Skip to content

SgSourceFile

Synopsis

Declared in <src/frontend/SageIII/Cxx_Grammar.h> (not stored in Git)

class [[visibility("default")]] SgSourceFile
    : public SgFile

Base Classes

Name Description
SgFile Base class for files in a project. Stores file metadata and command-line options. SgSourceFile owns the global scope of a source file.

Types

Name
fortran_source_context
fortran_source_inclusion
scalar_abi_layout
target_abi_info

Type Aliases

Name
base_node_type

Enums

Name Description
Unnamed enum static variant value
fortran_include_kind
fortran_output_surface
source_origin_enum

Member Functions

Name Description
SgSourceFile
SgSourceFile( bool isGeneratedSource = false, bool isCommandLineInputSource = false); [constructor]
Constructors
~SgSourceFile
virtual ~SgSourceFile(); [destructor] [virtual]
Destructor
accept
virtual void accept(ROSE_VisitorPattern& visitor) override; [virtual]
support for the classic visitor pattern done in GoF
appendDestructorOwnedNodes
virtual void appendDestructorOwnedNodes(std::vector<SgNode*>& nodes) const override; [virtual]
buildAST
virtual int buildAST( std::vector<std::string> argv, std::vector<std::string> inputCommandLine) override; [virtual]
build_C_and_Cxx_AST
int build_C_and_Cxx_AST( std::vector<std::string> argv, std::vector<std::string> inputCommandLine);
build_Fortran_AST
int build_Fortran_AST(std::vector<std::string> argv);
Divide up the handling of different languages
callFrontEnd
virtual int callFrontEnd() override; [virtual]
class_name
virtual std::string class_name() const override; [virtual]
returns a string representing the class name
clear_tokenSubsequenceMap
void clear_tokenSubsequenceMap();
copy
virtual SgNode* copy(SgCopyHelp& help) const override; [virtual]
copy_frontendAssociations
void copy_frontendAssociations( SgSourceFile const& source, SgCopyHelp& help);
fixupCopy_references
virtual void fixupCopy_references( SgNode* copy, SgCopyHelp& help) const override; [virtual]
fixupCopy_scopes
virtual void fixupCopy_scopes( SgNode* copy, SgCopyHelp& help) const override; [virtual]
fixupCopy_symbols
virtual void fixupCopy_symbols( SgNode* copy, SgCopyHelp& help) const override; [virtual]
get_associated_include_file
SgIncludeFile* get_associated_include_file() const;
get_childIndex
virtual size_t get_childIndex(SgNode* child) const override; [virtual]
index-based access to traversal successors by child node
get_fortran_output_surface
fortran_output_surface get_fortran_output_surface() const;
get_fortran_source_context
SgSourceFile::fortran_source_context get_fortran_source_context() const;
get_frontendExternalFileList
SgFileList* get_frontendExternalFileList() const;
get_frontendExternalOwnershipPathList
SgStringList const& get_frontendExternalOwnershipPathList() const;
get_frontendIncludeOwnershipPathList
SgStringList const& get_frontendIncludeOwnershipPathList() const;
get_frontendResolvedIncludeDirectivesMap
std::map<std::string, std::set<PreprocessingInfo*>> get_frontendResolvedIncludeDirectivesMap() const;
get_frontendSystemIncludeOwnershipPathList
SgStringList const& get_frontendSystemIncludeOwnershipPathList() const;
get_globalScope
SgGlobal* get_globalScope() const;
get_isCommandLineInputSource
bool get_isCommandLineInputSource() const;
get_isGeneratedSource
bool get_isGeneratedSource() const;
get_isHeaderFile
bool get_isHeaderFile() const;
get_macroExpansionMap
std::map<SgStatement*, MacroExpansion*>& get_macroExpansionMap();
get_numberOfTraversalSuccessors
virtual size_t get_numberOfTraversalSuccessors() const override; [virtual]
return number of children in the traversal successor list
get_processedToIncludeCppDirectivesAndComments
bool get_processedToIncludeCppDirectivesAndComments() const;
get_representativeWhitespaceStatementMap
std::map<SgScopeStatement*, SgStatement*>& get_representativeWhitespaceStatementMap();
get_target_abi
SgSourceFile::target_abi_info get_target_abi() const;
get_target_size_type
SgType* get_target_size_type() const;
get_tokenSubsequenceMap
std::map<SgNode*, TokenStreamSequenceToNodeMapping*>& get_tokenSubsequenceMap();
get_token_list
SgTokenPtrList const& get_token_list() const;
get_traversalSuccessorByIndex
virtual SgNode* get_traversalSuccessorByIndex(size_t idx) const override; [virtual]
index-based access to traversal successors by index number
get_traversalSuccessorContainer
virtual std::vector<SgNode*> get_traversalSuccessorContainer() const override; [virtual]
container of pointers to AST successor nodes used in the traversal overridden in every class by generated implementation
get_traversalSuccessorIsListElement
virtual std::vector<bool> get_traversalSuccessorIsListElement() const override; [virtual]
get_traversalSuccessorNamesContainer
virtual std::vector<std::string> get_traversalSuccessorNamesContainer() const override; [virtual]
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
initialization
void initialization();
initializeGlobalScope
void initializeGlobalScope();
operator delete
void operator delete( void* pointer, size_t size);
deallocated memory for IR node (returns memory to memory pool for reuse)
operator new
void* operator new(size_t size);
returns pointer to newly allocated IR node
post_construction_initialization
virtual void post_construction_initialization() override; [virtual]
processDataMemberReferenceToPointers
virtual void processDataMemberReferenceToPointers(ReferenceToPointerHandler*) override; [virtual]
Pass references to stored node pointers to a handler.
returnDataMemberPointers
virtual std::vector<std::pair<SgNode*, std::string>> returnDataMemberPointers() const override; [virtual]
Return the node pointers stored in this node's data members.
roseRTI
virtual RTIReturnType roseRTI() override; [virtual]
return C++ Runtime-Time-Information
sage_class_name
virtual char const* sage_class_name() const override; [virtual]
returns a C style string (char*) representing the class name
set_associated_include_file
void set_associated_include_file(SgIncludeFile* associated_include_file);
set_fortran_source_context
void set_fortran_source_context(SgSourceFile::fortran_source_context fortran_source_context);
set_frontendExternalFileList
void set_frontendExternalFileList(SgFileList* frontendExternalFileList);
set_frontendResolvedIncludeDirectivesMap
void set_frontendResolvedIncludeDirectivesMap(std::map<std::string, std::set<PreprocessingInfo*>> frontendResolvedIncludeDirectivesMap);
set_globalScope
void set_globalScope(SgGlobal* globalScope);
set_isCommandLineInputSource
void set_isCommandLineInputSource(bool isCommandLineInputSource);
set_isGeneratedSource
void set_isGeneratedSource(bool isGeneratedSource);
set_isHeaderFile
void set_isHeaderFile(bool isHeaderFile);
set_macroExpansionMap
void set_macroExpansionMap(std::map<SgStatement*, MacroExpansion*>& macroExpansionMap);
set_processedToIncludeCppDirectivesAndComments
void set_processedToIncludeCppDirectivesAndComments(bool processedToIncludeCppDirectivesAndComments);
set_representativeWhitespaceStatementMap
void set_representativeWhitespaceStatementMap(std::map<SgScopeStatement*, SgStatement*>& representativeWhitespaceStatementMap);
set_target_abi
void set_target_abi(SgSourceFile::target_abi_info target_abi);
set_target_size_type
void set_target_size_type(SgType* target_size_type);
set_tokenSubsequenceMap
void set_tokenSubsequenceMap(std::map<SgNode*, TokenStreamSequenceToNodeMapping*>* tokenStreamSequenceMap);
variantT
virtual VariantT variantT() const override; [virtual]
returns new style SageIII enum values

