version 1.61, 2011/03/17 12:08:01 |
version 1.106, 2012/11/19 22:30:58 |
|
|
/* $Id$ */ |
/* $Id$ */ |
/* |
/* |
* Copyright (c) 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv> |
* Copyright (c) 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv> |
|
* Copyright (c) 2012 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 |
|
|
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_BADVOLARCH, /* unknown manual volume or arch */ |
MANDOCERR_NODATE, /* date missing, using today's date */ |
MANDOCERR_NODATE, /* date missing, using today's date */ |
MANDOCERR_BADDATE, /* cannot parse date, using it verbatim */ |
MANDOCERR_BADDATE, /* cannot parse date, using it verbatim */ |
MANDOCERR_PROLOGOOO, /* prologue macros out of order */ |
MANDOCERR_PROLOGOOO, /* prologue macros out of order */ |
|
|
MANDOCERR_SO, /* .so is fragile, better use ln(1) */ |
MANDOCERR_SO, /* .so is fragile, better use ln(1) */ |
MANDOCERR_NAMESECFIRST, /* NAME section must come first */ |
MANDOCERR_NAMESECFIRST, /* NAME section must come first */ |
MANDOCERR_BADNAMESEC, /* bad NAME section contents */ |
MANDOCERR_BADNAMESEC, /* bad NAME section contents */ |
MANDOCERR_NONAME, /* manual name not yet set */ |
|
MANDOCERR_SECOOO, /* sections out of conventional order */ |
MANDOCERR_SECOOO, /* sections out of conventional order */ |
MANDOCERR_SECREP, /* duplicate section name */ |
MANDOCERR_SECREP, /* duplicate section name */ |
MANDOCERR_SECMSEC, /* section not in conventional manual section */ |
MANDOCERR_SECMSEC, /* section not in conventional manual section */ |
|
|
/* related to macros and nesting */ |
/* related to macros and nesting */ |
MANDOCERR_MACROOBS, /* skipping obsolete macro */ |
MANDOCERR_MACROOBS, /* skipping obsolete macro */ |
MANDOCERR_IGNPAR, /* skipping paragraph macro */ |
MANDOCERR_IGNPAR, /* skipping paragraph macro */ |
|
MANDOCERR_MOVEPAR, /* moving paragraph macro out of list */ |
MANDOCERR_IGNNS, /* skipping no-space macro */ |
MANDOCERR_IGNNS, /* skipping no-space macro */ |
MANDOCERR_SCOPENEST, /* blocks badly nested */ |
MANDOCERR_SCOPENEST, /* blocks badly nested */ |
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 103 enum mandocerr { |
|
Line 106 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 118 enum mandocerr { |
|
Line 131 enum mandocerr { |
|
MANDOCERR_ROFFLOOP, /* input stack limit exceeded, infinite loop? */ |
MANDOCERR_ROFFLOOP, /* input stack limit exceeded, infinite loop? */ |
MANDOCERR_BADCHAR, /* skipping bad character */ |
MANDOCERR_BADCHAR, /* skipping bad character */ |
MANDOCERR_NAMESC, /* escaped character not allowed in a name */ |
MANDOCERR_NAMESC, /* escaped character not allowed in a name */ |
|
MANDOCERR_NONAME, /* manual name not yet set */ |
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_STRAYTA, /* skipping column outside column list */ |
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 */ |
MANDOCERR_SCOPEEXIT, /* scope open on exit */ |
MANDOCERR_SCOPEEXIT, /* scope open on exit */ |
Line 137 enum mandocerr { |
|
Line 151 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 */ |
|
|
int cols; /* number of columns */ |
int cols; /* number of columns */ |
}; |
}; |
|
|
enum tbl_headt { |
|
TBL_HEAD_DATA, /* plug in data from tbl_dat */ |
|
TBL_HEAD_VERT, /* vertical spacer */ |
|
TBL_HEAD_DVERT /* double-vertical spacer */ |
|
}; |
|
|
|
/* |
/* |
* The head of a table specifies all of its columns. When formatting a |
* The head of a table specifies all of its columns. When formatting a |
* tbl_span, iterate over these and plug in data from the tbl_span when |
* tbl_span, iterate over these and plug in data from the tbl_span when |
* appropriate, using tbl_cell as a guide to placement. |
* appropriate, using tbl_cell as a guide to placement. |
*/ |
*/ |
struct tbl_head { |
struct tbl_head { |
enum tbl_headt pos; |
|
int ident; /* 0 <= unique id < cols */ |
int ident; /* 0 <= unique id < cols */ |
|
int vert; /* width of preceding vertical line */ |
struct tbl_head *next; |
struct tbl_head *next; |
struct tbl_head *prev; |
struct tbl_head *prev; |
}; |
}; |
Line 193 enum tbl_cellt { |
|
Line 201 enum tbl_cellt { |
|
TBL_CELL_DOWN, /* ^ */ |
TBL_CELL_DOWN, /* ^ */ |
TBL_CELL_HORIZ, /* _, - */ |
TBL_CELL_HORIZ, /* _, - */ |
TBL_CELL_DHORIZ, /* = */ |
TBL_CELL_DHORIZ, /* = */ |
TBL_CELL_VERT, /* | */ |
|
TBL_CELL_DVERT, /* || */ |
|
TBL_CELL_MAX |
TBL_CELL_MAX |
}; |
}; |
|
|
Line 203 enum tbl_cellt { |
|
Line 209 enum tbl_cellt { |
|
*/ |
*/ |
struct tbl_cell { |
struct tbl_cell { |
struct tbl_cell *next; |
struct tbl_cell *next; |
|
int vert; /* width of preceding vertical line */ |
enum tbl_cellt pos; |
enum tbl_cellt pos; |
size_t spacing; |
size_t spacing; |
int flags; |
int flags; |
Line 269 struct tbl_span { |
|
Line 276 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) */ |
int line; /* invocation line */ |
EQN_SUBEXPR, /* nested `eqn' subexpression */ |
int pos; /* invocation position */ |
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, |
union regval { |
EQNFONT_FAT, |
unsigned u; /* unsigned integer */ |
EQNFONT_ITALIC, |
|
EQNFONT__MAX |
}; |
}; |
|
|
/* |
enum eqn_post { |
* A single register entity. If "set" is zero, the value of the |
EQNPOS_NONE = 0, |
* register should be the default one, which is per-register. It's |
EQNPOS_OVER, |
* assumed that callers know which type in "v" corresponds to which |
EQNPOS_SUP, |
* register value. |
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. |
*/ |
*/ |
struct reg { |
struct eqn_box { |
int set; /* whether set or not */ |
int size; /* font size of expression */ |
union regval v; /* parsed data */ |
#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 */ |
}; |
}; |
|
|
/* |
/* |
* The primary interface to setting register values is in libroff, |
* An equation consists of a tree of expressions starting at a given |
* although libmdoc and libman from time to time will manipulate |
* line and position. |
* registers (such as `.Sh SYNOPSIS' enabling REG_nS). |
|
*/ |
*/ |
struct regset { |
struct eqn { |
struct reg regs[REG__MAX]; |
char *name; /* identifier (or NULL) */ |
|
struct eqn_box *root; /* root mathematical expression */ |
|
int ln; /* invocation line */ |
|
int pos; /* invocation position */ |
}; |
}; |
|
|
/* |
/* |
* A punctuation delimiter, used only in mdoc(7) documents, is opening, |
* The type of parse sequence. This value is usually passed via the |
* closing, or "middle mark" punctuation. These govern spacing. |
* mandoc(1) command line of -man and -mdoc. It's almost exclusively |
* Opening punctuation (e.g., the opening parenthesis) suppresses the |
* -mandoc but the others have been retained for compatibility. |
* 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 { |
enum mparset { |
DELIM_NONE = 0, |
MPARSE_AUTO, /* magically determine the document type */ |
DELIM_OPEN, |
MPARSE_MDOC, /* assume -mdoc */ |
DELIM_MIDDLE, |
MPARSE_MAN /* assume -man */ |
DELIM_CLOSE |
|
}; |
}; |
|
|
typedef void (*mandocmsg)(enum mandocerr, void *, |
enum mandoc_esc { |
int, int, const char *); |
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 */ |
|
ESCAPE_SKIPCHAR /* skip the next character */ |
|
}; |
|
|
|
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); |
void *mandoc_calloc(size_t, size_t); |
|
enum mandoc_esc mandoc_escape(const char **, const char **, int *); |
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 *); |
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 |
|
|