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

Diff for /mandoc/mdoc.h between version 1.20 and 1.29

version 1.20, 2009/01/12 12:52:21 version 1.29, 2009/02/20 07:43:15
Line 19 
Line 19 
 #ifndef MDOC_H  #ifndef MDOC_H
 #define MDOC_H  #define MDOC_H
   
 #define MDOC_LINEARG_MAX 12  /* What follows is a list of ALL possible macros. */
   
 #define MDOC___          0  #define MDOC___          0
 #define MDOC_Dd          1  #define MDOC_Dd          1
Line 129 
Line 129 
 #define MDOC_Ud          105  #define MDOC_Ud          105
 #define MDOC_MAX         106  #define MDOC_MAX         106
   
   /* What follows is a list of ALL possible macro arguments. */
   
 #define MDOC_Split       0  #define MDOC_Split       0
 #define MDOC_Nosplit     1  #define MDOC_Nosplit     1
 #define MDOC_Ragged      2  #define MDOC_Ragged      2
Line 193 
Line 195 
 #define MDOC_Symbolic    61  #define MDOC_Symbolic    61
 #define MDOC_ARG_MAX     62  #define MDOC_ARG_MAX     62
   
 enum    mdoc_err {  /* Warnings are either syntax or groff-compatibility. */
         ERR_SYNTAX_QUOTE, /* NOTUSED */  enum    mdoc_warn {
         ERR_SYNTAX_UNQUOTE,          WARN_SYNTAX,
         ERR_SYNTAX_NOPUNCT,          WARN_COMPAT
         ERR_SYNTAX_WS,  
         ERR_SYNTAX_ARG,  
         ERR_SYNTAX_ARGFORM,  
         ERR_SYNTAX_ARGVAL,  
         ERR_SYNTAX_ARGBAD,  
         ERR_SYNTAX_ARGMISS,  
         ERR_SYNTAX_ARGMANY,  
         ERR_MACRO_NOTSUP,  
         ERR_MACRO_NOTCALL,  
         ERR_SCOPE_BREAK,  
         ERR_SCOPE_NOCTX,  
         ERR_SCOPE_NONEST,  
         ERR_SEC_PROLOGUE,  
         ERR_SEC_NPROLOGUE,  
         ERR_SEC_PROLOGUE_OO,  
         ERR_SEC_PROLOGUE_REP,  
         ERR_SEC_NAME,  
         ERR_ARGS_EQ0,  
         ERR_ARGS_EQ1,  
         ERR_ARGS_GE1,  
         ERR_ARGS_LE2,  
         ERR_ARGS_LE8,  
         ERR_ARGS_MANY,  
         ERR_SYNTAX_CHILDBAD,  
         ERR_SYNTAX_PARENTBAD,  
         ERR_SYNTAX_CHILDHEAD,  
         ERR_SYNTAX_CHILDBODY,  
         ERR_SYNTAX_EMPTYBODY,  
         ERR_SYNTAX_EMPTYHEAD,  
         ERR_SYNTAX_NOTEXT  
 };  };
   
   /* Possible values for the `At' macro. */
 enum    mdoc_att {  enum    mdoc_att {
         ATT_DEFAULT = 0,          ATT_DEFAULT = 0,
         ATT_v1,          ATT_v1,
Line 245  enum mdoc_att {
Line 218  enum mdoc_att {
         ATT_V4          ATT_V4
 };  };
   
 enum    mdoc_warn {  /* An argument to a macro (multiple values = `It -column'). */
         WARN_SYNTAX_WS_EOLN,  
         WARN_SYNTAX_MACLIKE,  
         WARN_SYNTAX_ARGLIKE,  
         WARN_SYNTAX_QUOTED,  
         WARN_SYNTAX_EMPTYHEAD,  
         WARN_SYNTAX_EMPTYBODY,  
         WARN_SYNTAX_NOBODY,  
         WARN_IGN_AFTER_BLK,  
         WARN_IGN_BEFORE_BLK,  
         WARN_IGN_OBSOLETE,  
         WARN_SEC_OO,  
         WARN_SEC_REP,  
         WARN_ARGS_GE1,  
         WARN_ARGS_EQ0,  
         WARN_COMPAT_TROFF  
 };  
   
 struct  mdoc_arg {  struct  mdoc_arg {
         int               arg;          int               arg;
         int               line;          int               line;
Line 271  struct mdoc_arg {
Line 227  struct mdoc_arg {
         char            **value;          char            **value;
 };  };
   
   /* Type of a syntax node. */
 enum    mdoc_type {  enum    mdoc_type {
         MDOC_TEXT,          MDOC_TEXT,
         MDOC_ELEM,          MDOC_ELEM,
Line 281  enum mdoc_type {
Line 238  enum mdoc_type {
         MDOC_ROOT          MDOC_ROOT
 };  };
   
   /* Manual section. */
 enum    mdoc_msec {  enum    mdoc_msec {
         MSEC_DEFAULT = 0,          MSEC_DEFAULT = 0,
         MSEC_1,          MSEC_1,
Line 303  enum mdoc_msec {
Line 261  enum mdoc_msec {
         MSEC_paper          MSEC_paper
 };  };
   
   /* Section (named/unnamed) of `Ss'. */
 enum    mdoc_sec {  enum    mdoc_sec {
         SEC_PROLOGUE = 0,          SEC_PROLOGUE = 0,
         SEC_BODY,          SEC_BODY,
Line 324  enum mdoc_sec {
Line 283  enum mdoc_sec {
         SEC_CUSTOM          SEC_CUSTOM
 };  };
   
   /* Volume of `Dt'. */
 enum    mdoc_vol {  enum    mdoc_vol {
         VOL_DEFAULT = 0,          VOL_DEFAULT = 0,
         VOL_AMD,          VOL_AMD,
Line 337  enum mdoc_vol {
Line 297  enum mdoc_vol {
         VOL_USD          VOL_USD
 };  };
   
   /* Architecture of `Dt'. */
 enum    mdoc_arch {  enum    mdoc_arch {
         ARCH_DEFAULT = 0,          ARCH_DEFAULT = 0,
         ARCH_alpha,          ARCH_alpha,
         ARCH_amd64,          ARCH_amd64,
         ARCH_amiga,          ARCH_amiga,
         ARCH_arc,          ARCH_arc,
           ARCH_arm,
         ARCH_armish,          ARCH_armish,
         ARCH_aviion,          ARCH_aviion,
         ARCH_hp300,          ARCH_hp300,
Line 366  enum mdoc_arch {
Line 328  enum mdoc_arch {
         ARCH_zaurus          ARCH_zaurus
 };  };
   
   /* Information from prologue. */
 struct  mdoc_meta {  struct  mdoc_meta {
         enum mdoc_msec    msec;          enum mdoc_msec    msec;
         enum mdoc_vol     vol;          enum mdoc_vol     vol;
         enum mdoc_arch    arch;          enum mdoc_arch    arch;
         time_t            date;          time_t            date;
 #define META_TITLE_SZ    (64)          char             *title;
         char              title[META_TITLE_SZ];          char             *os;
 #define META_OS_SZ       (64)          char             *name;
         char              os[META_OS_SZ];  
 };  };
   
   /* Text-only node. */
 struct  mdoc_text {  struct  mdoc_text {
         char             *string;          char             *string;
 };  };
   
   /* Block (scoped) node. */
 struct  mdoc_block {  struct  mdoc_block {
         size_t            argc;          size_t            argc;
         struct mdoc_arg  *argv;          struct mdoc_arg  *argv;
Line 389  struct mdoc_block {
Line 353  struct mdoc_block {
         struct mdoc_node *tail;          struct mdoc_node *tail;
 };  };
   
   /* In-line element node. */
 struct  mdoc_elem {  struct  mdoc_elem {
         size_t            sz;          size_t            sz;
         char            **args;          char            **args;
Line 396  struct mdoc_elem {
Line 361  struct mdoc_elem {
         struct mdoc_arg  *argv;          struct mdoc_arg  *argv;
 };  };
   
   /* Typed nodes of an AST node. */
 union   mdoc_data {  union   mdoc_data {
         struct mdoc_text  text;          struct mdoc_text  text;
         struct mdoc_elem  elem;          struct mdoc_elem  elem;
         struct mdoc_block block;          struct mdoc_block block;
 };  };
   
   /* Node in AST. */
 struct  mdoc_node {  struct  mdoc_node {
         struct mdoc_node *parent;          struct mdoc_node *parent;
         struct mdoc_node *child;          struct mdoc_node *child;
Line 410  struct mdoc_node {
Line 377  struct mdoc_node {
         int               line;          int               line;
         int               pos;          int               pos;
         int               tok;          int               tok;
           int               flags;
   #define MDOC_VALID       (1 << 0)
   #define MDOC_ACTED       (1 << 1)
         enum mdoc_type    type;          enum mdoc_type    type;
         union mdoc_data   data;          union mdoc_data   data;
           /* FIXME: have an enum mdoc_sec. */
 };  };
   
   /* Call-backs for parse messages. */
 struct  mdoc_cb {  struct  mdoc_cb {
         int     (*mdoc_err)(void *, int, int, enum mdoc_err);  
         int     (*mdoc_warn)(void *, int, int, enum mdoc_warn);  
         void    (*mdoc_msg)(void *, int, int, const char *);          void    (*mdoc_msg)(void *, int, int, const char *);
           int     (*mdoc_err)(void *, int, int, const char *);
           int     (*mdoc_warn)(void *, int, int,
                           enum mdoc_warn, const char *);
 };  };
   
   /* Global table of macro names (`Bd', `Ed', etc.). */
 extern  const char *const *mdoc_macronames;  extern  const char *const *mdoc_macronames;
   
   /* Global table of argument names (`column', `tag', etc.). */
 extern  const char *const *mdoc_argnames;  extern  const char *const *mdoc_argnames;
   
 __BEGIN_DECLS  __BEGIN_DECLS
   
 struct  mdoc;  struct  mdoc;
   
   /* Free memory allocated with mdoc_alloc. */
 void              mdoc_free(struct mdoc *);  void              mdoc_free(struct mdoc *);
   
   /* Allocate a new parser instance. */
 struct  mdoc     *mdoc_alloc(void *data, const struct mdoc_cb *);  struct  mdoc     *mdoc_alloc(void *data, const struct mdoc_cb *);
   
   /* Parse a single line in a stream (boolean retval). */
 int               mdoc_parseln(struct mdoc *, int, char *buf);  int               mdoc_parseln(struct mdoc *, int, char *buf);
 const struct mdoc_node  
                  *mdoc_result(struct mdoc *);  /* Get result first node (after mdoc_endparse!). */
   const struct mdoc_node *mdoc_node(struct mdoc *);
   
   /* Get result meta-information (after mdoc_endparse!). */
   const struct mdoc_meta *mdoc_meta(struct mdoc *);
   
   /* Signal end of parse sequence (boolean retval). */
 int               mdoc_endparse(struct mdoc *);  int               mdoc_endparse(struct mdoc *);
   
 __END_DECLS  __END_DECLS
Legend:
Removed from v.1.20  
changed lines
  Added in v.1.29
CVSweb