The base class for the visitor type hierarchy used for traversing a translation unit. More...

#include <abg-ir.h>

Inheritance diagram for ir_node_visitor:

Public Member Functions
	ir_node_visitor ()
	Default Constructor of the ir_node_visitor type. More...

bool	allow_visiting_already_visited_type_node () const
	Get if the walker using this visitor is allowed to re-visit a type node that was previously visited or not. More...

void	allow_visiting_already_visited_type_node (bool)
	Set if the walker using this visitor is allowed to re-visit a type node that was previously visited or not. More...

void	forget_visited_type_nodes ()
	Un-mark all visited type nodes. More...

void	mark_type_node_as_visited (type_base *)
	Mark a given type node as having been visited. More...

bool	type_node_has_been_visited (type_base *) const
	Test if a given type node has been marked as visited. More...

virtual bool	visit_begin (array_type_def *)

virtual bool	visit_begin (array_type_def::subrange_type *)

virtual bool	visit_begin (class_decl *)

virtual bool	visit_begin (class_decl::base_spec *)

virtual bool	visit_begin (class_or_union *)

virtual bool	visit_begin (class_tdecl *)

virtual bool	visit_begin (decl_base *)

virtual bool	visit_begin (enum_type_decl *)

virtual bool	visit_begin (function_decl *)

virtual bool	visit_begin (function_decl::parameter *)

virtual bool	visit_begin (function_tdecl *)

virtual bool	visit_begin (function_type *)

virtual bool	visit_begin (member_class_template *)

virtual bool	visit_begin (member_function_template *)

virtual bool	visit_begin (namespace_decl *)

virtual bool	visit_begin (pointer_type_def *)

virtual bool	visit_begin (qualified_type_def *)

virtual bool	visit_begin (reference_type_def *)

virtual bool	visit_begin (scope_decl *)

virtual bool	visit_begin (scope_type_decl *)

virtual bool	visit_begin (type_base *)

virtual bool	visit_begin (type_decl *)

virtual bool	visit_begin (typedef_decl *)

virtual bool	visit_begin (union_decl *)

virtual bool	visit_begin (var_decl *)

virtual bool	visit_end (array_type_def *)

virtual bool	visit_end (array_type_def::subrange_type *)

virtual bool	visit_end (class_decl *)

virtual bool	visit_end (class_decl::base_spec *)

virtual bool	visit_end (class_or_union *)

virtual bool	visit_end (class_tdecl *)

virtual bool	visit_end (decl_base *)

virtual bool	visit_end (enum_type_decl *)

virtual bool	visit_end (function_decl *)

virtual bool	visit_end (function_decl::parameter *)

virtual bool	visit_end (function_tdecl *)

virtual bool	visit_end (function_type *)

virtual bool	visit_end (member_class_template *)

virtual bool	visit_end (member_function_template *)

virtual bool	visit_end (namespace_decl *)

virtual bool	visit_end (pointer_type_def *)

virtual bool	visit_end (qualified_type_def *)

virtual bool	visit_end (reference_type_def *)

virtual bool	visit_end (scope_decl *)

virtual bool	visit_end (scope_type_decl *)

virtual bool	visit_end (type_base *)

virtual bool	visit_end (type_decl *)

virtual bool	visit_end (typedef_decl *)

virtual bool	visit_end (union_decl *)

virtual bool	visit_end (var_decl *)

Detailed Description

The base class for the visitor type hierarchy used for traversing a translation unit.

Client code willing to get notified for a certain kind of node during the IR traversal might want to define a visitor class that inherit ir_node_visitor, overload the ir_node_visitor::visit_begin() or ir_node_visitor::visit_end() method of its choice, and provide and implementation for it. If either ir_node_visitor::visit_begin() or ir_node_visitor::visit_end() return false, it means the traversal has to stop immediately after the methods' return. If the methods return true, it means the traversal keeps going.

