Annotation of mandoc/libmdoc.h, Revision 1.93
1.93 ! schwarze 1: /* $Id: libmdoc.h,v 1.92 2014/11/28 04:47:03 schwarze Exp $ */
1.1 kristaps 2: /*
1.77 schwarze 3: * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.89 schwarze 4: * Copyright (c) 2013, 2014 Ingo Schwarze <schwarze@openbsd.org>
1.1 kristaps 5: *
6: * Permission to use, copy, modify, and distribute this software for any
1.6 kristaps 7: * purpose with or without fee is hereby granted, provided that the above
8: * copyright notice and this permission notice appear in all copies.
1.1 kristaps 9: *
1.6 kristaps 10: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11: * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12: * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13: * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14: * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15: * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16: * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
1.1 kristaps 17: */
18: #ifndef LIBMDOC_H
19: #define LIBMDOC_H
20:
21: enum mdoc_next {
22: MDOC_NEXT_SIBLING = 0,
23: MDOC_NEXT_CHILD
24: };
25:
26: struct mdoc {
1.69 kristaps 27: struct mparse *parse; /* parse pointer */
1.86 schwarze 28: const char *defos; /* default argument for .Os */
1.83 schwarze 29: int quick; /* abort parse early */
1.69 kristaps 30: int flags; /* parse flags */
1.42 kristaps 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.82 schwarze 38: #define MDOC_KEEP (1 << 8) /* in a word keep */
39: #define MDOC_SMOFF (1 << 9) /* spacing is off */
1.89 schwarze 40: #define MDOC_NODELIMC (1 << 10) /* disable closing delimiter handling */
1.56 kristaps 41: enum mdoc_next next; /* where to put the next node */
42: struct mdoc_node *last; /* the last node parsed */
43: struct mdoc_node *first; /* the first node parsed */
1.85 schwarze 44: struct mdoc_node *last_es; /* the most recent Es node */
1.56 kristaps 45: struct mdoc_meta meta; /* document meta-data */
1.1 kristaps 46: enum mdoc_sec lastnamed;
47: enum mdoc_sec lastsec;
1.75 kristaps 48: struct roff *roff;
1.13 kristaps 49: };
1.1 kristaps 50:
1.81 schwarze 51: #define MACRO_PROT_ARGS struct mdoc *mdoc, \
1.55 kristaps 52: enum mdoct tok, \
53: int line, \
54: int ppos, \
55: int *pos, \
56: char *buf
1.1 kristaps 57:
58: struct mdoc_macro {
1.92 schwarze 59: void (*fp)(MACRO_PROT_ARGS);
1.1 kristaps 60: int flags;
61: #define MDOC_CALLABLE (1 << 0)
62: #define MDOC_PARSED (1 << 1)
63: #define MDOC_EXPLICIT (1 << 2)
64: #define MDOC_PROLOGUE (1 << 3)
1.82 schwarze 65: #define MDOC_IGNDELIM (1 << 4)
66: #define MDOC_JOIN (1 << 5)
1.1 kristaps 67: };
68:
1.36 kristaps 69: enum margserr {
1.35 kristaps 70: ARGS_ERROR,
1.73 kristaps 71: ARGS_EOLN, /* end-of-line */
72: ARGS_WORD, /* normal word */
73: ARGS_PUNCT, /* series of punctuation */
74: ARGS_QWORD, /* quoted word */
75: ARGS_PHRASE, /* Ta'd phrase (-column) */
76: ARGS_PPHRASE, /* tabbed phrase (-column) */
77: ARGS_PEND /* last phrase (-column) */
1.35 kristaps 78: };
79:
1.37 kristaps 80: enum margverr {
81: ARGV_ERROR,
1.73 kristaps 82: ARGV_EOLN, /* end of line */
83: ARGV_ARG, /* valid argument */
84: ARGV_WORD /* normal word (or bad argument---same thing) */
1.37 kristaps 85: };
86:
1.70 kristaps 87: /*
88: * A punctuation delimiter is opening, closing, or "middle mark"
89: * punctuation. These govern spacing.
90: * Opening punctuation (e.g., the opening parenthesis) suppresses the
91: * following space; closing punctuation (e.g., the closing parenthesis)
92: * suppresses the leading space; middle punctuation (e.g., the vertical
93: * bar) can do either. The middle punctuation delimiter bends the rules
94: * depending on usage.
95: */
96: enum mdelim {
97: DELIM_NONE = 0,
98: DELIM_OPEN,
99: DELIM_MIDDLE,
100: DELIM_CLOSE,
101: DELIM_MAX
102: };
103:
1.1 kristaps 104: extern const struct mdoc_macro *const mdoc_macros;
105:
106: __BEGIN_DECLS
107:
1.92 schwarze 108: void mdoc_macro(MACRO_PROT_ARGS);
1.91 schwarze 109: void mdoc_word_alloc(struct mdoc *, int, int, const char *);
1.82 schwarze 110: void mdoc_word_append(struct mdoc *, const char *);
1.91 schwarze 111: void mdoc_elem_alloc(struct mdoc *, int, int,
1.31 kristaps 112: enum mdoct, struct mdoc_arg *);
1.91 schwarze 113: struct mdoc_node *mdoc_block_alloc(struct mdoc *, int, int,
1.31 kristaps 114: enum mdoct, struct mdoc_arg *);
1.91 schwarze 115: struct mdoc_node *mdoc_head_alloc(struct mdoc *, int, int, enum mdoct);
116: void mdoc_tail_alloc(struct mdoc *, int, int, enum mdoct);
117: struct mdoc_node *mdoc_body_alloc(struct mdoc *, int, int, enum mdoct);
118: void mdoc_endbody_alloc(struct mdoc *, int, int, enum mdoct,
1.81 schwarze 119: struct mdoc_node *, enum mdoc_endbody);
1.33 kristaps 120: void mdoc_node_delete(struct mdoc *, struct mdoc_node *);
1.91 schwarze 121: void mdoc_node_relink(struct mdoc *, struct mdoc_node *);
1.27 kristaps 122: void mdoc_hash_init(void);
1.31 kristaps 123: enum mdoct mdoc_hash_find(const char *);
1.16 kristaps 124: const char *mdoc_a2att(const char *);
1.18 kristaps 125: const char *mdoc_a2lib(const char *);
1.17 kristaps 126: const char *mdoc_a2st(const char *);
1.1 kristaps 127: const char *mdoc_a2arch(const char *);
1.90 schwarze 128: void mdoc_valid_pre(struct mdoc *, struct mdoc_node *);
129: void mdoc_valid_post(struct mdoc *);
1.37 kristaps 130: enum margverr mdoc_argv(struct mdoc *, int, enum mdoct,
1.1 kristaps 131: struct mdoc_arg **, int *, char *);
132: void mdoc_argv_free(struct mdoc_arg *);
1.36 kristaps 133: enum margserr mdoc_args(struct mdoc *, int,
1.31 kristaps 134: int *, char *, enum mdoct, char **);
1.84 schwarze 135: enum margserr mdoc_zargs(struct mdoc *, int,
1.74 kristaps 136: int *, char *, char **);
1.92 schwarze 137: void mdoc_macroend(struct mdoc *);
1.70 kristaps 138: enum mdelim mdoc_isdelim(const char *);
1.1 kristaps 139:
140: __END_DECLS
141:
142: #endif /*!LIBMDOC_H*/
CVSweb