Annotation of src/usr.bin/mandoc/mandoc.h, Revision 1.18
1.18 ! schwarze 1: /* $Id: mandoc.h,v 1.17 2010/10/24 18:15:43 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.3 schwarze 48: MANDOCERR_UPPERCASE, /* text should be uppercase */
1.6 schwarze 49: MANDOCERR_SECOOO, /* sections out of conventional order */
1.3 schwarze 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 */
54: MANDOCERR_BADSTANDARD, /* bad standard */
55: MANDOCERR_BADLIB, /* bad library */
1.11 schwarze 56: MANDOCERR_BADTAB, /* tab in non-literal context */
1.3 schwarze 57: MANDOCERR_BADESCAPE, /* bad escape sequence */
58: MANDOCERR_BADQUOTE, /* unterminated quoted string */
59: MANDOCERR_NOWIDTHARG, /* argument requires the width argument */
1.7 schwarze 60: /* FIXME: merge with MANDOCERR_IGNARGV. */
1.3 schwarze 61: MANDOCERR_WIDTHARG, /* superfluous width argument */
1.8 schwarze 62: MANDOCERR_IGNARGV, /* ignoring argument */
1.3 schwarze 63: MANDOCERR_BADDATE, /* bad date argument */
64: MANDOCERR_BADWIDTH, /* bad width argument */
1.6 schwarze 65: MANDOCERR_BADMSEC, /* unknown manual section */
1.17 schwarze 66: MANDOCERR_NESTEDDISP, /* nested displays are not portable */
1.3 schwarze 67: MANDOCERR_SECMSEC, /* section not in conventional manual section */
68: MANDOCERR_EOLNSPACE, /* end of line whitespace */
1.9 schwarze 69: MANDOCERR_SCOPENEST, /* blocks badly nested */
1.8 schwarze 70:
1.16 schwarze 71: MANDOCERR_ERROR, /* ===== start of errors ===== */
1.3 schwarze 72: MANDOCERR_NAMESECFIRST, /* NAME section must come first */
73: MANDOCERR_BADBOOL, /* bad Boolean value */
74: MANDOCERR_CHILD, /* child violates parent syntax */
75: MANDOCERR_BADATT, /* bad AT&T symbol */
76: MANDOCERR_LISTREP, /* list type repeated */
77: MANDOCERR_DISPREP, /* display type repeated */
78: MANDOCERR_ARGVREP, /* argument repeated */
79: MANDOCERR_NONAME, /* manual name not yet set */
80: MANDOCERR_MACROOBS, /* obsolete macro ignored */
81: MANDOCERR_MACROEMPTY, /* empty macro ignored */
82: MANDOCERR_BADBODY, /* macro not allowed in body */
83: MANDOCERR_BADPROLOG, /* macro not allowed in prologue */
84: MANDOCERR_BADCHAR, /* bad character */
85: MANDOCERR_BADNAMESEC, /* bad NAME section contents */
86: MANDOCERR_NOBLANKLN, /* no blank lines */
87: MANDOCERR_NOTEXT, /* no text in this context */
88: MANDOCERR_BADCOMMENT, /* bad comment style */
89: MANDOCERR_MACRO, /* unknown macro will be lost */
90: MANDOCERR_LINESCOPE, /* line scope broken */
91: MANDOCERR_ARGCOUNT, /* argument count wrong */
1.9 schwarze 92: MANDOCERR_NOSCOPE, /* no such block is open */
1.17 schwarze 93: MANDOCERR_SCOPEBROKEN, /* missing end of block */
1.3 schwarze 94: MANDOCERR_SCOPEREP, /* scope already open */
1.13 schwarze 95: MANDOCERR_SCOPEEXIT, /* scope open on exit */
1.17 schwarze 96: MANDOCERR_UNAME, /* uname(3) system call failed */
1.3 schwarze 97: /* FIXME: merge following with MANDOCERR_ARGCOUNT */
98: MANDOCERR_NOARGS, /* macro requires line argument(s) */
99: MANDOCERR_NOBODY, /* macro requires body argument(s) */
100: MANDOCERR_NOARGV, /* macro requires argument(s) */
101: MANDOCERR_NOTITLE, /* no title in document */
1.6 schwarze 102: MANDOCERR_LISTTYPE, /* missing list type */
1.7 schwarze 103: MANDOCERR_DISPTYPE, /* missing display type */
1.10 schwarze 104: MANDOCERR_FONTTYPE, /* missing font type */
1.3 schwarze 105: MANDOCERR_ARGSLOST, /* line argument(s) will be lost */
106: MANDOCERR_BODYLOST, /* body argument(s) will be lost */
1.14 schwarze 107: MANDOCERR_IGNPAR, /* paragraph macro ignored */
1.15 schwarze 108: MANDOCERR_TBL, /* tbl(1) error */
1.8 schwarze 109:
1.16 schwarze 110: MANDOCERR_FATAL, /* ===== start of fatal errors ===== */
1.6 schwarze 111: MANDOCERR_COLUMNS, /* column syntax is inconsistent */
1.7 schwarze 112: MANDOCERR_BADDISP, /* unsupported display type */
1.3 schwarze 113: MANDOCERR_SYNTLINESCOPE, /* line scope broken, syntax violated */
114: MANDOCERR_SYNTARGVCOUNT, /* argument count wrong, violates syntax */
115: MANDOCERR_SYNTCHILD, /* child violates parent syntax */
116: MANDOCERR_SYNTARGCOUNT, /* argument count wrong, violates syntax */
1.18 ! schwarze 117: MANDOCERR_SOPATH, /* invalid path in include directive */
1.3 schwarze 118: MANDOCERR_NODOCBODY, /* no document body */
119: MANDOCERR_NODOCPROLOG, /* no document prologue */
1.12 schwarze 120: MANDOCERR_MEM, /* static buffer exhausted */
1.1 schwarze 121: MANDOCERR_MAX
122: };
123:
1.16 schwarze 124: /*
125: * Available registers (set in libroff, accessed elsewhere).
126: */
1.10 schwarze 127: enum regs {
1.16 schwarze 128: REG_nS = 0,
1.10 schwarze 129: REG__MAX
130: };
131:
132: /*
1.16 schwarze 133: * A register (struct reg) can consist of many types: this consists of
134: * normalised types from the original string form.
135: */
136: union regval {
137: unsigned u; /* unsigned integer */
138: };
139:
140: /*
1.10 schwarze 141: * A single register entity. If "set" is zero, the value of the
142: * register should be the default one, which is per-register. It's
143: * assumed that callers know which type in "v" corresponds to which
144: * register value.
145: */
146: struct reg {
147: int set; /* whether set or not */
1.16 schwarze 148: union regval v; /* parsed data */
1.10 schwarze 149: };
150:
151: /*
152: * The primary interface to setting register values is in libroff,
153: * although libmdoc and libman from time to time will manipulate
154: * registers (such as `.Sh SYNOPSIS' enabling REG_nS).
155: */
156: struct regset {
157: struct reg regs[REG__MAX];
158: };
1.16 schwarze 159:
160: __BEGIN_DECLS
1.10 schwarze 161:
162: /*
163: * Callback function for warnings, errors, and fatal errors as they
164: * occur in the compilers libroff, libmdoc, and libman.
165: */
166: typedef int (*mandocmsg)(enum mandocerr, void *,
167: int, int, const char *);
1.1 schwarze 168:
169: __END_DECLS
170:
171: #endif /*!MANDOC_H*/