ROSE  0.9.6a
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
SgFunctionModifier Class Reference

#include <Cxx_Grammar.h>

Inheritance diagram for SgFunctionModifier:
Collaboration diagram for SgFunctionModifier:

Classes

struct  opencl_work_group_size_t
 

Public Types

enum  function_modifier_enum {
  e_unknown = 0,
  e_default = 1,
  e_inline = 2,
  e_virtual = 3,
  e_pure_virtual = 4,
  e_explicit = 5,
  e_pure = 7,
  e_elemental = 8,
  e_recursive = 9,
  e_gnu_attribute__constructor__ = 10,
  e_gnu_attribute__destructor__ = 11,
  e_gnu_attribute__pure__ = 12,
  e_gnu_attribute__weak__ = 13,
  e_gnu_attribute__unused__ = 14,
  e_gnu_attribute__used__ = 15,
  e_gnu_attribute__deprecated__ = 16,
  e_gnu_attribute__malloc__ = 17,
  e_gnu_attribute__naked__ = 18,
  e_gnu_attribute__no_instrument_function__ = 19,
  e_gnu_attribute__no_check_memory_usage__ = 20,
  e_gnu_attribute__noinline__ = 21,
  e_gnu_attribute__always_inline__ = 22,
  e_gnu_attribute__nothrow__ = 23,
  e_gnu_attribute__weakref__ = 24,
  e_cuda_device = 25,
  e_cuda_kernel = 26,
  e_cuda_host = 27,
  e_opencl_kernel = 28,
  e_opencl_vec_type_hint = 29,
  e_opencl_work_group_size_hint = 30,
  e_opencl_work_group_size_req = 31,
  e_java_native = 32,
  e_java_synchronized = 33,
  e_java_strictfp = 34,
  e_java_initializer = 35,
  e_last_modifier
}
 Function Modifiers (bitvector implementation permits multiple values to be specified) More...
 
enum  { static_variant = V_SgFunctionModifier }
 static variant value More...
 
typedef SgModifier base_node_type
 
- Public Types inherited from SgModifier
enum  { static_variant = V_SgModifier }
 static variant value More...
 
typedef SgSupport base_node_type
 
- Public Types inherited from SgSupport
enum  { static_variant = V_SgSupport }
 static variant value More...
 
typedef SgNode base_node_type
 
- Public Types inherited from SgNode
enum  { static_variant = V_SgNode }
 static variant value More...
 

Public Member Functions

virtual SgNodecopy (SgCopyHelp &help) const
 This function clones the current IR node object recursively or not, depending on the argument. More...
 
 SgFunctionModifier (const SgFunctionModifier &X)
 
SgFunctionModifieroperator= (const SgFunctionModifier &X)
 
void post_construction_initialization ()
 Final initialization for constructors This function is called at the end of generated constructors to allow the specification writer to add special initialization functions or tests. Default is to do nothing. Otherwise it should be overridden in the spec file, in NewHeaderCode/NewOutlinedCode. More...
 
bool isUnknown () const
 
void setUnknown ()
 
void unsetUnknown ()
 
bool isDefault () const
 
void setDefault ()
 
void unsetDefault ()
 
bool isInline () const
 
void setInline ()
 
void unsetInline ()
 
bool isVirtual () const
 
void setVirtual ()
 
void unsetVirtual ()
 
bool isPureVirtual () const
 
void setPureVirtual ()
 
void unsetPureVirtual ()
 
bool isExplicit () const
 
void setExplicit ()
 
void unsetExplicit ()
 
bool isPure () const
 
void setPure ()
 
void unsetPure ()
 
bool isElemental () const
 
void setElemental ()
 
void unsetElemental ()
 
bool isRecursive () const
 
void setRecursive ()
 
void unsetRecursive ()
 
bool isGnuAttributeConstructor () const
 
void setGnuAttributeConstructor ()
 
void unsetGnuAttributeConstructor ()
 
bool isGnuAttributeDestructor () const
 
void setGnuAttributeDestructor ()
 
void unsetGnuAttributeDestructor ()
 
bool isGnuAttributePure () const
 
void setGnuAttributePure ()
 
void unsetGnuAttributePure ()
 
bool isGnuAttributeWeak () const
 
void setGnuAttributeWeak ()
 
void unsetGnuAttributeWeak ()
 
bool isGnuAttributeUnused () const
 
void setGnuAttributeUnused ()
 
void unsetGnuAttributeUnused ()
 
bool isGnuAttributeUsed () const
 
void setGnuAttributeUsed ()
 
void unsetGnuAttributeUsed ()
 
bool isGnuAttributeDeprecated () const
 
void setGnuAttributeDeprecated ()
 
void unsetGnuAttributeDeprecated ()
 
bool isGnuAttributeMalloc () const
 
void setGnuAttributeMalloc ()
 
void unsetGnuAttributeMalloc ()
 
bool isGnuAttributeNaked () const
 
void setGnuAttributeNaked ()
 
void unsetGnuAttributeNaked ()
 
bool isGnuAttributeNoInstrumentFunction () const
 
void setGnuAttributeNoInstrumentFunction ()
 
void unsetGnuAttributeNoInstrumentFunction ()
 
bool isGnuAttributeNoCheckMemoryUsage () const
 
void setGnuAttributeNoCheckMemoryUsage ()
 
void unsetGnuAttributeNoCheckMemoryUsage ()
 
bool isGnuAttributeNoInline () const
 
void setGnuAttributeNoInline ()
 
void unsetGnuAttributeNoInline ()
 
bool isGnuAttributeAlwaysInline () const
 
void setGnuAttributeAlwaysInline ()
 
void unsetGnuAttributeAlwaysInline ()
 
bool isGnuAttributeNoThrow () const
 
void setGnuAttributeNoThrow ()
 
void unsetGnuAttributeNoThrow ()
 
bool isGnuAttributeWeakReference () const
 
void setGnuAttributeWeakReference ()
 
void unsetGnuAttributeWeakReference ()
 
bool isCudaDevice () const
 
void setCudaDevice ()
 
void unsetCudaDevice ()
 
bool isCudaKernel () const
 
void setCudaKernel ()
 
void unsetCudaKernel ()
 
bool isCudaHost () const
 
void setCudaHost ()
 
