Annotation of mandoc/libmdoc.h, Revision 1.67
1.67 ! kristaps 1: /* $Id: libmdoc.h,v 1.66 2011/03/17 09:22:39 kristaps Exp $ */
1.1 kristaps 2: /*
1.61 schwarze 3: * Copyright (c) 2008, 2009, 2010 Kristaps Dzonsons <kristaps@bsd.lv>
1.1 kristaps 4: *
5: * Permission to use, copy, modify, and distribute this software for any
1.6 kristaps 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.6 kristaps 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:
20: #include "mdoc.h"
21:
22: enum mdoc_next {
23: MDOC_NEXT_SIBLING = 0,
24: MDOC_NEXT_CHILD
25: };
26:
27: struct mdoc {
1.56 kristaps 28: void *data; /* private application data */
29: mandocmsg msg; /* message callback */
1.1 kristaps 30: int flags;
1.42 kristaps 31: #define MDOC_HALT (1 << 0) /* error in parse: halt */
32: #define MDOC_LITERAL (1 << 1) /* in a literal scope */
33: #define MDOC_PBODY (1 << 2) /* in the document body */
34: #define MDOC_NEWLINE (1 << 3) /* first macro/text in a line */
1.45 kristaps 35: #define MDOC_PHRASELIT (1 << 4) /* literal within a partila phrase */
36: #define MDOC_PPHRASE (1 << 5) /* within a partial phrase */
1.51 kristaps 37: #define MDOC_FREECOL (1 << 6) /* `It' invocation should close */
1.59 schwarze 38: #define MDOC_SYNOPSIS (1 << 7) /* SYNOPSIS-style formatting */
1.56 kristaps 39: enum mdoc_next next; /* where to put the next node */
40: struct mdoc_node *last; /* the last node parsed */
41: struct mdoc_node *first; /* the first node parsed */
42: struct mdoc_meta meta; /* document meta-data */
1.1 kristaps 43: enum mdoc_sec lastnamed;
44: enum mdoc_sec lastsec;
1.57 kristaps 45: struct regset *regs; /* registers */
1.13 kristaps 46: };
1.1 kristaps 47:
1.55 kristaps 48: #define MACRO_PROT_ARGS struct mdoc *m, \
49: enum mdoct tok, \
50: int line, \
51: int ppos, \
52: int *pos, \
53: char *buf
1.1 kristaps 54:
55: struct mdoc_macro {
56: int (*fp)(MACRO_PROT_ARGS);
57: int flags;
58: #define MDOC_CALLABLE (1 << 0)
59: #define MDOC_PARSED (1 << 1)
60: #define MDOC_EXPLICIT (1 << 2)
61: #define MDOC_PROLOGUE (1 << 3)
62: #define MDOC_IGNDELIM (1 << 4)
63: /* Reserved words in arguments treated as text. */
64: };
65:
1.36 kristaps 66: enum margserr {
1.35 kristaps 67: ARGS_ERROR,
68: ARGS_EOLN,
69: ARGS_WORD,
70: ARGS_PUNCT,
71: ARGS_QWORD,
1.38 kristaps 72: ARGS_PHRASE,
1.40 kristaps 73: ARGS_PPHRASE,
74: ARGS_PEND
1.35 kristaps 75: };
76:
1.37 kristaps 77: enum margverr {
78: ARGV_ERROR,
79: ARGV_EOLN,
80: ARGV_ARG,
81: ARGV_WORD
82: };
83:
1.1 kristaps 84: extern const struct mdoc_macro *const mdoc_macros;
85:
86: __BEGIN_DECLS
87:
1.48 kristaps 88: #define mdoc_pmsg(m, l, p, t) \
89: (*(m)->msg)((t), (m)->data, (l), (p), NULL)
90: #define mdoc_nmsg(m, n, t) \
91: (*(m)->msg)((t), (m)->data, (n)->line, (n)->pos, NULL)
92: int mdoc_vmsg(struct mdoc *, enum mandocerr,
93: int, int, const char *, ...);
1.1 kristaps 94: int mdoc_macro(MACRO_PROT_ARGS);
95: int mdoc_word_alloc(struct mdoc *,
96: int, int, const char *);
97: int mdoc_elem_alloc(struct mdoc *, int, int,
1.31 kristaps 98: enum mdoct, struct mdoc_arg *);
1.1 kristaps 99: int mdoc_block_alloc(struct mdoc *, int, int,
1.31 kristaps 100: enum mdoct, struct mdoc_arg *);
101: int mdoc_head_alloc(struct mdoc *, int, int, enum mdoct);
102: int mdoc_tail_alloc(struct mdoc *, int, int, enum mdoct);
103: int mdoc_body_alloc(struct mdoc *, int, int, enum mdoct);
1.58 schwarze 104: int mdoc_endbody_alloc(struct mdoc *m, int line, int pos,
105: enum mdoct tok, struct mdoc_node *body,
106: enum mdoc_endbody end);
1.33 kristaps 107: void mdoc_node_delete(struct mdoc *, struct mdoc_node *);
1.27 kristaps 108: void mdoc_hash_init(void);
1.31 kristaps 109: enum mdoct mdoc_hash_find(const char *);
1.16 kristaps 110: const char *mdoc_a2att(const char *);
1.18 kristaps 111: const char *mdoc_a2lib(const char *);
1.17 kristaps 112: const char *mdoc_a2st(const char *);
1.1 kristaps 113: const char *mdoc_a2arch(const char *);
114: const char *mdoc_a2vol(const char *);
115: const char *mdoc_a2msec(const char *);
1.52 kristaps 116: int mdoc_valid_pre(struct mdoc *, struct mdoc_node *);
1.1 kristaps 117: int mdoc_valid_post(struct mdoc *);
1.37 kristaps 118: enum margverr mdoc_argv(struct mdoc *, int, enum mdoct,
1.1 kristaps 119: struct mdoc_arg **, int *, char *);
120: void mdoc_argv_free(struct mdoc_arg *);
1.32 kristaps 121: void mdoc_argn_free(struct mdoc_arg *, int);
1.36 kristaps 122: enum margserr mdoc_args(struct mdoc *, int,
1.31 kristaps 123: int *, char *, enum mdoct, char **);
1.36 kristaps 124: enum margserr mdoc_zargs(struct mdoc *, int,
1.25 kristaps 125: int *, char *, int, char **);
1.43 kristaps 126: #define ARGS_DELIM (1 << 1)
127: #define ARGS_TABSEP (1 << 2)
128: #define ARGS_NOWARN (1 << 3)
1.35 kristaps 129:
1.2 kristaps 130: int mdoc_macroend(struct mdoc *);
1.1 kristaps 131:
132: __END_DECLS
133:
134: #endif /*!LIBMDOC_H*/
CVSweb