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

Annotation of mandoc/mandoc.h, Revision 1.182

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

CVSweb