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