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

Annotation of mandoc/mandoc.h, Revision 1.36

1.36    ! kristaps    1: /*     $Id: mandoc.h,v 1.35 2010/12/22 11:38:17 kristaps Exp $ */
1.1       kristaps    2: /*
                      3:  * Copyright (c) 2010 Kristaps Dzonsons <kristaps@bsd.lv>
                      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 */
                     53:        MANDOCERR_BADDATE, /* cannot parse date argument */
                     54:        MANDOCERR_PROLOGOOO, /* prologue macros out of order */
                     55:        MANDOCERR_PROLOGREP, /* duplicate prologue macro */
                     56:        MANDOCERR_BADPROLOG, /* macro not allowed in prologue */
                     57:        MANDOCERR_BADBODY, /* macro not allowed in body */
                     58:
                     59:        /* related to document structure */
1.26      kristaps   60:        MANDOCERR_SO, /* .so is fragile, better use ln(1) */
1.32      kristaps   61:        MANDOCERR_NAMESECFIRST, /* NAME section must come first */
                     62:        MANDOCERR_BADNAMESEC, /* bad NAME section contents */
                     63:        MANDOCERR_NONAME, /* manual name not yet set */
1.9       kristaps   64:        MANDOCERR_SECOOO, /* sections out of conventional order */
1.32      kristaps   65:        MANDOCERR_SECREP, /* duplicate section name */
1.5       kristaps   66:        MANDOCERR_SECMSEC, /* section not in conventional manual section */
1.32      kristaps   67:
                     68:        /* related to macros and nesting */
                     69:        MANDOCERR_MACROOBS, /* skipping obsolete macro */
1.35      kristaps   70:        MANDOCERR_IGNPAR, /* skipping paragraph macro */
1.14      schwarze   71:        MANDOCERR_SCOPENEST, /* blocks badly nested */
1.32      kristaps   72:        MANDOCERR_CHILD, /* child violates parent syntax */
                     73:        MANDOCERR_NESTEDDISP, /* nested displays are not portable */
                     74:        MANDOCERR_SCOPEREP, /* already in literal mode */
                     75:
                     76:        /* related to missing macro arguments */
                     77:        MANDOCERR_MACROEMPTY, /* skipping empty macro */
                     78:        MANDOCERR_DISPTYPE, /* missing display type */
                     79:        MANDOCERR_LISTFIRST, /* list type must come first */
                     80:        MANDOCERR_NOWIDTHARG, /* tag lists require a width argument */
                     81:        MANDOCERR_FONTTYPE, /* missing font type */
1.13      schwarze   82:
1.32      kristaps   83:        /* related to bad macro arguments */
                     84:        MANDOCERR_IGNARGV, /* skipping argument */
                     85:        MANDOCERR_ARGVREP, /* duplicate argument */
                     86:        MANDOCERR_DISPREP, /* duplicate display type */
                     87:        MANDOCERR_LISTREP, /* duplicate list type */
                     88:        MANDOCERR_BADATT, /* unknown AT&T UNIX version */
1.5       kristaps   89:        MANDOCERR_BADBOOL, /* bad Boolean value */
1.31      kristaps   90:        MANDOCERR_BADFONT, /* unknown font */
1.32      kristaps   91:        MANDOCERR_BADSTANDARD, /* unknown standard specifier */
                     92:        MANDOCERR_BADWIDTH, /* bad width argument */
                     93:
                     94:        /* related to plain text */
                     95:        MANDOCERR_NOBLANKLN, /* blank line in non-literal context */
                     96:        MANDOCERR_BADTAB, /* tab in non-literal context */
                     97:        MANDOCERR_EOLNSPACE, /* end of line whitespace */
1.5       kristaps   98:        MANDOCERR_BADCOMMENT, /* bad comment style */
1.32      kristaps   99:        MANDOCERR_BADESCAPE, /* unknown escape sequence */
                    100:        MANDOCERR_BADQUOTE, /* unterminated quoted string */
                    101:
                    102:        MANDOCERR_ERROR, /* ===== start of errors ===== */
                    103:
1.36    ! kristaps  104:        MANDOCERR_TBL, /* bad table syntax */
        !           105:        MANDOCERR_TBLOPT, /* bad table option */
1.33      schwarze  106:        MANDOCERR_ROFFLOOP, /* input stack limit exceeded, infinite loop? */
1.32      kristaps  107:        MANDOCERR_BADCHAR, /* skipping bad character */
                    108:        MANDOCERR_NOTEXT, /* skipping text before the first section header */
                    109:        MANDOCERR_MACRO, /* skipping unknown macro */
