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