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

Annotation of mandoc/mandoc.h, Revision 1.167

1.167   ! schwarze    1: /*     $Id: mandoc.h,v 1.166 2014/10/26 18:07:28 schwarze Exp $ */
1.1       kristaps    2: /*
1.160     schwarze    3:  * Copyright (c) 2010, 2011, 2014 Kristaps Dzonsons <kristaps@bsd.lv>
1.118     schwarze    4:  * Copyright (c) 2010-2014 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:  *
                     10:  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
                     11:  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
                     12:  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
                     13:  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
                     14:  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
                     15:  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
                     16:  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
                     17:  */
                     18: #ifndef MANDOC_H
                     19: #define MANDOC_H
1.7       kristaps   20:
                     21: #define ASCII_NBRSP     31  /* non-breaking space */
                     22: #define        ASCII_HYPH       30  /* breakable hyphen */
1.115     schwarze   23: #define        ASCII_BREAK      29  /* breakable zero-width space */
1.7       kristaps   24:
1.22      kristaps   25: /*
                     26:  * Status level.  This refers to both internal status (i.e., whilst
                     27:  * running, when warnings/errors are reported) and an indicator of a
                     28:  * threshold of when to halt (when said internal state exceeds the
                     29:  * threshold).
                     30:  */
1.18      schwarze   31: enum   mandoclevel {
                     32:        MANDOCLEVEL_OK = 0,
                     33:        MANDOCLEVEL_RESERVED,
1.22      kristaps   34:        MANDOCLEVEL_WARNING, /* warnings: syntax, whitespace, etc. */
                     35:        MANDOCLEVEL_ERROR, /* input has been thrown away */
                     36:        MANDOCLEVEL_FATAL, /* input is borked */
                     37:        MANDOCLEVEL_BADARG, /* bad argument in invocation */
                     38:        MANDOCLEVEL_SYSERR, /* system error */
1.18      schwarze   39:        MANDOCLEVEL_MAX
                     40: };
                     41:
1.22      kristaps   42: /*
                     43:  * All possible things that can go wrong within a parse, be it libroff,
                     44:  * libmdoc, or libman.
                     45:  */
