mandoc.h

   1 /*      $Id: mandoc.h,v 1.204 2015/07/19 06:05:16 schwarze Exp $ */
   2 /*
   3  * Copyright (c) 2010, 2011, 2014 Kristaps Dzonsons <kristaps@bsd.lv>
   4  * Copyright (c) 2010-2015 Ingo Schwarze <schwarze@openbsd.org>
   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 AUTHORS DISCLAIM ALL WARRANTIES
  11  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  12  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS 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
  19 #define ASCII_NBRSP      31  /* non-breaking space */
  20 #define ASCII_HYPH       30  /* breakable hyphen */
  21 #define ASCII_BREAK      29  /* breakable zero-width space */
  22
  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  */
  29 enum    mandoclevel {
  30         MANDOCLEVEL_OK = 0,
  31         MANDOCLEVEL_RESERVED,
  32         MANDOCLEVEL_WARNING, /* warnings: syntax, whitespace, etc. */
  33         MANDOCLEVEL_ERROR, /* input has been thrown away */
  34         MANDOCLEVEL_UNSUPP, /* input needs unimplemented features */
  35         MANDOCLEVEL_BADARG, /* bad argument in invocation */
  36         MANDOCLEVEL_SYSERR, /* system error */
  37         MANDOCLEVEL_MAX
  38 };
  39
  40 /*
  41  * All possible things that can go wrong within a parse, be it libroff,
  42  * libmdoc, or libman.
  43  */
  44 enum    mandocerr {
  45         MANDOCERR_OK,
  46
  47         MANDOCERR_WARNING, /* ===== start of warnings ===== */
  48
  49         /* related to the prologue */
  50         MANDOCERR_DT_NOTITLE, /* missing manual title, using UNTITLED: line */
  51         MANDOCERR_TH_NOTITLE, /* missing manual title, using "": [macro] */
  52         MANDOCERR_TITLE_CASE, /* lower case character in document title */
  53         MANDOCERR_MSEC_MISSING, /* missing manual section, using "": macro */
  54         MANDOCERR_MSEC_BAD, /* unknown manual section: Dt ... section */
  55         MANDOCERR_DATE_MISSING, /* missing date, using today's date */
  56         MANDOCERR_DATE_BAD, /* cannot parse date, using it verbatim: date */
  57         MANDOCERR_OS_MISSING, /* missing Os macro, using "" */
  58         MANDOCERR_PROLOG_REP, /* duplicate prologue macro: macro */
  59         MANDOCERR_PROLOG_LATE, /* late prologue macro: macro */
  60         MANDOCERR_DT_LATE, /* skipping late title macro: Dt args */
  61         MANDOCERR_PROLOG_ORDER, /* prologue macros out of order: macros */
  62
  63         /* related to document structure */
  64         MANDOCERR_SO, /* .so is fragile, better use ln(1): so path */
  65         MANDOCERR_DOC_EMPTY, /* no document body */
  66         MANDOCERR_SEC_BEFORE, /* content before first section header: macro */
  67         MANDOCERR_NAMESEC_FIRST, /* first section is not NAME: Sh title */
  68         MANDOCERR_NAMESEC_NONM, /* NAME section without name */
  69         MANDOCERR_NAMESEC_NOND, /* NAME section without description */
  70         MANDOCERR_NAMESEC_ND, /* description not at the end of NAME */
  71         MANDOCERR_NAMESEC_BAD, /* bad NAME section content: macro */
  72         MANDOCERR_ND_EMPTY, /* missing description line, using "" */
  73         MANDOCERR_SEC_ORDER, /* sections out of conventional order: Sh title */
  74         MANDOCERR_SEC_REP, /* duplicate section title: Sh title */
  75         MANDOCERR_SEC_MSEC, /* unexpected section: Sh title for ... only */
  76         MANDOCERR_XR_ORDER, /* unusual Xr order: ... after ... */
  77         MANDOCERR_XR_PUNCT, /* unusual Xr punctuation: ... after ... */
  78         MANDOCERR_AN_MISSING, /* AUTHORS section without An macro */
  79
  80         /* related to macros and nesting */
  81         MANDOCERR_MACRO_OBS, /* obsolete macro: macro */
  82         MANDOCERR_MACRO_CALL, /* macro neither callable nor escaped: macro */
  83         MANDOCERR_PAR_SKIP, /* skipping paragraph macro: macro ... */
  84         MANDOCERR_PAR_MOVE, /* moving paragraph macro out of list: macro */
  85         MANDOCERR_NS_SKIP, /* skipping no-space macro */
  86         MANDOCERR_BLK_NEST, /* blocks badly nested: macro ... */
  87         MANDOCERR_BD_NEST, /* nested displays are not portable: macro ... */
  88         MANDOCERR_BL_MOVE, /* moving content out of list: macro */
  89         MANDOCERR_VT_CHILD, /* .Vt block has child macro: macro */
  90         MANDOCERR_FI_SKIP, /* fill mode already enabled, skipping: fi */
  91         MANDOCERR_NF_SKIP, /* fill mode already disabled, skipping: nf */
  92         MANDOCERR_BLK_LINE, /* line scope broken: macro breaks macro */
  93
  94         /* related to missing arguments */
  95         MANDOCERR_REQ_EMPTY, /* skipping empty request: request */
  96         MANDOCERR_COND_EMPTY, /* conditional request controls empty scope */
  97         MANDOCERR_MACRO_EMPTY, /* skipping empty macro: macro */
  98         MANDOCERR_BLK_EMPTY, /* empty block: macro */
  99         MANDOCERR_ARG_EMPTY, /* empty argument, using 0n: macro arg */
 100         MANDOCERR_BD_NOTYPE, /* missing display type, using -ragged: Bd */
 101         MANDOCERR_BL_LATETYPE, /* list type is not the first argument: Bl arg */
 102         MANDOCERR_BL_NOWIDTH, /* missing -width in -tag list, using 8n */
 103         MANDOCERR_EX_NONAME, /* missing utility name, using "": Ex */
 104         MANDOCERR_FO_NOHEAD, /* missing function name, using "": Fo */
 105         MANDOCERR_IT_NOHEAD, /* empty head in list item: Bl -type It */
 106         MANDOCERR_IT_NOBODY, /* empty list item: Bl -type It */
 107         MANDOCERR_BF_NOFONT, /* missing font type, using \fR: Bf */
 108         MANDOCERR_BF_BADFONT, /* unknown font type, using \fR: Bf font */
 109         MANDOCERR_PF_SKIP, /* nothing follows prefix: Pf arg */
 110         MANDOCERR_RS_EMPTY, /* empty reference block: Rs */
 111         MANDOCERR_ARG_STD, /* missing -std argument, adding it: macro */
 112         MANDOCERR_OP_EMPTY, /* missing option string, using "": OP */
 113         MANDOCERR_UR_NOHEAD, /* missing resource identifier, using "": UR */
 114         MANDOCERR_EQN_NOBOX, /* missing eqn box, using "": op */
 115
 116         /* related to bad arguments */
 117         MANDOCERR_ARG_QUOTE, /* unterminated quoted argument */
 118         MANDOCERR_ARG_REP, /* duplicate argument: macro arg */
 119         MANDOCERR_AN_REP, /* skipping duplicate argument: An -arg */
 120         MANDOCERR_BD_REP, /* skipping duplicate display type: Bd -type */
 121         MANDOCERR_BL_REP, /* skipping duplicate list type: Bl -type */
 122         MANDOCERR_BL_SKIPW, /* skipping -width argument: Bl -type */
 123         MANDOCERR_BL_COL, /* wrong number of cells */
 124         MANDOCERR_AT_BAD, /* unknown AT&T UNIX version: At version */
 125         MANDOCERR_FA_COMMA, /* comma in function argument: arg */
 126         MANDOCERR_FN_PAREN, /* parenthesis in function name: arg */
 127         MANDOCERR_RS_BAD, /* invalid content in Rs block: macro */
 128         MANDOCERR_SM_BAD, /* invalid Boolean argument: macro arg */
 129         MANDOCERR_FT_BAD, /* unknown font, skipping request: ft font */
 130         MANDOCERR_TR_ODD, /* odd number of characters in request: tr char */
 131
 132         /* related to plain text */
 133         MANDOCERR_FI_BLANK, /* blank line in fill mode, using .sp */
 134         MANDOCERR_FI_TAB, /* tab in filled text */
 135         MANDOCERR_SPACE_EOL, /* whitespace at end of input line */
 136         MANDOCERR_COMMENT_BAD, /* bad comment style */
 137         MANDOCERR_ESC_BAD, /* invalid escape sequence: esc */
 138         MANDOCERR_STR_UNDEF, /* undefined string, using "": name */
 139
 140         /* related to tables */
 141         MANDOCERR_TBLLAYOUT_SPAN, /* tbl line starts with span */
 142         MANDOCERR_TBLLAYOUT_DOWN, /* tbl column starts with span */
 143         MANDOCERR_TBLLAYOUT_VERT, /* skipping vertical bar in tbl layout */
 144
 145         MANDOCERR_ERROR, /* ===== start of errors ===== */
 146
 147         /* related to tables */
 148         MANDOCERR_TBLOPT_ALPHA, /* non-alphabetic character in tbl options */
 149         MANDOCERR_TBLOPT_BAD, /* skipping unknown tbl option: option */
 150         MANDOCERR_TBLOPT_NOARG, /* missing tbl option argument: option */
 151         MANDOCERR_TBLOPT_ARGSZ, /* wrong tbl option argument size: option */
 152         MANDOCERR_TBLLAYOUT_NONE, /* empty tbl layout */
 153         MANDOCERR_TBLLAYOUT_CHAR, /* invalid character in tbl layout: char */
 154         MANDOCERR_TBLLAYOUT_PAR, /* unmatched parenthesis in tbl layout */
 155         MANDOCERR_TBLDATA_NONE, /* tbl without any data cells */
 156         MANDOCERR_TBLDATA_SPAN, /* ignoring data in spanned tbl cell: data */
 157         MANDOCERR_TBLDATA_EXTRA, /* ignoring extra tbl data cells: data */
 158         MANDOCERR_TBLDATA_BLK, /* data block open at end of tbl: macro */
 159
 160         /* related to document structure and macros */
 161         MANDOCERR_FILE, /* cannot open file */
 162         MANDOCERR_ROFFLOOP, /* input stack limit exceeded, infinite loop? */
 163         MANDOCERR_CHAR_BAD, /* skipping bad character: number */
 164         MANDOCERR_MACRO, /* skipping unknown macro: macro */
 165         MANDOCERR_REQ_INSEC, /* skipping insecure request: request */
 166         MANDOCERR_IT_STRAY, /* skipping item outside list: It ... */
 167         MANDOCERR_TA_STRAY, /* skipping column outside column list: Ta */
 168         MANDOCERR_BLK_NOTOPEN, /* skipping end of block that is not open */
 169         MANDOCERR_RE_NOTOPEN, /* fewer RS blocks open, skipping: RE arg */
 170         MANDOCERR_BLK_BROKEN, /* inserting missing end of block: macro ... */
 171         MANDOCERR_BLK_NOEND, /* appending missing end of block: macro */
 172
 173         /* related to request and macro arguments */
 174         MANDOCERR_NAMESC, /* escaped character not allowed in a name: name */
 175         MANDOCERR_BD_FILE, /* NOT IMPLEMENTED: Bd -file */
 176         MANDOCERR_BL_NOTYPE, /* missing list type, using -item: Bl */
 177         MANDOCERR_NM_NONAME, /* missing manual name, using "": Nm */
 178         MANDOCERR_OS_UNAME, /* uname(3) system call failed, using UNKNOWN */
 179         MANDOCERR_ST_BAD, /* unknown standard specifier: St standard */
 180         MANDOCERR_IT_NONUM, /* skipping request without numeric argument */
 181         MANDOCERR_SO_PATH, /* NOT IMPLEMENTED: .so with absolute path or ".." */
 182         MANDOCERR_SO_FAIL, /* .so request failed */
 183         MANDOCERR_ARG_SKIP, /* skipping all arguments: macro args */
 184         MANDOCERR_ARG_EXCESS, /* skipping excess arguments: macro ... args */
 185         MANDOCERR_DIVZERO, /* divide by zero */
 186
 187         MANDOCERR_UNSUPP, /* ===== start of unsupported features ===== */
 188
 189         MANDOCERR_TOOLARGE, /* input too large */
 190         MANDOCERR_CHAR_UNSUPP, /* unsupported control character: number */
 191         MANDOCERR_REQ_UNSUPP, /* unsupported roff request: request */
 192         MANDOCERR_TBLOPT_EQN, /* eqn delim option in tbl: arg */
 193         MANDOCERR_TBLLAYOUT_MOD, /* unsupported tbl layout modifier: m */
 194         MANDOCERR_TBLMACRO, /* ignoring macro in table: macro */
 195
 196         MANDOCERR_MAX
 197 };
 198
 199 struct  tbl_opts {
 200         char              tab; /* cell-separator */
 201         char              decimal; /* decimal point */
 202         int               opts;
 203 #define TBL_OPT_CENTRE   (1 << 0)
 204 #define TBL_OPT_EXPAND   (1 << 1)
 205 #define TBL_OPT_BOX      (1 << 2)
 206 #define TBL_OPT_DBOX     (1 << 3)
 207 #define TBL_OPT_ALLBOX   (1 << 4)
 208 #define TBL_OPT_NOKEEP   (1 << 5)
 209 #define TBL_OPT_NOSPACE  (1 << 6)
 210 #define TBL_OPT_NOWARN   (1 << 7)
 211         int               cols; /* number of columns */
 212         int               lvert; /* width of left vertical line */
 213         int               rvert; /* width of right vertical line */
 214 };
 215
 216 enum    tbl_cellt {
 217         TBL_CELL_CENTRE, /* c, C */
 218         TBL_CELL_RIGHT, /* r, R */
 219         TBL_CELL_LEFT, /* l, L */
 220         TBL_CELL_NUMBER, /* n, N */
 221         TBL_CELL_SPAN, /* s, S */
 222         TBL_CELL_LONG, /* a, A */
 223         TBL_CELL_DOWN, /* ^ */
 224         TBL_CELL_HORIZ, /* _, - */
 225         TBL_CELL_DHORIZ, /* = */
 226         TBL_CELL_MAX
 227 };
 228
 229 /*
 230  * A cell in a layout row.
 231  */
 232 struct  tbl_cell {
 233         struct tbl_cell  *next;
 234         int               vert; /* width of subsequent vertical line */
 235         enum tbl_cellt    pos;
 236         size_t            spacing;
 237         int               col; /* column number, starting from 0 */
 238         int               flags;
 239 #define TBL_CELL_TALIGN  (1 << 0) /* t, T */
 240 #define TBL_CELL_BALIGN  (1 << 1) /* d, D */
 241 #define TBL_CELL_BOLD    (1 << 2) /* fB, B, b */
 242 #define TBL_CELL_ITALIC  (1 << 3) /* fI, I, i */
 243 #define TBL_CELL_EQUAL   (1 << 4) /* e, E */
 244 #define TBL_CELL_UP      (1 << 5) /* u, U */
 245 #define TBL_CELL_WIGN    (1 << 6) /* z, Z */
 246 #define TBL_CELL_WMAX    (1 << 7) /* x, X */
 247 };
 248
 249 /*
 250  * A layout row.
 251  */
 252 struct  tbl_row {
 253         struct tbl_row   *next;
 254         struct tbl_cell  *first;
 255         struct tbl_cell  *last;
 256         int               vert; /* width of left vertical line */
 257 };
 258
 259 enum    tbl_datt {
 260         TBL_DATA_NONE, /* has no data */
 261         TBL_DATA_DATA, /* consists of data/string */
 262         TBL_DATA_HORIZ, /* horizontal line */
 263         TBL_DATA_DHORIZ, /* double-horizontal line */
 264         TBL_DATA_NHORIZ, /* squeezed horizontal line */
 265         TBL_DATA_NDHORIZ /* squeezed double-horizontal line */
 266 };
 267
 268 /*
 269  * A cell within a row of data.  The "string" field contains the actual
 270  * string value that's in the cell.  The rest is layout.
 271  */
 272 struct  tbl_dat {
 273         struct tbl_cell  *layout; /* layout cell */
 274         int               spans; /* how many spans follow */
 275         struct tbl_dat   *next;
 276         char             *string; /* data (NULL if not TBL_DATA_DATA) */
 277         enum tbl_datt     pos;
 278 };
 279
 280 enum    tbl_spant {
 281         TBL_SPAN_DATA, /* span consists of data */
 282         TBL_SPAN_HORIZ, /* span is horizontal line */
 283         TBL_SPAN_DHORIZ /* span is double horizontal line */
 284 };
 285
 286 /*
 287  * A row of data in a table.
 288  */
 289 struct  tbl_span {
 290         struct tbl_opts  *opts;
 291         struct tbl_row   *layout; /* layout row */
 292         struct tbl_dat   *first;
 293         struct tbl_dat   *last;
 294         struct tbl_span  *prev;
 295         struct tbl_span  *next;
 296         int               line; /* parse line */
 297         enum tbl_spant    pos;
 298 };
 299
 300 enum    eqn_boxt {
 301         EQN_ROOT, /* root of parse tree */
 302         EQN_TEXT, /* text (number, variable, whatever) */
 303         EQN_SUBEXPR, /* nested `eqn' subexpression */
 304         EQN_LIST, /* list (braces, etc.) */
 305         EQN_LISTONE, /* singleton list */
 306         EQN_PILE, /* vertical pile */
 307         EQN_MATRIX /* pile of piles */
 308 };
 309
 310 enum    eqn_fontt {
 311         EQNFONT_NONE = 0,
 312         EQNFONT_ROMAN,
 313         EQNFONT_BOLD,
 314         EQNFONT_FAT,
 315         EQNFONT_ITALIC,
 316         EQNFONT__MAX
 317 };
 318
 319 enum    eqn_post {
 320         EQNPOS_NONE = 0,
 321         EQNPOS_SUP,
 322         EQNPOS_SUBSUP,
 323         EQNPOS_SUB,
 324         EQNPOS_TO,
 325         EQNPOS_FROM,
 326         EQNPOS_FROMTO,
 327         EQNPOS_OVER,
 328         EQNPOS_SQRT,
 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   *prev; /* node sibling */
 357         struct eqn_box   *parent; /* node sibling */
 358         char             *text; /* text (or NULL) */
 359         char             *left; /* fence left-hand */
 360         char             *right; /* fence right-hand */
 361         char             *top; /* expression over-symbol */
 362         char             *bottom; /* expression under-symbol */
 363         size_t            args; /* arguments in parent */
 364         size_t            expectargs; /* max arguments in parent */
 365         enum eqn_post     pos; /* position of next box */
 366         enum eqn_fontt    font; /* font of box */
 367         enum eqn_pilet    pile; /* equation piling */
 368 };
 369
 370 /*
 371  * An equation consists of a tree of expressions starting at a given
 372  * line and position.
 373  */
 374 struct  eqn {
 375         char             *name; /* identifier (or NULL) */
 376         struct eqn_box   *root; /* root mathematical expression */
 377         int               ln; /* invocation line */
 378         int               pos; /* invocation position */
 379 };
 380
 381 /*
 382  * Parse options.
 383  */
 384 #define MPARSE_MDOC     1  /* assume -mdoc */
 385 #define MPARSE_MAN      2  /* assume -man */
 386 #define MPARSE_SO       4  /* honour .so requests */
 387 #define MPARSE_QUICK    8  /* abort the parse early */
 388 #define MPARSE_UTF8     16 /* accept UTF-8 input */
 389 #define MPARSE_LATIN1   32 /* accept ISO-LATIN-1 input */
 390
 391 enum    mandoc_esc {
 392         ESCAPE_ERROR = 0, /* bail! unparsable escape */
 393         ESCAPE_IGNORE, /* escape to be ignored */
 394         ESCAPE_SPECIAL, /* a regular special character */
 395         ESCAPE_FONT, /* a generic font mode */
 396         ESCAPE_FONTBOLD, /* bold font mode */
 397         ESCAPE_FONTITALIC, /* italic font mode */
 398         ESCAPE_FONTBI, /* bold italic font mode */
 399         ESCAPE_FONTROMAN, /* roman font mode */
 400         ESCAPE_FONTPREV, /* previous font mode */
 401         ESCAPE_NUMBERED, /* a numbered glyph */
 402         ESCAPE_UNICODE, /* a unicode codepoint */
 403         ESCAPE_NOSPACE, /* suppress space if the last on a line */
 404         ESCAPE_SKIPCHAR, /* skip the next character */
 405         ESCAPE_OVERSTRIKE /* overstrike all chars in the argument */
 406 };
 407
 408 typedef void    (*mandocmsg)(enum mandocerr, enum mandoclevel,
 409                         const char *, int, int, const char *);
 410
 411 __BEGIN_DECLS
 412
 413 struct  mparse;
 414 struct  mchars;
 415 struct  roff_man;
 416
 417 enum mandoc_esc   mandoc_escape(const char **, const char **, int *);
 418 struct mchars    *mchars_alloc(void);
 419 void              mchars_free(struct mchars *);
 420 int               mchars_num2char(const char *, size_t);
 421 const char       *mchars_uc2str(int);
 422 int               mchars_num2uc(const char *, size_t);
 423 int               mchars_spec2cp(const struct mchars *,
 424                         const char *, size_t);
 425 const char       *mchars_spec2str(const struct mchars *,
 426                         const char *, size_t, size_t *);
 427 struct mparse    *mparse_alloc(int, enum mandoclevel, mandocmsg,
 428                         const struct mchars *, const char *);
 429 void              mparse_free(struct mparse *);
 430 void              mparse_keep(struct mparse *);
 431 enum mandoclevel  mparse_open(struct mparse *, int *, const char *);
 432 enum mandoclevel  mparse_readfd(struct mparse *, int, const char *);
 433 enum mandoclevel  mparse_readmem(struct mparse *, void *, size_t,
 434                         const char *);
 435 void              mparse_reset(struct mparse *);
 436 void              mparse_result(struct mparse *,
 437                         struct roff_man **, char **);
 438 const char       *mparse_getkeep(const struct mparse *);
 439 const char       *mparse_strerror(enum mandocerr);
 440 const char       *mparse_strlevel(enum mandoclevel);
 441
 442 __END_DECLS