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

Diff for /mandoc/mandoc.h between version 1.143 and 1.161

version 1.143, 2014/07/30 00:19:16 version 1.161, 2014/10/11 21:14:16
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, /* missing .TH macro, using "unknown 1" */          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_TITLE_CASE, /* lower case character in document title */
         MANDOCERR_MSEC_BAD, /* unknown manual section: section */          MANDOCERR_MSEC_MISSING, /* missing manual section, using "": macro */
         MANDOCERR_ARCH_BAD, /* unknown manual volume or arch: volume */          MANDOCERR_MSEC_BAD, /* unknown manual section: Dt ... section */
           MANDOCERR_ARCH_BAD, /* unknown manual volume or arch: Dt ... volume */
         MANDOCERR_DATE_MISSING, /* missing date, using today's date */          MANDOCERR_DATE_MISSING, /* missing date, using today's date */
         MANDOCERR_DATE_BAD, /* cannot parse date, using it verbatim: date */          MANDOCERR_DATE_BAD, /* cannot parse date, using it verbatim: date */
         MANDOCERR_PROLOG_ORDER, /* prologue macros out of order: macro */          MANDOCERR_OS_MISSING, /* missing Os macro, using "" */
         MANDOCERR_PROLOG_REP, /* duplicate prologue macro: macro */          MANDOCERR_PROLOG_REP, /* duplicate prologue macro: macro */
         MANDOCERR_PROLOG_BAD, /* incomplete prologue, terminated by: macro */          MANDOCERR_PROLOG_LATE, /* late prologue macro: macro */
         MANDOCERR_PROLOG_ONLY, /* skipping prologue macro in body: 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): .so path */          MANDOCERR_SO, /* .so is fragile, better use ln(1): so path */
         MANDOCERR_DOC_EMPTY, /* no document body */          MANDOCERR_DOC_EMPTY, /* no document body */
         MANDOCERR_SEC_BEFORE, /* content before first section header: macro */          MANDOCERR_SEC_BEFORE, /* content before first section header: macro */
         MANDOCERR_NAMESEC_FIRST, /* first section is not "NAME": title */          MANDOCERR_NAMESEC_FIRST, /* first section is not NAME: Sh title */
         MANDOCERR_NAMESEC_BAD, /* bad NAME section contents: macro */          MANDOCERR_NAMESEC_BAD, /* bad NAME section contents: macro */
         MANDOCERR_SEC_ORDER, /* sections out of conventional order: title */          MANDOCERR_SEC_ORDER, /* sections out of conventional order: Sh title */
         MANDOCERR_SEC_REP, /* duplicate section title: title */          MANDOCERR_SEC_REP, /* duplicate section title: Sh title */
         MANDOCERR_SEC_MSEC, /* unexpected section: title for ... only */          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_MACRO_OBS, /* obsolete macro: macro */          MANDOCERR_MACRO_OBS, /* obsolete macro: macro */
