ROSE 0.11.145.147
SgAsmJvmClass.h
1
2#ifndef ROSE_SgAsmJvmClass_H
3#define ROSE_SgAsmJvmClass_H
4#include <RoseFirst.h>
5#include <Cxx_GrammarDeclarations.h>
6#include <SgAsmJvmNode.h>
7
8
9
10/* #line 1 "/workspace/src/ROSETTA/Grammar/grammarClassDeclarationMacros.macro" */
11
12// WARNING -- GENERATED CODE -- DO NOT MODIFY THIS CODE -- WARNING!
13// This code is automatically generated for each
14// terminal and non-terminal within the defined
15// grammar. There is a simple way to change the
16// code to fix bugs etc. See the ROSE README file
17// for directions.
18
19// tps: (02/22/2010): Adding DLL export requirements
20#include "rosedll.h"
21
22// predeclarations for SgAsmJvmClass
23
24/* #line 25 "../../../src/frontend/SageIII//SgAsmJvmClass.h" */
25
26/* #line 13 "/workspace/src/ROSETTA/Grammar/grammarClassDeclarationMacros.macro after subst for $PREDECLARATIONS" */
27
28/* #line 14 "/workspace/src/ROSETTA/Grammar/grammarClassDeclarationMacros.macro" */
29
30#if !defined(DOCUMENTATION)
31// Class Definition for SgAsmJvmClass
32class ROSE_DLL_API SgAsmJvmClass : public SgAsmJvmNode
33 {
34 public:
35
36
37/* #line 38 "../../../src/frontend/SageIII//SgAsmJvmClass.h" */
38
39 virtual SgNode* copy ( SgCopyHelp& help) const override;
40// Start of memberFunctionString
41/* #line 13466 "/workspace/src/ROSETTA/src/binaryInstruction.C" */
42
43
44 //----------------------- Boost serialization for SgAsmJvmClass -----------------------
45#ifdef ROSE_HAVE_BOOST_SERIALIZATION_LIB
46private:
47 friend class boost::serialization::access;
48
49 template<class S>
50 void serialize(S &s, const unsigned /*version*/) {
51 debugSerializationBegin("SgAsmJvmClass");
52 s & BOOST_SERIALIZATION_BASE_OBJECT_NVP(SgAsmJvmNode);
53 debugSerializationEnd("SgAsmJvmClass");
54 }
55#endif // ROSE_HAVE_BOOST_SERIALIZATION_LIB
56
57public:
59 virtual ~SgAsmJvmClass();
60
61public:
64
65protected:
73
74
75// End of memberFunctionString
76// Start of memberFunctionString
77/* #line 1 "/workspace/src/ROSETTA/Grammar/Common.code" */
78
79// *** COMMON CODE SECTION BEGINS HERE ***
80
81 public:
82
83 // DQ (3/25/3006): I put this back in because it had the logic for where the copy function required
84 // and not required which is required to match the other aspects of the copy mechanism code generation.
85 // Specifically it is a problem to declare the copy function everywhere because it is not implemented
86 // for the SgSymbol IR nodes. I'm not clear why it is not implemented for these IR nodes.
87 /* \brief Copies AST (whole subtree, depending on the SgCopyHelp class */
88 // virtual SgNode* copy ( const SgCopyHelp & help) const;
89
91 virtual std::string class_name() const override;
92
94 virtual VariantT variantT() const override; // MS: new variant used in tree traversal
95
97 // King84 (2010.08.16): Moved this to an enum to save space, since it's only used at compiler-time anyway.
98 // static const VariantT static_variant = V_SgAsmJvmClass;
99 enum { static_variant = V_SgAsmJvmClass };
100
101 /* the generated cast function */
103 ROSE_DLL_API friend SgAsmJvmClass* isSgAsmJvmClass( SgNode * s );
104
106 ROSE_DLL_API friend const SgAsmJvmClass* isSgAsmJvmClass( const SgNode * s );
107
108 // ******************************************
109 // * Memory Pool / New / Delete
110 // ******************************************
111
112 public:
114 static const unsigned pool_size; //
116 static std::vector<unsigned char *> pools; //
118 static SgAsmJvmClass * next_node; //
119
121 static unsigned long initializeStorageClassArray(SgAsmJvmClassStorageClass *); //
122
124 static void clearMemoryPool(); //
125 static void deleteMemoryPool(); //
126
128 static void extendMemoryPoolForFileIO(); //
129
131 static SgAsmJvmClass * getPointerFromGlobalIndex(unsigned long); //
133 static SgAsmJvmClass * getPointerFromGlobalIndex(AstSpecificDataManagingClass *, unsigned long); //
134
136 static unsigned long getNumberOfValidNodesAndSetGlobalIndexInFreepointer(unsigned long); //
138 static void resetValidFreepointers(); //
140 static unsigned long getNumberOfLastValidPointer(); //
141
142
143#if defined(INLINE_FUNCTIONS)
145 inline void *operator new (size_t size);
146#else
148 void *operator new (size_t size);
149#endif
151 void operator delete (void* pointer, size_t size);
152
153 // DQ (4/5/2007): This is not the correct operator that we want, but appears to be required to compile ROSE with ROSE.
154 void operator delete (void* pointer)
155 {
156 // This is the generated delete operator...
157 SgAsmJvmClass::operator delete (pointer,sizeof(SgAsmJvmClass));
158 }
159
161 static size_t numberOfNodes();
162
164 static size_t memoryUsage();
165
166 // End of scope which started in IR nodes specific code
167 /* */
168
169 /* name Internal Functions
170 \brief Internal functions ... incomplete-documentation
171
172 These functions have been made public as part of the design, but they are suggested for internal use
173 or by particularly knowledgeable users for specialized tools or applications.
174
175 \internal We could not make these private because they are required by user for special purposes. And
176 it would be unwieldy to have many of the internal classes in ROSE be explicitly defined as friends.
177
178 */
179
180 // MS: 02/12/02 container of pointers to AST successor nodes used in the traversal
181 // overridden in every class by *generated* implementation
183 virtual std::vector<SgNode*> get_traversalSuccessorContainer() override;
184 // MS: 06/28/02 container of names of variables or container indices
185 // used used in the traversal to access AST successor nodes
186 // overridden in every class by *generated* implementation
189 virtual std::vector<std::string> get_traversalSuccessorNamesContainer() override;
190
191 // GB (09/25/2007): Functions for index-based access to traversal successors; these are hopefully a lot faster
192 // than all the vector copies. The implementation for these functions is generated for each class.
194 virtual size_t get_numberOfTraversalSuccessors() override;
196 virtual SgNode *get_traversalSuccessorByIndex(size_t idx) override;
198 virtual size_t get_childIndex(SgNode *child) override;
199
200#ifndef ROSE_USE_INTERNAL_FRONTEND_DEVELOPMENT
201 // MS: 08/16/2002 method for generating RTI information
203 virtual RTIReturnType roseRTI() override;
204#endif
205 /* */
206
207
208
209 /* name Deprecated Functions
210 \brief Deprecated functions ... incomplete-documentation
211
212 These functions have been deprecated from use.
213 */
214 /* */
215
217 virtual const char* sage_class_name() const override ROSE_DEPRECATED_FUNCTION;
218
219 // JJW (10/16/2008): Changed to a single function in Node.code, and put
220 // getVariant() in #if 0 block to prevent confusing Doxygen
221#if 0
223 virtual int variant() const ROSE_DEPRECATED_FUNCTION;
225 // virtual int getVariant() const ROSE_DEPRECATED_FUNCTION;
226#endif
227 /* */
228
229
230
231
232 public:
233 /* name Traversal Support Functions
234 \brief Traversal support functions ... incomplete-documentation
235
236 These functions have been made public as part of the design, but they are suggested for internal use
237 or by particularly knowledgable users for specialized tools or applications.
238 */
239 /* */
240
241 // DQ (11/26/2005): Support for visitor pattern mechanims
242 // (inferior to ROSE traversal mechanism, experimental).
246
247 /* DXN (08/09/2010): support for the classic visitor pattern done in GoF */
249 virtual void accept (ROSE_VisitorPattern & visitor) override;
250
251 // DQ (12/26/2005): Support for traversal based on the memory pool
254 static void traverseMemoryPoolNodes(ROSE_VisitTraversal & visit);
255
259
260 // DQ (2/9/2006): Added to support traversal over single representative of each IR node
261 // This traversal helps support internal tools that call static member functions.
262 // note: this function operates on the memory pools.
265 static void visitRepresentativeNode (ROSE_VisitTraversal & visit);
266 /* */
267
268 public:
269 /* NodeId support functions */
271 static SgNode* getNodeByNodeId(VariantT variantT, size_t poolIdx, size_t itemIdx);
274 static SgAsmJvmClass* getNodeByNodeIdInternal(size_t poolIdx, size_t itemIdx);
277 static std::string getNodeIdString(SgAsmJvmClass* sgnode);
278 static std::string getNodeIdStringInternal(SgAsmJvmClass* sgnode);
279
280 public:
281 /* name Memory Allocation Functions
282 \brief Memory allocations functions ... incomplete-documentation
283
284 These functions have been made public as part of the design, but they are suggested for internal use
285 or by particularly knowledgable users for specialized tools or applications.
286 */
287 /* */
288
299 virtual bool isInMemoryPool() override;
300
311 virtual void checkDataMemberPointersIfInMemoryPool() override;
312
313 // DQ (4/30/2006): Modified to be a const function.
328 virtual std::vector<std::pair<SgNode*,std::string> > returnDataMemberPointers() const override;
329
340
352 virtual long getChildIndex( SgNode* childNode ) const override;
353
354 // DQ (9/2/2015): Since this function is generated by ROSETTA, we can't define the
355 // comment here (changed to be a C style comment and not be a doxygen comment).
356 /* \brief Constructor for use by AST File I/O Mechanism
357
358 This constructor permits the IR node to be rebuilt from the contiguously arranged data in memory
359 which obtained via fast binary file I/O from disk.
360 */
361 // SgAsmJvmClass( SgAsmJvmClassStorageClass& source );
362
363
364
365
366
367 // JH (10/24/2005): methods added to support the ast file IO
368 private:
369
370 /* name AST Memory Allocation Support Functions
371 \brief Memory allocations support....
372
373 These functions handle the low leve support of the memory allocation scheme which permits IR nodes to be allocated
374 in large contiguous blocks to reduce memory fragmentation, improve performance, support specialized access (AST traversals),
375 and support the AST File I/O Mechanism.
376 */
377 /* */
378
379 /* JH (10/24/2005): Two typedefs. The TestType notes the type every pointer is cast to before
380 we compare them. Since I had several problems with this, I decided to make a typdef to ensure
381 that I use the same type everywhere, if any changes are made. THe second one declares the type
382 (actually unsigned long) where teh pointer address gets converted to. On 64 bit platforms this
383 might got changed, but unfortunatly, the return types are still unsigned longs. There exists
384 a correspinding one in the AST_FILE_IO class!
385 */
386 // DQ (9/2/2015): This typedef is no longer used, we can't define the
387 // comment here (changed to be a C style comment and not be a doxygen comment).
388 /* \brief Typedef used for low level memory access.
389 */
390 // typedef unsigned char* TestType;
391
392 // DQ (9/2/2015): This typedef is no longer used, we can't define the
393 // comment here (changed to be a C style comment and not be a doxygen comment).
394 /* \brief Typedef used to hold memory addresses as values.
395 */
396 // typedef unsigned long AddressType;
397
398
399
400 // necessary, to have direct access to the p_freepointer and the private methods !
402 friend class AST_FILE_IO;
403
405 friend class SgAsmJvmClassStorageClass;
406
408 friend class AstSpecificDataManagingClass;
409
411 friend class AstSpecificDataManagingClassStorageClass;
412 public:
414 SgAsmJvmClass( const SgAsmJvmClassStorageClass& source );
415
416 // private: // JJW hack
417 /*
418 name AST Memory Allocation Support Variables
419 Memory allocations support variables
420
421 These variables handle the low level support of the memory allocation scheme which permits IR nodes to be allocated
422 in large contiguous blocks to reduce memory fragmentation, improve performance, support specialized access (AST traversals),
423 and support the AST File I/O Mechanism.
424 */
425 /* */
426
427 public:
428
429 // DQ (11/21/2009): Added function to add new Regular Expression attributes and return pointer
430 // to current node (so that it will work cleanly with build functions to specify patterns).
431 // virtual SgNode* addRegExpAttribute();
438
439#ifndef _MSC_VER
440// Rasmussen (04/17/2019): Support for ATerms has been deprecated as it is no longer needed
441// and likely never fully implemented nor tested. Files remain in the src tree but are no
442// longer built.
443#define BUILD_ATERM_SUPPORT 0
444 #if BUILD_ATERM_SUPPORT
445 #ifdef ROSE_USE_ROSE_ATERM_SUPPORT
446 // DQ (10/4/2014): Adding ATerm support to ROSE.
456 // Rasmussen (1/7/2019): Added override to kill warning messages of overridden virtual function
457 virtual ATerm generate_ATerm() override;
458
460 virtual void generate_ATerm_Annotation(ATerm & term) override;
461 #endif
462 #endif // BUILD_ATERM_SUPPORT
463#endif
464 // These can't be virtual functions since we don't yet know what IR node to build (until we have read the aterm).
465 // virtual generate_AST(ATerm & term);
466 // virtual void read_ATerm_Annotation(ATerm & term);
467
468// *** COMMON CODE SECTION ENDS HERE ***
469
470
471// End of memberFunctionString
472// Start of memberFunctionString
473/* #line 706 "/workspace/src/ROSETTA/Grammar/Node.code" */
474
475 // the generated cast function
476 // friend ROSE_DLL_API SgAsmJvmClass* isSgAsmJvmClass ( SgNode* s );
477
478 typedef SgAsmJvmNode base_node_type;
479
480
481// End of memberFunctionString
482
483 protected:
484
486
487/* #line 21 "/workspace/src/ROSETTA/Grammar/grammarClassDeclarationMacros.macro" */
488
489
490 };
491#endif
492
493// postdeclarations for SgAsmJvmClass
494
495/* #line 496 "../../../src/frontend/SageIII//SgAsmJvmClass.h" */
496
497/* #line 27 "/workspace/src/ROSETTA/Grammar/grammarClassDeclarationMacros.macro after subst for $POSTDECLARATIONS" */
498
499/* #line 28 "/workspace/src/ROSETTA/Grammar/grammarClassDeclarationMacros.macro" */
500
501
502/* #line 503 "../../../src/frontend/SageIII//SgAsmJvmClass.h" */
503
504#endif // ROSE_SgAsmJvmClass_H
505
Class holding static data and functions supporting File I/O.
Definition AST_FILE_IO.h:19
Attribute containing a regex expression as a string.
Base class for JVM branch of binary analysis IR nodes.
void initializeProperties()
Initialize all properties that have explicit initial values.
Supporting class from copy mechanism within ROSE.
Definition sageCopy.h:26
This class represents the base class for all IR nodes within Sage III.
virtual size_t get_numberOfTraversalSuccessors()
return number of children in the traversal successor list
virtual RTIReturnType roseRTI()
return C++ Runtime-Time-Information
virtual std::vector< std::string > get_traversalSuccessorNamesContainer()
container of names of variables or container indices used used in the traversal to access AST success...
virtual void debugSerializationEnd(const char *className)
Called by generated serializers.
static std::string getNodeIdString(SgNode *sgnode)
compute the NodeId for a particular SgNode*.
virtual bool isInMemoryPool()
FOR INTERNAL USE This is used in internal tests to verify that all IR nodes are allocated from the he...
int variant() const
Older version function returns enum value "NODE".
virtual void processDataMemberReferenceToPointers(ReferenceToPointerHandler *)
FOR INTERNAL USE Processes pairs of references to SgNode* and strings for use in AST tools
virtual VariantT variantT() const
returns new style SageIII enum values
virtual long getChildIndex(SgNode *childNode) const
FOR INTERNAL USE Returns a unique index value for the childNode in the list of children at this IR no...
virtual size_t get_childIndex(SgNode *child)
index-based access to traversal successors by child node
virtual void debugSerializationBegin(const char *className)
Called by generated serializers.
virtual std::vector< SgNode * > get_traversalSuccessorContainer()
container of pointers to AST successor nodes used in the traversal overridden in every class by gener...
virtual std::string class_name() const
returns a string representing the class name
static void visitRepresentativeNode(ROSE_VisitTraversal &visit)
FOR INTERNAL USE Support for type-based traversal.
virtual void checkDataMemberPointersIfInMemoryPool()
FOR INTERNAL USE This is used in internal tests to verify that all IR nodes are allocated from the he...
static size_t numberOfNodes()
Returns the total number of IR nodes of this type.
virtual void accept(ROSE_VisitorPattern &visitor)
support for the classic visitor pattern done in GoF
virtual SgNode * get_traversalSuccessorByIndex(size_t idx)
index-based access to traversal successors by index number
static void traverseMemoryPoolVisitorPattern(ROSE_VisitorPattern &visitor)
FOR INTERNAL USE Support for visitor pattern.
void executeVisitorMemberFunction(ROSE_VisitorPattern &visitor)
FOR INTERNAL USE Support for visitor pattern.
static SgNode * getNodeByNodeId(VariantT variantT, size_t poolIdx, size_t itemIdx)
Find a node by its variant type, pool index, and item index.
static size_t memoryUsage()
Returns the size in bytes of the total memory allocated for all IR nodes of this type.
static void traverseMemoryPoolNodes(ROSE_VisitTraversal &visit)
FOR INTERNAL USE Support for visitor pattern over all IR nodes by type of IR node.
virtual const char * sage_class_name() const
generates string representing the class name: (e.g. for SgNode returns "SgNode").
virtual std::vector< std::pair< SgNode *, std::string > > returnDataMemberPointers() const
FOR INTERNAL USE Returns STL vector of pairs of SgNode* and strings for use in AST tools
static SgNode * getNodeByNodeIdInternal(size_t poolIdx, size_t itemIdx)
FOR INTERNAL USE Find an SgNode from its memory pool and location therin.
SgNode * addRegExpAttribute(std::string s, AstRegExAttribute *a)
Support for AST matching using regular expression.
void serialize(std::ostream &output, Graph &graph)
Serialize a graph into a stream of bytes.
void copy(const Word *src, const BitRange &srcRange, Word *dst, const BitRange &dstRange)
Copy some bits.