libmdoc.h

   1 /*      $Id: libmdoc.h,v 1.59 2010/07/01 22:35:54 schwarze Exp $ */
   2 /*
   3  * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@bsd.lv>
   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 "regs.h"
  21 #include "mdoc.h"
  22
  23 enum    mdoc_next {
  24         MDOC_NEXT_SIBLING = 0,
  25         MDOC_NEXT_CHILD
  26 };
  27
  28 struct  mdoc {
  29         void             *data; /* private application data */
  30         mandocmsg         msg; /* message callback */
  31         int               flags;
  32 #define MDOC_HALT        (1 << 0) /* error in parse: halt */
  33 #define MDOC_LITERAL     (1 << 1) /* in a literal scope */
  34 #define MDOC_PBODY       (1 << 2) /* in the document body */
  35 #define MDOC_NEWLINE     (1 << 3) /* first macro/text in a line */
  36 #define MDOC_PHRASELIT   (1 << 4) /* literal within a partila phrase */
  37 #define MDOC_PPHRASE     (1 << 5) /* within a partial phrase */
  38 #define MDOC_FREECOL     (1 << 6) /* `It' invocation should close */
  39 #define MDOC_SYNOPSIS    (1 << 7) /* SYNOPSIS-style formatting */
  40         int               pflags;
  41         enum mdoc_next    next; /* where to put the next node */
  42         struct mdoc_node *last; /* the last node parsed */
  43         struct mdoc_node *first; /* the first node parsed */
  44         struct mdoc_meta  meta; /* document meta-data */
  45         enum mdoc_sec     lastnamed;
  46         enum mdoc_sec     lastsec;
  47         struct regset    *regs; /* registers */
  48 };
  49
  50 #define MACRO_PROT_ARGS struct mdoc *m, \
  51                         enum mdoct tok, \
  52                         int line, \
  53                         int ppos, \
  54                         int *pos, \
  55                         char *buf
  56
  57 struct  mdoc_macro {
  58         int             (*fp)(MACRO_PROT_ARGS);
  59         int               flags;
  60 #define MDOC_CALLABLE    (1 << 0)
  61 #define MDOC_PARSED      (1 << 1)
  62 #define MDOC_EXPLICIT    (1 << 2)
  63 #define MDOC_PROLOGUE    (1 << 3)
  64 #define MDOC_IGNDELIM    (1 << 4)
  65         /* Reserved words in arguments treated as text. */
  66 };
  67
  68 enum    margserr {
  69         ARGS_ERROR,
  70         ARGS_EOLN,
  71         ARGS_WORD,
  72         ARGS_PUNCT,
  73         ARGS_QWORD,
  74         ARGS_PHRASE,
  75         ARGS_PPHRASE,
  76         ARGS_PEND
  77 };
  78
  79 enum    margverr {
  80         ARGV_ERROR,
  81         ARGV_EOLN,
  82         ARGV_ARG,
  83         ARGV_WORD
  84 };
  85
  86 enum    mdelim {
  87         DELIM_NONE = 0,
  88         DELIM_OPEN,
  89         DELIM_MIDDLE,
  90         DELIM_CLOSE
  91 };
  92
  93 extern  const struct mdoc_macro *const mdoc_macros;
  94
  95 __BEGIN_DECLS
  96
  97 #define           mdoc_pmsg(m, l, p, t) \
  98                   (*(m)->msg)((t), (m)->data, (l), (p), NULL)
  99 #define           mdoc_nmsg(m, n, t) \
 100                   (*(m)->msg)((t), (m)->data, (n)->line, (n)->pos, NULL)
 101 int               mdoc_vmsg(struct mdoc *, enum mandocerr,
 102                         int, int, const char *, ...);
 103 int               mdoc_macro(MACRO_PROT_ARGS);
 104 int               mdoc_word_alloc(struct mdoc *,
 105                         int, int, const char *);
 106 int               mdoc_elem_alloc(struct mdoc *, int, int,
 107                         enum mdoct, struct mdoc_arg *);
 108 int               mdoc_block_alloc(struct mdoc *, int, int,
 109                         enum mdoct, struct mdoc_arg *);
 110 int               mdoc_head_alloc(struct mdoc *, int, int, enum mdoct);
 111 int               mdoc_tail_alloc(struct mdoc *, int, int, enum mdoct);
 112 int               mdoc_body_alloc(struct mdoc *, int, int, enum mdoct);
 113 int               mdoc_endbody_alloc(struct mdoc *m, int line, int pos,
 114                         enum mdoct tok, struct mdoc_node *body,
 115                         enum mdoc_endbody end);
 116 void              mdoc_node_delete(struct mdoc *, struct mdoc_node *);
 117 void              mdoc_hash_init(void);
 118 enum mdoct        mdoc_hash_find(const char *);
 119 enum mdelim       mdoc_iscdelim(char);
 120 enum mdelim       mdoc_isdelim(const char *);
 121 size_t            mdoc_isescape(const char *);
 122 enum    mdoc_sec  mdoc_str2sec(const char *);
 123 time_t            mdoc_atotime(const char *);
 124 size_t            mdoc_macro2len(enum mdoct);
 125 const char       *mdoc_a2att(const char *);
 126 const char       *mdoc_a2lib(const char *);
 127 const char       *mdoc_a2st(const char *);
 128 const char       *mdoc_a2arch(const char *);
 129 const char       *mdoc_a2vol(const char *);
 130 const char       *mdoc_a2msec(const char *);
 131 int               mdoc_valid_pre(struct mdoc *, struct mdoc_node *);
 132 int               mdoc_valid_post(struct mdoc *);
 133 int               mdoc_action_pre(struct mdoc *,
 134                         struct mdoc_node *);
 135 int               mdoc_action_post(struct mdoc *);
 136 enum margverr     mdoc_argv(struct mdoc *, int, enum mdoct,
 137                         struct mdoc_arg **, int *, char *);
 138 void              mdoc_argv_free(struct mdoc_arg *);
 139 void              mdoc_argn_free(struct mdoc_arg *, int);
 140 enum margserr     mdoc_args(struct mdoc *, int,
 141                         int *, char *, enum mdoct, char **);
 142 enum margserr     mdoc_zargs(struct mdoc *, int,
 143                         int *, char *, int, char **);
 144 #define ARGS_DELIM      (1 << 1)
 145 #define ARGS_TABSEP     (1 << 2)
 146 #define ARGS_NOWARN     (1 << 3)
 147
 148 int               mdoc_macroend(struct mdoc *);
 149
 150 __END_DECLS
 151
 152 #endif /*!LIBMDOC_H*/