1.1       kristaps   46: enum   mandocerr {
                     47:        MANDOCERR_OK,
1.13      schwarze   48:
1.21      kristaps   49:        MANDOCERR_WARNING, /* ===== start of warnings ===== */
1.32      kristaps   50:
                     51:        /* related to the prologue */
1.152     schwarze   52:        MANDOCERR_DT_NOTITLE, /* missing manual title, using UNTITLED: line */
                     53:        MANDOCERR_TH_NOTITLE, /* missing manual title, using "": [macro] */
1.125     schwarze   54:        MANDOCERR_TITLE_CASE, /* lower case character in document title */
1.152     schwarze   55:        MANDOCERR_MSEC_MISSING, /* missing manual section, using "": macro */
1.151     schwarze   56:        MANDOCERR_MSEC_BAD, /* unknown manual section: Dt ... section */
                     57:        MANDOCERR_ARCH_BAD, /* unknown manual volume or arch: Dt ... volume */
1.125     schwarze   58:        MANDOCERR_DATE_MISSING, /* missing date, using today's date */
                     59:        MANDOCERR_DATE_BAD, /* cannot parse date, using it verbatim: date */
1.152     schwarze   60:        MANDOCERR_OS_MISSING, /* missing Os macro, using "" */
1.125     schwarze   61:        MANDOCERR_PROLOG_REP, /* duplicate prologue macro: macro */
1.152     schwarze   62:        MANDOCERR_PROLOG_LATE, /* late prologue macro: macro */
                     63:        MANDOCERR_DT_LATE, /* skipping late title macro: Dt args */
                     64:        MANDOCERR_PROLOG_ORDER, /* prologue macros out of order: macros */
1.32      kristaps   65:
                     66:        /* related to document structure */
1.151     schwarze   67:        MANDOCERR_SO, /* .so is fragile, better use ln(1): so path */
1.122     schwarze   68:        MANDOCERR_DOC_EMPTY, /* no document body */
1.125     schwarze   69:        MANDOCERR_SEC_BEFORE, /* content before first section header: macro */
1.151     schwarze   70:        MANDOCERR_NAMESEC_FIRST, /* first section is not NAME: Sh title */
1.125     schwarze   71:        MANDOCERR_NAMESEC_BAD, /* bad NAME section contents: macro */
1.151     schwarze   72:        MANDOCERR_SEC_ORDER, /* sections out of conventional order: Sh title */
                     73:        MANDOCERR_SEC_REP, /* duplicate section title: Sh title */
                     74:        MANDOCERR_SEC_MSEC, /* unexpected section: Sh title for ... only */
1.155     schwarze   75:        MANDOCERR_XR_ORDER, /* unusual Xr order: ... after ... */
                     76:        MANDOCERR_XR_PUNCT, /* unusual Xr punctuation: ... after ... */
1.154     schwarze   77:        MANDOCERR_AN_MISSING, /* AUTHORS section without An macro */
1.32      kristaps   78:
                     79:        /* related to macros and nesting */
1.126     schwarze   80:        MANDOCERR_MACRO_OBS, /* obsolete macro: macro */
1.127     schwarze   81:        MANDOCERR_PAR_SKIP, /* skipping paragraph macro: macro ... */
                     82:        MANDOCERR_PAR_MOVE, /* moving paragraph macro out of list: macro */
1.128     schwarze   83:        MANDOCERR_NS_SKIP, /* skipping no-space macro */
1.141     schwarze   84:        MANDOCERR_BLK_NEST, /* blocks badly nested: macro ... */
1.128     schwarze   85:        MANDOCERR_BD_NEST, /* nested displays are not portable: macro ... */
1.129     schwarze   86:        MANDOCERR_BL_MOVE, /* moving content out of list: macro */
                     87:        MANDOCERR_VT_CHILD, /* .Vt block has child macro: macro */
1.151     schwarze   88:        MANDOCERR_FI_SKIP, /* fill mode already enabled, skipping: fi */
                     89:        MANDOCERR_NF_SKIP, /* fill mode already disabled, skipping: nf */
1.141     schwarze   90:        MANDOCERR_BLK_LINE, /* line scope broken: macro breaks macro */
1.32      kristaps   91:
1.131     schwarze   92:        /* related to missing arguments */
                     93:        MANDOCERR_REQ_EMPTY, /* skipping empty request: request */
                     94:        MANDOCERR_COND_EMPTY, /* conditional request controls empty scope */
1.130     schwarze   95:        MANDOCERR_MACRO_EMPTY, /* skipping empty macro: macro */
1.135     schwarze   96:        MANDOCERR_ARG_EMPTY, /* empty argument, using 0n: macro arg */
1.46      schwarze   97:        MANDOCERR_ARGCWARN, /* argument count wrong */
1.151     schwarze   98:        MANDOCERR_BD_NOTYPE, /* missing display type, using -ragged: Bd */
                     99:        MANDOCERR_BL_LATETYPE, /* list type is not the first argument: Bl arg */
1.136     schwarze  100:        MANDOCERR_BL_NOWIDTH, /* missing -width in -tag list, using 8n */
1.151     schwarze  101:        MANDOCERR_EX_NONAME, /* missing utility name, using "": Ex */
                    102:        MANDOCERR_IT_NOHEAD, /* empty head in list item: Bl -type It */
                    103:        MANDOCERR_IT_NOBODY, /* empty list item: Bl -type It */
                    104:        MANDOCERR_BF_NOFONT, /* missing font type, using \fR: Bf */
                    105:        MANDOCERR_BF_BADFONT, /* unknown font type, using \fR: Bf font */
1.133     schwarze  106:        MANDOCERR_ARG_STD, /* missing -std argument, adding it: macro */
1.162     schwarze  107:        MANDOCERR_EQN_NOBOX, /* missing eqn box, using "": op */
1.13      schwarze  108:
1.137     schwarze  109:        /* related to bad arguments */
                    110:        MANDOCERR_ARG_QUOTE, /* unterminated quoted argument */
1.135     schwarze  111:        MANDOCERR_ARG_REP, /* duplicate argument: macro arg */
1.149     schwarze  112:        MANDOCERR_AN_REP, /* skipping duplicate argument: An -arg */
1.151     schwarze  113:        MANDOCERR_BD_REP, /* skipping duplicate display type: Bd -type */
                    114:        MANDOCERR_BL_REP, /* skipping duplicate list type: Bl -type */
1.149     schwarze  115:        MANDOCERR_BL_SKIPW, /* skipping -width argument: Bl -type */
1.151     schwarze  116:        MANDOCERR_AT_BAD, /* unknown AT&T UNIX version: At version */
1.156     schwarze  117:        MANDOCERR_FA_COMMA, /* comma in function argument: arg */
1.161     schwarze  118:        MANDOCERR_FN_PAREN, /* parenthesis in function name: arg */
1.140     schwarze  119:        MANDOCERR_RS_BAD, /* invalid content in Rs block: macro */
1.136     schwarze  120:        MANDOCERR_SM_BAD, /* invalid Boolean argument: macro arg */
1.151     schwarze  121:        MANDOCERR_FT_BAD, /* unknown font, skipping request: ft font */
1.32      kristaps  122:
                    123:        /* related to plain text */
1.137     schwarze  124:        MANDOCERR_FI_BLANK, /* blank line in fill mode, using .sp */
                    125:        MANDOCERR_FI_TAB, /* tab in filled text */
                    126:        MANDOCERR_SPACE_EOL, /* whitespace at end of input line */
                    127:        MANDOCERR_COMMENT_BAD, /* bad comment style */
                    128:        MANDOCERR_ESC_BAD, /* invalid escape sequence: esc */
                    129:        MANDOCERR_STR_UNDEF, /* undefined string, using "": name */
1.79      kristaps  130:
1.32      kristaps  131:        MANDOCERR_ERROR, /* ===== start of errors ===== */
1.80      kristaps  132:
                    133:        /* related to equations */
1.84      kristaps  134:        MANDOCERR_EQNNSCOPE, /* unexpected equation scope closure*/
                    135:        MANDOCERR_EQNSCOPE, /* equation scope open on exit */
1.89      kristaps  136:        MANDOCERR_EQNBADSCOPE, /* overlapping equation scopes */
                    137:        MANDOCERR_EQNEOF, /* unexpected end of equation */
1.32      kristaps  138:
1.42      kristaps  139:        /* related to tables */
1.36      kristaps  140:        MANDOCERR_TBL, /* bad table syntax */
                    141:        MANDOCERR_TBLOPT, /* bad table option */
1.37      kristaps  142:        MANDOCERR_TBLLAYOUT, /* bad table layout */
                    143:        MANDOCERR_TBLNOLAYOUT, /* no table layout cells specified */
1.39      kristaps  144:        MANDOCERR_TBLNODATA, /* no table data cells specified */
1.47      kristaps  145:        MANDOCERR_TBLIGNDATA, /* ignore data in cell */
1.48      kristaps  146:        MANDOCERR_TBLBLOCK, /* data block still open */
1.50      kristaps  147:        MANDOCERR_TBLEXTRADAT, /* ignoring extra data cells */
1.42      kristaps  148:
1.141     schwarze  149:        /* related to document structure and macros */
1.33      schwarze  150:        MANDOCERR_ROFFLOOP, /* input stack limit exceeded, infinite loop? */
1.151     schwarze  151:        MANDOCERR_BADCHAR, /* skipping bad character: number */
                    152:        MANDOCERR_MACRO, /* skipping unknown macro: macro */
                    153:        MANDOCERR_IT_STRAY, /* skipping item outside list: It ... */
                    154:        MANDOCERR_TA_STRAY, /* skipping column outside column list: Ta */
1.141     schwarze  155:        MANDOCERR_BLK_NOTOPEN, /* skipping end of block that is not open */
                    156:        MANDOCERR_BLK_BROKEN, /* inserting missing end of block: macro ... */
                    157:        MANDOCERR_BLK_NOEND, /* appending missing end of block: macro */
                    158:
                    159:        /* related to request and macro arguments */
1.151     schwarze  160:        MANDOCERR_NAMESC, /* escaped character not allowed in a name: name */
1.5       kristaps  161:        MANDOCERR_ARGCOUNT, /* argument count wrong */
1.151     schwarze  162:        MANDOCERR_BL_NOTYPE, /* missing list type, using -item: Bl */
                    163:        MANDOCERR_NM_NONAME, /* missing manual name, using "": Nm */
1.144     schwarze  164:        MANDOCERR_OS_UNAME, /* uname(3) system call failed, using UNKNOWN */
1.151     schwarze  165:        MANDOCERR_ST_BAD, /* unknown standard specifier: St standard */
1.144     schwarze  166:        MANDOCERR_IT_NONUM, /* skipping request without numeric argument */
1.134     schwarze  167:        MANDOCERR_ARG_SKIP, /* skipping all arguments: macro args */
                    168:        MANDOCERR_ARG_EXCESS, /* skipping excess arguments: macro ... args */
1.164     kristaps  169:        MANDOCERR_DIVZERO, /* divide by zero */
1.13      schwarze  170:
1.21      kristaps  171:        MANDOCERR_FATAL, /* ===== start of fatal errors ===== */
1.32      kristaps  172:
1.113     schwarze  173:        MANDOCERR_TOOLARGE, /* input too large */
1.151     schwarze  174:        MANDOCERR_BD_FILE, /* NOT IMPLEMENTED: Bd -file */
1.123     schwarze  175:        MANDOCERR_SO_PATH, /* NOT IMPLEMENTED: .so with absolute path or ".." */
                    176:        MANDOCERR_SO_FAIL, /* .so request failed */
1.113     schwarze  177:
                    178:        /* ===== system errors ===== */
                    179:
1.153     schwarze  180:        MANDOCERR_SYSDUP, /* cannot dup file descriptor */
                    181:        MANDOCERR_SYSEXEC, /* cannot exec */
                    182:        MANDOCERR_SYSEXIT, /* gunzip failed with code */
                    183:        MANDOCERR_SYSFORK, /* cannot fork */
1.113     schwarze  184:        MANDOCERR_SYSOPEN, /* cannot open file */
1.153     schwarze  185:        MANDOCERR_SYSPIPE, /* cannot open pipe */
                    186:        MANDOCERR_SYSREAD, /* cannot read file */
                    187:        MANDOCERR_SYSSIG, /* gunzip died from signal */
1.113     schwarze  188:        MANDOCERR_SYSSTAT, /* cannot stat file */
1.153     schwarze  189:        MANDOCERR_SYSWAIT, /* wait failed */
1.113     schwarze  190:
1.1       kristaps  191:        MANDOCERR_MAX
1.43      kristaps  192: };
                    193:
