ROSE 0.11.145.147
SgAsmCilTypeDef.h
1
2#ifndef ROSE_SgAsmCilTypeDef_H
3#define ROSE_SgAsmCilTypeDef_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 SgAsmCilTypeDef
23
24/* #line 25 "../../../src/frontend/SageIII//SgAsmCilTypeDef.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 SgAsmCilTypeDef
32class ROSE_DLL_API SgAsmCilTypeDef : public SgAsmCilMetadata
33 {
34 public:
35
36
37/* #line 38 "../../../src/frontend/SageIII//SgAsmCilTypeDef.h" */
38
39 virtual SgNode* copy ( SgCopyHelp& help) const override;
40// Start of memberFunctionString
41/* #line 32262 "/workspace/src/ROSETTA/src/binaryInstruction.C" */
42
43
44 //----------------------- Boost serialization for SgAsmCilTypeDef -----------------------
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("SgAsmCilTypeDef");
52 s & BOOST_SERIALIZATION_BASE_OBJECT_NVP(SgAsmCilMetadata);
53 s & BOOST_SERIALIZATION_NVP(p_Flags);
54 s & BOOST_SERIALIZATION_NVP(p_TypeName);
55 s & BOOST_SERIALIZATION_NVP(p_TypeNamespace);
56 s & BOOST_SERIALIZATION_NVP(p_Extends);
57 s & BOOST_SERIALIZATION_NVP(p_FieldList);
58 s & BOOST_SERIALIZATION_NVP(p_MethodList);
59 debugSerializationEnd("SgAsmCilTypeDef");
60 }
61#endif // ROSE_HAVE_BOOST_SERIALIZATION_LIB
62
63public:
69 uint32_t const& get_Flags() const;
70 void set_Flags(uint32_t const&);
73public:
79 uint32_t const& get_TypeName() const;
80 void set_TypeName(uint32_t const&);
83public:
89 uint32_t const& get_TypeNamespace() const;
90 void set_TypeNamespace(uint32_t const&);
93public:
99 uint32_t const& get_Extends() const;
100 void set_Extends(uint32_t const&);
103public:
109 uint32_t const& get_FieldList() const;
110 void set_FieldList(uint32_t const&);
113public:
119 uint32_t const& get_MethodList() const;
120 void set_MethodList(uint32_t const&);
122public:
123 void parse(const std::vector<uint8_t>& buf, size_t& index, uint64_t uses4byteIndexing);
124 void unparse(std::vector<uint8_t>& buf, size_t& index, uint64_t uses4byteIndexing) const;
125 void dump(std::ostream&) const;
126
127 const std::uint8_t* get_TypeName_string() const;
128 const std::uint8_t* get_TypeNamespace_string() const;
129 const SgAsmCilMetadata* get_Extends_object() const;
130 const SgAsmCilMetadata* get_FieldList_object() const;
131 const SgAsmCilMetadata* get_MethodList_object() const;
132 const SgAsmCilMetadata* get_MethodList_object(const SgAsmCilMethodDef*) const;
133public:
135 virtual ~SgAsmCilTypeDef();
136
137public:
140
141protected:
149
150
151// End of memberFunctionString
152// Start of memberFunctionString
153/* #line 1 "/workspace/src/ROSETTA/Grammar/Common.code" */
154
155// *** COMMON CODE SECTION BEGINS HERE ***
156
157 public:
158
159 // DQ (3/25/3006): I put this back in because it had the logic for where the copy function required
160 // and not required which is required to match the other aspects of the copy mechanism code generation.
161 // Specifically it is a problem to declare the copy function everywhere because it is not implemented
162 // for the SgSymbol IR nodes. I'm not clear why it is not implemented for these IR nodes.
163 /* \brief Copies AST (whole subtree, depending on the SgCopyHelp class */
164 // virtual SgNode* copy ( const SgCopyHelp & help) const;
165
167 virtual std::string class_name() const override;
168
170 virtual VariantT variantT() const override; // MS: new variant used in tree traversal
171
173 // King84 (2010.08.16): Moved this to an enum to save space, since it's only used at compiler-time anyway.
174 // static const VariantT static_variant = V_SgAsmCilTypeDef;
175 enum { static_variant = V_SgAsmCilTypeDef };
176
177 /* the generated cast function */
179 ROSE_DLL_API friend SgAsmCilTypeDef* isSgAsmCilTypeDef( SgNode * s );
180
182 ROSE_DLL_API friend const SgAsmCilTypeDef* isSgAsmCilTypeDef( const SgNode * s );
183
184 // ******************************************
185 // * Memory Pool / New / Delete
186 // ******************************************
187
188 public:
190 static const unsigned pool_size; //
192 static std::vector<unsigned char *> pools; //
194 static SgAsmCilTypeDef * next_node; //
195
197 static unsigned long initializeStorageClassArray(SgAsmCilTypeDefStorageClass *); //
198
200 static void clearMemoryPool(); //
201 static void deleteMemoryPool(); //
202
204 static void extendMemoryPoolForFileIO(); //
205
207 static SgAsmCilTypeDef * getPointerFromGlobalIndex(unsigned long); //
209 static SgAsmCilTypeDef * getPointerFromGlobalIndex(AstSpecificDataManagingClass *, unsigned long); //
210
212 static unsigned long getNumberOfValidNodesAndSetGlobalIndexInFreepointer(unsigned long); //
214 static void resetValidFreepointers(); //
216 static unsigned long getNumberOfLastValidPointer(); //
217
218
219#if defined(INLINE_FUNCTIONS)
221 inline void *operator new (size_t size);
222#else
224 void *operator new (size_t size);
225#endif
227 void operator delete (void* pointer, size_t size);
228
229 // DQ (4/5/2007): This is not the correct operator that we want, but appears to be required to compile ROSE with ROSE.
230 void operator delete (void* pointer)
231 {
232 // This is the generated delete operator...
233 SgAsmCilTypeDef::operator delete (pointer,sizeof(SgAsmCilTypeDef));
234 }
235
237 static size_t numberOfNodes();
238
240 static size_t memoryUsage();
241
242 // End of scope which started in IR nodes specific code
243 /* */
244
245 /* name Internal Functions
246 \brief Internal functions ... incomplete-documentation
247
248 These functions have been made public as part of the design, but they are suggested for internal use
249 or by particularly knowledgeable users for specialized tools or applications.
250
251 \internal We could not make these private because they are required by user for special purposes. And
252 it would be unwieldy to have many of the internal classes in ROSE be explicitly defined as friends.
253
254 */
255
256 // MS: 02/12/02 container of pointers to AST successor nodes used in the traversal
257 // overridden in every class by *generated* implementation
259 virtual std::vector<SgNode*> get_traversalSuccessorContainer() override;
260 // MS: 06/28/02 container of names of variables or container indices
261 // used used in the traversal to access AST successor nodes
262 // overridden in every class by *generated* implementation
265 virtual std::vector<std::string> get_traversalSuccessorNamesContainer() override;
266
267 // GB (09/25/2007): Functions for index-based access to traversal successors; these are hopefully a lot faster
268 // than all the vector copies. The implementation for these functions is generated for each class.
270 virtual size_t get_numberOfTraversalSuccessors() override;
272 virtual SgNode *get_traversalSuccessorByIndex(size_t idx) override;
274 virtual size_t get_childIndex(SgNode *child) override;
275
276#ifndef ROSE_USE_INTERNAL_FRONTEND_DEVELOPMENT
277 // MS: 08/16/2002 method for generating RTI information
279 virtual RTIReturnType roseRTI() override;
280#endif
281 /* */
282
283
284
285 /* name Deprecated Functions
286 \brief Deprecated functions ... incomplete-documentation
287
288 These functions have been deprecated from use.
289 */
290 /* */
291
293 virtual const char* sage_class_name() const override ROSE_DEPRECATED_FUNCTION;
294
295 // JJW (10/16/2008): Changed to a single function in Node.code, and put
296 // getVariant() in #if 0 block to prevent confusing Doxygen
297#if 0
299 virtual int variant() const ROSE_DEPRECATED_FUNCTION;
301 // virtual int getVariant() const ROSE_DEPRECATED_FUNCTION;
302#endif
303 /* */
304
305
306
307
308 public:
309 /* name Traversal Support Functions
310 \brief Traversal support functions ... incomplete-documentation
311
312 These functions have been made public as part of the design, but they are suggested for internal use
313 or by particularly knowledgable users for specialized tools or applications.
314 */
315 /* */
316
317 // DQ (11/26/2005): Support for visitor pattern mechanims
318 // (inferior to ROSE traversal mechanism, experimental).
322
323 /* DXN (08/09/2010): support for the classic visitor pattern done in GoF */
325 virtual void accept (ROSE_VisitorPattern & visitor) override;
326
327 // DQ (12/26/2005): Support for traversal based on the memory pool
330 static void traverseMemoryPoolNodes(ROSE_VisitTraversal & visit);
331
335
336 // DQ (2/9/2006): Added to support traversal over single representative of each IR node
337 // This traversal helps support internal tools that call static member functions.
338 // note: this function operates on the memory pools.
341 static void visitRepresentativeNode (ROSE_VisitTraversal & visit);
342 /* */
343
344 public:
345 /* NodeId support functions */
347 static SgNode* getNodeByNodeId(VariantT variantT, size_t poolIdx, size_t itemIdx);
350 static SgAsmCilTypeDef* getNodeByNodeIdInternal(size_t poolIdx, size_t itemIdx);
353 static std::string getNodeIdString(SgAsmCilTypeDef* sgnode);
354 static std::string getNodeIdStringInternal(SgAsmCilTypeDef* sgnode);
355
356 public:
357 /* name Memory Allocation Functions
358 \brief Memory allocations functions ... incomplete-documentation
359
360 These functions have been made public as part of the design, but they are suggested for internal use
361 or by particularly knowledgable users for specialized tools or applications.
362 */
363 /* */
364
375 virtual bool isInMemoryPool() override;
376
387 virtual void checkDataMemberPointersIfInMemoryPool() override;
388
389 // DQ (4/30/2006): Modified to be a const function.
404 virtual std::vector<std::pair<SgNode*,std::string> > returnDataMemberPointers() const override;
405
416
428 virtual long getChildIndex( SgNode* childNode ) const override;
429
430 // DQ (9/2/2015): Since this function is generated by ROSETTA, we can't define the
431 // comment here (changed to be a C style comment and not be a doxygen comment).
432 /* \brief Constructor for use by AST File I/O Mechanism
433
434 This constructor permits the IR node to be rebuilt from the contiguously arranged data in memory
435 which obtained via fast binary file I/O from disk.
436 */
437 // SgAsmCilTypeDef( SgAsmCilTypeDefStorageClass& source );
438
439
440
441
442
443 // JH (10/24/2005): methods added to support the ast file IO
444 private:
445
446 /* name AST Memory Allocation Support Functions
447 \brief Memory allocations support....
448
449 These functions handle the low leve support of the memory allocation scheme which permits IR nodes to be allocated
450 in large contiguous blocks to reduce memory fragmentation, improve performance, support specialized access (AST traversals),
451 and support the AST File I/O Mechanism.
452 */
453 /* */
454
455 /* JH (10/24/2005): Two typedefs. The TestType notes the type every pointer is cast to before
456 we compare them. Since I had several problems with this, I decided to make a typdef to ensure
457 that I use the same type everywhere, if any changes are made. THe second one declares the type
458 (actually unsigned long) where teh pointer address gets converted to. On 64 bit platforms this
459 might got changed, but unfortunatly, the return types are still unsigned longs. There exists
460 a correspinding one in the AST_FILE_IO class!
461 */
462 // DQ (9/2/2015): This typedef is no longer used, we can't define the
463 // comment here (changed to be a C style comment and not be a doxygen comment).
464 /* \brief Typedef used for low level memory access.
465 */
466 // typedef unsigned char* TestType;
467
468 // DQ (9/2/2015): This typedef is no longer used, we can't define the
469 // comment here (changed to be a C style comment and not be a doxygen comment).
470 /* \brief Typedef used to hold memory addresses as values.
471 */
472 // typedef unsigned long AddressType;
473
474
475
476 // necessary, to have direct access to the p_freepointer and the private methods !
478 friend class AST_FILE_IO;
479
481 friend class SgAsmCilTypeDefStorageClass;
482
484 friend class AstSpecificDataManagingClass;
485
487 friend class AstSpecificDataManagingClassStorageClass;
488 public:
490 SgAsmCilTypeDef( const SgAsmCilTypeDefStorageClass& source );
491
492 // private: // JJW hack
493 /*
494 name AST Memory Allocation Support Variables
495 Memory allocations support variables
496
497 These variables handle the low level support of the memory allocation scheme which permits IR nodes to be allocated
498 in large contiguous blocks to reduce memory fragmentation, improve performance, support specialized access (AST traversals),
499 and support the AST File I/O Mechanism.
500 */
501 /* */
502
503 public:
504
505 // DQ (11/21/2009): Added function to add new Regular Expression attributes and return pointer
506 // to current node (so that it will work cleanly with build functions to specify patterns).
507 // virtual SgNode* addRegExpAttribute();
514
515#ifndef _MSC_VER
516// Rasmussen (04/17/2019): Support for ATerms has been deprecated as it is no longer needed
517// and likely never fully implemented nor tested. Files remain in the src tree but are no
518// longer built.
519#define BUILD_ATERM_SUPPORT 0
520 #if BUILD_ATERM_SUPPORT
521 #ifdef ROSE_USE_ROSE_ATERM_SUPPORT
522 // DQ (10/4/2014): Adding ATerm support to ROSE.
532 // Rasmussen (1/7/2019): Added override to kill warning messages of overridden virtual function
533 virtual ATerm generate_ATerm() override;
534
536 virtual void generate_ATerm_Annotation(ATerm & term) override;
537 #endif
538 #endif // BUILD_ATERM_SUPPORT
539#endif
540 // These can't be virtual functions since we don't yet know what IR node to build (until we have read the aterm).
541 // virtual generate_AST(ATerm & term);
542 // virtual void read_ATerm_Annotation(ATerm & term);
543
544// *** COMMON CODE SECTION ENDS HERE ***
545
546
547// End of memberFunctionString
548// Start of memberFunctionString
549/* #line 706 "/workspace/src/ROSETTA/Grammar/Node.code" */
550
551 // the generated cast function
552 // friend ROSE_DLL_API SgAsmCilTypeDef* isSgAsmCilTypeDef ( SgNode* s );
553
554 typedef SgAsmCilMetadata base_node_type;
555
556
557// End of memberFunctionString
558
559
560
561
562
563
564
565 protected:
566// Start of memberFunctionString
567uint32_t p_Flags;
568
569// End of memberFunctionString
570// Start of memberFunctionString
571uint32_t p_TypeName;
572
573// End of memberFunctionString
574// Start of memberFunctionString
575uint32_t p_TypeNamespace;
576
577// End of memberFunctionString
578// Start of memberFunctionString
579uint32_t p_Extends;
580
581// End of memberFunctionString
582// Start of memberFunctionString
583uint32_t p_FieldList;
584
585// End of memberFunctionString
586// Start of memberFunctionString
587uint32_t p_MethodList;
588
589// End of memberFunctionString
590
592 friend struct Rose::Traits::generated::describe_field_t<SgAsmCilTypeDef, uint32_t,&SgAsmCilTypeDef::p_Flags>;
593 friend struct Rose::Traits::generated::describe_field_t<SgAsmCilTypeDef, uint32_t,&SgAsmCilTypeDef::p_TypeName>;
594 friend struct Rose::Traits::generated::describe_field_t<SgAsmCilTypeDef, uint32_t,&SgAsmCilTypeDef::p_TypeNamespace>;
595 friend struct Rose::Traits::generated::describe_field_t<SgAsmCilTypeDef, uint32_t,&SgAsmCilTypeDef::p_Extends>;
596 friend struct Rose::Traits::generated::describe_field_t<SgAsmCilTypeDef, uint32_t,&SgAsmCilTypeDef::p_FieldList>;
597 friend struct Rose::Traits::generated::describe_field_t<SgAsmCilTypeDef, uint32_t,&SgAsmCilTypeDef::p_MethodList>;
598
599/* #line 21 "/workspace/src/ROSETTA/Grammar/grammarClassDeclarationMacros.macro" */
600
601
602 };
603#endif
604
605// postdeclarations for SgAsmCilTypeDef
606
607/* #line 608 "../../../src/frontend/SageIII//SgAsmCilTypeDef.h" */
608
609/* #line 27 "/workspace/src/ROSETTA/Grammar/grammarClassDeclarationMacros.macro after subst for $POSTDECLARATIONS" */
610
611/* #line 28 "/workspace/src/ROSETTA/Grammar/grammarClassDeclarationMacros.macro" */
612
613
614/* #line 615 "../../../src/frontend/SageIII//SgAsmCilTypeDef.h" */
615
616#endif // ROSE_SgAsmCilTypeDef_H
617
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 CIL branch of binary analysis IR nodes.
void initializeProperties()
Initialize all properties that have explicit initial values.
CIL MethodDef node (II.22.26).
CIL TypeDef node (II.22.37).
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.