file_system_provider.h
1 /*
2 ** ClanLib SDK
3 ** Copyright (c) 1997-2015 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 <memory>
34 #include "file.h"
35
36 namespace clan
37 {
40
41 class IODevice;
42 class DirectoryListingEntry;
43
45 class FileSystemProvider
46 {
49
50 public:
51 virtual ~FileSystemProvider() { return; }
52
56
57 public:
58
62
63 public:
65
71 virtual IODevice open_file(const std::string &filename,
72 File::OpenMode mode = File::open_existing,
73 unsigned int access = File::access_read | File::access_write,
74 unsigned int share = File::share_all,
75 unsigned int flags = 0) = 0;
76
78 virtual bool initialize_directory_listing(const std::string &path) = 0;
79
81 virtual bool next_file(DirectoryListingEntry &entry) = 0;
82
84 virtual std::string get_path() const = 0;
85
90 virtual std::string get_identifier() const = 0;
91
95
96 private:
98 };
99
100 }
101
clan
Definition: clanapp.h:35
clan::File::access_write
Generic write access.
Definition: file.h:70
clan::IODevice
I/O Device interface.
Definition: iodevice.h:50
clan::FileSystemProvider::open_file
virtual IODevice open_file(const std::string &filename, File::OpenMode mode=File::open_existing, unsigned int access=File::access_read|File::access_write, unsigned int share=File::share_all, unsigned int flags=0)=0
Open file from this source.
clan::FileSystemProvider::~FileSystemProvider
virtual ~FileSystemProvider()
Definition: file_system_provider.h:51
clan::StyleTokenType::string
@ keyword
clan::File::access_read
Generic read access.
Definition: file.h:67
clan::File::open_existing
Open existing file. Fails if it does not exist.
Definition: file.h:99
clan::File::share_all
All other sharing flags combined.
Definition: file.h:89
clan::FileSystemProvider::next_file
virtual bool next_file(DirectoryListingEntry &entry)=0
Update directory listing item.
clan::File::OpenMode
OpenMode
File opening modes.
Definition: file.h:93
clan::FileSystemProvider::initialize_directory_listing
virtual bool initialize_directory_listing(const std::string &path)=0
Initiate directory listing.
clan::FileSystemProvider
Virtual File System (VFS) file source.
Definition: file_system_provider.h:45
clan::FileSystemProvider::get_path
virtual std::string get_path() const =0
Return the path of this file source.
clan::DirectoryListingEntry
Virtual File System (VFS) directory listing entry class.
Definition: directory_listing_entry.h:39
clan::FileSystemProvider::get_identifier
virtual std::string get_identifier() const =0
Get the identifier of this file source.