uLang::CSourcePackage Class Reference

#include <SourceProject.h>

Inheritance diagram for uLang::CSourcePackage:

Classes
struct	SSettings
struct	SVersionedDigest

Public Types
enum	EOrigin : uint8_t { Unknown , Memory , FileSystem }
	Where the source code of this package originates. More...

Public Member Functions
	CSourcePackage (const CUTF8StringView &Name, const TSRef< CSourceModule > &RootModule)
	Construct from name.
virtual	~CSourcePackage ()=default
const CUTF8String &	GetName () const
const SSettings &	GetSettings () const
virtual EOrigin	GetOrigin () const
virtual const CUTF8String &	GetDirPath () const
virtual const CUTF8String &	GetFilePath () 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

Public Attributes
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.

Protected Attributes
SSettings	_Settings
	Settings, e.g. parsed from .vpackage file.

Additional Inherited Members
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)

Detailed Description

A package of modules

Member Enumeration Documentation

EOrigin

enum uLang::CSourcePackage::EOrigin : uint8_t

Where the source code of this package originates.

Enumerator
Unknown
Memory
FileSystem

Constructor & Destructor Documentation

CSourcePackage()

uLang::CSourcePackage::CSourcePackage ( const CUTF8StringView &  Name, const TSRef< CSourceModule > &  RootModule  )

inline

Construct from name.

~CSourcePackage()

virtual uLang::CSourcePackage::~CSourcePackage ( )

virtualdefault

Member Function Documentation

AddDependencyPackage()

void uLang::CSourcePackage::AddDependencyPackage

(

const CUTF8StringView &

PackageName

)

GenerateFingerprint()

void uLang::CSourcePackage::GenerateFingerprint

(

TSRef< ISolFingerprintGenerator > &

Generator

)

const

GetDirPath()

virtual const CUTF8String & uLang::CSourcePackage::GetDirPath ( ) const

inlinevirtual

Reimplemented in uLang::CSourceDataPackage, and uLang::CSourceFilePackage.

GetFilePath()

virtual const CUTF8String & uLang::CSourcePackage::GetFilePath ( ) const

inlinevirtual

Reimplemented in uLang::CSourceFilePackage.

GetFingerprint()

const FSolFingerprint & uLang::CSourcePackage::GetFingerprint ( ) const

inline

GetName()

const CUTF8String & uLang::CSourcePackage::GetName ( ) const

inline

GetNumSnippets()

int32_t uLang::CSourcePackage::GetNumSnippets

(

)

const

GetOrigin()

virtual EOrigin uLang::CSourcePackage::GetOrigin ( ) const

inlinevirtual

Reimplemented in uLang::CSourceDataPackage, and uLang::CSourceFilePackage.

GetSettings()

const SSettings & uLang::CSourcePackage::GetSettings ( ) const

inline

RemoveSnippet()

bool uLang::CSourcePackage::RemoveSnippet

(

const uLang::TSRef< ISourceSnippet > &

Snippet

)

SetAllowExperimental()

void uLang::CSourcePackage::SetAllowExperimental ( const bool  bAllowExperimental )

inline

SetDependencyPackages()

void uLang::CSourcePackage::SetDependencyPackages

(

TArray< CUTF8String > &&

PackageNames

)

SetFingerprint()

void uLang::CSourcePackage::SetFingerprint ( FSolFingerprint  Fingerprint )

inline

SetName()

void uLang::CSourcePackage::SetName ( const CUTF8StringView &  NewName )

inline

SetRole()

void uLang::CSourcePackage::SetRole ( const EPackageRole  Role )

inline

SetTreatDefinitionsAsImplicit()

void uLang::CSourcePackage::SetTreatDefinitionsAsImplicit ( bool  bTreatAsImplicit )

inline

SetVersePath()

void uLang::CSourcePackage::SetVersePath ( const CUTF8StringView &  VersePath )

inline

SetVerseScope()

void uLang::CSourcePackage::SetVerseScope ( const EVerseScope  VerseScope )

inline

SetVerseVersion()

void uLang::CSourcePackage::SetVerseVersion ( const TOptional< uint32_t >  VerseVersion )

inline

TruncateVniDestDir()

void uLang::CSourcePackage::TruncateVniDestDir

(

)

Member Data Documentation

_Digest

TOptional<SVersionedDigest> uLang::CSourcePackage::_Digest

Optional digest to be used instead of source if desired.

_PublicDigest

TOptional<SVersionedDigest> uLang::CSourcePackage::_PublicDigest

The public-only digest, if it exists.

_RootModule

TSRef<CSourceModule> uLang::CSourcePackage::_RootModule

The root module of this package, equivalent to the _VersePath specified in _Settings.

_Settings

SSettings uLang::CSourcePackage::_Settings

protected

Settings, e.g. parsed from .vpackage file.

---

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

• Engine/Source/Runtime/VerseCompiler/Public/uLang/SourceProject/SourceProject.h
• Engine/Source/Runtime/VerseCompiler/Private/uLang/SourceProject/SourceProject.cpp