1 /* PSPP - a program for statistical analysis.
2 Copyright (C) 1997-9, 2000, 2006, 2009, 2010,
3 2011, 2013 Free Software Foundation, Inc.
5 This program is free software: you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation, either version 3 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>. */
20 #include "libpspp/message.h"
29 #include "libpspp/cast.h"
30 #include "libpspp/str.h"
31 #include "libpspp/version.h"
32 #include "data/settings.h"
34 #include "gl/minmax.h"
35 #include "gl/progname.h"
36 #include "gl/relocatable.h"
37 #include "gl/xalloc.h"
38 #include "gl/xvasprintf.h"
41 #define _(msgid) gettext (msgid)
43 /* Message handler as set by msg_set_handler(). */
44 static void (*msg_handler) (const struct msg *, void *aux);
47 /* Disables emitting messages if positive. */
48 static int messages_disabled;
50 /* Public functions. */
54 vmsg (enum msg_class class, const char *format, va_list args)
57 .category = msg_class_to_category (class),
58 .severity = msg_class_to_severity (class),
59 .text = xvasprintf (format, args),
65 /* Writes error message in CLASS, with text FORMAT, formatted with
66 printf, to the standard places. */
68 msg (enum msg_class class, const char *format, ...)
71 va_start (args, format);
72 vmsg (class, format, args);
79 msg_error (int errnum, const char *format, ...)
82 va_start (args, format);
83 char *e = xvasprintf (format, args);
87 .category = MSG_C_GENERAL,
88 .severity = MSG_S_ERROR,
89 .text = xasprintf (_("%s: %s"), e, strerror (errnum)),
99 msg_set_handler (void (*handler) (const struct msg *, void *aux), void *aux)
101 msg_handler = handler;
108 msg_location_destroy (struct msg_location *loc)
112 free (loc->file_name);
117 struct msg_location *
118 msg_location_dup (const struct msg_location *src)
123 struct msg_location *dst = xmalloc (sizeof *dst);
124 *dst = (struct msg_location) {
125 .file_name = xstrdup_if_nonnull (src->file_name),
126 .first_line = src->first_line,
127 .last_line = src->last_line,
128 .first_column = src->first_column,
129 .last_column = src->last_column,
135 msg_location_is_empty (const struct msg_location *loc)
137 return !loc || (!loc->file_name
138 && loc->first_line <= 0
139 && loc->first_column <= 0);
143 msg_location_format (const struct msg_location *loc, struct string *s)
149 ds_put_cstr (s, loc->file_name);
151 int l1 = loc->first_line;
152 int l2 = MAX (loc->first_line, loc->last_line - 1);
153 int c1 = loc->first_column;
154 int c2 = MAX (loc->first_column, loc->last_column - 1);
159 ds_put_byte (s, ':');
164 ds_put_format (s, "%d.%d-%d.%d", l1, c1, l2, c2);
166 ds_put_format (s, "%d-%d", l1, l2);
174 /* The GNU coding standards say to use
175 LINENO-1.COLUMN-1-COLUMN-2 for this case, but GNU
176 Emacs interprets COLUMN-2 as LINENO-2 if I do that.
177 I've submitted an Emacs bug report:
178 http://debbugs.gnu.org/cgi/bugreport.cgi?bug=7725.
180 For now, let's be compatible. */
181 ds_put_format (s, "%d.%d-%d.%d", l1, c1, l1, c2);
184 ds_put_format (s, "%d.%d", l1, c1);
187 ds_put_format (s, "%d", l1);
193 ds_put_format (s, ".%d-%d", c1, c2);
195 ds_put_format (s, ".%d", c1);
199 /* Working with messages. */
202 msg_severity_to_string (enum msg_severity severity)
216 /* Duplicate a message */
218 msg_dup (const struct msg *src)
220 struct msg *dst = xmalloc (sizeof *dst);
221 *dst = (struct msg) {
222 .category = src->category,
223 .severity = src->severity,
224 .location = msg_location_dup (src->location),
225 .command_name = xstrdup_if_nonnull (src->command_name),
226 .text = xstrdup (src->text),
231 /* Frees a message created by msg_dup().
233 (Messages not created by msg_dup(), as well as their file_name
234 members, are typically not dynamically allocated, so this function should
235 not be used to destroy them.) */
237 msg_destroy (struct msg *m)
241 msg_location_destroy (m->location);
243 free (m->command_name);
249 msg_to_string (const struct msg *m)
255 if (m->category != MSG_C_GENERAL && !msg_location_is_empty (m->location))
257 msg_location_format (m->location, &s);
258 ds_put_cstr (&s, ": ");
261 ds_put_format (&s, "%s: ", msg_severity_to_string (m->severity));
263 if (m->category == MSG_C_SYNTAX && m->command_name != NULL)
264 ds_put_format (&s, "%s: ", m->command_name);
266 ds_put_cstr (&s, m->text);
272 /* Number of messages reported, by severity level. */
273 static int counts[MSG_N_SEVERITIES];
275 /* True after the maximum number of errors or warnings has been exceeded. */
276 static bool too_many_errors;
278 /* True after the maximum number of notes has been exceeded. */
279 static bool too_many_notes;
281 /* True iff warnings have been explicitly disabled (MXWARNS = 0) */
282 static bool warnings_off = false;
284 /* Checks whether we've had so many errors that it's time to quit
285 processing this syntax file. */
287 msg_ui_too_many_errors (void)
289 return too_many_errors;
293 msg_ui_disable_warnings (bool x)
300 msg_ui_reset_counts (void)
304 for (i = 0; i < MSG_N_SEVERITIES; i++)
306 too_many_errors = false;
307 too_many_notes = false;
311 msg_ui_any_errors (void)
313 return counts[MSG_S_ERROR] > 0;
318 ship_message (struct msg *m)
320 enum { MAX_STACK = 4 };
321 static struct msg *stack[MAX_STACK];
324 /* If we're recursing on a given message, or recursing deeply, drop it. */
327 for (size_t i = 0; i < n; i++)
332 if (msg_handler && n <= 1)
333 msg_handler (m, msg_aux);
335 fprintf (stderr, "%s\n", m->text);
340 submit_note (char *s)
343 .category = MSG_C_GENERAL,
344 .severity = MSG_S_NOTE,
355 process_msg (struct msg *m)
357 int n_msgs, max_msgs;
360 || (too_many_notes && m->severity == MSG_S_NOTE)
361 || (warnings_off && m->severity == MSG_S_WARNING))
366 counts[m->severity]++;
367 max_msgs = settings_get_max_messages (m->severity);
368 n_msgs = counts[m->severity];
369 if (m->severity == MSG_S_WARNING)
370 n_msgs += counts[MSG_S_ERROR];
371 if (n_msgs > max_msgs)
373 if (m->severity == MSG_S_NOTE)
375 too_many_notes = true;
376 submit_note (xasprintf (_("Notes (%d) exceed limit (%d). "
377 "Suppressing further notes."),
382 too_many_errors = true;
383 if (m->severity == MSG_S_WARNING)
384 submit_note (xasprintf (_("Warnings (%d) exceed limit (%d). Syntax processing will be halted."),
387 submit_note (xasprintf (_("Errors (%d) exceed limit (%d). Syntax processing will be halted."),
394 /* Emits M as an error message.
395 Frees allocated data in M. */
397 msg_emit (struct msg *m)
399 if (!messages_disabled)
403 free (m->command_name);
406 /* Disables message output until the next call to msg_enable. If
407 this function is called multiple times, msg_enable must be
408 called an equal number of times before messages are actually
416 /* Enables message output that was disabled by msg_disable. */
420 assert (messages_disabled > 0);
424 /* Private functions. */
426 static char fatal_error_message[1024];
427 static int fatal_error_message_bytes = 0;
429 static char diagnostic_information[1024];
430 static int diagnostic_information_bytes = 0;
433 append_message (char *msg, int bytes_used, const char *fmt, ...)
437 int ret = vsnprintf (msg + bytes_used, 1024 - bytes_used, fmt, va);
445 /* Generate a row of asterisks held in statically allocated memory */
446 static struct substring
447 generate_banner (void)
449 static struct substring banner;
451 banner = ss_cstr ("******************************************************\n");
456 prepare_fatal_error_message (void)
458 fatal_error_message_bytes += append_message (fatal_error_message, fatal_error_message_bytes, generate_banner ().string);
460 fatal_error_message_bytes += append_message (fatal_error_message, fatal_error_message_bytes, "You have discovered a bug in PSPP. Please report this\n");
461 fatal_error_message_bytes += append_message (fatal_error_message, fatal_error_message_bytes, "to " PACKAGE_BUGREPORT ". Please include this entire\n");
462 fatal_error_message_bytes += append_message (fatal_error_message, fatal_error_message_bytes, "message, *plus* several lines of output just above it.\n");
463 fatal_error_message_bytes += append_message (fatal_error_message, fatal_error_message_bytes, "For the best chance at having the bug fixed, also\n");
464 fatal_error_message_bytes += append_message (fatal_error_message, fatal_error_message_bytes, "include the syntax file that triggered it and a sample\n");
465 fatal_error_message_bytes += append_message (fatal_error_message, fatal_error_message_bytes, "of any data file used for input.\n");
466 return fatal_error_message;
470 prepare_diagnostic_information (void)
472 diagnostic_information_bytes += append_message (diagnostic_information, diagnostic_information_bytes, "version: %s\n", version);
473 diagnostic_information_bytes += append_message (diagnostic_information, diagnostic_information_bytes, "host_system: %s\n", host_system);
474 diagnostic_information_bytes += append_message (diagnostic_information, diagnostic_information_bytes, "build_system: %s\n", build_system);
475 diagnostic_information_bytes += append_message (diagnostic_information, diagnostic_information_bytes, "locale_dir: %s\n", relocate (locale_dir));
476 diagnostic_information_bytes += append_message (diagnostic_information, diagnostic_information_bytes, "compiler version: %s\n",
484 return diagnostic_information;
488 request_bug_report (const char *msg)
490 write (STDERR_FILENO, fatal_error_message, fatal_error_message_bytes);
491 write (STDERR_FILENO, "proximate cause: ", 21);
492 write (STDERR_FILENO, msg, strlen (msg));
493 write (STDERR_FILENO, "\n", 1);
494 write (STDERR_FILENO, diagnostic_information, diagnostic_information_bytes);
495 const struct substring banner = generate_banner ();
496 write (STDERR_FILENO, banner.string, banner.length);