Annotation of src/usr.bin/mandoc/mandoc.h, Revision 1.95
1.95 ! schwarze 1: /* $Id: mandoc.h,v 1.94 2014/08/08 15:48:43 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 */
1.95 ! schwarze 54: MANDOCERR_MSEC_BAD, /* unknown manual section: Dt ... section */
! 55: MANDOCERR_ARCH_BAD, /* unknown manual volume or arch: Dt ... volume */
1.69 schwarze 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.95 ! 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 */
1.95 ! schwarze 67: MANDOCERR_NAMESEC_FIRST, /* first section is not NAME: Sh title */
1.69 schwarze 68: MANDOCERR_NAMESEC_BAD, /* bad NAME section contents: macro */
1.95 ! schwarze 69: MANDOCERR_SEC_ORDER, /* sections out of conventional order: Sh title */
! 70: MANDOCERR_SEC_REP, /* duplicate section title: Sh title */
! 71: MANDOCERR_SEC_MSEC, /* unexpected section: Sh 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 */
1.85 schwarze 78: MANDOCERR_BLK_NEST, /* blocks badly nested: macro ... */
1.72 schwarze 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.95 ! schwarze 82: MANDOCERR_FI_SKIP, /* fill mode already enabled, skipping: fi */
! 83: MANDOCERR_NF_SKIP, /* fill mode already disabled, skipping: nf */
1.85 schwarze 84: MANDOCERR_BLK_LINE, /* 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.95 ! schwarze 92: MANDOCERR_BD_NOTYPE, /* missing display type, using -ragged: Bd */
! 93: MANDOCERR_BL_LATETYPE, /* list type is not the first argument: Bl arg */
1.80 schwarze 94: MANDOCERR_BL_NOWIDTH, /* missing -width in -tag list, using 8n */
1.95 ! schwarze 95: MANDOCERR_EX_NONAME, /* missing utility name, using "": Ex */
! 96: MANDOCERR_IT_NOHEAD, /* empty head in list item: Bl -type It */
! 97: MANDOCERR_IT_NOBODY, /* empty list item: Bl -type It */
! 98: MANDOCERR_BF_NOFONT, /* missing font type, using \fR: Bf */
! 99: MANDOCERR_BF_BADFONT, /* unknown font type, using \fR: Bf font */
1.77 schwarze 100: MANDOCERR_ARG_STD, /* missing -std argument, adding it: macro */
1.19 schwarze 101:
1.81 schwarze 102: /* related to bad arguments */
103: MANDOCERR_ARG_QUOTE, /* unterminated quoted argument */
1.79 schwarze 104: MANDOCERR_ARG_REP, /* duplicate argument: macro arg */
1.93 schwarze 105: MANDOCERR_AN_REP, /* skipping duplicate argument: An -arg */
1.95 ! schwarze 106: MANDOCERR_BD_REP, /* skipping duplicate display type: Bd -type */
! 107: MANDOCERR_BL_REP, /* skipping duplicate list type: Bl -type */
1.93 schwarze 108: MANDOCERR_BL_SKIPW, /* skipping -width argument: Bl -type */
1.95 ! schwarze 109: MANDOCERR_AT_BAD, /* unknown AT&T UNIX version: At version */
1.84 schwarze 110: MANDOCERR_RS_BAD, /* invalid content in Rs block: macro */
1.80 schwarze 111: MANDOCERR_SM_BAD, /* invalid Boolean argument: macro arg */
1.95 ! schwarze 112: MANDOCERR_FT_BAD, /* unknown font, skipping request: ft font */
1.19 schwarze 113:
114: /* related to plain text */
1.81 schwarze 115: MANDOCERR_FI_BLANK, /* blank line in fill mode, using .sp */
116: MANDOCERR_FI_TAB, /* tab in filled text */
117: MANDOCERR_SPACE_EOL, /* whitespace at end of input line */
118: MANDOCERR_COMMENT_BAD, /* bad comment style */
119: MANDOCERR_ESC_BAD, /* invalid escape sequence: esc */
120: MANDOCERR_STR_UNDEF, /* undefined string, using "": name */
1.8 schwarze 121:
1.16 schwarze 122: MANDOCERR_ERROR, /* ===== start of errors ===== */
1.24 schwarze 123:
1.40 schwarze 124: /* related to equations */
125: MANDOCERR_EQNNSCOPE, /* unexpected equation scope closure*/
126: MANDOCERR_EQNSCOPE, /* equation scope open on exit */
127: MANDOCERR_EQNBADSCOPE, /* overlapping equation scopes */
128: MANDOCERR_EQNEOF, /* unexpected end of equation */
129: MANDOCERR_EQNSYNT, /* equation syntax error */
130:
1.27 schwarze 131: /* related to tables */
132: MANDOCERR_TBL, /* bad table syntax */
133: MANDOCERR_TBLOPT, /* bad table option */
134: MANDOCERR_TBLLAYOUT, /* bad table layout */
135: MANDOCERR_TBLNOLAYOUT, /* no table layout cells specified */
136: MANDOCERR_TBLNODATA, /* no table data cells specified */
137: MANDOCERR_TBLIGNDATA, /* ignore data in cell */
138: MANDOCERR_TBLBLOCK, /* data block still open */
1.30 schwarze 139: MANDOCERR_TBLEXTRADAT, /* ignoring extra data cells */
1.27 schwarze 140:
1.85 schwarze 141: /* related to document structure and macros */
1.25 schwarze 142: MANDOCERR_ROFFLOOP, /* input stack limit exceeded, infinite loop? */
1.95 ! schwarze 143: MANDOCERR_BADCHAR, /* skipping bad character: number */
! 144: MANDOCERR_MACRO, /* skipping unknown macro: macro */
! 145: MANDOCERR_IT_STRAY, /* skipping item outside list: It ... */
! 146: MANDOCERR_TA_STRAY, /* skipping column outside column list: Ta */
1.85 schwarze 147: MANDOCERR_BLK_NOTOPEN, /* skipping end of block that is not open */
148: MANDOCERR_BLK_BROKEN, /* inserting missing end of block: macro ... */
149: MANDOCERR_BLK_NOEND, /* appending missing end of block: macro */
150:
151: /* related to request and macro arguments */
1.95 ! schwarze 152: MANDOCERR_NAMESC, /* escaped character not allowed in a name: name */
1.3 schwarze 153: MANDOCERR_ARGCOUNT, /* argument count wrong */
1.95 ! schwarze 154: MANDOCERR_BL_NOTYPE, /* missing list type, using -item: Bl */
! 155: MANDOCERR_NM_NONAME, /* missing manual name, using "": Nm */
1.88 schwarze 156: MANDOCERR_OS_UNAME, /* uname(3) system call failed, using UNKNOWN */
1.95 ! schwarze 157: MANDOCERR_ST_BAD, /* unknown standard specifier: St standard */
1.88 schwarze 158: MANDOCERR_IT_NONUM, /* skipping request without numeric argument */
1.78 schwarze 159: MANDOCERR_ARG_SKIP, /* skipping all arguments: macro args */
160: MANDOCERR_ARG_EXCESS, /* skipping excess arguments: macro ... args */
1.8 schwarze 161:
1.16 schwarze 162: MANDOCERR_FATAL, /* ===== start of fatal errors ===== */
1.24 schwarze 163:
1.57 schwarze 164: MANDOCERR_TOOLARGE, /* input too large */
1.95 ! schwarze 165: MANDOCERR_BD_FILE, /* NOT IMPLEMENTED: Bd -file */
1.67 schwarze 166: MANDOCERR_SO_PATH, /* NOT IMPLEMENTED: .so with absolute path or ".." */
167: MANDOCERR_SO_FAIL, /* .so request failed */
1.57 schwarze 168:
169: /* ===== system errors ===== */
170:
171: MANDOCERR_SYSOPEN, /* cannot open file */
172: MANDOCERR_SYSSTAT, /* cannot stat file */
173: MANDOCERR_SYSREAD, /* cannot read file */
174:
1.1 schwarze 175: MANDOCERR_MAX
1.27 schwarze 176: };
177:
1.51 schwarze 178: struct tbl_opts {
1.27 schwarze 179: char tab; /* cell-separator */
180: char decimal; /* decimal point */
181: int linesize;
182: int opts;
183: #define TBL_OPT_CENTRE (1 << 0)
184: #define TBL_OPT_EXPAND (1 << 1)
185: #define TBL_OPT_BOX (1 << 2)
186: #define TBL_OPT_DBOX (1 << 3)
187: #define TBL_OPT_ALLBOX (1 << 4)
188: #define TBL_OPT_NOKEEP (1 << 5)
189: #define TBL_OPT_NOSPACE (1 << 6)
190: int cols; /* number of columns */
191: };
192:
193: /*
194: * The head of a table specifies all of its columns. When formatting a
195: * tbl_span, iterate over these and plug in data from the tbl_span when
196: * appropriate, using tbl_cell as a guide to placement.
197: */
198: struct tbl_head {
199: int ident; /* 0 <= unique id < cols */
1.45 schwarze 200: int vert; /* width of preceding vertical line */
1.27 schwarze 201: struct tbl_head *next;
202: struct tbl_head *prev;
203: };
204:
205: enum tbl_cellt {
206: TBL_CELL_CENTRE, /* c, C */
207: TBL_CELL_RIGHT, /* r, R */
208: TBL_CELL_LEFT, /* l, L */
209: TBL_CELL_NUMBER, /* n, N */
210: TBL_CELL_SPAN, /* s, S */
211: TBL_CELL_LONG, /* a, A */
212: TBL_CELL_DOWN, /* ^ */
213: TBL_CELL_HORIZ, /* _, - */
214: TBL_CELL_DHORIZ, /* = */
215: TBL_CELL_MAX
216: };
217:
218: /*
219: * A cell in a layout row.
220: */
221: struct tbl_cell {
222: struct tbl_cell *next;
1.45 schwarze 223: int vert; /* width of preceding vertical line */
1.27 schwarze 224: enum tbl_cellt pos;
1.30 schwarze 225: size_t spacing;
1.27 schwarze 226: int flags;
227: #define TBL_CELL_TALIGN (1 << 0) /* t, T */
228: #define TBL_CELL_BALIGN (1 << 1) /* d, D */
229: #define TBL_CELL_BOLD (1 << 2) /* fB, B, b */
230: #define TBL_CELL_ITALIC (1 << 3) /* fI, I, i */
231: #define TBL_CELL_EQUAL (1 << 4) /* e, E */
232: #define TBL_CELL_UP (1 << 5) /* u, U */
233: #define TBL_CELL_WIGN (1 << 6) /* z, Z */
234: struct tbl_head *head;
235: };
236:
237: /*
238: * A layout row.
239: */
240: struct tbl_row {
241: struct tbl_row *next;
242: struct tbl_cell *first;
243: struct tbl_cell *last;
1.63 schwarze 244: int vert; /* trailing vertical line */
1.27 schwarze 245: };
246:
247: enum tbl_datt {
1.30 schwarze 248: TBL_DATA_NONE, /* has no data */
249: TBL_DATA_DATA, /* consists of data/string */
250: TBL_DATA_HORIZ, /* horizontal line */
251: TBL_DATA_DHORIZ, /* double-horizontal line */
252: TBL_DATA_NHORIZ, /* squeezed horizontal line */
253: TBL_DATA_NDHORIZ /* squeezed double-horizontal line */
1.27 schwarze 254: };
255:
256: /*
257: * A cell within a row of data. The "string" field contains the actual
258: * string value that's in the cell. The rest is layout.
259: */
260: struct tbl_dat {
1.30 schwarze 261: struct tbl_cell *layout; /* layout cell */
262: int spans; /* how many spans follow */
1.27 schwarze 263: struct tbl_dat *next;
1.30 schwarze 264: char *string; /* data (NULL if not TBL_DATA_DATA) */
1.27 schwarze 265: enum tbl_datt pos;
266: };
267:
268: enum tbl_spant {
269: TBL_SPAN_DATA, /* span consists of data */
270: TBL_SPAN_HORIZ, /* span is horizontal line */
271: TBL_SPAN_DHORIZ /* span is double horizontal line */
272: };
273:
274: /*
275: * A row of data in a table.
276: */
277: struct tbl_span {
1.51 schwarze 278: struct tbl_opts *opts;
1.27 schwarze 279: struct tbl_head *head;
1.30 schwarze 280: struct tbl_row *layout; /* layout row */
1.27 schwarze 281: struct tbl_dat *first;
282: struct tbl_dat *last;
1.33 schwarze 283: int line; /* parse line */
1.27 schwarze 284: int flags;
285: #define TBL_SPAN_FIRST (1 << 0)
286: #define TBL_SPAN_LAST (1 << 1)
287: enum tbl_spant pos;
288: struct tbl_span *next;
1.35 schwarze 289: };
290:
1.40 schwarze 291: enum eqn_boxt {
292: EQN_ROOT, /* root of parse tree */
293: EQN_TEXT, /* text (number, variable, whatever) */
294: EQN_SUBEXPR, /* nested `eqn' subexpression */
295: EQN_LIST, /* subexpressions list */
296: EQN_MATRIX /* matrix subexpression */
297: };
298:
299: enum eqn_markt {
300: EQNMARK_NONE = 0,
301: EQNMARK_DOT,
302: EQNMARK_DOTDOT,
303: EQNMARK_HAT,
304: EQNMARK_TILDE,
305: EQNMARK_VEC,
306: EQNMARK_DYAD,
307: EQNMARK_BAR,
308: EQNMARK_UNDER,
309: EQNMARK__MAX
310: };
311:
312: enum eqn_fontt {
313: EQNFONT_NONE = 0,
314: EQNFONT_ROMAN,
315: EQNFONT_BOLD,
316: EQNFONT_FAT,
317: EQNFONT_ITALIC,
318: EQNFONT__MAX
319: };
320:
321: enum eqn_post {
322: EQNPOS_NONE = 0,
323: EQNPOS_OVER,
324: EQNPOS_SUP,
325: EQNPOS_SUB,
326: EQNPOS_TO,
327: EQNPOS_FROM,
328: EQNPOS__MAX
329: };
330:
331: enum eqn_pilet {
332: EQNPILE_NONE = 0,
333: EQNPILE_PILE,
334: EQNPILE_CPILE,
335: EQNPILE_RPILE,
336: EQNPILE_LPILE,
337: EQNPILE_COL,
338: EQNPILE_CCOL,
339: EQNPILE_RCOL,
340: EQNPILE_LCOL,
341: EQNPILE__MAX
342: };
343:
344: /*
345: * A "box" is a parsed mathematical expression as defined by the eqn.7
346: * grammar.
347: */
348: struct eqn_box {
349: int size; /* font size of expression */
350: #define EQN_DEFSIZE INT_MIN
351: enum eqn_boxt type; /* type of node */
352: struct eqn_box *first; /* first child node */
353: struct eqn_box *last; /* last child node */
354: struct eqn_box *next; /* node sibling */
355: struct eqn_box *parent; /* node sibling */
356: char *text; /* text (or NULL) */
357: char *left;
358: char *right;
359: enum eqn_post pos; /* position of next box */
360: enum eqn_markt mark; /* a mark about the box */
361: enum eqn_fontt font; /* font of box */
362: enum eqn_pilet pile; /* equation piling */
363: };
364:
365: /*
366: * An equation consists of a tree of expressions starting at a given
1.64 schwarze 367: * line and position.
1.40 schwarze 368: */
1.35 schwarze 369: struct eqn {
1.40 schwarze 370: char *name; /* identifier (or NULL) */
371: struct eqn_box *root; /* root mathematical expression */
372: int ln; /* invocation line */
1.35 schwarze 373: int pos; /* invocation position */
1.1 schwarze 374: };
375:
1.16 schwarze 376: /*
1.60 schwarze 377: * Parse options.
378: */
379: #define MPARSE_MDOC 1 /* assume -mdoc */
380: #define MPARSE_MAN 2 /* assume -man */
381: #define MPARSE_SO 4 /* honour .so requests */
382: #define MPARSE_QUICK 8 /* abort the parse early */
1.37 schwarze 383:
1.38 schwarze 384: enum mandoc_esc {
385: ESCAPE_ERROR = 0, /* bail! unparsable escape */
386: ESCAPE_IGNORE, /* escape to be ignored */
387: ESCAPE_SPECIAL, /* a regular special character */
388: ESCAPE_FONT, /* a generic font mode */
389: ESCAPE_FONTBOLD, /* bold font mode */
390: ESCAPE_FONTITALIC, /* italic font mode */
1.53 schwarze 391: ESCAPE_FONTBI, /* bold italic font mode */
1.38 schwarze 392: ESCAPE_FONTROMAN, /* roman font mode */
393: ESCAPE_FONTPREV, /* previous font mode */
394: ESCAPE_NUMBERED, /* a numbered glyph */
395: ESCAPE_UNICODE, /* a unicode codepoint */
1.46 schwarze 396: ESCAPE_NOSPACE, /* suppress space if the last on a line */
397: ESCAPE_SKIPCHAR /* skip the next character */
1.38 schwarze 398: };
399:
1.37 schwarze 400: typedef void (*mandocmsg)(enum mandocerr, enum mandoclevel,
401: const char *, int, int, const char *);
402:
403: struct mparse;
1.38 schwarze 404: struct mchars;
1.37 schwarze 405: struct mdoc;
406: struct man;
1.10 schwarze 407:
1.37 schwarze 408: __BEGIN_DECLS
1.16 schwarze 409:
1.56 schwarze 410: enum mandoc_esc mandoc_escape(const char **, const char **, int *);
1.38 schwarze 411: struct mchars *mchars_alloc(void);
1.41 schwarze 412: void mchars_free(struct mchars *);
1.64 schwarze 413: char mchars_num2char(const char *, size_t);
1.38 schwarze 414: int mchars_num2uc(const char *, size_t);
1.64 schwarze 415: int mchars_spec2cp(const struct mchars *,
1.41 schwarze 416: const char *, size_t);
1.64 schwarze 417: const char *mchars_spec2str(const struct mchars *,
1.41 schwarze 418: const char *, size_t, size_t *);
1.86 schwarze 419: struct mparse *mparse_alloc(int, enum mandoclevel, mandocmsg,
420: const 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