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

Diff for /mandoc/mandoc.h between version 1.28 and 1.256

version 1.28, 2010/12/05 15:49:37 version 1.256, 2018/12/12 21:54:35
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, 2012-2018 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_BASE, /* ===== start of base system conventions ===== */
   
           MANDOCERR_MDOCDATE, /* Mdocdate found: Dd ... */
           MANDOCERR_MDOCDATE_MISSING, /* Mdocdate missing: Dd ... */
           MANDOCERR_ARCH_BAD,  /* unknown architecture: Dt ... arch */
           MANDOCERR_OS_ARG,  /* operating system explicitly specified: Os ... */
           MANDOCERR_RCS_MISSING, /* RCS id missing */
           MANDOCERR_XR_BAD,  /* referenced manual not found: Xr name sec */
   
           MANDOCERR_STYLE, /* ===== start of style suggestions ===== */
   
           MANDOCERR_DATE_LEGACY, /* legacy man(7) date format: Dd ... */
           MANDOCERR_DATE_NORM, /* normalizing date format to: ... */
           MANDOCERR_TITLE_CASE, /* lower case character in document title */
           MANDOCERR_RCS_REP, /* duplicate RCS id: ... */
           MANDOCERR_SEC_TYPO,  /* possible typo in section name: Sh ... */
           MANDOCERR_ARG_QUOTE, /* unterminated quoted argument */
           MANDOCERR_MACRO_USELESS, /* useless macro: macro */
           MANDOCERR_BX, /* consider using OS macro: macro */
           MANDOCERR_ER_ORDER, /* errnos out of order: Er ... */
           MANDOCERR_ER_REP, /* duplicate errno: Er ... */
           MANDOCERR_DELIM, /* trailing delimiter: macro ... */
           MANDOCERR_DELIM_NB, /* no blank before trailing delimiter: macro ... */
           MANDOCERR_FI_SKIP, /* fill mode already enabled, skipping: fi */
           MANDOCERR_NF_SKIP, /* fill mode already disabled, skipping: nf */
           MANDOCERR_DASHDASH, /* verbatim "--", maybe consider using \(em */
           MANDOCERR_FUNC, /* function name without markup: name() */
           MANDOCERR_SPACE_EOL, /* whitespace at end of input line */
           MANDOCERR_COMMENT_BAD, /* bad comment style */
   
         MANDOCERR_WARNING, /* ===== start of warnings ===== */          MANDOCERR_WARNING, /* ===== start of warnings ===== */
         MANDOCERR_SO, /* .so is fragile, better use ln(1) */  
         MANDOCERR_UPPERCASE, /* text should be uppercase */  
         MANDOCERR_SECOOO, /* sections out of conventional order */  
         MANDOCERR_SECREP, /* section name repeats */  
         MANDOCERR_PROLOGOOO, /* out of order prologue */  
         MANDOCERR_PROLOGREP, /* repeated prologue entry */  
         MANDOCERR_LISTFIRST, /* list type must come first */  
         MANDOCERR_BADTAB, /* tab in non-literal context */  
         MANDOCERR_BADESCAPE, /* bad escape sequence */  
         MANDOCERR_BADQUOTE, /* unterminated quoted string */  
         MANDOCERR_NOWIDTHARG, /* argument requires the width argument */  
         /* FIXME: merge with MANDOCERR_IGNARGV. */  
         MANDOCERR_WIDTHARG, /* superfluous width argument */  
         MANDOCERR_BADDATE, /* bad date argument */  
         MANDOCERR_BADWIDTH, /* bad width argument */  
         MANDOCERR_BADMSEC, /* unknown manual section */  
         MANDOCERR_SECMSEC, /* section not in conventional manual section */  
         MANDOCERR_EOLNSPACE, /* end of line whitespace */  
         MANDOCERR_SCOPENEST, /* blocks badly nested */  
   
           /* related to the prologue */
           MANDOCERR_DT_NOTITLE, /* missing manual title, using UNTITLED: line */
           MANDOCERR_TH_NOTITLE, /* missing manual title, using "": [macro] */
           MANDOCERR_MSEC_MISSING, /* missing manual section, using "": macro */
           MANDOCERR_MSEC_BAD, /* unknown manual section: Dt ... section */
           MANDOCERR_DATE_MISSING, /* missing date, using today's date */
           MANDOCERR_DATE_BAD, /* cannot parse date, using it verbatim: date */
           MANDOCERR_DATE_FUTURE, /* date in the future, using it anyway: date */
           MANDOCERR_OS_MISSING, /* missing Os macro, using "" */
           MANDOCERR_PROLOG_LATE, /* late prologue macro: macro */
           MANDOCERR_PROLOG_ORDER, /* prologue macros out of order: macros */
   
           /* related to document structure */
           MANDOCERR_SO, /* .so is fragile, better use ln(1): so path */
           MANDOCERR_DOC_EMPTY, /* no document body */
           MANDOCERR_SEC_BEFORE, /* content before first section header: macro */
           MANDOCERR_NAMESEC_FIRST, /* first section is not NAME: Sh title */
           MANDOCERR_NAMESEC_NONM, /* NAME section without Nm before Nd */
           MANDOCERR_NAMESEC_NOND, /* NAME section without description */
           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_SELF,  /* cross reference to self: Xr name sec */
           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 */
           MANDOCERR_MACRO_OBS, /* obsolete macro: macro */
           MANDOCERR_MACRO_CALL, /* macro neither callable nor escaped: macro */
           MANDOCERR_PAR_SKIP, /* skipping paragraph macro: macro ... */
           MANDOCERR_PAR_MOVE, /* moving paragraph macro out of list: macro */
           MANDOCERR_NS_SKIP, /* skipping no-space macro */
           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_TA_LINE, /* first macro on line: Ta */
           MANDOCERR_BLK_LINE, /* line scope broken: macro breaks macro */
           MANDOCERR_BLK_BLANK, /* skipping blank line in line scope */
   
           /* related to missing arguments */
           MANDOCERR_REQ_EMPTY, /* skipping empty request: request */
           MANDOCERR_COND_EMPTY, /* conditional request controls empty scope */
           MANDOCERR_MACRO_EMPTY, /* skipping empty macro: macro */
           MANDOCERR_BLK_EMPTY, /* empty block: macro */
           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_IT_NOARG, /* missing argument, using next line: Bl -c 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 arguments */
           MANDOCERR_ARG_REP, /* duplicate argument: macro arg */
           MANDOCERR_AN_REP, /* skipping duplicate argument: An -arg */
           MANDOCERR_BD_REP, /* skipping duplicate display type: Bd -type */
           MANDOCERR_BL_REP, /* skipping duplicate list type: Bl -type */
           MANDOCERR_BL_SKIPW, /* skipping -width argument: Bl -type */
           MANDOCERR_BL_COL, /* wrong number of cells */
           MANDOCERR_AT_BAD, /* unknown AT&T UNIX version: At version */
           MANDOCERR_FA_COMMA, /* comma in function argument: arg */
           MANDOCERR_FN_PAREN, /* parenthesis in function name: arg */
           MANDOCERR_LB_BAD, /* unknown library name: Lb ... */
           MANDOCERR_RS_BAD, /* invalid content in Rs block: macro */
           MANDOCERR_SM_BAD, /* invalid Boolean argument: macro arg */
           MANDOCERR_CHAR_FONT, /* argument contains two font escapes */
           MANDOCERR_FT_BAD, /* unknown font, skipping request: ft font */
           MANDOCERR_TR_ODD, /* odd number of characters in request: tr char */
   
           /* related to plain text */
           MANDOCERR_FI_BLANK, /* blank line in fill mode, using .sp */
           MANDOCERR_FI_TAB, /* tab in filled text */
           MANDOCERR_EOS, /* new sentence, new line */
           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_NAMESECFIRST, /* NAME section must come first */  
         MANDOCERR_BADBOOL, /* bad Boolean value */  
         MANDOCERR_CHILD, /* child violates parent syntax */  
         MANDOCERR_NESTEDDISP, /* displays may not be nested */  
         MANDOCERR_BADATT, /* bad AT&T symbol */  
         MANDOCERR_BADSTANDARD, /* bad standard */  
         MANDOCERR_LISTREP, /* list type repeated */  
         MANDOCERR_DISPREP, /* display type repeated */  
         MANDOCERR_ARGVREP, /* argument repeated */  
         MANDOCERR_IGNARGV, /* ignoring argument */  
         MANDOCERR_NONAME, /* manual name not yet set */  
         MANDOCERR_MACROOBS, /* obsolete macro ignored */  
         MANDOCERR_MACROEMPTY, /* empty macro ignored */  
         MANDOCERR_BADBODY, /* macro not allowed in body */  
         MANDOCERR_BADPROLOG, /* macro not allowed in prologue */  
         MANDOCERR_BADCHAR, /* bad character */  
         MANDOCERR_BADNAMESEC, /* bad NAME section contents */  
         MANDOCERR_NOBLANKLN, /* no blank lines */  
         MANDOCERR_NOTEXT, /* no text in this context */  
         MANDOCERR_BADCOMMENT, /* bad comment style */  
         MANDOCERR_MACRO, /* unknown macro will be lost */  
         MANDOCERR_REQUEST, /* NOT IMPLEMENTED: skipping request */  
         MANDOCERR_LINESCOPE, /* line scope broken */  
         MANDOCERR_ARGCOUNT, /* argument count wrong */  
         MANDOCERR_NOSCOPE, /* no such block is open */  
         MANDOCERR_SCOPEREP, /* scope already open */  
         MANDOCERR_SCOPEEXIT, /* scope open on exit */  
         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_NOTITLE, /* no title in document */  
         MANDOCERR_LISTTYPE, /* missing list type */  
         MANDOCERR_DISPTYPE, /* missing display type */  
         MANDOCERR_FONTTYPE, /* missing font type */  
         MANDOCERR_ARGSLOST, /* line argument(s) will be lost */  
         MANDOCERR_BODYLOST, /* body argument(s) will be lost */  
         MANDOCERR_IGNPAR, /* paragraph macro ignored */  
   
         MANDOCERR_FATAL, /* ===== start of fatal errors ===== */          /* related to tables */
         MANDOCERR_COLUMNS, /* column syntax is inconsistent */          MANDOCERR_TBLOPT_ALPHA, /* non-alphabetic character in tbl options */
         MANDOCERR_BADDISP, /* unsupported display type */          MANDOCERR_TBLOPT_BAD, /* skipping unknown tbl option: option */
         MANDOCERR_SCOPEFATAL, /* blocks badly nested */          MANDOCERR_TBLOPT_NOARG, /* missing tbl option argument: option */
         MANDOCERR_SYNTNOSCOPE, /* no scope to rewind: syntax violated */          MANDOCERR_TBLOPT_ARGSZ, /* wrong tbl option argument size: option */
         MANDOCERR_SYNTLINESCOPE, /* line scope broken, syntax violated */          MANDOCERR_TBLLAYOUT_NONE, /* empty tbl layout */
         MANDOCERR_SYNTARGVCOUNT, /* argument count wrong, violates syntax */          MANDOCERR_TBLLAYOUT_CHAR, /* invalid character in tbl layout: char */
         MANDOCERR_SYNTCHILD, /* child violates parent syntax */          MANDOCERR_TBLLAYOUT_PAR, /* unmatched parenthesis in tbl layout */
         MANDOCERR_SYNTARGCOUNT, /* argument count wrong, violates syntax */          MANDOCERR_TBLDATA_NONE, /* tbl without any data cells */
         MANDOCERR_SOPATH, /* NOT IMPLEMENTED: .so with absolute path or ".." */          MANDOCERR_TBLDATA_SPAN, /* ignoring data in spanned tbl cell: data */
         MANDOCERR_NODOCBODY, /* no document body */          MANDOCERR_TBLDATA_EXTRA, /* ignoring extra tbl data cells: data */
         MANDOCERR_NODOCPROLOG, /* no document prologue */          MANDOCERR_TBLDATA_BLK, /* data block open at end of tbl: macro */
         MANDOCERR_MEM, /* static buffer exhausted */  
           /* related to document structure and macros */
           MANDOCERR_FILE, /* cannot open file */
           MANDOCERR_PROLOG_REP, /* duplicate prologue macro: macro */
           MANDOCERR_DT_LATE, /* skipping late title macro: Dt args */
           MANDOCERR_ROFFLOOP, /* input stack limit exceeded, infinite loop? */
           MANDOCERR_CHAR_BAD, /* skipping bad character: number */
           MANDOCERR_MACRO, /* skipping unknown macro: macro */
           MANDOCERR_REQ_NOMAC, /* skipping request outside macro: ... */
           MANDOCERR_REQ_INSEC, /* skipping insecure request: request */
           MANDOCERR_IT_STRAY, /* skipping item outside list: It ... */
           MANDOCERR_TA_STRAY, /* skipping column outside column list: Ta */
           MANDOCERR_BLK_NOTOPEN, /* skipping end of block that is not open */
           MANDOCERR_RE_NOTOPEN, /* fewer RS blocks open, skipping: RE arg */
           MANDOCERR_BLK_BROKEN, /* inserting missing end of block: macro ... */
           MANDOCERR_BLK_NOEND, /* appending missing end of block: macro */
   
           /* related to request and macro arguments */
           MANDOCERR_NAMESC, /* escaped character not allowed in a name: name */
           MANDOCERR_ARG_UNDEF, /* using macro argument outside macro */
           MANDOCERR_ARG_NONUM, /* argument number is not numeric */
           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_CE_NONUM, /* argument is not numeric, using 1: ce ... */
           MANDOCERR_CHAR_ARG, /* argument is not a character: char ... */
           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_SHIFT, /* excessive shift: ..., but max is ... */
           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_UNSUPP, /* ===== start of unsupported features ===== */
   
           MANDOCERR_TOOLARGE, /* input too large */
           MANDOCERR_CHAR_UNSUPP, /* unsupported control character: number */
           MANDOCERR_REQ_UNSUPP, /* unsupported roff request: request */
           MANDOCERR_WHILE_NEST, /* nested .while loops */
           MANDOCERR_WHILE_OUTOF, /* end of scope with open .while loop */
           MANDOCERR_WHILE_INTO, /* end of .while loop in inner scope */
           MANDOCERR_WHILE_FAIL, /* cannot continue this .while loop */
           MANDOCERR_TBLOPT_EQN, /* eqn delim option in tbl: arg */
           MANDOCERR_TBLLAYOUT_MOD, /* unsupported tbl layout modifier: m */
           MANDOCERR_TBLMACRO, /* ignoring macro in table: macro */
   
         MANDOCERR_MAX          MANDOCERR_MAX
 };  };
   
 /*  enum    eqn_boxt {
  * Available registers (set in libroff, accessed elsewhere).          EQN_TEXT, /* text (number, variable, whatever) */
  */          EQN_SUBEXPR, /* nested `eqn' subexpression */
 enum    regs {          EQN_LIST, /* list (braces, etc.) */
         REG_nS = 0,          EQN_PILE, /* vertical pile */
         REG__MAX          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,
 union   regval {          EQNFONT_FAT,
         unsigned  u; /* unsigned integer */          EQNFONT_ITALIC,
           EQNFONT__MAX
 };  };
   
 /*  enum    eqn_post {
  * A single register entity.  If "set" is zero, the value of the          EQNPOS_NONE = 0,
  * register should be the default one, which is per-register.  It's          EQNPOS_SUP,
  * assumed that callers know which type in "v" corresponds to which          EQNPOS_SUBSUP,
  * register value.          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.
  */   */
 struct  reg {  struct  eqn_box {
         int               set; /* whether set or not */          int               size; /* font size of expression */
         union regval      v; /* parsed data */  #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 */
 };  };
   
 /*  /*
  * 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_os {
           MANDOC_OS_OTHER = 0,
           MANDOC_OS_NETBSD,
           MANDOC_OS_OPENBSD
 };  };
   
 __BEGIN_DECLS  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_FONTCW, /* constant width font mode */
           ESCAPE_FONTPREV, /* previous font mode */
           ESCAPE_NUMBERED, /* a numbered glyph */
           ESCAPE_UNICODE, /* a unicode codepoint */
           ESCAPE_DEVICE, /* print the output device name */
           ESCAPE_BREAK, /* break the output line */
           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 */
   };
   
 /*  typedef void    (*mandocmsg)(enum mandocerr, enum mandoclevel,
  * Callback function for warnings, errors, and fatal errors as they                          const char *, int, int, const char *);
  * occur in the compilers libroff, libmdoc, and libman.  
  */  
 typedef int             (*mandocmsg)(enum mandocerr, void *,  
                                 int, int, const char *);  
   
 __END_DECLS  
   
 #endif /*!MANDOC_H*/  struct  mparse;
   struct  roff_man;
   
   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 mandocerr, mandocmsg,
                           enum mandoc_os, const char *);
   void              mparse_free(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 **);
   void              mparse_copy(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.28  
changed lines
  Added in v.1.256
CVSweb