file_system.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 FileSystem_Impl;
43 class FileSystemProvider;
44 class DirectoryListing;
45
47 class FileSystem
48 {
51
52 public:
54 FileSystem();
55
59 FileSystem(FileSystemProvider *provider);
60
65 FileSystem(const std::string &path, bool is_zip_file = false);
66
67 ~FileSystem();
68
72
73 public:
75 bool is_null() const { return !impl; }
76
78 bool is_mount(const std::string &mount_point);
79
81 DirectoryListing get_directory_listing(const std::string &path_rel);
82
84 bool has_file(const std::string &filename);
85
87 bool has_directory(const std::string &directory);
88
90 FileSystemProvider *get_provider();
91
93 std::string get_path() const;
94
99 std::string get_identifier() const;
100
104
105 public:
107
112 IODevice open_file(const std::string &filename,
113 File::OpenMode mode = File::open_existing,
114 unsigned int access = File::access_read,
115 unsigned int share = File::share_all,
116 unsigned int flags = 0) const;
117
119
127 void mount(const std::string &mount_point, FileSystem fs);
128
130
135 void mount(const std::string &mount_point, const std::string &path, bool is_zip_file);
136
138
139 void unmount(const std::string &mount_point);
140
144
145 private:
146 class NullVFS { };
147 explicit FileSystem(class NullVFS null_fs);
148
149 std::shared_ptr<FileSystem_Impl> impl;
151 };
152
153 }
154
clan::FileSystem::get_directory_listing
DirectoryListing get_directory_listing(const std::string &path_rel)
Return directory listing for path.
clan
Definition: clanapp.h:35
clan::FileSystem::is_null
bool is_null() const
Returns true if the file system is null.
Definition: file_system.h:75
clan::DirectoryListing
Virtual File System (VFS) directory listing class.
Definition: directory_listing.h:41
clan::FileSystem::~FileSystem
~FileSystem()
clan::IODevice
I/O Device interface.
Definition: iodevice.h:50
clan::FileSystem::unmount
void unmount(const std::string &mount_point)
Unmount a file system.
clan::FileSystem::get_path
std::string get_path() const
Returns a path to the file source for this file system.
clan::StyleTokenType::string
@ keyword
clan::FileSystem::is_mount
bool is_mount(const std::string &mount_point)
Returns true if a path is a mount point.
clan::FileSystem::get_provider
FileSystemProvider * get_provider()
Returns the file source for this file system.
clan::FileSystem::get_identifier
std::string get_identifier() const
Get the identifier of this file source.
clan::FileSystem
Virtual File System (VFS).
Definition: file_system.h:47
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::FileSystem::FileSystem
FileSystem()
Constructs a file system.
clan::FileSystem::open_file
IODevice open_file(const std::string &filename, File::OpenMode mode=File::open_existing, unsigned int access=File::access_read, unsigned int share=File::share_all, unsigned int flags=0) const
Opens a file.
clan::FileSystem::has_file
bool has_file(const std::string &filename)
Return true if the root of the filesystem contains the specified file.
clan::File::OpenMode
OpenMode
File opening modes.
Definition: file.h:93
clan::FileSystemProvider
Virtual File System (VFS) file source.
Definition: file_system_provider.h:45
clan::FileSystem::has_directory
bool has_directory(const std::string &directory)
Return true if the root of the filesystem contains the specified directory.
clan::FileSystem::mount
void mount(const std::string &mount_point, FileSystem fs)
Mounts a file system at mount point.