Annotation of src/usr.bin/mandoc/libmdoc.h, Revision 1.18
1.18 ! schwarze 1: /* $Id: libmdoc.h,v 1.17 2009/07/26 22:48:41 schwarze Exp $ */
1.1 kristaps 2: /*
1.3 schwarze 3: * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@kth.se>
1.1 kristaps 4: *
5: * Permission to use, copy, modify, and distribute this software for any
1.3 schwarze 6: * purpose with or without fee is hereby granted, provided that the above
7: * copyright notice and this permission notice appear in all copies.
1.1 kristaps 8: *
1.3 schwarze 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.
1.1 kristaps 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: void *htab;
31: int flags;
1.7 schwarze 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. */
1.1 kristaps 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:
1.10 schwarze 44: enum merr {
45: ETAILWS = 0,
46: EQUOTPARM,
47: EQUOTTERM,
48: EMALLOC,
49: EARGVAL,
50: EBODYPROL,
51: EPROLBODY,
52: ETEXTPROL,
53: ENOBLANK,
54: ETOOLONG,
55: EESCAPE,
56: EPRINT,
57: ENODAT,
58: ENOPROLOGUE,
59: ELINE,
60: EATT,
61: ENAME,
62: ELISTTYPE,
63: EDISPTYPE,
64: EMULTIDISP,
65: EMULTILIST,
66: ESECNAME,
67: ENAMESECINC,
68: EARGREP,
69: EBOOL,
70: ECOLMIS,
71: ENESTDISP,
72: EMISSWIDTH,
73: EWRONGMSEC,
74: ESECOOO,
75: ESECREP,
76: EBADSTAND,
77: ENOMULTILINE,
78: EMULTILINE,
79: ENOLINE,
80: EPROLOOO,
81: EPROLREP,
82: EBADMSEC,
83: EBADSEC,
84: EFONT,
85: EBADDATE,
86: ENUMFMT,
87: ENOWIDTH,
88: EUTSNAME,
89: EOBS,
90: EIMPBRK,
91: EIGNE,
92: EOPEN,
93: EQUOTPHR,
94: ENOCTX,
1.15 schwarze 95: ELIB,
1.10 schwarze 96: MERRMAX
97: };
1.1 kristaps 98:
99: #define MACRO_PROT_ARGS struct mdoc *mdoc, int tok, int line, \
100: int ppos, int *pos, char *buf
101:
102: struct mdoc_macro {
103: int (*fp)(MACRO_PROT_ARGS);
104: int flags;
105: #define MDOC_CALLABLE (1 << 0)
106: #define MDOC_PARSED (1 << 1)
107: #define MDOC_EXPLICIT (1 << 2)
108: #define MDOC_PROLOGUE (1 << 3)
109: #define MDOC_IGNDELIM (1 << 4)
110: /* Reserved words in arguments treated as text. */
111: };
112:
113: extern const struct mdoc_macro *const mdoc_macros;
114:
115: __BEGIN_DECLS
116:
1.12 schwarze 117: #define mdoc_perr(m, l, p, t) \
118: mdoc_err((m), (l), (p), 1, (t))
1.13 schwarze 119: #define mdoc_pwarn(m, l, p, t) \
120: mdoc_err((m), (l), (p), 0, (t))
1.11 schwarze 121: #define mdoc_nerr(m, n, t) \
1.14 schwarze 122: mdoc_err((m), (n)->line, (n)->pos, 1, (t))
123: #define mdoc_nwarn(m, n, t) \
1.11 schwarze 124: mdoc_err((m), (n)->line, (n)->pos, 0, (t))
1.8 schwarze 125:
1.10 schwarze 126: int mdoc_err(struct mdoc *, int, int, int, enum merr);
1.9 schwarze 127: int mdoc_verr(struct mdoc *, int, int, const char *, ...);
1.8 schwarze 128: int mdoc_vwarn(struct mdoc *, int, int, const char *, ...);
129:
1.1 kristaps 130: int mdoc_macro(MACRO_PROT_ARGS);
131: int mdoc_word_alloc(struct mdoc *,
132: int, int, const char *);
133: int mdoc_elem_alloc(struct mdoc *, int, int,
134: int, struct mdoc_arg *);
135: int mdoc_block_alloc(struct mdoc *, int, int,
136: int, struct mdoc_arg *);
137: int mdoc_head_alloc(struct mdoc *, int, int, int);
138: int mdoc_tail_alloc(struct mdoc *, int, int, int);
139: int mdoc_body_alloc(struct mdoc *, int, int, int);
140: void mdoc_node_free(struct mdoc_node *);
141: void mdoc_node_freelist(struct mdoc_node *);
142: void *mdoc_hash_alloc(void);
143: int mdoc_hash_find(const void *, const char *);
144: void mdoc_hash_free(void *);
145: int mdoc_iscdelim(char);
146: int mdoc_isdelim(const char *);
147: size_t mdoc_isescape(const char *);
148: enum mdoc_sec mdoc_atosec(const char *);
149: time_t mdoc_atotime(const char *);
150:
151: size_t mdoc_macro2len(int);
1.15 schwarze 152: const char *mdoc_a2att(const char *);
153: const char *mdoc_a2lib(const char *);
154: const char *mdoc_a2st(const char *);
1.1 kristaps 155: const char *mdoc_a2arch(const char *);
156: const char *mdoc_a2vol(const char *);
157: const char *mdoc_a2msec(const char *);
158: int mdoc_valid_pre(struct mdoc *,
159: const struct mdoc_node *);
160: int mdoc_valid_post(struct mdoc *);
161: int mdoc_action_pre(struct mdoc *,
162: const struct mdoc_node *);
163: int mdoc_action_post(struct mdoc *);
164: int mdoc_argv(struct mdoc *, int, int,
165: struct mdoc_arg **, int *, char *);
166: #define ARGV_ERROR (-1)
167: #define ARGV_EOLN (0)
168: #define ARGV_ARG (1)
169: #define ARGV_WORD (2)
170: void mdoc_argv_free(struct mdoc_arg *);
171: int mdoc_args(struct mdoc *, int,
172: int *, char *, int, char **);
1.17 schwarze 173: int mdoc_zargs(struct mdoc *, int,
174: int *, char *, char **);
1.1 kristaps 175: #define ARGS_ERROR (-1)
176: #define ARGS_EOLN (0)
177: #define ARGS_WORD (1)
178: #define ARGS_PUNCT (2)
179: #define ARGS_QWORD (3)
180: #define ARGS_PHRASE (4)
181:
182: int mdoc_macroend(struct mdoc *);
183:
184: __END_DECLS
185:
186: #endif /*!LIBMDOC_H*/
![[BACK]](/icons/back.gif){kind=icon}
Return to libmdoc.h CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / mandoc