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

Annotation of mandoc/mandoc.h, Revision 1.230

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

CVSweb