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

Annotation of mandoc/mandoc.h, Revision 1.88

1.88    ! kristaps    1: /*     $Id: mandoc.h,v 1.87 2011/07/21 14:13:00 kristaps Exp $ */
1.1       kristaps    2: /*
1.46      schwarze    3:  * Copyright (c) 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.1       kristaps    4:  *
                      5:  * Permission to use, copy, modify, and distribute this software for any
                      6:  * purpose with or without fee is hereby granted, provided that the above
                      7:  * copyright notice and this permission notice appear in all copies.
                      8:  *
                      9:  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
                     10:  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
                     11:  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
                     12:  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
                     13:  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
                     14:  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
                     15:  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
                     16:  */
                     17: #ifndef MANDOC_H
                     18: #define MANDOC_H
1.7       kristaps   19:
                     20: #define ASCII_NBRSP     31  /* non-breaking space */
                     21: #define        ASCII_HYPH       30  /* breakable hyphen */
                     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 */
                     50:        MANDOCERR_NOTITLE, /* no title in document */
                     51:        MANDOCERR_UPPERCASE, /* document title should be all caps */
                     52:        MANDOCERR_BADMSEC, /* unknown manual section */
1.58      schwarze   53:        MANDOCERR_NODATE, /* date missing, using today's date */
                     54:        MANDOCERR_BADDATE, /* cannot parse date, using it verbatim */
1.32      kristaps   55:        MANDOCERR_PROLOGOOO, /* prologue macros out of order */
                     56:        MANDOCERR_PROLOGREP, /* duplicate prologue macro */
                     57:        MANDOCERR_BADPROLOG, /* macro not allowed in prologue */
                     58:        MANDOCERR_BADBODY, /* macro not allowed in body */
                     59:
                     60:        /* related to document structure */
1.26      kristaps   61:        MANDOCERR_SO, /* .so is fragile, better use ln(1) */
1.32      kristaps   62:        MANDOCERR_NAMESECFIRST, /* NAME section must come first */
                     63:        MANDOCERR_BADNAMESEC, /* bad NAME section contents */
                     64:        MANDOCERR_NONAME, /* manual name not yet set */
1.9       kristaps   65:        MANDOCERR_SECOOO, /* sections out of conventional order */
1.32      kristaps   66:        MANDOCERR_SECREP, /* duplicate section name */
1.5       kristaps   67:        MANDOCERR_SECMSEC, /* section not in conventional manual section */
1.32      kristaps   68:
                     69:        /* related to macros and nesting */
                     70:        MANDOCERR_MACROOBS, /* skipping obsolete macro */
1.35      kristaps   71:        MANDOCERR_IGNPAR, /* skipping paragraph macro */
1.54      kristaps   72:        MANDOCERR_IGNNS, /* skipping no-space macro */
1.14      schwarze   73:        MANDOCERR_SCOPENEST, /* blocks badly nested */
1.32      kristaps   74:        MANDOCERR_CHILD, /* child violates parent syntax */
                     75:        MANDOCERR_NESTEDDISP, /* nested displays are not portable */
                     76:        MANDOCERR_SCOPEREP, /* already in literal mode */
1.68      kristaps   77:        MANDOCERR_LINESCOPE, /* line scope broken */
1.32      kristaps   78:
                     79:        /* related to missing macro arguments */
                     80:        MANDOCERR_MACROEMPTY, /* skipping empty macro */
1.46      schwarze   81:        MANDOCERR_ARGCWARN, /* argument count wrong */
1.32      kristaps   82:        MANDOCERR_DISPTYPE, /* missing display type */
                     83:        MANDOCERR_LISTFIRST, /* list type must come first */
                     84:        MANDOCERR_NOWIDTHARG, /* tag lists require a width argument */
                     85:        MANDOCERR_FONTTYPE, /* missing font type */
1.53      kristaps   86:        MANDOCERR_WNOSCOPE, /* skipping end of block that is not open */
1.13      schwarze   87:
1.32      kristaps   88:        /* related to bad macro arguments */
                     89:        MANDOCERR_IGNARGV, /* skipping argument */
                     90:        MANDOCERR_ARGVREP, /* duplicate argument */
                     91:        MANDOCERR_DISPREP, /* duplicate display type */
                     92:        MANDOCERR_LISTREP, /* duplicate list type */
                     93:        MANDOCERR_BADATT, /* unknown AT&T UNIX version */
