1 /* PSPP - a program for statistical analysis.
2 Copyright (C) 1997-9, 2000, 2006, 2009 Free Software Foundation, Inc.
4 This program is free software: you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation, either version 3 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program. If not, see <http://www.gnu.org/licenses/>. */
20 #include "msg-locator.h"
29 #include <libpspp/version.h>
33 #include "xvasprintf.h"
35 /* Current command name as set by msg_set_command_name(). */
36 static char *command_name;
38 /* Message handler as set by msg_init(). */
39 static void (*msg_handler) (const struct msg *);
41 /* Disables emitting messages if positive. */
42 static int messages_disabled;
44 /* Public functions. */
46 /* Writes error message in CLASS, with text FORMAT, formatted with
47 printf, to the standard places. */
49 msg (enum msg_class class, const char *format, ...)
54 m.category = msg_class_to_category (class);
55 m.severity = msg_class_to_severity (class);
56 va_start (args, format);
57 m.text = xvasprintf (format, args);
63 static struct source_stream *s_stream;
66 msg_init (struct source_stream *ss, void (*handler) (const struct msg *) )
69 msg_handler = handler;
78 /* Duplicate a message */
80 msg_dup(const struct msg *m)
84 new_msg = xmemdup (m, sizeof *m);
85 if (m->where.file_name != NULL)
86 new_msg->where.file_name = xstrdup (m->where.file_name);
87 new_msg->text = xstrdup (m->text);
92 /* Frees a message created by msg_dup().
94 (Messages not created by msg_dup(), as well as their where.file_name
95 members, are typically not dynamically allocated, so this function should
96 not be used to destroy them.) */
98 msg_destroy (struct msg *m)
100 free (m->where.file_name);
105 /* Emits M as an error message.
106 Frees allocated data in M. */
108 msg_emit (struct msg *m)
111 get_msg_location (s_stream, &m->where);
114 m->where.file_name = NULL;
115 m->where.line_number = -1;
118 if (!messages_disabled)
123 /* Disables message output until the next call to msg_enable. If
124 this function is called multiple times, msg_enable must be
125 called an equal number of times before messages are actually
133 /* Enables message output that was disabled by msg_disable. */
137 assert (messages_disabled > 0);
141 /* Private functions. */
143 /* Sets COMMAND_NAME as the command name included in some kinds
144 of error messages. */
146 msg_set_command_name (const char *command_name_)
149 command_name = command_name_ ? xstrdup (command_name_) : NULL;
152 /* Returns the current command name, or NULL if none. */
154 msg_get_command_name (void)
160 request_bug_report_and_abort (const char *msg)
162 fprintf (stderr, "******************************************************\n");
163 fprintf (stderr, "You have discovered a bug in PSPP. Please report this\n");
164 fprintf (stderr, "to " PACKAGE_BUGREPORT ". Please include this entire\n");
165 fprintf (stderr, "message, *plus* several lines of output just above it.\n");
166 fprintf (stderr, "For the best chance at having the bug fixed, also\n");
167 fprintf (stderr, "include the syntax file that triggered it and a sample\n");
168 fprintf (stderr, "of any data file used for input.\n");
169 fprintf (stderr, "proximate cause: %s\n", msg);
170 fprintf (stderr, "version: %s\n", stat_version);
171 fprintf (stderr, "host_system: %s\n", host_system);
172 fprintf (stderr, "build_system: %s\n", build_system);
173 fprintf (stderr, "default_config_path: %s\n", default_config_path);
174 fprintf (stderr, "include_path: %s\n", include_path);
175 fprintf (stderr, "locale_dir: %s\n", locale_dir);
176 fprintf (stderr, "compiler version: %s\n",
183 fprintf (stderr, "******************************************************\n");
185 _exit (EXIT_FAILURE);