[BACK]Return to mandoc.h CVS log [TXT][DIR] Up to [cvsweb.bsd.lv] / mandoc

Annotation of mandoc/mandoc.h, Revision 1.255

1.255   ! schwarze    1: /*     $Id: mandoc.h,v 1.254 2018/10/25 01:32:40 schwarze Exp $ */
1.1       kristaps    2: /*
1.160     schwarze    3:  * Copyright (c) 2010, 2011, 2014 Kristaps Dzonsons <kristaps@bsd.lv>
1.248     schwarze    4:  * Copyright (c) 2010-2018 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:  *
1.202     schwarze   10:  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
1.1       kristaps   11:  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
1.202     schwarze   12:  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
1.1       kristaps   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:  */
1.7       kristaps   18:
                     19: #define ASCII_NBRSP     31  /* non-breaking space */
                     20: #define        ASCII_HYPH       30  /* breakable hyphen */
1.115     schwarze   21: #define        ASCII_BREAK      29  /* breakable zero-width space */
1.7       kristaps   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,
1.216     schwarze   31:        MANDOCLEVEL_STYLE, /* style suggestions */
1.22      kristaps   32:        MANDOCLEVEL_WARNING, /* warnings: syntax, whitespace, etc. */
                     33:        MANDOCLEVEL_ERROR, /* input has been thrown away */
1.183     schwarze   34:        MANDOCLEVEL_UNSUPP, /* input needs unimplemented features */
1.22      kristaps   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.216     schwarze   46:
1.233     schwarze   47:        MANDOCERR_BASE, /* ===== start of base system conventions ===== */
1.217     schwarze   48:
1.229     schwarze   49:        MANDOCERR_MDOCDATE, /* Mdocdate found: Dd ... */
                     50:        MANDOCERR_MDOCDATE_MISSING, /* Mdocdate missing: Dd ... */
1.235     schwarze   51:        MANDOCERR_ARCH_BAD,  /* unknown architecture: Dt ... arch */
1.234     schwarze   52:        MANDOCERR_OS_ARG,  /* operating system explicitly specified: Os ... */
1.233     schwarze   53:        MANDOCERR_RCS_MISSING, /* RCS id missing */
1.238     schwarze   54:        MANDOCERR_XR_BAD,  /* referenced manual not found: Xr name sec */
1.233     schwarze   55:
                     56:        MANDOCERR_STYLE, /* ===== start of style suggestions ===== */
                     57:
1.229     schwarze   58:        MANDOCERR_DATE_LEGACY, /* legacy man(7) date format: Dd ... */
1.248     schwarze   59:        MANDOCERR_DATE_NORM, /* normalizing date format to: ... */
1.243     schwarze   60:        MANDOCERR_TITLE_CASE, /* lower case character in document title */
1.232     schwarze   61:        MANDOCERR_RCS_REP, /* duplicate RCS id: ... */
1.246     schwarze   62:        MANDOCERR_SEC_TYPO,  /* possible typo in section name: Sh ... */
1.243     schwarze   63:        MANDOCERR_ARG_QUOTE, /* unterminated quoted argument */
1.217     schwarze   64:        MANDOCERR_MACRO_USELESS, /* useless macro: macro */
1.218     schwarze   65:        MANDOCERR_BX, /* consider using OS macro: macro */
1.224     schwarze   66:        MANDOCERR_ER_ORDER, /* errnos out of order: Er ... */
                     67:        MANDOCERR_ER_REP, /* duplicate errno: Er ... */
1.241     schwarze   68:        MANDOCERR_DELIM, /* trailing delimiter: macro ... */
                     69:        MANDOCERR_DELIM_NB, /* no blank before trailing delimiter: macro ... */
1.243     schwarze   70:        MANDOCERR_FI_SKIP, /* fill mode already enabled, skipping: fi */
                     71:        MANDOCERR_NF_SKIP, /* fill mode already disabled, skipping: nf */
1.247     schwarze   72:        MANDOCERR_DASHDASH, /* verbatim "--", maybe consider using \(em */
1.228     schwarze   73:        MANDOCERR_FUNC, /* function name without markup: name() */
1.243     schwarze   74:        MANDOCERR_SPACE_EOL, /* whitespace at end of input line */
                     75:        MANDOCERR_COMMENT_BAD, /* bad comment style */
