Download
Documentation
Development
Examples
Donations
Contributions
Forum
Main Page
Related Pages
Modules
Classes
Sources
API
Core
IOData
file_system_provider.h
1
/*
2
** ClanLib SDK
3
** Copyright (c) 1997-2013 The ClanLib Team
4
**
5
** This software is provided 'as-is', without any express or implied
6
** warranty. In no event will the authors be held liable for any damages
7
** arising from the use of this software.
8
**
9
** Permission is granted to anyone to use this software for any purpose,
10
** including commercial applications, and to alter it and redistribute it
11
** freely, subject to the following restrictions:
12
**
13
** 1. The origin of this software must not be misrepresented; you must not
14
** claim that you wrote the original software. If you use this software
15
** in a product, an acknowledgment in the product documentation would be
16
** appreciated but is not required.
17
** 2. Altered source versions must be plainly marked as such, and must not be
18
** misrepresented as being the original software.
19
** 3. This notice may not be removed or altered from any source distribution.
20
**
21
** Note: Some of the libraries ClanLib may link to may have additional
22
** requirements or restrictions.
23
**
24
** File Author(s):
25
**
26
** Magnus Norddahl
27
** Harry Storbacka
28
*/
29
30
31
#pragma once
32
33
#include "../api_core.h"
34
#include <memory>
35
#include "file.h"
36
37
namespace
clan
38
{
41
42
class
IODevice;
43
class
DirectoryListingEntry;
44
46
class
CL_API_CORE
FileSystemProvider
47
{
50
51
public
:
52
virtual
~FileSystemProvider
() {
return
; }
53
57
58
public
:
59
63
64
public
:
66
72
virtual
IODevice
open_file(
const
std::string &filename,
73
File::OpenMode
mode =
File::open_existing
,
74
unsigned
int
access =
File::access_read
|
File::access_write
,
75
unsigned
int
share =
File::share_all
,
76
unsigned
int
flags = 0) = 0;
77
79
virtual
bool
initialize_directory_listing(
const
std::string &path) = 0;
80
82
virtual
bool
next_file(
DirectoryListingEntry
&entry) = 0;
83
85
virtual
std::string get_path()
const
= 0;
86
91
virtual
std::string get_identifier()
const
= 0;
92
96
97
private
:
99
};
100
101
}
102
clan::File::access_write
Generic write access.
Definition:
file.h:71
clan::IODevice
I/O Device interface.
Definition:
iodevice.h:51
clan::FileSystemProvider::~FileSystemProvider
virtual ~FileSystemProvider()
Definition:
file_system_provider.h:52
clan::File::access_read
Generic read access.
Definition:
file.h:68
clan::File::open_existing
Open existing file. Fails if it does not exist.
Definition:
file.h:100
clan::File::share_all
All other sharing flags combined.
Definition:
file.h:90
clan::File::OpenMode
OpenMode
File opening modes.
Definition:
file.h:94
clan::FileSystemProvider
Virtual File System (VFS) file source.
Definition:
file_system_provider.h:46
clan::DirectoryListingEntry
Virtual File System (VFS) directory listing entry class.
Definition:
directory_listing_entry.h:39