#include <TextSource.hpp>

Inherits UtTextDocument.

Public Types
enum	Flags { cINCLUDED = 1 , cCRITICAL = 2 , cCRITICAL_MASK = cCRITICAL \| cINCLUDED }

Public Member Functions
	TextSource (ProjectWorkspace *aProjectManagerPtr, const UtPath &aSourcePath)
virtual	~TextSource ()
void	AddedToWorkspace ()
bool	Load ()
	Load the file into memory if it has not been loaded.
UtTextDocument *	GetSource ()
bool	IsDeleted () const
void	SetDeleted (bool aIsDeleted)
bool	CheckForFileModifications (bool aAlwaysFullyReload)
void	HandleInsert (int aPosition, int aLength, const char *aText)
void	HandleDelete (int aPosition, int aLength)
TextSourceView *	NewView (Project *aProjectPtr)
TextSourceView *	GetView (Project *aParentPtr)
const std::vector< TextSourceView * > &	GetViews () const
void	EditorClosed (Editor *aEditorPtr)
void *	GetQtDocument () const
QTextDocument *	GetDocumentAsQTextDocument () const
void	ProjectParseUpdated ()
bool	Save ()
void	SaveWithNotifications ()
void	SaveAs ()
std::string	GetFileName ()
std::string	GetSystemPath () const
void	Replace (const UtTextRange &aReplaceRange, const std::string &aText)
void	Append (const std::string &aText)
const std::vector< TextSourceChange > &	GetPendingChanges () const
bool	IsModified () const
void	SavePointReached ()
bool	ReadSource (bool aAlwaysFullyReload=false)
ProjectWorkspace *	GetWorkspace () const
Project *	GetProject ()
void	WaitForSourceModifications ()
int	GetFlags () const
void	SetFlags (int aFlags)
bool	IsCritical () const
bool	IsLoaded () const
void	Unload ()
	Unload the file from memory if possible.
void	ApplyModifications (UtTextRange &aRange, long long aStartSequenceNumber) const
size_t	ApplyModifications (size_t aPos, long long aStartSequenceNumber) const
void	ApplyPendingModifications (UtTextRange &aRange, UtTextDocument &aDocument) const
bool	HasAppliedChanges (long long aSequenceNumber) const
bool	HasPendingChanges () const
FileSignature	FileSignatureAtLoad () const
void	ReloadViews ()
void	FindIncludeLocations ()
void	BrowseContainingFolder ()
void	CopyPathToClipboard ()

Static Public Member Functions
static long long	GetNextSequenceNumber ()
static void	SetObsoleteSequenceNumber (long long aNumber)
static void	DiffDocuments (const char aOld, const char aNew, QVector< TextSourceChange > &aChanges)
	Compute differences between two null-terminated text strings.

Public Attributes
UtCallbackListN< void(TextSource &)>	FileModifiedChange
	Executes when file's modification state has changed.

Static Public Attributes
static UtCallbackListN< void(TextSource *, size_t, int)>	TextSourceCharDeleted

Friends
class	wizard::Project
class	wizard::ProjectWorkspace

Detailed Description

TextSource is a file referenced by the project. The file may or may not be loaded into memory. Because of multi-threaded parsing, this class maintains a separate copy of the text when loaded in the text editor. Changes made to the document are queued and only applied when the parser has stopped. While TextSource inherits from UtTextDocument, using mutators from UtTextDocument directly is not advised.

Member Enumeration Documentation

◆ Flags

enum wizard::TextSource::Flags

Enumerator
cINCLUDED
cCRITICAL
cCRITICAL_MASK

Constructor & Destructor Documentation

◆ TextSource()

wizard::TextSource::TextSource	(	ProjectWorkspace *	aProjectManagerPtr,
		const UtPath &	aSourcePath )

References wizard::ProjectWorkspace.

Referenced by wizard::ProjectWorkspace.

◆ ~TextSource()

wizard::TextSource::~TextSource ( )

virtual

References Unload(), and wizSignals.

Member Function Documentation

◆ AddedToWorkspace()

void wizard::TextSource::AddedToWorkspace ( )

Referenced by wizard::ProjectWorkspace.

◆ Append()

void wizard::TextSource::Append ( const std::string & aText )

Referenced by wizard::CreatePlatformDialog::CreatePlatform().

◆ ApplyModifications() [1/2]

