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,
90 .text = xasprintf (_("%s: %s"), e, strerror (errnum)),
100 msg_set_handler (void (*handler) (const struct msg *, void *aux), void *aux)
102 msg_handler = handler;
106 /* Working with messages. */
109 msg_severity_to_string (enum msg_severity severity)
123 /* Duplicate a message */
125 msg_dup (const struct msg *m)
129 new_msg = xmemdup (m, sizeof *m);
130 if (m->file_name != NULL)
131 new_msg->file_name = xstrdup (m->file_name);
132 if (m->command_name != NULL)
133 new_msg->command_name = xstrdup (m->command_name);
134 new_msg->text = xstrdup (m->text);
139 /* Frees a message created by msg_dup().
141 (Messages not created by msg_dup(), as well as their file_name
142 members, are typically not dynamically allocated, so this function should
143 not be used to destroy them.) */
145 msg_destroy (struct msg *m)
149 free (m->command_name);
154 msg_to_string (const struct msg *m)
160 if (m->category != MSG_C_GENERAL
161 && (m->file_name || m->first_line > 0 || m->first_column > 0))
163 int l1 = m->first_line;
164 int l2 = MAX (m->first_line, m->last_line - 1);
165 int c1 = m->first_column;
166 int c2 = MAX (m->first_column, m->last_column - 1);
169 ds_put_format (&s, "%s", m->file_name);
173 if (!ds_is_empty (&s))
174 ds_put_byte (&s, ':');
179 ds_put_format (&s, "%d.%d-%d.%d", l1, c1, l2, c2);
181 ds_put_format (&s, "%d-%d", l1, l2);
189 /* The GNU coding standards say to use
190 LINENO-1.COLUMN-1-COLUMN-2 for this case, but GNU
191 Emacs interprets COLUMN-2 as LINENO-2 if I do that.
192 I've submitted an Emacs bug report:
193 http://debbugs.gnu.org/cgi/bugreport.cgi?bug=7725.
195 For now, let's be compatible. */
196 ds_put_format (&s, "%d.%d-%d.%d", l1, c1, l1, c2);
199 ds_put_format (&s, "%d.%d", l1, c1);
202 ds_put_format (&s, "%d", l1);
208 ds_put_format (&s, ".%d-%d", c1, c2);
210 ds_put_format (&s, ".%d", c1);
212 ds_put_cstr (&s, ": ");
215 ds_put_format (&s, "%s: ", msg_severity_to_string (m->severity));
217 if (m->category == MSG_C_SYNTAX && m->command_name != NULL)
218 ds_put_format (&s, "%s: ", m->command_name);
220 ds_put_cstr (&s, m->text);
226 /* Number of messages reported, by severity level. */
227 static int counts[MSG_N_SEVERITIES];
229 /* True after the maximum number of errors or warnings has been exceeded. */
230 static bool too_many_errors;
232 /* True after the maximum number of notes has been exceeded. */
233 static bool too_many_notes;
235 /* True iff warnings have been explicitly disabled (MXWARNS = 0) */
236 static bool warnings_off = false;
238 /* Checks whether we've had so many errors that it's time to quit
239 processing this syntax file. */
241 msg_ui_too_many_errors (void)
243 return too_many_errors;
247 msg_ui_disable_warnings (bool x)
254 msg_ui_reset_counts (void)
258 for (i = 0; i < MSG_N_SEVERITIES; i++)
260 too_many_errors = false;
261 too_many_notes = false;
265 msg_ui_any_errors (void)
267 return counts[MSG_S_ERROR] > 0;
271 static int entrances = 0;
274 ship_message (struct msg *m)
279 if (msg_handler && entrances <= 1)
280 msg_handler (m, msg_aux);
283 fwrite (m->text, 1, strlen (m->text), stderr);
284 fwrite ("\n", 1, 1, stderr);
292 submit_note (char *s)
295 .category = MSG_C_GENERAL,
296 .severity = MSG_S_NOTE,
307 process_msg (struct msg *m)
309 int n_msgs, max_msgs;
312 || (too_many_notes && m->severity == MSG_S_NOTE)
313 || (warnings_off && m->severity == MSG_S_WARNING))
318 counts[m->severity]++;
319 max_msgs = settings_get_max_messages (m->severity);
320 n_msgs = counts[m->severity];
321 if (m->severity == MSG_S_WARNING)
322 n_msgs += counts[MSG_S_ERROR];
323 if (n_msgs > max_msgs)
325 if (m->severity == MSG_S_NOTE)
327 too_many_notes = true;
328 submit_note (xasprintf (_("Notes (%d) exceed limit (%d). "
329 "Suppressing further notes."),
334 too_many_errors = true;
335 if (m->severity == MSG_S_WARNING)
336 submit_note (xasprintf (_("Warnings (%d) exceed limit (%d). Syntax processing will be halted."),
339 submit_note (xasprintf (_("Errors (%d) exceed limit (%d). Syntax processing will be halted."),
346 /* Emits M as an error message.
347 Frees allocated data in M. */
349 msg_emit (struct msg *m)
352 if (!messages_disabled)
356 free (m->command_name);
359 /* Disables message output until the next call to msg_enable. If
360 this function is called multiple times, msg_enable must be
361 called an equal number of times before messages are actually
369 /* Enables message output that was disabled by msg_disable. */
373 assert (messages_disabled > 0);
377 /* Private functions. */
379 static char fatal_error_message[1024];
380 static int fatal_error_message_bytes = 0;
382 static char diagnostic_information[1024];
383 static int diagnostic_information_bytes = 0;
386 append_message (char *msg, int bytes_used, const char *fmt, ...)
390 int ret = vsnprintf (msg + bytes_used, 1024 - bytes_used, fmt, va);
398 /* Generate a row of asterisks held in statically allocated memory */
399 static struct substring
400 generate_banner (void)
402 static struct substring banner;
404 banner = ss_cstr ("******************************************************\n");
409 prepare_fatal_error_message (void)
411 fatal_error_message_bytes += append_message (fatal_error_message, fatal_error_message_bytes, generate_banner ().string);
413 fatal_error_message_bytes += append_message (fatal_error_message, fatal_error_message_bytes, "You have discovered a bug in PSPP. Please report this\n");
414 fatal_error_message_bytes += append_message (fatal_error_message, fatal_error_message_bytes, "to " PACKAGE_BUGREPORT ". Please include this entire\n");
415 fatal_error_message_bytes += append_message (fatal_error_message, fatal_error_message_bytes, "message, *plus* several lines of output just above it.\n");
416 fatal_error_message_bytes += append_message (fatal_error_message, fatal_error_message_bytes, "For the best chance at having the bug fixed, also\n");
417 fatal_error_message_bytes += append_message (fatal_error_message, fatal_error_message_bytes, "include the syntax file that triggered it and a sample\n");
418 fatal_error_message_bytes += append_message (fatal_error_message, fatal_error_message_bytes, "of any data file used for input.\n");
419 return fatal_error_message;
423 prepare_diagnostic_information (void)
425 diagnostic_information_bytes += append_message (diagnostic_information, diagnostic_information_bytes, "version: %s\n", version);
426 diagnostic_information_bytes += append_message (diagnostic_information, diagnostic_information_bytes, "host_system: %s\n", host_system);
427 diagnostic_information_bytes += append_message (diagnostic_information, diagnostic_information_bytes, "build_system: %s\n", build_system);
428 diagnostic_information_bytes += append_message (diagnostic_information, diagnostic_information_bytes, "locale_dir: %s\n", relocate (locale_dir));
429 diagnostic_information_bytes += append_message (diagnostic_information, diagnostic_information_bytes, "compiler version: %s\n",
437 return diagnostic_information;
441 request_bug_report (const char *msg)
443 write (STDERR_FILENO, fatal_error_message, fatal_error_message_bytes);
444 write (STDERR_FILENO, "proximate cause: ", 21);
445 write (STDERR_FILENO, msg, strlen (msg));
446 write (STDERR_FILENO, "\n", 1);
447 write (STDERR_FILENO, diagnostic_information, diagnostic_information_bytes);
448 const struct substring banner = generate_banner ();
449 write (STDERR_FILENO, banner.string, banner.length);