ROSE 0.11.145.192
SgAsmJvmModuleMainClass.h
1
2#ifndef ROSE_SgAsmJvmModuleMainClass_H
3#define ROSE_SgAsmJvmModuleMainClass_H
4#include <RoseFirst.h>
5#include <Cxx_GrammarDeclarations.h>
6#include <SgAsmJvmAttribute.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 SgAsmJvmModuleMainClass
23
24/* #line 25 "../../../src/frontend/SageIII//SgAsmJvmModuleMainClass.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 SgAsmJvmModuleMainClass
32class ROSE_DLL_API SgAsmJvmModuleMainClass : public SgAsmJvmAttribute
33 {
34 public:
35
36
37/* #line 38 "../../../src/frontend/SageIII//SgAsmJvmModuleMainClass.h" */
38
39 virtual SgNode* copy ( SgCopyHelp& help) const override;
40// Start of memberFunctionString
41/* #line 10114 "/workspace/src/ROSETTA/src/binaryInstruction.C" */
42
43
44 //----------------------- Boost serialization for SgAsmJvmModuleMainClass -----------------------
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("SgAsmJvmModuleMainClass");
52 s & BOOST_SERIALIZATION_BASE_OBJECT_NVP(SgAsmJvmAttribute);
53 s & BOOST_SERIALIZATION_NVP(p_main_class_index);
54 debugSerializationEnd("SgAsmJvmModuleMainClass");
55 }
56#endif // ROSE_HAVE_BOOST_SERIALIZATION_LIB
57public:
58public:
64 uint16_t const& get_main_class_index() const;
65 void set_main_class_index(uint16_t const&);
67public:
72
74 virtual SgAsmJvmAttribute* parse(SgAsmJvmConstantPool* pool) override;
75
77 virtual void unparse(std::ostream&) const override;
78
80 virtual void dump(FILE*, const char *prefix, ssize_t idx) const override;
81public:
84
85public:
88
89protected:
97
98
99// End of memberFunctionString
100// Start of memberFunctionString
101/* #line 1 "/workspace/src/ROSETTA/Grammar/Common.code" */
102
103// *** COMMON CODE SECTION BEGINS HERE ***
104
105 public:
106
107 // DQ (3/25/3006): I put this back in because it had the logic for where the copy function required
108 // and not required which is required to match the other aspects of the copy mechanism code generation.
109 // Specifically it is a problem to declare the copy function everywhere because it is not implemented
110 // for the SgSymbol IR nodes. I'm not clear why it is not implemented for these IR nodes.
111 /* \brief Copies AST (whole subtree, depending on the SgCopyHelp class */
112 // virtual SgNode* copy ( const SgCopyHelp & help) const;
113
115 virtual std::string class_name() const override;
116
118 virtual VariantT variantT() const override; // MS: new variant used in tree traversal
119
121 // King84 (2010.08.16): Moved this to an enum to save space, since it's only used at compiler-time anyway.
122 // static const VariantT static_variant = V_SgAsmJvmModuleMainClass;
123 enum { static_variant = V_SgAsmJvmModuleMainClass };
124
125 /* the generated cast function */
127 ROSE_DLL_API friend SgAsmJvmModuleMainClass* isSgAsmJvmModuleMainClass( SgNode * s );
128
130 ROSE_DLL_API friend const SgAsmJvmModuleMainClass* isSgAsmJvmModuleMainClass( const SgNode * s );
131
132 // ******************************************
133 // * Memory Pool / New / Delete
134 // ******************************************
135
136 public:
138 static const unsigned pool_size; //
140 static std::vector<unsigned char *> pools; //
142 static SgAsmJvmModuleMainClass * next_node; //
143
145 static unsigned long initializeStorageClassArray(SgAsmJvmModuleMainClassStorageClass *); //
146
148 static void clearMemoryPool(); //
149 static void deleteMemoryPool(); //
150
152 static void extendMemoryPoolForFileIO(); //
153
155 static SgAsmJvmModuleMainClass * getPointerFromGlobalIndex(unsigned long); //
157 static SgAsmJvmModuleMainClass * getPointerFromGlobalIndex(AstSpecificDataManagingClass *, unsigned long); //
158
160 static unsigned long getNumberOfValidNodesAndSetGlobalIndexInFreepointer(unsigned long); //
162 static void resetValidFreepointers(); //
164 static unsigned long getNumberOfLastValidPointer(); //
165
166
167#if defined(INLINE_FUNCTIONS)
169 inline void *operator new (size_t size);
170#else
172 void *operator new (size_t size);
173#endif
175 void operator delete (void* pointer, size_t size);
176
177 // DQ (4/5/2007): This is not the correct operator that we want, but appears to be required to compile ROSE with ROSE.
178 void operator delete (void* pointer)
179 {
180 // This is the generated delete operator...
181 SgAsmJvmModuleMainClass::operator delete (pointer,sizeof(SgAsmJvmModuleMainClass));
182 }
183
185 static size_t numberOfNodes();
186
188 static size_t memoryUsage();
189
190 // End of scope which started in IR nodes specific code
191 /* */
192
193 /* name Internal Functions
194 \brief Internal functions ... incomplete-documentation
195
196 These functions have been made public as part of the design, but they are suggested for internal use
197 or by particularly knowledgeable users for specialized tools or applications.
198
199 \internal We could not make these private because they are required by user for special purposes. And
200 it would be unwieldy to have many of the internal classes in ROSE be explicitly defined as friends.
201
202 */
203
204 // MS: 02/12/02 container of pointers to AST successor nodes used in the traversal
205 // overridden in every class by *generated* implementation
207 virtual std::vector<SgNode*> get_traversalSuccessorContainer() override;
208 // MS: 06/28/02 container of names of variables or container indices
209 // used used in the traversal to access AST successor nodes
210 // overridden in every class by *generated* implementation
213 virtual std::vector<std::string> get_traversalSuccessorNamesContainer() override;
214
215 // GB (09/25/2007): Functions for index-based access to traversal successors; these are hopefully a lot faster
216 // than all the vector copies. The implementation for these functions is generated for each class.
218 virtual size_t get_numberOfTraversalSuccessors() override;
220 virtual SgNode *get_traversalSuccessorByIndex(size_t idx) override;
222 virtual size_t get_childIndex(SgNode *child) override;
223
224#ifndef ROSE_USE_INTERNAL_FRONTEND_DEVELOPMENT
225 // MS: 08/16/2002 method for generating RTI information
227 virtual RTIReturnType roseRTI() override;
228#endif
229 /* */
230
231
232
233 /* name Deprecated Functions
234 \brief Deprecated functions ... incomplete-documentation
235
236 These functions have been deprecated from use.
237 */
238 /* */
239
241 virtual const char* sage_class_name() const override ROSE_DEPRECATED_FUNCTION;
242
243 // JJW (10/16/2008): Changed to a single function in Node.code, and put
244 // getVariant() in #if 0 block to prevent confusing Doxygen
245#if 0
247 virtual int variant() const ROSE_DEPRECATED_FUNCTION;
249 // virtual int getVariant() const ROSE_DEPRECATED_FUNCTION;
250#endif
251 /* */
252
253
254
255
256 public:
257 /* name Traversal Support Functions
258 \brief Traversal support functions ... incomplete-documentation
259
260 These functions have been made public as part of the design, but they are suggested for internal use
261 or by particularly knowledgable users for specialized tools or applications.
262 */
263 /* */
264
265 // DQ (11/26/2005): Support for visitor pattern mechanims
266 // (inferior to ROSE traversal mechanism, experimental).
270
271 /* DXN (08/09/2010): support for the classic visitor pattern done in GoF */
273 virtual void accept (ROSE_VisitorPattern & visitor) override;
274
275 // DQ (12/26/2005): Support for traversal based on the memory pool
278 static void traverseMemoryPoolNodes(ROSE_VisitTraversal & visit);
279
283
284 // DQ (2/9/2006): Added to support traversal over single representative of each IR node
285 // This traversal helps support internal tools that call static member functions.
286 // note: this function operates on the memory pools.
289 static void visitRepresentativeNode (ROSE_VisitTraversal & visit);
290 /* */
291
292 public:
293 /* NodeId support functions */
295 static SgNode* getNodeByNodeId(VariantT variantT, size_t poolIdx, size_t itemIdx);
298 static SgAsmJvmModuleMainClass* getNodeByNodeIdInternal(size_t poolIdx, size_t itemIdx);
301 static std::string getNodeIdString(SgAsmJvmModuleMainClass* sgnode);
302 static std::string getNodeIdStringInternal(SgAsmJvmModuleMainClass* sgnode);
303
304 public:
305 /* name Memory Allocation Functions
306 \brief Memory allocations functions ... incomplete-documentation
307
308 These functions have been made public as part of the design, but they are suggested for internal use
309 or by particularly knowledgable users for specialized tools or applications.
310 */
311 /* */
312
323 virtual bool isInMemoryPool() override;
324
335 virtual void checkDataMemberPointersIfInMemoryPool() override;
336
337 // DQ (4/30/2006): Modified to be a const function.
352 virtual std::vector<std::pair<SgNode*,std::string> > returnDataMemberPointers() const override;
353
364
376 virtual long getChildIndex( SgNode* childNode ) const override;
377
378 // DQ (9/2/2015): Since this function is generated by ROSETTA, we can't define the
379 // comment here (changed to be a C style comment and not be a doxygen comment).
380 /* \brief Constructor for use by AST File I/O Mechanism
381
382 This constructor permits the IR node to be rebuilt from the contiguously arranged data in memory
383 which obtained via fast binary file I/O from disk.
384 */
385 // SgAsmJvmModuleMainClass( SgAsmJvmModuleMainClassStorageClass& source );
386
387
388
389
390
391 // JH (10/24/2005): methods added to support the ast file IO
392 private:
393
394 /* name AST Memory Allocation Support Functions
395 \brief Memory allocations support....
396
397 These functions handle the low leve support of the memory allocation scheme which permits IR nodes to be allocated
398 in large contiguous blocks to reduce memory fragmentation, improve performance, support specialized access (AST traversals),
399 and support the AST File I/O Mechanism.
400 */
401 /* */
402
403 /* JH (10/24/2005): Two typedefs. The TestType notes the type every pointer is cast to before
404 we compare them. Since I had several problems with this, I decided to make a typdef to ensure
405 that I use the same type everywhere, if any changes are made. THe second one declares the type
406 (actually unsigned long) where teh pointer address gets converted to. On 64 bit platforms this
407 might got changed, but unfortunatly, the return types are still unsigned longs. There exists
408 a correspinding one in the AST_FILE_IO class!
409 */
410 // DQ (9/2/2015): This typedef is no longer used, we can't define the
411 // comment here (changed to be a C style comment and not be a doxygen comment).
412 /* \brief Typedef used for low level memory access.
413 */
414 // typedef unsigned char* TestType;
415
416 // DQ (9/2/2015): This typedef is no longer used, we can't define the
417 // comment here (changed to be a C style comment and not be a doxygen comment).
418 /* \brief Typedef used to hold memory addresses as values.
419 */
420 // typedef unsigned long AddressType;
421
422
423
424 // necessary, to have direct access to the p_freepointer and the private methods !
426 friend class AST_FILE_IO;
427
429 friend class SgAsmJvmModuleMainClassStorageClass;
430
432 friend class AstSpecificDataManagingClass;
433
435 friend class AstSpecificDataManagingClassStorageClass;
436 public:
438 SgAsmJvmModuleMainClass( const SgAsmJvmModuleMainClassStorageClass& source );
439
440 // private: // JJW hack
441 /*
442 name AST Memory Allocation Support Variables
443 Memory allocations support variables
444
445 These variables handle the low level support of the memory allocation scheme which permits IR nodes to be allocated
446 in large contiguous blocks to reduce memory fragmentation, improve performance, support specialized access (AST traversals),
447 and support the AST File I/O Mechanism.
448 */
449 /* */
450
451 public:
452
453 // DQ (11/21/2009): Added function to add new Regular Expression attributes and return pointer
454 // to current node (so that it will work cleanly with build functions to specify patterns).
455 // virtual SgNode* addRegExpAttribute();
462
463#ifndef _MSC_VER
464// Rasmussen (04/17/2019): Support for ATerms has been deprecated as it is no longer needed
465// and likely never fully implemented nor tested. Files remain in the src tree but are no
466// longer built.
467#define BUILD_ATERM_SUPPORT 0
468 #if BUILD_ATERM_SUPPORT
469 #ifdef ROSE_USE_ROSE_ATERM_SUPPORT
470 // DQ (10/4/2014): Adding ATerm support to ROSE.
480 // Rasmussen (1/7/2019): Added override to kill warning messages of overridden virtual function
481 virtual ATerm generate_ATerm() override;
482
484 virtual void generate_ATerm_Annotation(ATerm & term) override;
485 #endif
486 #endif // BUILD_ATERM_SUPPORT
487#endif
488 // These can't be virtual functions since we don't yet know what IR node to build (until we have read the aterm).
489 // virtual generate_AST(ATerm & term);
490 // virtual void read_ATerm_Annotation(ATerm & term);
491
492// *** COMMON CODE SECTION ENDS HERE ***
493
494
495// End of memberFunctionString
496// Start of memberFunctionString
497/* #line 706 "/workspace/src/ROSETTA/Grammar/Node.code" */
498
499 // the generated cast function
500 // friend ROSE_DLL_API SgAsmJvmModuleMainClass* isSgAsmJvmModuleMainClass ( SgNode* s );
501
502 typedef SgAsmJvmAttribute base_node_type;
503
504
505// End of memberFunctionString
506
507
508 protected:
509// Start of memberFunctionString
510uint16_t p_main_class_index;
511
512// End of memberFunctionString
513
515 friend struct Rose::Traits::generated::describe_field_t<SgAsmJvmModuleMainClass, uint16_t,&SgAsmJvmModuleMainClass::p_main_class_index>;
516
517/* #line 21 "/workspace/src/ROSETTA/Grammar/grammarClassDeclarationMacros.macro" */
518
519
520 };
521#endif
522
523// postdeclarations for SgAsmJvmModuleMainClass
524
525/* #line 526 "../../../src/frontend/SageIII//SgAsmJvmModuleMainClass.h" */
526
527/* #line 27 "/workspace/src/ROSETTA/Grammar/grammarClassDeclarationMacros.macro after subst for $POSTDECLARATIONS" */
528
529/* #line 28 "/workspace/src/ROSETTA/Grammar/grammarClassDeclarationMacros.macro" */
530
531
532/* #line 533 "../../../src/frontend/SageIII//SgAsmJvmModuleMainClass.h" */
533
534#endif // ROSE_SgAsmJvmModuleMainClass_H
535
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 a JVM attribute.
virtual void dump(FILE *, const char *prefix, ssize_t idx) const override
Print some debugging information.
void initializeProperties()
Initialize all properties that have explicit initial values.
virtual void unparse(std::ostream &) const override
Write attribute to a binary file.
Represents an JVM constant pool.
Represents a JVM exception_info table/array.
JVM ModuleMainClass attribute.
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 parse(SgAsmGenericFile *)
Main function to parse DWARF information.
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.