Annotation of mandoc/private.h, Revision 1.63
1.63 ! kristaps 1: /* $Id: private.h,v 1.62 2009/01/12 16:39:57 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.52 kristaps 33: int flags;
1.57 kristaps 34: #define MDOC_HALT (1 << 0)
1.52 kristaps 35: enum mdoc_next next;
1.41 kristaps 36: struct mdoc_node *last;
37: struct mdoc_node *first;
1.43 kristaps 38: struct mdoc_meta meta;
1.42 kristaps 39: enum mdoc_sec sec_lastn;
40: enum mdoc_sec sec_last;
1.36 kristaps 41: };
42:
1.58 kristaps 43:
44: #define MACRO_PROT_ARGS struct mdoc *mdoc, int tok, int line, \
45: int ppos, int *pos, char *buf
46:
1.41 kristaps 47: struct mdoc_macro {
1.58 kristaps 48: int (*fp)(MACRO_PROT_ARGS);
1.41 kristaps 49: int flags;
50: #define MDOC_CALLABLE (1 << 0)
1.56 kristaps 51: #define MDOC_PARSED (1 << 1)
52: #define MDOC_EXPLICIT (1 << 2)
53: #define MDOC_QUOTABLE (1 << 3)
54: #define MDOC_PROLOGUE (1 << 4)
1.63 ! kristaps 55: #define MDOC_TABSEP (1 << 5)
1.8 kristaps 56: };
1.5 kristaps 57:
1.41 kristaps 58: extern const struct mdoc_macro *const mdoc_macros;
1.24 kristaps 59:
1.1 kristaps 60: __BEGIN_DECLS
61:
1.60 kristaps 62: #define mdoc_vwarn(m, n, t) \
63: mdoc_pwarn((m), (n)->line, (n)->pos, (t))
64: #define mdoc_verr(m, n, t) \
65: mdoc_perr((m), (n)->line, (n)->pos, (t))
66: #define mdoc_warn(m, t) \
67: mdoc_pwarn((m), (m)->last->line, (m)->last->pos, (t))
68: #define mdoc_err(m, t) \
69: mdoc_perr((m), (m)->last->line, (m)->last->pos, (t))
70: int mdoc_pwarn(struct mdoc *, int, int, enum mdoc_warn);
71: int mdoc_perr(struct mdoc *, int, int, enum mdoc_err);
72: void mdoc_msg(struct mdoc *, const char *, ...);
1.58 kristaps 73: int mdoc_macro(MACRO_PROT_ARGS);
1.41 kristaps 74: int mdoc_find(const struct mdoc *, const char *);
1.60 kristaps 75: int mdoc_word_alloc(struct mdoc *,
1.59 kristaps 76: int, int, const char *);
1.60 kristaps 77: int mdoc_elem_alloc(struct mdoc *, int, int,
1.59 kristaps 78: int, size_t, const struct mdoc_arg *);
1.60 kristaps 79: int mdoc_block_alloc(struct mdoc *, int, int,
1.59 kristaps 80: int, size_t, const struct mdoc_arg *);
1.61 kristaps 81: int mdoc_root_alloc(struct mdoc *);
1.60 kristaps 82: int mdoc_head_alloc(struct mdoc *, int, int, int);
83: int mdoc_tail_alloc(struct mdoc *, int, int, int);
84: int mdoc_body_alloc(struct mdoc *, int, int, int);
1.41 kristaps 85: void mdoc_node_free(struct mdoc_node *);
86: void mdoc_sibling(struct mdoc *, int, struct mdoc_node **,
87: struct mdoc_node **, struct mdoc_node *);
1.44 kristaps 88: void *mdoc_tokhash_alloc(void);
89: int mdoc_tokhash_find(const void *, const char *);
90: void mdoc_tokhash_free(void *);
1.42 kristaps 91: int mdoc_isdelim(const char *);
1.45 kristaps 92: int mdoc_iscdelim(char);
1.43 kristaps 93: enum mdoc_sec mdoc_atosec(size_t, const char **);
94: enum mdoc_msec mdoc_atomsec(const char *);
95: enum mdoc_vol mdoc_atovol(const char *);
96: enum mdoc_arch mdoc_atoarch(const char *);
1.48 kristaps 97: enum mdoc_att mdoc_atoatt(const char *);
1.43 kristaps 98: time_t mdoc_atotime(const char *);
99:
1.60 kristaps 100: int mdoc_valid_pre(struct mdoc *, struct mdoc_node *);
101: int mdoc_valid_post(struct mdoc *);
102: int mdoc_action_pre(struct mdoc *, struct mdoc_node *);
103: int mdoc_action_post(struct mdoc *);
1.50 kristaps 104:
1.60 kristaps 105: int mdoc_argv(struct mdoc *, int, int,
1.45 kristaps 106: struct mdoc_arg *, int *, char *);
1.52 kristaps 107: #define ARGV_ERROR (-1)
108: #define ARGV_EOLN (0)
109: #define ARGV_ARG (1)
110: #define ARGV_WORD (2)
1.44 kristaps 111: void mdoc_argv_free(int, struct mdoc_arg *);
1.45 kristaps 112: int mdoc_args(struct mdoc *, int,
113: int *, char *, int, char **);
114: #define ARGS_ERROR (-1)
115: #define ARGS_EOLN (0)
116: #define ARGS_WORD (1)
117: #define ARGS_PUNCT (2)
118:
119: #define ARGS_QUOTED (1 << 0)
120: #define ARGS_DELIM (1 << 1)
1.62 kristaps 121: #define ARGS_TABSEP (1 << 2)
1.44 kristaps 122:
123: int xstrlcat(char *, const char *, size_t);
124: int xstrlcpy(char *, const char *, size_t);
125: int xstrcmp(const char *, const char *);
126: void *xcalloc(size_t, size_t);
127: char *xstrdup(const char *);
128:
1.51 kristaps 129: int macro_obsolete(MACRO_PROT_ARGS);
1.48 kristaps 130: int macro_constant(MACRO_PROT_ARGS);
1.55 kristaps 131: int macro_constant_scoped(MACRO_PROT_ARGS);
1.47 kristaps 132: int macro_constant_delimited(MACRO_PROT_ARGS);
1.43 kristaps 133: int macro_text(MACRO_PROT_ARGS);
1.52 kristaps 134: int macro_scoped(MACRO_PROT_ARGS);
1.63 ! kristaps 135: int macro_scoped_close(MACRO_PROT_ARGS);
1.46 kristaps 136: int macro_scoped_line(MACRO_PROT_ARGS);
1.52 kristaps 137: int macro_prologue(MACRO_PROT_ARGS);
1.57 kristaps 138: int macro_end(struct mdoc *);
1.35 kristaps 139:
1.1 kristaps 140: __END_DECLS
141:
142: #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