version 1.159, 2014/10/10 08:44:24 |
version 1.176, 2014/12/01 08:05:52 |
|
|
/* $Id$ */ |
/* $Id$ */ |
/* |
/* |
* Copyright (c) 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv> |
* Copyright (c) 2010, 2011, 2014 Kristaps Dzonsons <kristaps@bsd.lv> |
* Copyright (c) 2010-2014 Ingo Schwarze <schwarze@openbsd.org> |
* Copyright (c) 2010-2014 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 |
|
|
* 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 MANDOC_H |
|
#define MANDOC_H |
|
|
|
#define ASCII_NBRSP 31 /* non-breaking space */ |
#define ASCII_NBRSP 31 /* non-breaking space */ |
#define ASCII_HYPH 30 /* breakable hyphen */ |
#define ASCII_HYPH 30 /* breakable hyphen */ |
|
|
MANDOCERR_TITLE_CASE, /* lower case character in document title */ |
MANDOCERR_TITLE_CASE, /* lower case character in document title */ |
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_ARCH_BAD, /* unknown manual volume or arch: Dt ... volume */ |
|
MANDOCERR_DATE_MISSING, /* missing date, using today's date */ |
MANDOCERR_DATE_MISSING, /* missing date, using today's date */ |
MANDOCERR_DATE_BAD, /* cannot parse date, using it verbatim: date */ |
MANDOCERR_DATE_BAD, /* cannot parse date, using it verbatim: date */ |
MANDOCERR_OS_MISSING, /* missing Os macro, using "" */ |
MANDOCERR_OS_MISSING, /* missing Os macro, using "" */ |
|
|
|
|
/* related to macros and nesting */ |
/* related to macros and nesting */ |
MANDOCERR_MACRO_OBS, /* obsolete macro: macro */ |
MANDOCERR_MACRO_OBS, /* obsolete macro: macro */ |
|
MANDOCERR_MACRO_CALL, /* macro neither callable nor escaped: macro */ |
MANDOCERR_PAR_SKIP, /* skipping paragraph macro: macro ... */ |
MANDOCERR_PAR_SKIP, /* skipping paragraph macro: macro ... */ |
MANDOCERR_PAR_MOVE, /* moving paragraph macro out of list: macro */ |
MANDOCERR_PAR_MOVE, /* moving paragraph macro out of list: macro */ |
MANDOCERR_NS_SKIP, /* skipping no-space macro */ |
MANDOCERR_NS_SKIP, /* skipping no-space macro */ |
Line 103 enum mandocerr { |
|
Line 101 enum mandocerr { |
|
MANDOCERR_IT_NOBODY, /* empty list item: Bl -type It */ |
MANDOCERR_IT_NOBODY, /* empty list item: Bl -type It */ |
MANDOCERR_BF_NOFONT, /* missing font type, using \fR: Bf */ |
MANDOCERR_BF_NOFONT, /* missing font type, using \fR: Bf */ |
MANDOCERR_BF_BADFONT, /* unknown font type, using \fR: Bf font */ |
MANDOCERR_BF_BADFONT, /* unknown font type, using \fR: Bf font */ |
|
MANDOCERR_PF_SKIP, /* nothing follows prefix: Pf arg */ |
MANDOCERR_ARG_STD, /* missing -std argument, adding it: macro */ |
MANDOCERR_ARG_STD, /* missing -std argument, adding it: macro */ |
|
MANDOCERR_EQN_NOBOX, /* missing eqn box, using "": op */ |
|
|
/* related to bad arguments */ |
/* related to bad arguments */ |
MANDOCERR_ARG_QUOTE, /* unterminated quoted argument */ |
MANDOCERR_ARG_QUOTE, /* unterminated quoted argument */ |
Line 114 enum mandocerr { |
|
Line 114 enum mandocerr { |
|
MANDOCERR_BL_SKIPW, /* skipping -width argument: Bl -type */ |
MANDOCERR_BL_SKIPW, /* skipping -width argument: Bl -type */ |
MANDOCERR_AT_BAD, /* unknown AT&T UNIX version: At version */ |
MANDOCERR_AT_BAD, /* unknown AT&T UNIX version: At version */ |
MANDOCERR_FA_COMMA, /* comma in function argument: arg */ |
MANDOCERR_FA_COMMA, /* comma in function argument: arg */ |
|
MANDOCERR_FN_PAREN, /* parenthesis in function name: arg */ |
MANDOCERR_RS_BAD, /* invalid content in Rs block: macro */ |
MANDOCERR_RS_BAD, /* invalid content in Rs block: macro */ |
MANDOCERR_SM_BAD, /* invalid Boolean argument: macro arg */ |
MANDOCERR_SM_BAD, /* invalid Boolean argument: macro arg */ |
MANDOCERR_FT_BAD, /* unknown font, skipping request: ft font */ |
MANDOCERR_FT_BAD, /* unknown font, skipping request: ft font */ |
Line 133 enum mandocerr { |
|
Line 134 enum mandocerr { |
|
MANDOCERR_EQNSCOPE, /* equation scope open on exit */ |
MANDOCERR_EQNSCOPE, /* equation scope open on exit */ |
MANDOCERR_EQNBADSCOPE, /* overlapping equation scopes */ |
MANDOCERR_EQNBADSCOPE, /* overlapping equation scopes */ |
MANDOCERR_EQNEOF, /* unexpected end of equation */ |
MANDOCERR_EQNEOF, /* unexpected end of equation */ |
MANDOCERR_EQNSYNT, /* equation syntax error */ |
|
|
|
/* related to tables */ |
/* related to tables */ |
MANDOCERR_TBL, /* bad table syntax */ |
MANDOCERR_TBL, /* bad table syntax */ |
Line 158 enum mandocerr { |
|
Line 158 enum mandocerr { |
|
/* related to request and macro arguments */ |
/* related to request and macro arguments */ |
MANDOCERR_NAMESC, /* escaped character not allowed in a name: name */ |
MANDOCERR_NAMESC, /* escaped character not allowed in a name: name */ |
MANDOCERR_ARGCOUNT, /* argument count wrong */ |
MANDOCERR_ARGCOUNT, /* argument count wrong */ |
|
MANDOCERR_BD_FILE, /* NOT IMPLEMENTED: Bd -file */ |
MANDOCERR_BL_NOTYPE, /* missing list type, using -item: Bl */ |
MANDOCERR_BL_NOTYPE, /* missing list type, using -item: Bl */ |
MANDOCERR_NM_NONAME, /* missing manual name, using "": Nm */ |
MANDOCERR_NM_NONAME, /* missing manual name, using "": Nm */ |
MANDOCERR_OS_UNAME, /* uname(3) system call failed, using UNKNOWN */ |
MANDOCERR_OS_UNAME, /* uname(3) system call failed, using UNKNOWN */ |
Line 165 enum mandocerr { |
|
Line 166 enum mandocerr { |
|
MANDOCERR_IT_NONUM, /* skipping request without numeric argument */ |
MANDOCERR_IT_NONUM, /* skipping request without numeric argument */ |
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_FATAL, /* ===== start of fatal errors ===== */ |
MANDOCERR_FATAL, /* ===== start of fatal errors ===== */ |
|
|
MANDOCERR_TOOLARGE, /* input too large */ |
MANDOCERR_TOOLARGE, /* input too large */ |
MANDOCERR_BD_FILE, /* NOT IMPLEMENTED: Bd -file */ |
|
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 */ |
|
|
Line 245 struct tbl_cell { |
|
Line 246 struct tbl_cell { |
|
#define TBL_CELL_EQUAL (1 << 4) /* e, E */ |
#define TBL_CELL_EQUAL (1 << 4) /* e, E */ |
#define TBL_CELL_UP (1 << 5) /* u, U */ |
#define TBL_CELL_UP (1 << 5) /* u, U */ |
#define TBL_CELL_WIGN (1 << 6) /* z, Z */ |
#define TBL_CELL_WIGN (1 << 6) /* z, Z */ |
|
#define TBL_CELL_WMAX (1 << 7) /* x, X */ |
struct tbl_head *head; |
struct tbl_head *head; |
}; |
}; |
|
|
|
|
#define MPARSE_MAN 2 /* assume -man */ |
#define MPARSE_MAN 2 /* assume -man */ |
#define MPARSE_SO 4 /* honour .so requests */ |
#define MPARSE_SO 4 /* honour .so requests */ |
#define MPARSE_QUICK 8 /* abort the parse early */ |
#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_esc { |
enum mandoc_esc { |
ESCAPE_ERROR = 0, /* bail! unparsable escape */ |
ESCAPE_ERROR = 0, /* bail! unparsable escape */ |
Line 410 enum mandoc_esc { |
|
Line 414 enum mandoc_esc { |
|
typedef void (*mandocmsg)(enum mandocerr, enum mandoclevel, |
typedef void (*mandocmsg)(enum mandocerr, enum mandoclevel, |
const char *, int, int, const char *); |
const char *, int, int, const char *); |
|
|
|
__BEGIN_DECLS |
|
|
struct mparse; |
struct mparse; |
struct mchars; |
struct mchars; |
struct mdoc; |
struct mdoc; |
struct man; |
struct man; |
|
|
__BEGIN_DECLS |
|
|
|
enum mandoc_esc mandoc_escape(const char **, const char **, int *); |
enum mandoc_esc mandoc_escape(const char **, const char **, int *); |
struct mchars *mchars_alloc(void); |
struct mchars *mchars_alloc(void); |
void mchars_free(struct mchars *); |
void mchars_free(struct mchars *); |
char mchars_num2char(const char *, size_t); |
int mchars_num2char(const char *, size_t); |
|
const char *mchars_uc2str(int); |
int mchars_num2uc(const char *, size_t); |
int mchars_num2uc(const char *, size_t); |
int mchars_spec2cp(const struct mchars *, |
int mchars_spec2cp(const struct mchars *, |
const char *, size_t); |
const char *, size_t); |
const char *mchars_spec2str(const struct mchars *, |
const char *mchars_spec2str(const struct mchars *, |
const char *, size_t, size_t *); |
const char *, size_t, size_t *); |
struct mparse *mparse_alloc(int, enum mandoclevel, mandocmsg, |
struct mparse *mparse_alloc(int, enum mandoclevel, mandocmsg, |
const char *); |
const struct mchars *, const char *); |
void mparse_free(struct mparse *); |
void mparse_free(struct mparse *); |
void mparse_keep(struct mparse *); |
void mparse_keep(struct mparse *); |
enum mandoclevel mparse_open(struct mparse *, int *, const char *, |
enum mandoclevel mparse_open(struct mparse *, int *, const char *); |
pid_t *); |
|
enum mandoclevel mparse_readfd(struct mparse *, int, const char *); |
enum mandoclevel mparse_readfd(struct mparse *, int, const char *); |
enum mandoclevel mparse_readmem(struct mparse *, const void *, size_t, |
enum mandoclevel mparse_readmem(struct mparse *, void *, size_t, |
const char *); |
const char *); |
void mparse_reset(struct mparse *); |
void mparse_reset(struct mparse *); |
void mparse_result(struct mparse *, |
void mparse_result(struct mparse *, |
Line 441 void mparse_result(struct mparse *, |
|
Line 445 void mparse_result(struct mparse *, |
|
const char *mparse_getkeep(const struct mparse *); |
const char *mparse_getkeep(const struct mparse *); |
const char *mparse_strerror(enum mandocerr); |
const char *mparse_strerror(enum mandocerr); |
const char *mparse_strlevel(enum mandoclevel); |
const char *mparse_strlevel(enum mandoclevel); |
enum mandoclevel mparse_wait(struct mparse *, pid_t); |
enum mandoclevel mparse_wait(struct mparse *); |
|
|
__END_DECLS |
__END_DECLS |
|
|
#endif /*!MANDOC_H*/ |
|