ROSE  0.11.145.0
Public Types | Public Member Functions | Static Public Member Functions | Protected Attributes | Static Protected Attributes | Friends | List of all members
SgUnparse_Info Class Reference

Description

Definition at line 31850 of file Cxx_Grammar.h.

Inheritance diagram for SgUnparse_Info:
Inheritance graph
[legend]
Collaboration diagram for SgUnparse_Info:
Collaboration graph
[legend]

Public Types

enum  unparse_type_num {
  b_enum_defaultValue = 0,
  b_isPointerToSomething = 1,
  b_isReferenceToSomething = 2,
  b_inVarDecl = 3,
  b_inArgList = 4,
  b_SkipSemiColon = 5,
  b_inEnumDecl = 6,
  b_inTemplateList = 7,
  b_SkipBaseType = 8,
  b_inAggregateInitializer = 9,
  b_isWithType = 10,
  b_inConditional = 11,
  b_SkipDefinition = 12,
  b_SkipClassSpecifier = 13,
  b_inEmbeddedDecl = 14,
  b_SkipGlobal = 15,
  b_SkipAtomic = 16,
  b_PrintName = 17,
  b_CheckAccess = 18,
  b_SkipFunctionQualifier = 19,
  b_isArrayType = 20,
  b_inRhsExpr = 21,
  b_SkipParen = 22,
  b_isTypeSecondPart = 23,
  b_isTypeFirstPart = 24,
  b_SkipInitializer = 25,
  b_SkipComments = 26,
  b_SkipCPPDirectives = 27,
  b_SkipEnumDefinition = 28,
  b_SkipFunctionDefinition = 29,
  b_SkipClassDefinition = 30,
  b_AddSemiColonAfterDeclaration = 31,
  b_SkipWhitespaces = 32,
  b_SkipBasicBlock = 33,
  b_outputClassTemplateName = 34,
  b_outputCompilerGeneratedStatements = 35,
  b_SkipConstantFoldedExpressions = 36,
  b_forceQualifiedNames = 37,
  b_SkipQualifiedNames = 38,
  b_skipCheckAccess = 39,
  b_requiresGlobalNameQualification = 40,
  b_useTypeAttributes = 41,
  b_SkipFormatting = 42,
  b_outputFortranModFile = 43,
  b_supressStrippedTypeName = 44,
  b_prefixOperator = 45,
  b_supressArrayBound = 46,
  b_supressImplicitThisOperator = 47,
  b_unparsedPartiallyUsingTokenStream = 48,
  b_skipCompilerGeneratedSubExpressions = 49,
  b_parentStatementListBeingUnparsedUsingPartialTokenSequence = 50,
  b_cxx11_initialization_list = 51,
  b_inTypedefDecl = 52,
  b_SkipNameQualification = 53,
  b_useAlternativeDefiningDeclaration = 54,
  b_usedInUparseToStringFunction = 55,
  UNPARSE_TYPE_LAST
}
 Options available for unparsing the AST to generate source code. More...
 
enum  access_attr_enum {
  a_unset_access = 1,
  a_private_access = 2,
  a_protected_access = 3,
  a_public_access = 4,
  a_default_access = 5
}
 
enum  { static_variant = V_SgUnparse_Info }
 static variant value
 
typedef SgSupport base_node_type
 
- Public Types inherited from SgSupport
enum  { static_variant = V_SgSupport }
 static variant value
 
typedef SgNode base_node_type
 
- Public Types inherited from SgNode
enum  { static_variant = V_SgNode }
 static variant value
 

Public Member Functions

virtual SgNodecopy (SgCopyHelp &help) const override
 This function clones the current IR node object recursively or not, depending on the argument. More...
 
 SgUnparse_Info (const SgUnparse_Info &X)
 
SgUnparse_Infooperator= (const SgUnparse_Info &X)
 
void post_construction_initialization () override
 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.
 
bool isUnsetAccess () const
 
void set_isUnsetAccess ()
 
bool isPrivateAccess () const
 
void set_isPrivateAccess ()
 
bool isProtectedAccess () const
 
void set_isProtectedAccess ()
 
bool isPublicAccess () const
 
void set_isPublicAccess ()
 
bool isDefaultAccess () const
 
void set_isDefaultAccess ()
 
bool isPointerToSomething () const
 
void set_isPointerToSomething ()
 
void unset_isPointerToSomething ()
 
bool isReferenceToSomething () const
 
void set_isReferenceToSomething ()
 
void unset_isReferenceToSomething ()
 
bool inVarDecl () const
 
void set_inVarDecl ()
 
void unset_inVarDecl ()
 
bool inArgList () const
 
void set_inArgList ()
 
void unset_inArgList ()
 
bool SkipSemiColon () const
 
void set_SkipSemiColon ()
 
void unset_SkipSemiColon ()
 
bool inEnumDecl () const
 
void set_inEnumDecl ()
 
void unset_inEnumDecl ()
 
bool inTemplateList () const
 
void set_inTemplateList ()
 
void unset_inTemplateList ()
 
bool SkipBaseType () const
 
void set_SkipBaseType ()
 
