Interface.hxx

Go to the documentation of this file.

/*
 * Copyright 2003-2017 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_DATABASE_INTERFACE_HXX
#define MPD_DATABASE_INTERFACE_HXX

#include "Visitor.hxx"
#include "tag/TagType.h"
#include "Compiler.h"

#include <map>
#include <set>
#include <string>

#include <time.h>

struct DatabasePlugin;
struct DatabaseStats;
struct DatabaseSelection;
struct LightSong;

class Database {
        const DatabasePlugin &plugin;

public:
        Database(const DatabasePlugin &_plugin)
                :plugin(_plugin) {}

        virtual ~Database() {}

        const DatabasePlugin &GetPlugin() const {
                return plugin;
        }

        bool IsPlugin(const DatabasePlugin &other) const {
                return &plugin == &other;
        }

        virtual void Open() {
        }

        virtual void Close() {}

        virtual const LightSong *GetSong(const char *uri_utf8) const = 0;

        virtual void ReturnSong(const LightSong *song) const = 0;

        virtual void Visit(const DatabaseSelection &selection,
                           VisitDirectory visit_directory,
                           VisitSong visit_song,
                           VisitPlaylist visit_playlist) const = 0;

        void Visit(const DatabaseSelection &selection,
                   VisitDirectory visit_directory,
                   VisitSong visit_song) const {
                Visit(selection, visit_directory, visit_song, VisitPlaylist());
        }

        void Visit(const DatabaseSelection &selection,
                   VisitSong visit_song) const {
                return Visit(selection, VisitDirectory(), visit_song);
        }

        virtual std::map<std::string, std::set<std::string>> CollectUniqueTags(const DatabaseSelection &selection,
                                                                               TagType tag_type,
                                                                               TagType group=TAG_NUM_OF_ITEM_TYPES) const = 0;

        virtual DatabaseStats GetStats(const DatabaseSelection &selection) const = 0;

        virtual unsigned Update(gcc_unused const char *uri_utf8,
                                gcc_unused bool discard) {
                /* not implemented: return 0 */
                return 0;
        }

        gcc_pure
        virtual time_t GetUpdateStamp() const noexcept = 0;
};

#endif