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