1*a40ea1a7SYuri Pankov /* $Id: roff.h,v 1.40 2017/02/16 03:00:23 schwarze Exp $ */ 2371584c2SYuri Pankov /* 3371584c2SYuri Pankov * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv> 4*a40ea1a7SYuri Pankov * Copyright (c) 2013, 2014, 2015, 2017 Ingo Schwarze <schwarze@openbsd.org> 5371584c2SYuri Pankov * 6371584c2SYuri Pankov * Permission to use, copy, modify, and distribute this software for any 7371584c2SYuri Pankov * purpose with or without fee is hereby granted, provided that the above 8371584c2SYuri Pankov * copyright notice and this permission notice appear in all copies. 9371584c2SYuri Pankov * 10371584c2SYuri Pankov * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES 11371584c2SYuri Pankov * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 12371584c2SYuri Pankov * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR 13371584c2SYuri Pankov * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 14371584c2SYuri Pankov * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 15371584c2SYuri Pankov * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 16371584c2SYuri Pankov * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 17371584c2SYuri Pankov */ 18371584c2SYuri Pankov 19371584c2SYuri Pankov struct mdoc_arg; 20371584c2SYuri Pankov union mdoc_data; 21371584c2SYuri Pankov 22371584c2SYuri Pankov enum roff_macroset { 23371584c2SYuri Pankov MACROSET_NONE = 0, 24371584c2SYuri Pankov MACROSET_MDOC, 25371584c2SYuri Pankov MACROSET_MAN 26371584c2SYuri Pankov }; 27371584c2SYuri Pankov 28371584c2SYuri Pankov enum roff_sec { 29371584c2SYuri Pankov SEC_NONE = 0, 30371584c2SYuri Pankov SEC_NAME, 31371584c2SYuri Pankov SEC_LIBRARY, 32371584c2SYuri Pankov SEC_SYNOPSIS, 33371584c2SYuri Pankov SEC_DESCRIPTION, 34371584c2SYuri Pankov SEC_CONTEXT, 35371584c2SYuri Pankov SEC_IMPLEMENTATION, /* IMPLEMENTATION NOTES */ 36371584c2SYuri Pankov SEC_RETURN_VALUES, 37371584c2SYuri Pankov SEC_ENVIRONMENT, 38371584c2SYuri Pankov SEC_FILES, 39371584c2SYuri Pankov SEC_EXIT_STATUS, 40371584c2SYuri Pankov SEC_EXAMPLES, 41371584c2SYuri Pankov SEC_DIAGNOSTICS, 42371584c2SYuri Pankov SEC_COMPATIBILITY, 43371584c2SYuri Pankov SEC_ERRORS, 44371584c2SYuri Pankov SEC_SEE_ALSO, 45371584c2SYuri Pankov SEC_STANDARDS, 46371584c2SYuri Pankov SEC_HISTORY, 47371584c2SYuri Pankov SEC_AUTHORS, 48371584c2SYuri Pankov SEC_CAVEATS, 49371584c2SYuri Pankov SEC_BUGS, 50371584c2SYuri Pankov SEC_SECURITY, 51371584c2SYuri Pankov SEC_CUSTOM, 52371584c2SYuri Pankov SEC__MAX 53371584c2SYuri Pankov }; 54371584c2SYuri Pankov 55371584c2SYuri Pankov enum roff_type { 56371584c2SYuri Pankov ROFFT_ROOT, 57371584c2SYuri Pankov ROFFT_BLOCK, 58371584c2SYuri Pankov ROFFT_HEAD, 59371584c2SYuri Pankov ROFFT_BODY, 60371584c2SYuri Pankov ROFFT_TAIL, 61371584c2SYuri Pankov ROFFT_ELEM, 62371584c2SYuri Pankov ROFFT_TEXT, 63371584c2SYuri Pankov ROFFT_TBL, 64371584c2SYuri Pankov ROFFT_EQN 65371584c2SYuri Pankov }; 66371584c2SYuri Pankov 67371584c2SYuri Pankov enum roff_next { 68371584c2SYuri Pankov ROFF_NEXT_SIBLING = 0, 69371584c2SYuri Pankov ROFF_NEXT_CHILD 70371584c2SYuri Pankov }; 71371584c2SYuri Pankov 72371584c2SYuri Pankov /* 73371584c2SYuri Pankov * Indicates that a BODY's formatting has ended, but 74371584c2SYuri Pankov * the scope is still open. Used for badly nested blocks. 75371584c2SYuri Pankov */ 76371584c2SYuri Pankov enum mdoc_endbody { 77371584c2SYuri Pankov ENDBODY_NOT = 0, 78*a40ea1a7SYuri Pankov ENDBODY_SPACE /* Is broken: append a space. */ 79371584c2SYuri Pankov }; 80371584c2SYuri Pankov 81371584c2SYuri Pankov struct roff_node { 82371584c2SYuri Pankov struct roff_node *parent; /* Parent AST node. */ 83371584c2SYuri Pankov struct roff_node *child; /* First child AST node. */ 84371584c2SYuri Pankov struct roff_node *last; /* Last child AST node. */ 85371584c2SYuri Pankov struct roff_node *next; /* Sibling AST node. */ 86371584c2SYuri Pankov struct roff_node *prev; /* Prior sibling AST node. */ 87371584c2SYuri Pankov struct roff_node *head; /* BLOCK */ 88371584c2SYuri Pankov struct roff_node *body; /* BLOCK/ENDBODY */ 89371584c2SYuri Pankov struct roff_node *tail; /* BLOCK */ 90371584c2SYuri Pankov struct mdoc_arg *args; /* BLOCK/ELEM */ 91371584c2SYuri Pankov union mdoc_data *norm; /* Normalized arguments. */ 92371584c2SYuri Pankov char *string; /* TEXT */ 93371584c2SYuri Pankov const struct tbl_span *span; /* TBL */ 94371584c2SYuri Pankov const struct eqn *eqn; /* EQN */ 95371584c2SYuri Pankov int line; /* Input file line number. */ 96371584c2SYuri Pankov int pos; /* Input file column number. */ 97371584c2SYuri Pankov int tok; /* Request or macro ID. */ 98371584c2SYuri Pankov #define TOKEN_NONE (-1) /* No request or macro. */ 99371584c2SYuri Pankov int flags; 100*a40ea1a7SYuri Pankov #define NODE_VALID (1 << 0) /* Has been validated. */ 101*a40ea1a7SYuri Pankov #define NODE_ENDED (1 << 1) /* Gone past body end mark. */ 102*a40ea1a7SYuri Pankov #define NODE_EOS (1 << 2) /* At sentence boundary. */ 103*a40ea1a7SYuri Pankov #define NODE_LINE (1 << 3) /* First macro/text on line. */ 104*a40ea1a7SYuri Pankov #define NODE_SYNPRETTY (1 << 4) /* SYNOPSIS-style formatting. */ 105*a40ea1a7SYuri Pankov #define NODE_BROKEN (1 << 5) /* Must validate parent when ending. */ 106*a40ea1a7SYuri Pankov #define NODE_DELIMO (1 << 6) 107*a40ea1a7SYuri Pankov #define NODE_DELIMC (1 << 7) 108*a40ea1a7SYuri Pankov #define NODE_NOSRC (1 << 8) /* Generated node, not in input file. */ 109*a40ea1a7SYuri Pankov #define NODE_NOPRT (1 << 9) /* Shall not print anything. */ 110371584c2SYuri Pankov int prev_font; /* Before entering this node. */ 111371584c2SYuri Pankov int aux; /* Decoded node data, type-dependent. */ 112371584c2SYuri Pankov enum roff_type type; /* AST node type. */ 113371584c2SYuri Pankov enum roff_sec sec; /* Current named section. */ 114371584c2SYuri Pankov enum mdoc_endbody end; /* BODY */ 115371584c2SYuri Pankov }; 116371584c2SYuri Pankov 117371584c2SYuri Pankov struct roff_meta { 118371584c2SYuri Pankov char *msec; /* Manual section, usually a digit. */ 119371584c2SYuri Pankov char *vol; /* Manual volume title. */ 120371584c2SYuri Pankov char *os; /* Operating system. */ 121371584c2SYuri Pankov char *arch; /* Machine architecture. */ 122371584c2SYuri Pankov char *title; /* Manual title, usually CAPS. */ 123371584c2SYuri Pankov char *name; /* Leading manual name. */ 124371584c2SYuri Pankov char *date; /* Normalized date. */ 125371584c2SYuri Pankov int hasbody; /* Document is not empty. */ 126371584c2SYuri Pankov }; 127371584c2SYuri Pankov 128371584c2SYuri Pankov struct roff_man { 129371584c2SYuri Pankov struct roff_meta meta; /* Document meta-data. */ 130371584c2SYuri Pankov struct mparse *parse; /* Parse pointer. */ 131371584c2SYuri Pankov struct roff *roff; /* Roff parser state data. */ 132371584c2SYuri Pankov const char *defos; /* Default operating system. */ 133371584c2SYuri Pankov struct roff_node *first; /* The first node parsed. */ 134371584c2SYuri Pankov struct roff_node *last; /* The last node parsed. */ 135371584c2SYuri Pankov struct roff_node *last_es; /* The most recent Es node. */ 136371584c2SYuri Pankov int quick; /* Abort parse early. */ 137371584c2SYuri Pankov int flags; /* Parse flags. */ 138371584c2SYuri Pankov #define MDOC_LITERAL (1 << 1) /* In a literal scope. */ 139371584c2SYuri Pankov #define MDOC_PBODY (1 << 2) /* In the document body. */ 140371584c2SYuri Pankov #define MDOC_NEWLINE (1 << 3) /* First macro/text in a line. */ 141371584c2SYuri Pankov #define MDOC_PHRASE (1 << 4) /* In a Bl -column phrase. */ 142371584c2SYuri Pankov #define MDOC_PHRASELIT (1 << 5) /* Literal within a phrase. */ 143371584c2SYuri Pankov #define MDOC_FREECOL (1 << 6) /* `It' invocation should close. */ 144371584c2SYuri Pankov #define MDOC_SYNOPSIS (1 << 7) /* SYNOPSIS-style formatting. */ 145371584c2SYuri Pankov #define MDOC_KEEP (1 << 8) /* In a word keep. */ 146371584c2SYuri Pankov #define MDOC_SMOFF (1 << 9) /* Spacing is off. */ 147371584c2SYuri Pankov #define MDOC_NODELIMC (1 << 10) /* Disable closing delimiter handling. */ 148371584c2SYuri Pankov #define MAN_ELINE (1 << 11) /* Next-line element scope. */ 149371584c2SYuri Pankov #define MAN_BLINE (1 << 12) /* Next-line block scope. */ 150371584c2SYuri Pankov #define MDOC_PHRASEQF (1 << 13) /* Quote first word encountered. */ 151371584c2SYuri Pankov #define MDOC_PHRASEQL (1 << 14) /* Quote last word of this phrase. */ 152371584c2SYuri Pankov #define MDOC_PHRASEQN (1 << 15) /* Quote first word of the next phrase. */ 153371584c2SYuri Pankov #define MAN_LITERAL MDOC_LITERAL 154371584c2SYuri Pankov #define MAN_NEWLINE MDOC_NEWLINE 155371584c2SYuri Pankov enum roff_macroset macroset; /* Kind of high-level macros used. */ 156371584c2SYuri Pankov enum roff_sec lastsec; /* Last section seen. */ 157371584c2SYuri Pankov enum roff_sec lastnamed; /* Last standard section seen. */ 158371584c2SYuri Pankov enum roff_next next; /* Where to put the next node. */ 159371584c2SYuri Pankov }; 160371584c2SYuri Pankov 161371584c2SYuri Pankov 162371584c2SYuri Pankov void deroff(char **, const struct roff_node *); 163