1 /* Language-independent diagnostic subroutines for the GNU Compiler Collection
2 Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005
3 Free Software Foundation, Inc.
4 Contributed by Gabriel Dos Reis <gdr@codesourcery.com>
6 This file is part of GCC.
8 GCC is free software; you can redistribute it and/or modify it under
9 the terms of the GNU General Public License as published by the Free
10 Software Foundation; either version 2, or (at your option) any later
13 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
14 WARRANTY; without even the implied warranty of MERCHANTABILITY or
15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
18 You should have received a copy of the GNU General Public License
19 along with GCC; see the file COPYING. If not, write to the Free
20 Software Foundation, 59 Temple Place - Suite 330, Boston, MA
24 /* This file implements the language independent aspect of diagnostic
28 #undef FLOAT /* This is for hpux. They should change hpux. */
29 #undef FFS /* Some systems define this in param.h. */
31 #include "coretypes.h"
40 #include "diagnostic.h"
41 #include "langhooks.h"
42 #include "langhooks-def.h"
46 static char *build_message_string (const char *, ...) ATTRIBUTE_PRINTF_1
;
48 static void default_diagnostic_starter (diagnostic_context
*,
50 static void default_diagnostic_finalizer (diagnostic_context
*,
53 static void error_recursion (diagnostic_context
*) ATTRIBUTE_NORETURN
;
54 static bool diagnostic_count_diagnostic (diagnostic_context
*,
56 static void diagnostic_action_after_output (diagnostic_context
*,
58 static void real_abort (void) ATTRIBUTE_NORETURN
;
60 /* A diagnostic_context surrogate for stderr. */
61 static diagnostic_context global_diagnostic_context
;
62 diagnostic_context
*global_dc
= &global_diagnostic_context
;
64 /* Return a malloc'd string containing MSG formatted a la printf. The
65 caller is responsible for freeing the memory. */
67 build_message_string (const char *msg
, ...)
73 vasprintf (&str
, msg
, ap
);
79 /* Same as diagnostic_build_prefix, but only the source FILE is given. */
81 file_name_as_prefix (const char *f
)
83 return build_message_string ("%s: ", f
);
88 /* Initialize the diagnostic message outputting machinery. */
90 diagnostic_initialize (diagnostic_context
*context
)
92 /* Allocate a basic pretty-printer. Clients will replace this a
93 much more elaborated pretty-printer if they wish. */
94 context
->printer
= xmalloc (sizeof (pretty_printer
));
95 pp_construct (context
->printer
, NULL
, 0);
96 /* By default, diagnostics are sent to stderr. */
97 context
->printer
->buffer
->stream
= stderr
;
98 /* By default, we emit prefixes once per message. */
99 context
->printer
->prefixing_rule
= DIAGNOSTICS_SHOW_PREFIX_ONCE
;
101 memset (context
->diagnostic_count
, 0, sizeof context
->diagnostic_count
);
102 context
->issue_warnings_are_errors_message
= true;
103 context
->warning_as_error_requested
= false;
104 context
->abort_on_error
= false;
105 context
->internal_error
= NULL
;
106 diagnostic_starter (context
) = default_diagnostic_starter
;
107 diagnostic_finalizer (context
) = default_diagnostic_finalizer
;
108 context
->last_module
= 0;
109 context
->last_function
= NULL
;
114 diagnostic_set_info (diagnostic_info
*diagnostic
, const char *msgid
,
115 va_list *args
, location_t location
,
118 diagnostic
->message
.err_no
= errno
;
119 diagnostic
->message
.args_ptr
= args
;
120 diagnostic
->message
.format_spec
= _(msgid
);
121 diagnostic
->location
= location
;
122 diagnostic
->kind
= kind
;
125 /* Return a malloc'd string describing a location. The caller is
126 responsible for freeing the memory. */
128 diagnostic_build_prefix (diagnostic_info
*diagnostic
)
130 static const char *const diagnostic_kind_text
[] = {
131 #define DEFINE_DIAGNOSTIC_KIND(K, T) (T),
132 #include "diagnostic.def"
133 #undef DEFINE_DIAGNOSTIC_KIND
136 const char *text
= _(diagnostic_kind_text
[diagnostic
->kind
]);
137 expanded_location s
= expand_location (diagnostic
->location
);
138 gcc_assert (diagnostic
->kind
< DK_LAST_DIAGNOSTIC_KIND
);
142 ? build_message_string ("%s: %s", progname
, text
)
143 #ifdef USE_MAPPED_LOCATION
144 : flag_show_column
&& s
.column
!= 0
145 ? build_message_string ("%s:%d:%d: %s", s
.file
, s
.line
, s
.column
, text
)
147 : build_message_string ("%s:%d: %s", s
.file
, s
.line
, text
));
150 /* Count a diagnostic. Return true if the message should be printed. */
152 diagnostic_count_diagnostic (diagnostic_context
*context
,
153 diagnostic_info
*diagnostic
)
155 diagnostic_t kind
= diagnostic
->kind
;
162 #ifndef ENABLE_CHECKING
163 /* When not checking, ICEs are converted to fatal errors when an
164 error has already occurred. This is counteracted by
166 if ((diagnostic_kind_count (context
, DK_ERROR
) > 0
167 || diagnostic_kind_count (context
, DK_SORRY
) > 0)
168 && !context
->abort_on_error
)
170 expanded_location s
= expand_location (diagnostic
->location
);
171 fnotice (stderr
, "%s:%d: confused by earlier errors, bailing out\n",
173 exit (FATAL_EXIT_CODE
);
176 if (context
->internal_error
)
177 (*context
->internal_error
) (diagnostic
->message
.format_spec
,
178 diagnostic
->message
.args_ptr
);
181 case DK_FATAL
: case DK_SORRY
:
182 case DK_ANACHRONISM
: case DK_NOTE
:
183 ++diagnostic_kind_count (context
, kind
);
187 if (!diagnostic_report_warnings_p ())
190 if (!context
->warning_as_error_requested
)
192 ++diagnostic_kind_count (context
, DK_WARNING
);
195 else if (context
->issue_warnings_are_errors_message
)
197 pp_verbatim (context
->printer
,
198 "%s: warnings being treated as errors\n", progname
);
199 context
->issue_warnings_are_errors_message
= false;
202 /* And fall through. */
204 ++diagnostic_kind_count (context
, DK_ERROR
);
211 /* Take any action which is expected to happen after the diagnostic
212 is written out. This function does not always return. */
214 diagnostic_action_after_output (diagnostic_context
*context
,
215 diagnostic_info
*diagnostic
)
217 switch (diagnostic
->kind
)
227 if (context
->abort_on_error
)
229 if (flag_fatal_errors
)
231 fnotice (stderr
, "compilation terminated due to -Wfatal-errors.\n");
232 exit (FATAL_EXIT_CODE
);
237 if (context
->abort_on_error
)
240 fnotice (stderr
, "Please submit a full bug report,\n"
241 "with preprocessed source if appropriate.\n"
242 "See %s for instructions.\n", bug_report_url
);
243 exit (FATAL_EXIT_CODE
);
246 if (context
->abort_on_error
)
249 fnotice (stderr
, "compilation terminated.\n");
250 exit (FATAL_EXIT_CODE
);
257 /* Prints out, if necessary, the name of the current function
258 that caused an error. Called from all error and warning functions. */
260 diagnostic_report_current_function (diagnostic_context
*context
)
262 diagnostic_report_current_module (context
);
263 lang_hooks
.print_error_function (context
, input_filename
);
267 diagnostic_report_current_module (diagnostic_context
*context
)
269 struct file_stack
*p
;
271 if (pp_needs_newline (context
->printer
))
273 pp_newline (context
->printer
);
274 pp_needs_newline (context
->printer
) = false;
277 p
= input_file_stack
;
278 if (p
&& diagnostic_last_module_changed (context
))
280 expanded_location xloc
= expand_location (p
->location
);
281 pp_verbatim (context
->printer
,
282 "In file included from %s:%d",
283 xloc
.file
, xloc
.line
);
284 while ((p
= p
->next
) != NULL
)
286 xloc
= expand_location (p
->location
);
287 pp_verbatim (context
->printer
,
289 xloc
.file
, xloc
.line
);
291 pp_verbatim (context
->printer
, ":\n");
292 diagnostic_set_last_module (context
);
297 default_diagnostic_starter (diagnostic_context
*context
,
298 diagnostic_info
*diagnostic
)
300 diagnostic_report_current_function (context
);
301 pp_set_prefix (context
->printer
, diagnostic_build_prefix (diagnostic
));
305 default_diagnostic_finalizer (diagnostic_context
*context
,
306 diagnostic_info
*diagnostic ATTRIBUTE_UNUSED
)
308 pp_destroy_prefix (context
->printer
);
311 /* Report a diagnostic message (an error or a warning) as specified by
312 DC. This function is *the* subroutine in terms of which front-ends
313 should implement their specific diagnostic handling modules. The
314 front-end independent format specifiers are exactly those described
315 in the documentation of output_format. */
318 diagnostic_report_diagnostic (diagnostic_context
*context
,
319 diagnostic_info
*diagnostic
)
321 if (context
->lock
> 0)
323 /* If we're reporting an ICE in the middle of some other error,
324 try to flush out the previous error, then let this one
325 through. Don't do this more than once. */
326 if (diagnostic
->kind
== DK_ICE
&& context
->lock
== 1)
327 pp_flush (context
->printer
);
329 error_recursion (context
);
334 if (diagnostic_count_diagnostic (context
, diagnostic
))
336 pp_prepare_to_format (context
->printer
, &diagnostic
->message
,
337 &diagnostic
->location
);
338 (*diagnostic_starter (context
)) (context
, diagnostic
);
339 pp_format_text (context
->printer
, &diagnostic
->message
);
340 (*diagnostic_finalizer (context
)) (context
, diagnostic
);
341 pp_flush (context
->printer
);
342 diagnostic_action_after_output (context
, diagnostic
);
348 /* Given a partial pathname as input, return another pathname that
349 shares no directory elements with the pathname of __FILE__. This
350 is used by fancy_abort() to print `Internal compiler error in expr.c'
351 instead of `Internal compiler error in ../../GCC/gcc/expr.c'. */
354 trim_filename (const char *name
)
356 static const char this_file
[] = __FILE__
;
357 const char *p
= name
, *q
= this_file
;
359 /* First skip any "../" in each filename. This allows us to give a proper
360 reference to a file in a subdirectory. */
361 while (p
[0] == '.' && p
[1] == '.' && IS_DIR_SEPARATOR (p
[2]))
364 while (q
[0] == '.' && q
[1] == '.' && IS_DIR_SEPARATOR (q
[2]))
367 /* Now skip any parts the two filenames have in common. */
368 while (*p
== *q
&& *p
!= 0 && *q
!= 0)
371 /* Now go backwards until the previous directory separator. */
372 while (p
> name
&& !IS_DIR_SEPARATOR (p
[-1]))
378 /* Standard error reporting routines in increasing order of severity.
379 All of these take arguments like printf. */
381 /* Text to be emitted verbatim to the error message stream; this
382 produces no prefix and disables line-wrapping. Use rarely. */
384 verbatim (const char *msgid
, ...)
389 va_start (ap
, msgid
);
392 text
.format_spec
= _(msgid
);
393 pp_format_verbatim (global_dc
->printer
, &text
);
394 pp_flush (global_dc
->printer
);
398 /* An informative note. Use this for additional details on an error
401 inform (const char *msgid
, ...)
403 diagnostic_info diagnostic
;
406 va_start (ap
, msgid
);
407 diagnostic_set_info (&diagnostic
, msgid
, &ap
, input_location
, DK_NOTE
);
408 report_diagnostic (&diagnostic
);
412 /* A warning. Use this for code which is correct according to the
413 relevant language specification but is likely to be buggy anyway. */
415 warning (int opt ATTRIBUTE_UNUSED
, const char *msgid
, ...)
417 diagnostic_info diagnostic
;
420 va_start (ap
, msgid
);
421 diagnostic_set_info (&diagnostic
, msgid
, &ap
, input_location
, DK_WARNING
);
422 report_diagnostic (&diagnostic
);
427 warning0 (const char *msgid
, ...)
429 diagnostic_info diagnostic
;
432 va_start (ap
, msgid
);
433 diagnostic_set_info (&diagnostic
, msgid
, &ap
, input_location
, DK_WARNING
);
434 report_diagnostic (&diagnostic
);
438 /* A "pedantic" warning: issues a warning unless -pedantic-errors was
439 given on the command line, in which case it issues an error. Use
440 this for diagnostics required by the relevant language standard,
441 if you have chosen not to make them errors.
443 Note that these diagnostics are issued independent of the setting
444 of the -pedantic command-line switch. To get a warning enabled
445 only with that switch, write "if (pedantic) pedwarn (...);" */
447 pedwarn (const char *msgid
, ...)
449 diagnostic_info diagnostic
;
452 va_start (ap
, msgid
);
453 diagnostic_set_info (&diagnostic
, msgid
, &ap
, input_location
,
454 pedantic_error_kind ());
455 report_diagnostic (&diagnostic
);
459 /* A hard error: the code is definitely ill-formed, and an object file
460 will not be produced. */
462 error (const char *msgid
, ...)
464 diagnostic_info diagnostic
;
467 va_start (ap
, msgid
);
468 diagnostic_set_info (&diagnostic
, msgid
, &ap
, input_location
, DK_ERROR
);
469 report_diagnostic (&diagnostic
);
473 /* "Sorry, not implemented." Use for a language feature which is
474 required by the relevant specification but not implemented by GCC.
475 An object file will not be produced. */
477 sorry (const char *msgid
, ...)
479 diagnostic_info diagnostic
;
482 va_start (ap
, msgid
);
483 diagnostic_set_info (&diagnostic
, msgid
, &ap
, input_location
, DK_SORRY
);
484 report_diagnostic (&diagnostic
);
488 /* An error which is severe enough that we make no attempt to
489 continue. Do not use this for internal consistency checks; that's
490 internal_error. Use of this function should be rare. */
492 fatal_error (const char *msgid
, ...)
494 diagnostic_info diagnostic
;
497 va_start (ap
, msgid
);
498 diagnostic_set_info (&diagnostic
, msgid
, &ap
, input_location
, DK_FATAL
);
499 report_diagnostic (&diagnostic
);
505 /* An internal consistency check has failed. We make no attempt to
506 continue. Note that unless there is debugging value to be had from
507 a more specific message, or some other good reason, you should use
508 abort () instead of calling this function directly. */
510 internal_error (const char *msgid
, ...)
512 diagnostic_info diagnostic
;
515 va_start (ap
, msgid
);
516 diagnostic_set_info (&diagnostic
, msgid
, &ap
, input_location
, DK_ICE
);
517 report_diagnostic (&diagnostic
);
523 /* Special case error functions. Most are implemented in terms of the
524 above, or should be. */
526 /* Print a diagnostic MSGID on FILE. This is just fprintf, except it
527 runs its second argument through gettext. */
529 fnotice (FILE *file
, const char *msgid
, ...)
533 va_start (ap
, msgid
);
534 vfprintf (file
, _(msgid
), ap
);
538 /* Inform the user that an error occurred while trying to report some
539 other error. This indicates catastrophic internal inconsistencies,
540 so give up now. But do try to flush out the previous error.
541 This mustn't use internal_error, that will cause infinite recursion. */
544 error_recursion (diagnostic_context
*context
)
546 diagnostic_info diagnostic
;
548 if (context
->lock
< 3)
549 pp_flush (context
->printer
);
552 "Internal compiler error: Error reporting routines re-entered.\n");
554 /* Call diagnostic_action_after_output to get the "please submit a bug
555 report" message. It only looks at the kind field of diagnostic_info. */
556 diagnostic
.kind
= DK_ICE
;
557 diagnostic_action_after_output (context
, &diagnostic
);
559 /* Do not use gcc_unreachable here; that goes through internal_error
560 and therefore would cause infinite recursion. */
564 /* Report an internal compiler error in a friendly manner. This is
565 the function that gets called upon use of abort() in the source
566 code generally, thanks to a special macro. */
569 fancy_abort (const char *file
, int line
, const char *function
)
571 internal_error ("in %s, at %s:%d", function
, trim_filename (file
), line
);
574 /* Really call the system 'abort'. This has to go right at the end of
575 this file, so that there are no functions after it that call abort
576 and get the system abort instead of our macro. */