plonk_BinaryFile.h

/*
 -------------------------------------------------------------------------------
 This file is part of the Plink, Plonk, Plank libraries
  by Martin Robinson
 
 http://code.google.com/p/pl-nk/
 
 Copyright University of the West of England, Bristol 2011-14
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:
 
 * Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer.
 * Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in the
   documentation and/or other materials provided with the distribution.
 * Neither the name of University of the West of England, Bristol nor 
   the names of its contributors may be used to endorse or promote products
   derived from this software without specific prior written permission.
 
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 
 DISCLAIMED. IN NO EVENT SHALL UNIVERSITY OF THE WEST OF ENGLAND, BRISTOL BE 
 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
 CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE 
 GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 
 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 
 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 
 OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
 
 This software makes use of third party libraries. For more information see:
 doc/license.txt included in the distribution.
 -------------------------------------------------------------------------------
 */

#ifndef PLONK_BINARYFILE_H
#define PLONK_BINARYFILE_H

#include "../core/plonk_CoreForwardDeclarations.h"
#include "plonk_FilesForwardDeclarations.h"
#include "../core/plonk_SmartPointer.h"
#include "../core/plonk_WeakPointer.h"
#include "../core/plonk_SmartPointerContainer.h"
#include "../containers/plonk_Text.h"

class BinaryFileInternal : public SmartPointer
{
public:
    BinaryFileInternal() throw();
    BinaryFileInternal (Text const& path, 
                        const bool writable = false, 
                        const bool clearContents = false,
                        const bool bigEndian = false) throw();
    BinaryFileInternal (ByteArray const& bytes,
                        const bool writable = false) throw();
    BinaryFileInternal (FilePathArray const& fileArray, const int multiMode, const bool bigEndian) throw();
    BinaryFileInternal (BinaryFileQueue const& fileQueue, const bool bigEndian) throw();
    BinaryFileInternal (FilePathQueue const& fileQueue, const bool bigEndian) throw();

    explicit BinaryFileInternal (PlankFileRef fileRef) throw();

    ~BinaryFileInternal();
    
    void disownPeer (PlankFileRef fileRef) throw();
    
    static bool setupBytes (PlankFileRef p, ByteArray const& bytes, const bool writable) throw();
    static bool setupMulti (PlankFileRef p, FilePathArray const& fileArray, const int multiMode, const bool bigEndian, IntVariable* indexRef = 0) throw();
    static bool setupMulti (PlankFileRef p, BinaryFileQueue const& fileQueue, const bool bigEndian) throw();
    static bool setupMulti (PlankFileRef p, FilePathQueue const& fileQueue, const bool bigEndian) throw();

    static PlankResult dynamicMemoryOpenCallback (PlankFileRef p);
    static PlankResult dynamicMemoryCloseCallback (PlankFileRef p);
    static PlankResult dynamicMemoryClearCallback (PlankFileRef p);
    static PlankResult dynamicMemoryGetStatusCallback (PlankFileRef p, int type, int* status);
    static PlankResult dynamicMemoryReadCallback (PlankFileRef p, PlankP ptr, int maximumBytes, int* bytesReadOut);
    static PlankResult dynamicMemoryWriteCallback (PlankFileRef p, const void* data, const int maximumBytes);
    static PlankResult dynamicMemorySetPositionCallback (PlankFileRef p, PlankLL offset, int code);
    static PlankResult dynamicMemoryGetPositionCallback (PlankFileRef p, PlankLL* position);
    
    LongLong getPosition() const throw();
    void setPosition (const LongLong position) throw();
    
    void setEof() throw();
    bool isEof() const throw();
    
    bool isBigEndian() const throw();
    bool isLittleEndian() const throw();
    bool isNativeEndian() const throw();
    bool canRead() const throw();
    bool canWrite() const throw();