1.25      kristaps  110:        MANDOCERR_REQUEST, /* NOT IMPLEMENTED: skipping request */
1.5       kristaps  111:        MANDOCERR_LINESCOPE, /* line scope broken */
                    112:        MANDOCERR_ARGCOUNT, /* argument count wrong */
1.32      kristaps  113:        MANDOCERR_NOSCOPE, /* skipping end of block that is not open */
1.30      kristaps  114:        MANDOCERR_SCOPEBROKEN, /* missing end of block */
1.19      schwarze  115:        MANDOCERR_SCOPEEXIT, /* scope open on exit */
1.28      kristaps  116:        MANDOCERR_UNAME, /* uname(3) system call failed */
1.5       kristaps  117:        /* FIXME: merge following with MANDOCERR_ARGCOUNT */
                    118:        MANDOCERR_NOARGS, /* macro requires line argument(s) */
                    119:        MANDOCERR_NOBODY, /* macro requires body argument(s) */
                    120:        MANDOCERR_NOARGV, /* macro requires argument(s) */
1.10      kristaps  121:        MANDOCERR_LISTTYPE, /* missing list type */
1.5       kristaps  122:        MANDOCERR_ARGSLOST, /* line argument(s) will be lost */
                    123:        MANDOCERR_BODYLOST, /* body argument(s) will be lost */
1.13      schwarze  124:
1.21      kristaps  125:        MANDOCERR_FATAL, /* ===== start of fatal errors ===== */
1.32      kristaps  126:
1.8       kristaps  127:        MANDOCERR_COLUMNS, /* column syntax is inconsistent */
1.32      kristaps  128:        MANDOCERR_BADDISP, /* NOT IMPLEMENTED: .Bd -file */
1.5       kristaps  129:        MANDOCERR_SYNTLINESCOPE, /* line scope broken, syntax violated */
                    130:        MANDOCERR_SYNTARGVCOUNT, /* argument count wrong, violates syntax */
                    131:        MANDOCERR_SYNTCHILD, /* child violates parent syntax */
                    132:        MANDOCERR_SYNTARGCOUNT, /* argument count wrong, violates syntax */
1.26      kristaps  133:        MANDOCERR_SOPATH, /* NOT IMPLEMENTED: .so with absolute path or ".." */
1.5       kristaps  134:        MANDOCERR_NODOCBODY, /* no document body */
                    135:        MANDOCERR_NODOCPROLOG, /* no document prologue */
1.18      schwarze  136:        MANDOCERR_MEM, /* static buffer exhausted */
1.1       kristaps  137:        MANDOCERR_MAX
                    138: };
                    139:
1.22      kristaps  140: /*
                    141:  * Available registers (set in libroff, accessed elsewhere).
                    142:  */
1.16      kristaps  143: enum   regs {
1.22      kristaps  144:        REG_nS = 0,
1.16      kristaps  145:        REG__MAX
1.21      kristaps  146: };
                    147:
1.22      kristaps  148: /*
                    149:  * A register (struct reg) can consist of many types: this consists of
                    150:  * normalised types from the original string form.
                    151:  */
                    152: union  regval {
                    153:        unsigned  u; /* unsigned integer */
1.16      kristaps  154: };
                    155:
                    156: /*
                    157:  * A single register entity.  If "set" is zero, the value of the
                    158:  * register should be the default one, which is per-register.  It's
                    159:  * assumed that callers know which type in "v" corresponds to which
                    160:  * register value.
                    161:  */
                    162: struct reg {
                    163:        int               set; /* whether set or not */
1.22      kristaps  164:        union regval      v; /* parsed data */
1.16      kristaps  165: };
                    166:
                    167: /*
                    168:  * The primary interface to setting register values is in libroff,
                    169:  * although libmdoc and libman from time to time will manipulate
                    170:  * registers (such as `.Sh SYNOPSIS' enabling REG_nS).
                    171:  */
                    172: struct regset {
                    173:        struct reg        regs[REG__MAX];
                    174: };
1.22      kristaps  175:
                    176: __BEGIN_DECLS
1.16      kristaps  177:
                    178: /*
                    179:  * Callback function for warnings, errors, and fatal errors as they
                    180:  * occur in the compilers libroff, libmdoc, and libman.
                    181:  */
                    182: typedef        int             (*mandocmsg)(enum mandocerr, void *,
                    183:                                int, int, const char *);
1.1       kristaps  184:
                    185: __END_DECLS
                    186:
                    187: #endif /*!MANDOC_H*/

CVSweb