plonk_TextFile.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_TEXTFILE_H
#define PLONK_TEXTFILE_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 TextFileInternal : public SmartPointer
{
public:
    TextFileInternal() throw();
    TextFileInternal (Text const& path, 
                      const bool writable = false, 
                      const bool clearContents = false) throw();
    TextFileInternal (FilePathArray const& fileArray, const int multiMode) throw();
    TextFileInternal (TextFileQueue const& fileQueue) throw();

    ~TextFileInternal();
    
    LongLong getPosition() const throw();
    void setPosition (const LongLong position) throw();
    
    void setEof() throw();
    bool isEof() const throw();
    bool canRead() const throw();
    bool canWrite() const throw();

    Text readLine (const int maximumLength = 1024) throw();
    Text readAll() throw();
    Text read (const int numBytes) throw();
    
        void writeValue (const char value) throw();
        void writeValue (const short value) throw();
    void writeValue (const int value) throw();
        void writeValue (const long value) throw();
    void writeValue (const LongLong value) throw();
    void writeValue (const unsigned char value) throw();
    void writeValue (const unsigned short value) throw();
    void writeValue (const unsigned int value) throw();
        void writeValue (const unsigned long value) throw();
    void writeValue (const UnsignedLongLong value) throw();
        void writeValue (const float value) throw();
        void writeValue (const double value) throw();
        void write (const char* text) throw();
        void writeLine (const char* text) throw();
    
    void disownPeer (PlankFileRef otherFile) throw();

private:
    inline PlankFileRef getPeerRef() { return static_cast<PlankFileRef> (&peer); }
    inline const PlankFileRef getPeerRef() const { return const_cast<const PlankFileRef> (&peer); }
    
    PlankFile peer;
};

class TextFile : public SmartPointerContainer<TextFileInternal>
{
public:
    typedef TextFileInternal                        Internal;
    typedef SmartPointerContainer<Internal>         Base;
    typedef WeakPointerContainer<TextFile>          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
    };
    
    TextFile() throw()
    :   Base (new Internal())
    {
    }
    
        TextFile (Text const& path) throw()
        :       Base (new Internal (path))
        {
        }
    
    TextFile (Text const& path, const bool writable, const bool clearContents = false) throw()
        :       Base (new Internal (path, writable, clearContents))
        {
        }    
    
    TextFile (const char* path) throw()
        :       Base (new Internal (path))
        {
        }
    
    TextFile (const char* path, const bool writable, const bool clearContents = false) throw()
        :       Base (new Internal (path, writable, clearContents))
        {
        }
    
    TextFile (FilePathArray const& fileArray, const int multiMode) throw()
    :   Base (new Internal (fileArray, multiMode))
    {
    }
    
    TextFile (TextFileQueue const& fileQueue) throw()
    :   Base (new Internal (fileQueue))
    {
    }
        
    explicit TextFile (Internal* internalToUse) throw() 
        :       Base (internalToUse)
        {
        }    
    
    TextFile (TextFile const& copy) throw()
    :   Base (static_cast<Base const&> (copy))
    {
    }
    
    TextFile& operator= (TextFile const& other) throw()
        {
                if (this != &other)
            this->setInternal (other.getInternal());//this->setInternal (other.containerCopy().getInternal());
        
        return *this;
        }
        
    static TextFile fromWeak (Weak const& weak) throw()
    {
        return weak.fromWeak();
    }    
    
        Text readLine (const int maximumLength = 1024) throw()
        {
        return getInternal()->readLine (maximumLength);
        }
        
        Text readAll() throw()
        {
                return getInternal()->readAll();
        }
    
    Text read (const int numBytes) throw()
        {
                return getInternal()->read (numBytes);
        }
        
    LongLong getPosition() const throw()
    {
        return getInternal()->getPosition();
    }
    
    void setPosition (const LongLong position) throw()
    {
        getInternal()->setPosition (position);
    }

    void setEof() throw()
    {
        getInternal()->setEof();
    }    
    
        bool isEof() const throw()
        {
                return getInternal()->isEof();
        }
    
    template<class ValueType>
    void writeValue (const ValueType value) throw()
    {
        getInternal()->writeValue (value);
    }
        
        void write (const char* text) throw()
    {
        getInternal()->write (text);
    }
    
    void write (Text const& text) throw()
    {
        getInternal()->write (text.getArray());
    }    
    
        void writeLine (const char* text) throw()
    {
        getInternal()->writeLine (text);
    }
    
    void writeLine (Text const& text) throw()
    {
        getInternal()->writeLine (text.getArray());
    }    
    
    void disownPeer (PlankFileRef otherFile) throw()
    {
        getInternal()->disownPeer (otherFile);
    }
    
    PLONK_OBJECTARROWOPERATOR(TextFile);

};



#endif // PLONK_TEXTFILE_H