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

Diff for /mandoc/mandoc.h between version 1.61 and 1.92

version 1.61, 2011/03/17 12:08:01 version 1.92, 2011/07/23 12:01:54
Line 74  enum mandocerr {
Line 74  enum mandocerr {
         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 103  enum mandocerr {
Line 104  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_EQNNEST, /* too many nested equation defines */
           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 121  enum mandocerr {
Line 133  enum mandocerr {
         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_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 */
Line 137  enum mandocerr {
Line 148  enum mandocerr {
   
         MANDOCERR_FATAL, /* ===== start of fatal errors ===== */          MANDOCERR_FATAL, /* ===== start of fatal errors ===== */
   
           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_SYNTLINESCOPE, /* line scope broken, syntax violated */
Line 269  struct tbl_span {
Line 281  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_ITALIC,
         unsigned  u; /* unsigned integer */          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,
           EQNPOS_FROM,
           EQNPOS__MAX
   };
   
   enum    eqn_pilet {
           EQNPILE_NONE = 0,
           EQNPILE_CPILE,
           EQNPILE_RPILE,
           EQNPILE_LPILE,
           EQNPILE_CCOL,
           EQNPILE_RCOL,
           EQNPILE_LCOL,
           EQNPILE__MAX
   };
   
    /*
    * A "box" is a parsed mathematical expression as defined by the eqn.7
    * grammar.
  */   */
 struct  reg {  struct  eqn_box {
         int               set; /* whether set or not */          int               size; /* font size of expression */
         union regval      v; /* parsed data */  #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 */
 };  };
   
 /*  /*
  * The primary interface to setting register values is in libroff,   * An equation consists of a tree of expressions starting at a given
  * although libmdoc and libman from time to time will manipulate   * line and position.
  * registers (such as `.Sh SYNOPSIS' enabling REG_nS).  
  */   */
 struct  regset {  struct  eqn {
         struct reg        regs[REG__MAX];          struct eqn_box   *root; /* root mathematical expression */
           int               ln; /* invocation line */
           int               pos; /* invocation position */
 };  };
   
 /*  /*
  * A punctuation delimiter, used only in mdoc(7) documents, is opening,   * The type of parse sequence.  This value is usually passed via the
  * closing, or "middle mark" punctuation.  These govern spacing.   * mandoc(1) command line of -man and -mdoc.  It's almost exclusively
  * Opening punctuation (e.g., the opening parenthesis) suppresses the   * -mandoc but the others have been retained for compatibility.
  * 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 {  enum    mparset {
         DELIM_NONE = 0,          MPARSE_AUTO, /* magically determine the document type */
         DELIM_OPEN,          MPARSE_MDOC, /* assume -mdoc */
         DELIM_MIDDLE,          MPARSE_MAN /* assume -man */
         DELIM_CLOSE  
 };  };
   
 typedef void    (*mandocmsg)(enum mandocerr, void *,  enum    mandoc_esc {
                         int, int, const char *);          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_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 */
   };
   
   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
   
   void              mparse_free(struct mparse *);
   void              mparse_reset(struct mparse *);
   struct mparse    *mparse_alloc(enum mparset,
                           enum mandoclevel, mandocmsg, void *);
   enum mandoclevel  mparse_readfd(struct mparse *, int, const char *);
   void              mparse_result(struct mparse *, struct mdoc **, struct man **);
   const char       *mparse_strerror(enum mandocerr);
   const char       *mparse_strlevel(enum mandoclevel);
   
 void             *mandoc_calloc(size_t, size_t);  void             *mandoc_calloc(size_t, size_t);
 void             *mandoc_malloc(size_t);  void             *mandoc_malloc(size_t);
 void             *mandoc_realloc(void *, size_t);  void             *mandoc_realloc(void *, size_t);
 #define DELIMSZ   6 /* hint: max possible size of a delimiter */  char             *mandoc_strdup(const char *);
 enum mdelim       mandoc_isdelim(const char *);  char             *mandoc_strndup(const char *, size_t);
   
   enum mandoc_esc   mandoc_escape(const char **, const char **, int *);
   
   struct mchars    *mchars_alloc(void);
   char              mchars_num2char(const char *, size_t);
   int               mchars_num2uc(const char *, size_t);
   const char       *mchars_spec2str(struct mchars *, const char *, size_t, size_t *);
   int               mchars_spec2cp(struct mchars *, const char *, size_t);
   void              mchars_free(struct mchars *);
   
   
 __END_DECLS  __END_DECLS
   
Legend:
Removed from v.1.61  
changed lines
  Added in v.1.92
CVSweb