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 #define DIAGNOSTICS_SHOW_PREFIX_ONCE       0x0
  45 #define DIAGNOSTICS_SHOW_PREFIX_NEVER      0x1
  46 #define DIAGNOSTICS_SHOW_PREFIX_EVERY_LINE 0x2
  47
  48 /* The type of front-end specific hook that formats trees into an
  49    output_buffer.  A language specific printer returns a truth value if
  50    everything goes well. */
  51 typedef int (*printer_fn) PARAMS ((output_buffer *));
  52
  53 /* This data structure encapsulates an output_buffer's state.  */
  54 typedef struct
  55 {
  56   /* The prefix for each new line.   */
  57   const char *prefix;
  58
  59   /* The real upper bound of number of characters per line, taking into
  60      account the case of a very very looong prefix.  */
  61   int maximum_length;
  62
  63   /* The ideal upper bound of number of characters per line, as suggested
  64      by front-end. */
  65   int ideal_maximum_length;
  66
  67   /* Indentation count.  */
  68   int indent_skip;
  69
  70   /* Nonzero if current PREFIX was emitted at least once.  */
  71   int emitted_prefix_p;
  72
  73   /* Nonzero means one should emit a newline before outputing anything.  */
  74   int need_newline_p;
  75
  76   /* Tells how often current PREFIX should be emitted:
  77      o DIAGNOSTICS_SHOW_PREFIX_NEVER: never - not yet supported;
  78      o DIAGNOSTICS_SHOW_PREFIX_ONCE: emit current PREFIX only once;
  79      o DIAGNOSTICS_SHOW_PREFIX_EVERY_LINE: emit current PREFIX each time
  80        a physical line is started.  */
  81   int prefixing_rule;
  82
  83   /* The current char to output.  Updated by front-end (*format_map) when
  84      it is called to report front-end printer for a specified format.  */
  85   const char *cursor;
  86
  87   /* A pointer to the variable argument-list for formatting.  */
  88   va_list *format_args;
  89
  90   /* The number of times we have issued diagnostics.  */
  91   int diagnostic_count[DK_LAST_DIAGNOSTIC_KIND];
  92 } output_state;
  93
  94 /* The output buffer datatype.  This is best seen as an abstract datatype.  */
  95 struct output_buffer
  96 {
  97   /* Internal data.  These fields should not be accessed directly by
  98      front-ends.  */
  99
 100   /* The current state of the buffer.  */
 101   output_state state;
 102
 103   /* Where to output formatted text.  */
 104   FILE* stream;
 105
 106   /* The obstack where the text is built up.  */
 107   struct obstack obstack;
 108
 109   /* The amount of characters output so far.  */
 110   int line_length;
 111 };
 112
 113 #define output_buffer_state(BUFFER) (BUFFER)->state
 114 #define output_buffer_attached_stream(BUFFER) (BUFFER)->stream
 115 #define output_buffer_text_cursor(BUFFER) (BUFFER)->state.cursor
 116 #define output_buffer_format_args(BUFFER) *((BUFFER)->state.format_args)
 117 #define output_needs_newline(BUFFER) (BUFFER)->state.need_newline_p
 118 #define output_buffer_state(BUFFER) (BUFFER)->state
 119 #define output_indentation(BUFFER) (BUFFER)->state.indent_skip
 120 #define output_message_text(BUFFER) \
 121    ((const char *) obstack_base (&(BUFFER)->obstack))
 122
 123 /* This data structure bundles altogether any information relevant to
 124    the context of a diagnostic message.  */
 125 struct diagnostic_context
 126 {
 127   /* The diagnostic message to output.  */
 128   const char *message;
 129
 130   /* A pointer to a variable list of the arguments necessary for the
 131      purpose of message formatting.  */
 132   va_list *args_ptr;
 133
 134   /* The name of the source file involved in the diiagnostic.  */
 135   const char *file;
 136
 137   /* The line-location in the source file.  */
 138   int line;
 139
 140   /* Is this message a warning?  */
 141   int warn;
 142
 143   /* This function is called before any message is printed out.  It is
 144      responsible for preparing message prefix and such.  For example, it
 145      might say:
 146      In file included from "/usr/local/include/curses.h:5:
 147                       from "/home/gdr/src/nifty_printer.h:56:
 148                       ...
 149   */
 150   void (*begin_diagnostic) PARAMS ((output_buffer *, diagnostic_context *));
 151
 152   /* This function is called after the diagnostic message is printed.   */
 153   void (*end_diagnostic) PARAMS ((output_buffer *, diagnostic_context *));
 154
 155   /* Hook for front-end extensions.  */
 156   void *x_data;
 157 };
 158
 159 #define diagnostic_message(DC) (DC)->message
 160 #define diagnostic_argument_list(DC) (DC)->args_ptr
 161 #define diagnostic_file_location(DC) (DC)->file
 162 #define diagnostic_line_location(DC) (DC)->line
 163 #define diagnostic_is_warning(DC) (DC)->warn
 164 #define diagnostic_starter(DC) (DC)->begin_diagnostic
 165 #define diagnostic_finalizer(DC) (DC)->end_diagnostic
 166 #define diagnostic_auxiliary_data(DC) (DC)->x_data
 167
 168 /* If non-NULL, this function formats data in the BUFFER. When called,
 169    output_buffer_text_cursor (BUFFER) points to a format code.  LANG_PRINTER
 170    should call output_add_string (and related functions) to add data to
 171    the BUFFER.  LANG_PRINTER can read arguments from
 172    output_buffer_format_args (BUFFER) using VA_ARG.  If the BUFFER needs
 173    additional characters from the format string, it should advance
 174    the output_buffer_text_cursor (BUFFER) as it goes.  When LANG_PRINTER
 175    returns, output_buffer_text_cursor (BUFFER) should point to the last
 176    character processed.  */
 177
 178 extern printer_fn lang_printer;
 179
 180 extern diagnostic_starter_fn lang_diagnostic_starter;
 181 extern diagnostic_finalizer_fn lang_diagnostic_finalizer;
 182
 183 extern int diagnostic_message_length_per_line;
 184
 185 /* This output buffer is used by front-ends that directly output
 186    diagnostic messages without going through `error', `warning',
 187    and similar functions.  In general, such usage should be
 188    avoided.  This global buffer will go away, once all such usage
 189    has been removed.  */
 190 extern output_buffer *diagnostic_buffer;
 191
 192 #define diagnostic_kind_count(BUFFER, DK) \
 193    (BUFFER)->state.diagnostic_count[(int) DK]
 194
 195 /* The number of errors that have been issued so far.  Ideally, these
 196    would take an output_buffer as an argument.  */
 197 #define errorcount diagnostic_kind_count (diagnostic_buffer, DK_ERROR)
 198 /* Similarly, but for warnings.  */
 199 #define warningcount diagnostic_kind_count (diagnostic_buffer, DK_WARNING)
 200 /* Similarly, but for sorrys.  */
 201 #define sorrycount diagnostic_kind_count (diagnostic_buffer, DK_SORRY)
 202
 203 /* Returns non-zero if warnings should be emitted.  */
 204 #define diagnostic_report_warnings_p()                  \
 205   (!inhibit_warnings                                    \
 206    && !(in_system_header && !warn_system_headers))
 207
 208
 209 /* Prototypes */
 210 extern void set_diagnostic_context      PARAMS ((diagnostic_context *,
 211                                                  const char *, va_list *,
 212                                                  const char *, int, int));
 213 extern void set_internal_error_function PARAMS ((void (*)
 214                                                  PARAMS ((const char *,
 215                                                           va_list *))));
 216 extern void report_diagnostic           PARAMS ((diagnostic_context *));
 217 extern void initialize_diagnostics      PARAMS ((void));
 218 extern void reshape_diagnostic_buffer   PARAMS ((void));
 219 extern void default_initialize_buffer   PARAMS ((output_buffer *));
 220 extern void init_output_buffer          PARAMS ((output_buffer *,
 221                                                  const char *, int));
 222 extern void flush_diagnostic_buffer     PARAMS ((void));
 223 extern void output_clear                PARAMS ((output_buffer *));
 224 extern const char *output_get_prefix    PARAMS ((const output_buffer *));
 225 extern const char *output_last_position PARAMS ((const output_buffer *));
 226 extern void output_set_prefix           PARAMS ((output_buffer *,
 227                                                  const char *));
 228 extern void output_destroy_prefix       PARAMS ((output_buffer *));
 229 extern void output_set_maximum_length   PARAMS ((output_buffer *, int));
 230 extern void output_emit_prefix          PARAMS ((output_buffer *));
 231 extern void output_add_newline          PARAMS ((output_buffer *));
 232 extern void output_add_space            PARAMS ((output_buffer *));
 233 extern int output_space_left            PARAMS ((const output_buffer *));
 234 extern void output_append               PARAMS ((output_buffer *, const char *,
 235                                                  const char *));
 236 extern void output_add_character        PARAMS ((output_buffer *, int));
 237 extern void output_decimal              PARAMS ((output_buffer *, int));
 238 extern void output_add_string           PARAMS ((output_buffer *,
 239                                                  const char *));
 240 extern const char *output_finalize_message PARAMS ((output_buffer *));
 241 extern void output_clear_message_text   PARAMS ((output_buffer *));
 242 extern void output_printf               PARAMS ((output_buffer *, const char *,
 243                                                  ...)) ATTRIBUTE_PRINTF_2;
 244 extern int output_is_line_wrapping      PARAMS ((output_buffer *));
 245 extern void set_message_prefixing_rule  PARAMS ((int));
 246 extern void output_verbatim             PARAMS ((output_buffer *, const char *,
 247                                                  ...)) ATTRIBUTE_PRINTF_2;
 248 extern void verbatim                    PARAMS ((const char *, ...))
 249      ATTRIBUTE_PRINTF_1;
 250 extern char *context_as_prefix          PARAMS ((const char *, int, int));
 251 extern char *file_name_as_prefix        PARAMS ((const char *));
 252 extern int error_module_changed         PARAMS ((void));
 253 extern void record_last_error_module    PARAMS ((void));
 254 extern int error_function_changed       PARAMS ((void));
 255 extern void record_last_error_function  PARAMS ((void));
 256 extern void report_problematic_module   PARAMS ((output_buffer *));
 257
 258 #endif /* ! GCC_DIAGNOSTIC_H */