forked from qt-creator/qt-creator
Introduce JSON validation
Support basic validation for JSON files according to the draft http://tools.ietf.org/html/draft-zyp-json-schema-03. This is not a complete implementation yet, but it should already be useful, since "type" verification along with many of the attributes is done. Change-Id: I364bc98dd92937c5e2ea9cba7e15ed8e03eb9beb Reviewed-by: Erik Verbruggen <erik.verbruggen@nokia.com>
This commit is contained in:
Leandro Melo
412
src/libs/utils/json.h
Normal file
412
src/libs/utils/json.h
Normal file
@@ -0,0 +1,412 @@
|
||||
/**************************************************************************
|
||||
**
|
||||
** This file is part of Qt Creator
|
||||
**
|
||||
** Copyright (c) 2012 Nokia Corporation and/or its subsidiary(-ies).
|
||||
**
|
||||
** Contact: Nokia Corporation (info@qt.nokia.com)
|
||||
**
|
||||
**
|
||||
** GNU Lesser General Public License Usage
|
||||
**
|
||||
** This file may be used under the terms of the GNU Lesser General Public
|
||||
** License version 2.1 as published by the Free Software Foundation and
|
||||
** appearing in the file LICENSE.LGPL included in the packaging of this file.
|
||||
** Please review the following information to ensure the GNU Lesser General
|
||||
** Public License version 2.1 requirements will be met:
|
||||
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
|
||||
**
|
||||
** In addition, as a special exception, Nokia gives you certain additional
|
||||
** rights. These rights are described in the Nokia Qt LGPL Exception
|
||||
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
|
||||
**
|
||||
** Other Usage
|
||||
**
|
||||
** Alternatively, this file may be used in accordance with the terms and
|
||||
** conditions contained in a signed written agreement between you and Nokia.
|
||||
**
|
||||
** If you have questions regarding the use of this file, please contact
|
||||
** Nokia at info@qt.nokia.com.
|
||||
**
|
||||
**************************************************************************/
|
||||
|
||||
#ifndef JSON_H
|
||||
#define JSON_H
|
||||
|
||||
#include "utils_global.h"
|
||||
|
||||
#include <QtCore/QHash>
|
||||
#include <QtCore/QVector>
|
||||
#include <QtCore/QScopedPointer>
|
||||
#include <QtCore/QVariant>
|
||||
#include <QtCore/QStringList>
|
||||
#include <QtCore/QLatin1String>
|
||||
#include <QtCore/QDateTime>
|
||||
#include <QtScript/QScriptEngine>
|
||||
#include <QtScript/QScriptValue>
|
||||
#include <QtScript/QScriptValueIterator>
|
||||
|
||||
namespace Utils {
|
||||
|
||||
class JsonStringValue;
|
||||
class JsonDoubleValue;
|
||||
class JsonIntValue;
|
||||
class JsonObjectValue;
|
||||
class JsonArrayValue;
|
||||
class JsonBooleanValue;
|
||||
class JsonNullValue;
|
||||
|
||||
/*!
|
||||
* \brief The JsonValue class
|
||||
*/
|
||||
class QTCREATOR_UTILS_EXPORT JsonValue
|
||||
{
|
||||
public:
|
||||
enum Kind {
|
||||
String,
|
||||
Double,
|
||||
Int,
|
||||
Object,
|
||||
Array,
|
||||
Boolean,
|
||||
Null,
|
||||
Unknown
|
||||
};
|
||||
|
||||
virtual ~JsonValue();
|
||||
|
||||
Kind kind() const { return m_kind; }
|
||||
static QString kindToString(Kind kind);
|
||||
|
||||
virtual JsonStringValue *toString() { return 0; }
|
||||
virtual JsonDoubleValue *toDouble() { return 0; }
|
||||
virtual JsonIntValue *toInt() { return 0; }
|
||||
virtual JsonObjectValue *toObject() { return 0; }
|
||||
virtual JsonArrayValue *toArray() { return 0; }
|
||||
virtual JsonBooleanValue *toBoolean() { return 0; }
|
||||
virtual JsonNullValue *toNull() { return 0; }
|
||||
|
||||
static JsonValue *create(const QString &s);
|
||||
|
||||
protected:
|
||||
JsonValue(Kind kind);
|
||||
|
||||
private:
|
||||
static JsonValue *build(const QVariant &varixant);
|
||||
|
||||
Kind m_kind;
|
||||
};
|
||||
|
||||
|
||||
/*!
|
||||
* \brief The JsonStringValue class
|
||||
*/
|
||||
class QTCREATOR_UTILS_EXPORT JsonStringValue : public JsonValue
|
||||
{
|
||||
public:
|
||||
JsonStringValue(const QString &value)
|
||||
: JsonValue(String)
|
||||
, m_value(value)
|
||||
{}
|
||||
|
||||
virtual JsonStringValue *toString() { return this; }
|
||||
|
||||
const QString &value() const { return m_value; }
|
||||
|
||||
private:
|
||||
QString m_value;
|
||||
};
|
||||
|
||||
|
||||
/*!
|
||||
* \brief The JsonDoubleValue class
|
||||
*/
|
||||
class QTCREATOR_UTILS_EXPORT JsonDoubleValue : public JsonValue
|
||||
{
|
||||
public:
|
||||
JsonDoubleValue(double value)
|
||||
: JsonValue(Double)
|
||||
, m_value(value)
|
||||
{}
|
||||
|
||||
virtual JsonDoubleValue *toDouble() { return this; }
|
||||
|
||||
double value() const { return m_value; }
|
||||
|
||||
private:
|
||||
double m_value;
|
||||
};
|
||||
|
||||
/*!
|
||||
* \brief The JsonIntValue class
|
||||
*/
|
||||
class QTCREATOR_UTILS_EXPORT JsonIntValue : public JsonValue
|
||||
{
|
||||
public:
|
||||
JsonIntValue(int value)
|
||||
: JsonValue(Int)
|
||||
, m_value(value)
|
||||
{}
|
||||
|
||||
virtual JsonIntValue *toInt() { return this; }
|
||||
|
||||
int value() const { return m_value; }
|
||||
|
||||
private:
|
||||
int m_value;
|
||||
};
|
||||
|
||||
|
||||
/*!
|
||||
* \brief The JsonObjectValue class
|
||||
*/
|
||||
class QTCREATOR_UTILS_EXPORT JsonObjectValue : public JsonValue
|
||||
{
|
||||
public:
|
||||
JsonObjectValue()
|
||||
: JsonValue(Object)
|
||||
{}
|
||||
|
||||
virtual JsonObjectValue *toObject() { return this; }
|
||||
|
||||
void addMember(const QString &name, JsonValue *value) { m_members.insert(name, value); }
|
||||
bool hasMember(const QString &name) const { return m_members.contains(name); }
|
||||
JsonValue *member(const QString &name) const { return m_members.value(name); }
|
||||
QHash<QString, JsonValue *> members() const { return m_members; }
|
||||
bool isEmpty() const { return m_members.isEmpty(); }
|
||||
|
||||
protected:
|
||||
JsonObjectValue(Kind kind)
|
||||
: JsonValue(kind)
|
||||
{}
|
||||
|
||||
private:
|
||||
QHash<QString, JsonValue *> m_members;
|
||||
};
|
||||
|
||||
|
||||
/*!
|
||||
* \brief The JsonArrayValue class
|
||||
*/
|
||||
class QTCREATOR_UTILS_EXPORT JsonArrayValue : public JsonValue
|
||||
{
|
||||
public:
|
||||
JsonArrayValue()
|
||||
: JsonValue(Array)
|
||||
{}
|
||||
|
||||
virtual JsonArrayValue *toArray() { return this; }
|
||||
|
||||
void addElement(JsonValue *value) { m_elements.append(value); }
|
||||
QList<JsonValue *> elements() const { return m_elements; }
|
||||
int size() const { return m_elements.size(); }
|
||||
|
||||
private:
|
||||
QList<JsonValue *> m_elements;
|
||||
};
|
||||
|
||||
|
||||
/*!
|
||||
* \brief The JsonBooleanValue class
|
||||
*/
|
||||
class QTCREATOR_UTILS_EXPORT JsonBooleanValue : public JsonValue
|
||||
{
|
||||
public:
|
||||
JsonBooleanValue(bool value)
|
||||
: JsonValue(Boolean)
|
||||
, m_value(value)
|
||||
{}
|
||||
|
||||
virtual JsonBooleanValue *toBoolean() { return this; }
|
||||
|
||||
bool value() const { return m_value; }
|
||||
|
||||
private:
|
||||
bool m_value;
|
||||
};
|
||||
|
||||
class QTCREATOR_UTILS_EXPORT JsonNullValue : public JsonValue
|
||||
{
|
||||
public:
|
||||
JsonNullValue()
|
||||
: JsonValue(Null)
|
||||
{}
|
||||
|
||||
virtual JsonNullValue *toNull() { return this; }
|
||||
};
|
||||
|
||||
class JsonSchemaManager;
|
||||
|
||||
/*!
|
||||
* \brief The JsonSchema class
|
||||
*
|
||||
* [NOTE: This is an incomplete implementation and a work in progress.]
|
||||
*
|
||||
* This class provides an interface for traversing and evaluating a JSON schema, as described
|
||||
* in the draft http://tools.ietf.org/html/draft-zyp-json-schema-03.
|
||||
*
|
||||
* JSON schemas are recursive in concept. This means that a particular attribute from a schema
|
||||
* might be also another schema. Therefore, the basic working principle of this API is that
|
||||
* from within some schema, one can investigate its attributes and if necessary "enter" a
|
||||
* corresponding nested schema. Afterwards, it's expected that one would "leave" such nested
|
||||
* schema.
|
||||
*
|
||||
* All methods assume that the current "context" is a valid schema. Once an instance of this
|
||||
* class is created the root schema is put on top of the stack.
|
||||
*
|
||||
*/
|
||||
class QTCREATOR_UTILS_EXPORT JsonSchema
|
||||
{
|
||||
public:
|
||||
bool isTypeConstrained() const;
|
||||
bool acceptsType(const QString &type) const;
|
||||
QStringList validTypes() const;
|
||||
|
||||
// Applicable on schemas of any type.
|
||||
bool required() const;
|
||||
|
||||
bool hasTypeSchema() const;
|
||||
void enterNestedTypeSchema();
|
||||
|
||||
bool hasUnionSchema() const;
|
||||
int unionSchemaSize() const;
|
||||
bool maybeEnterNestedUnionSchema(int index);
|
||||
|
||||
void leaveNestedSchema();
|
||||
|
||||
// Applicable on schemas of type number/integer.
|
||||
bool hasMinimum() const;
|
||||
bool hasMaximum() const;
|
||||
bool hasExclusiveMinimum();
|
||||
bool hasExclusiveMaximum();
|
||||
double minimum() const;
|
||||
double maximum() const;
|
||||
|
||||
// Applicable on schemas of type string.
|
||||
QString pattern() const;
|
||||
int minimumLength() const;
|
||||
int maximumLength() const;
|
||||
|
||||
// Applicable on schemas of type object.
|
||||
QStringList properties() const;
|
||||
bool hasPropertySchema(const QString &property) const;
|
||||
void enterNestedPropertySchema(const QString &property);
|
||||
|
||||
// Applicable on schemas of type array.
|
||||
bool hasAdditionalItems() const;
|
||||
|
||||
bool hasItemSchema() const;
|
||||
void enterNestedItemSchema();
|
||||
|
||||
bool hasItemArraySchema() const;
|
||||
int itemArraySchemaSize() const;
|
||||
bool maybeEnterNestedArraySchema(int index);
|
||||
|
||||
private:
|
||||
friend class JsonSchemaManager;
|
||||
JsonSchema(JsonObjectValue *rootObject, const JsonSchemaManager *manager);
|
||||
Q_DISABLE_COPY(JsonSchema)
|
||||
|
||||
enum EvaluationMode {
|
||||
Normal,
|
||||
Array,
|
||||
Union
|
||||
};
|
||||
|
||||
void enter(JsonObjectValue *ov, EvaluationMode eval = Normal, int index = -1);
|
||||
bool maybeEnter(JsonValue *v, EvaluationMode eval, int index);
|
||||
void evaluate(EvaluationMode eval, int index);
|
||||
void leave();
|
||||
|
||||
JsonObjectValue *resolveReference(JsonObjectValue *ov) const;
|
||||
JsonObjectValue *resolveBase(JsonObjectValue *ov) const;
|
||||
|
||||
JsonObjectValue *currentValue() const;
|
||||
int currentIndex() const;
|
||||
|
||||
JsonObjectValue *rootValue() const;
|
||||
|
||||
static JsonStringValue *getStringValue(const QString &name, JsonObjectValue *value);
|
||||
static JsonObjectValue *getObjectValue(const QString &name, JsonObjectValue *value);
|
||||
static JsonBooleanValue *getBooleanValue(const QString &name, JsonObjectValue *value);
|
||||
static JsonArrayValue *getArrayValue(const QString &name, JsonObjectValue *value);
|
||||
static JsonDoubleValue *getDoubleValue(const QString &name, JsonObjectValue *value);
|
||||
|
||||
static QStringList validTypes(JsonObjectValue *v);
|
||||
static bool typeMatches(const QString &expected, const QString &actual);
|
||||
static bool isCheckableType(const QString &s);
|
||||
|
||||
QStringList properties(JsonObjectValue *v) const;
|
||||
JsonObjectValue *propertySchema(const QString &property, JsonObjectValue *v) const;
|
||||
// TODO: Similar methods for other attributes which require looking into base schemas.
|
||||
|
||||
static bool maybeSchemaName(const QString &s);
|
||||
|
||||
static const QString kType;
|
||||
static const QString kProperties;
|
||||
static const QString kPatternProperties;
|
||||
static const QString kAdditionalProperties;
|
||||
static const QString kItems;
|
||||
static const QString kAdditionalItems;
|
||||
static const QString kRequired;
|
||||
static const QString kDependencies;
|
||||
static const QString kMinimum;
|
||||
static const QString kMaximum;
|
||||
static const QString kExclusiveMinimum;
|
||||
static const QString kExclusiveMaximum;
|
||||
static const QString kMinItems;
|
||||
static const QString kMaxItems;
|
||||
static const QString kUniqueItems;
|
||||
static const QString kPattern;
|
||||
static const QString kMinLength;
|
||||
static const QString kMaxLength;
|
||||
static const QString kTitle;
|
||||
static const QString kDescription;
|
||||
static const QString kExtends;
|
||||
static const QString kRef;
|
||||
|
||||
struct Context
|
||||
{
|
||||
JsonObjectValue *m_value;
|
||||
EvaluationMode m_eval;
|
||||
int m_index;
|
||||
};
|
||||
|
||||
QVector<Context> m_schemas;
|
||||
const JsonSchemaManager *m_manager;
|
||||
};
|
||||
|
||||
|
||||
/*!
|
||||
* \brief The JsonSchemaManager class
|
||||
*/
|
||||
class QTCREATOR_UTILS_EXPORT JsonSchemaManager
|
||||
{
|
||||
public:
|
||||
JsonSchemaManager(const QStringList &searchPaths);
|
||||
~JsonSchemaManager();
|
||||
|
||||
Utils::JsonSchema *schemaForFile(const QString &fileName) const;
|
||||
Utils::JsonSchema *schemaByName(const QString &baseName) const;
|
||||
|
||||
private:
|
||||
struct JsonSchemaData
|
||||
{
|
||||
JsonSchemaData(const QString &absoluteFileName, Utils::JsonSchema *schema = 0)
|
||||
: m_absoluteFileName(absoluteFileName)
|
||||
, m_schema(schema)
|
||||
{}
|
||||
QString m_absoluteFileName;
|
||||
Utils::JsonSchema *m_schema;
|
||||
QDateTime m_lastParseAttempt;
|
||||
};
|
||||
|
||||
Utils::JsonSchema *parseSchema(const QString &schemaFileName) const;
|
||||
|
||||
QStringList m_searchPaths;
|
||||
mutable QHash<QString, JsonSchemaData> m_schemas;
|
||||
};
|
||||
|
||||
} // namespace Utils
|
||||
|
||||
#endif // JSON_H
|
||||
Reference in New Issue
Block a user