![]() ![]() | ![]() |
version 1.255, 2018/11/25 19:24:20 | version 1.267, 2020/04/03 11:35:01 | ||
---|---|---|---|
|
|
||
/* $Id$ */ | /* $Id$ */ | ||
/* | /* | ||
* Copyright (c) 2012-2020 Ingo Schwarze <schwarze@openbsd.org> | |||
* Copyright (c) 2010, 2011, 2014 Kristaps Dzonsons <kristaps@bsd.lv> | * Copyright (c) 2010, 2011, 2014 Kristaps Dzonsons <kristaps@bsd.lv> | ||
* Copyright (c) 2010-2018 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 | ||
|
|
||
* 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. | ||
* | |||
* Error handling, escape sequence, and character utilities. | |||
* Can be used by all code in the mandoc package. | |||
*/ | */ | ||
#define ASCII_NBRSP 31 /* non-breaking space */ | #define ASCII_NBRSP 31 /* non-breaking space */ | ||
|
|
||
MANDOCERR_TH_NOTITLE, /* missing manual title, using "": [macro] */ | MANDOCERR_TH_NOTITLE, /* missing manual title, using "": [macro] */ | ||
MANDOCERR_MSEC_MISSING, /* missing manual section, using "": macro */ | MANDOCERR_MSEC_MISSING, /* missing manual section, using "": macro */ | ||
MANDOCERR_MSEC_BAD, /* unknown manual section: Dt ... section */ | MANDOCERR_MSEC_BAD, /* unknown manual section: Dt ... section */ | ||
MANDOCERR_DATE_MISSING, /* missing date, using today's date */ | MANDOCERR_DATE_MISSING, /* missing date, using "": [macro] */ | ||
MANDOCERR_DATE_BAD, /* cannot parse date, using it verbatim: date */ | MANDOCERR_DATE_BAD, /* cannot parse date, using it verbatim: date */ | ||
MANDOCERR_DATE_FUTURE, /* date in the future, using it anyway: date */ | MANDOCERR_DATE_FUTURE, /* date in the future, using it anyway: date */ | ||
MANDOCERR_OS_MISSING, /* missing Os macro, using "" */ | MANDOCERR_OS_MISSING, /* missing Os macro, using "" */ | ||
|
|
||
MANDOCERR_FI_TAB, /* tab in filled text */ | MANDOCERR_FI_TAB, /* tab in filled text */ | ||
MANDOCERR_EOS, /* new sentence, new line */ | MANDOCERR_EOS, /* new sentence, new line */ | ||
MANDOCERR_ESC_BAD, /* invalid escape sequence: esc */ | MANDOCERR_ESC_BAD, /* invalid escape sequence: esc */ | ||
MANDOCERR_ESC_UNDEF, /* undefined escape, printing literally: char */ | |||
MANDOCERR_STR_UNDEF, /* undefined string, using "": name */ | MANDOCERR_STR_UNDEF, /* undefined string, using "": name */ | ||
/* related to tables */ | /* related to tables */ | ||
|
|
||
MANDOCERR_TBLDATA_BLK, /* data block open at end of tbl: macro */ | MANDOCERR_TBLDATA_BLK, /* data block open at end of tbl: macro */ | ||
/* related to document structure and macros */ | /* related to document structure and macros */ | ||
MANDOCERR_FILE, /* cannot open file */ | |||
MANDOCERR_PROLOG_REP, /* duplicate prologue macro: macro */ | MANDOCERR_PROLOG_REP, /* duplicate prologue macro: macro */ | ||
MANDOCERR_DT_LATE, /* skipping late title macro: Dt args */ | MANDOCERR_DT_LATE, /* skipping late title macro: Dt args */ | ||
MANDOCERR_ROFFLOOP, /* input stack limit exceeded, infinite loop? */ | MANDOCERR_ROFFLOOP, /* input stack limit exceeded, infinite loop? */ | ||
|
|
||
MANDOCERR_SHIFT, /* excessive shift: ..., but max is ... */ | MANDOCERR_SHIFT, /* excessive shift: ..., but max is ... */ | ||
MANDOCERR_SO_PATH, /* NOT IMPLEMENTED: .so with absolute path or ".." */ | MANDOCERR_SO_PATH, /* NOT IMPLEMENTED: .so with absolute path or ".." */ | ||
MANDOCERR_SO_FAIL, /* .so request failed */ | MANDOCERR_SO_FAIL, /* .so request failed */ | ||
MANDOCERR_TG_SPC, /* skipping tag containing whitespace: tag */ | |||
MANDOCERR_ARG_SKIP, /* skipping all arguments: macro args */ | MANDOCERR_ARG_SKIP, /* skipping all arguments: macro args */ | ||
MANDOCERR_ARG_EXCESS, /* skipping excess arguments: macro ... args */ | MANDOCERR_ARG_EXCESS, /* skipping excess arguments: macro ... args */ | ||
MANDOCERR_DIVZERO, /* divide by zero */ | MANDOCERR_DIVZERO, /* divide by zero */ | ||
|
|
||
MANDOCERR_TOOLARGE, /* input too large */ | MANDOCERR_TOOLARGE, /* input too large */ | ||
MANDOCERR_CHAR_UNSUPP, /* unsupported control character: number */ | MANDOCERR_CHAR_UNSUPP, /* unsupported control character: number */ | ||
MANDOCERR_ESC_UNSUPP, /* unsupported escape sequence: escape */ | |||
MANDOCERR_REQ_UNSUPP, /* unsupported roff request: request */ | MANDOCERR_REQ_UNSUPP, /* unsupported roff request: request */ | ||
MANDOCERR_WHILE_NEST, /* nested .while loops */ | MANDOCERR_WHILE_NEST, /* nested .while loops */ | ||
MANDOCERR_WHILE_OUTOF, /* end of scope with open .while loop */ | MANDOCERR_WHILE_OUTOF, /* end of scope with open .while loop */ | ||
|
|
||
MANDOCERR_TBLLAYOUT_MOD, /* unsupported tbl layout modifier: m */ | MANDOCERR_TBLLAYOUT_MOD, /* unsupported tbl layout modifier: m */ | ||
MANDOCERR_TBLMACRO, /* ignoring macro in table: macro */ | MANDOCERR_TBLMACRO, /* ignoring macro in table: macro */ | ||
MANDOCERR_MAX | MANDOCERR_BADARG, /* ===== start of bad invocations ===== */ | ||
}; | |||
struct tbl_opts { | MANDOCERR_BADARG_BAD, /* bad argument */ | ||
char tab; /* cell-separator */ | MANDOCERR_BADARG_DUPE, /* duplicate argument */ | ||
char decimal; /* decimal point */ | MANDOCERR_BADVAL, /* does not take a value */ | ||
int opts; | MANDOCERR_BADVAL_MISS, /* missing argument value */ | ||
#define TBL_OPT_CENTRE (1 << 0) | MANDOCERR_BADVAL_BAD, /* bad argument value */ | ||
#define TBL_OPT_EXPAND (1 << 1) | MANDOCERR_BADVAL_DUPE, /* duplicate argument value */ | ||
#define TBL_OPT_BOX (1 << 2) | MANDOCERR_TAG, /* no such tag */ | ||
#define TBL_OPT_DBOX (1 << 3) | |||
#define TBL_OPT_ALLBOX (1 << 4) | |||
#define TBL_OPT_NOKEEP (1 << 5) | |||
#define TBL_OPT_NOSPACE (1 << 6) | |||
#define TBL_OPT_NOWARN (1 << 7) | |||
int cols; /* number of columns */ | |||
int lvert; /* width of left vertical line */ | |||
int rvert; /* width of right vertical line */ | |||
}; | |||
enum tbl_cellt { | MANDOCERR_SYSERR, /* ===== start of system errors ===== */ | ||
TBL_CELL_CENTRE, /* c, C */ | |||
TBL_CELL_RIGHT, /* r, R */ | |||
TBL_CELL_LEFT, /* l, L */ | |||
TBL_CELL_NUMBER, /* n, N */ | |||
TBL_CELL_SPAN, /* s, S */ | |||
TBL_CELL_LONG, /* a, A */ | |||
TBL_CELL_DOWN, /* ^ */ | |||
TBL_CELL_HORIZ, /* _, - */ | |||
TBL_CELL_DHORIZ, /* = */ | |||
TBL_CELL_MAX | |||
}; | |||
/* | MANDOCERR_DUP, | ||
* A cell in a layout row. | MANDOCERR_EXEC, | ||
*/ | MANDOCERR_FDOPEN, | ||
struct tbl_cell { | MANDOCERR_FFLUSH, | ||
struct tbl_cell *next; | MANDOCERR_FORK, | ||
char *wstr; /* min width represented as a string */ | MANDOCERR_FSTAT, | ||
size_t width; /* minimum column width */ | MANDOCERR_GETLINE, | ||
size_t spacing; /* to the right of the column */ | MANDOCERR_GLOB, | ||
int vert; /* width of subsequent vertical line */ | MANDOCERR_GZCLOSE, | ||
int col; /* column number, starting from 0 */ | MANDOCERR_GZDOPEN, | ||
int flags; | MANDOCERR_MKSTEMP, | ||
#define TBL_CELL_TALIGN (1 << 0) /* t, T */ | MANDOCERR_OPEN, | ||
#define TBL_CELL_BALIGN (1 << 1) /* d, D */ | MANDOCERR_PLEDGE, | ||
#define TBL_CELL_BOLD (1 << 2) /* fB, B, b */ | MANDOCERR_READ, | ||
#define TBL_CELL_ITALIC (1 << 3) /* fI, I, i */ | MANDOCERR_WAIT, | ||
#define TBL_CELL_EQUAL (1 << 4) /* e, E */ | MANDOCERR_WRITE, | ||
#define TBL_CELL_UP (1 << 5) /* u, U */ | |||
#define TBL_CELL_WIGN (1 << 6) /* z, Z */ | |||
#define TBL_CELL_WMAX (1 << 7) /* x, X */ | |||
enum tbl_cellt pos; | |||
}; | |||
/* | MANDOCERR_MAX | ||
* A layout row. | |||
*/ | |||
struct tbl_row { | |||
struct tbl_row *next; | |||
struct tbl_cell *first; | |||
struct tbl_cell *last; | |||
int vert; /* width of left vertical line */ | |||
}; | }; | ||
enum tbl_datt { | |||
TBL_DATA_NONE, /* has no data */ | |||
TBL_DATA_DATA, /* consists of data/string */ | |||
TBL_DATA_HORIZ, /* horizontal line */ | |||
TBL_DATA_DHORIZ, /* double-horizontal line */ | |||
TBL_DATA_NHORIZ, /* squeezed horizontal line */ | |||
TBL_DATA_NDHORIZ /* squeezed double-horizontal line */ | |||
}; | |||
/* | |||
* A cell within a row of data. The "string" field contains the actual | |||
* string value that's in the cell. The rest is layout. | |||
*/ | |||
struct tbl_dat { | |||
struct tbl_cell *layout; /* layout cell */ | |||
struct tbl_dat *next; | |||
char *string; /* data (NULL if not TBL_DATA_DATA) */ | |||
int hspans; /* how many horizontal spans follow */ | |||
int vspans; /* how many vertical spans follow */ | |||
int block; /* T{ text block T} */ | |||
enum tbl_datt pos; | |||
}; | |||
enum tbl_spant { | |||
TBL_SPAN_DATA, /* span consists of data */ | |||
TBL_SPAN_HORIZ, /* span is horizontal line */ | |||
TBL_SPAN_DHORIZ /* span is double horizontal line */ | |||
}; | |||
/* | |||
* A row of data in a table. | |||
*/ | |||
struct tbl_span { | |||
struct tbl_opts *opts; | |||
struct tbl_row *layout; /* layout row */ | |||
struct tbl_dat *first; | |||
struct tbl_dat *last; | |||
struct tbl_span *prev; | |||
struct tbl_span *next; | |||
int line; /* parse line */ | |||
enum tbl_spant pos; | |||
}; | |||
enum eqn_boxt { | |||
EQN_TEXT, /* text (number, variable, whatever) */ | |||
EQN_SUBEXPR, /* nested `eqn' subexpression */ | |||
EQN_LIST, /* list (braces, etc.) */ | |||
EQN_PILE, /* vertical pile */ | |||
EQN_MATRIX /* pile of piles */ | |||
}; | |||
enum eqn_fontt { | |||
EQNFONT_NONE = 0, | |||
EQNFONT_ROMAN, | |||
EQNFONT_BOLD, | |||
EQNFONT_FAT, | |||
EQNFONT_ITALIC, | |||
EQNFONT__MAX | |||
}; | |||
enum eqn_post { | |||
EQNPOS_NONE = 0, | |||
EQNPOS_SUP, | |||
EQNPOS_SUBSUP, | |||
EQNPOS_SUB, | |||
EQNPOS_TO, | |||
EQNPOS_FROM, | |||
EQNPOS_FROMTO, | |||
EQNPOS_OVER, | |||
EQNPOS_SQRT, | |||
EQNPOS__MAX | |||
}; | |||
enum eqn_pilet { | |||
EQNPILE_NONE = 0, | |||
EQNPILE_PILE, | |||
EQNPILE_CPILE, | |||
EQNPILE_RPILE, | |||
EQNPILE_LPILE, | |||
EQNPILE_COL, | |||
EQNPILE_CCOL, | |||
EQNPILE_RCOL, | |||
EQNPILE_LCOL, | |||
EQNPILE__MAX | |||
}; | |||
/* | |||
* A "box" is a parsed mathematical expression as defined by the eqn.7 | |||
* grammar. | |||
*/ | |||
struct eqn_box { | |||
int size; /* font size of expression */ | |||
#define EQN_DEFSIZE INT_MIN | |||
enum eqn_boxt type; /* type of node */ | |||
struct eqn_box *first; /* first child node */ | |||
struct eqn_box *last; /* last child node */ | |||
struct eqn_box *next; /* node sibling */ | |||
struct eqn_box *prev; /* node sibling */ | |||
struct eqn_box *parent; /* node sibling */ | |||
char *text; /* text (or NULL) */ | |||
char *left; /* fence left-hand */ | |||
char *right; /* fence right-hand */ | |||
char *top; /* expression over-symbol */ | |||
char *bottom; /* expression under-symbol */ | |||
size_t args; /* arguments in parent */ | |||
size_t expectargs; /* max arguments in parent */ | |||
enum eqn_post pos; /* position of next box */ | |||
enum eqn_fontt font; /* font of box */ | |||
enum eqn_pilet pile; /* equation piling */ | |||
}; | |||
/* | |||
* Parse options. | |||
*/ | |||
#define MPARSE_MDOC 1 /* assume -mdoc */ | |||
#define MPARSE_MAN 2 /* assume -man */ | |||
#define MPARSE_SO 4 /* honour .so requests */ | |||
#define MPARSE_QUICK 8 /* abort the parse early */ | |||
#define MPARSE_UTF8 16 /* accept UTF-8 input */ | |||
#define MPARSE_LATIN1 32 /* accept ISO-LATIN-1 input */ | |||
enum mandoc_os { | |||
MANDOC_OS_OTHER = 0, | |||
MANDOC_OS_NETBSD, | |||
MANDOC_OS_OPENBSD | |||
}; | |||
enum mandoc_esc { | enum mandoc_esc { | ||
ESCAPE_ERROR = 0, /* bail! unparsable escape */ | ESCAPE_ERROR = 0, /* bail! unparsable escape */ | ||
ESCAPE_UNSUPP, /* unsupported escape; ignore it */ | |||
ESCAPE_IGNORE, /* escape to be ignored */ | ESCAPE_IGNORE, /* escape to be ignored */ | ||
ESCAPE_UNDEF, /* undefined escape; print literal character */ | |||
ESCAPE_SPECIAL, /* a regular special character */ | ESCAPE_SPECIAL, /* a regular special character */ | ||
ESCAPE_FONT, /* a generic font mode */ | ESCAPE_FONT, /* a generic font mode */ | ||
ESCAPE_FONTBOLD, /* bold font mode */ | ESCAPE_FONTBOLD, /* bold font mode */ | ||
|
|
||
ESCAPE_OVERSTRIKE /* overstrike all chars in the argument */ | ESCAPE_OVERSTRIKE /* overstrike all chars in the argument */ | ||
}; | }; | ||
typedef void (*mandocmsg)(enum mandocerr, enum mandoclevel, | |||
const char *, int, int, const char *); | |||
enum mandoc_esc mandoc_font(const char *, int); | |||
struct mparse; | |||
struct roff_man; | |||
enum mandoc_esc mandoc_escape(const char **, const char **, int *); | enum mandoc_esc mandoc_escape(const char **, const char **, int *); | ||
void mandoc_msg_setoutfile(FILE *); | |||
const char *mandoc_msg_getinfilename(void); | |||
void mandoc_msg_setinfilename(const char *); | |||
enum mandocerr mandoc_msg_getmin(void); | |||
void mandoc_msg_setmin(enum mandocerr); | |||
enum mandoclevel mandoc_msg_getrc(void); | |||
void mandoc_msg_setrc(enum mandoclevel); | |||
void mandoc_msg(enum mandocerr, int, int, const char *, ...) | |||
__attribute__((__format__ (__printf__, 4, 5))); | |||
void mandoc_msg_summary(void); | |||
void mchars_alloc(void); | void mchars_alloc(void); | ||
void mchars_free(void); | void mchars_free(void); | ||
int mchars_num2char(const char *, size_t); | int mchars_num2char(const char *, size_t); | ||
|
|
||
int mchars_num2uc(const char *, size_t); | int mchars_num2uc(const char *, size_t); | ||
int mchars_spec2cp(const char *, size_t); | int mchars_spec2cp(const char *, size_t); | ||
const char *mchars_spec2str(const char *, size_t, size_t *); | const char *mchars_spec2str(const char *, size_t, size_t *); | ||
struct mparse *mparse_alloc(int, enum mandocerr, mandocmsg, | |||
enum mandoc_os, const char *); | |||
void mparse_free(struct mparse *); | |||
int mparse_open(struct mparse *, const char *); | |||
enum mandoclevel mparse_readfd(struct mparse *, int, const char *); | |||
enum mandoclevel mparse_readmem(struct mparse *, void *, size_t, | |||
const char *); | |||
void mparse_reset(struct mparse *); | |||
void mparse_result(struct mparse *, | |||
struct roff_man **, char **); | |||
void mparse_copy(const struct mparse *); | |||
const char *mparse_strerror(enum mandocerr); | |||
const char *mparse_strlevel(enum mandoclevel); | |||
void mparse_updaterc(struct mparse *, enum mandoclevel *); |