size_t wizard::TextSource::ApplyModifications	(	size_t	aPos,
		long long	aStartSequenceNumber ) const

References wizard::TextSourceChange::ApplyChangeToPos().

◆ ApplyModifications() [2/2]

void wizard::TextSource::ApplyModifications	(	UtTextRange &	aRange,
		long long	aStartSequenceNumber ) const

References wizard::TextSourceChange::ApplyChangeToRange().

◆ ApplyPendingModifications()

void wizard::TextSource::ApplyPendingModifications	(	UtTextRange &	aRange,
		UtTextDocument &	aDocument ) const

◆ BrowseContainingFolder()

void wizard::TextSource::BrowseContainingFolder ( )

Referenced by wizard::ActionManager::BuildUpTextSourceContextMenu(), and wizard::ActionManager::BuildUpTitleBarMenu().

◆ CheckForFileModifications()

bool wizard::TextSource::CheckForFileModifications ( bool aAlwaysFullyReload )

References wizard::FileSignature::cFILE_NOT_FOUND, wizard::FileSignature::cTIME_CHANGE, and ReadSource().

◆ CopyPathToClipboard()

void wizard::TextSource::CopyPathToClipboard ( )

References GetSystemPath().

Referenced by wizard::ActionManager::BuildUpTextSourceContextMenu(), and wizard::ActionManager::BuildUpTitleBarMenu().

◆ DiffDocuments()

void wizard::TextSource::DiffDocuments	(	const char *	aOld,
		const char *	aNew,
		QVector< TextSourceChange > &	aChanges )

static

Compute differences between two null-terminated text strings.

References wizard::TextSourceChange::mCharsRemoved, wizard::TextSourceChange::mPos, and wizard::TextSourceChange::mText.

◆ EditorClosed()

void wizard::TextSource::EditorClosed ( Editor * aEditorPtr )

References GetWorkspace(), and Unload().

◆ FileSignatureAtLoad()

FileSignature wizard::TextSource::FileSignatureAtLoad ( ) const

inline

◆ FindIncludeLocations()

void wizard::TextSource::FindIncludeLocations ( )

References GetProject().

Referenced by wizard::ActionManager::BuildUpTextSourceContextMenu(), and wizard::ActionManager::BuildUpTitleBarMenu().

◆ GetDocumentAsQTextDocument()

QTextDocument * wizard::TextSource::GetDocumentAsQTextDocument ( ) const

inline

◆ GetFileName()

std::string wizard::TextSource::GetFileName ( )

Referenced by SaveAs().

◆ GetFlags()

int wizard::TextSource::GetFlags ( ) const

inline

Referenced by wizard::TextSourceCache::GetSource(), and wizard::RevisionStore::QueueAllProjectFiles().

◆ GetNextSequenceNumber()

long long wizard::TextSource::GetNextSequenceNumber ( )

inlinestatic

Referenced by wizard::ParseWorker::Start().

◆ GetPendingChanges()

const std::vector< TextSourceChange > & wizard::TextSource::GetPendingChanges ( ) const

inline

◆ GetProject()

wizard::Project * wizard::TextSource::GetProject ( )

Referenced by FindIncludeLocations(), ProjectParseUpdated(), and ReadSource().

◆ GetQtDocument()

void * wizard::TextSource::GetQtDocument ( ) const

inline

◆ GetSource()

UtTextDocument * wizard::TextSource::GetSource ( )

Referenced by wizard::EditorManager::CloseAllButIncluded(), wizard::EditorManager::CloseAllButStartup(), wizard::InputContext::ContextFromCursor(), wizard::ParseResults::FindIncludes(), wizard::CacheSourceProvider::FindSource(), wizard::ProjectWorkspace::FindSource(), wizard::WsfStyler::FoldDocument(), wizard::InputContext::GetContext(), wizard::InputContext::GetInputContext(), wizard::EditAssist::MakeAssistant(), wizard::EditorDock::ModificationChanged(), wizard::FindResultsControl::SearchFile(), wizard::WsfStyler::UpdateStyle(), wizard::SyntaxTips::UpdateSuggestions(), and wizard::ProjectWorkspace.

◆ GetSystemPath()

std::string wizard::TextSource::GetSystemPath ( ) const

inline

