Annotation of src/usr.bin/mandoc/libmdoc.h, Revision 1.63
1.63 ! schwarze 1: /* $OpenBSD: libmdoc.h,v 1.62 2014/11/28 03:13:58 schwarze Exp $ */
1.1 kristaps 2: /*
1.45 schwarze 3: * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
1.59 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.3 schwarze 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.3 schwarze 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:
19: enum mdoc_next {
20: MDOC_NEXT_SIBLING = 0,
21: MDOC_NEXT_CHILD
22: };
23:
24: struct mdoc {
1.45 schwarze 25: struct mparse *parse; /* parse pointer */
1.56 schwarze 26: const char *defos; /* default argument for .Os */
1.53 schwarze 27: int quick; /* abort parse early */
1.45 schwarze 28: int flags; /* parse flags */
1.30 schwarze 29: #define MDOC_LITERAL (1 << 1) /* in a literal scope */
30: #define MDOC_PBODY (1 << 2) /* in the document body */
31: #define MDOC_NEWLINE (1 << 3) /* first macro/text in a line */
1.32 schwarze 32: #define MDOC_PHRASELIT (1 << 4) /* literal within a partila phrase */
33: #define MDOC_PPHRASE (1 << 5) /* within a partial phrase */
1.37 schwarze 34: #define MDOC_FREECOL (1 << 6) /* `It' invocation should close */
1.40 schwarze 35: #define MDOC_SYNOPSIS (1 << 7) /* SYNOPSIS-style formatting */
1.52 schwarze 36: #define MDOC_KEEP (1 << 8) /* in a word keep */
37: #define MDOC_SMOFF (1 << 9) /* spacing is off */
1.59 schwarze 38: #define MDOC_NODELIMC (1 << 10) /* disable closing delimiter handling */
1.38 schwarze 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 */
1.55 schwarze 42: struct mdoc_node *last_es; /* the most recent Es node */
1.38 schwarze 43: struct mdoc_meta meta; /* document meta-data */
1.1 kristaps 44: enum mdoc_sec lastnamed;
45: enum mdoc_sec lastsec;
1.47 schwarze 46: struct roff *roff;
1.1 kristaps 47: };
48:
1.51 schwarze 49: #define MACRO_PROT_ARGS struct mdoc *mdoc, \
1.38 schwarze 50: enum mdoct tok, \
51: int line, \
52: int ppos, \
53: int *pos, \
54: char *buf
1.1 kristaps 55:
56: struct mdoc_macro {
1.63 ! schwarze 57: void (*fp)(MACRO_PROT_ARGS);
1.1 kristaps 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)
1.52 schwarze 63: #define MDOC_IGNDELIM (1 << 4)
64: #define MDOC_JOIN (1 << 5)
1.1 kristaps 65: };
66:
1.29 schwarze 67: enum margserr {
68: ARGS_ERROR,
1.46 schwarze 69: ARGS_EOLN, /* end-of-line */
70: ARGS_WORD, /* normal word */
71: ARGS_PUNCT, /* series of punctuation */
72: ARGS_QWORD, /* quoted word */
73: ARGS_PHRASE, /* Ta'd phrase (-column) */
74: ARGS_PPHRASE, /* tabbed phrase (-column) */
75: ARGS_PEND /* last phrase (-column) */
1.29 schwarze 76: };
77:
78: enum margverr {
79: ARGV_ERROR,
1.46 schwarze 80: ARGV_EOLN, /* end of line */
81: ARGV_ARG, /* valid argument */
82: ARGV_WORD /* normal word (or bad argument---same thing) */
1.29 schwarze 83: };
84:
1.45 schwarze 85: /*
86: * A punctuation delimiter is opening, closing, or "middle mark"
87: * punctuation. These govern spacing.
88: * Opening punctuation (e.g., the opening parenthesis) suppresses the
89: * following space; closing punctuation (e.g., the closing parenthesis)
90: * suppresses the leading space; middle punctuation (e.g., the vertical
91: * bar) can do either. The middle punctuation delimiter bends the rules
92: * depending on usage.
93: */
94: enum mdelim {
95: DELIM_NONE = 0,
96: DELIM_OPEN,
97: DELIM_MIDDLE,
98: DELIM_CLOSE,
99: DELIM_MAX
100: };
101:
1.1 kristaps 102: extern const struct mdoc_macro *const mdoc_macros;
103:
104: __BEGIN_DECLS
105:
1.63 ! schwarze 106: void mdoc_macro(MACRO_PROT_ARGS);
1.62 schwarze 107: void mdoc_word_alloc(struct mdoc *, int, int, const char *);
1.52 schwarze 108: void mdoc_word_append(struct mdoc *, const char *);
1.62 schwarze 109: void mdoc_elem_alloc(struct mdoc *, int, int,
1.25 schwarze 110: enum mdoct, struct mdoc_arg *);
1.62 schwarze 111: struct mdoc_node *mdoc_block_alloc(struct mdoc *, int, int,
1.25 schwarze 112: enum mdoct, struct mdoc_arg *);
1.62 schwarze 113: struct mdoc_node *mdoc_head_alloc(struct mdoc *, int, int, enum mdoct);
114: void mdoc_tail_alloc(struct mdoc *, int, int, enum mdoct);
115: struct mdoc_node *mdoc_body_alloc(struct mdoc *, int, int, enum mdoct);
116: void mdoc_endbody_alloc(struct mdoc *, int, int, enum mdoct,
1.51 schwarze 117: struct mdoc_node *, enum mdoc_endbody);
1.27 schwarze 118: void mdoc_node_delete(struct mdoc *, struct mdoc_node *);
1.62 schwarze 119: void mdoc_node_relink(struct mdoc *, struct mdoc_node *);
1.21 schwarze 120: void mdoc_hash_init(void);
1.25 schwarze 121: enum mdoct mdoc_hash_find(const char *);
1.15 schwarze 122: const char *mdoc_a2att(const char *);
123: const char *mdoc_a2lib(const char *);
124: const char *mdoc_a2st(const char *);
1.1 kristaps 125: const char *mdoc_a2arch(const char *);
126: const char *mdoc_a2vol(const char *);
1.61 schwarze 127: void mdoc_valid_pre(struct mdoc *, struct mdoc_node *);
128: void mdoc_valid_post(struct mdoc *);
1.29 schwarze 129: enum margverr mdoc_argv(struct mdoc *, int, enum mdoct,
1.1 kristaps 130: struct mdoc_arg **, int *, char *);
131: void mdoc_argv_free(struct mdoc_arg *);
1.29 schwarze 132: enum margserr mdoc_args(struct mdoc *, int,
1.25 schwarze 133: int *, char *, enum mdoct, char **);
1.54 schwarze 134: enum margserr mdoc_zargs(struct mdoc *, int,
1.46 schwarze 135: int *, char *, char **);
1.63 ! schwarze 136: void mdoc_macroend(struct mdoc *);
1.45 schwarze 137: enum mdelim mdoc_isdelim(const char *);
1.1 kristaps 138:
139: __END_DECLS
![[BACK]](/icons/back.gif){kind=icon}
Return to libmdoc.h CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / mandoc