db_plugin: convert to C++
This commit is contained in:
87
src/DatabasePlugin.hxx
Normal file
87
src/DatabasePlugin.hxx
Normal file
@@ -0,0 +1,87 @@
|
||||
/*
|
||||
* Copyright (C) 2003-2011 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.
|
||||
*/
|
||||
|
||||
/** \file
|
||||
*
|
||||
* This header declares the db_plugin class. It describes a
|
||||
* plugin API for databases of song metadata.
|
||||
*/
|
||||
|
||||
#ifndef MPD_DATABASE_PLUGIN_HXX
|
||||
#define MPD_DATABASE_PLUGIN_HXX
|
||||
|
||||
#include "DatabaseVisitor.hxx"
|
||||
|
||||
#include <glib.h>
|
||||
#include <assert.h>
|
||||
#include <stdbool.h>
|
||||
|
||||
struct config_param;
|
||||
struct db_selection;
|
||||
struct db_visitor;
|
||||
|
||||
class Database {
|
||||
public:
|
||||
/**
|
||||
* Free instance data.
|
||||
*/
|
||||
virtual ~Database() {}
|
||||
|
||||
/**
|
||||
* Open the database. Read it into memory if applicable.
|
||||
*/
|
||||
virtual bool Open(G_GNUC_UNUSED GError **error_r) {
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Close the database, free allocated memory.
|
||||
*/
|
||||
virtual void Close() {}
|
||||
|
||||
/**
|
||||
* Look up a song (including tag data) in the database.
|
||||
*
|
||||
* @param uri_utf8 the URI of the song within the music
|
||||
* directory (UTF-8)
|
||||
*/
|
||||
virtual struct song *GetSong(const char *uri_utf8,
|
||||
GError **error_r) = 0;
|
||||
|
||||
/**
|
||||
* Visit the selected entities.
|
||||
*/
|
||||
virtual bool Visit(const struct db_selection *selection,
|
||||
VisitDirectory visit_directory,
|
||||
VisitSong visit_song,
|
||||
VisitPlaylist visit_playlist,
|
||||
GError **error_r) = 0;
|
||||
};
|
||||
|
||||
struct DatabasePlugin {
|
||||
const char *name;
|
||||
|
||||
/**
|
||||
* Allocates and configures a database.
|
||||
*/
|
||||
Database *(*create)(const struct config_param *param,
|
||||
GError **error_r);
|
||||
};
|
||||
|
||||
#endif
|
Reference in New Issue
Block a user