Line 79  enum mandocerr {
Line 85  enum mandocerr {
         MANDOCERR_BD_NEST, /* nested displays are not portable: macro ... */          MANDOCERR_BD_NEST, /* nested displays are not portable: macro ... */
         MANDOCERR_BL_MOVE, /* moving content out of list: macro */          MANDOCERR_BL_MOVE, /* moving content out of list: macro */
         MANDOCERR_VT_CHILD, /* .Vt block has child macro: macro */          MANDOCERR_VT_CHILD, /* .Vt block has child macro: macro */
         MANDOCERR_FI_SKIP, /* fill mode already enabled, skipping .fi */          MANDOCERR_FI_SKIP, /* fill mode already enabled, skipping: fi */
         MANDOCERR_NF_SKIP, /* fill mode already disabled, skipping .nf */          MANDOCERR_NF_SKIP, /* fill mode already disabled, skipping: nf */
         MANDOCERR_BLK_LINE, /* line scope broken: macro breaks macro */          MANDOCERR_BLK_LINE, /* line scope broken: macro breaks macro */
   
         /* related to missing arguments */          /* related to missing arguments */
Line 89  enum mandocerr {
Line 95  enum mandocerr {
         MANDOCERR_MACRO_EMPTY, /* skipping empty macro: macro */          MANDOCERR_MACRO_EMPTY, /* skipping empty macro: macro */
         MANDOCERR_ARG_EMPTY, /* empty argument, using 0n: macro arg */          MANDOCERR_ARG_EMPTY, /* empty argument, using 0n: macro arg */
         MANDOCERR_ARGCWARN, /* argument count wrong */          MANDOCERR_ARGCWARN, /* argument count wrong */
         MANDOCERR_BD_NOTYPE, /* missing display type, using -ragged */          MANDOCERR_BD_NOTYPE, /* missing display type, using -ragged: Bd */
         MANDOCERR_BL_LATETYPE, /* list type is not the first argument: arg */          MANDOCERR_BL_LATETYPE, /* list type is not the first argument: Bl arg */
         MANDOCERR_BL_NOWIDTH, /* missing -width in -tag list, using 8n */          MANDOCERR_BL_NOWIDTH, /* missing -width in -tag list, using 8n */
         MANDOCERR_EX_NONAME, /* missing name for .Ex, using "" */          MANDOCERR_EX_NONAME, /* missing utility name, using "": Ex */
         MANDOCERR_IT_NOHEAD, /* empty head in list item: type */          MANDOCERR_IT_NOHEAD, /* empty head in list item: Bl -type It */
         MANDOCERR_IT_NOBODY, /* empty list item: type */          MANDOCERR_IT_NOBODY, /* empty list item: Bl -type It */
         MANDOCERR_BF_NOFONT, /* missing font type, using \fR */          MANDOCERR_BF_NOFONT, /* missing font type, using \fR: Bf */
         MANDOCERR_BF_BADFONT, /* unknown font type, using \fR: macro font */          MANDOCERR_BF_BADFONT, /* unknown font type, using \fR: Bf font */
         MANDOCERR_ARG_STD, /* missing -std argument, adding it: macro */          MANDOCERR_ARG_STD, /* missing -std argument, adding it: macro */
   
         /* related to bad arguments */          /* related to bad arguments */
         MANDOCERR_IGNARGV, /* skipping argument */  
         MANDOCERR_ARG_QUOTE, /* unterminated quoted argument */          MANDOCERR_ARG_QUOTE, /* unterminated quoted argument */
         MANDOCERR_ARG_REP, /* duplicate argument: macro arg */          MANDOCERR_ARG_REP, /* duplicate argument: macro arg */
         MANDOCERR_BD_REP, /* skipping duplicate display type: type */          MANDOCERR_AN_REP, /* skipping duplicate argument: An -arg */
         MANDOCERR_BL_REP, /* skipping duplicate list type: type */          MANDOCERR_BD_REP, /* skipping duplicate display type: Bd -type */
         MANDOCERR_AT_BAD, /* unknown AT&T UNIX version: version */          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_RS_BAD, /* invalid content in Rs block: macro */
         MANDOCERR_SM_BAD, /* invalid Boolean argument: macro arg */          MANDOCERR_SM_BAD, /* invalid Boolean argument: macro arg */
         MANDOCERR_FT_BAD, /* unknown font, skipping request: request font */          MANDOCERR_FT_BAD, /* unknown font, skipping request: ft font */
   
         /* related to plain text */          /* related to plain text */
         MANDOCERR_FI_BLANK, /* blank line in fill mode, using .sp */          MANDOCERR_FI_BLANK, /* blank line in fill mode, using .sp */
Line 139  enum mandocerr {
Line 148  enum mandocerr {
   
         /* related to document structure and macros */          /* 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_MACRO, /* skipping unknown macro */          MANDOCERR_MACRO, /* skipping unknown macro: macro */
         MANDOCERR_TA_STRAY, /* skipping column outside column list */          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_NOTOPEN, /* skipping end of block that is not open */
         MANDOCERR_BLK_BROKEN, /* inserting missing end of block: macro ... */          MANDOCERR_BLK_BROKEN, /* inserting missing end of block: macro ... */
         MANDOCERR_BLK_NOEND, /* appending missing end of block: macro */          MANDOCERR_BLK_NOEND, /* appending missing end of block: macro */
   
         /* related to request and macro arguments */          /* related to request and macro arguments */
         MANDOCERR_NAMESC, /* escaped character not allowed in a name */          MANDOCERR_NAMESC, /* escaped character not allowed in a name: name */
         MANDOCERR_ARGCOUNT, /* argument count wrong */          MANDOCERR_ARGCOUNT, /* argument count wrong */
         MANDOCERR_NM_NONAME, /* missing manual name, using "" */          MANDOCERR_BL_NOTYPE, /* missing list type, using -item: Bl */
         MANDOCERR_ST_BAD, /* unknown standard specifier: standard */          MANDOCERR_NM_NONAME, /* missing manual name, using "": Nm */
         MANDOCERR_UNAME, /* uname(3) system call failed */          MANDOCERR_OS_UNAME, /* uname(3) system call failed, using UNKNOWN */
         MANDOCERR_NUMERIC, /* request requires a numeric argument */          MANDOCERR_ST_BAD, /* unknown standard specifier: St standard */
         MANDOCERR_BL_NOTYPE, /* missing list type, using -item */          MANDOCERR_IT_NONUM, /* skipping request without numeric argument */
         MANDOCERR_ARG_SKIP, /* skipping all arguments: macro args */          MANDOCERR_ARG_SKIP, /* skipping all arguments: macro args */
         MANDOCERR_ARG_EXCESS, /* skipping excess arguments: macro ... args */          MANDOCERR_ARG_EXCESS, /* skipping excess arguments: macro ... args */
   
         MANDOCERR_FATAL, /* ===== start of fatal errors ===== */          MANDOCERR_FATAL, /* ===== start of fatal errors ===== */
   
         MANDOCERR_TOOLARGE, /* input too large */          MANDOCERR_TOOLARGE, /* input too large */
         MANDOCERR_NOTMANUAL, /* not a manual */          MANDOCERR_BD_FILE, /* NOT IMPLEMENTED: Bd -file */
         MANDOCERR_COLUMNS, /* column syntax is inconsistent */  
         MANDOCERR_BADDISP, /* NOT IMPLEMENTED: .Bd -file */  
         MANDOCERR_SYNTCHILD, /* child violates parent syntax */  
         MANDOCERR_SYNTARGCOUNT, /* argument count wrong, violates syntax */  
         MANDOCERR_SO_PATH, /* NOT IMPLEMENTED: .so with absolute path or ".." */          MANDOCERR_SO_PATH, /* NOT IMPLEMENTED: .so with absolute path or ".." */
         MANDOCERR_SO_FAIL, /* .so request failed */          MANDOCERR_SO_FAIL, /* .so request failed */
         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 296  enum eqn_boxt {
Line 307  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 324  enum eqn_fontt {
Line 324  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 356  struct eqn_box {
Line 359  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 424  struct mparse  *mparse_alloc(int, enum mandoclevel, ma
Line 431  struct mparse  *mparse_alloc(int, enum mandoclevel, ma
                         const char *);                          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 433  void    mparse_result(struct mparse *,
Line 442  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.143  
changed lines
  Added in v.1.161
CVSweb