Annotation of src/usr.bin/mandoc/libmdoc.h, Revision 1.32
1.32 ! schwarze 1: /* $Id: libmdoc.h,v 1.31 2010/05/15 12:30:59 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: int flags;
1.30 schwarze 31: #define MDOC_HALT (1 << 0) /* error in parse: halt */
32: #define MDOC_LITERAL (1 << 1) /* in a literal scope */
33: #define MDOC_PBODY (1 << 2) /* in the document body */
34: #define MDOC_NEWLINE (1 << 3) /* first macro/text in a line */
1.32 ! schwarze 35: #define MDOC_PHRASELIT (1 << 4) /* literal within a partila phrase */
! 36: #define MDOC_PPHRASE (1 << 5) /* within a partial phrase */
1.1 kristaps 37: int pflags;
38: enum mdoc_next next;
39: struct mdoc_node *last;
40: struct mdoc_node *first;
41: struct mdoc_meta meta;
42: enum mdoc_sec lastnamed;
43: enum mdoc_sec lastsec;
44: };
45:
1.10 schwarze 46: enum merr {
47: ETAILWS = 0,
48: EQUOTPARM,
49: EQUOTTERM,
50: EARGVAL,
51: EBODYPROL,
52: EPROLBODY,
53: ETEXTPROL,
54: ENOBLANK,
55: ETOOLONG,
56: EESCAPE,
57: EPRINT,
58: ENODAT,
59: ENOPROLOGUE,
60: ELINE,
61: EATT,
62: ENAME,
63: ELISTTYPE,
64: EDISPTYPE,
65: EMULTIDISP,
66: EMULTILIST,
67: ESECNAME,
68: ENAMESECINC,
69: EARGREP,
70: EBOOL,
71: ECOLMIS,
72: ENESTDISP,
73: EMISSWIDTH,
74: EWRONGMSEC,
75: ESECOOO,
76: ESECREP,
77: EBADSTAND,
78: ENOMULTILINE,
79: EMULTILINE,
80: ENOLINE,
81: EPROLOOO,
82: EPROLREP,
83: EBADMSEC,
84: EBADSEC,
85: EFONT,
86: EBADDATE,
87: ENUMFMT,
88: ENOWIDTH,
89: EUTSNAME,
90: EOBS,
91: EIMPBRK,
92: EIGNE,
93: EOPEN,
94: EQUOTPHR,
95: ENOCTX,
1.15 schwarze 96: ELIB,
1.22 schwarze 97: EBADCHILD,
1.23 schwarze 98: ENOTYPE,
1.28 schwarze 99: EBADCOMMENT,
1.10 schwarze 100: MERRMAX
101: };
1.1 kristaps 102:
1.25 schwarze 103: #define MACRO_PROT_ARGS struct mdoc *m, enum mdoct tok, \
104: int line, int ppos, int *pos, char *buf
1.1 kristaps 105:
106: struct mdoc_macro {
107: int (*fp)(MACRO_PROT_ARGS);
108: int flags;
109: #define MDOC_CALLABLE (1 << 0)
110: #define MDOC_PARSED (1 << 1)
111: #define MDOC_EXPLICIT (1 << 2)
112: #define MDOC_PROLOGUE (1 << 3)
113: #define MDOC_IGNDELIM (1 << 4)
114: /* Reserved words in arguments treated as text. */
115: };
116:
1.29 schwarze 117: enum margserr {
118: ARGS_ERROR,
119: ARGS_EOLN,
120: ARGS_WORD,
121: ARGS_PUNCT,
122: ARGS_QWORD,
123: ARGS_PHRASE,
1.30 schwarze 124: ARGS_PPHRASE,
125: ARGS_PEND
1.29 schwarze 126: };
127:
128: enum margverr {
129: ARGV_ERROR,
130: ARGV_EOLN,
131: ARGV_ARG,
132: ARGV_WORD
133: };
134:
1.31 schwarze 135: enum mdelim {
136: DELIM_NONE = 0,
137: DELIM_OPEN,
138: DELIM_MIDDLE,
139: DELIM_CLOSE
140: };
141:
1.1 kristaps 142: extern const struct mdoc_macro *const mdoc_macros;
143:
144: __BEGIN_DECLS
145:
1.12 schwarze 146: #define mdoc_perr(m, l, p, t) \
147: mdoc_err((m), (l), (p), 1, (t))
1.13 schwarze 148: #define mdoc_pwarn(m, l, p, t) \
149: mdoc_err((m), (l), (p), 0, (t))
1.11 schwarze 150: #define mdoc_nerr(m, n, t) \
1.14 schwarze 151: mdoc_err((m), (n)->line, (n)->pos, 1, (t))
152: #define mdoc_nwarn(m, n, t) \
1.11 schwarze 153: mdoc_err((m), (n)->line, (n)->pos, 0, (t))
1.8 schwarze 154:
1.10 schwarze 155: int mdoc_err(struct mdoc *, int, int, int, enum merr);
1.9 schwarze 156: int mdoc_verr(struct mdoc *, int, int, const char *, ...);
1.8 schwarze 157: int mdoc_vwarn(struct mdoc *, int, int, const char *, ...);
158:
1.1 kristaps 159: int mdoc_macro(MACRO_PROT_ARGS);
160: int mdoc_word_alloc(struct mdoc *,
161: int, int, const char *);
162: int mdoc_elem_alloc(struct mdoc *, int, int,
1.25 schwarze 163: enum mdoct, struct mdoc_arg *);
1.1 kristaps 164: int mdoc_block_alloc(struct mdoc *, int, int,
1.25 schwarze 165: enum mdoct, struct mdoc_arg *);
166: int mdoc_head_alloc(struct mdoc *, int, int, enum mdoct);
167: int mdoc_tail_alloc(struct mdoc *, int, int, enum mdoct);
168: int mdoc_body_alloc(struct mdoc *, int, int, enum mdoct);
1.27 schwarze 169: void mdoc_node_delete(struct mdoc *, struct mdoc_node *);
1.21 schwarze 170: void mdoc_hash_init(void);
1.25 schwarze 171: enum mdoct mdoc_hash_find(const char *);
1.31 schwarze 172: enum mdelim mdoc_iscdelim(char);
173: enum mdelim mdoc_isdelim(const char *);
1.1 kristaps 174: size_t mdoc_isescape(const char *);
1.30 schwarze 175: enum mdoc_sec mdoc_str2sec(const char *);
1.1 kristaps 176: time_t mdoc_atotime(const char *);
1.29 schwarze 177: size_t mdoc_macro2len(enum mdoct);
1.15 schwarze 178: const char *mdoc_a2att(const char *);
179: const char *mdoc_a2lib(const char *);
180: const char *mdoc_a2st(const char *);
1.1 kristaps 181: const char *mdoc_a2arch(const char *);
182: const char *mdoc_a2vol(const char *);
183: const char *mdoc_a2msec(const char *);
184: int mdoc_valid_pre(struct mdoc *,
185: const struct mdoc_node *);
186: int mdoc_valid_post(struct mdoc *);
187: int mdoc_action_pre(struct mdoc *,
188: const struct mdoc_node *);
189: int mdoc_action_post(struct mdoc *);
1.29 schwarze 190: enum margverr mdoc_argv(struct mdoc *, int, enum mdoct,
1.1 kristaps 191: struct mdoc_arg **, int *, char *);
192: void mdoc_argv_free(struct mdoc_arg *);
1.26 schwarze 193: void mdoc_argn_free(struct mdoc_arg *, int);
1.29 schwarze 194: enum margserr mdoc_args(struct mdoc *, int,
1.25 schwarze 195: int *, char *, enum mdoct, char **);
1.29 schwarze 196: enum margserr mdoc_zargs(struct mdoc *, int,
1.20 schwarze 197: int *, char *, int, char **);
1.32 ! schwarze 198: #define ARGS_DELIM (1 << 1)
! 199: #define ARGS_TABSEP (1 << 2)
! 200: #define ARGS_NOWARN (1 << 3)
1.29 schwarze 201:
1.1 kristaps 202: int mdoc_macroend(struct mdoc *);
203:
204: __END_DECLS
205:
206: #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