version 1.56, 2011/02/06 22:02:58 |
version 1.100, 2012/05/27 17:48:57 |
|
|
MANDOCERR_NOTITLE, /* no title in document */ |
MANDOCERR_NOTITLE, /* no title in document */ |
MANDOCERR_UPPERCASE, /* document title should be all caps */ |
MANDOCERR_UPPERCASE, /* document title should be all caps */ |
MANDOCERR_BADMSEC, /* unknown manual section */ |
MANDOCERR_BADMSEC, /* unknown manual section */ |
MANDOCERR_BADDATE, /* cannot parse date argument */ |
MANDOCERR_NODATE, /* date missing, using today's date */ |
|
MANDOCERR_BADDATE, /* cannot parse date, using it verbatim */ |
MANDOCERR_PROLOGOOO, /* prologue macros out of order */ |
MANDOCERR_PROLOGOOO, /* prologue macros out of order */ |
MANDOCERR_PROLOGREP, /* duplicate prologue macro */ |
MANDOCERR_PROLOGREP, /* duplicate prologue macro */ |
MANDOCERR_BADPROLOG, /* macro not allowed in prologue */ |
MANDOCERR_BADPROLOG, /* macro not allowed in prologue */ |
|
|
MANDOCERR_CHILD, /* child violates parent syntax */ |
MANDOCERR_CHILD, /* child violates parent syntax */ |
MANDOCERR_NESTEDDISP, /* nested displays are not portable */ |
MANDOCERR_NESTEDDISP, /* nested displays are not portable */ |
MANDOCERR_SCOPEREP, /* already in literal mode */ |
MANDOCERR_SCOPEREP, /* already in literal mode */ |
|
MANDOCERR_LINESCOPE, /* line scope broken */ |
|
|
/* related to missing macro arguments */ |
/* related to missing macro arguments */ |
MANDOCERR_MACROEMPTY, /* skipping empty macro */ |
MANDOCERR_MACROEMPTY, /* skipping empty macro */ |
Line 102 enum mandocerr { |
|
Line 104 enum mandocerr { |
|
MANDOCERR_BADESCAPE, /* unknown escape sequence */ |
MANDOCERR_BADESCAPE, /* unknown escape sequence */ |
MANDOCERR_BADQUOTE, /* unterminated quoted string */ |
MANDOCERR_BADQUOTE, /* unterminated quoted string */ |
|
|
|
/* related to equations */ |
|
MANDOCERR_EQNQUOTE, /* unexpected literal in equation */ |
|
|
MANDOCERR_ERROR, /* ===== start of errors ===== */ |
MANDOCERR_ERROR, /* ===== start of errors ===== */ |
|
|
|
/* related to equations */ |
|
MANDOCERR_EQNNSCOPE, /* unexpected equation scope closure*/ |
|
MANDOCERR_EQNSCOPE, /* equation scope open on exit */ |
|
MANDOCERR_EQNBADSCOPE, /* overlapping equation scopes */ |
|
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 */ |
MANDOCERR_TBLOPT, /* bad table option */ |
MANDOCERR_TBLOPT, /* bad table option */ |
Line 120 enum mandocerr { |
|
Line 132 enum mandocerr { |
|
MANDOCERR_NOTEXT, /* skipping text before the first section header */ |
MANDOCERR_NOTEXT, /* skipping text before the first section header */ |
MANDOCERR_MACRO, /* skipping unknown macro */ |
MANDOCERR_MACRO, /* skipping unknown macro */ |
MANDOCERR_REQUEST, /* NOT IMPLEMENTED: skipping request */ |
MANDOCERR_REQUEST, /* NOT IMPLEMENTED: skipping request */ |
MANDOCERR_LINESCOPE, /* line scope broken */ |
|
MANDOCERR_ARGCOUNT, /* argument count wrong */ |
MANDOCERR_ARGCOUNT, /* argument count wrong */ |
MANDOCERR_NOSCOPE, /* skipping end of block that is not open */ |
MANDOCERR_NOSCOPE, /* skipping end of block that is not open */ |
MANDOCERR_SCOPEBROKEN, /* missing end of block */ |
MANDOCERR_SCOPEBROKEN, /* missing end of block */ |
Line 136 enum mandocerr { |
|
Line 147 enum mandocerr { |
|
|
|
MANDOCERR_FATAL, /* ===== start of fatal errors ===== */ |
MANDOCERR_FATAL, /* ===== start of fatal errors ===== */ |
|
|
|
MANDOCERR_NOTMANUAL, /* manual isn't really a manual */ |
MANDOCERR_COLUMNS, /* column syntax is inconsistent */ |
MANDOCERR_COLUMNS, /* column syntax is inconsistent */ |
MANDOCERR_BADDISP, /* NOT IMPLEMENTED: .Bd -file */ |
MANDOCERR_BADDISP, /* NOT IMPLEMENTED: .Bd -file */ |
MANDOCERR_SYNTLINESCOPE, /* line scope broken, syntax violated */ |
|
MANDOCERR_SYNTARGVCOUNT, /* argument count wrong, violates syntax */ |
MANDOCERR_SYNTARGVCOUNT, /* argument count wrong, violates syntax */ |
MANDOCERR_SYNTCHILD, /* child violates parent syntax */ |
MANDOCERR_SYNTCHILD, /* child violates parent syntax */ |
MANDOCERR_SYNTARGCOUNT, /* argument count wrong, violates syntax */ |
MANDOCERR_SYNTARGCOUNT, /* argument count wrong, violates syntax */ |
Line 268 struct tbl_span { |
|
Line 279 struct tbl_span { |
|
struct tbl_span *next; |
struct tbl_span *next; |
}; |
}; |
|
|
struct eqn { |
enum eqn_boxt { |
size_t sz; |
EQN_ROOT, /* root of parse tree */ |
char *data; |
EQN_TEXT, /* text (number, variable, whatever) */ |
|
EQN_SUBEXPR, /* nested `eqn' subexpression */ |
|
EQN_LIST, /* subexpressions list */ |
|
EQN_MATRIX /* matrix subexpression */ |
}; |
}; |
|
|
/* |
enum eqn_markt { |
* Available registers (set in libroff, accessed elsewhere). |
EQNMARK_NONE = 0, |
*/ |
EQNMARK_DOT, |
enum regs { |
EQNMARK_DOTDOT, |
REG_nS = 0, |
EQNMARK_HAT, |
REG__MAX |
EQNMARK_TILDE, |
|
EQNMARK_VEC, |
|
EQNMARK_DYAD, |
|
EQNMARK_BAR, |
|
EQNMARK_UNDER, |
|
EQNMARK__MAX |
}; |
}; |
|
|
/* |
enum eqn_fontt { |
* A register (struct reg) can consist of many types: this consists of |
EQNFONT_NONE = 0, |
* normalised types from the original string form. |
EQNFONT_ROMAN, |
|
EQNFONT_BOLD, |
|
EQNFONT_FAT, |
|
EQNFONT_ITALIC, |
|
EQNFONT__MAX |
|
}; |
|
|
|
enum eqn_post { |
|
EQNPOS_NONE = 0, |
|
EQNPOS_OVER, |
|
EQNPOS_SUP, |
|
EQNPOS_SUB, |
|
EQNPOS_TO, |
|
EQNPOS_FROM, |
|
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. |
*/ |
*/ |
union regval { |
struct eqn_box { |
unsigned u; /* unsigned integer */ |
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 *parent; /* node sibling */ |
|
char *text; /* text (or NULL) */ |
|
char *left; |
|
char *right; |
|
enum eqn_post pos; /* position of next box */ |
|
enum eqn_markt mark; /* a mark about the box */ |
|
enum eqn_fontt font; /* font of box */ |
|
enum eqn_pilet pile; /* equation piling */ |
}; |
}; |
|
|
/* |
/* |
* A single register entity. If "set" is zero, the value of the |
* An equation consists of a tree of expressions starting at a given |
* register should be the default one, which is per-register. It's |
* line and position. |
* assumed that callers know which type in "v" corresponds to which |
|
* register value. |
|
*/ |
*/ |
struct reg { |
struct eqn { |
int set; /* whether set or not */ |
char *name; /* identifier (or NULL) */ |
union regval v; /* parsed data */ |
struct eqn_box *root; /* root mathematical expression */ |
|
int ln; /* invocation line */ |
|
int pos; /* invocation position */ |
}; |
}; |
|
|
/* |
/* |
* The primary interface to setting register values is in libroff, |
* The type of parse sequence. This value is usually passed via the |
* although libmdoc and libman from time to time will manipulate |
* mandoc(1) command line of -man and -mdoc. It's almost exclusively |
* registers (such as `.Sh SYNOPSIS' enabling REG_nS). |
* -mandoc but the others have been retained for compatibility. |
*/ |
*/ |
struct regset { |
enum mparset { |
struct reg regs[REG__MAX]; |
MPARSE_AUTO, /* magically determine the document type */ |
|
MPARSE_MDOC, /* assume -mdoc */ |
|
MPARSE_MAN /* assume -man */ |
}; |
}; |
|
|
|
enum mandoc_esc { |
|
ESCAPE_ERROR = 0, /* bail! unparsable escape */ |
|
ESCAPE_IGNORE, /* escape to be ignored */ |
|
ESCAPE_SPECIAL, /* a regular special character */ |
|
ESCAPE_FONT, /* a generic font mode */ |
|
ESCAPE_FONTBOLD, /* bold font mode */ |
|
ESCAPE_FONTITALIC, /* italic font mode */ |
|
ESCAPE_FONTROMAN, /* roman font mode */ |
|
ESCAPE_FONTPREV, /* previous font mode */ |
|
ESCAPE_NUMBERED, /* a numbered glyph */ |
|
ESCAPE_UNICODE, /* a unicode codepoint */ |
|
ESCAPE_NOSPACE /* suppress space if the last on a line */ |
|
}; |
|
|
|
typedef void (*mandocmsg)(enum mandocerr, enum mandoclevel, |
|
const char *, int, int, const char *); |
|
|
|
struct mparse; |
|
struct mchars; |
|
struct mdoc; |
|
struct man; |
|
|
__BEGIN_DECLS |
__BEGIN_DECLS |
|
|
/* |
void *mandoc_calloc(size_t, size_t); |
* Callback function for warnings, errors, and fatal errors as they |
enum mandoc_esc mandoc_escape(const char **, const char **, int *); |
* occur in the compilers libroff, libmdoc, and libman. |
void *mandoc_malloc(size_t); |
*/ |
void *mandoc_realloc(void *, size_t); |
typedef int (*mandocmsg)(enum mandocerr, void *, |
char *mandoc_strdup(const char *); |
int, int, const char *); |
char *mandoc_strndup(const char *, size_t); |
|
struct mchars *mchars_alloc(void); |
|
void mchars_free(struct mchars *); |
|
char mchars_num2char(const char *, size_t); |
|
int mchars_num2uc(const char *, size_t); |
|
int mchars_spec2cp(const struct mchars *, |
|
const char *, size_t); |
|
const char *mchars_spec2str(const struct mchars *, |
|
const char *, size_t, size_t *); |
|
struct mparse *mparse_alloc(enum mparset, enum mandoclevel, |
|
mandocmsg, void *, char *); |
|
void mparse_free(struct mparse *); |
|
void mparse_keep(struct mparse *); |
|
enum mandoclevel mparse_readfd(struct mparse *, int, const char *); |
|
enum mandoclevel mparse_readmem(struct mparse *, const void *, size_t, |
|
const char *); |
|
void mparse_reset(struct mparse *); |
|
void mparse_result(struct mparse *, |
|
struct mdoc **, struct man **); |
|
const char *mparse_getkeep(const struct mparse *); |
|
const char *mparse_strerror(enum mandocerr); |
|
const char *mparse_strlevel(enum mandoclevel); |
|
|
__END_DECLS |
__END_DECLS |
|
|