message: Make msg_emit() take full ownership of its argument.
[pspp] / src / libpspp / message.c
1 /* PSPP - a program for statistical analysis.
2    Copyright (C) 1997-9, 2000, 2006, 2009, 2010,
3    2011, 2013 Free Software Foundation, Inc.
4
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.
9
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.
14
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/>. */
17
18 #include <config.h>
19
20 #include "libpspp/message.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/cast.h"
30 #include "libpspp/str.h"
31 #include "libpspp/version.h"
32 #include "data/settings.h"
33
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"
39
40 #include "gettext.h"
41 #define _(msgid) gettext (msgid)
42
43 /* Message handler as set by msg_set_handler(). */
44 static void (*msg_handler)  (const struct msg *, void *aux);
45 static void *msg_aux;
46
47 /* Disables emitting messages if positive. */
48 static int messages_disabled;
49
50 /* Public functions. */
51
52
53 void
54 vmsg (enum msg_class class, const char *format, va_list args)
55 {
56   struct msg *m = xmalloc (sizeof *m);
57   *m = (struct msg) {
58     .category = msg_class_to_category (class),
59     .severity = msg_class_to_severity (class),
60     .text = xvasprintf (format, args),
61   };
62   msg_emit (m);
63 }
64
65 /* Writes error message in CLASS, with text FORMAT, formatted with
66    printf, to the standard places. */
67 void
68 msg (enum msg_class class, const char *format, ...)
69 {
70   va_list args;
71   va_start (args, format);
72   vmsg (class, format, args);
73   va_end (args);
74 }
75
76
77
78 void
79 msg_error (int errnum, const char *format, ...)
80 {
81   va_list args;
82   va_start (args, format);
83   struct string s = DS_EMPTY_INITIALIZER;
84   ds_put_vformat (&s, format, args);
85   va_end (args);
86   ds_put_format (&s, ": %s", strerror (errnum));
87
88   struct msg *m = xmalloc (sizeof *m);
89   *m = (struct msg) {
90     .category = MSG_C_GENERAL,
91     .severity = MSG_S_ERROR,
92     .text = ds_steal_cstr (&s),
93   };
94   msg_emit (m);
95 }
96
97
98
99 void
100 msg_set_handler (void (*handler) (const struct msg *, void *aux), void *aux)
101 {
102   msg_handler = handler;
103   msg_aux = aux;
104 }
105 \f
106 /* msg_location. */
107
108 void
109 msg_location_destroy (struct msg_location *loc)
110 {
111   if (loc)
112     {
113       free (loc->file_name);
114       free (loc);
115     }
116 }
117
118 struct msg_location *
119 msg_location_dup (const struct msg_location *src)
120 {
121   if (!src)
122     return NULL;
123
124   struct msg_location *dst = xmalloc (sizeof *dst);
125   *dst = (struct msg_location) {
126     .file_name = xstrdup_if_nonnull (src->file_name),
127     .first_line = src->first_line,
128     .last_line = src->last_line,
129     .first_column = src->first_column,
130     .last_column = src->last_column,
131   };
132   return dst;
133 }
134
135 bool
136 msg_location_is_empty (const struct msg_location *loc)
137 {
138   return !loc || (!loc->file_name
139                   && loc->first_line <= 0
140                   && loc->first_column <= 0);
141 }
142
143 void
144 msg_location_format (const struct msg_location *loc, struct string *s)
145 {
146   if (!loc)
147     return;
148
149   if (loc->file_name)
150     ds_put_cstr (s, loc->file_name);
151
152   int l1 = loc->first_line;
153   int l2 = MAX (loc->first_line, loc->last_line - 1);
154   int c1 = loc->first_column;
155   int c2 = MAX (loc->first_column, loc->last_column - 1);
156
157   if (l1 > 0)
158     {
159       if (loc->file_name)
160         ds_put_byte (s, ':');
161
162       if (l2 > l1)
163         {
164           if (c1 > 0)
165             ds_put_format (s, "%d.%d-%d.%d", l1, c1, l2, c2);
166           else
167             ds_put_format (s, "%d-%d", l1, l2);
168         }
169       else
170         {
171           if (c1 > 0)
172             {
173               if (c2 > c1)
174                 {
175                   /* The GNU coding standards say to use
176                      LINENO-1.COLUMN-1-COLUMN-2 for this case, but GNU
177                      Emacs interprets COLUMN-2 as LINENO-2 if I do that.
178                      I've submitted an Emacs bug report:
179                      http://debbugs.gnu.org/cgi/bugreport.cgi?bug=7725.
180
181                      For now, let's be compatible. */
182                   ds_put_format (s, "%d.%d-%d.%d", l1, c1, l1, c2);
183                 }
184               else
185                 ds_put_format (s, "%d.%d", l1, c1);
186             }
187           else
188             ds_put_format (s, "%d", l1);
189         }
190     }
191   else if (c1 > 0)
192     {
193       if (c2 > c1)
194         ds_put_format (s, ".%d-%d", c1, c2);
195       else
196         ds_put_format (s, ".%d", c1);
197     }
198 }
199 \f
200 /* Working with messages. */
201
202 const char *
203 msg_severity_to_string (enum msg_severity severity)
204 {
205   switch (severity)
206     {
207     case MSG_S_ERROR:
208       return _("error");
209     case MSG_S_WARNING:
210       return _("warning");
211     case MSG_S_NOTE:
212     default:
213       return _("note");
214     }
215 }
216
217 /* Duplicate a message */
218 struct msg *
219 msg_dup (const struct msg *src)
220 {
221   struct msg *dst = xmalloc (sizeof *dst);
222   *dst = (struct msg) {
223     .category = src->category,
224     .severity = src->severity,
225     .location = msg_location_dup (src->location),
226     .command_name = xstrdup_if_nonnull (src->command_name),
227     .text = xstrdup (src->text),
228   };
229   return dst;
230 }
231
232 /* Frees a message created by msg_dup().
233
234    (Messages not created by msg_dup(), as well as their file_name
235    members, are typically not dynamically allocated, so this function should
236    not be used to destroy them.) */
237 void
238 msg_destroy (struct msg *m)
239 {
240   if (m)
241     {
242       msg_location_destroy (m->location);
243       free (m->text);
244       free (m->command_name);
245       free (m);
246     }
247 }
248
249 char *
250 msg_to_string (const struct msg *m)
251 {
252   struct string s;
253
254   ds_init_empty (&s);
255
256   if (m->category != MSG_C_GENERAL && !msg_location_is_empty (m->location))
257     {
258       msg_location_format (m->location, &s);
259       ds_put_cstr (&s, ": ");
260     }
261
262   ds_put_format (&s, "%s: ", msg_severity_to_string (m->severity));
263
264   if (m->category == MSG_C_SYNTAX && m->command_name != NULL)
265     ds_put_format (&s, "%s: ", m->command_name);
266
267   ds_put_cstr (&s, m->text);
268
269   return ds_cstr (&s);
270 }
271 \f
272
273 /* Number of messages reported, by severity level. */
274 static int counts[MSG_N_SEVERITIES];
275
276 /* True after the maximum number of errors or warnings has been exceeded. */
277 static bool too_many_errors;
278
279 /* True after the maximum number of notes has been exceeded. */
280 static bool too_many_notes;
281
282 /* True iff warnings have been explicitly disabled (MXWARNS = 0) */
283 static bool warnings_off = false;
284
285 /* Checks whether we've had so many errors that it's time to quit
286    processing this syntax file. */
287 bool
288 msg_ui_too_many_errors (void)
289 {
290   return too_many_errors;
291 }
292
293 void
294 msg_ui_disable_warnings (bool x)
295 {
296   warnings_off = x;
297 }
298
299
300 void
301 msg_ui_reset_counts (void)
302 {
303   int i;
304
305   for (i = 0; i < MSG_N_SEVERITIES; i++)
306     counts[i] = 0;
307   too_many_errors = false;
308   too_many_notes = false;
309 }
310
311 bool
312 msg_ui_any_errors (void)
313 {
314   return counts[MSG_S_ERROR] > 0;
315 }
316
317
318 static void
319 ship_message (const struct msg *m)
320 {
321   enum { MAX_STACK = 4 };
322   static const struct msg *stack[MAX_STACK];
323   static size_t n;
324
325   /* If we're recursing on a given message, or recursing deeply, drop it. */
326   if (n >= MAX_STACK)
327     return;
328   for (size_t i = 0; i < n; i++)
329     if (stack[i] == m)
330       return;
331
332   stack[n++] = m;
333   if (msg_handler && n <= 1)
334     msg_handler (m, msg_aux);
335   else
336     fprintf (stderr, "%s\n", m->text);
337   n--;
338 }
339
340 static void
341 submit_note (char *s)
342 {
343   struct msg m = {
344     .category = MSG_C_GENERAL,
345     .severity = MSG_S_NOTE,
346     .text = s,
347   };
348   ship_message (&m);
349
350   free (s);
351 }
352
353 static void
354 process_msg (struct msg *m)
355 {
356   int n_msgs, max_msgs;
357
358   if (too_many_errors
359       || (too_many_notes && m->severity == MSG_S_NOTE)
360       || (warnings_off && m->severity == MSG_S_WARNING))
361     return;
362
363   ship_message (m);
364
365   counts[m->severity]++;
366   max_msgs = settings_get_max_messages (m->severity);
367   n_msgs = counts[m->severity];
368   if (m->severity == MSG_S_WARNING)
369     n_msgs += counts[MSG_S_ERROR];
370   if (n_msgs > max_msgs)
371     {
372       if (m->severity == MSG_S_NOTE)
373         {
374           too_many_notes = true;
375           submit_note (xasprintf (_("Notes (%d) exceed limit (%d).  "
376                                     "Suppressing further notes."),
377                                   n_msgs, max_msgs));
378         }
379       else
380         {
381           too_many_errors = true;
382           if (m->severity == MSG_S_WARNING)
383             submit_note (xasprintf (_("Warnings (%d) exceed limit (%d).  Syntax processing will be halted."),
384                                     n_msgs, max_msgs));
385           else
386             submit_note (xasprintf (_("Errors (%d) exceed limit (%d).  Syntax processing will be halted."),
387                                     n_msgs, max_msgs));
388         }
389     }
390 }
391
392
393 /* Emits M as an error message.  Takes ownership of M. */
394 void
395 msg_emit (struct msg *m)
396 {
397   if (!messages_disabled)
398     process_msg (m);
399   msg_destroy (m);
400 }
401
402 /* Disables message output until the next call to msg_enable.  If
403    this function is called multiple times, msg_enable must be
404    called an equal number of times before messages are actually
405    re-enabled. */
406 void
407 msg_disable (void)
408 {
409   messages_disabled++;
410 }
411
412 /* Enables message output that was disabled by msg_disable. */
413 void
414 msg_enable (void)
415 {
416   assert (messages_disabled > 0);
417   messages_disabled--;
418 }
419 \f
420 /* Private functions. */
421
422 static char fatal_error_message[1024];
423 static int fatal_error_message_bytes = 0;
424
425 static char diagnostic_information[1024];
426 static int diagnostic_information_bytes = 0;
427
428 static int
429 append_message (char *msg, int bytes_used, const char *fmt, ...)
430 {
431   va_list va;
432   va_start (va, fmt);
433   int ret = vsnprintf (msg + bytes_used, 1024 - bytes_used, fmt, va);
434   va_end (va);
435   assert (ret >= 0);
436
437   return ret;
438 }
439
440
441 /* Generate a row of asterisks held in statically allocated memory  */
442 static struct substring
443 generate_banner (void)
444 {
445   static struct substring banner;
446   if (!banner.string)
447     banner = ss_cstr ("******************************************************\n");
448   return banner;
449 }
450
451 const char *
452 prepare_fatal_error_message (void)
453 {
454   fatal_error_message_bytes += append_message (fatal_error_message, fatal_error_message_bytes, generate_banner ().string);
455
456   fatal_error_message_bytes += append_message (fatal_error_message, fatal_error_message_bytes, "You have discovered a bug in PSPP.  Please report this\n");
457   fatal_error_message_bytes += append_message (fatal_error_message, fatal_error_message_bytes, "to " PACKAGE_BUGREPORT ".  Please include this entire\n");
458   fatal_error_message_bytes += append_message (fatal_error_message, fatal_error_message_bytes, "message, *plus* several lines of output just above it.\n");
459   fatal_error_message_bytes += append_message (fatal_error_message, fatal_error_message_bytes, "For the best chance at having the bug fixed, also\n");
460   fatal_error_message_bytes += append_message (fatal_error_message, fatal_error_message_bytes, "include the syntax file that triggered it and a sample\n");
461   fatal_error_message_bytes += append_message (fatal_error_message, fatal_error_message_bytes, "of any data file used for input.\n");
462   return fatal_error_message;
463 }
464
465 const char *
466 prepare_diagnostic_information (void)
467 {
468   diagnostic_information_bytes += append_message (diagnostic_information, diagnostic_information_bytes, "version:             %s\n", version);
469   diagnostic_information_bytes += append_message (diagnostic_information, diagnostic_information_bytes, "host_system:         %s\n", host_system);
470   diagnostic_information_bytes += append_message (diagnostic_information, diagnostic_information_bytes, "build_system:        %s\n", build_system);
471   diagnostic_information_bytes += append_message (diagnostic_information, diagnostic_information_bytes, "locale_dir:          %s\n", relocate (locale_dir));
472   diagnostic_information_bytes += append_message (diagnostic_information, diagnostic_information_bytes, "compiler version:    %s\n",
473 #ifdef __VERSION__
474            __VERSION__
475 #else
476            "Unknown"
477 #endif
478 );
479
480   return diagnostic_information;
481 }
482
483 void
484 request_bug_report (const char *msg)
485 {
486   write (STDERR_FILENO, fatal_error_message, fatal_error_message_bytes);
487   write (STDERR_FILENO, "proximate cause:     ", 21);
488   write (STDERR_FILENO, msg, strlen (msg));
489   write (STDERR_FILENO, "\n", 1);
490   write (STDERR_FILENO, diagnostic_information, diagnostic_information_bytes);
491   const struct substring banner = generate_banner ();
492   write (STDERR_FILENO, banner.string, banner.length);
493 }