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