Annotation of src/usr.bin/mandoc/mandoc.h, Revision 1.199
1.199 ! schwarze 1: /* $OpenBSD: mandoc.h,v 1.198 2018/12/12 21:54:30 schwarze Exp $ */
1.1 schwarze 2: /*
1.102 schwarze 3: * Copyright (c) 2010, 2011, 2014 Kristaps Dzonsons <kristaps@bsd.lv>
1.198 schwarze 4: * Copyright (c) 2010, 2012-2018 Ingo Schwarze <schwarze@openbsd.org>
1.1 schwarze 5: *
6: * Permission to use, copy, modify, and distribute this software for any
7: * purpose with or without fee is hereby granted, provided that the above
8: * copyright notice and this permission notice appear in all copies.
9: *
1.144 schwarze 10: * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES
1.1 schwarze 11: * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
1.144 schwarze 12: * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
1.1 schwarze 13: * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14: * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15: * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16: * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17: */
1.5 schwarze 18:
19: #define ASCII_NBRSP 31 /* non-breaking space */
20: #define ASCII_HYPH 30 /* breakable hyphen */
1.59 schwarze 21: #define ASCII_BREAK 29 /* breakable zero-width space */
1.5 schwarze 22:
1.16 schwarze 23: /*
24: * Status level. This refers to both internal status (i.e., whilst
25: * running, when warnings/errors are reported) and an indicator of a
26: * threshold of when to halt (when said internal state exceeds the
27: * threshold).
28: */
1.12 schwarze 29: enum mandoclevel {
30: MANDOCLEVEL_OK = 0,
1.158 schwarze 31: MANDOCLEVEL_STYLE, /* style suggestions */
1.16 schwarze 32: MANDOCLEVEL_WARNING, /* warnings: syntax, whitespace, etc. */
33: MANDOCLEVEL_ERROR, /* input has been thrown away */
1.125 schwarze 34: MANDOCLEVEL_UNSUPP, /* input needs unimplemented features */
1.16 schwarze 35: MANDOCLEVEL_BADARG, /* bad argument in invocation */
36: MANDOCLEVEL_SYSERR, /* system error */
1.12 schwarze 37: MANDOCLEVEL_MAX
38: };
39:
1.16 schwarze 40: /*
41: * All possible things that can go wrong within a parse, be it libroff,
42: * libmdoc, or libman.
43: */
1.1 schwarze 44: enum mandocerr {
45: MANDOCERR_OK,
1.158 schwarze 46:
1.175 schwarze 47: MANDOCERR_BASE, /* ===== start of base system conventions ===== */
1.159 schwarze 48:
1.171 schwarze 49: MANDOCERR_MDOCDATE, /* Mdocdate found: Dd ... */
50: MANDOCERR_MDOCDATE_MISSING, /* Mdocdate missing: Dd ... */
1.177 schwarze 51: MANDOCERR_ARCH_BAD, /* unknown architecture: Dt ... arch */
1.176 schwarze 52: MANDOCERR_OS_ARG, /* operating system explicitly specified: Os ... */
1.175 schwarze 53: MANDOCERR_RCS_MISSING, /* RCS id missing */
1.180 schwarze 54: MANDOCERR_XR_BAD, /* referenced manual not found: Xr name sec */
1.175 schwarze 55:
56: MANDOCERR_STYLE, /* ===== start of style suggestions ===== */
57:
1.171 schwarze 58: MANDOCERR_DATE_LEGACY, /* legacy man(7) date format: Dd ... */
1.190 schwarze 59: MANDOCERR_DATE_NORM, /* normalizing date format to: ... */
1.185 schwarze 60: MANDOCERR_TITLE_CASE, /* lower case character in document title */
1.174 schwarze 61: MANDOCERR_RCS_REP, /* duplicate RCS id: ... */
1.188 jca 62: MANDOCERR_SEC_TYPO, /* possible typo in section name: Sh ... */
1.185 schwarze 63: MANDOCERR_ARG_QUOTE, /* unterminated quoted argument */
1.159 schwarze 64: MANDOCERR_MACRO_USELESS, /* useless macro: macro */
1.160 schwarze 65: MANDOCERR_BX, /* consider using OS macro: macro */
1.166 schwarze 66: MANDOCERR_ER_ORDER, /* errnos out of order: Er ... */
67: MANDOCERR_ER_REP, /* duplicate errno: Er ... */
1.183 schwarze 68: MANDOCERR_DELIM, /* trailing delimiter: macro ... */
69: MANDOCERR_DELIM_NB, /* no blank before trailing delimiter: macro ... */
1.185 schwarze 70: MANDOCERR_FI_SKIP, /* fill mode already enabled, skipping: fi */
71: MANDOCERR_NF_SKIP, /* fill mode already disabled, skipping: nf */
1.189 schwarze 72: MANDOCERR_DASHDASH, /* verbatim "--", maybe consider using \(em */
1.170 schwarze 73: MANDOCERR_FUNC, /* function name without markup: name() */
1.185 schwarze 74: MANDOCERR_SPACE_EOL, /* whitespace at end of input line */
75: MANDOCERR_COMMENT_BAD, /* bad comment style */
1.8 schwarze 76:
1.16 schwarze 77: MANDOCERR_WARNING, /* ===== start of warnings ===== */
1.19 schwarze 78:
79: /* related to the prologue */
1.96 schwarze 80: MANDOCERR_DT_NOTITLE, /* missing manual title, using UNTITLED: line */
81: MANDOCERR_TH_NOTITLE, /* missing manual title, using "": [macro] */
82: MANDOCERR_MSEC_MISSING, /* missing manual section, using "": macro */
1.95 schwarze 83: MANDOCERR_MSEC_BAD, /* unknown manual section: Dt ... section */
1.69 schwarze 84: MANDOCERR_DATE_MISSING, /* missing date, using today's date */
85: MANDOCERR_DATE_BAD, /* cannot parse date, using it verbatim: date */
1.182 schwarze 86: MANDOCERR_DATE_FUTURE, /* date in the future, using it anyway: date */
1.96 schwarze 87: MANDOCERR_OS_MISSING, /* missing Os macro, using "" */
88: MANDOCERR_PROLOG_LATE, /* late prologue macro: macro */
89: MANDOCERR_PROLOG_ORDER, /* prologue macros out of order: macros */
1.19 schwarze 90:
91: /* related to document structure */
1.95 schwarze 92: MANDOCERR_SO, /* .so is fragile, better use ln(1): so path */
1.66 schwarze 93: MANDOCERR_DOC_EMPTY, /* no document body */
1.69 schwarze 94: MANDOCERR_SEC_BEFORE, /* content before first section header: macro */
1.95 schwarze 95: MANDOCERR_NAMESEC_FIRST, /* first section is not NAME: Sh title */
1.154 schwarze 96: MANDOCERR_NAMESEC_NONM, /* NAME section without Nm before Nd */
1.143 schwarze 97: MANDOCERR_NAMESEC_NOND, /* NAME section without description */
98: MANDOCERR_NAMESEC_ND, /* description not at the end of NAME */
99: MANDOCERR_NAMESEC_BAD, /* bad NAME section content: macro */
1.154 schwarze 100: MANDOCERR_NAMESEC_PUNCT, /* missing comma before name: Nm name */
1.137 schwarze 101: MANDOCERR_ND_EMPTY, /* missing description line, using "" */
1.157 schwarze 102: MANDOCERR_ND_LATE, /* description line outside NAME section */
1.95 schwarze 103: MANDOCERR_SEC_ORDER, /* sections out of conventional order: Sh title */
104: MANDOCERR_SEC_REP, /* duplicate section title: Sh title */
105: MANDOCERR_SEC_MSEC, /* unexpected section: Sh title for ... only */
1.181 schwarze 106: MANDOCERR_XR_SELF, /* cross reference to self: Xr name sec */
1.99 schwarze 107: MANDOCERR_XR_ORDER, /* unusual Xr order: ... after ... */
108: MANDOCERR_XR_PUNCT, /* unusual Xr punctuation: ... after ... */
1.98 schwarze 109: MANDOCERR_AN_MISSING, /* AUTHORS section without An macro */
1.19 schwarze 110:
111: /* related to macros and nesting */
1.70 schwarze 112: MANDOCERR_MACRO_OBS, /* obsolete macro: macro */
1.116 schwarze 113: MANDOCERR_MACRO_CALL, /* macro neither callable nor escaped: macro */
1.71 schwarze 114: MANDOCERR_PAR_SKIP, /* skipping paragraph macro: macro ... */
115: MANDOCERR_PAR_MOVE, /* moving paragraph macro out of list: macro */
1.72 schwarze 116: MANDOCERR_NS_SKIP, /* skipping no-space macro */
1.85 schwarze 117: MANDOCERR_BLK_NEST, /* blocks badly nested: macro ... */
1.72 schwarze 118: MANDOCERR_BD_NEST, /* nested displays are not portable: macro ... */
1.73 schwarze 119: MANDOCERR_BL_MOVE, /* moving content out of list: macro */
1.179 schwarze 120: MANDOCERR_TA_LINE, /* first macro on line: Ta */
1.85 schwarze 121: MANDOCERR_BLK_LINE, /* line scope broken: macro breaks macro */
1.164 schwarze 122: MANDOCERR_BLK_BLANK, /* skipping blank line in line scope */
1.19 schwarze 123:
1.75 schwarze 124: /* related to missing arguments */
125: MANDOCERR_REQ_EMPTY, /* skipping empty request: request */
126: MANDOCERR_COND_EMPTY, /* conditional request controls empty scope */
1.74 schwarze 127: MANDOCERR_MACRO_EMPTY, /* skipping empty macro: macro */
1.140 schwarze 128: MANDOCERR_BLK_EMPTY, /* empty block: macro */
1.79 schwarze 129: MANDOCERR_ARG_EMPTY, /* empty argument, using 0n: macro arg */
1.95 schwarze 130: MANDOCERR_BD_NOTYPE, /* missing display type, using -ragged: Bd */
131: MANDOCERR_BL_LATETYPE, /* list type is not the first argument: Bl arg */
1.152 schwarze 132: MANDOCERR_BL_NOWIDTH, /* missing -width in -tag list, using 6n */
1.95 schwarze 133: MANDOCERR_EX_NONAME, /* missing utility name, using "": Ex */
1.139 schwarze 134: MANDOCERR_FO_NOHEAD, /* missing function name, using "": Fo */
1.95 schwarze 135: MANDOCERR_IT_NOHEAD, /* empty head in list item: Bl -type It */
136: MANDOCERR_IT_NOBODY, /* empty list item: Bl -type It */
1.179 schwarze 137: MANDOCERR_IT_NOARG, /* missing argument, using next line: Bl -c It */
1.95 schwarze 138: MANDOCERR_BF_NOFONT, /* missing font type, using \fR: Bf */
139: MANDOCERR_BF_BADFONT, /* unknown font type, using \fR: Bf font */
1.117 schwarze 140: MANDOCERR_PF_SKIP, /* nothing follows prefix: Pf arg */
1.138 schwarze 141: MANDOCERR_RS_EMPTY, /* empty reference block: Rs */
1.153 schwarze 142: MANDOCERR_XR_NOSEC, /* missing section argument: Xr arg */
1.77 schwarze 143: MANDOCERR_ARG_STD, /* missing -std argument, adding it: macro */
1.141 schwarze 144: MANDOCERR_OP_EMPTY, /* missing option string, using "": OP */
145: MANDOCERR_UR_NOHEAD, /* missing resource identifier, using "": UR */
1.105 schwarze 146: MANDOCERR_EQN_NOBOX, /* missing eqn box, using "": op */
1.19 schwarze 147:
1.81 schwarze 148: /* related to bad arguments */
1.79 schwarze 149: MANDOCERR_ARG_REP, /* duplicate argument: macro arg */
1.93 schwarze 150: MANDOCERR_AN_REP, /* skipping duplicate argument: An -arg */
1.95 schwarze 151: MANDOCERR_BD_REP, /* skipping duplicate display type: Bd -type */
152: MANDOCERR_BL_REP, /* skipping duplicate list type: Bl -type */
1.93 schwarze 153: MANDOCERR_BL_SKIPW, /* skipping -width argument: Bl -type */
1.142 schwarze 154: MANDOCERR_BL_COL, /* wrong number of cells */
1.95 schwarze 155: MANDOCERR_AT_BAD, /* unknown AT&T UNIX version: At version */
1.100 schwarze 156: MANDOCERR_FA_COMMA, /* comma in function argument: arg */
1.104 schwarze 157: MANDOCERR_FN_PAREN, /* parenthesis in function name: arg */
1.167 schwarze 158: MANDOCERR_LB_BAD, /* unknown library name: Lb ... */
1.84 schwarze 159: MANDOCERR_RS_BAD, /* invalid content in Rs block: macro */
1.80 schwarze 160: MANDOCERR_SM_BAD, /* invalid Boolean argument: macro arg */
1.195 schwarze 161: MANDOCERR_CHAR_FONT, /* argument contains two font escapes */
1.95 schwarze 162: MANDOCERR_FT_BAD, /* unknown font, skipping request: ft font */
1.142 schwarze 163: MANDOCERR_TR_ODD, /* odd number of characters in request: tr char */
1.19 schwarze 164:
165: /* related to plain text */
1.81 schwarze 166: MANDOCERR_FI_BLANK, /* blank line in fill mode, using .sp */
167: MANDOCERR_FI_TAB, /* tab in filled text */
1.156 schwarze 168: MANDOCERR_EOS, /* new sentence, new line */
1.81 schwarze 169: MANDOCERR_ESC_BAD, /* invalid escape sequence: esc */
170: MANDOCERR_STR_UNDEF, /* undefined string, using "": name */
1.8 schwarze 171:
1.131 schwarze 172: /* related to tables */
173: MANDOCERR_TBLLAYOUT_SPAN, /* tbl line starts with span */
174: MANDOCERR_TBLLAYOUT_DOWN, /* tbl column starts with span */
175: MANDOCERR_TBLLAYOUT_VERT, /* skipping vertical bar in tbl layout */
176:
1.16 schwarze 177: MANDOCERR_ERROR, /* ===== start of errors ===== */
1.40 schwarze 178:
1.27 schwarze 179: /* related to tables */
1.129 schwarze 180: MANDOCERR_TBLOPT_ALPHA, /* non-alphabetic character in tbl options */
181: MANDOCERR_TBLOPT_BAD, /* skipping unknown tbl option: option */
1.133 schwarze 182: MANDOCERR_TBLOPT_NOARG, /* missing tbl option argument: option */
183: MANDOCERR_TBLOPT_ARGSZ, /* wrong tbl option argument size: option */
1.131 schwarze 184: MANDOCERR_TBLLAYOUT_NONE, /* empty tbl layout */
185: MANDOCERR_TBLLAYOUT_CHAR, /* invalid character in tbl layout: char */
186: MANDOCERR_TBLLAYOUT_PAR, /* unmatched parenthesis in tbl layout */
1.133 schwarze 187: MANDOCERR_TBLDATA_NONE, /* tbl without any data cells */
188: MANDOCERR_TBLDATA_SPAN, /* ignoring data in spanned tbl cell: data */
189: MANDOCERR_TBLDATA_EXTRA, /* ignoring extra tbl data cells: data */
190: MANDOCERR_TBLDATA_BLK, /* data block open at end of tbl: macro */
1.27 schwarze 191:
1.85 schwarze 192: /* related to document structure and macros */
1.121 schwarze 193: MANDOCERR_FILE, /* cannot open file */
1.185 schwarze 194: MANDOCERR_PROLOG_REP, /* duplicate prologue macro: macro */
195: MANDOCERR_DT_LATE, /* skipping late title macro: Dt args */
1.25 schwarze 196: MANDOCERR_ROFFLOOP, /* input stack limit exceeded, infinite loop? */
1.127 schwarze 197: MANDOCERR_CHAR_BAD, /* skipping bad character: number */
1.95 schwarze 198: MANDOCERR_MACRO, /* skipping unknown macro: macro */
1.192 schwarze 199: MANDOCERR_REQ_NOMAC, /* skipping request outside macro: ... */
1.125 schwarze 200: MANDOCERR_REQ_INSEC, /* skipping insecure request: request */
1.95 schwarze 201: MANDOCERR_IT_STRAY, /* skipping item outside list: It ... */
202: MANDOCERR_TA_STRAY, /* skipping column outside column list: Ta */
1.85 schwarze 203: MANDOCERR_BLK_NOTOPEN, /* skipping end of block that is not open */
1.128 schwarze 204: MANDOCERR_RE_NOTOPEN, /* fewer RS blocks open, skipping: RE arg */
1.85 schwarze 205: MANDOCERR_BLK_BROKEN, /* inserting missing end of block: macro ... */
206: MANDOCERR_BLK_NOEND, /* appending missing end of block: macro */
207:
208: /* related to request and macro arguments */
1.95 schwarze 209: MANDOCERR_NAMESC, /* escaped character not allowed in a name: name */
1.192 schwarze 210: MANDOCERR_ARG_UNDEF, /* using macro argument outside macro */
211: MANDOCERR_ARG_NONUM, /* argument number is not numeric */
1.114 schwarze 212: MANDOCERR_BD_FILE, /* NOT IMPLEMENTED: Bd -file */
1.149 schwarze 213: MANDOCERR_BD_NOARG, /* skipping display without arguments: Bd */
1.95 schwarze 214: MANDOCERR_BL_NOTYPE, /* missing list type, using -item: Bl */
1.165 schwarze 215: MANDOCERR_CE_NONUM, /* argument is not numeric, using 1: ce ... */
1.195 schwarze 216: MANDOCERR_CHAR_ARG, /* argument is not a character: char ... */
1.95 schwarze 217: MANDOCERR_NM_NONAME, /* missing manual name, using "": Nm */
1.88 schwarze 218: MANDOCERR_OS_UNAME, /* uname(3) system call failed, using UNKNOWN */
1.95 schwarze 219: MANDOCERR_ST_BAD, /* unknown standard specifier: St standard */
1.88 schwarze 220: MANDOCERR_IT_NONUM, /* skipping request without numeric argument */
1.192 schwarze 221: MANDOCERR_SHIFT, /* excessive shift: ..., but max is ... */
1.122 schwarze 222: MANDOCERR_SO_PATH, /* NOT IMPLEMENTED: .so with absolute path or ".." */
1.123 schwarze 223: MANDOCERR_SO_FAIL, /* .so request failed */
1.78 schwarze 224: MANDOCERR_ARG_SKIP, /* skipping all arguments: macro args */
225: MANDOCERR_ARG_EXCESS, /* skipping excess arguments: macro ... args */
1.107 schwarze 226: MANDOCERR_DIVZERO, /* divide by zero */
1.125 schwarze 227:
228: MANDOCERR_UNSUPP, /* ===== start of unsupported features ===== */
229:
230: MANDOCERR_TOOLARGE, /* input too large */
1.127 schwarze 231: MANDOCERR_CHAR_UNSUPP, /* unsupported control character: number */
1.125 schwarze 232: MANDOCERR_REQ_UNSUPP, /* unsupported roff request: request */
1.194 schwarze 233: MANDOCERR_WHILE_NEST, /* nested .while loops */
234: MANDOCERR_WHILE_OUTOF, /* end of scope with open .while loop */
235: MANDOCERR_WHILE_INTO, /* end of .while loop in inner scope */
236: MANDOCERR_WHILE_FAIL, /* cannot continue this .while loop */
1.133 schwarze 237: MANDOCERR_TBLOPT_EQN, /* eqn delim option in tbl: arg */
1.131 schwarze 238: MANDOCERR_TBLLAYOUT_MOD, /* unsupported tbl layout modifier: m */
1.125 schwarze 239: MANDOCERR_TBLMACRO, /* ignoring macro in table: macro */
1.57 schwarze 240:
1.1 schwarze 241: MANDOCERR_MAX
242: };
243:
1.16 schwarze 244: /*
1.60 schwarze 245: * Parse options.
246: */
247: #define MPARSE_MDOC 1 /* assume -mdoc */
248: #define MPARSE_MAN 2 /* assume -man */
249: #define MPARSE_SO 4 /* honour .so requests */
250: #define MPARSE_QUICK 8 /* abort the parse early */
1.111 schwarze 251: #define MPARSE_UTF8 16 /* accept UTF-8 input */
252: #define MPARSE_LATIN1 32 /* accept ISO-LATIN-1 input */
1.37 schwarze 253:
1.175 schwarze 254: enum mandoc_os {
255: MANDOC_OS_OTHER = 0,
256: MANDOC_OS_NETBSD,
257: MANDOC_OS_OPENBSD
258: };
259:
1.38 schwarze 260: enum mandoc_esc {
261: ESCAPE_ERROR = 0, /* bail! unparsable escape */
262: ESCAPE_IGNORE, /* escape to be ignored */
263: ESCAPE_SPECIAL, /* a regular special character */
264: ESCAPE_FONT, /* a generic font mode */
265: ESCAPE_FONTBOLD, /* bold font mode */
266: ESCAPE_FONTITALIC, /* italic font mode */
1.53 schwarze 267: ESCAPE_FONTBI, /* bold italic font mode */
1.38 schwarze 268: ESCAPE_FONTROMAN, /* roman font mode */
1.196 schwarze 269: ESCAPE_FONTCW, /* constant width font mode */
1.38 schwarze 270: ESCAPE_FONTPREV, /* previous font mode */
271: ESCAPE_NUMBERED, /* a numbered glyph */
272: ESCAPE_UNICODE, /* a unicode codepoint */
1.191 schwarze 273: ESCAPE_DEVICE, /* print the output device name */
1.172 schwarze 274: ESCAPE_BREAK, /* break the output line */
1.46 schwarze 275: ESCAPE_NOSPACE, /* suppress space if the last on a line */
1.162 schwarze 276: ESCAPE_HORIZ, /* horizontal movement */
1.163 schwarze 277: ESCAPE_HLINE, /* horizontal line drawing */
1.126 schwarze 278: ESCAPE_SKIPCHAR, /* skip the next character */
279: ESCAPE_OVERSTRIKE /* overstrike all chars in the argument */
1.38 schwarze 280: };
281:
1.37 schwarze 282: typedef void (*mandocmsg)(enum mandocerr, enum mandoclevel,
283: const char *, int, int, const char *);
284:
1.118 schwarze 285:
1.37 schwarze 286: struct mparse;
1.144 schwarze 287: struct roff_man;
1.16 schwarze 288:
1.56 schwarze 289: enum mandoc_esc mandoc_escape(const char **, const char **, int *);
1.148 schwarze 290: void mchars_alloc(void);
291: void mchars_free(void);
1.110 schwarze 292: int mchars_num2char(const char *, size_t);
1.108 schwarze 293: const char *mchars_uc2str(int);
1.38 schwarze 294: int mchars_num2uc(const char *, size_t);
1.148 schwarze 295: int mchars_spec2cp(const char *, size_t);
296: const char *mchars_spec2str(const char *, size_t, size_t *);
1.175 schwarze 297: struct mparse *mparse_alloc(int, enum mandocerr, mandocmsg,
298: enum mandoc_os, const char *);
1.41 schwarze 299: void mparse_free(struct mparse *);
1.151 schwarze 300: int mparse_open(struct mparse *, const char *);
1.41 schwarze 301: enum mandoclevel mparse_readfd(struct mparse *, int, const char *);
302: void mparse_reset(struct mparse *);
1.145 schwarze 303: void mparse_result(struct mparse *,
1.144 schwarze 304: struct roff_man **, char **);
1.193 schwarze 305: void mparse_copy(const struct mparse *);
1.41 schwarze 306: const char *mparse_strerror(enum mandocerr);
307: const char *mparse_strlevel(enum mandoclevel);
1.155 schwarze 308: void mparse_updaterc(struct mparse *, enum mandoclevel *);
![[BACK]](/icons/back.gif){kind=icon}
Return to mandoc.h CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / mandoc