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

Annotation of mandoc/mandoc.h, Revision 1.222

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

CVSweb