85 lines
2.9 KiB
C++
85 lines
2.9 KiB
C++
/* === This file is part of Calamares - <https://calamares.io> ===
|
|
*
|
|
* SPDX-FileCopyrightText: 2014 Teo Mrnjavac <teo@kde.org>
|
|
* SPDX-FileCopyrightText: 2017-2018 Adriaan de Groot <groot@kde.org>
|
|
* SPDX-License-Identifier: GPL-3.0-or-later
|
|
*
|
|
* Calamares is Free Software: see the License-Identifier above.
|
|
*
|
|
*/
|
|
|
|
/*
|
|
* YAML conversions and YAML convenience header.
|
|
*
|
|
* Includes the system YAMLCPP headers without warnings (by switching off
|
|
* the expected warnings) and provides a handful of methods for
|
|
* converting between YAML and QVariant.
|
|
*/
|
|
#ifndef UTILS_YAML_H
|
|
#define UTILS_YAML_H
|
|
|
|
#include "DllMacro.h"
|
|
|
|
#include <QStringList>
|
|
#include <QVariant>
|
|
#include <QVariantList>
|
|
#include <QVariantMap>
|
|
|
|
class QByteArray;
|
|
class QFileInfo;
|
|
|
|
// The yaml-cpp headers are not C++11 warning-proof, especially
|
|
// with picky compilers like Clang 8. Since we use Clang for the
|
|
// find-all-the-warnings case, switch those warnings off for
|
|
// the we-can't-change-them system headers.
|
|
QT_WARNING_PUSH
|
|
QT_WARNING_DISABLE_CLANG( "-Wzero-as-null-pointer-constant" )
|
|
QT_WARNING_DISABLE_CLANG( "-Wshadow" )
|
|
QT_WARNING_DISABLE_CLANG( "-Wfloat-equal" )
|
|
QT_WARNING_DISABLE_CLANG( "-Wsuggest-destructor-override" )
|
|
|
|
#include <yaml-cpp/yaml.h>
|
|
|
|
QT_WARNING_POP
|
|
|
|
/// @brief Appends all the elements of @p node to the string list @p v
|
|
DLLEXPORT void operator>>( const ::YAML::Node& node, QStringList& v );
|
|
|
|
namespace Calamares
|
|
{
|
|
namespace YAML
|
|
{
|
|
/**
|
|
* Loads a given @p filename and returns the YAML data
|
|
* as a QVariantMap. If filename doesn't exist, or is
|
|
* malformed in some way, returns an empty map and sets
|
|
* @p *ok to false. Otherwise sets @p *ok to true.
|
|
*/
|
|
DLLEXPORT QVariantMap load( const QString& filename, bool* ok = nullptr );
|
|
/** Convenience overload. */
|
|
DLLEXPORT QVariantMap load( const QFileInfo&, bool* ok = nullptr );
|
|
|
|
DLLEXPORT QVariant toVariant( const ::YAML::Node& node );
|
|
DLLEXPORT QVariant scalarToVariant( const ::YAML::Node& scalarNode );
|
|
DLLEXPORT QVariantList sequenceToVariant( const ::YAML::Node& sequenceNode );
|
|
DLLEXPORT QVariantMap mapToVariant( const ::YAML::Node& mapNode );
|
|
|
|
/// @brief Returns all the elements of @p listNode in a StringList
|
|
DLLEXPORT QStringList toStringList( const ::YAML::Node& listNode );
|
|
|
|
/// @brief Save a @p map to @p filename as YAML
|
|
DLLEXPORT bool save( const QString& filename, const QVariantMap& map );
|
|
|
|
/**
|
|
* Given an exception from the YAML parser library, explain
|
|
* what is going on in terms of the data passed to the parser.
|
|
* Uses @p label when labeling the data source (e.g. "netinstall data")
|
|
*/
|
|
DLLEXPORT void explainException( const ::YAML::Exception& e, const QByteArray& data, const char* label );
|
|
DLLEXPORT void explainException( const ::YAML::Exception& e, const QByteArray& data, const QString& label );
|
|
DLLEXPORT void explainException( const ::YAML::Exception& e, const QByteArray& data );
|
|
|
|
} // namespace YAML
|
|
} // namespace Calamares
|
|
|
|
#endif
|