void unset_SkipBaseType ()
 
bool inAggregateInitializer () const
 
void set_inAggregateInitializer ()
 
void unset_inAggregateInitializer ()
 
bool isWithType () const
 
void set_isWithType ()
 
void unset_isWithType ()
 
bool inConditional () const
 
void set_inConditional ()
 
void unset_inConditional ()
 
bool SkipDefinition () const
 
void set_SkipDefinition ()
 
void unset_SkipDefinition ()
 
bool SkipClassSpecifier () const
 
void set_SkipClassSpecifier ()
 
void unset_SkipClassSpecifier ()
 
bool inEmbeddedDecl () const
 
void set_inEmbeddedDecl ()
 
void unset_inEmbeddedDecl ()
 
bool SkipGlobal () const
 
void set_SkipGlobal ()
 
void unset_SkipGlobal ()
 
bool SkipAtomic () const
 
void set_SkipAtomic ()
 
void unset_SkipAtomic ()
 
bool PrintName () const
 
void set_PrintName ()
 
void unset_PrintName ()
 
bool CheckAccess () const
 
void set_CheckAccess ()
 
void unset_CheckAccess ()
 
bool SkipFunctionQualifier () const
 
void set_SkipFunctionQualifier ()
 
void unset_SkipFunctionQualifier ()
 
bool isArrayType () const
 
void set_isArrayType ()
 
void unset_isArrayType ()
 
bool inRhsExpr () const
 
void set_inRhsExpr ()
 
void unset_inRhsExpr ()
 
bool SkipParen () const
 
void set_SkipParen ()
 
void unset_SkipParen ()
 
bool isTypeSecondPart () const
 Tests the setting of the flag to permit output of 2nd part of type.
 
void set_isTypeSecondPart ()
 Sets flag to permit output of 2nd part of type. More...
 
void unset_isTypeSecondPart ()
 Unsets the flag to permit output of 2nd part of type. More...
 
bool isTypeFirstPart () const
 Tests the setting of the flag to permit output of 1st part of type.
 
void set_isTypeFirstPart ()
 Sets flag to permit output of 1st part of type. More...
 
void unset_isTypeFirstPart ()
 Unsets the flag to permit output of 1st part of type. More...
 
bool SkipInitializer () const
 
void set_SkipInitializer ()
 
void unset_SkipInitializer ()
 
bool SkipComments () const
 
void set_SkipComments ()
 
void unset_SkipComments ()
 
bool SkipWhitespaces () const
 
void set_SkipWhitespaces ()
 
void unset_SkipWhitespaces ()
 
bool SkipCPPDirectives () const
 
void set_SkipCPPDirectives ()
 
void unset_SkipCPPDirectives ()
 
bool SkipEnumDefinition () const
 
void set_SkipEnumDefinition ()
 
void unset_SkipEnumDefinition ()
 
bool SkipFunctionDefinition () const
 
void set_SkipFunctionDefinition ()
 
void unset_SkipFunctionDefinition ()
 
bool SkipClassDefinition () const
 
void set_SkipClassDefinition ()
 
void unset_SkipClassDefinition ()
 
bool AddSemiColonAfterDeclaration () const
 
void set_AddSemiColonAfterDeclaration ()
 
void unset_AddSemiColonAfterDeclaration ()
 
bool SkipBasicBlock () const
 
void set_SkipBasicBlock ()
 
void unset_SkipBasicBlock ()
 
bool outputClassTemplateName () const
 
void set_outputClassTemplateName ()
 
void unset_outputClassTemplateName ()
 
bool outputCompilerGeneratedStatements () const
 
void set_outputCompilerGeneratedStatements ()
 
void unset_outputCompilerGeneratedStatements ()
 
bool SkipConstantFoldedExpressions () const
 Control output of constant folded values, the default is to ignore constant folded values and unparse the original code (as if no constant folding were done). More...
 
void set_SkipConstantFoldedExpressions ()
 
void unset_SkipConstantFoldedExpressions ()
 
bool forceQualifiedNames () const
 
void set_forceQualifiedNames ()
 
void unset_forceQualifiedNames ()
 
bool skipCheckAccess () const
 
void set_skipCheckAccess ()
 
void unset_skipCheckAccess ()
 
bool SkipQualifiedNames () const
 
void set_SkipQualifiedNames ()
 
void unset_SkipQualifiedNames ()
 
bool requiresGlobalNameQualification () const
 
void set_requiresGlobalNameQualification ()
 
void unset_requiresGlobalNameQualification ()
 
bool useTypeAttributes () const
 
void set_useTypeAttributes ()
 
void unset_useTypeAttributes ()
 
bool SkipFormatting () const
 
void set_SkipFormatting ()
 
void unset_SkipFormatting ()
 
bool supressStrippedTypeName () const
 
void set_supressStrippedTypeName ()
 
void unset_supressStrippedTypeName ()
 
std::string get_operator_name ()
 
void set_operator_name (const std::string &on)
 
SgNameget_name ()
 
void set_name (const SgName &name)
 
void unset_name ()
 
SgDeclarationStatementget_decl_stmt ()
 
