Annotation of mandoc/mandoc.h, Revision 1.42
1.42 ! kristaps 1: /* $Id: mandoc.h,v 1.41 2011/01/01 22:19:15 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.32 kristaps 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.26 kristaps 60: MANDOCERR_SO, /* .so is fragile, better use ln(1) */
1.32 kristaps 61: MANDOCERR_NAMESECFIRST, /* NAME section must come first */
62: MANDOCERR_BADNAMESEC, /* bad NAME section contents */
63: MANDOCERR_NONAME, /* manual name not yet set */
1.9 kristaps 64: MANDOCERR_SECOOO, /* sections out of conventional order */
1.32 kristaps 65: MANDOCERR_SECREP, /* duplicate section name */
1.5 kristaps 66: MANDOCERR_SECMSEC, /* section not in conventional manual section */
1.32 kristaps 67:
68: /* related to macros and nesting */
69: MANDOCERR_MACROOBS, /* skipping obsolete macro */
1.35 kristaps 70: MANDOCERR_IGNPAR, /* skipping paragraph macro */
1.14 schwarze 71: MANDOCERR_SCOPENEST, /* blocks badly nested */
1.32 kristaps 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 */
79: MANDOCERR_LISTFIRST, /* list type must come first */
80: MANDOCERR_NOWIDTHARG, /* tag lists require a width argument */
81: MANDOCERR_FONTTYPE, /* missing font type */
1.13 schwarze 82:
1.32 kristaps 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 */
1.5 kristaps 89: MANDOCERR_BADBOOL, /* bad Boolean value */
1.31 kristaps 90: MANDOCERR_BADFONT, /* unknown font */
1.32 kristaps 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 */
96: MANDOCERR_BADTAB, /* tab in non-literal context */
97: MANDOCERR_EOLNSPACE, /* end of line whitespace */
1.5 kristaps 98: MANDOCERR_BADCOMMENT, /* bad comment style */
1.32 kristaps 99: MANDOCERR_BADESCAPE, /* unknown escape sequence */
100: MANDOCERR_BADQUOTE, /* unterminated quoted string */
101:
1.42 ! kristaps 102: /* related to tables */
! 103: MANDOCERR_TBLEXTRADAT, /* extra data cells */
! 104:
1.32 kristaps 105: MANDOCERR_ERROR, /* ===== start of errors ===== */
106:
1.42 ! kristaps 107: /* related to tables */
1.36 kristaps 108: MANDOCERR_TBL, /* bad table syntax */
109: MANDOCERR_TBLOPT, /* bad table option */
1.37 kristaps 110: MANDOCERR_TBLLAYOUT, /* bad table layout */
111: MANDOCERR_TBLNOLAYOUT, /* no table layout cells specified */
1.39 kristaps 112: MANDOCERR_TBLNODATA, /* no table data cells specified */
1.42 ! kristaps 113:
1.33 schwarze 114: MANDOCERR_ROFFLOOP, /* input stack limit exceeded, infinite loop? */
1.32 kristaps 115: MANDOCERR_BADCHAR, /* skipping bad character */
116: MANDOCERR_NOTEXT, /* skipping text before the first section header */
117: MANDOCERR_MACRO, /* skipping unknown macro */
1.25 kristaps 118: MANDOCERR_REQUEST, /* NOT IMPLEMENTED: skipping request */
1.5 kristaps 119: MANDOCERR_LINESCOPE, /* line scope broken */
120: MANDOCERR_ARGCOUNT, /* argument count wrong */
1.32 kristaps 121: MANDOCERR_NOSCOPE, /* skipping end of block that is not open */
1.30 kristaps 122: MANDOCERR_SCOPEBROKEN, /* missing end of block */
1.19 schwarze 123: MANDOCERR_SCOPEEXIT, /* scope open on exit */
1.28 kristaps 124: MANDOCERR_UNAME, /* uname(3) system call failed */
1.5 kristaps 125: /* FIXME: merge following with MANDOCERR_ARGCOUNT */
126: MANDOCERR_NOARGS, /* macro requires line argument(s) */
127: MANDOCERR_NOBODY, /* macro requires body argument(s) */
128: MANDOCERR_NOARGV, /* macro requires argument(s) */
1.10 kristaps 129: MANDOCERR_LISTTYPE, /* missing list type */
1.5 kristaps 130: MANDOCERR_ARGSLOST, /* line argument(s) will be lost */
131: MANDOCERR_BODYLOST, /* body argument(s) will be lost */
1.13 schwarze 132:
1.21 kristaps 133: MANDOCERR_FATAL, /* ===== start of fatal errors ===== */
1.32 kristaps 134:
1.8 kristaps 135: MANDOCERR_COLUMNS, /* column syntax is inconsistent */
1.32 kristaps 136: MANDOCERR_BADDISP, /* NOT IMPLEMENTED: .Bd -file */
1.5 kristaps 137: MANDOCERR_SYNTLINESCOPE, /* line scope broken, syntax violated */
138: MANDOCERR_SYNTARGVCOUNT, /* argument count wrong, violates syntax */
139: MANDOCERR_SYNTCHILD, /* child violates parent syntax */
140: MANDOCERR_SYNTARGCOUNT, /* argument count wrong, violates syntax */
1.26 kristaps 141: MANDOCERR_SOPATH, /* NOT IMPLEMENTED: .so with absolute path or ".." */
1.5 kristaps 142: MANDOCERR_NODOCBODY, /* no document body */
143: MANDOCERR_NODOCPROLOG, /* no document prologue */
1.18 schwarze 144: MANDOCERR_MEM, /* static buffer exhausted */
1.1 kristaps 145: MANDOCERR_MAX
1.38 kristaps 146: };
147:
1.41 kristaps 148: enum tbl_headt {
149: TBL_HEAD_DATA, /* plug in data from tbl_dat */
150: TBL_HEAD_VERT, /* vertical spacer */
151: TBL_HEAD_DVERT /* double-vertical spacer */
152: };
153:
154: /*
155: * The head of a table specifies all of its columns. When formatting a
156: * tbl_span, iterate over these and plug in data from the tbl_span when
157: * appropriate, using tbl_cell as a guide to placement.
158: */
159: struct tbl_head {
160: enum tbl_headt pos;
161: int width; /* width of cell in fixed chars */
162: int decimal; /* decimal point position */
163: struct tbl_head *next;
164: struct tbl_head *prev;
165: };
166:
1.38 kristaps 167: enum tbl_cellt {
168: TBL_CELL_CENTRE, /* c, C */
169: TBL_CELL_RIGHT, /* r, R */
170: TBL_CELL_LEFT, /* l, L */
171: TBL_CELL_NUMBER, /* n, N */
172: TBL_CELL_SPAN, /* s, S */
173: TBL_CELL_LONG, /* a, A */
174: TBL_CELL_DOWN, /* ^ */
175: TBL_CELL_HORIZ, /* _, - */
176: TBL_CELL_DHORIZ, /* = */
177: TBL_CELL_VERT, /* | */
178: TBL_CELL_DVERT, /* || */
179: TBL_CELL_MAX
180: };
181:
182: /*
183: * A cell in a layout row.
184: */
185: struct tbl_cell {
186: struct tbl_cell *next;
187: enum tbl_cellt pos;
188: int spacing;
189: int flags;
190: #define TBL_CELL_TALIGN (1 << 0) /* t, T */
191: #define TBL_CELL_BALIGN (1 << 1) /* d, D */
192: #define TBL_CELL_BOLD (1 << 2) /* fB, B, b */
193: #define TBL_CELL_ITALIC (1 << 3) /* fI, I, i */
194: #define TBL_CELL_EQUAL (1 << 4) /* e, E */
195: #define TBL_CELL_UP (1 << 5) /* u, U */
196: #define TBL_CELL_WIGN (1 << 6) /* z, Z */
1.41 kristaps 197: struct tbl_head *head;
1.38 kristaps 198: };
199:
200: /*
201: * A layout row.
202: */
203: struct tbl_row {
204: struct tbl_row *next;
205: struct tbl_cell *first;
206: struct tbl_cell *last;
207: };
208:
1.40 kristaps 209: enum tbl_datt {
210: TBL_DATA_DATA,
211: TBL_DATA_HORIZ,
212: TBL_DATA_DHORIZ,
213: TBL_DATA_NHORIZ,
214: TBL_DATA_NDHORIZ
215: };
216:
1.38 kristaps 217: /*
218: * A cell within a row of data. The "string" field contains the actual
219: * string value that's in the cell. The rest is layout.
220: */
221: struct tbl_dat {
222: struct tbl_cell *layout; /* layout cell: CAN BE NULL */
223: struct tbl_dat *next;
224: char *string;
1.40 kristaps 225: enum tbl_datt pos;
226: };
227:
228: enum tbl_spant {
229: TBL_SPAN_DATA, /* span consists of data */
230: TBL_SPAN_HORIZ, /* span is horizontal line */
231: TBL_SPAN_DHORIZ /* span is double horizontal line */
1.38 kristaps 232: };
233:
234: /*
235: * A row of data in a table.
236: */
237: struct tbl_span {
238: struct tbl_row *layout; /* layout row: CAN BE NULL */
239: struct tbl_dat *first;
240: struct tbl_dat *last;
1.40 kristaps 241: enum tbl_spant pos;
1.38 kristaps 242: struct tbl_span *next;
1.1 kristaps 243: };
244:
1.22 kristaps 245: /*
246: * Available registers (set in libroff, accessed elsewhere).
247: */
1.16 kristaps 248: enum regs {
1.22 kristaps 249: REG_nS = 0,
1.16 kristaps 250: REG__MAX
1.21 kristaps 251: };
252:
1.22 kristaps 253: /*
254: * A register (struct reg) can consist of many types: this consists of
255: * normalised types from the original string form.
256: */
257: union regval {
258: unsigned u; /* unsigned integer */
1.16 kristaps 259: };
260:
261: /*
262: * A single register entity. If "set" is zero, the value of the
263: * register should be the default one, which is per-register. It's
264: * assumed that callers know which type in "v" corresponds to which
265: * register value.
266: */
267: struct reg {
268: int set; /* whether set or not */
1.22 kristaps 269: union regval v; /* parsed data */
1.16 kristaps 270: };
271:
272: /*
273: * The primary interface to setting register values is in libroff,
274: * although libmdoc and libman from time to time will manipulate
275: * registers (such as `.Sh SYNOPSIS' enabling REG_nS).
276: */
277: struct regset {
278: struct reg regs[REG__MAX];
279: };
1.22 kristaps 280:
281: __BEGIN_DECLS
1.16 kristaps 282:
283: /*
284: * Callback function for warnings, errors, and fatal errors as they
285: * occur in the compilers libroff, libmdoc, and libman.
286: */
287: typedef int (*mandocmsg)(enum mandocerr, void *,
288: int, int, const char *);
1.1 kristaps 289:
290: __END_DECLS
291:
292: #endif /*!MANDOC_H*/
CVSweb