OutputStream.h

Go to the documentation of this file.

/*
  ==============================================================================
 
   This file is part of the Water library.
   Copyright (c) 2016 ROLI Ltd.
   Copyright (C) 2017-2022 Filipe Coelho <falktx@falktx.com>
 
   Permission is granted to use this software under the terms of the ISC license
   http://www.isc.org/downloads/software-support-policy/isc-license/
 
   Permission to use, copy, modify, and/or distribute this software for any
   purpose with or without fee is hereby granted, provided that the above
   copyright notice and this permission notice appear in all copies.
 
   THE SOFTWARE IS PROVIDED "AS IS" AND ISC DISCLAIMS ALL WARRANTIES WITH REGARD
   TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
   FITNESS. IN NO EVENT SHALL ISC BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT,
   OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF
   USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
   TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
   OF THIS SOFTWARE.
 
  ==============================================================================
*/
 
#ifndef WATER_OUTPUTSTREAM_H_INCLUDED
#define WATER_OUTPUTSTREAM_H_INCLUDED
 
#include "../water.h"
#include "../text/String.h"
 
namespace water {
 
//==============================================================================
class OutputStream
{
protected:
    //==============================================================================
    OutputStream();
 
public:
    virtual ~OutputStream();
 
    //==============================================================================
    virtual void flush() = 0;

    virtual bool setPosition (int64 newPosition) = 0;

    virtual int64 getPosition() = 0;
 
    //==============================================================================
    virtual bool write (const void* dataToWrite,
                        size_t numberOfBytes) = 0;
 
    //==============================================================================
    virtual bool writeByte (char byte);

    virtual bool writeBool (bool boolValue);

    virtual bool writeShort (short value);

    virtual bool writeShortBigEndian (short value);

    virtual bool writeInt (int value);

    virtual bool writeIntBigEndian (int value);

    virtual bool writeInt64 (int64 value);

    virtual bool writeInt64BigEndian (int64 value);

    virtual bool writeFloat (float value);

    virtual bool writeFloatBigEndian (float value);

    virtual bool writeDouble (double value);

    virtual bool writeDoubleBigEndian (double value);

    virtual bool writeRepeatedByte (uint8 byte, size_t numTimesToRepeat);

    virtual bool writeCompressedInt (int value);

    virtual bool writeString (const String& text);

    virtual bool writeText (const String& text,
                            bool asUTF16,
                            bool writeUTF16ByteOrderMark);

    virtual int64 writeFromInputStream (InputStream& source, int64 maxNumBytesToWrite);
 
    //==============================================================================
    void setNewLineString (const String& newLineString);

    const String& getNewLineString() const noexcept         { return newLineString; }
 
private:
    //==============================================================================
    String newLineString;
 
    CARLA_DECLARE_NON_COPYABLE (OutputStream)
};
 
//==============================================================================
OutputStream& operator<< (OutputStream& stream, int number);

OutputStream& operator<< (OutputStream& stream, int64 number);

OutputStream& operator<< (OutputStream& stream, double number);

OutputStream& operator<< (OutputStream& stream, char character);

OutputStream& operator<< (OutputStream& stream, const char* text);

OutputStream& operator<< (OutputStream& stream, const MemoryBlock& data);

OutputStream& operator<< (OutputStream& stream, const File& fileToRead);

OutputStream& operator<< (OutputStream& stream, InputStream& streamToRead);

OutputStream& operator<< (OutputStream& stream, const NewLine&);
 
}
 
#endif // WATER_OUTPUTSTREAM_H_INCLUDED