1.5       kristaps   94:        MANDOCERR_BADBOOL, /* bad Boolean value */
1.31      kristaps   95:        MANDOCERR_BADFONT, /* unknown font */
1.32      kristaps   96:        MANDOCERR_BADSTANDARD, /* unknown standard specifier */
                     97:        MANDOCERR_BADWIDTH, /* bad width argument */
                     98:
                     99:        /* related to plain text */
                    100:        MANDOCERR_NOBLANKLN, /* blank line in non-literal context */
                    101:        MANDOCERR_BADTAB, /* tab in non-literal context */
                    102:        MANDOCERR_EOLNSPACE, /* end of line whitespace */
1.5       kristaps  103:        MANDOCERR_BADCOMMENT, /* bad comment style */
1.32      kristaps  104:        MANDOCERR_BADESCAPE, /* unknown escape sequence */
                    105:        MANDOCERR_BADQUOTE, /* unterminated quoted string */
1.79      kristaps  106:
                    107:        /* related to equations */
                    108:        MANDOCERR_EQNQUOTE, /* unexpected literal in equation */
1.32      kristaps  109:
                    110:        MANDOCERR_ERROR, /* ===== start of errors ===== */
1.80      kristaps  111:
                    112:        /* related to equations */
                    113:        MANDOCERR_EQNARGS, /* bad equation macro arguments */
1.81      kristaps  114:        MANDOCERR_EQNNEST, /* too many nested equation defines */
1.84      kristaps  115:        MANDOCERR_EQNNSCOPE, /* unexpected equation scope closure*/
                    116:        MANDOCERR_EQNSCOPE, /* equation scope open on exit */
1.32      kristaps  117:
1.42      kristaps  118:        /* related to tables */
1.36      kristaps  119:        MANDOCERR_TBL, /* bad table syntax */
                    120:        MANDOCERR_TBLOPT, /* bad table option */
1.37      kristaps  121:        MANDOCERR_TBLLAYOUT, /* bad table layout */
                    122:        MANDOCERR_TBLNOLAYOUT, /* no table layout cells specified */
1.39      kristaps  123:        MANDOCERR_TBLNODATA, /* no table data cells specified */
1.47      kristaps  124:        MANDOCERR_TBLIGNDATA, /* ignore data in cell */
1.48      kristaps  125:        MANDOCERR_TBLBLOCK, /* data block still open */
1.50      kristaps  126:        MANDOCERR_TBLEXTRADAT, /* ignoring extra data cells */
1.42      kristaps  127:
1.33      schwarze  128:        MANDOCERR_ROFFLOOP, /* input stack limit exceeded, infinite loop? */
1.32      kristaps  129:        MANDOCERR_BADCHAR, /* skipping bad character */
1.52      schwarze  130:        MANDOCERR_NAMESC, /* escaped character not allowed in a name */
1.32      kristaps  131:        MANDOCERR_NOTEXT, /* skipping text before the first section header */
                    132:        MANDOCERR_MACRO, /* skipping unknown macro */
1.25      kristaps  133:        MANDOCERR_REQUEST, /* NOT IMPLEMENTED: skipping request */
1.5       kristaps  134:        MANDOCERR_ARGCOUNT, /* argument count wrong */
1.32      kristaps  135:        MANDOCERR_NOSCOPE, /* skipping end of block that is not open */
1.30      kristaps  136:        MANDOCERR_SCOPEBROKEN, /* missing end of block */
1.19      schwarze  137:        MANDOCERR_SCOPEEXIT, /* scope open on exit */
1.28      kristaps  138:        MANDOCERR_UNAME, /* uname(3) system call failed */
1.5       kristaps  139:        /* FIXME: merge following with MANDOCERR_ARGCOUNT */
                    140:        MANDOCERR_NOARGS, /* macro requires line argument(s) */
                    141:        MANDOCERR_NOBODY, /* macro requires body argument(s) */
                    142:        MANDOCERR_NOARGV, /* macro requires argument(s) */
1.10      kristaps  143:        MANDOCERR_LISTTYPE, /* missing list type */
1.5       kristaps  144:        MANDOCERR_ARGSLOST, /* line argument(s) will be lost */
                    145:        MANDOCERR_BODYLOST, /* body argument(s) will be lost */
