Annotation of src/usr.bin/mandoc/libmdoc.h, Revision 1.38
1.38 ! schwarze 1: /* $Id: libmdoc.h,v 1.37 2010/06/06 20:30:08 schwarze Exp $ */
1.1 kristaps 2: /*
1.38 ! schwarze 3: * Copyright (c) 2008, 2009 Kristaps Dzonsons <kristaps@bsd.lv>
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:
1.38 ! schwarze 20: #include "regs.h"
1.1 kristaps 21: #include "mdoc.h"
22:
23: enum mdoc_next {
24: MDOC_NEXT_SIBLING = 0,
25: MDOC_NEXT_CHILD
26: };
27:
28: struct mdoc {
1.38 ! schwarze 29: void *data; /* private application data */
! 30: mandocmsg msg; /* message callback */
1.1 kristaps 31: int flags;
1.30 schwarze 32: #define MDOC_HALT (1 << 0) /* error in parse: halt */
33: #define MDOC_LITERAL (1 << 1) /* in a literal scope */
34: #define MDOC_PBODY (1 << 2) /* in the document body */
35: #define MDOC_NEWLINE (1 << 3) /* first macro/text in a line */
1.32 schwarze 36: #define MDOC_PHRASELIT (1 << 4) /* literal within a partila phrase */
37: #define MDOC_PPHRASE (1 << 5) /* within a partial phrase */
1.37 schwarze 38: #define MDOC_FREECOL (1 << 6) /* `It' invocation should close */
1.1 kristaps 39: int pflags;
1.38 ! schwarze 40: enum mdoc_next next; /* where to put the next node */
! 41: struct mdoc_node *last; /* the last node parsed */
! 42: struct mdoc_node *first; /* the first node parsed */
! 43: struct mdoc_meta meta; /* document meta-data */
1.1 kristaps 44: enum mdoc_sec lastnamed;
45: enum mdoc_sec lastsec;
1.38 ! schwarze 46: struct regset *regs; /* registers */
1.1 kristaps 47: };
48:
1.38 ! schwarze 49: #define MACRO_PROT_ARGS struct mdoc *m, \
! 50: enum mdoct tok, \
! 51: int line, \
! 52: int ppos, \
! 53: int *pos, \
! 54: char *buf
1.1 kristaps 55:
56: struct mdoc_macro {
57: int (*fp)(MACRO_PROT_ARGS);
58: int flags;
59: #define MDOC_CALLABLE (1 << 0)
60: #define MDOC_PARSED (1 << 1)
61: #define MDOC_EXPLICIT (1 << 2)
62: #define MDOC_PROLOGUE (1 << 3)
63: #define MDOC_IGNDELIM (1 << 4)
64: /* Reserved words in arguments treated as text. */
65: };
66:
1.29 schwarze 67: enum margserr {
68: ARGS_ERROR,
69: ARGS_EOLN,
70: ARGS_WORD,
71: ARGS_PUNCT,
72: ARGS_QWORD,
73: ARGS_PHRASE,
1.30 schwarze 74: ARGS_PPHRASE,
75: ARGS_PEND
1.29 schwarze 76: };
77:
78: enum margverr {
79: ARGV_ERROR,
80: ARGV_EOLN,
81: ARGV_ARG,
82: ARGV_WORD
83: };
84:
1.31 schwarze 85: enum mdelim {
86: DELIM_NONE = 0,
87: DELIM_OPEN,
88: DELIM_MIDDLE,
89: DELIM_CLOSE
90: };
91:
1.1 kristaps 92: extern const struct mdoc_macro *const mdoc_macros;
93:
94: __BEGIN_DECLS
95:
1.35 schwarze 96: #define mdoc_pmsg(m, l, p, t) \
97: (*(m)->msg)((t), (m)->data, (l), (p), NULL)
98: #define mdoc_nmsg(m, n, t) \
99: (*(m)->msg)((t), (m)->data, (n)->line, (n)->pos, NULL)
100: int mdoc_vmsg(struct mdoc *, enum mandocerr,
101: int, int, const char *, ...);
1.1 kristaps 102: int mdoc_macro(MACRO_PROT_ARGS);
103: int mdoc_word_alloc(struct mdoc *,
104: int, int, const char *);
105: int mdoc_elem_alloc(struct mdoc *, int, int,
1.25 schwarze 106: enum mdoct, struct mdoc_arg *);
1.1 kristaps 107: int mdoc_block_alloc(struct mdoc *, int, int,
1.25 schwarze 108: enum mdoct, struct mdoc_arg *);
109: int mdoc_head_alloc(struct mdoc *, int, int, enum mdoct);
110: int mdoc_tail_alloc(struct mdoc *, int, int, enum mdoct);
111: int mdoc_body_alloc(struct mdoc *, int, int, enum mdoct);
1.27 schwarze 112: void mdoc_node_delete(struct mdoc *, struct mdoc_node *);
1.21 schwarze 113: void mdoc_hash_init(void);
1.25 schwarze 114: enum mdoct mdoc_hash_find(const char *);
1.31 schwarze 115: enum mdelim mdoc_iscdelim(char);
116: enum mdelim mdoc_isdelim(const char *);
1.1 kristaps 117: size_t mdoc_isescape(const char *);
1.30 schwarze 118: enum mdoc_sec mdoc_str2sec(const char *);
1.1 kristaps 119: time_t mdoc_atotime(const char *);
1.29 schwarze 120: size_t mdoc_macro2len(enum mdoct);
1.15 schwarze 121: const char *mdoc_a2att(const char *);
122: const char *mdoc_a2lib(const char *);
123: const char *mdoc_a2st(const char *);
1.1 kristaps 124: const char *mdoc_a2arch(const char *);
125: const char *mdoc_a2vol(const char *);
126: const char *mdoc_a2msec(const char *);
1.37 schwarze 127: int mdoc_valid_pre(struct mdoc *, struct mdoc_node *);
1.1 kristaps 128: int mdoc_valid_post(struct mdoc *);
129: int mdoc_action_pre(struct mdoc *,
1.36 schwarze 130: struct mdoc_node *);
1.1 kristaps 131: int mdoc_action_post(struct mdoc *);
1.29 schwarze 132: enum margverr mdoc_argv(struct mdoc *, int, enum mdoct,
1.1 kristaps 133: struct mdoc_arg **, int *, char *);
134: void mdoc_argv_free(struct mdoc_arg *);
1.26 schwarze 135: void mdoc_argn_free(struct mdoc_arg *, int);
1.29 schwarze 136: enum margserr mdoc_args(struct mdoc *, int,
1.25 schwarze 137: int *, char *, enum mdoct, char **);
1.29 schwarze 138: enum margserr mdoc_zargs(struct mdoc *, int,
1.20 schwarze 139: int *, char *, int, char **);
1.32 schwarze 140: #define ARGS_DELIM (1 << 1)
141: #define ARGS_TABSEP (1 << 2)
142: #define ARGS_NOWARN (1 << 3)
1.29 schwarze 143:
1.1 kristaps 144: int mdoc_macroend(struct mdoc *);
145:
146: __END_DECLS
147:
148: #endif /*!LIBMDOC_H*/