message: Intern file names in msg_location to make them cheaper to copy.
[pspp] / src / libpspp / message.h
index af7bc699d7afcc3d4e3e21122d580a38f7b0af62..a99b0818e3438fd6514be202a46c3d6e0f6f8185 100644 (file)
 
 #include <stdarg.h>
 #include <stdbool.h>
+#include <stddef.h>
 #include "libpspp/compiler.h"
 
+struct string;
+
 /* What kind of message is this? */
 enum msg_category
   {
@@ -69,17 +72,40 @@ msg_class_from_category_and_severity (enum msg_category category,
   return category * 3 + severity;
 }
 
+struct msg_location
+  {
+    const char *file_name;      /* Interned file name, 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). */
+  };
+
+void msg_location_uninit (struct msg_location *);
+void msg_location_destroy (struct msg_location *);
+struct msg_location *msg_location_dup (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. */
-    char *file_name;            /* Name of file containing error, or NULL. */
+    struct msg_location *location; /* Code location. */
+    struct msg_stack **stack;
+    size_t n_stack;
     char *command_name;         /* Name of erroneous command, 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). */
     char *text;                 /* Error text. */
   };