libmdoc.h

   1 /*      $Id: libmdoc.h,v 1.47 2010/05/15 16:24:37 kristaps 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         struct mdoc_cb    cb;
  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 enum    merr {
  47         ETAILWS = 0,
  48         EQUOTPARM,
  49         EQUOTTERM,
  50         EARGVAL,
  51         EBODYPROL,
  52         EPROLBODY,
  53         ETEXTPROL,
  54         ENOBLANK,
  55         ETOOLONG,
  56         EESCAPE,
  57         EPRINT,
  58         ENODAT,
  59         ENOPROLOGUE,
  60         ELINE,
  61         EATT,
  62         ENAME,
  63         ELISTTYPE,
  64         EDISPTYPE,
  65         EMULTIDISP,
  66         EMULTILIST,
  67         ESECNAME,
  68         ENAMESECINC,
  69         EARGREP,
  70         EBOOL,
  71         ECOLMIS,
  72         ENESTDISP,
  73         EMISSWIDTH,
  74         EWRONGMSEC,
  75         ESECOOO,
  76         ESECREP,
  77         EBADSTAND,
  78         ENOMULTILINE,
  79         EMULTILINE,
  80         ENOLINE,
  81         EPROLOOO,
  82         EPROLREP,
  83         EBADMSEC,
  84         EFONT,
  85         EBADDATE,
  86         ENUMFMT,
  87         ENOWIDTH,
  88         EUTSNAME,
  89         EOBS,
  90         EIMPBRK,
  91         EIGNE,
  92         EOPEN,
  93         EQUOTPHR,
  94         ENOCTX,
  95         ELIB,
  96         EBADCHILD,
  97         ENOTYPE,
  98         EBADCOMMENT,
  99         MERRMAX
 100 };
 101
 102 #define MACRO_PROT_ARGS struct mdoc *m, enum mdoct tok, \
 103                         int line, int ppos, int *pos, char *buf
 104
 105 struct  mdoc_macro {
 106         int             (*fp)(MACRO_PROT_ARGS);
 107         int               flags;
 108 #define MDOC_CALLABLE    (1 << 0)
 109 #define MDOC_PARSED      (1 << 1)
 110 #define MDOC_EXPLICIT    (1 << 2)
 111 #define MDOC_PROLOGUE    (1 << 3)
 112 #define MDOC_IGNDELIM    (1 << 4)
 113         /* Reserved words in arguments treated as text. */
 114 };
 115
 116 enum    margserr {
 117         ARGS_ERROR,
 118         ARGS_EOLN,
 119         ARGS_WORD,
 120         ARGS_PUNCT,
 121         ARGS_QWORD,
 122         ARGS_PHRASE,
 123         ARGS_PPHRASE,
 124         ARGS_PEND
 125 };
 126
 127 enum    margverr {
 128         ARGV_ERROR,
 129         ARGV_EOLN,
 130         ARGV_ARG,
 131         ARGV_WORD
 132 };
 133
 134 enum    mdelim {
 135         DELIM_NONE = 0,
 136         DELIM_OPEN,
 137         DELIM_MIDDLE,
 138         DELIM_CLOSE
 139 };
 140
 141 extern  const struct mdoc_macro *const mdoc_macros;
 142
 143 __BEGIN_DECLS
 144
 145 #define           mdoc_perr(m, l, p, t) \
 146                   mdoc_err((m), (l), (p), 1, (t))
 147 #define           mdoc_pwarn(m, l, p, t) \
 148                   mdoc_err((m), (l), (p), 0, (t))
 149 #define           mdoc_nerr(m, n, t) \
 150                   mdoc_err((m), (n)->line, (n)->pos, 1, (t))
 151 #define           mdoc_nwarn(m, n, t) \
 152                   mdoc_err((m), (n)->line, (n)->pos, 0, (t))
 153
 154 int               mdoc_err(struct mdoc *, int, int, int, enum merr);
 155 int               mdoc_verr(struct mdoc *, int, int, const char *, ...);
 156 int               mdoc_vwarn(struct mdoc *, int, int, const char *, ...);
 157
 158 int               mdoc_macro(MACRO_PROT_ARGS);
 159 int               mdoc_word_alloc(struct mdoc *,
 160                         int, int, const char *);
 161 int               mdoc_elem_alloc(struct mdoc *, int, int,
 162                         enum mdoct, struct mdoc_arg *);
 163 int               mdoc_block_alloc(struct mdoc *, int, int,
 164                         enum mdoct, struct mdoc_arg *);
 165 int               mdoc_head_alloc(struct mdoc *, int, int, enum mdoct);
 166 int               mdoc_tail_alloc(struct mdoc *, int, int, enum mdoct);
 167 int               mdoc_body_alloc(struct mdoc *, int, int, enum mdoct);
 168 void              mdoc_node_delete(struct mdoc *, struct mdoc_node *);
 169 void              mdoc_hash_init(void);
 170 enum mdoct        mdoc_hash_find(const char *);
 171 enum mdelim       mdoc_iscdelim(char);
 172 enum mdelim       mdoc_isdelim(const char *);
 173 size_t            mdoc_isescape(const char *);
 174 enum    mdoc_sec  mdoc_str2sec(const char *);
 175 time_t            mdoc_atotime(const char *);
 176 size_t            mdoc_macro2len(enum mdoct);
 177 const char       *mdoc_a2att(const char *);
 178 const char       *mdoc_a2lib(const char *);
 179 const char       *mdoc_a2st(const char *);
 180 const char       *mdoc_a2arch(const char *);
 181 const char       *mdoc_a2vol(const char *);
 182 const char       *mdoc_a2msec(const char *);
 183 int               mdoc_valid_pre(struct mdoc *,
 184                         const struct mdoc_node *);
 185 int               mdoc_valid_post(struct mdoc *);
 186 int               mdoc_action_pre(struct mdoc *,
 187                         const struct mdoc_node *);
 188 int               mdoc_action_post(struct mdoc *);
 189 enum margverr     mdoc_argv(struct mdoc *, int, enum mdoct,
 190                         struct mdoc_arg **, int *, char *);
 191 void              mdoc_argv_free(struct mdoc_arg *);
 192 void              mdoc_argn_free(struct mdoc_arg *, int);
 193 enum margserr     mdoc_args(struct mdoc *, int,
 194                         int *, char *, enum mdoct, char **);
 195 enum margserr     mdoc_zargs(struct mdoc *, int,
 196                         int *, char *, int, char **);
 197 #define ARGS_DELIM      (1 << 1)
 198 #define ARGS_TABSEP     (1 << 2)
 199 #define ARGS_NOWARN     (1 << 3)
 200
 201 int               mdoc_macroend(struct mdoc *);
 202
 203 __END_DECLS
 204
 205 #endif /*!LIBMDOC_H*/