1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
// -*- mode: C++ -*-
//
// Copyright (C) 2013-2025 Red Hat, Inc.
/// @file
#ifndef __ABG_TRAVERSE_H__
#define __ABG_TRAVERSE_H__
#include "abg-fwd.h"
namespace abigail
{
namespace ir
{
/// The base class for the visitor type hierarchy used for traversing
/// a hierarchy of nodes.
///
/// Client code willing to get notified for a certain kind of node
/// during traversal might want to define a visitor class that inherit
/// \a node_visitor, define and overload a node_visitor::visit method
/// for it, like what is done for the ir_node_visitor::visit set of
/// functions, for traversing internal representation nodes.
struct node_visitor_base
{};
/// The interface for types which are feeling social and want to be
/// visited during the traversal of a hierarchy of nodes.
///
/// It is expected that classes derived from traversable_base define a
/// traverse method specialised to the node *visitor* type. Such
/// methods should visit nodes recursively, calling
/// ir_node_visitor::visit for each node. The method should return
/// true until all nodes have been visited.
class traversable_base
{
struct priv;
std::unique_ptr<priv> priv_;
protected:
traversable_base();
bool visiting() const;
void visiting(bool f);
public:
virtual ~traversable_base();
/// This virtual method is overloaded and implemented by any single
/// type which instance is going to be visited during the traversal
/// of translation unit nodes.
///
/// The method visits a given node and, for scopes, visits their
/// member nodes. Visiting a node means calling the
/// ir_node_visitor::visit method with the node passed as an
/// argument.
///
/// @param v the visitor used during the traverse.
///
/// @return true if traversed until the end of the type tree, false
/// otherwise.
///
/// Note that each class that derives from this one and overloads
/// this method will have to define a type for its node visitor
/// argument (the one named v). That type will have to derive from
/// the node_visitor_base type. In that sense, this new overload
/// method will "hide" this one. That is why we are keeping this
/// method commented, for documentation purposes.
// virtual bool traverse(node_visitor_base& v);
}; // end class traversable_base
}// end namespace ir.
}//end namespace abigail
#endif //__ABG_TRAVERSE_H__
|
