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
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
/*
* Copyright 2003-2018 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/Type.h"
#include "util/Compiler.h"
#include <chrono>
struct DatabasePlugin;
struct DatabaseStats;
struct DatabaseSelection;
struct LightSong;
class TagMask;
class Database {
const DatabasePlugin &plugin;
public:
Database(const DatabasePlugin &_plugin) noexcept
:plugin(_plugin) {}
/**
* Free instance data.
*/
virtual ~Database() noexcept = default;
const DatabasePlugin &GetPlugin() const noexcept {
return plugin;
}
bool IsPlugin(const DatabasePlugin &other) const noexcept {
return &plugin == &other;
}
/**
* Open the database. Read it into memory if applicable.
*
* Throws on error (e.g. #DatabaseError).
*/
virtual void Open() {
}
/**
* Close the database, free allocated memory.
*/
virtual void Close() noexcept {}
/**
* Look up a song (including tag data) in the database. When
* you don't need this anymore, call ReturnSong().
*
* Throws on error. "Not found" is an error that throws
* DatabaseErrorCode::NOT_FOUND.
*
* @param uri_utf8 the URI of the song within the music
* directory (UTF-8)
* @return a pointer that must be released with ReturnSong()
*/
virtual const LightSong *GetSong(const char *uri_utf8) const = 0;
/**
* Mark the song object as "unused". Call this on objects
* returned by GetSong().
*/
virtual void ReturnSong(const LightSong *song) const noexcept = 0;
/**
* Visit the selected entities.
*
* Throws on error.
*/
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);
}
/**
* Visit all unique tag values.
*
* Throws on error.
*/
virtual void VisitUniqueTags(const DatabaseSelection &selection,
TagType tag_type, TagMask group_mask,
VisitTag visit_tag) const = 0;
/**
* Throws on error.
*/
virtual DatabaseStats GetStats(const DatabaseSelection &selection) const = 0;
/**
* Update the database.
*
* Throws on error.
*
* @return the job id or 0 if not implemented
*/
virtual unsigned Update(gcc_unused const char *uri_utf8,
gcc_unused bool discard) {
/* not implemented: return 0 */
return 0;
}
/**
* Returns the time stamp of the last database update.
* Returns a negative value if that is not not known/available.
*/
gcc_pure
virtual std::chrono::system_clock::time_point GetUpdateStamp() const noexcept = 0;
};
#endif