Annotation of src/usr.bin/mandoc/mandoc.h, Revision 1.24
1.24 ! schwarze 1: /* $Id: mandoc.h,v 1.23 2010/12/01 22:02:29 schwarze Exp $ */
1.1 schwarze 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.5 schwarze 19:
20: #define ASCII_NBRSP 31 /* non-breaking space */
21: #define ASCII_HYPH 30 /* breakable hyphen */
22:
1.16 schwarze 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.12 schwarze 29: enum mandoclevel {
30: MANDOCLEVEL_OK = 0,
31: MANDOCLEVEL_RESERVED,
1.16 schwarze 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.12 schwarze 37: MANDOCLEVEL_MAX
38: };
39:
1.16 schwarze 40: /*
41: * All possible things that can go wrong within a parse, be it libroff,
42: * libmdoc, or libman.
43: */
1.1 schwarze 44: enum mandocerr {
45: MANDOCERR_OK,
1.8 schwarze 46:
1.16 schwarze 47: MANDOCERR_WARNING, /* ===== start of warnings ===== */
1.19 schwarze 48:
49: /* related to the prologue */
50: MANDOCERR_NOTITLE, /* no title in document */
51: MANDOCERR_UPPERCASE, /* document title should be all caps */
52: MANDOCERR_BADMSEC, /* unknown manual section */
53: MANDOCERR_BADDATE, /* cannot parse date argument */
54: MANDOCERR_PROLOGOOO, /* prologue macros out of order */
55: MANDOCERR_PROLOGREP, /* duplicate prologue macro */
56: MANDOCERR_BADPROLOG, /* macro not allowed in prologue */
57: MANDOCERR_BADBODY, /* macro not allowed in body */
58:
59: /* related to document structure */
1.20 schwarze 60: MANDOCERR_SO, /* .so is fragile, better use ln(1) */
1.19 schwarze 61: MANDOCERR_NAMESECFIRST, /* NAME section must come first */
62: MANDOCERR_BADNAMESEC, /* bad NAME section contents */
63: MANDOCERR_NONAME, /* manual name not yet set */
1.6 schwarze 64: MANDOCERR_SECOOO, /* sections out of conventional order */
1.19 schwarze 65: MANDOCERR_SECREP, /* duplicate section name */
66: MANDOCERR_SECMSEC, /* section not in conventional manual section */
67:
68: /* related to macros and nesting */
69: MANDOCERR_MACROOBS, /* skipping obsolete macro */
70: MANDOCERR_IGNPAR, /* skipping paragraph macro */
71: MANDOCERR_SCOPENEST, /* blocks badly nested */
72: MANDOCERR_CHILD, /* child violates parent syntax */
73: MANDOCERR_NESTEDDISP, /* nested displays are not portable */
74: MANDOCERR_SCOPEREP, /* already in literal mode */
75:
76: /* related to missing macro arguments */
77: MANDOCERR_MACROEMPTY, /* skipping empty macro */
78: MANDOCERR_DISPTYPE, /* missing display type */
1.3 schwarze 79: MANDOCERR_LISTFIRST, /* list type must come first */
1.19 schwarze 80: MANDOCERR_NOWIDTHARG, /* tag lists require a width argument */
81: MANDOCERR_FONTTYPE, /* missing font type */
82:
83: /* related to bad macro arguments */
84: MANDOCERR_IGNARGV, /* skipping argument */
85: MANDOCERR_ARGVREP, /* duplicate argument */
86: MANDOCERR_DISPREP, /* duplicate display type */
87: MANDOCERR_LISTREP, /* duplicate list type */
88: MANDOCERR_BADATT, /* unknown AT&T UNIX version */
89: MANDOCERR_BADBOOL, /* bad Boolean value */
1.22 schwarze 90: MANDOCERR_BADFONT, /* unknown font */
1.19 schwarze 91: MANDOCERR_BADSTANDARD, /* unknown standard specifier */
92: MANDOCERR_BADWIDTH, /* bad width argument */
93:
94: /* related to plain text */
95: MANDOCERR_NOBLANKLN, /* blank line in non-literal context */
1.11 schwarze 96: MANDOCERR_BADTAB, /* tab in non-literal context */
1.19 schwarze 97: MANDOCERR_EOLNSPACE, /* end of line whitespace */
98: MANDOCERR_BADCOMMENT, /* bad comment style */
99: MANDOCERR_BADESCAPE, /* unknown escape sequence */
1.3 schwarze 100: MANDOCERR_BADQUOTE, /* unterminated quoted string */
1.8 schwarze 101:
1.16 schwarze 102: MANDOCERR_ERROR, /* ===== start of errors ===== */
1.24 ! schwarze 103:
1.19 schwarze 104: MANDOCERR_BADCHAR, /* skipping bad character */
105: MANDOCERR_NOTEXT, /* skipping text before the first section header */
106: MANDOCERR_MACRO, /* skipping unknown macro */
1.21 schwarze 107: MANDOCERR_REQUEST, /* NOT IMPLEMENTED: skipping request */
1.3 schwarze 108: MANDOCERR_LINESCOPE, /* line scope broken */
109: MANDOCERR_ARGCOUNT, /* argument count wrong */
1.19 schwarze 110: MANDOCERR_NOSCOPE, /* skipping end of block that is not open */
1.17 schwarze 111: MANDOCERR_SCOPEBROKEN, /* missing end of block */
1.13 schwarze 112: MANDOCERR_SCOPEEXIT, /* scope open on exit */
1.17 schwarze 113: MANDOCERR_UNAME, /* uname(3) system call failed */
1.3 schwarze 114: /* FIXME: merge following with MANDOCERR_ARGCOUNT */
115: MANDOCERR_NOARGS, /* macro requires line argument(s) */
116: MANDOCERR_NOBODY, /* macro requires body argument(s) */
117: MANDOCERR_NOARGV, /* macro requires argument(s) */
1.6 schwarze 118: MANDOCERR_LISTTYPE, /* missing list type */
1.3 schwarze 119: MANDOCERR_ARGSLOST, /* line argument(s) will be lost */
120: MANDOCERR_BODYLOST, /* body argument(s) will be lost */
1.15 schwarze 121: MANDOCERR_TBL, /* tbl(1) error */
1.8 schwarze 122:
1.16 schwarze 123: MANDOCERR_FATAL, /* ===== start of fatal errors ===== */
1.24 ! schwarze 124:
1.6 schwarze 125: MANDOCERR_COLUMNS, /* column syntax is inconsistent */
1.21 schwarze 126: MANDOCERR_BADDISP, /* NOT IMPLEMENTED: .Bd -file */
1.3 schwarze 127: MANDOCERR_SYNTLINESCOPE, /* line scope broken, syntax violated */
128: MANDOCERR_SYNTARGVCOUNT, /* argument count wrong, violates syntax */
129: MANDOCERR_SYNTCHILD, /* child violates parent syntax */
130: MANDOCERR_SYNTARGCOUNT, /* argument count wrong, violates syntax */
1.21 schwarze 131: MANDOCERR_SOPATH, /* NOT IMPLEMENTED: .so with absolute path or ".." */
1.3 schwarze 132: MANDOCERR_NODOCBODY, /* no document body */
133: MANDOCERR_NODOCPROLOG, /* no document prologue */
1.12 schwarze 134: MANDOCERR_MEM, /* static buffer exhausted */
1.1 schwarze 135: MANDOCERR_MAX
136: };
137:
1.16 schwarze 138: /*
139: * Available registers (set in libroff, accessed elsewhere).
140: */
1.10 schwarze 141: enum regs {
1.16 schwarze 142: REG_nS = 0,
1.10 schwarze 143: REG__MAX
144: };
145:
146: /*
1.16 schwarze 147: * A register (struct reg) can consist of many types: this consists of
148: * normalised types from the original string form.
149: */
150: union regval {
151: unsigned u; /* unsigned integer */
152: };
153:
154: /*
1.10 schwarze 155: * A single register entity. If "set" is zero, the value of the
156: * register should be the default one, which is per-register. It's
157: * assumed that callers know which type in "v" corresponds to which
158: * register value.
159: */
160: struct reg {
161: int set; /* whether set or not */
1.16 schwarze 162: union regval v; /* parsed data */
1.10 schwarze 163: };
164:
165: /*
166: * The primary interface to setting register values is in libroff,
167: * although libmdoc and libman from time to time will manipulate
168: * registers (such as `.Sh SYNOPSIS' enabling REG_nS).
169: */
170: struct regset {
171: struct reg regs[REG__MAX];
172: };
1.16 schwarze 173:
174: __BEGIN_DECLS
1.10 schwarze 175:
176: /*
177: * Callback function for warnings, errors, and fatal errors as they
178: * occur in the compilers libroff, libmdoc, and libman.
179: */
180: typedef int (*mandocmsg)(enum mandocerr, void *,
181: int, int, const char *);
1.1 schwarze 182:
183: __END_DECLS
184:
185: #endif /*!MANDOC_H*/
![[BACK]](/icons/back.gif){kind=icon}
Return to mandoc.h CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / mandoc