PluginSettings Namespace Reference

Typedefs
using	ConfigValueTypes = TypeList::List< wxString, int, bool, float, double >
	Supported types for settings. More...
using	ConfigReference = TypeListVisitor::VariantOfReferences_t< false, ConfigValueTypes >
	Define a reference to a variable of one of the types in ConfigValueTypes. More...
using	ConfigConstReference = TypeListVisitor::VariantOfReferences_t< true, ConfigValueTypes >

Enumerations
enum	ConfigurationType : unsigned { Shared , Private }

Functions
bool	HasConfigGroup (const EffectDefinitionInterface &ident, PluginSettings::ConfigurationType type, const RegistryPath &group)
bool	GetConfigSubgroups (const EffectDefinitionInterface &ident, PluginSettings::ConfigurationType type, const RegistryPath &group, RegistryPaths &subgroups)
bool	HasConfigValue (const EffectDefinitionInterface &ident, PluginSettings::ConfigurationType type, const RegistryPath &group, const RegistryPath &key)
bool	GetConfigValue (const EffectDefinitionInterface &ident, PluginSettings::ConfigurationType type, const RegistryPath &group, const RegistryPath &key, ConfigReference var, ConfigConstReference defval)
bool	SetConfigValue (const EffectDefinitionInterface &ident, PluginSettings::ConfigurationType type, const RegistryPath &group, const RegistryPath &key, ConfigConstReference value)
bool	RemoveConfigSubgroup (const EffectDefinitionInterface &ident, PluginSettings::ConfigurationType type, const RegistryPath &group)
bool	RemoveConfig (const EffectDefinitionInterface &ident, PluginSettings::ConfigurationType type, const RegistryPath &group, const RegistryPath &key)
template<typename Value >
bool	GetConfig (const EffectDefinitionInterface &ident, ConfigurationType type, const RegistryPath &group, const RegistryPath &key, Value &var, const Value &defval)
template<typename Value , typename ConvertibleToValue >
bool	GetConfig (const EffectDefinitionInterface &ident, ConfigurationType type, const RegistryPath &group, const RegistryPath &key, Value &var, ConvertibleToValue defval)
template<typename Value >
bool	GetConfig (const EffectDefinitionInterface &ident, ConfigurationType type, const RegistryPath &group, const RegistryPath &key, const Value &var, const Value &defval)=delete
template<typename Value , typename ConvertibleToValue >
bool	GetConfig (const EffectDefinitionInterface &ident, ConfigurationType type, const RegistryPath &group, const RegistryPath &key, const Value &var, ConvertibleToValue defval)=delete
template<typename Value >
bool	GetConfig (const EffectDefinitionInterface &ident, ConfigurationType type, const RegistryPath &group, const RegistryPath &key, Value &var)
template<typename Value >
bool	SetConfig (const EffectDefinitionInterface &ident, ConfigurationType type, const RegistryPath &group, const RegistryPath &key, const Value &value)

Typedef Documentation

ConfigConstReference

using PluginSettings::ConfigConstReference = typedef TypeListVisitor::VariantOfReferences_t<true, ConfigValueTypes>

Definition at line 72 of file PluginInterface.h.

ConfigReference

using PluginSettings::ConfigReference = typedef TypeListVisitor::VariantOfReferences_t<false, ConfigValueTypes>

Define a reference to a variable of one of the types in ConfigValueTypes.

Definition at line 70 of file PluginInterface.h.

ConfigValueTypes

using PluginSettings::ConfigValueTypes = typedef TypeList::List< wxString , int , bool , float , double >

Supported types for settings.

Definition at line 61 of file PluginInterface.h.

Enumeration Type Documentation

ConfigurationType

enum PluginSettings::ConfigurationType : unsigned

Enumerator
Shared
Private

Definition at line 56 of file PluginInterface.h.

                       : unsigned {
   Shared, Private
};

Function Documentation

GetConfig() [1/5]

template<typename Value >

bool PluginSettings::GetConfig ( const EffectDefinitionInterface &  ident, ConfigurationType  type, const RegistryPath &  group, const RegistryPath &  key, const Value &  var, const Value &  defval  )

inlinedelete

GetConfig() [2/5]

template<typename Value , typename ConvertibleToValue >

bool PluginSettings::GetConfig ( const EffectDefinitionInterface &  ident, ConfigurationType  type, const RegistryPath &  group, const RegistryPath &  key, const Value &  var, ConvertibleToValue  defval  )

inlinedelete

GetConfig() [3/5]

template<typename Value >

bool PluginSettings::GetConfig ( const EffectDefinitionInterface &  ident, ConfigurationType  type, const RegistryPath &  group, const RegistryPath &  key, Value &  var  )

