[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.111

version 1.3, 2009/03/31 13:50:19 version 1.111, 2017/04/29 12:45:41
Line 1 
Line 1 
 /* $Id$ */  /*      $Id$ */
 /*  /*
  * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@openbsd.org>   * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
    * Copyright (c) 2013, 2014, 2015, 2017 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 LIBMDOC_H  
 #define LIBMDOC_H  
   
 #include "mdoc.h"  #define MACRO_PROT_ARGS struct roff_man *mdoc, \
                           enum roff_tok tok, \
                           int line, \
                           int ppos, \
                           int *pos, \
                           char *buf
   
 enum    mdoc_next {  
         MDOC_NEXT_SIBLING = 0,  
         MDOC_NEXT_CHILD  
 };  
   
 struct  mdoc {  
         void             *data;  
         struct mdoc_cb    cb;  
         void             *htab;  
         int               flags;  
 #define MDOC_HALT        (1 << 0)  
 #define MDOC_LITERAL     (1 << 1)  
         int               pflags;  
         enum mdoc_next    next;  
         struct mdoc_node *last;  
         struct mdoc_node *first;  
         struct mdoc_meta  meta;  
         enum mdoc_sec     lastnamed;  
         enum mdoc_sec     lastsec;  
 };  
   
   
 #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);          void            (*fp)(MACRO_PROT_ARGS);
         int               flags;          int               flags;
 #define MDOC_CALLABLE    (1 << 0)  #define MDOC_CALLABLE    (1 << 0)
 #define MDOC_PARSED      (1 << 1)  #define MDOC_PARSED      (1 << 1)
 #define MDOC_EXPLICIT    (1 << 2)  #define MDOC_EXPLICIT    (1 << 2)
 #define MDOC_PROLOGUE    (1 << 3)  #define MDOC_PROLOGUE    (1 << 3)
 #define MDOC_IGNDELIM    (1 << 4)  #define MDOC_IGNDELIM    (1 << 4)
         /* Reserved words in arguments treated as text. */  #define MDOC_JOIN        (1 << 5)
 };  };
   
 #define mdoc_nwarn(mdoc, node, type, fmt, ...) \  enum    margserr {
                   mdoc_vwarn((mdoc), (node)->line, \          ARGS_ERROR,
                   (node)->pos, (type), (fmt), ##__VA_ARGS__)          ARGS_EOLN, /* end-of-line */
           ARGS_WORD, /* normal word */
           ARGS_PUNCT, /* series of punctuation */
           ARGS_QWORD, /* quoted word */
           ARGS_PHRASE /* Bl -column phrase */
   };
   
 #define mdoc_nerr(mdoc, node, fmt, ...) \  /*
                   mdoc_verr((mdoc), (node)->line, \   * A punctuation delimiter is opening, closing, or "middle mark"
                   (node)->pos, (fmt), ##__VA_ARGS__)   * 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
   };
   
 #define mdoc_warn(mdoc, type, fmt, ...) \  
                   mdoc_vwarn((mdoc), (mdoc)->last->line, \  
                   (mdoc)->last->pos, (type), (fmt), ##__VA_ARGS__)  
   
 #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  
   
 int               mdoc_vwarn(struct mdoc *, int, int,  void              mdoc_macro(MACRO_PROT_ARGS);
                         enum mdoc_warn, const char *, ...);  void              mdoc_elem_alloc(struct roff_man *, int, int,
 void              mdoc_vmsg(struct mdoc *, int, int,                          enum roff_tok, struct mdoc_arg *);
                         const char *, ...);  struct roff_node *mdoc_block_alloc(struct roff_man *, int, int,
 int               mdoc_verr(struct mdoc *, int, int,                          enum roff_tok, struct mdoc_arg *);
                         const char *, ...);  void              mdoc_tail_alloc(struct roff_man *, int, int,
 int               mdoc_macro(MACRO_PROT_ARGS);                          enum roff_tok);
 int               mdoc_word_alloc(struct mdoc *,  struct roff_node *mdoc_endbody_alloc(struct roff_man *, int, int,
                         int, int, const char *);                          enum roff_tok, struct roff_node *);
 int               mdoc_elem_alloc(struct mdoc *, int, int,  void              mdoc_node_relink(struct roff_man *, struct roff_node *);
                         int, struct mdoc_arg *);  void              mdoc_node_validate(struct roff_man *);
 int               mdoc_block_alloc(struct mdoc *, int, int,  void              mdoc_state(struct roff_man *, struct roff_node *);
                         int, struct mdoc_arg *);  void              mdoc_state_reset(struct roff_man *);
 int               mdoc_head_alloc(struct mdoc *, int, int, int);  
 int               mdoc_tail_alloc(struct mdoc *, int, int, int);  
 int               mdoc_body_alloc(struct mdoc *, int, int, int);  
 void              mdoc_node_free(struct mdoc_node *);  
 void              mdoc_node_freelist(struct mdoc_node *);  
 void             *mdoc_tokhash_alloc(void);  
 int               mdoc_tokhash_find(const void *, const char *);  
 void              mdoc_tokhash_free(void *);  
 int               mdoc_iscdelim(char);  
 int               mdoc_isdelim(const char *);  
 size_t            mdoc_isescape(const char *);  
 enum    mdoc_sec  mdoc_atosec(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_a2att(const char *);
 const char       *mdoc_a2msec(const char *);  const char       *mdoc_a2lib(const char *);
 int               mdoc_valid_pre(struct mdoc *,  enum roff_sec     mdoc_a2sec(const char *);
                         const struct mdoc_node *);  const char       *mdoc_a2st(const char *);
 int               mdoc_valid_post(struct mdoc *);  void              mdoc_argv(struct roff_man *, int, enum roff_tok,
 int               mdoc_action_pre(struct mdoc *,  
                         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)  enum margserr     mdoc_args(struct roff_man *, int,
 #define ARGV_EOLN       (0)                          int *, char *, enum roff_tok, char **);
 #define ARGV_ARG        (1)  enum mdelim       mdoc_isdelim(const char *);
 #define ARGV_WORD       (2)  
 void              mdoc_argv_free(struct mdoc_arg *);  
 int               mdoc_args(struct mdoc *, int,  
                         int *, char *, int, char **);  
 #define ARGS_ERROR      (-1)  
 #define ARGS_EOLN       (0)  
 #define ARGS_WORD       (1)  
 #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 *);  
   
 __END_DECLS  
   
 #endif /*!LIBMDOC_H*/  
Legend:
Removed from v.1.3  
changed lines
  Added in v.1.111
CVSweb