1.13      schwarze  146:
1.21      kristaps  147:        MANDOCERR_FATAL, /* ===== start of fatal errors ===== */
1.32      kristaps  148:
1.66      kristaps  149:        MANDOCERR_NOTMANUAL, /* manual isn't really a manual */
1.8       kristaps  150:        MANDOCERR_COLUMNS, /* column syntax is inconsistent */
1.32      kristaps  151:        MANDOCERR_BADDISP, /* NOT IMPLEMENTED: .Bd -file */
1.5       kristaps  152:        MANDOCERR_SYNTLINESCOPE, /* line scope broken, syntax violated */
                    153:        MANDOCERR_SYNTARGVCOUNT, /* argument count wrong, violates syntax */
                    154:        MANDOCERR_SYNTCHILD, /* child violates parent syntax */
                    155:        MANDOCERR_SYNTARGCOUNT, /* argument count wrong, violates syntax */
1.26      kristaps  156:        MANDOCERR_SOPATH, /* NOT IMPLEMENTED: .so with absolute path or ".." */
1.5       kristaps  157:        MANDOCERR_NODOCBODY, /* no document body */
                    158:        MANDOCERR_NODOCPROLOG, /* no document prologue */
1.18      schwarze  159:        MANDOCERR_MEM, /* static buffer exhausted */
1.1       kristaps  160:        MANDOCERR_MAX
1.43      kristaps  161: };
                    162:
                    163: struct tbl {
                    164:        char              tab; /* cell-separator */
                    165:        char              decimal; /* decimal point */
                    166:        int               linesize;
                    167:        int               opts;
                    168: #define        TBL_OPT_CENTRE   (1 << 0)
                    169: #define        TBL_OPT_EXPAND   (1 << 1)
                    170: #define        TBL_OPT_BOX      (1 << 2)
                    171: #define        TBL_OPT_DBOX     (1 << 3)
                    172: #define        TBL_OPT_ALLBOX   (1 << 4)
                    173: #define        TBL_OPT_NOKEEP   (1 << 5)
                    174: #define        TBL_OPT_NOSPACE  (1 << 6)
1.45      kristaps  175:        int               cols; /* number of columns */
1.38      kristaps  176: };
                    177:
1.41      kristaps  178: enum   tbl_headt {
                    179:        TBL_HEAD_DATA, /* plug in data from tbl_dat */
                    180:        TBL_HEAD_VERT, /* vertical spacer */
                    181:        TBL_HEAD_DVERT  /* double-vertical spacer */
                    182: };
                    183:
                    184: /*
                    185:  * The head of a table specifies all of its columns.  When formatting a
                    186:  * tbl_span, iterate over these and plug in data from the tbl_span when
                    187:  * appropriate, using tbl_cell as a guide to placement.
                    188:  */
                    189: struct tbl_head {
                    190:        enum tbl_headt    pos;
1.45      kristaps  191:        int               ident; /* 0 <= unique id < cols */
1.41      kristaps  192:        struct tbl_head  *next;
                    193:        struct tbl_head  *prev;
                    194: };
                    195:
1.38      kristaps  196: enum   tbl_cellt {
                    197:        TBL_CELL_CENTRE, /* c, C */
                    198:        TBL_CELL_RIGHT, /* r, R */
                    199:        TBL_CELL_LEFT, /* l, L */
                    200:        TBL_CELL_NUMBER, /* n, N */
                    201:        TBL_CELL_SPAN, /* s, S */
                    202:        TBL_CELL_LONG, /* a, A */
                    203:        TBL_CELL_DOWN, /* ^ */
                    204:        TBL_CELL_HORIZ, /* _, - */
                    205:        TBL_CELL_DHORIZ, /* = */
                    206:        TBL_CELL_VERT, /* | */
                    207:        TBL_CELL_DVERT, /* || */
                    208:        TBL_CELL_MAX
                    209: };
                    210:
                    211: /*
                    212:  * A cell in a layout row.
                    213:  */
                    214: struct tbl_cell {
                    215:        struct tbl_cell  *next;
                    216:        enum tbl_cellt    pos;
1.51      kristaps  217:        size_t            spacing;
1.38      kristaps  218:        int               flags;
                    219: #define        TBL_CELL_TALIGN  (1 << 0) /* t, T */
                    220: #define        TBL_CELL_BALIGN  (1 << 1) /* d, D */
                    221: #define        TBL_CELL_BOLD    (1 << 2) /* fB, B, b */
                    222: #define        TBL_CELL_ITALIC  (1 << 3) /* fI, I, i */
                    223: #define        TBL_CELL_EQUAL   (1 << 4) /* e, E */
                    224: #define        TBL_CELL_UP      (1 << 5) /* u, U */
                    225: #define        TBL_CELL_WIGN    (1 << 6) /* z, Z */
1.41      kristaps  226:        struct tbl_head  *head;
1.38      kristaps  227: };
                    228:
                    229: /*
                    230:  * A layout row.
                    231:  */
                    232: struct tbl_row {
                    233:        struct tbl_row   *next;
                    234:        struct tbl_cell  *first;
                    235:        struct tbl_cell  *last;
                    236: };
                    237:
