source/includes/vst3sdk/pluginterfaces/vst/ivsttestplugprovider.h

   1 //-----------------------------------------------------------------------------
   2 // Flags       : clang-format SMTGSequencer
   3 // Project     : VST SDK
   4 //
   5 // Category    : Validator
   6 // Filename    : public.sdk/source/vst/testsuite/iplugprovider.h
   7 // Created by  : Steinberg, 04/2005
   8 // Description : VST Test Suite
   9 //
  10 //-----------------------------------------------------------------------------
  11 // LICENSE
  12 // (c) 2020, Steinberg Media Technologies GmbH, All Rights Reserved
  13 //-----------------------------------------------------------------------------
  14 // Redistribution and use in source and binary forms, with or without modification,
  15 // are permitted provided that the following conditions are met:
  16 //
  17 //   * Redistributions of source code must retain the above copyright notice,
  18 //     this list of conditions and the following disclaimer.
  19 //   * Redistributions in binary form must reproduce the above copyright notice,
  20 //     this list of conditions and the following disclaimer in the documentation
  21 //     and/or other materials provided with the distribution.
  22 //   * Neither the name of the Steinberg Media Technologies nor the names of its
  23 //     contributors may be used to endorse or promote products derived from this
  24 //     software without specific prior written permission.
  25 //
  26 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
  27 // ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  28 // WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  29 // IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
  30 // INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  31 // BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  32 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
  34 // OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE  OF THIS SOFTWARE, EVEN IF ADVISED
  35 // OF THE POSSIBILITY OF SUCH DAMAGE.
  36 //-----------------------------------------------------------------------------
  37
  38 #pragma once
  39
  40 #include "pluginterfaces/base/istringresult.h"
  41 #include "pluginterfaces/vst/ivstcomponent.h"
  42 #include "pluginterfaces/vst/ivsteditcontroller.h"
  43
  44 //------------------------------------------------------------------------
  45 namespace Steinberg {
  46 namespace Vst {
  47
  48 //------------------------------------------------------------------------
  49 /** Test Helper.
  50  * \ingroup TestClass
  51  *
  52  *      This class provides access to the component and the controller of a plug-in when running a unit
  53  *      test (see ITest).
  54  *      You get this interface as the context argument in the ITestFactory::createTests method.
  55  */
  56 //------------------------------------------------------------------------
  57 class ITestPlugProvider : public FUnknown
  58 {
  59 public:
  60 //------------------------------------------------------------------------
  61         /** get the component of the plug-in.
  62          *
  63          * The reference count of the component is increased in this function and you need to call
  64          * releasePlugIn when done with the component.
  65          */
  66         virtual IComponent* PLUGIN_API getComponent () = 0;
  67         /** get the controller of the plug-in.
  68          *
  69          * The reference count of the controller is increased in this function and you need to call
  70          * releasePlugIn when done with the controller.
  71          */
  72         virtual IEditController* PLUGIN_API getController () = 0;
  73         /** release the component and/or controller */
  74         virtual tresult PLUGIN_API releasePlugIn (IComponent* component,
  75                                                   IEditController* controller) = 0;
  76         /** get the sub categories of the plug-in */
  77         virtual tresult PLUGIN_API getSubCategories (IStringResult& result) const = 0;
  78         /** get the component UID of the plug-in */
  79         virtual tresult PLUGIN_API getComponentUID (FUID& uid) const = 0;
  80
  81 //------------------------------------------------------------------------
  82         static const FUID iid;
  83 };
  84
  85 DECLARE_CLASS_IID (ITestPlugProvider, 0x86BE70EE, 0x4E99430F, 0x978F1E6E, 0xD68FB5BA)
  86
  87 //------------------------------------------------------------------------
  88 /** Test Helper extension.
  89  * \ingroup TestClass
  90  */
  91 class ITestPlugProvider2 : public ITestPlugProvider
  92 {
  93 public:
  94         /** get the plugin factory.
  95          *
  96          * The reference count of the returned factory object is not increased when calling this
  97          * function.
  98          */
  99         virtual IPluginFactory* PLUGIN_API getPluginFactory () = 0;
 100
 101 //------------------------------------------------------------------------
 102         static const FUID iid;
 103 };
 104
 105 DECLARE_CLASS_IID (ITestPlugProvider2, 0xC7C75364, 0x7B8343AC, 0xA4495B0A, 0x3E5A46C7)
 106
 107 //------------------------------------------------------------------------
 108 } // Vst
 109 } // Steinberg