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

Diff for /mandoc/mdoc.h between version 1.103 and 1.105

version 1.103, 2010/08/20 01:02:07 version 1.105, 2010/10/04 07:01:02
Line 17 
Line 17 
 #ifndef MDOC_H  #ifndef MDOC_H
 #define MDOC_H  #define MDOC_H
   
 /*  /*
  * This library implements a validating scanner/parser for ``mdoc'' roff   * What follows is a list of ALL possible macros.
  * macro documents, a.k.a. BSD manual page documents.  The mdoc.c file  
  * drives the parser, while macro.c describes the macro ontologies.  
  * validate.c pre- and post-validates parsed macros, and action.c  
  * performs actions on parsed and validated macros.  
  */   */
   
 /* What follows is a list of ALL possible macros. */  
   
 enum    mdoct {  enum    mdoct {
         MDOC_Ap = 0,          MDOC_Ap = 0,
         MDOC_Dd,          MDOC_Dd,
Line 153  enum mdoct {
Line 146  enum mdoct {
         MDOC_MAX          MDOC_MAX
 };  };
   
 /* What follows is a list of ALL possible macro arguments. */  /*
    * What follows is a list of ALL possible macro arguments.
    */
 enum    mdocargt {  enum    mdocargt {
         MDOC_Split,          MDOC_Split,
         MDOC_Nosplit,          MDOC_Nosplit,
Line 186  enum mdocargt {
Line 180  enum mdocargt {
         MDOC_ARG_MAX          MDOC_ARG_MAX
 };  };
   
 /* Type of a syntax node. */  /*
    * Type of a syntax node.
    */
 enum    mdoc_type {  enum    mdoc_type {
         MDOC_TEXT,          MDOC_TEXT,
         MDOC_ELEM,          MDOC_ELEM,
Line 197  enum mdoc_type {
Line 193  enum mdoc_type {
         MDOC_ROOT          MDOC_ROOT
 };  };
   
 /* Section (named/unnamed) of `Sh'. */  /*
    * Section (named/unnamed) of `Sh'.   Note that these appear in the
    * conventional order imposed by mdoc.7.
    */
 enum    mdoc_sec {  enum    mdoc_sec {
         SEC_NONE,               /* No section, yet. */          SEC_NONE = 0, /* No section, yet. */
         SEC_NAME,          SEC_NAME,
         SEC_LIBRARY,          SEC_LIBRARY,
         SEC_SYNOPSIS,          SEC_SYNOPSIS,
Line 220  enum mdoc_sec {
Line 219  enum mdoc_sec {
         SEC_CAVEATS,          SEC_CAVEATS,
         SEC_BUGS,          SEC_BUGS,
         SEC_SECURITY,          SEC_SECURITY,
         SEC_CUSTOM,             /* User-defined. */          SEC_CUSTOM, /* User-defined. */
         SEC__MAX          SEC__MAX
 };  };
   
 /* Information from prologue. */  /*
    * Information from prologue.
    */
 struct  mdoc_meta {  struct  mdoc_meta {
         char             *msec;          char             *msec; /* `Dt' section (1, 3p, etc.) */
         char             *vol;          char             *vol; /* `Dt' volume (implied) */
         char             *arch;          char             *arch; /* `Dt' arch (i386, etc.) */
         time_t            date;          time_t            date; /* `Dd' normalised date */
         char             *title;          char             *title; /* `Dt' title (FOO, etc.) */
         char             *os;          char             *os; /* `Os' system (OpenBSD, etc.) */
         char             *name;          char             *name; /* leading `Nm' name */
 };  };
   
 /* An argument to a macro (multiple values = `It -column'). */  /*
    * An argument to a macro (multiple values = `-column xxx yyy').
    */
 struct  mdoc_argv {  struct  mdoc_argv {
         enum mdocargt     arg;          enum mdocargt     arg; /* type of argument */
         int               line;          int               line;
         int               pos;          int               pos;
         size_t            sz;          size_t            sz; /* elements in "value" */
         char            **value;          char            **value; /* argument strings */
 };  };
   
   /*
    * Reference-counted macro arguments.  These are refcounted because
    * blocks have multiple instances of the same arguments spread across
    * the HEAD, BODY, TAIL, and BLOCK node types.
    */
 struct  mdoc_arg {  struct  mdoc_arg {
         size_t            argc;          size_t            argc;
         struct mdoc_argv *argv;          struct mdoc_argv *argv;
         unsigned int      refcnt;          unsigned int      refcnt;
 };  };
   
   /*
    * Indicates that a BODY's formatting has ended, but the scope is still
    * open.  Used for syntax-broken blocks.
    */
 enum    mdoc_endbody {  enum    mdoc_endbody {
         ENDBODY_NOT = 0,          ENDBODY_NOT = 0,
         ENDBODY_SPACE,          ENDBODY_SPACE, /* is broken: append a space */
         ENDBODY_NOSPACE          ENDBODY_NOSPACE /* is broken: don't append a space */
 };  };
   
   /*
    * Normalised `Bl' list type.
    */
 enum    mdoc_list {  enum    mdoc_list {
         LIST__NONE = 0,          LIST__NONE = 0,
         LIST_bullet,          LIST_bullet,
Line 271  enum mdoc_list {
Line 286  enum mdoc_list {
         LIST_tag          LIST_tag
 };  };
   
   /*
    * Normalised `Bd' display type.
    */
 enum    mdoc_disp {  enum    mdoc_disp {
         DISP__NONE = 0,          DISP__NONE = 0,
         DISP_centred,          DISP_centred,
Line 280  enum mdoc_disp {
Line 298  enum mdoc_disp {
         DISP_literal          DISP_literal
 };  };
   
   /*
    * Normalised `An' splitting argument.
    */
 enum    mdoc_auth {  enum    mdoc_auth {
         AUTH__NONE = 0,          AUTH__NONE = 0,
         AUTH_split,          AUTH_split,
         AUTH_nosplit          AUTH_nosplit
 };  };
   
   /*
    * Normalised `Bf' font type.
    */
 enum    mdoc_font {  enum    mdoc_font {
         FONT__NONE = 0,          FONT__NONE = 0,
         FONT_Em,          FONT_Em,
Line 293  enum mdoc_font {
Line 317  enum mdoc_font {
         FONT_Sy          FONT_Sy
 };  };
   
   /*
    * Normalised arguments for `Bd'.
    */
 struct  mdoc_bd {  struct  mdoc_bd {
         const char       *offs; /* -offset */          const char       *offs; /* -offset */
         enum mdoc_disp    type; /* -ragged, etc. */          enum mdoc_disp    type; /* -ragged, etc. */
         int               comp; /* -compact */          int               comp; /* -compact */
 };  };
   
   /*
    * Normalised arguments for `Bl'.
    */
 struct  mdoc_bl {  struct  mdoc_bl {
         const char       *width; /* -width */          const char       *width; /* -width */
         const char       *offs; /* -offset */          const char       *offs; /* -offset */
Line 308  struct mdoc_bl {
Line 338  struct mdoc_bl {
         const char      **cols; /* -column val ptr */          const char      **cols; /* -column val ptr */
 };  };
   
   /*
    * Normalised arguments for `Bf'.
    */
 struct  mdoc_bf {  struct  mdoc_bf {
         enum mdoc_font    font; /* font */          enum mdoc_font    font; /* font */
 };  };
   
   /*
    * Normalised arguments for `An'.
    */
 struct  mdoc_an {  struct  mdoc_an {
         enum mdoc_auth    auth; /* -split, etc. */          enum mdoc_auth    auth; /* -split, etc. */
 };  };
   
 /* Node in AST. */  /*
    * Consists of normalised node arguments.  These should be used instead
    * of iterating through the mdoc_arg pointers of a node: defaults are
    * provided, etc.
    */
   union mdoc_data {
           struct mdoc_an    An;
           struct mdoc_bd   *Bd;
           struct mdoc_bf   *Bf;
           struct mdoc_bl   *Bl;
   };
   
   /*
    * Single node in tree-linked AST.
    */
 struct  mdoc_node {  struct  mdoc_node {
         struct mdoc_node *parent; /* parent AST node */          struct mdoc_node *parent; /* parent AST node */
         struct mdoc_node *child; /* first child AST node */          struct mdoc_node *child; /* first child AST node */
Line 336  struct mdoc_node {
Line 386  struct mdoc_node {
         enum mdoc_type    type; /* AST node type */          enum mdoc_type    type; /* AST node type */
         enum mdoc_sec     sec; /* current named section */          enum mdoc_sec     sec; /* current named section */
         /* FIXME: these can be union'd to shave a few bytes. */          /* FIXME: these can be union'd to shave a few bytes. */
         struct mdoc_arg  *args;         /* BLOCK/ELEM */          struct mdoc_arg  *args; /* BLOCK/ELEM */
         struct mdoc_node *pending;      /* BLOCK */          struct mdoc_node *pending; /* BLOCK */
         struct mdoc_node *head;         /* BLOCK */          struct mdoc_node *head; /* BLOCK */
         struct mdoc_node *body;         /* BLOCK */          struct mdoc_node *body; /* BLOCK */
         struct mdoc_node *tail;         /* BLOCK */          struct mdoc_node *tail; /* BLOCK */
         char             *string;       /* TEXT */          char             *string; /* TEXT */
         enum mdoc_endbody end;          /* BODY */          enum mdoc_endbody end; /* BODY */
           union mdoc_data   data;
         union {  
                 struct mdoc_an  An;  
                 struct mdoc_bd *Bd;  
                 struct mdoc_bf *Bf;  
                 struct mdoc_bl *Bl;  
         } data;  
 };  };
   
 /* See mdoc.3 for documentation. */  /*
    * Names of macros.  Index is enum mdoct.  Indexing into this returns
    * the normalised name, e.g., mdoc_macronames[MDOC_Sh] -> "Sh".
    */
 extern  const char *const *mdoc_macronames;  extern  const char *const *mdoc_macronames;
   
   /*
    * Names of macro args.  Index is enum mdocargt.  Indexing into this
    * returns the normalised name, e.g., mdoc_argnames[MDOC_File] ->
    * "file".
    */
 extern  const char *const *mdoc_argnames;  extern  const char *const *mdoc_argnames;
   
 __BEGIN_DECLS  __BEGIN_DECLS
   
 struct  mdoc;  struct  mdoc;
   
 /* See mdoc.3 for documentation. */  
   
 void              mdoc_free(struct mdoc *);  void              mdoc_free(struct mdoc *);
 struct  mdoc     *mdoc_alloc(struct regset *, void *, mandocmsg);  struct  mdoc     *mdoc_alloc(struct regset *, void *, mandocmsg);
Legend:
Removed from v.1.103  
changed lines
  Added in v.1.105
CVSweb