Navigation
API > API/Runtime > API/Runtime/VerseCompiler
A source snippet on disk
| Name | CSourceFileSnippet |
| Type | class |
| Header File | /Engine/Source/Runtime/VerseCompiler/Public/uLang/SourceProject/SourceFileProject.h |
| Include Path | #include "uLang/SourceProject/SourceFileProject.h" |
Syntax
class CSourceFileSnippet : public uLang::ISourceSnippet
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
CSourceFileSnippet
(
CUTF8String&& FilePath, |
uLang/SourceProject/SourceFileProject.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| _InvalidSnippetCharacters | char | This mimics what Unreal allows for package names, except that we allow periods in filenames as well. | uLang/SourceProject/SourceFileProject.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| _FilePath | CUTF8String | uLang/SourceProject/SourceFileProject.h | ||
| _FileSystem | TSRef< IFileSystem > | uLang/SourceProject/SourceFileProject.h | ||
| _LineIndexCache | TArray< int64_t > | uLang/SourceProject/SourceFileProject.h | ||
| _ModifiedText | TOptional< CUTF8String > | uLang/SourceProject/SourceFileProject.h | ||
| _SnippetVersion | uint64_t | uLang/SourceProject/SourceFileProject.h | ||
| _Vst | TOptional< TSRef< Verse::Vst::Snippet > > | uLang/SourceProject/SourceFileProject.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
const CUTF8StringView & GetFilePath() |
uLang/SourceProject/SourceFileProject.h | ||
TOptional< SIndexedSourceText > GetIndexedSourceText() |
uLang/SourceProject/SourceFileProject.h | ||
const CUTF8StringView & GetModifiedText() |
uLang/SourceProject/SourceFileProject.h | ||
bool HasModifiedText() |
uLang/SourceProject/SourceFileProject.h | ||
void MarkDirty
(
int32_t MinDeadLine |
DeadLine represents the first line we know is invalid. | uLang/SourceProject/SourceFileProject.h | |
void SetModifiedText
(
const CUTF8StringView& Text |
uLang/SourceProject/SourceFileProject.h | ||
void UnsetModifiedText() |
uLang/SourceProject/SourceFileProject.h |
Overridden from ISourceSnippet
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual CUTF8String GetPath() |
Globally unique path of this snippet, e.g. a fully qualified file path | uLang/SourceProject/SourceFileProject.h | |
virtual uint64_t GetSourceVersion() |
uLang/SourceProject/SourceFileProject.h | ||
virtual TOptional< CUTF8String > GetText() |
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 | uLang/SourceProject/SourceFileProject.h | |
virtual TOptional< uLang::TSRef< Verse::Vst::Snippet > > GetVst() |
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 | uLang/SourceProject/SourceFileProject.h | |
virtual bool IsSnippetValid
(
Verse::Vst::Snippet& Snippet |
Source version tracking to facilitate some VST reuse across compiles By default, all cached snippet VSTs are invalid so we won't reuse them. | uLang/SourceProject/SourceFileProject.h | |
virtual void SetPath
(
const CUTF8String& Path |
uLang/SourceProject/SourceFileProject.h | ||
virtual void SetVst
(
TSRef< Verse::Vst::Snippet > Snippet |
uLang/SourceProject/SourceFileProject.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
operator const CUTF8String &() |
uLang/SourceProject/SourceFileProject.h |