1 /* Language-independent diagnostic subroutines for the GNU Compiler Collection
2 Copyright (C) 1999-2016 Free Software Foundation, Inc.
3 Contributed by Gabriel Dos Reis <gdr@codesourcery.com>
5 This file is part of GCC.
7 GCC is free software; you can redistribute it and/or modify it under
8 the terms of the GNU General Public License as published by the Free
9 Software Foundation; either version 3, or (at your option) any later
12 GCC is distributed in the hope that it will be useful, but WITHOUT ANY
13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
17 You should have received a copy of the GNU General Public License
18 along with GCC; see the file COPYING3. If not see
19 <http://www.gnu.org/licenses/>. */
22 /* This file implements the language independent aspect of diagnostic
27 #include "coretypes.h"
31 #include "backtrace.h"
32 #include "diagnostic.h"
33 #include "diagnostic-color.h"
39 #ifdef GWINSZ_IN_SYS_IOCTL
40 # include <sys/ioctl.h>
43 #include <new> // For placement new.
45 #define pedantic_warning_kind(DC) \
46 ((DC)->pedantic_errors ? DK_ERROR : DK_WARNING)
47 #define permissive_error_kind(DC) ((DC)->permissive ? DK_WARNING : DK_ERROR)
48 #define permissive_error_option(DC) ((DC)->opt_permissive)
51 static void error_recursion (diagnostic_context
*) ATTRIBUTE_NORETURN
;
53 static void real_abort (void) ATTRIBUTE_NORETURN
;
55 /* Name of program invoked, sans directories. */
59 /* A diagnostic_context surrogate for stderr. */
60 static diagnostic_context global_diagnostic_context
;
61 diagnostic_context
*global_dc
= &global_diagnostic_context
;
63 /* Return a malloc'd string containing MSG formatted a la printf. The
64 caller is responsible for freeing the memory. */
66 build_message_string (const char *msg
, ...)
72 str
= xvasprintf (msg
, ap
);
78 /* Same as diagnostic_build_prefix, but only the source FILE is given. */
80 file_name_as_prefix (diagnostic_context
*context
, const char *f
)
83 = colorize_start (pp_show_color (context
->printer
), "locus");
84 const char *locus_ce
= colorize_stop (pp_show_color (context
->printer
));
85 return build_message_string ("%s%s:%s ", locus_cs
, f
, locus_ce
);
90 /* Return the value of the getenv("COLUMNS") as an integer. If the
91 value is not set to a positive integer, use ioctl to get the
92 terminal width. If it fails, return INT_MAX. */
94 get_terminal_width (void)
96 const char * s
= getenv ("COLUMNS");
106 if (ioctl (0, TIOCGWINSZ
, &w
) == 0 && w
.ws_col
> 0)
113 /* Set caret_max_width to value. */
115 diagnostic_set_caret_max_width (diagnostic_context
*context
, int value
)
117 /* One minus to account for the leading empty space. */
118 value
= value
? value
- 1
119 : (isatty (fileno (pp_buffer (context
->printer
)->stream
))
120 ? get_terminal_width () - 1: INT_MAX
);
125 context
->caret_max_width
= value
;
128 /* Initialize the diagnostic message outputting machinery. */
130 diagnostic_initialize (diagnostic_context
*context
, int n_opts
)
134 /* Allocate a basic pretty-printer. Clients will replace this a
135 much more elaborated pretty-printer if they wish. */
136 context
->printer
= XNEW (pretty_printer
);
137 new (context
->printer
) pretty_printer ();
139 memset (context
->diagnostic_count
, 0, sizeof context
->diagnostic_count
);
140 context
->warning_as_error_requested
= false;
141 context
->n_opts
= n_opts
;
142 context
->classify_diagnostic
= XNEWVEC (diagnostic_t
, n_opts
);
143 for (i
= 0; i
< n_opts
; i
++)
144 context
->classify_diagnostic
[i
] = DK_UNSPECIFIED
;
145 context
->show_caret
= false;
146 diagnostic_set_caret_max_width (context
, pp_line_cutoff (context
->printer
));
147 for (i
= 0; i
< rich_location::MAX_RANGES
; i
++)
148 context
->caret_chars
[i
] = '^';
149 context
->show_option_requested
= false;
150 context
->abort_on_error
= false;
151 context
->show_column
= false;
152 context
->pedantic_errors
= false;
153 context
->permissive
= false;
154 context
->opt_permissive
= 0;
155 context
->fatal_errors
= false;
156 context
->dc_inhibit_warnings
= false;
157 context
->dc_warn_system_headers
= false;
158 context
->max_errors
= 0;
159 context
->internal_error
= NULL
;
160 diagnostic_starter (context
) = default_diagnostic_starter
;
161 diagnostic_finalizer (context
) = default_diagnostic_finalizer
;
162 context
->option_enabled
= NULL
;
163 context
->option_state
= NULL
;
164 context
->option_name
= NULL
;
165 context
->last_location
= UNKNOWN_LOCATION
;
166 context
->last_module
= 0;
167 context
->x_data
= NULL
;
169 context
->inhibit_notes_p
= false;
172 /* Maybe initialize the color support. We require clients to do this
173 explicitly, since most clients don't want color. When called
174 without a VALUE, it initializes with DIAGNOSTICS_COLOR_DEFAULT. */
177 diagnostic_color_init (diagnostic_context
*context
, int value
/*= -1 */)
179 /* value == -1 is the default value. */
182 /* If DIAGNOSTICS_COLOR_DEFAULT is -1, default to
183 -fdiagnostics-color=auto if GCC_COLORS is in the environment,
184 otherwise default to -fdiagnostics-color=never, for other
185 values default to that
186 -fdiagnostics-color={never,auto,always}. */
187 if (DIAGNOSTICS_COLOR_DEFAULT
== -1)
189 if (!getenv ("GCC_COLORS"))
191 value
= DIAGNOSTICS_COLOR_AUTO
;
194 value
= DIAGNOSTICS_COLOR_DEFAULT
;
196 pp_show_color (context
->printer
)
197 = colorize_init ((diagnostic_color_rule_t
) value
);
200 /* Do any cleaning up required after the last diagnostic is emitted. */
203 diagnostic_finish (diagnostic_context
*context
)
205 /* Some of the errors may actually have been warnings. */
206 if (diagnostic_kind_count (context
, DK_WERROR
))
208 /* -Werror was given. */
209 if (context
->warning_as_error_requested
)
210 pp_verbatim (context
->printer
,
211 _("%s: all warnings being treated as errors"),
213 /* At least one -Werror= was given. */
215 pp_verbatim (context
->printer
,
216 _("%s: some warnings being treated as errors"),
218 pp_newline_and_flush (context
->printer
);
221 diagnostic_file_cache_fini ();
223 XDELETEVEC (context
->classify_diagnostic
);
224 context
->classify_diagnostic
= NULL
;
226 /* diagnostic_initialize allocates context->printer using XNEW
227 and placement-new. */
228 context
->printer
->~pretty_printer ();
229 XDELETE (context
->printer
);
230 context
->printer
= NULL
;
233 /* Initialize DIAGNOSTIC, where the message MSG has already been
236 diagnostic_set_info_translated (diagnostic_info
*diagnostic
, const char *msg
,
237 va_list *args
, rich_location
*richloc
,
240 gcc_assert (richloc
);
241 diagnostic
->message
.err_no
= errno
;
242 diagnostic
->message
.args_ptr
= args
;
243 diagnostic
->message
.format_spec
= msg
;
244 diagnostic
->message
.m_richloc
= richloc
;
245 diagnostic
->richloc
= richloc
;
246 diagnostic
->kind
= kind
;
247 diagnostic
->option_index
= 0;
250 /* Initialize DIAGNOSTIC, where the message GMSGID has not yet been
253 diagnostic_set_info (diagnostic_info
*diagnostic
, const char *gmsgid
,
254 va_list *args
, rich_location
*richloc
,
257 gcc_assert (richloc
);
258 diagnostic_set_info_translated (diagnostic
, _(gmsgid
), args
, richloc
, kind
);
261 static const char *const diagnostic_kind_color
[] = {
262 #define DEFINE_DIAGNOSTIC_KIND(K, T, C) (C),
263 #include "diagnostic.def"
264 #undef DEFINE_DIAGNOSTIC_KIND
268 /* Get a color name for diagnostics of type KIND
269 Result could be NULL. */
272 diagnostic_get_color_for_kind (diagnostic_t kind
)
274 return diagnostic_kind_color
[kind
];
277 /* Return a malloc'd string describing a location. The caller is
278 responsible for freeing the memory. */
280 diagnostic_build_prefix (diagnostic_context
*context
,
281 const diagnostic_info
*diagnostic
)
283 static const char *const diagnostic_kind_text
[] = {
284 #define DEFINE_DIAGNOSTIC_KIND(K, T, C) (T),
285 #include "diagnostic.def"
286 #undef DEFINE_DIAGNOSTIC_KIND
289 gcc_assert (diagnostic
->kind
< DK_LAST_DIAGNOSTIC_KIND
);
291 const char *text
= _(diagnostic_kind_text
[diagnostic
->kind
]);
292 const char *text_cs
= "", *text_ce
= "";
293 const char *locus_cs
, *locus_ce
;
294 pretty_printer
*pp
= context
->printer
;
296 if (diagnostic_kind_color
[diagnostic
->kind
])
298 text_cs
= colorize_start (pp_show_color (pp
),
299 diagnostic_kind_color
[diagnostic
->kind
]);
300 text_ce
= colorize_stop (pp_show_color (pp
));
302 locus_cs
= colorize_start (pp_show_color (pp
), "locus");
303 locus_ce
= colorize_stop (pp_show_color (pp
));
305 expanded_location s
= diagnostic_expand_location (diagnostic
);
308 ? build_message_string ("%s%s:%s %s%s%s", locus_cs
, progname
, locus_ce
,
309 text_cs
, text
, text_ce
)
310 : !strcmp (s
.file
, N_("<built-in>"))
311 ? build_message_string ("%s%s:%s %s%s%s", locus_cs
, s
.file
, locus_ce
,
312 text_cs
, text
, text_ce
)
313 : context
->show_column
314 ? build_message_string ("%s%s:%d:%d:%s %s%s%s", locus_cs
, s
.file
, s
.line
,
315 s
.column
, locus_ce
, text_cs
, text
, text_ce
)
316 : build_message_string ("%s%s:%d:%s %s%s%s", locus_cs
, s
.file
, s
.line
,
317 locus_ce
, text_cs
, text
, text_ce
));
320 /* Functions at which to stop the backtrace print. It's not
321 particularly helpful to print the callers of these functions. */
323 static const char * const bt_stop
[] =
331 /* A callback function passed to the backtrace_full function. */
334 bt_callback (void *data
, uintptr_t pc
, const char *filename
, int lineno
,
335 const char *function
)
337 int *pcount
= (int *) data
;
339 /* If we don't have any useful information, don't print
341 if (filename
== NULL
&& function
== NULL
)
344 /* Skip functions in diagnostic.c. */
347 && strcmp (lbasename (filename
), "diagnostic.c") == 0)
350 /* Print up to 20 functions. We could make this a --param, but
351 since this is only for debugging just use a constant for now. */
354 /* Returning a non-zero value stops the backtrace. */
360 if (function
!= NULL
)
362 char *str
= cplus_demangle_v3 (function
,
363 (DMGL_VERBOSE
| DMGL_ANSI
364 | DMGL_GNU_V3
| DMGL_PARAMS
));
371 for (size_t i
= 0; i
< ARRAY_SIZE (bt_stop
); ++i
)
373 size_t len
= strlen (bt_stop
[i
]);
374 if (strncmp (function
, bt_stop
[i
], len
) == 0
375 && (function
[len
] == '\0' || function
[len
] == '('))
379 /* Returning a non-zero value stops the backtrace. */
385 fprintf (stderr
, "0x%lx %s\n\t%s:%d\n",
387 function
== NULL
? "???" : function
,
388 filename
== NULL
? "???" : filename
,
397 /* A callback function passed to the backtrace_full function. This is
398 called if backtrace_full has an error. */
401 bt_err_callback (void *data ATTRIBUTE_UNUSED
, const char *msg
, int errnum
)
405 /* This means that no debug info was available. Just quietly
406 skip printing backtrace info. */
409 fprintf (stderr
, "%s%s%s\n", msg
, errnum
== 0 ? "" : ": ",
410 errnum
== 0 ? "" : xstrerror (errnum
));
413 /* Take any action which is expected to happen after the diagnostic
414 is written out. This function does not always return. */
416 diagnostic_action_after_output (diagnostic_context
*context
,
417 diagnostic_t diag_kind
)
429 if (context
->abort_on_error
)
431 if (context
->fatal_errors
)
433 fnotice (stderr
, "compilation terminated due to -Wfatal-errors.\n");
434 diagnostic_finish (context
);
435 exit (FATAL_EXIT_CODE
);
437 if (context
->max_errors
!= 0
438 && ((unsigned) (diagnostic_kind_count (context
, DK_ERROR
)
439 + diagnostic_kind_count (context
, DK_SORRY
)
440 + diagnostic_kind_count (context
, DK_WERROR
))
441 >= context
->max_errors
))
444 "compilation terminated due to -fmax-errors=%u.\n",
445 context
->max_errors
);
446 diagnostic_finish (context
);
447 exit (FATAL_EXIT_CODE
);
454 struct backtrace_state
*state
= NULL
;
455 if (diag_kind
== DK_ICE
)
456 state
= backtrace_create_state (NULL
, 0, bt_err_callback
, NULL
);
459 backtrace_full (state
, 2, bt_callback
, bt_err_callback
,
462 if (context
->abort_on_error
)
465 fnotice (stderr
, "Please submit a full bug report,\n"
466 "with preprocessed source if appropriate.\n");
469 ("Please include the complete backtrace "
470 "with any bug report.\n"));
471 fnotice (stderr
, "See %s for instructions.\n", bug_report_url
);
473 exit (ICE_EXIT_CODE
);
477 if (context
->abort_on_error
)
479 diagnostic_finish (context
);
480 fnotice (stderr
, "compilation terminated.\n");
481 exit (FATAL_EXIT_CODE
);
489 diagnostic_report_current_module (diagnostic_context
*context
, location_t where
)
491 const line_map_ordinary
*map
= NULL
;
493 if (pp_needs_newline (context
->printer
))
495 pp_newline (context
->printer
);
496 pp_needs_newline (context
->printer
) = false;
499 if (where
<= BUILTINS_LOCATION
)
502 linemap_resolve_location (line_table
, where
,
503 LRK_MACRO_DEFINITION_LOCATION
,
506 if (map
&& diagnostic_last_module_changed (context
, map
))
508 diagnostic_set_last_module (context
, map
);
509 if (! MAIN_FILE_P (map
))
511 map
= INCLUDED_FROM (line_table
, map
);
512 if (context
->show_column
)
513 pp_verbatim (context
->printer
,
514 "In file included from %r%s:%d:%d%R", "locus",
516 LAST_SOURCE_LINE (map
), LAST_SOURCE_COLUMN (map
));
518 pp_verbatim (context
->printer
,
519 "In file included from %r%s:%d%R", "locus",
520 LINEMAP_FILE (map
), LAST_SOURCE_LINE (map
));
521 while (! MAIN_FILE_P (map
))
523 map
= INCLUDED_FROM (line_table
, map
);
524 pp_verbatim (context
->printer
,
525 ",\n from %r%s:%d%R", "locus",
526 LINEMAP_FILE (map
), LAST_SOURCE_LINE (map
));
528 pp_verbatim (context
->printer
, ":");
529 pp_newline (context
->printer
);
535 default_diagnostic_starter (diagnostic_context
*context
,
536 diagnostic_info
*diagnostic
)
538 diagnostic_report_current_module (context
, diagnostic_location (diagnostic
));
539 pp_set_prefix (context
->printer
, diagnostic_build_prefix (context
,
544 default_diagnostic_finalizer (diagnostic_context
*context
,
545 diagnostic_info
*diagnostic
)
547 diagnostic_show_locus (context
, diagnostic
);
548 pp_destroy_prefix (context
->printer
);
549 pp_flush (context
->printer
);
552 /* Interface to specify diagnostic kind overrides. Returns the
553 previous setting, or DK_UNSPECIFIED if the parameters are out of
554 range. If OPTION_INDEX is zero, the new setting is for all the
557 diagnostic_classify_diagnostic (diagnostic_context
*context
,
559 diagnostic_t new_kind
,
562 diagnostic_t old_kind
;
565 || option_index
>= context
->n_opts
566 || new_kind
>= DK_LAST_DIAGNOSTIC_KIND
)
567 return DK_UNSPECIFIED
;
569 old_kind
= context
->classify_diagnostic
[option_index
];
571 /* Handle pragmas separately, since we need to keep track of *where*
573 if (where
!= UNKNOWN_LOCATION
)
577 /* Record the command-line status, so we can reset it back on DK_POP. */
578 if (old_kind
== DK_UNSPECIFIED
)
580 old_kind
= !context
->option_enabled (option_index
,
581 context
->option_state
)
582 ? DK_IGNORED
: (context
->warning_as_error_requested
583 ? DK_ERROR
: DK_WARNING
);
584 context
->classify_diagnostic
[option_index
] = old_kind
;
587 for (i
= context
->n_classification_history
- 1; i
>= 0; i
--)
588 if (context
->classification_history
[i
].option
== option_index
)
590 old_kind
= context
->classification_history
[i
].kind
;
594 i
= context
->n_classification_history
;
595 context
->classification_history
=
596 (diagnostic_classification_change_t
*) xrealloc (context
->classification_history
, (i
+ 1)
597 * sizeof (diagnostic_classification_change_t
));
598 context
->classification_history
[i
].location
= where
;
599 context
->classification_history
[i
].option
= option_index
;
600 context
->classification_history
[i
].kind
= new_kind
;
601 context
->n_classification_history
++;
604 context
->classify_diagnostic
[option_index
] = new_kind
;
609 /* Save all diagnostic classifications in a stack. */
611 diagnostic_push_diagnostics (diagnostic_context
*context
, location_t where ATTRIBUTE_UNUSED
)
613 context
->push_list
= (int *) xrealloc (context
->push_list
, (context
->n_push
+ 1) * sizeof (int));
614 context
->push_list
[context
->n_push
++] = context
->n_classification_history
;
617 /* Restore the topmost classification set off the stack. If the stack
618 is empty, revert to the state based on command line parameters. */
620 diagnostic_pop_diagnostics (diagnostic_context
*context
, location_t where
)
626 jump_to
= context
->push_list
[-- context
->n_push
];
630 i
= context
->n_classification_history
;
631 context
->classification_history
=
632 (diagnostic_classification_change_t
*) xrealloc (context
->classification_history
, (i
+ 1)
633 * sizeof (diagnostic_classification_change_t
));
634 context
->classification_history
[i
].location
= where
;
635 context
->classification_history
[i
].option
= jump_to
;
636 context
->classification_history
[i
].kind
= DK_POP
;
637 context
->n_classification_history
++;
640 /* Report a diagnostic message (an error or a warning) as specified by
641 DC. This function is *the* subroutine in terms of which front-ends
642 should implement their specific diagnostic handling modules. The
643 front-end independent format specifiers are exactly those described
644 in the documentation of output_format.
645 Return true if a diagnostic was printed, false otherwise. */
648 diagnostic_report_diagnostic (diagnostic_context
*context
,
649 diagnostic_info
*diagnostic
)
651 location_t location
= diagnostic_location (diagnostic
);
652 diagnostic_t orig_diag_kind
= diagnostic
->kind
;
653 const char *saved_format_spec
;
655 /* Give preference to being able to inhibit warnings, before they
656 get reclassified to something else. */
657 if ((diagnostic
->kind
== DK_WARNING
|| diagnostic
->kind
== DK_PEDWARN
)
658 && !diagnostic_report_warnings_p (context
, location
))
661 if (diagnostic
->kind
== DK_PEDWARN
)
663 diagnostic
->kind
= pedantic_warning_kind (context
);
664 /* We do this to avoid giving the message for -pedantic-errors. */
665 orig_diag_kind
= diagnostic
->kind
;
668 if (diagnostic
->kind
== DK_NOTE
&& context
->inhibit_notes_p
)
671 if (context
->lock
> 0)
673 /* If we're reporting an ICE in the middle of some other error,
674 try to flush out the previous error, then let this one
675 through. Don't do this more than once. */
676 if ((diagnostic
->kind
== DK_ICE
|| diagnostic
->kind
== DK_ICE_NOBT
)
677 && context
->lock
== 1)
678 pp_newline_and_flush (context
->printer
);
680 error_recursion (context
);
683 /* If the user requested that warnings be treated as errors, so be
684 it. Note that we do this before the next block so that
685 individual warnings can be overridden back to warnings with
687 if (context
->warning_as_error_requested
688 && diagnostic
->kind
== DK_WARNING
)
690 diagnostic
->kind
= DK_ERROR
;
693 if (diagnostic
->option_index
694 && diagnostic
->option_index
!= permissive_error_option (context
))
696 diagnostic_t diag_class
= DK_UNSPECIFIED
;
698 /* This tests if the user provided the appropriate -Wfoo or
700 if (! context
->option_enabled (diagnostic
->option_index
,
701 context
->option_state
))
704 /* This tests for #pragma diagnostic changes. */
705 if (context
->n_classification_history
> 0)
707 /* FIXME: Stupid search. Optimize later. */
708 for (int i
= context
->n_classification_history
- 1; i
>= 0; i
--)
710 if (linemap_location_before_p
712 context
->classification_history
[i
].location
,
715 if (context
->classification_history
[i
].kind
== (int) DK_POP
)
717 i
= context
->classification_history
[i
].option
;
720 int option
= context
->classification_history
[i
].option
;
721 /* The option 0 is for all the diagnostics. */
722 if (option
== 0 || option
== diagnostic
->option_index
)
724 diag_class
= context
->classification_history
[i
].kind
;
725 if (diag_class
!= DK_UNSPECIFIED
)
726 diagnostic
->kind
= diag_class
;
732 /* This tests if the user provided the appropriate -Werror=foo
734 if (diag_class
== DK_UNSPECIFIED
735 && context
->classify_diagnostic
[diagnostic
->option_index
] != DK_UNSPECIFIED
)
737 diagnostic
->kind
= context
->classify_diagnostic
[diagnostic
->option_index
];
739 /* This allows for future extensions, like temporarily disabling
740 warnings for ranges of source code. */
741 if (diagnostic
->kind
== DK_IGNORED
)
747 if (diagnostic
->kind
== DK_ICE
|| diagnostic
->kind
== DK_ICE_NOBT
)
749 /* When not checking, ICEs are converted to fatal errors when an
750 error has already occurred. This is counteracted by
753 && (diagnostic_kind_count (context
, DK_ERROR
) > 0
754 || diagnostic_kind_count (context
, DK_SORRY
) > 0)
755 && !context
->abort_on_error
)
758 = expand_location (diagnostic_location (diagnostic
));
759 fnotice (stderr
, "%s:%d: confused by earlier errors, bailing out\n",
761 exit (ICE_EXIT_CODE
);
763 if (context
->internal_error
)
764 (*context
->internal_error
) (context
,
765 diagnostic
->message
.format_spec
,
766 diagnostic
->message
.args_ptr
);
768 if (diagnostic
->kind
== DK_ERROR
&& orig_diag_kind
== DK_WARNING
)
769 ++diagnostic_kind_count (context
, DK_WERROR
);
771 ++diagnostic_kind_count (context
, diagnostic
->kind
);
773 saved_format_spec
= diagnostic
->message
.format_spec
;
774 if (context
->show_option_requested
)
778 option_text
= context
->option_name (context
, diagnostic
->option_index
,
779 orig_diag_kind
, diagnostic
->kind
);
784 = colorize_start (pp_show_color (context
->printer
),
785 diagnostic_kind_color
[diagnostic
->kind
]);
786 const char *ce
= colorize_stop (pp_show_color (context
->printer
));
787 diagnostic
->message
.format_spec
788 = ACONCAT ((diagnostic
->message
.format_spec
,
790 "[", cs
, option_text
, ce
, "]",
795 diagnostic
->message
.x_data
= &diagnostic
->x_data
;
796 diagnostic
->x_data
= NULL
;
797 pp_format (context
->printer
, &diagnostic
->message
);
798 (*diagnostic_starter (context
)) (context
, diagnostic
);
799 pp_output_formatted_text (context
->printer
);
800 (*diagnostic_finalizer (context
)) (context
, diagnostic
);
801 diagnostic_action_after_output (context
, diagnostic
->kind
);
802 diagnostic
->message
.format_spec
= saved_format_spec
;
803 diagnostic
->x_data
= NULL
;
810 /* Given a partial pathname as input, return another pathname that
811 shares no directory elements with the pathname of __FILE__. This
812 is used by fancy_abort() to print `Internal compiler error in expr.c'
813 instead of `Internal compiler error in ../../GCC/gcc/expr.c'. */
816 trim_filename (const char *name
)
818 static const char this_file
[] = __FILE__
;
819 const char *p
= name
, *q
= this_file
;
821 /* First skip any "../" in each filename. This allows us to give a proper
822 reference to a file in a subdirectory. */
823 while (p
[0] == '.' && p
[1] == '.' && IS_DIR_SEPARATOR (p
[2]))
826 while (q
[0] == '.' && q
[1] == '.' && IS_DIR_SEPARATOR (q
[2]))
829 /* Now skip any parts the two filenames have in common. */
830 while (*p
== *q
&& *p
!= 0 && *q
!= 0)
833 /* Now go backwards until the previous directory separator. */
834 while (p
> name
&& !IS_DIR_SEPARATOR (p
[-1]))
840 /* Standard error reporting routines in increasing order of severity.
841 All of these take arguments like printf. */
843 /* Text to be emitted verbatim to the error message stream; this
844 produces no prefix and disables line-wrapping. Use rarely. */
846 verbatim (const char *gmsgid
, ...)
851 va_start (ap
, gmsgid
);
854 text
.format_spec
= _(gmsgid
);
856 pp_format_verbatim (global_dc
->printer
, &text
);
857 pp_newline_and_flush (global_dc
->printer
);
861 /* Add a note with text GMSGID and with LOCATION to the diagnostic CONTEXT. */
863 diagnostic_append_note (diagnostic_context
*context
,
865 const char * gmsgid
, ...)
867 diagnostic_info diagnostic
;
869 const char *saved_prefix
;
870 rich_location
richloc (line_table
, location
);
872 va_start (ap
, gmsgid
);
873 diagnostic_set_info (&diagnostic
, gmsgid
, &ap
, &richloc
, DK_NOTE
);
874 if (context
->inhibit_notes_p
)
879 saved_prefix
= pp_get_prefix (context
->printer
);
880 pp_set_prefix (context
->printer
,
881 diagnostic_build_prefix (context
, &diagnostic
));
882 pp_format (context
->printer
, &diagnostic
.message
);
883 pp_output_formatted_text (context
->printer
);
884 pp_destroy_prefix (context
->printer
);
885 pp_set_prefix (context
->printer
, saved_prefix
);
886 diagnostic_show_locus (context
, &diagnostic
);
891 emit_diagnostic (diagnostic_t kind
, location_t location
, int opt
,
892 const char *gmsgid
, ...)
894 diagnostic_info diagnostic
;
897 rich_location
richloc (line_table
, location
);
899 va_start (ap
, gmsgid
);
900 if (kind
== DK_PERMERROR
)
902 diagnostic_set_info (&diagnostic
, gmsgid
, &ap
, &richloc
,
903 permissive_error_kind (global_dc
));
904 diagnostic
.option_index
= permissive_error_option (global_dc
);
907 diagnostic_set_info (&diagnostic
, gmsgid
, &ap
, &richloc
, kind
);
908 if (kind
== DK_WARNING
|| kind
== DK_PEDWARN
)
909 diagnostic
.option_index
= opt
;
912 ret
= report_diagnostic (&diagnostic
);
917 /* An informative note at LOCATION. Use this for additional details on an error
920 inform (location_t location
, const char *gmsgid
, ...)
922 diagnostic_info diagnostic
;
924 rich_location
richloc (line_table
, location
);
926 va_start (ap
, gmsgid
);
927 diagnostic_set_info (&diagnostic
, gmsgid
, &ap
, &richloc
, DK_NOTE
);
928 report_diagnostic (&diagnostic
);
932 /* Same as "inform", but at RICHLOC. */
934 inform_at_rich_loc (rich_location
*richloc
, const char *gmsgid
, ...)
936 diagnostic_info diagnostic
;
939 va_start (ap
, gmsgid
);
940 diagnostic_set_info (&diagnostic
, gmsgid
, &ap
, richloc
, DK_NOTE
);
941 report_diagnostic (&diagnostic
);
945 /* An informative note at LOCATION. Use this for additional details on an
948 inform_n (location_t location
, int n
, const char *singular_gmsgid
,
949 const char *plural_gmsgid
, ...)
951 diagnostic_info diagnostic
;
953 rich_location
richloc (line_table
, location
);
955 va_start (ap
, plural_gmsgid
);
956 diagnostic_set_info_translated (&diagnostic
,
957 ngettext (singular_gmsgid
, plural_gmsgid
, n
),
958 &ap
, &richloc
, DK_NOTE
);
959 report_diagnostic (&diagnostic
);
963 /* A warning at INPUT_LOCATION. Use this for code which is correct according
964 to the relevant language specification but is likely to be buggy anyway.
965 Returns true if the warning was printed, false if it was inhibited. */
967 warning (int opt
, const char *gmsgid
, ...)
969 diagnostic_info diagnostic
;
972 rich_location
richloc (line_table
, input_location
);
974 va_start (ap
, gmsgid
);
975 diagnostic_set_info (&diagnostic
, gmsgid
, &ap
, &richloc
, DK_WARNING
);
976 diagnostic
.option_index
= opt
;
978 ret
= report_diagnostic (&diagnostic
);
983 /* A warning at LOCATION. Use this for code which is correct according to the
984 relevant language specification but is likely to be buggy anyway.
985 Returns true if the warning was printed, false if it was inhibited. */
988 warning_at (location_t location
, int opt
, const char *gmsgid
, ...)
990 diagnostic_info diagnostic
;
993 rich_location
richloc (line_table
, location
);
995 va_start (ap
, gmsgid
);
996 diagnostic_set_info (&diagnostic
, gmsgid
, &ap
, &richloc
, DK_WARNING
);
997 diagnostic
.option_index
= opt
;
998 ret
= report_diagnostic (&diagnostic
);
1003 /* Same as warning at, but using RICHLOC. */
1006 warning_at_rich_loc (rich_location
*richloc
, int opt
, const char *gmsgid
, ...)
1008 diagnostic_info diagnostic
;
1012 va_start (ap
, gmsgid
);
1013 diagnostic_set_info (&diagnostic
, gmsgid
, &ap
, richloc
, DK_WARNING
);
1014 diagnostic
.option_index
= opt
;
1015 ret
= report_diagnostic (&diagnostic
);
1020 /* A warning at LOCATION. Use this for code which is correct according to the
1021 relevant language specification but is likely to be buggy anyway.
1022 Returns true if the warning was printed, false if it was inhibited. */
1025 warning_n (location_t location
, int opt
, int n
, const char *singular_gmsgid
,
1026 const char *plural_gmsgid
, ...)
1028 diagnostic_info diagnostic
;
1031 rich_location
richloc (line_table
, location
);
1033 va_start (ap
, plural_gmsgid
);
1034 diagnostic_set_info_translated (&diagnostic
,
1035 ngettext (singular_gmsgid
, plural_gmsgid
, n
),
1036 &ap
, &richloc
, DK_WARNING
1038 diagnostic
.option_index
= opt
;
1039 ret
= report_diagnostic (&diagnostic
);
1044 /* A "pedantic" warning at LOCATION: issues a warning unless
1045 -pedantic-errors was given on the command line, in which case it
1046 issues an error. Use this for diagnostics required by the relevant
1047 language standard, if you have chosen not to make them errors.
1049 Note that these diagnostics are issued independent of the setting
1050 of the -Wpedantic command-line switch. To get a warning enabled
1051 only with that switch, use either "if (pedantic) pedwarn
1052 (OPT_Wpedantic,...)" or just "pedwarn (OPT_Wpedantic,..)". To get a
1053 pedwarn independently of the -Wpedantic switch use "pedwarn (0,...)".
1055 Returns true if the warning was printed, false if it was inhibited. */
1058 pedwarn (location_t location
, int opt
, const char *gmsgid
, ...)
1060 diagnostic_info diagnostic
;
1063 rich_location
richloc (line_table
, location
);
1065 va_start (ap
, gmsgid
);
1066 diagnostic_set_info (&diagnostic
, gmsgid
, &ap
, &richloc
, DK_PEDWARN
);
1067 diagnostic
.option_index
= opt
;
1068 ret
= report_diagnostic (&diagnostic
);
1073 /* A "permissive" error at LOCATION: issues an error unless
1074 -fpermissive was given on the command line, in which case it issues
1075 a warning. Use this for things that really should be errors but we
1076 want to support legacy code.
1078 Returns true if the warning was printed, false if it was inhibited. */
1081 permerror (location_t location
, const char *gmsgid
, ...)
1083 diagnostic_info diagnostic
;
1086 rich_location
richloc (line_table
, location
);
1088 va_start (ap
, gmsgid
);
1089 diagnostic_set_info (&diagnostic
, gmsgid
, &ap
, &richloc
,
1090 permissive_error_kind (global_dc
));
1091 diagnostic
.option_index
= permissive_error_option (global_dc
);
1092 ret
= report_diagnostic (&diagnostic
);
1097 /* Same as "permerror", but at RICHLOC. */
1100 permerror_at_rich_loc (rich_location
*richloc
, const char *gmsgid
, ...)
1102 diagnostic_info diagnostic
;
1106 va_start (ap
, gmsgid
);
1107 diagnostic_set_info (&diagnostic
, gmsgid
, &ap
, richloc
,
1108 permissive_error_kind (global_dc
));
1109 diagnostic
.option_index
= permissive_error_option (global_dc
);
1110 ret
= report_diagnostic (&diagnostic
);
1115 /* A hard error: the code is definitely ill-formed, and an object file
1116 will not be produced. */
1118 error (const char *gmsgid
, ...)
1120 diagnostic_info diagnostic
;
1122 rich_location
richloc (line_table
, input_location
);
1124 va_start (ap
, gmsgid
);
1125 diagnostic_set_info (&diagnostic
, gmsgid
, &ap
, &richloc
, DK_ERROR
);
1126 report_diagnostic (&diagnostic
);
1130 /* A hard error: the code is definitely ill-formed, and an object file
1131 will not be produced. */
1133 error_n (location_t location
, int n
, const char *singular_gmsgid
,
1134 const char *plural_gmsgid
, ...)
1136 diagnostic_info diagnostic
;
1138 rich_location
richloc (line_table
, location
);
1140 va_start (ap
, plural_gmsgid
);
1141 diagnostic_set_info_translated (&diagnostic
,
1142 ngettext (singular_gmsgid
, plural_gmsgid
, n
),
1143 &ap
, &richloc
, DK_ERROR
);
1144 report_diagnostic (&diagnostic
);
1148 /* Same as ebove, but use location LOC instead of input_location. */
1150 error_at (location_t loc
, const char *gmsgid
, ...)
1152 diagnostic_info diagnostic
;
1154 rich_location
richloc (line_table
, loc
);
1156 va_start (ap
, gmsgid
);
1157 diagnostic_set_info (&diagnostic
, gmsgid
, &ap
, &richloc
, DK_ERROR
);
1158 report_diagnostic (&diagnostic
);
1162 /* Same as above, but use RICH_LOC. */
1165 error_at_rich_loc (rich_location
*rich_loc
, const char *gmsgid
, ...)
1167 diagnostic_info diagnostic
;
1170 va_start (ap
, gmsgid
);
1171 diagnostic_set_info (&diagnostic
, gmsgid
, &ap
, rich_loc
,
1173 report_diagnostic (&diagnostic
);
1177 /* "Sorry, not implemented." Use for a language feature which is
1178 required by the relevant specification but not implemented by GCC.
1179 An object file will not be produced. */
1181 sorry (const char *gmsgid
, ...)
1183 diagnostic_info diagnostic
;
1185 rich_location
richloc (line_table
, input_location
);
1187 va_start (ap
, gmsgid
);
1188 diagnostic_set_info (&diagnostic
, gmsgid
, &ap
, &richloc
, DK_SORRY
);
1189 report_diagnostic (&diagnostic
);
1193 /* Return true if an error or a "sorry" has been seen. Various
1194 processing is disabled after errors. */
1198 return errorcount
|| sorrycount
;
1201 /* An error which is severe enough that we make no attempt to
1202 continue. Do not use this for internal consistency checks; that's
1203 internal_error. Use of this function should be rare. */
1205 fatal_error (location_t loc
, const char *gmsgid
, ...)
1207 diagnostic_info diagnostic
;
1209 rich_location
richloc (line_table
, loc
);
1211 va_start (ap
, gmsgid
);
1212 diagnostic_set_info (&diagnostic
, gmsgid
, &ap
, &richloc
, DK_FATAL
);
1213 report_diagnostic (&diagnostic
);
1219 /* An internal consistency check has failed. We make no attempt to
1220 continue. Note that unless there is debugging value to be had from
1221 a more specific message, or some other good reason, you should use
1222 abort () instead of calling this function directly. */
1224 internal_error (const char *gmsgid
, ...)
1226 diagnostic_info diagnostic
;
1228 rich_location
richloc (line_table
, input_location
);
1230 va_start (ap
, gmsgid
);
1231 diagnostic_set_info (&diagnostic
, gmsgid
, &ap
, &richloc
, DK_ICE
);
1232 report_diagnostic (&diagnostic
);
1238 /* Like internal_error, but no backtrace will be printed. Used when
1239 the internal error does not happen at the current location, but happened
1242 internal_error_no_backtrace (const char *gmsgid
, ...)
1244 diagnostic_info diagnostic
;
1246 rich_location
richloc (line_table
, input_location
);
1248 va_start (ap
, gmsgid
);
1249 diagnostic_set_info (&diagnostic
, gmsgid
, &ap
, &richloc
, DK_ICE_NOBT
);
1250 report_diagnostic (&diagnostic
);
1256 /* Special case error functions. Most are implemented in terms of the
1257 above, or should be. */
1259 /* Print a diagnostic MSGID on FILE. This is just fprintf, except it
1260 runs its second argument through gettext. */
1262 fnotice (FILE *file
, const char *cmsgid
, ...)
1266 va_start (ap
, cmsgid
);
1267 vfprintf (file
, _(cmsgid
), ap
);
1271 /* Inform the user that an error occurred while trying to report some
1272 other error. This indicates catastrophic internal inconsistencies,
1273 so give up now. But do try to flush out the previous error.
1274 This mustn't use internal_error, that will cause infinite recursion. */
1277 error_recursion (diagnostic_context
*context
)
1279 if (context
->lock
< 3)
1280 pp_newline_and_flush (context
->printer
);
1283 "Internal compiler error: Error reporting routines re-entered.\n");
1285 /* Call diagnostic_action_after_output to get the "please submit a bug
1287 diagnostic_action_after_output (context
, DK_ICE
);
1289 /* Do not use gcc_unreachable here; that goes through internal_error
1290 and therefore would cause infinite recursion. */
1294 /* Report an internal compiler error in a friendly manner. This is
1295 the function that gets called upon use of abort() in the source
1296 code generally, thanks to a special macro. */
1299 fancy_abort (const char *file
, int line
, const char *function
)
1301 internal_error ("in %s, at %s:%d", function
, trim_filename (file
), line
);
1304 /* Really call the system 'abort'. This has to go right at the end of
1305 this file, so that there are no functions after it that call abort
1306 and get the system abort instead of our macro. */
1314 /* Display the given source_range instance, with MSG as a descriptive
1315 comment. This issues a "note" diagnostic at the range.
1317 This is declared within libcpp, but implemented here, since it
1318 makes use of the diagnostic-printing machinery. */
1321 source_range::debug (const char *msg
) const
1323 rich_location
richloc (line_table
, m_start
);
1324 richloc
.add_range (m_start
, m_finish
, false);
1325 inform_at_rich_loc (&richloc
, "%s", msg
);