    int read (void* data, const int maximumBytes) throw();
    void read (char& value) throw();
        void read (short& value) throw();
    void read (int& value) throw();
    void read (Int24& value) throw();
    void read (LongLong& value) throw();
    void read (unsigned char& value) throw();
    void read (unsigned short& value) throw();
    void read (unsigned int& value) throw();
    void read (UnsignedLongLong& value) throw();
        void read (float& value) throw();
        void read (double& value) throw();
    
    template<class NumericalType>
    int read (NumericalArray<NumericalType>& array) throw();
    
    void write (void* data, const int maximumBytes) throw();
        void write (const char value) throw();
        void write (const short value) throw();
    void write (const int value) throw();
    void write (const Int24 value) throw();
    void write (const LongLong value) throw();
    void write (const unsigned char value) throw();
    void write (const unsigned short value) throw();
    void write (const unsigned int value) throw();
    void write (const UnsignedLongLong value) throw();
        void write (const float value) throw();
        void write (const double value) throw();
        
    template<class NumericalType>
    void write (NumericalArray<NumericalType> const& array) throw();

    ResultCode copy (BinaryFileInternal* source, const LongLong size) throw();
    
    friend class JSON;
    
    //private:
    inline PlankFileRef getPeerRef() { return static_cast<PlankFileRef> (&peer); }
    inline const PlankFileRef getPeerRef() const { return const_cast<const PlankFileRef> (&peer); }
    
private:
    PlankFile peer;
};

template<class NumericalType>
int BinaryFileInternal::read (NumericalArray<NumericalType>& array) throw()
{
    int bytesRead;
    plonk_assert (array.length() > 0);
    
    ResultCode result = pl_File_Read (getPeerRef(), 
                                      reinterpret_cast<void*> (array.getArray()), 
                                      sizeof (NumericalType) * array.length()
                                      &bytesRead);
    
    plonk_assert (result == PlankResult_OK || result == PlankResult_FileEOF); 
    
    if (sizeof (NumericalType) > 1 && !isNativeEndian())
        Endian::swap (array);
    
#ifndef PLONK_DEBUG
    (void)result;
#endif    
    
    return bytesRead;
}

template<class NumericalType>
void BinaryFileInternal::write (NumericalArray<NumericalType> const& array) throw()
{
    const int length = array.length();
    
    if (length > 0)
    {        
        if (isNativeEndian() || (sizeof(NumericalType) == 1))
        {
            ResultCode result = pl_File_Write (getPeerRef(), 
                                               reinterpret_cast<const void*> (array.getArray()), 
                                               sizeof (NumericalType) * length);
            
            plonk_assert (result == PlankResult_OK);
            
#ifndef PLONK_DEBUG
            (void)result;
#endif
        }
        else
        {
            const NumericalType* rawArray = array.getArray();
            
            for (int i = 0; i < length; ++i)
                write (rawArray[i]);
        }        
    }
}


class BinaryFile : public SmartPointerContainer<BinaryFileInternal>
{
public:
    typedef BinaryFileInternal                      Internal;
    typedef SmartPointerContainer<Internal>         Base;
    typedef WeakPointerContainer<BinaryFile>        Weak;
    
    enum MultiFileTypes
    {
        MultiFileUnknown = PLANKMULITFILE_MODE_UNKNOWN,
        MultiFileArraySequenceOnce = PLANKMULITFILE_MODE_ARRAYSEQUENCEONCE,
        MultiFileArraySequenceLoop = PLANKMULITFILE_MODE_ARRAYSEQUENCELOOP,
        MultiFileArrayRandom = PLANKMULITFILE_MODE_ARRAYRANDOM,
        MultiFileArrayRandomNoRepeat = PLANKMULITFILE_MODE_ARRAYRANDOMNOREPEAT,
        MultiFileArrayIndexRef = PLANKMULITFILE_MODE_ARRAYINDEXREF,
        MultiFileQueue = PLANKMULITFILE_MODE_QUEUE,
        MultiFileCustom = PLANKMULITFILE_MODE_CUSTOM
    };
    
