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

Diff for /mandoc/libmdoc.h between version 1.10 and 1.79

version 1.10, 2009/06/15 10:36:01 version 1.79, 2012/05/27 17:48:57
Line 1 
Line 1 
 /*      $Id$ */  /*      $Id$ */
 /*  /*
  * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>   * Copyright (c) 2008, 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 above   * purpose with or without fee is hereby granted, provided that the above
Line 17 
Line 17 
 #ifndef LIBMDOC_H  #ifndef LIBMDOC_H
 #define LIBMDOC_H  #define LIBMDOC_H
   
 #include "mdoc.h"  
   
 enum    mdoc_next {  enum    mdoc_next {
         MDOC_NEXT_SIBLING = 0,          MDOC_NEXT_SIBLING = 0,
         MDOC_NEXT_CHILD          MDOC_NEXT_CHILD
 };  };
   
 struct  mdoc {  struct  mdoc {
         void             *data;          struct mparse    *parse; /* parse pointer */
         struct mdoc_cb    cb;          char             *defos; /* default argument for .Os */
         void             *htab;          int               flags; /* parse flags */
         int               flags;  #define MDOC_HALT        (1 << 0) /* error in parse: halt */
 #define MDOC_HALT        (1 << 0)  #define MDOC_LITERAL     (1 << 1) /* in a literal scope */
 #define MDOC_LITERAL     (1 << 1)  #define MDOC_PBODY       (1 << 2) /* in the document body */
         int               pflags;  #define MDOC_NEWLINE     (1 << 3) /* first macro/text in a line */
         enum mdoc_next    next;  #define MDOC_PHRASELIT   (1 << 4) /* literal within a partila phrase */
         struct mdoc_node *last;  #define MDOC_PPHRASE     (1 << 5) /* within a partial phrase */
         struct mdoc_node *first;  #define MDOC_FREECOL     (1 << 6) /* `It' invocation should close */
         struct mdoc_meta  meta;  #define MDOC_SYNOPSIS    (1 << 7) /* SYNOPSIS-style formatting */
           enum mdoc_next    next; /* where to put the next node */
           struct mdoc_node *last; /* the last node parsed */
           struct mdoc_node *first; /* the first node parsed */
           struct mdoc_meta  meta; /* document meta-data */
         enum mdoc_sec     lastnamed;          enum mdoc_sec     lastnamed;
         enum mdoc_sec     lastsec;          enum mdoc_sec     lastsec;
           struct roff      *roff;
 };  };
   
   #define MACRO_PROT_ARGS struct mdoc *m, \
                           enum mdoct tok, \
                           int line, \
                           int ppos, \
                           int *pos, \
                           char *buf
   
 #define MACRO_PROT_ARGS struct mdoc *mdoc, int tok, int line, \  
                         int ppos, int *pos, char *buf  
   
 struct  mdoc_macro {  struct  mdoc_macro {
         int             (*fp)(MACRO_PROT_ARGS);          int             (*fp)(MACRO_PROT_ARGS);
         int               flags;          int               flags;
Line 55  struct mdoc_macro {
Line 61  struct mdoc_macro {
         /* Reserved words in arguments treated as text. */          /* Reserved words in arguments treated as text. */
 };  };
   
   enum    margserr {
           ARGS_ERROR,
           ARGS_EOLN, /* end-of-line */
           ARGS_WORD, /* normal word */
           ARGS_PUNCT, /* series of punctuation */
           ARGS_QWORD, /* quoted word */
           ARGS_PHRASE, /* Ta'd phrase (-column) */
           ARGS_PPHRASE, /* tabbed phrase (-column) */
           ARGS_PEND /* last phrase (-column) */
   };
   
   enum    margverr {
           ARGV_ERROR,
           ARGV_EOLN, /* end of line */
           ARGV_ARG, /* valid argument */
           ARGV_WORD /* normal word (or bad argument---same thing) */
   };
   
   /*
    * A punctuation delimiter is opening, closing, or "middle mark"
    * punctuation.  These govern spacing.
    * Opening punctuation (e.g., the opening parenthesis) suppresses the
    * following space; closing punctuation (e.g., the closing parenthesis)
    * suppresses the leading space; middle punctuation (e.g., the vertical
    * bar) can do either.  The middle punctuation delimiter bends the rules
    * depending on usage.
    */
   enum    mdelim {
           DELIM_NONE = 0,
           DELIM_OPEN,
           DELIM_MIDDLE,
           DELIM_CLOSE,
           DELIM_MAX
   };
   
 extern  const struct mdoc_macro *const mdoc_macros;  extern  const struct mdoc_macro *const mdoc_macros;
   
 __BEGIN_DECLS  __BEGIN_DECLS
   
 /*  #define           mdoc_pmsg(m, l, p, t) \
  * When GCC2 is deprecated, most of these can be reverted to #define                    mandoc_msg((t), (m)->parse, (l), (p), NULL)
  * as mdoc_vXXX using __VA_ARGS__.  Until then, use real functions.  #define           mdoc_nmsg(m, n, t) \
  */                    mandoc_msg((t), (m)->parse, (n)->line, (n)->pos, NULL)
 int               mdoc_vwarn(struct mdoc *, int, int,  
                         enum mdoc_warn, const char *, ...);  
 int               mdoc_verr(struct mdoc *, int, int,  
                         const char *, ...);  
 int               mdoc_nerr(struct mdoc *, const struct mdoc_node *,  
                         const char *, ...);  
 int               mdoc_warn(struct mdoc *, enum mdoc_warn, const char *, ...);  
 int               mdoc_err(struct mdoc *, const char *, ...);  
 int               mdoc_pwarn(struct mdoc *, int, int,  
                         enum mdoc_warn,const char *, ...);  
 int               mdoc_perr(struct mdoc *, int, int, const char *, ...);  
 int               mdoc_macro(MACRO_PROT_ARGS);  int               mdoc_macro(MACRO_PROT_ARGS);
 int               mdoc_word_alloc(struct mdoc *,  int               mdoc_word_alloc(struct mdoc *,
                         int, int, const char *);                          int, int, const char *);
 int               mdoc_elem_alloc(struct mdoc *, int, int,  int               mdoc_elem_alloc(struct mdoc *, int, int,
                         int, struct mdoc_arg *);                          enum mdoct, struct mdoc_arg *);
 int               mdoc_block_alloc(struct mdoc *, int, int,  int               mdoc_block_alloc(struct mdoc *, int, int,
                         int, struct mdoc_arg *);                          enum mdoct, struct mdoc_arg *);
 int               mdoc_head_alloc(struct mdoc *, int, int, int);  int               mdoc_head_alloc(struct mdoc *, int, int, enum mdoct);
 int               mdoc_tail_alloc(struct mdoc *, int, int, int);  int               mdoc_tail_alloc(struct mdoc *, int, int, enum mdoct);
 int               mdoc_body_alloc(struct mdoc *, int, int, int);  int               mdoc_body_alloc(struct mdoc *, int, int, enum mdoct);
 void              mdoc_node_free(struct mdoc_node *);  int               mdoc_endbody_alloc(struct mdoc *m, int line, int pos,
 void              mdoc_node_freelist(struct mdoc_node *);                          enum mdoct tok, struct mdoc_node *body,
 void             *mdoc_hash_alloc(void);                          enum mdoc_endbody end);
 int               mdoc_hash_find(const void *, const char *);  void              mdoc_node_delete(struct mdoc *, struct mdoc_node *);
 void              mdoc_hash_free(void *);  void              mdoc_hash_init(void);
 int               mdoc_iscdelim(char);  enum mdoct        mdoc_hash_find(const char *);
 int               mdoc_isdelim(const char *);  const char       *mdoc_a2att(const char *);
 size_t            mdoc_isescape(const char *);  const char       *mdoc_a2lib(const char *);
 enum    mdoc_sec  mdoc_atosec(const char *);  const char       *mdoc_a2st(const char *);
 time_t            mdoc_atotime(const char *);  
   
 size_t            mdoc_macro2len(int);  
 const char       *mdoc_a2arch(const char *);  const char       *mdoc_a2arch(const char *);
 const char       *mdoc_a2vol(const char *);  const char       *mdoc_a2vol(const char *);
 const char       *mdoc_a2msec(const char *);  int               mdoc_valid_pre(struct mdoc *, struct mdoc_node *);
 int               mdoc_valid_pre(struct mdoc *,  
                         const struct mdoc_node *);  
 int               mdoc_valid_post(struct mdoc *);  int               mdoc_valid_post(struct mdoc *);
 int               mdoc_action_pre(struct mdoc *,  enum margverr     mdoc_argv(struct mdoc *, int, enum mdoct,
                         const struct mdoc_node *);  
 int               mdoc_action_post(struct mdoc *);  
 int               mdoc_argv(struct mdoc *, int, int,  
                         struct mdoc_arg **, int *, char *);                          struct mdoc_arg **, int *, char *);
 #define ARGV_ERROR      (-1)  
 #define ARGV_EOLN       (0)  
 #define ARGV_ARG        (1)  
 #define ARGV_WORD       (2)  
 void              mdoc_argv_free(struct mdoc_arg *);  void              mdoc_argv_free(struct mdoc_arg *);
 int               mdoc_args(struct mdoc *, int,  enum margserr     mdoc_args(struct mdoc *, int,
                         int *, char *, int, char **);                          int *, char *, enum mdoct, char **);
 #define ARGS_ERROR      (-1)  enum margserr     mdoc_zargs(struct mdoc *, int,
 #define ARGS_EOLN       (0)                          int *, char *, char **);
 #define ARGS_WORD       (1)  
 #define ARGS_PUNCT      (2)  
 #define ARGS_QWORD      (3)  
 #define ARGS_PHRASE     (4)  
   
 int               mdoc_macroend(struct mdoc *);  int               mdoc_macroend(struct mdoc *);
   enum mdelim       mdoc_isdelim(const char *);
   
 __END_DECLS  __END_DECLS
   
Legend:
Removed from v.1.10  
changed lines
  Added in v.1.79
CVSweb