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

Diff for /mandoc/mandoc.h between version 1.24 and 1.174

version 1.24, 2010/11/29 15:45:15 version 1.174, 2014/12/01 04:05:32
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-2014 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
Line 14 
Line 15 
  * 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 45  enum mandocerr {
Line 45  enum mandocerr {
         MANDOCERR_OK,          MANDOCERR_OK,
   
         MANDOCERR_WARNING, /* ===== start of warnings ===== */          MANDOCERR_WARNING, /* ===== start of warnings ===== */
         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_TITLE_CASE, /* lower case character in document title */
           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_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 */
           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_BAD, /* bad NAME section contents: macro */
           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 */
           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_VT_CHILD, /* .Vt block has child macro: 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 */
   
           /* 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_ARG_EMPTY, /* empty argument, using 0n: macro arg */
           MANDOCERR_ARGCWARN, /* argument count wrong */
           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 8n */
           MANDOCERR_EX_NONAME, /* missing utility name, using "": Ex */
           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_ARG_STD, /* missing -std argument, adding it: macro */
           MANDOCERR_EQN_NOBOX, /* missing eqn box, using "": op */
   
           /* related to bad arguments */
           MANDOCERR_ARG_QUOTE, /* unterminated quoted argument */
           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_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_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 */
   
           /* related to plain text */
           MANDOCERR_FI_BLANK, /* blank line in fill mode, using .sp */
           MANDOCERR_FI_TAB, /* tab in filled text */
           MANDOCERR_SPACE_EOL, /* whitespace at end of input line */
           MANDOCERR_COMMENT_BAD, /* bad comment style */
           MANDOCERR_ESC_BAD, /* invalid escape sequence: esc */
           MANDOCERR_STR_UNDEF, /* undefined string, using "": name */
   
         MANDOCERR_ERROR, /* ===== start of errors ===== */          MANDOCERR_ERROR, /* ===== start of errors ===== */
         MANDOCERR_NAMESECFIRST, /* NAME section must come first */  
         MANDOCERR_BADBOOL, /* bad Boolean value */          /* related to equations */
         MANDOCERR_CHILD, /* child violates parent syntax */          MANDOCERR_EQNNSCOPE, /* unexpected equation scope closure*/
         MANDOCERR_BADATT, /* bad AT&T symbol */          MANDOCERR_EQNSCOPE, /* equation scope open on exit */
         MANDOCERR_BADSTANDARD, /* bad standard */          MANDOCERR_EQNBADSCOPE, /* overlapping equation scopes */
         MANDOCERR_LISTREP, /* list type repeated */          MANDOCERR_EQNEOF, /* unexpected end of equation */
         MANDOCERR_DISPREP, /* display type repeated */  
         MANDOCERR_ARGVREP, /* argument repeated */          /* related to tables */
         MANDOCERR_IGNARGV, /* ignoring argument */          MANDOCERR_TBL, /* bad table syntax */
         MANDOCERR_NONAME, /* manual name not yet set */          MANDOCERR_TBLOPT, /* bad table option */
         MANDOCERR_MACROOBS, /* obsolete macro ignored */          MANDOCERR_TBLLAYOUT, /* bad table layout */
         MANDOCERR_MACROEMPTY, /* empty macro ignored */          MANDOCERR_TBLNOLAYOUT, /* no table layout cells specified */
         MANDOCERR_BADBODY, /* macro not allowed in body */          MANDOCERR_TBLNODATA, /* no table data cells specified */
         MANDOCERR_BADPROLOG, /* macro not allowed in prologue */          MANDOCERR_TBLIGNDATA, /* ignore data in cell */
         MANDOCERR_BADCHAR, /* bad character */          MANDOCERR_TBLBLOCK, /* data block still open */
         MANDOCERR_BADNAMESEC, /* bad NAME section contents */          MANDOCERR_TBLEXTRADAT, /* ignoring extra data cells */
         MANDOCERR_NOBLANKLN, /* no blank lines */  
         MANDOCERR_NOTEXT, /* no text in this context */          /* related to document structure and macros */
         MANDOCERR_BADCOMMENT, /* bad comment style */          MANDOCERR_ROFFLOOP, /* input stack limit exceeded, infinite loop? */
         MANDOCERR_MACRO, /* unknown macro will be lost */          MANDOCERR_BADCHAR, /* skipping bad character: number */
         MANDOCERR_LINESCOPE, /* line scope broken */          MANDOCERR_MACRO, /* skipping unknown macro: macro */
           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_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_ARGCOUNT, /* argument count wrong */          MANDOCERR_ARGCOUNT, /* argument count wrong */
         MANDOCERR_NOSCOPE, /* no such block is open */          MANDOCERR_BD_FILE, /* NOT IMPLEMENTED: Bd -file */
         MANDOCERR_SCOPEREP, /* scope already open */          MANDOCERR_BL_NOTYPE, /* missing list type, using -item: Bl */
         MANDOCERR_SCOPEEXIT, /* scope open on exit */          MANDOCERR_NM_NONAME, /* missing manual name, using "": Nm */
         /* FIXME: merge following with MANDOCERR_ARGCOUNT */          MANDOCERR_OS_UNAME, /* uname(3) system call failed, using UNKNOWN */
         MANDOCERR_NOARGS, /* macro requires line argument(s) */          MANDOCERR_ST_BAD, /* unknown standard specifier: St standard */
         MANDOCERR_NOBODY, /* macro requires body argument(s) */          MANDOCERR_IT_NONUM, /* skipping request without numeric argument */
         MANDOCERR_NOARGV, /* macro requires argument(s) */          MANDOCERR_ARG_SKIP, /* skipping all arguments: macro args */
         MANDOCERR_NOTITLE, /* no title in document */          MANDOCERR_ARG_EXCESS, /* skipping excess arguments: macro ... args */
         MANDOCERR_LISTTYPE, /* missing list type */          MANDOCERR_DIVZERO, /* divide by zero */
         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 ===== */          MANDOCERR_FATAL, /* ===== start of fatal errors ===== */
         MANDOCERR_COLUMNS, /* column syntax is inconsistent */  
         /* FIXME: this should be a MANDOCERR_ERROR */          MANDOCERR_TOOLARGE, /* input too large */
         MANDOCERR_NESTEDDISP, /* displays may not be nested */          MANDOCERR_SO_PATH, /* NOT IMPLEMENTED: .so with absolute path or ".." */
         MANDOCERR_BADDISP, /* unsupported display type */          MANDOCERR_SO_FAIL, /* .so request failed */
         MANDOCERR_SCOPEFATAL, /* blocks badly nested */  
         MANDOCERR_SYNTNOSCOPE, /* no scope to rewind: syntax violated */          /* ===== system errors ===== */
         MANDOCERR_SYNTLINESCOPE, /* line scope broken, syntax violated */  
         MANDOCERR_SYNTARGVCOUNT, /* argument count wrong, violates syntax */          MANDOCERR_SYSDUP, /* cannot dup file descriptor */
         MANDOCERR_SYNTCHILD, /* child violates parent syntax */          MANDOCERR_SYSEXEC, /* cannot exec */
         MANDOCERR_SYNTARGCOUNT, /* argument count wrong, violates syntax */          MANDOCERR_SYSEXIT, /* gunzip failed with code */
         MANDOCERR_NODOCBODY, /* no document body */          MANDOCERR_SYSFORK, /* cannot fork */
         MANDOCERR_NODOCPROLOG, /* no document prologue */          MANDOCERR_SYSOPEN, /* cannot open file */
         MANDOCERR_UTSNAME, /* utsname system call failed */          MANDOCERR_SYSPIPE, /* cannot open pipe */
         MANDOCERR_MEM, /* static buffer exhausted */          MANDOCERR_SYSREAD, /* cannot read file */
           MANDOCERR_SYSSIG, /* gunzip died from signal */
           MANDOCERR_SYSSTAT, /* cannot stat file */
           MANDOCERR_SYSWAIT, /* wait failed */
   
         MANDOCERR_MAX          MANDOCERR_MAX
 };  };
   
   struct  tbl_opts {
           char              tab; /* cell-separator */
           char              decimal; /* decimal point */
           int               linesize;
           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)
           int               cols; /* number of columns */
   };
   
 /*  /*
  * Available registers (set in libroff, accessed elsewhere).   * The head of a table specifies all of its columns.  When formatting a
    * tbl_span, iterate over these and plug in data from the tbl_span when
    * appropriate, using tbl_cell as a guide to placement.
  */   */
 enum    regs {  struct  tbl_head {
         REG_nS = 0,          int               ident; /* 0 <= unique id < cols */
         REG__MAX          int               vert; /* width of preceding vertical line */
           struct tbl_head  *next;
           struct tbl_head  *prev;
 };  };
   
   enum    tbl_cellt {
           TBL_CELL_CENTRE, /* c, C */
           TBL_CELL_RIGHT, /* r, R */
           TBL_CELL_LEFT, /* l, L */
           TBL_CELL_NUMBER, /* n, N */
           TBL_CELL_SPAN, /* s, S */
           TBL_CELL_LONG, /* a, A */
           TBL_CELL_DOWN, /* ^ */
           TBL_CELL_HORIZ, /* _, - */
           TBL_CELL_DHORIZ, /* = */
           TBL_CELL_MAX
   };
   
 /*  /*
  * A register (struct reg) can consist of many types: this consists of   * A cell in a layout row.
  * normalised types from the original string form.  
  */   */
 union   regval {  struct  tbl_cell {
         unsigned  u; /* unsigned integer */          struct tbl_cell  *next;
           int               vert; /* width of preceding vertical line */
           enum tbl_cellt    pos;
           size_t            spacing;
           int               flags;
   #define TBL_CELL_TALIGN  (1 << 0) /* t, T */
   #define TBL_CELL_BALIGN  (1 << 1) /* d, D */
   #define TBL_CELL_BOLD    (1 << 2) /* fB, B, b */
   #define TBL_CELL_ITALIC  (1 << 3) /* fI, I, i */
   #define TBL_CELL_EQUAL   (1 << 4) /* e, E */
   #define TBL_CELL_UP      (1 << 5) /* u, U */
   #define TBL_CELL_WIGN    (1 << 6) /* z, Z */
   #define TBL_CELL_WMAX    (1 << 7) /* x, X */
           struct tbl_head  *head;
 };  };
   
 /*  /*
  * A single register entity.  If "set" is zero, the value of the   * A layout row.
  * register should be the default one, which is per-register.  It's  
  * assumed that callers know which type in "v" corresponds to which  
  * register value.  
  */   */
 struct  reg {  struct  tbl_row {
         int               set; /* whether set or not */          struct tbl_row   *next;
         union regval      v; /* parsed data */          struct tbl_cell  *first;
           struct tbl_cell  *last;
           int               vert; /* trailing 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 */
   };
   
 /*  /*
  * The primary interface to setting register values is in libroff,   * A cell within a row of data.  The "string" field contains the actual
  * although libmdoc and libman from time to time will manipulate   * string value that's in the cell.  The rest is layout.
  * registers (such as `.Sh SYNOPSIS' enabling REG_nS).  
  */   */
 struct  regset {  struct  tbl_dat {
         struct reg        regs[REG__MAX];          struct tbl_cell  *layout; /* layout cell */
           int               spans; /* how many spans follow */
           struct tbl_dat   *next;
           char             *string; /* data (NULL if not TBL_DATA_DATA) */
           enum tbl_datt     pos;
 };  };
   
 __BEGIN_DECLS  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 */
   };
   
 /*  /*
  * Callback function for warnings, errors, and fatal errors as they   * A row of data in a table.
  * occur in the compilers libroff, libmdoc, and libman.  
  */   */
 typedef int             (*mandocmsg)(enum mandocerr, void *,  struct  tbl_span {
                                 int, int, const char *);          struct tbl_opts  *opts;
           struct tbl_head  *head;
           struct tbl_row   *layout; /* layout row */
           struct tbl_dat   *first;
           struct tbl_dat   *last;
           int               line; /* parse line */
           int               flags;
   #define TBL_SPAN_FIRST   (1 << 0)
   #define TBL_SPAN_LAST    (1 << 1)
           enum tbl_spant    pos;
           struct tbl_span  *next;
   };
   
 __END_DECLS  enum    eqn_boxt {
           EQN_ROOT, /* root of parse tree */
           EQN_TEXT, /* text (number, variable, whatever) */
           EQN_SUBEXPR, /* nested `eqn' subexpression */
           EQN_LIST, /* list (braces, etc.) */
           EQN_LISTONE, /* singleton list */
           EQN_PILE, /* vertical pile */
           EQN_MATRIX /* pile of piles */
   };
   
 #endif /*!MANDOC_H*/  enum    eqn_fontt {
           EQNFONT_NONE = 0,
           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.
    */
   struct  eqn_box {
           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 */
   };
   
   /*
    * An equation consists of a tree of expressions starting at a given
    * line and position.
    */
   struct  eqn {
           char             *name; /* identifier (or NULL) */
           struct eqn_box   *root; /* root mathematical expression */
           int               ln; /* invocation line */
           int               pos; /* invocation position */
   };
   
   /*
    * Parse options.
    */
   #define MPARSE_MDOC     1  /* assume -mdoc */
   #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_SKIPCHAR /* skip the next character */
   };
   
   typedef void    (*mandocmsg)(enum mandocerr, enum mandoclevel,
                           const char *, int, int, const char *);
   
   struct  mparse;
   struct  mchars;
   struct  mdoc;
   struct  man;
   
   __BEGIN_DECLS
   
   enum mandoc_esc   mandoc_escape(const char **, const char **, int *);
   struct mchars    *mchars_alloc(void);
   void              mchars_free(struct mchars *);
   int               mchars_num2char(const char *, size_t);
   const char       *mchars_uc2str(int);
   int               mchars_num2uc(const char *, size_t);
   int               mchars_spec2cp(const struct mchars *,
                           const char *, size_t);
   const char       *mchars_spec2str(const struct mchars *,
                           const char *, size_t, size_t *);
   struct mparse    *mparse_alloc(int, enum mandoclevel, mandocmsg,
                           const struct mchars *, const char *);
   void              mparse_free(struct mparse *);
   void              mparse_keep(struct mparse *);
   enum mandoclevel  mparse_open(struct mparse *, int *, const char *);
   enum mandoclevel  mparse_readfd(struct mparse *, int, const char *);
   enum mandoclevel  mparse_readmem(struct mparse *, const void *, size_t,
                           const char *);
   void              mparse_reset(struct mparse *);
   void              mparse_result(struct mparse *,
                           struct mdoc **, struct man **, char **);
   const char       *mparse_getkeep(const struct mparse *);
   const char       *mparse_strerror(enum mandocerr);
   const char       *mparse_strlevel(enum mandoclevel);
   enum mandoclevel  mparse_wait(struct mparse *);
   
   __END_DECLS
Legend:
Removed from v.1.24  
changed lines
  Added in v.1.174
CVSweb