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

Annotation of mandoc/mandoc.h, Revision 1.141

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

CVSweb