Static Member Functions

Name Description
memoryUsage
static size_t memoryUsage();
Returns the size in bytes of the total memory allocated for all IR nodes of this type
numberOfNodes
static size_t numberOfNodes();
Returns the total number of IR nodes of this type
traverseMemoryPoolNodes
static void traverseMemoryPoolNodes(ROSE_VisitTraversal& visit);
FOR INTERNAL USE Support for visitor pattern over all IR nodes by type of IR node.
traverseMemoryPoolVisitorPattern
static void traverseMemoryPoolVisitorPattern(ROSE_VisitorPattern& visitor);
FOR INTERNAL USE Support for visitor pattern.
visitRepresentativeNode
static void visitRepresentativeNode(ROSE_VisitTraversal& visit);
FOR INTERNAL USE Support for type-based traversal.

Static Data Members

Name Description
free_slots Free slots, each numbered pool_index * pool_size + slot_index. The last entry is allocated next.
pool_live_flags
pool_size
pools

Protected Data Members

Name
p_associated_include_file
p_fortran_source_context
p_frontendExternalFileList
p_frontendExternalOwnershipPathList
p_frontendIncludeOwnershipPathList
p_frontendResolvedIncludeDirectivesMap
p_frontendSystemIncludeOwnershipPathList
p_globalScope
p_isCommandLineInputSource
p_isGeneratedSource
p_isHeaderFile
p_processedToIncludeCppDirectivesAndComments
p_target_abi
p_target_size_type
p_tokenSubsequenceMap
p_token_list

Private Member Functions

Name
release_tokenSubsequenceMap
void release_tokenSubsequenceMap();

Friends

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

Created with MrDocs