1.13      schwarze   76:
1.21      kristaps   77:        MANDOCERR_WARNING, /* ===== start of warnings ===== */
1.32      kristaps   78:
                     79:        /* related to the prologue */
1.152     schwarze   80:        MANDOCERR_DT_NOTITLE, /* missing manual title, using UNTITLED: line */
                     81:        MANDOCERR_TH_NOTITLE, /* missing manual title, using "": [macro] */
                     82:        MANDOCERR_MSEC_MISSING, /* missing manual section, using "": macro */
1.151     schwarze   83:        MANDOCERR_MSEC_BAD, /* unknown manual section: Dt ... section */
1.125     schwarze   84:        MANDOCERR_DATE_MISSING, /* missing date, using today's date */
                     85:        MANDOCERR_DATE_BAD, /* cannot parse date, using it verbatim: date */
1.240     schwarze   86:        MANDOCERR_DATE_FUTURE, /* date in the future, using it anyway: date */
1.152     schwarze   87:        MANDOCERR_OS_MISSING, /* missing Os macro, using "" */
                     88:        MANDOCERR_PROLOG_LATE, /* late prologue macro: macro */
                     89:        MANDOCERR_PROLOG_ORDER, /* prologue macros out of order: macros */
1.32      kristaps   90:
                     91:        /* related to document structure */
1.151     schwarze   92:        MANDOCERR_SO, /* .so is fragile, better use ln(1): so path */
1.122     schwarze   93:        MANDOCERR_DOC_EMPTY, /* no document body */
1.125     schwarze   94:        MANDOCERR_SEC_BEFORE, /* content before first section header: macro */
1.151     schwarze   95:        MANDOCERR_NAMESEC_FIRST, /* first section is not NAME: Sh title */
1.212     schwarze   96:        MANDOCERR_NAMESEC_NONM, /* NAME section without Nm before Nd */
1.201     schwarze   97:        MANDOCERR_NAMESEC_NOND, /* NAME section without description */
                     98:        MANDOCERR_NAMESEC_ND, /* description not at the end of NAME */
                     99:        MANDOCERR_NAMESEC_BAD, /* bad NAME section content: macro */
1.212     schwarze  100:        MANDOCERR_NAMESEC_PUNCT, /* missing comma before name: Nm name */
1.195     schwarze  101:        MANDOCERR_ND_EMPTY, /* missing description line, using "" */
1.215     schwarze  102:        MANDOCERR_ND_LATE, /* description line outside NAME section */
1.151     schwarze  103:        MANDOCERR_SEC_ORDER, /* sections out of conventional order: Sh title */
                    104:        MANDOCERR_SEC_REP, /* duplicate section title: Sh title */
                    105:        MANDOCERR_SEC_MSEC, /* unexpected section: Sh title for ... only */
1.239     schwarze  106:        MANDOCERR_XR_SELF,  /* cross reference to self: Xr name sec */
1.155     schwarze  107:        MANDOCERR_XR_ORDER, /* unusual Xr order: ... after ... */
                    108:        MANDOCERR_XR_PUNCT, /* unusual Xr punctuation: ... after ... */
1.154     schwarze  109:        MANDOCERR_AN_MISSING, /* AUTHORS section without An macro */
1.32      kristaps  110:
                    111:        /* related to macros and nesting */
1.126     schwarze  112:        MANDOCERR_MACRO_OBS, /* obsolete macro: macro */
1.172     schwarze  113:        MANDOCERR_MACRO_CALL, /* macro neither callable nor escaped: macro */
1.127     schwarze  114:        MANDOCERR_PAR_SKIP, /* skipping paragraph macro: macro ... */
                    115:        MANDOCERR_PAR_MOVE, /* moving paragraph macro out of list: macro */
