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

Diff for /mandoc/mandoc.h between version 1.38 and 1.222

version 1.38, 2010/12/31 18:19:43 version 1.222, 2017/06/03 15:55:24
Line 1 
Line 1 
 /*      $Id$ */  /*      $Id$ */
 /*  /*
  * Copyright (c) 2010 Kristaps Dzonsons <kristaps@bsd.lv>   * Copyright (c) 2010, 2011, 2014 Kristaps Dzonsons <kristaps@bsd.lv>
    * Copyright (c) 2010-2017 Ingo Schwarze <schwarze@openbsd.org>
  *   *
  * Permission to use, copy, modify, and distribute this software for any   * Permission to use, copy, modify, and distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above   * purpose with or without fee is hereby granted, provided that the above
  * copyright notice and this permission notice appear in all copies.   * copyright notice and this permission notice appear in all copies.
  *   *
  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES   * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF   * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR   * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES   * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN   * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF   * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.   * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */   */
 #ifndef MANDOC_H  
 #define MANDOC_H  
   
 #define ASCII_NBRSP      31  /* non-breaking space */  #define ASCII_NBRSP      31  /* non-breaking space */
 #define ASCII_HYPH       30  /* breakable hyphen */  #define ASCII_HYPH       30  /* breakable hyphen */
   #define ASCII_BREAK      29  /* breakable zero-width space */
   
 /*  /*
  * Status level.  This refers to both internal status (i.e., whilst   * Status level.  This refers to both internal status (i.e., whilst
Line 28 
Line 28 
  */   */
 enum    mandoclevel {  enum    mandoclevel {
         MANDOCLEVEL_OK = 0,          MANDOCLEVEL_OK = 0,
         MANDOCLEVEL_RESERVED,          MANDOCLEVEL_STYLE, /* style suggestions */
         MANDOCLEVEL_WARNING, /* warnings: syntax, whitespace, etc. */          MANDOCLEVEL_WARNING, /* warnings: syntax, whitespace, etc. */
         MANDOCLEVEL_ERROR, /* input has been thrown away */          MANDOCLEVEL_ERROR, /* input has been thrown away */
         MANDOCLEVEL_FATAL, /* input is borked */          MANDOCLEVEL_UNSUPP, /* input needs unimplemented features */
         MANDOCLEVEL_BADARG, /* bad argument in invocation */          MANDOCLEVEL_BADARG, /* bad argument in invocation */
         MANDOCLEVEL_SYSERR, /* system error */          MANDOCLEVEL_SYSERR, /* system error */
         MANDOCLEVEL_MAX          MANDOCLEVEL_MAX
Line 44  enum mandoclevel {
Line 44  enum mandoclevel {
 enum    mandocerr {  enum    mandocerr {
         MANDOCERR_OK,          MANDOCERR_OK,
   
           MANDOCERR_STYLE, /* ===== start of style suggestions ===== */
   
           MANDOCERR_MACRO_USELESS, /* useless macro: macro */
           MANDOCERR_BX, /* consider using OS macro: macro */
           MANDOCERR_ND_DOT, /* description line ends with a full stop */
   
         MANDOCERR_WARNING, /* ===== start of warnings ===== */          MANDOCERR_WARNING, /* ===== start of warnings ===== */
   
         /* related to the prologue */          /* related to the prologue */
         MANDOCERR_NOTITLE, /* no title in document */          MANDOCERR_DT_NOTITLE, /* missing manual title, using UNTITLED: line */
         MANDOCERR_UPPERCASE, /* document title should be all caps */          MANDOCERR_TH_NOTITLE, /* missing manual title, using "": [macro] */
         MANDOCERR_BADMSEC, /* unknown manual section */          MANDOCERR_TITLE_CASE, /* lower case character in document title */
         MANDOCERR_BADDATE, /* cannot parse date argument */          MANDOCERR_MSEC_MISSING, /* missing manual section, using "": macro */
         MANDOCERR_PROLOGOOO, /* prologue macros out of order */          MANDOCERR_MSEC_BAD, /* unknown manual section: Dt ... section */
         MANDOCERR_PROLOGREP, /* duplicate prologue macro */          MANDOCERR_DATE_MISSING, /* missing date, using today's date */
         MANDOCERR_BADPROLOG, /* macro not allowed in prologue */          MANDOCERR_DATE_BAD, /* cannot parse date, using it verbatim: date */
         MANDOCERR_BADBODY, /* macro not allowed in body */          MANDOCERR_OS_MISSING, /* missing Os macro, using "" */
           MANDOCERR_PROLOG_REP, /* duplicate prologue macro: macro */
           MANDOCERR_PROLOG_LATE, /* late prologue macro: macro */
           MANDOCERR_DT_LATE, /* skipping late title macro: Dt args */
           MANDOCERR_PROLOG_ORDER, /* prologue macros out of order: macros */
   
         /* related to document structure */          /* related to document structure */
         MANDOCERR_SO, /* .so is fragile, better use ln(1) */          MANDOCERR_SO, /* .so is fragile, better use ln(1): so path */
         MANDOCERR_NAMESECFIRST, /* NAME section must come first */          MANDOCERR_DOC_EMPTY, /* no document body */
         MANDOCERR_BADNAMESEC, /* bad NAME section contents */          MANDOCERR_SEC_BEFORE, /* content before first section header: macro */
         MANDOCERR_NONAME, /* manual name not yet set */          MANDOCERR_NAMESEC_FIRST, /* first section is not NAME: Sh title */
         MANDOCERR_SECOOO, /* sections out of conventional order */          MANDOCERR_NAMESEC_NONM, /* NAME section without Nm before Nd */
         MANDOCERR_SECREP, /* duplicate section name */          MANDOCERR_NAMESEC_NOND, /* NAME section without description */
         MANDOCERR_SECMSEC, /* section not in conventional manual section */          MANDOCERR_NAMESEC_ND, /* description not at the end of NAME */
           MANDOCERR_NAMESEC_BAD, /* bad NAME section content: macro */
           MANDOCERR_NAMESEC_PUNCT, /* missing comma before name: Nm name */
           MANDOCERR_ND_EMPTY, /* missing description line, using "" */
           MANDOCERR_ND_LATE, /* description line outside NAME section */
           MANDOCERR_SEC_ORDER, /* sections out of conventional order: Sh title */
           MANDOCERR_SEC_REP, /* duplicate section title: Sh title */
           MANDOCERR_SEC_MSEC, /* unexpected section: Sh title for ... only */
           MANDOCERR_XR_ORDER, /* unusual Xr order: ... after ... */
           MANDOCERR_XR_PUNCT, /* unusual Xr punctuation: ... after ... */
           MANDOCERR_AN_MISSING, /* AUTHORS section without An macro */
   
         /* related to macros and nesting */          /* related to macros and nesting */
         MANDOCERR_MACROOBS, /* skipping obsolete macro */          MANDOCERR_MACRO_OBS, /* obsolete macro: macro */
         MANDOCERR_IGNPAR, /* skipping paragraph macro */          MANDOCERR_MACRO_CALL, /* macro neither callable nor escaped: macro */
         MANDOCERR_SCOPENEST, /* blocks badly nested */          MANDOCERR_PAR_SKIP, /* skipping paragraph macro: macro ... */
         MANDOCERR_CHILD, /* child violates parent syntax */          MANDOCERR_PAR_MOVE, /* moving paragraph macro out of list: macro */
         MANDOCERR_NESTEDDISP, /* nested displays are not portable */          MANDOCERR_NS_SKIP, /* skipping no-space macro */
         MANDOCERR_SCOPEREP, /* already in literal mode */          MANDOCERR_BLK_NEST, /* blocks badly nested: macro ... */
           MANDOCERR_BD_NEST, /* nested displays are not portable: macro ... */
           MANDOCERR_BL_MOVE, /* moving content out of list: macro */
           MANDOCERR_FI_SKIP, /* fill mode already enabled, skipping: fi */
           MANDOCERR_NF_SKIP, /* fill mode already disabled, skipping: nf */
           MANDOCERR_BLK_LINE, /* line scope broken: macro breaks macro */
           MANDOCERR_BLK_BLANK, /* skipping blank line in line scope */
   
         /* related to missing macro arguments */          /* related to missing arguments */
         MANDOCERR_MACROEMPTY, /* skipping empty macro */          MANDOCERR_REQ_EMPTY, /* skipping empty request: request */
         MANDOCERR_DISPTYPE, /* missing display type */          MANDOCERR_COND_EMPTY, /* conditional request controls empty scope */
         MANDOCERR_LISTFIRST, /* list type must come first */          MANDOCERR_MACRO_EMPTY, /* skipping empty macro: macro */
         MANDOCERR_NOWIDTHARG, /* tag lists require a width argument */          MANDOCERR_BLK_EMPTY, /* empty block: macro */
         MANDOCERR_FONTTYPE, /* missing font type */          MANDOCERR_ARG_EMPTY, /* empty argument, using 0n: macro arg */
           MANDOCERR_BD_NOTYPE, /* missing display type, using -ragged: Bd */
           MANDOCERR_BL_LATETYPE, /* list type is not the first argument: Bl arg */
           MANDOCERR_BL_NOWIDTH, /* missing -width in -tag list, using 6n */
           MANDOCERR_EX_NONAME, /* missing utility name, using "": Ex */
           MANDOCERR_FO_NOHEAD, /* missing function name, using "": Fo */
           MANDOCERR_IT_NOHEAD, /* empty head in list item: Bl -type It */
           MANDOCERR_IT_NOBODY, /* empty list item: Bl -type It */
           MANDOCERR_BF_NOFONT, /* missing font type, using \fR: Bf */
           MANDOCERR_BF_BADFONT, /* unknown font type, using \fR: Bf font */
           MANDOCERR_PF_SKIP, /* nothing follows prefix: Pf arg */
           MANDOCERR_RS_EMPTY, /* empty reference block: Rs */
           MANDOCERR_XR_NOSEC, /* missing section argument: Xr arg */
           MANDOCERR_ARG_STD, /* missing -std argument, adding it: macro */
           MANDOCERR_OP_EMPTY, /* missing option string, using "": OP */
           MANDOCERR_UR_NOHEAD, /* missing resource identifier, using "": UR */
           MANDOCERR_EQN_NOBOX, /* missing eqn box, using "": op */
   
         /* related to bad macro arguments */          /* related to bad arguments */
         MANDOCERR_IGNARGV, /* skipping argument */          MANDOCERR_ARG_QUOTE, /* unterminated quoted argument */
         MANDOCERR_ARGVREP, /* duplicate argument */          MANDOCERR_ARG_REP, /* duplicate argument: macro arg */
         MANDOCERR_DISPREP, /* duplicate display type */          MANDOCERR_AN_REP, /* skipping duplicate argument: An -arg */
         MANDOCERR_LISTREP, /* duplicate list type */          MANDOCERR_BD_REP, /* skipping duplicate display type: Bd -type */
         MANDOCERR_BADATT, /* unknown AT&T UNIX version */          MANDOCERR_BL_REP, /* skipping duplicate list type: Bl -type */
         MANDOCERR_BADBOOL, /* bad Boolean value */          MANDOCERR_BL_SKIPW, /* skipping -width argument: Bl -type */
         MANDOCERR_BADFONT, /* unknown font */          MANDOCERR_BL_COL, /* wrong number of cells */
         MANDOCERR_BADSTANDARD, /* unknown standard specifier */          MANDOCERR_AT_BAD, /* unknown AT&T UNIX version: At version */
         MANDOCERR_BADWIDTH, /* bad width argument */          MANDOCERR_FA_COMMA, /* comma in function argument: arg */
           MANDOCERR_FN_PAREN, /* parenthesis in function name: arg */
           MANDOCERR_RS_BAD, /* invalid content in Rs block: macro */
           MANDOCERR_SM_BAD, /* invalid Boolean argument: macro arg */
           MANDOCERR_FT_BAD, /* unknown font, skipping request: ft font */
           MANDOCERR_TR_ODD, /* odd number of characters in request: tr char */
   
         /* related to plain text */          /* related to plain text */
         MANDOCERR_NOBLANKLN, /* blank line in non-literal context */          MANDOCERR_FI_BLANK, /* blank line in fill mode, using .sp */
         MANDOCERR_BADTAB, /* tab in non-literal context */          MANDOCERR_FI_TAB, /* tab in filled text */
         MANDOCERR_EOLNSPACE, /* end of line whitespace */          MANDOCERR_SPACE_EOL, /* whitespace at end of input line */
         MANDOCERR_BADCOMMENT, /* bad comment style */          MANDOCERR_EOS, /* new sentence, new line */
         MANDOCERR_BADESCAPE, /* unknown escape sequence */          MANDOCERR_COMMENT_BAD, /* bad comment style */
         MANDOCERR_BADQUOTE, /* unterminated quoted string */          MANDOCERR_ESC_BAD, /* invalid escape sequence: esc */
           MANDOCERR_STR_UNDEF, /* undefined string, using "": name */
   
           /* related to tables */
           MANDOCERR_TBLLAYOUT_SPAN, /* tbl line starts with span */
           MANDOCERR_TBLLAYOUT_DOWN, /* tbl column starts with span */
           MANDOCERR_TBLLAYOUT_VERT, /* skipping vertical bar in tbl layout */
   
         MANDOCERR_ERROR, /* ===== start of errors ===== */          MANDOCERR_ERROR, /* ===== start of errors ===== */
   
         MANDOCERR_TBL, /* bad table syntax */          /* related to tables */
         MANDOCERR_TBLOPT, /* bad table option */          MANDOCERR_TBLOPT_ALPHA, /* non-alphabetic character in tbl options */
         MANDOCERR_TBLLAYOUT, /* bad table layout */          MANDOCERR_TBLOPT_BAD, /* skipping unknown tbl option: option */
         MANDOCERR_TBLNOLAYOUT, /* no table layout cells specified */          MANDOCERR_TBLOPT_NOARG, /* missing tbl option argument: option */
           MANDOCERR_TBLOPT_ARGSZ, /* wrong tbl option argument size: option */
           MANDOCERR_TBLLAYOUT_NONE, /* empty tbl layout */
           MANDOCERR_TBLLAYOUT_CHAR, /* invalid character in tbl layout: char */
           MANDOCERR_TBLLAYOUT_PAR, /* unmatched parenthesis in tbl layout */
           MANDOCERR_TBLDATA_NONE, /* tbl without any data cells */
           MANDOCERR_TBLDATA_SPAN, /* ignoring data in spanned tbl cell: data */
           MANDOCERR_TBLDATA_EXTRA, /* ignoring extra tbl data cells: data */
           MANDOCERR_TBLDATA_BLK, /* data block open at end of tbl: macro */
   
           /* related to document structure and macros */
           MANDOCERR_FILE, /* cannot open file */
         MANDOCERR_ROFFLOOP, /* input stack limit exceeded, infinite loop? */          MANDOCERR_ROFFLOOP, /* input stack limit exceeded, infinite loop? */
         MANDOCERR_BADCHAR, /* skipping bad character */          MANDOCERR_CHAR_BAD, /* skipping bad character: number */
         MANDOCERR_NOTEXT, /* skipping text before the first section header */          MANDOCERR_MACRO, /* skipping unknown macro: macro */
         MANDOCERR_MACRO, /* skipping unknown macro */          MANDOCERR_REQ_INSEC, /* skipping insecure request: request */
         MANDOCERR_REQUEST, /* NOT IMPLEMENTED: skipping request */          MANDOCERR_IT_STRAY, /* skipping item outside list: It ... */
         MANDOCERR_LINESCOPE, /* line scope broken */          MANDOCERR_TA_STRAY, /* skipping column outside column list: Ta */
         MANDOCERR_ARGCOUNT, /* argument count wrong */          MANDOCERR_BLK_NOTOPEN, /* skipping end of block that is not open */
         MANDOCERR_NOSCOPE, /* skipping end of block that is not open */          MANDOCERR_RE_NOTOPEN, /* fewer RS blocks open, skipping: RE arg */
         MANDOCERR_SCOPEBROKEN, /* missing end of block */          MANDOCERR_BLK_BROKEN, /* inserting missing end of block: macro ... */
         MANDOCERR_SCOPEEXIT, /* scope open on exit */          MANDOCERR_BLK_NOEND, /* appending missing end of block: macro */
         MANDOCERR_UNAME, /* uname(3) system call failed */  
         /* FIXME: merge following with MANDOCERR_ARGCOUNT */  
         MANDOCERR_NOARGS, /* macro requires line argument(s) */  
         MANDOCERR_NOBODY, /* macro requires body argument(s) */  
         MANDOCERR_NOARGV, /* macro requires argument(s) */  
         MANDOCERR_LISTTYPE, /* missing list type */  
         MANDOCERR_ARGSLOST, /* line argument(s) will be lost */  
         MANDOCERR_BODYLOST, /* body argument(s) will be lost */  
   
         MANDOCERR_FATAL, /* ===== start of fatal errors ===== */          /* related to request and macro arguments */
           MANDOCERR_NAMESC, /* escaped character not allowed in a name: name */
           MANDOCERR_BD_FILE, /* NOT IMPLEMENTED: Bd -file */
           MANDOCERR_BD_NOARG, /* skipping display without arguments: Bd */
           MANDOCERR_BL_NOTYPE, /* missing list type, using -item: Bl */
           MANDOCERR_NM_NONAME, /* missing manual name, using "": Nm */
           MANDOCERR_OS_UNAME, /* uname(3) system call failed, using UNKNOWN */
           MANDOCERR_ST_BAD, /* unknown standard specifier: St standard */
           MANDOCERR_IT_NONUM, /* skipping request without numeric argument */
           MANDOCERR_SO_PATH, /* NOT IMPLEMENTED: .so with absolute path or ".." */
           MANDOCERR_SO_FAIL, /* .so request failed */
           MANDOCERR_ARG_SKIP, /* skipping all arguments: macro args */
           MANDOCERR_ARG_EXCESS, /* skipping excess arguments: macro ... args */
           MANDOCERR_DIVZERO, /* divide by zero */
   
         MANDOCERR_COLUMNS, /* column syntax is inconsistent */          MANDOCERR_UNSUPP, /* ===== start of unsupported features ===== */
         MANDOCERR_BADDISP, /* NOT IMPLEMENTED: .Bd -file */  
         MANDOCERR_SYNTLINESCOPE, /* line scope broken, syntax violated */          MANDOCERR_TOOLARGE, /* input too large */
         MANDOCERR_SYNTARGVCOUNT, /* argument count wrong, violates syntax */          MANDOCERR_CHAR_UNSUPP, /* unsupported control character: number */
         MANDOCERR_SYNTCHILD, /* child violates parent syntax */          MANDOCERR_REQ_UNSUPP, /* unsupported roff request: request */
         MANDOCERR_SYNTARGCOUNT, /* argument count wrong, violates syntax */          MANDOCERR_TBLOPT_EQN, /* eqn delim option in tbl: arg */
         MANDOCERR_SOPATH, /* NOT IMPLEMENTED: .so with absolute path or ".." */          MANDOCERR_TBLLAYOUT_MOD, /* unsupported tbl layout modifier: m */
         MANDOCERR_NODOCBODY, /* no document body */          MANDOCERR_TBLMACRO, /* ignoring macro in table: macro */
         MANDOCERR_NODOCPROLOG, /* no document prologue */  
         MANDOCERR_MEM, /* static buffer exhausted */  
         MANDOCERR_MAX          MANDOCERR_MAX
 };  };
   
   struct  tbl_opts {
           char              tab; /* cell-separator */
           char              decimal; /* decimal point */
           int               opts;
   #define TBL_OPT_CENTRE   (1 << 0)
   #define TBL_OPT_EXPAND   (1 << 1)
   #define TBL_OPT_BOX      (1 << 2)
   #define TBL_OPT_DBOX     (1 << 3)
   #define TBL_OPT_ALLBOX   (1 << 4)
   #define TBL_OPT_NOKEEP   (1 << 5)
   #define TBL_OPT_NOSPACE  (1 << 6)
   #define TBL_OPT_NOWARN   (1 << 7)
           int               cols; /* number of columns */
           int               lvert; /* width of left vertical line */
           int               rvert; /* width of right vertical line */
   };
   
 enum    tbl_cellt {  enum    tbl_cellt {
         TBL_CELL_CENTRE, /* c, C */          TBL_CELL_CENTRE, /* c, C */
         TBL_CELL_RIGHT, /* r, R */          TBL_CELL_RIGHT, /* r, R */
Line 149  enum tbl_cellt {
Line 234  enum tbl_cellt {
         TBL_CELL_DOWN, /* ^ */          TBL_CELL_DOWN, /* ^ */
         TBL_CELL_HORIZ, /* _, - */          TBL_CELL_HORIZ, /* _, - */
         TBL_CELL_DHORIZ, /* = */          TBL_CELL_DHORIZ, /* = */
         TBL_CELL_VERT, /* | */  
         TBL_CELL_DVERT, /* || */  
         TBL_CELL_MAX          TBL_CELL_MAX
 };  };
   
Line 159  enum tbl_cellt {
Line 242  enum tbl_cellt {
  */   */
 struct  tbl_cell {  struct  tbl_cell {
         struct tbl_cell  *next;          struct tbl_cell  *next;
           int               vert; /* width of subsequent vertical line */
         enum tbl_cellt    pos;          enum tbl_cellt    pos;
         int               spacing;          size_t            spacing;
           int               col; /* column number, starting from 0 */
         int               flags;          int               flags;
 #define TBL_CELL_TALIGN  (1 << 0) /* t, T */  #define TBL_CELL_TALIGN  (1 << 0) /* t, T */
 #define TBL_CELL_BALIGN  (1 << 1) /* d, D */  #define TBL_CELL_BALIGN  (1 << 1) /* d, D */
Line 169  struct tbl_cell {
Line 254  struct tbl_cell {
 #define TBL_CELL_EQUAL   (1 << 4) /* e, E */  #define TBL_CELL_EQUAL   (1 << 4) /* e, E */
 #define TBL_CELL_UP      (1 << 5) /* u, U */  #define TBL_CELL_UP      (1 << 5) /* u, U */
 #define TBL_CELL_WIGN    (1 << 6) /* z, Z */  #define TBL_CELL_WIGN    (1 << 6) /* z, Z */
   #define TBL_CELL_WMAX    (1 << 7) /* x, X */
 };  };
   
 /*  /*
Line 178  struct tbl_row {
Line 264  struct tbl_row {
         struct tbl_row   *next;          struct tbl_row   *next;
         struct tbl_cell  *first;          struct tbl_cell  *first;
         struct tbl_cell  *last;          struct tbl_cell  *last;
           int               vert; /* width of left vertical line */
 };  };
   
   enum    tbl_datt {
           TBL_DATA_NONE, /* has no data */
           TBL_DATA_DATA, /* consists of data/string */
           TBL_DATA_HORIZ, /* horizontal line */
           TBL_DATA_DHORIZ, /* double-horizontal line */
           TBL_DATA_NHORIZ, /* squeezed horizontal line */
           TBL_DATA_NDHORIZ /* squeezed double-horizontal line */
   };
   
 /*  /*
  * A cell within a row of data.  The "string" field contains the actual   * A cell within a row of data.  The "string" field contains the actual
  * string value that's in the cell.  The rest is layout.   * string value that's in the cell.  The rest is layout.
  */   */
 struct  tbl_dat {  struct  tbl_dat {
         struct tbl_cell  *layout; /* layout cell: CAN BE NULL */          struct tbl_cell  *layout; /* layout cell */
           int               spans; /* how many spans follow */
         struct tbl_dat   *next;          struct tbl_dat   *next;
         char             *string;          char             *string; /* data (NULL if not TBL_DATA_DATA) */
         int               flags;          enum tbl_datt     pos;
 #define TBL_DATA_HORIZ   (1 << 0)  
 #define TBL_DATA_DHORIZ  (1 << 1)  
 #define TBL_DATA_NHORIZ  (1 << 2)  
 #define TBL_DATA_NDHORIZ (1 << 3)  
 };  };
   
   enum    tbl_spant {
           TBL_SPAN_DATA, /* span consists of data */
           TBL_SPAN_HORIZ, /* span is horizontal line */
           TBL_SPAN_DHORIZ /* span is double horizontal line */
   };
   
 /*  /*
  * A row of data in a table.   * A row of data in a table.
  */   */
 struct  tbl_span {  struct  tbl_span {
         struct tbl_row   *layout; /* layout row: CAN BE NULL */          struct tbl_opts  *opts;
           struct tbl_row   *layout; /* layout row */
         struct tbl_dat   *first;          struct tbl_dat   *first;
         struct tbl_dat   *last;          struct tbl_dat   *last;
         int               flags;          struct tbl_span  *prev;
 #define TBL_SPAN_HORIZ  (1 << 0)  
 #define TBL_SPAN_DHORIZ (1 << 1)  
         struct tbl_span  *next;          struct tbl_span  *next;
           int               line; /* parse line */
           enum tbl_spant    pos;
 };  };
   
 /*  enum    eqn_boxt {
  * Available registers (set in libroff, accessed elsewhere).          EQN_ROOT, /* root of parse tree */
  */          EQN_TEXT, /* text (number, variable, whatever) */
 enum    regs {          EQN_SUBEXPR, /* nested `eqn' subexpression */
         REG_nS = 0,          EQN_LIST, /* list (braces, etc.) */
         REG__MAX          EQN_LISTONE, /* singleton list */
           EQN_PILE, /* vertical pile */
           EQN_MATRIX /* pile of piles */
 };  };
   
 /*  enum    eqn_fontt {
  * A register (struct reg) can consist of many types: this consists of          EQNFONT_NONE = 0,
  * normalised types from the original string form.          EQNFONT_ROMAN,
           EQNFONT_BOLD,
           EQNFONT_FAT,
           EQNFONT_ITALIC,
           EQNFONT__MAX
   };
   
   enum    eqn_post {
           EQNPOS_NONE = 0,
           EQNPOS_SUP,
           EQNPOS_SUBSUP,
           EQNPOS_SUB,
           EQNPOS_TO,
           EQNPOS_FROM,
           EQNPOS_FROMTO,
           EQNPOS_OVER,
           EQNPOS_SQRT,
           EQNPOS__MAX
   };
   
   enum    eqn_pilet {
           EQNPILE_NONE = 0,
           EQNPILE_PILE,
           EQNPILE_CPILE,
           EQNPILE_RPILE,
           EQNPILE_LPILE,
           EQNPILE_COL,
           EQNPILE_CCOL,
           EQNPILE_RCOL,
           EQNPILE_LCOL,
           EQNPILE__MAX
   };
   
    /*
    * A "box" is a parsed mathematical expression as defined by the eqn.7
    * grammar.
  */   */
 union   regval {  struct  eqn_box {
         unsigned  u; /* unsigned integer */          int               size; /* font size of expression */
   #define EQN_DEFSIZE       INT_MIN
           enum eqn_boxt     type; /* type of node */
           struct eqn_box   *first; /* first child node */
           struct eqn_box   *last; /* last child node */
           struct eqn_box   *next; /* node sibling */
           struct eqn_box   *prev; /* node sibling */
           struct eqn_box   *parent; /* node sibling */
           char             *text; /* text (or NULL) */
           char             *left; /* fence left-hand */
           char             *right; /* fence right-hand */
           char             *top; /* expression over-symbol */
           char             *bottom; /* expression under-symbol */
           size_t            args; /* arguments in parent */
           size_t            expectargs; /* max arguments in parent */
           enum eqn_post     pos; /* position of next box */
           enum eqn_fontt    font; /* font of box */
           enum eqn_pilet    pile; /* equation piling */
 };  };
   
 /*  /*
  * A single register entity.  If "set" is zero, the value of the   * An equation consists of a tree of expressions starting at a given
  * register should be the default one, which is per-register.  It's   * line and position.
  * assumed that callers know which type in "v" corresponds to which  
  * register value.  
  */   */
 struct  reg {  struct  eqn {
         int               set; /* whether set or not */          char             *name; /* identifier (or NULL) */
         union regval      v; /* parsed data */          struct eqn_box   *root; /* root mathematical expression */
           int               ln; /* invocation line */
           int               pos; /* invocation position */
 };  };
   
 /*  /*
  * The primary interface to setting register values is in libroff,   * Parse options.
  * although libmdoc and libman from time to time will manipulate  
  * registers (such as `.Sh SYNOPSIS' enabling REG_nS).  
  */   */
 struct  regset {  #define MPARSE_MDOC     1  /* assume -mdoc */
         struct reg        regs[REG__MAX];  #define MPARSE_MAN      2  /* assume -man */
   #define MPARSE_SO       4  /* honour .so requests */
   #define MPARSE_QUICK    8  /* abort the parse early */
   #define MPARSE_UTF8     16 /* accept UTF-8 input */
   #define MPARSE_LATIN1   32 /* accept ISO-LATIN-1 input */
   
   enum    mandoc_esc {
           ESCAPE_ERROR = 0, /* bail! unparsable escape */
           ESCAPE_IGNORE, /* escape to be ignored */
           ESCAPE_SPECIAL, /* a regular special character */
           ESCAPE_FONT, /* a generic font mode */
           ESCAPE_FONTBOLD, /* bold font mode */
           ESCAPE_FONTITALIC, /* italic font mode */
           ESCAPE_FONTBI, /* bold italic font mode */
           ESCAPE_FONTROMAN, /* roman font mode */
           ESCAPE_FONTPREV, /* previous font mode */
           ESCAPE_NUMBERED, /* a numbered glyph */
           ESCAPE_UNICODE, /* a unicode codepoint */
           ESCAPE_NOSPACE, /* suppress space if the last on a line */
           ESCAPE_HORIZ, /* horizontal movement */
           ESCAPE_HLINE, /* horizontal line drawing */
           ESCAPE_SKIPCHAR, /* skip the next character */
           ESCAPE_OVERSTRIKE /* overstrike all chars in the argument */
 };  };
   
 __BEGIN_DECLS  typedef void    (*mandocmsg)(enum mandocerr, enum mandoclevel,
                           const char *, int, int, const char *);
   
 /*  
  * Callback function for warnings, errors, and fatal errors as they  
  * occur in the compilers libroff, libmdoc, and libman.  
  */  
 typedef int             (*mandocmsg)(enum mandocerr, void *,  
                                 int, int, const char *);  
   
 __END_DECLS  struct  mparse;
   struct  roff_man;
   
 #endif /*!MANDOC_H*/  enum mandoc_esc   mandoc_escape(const char **, const char **, int *);
   void              mchars_alloc(void);
   void              mchars_free(void);
   int               mchars_num2char(const char *, size_t);
   const char       *mchars_uc2str(int);
   int               mchars_num2uc(const char *, size_t);
   int               mchars_spec2cp(const char *, size_t);
   const char       *mchars_spec2str(const char *, size_t, size_t *);
   struct mparse    *mparse_alloc(int, enum mandoclevel, mandocmsg, const char *);
   void              mparse_free(struct mparse *);
   void              mparse_keep(struct mparse *);
   int               mparse_open(struct mparse *, const char *);
   enum mandoclevel  mparse_readfd(struct mparse *, int, const char *);
   enum mandoclevel  mparse_readmem(struct mparse *, void *, size_t,
                           const char *);
   void              mparse_reset(struct mparse *);
   void              mparse_result(struct mparse *,
                           struct roff_man **, char **);
   const char       *mparse_getkeep(const struct mparse *);
   const char       *mparse_strerror(enum mandocerr);
   const char       *mparse_strlevel(enum mandoclevel);
   void              mparse_updaterc(struct mparse *, enum mandoclevel *);
Legend:
Removed from v.1.38  
changed lines
  Added in v.1.222
CVSweb