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

Diff for /mandoc/mdoc.h between version 1.42 and 1.137

version 1.42, 2009/03/08 20:57:35 version 1.137, 2015/04/02 21:36:50
Line 1 
Line 1 
 /* $Id$ */  /*      $Id$ */
 /*  /*
  * Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>   * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
    * Copyright (c) 2014, 2015 Ingo Schwarze <schwarze@openbsd.org>
  *   *
  * 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 AUTHORS DISCLAIM 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 AUTHORS 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  
 #define MDOC_H  
   
 /*  enum    mdoct {
  * This library implements a validating scanner/parser for ``mdoc'' roff          MDOC_Ap = 0,
  * macro documents, a.k.a. BSD manual page documents.  The mdoc.c file          MDOC_Dd,
  * drives the parser, while macro.c describes the macro ontologies.          MDOC_Dt,
  * validate.c pre- and post-validates parsed macros, and action.c          MDOC_Os,
  * performs actions on parsed and validated macros.          MDOC_Sh,
  */          MDOC_Ss,
           MDOC_Pp,
 /* What follows is a list of ALL possible macros. */          MDOC_D1,
           MDOC_Dl,
 /* TODO: Brq et al. */          MDOC_Bd,
           MDOC_Ed,
 #define MDOC___          0          MDOC_Bl,
 #define MDOC_Dd          1          MDOC_El,
 #define MDOC_Dt          2          MDOC_It,
 #define MDOC_Os          3          MDOC_Ad,
 #define MDOC_Sh          4          MDOC_An,
 #define MDOC_Ss          5          MDOC_Ar,
 #define MDOC_Pp          6          MDOC_Cd,
 #define MDOC_D1          7          MDOC_Cm,
 #define MDOC_Dl          8          MDOC_Dv,
 #define MDOC_Bd          9          MDOC_Er,
 #define MDOC_Ed          10          MDOC_Ev,
 #define MDOC_Bl          11          MDOC_Ex,
 #define MDOC_El          12          MDOC_Fa,
 #define MDOC_It          13          MDOC_Fd,
 #define MDOC_Ad          14          MDOC_Fl,
 #define MDOC_An          15          MDOC_Fn,
 #define MDOC_Ar          16          MDOC_Ft,
 #define MDOC_Cd          17          MDOC_Ic,
 #define MDOC_Cm          18          MDOC_In,
 #define MDOC_Dv          19          MDOC_Li,
 #define MDOC_Er          20          MDOC_Nd,
 #define MDOC_Ev          21          MDOC_Nm,
 #define MDOC_Ex          22          MDOC_Op,
 #define MDOC_Fa          23          MDOC_Ot,
 #define MDOC_Fd          24          MDOC_Pa,
 #define MDOC_Fl          25          MDOC_Rv,
 #define MDOC_Fn          26          MDOC_St,
 #define MDOC_Ft          27          MDOC_Va,
 #define MDOC_Ic          28          MDOC_Vt,
 #define MDOC_In          29          MDOC_Xr,
 #define MDOC_Li          30          MDOC__A,
 #define MDOC_Nd          31          MDOC__B,
 #define MDOC_Nm          32          MDOC__D,
 #define MDOC_Op          33          MDOC__I,
 #define MDOC_Ot          34          MDOC__J,
 #define MDOC_Pa          35          MDOC__N,
 #define MDOC_Rv          36          MDOC__O,
 #define MDOC_St          37          MDOC__P,
 #define MDOC_Va          38          MDOC__R,
 #define MDOC_Vt          39          MDOC__T,
 #define MDOC_Xr          40          MDOC__V,
 #define MDOC__A          41          MDOC_Ac,
 #define MDOC__B          42          MDOC_Ao,
 #define MDOC__D          43          MDOC_Aq,
 #define MDOC__I          44          MDOC_At,
 #define MDOC__J          45          MDOC_Bc,
 #define MDOC__N          46          MDOC_Bf,
 #define MDOC__O          47          MDOC_Bo,
 #define MDOC__P          48          MDOC_Bq,
 #define MDOC__R          49          MDOC_Bsx,
 #define MDOC__T          50          MDOC_Bx,
 #define MDOC__V          51          MDOC_Db,
 #define MDOC_Ac          52          MDOC_Dc,
 #define MDOC_Ao          53          MDOC_Do,
 #define MDOC_Aq          54          MDOC_Dq,
 #define MDOC_At          55          MDOC_Ec,
 #define MDOC_Bc          56          MDOC_Ef,
 #define MDOC_Bf          57          MDOC_Em,
 #define MDOC_Bo          58          MDOC_Eo,
 #define MDOC_Bq          59          MDOC_Fx,
 #define MDOC_Bsx         60          MDOC_Ms,
 #define MDOC_Bx          61          MDOC_No,
 #define MDOC_Db          62          MDOC_Ns,
 #define MDOC_Dc          63          MDOC_Nx,
 #define MDOC_Do          64          MDOC_Ox,
 #define MDOC_Dq          65          MDOC_Pc,
 #define MDOC_Ec          66          MDOC_Pf,
 #define MDOC_Ef          67          MDOC_Po,
 #define MDOC_Em          68          MDOC_Pq,
 #define MDOC_Eo          69          MDOC_Qc,
 #define MDOC_Fx          70          MDOC_Ql,
 #define MDOC_Ms          71          MDOC_Qo,
 #define MDOC_No          72          MDOC_Qq,
 #define MDOC_Ns          73          MDOC_Re,
 #define MDOC_Nx          74          MDOC_Rs,
 #define MDOC_Ox          75          MDOC_Sc,
 #define MDOC_Pc          76          MDOC_So,
 #define MDOC_Pf          77          MDOC_Sq,
 #define MDOC_Po          78          MDOC_Sm,
 #define MDOC_Pq          79          MDOC_Sx,
 #define MDOC_Qc          80          MDOC_Sy,
 #define MDOC_Ql          81          MDOC_Tn,
 #define MDOC_Qo          82          MDOC_Ux,
 #define MDOC_Qq          83          MDOC_Xc,
 #define MDOC_Re          84          MDOC_Xo,
 #define MDOC_Rs          85          MDOC_Fo,
 #define MDOC_Sc          86          MDOC_Fc,
 #define MDOC_So          87          MDOC_Oo,
 #define MDOC_Sq          88          MDOC_Oc,
 #define MDOC_Sm          89          MDOC_Bk,
 #define MDOC_Sx          90          MDOC_Ek,
 #define MDOC_Sy          91          MDOC_Bt,
 #define MDOC_Tn          92          MDOC_Hf,
 #define MDOC_Ux          93          MDOC_Fr,
 #define MDOC_Xc          94          MDOC_Ud,
 #define MDOC_Xo          95          MDOC_Lb,
 #define MDOC_Fo          96          MDOC_Lp,
 #define MDOC_Fc          97          MDOC_Lk,
 #define MDOC_Oo          98          MDOC_Mt,
 #define MDOC_Oc          99          MDOC_Brq,
 #define MDOC_Bk          100          MDOC_Bro,
 #define MDOC_Ek          101          MDOC_Brc,
 #define MDOC_Bt          102          MDOC__C,
 #define MDOC_Hf          103          MDOC_Es,
 #define MDOC_Fr          104          MDOC_En,
 #define MDOC_Ud          105          MDOC_Dx,
 #define MDOC_Lb          106          MDOC__Q,
 #define MDOC_Ap          107          MDOC_br,
 #define MDOC_Lp          108          MDOC_sp,
 #define MDOC_MAX         109          MDOC__U,
           MDOC_Ta,
 /* What follows is a list of ALL possible macro arguments. */          MDOC_ll,
           MDOC_MAX
 #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. */  enum    mdocargt {
 enum    mdoc_type {          MDOC_Split, /* -split */
         MDOC_TEXT,          MDOC_Nosplit, /* -nospli */
         MDOC_ELEM,          MDOC_Ragged, /* -ragged */
         MDOC_HEAD,          MDOC_Unfilled, /* -unfilled */
         MDOC_TAIL,          MDOC_Literal, /* -literal */
         MDOC_BODY,          MDOC_File, /* -file */
         MDOC_BLOCK,          MDOC_Offset, /* -offset */
         MDOC_ROOT          MDOC_Bullet, /* -bullet */
           MDOC_Dash, /* -dash */
           MDOC_Hyphen, /* -hyphen */
           MDOC_Item, /* -item */
           MDOC_Enum, /* -enum */
           MDOC_Tag, /* -tag */
           MDOC_Diag, /* -diag */
           MDOC_Hang, /* -hang */
           MDOC_Ohang, /* -ohang */
           MDOC_Inset, /* -inset */
           MDOC_Column, /* -column */
           MDOC_Width, /* -width */
           MDOC_Compact, /* -compact */
           MDOC_Std, /* -std */
           MDOC_Filled, /* -filled */
           MDOC_Words, /* -words */
           MDOC_Emphasis, /* -emphasis */
           MDOC_Symbolic, /* -symbolic */
           MDOC_Nested, /* -nested */
           MDOC_Centred, /* -centered */
           MDOC_ARG_MAX
 };  };
   
 /* Section (named/unnamed) of `Sh'. */  /*
    * Section (named/unnamed) of `Sh'.   Note that these appear in the
    * conventional order imposed by mdoc.7.  In the case of SEC_NONE, no
    * section has been invoked (this shouldn't happen).  SEC_CUSTOM refers
    * to other sections.
    */
 enum    mdoc_sec {  enum    mdoc_sec {
         SEC_PROLOGUE            = 0,          SEC_NONE = 0,
         SEC_BODY                = 1,          SEC_NAME, /* NAME */
         SEC_NAME                = 2,          SEC_LIBRARY, /* LIBRARY */
         SEC_LIBRARY             = 3,          SEC_SYNOPSIS, /* SYNOPSIS */
         SEC_SYNOPSIS            = 4,          SEC_DESCRIPTION, /* DESCRIPTION */
         SEC_DESCRIPTION         = 5,          SEC_CONTEXT, /* CONTEXT */
         SEC_IMPLEMENTATION      = 6,          SEC_IMPLEMENTATION, /* IMPLEMENTATION NOTES */
         SEC_RETURN_VALUES       = 7,          SEC_RETURN_VALUES, /* RETURN VALUES */
         SEC_ENVIRONMENT         = 8,          SEC_ENVIRONMENT,  /* ENVIRONMENT */
         SEC_FILES               = 9,          SEC_FILES, /* FILES */
         SEC_EXAMPLES            = 10,          SEC_EXIT_STATUS, /* EXIT STATUS */
         SEC_DIAGNOSTICS         = 11,          SEC_EXAMPLES, /* EXAMPLES */
         SEC_COMPATIBILITY       = 12,          SEC_DIAGNOSTICS, /* DIAGNOSTICS */
         SEC_ERRORS              = 13,          SEC_COMPATIBILITY, /* COMPATIBILITY */
         SEC_SEE_ALSO            = 14,          SEC_ERRORS, /* ERRORS */
         SEC_STANDARDS           = 15,          SEC_SEE_ALSO, /* SEE ALSO */
         SEC_HISTORY             = 16,          SEC_STANDARDS, /* STANDARDS */
         SEC_AUTHORS             = 17,          SEC_HISTORY, /* HISTORY */
         SEC_CAVEATS             = 18,          SEC_AUTHORS, /* AUTHORS */
         SEC_BUGS                = 19,          SEC_CAVEATS, /* CAVEATS */
         SEC_CUSTOM          SEC_BUGS, /* BUGS */
           SEC_SECURITY, /* SECURITY */
           SEC_CUSTOM,
           SEC__MAX
 };  };
   
 /* 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;          char             *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 */
 };  };
   
 struct  mdoc_arg {  /*
    * 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 {
         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;  
   
         /* FIXME: union/struct this with #defines. */  enum    mdoc_list {
         struct mdoc_arg  *args;         /* BLOCK/ELEM */          LIST__NONE = 0,
         struct mdoc_node *head;         /* BLOCK */          LIST_bullet, /* -bullet */
         struct mdoc_node *body;         /* BLOCK */          LIST_column, /* -column */
         struct mdoc_node *tail;         /* BLOCK */          LIST_dash, /* -dash */
         char             *string;       /* TEXT */          LIST_diag, /* -diag */
           LIST_enum, /* -enum */
           LIST_hang, /* -hang */
           LIST_hyphen, /* -hyphen */
           LIST_inset, /* -inset */
           LIST_item, /* -item */
           LIST_ohang, /* -ohang */
           LIST_tag, /* -tag */
           LIST_MAX
 };  };
   
 #define MDOC_IGN_SCOPE   (1 << 0) /* Ignore scope violations. */  enum    mdoc_disp {
 #define MDOC_IGN_ESCAPE  (1 << 1) /* Ignore bad escape sequences. */          DISP__NONE = 0,
           DISP_centered, /* -centered */
           DISP_ragged, /* -ragged */
           DISP_unfilled, /* -unfilled */
           DISP_filled, /* -filled */
           DISP_literal /* -literal */
   };
   
 /* Call-backs for parse messages. */  enum    mdoc_auth {
 struct  mdoc_cb {          AUTH__NONE = 0,
         void    (*mdoc_msg)(void *, int, int, const char *);          AUTH_split, /* -split */
         int     (*mdoc_err)(void *, int, int, const char *);          AUTH_nosplit /* -nosplit */
         int     (*mdoc_warn)(void *, int, int,  
                         enum mdoc_warn, const char *);  
 };  };
   
 /* Global table of macro names (`Bd', `Ed', etc.). */  enum    mdoc_font {
 extern  const char *const *mdoc_macronames;          FONT__NONE = 0,
           FONT_Em, /* Em, -emphasis */
           FONT_Li, /* Li, -literal */
           FONT_Sy /* Sy, -symbolic */
   };
   
 /* Global table of argument names (`column', `tag', etc.). */  struct  mdoc_bd {
 extern  const char *const *mdoc_argnames;          const char       *offs; /* -offset */
           enum mdoc_disp    type; /* -ragged, etc. */
           int               comp; /* -compact */
   };
   
 __BEGIN_DECLS  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 */
           int               count; /* -enum counter */
   };
   
 struct  mdoc;  struct  mdoc_bf {
           enum mdoc_font    font; /* font */
   };
   
 /* Free memory allocated with mdoc_alloc. */  struct  mdoc_an {
 void              mdoc_free(struct mdoc *);          enum mdoc_auth    auth; /* -split, etc. */
   };
   
 /* Allocate a new parser instance. */  struct  mdoc_rs {
 struct  mdoc     *mdoc_alloc(void *, int, const struct mdoc_cb *);          int               quote_T; /* whether to quote %T */
   };
   
 /* 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;
           struct mdoc_node *Es;
           struct mdoc_rs    Rs;
   };
   
 /* 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 *last; /* last 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_ENDED       (1 << 1) /* gone past body end mark */
   #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_BROKEN      (1 << 5) /* must validate parent when ending */
   #define MDOC_DELIMO      (1 << 6)
   #define MDOC_DELIMC      (1 << 7)
           enum roff_type    type; /* AST node type */
           enum mdoc_sec     sec; /* current named section */
           union mdoc_data  *norm; /* normalised args */
           int               prev_font; /* before entering this node */
           /* FIXME: these can be union'd to shave a few bytes. */
           struct mdoc_arg  *args; /* BLOCK/ELEM */
           struct mdoc_node *head; /* BLOCK */
           struct mdoc_node *body; /* BLOCK/ENDBODY */
           struct mdoc_node *tail; /* BLOCK */
           char             *string; /* TEXT */
           const struct tbl_span *span; /* TBL */
           const struct eqn *eqn; /* EQN */
           enum mdoc_endbody end; /* BODY */
   };
   
 /* Get result first node (after mdoc_endparse!). */  /* Names of macros.  Index is enum mdoct. */
 const struct mdoc_node *mdoc_node(const struct mdoc *);  extern  const char *const *mdoc_macronames;
   
 /* Get result meta-information (after mdoc_endparse!). */  /* Names of macro args.  Index is enum mdocargt. */
 const struct mdoc_meta *mdoc_meta(const struct mdoc *);  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 *);  const struct mdoc_node *mdoc_node(const struct mdoc *);
 const char       *mdoc_a2lib(const char *);  const struct mdoc_meta *mdoc_meta(const struct mdoc *);
 const char       *mdoc_a2st(const char *);  void mdoc_deroff(char **, const struct mdoc_node *);
   
 int               mdoc_isdelim(const char *);  
   
 __END_DECLS  __END_DECLS
   
 #endif /*!MDOC_H*/  
Legend:
Removed from v.1.42  
changed lines
  Added in v.1.137
CVSweb