1.128     schwarze  116:        MANDOCERR_NS_SKIP, /* skipping no-space macro */
1.141     schwarze  117:        MANDOCERR_BLK_NEST, /* blocks badly nested: macro ... */
1.128     schwarze  118:        MANDOCERR_BD_NEST, /* nested displays are not portable: macro ... */
1.129     schwarze  119:        MANDOCERR_BL_MOVE, /* moving content out of list: macro */
1.237     schwarze  120:        MANDOCERR_TA_LINE, /* first macro on line: Ta */
1.141     schwarze  121:        MANDOCERR_BLK_LINE, /* line scope broken: macro breaks macro */
1.222     schwarze  122:        MANDOCERR_BLK_BLANK, /* skipping blank line in line scope */
1.32      kristaps  123:
1.131     schwarze  124:        /* related to missing arguments */
                    125:        MANDOCERR_REQ_EMPTY, /* skipping empty request: request */
                    126:        MANDOCERR_COND_EMPTY, /* conditional request controls empty scope */
1.130     schwarze  127:        MANDOCERR_MACRO_EMPTY, /* skipping empty macro: macro */
1.198     schwarze  128:        MANDOCERR_BLK_EMPTY, /* empty block: macro */
1.135     schwarze  129:        MANDOCERR_ARG_EMPTY, /* empty argument, using 0n: macro arg */
1.151     schwarze  130:        MANDOCERR_BD_NOTYPE, /* missing display type, using -ragged: Bd */
                    131:        MANDOCERR_BL_LATETYPE, /* list type is not the first argument: Bl arg */
1.210     schwarze  132:        MANDOCERR_BL_NOWIDTH, /* missing -width in -tag list, using 6n */
1.151     schwarze  133:        MANDOCERR_EX_NONAME, /* missing utility name, using "": Ex */
1.197     schwarze  134:        MANDOCERR_FO_NOHEAD, /* missing function name, using "": Fo */
1.151     schwarze  135:        MANDOCERR_IT_NOHEAD, /* empty head in list item: Bl -type It */
                    136:        MANDOCERR_IT_NOBODY, /* empty list item: Bl -type It */
1.237     schwarze  137:        MANDOCERR_IT_NOARG, /* missing argument, using next line: Bl -c It */
1.151     schwarze  138:        MANDOCERR_BF_NOFONT, /* missing font type, using \fR: Bf */
                    139:        MANDOCERR_BF_BADFONT, /* unknown font type, using \fR: Bf font */
1.173     schwarze  140:        MANDOCERR_PF_SKIP, /* nothing follows prefix: Pf arg */
1.196     schwarze  141:        MANDOCERR_RS_EMPTY, /* empty reference block: Rs */
1.211     schwarze  142:        MANDOCERR_XR_NOSEC, /* missing section argument: Xr arg */
1.133     schwarze  143:        MANDOCERR_ARG_STD, /* missing -std argument, adding it: macro */
1.199     schwarze  144:        MANDOCERR_OP_EMPTY, /* missing option string, using "": OP */
                    145:        MANDOCERR_UR_NOHEAD, /* missing resource identifier, using "": UR */
1.162     schwarze  146:        MANDOCERR_EQN_NOBOX, /* missing eqn box, using "": op */
1.13      schwarze  147:
1.137     schwarze  148:        /* related to bad arguments */
1.135     schwarze  149:        MANDOCERR_ARG_REP, /* duplicate argument: macro arg */
1.149     schwarze  150:        MANDOCERR_AN_REP, /* skipping duplicate argument: An -arg */
1.151     schwarze  151:        MANDOCERR_BD_REP, /* skipping duplicate display type: Bd -type */
                    152:        MANDOCERR_BL_REP, /* skipping duplicate list type: Bl -type */
1.149     schwarze  153:        MANDOCERR_BL_SKIPW, /* skipping -width argument: Bl -type */
1.200     schwarze  154:        MANDOCERR_BL_COL, /* wrong number of cells */
1.151     schwarze  155:        MANDOCERR_AT_BAD, /* unknown AT&T UNIX version: At version */
1.156     schwarze  156:        MANDOCERR_FA_COMMA, /* comma in function argument: arg */
1.161     schwarze  157:        MANDOCERR_FN_PAREN, /* parenthesis in function name: arg */
1.225     schwarze  158:        MANDOCERR_LB_BAD, /* unknown library name: Lb ... */
1.140     schwarze  159:        MANDOCERR_RS_BAD, /* invalid content in Rs block: macro */
1.136     schwarze  160:        MANDOCERR_SM_BAD, /* invalid Boolean argument: macro arg */
1.253     schwarze  161:        MANDOCERR_CHAR_FONT, /* argument contains two font escapes */
1.151     schwarze  162:        MANDOCERR_FT_BAD, /* unknown font, skipping request: ft font */
1.200     schwarze  163:        MANDOCERR_TR_ODD, /* odd number of characters in request: tr char */
1.32      kristaps  164:
                    165:        /* related to plain text */
