ZblCog.h

Go to the documentation of this file.

/*
 * Zuble - A run-time system for QML/Javascript applications
 * Copyright (C) 2014 Bob Dinitto
 *
 * Filename:   ZblCog.h
 * Created on: 12/10/2014
 * Author:     Bob Dinitto
 *
 * Zuble is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 *
 */

#ifndef ZBLCOG_H
#define ZBLCOG_H

#include <QObject>
#include <QReadWriteLock>
#include <qqml.h>
#include "ZblPlugin.h"
#include "ZblLogManager.h"

#define zCog (Zbl::ZblCog::zInstance())

#define zblRegisterType(uri, versionMajor, versionMinor, qmlName, typeName, createFunc) \
    qmlRegisterType<typeName>(uri, versionMajor, versionMinor, qmlName); \
    zCog.registerSprocketObject(uri, versionMajor, versionMinor, qmlName, createFunc); \


class QXmlQuery;
class QXmlItem;

namespace Zbl
{

class ZblSprocket;
class ZblFactory;

class ZblCog : public QObject
{
    //friend class ZblFactory;

    Q_OBJECT

public:
    explicit ZblCog(QObject *parent = 0);
    virtual ~ZblCog();

    static ZblCog& zInit(QObject* parent);

    bool registerSprocket(const char* uri,
                          int versionMajor,
                          int versionMinor);

    bool registerSprocketObject(
            const char* uri,
            int versionMajor,
            int versionMinor,
            const char* qmlName,
            sprocketObjectConstructor createFunc);


    ZblFactory* createFactory(
            const char* sprocketUri,
            int versionMajor,
            int versionMinor,
            QObject* parent = NULL);



    bool mapResource(
            const char* uri,
            int versionMajor,
            int versionMinor,
            const char* fileName);

    bool mapPluginResources(const char* fileName, bool qmlRegister = false);

    bool mapConfigResources(const char* configFilePath);

    bool isMappedResource(
            const char* uri,
            int versionMajor,
            int versionMinor);

    QStringList getMappedResources();

    bool registerResource(
            const char* uri, int versionMajor, int versionMinor);



    static ZblCog& zInstance();


signals:

public slots:

protected:

    QString getNodeName(const QXmlItem& item, const QXmlQuery& query);

    enum commandFields {
        cmdAction = 0,
        cmdResourceType,
        cmdRecordSize,

        commandFieldCount // must be last
    };

    enum paramFile {
        fileUri = 1,
        fileVersionMajor,
        fileVersionMinor,
        fileName
    };

    enum paramPlugin {
        pluginName = 1
    };

#if 0

    const ZblSprockOb* findSprock(
        const char* uri,
        int versionMajor,
        int versionMinor,
        const char* qmlName) const;
#endif

    void warnInvalidResourceCommand(
            const QString& label, const QString& command);

    void warnAbortingResourceLoad(
            const QString& label, const QString& reason);

    bool validateParamCount(int actual, int required);

    bool getPluginResParams(const QJsonValue& resourceValue,
                                    QString& uri,
                                    QString& fileName,
                                    QString& versionMajor,
                                    QString& versionMinor);

    bool getPluginStringParam(const QJsonObject& resource,
                                      const QString& paramKey,
                                      QString& outValue);

    static const QString m_commandSeparator;
    static const QString m_actionMap;
    static const QString m_actionQmlregister;
    static const QString m_actionIgnore;
    static const QString m_restypeFile;
    static const QString m_restypePlugin;
    static const QString m_restypeInvalid;

    static const int m_paramcountFile;
    static const int m_paramcountPlugin;


    sprocketPluginMap m_sprockets;

    resourceMap m_resources;

    QReadWriteLock m_lock;

private:


    static ZblCog* m_zCog;



    ZBL_DECLARE_LOGGED_OBJECT
};

} // Zbl

#endif // ZBLCOG_H