/* PSPP - a program for statistical analysis.
- Copyright (C) 1997-9, 2000, 2006, 2009, 2010 Free Software Foundation, Inc.
+ Copyright (C) 1997-9, 2000, 2006, 2009, 2010,
+ 2011, 2013 Free Software Foundation, Inc.
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
#include <config.h>
-#include "message.h"
-#include "msg-locator.h"
+#include "libpspp/message.h"
#include <assert.h>
#include <stdarg.h>
#include <string.h>
#include <unistd.h>
-#include <libpspp/str.h>
-#include <libpspp/version.h>
-#include <data/settings.h>
+#include "libpspp/cast.h"
+#include "libpspp/str.h"
+#include "libpspp/version.h"
+#include "data/settings.h"
+#include "gl/minmax.h"
#include "gl/progname.h"
+#include "gl/relocatable.h"
#include "gl/xalloc.h"
#include "gl/xvasprintf.h"
#include "gettext.h"
#define _(msgid) gettext (msgid)
-/* Message handler as set by msg_init(). */
-static void (*msg_handler) (const struct msg *);
+/* Message handler as set by msg_set_handler(). */
+static void (*msg_handler) (const struct msg *, void *aux);
+static void *msg_aux;
/* Disables emitting messages if positive. */
static int messages_disabled;
/* Public functions. */
+
+void
+vmsg (enum msg_class class, const char *format, va_list args)
+{
+ struct msg m = {
+ .category = msg_class_to_category (class),
+ .severity = msg_class_to_severity (class),
+ .text = xvasprintf (format, args),
+ };
+
+ msg_emit (&m);
+}
+
/* Writes error message in CLASS, with text FORMAT, formatted with
printf, to the standard places. */
void
msg (enum msg_class class, const char *format, ...)
{
- struct msg m;
va_list args;
+ va_start (args, format);
+ vmsg (class, format, args);
+ va_end (args);
+}
- m.category = msg_class_to_category (class);
- m.severity = msg_class_to_severity (class);
+
+
+void
+msg_error (int errnum, const char *format, ...)
+{
+ va_list args;
va_start (args, format);
- m.text = xvasprintf (format, args);
+ char *e = xvasprintf (format, args);
va_end (args);
+ struct msg m = {
+ .category = MSG_C_GENERAL,
+ .severity = MSG_S_ERROR,
+ .file_name = NULL,
+ .text = xasprintf (_("%s: %s"), e, strerror (errnum)),
+ };
msg_emit (&m);
+
+ free (e);
}
-static struct source_stream *s_stream;
+
void
-msg_init (struct source_stream *ss, void (*handler) (const struct msg *) )
+msg_set_handler (void (*handler) (const struct msg *, void *aux), void *aux)
{
- s_stream = ss;
msg_handler = handler;
+ msg_aux = aux;
}
+\f
+/* Working with messages. */
-void
-msg_done (void)
+const char *
+msg_severity_to_string (enum msg_severity severity)
{
+ switch (severity)
+ {
+ case MSG_S_ERROR:
+ return _("error");
+ case MSG_S_WARNING:
+ return _("warning");
+ case MSG_S_NOTE:
+ default:
+ return _("note");
+ }
}
-\f
-/* Working with messages. */
/* Duplicate a message */
struct msg *
struct msg *new_msg;
new_msg = xmemdup (m, sizeof *m);
- if (m->where.file_name != NULL)
- new_msg->where.file_name = xstrdup (m->where.file_name);
+ if (m->file_name != NULL)
+ new_msg->file_name = xstrdup (m->file_name);
+ if (m->command_name != NULL)
+ new_msg->command_name = xstrdup (m->command_name);
new_msg->text = xstrdup (m->text);
return new_msg;
/* Frees a message created by msg_dup().
- (Messages not created by msg_dup(), as well as their where.file_name
+ (Messages not created by msg_dup(), as well as their file_name
members, are typically not dynamically allocated, so this function should
not be used to destroy them.) */
void
msg_destroy (struct msg *m)
{
- free (m->where.file_name);
+ free (m->file_name);
free (m->text);
+ free (m->command_name);
free (m);
}
char *
-msg_to_string (const struct msg *m, const char *command_name)
+msg_to_string (const struct msg *m)
{
- const char *label;
struct string s;
ds_init_empty (&s);
if (m->category != MSG_C_GENERAL
- && (m->where.file_name || m->where.line_number != -1))
+ && (m->file_name || m->first_line > 0 || m->first_column > 0))
{
- if (m->where.file_name)
- ds_put_format (&s, "%s:", m->where.file_name);
- if (m->where.line_number != -1)
- ds_put_format (&s, "%d:", m->where.line_number);
- ds_put_char (&s, ' ');
- }
+ int l1 = m->first_line;
+ int l2 = MAX (m->first_line, m->last_line - 1);
+ int c1 = m->first_column;
+ int c2 = MAX (m->first_column, m->last_column - 1);
- switch (m->severity)
- {
- case MSG_S_ERROR:
- label = _("error");
- break;
- case MSG_S_WARNING:
- label = _("warning");
- break;
- case MSG_S_NOTE:
- default:
- label = _("note");
- break;
+ if (m->file_name)
+ ds_put_format (&s, "%s", m->file_name);
+
+ if (l1 > 0)
+ {
+ if (!ds_is_empty (&s))
+ ds_put_byte (&s, ':');
+
+ if (l2 > l1)
+ {
+ if (c1 > 0)
+ ds_put_format (&s, "%d.%d-%d.%d", l1, c1, l2, c2);
+ else
+ ds_put_format (&s, "%d-%d", l1, l2);
+ }
+ else
+ {
+ if (c1 > 0)
+ {
+ if (c2 > c1)
+ {
+ /* The GNU coding standards say to use
+ LINENO-1.COLUMN-1-COLUMN-2 for this case, but GNU
+ Emacs interprets COLUMN-2 as LINENO-2 if I do that.
+ I've submitted an Emacs bug report:
+ http://debbugs.gnu.org/cgi/bugreport.cgi?bug=7725.
+
+ For now, let's be compatible. */
+ ds_put_format (&s, "%d.%d-%d.%d", l1, c1, l1, c2);
+ }
+ else
+ ds_put_format (&s, "%d.%d", l1, c1);
+ }
+ else
+ ds_put_format (&s, "%d", l1);
+ }
+ }
+ else if (c1 > 0)
+ {
+ if (c2 > c1)
+ ds_put_format (&s, ".%d-%d", c1, c2);
+ else
+ ds_put_format (&s, ".%d", c1);
+ }
+ ds_put_cstr (&s, ": ");
}
- ds_put_format (&s, "%s: ", label);
- if (m->category == MSG_C_SYNTAX && command_name != NULL)
- ds_put_format (&s, "%s: ", command_name);
+ ds_put_format (&s, "%s: ", msg_severity_to_string (m->severity));
+
+ if (m->category == MSG_C_SYNTAX && m->command_name != NULL)
+ ds_put_format (&s, "%s: ", m->command_name);
ds_put_cstr (&s, m->text);
return counts[MSG_S_ERROR] > 0;
}
+
+static int entrances = 0;
+
+static void
+ship_message (struct msg *m)
+{
+ entrances++;
+ if (! m->shipped)
+ {
+ if (msg_handler && entrances <= 1)
+ msg_handler (m, msg_aux);
+ else
+ {
+ fwrite (m->text, 1, strlen (m->text), stderr);
+ fwrite ("\n", 1, 1, stderr);
+ }
+ }
+ m->shipped = true;
+ entrances--;
+}
+
static void
submit_note (char *s)
{
- struct msg m;
-
- m.category = MSG_C_GENERAL;
- m.severity = MSG_S_NOTE;
- m.where.file_name = NULL;
- m.where.line_number = -1;
- m.text = s;
- msg_handler (&m);
+ struct msg m = {
+ .category = MSG_C_GENERAL,
+ .severity = MSG_S_NOTE,
+ .text = s,
+ };
+ ship_message (&m);
+
free (s);
}
static void
-process_msg (const struct msg *m)
+process_msg (struct msg *m)
{
int n_msgs, max_msgs;
-
if (too_many_errors
|| (too_many_notes && m->severity == MSG_S_NOTE)
- || (warnings_off && m->severity == MSG_S_WARNING) )
+ || (warnings_off && m->severity == MSG_S_WARNING))
return;
- msg_handler (m);
+ ship_message (m);
counts[m->severity]++;
max_msgs = settings_get_max_messages (m->severity);
void
msg_emit (struct msg *m)
{
- if ( s_stream )
- get_msg_location (s_stream, &m->where);
- else
- {
- m->where.file_name = NULL;
- m->where.line_number = -1;
- }
-
+ m->shipped = false;
if (!messages_disabled)
process_msg (m);
free (m->text);
+ free (m->command_name);
}
/* Disables message output until the next call to msg_enable. If
\f
/* Private functions. */
-void
-request_bug_report_and_abort (const char *msg)
+static char fatal_error_message[1024];
+static int fatal_error_message_bytes = 0;
+
+static char diagnostic_information[1024];
+static int diagnostic_information_bytes = 0;
+
+static int
+append_message (char *msg, int bytes_used, const char *fmt, ...)
+{
+ va_list va;
+ va_start (va, fmt);
+ int ret = vsnprintf (msg + bytes_used, 1024 - bytes_used, fmt, va);
+ va_end (va);
+ assert (ret >= 0);
+
+ return ret;
+}
+
+
+/* Generate a row of asterisks held in statically allocated memory */
+static struct substring
+generate_banner (void)
{
- fprintf (stderr, "******************************************************\n");
- fprintf (stderr, "You have discovered a bug in PSPP. Please report this\n");
- fprintf (stderr, "to " PACKAGE_BUGREPORT ". Please include this entire\n");
- fprintf (stderr, "message, *plus* several lines of output just above it.\n");
- fprintf (stderr, "For the best chance at having the bug fixed, also\n");
- fprintf (stderr, "include the syntax file that triggered it and a sample\n");
- fprintf (stderr, "of any data file used for input.\n");
- fprintf (stderr, "proximate cause: %s\n", msg);
- fprintf (stderr, "version: %s\n", stat_version);
- fprintf (stderr, "host_system: %s\n", host_system);
- fprintf (stderr, "build_system: %s\n", build_system);
- fprintf (stderr, "locale_dir: %s\n", locale_dir);
- fprintf (stderr, "compiler version: %s\n",
+ static struct substring banner;
+ if (!banner.string)
+ banner = ss_cstr ("******************************************************\n");
+ return banner;
+}
+
+const char *
+prepare_fatal_error_message (void)
+{
+ fatal_error_message_bytes += append_message (fatal_error_message, fatal_error_message_bytes, generate_banner ().string);
+
+ fatal_error_message_bytes += append_message (fatal_error_message, fatal_error_message_bytes, "You have discovered a bug in PSPP. Please report this\n");
+ fatal_error_message_bytes += append_message (fatal_error_message, fatal_error_message_bytes, "to " PACKAGE_BUGREPORT ". Please include this entire\n");
+ fatal_error_message_bytes += append_message (fatal_error_message, fatal_error_message_bytes, "message, *plus* several lines of output just above it.\n");
+ fatal_error_message_bytes += append_message (fatal_error_message, fatal_error_message_bytes, "For the best chance at having the bug fixed, also\n");
+ fatal_error_message_bytes += append_message (fatal_error_message, fatal_error_message_bytes, "include the syntax file that triggered it and a sample\n");
+ fatal_error_message_bytes += append_message (fatal_error_message, fatal_error_message_bytes, "of any data file used for input.\n");
+ return fatal_error_message;
+}
+
+const char *
+prepare_diagnostic_information (void)
+{
+ diagnostic_information_bytes += append_message (diagnostic_information, diagnostic_information_bytes, "version: %s\n", version);
+ diagnostic_information_bytes += append_message (diagnostic_information, diagnostic_information_bytes, "host_system: %s\n", host_system);
+ diagnostic_information_bytes += append_message (diagnostic_information, diagnostic_information_bytes, "build_system: %s\n", build_system);
+ diagnostic_information_bytes += append_message (diagnostic_information, diagnostic_information_bytes, "locale_dir: %s\n", relocate (locale_dir));
+ diagnostic_information_bytes += append_message (diagnostic_information, diagnostic_information_bytes, "compiler version: %s\n",
#ifdef __VERSION__
__VERSION__
#else
"Unknown"
#endif
- );
- fprintf (stderr, "******************************************************\n");
+);
- _exit (EXIT_FAILURE);
+ return diagnostic_information;
}
+void
+request_bug_report (const char *msg)
+{
+ write (STDERR_FILENO, fatal_error_message, fatal_error_message_bytes);
+ write (STDERR_FILENO, "proximate cause: ", 21);
+ write (STDERR_FILENO, msg, strlen (msg));
+ write (STDERR_FILENO, "\n", 1);
+ write (STDERR_FILENO, diagnostic_information, diagnostic_information_bytes);
+ const struct substring banner = generate_banner ();
+ write (STDERR_FILENO, banner.string, banner.length);
+}
projects / pspp / blobdiff