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
|
/*
This file is part of libdjinterop.
libdjinterop is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
libdjinterop 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 Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License
along with libdjinterop. If not, see <http://www.gnu.org/licenses/>.
*/
#pragma once
#include <memory>
#include <string>
#include <djinterop/config.hpp>
#include <djinterop/database.hpp>
#include <djinterop/engine/engine_schema.hpp>
namespace djinterop::engine
{
struct engine_library_context;
/// Abstract base class for an Engine Library.
///
class DJINTEROP_PUBLIC base_engine_library
{
public:
/// Construct an instance of the class using an Engine library context.
///
/// \param context Engine library context.
explicit base_engine_library(
std::shared_ptr<engine_library_context> context);
virtual ~base_engine_library() = default;
/// Verify the correctness of the Engine library database schema for its
/// stated version.
void verify() const;
/// Get the Engine library top-level directory.
///
/// \return Returns the top-level directory.
[[nodiscard]] std::string directory() const;
/// Get the schema version of the Engine library.
///
/// \return Returns the Engine schema version.
[[nodiscard]] engine_schema schema() const;
/// Get the unified database interface for this Engine library.
[[nodiscard]] virtual djinterop::database database() const = 0;
protected:
static std::shared_ptr<engine_library_context> load(
const std::string& directory);
static std::shared_ptr<engine_library_context> create(
const std::string& directory, const engine_schema& schema);
static std::shared_ptr<engine_library_context> create_temporary(
const engine_schema& schema);
static bool exists(const std::string& directory);
// Pimpl-like idiom, also used by other classes.
std::shared_ptr<engine_library_context> context_;
};
} // namespace djinterop::engine
|