1.137     schwarze  166:        MANDOCERR_FI_BLANK, /* blank line in fill mode, using .sp */
                    167:        MANDOCERR_FI_TAB, /* tab in filled text */
1.214     schwarze  168:        MANDOCERR_EOS, /* new sentence, new line */
1.137     schwarze  169:        MANDOCERR_ESC_BAD, /* invalid escape sequence: esc */
                    170:        MANDOCERR_STR_UNDEF, /* undefined string, using "": name */
1.79      kristaps  171:
1.189     schwarze  172:        /* related to tables */
                    173:        MANDOCERR_TBLLAYOUT_SPAN, /* tbl line starts with span */
                    174:        MANDOCERR_TBLLAYOUT_DOWN, /* tbl column starts with span */
                    175:        MANDOCERR_TBLLAYOUT_VERT, /* skipping vertical bar in tbl layout */
                    176:
1.32      kristaps  177:        MANDOCERR_ERROR, /* ===== start of errors ===== */
                    178:
1.42      kristaps  179:        /* related to tables */
1.187     schwarze  180:        MANDOCERR_TBLOPT_ALPHA, /* non-alphabetic character in tbl options */
                    181:        MANDOCERR_TBLOPT_BAD, /* skipping unknown tbl option: option */
1.191     schwarze  182:        MANDOCERR_TBLOPT_NOARG, /* missing tbl option argument: option */
                    183:        MANDOCERR_TBLOPT_ARGSZ, /* wrong tbl option argument size: option */
1.189     schwarze  184:        MANDOCERR_TBLLAYOUT_NONE, /* empty tbl layout */
                    185:        MANDOCERR_TBLLAYOUT_CHAR, /* invalid character in tbl layout: char */
                    186:        MANDOCERR_TBLLAYOUT_PAR, /* unmatched parenthesis in tbl layout */
1.191     schwarze  187:        MANDOCERR_TBLDATA_NONE, /* tbl without any data cells */
                    188:        MANDOCERR_TBLDATA_SPAN, /* ignoring data in spanned tbl cell: data */
                    189:        MANDOCERR_TBLDATA_EXTRA, /* ignoring extra tbl data cells: data */
                    190:        MANDOCERR_TBLDATA_BLK, /* data block open at end of tbl: macro */
1.42      kristaps  191:
1.141     schwarze  192:        /* related to document structure and macros */
1.179     schwarze  193:        MANDOCERR_FILE, /* cannot open file */
1.243     schwarze  194:        MANDOCERR_PROLOG_REP, /* duplicate prologue macro: macro */
                    195:        MANDOCERR_DT_LATE, /* skipping late title macro: Dt args */
1.33      schwarze  196:        MANDOCERR_ROFFLOOP, /* input stack limit exceeded, infinite loop? */
1.185     schwarze  197:        MANDOCERR_CHAR_BAD, /* skipping bad character: number */
1.151     schwarze  198:        MANDOCERR_MACRO, /* skipping unknown macro: macro */
1.250     schwarze  199:        MANDOCERR_REQ_NOMAC, /* skipping request outside macro: ... */
1.183     schwarze  200:        MANDOCERR_REQ_INSEC, /* skipping insecure request: request */
1.151     schwarze  201:        MANDOCERR_IT_STRAY, /* skipping item outside list: It ... */
                    202:        MANDOCERR_TA_STRAY, /* skipping column outside column list: Ta */
1.141     schwarze  203:        MANDOCERR_BLK_NOTOPEN, /* skipping end of block that is not open */
1.186     schwarze  204:        MANDOCERR_RE_NOTOPEN, /* fewer RS blocks open, skipping: RE arg */
1.141     schwarze  205:        MANDOCERR_BLK_BROKEN, /* inserting missing end of block: macro ... */
                    206:        MANDOCERR_BLK_NOEND, /* appending missing end of block: macro */
                    207:
                    208:        /* related to request and macro arguments */
