=================================================================== RCS file: /cvs/mandoc/mandoc.h,v retrieving revision 1.62 retrieving revision 1.74 diff -u -p -r1.62 -r1.74 --- mandoc/mandoc.h 2011/03/20 11:41:24 1.62 +++ mandoc/mandoc.h 2011/04/30 22:24:31 1.74 @@ -1,4 +1,4 @@ -/* $Id: mandoc.h,v 1.62 2011/03/20 11:41:24 kristaps Exp $ */ +/* $Id: mandoc.h,v 1.74 2011/04/30 22:24:31 kristaps Exp $ */ /* * Copyright (c) 2010, 2011 Kristaps Dzonsons * @@ -74,6 +74,7 @@ enum mandocerr { MANDOCERR_CHILD, /* child violates parent syntax */ MANDOCERR_NESTEDDISP, /* nested displays are not portable */ MANDOCERR_SCOPEREP, /* already in literal mode */ + MANDOCERR_LINESCOPE, /* line scope broken */ /* related to missing macro arguments */ MANDOCERR_MACROEMPTY, /* skipping empty macro */ @@ -121,7 +122,6 @@ enum mandocerr { MANDOCERR_NOTEXT, /* skipping text before the first section header */ MANDOCERR_MACRO, /* skipping unknown macro */ MANDOCERR_REQUEST, /* NOT IMPLEMENTED: skipping request */ - MANDOCERR_LINESCOPE, /* line scope broken */ MANDOCERR_ARGCOUNT, /* argument count wrong */ MANDOCERR_NOSCOPE, /* skipping end of block that is not open */ MANDOCERR_SCOPEBROKEN, /* missing end of block */ @@ -137,6 +137,7 @@ enum mandocerr { MANDOCERR_FATAL, /* ===== start of fatal errors ===== */ + MANDOCERR_NOTMANUAL, /* manual isn't really a manual */ MANDOCERR_COLUMNS, /* column syntax is inconsistent */ MANDOCERR_BADDISP, /* NOT IMPLEMENTED: .Bd -file */ MANDOCERR_SYNTLINESCOPE, /* line scope broken, syntax violated */ @@ -277,58 +278,6 @@ struct eqn { }; /* - * 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 * mandoc(1) command line of -man and -mdoc. It's almost exclusively * -mandoc but the others have been retained for compatibility. @@ -339,12 +288,25 @@ enum mparset { MPARSE_MAN /* assume -man */ }; -typedef void (*mandocmsg)(enum mandocerr, void *, - int, int, const char *); -typedef int (*mevt_open)(void *, const char *); -typedef void (*mevt_close)(void *, const char *); +enum mandoc_esc { + ESCAPE_ERROR = 0, /* bail! unparsable escape */ + ESCAPE_IGNORE, /* escape to be ignored */ + ESCAPE_SPECIAL, /* a regular special character */ + ESCAPE_PREDEF, /* a predefined 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_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; @@ -352,17 +314,27 @@ __BEGIN_DECLS void mparse_free(struct mparse *); void mparse_reset(struct mparse *); -struct mparse *mparse_alloc(enum mparset, mevt_open, - mevt_close, mandocmsg, void *); -void mparse_setstatus(struct mparse *, enum mandoclevel); +struct mparse *mparse_alloc(enum mparset, + enum mandoclevel, mandocmsg, void *); enum mandoclevel mparse_readfd(struct mparse *, int, const char *); 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_malloc(size_t); void *mandoc_realloc(void *, size_t); -#define DELIMSZ 6 /* hint: max possible size of a delimiter */ -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); +const char *mchars_spec2str(struct mchars *, const char *, size_t, size_t *); +int mchars_spec2cp(struct mchars *, const char *, size_t); +const char *mchars_res2str(struct mchars *, const char *, size_t, size_t *); +int mchars_res2cp(struct mchars *, const char *, size_t); +void mchars_free(struct mchars *); + __END_DECLS