Annotation of mandoc/private.h, Revision 1.70
1.70 ! kristaps 1: /* $Id: private.h,v 1.69 2009/01/19 17:51:33 kristaps Exp $ */
1.1 kristaps 2: /*
3: * Copyright (c) 2008 Kristaps Dzonsons <kristaps@kth.se>
4: *
5: * Permission to use, copy, modify, and distribute this software for any
6: * purpose with or without fee is hereby granted, provided that the
7: * above copyright notice and this permission notice appear in all
8: * copies.
9: *
10: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
11: * WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
12: * WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
13: * AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL
14: * DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR
15: * PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
16: * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
17: * PERFORMANCE OF THIS SOFTWARE.
18: */
19: #ifndef PRIVATE_H
20: #define PRIVATE_H
21:
1.41 kristaps 22: #include "mdoc.h"
1.27 kristaps 23:
1.52 kristaps 24: enum mdoc_next {
25: MDOC_NEXT_SIBLING = 0,
26: MDOC_NEXT_CHILD
27: };
28:
1.41 kristaps 29: struct mdoc {
30: void *data;
31: struct mdoc_cb cb;
32: void *htab;
1.70 ! kristaps 33: int linetok;
1.52 kristaps 34: int flags;
1.57 kristaps 35: #define MDOC_HALT (1 << 0)
1.70 ! kristaps 36: #define MDOC_BODYPARSE (1 << 1)
1.52 kristaps 37: enum mdoc_next next;
1.41 kristaps 38: struct mdoc_node *last;
39: struct mdoc_node *first;
1.43 kristaps 40: struct mdoc_meta meta;
1.42 kristaps 41: enum mdoc_sec sec_lastn;
42: enum mdoc_sec sec_last;
1.36 kristaps 43: };
44:
1.58 kristaps 45:
1.70 ! kristaps 46: /* Hard-limit of macro arguments. */
1.65 kristaps 47:
1.70 ! kristaps 48: #define MDOC_LINEARG_MAX 9
! 49:
! 50: /* Suggested limit of macro arguments. */
! 51:
! 52: #define MDOC_LINEARG_SOFTMAX 9
1.65 kristaps 53:
1.58 kristaps 54: #define MACRO_PROT_ARGS struct mdoc *mdoc, int tok, int line, \
55: int ppos, int *pos, char *buf
56:
1.41 kristaps 57: struct mdoc_macro {
1.64 kristaps 58: int (*fp)(MACRO_PROT_ARGS);
59: int flags;
60: #define MDOC_CALLABLE (1 << 0)
61: #define MDOC_PARSED (1 << 1)
62: #define MDOC_EXPLICIT (1 << 2)
63: #define MDOC_QUOTABLE (1 << 3)
64: #define MDOC_PROLOGUE (1 << 4)
65: #define MDOC_TABSEP (1 << 5)
1.8 kristaps 66: };
1.5 kristaps 67:
1.64 kristaps 68: #define mdoc_nwarn(mdoc, node, type, fmt, ...) \
69: mdoc_vwarn((mdoc), (node)->line, \
70: (node)->pos, (type), (fmt), ##__VA_ARGS__)
71:
72: #define mdoc_nerr(mdoc, node, fmt, ...) \
73: mdoc_verr((mdoc), (node)->line, \
74: (node)->pos, (fmt), ##__VA_ARGS__)
75:
76: #define mdoc_warn(mdoc, type, fmt, ...) \
77: mdoc_vwarn((mdoc), (mdoc)->last->line, \
78: (mdoc)->last->pos, (type), (fmt), ##__VA_ARGS__)
79:
80: #define mdoc_err(mdoc, fmt, ...) \
81: mdoc_verr((mdoc), (mdoc)->last->line, \
82: (mdoc)->last->pos, (fmt), ##__VA_ARGS__)
83:
84: #define mdoc_msg(mdoc, fmt, ...) \
85: mdoc_vmsg((mdoc), (mdoc)->last->line, \
86: (mdoc)->last->pos, (fmt), ##__VA_ARGS__)
87:
88: #define mdoc_pmsg(mdoc, line, pos, fmt, ...) \
89: mdoc_vmsg((mdoc), (line), \
90: (pos), (fmt), ##__VA_ARGS__)
91:
92: #define mdoc_pwarn(mdoc, line, pos, type, fmt, ...) \
93: mdoc_vwarn((mdoc), (line), \
94: (pos), (type), (fmt), ##__VA_ARGS__)
95:
96: #define mdoc_perr(mdoc, line, pos, fmt, ...) \
97: mdoc_verr((mdoc), (line), \
98: (pos), (fmt), ##__VA_ARGS__)
99:
1.41 kristaps 100: extern const struct mdoc_macro *const mdoc_macros;
1.24 kristaps 101:
1.1 kristaps 102: __BEGIN_DECLS
103:
1.64 kristaps 104: int mdoc_vwarn(struct mdoc *, int, int,
105: enum mdoc_warn, const char *, ...);
106: void mdoc_vmsg(struct mdoc *, int, int,
107: const char *, ...);
108: int mdoc_verr(struct mdoc *, int, int,
109: const char *, ...);
110:
1.58 kristaps 111: int mdoc_macro(MACRO_PROT_ARGS);
1.41 kristaps 112: int mdoc_find(const struct mdoc *, const char *);
1.60 kristaps 113: int mdoc_word_alloc(struct mdoc *,
1.59 kristaps 114: int, int, const char *);
1.60 kristaps 115: int mdoc_elem_alloc(struct mdoc *, int, int,
1.59 kristaps 116: int, size_t, const struct mdoc_arg *);
1.60 kristaps 117: int mdoc_block_alloc(struct mdoc *, int, int,
1.59 kristaps 118: int, size_t, const struct mdoc_arg *);
1.61 kristaps 119: int mdoc_root_alloc(struct mdoc *);
1.60 kristaps 120: int mdoc_head_alloc(struct mdoc *, int, int, int);
121: int mdoc_tail_alloc(struct mdoc *, int, int, int);
122: int mdoc_body_alloc(struct mdoc *, int, int, int);
1.41 kristaps 123: void mdoc_node_free(struct mdoc_node *);
1.69 kristaps 124: void mdoc_node_freelist(struct mdoc_node *);
1.41 kristaps 125: void mdoc_sibling(struct mdoc *, int, struct mdoc_node **,
126: struct mdoc_node **, struct mdoc_node *);
1.44 kristaps 127: void *mdoc_tokhash_alloc(void);
128: int mdoc_tokhash_find(const void *, const char *);
129: void mdoc_tokhash_free(void *);
1.42 kristaps 130: int mdoc_isdelim(const char *);
1.45 kristaps 131: int mdoc_iscdelim(char);
1.67 kristaps 132: enum mdoc_sec mdoc_atosec(const char *);
1.43 kristaps 133: enum mdoc_msec mdoc_atomsec(const char *);
134: enum mdoc_vol mdoc_atovol(const char *);
135: enum mdoc_arch mdoc_atoarch(const char *);
1.48 kristaps 136: enum mdoc_att mdoc_atoatt(const char *);
1.43 kristaps 137: time_t mdoc_atotime(const char *);
138:
1.66 kristaps 139: char *mdoc_type2a(enum mdoc_type);
1.68 kristaps 140: char *mdoc_node2a(struct mdoc_node *);
1.66 kristaps 141:
1.60 kristaps 142: int mdoc_valid_pre(struct mdoc *, struct mdoc_node *);
143: int mdoc_valid_post(struct mdoc *);
144: int mdoc_action_pre(struct mdoc *, struct mdoc_node *);
145: int mdoc_action_post(struct mdoc *);
1.50 kristaps 146:
1.60 kristaps 147: int mdoc_argv(struct mdoc *, int, int,
1.45 kristaps 148: struct mdoc_arg *, int *, char *);
1.52 kristaps 149: #define ARGV_ERROR (-1)
150: #define ARGV_EOLN (0)
151: #define ARGV_ARG (1)
152: #define ARGV_WORD (2)
1.44 kristaps 153: void mdoc_argv_free(int, struct mdoc_arg *);
1.45 kristaps 154: int mdoc_args(struct mdoc *, int,
155: int *, char *, int, char **);
156: #define ARGS_ERROR (-1)
157: #define ARGS_EOLN (0)
158: #define ARGS_WORD (1)
159: #define ARGS_PUNCT (2)
160:
161: #define ARGS_QUOTED (1 << 0)
162: #define ARGS_DELIM (1 << 1)
1.62 kristaps 163: #define ARGS_TABSEP (1 << 2)
1.44 kristaps 164:
1.67 kristaps 165: int xstrlcats(char *, const struct mdoc_node *, size_t);
1.44 kristaps 166: int xstrlcat(char *, const char *, size_t);
167: int xstrlcpy(char *, const char *, size_t);
168: int xstrcmp(const char *, const char *);
169: void *xcalloc(size_t, size_t);
170: char *xstrdup(const char *);
171:
1.51 kristaps 172: int macro_obsolete(MACRO_PROT_ARGS);
1.48 kristaps 173: int macro_constant(MACRO_PROT_ARGS);
1.55 kristaps 174: int macro_constant_scoped(MACRO_PROT_ARGS);
1.47 kristaps 175: int macro_constant_delimited(MACRO_PROT_ARGS);
1.43 kristaps 176: int macro_text(MACRO_PROT_ARGS);
1.52 kristaps 177: int macro_scoped(MACRO_PROT_ARGS);
1.63 kristaps 178: int macro_scoped_close(MACRO_PROT_ARGS);
1.46 kristaps 179: int macro_scoped_line(MACRO_PROT_ARGS);
1.52 kristaps 180: int macro_prologue(MACRO_PROT_ARGS);
1.57 kristaps 181: int macro_end(struct mdoc *);
1.35 kristaps 182:
1.1 kristaps 183: __END_DECLS
184:
185: #endif /*!PRIVATE_H*/
CVSweb
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to private.h CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [cvsweb.bsd.lv] / mandoc