Functions
QString	appDataFolder ()
	The folder where persistent application data shall be stored. Under Windows this is the AppData/Roaming location. Used e.g. for storing the instrument library. More...

QString	baseName (const QString &fileName)
	Returns base name of file. More...

QString	fileDir (const QString &fileName)
	Returns file directory from the full file path. More...

QString	getBornAgainVersionString ()

QString	getPathFromIndex (const QModelIndex &index)

QString	getValidFileName (const QString &proposed_name)
	Returns valid file name to be saved on disk. This name is constructed from proposed_name by replacing all special characters with text representation \ backslash / slash " quote < lessthan greaterthan \| pipe ? questionmark. More...

bool	isVersionMatchMinimal (const QString &version, const QString &minimal_version)
	Returns true if current BornAgain version match minimal required version. More...

bool	parseVersion (const QString &version, int &major_num, int &minor_num, int &patch_num)
	parses version string into 3 numbers, returns true in the case of success More...

int	versionCode (const QString &version)

QString	withTildeHomePath (const QString &path)

Function Documentation

◆ appDataFolder()

QString GUI::Util::Path::appDataFolder ( )

The folder where persistent application data shall be stored. Under Windows this is the AppData/Roaming location. Used e.g. for storing the instrument library.

Definition at line 139 of file Path.cpp.

 {
     return QStandardPaths::writableLocation(QStandardPaths::AppDataLocation);
 }

Referenced by main().

◆ baseName()

QString GUI::Util::Path::baseName ( const QString & fileName )

Returns base name of file.

Definition at line 133 of file Path.cpp.

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

Referenced by RealDataSelectorWidget::importData1D(), RealDataSelectorWidget::importData2D(), PyImportAssistant::importMultiLayer(), InstrumentCollection::suggestInstrumentName(), GUI::Util::String::suggestName(), and WelcomeView::updateRecentProjectPanel().

◆ fileDir()

QString GUI::Util::Path::fileDir ( const QString & fileName )

Returns file directory from the full file path.

Definition at line 123 of file Path.cpp.

 {
     QFileInfo info(fileName);
     if (info.exists())
         return info.dir().path();
     return "";
 }

◆ getBornAgainVersionString()

QString GUI::Util::Path::getBornAgainVersionString ( )

Definition at line 60 of file Path.cpp.

 {
     return QString::fromStdString(BornAgain::GetVersionNumber());
 }

Referenced by AboutDialog::createTextLayout(), ProjectDocument::documentVersion(), ProjectLoadProblemDialog::explanationText(), main(), ApplicationOptions::processOptions(), and ProjectDocument::writeTo().

◆ getPathFromIndex()

QString GUI::Util::Path::getPathFromIndex ( const QModelIndex & index )

Definition at line 144 of file Path.cpp.

 {
     if (!index.isValid())
         return "";
  
     QStringList namePath;
     QModelIndex cur = index;
     while (cur.isValid()) {
         namePath << cur.data().toString();
         cur = cur.parent();
     }
     std::reverse(namePath.begin(), namePath.end());
     return namePath.join("/");
 }

Referenced by ParameterItem::linkToSessionItem(), and DataProperties::setDataItem().

◆ getValidFileName()

QString GUI::Util::Path::getValidFileName ( const QString & proposed_name )

Returns valid file name to be saved on disk. This name is constructed from proposed_name by replacing all special characters with text representation \ backslash / slash " quote < lessthan

greaterthan

| pipe ? questionmark.

Definition at line 74 of file Path.cpp.

 {
     QString result = proposed_name;
     for (auto it = invalidCharacterMap.begin(); it != invalidCharacterMap.end(); ++it)
         result.replace(it.key(), it.value());
     return result;
 }

◆ isVersionMatchMinimal()

bool GUI::Util::Path::isVersionMatchMinimal	(	const QString &	version,
		const QString &	minimal_version
	)

Returns true if current BornAgain version match minimal required version.

Definition at line 117 of file Path.cpp.

 {
     return versionCode(version) >= versionCode(minimal_version);
 }

References versionCode().

Referenced by ProjectDocument::readProject().

Here is the call graph for this function:

◆ parseVersion()

bool GUI::Util::Path::parseVersion	(	const QString &	version,
		int &	major_num,
		int &	minor_num,
		int &	patch_num
	)

parses version string into 3 numbers, returns true in the case of success

Definition at line 83 of file Path.cpp.

 {
     major_num = minor_num = patch_num = 0;
     bool success(true);
     QStringList nums = version.split(".");
     if (nums.size() != 3)
         return false;
  
     bool ok(false);
     major_num = nums.at(0).toInt(&ok);
     success &= ok;
     minor_num = nums.at(1).toInt(&ok);
     success &= ok;
     patch_num = nums.at(2).toInt(&ok);
     success &= ok;
  
     return success;
 }

Referenced by versionCode().

◆ versionCode()

int GUI::Util::Path::versionCode ( const QString & version )

Definition at line 103 of file Path.cpp.

 {
     int result(-1);
  
     int ba_major(0), ba_minor(0), ba_patch(0);
     if (!parseVersion(version, ba_major, ba_minor, ba_patch))
         return result;
  
     result = ba_major * 10000 + ba_minor * 100 + ba_patch;
  
     return result;
 }

References parseVersion().

Referenced by isVersionMatchMinimal().