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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
|
/**********************************************************************
Audacity: A Digital Audio Editor
PluginInterface.h
Leland Lucius
Copyright (c) 2014, Audacity Team
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
3. Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.
**********************************************************************/
#ifndef __AUDACITY_PLUGININTERFACE_H__
#define __AUDACITY_PLUGININTERFACE_H__
#include "EffectInterface.h"
#include "ComponentInterface.h"
#include "Identifier.h"
#include "PluginProvider.h"
#include <variant>
class PluginProvider;
namespace PluginSettings {
enum ConfigurationType : unsigned {
Shared, Private
};
//! Supported types for settings
using ConfigValueTypes = std::tuple<
wxString
, int
, bool
, float
, double
>;
//! Define a reference to a variable of one of the types in ConfigValueTypes
/*! Avoid repetition of the list of types */
template<bool is_const, typename> struct ConfigReferenceGenerator;
template<bool is_const, typename... Types>
struct ConfigReferenceGenerator<is_const, std::tuple<Types...>> {
using type = std::variant< std::reference_wrapper<
std::conditional_t<is_const, const Types, Types> >... >;
};
using ConfigReference =
ConfigReferenceGenerator<false, ConfigValueTypes>::type;
using ConfigConstReference =
ConfigReferenceGenerator<true, ConfigValueTypes>::type;
}
//! Type of plugin registry version information
using PluginRegistryVersion = wxString;
MODULE_MANAGER_API
bool Regver_eq(
const PluginRegistryVersion ®ver1, const PluginRegistryVersion ®ver2);
// Compare registry versions
MODULE_MANAGER_API
bool Regver_lt(
const PluginRegistryVersion ®ver1, const PluginRegistryVersion ®ver2);
// Compare registry versions
inline bool Regver_le(
const PluginRegistryVersion ®ver1, const PluginRegistryVersion ®ver2)
{
return !Regver_lt(regver2, regver1);
}
class MODULE_MANAGER_API PluginManagerInterface /* not final */
{
public:
using ConfigurationType = PluginSettings::ConfigurationType;
using ConfigReference = PluginSettings::ConfigReference;
using ConfigConstReference = PluginSettings::ConfigConstReference;
virtual ~PluginManagerInterface();
static const PluginID &DefaultRegistrationCallback(
PluginProvider *provider, ComponentInterface *ident );
static const PluginID &AudacityCommandRegistrationCallback(
PluginProvider *provider, ComponentInterface *ident );
//! Was the plugin registry already populated for a path (maybe from loading the config file)?
/*!
@param path an identifier for the plug-in with meaning defined by provider; not always a file path
@param pName if supplied, a correction for the user visible name associated with the plug-in, if it is
registered already. (Needed because the configuration file only stores an internal name.)
*/
virtual bool IsPluginRegistered(
const PluginPath & path,
const TranslatableString *pName = nullptr) = 0;
virtual const PluginID & RegisterPlugin(PluginProvider *provider) = 0;
virtual const PluginID & RegisterPlugin(PluginProvider *provider, EffectDefinitionInterface *effect, int type) = 0;
virtual void FindFilesInPathList(const wxString & pattern,
const FilePaths & pathList,
FilePaths & files,
bool directories = false) = 0;
// Many functions corresponding to those in ConfigClientInterface, but
// with an extra ID argument
virtual bool GetConfigSubgroups(ConfigurationType type, const PluginID & ID,
const RegistryPath & group, RegistryPaths & subgroups) = 0;
virtual bool HasConfigValue(ConfigurationType type, const PluginID & ID,
const RegistryPath & group, const RegistryPath & key) = 0;
//! @pre var and defval wrap references to the same type (ignoring const)
virtual bool GetConfigValue(ConfigurationType type, const PluginID & ID,
const RegistryPath & group, const RegistryPath & key,
ConfigReference var, ConfigConstReference defval) = 0;
virtual bool SetConfigValue(ConfigurationType type, const PluginID & ID,
const RegistryPath & group, const RegistryPath & key,
ConfigConstReference value) = 0;
virtual bool RemoveConfigSubgroup(ConfigurationType type,
const PluginID & ID, const RegistryPath & group) = 0;
virtual bool RemoveConfig(ConfigurationType type, const PluginID & ID,
const RegistryPath & group, const RegistryPath & key) = 0;
//! What is the plugin registry version number now in the file?
virtual const PluginRegistryVersion &GetRegistryVersion() const = 0;
};
#endif // __AUDACITY_PLUGININTERFACE_H__
|
