ZTextStream.h

Go to the documentation of this file.

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

#include "ZFile.h"
#include "zblcore_global.h"
#include <QObject>
#include <QTextStream>

namespace Zbl
{
class ZTextStream : public QObject
{
    Q_OBJECT
    Q_ENUMS(RealNumberNotation)
    Q_ENUMS(FieldAlignment)
    Q_ENUMS(Status)
    Q_ENUMS(NumberFlag)
public:

    typedef QSharedPointer<QTextStream> QTextStreamPtr;


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

    enum RealNumberNotation {
        SmartNotation = QTextStream::SmartNotation,
        FixedNotation = QTextStream::FixedNotation,
        ScientificNotation = QTextStream::ScientificNotation
    };

    enum FieldAlignment {
        AlignLeft = QTextStream::AlignLeft,
        AlignRight = QTextStream::AlignRight,
        AlignCenter = QTextStream::AlignCenter,
        AlignAccountingStyle = QTextStream::AlignAccountingStyle
    };

    enum Status {
        Ok = QTextStream::Ok,
        ReadPastEnd = QTextStream::ReadPastEnd,
        ReadCorruptData = QTextStream::ReadCorruptData,
        WriteFailed = QTextStream::WriteFailed
    };


    enum NumberFlag {
        ShowBase =QTextStream::ShowBase,
        ForcePoint = QTextStream::ForcePoint,
        ForceSign = QTextStream::ForceSign,
        UppercaseBase =  QTextStream::UppercaseBase,
        UppercaseDigits = QTextStream::UppercaseDigits
    };
    Q_DECLARE_FLAGS(NumberFlags, NumberFlag)



    explicit ZTextStream(QObject *parent = nullptr);
    explicit ZTextStream(const ZqIODevicePtr device, QObject *parent = nullptr);
    explicit ZTextStream(const ZqStringPtr string, QObject *parent = nullptr);

    virtual ~ZTextStream();

    static void registerType();

    Q_PROPERTY(QVariant tags READ getTags)

    
    Q_PROPERTY(QObject* device READ getJsDevice)


    Q_PROPERTY(bool autoDetectUnicode READ
               getAutoDetectUnicode WRITE setAutoDetectUnicode)

    Q_PROPERTY(bool atEnd READ atEnd)
    Q_PROPERTY(QVariant pos READ pos)

    Q_PROPERTY(uint status READ getStatus)
    Q_PROPERTY(uint fieldAlignment READ getFieldAlignment WRITE setFieldAlignment)
    Q_PROPERTY(uint padChar READ getPadChar WRITE setPadChar)
    Q_PROPERTY(int fieldWidth READ getFieldWidth WRITE setFieldWidth)
    Q_PROPERTY(uint numberFlags READ getNumberFlags WRITE setNumberFlags)
    Q_PROPERTY(int integerBase READ getIntegerBase WRITE setIntegerBase)
    Q_PROPERTY(uint realNumberNotation READ getRealNumberNotation WRITE setRealNumberNotation)
    Q_PROPERTY(int realNumberPrecision READ getRealNumberPrecision WRITE setRealNumberPrecision)
    Q_PROPERTY(QString string READ getString)

    QVariant getTags();
    QObject* getJsDevice();

    bool getAutoDetectUnicode() const;
    void setAutoDetectUnicode(bool autoDetectOn);
    uint getStatus() const;
    bool atEnd() const;
    QVariant pos() const;
    void setFieldAlignment(uint alignment);
    uint getFieldAlignment() const;
    void setPadChar(uint ch);
    uint getPadChar() const;
    void setFieldWidth(int width);
    int getFieldWidth() const;
    void setNumberFlags(uint flags);
    uint getNumberFlags() const;
    void setIntegerBase(int base);
    int getIntegerBase() const;
    void setRealNumberNotation(uint notation);
    uint getRealNumberNotation() const;
    void setRealNumberPrecision(int precision);
    int getRealNumberPrecision() const;
    QString getString() const;

    Q_INVOKABLE void release();
    Q_INVOKABLE void resetStatus();
    Q_INVOKABLE void reset();
    Q_INVOKABLE void flush();
    Q_INVOKABLE bool seek(QVariant pos); // tbd: should this be an integer type?
    Q_INVOKABLE void skipWhiteSpace();
    Q_INVOKABLE void setLocale(const QString &locale);

    Q_INVOKABLE QString read(qint64 maxSize);
    Q_INVOKABLE QString readLine(qint64 maxSize);
    Q_INVOKABLE QString readAll();
    Q_INVOKABLE uint readChar();
    Q_INVOKABLE signed short readShort();
    Q_INVOKABLE unsigned short readUShort();
    Q_INVOKABLE signed int readInt();
    Q_INVOKABLE unsigned int readUInt();
    Q_INVOKABLE signed long readLong();
    Q_INVOKABLE unsigned long readULong();
    Q_INVOKABLE qlonglong readLongLong();
    Q_INVOKABLE qulonglong readULongLong();
    Q_INVOKABLE float readFloat();
    Q_INVOKABLE double readDouble();
    Q_INVOKABLE QString readString();
    Q_INVOKABLE QObject* readBytes();

    Q_INVOKABLE bool writeLine(const QString& text);
    Q_INVOKABLE bool writeChar(uint data);
    Q_INVOKABLE bool writeShort(signed short data);
    Q_INVOKABLE bool writeUShort(unsigned short data);
    Q_INVOKABLE bool writeInt(signed int data);
    Q_INVOKABLE bool writeUInt(unsigned int data);
    Q_INVOKABLE bool writeLong(signed long data);
    Q_INVOKABLE bool writeULong(unsigned long data);
    Q_INVOKABLE bool writeLongLong(qlonglong data);
    Q_INVOKABLE bool writeULongLong(qulonglong data);
    Q_INVOKABLE bool writeFloat(float data);
    Q_INVOKABLE bool writeDouble(double data);
    Q_INVOKABLE bool writeString(const QString& text);
    Q_INVOKABLE bool writeBytes(QObject* data);

signals:

public slots:

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

protected:

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

    ZqIODevicePtr m_d;

    //QTextStreamPtr m_t;
    QTextStream* m_t;

    ZqStringPtr m_s;

    ZioDevice* m_zd;


    //QFile* m_f;

    static QVariant m_tags;
};


} // Zbl


#endif // ZTEXTSTREAM_H