inline

Definition at line 99 of file ConfigInterface.h.

{
   return GetConfig(ident, type, group, key, var, Value{});
}

References GetConfig(), ident(), and key.

Here is the call graph for this function:

GetConfig() [4/5]

template<typename Value >

bool PluginSettings::GetConfig ( const EffectDefinitionInterface &  ident, ConfigurationType  type, const RegistryPath &  group, const RegistryPath &  key, Value &  var, const Value &  defval  )

inline

Definition at line 73 of file ConfigInterface.h.

{ return GetConfigValue(ident, type, group, key,
   std::ref(var), std::cref(defval)); }

References GetConfigValue(), ident(), and key.

Referenced by EffectBase::DoEffect(), EqualizationParameters::EqualizationParameters(), GetConfig(), anonymous_namespace{LV2Preferences.cpp}::GetSetting(), anonymous_namespace{EffectManager.cpp}::InitializePreset(), LadspaEffectBase::LoadParameters(), LV2EffectBase::LoadParameters(), AudioUnitWrapper::LoadPreset(), LadspaInstance::LoadUseLatency(), VST3Wrapper::LoadUserPreset(), VSTEffectBase::LoadUserPreset(), AudioUnitEffectBase::MakeInstance(), VSTEffectBase::MakeInstance(), AudioUnitEffectBase::MigrateOldConfigFile(), EffectChangeSpeed::PopulateOrExchange(), AudioUnitEffect::PopulateUI(), VSTEffect::PopulateUI(), VST3Effect::PopulateUI(), VST3Instance::ReloadUserOptions(), EffectNoiseReduction::TrackProgress(), and EffectChangeSpeed::Update_Vinyl().

Here is the call graph for this function:

Here is the caller graph for this function:

GetConfig() [5/5]

template<typename Value , typename ConvertibleToValue >

bool PluginSettings::GetConfig ( const EffectDefinitionInterface &  ident, ConfigurationType  type, const RegistryPath &  group, const RegistryPath &  key, Value &  var, ConvertibleToValue  defval  )

inline

Definition at line 81 of file ConfigInterface.h.

{ return GetConfig(ident, type, group, key, var, static_cast<Value>(defval)); }

References GetConfig(), ident(), and key.

Here is the call graph for this function:

GetConfigSubgroups()

MODULE_MANAGER_API bool PluginSettings::GetConfigSubgroups	(	const EffectDefinitionInterface &	ident,
		PluginSettings::ConfigurationType	type,
		const RegistryPath &	group,
		RegistryPaths &	subgroups
	)

Definition at line 27 of file ConfigInterface.cpp.

{
   auto &pluginManager = PluginManager::Get();
   const auto &id = pluginManager.GetID(&ident);
   if (pluginManager.GetConfigSubgroups(
      type, id, group, subgroups))
      return true;
   if (auto id2 = pluginManager.OldGetID(&ident); id != id2)
      return pluginManager.GetConfigSubgroups(type, id2, group, subgroups);
   return false;
}

References PluginManager::Get(), and ident().

Referenced by GetUserPresets(), and EffectUIHost::LoadUserPresets().

Here is the call graph for this function:

Here is the caller graph for this function:

GetConfigValue()

MODULE_MANAGER_API bool PluginSettings::GetConfigValue	(	const EffectDefinitionInterface &	ident,
		PluginSettings::ConfigurationType	type,
		const RegistryPath &	group,
		const RegistryPath &	key,
		ConfigReference	var,
		ConfigConstReference	defval
	)

Definition at line 54 of file ConfigInterface.cpp.

{
   auto &pluginManager = PluginManager::Get();
   const auto &id = pluginManager.GetID(&ident);
   if (pluginManager.GetConfigValue(type, id, group, key, var, defval))
      return true;
   if (auto id2 = pluginManager.OldGetID(&ident); id != id2)
      return pluginManager.GetConfigValue(type, id2, group, key, var, defval);
   return false;
}

References PluginManager::Get(), ident(), and key.

Referenced by GetConfig().

Here is the call graph for this function:

Here is the caller graph for this function:

HasConfigGroup()

MODULE_MANAGER_API bool PluginSettings::HasConfigGroup	(	const EffectDefinitionInterface &	ident,
		PluginSettings::ConfigurationType	type,
		const RegistryPath &	group
	)

Definition at line 14 of file ConfigInterface.cpp.

{
   auto &pluginManager = PluginManager::Get();
   const auto &id = pluginManager.GetID(&ident);
   if (pluginManager.HasConfigGroup(type, id, group))
      return true;
   if (auto id2 = pluginManager.OldGetID(&ident); id != id2)
      return pluginManager.HasConfigGroup(type, id2, group);
   return false;
}