1.107     schwarze  194: struct tbl_opts {
1.43      kristaps  195:        char              tab; /* cell-separator */
                    196:        char              decimal; /* decimal point */
                    197:        int               linesize;
                    198:        int               opts;
                    199: #define        TBL_OPT_CENTRE   (1 << 0)
                    200: #define        TBL_OPT_EXPAND   (1 << 1)
                    201: #define        TBL_OPT_BOX      (1 << 2)
                    202: #define        TBL_OPT_DBOX     (1 << 3)
                    203: #define        TBL_OPT_ALLBOX   (1 << 4)
                    204: #define        TBL_OPT_NOKEEP   (1 << 5)
                    205: #define        TBL_OPT_NOSPACE  (1 << 6)
1.45      kristaps  206:        int               cols; /* number of columns */
1.38      kristaps  207: };
                    208:
1.41      kristaps  209: /*
                    210:  * The head of a table specifies all of its columns.  When formatting a
                    211:  * tbl_span, iterate over these and plug in data from the tbl_span when
                    212:  * appropriate, using tbl_cell as a guide to placement.
                    213:  */
                    214: struct tbl_head {
1.45      kristaps  215:        int               ident; /* 0 <= unique id < cols */
1.101     schwarze  216:        int               vert; /* width of preceding vertical line */
1.41      kristaps  217:        struct tbl_head  *next;
                    218:        struct tbl_head  *prev;
                    219: };
                    220:
