mirror of
https://github.com/cookiengineer/audacity
synced 2025-06-20 14:20:06 +02:00
466e9c179e
It combines the old IdentInterface with the ParamsInterface, providing an identifier and parameters (if needed). The main purpose of the change is to make the class hierarchy (as viewed via doxygen) much easier to follow.
138 lines
5.2 KiB
C++
138 lines
5.2 KiB
C++
/**********************************************************************
|
|
|
|
Audacity: A Digital Audio Editor
|
|
|
|
ComponentInterface.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_COMPONENT_INTERFACE_H__
|
|
#define __AUDACITY_COMPONENT_INTERFACE_H__
|
|
|
|
#include "audacity/Types.h"
|
|
extern AUDACITY_DLL_API const wxString& GetCustomTranslation(const wxString& str1 );
|
|
|
|
/**************************************************************************//**
|
|
|
|
\brief ComponentInterfaceSymbol pairs a persistent string identifier used internally
|
|
with an optional, different string as msgid for lookup in a translation catalog.
|
|
\details If there is need to change a msgid in a later version of the
|
|
program, change the constructor call to supply a second argument but leave the
|
|
first the same, so that compatibility of older configuration files containing
|
|
that internal string is not broken.
|
|
********************************************************************************/
|
|
class ComponentInterfaceSymbol
|
|
{
|
|
public:
|
|
ComponentInterfaceSymbol() = default;
|
|
|
|
// Allows implicit construction from a msgid re-used as an internal string
|
|
ComponentInterfaceSymbol( const wxString &msgid )
|
|
: mInternal{ msgid }, mMsgid{ msgid }
|
|
{}
|
|
|
|
// Allows implicit construction from a msgid re-used as an internal string
|
|
ComponentInterfaceSymbol( const wxChar *msgid )
|
|
: mInternal{ msgid }, mMsgid{ msgid }
|
|
{}
|
|
|
|
// Two-argument version distinguishes internal from translatable string
|
|
// such as when the first squeezes spaces out
|
|
ComponentInterfaceSymbol( const wxString &internal, const wxString &msgid )
|
|
: mInternal{ internal }
|
|
// Do not permit non-empty msgid with empty internal
|
|
, mMsgid{ internal.empty() ? wxString{} : msgid }
|
|
{}
|
|
|
|
const wxString &Internal() const { return mInternal; }
|
|
const wxString &Msgid() const { return mMsgid; }
|
|
const wxString &Translation() const
|
|
{ return GetCustomTranslation( mMsgid ); }
|
|
|
|
bool empty() const { return mInternal.empty(); }
|
|
|
|
friend inline bool operator == (
|
|
const ComponentInterfaceSymbol &a, const ComponentInterfaceSymbol &b )
|
|
{ return a.mInternal == b.mInternal; }
|
|
|
|
friend inline bool operator != (
|
|
const ComponentInterfaceSymbol &a, const ComponentInterfaceSymbol &b )
|
|
{ return !( a == b ); }
|
|
|
|
private:
|
|
wxString mInternal;
|
|
wxString mMsgid;
|
|
};
|
|
|
|
|
|
class ShuttleParams;
|
|
|
|
/**************************************************************************//**
|
|
|
|
\brief ComponentInterface provides name / vendor / version functions to identify
|
|
plugins. It is what makes a class a plug-in. Additionally it provides an
|
|
optional parameter definitions function, for those components such as commands,
|
|
effects and (soon) preference pagess that define parameters.
|
|
********************************************************************************/
|
|
class AUDACITY_DLL_API ComponentInterface /* not final */
|
|
{
|
|
public:
|
|
virtual ~ComponentInterface() {};
|
|
|
|
// These should return an untranslated value
|
|
virtual wxString GetPath() = 0;
|
|
|
|
// The internal string persists in configuration files
|
|
// So config compatibility will break if it is changed across Audacity versions
|
|
virtual ComponentInterfaceSymbol GetSymbol() = 0;
|
|
|
|
virtual ComponentInterfaceSymbol GetVendor() = 0;
|
|
|
|
virtual wxString GetVersion() = 0;
|
|
|
|
// This returns a translated string
|
|
// Any verb should be present tense indicative, not imperative
|
|
virtual wxString GetDescription() = 0;
|
|
|
|
// non-virtual convenience function
|
|
const wxString& GetTranslatedName();
|
|
|
|
// Parameters, if defined. false means no defined parameters.
|
|
virtual bool DefineParams( ShuttleParams & WXUNUSED(S) ){ return false;};
|
|
};
|
|
|
|
#endif // __AUDACITY_IDENTINTERFACE_H__
|