Assorted improvements to diagnostics.
[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/intern.h"
31 #include "libpspp/str.h"
32 #include "libpspp/version.h"
33 #include "data/settings.h"
34
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"
40
41 #include "gettext.h"
42 #define _(msgid) gettext (msgid)
43
44 /* Message handler as set by msg_set_handler(). */
45 static struct msg_handler msg_handler = { .output_msg = NULL };
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 struct msg_location *location,
55       const char *format, va_list args)
56 {
57   struct msg *m = xmalloc (sizeof *m);
58   *m = (struct msg) {
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),
63   };
64   msg_emit (m);
65 }
66
67 /* Writes error message in CLASS, with text FORMAT, formatted with
68    printf, to the standard places. */
69 void
70 msg (enum msg_class class, const char *format, ...)
71 {
72   va_list args;
73   va_start (args, format);
74   vmsg (class, NULL, format, args);
75   va_end (args);
76 }
77
78 /* Outputs error message in CLASS, with text FORMAT, formatted with printf.
79    LOCATION is the reported location for the message. */
80 void
81 msg_at (enum msg_class class, const struct msg_location *location,
82         const char *format, ...)
83 {
84   va_list args;
85   va_start (args, format);
86   vmsg (class, location, format, args);
87   va_end (args);
88 }
89
90 void
91 msg_error (int errnum, const char *format, ...)
92 {
93   va_list args;
94   va_start (args, format);
95   struct string s = DS_EMPTY_INITIALIZER;
96   ds_put_vformat (&s, format, args);
97   va_end (args);
98   ds_put_format (&s, ": %s", strerror (errnum));
99
100   struct msg *m = xmalloc (sizeof *m);
101   *m = (struct msg) {
102     .category = MSG_C_GENERAL,
103     .severity = MSG_S_ERROR,
104     .text = ds_steal_cstr (&s),
105   };
106   msg_emit (m);
107 }
108
109 void
110 msg_set_handler (const struct msg_handler *handler)
111 {
112   msg_handler = *handler;
113 }
114 \f
115 /* msg_point. */
116
117 /* Takes POINT, adds to it the syntax in SYNTAX, incrementing the line number
118    for each new-line in SYNTAX and the column number for each column, and
119    returns the result. */
120 struct msg_point
121 msg_point_advance (struct msg_point point, struct substring syntax)
122 {
123   for (;;)
124     {
125       size_t newline = ss_find_byte (syntax, '\n');
126       if (newline == SIZE_MAX)
127         break;
128       point.line++;
129       point.column = 1;
130       ss_advance (&syntax, newline + 1);
131     }
132
133   point.column += ss_utf8_count_columns (syntax);
134   return point;
135 }
136 \f
137 /* msg_location. */
138
139 void
140 msg_location_uninit (struct msg_location *loc)
141 {
142   if (msg_handler.lex_source_unref)
143     msg_handler.lex_source_unref (loc->src);
144   intern_unref (loc->file_name);
145 }
146
147 void
148 msg_location_destroy (struct msg_location *loc)
149 {
150   if (loc)
151     {
152       msg_location_uninit (loc);
153       free (loc);
154     }
155 }
156
157 static int
158 msg_point_compare_3way (const struct msg_point *a, const struct msg_point *b)
159 {
160   return (!a->line ? 1
161           : !b->line ? -1
162           : a->line > b->line ? 1
163           : a->line < b->line ? -1
164           : !a->column ? 1
165           : !b->column ? -1
166           : a->column > b->column ? 1
167           : a->column < b->column ? -1
168           : 0);
169 }
170
171 void
172 msg_location_remove_columns (struct msg_location *location)
173 {
174   location->start.column = 0;
175   location->end.column = 0;
176 }
177
178 void
179 msg_location_merge (struct msg_location **dstp, const struct msg_location *src)
180 {
181   struct msg_location *dst = *dstp;
182   if (!dst)
183     {
184       *dstp = msg_location_dup (src);
185       return;
186     }
187
188   if (dst->file_name != src->file_name)
189     {
190       /* Failure. */
191       return;
192     }
193   if (msg_point_compare_3way (&dst->start, &src->start) > 0)
194     dst->start = src->start;
195   if (msg_point_compare_3way (&dst->end, &src->end) < 0)
196     dst->end = src->end;
197 }
198
199 struct msg_location *
200 msg_location_merged (const struct msg_location *a,
201                      const struct msg_location *b)
202 {
203   struct msg_location *new = msg_location_dup (a);
204   if (b)
205     msg_location_merge (&new, b);
206   return new;
207 }
208
209 struct msg_location *
210 msg_location_dup (const struct msg_location *src)
211 {
212   if (!src)
213     return NULL;
214
215   struct msg_location *dst = xmalloc (sizeof *dst);
216   *dst = *src;
217   if (src->file_name)
218     dst->file_name = intern_ref (src->file_name);
219   if (msg_handler.lex_source_ref && src->src)
220     msg_handler.lex_source_ref (dst->src);
221   return dst;
222 }
223
224 bool
225 msg_location_is_empty (const struct msg_location *loc)
226 {
227   return !loc || (!loc->file_name
228                   && loc->start.line <= 0
229                   && loc->start.column <= 0);
230 }
231
232 void
233 msg_location_format (const struct msg_location *loc, struct string *s)
234 {
235   if (!loc)
236     return;
237
238   if (loc->file_name)
239     ds_put_cstr (s, loc->file_name);
240
241   int l1 = loc->start.line;
242   int l2 = MAX (l1, loc->end.line);
243   int c1 = loc->start.column;
244   int c2 = MAX (c1, loc->end.column);
245
246   if (l1 > 0)
247     {
248       if (loc->file_name)
249         ds_put_byte (s, ':');
250
251       if (l2 > l1)
252         {
253           if (c1 > 0)
254             ds_put_format (s, "%d.%d-%d.%d", l1, c1, l2, c2);
255           else
256             ds_put_format (s, "%d-%d", l1, l2);
257         }
258       else
259         {
260           if (c1 > 0)
261             {
262               if (c2 > c1)
263                 {
264                   /* The GNU coding standards say to use
265                      LINENO-1.COLUMN-1-COLUMN-2 for this case, but GNU
266                      Emacs interprets COLUMN-2 as LINENO-2 if I do that.
267                      I've submitted an Emacs bug report:
268                      http://debbugs.gnu.org/cgi/bugreport.cgi?bug=7725.
269
270                      For now, let's be compatible. */
271                   ds_put_format (s, "%d.%d-%d.%d", l1, c1, l1, c2);
272                 }
273               else
274                 ds_put_format (s, "%d.%d", l1, c1);
275             }
276           else
277             ds_put_format (s, "%d", l1);
278         }
279     }
280   else if (c1 > 0)
281     {
282       if (c2 > c1)
283         ds_put_format (s, ".%d-%d", c1, c2);
284       else
285         ds_put_format (s, ".%d", c1);
286     }
287 }
288 \f
289 /* msg_stack */
290
291 void
292 msg_stack_destroy (struct msg_stack *stack)
293 {
294   if (stack)
295     {
296       msg_location_destroy (stack->location);
297       free (stack->description);
298       free (stack);
299     }
300 }
301
302 struct msg_stack *
303 msg_stack_dup (const struct msg_stack *src)
304 {
305   struct msg_stack *dst = xmalloc (sizeof *src);
306   *dst = (struct msg_stack) {
307     .location = msg_location_dup (src->location),
308     .description = xstrdup_if_nonnull (src->description),
309   };
310   return dst;
311 }
312 \f
313 /* Working with messages. */
314
315 const char *
316 msg_severity_to_string (enum msg_severity severity)
317 {
318   switch (severity)
319     {
320     case MSG_S_ERROR:
321       return _("error");
322     case MSG_S_WARNING:
323       return _("warning");
324     case MSG_S_NOTE:
325     default:
326       return _("note");
327     }
328 }
329
330 /* Duplicate a message */
331 struct msg *
332 msg_dup (const struct msg *src)
333 {
334   struct msg_stack **ms = xmalloc (src->n_stack * sizeof *ms);
335   for (size_t i = 0; i < src->n_stack; i++)
336     ms[i] = msg_stack_dup (src->stack[i]);
337
338   struct msg *dst = xmalloc (sizeof *dst);
339   *dst = (struct msg) {
340     .category = src->category,
341     .severity = src->severity,
342     .stack = ms,
343     .n_stack = src->n_stack,
344     .location = msg_location_dup (src->location),
345     .command_name = xstrdup_if_nonnull (src->command_name),
346     .text = xstrdup (src->text),
347   };
348   return dst;
349 }
350
351 /* Frees a message created by msg_dup().
352
353    (Messages not created by msg_dup(), as well as their file_name
354    members, are typically not dynamically allocated, so this function should
355    not be used to destroy them.) */
356 void
357 msg_destroy (struct msg *m)
358 {
359   if (m)
360     {
361       for (size_t i = 0; i < m->n_stack; i++)
362         msg_stack_destroy (m->stack[i]);
363       free (m->stack);
364       msg_location_destroy (m->location);
365       free (m->text);
366       free (m->command_name);
367       free (m);
368     }
369 }
370
371 char *
372 msg_to_string (const struct msg *m)
373 {
374   struct string s;
375
376   ds_init_empty (&s);
377
378   for (size_t i = 0; i < m->n_stack; i++)
379     {
380       const struct msg_stack *ms = m->stack[i];
381       if (!msg_location_is_empty (ms->location))
382         {
383           msg_location_format (ms->location, &s);
384           ds_put_cstr (&s, ": ");
385         }
386       ds_put_format (&s, "%s\n", ms->description);
387     }
388   if (m->category != MSG_C_GENERAL && !msg_location_is_empty (m->location))
389     {
390       msg_location_format (m->location, &s);
391       ds_put_cstr (&s, ": ");
392     }
393
394   ds_put_format (&s, "%s: ", msg_severity_to_string (m->severity));
395
396   if (m->category == MSG_C_SYNTAX && m->command_name != NULL)
397     ds_put_format (&s, "%s: ", m->command_name);
398
399   ds_put_cstr (&s, m->text);
400
401   const struct msg_location *loc = m->location;
402   if (m->category != MSG_C_GENERAL
403       && loc->src && loc->start.line && loc->start.column
404       && msg_handler.lex_source_get_line)
405     {
406       int l0 = loc->start.line;
407       int l1 = loc->end.line;
408       int nl = l1 - l0;
409       for (int ln = l0; ln <= l1; ln++)
410         {
411           if (nl > 3 && ln == l0 + 2)
412             {
413               ds_put_cstr (&s, "\n  ... |");
414               ln = l1;
415             }
416
417           struct substring line = msg_handler.lex_source_get_line (
418             loc->src, ln);
419           ss_rtrim (&line, ss_cstr ("\n\r"));
420
421           ds_put_format (&s, "\n%5d | ", ln);
422           ds_put_substring (&s, line);
423
424           int c0 = ln == l0 ? loc->start.column : 1;
425           int c1 = ln == l1 ? loc->end.column : ss_utf8_count_columns (line);
426           if (c0 > 0 && c1 >= c0 && !loc->omit_underlines)
427             {
428               ds_put_cstr (&s, "\n      |");
429               ds_put_byte_multiple (&s, ' ', c0);
430               if (ln == l0)
431                 {
432                   ds_put_byte (&s, '^');
433                   if (c1 > c0)
434                     ds_put_byte_multiple (&s, '~', c1 - c0);
435                 }
436               else
437                 ds_put_byte_multiple (&s, '-', c1 - c0 + 1);
438             }
439         }
440     }
441
442   return ds_cstr (&s);
443 }
444 \f
445
446 /* Number of messages reported, by severity level. */
447 static int counts[MSG_N_SEVERITIES];
448
449 /* True after the maximum number of errors or warnings has been exceeded. */
450 static bool too_many_errors;
451
452 /* True after the maximum number of notes has been exceeded. */
453 static bool too_many_notes;
454
455 /* True iff warnings have been explicitly disabled (MXWARNS = 0) */
456 static bool warnings_off = false;
457
458 /* Checks whether we've had so many errors that it's time to quit
459    processing this syntax file. */
460 bool
461 msg_ui_too_many_errors (void)
462 {
463   return too_many_errors;
464 }
465
466 void
467 msg_ui_disable_warnings (bool x)
468 {
469   warnings_off = x;
470 }
471
472
473 void
474 msg_ui_reset_counts (void)
475 {
476   int i;
477
478   for (i = 0; i < MSG_N_SEVERITIES; i++)
479     counts[i] = 0;
480   too_many_errors = false;
481   too_many_notes = false;
482 }
483
484 bool
485 msg_ui_any_errors (void)
486 {
487   return counts[MSG_S_ERROR] > 0;
488 }
489
490
491 static void
492 ship_message (const struct msg *m)
493 {
494   enum { MAX_STACK = 4 };
495   static const struct msg *stack[MAX_STACK];
496   static size_t n;
497
498   /* If we're recursing on a given message, or recursing deeply, drop it. */
499   if (n >= MAX_STACK)
500     return;
501   for (size_t i = 0; i < n; i++)
502     if (stack[i] == m)
503       return;
504
505   stack[n++] = m;
506   if (msg_handler.output_msg && n <= 1)
507     msg_handler.output_msg (m, msg_handler.aux);
508   else
509     fprintf (stderr, "%s\n", m->text);
510   n--;
511 }
512
513 static void
514 submit_note (char *s)
515 {
516   struct msg m = {
517     .category = MSG_C_GENERAL,
518     .severity = MSG_S_NOTE,
519     .text = s,
520   };
521   ship_message (&m);
522
523   free (s);
524 }
525
526 static void
527 process_msg (struct msg *m)
528 {
529   int n_msgs, max_msgs;
530
531   if (too_many_errors
532       || (too_many_notes && m->severity == MSG_S_NOTE)
533       || (warnings_off && m->severity == MSG_S_WARNING))
534     return;
535
536   ship_message (m);
537
538   counts[m->severity]++;
539   max_msgs = settings_get_max_messages (m->severity);
540   n_msgs = counts[m->severity];
541   if (m->severity == MSG_S_WARNING)
542     n_msgs += counts[MSG_S_ERROR];
543   if (n_msgs > max_msgs)
544     {
545       if (m->severity == MSG_S_NOTE)
546         {
547           too_many_notes = true;
548           submit_note (xasprintf (_("Notes (%d) exceed limit (%d).  "
549                                     "Suppressing further notes."),
550                                   n_msgs, max_msgs));
551         }
552       else
553         {
554           too_many_errors = true;
555           if (m->severity == MSG_S_WARNING)
556             submit_note (xasprintf (_("Warnings (%d) exceed limit (%d).  Syntax processing will be halted."),
557                                     n_msgs, max_msgs));
558           else
559             submit_note (xasprintf (_("Errors (%d) exceed limit (%d).  Syntax processing will be halted."),
560                                     n_msgs, max_msgs));
561         }
562     }
563 }
564
565
566 /* Emits M as an error message.  Takes ownership of M. */
567 void
568 msg_emit (struct msg *m)
569 {
570   if (!messages_disabled)
571     process_msg (m);
572   msg_destroy (m);
573 }
574
575 /* Disables message output until the next call to msg_enable.  If
576    this function is called multiple times, msg_enable must be
577    called an equal number of times before messages are actually
578    re-enabled. */
579 void
580 msg_disable (void)
581 {
582   messages_disabled++;
583 }
584
585 /* Enables message output that was disabled by msg_disable. */
586 void
587 msg_enable (void)
588 {
589   assert (messages_disabled > 0);
590   messages_disabled--;
591 }
592 \f
593 /* Private functions. */
594
595 static char fatal_error_message[1024];
596 static int fatal_error_message_bytes = 0;
597
598 static char diagnostic_information[1024];
599 static int diagnostic_information_bytes = 0;
600
601 static int
602 append_message (char *msg, int bytes_used, const char *fmt, ...)
603 {
604   va_list va;
605   va_start (va, fmt);
606   int ret = vsnprintf (msg + bytes_used, 1024 - bytes_used, fmt, va);
607   va_end (va);
608   assert (ret >= 0);
609
610   return ret;
611 }
612
613
614 /* Generate a row of asterisks held in statically allocated memory  */
615 static struct substring
616 generate_banner (void)
617 {
618   static struct substring banner;
619   if (!banner.string)
620     banner = ss_cstr ("******************************************************\n");
621   return banner;
622 }
623
624 const char *
625 prepare_fatal_error_message (void)
626 {
627   fatal_error_message_bytes += append_message (fatal_error_message, fatal_error_message_bytes, generate_banner ().string);
628
629   fatal_error_message_bytes += append_message (fatal_error_message, fatal_error_message_bytes, "You have discovered a bug in PSPP.  Please report this\n");
630   fatal_error_message_bytes += append_message (fatal_error_message, fatal_error_message_bytes, "to " PACKAGE_BUGREPORT ".  Please include this entire\n");
631   fatal_error_message_bytes += append_message (fatal_error_message, fatal_error_message_bytes, "message, *plus* several lines of output just above it.\n");
632   fatal_error_message_bytes += append_message (fatal_error_message, fatal_error_message_bytes, "For the best chance at having the bug fixed, also\n");
633   fatal_error_message_bytes += append_message (fatal_error_message, fatal_error_message_bytes, "include the syntax file that triggered it and a sample\n");
634   fatal_error_message_bytes += append_message (fatal_error_message, fatal_error_message_bytes, "of any data file used for input.\n");
635   return fatal_error_message;
636 }
637
638 const char *
639 prepare_diagnostic_information (void)
640 {
641   diagnostic_information_bytes += append_message (diagnostic_information, diagnostic_information_bytes, "version:             %s\n", version);
642   diagnostic_information_bytes += append_message (diagnostic_information, diagnostic_information_bytes, "host_system:         %s\n", host_system);
643   diagnostic_information_bytes += append_message (diagnostic_information, diagnostic_information_bytes, "build_system:        %s\n", build_system);
644   diagnostic_information_bytes += append_message (diagnostic_information, diagnostic_information_bytes, "locale_dir:          %s\n", relocate (locale_dir));
645   diagnostic_information_bytes += append_message (diagnostic_information, diagnostic_information_bytes, "compiler version:    %s\n",
646 #ifdef __VERSION__
647            __VERSION__
648 #else
649            "Unknown"
650 #endif
651 );
652
653   return diagnostic_information;
654 }
655
656 void
657 request_bug_report (const char *msg)
658 {
659   write (STDERR_FILENO, fatal_error_message, fatal_error_message_bytes);
660   write (STDERR_FILENO, "proximate cause:     ", 21);
661   write (STDERR_FILENO, msg, strlen (msg));
662   write (STDERR_FILENO, "\n", 1);
663   write (STDERR_FILENO, diagnostic_information, diagnostic_information_bytes);
664   const struct substring banner = generate_banner ();
665   write (STDERR_FILENO, banner.string, banner.length);
666 }