ROSE 0.11.145.147
SgAsmBinaryPostupdate.h
1
2#ifndef ROSE_SgAsmBinaryPostupdate_H
3#define ROSE_SgAsmBinaryPostupdate_H
4#include <RoseFirst.h>
5#include <Cxx_GrammarDeclarations.h>
6#include <SgAsmBinaryExpression.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 SgAsmBinaryPostupdate
23
24/* #line 25 "../../../src/frontend/SageIII//SgAsmBinaryPostupdate.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 SgAsmBinaryPostupdate
32class ROSE_DLL_API SgAsmBinaryPostupdate : public SgAsmBinaryExpression
33 {
34 public:
35
36
37/* #line 38 "../../../src/frontend/SageIII//SgAsmBinaryPostupdate.h" */
38
39 virtual SgNode* copy ( SgCopyHelp& help) const override;
40// Start of memberFunctionString
41/* #line 41377 "/workspace/src/ROSETTA/src/binaryInstruction.C" */
42
43
44 //----------------------- Boost serialization for SgAsmBinaryPostupdate -----------------------
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("SgAsmBinaryPostupdate");
52 s & BOOST_SERIALIZATION_BASE_OBJECT_NVP(SgAsmBinaryExpression);
53 debugSerializationEnd("SgAsmBinaryPostupdate");
54 }
55#endif // ROSE_HAVE_BOOST_SERIALIZATION_LIB
56
57public:
59 virtual ~SgAsmBinaryPostupdate();
60
61public:
64
65public:
68 SgAsmExpression* const& rhs);
69
70protected:
78
79
80// End of memberFunctionString
81// Start of memberFunctionString
82/* #line 1 "/workspace/src/ROSETTA/Grammar/Common.code" */
83
84// *** COMMON CODE SECTION BEGINS HERE ***
85
86 public:
87
88 // DQ (3/25/3006): I put this back in because it had the logic for where the copy function required
89 // and not required which is required to match the other aspects of the copy mechanism code generation.
90 // Specifically it is a problem to declare the copy function everywhere because it is not implemented
91 // for the SgSymbol IR nodes. I'm not clear why it is not implemented for these IR nodes.
92 /* \brief Copies AST (whole subtree, depending on the SgCopyHelp class */
93 // virtual SgNode* copy ( const SgCopyHelp & help) const;
94
96 virtual std::string class_name() const override;
97
99 virtual VariantT variantT() const override; // MS: new variant used in tree traversal
100
102 // King84 (2010.08.16): Moved this to an enum to save space, since it's only used at compiler-time anyway.
103 // static const VariantT static_variant = V_SgAsmBinaryPostupdate;
104 enum { static_variant = V_SgAsmBinaryPostupdate };
105
106 /* the generated cast function */
108 ROSE_DLL_API friend SgAsmBinaryPostupdate* isSgAsmBinaryPostupdate( SgNode * s );
109
111 ROSE_DLL_API friend const SgAsmBinaryPostupdate* isSgAsmBinaryPostupdate( const SgNode * s );
112
113 // ******************************************
114 // * Memory Pool / New / Delete
115 // ******************************************
116
117 public:
119 static const unsigned pool_size; //
121 static std::vector<unsigned char *> pools; //
123 static SgAsmBinaryPostupdate * next_node; //
124
126 static unsigned long initializeStorageClassArray(SgAsmBinaryPostupdateStorageClass *); //
127
129 static void clearMemoryPool(); //
130 static void deleteMemoryPool(); //
131
133 static void extendMemoryPoolForFileIO(); //
134
136 static SgAsmBinaryPostupdate * getPointerFromGlobalIndex(unsigned long); //
138 static SgAsmBinaryPostupdate * getPointerFromGlobalIndex(AstSpecificDataManagingClass *, unsigned long); //
139
141 static unsigned long getNumberOfValidNodesAndSetGlobalIndexInFreepointer(unsigned long); //
143 static void resetValidFreepointers(); //
145 static unsigned long getNumberOfLastValidPointer(); //
146
147
148#if defined(INLINE_FUNCTIONS)
150 inline void *operator new (size_t size);
151#else
153 void *operator new (size_t size);
154#endif
156 void operator delete (void* pointer, size_t size);
157
158 // DQ (4/5/2007): This is not the correct operator that we want, but appears to be required to compile ROSE with ROSE.
159 void operator delete (void* pointer)
160 {
161 // This is the generated delete operator...
162 SgAsmBinaryPostupdate::operator delete (pointer,sizeof(SgAsmBinaryPostupdate));
163 }
164
166 static size_t numberOfNodes();
167
169 static size_t memoryUsage();
170
171 // End of scope which started in IR nodes specific code
172 /* */
173
174 /* name Internal Functions
175 \brief Internal functions ... incomplete-documentation
176
177 These functions have been made public as part of the design, but they are suggested for internal use
178 or by particularly knowledgeable users for specialized tools or applications.
179
180 \internal We could not make these private because they are required by user for special purposes. And
181 it would be unwieldy to have many of the internal classes in ROSE be explicitly defined as friends.
182
183 */
184
185 // MS: 02/12/02 container of pointers to AST successor nodes used in the traversal
186 // overridden in every class by *generated* implementation
188 virtual std::vector<SgNode*> get_traversalSuccessorContainer() override;
189 // MS: 06/28/02 container of names of variables or container indices
190 // used used in the traversal to access AST successor nodes
191 // overridden in every class by *generated* implementation
194 virtual std::vector<std::string> get_traversalSuccessorNamesContainer() override;
195
196 // GB (09/25/2007): Functions for index-based access to traversal successors; these are hopefully a lot faster
197 // than all the vector copies. The implementation for these functions is generated for each class.
199 virtual size_t get_numberOfTraversalSuccessors() override;
201 virtual SgNode *get_traversalSuccessorByIndex(size_t idx) override;
203 virtual size_t get_childIndex(SgNode *child) override;
204
205#ifndef ROSE_USE_INTERNAL_FRONTEND_DEVELOPMENT
206 // MS: 08/16/2002 method for generating RTI information
208 virtual RTIReturnType roseRTI() override;
209#endif
210 /* */
211
212
213
214 /* name Deprecated Functions
215 \brief Deprecated functions ... incomplete-documentation
216
217 These functions have been deprecated from use.
218 */
219 /* */
220
222 virtual const char* sage_class_name() const override ROSE_DEPRECATED_FUNCTION;
223
224 // JJW (10/16/2008): Changed to a single function in Node.code, and put
225 // getVariant() in #if 0 block to prevent confusing Doxygen
226#if 0
228 virtual int variant() const ROSE_DEPRECATED_FUNCTION;
230 // virtual int getVariant() const ROSE_DEPRECATED_FUNCTION;
231#endif
232 /* */
233
234
235
236
237 public:
238 /* name Traversal Support Functions
239 \brief Traversal support functions ... incomplete-documentation
240
241 These functions have been made public as part of the design, but they are suggested for internal use
242 or by particularly knowledgable users for specialized tools or applications.
243 */
244 /* */
245
246 // DQ (11/26/2005): Support for visitor pattern mechanims
247 // (inferior to ROSE traversal mechanism, experimental).
251
252 /* DXN (08/09/2010): support for the classic visitor pattern done in GoF */
254 virtual void accept (ROSE_VisitorPattern & visitor) override;
255
256 // DQ (12/26/2005): Support for traversal based on the memory pool
259 static void traverseMemoryPoolNodes(ROSE_VisitTraversal & visit);
260
264
265 // DQ (2/9/2006): Added to support traversal over single representative of each IR node
266 // This traversal helps support internal tools that call static member functions.
267 // note: this function operates on the memory pools.
270 static void visitRepresentativeNode (ROSE_VisitTraversal & visit);
271 /* */
272
273 public:
274 /* NodeId support functions */
276 static SgNode* getNodeByNodeId(VariantT variantT, size_t poolIdx, size_t itemIdx);
279 static SgAsmBinaryPostupdate* getNodeByNodeIdInternal(size_t poolIdx, size_t itemIdx);
282 static std::string getNodeIdString(SgAsmBinaryPostupdate* sgnode);
283 static std::string getNodeIdStringInternal(SgAsmBinaryPostupdate* sgnode);
284
285 public:
286 /* name Memory Allocation Functions
287 \brief Memory allocations functions ... incomplete-documentation
288
289 These functions have been made public as part of the design, but they are suggested for internal use
290 or by particularly knowledgable users for specialized tools or applications.
291 */
292 /* */
293
304 virtual bool isInMemoryPool() override;
305
316 virtual void checkDataMemberPointersIfInMemoryPool() override;
317
318 // DQ (4/30/2006): Modified to be a const function.
333 virtual std::vector<std::pair<SgNode*,std::string> > returnDataMemberPointers() const override;
334
345
357 virtual long getChildIndex( SgNode* childNode ) const override;
358
359 // DQ (9/2/2015): Since this function is generated by ROSETTA, we can't define the
360 // comment here (changed to be a C style comment and not be a doxygen comment).
361 /* \brief Constructor for use by AST File I/O Mechanism
362
363 This constructor permits the IR node to be rebuilt from the contiguously arranged data in memory
364 which obtained via fast binary file I/O from disk.
365 */
366 // SgAsmBinaryPostupdate( SgAsmBinaryPostupdateStorageClass& source );
367
368
369
370
371
372 // JH (10/24/2005): methods added to support the ast file IO
373 private:
374
375 /* name AST Memory Allocation Support Functions
376 \brief Memory allocations support....
377
378 These functions handle the low leve support of the memory allocation scheme which permits IR nodes to be allocated
379 in large contiguous blocks to reduce memory fragmentation, improve performance, support specialized access (AST traversals),
380 and support the AST File I/O Mechanism.
381 */
382 /* */
383
384 /* JH (10/24/2005): Two typedefs. The TestType notes the type every pointer is cast to before
385 we compare them. Since I had several problems with this, I decided to make a typdef to ensure
386 that I use the same type everywhere, if any changes are made. THe second one declares the type
387 (actually unsigned long) where teh pointer address gets converted to. On 64 bit platforms this
388 might got changed, but unfortunatly, the return types are still unsigned longs. There exists
389 a correspinding one in the AST_FILE_IO class!
390 */
391 // DQ (9/2/2015): This typedef is no longer used, we can't define the
392 // comment here (changed to be a C style comment and not be a doxygen comment).
393 /* \brief Typedef used for low level memory access.
394 */
395 // typedef unsigned char* TestType;
396
397 // DQ (9/2/2015): This typedef is no longer used, we can't define the
398 // comment here (changed to be a C style comment and not be a doxygen comment).
399 /* \brief Typedef used to hold memory addresses as values.
400 */
401 // typedef unsigned long AddressType;
402
403
404
405 // necessary, to have direct access to the p_freepointer and the private methods !
407 friend class AST_FILE_IO;
408
410 friend class SgAsmBinaryPostupdateStorageClass;
411
413 friend class AstSpecificDataManagingClass;
414
416 friend class AstSpecificDataManagingClassStorageClass;
417 public:
419 SgAsmBinaryPostupdate( const SgAsmBinaryPostupdateStorageClass& source );
420
421 // private: // JJW hack
422 /*
423 name AST Memory Allocation Support Variables
424 Memory allocations support variables
425
426 These variables handle the low level support of the memory allocation scheme which permits IR nodes to be allocated
427 in large contiguous blocks to reduce memory fragmentation, improve performance, support specialized access (AST traversals),
428 and support the AST File I/O Mechanism.
429 */
430 /* */
431
432 public:
433
434 // DQ (11/21/2009): Added function to add new Regular Expression attributes and return pointer
435 // to current node (so that it will work cleanly with build functions to specify patterns).
436 // virtual SgNode* addRegExpAttribute();
443
444#ifndef _MSC_VER
445// Rasmussen (04/17/2019): Support for ATerms has been deprecated as it is no longer needed
446// and likely never fully implemented nor tested. Files remain in the src tree but are no
447// longer built.
448#define BUILD_ATERM_SUPPORT 0
449 #if BUILD_ATERM_SUPPORT
450 #ifdef ROSE_USE_ROSE_ATERM_SUPPORT
451 // DQ (10/4/2014): Adding ATerm support to ROSE.
461 // Rasmussen (1/7/2019): Added override to kill warning messages of overridden virtual function
462 virtual ATerm generate_ATerm() override;
463
465 virtual void generate_ATerm_Annotation(ATerm & term) override;
466 #endif
467 #endif // BUILD_ATERM_SUPPORT
468#endif
469 // These can't be virtual functions since we don't yet know what IR node to build (until we have read the aterm).
470 // virtual generate_AST(ATerm & term);
471 // virtual void read_ATerm_Annotation(ATerm & term);
472
473// *** COMMON CODE SECTION ENDS HERE ***
474
475
476// End of memberFunctionString
477// Start of memberFunctionString
478/* #line 706 "/workspace/src/ROSETTA/Grammar/Node.code" */
479
480 // the generated cast function
481 // friend ROSE_DLL_API SgAsmBinaryPostupdate* isSgAsmBinaryPostupdate ( SgNode* s );
482
483 typedef SgAsmBinaryExpression base_node_type;
484
485
486// End of memberFunctionString
487
488 protected:
489
491
492/* #line 21 "/workspace/src/ROSETTA/Grammar/grammarClassDeclarationMacros.macro" */
493
494
495 };
496#endif
497
498// postdeclarations for SgAsmBinaryPostupdate
499
500/* #line 501 "../../../src/frontend/SageIII//SgAsmBinaryPostupdate.h" */
501
502/* #line 27 "/workspace/src/ROSETTA/Grammar/grammarClassDeclarationMacros.macro after subst for $POSTDECLARATIONS" */
503
504/* #line 28 "/workspace/src/ROSETTA/Grammar/grammarClassDeclarationMacros.macro" */
505
506
507/* #line 508 "../../../src/frontend/SageIII//SgAsmBinaryPostupdate.h" */
508
509#endif // ROSE_SgAsmBinaryPostupdate_H
510
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 binary expressions.
void initializeProperties()
Initialize all properties that have explicit initial values.
Expression that represents an update to a storage location.
Base class for expressions.
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.