622388a1169d9433a367984205dbeafe3574670b
[pspp-builds.git] / src / libpspp / message.c
1 /* PSPP - a program for statistical analysis.
2    Copyright (C) 1997-9, 2000, 2006 Free Software Foundation, Inc.
3
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.
8
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.
13
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/>. */
16
17 #include <config.h>
18
19 #include "message.h"
20 #include "msg-locator.h"
21
22 #include <assert.h>
23 #include <stdarg.h>
24 #include <stdio.h>
25 #include <stdlib.h>
26 #include <string.h>
27 #include <unistd.h>
28
29 #include <libpspp/alloc.h>
30 #include <libpspp/version.h>
31
32 #include "progname.h"
33 #include "xvasprintf.h"
34
35 /* Current command name as set by msg_set_command_name(). */
36 static char *command_name;
37
38 /* Message handler as set by msg_init(). */
39 static void (*msg_handler)  (const struct msg *);
40
41 /* Disables emitting messages if positive. */
42 static int messages_disabled;
43
44 /* Public functions. */
45
46 /* Writes error message in CLASS, with text FORMAT, formatted with
47    printf, to the standard places. */
48 void
49 msg (enum msg_class class, const char *format, ...)
50 {
51   struct msg m;
52   va_list args;
53
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);
58   va_end (args);
59
60   msg_emit (&m);
61 }
62
63 static struct source_stream *s_stream;
64
65 void
66 msg_init (struct source_stream *ss,  void (*handler) (const struct msg *) )
67 {
68   s_stream = ss;
69   msg_handler = handler;
70 }
71
72 void
73 msg_done (void)
74 {
75 }
76
77
78 /* Duplicate a message */
79 struct msg *
80 msg_dup(const struct msg *m)
81 {
82   struct msg *new_msg = xmalloc (sizeof *m);
83
84   *new_msg = *m;
85   new_msg->text = strdup(m->text);
86
87   return new_msg;
88 }
89
90 void
91 msg_destroy(struct msg *m)
92 {
93   free(m->text);
94   free(m);
95 }
96
97 /* Emits M as an error message.
98    Frees allocated data in M. */
99 void
100 msg_emit (struct msg *m)
101 {
102   get_msg_location (s_stream, &m->where);
103   if (!messages_disabled)
104     msg_handler (m);
105   free (m->text);
106 }
107
108 /* Disables message output until the next call to msg_enable.  If
109    this function is called multiple times, msg_enable must be
110    called an equal number of times before messages are actually
111    re-enabled. */
112 void
113 msg_disable (void)
114 {
115   messages_disabled++;
116 }
117
118 /* Enables message output that was disabled by msg_disable. */
119 void
120 msg_enable (void)
121 {
122   assert (messages_disabled > 0);
123   messages_disabled--;
124 }
125 \f
126 /* Private functions. */
127
128 /* Sets COMMAND_NAME as the command name included in some kinds
129    of error messages. */
130 void
131 msg_set_command_name (const char *command_name_)
132 {
133   free (command_name);
134   command_name = command_name_ ? xstrdup (command_name_) : NULL;
135 }
136
137 /* Returns the current command name, or NULL if none. */
138 const char *
139 msg_get_command_name (void)
140 {
141   return command_name;
142 }
143
144 void
145 request_bug_report_and_abort (const char *msg)
146 {
147   fprintf (stderr, "******************************************************\n");
148   fprintf (stderr, "You have discovered a bug in PSPP.  Please report this\n");
149   fprintf (stderr, "to " PACKAGE_BUGREPORT ".  Please include this entire\n");
150   fprintf (stderr, "message, *plus* several lines of output just above it.\n");
151   fprintf (stderr, "For the best chance at having the bug fixed, also\n");
152   fprintf (stderr, "include the syntax file that triggered it and a sample\n");
153   fprintf (stderr, "of any data file used for input.\n");
154   fprintf (stderr, "proximate cause:     %s\n", msg);
155   fprintf (stderr, "version:             %s\n", stat_version);
156   fprintf (stderr, "host_system:         %s\n", host_system);
157   fprintf (stderr, "build_system:        %s\n", build_system);
158   fprintf (stderr, "default_config_path: %s\n", default_config_path);
159   fprintf (stderr, "include_path:        %s\n", include_path);
160   fprintf (stderr, "locale_dir:          %s\n", locale_dir);
161   fprintf (stderr, "compiler version:    %s\n",
162 #ifdef __VERSION__
163            __VERSION__
164 #else
165            "Unknown"
166 #endif
167            );
168   fprintf (stderr, "******************************************************\n");
169
170   _exit (EXIT_FAILURE);
171 }