1.151     schwarze  209:        MANDOCERR_NAMESC, /* escaped character not allowed in a name: name */
1.250     schwarze  210:        MANDOCERR_ARG_UNDEF, /* using macro argument outside macro */
                    211:        MANDOCERR_ARG_NONUM, /* argument number is not numeric */
1.170     schwarze  212:        MANDOCERR_BD_FILE, /* NOT IMPLEMENTED: Bd -file */
1.207     schwarze  213:        MANDOCERR_BD_NOARG, /* skipping display without arguments: Bd */
1.151     schwarze  214:        MANDOCERR_BL_NOTYPE, /* missing list type, using -item: Bl */
1.223     schwarze  215:        MANDOCERR_CE_NONUM, /* argument is not numeric, using 1: ce ... */
1.253     schwarze  216:        MANDOCERR_CHAR_ARG, /* argument is not a character: char ... */
1.151     schwarze  217:        MANDOCERR_NM_NONAME, /* missing manual name, using "": Nm */
1.144     schwarze  218:        MANDOCERR_OS_UNAME, /* uname(3) system call failed, using UNKNOWN */
1.151     schwarze  219:        MANDOCERR_ST_BAD, /* unknown standard specifier: St standard */
1.144     schwarze  220:        MANDOCERR_IT_NONUM, /* skipping request without numeric argument */
1.250     schwarze  221:        MANDOCERR_SHIFT, /* excessive shift: ..., but max is ... */
1.180     schwarze  222:        MANDOCERR_SO_PATH, /* NOT IMPLEMENTED: .so with absolute path or ".." */
1.181     schwarze  223:        MANDOCERR_SO_FAIL, /* .so request failed */
1.134     schwarze  224:        MANDOCERR_ARG_SKIP, /* skipping all arguments: macro args */
                    225:        MANDOCERR_ARG_EXCESS, /* skipping excess arguments: macro ... args */
1.164     kristaps  226:        MANDOCERR_DIVZERO, /* divide by zero */
1.183     schwarze  227:
                    228:        MANDOCERR_UNSUPP, /* ===== start of unsupported features ===== */
                    229:
                    230:        MANDOCERR_TOOLARGE, /* input too large */
1.185     schwarze  231:        MANDOCERR_CHAR_UNSUPP, /* unsupported control character: number */
1.183     schwarze  232:        MANDOCERR_REQ_UNSUPP, /* unsupported roff request: request */
1.252     schwarze  233:        MANDOCERR_WHILE_NEST, /* nested .while loops */
                    234:        MANDOCERR_WHILE_OUTOF, /* end of scope with open .while loop */
                    235:        MANDOCERR_WHILE_INTO, /* end of .while loop in inner scope */
                    236:        MANDOCERR_WHILE_FAIL, /* cannot continue this .while loop */
1.191     schwarze  237:        MANDOCERR_TBLOPT_EQN, /* eqn delim option in tbl: arg */
1.189     schwarze  238:        MANDOCERR_TBLLAYOUT_MOD, /* unsupported tbl layout modifier: m */
1.183     schwarze  239:        MANDOCERR_TBLMACRO, /* ignoring macro in table: macro */
1.113     schwarze  240:
1.1       kristaps  241:        MANDOCERR_MAX
1.43      kristaps  242: };
                    243:
