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

Diff for /mandoc/mdoc.h between version 1.23 and 1.84

version 1.23, 2009/01/16 12:23:25 version 1.84, 2010/06/12 10:09:19
Line 1 
Line 1 
 /* $Id$ */  /*      $Id$ */
 /*  /*
  * Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>   * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
  *   *
  * 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
    * 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. */  /* What follows is a list of ALL possible macros. */
   
 #define MDOC___          0  enum    mdoct {
 #define MDOC_Dd          1          MDOC_Ap = 0,
 #define MDOC_Dt          2          MDOC_Dd,
 #define MDOC_Os          3          MDOC_Dt,
 #define MDOC_Sh          4          MDOC_Os,
 #define MDOC_Ss          5          MDOC_Sh,
 #define MDOC_Pp          6          MDOC_Ss,
 #define MDOC_D1          7          MDOC_Pp,
 #define MDOC_Dl          8          MDOC_D1,
 #define MDOC_Bd          9          MDOC_Dl,
 #define MDOC_Ed          10          MDOC_Bd,
 #define MDOC_Bl          11          MDOC_Ed,
 #define MDOC_El          12          MDOC_Bl,
 #define MDOC_It          13          MDOC_El,
 #define MDOC_Ad          14          MDOC_It,
 #define MDOC_An          15          MDOC_Ad,
 #define MDOC_Ar          16          MDOC_An,
 #define MDOC_Cd          17          MDOC_Ar,
 #define MDOC_Cm          18          MDOC_Cd,
 #define MDOC_Dv          19          MDOC_Cm,
 #define MDOC_Er          20          MDOC_Dv,
 #define MDOC_Ev          21          MDOC_Er,
 #define MDOC_Ex          22          MDOC_Ev,
 #define MDOC_Fa          23          MDOC_Ex,
 #define MDOC_Fd          24          MDOC_Fa,
 #define MDOC_Fl          25          MDOC_Fd,
 #define MDOC_Fn          26          MDOC_Fl,
 #define MDOC_Ft          27          MDOC_Fn,
 #define MDOC_Ic          28          MDOC_Ft,
 #define MDOC_In          29          MDOC_Ic,
 #define MDOC_Li          30          MDOC_In,
 #define MDOC_Nd          31          MDOC_Li,
 #define MDOC_Nm          32          MDOC_Nd,
 #define MDOC_Op          33          MDOC_Nm,
 #define MDOC_Ot          34          MDOC_Op,
 #define MDOC_Pa          35          MDOC_Ot,
 #define MDOC_Rv          36          MDOC_Pa,
 #define MDOC_St          37          MDOC_Rv,
 #define MDOC_Va          38          MDOC_St,
 #define MDOC_Vt          39          MDOC_Va,
 #define MDOC_Xr          40          MDOC_Vt,
 #define MDOC__A          41          MDOC_Xr,
 #define MDOC__B          42          MDOC__A,
 #define MDOC__D          43          MDOC__B,
 #define MDOC__I          44          MDOC__D,
 #define MDOC__J          45          MDOC__I,
 #define MDOC__N          46          MDOC__J,
 #define MDOC__O          47          MDOC__N,
 #define MDOC__P          48          MDOC__O,
 #define MDOC__R          49          MDOC__P,
 #define MDOC__T          50          MDOC__R,
 #define MDOC__V          51          MDOC__T,
 #define MDOC_Ac          52          MDOC__V,
 #define MDOC_Ao          53          MDOC_Ac,
 #define MDOC_Aq          54          MDOC_Ao,
 #define MDOC_At          55          MDOC_Aq,
 #define MDOC_Bc          56          MDOC_At,
 #define MDOC_Bf          57          MDOC_Bc,
 #define MDOC_Bo          58          MDOC_Bf,
 #define MDOC_Bq          59          MDOC_Bo,
 #define MDOC_Bsx         60          MDOC_Bq,
 #define MDOC_Bx          61          MDOC_Bsx,
 #define MDOC_Db          62          MDOC_Bx,
 #define MDOC_Dc          63          MDOC_Db,
 #define MDOC_Do          64          MDOC_Dc,
 #define MDOC_Dq          65          MDOC_Do,
 #define MDOC_Ec          66          MDOC_Dq,
 #define MDOC_Ef          67          MDOC_Ec,
 #define MDOC_Em          68          MDOC_Ef,
 #define MDOC_Eo          69          MDOC_Em,
 #define MDOC_Fx          70          MDOC_Eo,
 #define MDOC_Ms          71          MDOC_Fx,
 #define MDOC_No          72          MDOC_Ms,
 #define MDOC_Ns          73          MDOC_No,
 #define MDOC_Nx          74          MDOC_Ns,
 #define MDOC_Ox          75          MDOC_Nx,
 #define MDOC_Pc          76          MDOC_Ox,
 #define MDOC_Pf          77          MDOC_Pc,
 #define MDOC_Po          78          MDOC_Pf,
 #define MDOC_Pq          79          MDOC_Po,
 #define MDOC_Qc          80          MDOC_Pq,
 #define MDOC_Ql          81          MDOC_Qc,
 #define MDOC_Qo          82          MDOC_Ql,
 #define MDOC_Qq          83          MDOC_Qo,
 #define MDOC_Re          84          MDOC_Qq,
 #define MDOC_Rs          85          MDOC_Re,
 #define MDOC_Sc          86          MDOC_Rs,
 #define MDOC_So          87          MDOC_Sc,
 #define MDOC_Sq          88          MDOC_So,
 #define MDOC_Sm          89          MDOC_Sq,
 #define MDOC_Sx          90          MDOC_Sm,
 #define MDOC_Sy          91          MDOC_Sx,
 #define MDOC_Tn          92          MDOC_Sy,
 #define MDOC_Ux          93          MDOC_Tn,
 #define MDOC_Xc          94          MDOC_Ux,
 #define MDOC_Xo          95          MDOC_Xc,
 #define MDOC_Fo          96          MDOC_Xo,
 #define MDOC_Fc          97          MDOC_Fo,
 #define MDOC_Oo          98          MDOC_Fc,
 #define MDOC_Oc          99          MDOC_Oo,
 #define MDOC_Bk          100          MDOC_Oc,
 #define MDOC_Ek          101          MDOC_Bk,
 #define MDOC_Bt          102          MDOC_Ek,
 #define MDOC_Hf          103          MDOC_Bt,
 #define MDOC_Fr          104          MDOC_Hf,
 #define MDOC_Ud          105          MDOC_Fr,
 #define MDOC_MAX         106          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 macro arguments. */  /* What follows is a list of ALL possible macro arguments. */
   
