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

Annotation of mandoc/mandoc.h, Revision 1.28

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

CVSweb