iodevice.h

Go to the documentation of this file.

/*
**  ClanLib SDK
**  Copyright (c) 1997-2009 The ClanLib Team
**
**  This software is provided 'as-is', without any express or implied
**  warranty.  In no event will the authors be held liable for any damages
**  arising from the use of this software.
**
**  Permission is granted to anyone to use this software for any purpose,
**  including commercial applications, and to alter it and redistribute it
**  freely, subject to the following restrictions:
**
**  1. The origin of this software must not be misrepresented; you must not
**     claim that you wrote the original software. If you use this software
**     in a product, an acknowledgment in the product documentation would be
**     appreciated but is not required.
**  2. Altered source versions must be plainly marked as such, and must not be
**     misrepresented as being the original software.
**  3. This notice may not be removed or altered from any source distribution.
**
**  Note: Some of the libraries ClanLib may link to may have additional
**  requirements or restrictions.
**
**  File Author(s):
**
**    Magnus Norddahl
**    Mark Page
*/


#pragma once

#include "../api_core.h"
#include "datatypes.h"
#include "../System/sharedptr.h"

class CL_IODeviceProvider;
class CL_IODevice_Impl;

class CL_API_CORE CL_IODevice
{

public:
        enum SeekMode
        {
                seek_set,

                seek_cur,

                seek_end
        };


public:
        CL_IODevice();

        CL_IODevice(CL_IODeviceProvider *provider);

        ~CL_IODevice();


public:
        bool is_null() const;
        

        int get_size() const;


        int get_position() const;


        bool is_little_endian() const;


public:

        int send(const void *data, int len, bool send_all = true);

        int receive(void *data, int len, bool receive_all = true);

        int peek(void *data, int len);

        bool seek(int position, SeekMode mode = seek_set);

        int read(void *data, int len, bool receive_all = true);

        int write(const void *data, int len, bool send_all = true);

        void set_system_mode();

        void set_big_endian_mode();

        void set_little_endian_mode();

        void write_int64(cl_int64 data);

        void write_uint64(cl_uint64 data);

        void write_int32(cl_int32 data);

        void write_uint32(cl_uint32 data);

        void write_int16(cl_int16 data);

        void write_uint16(cl_uint16 data);

        void write_int8(cl_int8 data);

        void write_uint8(cl_uint8 data);

        void write_float(float data);

        void write_string_a(const CL_StringRef8 &str);


        cl_int64 read_int64();


        cl_uint64 read_uint64();


        cl_int32 read_int32();


        cl_uint32 read_uint32();


        cl_int16 read_int16();


        cl_uint16 read_uint16();


        cl_int8 read_int8();


        cl_uint8 read_uint8();


        float read_float();


        CL_String8 read_string_a();


        CL_String8 read_string_nul();

        CL_String8 read_string_text(const char *skip_initial_chars, const char *read_until_chars, bool allow_eof = true);

        CL_IODevice duplicate();


protected:
        CL_SharedPtr<CL_IODevice_Impl> impl;
};

---