mandoc.h

   1 /*      $Id: mandoc.h,v 1.46 2011/01/03 23:53:51 schwarze Exp $ */
   2 /*
   3  * Copyright (c) 2010, 2011 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_ARGCWARN, /* argument count wrong */
  79         MANDOCERR_DISPTYPE, /* missing display type */
  80         MANDOCERR_LISTFIRST, /* list type must come first */
  81         MANDOCERR_NOWIDTHARG, /* tag lists require a width argument */
  82         MANDOCERR_FONTTYPE, /* missing font type */
  83
  84         /* related to bad macro arguments */
  85         MANDOCERR_IGNARGV, /* skipping argument */
  86         MANDOCERR_ARGVREP, /* duplicate argument */
  87         MANDOCERR_DISPREP, /* duplicate display type */
  88         MANDOCERR_LISTREP, /* duplicate list type */
  89         MANDOCERR_BADATT, /* unknown AT&T UNIX version */
  90         MANDOCERR_BADBOOL, /* bad Boolean value */
  91         MANDOCERR_BADFONT, /* unknown font */
  92         MANDOCERR_BADSTANDARD, /* unknown standard specifier */
  93         MANDOCERR_BADWIDTH, /* bad width argument */
  94
  95         /* related to plain text */
  96         MANDOCERR_NOBLANKLN, /* blank line in non-literal context */
  97         MANDOCERR_BADTAB, /* tab in non-literal context */
  98         MANDOCERR_EOLNSPACE, /* end of line whitespace */
  99         MANDOCERR_BADCOMMENT, /* bad comment style */
 100         MANDOCERR_BADESCAPE, /* unknown escape sequence */
 101         MANDOCERR_BADQUOTE, /* unterminated quoted string */
 102
 103         /* related to tables */
 104         MANDOCERR_TBLEXTRADAT, /* extra data cells */
 105
 106         MANDOCERR_ERROR, /* ===== start of errors ===== */
 107
 108         /* related to tables */
 109         MANDOCERR_TBL, /* bad table syntax */
 110         MANDOCERR_TBLOPT, /* bad table option */
 111         MANDOCERR_TBLLAYOUT, /* bad table layout */
 112         MANDOCERR_TBLNOLAYOUT, /* no table layout cells specified */
 113         MANDOCERR_TBLNODATA, /* no table data cells specified */
 114
 115         MANDOCERR_ROFFLOOP, /* input stack limit exceeded, infinite loop? */
 116         MANDOCERR_BADCHAR, /* skipping bad character */
 117         MANDOCERR_NOTEXT, /* skipping text before the first section header */
 118         MANDOCERR_MACRO, /* skipping unknown macro */
 119         MANDOCERR_REQUEST, /* NOT IMPLEMENTED: skipping request */
 120         MANDOCERR_LINESCOPE, /* line scope broken */
 121         MANDOCERR_ARGCOUNT, /* argument count wrong */
 122         MANDOCERR_NOSCOPE, /* skipping end of block that is not open */
 123         MANDOCERR_SCOPEBROKEN, /* missing end of block */
 124         MANDOCERR_SCOPEEXIT, /* scope open on exit */
 125         MANDOCERR_UNAME, /* uname(3) system call failed */
 126         /* FIXME: merge following with MANDOCERR_ARGCOUNT */
 127         MANDOCERR_NOARGS, /* macro requires line argument(s) */
 128         MANDOCERR_NOBODY, /* macro requires body argument(s) */
 129         MANDOCERR_NOARGV, /* macro requires argument(s) */
 130         MANDOCERR_LISTTYPE, /* missing list type */
 131         MANDOCERR_ARGSLOST, /* line argument(s) will be lost */
 132         MANDOCERR_BODYLOST, /* body argument(s) will be lost */
 133
 134         MANDOCERR_FATAL, /* ===== start of fatal errors ===== */
 135
 136         MANDOCERR_COLUMNS, /* column syntax is inconsistent */
 137         MANDOCERR_BADDISP, /* NOT IMPLEMENTED: .Bd -file */
 138         MANDOCERR_SYNTLINESCOPE, /* line scope broken, syntax violated */
 139         MANDOCERR_SYNTARGVCOUNT, /* argument count wrong, violates syntax */
 140         MANDOCERR_SYNTCHILD, /* child violates parent syntax */
 141         MANDOCERR_SYNTARGCOUNT, /* argument count wrong, violates syntax */
 142         MANDOCERR_SOPATH, /* NOT IMPLEMENTED: .so with absolute path or ".." */
 143         MANDOCERR_NODOCBODY, /* no document body */
 144         MANDOCERR_NODOCPROLOG, /* no document prologue */
 145         MANDOCERR_MEM, /* static buffer exhausted */
 146         MANDOCERR_MAX
 147 };
 148
 149 struct  tbl {
 150         char              tab; /* cell-separator */
 151         char              decimal; /* decimal point */
 152         int               linesize;
 153         char              delims[2]; /* FIXME: deprecate */
 154         int               opts;
 155 #define TBL_OPT_CENTRE   (1 << 0)
 156 #define TBL_OPT_EXPAND   (1 << 1)
 157 #define TBL_OPT_BOX      (1 << 2)
 158 #define TBL_OPT_DBOX     (1 << 3)
 159 #define TBL_OPT_ALLBOX   (1 << 4)
 160 #define TBL_OPT_NOKEEP   (1 << 5)
 161 #define TBL_OPT_NOSPACE  (1 << 6)
 162         int               cols; /* number of columns */
 163 };
 164
 165 enum    tbl_headt {
 166         TBL_HEAD_DATA, /* plug in data from tbl_dat */
 167         TBL_HEAD_VERT, /* vertical spacer */
 168         TBL_HEAD_DVERT  /* double-vertical spacer */
 169 };
 170
 171 /*
 172  * The head of a table specifies all of its columns.  When formatting a
 173  * tbl_span, iterate over these and plug in data from the tbl_span when
 174  * appropriate, using tbl_cell as a guide to placement.
 175  */
 176 struct  tbl_head {
 177         enum tbl_headt    pos;
 178         int               ident; /* 0 <= unique id < cols */
 179         struct tbl_head  *next;
 180         struct tbl_head  *prev;
 181 };
 182
 183 enum    tbl_cellt {
 184         TBL_CELL_CENTRE, /* c, C */
 185         TBL_CELL_RIGHT, /* r, R */
 186         TBL_CELL_LEFT, /* l, L */
 187         TBL_CELL_NUMBER, /* n, N */
 188         TBL_CELL_SPAN, /* s, S */
 189         TBL_CELL_LONG, /* a, A */
 190         TBL_CELL_DOWN, /* ^ */
 191         TBL_CELL_HORIZ, /* _, - */
 192         TBL_CELL_DHORIZ, /* = */
 193         TBL_CELL_VERT, /* | */
 194         TBL_CELL_DVERT, /* || */
 195         TBL_CELL_MAX
 196 };
 197
 198 /*
 199  * A cell in a layout row.
 200  */
 201 struct  tbl_cell {
 202         struct tbl_cell  *next;
 203         enum tbl_cellt    pos;
 204         int               spacing;
 205         int               flags;
 206 #define TBL_CELL_TALIGN  (1 << 0) /* t, T */
 207 #define TBL_CELL_BALIGN  (1 << 1) /* d, D */
 208 #define TBL_CELL_BOLD    (1 << 2) /* fB, B, b */
 209 #define TBL_CELL_ITALIC  (1 << 3) /* fI, I, i */
 210 #define TBL_CELL_EQUAL   (1 << 4) /* e, E */
 211 #define TBL_CELL_UP      (1 << 5) /* u, U */
 212 #define TBL_CELL_WIGN    (1 << 6) /* z, Z */
 213         struct tbl_head  *head;
 214 };
 215
 216 /*
 217  * A layout row.
 218  */
 219 struct  tbl_row {
 220         struct tbl_row   *next;
 221         struct tbl_cell  *first;
 222         struct tbl_cell  *last;
 223 };
 224
 225 enum    tbl_datt {
 226         TBL_DATA_DATA,
 227         TBL_DATA_HORIZ,
 228         TBL_DATA_DHORIZ,
 229         TBL_DATA_NHORIZ,
 230         TBL_DATA_NDHORIZ
 231 };
 232
 233 /*
 234  * A cell within a row of data.  The "string" field contains the actual
 235  * string value that's in the cell.  The rest is layout.
 236  */
 237 struct  tbl_dat {
 238         struct tbl_cell  *layout; /* layout cell: CAN BE NULL */
 239         struct tbl_dat   *next;
 240         char             *string;
 241         enum tbl_datt     pos;
 242 };
 243
 244 enum    tbl_spant {
 245         TBL_SPAN_DATA, /* span consists of data */
 246         TBL_SPAN_HORIZ, /* span is horizontal line */
 247         TBL_SPAN_DHORIZ /* span is double horizontal line */
 248 };
 249
 250 /*
 251  * A row of data in a table.
 252  */
 253 struct  tbl_span {
 254         struct tbl       *tbl;
 255         struct tbl_head  *head;
 256         struct tbl_row   *layout; /* layout row: CAN BE NULL */
 257         struct tbl_dat   *first;
 258         struct tbl_dat   *last;
 259         int               flags;
 260 #define TBL_SPAN_FIRST   (1 << 0)
 261 #define TBL_SPAN_LAST    (1 << 1)
 262         enum tbl_spant    pos;
 263         struct tbl_span  *next;
 264 };
 265
 266 /*
 267  * Available registers (set in libroff, accessed elsewhere).
 268  */
 269 enum    regs {
 270         REG_nS = 0,
 271         REG__MAX
 272 };
 273
 274 /*
 275  * A register (struct reg) can consist of many types: this consists of
 276  * normalised types from the original string form.
 277  */
 278 union   regval {
 279         unsigned  u; /* unsigned integer */
 280 };
 281
 282 /*
 283  * A single register entity.  If "set" is zero, the value of the
 284  * register should be the default one, which is per-register.  It's
 285  * assumed that callers know which type in "v" corresponds to which
 286  * register value.
 287  */
 288 struct  reg {
 289         int               set; /* whether set or not */
 290         union regval      v; /* parsed data */
 291 };
 292
 293 /*
 294  * The primary interface to setting register values is in libroff,
 295  * although libmdoc and libman from time to time will manipulate
 296  * registers (such as `.Sh SYNOPSIS' enabling REG_nS).
 297  */
 298 struct  regset {
 299         struct reg        regs[REG__MAX];
 300 };
 301
 302 __BEGIN_DECLS
 303
 304 /*
 305  * Callback function for warnings, errors, and fatal errors as they
 306  * occur in the compilers libroff, libmdoc, and libman.
 307  */
 308 typedef int             (*mandocmsg)(enum mandocerr, void *,
 309                                 int, int, const char *);
 310
 311 __END_DECLS
 312
 313 #endif /*!MANDOC_H*/