]> git.cameronkatri.com Git - mandoc.git/blob - libmdoc.h
Provide a helper function macro_or_word() and use it to prune the
[mandoc.git] / libmdoc.h
1 /* $Id: libmdoc.h,v 1.95 2014/11/29 03:37:44 schwarze Exp $ */
2 /*
3 * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
4 * Copyright (c) 2013, 2014 Ingo Schwarze <schwarze@openbsd.org>
5 *
6 * Permission to use, copy, modify, and distribute this software for any
7 * purpose with or without fee is hereby granted, provided that the above
8 * copyright notice and this permission notice appear in all copies.
9 *
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17 */
18 #ifndef LIBMDOC_H
19 #define LIBMDOC_H
20
21 enum mdoc_next {
22 MDOC_NEXT_SIBLING = 0,
23 MDOC_NEXT_CHILD
24 };
25
26 struct mdoc {
27 struct mparse *parse; /* parse pointer */
28 const char *defos; /* default argument for .Os */
29 int quick; /* abort parse early */
30 int flags; /* parse flags */
31 #define MDOC_LITERAL (1 << 1) /* in a literal scope */
32 #define MDOC_PBODY (1 << 2) /* in the document body */
33 #define MDOC_NEWLINE (1 << 3) /* first macro/text in a line */
34 #define MDOC_PHRASELIT (1 << 4) /* literal within a partila phrase */
35 #define MDOC_PPHRASE (1 << 5) /* within a partial phrase */
36 #define MDOC_FREECOL (1 << 6) /* `It' invocation should close */
37 #define MDOC_SYNOPSIS (1 << 7) /* SYNOPSIS-style formatting */
38 #define MDOC_KEEP (1 << 8) /* in a word keep */
39 #define MDOC_SMOFF (1 << 9) /* spacing is off */
40 #define MDOC_NODELIMC (1 << 10) /* disable closing delimiter handling */
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_node *last_es; /* the most recent Es node */
45 struct mdoc_meta meta; /* document meta-data */
46 enum mdoc_sec lastnamed;
47 enum mdoc_sec lastsec;
48 struct roff *roff;
49 };
50
51 #define MACRO_PROT_ARGS struct mdoc *mdoc, \
52 enum mdoct tok, \
53 int line, \
54 int ppos, \
55 int *pos, \
56 char *buf
57
58 struct mdoc_macro {
59 void (*fp)(MACRO_PROT_ARGS);
60 int flags;
61 #define MDOC_CALLABLE (1 << 0)
62 #define MDOC_PARSED (1 << 1)
63 #define MDOC_EXPLICIT (1 << 2)
64 #define MDOC_PROLOGUE (1 << 3)
65 #define MDOC_IGNDELIM (1 << 4)
66 #define MDOC_JOIN (1 << 5)
67 };
68
69 enum margserr {
70 ARGS_ERROR,
71 ARGS_EOLN, /* end-of-line */
72 ARGS_WORD, /* normal word */
73 ARGS_PUNCT, /* series of punctuation */
74 ARGS_QWORD, /* quoted word */
75 ARGS_PHRASE, /* Ta'd phrase (-column) */
76 ARGS_PPHRASE, /* tabbed phrase (-column) */
77 ARGS_PEND /* last phrase (-column) */
78 };
79
80 /*
81 * A punctuation delimiter is opening, closing, or "middle mark"
82 * punctuation. These govern spacing.
83 * Opening punctuation (e.g., the opening parenthesis) suppresses the
84 * following space; closing punctuation (e.g., the closing parenthesis)
85 * suppresses the leading space; middle punctuation (e.g., the vertical
86 * bar) can do either. The middle punctuation delimiter bends the rules
87 * depending on usage.
88 */
89 enum mdelim {
90 DELIM_NONE = 0,
91 DELIM_OPEN,
92 DELIM_MIDDLE,
93 DELIM_CLOSE,
94 DELIM_MAX
95 };
96
97 extern const struct mdoc_macro *const mdoc_macros;
98
99 __BEGIN_DECLS
100
101 void mdoc_macro(MACRO_PROT_ARGS);
102 void mdoc_word_alloc(struct mdoc *, int, int, const char *);
103 void mdoc_word_append(struct mdoc *, const char *);
104 void mdoc_elem_alloc(struct mdoc *, int, int,
105 enum mdoct, struct mdoc_arg *);
106 struct mdoc_node *mdoc_block_alloc(struct mdoc *, int, int,
107 enum mdoct, struct mdoc_arg *);
108 struct mdoc_node *mdoc_head_alloc(struct mdoc *, int, int, enum mdoct);
109 void mdoc_tail_alloc(struct mdoc *, int, int, enum mdoct);
110 struct mdoc_node *mdoc_body_alloc(struct mdoc *, int, int, enum mdoct);
111 void mdoc_endbody_alloc(struct mdoc *, int, int, enum mdoct,
112 struct mdoc_node *, enum mdoc_endbody);
113 void mdoc_node_delete(struct mdoc *, struct mdoc_node *);
114 void mdoc_node_relink(struct mdoc *, struct mdoc_node *);
115 void mdoc_hash_init(void);
116 enum mdoct mdoc_hash_find(const char *);
117 const char *mdoc_a2att(const char *);
118 const char *mdoc_a2lib(const char *);
119 const char *mdoc_a2st(const char *);
120 const char *mdoc_a2arch(const char *);
121 void mdoc_valid_pre(struct mdoc *, struct mdoc_node *);
122 void mdoc_valid_post(struct mdoc *);
123 void mdoc_argv(struct mdoc *, int, enum mdoct,
124 struct mdoc_arg **, int *, char *);
125 void mdoc_argv_free(struct mdoc_arg *);
126 enum margserr mdoc_args(struct mdoc *, int,
127 int *, char *, enum mdoct, char **);
128 void mdoc_macroend(struct mdoc *);
129 enum mdelim mdoc_isdelim(const char *);
130
131 __END_DECLS
132
133 #endif /*!LIBMDOC_H*/