PathUtil.h

Go to the documentation of this file.

/*
 * PathUtil.h
 *
 * Copyright (c) 2019-2022 Spekular <Spekularr@gmail.com>
 *
 * This file is part of LMMS - https://lmms.io
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public
 * License along with this program (see COPYING); if not, write to the
 * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301 USA.
 *
 */
 
#ifndef LMMS_PATHUTIL_H
#define LMMS_PATHUTIL_H
 
#include <filesystem>
#include <string_view>
 
#include <QDir>
 
#include "lmms_export.h"
 
namespace lmms::PathUtil
{
    enum class Base { Absolute, ProjectDir, FactoryProjects, FactorySample, UserSample, UserVST, Preset,
        FactoryPresets, UserLADSPA, DefaultLADSPA, UserSoundfont, DefaultSoundfont, UserGIG, DefaultGIG,
        LocalDir };

    QString LMMS_EXPORT baseLocation(const Base base, bool* error = nullptr);
    QDir LMMS_EXPORT baseQDir (const Base base, bool* error = nullptr);
    QString LMMS_EXPORT basePrefix(const Base base);
    Base LMMS_EXPORT baseLookup(const QString& input);

    QString LMMS_EXPORT stripPrefix(const QString& input);
    QString LMMS_EXPORT cleanName(const QString& input);

    QString LMMS_EXPORT oldRelativeUpgrade(const QString& input);

    QString LMMS_EXPORT toAbsolute(const QString& input, bool* error = nullptr);
    QString LMMS_EXPORT relativeOrAbsolute(const QString& input, const Base base);
    QString LMMS_EXPORT toShortestRelative(const QString& input, bool allowLocal = false);

    LMMS_EXPORT auto stringToPath(std::string_view path) -> std::filesystem::path;

    LMMS_EXPORT auto stringToPath(const QString& path) -> std::filesystem::path;

    LMMS_EXPORT auto pathToString(const std::filesystem::path& path) -> std::string;
} // namespace lmms::PathUtil
 
#endif // LMMS_PATHUTIL_H