1.107     schwarze  244: struct tbl_opts {
1.43      kristaps  245:        char              tab; /* cell-separator */
                    246:        char              decimal; /* decimal point */
                    247:        int               opts;
                    248: #define        TBL_OPT_CENTRE   (1 << 0)
                    249: #define        TBL_OPT_EXPAND   (1 << 1)
                    250: #define        TBL_OPT_BOX      (1 << 2)
                    251: #define        TBL_OPT_DBOX     (1 << 3)
                    252: #define        TBL_OPT_ALLBOX   (1 << 4)
                    253: #define        TBL_OPT_NOKEEP   (1 << 5)
                    254: #define        TBL_OPT_NOSPACE  (1 << 6)
1.188     schwarze  255: #define        TBL_OPT_NOWARN   (1 << 7)
1.45      kristaps  256:        int               cols; /* number of columns */
1.190     schwarze  257:        int               lvert; /* width of left vertical line */
                    258:        int               rvert; /* width of right vertical line */
1.38      kristaps  259: };
                    260:
                    261: enum   tbl_cellt {
                    262:        TBL_CELL_CENTRE, /* c, C */
                    263:        TBL_CELL_RIGHT, /* r, R */
                    264:        TBL_CELL_LEFT, /* l, L */
                    265:        TBL_CELL_NUMBER, /* n, N */
                    266:        TBL_CELL_SPAN, /* s, S */
                    267:        TBL_CELL_LONG, /* a, A */
                    268:        TBL_CELL_DOWN, /* ^ */
                    269:        TBL_CELL_HORIZ, /* _, - */
                    270:        TBL_CELL_DHORIZ, /* = */
                    271:        TBL_CELL_MAX
                    272: };
                    273:
                    274: /*
                    275:  * A cell in a layout row.
                    276:  */
                    277: struct tbl_cell {
                    278:        struct tbl_cell  *next;
1.226     schwarze  279:        char             *wstr; /* min width represented as a string */
                    280:        size_t            width; /* minimum column width */
                    281:        size_t            spacing; /* to the right of the column */
1.190     schwarze  282:        int               vert; /* width of subsequent vertical line */
1.193     schwarze  283:        int               col; /* column number, starting from 0 */
1.38      kristaps  284:        int               flags;
                    285: #define        TBL_CELL_TALIGN  (1 << 0) /* t, T */
                    286: #define        TBL_CELL_BALIGN  (1 << 1) /* d, D */
                    287: #define        TBL_CELL_BOLD    (1 << 2) /* fB, B, b */
                    288: #define        TBL_CELL_ITALIC  (1 << 3) /* fI, I, i */
                    289: #define        TBL_CELL_EQUAL   (1 << 4) /* e, E */
                    290: #define        TBL_CELL_UP      (1 << 5) /* u, U */
                    291: #define        TBL_CELL_WIGN    (1 << 6) /* z, Z */
1.163     schwarze  292: #define        TBL_CELL_WMAX    (1 << 7) /* x, X */
1.226     schwarze  293:        enum tbl_cellt    pos;
1.38      kristaps  294: };
                    295:
                    296: /*
                    297:  * A layout row.
                    298:  */
                    299: struct tbl_row {
                    300:        struct tbl_row   *next;
                    301:        struct tbl_cell  *first;
                    302:        struct tbl_cell  *last;
1.190     schwarze  303:        int               vert; /* width of left vertical line */
1.38      kristaps  304: };
                    305:
1.40      kristaps  306: enum   tbl_datt {
1.51      kristaps  307:        TBL_DATA_NONE, /* has no data */
                    308:        TBL_DATA_DATA, /* consists of data/string */
                    309:        TBL_DATA_HORIZ, /* horizontal line */
                    310:        TBL_DATA_DHORIZ, /* double-horizontal line */
                    311:        TBL_DATA_NHORIZ, /* squeezed horizontal line */
                    312:        TBL_DATA_NDHORIZ /* squeezed double-horizontal line */
1.40      kristaps  313: };
                    314:
1.38      kristaps  315: /*
                    316:  * A cell within a row of data.  The "string" field contains the actual
                    317:  * string value that's in the cell.  The rest is layout.
                    318:  */
                    319: struct tbl_dat {
1.51      kristaps  320:        struct tbl_cell  *layout; /* layout cell */
1.38      kristaps  321:        struct tbl_dat   *next;
1.51      kristaps  322:        char             *string; /* data (NULL if not TBL_DATA_DATA) */
1.255   ! schwarze  323:        int               hspans; /* how many horizontal spans follow */
        !           324:        int               vspans; /* how many vertical spans follow */
1.226     schwarze  325:        int               block; /* T{ text block T} */
1.40      kristaps  326:        enum tbl_datt     pos;
                    327: };
                    328:
                    329: enum   tbl_spant {
                    330:        TBL_SPAN_DATA, /* span consists of data */
                    331:        TBL_SPAN_HORIZ, /* span is horizontal line */
                    332:        TBL_SPAN_DHORIZ /* span is double horizontal line */
1.38      kristaps  333: };
                    334:
                    335: /*
                    336:  * A row of data in a table.
                    337:  */
                    338: struct tbl_span {
1.107     schwarze  339:        struct tbl_opts  *opts;
1.51      kristaps  340:        struct tbl_row   *layout; /* layout row */
1.38      kristaps  341:        struct tbl_dat   *first;
                    342:        struct tbl_dat   *last;
1.190     schwarze  343:        struct tbl_span  *prev;
                    344:        struct tbl_span  *next;
1.56      kristaps  345:        int               line; /* parse line */
1.40      kristaps  346:        enum tbl_spant    pos;
1.55      kristaps  347: };
                    348:
1.83      kristaps  349: enum   eqn_boxt {
1.84      kristaps  350:        EQN_TEXT, /* text (number, variable, whatever) */
1.90      kristaps  351:        EQN_SUBEXPR, /* nested `eqn' subexpression */
1.159     kristaps  352:        EQN_LIST, /* list (braces, etc.) */
                    353:        EQN_PILE, /* vertical pile */
                    354:        EQN_MATRIX /* pile of piles */
1.85      kristaps  355: };
                    356:
1.86      kristaps  357: enum   eqn_fontt {
                    358:        EQNFONT_NONE = 0,
                    359:        EQNFONT_ROMAN,
                    360:        EQNFONT_BOLD,
1.93      kristaps  361:        EQNFONT_FAT,
1.86      kristaps  362:        EQNFONT_ITALIC,
                    363:        EQNFONT__MAX
                    364: };
                    365:
1.87      kristaps  366: enum   eqn_post {
                    367:        EQNPOS_NONE = 0,
                    368:        EQNPOS_SUP,
1.157     kristaps  369:        EQNPOS_SUBSUP,
1.87      kristaps  370:        EQNPOS_SUB,
                    371:        EQNPOS_TO,
                    372:        EQNPOS_FROM,
1.158     kristaps  373:        EQNPOS_FROMTO,
1.159     kristaps  374:        EQNPOS_OVER,
                    375:        EQNPOS_SQRT,
1.87      kristaps  376:        EQNPOS__MAX
                    377: };
                    378:
1.89      kristaps  379: enum   eqn_pilet {
                    380:        EQNPILE_NONE = 0,
1.95      kristaps  381:        EQNPILE_PILE,
1.89      kristaps  382:        EQNPILE_CPILE,
                    383:        EQNPILE_RPILE,
                    384:        EQNPILE_LPILE,
1.95      kristaps  385:        EQNPILE_COL,
1.92      kristaps  386:        EQNPILE_CCOL,
                    387:        EQNPILE_RCOL,
                    388:        EQNPILE_LCOL,
1.89      kristaps  389:        EQNPILE__MAX
                    390: };
                    391:
1.86      kristaps  392:  /*
1.84      kristaps  393:  * A "box" is a parsed mathematical expression as defined by the eqn.7
                    394:  * grammar.
                    395:  */
1.83      kristaps  396: struct eqn_box {
1.88      kristaps  397:        int               size; /* font size of expression */
                    398: #define        EQN_DEFSIZE       INT_MIN
1.84      kristaps  399:        enum eqn_boxt     type; /* type of node */
1.89      kristaps  400:        struct eqn_box   *first; /* first child node */
                    401:        struct eqn_box   *last; /* last child node */
                    402:        struct eqn_box   *next; /* node sibling */
1.157     kristaps  403:        struct eqn_box   *prev; /* node sibling */
1.89      kristaps  404:        struct eqn_box   *parent; /* node sibling */
                    405:        char             *text; /* text (or NULL) */
1.159     kristaps  406:        char             *left; /* fence left-hand */
                    407:        char             *right; /* fence right-hand */
                    408:        char             *top; /* expression over-symbol */
                    409:        char             *bottom; /* expression under-symbol */
                    410:        size_t            args; /* arguments in parent */
                    411:        size_t            expectargs; /* max arguments in parent */
1.87      kristaps  412:        enum eqn_post     pos; /* position of next box */
1.86      kristaps  413:        enum eqn_fontt    font; /* font of box */
1.89      kristaps  414:        enum eqn_pilet    pile; /* equation piling */
1.16      kristaps  415: };
1.22      kristaps  416:
1.60      kristaps  417: /*
1.116     schwarze  418:  * Parse options.
                    419:  */
                    420: #define        MPARSE_MDOC     1  /* assume -mdoc */
                    421: #define        MPARSE_MAN      2  /* assume -man */
                    422: #define        MPARSE_SO       4  /* honour .so requests */
                    423: #define        MPARSE_QUICK    8  /* abort the parse early */
