version 1.21, 2010/10/02 10:14:37 |
version 1.269, 2020/09/01 18:25:27 |
|
|
/* $Id$ */ |
/* $Id$ */ |
/* |
/* |
* Copyright (c) 2010 Kristaps Dzonsons <kristaps@bsd.lv> |
* Copyright (c) 2012-2020 Ingo Schwarze <schwarze@openbsd.org> |
|
* Copyright (c) 2010, 2011, 2014 Kristaps Dzonsons <kristaps@bsd.lv> |
* |
* |
* 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 |
* copyright notice and this permission notice appear in all copies. |
* copyright notice and this permission notice appear in all copies. |
* |
* |
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES |
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES |
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF |
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF |
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR |
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR |
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES |
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES |
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN |
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN |
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
|
* |
|
* Error handling, escape sequence, and character utilities. |
|
* Can be used by all code in the mandoc package. |
*/ |
*/ |
#ifndef MANDOC_H |
|
#define MANDOC_H |
|
|
|
#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_STYLE, /* style suggestions */ |
MANDOCLEVEL_WARNING, |
MANDOCLEVEL_WARNING, /* warnings: syntax, whitespace, etc. */ |
MANDOCLEVEL_ERROR, |
MANDOCLEVEL_ERROR, /* input has been thrown away */ |
MANDOCLEVEL_FATAL, |
MANDOCLEVEL_UNSUPP, /* input needs unimplemented features */ |
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_BASE, /* ===== start of base system conventions ===== */ |
MANDOCERR_UPPERCASE, /* text should be uppercase */ |
|
MANDOCERR_SECOOO, /* sections out of conventional order */ |
|
MANDOCERR_SECREP, /* section name repeats */ |
|
MANDOCERR_PROLOGOOO, /* out of order prologue */ |
|
MANDOCERR_PROLOGREP, /* repeated prologue entry */ |
|
MANDOCERR_LISTFIRST, /* list type must come first */ |
|
MANDOCERR_BADSTANDARD, /* bad standard */ |
|
MANDOCERR_BADLIB, /* bad library */ |
|
MANDOCERR_BADTAB, /* tab in non-literal context */ |
|
MANDOCERR_BADESCAPE, /* bad escape sequence */ |
|
MANDOCERR_BADQUOTE, /* unterminated quoted string */ |
|
MANDOCERR_NOWIDTHARG, /* argument requires the width argument */ |
|
/* FIXME: merge with MANDOCERR_IGNARGV. */ |
|
MANDOCERR_WIDTHARG, /* superfluous width argument */ |
|
MANDOCERR_IGNARGV, /* ignoring argument */ |
|
MANDOCERR_BADDATE, /* bad date argument */ |
|
MANDOCERR_BADWIDTH, /* bad width argument */ |
|
MANDOCERR_BADMSEC, /* unknown manual section */ |
|
MANDOCERR_SECMSEC, /* section not in conventional manual section */ |
|
MANDOCERR_EOLNSPACE, /* end of line whitespace */ |
|
MANDOCERR_SCOPENEST, /* blocks badly nested */ |
|
|
|
MANDOCERR_ERROR, /* ===== start of errors ===== */ |
MANDOCERR_MDOCDATE, /* Mdocdate found: Dd ... */ |
MANDOCERR_NAMESECFIRST, /* NAME section must come first */ |
MANDOCERR_MDOCDATE_MISSING, /* Mdocdate missing: Dd ... */ |
MANDOCERR_BADBOOL, /* bad Boolean value */ |
MANDOCERR_ARCH_BAD, /* unknown architecture: Dt ... arch */ |
MANDOCERR_CHILD, /* child violates parent syntax */ |
MANDOCERR_OS_ARG, /* operating system explicitly specified: Os ... */ |
MANDOCERR_BADATT, /* bad AT&T symbol */ |
MANDOCERR_RCS_MISSING, /* RCS id missing */ |
MANDOCERR_LISTREP, /* list type repeated */ |
MANDOCERR_XR_BAD, /* referenced manual not found: Xr name sec */ |
MANDOCERR_DISPREP, /* display type repeated */ |
|
MANDOCERR_ARGVREP, /* argument repeated */ |
|
MANDOCERR_NONAME, /* manual name not yet set */ |
|
MANDOCERR_MACROOBS, /* obsolete macro ignored */ |
|
MANDOCERR_MACROEMPTY, /* empty macro ignored */ |
|
MANDOCERR_BADBODY, /* macro not allowed in body */ |
|
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_NOSCOPE, /* no such block is open */ |
|
MANDOCERR_SCOPEREP, /* scope already open */ |
|
MANDOCERR_SCOPEEXIT, /* scope open on exit */ |
|
/* FIXME: merge following with MANDOCERR_ARGCOUNT */ |
|
MANDOCERR_NOARGS, /* macro requires line argument(s) */ |
|
MANDOCERR_NOBODY, /* macro requires body argument(s) */ |
|
MANDOCERR_NOARGV, /* macro requires argument(s) */ |
|
MANDOCERR_NOTITLE, /* no title in document */ |
|
MANDOCERR_LISTTYPE, /* missing list type */ |
|
MANDOCERR_DISPTYPE, /* missing display type */ |
|
MANDOCERR_FONTTYPE, /* missing font type */ |
|
MANDOCERR_ARGSLOST, /* line 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_STYLE, /* ===== start of style suggestions ===== */ |
MANDOCERR_COLUMNS, /* column syntax is inconsistent */ |
|
/* FIXME: this should be a MANDOCERR_ERROR */ |
|
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_SYNTCHILD, /* child violates parent syntax */ |
|
MANDOCERR_SYNTARGCOUNT, /* argument count wrong, violates syntax */ |
|
MANDOCERR_NODOCBODY, /* no document body */ |
|
MANDOCERR_NODOCPROLOG, /* no document prologue */ |
|
MANDOCERR_UTSNAME, /* utsname system call failed */ |
|
MANDOCERR_MEM, /* static buffer exhausted */ |
|
MANDOCERR_MAX |
|
}; |
|
|
|
enum regs { |
MANDOCERR_DATE_LEGACY, /* legacy man(7) date format: Dd ... */ |
REG_nS = 0, /* register: nS */ |
MANDOCERR_DATE_NORM, /* normalizing date format to: ... */ |
REG__MAX |
MANDOCERR_TITLE_CASE, /* lower case character in document title */ |
}; |
MANDOCERR_RCS_REP, /* duplicate RCS id: ... */ |
|
MANDOCERR_SEC_TYPO, /* possible typo in section name: Sh ... */ |
|
MANDOCERR_ARG_QUOTE, /* unterminated quoted argument */ |
|
MANDOCERR_MACRO_USELESS, /* useless macro: macro */ |
|
MANDOCERR_BX, /* consider using OS macro: macro */ |
|
MANDOCERR_ER_ORDER, /* errnos out of order: Er ... */ |
|
MANDOCERR_ER_REP, /* duplicate errno: Er ... */ |
|
MANDOCERR_DELIM, /* trailing delimiter: macro ... */ |
|
MANDOCERR_DELIM_NB, /* no blank before trailing delimiter: macro ... */ |
|
MANDOCERR_FI_SKIP, /* fill mode already enabled, skipping: fi */ |
|
MANDOCERR_NF_SKIP, /* fill mode already disabled, skipping: nf */ |
|
MANDOCERR_DASHDASH, /* verbatim "--", maybe consider using \(em */ |
|
MANDOCERR_FUNC, /* function name without markup: name() */ |
|
MANDOCERR_SPACE_EOL, /* whitespace at end of input line */ |
|
MANDOCERR_COMMENT_BAD, /* bad comment style */ |
|
|
enum mant { |
MANDOCERR_WARNING, /* ===== start of warnings ===== */ |
MAN_br = 0, |
|
MAN_TH, |
|
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 { |
/* related to the prologue */ |
MAN_TEXT, |
MANDOCERR_DT_NOTITLE, /* missing manual title, using UNTITLED: line */ |
MAN_ELEM, |
MANDOCERR_TH_NOTITLE, /* missing manual title, using "": [macro] */ |
MAN_ROOT, |
MANDOCERR_MSEC_MISSING, /* missing manual section, using "": macro */ |
MAN_BLOCK, |
MANDOCERR_MSEC_BAD, /* unknown manual section: Dt ... section */ |
MAN_HEAD, |
MANDOCERR_MSEC_FILE, /* filename/section mismatch: ... */ |
MAN_BODY |
MANDOCERR_DATE_MISSING, /* missing date, using "": [macro] */ |
}; |
MANDOCERR_DATE_BAD, /* cannot parse date, using it verbatim: date */ |
|
MANDOCERR_DATE_FUTURE, /* date in the future, using it anyway: date */ |
|
MANDOCERR_OS_MISSING, /* missing Os macro, using "" */ |
|
MANDOCERR_PROLOG_LATE, /* late prologue macro: macro */ |
|
MANDOCERR_PROLOG_ORDER, /* prologue macros out of order: macros */ |
|
|
enum mdoct { |
/* related to document structure */ |
MDOC_Ap = 0, |
MANDOCERR_SO, /* .so is fragile, better use ln(1): so path */ |
MDOC_Dd, |
MANDOCERR_DOC_EMPTY, /* no document body */ |
MDOC_Dt, |
MANDOCERR_SEC_BEFORE, /* content before first section header: macro */ |
MDOC_Os, |
MANDOCERR_NAMESEC_FIRST, /* first section is not NAME: Sh title */ |
MDOC_Sh, |
MANDOCERR_NAMESEC_NONM, /* NAME section without Nm before Nd */ |
MDOC_Ss, |
MANDOCERR_NAMESEC_NOND, /* NAME section without description */ |
MDOC_Pp, |
MANDOCERR_NAMESEC_ND, /* description not at the end of NAME */ |
MDOC_D1, |
MANDOCERR_NAMESEC_BAD, /* bad NAME section content: macro */ |
MDOC_Dl, |
MANDOCERR_NAMESEC_PUNCT, /* missing comma before name: Nm name */ |
MDOC_Bd, |
MANDOCERR_ND_EMPTY, /* missing description line, using "" */ |
MDOC_Ed, |
MANDOCERR_ND_LATE, /* description line outside NAME section */ |
MDOC_Bl, |
MANDOCERR_SEC_ORDER, /* sections out of conventional order: Sh title */ |
MDOC_El, |
MANDOCERR_SEC_REP, /* duplicate section title: Sh title */ |
MDOC_It, |
MANDOCERR_SEC_MSEC, /* unexpected section: Sh title for ... only */ |
MDOC_Ad, |
MANDOCERR_XR_SELF, /* cross reference to self: Xr name sec */ |
MDOC_An, |
MANDOCERR_XR_ORDER, /* unusual Xr order: ... after ... */ |
MDOC_Ar, |
MANDOCERR_XR_PUNCT, /* unusual Xr punctuation: ... after ... */ |
MDOC_Cd, |
MANDOCERR_AN_MISSING, /* AUTHORS section without An macro */ |
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 { |
/* related to macros and nesting */ |
MDOC_Split, |
MANDOCERR_MACRO_OBS, /* obsolete macro: macro */ |
MDOC_Nosplit, |
MANDOCERR_MACRO_CALL, /* macro neither callable nor escaped: macro */ |
MDOC_Ragged, |
MANDOCERR_PAR_SKIP, /* skipping paragraph macro: macro ... */ |
MDOC_Unfilled, |
MANDOCERR_PAR_MOVE, /* moving paragraph macro out of list: macro */ |
MDOC_Literal, |
MANDOCERR_NS_SKIP, /* skipping no-space macro */ |
MDOC_File, |
MANDOCERR_BLK_NEST, /* blocks badly nested: macro ... */ |
MDOC_Offset, |
MANDOCERR_BD_NEST, /* nested displays are not portable: macro ... */ |
MDOC_Bullet, |
MANDOCERR_BL_MOVE, /* moving content out of list: macro */ |
MDOC_Dash, |
MANDOCERR_TA_LINE, /* first macro on line: Ta */ |
MDOC_Hyphen, |
MANDOCERR_BLK_LINE, /* line scope broken: macro breaks macro */ |
MDOC_Item, |
MANDOCERR_BLK_BLANK, /* skipping blank line in line scope */ |
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 { |
/* related to missing arguments */ |
MDOC_TEXT, |
MANDOCERR_REQ_EMPTY, /* skipping empty request: request */ |
MDOC_ELEM, |
MANDOCERR_COND_EMPTY, /* conditional request controls empty scope */ |
MDOC_HEAD, |
MANDOCERR_MACRO_EMPTY, /* skipping empty macro: macro */ |
MDOC_TAIL, |
MANDOCERR_BLK_EMPTY, /* empty block: macro */ |
MDOC_BODY, |
MANDOCERR_ARG_EMPTY, /* empty argument, using 0n: macro arg */ |
MDOC_BLOCK, |
MANDOCERR_BD_NOTYPE, /* missing display type, using -ragged: Bd */ |
MDOC_ROOT |
MANDOCERR_BL_LATETYPE, /* list type is not the first argument: Bl arg */ |
}; |
MANDOCERR_BL_NOWIDTH, /* missing -width in -tag list, using 6n */ |
|
MANDOCERR_EX_NONAME, /* missing utility name, using "": Ex */ |
|
MANDOCERR_FO_NOHEAD, /* missing function name, using "": Fo */ |
|
MANDOCERR_IT_NOHEAD, /* empty head in list item: Bl -type It */ |
|
MANDOCERR_IT_NOBODY, /* empty list item: Bl -type It */ |
|
MANDOCERR_IT_NOARG, /* missing argument, using next line: Bl -c It */ |
|
MANDOCERR_BF_NOFONT, /* missing font type, using \fR: Bf */ |
|
MANDOCERR_BF_BADFONT, /* unknown font type, using \fR: Bf font */ |
|
MANDOCERR_PF_SKIP, /* nothing follows prefix: Pf arg */ |
|
MANDOCERR_RS_EMPTY, /* empty reference block: Rs */ |
|
MANDOCERR_XR_NOSEC, /* missing section argument: Xr arg */ |
|
MANDOCERR_ARG_STD, /* missing -std argument, adding it: macro */ |
|
MANDOCERR_OP_EMPTY, /* missing option string, using "": OP */ |
|
MANDOCERR_UR_NOHEAD, /* missing resource identifier, using "": UR */ |
|
MANDOCERR_EQN_NOBOX, /* missing eqn box, using "": op */ |
|
|
enum mdoc_sec { |
/* related to bad arguments */ |
SEC_NONE, |
MANDOCERR_ARG_REP, /* duplicate argument: macro arg */ |
SEC_NAME, |
MANDOCERR_AN_REP, /* skipping duplicate argument: An -arg */ |
SEC_LIBRARY, |
MANDOCERR_BD_REP, /* skipping duplicate display type: Bd -type */ |
SEC_SYNOPSIS, |
MANDOCERR_BL_REP, /* skipping duplicate list type: Bl -type */ |
SEC_DESCRIPTION, |
MANDOCERR_BL_SKIPW, /* skipping -width argument: Bl -type */ |
SEC_IMPLEMENTATION, |
MANDOCERR_BL_COL, /* wrong number of cells */ |
SEC_RETURN_VALUES, |
MANDOCERR_AT_BAD, /* unknown AT&T UNIX version: At version */ |
SEC_ENVIRONMENT, |
MANDOCERR_FA_COMMA, /* comma in function argument: arg */ |
SEC_FILES, |
MANDOCERR_FN_PAREN, /* parenthesis in function name: arg */ |
SEC_EXIT_STATUS, |
MANDOCERR_LB_BAD, /* unknown library name: Lb ... */ |
SEC_EXAMPLES, |
MANDOCERR_RS_BAD, /* invalid content in Rs block: macro */ |
SEC_DIAGNOSTICS, |
MANDOCERR_SM_BAD, /* invalid Boolean argument: macro arg */ |
SEC_COMPATIBILITY, |
MANDOCERR_CHAR_FONT, /* argument contains two font escapes */ |
SEC_ERRORS, |
MANDOCERR_FT_BAD, /* unknown font, skipping request: ft font */ |
SEC_SEE_ALSO, |
MANDOCERR_TR_ODD, /* odd number of characters in request: tr char */ |
SEC_STANDARDS, |
|
SEC_HISTORY, |
|
SEC_AUTHORS, |
|
SEC_CAVEATS, |
|
SEC_BUGS, |
|
SEC_SECURITY, |
|
SEC_CUSTOM, |
|
SEC__MAX |
|
}; |
|
|
|
enum mdoc_endbody { |
/* related to plain text */ |
ENDBODY_NOT = 0, |
MANDOCERR_FI_BLANK, /* blank line in fill mode, using .sp */ |
ENDBODY_SPACE, |
MANDOCERR_FI_TAB, /* tab in filled text */ |
ENDBODY_NOSPACE |
MANDOCERR_EOS, /* new sentence, new line */ |
}; |
MANDOCERR_ESC_BAD, /* invalid escape sequence: esc */ |
|
MANDOCERR_ESC_UNDEF, /* undefined escape, printing literally: char */ |
|
MANDOCERR_STR_UNDEF, /* undefined string, using "": name */ |
|
|
enum mdoc_list { |
/* related to tables */ |
LIST__NONE = 0, |
MANDOCERR_TBLLAYOUT_SPAN, /* tbl line starts with span */ |
LIST_bullet, |
MANDOCERR_TBLLAYOUT_DOWN, /* tbl column starts with span */ |
LIST_column, |
MANDOCERR_TBLLAYOUT_VERT, /* skipping vertical bar in tbl layout */ |
LIST_dash, |
|
LIST_diag, |
|
LIST_enum, |
|
LIST_hang, |
|
LIST_hyphen, |
|
LIST_inset, |
|
LIST_item, |
|
LIST_ohang, |
|
LIST_tag |
|
}; |
|
|
|
enum mdoc_disp { |
MANDOCERR_ERROR, /* ===== start of errors ===== */ |
DISP__NONE = 0, |
|
DISP_centred, |
|
DISP_ragged, |
|
DISP_unfilled, |
|
DISP_filled, |
|
DISP_literal |
|
}; |
|
|
|
enum mdoc_auth { |
/* related to tables */ |
AUTH__NONE = 0, |
MANDOCERR_TBLOPT_ALPHA, /* non-alphabetic character in tbl options */ |
AUTH_split, |
MANDOCERR_TBLOPT_BAD, /* skipping unknown tbl option: option */ |
AUTH_nosplit |
MANDOCERR_TBLOPT_NOARG, /* missing tbl option argument: option */ |
}; |
MANDOCERR_TBLOPT_ARGSZ, /* wrong tbl option argument size: option */ |
|
MANDOCERR_TBLLAYOUT_NONE, /* empty tbl layout */ |
|
MANDOCERR_TBLLAYOUT_CHAR, /* invalid character in tbl layout: char */ |
|
MANDOCERR_TBLLAYOUT_PAR, /* unmatched parenthesis in tbl layout */ |
|
MANDOCERR_TBLLAYOUT_SPC, /* ignoring excessive spacing in tbl layout */ |
|
MANDOCERR_TBLDATA_NONE, /* tbl without any data cells */ |
|
MANDOCERR_TBLDATA_SPAN, /* ignoring data in spanned tbl cell: data */ |
|
MANDOCERR_TBLDATA_EXTRA, /* ignoring extra tbl data cells: data */ |
|
MANDOCERR_TBLDATA_BLK, /* data block open at end of tbl: macro */ |
|
|
enum mdoc_font { |
/* related to document structure and macros */ |
FONT__NONE = 0, |
MANDOCERR_PROLOG_REP, /* duplicate prologue macro: macro */ |
FONT_Em, |
MANDOCERR_DT_LATE, /* skipping late title macro: Dt args */ |
FONT_Li, |
MANDOCERR_ROFFLOOP, /* input stack limit exceeded, infinite loop? */ |
FONT_Sy |
MANDOCERR_CHAR_BAD, /* skipping bad character: number */ |
}; |
MANDOCERR_MACRO, /* skipping unknown macro: macro */ |
|
MANDOCERR_REQ_NOMAC, /* skipping request outside macro: ... */ |
|
MANDOCERR_REQ_INSEC, /* skipping insecure request: request */ |
|
MANDOCERR_IT_STRAY, /* skipping item outside list: It ... */ |
|
MANDOCERR_TA_STRAY, /* skipping column outside column list: Ta */ |
|
MANDOCERR_BLK_NOTOPEN, /* skipping end of block that is not open */ |
|
MANDOCERR_RE_NOTOPEN, /* fewer RS blocks open, skipping: RE arg */ |
|
MANDOCERR_BLK_BROKEN, /* inserting missing end of block: macro ... */ |
|
MANDOCERR_BLK_NOEND, /* appending missing end of block: macro */ |
|
|
struct man_meta { |
/* related to request and macro arguments */ |
char *msec; /* `TH' section (e.g., 1--9) */ |
MANDOCERR_NAMESC, /* escaped character not allowed in a name: name */ |
time_t date; /* parsed `TH' date */ |
MANDOCERR_ARG_UNDEF, /* using macro argument outside macro */ |
char *rawdate; /* raw `TH' date */ |
MANDOCERR_ARG_NONUM, /* argument number is not numeric */ |
char *vol; /* `TH' volume (e.g., KM) */ |
MANDOCERR_BD_FILE, /* NOT IMPLEMENTED: Bd -file */ |
char *title; /* `TH' title (e.g., LS, CAT) */ |
MANDOCERR_BD_NOARG, /* skipping display without arguments: Bd */ |
char *source; /* `TH' source (e.g., GNU) */ |
MANDOCERR_BL_NOTYPE, /* missing list type, using -item: Bl */ |
}; |
MANDOCERR_CE_NONUM, /* argument is not numeric, using 1: ce ... */ |
|
MANDOCERR_CHAR_ARG, /* argument is not a character: char ... */ |
|
MANDOCERR_NM_NONAME, /* missing manual name, using "": Nm */ |
|
MANDOCERR_OS_UNAME, /* uname(3) system call failed, using UNKNOWN */ |
|
MANDOCERR_ST_BAD, /* unknown standard specifier: St standard */ |
|
MANDOCERR_IT_NONUM, /* skipping request without numeric argument */ |
|
MANDOCERR_SHIFT, /* excessive shift: ..., but max is ... */ |
|
MANDOCERR_SO_PATH, /* NOT IMPLEMENTED: .so with absolute path or ".." */ |
|
MANDOCERR_SO_FAIL, /* .so request failed */ |
|
MANDOCERR_TG_SPC, /* skipping tag containing whitespace: tag */ |
|
MANDOCERR_ARG_SKIP, /* skipping all arguments: macro args */ |
|
MANDOCERR_ARG_EXCESS, /* skipping excess arguments: macro ... args */ |
|
MANDOCERR_DIVZERO, /* divide by zero */ |
|
|
struct man_node { |
MANDOCERR_UNSUPP, /* ===== start of unsupported features ===== */ |
struct man_node *parent; |
|
struct man_node *child; |
|
struct man_node *next; |
|
struct man_node *prev; |
|
int nchild; |
|
int line; |
|
int pos; |
|
enum mant tok; |
|
int flags; |
|
#define MAN_VALID (1 << 0) |
|
#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 { |
MANDOCERR_TOOLARGE, /* input too large */ |
char *msec; /* `Dt' section (e.g., 1--9) */ |
MANDOCERR_CHAR_UNSUPP, /* unsupported control character: number */ |
char *vol; /* `Dt' volume (e.g., LOCAL) */ |
MANDOCERR_ESC_UNSUPP, /* unsupported escape sequence: escape */ |
char *arch; /* `Dt' architecture (e.g., i386) */ |
MANDOCERR_REQ_UNSUPP, /* unsupported roff request: request */ |
time_t date; /* `Dd' date */ |
MANDOCERR_WHILE_NEST, /* nested .while loops */ |
char *title; /* `Dt' title (e.g., LS, CAT) */ |
MANDOCERR_WHILE_OUTOF, /* end of scope with open .while loop */ |
char *os; /* `Os' system (e.g., OpenBSD) */ |
MANDOCERR_WHILE_INTO, /* end of .while loop in inner scope */ |
char *name; /* leading `Nm' (e.g., ls, cat) */ |
MANDOCERR_WHILE_FAIL, /* cannot continue this .while loop */ |
}; |
MANDOCERR_TBLOPT_EQN, /* eqn delim option in tbl: arg */ |
|
MANDOCERR_TBLLAYOUT_MOD, /* unsupported tbl layout modifier: m */ |
|
MANDOCERR_TBLMACRO, /* ignoring macro in table: macro */ |
|
|
struct mdoc_argv { |
MANDOCERR_BADARG, /* ===== start of bad invocations ===== */ |
enum mdocargt arg; |
|
int line; |
|
int pos; |
|
size_t sz; |
|
char **value; |
|
}; |
|
|
|
struct mdoc_arg { |
MANDOCERR_BADARG_BAD, /* bad argument */ |
size_t argc; |
MANDOCERR_BADARG_DUPE, /* duplicate argument */ |
struct mdoc_argv *argv; |
MANDOCERR_BADVAL, /* does not take a value */ |
unsigned int refcnt; |
MANDOCERR_BADVAL_MISS, /* missing argument value */ |
}; |
MANDOCERR_BADVAL_BAD, /* bad argument value */ |
|
MANDOCERR_BADVAL_DUPE, /* duplicate argument value */ |
|
MANDOCERR_TAG, /* no such tag */ |
|
|
|
MANDOCERR_SYSERR, /* ===== start of system errors ===== */ |
|
|
struct mdoc_bd { |
MANDOCERR_DUP, |
const char *offs; /* -offset */ |
MANDOCERR_EXEC, |
enum mdoc_disp type; /* -ragged, etc. */ |
MANDOCERR_FDOPEN, |
int comp; /* -compact */ |
MANDOCERR_FFLUSH, |
}; |
MANDOCERR_FORK, |
|
MANDOCERR_FSTAT, |
|
MANDOCERR_GETLINE, |
|
MANDOCERR_GLOB, |
|
MANDOCERR_GZCLOSE, |
|
MANDOCERR_GZDOPEN, |
|
MANDOCERR_MKSTEMP, |
|
MANDOCERR_OPEN, |
|
MANDOCERR_PLEDGE, |
|
MANDOCERR_READ, |
|
MANDOCERR_WAIT, |
|
MANDOCERR_WRITE, |
|
|
struct mdoc_bl { |
MANDOCERR_MAX |
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 mandoc_esc { |
enum mdoc_font font; /* font */ |
ESCAPE_ERROR = 0, /* bail! unparsable escape */ |
|
ESCAPE_UNSUPP, /* unsupported escape; ignore it */ |
|
ESCAPE_IGNORE, /* escape to be ignored */ |
|
ESCAPE_UNDEF, /* undefined escape; print literal character */ |
|
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_FONTCW, /* constant width font mode */ |
|
ESCAPE_FONTPREV, /* previous font mode */ |
|
ESCAPE_NUMBERED, /* a numbered glyph */ |
|
ESCAPE_UNICODE, /* a unicode codepoint */ |
|
ESCAPE_DEVICE, /* print the output device name */ |
|
ESCAPE_BREAK, /* break the output line */ |
|
ESCAPE_NOSPACE, /* suppress space if the last on a line */ |
|
ESCAPE_HORIZ, /* horizontal movement */ |
|
ESCAPE_HLINE, /* horizontal line drawing */ |
|
ESCAPE_SKIPCHAR, /* skip the next character */ |
|
ESCAPE_OVERSTRIKE /* overstrike all chars in the argument */ |
}; |
}; |
|
|
struct mdoc_an { |
|
enum mdoc_auth auth; /* -split, etc. */ |
|
}; |
|
|
|
struct mdoc_node { |
enum mandoc_esc mandoc_font(const char *, int); |
struct mdoc_node *parent; /* parent AST node */ |
enum mandoc_esc mandoc_escape(const char **, const char **, int *); |
struct mdoc_node *child; /* first child AST node */ |
void mandoc_msg_setoutfile(FILE *); |
struct mdoc_node *next; /* sibling AST node */ |
const char *mandoc_msg_getinfilename(void); |
struct mdoc_node *prev; /* prior sibling AST node */ |
void mandoc_msg_setinfilename(const char *); |
int nchild; /* number children */ |
enum mandocerr mandoc_msg_getmin(void); |
int line; /* parse line */ |
void mandoc_msg_setmin(enum mandocerr); |
int pos; /* parse column */ |
enum mandoclevel mandoc_msg_getrc(void); |
enum mdoct tok; /* tok or MDOC__MAX if none */ |
void mandoc_msg_setrc(enum mandoclevel); |
int flags; |
void mandoc_msg(enum mandocerr, int, int, const char *, ...) |
#define MDOC_VALID (1 << 0) /* has been validated */ |
__attribute__((__format__ (__printf__, 4, 5))); |
#define MDOC_ACTED (1 << 1) /* has been acted upon */ |
void mandoc_msg_summary(void); |
#define MDOC_EOS (1 << 2) /* at sentence boundary */ |
void mchars_alloc(void); |
#define MDOC_LINE (1 << 3) /* first macro/text on line */ |
void mchars_free(void); |
#define MDOC_SYNPRETTY (1 << 4) /* SYNOPSIS-style formatting */ |
int mchars_num2char(const char *, size_t); |
#define MDOC_ENDED (1 << 5) /* rendering has been ended */ |
const char *mchars_uc2str(int); |
enum mdoc_type type; /* AST node type */ |
int mchars_num2uc(const char *, size_t); |
enum mdoc_sec sec; /* current named section */ |
int mchars_spec2cp(const char *, size_t); |
/* XXX: these can be union'd to shave a few bytes. */ |
const char *mchars_spec2str(const char *, size_t, size_t *); |
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 |
|
* 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 { |
|
unsigned u; /* unsigned integer */ |
|
} v; |
|
}; |
|
|
|
/* |
|
* 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]; |
|
}; |
|
|
|
/* |
|
* Callback function for warnings, errors, and fatal errors as they |
|
* occur in the compilers libroff, libmdoc, and libman. |
|
*/ |
|
typedef int (*mandocmsg)(enum mandocerr, void *, |
|
int, int, const char *); |
|
|
|
__END_DECLS |
|
|
|
#endif /*!MANDOC_H*/ |
|