JsonParsing.h

Go to the documentation of this file.

#pragma once
 
#include <QtCore/QJsonDocument>
#include <QtCore/QJsonObject>
#include <QtCore/QJsonValue>
#include <QtCore/QStringList>
 
class QTranslator;
 
namespace JsonParsing {
 
constexpr const char *jsonVersionKey = "version";
constexpr const char *jsonFileTypeKey = "fileType";
 
 
bool isJsonFile(const QString& fileName, QJsonDocument& jsonDoc, QString& errorString);
 
bool isJsonFile(const QByteArray& bytes, QJsonDocument& jsonDoc, QString& errorString);
 
bool validateRequiredKeys(const QJsonObject& jsonObject, const QStringList& keys, QString& errorString);
 
bool validateKeyTypes(const QJsonObject& jsonObject, const QStringList& keys, const QList<QJsonValue::Type>& types,
                      QString& errorString);
 
struct KeyValidateInfo {
    const char *key;        
    QJsonValue::Type type;  
    bool required;          
};
 
bool validateKeys(const QJsonObject& jsonObject, const QList<KeyValidateInfo>& keyInfo, QString& errorString);
 
bool validateKeysStrict(const QJsonObject& jsonObject, const QList<KeyValidateInfo>& keyInfo, QString& errorString);
 
double possibleNaNJsonValue(const QJsonValue& value);
 
QTranslator *translator();
 
void saveQGCJsonFileHeader(QJsonObject &jsonObject, const QString &fileType, int version);
 
bool validateExternalQGCJsonFile(const QJsonObject &jsonObject,
                                 const QString &expectedFileType,
                                 int minSupportedVersion,
                                 int maxSupportedVersion,
                                 int &version,
                                 QString &errorString);
 
bool validateInternalQGCJsonFile(const QJsonObject &jsonObject,
                                 const QString &expectedFileType,
                                 int minSupportedVersion,
                                 int maxSupportedVersion,
                                 int &version,
                                 QString &errorString);
 
QJsonObject openInternalQGCJsonFile(const QString &jsonFilename,
                                    const QString &expectedFileType,
                                    int minSupportedVersion,
                                    int maxSupportedVersion,
                                    int &version,
                                    QString &errorString,
                                    const QStringList &defaultTranslateKeys = {},
                                    const QStringList &defaultArrayIDKeys = {});
 
}  // namespace JsonParsing