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

file_system_provider.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 DirectoryListingEntry;
42
44 class FileSystemProvider
45 {
46 public:
47 virtual ~FileSystemProvider() { return; }
48
50
56 virtual IODevice open_file(const std::string &filename,
57 File::OpenMode mode = File::open_existing,
58 unsigned int access = File::access_read | File::access_write,
59 unsigned int share = File::share_all,
60 unsigned int flags = 0) = 0;
61
63 virtual bool initialize_directory_listing(const std::string &path) = 0;
64
66 virtual bool next_file(DirectoryListingEntry &entry) = 0;
67
69 virtual std::string get_path() const = 0;
70
75 virtual std::string get_identifier() const = 0;
76 };
77
79}
clan::DirectoryListingEntry
Virtual File System (VFS) directory listing entry class.
Definition directory_listing_entry.h:39
clan::FileSystemProvider
Virtual File System (VFS) file source.
Definition file_system_provider.h:45
clan::FileSystemProvider::next_file
virtual bool next_file(DirectoryListingEntry &entry)=0
Update directory listing item.
clan::FileSystemProvider::initialize_directory_listing
virtual bool initialize_directory_listing(const std::string &path)=0
Initiate directory listing.
clan::FileSystemProvider::open_file
virtual IODevice open_file(const std::string &filename, File::OpenMode mode=File::open_existing, unsigned int access=File::access_read|File::access_write, unsigned int share=File::share_all, unsigned int flags=0)=0
Open file from this source.
clan::FileSystemProvider::get_identifier
virtual std::string get_identifier() const =0
Get the identifier of this file source.
clan::FileSystemProvider::get_path
virtual std::string get_path() const =0
Return the path of this file source.
clan::FileSystemProvider::~FileSystemProvider
virtual ~FileSystemProvider()
Definition file_system_provider.h:47
clan::File::share_all
@ share_all
All other sharing flags combined.
Definition file.h:82
clan::File::access_write
@ access_write
Generic write access.
Definition file.h:63
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
clan
Definition clanapp.h:36