    BinaryFile() throw()
    :   Base (new Internal())
    {
    }
    
        BinaryFile (Text const& path, const bool bigEndian = PLANK_BIGENDIAN) throw()
        :       Base (new Internal (path, false, false, bigEndian))
        {
        }
    
    BinaryFile (Text const& path, const bool writable, const bool clearContents, const bool bigEndian = PLANK_BIGENDIAN) throw()
        :       Base (new Internal (path, writable, clearContents, bigEndian))
        {
        }        
    
    BinaryFile (const char* path, const bool bigEndian = PLANK_BIGENDIAN) throw()
        :       Base (new Internal (path, false, false, bigEndian))
        {
        }
        
    BinaryFile (const char* path, const bool writable, const bool clearContents, const bool bigEndian = PLANK_BIGENDIAN) throw()
        :       Base (new Internal (path, writable, clearContents, bigEndian))
        {
        }
    
    BinaryFile (ByteArray const& bytes, const bool writable = false) throw()
        :       Base (new Internal (bytes, writable))
    {
    }
    
    BinaryFile (FilePathArray const& fileArray, const int multiMode, const bool bigEndian = PLANK_BIGENDIAN) throw()
    :   Base (new Internal (fileArray, multiMode, bigEndian))
    {
    }
    
    BinaryFile (BinaryFileQueue const& fileQueue, const bool bigEndian = PLANK_BIGENDIAN) throw()
    :   Base (new Internal (fileQueue, bigEndian))
    {
    }

    explicit BinaryFile (Internal* internalToUse) throw() 
        :       Base (internalToUse)
        {
        }
    
    explicit BinaryFile (PlankFileRef fileRef) throw()
        :       Base (new Internal (fileRef))
        {
        }

    BinaryFile (BinaryFile const& copy) throw()
    :   Base (static_cast<Base const&> (copy))
    {
    }
    
    BinaryFile& operator= (BinaryFile const& other) throw()
        {
                if (this != &other)
            this->setInternal (other.getInternal());
        
        return *this;
        }
        
    static BinaryFile fromWeak (Weak const& weak) throw()
    {
        return weak.fromWeak();
    }    
        
    inline LongLong getPosition() throw()
    {
        return getInternal()->getPosition();
    }
    
    inline void setPosition (const LongLong position) throw()
    {
        getInternal()->setPosition (position);
    }

    inline void setEof() throw()
    {
        getInternal()->setEof();
    }    
    
        inline bool isEof() const throw()
        {
                return getInternal()->isEof();
        }
    
    inline bool canRead() const throw()
    {
        return getInternal()->canRead();
    }

    inline bool canWrite() const throw()
    {
        return getInternal()->canWrite();
    }

    template<class ValueType>
    inline ValueType read() throw()
    {
        ValueType value;
        getInternal()->read (value);
        return value;
    }    
    
    template<class ValueType>
    void read (ValueType& value) throw()
    {
        getInternal()->read (value);
    }    
    
    template<class NumericalType>
    int read (NumericalArray<NumericalType>& array) throw()
    {
        return getInternal()->read (array);
    }
    
    template<class NumericalType>
    void write (NumericalArray<NumericalType> const& array) throw()
    {
        return getInternal()->write (array);
    }
    
    void disownPeer (PlankFileRef otherFile) throw()
    {
        getInternal()->disownPeer (otherFile);
    }

    template<class ValueType>
    void write (const ValueType value) throw()
    {
        getInternal()->write (value);
    }
    
    ResultCode copy (BinaryFile const& source, const LongLong size = 0) throw()
    {
        return getInternal()->copy (source.getInternal(), size);
    }
                
    static inline int chunkID (const char* const fourCharCode) throw()
    {
        plonk_assert (Text (fourCharCode).length() == 4);
        return pl_FourCharCode (fourCharCode);
    }
    
    PLONK_OBJECTARROWOPERATOR(BinaryFile);

};



#endif // PLONK_BINARYFILE_H