1 /* $OpenBSD: mandoc_msg.c,v 1.13 2021/07/04 15:38:09 schwarze Exp $ */ 2 /* 3 * Copyright (c) 2014-2021 Ingo Schwarze <schwarze@openbsd.org> 4 * Copyright (c) 2010, 2011 Kristaps Dzonsons <kristaps@bsd.lv> 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 * 10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHORS DISCLAIM ALL WARRANTIES 11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR 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 * 18 * Implementation of warning and error messages for mandoc(1). 19 */ 20 #include <stdarg.h> 21 #include <stdio.h> 22 #include <stdlib.h> 23 24 #include "mandoc.h" 25 26 static const enum mandocerr lowest_type[MANDOCLEVEL_MAX] = { 27 MANDOCERR_OK, 28 MANDOCERR_OK, 29 MANDOCERR_WARNING, 30 MANDOCERR_ERROR, 31 MANDOCERR_UNSUPP, 32 MANDOCERR_BADARG, 33 MANDOCERR_SYSERR 34 }; 35 36 static const char *const level_name[MANDOCLEVEL_MAX] = { 37 "SUCCESS", 38 "STYLE", 39 "WARNING", 40 "ERROR", 41 "UNSUPP", 42 "BADARG", 43 "SYSERR" 44 }; 45 46 static const char *const type_message[MANDOCERR_MAX] = { 47 "ok", 48 49 "base system convention", 50 51 "Mdocdate found", 52 "Mdocdate missing", 53 "unknown architecture", 54 "operating system explicitly specified", 55 "RCS id missing", 56 57 "generic style suggestion", 58 59 "legacy man(7) date format", 60 "normalizing date format to", 61 "lower case character in document title", 62 "duplicate RCS id", 63 "possible typo in section name", 64 "unterminated quoted argument", 65 "useless macro", 66 "consider using OS macro", 67 "errnos out of order", 68 "duplicate errno", 69 "referenced manual not found", 70 "trailing delimiter", 71 "no blank before trailing delimiter", 72 "fill mode already enabled, skipping", 73 "fill mode already disabled, skipping", 74 "input text line longer than 80 bytes", 75 "verbatim \"--\", maybe consider using \\(em", 76 "function name without markup", 77 "whitespace at end of input line", 78 "bad comment style", 79 80 "generic warning", 81 82 /* related to the prologue */ 83 "missing manual title, using UNTITLED", 84 "missing manual title, using \"\"", 85 "missing manual section, using \"\"", 86 "unknown manual section", 87 "filename/section mismatch", 88 "missing date, using \"\"", 89 "cannot parse date, using it verbatim", 90 "date in the future, using it anyway", 91 "missing Os macro, using \"\"", 92 "late prologue macro", 93 "prologue macros out of order", 94 95 /* related to document structure */ 96 ".so is fragile, better use ln(1)", 97 "no document body", 98 "content before first section header", 99 "first section is not \"NAME\"", 100 "NAME section without Nm before Nd", 101 "NAME section without description", 102 "description not at the end of NAME", 103 "bad NAME section content", 104 "missing comma before name", 105 "missing description line, using \"\"", 106 "description line outside NAME section", 107 "sections out of conventional order", 108 "duplicate section title", 109 "unexpected section", 110 "cross reference to self", 111 "unusual Xr order", 112 "unusual Xr punctuation", 113 "AUTHORS section without An macro", 114 115 /* related to macros and nesting */ 116 "obsolete macro", 117 "macro neither callable nor escaped", 118 "skipping paragraph macro", 119 "moving paragraph macro out of list", 120 "skipping no-space macro", 121 "blocks badly nested", 122 "nested displays are not portable", 123 "moving content out of list", 124 "first macro on line", 125 "line scope broken", 126 "skipping blank line in line scope", 127 128 /* related to missing macro arguments */ 129 "skipping empty request", 130 "conditional request controls empty scope", 131 "skipping empty macro", 132 "empty block", 133 "empty argument, using 0n", 134 "missing display type, using -ragged", 135 "list type is not the first argument", 136 "missing -width in -tag list, using 6n", 137 "missing utility name, using \"\"", 138 "missing function name, using \"\"", 139 "empty head in list item", 140 "empty list item", 141 "missing argument, using next line", 142 "missing font type, using \\fR", 143 "unknown font type, using \\fR", 144 "nothing follows prefix", 145 "empty reference block", 146 "missing section argument", 147 "missing -std argument, adding it", 148 "missing option string, using \"\"", 149 "missing resource identifier, using \"\"", 150 "missing eqn box, using \"\"", 151 152 /* related to bad macro arguments */ 153 "duplicate argument", 154 "skipping duplicate argument", 155 "skipping duplicate display type", 156 "skipping duplicate list type", 157 "skipping -width argument", 158 "wrong number of cells", 159 "unknown AT&T UNIX version", 160 "comma in function argument", 161 "parenthesis in function name", 162 "unknown library name", 163 "invalid content in Rs block", 164 "invalid Boolean argument", 165 "argument contains two font escapes", 166 "unknown font, skipping request", 167 "odd number of characters in request", 168 169 /* related to plain text */ 170 "blank line in fill mode, using .sp", 171 "tab in filled text", 172 "new sentence, new line", 173 "invalid escape sequence", 174 "undefined escape, printing literally", 175 "undefined string, using \"\"", 176 177 /* related to tables */ 178 "tbl line starts with span", 179 "tbl column starts with span", 180 "skipping vertical bar in tbl layout", 181 182 "generic error", 183 184 /* related to tables */ 185 "non-alphabetic character in tbl options", 186 "skipping unknown tbl option", 187 "missing tbl option argument", 188 "wrong tbl option argument size", 189 "empty tbl layout", 190 "invalid character in tbl layout", 191 "unmatched parenthesis in tbl layout", 192 "ignoring excessive spacing in tbl layout", 193 "tbl without any data cells", 194 "ignoring data in spanned tbl cell", 195 "ignoring extra tbl data cells", 196 "data block open at end of tbl", 197 198 /* related to document structure and macros */ 199 "duplicate prologue macro", 200 "skipping late title macro", 201 "input stack limit exceeded, infinite loop?", 202 "skipping bad character", 203 "skipping unknown macro", 204 "ignoring request outside macro", 205 "skipping insecure request", 206 "skipping item outside list", 207 "skipping column outside column list", 208 "skipping end of block that is not open", 209 "fewer RS blocks open, skipping", 210 "inserting missing end of block", 211 "appending missing end of block", 212 213 /* related to request and macro arguments */ 214 "escaped character not allowed in a name", 215 "using macro argument outside macro", 216 "argument number is not numeric", 217 "NOT IMPLEMENTED: Bd -file", 218 "skipping display without arguments", 219 "missing list type, using -item", 220 "argument is not numeric, using 1", 221 "argument is not a character", 222 "missing manual name, using \"\"", 223 "uname(3) system call failed, using UNKNOWN", 224 "unknown standard specifier", 225 "skipping request without numeric argument", 226 "excessive shift", 227 "NOT IMPLEMENTED: .so with absolute path or \"..\"", 228 ".so request failed", 229 "skipping tag containing whitespace", 230 "skipping all arguments", 231 "skipping excess arguments", 232 "divide by zero", 233 234 "unsupported feature", 235 "input too large", 236 "unsupported control character", 237 "unsupported escape sequence", 238 "unsupported roff request", 239 "nested .while loops", 240 "end of scope with open .while loop", 241 "end of .while loop in inner scope", 242 "cannot continue this .while loop", 243 "eqn delim option in tbl", 244 "unsupported tbl layout modifier", 245 "ignoring macro in table", 246 "skipping tbl in -Tman mode", 247 "skipping eqn in -Tman mode", 248 249 /* bad command line arguments */ 250 NULL, 251 "bad command line argument", 252 "duplicate command line argument", 253 "option has a superfluous value", 254 "missing option value", 255 "bad option value", 256 "duplicate option value", 257 "no such tag", 258 259 /* system errors */ 260 NULL, 261 "dup", 262 "exec", 263 "fdopen", 264 "fflush", 265 "fork", 266 "fstat", 267 "getline", 268 "glob", 269 "gzclose", 270 "gzdopen", 271 "mkstemp", 272 "open", 273 "pledge", 274 "read", 275 "wait", 276 "write", 277 }; 278 279 static FILE *fileptr = NULL; 280 static const char *filename = NULL; 281 static enum mandocerr min_type = MANDOCERR_BADARG; 282 static enum mandoclevel rc = MANDOCLEVEL_OK; 283 284 285 void 286 mandoc_msg_setoutfile(FILE *fp) 287 { 288 fileptr = fp; 289 } 290 291 const char * 292 mandoc_msg_getinfilename(void) 293 { 294 return filename; 295 } 296 297 void 298 mandoc_msg_setinfilename(const char *fn) 299 { 300 filename = fn; 301 } 302 303 enum mandocerr 304 mandoc_msg_getmin(void) 305 { 306 return min_type; 307 } 308 309 void 310 mandoc_msg_setmin(enum mandocerr t) 311 { 312 min_type = t; 313 } 314 315 enum mandoclevel 316 mandoc_msg_getrc(void) 317 { 318 return rc; 319 } 320 321 void 322 mandoc_msg_setrc(enum mandoclevel level) 323 { 324 if (rc < level) 325 rc = level; 326 } 327 328 void 329 mandoc_msg(enum mandocerr t, int line, int col, const char *fmt, ...) 330 { 331 va_list ap; 332 enum mandoclevel level; 333 334 if (t < min_type) 335 return; 336 337 level = MANDOCLEVEL_SYSERR; 338 while (t < lowest_type[level]) 339 level--; 340 mandoc_msg_setrc(level); 341 342 if (fileptr == NULL) 343 return; 344 345 fprintf(fileptr, "%s:", getprogname()); 346 if (filename != NULL) 347 fprintf(fileptr, " %s:", filename); 348 349 if (line > 0) 350 fprintf(fileptr, "%d:%d:", line, col + 1); 351 352 fprintf(fileptr, " %s", level_name[level]); 353 if (type_message[t] != NULL) 354 fprintf(fileptr, ": %s", type_message[t]); 355 356 if (fmt != NULL) { 357 fprintf(fileptr, ": "); 358 va_start(ap, fmt); 359 vfprintf(fileptr, fmt, ap); 360 va_end(ap); 361 } 362 fputc('\n', fileptr); 363 } 364 365 void 366 mandoc_msg_summary(void) 367 { 368 if (fileptr != NULL && rc != MANDOCLEVEL_OK) 369 fprintf(fileptr, 370 "%s: see above the output for %s messages\n", 371 getprogname(), level_name[rc]); 372 } 373