pintos-os.org Git - pspp/blob - src/libpspp/message.h

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 1997-9, 2000, 2006, 2010, 2011, 2014 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 #ifndef MESSAGE_H
  18 #define MESSAGE_H 1
  19
  20 #include <stdarg.h>
  21 #include <stdbool.h>
  22 #include <stddef.h>
  23 #include "libpspp/compiler.h"
  24
  25 struct string;
  26
  27 /* What kind of message is this? */
  28 enum msg_category
  29   {
  30     MSG_C_GENERAL,              /* General info. */
  31     MSG_C_SYNTAX,               /* Messages that relate to syntax files. */
  32     MSG_C_DATA,                 /* Messages that relate to data files. */
  33     MSG_N_CATEGORIES
  34   };
  35
  36 /* How important a condition is it? */
  37 enum msg_severity
  38   {
  39     MSG_S_ERROR,
  40     MSG_S_WARNING,
  41     MSG_S_NOTE,
  42     MSG_N_SEVERITIES
  43   };
  44
  45 const char *msg_severity_to_string (enum msg_severity);
  46
  47 /* Combination of a category and a severity for convenience. */
  48 enum msg_class
  49   {
  50     ME, MW, MN,                 /* General error/warning/note. */
  51     SE, SW, SN,                 /* Script error/warning/note. */
  52     DE, DW, DN,                 /* Data-file error/note. */
  53     MSG_CLASS_CNT,
  54   };
  55
  56 static inline enum msg_category
  57 msg_class_to_category (enum msg_class class)
  58 {
  59   return class / 3;
  60 }
  61
  62 static inline enum msg_severity
  63 msg_class_to_severity (enum msg_class class)
  64 {
  65   return class % 3;
  66 }
  67
  68 static inline enum msg_class
  69 msg_class_from_category_and_severity (enum msg_category category,
  70                                       enum msg_severity severity)
  71 {
  72   return category * 3 + severity;
  73 }
  74
  75 struct msg_location
  76   {
  77     const char *file_name;      /* Interned file name, or NULL. */
  78     int first_line;             /* 1-based line number, or 0 if none. */
  79     int last_line;              /* 1-based exclusive last line (0=none). */
  80     int first_column;           /* 1-based first column, or 0 if none. */
  81     int last_column;            /* 1-based exclusive last column (0=none). */
  82   };
  83
  84 void msg_location_uninit (struct msg_location *);
  85 void msg_location_destroy (struct msg_location *);
  86 struct msg_location *msg_location_dup (const struct msg_location *);
  87
  88 bool msg_location_is_empty (const struct msg_location *);
  89 void msg_location_format (const struct msg_location *, struct string *);
  90
  91 struct msg_stack
  92   {
  93     struct msg_location *location;
  94     char *description;
  95   };
  96
  97 void msg_stack_destroy (struct msg_stack *);
  98 struct msg_stack *msg_stack_dup (const struct msg_stack *);
  99
 100 /* A message. */
 101 struct msg
 102   {
 103     enum msg_category category; /* Message category. */
 104     enum msg_severity severity; /* Message severity. */
 105     struct msg_location *location; /* Code location. */
 106     struct msg_stack **stack;
 107     size_t n_stack;
 108     char *command_name;         /* Name of erroneous command, or NULL.  */
 109     char *text;                 /* Error text. */
 110   };
 111
 112 /* Initialization. */
 113 void msg_set_handler (void (*handler) (const struct msg *, void *lexer),
 114                       void *aux);
 115
 116 /* Working with messages. */
 117 struct msg *msg_dup (const struct msg *);
 118 void msg_destroy(struct msg *);
 119 char *msg_to_string (const struct msg *);
 120
 121 /* Emitting messages. */
 122 void vmsg (enum msg_class class, const char *format, va_list args)
 123      PRINTF_FORMAT (2, 0);
 124 void msg (enum msg_class, const char *format, ...)
 125      PRINTF_FORMAT (2, 3);
 126 void msg_emit (struct msg *);
 127
 128 void msg_error (int errnum, const char *format, ...)
 129   PRINTF_FORMAT (2, 3);
 130
 131
 132 /* Enable and disable messages. */
 133 void msg_enable (void);
 134 void msg_disable (void);
 135
 136 /* Error context. */
 137 bool msg_ui_too_many_errors (void);
 138 void msg_ui_reset_counts (void);
 139 bool msg_ui_any_errors (void);
 140 void msg_ui_disable_warnings (bool);
 141
 142
 143 /* Used in panic situations only. */
 144 const char * prepare_diagnostic_information (void);
 145 const char * prepare_fatal_error_message (void);
 146 void request_bug_report (const char *msg);
 147
 148
 149 #endif /* message.h */