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