[libcalamares] Convenience function for FS names

Because getting the untranslated name of a FileSystem is something
that needs doing consistently, add some functions for that;
it makes it easier to spot places where that isn't done.

Probably doesn't compile, and needs extra documentation.
This commit is contained in:
Adriaan de Groot 2020-02-13 10:12:02 +01:00
parent c055e1da49
commit f410a4bb68

View File

@ -0,0 +1,52 @@
/* === This file is part of Calamares - <https://github.com/calamares> ===
*
* Copyright 2020, Adriaan de Groot <groot@kde.org>
*
* 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/>.
*/
/** @brief Gets filesystem names from KPMCore
*
* A name (e.g. "ext4") can be for internal, untranslated, use, or for
* user-visible use. In the latter case it should be translated. The
* KPMCore API gives user-visible names by default.
*/
#ifndef PARTITION_FSNAME_H
#define PARTITION_FSNAME_H
#include <fs/filesystem.h>
#include <QString>
namespace CalamaresUtils
{
namespace Partition
{
static inline QString
untranslatedFS( FileSystem& fs )
{
return fs.name( { QStringLiteral( "C" ) } );
}
static inline QString
untranslatedFS( FileSystem* fs )
{
return fs ? untranslatedFS( *fs ) : QString();
}
} // namespace Partition
} // namespace CalamaresUtils
#endif // PARTITION_FSNAME_H