mirror of
https://github.com/LMMS/lmms.git
synced 2025-12-30 10:08:00 -05:00
74 lines
3.0 KiB
C++
74 lines
3.0 KiB
C++
/*
|
|
* 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 "lmms_export.h"
|
|
|
|
#include <QDir>
|
|
|
|
namespace lmms::PathUtil
|
|
{
|
|
enum class Base { Absolute, ProjectDir, FactorySample, UserSample, UserVST, Preset,
|
|
UserLADSPA, DefaultLADSPA, UserSoundfont, DefaultSoundfont, UserGIG, DefaultGIG,
|
|
LocalDir };
|
|
|
|
//! Return the directory associated with a given base as a QString
|
|
//! Optionally, if a pointer to boolean is given the method will
|
|
//! use it to indicate whether the prefix could be resolved properly
|
|
//! or not.
|
|
QString LMMS_EXPORT baseLocation(const Base base, bool* error = nullptr);
|
|
//! Return the directory associated with a given base as a QDir.
|
|
//! Optional pointer to boolean to indicate if the prefix could
|
|
//! be resolved properly.
|
|
QDir LMMS_EXPORT baseQDir (const Base base, bool* error = nullptr);
|
|
//! Return the prefix used to denote this base in path strings
|
|
QString LMMS_EXPORT basePrefix(const Base base);
|
|
//! Check the prefix of a path and return the base it corresponds to
|
|
//! Defaults to Base::Absolute
|
|
Base LMMS_EXPORT baseLookup(const QString & path);
|
|
|
|
//! Remove the prefix from a path, iff there is one
|
|
QString LMMS_EXPORT stripPrefix(const QString & path);
|
|
//! Get the filename for a path, handling prefixed paths correctly
|
|
QString LMMS_EXPORT cleanName(const QString & path);
|
|
|
|
//! Upgrade prefix-less relative paths to the new format
|
|
QString LMMS_EXPORT oldRelativeUpgrade(const QString & input);
|
|
|
|
//! Make this path absolute. If a pointer to boolean is given
|
|
//! it will indicate whether the path was converted successfully
|
|
QString LMMS_EXPORT toAbsolute(const QString & input, bool* error = nullptr);
|
|
//! Make this path relative to a given base, return an absolute path if that fails
|
|
QString LMMS_EXPORT relativeOrAbsolute(const QString & input, const Base base);
|
|
//! Make this path relative to any base, choosing the shortest if there are
|
|
//! multiple options. allowLocal defines whether local paths should be considered.
|
|
//! Defaults to an absolute path if all bases fail.
|
|
QString LMMS_EXPORT toShortestRelative(const QString & input, bool allowLocal = false);
|
|
|
|
} // namespace lmms::PathUtil
|
|
|
|
#endif // LMMS_PATHUTIL_H
|