1 /* $Id: libmdoc.h,v 1.82 2013/10/21 23:47:58 schwarze Exp $ */ 2 /* 3 * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv> 4 * Copyright (c) 2013 Ingo Schwarze <schwarze@openbsd.org> 5 * 6 * Permission to use, copy, modify, and distribute this software for any 7 * purpose with or without fee is hereby granted, provided that the above 8 * copyright notice and this permission notice appear in all copies. 9 * 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. 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 { 27 struct mparse *parse; /* parse pointer */ 28 char *defos; /* default argument for .Os */ 29 int flags; /* parse flags */ 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 */ 34 #define MDOC_PHRASELIT (1 << 4) /* literal within a partila phrase */ 35 #define MDOC_PPHRASE (1 << 5) /* within a partial phrase */ 36 #define MDOC_FREECOL (1 << 6) /* `It' invocation should close */ 37 #define MDOC_SYNOPSIS (1 << 7) /* SYNOPSIS-style formatting */ 38 #define MDOC_KEEP (1 << 8) /* in a word keep */ 39 #define MDOC_SMOFF (1 << 9) /* spacing is off */ 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 */ 44 enum mdoc_sec lastnamed; 45 enum mdoc_sec lastsec; 46 struct roff *roff; 47 }; 48 49 #define MACRO_PROT_ARGS struct mdoc *mdoc, \ 50 enum mdoct tok, \ 51 int line, \ 52 int ppos, \ 53 int *pos, \ 54 char *buf 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 #define MDOC_JOIN (1 << 5) 65 }; 66 67 enum margserr { 68 ARGS_ERROR, 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) */ 76 }; 77 78 enum margverr { 79 ARGV_ERROR, 80 ARGV_EOLN, /* end of line */ 81 ARGV_ARG, /* valid argument */ 82 ARGV_WORD /* normal word (or bad argument---same thing) */ 83 }; 84 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 102 extern const struct mdoc_macro *const mdoc_macros; 103 104 __BEGIN_DECLS 105 106 #define mdoc_pmsg(mdoc, l, p, t) \ 107 mandoc_msg((t), (mdoc)->parse, (l), (p), NULL) 108 #define mdoc_nmsg(mdoc, n, t) \ 109 mandoc_msg((t), (mdoc)->parse, (n)->line, (n)->pos, NULL) 110 int mdoc_macro(MACRO_PROT_ARGS); 111 int mdoc_word_alloc(struct mdoc *, 112 int, int, const char *); 113 void mdoc_word_append(struct mdoc *, const char *); 114 int mdoc_elem_alloc(struct mdoc *, int, int, 115 enum mdoct, struct mdoc_arg *); 116 int mdoc_block_alloc(struct mdoc *, int, int, 117 enum mdoct, struct mdoc_arg *); 118 int mdoc_head_alloc(struct mdoc *, int, int, enum mdoct); 119 int mdoc_tail_alloc(struct mdoc *, int, int, enum mdoct); 120 int mdoc_body_alloc(struct mdoc *, int, int, enum mdoct); 121 int mdoc_endbody_alloc(struct mdoc *, int, int, enum mdoct, 122 struct mdoc_node *, enum mdoc_endbody); 123 void mdoc_node_delete(struct mdoc *, struct mdoc_node *); 124 int mdoc_node_relink(struct mdoc *, struct mdoc_node *); 125 void mdoc_hash_init(void); 126 enum mdoct mdoc_hash_find(const char *); 127 const char *mdoc_a2att(const char *); 128 const char *mdoc_a2lib(const char *); 129 const char *mdoc_a2st(const char *); 130 const char *mdoc_a2arch(const char *); 131 const char *mdoc_a2vol(const char *); 132 int mdoc_valid_pre(struct mdoc *, struct mdoc_node *); 133 int mdoc_valid_post(struct mdoc *); 134 enum margverr mdoc_argv(struct mdoc *, int, enum mdoct, 135 struct mdoc_arg **, int *, char *); 136 void mdoc_argv_free(struct mdoc_arg *); 137 enum margserr mdoc_args(struct mdoc *, int, 138 int *, char *, enum mdoct, char **); 139 enum margserr mdoc_zargs(struct mdoc *, int, 140 int *, char *, char **); 141 int mdoc_macroend(struct mdoc *); 142 enum mdelim mdoc_isdelim(const char *); 143 144 __END_DECLS 145 146 #endif /*!LIBMDOC_H*/ 147