UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | List of all members
uLang::CSourceFilePackage Class Reference

#include <SourceFileProject.h>

+ Inheritance diagram for uLang::CSourceFilePackage:

Public Member Functions

VERSECOMPILER_API CSourceFilePackage (const CUTF8String &PackageFilePath, const TSRef< IFileSystem > &FileSystem, const TSRef< CDiagnostics > &Diagnostics)
 
VERSECOMPILER_API CSourceFilePackage (const SPackageDesc &PackageDesc, const TSRef< IFileSystem > &FileSystem, const TSRef< CDiagnostics > &Diagnostics)
 
virtual const CUTF8String & GetDirPath () const override
 
virtual const CUTF8String & GetFilePath () const override
 
virtual EOrigin GetOrigin () const override
 
VERSECOMPILER_API CSourceFileModule * GetModuleForFilePath (const CUTF8StringView &FilePath)
 
VERSECOMPILER_API TOptional< TSRef< CSourceFileSnippet > > FindSnippetByFilePath (const CUTF8StringView &FilePath) const
 
VERSECOMPILER_API TOptional< TSRef< CSourceFileSnippet > > AddSnippet (const CUTF8StringView &FilePath)
 
VERSECOMPILER_API bool RemoveSnippet (const CUTF8StringView &FilePath)
 
- Public Member Functions inherited from uLang::CSourcePackage
 CSourcePackage (const CUTF8StringView &Name, const TSRef< CSourceModule > &RootModule)
 Construct from name.
 
virtual ~CSourcePackage ()=default
 
const CUTF8String & GetName () const
 
const SSettings & GetSettings () const
 
VERSECOMPILER_API int32_t GetNumSnippets () const
 
const FSolFingerprint & GetFingerprint () const
 
VERSECOMPILER_API void GenerateFingerprint (TSRef< ISolFingerprintGenerator > &Generator) const
 
void SetName (const CUTF8StringView &NewName)
 
void SetVersePath (const CUTF8StringView &VersePath)
 
void SetVerseScope (const EVerseScope VerseScope)
 
void SetVerseVersion (const TOptional< uint32_t > VerseVersion)
 
void SetAllowExperimental (const bool bAllowExperimental)
 
void SetRole (const EPackageRole Role)
 
void SetTreatDefinitionsAsImplicit (bool bTreatAsImplicit)
 
void SetFingerprint (FSolFingerprint Fingerprint)
 
VERSECOMPILER_API void SetDependencyPackages (TArray< CUTF8String > &&PackageNames)
 
VERSECOMPILER_API void AddDependencyPackage (const CUTF8StringView &PackageName)
 
VERSECOMPILER_API void TruncateVniDestDir ()
 
VERSECOMPILER_API bool RemoveSnippet (const uLang::TSRef< ISourceSnippet > &Snippet)
 
- Public Member Functions inherited from uLang::CSharedMix
 CSharedMix ()
 
virtual UE_API ~CSharedMix ()
 
 CSharedMix (const CSharedMix &Other)=delete
 
CSharedMix & operator= (const CSharedMix &Other)=delete
 
uint32_t GetRefCount () const
 

Additional Inherited Members

- Public Types inherited from uLang::CSourcePackage
enum  EOrigin : uint8_t { Unknown , Memory , FileSystem }
 Where the source code of this package originates. More...
 
- Public Attributes inherited from uLang::CSourcePackage
TSRef< CSourceModule > _RootModule
 The root module of this package, equivalent to the _VersePath specified in _Settings.
 
TOptional< SVersionedDigest > _Digest
 Optional digest to be used instead of source if desired.
 
TOptional< SVersionedDigest > _PublicDigest
 The public-only digest, if it exists.
 
- Static Protected Member Functions inherited from uLang::CSharedMix
template<class ObjectType >
static TSPtrG< ObjectType, false, CHeapRawAllocator > SharedThis (ObjectType *This)
 
template<class ObjectType >
static TSPtrG< const ObjectType, false, CHeapRawAllocator > SharedThis (const ObjectType *This)
 
- Protected Attributes inherited from uLang::CSourcePackage
SSettings _Settings
 Settings, e.g. parsed from .vpackage file.
 

Detailed Description

A package of source modules/snippets on disk

Constructor & Destructor Documentation

◆ CSourceFilePackage() [1/2]

uLang::CSourceFilePackage::CSourceFilePackage ( const CUTF8String &  PackageFilePath,
const TSRef< IFileSystem > &  FileSystem,
const TSRef< CDiagnostics > &  Diagnostics 
)

◆ CSourceFilePackage() [2/2]

uLang::CSourceFilePackage::CSourceFilePackage ( const SPackageDesc &  PackageDesc,
const TSRef< IFileSystem > &  FileSystem,
const TSRef< CDiagnostics > &  Diagnostics 
)

Member Function Documentation

◆ AddSnippet()

TOptional< TSRef< CSourceFileSnippet > > uLang::CSourceFilePackage::AddSnippet ( const CUTF8StringView &  FilePath)

◆ FindSnippetByFilePath()

TOptional< TSRef< CSourceFileSnippet > > uLang::CSourceFilePackage::FindSnippetByFilePath ( const CUTF8StringView &  FilePath) const

◆ GetDirPath()

virtual const CUTF8String & uLang::CSourceFilePackage::GetDirPath ( ) const
inlineoverridevirtual

Reimplemented from uLang::CSourcePackage.

◆ GetFilePath()

virtual const CUTF8String & uLang::CSourceFilePackage::GetFilePath ( ) const
inlineoverridevirtual

Reimplemented from uLang::CSourcePackage.

◆ GetModuleForFilePath()

CSourceFileModule * uLang::CSourceFilePackage::GetModuleForFilePath ( const CUTF8StringView &  FilePath)

◆ GetOrigin()

virtual EOrigin uLang::CSourceFilePackage::GetOrigin ( ) const
inlineoverridevirtual

Reimplemented from uLang::CSourcePackage.

◆ RemoveSnippet()

bool uLang::CSourceFilePackage::RemoveSnippet ( const CUTF8StringView &  FilePath)
The documentation for this class was generated from the following files: