file.h

Go to the documentation of this file.

/*
**  ClanLib SDK
**  Copyright (c) 1997-2005 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 link to may have additional
**  requirements or restrictions.
**
**  File Author(s):
**
**    Magnus Norddahl
*/

#ifndef header_file
#define header_file

#include "iodevice.h"
#include "bytearray.h"

class CL_SecurityDescriptor;

class CL_File : public CL_IODevice
{
public:
        enum AccessFlags
        {
                access_read  = 1,
                access_write = 2
        };
        
        enum ShareFlags
        {
                share_read   = 1,
                share_write  = 2,
                share_delete = 4,
                share_all    = share_read + share_write + share_delete
        };
        
        enum OpenMode
        {
                open_always,
                open_existing,
                open_existing_truncate
        };
        
        enum CreateMode
        {
                create_always,
                create_new
        };

public:
        CL_File();
        
        CL_File(
                const CL_String &filename,
                CreateMode mode,
                unsigned int access = access_read | access_write,
                unsigned int share = share_all);

        CL_File(
                const CL_String &filename,
                CreateMode mode,
                const CL_SecurityDescriptor &permissions,
                unsigned int access = access_read | access_write,
                unsigned int share = share_all);

        CL_File(
                const CL_String &filename,
                OpenMode mode = open_existing,
                unsigned int access = access_read | access_write,
                unsigned int share = share_all);

        CL_File(
                const CL_String &filename,
                OpenMode mode,
                const CL_SecurityDescriptor &permissions,
                unsigned int access = access_read | access_write,
                unsigned int share = share_all);

        ~CL_File();

public:
        int get_size() const;
        
        int get_position() const;
        
        CL_SecurityDescriptor get_permissions() const;

public:
        bool create(
                const CL_String &filename,
                CreateMode mode = create_always,
                unsigned int access = access_read | access_write,
                unsigned int share = share_all);

        bool create(
                const CL_String &filename,
                CreateMode mode,
                const CL_SecurityDescriptor &permissions,
                unsigned int access = access_read | access_write,
                unsigned int share = share_all);

        bool open(
                const CL_String &filename,
                OpenMode mode = open_existing,
                unsigned int access = access_read | access_write,
                unsigned int share = share_all);

        bool open(
                const CL_String &filename,
                OpenMode mode,
                const CL_SecurityDescriptor &permissions,
                unsigned int access = access_read | access_write,
                unsigned int share = share_all);
        
        void close();
        
        bool set_permissions(const CL_SecurityDescriptor &permissions);
        
        int read(void *buffer, int size, bool read_all = true);

        int write(const void *buffer, int size, bool write_all = true);

        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);

private:
        int lowlevel_read(void *buffer, int size, bool read_all);

#ifdef WIN32
        HANDLE handle;
#else
        int handle;
#endif
        CL_ByteArray peeked_data;
};

#endif

---