ROSE 0.11.145.147
SgAsmCilMemberRef.h
1
2#ifndef ROSE_SgAsmCilMemberRef_H
3#define ROSE_SgAsmCilMemberRef_H
4#include <RoseFirst.h>
5#include <Cxx_GrammarDeclarations.h>
6#include <SgAsmCilMetadata.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 SgAsmCilMemberRef
23
24/* #line 25 "../../../src/frontend/SageIII//SgAsmCilMemberRef.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 SgAsmCilMemberRef
32class ROSE_DLL_API SgAsmCilMemberRef : public SgAsmCilMetadata
33 {
34 public:
35
36
37/* #line 38 "../../../src/frontend/SageIII//SgAsmCilMemberRef.h" */
38
39 virtual SgNode* copy ( SgCopyHelp& help) const override;
40// Start of memberFunctionString
41/* #line 35783 "/workspace/src/ROSETTA/src/binaryInstruction.C" */
42
43
44 //----------------------- Boost serialization for SgAsmCilMemberRef -----------------------
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("SgAsmCilMemberRef");
52 s & BOOST_SERIALIZATION_BASE_OBJECT_NVP(SgAsmCilMetadata);
53 s & BOOST_SERIALIZATION_NVP(p_Class);
54 s & BOOST_SERIALIZATION_NVP(p_Name);
55 s & BOOST_SERIALIZATION_NVP(p_Signature);
56 debugSerializationEnd("SgAsmCilMemberRef");
57 }
58#endif // ROSE_HAVE_BOOST_SERIALIZATION_LIB
59
60public:
66 uint32_t const& get_Class() const;
67 void set_Class(uint32_t const&);
70public:
76 uint32_t const& get_Name() const;
77 void set_Name(uint32_t const&);
80public:
86 uint32_t const& get_Signature() const;
87 void set_Signature(uint32_t const&);
89public:
90 void parse(const std::vector<uint8_t>& buf, size_t& index, uint64_t uses4byteIndexing);
91 void unparse(std::vector<uint8_t>& buf, size_t& index, uint64_t uses4byteIndexing) const;
92 void dump(std::ostream&) const;
93
94 const SgAsmCilMetadata* get_Class_object() const;
95 const std::uint8_t* get_Name_string() const;
96 const std::uint8_t* get_Signature_blob() const;
97public:
99 virtual ~SgAsmCilMemberRef();
100
101public:
104
105protected:
113
114
115// End of memberFunctionString
116// Start of memberFunctionString
117/* #line 1 "/workspace/src/ROSETTA/Grammar/Common.code" */
118
119// *** COMMON CODE SECTION BEGINS HERE ***
120
121 public:
122
123 // DQ (3/25/3006): I put this back in because it had the logic for where the copy function required
124 // and not required which is required to match the other aspects of the copy mechanism code generation.
125 // Specifically it is a problem to declare the copy function everywhere because it is not implemented
126 // for the SgSymbol IR nodes. I'm not clear why it is not implemented for these IR nodes.
127 /* \brief Copies AST (whole subtree, depending on the SgCopyHelp class */
128 // virtual SgNode* copy ( const SgCopyHelp & help) const;
129
131 virtual std::string class_name() const override;
132
134 virtual VariantT variantT() const override; // MS: new variant used in tree traversal
135
137 // King84 (2010.08.16): Moved this to an enum to save space, since it's only used at compiler-time anyway.
138 // static const VariantT static_variant = V_SgAsmCilMemberRef;
139 enum { static_variant = V_SgAsmCilMemberRef };
140
141 /* the generated cast function */
143 ROSE_DLL_API friend SgAsmCilMemberRef* isSgAsmCilMemberRef( SgNode * s );
144
146 ROSE_DLL_API friend const SgAsmCilMemberRef* isSgAsmCilMemberRef( const SgNode * s );
147
148 // ******************************************
149 // * Memory Pool / New / Delete
150 // ******************************************
151
152 public:
154 static const unsigned pool_size; //
156 static std::vector<unsigned char *> pools; //
158 static SgAsmCilMemberRef * next_node; //
159
161 static unsigned long initializeStorageClassArray(SgAsmCilMemberRefStorageClass *); //
162
164 static void clearMemoryPool(); //
165 static void deleteMemoryPool(); //
166
168 static void extendMemoryPoolForFileIO(); //
169
171 static SgAsmCilMemberRef * getPointerFromGlobalIndex(unsigned long); //
173 static SgAsmCilMemberRef * getPointerFromGlobalIndex(AstSpecificDataManagingClass *, unsigned long); //
174
176 static unsigned long getNumberOfValidNodesAndSetGlobalIndexInFreepointer(unsigned long); //
178 static void resetValidFreepointers(); //
180 static unsigned long getNumberOfLastValidPointer(); //
181
182
183#if defined(INLINE_FUNCTIONS)
185 inline void *operator new (size_t size);
186#else
188 void *operator new (size_t size);
189#endif
191 void operator delete (void* pointer, size_t size);
192
193 // DQ (4/5/2007): This is not the correct operator that we want, but appears to be required to compile ROSE with ROSE.
194 void operator delete (void* pointer)
195 {
196 // This is the generated delete operator...
197 SgAsmCilMemberRef::operator delete (pointer,sizeof(SgAsmCilMemberRef));
198 }
199
201 static size_t numberOfNodes();
202
204 static size_t memoryUsage();
205
206 // End of scope which started in IR nodes specific code
207 /* */
208
209 /* name Internal Functions
210 \brief Internal functions ... incomplete-documentation
211
212 These functions have been made public as part of the design, but they are suggested for internal use
213 or by particularly knowledgeable users for specialized tools or applications.
214
215 \internal We could not make these private because they are required by user for special purposes. And
216 it would be unwieldy to have many of the internal classes in ROSE be explicitly defined as friends.
217
218 */
219
220 // MS: 02/12/02 container of pointers to AST successor nodes used in the traversal
221 // overridden in every class by *generated* implementation
223 virtual std::vector<SgNode*> get_traversalSuccessorContainer() override;
224 // MS: 06/28/02 container of names of variables or container indices
225 // used used in the traversal to access AST successor nodes
226 // overridden in every class by *generated* implementation
229 virtual std::vector<std::string> get_traversalSuccessorNamesContainer() override;
230
231 // GB (09/25/2007): Functions for index-based access to traversal successors; these are hopefully a lot faster
232 // than all the vector copies. The implementation for these functions is generated for each class.
234 virtual size_t get_numberOfTraversalSuccessors() override;
236 virtual SgNode *get_traversalSuccessorByIndex(size_t idx) override;
238 virtual size_t get_childIndex(SgNode *child) override;
239
240#ifndef ROSE_USE_INTERNAL_FRONTEND_DEVELOPMENT
241 // MS: 08/16/2002 method for generating RTI information
243 virtual RTIReturnType roseRTI() override;
244#endif
245 /* */
246
247
248
249 /* name Deprecated Functions
250 \brief Deprecated functions ... incomplete-documentation
251
252 These functions have been deprecated from use.
253 */
254 /* */
255
257 virtual const char* sage_class_name() const override ROSE_DEPRECATED_FUNCTION;
258
259 // JJW (10/16/2008): Changed to a single function in Node.code, and put
260 // getVariant() in #if 0 block to prevent confusing Doxygen
261#if 0
263 virtual int variant() const ROSE_DEPRECATED_FUNCTION;
265 // virtual int getVariant() const ROSE_DEPRECATED_FUNCTION;
266#endif
267 /* */
268
269
270
271
272 public:
273 /* name Traversal Support Functions
274 \brief Traversal support functions ... incomplete-documentation
275
276 These functions have been made public as part of the design, but they are suggested for internal use
277 or by particularly knowledgable users for specialized tools or applications.
278 */
279 /* */
280
281 // DQ (11/26/2005): Support for visitor pattern mechanims
282 // (inferior to ROSE traversal mechanism, experimental).
286
287 /* DXN (08/09/2010): support for the classic visitor pattern done in GoF */
289 virtual void accept (ROSE_VisitorPattern & visitor) override;
290
291 // DQ (12/26/2005): Support for traversal based on the memory pool
294 static void traverseMemoryPoolNodes(ROSE_VisitTraversal & visit);
295
299
300 // DQ (2/9/2006): Added to support traversal over single representative of each IR node
301 // This traversal helps support internal tools that call static member functions.
302 // note: this function operates on the memory pools.
305 static void visitRepresentativeNode (ROSE_VisitTraversal & visit);
306 /* */
307
308 public:
309 /* NodeId support functions */
311 static SgNode* getNodeByNodeId(VariantT variantT, size_t poolIdx, size_t itemIdx);
314 static SgAsmCilMemberRef* getNodeByNodeIdInternal(size_t poolIdx, size_t itemIdx);
317 static std::string getNodeIdString(SgAsmCilMemberRef* sgnode);
318 static std::string getNodeIdStringInternal(SgAsmCilMemberRef* sgnode);
319
320 public:
321 /* name Memory Allocation Functions
322 \brief Memory allocations functions ... incomplete-documentation
323
324 These functions have been made public as part of the design, but they are suggested for internal use
325 or by particularly knowledgable users for specialized tools or applications.
326 */
327 /* */
328
339 virtual bool isInMemoryPool() override;
340
351 virtual void checkDataMemberPointersIfInMemoryPool() override;
352
353 // DQ (4/30/2006): Modified to be a const function.
368 virtual std::vector<std::pair<SgNode*,std::string> > returnDataMemberPointers() const override;
369
380
392 virtual long getChildIndex( SgNode* childNode ) const override;
393
394 // DQ (9/2/2015): Since this function is generated by ROSETTA, we can't define the
395 // comment here (changed to be a C style comment and not be a doxygen comment).
396 /* \brief Constructor for use by AST File I/O Mechanism
397
398 This constructor permits the IR node to be rebuilt from the contiguously arranged data in memory
399 which obtained via fast binary file I/O from disk.
400 */
401 // SgAsmCilMemberRef( SgAsmCilMemberRefStorageClass& source );
402
403
404
405
406
407 // JH (10/24/2005): methods added to support the ast file IO
408 private:
409
410 /* name AST Memory Allocation Support Functions
411 \brief Memory allocations support....
412
413 These functions handle the low leve support of the memory allocation scheme which permits IR nodes to be allocated
414 in large contiguous blocks to reduce memory fragmentation, improve performance, support specialized access (AST traversals),
415 and support the AST File I/O Mechanism.
416 */
417 /* */
418
419 /* JH (10/24/2005): Two typedefs. The TestType notes the type every pointer is cast to before
420 we compare them. Since I had several problems with this, I decided to make a typdef to ensure
421 that I use the same type everywhere, if any changes are made. THe second one declares the type
422 (actually unsigned long) where teh pointer address gets converted to. On 64 bit platforms this
423 might got changed, but unfortunatly, the return types are still unsigned longs. There exists
424 a correspinding one in the AST_FILE_IO class!
425 */
426 // DQ (9/2/2015): This typedef is no longer used, we can't define the
427 // comment here (changed to be a C style comment and not be a doxygen comment).
428 /* \brief Typedef used for low level memory access.
429 */
430 // typedef unsigned char* TestType;
431
432 // DQ (9/2/2015): This typedef is no longer used, we can't define the
433 // comment here (changed to be a C style comment and not be a doxygen comment).
434 /* \brief Typedef used to hold memory addresses as values.
435 */
436 // typedef unsigned long AddressType;
437
438
439
440 // necessary, to have direct access to the p_freepointer and the private methods !
442 friend class AST_FILE_IO;
443
445 friend class SgAsmCilMemberRefStorageClass;
446
448 friend class AstSpecificDataManagingClass;
449
451 friend class AstSpecificDataManagingClassStorageClass;
452 public:
454 SgAsmCilMemberRef( const SgAsmCilMemberRefStorageClass& source );
455
456 // private: // JJW hack
457 /*
458 name AST Memory Allocation Support Variables
459 Memory allocations support variables
460
461 These variables handle the low level support of the memory allocation scheme which permits IR nodes to be allocated
462 in large contiguous blocks to reduce memory fragmentation, improve performance, support specialized access (AST traversals),
463 and support the AST File I/O Mechanism.
464 */
465 /* */
466
467 public:
468
469 // DQ (11/21/2009): Added function to add new Regular Expression attributes and return pointer
470 // to current node (so that it will work cleanly with build functions to specify patterns).
471 // virtual SgNode* addRegExpAttribute();
478
479#ifndef _MSC_VER
480// Rasmussen (04/17/2019): Support for ATerms has been deprecated as it is no longer needed
481// and likely never fully implemented nor tested. Files remain in the src tree but are no
482// longer built.
483#define BUILD_ATERM_SUPPORT 0
484 #if BUILD_ATERM_SUPPORT
485 #ifdef ROSE_USE_ROSE_ATERM_SUPPORT
486 // DQ (10/4/2014): Adding ATerm support to ROSE.
496 // Rasmussen (1/7/2019): Added override to kill warning messages of overridden virtual function
497 virtual ATerm generate_ATerm() override;
498
500 virtual void generate_ATerm_Annotation(ATerm & term) override;
501 #endif
502 #endif // BUILD_ATERM_SUPPORT
503#endif
504 // These can't be virtual functions since we don't yet know what IR node to build (until we have read the aterm).
505 // virtual generate_AST(ATerm & term);
506 // virtual void read_ATerm_Annotation(ATerm & term);
507
508// *** COMMON CODE SECTION ENDS HERE ***
509
510
511// End of memberFunctionString
512// Start of memberFunctionString
513/* #line 706 "/workspace/src/ROSETTA/Grammar/Node.code" */
514
515 // the generated cast function
516 // friend ROSE_DLL_API SgAsmCilMemberRef* isSgAsmCilMemberRef ( SgNode* s );
517
518 typedef SgAsmCilMetadata base_node_type;
519
520
521// End of memberFunctionString
522
523
524
525
526 protected:
527// Start of memberFunctionString
528uint32_t p_Class;
529
530// End of memberFunctionString
531// Start of memberFunctionString
532uint32_t p_Name;
533
534// End of memberFunctionString
535// Start of memberFunctionString
536uint32_t p_Signature;
537
538// End of memberFunctionString
539
541 friend struct Rose::Traits::generated::describe_field_t<SgAsmCilMemberRef, uint32_t,&SgAsmCilMemberRef::p_Class>;
542 friend struct Rose::Traits::generated::describe_field_t<SgAsmCilMemberRef, uint32_t,&SgAsmCilMemberRef::p_Name>;
543 friend struct Rose::Traits::generated::describe_field_t<SgAsmCilMemberRef, uint32_t,&SgAsmCilMemberRef::p_Signature>;
544
545/* #line 21 "/workspace/src/ROSETTA/Grammar/grammarClassDeclarationMacros.macro" */
546
547
548 };
549#endif
550
551// postdeclarations for SgAsmCilMemberRef
552
553/* #line 554 "../../../src/frontend/SageIII//SgAsmCilMemberRef.h" */
554
555/* #line 27 "/workspace/src/ROSETTA/Grammar/grammarClassDeclarationMacros.macro after subst for $POSTDECLARATIONS" */
556
557/* #line 28 "/workspace/src/ROSETTA/Grammar/grammarClassDeclarationMacros.macro" */
558
559
560/* #line 561 "../../../src/frontend/SageIII//SgAsmCilMemberRef.h" */
561
562#endif // ROSE_SgAsmCilMemberRef_H
563
Class holding static data and functions supporting File I/O.
Definition AST_FILE_IO.h:19
Attribute containing a regex expression as a string.
CIL MemberRef node (II.22.25).
Base class for CIL 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 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.