That new visitor class would then be passed to e.g, translation_unit::traverse or to the traverse method of any type where the traversal is supposed to start from.

Definition at line 4869 of file abg-ir.h.

Constructor & Destructor Documentation

◆ ir_node_visitor()

ir_node_visitor ( )

Default Constructor of the ir_node_visitor type.

Definition at line 27206 of file abg-ir.cc.

Member Function Documentation

◆ allow_visiting_already_visited_type_node() [1/2]

bool allow_visiting_already_visited_type_node ( ) const

Get if the walker using this visitor is allowed to re-visit a type node that was previously visited or not.

Returns: true iff the walker using this visitor is allowed to re-visit a type node that was previously visited.

Definition at line 27227 of file abg-ir.cc.

◆ allow_visiting_already_visited_type_node() [2/2]

void allow_visiting_already_visited_type_node ( bool f )

Set if the walker using this visitor is allowed to re-visit a type node that was previously visited or not.

Parameters

f	if true, then the walker using this visitor is allowed to re-visit a type node that was previously visited.

Definition at line 27218 of file abg-ir.cc.

◆ forget_visited_type_nodes()

void forget_visited_type_nodes ( )

Un-mark all visited type nodes.

That is, no type node is going to be considered as having been visited anymore.

In other words, after invoking this funciton, ir_node_visitor::type_node_has_been_visited() is going to return false on all type nodes.

Definition at line 27261 of file abg-ir.cc.

◆ mark_type_node_as_visited()

void mark_type_node_as_visited ( type_base * p )

Mark a given type node as having been visited.

Note that for this function to work, the type node must have been canonicalized. Otherwise the process is aborted.

Parameters

p	the type to mark as having been visited.

Definition at line 27237 of file abg-ir.cc.

◆ type_node_has_been_visited()

bool type_node_has_been_visited ( type_base * p ) const

Test if a given type node has been marked as visited.

Parameters

p	the type node to consider.

Returns: true iff the type node p has been marked as visited by the function ir_node_visitor::mark_type_node_as_visited.

Definition at line 27271 of file abg-ir.cc.

◆ visit_begin() [1/25]

bool visit_begin ( array_type_def * t )

virtual

Definition at line 27363 of file abg-ir.cc.

◆ visit_begin() [2/25]

bool visit_begin ( array_type_def::subrange_type * t )

virtual

Definition at line 27371 of file abg-ir.cc.

◆ visit_begin() [3/25]

bool visit_begin ( class_decl * t )

virtual

Definition at line 27451 of file abg-ir.cc.

◆ visit_begin() [4/25]

bool visit_begin ( class_decl::base_spec * d )

virtual

Definition at line 27467 of file abg-ir.cc.

◆ visit_begin() [5/25]

bool visit_begin ( class_or_union * t )

virtual

Definition at line 27443 of file abg-ir.cc.

◆ visit_begin() [6/25]

bool visit_begin ( class_tdecl * d )

virtual

Definition at line 27435 of file abg-ir.cc.

◆ visit_begin() [7/25]

bool visit_begin ( decl_base * )

virtual

Definition at line 27291 of file abg-ir.cc.

◆ visit_begin() [8/25]

bool visit_begin ( enum_type_decl * t )

virtual

Definition at line 27379 of file abg-ir.cc.

◆ visit_begin() [9/25]

bool visit_begin ( function_decl * d )

virtual

Definition at line 27411 of file abg-ir.cc.

◆ visit_begin() [10/25]

bool visit_begin ( function_decl::parameter * d )

virtual

Definition at line 27419 of file abg-ir.cc.

◆ visit_begin() [11/25]

bool visit_begin ( function_tdecl * d )

virtual

Definition at line 27427 of file abg-ir.cc.

◆ visit_begin() [12/25]

bool visit_begin ( function_type * t )

virtual

Definition at line 27395 of file abg-ir.cc.

◆ visit_begin() [13/25]

