mandoc_msg.c

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