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