Return to mandoc.h CVS log | Up to [cvsweb.bsd.lv] / mandoc |
version 1.256, 2018/12/12 21:54:35 | version 1.275, 2022/04/24 13:38:46 | ||
---|---|---|---|
|
|
||
/* $Id$ */ | /* $Id$ */ | ||
/* | /* | ||
* Copyright (c) 2012-2022 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, 2012-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_ARCH_BAD, /* unknown architecture: Dt ... arch */ | MANDOCERR_ARCH_BAD, /* unknown architecture: Dt ... arch */ | ||
MANDOCERR_OS_ARG, /* operating system explicitly specified: Os ... */ | MANDOCERR_OS_ARG, /* operating system explicitly specified: Os ... */ | ||
MANDOCERR_RCS_MISSING, /* RCS id missing */ | MANDOCERR_RCS_MISSING, /* RCS id missing */ | ||
MANDOCERR_XR_BAD, /* referenced manual not found: Xr name sec */ | |||
MANDOCERR_STYLE, /* ===== start of style suggestions ===== */ | MANDOCERR_STYLE, /* ===== start of style suggestions ===== */ | ||
|
|
||
MANDOCERR_BX, /* consider using OS macro: macro */ | MANDOCERR_BX, /* consider using OS macro: macro */ | ||
MANDOCERR_ER_ORDER, /* errnos out of order: Er ... */ | MANDOCERR_ER_ORDER, /* errnos out of order: Er ... */ | ||
MANDOCERR_ER_REP, /* duplicate errno: Er ... */ | MANDOCERR_ER_REP, /* duplicate errno: Er ... */ | ||
MANDOCERR_XR_BAD, /* referenced manual not found: Xr name sec */ | |||
MANDOCERR_DELIM, /* trailing delimiter: macro ... */ | MANDOCERR_DELIM, /* trailing delimiter: macro ... */ | ||
MANDOCERR_DELIM_NB, /* no blank before trailing delimiter: macro ... */ | MANDOCERR_DELIM_NB, /* no blank before trailing delimiter: macro ... */ | ||
MANDOCERR_FI_SKIP, /* fill mode already enabled, skipping: fi */ | MANDOCERR_FI_SKIP, /* fill mode already enabled, skipping: fi */ | ||
MANDOCERR_NF_SKIP, /* fill mode already disabled, skipping: nf */ | MANDOCERR_NF_SKIP, /* fill mode already disabled, skipping: nf */ | ||
MANDOCERR_TEXT_LONG, /* input text line longer than 80 bytes */ | |||
MANDOCERR_DASHDASH, /* verbatim "--", maybe consider using \(em */ | MANDOCERR_DASHDASH, /* verbatim "--", maybe consider using \(em */ | ||
MANDOCERR_FUNC, /* function name without markup: name() */ | MANDOCERR_FUNC, /* function name without markup: name() */ | ||
MANDOCERR_SPACE_EOL, /* whitespace at end of input line */ | MANDOCERR_SPACE_EOL, /* whitespace at end of input line */ | ||
|
|
||
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_MSEC_FILE, /* filename/section mismatch: ... */ | ||
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_TBLLAYOUT_NONE, /* empty tbl layout */ | MANDOCERR_TBLLAYOUT_NONE, /* empty tbl layout */ | ||
MANDOCERR_TBLLAYOUT_CHAR, /* invalid character in tbl layout: char */ | MANDOCERR_TBLLAYOUT_CHAR, /* invalid character in tbl layout: char */ | ||
MANDOCERR_TBLLAYOUT_PAR, /* unmatched parenthesis in tbl layout */ | MANDOCERR_TBLLAYOUT_PAR, /* unmatched parenthesis in tbl layout */ | ||
MANDOCERR_TBLLAYOUT_SPC, /* ignoring excessive spacing in tbl layout */ | |||
MANDOCERR_TBLDATA_NONE, /* tbl without any data cells */ | MANDOCERR_TBLDATA_NONE, /* tbl without any data cells */ | ||
MANDOCERR_TBLDATA_SPAN, /* ignoring data in spanned tbl cell: data */ | MANDOCERR_TBLDATA_SPAN, /* ignoring data in spanned tbl cell: data */ | ||
MANDOCERR_TBLDATA_EXTRA, /* ignoring extra tbl data cells: data */ | MANDOCERR_TBLDATA_EXTRA, /* ignoring extra tbl data cells: data */ | ||
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_NAMESC, /* escaped character not allowed in a name: name */ | MANDOCERR_NAMESC, /* escaped character not allowed in a name: name */ | ||
MANDOCERR_ARG_UNDEF, /* using macro argument outside macro */ | MANDOCERR_ARG_UNDEF, /* using macro argument outside macro */ | ||
MANDOCERR_ARG_NONUM, /* argument number is not numeric */ | MANDOCERR_ARG_NONUM, /* argument number is not numeric */ | ||
MANDOCERR_ARG_NEG, /* negative argument, using 0: request arg */ | |||
MANDOCERR_BD_FILE, /* NOT IMPLEMENTED: Bd -file */ | MANDOCERR_BD_FILE, /* NOT IMPLEMENTED: Bd -file */ | ||
MANDOCERR_BD_NOARG, /* skipping display without arguments: Bd */ | MANDOCERR_BD_NOARG, /* skipping display without arguments: Bd */ | ||
MANDOCERR_BL_NOTYPE, /* missing list type, using -item: Bl */ | MANDOCERR_BL_NOTYPE, /* missing list type, using -item: Bl */ | ||
|
|
||
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_TBLOPT_EQN, /* eqn delim option in tbl: arg */ | MANDOCERR_TBLOPT_EQN, /* eqn delim option in tbl: arg */ | ||
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_TBL_TMAN, /* skipping tbl in -Tman mode */ | |||
MANDOCERR_EQN_TMAN, /* skipping eqn in -Tman mode */ | |||
MANDOCERR_MAX | MANDOCERR_BADARG, /* ===== start of bad invocations ===== */ | ||
}; | |||
enum eqn_boxt { | MANDOCERR_BADARG_BAD, /* bad argument */ | ||
EQN_TEXT, /* text (number, variable, whatever) */ | MANDOCERR_BADARG_DUPE, /* duplicate argument */ | ||
EQN_SUBEXPR, /* nested `eqn' subexpression */ | MANDOCERR_BADVAL, /* does not take a value */ | ||
EQN_LIST, /* list (braces, etc.) */ | MANDOCERR_BADVAL_MISS, /* missing argument value */ | ||
EQN_PILE, /* vertical pile */ | MANDOCERR_BADVAL_BAD, /* bad argument value */ | ||
EQN_MATRIX /* pile of piles */ | MANDOCERR_BADVAL_DUPE, /* duplicate argument value */ | ||
}; | MANDOCERR_TAG, /* no such tag */ | ||
MANDOCERR_MAN_TMARKDOWN, /* -Tmarkdown unsupported for man(7) input */ | |||
enum eqn_fontt { | MANDOCERR_SYSERR, /* ===== start of system errors ===== */ | ||
EQNFONT_NONE = 0, | |||
EQNFONT_ROMAN, | |||
EQNFONT_BOLD, | |||
EQNFONT_FAT, | |||
EQNFONT_ITALIC, | |||
EQNFONT__MAX | |||
}; | |||
enum eqn_post { | MANDOCERR_DUP, | ||
EQNPOS_NONE = 0, | MANDOCERR_EXEC, | ||
EQNPOS_SUP, | MANDOCERR_FDOPEN, | ||
EQNPOS_SUBSUP, | MANDOCERR_FFLUSH, | ||
EQNPOS_SUB, | MANDOCERR_FORK, | ||
EQNPOS_TO, | MANDOCERR_FSTAT, | ||
EQNPOS_FROM, | MANDOCERR_GETLINE, | ||
EQNPOS_FROMTO, | MANDOCERR_GLOB, | ||
EQNPOS_OVER, | MANDOCERR_GZCLOSE, | ||
EQNPOS_SQRT, | MANDOCERR_GZDOPEN, | ||
EQNPOS__MAX | MANDOCERR_MKSTEMP, | ||
}; | MANDOCERR_OPEN, | ||
MANDOCERR_PLEDGE, | |||
MANDOCERR_READ, | |||
MANDOCERR_WAIT, | |||
MANDOCERR_WRITE, | |||
enum eqn_pilet { | MANDOCERR_MAX | ||
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_FONTITALIC, /* italic font mode */ | ESCAPE_FONTITALIC, /* italic font mode */ | ||
ESCAPE_FONTBI, /* bold italic font mode */ | ESCAPE_FONTBI, /* bold italic font mode */ | ||
ESCAPE_FONTROMAN, /* roman font mode */ | ESCAPE_FONTROMAN, /* roman font mode */ | ||
ESCAPE_FONTCW, /* constant width font mode */ | ESCAPE_FONTCR, /* constant width font mode */ | ||
ESCAPE_FONTCB, /* constant width bold font mode */ | |||
ESCAPE_FONTCI, /* constant width italic font mode */ | |||
ESCAPE_FONTPREV, /* previous font mode */ | ESCAPE_FONTPREV, /* previous font mode */ | ||
ESCAPE_NUMBERED, /* a numbered glyph */ | ESCAPE_NUMBERED, /* a numbered glyph */ | ||
ESCAPE_UNICODE, /* a unicode codepoint */ | ESCAPE_UNICODE, /* a unicode codepoint */ | ||
|
|
||
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 *); |