file.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
*/


#pragma once

#include "../api_core.h"
#include "iodevice.h"

class CL_SecurityDescriptor;

class CL_API_CORE CL_File : public CL_IODevice
{

public:

        enum AccessFlags
        {
                access_read  = 1,

                access_write = 2,

                access_read_write = access_read | access_write
        };

        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,

                create_always,

                create_new
        };

        enum Flags
        {
                flag_write_through   = 1,
                flag_no_buffering    = 2,
                flag_random_access   = 4,
                flag_sequential_scan = 8
        };


public:
        CL_File();

        CL_File(
                const CL_String &filename);

        CL_File(
                const CL_String &filename,
                OpenMode mode,
                unsigned int access,
                unsigned int share = share_all,
                unsigned int flags = 0);

        CL_File(
                const CL_String &filename,
                OpenMode mode,
                const CL_SecurityDescriptor &permissions,
                unsigned int access,
                unsigned int share = share_all,
                unsigned int flags = 0);

        ~CL_File();


public:
        CL_SecurityDescriptor get_permissions() const;


public:
        bool open(
                const CL_String &filename);

        bool open(
                const CL_String &filename,
                OpenMode mode,
                unsigned int access,
                unsigned int share = share_all,
                unsigned int flags = 0);

        bool open(
                const CL_String &filename,
                OpenMode mode,
                const CL_SecurityDescriptor &permissions,
                unsigned int access,
                unsigned int share = share_all,
                unsigned int flags = 0);

        void close();

        bool set_permissions(const CL_SecurityDescriptor &permissions);


private:
};

---