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