Make SYNOPSIS `Nm' use a TABLE in -T[x]html mode. Also fix `Nd' using
[mandoc.git] / mandoc.h
1 /* $Id: mandoc.h,v 1.34 2010/12/15 23:39:40 kristaps Exp $ */
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
19
20 #define ASCII_NBRSP 31 /* non-breaking space */
21 #define ASCII_HYPH 30 /* breakable hyphen */
22
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 */
29 enum mandoclevel {
30 MANDOCLEVEL_OK = 0,
31 MANDOCLEVEL_RESERVED,
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 */
37 MANDOCLEVEL_MAX
38 };
39
40 /*
41 * All possible things that can go wrong within a parse, be it libroff,
42 * libmdoc, or libman.
43 */
44 enum mandocerr {
45 MANDOCERR_OK,
46
47 MANDOCERR_WARNING, /* ===== start of warnings ===== */
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 */
60 MANDOCERR_SO, /* .so is fragile, better use ln(1) */
61 MANDOCERR_NAMESECFIRST, /* NAME section must come first */
62 MANDOCERR_BADNAMESEC, /* bad NAME section contents */
63 MANDOCERR_NONAME, /* manual name not yet set */
64 MANDOCERR_SECOOO, /* sections out of conventional order */
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_SCOPENEST, /* blocks badly nested */
71 MANDOCERR_CHILD, /* child violates parent syntax */
72 MANDOCERR_NESTEDDISP, /* nested displays are not portable */
73 MANDOCERR_SCOPEREP, /* already in literal mode */
74
75 /* related to missing macro arguments */
76 MANDOCERR_MACROEMPTY, /* skipping empty macro */
77 MANDOCERR_DISPTYPE, /* missing display type */
78 MANDOCERR_LISTFIRST, /* list type must come first */
79 MANDOCERR_NOWIDTHARG, /* tag lists require a width argument */
80 MANDOCERR_FONTTYPE, /* missing font type */
81
82 /* related to bad macro arguments */
83 MANDOCERR_IGNARGV, /* skipping argument */
84 MANDOCERR_ARGVREP, /* duplicate argument */
85 MANDOCERR_DISPREP, /* duplicate display type */
86 MANDOCERR_LISTREP, /* duplicate list type */
87 MANDOCERR_BADATT, /* unknown AT&T UNIX version */
88 MANDOCERR_BADBOOL, /* bad Boolean value */
89 MANDOCERR_BADFONT, /* unknown font */
90 MANDOCERR_BADSTANDARD, /* unknown standard specifier */
91 MANDOCERR_BADWIDTH, /* bad width argument */
92
93 /* related to plain text */
94 MANDOCERR_NOBLANKLN, /* blank line in non-literal context */
95 MANDOCERR_BADTAB, /* tab in non-literal context */
96 MANDOCERR_EOLNSPACE, /* end of line whitespace */
97 MANDOCERR_BADCOMMENT, /* bad comment style */
98 MANDOCERR_BADESCAPE, /* unknown escape sequence */
99 MANDOCERR_BADQUOTE, /* unterminated quoted string */
100
101 MANDOCERR_ERROR, /* ===== start of errors ===== */
102
103 MANDOCERR_ROFFLOOP, /* input stack limit exceeded, infinite loop? */
104 MANDOCERR_BADCHAR, /* skipping bad character */
105 MANDOCERR_NOTEXT, /* skipping text before the first section header */
106 MANDOCERR_MACRO, /* skipping unknown macro */
107 MANDOCERR_IGNPAR, /* skipping paragraph macro */
108 MANDOCERR_REQUEST, /* NOT IMPLEMENTED: skipping request */
109 MANDOCERR_LINESCOPE, /* line scope broken */
110 MANDOCERR_ARGCOUNT, /* argument count wrong */
111 MANDOCERR_NOSCOPE, /* skipping end of block that is not open */
112 MANDOCERR_SCOPEBROKEN, /* missing end of block */
113 MANDOCERR_SCOPEEXIT, /* scope open on exit */
114 MANDOCERR_UNAME, /* uname(3) system call failed */
115 /* FIXME: merge following with MANDOCERR_ARGCOUNT */
116 MANDOCERR_NOARGS, /* macro requires line argument(s) */
117 MANDOCERR_NOBODY, /* macro requires body argument(s) */
118 MANDOCERR_NOARGV, /* macro requires argument(s) */
119 MANDOCERR_LISTTYPE, /* missing list type */
120 MANDOCERR_ARGSLOST, /* line argument(s) will be lost */
121 MANDOCERR_BODYLOST, /* body argument(s) will be lost */
122
123 MANDOCERR_FATAL, /* ===== start of fatal errors ===== */
124
125 MANDOCERR_COLUMNS, /* column syntax is inconsistent */
126 MANDOCERR_BADDISP, /* NOT IMPLEMENTED: .Bd -file */
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 */
131 MANDOCERR_SOPATH, /* NOT IMPLEMENTED: .so with absolute path or ".." */
132 MANDOCERR_NODOCBODY, /* no document body */
133 MANDOCERR_NODOCPROLOG, /* no document prologue */
134 MANDOCERR_MEM, /* static buffer exhausted */
135 MANDOCERR_MAX
136 };
137
138 /*
139 * Available registers (set in libroff, accessed elsewhere).
140 */
141 enum regs {
142 REG_nS = 0,
143 REG__MAX
144 };
145
146 /*
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 /*
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 */
162 union regval v; /* parsed data */
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 };
173
174 __BEGIN_DECLS
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 *);
182
183 __END_DECLS
184
185 #endif /*!MANDOC_H*/