FileOutputStream.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_FILEOUTPUTSTREAM_H_INCLUDED
#define WATER_FILEOUTPUTSTREAM_H_INCLUDED
 
#include "../files/File.h"
#include "../memory/HeapBlock.h"
#include "../streams/OutputStream.h"
 
namespace water {
 
//==============================================================================
class FileOutputStream  : public OutputStream
{
public:
    //==============================================================================
    FileOutputStream (const File& fileToWriteTo,
                      size_t bufferSizeToUse = 16384);

    ~FileOutputStream();
 
    //==============================================================================
    const File& getFile() const                         { return file; }

    const Result& getStatus() const noexcept            { return status; }

    bool failedToOpen() const noexcept                  { return status.failed(); }

    bool openedOk() const noexcept                      { return status.wasOk(); }

    Result truncate();
 
    //==============================================================================
    void flush() override;
    int64 getPosition() override;
    bool setPosition (int64) override;
    bool write (const void*, size_t) override;
    bool writeRepeatedByte (uint8 byte, size_t numTimesToRepeat) override;
 
 
private:
    //==============================================================================
    File file;
    void* fileHandle;
    Result status;
    int64 currentPosition;
    size_t bufferSize, bytesInBuffer;
    HeapBlock<char> buffer;
 
    void openHandle();
    void closeHandle();
    void flushInternal();
    bool flushBuffer();
    int64 setPositionInternal (int64);
    ssize_t writeInternal (const void*, size_t);
 
    CARLA_DECLARE_NON_COPYABLE (FileOutputStream)
};
 
}
 
#endif // WATER_FILEOUTPUTSTREAM_H_INCLUDED