62a8ee9708
- add apidox to all the untranslatedFS() methods - add the most-basic of untranslatedFS(), which works on a given FileSystem::Type; this one can handle special cases where Cala needs a different untranslated name than what KPMCore provides.
88 lines
2.5 KiB
C++
88 lines
2.5 KiB
C++
/* === This file is part of Calamares - <https://github.com/calamares> ===
|
|
*
|
|
* SPDX-FileCopyrightText: 2014 Aurélien Gâteau <agateau@kde.org>
|
|
* SPDX-FileCopyrightText: 2015-2016 Teo Mrnjavac <teo@kde.org>
|
|
* SPDX-FileCopyrightText: 2019 Adriaan de Groot <groot@kde.org>
|
|
* SPDX-License-Identifier: GPL-3.0-or-later
|
|
*
|
|
* Calamares 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 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* Calamares 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 Calamares. If not, see <http://www.gnu.org/licenses/>.
|
|
*
|
|
*/
|
|
|
|
/*
|
|
* NOTE: this functionality is only available when Calamares is compiled
|
|
* with KPMcore support.
|
|
*/
|
|
|
|
#ifndef PARTITION_FILESYSTEM_H
|
|
#define PARTITION_FILESYSTEM_H
|
|
|
|
#include "DllMacro.h"
|
|
|
|
#include <kpmcore/fs/filesystem.h>
|
|
|
|
namespace CalamaresUtils
|
|
{
|
|
namespace Partition
|
|
{
|
|
QString DLLEXPORT prettyNameForFileSystemType( FileSystem::Type t );
|
|
|
|
/** @brief Returns a machine-readable identifier for the filesystem type
|
|
*
|
|
* This identifier is used in filesystem manipulation --
|
|
* e.g. when mounting the filesystem, or in /etc/fstab. It
|
|
* is almost always just what KPMCore says it is, with
|
|
* the following exceptions:
|
|
* - reiserfs is called "reiser" by KPMCore, "reiserfs" by Calamares
|
|
*/
|
|
QString DLLEXPORT untranslatedFS( FileSystem::Type t );
|
|
|
|
/** @brief Returns the machine-readable identifier for the given @p fs
|
|
*
|
|
* See notes for untranslatedFS(), above.
|
|
*/
|
|
static inline QString
|
|
untranslatedFS( FileSystem& fs )
|
|
{
|
|
return untranslatedFS( fs.type() );
|
|
}
|
|
|
|
/** @brief Returns a machine-readable identifier for the given @p fs
|
|
*
|
|
* Returns an empty string is the @p fs is not valid (e.g. nullptr).
|
|
*/
|
|
static inline QString
|
|
untranslatedFS( FileSystem* fs )
|
|
{
|
|
return fs ? untranslatedFS( *fs ) : QString();
|
|
}
|
|
|
|
static inline QString
|
|
userVisibleFS( FileSystem& fs )
|
|
{
|
|
return fs.name();
|
|
}
|
|
|
|
static inline QString
|
|
userVisibleFS( FileSystem* fs )
|
|
{
|
|
return fs ? userVisibleFS( *fs ) : QString();
|
|
}
|
|
|
|
|
|
} // namespace Partition
|
|
} // namespace CalamaresUtils
|
|
|
|
#endif // PARTITION_PARTITIONQUERY_H
|