89 lines
2.4 KiB
C++
89 lines
2.4 KiB
C++
/*
|
|
* 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>
|
|
|
|
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(const char *uri_utf8, bool follow) = 0;
|
|
|
|
/**
|
|
* Throws #std::runtime_error on error.
|
|
*/
|
|
virtual std::unique_ptr<StorageDirectoryReader> OpenDirectory(const char *uri_utf8) = 0;
|
|
|
|
/**
|
|
* Map the given relative URI to an absolute URI.
|
|
*/
|
|
gcc_pure
|
|
virtual std::string MapUTF8(const char *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(const char *uri_utf8) const noexcept;
|
|
|
|
gcc_pure
|
|
AllocatedPath MapChildFS(const char *uri_utf8,
|
|
const char *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 const char *MapToRelativeUTF8(const char *uri_utf8) const noexcept = 0;
|
|
};
|
|
|
|
#endif
|