void set_decl_stmt (SgDeclarationStatement *stmt)
 
void unset_decl_stmt ()
 
int get_nested_expression ()
 
void set_nested_expression ()
 
void unset_nested_expression ()
 
bool isPrefixOperator () const
 
void set_prefixOperator ()
 
void unset_prefixOperator ()
 
bool supressArrayBound () const
 
void set_supressArrayBound ()
 
void unset_supressArrayBound ()
 
bool supressImplicitThisOperator () const
 
void set_supressImplicitThisOperator ()
 
void unset_supressImplicitThisOperator ()
 
bool unparsedPartiallyUsingTokenStream () const
 
void set_unparsedPartiallyUsingTokenStream ()
 
void unset_unparsedPartiallyUsingTokenStream ()
 
bool skipCompilerGeneratedSubExpressions () const
 
void set_skipCompilerGeneratedSubExpressions ()
 
void unset_skipCompilerGeneratedSubExpressions ()
 
bool parentStatementListBeingUnparsedUsingPartialTokenSequence () const
 
void set_parentStatementListBeingUnparsedUsingPartialTokenSequence ()
 
void unset_parentStatementListBeingUnparsedUsingPartialTokenSequence ()
 
bool get_cxx11_initialization_list () const
 
void set_cxx11_initialization_list ()
 
void unset_cxx11_initialization_list ()
 
bool inTypedefDecl () const
 
void set_inTypedefDecl ()
 
void unset_inTypedefDecl ()
 
bool SkipNameQualification () const
 
void set_SkipNameQualification ()
 
void unset_SkipNameQualification ()
 
bool useAlternativeDefiningDeclaration () const
 
void set_useAlternativeDefiningDeclaration ()
 
void unset_useAlternativeDefiningDeclaration ()
 
bool usedInUparseToStringFunction () const
 
void set_usedInUparseToStringFunction ()
 
void unset_usedInUparseToStringFunction ()
 
void unset_declaration_of_context ()
 
void unset_current_context ()
 
SgName get_array_index_list ()
 
void set_array_index_list (SgExpression *e, SgUnparse_Info finfo)
 
void unset_array_index_list ()
 
void addStructureTag (SgNamedType *structureTag)
 
SgTypePtrList & getStructureTagList ()
 Access function for internal STL list of structure tags.
 
void display (const std::string &label="") const
 
std::string displayString (const std::string &label) const
 
bool outputFortranModFile () const
 
void set_outputFortranModFile ()
 
void unset_outputFortranModFile ()
 
void inc_nestingLevel ()
 
void dec_nestingLevel ()
 
virtual std::string class_name () const override
 returns a string representing the class name
 
virtual VariantT variantT () const override
 returns new style SageIII enum values
 
void * operator new (size_t size)
 returns pointer to newly allocated IR node
 
void operator delete (void *pointer, size_t size)
 deallocated memory for IR node (returns memory to memory pool for reuse)
 
void operator delete (void *pointer)
 
virtual std::vector< SgNode * > get_traversalSuccessorContainer () override
 container of pointers to AST successor nodes used in the traversal overridden in every class by generated implementation
 
virtual std::vector< std::string > get_traversalSuccessorNamesContainer () override
 container of names of variables or container indices used used in the traversal to access AST successor nodes overridden in every class by generated implementation
 
virtual size_t get_numberOfTraversalSuccessors () override
 return number of children in the traversal successor list
 
virtual SgNodeget_traversalSuccessorByIndex (size_t idx) override
 index-based access to traversal successors by index number
 
virtual size_t get_childIndex (SgNode *child) override
 index-based access to traversal successors by child node
 
virtual RTIReturnType roseRTI () override
 return C++ Runtime-Time-Information
 
virtual const char * sage_class_name () const override ROSE_DEPRECATED_FUNCTION
 
void executeVisitorMemberFunction (ROSE_VisitorPattern &visitor)
 FOR INTERNAL USE Support for visitor pattern.
 
virtual void accept (ROSE_VisitorPattern &visitor) override
 support for the classic visitor pattern done in GoF
 
virtual bool isInMemoryPool () override
 FOR INTERNAL USE This is used in internal tests to verify that all IR nodes are allocated from the heap. More...
 
virtual void checkDataMemberPointersIfInMemoryPool () override
 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 override
 FOR INTERNAL USE Returns STL vector of pairs of SgNode* and strings for use in AST tools More...
 
virtual void processDataMemberReferenceToPointers (ReferenceToPointerHandler *) override
 FOR INTERNAL USE Processes pairs of references to SgNode* and strings for use in AST tools More...
 
virtual long getChildIndex (SgNode *childNode) const override
 FOR INTERNAL USE Returns a unique index value for the childNode in the list of children at this IR node. More...
 
 SgUnparse_Info (const SgUnparse_InfoStorageClass &source)
 IR node constructor to support AST File I/O.
 
SgUnparse_InfoaddRegExpAttribute (std::string s, AstRegExAttribute *a)
 Support for AST matching using regular expression. More...
 
int get_access_attribute () const
 
void set_access_attribute (int access_attribute)
 
SgDeclarationStatementget_declstatement_ptr () const
 
