MPD: archive/ArchivePlugin.hxx Source File

MPD 0.20.15

ArchivePlugin.hxx
Go to the documentation of this file.
1 /*
2 * Copyright 2003-2017 The Music Player Daemon Project
3 * http://www.musicpd.org
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18 */
19
20 #ifndef MPD_ARCHIVE_PLUGIN_HXX
21 #define MPD_ARCHIVE_PLUGIN_HXX
22
23 class ArchiveFile;
24 class Path;
25
26 struct ArchivePlugin {
27 const char *name;
28
34 bool (*init)();
35
40 void (*finish)();
41
48 ArchiveFile *(*open)(Path path_fs);
49
54 const char *const*suffixes;
55 };
56
57 ArchiveFile *
58 archive_file_open(const ArchivePlugin *plugin, Path path);
59
60 #endif
ArchivePlugin::init
bool(* init)()
optional, set this to nullptr if the archive plugin doesn&#39;t have/need one this must false if there is...
Definition: ArchivePlugin.hxx:34
ArchivePlugin
Definition: ArchivePlugin.hxx:26
ArchivePlugin::finish
void(* finish)()
optional, set this to nullptr if the archive plugin doesn&#39;t have/need one
Definition: ArchivePlugin.hxx:40
Path
A path name in the native file system character set.
Definition: Path.hxx:39
archive_file_open
ArchiveFile * archive_file_open(const ArchivePlugin *plugin, Path path)
ArchiveFile
Definition: ArchiveFile.hxx:29
ArchivePlugin::name
const char * name
Definition: ArchivePlugin.hxx:27
ArchivePlugin::suffixes
const char *const * suffixes
suffixes handled by this plugin.
Definition: ArchivePlugin.hxx:54