Path.cpp

Go to the documentation of this file.

//  ************************************************************************************************
//
//  BornAgain: simulate and fit reflection and scattering
//
//! @file      GUI/Util/Path.cpp
//! @brief     Implements Helpers functions
//!
//! @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)
//
//  ************************************************************************************************
 
#include "GUI/Util/Path.h"
#include "BAVersion.h"
#include <QDateTime>
#include <QDir>
#include <QFileInfo>
#include <QMap>
#include <QModelIndex>
#include <QStandardPaths>
#include <QVector>
 
namespace {
 
QMap<QString, QString> initializeCharacterMap()
{
    QMap<QString, QString> result;
    result["\\"] = "_backslash_";
    result["/"] = "_slash_";
    result["\""] = "_quote_";
    result["<"] = "_lessthan_";
    result[">"] = "_greaterthan_";
    result["|"] = "_pipe_";
    result["?"] = "_questionmark_";
    return result;
}
 
const QMap<QString, QString> invalidCharacterMap = initializeCharacterMap();
 
} // namespace
 
 
QString GUI::Util::Path::withTildeHomePath(const QString& path)
{
#ifdef Q_OS_WIN
    return path;
#endif
 
    static const QString homePath = QDir::homePath();
 
    QFileInfo fi(QDir::cleanPath(path));
    QString outPath = fi.absoluteFilePath();
    if (outPath.startsWith(homePath))
        return QLatin1Char('~') + outPath.mid(homePath.size());
    return path;
}
 
QString GUI::Util::Path::getBornAgainVersionString()
{
    return QString::fromStdString(BornAgain::GetVersionNumber());
}
 
//! 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
QString GUI::Util::Path::getValidFileName(const QString& proposed_name)
{
    QString result = proposed_name;
    for (auto it = invalidCharacterMap.begin(); it != invalidCharacterMap.end(); ++it)
        result.replace(it.key(), it.value());
    return result;
}
 
//! parses version string into 3 numbers, returns true in the case of success
bool GUI::Util::Path::parseVersion(const QString& version, int& major_num, int& minor_num,
                                   int& patch_num)
{
    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;
}
 
int GUI::Util::Path::versionCode(const QString& version)
{
    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;
}
 
//! Returns true if current BornAgain version match minimal required version
bool GUI::Util::Path::isVersionMatchMinimal(const QString& version, const QString& minimal_version)
{
    return versionCode(version) >= versionCode(minimal_version);
}
 
//! Returns file directory from the full file path
QString GUI::Util::Path::fileDir(const QString& fileName)
{
    QFileInfo info(fileName);
    if (info.exists())
        return info.dir().path();
    return "";
}
 
//! Returns base name of file.
 
QString GUI::Util::Path::baseName(const QString& fileName)
{
    QFileInfo info(fileName);
    return info.baseName();
}
 
QString GUI::Util::Path::appDataFolder()
{
    return QStandardPaths::writableLocation(QStandardPaths::AppDataLocation);
}
 
QString GUI::Util::Path::getPathFromIndex(const QModelIndex& index)
{
    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("/");
}