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

Diff for /mandoc/mandoc.h between version 1.38 and 1.118

version 1.38, 2010/12/31 18:19:43 version 1.118, 2014/03/23 11:25:26
Line 1 
Line 1 
 /*      $Id$ */  /*      $Id$ */
 /*  /*
  * Copyright (c) 2010 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 50  enum mandocerr {
Line 52  enum mandocerr {
         MANDOCERR_NOTITLE, /* no title in document */          MANDOCERR_NOTITLE, /* no title in document */
         MANDOCERR_UPPERCASE, /* document title should be all caps */          MANDOCERR_UPPERCASE, /* document title should be all caps */
         MANDOCERR_BADMSEC, /* unknown manual section */          MANDOCERR_BADMSEC, /* unknown manual section */
         MANDOCERR_BADDATE, /* cannot parse date argument */          MANDOCERR_BADVOLARCH, /* unknown manual volume or arch */
           MANDOCERR_NODATE, /* date missing, using today's date */
           MANDOCERR_BADDATE, /* cannot parse date, using it verbatim */
         MANDOCERR_PROLOGOOO, /* prologue macros out of order */          MANDOCERR_PROLOGOOO, /* prologue macros out of order */
         MANDOCERR_PROLOGREP, /* duplicate prologue macro */          MANDOCERR_PROLOGREP, /* duplicate prologue macro */
         MANDOCERR_BADPROLOG, /* macro not allowed in prologue */          MANDOCERR_BADPROLOG, /* macro not allowed in prologue */
