mpd/src/archive/ArchiveFile.hxx

// SPDX-License-Identifier: GPL-2.0-or-later
// Copyright The Music Player Daemon Project

#ifndef MPD_ARCHIVE_FILE_HXX
#define MPD_ARCHIVE_FILE_HXX

#include "input/Ptr.hxx"
#include "thread/Mutex.hxx"

class ArchiveVisitor;

class ArchiveFile {
public:
	virtual ~ArchiveFile() noexcept = default;

	/**
	 * Visit all entries inside this archive.
	 */
	virtual void Visit(ArchiveVisitor &visitor) = 0;

	/**
	 * Opens an InputStream of a file within the archive.
	 *
	 * Throws std::runtime_error on error.
	 *
	 * @param path the path within the archive
	 */
	virtual InputStreamPtr OpenStream(const char *path,
					  Mutex &mutex) = 0;
};

#endif
use SPDX IDs, replacing the long copyright headers 2023-03-06 14:42:04 +01:00			`// SPDX-License-Identifier: GPL-2.0-or-later`
			`// Copyright The Music Player Daemon Project`
new archive api, input_archive stream 2008-12-16 21:42:34 +01:00
ArchiveFile: convert to a class 2013-01-29 23:26:51 +01:00			`#ifndef MPD_ARCHIVE_FILE_HXX`
			`#define MPD_ARCHIVE_FILE_HXX`
new archive api, input_archive stream 2008-12-16 21:42:34 +01:00
archive/File, input/Plugin: return InputStreamPtr 2017-12-26 20:05:22 +01:00			`#include "input/Ptr.hxx"`
thread/Mutex: use `using` instead of making it a derived class Prepare the transition to std::mutex. 2019-05-07 19:23:01 +02:00			`#include "thread/Mutex.hxx"`
archive/File, input/Plugin: return InputStreamPtr 2017-12-26 20:05:22 +01:00
include cleanup using iwyu 2013-11-28 11:50:54 +01:00			`class ArchiveVisitor;`
util/Error: new error passing library Replaces GLib's GError. 2013-08-10 18:02:44 +02:00
ArchiveFile: convert to a class 2013-01-29 23:26:51 +01:00			`class ArchiveFile {`
ArchivePlugin: move instance methods to class ArchiveFile 2013-01-29 23:36:58 +01:00			`public:`
archive/File: eliminate Close(), make destructor virtual instead 2017-12-22 16:30:17 +01:00			`virtual ~ArchiveFile() noexcept = default;`
ArchivePlugin: move instance methods to class ArchiveFile 2013-01-29 23:36:58 +01:00
			`/**`
			`* Visit all entries inside this archive.`
			`*/`
			`virtual void Visit(ArchiveVisitor &visitor) = 0;`

			`/**`
input_stream: rename struct to InputStream 2013-10-23 22:08:59 +02:00			`* Opens an InputStream of a file within the archive.`
ArchivePlugin: move instance methods to class ArchiveFile 2013-01-29 23:36:58 +01:00			`*`
input/Plugin: migrate open() from class Error to C++ exceptions 2016-09-09 15:37:06 +02:00			`* Throws std::runtime_error on error.`
			`*`
ArchivePlugin: move instance methods to class ArchiveFile 2013-01-29 23:36:58 +01:00			`* @param path the path within the archive`
			`*/`
archive/File, input/Plugin: return InputStreamPtr 2017-12-26 20:05:22 +01:00			`virtual InputStreamPtr OpenStream(const char *path,`
input/Stream: remove attribute "cond", replace with handler interface This adds a bit of overhead, but also adds flexibility to the API, because arbitrary triggers may be invoked from that virtual method implementation, not just Cond::signal(). The motivation for this is to make the handlers more dynamic, for the upcoming buffering class utilizing ProxyInputStream. 2018-06-22 19:37:18 +02:00			`Mutex &mutex) = 0;`
ArchiveFile: convert to a class 2013-01-29 23:26:51 +01:00			`};`
archive_plugin: wrap method calls Make archive_file a "real" struct, extended by all plugins. Add the plugin pointer to it. Wrap all method calls in functions. 2009-12-16 16:28:26 +01:00
new archive api, input_archive stream 2008-12-16 21:42:34 +01:00			`#endif`