1.40      kristaps  238: enum   tbl_datt {
1.51      kristaps  239:        TBL_DATA_NONE, /* has no data */
                    240:        TBL_DATA_DATA, /* consists of data/string */
                    241:        TBL_DATA_HORIZ, /* horizontal line */
                    242:        TBL_DATA_DHORIZ, /* double-horizontal line */
                    243:        TBL_DATA_NHORIZ, /* squeezed horizontal line */
                    244:        TBL_DATA_NDHORIZ /* squeezed double-horizontal line */
1.40      kristaps  245: };
                    246:
1.38      kristaps  247: /*
                    248:  * A cell within a row of data.  The "string" field contains the actual
                    249:  * string value that's in the cell.  The rest is layout.
                    250:  */
                    251: struct tbl_dat {
1.51      kristaps  252:        struct tbl_cell  *layout; /* layout cell */
1.50      kristaps  253:        int               spans; /* how many spans follow */
1.38      kristaps  254:        struct tbl_dat   *next;
1.51      kristaps  255:        char             *string; /* data (NULL if not TBL_DATA_DATA) */
1.40      kristaps  256:        enum tbl_datt     pos;
                    257: };
                    258:
                    259: enum   tbl_spant {
                    260:        TBL_SPAN_DATA, /* span consists of data */
                    261:        TBL_SPAN_HORIZ, /* span is horizontal line */
                    262:        TBL_SPAN_DHORIZ /* span is double horizontal line */
1.38      kristaps  263: };
                    264:
                    265: /*
                    266:  * A row of data in a table.
                    267:  */
                    268: struct tbl_span {
1.44      kristaps  269:        struct tbl       *tbl;
                    270:        struct tbl_head  *head;
1.51      kristaps  271:        struct tbl_row   *layout; /* layout row */
1.38      kristaps  272:        struct tbl_dat   *first;
                    273:        struct tbl_dat   *last;
1.56      kristaps  274:        int               line; /* parse line */
1.44      kristaps  275:        int               flags;
                    276: #define        TBL_SPAN_FIRST   (1 << 0)
                    277: #define        TBL_SPAN_LAST    (1 << 1)
1.40      kristaps  278:        enum tbl_spant    pos;
1.38      kristaps  279:        struct tbl_span  *next;
1.55      kristaps  280: };
                    281:
1.83      kristaps  282: enum   eqn_boxt {
1.84      kristaps  283:        EQN_ROOT, /* root of parse tree */
                    284:        EQN_TEXT, /* text (number, variable, whatever) */
                    285:        EQN_SUBEXPR /* nested subexpression */
1.83      kristaps  286: };
                    287:
1.85      kristaps  288: enum   eqn_markt {
                    289:        EQNMARK_NONE = 0,
                    290:        EQNMARK_DOT,
                    291:        EQNMARK_DOTDOT,
                    292:        EQNMARK_HAT,
                    293:        EQNMARK_TILDE,
                    294:        EQNMARK_VEC,
                    295:        EQNMARK_DYAD,
                    296:        EQNMARK_BAR,
                    297:        EQNMARK_UNDER,
                    298:        EQNMARK__MAX
                    299: };
                    300:
1.86      kristaps  301: enum   eqn_fontt {
                    302:        EQNFONT_NONE = 0,
                    303:        EQNFONT_ROMAN,
                    304:        EQNFONT_BOLD,
                    305:        EQNFONT_ITALIC,
                    306:        EQNFONT__MAX
                    307: };
                    308:
1.87      kristaps  309: enum   eqn_post {
                    310:        EQNPOS_NONE = 0,
                    311:        EQNPOS_OVER,
                    312:        EQNPOS_SUP,
                    313:        EQNPOS_SUB,
                    314:        EQNPOS_TO,
                    315:        EQNPOS_FROM,
                    316:        EQNPOS_ABOVE,
                    317:        EQNPOS__MAX
                    318: };
                    319:
1.86      kristaps  320:  /*
1.84      kristaps  321:  * A "box" is a parsed mathematical expression as defined by the eqn.7
                    322:  * grammar.
                    323:  */
