1*4d131170SRobert Mustacchi /* $OpenBSD: roff_int.h,v 1.16 2019/01/05 00:36:46 schwarze Exp $ */ 2371584c2SYuri Pankov /* 3*4d131170SRobert Mustacchi * Copyright (c) 2013-2015, 2017-2020 Ingo Schwarze <schwarze@openbsd.org> 4371584c2SYuri Pankov * Copyright (c) 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv> 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. 17cec8643bSMichal Nowak * 18cec8643bSMichal Nowak * Parser internals shared by multiple parsers. 19371584c2SYuri Pankov */ 20371584c2SYuri Pankov 21cec8643bSMichal Nowak struct ohash; 22cec8643bSMichal Nowak struct roff_node; 23cec8643bSMichal Nowak struct roff_meta; 24cec8643bSMichal Nowak struct roff; 25cec8643bSMichal Nowak struct mdoc_arg; 26cec8643bSMichal Nowak 27cec8643bSMichal Nowak enum roff_next { 28cec8643bSMichal Nowak ROFF_NEXT_SIBLING = 0, 29cec8643bSMichal Nowak ROFF_NEXT_CHILD 30cec8643bSMichal Nowak }; 31cec8643bSMichal Nowak 32cec8643bSMichal Nowak struct roff_man { 33cec8643bSMichal Nowak struct roff_meta meta; /* Public parse results. */ 34cec8643bSMichal Nowak struct roff *roff; /* Roff parser state data. */ 35cec8643bSMichal Nowak struct ohash *mdocmac; /* Mdoc macro lookup table. */ 36cec8643bSMichal Nowak struct ohash *manmac; /* Man macro lookup table. */ 37cec8643bSMichal Nowak const char *os_s; /* Default operating system. */ 38cec8643bSMichal Nowak struct roff_node *last; /* The last node parsed. */ 39cec8643bSMichal Nowak struct roff_node *last_es; /* The most recent Es node. */ 40cec8643bSMichal Nowak int quick; /* Abort parse early. */ 41cec8643bSMichal Nowak int flags; /* Parse flags. */ 42cec8643bSMichal Nowak #define ROFF_NOFILL (1 << 1) /* Fill mode switched off. */ 43cec8643bSMichal Nowak #define MDOC_PBODY (1 << 2) /* In the document body. */ 44cec8643bSMichal Nowak #define MDOC_NEWLINE (1 << 3) /* First macro/text in a line. */ 45cec8643bSMichal Nowak #define MDOC_PHRASE (1 << 4) /* In a Bl -column phrase. */ 46cec8643bSMichal Nowak #define MDOC_PHRASELIT (1 << 5) /* Literal within a phrase. */ 47cec8643bSMichal Nowak #define MDOC_FREECOL (1 << 6) /* `It' invocation should close. */ 48cec8643bSMichal Nowak #define MDOC_SYNOPSIS (1 << 7) /* SYNOPSIS-style formatting. */ 49cec8643bSMichal Nowak #define MDOC_KEEP (1 << 8) /* In a word keep. */ 50cec8643bSMichal Nowak #define MDOC_SMOFF (1 << 9) /* Spacing is off. */ 51cec8643bSMichal Nowak #define MDOC_NODELIMC (1 << 10) /* Disable closing delimiter handling. */ 52cec8643bSMichal Nowak #define MAN_ELINE (1 << 11) /* Next-line element scope. */ 53cec8643bSMichal Nowak #define MAN_BLINE (1 << 12) /* Next-line block scope. */ 54cec8643bSMichal Nowak #define MDOC_PHRASEQF (1 << 13) /* Quote first word encountered. */ 55cec8643bSMichal Nowak #define MDOC_PHRASEQL (1 << 14) /* Quote last word of this phrase. */ 56cec8643bSMichal Nowak #define MDOC_PHRASEQN (1 << 15) /* Quote first word of the next phrase. */ 57cec8643bSMichal Nowak #define ROFF_NONOFILL (1 << 16) /* Temporarily suspend no-fill mode. */ 58cec8643bSMichal Nowak #define MAN_NEWLINE MDOC_NEWLINE 59cec8643bSMichal Nowak enum roff_sec lastsec; /* Last section seen. */ 60cec8643bSMichal Nowak enum roff_sec lastnamed; /* Last standard section seen. */ 61cec8643bSMichal Nowak enum roff_next next; /* Where to put the next node. */ 62*4d131170SRobert Mustacchi char filesec; /* Section digit in the file name. */ 63cec8643bSMichal Nowak }; 64cec8643bSMichal Nowak 65cec8643bSMichal Nowak 66371584c2SYuri Pankov struct roff_node *roff_node_alloc(struct roff_man *, int, int, 67371584c2SYuri Pankov enum roff_type, int); 68371584c2SYuri Pankov void roff_node_append(struct roff_man *, struct roff_node *); 69371584c2SYuri Pankov void roff_word_alloc(struct roff_man *, int, int, const char *); 70371584c2SYuri Pankov void roff_word_append(struct roff_man *, const char *); 71371584c2SYuri Pankov void roff_elem_alloc(struct roff_man *, int, int, int); 72371584c2SYuri Pankov struct roff_node *roff_block_alloc(struct roff_man *, int, int, int); 73371584c2SYuri Pankov struct roff_node *roff_head_alloc(struct roff_man *, int, int, int); 74371584c2SYuri Pankov struct roff_node *roff_body_alloc(struct roff_man *, int, int, int); 75371584c2SYuri Pankov void roff_node_unlink(struct roff_man *, struct roff_node *); 76cec8643bSMichal Nowak void roff_node_relink(struct roff_man *, struct roff_node *); 77371584c2SYuri Pankov void roff_node_free(struct roff_node *); 78371584c2SYuri Pankov void roff_node_delete(struct roff_man *, struct roff_node *); 79371584c2SYuri Pankov 80cec8643bSMichal Nowak struct ohash *roffhash_alloc(enum roff_tok, enum roff_tok); 81cec8643bSMichal Nowak enum roff_tok roffhash_find(struct ohash *, const char *, size_t); 82cec8643bSMichal Nowak void roffhash_free(struct ohash *); 83cec8643bSMichal Nowak 84cec8643bSMichal Nowak void roff_state_reset(struct roff_man *); 85cec8643bSMichal Nowak void roff_validate(struct roff_man *); 86cec8643bSMichal Nowak 87371584c2SYuri Pankov /* 88371584c2SYuri Pankov * Functions called from roff.c need to be declared here, 89371584c2SYuri Pankov * not in libmdoc.h or libman.h, even if they are specific 90371584c2SYuri Pankov * to either the mdoc(7) or the man(7) parser. 91371584c2SYuri Pankov */ 92371584c2SYuri Pankov 93371584c2SYuri Pankov void man_breakscope(struct roff_man *, int); 94371584c2SYuri Pankov void mdoc_argv_free(struct mdoc_arg *); 95