1.38      kristaps  221: enum   tbl_cellt {
                    222:        TBL_CELL_CENTRE, /* c, C */
                    223:        TBL_CELL_RIGHT, /* r, R */
                    224:        TBL_CELL_LEFT, /* l, L */
                    225:        TBL_CELL_NUMBER, /* n, N */
                    226:        TBL_CELL_SPAN, /* s, S */
                    227:        TBL_CELL_LONG, /* a, A */
                    228:        TBL_CELL_DOWN, /* ^ */
                    229:        TBL_CELL_HORIZ, /* _, - */
                    230:        TBL_CELL_DHORIZ, /* = */
                    231:        TBL_CELL_MAX
                    232: };
                    233:
                    234: /*
                    235:  * A cell in a layout row.
                    236:  */
                    237: struct tbl_cell {
                    238:        struct tbl_cell  *next;
1.101     schwarze  239:        int               vert; /* width of preceding vertical line */
1.38      kristaps  240:        enum tbl_cellt    pos;
1.51      kristaps  241:        size_t            spacing;
1.38      kristaps  242:        int               flags;
                    243: #define        TBL_CELL_TALIGN  (1 << 0) /* t, T */
                    244: #define        TBL_CELL_BALIGN  (1 << 1) /* d, D */
                    245: #define        TBL_CELL_BOLD    (1 << 2) /* fB, B, b */
                    246: #define        TBL_CELL_ITALIC  (1 << 3) /* fI, I, i */
                    247: #define        TBL_CELL_EQUAL   (1 << 4) /* e, E */
                    248: #define        TBL_CELL_UP      (1 << 5) /* u, U */
                    249: #define        TBL_CELL_WIGN    (1 << 6) /* z, Z */
1.163     schwarze  250: #define        TBL_CELL_WMAX    (1 << 7) /* x, X */
1.41      kristaps  251:        struct tbl_head  *head;
1.38      kristaps  252: };
                    253:
                    254: /*
                    255:  * A layout row.
                    256:  */
                    257: struct tbl_row {
                    258:        struct tbl_row   *next;
                    259:        struct tbl_cell  *first;
                    260:        struct tbl_cell  *last;
1.119     schwarze  261:        int               vert; /* trailing vertical line */
1.38      kristaps  262: };
                    263:
