version 1.167, 2014/10/28 17:36:19 |
version 1.185, 2015/01/22 21:38:16 |
|
|
/* $Id$ */ |
/* $Id$ */ |
/* |
/* |
* Copyright (c) 2010, 2011, 2014 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-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 |
|
|
* 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 */ |
Line 33 enum mandoclevel { |
|
Line 31 enum mandoclevel { |
|
MANDOCLEVEL_RESERVED, |
MANDOCLEVEL_RESERVED, |
MANDOCLEVEL_WARNING, /* warnings: syntax, whitespace, etc. */ |
MANDOCLEVEL_WARNING, /* warnings: syntax, whitespace, etc. */ |
MANDOCLEVEL_ERROR, /* input has been thrown away */ |
MANDOCLEVEL_ERROR, /* input has been thrown away */ |
MANDOCLEVEL_FATAL, /* input is borked */ |
MANDOCLEVEL_UNSUPP, /* input needs unimplemented features */ |
MANDOCLEVEL_BADARG, /* bad argument in invocation */ |
MANDOCLEVEL_BADARG, /* bad argument in invocation */ |
MANDOCLEVEL_SYSERR, /* system error */ |
MANDOCLEVEL_SYSERR, /* system error */ |
MANDOCLEVEL_MAX |
MANDOCLEVEL_MAX |
|
|
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 */ |
MANDOCERR_EQN_NOBOX, /* missing eqn box, using "": op */ |
|
|
Line 137 enum mandocerr { |
|
Line 136 enum mandocerr { |
|
MANDOCERR_EQNEOF, /* unexpected end of equation */ |
MANDOCERR_EQNEOF, /* unexpected end of equation */ |
|
|
/* related to tables */ |
/* related to tables */ |
MANDOCERR_TBL, /* bad table syntax */ |
|
MANDOCERR_TBLOPT, /* bad table option */ |
|
MANDOCERR_TBLLAYOUT, /* bad table layout */ |
|
MANDOCERR_TBLNOLAYOUT, /* no table layout cells specified */ |
MANDOCERR_TBLNOLAYOUT, /* no table layout cells specified */ |
MANDOCERR_TBLNODATA, /* no table data cells specified */ |
MANDOCERR_TBLNODATA, /* no table data cells specified */ |
MANDOCERR_TBLIGNDATA, /* ignore data in cell */ |
MANDOCERR_TBLIGNDATA, /* ignore data in cell */ |
Line 147 enum mandocerr { |
|
Line 143 enum mandocerr { |
|
MANDOCERR_TBLEXTRADAT, /* ignoring extra data cells */ |
MANDOCERR_TBLEXTRADAT, /* ignoring extra data cells */ |
|
|
/* related to document structure and macros */ |
/* related to document structure and macros */ |
|
MANDOCERR_FILE, /* cannot open file */ |
MANDOCERR_ROFFLOOP, /* input stack limit exceeded, infinite loop? */ |
MANDOCERR_ROFFLOOP, /* input stack limit exceeded, infinite loop? */ |
MANDOCERR_BADCHAR, /* skipping bad character: number */ |
MANDOCERR_CHAR_BAD, /* skipping bad character: number */ |
MANDOCERR_MACRO, /* skipping unknown macro: macro */ |
MANDOCERR_MACRO, /* skipping unknown macro: macro */ |
|
MANDOCERR_REQ_INSEC, /* skipping insecure request: request */ |
MANDOCERR_IT_STRAY, /* skipping item outside list: It ... */ |
MANDOCERR_IT_STRAY, /* skipping item outside list: It ... */ |
MANDOCERR_TA_STRAY, /* skipping column outside column list: Ta */ |
MANDOCERR_TA_STRAY, /* skipping column outside column list: Ta */ |
MANDOCERR_BLK_NOTOPEN, /* skipping end of block that is not open */ |
MANDOCERR_BLK_NOTOPEN, /* skipping end of block that is not open */ |
Line 159 enum mandocerr { |
|
Line 157 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 */ |
MANDOCERR_ST_BAD, /* unknown standard specifier: St standard */ |
MANDOCERR_ST_BAD, /* unknown standard specifier: St standard */ |
MANDOCERR_IT_NONUM, /* skipping request without numeric argument */ |
MANDOCERR_IT_NONUM, /* skipping request without numeric argument */ |
|
MANDOCERR_SO_PATH, /* NOT IMPLEMENTED: .so with absolute path or ".." */ |
|
MANDOCERR_SO_FAIL, /* .so request failed */ |
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_FATAL, /* ===== start of fatal errors ===== */ |
MANDOCERR_UNSUPP, /* ===== start of unsupported features ===== */ |
|
|
MANDOCERR_TOOLARGE, /* input too large */ |
MANDOCERR_TOOLARGE, /* input too large */ |
MANDOCERR_BD_FILE, /* NOT IMPLEMENTED: Bd -file */ |
MANDOCERR_CHAR_UNSUPP, /* unsupported control character: number */ |
MANDOCERR_SO_PATH, /* NOT IMPLEMENTED: .so with absolute path or ".." */ |
MANDOCERR_REQ_UNSUPP, /* unsupported roff request: request */ |
MANDOCERR_SO_FAIL, /* .so request failed */ |
MANDOCERR_TBL, /* unsupported table syntax */ |
|
MANDOCERR_TBLOPT, /* unsupported table option */ |
|
MANDOCERR_TBLLAYOUT, /* unsupported table layout */ |
|
MANDOCERR_TBLMACRO, /* ignoring macro in table: macro */ |
|
|
/* ===== system errors ===== */ |
|
|
|
MANDOCERR_SYSDUP, /* cannot dup file descriptor */ |
|
MANDOCERR_SYSEXEC, /* cannot exec */ |
|
MANDOCERR_SYSEXIT, /* gunzip failed with code */ |
|
MANDOCERR_SYSFORK, /* cannot fork */ |
|
MANDOCERR_SYSOPEN, /* cannot open file */ |
|
MANDOCERR_SYSPIPE, /* cannot open pipe */ |
|
MANDOCERR_SYSREAD, /* cannot read file */ |
|
MANDOCERR_SYSSIG, /* gunzip died from signal */ |
|
MANDOCERR_SYSSTAT, /* cannot stat file */ |
|
MANDOCERR_SYSWAIT, /* wait failed */ |
|
|
|
MANDOCERR_MAX |
MANDOCERR_MAX |
}; |
}; |
|
|
Line 409 enum mandoc_esc { |
|
Line 400 enum mandoc_esc { |
|
ESCAPE_NUMBERED, /* a numbered glyph */ |
ESCAPE_NUMBERED, /* a numbered glyph */ |
ESCAPE_UNICODE, /* a unicode codepoint */ |
ESCAPE_UNICODE, /* a unicode codepoint */ |
ESCAPE_NOSPACE, /* suppress space if the last on a line */ |
ESCAPE_NOSPACE, /* suppress space if the last on a line */ |
ESCAPE_SKIPCHAR /* skip the next character */ |
ESCAPE_SKIPCHAR, /* skip the next character */ |
|
ESCAPE_OVERSTRIKE /* overstrike all chars in the argument */ |
}; |
}; |
|
|
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); |
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 *, |
Line 436 struct mparse *mparse_alloc(int, enum mandoclevel, ma |
|
Line 428 struct mparse *mparse_alloc(int, enum mandoclevel, ma |
|
const struct mchars *, 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 447 void mparse_result(struct mparse *, |
|
Line 438 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*/ |
|