version 1.21, 2010/10/02 10:14:37 |
version 1.116, 2014/03/19 21:51:20 |
|
|
/* $Id$ */ |
/* $Id$ */ |
/* |
/* |
* Copyright (c) 2010 Kristaps Dzonsons <kristaps@bsd.lv> |
* Copyright (c) 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv> |
|
* Copyright (c) 2012, 2013, 2014 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 |
|
|
|
|
#define ASCII_NBRSP 31 /* non-breaking space */ |
#define ASCII_NBRSP 31 /* non-breaking space */ |
#define ASCII_HYPH 30 /* breakable hyphen */ |
#define ASCII_HYPH 30 /* breakable hyphen */ |
|
#define ASCII_BREAK 29 /* breakable zero-width space */ |
|
|
__BEGIN_DECLS |
/* |
|
* Status level. This refers to both internal status (i.e., whilst |
|
* running, when warnings/errors are reported) and an indicator of a |
|
* threshold of when to halt (when said internal state exceeds the |
|
* threshold). |
|
*/ |
enum mandoclevel { |
enum mandoclevel { |
MANDOCLEVEL_OK = 0, |
MANDOCLEVEL_OK = 0, |
MANDOCLEVEL_RESERVED, |
MANDOCLEVEL_RESERVED, |
MANDOCLEVEL_WARNING, |
MANDOCLEVEL_WARNING, /* warnings: syntax, whitespace, etc. */ |
MANDOCLEVEL_ERROR, |
MANDOCLEVEL_ERROR, /* input has been thrown away */ |
MANDOCLEVEL_FATAL, |
MANDOCLEVEL_FATAL, /* input is borked */ |
MANDOCLEVEL_BADARG, |
MANDOCLEVEL_BADARG, /* bad argument in invocation */ |
MANDOCLEVEL_SYSERR, |
MANDOCLEVEL_SYSERR, /* system error */ |
MANDOCLEVEL_MAX |
MANDOCLEVEL_MAX |
}; |
}; |
|
|
|
/* |
|
* All possible things that can go wrong within a parse, be it libroff, |
|
* libmdoc, or libman. |
|
*/ |
enum mandocerr { |
enum mandocerr { |
MANDOCERR_OK, |
MANDOCERR_OK, |
|
|
MANDOCERR_WARNING, /* ===== start of warnings ===== */ |
MANDOCERR_WARNING, /* ===== start of warnings ===== */ |
MANDOCERR_UPPERCASE, /* text should be uppercase */ |
|
|
/* related to the prologue */ |
|
MANDOCERR_NOTITLE, /* no title in document */ |
|
MANDOCERR_UPPERCASE, /* document title should be all caps */ |
|
MANDOCERR_BADMSEC, /* unknown manual section */ |
|
MANDOCERR_BADVOLARCH, /* unknown manual volume or arch */ |
|
MANDOCERR_NODATE, /* date missing, using today's date */ |
|
MANDOCERR_BADDATE, /* cannot parse date, using it verbatim */ |
|
MANDOCERR_PROLOGOOO, /* prologue macros out of order */ |
|
MANDOCERR_PROLOGREP, /* duplicate prologue macro */ |
|
MANDOCERR_BADPROLOG, /* macro not allowed in prologue */ |
|
MANDOCERR_BADBODY, /* macro not allowed in body */ |
|
|
|
/* related to document structure */ |
|
MANDOCERR_SO, /* .so is fragile, better use ln(1) */ |
|
MANDOCERR_NAMESECFIRST, /* NAME section must come first */ |
|
MANDOCERR_BADNAMESEC, /* bad NAME section contents */ |
MANDOCERR_SECOOO, /* sections out of conventional order */ |
MANDOCERR_SECOOO, /* sections out of conventional order */ |
MANDOCERR_SECREP, /* section name repeats */ |
MANDOCERR_SECREP, /* duplicate section name */ |
MANDOCERR_PROLOGOOO, /* out of order prologue */ |
MANDOCERR_SECMSEC, /* section header suited to sections ... */ |
MANDOCERR_PROLOGREP, /* repeated prologue entry */ |
|
|
/* related to macros and nesting */ |
|
MANDOCERR_MACROOBS, /* skipping obsolete macro */ |
|
MANDOCERR_IGNPAR, /* skipping paragraph macro */ |
|
MANDOCERR_MOVEPAR, /* moving paragraph macro out of list */ |
|
MANDOCERR_IGNNS, /* skipping no-space macro */ |
|
MANDOCERR_SCOPENEST, /* blocks badly nested */ |
|
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 */ |
|
MANDOCERR_ARGCWARN, /* argument count wrong */ |
|
MANDOCERR_DISPTYPE, /* missing display type */ |
MANDOCERR_LISTFIRST, /* list type must come first */ |
MANDOCERR_LISTFIRST, /* list type must come first */ |
MANDOCERR_BADSTANDARD, /* bad standard */ |
MANDOCERR_NOWIDTHARG, /* tag lists require a width argument */ |
MANDOCERR_BADLIB, /* bad library */ |
MANDOCERR_FONTTYPE, /* missing font type */ |
MANDOCERR_BADTAB, /* tab in non-literal context */ |
MANDOCERR_WNOSCOPE, /* skipping end of block that is not open */ |
MANDOCERR_BADESCAPE, /* bad escape sequence */ |
|
MANDOCERR_BADQUOTE, /* unterminated quoted string */ |
/* related to bad macro arguments */ |
MANDOCERR_NOWIDTHARG, /* argument requires the width argument */ |
MANDOCERR_IGNARGV, /* skipping argument */ |
/* FIXME: merge with MANDOCERR_IGNARGV. */ |
MANDOCERR_ARGVREP, /* duplicate argument */ |
MANDOCERR_WIDTHARG, /* superfluous width argument */ |
MANDOCERR_DISPREP, /* duplicate display type */ |
MANDOCERR_IGNARGV, /* ignoring argument */ |
MANDOCERR_LISTREP, /* duplicate list type */ |
MANDOCERR_BADDATE, /* bad date argument */ |
MANDOCERR_BADATT, /* unknown AT&T UNIX version */ |
|
MANDOCERR_BADBOOL, /* bad Boolean value */ |
|
MANDOCERR_BADFONT, /* unknown font */ |
|
MANDOCERR_BADSTANDARD, /* unknown standard specifier */ |
MANDOCERR_BADWIDTH, /* bad width argument */ |
MANDOCERR_BADWIDTH, /* bad width argument */ |
MANDOCERR_BADMSEC, /* unknown manual section */ |
|
MANDOCERR_SECMSEC, /* section not in conventional manual section */ |
/* related to plain text */ |
|
MANDOCERR_NOBLANKLN, /* blank line in non-literal context */ |
|
MANDOCERR_BADTAB, /* tab in non-literal context */ |
MANDOCERR_EOLNSPACE, /* end of line whitespace */ |
MANDOCERR_EOLNSPACE, /* end of line whitespace */ |
MANDOCERR_SCOPENEST, /* blocks badly nested */ |
MANDOCERR_BADCOMMENT, /* bad comment style */ |
|
MANDOCERR_BADESCAPE, /* unknown escape sequence */ |
|
MANDOCERR_BADQUOTE, /* unterminated quoted string */ |
|
|
|
/* related to equations */ |
|
MANDOCERR_EQNQUOTE, /* unexpected literal in equation */ |
|
|
MANDOCERR_ERROR, /* ===== start of errors ===== */ |
MANDOCERR_ERROR, /* ===== start of errors ===== */ |
MANDOCERR_NAMESECFIRST, /* NAME section must come first */ |
|
MANDOCERR_BADBOOL, /* bad Boolean value */ |
/* related to equations */ |
MANDOCERR_CHILD, /* child violates parent syntax */ |
MANDOCERR_EQNNSCOPE, /* unexpected equation scope closure*/ |
MANDOCERR_BADATT, /* bad AT&T symbol */ |
MANDOCERR_EQNSCOPE, /* equation scope open on exit */ |
MANDOCERR_LISTREP, /* list type repeated */ |
MANDOCERR_EQNBADSCOPE, /* overlapping equation scopes */ |
MANDOCERR_DISPREP, /* display type repeated */ |
MANDOCERR_EQNEOF, /* unexpected end of equation */ |
MANDOCERR_ARGVREP, /* argument repeated */ |
MANDOCERR_EQNSYNT, /* equation syntax error */ |
|
|
|
/* related to tables */ |
|
MANDOCERR_TBL, /* bad table syntax */ |
|
MANDOCERR_TBLOPT, /* bad table option */ |
|
MANDOCERR_TBLLAYOUT, /* bad table layout */ |
|
MANDOCERR_TBLNOLAYOUT, /* no table layout cells specified */ |
|
MANDOCERR_TBLNODATA, /* no table data cells specified */ |
|
MANDOCERR_TBLIGNDATA, /* ignore data in cell */ |
|
MANDOCERR_TBLBLOCK, /* data block still open */ |
|
MANDOCERR_TBLEXTRADAT, /* ignoring extra data cells */ |
|
|
|
MANDOCERR_ROFFLOOP, /* input stack limit exceeded, infinite loop? */ |
|
MANDOCERR_BADCHAR, /* skipping bad character */ |
|
MANDOCERR_NAMESC, /* escaped character not allowed in a name */ |
MANDOCERR_NONAME, /* manual name not yet set */ |
MANDOCERR_NONAME, /* manual name not yet set */ |
MANDOCERR_MACROOBS, /* obsolete macro ignored */ |
MANDOCERR_NOTEXT, /* skipping text before the first section header */ |
MANDOCERR_MACROEMPTY, /* empty macro ignored */ |
MANDOCERR_MACRO, /* skipping unknown macro */ |
MANDOCERR_BADBODY, /* macro not allowed in body */ |
MANDOCERR_REQUEST, /* NOT IMPLEMENTED: skipping request */ |
MANDOCERR_BADPROLOG, /* macro not allowed in prologue */ |
|
MANDOCERR_BADCHAR, /* bad character */ |
|
MANDOCERR_BADNAMESEC, /* bad NAME section contents */ |
|
MANDOCERR_NOBLANKLN, /* no blank lines */ |
|
MANDOCERR_NOTEXT, /* no text in this context */ |
|
MANDOCERR_BADCOMMENT, /* bad comment style */ |
|
MANDOCERR_MACRO, /* unknown macro will be lost */ |
|
MANDOCERR_LINESCOPE, /* line scope broken */ |
|
MANDOCERR_ARGCOUNT, /* argument count wrong */ |
MANDOCERR_ARGCOUNT, /* argument count wrong */ |
MANDOCERR_NOSCOPE, /* no such block is open */ |
MANDOCERR_STRAYTA, /* skipping column outside column list */ |
MANDOCERR_SCOPEREP, /* scope already open */ |
MANDOCERR_NOSCOPE, /* skipping end of block that is not open */ |
|
MANDOCERR_SCOPEBROKEN, /* missing end of block */ |
MANDOCERR_SCOPEEXIT, /* scope open on exit */ |
MANDOCERR_SCOPEEXIT, /* scope open on exit */ |
|
MANDOCERR_UNAME, /* uname(3) system call failed */ |
/* FIXME: merge following with MANDOCERR_ARGCOUNT */ |
/* FIXME: merge following with MANDOCERR_ARGCOUNT */ |
MANDOCERR_NOARGS, /* macro requires line argument(s) */ |
MANDOCERR_NOARGS, /* macro requires line argument(s) */ |
MANDOCERR_NOBODY, /* macro requires body argument(s) */ |
MANDOCERR_NOBODY, /* macro requires body argument(s) */ |
MANDOCERR_NOARGV, /* macro requires argument(s) */ |
MANDOCERR_NOARGV, /* macro requires argument(s) */ |
MANDOCERR_NOTITLE, /* no title in document */ |
MANDOCERR_NUMERIC, /* request requires a numeric argument */ |
MANDOCERR_LISTTYPE, /* missing list type */ |
MANDOCERR_LISTTYPE, /* missing list type */ |
MANDOCERR_DISPTYPE, /* missing display type */ |
|
MANDOCERR_FONTTYPE, /* missing font type */ |
|
MANDOCERR_ARGSLOST, /* line argument(s) will be lost */ |
MANDOCERR_ARGSLOST, /* line argument(s) will be lost */ |
MANDOCERR_BODYLOST, /* body argument(s) will be lost */ |
MANDOCERR_BODYLOST, /* body argument(s) will be lost */ |
MANDOCERR_IGNPAR, /* paragraph macro ignored */ |
|
|
|
MANDOCERR_FATAL, /* ===== start of fatal errors ===== */ |
MANDOCERR_FATAL, /* ===== start of fatal errors ===== */ |
|
|
|
MANDOCERR_TOOLARGE, /* input too large */ |
|
MANDOCERR_NOTMANUAL, /* manual isn't really a manual */ |
MANDOCERR_COLUMNS, /* column syntax is inconsistent */ |
MANDOCERR_COLUMNS, /* column syntax is inconsistent */ |
/* FIXME: this should be a MANDOCERR_ERROR */ |
MANDOCERR_BADDISP, /* NOT IMPLEMENTED: .Bd -file */ |
MANDOCERR_NESTEDDISP, /* displays may not be nested */ |
|
MANDOCERR_BADDISP, /* unsupported display type */ |
|
MANDOCERR_SCOPEFATAL, /* blocks badly nested */ |
|
MANDOCERR_SYNTNOSCOPE, /* no scope to rewind: syntax violated */ |
|
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 */ |
|
MANDOCERR_SOPATH, /* NOT IMPLEMENTED: .so with absolute path or ".." */ |
MANDOCERR_NODOCBODY, /* no document body */ |
MANDOCERR_NODOCBODY, /* no document body */ |
MANDOCERR_NODOCPROLOG, /* no document prologue */ |
MANDOCERR_NODOCPROLOG, /* no document prologue */ |
MANDOCERR_UTSNAME, /* utsname system call failed */ |
|
MANDOCERR_MEM, /* static buffer exhausted */ |
MANDOCERR_MEM, /* static buffer exhausted */ |
MANDOCERR_MAX |
|
}; |
|
|
|
enum regs { |
/* ===== system errors ===== */ |
REG_nS = 0, /* register: nS */ |
|
REG__MAX |
|
}; |
|
|
|
enum mant { |
MANDOCERR_SYSOPEN, /* cannot open file */ |
MAN_br = 0, |
MANDOCERR_SYSSTAT, /* cannot stat file */ |
MAN_TH, |
MANDOCERR_SYSREAD, /* cannot read file */ |
MAN_SH, |
|
MAN_SS, |
|
MAN_TP, |
|
MAN_LP, |
|
MAN_PP, |
|
MAN_P, |
|
MAN_IP, |
|
MAN_HP, |
|
MAN_SM, |
|
MAN_SB, |
|
MAN_BI, |
|
MAN_IB, |
|
MAN_BR, |
|
MAN_RB, |
|
MAN_R, |
|
MAN_B, |
|
MAN_I, |
|
MAN_IR, |
|
MAN_RI, |
|
MAN_na, |
|
MAN_i, |
|
MAN_sp, |
|
MAN_nf, |
|
MAN_fi, |
|
MAN_r, |
|
MAN_RE, |
|
MAN_RS, |
|
MAN_DT, |
|
MAN_UC, |
|
MAN_PD, |
|
MAN_Sp, |
|
MAN_Vb, |
|
MAN_Ve, |
|
MAN_AT, |
|
MAN_in, |
|
MAN_MAX |
|
}; |
|
|
|
enum man_type { |
MANDOCERR_MAX |
MAN_TEXT, |
|
MAN_ELEM, |
|
MAN_ROOT, |
|
MAN_BLOCK, |
|
MAN_HEAD, |
|
MAN_BODY |
|
}; |
}; |
|
|
enum mdoct { |
struct tbl_opts { |
MDOC_Ap = 0, |
char tab; /* cell-separator */ |
MDOC_Dd, |
char decimal; /* decimal point */ |
MDOC_Dt, |
int linesize; |
MDOC_Os, |
int opts; |
MDOC_Sh, |
#define TBL_OPT_CENTRE (1 << 0) |
MDOC_Ss, |
#define TBL_OPT_EXPAND (1 << 1) |
MDOC_Pp, |
#define TBL_OPT_BOX (1 << 2) |
MDOC_D1, |
#define TBL_OPT_DBOX (1 << 3) |
MDOC_Dl, |
#define TBL_OPT_ALLBOX (1 << 4) |
MDOC_Bd, |
#define TBL_OPT_NOKEEP (1 << 5) |
MDOC_Ed, |
#define TBL_OPT_NOSPACE (1 << 6) |
MDOC_Bl, |
int cols; /* number of columns */ |
MDOC_El, |
|
MDOC_It, |
|
MDOC_Ad, |
|
MDOC_An, |
|
MDOC_Ar, |
|
MDOC_Cd, |
|
MDOC_Cm, |
|
MDOC_Dv, |
|
MDOC_Er, |
|
MDOC_Ev, |
|
MDOC_Ex, |
|
MDOC_Fa, |
|
MDOC_Fd, |
|
MDOC_Fl, |
|
MDOC_Fn, |
|
MDOC_Ft, |
|
MDOC_Ic, |
|
MDOC_In, |
|
MDOC_Li, |
|
MDOC_Nd, |
|
MDOC_Nm, |
|
MDOC_Op, |
|
MDOC_Ot, |
|
MDOC_Pa, |
|
MDOC_Rv, |
|
MDOC_St, |
|
MDOC_Va, |
|
MDOC_Vt, |
|
MDOC_Xr, |
|
MDOC__A, |
|
MDOC__B, |
|
MDOC__D, |
|
MDOC__I, |
|
MDOC__J, |
|
MDOC__N, |
|
MDOC__O, |
|
MDOC__P, |
|
MDOC__R, |
|
MDOC__T, |
|
MDOC__V, |
|
MDOC_Ac, |
|
MDOC_Ao, |
|
MDOC_Aq, |
|
MDOC_At, |
|
MDOC_Bc, |
|
MDOC_Bf, |
|
MDOC_Bo, |
|
MDOC_Bq, |
|
MDOC_Bsx, |
|
MDOC_Bx, |
|
MDOC_Db, |
|
MDOC_Dc, |
|
MDOC_Do, |
|
MDOC_Dq, |
|
MDOC_Ec, |
|
MDOC_Ef, |
|
MDOC_Em, |
|
MDOC_Eo, |
|
MDOC_Fx, |
|
MDOC_Ms, |
|
MDOC_No, |
|
MDOC_Ns, |
|
MDOC_Nx, |
|
MDOC_Ox, |
|
MDOC_Pc, |
|
MDOC_Pf, |
|
MDOC_Po, |
|
MDOC_Pq, |
|
MDOC_Qc, |
|
MDOC_Ql, |
|
MDOC_Qo, |
|
MDOC_Qq, |
|
MDOC_Re, |
|
MDOC_Rs, |
|
MDOC_Sc, |
|
MDOC_So, |
|
MDOC_Sq, |
|
MDOC_Sm, |
|
MDOC_Sx, |
|
MDOC_Sy, |
|
MDOC_Tn, |
|
MDOC_Ux, |
|
MDOC_Xc, |
|
MDOC_Xo, |
|
MDOC_Fo, |
|
MDOC_Fc, |
|
MDOC_Oo, |
|
MDOC_Oc, |
|
MDOC_Bk, |
|
MDOC_Ek, |
|
MDOC_Bt, |
|
MDOC_Hf, |
|
MDOC_Fr, |
|
MDOC_Ud, |
|
MDOC_Lb, |
|
MDOC_Lp, |
|
MDOC_Lk, |
|
MDOC_Mt, |
|
MDOC_Brq, |
|
MDOC_Bro, |
|
MDOC_Brc, |
|
MDOC__C, |
|
MDOC_Es, |
|
MDOC_En, |
|
MDOC_Dx, |
|
MDOC__Q, |
|
MDOC_br, |
|
MDOC_sp, |
|
MDOC__U, |
|
MDOC_Ta, |
|
MDOC_MAX |
|
}; |
}; |
|
|
enum mdocargt { |
/* |
MDOC_Split, |
* The head of a table specifies all of its columns. When formatting a |
MDOC_Nosplit, |
* tbl_span, iterate over these and plug in data from the tbl_span when |
MDOC_Ragged, |
* appropriate, using tbl_cell as a guide to placement. |
MDOC_Unfilled, |
*/ |
MDOC_Literal, |
struct tbl_head { |
MDOC_File, |
int ident; /* 0 <= unique id < cols */ |
MDOC_Offset, |
int vert; /* width of preceding vertical line */ |
MDOC_Bullet, |
struct tbl_head *next; |
MDOC_Dash, |
struct tbl_head *prev; |
MDOC_Hyphen, |
|
MDOC_Item, |
|
MDOC_Enum, |
|
MDOC_Tag, |
|
MDOC_Diag, |
|
MDOC_Hang, |
|
MDOC_Ohang, |
|
MDOC_Inset, |
|
MDOC_Column, |
|
MDOC_Width, |
|
MDOC_Compact, |
|
MDOC_Std, |
|
MDOC_Filled, |
|
MDOC_Words, |
|
MDOC_Emphasis, |
|
MDOC_Symbolic, |
|
MDOC_Nested, |
|
MDOC_Centred, |
|
MDOC_ARG_MAX |
|
}; |
}; |
|
|
enum mdoc_type { |
enum tbl_cellt { |
MDOC_TEXT, |
TBL_CELL_CENTRE, /* c, C */ |
MDOC_ELEM, |
TBL_CELL_RIGHT, /* r, R */ |
MDOC_HEAD, |
TBL_CELL_LEFT, /* l, L */ |
MDOC_TAIL, |
TBL_CELL_NUMBER, /* n, N */ |
MDOC_BODY, |
TBL_CELL_SPAN, /* s, S */ |
MDOC_BLOCK, |
TBL_CELL_LONG, /* a, A */ |
MDOC_ROOT |
TBL_CELL_DOWN, /* ^ */ |
|
TBL_CELL_HORIZ, /* _, - */ |
|
TBL_CELL_DHORIZ, /* = */ |
|
TBL_CELL_MAX |
}; |
}; |
|
|
enum mdoc_sec { |
/* |
SEC_NONE, |
* A cell in a layout row. |
SEC_NAME, |
*/ |
SEC_LIBRARY, |
struct tbl_cell { |
SEC_SYNOPSIS, |
struct tbl_cell *next; |
SEC_DESCRIPTION, |
int vert; /* width of preceding vertical line */ |
SEC_IMPLEMENTATION, |
enum tbl_cellt pos; |
SEC_RETURN_VALUES, |
size_t spacing; |
SEC_ENVIRONMENT, |
int flags; |
SEC_FILES, |
#define TBL_CELL_TALIGN (1 << 0) /* t, T */ |
SEC_EXIT_STATUS, |
#define TBL_CELL_BALIGN (1 << 1) /* d, D */ |
SEC_EXAMPLES, |
#define TBL_CELL_BOLD (1 << 2) /* fB, B, b */ |
SEC_DIAGNOSTICS, |
#define TBL_CELL_ITALIC (1 << 3) /* fI, I, i */ |
SEC_COMPATIBILITY, |
#define TBL_CELL_EQUAL (1 << 4) /* e, E */ |
SEC_ERRORS, |
#define TBL_CELL_UP (1 << 5) /* u, U */ |
SEC_SEE_ALSO, |
#define TBL_CELL_WIGN (1 << 6) /* z, Z */ |
SEC_STANDARDS, |
struct tbl_head *head; |
SEC_HISTORY, |
|
SEC_AUTHORS, |
|
SEC_CAVEATS, |
|
SEC_BUGS, |
|
SEC_SECURITY, |
|
SEC_CUSTOM, |
|
SEC__MAX |
|
}; |
}; |
|
|
enum mdoc_endbody { |
/* |
ENDBODY_NOT = 0, |
* A layout row. |
ENDBODY_SPACE, |
*/ |
ENDBODY_NOSPACE |
struct tbl_row { |
|
struct tbl_row *next; |
|
struct tbl_cell *first; |
|
struct tbl_cell *last; |
}; |
}; |
|
|
enum mdoc_list { |
enum tbl_datt { |
LIST__NONE = 0, |
TBL_DATA_NONE, /* has no data */ |
LIST_bullet, |
TBL_DATA_DATA, /* consists of data/string */ |
LIST_column, |
TBL_DATA_HORIZ, /* horizontal line */ |
LIST_dash, |
TBL_DATA_DHORIZ, /* double-horizontal line */ |
LIST_diag, |
TBL_DATA_NHORIZ, /* squeezed horizontal line */ |
LIST_enum, |
TBL_DATA_NDHORIZ /* squeezed double-horizontal line */ |
LIST_hang, |
|
LIST_hyphen, |
|
LIST_inset, |
|
LIST_item, |
|
LIST_ohang, |
|
LIST_tag |
|
}; |
}; |
|
|
enum mdoc_disp { |
/* |
DISP__NONE = 0, |
* A cell within a row of data. The "string" field contains the actual |
DISP_centred, |
* string value that's in the cell. The rest is layout. |
DISP_ragged, |
*/ |
DISP_unfilled, |
struct tbl_dat { |
DISP_filled, |
struct tbl_cell *layout; /* layout cell */ |
DISP_literal |
int spans; /* how many spans follow */ |
|
struct tbl_dat *next; |
|
char *string; /* data (NULL if not TBL_DATA_DATA) */ |
|
enum tbl_datt pos; |
}; |
}; |
|
|
enum mdoc_auth { |
enum tbl_spant { |
AUTH__NONE = 0, |
TBL_SPAN_DATA, /* span consists of data */ |
AUTH_split, |
TBL_SPAN_HORIZ, /* span is horizontal line */ |
AUTH_nosplit |
TBL_SPAN_DHORIZ /* span is double horizontal line */ |
}; |
}; |
|
|
enum mdoc_font { |
/* |
FONT__NONE = 0, |
* A row of data in a table. |
FONT_Em, |
*/ |
FONT_Li, |
struct tbl_span { |
FONT_Sy |
struct tbl_opts *opts; |
|
struct tbl_head *head; |
|
struct tbl_row *layout; /* layout row */ |
|
struct tbl_dat *first; |
|
struct tbl_dat *last; |
|
int line; /* parse line */ |
|
int flags; |
|
#define TBL_SPAN_FIRST (1 << 0) |
|
#define TBL_SPAN_LAST (1 << 1) |
|
enum tbl_spant pos; |
|
struct tbl_span *next; |
}; |
}; |
|
|
struct man_meta { |
enum eqn_boxt { |
char *msec; /* `TH' section (e.g., 1--9) */ |
EQN_ROOT, /* root of parse tree */ |
time_t date; /* parsed `TH' date */ |
EQN_TEXT, /* text (number, variable, whatever) */ |
char *rawdate; /* raw `TH' date */ |
EQN_SUBEXPR, /* nested `eqn' subexpression */ |
char *vol; /* `TH' volume (e.g., KM) */ |
EQN_LIST, /* subexpressions list */ |
char *title; /* `TH' title (e.g., LS, CAT) */ |
EQN_MATRIX /* matrix subexpression */ |
char *source; /* `TH' source (e.g., GNU) */ |
|
}; |
}; |
|
|
struct man_node { |
enum eqn_markt { |
struct man_node *parent; |
EQNMARK_NONE = 0, |
struct man_node *child; |
EQNMARK_DOT, |
struct man_node *next; |
EQNMARK_DOTDOT, |
struct man_node *prev; |
EQNMARK_HAT, |
int nchild; |
EQNMARK_TILDE, |
int line; |
EQNMARK_VEC, |
int pos; |
EQNMARK_DYAD, |
enum mant tok; |
EQNMARK_BAR, |
int flags; |
EQNMARK_UNDER, |
#define MAN_VALID (1 << 0) |
EQNMARK__MAX |
#define MAN_ACTED (1 << 1) |
|
#define MAN_EOS (1 << 2) |
|
enum man_type type; |
|
char *string; |
|
struct man_node *head; |
|
struct man_node *body; |
|
}; |
}; |
|
|
struct mdoc_meta { |
enum eqn_fontt { |
char *msec; /* `Dt' section (e.g., 1--9) */ |
EQNFONT_NONE = 0, |
char *vol; /* `Dt' volume (e.g., LOCAL) */ |
EQNFONT_ROMAN, |
char *arch; /* `Dt' architecture (e.g., i386) */ |
EQNFONT_BOLD, |
time_t date; /* `Dd' date */ |
EQNFONT_FAT, |
char *title; /* `Dt' title (e.g., LS, CAT) */ |
EQNFONT_ITALIC, |
char *os; /* `Os' system (e.g., OpenBSD) */ |
EQNFONT__MAX |
char *name; /* leading `Nm' (e.g., ls, cat) */ |
|
}; |
}; |
|
|
struct mdoc_argv { |
enum eqn_post { |
enum mdocargt arg; |
EQNPOS_NONE = 0, |
int line; |
EQNPOS_OVER, |
int pos; |
EQNPOS_SUP, |
size_t sz; |
EQNPOS_SUB, |
char **value; |
EQNPOS_TO, |
|
EQNPOS_FROM, |
|
EQNPOS__MAX |
}; |
}; |
|
|
struct mdoc_arg { |
enum eqn_pilet { |
size_t argc; |
EQNPILE_NONE = 0, |
struct mdoc_argv *argv; |
EQNPILE_PILE, |
unsigned int refcnt; |
EQNPILE_CPILE, |
|
EQNPILE_RPILE, |
|
EQNPILE_LPILE, |
|
EQNPILE_COL, |
|
EQNPILE_CCOL, |
|
EQNPILE_RCOL, |
|
EQNPILE_LCOL, |
|
EQNPILE__MAX |
}; |
}; |
|
|
|
/* |
struct mdoc_bd { |
* A "box" is a parsed mathematical expression as defined by the eqn.7 |
const char *offs; /* -offset */ |
* grammar. |
enum mdoc_disp type; /* -ragged, etc. */ |
*/ |
int comp; /* -compact */ |
struct eqn_box { |
|
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 */ |
}; |
}; |
|
|
struct mdoc_bl { |
|
const char *width; /* -width */ |
|
const char *offs; /* -offset */ |
|
enum mdoc_list type; /* -tag, -enum, etc. */ |
|
int comp; /* -compact */ |
|
size_t ncols; /* -column arg count */ |
|
const char **cols; /* -column val ptr */ |
|
}; |
|
|
|
struct mdoc_bf { |
|
enum mdoc_font font; /* font */ |
|
}; |
|
|
|
struct mdoc_an { |
|
enum mdoc_auth auth; /* -split, etc. */ |
|
}; |
|
|
|
struct mdoc_node { |
|
struct mdoc_node *parent; /* parent AST node */ |
|
struct mdoc_node *child; /* first child AST node */ |
|
struct mdoc_node *next; /* sibling AST node */ |
|
struct mdoc_node *prev; /* prior sibling AST node */ |
|
int nchild; /* number children */ |
|
int line; /* parse line */ |
|
int pos; /* parse column */ |
|
enum mdoct tok; /* tok or MDOC__MAX if none */ |
|
int flags; |
|
#define MDOC_VALID (1 << 0) /* has been validated */ |
|
#define MDOC_ACTED (1 << 1) /* has been acted upon */ |
|
#define MDOC_EOS (1 << 2) /* at sentence boundary */ |
|
#define MDOC_LINE (1 << 3) /* first macro/text on line */ |
|
#define MDOC_SYNPRETTY (1 << 4) /* SYNOPSIS-style formatting */ |
|
#define MDOC_ENDED (1 << 5) /* rendering has been ended */ |
|
enum mdoc_type type; /* AST node type */ |
|
enum mdoc_sec sec; /* current named section */ |
|
/* XXX: these can be union'd to shave a few bytes. */ |
|
struct mdoc_arg *args; /* BLOCK/ELEM */ |
|
struct mdoc_node *pending; /* BLOCK */ |
|
struct mdoc_node *head; /* BLOCK */ |
|
struct mdoc_node *body; /* BLOCK */ |
|
struct mdoc_node *tail; /* BLOCK */ |
|
char *string; /* TEXT */ |
|
enum mdoc_endbody end; /* BODY */ |
|
|
|
union { |
|
struct mdoc_an An; |
|
struct mdoc_bd *Bd; |
|
struct mdoc_bf *Bf; |
|
struct mdoc_bl *Bl; |
|
} data; |
|
}; |
|
|
|
/* |
/* |
* 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 { |
struct eqn_box *root; /* root mathematical expression */ |
unsigned u; /* unsigned integer */ |
int ln; /* invocation line */ |
} v; |
int pos; /* invocation position */ |
}; |
}; |
|
|
/* |
/* |
* The primary interface to setting register values is in libroff, |
* Parse options. |
* although libmdoc and libman from time to time will manipulate |
|
* registers (such as `.Sh SYNOPSIS' enabling REG_nS). |
|
*/ |
*/ |
struct regset { |
#define MPARSE_MDOC 1 /* assume -mdoc */ |
struct reg regs[REG__MAX]; |
#define MPARSE_MAN 2 /* assume -man */ |
|
#define MPARSE_SO 4 /* honour .so requests */ |
|
#define MPARSE_QUICK 8 /* abort the parse early */ |
|
|
|
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_FONTBI, /* bold 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, |
* Callback function for warnings, errors, and fatal errors as they |
const char *, int, int, const char *); |
* occur in the compilers libroff, libmdoc, and libman. |
|
*/ |
struct mparse; |
typedef int (*mandocmsg)(enum mandocerr, void *, |
struct mchars; |
int, int, const char *); |
struct mdoc; |
|
struct man; |
|
|
|
__BEGIN_DECLS |
|
|
|
void *mandoc_calloc(size_t, size_t); |
|
enum mandoc_esc mandoc_escape(const char **, const char **, int *); |
|
void *mandoc_malloc(size_t); |
|
void *mandoc_realloc(void *, size_t); |
|
char *mandoc_strdup(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(int, enum mandoclevel, mandocmsg, 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 |
|
|