libmdoc.h

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