---

inputsource_memory_generic.h

Go to the documentation of this file.

/*
        $Id: inputsource_memory_generic.h,v 1.3 2001/01/11 00:30:32 plasmoid Exp $

        ------------------------------------------------------------------------
        ClanLib, the platform independent game SDK.

        This library is distributed under the GNU LIBRARY GENERAL PUBLIC LICENSE
        version 2. See COPYING for details.

        For a total list of contributers see CREDITS.

        ------------------------------------------------------------------------
*/

#ifndef header_inputsource_memory_generic
#define header_inputsource_memory_generic

#include "API/Core/IOData/inputsource.h"
#include "API/Core/IOData/inputsource_provider.h"

class CL_OutputSource_MemoryGeneric;

class CL_InputSource_MemoryGeneric : public CL_InputSource
//: Interface to read data from a memory_generic source.
// CL_InputSource_MemoryGeneric is used to read data from a memory_generic source.
{
public:
        CL_InputSource_MemoryGeneric(void *data, int size, bool delete_data = false);
  CL_InputSource_MemoryGeneric(const CL_InputSource_MemoryGeneric *MG);
  //: MemoryGeneric copy constructor.
  //Makes a seperate copy of the memory in MG.

        virtual ~CL_InputSource_MemoryGeneric();

        virtual void set_system_mode();
        //: Changes input data endianess to the local systems mode.

        virtual void set_big_endian_mode();
        //: Changes input data endianess to big endian mode.

        virtual void set_little_endian_mode();
        //: Changes input data endianess to little endian mode. This is the 
        //: default setting.

        virtual int read_int32();
        //: Reads a signed 32 bit integer from input source.

        virtual unsigned int read_uint32();
        //: Reads a unsigned 32 bit integer from input source.

        virtual short read_short16();
        //: Reads a signed 16 bit integer (short) from input source.

        virtual unsigned short read_ushort16();
        //: Reads a unsigned 16 bit integer (short) from input source.

        virtual char read_char8();
        //: Reads a signed 8 bit integer (char) from input source.

        virtual unsigned char read_uchar8();
        //: Reads a unsigned 8 bit integer (char) from input source.

        virtual float read_float32();
        //: Reads an ieee format floating point from input source.

        virtual bool read_bool();
        //: Reads a bool from input source.

        virtual int read(void *data, int size);
        //: Reads larger amounts of data (no endian and 64 bit conversion).
        
        virtual void open();
        //: Opens the input source. By default, it is open.
        
        virtual void close();
        //: Closes the input source.

        virtual CL_InputSource *clone() const;
        //: Make a copy of the current InputSource, standing at the same position.

        virtual int tell() const;
        //: Returns current position in input source.

        virtual void seek(int pos, SeekEnum seek_type);
        //: Seeks to the specified position in the input source.

        virtual int size() const;
        //: Returns the size of the input source

        virtual std::string read_string();
        //: Reads a string from the input source.

        virtual void push_position();
        //: Pushes the current input source position. The position can be restored again with pop_position.
        
        virtual void pop_position();
        //: Pops a previous pushed input source position (returns to the position).

  virtual void purge();
  //: Purges the input buffer of data without deleting the buffer

private:
        unsigned char *m_data;
        unsigned int m_pos, m_size;
        bool m_delete_data;
};

class CL_InputSourceProvider_Memory : public CL_InputSourceProvider {
  unsigned char *m_data;
  unsigned int m_size;
  bool m_delete_data;
public:
  CL_InputSourceProvider_Memory(unsigned char *data, unsigned int size, bool delete_data);
  CL_InputSourceProvider_Memory(CL_InputSource_MemoryGeneric *MG);
  CL_InputSourceProvider_Memory(CL_OutputSource_MemoryGeneric *MG);
  virtual CL_InputSource *open_source(const char *handle);
        virtual CL_InputSourceProvider *clone();

};
#endif

---