ZioDevice.h

Go to the documentation of this file.

/*
* Zuble - A run-time system for QML/Javascript applications
* Copyright (C) 2013, 2014  Bob Dinitto
*
* Filename:   ZioDevice.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 ZIODEVICE_H
#define ZIODEVICE_H

#include <QObject>
#include <QIODevice>
#include <QVariant>
#include "zblcore_global.h"

namespace Zbl {

class ZioDevice : public QObject
{
    Q_OBJECT
    Q_ENUMS(OpenMode)
public:

    enum OpenMode {
        NotOpen = QIODevice::NotOpen,
        ReadOnly = QIODevice::ReadOnly,
        WriteOnly = QIODevice::WriteOnly,
        ReadWrite = QIODevice::ReadWrite,
        Append = QIODevice::Append,
        Truncate = QIODevice::Truncate,
        Text = QIODevice::Text,
        Unbuffered = QIODevice::Unbuffered
    };
    Q_DECLARE_FLAGS(OpenModes, OpenMode)


    explicit ZioDevice(QObject *parent = 0);


    static void registerType();

    Q_PROPERTY(bool isOpen READ isOpen)

    
    Q_PROPERTY(int openMode READ openMode)

    Q_PROPERTY(bool textMode READ getTextMode WRITE setTextMode)


    Q_PROPERTY(bool isSequential READ isSequential)

    Q_PROPERTY(bool writable READ isWritable)

    Q_PROPERTY(bool readable READ isReadable)

    Q_PROPERTY(bool atEnd READ atEnd)



    Q_PROPERTY(qint64 size READ size)

    Q_PROPERTY(qint64 pos READ pos)

    Q_PROPERTY(qint64 bytesAvailable READ bytesAvailable)

    Q_PROPERTY(qint64 bytesToWrite READ bytesToWrite)


    Q_PROPERTY(QString errorString READ getErrorString)
    Q_PROPERTY(QVariant tags READ getTags CONSTANT)


    bool isOpen() const;
    int openMode() const;
    bool getTextMode() const;
    void setTextMode(bool textModeEnabled);
    bool isSequential();
    bool isWritable() const;
    bool isReadable() const;
    bool atEnd() const;

    qint64 size() const;
    qint64 pos() const;
    qint64 bytesAvailable() const;
    qint64 bytesToWrite() const;

    QVariant getTags();

    QString getErrorString();

    Q_INVOKABLE bool seek(qint64 pos);

    Q_INVOKABLE qint64 writeString(const QString& text);

    Q_INVOKABLE qint64 writeBytes(const QObject* data);


    Q_INVOKABLE bool waitForBytesWritten(int msecs);

    Q_INVOKABLE bool waitForReadyRead(int msecs);

    Q_INVOKABLE void reset();

    Q_INVOKABLE void close();


signals:

    void getCurrentDevice(QIODevice** device) const;

public slots:


protected:

    QIODevice* connectedDevice() const;

    void createTags();

    static QVariant m_tags;
};

} // Zbl

#endif // ZIODEVICE_H