version 1.63, 2011/03/20 16:02:05 |
version 1.78, 2011/07/15 10:14:12 |
|
|
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 121 enum mandocerr { |
|
Line 122 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 137 enum mandocerr { |
|
Line 137 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_SYNTLINESCOPE, /* line scope broken, syntax violated */ |
|
|
}; |
}; |
|
|
/* |
/* |
* Available registers (set in libroff, accessed elsewhere). |
|
*/ |
|
enum regs { |
|
REG_nS = 0, |
|
REG__MAX |
|
}; |
|
|
|
/* |
|
* A register (struct reg) can consist of many types: this consists of |
|
* normalised types from the original string form. |
|
*/ |
|
union regval { |
|
unsigned u; /* unsigned integer */ |
|
}; |
|
|
|
/* |
|
* A single register entity. If "set" is zero, the value of the |
|
* register should be the default one, which is per-register. It's |
|
* assumed that callers know which type in "v" corresponds to which |
|
* register value. |
|
*/ |
|
struct reg { |
|
int set; /* whether set or not */ |
|
union regval v; /* parsed data */ |
|
}; |
|
|
|
/* |
|
* The primary interface to setting register values is in libroff, |
|
* although libmdoc and libman from time to time will manipulate |
|
* registers (such as `.Sh SYNOPSIS' enabling REG_nS). |
|
*/ |
|
struct regset { |
|
struct reg regs[REG__MAX]; |
|
}; |
|
|
|
/* |
|
* A punctuation delimiter, used only in mdoc(7) documents, is opening, |
|
* closing, or "middle mark" punctuation. These govern spacing. |
|
* Opening punctuation (e.g., the opening parenthesis) suppresses the |
|
* following space; closing punctuation (e.g., the closing parenthesis) |
|
* suppresses the leading space; middle punctuation (e.g., the vertical |
|
* bar) can do either. The middle punctuation delimiter bends the rules |
|
* depending on usage. |
|
*/ |
|
enum mdelim { |
|
DELIM_NONE = 0, |
|
DELIM_OPEN, |
|
DELIM_MIDDLE, |
|
DELIM_CLOSE |
|
}; |
|
|
|
/* |
|
* The type of parse sequence. This value is usually passed via the |
* The type of parse sequence. This value is usually passed via the |
* mandoc(1) command line of -man and -mdoc. It's almost exclusively |
* mandoc(1) command line of -man and -mdoc. It's almost exclusively |
* -mandoc but the others have been retained for compatibility. |
* -mandoc but the others have been retained for compatibility. |
|
|
MPARSE_MAN /* assume -man */ |
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, |
typedef void (*mandocmsg)(enum mandocerr, enum mandoclevel, |
const char *, int, int, const char *); |
const char *, int, int, const char *); |
typedef int (*mevt_open)(void *, const char *); |
|
typedef void (*mevt_close)(void *, const char *); |
|
|
|
struct mparse; |
struct mparse; |
|
struct mchars; |
struct mdoc; |
struct mdoc; |
struct man; |
struct man; |
|
|
|
|
|
|
void mparse_free(struct mparse *); |
void mparse_free(struct mparse *); |
void mparse_reset(struct mparse *); |
void mparse_reset(struct mparse *); |
struct mparse *mparse_alloc(enum mparset, mevt_open, |
struct mparse *mparse_alloc(enum mparset, |
mevt_close, |
|
enum mandoclevel, mandocmsg, void *); |
enum mandoclevel, mandocmsg, void *); |
enum mandoclevel mparse_readfd(struct mparse *, int, const char *); |
enum mandoclevel mparse_readfd(struct mparse *, int, const char *); |
void mparse_result(struct mparse *, struct mdoc **, struct man **); |
void mparse_result(struct mparse *, struct mdoc **, struct man **); |
|
const char *mparse_strerror(enum mandocerr); |
|
const char *mparse_strlevel(enum mandoclevel); |
|
|
void *mandoc_calloc(size_t, size_t); |
void *mandoc_calloc(size_t, size_t); |
void *mandoc_malloc(size_t); |
void *mandoc_malloc(size_t); |
void *mandoc_realloc(void *, size_t); |
void *mandoc_realloc(void *, size_t); |
#define DELIMSZ 6 /* hint: max possible size of a delimiter */ |
char *mandoc_strdup(const char *); |
enum mdelim mandoc_isdelim(const char *); |
|
|
enum mandoc_esc mandoc_escape(const char **, const char **, int *); |
|
|
|
struct mchars *mchars_alloc(void); |
|
char mchars_num2char(const char *, size_t); |
|
int mchars_num2uc(const char *, size_t); |
|
const char *mchars_spec2str(struct mchars *, const char *, size_t, size_t *); |
|
int mchars_spec2cp(struct mchars *, const char *, size_t); |
|
void mchars_free(struct mchars *); |
|
|
|
|
__END_DECLS |
__END_DECLS |
|
|