uLang::CSourceFileSnippet Class Reference

#include <SourceFileProject.h>

Inheritance diagram for uLang::CSourceFileSnippet:

Public Member Functions
	CSourceFileSnippet (CUTF8String &&FilePath, const TSRef< IFileSystem > &FileSystem)
virtual CUTF8String	GetPath () const override
virtual void	SetPath (const CUTF8String &Path) override
virtual VERSECOMPILER_API TOptional< CUTF8String >	GetText () const override
virtual TOptional< uLang::TSRef< Verse::Vst::Snippet > >	GetVst () const override
virtual void	SetVst (TSRef< Verse::Vst::Snippet > Snippet) override
const CUTF8StringView &	GetFilePath () const
bool	HasModifiedText () const
const CUTF8StringView &	GetModifiedText () const
void	SetModifiedText (const CUTF8StringView &Text)
void	UnsetModifiedText ()
	operator const CUTF8String & () const
TOptional< SIndexedSourceText >	GetIndexedSourceText ()
void	MarkDirty (int32_t MinDeadLine)
bool	IsSnippetValid (Verse::Vst::Snippet &Snippet) const override
uint64_t	GetSourceVersion () const override
Public Member Functions inherited from uLang::ISourceSnippet
virtual	~ISourceSnippet ()
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

Static Public Attributes
static constexpr char	_InvalidSnippetCharacters [] = "\\:*?\"<>|' ,&!~\n\r\t@#"

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 source snippet on disk

Constructor & Destructor Documentation

CSourceFileSnippet()

uLang::CSourceFileSnippet::CSourceFileSnippet ( CUTF8String &&  FilePath, const TSRef< IFileSystem > &  FileSystem  )

inline

Member Function Documentation

GetFilePath()

const CUTF8StringView & uLang::CSourceFileSnippet::GetFilePath ( ) const

inline

GetIndexedSourceText()

TOptional< SIndexedSourceText > uLang::CSourceFileSnippet::GetIndexedSourceText

(

)

GetModifiedText()

const CUTF8StringView & uLang::CSourceFileSnippet::GetModifiedText ( ) const

inline

GetPath()

virtual CUTF8String uLang::CSourceFileSnippet::GetPath ( ) const

inlineoverridevirtual

Globally unique path of this snippet, e.g. a fully qualified file path

Implements uLang::ISourceSnippet.

GetSourceVersion()

uint64_t uLang::CSourceFileSnippet::GetSourceVersion ( ) const

inlineoverridevirtual

Reimplemented from uLang::ISourceSnippet.

GetText()

TOptional< CUTF8String > uLang::CSourceFileSnippet::GetText ( ) const

overridevirtual

Get text representation of this snippet When the result is EResult::Unspecified, no text representation exists When the result is EResult::Error, text representation exists, but an error occurred retrieving it

Implements uLang::ISourceSnippet.

GetVst()

virtual TOptional< uLang::TSRef< Verse::Vst::Snippet > > uLang::CSourceFileSnippet::GetVst ( ) const

inlineoverridevirtual

Get Vst representation of this snippet When the result is EResult::Unspecified, no Vst representation exists When the result is EResult::Error, Vst representation exists, but an error occurred retrieving it

Implements uLang::ISourceSnippet.

HasModifiedText()

bool uLang::CSourceFileSnippet::HasModifiedText ( ) const

inline

IsSnippetValid()

bool uLang::CSourceFileSnippet::IsSnippetValid ( Verse::Vst::Snippet &  Snippet ) const

inlineoverridevirtual

Source version tracking to facilitate some VST reuse across compiles By default, all cached snippet VSTs are invalid so we won't reuse them.

Reimplemented from uLang::ISourceSnippet.

MarkDirty()

void uLang::CSourceFileSnippet::MarkDirty ( int32_t  MinDeadLine )

inline

operator const CUTF8String &()

uLang::CSourceFileSnippet::operator const CUTF8String & ( ) const

inline

SetModifiedText()

void uLang::CSourceFileSnippet::SetModifiedText ( const CUTF8StringView &  Text )

inline

SetPath()

virtual void uLang::CSourceFileSnippet::SetPath ( const CUTF8String &  Path )

inlineoverridevirtual

Implements uLang::ISourceSnippet.

SetVst()

virtual void uLang::CSourceFileSnippet::SetVst ( TSRef< Verse::Vst::Snippet >  Snippet )

inlineoverridevirtual

Implements uLang::ISourceSnippet.

UnsetModifiedText()

void uLang::CSourceFileSnippet::UnsetModifiedText ( )

inline

Member Data Documentation

_InvalidSnippetCharacters

constexpr char uLang::CSourceFileSnippet::_InvalidSnippetCharacters[] = "\\:*?\"<>|' ,&!~\n\r\t@#"

staticconstexpr

---

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

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