Annotation of mandoc/private.h, Revision 1.87
1.87 ! kristaps 1: /* $Id: private.h,v 1.86 2009/03/08 11:41:22 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.86 kristaps 36: int pflags;
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.74 kristaps 41: enum mdoc_sec lastnamed;
1.78 kristaps 42: enum mdoc_sec lastsec;
1.36 kristaps 43: };
44:
1.58 kristaps 45:
46: #define MACRO_PROT_ARGS struct mdoc *mdoc, int tok, int line, \
47: int ppos, int *pos, char *buf
48:
1.41 kristaps 49: struct mdoc_macro {
1.64 kristaps 50: int (*fp)(MACRO_PROT_ARGS);
51: int flags;
52: #define MDOC_CALLABLE (1 << 0)
53: #define MDOC_PARSED (1 << 1)
54: #define MDOC_EXPLICIT (1 << 2)
1.72 kristaps 55: #define MDOC_PROLOGUE (1 << 3)
1.8 kristaps 56: };
1.5 kristaps 57:
1.64 kristaps 58: #define mdoc_nwarn(mdoc, node, type, fmt, ...) \
59: mdoc_vwarn((mdoc), (node)->line, \
60: (node)->pos, (type), (fmt), ##__VA_ARGS__)
61:
62: #define mdoc_nerr(mdoc, node, fmt, ...) \
63: mdoc_verr((mdoc), (node)->line, \
64: (node)->pos, (fmt), ##__VA_ARGS__)
65:
66: #define mdoc_warn(mdoc, type, fmt, ...) \
67: mdoc_vwarn((mdoc), (mdoc)->last->line, \
68: (mdoc)->last->pos, (type), (fmt), ##__VA_ARGS__)
69:
70: #define mdoc_err(mdoc, fmt, ...) \
71: mdoc_verr((mdoc), (mdoc)->last->line, \
72: (mdoc)->last->pos, (fmt), ##__VA_ARGS__)
73:
74: #define mdoc_msg(mdoc, fmt, ...) \
75: mdoc_vmsg((mdoc), (mdoc)->last->line, \
76: (mdoc)->last->pos, (fmt), ##__VA_ARGS__)
77:
78: #define mdoc_pmsg(mdoc, line, pos, fmt, ...) \
79: mdoc_vmsg((mdoc), (line), \
80: (pos), (fmt), ##__VA_ARGS__)
81:
82: #define mdoc_pwarn(mdoc, line, pos, type, fmt, ...) \
83: mdoc_vwarn((mdoc), (line), \
84: (pos), (type), (fmt), ##__VA_ARGS__)
85:
86: #define mdoc_perr(mdoc, line, pos, fmt, ...) \
87: mdoc_verr((mdoc), (line), \
88: (pos), (fmt), ##__VA_ARGS__)
89:
1.41 kristaps 90: extern const struct mdoc_macro *const mdoc_macros;
1.24 kristaps 91:
1.1 kristaps 92: __BEGIN_DECLS
93:
1.64 kristaps 94: int mdoc_vwarn(struct mdoc *, int, int,
95: enum mdoc_warn, const char *, ...);
96: void mdoc_vmsg(struct mdoc *, int, int,
97: const char *, ...);
98: int mdoc_verr(struct mdoc *, int, int,
99: const char *, ...);
100:
1.58 kristaps 101: int mdoc_macro(MACRO_PROT_ARGS);
1.60 kristaps 102: int mdoc_word_alloc(struct mdoc *,
1.59 kristaps 103: int, int, const char *);
1.60 kristaps 104: int mdoc_elem_alloc(struct mdoc *, int, int,
1.86 kristaps 105: int, struct mdoc_arg *);
1.60 kristaps 106: int mdoc_block_alloc(struct mdoc *, int, int,
1.86 kristaps 107: int, struct mdoc_arg *);
1.61 kristaps 108: int mdoc_root_alloc(struct mdoc *);
1.60 kristaps 109: int mdoc_head_alloc(struct mdoc *, int, int, int);
110: int mdoc_tail_alloc(struct mdoc *, int, int, int);
111: int mdoc_body_alloc(struct mdoc *, int, int, int);
1.41 kristaps 112: void mdoc_node_free(struct mdoc_node *);
1.69 kristaps 113: void mdoc_node_freelist(struct mdoc_node *);
1.41 kristaps 114: void mdoc_sibling(struct mdoc *, int, struct mdoc_node **,
115: struct mdoc_node **, struct mdoc_node *);
1.44 kristaps 116: void *mdoc_tokhash_alloc(void);
117: int mdoc_tokhash_find(const void *, const char *);
118: void mdoc_tokhash_free(void *);
1.45 kristaps 119: int mdoc_iscdelim(char);
1.80 kristaps 120: size_t mdoc_isescape(const char *);
1.67 kristaps 121: enum mdoc_sec mdoc_atosec(const char *);
1.87 ! kristaps 122:
1.43 kristaps 123: time_t mdoc_atotime(const char *);
1.83 kristaps 124: size_t mdoc_macro2len(int);
1.43 kristaps 125:
1.85 kristaps 126: const char *mdoc_a2arch(const char *);
127: const char *mdoc_a2vol(const char *);
128: const char *mdoc_a2msec(const char *);
1.66 kristaps 129:
1.81 kristaps 130: int mdoc_valid_pre(struct mdoc *,
131: const struct mdoc_node *);
1.60 kristaps 132: int mdoc_valid_post(struct mdoc *);
133: int mdoc_action_pre(struct mdoc *, struct mdoc_node *);
134: int mdoc_action_post(struct mdoc *);
1.50 kristaps 135:
1.86 kristaps 136: int mdoc_argv(struct mdoc *, int, int,
137: struct mdoc_arg **, int *, char *);
1.52 kristaps 138: #define ARGV_ERROR (-1)
139: #define ARGV_EOLN (0)
140: #define ARGV_ARG (1)
141: #define ARGV_WORD (2)
1.86 kristaps 142: void mdoc_argv_free(struct mdoc_arg *);
1.45 kristaps 143: int mdoc_args(struct mdoc *, int,
144: int *, char *, int, char **);
145: #define ARGS_ERROR (-1)
146: #define ARGS_EOLN (0)
147: #define ARGS_WORD (1)
148: #define ARGS_PUNCT (2)
1.71 kristaps 149: #define ARGS_QWORD (3)
1.75 kristaps 150: #define ARGS_PHRASE (4)
1.45 kristaps 151:
1.85 kristaps 152: int xstrlcpys(char *, const struct mdoc_node *, size_t);
1.44 kristaps 153: int xstrlcat(char *, const char *, size_t);
154: int xstrlcpy(char *, const char *, size_t);
155: int xstrcmp(const char *, const char *);
1.73 kristaps 156: int xstrncmp(const char *, const char *, size_t);
1.44 kristaps 157: void *xcalloc(size_t, size_t);
1.84 kristaps 158: void *xrealloc(void *, size_t);
1.44 kristaps 159: char *xstrdup(const char *);
160:
1.57 kristaps 161: int macro_end(struct mdoc *);
1.35 kristaps 162:
1.1 kristaps 163: __END_DECLS
164:
165: #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