Annotation of mandoc/private.h, Revision 1.64
1.64 ! kristaps 1: /* $Id: private.h,v 1.63 2009/01/14 11:58:24 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.64 ! kristaps 48: int (*fp)(MACRO_PROT_ARGS);
! 49: int flags;
! 50: #define MDOC_CALLABLE (1 << 0)
! 51: #define MDOC_PARSED (1 << 1)
! 52: #define MDOC_EXPLICIT (1 << 2)
! 53: #define MDOC_QUOTABLE (1 << 3)
! 54: #define MDOC_PROLOGUE (1 << 4)
! 55: #define MDOC_TABSEP (1 << 5)
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.41 kristaps 102: int mdoc_find(const struct mdoc *, const char *);
1.60 kristaps 103: int mdoc_word_alloc(struct mdoc *,
1.59 kristaps 104: int, int, const char *);
1.60 kristaps 105: int mdoc_elem_alloc(struct mdoc *, int, int,
1.59 kristaps 106: int, size_t, const struct mdoc_arg *);
1.60 kristaps 107: int mdoc_block_alloc(struct mdoc *, int, int,
1.59 kristaps 108: int, size_t, const struct mdoc_arg *);
1.61 kristaps 109: int mdoc_root_alloc(struct mdoc *);
1.60 kristaps 110: int mdoc_head_alloc(struct mdoc *, int, int, int);
111: int mdoc_tail_alloc(struct mdoc *, int, int, int);
112: int mdoc_body_alloc(struct mdoc *, int, int, int);
1.41 kristaps 113: void mdoc_node_free(struct mdoc_node *);
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.42 kristaps 119: int mdoc_isdelim(const char *);
1.45 kristaps 120: int mdoc_iscdelim(char);
1.43 kristaps 121: enum mdoc_sec mdoc_atosec(size_t, const char **);
122: enum mdoc_msec mdoc_atomsec(const char *);
123: enum mdoc_vol mdoc_atovol(const char *);
124: enum mdoc_arch mdoc_atoarch(const char *);
1.48 kristaps 125: enum mdoc_att mdoc_atoatt(const char *);
1.43 kristaps 126: time_t mdoc_atotime(const char *);
127:
1.60 kristaps 128: int mdoc_valid_pre(struct mdoc *, struct mdoc_node *);
129: int mdoc_valid_post(struct mdoc *);
130: int mdoc_action_pre(struct mdoc *, struct mdoc_node *);
131: int mdoc_action_post(struct mdoc *);
1.50 kristaps 132:
1.60 kristaps 133: int mdoc_argv(struct mdoc *, int, int,
1.45 kristaps 134: struct mdoc_arg *, int *, char *);
1.52 kristaps 135: #define ARGV_ERROR (-1)
136: #define ARGV_EOLN (0)
137: #define ARGV_ARG (1)
138: #define ARGV_WORD (2)
1.44 kristaps 139: void mdoc_argv_free(int, struct mdoc_arg *);
1.45 kristaps 140: int mdoc_args(struct mdoc *, int,
141: int *, char *, int, char **);
142: #define ARGS_ERROR (-1)
143: #define ARGS_EOLN (0)
144: #define ARGS_WORD (1)
145: #define ARGS_PUNCT (2)
146:
147: #define ARGS_QUOTED (1 << 0)
148: #define ARGS_DELIM (1 << 1)
1.62 kristaps 149: #define ARGS_TABSEP (1 << 2)
1.44 kristaps 150:
151: int xstrlcat(char *, const char *, size_t);
152: int xstrlcpy(char *, const char *, size_t);
153: int xstrcmp(const char *, const char *);
154: void *xcalloc(size_t, size_t);
155: char *xstrdup(const char *);
156:
1.51 kristaps 157: int macro_obsolete(MACRO_PROT_ARGS);
1.48 kristaps 158: int macro_constant(MACRO_PROT_ARGS);
1.55 kristaps 159: int macro_constant_scoped(MACRO_PROT_ARGS);
1.47 kristaps 160: int macro_constant_delimited(MACRO_PROT_ARGS);
1.43 kristaps 161: int macro_text(MACRO_PROT_ARGS);
1.52 kristaps 162: int macro_scoped(MACRO_PROT_ARGS);
1.63 kristaps 163: int macro_scoped_close(MACRO_PROT_ARGS);
1.46 kristaps 164: int macro_scoped_line(MACRO_PROT_ARGS);
1.52 kristaps 165: int macro_prologue(MACRO_PROT_ARGS);
1.57 kristaps 166: int macro_end(struct mdoc *);
1.35 kristaps 167:
1.1 kristaps 168: __END_DECLS
169:
170: #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