gcc/diagnostic.h

   1 /* Various declarations for language-independent diagnostics subroutines.
   2    Copyright (C) 2000, 2001 Free Software Foundation, Inc.
   3    Contributed by Gabriel Dos Reis <gdr@codesourcery.com>
   4
   5 This file is part of GNU CC.
   6
   7 GNU CC is free software; you can redistribute it and/or modify
   8 it under the terms of the GNU General Public License as published by
   9 the Free Software Foundation; either version 2, or (at your option)
  10 any later version.
  11
  12 GNU CC is distributed in the hope that it will be useful,
  13 but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 GNU General Public License for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with GNU CC; see the file COPYING.  If not, write to
  19 the Free Software Foundation, 59 Temple Place - Suite 330,
  20 Boston, MA 02111-1307, USA.  */
  21
  22 #ifndef GCC_DIAGNOSTIC_H
  23 #define GCC_DIAGNOSTIC_H
  24
  25 #include "obstack.h"
  26
  27 /*  Forward declarations.  */
  28 typedef struct output_buffer output_buffer;
  29 typedef struct diagnostic_context diagnostic_context;
  30 typedef void (*diagnostic_starter_fn) PARAMS ((output_buffer *,
  31                                                diagnostic_context *));
  32 typedef diagnostic_starter_fn diagnostic_finalizer_fn;
  33
  34 typedef enum
  35 {
  36 #define DEFINE_DIAGNOSTIC_KIND(K, M) K,
  37 #include "diagnostic.def"
  38 #undef DEFINE_DIAGNOSTIC_KIND
  39   DK_LAST_DIAGNOSTIC_KIND
  40 } diagnostic_t;
  41
  42 #define pedantic_error_kind() (flag_pedantic_errors ? DK_ERROR : DK_WARNING)
  43
  44 /* How often diagnostics are prefixed by their locations:
  45    o DIAGNOSTICS_SHOW_PREFIX_NEVER: never - not yet supported;
  46    o DIAGNOSTICS_SHOW_PREFIX_ONCE: emit only once;
  47    o DIAGNOSTICS_SHOW_PREFIX_EVERY_LINE: emit each time a physical
  48    line is started.  */
  49 typedef enum
  50 {
  51   DIAGNOSTICS_SHOW_PREFIX_ONCE       = 0x0,
  52   DIAGNOSTICS_SHOW_PREFIX_NEVER      = 0x1,
  53   DIAGNOSTICS_SHOW_PREFIX_EVERY_LINE = 0x2
  54 } diagnostic_prefixing_rule_t;
  55
  56 /* The type of front-end specific hook that formats trees into an
  57    output_buffer.  A language specific printer returns a truth value if
  58    everything goes well. */
  59 typedef int (*printer_fn) PARAMS ((output_buffer *));
  60
  61 /* This data structure encapsulates an output_buffer's state.  */
  62 typedef struct
  63 {
  64   /* The prefix for each new line.   */
  65   const char *prefix;
  66
  67   /* The real upper bound of number of characters per line, taking into
  68      account the case of a very very looong prefix.  */
  69   int maximum_length;
  70
  71   /* The ideal upper bound of number of characters per line, as suggested
  72      by front-end. */
  73   int ideal_maximum_length;
  74
  75   /* Indentation count.  */
  76   int indent_skip;
  77
  78   /* Nonzero if current PREFIX was emitted at least once.  */
  79   int emitted_prefix_p;
  80
  81   /* Nonzero means one should emit a newline before outputing anything.  */
  82   int need_newline_p;
  83
  84   /* Current prefixing rule.  */
  85   diagnostic_prefixing_rule_t prefixing_rule;
  86
  87   /* The current char to output.  Updated by front-end (*format_map) when
  88      it is called to report front-end printer for a specified format.  */
  89   const char *cursor;
  90
  91   /* A pointer to the variable argument-list for formatting.  */
  92   va_list *format_args;
  93
  94   /* The number of times we have issued diagnostics.  */
  95   int diagnostic_count[DK_LAST_DIAGNOSTIC_KIND];
  96 } output_state;
  97
  98 /* The output buffer datatype.  This is best seen as an abstract datatype.  */
  99 struct output_buffer
 100 {
 101   /* Internal data.  These fields should not be accessed directly by
 102      front-ends.  */
 103
 104   /* The current state of the buffer.  */
 105   output_state state;
 106
 107   /* Where to output formatted text.  */
 108   FILE* stream;
 109
 110   /* The obstack where the text is built up.  */
 111   struct obstack obstack;
 112
 113   /* The amount of characters output so far.  */
 114   int line_length;
 115
 116   /* This must be large enough to hold any printed integer or
 117      floating-point value.  */
 118   char digit_buffer[128];
 119
 120 /* If non-NULL, this function formats data in the BUFFER. When called,
 121    output_buffer_text_cursor (BUFFER) points to a format code.
 122    FORMAT_DECODER should call output_add_string (and related functions)
 123    to add data to the BUFFER.  FORMAT_DECODER can read arguments from
 124    output_buffer_format_args (BUFFER) using VA_ARG.  If the BUFFER needs
 125    additional characters from the format string, it should advance
 126    the output_buffer_text_cursor (BUFFER) as it goes.  When FORMAT_DECODER
 127    returns, output_buffer_text_cursor (BUFFER) should point to the last
 128    character processed.  */
 129
 130   printer_fn format_decoder;
 131 };
 132
 133 #define output_buffer_state(BUFFER) (BUFFER)->state
 134 #define output_buffer_attached_stream(BUFFER) (BUFFER)->stream
 135 #define output_buffer_text_cursor(BUFFER) (BUFFER)->state.cursor
 136 #define output_buffer_format_args(BUFFER) *((BUFFER)->state.format_args)
 137 #define output_needs_newline(BUFFER) (BUFFER)->state.need_newline_p
 138 #define output_buffer_state(BUFFER) (BUFFER)->state
 139 #define output_indentation(BUFFER) (BUFFER)->state.indent_skip
 140 #define output_message_text(BUFFER) \
 141    ((const char *) obstack_base (&(BUFFER)->obstack))
 142
 143 /* This data structure bundles altogether any information relevant to
 144    the context of a diagnostic message.  */
 145 struct diagnostic_context
 146 {
 147   /* Where most of the diagnostic formatting work is done.  In Object
 148      Oriented terms, we'll say that diagnostic_context is a sub-class of
 149      output_buffer.  */
 150   output_buffer buffer;
 151
 152   /* The diagnostic message to output.  */
 153   const char *message;
 154
 155   /* A pointer to a variable list of the arguments necessary for the
 156      purpose of message formatting.  */
 157   va_list *args_ptr;
 158
 159   /* The name of the source file involved in the diiagnostic.  */
 160   const char *file;
 161
 162   /* The line-location in the source file.  */
 163   int line;
 164
 165   /* Is this message a warning?  */
 166   int warn;
 167
 168   /* This function is called before any message is printed out.  It is
 169      responsible for preparing message prefix and such.  For example, it
 170      might say:
 171      In file included from "/usr/local/include/curses.h:5:
 172                       from "/home/gdr/src/nifty_printer.h:56:
 173                       ...
 174   */
 175   void (*begin_diagnostic) PARAMS ((output_buffer *, diagnostic_context *));
 176
 177   /* This function is called after the diagnostic message is printed.   */
 178   void (*end_diagnostic) PARAMS ((output_buffer *, diagnostic_context *));
 179
 180   /* Hook for front-end extensions.  */
 181   void *x_data;
 182 };
 183
 184 #define diagnostic_message(DC) (DC)->message
 185 #define diagnostic_argument_list(DC) (DC)->args_ptr
 186 #define diagnostic_file_location(DC) (DC)->file
 187 #define diagnostic_line_location(DC) (DC)->line
 188 #define diagnostic_is_warning(DC) (DC)->warn
 189 #define diagnostic_starter(DC) (DC)->begin_diagnostic
 190 #define diagnostic_finalizer(DC) (DC)->end_diagnostic
 191 #define diagnostic_auxiliary_data(DC) (DC)->x_data
 192 #define diagnostic_format_decoder(DC) (DC)->buffer.format_decoder
 193 #define diagnostic_prefixing_rule(DC) (DC)->buffer.state.prefixing_rule
 194
 195 /* Maximum characters per line in automatic line wrapping mode.
 196    Zero means don't wrap lines. */
 197 #define diagnostic_line_cutoff(DC) (DC)->buffer.state.ideal_maximum_length
 198
 199 /* This output buffer is used by front-ends that directly output
 200    diagnostic messages without going through `error', `warning',
 201    and similar functions.  In general, such usage should be
 202    avoided.  This global buffer will go away, once all such usage
 203    has been removed.  */
 204 extern output_buffer *diagnostic_buffer;
 205 extern diagnostic_context *global_dc;
 206
 207 #define diagnostic_kind_count(BUFFER, DK) \
 208    (BUFFER)->state.diagnostic_count[(int) DK]
 209
 210 /* The number of errors that have been issued so far.  Ideally, these
 211    would take an output_buffer as an argument.  */
 212 #define errorcount diagnostic_kind_count (diagnostic_buffer, DK_ERROR)
 213 /* Similarly, but for warnings.  */
 214 #define warningcount diagnostic_kind_count (diagnostic_buffer, DK_WARNING)
 215 /* Similarly, but for sorrys.  */
 216 #define sorrycount diagnostic_kind_count (diagnostic_buffer, DK_SORRY)
 217
 218 /* Returns non-zero if warnings should be emitted.  */
 219 #define diagnostic_report_warnings_p()                  \
 220   (!inhibit_warnings                                    \
 221    && !(in_system_header && !warn_system_headers))
 222
 223
 224 /* Prototypes */
 225 extern void set_diagnostic_context      PARAMS ((diagnostic_context *,
 226                                                  const char *, va_list *,
 227                                                  const char *, int, int));
 228 extern void set_internal_error_function PARAMS ((void (*)
 229                                                  PARAMS ((const char *,
 230                                                           va_list *))));
 231 extern void report_diagnostic           PARAMS ((diagnostic_context *));
 232 extern void diagnostic_initialize       PARAMS ((diagnostic_context *));
 233 extern void init_output_buffer          PARAMS ((output_buffer *,
 234                                                  const char *, int));
 235 extern void flush_diagnostic_buffer     PARAMS ((void));
 236 extern void output_clear                PARAMS ((output_buffer *));
 237 extern const char *output_get_prefix    PARAMS ((const output_buffer *));
 238 extern const char *output_last_position PARAMS ((const output_buffer *));
 239 extern void output_set_prefix           PARAMS ((output_buffer *,
 240                                                  const char *));
 241 extern void output_destroy_prefix       PARAMS ((output_buffer *));
 242 extern void output_set_maximum_length   PARAMS ((output_buffer *, int));
 243 extern void output_emit_prefix          PARAMS ((output_buffer *));
 244 extern void output_add_newline          PARAMS ((output_buffer *));
 245 extern void output_add_space            PARAMS ((output_buffer *));
 246 extern int output_space_left            PARAMS ((const output_buffer *));
 247 extern void output_append               PARAMS ((output_buffer *, const char *,
 248                                                  const char *));
 249 extern void output_add_character        PARAMS ((output_buffer *, int));
 250 extern void output_decimal              PARAMS ((output_buffer *, int));
 251 extern void output_add_string           PARAMS ((output_buffer *,
 252                                                  const char *));
 253 extern const char *output_finalize_message PARAMS ((output_buffer *));
 254 extern void output_clear_message_text   PARAMS ((output_buffer *));
 255 extern void output_printf               PARAMS ((output_buffer *, const char *,
 256                                                  ...)) ATTRIBUTE_PRINTF_2;
 257 extern int output_is_line_wrapping      PARAMS ((output_buffer *));
 258 extern void output_verbatim             PARAMS ((output_buffer *, const char *,
 259                                                  ...)) ATTRIBUTE_PRINTF_2;
 260 extern void verbatim                    PARAMS ((const char *, ...))
 261      ATTRIBUTE_PRINTF_1;
 262 extern char *context_as_prefix          PARAMS ((const char *, int, int));
 263 extern char *file_name_as_prefix        PARAMS ((const char *));
 264 extern int error_module_changed         PARAMS ((void));
 265 extern void record_last_error_module    PARAMS ((void));
 266 extern int error_function_changed       PARAMS ((void));
 267 extern void record_last_error_function  PARAMS ((void));
 268 extern void report_problematic_module   PARAMS ((output_buffer *));
 269
 270 #endif /* ! GCC_DIAGNOSTIC_H */