bool visit_begin ( member_class_template * d )

virtual

Definition at line 27483 of file abg-ir.cc.

◆ visit_begin() [14/25]

bool visit_begin ( member_function_template * d )

virtual

Definition at line 27475 of file abg-ir.cc.

◆ visit_begin() [15/25]

bool visit_begin ( namespace_decl * d )

virtual

Definition at line 27331 of file abg-ir.cc.

◆ visit_begin() [16/25]

bool visit_begin ( pointer_type_def * t )

virtual

Definition at line 27347 of file abg-ir.cc.

◆ visit_begin() [17/25]

bool visit_begin ( qualified_type_def * t )

virtual

Definition at line 27339 of file abg-ir.cc.

◆ visit_begin() [18/25]

bool visit_begin ( reference_type_def * t )

virtual

Definition at line 27355 of file abg-ir.cc.

◆ visit_begin() [19/25]

bool visit_begin ( scope_decl * )

virtual

Definition at line 27299 of file abg-ir.cc.

◆ visit_begin() [20/25]

bool visit_begin ( scope_type_decl * t )

virtual

Definition at line 27315 of file abg-ir.cc.

◆ visit_begin() [21/25]

bool visit_begin ( type_base * )

virtual

Definition at line 27307 of file abg-ir.cc.

◆ visit_begin() [22/25]

bool visit_begin ( type_decl * t )

virtual

Definition at line 27323 of file abg-ir.cc.

◆ visit_begin() [23/25]

bool visit_begin ( typedef_decl * t )

virtual

Definition at line 27387 of file abg-ir.cc.

◆ visit_begin() [24/25]

bool visit_begin ( union_decl * t )

virtual

Definition at line 27459 of file abg-ir.cc.

◆ visit_begin() [25/25]

bool visit_begin ( var_decl * d )

virtual

Definition at line 27403 of file abg-ir.cc.

◆ visit_end() [1/25]

bool visit_end ( array_type_def * t )

virtual

Definition at line 27367 of file abg-ir.cc.

◆ visit_end() [2/25]

bool visit_end ( array_type_def::subrange_type * t )

virtual

Definition at line 27375 of file abg-ir.cc.

◆ visit_end() [3/25]

bool visit_end ( class_decl * t )

virtual

Definition at line 27455 of file abg-ir.cc.

◆ visit_end() [4/25]

bool visit_end ( class_decl::base_spec * d )

virtual

Definition at line 27471 of file abg-ir.cc.

◆ visit_end() [5/25]

bool visit_end ( class_or_union * t )

virtual

Definition at line 27447 of file abg-ir.cc.

◆ visit_end() [6/25]

bool visit_end ( class_tdecl * d )

virtual

Definition at line 27439 of file abg-ir.cc.

◆ visit_end() [7/25]

bool visit_end ( decl_base * )

virtual

Definition at line 27295 of file abg-ir.cc.

◆ visit_end() [8/25]

bool visit_end ( enum_type_decl * t )

virtual

Definition at line 27383 of file abg-ir.cc.

◆ visit_end() [9/25]

bool visit_end ( function_decl * d )

virtual

Definition at line 27415 of file abg-ir.cc.

◆ visit_end() [10/25]

bool visit_end ( function_decl::parameter * d )

virtual

Definition at line 27423 of file abg-ir.cc.

◆ visit_end() [11/25]

bool visit_end ( function_tdecl * d )

virtual

Definition at line 27431 of file abg-ir.cc.

◆ visit_end() [12/25]

bool visit_end ( function_type * t )

virtual

Definition at line 27399 of file abg-ir.cc.

◆ visit_end() [13/25]

bool visit_end ( member_class_template * d )

virtual

Definition at line 27487 of file abg-ir.cc.

◆ visit_end() [14/25]

bool visit_end ( member_function_template * d )

virtual

Definition at line 27479 of file abg-ir.cc.

◆ visit_end() [15/25]

