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/intern.h"
31 #include "libpspp/str.h"
32 #include "libpspp/version.h"
33 #include "data/settings.h"
35 #include "gl/minmax.h"
36 #include "gl/progname.h"
37 #include "gl/relocatable.h"
38 #include "gl/xalloc.h"
39 #include "gl/xvasprintf.h"
42 #define _(msgid) gettext (msgid)
44 /* Message handler as set by msg_set_handler(). */
45 static struct msg_handler msg_handler = { .output_msg = NULL };
47 /* Disables emitting messages if positive. */
48 static int messages_disabled;
50 /* Public functions. */
54 vmsg (enum msg_class class, const struct msg_location *location,
55 const char *format, va_list args)
57 struct msg *m = xmalloc (sizeof *m);
59 .category = msg_class_to_category (class),
60 .severity = msg_class_to_severity (class),
61 .location = msg_location_dup (location),
62 .text = xvasprintf (format, args),
67 /* Writes error message in CLASS, with text FORMAT, formatted with
68 printf, to the standard places. */
70 msg (enum msg_class class, const char *format, ...)
73 va_start (args, format);
74 vmsg (class, NULL, format, args);
78 /* Outputs error message in CLASS, with text FORMAT, formatted with printf.
79 LOCATION is the reported location for the message. */
81 msg_at (enum msg_class class, const struct msg_location *location,
82 const char *format, ...)
85 va_start (args, format);
86 vmsg (class, location, format, args);
91 msg_error (int errnum, const char *format, ...)
94 va_start (args, format);
95 struct string s = DS_EMPTY_INITIALIZER;
96 ds_put_vformat (&s, format, args);
98 ds_put_format (&s, ": %s", strerror (errnum));
100 struct msg *m = xmalloc (sizeof *m);
102 .category = MSG_C_GENERAL,
103 .severity = MSG_S_ERROR,
104 .text = ds_steal_cstr (&s),
110 msg_set_handler (const struct msg_handler *handler)
112 msg_handler = *handler;
118 msg_location_uninit (struct msg_location *loc)
120 if (msg_handler.lex_source_unref)
121 msg_handler.lex_source_unref (loc->src);
122 intern_unref (loc->file_name);
126 msg_location_destroy (struct msg_location *loc)
130 msg_location_uninit (loc);
136 msg_point_compare_3way (const struct msg_point *a, const struct msg_point *b)
140 : a->line > b->line ? 1
141 : a->line < b->line ? -1
144 : a->column > b->column ? 1
145 : a->column < b->column ? -1
150 msg_location_remove_columns (struct msg_location *location)
152 location->start.column = 0;
153 location->end.column = 0;
157 msg_location_merge (struct msg_location **dstp, const struct msg_location *src)
159 struct msg_location *dst = *dstp;
162 *dstp = msg_location_dup (src);
166 if (dst->file_name != src->file_name)
171 if (msg_point_compare_3way (&dst->start, &src->start) > 0)
172 dst->start = src->start;
173 if (msg_point_compare_3way (&dst->end, &src->end) < 0)
177 struct msg_location *
178 msg_location_merged (const struct msg_location *a,
179 const struct msg_location *b)
181 struct msg_location *new = msg_location_dup (a);
183 msg_location_merge (&new, b);
187 struct msg_location *
188 msg_location_dup (const struct msg_location *src)
193 struct msg_location *dst = xmalloc (sizeof *dst);
196 dst->file_name = intern_ref (src->file_name);
197 if (msg_handler.lex_source_ref && src->src)
198 msg_handler.lex_source_ref (dst->src);
203 msg_location_is_empty (const struct msg_location *loc)
205 return !loc || (!loc->file_name
206 && loc->start.line <= 0
207 && loc->start.column <= 0);
211 msg_location_format (const struct msg_location *loc, struct string *s)
217 ds_put_cstr (s, loc->file_name);
219 int l1 = loc->start.line;
220 int l2 = MAX (l1, loc->end.line);
221 int c1 = loc->start.column;
222 int c2 = MAX (c1, loc->end.column);
227 ds_put_byte (s, ':');
232 ds_put_format (s, "%d.%d-%d.%d", l1, c1, l2, c2);
234 ds_put_format (s, "%d-%d", l1, l2);
242 /* The GNU coding standards say to use
243 LINENO-1.COLUMN-1-COLUMN-2 for this case, but GNU
244 Emacs interprets COLUMN-2 as LINENO-2 if I do that.
245 I've submitted an Emacs bug report:
246 http://debbugs.gnu.org/cgi/bugreport.cgi?bug=7725.
248 For now, let's be compatible. */
249 ds_put_format (s, "%d.%d-%d.%d", l1, c1, l1, c2);
252 ds_put_format (s, "%d.%d", l1, c1);
255 ds_put_format (s, "%d", l1);
261 ds_put_format (s, ".%d-%d", c1, c2);
263 ds_put_format (s, ".%d", c1);
270 msg_stack_destroy (struct msg_stack *stack)
274 msg_location_destroy (stack->location);
275 free (stack->description);
281 msg_stack_dup (const struct msg_stack *src)
283 struct msg_stack *dst = xmalloc (sizeof *src);
284 *dst = (struct msg_stack) {
285 .location = msg_location_dup (src->location),
286 .description = xstrdup_if_nonnull (src->description),
291 /* Working with messages. */
294 msg_severity_to_string (enum msg_severity severity)
308 /* Duplicate a message */
310 msg_dup (const struct msg *src)
312 struct msg_stack **ms = xmalloc (src->n_stack * sizeof *ms);
313 for (size_t i = 0; i < src->n_stack; i++)
314 ms[i] = msg_stack_dup (src->stack[i]);
316 struct msg *dst = xmalloc (sizeof *dst);
317 *dst = (struct msg) {
318 .category = src->category,
319 .severity = src->severity,
321 .n_stack = src->n_stack,
322 .location = msg_location_dup (src->location),
323 .command_name = xstrdup_if_nonnull (src->command_name),
324 .text = xstrdup (src->text),
329 /* Frees a message created by msg_dup().
331 (Messages not created by msg_dup(), as well as their file_name
332 members, are typically not dynamically allocated, so this function should
333 not be used to destroy them.) */
335 msg_destroy (struct msg *m)
339 for (size_t i = 0; i < m->n_stack; i++)
340 msg_stack_destroy (m->stack[i]);
342 msg_location_destroy (m->location);
344 free (m->command_name);
350 msg_to_string (const struct msg *m)
356 for (size_t i = 0; i < m->n_stack; i++)
358 const struct msg_stack *ms = m->stack[i];
359 if (!msg_location_is_empty (ms->location))
361 msg_location_format (ms->location, &s);
362 ds_put_cstr (&s, ": ");
364 ds_put_format (&s, "%s\n", ms->description);
366 if (m->category != MSG_C_GENERAL && !msg_location_is_empty (m->location))
368 msg_location_format (m->location, &s);
369 ds_put_cstr (&s, ": ");
372 ds_put_format (&s, "%s: ", msg_severity_to_string (m->severity));
374 if (m->category == MSG_C_SYNTAX && m->command_name != NULL)
375 ds_put_format (&s, "%s: ", m->command_name);
377 ds_put_cstr (&s, m->text);
379 const struct msg_location *loc = m->location;
380 if (m->category != MSG_C_GENERAL
381 && loc->src && loc->start.line && loc->start.column
382 && msg_handler.lex_source_get_line)
384 int l0 = loc->start.line;
385 int l1 = loc->end.line;
387 for (int ln = l0; ln <= l1; ln++)
389 if (nl > 3 && ln == l0 + 2)
391 ds_put_cstr (&s, "\n ... |");
395 struct substring line = msg_handler.lex_source_get_line (
397 ss_rtrim (&line, ss_cstr ("\n\r"));
399 ds_put_format (&s, "\n%5d | ", ln);
400 ds_put_substring (&s, line);
402 int c0 = ln == l0 ? loc->start.column : 1;
403 int c1 = ln == l1 ? loc->end.column : ss_utf8_count_columns (line);
404 if (c0 > 0 && c1 >= c0)
406 ds_put_cstr (&s, "\n |");
407 ds_put_byte_multiple (&s, ' ', c0);
410 ds_put_byte (&s, '^');
412 ds_put_byte_multiple (&s, '~', c1 - c0);
415 ds_put_byte_multiple (&s, '-', c1 - c0 + 1);
424 /* Number of messages reported, by severity level. */
425 static int counts[MSG_N_SEVERITIES];
427 /* True after the maximum number of errors or warnings has been exceeded. */
428 static bool too_many_errors;
430 /* True after the maximum number of notes has been exceeded. */
431 static bool too_many_notes;
433 /* True iff warnings have been explicitly disabled (MXWARNS = 0) */
434 static bool warnings_off = false;
436 /* Checks whether we've had so many errors that it's time to quit
437 processing this syntax file. */
439 msg_ui_too_many_errors (void)
441 return too_many_errors;
445 msg_ui_disable_warnings (bool x)
452 msg_ui_reset_counts (void)
456 for (i = 0; i < MSG_N_SEVERITIES; i++)
458 too_many_errors = false;
459 too_many_notes = false;
463 msg_ui_any_errors (void)
465 return counts[MSG_S_ERROR] > 0;
470 ship_message (const struct msg *m)
472 enum { MAX_STACK = 4 };
473 static const struct msg *stack[MAX_STACK];
476 /* If we're recursing on a given message, or recursing deeply, drop it. */
479 for (size_t i = 0; i < n; i++)
484 if (msg_handler.output_msg && n <= 1)
485 msg_handler.output_msg (m, msg_handler.aux);
487 fprintf (stderr, "%s\n", m->text);
492 submit_note (char *s)
495 .category = MSG_C_GENERAL,
496 .severity = MSG_S_NOTE,
505 process_msg (struct msg *m)
507 int n_msgs, max_msgs;
510 || (too_many_notes && m->severity == MSG_S_NOTE)
511 || (warnings_off && m->severity == MSG_S_WARNING))
516 counts[m->severity]++;
517 max_msgs = settings_get_max_messages (m->severity);
518 n_msgs = counts[m->severity];
519 if (m->severity == MSG_S_WARNING)
520 n_msgs += counts[MSG_S_ERROR];
521 if (n_msgs > max_msgs)
523 if (m->severity == MSG_S_NOTE)
525 too_many_notes = true;
526 submit_note (xasprintf (_("Notes (%d) exceed limit (%d). "
527 "Suppressing further notes."),
532 too_many_errors = true;
533 if (m->severity == MSG_S_WARNING)
534 submit_note (xasprintf (_("Warnings (%d) exceed limit (%d). Syntax processing will be halted."),
537 submit_note (xasprintf (_("Errors (%d) exceed limit (%d). Syntax processing will be halted."),
544 /* Emits M as an error message. Takes ownership of M. */
546 msg_emit (struct msg *m)
548 if (!messages_disabled)
553 /* Disables message output until the next call to msg_enable. If
554 this function is called multiple times, msg_enable must be
555 called an equal number of times before messages are actually
563 /* Enables message output that was disabled by msg_disable. */
567 assert (messages_disabled > 0);
571 /* Private functions. */
573 static char fatal_error_message[1024];
574 static int fatal_error_message_bytes = 0;
576 static char diagnostic_information[1024];
577 static int diagnostic_information_bytes = 0;
580 append_message (char *msg, int bytes_used, const char *fmt, ...)
584 int ret = vsnprintf (msg + bytes_used, 1024 - bytes_used, fmt, va);
592 /* Generate a row of asterisks held in statically allocated memory */
593 static struct substring
594 generate_banner (void)
596 static struct substring banner;
598 banner = ss_cstr ("******************************************************\n");
603 prepare_fatal_error_message (void)
605 fatal_error_message_bytes += append_message (fatal_error_message, fatal_error_message_bytes, generate_banner ().string);
607 fatal_error_message_bytes += append_message (fatal_error_message, fatal_error_message_bytes, "You have discovered a bug in PSPP. Please report this\n");
608 fatal_error_message_bytes += append_message (fatal_error_message, fatal_error_message_bytes, "to " PACKAGE_BUGREPORT ". Please include this entire\n");
609 fatal_error_message_bytes += append_message (fatal_error_message, fatal_error_message_bytes, "message, *plus* several lines of output just above it.\n");
610 fatal_error_message_bytes += append_message (fatal_error_message, fatal_error_message_bytes, "For the best chance at having the bug fixed, also\n");
611 fatal_error_message_bytes += append_message (fatal_error_message, fatal_error_message_bytes, "include the syntax file that triggered it and a sample\n");
612 fatal_error_message_bytes += append_message (fatal_error_message, fatal_error_message_bytes, "of any data file used for input.\n");
613 return fatal_error_message;
617 prepare_diagnostic_information (void)
619 diagnostic_information_bytes += append_message (diagnostic_information, diagnostic_information_bytes, "version: %s\n", version);
620 diagnostic_information_bytes += append_message (diagnostic_information, diagnostic_information_bytes, "host_system: %s\n", host_system);
621 diagnostic_information_bytes += append_message (diagnostic_information, diagnostic_information_bytes, "build_system: %s\n", build_system);
622 diagnostic_information_bytes += append_message (diagnostic_information, diagnostic_information_bytes, "locale_dir: %s\n", relocate (locale_dir));
623 diagnostic_information_bytes += append_message (diagnostic_information, diagnostic_information_bytes, "compiler version: %s\n",
631 return diagnostic_information;
635 request_bug_report (const char *msg)
637 write (STDERR_FILENO, fatal_error_message, fatal_error_message_bytes);
638 write (STDERR_FILENO, "proximate cause: ", 21);
639 write (STDERR_FILENO, msg, strlen (msg));
640 write (STDERR_FILENO, "\n", 1);
641 write (STDERR_FILENO, diagnostic_information, diagnostic_information_bytes);
642 const struct substring banner = generate_banner ();
643 write (STDERR_FILENO, banner.string, banner.length);