src/error.h

   1 /* PSPP - computes sample statistics.
   2    Copyright (C) 1997-9, 2000 Free Software Foundation, Inc.
   3    Written by Ben Pfaff <blp@gnu.org>.
   4
   5    This program is free software; you can redistribute it and/or
   6    modify it under the terms of the GNU General Public License as
   7    published by the Free Software Foundation; either version 2 of the
   8    License, or (at your option) any later version.
   9
  10    This program is distributed in the hope that it will be useful, but
  11    WITHOUT ANY WARRANTY; without even the implied warranty of
  12    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13    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, write to the Free Software
  17    Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
  18    02111-1307, USA. */
  19
  20 #if !error_h
  21 #define error_h 1
  22
  23 #include <stdarg.h>
  24
  25 /* Message classes. */
  26 enum
  27   {
  28     FE,                         /* Fatal errors. */
  29     SE, SW, SM,                 /* Script error/warning/message. */
  30     IE, IS,                     /* Installation error/script error. */
  31     DE, DW,                     /* Data-file error/warning. */
  32     ME, MW, MM,                 /* General error/warning/message. */
  33     ERR_CLASS_COUNT,            /* Number of message classes. */
  34     ERR_CLASS_MASK = 0xf,       /* Bitmask for class. */
  35     ERR_VERBOSITY_SHIFT = 4,    /* Shift count for verbosity. */
  36     ERR_VERBOSITY_MASK = 0xf,   /* Bitmask for verbosity. */
  37   };
  38
  39 /* If passed to msg() as CLASS, the return value will cause the message
  40    to be displayed only if `verbosity' is at least LEVEL. */
  41 #define VM(LEVEL) (MM | ((LEVEL) << ERR_VERBOSITY_SHIFT))
  42
  43 /* A file location.  */
  44 struct file_locator
  45   {
  46     const char *filename;               /* Filename. */
  47     int line_number;                    /* Line number. */
  48   };
  49
  50 /* An error message. */
  51 struct error
  52   {
  53     int class;                  /* One of the classes above. */
  54     struct file_locator where;  /* File location, or (NULL, -1). */
  55     const char *title;          /* Special text inserted if not null. */
  56     const char *text;           /* Error text. */
  57   };
  58
  59 /* Number of errors, warnings reported. */
  60 extern int err_error_count;
  61 extern int err_warning_count;
  62
  63 /* If number of allowable errors/warnings is exceeded, then a message
  64    is displayed and this flag is set to suppress subsequent
  65    messages. */
  66 extern int err_already_flagged;
  67
  68 /* Nonnegative verbosity level.  Higher value == more verbose. */
  69 extern int err_verbosity;
  70
  71 /* Functions. */
  72 void msg (int class, const char *format, ...)
  73      __attribute__ ((format (printf, 2, 3)));
  74 void tmsg (int class, const char *title, const char *format, ...)
  75      __attribute__ ((format (printf, 3, 4)));
  76 void err_failure (void);
  77 void err_cond_fail (void);
  78
  79 /* File-locator stack. */
  80 void err_push_file_locator (const struct file_locator *);
  81 void err_pop_file_locator (const struct file_locator *);
  82 void err_location (struct file_locator *);
  83
  84 /* Obscure functions. */
  85 void err_break (void);
  86 void err_check_count (void);
  87 void err_hcf (int exit_code) __attribute__ ((noreturn));
  88 void err_vmsg (const struct error *);
  89
  90 #endif /* error.h */