e1a9aecc8ee6c6ba1c77194395ff189451392003
[dragonfly.git] / contrib / mdocml / libman.h
1 /*      $Id: libman.h,v 1.44 2010/11/30 15:36:28 kristaps Exp $ */
2 /*
3  * Copyright (c) 2009, 2010 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 LIBMAN_H
18 #define LIBMAN_H
19
20 #include "man.h"
21
22 enum    man_next {
23         MAN_NEXT_SIBLING = 0,
24         MAN_NEXT_CHILD
25 };
26
27 struct  man {
28         void            *data; /* private application data */
29         mandocmsg        msg; /* output message handler */
30         int              flags; /* parse flags */
31 #define MAN_HALT        (1 << 0) /* badness happened: die */
32 #define MAN_ELINE       (1 << 1) /* Next-line element scope. */
33 #define MAN_BLINE       (1 << 2) /* Next-line block scope. */
34 #define MAN_ILINE       (1 << 3) /* Ignored in next-line scope. */
35 #define MAN_LITERAL     (1 << 4) /* Literal input. */
36 #define MAN_BPLINE      (1 << 5)
37         enum man_next    next; /* where to put the next node */
38         struct man_node *last; /* the last parsed node */
39         struct man_node *first; /* the first parsed node */
40         struct man_meta  meta; /* document meta-data */
41         struct regset   *regs; /* registers */
42 };
43
44 #define MACRO_PROT_ARGS   struct man *m, \
45                           enum mant tok, \
46                           int line, \
47                           int ppos, \
48                           int *pos, \
49                           char *buf
50
51 struct  man_macro {
52         int             (*fp)(MACRO_PROT_ARGS);
53         int               flags;
54 #define MAN_SCOPED       (1 << 0)
55 #define MAN_EXPLICIT     (1 << 1)       /* See blk_imp(). */
56 #define MAN_FSCOPED      (1 << 2)       /* See blk_imp(). */
57 #define MAN_NSCOPED      (1 << 3)       /* See in_line_eoln(). */
58 #define MAN_NOCLOSE      (1 << 4)       /* See blk_exp(). */
59 };
60
61 extern  const struct man_macro *const man_macros;
62
63 __BEGIN_DECLS
64
65 #define           man_pmsg(m, l, p, t) \
66                   (*(m)->msg)((t), (m)->data, (l), (p), NULL)
67 #define           man_nmsg(m, n, t) \
68                   (*(m)->msg)((t), (m)->data, (n)->line, (n)->pos, NULL)
69 int               man_word_alloc(struct man *, int, int, const char *);
70 int               man_block_alloc(struct man *, int, int, enum mant);
71 int               man_head_alloc(struct man *, int, int, enum mant);
72 int               man_body_alloc(struct man *, int, int, enum mant);
73 int               man_elem_alloc(struct man *, int, int, enum mant);
74 void              man_node_delete(struct man *, struct man_node *);
75 void              man_hash_init(void);
76 enum    mant      man_hash_find(const char *);
77 int               man_macroend(struct man *);
78 int               man_args(struct man *, int, int *, char *, char **);
79 #define ARGS_ERROR      (-1)
80 #define ARGS_EOLN       (0)
81 #define ARGS_WORD       (1)
82 #define ARGS_QWORD      (1)
83 int               man_vmsg(struct man *, enum mandocerr,
84                         int, int, const char *, ...);
85 int               man_valid_post(struct man *);
86 int               man_valid_pre(struct man *, struct man_node *);
87 int               man_unscope(struct man *, 
88                         const struct man_node *, enum mandocerr);
89
90 __END_DECLS
91
92 #endif /*!LIBMAN_H*/