Developer Documentation
Loading...
Searching...
No Matches
RPCWrappers.hh
Go to the documentation of this file.
1/*===========================================================================*\
2* *
3* OpenFlipper *
4 * Copyright (c) 2001-2015, RWTH-Aachen University *
5 * Department of Computer Graphics and Multimedia *
6 * All rights reserved. *
7 * www.openflipper.org *
8 * *
9 *---------------------------------------------------------------------------*
10 * This file is part of OpenFlipper. *
11 *---------------------------------------------------------------------------*
12 * *
13 * Redistribution and use in source and binary forms, with or without *
14 * modification, are permitted provided that the following conditions *
15 * are met: *
16 * *
17 * 1. Redistributions of source code must retain the above copyright notice, *
18 * this list of conditions and the following disclaimer. *
19 * *
20 * 2. Redistributions in binary form must reproduce the above copyright *
21 * notice, this list of conditions and the following disclaimer in the *
22 * documentation and/or other materials provided with the distribution. *
23 * *
24 * 3. Neither the name of the copyright holder nor the names of its *
25 * contributors may be used to endorse or promote products derived from *
26 * this software without specific prior written permission. *
27 * *
28 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS *
29 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *
30 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A *
31 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER *
32 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, *
33 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, *
34 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR *
35 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF *
36 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING *
37 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS *
38 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. *
39* *
40\*===========================================================================*/
41
42
51#pragma once
52
53
54#include <vector>
55#include <QVariant>
57
58
63namespace RPC {
64
65//===========================================================================
70//===========================================================================
71
82void callFunctionQVariant( const QString& _plugin, const QString& _functionName , const std::vector< QVariant >& _parameters , QGenericReturnArgument _returnArg = QGenericReturnArgument());
83
86//===========================================================================
91//===========================================================================
92
93
101void callFunction( QString _plugin, QString _functionName);
102
103template <class... Ts>
104void callFunction(QString _plugin, QString _functionName, Ts const&... args) {
105
106
107 QGenericReturnArgument unused;
108 std::vector<QVariant> parameters( { QVariant::fromValue( args ) ... } );
109
110 callFunctionQVariant(_plugin,_functionName,parameters);
111}
112
113
116//===========================================================================
122//===========================================================================
123
130template <typename ReturnValue >
131ReturnValue callFunctionValue( QString _plugin, QString _functionName) {
132
133 // Intermediate storage for the return value as we have to pass it through the GenericReturnargument to hide the type
134 ReturnValue tmpValue = 0;
135
136 // Two variants of getting the type mapping for the Returnvalue:
137 // 1. via qvariant (which is rather ugly
138 // QVariant::fromValue<ReturnValue>(tmpValue).typeName()
139 // 2. via the metatype system (Does not seem to work!)
140 // QMetaType::fromType<ReturnValue>().name().data()
141
142 // Return argument encapsulation for the final call to the function
143 QGenericReturnArgument argument1 = QGenericReturnArgument(QVariant::fromValue<ReturnValue>(tmpValue).typeName(),&tmpValue);
144
145 std::vector<QVariant> parameters;
146
147 callFunctionQVariant(_plugin,_functionName,parameters,argument1);
148
149 return tmpValue;
150}
151
159template <typename ReturnValue ,class... Ts>
160ReturnValue callFunctionValue(QString _plugin, QString _functionName, Ts const&... args) {
161
162 // Intermediate storage for the return value as we have to pass it through the GenericReturnargument to hide the type
163 ReturnValue tmpValue = 0;
164
165 // Return argument encapsulation for the final call to the function
166 QGenericReturnArgument argument1 = QGenericReturnArgument(QVariant::fromValue<ReturnValue>(tmpValue).typeName(),&tmpValue);
167
168 std::vector<QVariant> parameters( { QVariant::fromValue( args ) ... } );
169
170 callFunctionQVariant(_plugin,_functionName,parameters,argument1);
171
172 return tmpValue;
173}
174
178}
179
DLLEXPORT QString typeName(DataType _id)
Get the name of a type with given id.
Definition Types.cc:154
#define DLLEXPORT
void callFunction(QString _plugin, QString _functionName)
call a function in another plugin
void callFunctionQVariant(const QString &_plugin, const QString &_functionName, const std::vector< QVariant > &_parameters, QGenericReturnArgument _returnArg)
Call a function provided by a plugin getting multiple parameters as a vector of qvariants.
ReturnValue callFunctionValue(QString _plugin, QString _functionName)
call a function in another plugin and get a return parameter