1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
/*
* Copyright 2003-2020 The Music Player Daemon Project
* http://www.musicpd.org
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
#ifndef MPD_STORAGE_INTERFACE_HXX
#define MPD_STORAGE_INTERFACE_HXX
#include "util/Compiler.h"
#include <memory>
#include <string>
#include <string_view>
struct StorageFileInfo;
class AllocatedPath;
class StorageDirectoryReader {
public:
StorageDirectoryReader() = default;
StorageDirectoryReader(const StorageDirectoryReader &) = delete;
virtual ~StorageDirectoryReader() noexcept {}
virtual const char *Read() noexcept = 0;
/**
* Throws #std::runtime_error on error.
*/
virtual StorageFileInfo GetInfo(bool follow) = 0;
};
class Storage {
public:
Storage() = default;
Storage(const Storage &) = delete;
virtual ~Storage() noexcept {}
/**
* Throws #std::runtime_error on error.
*/
virtual StorageFileInfo GetInfo(std::string_view uri_utf8, bool follow) = 0;
/**
* Throws #std::runtime_error on error.
*/
virtual std::unique_ptr<StorageDirectoryReader> OpenDirectory(std::string_view uri_utf8) = 0;
/**
* Map the given relative URI to an absolute URI.
*/
gcc_pure
virtual std::string MapUTF8(std::string_view uri_utf8) const noexcept = 0;
/**
* Map the given relative URI to a local file path. Returns
* nullptr on error or if this storage does not
* support local files.
*/
gcc_pure
virtual AllocatedPath MapFS(std::string_view uri_utf8) const noexcept;
gcc_pure
AllocatedPath MapChildFS(std::string_view uri_utf8,
std::string_view child_utf8) const noexcept;
/**
* Check if the given URI points inside this storage. If yes,
* then it returns a relative URI (pointing inside the given
* string); if not, returns nullptr.
*/
gcc_pure
virtual std::string_view MapToRelativeUTF8(std::string_view uri_utf8) const noexcept = 0;
};
#endif