ClanLib  2.3.7
virtual_file_system.h
Go to the documentation of this file.
1 /*
2 ** ClanLib SDK
3 ** Copyright (c) 1997-2011 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 
32 
33 #pragma once
34 
35 #include "../api_core.h"
36 #include "../System/sharedptr.h"
37 #include "file.h"
38 class CL_IODevice;
40 class CL_VirtualFileSystem_Impl;
43 
48 {
51 
52 public:
55 
60 
65  CL_VirtualFileSystem(const CL_String &path, bool is_zip_file = false);
66 
68 
72 
73 public:
75  bool is_null() const { return !impl; }
76 
78  CL_VirtualDirectory get_root_directory();
79 
81  bool is_mount(const CL_String &mount_point);
82 
84  CL_VirtualDirectoryListing get_directory_listing(const CL_String &path_rel);
85 
87  bool has_file(const CL_String &filename);
88 
90  bool has_directory(const CL_String &directory);
91 
93  CL_VirtualFileSource *get_provider();
94 
96  CL_String get_path() const;
97 
102  CL_String get_identifier() const;
103 
107 
108 public:
110  CL_VirtualDirectory open_directory(const CL_String &path);
111 
113 
118  CL_IODevice open_file(const CL_String &filename,
120  unsigned int access = CL_File::access_read | CL_File::access_write,
121  unsigned int share = CL_File::share_all,
122  unsigned int flags = 0) const;
123 
125 
133  void mount(const CL_String &mount_point, CL_VirtualFileSystem fs);
134 
136 
141  void mount(const CL_String &mount_point, const CL_String &path, bool is_zip_file);
142 
144 
145  void unmount(const CL_String &mount_point);
146 
150 
151 private:
153  class CL_NullVFS { };
154  explicit CL_VirtualFileSystem(class CL_NullVFS null_fs);
155 
156  CL_SharedPtr<CL_VirtualFileSystem_Impl> impl;
157 
158  friend class CL_VirtualDirectory_Impl;
160 };
161