OgreDataStream.h

Go to the documentation of this file.

/*
-----------------------------------------------------------------------------
This source file is part of OGRE
(Object-oriented Graphics Rendering Engine)
For the latest info, see http://www.ogre3d.org/

Copyright (c) 2000-2005 The OGRE Team
Also see acknowledgements in Readme.html

This program is free software; you can redistribute it and/or modify it under
the terms of the GNU Lesser General Public License as published by the Free Software
Foundation; either version 2 of the License, or (at your option) any later
version.

This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with
this program; if not, write to the Free Software Foundation, Inc., 59 Temple
Place - Suite 330, Boston, MA 02111-1307, USA, or go to
http://www.gnu.org/copyleft/lesser.txt.
-----------------------------------------------------------------------------
*/
#ifndef __DataStream_H__
#define __DataStream_H__

#include "OgrePrerequisites.h"
#include "OgreString.h"
#include "OgreSharedPtr.h"
#include <istream>

namespace Ogre {

    class _OgreExport DataStream
    {
    protected:
        String mName;       
        size_t mSize;
        #define OGRE_STREAM_TEMP_SIZE 128

        char mTmpArea[OGRE_STREAM_TEMP_SIZE];
    public:
        DataStream() : mSize(0) {}
        DataStream(const String& name) : mName(name), mSize(0) {}
        const String& getName(void) { return mName; }
        virtual ~DataStream() {}
        // Streaming operators
        template<typename T> DataStream& operator>>(T& val);
        virtual size_t read(void* buf, size_t count) = 0;
        virtual size_t readLine(char* buf, size_t maxCount, const String& delim = "\n") = 0;
        
        virtual String getLine( bool trimAfter = true );

        virtual String getAsString(void);

        virtual size_t skipLine(const String& delim = "\n") = 0;

        virtual void skip(long count) = 0;
    
        virtual void seek( size_t pos ) = 0;
        
        virtual size_t tell(void) const = 0;

        virtual bool eof(void) const = 0;

        size_t size(void) const { return mSize; }

        virtual void close(void) = 0;
        

    };

    typedef SharedPtr<DataStream> DataStreamPtr;

    typedef std::list<DataStreamPtr> DataStreamList;
    typedef SharedPtr<DataStreamList> DataStreamListPtr;

    class _OgreExport MemoryDataStream : public DataStream
    {
    protected:
        uchar* mData;
        uchar* mPos;
        uchar* mEnd;
        bool mFreeOnClose;          
    public:
        
        MemoryDataStream(void* pMem, size_t size, bool freeOnClose = false);
        
        MemoryDataStream(const String& name, void* pMem, size_t size, 
                bool freeOnClose = false);

        MemoryDataStream(DataStream& sourceStream, 
                bool freeOnClose = true);
        
        MemoryDataStream(DataStreamPtr& sourceStream, 
                bool freeOnClose = true);

        MemoryDataStream(const String& name, DataStream& sourceStream, 
                bool freeOnClose = true);

        MemoryDataStream(const String& name, const DataStreamPtr& sourceStream, 
            bool freeOnClose = true);

        MemoryDataStream(size_t size, bool freeOnClose = true);
        MemoryDataStream(const String& name, size_t size, 
                bool freeOnClose = true);

        ~MemoryDataStream();

        uchar* getPtr(void) { return mData; }
        
        uchar* getCurrentPtr(void) { return mPos; }
        
        size_t read(void* buf, size_t count);
        size_t readLine(char* buf, size_t maxCount, const String& delim = "\n");
        
        size_t skipLine(const String& delim = "\n");

        void skip(long count);
    
        void seek( size_t pos );
        
        size_t tell(void) const;

        bool eof(void) const;

        void close(void);

        void setFreeOnClose(bool free) { mFreeOnClose = free; }
    };

    typedef SharedPtr<MemoryDataStream> MemoryDataStreamPtr;

    class _OgreExport FileStreamDataStream : public DataStream
    {
    protected:
        std::ifstream* mpStream;
        bool mFreeOnClose;          
    public:
        FileStreamDataStream(std::ifstream* s, 
            bool freeOnClose = true);
        FileStreamDataStream(const String& name, 
            std::ifstream* s, 
            bool freeOnClose = true);

        FileStreamDataStream(const String& name, 
            std::ifstream* s, 
            size_t size, 
            bool freeOnClose = true);

        ~FileStreamDataStream();

        size_t read(void* buf, size_t count);
        size_t readLine(char* buf, size_t maxCount, const String& delim = "\n");
        
        size_t skipLine(const String& delim = "\n");

        void skip(long count);
    
        void seek( size_t pos );

        size_t tell(void) const;

        bool eof(void) const;

        void close(void);
        
        
    };

    class _OgreExport FileHandleDataStream : public DataStream
    {
    protected:
        FILE* mFileHandle;
    public:
        FileHandleDataStream(FILE* handle);
        FileHandleDataStream(const String& name, FILE* handle);
        ~FileHandleDataStream();

        size_t read(void* buf, size_t count);
        size_t readLine(char* buf, size_t maxCount, const String& delim = "\n");
        
        size_t skipLine(const String& delim = "\n");

        void skip(long count);
    
        void seek( size_t pos );

        size_t tell(void) const;

        bool eof(void) const;

        void close(void);

    };
}
#endif

---

Copyright © 2000-2005 by The OGRE Team

This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sun Mar 12 14:37:40 2006