uLang::CSourceProjectWriter Class Reference

#include <SourceProjectWriter.h>

Public Types
enum class	EWriteFlags { All , UserSources }

Public Member Functions
	CSourceProjectWriter (const TSRef< IFileSystem > &FileSystem, const TSRef< CDiagnostics > &Diagnostics)
VERSECOMPILER_API bool	WriteProject (const CSourceProject &Project, const CUTF8String &DestinationDir, CUTF8String *ResultProjectFilePath=nullptr, const EWriteFlags WriteFlags=EWriteFlags::All) const
VERSECOMPILER_API bool	WriteProjectFile (const SProjectDesc &ProjectDesc, const CUTF8String &ProjectFilePath) const
VERSECOMPILER_API bool	WriteVSCodeWorkspaceFile (const SWorkspaceDesc &WorkspaceDesc, const CUTF8String &WorkspaceFilePath) const

Static Public Member Functions
static VERSECOMPILER_API SProjectDesc	GetProjectDesc (const CSourceProject &Project)
static VERSECOMPILER_API SWorkspaceDesc	GetWorkspaceDesc (const CSourceProject &Project, const CUTF8String &ProjectFilePath)

Detailed Description

Helper class to write a source project to disk This can either be a copy from one location to another, or save an in-memory project to the file system

Member Enumeration Documentation

EWriteFlags

enum class uLang::CSourceProjectWriter::EWriteFlags

strong

Enumerator
All
UserSources

Constructor & Destructor Documentation

CSourceProjectWriter()

uLang::CSourceProjectWriter::CSourceProjectWriter ( const TSRef< IFileSystem > &  FileSystem, const TSRef< CDiagnostics > &  Diagnostics  )

inline

Member Function Documentation

GetProjectDesc()

SProjectDesc uLang::CSourceProjectWriter::GetProjectDesc ( const CSourceProject &  Project )

static

Derive a project desc from a source project

GetWorkspaceDesc()

SWorkspaceDesc uLang::CSourceProjectWriter::GetWorkspaceDesc ( const CSourceProject &  Project, const CUTF8String &  ProjectFilePath  )

static

Derive a workspace desc from a source project

WriteProject()

bool uLang::CSourceProjectWriter::WriteProject	(	const CSourceProject &	Project,
		const CUTF8String &	DestinationDir,
		CUTF8String *	ResultProjectFilePath = nullptr,
		const EWriteFlags	WriteFlags = EWriteFlags::All
	)		const

Write the entire given source project to disk If ResultProjectFilePath is given, a vproject file will be generated and the path to it returned

WriteProjectFile()

bool uLang::CSourceProjectWriter::WriteProjectFile	(	const SProjectDesc &	ProjectDesc,
		const CUTF8String &	ProjectFilePath
	)		const

Write only a vproject file to the given file path

WriteVSCodeWorkspaceFile()

bool uLang::CSourceProjectWriter::WriteVSCodeWorkspaceFile	(	const SWorkspaceDesc &	WorkspaceDesc,
		const CUTF8String &	WorkspaceFilePath
	)		const

Write a .code-workspace file to the given file path

---

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

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