void unsetCudaHost ()
 
bool isOpenclKernel () const
 
void setOpenclKernel ()
 
void unsetOpenclKernel ()
 
bool hasOpenclVecTypeHint () const
 
void setOpenclVecTypeHint ()
 
void unsetOpenclVecTypeHint ()
 
bool hasOpenclWorkGroupSizeHint () const
 
void setOpenclWorkGroupSizeHint ()
 
void unsetOpenclWorkGroupSizeHint ()
 
bool hasOpenclWorkGroupSizeReq () const
 
void setOpenclWorkGroupSizeReq ()
 
void unsetOpenclWorkGroupSizeReq ()
 
bool isJavaNative () const
 
void setJavaNative ()
 
void unsetJavaNative ()
 
bool isJavaSynchronized () const
 
void setJavaSynchronized ()
 
void unsetJavaSynchronized ()
 
bool isJavaStrictfp () const
 
void setJavaStrictfp ()
 
void unsetJavaStrictfp ()
 
bool isJavaInitializer () const
 
void setJavaInitializer ()
 
void unsetJavaInitializer ()
 
std::string displayString () const
 
void display (std::string label) const
 
void reset ()
 
virtual std::string class_name () const
 Copies AST (whole subtree, depending on the SgCopyHelp class. More...
 
virtual VariantT variantT () const
 returns new style SageIII enum values More...
 
void * operator new (size_t size)
 returns pointer to newly allocated IR node More...
 
void operator delete (void *pointer, size_t size)
 deallocated memory for IR node (returns memory to memory pool for reuse) More...
 
void operator delete (void *pointer)
 
virtual std::vector< SgNode * > get_traversalSuccessorContainer ()
 FOR INTERNAL USE within ROSE traverals mechanism only. More...
 
virtual std::vector< std::string > get_traversalSuccessorNamesContainer ()
 FOR INTERNAL USE within ROSE traverals mechanism only. More...
 
virtual size_t get_numberOfTraversalSuccessors ()
 
virtual SgNodeget_traversalSuccessorByIndex (size_t idx)
 
virtual size_t get_childIndex (SgNode *child)
 
virtual RTIReturnType roseRTI ()
 FOR INTERNAL USE Access to Runtime Type Information (RTI) for this IR nodes. More...
 
virtual const char * sage_class_name () const ROSE_DEPRECATED_FUNCTION
 
void executeVisitorMemberFunction (ROSE_VisitorPattern &visitor)
 FOR INTERNAL USE Support for visitor pattern. More...
 
virtual void accept (ROSE_VisitorPattern &visitor)
 DXN (08/09/2010): support for the classic visitor pattern done in GoF. More...
 
virtual bool isInMemoryPool ()
 FOR INTERNAL USE This is used in internal tests to verify that all IR nodes are allocated from the heap. More...
 
virtual void checkDataMemberPointersIfInMemoryPool ()
 FOR INTERNAL USE This is used in internal tests to verify that all IR nodes are allocated from the heap. More...
 
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 More...
 
virtual void processDataMemberReferenceToPointers (ReferenceToPointerHandler *)
 FOR INTERNAL USE Processes pairs of references to SgNode* and strings for use in AST tools More...
 
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 node. More...
 
 SgFunctionModifier (const SgFunctionModifierStorageClass &source)
 
SgFunctionModifieraddRegExpAttribute (std::string s, AstRegExAttribute *a)
 Support for AST matching using regular expression. More...
 
SgBitVector get_modifierVector () const
 
void set_modifierVector (SgBitVector modifierVector)
 
unsigned long int get_gnu_attribute_constructor_destructor_priority () const
 
void set_gnu_attribute_constructor_destructor_priority (unsigned long int gnu_attribute_constructor_destructor_priority)
 
std::string get_gnu_attribute_named_weak_reference () const
 
void set_gnu_attribute_named_weak_reference (std::string gnu_attribute_named_weak_reference)
 
std::string get_gnu_attribute_named_alias () const
 
void set_gnu_attribute_named_alias (std::string gnu_attribute_named_alias)
 
SgTypeget_opencl_vec_type () const
 
void set_opencl_vec_type (SgType *opencl_vec_type)
 
SgFunctionModifier::opencl_work_group_size_t get_opencl_work_group_size () const
 
void set_opencl_work_group_size (SgFunctionModifier::opencl_work_group_size_t opencl_work_group_size)
 
virtual ~SgFunctionModifier ()
 
 SgFunctionModifier ()
 
- Public Member Functions inherited from SgModifier
 SgModifier (const SgModifier &X)
 
SgModifieroperator= (const SgModifier &X)
 This is the assignment operator. More...
 
bool checkBit (unsigned int bit, const SgBitVector &bitVector) const
 This function returns the value of the bit in the STL vector<bool> object. More...
 
void setBit (unsigned int bit, SgBitVector &bitVector) const
 This function sets the bit in the STL vector<bool> object (sets value to true). More...
 
void unsetBit (unsigned int bit, SgBitVector &bitVector) const
 This function clears the bit in the STL vector<bool> object (sets value to false). More...
 
void * operator new (size_t size)
 returns pointer to newly allocated IR node More...
 
void operator delete (void *pointer, size_t size)
 deallocated memory for IR node (returns memory to memory pool for reuse) More...
 
void operator delete (void *pointer)
 
void executeVisitorMemberFunction (ROSE_VisitorPattern &visitor)
 FOR INTERNAL USE Support for visitor pattern. More...
 
 SgModifier (const SgModifierStorageClass &source)
 
SgModifieraddRegExpAttribute (std::string s, AstRegExAttribute *a)
 Support for AST matching using regular expression. More...
 
virtual ~SgModifier ()
 This is the destructor. More...
 
 SgModifier ()
 This is the constructor. More...
 
- Public Member Functions inherited from SgSupport
void * operator new (size_t size)
 returns pointer to newly allocated IR node More...
 
void operator delete (void *pointer, size_t size)
 deallocated memory for IR node (returns memory to memory pool for reuse) More...
 
void operator delete (void *pointer)
 
void executeVisitorMemberFunction (ROSE_VisitorPattern &visitor)
 FOR INTERNAL USE Support for visitor pattern. More...
 
 SgSupport (const SgSupportStorageClass &source)
 
SgSupportaddRegExpAttribute (std::string s, AstRegExAttribute *a)
 Support for AST matching using regular expression. More...
 
virtual ~SgSupport ()
 This is the destructor. More...
 
 SgSupport ()
 This is the constructor. More...
 
- Public Member Functions inherited from SgNode
void * operator new (size_t size)
 returns pointer to newly allocated IR node More...
 
void operator delete (void *pointer, size_t size)
 deallocated memory for IR node (returns memory to memory pool for reuse) More...
 
void operator delete (void *pointer)
 
void executeVisitorMemberFunction (ROSE_VisitorPattern &visitor)
 FOR INTERNAL USE Support for visitor pattern. More...
 
 SgNode (const SgNodeStorageClass &source)
 
SgNodeaddRegExpAttribute (std::string s, AstRegExAttribute *a)
 Support for AST matching using regular expression. More...
 
void set_isModified (bool isModified)
 All nodes in the AST contain a isModified flag used to track changes to the AST. More...
 
bool get_isModified () const
 Acess function for isModified flag This flag records if the current IR node has been modified. It is set to false after and ROSE front-end processing. More...
 
void set_parent (SgNode *parent)
 All nodes in the AST contain a reference to a parent node. More...
 
SgNodeget_parent () const
 Access function for parent node. More...
 
bool isChild (SgNode *node) const
 Query function for if the input IR nodes is a child of the current IR node. More...
 
virtual std::string unparseToString (SgUnparse_Info *info) const
 This function unparses the AST node (excluding comments and unnecessary white space) More...
 
std::string unparseToString () const
 
std::string unparseToCompleteString ()
 This function unparses the AST node (including comments and white space) More...
 
int variant () const ROSE_DEPRECATED_FUNCTION
 Older version function returns enum value "NODE". More...
 
virtual void addNewAttribute (std::string s, AstAttribute *a)
 Add a new attribute represented by the named string. More...
 
virtual AstAttributegetAttribute (std::string s) const
 Returns attribute of name 's'. More...
 
virtual void updateAttribute (std::string s, AstAttribute *a)
 Replace existing attribute of name 's' with new AstAttribute. More...
 
virtual void setAttribute (std::string s, AstAttribute *a)
 This is a wrapper function with the following semantics: if no attribute of name 's' exists then addNewAttribute(s,a); is called, otherwise updateAttribute(s,a); is called. More...
 
virtual void removeAttribute (std::string s)
 Remove attribute of name 's' if present. More...
 
virtual bool attributeExists (std::string s) const
 Tests if attribute of name 's' is present. More...
 
virtual int numberOfAttributes () const
 Returns the number of attributes on this IR node. More...
 
virtual AstAttributeMechanismget_attributeMechanism () const
 FOR INTERNAL USE Access function; if an attribute exists then a pointer to it is returned, else error. More...
 
virtual void set_attributeMechanism (AstAttributeMechanism *a)
 FOR INTERNAL USE Access function; sets poiner to value AstAttributeMechanism. More...
 
virtual void fixupCopy (SgNode *copy, SgCopyHelp &help) const
 
virtual Sg_File_Infoget_file_info (void) const
 File information containing filename, line number, column number, and if the SgNode is a part of a new transformation, etc. More...
 
virtual Sg_File_Infoget_startOfConstruct (void) const
 New function interface for Sg_File_Info data stores starting location of contruct (typically the opening brace or first letter of keyword). More...
 
virtual Sg_File_Infoget_endOfConstruct (void) const
 New function interface for Sg_File_Info data stores ending location of contruct (typically the closing brace). More...
 
VirtualCFG::CFGNode cfgForBeginning ()
 Returns the CFG node for just before this AST node. More...
 
VirtualCFG::CFGNode cfgForEnd ()
 Returns the CFG node for just after this AST node. More...
 
virtual unsigned int cfgIndexForEnd () const
 Determine the CFG index for the end of this construct. More...
 
virtual bool cfgIsIndexInteresting (unsigned int index) const
 Determine whether a particular CFG node index is "interesting" for this kind of node. More...
 
virtual unsigned int cfgFindChildIndex (SgNode *n)
 Find the index of n in this node's CFG children. More...
 
virtual unsigned int cfgFindNextChildIndex (SgNode *n)
 Find the index just after n in this node's CFG children. More...
 
virtual std::vector
< VirtualCFG::CFGEdge
cfgOutEdges (unsigned int index=false)
 Find the out edges of a CFG node – internal version. More...
 
virtual std::vector
< VirtualCFG::CFGEdge
cfgInEdges (unsigned int index=false)
 Find the in edges of a CFG node – internal version. More...
 
int numberOfNodesInSubtree ()
 Computes the number of nodes in the defined subtree of the AST. More...
 
int depthOfSubtree ()
 Computes the depth of the current defined subtree of the AST. More...
 
SgNodeget_freepointer () const
 
void set_freepointer (SgNode *freepointer)
 
virtual ~SgNode ()
 This is the destructor. More...
 
 SgNode ()
 This is the constructor. More...
 
bool get_isVisited () const ROSE_DEPRECATED_FUNCTION
 DOCS IN HEADER: Access function for p_isVisited flag used previously by the AST traversals. More...
 
void set_isVisited (bool isVisited) ROSE_DEPRECATED_FUNCTION
 Access function for p_isVisited flag used previously by the AST traversals. More...
 

Static Public Member Functions

static size_t numberOfNodes ()
 Returns the total number of IR nodes of this type. More...
 
static size_t memoryUsage ()
 Returns the size in bytes of the total memory allocated for all IR nodes of this type. More...
 
static void traverseMemoryPoolNodes (ROSE_VisitTraversal &visit)
 FOR INTERNAL USE Support for visitor pattern. More...
 
static void traverseMemoryPoolVisitorPattern (ROSE_VisitorPattern &visitor)
 FOR INTERNAL USE Support for visitor pattern. More...
 
static void visitRepresentativeNode (ROSE_VisitTraversal &visit)
 FOR INTERNAL USE Support for type-based traversal. More...
 
- Static Public Member Functions inherited from SgModifier
static size_t numberOfNodes ()
 Returns the total number of IR nodes of this type. More...
 
static size_t memoryUsage ()
 Returns the size in bytes of the total memory allocated for all IR nodes of this type. More...
 
static void traverseMemoryPoolNodes (ROSE_VisitTraversal &visit)
 FOR INTERNAL USE Support for visitor pattern. More...
 
static void traverseMemoryPoolVisitorPattern (ROSE_VisitorPattern &visitor)
 FOR INTERNAL USE Support for visitor pattern. More...
 
static void visitRepresentativeNode (ROSE_VisitTraversal &visit)
 FOR INTERNAL USE Support for type-based traversal. More...
 
- Static Public Member Functions inherited from SgSupport
static size_t numberOfNodes ()
 Returns the total number of IR nodes of this type. More...
 
static size_t memoryUsage ()
 Returns the size in bytes of the total memory allocated for all IR nodes of this type. More...
 
static void traverseMemoryPoolNodes (ROSE_VisitTraversal &visit)
 FOR INTERNAL USE Support for visitor pattern. More...
 
static void traverseMemoryPoolVisitorPattern (ROSE_VisitorPattern &visitor)
 FOR INTERNAL USE Support for visitor pattern. More...
 
static void visitRepresentativeNode (ROSE_VisitTraversal &visit)
 FOR INTERNAL USE Support for type-based traversal. More...
 
- Static Public Member Functions inherited from SgNode
static size_t numberOfNodes ()
 Returns the total number of IR nodes of this type. More...
 
static size_t memoryUsage ()
 Returns the size in bytes of the total memory allocated for all IR nodes of this type. More...
 
static void traverseMemoryPoolNodes (ROSE_VisitTraversal &visit)
 FOR INTERNAL USE Support for visitor pattern. More...
 
static void traverseMemoryPoolVisitorPattern (ROSE_VisitorPattern &visitor)
 FOR INTERNAL USE Support for visitor pattern. More...
 
static void visitRepresentativeNode (ROSE_VisitTraversal &visit)
 FOR INTERNAL USE Support for type-based traversal. More...
 
static std::vector< std::string > buildCommandLineToSubstituteTransformationFile (const std::vector< std::string > &argv, std::string newFileName)
 Command line support for this compilation The command line is saved as a static variable so that it will be available to support the rewrite mechanism. More...
 
static std::vector< VariantTgetClassHierarchySubTreeFunction (VariantT v)
 
static void getClassHierarchySubTreeFunction (VariantT v, std::vector< VariantT > &)
 
static std::map< SgNode
*, std::string > & 
get_globalMangledNameMap ()
 Access function for performance optimizing global mangled name map. More...
 
static void clearGlobalMangledNameMap ()
 Support to clear the performance optimizing global mangled name map. More...
 
static std::map< std::string,
int > & 
get_shortMangledNameCache ()
 Access function for lower level optimizing of global mangled name map. More...
 
static std::map< SgNode
*, std::string > & 
get_globalQualifiedNameMapForNames ()
 Access function for name qualification support (for names). More...
 
static void set_globalQualifiedNameMapForNames (const std::map< SgNode *, std::string > &X)
 Access function for name qualification support (for names). More...
 
static std::map< SgNode
*, std::string > & 
get_globalQualifiedNameMapForTypes ()
 Access function for name qualification support (for type). More...
 
static void set_globalQualifiedNameMapForTypes (const std::map< SgNode *, std::string > &X)
 Access function for name qualification support (for type). More...
 
static std::map< SgNode
*, std::string > & 
get_globalTypeNameMap ()
 Access function for name qualification support (for names of types). More...
 
static void set_globalTypeNameMap (const std::map< SgNode *, std::string > &X)
 Access function for name qualification support (for names of types). More...
 
static SgFunctionTypeTableget_globalFunctionTypeTable ()
 Access function for symbol table specific to function types. More...
 
static void set_globalFunctionTypeTable (SgFunctionTypeTable *globalFunctionTypeTable)
 Access function for symbol table specific to function types. More...
 
static SgTypeTableget_globalTypeTable ()
 Access function for symbol table specific to non-function types. More...
 
static void set_globalTypeTable (SgTypeTable *globalTypeTable)
 Access function for symbol table specific to non-function types. More...
 

Protected Attributes

SgBitVector p_modifierVector
 
unsigned long int p_gnu_attribute_constructor_destructor_priority
 
std::string p_gnu_attribute_named_weak_reference
 
std::string p_gnu_attribute_named_alias
 
SgTypep_opencl_vec_type
 
SgFunctionModifier::opencl_work_group_size_t p_opencl_work_group_size
 

Friends

class AST_FILE_IO
 
class SgFunctionModifierStorageClass
 
class AstSpecificDataManagingClass
 
class AstSpecificDataManagingClassStorageClass
 
std::ostream & operator<< (std::ostream &os, const SgFunctionModifier &m)
 
bool operator== (const SgFunctionModifier &lhs, const SgFunctionModifier &rhs)
 
ROSE_DLL_API friend
SgFunctionModifier
isSgFunctionModifier (SgNode *s)
 Casts pointer from base class to derived class. More...
 
ROSE_DLL_API friend const
SgFunctionModifier
isSgFunctionModifier (const SgNode *s)
 Casts pointer from base class to derived class (for const pointers) More...
 
SgFunctionModifierSgFunctionModifier_getPointerFromGlobalIndex (unsigned long globalIndex)
 Constructor for use by AST File I/O Mechanism. More...
 
unsigned long SgFunctionModifier_getNumberOfValidNodesAndSetGlobalIndexInFreepointer (unsigned long)
 Get the size of the memory pool. More...
 
void SgFunctionModifier_clearMemoryPool ()
 
void SgFunctionModifier_extendMemoryPoolForFileIO (unsigned long)
 
void SgFunctionModifier_getNextValidPointer (std::pair< SgFunctionModifier *, std::vector< unsigned char * >::const_iterator > &)
 
void SgFunctionModifier_resetValidFreepointers ()
 

Additional Inherited Members

- Static Protected Attributes inherited from SgNode
static SgFunctionTypeTablep_globalFunctionTypeTable
 Pointer to symbol table specific to function types. More...
 
static SgTypeTablep_globalTypeTable
 
static std::map< SgNode
*, std::string > 
p_globalMangledNameMap
 Cache of mangled names to avoid regeneration of previously build mangled names or parts of mangled names. This is a performance optimization. More...
 
static std::map< std::string, int > p_shortMangledNameCache
 STL map used as a cache to shorten generated mangled names. This is mostly a space optimization ofr mangled names of templates. More...
 
static std::map< SgNode
*, std::string > 
p_globalQualifiedNameMapForNames
 
static std::map< SgNode
*, std::string > 
p_globalQualifiedNameMapForTypes
 
static std::map< SgNode
*, std::string > 
p_globalTypeNameMap
 

Detailed Description

Definition at line 11602 of file Cxx_Grammar.h.

Member Typedef Documentation

Member Enumeration Documentation

Function Modifiers (bitvector implementation permits multiple values to be specified)

Function modifiers (inline, virtual, pure-virtual, explicit).

Many values can be specified (when the gnu attributes are included), so the implementation uses an STL bit vector.

Enumerator
e_unknown 

error value

e_default 

default value

e_inline 

inlined function

e_virtual 

virtual function

e_pure_virtual 

pure virtual function

e_explicit 

explicit function (avoids type resolution through auto type promotion of function arguments)

e_pure 

Fortran pure attribute for functions (see also type modifier)

e_elemental 

Fortran elemental attribute for functions (see also type modifier)

e_recursive 

Fortran recursive attribute for functions (see also type modifier)

e_gnu_attribute__constructor__ 

GNU specific attribute for (GNU extension) (a separately stored value permits the priority to be specified).

e_gnu_attribute__destructor__ 

GNU specific attribute for (GNU extension)

e_gnu_attribute__pure__ 

GNU specific attribute for (GNU extension)

e_gnu_attribute__weak__ 

GNU specific attribute for (GNU extension)

e_gnu_attribute__unused__ 

GNU specific attribute for (GNU extension)

e_gnu_attribute__used__ 

GNU specific attribute for (GNU extension)

e_gnu_attribute__deprecated__ 

GNU specific attribute for (GNU extension)

e_gnu_attribute__malloc__ 

GNU specific attribute for (GNU extension)

e_gnu_attribute__naked__ 

GNU specific attribute for (GNU extension)

e_gnu_attribute__no_instrument_function__ 

GNU specific attribute for (GNU extension)

e_gnu_attribute__no_check_memory_usage__ 

GNU specific attribute for (GNU extension)

e_gnu_attribute__noinline__ 

GNU specific attribute for (GNU extension)

e_gnu_attribute__always_inline__ 

GNU specific attribute for (GNU extension)

e_gnu_attribute__nothrow__ 

GNU specific attribute for (GNU extension)

e_gnu_attribute__weakref__ 

GNU specific attribute for (GNU extension)

e_cuda_device 

CUDA device function

e_cuda_kernel 

CUDA kernel

e_cuda_host 

CUDA host function

e_opencl_kernel 

OpenCL kernel

e_opencl_vec_type_hint 

OpenCL

e_opencl_work_group_size_hint 

OpenCL

e_opencl_work_group_size_req 

OpenCL

e_java_native 

Java native keyword used for JNI function specification

e_java_synchronized 

Java synchronized keyword used to only allow one thread at a time into a particular section of code

e_java_strictfp 

Java strictfp keyword used to specify strict floating point evaluation by JVM

e_java_initializer 

Java initializer keyword used to specify that this "synthetic" function is, in fact, an initializer block

e_last_modifier 

last value (upper bound on range of values, used in error checking)

Definition at line 11620 of file Cxx_Grammar.h.

anonymous enum

static variant value

Enumerator
static_variant 

Definition at line 11875 of file Cxx_Grammar.h.

Constructor & Destructor Documentation

SgFunctionModifier::SgFunctionModifier ( const SgFunctionModifier X)
SgFunctionModifier::SgFunctionModifier ( const SgFunctionModifierStorageClass source)
virtual SgFunctionModifier::~SgFunctionModifier ( )
virtual
SgFunctionModifier::SgFunctionModifier ( )

Member Function Documentation

virtual SgNode* SgFunctionModifier::copy ( SgCopyHelp help) const
virtual

This function clones the current IR node object recursively or not, depending on the argument.

This function performs a copy based on the specification of the input parameter. The input parameter is used to determin which data members are copied by reference and which are copied by value.

Parameters
help- If this argument is of type SgTreeCopy, then the IR node is cloned recursively. If its of type SgShallowCopy only the first level of the IR node is copied, everything else is left pointing to the the original IR node's object's data members.
Returns
a pointer to the new clone.

It appears the the copy functions don't set the parents of anything that they do a deep copy of! This can cause AST tests to fail. In particular some functions that require the parent pointers to be valid will return NULL pointers (e.g. SgInitializedName::get_declaration()). It might be that we should allow this to be done as part of the SgCopyHelp::clone function or perhaps another member function of SgCopyHelp would be useful for this support. It is not serious if the AST post processing is done since that will set any NULL pointers that are found within its traversal.

Exceptions
noneNo exceptions are thrown by this function.

Reimplemented from SgModifier.

SgFunctionModifier& SgFunctionModifier::operator= ( const SgFunctionModifier X)
void SgFunctionModifier::post_construction_initialization ( )
virtual

Final initialization for constructors This function is called at the end of generated constructors to allow the specification writer to add special initialization functions or tests. Default is to do nothing. Otherwise it should be overridden in the spec file, in NewHeaderCode/NewOutlinedCode.

Reimplemented from SgNode.

bool SgFunctionModifier::isUnknown ( ) const
void SgFunctionModifier::setUnknown ( )
void SgFunctionModifier::unsetUnknown ( )
bool SgFunctionModifier::isDefault ( ) const
void SgFunctionModifier::setDefault ( )
void SgFunctionModifier::unsetDefault ( )
bool SgFunctionModifier::isInline ( ) const
void SgFunctionModifier::setInline ( )
void SgFunctionModifier::unsetInline ( )
bool SgFunctionModifier::isVirtual ( ) const
void SgFunctionModifier::setVirtual ( )
void SgFunctionModifier::unsetVirtual ( )
bool SgFunctionModifier::isPureVirtual ( ) const
void SgFunctionModifier::setPureVirtual ( )
void SgFunctionModifier::unsetPureVirtual ( )
bool SgFunctionModifier::isExplicit ( ) const
void SgFunctionModifier::setExplicit ( )
void SgFunctionModifier::unsetExplicit ( )
bool SgFunctionModifier::isPure ( ) const
void SgFunctionModifier::setPure ( )
void SgFunctionModifier::unsetPure ( )
bool SgFunctionModifier::isElemental ( ) const
void SgFunctionModifier::setElemental ( )
void SgFunctionModifier::unsetElemental ( )
bool SgFunctionModifier::isRecursive ( ) const
void SgFunctionModifier::setRecursive ( )
void SgFunctionModifier::unsetRecursive ( )
bool SgFunctionModifier::isGnuAttributeConstructor ( ) const
void SgFunctionModifier::setGnuAttributeConstructor ( )
void SgFunctionModifier::unsetGnuAttributeConstructor ( )
bool SgFunctionModifier::isGnuAttributeDestructor ( ) const
void SgFunctionModifier::setGnuAttributeDestructor ( )
void SgFunctionModifier::unsetGnuAttributeDestructor ( )
bool SgFunctionModifier::isGnuAttributePure ( ) const
void SgFunctionModifier::setGnuAttributePure ( )
void SgFunctionModifier::unsetGnuAttributePure ( )
bool SgFunctionModifier::isGnuAttributeWeak ( ) const
void SgFunctionModifier::setGnuAttributeWeak ( )
void SgFunctionModifier::unsetGnuAttributeWeak ( )
bool SgFunctionModifier::isGnuAttributeUnused ( ) const
void SgFunctionModifier::setGnuAttributeUnused ( )
void SgFunctionModifier::unsetGnuAttributeUnused ( )
bool SgFunctionModifier::isGnuAttributeUsed ( ) const
void SgFunctionModifier::setGnuAttributeUsed ( )
void SgFunctionModifier::unsetGnuAttributeUsed ( )
bool SgFunctionModifier::isGnuAttributeDeprecated ( ) const
void SgFunctionModifier::setGnuAttributeDeprecated ( )
void SgFunctionModifier::unsetGnuAttributeDeprecated ( )
bool SgFunctionModifier::isGnuAttributeMalloc ( ) const
void SgFunctionModifier::setGnuAttributeMalloc ( )
void SgFunctionModifier::unsetGnuAttributeMalloc ( )
bool SgFunctionModifier::isGnuAttributeNaked ( ) const
void SgFunctionModifier::setGnuAttributeNaked ( )
void SgFunctionModifier::unsetGnuAttributeNaked ( )
bool SgFunctionModifier::isGnuAttributeNoInstrumentFunction ( ) const
void SgFunctionModifier::setGnuAttributeNoInstrumentFunction ( )
void SgFunctionModifier::unsetGnuAttributeNoInstrumentFunction ( )
bool SgFunctionModifier::isGnuAttributeNoCheckMemoryUsage ( ) const
void SgFunctionModifier::setGnuAttributeNoCheckMemoryUsage ( )
void SgFunctionModifier::unsetGnuAttributeNoCheckMemoryUsage ( )
bool SgFunctionModifier::isGnuAttributeNoInline ( ) const
void SgFunctionModifier::setGnuAttributeNoInline ( )
void SgFunctionModifier::unsetGnuAttributeNoInline ( )
bool SgFunctionModifier::isGnuAttributeAlwaysInline ( ) const
void SgFunctionModifier::setGnuAttributeAlwaysInline ( )
void SgFunctionModifier::unsetGnuAttributeAlwaysInline ( )
bool SgFunctionModifier::isGnuAttributeNoThrow ( ) const
void SgFunctionModifier::setGnuAttributeNoThrow ( )
void SgFunctionModifier::unsetGnuAttributeNoThrow ( )
bool SgFunctionModifier::isGnuAttributeWeakReference ( ) const
void SgFunctionModifier::setGnuAttributeWeakReference ( )
void SgFunctionModifier::unsetGnuAttributeWeakReference ( )
bool SgFunctionModifier::isCudaDevice ( ) const
void SgFunctionModifier::setCudaDevice ( )
void SgFunctionModifier::unsetCudaDevice ( )
bool SgFunctionModifier::isCudaKernel ( ) const
void SgFunctionModifier::setCudaKernel ( )
void SgFunctionModifier::unsetCudaKernel ( )
bool SgFunctionModifier::isCudaHost ( ) const
void SgFunctionModifier::setCudaHost ( )
void SgFunctionModifier::unsetCudaHost ( )
bool SgFunctionModifier::isOpenclKernel ( ) const
void SgFunctionModifier::setOpenclKernel ( )
void SgFunctionModifier::unsetOpenclKernel ( )
bool SgFunctionModifier::hasOpenclVecTypeHint ( ) const
void SgFunctionModifier::setOpenclVecTypeHint ( )
void SgFunctionModifier::unsetOpenclVecTypeHint ( )
bool SgFunctionModifier::hasOpenclWorkGroupSizeHint ( ) const
void SgFunctionModifier::setOpenclWorkGroupSizeHint ( )
void SgFunctionModifier::unsetOpenclWorkGroupSizeHint ( )
bool SgFunctionModifier::hasOpenclWorkGroupSizeReq ( ) const
void SgFunctionModifier::setOpenclWorkGroupSizeReq ( )
void SgFunctionModifier::unsetOpenclWorkGroupSizeReq ( )
bool SgFunctionModifier::isJavaNative ( ) const
void SgFunctionModifier::setJavaNative ( )
void SgFunctionModifier::unsetJavaNative ( )
bool SgFunctionModifier::isJavaSynchronized ( ) const
void SgFunctionModifier::setJavaSynchronized ( )
void SgFunctionModifier::unsetJavaSynchronized ( )
bool SgFunctionModifier::isJavaStrictfp ( ) const
void SgFunctionModifier::setJavaStrictfp ( )
void SgFunctionModifier::unsetJavaStrictfp ( )
bool SgFunctionModifier::isJavaInitializer ( ) const
void SgFunctionModifier::setJavaInitializer ( )
void SgFunctionModifier::unsetJavaInitializer ( )
std::string SgFunctionModifier::displayString ( ) const

Referenced by toStringForRTI().

void SgFunctionModifier::display ( std::string  label) const
void SgFunctionModifier::reset ( )
virtual std::string SgFunctionModifier::class_name ( ) const
virtual

Copies AST (whole subtree, depending on the SgCopyHelp class.

returns a string representing the class name

Reimplemented from SgModifier.

virtual VariantT SgFunctionModifier::variantT ( ) const
virtual

returns new style SageIII enum values

Reimplemented from SgModifier.

void* SgFunctionModifier::operator new ( size_t  size)

returns pointer to newly allocated IR node

void SgFunctionModifier::operator delete ( void *  pointer,
size_t  size 
)

deallocated memory for IR node (returns memory to memory pool for reuse)

void SgFunctionModifier::operator delete ( void *  pointer)
static size_t SgFunctionModifier::numberOfNodes ( )
static

Returns the total number of IR nodes of this type.

static size_t SgFunctionModifier::memoryUsage ( )
static

Returns the size in bytes of the total memory allocated for all IR nodes of this type.

virtual std::vector<SgNode*> SgFunctionModifier::get_traversalSuccessorContainer ( )
virtual

FOR INTERNAL USE within ROSE traverals mechanism only.

This function builds and returns a copy of ordered container holding pointers to children of this node in a traversal. It is associated with the definition of a tree that is travered by the AST traversal mechanism; a tree that is embeded in the AST (which is a more general graph). This function is used within the implementation of the AST traversal and has a semantics may change in subtle ways that makes it difficult to use in user code. It can return unexpected data members and thus the order and the number of elements is unpredicable and subject to change.

Warning
This function can return unexpected data members and thus the order and the number of elements is unpredicable and subject to change.
Returns
Returns ordered STL Container of pointers to children nodes in AST.

Reimplemented from SgModifier.

virtual std::vector<std::string> SgFunctionModifier::get_traversalSuccessorNamesContainer ( )
virtual

FOR INTERNAL USE within ROSE traverals mechanism only.

This function builds and returns a copy of ordered container holding strings used to name data members that are traversed in the IR node. It is associated with the definition of a tree that is travered by the AST traversal mechanism; a tree that is embeded in the AST (which is a more general graph). This function is used within the implementation of the AST traversal and has a semantics may change in subtle ways that makes it difficult to use in user code. It can return unexpected data members and thus the order and the number of elements is unpredicable and subject to change.

Warning
This function can return unexpected data members and thus the order and the number of elements is unpredicable and subject to change.

Each string is a name of a member variable holding a pointer to a child in the AST. The names are the same as used in the generated enums for accessing attributes in a traversal. The order is the same in which they are traversed and the same in which the access enums are defined. Therefore this method can be used to get the corresponding name (string) of an access enum which allows to produce more meaningful messages for attribute computations.

Returns
Returns ordered STL container of names (strings) of access names to children nodes in AST.

Reimplemented from SgModifier.

virtual size_t SgFunctionModifier::get_numberOfTraversalSuccessors ( )
virtual

Reimplemented from SgModifier.

virtual SgNode* SgFunctionModifier::get_traversalSuccessorByIndex ( size_t  idx)
virtual

Reimplemented from SgModifier.

virtual size_t SgFunctionModifier::get_childIndex ( SgNode child)
virtual

Reimplemented from SgModifier.

virtual RTIReturnType SgFunctionModifier::roseRTI ( )
virtual

FOR INTERNAL USE Access to Runtime Type Information (RTI) for this IR nodes.

 This function provides runtime type information for accessing the

structure of the current node. It is useful for generating code which would dump out or rebuild IR nodes.

Returns
Returns a RTIReturnType object (runtime type information).

Reimplemented from SgModifier.

virtual const char* SgFunctionModifier::sage_class_name ( ) const
virtual

returns a C style string (char*) representing the class name

Reimplemented from SgModifier.

void SgFunctionModifier::executeVisitorMemberFunction ( ROSE_VisitorPattern visitor)

FOR INTERNAL USE Support for visitor pattern.

virtual void SgFunctionModifier::accept ( ROSE_VisitorPattern visitor)
virtual

DXN (08/09/2010): support for the classic visitor pattern done in GoF.

Reimplemented from SgModifier.

static void SgFunctionModifier::traverseMemoryPoolNodes ( ROSE_VisitTraversal visit)
static

FOR INTERNAL USE Support for visitor pattern.

static void SgFunctionModifier::traverseMemoryPoolVisitorPattern ( ROSE_VisitorPattern visitor)
static

FOR INTERNAL USE Support for visitor pattern.

static void SgFunctionModifier::visitRepresentativeNode ( ROSE_VisitTraversal visit)
static

FOR INTERNAL USE Support for type-based traversal.

virtual bool SgFunctionModifier::isInMemoryPool ( )
virtual

FOR INTERNAL USE This is used in internal tests to verify that all IR nodes are allocated from the heap.

The AST File I/O depends upon the allocation of IR nodes being from the heap, stack based or global IR nodes should not appear in the AST if it will be written out to a file and read back in. To enforce this concept, this function implements a test to verify that the IR node can be found on the heap and is part of a larger test of the whole AST. This test must pass before the AST can be written out to a file. This is part of a compromise in the design of the AST File I/O to support binary streaming of data to files; for performance. It is also rather difficult, but possible, to build a useful AST with IR nodes allocated on the stack or frm global scope, this test filters out such cased from being used with the AST File I/O mechanism.

Reimplemented from SgModifier.

virtual void SgFunctionModifier::checkDataMemberPointersIfInMemoryPool ( )
virtual

FOR INTERNAL USE This is used in internal tests to verify that all IR nodes are allocated from the heap.

The AST File I/O depends upon the allocation of IR nodes being from the heap, stack based or global IR nodes should not appear in the AST if it will be written out to a file and read back in. To enforce this concept, this function implements a test to verify that the IR node can be found on the heap and is part of a larger test of the whole AST. This test must pass before the AST can be written out to a file. This is part of a compromise in the design of the AST File I/O to support binary streaming of data to files; for performance. It is also rather difficult, but possible, to build a useful AST with IR nodes allocated on the stack or frm global scope, this test filters out such cased from being used with the AST File I/O mechanism.

Reimplemented from SgModifier.

virtual std::vector<std::pair<SgNode*,std::string> > SgFunctionModifier::returnDataMemberPointers ( ) const
virtual

FOR INTERNAL USE Returns STL vector of pairs of SgNode* and strings for use in AST tools

This functions is part of general support for many possible tools to operate on the AST. The forms a list of ALL IR node pointers used by each IR node, and is a supperset of the get_traversalSuccessorContainer(). It is (I think) less than the set of pointers used by the AST file I/O. This is part of work implemented by Andreas, and support tools such as the AST graph generation.

Warning
This function can return unexpected data members and thus the order and the number of elements is unpredicable and subject to change.
Returns
STL vector of pairs of SgNode* and strings

Reimplemented from SgModifier.

virtual void SgFunctionModifier::processDataMemberReferenceToPointers ( ReferenceToPointerHandler *  )
virtual

FOR INTERNAL USE Processes pairs of references to SgNode* and strings for use in AST tools

This functions similar to returnDataMemberPointers() except that it passes references to a handler object. As a result there is FAR more damage that can be done by using this function, but it is type-safe. This is provided for support of internal tools that operate on the AST, e.g the AST Merge mechanism.

Warning
This function can return unexpected data members and thus the order and the number of elements is unpredicable and subject to change.

Reimplemented from SgModifier.

virtual long SgFunctionModifier::getChildIndex ( SgNode childNode) const
virtual

FOR INTERNAL USE Returns a unique index value for the childNode in the list of children at this IR node.

This function returns a unique value for the input childNode in set of children at this IR node. Note that a negative value indicates that the input node is not a child. This is the basis for the implementation of the isChild(SgNode*) member function. Data members that are NULL in the IR node are counted internally (so that this function returns value that could be statically defined, and so are not dynamically determined).

Warning
The mapping on children to integer values could change from release to release of ROSE.
Returns
long

Reimplemented from SgModifier.

SgFunctionModifier* SgFunctionModifier::addRegExpAttribute ( std::string  s,
AstRegExAttribute a 
)

Support for AST matching using regular expression.

This support is incomplete and the subject of current research to define RegEx trees to support inexact matching.

SgBitVector SgFunctionModifier::get_modifierVector ( ) const
void SgFunctionModifier::set_modifierVector ( SgBitVector  modifierVector)
unsigned long int SgFunctionModifier::get_gnu_attribute_constructor_destructor_priority ( ) const
void SgFunctionModifier::set_gnu_attribute_constructor_destructor_priority ( unsigned long int  gnu_attribute_constructor_destructor_priority)
std::string SgFunctionModifier::get_gnu_attribute_named_weak_reference ( ) const
void SgFunctionModifier::set_gnu_attribute_named_weak_reference ( std::string  gnu_attribute_named_weak_reference)
std::string SgFunctionModifier::get_gnu_attribute_named_alias ( ) const
void SgFunctionModifier::set_gnu_attribute_named_alias ( std::string  gnu_attribute_named_alias)
SgType* SgFunctionModifier::get_opencl_vec_type ( ) const
void SgFunctionModifier::set_opencl_vec_type ( SgType opencl_vec_type)
SgFunctionModifier::opencl_work_group_size_t SgFunctionModifier::get_opencl_work_group_size ( ) const
void SgFunctionModifier::set_opencl_work_group_size ( SgFunctionModifier::opencl_work_group_size_t  opencl_work_group_size)

Friends And Related Function Documentation

friend class AST_FILE_IO
friend

Definition at line 12146 of file Cxx_Grammar.h.

friend class SgFunctionModifierStorageClass
friend

Definition at line 12147 of file Cxx_Grammar.h.

friend class AstSpecificDataManagingClass
friend

Definition at line 12148 of file Cxx_Grammar.h.

friend class AstSpecificDataManagingClassStorageClass
friend

Definition at line 12149 of file Cxx_Grammar.h.

std::ostream& operator<< ( std::ostream &  os,
const SgFunctionModifier m 
)
friend
bool operator== ( const SgFunctionModifier lhs,
const SgFunctionModifier rhs 
)
friend
ROSE_DLL_API friend SgFunctionModifier* isSgFunctionModifier ( SgNode s)
friend

Casts pointer from base class to derived class.

ROSE_DLL_API friend const SgFunctionModifier* isSgFunctionModifier ( const SgNode s)
friend

Casts pointer from base class to derived class (for const pointers)

SgFunctionModifier* SgFunctionModifier_getPointerFromGlobalIndex ( unsigned long  globalIndex)
friend

Constructor for use by AST File I/O Mechanism.

This constructor permits the IR node to be rebuilt from the contiguously arranged data in memory which obtained via fast binary file I/O from disk.

Typedef used for low level memory access.

Typedef used to hold memory addresses as values.

Methods to find the pointer to a global and local index

unsigned long SgFunctionModifier_getNumberOfValidNodesAndSetGlobalIndexInFreepointer ( unsigned  long)
friend

Get the size of the memory pool.

It actually returns the size of the whole blocks allocated, no matter they contain valid pointers or not.

void SgFunctionModifier_clearMemoryPool ( )
friend
void SgFunctionModifier_extendMemoryPoolForFileIO ( unsigned  long)
friend
void SgFunctionModifier_getNextValidPointer ( std::pair< SgFunctionModifier *, std::vector< unsigned char * >::const_iterator > &  )
friend
void SgFunctionModifier_resetValidFreepointers ( )
friend

Member Data Documentation

SgBitVector SgFunctionModifier::p_modifierVector
protected

Definition at line 12226 of file Cxx_Grammar.h.

unsigned long int SgFunctionModifier::p_gnu_attribute_constructor_destructor_priority
protected

Definition at line 12230 of file Cxx_Grammar.h.

std::string SgFunctionModifier::p_gnu_attribute_named_weak_reference
protected

Definition at line 12234 of file Cxx_Grammar.h.

std::string SgFunctionModifier::p_gnu_attribute_named_alias
protected

Definition at line 12238 of file Cxx_Grammar.h.

SgType* SgFunctionModifier::p_opencl_vec_type
protected

Definition at line 12242 of file Cxx_Grammar.h.

SgFunctionModifier::opencl_work_group_size_t SgFunctionModifier::p_opencl_work_group_size
protected

Definition at line 12246 of file Cxx_Grammar.h.


The documentation for this class was generated from the following file: