Annotation of mandoc/mandoc.h, Revision 1.24
1.24 ! kristaps 1: /* $Id: mandoc.h,v 1.23 2010/10/11 15:46:19 kristaps Exp $ */
1.1 kristaps 2: /*
3: * Copyright (c) 2010 Kristaps Dzonsons <kristaps@bsd.lv>
4: *
5: * Permission to use, copy, modify, and distribute this software for any
6: * purpose with or without fee is hereby granted, provided that the above
7: * copyright notice and this permission notice appear in all copies.
8: *
9: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10: * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11: * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12: * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13: * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14: * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15: * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16: */
17: #ifndef MANDOC_H
18: #define MANDOC_H
1.7 kristaps 19:
20: #define ASCII_NBRSP 31 /* non-breaking space */
21: #define ASCII_HYPH 30 /* breakable hyphen */
22:
1.22 kristaps 23: /*
24: * Status level. This refers to both internal status (i.e., whilst
25: * running, when warnings/errors are reported) and an indicator of a
26: * threshold of when to halt (when said internal state exceeds the
27: * threshold).
28: */
1.18 schwarze 29: enum mandoclevel {
30: MANDOCLEVEL_OK = 0,
31: MANDOCLEVEL_RESERVED,
1.22 kristaps 32: MANDOCLEVEL_WARNING, /* warnings: syntax, whitespace, etc. */
33: MANDOCLEVEL_ERROR, /* input has been thrown away */
34: MANDOCLEVEL_FATAL, /* input is borked */
35: MANDOCLEVEL_BADARG, /* bad argument in invocation */
36: MANDOCLEVEL_SYSERR, /* system error */
1.18 schwarze 37: MANDOCLEVEL_MAX
38: };
39:
1.22 kristaps 40: /*
41: * All possible things that can go wrong within a parse, be it libroff,
42: * libmdoc, or libman.
43: */
1.1 kristaps 44: enum mandocerr {
45: MANDOCERR_OK,
1.13 schwarze 46:
1.21 kristaps 47: MANDOCERR_WARNING, /* ===== start of warnings ===== */
1.5 kristaps 48: MANDOCERR_UPPERCASE, /* text should be uppercase */
1.9 kristaps 49: MANDOCERR_SECOOO, /* sections out of conventional order */
1.5 kristaps 50: MANDOCERR_SECREP, /* section name repeats */
51: MANDOCERR_PROLOGOOO, /* out of order prologue */
52: MANDOCERR_PROLOGREP, /* repeated prologue entry */
53: MANDOCERR_LISTFIRST, /* list type must come first */
1.17 kristaps 54: MANDOCERR_BADTAB, /* tab in non-literal context */
1.5 kristaps 55: MANDOCERR_BADESCAPE, /* bad escape sequence */
56: MANDOCERR_BADQUOTE, /* unterminated quoted string */
57: MANDOCERR_NOWIDTHARG, /* argument requires the width argument */
1.12 kristaps 58: /* FIXME: merge with MANDOCERR_IGNARGV. */
1.5 kristaps 59: MANDOCERR_WIDTHARG, /* superfluous width argument */
60: MANDOCERR_BADDATE, /* bad date argument */
61: MANDOCERR_BADWIDTH, /* bad width argument */
1.9 kristaps 62: MANDOCERR_BADMSEC, /* unknown manual section */
1.5 kristaps 63: MANDOCERR_SECMSEC, /* section not in conventional manual section */
64: MANDOCERR_EOLNSPACE, /* end of line whitespace */
1.14 schwarze 65: MANDOCERR_SCOPENEST, /* blocks badly nested */
1.13 schwarze 66:
1.21 kristaps 67: MANDOCERR_ERROR, /* ===== start of errors ===== */
1.5 kristaps 68: MANDOCERR_NAMESECFIRST, /* NAME section must come first */
69: MANDOCERR_BADBOOL, /* bad Boolean value */
70: MANDOCERR_CHILD, /* child violates parent syntax */
71: MANDOCERR_BADATT, /* bad AT&T symbol */
1.24 ! kristaps 72: MANDOCERR_BADSTANDARD, /* bad standard */
1.5 kristaps 73: MANDOCERR_LISTREP, /* list type repeated */
74: MANDOCERR_DISPREP, /* display type repeated */
75: MANDOCERR_ARGVREP, /* argument repeated */
1.23 kristaps 76: MANDOCERR_IGNARGV, /* ignoring argument */
1.5 kristaps 77: MANDOCERR_NONAME, /* manual name not yet set */
78: MANDOCERR_MACROOBS, /* obsolete macro ignored */
79: MANDOCERR_MACROEMPTY, /* empty macro ignored */
80: MANDOCERR_BADBODY, /* macro not allowed in body */
81: MANDOCERR_BADPROLOG, /* macro not allowed in prologue */
82: MANDOCERR_BADCHAR, /* bad character */
83: MANDOCERR_BADNAMESEC, /* bad NAME section contents */
84: MANDOCERR_NOBLANKLN, /* no blank lines */
85: MANDOCERR_NOTEXT, /* no text in this context */
86: MANDOCERR_BADCOMMENT, /* bad comment style */
87: MANDOCERR_MACRO, /* unknown macro will be lost */
88: MANDOCERR_LINESCOPE, /* line scope broken */
89: MANDOCERR_ARGCOUNT, /* argument count wrong */
1.14 schwarze 90: MANDOCERR_NOSCOPE, /* no such block is open */
1.5 kristaps 91: MANDOCERR_SCOPEREP, /* scope already open */
1.19 schwarze 92: MANDOCERR_SCOPEEXIT, /* scope open on exit */
1.5 kristaps 93: /* FIXME: merge following with MANDOCERR_ARGCOUNT */
94: MANDOCERR_NOARGS, /* macro requires line argument(s) */
95: MANDOCERR_NOBODY, /* macro requires body argument(s) */
96: MANDOCERR_NOARGV, /* macro requires argument(s) */
97: MANDOCERR_NOTITLE, /* no title in document */
1.10 kristaps 98: MANDOCERR_LISTTYPE, /* missing list type */
1.11 kristaps 99: MANDOCERR_DISPTYPE, /* missing display type */
1.15 kristaps 100: MANDOCERR_FONTTYPE, /* missing font type */
1.5 kristaps 101: MANDOCERR_ARGSLOST, /* line argument(s) will be lost */
102: MANDOCERR_BODYLOST, /* body argument(s) will be lost */
1.20 kristaps 103: MANDOCERR_IGNPAR, /* paragraph macro ignored */
1.13 schwarze 104:
1.21 kristaps 105: MANDOCERR_FATAL, /* ===== start of fatal errors ===== */
1.8 kristaps 106: MANDOCERR_COLUMNS, /* column syntax is inconsistent */
1.5 kristaps 107: /* FIXME: this should be a MANDOCERR_ERROR */
108: MANDOCERR_NESTEDDISP, /* displays may not be nested */
1.11 kristaps 109: MANDOCERR_BADDISP, /* unsupported display type */
1.14 schwarze 110: MANDOCERR_SCOPEFATAL, /* blocks badly nested */
1.13 schwarze 111: MANDOCERR_SYNTNOSCOPE, /* no scope to rewind: syntax violated */
1.5 kristaps 112: MANDOCERR_SYNTLINESCOPE, /* line scope broken, syntax violated */
113: MANDOCERR_SYNTARGVCOUNT, /* argument count wrong, violates syntax */
114: MANDOCERR_SYNTCHILD, /* child violates parent syntax */
115: MANDOCERR_SYNTARGCOUNT, /* argument count wrong, violates syntax */
116: MANDOCERR_NODOCBODY, /* no document body */
117: MANDOCERR_NODOCPROLOG, /* no document prologue */
1.13 schwarze 118: MANDOCERR_UTSNAME, /* utsname system call failed */
1.18 schwarze 119: MANDOCERR_MEM, /* static buffer exhausted */
1.1 kristaps 120: MANDOCERR_MAX
121: };
122:
1.22 kristaps 123: /*
124: * Available registers (set in libroff, accessed elsewhere).
125: */
1.16 kristaps 126: enum regs {
1.22 kristaps 127: REG_nS = 0,
1.16 kristaps 128: REG__MAX
1.21 kristaps 129: };
130:
1.22 kristaps 131: /*
132: * A register (struct reg) can consist of many types: this consists of
133: * normalised types from the original string form.
134: */
135: union regval {
136: unsigned u; /* unsigned integer */
1.16 kristaps 137: };
138:
139: /*
140: * A single register entity. If "set" is zero, the value of the
141: * register should be the default one, which is per-register. It's
142: * assumed that callers know which type in "v" corresponds to which
143: * register value.
144: */
145: struct reg {
146: int set; /* whether set or not */
1.22 kristaps 147: union regval v; /* parsed data */
1.16 kristaps 148: };
149:
150: /*
151: * The primary interface to setting register values is in libroff,
152: * although libmdoc and libman from time to time will manipulate
153: * registers (such as `.Sh SYNOPSIS' enabling REG_nS).
154: */
155: struct regset {
156: struct reg regs[REG__MAX];
157: };
1.22 kristaps 158:
159: __BEGIN_DECLS
1.16 kristaps 160:
161: /*
162: * Callback function for warnings, errors, and fatal errors as they
163: * occur in the compilers libroff, libmdoc, and libman.
164: */
165: typedef int (*mandocmsg)(enum mandocerr, void *,
166: int, int, const char *);
1.1 kristaps 167:
168: __END_DECLS
169:
170: #endif /*!MANDOC_H*/
CVSweb
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to mandoc.h CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [cvsweb.bsd.lv] / mandoc