1241675Suqs/* $Id: libmdoc.h,v 1.78 2011/12/02 01:37:14 schwarze Exp $ */ 2241675Suqs/* 3241675Suqs * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv> 4241675Suqs * 5241675Suqs * Permission to use, copy, modify, and distribute this software for any 6241675Suqs * purpose with or without fee is hereby granted, provided that the above 7241675Suqs * copyright notice and this permission notice appear in all copies. 8241675Suqs * 9241675Suqs * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 10241675Suqs * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 11241675Suqs * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 12241675Suqs * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 13241675Suqs * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 14241675Suqs * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 15241675Suqs * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 16241675Suqs */ 17241675Suqs#ifndef LIBMDOC_H 18241675Suqs#define LIBMDOC_H 19241675Suqs 20241675Suqsenum mdoc_next { 21241675Suqs MDOC_NEXT_SIBLING = 0, 22241675Suqs MDOC_NEXT_CHILD 23241675Suqs}; 24241675Suqs 25241675Suqsstruct mdoc { 26241675Suqs struct mparse *parse; /* parse pointer */ 27241675Suqs int flags; /* parse flags */ 28241675Suqs#define MDOC_HALT (1 << 0) /* error in parse: halt */ 29241675Suqs#define MDOC_LITERAL (1 << 1) /* in a literal scope */ 30241675Suqs#define MDOC_PBODY (1 << 2) /* in the document body */ 31241675Suqs#define MDOC_NEWLINE (1 << 3) /* first macro/text in a line */ 32241675Suqs#define MDOC_PHRASELIT (1 << 4) /* literal within a partila phrase */ 33241675Suqs#define MDOC_PPHRASE (1 << 5) /* within a partial phrase */ 34241675Suqs#define MDOC_FREECOL (1 << 6) /* `It' invocation should close */ 35241675Suqs#define MDOC_SYNOPSIS (1 << 7) /* SYNOPSIS-style formatting */ 36241675Suqs enum mdoc_next next; /* where to put the next node */ 37241675Suqs struct mdoc_node *last; /* the last node parsed */ 38241675Suqs struct mdoc_node *first; /* the first node parsed */ 39241675Suqs struct mdoc_meta meta; /* document meta-data */ 40241675Suqs enum mdoc_sec lastnamed; 41241675Suqs enum mdoc_sec lastsec; 42241675Suqs struct roff *roff; 43241675Suqs}; 44241675Suqs 45241675Suqs#define MACRO_PROT_ARGS struct mdoc *m, \ 46241675Suqs enum mdoct tok, \ 47241675Suqs int line, \ 48241675Suqs int ppos, \ 49241675Suqs int *pos, \ 50241675Suqs char *buf 51241675Suqs 52241675Suqsstruct mdoc_macro { 53241675Suqs int (*fp)(MACRO_PROT_ARGS); 54241675Suqs int flags; 55241675Suqs#define MDOC_CALLABLE (1 << 0) 56241675Suqs#define MDOC_PARSED (1 << 1) 57241675Suqs#define MDOC_EXPLICIT (1 << 2) 58241675Suqs#define MDOC_PROLOGUE (1 << 3) 59241675Suqs#define MDOC_IGNDELIM (1 << 4) 60241675Suqs /* Reserved words in arguments treated as text. */ 61241675Suqs}; 62241675Suqs 63241675Suqsenum margserr { 64241675Suqs ARGS_ERROR, 65241675Suqs ARGS_EOLN, /* end-of-line */ 66241675Suqs ARGS_WORD, /* normal word */ 67241675Suqs ARGS_PUNCT, /* series of punctuation */ 68241675Suqs ARGS_QWORD, /* quoted word */ 69241675Suqs ARGS_PHRASE, /* Ta'd phrase (-column) */ 70241675Suqs ARGS_PPHRASE, /* tabbed phrase (-column) */ 71241675Suqs ARGS_PEND /* last phrase (-column) */ 72241675Suqs}; 73241675Suqs 74241675Suqsenum margverr { 75241675Suqs ARGV_ERROR, 76241675Suqs ARGV_EOLN, /* end of line */ 77241675Suqs ARGV_ARG, /* valid argument */ 78241675Suqs ARGV_WORD /* normal word (or bad argument---same thing) */ 79241675Suqs}; 80241675Suqs 81241675Suqs/* 82241675Suqs * A punctuation delimiter is opening, closing, or "middle mark" 83241675Suqs * punctuation. These govern spacing. 84241675Suqs * Opening punctuation (e.g., the opening parenthesis) suppresses the 85241675Suqs * following space; closing punctuation (e.g., the closing parenthesis) 86241675Suqs * suppresses the leading space; middle punctuation (e.g., the vertical 87241675Suqs * bar) can do either. The middle punctuation delimiter bends the rules 88241675Suqs * depending on usage. 89241675Suqs */ 90241675Suqsenum mdelim { 91241675Suqs DELIM_NONE = 0, 92241675Suqs DELIM_OPEN, 93241675Suqs DELIM_MIDDLE, 94241675Suqs DELIM_CLOSE, 95241675Suqs DELIM_MAX 96241675Suqs}; 97241675Suqs 98241675Suqsextern const struct mdoc_macro *const mdoc_macros; 99241675Suqs 100241675Suqs__BEGIN_DECLS 101241675Suqs 102241675Suqs#define mdoc_pmsg(m, l, p, t) \ 103241675Suqs mandoc_msg((t), (m)->parse, (l), (p), NULL) 104241675Suqs#define mdoc_nmsg(m, n, t) \ 105241675Suqs mandoc_msg((t), (m)->parse, (n)->line, (n)->pos, NULL) 106241675Suqsint mdoc_macro(MACRO_PROT_ARGS); 107241675Suqsint mdoc_word_alloc(struct mdoc *, 108241675Suqs int, int, const char *); 109241675Suqsint mdoc_elem_alloc(struct mdoc *, int, int, 110241675Suqs enum mdoct, struct mdoc_arg *); 111241675Suqsint mdoc_block_alloc(struct mdoc *, int, int, 112241675Suqs enum mdoct, struct mdoc_arg *); 113241675Suqsint mdoc_head_alloc(struct mdoc *, int, int, enum mdoct); 114241675Suqsint mdoc_tail_alloc(struct mdoc *, int, int, enum mdoct); 115241675Suqsint mdoc_body_alloc(struct mdoc *, int, int, enum mdoct); 116241675Suqsint mdoc_endbody_alloc(struct mdoc *m, int line, int pos, 117241675Suqs enum mdoct tok, struct mdoc_node *body, 118241675Suqs enum mdoc_endbody end); 119241675Suqsvoid mdoc_node_delete(struct mdoc *, struct mdoc_node *); 120241675Suqsvoid mdoc_hash_init(void); 121241675Suqsenum mdoct mdoc_hash_find(const char *); 122241675Suqsconst char *mdoc_a2att(const char *); 123241675Suqsconst char *mdoc_a2lib(const char *); 124241675Suqsconst char *mdoc_a2st(const char *); 125241675Suqsconst char *mdoc_a2arch(const char *); 126241675Suqsconst char *mdoc_a2vol(const char *); 127241675Suqsint mdoc_valid_pre(struct mdoc *, struct mdoc_node *); 128241675Suqsint mdoc_valid_post(struct mdoc *); 129241675Suqsenum margverr mdoc_argv(struct mdoc *, int, enum mdoct, 130241675Suqs struct mdoc_arg **, int *, char *); 131241675Suqsvoid mdoc_argv_free(struct mdoc_arg *); 132241675Suqsenum margserr mdoc_args(struct mdoc *, int, 133241675Suqs int *, char *, enum mdoct, char **); 134241675Suqsenum margserr mdoc_zargs(struct mdoc *, int, 135241675Suqs int *, char *, char **); 136241675Suqsint mdoc_macroend(struct mdoc *); 137241675Suqsenum mdelim mdoc_isdelim(const char *); 138241675Suqs 139241675Suqs__END_DECLS 140241675Suqs 141241675Suqs#endif /*!LIBMDOC_H*/ 142