pqParaViewPlugin.cxx.in 5.95 KB
Newer Older
1 2 3 4 5 6 7 8 9
/*=========================================================================

   Program: ParaView
   Module:    pqParaViewPlugin.cxx.in

   Copyright (c) 2005,2006 Sandia Corporation, Kitware Inc.
   All rights reserved.

   ParaView is a free software; you can redistribute it and/or modify it
10
   under the terms of the ParaView license version 1.2.
11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34

   See License_v1.2.txt for the full ParaView license.
   A copy of this license can be obtained by contacting
   Kitware Inc.
   28 Corporate Drive
   Clifton Park, NY 12065
   USA

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 AUTHORS 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.

========================================================================*/
#include "@PLUGIN_NAME@_Plugin.h"

#include "vtkObjectFactory.h"
35
#include "vtkPVPluginLoader.h"
36

37 38
@EXTRA_INCLUDES@

39 40 41 42
#if @PLUGIN_HAS_EULA@ // PLUGIN_HAS_EULA
#include "@PLUGIN_EULA_HEADER@"
#endif

43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64
namespace
{
  // This ensures that when the shared library for this plugin is
  // unloaded during finalization sequence, it notifies the vtkPVPluginLoader
  // so it does not double-dlclose() an already unloaded plugin.
  // This does not affect static builds and hence we don't need to worry about
  // making sure this instance gets created in static builds.
  static class @PLUGIN_NAME@_PluginCleaner
    {
  public:
    @PLUGIN_NAME@_PluginCleaner()
      {
      }
    ~@PLUGIN_NAME@_PluginCleaner()
      {
      // The plugin library is being unloaded.
      // Let the plugin loader know so it doesn't try to unload it again.
      vtkPVPluginLoader::PluginLibraryUnloaded("@PLUGIN_NAME@");
      }
    } @PLUGIN_NAME@_PluginCleaner_Instance;
}

65 66 67 68 69
//-----------------------------------------------------------------------------
// Used to push a string returns from a function to a vector.
template <class T, class F>
void PushBack(T& vector, F& fun)
{
70
  char* text = fun();
71 72 73 74
  vector.push_back(text);
  delete []text;
}

75 76
//-----------------------------------------------------------------------------
#ifdef plugin_type_servermanager
77
# if defined(INITIALIZE_WRAPPING) || defined(INITIALIZE_EXTRA_CS_MODULES)
78 79
#include "vtkClientServerInterpreter.h"
#include "vtkClientServerInterpreterInitializer.h"
80

81
#   if defined(INITIALIZE_WRAPPING)
82
extern "C" void @PLUGIN_NAME@_Initialize(vtkClientServerInterpreter *);
83 84
#   endif

85
@PLUGIN_EXTRA_CS_INITS_EXTERNS@
86

87 88 89
extern "C" void VTK_EXPORT @PLUGIN_NAME@_CombinedInitialize(
  vtkClientServerInterpreter *interp)
{
90
#   if defined(INITIALIZE_WRAPPING)
91
  @PLUGIN_NAME@_Initialize(interp);
92
#   endif
93 94 95 96

  // Now initialize any extra kits as requested.
  @PLUGIN_EXTRA_CS_INITS@
}
97
# endif
98 99
#endif

100
//-----------------------------------------------------------------------------
101
void @PLUGIN_NAME@_Plugin::GetBinaryResources(
102
  std::vector<std::string>& resources)
103 104
{
@BINARY_RESOURCES_INIT@
105
  (void)resources;
106
}
107 108 109

//-----------------------------------------------------------------------------
#ifdef plugin_type_gui
110
@PUSH_BACK_PV_INTERFACES@
111 112
@INTERFACE_INCLUDES@
#endif
113 114 115

//-----------------------------------------------------------------------------
#ifdef plugin_type_servermanager
116
vtkClientServerInterpreterInitializer::InterpreterInitializationCallback
117 118
@PLUGIN_NAME@_Plugin::GetInitializeInterpreterCallback()
{
119
#if defined(INITIALIZE_WRAPPING) || defined(INITIALIZE_EXTRA_CS_MODULES)
120
  return @PLUGIN_NAME@_CombinedInitialize;
121
#else
122
  return NULL;
123
#endif
124 125 126
}

//-----------------------------------------------------------------------------
127
void @PLUGIN_NAME@_Plugin::GetXMLs(std::vector<std::string> &xmls)
128
{
129
@XML_INTERFACES_INIT@
130
  (void)xmls;
131 132 133 134 135 136 137
}
#endif

//-----------------------------------------------------------------------------
#ifdef plugin_type_gui
QObjectList @PLUGIN_NAME@_Plugin::interfaces()
{
138
  QObjectList ifaces;
139
#ifdef PUSH_BACK_PV_INTERFACES
140
  PUSH_BACK_PV_INTERFACES(ifaces);
141
#endif
142
  return ifaces;
143 144 145 146 147 148 149
}
#endif

//-----------------------------------------------------------------------------
#ifdef plugin_type_python
@WRAP_PYTHON_INCLUDES@

150 151 152
void @PLUGIN_NAME@_Plugin::GetPythonSourceList(std::vector<std::string>& modules,
  std::vector<std::string>& sources,
  std::vector<int> &package_flags)
153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177
{
  const char *moduleNames[] = {
    @PY_MODULE_LIST@
  };
  char *moduleSources[] = {
    @PY_LOADER_LIST@
  };
  const int packageFlags[] = {
    @PY_PACKAGE_FLAGS@
  };

  int num_modules = sizeof(moduleNames)/sizeof(const char *);
  for (int cc=0; cc < num_modules; cc++)
    {
    modules.push_back(moduleNames[cc]);
    sources.push_back(moduleSources[cc]);
    package_flags.push_back(packageFlags[cc]);

    // free allocated memory.
    delete moduleSources[cc];
    moduleSources[cc] = NULL;
    }
}
#endif

178 179 180
//-----------------------------------------------------------------------------
@PLUGIN_NAME@_Plugin::@PLUGIN_NAME@_Plugin()
{
181
#if !defined(BUILD_SHARED_LIBS) && defined(plugin_type_gui)
182 183
  // For static builds, initialize the Qt resources as well as the Qt plugin.
  @QRC_RESOURCES_INIT@
184 185 186
  // Qt 5
  Q_IMPORT_PLUGIN(@PLUGIN_NAME@_Plugin)

187 188 189
#endif
}

190 191 192 193 194 195 196 197 198 199
//-----------------------------------------------------------------------------
const char* @PLUGIN_NAME@_Plugin::GetEULA()
{
#if @PLUGIN_HAS_EULA@ // PLUGIN_HAS_EULA
  return @PLUGIN_NAME@_EULA;
#else
  return nullptr;
#endif
}

200 201 202
//-----------------------------------------------------------------------------
// Mark this as a ParaView-ServerManager plugin.
PV_PLUGIN_EXPORT(@PLUGIN_NAME@, @PLUGIN_NAME@_Plugin)