libmdoc.h

   1 /*      $Id: libmdoc.h,v 1.50 2010/05/24 12:05:04 schwarze Exp $ */
   2 /*
   3  * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
   4  *
   5  * Permission to use, copy, modify, and distribute this software for any
   6  * purpose with or without fee is hereby granted, provided that the above
   7  * copyright notice and this permission notice appear in all copies.
   8  *
   9  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  10  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  11  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  12  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  13  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  14  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  15  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  16  */
  17 #ifndef LIBMDOC_H
  18 #define LIBMDOC_H
  19
  20 #include "mdoc.h"
  21
  22 enum    mdoc_next {
  23         MDOC_NEXT_SIBLING = 0,
  24         MDOC_NEXT_CHILD
  25 };
  26
  27 struct  mdoc {
  28         void             *data;
  29         mandocmsg         msg;
  30         int               flags;
  31 #define MDOC_HALT        (1 << 0) /* error in parse: halt */
  32 #define MDOC_LITERAL     (1 << 1) /* in a literal scope */
  33 #define MDOC_PBODY       (1 << 2) /* in the document body */
  34 #define MDOC_NEWLINE     (1 << 3) /* first macro/text in a line */
  35 #define MDOC_PHRASELIT   (1 << 4) /* literal within a partila phrase */
  36 #define MDOC_PPHRASE     (1 << 5) /* within a partial phrase */
  37         int               pflags;
  38         enum mdoc_next    next;
  39         struct mdoc_node *last;
  40         struct mdoc_node *first;
  41         struct mdoc_meta  meta;
  42         enum mdoc_sec     lastnamed;
  43         enum mdoc_sec     lastsec;
  44 };
  45
  46 #define MACRO_PROT_ARGS struct mdoc *m, enum mdoct tok, \
  47                         int line, int ppos, int *pos, char *buf
  48
  49 struct  mdoc_macro {
  50         int             (*fp)(MACRO_PROT_ARGS);
  51         int               flags;
  52 #define MDOC_CALLABLE    (1 << 0)
  53 #define MDOC_PARSED      (1 << 1)
  54 #define MDOC_EXPLICIT    (1 << 2)
  55 #define MDOC_PROLOGUE    (1 << 3)
  56 #define MDOC_IGNDELIM    (1 << 4)
  57         /* Reserved words in arguments treated as text. */
  58 };
  59
  60 enum    margserr {
  61         ARGS_ERROR,
  62         ARGS_EOLN,
  63         ARGS_WORD,
  64         ARGS_PUNCT,
  65         ARGS_QWORD,
  66         ARGS_PHRASE,
  67         ARGS_PPHRASE,
  68         ARGS_PEND
  69 };
  70
  71 enum    margverr {
  72         ARGV_ERROR,
  73         ARGV_EOLN,
  74         ARGV_ARG,
  75         ARGV_WORD
  76 };
  77
  78 enum    mdelim {
  79         DELIM_NONE = 0,
  80         DELIM_OPEN,
  81         DELIM_MIDDLE,
  82         DELIM_CLOSE
  83 };
  84
  85 extern  const struct mdoc_macro *const mdoc_macros;
  86
  87 __BEGIN_DECLS
  88
  89 #define           mdoc_pmsg(m, l, p, t) \
  90                   (*(m)->msg)((t), (m)->data, (l), (p), NULL)
  91 #define           mdoc_nmsg(m, n, t) \
  92                   (*(m)->msg)((t), (m)->data, (n)->line, (n)->pos, NULL)
  93 int               mdoc_vmsg(struct mdoc *, enum mandocerr,
  94                         int, int, const char *, ...);
  95 int               mdoc_macro(MACRO_PROT_ARGS);
  96 int               mdoc_word_alloc(struct mdoc *,
  97                         int, int, const char *);
  98 int               mdoc_elem_alloc(struct mdoc *, int, int,
  99                         enum mdoct, struct mdoc_arg *);
 100 int               mdoc_block_alloc(struct mdoc *, int, int,
 101                         enum mdoct, struct mdoc_arg *);
 102 int               mdoc_head_alloc(struct mdoc *, int, int, enum mdoct);
 103 int               mdoc_tail_alloc(struct mdoc *, int, int, enum mdoct);
 104 int               mdoc_body_alloc(struct mdoc *, int, int, enum mdoct);
 105 void              mdoc_node_delete(struct mdoc *, struct mdoc_node *);
 106 void              mdoc_hash_init(void);
 107 enum mdoct        mdoc_hash_find(const char *);
 108 enum mdelim       mdoc_iscdelim(char);
 109 enum mdelim       mdoc_isdelim(const char *);
 110 size_t            mdoc_isescape(const char *);
 111 enum    mdoc_sec  mdoc_str2sec(const char *);
 112 time_t            mdoc_atotime(const char *);
 113 size_t            mdoc_macro2len(enum mdoct);
 114 const char       *mdoc_a2att(const char *);
 115 const char       *mdoc_a2lib(const char *);
 116 const char       *mdoc_a2st(const char *);
 117 const char       *mdoc_a2arch(const char *);
 118 const char       *mdoc_a2vol(const char *);
 119 const char       *mdoc_a2msec(const char *);
 120 int               mdoc_valid_pre(struct mdoc *,
 121                         const struct mdoc_node *);
 122 int               mdoc_valid_post(struct mdoc *);
 123 int               mdoc_action_pre(struct mdoc *,
 124                         struct mdoc_node *);
 125 int               mdoc_action_post(struct mdoc *);
 126 enum margverr     mdoc_argv(struct mdoc *, int, enum mdoct,
 127                         struct mdoc_arg **, int *, char *);
 128 void              mdoc_argv_free(struct mdoc_arg *);
 129 void              mdoc_argn_free(struct mdoc_arg *, int);
 130 enum margserr     mdoc_args(struct mdoc *, int,
 131                         int *, char *, enum mdoct, char **);
 132 enum margserr     mdoc_zargs(struct mdoc *, int,
 133                         int *, char *, int, char **);
 134 #define ARGS_DELIM      (1 << 1)
 135 #define ARGS_TABSEP     (1 << 2)
 136 #define ARGS_NOWARN     (1 << 3)
 137
 138 int               mdoc_macroend(struct mdoc *);
 139
 140 __END_DECLS
 141
 142 #endif /*!LIBMDOC_H*/