1.40      kristaps  264: enum   tbl_datt {
1.51      kristaps  265:        TBL_DATA_NONE, /* has no data */
                    266:        TBL_DATA_DATA, /* consists of data/string */
                    267:        TBL_DATA_HORIZ, /* horizontal line */
                    268:        TBL_DATA_DHORIZ, /* double-horizontal line */
                    269:        TBL_DATA_NHORIZ, /* squeezed horizontal line */
                    270:        TBL_DATA_NDHORIZ /* squeezed double-horizontal line */
1.40      kristaps  271: };
                    272:
1.38      kristaps  273: /*
                    274:  * A cell within a row of data.  The "string" field contains the actual
                    275:  * string value that's in the cell.  The rest is layout.
                    276:  */
                    277: struct tbl_dat {
1.51      kristaps  278:        struct tbl_cell  *layout; /* layout cell */
1.50      kristaps  279:        int               spans; /* how many spans follow */
1.38      kristaps  280:        struct tbl_dat   *next;
1.51      kristaps  281:        char             *string; /* data (NULL if not TBL_DATA_DATA) */
1.40      kristaps  282:        enum tbl_datt     pos;
                    283: };
                    284:
                    285: enum   tbl_spant {
                    286:        TBL_SPAN_DATA, /* span consists of data */
                    287:        TBL_SPAN_HORIZ, /* span is horizontal line */
                    288:        TBL_SPAN_DHORIZ /* span is double horizontal line */
1.38      kristaps  289: };
                    290:
                    291: /*
                    292:  * A row of data in a table.
                    293:  */
                    294: struct tbl_span {
1.107     schwarze  295:        struct tbl_opts  *opts;
1.44      kristaps  296:        struct tbl_head  *head;
1.51      kristaps  297:        struct tbl_row   *layout; /* layout row */
1.38      kristaps  298:        struct tbl_dat   *first;
                    299:        struct tbl_dat   *last;
1.56      kristaps  300:        int               line; /* parse line */
1.44      kristaps  301:        int               flags;
                    302: #define        TBL_SPAN_FIRST   (1 << 0)
                    303: #define        TBL_SPAN_LAST    (1 << 1)
1.40      kristaps  304:        enum tbl_spant    pos;
1.38      kristaps  305:        struct tbl_span  *next;
1.55      kristaps  306: };
                    307:
