#include "config.h"
#include "system.h"
#include "coretypes.h"
#include "tree.h"
#include "diagnostic.h"
#include "diagnostic-macro-unwinding.h"
#include "diagnostic-format-text.h"
#include "intl.h"

Include dependency graph for diagnostic-macro-unwinding.cc:

Data Structures
struct	loc_map_pair

Functions
void	maybe_unwind_expanded_macro_loc (diagnostic_text_output_format &text_output, location_t where)

void	virt_loc_aware_diagnostic_finalizer (diagnostic_text_output_format &text_output, const diagnostic_info *diagnostic)

Function Documentation

◆ maybe_unwind_expanded_macro_loc()

void maybe_unwind_expanded_macro_loc	(	diagnostic_text_output_format &	text_output,
		location_t	where )

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_text_output_format::append_note(), expand_location_to_spelling_point(), FOR_EACH_VEC_ELT, line_table, loc_map_pair::map, map, NULL, and loc_map_pair::where.

Referenced by virt_loc_aware_diagnostic_finalizer().

◆ virt_loc_aware_diagnostic_finalizer()

void virt_loc_aware_diagnostic_finalizer	(	diagnostic_text_output_format &	text_output,
		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(), and maybe_unwind_expanded_macro_loc().

Data Structures

Functions

Function Documentation

◆ maybe_unwind_expanded_macro_loc()

◆ virt_loc_aware_diagnostic_finalizer()