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

Diff for /mandoc/mandoc.h between version 1.43 and 1.65

version 1.43, 2011/01/02 10:10:57 version 1.65, 2011/03/22 09:48:13
Line 1 
Line 1 
 /*      $Id$ */  /*      $Id$ */
 /*  /*
  * Copyright (c) 2010 Kristaps Dzonsons <kristaps@bsd.lv>   * Copyright (c) 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
  *   *
  * 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 50  enum mandocerr {
Line 50  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_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 68  enum mandocerr {
Line 69  enum mandocerr {
         /* 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_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 */
Line 75  enum mandocerr {
Line 77  enum mandocerr {
   
         /* 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 103  enum mandocerr {
         MANDOCERR_BADESCAPE, /* unknown escape sequence */          MANDOCERR_BADESCAPE, /* unknown escape sequence */
         MANDOCERR_BADQUOTE, /* unterminated quoted string */          MANDOCERR_BADQUOTE, /* unterminated quoted string */
   
         /* related to tables */  
         MANDOCERR_TBLEXTRADAT, /* extra data cells */  
   
         MANDOCERR_ERROR, /* ===== start of errors ===== */          MANDOCERR_ERROR, /* ===== start of errors ===== */
   
         /* related to tables */          /* related to tables */
Line 110  enum mandocerr {
Line 111  enum mandocerr {
         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_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_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 */
Line 149  struct tbl {
Line 154  struct tbl {
         char              tab; /* cell-separator */          char              tab; /* cell-separator */
         char              decimal; /* decimal point */          char              decimal; /* decimal point */
         int               linesize;          int               linesize;
         char              delims[2];  
         int               opts;          int               opts;
 #define TBL_OPT_CENTRE   (1 << 0)  #define TBL_OPT_CENTRE   (1 << 0)
 #define TBL_OPT_EXPAND   (1 << 1)  #define TBL_OPT_EXPAND   (1 << 1)
Line 158  struct tbl {
Line 162  struct tbl {
 #define TBL_OPT_ALLBOX   (1 << 4)  #define TBL_OPT_ALLBOX   (1 << 4)
 #define TBL_OPT_NOKEEP   (1 << 5)  #define TBL_OPT_NOKEEP   (1 << 5)
 #define TBL_OPT_NOSPACE  (1 << 6)  #define TBL_OPT_NOSPACE  (1 << 6)
           int               cols; /* number of columns */
 };  };
   
 enum    tbl_headt {  enum    tbl_headt {
Line 173  enum tbl_headt {
Line 178  enum tbl_headt {
  */   */
 struct  tbl_head {  struct  tbl_head {
         enum tbl_headt    pos;          enum tbl_headt    pos;
         int               width; /* width of cell in fixed chars */          int               ident; /* 0 <= unique id < cols */
         int               decimal; /* decimal point position */  
         struct tbl_head  *next;          struct tbl_head  *next;
         struct tbl_head  *prev;          struct tbl_head  *prev;
 };  };
Line 200  enum tbl_cellt {
Line 204  enum tbl_cellt {
 struct  tbl_cell {  struct  tbl_cell {
         struct tbl_cell  *next;          struct tbl_cell  *next;
         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 222  struct tbl_row {
Line 226  struct tbl_row {
 };  };
   
 enum    tbl_datt {  enum    tbl_datt {
         TBL_DATA_DATA,          TBL_DATA_NONE, /* has no data */
         TBL_DATA_HORIZ,          TBL_DATA_DATA, /* consists of data/string */
         TBL_DATA_DHORIZ,          TBL_DATA_HORIZ, /* horizontal line */
         TBL_DATA_NHORIZ,          TBL_DATA_DHORIZ, /* double-horizontal line */
         TBL_DATA_NDHORIZ          TBL_DATA_NHORIZ, /* squeezed horizontal line */
           TBL_DATA_NDHORIZ /* squeezed double-horizontal line */
 };  };
   
 /*  /*
Line 234  enum tbl_datt {
Line 239  enum tbl_datt {
  * 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) */
         enum tbl_datt     pos;          enum tbl_datt     pos;
 };  };
   
Line 250  enum tbl_spant {
Line 256  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_row   *layout; /* layout row: CAN BE NULL */          struct tbl       *tbl;
           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;
   #define TBL_SPAN_FIRST   (1 << 0)
   #define TBL_SPAN_LAST    (1 << 1)
         enum tbl_spant    pos;          enum tbl_spant    pos;
         struct tbl_span  *next;          struct tbl_span  *next;
 };  };
   
 /*  struct  eqn {
  * Available registers (set in libroff, accessed elsewhere).          size_t            sz;
  */          char             *data;
 enum    regs {          int               line; /* invocation line */
         REG_nS = 0,          int               pos; /* invocation position */
         REG__MAX  
 };  };
   
 /*  /*
  * A register (struct reg) can consist of many types: this consists of   * A punctuation delimiter, used only in mdoc(7) documents, is opening,
  * normalised types from the original string form.   * closing, or "middle mark" punctuation.  These govern spacing.
    * 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.
  */   */
 union   regval {  enum    mdelim {
         unsigned  u; /* unsigned integer */          DELIM_NONE = 0,
           DELIM_OPEN,
           DELIM_MIDDLE,
           DELIM_CLOSE
 };  };
   
 /*  /*
  * A single register entity.  If "set" is zero, the value of the   * The type of parse sequence.  This value is usually passed via the
  * register should be the default one, which is per-register.  It's   * mandoc(1) command line of -man and -mdoc.  It's almost exclusively
  * assumed that callers know which type in "v" corresponds to which   * -mandoc but the others have been retained for compatibility.
  * register value.  
  */   */
 struct  reg {  enum    mparset {
         int               set; /* whether set or not */          MPARSE_AUTO, /* magically determine the document type */
         union regval      v; /* parsed data */          MPARSE_MDOC, /* assume -mdoc */
           MPARSE_MAN /* assume -man */
 };  };
   
 /*  typedef void    (*mandocmsg)(enum mandocerr, enum mandoclevel,
  * The primary interface to setting register values is in libroff,                          const char *, int, int, const char *);
  * although libmdoc and libman from time to time will manipulate  
  * registers (such as `.Sh SYNOPSIS' enabling REG_nS).  
  */  
 struct  regset {  
         struct reg        regs[REG__MAX];  
 };  
   
   struct  mparse;
   struct  mdoc;
   struct  man;
   
 __BEGIN_DECLS  __BEGIN_DECLS
   
 /*  void              mparse_free(struct mparse *);
  * Callback function for warnings, errors, and fatal errors as they  void              mparse_reset(struct mparse *);
  * occur in the compilers libroff, libmdoc, and libman.  struct mparse    *mparse_alloc(enum mparset,
  */                          enum mandoclevel, mandocmsg, void *);
 typedef int             (*mandocmsg)(enum mandocerr, void *,  enum mandoclevel  mparse_readfd(struct mparse *, int, const char *);
                                 int, int, const char *);  void              mparse_result(struct mparse *, struct mdoc **, struct man **);
   
   void             *mandoc_calloc(size_t, size_t);
   void             *mandoc_malloc(size_t);
   void             *mandoc_realloc(void *, size_t);
   #define DELIMSZ   6 /* hint: max possible size of a delimiter */
   enum mdelim       mandoc_isdelim(const char *);
   
 __END_DECLS  __END_DECLS
   
Legend:
Removed from v.1.43  
changed lines
  Added in v.1.65
CVSweb