void set_declstatement_ptr (SgDeclarationStatement *declstatement_ptr)
 
SgDeclarationStatementget_declaration_of_context () const
 
void set_declaration_of_context (SgDeclarationStatement *declaration_of_context)
 
SgNamedTypeget_current_context () const
 
void set_current_context (SgNamedType *current_context)
 
SgName get_array_index_list () const
 
void set_array_index_list (SgName array_index_list)
 
SgNamespaceDeclarationStatementget_current_namespace () const
 
void set_current_namespace (SgNamespaceDeclarationStatement *current_namespace)
 
bool get_outputCodeGenerationFormatDelimiters () const
 
void set_outputCodeGenerationFormatDelimiters (bool outputCodeGenerationFormatDelimiters)
 
SgQualifiedNamePtrList get_qualifiedNameList () const
 
void set_qualifiedNameList (SgQualifiedNamePtrList qualifiedNameList)
 
SgFunctionCallExpget_current_function_call () const
 
void set_current_function_call (SgFunctionCallExp *current_function_call)
 
SgScopeStatementget_current_scope () const
 
void set_current_scope (SgScopeStatement *current_scope)
 
SgNodeget_reference_node_for_qualification () const
 
void set_reference_node_for_qualification (SgNode *reference_node_for_qualification)
 
int get_name_qualification_length () const
 
void set_name_qualification_length (int name_qualification_length)
 
bool get_type_elaboration_required () const
 
void set_type_elaboration_required (bool type_elaboration_required)
 
bool get_global_qualification_required () const
 
void set_global_qualification_required (bool global_qualification_required)
 
int get_nestingLevel () const
 
void set_nestingLevel (int nestingLevel)
 
SgFile::languageOption_enum get_language () const
 
void set_language (SgFile::languageOption_enum language)
 
SgSourceFileget_current_source_file () const
 
void set_current_source_file (SgSourceFile *current_source_file)
 
bool get_use_generated_name_for_template_arguments () const
 
void set_use_generated_name_for_template_arguments (bool use_generated_name_for_template_arguments)
 
bool get_user_defined_literal () const
 
void set_user_defined_literal (bool user_defined_literal)
 
SgDeclarationStatementget_declstatement_associated_with_type () const
 
void set_declstatement_associated_with_type (SgDeclarationStatement *declstatement_associated_with_type)
 
bool get_context_for_added_parentheses () const
 
void set_context_for_added_parentheses (bool context_for_added_parentheses)
 
- Public Member Functions inherited from SgSupport
void * operator new (size_t size)
 returns pointer to newly allocated IR node
 
void operator delete (void *pointer, size_t size)
 deallocated memory for IR node (returns memory to memory pool for reuse)
 
void operator delete (void *pointer)
 
void executeVisitorMemberFunction (ROSE_VisitorPattern &visitor)
 FOR INTERNAL USE Support for visitor pattern.
 
 SgSupport (const SgSupportStorageClass &source)
 IR node constructor to support AST File I/O.
 
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
 
void operator delete (void *pointer, size_t size)
 deallocated memory for IR node (returns memory to memory pool for reuse)
 
void operator delete (void *pointer)
 
void executeVisitorMemberFunction (ROSE_VisitorPattern &visitor)
 FOR INTERNAL USE Support for visitor pattern.
 
 SgNode (const SgNodeStorageClass &source)
 IR node constructor to support AST File I/O.
 
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...
 
void set_containsTransformation (bool containsTransformation)
 Many nodes can hide other AST nodes and we need to track when outer nodes contain modified nodes even if they are not themselves modified. More...
 
bool get_isModified () const
 Acess function for isModified flag. More...
 
bool get_containsTransformation () const
 Acess function for containsTransformation flag. 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...
 
SgNodeget_raw_parent () const
 Access function for direct access to uncomputed value of parent node.
 
bool isChild (SgNode *node) const
 Query function for if the input IR nodes is a child of the current IR node.
 
virtual std::string unparseToString (SgUnparse_Info *info) const
 This function unparses the AST node (excluding comments and unnecessary white space)
 
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.
 
virtual AstAttributegetAttribute (std::string s) const
 Returns attribute of name 's'.
 
virtual void updateAttribute (std::string s, AstAttribute *a)
 Replace existing attribute of name 's' with new AstAttribute.
 
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.
 
virtual void removeAttribute (std::string s)
 Remove attribute of name 's' if present.
 
virtual bool attributeExists (std::string s) const
 Tests if attribute of name 's' is present.
 
virtual int numberOfAttributes () const
 Returns the number of attributes on this IR node.
 
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.
 
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).
 
virtual Sg_File_Infoget_endOfConstruct (void) const
 New function interface for Sg_File_Info data stores ending location of contruct (typically the closing brace).
 
VirtualCFG::CFGNode cfgForBeginning ()
 Returns the CFG node for just before this AST node.
 
VirtualCFG::CFGNode cfgForEnd ()
 Returns the CFG node for just after this AST node.
 
virtual unsigned int cfgIndexForEnd () const
 Determine the CFG index for the end of this construct.
 
virtual bool cfgIsIndexInteresting (unsigned int index) const
 Determine whether a particular CFG node index is "interesting" for this kind of node.
 
virtual unsigned int cfgFindChildIndex (SgNode *n)
 Find the index of n in this node's CFG children.
 
virtual unsigned int cfgFindNextChildIndex (SgNode *n)
 Find the index just after n in this node's CFG children.
 
virtual std::vector< VirtualCFG::CFGEdgecfgOutEdges (unsigned int index=false)
 Find the out edges of a CFG node – internal version.
 
virtual std::vector< VirtualCFG::CFGEdgecfgInEdges (unsigned int index=false)
 Find the in edges of a CFG node – internal version.
 
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...
 
template<class T >
T * initParentPointer (T *child, SgNode *parent)
 Generated for tree edge data member initializations. More...
 
SgNodeget_freepointer () const
 
void set_freepointer (SgNode *freepointer)
 
virtual ~SgNode ()
 This is the destructor. More...
 
 SgNode ()
 This is the constructor. More...
 
template<class T >
std::enable_if< std::is_pointer< T >::value, void >::type changeChildPointer (T &edge, T const &child)
 Set a child edge in a tree to point to a specific child. More...
 
template<class T >
std::enable_if< !std::is_pointer< T >::value, void >::type changeChildPointer (T &edge, T const &child)
 Set a child edge in a tree to point to a specific child. 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 bool get_forceDefaultConstructorToTriggerError ()
 Added to debug use of the default constructor. More...
 
static void set_forceDefaultConstructorToTriggerError (bool forceDefaultConstructorToTriggerError)
 
static bool get_extern_C_with_braces ()
 
static void set_extern_C_with_braces (bool extern_C_with_braces)
 
static SgStatementget_previouslyUnparsedStatement ()
 
static void set_previouslyUnparsedStatement (SgStatement *previouslyUnparsedStatement)
 
static bool get_previousStatementUnparsedFromTokenStream ()
 
static void set_previousStatementUnparsedFromTokenStream (bool previousStatementUnparsedFromTokenStream)
 
static void deleteMemoryPool ()
 
static size_t numberOfNodes ()
 Returns the total number of IR nodes of this type.
 
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.
 
static void traverseMemoryPoolVisitorPattern (ROSE_VisitorPattern &visitor)
 FOR INTERNAL USE Support for visitor pattern.
 
static void visitRepresentativeNode (ROSE_VisitTraversal &visit)
 FOR INTERNAL USE Support for type-based traversal.
 
static SgNodegetNodeByNodeId (VariantT variantT, size_t poolIdx, size_t itemIdx)
 Find a node by its variant type, pool index, and item index.
 
static SgUnparse_InfogetNodeByNodeIdInternal (size_t poolIdx, size_t itemIdx)
 FOR INTERNAL USE Find an SgNode from its memory pool and location therin.
 
static std::string getNodeIdString (SgUnparse_Info *sgnode)
 compute the NodeId for a particular SgNode*.
 
static std::string getNodeIdStringInternal (SgUnparse_Info *sgnode)
 
- Static Public Member Functions inherited from SgSupport
static void deleteMemoryPool ()
 
static size_t numberOfNodes ()
 Returns the total number of IR nodes of this type.
 
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.
 
static void traverseMemoryPoolVisitorPattern (ROSE_VisitorPattern &visitor)
 FOR INTERNAL USE Support for visitor pattern.
 
static void visitRepresentativeNode (ROSE_VisitTraversal &visit)
 FOR INTERNAL USE Support for type-based traversal.
 
static SgNodegetNodeByNodeId (VariantT variantT, size_t poolIdx, size_t itemIdx)
 Find a node by its variant type, pool index, and item index.
 
static SgSupportgetNodeByNodeIdInternal (size_t poolIdx, size_t itemIdx)
 FOR INTERNAL USE Find an SgNode from its memory pool and location therin.
 
static std::string getNodeIdString (SgSupport *sgnode)
 compute the NodeId for a particular SgNode*.
 
static std::string getNodeIdStringInternal (SgSupport *sgnode)
 
- Static Public Member Functions inherited from SgNode
static void deleteMemoryPool ()
 
static size_t numberOfNodes ()
 Returns the total number of IR nodes of this type.
 
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.
 
static void traverseMemoryPoolVisitorPattern (ROSE_VisitorPattern &visitor)
 FOR INTERNAL USE Support for visitor pattern.
 
static void visitRepresentativeNode (ROSE_VisitTraversal &visit)
 FOR INTERNAL USE Support for type-based traversal.
 
static SgNodegetNodeByNodeId (VariantT variantT, size_t poolIdx, size_t itemIdx)
 Find a node by its variant type, pool index, and item index.
 
static SgNodegetNodeByNodeIdInternal (size_t poolIdx, size_t itemIdx)
 FOR INTERNAL USE Find an SgNode from its memory pool and location therin.
 
static std::string getNodeIdString (SgNode *sgnode)
 compute the NodeId for a particular SgNode*.
 
