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