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)
56 struct msg *m = xmalloc (sizeof *m);
58 .category = msg_class_to_category (class),
59 .severity = msg_class_to_severity (class),
60 .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 struct string s = DS_EMPTY_INITIALIZER;
84 ds_put_vformat (&s, format, args);
86 ds_put_format (&s, ": %s", strerror (errnum));
88 struct msg *m = xmalloc (sizeof *m);
90 .category = MSG_C_GENERAL,
91 .severity = MSG_S_ERROR,
92 .text = ds_steal_cstr (&s),
100 msg_set_handler (void (*handler) (const struct msg *, void *aux), void *aux)
102 msg_handler = handler;
109 msg_location_destroy (struct msg_location *loc)
113 free (loc->file_name);
118 struct msg_location *
119 msg_location_dup (const struct msg_location *src)
124 struct msg_location *dst = xmalloc (sizeof *dst);
125 *dst = (struct msg_location) {
126 .file_name = xstrdup_if_nonnull (src->file_name),
127 .first_line = src->first_line,
128 .last_line = src->last_line,
129 .first_column = src->first_column,
130 .last_column = src->last_column,
136 msg_location_is_empty (const struct msg_location *loc)
138 return !loc || (!loc->file_name
139 && loc->first_line <= 0
140 && loc->first_column <= 0);
144 msg_location_format (const struct msg_location *loc, struct string *s)
150 ds_put_cstr (s, loc->file_name);
152 int l1 = loc->first_line;
153 int l2 = MAX (loc->first_line, loc->last_line - 1);
154 int c1 = loc->first_column;
155 int c2 = MAX (loc->first_column, loc->last_column - 1);
160 ds_put_byte (s, ':');
165 ds_put_format (s, "%d.%d-%d.%d", l1, c1, l2, c2);
167 ds_put_format (s, "%d-%d", l1, l2);
175 /* The GNU coding standards say to use
176 LINENO-1.COLUMN-1-COLUMN-2 for this case, but GNU
177 Emacs interprets COLUMN-2 as LINENO-2 if I do that.
178 I've submitted an Emacs bug report:
179 http://debbugs.gnu.org/cgi/bugreport.cgi?bug=7725.
181 For now, let's be compatible. */
182 ds_put_format (s, "%d.%d-%d.%d", l1, c1, l1, c2);
185 ds_put_format (s, "%d.%d", l1, c1);
188 ds_put_format (s, "%d", l1);
194 ds_put_format (s, ".%d-%d", c1, c2);
196 ds_put_format (s, ".%d", c1);
200 /* Working with messages. */
203 msg_severity_to_string (enum msg_severity severity)
217 /* Duplicate a message */
219 msg_dup (const struct msg *src)
221 struct msg *dst = xmalloc (sizeof *dst);
222 *dst = (struct msg) {
223 .category = src->category,
224 .severity = src->severity,
225 .location = msg_location_dup (src->location),
226 .command_name = xstrdup_if_nonnull (src->command_name),
227 .text = xstrdup (src->text),
232 /* Frees a message created by msg_dup().
234 (Messages not created by msg_dup(), as well as their file_name
235 members, are typically not dynamically allocated, so this function should
236 not be used to destroy them.) */
238 msg_destroy (struct msg *m)
242 msg_location_destroy (m->location);
244 free (m->command_name);
250 msg_to_string (const struct msg *m)
256 if (m->category != MSG_C_GENERAL && !msg_location_is_empty (m->location))
258 msg_location_format (m->location, &s);
259 ds_put_cstr (&s, ": ");
262 ds_put_format (&s, "%s: ", msg_severity_to_string (m->severity));
264 if (m->category == MSG_C_SYNTAX && m->command_name != NULL)
265 ds_put_format (&s, "%s: ", m->command_name);
267 ds_put_cstr (&s, m->text);
273 /* Number of messages reported, by severity level. */
274 static int counts[MSG_N_SEVERITIES];
276 /* True after the maximum number of errors or warnings has been exceeded. */
277 static bool too_many_errors;
279 /* True after the maximum number of notes has been exceeded. */
280 static bool too_many_notes;
282 /* True iff warnings have been explicitly disabled (MXWARNS = 0) */
283 static bool warnings_off = false;
285 /* Checks whether we've had so many errors that it's time to quit
286 processing this syntax file. */
288 msg_ui_too_many_errors (void)
290 return too_many_errors;
294 msg_ui_disable_warnings (bool x)
301 msg_ui_reset_counts (void)
305 for (i = 0; i < MSG_N_SEVERITIES; i++)
307 too_many_errors = false;
308 too_many_notes = false;
312 msg_ui_any_errors (void)
314 return counts[MSG_S_ERROR] > 0;
319 ship_message (const struct msg *m)
321 enum { MAX_STACK = 4 };
322 static const struct msg *stack[MAX_STACK];
325 /* If we're recursing on a given message, or recursing deeply, drop it. */
328 for (size_t i = 0; i < n; i++)
333 if (msg_handler && n <= 1)
334 msg_handler (m, msg_aux);
336 fprintf (stderr, "%s\n", m->text);
341 submit_note (char *s)
344 .category = MSG_C_GENERAL,
345 .severity = MSG_S_NOTE,
354 process_msg (struct msg *m)
356 int n_msgs, max_msgs;
359 || (too_many_notes && m->severity == MSG_S_NOTE)
360 || (warnings_off && m->severity == MSG_S_WARNING))
365 counts[m->severity]++;
366 max_msgs = settings_get_max_messages (m->severity);
367 n_msgs = counts[m->severity];
368 if (m->severity == MSG_S_WARNING)
369 n_msgs += counts[MSG_S_ERROR];
370 if (n_msgs > max_msgs)
372 if (m->severity == MSG_S_NOTE)
374 too_many_notes = true;
375 submit_note (xasprintf (_("Notes (%d) exceed limit (%d). "
376 "Suppressing further notes."),
381 too_many_errors = true;
382 if (m->severity == MSG_S_WARNING)
383 submit_note (xasprintf (_("Warnings (%d) exceed limit (%d). Syntax processing will be halted."),
386 submit_note (xasprintf (_("Errors (%d) exceed limit (%d). Syntax processing will be halted."),
393 /* Emits M as an error message. Takes ownership of M. */
395 msg_emit (struct msg *m)
397 if (!messages_disabled)
402 /* Disables message output until the next call to msg_enable. If
403 this function is called multiple times, msg_enable must be
404 called an equal number of times before messages are actually
412 /* Enables message output that was disabled by msg_disable. */
416 assert (messages_disabled > 0);
420 /* Private functions. */
422 static char fatal_error_message[1024];
423 static int fatal_error_message_bytes = 0;
425 static char diagnostic_information[1024];
426 static int diagnostic_information_bytes = 0;
429 append_message (char *msg, int bytes_used, const char *fmt, ...)
433 int ret = vsnprintf (msg + bytes_used, 1024 - bytes_used, fmt, va);
441 /* Generate a row of asterisks held in statically allocated memory */
442 static struct substring
443 generate_banner (void)
445 static struct substring banner;
447 banner = ss_cstr ("******************************************************\n");
452 prepare_fatal_error_message (void)
454 fatal_error_message_bytes += append_message (fatal_error_message, fatal_error_message_bytes, generate_banner ().string);
456 fatal_error_message_bytes += append_message (fatal_error_message, fatal_error_message_bytes, "You have discovered a bug in PSPP. Please report this\n");
457 fatal_error_message_bytes += append_message (fatal_error_message, fatal_error_message_bytes, "to " PACKAGE_BUGREPORT ". Please include this entire\n");
458 fatal_error_message_bytes += append_message (fatal_error_message, fatal_error_message_bytes, "message, *plus* several lines of output just above it.\n");
459 fatal_error_message_bytes += append_message (fatal_error_message, fatal_error_message_bytes, "For the best chance at having the bug fixed, also\n");
460 fatal_error_message_bytes += append_message (fatal_error_message, fatal_error_message_bytes, "include the syntax file that triggered it and a sample\n");
461 fatal_error_message_bytes += append_message (fatal_error_message, fatal_error_message_bytes, "of any data file used for input.\n");
462 return fatal_error_message;
466 prepare_diagnostic_information (void)
468 diagnostic_information_bytes += append_message (diagnostic_information, diagnostic_information_bytes, "version: %s\n", version);
469 diagnostic_information_bytes += append_message (diagnostic_information, diagnostic_information_bytes, "host_system: %s\n", host_system);
470 diagnostic_information_bytes += append_message (diagnostic_information, diagnostic_information_bytes, "build_system: %s\n", build_system);
471 diagnostic_information_bytes += append_message (diagnostic_information, diagnostic_information_bytes, "locale_dir: %s\n", relocate (locale_dir));
472 diagnostic_information_bytes += append_message (diagnostic_information, diagnostic_information_bytes, "compiler version: %s\n",
480 return diagnostic_information;
484 request_bug_report (const char *msg)
486 write (STDERR_FILENO, fatal_error_message, fatal_error_message_bytes);
487 write (STDERR_FILENO, "proximate cause: ", 21);
488 write (STDERR_FILENO, msg, strlen (msg));
489 write (STDERR_FILENO, "\n", 1);
490 write (STDERR_FILENO, diagnostic_information, diagnostic_information_bytes);
491 const struct substring banner = generate_banner ();
492 write (STDERR_FILENO, banner.string, banner.length);