1.165     schwarze  424: #define        MPARSE_UTF8     16 /* accept UTF-8 input */
                    425: #define        MPARSE_LATIN1   32 /* accept ISO-LATIN-1 input */
1.62      kristaps  426:
1.233     schwarze  427: enum   mandoc_os {
                    428:        MANDOC_OS_OTHER = 0,
                    429:        MANDOC_OS_NETBSD,
                    430:        MANDOC_OS_OPENBSD
                    431: };
                    432:
1.70      kristaps  433: enum   mandoc_esc {
                    434:        ESCAPE_ERROR = 0, /* bail! unparsable escape */
                    435:        ESCAPE_IGNORE, /* escape to be ignored */
                    436:        ESCAPE_SPECIAL, /* a regular special character */
                    437:        ESCAPE_FONT, /* a generic font mode */
                    438:        ESCAPE_FONTBOLD, /* bold font mode */
                    439:        ESCAPE_FONTITALIC, /* italic font mode */
1.109     schwarze  440:        ESCAPE_FONTBI, /* bold italic font mode */
1.70      kristaps  441:        ESCAPE_FONTROMAN, /* roman font mode */
1.254     schwarze  442:        ESCAPE_FONTCW, /* constant width font mode */
1.70      kristaps  443:        ESCAPE_FONTPREV, /* previous font mode */
                    444:        ESCAPE_NUMBERED, /* a numbered glyph */
1.75      kristaps  445:        ESCAPE_UNICODE, /* a unicode codepoint */
1.249     schwarze  446:        ESCAPE_DEVICE, /* print the output device name */
1.230     schwarze  447:        ESCAPE_BREAK, /* break the output line */
1.102     schwarze  448:        ESCAPE_NOSPACE, /* suppress space if the last on a line */
1.220     schwarze  449:        ESCAPE_HORIZ, /* horizontal movement */
1.221     schwarze  450:        ESCAPE_HLINE, /* horizontal line drawing */
1.184     schwarze  451:        ESCAPE_SKIPCHAR, /* skip the next character */
                    452:        ESCAPE_OVERSTRIKE /* overstrike all chars in the argument */
1.70      kristaps  453: };
                    454:
1.63      kristaps  455: typedef        void    (*mandocmsg)(enum mandocerr, enum mandoclevel,
                    456:                        const char *, int, int, const char *);
1.62      kristaps  457:
1.176     schwarze  458:
1.62      kristaps  459: struct mparse;
1.202     schwarze  460: struct roff_man;
1.62      kristaps  461:
1.112     schwarze  462: enum mandoc_esc          mandoc_escape(const char **, const char **, int *);
1.206     schwarze  463: void             mchars_alloc(void);
                    464: void             mchars_free(void);
1.168     schwarze  465: int              mchars_num2char(const char *, size_t);
1.166     schwarze  466: const char      *mchars_uc2str(int);
1.76      kristaps  467: int              mchars_num2uc(const char *, size_t);
1.206     schwarze  468: int              mchars_spec2cp(const char *, size_t);
                    469: const char      *mchars_spec2str(const char *, size_t, size_t *);
1.233     schwarze  470: struct mparse   *mparse_alloc(int, enum mandocerr, mandocmsg,
                    471:                        enum mandoc_os, const char *);
1.96      kristaps  472: void             mparse_free(struct mparse *);
1.209     schwarze  473: int              mparse_open(struct mparse *, const char *);
1.96      kristaps  474: enum mandoclevel  mparse_readfd(struct mparse *, int, const char *);
1.175     schwarze  475: enum mandoclevel  mparse_readmem(struct mparse *, void *, size_t,
1.99      joerg     476:                        const char *);
1.96      kristaps  477: void             mparse_reset(struct mparse *);
1.203     schwarze  478: void             mparse_result(struct mparse *,
1.202     schwarze  479:                        struct roff_man **, char **);
1.251     schwarze  480: void             mparse_copy(const struct mparse *);
1.96      kristaps  481: const char      *mparse_strerror(enum mandocerr);
                    482: const char      *mparse_strlevel(enum mandoclevel);
1.213     schwarze  483: void             mparse_updaterc(struct mparse *, enum mandoclevel *);

CVSweb