file_system.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 FileSystem_Impl;
44 class FileSystemProvider;
45 class DirectoryListing;
46 
48 class CL_API_CORE FileSystem
49 {
52 
53 public:
55  FileSystem();
56 
60  FileSystem(FileSystemProvider *provider);
61 
66  FileSystem(const std::string &path, bool is_zip_file = false);
67 
68  ~FileSystem();
69 
73 
74 public:
76  bool is_null() const { return !impl; }
77 
79  bool is_mount(const std::string &mount_point);
80 
82  DirectoryListing get_directory_listing(const std::string &path_rel);
83 
85  bool has_file(const std::string &filename);
86 
88  bool has_directory(const std::string &directory);
89 
91  FileSystemProvider *get_provider();
92 
94  std::string get_path() const;
95 
100  std::string get_identifier() const;
101 
105 
106 public:
108 
113  IODevice open_file(const std::string &filename,
115  unsigned int access = File::access_read,
116  unsigned int share = File::share_all,
117  unsigned int flags = 0) const;
118 
120 
128  void mount(const std::string &mount_point, FileSystem fs);
129 
131 
136  void mount(const std::string &mount_point, const std::string &path, bool is_zip_file);
137 
139 
140  void unmount(const std::string &mount_point);
141 
145 
146 private:
147  class NullVFS { };
148  explicit FileSystem(class NullVFS null_fs);
149 
150  std::shared_ptr<FileSystem_Impl> impl;
152 };
153 
154 }
155 
bool is_null() const
Returns true if the file system is null.
Definition: file_system.h:76
Virtual File System (VFS) directory listing class.
Definition: directory_listing.h:41
I/O Device interface.
Definition: iodevice.h:51
Virtual File System (VFS).
Definition: file_system.h:48
Generic read access.
Definition: file.h:68
Open existing file. Fails if it does not exist.
Definition: file.h:100
All other sharing flags combined.
Definition: file.h:90
OpenMode
File opening modes.
Definition: file.h:94
Virtual File System (VFS) file source.
Definition: file_system_provider.h:46