/*
 * Copyright 2003-2021 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_PLAYLIST_REGISTRY_HXX
#define MPD_PLAYLIST_REGISTRY_HXX

#include "input/Ptr.hxx"
#include "thread/Mutex.hxx"
#include "util/Compiler.h"

struct ConfigData;
struct PlaylistPlugin;
class SongEnumerator;

extern const PlaylistPlugin *const playlist_plugins[];

#define playlist_plugins_for_each(plugin) \
	for (const PlaylistPlugin *plugin, \
		*const*playlist_plugin_iterator = &playlist_plugins[0]; \
		(plugin = *playlist_plugin_iterator) != nullptr; \
		++playlist_plugin_iterator)

/**
 * Initializes all playlist plugins.
 */
void
playlist_list_global_init(const ConfigData &config);

/**
 * Deinitializes all playlist plugins.
 */
void
playlist_list_global_finish() noexcept;

class ScopePlaylistPluginsInit {
public:
	explicit ScopePlaylistPluginsInit(const ConfigData &config) {
		playlist_list_global_init(config);
	}

	~ScopePlaylistPluginsInit() noexcept {
		playlist_list_global_finish();
	}
};

/**
 * Shall this playlists supported by this plugin be represented as
 * directories in the database?
 */
gcc_const
bool
GetPlaylistPluginAsFolder(const PlaylistPlugin &plugin) noexcept;

/**
 * Opens a playlist by its URI.
 */
std::unique_ptr<SongEnumerator>
playlist_list_open_uri(const char *uri, Mutex &mutex);

std::unique_ptr<SongEnumerator>
playlist_list_open_stream_suffix(InputStreamPtr &&is, const char *suffix);

/**
 * Opens a playlist from an input stream.
 *
 * @param is an #InputStream object which is open and ready
 * @param uri optional URI which was used to open the stream; may be
 * used to select the appropriate playlist plugin
 */
std::unique_ptr<SongEnumerator>
playlist_list_open_stream(InputStreamPtr &&is, const char *uri);

gcc_pure
const PlaylistPlugin *
FindPlaylistPluginBySuffix(const char *suffix) noexcept;

/**
 * Determines if there is a playlist plugin which can handle the
 * specified file name suffix.
 */
gcc_pure
inline bool
playlist_suffix_supported(const char *suffix) noexcept
{
	return FindPlaylistPluginBySuffix(suffix) != nullptr;
}

#endif