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

Diff for /mandoc/mandoc.h between version 1.62 and 1.125

version 1.62, 2011/03/20 11:41:24 version 1.125, 2014/07/01 22:37:15
Line 1 
Line 1 
 /*      $Id$ */  /*      $Id$ */
 /*  /*
  * Copyright (c) 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>   * Copyright (c) 2010, 2011 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 19 
Line 20 
   
 #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 47  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_NOTITLE, /* no title in document */          MANDOCERR_TH_MISSING, /* missing .TH macro, using "unknown 1" */
         MANDOCERR_UPPERCASE, /* document title should be all caps */          MANDOCERR_TITLE_CASE, /* lower case character in document title */
         MANDOCERR_BADMSEC, /* unknown manual section */          MANDOCERR_MSEC_BAD, /* unknown manual section: section */
         MANDOCERR_NODATE, /* date missing, using today's date */          MANDOCERR_ARCH_BAD, /* unknown manual volume or arch: volume */
         MANDOCERR_BADDATE, /* cannot parse date, using it verbatim */          MANDOCERR_DATE_MISSING, /* missing date, using today's date */
         MANDOCERR_PROLOGOOO, /* prologue macros out of order */          MANDOCERR_DATE_BAD, /* cannot parse date, using it verbatim: date */
         MANDOCERR_PROLOGREP, /* duplicate prologue macro */          MANDOCERR_PROLOG_ORDER, /* prologue macros out of order: macro */
         MANDOCERR_BADPROLOG, /* macro not allowed in prologue */          MANDOCERR_PROLOG_REP, /* duplicate prologue macro: macro */
         MANDOCERR_BADBODY, /* macro not allowed in body */          MANDOCERR_PROLOG_BAD, /* incomplete prologue, terminated by: macro */
           MANDOCERR_PROLOG_ONLY, /* skipping prologue macro in body: macro */
   
         /* 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": title */
         MANDOCERR_SECOOO, /* sections out of conventional order */          MANDOCERR_NAMESEC_BAD, /* bad NAME section contents: macro */
         MANDOCERR_SECREP, /* duplicate section name */          MANDOCERR_SEC_ORDER, /* sections out of conventional order: title */
         MANDOCERR_SECMSEC, /* section not in conventional manual section */          MANDOCERR_SEC_REP, /* duplicate section title: title */
           MANDOCERR_SEC_MSEC, /* unexpected section: title for ... only */
   
         /* related to macros and nesting */          /* related to macros and nesting */
         MANDOCERR_MACROOBS, /* skipping obsolete macro */          MANDOCERR_MACROOBS, /* skipping obsolete macro */
         MANDOCERR_IGNPAR, /* skipping paragraph macro */          MANDOCERR_IGNPAR, /* skipping paragraph macro */
           MANDOCERR_MOVEPAR, /* moving paragraph macro out of list */
         MANDOCERR_IGNNS, /* skipping no-space macro */          MANDOCERR_IGNNS, /* skipping no-space macro */
         MANDOCERR_SCOPENEST, /* blocks badly nested */          MANDOCERR_SCOPENEST, /* blocks badly nested */
         MANDOCERR_CHILD, /* child violates parent syntax */          MANDOCERR_CHILD, /* child violates parent syntax */
         MANDOCERR_NESTEDDISP, /* nested displays are not portable */          MANDOCERR_NESTEDDISP, /* nested displays are not portable */
         MANDOCERR_SCOPEREP, /* already in literal mode */          MANDOCERR_SCOPEREP, /* already in literal mode */
           MANDOCERR_LINESCOPE, /* line scope broken */
   
         /* related to missing macro arguments */          /* related to missing macro arguments */
         MANDOCERR_MACROEMPTY, /* skipping empty macro */          MANDOCERR_MACROEMPTY, /* skipping empty macro */
