Annotation of src/usr.bin/mandoc/mandoc.h, Revision 1.222
1.222 ! schwarze 1: /* $OpenBSD: mandoc.h,v 1.221 2022/06/07 09:51:03 schwarze Exp $ */
1.1 schwarze 2: /*
1.217 schwarze 3: * Copyright (c) 2012-2022 Ingo Schwarze <schwarze@openbsd.org>
1.102 schwarze 4: * Copyright (c) 2010, 2011, 2014 Kristaps Dzonsons <kristaps@bsd.lv>
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.
1.200 schwarze 17: *
18: * Error handling, escape sequence, and character utilities.
1.209 schwarze 19: * Can be used by all code in the mandoc package.
1.1 schwarze 20: */
1.5 schwarze 21:
22: #define ASCII_NBRSP 31 /* non-breaking space */
1.222 ! schwarze 23: #define ASCII_NBRZW 30 /* non-breaking zero-width space */
! 24: #define ASCII_BREAK 29 /* breakable zero-width space */
! 25: #define ASCII_HYPH 28 /* breakable hyphen */
1.5 schwarze 26:
1.16 schwarze 27: /*
28: * Status level. This refers to both internal status (i.e., whilst
29: * running, when warnings/errors are reported) and an indicator of a
30: * threshold of when to halt (when said internal state exceeds the
31: * threshold).
32: */
1.12 schwarze 33: enum mandoclevel {
34: MANDOCLEVEL_OK = 0,
1.158 schwarze 35: MANDOCLEVEL_STYLE, /* style suggestions */
1.16 schwarze 36: MANDOCLEVEL_WARNING, /* warnings: syntax, whitespace, etc. */
37: MANDOCLEVEL_ERROR, /* input has been thrown away */
1.125 schwarze 38: MANDOCLEVEL_UNSUPP, /* input needs unimplemented features */
1.16 schwarze 39: MANDOCLEVEL_BADARG, /* bad argument in invocation */
40: MANDOCLEVEL_SYSERR, /* system error */
1.12 schwarze 41: MANDOCLEVEL_MAX
42: };
43:
1.16 schwarze 44: /*
45: * All possible things that can go wrong within a parse, be it libroff,
46: * libmdoc, or libman.
47: */
1.1 schwarze 48: enum mandocerr {
49: MANDOCERR_OK,
1.158 schwarze 50:
1.175 schwarze 51: MANDOCERR_BASE, /* ===== start of base system conventions ===== */
1.159 schwarze 52:
1.171 schwarze 53: MANDOCERR_MDOCDATE, /* Mdocdate found: Dd ... */
54: MANDOCERR_MDOCDATE_MISSING, /* Mdocdate missing: Dd ... */
1.177 schwarze 55: MANDOCERR_ARCH_BAD, /* unknown architecture: Dt ... arch */
1.176 schwarze 56: MANDOCERR_OS_ARG, /* operating system explicitly specified: Os ... */
1.175 schwarze 57: MANDOCERR_RCS_MISSING, /* RCS id missing */
58:
59: MANDOCERR_STYLE, /* ===== start of style suggestions ===== */
60:
1.171 schwarze 61: MANDOCERR_DATE_LEGACY, /* legacy man(7) date format: Dd ... */
1.190 schwarze 62: MANDOCERR_DATE_NORM, /* normalizing date format to: ... */
1.185 schwarze 63: MANDOCERR_TITLE_CASE, /* lower case character in document title */
1.174 schwarze 64: MANDOCERR_RCS_REP, /* duplicate RCS id: ... */
1.188 jca 65: MANDOCERR_SEC_TYPO, /* possible typo in section name: Sh ... */
1.185 schwarze 66: MANDOCERR_ARG_QUOTE, /* unterminated quoted argument */
1.159 schwarze 67: MANDOCERR_MACRO_USELESS, /* useless macro: macro */
1.160 schwarze 68: MANDOCERR_BX, /* consider using OS macro: macro */
1.166 schwarze 69: MANDOCERR_ER_ORDER, /* errnos out of order: Er ... */
70: MANDOCERR_ER_REP, /* duplicate errno: Er ... */
1.212 schwarze 71: MANDOCERR_XR_BAD, /* referenced manual not found: Xr name sec */
1.183 schwarze 72: MANDOCERR_DELIM, /* trailing delimiter: macro ... */
73: MANDOCERR_DELIM_NB, /* no blank before trailing delimiter: macro ... */
1.185 schwarze 74: MANDOCERR_FI_SKIP, /* fill mode already enabled, skipping: fi */
75: MANDOCERR_NF_SKIP, /* fill mode already disabled, skipping: nf */
1.213 schwarze 76: MANDOCERR_TEXT_LONG, /* input text line longer than 80 bytes */
1.189 schwarze 77: MANDOCERR_DASHDASH, /* verbatim "--", maybe consider using \(em */
1.170 schwarze 78: MANDOCERR_FUNC, /* function name without markup: name() */
1.185 schwarze 79: MANDOCERR_SPACE_EOL, /* whitespace at end of input line */
80: MANDOCERR_COMMENT_BAD, /* bad comment style */
1.8 schwarze 81:
1.16 schwarze 82: MANDOCERR_WARNING, /* ===== start of warnings ===== */
1.19 schwarze 83:
84: /* related to the prologue */
1.96 schwarze 85: MANDOCERR_DT_NOTITLE, /* missing manual title, using UNTITLED: line */
86: MANDOCERR_TH_NOTITLE, /* missing manual title, using "": [macro] */
87: MANDOCERR_MSEC_MISSING, /* missing manual section, using "": macro */
1.95 schwarze 88: MANDOCERR_MSEC_BAD, /* unknown manual section: Dt ... section */
1.210 schwarze 89: MANDOCERR_MSEC_FILE, /* filename/section mismatch: ... */
1.207 schwarze 90: MANDOCERR_DATE_MISSING, /* missing date, using "": [macro] */
1.69 schwarze 91: MANDOCERR_DATE_BAD, /* cannot parse date, using it verbatim: date */
1.182 schwarze 92: MANDOCERR_DATE_FUTURE, /* date in the future, using it anyway: date */
1.96 schwarze 93: MANDOCERR_OS_MISSING, /* missing Os macro, using "" */
94: MANDOCERR_PROLOG_LATE, /* late prologue macro: macro */
95: MANDOCERR_PROLOG_ORDER, /* prologue macros out of order: macros */
1.19 schwarze 96:
97: /* related to document structure */
1.95 schwarze 98: MANDOCERR_SO, /* .so is fragile, better use ln(1): so path */
1.66 schwarze 99: MANDOCERR_DOC_EMPTY, /* no document body */
1.69 schwarze 100: MANDOCERR_SEC_BEFORE, /* content before first section header: macro */
1.95 schwarze 101: MANDOCERR_NAMESEC_FIRST, /* first section is not NAME: Sh title */
1.154 schwarze 102: MANDOCERR_NAMESEC_NONM, /* NAME section without Nm before Nd */
1.143 schwarze 103: MANDOCERR_NAMESEC_NOND, /* NAME section without description */
104: MANDOCERR_NAMESEC_ND, /* description not at the end of NAME */
105: MANDOCERR_NAMESEC_BAD, /* bad NAME section content: macro */
1.154 schwarze 106: MANDOCERR_NAMESEC_PUNCT, /* missing comma before name: Nm name */
1.137 schwarze 107: MANDOCERR_ND_EMPTY, /* missing description line, using "" */
1.157 schwarze 108: MANDOCERR_ND_LATE, /* description line outside NAME section */
1.95 schwarze 109: MANDOCERR_SEC_ORDER, /* sections out of conventional order: Sh title */
110: MANDOCERR_SEC_REP, /* duplicate section title: Sh title */
111: MANDOCERR_SEC_MSEC, /* unexpected section: Sh title for ... only */
1.181 schwarze 112: MANDOCERR_XR_SELF, /* cross reference to self: Xr name sec */
1.99 schwarze 113: MANDOCERR_XR_ORDER, /* unusual Xr order: ... after ... */
114: MANDOCERR_XR_PUNCT, /* unusual Xr punctuation: ... after ... */
1.98 schwarze 115: MANDOCERR_AN_MISSING, /* AUTHORS section without An macro */
1.19 schwarze 116:
117: /* related to macros and nesting */
1.70 schwarze 118: MANDOCERR_MACRO_OBS, /* obsolete macro: macro */
1.116 schwarze 119: MANDOCERR_MACRO_CALL, /* macro neither callable nor escaped: macro */
1.71 schwarze 120: MANDOCERR_PAR_SKIP, /* skipping paragraph macro: macro ... */
121: MANDOCERR_PAR_MOVE, /* moving paragraph macro out of list: macro */
1.72 schwarze 122: MANDOCERR_NS_SKIP, /* skipping no-space macro */
1.85 schwarze 123: MANDOCERR_BLK_NEST, /* blocks badly nested: macro ... */
1.72 schwarze 124: MANDOCERR_BD_NEST, /* nested displays are not portable: macro ... */
1.73 schwarze 125: MANDOCERR_BL_MOVE, /* moving content out of list: macro */
1.179 schwarze 126: MANDOCERR_TA_LINE, /* first macro on line: Ta */
1.85 schwarze 127: MANDOCERR_BLK_LINE, /* line scope broken: macro breaks macro */
1.164 schwarze 128: MANDOCERR_BLK_BLANK, /* skipping blank line in line scope */
1.19 schwarze 129:
1.75 schwarze 130: /* related to missing arguments */
131: MANDOCERR_REQ_EMPTY, /* skipping empty request: request */
132: MANDOCERR_COND_EMPTY, /* conditional request controls empty scope */
1.74 schwarze 133: MANDOCERR_MACRO_EMPTY, /* skipping empty macro: macro */
1.140 schwarze 134: MANDOCERR_BLK_EMPTY, /* empty block: macro */
1.79 schwarze 135: MANDOCERR_ARG_EMPTY, /* empty argument, using 0n: macro arg */
1.95 schwarze 136: MANDOCERR_BD_NOTYPE, /* missing display type, using -ragged: Bd */
137: MANDOCERR_BL_LATETYPE, /* list type is not the first argument: Bl arg */
1.152 schwarze 138: MANDOCERR_BL_NOWIDTH, /* missing -width in -tag list, using 6n */
1.95 schwarze 139: MANDOCERR_EX_NONAME, /* missing utility name, using "": Ex */
1.139 schwarze 140: MANDOCERR_FO_NOHEAD, /* missing function name, using "": Fo */
1.95 schwarze 141: MANDOCERR_IT_NOHEAD, /* empty head in list item: Bl -type It */
142: MANDOCERR_IT_NOBODY, /* empty list item: Bl -type It */
1.179 schwarze 143: MANDOCERR_IT_NOARG, /* missing argument, using next line: Bl -c It */
1.95 schwarze 144: MANDOCERR_BF_NOFONT, /* missing font type, using \fR: Bf */
145: MANDOCERR_BF_BADFONT, /* unknown font type, using \fR: Bf font */
1.117 schwarze 146: MANDOCERR_PF_SKIP, /* nothing follows prefix: Pf arg */
1.138 schwarze 147: MANDOCERR_RS_EMPTY, /* empty reference block: Rs */
1.153 schwarze 148: MANDOCERR_XR_NOSEC, /* missing section argument: Xr arg */
1.77 schwarze 149: MANDOCERR_ARG_STD, /* missing -std argument, adding it: macro */
1.141 schwarze 150: MANDOCERR_OP_EMPTY, /* missing option string, using "": OP */
151: MANDOCERR_UR_NOHEAD, /* missing resource identifier, using "": UR */
1.105 schwarze 152: MANDOCERR_EQN_NOBOX, /* missing eqn box, using "": op */
1.19 schwarze 153:
1.81 schwarze 154: /* related to bad arguments */
1.79 schwarze 155: MANDOCERR_ARG_REP, /* duplicate argument: macro arg */
1.93 schwarze 156: MANDOCERR_AN_REP, /* skipping duplicate argument: An -arg */
1.95 schwarze 157: MANDOCERR_BD_REP, /* skipping duplicate display type: Bd -type */
158: MANDOCERR_BL_REP, /* skipping duplicate list type: Bl -type */
1.93 schwarze 159: MANDOCERR_BL_SKIPW, /* skipping -width argument: Bl -type */
1.142 schwarze 160: MANDOCERR_BL_COL, /* wrong number of cells */
1.95 schwarze 161: MANDOCERR_AT_BAD, /* unknown AT&T UNIX version: At version */
1.100 schwarze 162: MANDOCERR_FA_COMMA, /* comma in function argument: arg */
1.104 schwarze 163: MANDOCERR_FN_PAREN, /* parenthesis in function name: arg */
1.167 schwarze 164: MANDOCERR_LB_BAD, /* unknown library name: Lb ... */
1.84 schwarze 165: MANDOCERR_RS_BAD, /* invalid content in Rs block: macro */
1.80 schwarze 166: MANDOCERR_SM_BAD, /* invalid Boolean argument: macro arg */
1.195 schwarze 167: MANDOCERR_CHAR_FONT, /* argument contains two font escapes */
1.95 schwarze 168: MANDOCERR_FT_BAD, /* unknown font, skipping request: ft font */
1.218 schwarze 169: MANDOCERR_MC_DIST, /* ignoring distance argument: mc ... arg */
1.142 schwarze 170: MANDOCERR_TR_ODD, /* odd number of characters in request: tr char */
1.19 schwarze 171:
172: /* related to plain text */
1.81 schwarze 173: MANDOCERR_FI_BLANK, /* blank line in fill mode, using .sp */
174: MANDOCERR_FI_TAB, /* tab in filled text */
1.156 schwarze 175: MANDOCERR_EOS, /* new sentence, new line */
1.221 schwarze 176: MANDOCERR_ESC_ARG, /* invalid escape sequence argument: esc */
1.203 schwarze 177: MANDOCERR_ESC_UNDEF, /* undefined escape, printing literally: char */
1.81 schwarze 178: MANDOCERR_STR_UNDEF, /* undefined string, using "": name */
1.8 schwarze 179:
1.131 schwarze 180: /* related to tables */
181: MANDOCERR_TBLLAYOUT_SPAN, /* tbl line starts with span */
182: MANDOCERR_TBLLAYOUT_DOWN, /* tbl column starts with span */
183: MANDOCERR_TBLLAYOUT_VERT, /* skipping vertical bar in tbl layout */
184:
1.16 schwarze 185: MANDOCERR_ERROR, /* ===== start of errors ===== */
1.40 schwarze 186:
1.27 schwarze 187: /* related to tables */
1.129 schwarze 188: MANDOCERR_TBLOPT_ALPHA, /* non-alphabetic character in tbl options */
189: MANDOCERR_TBLOPT_BAD, /* skipping unknown tbl option: option */
1.133 schwarze 190: MANDOCERR_TBLOPT_NOARG, /* missing tbl option argument: option */
191: MANDOCERR_TBLOPT_ARGSZ, /* wrong tbl option argument size: option */
1.131 schwarze 192: MANDOCERR_TBLLAYOUT_NONE, /* empty tbl layout */
193: MANDOCERR_TBLLAYOUT_CHAR, /* invalid character in tbl layout: char */
194: MANDOCERR_TBLLAYOUT_PAR, /* unmatched parenthesis in tbl layout */
1.211 schwarze 195: MANDOCERR_TBLLAYOUT_SPC, /* ignoring excessive spacing in tbl layout */
1.133 schwarze 196: MANDOCERR_TBLDATA_NONE, /* tbl without any data cells */
197: MANDOCERR_TBLDATA_SPAN, /* ignoring data in spanned tbl cell: data */
198: MANDOCERR_TBLDATA_EXTRA, /* ignoring extra tbl data cells: data */
199: MANDOCERR_TBLDATA_BLK, /* data block open at end of tbl: macro */
1.27 schwarze 200:
1.85 schwarze 201: /* related to document structure and macros */
1.185 schwarze 202: MANDOCERR_PROLOG_REP, /* duplicate prologue macro: macro */
203: MANDOCERR_DT_LATE, /* skipping late title macro: Dt args */
1.25 schwarze 204: MANDOCERR_ROFFLOOP, /* input stack limit exceeded, infinite loop? */
1.127 schwarze 205: MANDOCERR_CHAR_BAD, /* skipping bad character: number */
1.95 schwarze 206: MANDOCERR_MACRO, /* skipping unknown macro: macro */
1.192 schwarze 207: MANDOCERR_REQ_NOMAC, /* skipping request outside macro: ... */
1.125 schwarze 208: MANDOCERR_REQ_INSEC, /* skipping insecure request: request */
1.95 schwarze 209: MANDOCERR_IT_STRAY, /* skipping item outside list: It ... */
210: MANDOCERR_TA_STRAY, /* skipping column outside column list: Ta */
1.85 schwarze 211: MANDOCERR_BLK_NOTOPEN, /* skipping end of block that is not open */
1.128 schwarze 212: MANDOCERR_RE_NOTOPEN, /* fewer RS blocks open, skipping: RE arg */
1.85 schwarze 213: MANDOCERR_BLK_BROKEN, /* inserting missing end of block: macro ... */
214: MANDOCERR_BLK_NOEND, /* appending missing end of block: macro */
215:
216: /* related to request and macro arguments */
1.95 schwarze 217: MANDOCERR_NAMESC, /* escaped character not allowed in a name: name */
1.192 schwarze 218: MANDOCERR_ARG_UNDEF, /* using macro argument outside macro */
219: MANDOCERR_ARG_NONUM, /* argument number is not numeric */
1.217 schwarze 220: MANDOCERR_ARG_NEG, /* negative argument, using 0: request arg */
1.114 schwarze 221: MANDOCERR_BD_FILE, /* NOT IMPLEMENTED: Bd -file */
1.149 schwarze 222: MANDOCERR_BD_NOARG, /* skipping display without arguments: Bd */
1.95 schwarze 223: MANDOCERR_BL_NOTYPE, /* missing list type, using -item: Bl */
1.165 schwarze 224: MANDOCERR_CE_NONUM, /* argument is not numeric, using 1: ce ... */
1.195 schwarze 225: MANDOCERR_CHAR_ARG, /* argument is not a character: char ... */
1.218 schwarze 226: MANDOCERR_MC_ESC, /* skipping unusable escape sequence: mc arg */
1.95 schwarze 227: MANDOCERR_NM_NONAME, /* missing manual name, using "": Nm */
1.88 schwarze 228: MANDOCERR_OS_UNAME, /* uname(3) system call failed, using UNKNOWN */
1.95 schwarze 229: MANDOCERR_ST_BAD, /* unknown standard specifier: St standard */
1.88 schwarze 230: MANDOCERR_IT_NONUM, /* skipping request without numeric argument */
1.192 schwarze 231: MANDOCERR_SHIFT, /* excessive shift: ..., but max is ... */
1.122 schwarze 232: MANDOCERR_SO_PATH, /* NOT IMPLEMENTED: .so with absolute path or ".." */
1.123 schwarze 233: MANDOCERR_SO_FAIL, /* .so request failed */
1.208 schwarze 234: MANDOCERR_TG_SPC, /* skipping tag containing whitespace: tag */
1.78 schwarze 235: MANDOCERR_ARG_SKIP, /* skipping all arguments: macro args */
236: MANDOCERR_ARG_EXCESS, /* skipping excess arguments: macro ... args */
1.107 schwarze 237: MANDOCERR_DIVZERO, /* divide by zero */
1.220 schwarze 238:
239: /* related to escape sequences */
240: MANDOCERR_ESC_INCOMPLETE, /* incomplete escape sequence: esc */
241: MANDOCERR_ESC_BADCHAR, /* invalid special character: esc */
242: MANDOCERR_ESC_UNKCHAR, /* unknown special character: esc */
1.221 schwarze 243: MANDOCERR_ESC_DELIM, /* invalid escape argument delimiter: esc */
1.125 schwarze 244:
245: MANDOCERR_UNSUPP, /* ===== start of unsupported features ===== */
246:
247: MANDOCERR_TOOLARGE, /* input too large */
1.127 schwarze 248: MANDOCERR_CHAR_UNSUPP, /* unsupported control character: number */
1.203 schwarze 249: MANDOCERR_ESC_UNSUPP, /* unsupported escape sequence: escape */
1.125 schwarze 250: MANDOCERR_REQ_UNSUPP, /* unsupported roff request: request */
1.194 schwarze 251: MANDOCERR_WHILE_NEST, /* nested .while loops */
252: MANDOCERR_WHILE_OUTOF, /* end of scope with open .while loop */
253: MANDOCERR_WHILE_INTO, /* end of .while loop in inner scope */
254: MANDOCERR_WHILE_FAIL, /* cannot continue this .while loop */
1.133 schwarze 255: MANDOCERR_TBLOPT_EQN, /* eqn delim option in tbl: arg */
1.131 schwarze 256: MANDOCERR_TBLLAYOUT_MOD, /* unsupported tbl layout modifier: m */
1.125 schwarze 257: MANDOCERR_TBLMACRO, /* ignoring macro in table: macro */
1.214 schwarze 258: MANDOCERR_TBL_TMAN, /* skipping tbl in -Tman mode */
259: MANDOCERR_EQN_TMAN, /* skipping eqn in -Tman mode */
1.205 schwarze 260:
261: MANDOCERR_BADARG, /* ===== start of bad invocations ===== */
262:
263: MANDOCERR_BADARG_BAD, /* bad argument */
264: MANDOCERR_BADARG_DUPE, /* duplicate argument */
265: MANDOCERR_BADVAL, /* does not take a value */
266: MANDOCERR_BADVAL_MISS, /* missing argument value */
267: MANDOCERR_BADVAL_BAD, /* bad argument value */
268: MANDOCERR_BADVAL_DUPE, /* duplicate argument value */
269: MANDOCERR_TAG, /* no such tag */
1.216 schwarze 270: MANDOCERR_MAN_TMARKDOWN, /* -Tmarkdown unsupported for man(7) input */
1.205 schwarze 271:
272: MANDOCERR_SYSERR, /* ===== start of system errors ===== */
273:
274: MANDOCERR_DUP,
275: MANDOCERR_EXEC,
276: MANDOCERR_FDOPEN,
277: MANDOCERR_FFLUSH,
278: MANDOCERR_FORK,
279: MANDOCERR_FSTAT,
280: MANDOCERR_GETLINE,
281: MANDOCERR_GLOB,
282: MANDOCERR_GZCLOSE,
283: MANDOCERR_GZDOPEN,
284: MANDOCERR_MKSTEMP,
285: MANDOCERR_OPEN,
286: MANDOCERR_PLEDGE,
287: MANDOCERR_READ,
288: MANDOCERR_WAIT,
289: MANDOCERR_WRITE,
1.57 schwarze 290:
1.1 schwarze 291: MANDOCERR_MAX
292: };
293:
1.38 schwarze 294: enum mandoc_esc {
1.219 schwarze 295: ESCAPE_EXPAND = 0, /* interpolation and iterative call needed */
296: ESCAPE_ERROR, /* non-fatal error: unparsable escape */
297: ESCAPE_UNSUPP, /* unsupported escape: warn and ignore */
298: ESCAPE_IGNORE, /* valid escape to be ignored */
299: ESCAPE_UNDEF, /* undefined escape: print literal character */
300: ESCAPE_SPECIAL, /* special character escape */
1.38 schwarze 301: ESCAPE_FONT, /* a generic font mode */
302: ESCAPE_FONTBOLD, /* bold font mode */
303: ESCAPE_FONTITALIC, /* italic font mode */
1.53 schwarze 304: ESCAPE_FONTBI, /* bold italic font mode */
1.38 schwarze 305: ESCAPE_FONTROMAN, /* roman font mode */
1.215 schwarze 306: ESCAPE_FONTCR, /* constant width font mode */
307: ESCAPE_FONTCB, /* constant width bold font mode */
308: ESCAPE_FONTCI, /* constant width italic font mode */
1.38 schwarze 309: ESCAPE_FONTPREV, /* previous font mode */
310: ESCAPE_NUMBERED, /* a numbered glyph */
311: ESCAPE_UNICODE, /* a unicode codepoint */
1.191 schwarze 312: ESCAPE_DEVICE, /* print the output device name */
1.172 schwarze 313: ESCAPE_BREAK, /* break the output line */
1.46 schwarze 314: ESCAPE_NOSPACE, /* suppress space if the last on a line */
1.162 schwarze 315: ESCAPE_HORIZ, /* horizontal movement */
1.163 schwarze 316: ESCAPE_HLINE, /* horizontal line drawing */
1.126 schwarze 317: ESCAPE_SKIPCHAR, /* skip the next character */
318: ESCAPE_OVERSTRIKE /* overstrike all chars in the argument */
1.38 schwarze 319: };
320:
1.118 schwarze 321:
1.209 schwarze 322: enum mandoc_esc mandoc_font(const char *, int);
1.56 schwarze 323: enum mandoc_esc mandoc_escape(const char **, const char **, int *);
1.201 schwarze 324: void mandoc_msg_setoutfile(FILE *);
325: const char *mandoc_msg_getinfilename(void);
326: void mandoc_msg_setinfilename(const char *);
327: enum mandocerr mandoc_msg_getmin(void);
328: void mandoc_msg_setmin(enum mandocerr);
329: enum mandoclevel mandoc_msg_getrc(void);
330: void mandoc_msg_setrc(enum mandoclevel);
1.202 schwarze 331: void mandoc_msg(enum mandocerr, int, int, const char *, ...)
332: __attribute__((__format__ (__printf__, 4, 5)));
1.206 schwarze 333: void mandoc_msg_summary(void);
1.148 schwarze 334: void mchars_alloc(void);
335: void mchars_free(void);
1.110 schwarze 336: int mchars_num2char(const char *, size_t);
1.108 schwarze 337: const char *mchars_uc2str(int);
1.38 schwarze 338: int mchars_num2uc(const char *, size_t);
1.148 schwarze 339: int mchars_spec2cp(const char *, size_t);
340: const char *mchars_spec2str(const char *, size_t, size_t *);