ROSE 0.11.145.192
SgAsmCilAssemblyRef.h
1
2#ifndef ROSE_SgAsmCilAssemblyRef_H
3#define ROSE_SgAsmCilAssemblyRef_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 SgAsmCilAssemblyRef
23
24/* #line 25 "../../../src/frontend/SageIII//SgAsmCilAssemblyRef.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 SgAsmCilAssemblyRef
32class ROSE_DLL_API SgAsmCilAssemblyRef : public SgAsmCilMetadata
33 {
34 public:
35
36
37/* #line 38 "../../../src/frontend/SageIII//SgAsmCilAssemblyRef.h" */
38
39 virtual SgNode* copy ( SgCopyHelp& help) const override;
40// Start of memberFunctionString
41/* #line 39816 "/workspace/src/ROSETTA/src/binaryInstruction.C" */
42
43
44 //----------------------- Boost serialization for SgAsmCilAssemblyRef -----------------------
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("SgAsmCilAssemblyRef");
52 s & BOOST_SERIALIZATION_BASE_OBJECT_NVP(SgAsmCilMetadata);
53 s & BOOST_SERIALIZATION_NVP(p_MajorVersion);
54 s & BOOST_SERIALIZATION_NVP(p_MinorVersion);
55 s & BOOST_SERIALIZATION_NVP(p_BuildNumber);
56 s & BOOST_SERIALIZATION_NVP(p_RevisionNumber);
57 s & BOOST_SERIALIZATION_NVP(p_Flags);
58 s & BOOST_SERIALIZATION_NVP(p_PublicKeyOrToken);
59 s & BOOST_SERIALIZATION_NVP(p_Name);
60 s & BOOST_SERIALIZATION_NVP(p_Culture);
61 s & BOOST_SERIALIZATION_NVP(p_HashValue);
62 debugSerializationEnd("SgAsmCilAssemblyRef");
63 }
64#endif // ROSE_HAVE_BOOST_SERIALIZATION_LIB
65
66public:
72 uint16_t const& get_MajorVersion() const;
73 void set_MajorVersion(uint16_t const&);
76public:
82 uint16_t const& get_MinorVersion() const;
83 void set_MinorVersion(uint16_t const&);
86public:
92 uint16_t const& get_BuildNumber() const;
93 void set_BuildNumber(uint16_t const&);
96public:
102 uint16_t const& get_RevisionNumber() const;
103 void set_RevisionNumber(uint16_t const&);
106public:
112 uint32_t const& get_Flags() const;
113 void set_Flags(uint32_t const&);
116public:
122 uint32_t const& get_PublicKeyOrToken() const;
123 void set_PublicKeyOrToken(uint32_t const&);
126public:
132 uint32_t const& get_Name() const;
133 void set_Name(uint32_t const&);
136public:
142 uint32_t const& get_Culture() const;
143 void set_Culture(uint32_t const&);
146public:
152 uint32_t const& get_HashValue() const;
153 void set_HashValue(uint32_t const&);
155public:
156 void parse(const std::vector<uint8_t>& buf, size_t& index, uint64_t uses4byteIndexing);
157 void unparse(std::vector<uint8_t>& buf, size_t& index, uint64_t uses4byteIndexing) const;
158 void dump(std::ostream&) const;
159
160 const std::uint8_t* get_PublicKeyOrToken_blob() const;
161 const std::uint8_t* get_Name_string() const;
162 const std::uint8_t* get_Culture_string() const;
163 const std::uint8_t* get_HashValue_blob() const;
164public:
166 virtual ~SgAsmCilAssemblyRef();
167
168public:
171
172protected:
180
181
182// End of memberFunctionString
183// Start of memberFunctionString
184/* #line 1 "/workspace/src/ROSETTA/Grammar/Common.code" */
185
186// *** COMMON CODE SECTION BEGINS HERE ***
187
188 public:
189
190 // DQ (3/25/3006): I put this back in because it had the logic for where the copy function required
191 // and not required which is required to match the other aspects of the copy mechanism code generation.
192 // Specifically it is a problem to declare the copy function everywhere because it is not implemented
193 // for the SgSymbol IR nodes. I'm not clear why it is not implemented for these IR nodes.
194 /* \brief Copies AST (whole subtree, depending on the SgCopyHelp class */
195 // virtual SgNode* copy ( const SgCopyHelp & help) const;
196
198 virtual std::string class_name() const override;
199
201 virtual VariantT variantT() const override; // MS: new variant used in tree traversal
202
204 // King84 (2010.08.16): Moved this to an enum to save space, since it's only used at compiler-time anyway.
205 // static const VariantT static_variant = V_SgAsmCilAssemblyRef;
206 enum { static_variant = V_SgAsmCilAssemblyRef };
207
208 /* the generated cast function */
210 ROSE_DLL_API friend SgAsmCilAssemblyRef* isSgAsmCilAssemblyRef( SgNode * s );
211
213 ROSE_DLL_API friend const SgAsmCilAssemblyRef* isSgAsmCilAssemblyRef( const SgNode * s );
214
215 // ******************************************
216 // * Memory Pool / New / Delete
217 // ******************************************
218
219 public:
221 static const unsigned pool_size; //
223 static std::vector<unsigned char *> pools; //
225 static SgAsmCilAssemblyRef * next_node; //
226
228 static unsigned long initializeStorageClassArray(SgAsmCilAssemblyRefStorageClass *); //
229
231 static void clearMemoryPool(); //
232 static void deleteMemoryPool(); //
233
235 static void extendMemoryPoolForFileIO(); //
236
238 static SgAsmCilAssemblyRef * getPointerFromGlobalIndex(unsigned long); //
240 static SgAsmCilAssemblyRef * getPointerFromGlobalIndex(AstSpecificDataManagingClass *, unsigned long); //
241
243 static unsigned long getNumberOfValidNodesAndSetGlobalIndexInFreepointer(unsigned long); //
245 static void resetValidFreepointers(); //
247 static unsigned long getNumberOfLastValidPointer(); //
248
249
250#if defined(INLINE_FUNCTIONS)
252 inline void *operator new (size_t size);
253#else
255 void *operator new (size_t size);
256#endif
258 void operator delete (void* pointer, size_t size);
259
260 // DQ (4/5/2007): This is not the correct operator that we want, but appears to be required to compile ROSE with ROSE.
261 void operator delete (void* pointer)
262 {
263 // This is the generated delete operator...
264 SgAsmCilAssemblyRef::operator delete (pointer,sizeof(SgAsmCilAssemblyRef));
265 }
266
268 static size_t numberOfNodes();
269
271 static size_t memoryUsage();
272
273 // End of scope which started in IR nodes specific code
274 /* */
275
276 /* name Internal Functions
277 \brief Internal functions ... incomplete-documentation
278
279 These functions have been made public as part of the design, but they are suggested for internal use
280 or by particularly knowledgeable users for specialized tools or applications.
281
282 \internal We could not make these private because they are required by user for special purposes. And
283 it would be unwieldy to have many of the internal classes in ROSE be explicitly defined as friends.
284
285 */
286
287 // MS: 02/12/02 container of pointers to AST successor nodes used in the traversal
288 // overridden in every class by *generated* implementation
290 virtual std::vector<SgNode*> get_traversalSuccessorContainer() override;
291 // MS: 06/28/02 container of names of variables or container indices
292 // used used in the traversal to access AST successor nodes
293 // overridden in every class by *generated* implementation
296 virtual std::vector<std::string> get_traversalSuccessorNamesContainer() override;
297
298 // GB (09/25/2007): Functions for index-based access to traversal successors; these are hopefully a lot faster
299 // than all the vector copies. The implementation for these functions is generated for each class.
301 virtual size_t get_numberOfTraversalSuccessors() override;
303 virtual SgNode *get_traversalSuccessorByIndex(size_t idx) override;
305 virtual size_t get_childIndex(SgNode *child) override;
306
307#ifndef ROSE_USE_INTERNAL_FRONTEND_DEVELOPMENT
308 // MS: 08/16/2002 method for generating RTI information
310 virtual RTIReturnType roseRTI() override;
311#endif
312 /* */
313
314
315
316 /* name Deprecated Functions
317 \brief Deprecated functions ... incomplete-documentation
318
319 These functions have been deprecated from use.
320 */
321 /* */
322
324 virtual const char* sage_class_name() const override ROSE_DEPRECATED_FUNCTION;
325
326 // JJW (10/16/2008): Changed to a single function in Node.code, and put
327 // getVariant() in #if 0 block to prevent confusing Doxygen
328#if 0
330 virtual int variant() const ROSE_DEPRECATED_FUNCTION;
332 // virtual int getVariant() const ROSE_DEPRECATED_FUNCTION;
333#endif
334 /* */
335
336
337
338
339 public:
340 /* name Traversal Support Functions
341 \brief Traversal support functions ... incomplete-documentation
342
343 These functions have been made public as part of the design, but they are suggested for internal use
344 or by particularly knowledgable users for specialized tools or applications.
345 */
346 /* */
347
348 // DQ (11/26/2005): Support for visitor pattern mechanims
349 // (inferior to ROSE traversal mechanism, experimental).
353
354 /* DXN (08/09/2010): support for the classic visitor pattern done in GoF */
356 virtual void accept (ROSE_VisitorPattern & visitor) override;
357
358 // DQ (12/26/2005): Support for traversal based on the memory pool
361 static void traverseMemoryPoolNodes(ROSE_VisitTraversal & visit);
362
366
367 // DQ (2/9/2006): Added to support traversal over single representative of each IR node
368 // This traversal helps support internal tools that call static member functions.
369 // note: this function operates on the memory pools.
372 static void visitRepresentativeNode (ROSE_VisitTraversal & visit);
373 /* */
374
375 public:
376 /* NodeId support functions */
378 static SgNode* getNodeByNodeId(VariantT variantT, size_t poolIdx, size_t itemIdx);
381 static SgAsmCilAssemblyRef* getNodeByNodeIdInternal(size_t poolIdx, size_t itemIdx);
384 static std::string getNodeIdString(SgAsmCilAssemblyRef* sgnode);
385 static std::string getNodeIdStringInternal(SgAsmCilAssemblyRef* sgnode);
386
387 public:
388 /* name Memory Allocation Functions
389 \brief Memory allocations functions ... incomplete-documentation
390
391 These functions have been made public as part of the design, but they are suggested for internal use
392 or by particularly knowledgable users for specialized tools or applications.
393 */
394 /* */
395
406 virtual bool isInMemoryPool() override;
407
418 virtual void checkDataMemberPointersIfInMemoryPool() override;
419
420 // DQ (4/30/2006): Modified to be a const function.
435 virtual std::vector<std::pair<SgNode*,std::string> > returnDataMemberPointers() const override;
436
447
459 virtual long getChildIndex( SgNode* childNode ) const override;
460
461 // DQ (9/2/2015): Since this function is generated by ROSETTA, we can't define the
462 // comment here (changed to be a C style comment and not be a doxygen comment).
463 /* \brief Constructor for use by AST File I/O Mechanism
464
465 This constructor permits the IR node to be rebuilt from the contiguously arranged data in memory
466 which obtained via fast binary file I/O from disk.
467 */
468 // SgAsmCilAssemblyRef( SgAsmCilAssemblyRefStorageClass& source );
469
470
471
472
473
474 // JH (10/24/2005): methods added to support the ast file IO
475 private:
476
477 /* name AST Memory Allocation Support Functions
478 \brief Memory allocations support....
479
480 These functions handle the low leve support of the memory allocation scheme which permits IR nodes to be allocated
481 in large contiguous blocks to reduce memory fragmentation, improve performance, support specialized access (AST traversals),
482 and support the AST File I/O Mechanism.
483 */
484 /* */
485
486 /* JH (10/24/2005): Two typedefs. The TestType notes the type every pointer is cast to before
487 we compare them. Since I had several problems with this, I decided to make a typdef to ensure
488 that I use the same type everywhere, if any changes are made. THe second one declares the type
489 (actually unsigned long) where teh pointer address gets converted to. On 64 bit platforms this
490 might got changed, but unfortunatly, the return types are still unsigned longs. There exists
491 a correspinding one in the AST_FILE_IO class!
492 */
493 // DQ (9/2/2015): This typedef is no longer used, we can't define the
494 // comment here (changed to be a C style comment and not be a doxygen comment).
495 /* \brief Typedef used for low level memory access.
496 */
497 // typedef unsigned char* TestType;
498
499 // DQ (9/2/2015): This typedef is no longer used, we can't define the
500 // comment here (changed to be a C style comment and not be a doxygen comment).
501 /* \brief Typedef used to hold memory addresses as values.
502 */
503 // typedef unsigned long AddressType;
504
505
506
507 // necessary, to have direct access to the p_freepointer and the private methods !
509 friend class AST_FILE_IO;
510
512 friend class SgAsmCilAssemblyRefStorageClass;
513
515 friend class AstSpecificDataManagingClass;
516
518 friend class AstSpecificDataManagingClassStorageClass;
519 public:
521 SgAsmCilAssemblyRef( const SgAsmCilAssemblyRefStorageClass& source );
522
523 // private: // JJW hack
524 /*
525 name AST Memory Allocation Support Variables
526 Memory allocations support variables
527
528 These variables handle the low level support of the memory allocation scheme which permits IR nodes to be allocated
529 in large contiguous blocks to reduce memory fragmentation, improve performance, support specialized access (AST traversals),
530 and support the AST File I/O Mechanism.
531 */
532 /* */
533
534 public:
535
536 // DQ (11/21/2009): Added function to add new Regular Expression attributes and return pointer
537 // to current node (so that it will work cleanly with build functions to specify patterns).
538 // virtual SgNode* addRegExpAttribute();
545
546#ifndef _MSC_VER
547// Rasmussen (04/17/2019): Support for ATerms has been deprecated as it is no longer needed
548// and likely never fully implemented nor tested. Files remain in the src tree but are no
549// longer built.
550#define BUILD_ATERM_SUPPORT 0
551 #if BUILD_ATERM_SUPPORT
552 #ifdef ROSE_USE_ROSE_ATERM_SUPPORT
553 // DQ (10/4/2014): Adding ATerm support to ROSE.
563 // Rasmussen (1/7/2019): Added override to kill warning messages of overridden virtual function
564 virtual ATerm generate_ATerm() override;
565
567 virtual void generate_ATerm_Annotation(ATerm & term) override;
568 #endif
569 #endif // BUILD_ATERM_SUPPORT
570#endif
571 // These can't be virtual functions since we don't yet know what IR node to build (until we have read the aterm).
572 // virtual generate_AST(ATerm & term);
573 // virtual void read_ATerm_Annotation(ATerm & term);
574
575// *** COMMON CODE SECTION ENDS HERE ***
576
577
578// End of memberFunctionString
579// Start of memberFunctionString
580/* #line 706 "/workspace/src/ROSETTA/Grammar/Node.code" */
581
582 // the generated cast function
583 // friend ROSE_DLL_API SgAsmCilAssemblyRef* isSgAsmCilAssemblyRef ( SgNode* s );
584
585 typedef SgAsmCilMetadata base_node_type;
586
587
588// End of memberFunctionString
589
590
591
592
593
594
595
596
597
598
599 protected:
600// Start of memberFunctionString
601uint16_t p_MajorVersion;
602
603// End of memberFunctionString
604// Start of memberFunctionString
605uint16_t p_MinorVersion;
606
607// End of memberFunctionString
608// Start of memberFunctionString
609uint16_t p_BuildNumber;
610
611// End of memberFunctionString
612// Start of memberFunctionString
613uint16_t p_RevisionNumber;
614
615// End of memberFunctionString
616// Start of memberFunctionString
617uint32_t p_Flags;
618
619// End of memberFunctionString
620// Start of memberFunctionString
621uint32_t p_PublicKeyOrToken;
622
623// End of memberFunctionString
624// Start of memberFunctionString
625uint32_t p_Name;
626
627// End of memberFunctionString
628// Start of memberFunctionString
629uint32_t p_Culture;
630
631// End of memberFunctionString
632// Start of memberFunctionString
633uint32_t p_HashValue;
634
635// End of memberFunctionString
636
638 friend struct Rose::Traits::generated::describe_field_t<SgAsmCilAssemblyRef, uint16_t,&SgAsmCilAssemblyRef::p_MajorVersion>;
639 friend struct Rose::Traits::generated::describe_field_t<SgAsmCilAssemblyRef, uint16_t,&SgAsmCilAssemblyRef::p_MinorVersion>;
640 friend struct Rose::Traits::generated::describe_field_t<SgAsmCilAssemblyRef, uint16_t,&SgAsmCilAssemblyRef::p_BuildNumber>;
641 friend struct Rose::Traits::generated::describe_field_t<SgAsmCilAssemblyRef, uint16_t,&SgAsmCilAssemblyRef::p_RevisionNumber>;
642 friend struct Rose::Traits::generated::describe_field_t<SgAsmCilAssemblyRef, uint32_t,&SgAsmCilAssemblyRef::p_Flags>;
643 friend struct Rose::Traits::generated::describe_field_t<SgAsmCilAssemblyRef, uint32_t,&SgAsmCilAssemblyRef::p_PublicKeyOrToken>;
644 friend struct Rose::Traits::generated::describe_field_t<SgAsmCilAssemblyRef, uint32_t,&SgAsmCilAssemblyRef::p_Name>;
645 friend struct Rose::Traits::generated::describe_field_t<SgAsmCilAssemblyRef, uint32_t,&SgAsmCilAssemblyRef::p_Culture>;
646 friend struct Rose::Traits::generated::describe_field_t<SgAsmCilAssemblyRef, uint32_t,&SgAsmCilAssemblyRef::p_HashValue>;
647
648/* #line 21 "/workspace/src/ROSETTA/Grammar/grammarClassDeclarationMacros.macro" */
649
650
651 };
652#endif
653
654// postdeclarations for SgAsmCilAssemblyRef
655
656/* #line 657 "../../../src/frontend/SageIII//SgAsmCilAssemblyRef.h" */
657
658/* #line 27 "/workspace/src/ROSETTA/Grammar/grammarClassDeclarationMacros.macro after subst for $POSTDECLARATIONS" */
659
660/* #line 28 "/workspace/src/ROSETTA/Grammar/grammarClassDeclarationMacros.macro" */
661
662
663/* #line 664 "../../../src/frontend/SageIII//SgAsmCilAssemblyRef.h" */
664
665#endif // ROSE_SgAsmCilAssemblyRef_H
666
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 AssemblyRef node (II.22.5).
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.