ClanLib  2.3.7
virtual_directory.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 
39 class CL_IODevice;
41 class CL_VirtualDirectory_Impl;
43 
48 {
51 
52 public:
54 
57 
59 
61  CL_VirtualDirectory(const CL_VirtualFileSystem &file_system, const CL_String &base_path);
62 
64 
68 
69 public:
71 
72  CL_VirtualFileSystem get_file_system();
73 
75 
78  const CL_String &get_path() const;
79 
81 
82  CL_VirtualDirectoryListing get_directory_listing();
83 
88  CL_String get_identifier() const;
89 
93 
94 public:
96 
98  CL_VirtualDirectory open_directory(const CL_String &path);
99 
101 
109  CL_IODevice open_file(
110  const CL_String &filename,
112  unsigned int access = CL_File::access_read | CL_File::access_write,
113  unsigned int share = CL_File::share_all,
114  unsigned int flags = 0);
115 
117  CL_IODevice open_file_read(
118  const CL_String &filename) const;
119 
121 
125  CL_String make_path_absolute(const CL_String &relative_path) const;
126 
128 
132  CL_String make_path_relative(const CL_String &absolute_path) const;
133 
135 
143  void mount(const CL_String &mount_point, CL_VirtualFileSystem &fs);
144 
146 
151  void mount(const CL_String &mount_point, const CL_String &path);
152 
154 
156  void unmount(const CL_String &mount_point);
157 
161 
162 private:
163  CL_SharedPtr<CL_VirtualDirectory_Impl> impl;
165 };
166