static std::string getNodeIdStringInternal (SgNode *sgnode)
 
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< VariantT > getClassHierarchySubTreeFunction (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.
 
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::map< SgNode *, std::string > > & get_globalQualifiedNameMapForMapsOfTypes ()
 Access function for name qualification support (for maps of types). More...
 
static void set_globalQualifiedNameMapForMapsOfTypes (const std::map< SgNode *, std::map< SgNode *, std::string > > &X)
 Access function for name qualification support (for maps of types). More...
 
static std::map< SgNode *, std::string > & get_globalQualifiedNameMapForTemplateHeaders ()
 Access function for name qualification support (for template headers in template declarations). More...
 
static void set_globalQualifiedNameMapForTemplateHeaders (const std::map< SgNode *, std::string > &X)
 Access function for name qualification support (for template headers in template declarations). 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.
 
static void set_globalFunctionTypeTable (SgFunctionTypeTable *globalFunctionTypeTable)
 Access function for symbol table specific to function types.
 
static SgTypeTableget_globalTypeTable ()
 Access function for symbol table specific to non-function types.
 
static void set_globalTypeTable (SgTypeTable *globalTypeTable)
 Access function for symbol table specific to non-function types.
 
static VariantT variantFromPool (SgNode const *n)
 
template<class T >
static std::enable_if< std::is_base_of< SgNode, T >::value, T * >::type createAndParent (SgNode *parent)
 Allocate and return a new node after setting its parent. More...
 

Protected Attributes

SgBitVector p_unparse_attribute
 
int p_access_attribute
 
int p_nested_expression
 
std::string p_operator_name
 
SgName p_var_name
 
SgDeclarationStatementp_declstatement_ptr
 
SgDeclarationStatementp_declaration_of_context
 
SgNamedTypep_current_context
 
SgName p_array_index_list
 
SgNamespaceDeclarationStatementp_current_namespace
 
bool p_outputCodeGenerationFormatDelimiters
 
SgQualifiedNamePtrList p_qualifiedNameList
 
SgFunctionCallExpp_current_function_call
 
SgScopeStatementp_current_scope
 
SgNodep_reference_node_for_qualification
 
int p_name_qualification_length
 
bool p_type_elaboration_required
 
bool p_global_qualification_required
 
int p_nestingLevel
 
SgFile::languageOption_enum p_language
 
SgSourceFilep_current_source_file
 
bool p_use_generated_name_for_template_arguments
 
bool p_user_defined_literal
 
SgDeclarationStatementp_declstatement_associated_with_type
 
bool p_context_for_added_parentheses
 
- Protected Attributes inherited from SgNode
SgNodep_parent
 This is the pointer to the parent IR node in the AST. More...
 
bool p_isModified
 Records if IR node has been modified (data members reset). More...
 
bool p_containsTransformation
 
SgNodep_freepointer
 This is the pointer to the chain of previously freed objects.
 

Static Protected Attributes

static SgTypePtrList p_structureTagProcessingList
 
static bool p_forceDefaultConstructorToTriggerError
 
static bool p_extern_C_with_braces
 
static SgStatementp_previouslyUnparsedStatement
 
static bool p_previousStatementUnparsedFromTokenStream
 
- Static Protected Attributes inherited from SgNode
static std::vector< std::tuple< unsigned char *, unsigned, VariantT > > all_pools
 
static SgFunctionTypeTablep_globalFunctionTypeTable
 Pointer to symbol table specific to function types.
 
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.
 
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.
 
static std::map< SgNode *, std::string > p_globalQualifiedNameMapForNames
 
static std::map< SgNode *, std::string > p_globalQualifiedNameMapForTypes
 
static std::map< SgNode *, std::string > p_globalQualifiedNameMapForTemplateHeaders
 
static std::map< SgNode *, std::string > p_globalTypeNameMap
 
static std::map< SgNode *, std::map< SgNode *, std::string > > p_globalQualifiedNameMapForMapsOfTypes
 

Friends

ROSE_DLL_API friend SgUnparse_InfoisSgUnparse_Info (SgNode *s)
 Casts pointer from base class to derived class.
 
ROSE_DLL_API friend const SgUnparse_InfoisSgUnparse_Info (const SgNode *s)
 Casts pointer from base class to derived class (for const pointers)
 

Additional Inherited Members

- Protected Member Functions inherited from SgNode
virtual void destructorHelper ()
 This gets called by all Rosebud-generated destructors. More...
 
virtual void debugSerializationBegin (const char *className)
 Called by generated serializers. More...
 
virtual void debugSerializationEnd (const char *className)
 Called by generated serializers. More...
 

Member Enumeration Documentation

Options available for unparsing the AST to generate source code.

These options can be set or unset and are passed from each unparse function to any called unparse functions. Sometimes a new unparse info object is generated, always using the copy constructor, so that the options can be modified for unparsing different parts of the AST.

Enumerator
b_enum_defaultValue 

DQ (11/4/2003): Build a default value to support initialization.

default value

b_isPointerToSomething 

to postponing the printing of name for ptr of function or array etc

postponing the printing of name for ptr of function or array etc

b_isReferenceToSomething 

postponing the printing of name for ptr of function or array etc

b_inVarDecl 

if it is in Variable Declaration, output either , or ; for SgExprStmt

if it is in Variable Declaration, output either , or ; for SgExprStmt

b_inArgList 

in a function header, output type+ symbol

in a function header, output type+ symbol

b_SkipSemiColon 

no ';' for declaration statement

no ';' for declaration statement

b_inEnumDecl 

to setup for printing of enum var in a VariableDeclaration

setup for printing of enum var in a VariableDeclaration

b_inTemplateList 

not really being used (yet)

not really being used (yet)

b_SkipBaseType 

suppress printing of the base type

suppress printing of the base type

b_inAggregateInitializer 

for skip "=" if in aggregate initializer

skip "=" if in aggregate initializer

b_isWithType 

for print both type & sym name

print both type and sym name

b_inConditional 

it is in conditional expr

is in conditional expr (context information)

b_SkipDefinition 

skip printing definition part of a declaration

skip output of definitions (sets b_SkipEnumDefinition, b_SkipFunctionDefinition, and b_SkipClassDefinition

b_SkipClassSpecifier 

need to put in either class/struct/union keyword

skip the class specifier (modifier)

b_inEmbeddedDecl 

printing something within a variable declaration

printing something within a variable declaration

b_SkipGlobal 

suppress the printing of global and atomic

suppress the printing of global and atomic (hold over from CC++, I think (not used)

b_SkipAtomic 

suppress the printing of global and atomic (hold over from CC++, I think (not used)

b_PrintName 

used by set/unsetName and set/unsetPrintName to bring down the Name to lower tree structure

used by set/unsetName and set/unsetPrintName to bring down the Name to lower tree structure

b_CheckAccess 

to set the need to check if need access specifier (avoids redundently specific access modifiers)

set the need to check if need access specifier

b_SkipFunctionQualifier 

to skip function qualifiers

skip function qualifiers

b_isArrayType 

to show that the type above current one is an array

show that the type above current one is an array

b_inRhsExpr 

to indicate that this is at the right hand side of a binary op

indicate that this is at the right hand side of a binary op

b_SkipParen 

to flag the skipping of () printing in a function call this is for a bug in g++ that can not handle (P::dval->B::mfcall)() skipping the toplevel only

skip over output of matching "(" and ")"

b_isTypeSecondPart 

for the case that this maybe a function type, separate the outputing of the type info into 2 parts, the return type part and the arg type by default this is always set to 0

unparse only second part of type

b_isTypeFirstPart 

unparse only first part of type

b_SkipInitializer 

Added by DQ to permit reuse of unparser code in generation of declarations in rewrite mechanism.

skip output of initializers

b_SkipComments 

Added by DQ to permit reuse of unparser code in generation of declarations in rewrite mechanism.

ignore all comments in unparsing

b_SkipCPPDirectives 

Added by DQ to permit reuse of unparser code in generation of declarations in rewrite mechanism.

ignore all C preprocessor directives (except #pragma which is in the AST)

b_SkipEnumDefinition 

Added by DQ to permit reuse of unparser code in generation of declarations in rewrite mechanism.

skip over enum definition, if available

b_SkipFunctionDefinition 

Added by DQ to permit reuse of unparser code in generation of declarations in rewrite mechanism.

skip over the function definition, if available

b_SkipClassDefinition 

Added by DQ to permit reuse of unparser code in generation of declarations in rewrite mechanism.

skip over the class definition, if available

b_AddSemiColonAfterDeclaration 

Added by DQ to permit reuse of unparser code in generation of declarations in rewrite mechanism.

add ';' after declaration

b_SkipWhitespaces 

MS: 09/03/02 Added by MS to make unparsing of white space optional currently only used in unparseToCompleteString (by removing whitespaces) I only added it here to follow the design but suggest to use varibles of type bool, and extend the ROSETTA code to add these attributes, and generate the access functions - unfortunately the naming scheme does not comply with ROSETTA's naming scheme for access functions.

ignore any unrequired white space

b_SkipBasicBlock 

DQ (11/3/2003): made all bit flags 64 bit long so that we could add a few more entries.

Added bit flag to control generation of prefix scope statements. This permits unparsing SgForStmt, SgWhileStmt, SgSwitchStmt, etc., without their body so that we can capture the full context of the declarations associated with such statements. In the case of SgSwitchStmt it also permits replacement of case statements which are specific to SgSwitchStmt basic blocks and no other basic blocks. This verifies the correctness of transformation specified. skip over the unparsing of the basic block

b_outputClassTemplateName 

Templates that are modified need to be output, but all other output of a class template only supports the output of the class template name (but in template form, e.g.

"Rose_STL_Container<int>"). If the template has not been transformed then we have to control where it is output. The default can't be to output the template everywhere and then restrict it's use since the unparser can't turn that on, so we have to restrict it everywhere and turn it on in several places. outputClassTemplateName

b_outputCompilerGeneratedStatements 

Control output of compiler-generated statements (typically template specialization declarations).

this allows the unparing of comments and preprocessor declarations before the compiler-generated statements appearing with any non-compiler-generated statement. outputCompilerGeneratedStatements

b_SkipConstantFoldedExpressions 

Control output of constant folded values.

SkipConstantFoldedExpressions

b_forceQualifiedNames 

Force qualified names.

b_SkipQualifiedNames 

Control output of qualified names (not always wanted).

skip qualified names (e.g. names of defining declarations).

b_skipCheckAccess 

Control access specifiers use in generated code (public, protected, private).

Skip access specifier (different from b_CheckAccess, above)

b_requiresGlobalNameQualification 

Requires global qualifier on generated name.

b_useTypeAttributes 

Fortran allows type attributes to be used in declarations (for example to dimension a collection of arrays).

b_SkipFormatting 

Fortran code generation requires that we skip some formatting (e.g. column 7 formatting, even if fixed format output).

b_outputFortranModFile 

Fortran mod file generation

b_supressStrippedTypeName 

Unparsing of Fortran types with multiple attributes requires skipping the stripped base type name if it has already been output.

b_prefixOperator 

Part of support to unparse code using overloaded operator names or operator syntax (to match the input code); this marks prefix operators to be unparsed before the LHS s output.

b_supressArrayBound 

Supress output of array bound in array type. Used to support array declearations with empty bracket syntax for secondary (prototype) declarations (e.g. int array[];).

b_supressImplicitThisOperator 

Supress output of SgThisExp (required to support lambda function code generation).

b_unparsedPartiallyUsingTokenStream 

Record that the statement was partially unparsed using the token stream.

b_skipCompilerGeneratedSubExpressions 

Supress compiler generated subexpressions (used to output fields in the 2nd parameter of the offsetof() function family.

b_parentStatementListBeingUnparsedUsingPartialTokenSequence 

Controls output formatting (CR's) in mixing unparsing from token stream with unparsing from the AST.

b_cxx11_initialization_list 

Indicate when we are in a C++11 specific initialization list.

b_inTypedefDecl 

to setup unparsing of base types in typedef declarations (for SgPointerMemberType) which requires extra parenthesis.

setup unparsing of base types in typedef declarations (for SgPointerMemberType) which requires extra parenthesis

b_SkipNameQualification 

Skip the use of name qualification (used in generating strings of template instantiations)

b_useAlternativeDefiningDeclaration 

Skip the use of name qualification (used in generating strings of template instantiations)

b_usedInUparseToStringFunction 

Mark this use as being called from the unparseToString() functions (used in debugging)

UNPARSE_TYPE_LAST 

DQ (12/6/2003): Added last value to use a upper bound in loops.

last value used for debugging

Definition at line 31897 of file Cxx_Grammar.h.

Access modifiers for use with SgUnparseInfo (only)

Enumerator
a_unset_access 

default value

a_private_access 

private access value

a_protected_access 

protected access value

a_public_access 

public access value

a_default_access 

public access value

Definition at line 32074 of file Cxx_Grammar.h.

Member Function Documentation

virtual SgNode* SgUnparse_Info::copy ( SgCopyHelp help) const
overridevirtual

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.

Reimplemented from SgSupport.

void SgUnparse_Info::set_isTypeSecondPart ( )

Sets flag to permit output of 2nd part of type.

This sets the flag for output of the 2nd part of a type and unsets the flag for the 1st part of the type.

void SgUnparse_Info::unset_isTypeSecondPart ( )

Unsets the flag to permit output of 2nd part of type.

This only unsets the flag for the output of the 2nd part of a type (no change to the flag for the 1st part of the type).

void SgUnparse_Info::set_isTypeFirstPart ( )

Sets flag to permit output of 1st part of type.

This sets the flag for output of the 1st part of a type and unsets the flag for the 2nd part of the type.

void SgUnparse_Info::unset_isTypeFirstPart ( )

Unsets the flag to permit output of 1st part of type.

This only unsets the flag for the output of the 1st part of a type (not change to the flag for the 2nd part of the type).

bool SgUnparse_Info::SkipConstantFoldedExpressions ( ) const

Control output of constant folded values, the default is to ignore constant folded values and unparse the original code (as if no constant folding were done).

(default is unset)

static bool SgUnparse_Info::get_forceDefaultConstructorToTriggerError ( )
static

Added to debug use of the default constructor.

Added to debug use of the default constructor (to restrict it from being used so that we could detect where it is being used in place of the copy constructor which should be used to implement the SgUnparse_Info object correctly as an inherited attribute within the ROSE unparser.

virtual const char* SgUnparse_Info::sage_class_name ( ) const
overridevirtual

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

Reimplemented from SgSupport.

virtual bool SgUnparse_Info::isInMemoryPool ( )
overridevirtual

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 SgSupport.

virtual void SgUnparse_Info::checkDataMemberPointersIfInMemoryPool ( )
overridevirtual

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 SgSupport.

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

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 SgSupport.

virtual void SgUnparse_Info::processDataMemberReferenceToPointers ( ReferenceToPointerHandler *  )
overridevirtual

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 SgSupport.

virtual long SgUnparse_Info::getChildIndex ( SgNode childNode) const
overridevirtual

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 SgSupport.

SgUnparse_Info* SgUnparse_Info::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.


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