=================================================================== RCS file: /cvs/mandoc/mandoc.h,v retrieving revision 1.68 retrieving revision 1.85 diff -u -p -r1.68 -r1.85 --- mandoc/mandoc.h 2011/03/23 09:47:13 1.68 +++ mandoc/mandoc.h 2011/07/21 13:18:24 1.85 @@ -1,4 +1,4 @@ -/* $Id: mandoc.h,v 1.68 2011/03/23 09:47:13 kristaps Exp $ */ +/* $Id: mandoc.h,v 1.85 2011/07/21 13:18:24 kristaps Exp $ */ /* * Copyright (c) 2010, 2011 Kristaps Dzonsons * @@ -104,8 +104,17 @@ enum mandocerr { MANDOCERR_BADESCAPE, /* unknown escape sequence */ MANDOCERR_BADQUOTE, /* unterminated quoted string */ + /* related to equations */ + MANDOCERR_EQNQUOTE, /* unexpected literal in equation */ + MANDOCERR_ERROR, /* ===== start of errors ===== */ + /* related to equations */ + MANDOCERR_EQNARGS, /* bad equation macro arguments */ + MANDOCERR_EQNNEST, /* too many nested equation defines */ + MANDOCERR_EQNNSCOPE, /* unexpected equation scope closure*/ + MANDOCERR_EQNSCOPE, /* equation scope open on exit */ + /* related to tables */ MANDOCERR_TBL, /* bad table syntax */ MANDOCERR_TBLOPT, /* bad table option */ @@ -270,10 +279,40 @@ struct tbl_span { struct tbl_span *next; }; +enum eqn_boxt { + EQN_ROOT, /* root of parse tree */ + EQN_TEXT, /* text (number, variable, whatever) */ + EQN_SUBEXPR /* nested subexpression */ +}; + +enum eqn_markt { + EQNMARK_NONE = 0, + EQNMARK_DOT, + EQNMARK_DOTDOT, + EQNMARK_HAT, + EQNMARK_TILDE, + EQNMARK_VEC, + EQNMARK_DYAD, + EQNMARK_BAR, + EQNMARK_UNDER, + EQNMARK__MAX +}; + +/* + * A "box" is a parsed mathematical expression as defined by the eqn.7 + * grammar. + */ +struct eqn_box { + enum eqn_boxt type; /* type of node */ + struct eqn_box *child; /* child node */ + struct eqn_box *next; /* next in tree */ + char *text; /* text (or NULL) */ + enum eqn_markt mark; /* whether 'marked' */ +}; + struct eqn { - size_t sz; - char *data; - int line; /* invocation line */ + struct eqn_box *root; /* root mathematical expression */ + int ln; /* invocation line */ int pos; /* invocation position */ }; @@ -288,10 +327,25 @@ enum mparset { 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; @@ -303,10 +357,23 @@ 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); +char *mandoc_strdup(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