better error messages are awesome!
[pspp] / src / libpspp / message.h
index 36aae9c5d13137d790493ae6ac102ec5cc3ba600..0c31b8e309c24ef0ebb039977a469bf3b99cfeec 100644 (file)
@@ -19,6 +19,7 @@
 
 #include <stdarg.h>
 #include <stdbool.h>
+#include <stddef.h>
 #include "libpspp/compiler.h"
 
 struct string;
@@ -71,27 +72,45 @@ msg_class_from_category_and_severity (enum msg_category category,
   return category * 3 + severity;
 }
 
+struct msg_point
+  {
+    int line;                   /* 1-based line number, or 0 if none. */
+    int column;                 /* 1-based column number, or 0 if none. */
+  };
+
 struct msg_location
   {
-    char *file_name;            /* Name of file containing error, or NULL. */
-    int first_line;             /* 1-based line number, or 0 if none. */
-    int last_line;              /* 1-based exclusive last line (0=none). */
-    int first_column;           /* 1-based first column, or 0 if none. */
-    int last_column;            /* 1-based exclusive last column (0=none). */
+    const char *file_name;      /* Interned file name, or NULL. */
+    struct lex_source *src;
+    struct msg_point p[2];
   };
 
+void msg_location_uninit (struct msg_location *);
 void msg_location_destroy (struct msg_location *);
 struct msg_location *msg_location_dup (const struct msg_location *);
 
+void msg_location_merge (struct msg_location **, const struct msg_location *);
+
 bool msg_location_is_empty (const struct msg_location *);
 void msg_location_format (const struct msg_location *, struct string *);
 
+struct msg_stack
+  {
+    struct msg_location *location;
+    char *description;
+  };
+
+void msg_stack_destroy (struct msg_stack *);
+struct msg_stack *msg_stack_dup (const struct msg_stack *);
+
 /* A message. */
 struct msg
   {
     enum msg_category category; /* Message category. */
     enum msg_severity severity; /* Message severity. */
     struct msg_location *location; /* Code location. */
+    struct msg_stack **stack;
+    size_t n_stack;
     char *command_name;         /* Name of erroneous command, or NULL.  */
     char *text;                 /* Error text. */
   };
@@ -106,10 +125,14 @@ void msg_destroy(struct msg *);
 char *msg_to_string (const struct msg *);
 
 /* Emitting messages. */
-void vmsg (enum msg_class class, const char *format, va_list args)
-     PRINTF_FORMAT (2, 0);
+void vmsg (enum msg_class, const struct msg_location *,
+           const char *format, va_list args)
+     PRINTF_FORMAT (3, 0);
 void msg (enum msg_class, const char *format, ...)
      PRINTF_FORMAT (2, 3);
+void msg_at (enum msg_class, const struct msg_location *,
+             const char *format, ...)
+     PRINTF_FORMAT (3, 4);
 void msg_emit (struct msg *);
 
 void msg_error (int errnum, const char *format, ...)