shape_p.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2013-2025 Paul Colby <git@colby.id.au>
// SPDX-License-Identifier: LGPL-3.0-or-later
 
/*!
 * \file
 * Declares the ShapePrivate class.
 */
 
#ifndef QTSMITHY_SHAPE_P_H
#define QTSMITHY_SHAPE_P_H
 
#include <qtsmithy/shape.h>
#include <qtsmithy/shapeid.h>
 
#include <QLoggingCategory>
 
QTSMITHY_BEGIN_NAMESPACE
 
class QTSMITHY_EXPORT ShapePrivate
{
Q_DECLARE_TR_FUNCTIONS(Shape);
 
public:
    explicit ShapePrivate(Shape * const q);
 
    static Shape::Type getType(const QJsonObject &ast);
    static Shape::Type getType(const QString &type);
 
    static Shape::Member getMember(const QJsonObject &ast, const QString &name);
    static ShapeIdStringMap getShapeIdStrMap(const QJsonObject &ast, const QString &name);
    static Shape::ShapeReference getShapeRef(const QJsonObject &ast, const QString &name);
    static Shape::ShapeReferences getShapeRefs(const QJsonObject &ast, const QString &name);
    static Shape::StringMemberMap getStrMemberMap(const QJsonObject &ast, const QString &name);
    static Shape::StringShapeRefMap getStrShapeRefMap(const QJsonObject &ast, const QString &name);
    static Shape::TraitsMap getTraitsMap(const QJsonObject &ast, const QString &name);
    static QString getString(const QJsonObject &ast, const QString &name);
 
    static QStringList supportedProperties(const Shape::Type &type);
    static QStringList requiredProperties(const Shape::Type &type);
 
    static bool validateIdentifier(const QString &id);
    static bool validateProperty(const QString &name, const QJsonValue &value);
 
protected:
    Shape * q_ptr; ///< Internal q-pointer.
    static Q_LOGGING_CATEGORY(lc, "smithy.Shape", QtInfoMsg); ///< Logging category for Shape.
 
private:
    QJsonObject ast;
    Shape::Error error;
    ShapeId id;
    Shape::Type type;
 
    Q_DECLARE_PUBLIC(Shape)
    QTSMITHY_BEFRIEND_TEST(Shape)
};
 
QTSMITHY_END_NAMESPACE
 
#endif // QTSMITHY_SHAPE_P_H