libmdoc.h

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