References PluginManager::Get(), and ident().

Referenced by HasCurrentSettings(), and HasFactoryDefaults().

Here is the call graph for this function:

Here is the caller graph for this function:

HasConfigValue()

MODULE_MANAGER_API bool PluginSettings::HasConfigValue	(	const EffectDefinitionInterface &	ident,
		PluginSettings::ConfigurationType	type,
		const RegistryPath &	group,
		const RegistryPath &	key
	)

Definition at line 41 of file ConfigInterface.cpp.

{
   auto &pluginManager = PluginManager::Get();
   const auto &id = pluginManager.GetID(&ident);
   if (pluginManager.HasConfigValue(type, id, group, key))
      return true;
   if (auto id2 = pluginManager.OldGetID(&ident); id != id2)
      return pluginManager.HasConfigValue(type, id2, group, key);
   return false;
}

References PluginManager::Get(), ident(), and key.

Here is the call graph for this function:

RemoveConfig()

MODULE_MANAGER_API bool PluginSettings::RemoveConfig	(	const EffectDefinitionInterface &	ident,
		PluginSettings::ConfigurationType	type,
		const RegistryPath &	group,
		const RegistryPath &	key
	)

Definition at line 89 of file ConfigInterface.cpp.

{
   auto &pluginManager = PluginManager::Get();
   const auto &id = pluginManager.GetID(&ident);
   const auto &id2 = pluginManager.OldGetID(&ident);
   return pluginManager.RemoveConfig(type, id, group, key)
      || (id2 != id && pluginManager.RemoveConfig(type, id2, group, key));
}

References PluginManager::Get(), ident(), and key.

Referenced by AudioUnitEffectBase::MigrateOldConfigFile().

Here is the call graph for this function:

Here is the caller graph for this function:

RemoveConfigSubgroup()

MODULE_MANAGER_API bool PluginSettings::RemoveConfigSubgroup	(	const EffectDefinitionInterface &	ident,
		PluginSettings::ConfigurationType	type,
		const RegistryPath &	group
	)

Definition at line 78 of file ConfigInterface.cpp.

{
   auto &pluginManager = PluginManager::Get();
   const auto &id = pluginManager.GetID(&ident);
   const auto &id2 = pluginManager.OldGetID(&ident);
   return pluginManager.RemoveConfigSubgroup(type, id, group)
      || (id2 != id && pluginManager.RemoveConfigSubgroup(type, id2, group));
}

References PluginManager::Get(), and ident().

Referenced by EffectUIHost::OnDeletePreset().

Here is the call graph for this function:

Here is the caller graph for this function:

SetConfig()

template<typename Value >

bool PluginSettings::SetConfig ( const EffectDefinitionInterface &  ident, ConfigurationType  type, const RegistryPath &  group, const RegistryPath &  key, const Value &  value  )

inline

Definition at line 111 of file ConfigInterface.h.

{
   return SetConfigValue(ident, type, group, key, std::cref(value));
}

References ident(), key, and SetConfigValue().

Referenced by anonymous_namespace{EffectManager.cpp}::InitializePreset(), EffectChangeSpeed::OnChoice_Vinyl(), AudioUnitEffectOptionsDialog::OnOk(), VSTEffectOptionsDialog::OnOk(), VST3OptionsDialog::OnOk(), AudioUnitEffectBase::SaveBlobToConfig(), EqualizationParameters::SaveConfig(), LadspaEffectBase::SaveParameters(), LV2EffectBase::SaveParameters(), LadspaInstance::SaveUseLatency(), VST3Wrapper::SaveUserPreset(), Effect::SaveUserPreset(), VSTEffectBase::SaveUserPreset(), anonymous_namespace{LV2Preferences.cpp}::SetSetting(), EffectUIHost::TransferDataFromWindow(), and EffectChangeSpeed::TransferDataFromWindow().

Here is the call graph for this function:

Here is the caller graph for this function:

SetConfigValue()

MODULE_MANAGER_API bool PluginSettings::SetConfigValue	(	const EffectDefinitionInterface &	ident,
		PluginSettings::ConfigurationType	type,
		const RegistryPath &	group,
		const RegistryPath &	key,
		ConfigConstReference	value
	)

Definition at line 68 of file ConfigInterface.cpp.

{
   auto &pluginManager = PluginManager::Get();
   const auto &id = pluginManager.GetID(&ident);
   return pluginManager.SetConfigValue(type, id, group, key, value);
}

References PluginManager::Get(), ident(), and key.

Referenced by SetConfig().

Here is the call graph for this function:

Here is the caller graph for this function: