tree-diagnostic.h File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	diagnostic_abstract_origin(DI)    ((tree) diagnostic_info_auxiliary_data (DI))
#define	diagnostic_last_function(DC)    ((tree) diagnostic_context_auxiliary_data (DC))
#define	diagnostic_last_function_changed(DC, DI)
#define	diagnostic_set_last_function(DC, DI)

Functions
void	diagnostic_report_current_function (diagnostic_context *, const diagnostic_info *)
void	virt_loc_aware_diagnostic_finalizer (diagnostic_context *, const diagnostic_info *)
void	tree_diagnostics_defaults (diagnostic_context *context)
bool	default_tree_printer (pretty_printer *, text_info *, const char *, int, bool, bool, bool, bool *, const char **)
void	default_tree_diagnostic_path_printer (diagnostic_context *, const diagnostic_path *)
json::value *	default_tree_make_json_for_path (diagnostic_context *, const diagnostic_path *)
void	maybe_unwind_expanded_macro_loc (diagnostic_context *context, location_t where)

Macro Definition Documentation

diagnostic_abstract_origin

#define diagnostic_abstract_origin

(

DI

)

((tree) diagnostic_info_auxiliary_data (DI))

Various declarations for language-independent diagnostics
   subroutines that are only for use in the compilers proper and not
   the driver or other programs.
   Copyright (C) 2000-2024 Free Software Foundation, Inc.

This file is part of GCC.

GCC is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free
Software Foundation; either version 3, or (at your option) any later
version.

GCC is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
for more details.

You should have received a copy of the GNU General Public License
along with GCC; see the file COPYING3.  If not see
<http://www.gnu.org/licenses/>.   

TREE_BLOCK if the diagnostic is to be reported in some inline
function inlined into other function, otherwise NULL.   

Referenced by lhd_print_error_function().

diagnostic_last_function

#define diagnostic_last_function

(

DC

)

((tree) diagnostic_context_auxiliary_data (DC))

Function of last diagnostic message; more generally, function such
that if next diagnostic message is in it then we don't have to
mention the function name.   

diagnostic_last_function_changed

#define diagnostic_last_function_changed	(		DC,
			DI )

Value:

  (diagnostic_last_function (DC) != (diagnostic_abstract_origin (DI)    \
                                     ? diagnostic_abstract_origin (DI)  \
                                     : current_function_decl))

True if the last function in which a diagnostic was reported is
different from the current one.   

Referenced by lhd_print_error_function().

diagnostic_set_last_function

#define diagnostic_set_last_function	(		DC,
			DI )

Value:

  diagnostic_context_auxiliary_data (DC)                \
    = (((DI) && diagnostic_abstract_origin (DI))        \
       ? diagnostic_abstract_origin (DI)                \
       : current_function_decl)

Remember the current function as being the last one in which we report
a diagnostic.   

Referenced by announce_function(), and lhd_print_error_function().

Function Documentation

default_tree_diagnostic_path_printer()

void default_tree_diagnostic_path_printer ( diagnostic_context * context, const diagnostic_path * path )

extern

Print PATH to CONTEXT, according to CONTEXT's path_format.   

References DPF_INLINE_EVENTS, DPF_NONE, DPF_SEPARATE_EVENTS, gcc_assert, diagnostic_context::get_path_format(), ggc_alloc(), i, inform(), diagnostic_context::m_source_printing, NULL, pp_flush(), pp_set_prefix(), pp_take_prefix(), diagnostic_context::printer, diagnostic_source_printing_options::show_event_links_p, and diagnostic_context::show_path_depths_p().

Referenced by tree_diagnostics_defaults().

default_tree_make_json_for_path()

json::value * default_tree_make_json_for_path ( diagnostic_context * context, const diagnostic_path * path )

extern

This has to be here, rather than diagnostic-format-json.cc,
since diagnostic-format-json.o is within OBJS-libcommon and thus
doesn't have access to trees (for m_fndecl).   

References lang_hooks::decl_printable_name, ggc_alloc(), i, identifier_to_locale(), and json_from_expanded_location().

Referenced by tree_diagnostics_defaults().

default_tree_printer()

bool default_tree_printer	(	pretty_printer *	pp,
		text_info *	text,
		const char *	spec,
		int	precision,
		bool	wide,
		bool	set_locus,
		bool	hash,
		bool *	,
		const char **	)

Default tree printer.   Handles declarations only.   

References _, DECL_DEBUG_EXPR, DECL_HAS_DEBUG_EXPR_P, DECL_NAME, DECL_P, lang_hooks::decl_printable_name, DECL_SOURCE_LOCATION, dump_generic_node(), ggc_alloc(), IDENTIFIER_POINTER, identifier_to_locale(), pp_identifier, pp_string(), TDF_SLIM, TREE_CODE, and VAR_P.

Referenced by digraph< GraphTraits >::dump_dot_to_file(), and tree_diagnostics_defaults().

diagnostic_report_current_function()

void diagnostic_report_current_function	(	diagnostic_context *	context,
		const diagnostic_info *	diagnostic )

Language-independent diagnostic subroutines for the GNU Compiler
   Collection that are only for use in the compilers proper and not
   the driver or other programs.
   Copyright (C) 1999-2024 Free Software Foundation, Inc.

This file is part of GCC.

GCC is free software; you can redistribute it and/or modify it under
the terms of the GNU General Public License as published by the Free
Software Foundation; either version 3, or (at your option) any later
version.

GCC is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
for more details.

You should have received a copy of the GNU General Public License
along with GCC; see the file COPYING3.  If not see
<http://www.gnu.org/licenses/>.   

Prints out, if necessary, the name of the current function
that caused an error.  Called from all error and warning functions.   

References diagnostic_location(), diagnostic_report_current_module(), ggc_alloc(), LOCATION_FILE, and lang_hooks::print_error_function.

Referenced by default_tree_diagnostic_starter().

maybe_unwind_expanded_macro_loc()

void maybe_unwind_expanded_macro_loc ( diagnostic_context * context, location_t where )

extern

Unwind the different macro expansions that lead to the token which
location is WHERE and emit diagnostics showing the resulting
unwound macro expansion trace.  Let's look at an example to see how
the trace looks like.  Suppose we have this piece of code,
artificially annotated with the line numbers to increase
legibility:

 $ cat -n test.c
   1    #define OPERATE(OPRD1, OPRT, OPRD2) \
   2      OPRD1 OPRT OPRD2;
   3
   4    #define SHIFTL(A,B) \
   5      OPERATE (A,<<,B)
   6
   7    #define MULT(A) \
   8      SHIFTL (A,1)
   9
  10    void
  11    g ()
  12    {
  13      MULT (1.0);// 1.0 << 1; <-- so this is an error.
  14    }

Here is the diagnostic that we want the compiler to generate:

 test.c: In function ‘g’:
 test.c:5:14: error: invalid operands to binary << (have ‘double’ and ‘int’)
 test.c:2:9: note: in definition of macro 'OPERATE'
 test.c:8:3: note: in expansion of macro 'SHIFTL'
 test.c:13:3: note: in expansion of macro 'MULT'

The part that goes from the third to the fifth line of this
diagnostic (the lines containing the 'note:' string) is called the
unwound macro expansion trace.  That's the part generated by this
function.   

References diagnostic_append_note(), expand_location_to_spelling_point(), FOR_EACH_VEC_ELT, ggc_alloc(), line_table, map, loc_map_pair::map, NULL, and loc_map_pair::where.

Referenced by virt_loc_aware_diagnostic_finalizer().

tree_diagnostics_defaults()

void tree_diagnostics_defaults

(

diagnostic_context *

context

)

Sets CONTEXT to use language independent diagnostics.   

References default_diagnostic_finalizer(), default_tree_diagnostic_path_printer(), default_tree_diagnostic_starter(), default_tree_make_json_for_path(), default_tree_printer(), diagnostic_finalizer(), diagnostic_format_decoder, diagnostic_starter(), diagnostic_context::m_make_json_for_path, diagnostic_context::m_print_path, make_compiler_data_hooks(), diagnostic_context::set_client_data_hooks(), set_inlining_locations(), and diagnostic_context::set_set_locations_callback().

Referenced by general_init().

virt_loc_aware_diagnostic_finalizer()

void virt_loc_aware_diagnostic_finalizer	(	diagnostic_context *	context,
		const diagnostic_info *	diagnostic )

This is a diagnostic finalizer implementation that is aware of
virtual locations produced by libcpp.

It has to be called by the diagnostic finalizer of front ends that
uses libcpp and wish to get diagnostics involving tokens resulting
from macro expansion.

For a given location, if said location belongs to a token
resulting from a macro expansion, this starter prints the context
of the token.  E.g, for multiply nested macro expansion, it
unwinds the nested macro expansions and prints them in a manner
that is similar to what is done for function call stacks, or
template instantiation contexts.   

References diagnostic_location(), ggc_alloc(), and maybe_unwind_expanded_macro_loc().