uLang::ISourceSnippet Class Reference

#include <SourceProject.h>

Inheritance diagram for uLang::ISourceSnippet:

Public Member Functions
virtual	~ISourceSnippet ()
virtual CUTF8String	GetPath () const =0
virtual void	SetPath (const CUTF8String &Path)=0
virtual TOptional< CUTF8String >	GetText () const =0
virtual TOptional< TSRef< Verse::Vst::Snippet > >	GetVst () const =0
virtual void	SetVst (TSRef< Verse::Vst::Snippet > Snippet)=0
virtual bool	IsSnippetValid (Verse::Vst::Snippet &Snippet) const
virtual uint64_t	GetSourceVersion () const
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
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

Abstraction of a source file

Constructor & Destructor Documentation

~ISourceSnippet()

virtual uLang::ISourceSnippet::~ISourceSnippet ( )

inlinevirtual

Member Function Documentation

GetPath()

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

pure virtual

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

Implemented in uLang::CSourceDataSnippet, and uLang::CSourceFileSnippet.

GetSourceVersion()

virtual uint64_t uLang::ISourceSnippet::GetSourceVersion ( ) const

inlinevirtual

Reimplemented in uLang::CSourceFileSnippet.

GetText()

virtual TOptional< CUTF8String > uLang::ISourceSnippet::GetText ( ) const

pure virtual

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

Implemented in uLang::CSourceDataSnippet, and uLang::CSourceFileSnippet.

GetVst()

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

pure virtual

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

Implemented in uLang::CSourceDataSnippet, and uLang::CSourceFileSnippet.

IsSnippetValid()

virtual bool uLang::ISourceSnippet::IsSnippetValid ( Verse::Vst::Snippet &  Snippet ) const

inlinevirtual

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 in uLang::CSourceFileSnippet.

SetPath()

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

pure virtual

Implemented in uLang::CSourceDataSnippet, and uLang::CSourceFileSnippet.

SetVst()

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

pure virtual

Implemented in uLang::CSourceDataSnippet, and uLang::CSourceFileSnippet.

---

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

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