ProjectUtils Namespace Reference

Defines convenience function for project manager and document. More...

Functions
QString	autosaveDir (const QString &projectFileName)
	Returns name of autosave directory for project with given project file name. More...
QString	autosaveName (const QString &projectFileName)
	Returns name of project for autoSave from given project file name. More...
QString	autosaveSubdir ()
	Returns fixed name for autosave sub-directory. More...
bool	exists (const QString &fileName)
	Returns true if file exists. More...
bool	hasAutosavedData (const QString &projectFileName)
	Returns true if project with given projectFileName contains autosaved data. More...
QString	lastModified (const QString &fileName)
	Returns a string representing modification time of given file. More...
QStringList	nonXMLDataInDir (const QString &dirname)
	Returns list of files on disk representing nonXML data. More...
QString	projectDir (const QString &projectFileName)
	Returns project directory deduced from project file name. More...
QString	projectName (const QString &projectFileName)
	Returns project name deduced from project file name. More...
QString	readTextFile (const QString &fileName)
	Returns multi-lione string representing content of text file. More...
bool	removeFile (const QString &dirname, const QString &filename)
	Remove file from given directory. More...
bool	removeFiles (const QString &dirname, const QStringList &filenames)
bool	removeRecursively (const QString &dirname)
	Removes recursively directory with given name. More...
QStringList	substract (const QStringList &lhs, const QStringList &rhs)
	Returns list of string from lhs, which are not in rhs. More...
QString	userExportDir ()
	Returns directory which user is normally using to export files. More...

Detailed Description

Defines convenience function for project manager and document.

Function Documentation

autosaveDir()

QString ProjectUtils::autosaveDir

(

const QString &

projectFileName

)

Returns name of autosave directory for project with given project file name.

From '/projects/Untitled2/Untitled2.pro' returns '/projects/Untitled2/autosave'.

Definition at line 45 of file ProjectUtils.cpp.

{
    return ProjectUtils::projectDir(projectFileName) + "/" + autosaveSubdir();
}

References autosaveSubdir(), and projectDir().

Referenced by AutosaveController::autosaveDir(), and autosaveName().

Here is the call graph for this function:

autosaveName()

QString ProjectUtils::autosaveName

(

const QString &

projectFileName

)

Returns name of project for autoSave from given project file name.

From '/projects/Untitled2/Untitled2.pro' returns '/projects/Untitled2/autosave/Untitled2.pro'.

Definition at line 52 of file ProjectUtils.cpp.

{
    return ProjectUtils::autosaveDir(projectFileName) + "/"
           + ProjectUtils::projectName(projectFileName) + ProjectDocument::projectFileExtension();
}

References autosaveDir(), ProjectDocument::projectFileExtension(), and projectName().

Referenced by AutosaveController::autosaveName(), hasAutosavedData(), ProjectManager::loadProject(), and ProjectManager::restoreProjectDialog().

Here is the call graph for this function:

autosaveSubdir()

QString ProjectUtils::autosaveSubdir

(

)

Returns fixed name for autosave sub-directory.

Definition at line 38 of file ProjectUtils.cpp.

{
    return "autosave";
}

Referenced by AutosaveController::assureAutoSaveDirExists(), autosaveDir(), and SaveService::process_queue().

exists()

bool ProjectUtils::exists

(

const QString &

fileName

)

Returns true if file exists.

Definition at line 58 of file ProjectUtils.cpp.

{
    QFileInfo info(fileName);
    return info.exists();
}

Referenced by NewProjectDialog::checkIfProjectPathIsValid(), ModelView::Utils::exists(), FileSystemUtils::filesInDirectory(), hasAutosavedData(), and FileSystemUtils::IsFileExists().

hasAutosavedData()

bool ProjectUtils::hasAutosavedData

(

const QString &

projectFileName

)

Returns true if project with given projectFileName contains autosaved data.

Definition at line 64 of file ProjectUtils.cpp.

{
    return exists(projectFileName) && exists(autosaveName(projectFileName));
}

References autosaveName(), and exists().

Referenced by ProjectManager::loadProject().

Here is the call graph for this function:

lastModified()

QString ProjectUtils::lastModified

(

const QString &

fileName

)

Returns a string representing modification time of given file.

Definition at line 69 of file ProjectUtils.cpp.

{
    QFileInfo info(fileName);
    return info.lastModified().toString("hh:mm:ss, MMMM d, yyyy");
}

Referenced by ProjectManager::restoreProjectDialog().

nonXMLDataInDir()

QStringList ProjectUtils::nonXMLDataInDir

(

const QString &

dirname

)

Returns list of files on disk representing nonXML data.

Definition at line 75 of file ProjectUtils.cpp.

