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

Diff for /mandoc/mdoc.h between version 1.49 and 1.145

version 1.49, 2009/03/16 23:37:28 version 1.145, 2017/04/24 23:06:18
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  
   
 #include <time.h>  enum    mdocargt {
           MDOC_Split, /* -split */
           MDOC_Nosplit, /* -nospli */
           MDOC_Ragged, /* -ragged */
           MDOC_Unfilled, /* -unfilled */
           MDOC_Literal, /* -literal */
           MDOC_File, /* -file */
           MDOC_Offset, /* -offset */
           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
   };
   
 /*  /*
  * This library implements a validating scanner/parser for ``mdoc'' roff   * An argument to a macro (multiple values = `-column xxx yyy').
  * 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. */  
   
 #define MDOC___          0  
 #define MDOC_Dd          1  
 #define MDOC_Dt          2  
 #define MDOC_Os          3  
 #define MDOC_Sh          4  
 #define MDOC_Ss          5  
 #define MDOC_Pp          6  
 #define MDOC_D1          7  
 #define MDOC_Dl          8  
 #define MDOC_Bd          9  
 #define MDOC_Ed          10  
 #define MDOC_Bl          11  
 #define MDOC_El          12  
 #define MDOC_It          13  
 #define MDOC_Ad          14  
 #define MDOC_An          15  
 #define MDOC_Ar          16  
 #define MDOC_Cd          17  
 #define MDOC_Cm          18  
 #define MDOC_Dv          19  
 #define MDOC_Er          20  
 #define MDOC_Ev          21  
 #define MDOC_Ex          22  
 #define MDOC_Fa          23  
 #define MDOC_Fd          24  
 #define MDOC_Fl          25  
 #define MDOC_Fn          26  
 #define MDOC_Ft          27  
 #define MDOC_Ic          28  
 #define MDOC_In          29  
 #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_Ap          107  
 #define MDOC_Lp          108  
 #define MDOC_Lk          109  
 #define MDOC_Mt          110  
 #define MDOC_Brq         111  
 #define MDOC_Bro         112  
 #define MDOC_Brc         113  
 #define MDOC__C          114  
 #define MDOC_Es          115  
 #define MDOC_En          116  
 #define MDOC_Dx          117  
 #define MDOC_MAX         118  
   
 /* 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_Nested      25  
 #define MDOC_ARG_MAX     26  
   
 /* Warnings are either syntax or groff-compatibility. */  
 enum    mdoc_warn {  
         WARN_SYNTAX,  
         WARN_COMPAT  
 };  
   
 /* Type of a syntax node. */  
 enum    mdoc_type {  
         MDOC_TEXT,  
         MDOC_ELEM,  
         MDOC_HEAD,  
         MDOC_TAIL,  
         MDOC_BODY,  
         MDOC_BLOCK,  
         MDOC_ROOT  
 };  
   
 /* Section (named/unnamed) of `Sh'. */  
 enum    mdoc_sec {  
         SEC_PROLOGUE            = 0,  
         SEC_BODY                = 1,  
         SEC_NAME                = 2,  
         SEC_LIBRARY             = 3,  
         SEC_SYNOPSIS            = 4,  
         SEC_DESCRIPTION         = 5,  
         SEC_IMPLEMENTATION      = 6,  
         SEC_RETURN_VALUES       = 7,  
         SEC_ENVIRONMENT         = 8,  
         SEC_FILES               = 9,  
         SEC_EXAMPLES            = 10,  
         SEC_DIAGNOSTICS         = 11,  
         SEC_COMPATIBILITY       = 12,  
         SEC_ERRORS              = 13,  
         SEC_SEE_ALSO            = 14,  
         SEC_STANDARDS           = 15,  
         SEC_HISTORY             = 16,  
         SEC_AUTHORS             = 17,  
         SEC_CAVEATS             = 18,  
         SEC_BUGS                = 19,  
         SEC_CUSTOM  
 };  
   
 /* Information from prologue. */  
 struct  mdoc_meta {  
         int               msec;  
         char             *vol;  
         char             *arch;  
         time_t            date;  
         char             *title;  
         char             *os;  
         char             *name;  
 };  
   
 /* An argument to a macro (multiple values = `It -column'). */  
 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. */  enum    mdoc_list {
 struct  mdoc_node {          LIST__NONE = 0,
         struct mdoc_node *parent;          LIST_bullet, /* -bullet */
         struct mdoc_node *child;          LIST_column, /* -column */
         struct mdoc_node *next;          LIST_dash, /* -dash */
         struct mdoc_node *prev;          LIST_diag, /* -diag */
         int               line;          LIST_enum, /* -enum */
         int               pos;          LIST_hang, /* -hang */
         int               tok;          LIST_hyphen, /* -hyphen */
         int               flags;          LIST_inset, /* -inset */
 #define MDOC_VALID       (1 << 0)          LIST_item, /* -item */
 #define MDOC_ACTED       (1 << 1)          LIST_ohang, /* -ohang */
         enum mdoc_type    type;          LIST_tag, /* -tag */
         enum mdoc_sec     sec;          LIST_MAX
   };
   
         /* FIXME: union/struct this with #defines. */  enum    mdoc_disp {
         struct mdoc_arg  *args;         /* BLOCK/ELEM */          DISP__NONE = 0,
         struct mdoc_node *head;         /* BLOCK */          DISP_centered, /* -centered */
         struct mdoc_node *body;         /* BLOCK */          DISP_ragged, /* -ragged */
         struct mdoc_node *tail;         /* BLOCK */          DISP_unfilled, /* -unfilled */
         char             *string;       /* TEXT */          DISP_filled, /* -filled */
           DISP_literal /* -literal */
 };  };
   
 #define MDOC_IGN_SCOPE   (1 << 0) /* Ignore scope violations. */  enum    mdoc_auth {
 #define MDOC_IGN_ESCAPE  (1 << 1) /* Ignore bad escape sequences. */          AUTH__NONE = 0,
 #define MDOC_IGN_MACRO   (1 << 2) /* Ignore unknown macros. */          AUTH_split, /* -split */
           AUTH_nosplit /* -nosplit */
   };
   
 /* Call-backs for parse messages. */  enum    mdoc_font {
 struct  mdoc_cb {          FONT__NONE = 0,
         void    (*mdoc_msg)(void *, int, int, const char *);          FONT_Em, /* Em, -emphasis */
         int     (*mdoc_err)(void *, int, int, const char *);          FONT_Li, /* Li, -literal */
         int     (*mdoc_warn)(void *, int, int,          FONT_Sy /* Sy, -symbolic */
                         enum mdoc_warn, const char *);  
 };  };
   
 /* Global table of macro names (`Bd', `Ed', etc.). */  struct  mdoc_bd {
 extern  const char *const *mdoc_macronames;          const char       *offs; /* -offset */
           enum mdoc_disp    type; /* -ragged, etc. */
           int               comp; /* -compact */
   };
   
 /* Global table of argument names (`column', `tag', etc.). */  struct  mdoc_bl {
 extern  const char *const *mdoc_argnames;          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 */
   };
   
 __BEGIN_DECLS  struct  mdoc_bf {
           enum mdoc_font    font; /* font */
   };
   
 struct  mdoc;  struct  mdoc_an {
           enum mdoc_auth    auth; /* -split, etc. */
   };
   
 /* Free memory allocated with mdoc_alloc. */  struct  mdoc_rs {
 void              mdoc_free(struct mdoc *);          int               quote_T; /* whether to quote %T */
   };
   
 /* Allocate a new parser instance. */  /*
 struct  mdoc     *mdoc_alloc(void *, int, const struct mdoc_cb *);   * 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 roff_node *Es;
           struct mdoc_rs    Rs;
   };
   
 /* Set parse options. */  /* Names of macro args.  Index is enum mdocargt. */
 void              mdoc_setflags(struct mdoc *, int);  extern  const char *const *mdoc_argnames;
   
 /* Parse a single line in a stream (boolean retval). */  void             mdoc_validate(struct roff_man *);
 int               mdoc_parseln(struct mdoc *, int, char *buf);  
   
 /* Get result first node (after mdoc_endparse!). */  
 const struct mdoc_node *mdoc_node(const struct mdoc *);  
   
 /* Get result meta-information (after mdoc_endparse!). */  
 const struct mdoc_meta *mdoc_meta(const struct mdoc *);  
   
 /* Signal end of parse sequence (boolean retval). */  
 int               mdoc_endparse(struct mdoc *);  
   
 /* The following are utility functions. */  
   
 const char       *mdoc_a2att(const char *);  
 const char       *mdoc_a2lib(const char *);  
 const char       *mdoc_a2st(const char *);  
   
 int               mdoc_isdelim(const char *);  
   
 __END_DECLS  
   
 #endif /*!MDOC_H*/  
Legend:
Removed from v.1.49  
changed lines
  Added in v.1.145
CVSweb