1 /* $OpenBSD: libmdoc.h,v 1.59 2014/11/17 06:44:35 schwarze Exp $ */ 2 /* 3 * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv> 4 * Copyright (c) 2013, 2014 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 const char *defos; /* default argument for .Os */ 29 int quick; /* abort parse early */ 30 int flags; /* parse flags */ 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 #define MDOC_NODELIMC (1 << 10) /* disable closing delimiter handling */ 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 */ 44 struct mdoc_node *last_es; /* the most recent Es node */ 45 struct mdoc_meta meta; /* document meta-data */ 46 enum mdoc_sec lastnamed; 47 enum mdoc_sec lastsec; 48 struct roff *roff; 49 }; 50 51 #define MACRO_PROT_ARGS struct mdoc *mdoc, \ 52 enum mdoct tok, \ 53 int line, \ 54 int ppos, \ 55 int *pos, \ 56 char *buf 57 58 struct mdoc_macro { 59 int (*fp)(MACRO_PROT_ARGS); 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) 65 #define MDOC_IGNDELIM (1 << 4) 66 #define MDOC_JOIN (1 << 5) 67 }; 68 69 enum margserr { 70 ARGS_ERROR, 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) */ 78 }; 79 80 enum margverr { 81 ARGV_ERROR, 82 ARGV_EOLN, /* end of line */ 83 ARGV_ARG, /* valid argument */ 84 ARGV_WORD /* normal word (or bad argument---same thing) */ 85 }; 86 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 104 extern const struct mdoc_macro *const mdoc_macros; 105 106 __BEGIN_DECLS 107 108 int mdoc_macro(MACRO_PROT_ARGS); 109 int mdoc_word_alloc(struct mdoc *, 110 int, int, const char *); 111 void mdoc_word_append(struct mdoc *, const char *); 112 int mdoc_elem_alloc(struct mdoc *, int, int, 113 enum mdoct, struct mdoc_arg *); 114 int mdoc_block_alloc(struct mdoc *, int, int, 115 enum mdoct, struct mdoc_arg *); 116 int mdoc_head_alloc(struct mdoc *, int, int, enum mdoct); 117 int mdoc_tail_alloc(struct mdoc *, int, int, enum mdoct); 118 int mdoc_body_alloc(struct mdoc *, int, int, enum mdoct); 119 int mdoc_endbody_alloc(struct mdoc *, int, int, enum mdoct, 120 struct mdoc_node *, enum mdoc_endbody); 121 void mdoc_node_delete(struct mdoc *, struct mdoc_node *); 122 int mdoc_node_relink(struct mdoc *, struct mdoc_node *); 123 void mdoc_hash_init(void); 124 enum mdoct mdoc_hash_find(const char *); 125 const char *mdoc_a2att(const char *); 126 const char *mdoc_a2lib(const char *); 127 const char *mdoc_a2st(const char *); 128 const char *mdoc_a2arch(const char *); 129 const char *mdoc_a2vol(const char *); 130 int mdoc_valid_pre(struct mdoc *, struct mdoc_node *); 131 int mdoc_valid_post(struct mdoc *); 132 enum margverr mdoc_argv(struct mdoc *, int, enum mdoct, 133 struct mdoc_arg **, int *, char *); 134 void mdoc_argv_free(struct mdoc_arg *); 135 enum margserr mdoc_args(struct mdoc *, int, 136 int *, char *, enum mdoct, char **); 137 enum margserr mdoc_zargs(struct mdoc *, int, 138 int *, char *, char **); 139 int mdoc_macroend(struct mdoc *); 140 enum mdelim mdoc_isdelim(const char *); 141 142 __END_DECLS 143 144 #endif /*!LIBMDOC_H*/ 145