Line 100  enum mandocerr {
Line 106  enum mandocerr {
         MANDOCERR_BADTAB, /* tab in non-literal context */          MANDOCERR_BADTAB, /* tab in non-literal context */
         MANDOCERR_EOLNSPACE, /* end of line whitespace */          MANDOCERR_EOLNSPACE, /* end of line whitespace */
         MANDOCERR_BADCOMMENT, /* bad comment style */          MANDOCERR_BADCOMMENT, /* bad comment style */
         MANDOCERR_BADESCAPE, /* unknown escape sequence */          MANDOCERR_BADESCAPE, /* bad escape sequence */
         MANDOCERR_BADQUOTE, /* unterminated quoted string */          MANDOCERR_BADQUOTE, /* unterminated quoted string */
   
         MANDOCERR_ERROR, /* ===== start of errors ===== */          MANDOCERR_ERROR, /* ===== start of errors ===== */
   
           /* related to equations */
           MANDOCERR_EQNNSCOPE, /* unexpected equation scope closure*/
           MANDOCERR_EQNSCOPE, /* equation scope open on exit */
           MANDOCERR_EQNBADSCOPE, /* overlapping equation scopes */
           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 */
         MANDOCERR_TBLOPT, /* bad table option */          MANDOCERR_TBLOPT, /* bad table option */
Line 118  enum mandocerr {
Line 131  enum mandocerr {
         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 */
         MANDOCERR_NAMESC, /* escaped character not allowed in a name */          MANDOCERR_NAMESC, /* escaped character not allowed in a name */
         MANDOCERR_NOTEXT, /* skipping text before the first section header */          MANDOCERR_NONAME, /* manual name not yet set */
           MANDOCERR_NOTEXT, /* skipping text before first section header */
         MANDOCERR_MACRO, /* skipping unknown macro */          MANDOCERR_MACRO, /* skipping unknown macro */
         MANDOCERR_REQUEST, /* NOT IMPLEMENTED: skipping request */          MANDOCERR_REQUEST, /* NOT IMPLEMENTED: skipping request */
         MANDOCERR_LINESCOPE, /* line scope broken */  
         MANDOCERR_ARGCOUNT, /* argument count wrong */          MANDOCERR_ARGCOUNT, /* argument count wrong */
           MANDOCERR_STRAYTA, /* skipping column outside column list */
         MANDOCERR_NOSCOPE, /* skipping end of block that is not open */          MANDOCERR_NOSCOPE, /* skipping end of block that is not open */
         MANDOCERR_SCOPEBROKEN, /* missing end of block */          MANDOCERR_SCOPEBROKEN, /* missing end of block */
         MANDOCERR_SCOPEEXIT, /* scope open on exit */          MANDOCERR_SCOPEEXIT, /* scope open on exit */
Line 131  enum mandocerr {
Line 145  enum mandocerr {
         MANDOCERR_NOARGS, /* macro requires line argument(s) */          MANDOCERR_NOARGS, /* macro requires line argument(s) */
         MANDOCERR_NOBODY, /* macro requires body argument(s) */          MANDOCERR_NOBODY, /* macro requires body argument(s) */
         MANDOCERR_NOARGV, /* macro requires argument(s) */          MANDOCERR_NOARGV, /* macro requires argument(s) */
           MANDOCERR_NUMERIC, /* request requires a numeric argument */
         MANDOCERR_LISTTYPE, /* missing list type */          MANDOCERR_LISTTYPE, /* missing list type */
         MANDOCERR_ARGSLOST, /* line argument(s) will be lost */          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_NOTMANUAL, /* not a manual */
         MANDOCERR_COLUMNS, /* column syntax is inconsistent */          MANDOCERR_COLUMNS, /* column syntax is inconsistent */
         MANDOCERR_BADDISP, /* NOT IMPLEMENTED: .Bd -file */          MANDOCERR_BADDISP, /* NOT IMPLEMENTED: .Bd -file */
         MANDOCERR_SYNTLINESCOPE, /* line scope broken, syntax violated */  
         MANDOCERR_SYNTARGVCOUNT, /* argument count wrong, violates syntax */          MANDOCERR_SYNTARGVCOUNT, /* argument count wrong, violates syntax */
         MANDOCERR_SYNTCHILD, /* child violates parent syntax */          MANDOCERR_SYNTCHILD, /* child violates parent syntax */
         MANDOCERR_SYNTARGCOUNT, /* argument count wrong, violates syntax */          MANDOCERR_SYNTARGCOUNT, /* argument count wrong, violates syntax */
         MANDOCERR_SOPATH, /* NOT IMPLEMENTED: .so with absolute path or ".." */          MANDOCERR_SO_PATH, /* NOT IMPLEMENTED: .so with absolute path or ".." */
         MANDOCERR_NODOCBODY, /* no document body */          MANDOCERR_SO_FAIL, /* .so request failed */
         MANDOCERR_NODOCPROLOG, /* no document prologue */          MANDOCERR_NODOCPROLOG, /* no document prologue */
         MANDOCERR_MEM, /* static buffer exhausted */          MANDOCERR_MEM, /* static buffer exhausted */
   
           /* ===== system errors ===== */
   
           MANDOCERR_SYSOPEN, /* cannot open file */
           MANDOCERR_SYSSTAT, /* cannot stat file */
           MANDOCERR_SYSREAD, /* cannot read file */
   
         MANDOCERR_MAX          MANDOCERR_MAX
 };  };
   
 struct  tbl {  struct  tbl_opts {
         char              tab; /* cell-separator */          char              tab; /* cell-separator */
         char              decimal; /* decimal point */          char              decimal; /* decimal point */
         int               linesize;          int               linesize;
Line 165  struct tbl {
Line 187  struct tbl {
         int               cols; /* number of columns */          int               cols; /* number of columns */
 };  };
   
 enum    tbl_headt {  
         TBL_HEAD_DATA, /* plug in data from tbl_dat */  
         TBL_HEAD_VERT, /* vertical spacer */  
         TBL_HEAD_DVERT  /* double-vertical spacer */  
 };  
   
 /*  /*
  * The head of a table specifies all of its columns.  When formatting a   * 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   * tbl_span, iterate over these and plug in data from the tbl_span when
  * appropriate, using tbl_cell as a guide to placement.   * appropriate, using tbl_cell as a guide to placement.
  */   */
 struct  tbl_head {  struct  tbl_head {
         enum tbl_headt    pos;  
         int               ident; /* 0 <= unique id < cols */          int               ident; /* 0 <= unique id < cols */
           int               vert; /* width of preceding vertical line */
         struct tbl_head  *next;          struct tbl_head  *next;
         struct tbl_head  *prev;          struct tbl_head  *prev;
 };  };
Line 193  enum tbl_cellt {
Line 209  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 203  enum tbl_cellt {
Line 217  enum tbl_cellt {
  */   */
 struct  tbl_cell {  struct  tbl_cell {
         struct tbl_cell  *next;          struct tbl_cell  *next;
           int               vert; /* width of preceding vertical line */
         enum tbl_cellt    pos;          enum tbl_cellt    pos;
         size_t            spacing;          size_t            spacing;
         int               flags;          int               flags;
Line 223  struct tbl_row {
Line 238  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; /* trailing vertical line */
 };  };
   
 enum    tbl_datt {  enum    tbl_datt {
Line 256  enum tbl_spant {
Line 272  enum tbl_spant {
  * A row of data in a table.   * A row of data in a table.
  */   */
 struct  tbl_span {  struct  tbl_span {
         struct tbl       *tbl;          struct tbl_opts  *opts;
         struct tbl_head  *head;          struct tbl_head  *head;
         struct tbl_row   *layout; /* layout row */          struct tbl_row   *layout; /* layout row */
         struct tbl_dat   *first;          struct tbl_dat   *first;
Line 269  struct tbl_span {
Line 285  struct tbl_span {
         struct tbl_span  *next;          struct tbl_span  *next;
 };  };
   
 struct  eqn {  enum    eqn_boxt {
         size_t            sz;          EQN_ROOT, /* root of parse tree */
         char             *data;          EQN_TEXT, /* text (number, variable, whatever) */
         int               line; /* invocation line */          EQN_SUBEXPR, /* nested `eqn' subexpression */
         int               pos; /* invocation position */          EQN_LIST, /* subexpressions list */
           EQN_MATRIX /* matrix subexpression */
 };  };
   
 /*  enum    eqn_markt {
  * Available registers (set in libroff, accessed elsewhere).          EQNMARK_NONE = 0,
  */          EQNMARK_DOT,
 enum    regs {          EQNMARK_DOTDOT,
         REG_nS = 0,          EQNMARK_HAT,
         REG__MAX          EQNMARK_TILDE,
           EQNMARK_VEC,
           EQNMARK_DYAD,
           EQNMARK_BAR,
           EQNMARK_UNDER,
           EQNMARK__MAX
 };  };
   
 /*  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_OVER,
  * assumed that callers know which type in "v" corresponds to which          EQNPOS_SUP,
  * register value.          EQNPOS_SUB,
  */          EQNPOS_TO,
 struct  reg {          EQNPOS_FROM,
         int               set; /* whether set or not */          EQNPOS__MAX
         union regval      v; /* parsed data */  
 };  };
   
 /*  enum    eqn_pilet {
  * The primary interface to setting register values is in libroff,          EQNPILE_NONE = 0,
  * although libmdoc and libman from time to time will manipulate          EQNPILE_PILE,
  * registers (such as `.Sh SYNOPSIS' enabling REG_nS).          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  regset {  struct  eqn_box {
         struct reg        regs[REG__MAX];          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   *parent; /* node sibling */
           char             *text; /* text (or NULL) */
           char             *left;
           char             *right;
           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_pilet    pile; /* equation piling */
 };  };
   
 /*  /*
  * A punctuation delimiter, used only in mdoc(7) documents, is opening,   * An equation consists of a tree of expressions starting at a given
  * closing, or "middle mark" punctuation.  These govern spacing.   * line and position.
  * Opening punctuation (e.g., the opening parenthesis) suppresses the  
  * following space; closing punctuation (e.g., the closing parenthesis)  
  * suppresses the leading space; middle punctuation (e.g., the vertical  
  * bar) can do either.  The middle punctuation delimiter bends the rules  
  * depending on usage.  
  */   */
 enum    mdelim {  struct  eqn {
         DELIM_NONE = 0,          char             *name; /* identifier (or NULL) */
         DELIM_OPEN,          struct eqn_box   *root; /* root mathematical expression */
         DELIM_MIDDLE,          int               ln; /* invocation line */
         DELIM_CLOSE          int               pos; /* invocation position */
 };  };
   
 /*  /*
  * The type of parse sequence.  This value is usually passed via the   * Parse options.
  * mandoc(1) command line of -man and -mdoc.  It's almost exclusively  
  * -mandoc but the others have been retained for compatibility.  
  */   */
 enum    mparset {  #define MPARSE_MDOC     1  /* assume -mdoc */
         MPARSE_AUTO, /* magically determine the document type */  #define MPARSE_MAN      2  /* assume -man */
         MPARSE_MDOC, /* assume -mdoc */  #define MPARSE_SO       4  /* honour .so requests */
         MPARSE_MAN /* assume -man */  #define MPARSE_QUICK    8  /* abort the parse early */
   
   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, void *,  typedef void    (*mandocmsg)(enum mandocerr, enum mandoclevel,
                         int, int, const char *);                          const char *, int, int, const char *);
 typedef int     (*mevt_open)(void *, const char *);  
 typedef void    (*mevt_close)(void *, const char *);  
   
 struct  mparse;  struct  mparse;
   struct  mchars;
 struct  mdoc;  struct  mdoc;
 struct  man;  struct  man;
   
 __BEGIN_DECLS  __BEGIN_DECLS
   
   enum mandoc_esc   mandoc_escape(const char **, const char **, int *);
   struct mchars    *mchars_alloc(void);
   void              mchars_free(struct mchars *);
   char              mchars_num2char(const char *, size_t);
   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, char *);
 void              mparse_free(struct mparse *);  void              mparse_free(struct mparse *);
 void              mparse_reset(struct mparse *);  void              mparse_keep(struct mparse *);
 struct mparse    *mparse_alloc(enum mparset, mevt_open,  
                         mevt_close, mandocmsg, void *);  
 void              mparse_setstatus(struct mparse *, enum mandoclevel);  
 enum mandoclevel  mparse_readfd(struct mparse *, int, const char *);  enum mandoclevel  mparse_readfd(struct mparse *, int, const char *);
 void              mparse_result(struct mparse *, struct mdoc **, struct man **);  enum mandoclevel  mparse_readmem(struct mparse *, const void *, size_t,
                           const char *);
 void             *mandoc_calloc(size_t, size_t);  void              mparse_reset(struct mparse *);
 void             *mandoc_malloc(size_t);  void              mparse_result(struct mparse *,
 void             *mandoc_realloc(void *, size_t);                          struct mdoc **, struct man **, char **);
 #define DELIMSZ   6 /* hint: max possible size of a delimiter */  const char       *mparse_getkeep(const struct mparse *);
 enum mdelim       mandoc_isdelim(const char *);  const char       *mparse_strerror(enum mandocerr);
   const char       *mparse_strlevel(enum mandoclevel);
   
 __END_DECLS  __END_DECLS
   
Legend:
Removed from v.1.62  
changed lines
  Added in v.1.125
CVSweb