Annotation of src/usr.bin/mandoc/libmdoc.h, Revision 1.37
1.37 ! schwarze 1: /* $Id: libmdoc.h,v 1.36 2010/05/24 00:00:10 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;
1.35 schwarze 29: mandocmsg msg;
1.1 kristaps 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.37 ! schwarze 37: #define MDOC_FREECOL (1 << 6) /* `It' invocation should close */
1.1 kristaps 38: int pflags;
39: enum mdoc_next next;
40: struct mdoc_node *last;
41: struct mdoc_node *first;
42: struct mdoc_meta meta;
43: enum mdoc_sec lastnamed;
44: enum mdoc_sec lastsec;
45: };
46:
1.25 schwarze 47: #define MACRO_PROT_ARGS struct mdoc *m, enum mdoct tok, \
48: int line, int ppos, int *pos, char *buf
1.1 kristaps 49:
50: struct mdoc_macro {
51: int (*fp)(MACRO_PROT_ARGS);
52: int flags;
53: #define MDOC_CALLABLE (1 << 0)
54: #define MDOC_PARSED (1 << 1)
55: #define MDOC_EXPLICIT (1 << 2)
56: #define MDOC_PROLOGUE (1 << 3)
57: #define MDOC_IGNDELIM (1 << 4)
58: /* Reserved words in arguments treated as text. */
59: };
60:
1.29 schwarze 61: enum margserr {
62: ARGS_ERROR,
63: ARGS_EOLN,
64: ARGS_WORD,
65: ARGS_PUNCT,
66: ARGS_QWORD,
67: ARGS_PHRASE,
1.30 schwarze 68: ARGS_PPHRASE,
69: ARGS_PEND
1.29 schwarze 70: };
71:
72: enum margverr {
73: ARGV_ERROR,
74: ARGV_EOLN,
75: ARGV_ARG,
76: ARGV_WORD
77: };
78:
1.31 schwarze 79: enum mdelim {
80: DELIM_NONE = 0,
81: DELIM_OPEN,
82: DELIM_MIDDLE,
83: DELIM_CLOSE
84: };
85:
1.1 kristaps 86: extern const struct mdoc_macro *const mdoc_macros;
87:
88: __BEGIN_DECLS
89:
1.35 schwarze 90: #define mdoc_pmsg(m, l, p, t) \
91: (*(m)->msg)((t), (m)->data, (l), (p), NULL)
92: #define mdoc_nmsg(m, n, t) \
93: (*(m)->msg)((t), (m)->data, (n)->line, (n)->pos, NULL)
94: int mdoc_vmsg(struct mdoc *, enum mandocerr,
95: int, int, const char *, ...);
1.1 kristaps 96: int mdoc_macro(MACRO_PROT_ARGS);
97: int mdoc_word_alloc(struct mdoc *,
98: int, int, const char *);
99: int mdoc_elem_alloc(struct mdoc *, int, int,
1.25 schwarze 100: enum mdoct, struct mdoc_arg *);
1.1 kristaps 101: int mdoc_block_alloc(struct mdoc *, int, int,
1.25 schwarze 102: enum mdoct, struct mdoc_arg *);
103: int mdoc_head_alloc(struct mdoc *, int, int, enum mdoct);
104: int mdoc_tail_alloc(struct mdoc *, int, int, enum mdoct);
105: int mdoc_body_alloc(struct mdoc *, int, int, enum mdoct);
1.27 schwarze 106: void mdoc_node_delete(struct mdoc *, struct mdoc_node *);
1.21 schwarze 107: void mdoc_hash_init(void);
1.25 schwarze 108: enum mdoct mdoc_hash_find(const char *);
1.31 schwarze 109: enum mdelim mdoc_iscdelim(char);
110: enum mdelim mdoc_isdelim(const char *);
1.1 kristaps 111: size_t mdoc_isescape(const char *);
1.30 schwarze 112: enum mdoc_sec mdoc_str2sec(const char *);
1.1 kristaps 113: time_t mdoc_atotime(const char *);
1.29 schwarze 114: size_t mdoc_macro2len(enum mdoct);
1.15 schwarze 115: const char *mdoc_a2att(const char *);
116: const char *mdoc_a2lib(const char *);
117: const char *mdoc_a2st(const char *);
1.1 kristaps 118: const char *mdoc_a2arch(const char *);
119: const char *mdoc_a2vol(const char *);
120: const char *mdoc_a2msec(const char *);
1.37 ! schwarze 121: int mdoc_valid_pre(struct mdoc *, struct mdoc_node *);
1.1 kristaps 122: int mdoc_valid_post(struct mdoc *);
123: int mdoc_action_pre(struct mdoc *,
1.36 schwarze 124: struct mdoc_node *);
1.1 kristaps 125: int mdoc_action_post(struct mdoc *);
1.29 schwarze 126: enum margverr mdoc_argv(struct mdoc *, int, enum mdoct,
1.1 kristaps 127: struct mdoc_arg **, int *, char *);
128: void mdoc_argv_free(struct mdoc_arg *);
1.26 schwarze 129: void mdoc_argn_free(struct mdoc_arg *, int);
1.29 schwarze 130: enum margserr mdoc_args(struct mdoc *, int,
1.25 schwarze 131: int *, char *, enum mdoct, char **);
1.29 schwarze 132: enum margserr mdoc_zargs(struct mdoc *, int,
1.20 schwarze 133: int *, char *, int, char **);
1.32 schwarze 134: #define ARGS_DELIM (1 << 1)
135: #define ARGS_TABSEP (1 << 2)
136: #define ARGS_NOWARN (1 << 3)
1.29 schwarze 137:
1.1 kristaps 138: int mdoc_macroend(struct mdoc *);
139:
140: __END_DECLS
141:
142: #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