Annotation of src/usr.bin/mandoc/mandoc.h, Revision 1.82
1.82 ! schwarze 1: /* $Id: mandoc.h,v 1.81 2014/07/06 19:08:56 schwarze Exp $ */
1.1 schwarze 2: /*
1.27 schwarze 3: * Copyright (c) 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.62 schwarze 4: * Copyright (c) 2010-2014 Ingo Schwarze <schwarze@openbsd.org>
1.1 schwarze 5: *
6: * Permission to use, copy, modify, and distribute this software for any
7: * purpose with or without fee is hereby granted, provided that the above
8: * copyright notice and this permission notice appear in all copies.
9: *
10: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11: * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12: * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13: * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14: * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15: * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16: * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17: */
18: #ifndef MANDOC_H
19: #define MANDOC_H
1.5 schwarze 20:
21: #define ASCII_NBRSP 31 /* non-breaking space */
22: #define ASCII_HYPH 30 /* breakable hyphen */
1.59 schwarze 23: #define ASCII_BREAK 29 /* breakable zero-width space */
1.5 schwarze 24:
1.16 schwarze 25: /*
26: * Status level. This refers to both internal status (i.e., whilst
27: * running, when warnings/errors are reported) and an indicator of a
28: * threshold of when to halt (when said internal state exceeds the
29: * threshold).
30: */
1.12 schwarze 31: enum mandoclevel {
32: MANDOCLEVEL_OK = 0,
33: MANDOCLEVEL_RESERVED,
1.16 schwarze 34: MANDOCLEVEL_WARNING, /* warnings: syntax, whitespace, etc. */
35: MANDOCLEVEL_ERROR, /* input has been thrown away */
36: MANDOCLEVEL_FATAL, /* input is borked */
37: MANDOCLEVEL_BADARG, /* bad argument in invocation */
38: MANDOCLEVEL_SYSERR, /* system error */
1.12 schwarze 39: MANDOCLEVEL_MAX
40: };
41:
1.16 schwarze 42: /*
43: * All possible things that can go wrong within a parse, be it libroff,
44: * libmdoc, or libman.
45: */
1.1 schwarze 46: enum mandocerr {
47: MANDOCERR_OK,
1.8 schwarze 48:
1.16 schwarze 49: MANDOCERR_WARNING, /* ===== start of warnings ===== */
1.19 schwarze 50:
51: /* related to the prologue */
1.69 schwarze 52: MANDOCERR_TH_MISSING, /* missing .TH macro, using "unknown 1" */
53: MANDOCERR_TITLE_CASE, /* lower case character in document title */
54: MANDOCERR_MSEC_BAD, /* unknown manual section: section */
55: MANDOCERR_ARCH_BAD, /* unknown manual volume or arch: volume */
56: MANDOCERR_DATE_MISSING, /* missing date, using today's date */
57: MANDOCERR_DATE_BAD, /* cannot parse date, using it verbatim: date */
58: MANDOCERR_PROLOG_ORDER, /* prologue macros out of order: macro */
59: MANDOCERR_PROLOG_REP, /* duplicate prologue macro: macro */
60: MANDOCERR_PROLOG_BAD, /* incomplete prologue, terminated by: macro */
61: MANDOCERR_PROLOG_ONLY, /* skipping prologue macro in body: macro */
1.19 schwarze 62:
63: /* related to document structure */
1.68 schwarze 64: MANDOCERR_SO, /* .so is fragile, better use ln(1): .so path */
1.66 schwarze 65: MANDOCERR_DOC_EMPTY, /* no document body */
1.69 schwarze 66: MANDOCERR_SEC_BEFORE, /* content before first section header: macro */
67: MANDOCERR_NAMESEC_FIRST, /* first section is not "NAME": title */
68: MANDOCERR_NAMESEC_BAD, /* bad NAME section contents: macro */
69: MANDOCERR_SEC_ORDER, /* sections out of conventional order: title */
70: MANDOCERR_SEC_REP, /* duplicate section title: title */
71: MANDOCERR_SEC_MSEC, /* unexpected section: title for ... only */
1.19 schwarze 72:
73: /* related to macros and nesting */
1.70 schwarze 74: MANDOCERR_MACRO_OBS, /* obsolete macro: macro */
1.71 schwarze 75: MANDOCERR_PAR_SKIP, /* skipping paragraph macro: macro ... */
76: MANDOCERR_PAR_MOVE, /* moving paragraph macro out of list: macro */
1.72 schwarze 77: MANDOCERR_NS_SKIP, /* skipping no-space macro */
78: MANDOCERR_BLOCK_NEST, /* blocks badly nested: macro ... */
79: MANDOCERR_BD_NEST, /* nested displays are not portable: macro ... */
1.73 schwarze 80: MANDOCERR_BL_MOVE, /* moving content out of list: macro */
81: MANDOCERR_VT_CHILD, /* .Vt block has child macro: macro */
1.72 schwarze 82: MANDOCERR_FI_SKIP, /* fill mode already enabled, skipping .fi */
83: MANDOCERR_NF_SKIP, /* fill mode already disabled, skipping .nf */
84: MANDOCERR_LINESCOPE, /* line scope broken: macro breaks macro */
1.19 schwarze 85:
1.75 schwarze 86: /* related to missing arguments */
87: MANDOCERR_REQ_EMPTY, /* skipping empty request: request */
88: MANDOCERR_COND_EMPTY, /* conditional request controls empty scope */
1.74 schwarze 89: MANDOCERR_MACRO_EMPTY, /* skipping empty macro: macro */
1.79 schwarze 90: MANDOCERR_ARG_EMPTY, /* empty argument, using 0n: macro arg */
1.26 schwarze 91: MANDOCERR_ARGCWARN, /* argument count wrong */
1.77 schwarze 92: MANDOCERR_BD_NOTYPE, /* missing display type, using -ragged */
93: MANDOCERR_BL_LATETYPE, /* list type is not the first argument: arg */
1.80 schwarze 94: MANDOCERR_BL_NOWIDTH, /* missing -width in -tag list, using 8n */
1.77 schwarze 95: MANDOCERR_IT_NOHEAD, /* empty head in list item: type */
96: MANDOCERR_IT_NOBODY, /* empty list item: type */
1.78 schwarze 97: MANDOCERR_BF_NOFONT, /* missing font type, using \fR */
1.80 schwarze 98: MANDOCERR_BF_BADFONT, /* unknown font type, using \fR: macro font */
1.77 schwarze 99: MANDOCERR_ARG_STD, /* missing -std argument, adding it: macro */
1.19 schwarze 100:
1.81 schwarze 101: /* related to bad arguments */
1.19 schwarze 102: MANDOCERR_IGNARGV, /* skipping argument */
1.81 schwarze 103: MANDOCERR_ARG_QUOTE, /* unterminated quoted argument */
1.79 schwarze 104: MANDOCERR_ARG_REP, /* duplicate argument: macro arg */
1.80 schwarze 105: MANDOCERR_BD_REP, /* skipping duplicate display type: type */
106: MANDOCERR_BL_REP, /* skipping duplicate list type: type */
107: MANDOCERR_AT_BAD, /* unknown AT&T UNIX version: version */
108: MANDOCERR_SM_BAD, /* invalid Boolean argument: macro arg */
109: MANDOCERR_FT_BAD, /* unknown font, skipping request: request font */
1.19 schwarze 110:
111: /* related to plain text */
1.81 schwarze 112: MANDOCERR_FI_BLANK, /* blank line in fill mode, using .sp */
113: MANDOCERR_FI_TAB, /* tab in filled text */
114: MANDOCERR_SPACE_EOL, /* whitespace at end of input line */
115: MANDOCERR_COMMENT_BAD, /* bad comment style */
116: MANDOCERR_ESC_BAD, /* invalid escape sequence: esc */
117: MANDOCERR_STR_UNDEF, /* undefined string, using "": name */
1.8 schwarze 118:
1.16 schwarze 119: MANDOCERR_ERROR, /* ===== start of errors ===== */
1.24 schwarze 120:
1.40 schwarze 121: /* related to equations */
122: MANDOCERR_EQNNSCOPE, /* unexpected equation scope closure*/
123: MANDOCERR_EQNSCOPE, /* equation scope open on exit */
124: MANDOCERR_EQNBADSCOPE, /* overlapping equation scopes */
125: MANDOCERR_EQNEOF, /* unexpected end of equation */
126: MANDOCERR_EQNSYNT, /* equation syntax error */
127:
1.27 schwarze 128: /* related to tables */
129: MANDOCERR_TBL, /* bad table syntax */
130: MANDOCERR_TBLOPT, /* bad table option */
131: MANDOCERR_TBLLAYOUT, /* bad table layout */
132: MANDOCERR_TBLNOLAYOUT, /* no table layout cells specified */
133: MANDOCERR_TBLNODATA, /* no table data cells specified */
134: MANDOCERR_TBLIGNDATA, /* ignore data in cell */
135: MANDOCERR_TBLBLOCK, /* data block still open */
1.30 schwarze 136: MANDOCERR_TBLEXTRADAT, /* ignoring extra data cells */
1.27 schwarze 137:
1.25 schwarze 138: MANDOCERR_ROFFLOOP, /* input stack limit exceeded, infinite loop? */
1.19 schwarze 139: MANDOCERR_BADCHAR, /* skipping bad character */
1.29 schwarze 140: MANDOCERR_NAMESC, /* escaped character not allowed in a name */
1.47 schwarze 141: MANDOCERR_NONAME, /* manual name not yet set */
1.69 schwarze 142: MANDOCERR_NOTEXT, /* skipping text before first section header */
1.19 schwarze 143: MANDOCERR_MACRO, /* skipping unknown macro */
1.3 schwarze 144: MANDOCERR_ARGCOUNT, /* argument count wrong */
1.73 schwarze 145: MANDOCERR_RS_SKIP, /* skipping invalid content in .Rs block: macro */
1.80 schwarze 146: MANDOCERR_ST_BAD, /* unknown standard specifier: standard */
1.50 schwarze 147: MANDOCERR_STRAYTA, /* skipping column outside column list */
1.19 schwarze 148: MANDOCERR_NOSCOPE, /* skipping end of block that is not open */
1.17 schwarze 149: MANDOCERR_SCOPEBROKEN, /* missing end of block */
1.13 schwarze 150: MANDOCERR_SCOPEEXIT, /* scope open on exit */
1.17 schwarze 151: MANDOCERR_UNAME, /* uname(3) system call failed */
1.52 schwarze 152: MANDOCERR_NUMERIC, /* request requires a numeric argument */
1.77 schwarze 153: MANDOCERR_BL_NOTYPE, /* missing list type, using -item */
1.78 schwarze 154: MANDOCERR_ARG_SKIP, /* skipping all arguments: macro args */
155: MANDOCERR_ARG_EXCESS, /* skipping excess arguments: macro ... args */
1.8 schwarze 156:
1.16 schwarze 157: MANDOCERR_FATAL, /* ===== start of fatal errors ===== */
1.24 schwarze 158:
1.57 schwarze 159: MANDOCERR_TOOLARGE, /* input too large */
1.68 schwarze 160: MANDOCERR_NOTMANUAL, /* not a manual */
1.6 schwarze 161: MANDOCERR_COLUMNS, /* column syntax is inconsistent */
1.21 schwarze 162: MANDOCERR_BADDISP, /* NOT IMPLEMENTED: .Bd -file */
1.3 schwarze 163: MANDOCERR_SYNTCHILD, /* child violates parent syntax */
164: MANDOCERR_SYNTARGCOUNT, /* argument count wrong, violates syntax */
1.67 schwarze 165: MANDOCERR_SO_PATH, /* NOT IMPLEMENTED: .so with absolute path or ".." */
166: MANDOCERR_SO_FAIL, /* .so request failed */
1.3 schwarze 167: MANDOCERR_NODOCPROLOG, /* no document prologue */
1.12 schwarze 168: MANDOCERR_MEM, /* static buffer exhausted */
1.57 schwarze 169:
170: /* ===== system errors ===== */
171:
172: MANDOCERR_SYSOPEN, /* cannot open file */
173: MANDOCERR_SYSSTAT, /* cannot stat file */
174: MANDOCERR_SYSREAD, /* cannot read file */
175:
1.1 schwarze 176: MANDOCERR_MAX
1.27 schwarze 177: };
178:
1.51 schwarze 179: struct tbl_opts {
1.27 schwarze 180: char tab; /* cell-separator */
181: char decimal; /* decimal point */
182: int linesize;
183: int opts;
184: #define TBL_OPT_CENTRE (1 << 0)
185: #define TBL_OPT_EXPAND (1 << 1)
186: #define TBL_OPT_BOX (1 << 2)
187: #define TBL_OPT_DBOX (1 << 3)
188: #define TBL_OPT_ALLBOX (1 << 4)
189: #define TBL_OPT_NOKEEP (1 << 5)
190: #define TBL_OPT_NOSPACE (1 << 6)
191: int cols; /* number of columns */
192: };
193:
194: /*
195: * The head of a table specifies all of its columns. When formatting a
196: * tbl_span, iterate over these and plug in data from the tbl_span when
197: * appropriate, using tbl_cell as a guide to placement.
198: */
199: struct tbl_head {
200: int ident; /* 0 <= unique id < cols */
1.45 schwarze 201: int vert; /* width of preceding vertical line */
1.27 schwarze 202: struct tbl_head *next;
203: struct tbl_head *prev;
204: };
205:
206: enum tbl_cellt {
207: TBL_CELL_CENTRE, /* c, C */
208: TBL_CELL_RIGHT, /* r, R */
209: TBL_CELL_LEFT, /* l, L */
210: TBL_CELL_NUMBER, /* n, N */
211: TBL_CELL_SPAN, /* s, S */
212: TBL_CELL_LONG, /* a, A */
213: TBL_CELL_DOWN, /* ^ */
214: TBL_CELL_HORIZ, /* _, - */
215: TBL_CELL_DHORIZ, /* = */
216: TBL_CELL_MAX
217: };
218:
219: /*
220: * A cell in a layout row.
221: */
222: struct tbl_cell {
223: struct tbl_cell *next;
1.45 schwarze 224: int vert; /* width of preceding vertical line */
1.27 schwarze 225: enum tbl_cellt pos;
1.30 schwarze 226: size_t spacing;
1.27 schwarze 227: int flags;
228: #define TBL_CELL_TALIGN (1 << 0) /* t, T */
229: #define TBL_CELL_BALIGN (1 << 1) /* d, D */
230: #define TBL_CELL_BOLD (1 << 2) /* fB, B, b */
231: #define TBL_CELL_ITALIC (1 << 3) /* fI, I, i */
232: #define TBL_CELL_EQUAL (1 << 4) /* e, E */
233: #define TBL_CELL_UP (1 << 5) /* u, U */
234: #define TBL_CELL_WIGN (1 << 6) /* z, Z */
235: struct tbl_head *head;
236: };
237:
238: /*
239: * A layout row.
240: */
241: struct tbl_row {
242: struct tbl_row *next;
243: struct tbl_cell *first;
244: struct tbl_cell *last;
1.63 schwarze 245: int vert; /* trailing vertical line */
1.27 schwarze 246: };
247:
248: enum tbl_datt {
1.30 schwarze 249: TBL_DATA_NONE, /* has no data */
250: TBL_DATA_DATA, /* consists of data/string */
251: TBL_DATA_HORIZ, /* horizontal line */
252: TBL_DATA_DHORIZ, /* double-horizontal line */
253: TBL_DATA_NHORIZ, /* squeezed horizontal line */
254: TBL_DATA_NDHORIZ /* squeezed double-horizontal line */
1.27 schwarze 255: };
256:
257: /*
258: * A cell within a row of data. The "string" field contains the actual
259: * string value that's in the cell. The rest is layout.
260: */
261: struct tbl_dat {
1.30 schwarze 262: struct tbl_cell *layout; /* layout cell */
263: int spans; /* how many spans follow */
1.27 schwarze 264: struct tbl_dat *next;
1.30 schwarze 265: char *string; /* data (NULL if not TBL_DATA_DATA) */
1.27 schwarze 266: enum tbl_datt pos;
267: };
268:
269: enum tbl_spant {
270: TBL_SPAN_DATA, /* span consists of data */
271: TBL_SPAN_HORIZ, /* span is horizontal line */
272: TBL_SPAN_DHORIZ /* span is double horizontal line */
273: };
274:
275: /*
276: * A row of data in a table.
277: */
278: struct tbl_span {
1.51 schwarze 279: struct tbl_opts *opts;
1.27 schwarze 280: struct tbl_head *head;
1.30 schwarze 281: struct tbl_row *layout; /* layout row */
1.27 schwarze 282: struct tbl_dat *first;
283: struct tbl_dat *last;
1.33 schwarze 284: int line; /* parse line */
1.27 schwarze 285: int flags;
286: #define TBL_SPAN_FIRST (1 << 0)
287: #define TBL_SPAN_LAST (1 << 1)
288: enum tbl_spant pos;
289: struct tbl_span *next;
1.35 schwarze 290: };
291:
1.40 schwarze 292: enum eqn_boxt {
293: EQN_ROOT, /* root of parse tree */
294: EQN_TEXT, /* text (number, variable, whatever) */
295: EQN_SUBEXPR, /* nested `eqn' subexpression */
296: EQN_LIST, /* subexpressions list */
297: EQN_MATRIX /* matrix subexpression */
298: };
299:
300: enum eqn_markt {
301: EQNMARK_NONE = 0,
302: EQNMARK_DOT,
303: EQNMARK_DOTDOT,
304: EQNMARK_HAT,
305: EQNMARK_TILDE,
306: EQNMARK_VEC,
307: EQNMARK_DYAD,
308: EQNMARK_BAR,
309: EQNMARK_UNDER,
310: EQNMARK__MAX
311: };
312:
313: enum eqn_fontt {
314: EQNFONT_NONE = 0,
315: EQNFONT_ROMAN,
316: EQNFONT_BOLD,
317: EQNFONT_FAT,
318: EQNFONT_ITALIC,
319: EQNFONT__MAX
320: };
321:
322: enum eqn_post {
323: EQNPOS_NONE = 0,
324: EQNPOS_OVER,
325: EQNPOS_SUP,
326: EQNPOS_SUB,
327: EQNPOS_TO,
328: EQNPOS_FROM,
329: EQNPOS__MAX
330: };
331:
332: enum eqn_pilet {
333: EQNPILE_NONE = 0,
334: EQNPILE_PILE,
335: EQNPILE_CPILE,
336: EQNPILE_RPILE,
337: EQNPILE_LPILE,
338: EQNPILE_COL,
339: EQNPILE_CCOL,
340: EQNPILE_RCOL,
341: EQNPILE_LCOL,
342: EQNPILE__MAX
343: };
344:
345: /*
346: * A "box" is a parsed mathematical expression as defined by the eqn.7
347: * grammar.
348: */
349: struct eqn_box {
350: int size; /* font size of expression */
351: #define EQN_DEFSIZE INT_MIN
352: enum eqn_boxt type; /* type of node */
353: struct eqn_box *first; /* first child node */
354: struct eqn_box *last; /* last child node */
355: struct eqn_box *next; /* node sibling */
356: struct eqn_box *parent; /* node sibling */
357: char *text; /* text (or NULL) */
358: char *left;
359: char *right;
360: enum eqn_post pos; /* position of next box */
361: enum eqn_markt mark; /* a mark about the box */
362: enum eqn_fontt font; /* font of box */
363: enum eqn_pilet pile; /* equation piling */
364: };
365:
366: /*
367: * An equation consists of a tree of expressions starting at a given
1.64 schwarze 368: * line and position.
1.40 schwarze 369: */
1.35 schwarze 370: struct eqn {
1.40 schwarze 371: char *name; /* identifier (or NULL) */
372: struct eqn_box *root; /* root mathematical expression */
373: int ln; /* invocation line */
1.35 schwarze 374: int pos; /* invocation position */
1.1 schwarze 375: };
376:
1.16 schwarze 377: /*
1.60 schwarze 378: * Parse options.
379: */
380: #define MPARSE_MDOC 1 /* assume -mdoc */
381: #define MPARSE_MAN 2 /* assume -man */
382: #define MPARSE_SO 4 /* honour .so requests */
383: #define MPARSE_QUICK 8 /* abort the parse early */
1.37 schwarze 384:
1.38 schwarze 385: enum mandoc_esc {
386: ESCAPE_ERROR = 0, /* bail! unparsable escape */
387: ESCAPE_IGNORE, /* escape to be ignored */
388: ESCAPE_SPECIAL, /* a regular special character */
389: ESCAPE_FONT, /* a generic font mode */
390: ESCAPE_FONTBOLD, /* bold font mode */
391: ESCAPE_FONTITALIC, /* italic font mode */
1.53 schwarze 392: ESCAPE_FONTBI, /* bold italic font mode */
1.38 schwarze 393: ESCAPE_FONTROMAN, /* roman font mode */
394: ESCAPE_FONTPREV, /* previous font mode */
395: ESCAPE_NUMBERED, /* a numbered glyph */
396: ESCAPE_UNICODE, /* a unicode codepoint */
1.46 schwarze 397: ESCAPE_NOSPACE, /* suppress space if the last on a line */
398: ESCAPE_SKIPCHAR /* skip the next character */
1.38 schwarze 399: };
400:
1.37 schwarze 401: typedef void (*mandocmsg)(enum mandocerr, enum mandoclevel,
402: const char *, int, int, const char *);
403:
404: struct mparse;
1.38 schwarze 405: struct mchars;
1.37 schwarze 406: struct mdoc;
407: struct man;
1.10 schwarze 408:
1.37 schwarze 409: __BEGIN_DECLS
1.16 schwarze 410:
1.56 schwarze 411: enum mandoc_esc mandoc_escape(const char **, const char **, int *);
1.38 schwarze 412: struct mchars *mchars_alloc(void);
1.41 schwarze 413: void mchars_free(struct mchars *);
1.64 schwarze 414: char mchars_num2char(const char *, size_t);
1.38 schwarze 415: int mchars_num2uc(const char *, size_t);
1.64 schwarze 416: int mchars_spec2cp(const struct mchars *,
1.41 schwarze 417: const char *, size_t);
1.64 schwarze 418: const char *mchars_spec2str(const struct mchars *,
1.41 schwarze 419: const char *, size_t, size_t *);
1.60 schwarze 420: struct mparse *mparse_alloc(int, enum mandoclevel, mandocmsg, char *);
1.41 schwarze 421: void mparse_free(struct mparse *);
422: void mparse_keep(struct mparse *);
423: enum mandoclevel mparse_readfd(struct mparse *, int, const char *);
424: void mparse_reset(struct mparse *);
1.64 schwarze 425: void mparse_result(struct mparse *,
1.61 schwarze 426: struct mdoc **, struct man **, char **);
1.41 schwarze 427: const char *mparse_getkeep(const struct mparse *);
428: const char *mparse_strerror(enum mandocerr);
429: const char *mparse_strlevel(enum mandoclevel);
1.1 schwarze 430:
431: __END_DECLS
432:
433: #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