UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
uLang::CSourceModule Class Reference

#include <SourceProject.h>

+ Inheritance diagram for uLang::CSourceModule:

Public Member Functions

 CSourceModule (const CUTF8StringView &Name)
 Construct from name.
 
virtual ~CSourceModule ()=default
 
const CUTF8StringGetName () const
 
virtual const CUTF8StringGetFilePath () const
 
VERSECOMPILER_API CUTF8StringView GetNameFromFile () const
 
VERSECOMPILER_API TOptional< TSRef< CSourceModule > > FindSubmodule (const CUTF8StringView &ModuleName) const
 
VERSECOMPILER_API void AddSnippet (const uLang::TSRef< ISourceSnippet > &Snippet)
 
VERSECOMPILER_API bool RemoveSnippet (const uLang::TSRef< ISourceSnippet > &Snippet, bool bRecursive)
 
template<typename FunctionType >
bool VisitAll (FunctionType &&Lambda) const
 
template<typename FunctionType >
bool VisitAll (FunctionType &&Lambda)
 
ULANG_FORCEINLINE bool operator== (const CUTF8StringView &Name) const
 For lookup by name.
 
- Public Member Functions inherited from uLang::CSharedMix
 CSharedMix ()
 
virtual UE_API ~CSharedMix ()
 
 CSharedMix (const CSharedMix &Other)=delete
 
CSharedMixoperator= (const CSharedMix &Other)=delete
 
uint32_t GetRefCount () const
 

Static Public Member Functions

static VERSECOMPILER_API CUTF8StringView GetNameFromFile (const CUTF8StringView &ModuleFilePath)
 

Public Attributes

TSRefArray< ISourceSnippet_SourceSnippets
 The source files contained in the module.
 
TSRefArray< CSourceModule_Submodules
 Submodules of this module.
 

Protected Attributes

CUTF8String _Name
 Name of this module.
 

Additional Inherited Members

- Static Protected Member Functions inherited from uLang::CSharedMix
template<class ObjectType >
static TSPtrG< ObjectType, false, CHeapRawAllocatorSharedThis (ObjectType *This)
 
template<class ObjectType >
static TSPtrG< const ObjectType, false, CHeapRawAllocatorSharedThis (const ObjectType *This)
 

Detailed Description

A module

Constructor & Destructor Documentation

◆ CSourceModule()

uLang::CSourceModule::CSourceModule ( const CUTF8StringView Name)
inline

Construct from name.

◆ ~CSourceModule()

virtual uLang::CSourceModule::~CSourceModule ( )
virtualdefault

Member Function Documentation

◆ AddSnippet()

void uLang::CSourceModule::AddSnippet ( const uLang::TSRef< ISourceSnippet > &  Snippet)

◆ FindSubmodule()

TOptional< TSRef< CSourceModule > > uLang::CSourceModule::FindSubmodule ( const CUTF8StringView ModuleName) const

◆ GetFilePath()

virtual const CUTF8String & uLang::CSourceModule::GetFilePath ( ) const
inlinevirtual

Reimplemented in uLang::CSourceFileModule.

◆ GetName()

const CUTF8String & uLang::CSourceModule::GetName ( ) const
inline

◆ GetNameFromFile() [1/2]

CUTF8StringView uLang::CSourceModule::GetNameFromFile ( ) const

◆ GetNameFromFile() [2/2]

CUTF8StringView uLang::CSourceModule::GetNameFromFile ( const CUTF8StringView ModuleFilePath)
static

◆ operator==()

ULANG_FORCEINLINE bool uLang::CSourceModule::operator== ( const CUTF8StringView Name) const
inline

For lookup by name.

◆ RemoveSnippet()

bool uLang::CSourceModule::RemoveSnippet ( const uLang::TSRef< ISourceSnippet > &  Snippet,
bool  bRecursive 
)

◆ VisitAll() [1/2]

template<typename FunctionType >
bool uLang::CSourceModule::VisitAll ( FunctionType &&  Lambda)

◆ VisitAll() [2/2]

template<typename FunctionType >
bool uLang::CSourceModule::VisitAll ( FunctionType &&  Lambda) const

Visit this module and all its submodules Lambda returns true to continue visiting, false to terminate search Returns true if all modules have been visited, false if search was terminated early

Member Data Documentation

◆ _Name

CUTF8String uLang::CSourceModule::_Name
protected

Name of this module.

◆ _SourceSnippets

TSRefArray<ISourceSnippet> uLang::CSourceModule::_SourceSnippets

The source files contained in the module.

◆ _Submodules

TSRefArray<CSourceModule> uLang::CSourceModule::_Submodules

Submodules of this module.


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