juce_InputStream.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  InputStream
{
public:
    virtual ~InputStream() = default;
 
    //==============================================================================
    virtual int64 getTotalLength() = 0;

    int64 getNumBytesRemaining();

    virtual bool isExhausted() = 0;
 
    //==============================================================================
    virtual int read (void* destBuffer, int maxBytesToRead) = 0;
 
    ssize_t read (void* destBuffer, size_t maxBytesToRead);

    virtual char readByte();

    virtual bool readBool();

    virtual short readShort();

    virtual short readShortBigEndian();

    virtual int readInt();

    virtual int readIntBigEndian();

    virtual int64 readInt64();

    virtual int64 readInt64BigEndian();

    virtual float readFloat();

    virtual float readFloatBigEndian();

    virtual double readDouble();

    virtual double readDoubleBigEndian();

    virtual int readCompressedInt();
 
    //==============================================================================
    virtual String readNextLine();

    virtual String readString();

    virtual String readEntireStreamAsString();

    virtual size_t readIntoMemoryBlock (MemoryBlock& destBlock,
                                        ssize_t maxNumBytesToRead = -1);
 
    //==============================================================================
    virtual int64 getPosition() = 0;

    virtual bool setPosition (int64 newPosition) = 0;

    virtual void skipNextBytes (int64 numBytesToSkip);
 
 
protected:
    //==============================================================================
    InputStream() = default;
 
private:
    JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR (InputStream)
};
 
} // namespace juce