file_system.h Source File - ClanLib SDK
Description: file_system.h Source File

file_system.h
1/*
2** ClanLib SDK
3** Copyright (c) 1997-2020 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#pragma once
31
32#include <memory>
33#include "file.h"
34
35namespace clan
36{
39
40 class IODevice;
41 class FileSystem_Impl;
42 class FileSystemProvider;
43 class DirectoryListing;
44
46 class FileSystem
47 {
48 public:
50 FileSystem();
51
55 FileSystem(FileSystemProvider *provider);
56
61 FileSystem(const std::string &path, bool is_zip_file = false);
62
63 ~FileSystem();
64
66 bool is_null() const { return !impl; }
67
69 bool is_mount(const std::string &mount_point);
70
72 DirectoryListing get_directory_listing(const std::string &path_rel);
73
75 bool has_file(const std::string &filename);
76
78 bool has_directory(const std::string &directory);
79
81 FileSystemProvider *get_provider();
82
84 std::string get_path() const;
85
90 std::string get_identifier() const;
91
93
98 IODevice open_file(const std::string &filename,
99 File::OpenMode mode = File::open_existing,
100 unsigned int access = File::access_read,
101 unsigned int share = File::share_all,
102 unsigned int flags = 0) const;
103
105
113 void mount(const std::string &mount_point, FileSystem fs);
114
116
121 void mount(const std::string &mount_point, const std::string &path, bool is_zip_file);
122
124
125 void unmount(const std::string &mount_point);
126
127 private:
128 class NullVFS { };
129 explicit FileSystem(class NullVFS null_fs);
130
131 std::shared_ptr<FileSystem_Impl> impl;
132 };
133
135}
clan::DirectoryListing
Virtual File System (VFS) directory listing class.
Definition directory_listing.h:42
clan::FileSystemProvider
Virtual File System (VFS) file source.
Definition file_system_provider.h:45
clan::FileSystem::get_identifier
std::string get_identifier() const
Get the identifier of this file source.
clan::FileSystem::get_directory_listing
DirectoryListing get_directory_listing(const std::string &path_rel)
Return directory listing for path.
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::~FileSystem
~FileSystem()
clan::FileSystem::FileSystem
FileSystem()
Constructs a file system.
clan::FileSystem::is_null
bool is_null() const
Returns true if the file system is null.
Definition file_system.h:66
clan::FileSystem::unmount
void unmount(const std::string &mount_point)
Unmount a file system.
clan::FileSystem::mount
void mount(const std::string &mount_point, FileSystem fs)
Mounts a file system at mount point.
clan::FileSystem::get_path
std::string get_path() const
Returns a path to the file source for this file system.
clan::FileSystem::has_file
bool has_file(const std::string &filename)
Return true if the root of the filesystem contains the specified file.
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, const std::string &path, bool is_zip_file)
Mounts a file system at mount point.
clan::FileSystem::FileSystem
FileSystem(FileSystemProvider *provider)
Constructs a FileSystem.
clan::FileSystem::FileSystem
FileSystem(const std::string &path, bool is_zip_file=false)
Constructs a FileSystem.
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::File::share_all
@ share_all
All other sharing flags combined.
Definition file.h:82
clan::File::access_read
@ access_read
Generic read access.
Definition file.h:60
clan::File::OpenMode
OpenMode
File opening modes.
Definition file.h:87
clan::File::open_existing
@ open_existing
Open existing file. Fails if it does not exist.
Definition file.h:92
clan::IODevice
I/O Device interface.
Definition iodevice.h:50
clan::StandardProgram::path
@ path
Definition graphic_context.h:243
clan
Definition clanapp.h:36