Line 60  enum mandocerr {
Line 64  enum mandocerr {
         MANDOCERR_SO, /* .so is fragile, better use ln(1) */          MANDOCERR_SO, /* .so is fragile, better use ln(1) */
         MANDOCERR_NAMESECFIRST, /* NAME section must come first */          MANDOCERR_NAMESECFIRST, /* NAME section must come first */
         MANDOCERR_BADNAMESEC, /* bad NAME section contents */          MANDOCERR_BADNAMESEC, /* bad NAME section contents */
         MANDOCERR_NONAME, /* manual name not yet set */  
         MANDOCERR_SECOOO, /* sections out of conventional order */          MANDOCERR_SECOOO, /* sections out of conventional order */
         MANDOCERR_SECREP, /* duplicate section name */          MANDOCERR_SECREP, /* duplicate section name */
         MANDOCERR_SECMSEC, /* section not in conventional manual section */          MANDOCERR_SECMSEC, /* section header suited to sections ... */
   
         /* 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_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 */
           MANDOCERR_ARGCWARN, /* argument count wrong */
         MANDOCERR_DISPTYPE, /* missing display type */          MANDOCERR_DISPTYPE, /* missing display type */
         MANDOCERR_LISTFIRST, /* list type must come first */          MANDOCERR_LISTFIRST, /* list type must come first */
         MANDOCERR_NOWIDTHARG, /* tag lists require a width argument */          MANDOCERR_NOWIDTHARG, /* tag lists require a width argument */
         MANDOCERR_FONTTYPE, /* missing font type */          MANDOCERR_FONTTYPE, /* missing font type */
           MANDOCERR_WNOSCOPE, /* skipping end of block that is not open */
   
         /* related to bad macro arguments */          /* related to bad macro arguments */
         MANDOCERR_IGNARGV, /* skipping argument */          MANDOCERR_IGNARGV, /* skipping argument */
Line 99  enum mandocerr {
Line 107  enum mandocerr {
         MANDOCERR_BADESCAPE, /* unknown escape sequence */          MANDOCERR_BADESCAPE, /* unknown escape sequence */
         MANDOCERR_BADQUOTE, /* unterminated quoted string */          MANDOCERR_BADQUOTE, /* unterminated quoted string */
   
           /* related to equations */
           MANDOCERR_EQNQUOTE, /* unexpected literal in equation */
   
         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 */
         MANDOCERR_TBL, /* bad table syntax */          MANDOCERR_TBL, /* bad table syntax */
         MANDOCERR_TBLOPT, /* bad table option */          MANDOCERR_TBLOPT, /* bad table option */
         MANDOCERR_TBLLAYOUT, /* bad table layout */          MANDOCERR_TBLLAYOUT, /* bad table layout */
         MANDOCERR_TBLNOLAYOUT, /* no table layout cells specified */          MANDOCERR_TBLNOLAYOUT, /* no table layout cells specified */
           MANDOCERR_TBLNODATA, /* no table data cells specified */
           MANDOCERR_TBLIGNDATA, /* ignore data in cell */
           MANDOCERR_TBLBLOCK, /* data block still open */
           MANDOCERR_TBLEXTRADAT, /* ignoring extra data cells */
   
         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_NONAME, /* manual name not yet set */
         MANDOCERR_NOTEXT, /* skipping text before the first section header */          MANDOCERR_NOTEXT, /* skipping text before the 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 120  enum mandocerr {
Line 146  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_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, /* manual isn't really 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 */
Line 136  enum mandocerr {
Line 164  enum mandocerr {
         MANDOCERR_NODOCBODY, /* no document body */          MANDOCERR_NODOCBODY, /* no document body */
         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_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 */
   };
   
   /*
    * 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.
    */
   struct  tbl_head {
           int               ident; /* 0 <= unique id < cols */
           int               vert; /* width of preceding vertical line */
           struct tbl_head  *next;
           struct tbl_head  *prev;
   };
   
 enum    tbl_cellt {  enum    tbl_cellt {
         TBL_CELL_CENTRE, /* c, C */          TBL_CELL_CENTRE, /* c, C */
         TBL_CELL_RIGHT, /* r, R */          TBL_CELL_RIGHT, /* r, R */
Line 149  enum tbl_cellt {
Line 211  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 159  enum tbl_cellt {
Line 219  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;
         int               spacing;          size_t            spacing;
         int               flags;          int               flags;
 #define TBL_CELL_TALIGN  (1 << 0) /* t, T */  #define TBL_CELL_TALIGN  (1 << 0) /* t, T */
 #define TBL_CELL_BALIGN  (1 << 1) /* d, D */  #define TBL_CELL_BALIGN  (1 << 1) /* d, D */
Line 169  struct tbl_cell {
Line 230  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 */
           struct tbl_head  *head;
 };  };
   
 /*  /*
Line 180  struct tbl_row {
Line 242  struct tbl_row {
         struct tbl_cell  *last;          struct tbl_cell  *last;
 };  };
   
   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 */
   };
   
 /*  /*
  * A cell within a row of data.  The "string" field contains the actual   * A cell within a row of data.  The "string" field contains the actual
  * string value that's in the cell.  The rest is layout.   * string value that's in the cell.  The rest is layout.
  */   */
 struct  tbl_dat {  struct  tbl_dat {
         struct tbl_cell  *layout; /* layout cell: CAN BE NULL */          struct tbl_cell  *layout; /* layout cell */
           int               spans; /* how many spans follow */
         struct tbl_dat   *next;          struct tbl_dat   *next;
         char             *string;          char             *string; /* data (NULL if not TBL_DATA_DATA) */
         int               flags;          enum tbl_datt     pos;
 #define TBL_DATA_HORIZ   (1 << 0)  
 #define TBL_DATA_DHORIZ  (1 << 1)  
 #define TBL_DATA_NHORIZ  (1 << 2)  
 #define TBL_DATA_NDHORIZ (1 << 3)  
 };  };
   
   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 */
   };
   
 /*  /*
  * A row of data in a table.   * A row of data in a table.
  */   */
 struct  tbl_span {  struct  tbl_span {
         struct tbl_row   *layout; /* layout row: CAN BE NULL */          struct tbl_opts  *opts;
           struct tbl_head  *head;
           struct tbl_row   *layout; /* layout row */
         struct tbl_dat   *first;          struct tbl_dat   *first;
         struct tbl_dat   *last;          struct tbl_dat   *last;
           int               line; /* parse line */
         int               flags;          int               flags;
 #define TBL_SPAN_HORIZ  (1 << 0)  #define TBL_SPAN_FIRST   (1 << 0)
 #define TBL_SPAN_DHORIZ (1 << 1)  #define TBL_SPAN_LAST    (1 << 1)
           enum tbl_spant    pos;
         struct tbl_span  *next;          struct tbl_span  *next;
 };  };
   
 /*  enum    eqn_boxt {
  * Available registers (set in libroff, accessed elsewhere).          EQN_ROOT, /* root of parse tree */
  */          EQN_TEXT, /* text (number, variable, whatever) */
 enum    regs {          EQN_SUBEXPR, /* nested `eqn' subexpression */
         REG_nS = 0,          EQN_LIST, /* subexpressions list */
         REG__MAX          EQN_MATRIX /* matrix subexpression */
 };  };
   
 /*  enum    eqn_markt {
  * A register (struct reg) can consist of many types: this consists of          EQNMARK_NONE = 0,
  * normalised types from the original string form.          EQNMARK_DOT,
           EQNMARK_DOTDOT,
           EQNMARK_HAT,
           EQNMARK_TILDE,
           EQNMARK_VEC,
           EQNMARK_DYAD,
           EQNMARK_BAR,
           EQNMARK_UNDER,
           EQNMARK__MAX
   };
   
   enum    eqn_fontt {
           EQNFONT_NONE = 0,
           EQNFONT_ROMAN,
           EQNFONT_BOLD,
           EQNFONT_FAT,
           EQNFONT_ITALIC,
           EQNFONT__MAX
   };
   
   enum    eqn_post {
           EQNPOS_NONE = 0,
           EQNPOS_OVER,
           EQNPOS_SUP,
           EQNPOS_SUB,
           EQNPOS_TO,
           EQNPOS_FROM,
           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.
  */   */
 union   regval {  struct  eqn_box {
         unsigned  u; /* unsigned integer */          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 single register entity.  If "set" is zero, the value of the   * An equation consists of a tree of expressions starting at a given
  * register should be the default one, which is per-register.  It's   * line and position.
  * assumed that callers know which type in "v" corresponds to which  
  * register value.  
  */   */
 struct  reg {  struct  eqn {
         int               set; /* whether set or not */          char             *name; /* identifier (or NULL) */
         union regval      v; /* parsed data */          struct eqn_box   *root; /* root mathematical expression */
           int               ln; /* invocation line */
           int               pos; /* invocation position */
 };  };
   
 /*  /*
  * 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 */
   
   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  __BEGIN_DECLS
   
 /*  enum mandoc_esc   mandoc_escape(const char **, const char **, int *);
  * Callback function for warnings, errors, and fatal errors as they  struct mchars    *mchars_alloc(void);
  * occur in the compilers libroff, libmdoc, and libman.  void              mchars_free(struct mchars *);
  */  char              mchars_num2char(const char *, size_t);
 typedef int             (*mandocmsg)(enum mandocerr, void *,  int               mchars_num2uc(const char *, size_t);
                                 int, int, const char *);  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_keep(struct mparse *);
   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);
   
 __END_DECLS  __END_DECLS
   
Legend:
Removed from v.1.38  
changed lines
  Added in v.1.118
CVSweb