#include <RunManager.hpp>

Collaboration diagram for wizard::RunManager:

Public Member Functions
const QList< QStringList > &	GetRecentScenarios () const
void	RemoveRecentScenario (const QStringList &aFileList)
void	ClearRecentScenarios ()
QString	GetMostRecentDirectory ()
bool	ReloadScenario ()
bool	LoadScenario (const QStringList &aFileList)
void	Shutdown ()
const QList< QStringList > &	GetRecents ()

Static Public Member Functions
static RunManager &	GetInstance ()
static void	Create ()
static QString	GetScenarioDisplayName (const QStringList &aFileList, bool aDisplayFullPath)

Current project path routines
int	mMaxRecentScenarios
QList< QStringList >	mRecentScenarios
QStringList	mFileList
QString	mCurrentProjectPath
	the working directory for the current project
const QString	mApplicationPath
	the working directory for the application
static RunManager *	mInstancePtr = nullptr
QString	GetCurrentProjectPath () const noexcept
	Get the current project's path.
bool	SetWorkingDirectoryToProject (const QString &aMainScenarioFile) noexcept
bool	SetWorkingDirectoryToProject (const std::string &aMainScenarioFile) noexcept
	Overload of SetCurrentProjectDirectory for std::string.
bool	SetWorkingDirectoryToProject (const UtPath &aMainScenarioFile) noexcept
	Overload of SetCurrentProjectDirectory for UtPath.
bool	IsWorkingDirectoryProject () const noexcept
	RunManager ()
virtual	~RunManager ()
void	ReadSettings ()
void	WriteHistory ()
void	SetMostRecentScenario (const QStringList &aFileList)
static QStringList	StandardizeFilePaths (const QStringList &aFileList, bool *aFilesExist=nullptr)

Application path routines
QString	GetApplicationPath () const noexcept
bool	SetWorkingDirectoryToApplication () noexcept
bool	IsWorkingDirectoryApplication () const noexcept

Constructor & Destructor Documentation

◆ RunManager()

wizard::RunManager::RunManager ( )

protected

References mApplicationPath, mFileList, mInstancePtr, mMaxRecentScenarios, and ReadSettings().

Referenced by Create().

◆ ~RunManager()

wizard::RunManager::~RunManager ( )

protectedvirtual

References mInstancePtr.

Member Function Documentation

◆ ClearRecentScenarios()

void wizard::RunManager::ClearRecentScenarios ( )

References mRecentScenarios, wizEnv, and WriteHistory().

◆ Create()

void wizard::RunManager::Create ( )

static

References mInstancePtr, and RunManager().

Referenced by wizard::Runner::run().

◆ GetApplicationPath()

QString wizard::RunManager::GetApplicationPath ( ) const

noexcept

Get the application path

Returns: the application path

References mApplicationPath.

◆ GetCurrentProjectPath()

QString wizard::RunManager::GetCurrentProjectPath ( ) const

noexcept

Get the current project's path.

References mCurrentProjectPath.

◆ GetInstance()

wizard::RunManager & wizard::RunManager::GetInstance ( )

static

References mInstancePtr.

◆ GetMostRecentDirectory()

QString wizard::RunManager::GetMostRecentDirectory ( )

References mRecentScenarios.

◆ GetRecents()

const QList< QStringList > & wizard::RunManager::GetRecents ( )

inline

References mRecentScenarios.

◆ GetRecentScenarios()

const QList< QStringList > & wizard::RunManager::GetRecentScenarios ( ) const

inline

References mRecentScenarios.

◆ GetScenarioDisplayName()

QString wizard::RunManager::GetScenarioDisplayName	(	const QStringList &	aFileList,
		bool	aDisplayFullPath )

static

Note: For window title and recent menu actions/links

Referenced by LoadScenario().

◆ IsWorkingDirectoryApplication()

bool wizard::RunManager::IsWorkingDirectoryApplication ( ) const

noexcept

Determine whether or not the application path is set as the working directory

Returns: whether or not the application path is set as the working directory

References mApplicationPath.

Referenced by SetWorkingDirectoryToApplication().

◆ IsWorkingDirectoryProject()

bool wizard::RunManager::IsWorkingDirectoryProject ( ) const

noexcept

Determine whether or not the current project's path is set as the working directory

Returns: whether or not the current project's path is set as the working directory

References mCurrentProjectPath.

◆ LoadScenario()

bool wizard::RunManager::LoadScenario ( const QStringList & aFileList )

References GetScenarioDisplayName(), mCurrentProjectPath, mFileList, SetMostRecentScenario(), SetWorkingDirectoryToProject(), and wizEnv.

Referenced by ReloadScenario().

◆ ReadSettings()

void wizard::RunManager::ReadSettings ( )

protected

References mMaxRecentScenarios, mRecentScenarios, and settings().

Referenced by RunManager().

◆ ReloadScenario()

bool wizard::RunManager::ReloadScenario ( )

References LoadScenario(), and mFileList.

◆ RemoveRecentScenario()

void wizard::RunManager::RemoveRecentScenario ( const QStringList & aFileList )

References mRecentScenarios, StandardizeFilePaths(), and WriteHistory().

Referenced by SetMostRecentScenario().

◆ SetMostRecentScenario()

void wizard::RunManager::SetMostRecentScenario ( const QStringList & aFileList )

protected

References mMaxRecentScenarios, mRecentScenarios, RemoveRecentScenario(), StandardizeFilePaths(), and WriteHistory().

Referenced by LoadScenario().

◆ SetWorkingDirectoryToApplication()

bool wizard::RunManager::SetWorkingDirectoryToApplication ( )

noexcept

Sets the working directory to where the application is

Precondition: mApplicationPath contains the application path for Wizard

Returns: whether or not the write-protection was removed

References IsWorkingDirectoryApplication(), mApplicationPath, and mCurrentProjectPath.

◆ SetWorkingDirectoryToProject() [1/3]

bool wizard::RunManager::SetWorkingDirectoryToProject ( const QString & aMainScenarioFile )

noexcept

Sets the working directory to where the "soon-to-be-current" project is

Parameters

aMainScenarioFile is the "soon-to-be-current" project (or the start-up file for the project)

Postcondition: the application path for Wizard is stored in mApplicationPath

Returns: whether or not the write-protection was set

Note: another side-effect of QDir::setCurrent on Windows is that the working directory is write-protected (just the directory, not the files in the directory)