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

Diff for /mandoc/man.h between version 1.5 and 1.54

version 1.5, 2009/03/25 21:03:13 version 1.54, 2011/03/07 01:35:51
Line 1 
Line 1 
 /* $Id$ */  /*      $Id$ */
 /*  /*
  * Copyright (c) 2009 Kristaps Dzonsons <kristaps@openbsd.org>   * Copyright (c) 2009, 2010, 2011 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 MAN_H  #ifndef MAN_H
 #define MAN_H  #define MAN_H
   
 #include <time.h>  /*
    * What follows is a list of ALL possible macros.
    */
   enum    mant {
           MAN_br = 0,
           MAN_TH,
           MAN_SH,
           MAN_SS,
           MAN_TP,
           MAN_LP,
           MAN_PP,
           MAN_P,
           MAN_IP,
           MAN_HP,
           MAN_SM,
           MAN_SB,
           MAN_BI,
           MAN_IB,
           MAN_BR,
           MAN_RB,
           MAN_R,
           MAN_B,
           MAN_I,
           MAN_IR,
           MAN_RI,
           MAN_na,
           MAN_sp,
           MAN_nf,
           MAN_fi,
           MAN_RE,
           MAN_RS,
           MAN_DT,
           MAN_UC,
           MAN_PD,
           MAN_AT,
           MAN_in,
           MAN_ft,
           MAN_MAX
   };
   
 #define MAN___           0  /*
 #define MAN_TH           1   * Type of a syntax node.
 #define MAN_SH           2   */
 #define MAN_SS           3  
 #define MAN_TP           4  
 #define MAN_LP           5  
 #define MAN_PP           6  
 #define MAN_P            7  
 #define MAN_IP           8  
 #define MAN_HP           9  
 #define MAN_SM           10  
 #define MAN_SB           11  
 #define MAN_BI           12  
 #define MAN_IB           13  
 #define MAN_BR           14  
 #define MAN_RB           15  
 #define MAN_R            16  
 #define MAN_B            17  
 #define MAN_I            18  
 #define MAN_IR           19  
 #define MAN_MAX          20  
   
 enum    man_type {  enum    man_type {
         MAN_TEXT,          MAN_TEXT,
         MAN_ELEM,          MAN_ELEM,
         MAN_ROOT          MAN_ROOT,
           MAN_BLOCK,
           MAN_HEAD,
           MAN_BODY,
           MAN_TBL,
           MAN_EQN
 };  };
   
   /*
    * Information from prologue.
    */
 struct  man_meta {  struct  man_meta {
         int              msec;          char            *msec; /* `TH' section (1, 3p, etc.) */
         time_t           date;          char            *date; /* `TH' normalised date */
         char            *vol;          char            *vol; /* `TH' volume */
         char            *title;          char            *title; /* `TH' title (e.g., FOO) */
         char            *source;          char            *source; /* `TH' source (e.g., GNU) */
 };  };
   
   /*
    * Single node in tree-linked AST.
    */
 struct  man_node {  struct  man_node {
         struct man_node *parent;          struct man_node *parent; /* parent AST node */
         struct man_node *child;          struct man_node *child; /* first child AST node */
         struct man_node *next;          struct man_node *next; /* sibling AST node */
         struct man_node *prev;          struct man_node *prev; /* prior sibling AST node */
           int              nchild; /* number children */
         int              line;          int              line;
         int              pos;          int              pos;
         int              tok;          enum mant        tok; /* tok or MAN__MAX if none */
         int              flags;          int              flags;
 #define MAN_VALID       (1 << 0)  #define MAN_VALID       (1 << 0) /* has been validated */
 #define MAN_ACTED       (1 << 1)  #define MAN_EOS         (1 << 2) /* at sentence boundary */
         enum man_type    type;  #define MAN_LINE        (1 << 3) /* first macro/text on line */
         char            *string;          enum man_type    type; /* AST node type */
           char            *string; /* TEXT node argument */
           struct man_node *head; /* BLOCK node HEAD ptr */
           struct man_node *body; /* BLOCK node BODY ptr */
           const struct tbl_span *span; /* TBL */
           const struct eqn *eqn; /* EQN */
 };  };
   
 #define MAN_IGN_MACRO    (1 << 0) /* Ignore unknown macros. */  /*
    * Names of macros.  Index is enum mant.  Indexing into this returns
    * the normalised name, e.g., man_macronames[MAN_SH] -> "SH".
    */
 extern  const char *const *man_macronames;  extern  const char *const *man_macronames;
   
 struct  man_cb {  
         int     (*man_warn)(void *, int, int, const char *);  
         int     (*man_err)(void *, int, int, const char *);  
 };  
   
 __BEGIN_DECLS  __BEGIN_DECLS
   
 struct  man;  struct  man;
   
 void              man_free(struct man *);  void              man_free(struct man *);
 struct  man      *man_alloc(void *, int, const struct man_cb *);  struct  man      *man_alloc(struct regset *, void *, mandocmsg);
 void              man_reset(struct man *);  void              man_reset(struct man *);
 int               man_parseln(struct man *, int, char *buf);  int               man_parseln(struct man *, int, char *, int);
 int               man_endparse(struct man *);  int               man_endparse(struct man *);
 int               man_valid_post(struct man *);  int               man_addspan(struct man *,
                           const struct tbl_span *);
   int               man_addeqn(struct man *, const struct eqn *);
   
 const struct man_node *man_node(const struct man *);  const struct man_node *man_node(const struct man *);
 const struct man_meta *man_meta(const struct man *);  const struct man_meta *man_meta(const struct man *);
Legend:
Removed from v.1.5  
changed lines
  Added in v.1.54
CVSweb