ZDataStream.h

Go to the documentation of this file.

/*
* Zuble - A run-time system for QML/Javascript applications
* Copyright (C) 2013, 2014  Bob Dinitto
*
* Filename:   ZDataStream.h
* Created on: 11/9/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 ZDATASTREAM_H
#define ZDATASTREAM_H
#include <QObject>
#include <QTextStream>

#include "zblcore_global.h"
#include "ZFile.h"
#include "ZioDevice.h"

//class QVariantMap;


namespace Zbl
{

class ZDataStream : public QObject
{
    Q_OBJECT
    Q_ENUMS(Status)
    Q_ENUMS(Version)
    Q_ENUMS(ByteOrder)
    Q_ENUMS(FloatingPointPrecision)
public:

    typedef QSharedPointer<QDataStream> QDataStreamPtr;


    // to participate in automatic enum propagation
    // for QML programs we redeclare these QDataStream enums;
    // note background Javascript programs can't use QML
    // type engine, those programs use m_tags instead


    enum Status {
        StatusOk = QDataStream::Ok,
        StatusReadPastEnd = QDataStream::ReadPastEnd,
        StatusReadCorruptData = QDataStream::ReadCorruptData,
        StatusWriteFailed = QDataStream::WriteFailed
    };


    enum Version {
        Version_Qt_1_0 = QDataStream::Qt_1_0,
        Version_Qt_2_0 = QDataStream::Qt_2_0,
        Version_Qt_2_1 = QDataStream::Qt_2_1,
        Version_Qt_3_0 = QDataStream::Qt_3_0,
        Version_Qt_3_1 = QDataStream::Qt_3_1,
        Version_Qt_3_3 = QDataStream::Qt_3_3,
        Version_Qt_4_0 = QDataStream::Qt_4_0,
        Version_Qt_4_1 = QDataStream::Qt_4_1,
        Version_Qt_4_2 = QDataStream::Qt_4_2,
        Version_Qt_4_3 = QDataStream::Qt_4_3,
        Version_Qt_4_4 = QDataStream::Qt_4_4,
        Version_Qt_4_5 = QDataStream::Qt_4_5,
        Version_Qt_4_6 = QDataStream::Qt_4_6,
        Version_Qt_4_7 = QDataStream::Qt_4_7,
        Version_Qt_4_8 = QDataStream::Qt_4_8,
        Version_Qt_4_9 = QDataStream::Qt_4_9,
        Version_Qt_5_0 = QDataStream::Qt_5_0,
        Version_Qt_5_1 = QDataStream::Qt_5_1,
        Version_Qt_5_2 = QDataStream::Qt_5_2,
        Version_Qt_5_3 = QDataStream::Qt_5_3,
        Version_Qt_5_4 = QDataStream::Qt_5_4,
        Version_Qt_5_5 = QDataStream::Qt_5_5,
        Version_Qt_5_6 = QDataStream::Qt_5_6,
        Version_Qt_5_7 = QDataStream::Qt_5_7,
        Version_Qt_5_8 = QDataStream::Qt_5_8,
        Version_Qt_5_9 = QDataStream::Qt_5_9,
        Version_Qt_5_10 = QDataStream::Qt_5_10,
        Version_Qt_5_11 = QDataStream::Qt_5_11,
        Version_Qt_5_12 = QDataStream::Qt_5_12,
        Version_Qt_5_13 = QDataStream::Qt_5_13,

#if QT_VERSION >= 0x050e00
#error Add the datastream version for this Qt version and update Qt_DefaultCompiledVersion
#endif
        Qt_DefaultCompiledVersion = Version_Qt_5_13

    };


    enum ByteOrder {
        ByteOrderBigEndian = QDataStream::BigEndian,
        ByteOrderLittleEndian = QDataStream::LittleEndian
    };

    enum FloatingPointPrecision {
        FpSinglePrecision = QDataStream::SinglePrecision,
        FpDoublePrecision = QDataStream::DoublePrecision
    };


    explicit ZDataStream(QObject *parent = 0);
    explicit ZDataStream(const ZqIODevicePtr device, QObject *parent = 0);
    explicit ZDataStream(const ZqByteArrayPtr byteArray, QObject *parent = 0);

    static void registerType();

    Q_PROPERTY(uint status READ getStatus)
    Q_PROPERTY(QObject* device READ getJsDevice)
    Q_PROPERTY(QVariant tags READ getTags)
    Q_PROPERTY(uint byteOrder READ getByteOrder WRITE setByteOrder)
    Q_PROPERTY(uint floatingPointPrecision READ getFloatingPointPrecision
               WRITE setFloatingPointPrecision)
    Q_PROPERTY(uint version READ getVersion WRITE setVersion)

    uint getStatus() const;
    QObject* getJsDevice();
    QVariant getTags();

    void setByteOrder(uint byteOrder);
    uint getByteOrder() const;

    void setFloatingPointPrecision(uint floatingPointPrecision);
    uint getFloatingPointPrecision() const;

    void setVersion(uint version);
    uint getVersion() const;

    Q_INVOKABLE void release();
    Q_INVOKABLE void resetStatus();


    Q_INVOKABLE QList<int> jReadBytes();
    Q_INVOKABLE bool jWriteBytes(const QList<int> data);

    Q_INVOKABLE QObject* zReadBytes();
    Q_INVOKABLE bool zWriteBytes(QObject* zByteArray);

    Q_INVOKABLE QList<int> jReadRawData(uint len);
    Q_INVOKABLE bool jWriteRawData(const QList<int> data);

    Q_INVOKABLE QObject* zReadRawData(uint len);
    Q_INVOKABLE bool zWriteRawData(QObject* zByteArray);

    Q_INVOKABLE uint skipRawData(uint len);

    Q_INVOKABLE quint8 readByte();
    Q_INVOKABLE qint16 readInt16();
    Q_INVOKABLE quint16 readUInt16();
    Q_INVOKABLE qint32 readInt32();
    Q_INVOKABLE quint32 readUInt32();
    Q_INVOKABLE qint64 readInt64();
    Q_INVOKABLE quint64 readUInt64();
    Q_INVOKABLE float readFloat();
    Q_INVOKABLE double readDouble();

    Q_INVOKABLE bool writeByte(quint8 data);
    Q_INVOKABLE bool writeInt16(qint16 data);
    Q_INVOKABLE bool writeUInt16(quint16 data);
    Q_INVOKABLE bool writeInt32(qint32 data);
    Q_INVOKABLE bool writeUInt32(quint32 data);
    Q_INVOKABLE bool writeInt64(qint64 data);
    Q_INVOKABLE bool writeUInt64(quint64 data);
    Q_INVOKABLE bool writeFloat(float data);
    Q_INVOKABLE bool writeDouble(double data);

signals:

public slots:

    void getQDevice(QIODevice** device); // for ZioDevice

protected:

    void validateData() const;
    void validateReadable() const;
    void validateWritable() const;

    void initZioDevice();
    void createTags();

    ZqIODevicePtr m_dv;

    ZqByteArrayPtr m_b;

    QDataStreamPtr m_ds;

    ZioDevice* m_zd;

    static QVariant m_tags;
};


} // Zbl




#endif // ZDATASTREAM_H