1.83      kristaps  308: enum   eqn_boxt {
1.84      kristaps  309:        EQN_ROOT, /* root of parse tree */
                    310:        EQN_TEXT, /* text (number, variable, whatever) */
1.90      kristaps  311:        EQN_SUBEXPR, /* nested `eqn' subexpression */
1.159     kristaps  312:        EQN_LIST, /* list (braces, etc.) */
                    313:        EQN_LISTONE, /* singleton list */
                    314:        EQN_PILE, /* vertical pile */
                    315:        EQN_MATRIX /* pile of piles */
1.85      kristaps  316: };
                    317:
1.86      kristaps  318: enum   eqn_fontt {
                    319:        EQNFONT_NONE = 0,
                    320:        EQNFONT_ROMAN,
                    321:        EQNFONT_BOLD,
1.93      kristaps  322:        EQNFONT_FAT,
1.86      kristaps  323:        EQNFONT_ITALIC,
                    324:        EQNFONT__MAX
                    325: };
                    326:
1.87      kristaps  327: enum   eqn_post {
                    328:        EQNPOS_NONE = 0,
                    329:        EQNPOS_SUP,
1.157     kristaps  330:        EQNPOS_SUBSUP,
1.87      kristaps  331:        EQNPOS_SUB,
                    332:        EQNPOS_TO,
                    333:        EQNPOS_FROM,
1.158     kristaps  334:        EQNPOS_FROMTO,
1.159     kristaps  335:        EQNPOS_OVER,
                    336:        EQNPOS_SQRT,
1.87      kristaps  337:        EQNPOS__MAX
                    338: };
                    339:
1.89      kristaps  340: enum   eqn_pilet {
                    341:        EQNPILE_NONE = 0,
1.95      kristaps  342:        EQNPILE_PILE,
1.89      kristaps  343:        EQNPILE_CPILE,
                    344:        EQNPILE_RPILE,
                    345:        EQNPILE_LPILE,
1.95      kristaps  346:        EQNPILE_COL,
1.92      kristaps  347:        EQNPILE_CCOL,
                    348:        EQNPILE_RCOL,
                    349:        EQNPILE_LCOL,
1.89      kristaps  350:        EQNPILE__MAX
                    351: };
                    352:
1.86      kristaps  353:  /*
1.84      kristaps  354:  * A "box" is a parsed mathematical expression as defined by the eqn.7
                    355:  * grammar.
                    356:  */
1.83      kristaps  357: struct eqn_box {
1.88      kristaps  358:        int               size; /* font size of expression */
                    359: #define        EQN_DEFSIZE       INT_MIN
1.84      kristaps  360:        enum eqn_boxt     type; /* type of node */
1.89      kristaps  361:        struct eqn_box   *first; /* first child node */
                    362:        struct eqn_box   *last; /* last child node */
                    363:        struct eqn_box   *next; /* node sibling */
1.157     kristaps  364:        struct eqn_box   *prev; /* node sibling */
1.89      kristaps  365:        struct eqn_box   *parent; /* node sibling */
                    366:        char             *text; /* text (or NULL) */
1.159     kristaps  367:        char             *left; /* fence left-hand */
                    368:        char             *right; /* fence right-hand */
                    369:        char             *top; /* expression over-symbol */
                    370:        char             *bottom; /* expression under-symbol */
                    371:        size_t            args; /* arguments in parent */
                    372:        size_t            expectargs; /* max arguments in parent */
1.87      kristaps  373:        enum eqn_post     pos; /* position of next box */
1.86      kristaps  374:        enum eqn_fontt    font; /* font of box */
1.89      kristaps  375:        enum eqn_pilet    pile; /* equation piling */
1.83      kristaps  376: };
                    377:
1.87      kristaps  378: /*
                    379:  * An equation consists of a tree of expressions starting at a given
1.120     schwarze  380:  * line and position.
1.87      kristaps  381:  */
1.55      kristaps  382: struct eqn {
1.94      kristaps  383:        char             *name; /* identifier (or NULL) */
1.84      kristaps  384:        struct eqn_box   *root; /* root mathematical expression */
1.82      kristaps  385:        int               ln; /* invocation line */
1.57      kristaps  386:        int               pos; /* invocation position */
1.16      kristaps  387: };
1.22      kristaps  388:
1.60      kristaps  389: /*
1.116     schwarze  390:  * Parse options.
                    391:  */
                    392: #define        MPARSE_MDOC     1  /* assume -mdoc */
                    393: #define        MPARSE_MAN      2  /* assume -man */
                    394: #define        MPARSE_SO       4  /* honour .so requests */
                    395: #define        MPARSE_QUICK    8  /* abort the parse early */
