libmdoc.h revision 256281
168651Skris/* $Id: libmdoc.h,v 1.78 2011/12/02 01:37:14 schwarze Exp $ */ 268651Skris/* 368651Skris * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv> 468651Skris * 572613Skris * Permission to use, copy, modify, and distribute this software for any 668651Skris * purpose with or without fee is hereby granted, provided that the above 768651Skris * copyright notice and this permission notice appear in all copies. 868651Skris * 968651Skris * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 1068651Skris * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 1168651Skris * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 1268651Skris * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 1368651Skris * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 1468651Skris * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 1568651Skris * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 1668651Skris */ 1768651Skris#ifndef LIBMDOC_H 1868651Skris#define LIBMDOC_H 1968651Skris 2068651Skrisenum mdoc_next { 2168651Skris MDOC_NEXT_SIBLING = 0, 2268651Skris MDOC_NEXT_CHILD 2368651Skris}; 2468651Skris 2568651Skrisstruct mdoc { 2668651Skris struct mparse *parse; /* parse pointer */ 2768651Skris int flags; /* parse flags */ 2868651Skris#define MDOC_HALT (1 << 0) /* error in parse: halt */ 2968651Skris#define MDOC_LITERAL (1 << 1) /* in a literal scope */ 3068651Skris#define MDOC_PBODY (1 << 2) /* in the document body */ 3168651Skris#define MDOC_NEWLINE (1 << 3) /* first macro/text in a line */ 3268651Skris#define MDOC_PHRASELIT (1 << 4) /* literal within a partila phrase */ 3368651Skris#define MDOC_PPHRASE (1 << 5) /* within a partial phrase */ 3468651Skris#define MDOC_FREECOL (1 << 6) /* `It' invocation should close */ 3568651Skris#define MDOC_SYNOPSIS (1 << 7) /* SYNOPSIS-style formatting */ 3668651Skris enum mdoc_next next; /* where to put the next node */ 3789837Skris struct mdoc_node *last; /* the last node parsed */ 3868651Skris struct mdoc_node *first; /* the first node parsed */ 3989837Skris struct mdoc_meta meta; /* document meta-data */ 4089837Skris enum mdoc_sec lastnamed; 4189837Skris enum mdoc_sec lastsec; 4289837Skris struct roff *roff; 4389837Skris}; 44290207Sjkim 4589837Skris#define MACRO_PROT_ARGS struct mdoc *m, \ 4689837Skris enum mdoct tok, \ 4789837Skris int line, \ 4889837Skris int ppos, \ 4989837Skris int *pos, \ 5089837Skris char *buf 5189837Skris 5289837Skrisstruct mdoc_macro { 5389837Skris int (*fp)(MACRO_PROT_ARGS); 5489837Skris int flags; 5589837Skris#define MDOC_CALLABLE (1 << 0) 5689837Skris#define MDOC_PARSED (1 << 1) 57269682Sjkim#define MDOC_EXPLICIT (1 << 2) 58269682Sjkim#define MDOC_PROLOGUE (1 << 3) 59269682Sjkim#define MDOC_IGNDELIM (1 << 4) 60269682Sjkim /* Reserved words in arguments treated as text. */ 6168651Skris}; 6268651Skris 6368651Skrisenum margserr { 6468651Skris ARGS_ERROR, 6568651Skris ARGS_EOLN, /* end-of-line */ 6668651Skris ARGS_WORD, /* normal word */ 6768651Skris ARGS_PUNCT, /* series of punctuation */ 6868651Skris ARGS_QWORD, /* quoted word */ 6972613Skris ARGS_PHRASE, /* Ta'd phrase (-column) */ 7089837Skris ARGS_PPHRASE, /* tabbed phrase (-column) */ 7189837Skris ARGS_PEND /* last phrase (-column) */ 7268651Skris}; 7368651Skris 7468651Skrisenum margverr { 75 ARGV_ERROR, 76 ARGV_EOLN, /* end of line */ 77 ARGV_ARG, /* valid argument */ 78 ARGV_WORD /* normal word (or bad argument---same thing) */ 79}; 80 81/* 82 * A punctuation delimiter is opening, closing, or "middle mark" 83 * punctuation. These govern spacing. 84 * Opening punctuation (e.g., the opening parenthesis) suppresses the 85 * following space; closing punctuation (e.g., the closing parenthesis) 86 * suppresses the leading space; middle punctuation (e.g., the vertical 87 * bar) can do either. The middle punctuation delimiter bends the rules 88 * depending on usage. 89 */ 90enum mdelim { 91 DELIM_NONE = 0, 92 DELIM_OPEN, 93 DELIM_MIDDLE, 94 DELIM_CLOSE, 95 DELIM_MAX 96}; 97 98extern const struct mdoc_macro *const mdoc_macros; 99 100__BEGIN_DECLS 101 102#define mdoc_pmsg(m, l, p, t) \ 103 mandoc_msg((t), (m)->parse, (l), (p), NULL) 104#define mdoc_nmsg(m, n, t) \ 105 mandoc_msg((t), (m)->parse, (n)->line, (n)->pos, NULL) 106int mdoc_macro(MACRO_PROT_ARGS); 107int mdoc_word_alloc(struct mdoc *, 108 int, int, const char *); 109int mdoc_elem_alloc(struct mdoc *, int, int, 110 enum mdoct, struct mdoc_arg *); 111int mdoc_block_alloc(struct mdoc *, int, int, 112 enum mdoct, struct mdoc_arg *); 113int mdoc_head_alloc(struct mdoc *, int, int, enum mdoct); 114int mdoc_tail_alloc(struct mdoc *, int, int, enum mdoct); 115int mdoc_body_alloc(struct mdoc *, int, int, enum mdoct); 116int mdoc_endbody_alloc(struct mdoc *m, int line, int pos, 117 enum mdoct tok, struct mdoc_node *body, 118 enum mdoc_endbody end); 119void mdoc_node_delete(struct mdoc *, struct mdoc_node *); 120void mdoc_hash_init(void); 121enum mdoct mdoc_hash_find(const char *); 122const char *mdoc_a2att(const char *); 123const char *mdoc_a2lib(const char *); 124const char *mdoc_a2st(const char *); 125const char *mdoc_a2arch(const char *); 126const char *mdoc_a2vol(const char *); 127int mdoc_valid_pre(struct mdoc *, struct mdoc_node *); 128int mdoc_valid_post(struct mdoc *); 129enum margverr mdoc_argv(struct mdoc *, int, enum mdoct, 130 struct mdoc_arg **, int *, char *); 131void mdoc_argv_free(struct mdoc_arg *); 132enum margserr mdoc_args(struct mdoc *, int, 133 int *, char *, enum mdoct, char **); 134enum margserr mdoc_zargs(struct mdoc *, int, 135 int *, char *, char **); 136int mdoc_macroend(struct mdoc *); 137enum mdelim mdoc_isdelim(const char *); 138 139__END_DECLS 140 141#endif /*!LIBMDOC_H*/ 142