juce_OutputStream.h

Go to the documentation of this file.

/*
  ==============================================================================
 
   This file is part of the JUCE library.
   Copyright (c) 2022 - Raw Material Software Limited
 
   JUCE is an open source library subject to commercial or open-source
   licensing.
 
   The code included in this file is provided 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.
 
   JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
   EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
   DISCLAIMED.
 
  ==============================================================================
*/
 
namespace juce
{
 
//==============================================================================
class JUCE_API  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,
                            const char* lineEndings);

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

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

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

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

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

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

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

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

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

JUCE_API OutputStream& JUCE_CALLTYPE operator<< (OutputStream& stream, const NewLine&);
 
} // namespace juce