mpd/src/LocateUri.hxx

84 lines
1.5 KiB
C++

// SPDX-License-Identifier: GPL-2.0-or-later
// Copyright The Music Player Daemon Project
#ifndef MPD_LOCATE_URI_HXX
#define MPD_LOCATE_URI_HXX
#include "config.h"
#include "fs/AllocatedPath.hxx"
#ifdef _WIN32
#include <windows.h>
/* damn you, windows.h! */
#ifdef ABSOLUTE
#undef ABSOLUTE
#endif
#ifdef RELATIVE
#undef RELATIVE
#endif
#endif
class IClient;
#ifdef ENABLE_DATABASE
class Storage;
#endif
enum class UriPluginKind {
INPUT,
STORAGE,
PLAYLIST,
};
struct LocatedUri {
enum class Type {
/**
* An absolute URI with a supported scheme.
*/
ABSOLUTE,
/**
* A relative URI path.
*/
RELATIVE,
/**
* A local file. The #path attribute is valid.
*/
PATH,
} type;
const char *canonical_uri;
/**
* Contains the local file path if type==FILE.
*/
AllocatedPath path;
LocatedUri(Type _type, const char *_uri,
AllocatedPath &&_path=nullptr)
:type(_type), canonical_uri(_uri), path(std::move(_path)) {}
};
/**
* Classify a URI.
*
* Throws #std::runtime_error on error.
*
* @param client the #IClient that is used to determine whether a local
* file is allowed; nullptr disables the check and allows all local
* files
* @param storage a #Storage instance which may be used to convert
* absolute URIs to relative ones, using Storage::MapToRelativeUTF8();
* that feature is disabled if this parameter is nullptr
*/
LocatedUri
LocateUri(UriPluginKind kind,
const char *uri, const IClient *client
#ifdef ENABLE_DATABASE
, const Storage *storage
#endif
);
#endif