RPCInterface.hh 6.85 KB
 Jan Möbius committed Aug 05, 2009 1 /*===========================================================================*\ Jan Möbius committed Nov 25, 2010 2 3 * * * OpenFlipper * Jan Möbius committed Feb 05, 2014 4 * Copyright (C) 2001-2014 by Computer Graphics Group, RWTH Aachen * Jan Möbius committed Nov 25, 2010 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 * www.openflipper.org * * * *--------------------------------------------------------------------------- * * This file is part of OpenFlipper. * * * * OpenFlipper is free software: you can redistribute it and/or modify * * it under the terms of the GNU Lesser General Public License as * * published by the Free Software Foundation, either version 3 of * * the License, or (at your option) any later version with the * * following exceptions: * * * * If other files instantiate templates or use macros * * or inline functions from this file, or you compile this file and * * link it with other files to produce an executable, this file does * * not by itself cause the resulting executable to be covered by the * * GNU Lesser General Public License. This exception does not however * * invalidate any other reasons why the executable file might be * * covered by the GNU Lesser General Public License. * * * * OpenFlipper is distributed in the hope that it will be useful, * * but WITHOUT ANY WARRANTY; without even the implied warranty of * * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * * GNU Lesser General Public License for more details. * * * * You should have received a copy of the GNU LesserGeneral Public * * License along with OpenFlipper. If not, * * see . * * * Jan Möbius committed Aug 05, 2009 33 34 35 \*===========================================================================*/ /*===========================================================================*\ Jan Möbius committed Nov 25, 2010 36 37 38 39 40 * * * $Revision$ * * $LastChangedBy$ * * $Date$ * * * Jan Möbius committed Aug 05, 2009 41 \*===========================================================================*/ Jan Möbius committed Aug 29, 2008 42 43 44 45 46 #ifndef RPCINTERFACE_HH #define RPCINTERFACE_HH Jan Möbius committed Feb 25, 2009 47 48 #include Jan Möbius committed Mar 01, 2011 49 /** \file RPCInterface.hh Jan Möbius committed Mar 01, 2011 50 51 52 53 54 55 56 57 58 59 60 * * Interface for calling functions across plugins. \ref RPCInterfacePage */ /** \brief Interface to call functions across plugins. * * \ref RPCInterfacePage "Detailed description" * \n * \n * * Interface for all Plugins which do remote procedure calls ( and cross plugin calls).\n Jan Möbius committed Feb 25, 2009 61 62 * The functions provided in the interface are only used to verify that certain plugins or * functions are available. The actual calls are in the RPCWrappers.hh file. Jan Möbius committed Aug 29, 2008 63 64 65 */ class RPCInterface { Mike Kremer committed Feb 10, 2009 66 public: Jan Möbius committed Feb 25, 2009 67 Mike Kremer committed Feb 10, 2009 68 69 70 71 /// Destructor virtual ~RPCInterface() {}; signals : Jan Möbius committed Aug 29, 2008 72 73 /** Check if the plugin exists in the current Environment \n Jan Möbius committed Mar 01, 2011 74 * Jan Möbius committed Aug 29, 2008 75 76 77 * @param _pluginName Name of the Plugin (has to be the clean version .. no Spaces etc) * @param _exists found or not */ Jan Möbius committed Mar 15, 2011 78 virtual void pluginExists( QString _pluginName , bool& _exists ) {}; Jan Möbius committed Aug 29, 2008 79 80 81 82 83 84 85 /** Check if a plugin exists and provides the given function \n * @param _pluginName Name of the Plugin (has to be the clean version .. no Spaces etc) * @param _functionName requested function * @param _exists found or not */ Jan Möbius committed Mar 15, 2011 86 virtual void functionExists( QString _pluginName , QString _functionName , bool& _exists ) {}; Jan Möbius committed Aug 29, 2008 87 88 89 }; Jan Möbius committed Mar 01, 2011 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 /** \page RPCInterfacePage RPC Interface \image html RPCInterface.png \n The RPCInterface can be used by plugins to call functions from other OpenFlipper plugins. The calls are internally transformed into scripting calls and passed to the other plugins. You can directly connect signals and slots via the \ref pluginConnectionInterfacePage . The interface itself contains two basic functions which can be used to check if another plugin exists (RPCInterface::pluginExists()) or if a specific function exists in another plugin (RPCInterface::functionExists()). Both functions get the clean name of the plugin to check. To get that name, just open the script editor in OpenFlipper which lists all plugins and their available functions. Example Code for plugins: \code bool isPluginAvailable; emit pluginExists ("scripting", isPluginAvailable); \endcode Example Code for functions: \code bool isFunctionAvailable; emit functionExists ("scripting", "showScriptInEditor(QString)", isFunctionAvailable); \endcode In addition to these basic functions there is a set of template functions in RPCWrappers.hh which can be used to directly call a function from another plugin via the scripting system. This requires the parameters to be registered to the QT MetaObject system which is already done for the most common types of variables. For calling a function you can use RPC::callFunction() or RPC::callFunctionValue() if the called function returns a value. These functions get the pluginName and the function name and call the requested function via scripting. It is possible to supply additional parameters to these functions that will be passed to the called function. Example code: \code // call without getting return value RPC::callFunction ("pluginName", "FunctionName"); // call without getting return value and suplying a parameter int parameter1 RPC::callFunction ("pluginName", "FunctionName", parameter1); // call with getting return value which is defined as the template parameter QString parameter2 bool value = RPC::callFunctionValue ("pluginName", "FunctionName", parameter1, parameter2); \endcode To use the RPCInterface: