message: Add column range to struct msg_locator.
[pspp] / src / libpspp / message.h
index 3aca77891e9e0df2f25e96be3317cffd63ee82e8..7c1110175e052a4ad4ebf3de6475561647772c38 100644 (file)
@@ -1,5 +1,5 @@
 /* PSPP - a program for statistical analysis.
-   Copyright (C) 1997-9, 2000, 2006 Free Software Foundation, Inc.
+   Copyright (C) 1997-9, 2000, 2006, 2010 Free Software Foundation, Inc.
 
    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
 /* What kind of message is this? */
 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
   {
-    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. */
@@ -46,7 +48,6 @@ enum msg_class
     MSG_CLASS_CNT,
   };
 
-
 static inline enum msg_category
 msg_class_to_category (enum msg_class class)
 {
@@ -69,8 +70,10 @@ msg_class_from_category_and_severity (enum msg_category category,
 /* A file location.  */
 struct msg_locator
   {
-    char *file_name;           /* File name. */
-    int line_number;            /* Line number. */
+    char *file_name;           /* File name (NULL if none). */
+    int line_number;           /* Line number (0 if none). */
+    int first_column;          /* 1-based column number (0 if none). */
+    int last_column;           /* 1-based exclusive last column (0 if none). */
   };
 
 /* A message. */
@@ -89,8 +92,10 @@ void msg_init (struct source_stream *, void (*handler) (const struct msg *) );
 
 void msg_done (void);
 
-struct msg * msg_dup(const struct msg *m);
-void msg_destroy(struct msg *m);
+/* 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, ...)
@@ -102,13 +107,17 @@ void msg_enable (void);
 void msg_disable (void);
 
 /* Error context. */
-void msg_set_command_name (const char *);
-const char *msg_get_command_name (void);
 void msg_push_msg_locator (const struct msg_locator *);
 void msg_pop_msg_locator (const struct msg_locator *);
 
+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);
+
 
 /* Used in panic situations only. */
 void request_bug_report_and_abort (const char *msg) NO_RETURN;
 
+
 #endif /* message.h */