libabigail
Public Member Functions | List of all members
ir_node_visitor Class Reference

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:
[legend]

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 4887 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 27697 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 27718 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
fif true, then the walker using this visitor is allowed to re-visit a type node that was previously visited.

Definition at line 27709 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 27752 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
pthe type to mark as having been visited.

Definition at line 27728 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
pthe 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 27762 of file abg-ir.cc.

The documentation for this class was generated from the following files:
Generated by doxygen 1.9.1