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

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

version 1.38, 2009/03/08 11:41:22 version 1.105, 2010/10/04 07:01:02
Line 1 
Line 1 
 /* $Id$ */  /*      $Id$ */
 /*  /*
  * Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>   * Copyright (c) 2008, 2009, 2010 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   * purpose with or without fee is hereby granted, provided that the above
  * above copyright notice and this permission notice appear in all   * copyright notice and this permission notice appear in all copies.
  * copies.  
  *   *
  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL   * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED   * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE   * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL   * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR   * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER   * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR   * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  * PERFORMANCE OF THIS SOFTWARE.  
  */   */
 #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.  
  */   */
   enum    mdoct {
           MDOC_Ap = 0,
           MDOC_Dd,
           MDOC_Dt,
           MDOC_Os,
           MDOC_Sh,
           MDOC_Ss,
           MDOC_Pp,
           MDOC_D1,
           MDOC_Dl,
           MDOC_Bd,
           MDOC_Ed,
           MDOC_Bl,
           MDOC_El,
           MDOC_It,
           MDOC_Ad,
           MDOC_An,
           MDOC_Ar,
           MDOC_Cd,
           MDOC_Cm,
           MDOC_Dv,
           MDOC_Er,
           MDOC_Ev,
           MDOC_Ex,
           MDOC_Fa,
           MDOC_Fd,
           MDOC_Fl,
           MDOC_Fn,
           MDOC_Ft,
           MDOC_Ic,
           MDOC_In,
           MDOC_Li,
           MDOC_Nd,
           MDOC_Nm,
           MDOC_Op,
           MDOC_Ot,
           MDOC_Pa,
           MDOC_Rv,
           MDOC_St,
           MDOC_Va,
           MDOC_Vt,
           MDOC_Xr,
           MDOC__A,
           MDOC__B,
           MDOC__D,
           MDOC__I,
           MDOC__J,
           MDOC__N,
           MDOC__O,
           MDOC__P,
           MDOC__R,
           MDOC__T,
           MDOC__V,
           MDOC_Ac,
           MDOC_Ao,
           MDOC_Aq,
           MDOC_At,
           MDOC_Bc,
           MDOC_Bf,
           MDOC_Bo,
           MDOC_Bq,
           MDOC_Bsx,
           MDOC_Bx,
           MDOC_Db,
           MDOC_Dc,
           MDOC_Do,
           MDOC_Dq,
           MDOC_Ec,
           MDOC_Ef,
           MDOC_Em,
           MDOC_Eo,
           MDOC_Fx,
           MDOC_Ms,
           MDOC_No,
           MDOC_Ns,
           MDOC_Nx,
           MDOC_Ox,
           MDOC_Pc,
           MDOC_Pf,
           MDOC_Po,
           MDOC_Pq,
           MDOC_Qc,
           MDOC_Ql,
           MDOC_Qo,
           MDOC_Qq,
           MDOC_Re,
           MDOC_Rs,
           MDOC_Sc,
           MDOC_So,
           MDOC_Sq,
           MDOC_Sm,
           MDOC_Sx,
           MDOC_Sy,
           MDOC_Tn,
           MDOC_Ux,
           MDOC_Xc,
           MDOC_Xo,
           MDOC_Fo,
           MDOC_Fc,
           MDOC_Oo,
           MDOC_Oc,
           MDOC_Bk,
           MDOC_Ek,
           MDOC_Bt,
           MDOC_Hf,
           MDOC_Fr,
           MDOC_Ud,
           MDOC_Lb,
           MDOC_Lp,
           MDOC_Lk,
           MDOC_Mt,
           MDOC_Brq,
           MDOC_Bro,
           MDOC_Brc,
           MDOC__C,
           MDOC_Es,
           MDOC_En,
           MDOC_Dx,
           MDOC__Q,
           MDOC_br,
           MDOC_sp,
           MDOC__U,
           MDOC_Ta,
           MDOC_MAX
   };
   
 /* What follows is a list of ALL possible macros. */  /*
    * What follows is a list of ALL possible macro arguments.
 #define MDOC___          0   */
 #define MDOC_Dd          1  enum    mdocargt {
 #define MDOC_Dt          2          MDOC_Split,
 #define MDOC_Os          3          MDOC_Nosplit,
 #define MDOC_Sh          4          MDOC_Ragged,
 #define MDOC_Ss          5          MDOC_Unfilled,
 #define MDOC_Pp          6          MDOC_Literal,
 #define MDOC_D1          7          MDOC_File,
 #define MDOC_Dl          8          MDOC_Offset,
 #define MDOC_Bd          9          MDOC_Bullet,
 #define MDOC_Ed          10          MDOC_Dash,
 #define MDOC_Bl          11          MDOC_Hyphen,
 #define MDOC_El          12          MDOC_Item,
 #define MDOC_It          13          MDOC_Enum,
 #define MDOC_Ad          14          MDOC_Tag,
 #define MDOC_An          15          MDOC_Diag,
 #define MDOC_Ar          16          MDOC_Hang,
 #define MDOC_Cd          17          MDOC_Ohang,
 #define MDOC_Cm          18          MDOC_Inset,
 #define MDOC_Dv          19          MDOC_Column,
 #define MDOC_Er          20          MDOC_Width,
 #define MDOC_Ev          21          MDOC_Compact,
 #define MDOC_Ex          22          MDOC_Std,
 #define MDOC_Fa          23          MDOC_Filled,
 #define MDOC_Fd          24          MDOC_Words,
 #define MDOC_Fl          25          MDOC_Emphasis,
 #define MDOC_Fn          26          MDOC_Symbolic,
 #define MDOC_Ft          27          MDOC_Nested,
 #define MDOC_Ic          28          MDOC_Centred,
 #define MDOC_In          29          MDOC_ARG_MAX
 #define MDOC_Li          30  
 #define MDOC_Nd          31  
 #define MDOC_Nm          32  
 #define MDOC_Op          33  
 #define MDOC_Ot          34  
 #define MDOC_Pa          35  
 #define MDOC_Rv          36  
 #define MDOC_St          37  
 #define MDOC_Va          38  
 #define MDOC_Vt          39  
 #define MDOC_Xr          40  
 #define MDOC__A          41  
 #define MDOC__B          42  
 #define MDOC__D          43  
 #define MDOC__I          44  
 #define MDOC__J          45  
 #define MDOC__N          46  
 #define MDOC__O          47  
 #define MDOC__P          48  
 #define MDOC__R          49  
 #define MDOC__T          50  
 #define MDOC__V          51  
 #define MDOC_Ac          52  
 #define MDOC_Ao          53  
 #define MDOC_Aq          54  
 #define MDOC_At          55  
 #define MDOC_Bc          56  
 #define MDOC_Bf          57  
 #define MDOC_Bo          58  
 #define MDOC_Bq          59  
 #define MDOC_Bsx         60  
 #define MDOC_Bx          61  
 #define MDOC_Db          62  
 #define MDOC_Dc          63  
 #define MDOC_Do          64  
 #define MDOC_Dq          65  
 #define MDOC_Ec          66  
 #define MDOC_Ef          67  
 #define MDOC_Em          68  
 #define MDOC_Eo          69  
 #define MDOC_Fx          70  
 #define MDOC_Ms          71  
 #define MDOC_No          72  
 #define MDOC_Ns          73  
 #define MDOC_Nx          74  
 #define MDOC_Ox          75  
 #define MDOC_Pc          76  
 #define MDOC_Pf          77  
 #define MDOC_Po          78  
 #define MDOC_Pq          79  
 #define MDOC_Qc          80  
 #define MDOC_Ql          81  
 #define MDOC_Qo          82  
 #define MDOC_Qq          83  
 #define MDOC_Re          84  
 #define MDOC_Rs          85  
 #define MDOC_Sc          86  
 #define MDOC_So          87  
 #define MDOC_Sq          88  
 #define MDOC_Sm          89  
 #define MDOC_Sx          90  
 #define MDOC_Sy          91  
 #define MDOC_Tn          92  
 #define MDOC_Ux          93  
 #define MDOC_Xc          94  
 #define MDOC_Xo          95  
 #define MDOC_Fo          96  
 #define MDOC_Fc          97  
 #define MDOC_Oo          98  
 #define MDOC_Oc          99  
 #define MDOC_Bk          100  
 #define MDOC_Ek          101  
 #define MDOC_Bt          102  
 #define MDOC_Hf          103  
 #define MDOC_Fr          104  
 #define MDOC_Ud          105  
 #define MDOC_Lb          106  
 #define MDOC_MAX         107  
   
 /* What follows is a list of ALL possible macro arguments. */  
   
 #define MDOC_Split       0  
 #define MDOC_Nosplit     1  
 #define MDOC_Ragged      2  
 #define MDOC_Unfilled    3  
 #define MDOC_Literal     4  
 #define MDOC_File        5  
 #define MDOC_Offset      6  
 #define MDOC_Bullet      7  
 #define MDOC_Dash        8  
 #define MDOC_Hyphen      9  
 #define MDOC_Item        10  
 #define MDOC_Enum        11  
 #define MDOC_Tag         12  
 #define MDOC_Diag        13  
 #define MDOC_Hang        14  
 #define MDOC_Ohang       15  
 #define MDOC_Inset       16  
 #define MDOC_Column      17  
 #define MDOC_Width       18  
 #define MDOC_Compact     19  
 #define MDOC_Std         20  
 #define MDOC_Filled      21  
 #define MDOC_Words       22  
 #define MDOC_Emphasis    23  
 #define MDOC_Symbolic    24  
 #define MDOC_ARG_MAX     25  
   
 /* Warnings are either syntax or groff-compatibility. */  
 enum    mdoc_warn {  
         WARN_SYNTAX,  
         WARN_COMPAT  
 };  };
   
 /* 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 184  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_PROLOGUE            = 0,          SEC_NONE = 0, /* No section, yet. */
         SEC_BODY                = 1,          SEC_NAME,
         SEC_NAME                = 2,          SEC_LIBRARY,
         SEC_LIBRARY             = 3,          SEC_SYNOPSIS,
         SEC_SYNOPSIS            = 4,          SEC_DESCRIPTION,
         SEC_DESCRIPTION         = 5,          SEC_IMPLEMENTATION,
         SEC_IMPLEMENTATION      = 6,          SEC_RETURN_VALUES,
         SEC_RETURN_VALUES       = 7,          SEC_ENVIRONMENT,
         SEC_ENVIRONMENT         = 8,          SEC_FILES,
         SEC_FILES               = 9,          SEC_EXIT_STATUS,
         SEC_EXAMPLES            = 10,          SEC_EXAMPLES,
         SEC_DIAGNOSTICS         = 11,          SEC_DIAGNOSTICS,
         SEC_COMPATIBILITY       = 12,          SEC_COMPATIBILITY,
         SEC_ERRORS              = 13,          SEC_ERRORS,
         SEC_SEE_ALSO            = 14,          SEC_SEE_ALSO,
         SEC_STANDARDS           = 15,          SEC_STANDARDS,
         SEC_HISTORY             = 16,          SEC_HISTORY,
         SEC_AUTHORS             = 17,          SEC_AUTHORS,
         SEC_CAVEATS             = 18,          SEC_CAVEATS,
         SEC_BUGS                = 19,          SEC_BUGS,
         SEC_CUSTOM          SEC_SECURITY,
           SEC_CUSTOM, /* User-defined. */
           SEC__MAX
 };  };
   
 /* Information from prologue. */  /*
    * Information from prologue.
    */
 struct  mdoc_meta {  struct  mdoc_meta {
         int               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 {
         int               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;
 };  };
   
 /* Node in AST. */  /*
 struct  mdoc_node {   * Indicates that a BODY's formatting has ended, but the scope is still
         struct mdoc_node *parent;   * open.  Used for syntax-broken blocks.
         struct mdoc_node *child;   */
         struct mdoc_node *next;  enum    mdoc_endbody {
         struct mdoc_node *prev;          ENDBODY_NOT = 0,
         int               line;          ENDBODY_SPACE, /* is broken: append a space */
         int               pos;          ENDBODY_NOSPACE /* is broken: don't append a space */
         int               tok;  
         int               flags;  
 #define MDOC_VALID       (1 << 0)  
 #define MDOC_ACTED       (1 << 1)  
         enum mdoc_type    type;  
         enum mdoc_sec     sec;  
         struct mdoc_arg  *args;         /* BLOCK/ELEM */  
         struct mdoc_node *head;         /* BLOCK */  
         struct mdoc_node *body;         /* BLOCK */  
         struct mdoc_node *tail;         /* BLOCK */  
         char             *string;       /* TEXT */  
 };  };
   
 #define MDOC_IGN_SCOPE   (1 << 0)  /*
    * Normalised `Bl' list type.
    */
   enum    mdoc_list {
           LIST__NONE = 0,
           LIST_bullet,
           LIST_column,
           LIST_dash,
           LIST_diag,
           LIST_enum,
           LIST_hang,
           LIST_hyphen,
           LIST_inset,
           LIST_item,
           LIST_ohang,
           LIST_tag
   };
   
 /* Call-backs for parse messages. */  /*
 struct  mdoc_cb {   * Normalised `Bd' display type.
         void    (*mdoc_msg)(void *, int, int, const char *);   */
         int     (*mdoc_err)(void *, int, int, const char *);  enum    mdoc_disp {
         int     (*mdoc_warn)(void *, int, int,          DISP__NONE = 0,
                         enum mdoc_warn, const char *);          DISP_centred,
           DISP_ragged,
           DISP_unfilled,
           DISP_filled,
           DISP_literal
 };  };
   
 /* Global table of macro names (`Bd', `Ed', etc.). */  /*
 extern  const char *const *mdoc_macronames;   * Normalised `An' splitting argument.
    */
   enum    mdoc_auth {
           AUTH__NONE = 0,
           AUTH_split,
           AUTH_nosplit
   };
   
 /* Global table of argument names (`column', `tag', etc.). */  /*
 extern  const char *const *mdoc_argnames;   * Normalised `Bf' font type.
    */
   enum    mdoc_font {
           FONT__NONE = 0,
           FONT_Em,
           FONT_Li,
           FONT_Sy
   };
   
 __BEGIN_DECLS  /*
    * Normalised arguments for `Bd'.
    */
   struct  mdoc_bd {
           const char       *offs; /* -offset */
           enum mdoc_disp    type; /* -ragged, etc. */
           int               comp; /* -compact */
   };
   
 struct  mdoc;  /*
    * Normalised arguments for `Bl'.
    */
   struct  mdoc_bl {
           const char       *width; /* -width */
           const char       *offs; /* -offset */
           enum mdoc_list    type; /* -tag, -enum, etc. */
           int               comp; /* -compact */
           size_t            ncols; /* -column arg count */
           const char      **cols; /* -column val ptr */
   };
   
 /* Free memory allocated with mdoc_alloc. */  /*
 void              mdoc_free(struct mdoc *);   * Normalised arguments for `Bf'.
    */
   struct  mdoc_bf {
           enum mdoc_font    font; /* font */
   };
   
 /* Allocate a new parser instance. */  /*
 struct  mdoc     *mdoc_alloc(void *data, const struct mdoc_cb *);   * Normalised arguments for `An'.
    */
   struct  mdoc_an {
           enum mdoc_auth    auth; /* -split, etc. */
   };
   
 /* Set parse options. */  /*
 void              mdoc_setflags(struct mdoc *, int);   * 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;
   };
   
 /* Parse a single line in a stream (boolean retval). */  /*
 int               mdoc_parseln(struct mdoc *, int, char *buf);   * Single node in tree-linked AST.
    */
   struct  mdoc_node {
           struct mdoc_node *parent; /* parent AST node */
           struct mdoc_node *child; /* first child AST node */
           struct mdoc_node *next; /* sibling AST node */
           struct mdoc_node *prev; /* prior sibling AST node */
           int               nchild; /* number children */
           int               line; /* parse line */
           int               pos; /* parse column */
           enum mdoct        tok; /* tok or MDOC__MAX if none */
           int               flags;
   #define MDOC_VALID       (1 << 0) /* has been validated */
   #define MDOC_ACTED       (1 << 1) /* has been acted upon */
   #define MDOC_EOS         (1 << 2) /* at sentence boundary */
   #define MDOC_LINE        (1 << 3) /* first macro/text on line */
   #define MDOC_SYNPRETTY   (1 << 4) /* SYNOPSIS-style formatting */
   #define MDOC_ENDED       (1 << 5) /* rendering has been ended */
           enum mdoc_type    type; /* AST node type */
           enum mdoc_sec     sec; /* current named section */
           /* FIXME: these can be union'd to shave a few bytes. */
           struct mdoc_arg  *args; /* BLOCK/ELEM */
           struct mdoc_node *pending; /* BLOCK */
           struct mdoc_node *head; /* BLOCK */
           struct mdoc_node *body; /* BLOCK */
           struct mdoc_node *tail; /* BLOCK */
           char             *string; /* TEXT */
           enum mdoc_endbody end; /* BODY */
           union mdoc_data   data;
   };
   
 /* Get result first node (after mdoc_endparse!). */  /*
 const struct mdoc_node *mdoc_node(const struct mdoc *);   * 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;
   
 /* Get result meta-information (after mdoc_endparse!). */  /*
 const struct mdoc_meta *mdoc_meta(const struct mdoc *);   * 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;
   
 /* Signal end of parse sequence (boolean retval). */  __BEGIN_DECLS
 int               mdoc_endparse(struct mdoc *);  
   
 /* The following are utility functions. */  struct  mdoc;
   
 const char       *mdoc_a2att(const char *);  void              mdoc_free(struct mdoc *);
 const char       *mdoc_a2lib(const char *);  struct  mdoc     *mdoc_alloc(struct regset *, void *, mandocmsg);
 const char       *mdoc_a2st(const char *);  void              mdoc_reset(struct mdoc *);
   int               mdoc_parseln(struct mdoc *, int, char *, int);
 int               mdoc_isdelim(const char *);  const struct mdoc_node *mdoc_node(const struct mdoc *);
   const struct mdoc_meta *mdoc_meta(const struct mdoc *);
   int               mdoc_endparse(struct mdoc *);
   
 __END_DECLS  __END_DECLS
   
Legend:
Removed from v.1.38  
changed lines
  Added in v.1.105
CVSweb