Annotation of mandoc/mandoc_msg.c, Revision 1.16
1.11 schwarze 1: /* $OpenBSD: mandoc_msg.c,v 1.8 2020/01/19 17:59:01 schwarze Exp $ */
1.1 schwarze 2: /*
1.15 schwarze 3: * Copyright (c) 2014-2021 Ingo Schwarze <schwarze@openbsd.org>
1.1 schwarze 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.
1.11 schwarze 17: *
18: * Implementation of warning and error messages for mandoc(1).
1.1 schwarze 19: */
1.6 schwarze 20: #include "config.h"
21:
1.1 schwarze 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,
1.7 schwarze 34: MANDOCERR_BADARG,
35: MANDOCERR_SYSERR
1.1 schwarze 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",
1.13 schwarze 71: "referenced manual not found",
1.1 schwarze 72: "trailing delimiter",
73: "no blank before trailing delimiter",
74: "fill mode already enabled, skipping",
75: "fill mode already disabled, skipping",
1.14 schwarze 76: "input text line longer than 80 bytes",
1.1 schwarze 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",
1.11 schwarze 89: "filename/section mismatch",
1.9 schwarze 90: "missing date, using \"\"",
1.1 schwarze 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: "odd number of characters in request",
170:
171: /* related to plain text */
172: "blank line in fill mode, using .sp",
173: "tab in filled text",
174: "new sentence, new line",
175: "invalid escape sequence",
1.3 schwarze 176: "undefined escape, printing literally",
1.1 schwarze 177: "undefined string, using \"\"",
178:
179: /* related to tables */
180: "tbl line starts with span",
181: "tbl column starts with span",
182: "skipping vertical bar in tbl layout",
183:
184: "generic error",
185:
186: /* related to tables */
187: "non-alphabetic character in tbl options",
188: "skipping unknown tbl option",
189: "missing tbl option argument",
190: "wrong tbl option argument size",
191: "empty tbl layout",
192: "invalid character in tbl layout",
193: "unmatched parenthesis in tbl layout",
1.12 schwarze 194: "ignoring excessive spacing in tbl layout",
1.1 schwarze 195: "tbl without any data cells",
196: "ignoring data in spanned tbl cell",
197: "ignoring extra tbl data cells",
198: "data block open at end of tbl",
199:
200: /* related to document structure and macros */
201: "duplicate prologue macro",
202: "skipping late title macro",
203: "input stack limit exceeded, infinite loop?",
204: "skipping bad character",
205: "skipping unknown macro",
206: "ignoring request outside macro",
207: "skipping insecure request",
208: "skipping item outside list",
209: "skipping column outside column list",
210: "skipping end of block that is not open",
211: "fewer RS blocks open, skipping",
212: "inserting missing end of block",
213: "appending missing end of block",
214:
215: /* related to request and macro arguments */
216: "escaped character not allowed in a name",
217: "using macro argument outside macro",
218: "argument number is not numeric",
219: "NOT IMPLEMENTED: Bd -file",
220: "skipping display without arguments",
221: "missing list type, using -item",
222: "argument is not numeric, using 1",
223: "argument is not a character",
224: "missing manual name, using \"\"",
225: "uname(3) system call failed, using UNKNOWN",
226: "unknown standard specifier",
227: "skipping request without numeric argument",
228: "excessive shift",
229: "NOT IMPLEMENTED: .so with absolute path or \"..\"",
230: ".so request failed",
1.10 schwarze 231: "skipping tag containing whitespace",
1.1 schwarze 232: "skipping all arguments",
233: "skipping excess arguments",
234: "divide by zero",
235:
236: "unsupported feature",
237: "input too large",
238: "unsupported control character",
1.3 schwarze 239: "unsupported escape sequence",
1.1 schwarze 240: "unsupported roff request",
241: "nested .while loops",
242: "end of scope with open .while loop",
243: "end of .while loop in inner scope",
244: "cannot continue this .while loop",
245: "eqn delim option in tbl",
246: "unsupported tbl layout modifier",
247: "ignoring macro in table",
1.15 schwarze 248: "skipping tbl in -Tman mode",
249: "skipping eqn in -Tman mode",
1.7 schwarze 250:
251: /* bad command line arguments */
252: NULL,
253: "bad command line argument",
254: "duplicate command line argument",
255: "option has a superfluous value",
256: "missing option value",
257: "bad option value",
258: "duplicate option value",
259: "no such tag",
1.16 ! schwarze 260: "-Tmarkdown unsupported for man(7) input",
1.7 schwarze 261:
262: /* system errors */
263: NULL,
264: "dup",
265: "exec",
266: "fdopen",
267: "fflush",
268: "fork",
269: "fstat",
270: "getline",
271: "glob",
272: "gzclose",
273: "gzdopen",
274: "mkstemp",
275: "open",
276: "pledge",
277: "read",
278: "wait",
279: "write",
1.1 schwarze 280: };
281:
1.5 schwarze 282: static FILE *fileptr = NULL;
1.1 schwarze 283: static const char *filename = NULL;
1.7 schwarze 284: static enum mandocerr min_type = MANDOCERR_BADARG;
1.1 schwarze 285: static enum mandoclevel rc = MANDOCLEVEL_OK;
286:
287:
288: void
289: mandoc_msg_setoutfile(FILE *fp)
290: {
291: fileptr = fp;
292: }
293:
294: const char *
295: mandoc_msg_getinfilename(void)
296: {
297: return filename;
298: }
299:
300: void
301: mandoc_msg_setinfilename(const char *fn)
302: {
303: filename = fn;
304: }
305:
306: enum mandocerr
307: mandoc_msg_getmin(void)
308: {
309: return min_type;
310: }
311:
312: void
313: mandoc_msg_setmin(enum mandocerr t)
314: {
315: min_type = t;
316: }
317:
318: enum mandoclevel
319: mandoc_msg_getrc(void)
320: {
321: return rc;
322: }
323:
324: void
325: mandoc_msg_setrc(enum mandoclevel level)
326: {
327: if (rc < level)
328: rc = level;
329: }
330:
331: void
1.2 schwarze 332: mandoc_msg(enum mandocerr t, int line, int col, const char *fmt, ...)
1.1 schwarze 333: {
334: va_list ap;
335: enum mandoclevel level;
336:
1.7 schwarze 337: if (t < min_type)
1.1 schwarze 338: return;
339:
1.7 schwarze 340: level = MANDOCLEVEL_SYSERR;
1.1 schwarze 341: while (t < lowest_type[level])
342: level--;
343: mandoc_msg_setrc(level);
344:
345: if (fileptr == NULL)
346: return;
347:
348: fprintf(fileptr, "%s:", getprogname());
349: if (filename != NULL)
350: fprintf(fileptr, " %s:", filename);
351:
352: if (line > 0)
353: fprintf(fileptr, "%d:%d:", line, col + 1);
354:
355: fprintf(fileptr, " %s", level_name[level]);
356: if (type_message[t] != NULL)
357: fprintf(fileptr, ": %s", type_message[t]);
358:
359: if (fmt != NULL) {
360: fprintf(fileptr, ": ");
361: va_start(ap, fmt);
362: vfprintf(fileptr, fmt, ap);
363: va_end(ap);
364: }
365: fputc('\n', fileptr);
1.8 schwarze 366: }
367:
368: void
369: mandoc_msg_summary(void)
370: {
371: if (fileptr != NULL && rc != MANDOCLEVEL_OK)
372: fprintf(fileptr,
373: "%s: see above the output for %s messages\n",
374: getprogname(), level_name[rc]);
1.1 schwarze 375: }
CVSweb
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to mandoc_msg.c CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [cvsweb.bsd.lv] / mandoc