SET MXWARNS = 0 to be interpreted as unlimited.
[pspp] / src / libpspp / message.h
index 0cf6739941ba3edbf39102223435f0823562d380..bdd27a5e72faac5cc52ee2e85bbd8a992a7c6912 100644 (file)
@@ -1,21 +1,18 @@
-/* PSPP - computes sample statistics.
+/* PSPP - a program for statistical analysis.
    Copyright (C) 1997-9, 2000, 2006 Free Software Foundation, Inc.
-   Written by Ben Pfaff <blp@gnu.org>.
 
-   This program is free software; you can redistribute it and/or
-   modify it under the terms of the GNU General Public License as
-   published by the Free Software Foundation; either version 2 of the
-   License, or (at your option) any later version.
+   This program is free software: you can redistribute it and/or modify
+   it under the terms of the GNU General Public License as published by
+   the Free Software Foundation, either version 3 of the License, or
+   (at your option) any later version.
 
-   This program is distributed in the hope that it will be useful, but
-   WITHOUT ANY WARRANTY; without even the implied warranty of
-   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-   General Public License for more details.
+   This program is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+   GNU General Public License for more details.
 
    You should have received a copy of the GNU General Public License
-   along with this program; if not, write to the Free Software
-   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
-   02110-1301, USA. */
+   along with this program.  If not, see <http://www.gnu.org/licenses/>. */
 
 #ifndef MESSAGE_H
 #define MESSAGE_H 1
 #include <libpspp/compiler.h>
 
 /* What kind of message is this? */
-enum msg_category 
+enum msg_category
   {
-    MSG_GENERAL,        /* General info. */
-    MSG_SYNTAX,         /* Messages that relate to syntax files. */
-    MSG_DATA            /* Messages that relate to data files. */
+    MSG_C_GENERAL,              /* General info. */
+    MSG_C_SYNTAX,               /* Messages that relate to syntax files. */
+    MSG_C_DATA,                 /* Messages that relate to data files. */
+    MSG_N_CATEGORIES
   };
 
 /* How important a condition is it? */
-enum msg_severity 
+enum msg_severity
   {
-    MSG_ERROR,
-    MSG_WARNING,
-    MSG_NOTE
+    MSG_S_ERROR,
+    MSG_S_WARNING,
+    MSG_S_NOTE,
+    MSG_N_SEVERITIES
   };
 
 /* Combination of a category and a severity for convenience. */
@@ -49,22 +48,21 @@ enum msg_class
     MSG_CLASS_CNT,
   };
 
-
 static inline enum msg_category
-msg_class_to_category (enum msg_class class) 
+msg_class_to_category (enum msg_class class)
 {
   return class / 3;
 }
 
 static inline enum msg_severity
-msg_class_to_severity (enum msg_class class) 
+msg_class_to_severity (enum msg_class class)
 {
   return class % 3;
 }
 
 static inline enum msg_class
 msg_class_from_category_and_severity (enum msg_category category,
-                                      enum msg_severity severity) 
+                                      enum msg_severity severity)
 {
   return category * 3 + severity;
 }
@@ -72,8 +70,8 @@ msg_class_from_category_and_severity (enum msg_category category,
 /* A file location.  */
 struct msg_locator
   {
-    const char *file_name;             /* File name. */
-    int line_number;                   /* Line number. */
+    char *file_name;           /* File name. */
+    int line_number;            /* Line number. */
   };
 
 /* A message. */
@@ -85,46 +83,39 @@ struct msg
     char *text;                 /* Error text. */
   };
 
-/* Number of errors, warnings reported. */
-extern int err_error_count;
-extern int err_warning_count;
-
-/* If number of allowable errors/warnings is exceeded, then a message
-   is displayed and this flag is set to suppress subsequent
-   messages. */
-extern int err_already_flagged;
-
-/* Nonnegative verbosity level.  Higher value == more verbose. */
-extern int err_verbosity;
+struct source_stream ;
 
 /* Initialization. */
+void msg_init (struct source_stream *, void (*handler) (const struct msg *) );
+
 void msg_done (void);
 
+/* Working with messages. */
+struct msg *msg_dup (const struct msg *);
+void msg_destroy(struct msg *);
+char *msg_to_string (const struct msg *, const char *command_name);
+
 /* Emitting messages. */
 void msg (enum msg_class, const char *format, ...)
      PRINTF_FORMAT (2, 3);
-void msg_emit (const struct msg *);
+void msg_emit (struct msg *);
 
-void verbose_msg (int level, const char *format, ...)
-     PRINTF_FORMAT (2, 3);
+/* Enable and disable messages. */
+void msg_enable (void);
+void msg_disable (void);
 
 /* Error context. */
-void msg_set_command_name (const char *);
 void msg_push_msg_locator (const struct msg_locator *);
 void msg_pop_msg_locator (const struct msg_locator *);
-void msg_location (struct msg_locator *);
-void err_check_count (void);
 
-/* Used in panic situations only. */
-void request_bug_report_and_abort (const char *msg);
+bool msg_ui_too_many_errors (void);
+void msg_ui_reset_counts (void);
+bool msg_ui_any_errors (void);
+void msg_ui_disable_warnings (bool);
 
-void msg_assert_fail (const char *expr, const char *file, int line);
 
-#undef __STRING
-#define __STRING(x) #x
-#undef assert
-                              
-#define assert(expr) ( (void) ( expr ? (void) 0 : \
-              msg_assert_fail(__STRING(expr), __FILE__, __LINE__)) )
+/* Used in panic situations only. */
+void request_bug_report_and_abort (const char *msg) NO_RETURN;
+
 
 #endif /* message.h */