1 /* PSPP - a program for statistical analysis.
2 Copyright (C) 1997-9, 2000, 2006, 2010, 2011, 2014 Free Software Foundation, Inc.
4 This program is free software: you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation, either version 3 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program. If not, see <http://www.gnu.org/licenses/>. */
22 #include "libpspp/compiler.h"
26 /* What kind of message is this? */
29 MSG_C_GENERAL, /* General info. */
30 MSG_C_SYNTAX, /* Messages that relate to syntax files. */
31 MSG_C_DATA, /* Messages that relate to data files. */
35 /* How important a condition is it? */
44 const char *msg_severity_to_string (enum msg_severity);
46 /* Combination of a category and a severity for convenience. */
49 ME, MW, MN, /* General error/warning/note. */
50 SE, SW, SN, /* Script error/warning/note. */
51 DE, DW, DN, /* Data-file error/note. */
55 static inline enum msg_category
56 msg_class_to_category (enum msg_class class)
61 static inline enum msg_severity
62 msg_class_to_severity (enum msg_class class)
67 static inline enum msg_class
68 msg_class_from_category_and_severity (enum msg_category category,
69 enum msg_severity severity)
71 return category * 3 + severity;
76 char *file_name; /* Name of file containing error, or NULL. */
77 int first_line; /* 1-based line number, or 0 if none. */
78 int last_line; /* 1-based exclusive last line (0=none). */
79 int first_column; /* 1-based first column, or 0 if none. */
80 int last_column; /* 1-based exclusive last column (0=none). */
83 void msg_location_destroy (struct msg_location *);
84 struct msg_location *msg_location_dup (const struct msg_location *);
86 bool msg_location_is_empty (const struct msg_location *);
87 void msg_location_format (const struct msg_location *, struct string *);
92 enum msg_category category; /* Message category. */
93 enum msg_severity severity; /* Message severity. */
94 struct msg_location *location; /* Code location. */
95 char *command_name; /* Name of erroneous command, or NULL. */
96 char *text; /* Error text. */
100 void msg_set_handler (void (*handler) (const struct msg *, void *lexer),
103 /* Working with messages. */
104 struct msg *msg_dup (const struct msg *);
105 void msg_destroy(struct msg *);
106 char *msg_to_string (const struct msg *);
108 /* Emitting messages. */
109 void vmsg (enum msg_class class, const char *format, va_list args)
110 PRINTF_FORMAT (2, 0);
111 void msg (enum msg_class, const char *format, ...)
112 PRINTF_FORMAT (2, 3);
113 void msg_emit (struct msg *);
115 void msg_error (int errnum, const char *format, ...)
116 PRINTF_FORMAT (2, 3);
119 /* Enable and disable messages. */
120 void msg_enable (void);
121 void msg_disable (void);
124 bool msg_ui_too_many_errors (void);
125 void msg_ui_reset_counts (void);
126 bool msg_ui_any_errors (void);
127 void msg_ui_disable_warnings (bool);
130 /* Used in panic situations only. */
131 const char * prepare_diagnostic_information (void);
132 const char * prepare_fatal_error_message (void);
133 void request_bug_report (const char *msg);
136 #endif /* message.h */