ZxQuery.h

Go to the documentation of this file.

/*
 * Zuble - A run-time system for QML/Javascript applications
 * Copyright (C) 2013, 2014  Bob Dinitto
 *
 * ZxQuery.h
 *
 *  Created on: 29-Sep, 2013
 *      Author: Bob Dinitto   bob@ninzo.com
 *
 * 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 ZXQUERY_H
#define ZXQUERY_H

#include <QObject>
#include <QXmlQuery>
#include <QStringList>
#include <QFile>
#include "ZxResultItems.h"
#include "zblcore_global.h"
#include "zglobal.h"


class QFile;

namespace Zbl
{

class ZBLCORESHARED_EXPORT ZxQuery : public QObject
{
    Q_OBJECT
public:
    explicit ZxQuery(QObject *parent = 0);

    explicit ZxQuery(const ZxQuery& source, QObject *parent = 0);

    explicit ZxQuery(const QXmlNamePool & np, QObject *parent = 0);

    Q_PROPERTY(QString queryUrl READ getQueryUrl WRITE setQueryUrl)

    
    Q_PROPERTY(QObject* focusItem READ getFocusItem WRITE setFocusItem)

    Q_PROPERTY(QString focusUrl READ getFocusUrl WRITE setFocusUrl NOTIFY focusUrlChanged)

    Q_PROPERTY(QString focusText READ getFocusText WRITE setFocusText)

    Q_PROPERTY(QString queryText READ getQueryText WRITE setQueryText)

    Q_PROPERTY(bool substituteSymbols READ getSymbolSubstitution WRITE setSymbolSubstitution)



    Q_INVOKABLE QObject* evaluateToItems();

    Q_INVOKABLE QStringList evaluateToStringList();

    Q_INVOKABLE QString evaluateToXml();

    Q_INVOKABLE QObject* getCopy();

    Q_INVOKABLE QObject* getNamePoolCopy();



    Q_INVOKABLE void bindVariable(const QString &localName, QObject* zXmlItem);


    Q_INVOKABLE void loadQueryText(const QString& fileUri);


    Q_INVOKABLE void concatQueryText(const QString& text);

    Q_INVOKABLE void commitQueryText();

    Q_INVOKABLE void bindSymbol(const QString& symbolName, const QString& symbolText);

    Q_INVOKABLE QString getSymbolText(const QString& symbolName);

    Q_INVOKABLE void removeSymbol(const QString& symbolName);




    void setQueryUrl(const QString& url);

    const QString getQueryUrl();

    void setFocusUrl(const QString& url);

    const QString getFocusUrl();

    void setFocusItem(QObject* item);

    QObject* getFocusItem();


    void setFocusText(const QString& text);

    const QString getFocusText();

    void setQueryText(const QString& text);

    const QString getQueryText();

#if 0

    void clearQueryText();
#endif

    void setSymbolSubstitution(bool enabled);

    const bool getSymbolSubstitution();




    QXmlNamePool getNamePool() const;

    static void registerType();



    
signals:

    void focusUrlChanged(bool focusOK);
    void queryUrlChanged(bool queryOK);

public slots:


protected:

    ZBL_DECLARE_LOGGED_OBJECT


    class ResourceUrlFile
    {
    public:
        ResourceUrlFile(){m_f = NULL;}
        ~ResourceUrlFile();

        void setUrl(const QString& url);

        QString getUrl(){return m_url.url();}

        static bool isResourceScheme(const QString& scheme){return (scheme == "qrc:/" || scheme == ":/");}

        bool open();

        bool isOK(){return m_f != NULL ? m_f->error() == QFileDevice::NoError : false;}

        QString errorString(){return m_f != NULL ? m_f->errorString() : QString();}

        QString fileName(){return m_f != NULL ? m_f->fileName() : QString();}

        void dumpFile(){
            qDebug("begin dumping resource file...");
            QByteArray data = m_f->readAll();
            qDebug(data.constData());
            qDebug("end dumbing resource file.");
        }

    //protected:

        void resetFile();

        void closeFile();

        void freeFile();

        QFile* m_f;

        QUrl m_url;
    };



    QXmlQuery m_query;

    QUrl m_queryUrl;

    QString m_queryText;

    //QUrl m_focusUrl;

    QString m_focusText;


    QXmlItem m_xmlItem;

    ResourceUrlFile m_focusFile;

    ResourceUrlFile m_queryFile;

    bool m_enableSymbols;

    QMap<QString, QString> m_symbols;

};

} // Zbl

#endif // ZXQUERY_H