Annotation of mandoc/libmdoc.h, Revision 1.54
1.54 ! kristaps 1: /* $Id: libmdoc.h,v 1.53 2010/06/19 20:46:27 kristaps Exp $ */
1.1 kristaps 2: /*
1.53 kristaps 3: * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@bsd.lv>
1.1 kristaps 4: *
5: * Permission to use, copy, modify, and distribute this software for any
1.6 kristaps 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.6 kristaps 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:
1.54 ! kristaps 20: #include "regs.h"
1.1 kristaps 21: #include "mdoc.h"
22:
23: enum mdoc_next {
24: MDOC_NEXT_SIBLING = 0,
25: MDOC_NEXT_CHILD
26: };
27:
28: struct mdoc {
29: void *data;
1.48 kristaps 30: mandocmsg msg;
1.1 kristaps 31: int flags;
1.42 kristaps 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 */
35: #define MDOC_NEWLINE (1 << 3) /* first macro/text in a line */
1.45 kristaps 36: #define MDOC_PHRASELIT (1 << 4) /* literal within a partila phrase */
37: #define MDOC_PPHRASE (1 << 5) /* within a partial phrase */
1.51 kristaps 38: #define MDOC_FREECOL (1 << 6) /* `It' invocation should close */
1.1 kristaps 39: int pflags;
40: enum mdoc_next next;
41: struct mdoc_node *last;
42: struct mdoc_node *first;
43: struct mdoc_meta meta;
44: enum mdoc_sec lastnamed;
45: enum mdoc_sec lastsec;
1.13 kristaps 46: };
1.1 kristaps 47:
1.31 kristaps 48: #define MACRO_PROT_ARGS struct mdoc *m, enum mdoct tok, \
49: int line, int ppos, int *pos, char *buf
1.1 kristaps 50:
51: struct mdoc_macro {
52: int (*fp)(MACRO_PROT_ARGS);
53: int flags;
54: #define MDOC_CALLABLE (1 << 0)
55: #define MDOC_PARSED (1 << 1)
56: #define MDOC_EXPLICIT (1 << 2)
57: #define MDOC_PROLOGUE (1 << 3)
58: #define MDOC_IGNDELIM (1 << 4)
59: /* Reserved words in arguments treated as text. */
60: };
61:
1.36 kristaps 62: enum margserr {
1.35 kristaps 63: ARGS_ERROR,
64: ARGS_EOLN,
65: ARGS_WORD,
66: ARGS_PUNCT,
67: ARGS_QWORD,
1.38 kristaps 68: ARGS_PHRASE,
1.40 kristaps 69: ARGS_PPHRASE,
70: ARGS_PEND
1.35 kristaps 71: };
72:
1.37 kristaps 73: enum margverr {
74: ARGV_ERROR,
75: ARGV_EOLN,
76: ARGV_ARG,
77: ARGV_WORD
78: };
79:
1.46 schwarze 80: enum mdelim {
81: DELIM_NONE = 0,
82: DELIM_OPEN,
83: DELIM_MIDDLE,
84: DELIM_CLOSE
85: };
86:
1.1 kristaps 87: extern const struct mdoc_macro *const mdoc_macros;
88:
89: __BEGIN_DECLS
90:
1.48 kristaps 91: #define mdoc_pmsg(m, l, p, t) \
92: (*(m)->msg)((t), (m)->data, (l), (p), NULL)
93: #define mdoc_nmsg(m, n, t) \
94: (*(m)->msg)((t), (m)->data, (n)->line, (n)->pos, NULL)
95: int mdoc_vmsg(struct mdoc *, enum mandocerr,
96: int, int, const char *, ...);
1.1 kristaps 97: int mdoc_macro(MACRO_PROT_ARGS);
98: int mdoc_word_alloc(struct mdoc *,
99: int, int, const char *);
100: int mdoc_elem_alloc(struct mdoc *, int, int,
1.31 kristaps 101: enum mdoct, struct mdoc_arg *);
1.1 kristaps 102: int mdoc_block_alloc(struct mdoc *, int, int,
1.31 kristaps 103: enum mdoct, struct mdoc_arg *);
104: int mdoc_head_alloc(struct mdoc *, int, int, enum mdoct);
105: int mdoc_tail_alloc(struct mdoc *, int, int, enum mdoct);
106: int mdoc_body_alloc(struct mdoc *, int, int, enum mdoct);
1.33 kristaps 107: void mdoc_node_delete(struct mdoc *, struct mdoc_node *);
1.27 kristaps 108: void mdoc_hash_init(void);
1.31 kristaps 109: enum mdoct mdoc_hash_find(const char *);
1.46 schwarze 110: enum mdelim mdoc_iscdelim(char);
111: enum mdelim mdoc_isdelim(const char *);
1.1 kristaps 112: size_t mdoc_isescape(const char *);
1.41 kristaps 113: enum mdoc_sec mdoc_str2sec(const char *);
1.1 kristaps 114: time_t mdoc_atotime(const char *);
1.39 kristaps 115: size_t mdoc_macro2len(enum mdoct);
1.16 kristaps 116: const char *mdoc_a2att(const char *);
1.18 kristaps 117: const char *mdoc_a2lib(const char *);
1.17 kristaps 118: const char *mdoc_a2st(const char *);
1.1 kristaps 119: const char *mdoc_a2arch(const char *);
120: const char *mdoc_a2vol(const char *);
121: const char *mdoc_a2msec(const char *);
1.52 kristaps 122: int mdoc_valid_pre(struct mdoc *, struct mdoc_node *);
1.1 kristaps 123: int mdoc_valid_post(struct mdoc *);
124: int mdoc_action_pre(struct mdoc *,
1.49 kristaps 125: struct mdoc_node *);
1.1 kristaps 126: int mdoc_action_post(struct mdoc *);
1.37 kristaps 127: enum margverr mdoc_argv(struct mdoc *, int, enum mdoct,
1.1 kristaps 128: struct mdoc_arg **, int *, char *);
129: void mdoc_argv_free(struct mdoc_arg *);
1.32 kristaps 130: void mdoc_argn_free(struct mdoc_arg *, int);
1.36 kristaps 131: enum margserr mdoc_args(struct mdoc *, int,
1.31 kristaps 132: int *, char *, enum mdoct, char **);
1.36 kristaps 133: enum margserr mdoc_zargs(struct mdoc *, int,
1.25 kristaps 134: int *, char *, int, char **);
1.43 kristaps 135: #define ARGS_DELIM (1 << 1)
136: #define ARGS_TABSEP (1 << 2)
137: #define ARGS_NOWARN (1 << 3)
1.35 kristaps 138:
1.2 kristaps 139: int mdoc_macroend(struct mdoc *);
1.1 kristaps 140:
141: __END_DECLS
142:
143: #endif /*!LIBMDOC_H*/
CVSweb
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to libmdoc.h CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [cvsweb.bsd.lv] / mandoc