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

Diff for /mandoc/libmdoc.h between version 1.3 and 1.63

version 1.3, 2009/03/31 13:50:19 version 1.63, 2010/11/30 13:04:14
Line 1 
Line 1 
 /* $Id$ */  /*      $Id$ */
 /*  /*
  * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@openbsd.org>   * Copyright (c) 2008, 2009, 2010 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 LIBMDOC_H  #ifndef LIBMDOC_H
 #define LIBMDOC_H  #define LIBMDOC_H
Line 27  enum mdoc_next {
Line 25  enum mdoc_next {
 };  };
   
 struct  mdoc {  struct  mdoc {
         void             *data;          void             *data; /* private application data */
         struct mdoc_cb    cb;          mandocmsg         msg; /* message callback */
         void             *htab;  
         int               flags;          int               flags;
 #define MDOC_HALT        (1 << 0)  #define MDOC_HALT        (1 << 0) /* error in parse: halt */
 #define MDOC_LITERAL     (1 << 1)  #define MDOC_LITERAL     (1 << 1) /* in a literal scope */
         int               pflags;  #define MDOC_PBODY       (1 << 2) /* in the document body */
         enum mdoc_next    next;  #define MDOC_NEWLINE     (1 << 3) /* first macro/text in a line */
         struct mdoc_node *last;  #define MDOC_PHRASELIT   (1 << 4) /* literal within a partila phrase */
         struct mdoc_node *first;  #define MDOC_PPHRASE     (1 << 5) /* within a partial phrase */
         struct mdoc_meta  meta;  #define MDOC_FREECOL     (1 << 6) /* `It' invocation should close */
   #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 regset    *regs; /* registers */
 };  };
   
   #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 57  struct mdoc_macro {
Line 63  struct mdoc_macro {
         /* Reserved words in arguments treated as text. */          /* Reserved words in arguments treated as text. */
 };  };
   
 #define mdoc_nwarn(mdoc, node, type, fmt, ...) \  enum    margserr {
                   mdoc_vwarn((mdoc), (node)->line, \          ARGS_ERROR,
                   (node)->pos, (type), (fmt), ##__VA_ARGS__)          ARGS_EOLN,
           ARGS_WORD,
           ARGS_PUNCT,
           ARGS_QWORD,
           ARGS_PHRASE,
           ARGS_PPHRASE,
           ARGS_PEND
   };
   
 #define mdoc_nerr(mdoc, node, fmt, ...) \  enum    margverr {
                   mdoc_verr((mdoc), (node)->line, \          ARGV_ERROR,
                   (node)->pos, (fmt), ##__VA_ARGS__)          ARGV_EOLN,
           ARGV_ARG,
           ARGV_WORD
   };
   
 #define mdoc_warn(mdoc, type, fmt, ...) \  enum    mdelim {
                   mdoc_vwarn((mdoc), (mdoc)->last->line, \          DELIM_NONE = 0,
                   (mdoc)->last->pos, (type), (fmt), ##__VA_ARGS__)          DELIM_OPEN,
           DELIM_MIDDLE,
           DELIM_CLOSE
   };
   
 #define mdoc_err(mdoc, fmt, ...) \  
                   mdoc_verr((mdoc), (mdoc)->last->line, \  
                   (mdoc)->last->pos, (fmt), ##__VA_ARGS__)  
   
 #define mdoc_msg(mdoc, fmt, ...) \  
                   mdoc_vmsg((mdoc), (mdoc)->last->line, \  
                   (mdoc)->last->pos, (fmt), ##__VA_ARGS__)  
   
 #define mdoc_pmsg(mdoc, line, pos, fmt, ...) \  
                   mdoc_vmsg((mdoc), (line), \  
                   (pos), (fmt), ##__VA_ARGS__)  
   
 #define mdoc_pwarn(mdoc, line, pos, type, fmt, ...) \  
                   mdoc_vwarn((mdoc), (line), \  
                   (pos), (type), (fmt), ##__VA_ARGS__)  
   
 #define mdoc_perr(mdoc, line, pos, fmt, ...) \  
                   mdoc_verr((mdoc), (line), \  
                   (pos), (fmt), ##__VA_ARGS__)  
   
 extern  const struct mdoc_macro *const mdoc_macros;  extern  const struct mdoc_macro *const mdoc_macros;
   
 __BEGIN_DECLS  __BEGIN_DECLS
   
 int               mdoc_vwarn(struct mdoc *, int, int,  #define           mdoc_pmsg(m, l, p, t) \
                         enum mdoc_warn, const char *, ...);                    (*(m)->msg)((t), (m)->data, (l), (p), NULL)
 void              mdoc_vmsg(struct mdoc *, int, int,  #define           mdoc_nmsg(m, n, t) \
                         const char *, ...);                    (*(m)->msg)((t), (m)->data, (n)->line, (n)->pos, NULL)
 int               mdoc_verr(struct mdoc *, int, int,  int               mdoc_vmsg(struct mdoc *, enum mandocerr,
                         const char *, ...);                          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_tokhash_alloc(void);                          enum mdoc_endbody end);
 int               mdoc_tokhash_find(const void *, const char *);  void              mdoc_node_delete(struct mdoc *, struct mdoc_node *);
 void              mdoc_tokhash_free(void *);  void              mdoc_hash_init(void);
 int               mdoc_iscdelim(char);  enum mdoct        mdoc_hash_find(const char *);
 int               mdoc_isdelim(const char *);  enum mdelim       mdoc_iscdelim(char);
   enum mdelim       mdoc_isdelim(const char *);
 size_t            mdoc_isescape(const char *);  size_t            mdoc_isescape(const char *);
 enum    mdoc_sec  mdoc_atosec(const char *);  enum    mdoc_sec  mdoc_str2sec(const char *);
 time_t            mdoc_atotime(const char *);  time_t            mdoc_atotime(const char *);
   size_t            mdoc_macro2len(enum mdoct);
 size_t            mdoc_macro2len(int);  const char       *mdoc_a2att(const char *);
   const char       *mdoc_a2lib(const char *);
   const char       *mdoc_a2st(const char *);
 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 *);  const char       *mdoc_a2msec(const char *);
 int               mdoc_valid_pre(struct mdoc *,  int               mdoc_valid_pre(struct mdoc *, struct mdoc_node *);
                         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,  void              mdoc_argn_free(struct mdoc_arg *, int);
   enum margserr     mdoc_args(struct mdoc *, int,
                           int *, char *, enum mdoct, char **);
   enum margserr     mdoc_zargs(struct mdoc *, int,
                         int *, char *, int, char **);                          int *, char *, int, char **);
 #define ARGS_ERROR      (-1)  #define ARGS_DELIM      (1 << 1)
 #define ARGS_EOLN       (0)  #define ARGS_TABSEP     (1 << 2)
 #define ARGS_WORD       (1)  #define ARGS_NOWARN     (1 << 3)
 #define ARGS_PUNCT      (2)  
 #define ARGS_QWORD      (3)  
 #define ARGS_PHRASE     (4)  
   
 /* FIXME: get rid of these. */  
 int               xstrlcpys(char *, const struct mdoc_node *, size_t);  
 void             *xrealloc(void *, size_t);  
 char             *xstrdup(const char *);  
 int               mdoc_macroend(struct mdoc *);  int               mdoc_macroend(struct mdoc *);
   
 __END_DECLS  __END_DECLS
Legend:
Removed from v.1.3  
changed lines
  Added in v.1.63
CVSweb