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         "unsupported feature",
 240         "input too large",
 241         "unsupported control character",
 242         "unsupported escape sequence",
 243         "unsupported roff request",
 244         "nested .while loops",
 245         "end of scope with open .while loop",
 246         "end of .while loop in inner scope",
 247         "cannot continue this .while loop",
 248         "eqn delim option in tbl",
 249         "unsupported tbl layout modifier",
 250         "ignoring macro in table",
 251         "skipping tbl in -Tman mode",
 252         "skipping eqn in -Tman mode",
 253
 254         /* bad command line arguments */
 255         NULL,
 256         "bad command line argument",
 257         "duplicate command line argument",
 258         "option has a superfluous value",
 259         "missing option value",
 260         "bad option value",
 261         "duplicate option value",
 262         "no such tag",
 263         "-Tmarkdown unsupported for man(7) input",
 264
 265         /* system errors */
 266         NULL,
 267         "dup",
 268         "exec",
 269         "fdopen",
 270         "fflush",
 271         "fork",
 272         "fstat",
 273         "getline",
 274         "glob",
 275         "gzclose",
 276         "gzdopen",
 277         "mkstemp",
 278         "open",
 279         "pledge",
 280         "read",
 281         "wait",
 282         "write",
 283 };
 284
 285 static  FILE            *fileptr = NULL;
 286 static  const char      *filename = NULL;
 287 static  enum mandocerr   min_type = MANDOCERR_BADARG;
 288 static  enum mandoclevel rc = MANDOCLEVEL_OK;
 289
 290
 291 void
 292 mandoc_msg_setoutfile(FILE *fp)
 293 {
 294         fileptr = fp;
 295 }
 296
 297 const char *
 298 mandoc_msg_getinfilename(void)
 299 {
 300         return filename;
 301 }
 302
 303 void
 304 mandoc_msg_setinfilename(const char *fn)
 305 {
 306         filename = fn;
 307 }
 308
 309 enum mandocerr
 310 mandoc_msg_getmin(void)
 311 {
 312         return min_type;
 313 }
 314
 315 void
 316 mandoc_msg_setmin(enum mandocerr t)
 317 {
 318         min_type = t;
 319 }
 320
 321 enum mandoclevel
 322 mandoc_msg_getrc(void)
 323 {
 324         return rc;
 325 }
 326
 327 void
 328 mandoc_msg_setrc(enum mandoclevel level)
 329 {
 330         if (rc < level)
 331                 rc = level;
 332 }
 333
 334 void
 335 mandoc_msg(enum mandocerr t, int line, int col, const char *fmt, ...)
 336 {
 337         va_list                  ap;
 338         enum mandoclevel         level;
 339
 340         if (t < min_type)
 341                 return;
 342
 343         level = MANDOCLEVEL_SYSERR;
 344         while (t < lowest_type[level])
 345                 level--;
 346         mandoc_msg_setrc(level);
 347
 348         if (fileptr == NULL)
 349                 return;
 350
 351         fprintf(fileptr, "%s:", getprogname());
 352         if (filename != NULL)
 353                 fprintf(fileptr, " %s:", filename);
 354
 355         if (line > 0)
 356                 fprintf(fileptr, "%d:%d:", line, col + 1);
 357
 358         fprintf(fileptr, " %s", level_name[level]);
 359         if (type_message[t] != NULL)
 360                 fprintf(fileptr, ": %s", type_message[t]);
 361
 362         if (fmt != NULL) {
 363                 fprintf(fileptr, ": ");
 364                 va_start(ap, fmt);
 365                 vfprintf(fileptr, fmt, ap);
 366                 va_end(ap);
 367         }
 368         fputc('\n', fileptr);
 369 }
 370
 371 void
 372 mandoc_msg_summary(void)
 373 {
 374         if (fileptr != NULL && rc != MANDOCLEVEL_OK)
 375                 fprintf(fileptr,
 376                     "%s: see above the output for %s messages\n",
 377                     getprogname(), level_name[rc]);
 378 }