ProjectUtils.h

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      GUI/Support/IO/ProjectUtils.h
//! @brief     Defines namespace GUI::Project::Utils
//!
//! @homepage  http://www.bornagainproject.org
//! @license   GNU General Public License v3 or higher (see COPYING)
//! @copyright Forschungszentrum Jülich GmbH 2018
//! @authors   Scientific Computing Group at MLZ (see CITATION, AUTHORS)
//
//  ************************************************************************************************
 
#ifndef BORNAGAIN_GUI_SUPPORT_IO_PROJECTUTILS_H
#define BORNAGAIN_GUI_SUPPORT_IO_PROJECTUTILS_H
 
#include <QString>
 
//! Defines convenience function for project manager and document.
 
namespace GUI::Project::Utils {
 
inline constexpr const char* projectFileExtension{".pro"};
 
//! Returns project name deduced from project file name.
QString projectName(const QString& projectFileName);
 
//! Returns project directory deduced from project file name.
QString projectDir(const QString& projectFileName);
 
//! Returns fixed name for autosave sub-directory.
QString autosaveSubdir();
 
//! Returns name of autosave directory for project with given project file name.
//! E.g. from '/projects/Untitled2/Untitled2.pro' returns '/projects/Untitled2/autosave'
QString autosaveDir(const QString& projectFileName);
 
//! Returns name of project for autoSave from given project file name.
//! E.g. from '/projects/Untitled2/Untitled2.pro' returns
//! '/projects/Untitled2/autosave/Untitled2.pro'
QString autosaveName(const QString& projectFileName);
 
//! Returns true if project with given projectFileName contains autosaved data.
bool hasAutosavedData(const QString& projectFileName);
 
} // namespace GUI::Project::Utils
 
#endif // BORNAGAIN_GUI_SUPPORT_IO_PROJECTUTILS_H