ROSE 0.11.145.147
SgAsmDwarfConstructList.h
1
2#ifndef ROSE_SgAsmDwarfConstructList_H
3#define ROSE_SgAsmDwarfConstructList_H
4#include <RoseFirst.h>
5#include <Cxx_GrammarDeclarations.h>
6#include <SgAsmDwarfInformation.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 SgAsmDwarfConstructList
23
24/* #line 25 "../../../src/frontend/SageIII//SgAsmDwarfConstructList.h" */
25/* #line 26921 "/workspace/src/ROSETTA/src/binaryInstruction.C" */
26
27#include <sageContainer.h>
28
29
30/* #line 13 "/workspace/src/ROSETTA/Grammar/grammarClassDeclarationMacros.macro after subst for $PREDECLARATIONS" */
31
32/* #line 14 "/workspace/src/ROSETTA/Grammar/grammarClassDeclarationMacros.macro" */
33
34#if !defined(DOCUMENTATION)
35// Class Definition for SgAsmDwarfConstructList
36class ROSE_DLL_API SgAsmDwarfConstructList : public SgAsmDwarfInformation
37 {
38 public:
39
40
41/* #line 42 "../../../src/frontend/SageIII//SgAsmDwarfConstructList.h" */
42
43 virtual SgNode* copy ( SgCopyHelp& help) const override;
44// Start of memberFunctionString
45/* #line 26936 "/workspace/src/ROSETTA/src/binaryInstruction.C" */
46
47
48 //----------------------- Boost serialization for SgAsmDwarfConstructList -----------------------
49#ifdef ROSE_HAVE_BOOST_SERIALIZATION_LIB
50private:
51 friend class boost::serialization::access;
52
53 template<class S>
54 void serialize(S &s, const unsigned /*version*/) {
55 debugSerializationBegin("SgAsmDwarfConstructList");
56 s & BOOST_SERIALIZATION_BASE_OBJECT_NVP(SgAsmDwarfInformation);
57 s & BOOST_SERIALIZATION_NVP(p_list);
58 debugSerializationEnd("SgAsmDwarfConstructList");
59 }
60#endif // ROSE_HAVE_BOOST_SERIALIZATION_LIB
61public:
62public:
63 SgAsmDwarfConstructPtrList const& get_list() const;
64 SgAsmDwarfConstructPtrList& get_list();
65 void set_list(SgAsmDwarfConstructPtrList const&);
66
67public:
70
71public:
74
75protected:
83
84
85// End of memberFunctionString
86// Start of memberFunctionString
87/* #line 1 "/workspace/src/ROSETTA/Grammar/Common.code" */
88
89// *** COMMON CODE SECTION BEGINS HERE ***
90
91 public:
92
93 // DQ (3/25/3006): I put this back in because it had the logic for where the copy function required
94 // and not required which is required to match the other aspects of the copy mechanism code generation.
95 // Specifically it is a problem to declare the copy function everywhere because it is not implemented
96 // for the SgSymbol IR nodes. I'm not clear why it is not implemented for these IR nodes.
97 /* \brief Copies AST (whole subtree, depending on the SgCopyHelp class */
98 // virtual SgNode* copy ( const SgCopyHelp & help) const;
99
101 virtual std::string class_name() const override;
102
104 virtual VariantT variantT() const override; // MS: new variant used in tree traversal
105
107 // King84 (2010.08.16): Moved this to an enum to save space, since it's only used at compiler-time anyway.
108 // static const VariantT static_variant = V_SgAsmDwarfConstructList;
109 enum { static_variant = V_SgAsmDwarfConstructList };
110
111 /* the generated cast function */
113 ROSE_DLL_API friend SgAsmDwarfConstructList* isSgAsmDwarfConstructList( SgNode * s );
114
116 ROSE_DLL_API friend const SgAsmDwarfConstructList* isSgAsmDwarfConstructList( const SgNode * s );
117
118 // ******************************************
119 // * Memory Pool / New / Delete
120 // ******************************************
121
122 public:
124 static const unsigned pool_size; //
126 static std::vector<unsigned char *> pools; //
128 static SgAsmDwarfConstructList * next_node; //
129
131 static unsigned long initializeStorageClassArray(SgAsmDwarfConstructListStorageClass *); //
132
134 static void clearMemoryPool(); //
135 static void deleteMemoryPool(); //
136
138 static void extendMemoryPoolForFileIO(); //
139
141 static SgAsmDwarfConstructList * getPointerFromGlobalIndex(unsigned long); //
143 static SgAsmDwarfConstructList * getPointerFromGlobalIndex(AstSpecificDataManagingClass *, unsigned long); //
144
146 static unsigned long getNumberOfValidNodesAndSetGlobalIndexInFreepointer(unsigned long); //
148 static void resetValidFreepointers(); //
150 static unsigned long getNumberOfLastValidPointer(); //
151
152
153#if defined(INLINE_FUNCTIONS)
155 inline void *operator new (size_t size);
156#else
158 void *operator new (size_t size);
159#endif
161 void operator delete (void* pointer, size_t size);
162
163 // DQ (4/5/2007): This is not the correct operator that we want, but appears to be required to compile ROSE with ROSE.
164 void operator delete (void* pointer)
165 {
166 // This is the generated delete operator...
167 SgAsmDwarfConstructList::operator delete (pointer,sizeof(SgAsmDwarfConstructList));
168 }
169
171 static size_t numberOfNodes();
172
174 static size_t memoryUsage();
175
176 // End of scope which started in IR nodes specific code
177 /* */
178
179 /* name Internal Functions
180 \brief Internal functions ... incomplete-documentation
181
182 These functions have been made public as part of the design, but they are suggested for internal use
183 or by particularly knowledgeable users for specialized tools or applications.
184
185 \internal We could not make these private because they are required by user for special purposes. And
186 it would be unwieldy to have many of the internal classes in ROSE be explicitly defined as friends.
187
188 */
189
190 // MS: 02/12/02 container of pointers to AST successor nodes used in the traversal
191 // overridden in every class by *generated* implementation
193 virtual std::vector<SgNode*> get_traversalSuccessorContainer() override;
194 // MS: 06/28/02 container of names of variables or container indices
195 // used used in the traversal to access AST successor nodes
196 // overridden in every class by *generated* implementation
199 virtual std::vector<std::string> get_traversalSuccessorNamesContainer() override;
200
201 // GB (09/25/2007): Functions for index-based access to traversal successors; these are hopefully a lot faster
202 // than all the vector copies. The implementation for these functions is generated for each class.
204 virtual size_t get_numberOfTraversalSuccessors() override;
206 virtual SgNode *get_traversalSuccessorByIndex(size_t idx) override;
208 virtual size_t get_childIndex(SgNode *child) override;
209
210#ifndef ROSE_USE_INTERNAL_FRONTEND_DEVELOPMENT
211 // MS: 08/16/2002 method for generating RTI information
213 virtual RTIReturnType roseRTI() override;
214#endif
215 /* */
216
217
218
219 /* name Deprecated Functions
220 \brief Deprecated functions ... incomplete-documentation
221
222 These functions have been deprecated from use.
223 */
224 /* */
225
227 virtual const char* sage_class_name() const override ROSE_DEPRECATED_FUNCTION;
228
229 // JJW (10/16/2008): Changed to a single function in Node.code, and put
230 // getVariant() in #if 0 block to prevent confusing Doxygen
231#if 0
233 virtual int variant() const ROSE_DEPRECATED_FUNCTION;
235 // virtual int getVariant() const ROSE_DEPRECATED_FUNCTION;
236#endif
237 /* */
238
239
240
241
242 public:
243 /* name Traversal Support Functions
244 \brief Traversal support functions ... incomplete-documentation
245
246 These functions have been made public as part of the design, but they are suggested for internal use
247 or by particularly knowledgable users for specialized tools or applications.
248 */
249 /* */
250
251 // DQ (11/26/2005): Support for visitor pattern mechanims
252 // (inferior to ROSE traversal mechanism, experimental).
256
257 /* DXN (08/09/2010): support for the classic visitor pattern done in GoF */
259 virtual void accept (ROSE_VisitorPattern & visitor) override;
260
261 // DQ (12/26/2005): Support for traversal based on the memory pool
264 static void traverseMemoryPoolNodes(ROSE_VisitTraversal & visit);
265
269
270 // DQ (2/9/2006): Added to support traversal over single representative of each IR node
271 // This traversal helps support internal tools that call static member functions.
272 // note: this function operates on the memory pools.
275 static void visitRepresentativeNode (ROSE_VisitTraversal & visit);
276 /* */
277
278 public:
279 /* NodeId support functions */
281 static SgNode* getNodeByNodeId(VariantT variantT, size_t poolIdx, size_t itemIdx);
284 static SgAsmDwarfConstructList* getNodeByNodeIdInternal(size_t poolIdx, size_t itemIdx);
287 static std::string getNodeIdString(SgAsmDwarfConstructList* sgnode);
288 static std::string getNodeIdStringInternal(SgAsmDwarfConstructList* sgnode);
289
290 public:
291 /* name Memory Allocation Functions
292 \brief Memory allocations functions ... incomplete-documentation
293
294 These functions have been made public as part of the design, but they are suggested for internal use
295 or by particularly knowledgable users for specialized tools or applications.
296 */
297 /* */
298
309 virtual bool isInMemoryPool() override;
310
321 virtual void checkDataMemberPointersIfInMemoryPool() override;
322
323 // DQ (4/30/2006): Modified to be a const function.
338 virtual std::vector<std::pair<SgNode*,std::string> > returnDataMemberPointers() const override;
339
350
362 virtual long getChildIndex( SgNode* childNode ) const override;
363
364 // DQ (9/2/2015): Since this function is generated by ROSETTA, we can't define the
365 // comment here (changed to be a C style comment and not be a doxygen comment).
366 /* \brief Constructor for use by AST File I/O Mechanism
367
368 This constructor permits the IR node to be rebuilt from the contiguously arranged data in memory
369 which obtained via fast binary file I/O from disk.
370 */
371 // SgAsmDwarfConstructList( SgAsmDwarfConstructListStorageClass& source );
372
373
374
375
376
377 // JH (10/24/2005): methods added to support the ast file IO
378 private:
379
380 /* name AST Memory Allocation Support Functions
381 \brief Memory allocations support....
382
383 These functions handle the low leve support of the memory allocation scheme which permits IR nodes to be allocated
384 in large contiguous blocks to reduce memory fragmentation, improve performance, support specialized access (AST traversals),
385 and support the AST File I/O Mechanism.
386 */
387 /* */
388
389 /* JH (10/24/2005): Two typedefs. The TestType notes the type every pointer is cast to before
390 we compare them. Since I had several problems with this, I decided to make a typdef to ensure
391 that I use the same type everywhere, if any changes are made. THe second one declares the type
392 (actually unsigned long) where teh pointer address gets converted to. On 64 bit platforms this
393 might got changed, but unfortunatly, the return types are still unsigned longs. There exists
394 a correspinding one in the AST_FILE_IO class!
395 */
396 // DQ (9/2/2015): This typedef is no longer used, we can't define the
397 // comment here (changed to be a C style comment and not be a doxygen comment).
398 /* \brief Typedef used for low level memory access.
399 */
400 // typedef unsigned char* TestType;
401
402 // DQ (9/2/2015): This typedef is no longer used, we can't define the
403 // comment here (changed to be a C style comment and not be a doxygen comment).
404 /* \brief Typedef used to hold memory addresses as values.
405 */
406 // typedef unsigned long AddressType;
407
408
409
410 // necessary, to have direct access to the p_freepointer and the private methods !
412 friend class AST_FILE_IO;
413
415 friend class SgAsmDwarfConstructListStorageClass;
416
418 friend class AstSpecificDataManagingClass;
419
421 friend class AstSpecificDataManagingClassStorageClass;
422 public:
424 SgAsmDwarfConstructList( const SgAsmDwarfConstructListStorageClass& source );
425
426 // private: // JJW hack
427 /*
428 name AST Memory Allocation Support Variables
429 Memory allocations support variables
430
431 These variables handle the low level support of the memory allocation scheme which permits IR nodes to be allocated
432 in large contiguous blocks to reduce memory fragmentation, improve performance, support specialized access (AST traversals),
433 and support the AST File I/O Mechanism.
434 */
435 /* */
436
437 public:
438
439 // DQ (11/21/2009): Added function to add new Regular Expression attributes and return pointer
440 // to current node (so that it will work cleanly with build functions to specify patterns).
441 // virtual SgNode* addRegExpAttribute();
448
449#ifndef _MSC_VER
450// Rasmussen (04/17/2019): Support for ATerms has been deprecated as it is no longer needed
451// and likely never fully implemented nor tested. Files remain in the src tree but are no
452// longer built.
453#define BUILD_ATERM_SUPPORT 0
454 #if BUILD_ATERM_SUPPORT
455 #ifdef ROSE_USE_ROSE_ATERM_SUPPORT
456 // DQ (10/4/2014): Adding ATerm support to ROSE.
466 // Rasmussen (1/7/2019): Added override to kill warning messages of overridden virtual function
467 virtual ATerm generate_ATerm() override;
468
470 virtual void generate_ATerm_Annotation(ATerm & term) override;
471 #endif
472 #endif // BUILD_ATERM_SUPPORT
473#endif
474 // These can't be virtual functions since we don't yet know what IR node to build (until we have read the aterm).
475 // virtual generate_AST(ATerm & term);
476 // virtual void read_ATerm_Annotation(ATerm & term);
477
478// *** COMMON CODE SECTION ENDS HERE ***
479
480
481// End of memberFunctionString
482// Start of memberFunctionString
483/* #line 706 "/workspace/src/ROSETTA/Grammar/Node.code" */
484
485 // the generated cast function
486 // friend ROSE_DLL_API SgAsmDwarfConstructList* isSgAsmDwarfConstructList ( SgNode* s );
487
488 typedef SgAsmDwarfInformation base_node_type;
489
490
491// End of memberFunctionString
492
493
494 protected:
495// Start of memberFunctionString
496SgAsmDwarfConstructPtrList p_list;
497
498// End of memberFunctionString
499
501 friend struct Rose::Traits::generated::describe_field_t<SgAsmDwarfConstructList, SgAsmDwarfConstructPtrList,&SgAsmDwarfConstructList::p_list>;
502
503/* #line 21 "/workspace/src/ROSETTA/Grammar/grammarClassDeclarationMacros.macro" */
504
505
506 };
507#endif
508
509// postdeclarations for SgAsmDwarfConstructList
510
511/* #line 512 "../../../src/frontend/SageIII//SgAsmDwarfConstructList.h" */
512
513/* #line 27 "/workspace/src/ROSETTA/Grammar/grammarClassDeclarationMacros.macro after subst for $POSTDECLARATIONS" */
514
515/* #line 28 "/workspace/src/ROSETTA/Grammar/grammarClassDeclarationMacros.macro" */
516
517
518/* #line 519 "../../../src/frontend/SageIII//SgAsmDwarfConstructList.h" */
519
520#endif // ROSE_SgAsmDwarfConstructList_H
521
Class holding static data and functions supporting File I/O.
Definition AST_FILE_IO.h:19
Attribute containing a regex expression as a string.
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 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.