3#define _SAGEGENERIC_H 1
14#include <Cxx_GrammarVisitorSupport.h>
22#define WITH_BINARY_NODES 0
23#define WITH_UNTYPED_NODES 0
30#define SG_UNEXPECTED_NODE(X) (sg::unexpected_node(X, __FILE__, __LINE__))
31#define SG_DEREF(X) (sg::deref(X, __FILE__, __LINE__))
32#define SG_ASSERT_TYPE(SAGENODE, N) (sg::assert_sage_type<SAGENODE>(N, __FILE__, __LINE__))
33#define SG_ERROR_IF(COND, MSG) (sg::report_error_if(COND, MSG, __FILE__, __LINE__))
46 void unused(
const T&) {}
49 template <
class T1,
class T2>
55 template <
class T1,
class T2>
58 typedef const T2 type;
65 template <
class T,
class E>
82 void report_error(std::string desc,
const char* file =
nullptr,
size_t ln = 0);
85 void unexpected_node(
const SgNode& n,
const char* file =
nullptr,
size_t ln = 0);
90 void report_error_if(
bool iserror,
const std::string& desc,
const char* file =
nullptr,
size_t ln = 0)
94 report_error(desc, file, ln);
99 T&
deref(T* ptr,
const char* file = 0,
size_t ln = 0)
101 report_error_if(!ptr,
"assertion failed: null dereference ", file, ln);
113 template <
class U,
class T>
128 SG_ERROR_IF(ptr ==
nullptr,
"failed null pointer check.");
139 template <class U, bool = EnableConversion<U*,T*>::value>
151 operator T*()
const {
return ptr; }
168 template <class T, class U, bool = EnableConversion<U*,T*>::value || EnableConversion<T*,U*>::value>
169 bool operator<(NotNull<T> lhs, NotNull<U> rhs)
171 return lhs.pointer() < rhs.pointer();
184 template <
class _ReturnType>
187 typedef _ReturnType ReturnType;
199 operator ReturnType()
const {
return res; }
210 template <
class SageNode>
212 SageNode& assume_sage_type(
SgNode& n)
214 return static_cast<SageNode&
>(n);
219 template <
class SageNode>
221 const SageNode& assume_sage_type(
const SgNode& n)
223 return static_cast<const SageNode&
>(n);
226#define GEN_VISIT(X) \
227 void visit(X * n) { rv.handle(*n); }
229 template <
class RoseVisitor>
234 : rv(std::move(rosevisitor))
498 GEN_VISIT(SgJovialBitVal)
919 GEN_VISIT(SgAsmAarch64AtOperand)
920 GEN_VISIT(SgAsmAarch64BarrierOperand)
921 GEN_VISIT(SgAsmAarch64CImmediateOperand)
922 GEN_VISIT(SgAsmAarch64Instruction)
923 GEN_VISIT(SgAsmAarch64PrefetchOperand)
924 GEN_VISIT(SgAsmAarch64SysMoveOperand)
927 GEN_VISIT(SgAsmBinaryAddPostupdate)
928 GEN_VISIT(SgAsmBinaryAddPreupdate)
939 GEN_VISIT(SgAsmBinarySubtractPostupdate)
940 GEN_VISIT(SgAsmBinarySubtractPreupdate)
1241 template <
class RoseVisitor>
1243 typename std::remove_const<typename std::remove_reference<RoseVisitor>::type>::type
1244 _dispatch(RoseVisitor&& rv,
SgNode* n)
1246 using RoseVisitorNoref =
typename std::remove_reference<RoseVisitor>::type;
1247 using RoseHandler =
typename std::remove_const<RoseVisitorNoref>::type;
1252 std::is_lvalue_reference<RoseVisitor>()
1256 return std::move(vis).rv;
1328 template <
class RoseVisitor>
1330 typename std::remove_const<typename std::remove_reference<RoseVisitor>::type>::type
1334 return _dispatch(std::forward<RoseVisitor>(rv), n);
1337 template <
class RoseVisitor>
1339 typename std::remove_const<typename std::remove_reference<RoseVisitor>::type>::type
1343 return _dispatch(std::forward<RoseVisitor>(rv),
const_cast<SgNode*
>(n));
1355 template <
class SageNode>
1358 void handle(SageNode&) {}
1368 template <
class AncestorNode,
class QualSgNode>
1372 typedef std::pair<AncestorNode*, QualSgNode*> Pair;
1377 :
Base(), res(
nullptr,
nullptr)
1384 void handle(QualSgNode& n) { res.second = n.get_parent(); }
1385 void handle(AncestorNode& n) { res.first = &n; }
1387 operator Pair()
const {
return res; }
1392 template <
class AncestorNode,
class QualSgNode>
1397 typename AncestorFinder::Pair res(
nullptr, n.get_parent());
1399 while (res.second !=
nullptr)
1401 res = (
typename AncestorFinder::Pair)
sg::dispatch(AncestorFinder(), res.second);
1418 template <
class AncestorNode>
1421 if (n ==
nullptr)
return nullptr;
1423 return _ancestor<AncestorNode>(*n);
1427 template <
class AncestorNode>
1430 if (n ==
nullptr)
return nullptr;
1432 return _ancestor<const AncestorNode>(*n);
1436 template <
class AncestorNode>
1439 AncestorNode* res = _ancestor<AncestorNode>(n);
1446 template <
class AncestorNode>
1449 const AncestorNode* res = _ancestor<const AncestorNode>(n);
1459 template <
class SageNode>
1460 struct TypeRecoveryHandler
1462 typedef typename ConstLike<SageNode, SgNode>::type SgBaseNode;
1464 TypeRecoveryHandler(
const char* f = 0,
size_t ln = 0)
1465 : res(nullptr), loc(f), loc_ln(ln)
1468 TypeRecoveryHandler(TypeRecoveryHandler&&) =
default;
1469 TypeRecoveryHandler& operator=(TypeRecoveryHandler&&) =
default;
1471 operator SageNode* ()&& {
return res; }
1473 void handle(SgBaseNode& n) { unexpected_node(n, loc, loc_ln); }
1474 void handle(SageNode& n) { res = &n; }
1481 TypeRecoveryHandler() =
delete;
1482 TypeRecoveryHandler(
const TypeRecoveryHandler&) =
delete;
1483 TypeRecoveryHandler& operator=(
const TypeRecoveryHandler&) =
delete;
1496 template <
class SageNode>
1499 return sg::dispatch(TypeRecoveryHandler<SageNode>(f, ln), n);
1502 template <
class SageNode>
1505 return sg::dispatch(TypeRecoveryHandler<const SageNode>(f, ln), n);
1508 template <
class SageNode>
1511 return *
sg::dispatch(TypeRecoveryHandler<SageNode>(f, ln), &n);
1514 template <
class SageNode>
1517 return *
sg::dispatch(TypeRecoveryHandler<const SageNode>(f, ln), &n);
1521 template <
class SageNode>
1525 void handle(SageNode& n) { this->res = &n; }
1529 template <
class SageNode>
1536 template <
class SageNode,
class... SageNodes>
1539 if (SageNode* parent = ancestor_path<SageNode>(n))
1540 return ancestor_path<SageNodes...>(*parent);
1550 template <
class SageNode>
1557 template <
class SageNode,
class... SageNodes>
1560 if (SageNode* parent = ancestorPath<SageNode>(n))
1561 return ancestorPath<SageNodes...>(*parent);
1583 void swap_parent(
void*,
void*) {}
1592 template <
class SageNode,
class SageChild>
1593 void swap_child(SageNode& lhs, SageNode& rhs, SageChild* (SageNode::*getter) () const, void (SageNode::*setter) (SageChild*))
1595 SageChild* lhs_child = (lhs.*getter)();
1596 SageChild* rhs_child = (rhs.*getter)();
1597 ROSE_ASSERT(lhs_child && rhs_child);
1599 (lhs.*setter)(rhs_child);
1600 (rhs.*setter)(lhs_child);
1602 swap_parent(lhs_child, rhs_child);
1605 template <
class GVisitor>
1610 : gvisitor(std::move(gv))
1613 void operator()(
SgNode* n)
1615 if (n !=
nullptr) gvisitor =
sg::dispatch(std::move(gvisitor), n);
1618 operator GVisitor()&& {
return std::move(gvisitor); }
1624 template <
class GVisitor>
1627 dispatchHelper(GVisitor gv)
1634 SgNodePtrList operator()(
SgNode& n)
const
1640 template <
class GVisitor,
class SuccessorGenerator = DefaultTraversalSuccessors>
1642 GVisitor traverseChildren( GVisitor gv,
SgNode& n, SuccessorGenerator gen = {} )
1644 SgNodePtrList
const successors = gen(n);
1646 return std::for_each( successors.begin(), successors.end(),
1647 dispatchHelper(std::move(gv))
1651 template <
class GVisitor>
1653 GVisitor traverseChildren(GVisitor gv,
SgNode* n)
1655 return traverseChildren(gv,
sg::deref(n));
1658 template <
class SageParent,
class SageChild>
1659 void linkParentChild(SageParent& parent, SageChild& child,
void (SageParent::*setter)(SageChild*))
1661 (parent.*setter)(&child);
1662 child.set_parent(&parent);
1668 template <
class SageNode>
1669 typename SageNode::base_node_type&
1672 template <
class SageNode>
1673 const typename SageNode::base_node_type&
1676 template <
class SageNode>
1677 typename SageNode::base_node_type*
1680 template <
class SageNode>
1681 const typename SageNode::base_node_type*
1693 template <
class SageNode>
1694 struct TraversalFunction
1696 typedef void (*TransformHandlerFn)(SageNode*);
1699 TraversalFunction(TransformHandlerFn fun)
1704 void handle(SageNode& n) { fn(&n); }
1706 TransformHandlerFn fn;
1711 template <
class SageNode>
1713 TraversalFunction<SageNode>
1714 createTraversalFunction(
void (* fn)(SageNode*))
1716 return TraversalFunction<SageNode>(fn);
1724 template <
class GVisitor>
1728 TraversalClass(GVisitor gv)
1739 GVisitor visitor() {
return gvisitor; }
1755 forAllNodes(F fn,
SgNode* root, AstSimpleProcessing::Order order = postorder)
1759 TraversalClass<F> tt(fn);
1762 tt.traverse(root, order);
1763 return tt.visitor();
1766 template <
class SageNode>
1769 forAllNodes(
void (*fn)(SageNode*),
SgNode* root, AstSimpleProcessing::Order order = postorder)
1771 forAllNodes(createTraversalFunction(fn), root, order);
1776 std::string nodeType(
const SgNode& n)
1778 return typeid(n).name();
1782 std::string nodeType(
const SgNode* n)
1784 if (n ==
nullptr)
return "<null>";
1786 return nodeType(*n);
Class for traversing the AST.
virtual void visit(SgNode *astNode)=0
this method is called at every traversed node.
String associated with a binary file.
Expression that adds two operands.
Expression that performs an arithmetic, sign-bit preserving right shift.
Expression that divides the first operand by the second.
Base class for binary expressions.
Expression that performs a logical left shift operation.
Expression that performs a logical, sign-bit non-preserving right shift.
Expression that returns the remainder when dividing the first operand by the second.
Expression that performs a logical left shift operation filling low-order bits with one.
Expression that multiplies two operands.
Expression that performs a right rotate.
Expression that subtracts the second operand from the first.
CIL AssemblyOS node (II.22.3).
CIL AssemblyProcessor node (II.22.4).
CIL AssemblyRefOS node (II.22.6).
CIL AssemblyRefProcessor node (II.22.7).
CIL AssemblyRef node (II.22.5).
CIL Assembly node (II.22.2).
CIL ClassLayout node (II.22.8).
CIL Constant node (II.22.9).
CIL CustomAttribute node (II.22.10).
Base class for CIL branch of binary analysis IR nodes.
CIL DeclSecurity node (II.22.11).
CIL EventMap node (II.22.12).
CIL Event node (II.22.13).
CIL ExportedType node (II.22.14).
CIL FieldLayout node (II.22.16).
CIL FieldMarshal node (II.22.17).
CIL FieldRVA node (II.22.18).
CIL Field node (II.22.15).
CIL File node (II.22.19).
CIL GenericParamConstraint node (II.22.21).
CIL GenericParam node (II.22.20).
CIL ImplMap node (II.22.22).
CIL InterfaceImpl node (II.22.23).
CIL ManifestResource node (II.22.24).
CIL MemberRef node (II.22.25).
CIL MethodDef node (II.22.26).
CIL MethodImpl node (II.22.27).
CIL MethodSemantics node (II.22.28).
CIL MethodSpec node (II.22.29).
CIL ModuleRef node (II.22.31).
CIL Module node (II.22.30).
CIL NestedClass node (II.22.32).
Base class for CIL branch of binary analysis IR nodes.
CIL Param node (II.22.33).
CIL PropertyMap node (II.22.35).
CIL Property node (II.22.34).
CIL StandAloneSig node (II.22.36).
CIL TypeDef node (II.22.37).
CIL TypeRef node (II.22.38).
CIL TypeSpec node (II.22.39).
Base class for CIL branch of binary analysis IR nodes.
Base class for CIL branch of binary analysis IR nodes.
COFF symbol string table.
Base class for constants.
Expression representing a machine register.
List of dynamic linking section entries.
One entry from the dynamic linking table.
ELF section containing dynamic linking information.
List of ELF EH frame CI entries.
ELF error handling frame entry, common information entry.
List of ELF error handling frame descriptor entries.
ELF error handling frame entry frame description entry.
Represents an ELF EH frame section.
Node to hold list of ELF note entries.
One entry of an ELF notes table.
List of ELF relocation entries.
One entry of an ELF relocation table.
Represents an ELF relocation section.
Represents one entry in an ELF section table.
Represents an ELF section table.
Base class for ELF file sections.
Represents one entry of a segment table.
Represents an ELF segment table.
ELF string table section.
ELF file section containing symbols.
Represents a single ELF symbol.
List of symbol version aux entries.
Auxiliary data for an ELF Symbol Version.
List of entries for the ELF symbol version definition table.
One entry from an ELF symbol version definition table.
The GNU symbol version definitions.
List of entries from a symbol version table.
Entry in an ELF symbol version table.
Hods a list of symbol version aux entries.
Auxiliary info for needed symbol version.
List of symbol version needed entries.
One entry of the ELF symbol version needed table.
GNU symbol version requirements table.
The ELF symbol version table.
List of expression nodes.
Base class for expressions.
Represents a synthesized function.
List of pointers to other nodes.
Base class for dynamically linked library information.
List of AST file node pointers.
Base class for binary files.
List of pointers to file sections.
Contiguous region of a file.
Base class for strings related to binary specimens.
Base class for string tables.
Node to hold a list of symbol node pointers.
Registers accessed indirectly.
List of SgAsmInstruction nodes.
Base class for machine instructions.
Base class for integer values.
Represents an interpretation of a binary container.
JVM LocalVariableTable attribute.
JVM LocalVariableTypeEntry.
JVM LocalVariableTypeTable attribute.
JVM MethodParametersEntry.
JVM MethodParameters attribute.
JVM ModuleMainClass attribute.
Reference to memory locations.
Represents one MIPS machine instruction.
Base class for all binary analysis IR nodes.
List of operands for an instruction.
List of pointers to other AST nodes.
A list of PE Import Directories.
One import directory per library.
A list of imported items.
A single imported object.
Portable Executable Import Section.
List of SgAsmPERVASizePair AST nodes.
Base class for PE sections.
Represents one PowerPC machine instruction.
An ordered list of registers.
Base class for references to a machine register.
Static representation of instruction semantics.
Base class for scalar types.
Base class for statement-like subclasses.
Represents static data in an executable.
This class represents the concept of a C Assembler statement.
Strings stored in an ELF or PE container.
Strings stored in an ELF or PE container.
Declaration-like nodes that encapsulate multiple instructions.
Base class for synthesized declarations.
Base class for binary types.
Base class for unary expressions.
Expression represting negation.
Expression representing a (no-op) unary plus operation.
Expression representing sign extending.
Expression representing truncation.
Expression representing unsigned extending.
Instructions defined at runtime.
Base class for vector types.
A type that doesn't represent any data.
Represents one Intel x86 machine instruction.
This class represents the rhs of a variable declaration which includes an optional assignment (e....
This class represents the concept of a block (not a basic block from control flow analysis).
This class represents the notion of a binary operator. It is derived from a SgExpression because oper...
This class represents a boolean value (expression value).
This class represents the notion of a break statement (typically used in a switch statment).
This class represents the concept of a generic call expression.
This class represents the concept of a C and C++ case option (used within a switch statement).
This class represents a cast of one type to another.
This class represents the concept of a catch within a try-catch construct used in C++ exception handl...
This class represents the concept of a C++ sequence of catch statements.
This class represents the concept of a class declaration statement. It includes the concept of an ins...
This class represents the concept of a class definition in C++.
This class represents the concept of a C++ expression built from a class name.
This class represents the concept of a class name within the compiler.
This class represents the concept of a C style extern "C" declaration. But such information (linkage)...
This class represents the concept of a C trinary conditional expression (e.g. "test ?...
This class represents the call of a class constructor to initialize a variable. For example "Foo foo;...
This class represents the concept of a C or C++ continue statement.
This class represents the concept of a contructor initializer list (used in constructor (member funct...
This class represents modifiers for SgDeclaration (declaration statements).
This class represents the concept of a declaration statement.
This class represents the concept of a C or C++ default case within a switch statement.
This class represents the concept of a C++ call to the delete operator.
This class represents a directory within a projects file structure of files and directories.
This class represents the concept of a do-while statement.
This class represents the notion of an value (expression value).
This class represents the concept of an enum declaration.
This class represents the concept of the dynamic execution of a string, file, or code object....
This class represents the concept of a C and C++ expression list.
This class represents the concept of a C or C++ statement which contains a expression.
This class represents the notion of an expression. Expressions are derived from SgLocatedNodes,...
This class represents a source file for a project (which may contian many source files and or directo...
This class represents the notion of an value (expression value).
This class represents the variable declaration or variable initialization withn a for loop.
This class represents the concept of a for loop.
This class represents the concept of a C++ function call (which is an expression).
This class represents the concept of a function declaration statement.
This class represents the concept of a scope in C++ (e.g. global scope, fuction scope,...
This class represents the concept of a declaration list.
This class represents the function being called and must be assembled in the SgFunctionCall with the ...
This class represents the concept of a name and a type. It may be renamed in the future to SgTypeSymb...
This class represents the function type table (stores all function types so that they can be shared i...
This class represents a type for all functions.
This class represents the concept of a namespace definition.
This class represents the concept of a C or C++ goto statement.
This class represents the concept of an "if" construct.
This class represents the notion of a declared variable.
This class represents the notion of an initializer for a variable declaration or expression in a func...
This class represents the physical disequality (often called pointer disequality) operator for langua...
This class represents the physical equality (often called pointer equality) operator for languages th...
This class represents the concept of a C or C++ label statement.
This class represents a lambda expression.
This class represents a list display.
This class represents the notion of an expression or statement which has a position within the source...
This class represents the notion of an value (expression value).
This class represents the concept of a member function declaration statement.
This class represents the member function being called and must be assembled in the SgFunctionCall wi...
This class represents the numeric negation of a value. Not to be confused with SgSubtractOp.
This class is not used in ROSE, but is intended to represent a list of SgModifierTypes (similar to th...
This class represents the base class of a number of IR nodes define modifiers within the C++ grammar.
This class represents strings within the IR nodes.
This class represents the concept of a C++ namespace alias declaration statement.
This class represents the concept of a C++ namespace declaration.
This class represents the concept of a namespace definition.
This class represents the concept of a namespace name within the compiler.
This class represents the notion of an n-ary boolean operation. This node is intended for use with Py...
This class represents the notion of an n-ary comparison operation. This node is intended for use with...
This class represents the notion of an n-ary operator. This node is intended for use with Python.
This class represents the concept of a C++ call to the new operator.
This class represents the base class for all IR nodes within Sage III.
SgNode * get_parent() const
Access function for parent node.
void set_parent(SgNode *parent)
All nodes in the AST contain a reference to a parent node.
virtual std::vector< SgNode * > get_traversalSuccessorContainer()
container of pointers to AST successor nodes used in the traversal overridden in every class by gener...
virtual void accept(ROSE_VisitorPattern &visitor)
support for the classic visitor pattern done in GoF
This class represents an object used to initialize the unparsing.
This class represents a Fortran pointer assignment. It is not some weird compound assignment operator...
This class represents the concept of a C Assembler statement (untested).
This class represents a source project, with a list of SgFile objects and global information about th...
This class represents the concept of a 'global' stmt in Python.
This class represents a OLD concept of the structure require for qualified names when they were in th...
This class represents a OLD concept of the structure require for qualified names when they were in th...
This class represents the "&" operator (applied to any lvalue).
This class represents the concept of a C Assembler statement (untested).
This class was part of CC++ support from a long time ago.
This class represents the concept of a scope in C++ (e.g. global scope, fuction scope,...
This class represents the "sizeof()" operator (applied to any type).
This class is part of the older CC++ concept. It is not a part of C or C++ (this IR node is not used ...
This class represents the GNU extension "statement expression" (thus is non-standard C and C++).
This class represents the notion of a statement.
This class is intended to be a wrapper around SgStatements, allowing them to exist in scopes that onl...
This class represents modifiers specific to storage.
This class represents the conversion of an arbitrary expression to a string. This node is intended fo...
This class represents the base class of a numbr of IR nodes that don't otherwise fit into the existin...
This class represents the concept of a switch.
This class represents the symbol tables used in both SgScopeStatement and the SgFunctionTypeSymbolTab...
This class represents the concept of a name within the compiler.
This class represents template argument within the use of a template to build an instantiation.
This class represents the concept of a template declaration.
This class represents the concept of an instantiated class template.
This class represents the concept of a class definition in C++.
This class represents the concept of a C++ template instantiation directive.
This class represents the concept of an instantiation of function template.
This class represents the concept of an instantiation of member function template or a member functio...
This class represents the "this" operator (can be applied to any member data).
This class represents the C++ throw expression (handled as a unary operator).
This class represents the concept of try statement within the try-catch support for exception handlin...
This class represents a tuple display.
This class represents a C99 complex type.
This class represents a default type used for some IR nodes (see below).
This class represents a C99 complex type.
This class represents a string type used for SgStringVal IR node.
This class represents the base class for all types.
This class represents the notion of a typedef declaration.
This class represents a list of associated typedefs for the SgType IR nodes which reference this list...
This class represents the notion of a unary operator. It is derived from a SgExpression because opera...
This class represents the concept of a C++ using declaration.
This class represents the concept of a C++ using directive.
This class represents the notion of an value (expression value).
This class represents the variable refernece in expressions.
This class represents the concept of a C or C++ variable declaration.
This class represents the definition (initialization) of a variable.
This class represents the concept of a variable name within the compiler (a shared container for the ...
This class represents the concept of a do-while statement.
This class represents the location of the code associated with the IR node in the original source cod...
This namespace contains template functions that operate on the ROSE AST.
AncestorNode * _ancestor(QualSgNode &n)
implements the ancestor search
void swap_child(SageNode &lhs, SageNode &rhs, SageChild *(SageNode::*getter)() const, void(SageNode::*setter)(SageChild *))
swaps children (of equal kind) between two ancestor nodes of the same type
auto ancestor_path(const SgNode &n) -> SageNode *
std::remove_const< typenamestd::remove_reference< RoseVisitor >::type >::type dispatch(RoseVisitor &&rv, SgNode *n)
uncovers the type of SgNode and passes it to an function "handle" in RoseVisitor.
SageNode * assert_sage_type(SgNode *n, const char *f=0, size_t ln=0)
asserts that n has type SageNode
T & deref(T *ptr, const char *file=0, size_t ln=0)
dereferences an object (= checked dereference in debug mode)
AncestorNode * ancestor(SgNode *n)
finds an ancestor node with a given type
auto ancestorPath(const SgNode &n) -> SageNode *
returns the last parent in an ancestor path
SageNode::base_node_type & asBaseType(SageNode &n)
returns the same node n upcasted to its base type
helper class for _ancestor
projects the constness of T1 on T2
experimental class for returning non-null pointers
NotNull(NotNull< U > nn)
converting ctor for derived types and non-const versions of T
T * operator->() const
arrow operator returns pointer to object
T * pointer() const
explicit conversion operator
NotNull(T *p)
standard constructor testing that p is not nullptr
T & operator*() const
dereference operator returns reference to object
