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