aboutsummaryrefslogtreecommitdiffstats
path: root/src/ArchiveFile.hxx
blob: 5f8dc54f50fc55241b6f0cd7f5e009f87e50e8cb (plain) (blame)
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
/*
 * Copyright (C) 2003-2013 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_ARCHIVE_FILE_HXX
#define MPD_ARCHIVE_FILE_HXX

class Mutex;
class Cond;
class Error;

class ArchiveFile {
public:
	const struct archive_plugin &plugin;

	ArchiveFile(const struct archive_plugin &_plugin)
		:plugin(_plugin) {}

protected:
	/**
	 * Use Close() instead of delete.
	 */
	~ArchiveFile() {}

public:
	virtual void Close() = 0;

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

	/**
	 * Opens an input_stream of a file within the archive.
	 *
	 * @param path the path within the archive
	 * @param error_r location to store the error occurring, or
	 * NULL to ignore errors
	 */
	virtual input_stream *OpenStream(const char *path,
					 Mutex &mutex, Cond &cond,
					 Error &error) = 0;
};

#endif