Annotation of mandoc/mandoc.h, Revision 1.106
1.106 ! schwarze 1: /* $Id: mandoc.h,v 1.105 2012/11/16 22:21:05 schwarze Exp $ */
1.1 kristaps 2: /*
1.46 schwarze 3: * Copyright (c) 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.106 ! schwarze 4: * Copyright (c) 2012 Ingo Schwarze <schwarze@openbsd.org>
1.1 kristaps 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.7 kristaps 20:
21: #define ASCII_NBRSP 31 /* non-breaking space */
22: #define ASCII_HYPH 30 /* breakable hyphen */
23:
1.22 kristaps 24: /*
25: * Status level. This refers to both internal status (i.e., whilst
26: * running, when warnings/errors are reported) and an indicator of a
27: * threshold of when to halt (when said internal state exceeds the
28: * threshold).
29: */
1.18 schwarze 30: enum mandoclevel {
31: MANDOCLEVEL_OK = 0,
32: MANDOCLEVEL_RESERVED,
1.22 kristaps 33: MANDOCLEVEL_WARNING, /* warnings: syntax, whitespace, etc. */
34: MANDOCLEVEL_ERROR, /* input has been thrown away */
35: MANDOCLEVEL_FATAL, /* input is borked */
36: MANDOCLEVEL_BADARG, /* bad argument in invocation */
37: MANDOCLEVEL_SYSERR, /* system error */
1.18 schwarze 38: MANDOCLEVEL_MAX
39: };
40:
1.22 kristaps 41: /*
42: * All possible things that can go wrong within a parse, be it libroff,
43: * libmdoc, or libman.
44: */
1.1 kristaps 45: enum mandocerr {
46: MANDOCERR_OK,
1.13 schwarze 47:
1.21 kristaps 48: MANDOCERR_WARNING, /* ===== start of warnings ===== */
1.32 kristaps 49:
50: /* related to the prologue */
51: MANDOCERR_NOTITLE, /* no title in document */
52: MANDOCERR_UPPERCASE, /* document title should be all caps */
53: MANDOCERR_BADMSEC, /* unknown manual section */
1.105 schwarze 54: MANDOCERR_BADVOLARCH, /* unknown manual volume or arch */
1.58 schwarze 55: MANDOCERR_NODATE, /* date missing, using today's date */
56: MANDOCERR_BADDATE, /* cannot parse date, using it verbatim */
1.32 kristaps 57: MANDOCERR_PROLOGOOO, /* prologue macros out of order */
58: MANDOCERR_PROLOGREP, /* duplicate prologue macro */
59: MANDOCERR_BADPROLOG, /* macro not allowed in prologue */
60: MANDOCERR_BADBODY, /* macro not allowed in body */
61:
62: /* related to document structure */
1.26 kristaps 63: MANDOCERR_SO, /* .so is fragile, better use ln(1) */
1.32 kristaps 64: MANDOCERR_NAMESECFIRST, /* NAME section must come first */
65: MANDOCERR_BADNAMESEC, /* bad NAME section contents */
1.9 kristaps 66: MANDOCERR_SECOOO, /* sections out of conventional order */
1.32 kristaps 67: MANDOCERR_SECREP, /* duplicate section name */
1.5 kristaps 68: MANDOCERR_SECMSEC, /* section not in conventional manual section */
1.32 kristaps 69:
70: /* related to macros and nesting */
71: MANDOCERR_MACROOBS, /* skipping obsolete macro */
1.35 kristaps 72: MANDOCERR_IGNPAR, /* skipping paragraph macro */
1.104 schwarze 73: MANDOCERR_MOVEPAR, /* moving paragraph macro out of list */
1.54 kristaps 74: MANDOCERR_IGNNS, /* skipping no-space macro */
1.14 schwarze 75: MANDOCERR_SCOPENEST, /* blocks badly nested */
1.32 kristaps 76: MANDOCERR_CHILD, /* child violates parent syntax */
77: MANDOCERR_NESTEDDISP, /* nested displays are not portable */
78: MANDOCERR_SCOPEREP, /* already in literal mode */
1.68 kristaps 79: MANDOCERR_LINESCOPE, /* line scope broken */
1.32 kristaps 80:
81: /* related to missing macro arguments */
82: MANDOCERR_MACROEMPTY, /* skipping empty macro */
1.46 schwarze 83: MANDOCERR_ARGCWARN, /* argument count wrong */
1.32 kristaps 84: MANDOCERR_DISPTYPE, /* missing display type */
85: MANDOCERR_LISTFIRST, /* list type must come first */
86: MANDOCERR_NOWIDTHARG, /* tag lists require a width argument */
87: MANDOCERR_FONTTYPE, /* missing font type */
1.53 kristaps 88: MANDOCERR_WNOSCOPE, /* skipping end of block that is not open */
1.13 schwarze 89:
1.32 kristaps 90: /* related to bad macro arguments */
91: MANDOCERR_IGNARGV, /* skipping argument */
92: MANDOCERR_ARGVREP, /* duplicate argument */
93: MANDOCERR_DISPREP, /* duplicate display type */
94: MANDOCERR_LISTREP, /* duplicate list type */
95: MANDOCERR_BADATT, /* unknown AT&T UNIX version */
1.5 kristaps 96: MANDOCERR_BADBOOL, /* bad Boolean value */
1.31 kristaps 97: MANDOCERR_BADFONT, /* unknown font */
1.32 kristaps 98: MANDOCERR_BADSTANDARD, /* unknown standard specifier */
99: MANDOCERR_BADWIDTH, /* bad width argument */
100:
101: /* related to plain text */
102: MANDOCERR_NOBLANKLN, /* blank line in non-literal context */
103: MANDOCERR_BADTAB, /* tab in non-literal context */
104: MANDOCERR_EOLNSPACE, /* end of line whitespace */
1.5 kristaps 105: MANDOCERR_BADCOMMENT, /* bad comment style */
1.32 kristaps 106: MANDOCERR_BADESCAPE, /* unknown escape sequence */
107: MANDOCERR_BADQUOTE, /* unterminated quoted string */
1.79 kristaps 108:
109: /* related to equations */
110: MANDOCERR_EQNQUOTE, /* unexpected literal in equation */
1.32 kristaps 111:
112: MANDOCERR_ERROR, /* ===== start of errors ===== */
1.80 kristaps 113:
114: /* related to equations */
1.84 kristaps 115: MANDOCERR_EQNNSCOPE, /* unexpected equation scope closure*/
116: MANDOCERR_EQNSCOPE, /* equation scope open on exit */
1.89 kristaps 117: MANDOCERR_EQNBADSCOPE, /* overlapping equation scopes */
118: MANDOCERR_EQNEOF, /* unexpected end of equation */
119: MANDOCERR_EQNSYNT, /* equation syntax error */
1.32 kristaps 120:
1.42 kristaps 121: /* related to tables */
1.36 kristaps 122: MANDOCERR_TBL, /* bad table syntax */
123: MANDOCERR_TBLOPT, /* bad table option */
1.37 kristaps 124: MANDOCERR_TBLLAYOUT, /* bad table layout */
125: MANDOCERR_TBLNOLAYOUT, /* no table layout cells specified */
1.39 kristaps 126: MANDOCERR_TBLNODATA, /* no table data cells specified */
1.47 kristaps 127: MANDOCERR_TBLIGNDATA, /* ignore data in cell */
1.48 kristaps 128: MANDOCERR_TBLBLOCK, /* data block still open */
1.50 kristaps 129: MANDOCERR_TBLEXTRADAT, /* ignoring extra data cells */
1.42 kristaps 130:
1.33 schwarze 131: MANDOCERR_ROFFLOOP, /* input stack limit exceeded, infinite loop? */
1.32 kristaps 132: MANDOCERR_BADCHAR, /* skipping bad character */
1.52 schwarze 133: MANDOCERR_NAMESC, /* escaped character not allowed in a name */
1.103 schwarze 134: MANDOCERR_NONAME, /* manual name not yet set */
1.32 kristaps 135: MANDOCERR_NOTEXT, /* skipping text before the first section header */
136: MANDOCERR_MACRO, /* skipping unknown macro */
1.25 kristaps 137: MANDOCERR_REQUEST, /* NOT IMPLEMENTED: skipping request */
1.5 kristaps 138: MANDOCERR_ARGCOUNT, /* argument count wrong */
1.106 ! schwarze 139: MANDOCERR_STRAYTA, /* skipping column outside column list */
1.32 kristaps 140: MANDOCERR_NOSCOPE, /* skipping end of block that is not open */
1.30 kristaps 141: MANDOCERR_SCOPEBROKEN, /* missing end of block */
1.19 schwarze 142: MANDOCERR_SCOPEEXIT, /* scope open on exit */
1.28 kristaps 143: MANDOCERR_UNAME, /* uname(3) system call failed */
1.5 kristaps 144: /* FIXME: merge following with MANDOCERR_ARGCOUNT */
145: MANDOCERR_NOARGS, /* macro requires line argument(s) */
146: MANDOCERR_NOBODY, /* macro requires body argument(s) */
147: MANDOCERR_NOARGV, /* macro requires argument(s) */
1.10 kristaps 148: MANDOCERR_LISTTYPE, /* missing list type */
1.5 kristaps 149: MANDOCERR_ARGSLOST, /* line argument(s) will be lost */
150: MANDOCERR_BODYLOST, /* body argument(s) will be lost */
1.13 schwarze 151:
1.21 kristaps 152: MANDOCERR_FATAL, /* ===== start of fatal errors ===== */
1.32 kristaps 153:
1.66 kristaps 154: MANDOCERR_NOTMANUAL, /* manual isn't really a manual */
1.8 kristaps 155: MANDOCERR_COLUMNS, /* column syntax is inconsistent */
1.32 kristaps 156: MANDOCERR_BADDISP, /* NOT IMPLEMENTED: .Bd -file */
1.5 kristaps 157: MANDOCERR_SYNTARGVCOUNT, /* argument count wrong, violates syntax */
158: MANDOCERR_SYNTCHILD, /* child violates parent syntax */
159: MANDOCERR_SYNTARGCOUNT, /* argument count wrong, violates syntax */
1.26 kristaps 160: MANDOCERR_SOPATH, /* NOT IMPLEMENTED: .so with absolute path or ".." */
1.5 kristaps 161: MANDOCERR_NODOCBODY, /* no document body */
162: MANDOCERR_NODOCPROLOG, /* no document prologue */
1.18 schwarze 163: MANDOCERR_MEM, /* static buffer exhausted */
1.1 kristaps 164: MANDOCERR_MAX
1.43 kristaps 165: };
166:
167: struct tbl {
168: char tab; /* cell-separator */
169: char decimal; /* decimal point */
170: int linesize;
171: int opts;
172: #define TBL_OPT_CENTRE (1 << 0)
173: #define TBL_OPT_EXPAND (1 << 1)
174: #define TBL_OPT_BOX (1 << 2)
175: #define TBL_OPT_DBOX (1 << 3)
176: #define TBL_OPT_ALLBOX (1 << 4)
177: #define TBL_OPT_NOKEEP (1 << 5)
178: #define TBL_OPT_NOSPACE (1 << 6)
1.45 kristaps 179: int cols; /* number of columns */
1.38 kristaps 180: };
181:
1.41 kristaps 182: /*
183: * The head of a table specifies all of its columns. When formatting a
184: * tbl_span, iterate over these and plug in data from the tbl_span when
185: * appropriate, using tbl_cell as a guide to placement.
186: */
187: struct tbl_head {
1.45 kristaps 188: int ident; /* 0 <= unique id < cols */
1.101 schwarze 189: int vert; /* width of preceding vertical line */
1.41 kristaps 190: struct tbl_head *next;
191: struct tbl_head *prev;
192: };
193:
1.38 kristaps 194: enum tbl_cellt {
195: TBL_CELL_CENTRE, /* c, C */
196: TBL_CELL_RIGHT, /* r, R */
197: TBL_CELL_LEFT, /* l, L */
198: TBL_CELL_NUMBER, /* n, N */
199: TBL_CELL_SPAN, /* s, S */
200: TBL_CELL_LONG, /* a, A */
201: TBL_CELL_DOWN, /* ^ */
202: TBL_CELL_HORIZ, /* _, - */
203: TBL_CELL_DHORIZ, /* = */
204: TBL_CELL_MAX
205: };
206:
207: /*
208: * A cell in a layout row.
209: */
210: struct tbl_cell {
211: struct tbl_cell *next;
1.101 schwarze 212: int vert; /* width of preceding vertical line */
1.38 kristaps 213: enum tbl_cellt pos;
1.51 kristaps 214: size_t spacing;
1.38 kristaps 215: int flags;
216: #define TBL_CELL_TALIGN (1 << 0) /* t, T */
217: #define TBL_CELL_BALIGN (1 << 1) /* d, D */
218: #define TBL_CELL_BOLD (1 << 2) /* fB, B, b */
219: #define TBL_CELL_ITALIC (1 << 3) /* fI, I, i */
220: #define TBL_CELL_EQUAL (1 << 4) /* e, E */
221: #define TBL_CELL_UP (1 << 5) /* u, U */
222: #define TBL_CELL_WIGN (1 << 6) /* z, Z */
1.41 kristaps 223: struct tbl_head *head;
1.38 kristaps 224: };
225:
226: /*
227: * A layout row.
228: */
229: struct tbl_row {
230: struct tbl_row *next;
231: struct tbl_cell *first;
232: struct tbl_cell *last;
233: };
234:
1.40 kristaps 235: enum tbl_datt {
1.51 kristaps 236: TBL_DATA_NONE, /* has no data */
237: TBL_DATA_DATA, /* consists of data/string */
238: TBL_DATA_HORIZ, /* horizontal line */
239: TBL_DATA_DHORIZ, /* double-horizontal line */
240: TBL_DATA_NHORIZ, /* squeezed horizontal line */
241: TBL_DATA_NDHORIZ /* squeezed double-horizontal line */
1.40 kristaps 242: };
243:
1.38 kristaps 244: /*
245: * A cell within a row of data. The "string" field contains the actual
246: * string value that's in the cell. The rest is layout.
247: */
248: struct tbl_dat {
1.51 kristaps 249: struct tbl_cell *layout; /* layout cell */
1.50 kristaps 250: int spans; /* how many spans follow */
1.38 kristaps 251: struct tbl_dat *next;
1.51 kristaps 252: char *string; /* data (NULL if not TBL_DATA_DATA) */
1.40 kristaps 253: enum tbl_datt pos;
254: };
255:
256: enum tbl_spant {
257: TBL_SPAN_DATA, /* span consists of data */
258: TBL_SPAN_HORIZ, /* span is horizontal line */
259: TBL_SPAN_DHORIZ /* span is double horizontal line */
1.38 kristaps 260: };
261:
262: /*
263: * A row of data in a table.
264: */
265: struct tbl_span {
1.44 kristaps 266: struct tbl *tbl;
267: struct tbl_head *head;
1.51 kristaps 268: struct tbl_row *layout; /* layout row */
1.38 kristaps 269: struct tbl_dat *first;
270: struct tbl_dat *last;
1.56 kristaps 271: int line; /* parse line */
1.44 kristaps 272: int flags;
273: #define TBL_SPAN_FIRST (1 << 0)
274: #define TBL_SPAN_LAST (1 << 1)
1.40 kristaps 275: enum tbl_spant pos;
1.38 kristaps 276: struct tbl_span *next;
1.55 kristaps 277: };
278:
1.83 kristaps 279: enum eqn_boxt {
1.84 kristaps 280: EQN_ROOT, /* root of parse tree */
281: EQN_TEXT, /* text (number, variable, whatever) */
1.90 kristaps 282: EQN_SUBEXPR, /* nested `eqn' subexpression */
1.92 kristaps 283: EQN_LIST, /* subexpressions list */
284: EQN_MATRIX /* matrix subexpression */
1.83 kristaps 285: };
286:
1.85 kristaps 287: enum eqn_markt {
288: EQNMARK_NONE = 0,
289: EQNMARK_DOT,
290: EQNMARK_DOTDOT,
291: EQNMARK_HAT,
292: EQNMARK_TILDE,
293: EQNMARK_VEC,
294: EQNMARK_DYAD,
295: EQNMARK_BAR,
296: EQNMARK_UNDER,
297: EQNMARK__MAX
298: };
299:
1.86 kristaps 300: enum eqn_fontt {
301: EQNFONT_NONE = 0,
302: EQNFONT_ROMAN,
303: EQNFONT_BOLD,
1.93 kristaps 304: EQNFONT_FAT,
1.86 kristaps 305: EQNFONT_ITALIC,
306: EQNFONT__MAX
307: };
308:
1.87 kristaps 309: enum eqn_post {
310: EQNPOS_NONE = 0,
311: EQNPOS_OVER,
312: EQNPOS_SUP,
313: EQNPOS_SUB,
314: EQNPOS_TO,
315: EQNPOS_FROM,
316: EQNPOS__MAX
317: };
318:
1.89 kristaps 319: enum eqn_pilet {
320: EQNPILE_NONE = 0,
1.95 kristaps 321: EQNPILE_PILE,
1.89 kristaps 322: EQNPILE_CPILE,
323: EQNPILE_RPILE,
324: EQNPILE_LPILE,
1.95 kristaps 325: EQNPILE_COL,
1.92 kristaps 326: EQNPILE_CCOL,
327: EQNPILE_RCOL,
328: EQNPILE_LCOL,
1.89 kristaps 329: EQNPILE__MAX
330: };
331:
1.86 kristaps 332: /*
1.84 kristaps 333: * A "box" is a parsed mathematical expression as defined by the eqn.7
334: * grammar.
335: */
1.83 kristaps 336: struct eqn_box {
1.88 kristaps 337: int size; /* font size of expression */
338: #define EQN_DEFSIZE INT_MIN
1.84 kristaps 339: enum eqn_boxt type; /* type of node */
1.89 kristaps 340: struct eqn_box *first; /* first child node */
341: struct eqn_box *last; /* last child node */
342: struct eqn_box *next; /* node sibling */
343: struct eqn_box *parent; /* node sibling */
344: char *text; /* text (or NULL) */
345: char *left;
346: char *right;
1.87 kristaps 347: enum eqn_post pos; /* position of next box */
1.86 kristaps 348: enum eqn_markt mark; /* a mark about the box */
349: enum eqn_fontt font; /* font of box */
1.89 kristaps 350: enum eqn_pilet pile; /* equation piling */
1.83 kristaps 351: };
352:
1.87 kristaps 353: /*
354: * An equation consists of a tree of expressions starting at a given
355: * line and position.
356: */
1.55 kristaps 357: struct eqn {
1.94 kristaps 358: char *name; /* identifier (or NULL) */
1.84 kristaps 359: struct eqn_box *root; /* root mathematical expression */
1.82 kristaps 360: int ln; /* invocation line */
1.57 kristaps 361: int pos; /* invocation position */
1.16 kristaps 362: };
1.22 kristaps 363:
1.60 kristaps 364: /*
1.62 kristaps 365: * The type of parse sequence. This value is usually passed via the
366: * mandoc(1) command line of -man and -mdoc. It's almost exclusively
367: * -mandoc but the others have been retained for compatibility.
368: */
369: enum mparset {
370: MPARSE_AUTO, /* magically determine the document type */
371: MPARSE_MDOC, /* assume -mdoc */
372: MPARSE_MAN /* assume -man */
373: };
374:
1.70 kristaps 375: enum mandoc_esc {
376: ESCAPE_ERROR = 0, /* bail! unparsable escape */
377: ESCAPE_IGNORE, /* escape to be ignored */
378: ESCAPE_SPECIAL, /* a regular special character */
379: ESCAPE_FONT, /* a generic font mode */
380: ESCAPE_FONTBOLD, /* bold font mode */
381: ESCAPE_FONTITALIC, /* italic font mode */
382: ESCAPE_FONTROMAN, /* roman font mode */
383: ESCAPE_FONTPREV, /* previous font mode */
384: ESCAPE_NUMBERED, /* a numbered glyph */
1.75 kristaps 385: ESCAPE_UNICODE, /* a unicode codepoint */
1.102 schwarze 386: ESCAPE_NOSPACE, /* suppress space if the last on a line */
387: ESCAPE_SKIPCHAR /* skip the next character */
1.70 kristaps 388: };
389:
1.63 kristaps 390: typedef void (*mandocmsg)(enum mandocerr, enum mandoclevel,
391: const char *, int, int, const char *);
1.62 kristaps 392:
393: struct mparse;
1.71 kristaps 394: struct mchars;
1.62 kristaps 395: struct mdoc;
396: struct man;
1.59 kristaps 397:
1.22 kristaps 398: __BEGIN_DECLS
1.62 kristaps 399:
1.59 kristaps 400: void *mandoc_calloc(size_t, size_t);
1.96 kristaps 401: enum mandoc_esc mandoc_escape(const char **, const char **, int *);
1.59 kristaps 402: void *mandoc_malloc(size_t);
403: void *mandoc_realloc(void *, size_t);
1.78 kristaps 404: char *mandoc_strdup(const char *);
1.89 kristaps 405: char *mandoc_strndup(const char *, size_t);
1.73 kristaps 406: struct mchars *mchars_alloc(void);
1.96 kristaps 407: void mchars_free(struct mchars *);
1.74 kristaps 408: char mchars_num2char(const char *, size_t);
1.76 kristaps 409: int mchars_num2uc(const char *, size_t);
1.98 kristaps 410: int mchars_spec2cp(const struct mchars *,
1.96 kristaps 411: const char *, size_t);
1.98 kristaps 412: const char *mchars_spec2str(const struct mchars *,
1.96 kristaps 413: const char *, size_t, size_t *);
1.100 schwarze 414: struct mparse *mparse_alloc(enum mparset, enum mandoclevel,
415: mandocmsg, void *, char *);
1.96 kristaps 416: void mparse_free(struct mparse *);
417: void mparse_keep(struct mparse *);
418: enum mandoclevel mparse_readfd(struct mparse *, int, const char *);
1.99 joerg 419: enum mandoclevel mparse_readmem(struct mparse *, const void *, size_t,
420: const char *);
1.96 kristaps 421: void mparse_reset(struct mparse *);
422: void mparse_result(struct mparse *,
423: struct mdoc **, struct man **);
424: const char *mparse_getkeep(const struct mparse *);
425: const char *mparse_strerror(enum mandocerr);
426: const char *mparse_strlevel(enum mandoclevel);
1.1 kristaps 427:
428: __END_DECLS
429:
430: #endif /*!MANDOC_H*/
CVSweb