Audacity 3.2.0
Classes | Macros | Typedefs
PluginProvider.h File Reference

Generalized interface for discovery of plug-ins for one protocol. More...

#include <functional>
#include <memory>
#include "Identifier.h"
#include "ComponentInterface.h"
#include "ComponentInterfaceSymbol.h"
Include dependency graph for PluginProvider.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

class  PluginProvider
 
class  PluginProvider::Validator
 

Macros

#define DECLARE_PROVIDER_ENTRY(name)   static std::unique_ptr<PluginProvider> name()
 
#define DECLARE_BUILTIN_PROVIDER_BASE(name)
 
#define DECLARE_BUILTIN_PROVIDER(name)
 

Typedefs

using PluginID = wxString
 
using PluginIDs = wxArrayString
 

Detailed Description

Generalized interface for discovery of plug-ins for one protocol.


Audacity: A Digital Audio Editor

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.

Definition in file PluginProvider.h.

Macro Definition Documentation

◆ DECLARE_BUILTIN_PROVIDER

#define DECLARE_BUILTIN_PROVIDER (   name)
Value:
void name::Register() \
{ \
RegisterProviderFactory(AudacityModule); \
} \
void name::Unregister() \
{ \
UnregisterProviderFactory(AudacityModule); \
}
const TranslatableString name
Definition: Distortion.cpp:82
#define DECLARE_BUILTIN_PROVIDER_BASE(name)

Definition at line 227 of file PluginProvider.h.

◆ DECLARE_BUILTIN_PROVIDER_BASE

#define DECLARE_BUILTIN_PROVIDER_BASE (   name)
Value:
class name \
{ \
public: \
name() {Register();} \
~name() {Unregister();} \
void Register(); \
void Unregister(); \
}; \
static name name ## _instance;

Definition at line 212 of file PluginProvider.h.

◆ DECLARE_PROVIDER_ENTRY

#define DECLARE_PROVIDER_ENTRY (   name)    static std::unique_ptr<PluginProvider> name()

Definition at line 198 of file PluginProvider.h.

Typedef Documentation

◆ PluginID

using PluginID = wxString

Definition at line 52 of file PluginProvider.h.

◆ PluginIDs

using PluginIDs = wxArrayString

Definition at line 53 of file PluginProvider.h.