version 1.25, 2011/03/20 16:02:05 |
version 1.37, 2016/01/08 17:48:10 |
|
|
/* $Id$ */ |
/* $OpenBSD$ */ |
/* |
/* |
* Copyright (c) 2010 Kristaps Dzonsons <kristaps@bsd.lv> |
* Copyright (c) 2008, 2009, 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv> |
|
* Copyright (c) 2013, 2014, 2015 Ingo Schwarze <schwarze@openbsd.org> |
* |
* |
* Permission to use, copy, modify, and distribute this software for any |
* Permission to use, copy, modify, and distribute this software for any |
* purpose with or without fee is hereby granted, provided that the above |
* purpose with or without fee is hereby granted, provided that the above |
* copyright notice and this permission notice appear in all copies. |
* copyright notice and this permission notice appear in all copies. |
* |
* |
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES |
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES |
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF |
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF |
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR |
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR |
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES |
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES |
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN |
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN |
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
*/ |
*/ |
#ifndef ROFF_H |
|
#define ROFF_H |
|
|
|
enum rofferr { |
struct mdoc_arg; |
ROFF_CONT, /* continue processing line */ |
union mdoc_data; |
ROFF_RERUN, /* re-run roff interpreter with offset */ |
|
ROFF_APPEND, /* re-run main parser, appending next line */ |
enum roff_macroset { |
ROFF_REPARSE, /* re-run main parser on the result */ |
MACROSET_NONE = 0, |
ROFF_SO, /* include another file */ |
MACROSET_MDOC, |
ROFF_IGN, /* ignore current line */ |
MACROSET_MAN |
ROFF_TBL, /* a table row was successfully parsed */ |
|
ROFF_EQN, /* an equation was successfully parsed */ |
|
ROFF_ERR /* badness: puke and stop */ |
|
}; |
}; |
|
|
__BEGIN_DECLS |
enum roff_sec { |
|
SEC_NONE = 0, |
|
SEC_NAME, |
|
SEC_LIBRARY, |
|
SEC_SYNOPSIS, |
|
SEC_DESCRIPTION, |
|
SEC_CONTEXT, |
|
SEC_IMPLEMENTATION, /* IMPLEMENTATION NOTES */ |
|
SEC_RETURN_VALUES, |
|
SEC_ENVIRONMENT, |
|
SEC_FILES, |
|
SEC_EXIT_STATUS, |
|
SEC_EXAMPLES, |
|
SEC_DIAGNOSTICS, |
|
SEC_COMPATIBILITY, |
|
SEC_ERRORS, |
|
SEC_SEE_ALSO, |
|
SEC_STANDARDS, |
|
SEC_HISTORY, |
|
SEC_AUTHORS, |
|
SEC_CAVEATS, |
|
SEC_BUGS, |
|
SEC_SECURITY, |
|
SEC_CUSTOM, |
|
SEC__MAX |
|
}; |
|
|
struct roff; |
enum roff_type { |
|
ROFFT_ROOT, |
|
ROFFT_BLOCK, |
|
ROFFT_HEAD, |
|
ROFFT_BODY, |
|
ROFFT_TAIL, |
|
ROFFT_ELEM, |
|
ROFFT_TEXT, |
|
ROFFT_TBL, |
|
ROFFT_EQN |
|
}; |
|
|
void roff_free(struct roff *); |
enum roff_next { |
struct roff *roff_alloc(struct regset *, struct mparse *); |
ROFF_NEXT_SIBLING = 0, |
void roff_reset(struct roff *); |
ROFF_NEXT_CHILD |
enum rofferr roff_parseln(struct roff *, int, |
}; |
char **, size_t *, int, int *); |
|
void roff_endparse(struct roff *); |
|
const struct tbl_span *roff_span(const struct roff *); |
|
const struct eqn *roff_eqn(const struct roff *); |
|
|
|
__END_DECLS |
/* |
|
* Indicates that a BODY's formatting has ended, but |
|
* the scope is still open. Used for badly nested blocks. |
|
*/ |
|
enum mdoc_endbody { |
|
ENDBODY_NOT = 0, |
|
ENDBODY_SPACE, /* Is broken: append a space. */ |
|
ENDBODY_NOSPACE /* Is broken: don't append a space. */ |
|
}; |
|
|
#endif /*!ROFF_H*/ |
struct roff_node { |
|
struct roff_node *parent; /* Parent AST node. */ |
|
struct roff_node *child; /* First child AST node. */ |
|
struct roff_node *last; /* Last child AST node. */ |
|
struct roff_node *next; /* Sibling AST node. */ |
|
struct roff_node *prev; /* Prior sibling AST node. */ |
|
struct roff_node *head; /* BLOCK */ |
|
struct roff_node *body; /* BLOCK/ENDBODY */ |
|
struct roff_node *tail; /* BLOCK */ |
|
struct mdoc_arg *args; /* BLOCK/ELEM */ |
|
union mdoc_data *norm; /* Normalized arguments. */ |
|
char *string; /* TEXT */ |
|
const struct tbl_span *span; /* TBL */ |
|
const struct eqn *eqn; /* EQN */ |
|
int line; /* Input file line number. */ |
|
int pos; /* Input file column number. */ |
|
int tok; /* Request or macro ID. */ |
|
#define TOKEN_NONE (-1) /* No request or macro. */ |
|
int flags; |
|
#define MDOC_VALID (1 << 0) /* Has been validated. */ |
|
#define MDOC_ENDED (1 << 1) /* Gone past body end mark. */ |
|
#define MDOC_EOS (1 << 2) /* At sentence boundary. */ |
|
#define MDOC_LINE (1 << 3) /* First macro/text on line. */ |
|
#define MDOC_SYNPRETTY (1 << 4) /* SYNOPSIS-style formatting. */ |
|
#define MDOC_BROKEN (1 << 5) /* Must validate parent when ending. */ |
|
#define MDOC_DELIMO (1 << 6) |
|
#define MDOC_DELIMC (1 << 7) |
|
#define MAN_VALID MDOC_VALID |
|
#define MAN_EOS MDOC_EOS |
|
#define MAN_LINE MDOC_LINE |
|
int prev_font; /* Before entering this node. */ |
|
int aux; /* Decoded node data, type-dependent. */ |
|
enum roff_type type; /* AST node type. */ |
|
enum roff_sec sec; /* Current named section. */ |
|
enum mdoc_endbody end; /* BODY */ |
|
}; |
|
|
|
struct roff_meta { |
|
char *msec; /* Manual section, usually a digit. */ |
|
char *vol; /* Manual volume title. */ |
|
char *os; /* Operating system. */ |
|
char *arch; /* Machine architecture. */ |
|
char *title; /* Manual title, usually CAPS. */ |
|
char *name; /* Leading manual name. */ |
|
char *date; /* Normalized date. */ |
|
int hasbody; /* Document is not empty. */ |
|
}; |
|
|
|
struct roff_man { |
|
struct roff_meta meta; /* Document meta-data. */ |
|
struct mparse *parse; /* Parse pointer. */ |
|
struct roff *roff; /* Roff parser state data. */ |
|
const char *defos; /* Default operating system. */ |
|
struct roff_node *first; /* The first node parsed. */ |
|
struct roff_node *last; /* The last node parsed. */ |
|
struct roff_node *last_es; /* The most recent Es node. */ |
|
int quick; /* Abort parse early. */ |
|
int flags; /* Parse flags. */ |
|
#define MDOC_LITERAL (1 << 1) /* In a literal scope. */ |
|
#define MDOC_PBODY (1 << 2) /* In the document body. */ |
|
#define MDOC_NEWLINE (1 << 3) /* First macro/text in a line. */ |
|
#define MDOC_PHRASE (1 << 4) /* In a Bl -column phrase. */ |
|
#define MDOC_PHRASELIT (1 << 5) /* Literal within a phrase. */ |
|
#define MDOC_FREECOL (1 << 6) /* `It' invocation should close. */ |
|
#define MDOC_SYNOPSIS (1 << 7) /* SYNOPSIS-style formatting. */ |
|
#define MDOC_KEEP (1 << 8) /* In a word keep. */ |
|
#define MDOC_SMOFF (1 << 9) /* Spacing is off. */ |
|
#define MDOC_NODELIMC (1 << 10) /* Disable closing delimiter handling. */ |
|
#define MAN_ELINE (1 << 11) /* Next-line element scope. */ |
|
#define MAN_BLINE (1 << 12) /* Next-line block scope. */ |
|
#define MDOC_PHRASEQF (1 << 13) /* Quote first word encountered. */ |
|
#define MDOC_PHRASEQL (1 << 14) /* Quote last word of this phrase. */ |
|
#define MDOC_PHRASEQN (1 << 15) /* Quote first word of the next phrase. */ |
|
#define MAN_LITERAL MDOC_LITERAL |
|
#define MAN_NEWLINE MDOC_NEWLINE |
|
enum roff_macroset macroset; /* Kind of high-level macros used. */ |
|
enum roff_sec lastsec; /* Last section seen. */ |
|
enum roff_sec lastnamed; /* Last standard section seen. */ |
|
enum roff_next next; /* Where to put the next node. */ |
|
}; |
|
|
|
|
|
void deroff(char **, const struct roff_node *); |