wizard::TextSourceCache Class Reference

#include <TextSourceCache.hpp>

Collaboration diagram for wizard::TextSourceCache:

Public Types
typedef std::map< std::string, TextSource *, wizard::UtilFileStringCompare >	SourceMap

Public Member Functions
	TextSourceCache (wizard::ProjectWorkspace *aWorkspacePtr)
	~TextSourceCache ()
TextSource *	GetSource (const UtPath &aPath, bool aRead=true)
TextSource *	FindSource (const UtPath &aPath, bool aRead=true)
TextSource *	FindSource (const std::string &aPath, bool aRead=true)
TextSource *	FindSource (UtTextDocument *aParseSourcePtr)
const SourceMap &	GetSources () const
void	DeleteSource (TextSource *aSourcePtr)
void	Clear ()

Public Attributes
std::set< TextSource * >	mNewSources

Protected Attributes
wizard::ProjectWorkspace *	mWorkspacePtr
SourceMap	mSources

Detailed Description

The source cache provides in-memory access to all files referenced in the project. This improves speed, and allows us to react to changes without saving to the file.

Member Typedef Documentation

SourceMap

typedef std::map<std::string, TextSource*, wizard::UtilFileStringCompare> wizard::TextSourceCache::SourceMap

Constructor & Destructor Documentation

TextSourceCache()

wizard::TextSourceCache::TextSourceCache ( wizard::ProjectWorkspace * aWorkspacePtr )

explicit

References mWorkspacePtr.

~TextSourceCache()

wizard::TextSourceCache::~TextSourceCache

(

)

References Clear().

Member Function Documentation

Clear()

void wizard::TextSourceCache::Clear

(

)

References GetSources(), mNewSources, and mSources.

Referenced by ~TextSourceCache().

DeleteSource()

void wizard::TextSourceCache::DeleteSource

(

TextSource *

aSourcePtr

)

References wizard::TextSource::GetSystemPath(), mNewSources, and mSources.

FindSource() [1/3]

wizard::TextSource * wizard::TextSourceCache::FindSource	(	const std::string &	aPath,
		bool	aRead = true )

References wizard::TextSource::IsLoaded(), wizard::TextSource::Load(), and mSources.

FindSource() [2/3]

wizard::TextSource * wizard::TextSourceCache::FindSource	(	const UtPath &	aPath,
		bool	aRead = true )

References FindSource().

Referenced by FindSource(), GetSource(), and wizard::RenameFileDialog::OkClick().

FindSource() [3/3]

wizard::TextSource * wizard::TextSourceCache::FindSource

(

UtTextDocument *

aParseSourcePtr

)

GetSource()

wizard::TextSource * wizard::TextSourceCache::GetSource	(	const UtPath &	aPath,
		bool	aRead = true )

References wizard::TextSource::cINCLUDED, FindSource(), wizard::TextSource::GetFlags(), wizard::TextSource::IsLoaded(), wizard::TextSource::Load(), mNewSources, mSources, mWorkspacePtr, and wizard::TextSource::SetFlags().

GetSources()

const SourceMap & wizard::TextSourceCache::GetSources ( ) const

inline

References mSources.

Referenced by Clear(), wizard::FindResultsControl::NewFind(), wizard::PointOfInterestPropertiesWidget::PopulateFiles(), and wizard::RevisionStore::QueueAllProjectFiles().

Member Data Documentation

mNewSources

std::set<TextSource*> wizard::TextSourceCache::mNewSources

Referenced by Clear(), DeleteSource(), and GetSource().

mSources

SourceMap wizard::TextSourceCache::mSources

protected

Referenced by Clear(), DeleteSource(), FindSource(), GetSource(), and GetSources().

mWorkspacePtr

wizard::ProjectWorkspace* wizard::TextSourceCache::mWorkspacePtr

protected

Referenced by GetSource(), and TextSourceCache().

---

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

• TextSourceCache.hpp
• TextSourceCache.cpp