Skip to content

SgDirectory

This class represents a directory within a projects file structure of files and directories.

Synopsis

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

class [[visibility("default")]] SgDirectory
    : public SgSupport

Description

This IR node is intended to allow the AST at the SgProject level to have the same representation as a project being compiled using ROSE.

  • Internal: This is not yet used in ROSE and has been added as an experiment to support very large ASTs for a whole project. It is expected a a million lines of code will require a few Gig of storage, but memory is cheap, so we will see what we can accomplish. Note that it is a limitation of ROSETTA that we have to have the file list and the directory list be pointers to separate (new) IR nodes that contain the actually STL lists of files and directories. Note clear if this limitation in ROSETTA is documented anywhere :-).
  • Todo: Consider adding a SgFileInfo data member to be uniform with SgFile.
  • See also: Example of using a SgDirectory object

Base Classes

Name Description
SgSupport This class represents the base class of a numbr of IR nodes that don't otherwise fit

Type Aliases

Name
base_node_type

Enums

Name Description
Unnamed enum static variant value

Member Functions

Name Description
SgDirectory
SgDirectory(std::string name = ""); [constructor]
Default constructor
~SgDirectory
virtual ~SgDirectory(); [destructor] [virtual]
Destructor
accept
virtual void accept(ROSE_VisitorPattern& visitor) override; [virtual]
support for the classic visitor pattern done in GoF
addNewAttribute
virtual void addNewAttribute( std::string s, AstAttribute* a) override; [virtual]
Add a new attribute represented by the named string.
appendDestructorOwnedNodes
virtual void appendDestructorOwnedNodes(std::vector<SgNode*>& nodes) const override; [virtual]
attributeExists
virtual bool attributeExists(std::string s) const override; [virtual]
Tests if attribute of name 's' is present.
class_name
virtual std::string class_name() const override; [virtual]
returns a string representing the class name
copy
virtual SgNode* copy(SgCopyHelp& help) const override; [virtual]
getAttribute
virtual AstAttribute* getAttribute(std::string s) const override; [virtual]
Returns attribute of name 's'.
get_attributeMechanism
virtual AstAttributeMechanism* get_attributeMechanism() const override; [virtual]
get_childIndex
virtual size_t get_childIndex(SgNode* child) const override; [virtual]
index-based access to traversal successors by child node
get_directory
SgDirectory* get_directory(int i) const;
get_directoryList
SgDirectoryList* get_directoryList() const;
get_file
SgFile* get_file(int i) const;
get_fileList
SgFileList* get_fileList() const;
get_name
std::string get_name() const;
get_numberOfTraversalSuccessors
virtual size_t get_numberOfTraversalSuccessors() const override; [virtual]
return number of children in the traversal successor list
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
numberOfAttributes
virtual int numberOfAttributes() const override; [virtual]
Returns the number of attributes on this IR node.
numberOfDirectories
int numberOfDirectories() const;
numberOfFiles
int numberOfFiles() const;
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.
removeAttribute
virtual void removeAttribute(std::string s) override; [virtual]
Remove attribute of name 's' if present.
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
setAttribute
virtual void setAttribute( std::string s, AstAttribute* a) override; [virtual]
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.
set_attributeMechanism
virtual void set_attributeMechanism(AstAttributeMechanism* attributeMechanism) override; [virtual]
set_directoryList
void set_directoryList(SgDirectoryList* directoryList);
set_fileList
void set_fileList(SgFileList* fileList);
set_name
void set_name(std::string name);
updateAttribute
virtual void updateAttribute( std::string s, AstAttribute* a) override; [virtual]
Replace existing attribute of name 's' with new AstAttribute.
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_attributeMechanism
p_directoryList
p_fileList
p_name

Friends

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

Created with MrDocs