{
    QDir dir(dirname);
 
    if (!dir.exists())
        throw GUIHelpers::Error("ProjectUtils::nonXMLDataInDir() -> Error. Non existing "
                                "directory '"
                                + dirname + "'.");
 
    return dir.entryList(ItemFileNameUtils::nonXMLFileNameFilters());
}

References ItemFileNameUtils::nonXMLFileNameFilters().

Here is the call graph for this function:

projectDir()

QString ProjectUtils::projectDir

(

const QString &

projectFileName

)

Returns project directory deduced from project file name.

Definition at line 32 of file ProjectUtils.cpp.

{
    QFileInfo info(projectFileName);
    return info.path();
}

Referenced by AutosaveController::assureAutoSaveDirExists(), autosaveDir(), NewProjectDialog::checkIfProjectNameIsValid(), OutputDataIOService::cleanOldFiles(), SaveLoadInterface::fileName(), NewProjectDialog::getProjectFileName(), DataItem::load(), PointwiseAxisItem::load(), OutputDataIOService::load(), OutputDataIOService::save(), DataItem::save(), PointwiseAxisItem::save(), ProjectDocument::save_project_data(), and ProjectDocument::setProjectFileName().

projectName()

QString ProjectUtils::projectName

(

const QString &

projectFileName

)

Returns project name deduced from project file name.

Definition at line 26 of file ProjectUtils.cpp.

{
    QFileInfo info(projectFileName);
    return info.baseName();
}

Referenced by NewProjectDialog::NewProjectDialog(), autosaveName(), NewProjectDialog::checkIfProjectNameIsValid(), ProjectManager::restoreProjectDialog(), and ProjectDocument::setProjectFileName().

readTextFile()

QString ProjectUtils::readTextFile

(

const QString &

fileName

)

Returns multi-lione string representing content of text file.

Definition at line 135 of file ProjectUtils.cpp.

{
    QFile file(fileName);
    if (!file.open(QIODevice::ReadOnly | QIODevice::Text))
        throw GUIHelpers::Error("ProjectUtils::readTextFile -> Error. Can't open the file '"
                                + fileName + "' for reading.");
    QTextStream in(&file);
    return in.readAll();
}

Referenced by PyImportAssistant::readFile().

removeFile()

bool ProjectUtils::removeFile	(	const QString &	dirname,
		const QString &	filename
	)

Remove file from given directory.

Definition at line 99 of file ProjectUtils.cpp.

{
    QString name = dirname + "/" + filename;
    QFile fin(name);
 
    if (!fin.exists())
        throw GUIHelpers::Error("ProjectUtils::removeFile() -> Error. Non existing "
                                "file '"
                                + name + "'.");
 
    return fin.remove();
}

References FileSystemUtils::filename(), and RealSpace::Particles::name().

Referenced by removeFiles().

Here is the call graph for this function:

removeFiles()

bool ProjectUtils::removeFiles	(	const QString &	dirname,
		const QStringList &	filenames
	)

Definition at line 112 of file ProjectUtils.cpp.

{
    bool success(true);
 
    for (auto& name : filenames)
        success &= removeFile(dirname, name);
 
    return success;
}

References RealSpace::Particles::name(), and removeFile().

Referenced by OutputDataIOService::cleanOldFiles().

Here is the call graph for this function:

removeRecursively()

bool ProjectUtils::removeRecursively

(

const QString &

dirname

)

Removes recursively directory with given name.

Directory name is relative to the parent (working directory of the executable).

Definition at line 87 of file ProjectUtils.cpp.

{
    QDir dir(dirname);
 
    if (!dir.exists())
        throw GUIHelpers::Error("ProjectUtils::removeRecursively() -> Error. Non existing "
                                "directory '"
                                + dirname + "'.");
 
    return dir.removeRecursively();
}

substract()

QStringList ProjectUtils::substract	(	const QStringList &	lhs,
		const QStringList &	rhs
	)

Returns list of string from lhs, which are not in rhs.

Definition at line 122 of file ProjectUtils.cpp.

{
#if QT_VERSION >= QT_VERSION_CHECK(5, 14, 0)
    auto lhs_set = QSet<QString>{lhs.begin(), lhs.end()};
    auto rhs_set = QSet<QString>{rhs.begin(), rhs.end()};
    QSet<QString> diff = lhs_set.subtract(rhs_set);
    return diff.values();
#else
    QSet<QString> diff = lhs.toSet().subtract(rhs.toSet());
    return diff.toList();
#endif
}

Referenced by OutputDataIOService::cleanOldFiles().

userExportDir()

QString ProjectUtils::userExportDir

(

)

Returns directory which user is normally using to export files.

Definition at line 145 of file ProjectUtils.cpp.

{
    return AppSvc::projectManager()->userExportDir();
}

References AppSvc::projectManager(), and ProjectManager::userExportDir().

Referenced by SaveProjectionsAssistant::saveProjections().

Here is the call graph for this function: