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

Diff for /mandoc/mandoc.h between version 1.121 and 1.163

version 1.121, 2014/06/20 17:24:00 version 1.163, 2014/10/14 02:16:06
Line 1 
Line 1 
 /*      $Id$ */  /*      $Id$ */
 /*  /*
  * Copyright (c) 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>   * Copyright (c) 2010, 2011, 2014 Kristaps Dzonsons <kristaps@bsd.lv>
  * Copyright (c) 2010-2014 Ingo Schwarze <schwarze@openbsd.org>   * 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
Line 49  enum mandocerr {
Line 49  enum mandocerr {
         MANDOCERR_WARNING, /* ===== start of warnings ===== */          MANDOCERR_WARNING, /* ===== start of warnings ===== */
   
         /* related to the prologue */          /* related to the prologue */
         MANDOCERR_TH_MISSING, /* no TH macro in document */          MANDOCERR_DT_NOTITLE, /* missing manual title, using UNTITLED: line */
         MANDOCERR_TITLE_CASE, /* document title should be all caps */          MANDOCERR_TH_NOTITLE, /* missing manual title, using "": [macro] */
         MANDOCERR_MSEC_BAD, /* unknown manual section */          MANDOCERR_TITLE_CASE, /* lower case character in document title */
         MANDOCERR_ARCH_BAD, /* unknown manual volume or arch */          MANDOCERR_MSEC_MISSING, /* missing manual section, using "": macro */
         MANDOCERR_DATE_MISSING, /* date missing, using today's date */          MANDOCERR_MSEC_BAD, /* unknown manual section: Dt ... section */
         MANDOCERR_DATE_BAD, /* cannot parse date, using it verbatim */          MANDOCERR_ARCH_BAD, /* unknown manual volume or arch: Dt ... volume */
         MANDOCERR_PROLOG_ORDER, /* prologue macros out of order */          MANDOCERR_DATE_MISSING, /* missing date, using today's date */
         MANDOCERR_PROLOG_REP, /* duplicate prologue macro */          MANDOCERR_DATE_BAD, /* cannot parse date, using it verbatim: date */
         MANDOCERR_PROLOG_BAD, /* macro not allowed in prologue */          MANDOCERR_OS_MISSING, /* missing Os macro, using "" */
         MANDOCERR_PROLOG_ONLY, /* macro not allowed in body */          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_SECOOO, /* sections out of conventional order */          MANDOCERR_NAMESEC_FIRST, /* first section is not NAME: Sh title */
         MANDOCERR_SECREP, /* duplicate section name */          MANDOCERR_NAMESEC_BAD, /* bad NAME section contents: macro */
         MANDOCERR_SECMSEC, /* section header suited to sections ... */          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_PAR_SKIP, /* skipping paragraph macro: macro ... */
         MANDOCERR_MOVEPAR, /* moving paragraph macro out of list */          MANDOCERR_PAR_MOVE, /* moving paragraph macro out of list: macro */
         MANDOCERR_IGNNS, /* skipping no-space macro */          MANDOCERR_NS_SKIP, /* skipping no-space macro */
         MANDOCERR_SCOPENEST, /* blocks badly nested */          MANDOCERR_BLK_NEST, /* blocks badly nested: macro ... */
         MANDOCERR_CHILD, /* child violates parent syntax */          MANDOCERR_BD_NEST, /* nested displays are not portable: macro ... */
         MANDOCERR_NESTEDDISP, /* nested displays are not portable */          MANDOCERR_BL_MOVE, /* moving content out of list: macro */
         MANDOCERR_SCOPEREP, /* already in literal mode */          MANDOCERR_VT_CHILD, /* .Vt block has child macro: macro */
         MANDOCERR_LINESCOPE, /* line scope broken */          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 macro arguments */          /* related to missing arguments */
         MANDOCERR_MACROEMPTY, /* skipping empty macro */          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_ARGCWARN, /* argument count wrong */
         MANDOCERR_DISPTYPE, /* missing display type */          MANDOCERR_BD_NOTYPE, /* missing display type, using -ragged: Bd */
         MANDOCERR_LISTFIRST, /* list type must come first */          MANDOCERR_BL_LATETYPE, /* list type is not the first argument: Bl arg */
         MANDOCERR_NOWIDTHARG, /* tag lists require a width argument */          MANDOCERR_BL_NOWIDTH, /* missing -width in -tag list, using 8n */
         MANDOCERR_FONTTYPE, /* missing font type */          MANDOCERR_EX_NONAME, /* missing utility name, using "": Ex */
         MANDOCERR_WNOSCOPE, /* skipping end of block that is not open */          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_ARG_STD, /* missing -std argument, adding it: macro */
           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_AT_BAD, /* unknown AT&T UNIX version: At version */
         MANDOCERR_BADSTANDARD, /* unknown standard specifier */          MANDOCERR_FA_COMMA, /* comma in function argument: arg */
         MANDOCERR_BADWIDTH, /* bad width argument */          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 */          /* 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_COMMENT_BAD, /* bad comment style */
         MANDOCERR_BADESCAPE, /* unknown escape sequence */          MANDOCERR_ESC_BAD, /* invalid escape sequence: esc */
         MANDOCERR_BADQUOTE, /* unterminated quoted string */          MANDOCERR_STR_UNDEF, /* undefined string, using "": name */
   
         /* related to equations */  
         MANDOCERR_EQNQUOTE, /* unexpected literal in equation */  
   
         MANDOCERR_ERROR, /* ===== start of errors ===== */          MANDOCERR_ERROR, /* ===== start of errors ===== */
   
         /* related to equations */          /* related to equations */
