gcc/diagnostic.h

   1 /* Various declarations for language-independent diagnostics subroutines.
   2    Copyright (C) 2000 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
  30 #define DIAGNOSTICS_SHOW_PREFIX_ONCE       0x0
  31 #define DIAGNOSTICS_SHOW_PREFIX_NEVER      0x1
  32 #define DIAGNOSTICS_SHOW_PREFIX_EVERY_LINE 0x2
  33
  34 /* The type of front-end specific hook that formats trees into an
  35    output_buffer.  A language specific printer returns a truth value if
  36    everything goes well. */
  37 typedef int (*printer_fn) PARAMS ((output_buffer *));
  38
  39 /* The output buffer datatype.  This is best seen as an abstract datatype.  */
  40 struct output_buffer
  41 {
  42   /* Internal data.  These fields should not be accessed directly by
  43      front-ends.  */
  44
  45   /* The obstack where the text is built up.  */
  46   struct obstack obstack;
  47   /* The prefix for each new line.   */
  48   const char *prefix;
  49   /* The amount of characters output so far.  */
  50   int line_length;
  51   /* The real upper bound of number of characters per line, taking into
  52      accompt the case of a very very looong prefix.  */
  53   int maximum_length;
  54   /* The ideal upper bound of number of characters per line, as suggested
  55      by front-end. */
  56   int ideal_maximum_length;
  57   /* Nonzero if current PREFIX was emitted at least once.  */
  58   int emitted_prefix_p;
  59   /* Tells how often current PREFIX should be emitted:
  60      o DIAGNOSTICS_SHOW_PREFIX_NEVER: never - not yet supported;
  61      o DIAGNOSTICS_SHOW_PREFIX_ONCE: emit current PREFIX only once;
  62      o DIAGNOSTICS_SHOW_PREFIX_EVERY_LINE: emit current PREFIX each time
  63        a physical line is started.  */
  64   int prefixing_rule;
  65
  66   /* Public fields.  These are used by front-ends to extract formats and
  67      arguments from the variable argument-list passed to output_format.  */
  68
  69   /* The current char to output.  Updated by front-end (*format_map) when
  70      it is called to report front-end printer for a specified format.  */
  71   const char *cursor;
  72   /* Variable argument-list for formatting.  */
  73   va_list format_args;
  74 };
  75
  76 /* If non-NULL, this function formats data in the BUFFER.
  77    BUFFER->CURSOR points to a format code.  LANG_PRINTER should
  78    call output_add_string (and related functions) to add data to
  79    the BUFFER.  LANG_PRINTER can read arguments from
  80    BUFFER->FORMAT_ARGS using VA_ARG.  If the BUFFER needs
  81    additional characters from the format string, it should advance
  82    the BUFFER->CURSOR as it goes.  When LANG_PRINTER returns,
  83    BUFFER->CURSOR should point to the last character processed.  */
  84
  85 extern printer_fn lang_printer;
  86
  87 extern int diagnostic_message_length_per_line;
  88
  89 /* This output buffer is used by front-ends that directly output
  90    diagnostic messages without going through `error', `warning',
  91    and simillar functions.  In general, such usage should be
  92    avoided.  This global buffer will go away, once all such usage
  93    has been removed.  */
  94 extern output_buffer *diagnostic_buffer;
  95
  96 /* Prototypes */
  97 void report_diagnostic          PARAMS ((const char *, va_list,
  98                                          const char *, int, int));
  99 void initialize_diagnostics     PARAMS ((void));
 100 void reshape_diagnostic_buffer  PARAMS ((void));
 101 void default_initialize_buffer  PARAMS ((output_buffer *));
 102 void init_output_buffer         PARAMS ((output_buffer *, const char *, int));
 103 void output_clear               PARAMS ((output_buffer *));
 104 const char *output_get_prefix   PARAMS ((const output_buffer *));
 105 void output_set_prefix          PARAMS ((output_buffer *, const char *));
 106 void output_destroy_prefix      PARAMS ((output_buffer *));
 107 void output_set_maximum_length  PARAMS ((output_buffer *, int));
 108 void output_emit_prefix         PARAMS ((output_buffer *));
 109 void output_add_newline         PARAMS ((output_buffer *));
 110 void output_add_space           PARAMS ((output_buffer *));
 111 int output_space_left           PARAMS ((const output_buffer *));
 112 void output_append              PARAMS ((output_buffer *, const char *,
 113                                          const char *));
 114 void output_add_character       PARAMS ((output_buffer *, int));
 115 void output_decimal             PARAMS ((output_buffer *, int));
 116 void output_add_string          PARAMS ((output_buffer *, const char *));
 117 const char *output_finish       PARAMS ((output_buffer *));
 118 void output_printf              PARAMS ((output_buffer *, const char *,
 119                                          ...)) ATTRIBUTE_PRINTF_2;
 120 int output_is_line_wrapping     PARAMS ((output_buffer *));
 121 void set_message_prefixing_rule PARAMS ((int));
 122 void output_verbatim            PARAMS ((output_buffer *, const char *, ...))
 123      ATTRIBUTE_PRINTF_2;
 124 void verbatim PARAMS ((const char *, ...)) ATTRIBUTE_PRINTF_1;
 125
 126 #endif /* __GCC_DIAGNOSTIC_H__ */