Line 152 
Line 176 
 #define MDOC_Width       18  #define MDOC_Width       18
 #define MDOC_Compact     19  #define MDOC_Compact     19
 #define MDOC_Std         20  #define MDOC_Std         20
 #define MDOC_p1003_1_88  21  #define MDOC_Filled      21
 #define MDOC_p1003_1_90  22  #define MDOC_Words       22
 #define MDOC_p1003_1_96  23  #define MDOC_Emphasis    23
 #define MDOC_p1003_1_2001 24  #define MDOC_Symbolic    24
 #define MDOC_p1003_1_2004 25  #define MDOC_Nested      25
 #define MDOC_p1003_1     26  #define MDOC_Centred     26
 #define MDOC_p1003_1b    27  #define MDOC_ARG_MAX     27
 #define MDOC_p1003_1b_93 28  
 #define MDOC_p1003_1c_95 29  
 #define MDOC_p1003_1g_2000 30  
 #define MDOC_p1003_2_92  31  
 #define MDOC_p1387_2_95  32  
 #define MDOC_p1003_2     33  
 #define MDOC_p1387_2     34  
 #define MDOC_isoC_90     35  
 #define MDOC_isoC_amd1   36  
 #define MDOC_isoC_tcor1  37  
 #define MDOC_isoC_tcor2  38  
 #define MDOC_isoC_99     39  
 #define MDOC_ansiC       40  
 #define MDOC_ansiC_89    41  
 #define MDOC_ansiC_99    42  
 #define MDOC_ieee754     43  
 #define MDOC_iso8802_3   44  
 #define MDOC_xpg3        45  
 #define MDOC_xpg4        46  
 #define MDOC_xpg4_2      47  
 #define MDOC_xpg4_3      48  
 #define MDOC_xbd5        49  
 #define MDOC_xcu5        50  
 #define MDOC_xsh5        51  
 #define MDOC_xns5        52  
 #define MDOC_xns5_2d2_0  53  
 #define MDOC_xcurses4_2  54  
 #define MDOC_susv2       55  
 #define MDOC_susv3       56  
 #define MDOC_svid4       57  
 #define MDOC_Filled      58  
 #define MDOC_Words       59  
 #define MDOC_Emphasis    60  
 #define MDOC_Symbolic    61  
 #define MDOC_ARG_MAX     62  
   
 enum    mdoc_warn {  
         WARN_SYNTAX,            /* Syntax warn (at line/col). */  
         WARN_COMPAT             /* Groff compat warn (at line/col). */  
 };  
   
 /* Possible values for the `At' macro. */  
 enum    mdoc_att {  
         ATT_DEFAULT = 0,  
         ATT_v1,  
         ATT_v2,  
         ATT_v3,  
         ATT_v4,  
         ATT_v5,  
         ATT_v6,  
         ATT_v7,  
         ATT_32v,  
         ATT_V1,  
         ATT_V2,  
         ATT_V3,  
         ATT_V4  
 };  
   
 /* An argument to a macro (multiple values = `It -column'). */  
 struct  mdoc_arg {  
         int               arg;  
         int               line;  
         int               pos;  
         size_t            sz;  
         char            **value;  
 };  
   
 /*  
  * Simplified grammar of syntax tree:  
  *  
  * MDOC_ROOT: root of tree  
  * MDOC_TEXT: free-form text  
  * MDOC_ELEM: elem [args] MDOC_TEXT...  
  * MDOC_BLOCK, MDOC_HEAD, MDOC_BODY, MDOC_TAIL:  
  *   MDOC_BLOCK:  
  *     MDOC_HEAD [args] (MDOC_TEXT|MDOC_ELEM|MDOC_BLOCK)...  
  *     MDOC_BODY (MDOC_TEXT|MDOC_ELEM|MDOC_BLOCK)...  
  *     MDOC_TAIL (optional) (MDOC_TEXT|MDOC_ELEM|MDOC_BLOCK)...  
  */  
   
 /* Type of a syntax node. */  /* Type of a syntax node. */
 enum    mdoc_type {  enum    mdoc_type {
         MDOC_TEXT,          MDOC_TEXT,
Line 250  enum mdoc_type {
Line 195  enum mdoc_type {
         MDOC_ROOT          MDOC_ROOT
 };  };
   
 /* Manual section. */  /* Section (named/unnamed) of `Sh'. */
 enum    mdoc_msec {  
         MSEC_DEFAULT = 0,  
         MSEC_1,  
         MSEC_2,  
         MSEC_3,  
         MSEC_3f,  
         MSEC_3p,  
         MSEC_4,  
         MSEC_5,  
         MSEC_6,  
         MSEC_7,  
         MSEC_8,  
         MSEC_9,  
         MSEC_X11,  
         MSEC_X11R6,  
         MSEC_local,  
         MSEC_n,  
         MSEC_unass,  
         MSEC_draft,  
         MSEC_paper  
 };  
   
 /* Section (named/unnamed) of `Ss'. */  
 enum    mdoc_sec {  enum    mdoc_sec {
         SEC_PROLOGUE = 0,          SEC_NONE,               /* No section, yet. */
         SEC_BODY,  
         SEC_NAME,          SEC_NAME,
           SEC_LIBRARY,
         SEC_SYNOPSIS,          SEC_SYNOPSIS,
         SEC_DESCRIPTION,          SEC_DESCRIPTION,
           SEC_IMPLEMENTATION,
         SEC_RETURN_VALUES,          SEC_RETURN_VALUES,
         SEC_ENVIRONMENT,          SEC_ENVIRONMENT,
         SEC_FILES,          SEC_FILES,
           SEC_EXIT_STATUS,
         SEC_EXAMPLES,          SEC_EXAMPLES,
         SEC_DIAGNOSTICS,          SEC_DIAGNOSTICS,
           SEC_COMPATIBILITY,
         SEC_ERRORS,          SEC_ERRORS,
         SEC_SEE_ALSO,          SEC_SEE_ALSO,
         SEC_STANDARDS,          SEC_STANDARDS,
Line 292  enum mdoc_sec {
Line 217  enum mdoc_sec {
         SEC_AUTHORS,          SEC_AUTHORS,
         SEC_CAVEATS,          SEC_CAVEATS,
         SEC_BUGS,          SEC_BUGS,
         SEC_CUSTOM          SEC_SECURITY,
           SEC_CUSTOM,             /* User-defined. */
           SEC__MAX
 };  };
   
 /* Volume of `Dt'. */  /* Information from prologue. */
 enum    mdoc_vol {  
         VOL_DEFAULT = 0,  
         VOL_AMD,  
         VOL_IND,  
         VOL_KM,  
         VOL_LOCAL,  
         VOL_PRM,  
         VOL_PS1,  
         VOL_SMM,  
         VOL_URM,  
         VOL_USD  
 };  
   
 /* Architecture of `Dt'. */  
 enum    mdoc_arch {  
         ARCH_DEFAULT = 0,  
         ARCH_alpha,  
         ARCH_amd64,  
         ARCH_amiga,  
         ARCH_arc,  
         ARCH_arm,  
         ARCH_armish,  
         ARCH_aviion,  
         ARCH_hp300,  
         ARCH_hppa,  
         ARCH_hppa64,  
         ARCH_i386,  
         ARCH_landisk,  
         ARCH_luna88k,  
         ARCH_mac68k,  
         ARCH_macppc,  
         ARCH_mvme68k,  
         ARCH_mvme88k,  
         ARCH_mvmeppc,  
         ARCH_pmax,  
         ARCH_sgi,  
         ARCH_socppc,  
         ARCH_sparc,  
         ARCH_sparc64,  
         ARCH_sun3,  
         ARCH_vax,  
         ARCH_zaurus  
 };  
   
 /* Meta-information from prologue. */  
 struct  mdoc_meta {  struct  mdoc_meta {
         enum mdoc_msec    msec;          char             *msec;
         enum mdoc_vol     vol;          char             *vol;
         enum mdoc_arch    arch;          char             *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];  
 };  };
   
 struct  mdoc_text {  /* An argument to a macro (multiple values = `It -column'). */
         char             *string;  struct  mdoc_argv {
           int               arg;
           int               line;
           int               pos;
           size_t            sz;
           char            **value;
 };  };
   
 struct  mdoc_block {  struct  mdoc_arg {
         size_t            argc;          size_t            argc;
         struct mdoc_arg  *argv;          struct mdoc_argv *argv;
         struct mdoc_node *head;          unsigned int      refcnt;
         struct mdoc_node *body;  
         struct mdoc_node *tail;  
 };  };
   
 struct  mdoc_elem {  enum    mdoc_list {
         size_t            sz;          LIST__NONE = 0,
         char            **args;          LIST_bullet,
         size_t            argc;          LIST_column,
         struct mdoc_arg  *argv;          LIST_dash,
           LIST_diag,
           LIST_enum,
           LIST_hang,
           LIST_hyphen,
           LIST_inset,
           LIST_item,
           LIST_ohang,
           LIST_tag
 };  };
   
 union   mdoc_data {  enum    mdoc_disp {
         struct mdoc_text  text;          DISP__NONE = 0,
         struct mdoc_elem  elem;          DISP_centred,
         struct mdoc_block block;          DISP_ragged,
           DISP_unfilled,
           DISP_filled,
           DISP_literal
 };  };
   
 /* Syntax node in parse tree. */  /* Node in AST. */
 struct  mdoc_node {  struct  mdoc_node {
         struct mdoc_node *parent;          struct mdoc_node *parent; /* parent AST node */
         struct mdoc_node *child;          struct mdoc_node *child; /* first child AST node */
         struct mdoc_node *next;          struct mdoc_node *next; /* sibling AST node */
         struct mdoc_node *prev;          struct mdoc_node *prev; /* prior sibling AST node */
         int               line;          int               nchild; /* number children */
         int               pos;          int               line; /* parse line */
         int               tok;          int               pos; /* parse column */
         enum mdoc_type    type;          enum mdoct        tok; /* tok or MDOC__MAX if none */
         union mdoc_data   data;          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 */
           enum mdoc_type    type; /* AST node type */
           enum mdoc_sec     sec; /* current named section */
           struct mdoc_arg  *args;         /* BLOCK/ELEM */
   #ifdef  UGLY
           struct mdoc_node *pending;      /* BLOCK */
   #endif
           struct mdoc_node *head;         /* BLOCK */
           struct mdoc_node *body;         /* BLOCK */
           struct mdoc_node *tail;         /* BLOCK */
           char             *string;       /* TEXT */
   
 /* Call-backs for parse messages. */          union {
 struct  mdoc_cb {                  enum mdoc_list list; /* `Bl' nodes */
         void    (*mdoc_msg)(void *, int, int, const char *);                  enum mdoc_disp disp; /* `Bd' nodes */
         int     (*mdoc_err)(void *, int, int, const char *);          } data;
         int     (*mdoc_warn)(void *, int, int,  
                         enum mdoc_warn, const char *);  
 };  };
   
   #define MDOC_IGN_SCOPE   (1 << 0) /* Ignore scope violations. */
   #define MDOC_IGN_ESCAPE  (1 << 1) /* Ignore bad escape sequences. */
   #define MDOC_IGN_MACRO   (1 << 2) /* Ignore unknown macros. */
   
   /* See mdoc.3 for documentation. */
   
 extern  const char *const *mdoc_macronames;  extern  const char *const *mdoc_macronames;
 extern  const char *const *mdoc_argnames;  extern  const char *const *mdoc_argnames;
   
Line 405  __BEGIN_DECLS
Line 317  __BEGIN_DECLS
   
 struct  mdoc;  struct  mdoc;
   
 /* Free memory allocated with mdoc_alloc. */  /* See mdoc.3 for documentation. */
 void              mdoc_free(struct mdoc *);  
   
 /* Allocate a new parser instance. */  void              mdoc_free(struct mdoc *);
 struct  mdoc     *mdoc_alloc(void *data, const struct mdoc_cb *);  struct  mdoc     *mdoc_alloc(void *, int, mandocmsg);
   void              mdoc_reset(struct mdoc *);
 /* Parse a single line (boolean retval). */  int               mdoc_parseln(struct mdoc *, int, char *, int);
 int               mdoc_parseln(struct mdoc *, int, char *buf);  const struct mdoc_node *mdoc_node(const struct mdoc *);
   const struct mdoc_meta *mdoc_meta(const struct mdoc *);
 /* Get parse result or NULL. */  
 const struct mdoc_node *mdoc_result(struct mdoc *);  
   
 /* Signal end of parse sequence (boolean retval). */  
 int               mdoc_endparse(struct mdoc *);  int               mdoc_endparse(struct mdoc *);
   
 /* Node type to static string. */  
 char             *mdoc_type2a(enum mdoc_type);  
   
 __END_DECLS  __END_DECLS
   
Legend:
Removed from v.1.23  
changed lines
  Added in v.1.84
CVSweb