Referenced by wizard::EditorManager::AcceptsClose(), wizard::ActionManager::BuildUpTextSourceContextMenu(), wizard::EditorManager::CloseEditor(), CopyPathToClipboard(), wizard::TextSourceCache::DeleteSource(), wizard::Editor::Editor(), wizard::Environment::MarginClickAction(), NewView(), and Save().

◆ GetView()

wizard::TextSourceView * wizard::TextSource::GetView ( Project * aParentPtr )

References NewView(), and wizard::Project.

Referenced by wizard::ProjectWorkspace::GotoFile(), wizard::Project::GotoRange(), and wizard::ProjectWorkspace::OpenSource().

◆ GetViews()

const std::vector< TextSourceView * > & wizard::TextSource::GetViews ( ) const

inline

Referenced by wizard::CreatePlatformDialog::CreatePlatform(), and wizard::ProjectWorkspace::OpenSource().

◆ GetWorkspace()

ProjectWorkspace * wizard::TextSource::GetWorkspace ( ) const

inline

References wizard::ProjectWorkspace.

Referenced by EditorClosed(), NewView(), and ReadSource().

◆ HandleDelete()

void wizard::TextSource::HandleDelete	(	int	aPosition,
		int	aLength )

Safely deletes text from the document. Text changes must be reconciled by ProjectWorkspace at the appropriate time, therefore, the document will not be updated immediately.

◆ HandleInsert()

void wizard::TextSource::HandleInsert	(	int	aPosition,
		int	aLength,
		const char *	aText )

Safely inserts text into the document. Text changes must be reconciled by ProjectWorkspace at the appropriate time, therefore, the document will not be updated immediately.

◆ HasAppliedChanges()

bool wizard::TextSource::HasAppliedChanges ( long long aSequenceNumber ) const

◆ HasPendingChanges()

bool wizard::TextSource::HasPendingChanges ( ) const

inline

◆ IsCritical()

bool wizard::TextSource::IsCritical ( ) const

inline

References cCRITICAL_MASK.

◆ IsDeleted()

bool wizard::TextSource::IsDeleted ( ) const

inline

Referenced by wizard::CacheSourceProvider::FindSource().

◆ IsLoaded()

bool wizard::TextSource::IsLoaded ( ) const

inline

Referenced by wizard::ProjectWorkspace::BeginSerialize(), wizard::TextSourceCache::FindSource(), and wizard::TextSourceCache::GetSource().

◆ IsModified()

bool wizard::TextSource::IsModified ( ) const

inline

Referenced by wizard::ActionManager::BuildUpTextSourceContextMenu(), and wizard::EditorDock::ModificationChanged().

◆ Load()

bool wizard::TextSource::Load ( )

Load the file into memory if it has not been loaded.

References ReadSource().

Referenced by wizard::TextSourceCache::FindSource(), and wizard::TextSourceCache::GetSource().

◆ NewView()

wizard::TextSourceView * wizard::TextSource::NewView ( Project * aProjectPtr )

References wizard::Editor::GetOffset(), GetSystemPath(), GetWorkspace(), wizard::WsfEditor::Initialize(), wizard::ProjectWorkspace::Instance(), Load(), pos, wizard::Editor::SetSelection(), and wizard::Project.

Referenced by wizard::CreatePlatformDialog::CreatePlatform(), GetView(), and wizard::ProjectWorkspace::OpenSource().

◆ ProjectParseUpdated()

void wizard::TextSource::ProjectParseUpdated ( )

References GetProject(), and wizard::Project.

◆ ReadSource()

bool wizard::TextSource::ReadSource ( bool aAlwaysFullyReload = false )

References cMAXIMUM_FILE_SIZE, GetProject(), GetWorkspace(), SetDeleted(), and Unload().

Referenced by CheckForFileModifications(), wizard::CacheSourceProvider::FindSource(), and Load().

◆ ReloadViews()

void wizard::TextSource::ReloadViews ( )

Referenced by wizard::ProjectWorkspace::customEvent(), wizard::WsfEditor::FormatSelection(), and wizard::ProjectParseThread::SetTask().

◆ Replace()

void wizard::TextSource::Replace	(	const UtTextRange &	aReplaceRange,
		const std::string &	aText )

Referenced by wizard::RenameFileDialog::OkClick().

◆ Save()

bool wizard::TextSource::Save ( )

References GetSystemPath().

