1 /* $Id: roff.h,v 1.59 2018/04/11 17:11:13 schwarze Exp $ */
3 * Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv>
4 * Copyright (c) 2013, 2014, 2015, 2017 Ingo Schwarze <schwarze@openbsd.org>
6 * Permission to use, copy, modify, and distribute this software for any
7 * purpose with or without fee is hereby granted, provided that the above
8 * copyright notice and this permission notice appear in all copies.
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
36 SEC_IMPLEMENTATION, /* IMPLEMENTATION NOTES */
159 /* MAN_fi; ignored in mdoc(7) */
189 /* MAN_in; ignored in mdoc(7) */
219 /* MAN_nf; ignored in mdoc(7) */
477 ROFF_NEXT_SIBLING = 0,
482 * Indicates that a BODY's formatting has ended, but
483 * the scope is still open. Used for badly nested blocks.
487 ENDBODY_SPACE /* Is broken: append a space. */
491 struct roff_node *parent; /* Parent AST node. */
492 struct roff_node *child; /* First child AST node. */
493 struct roff_node *last; /* Last child AST node. */
494 struct roff_node *next; /* Sibling AST node. */
495 struct roff_node *prev; /* Prior sibling AST node. */
496 struct roff_node *head; /* BLOCK */
497 struct roff_node *body; /* BLOCK/ENDBODY */
498 struct roff_node *tail; /* BLOCK */
499 struct mdoc_arg *args; /* BLOCK/ELEM */
500 union mdoc_data *norm; /* Normalized arguments. */
501 char *string; /* TEXT */
502 const struct tbl_span *span; /* TBL */
503 struct eqn_box *eqn; /* EQN */
504 int line; /* Input file line number. */
505 int pos; /* Input file column number. */
507 #define NODE_VALID (1 << 0) /* Has been validated. */
508 #define NODE_ENDED (1 << 1) /* Gone past body end mark. */
509 #define NODE_EOS (1 << 2) /* At sentence boundary. */
510 #define NODE_LINE (1 << 3) /* First macro/text on line. */
511 #define NODE_SYNPRETTY (1 << 4) /* SYNOPSIS-style formatting. */
512 #define NODE_BROKEN (1 << 5) /* Must validate parent when ending. */
513 #define NODE_DELIMO (1 << 6)
514 #define NODE_DELIMC (1 << 7)
515 #define NODE_NOSRC (1 << 8) /* Generated node, not in input file. */
516 #define NODE_NOPRT (1 << 9) /* Shall not print anything. */
517 int prev_font; /* Before entering this node. */
518 int aux; /* Decoded node data, type-dependent. */
519 enum roff_tok tok; /* Request or macro ID. */
520 enum roff_type type; /* AST node type. */
521 enum roff_sec sec; /* Current named section. */
522 enum mdoc_endbody end; /* BODY */
526 char *msec; /* Manual section, usually a digit. */
527 char *vol; /* Manual volume title. */
528 char *os; /* Operating system. */
529 char *arch; /* Machine architecture. */
530 char *title; /* Manual title, usually CAPS. */
531 char *name; /* Leading manual name. */
532 char *date; /* Normalized date. */
533 int hasbody; /* Document is not empty. */
534 int rcsids; /* Bits indexed by enum mandoc_os. */
535 enum mandoc_os os_e; /* Operating system. */
539 struct roff_meta meta; /* Document meta-data. */
540 struct mparse *parse; /* Parse pointer. */
541 struct roff *roff; /* Roff parser state data. */
542 struct ohash *mdocmac; /* Mdoc macro lookup table. */
543 struct ohash *manmac; /* Man macro lookup table. */
544 const char *os_s; /* Default operating system. */
545 struct roff_node *first; /* The first node parsed. */
546 struct roff_node *last; /* The last node parsed. */
547 struct roff_node *last_es; /* The most recent Es node. */
548 int quick; /* Abort parse early. */
549 int flags; /* Parse flags. */
550 #define MDOC_LITERAL (1 << 1) /* In a literal scope. */
551 #define MDOC_PBODY (1 << 2) /* In the document body. */
552 #define MDOC_NEWLINE (1 << 3) /* First macro/text in a line. */
553 #define MDOC_PHRASE (1 << 4) /* In a Bl -column phrase. */
554 #define MDOC_PHRASELIT (1 << 5) /* Literal within a phrase. */
555 #define MDOC_FREECOL (1 << 6) /* `It' invocation should close. */
556 #define MDOC_SYNOPSIS (1 << 7) /* SYNOPSIS-style formatting. */
557 #define MDOC_KEEP (1 << 8) /* In a word keep. */
558 #define MDOC_SMOFF (1 << 9) /* Spacing is off. */
559 #define MDOC_NODELIMC (1 << 10) /* Disable closing delimiter handling. */
560 #define MAN_ELINE (1 << 11) /* Next-line element scope. */
561 #define MAN_BLINE (1 << 12) /* Next-line block scope. */
562 #define MDOC_PHRASEQF (1 << 13) /* Quote first word encountered. */
563 #define MDOC_PHRASEQL (1 << 14) /* Quote last word of this phrase. */
564 #define MDOC_PHRASEQN (1 << 15) /* Quote first word of the next phrase. */
565 #define MAN_LITERAL MDOC_LITERAL
566 #define MAN_NEWLINE MDOC_NEWLINE
567 enum roff_macroset macroset; /* Kind of high-level macros used. */
568 enum roff_sec lastsec; /* Last section seen. */
569 enum roff_sec lastnamed; /* Last standard section seen. */
570 enum roff_next next; /* Where to put the next node. */
573 extern const char *const *roff_name;
576 void deroff(char **, const struct roff_node *);
577 struct ohash *roffhash_alloc(enum roff_tok, enum roff_tok);
578 enum roff_tok roffhash_find(struct ohash *, const char *, size_t);
579 void roffhash_free(struct ohash *);
580 void roff_validate(struct roff_man *);