bool visit_end ( namespace_decl * d )

virtual

Definition at line 27335 of file abg-ir.cc.

◆ visit_end() [16/25]

bool visit_end ( pointer_type_def * t )

virtual

Definition at line 27351 of file abg-ir.cc.

◆ visit_end() [17/25]

bool visit_end ( qualified_type_def * t )

virtual

Definition at line 27343 of file abg-ir.cc.

◆ visit_end() [18/25]

bool visit_end ( reference_type_def * t )

virtual

Definition at line 27359 of file abg-ir.cc.

◆ visit_end() [19/25]

bool visit_end ( scope_decl * )

virtual

Definition at line 27303 of file abg-ir.cc.

◆ visit_end() [20/25]

bool visit_end ( scope_type_decl * t )

virtual

Definition at line 27319 of file abg-ir.cc.

◆ visit_end() [21/25]

bool visit_end ( type_base * )

virtual

Definition at line 27311 of file abg-ir.cc.

◆ visit_end() [22/25]

bool visit_end ( type_decl * t )

virtual

Definition at line 27327 of file abg-ir.cc.

◆ visit_end() [23/25]

bool visit_end ( typedef_decl * t )

virtual

Definition at line 27391 of file abg-ir.cc.

◆ visit_end() [24/25]

bool visit_end ( union_decl * t )

virtual

Definition at line 27463 of file abg-ir.cc.

◆ visit_end() [25/25]

bool visit_end ( var_decl * d )

virtual

Definition at line 27407 of file abg-ir.cc.

The documentation for this class was generated from the following files:

/home/builder/shared/snapshots/worker/libabigail-snapshots-html-doc/build/include/abg-ir.h
/home/builder/shared/snapshots/worker/libabigail-snapshots-html-doc/build/src/abg-ir.cc

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ir_node_visitor()

Member Function Documentation

◆ allow_visiting_already_visited_type_node() [1/2]

◆ allow_visiting_already_visited_type_node() [2/2]

◆ forget_visited_type_nodes()

◆ mark_type_node_as_visited()

◆ type_node_has_been_visited()

◆ visit_begin() [1/25]

◆ visit_begin() [2/25]

◆ visit_begin() [3/25]

◆ visit_begin() [4/25]

◆ visit_begin() [5/25]

◆ visit_begin() [6/25]

◆ visit_begin() [7/25]

◆ visit_begin() [8/25]

◆ visit_begin() [9/25]

◆ visit_begin() [10/25]

◆ visit_begin() [11/25]

◆ visit_begin() [12/25]

◆ visit_begin() [13/25]

◆ visit_begin() [14/25]

◆ visit_begin() [15/25]

◆ visit_begin() [16/25]

◆ visit_begin() [17/25]

◆ visit_begin() [18/25]

◆ visit_begin() [19/25]

◆ visit_begin() [20/25]

◆ visit_begin() [21/25]

◆ visit_begin() [22/25]

◆ visit_begin() [23/25]

◆ visit_begin() [24/25]

◆ visit_begin() [25/25]

◆ visit_end() [1/25]

◆ visit_end() [2/25]

◆ visit_end() [3/25]

◆ visit_end() [4/25]

◆ visit_end() [5/25]

◆ visit_end() [6/25]

◆ visit_end() [7/25]

◆ visit_end() [8/25]

◆ visit_end() [9/25]

◆ visit_end() [10/25]

◆ visit_end() [11/25]

◆ visit_end() [12/25]

◆ visit_end() [13/25]

◆ visit_end() [14/25]

◆ visit_end() [15/25]

◆ visit_end() [16/25]

◆ visit_end() [17/25]

◆ visit_end() [18/25]

◆ visit_end() [19/25]

◆ visit_end() [20/25]

◆ visit_end() [21/25]

◆ visit_end() [22/25]

◆ visit_end() [23/25]

◆ visit_end() [24/25]

◆ visit_end() [25/25]