Line 117  enum mandocerr {
Line 135  enum mandocerr {
         MANDOCERR_EQNSCOPE, /* equation scope open on exit */          MANDOCERR_EQNSCOPE, /* equation scope open on exit */
         MANDOCERR_EQNBADSCOPE, /* overlapping equation scopes */          MANDOCERR_EQNBADSCOPE, /* overlapping equation scopes */
         MANDOCERR_EQNEOF, /* unexpected end of equation */          MANDOCERR_EQNEOF, /* unexpected end of equation */
         MANDOCERR_EQNSYNT, /* equation syntax error */  
   
         /* related to tables */          /* related to tables */
         MANDOCERR_TBL, /* bad table syntax */          MANDOCERR_TBL, /* bad table syntax */
Line 129  enum mandocerr {
Line 146  enum mandocerr {
         MANDOCERR_TBLBLOCK, /* data block still open */          MANDOCERR_TBLBLOCK, /* data block still open */
         MANDOCERR_TBLEXTRADAT, /* ignoring extra data cells */          MANDOCERR_TBLEXTRADAT, /* ignoring extra data cells */
   
           /* related to document structure and macros */
         MANDOCERR_ROFFLOOP, /* input stack limit exceeded, infinite loop? */          MANDOCERR_ROFFLOOP, /* input stack limit exceeded, infinite loop? */
         MANDOCERR_BADCHAR, /* skipping bad character */          MANDOCERR_BADCHAR, /* skipping bad character: number */
         MANDOCERR_NAMESC, /* escaped character not allowed in a name */          MANDOCERR_MACRO, /* skipping unknown macro: macro */
         MANDOCERR_NONAME, /* manual name not yet set */          MANDOCERR_IT_STRAY, /* skipping item outside list: It ... */
         MANDOCERR_NOTEXT, /* skipping text before the first section header */          MANDOCERR_TA_STRAY, /* skipping column outside column list: Ta */
         MANDOCERR_MACRO, /* skipping unknown macro */          MANDOCERR_BLK_NOTOPEN, /* skipping end of block that is not open */
         MANDOCERR_REQUEST, /* NOT IMPLEMENTED: skipping request */          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_STRAYTA, /* skipping column outside column list */          MANDOCERR_BL_NOTYPE, /* missing list type, using -item: Bl */
         MANDOCERR_NOSCOPE, /* skipping end of block that is not open */          MANDOCERR_NM_NONAME, /* missing manual name, using "": Nm */
         MANDOCERR_SCOPEBROKEN, /* missing end of block */          MANDOCERR_OS_UNAME, /* uname(3) system call failed, using UNKNOWN */
         MANDOCERR_SCOPEEXIT, /* scope open on exit */          MANDOCERR_ST_BAD, /* unknown standard specifier: St standard */
         MANDOCERR_UNAME, /* uname(3) system call failed */          MANDOCERR_IT_NONUM, /* skipping request without numeric argument */
         /* FIXME: merge following with MANDOCERR_ARGCOUNT */          MANDOCERR_ARG_SKIP, /* skipping all arguments: macro args */
         MANDOCERR_NOARGS, /* macro requires line argument(s) */          MANDOCERR_ARG_EXCESS, /* skipping excess arguments: macro ... args */
         MANDOCERR_NOBODY, /* macro requires body argument(s) */  
         MANDOCERR_NOARGV, /* macro requires argument(s) */  
         MANDOCERR_NUMERIC, /* request requires a numeric argument */  
         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 ===== */          MANDOCERR_FATAL, /* ===== start of fatal errors ===== */
   
         MANDOCERR_TOOLARGE, /* input too large */          MANDOCERR_TOOLARGE, /* input too large */
         MANDOCERR_NOTMANUAL, /* manual isn't really a manual */          MANDOCERR_BD_FILE, /* NOT IMPLEMENTED: Bd -file */
         MANDOCERR_COLUMNS, /* column syntax is inconsistent */          MANDOCERR_SO_PATH, /* NOT IMPLEMENTED: .so with absolute path or ".." */
         MANDOCERR_BADDISP, /* NOT IMPLEMENTED: .Bd -file */          MANDOCERR_SO_FAIL, /* .so request failed */
         MANDOCERR_SYNTARGVCOUNT, /* argument count wrong, violates syntax */  
         MANDOCERR_SYNTCHILD, /* child violates parent syntax */  
         MANDOCERR_SYNTARGCOUNT, /* argument count wrong, violates syntax */  
         MANDOCERR_SOPATH, /* NOT IMPLEMENTED: .so with absolute path or ".." */  
         MANDOCERR_NODOCBODY, /* no document body */  
         MANDOCERR_NODOCPROLOG, /* no document prologue */  
         MANDOCERR_MEM, /* static buffer exhausted */  
   
         /* ===== system errors ===== */          /* ===== system errors ===== */
   
           MANDOCERR_SYSDUP, /* cannot dup file descriptor */
           MANDOCERR_SYSEXEC, /* cannot exec */
           MANDOCERR_SYSEXIT, /* gunzip failed with code */
           MANDOCERR_SYSFORK, /* cannot fork */
         MANDOCERR_SYSOPEN, /* cannot open file */          MANDOCERR_SYSOPEN, /* cannot open file */
         MANDOCERR_SYSSTAT, /* cannot stat file */          MANDOCERR_SYSPIPE, /* cannot open pipe */
         MANDOCERR_SYSREAD, /* cannot read file */          MANDOCERR_SYSREAD, /* cannot read file */
           MANDOCERR_SYSSIG, /* gunzip died from signal */
           MANDOCERR_SYSSTAT, /* cannot stat file */
           MANDOCERR_SYSWAIT, /* wait failed */
   
         MANDOCERR_MAX          MANDOCERR_MAX
 };  };
Line 230  struct tbl_cell {
Line 246  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 */
         struct tbl_head  *head;          struct tbl_head  *head;
 };  };
   
Line 291  enum eqn_boxt {
Line 308  enum eqn_boxt {
         EQN_ROOT, /* root of parse tree */          EQN_ROOT, /* root of parse tree */
         EQN_TEXT, /* text (number, variable, whatever) */          EQN_TEXT, /* text (number, variable, whatever) */
         EQN_SUBEXPR, /* nested `eqn' subexpression */          EQN_SUBEXPR, /* nested `eqn' subexpression */
         EQN_LIST, /* subexpressions list */          EQN_LIST, /* list (braces, etc.) */
         EQN_MATRIX /* matrix subexpression */          EQN_LISTONE, /* singleton list */
           EQN_PILE, /* vertical pile */
           EQN_MATRIX /* pile of piles */
 };  };
   
 enum    eqn_markt {  
         EQNMARK_NONE = 0,  
         EQNMARK_DOT,  
         EQNMARK_DOTDOT,  
         EQNMARK_HAT,  
         EQNMARK_TILDE,  
         EQNMARK_VEC,  
         EQNMARK_DYAD,  
         EQNMARK_BAR,  
         EQNMARK_UNDER,  
         EQNMARK__MAX  
 };  
   
 enum    eqn_fontt {  enum    eqn_fontt {
         EQNFONT_NONE = 0,          EQNFONT_NONE = 0,
         EQNFONT_ROMAN,          EQNFONT_ROMAN,
Line 319  enum eqn_fontt {
Line 325  enum eqn_fontt {
   
 enum    eqn_post {  enum    eqn_post {
         EQNPOS_NONE = 0,          EQNPOS_NONE = 0,
         EQNPOS_OVER,  
         EQNPOS_SUP,          EQNPOS_SUP,
           EQNPOS_SUBSUP,
         EQNPOS_SUB,          EQNPOS_SUB,
         EQNPOS_TO,          EQNPOS_TO,
         EQNPOS_FROM,          EQNPOS_FROM,
           EQNPOS_FROMTO,
           EQNPOS_OVER,
           EQNPOS_SQRT,
         EQNPOS__MAX          EQNPOS__MAX
 };  };
   
Line 351  struct eqn_box {
Line 360  struct eqn_box {
         struct eqn_box   *first; /* first child node */          struct eqn_box   *first; /* first child node */
         struct eqn_box   *last; /* last child node */          struct eqn_box   *last; /* last child node */
         struct eqn_box   *next; /* node sibling */          struct eqn_box   *next; /* node sibling */
           struct eqn_box   *prev; /* node sibling */
         struct eqn_box   *parent; /* node sibling */          struct eqn_box   *parent; /* node sibling */
         char             *text; /* text (or NULL) */          char             *text; /* text (or NULL) */
         char             *left;          char             *left; /* fence left-hand */
         char             *right;          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_post     pos; /* position of next box */
         enum eqn_markt    mark; /* a mark about the box */  
         enum eqn_fontt    font; /* font of box */          enum eqn_fontt    font; /* font of box */
         enum eqn_pilet    pile; /* equation piling */          enum eqn_pilet    pile; /* equation piling */
 };  };
Line 415  int    mchars_spec2cp(const struct mchars *,
Line 428  int    mchars_spec2cp(const struct mchars *,
                         const char *, size_t);                          const char *, size_t);
 const char       *mchars_spec2str(const struct mchars *,  const char       *mchars_spec2str(const struct mchars *,
                         const char *, size_t, size_t *);                          const char *, size_t, size_t *);
 struct mparse    *mparse_alloc(int, enum mandoclevel, mandocmsg, char *);  struct mparse    *mparse_alloc(int, enum mandoclevel, mandocmsg,
                           const char *);
 void              mparse_free(struct mparse *);  void              mparse_free(struct mparse *);
 void              mparse_keep(struct mparse *);  void              mparse_keep(struct mparse *);
   enum mandoclevel  mparse_open(struct mparse *, int *, const char *,
                           pid_t *);
 enum mandoclevel  mparse_readfd(struct mparse *, int, const char *);  enum mandoclevel  mparse_readfd(struct mparse *, int, const char *);
 enum mandoclevel  mparse_readmem(struct mparse *, const void *, size_t,  enum mandoclevel  mparse_readmem(struct mparse *, const void *, size_t,
                         const char *);                          const char *);
Line 427  void    mparse_result(struct mparse *,
Line 443  void    mparse_result(struct mparse *,
 const char       *mparse_getkeep(const struct mparse *);  const char       *mparse_getkeep(const struct mparse *);
 const char       *mparse_strerror(enum mandocerr);  const char       *mparse_strerror(enum mandocerr);
 const char       *mparse_strlevel(enum mandoclevel);  const char       *mparse_strlevel(enum mandoclevel);
   enum mandoclevel  mparse_wait(struct mparse *, pid_t);
   
 __END_DECLS  __END_DECLS
   
Legend:
Removed from v.1.121  
changed lines
  Added in v.1.163
CVSweb