ROSE 0.11.145.147
SgAsmJvmField.h
1
2#ifndef ROSE_SgAsmJvmField_H
3#define ROSE_SgAsmJvmField_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 SgAsmJvmField
23
24/* #line 25 "../../../src/frontend/SageIII//SgAsmJvmField.h" */
25/* #line 12022 "/workspace/src/ROSETTA/src/binaryInstruction.C" */
26
27#ifdef ROSE_SgAsmJvmField_IMPL
28#include <SgAsmJvmAttributeTable.h>
29#endif
30
31
32/* #line 13 "/workspace/src/ROSETTA/Grammar/grammarClassDeclarationMacros.macro after subst for $PREDECLARATIONS" */
33
34/* #line 14 "/workspace/src/ROSETTA/Grammar/grammarClassDeclarationMacros.macro" */
35
36#if !defined(DOCUMENTATION)
37// Class Definition for SgAsmJvmField
38class ROSE_DLL_API SgAsmJvmField : public SgAsmJvmNode
39 {
40 public:
41
42
43/* #line 44 "../../../src/frontend/SageIII//SgAsmJvmField.h" */
44
45 virtual SgNode* copy ( SgCopyHelp& help) const override;
46// Start of memberFunctionString
47/* #line 12060 "/workspace/src/ROSETTA/src/binaryInstruction.C" */
48
49
50 //----------------------- Boost serialization for SgAsmJvmField -----------------------
51#ifdef ROSE_HAVE_BOOST_SERIALIZATION_LIB
52private:
53 friend class boost::serialization::access;
54
55 template<class S>
56 void serialize(S &s, const unsigned /*version*/) {
57 debugSerializationBegin("SgAsmJvmField");
58 s & BOOST_SERIALIZATION_BASE_OBJECT_NVP(SgAsmJvmNode);
59 s & BOOST_SERIALIZATION_NVP(p_access_flags);
60 s & BOOST_SERIALIZATION_NVP(p_name_index);
61 s & BOOST_SERIALIZATION_NVP(p_descriptor_index);
62 s & BOOST_SERIALIZATION_NVP(p_attribute_table);
63 debugSerializationEnd("SgAsmJvmField");
64 }
65#endif // ROSE_HAVE_BOOST_SERIALIZATION_LIB
66public:
67public:
74 uint16_t const& get_access_flags() const;
75 void set_access_flags(uint16_t const&);
78public:
84 uint16_t const& get_name_index() const;
85 void set_name_index(uint16_t const&);
88public:
94 uint16_t const& get_descriptor_index() const;
95 void set_descriptor_index(uint16_t const&);
98public:
102 SgAsmJvmAttributeTable* const& get_attribute_table() const;
103 void set_attribute_table(SgAsmJvmAttributeTable* const&);
105 public:
110
113
115 virtual void unparse(std::ostream&) const override;
116
118 void dump(FILE*, const char *prefix, ssize_t idx) const override;
119public:
121 virtual ~SgAsmJvmField();
122
123public:
126
127protected:
135
136
137// End of memberFunctionString
138// Start of memberFunctionString
139/* #line 1 "/workspace/src/ROSETTA/Grammar/Common.code" */
140
141// *** COMMON CODE SECTION BEGINS HERE ***
142
143 public:
144
145 // DQ (3/25/3006): I put this back in because it had the logic for where the copy function required
146 // and not required which is required to match the other aspects of the copy mechanism code generation.
147 // Specifically it is a problem to declare the copy function everywhere because it is not implemented
148 // for the SgSymbol IR nodes. I'm not clear why it is not implemented for these IR nodes.
149 /* \brief Copies AST (whole subtree, depending on the SgCopyHelp class */
150 // virtual SgNode* copy ( const SgCopyHelp & help) const;
151
153 virtual std::string class_name() const override;
154
156 virtual VariantT variantT() const override; // MS: new variant used in tree traversal
157
159 // King84 (2010.08.16): Moved this to an enum to save space, since it's only used at compiler-time anyway.
160 // static const VariantT static_variant = V_SgAsmJvmField;
161 enum { static_variant = V_SgAsmJvmField };
162
163 /* the generated cast function */
165 ROSE_DLL_API friend SgAsmJvmField* isSgAsmJvmField( SgNode * s );
166
168 ROSE_DLL_API friend const SgAsmJvmField* isSgAsmJvmField( const SgNode * s );
169
170 // ******************************************
171 // * Memory Pool / New / Delete
172 // ******************************************
173
174 public:
176 static const unsigned pool_size; //
178 static std::vector<unsigned char *> pools; //
180 static SgAsmJvmField * next_node; //
181
183 static unsigned long initializeStorageClassArray(SgAsmJvmFieldStorageClass *); //
184
186 static void clearMemoryPool(); //
187 static void deleteMemoryPool(); //
188
190 static void extendMemoryPoolForFileIO(); //
191
193 static SgAsmJvmField * getPointerFromGlobalIndex(unsigned long); //
195 static SgAsmJvmField * getPointerFromGlobalIndex(AstSpecificDataManagingClass *, unsigned long); //
196
198 static unsigned long getNumberOfValidNodesAndSetGlobalIndexInFreepointer(unsigned long); //
200 static void resetValidFreepointers(); //
202 static unsigned long getNumberOfLastValidPointer(); //
203
204
205#if defined(INLINE_FUNCTIONS)
207 inline void *operator new (size_t size);
208#else
210 void *operator new (size_t size);
211#endif
213 void operator delete (void* pointer, size_t size);
214
215 // DQ (4/5/2007): This is not the correct operator that we want, but appears to be required to compile ROSE with ROSE.
216 void operator delete (void* pointer)
217 {
218 // This is the generated delete operator...
219 SgAsmJvmField::operator delete (pointer,sizeof(SgAsmJvmField));
220 }
221
223 static size_t numberOfNodes();
224
226 static size_t memoryUsage();
227
228 // End of scope which started in IR nodes specific code
229 /* */
230
231 /* name Internal Functions
232 \brief Internal functions ... incomplete-documentation
233
234 These functions have been made public as part of the design, but they are suggested for internal use
235 or by particularly knowledgeable users for specialized tools or applications.
236
237 \internal We could not make these private because they are required by user for special purposes. And
238 it would be unwieldy to have many of the internal classes in ROSE be explicitly defined as friends.
239
240 */
241
242 // MS: 02/12/02 container of pointers to AST successor nodes used in the traversal
243 // overridden in every class by *generated* implementation
245 virtual std::vector<SgNode*> get_traversalSuccessorContainer() override;
246 // MS: 06/28/02 container of names of variables or container indices
247 // used used in the traversal to access AST successor nodes
248 // overridden in every class by *generated* implementation
251 virtual std::vector<std::string> get_traversalSuccessorNamesContainer() override;
252
253 // GB (09/25/2007): Functions for index-based access to traversal successors; these are hopefully a lot faster
254 // than all the vector copies. The implementation for these functions is generated for each class.
256 virtual size_t get_numberOfTraversalSuccessors() override;
258 virtual SgNode *get_traversalSuccessorByIndex(size_t idx) override;
260 virtual size_t get_childIndex(SgNode *child) override;
261
262#ifndef ROSE_USE_INTERNAL_FRONTEND_DEVELOPMENT
263 // MS: 08/16/2002 method for generating RTI information
265 virtual RTIReturnType roseRTI() override;
266#endif
267 /* */
268
269
270
271 /* name Deprecated Functions
272 \brief Deprecated functions ... incomplete-documentation
273
274 These functions have been deprecated from use.
275 */
276 /* */
277
279 virtual const char* sage_class_name() const override ROSE_DEPRECATED_FUNCTION;
280
281 // JJW (10/16/2008): Changed to a single function in Node.code, and put
282 // getVariant() in #if 0 block to prevent confusing Doxygen
283#if 0
285 virtual int variant() const ROSE_DEPRECATED_FUNCTION;
287 // virtual int getVariant() const ROSE_DEPRECATED_FUNCTION;
288#endif
289 /* */
290
291
292
293
294 public:
295 /* name Traversal Support Functions
296 \brief Traversal support functions ... incomplete-documentation
297
298 These functions have been made public as part of the design, but they are suggested for internal use
299 or by particularly knowledgable users for specialized tools or applications.
300 */
301 /* */
302
303 // DQ (11/26/2005): Support for visitor pattern mechanims
304 // (inferior to ROSE traversal mechanism, experimental).
308
309 /* DXN (08/09/2010): support for the classic visitor pattern done in GoF */
311 virtual void accept (ROSE_VisitorPattern & visitor) override;
312
313 // DQ (12/26/2005): Support for traversal based on the memory pool
316 static void traverseMemoryPoolNodes(ROSE_VisitTraversal & visit);
317
321
322 // DQ (2/9/2006): Added to support traversal over single representative of each IR node
323 // This traversal helps support internal tools that call static member functions.
324 // note: this function operates on the memory pools.
327 static void visitRepresentativeNode (ROSE_VisitTraversal & visit);
328 /* */
329
330 public:
331 /* NodeId support functions */
333 static SgNode* getNodeByNodeId(VariantT variantT, size_t poolIdx, size_t itemIdx);
336 static SgAsmJvmField* getNodeByNodeIdInternal(size_t poolIdx, size_t itemIdx);
339 static std::string getNodeIdString(SgAsmJvmField* sgnode);
340 static std::string getNodeIdStringInternal(SgAsmJvmField* sgnode);
341
342 public:
343 /* name Memory Allocation Functions
344 \brief Memory allocations functions ... incomplete-documentation
345
346 These functions have been made public as part of the design, but they are suggested for internal use
347 or by particularly knowledgable users for specialized tools or applications.
348 */
349 /* */
350
361 virtual bool isInMemoryPool() override;
362
373 virtual void checkDataMemberPointersIfInMemoryPool() override;
374
375 // DQ (4/30/2006): Modified to be a const function.
390 virtual std::vector<std::pair<SgNode*,std::string> > returnDataMemberPointers() const override;
391
402
414 virtual long getChildIndex( SgNode* childNode ) const override;
415
416 // DQ (9/2/2015): Since this function is generated by ROSETTA, we can't define the
417 // comment here (changed to be a C style comment and not be a doxygen comment).
418 /* \brief Constructor for use by AST File I/O Mechanism
419
420 This constructor permits the IR node to be rebuilt from the contiguously arranged data in memory
421 which obtained via fast binary file I/O from disk.
422 */
423 // SgAsmJvmField( SgAsmJvmFieldStorageClass& source );
424
425
426
427
428
429 // JH (10/24/2005): methods added to support the ast file IO
430 private:
431
432 /* name AST Memory Allocation Support Functions
433 \brief Memory allocations support....
434
435 These functions handle the low leve support of the memory allocation scheme which permits IR nodes to be allocated
436 in large contiguous blocks to reduce memory fragmentation, improve performance, support specialized access (AST traversals),
437 and support the AST File I/O Mechanism.
438 */
439 /* */
440
441 /* JH (10/24/2005): Two typedefs. The TestType notes the type every pointer is cast to before
442 we compare them. Since I had several problems with this, I decided to make a typdef to ensure
443 that I use the same type everywhere, if any changes are made. THe second one declares the type
444 (actually unsigned long) where teh pointer address gets converted to. On 64 bit platforms this
445 might got changed, but unfortunatly, the return types are still unsigned longs. There exists
446 a correspinding one in the AST_FILE_IO class!
447 */
448 // DQ (9/2/2015): This typedef is no longer used, we can't define the
449 // comment here (changed to be a C style comment and not be a doxygen comment).
450 /* \brief Typedef used for low level memory access.
451 */
452 // typedef unsigned char* TestType;
453
454 // DQ (9/2/2015): This typedef is no longer used, we can't define the
455 // comment here (changed to be a C style comment and not be a doxygen comment).
456 /* \brief Typedef used to hold memory addresses as values.
457 */
458 // typedef unsigned long AddressType;
459
460
461
462 // necessary, to have direct access to the p_freepointer and the private methods !
464 friend class AST_FILE_IO;
465
467 friend class SgAsmJvmFieldStorageClass;
468
470 friend class AstSpecificDataManagingClass;
471
473 friend class AstSpecificDataManagingClassStorageClass;
474 public:
476 SgAsmJvmField( const SgAsmJvmFieldStorageClass& source );
477
478 // private: // JJW hack
479 /*
480 name AST Memory Allocation Support Variables
481 Memory allocations support variables
482
483 These variables handle the low level support of the memory allocation scheme which permits IR nodes to be allocated
484 in large contiguous blocks to reduce memory fragmentation, improve performance, support specialized access (AST traversals),
485 and support the AST File I/O Mechanism.
486 */
487 /* */
488
489 public:
490
491 // DQ (11/21/2009): Added function to add new Regular Expression attributes and return pointer
492 // to current node (so that it will work cleanly with build functions to specify patterns).
493 // virtual SgNode* addRegExpAttribute();
500
501#ifndef _MSC_VER
502// Rasmussen (04/17/2019): Support for ATerms has been deprecated as it is no longer needed
503// and likely never fully implemented nor tested. Files remain in the src tree but are no
504// longer built.
505#define BUILD_ATERM_SUPPORT 0
506 #if BUILD_ATERM_SUPPORT
507 #ifdef ROSE_USE_ROSE_ATERM_SUPPORT
508 // DQ (10/4/2014): Adding ATerm support to ROSE.
518 // Rasmussen (1/7/2019): Added override to kill warning messages of overridden virtual function
519 virtual ATerm generate_ATerm() override;
520
522 virtual void generate_ATerm_Annotation(ATerm & term) override;
523 #endif
524 #endif // BUILD_ATERM_SUPPORT
525#endif
526 // These can't be virtual functions since we don't yet know what IR node to build (until we have read the aterm).
527 // virtual generate_AST(ATerm & term);
528 // virtual void read_ATerm_Annotation(ATerm & term);
529
530// *** COMMON CODE SECTION ENDS HERE ***
531
532
533// End of memberFunctionString
534// Start of memberFunctionString
535/* #line 706 "/workspace/src/ROSETTA/Grammar/Node.code" */
536
537 // the generated cast function
538 // friend ROSE_DLL_API SgAsmJvmField* isSgAsmJvmField ( SgNode* s );
539
540 typedef SgAsmJvmNode base_node_type;
541
542
543// End of memberFunctionString
544
545
546
547
548
549 protected:
550// Start of memberFunctionString
551uint16_t p_access_flags;
552
553// End of memberFunctionString
554// Start of memberFunctionString
555uint16_t p_name_index;
556
557// End of memberFunctionString
558// Start of memberFunctionString
559uint16_t p_descriptor_index;
560
561// End of memberFunctionString
562// Start of memberFunctionString
563SgAsmJvmAttributeTable* p_attribute_table;
564
565// End of memberFunctionString
566
568 friend struct Rose::Traits::generated::describe_field_t<SgAsmJvmField, uint16_t,&SgAsmJvmField::p_access_flags>;
569 friend struct Rose::Traits::generated::describe_field_t<SgAsmJvmField, uint16_t,&SgAsmJvmField::p_name_index>;
570 friend struct Rose::Traits::generated::describe_field_t<SgAsmJvmField, uint16_t,&SgAsmJvmField::p_descriptor_index>;
571 friend struct Rose::Traits::generated::describe_field_t<SgAsmJvmField, SgAsmJvmAttributeTable*,&SgAsmJvmField::p_attribute_table>;
572
573/* #line 21 "/workspace/src/ROSETTA/Grammar/grammarClassDeclarationMacros.macro" */
574
575
576 };
577#endif
578
579// postdeclarations for SgAsmJvmField
580
581/* #line 582 "../../../src/frontend/SageIII//SgAsmJvmField.h" */
582
583/* #line 27 "/workspace/src/ROSETTA/Grammar/grammarClassDeclarationMacros.macro after subst for $POSTDECLARATIONS" */
584
585/* #line 28 "/workspace/src/ROSETTA/Grammar/grammarClassDeclarationMacros.macro" */
586
587
588/* #line 589 "../../../src/frontend/SageIII//SgAsmJvmField.h" */
589
590#endif // ROSE_SgAsmJvmField_H
591
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.
Represents an JVM constant pool.
Represents a JVM field_info table/array.
Base class for JVM branch of binary analysis IR nodes.
virtual void unparse(std::ostream &) const
Write node to a binary file.
void initializeProperties()
Initialize all properties that have explicit initial values.
virtual void dump(FILE *, const char *prefix, ssize_t idx) const
Print some debugging information.
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.