Referenced by wizard::ActionManager::BuildUpTextSourceContextMenu(), and wizard::ActionManager::BuildUpTitleBarMenu().

◆ SaveAs()

void wizard::TextSource::SaveAs ( )

References GetFileName(), wizard::TextSourceSignals::GetInstance(), wizard::TextSourceSignals::requestBackup(), and WaitForSourceModifications().

Referenced by wizard::ActionManager::BuildUpTextSourceContextMenu(), and wizard::ActionManager::BuildUpTitleBarMenu().

◆ SavePointReached()

void wizard::TextSource::SavePointReached ( )

◆ SaveWithNotifications()

void wizard::TextSource::SaveWithNotifications ( )

References Save(), and SaveWithNotifications().

Referenced by SaveWithNotifications().

◆ SetDeleted()

void wizard::TextSource::SetDeleted ( bool aIsDeleted )

Referenced by ReadSource().

◆ SetFlags()

void wizard::TextSource::SetFlags ( int aFlags )

inline

Referenced by wizard::TextSourceCache::GetSource().

◆ SetObsoleteSequenceNumber()

void wizard::TextSource::SetObsoleteSequenceNumber ( long long aNumber )

inlinestatic

Referenced by wizard::ProjectWorkspace::customEvent().

◆ Unload()

void wizard::TextSource::Unload ( )

Unload the file from memory if possible.

References cCRITICAL_MASK.

Referenced by EditorClosed(), ReadSource(), and ~TextSource().

◆ WaitForSourceModifications()

void wizard::TextSource::WaitForSourceModifications ( )

Referenced by SaveAs().

◆ wizard::Project

friend class wizard::Project

friend

Referenced by GetView(), NewView(), and ProjectParseUpdated().

◆ wizard::ProjectWorkspace

friend class wizard::ProjectWorkspace

friend

References AddedToWorkspace(), GetSource(), TextSource(), and wizard::ProjectWorkspace.

Referenced by GetWorkspace(), TextSource(), and wizard::ProjectWorkspace.

Member Data Documentation

◆ FileModifiedChange

UtCallbackListN<void(TextSource&)> wizard::TextSource::FileModifiedChange

Executes when file's modification state has changed.

◆ TextSourceCharDeleted

UtCallbackListN< void(wizard::TextSource *, size_t, int)> wizard::TextSource::TextSourceCharDeleted

static

Callback invoked when the given TextSource has characters removed

Template Parameters

void(TextSource*,size_t,int) is the function signature. The first parameter is the given text source that changed. The second parameter is the position where the text changed. The third parameter is the amount of characters removed from the text.

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

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ Flags

Constructor & Destructor Documentation

◆ TextSource()

◆ ~TextSource()

Member Function Documentation

◆ AddedToWorkspace()

◆ Append()

◆ ApplyModifications() [1/2]

◆ ApplyModifications() [2/2]

◆ ApplyPendingModifications()

◆ BrowseContainingFolder()

◆ CheckForFileModifications()

◆ CopyPathToClipboard()

◆ DiffDocuments()

◆ EditorClosed()

◆ FileSignatureAtLoad()

◆ FindIncludeLocations()

◆ GetDocumentAsQTextDocument()

◆ GetFileName()

◆ GetFlags()

◆ GetNextSequenceNumber()

◆ GetPendingChanges()

◆ GetProject()

◆ GetQtDocument()

◆ GetSource()

◆ GetSystemPath()

◆ GetView()

◆ GetViews()

◆ GetWorkspace()

◆ HandleDelete()

◆ HandleInsert()

◆ HasAppliedChanges()

◆ HasPendingChanges()

◆ IsCritical()

◆ IsDeleted()

◆ IsLoaded()

◆ IsModified()

◆ Load()

◆ NewView()

◆ ProjectParseUpdated()

◆ ReadSource()

◆ ReloadViews()

◆ Replace()

◆ Save()

◆ SaveAs()

◆ SavePointReached()

◆ SaveWithNotifications()

◆ SetDeleted()

◆ SetFlags()

◆ SetObsoleteSequenceNumber()

◆ Unload()

◆ WaitForSourceModifications()

Friends And Related Symbol Documentation

◆ wizard::Project

◆ wizard::ProjectWorkspace

Member Data Documentation

◆ FileModifiedChange

◆ TextSourceCharDeleted