Added python interface

BasePlugin/PythonInterface.hh

+/*===========================================================================*\
+*                                                                            *
+*                              OpenFlipper                                   *
+ *           Copyright (c) 2001-2015, RWTH-Aachen University                 *
+ *           Department of Computer Graphics and Multimedia                  *
+ *                          All rights reserved.                             *
+ *                            www.openflipper.org                            *
+ *                                                                           *
+ *---------------------------------------------------------------------------*
+ * This file is part of OpenFlipper.                                         *
+ *---------------------------------------------------------------------------*
+ *                                                                           *
+ * 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.              *
+*                                                                            *
+\*===========================================================================*/
+
+#pragma once
+
+
+/** \file PythonInterface.hh
+*
+* Interface for enabling Python Interfacing for this plugin. \ref pythonInterfacePage
+*/
+
+
+ /** \brief Interface class for exporting functions to python
+ *
+ * \n
+ * \ref pythonInterfacePage "Detailed description"
+ * \n
+ *
+ */
+class PythonInterface {
+
+  private slots :
+
+    /**  \brief This function will be called by the core to send the current this pointer to the plugin
+      *
+      *
+      *  As we need a this pointer to the plugin to call it from pythonn code, we need to pass it
+      *  into our shared plugin to make it available there. As a plugin is semantically a singleton
+      *  we can't have multiple this pointers.
+      *
+      *  The corresponding function has to be implemented inside the plugin!
+      *
+      *  @param _pluginPointer Pointer to the plugin instance
+    */
+    virtual void setPluginPointer(QObject* _pluginPointer) {};
+
+  public :
+
+    /// Destructor
+    virtual ~PythonInterface() {};
+
+};
+
+/** \page pythonInterfacePage Python Interface
+\n
+\n
+
+TODO!!!!!
+
+
+*/
+
+Q_DECLARE_INTERFACE(PythonInterface,"OpenFlipper.PythonInterface/1.0")
+

Core/PluginLoader.cc

@@ -67,6 +67,7 @@
 #include "OpenFlipper/BasePlugin/ViewModeInterface.hh"
 #include "OpenFlipper/BasePlugin/LoadSaveInterface.hh"
 #include "OpenFlipper/BasePlugin/INIInterface.hh"
+#include "OpenFlipper/BasePlugin/PythonInterface.hh"
 #include "OpenFlipper/BasePlugin/RPCInterface.hh"
 #include "OpenFlipper/BasePlugin/ScriptInterface.hh"
 #include "OpenFlipper/BasePlugin/SecurityInterface.hh"
@@ -1339,6 +1340,23 @@ void Core::loadPlugin(const QString& _filename,const bool _silent, QString& _lic
               plugin  , SLOT( loadIniFileOptionsLast( INIFile& ) ),Qt::DirectConnection);
   }
   
+#ifdef PYTHON_ENABLED
+
+  //Check if the plugin supports Python Interface
+  PythonInterface* pythonPlugin = qobject_cast< PythonInterface * >(plugin);
+
+  if ( pythonPlugin ) {
+    QObject* currentPluginPointer = qobject_cast< QObject * >(plugin);
+    if ( currentPluginPointer ) {
+        QMetaObject::invokeMethod(plugin,"setPluginPointer", Qt::DirectConnection,   Q_ARG(QObject*,currentPluginPointer) ) ;
+    } else {
+      emit log(LOGWARN,tr("Unable to set python plugin pointer!") );
+    }
+
+
+  }
+#endif
+
   //Check if the plugin supports Selection-Interface
   SelectionInterface* selectionPlugin = qobject_cast< SelectionInterface * >(plugin);
   if ( selectionPlugin && OpenFlipper::Options::gui() ) {