1*61d06d6bSBaptiste Daroussin /* $Id: libmdoc.h,v 1.112 2017/05/30 16:22:03 schwarze Exp $ */ 2*61d06d6bSBaptiste Daroussin /* 3*61d06d6bSBaptiste Daroussin * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv> 4*61d06d6bSBaptiste Daroussin * Copyright (c) 2013, 2014, 2015, 2017 Ingo Schwarze <schwarze@openbsd.org> 5*61d06d6bSBaptiste Daroussin * 6*61d06d6bSBaptiste Daroussin * Permission to use, copy, modify, and distribute this software for any 7*61d06d6bSBaptiste Daroussin * purpose with or without fee is hereby granted, provided that the above 8*61d06d6bSBaptiste Daroussin * copyright notice and this permission notice appear in all copies. 9*61d06d6bSBaptiste Daroussin * 10*61d06d6bSBaptiste Daroussin * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES 11*61d06d6bSBaptiste Daroussin * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 12*61d06d6bSBaptiste Daroussin * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR 13*61d06d6bSBaptiste Daroussin * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 14*61d06d6bSBaptiste Daroussin * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 15*61d06d6bSBaptiste Daroussin * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 16*61d06d6bSBaptiste Daroussin * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 17*61d06d6bSBaptiste Daroussin */ 18*61d06d6bSBaptiste Daroussin 19*61d06d6bSBaptiste Daroussin #define MACRO_PROT_ARGS struct roff_man *mdoc, \ 20*61d06d6bSBaptiste Daroussin enum roff_tok tok, \ 21*61d06d6bSBaptiste Daroussin int line, \ 22*61d06d6bSBaptiste Daroussin int ppos, \ 23*61d06d6bSBaptiste Daroussin int *pos, \ 24*61d06d6bSBaptiste Daroussin char *buf 25*61d06d6bSBaptiste Daroussin 26*61d06d6bSBaptiste Daroussin struct mdoc_macro { 27*61d06d6bSBaptiste Daroussin void (*fp)(MACRO_PROT_ARGS); 28*61d06d6bSBaptiste Daroussin int flags; 29*61d06d6bSBaptiste Daroussin #define MDOC_CALLABLE (1 << 0) 30*61d06d6bSBaptiste Daroussin #define MDOC_PARSED (1 << 1) 31*61d06d6bSBaptiste Daroussin #define MDOC_EXPLICIT (1 << 2) 32*61d06d6bSBaptiste Daroussin #define MDOC_PROLOGUE (1 << 3) 33*61d06d6bSBaptiste Daroussin #define MDOC_IGNDELIM (1 << 4) 34*61d06d6bSBaptiste Daroussin #define MDOC_JOIN (1 << 5) 35*61d06d6bSBaptiste Daroussin }; 36*61d06d6bSBaptiste Daroussin 37*61d06d6bSBaptiste Daroussin enum margserr { 38*61d06d6bSBaptiste Daroussin ARGS_ERROR, 39*61d06d6bSBaptiste Daroussin ARGS_EOLN, /* end-of-line */ 40*61d06d6bSBaptiste Daroussin ARGS_WORD, /* normal word */ 41*61d06d6bSBaptiste Daroussin ARGS_PUNCT, /* series of punctuation */ 42*61d06d6bSBaptiste Daroussin ARGS_PHRASE /* Bl -column phrase */ 43*61d06d6bSBaptiste Daroussin }; 44*61d06d6bSBaptiste Daroussin 45*61d06d6bSBaptiste Daroussin /* 46*61d06d6bSBaptiste Daroussin * A punctuation delimiter is opening, closing, or "middle mark" 47*61d06d6bSBaptiste Daroussin * punctuation. These govern spacing. 48*61d06d6bSBaptiste Daroussin * Opening punctuation (e.g., the opening parenthesis) suppresses the 49*61d06d6bSBaptiste Daroussin * following space; closing punctuation (e.g., the closing parenthesis) 50*61d06d6bSBaptiste Daroussin * suppresses the leading space; middle punctuation (e.g., the vertical 51*61d06d6bSBaptiste Daroussin * bar) can do either. The middle punctuation delimiter bends the rules 52*61d06d6bSBaptiste Daroussin * depending on usage. 53*61d06d6bSBaptiste Daroussin */ 54*61d06d6bSBaptiste Daroussin enum mdelim { 55*61d06d6bSBaptiste Daroussin DELIM_NONE = 0, 56*61d06d6bSBaptiste Daroussin DELIM_OPEN, 57*61d06d6bSBaptiste Daroussin DELIM_MIDDLE, 58*61d06d6bSBaptiste Daroussin DELIM_CLOSE, 59*61d06d6bSBaptiste Daroussin DELIM_MAX 60*61d06d6bSBaptiste Daroussin }; 61*61d06d6bSBaptiste Daroussin 62*61d06d6bSBaptiste Daroussin extern const struct mdoc_macro *const mdoc_macros; 63*61d06d6bSBaptiste Daroussin 64*61d06d6bSBaptiste Daroussin 65*61d06d6bSBaptiste Daroussin void mdoc_macro(MACRO_PROT_ARGS); 66*61d06d6bSBaptiste Daroussin void mdoc_elem_alloc(struct roff_man *, int, int, 67*61d06d6bSBaptiste Daroussin enum roff_tok, struct mdoc_arg *); 68*61d06d6bSBaptiste Daroussin struct roff_node *mdoc_block_alloc(struct roff_man *, int, int, 69*61d06d6bSBaptiste Daroussin enum roff_tok, struct mdoc_arg *); 70*61d06d6bSBaptiste Daroussin void mdoc_tail_alloc(struct roff_man *, int, int, 71*61d06d6bSBaptiste Daroussin enum roff_tok); 72*61d06d6bSBaptiste Daroussin struct roff_node *mdoc_endbody_alloc(struct roff_man *, int, int, 73*61d06d6bSBaptiste Daroussin enum roff_tok, struct roff_node *); 74*61d06d6bSBaptiste Daroussin void mdoc_node_relink(struct roff_man *, struct roff_node *); 75*61d06d6bSBaptiste Daroussin void mdoc_node_validate(struct roff_man *); 76*61d06d6bSBaptiste Daroussin void mdoc_state(struct roff_man *, struct roff_node *); 77*61d06d6bSBaptiste Daroussin void mdoc_state_reset(struct roff_man *); 78*61d06d6bSBaptiste Daroussin const char *mdoc_a2arch(const char *); 79*61d06d6bSBaptiste Daroussin const char *mdoc_a2att(const char *); 80*61d06d6bSBaptiste Daroussin const char *mdoc_a2lib(const char *); 81*61d06d6bSBaptiste Daroussin enum roff_sec mdoc_a2sec(const char *); 82*61d06d6bSBaptiste Daroussin const char *mdoc_a2st(const char *); 83*61d06d6bSBaptiste Daroussin void mdoc_argv(struct roff_man *, int, enum roff_tok, 84*61d06d6bSBaptiste Daroussin struct mdoc_arg **, int *, char *); 85*61d06d6bSBaptiste Daroussin enum margserr mdoc_args(struct roff_man *, int, 86*61d06d6bSBaptiste Daroussin int *, char *, enum roff_tok, char **); 87*61d06d6bSBaptiste Daroussin enum mdelim mdoc_isdelim(const char *); 88