mandoc.h

   1 /*      $Id: mandoc.h,v 1.37 2010/12/29 14:38:14 kristaps Exp $ */
   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
  19
  20 #define ASCII_NBRSP      31  /* non-breaking space */
  21 #define ASCII_HYPH       30  /* breakable hyphen */
  22
  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  */
  29 enum    mandoclevel {
  30         MANDOCLEVEL_OK = 0,
  31         MANDOCLEVEL_RESERVED,
  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 */
  37         MANDOCLEVEL_MAX
  38 };
  39
  40 /*
  41  * All possible things that can go wrong within a parse, be it libroff,
  42  * libmdoc, or libman.
  43  */
  44 enum    mandocerr {
  45         MANDOCERR_OK,
  46
  47         MANDOCERR_WARNING, /* ===== start of warnings ===== */
  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 */
  60         MANDOCERR_SO, /* .so is fragile, better use ln(1) */
  61         MANDOCERR_NAMESECFIRST, /* NAME section must come first */
  62         MANDOCERR_BADNAMESEC, /* bad NAME section contents */
  63         MANDOCERR_NONAME, /* manual name not yet set */
  64         MANDOCERR_SECOOO, /* sections out of conventional order */
  65         MANDOCERR_SECREP, /* duplicate section name */
  66         MANDOCERR_SECMSEC, /* section not in conventional manual section */
  67
  68         /* related to macros and nesting */
  69         MANDOCERR_MACROOBS, /* skipping obsolete macro */
  70         MANDOCERR_IGNPAR, /* skipping paragraph macro */
  71         MANDOCERR_SCOPENEST, /* blocks badly nested */
  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 */
  82
  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 */
  89         MANDOCERR_BADBOOL, /* bad Boolean value */
  90         MANDOCERR_BADFONT, /* unknown font */
  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 */
  98         MANDOCERR_BADCOMMENT, /* bad comment style */
  99         MANDOCERR_BADESCAPE, /* unknown escape sequence */
 100         MANDOCERR_BADQUOTE, /* unterminated quoted string */
 101
 102         MANDOCERR_ERROR, /* ===== start of errors ===== */
 103
 104         MANDOCERR_TBL, /* bad table syntax */
 105         MANDOCERR_TBLOPT, /* bad table option */
 106         MANDOCERR_TBLLAYOUT, /* bad table layout */
 107         MANDOCERR_TBLNOLAYOUT, /* no table layout cells specified */
 108         MANDOCERR_ROFFLOOP, /* input stack limit exceeded, infinite loop? */
 109         MANDOCERR_BADCHAR, /* skipping bad character */
 110         MANDOCERR_NOTEXT, /* skipping text before the first section header */
 111         MANDOCERR_MACRO, /* skipping unknown macro */
 112         MANDOCERR_REQUEST, /* NOT IMPLEMENTED: skipping request */
 113         MANDOCERR_LINESCOPE, /* line scope broken */
 114         MANDOCERR_ARGCOUNT, /* argument count wrong */
 115         MANDOCERR_NOSCOPE, /* skipping end of block that is not open */
 116         MANDOCERR_SCOPEBROKEN, /* missing end of block */
 117         MANDOCERR_SCOPEEXIT, /* scope open on exit */
 118         MANDOCERR_UNAME, /* uname(3) system call failed */
 119         /* FIXME: merge following with MANDOCERR_ARGCOUNT */
 120         MANDOCERR_NOARGS, /* macro requires line argument(s) */
 121         MANDOCERR_NOBODY, /* macro requires body argument(s) */
 122         MANDOCERR_NOARGV, /* macro requires argument(s) */
 123         MANDOCERR_LISTTYPE, /* missing list type */
 124         MANDOCERR_ARGSLOST, /* line argument(s) will be lost */
 125         MANDOCERR_BODYLOST, /* body argument(s) will be lost */
 126
 127         MANDOCERR_FATAL, /* ===== start of fatal errors ===== */
 128
 129         MANDOCERR_COLUMNS, /* column syntax is inconsistent */
 130         MANDOCERR_BADDISP, /* NOT IMPLEMENTED: .Bd -file */
 131         MANDOCERR_SYNTLINESCOPE, /* line scope broken, syntax violated */
 132         MANDOCERR_SYNTARGVCOUNT, /* argument count wrong, violates syntax */
 133         MANDOCERR_SYNTCHILD, /* child violates parent syntax */
 134         MANDOCERR_SYNTARGCOUNT, /* argument count wrong, violates syntax */
 135         MANDOCERR_SOPATH, /* NOT IMPLEMENTED: .so with absolute path or ".." */
 136         MANDOCERR_NODOCBODY, /* no document body */
 137         MANDOCERR_NODOCPROLOG, /* no document prologue */
 138         MANDOCERR_MEM, /* static buffer exhausted */
 139         MANDOCERR_MAX
 140 };
 141
 142 /*
 143  * Available registers (set in libroff, accessed elsewhere).
 144  */
 145 enum    regs {
 146         REG_nS = 0,
 147         REG__MAX
 148 };
 149
 150 /*
 151  * A register (struct reg) can consist of many types: this consists of
 152  * normalised types from the original string form.
 153  */
 154 union   regval {
 155         unsigned  u; /* unsigned integer */
 156 };
 157
 158 /*
 159  * A single register entity.  If "set" is zero, the value of the
 160  * register should be the default one, which is per-register.  It's
 161  * assumed that callers know which type in "v" corresponds to which
 162  * register value.
 163  */
 164 struct  reg {
 165         int               set; /* whether set or not */
 166         union regval      v; /* parsed data */
 167 };
 168
 169 /*
 170  * The primary interface to setting register values is in libroff,
 171  * although libmdoc and libman from time to time will manipulate
 172  * registers (such as `.Sh SYNOPSIS' enabling REG_nS).
 173  */
 174 struct  regset {
 175         struct reg        regs[REG__MAX];
 176 };
 177
 178 __BEGIN_DECLS
 179
 180 /*
 181  * Callback function for warnings, errors, and fatal errors as they
 182  * occur in the compilers libroff, libmdoc, and libman.
 183  */
 184 typedef int             (*mandocmsg)(enum mandocerr, void *,
 185                                 int, int, const char *);
 186
 187 __END_DECLS
 188
 189 #endif /*!MANDOC_H*/