1.83      kristaps  324: struct eqn_box {
1.88    ! kristaps  325:        int               size; /* font size of expression */
        !           326: #define        EQN_DEFSIZE       INT_MIN
1.84      kristaps  327:        enum eqn_boxt     type; /* type of node */
                    328:        struct eqn_box   *child; /* child node */
                    329:        struct eqn_box   *next; /* next in tree */
1.87      kristaps  330:        enum eqn_post     pos; /* position of next box */
1.84      kristaps  331:        char             *text; /* text (or NULL) */
1.86      kristaps  332:        enum eqn_markt    mark; /* a mark about the box */
                    333:        enum eqn_fontt    font; /* font of box */
1.83      kristaps  334: };
                    335:
1.87      kristaps  336: /*
                    337:  * An equation consists of a tree of expressions starting at a given
                    338:  * line and position.
                    339:  */
1.55      kristaps  340: struct eqn {
1.84      kristaps  341:        struct eqn_box   *root; /* root mathematical expression */
1.82      kristaps  342:        int               ln; /* invocation line */
1.57      kristaps  343:        int               pos; /* invocation position */
1.16      kristaps  344: };
1.22      kristaps  345:
1.60      kristaps  346: /*
1.62      kristaps  347:  * The type of parse sequence.  This value is usually passed via the
                    348:  * mandoc(1) command line of -man and -mdoc.  It's almost exclusively
                    349:  * -mandoc but the others have been retained for compatibility.
                    350:  */
                    351: enum   mparset {
                    352:        MPARSE_AUTO, /* magically determine the document type */
                    353:        MPARSE_MDOC, /* assume -mdoc */
                    354:        MPARSE_MAN /* assume -man */
                    355: };
                    356:
1.70      kristaps  357: enum   mandoc_esc {
                    358:        ESCAPE_ERROR = 0, /* bail! unparsable escape */
                    359:        ESCAPE_IGNORE, /* escape to be ignored */
                    360:        ESCAPE_SPECIAL, /* a regular special character */
                    361:        ESCAPE_FONT, /* a generic font mode */
                    362:        ESCAPE_FONTBOLD, /* bold font mode */
                    363:        ESCAPE_FONTITALIC, /* italic font mode */
                    364:        ESCAPE_FONTROMAN, /* roman font mode */
                    365:        ESCAPE_FONTPREV, /* previous font mode */
                    366:        ESCAPE_NUMBERED, /* a numbered glyph */
1.75      kristaps  367:        ESCAPE_UNICODE, /* a unicode codepoint */
1.70      kristaps  368:        ESCAPE_NOSPACE /* suppress space if the last on a line */
                    369: };
                    370:
1.63      kristaps  371: typedef        void    (*mandocmsg)(enum mandocerr, enum mandoclevel,
                    372:                        const char *, int, int, const char *);
1.62      kristaps  373:
                    374: struct mparse;
1.71      kristaps  375: struct mchars;
1.62      kristaps  376: struct mdoc;
                    377: struct man;
1.59      kristaps  378:
1.22      kristaps  379: __BEGIN_DECLS
1.62      kristaps  380:
                    381: void             mparse_free(struct mparse *);
                    382: void             mparse_reset(struct mparse *);
1.64      kristaps  383: struct mparse   *mparse_alloc(enum mparset,
1.63      kristaps  384:                        enum mandoclevel, mandocmsg, void *);
1.62      kristaps  385: enum mandoclevel  mparse_readfd(struct mparse *, int, const char *);
                    386: void             mparse_result(struct mparse *, struct mdoc **, struct man **);
1.69      kristaps  387: const char      *mparse_strerror(enum mandocerr);
                    388: const char      *mparse_strlevel(enum mandoclevel);
1.16      kristaps  389:
1.59      kristaps  390: void            *mandoc_calloc(size_t, size_t);
                    391: void            *mandoc_malloc(size_t);
                    392: void            *mandoc_realloc(void *, size_t);
1.78      kristaps  393: char            *mandoc_strdup(const char *);
1.70      kristaps  394:
                    395: enum mandoc_esc          mandoc_escape(const char **, const char **, int *);
1.71      kristaps  396:
1.73      kristaps  397: struct mchars   *mchars_alloc(void);
1.74      kristaps  398: char             mchars_num2char(const char *, size_t);
1.76      kristaps  399: int              mchars_num2uc(const char *, size_t);
1.71      kristaps  400: const char      *mchars_spec2str(struct mchars *, const char *, size_t, size_t *);
                    401: int              mchars_spec2cp(struct mchars *, const char *, size_t);
                    402: void             mchars_free(struct mchars *);
                    403:
1.1       kristaps  404:
                    405: __END_DECLS
                    406:
                    407: #endif /*!MANDOC_H*/

CVSweb