1.165     schwarze  396: #define        MPARSE_UTF8     16 /* accept UTF-8 input */
                    397: #define        MPARSE_LATIN1   32 /* accept ISO-LATIN-1 input */
1.62      kristaps  398:
1.70      kristaps  399: enum   mandoc_esc {
                    400:        ESCAPE_ERROR = 0, /* bail! unparsable escape */
                    401:        ESCAPE_IGNORE, /* escape to be ignored */
                    402:        ESCAPE_SPECIAL, /* a regular special character */
                    403:        ESCAPE_FONT, /* a generic font mode */
                    404:        ESCAPE_FONTBOLD, /* bold font mode */
                    405:        ESCAPE_FONTITALIC, /* italic font mode */
1.109     schwarze  406:        ESCAPE_FONTBI, /* bold italic font mode */
1.70      kristaps  407:        ESCAPE_FONTROMAN, /* roman font mode */
                    408:        ESCAPE_FONTPREV, /* previous font mode */
                    409:        ESCAPE_NUMBERED, /* a numbered glyph */
1.75      kristaps  410:        ESCAPE_UNICODE, /* a unicode codepoint */
1.102     schwarze  411:        ESCAPE_NOSPACE, /* suppress space if the last on a line */
                    412:        ESCAPE_SKIPCHAR /* skip the next character */
1.70      kristaps  413: };
                    414:
1.63      kristaps  415: typedef        void    (*mandocmsg)(enum mandocerr, enum mandoclevel,
                    416:                        const char *, int, int, const char *);
1.62      kristaps  417:
                    418: struct mparse;
1.71      kristaps  419: struct mchars;
1.62      kristaps  420: struct mdoc;
                    421: struct man;
1.59      kristaps  422:
1.22      kristaps  423: __BEGIN_DECLS
1.62      kristaps  424:
1.112     schwarze  425: enum mandoc_esc          mandoc_escape(const char **, const char **, int *);
1.73      kristaps  426: struct mchars   *mchars_alloc(void);
1.96      kristaps  427: void             mchars_free(struct mchars *);
1.120     schwarze  428: char             mchars_num2char(const char *, size_t);
1.166     schwarze  429: const char      *mchars_uc2str(int);
1.76      kristaps  430: int              mchars_num2uc(const char *, size_t);
1.120     schwarze  431: int              mchars_spec2cp(const struct mchars *,
1.96      kristaps  432:                        const char *, size_t);
1.120     schwarze  433: const char      *mchars_spec2str(const struct mchars *,
1.96      kristaps  434:                        const char *, size_t, size_t *);
1.142     schwarze  435: struct mparse   *mparse_alloc(int, enum mandoclevel, mandocmsg,
1.167   ! schwarze  436:                        const struct mchars *, const char *);
1.96      kristaps  437: void             mparse_free(struct mparse *);
                    438: void             mparse_keep(struct mparse *);
1.153     schwarze  439: enum mandoclevel  mparse_open(struct mparse *, int *, const char *,
                    440:                        pid_t *);
1.96      kristaps  441: enum mandoclevel  mparse_readfd(struct mparse *, int, const char *);
1.99      joerg     442: enum mandoclevel  mparse_readmem(struct mparse *, const void *, size_t,
                    443:                        const char *);
1.96      kristaps  444: void             mparse_reset(struct mparse *);
1.120     schwarze  445: void             mparse_result(struct mparse *,
1.117     schwarze  446:                        struct mdoc **, struct man **, char **);
1.96      kristaps  447: const char      *mparse_getkeep(const struct mparse *);
                    448: const char      *mparse_strerror(enum mandocerr);
                    449: const char      *mparse_strlevel(enum mandoclevel);
1.153     schwarze  450: enum mandoclevel  mparse_wait(struct mparse *, pid_t);
1.1       kristaps  451:
                    452: __END_DECLS
                    453:
                    454: #endif /*!MANDOC_H*/

CVSweb