Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
io.joynr.generator.cpp.util.CppInterfaceUtil.xtend Maven / Gradle / Ivy
package io.joynr.generator.cpp.util
/*
* !!!
*
* Copyright (C) 2011 - 2017 BMW Car IT GmbH
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import com.google.inject.Inject
import io.joynr.generator.templates.util.AttributeUtil
import io.joynr.generator.templates.util.InterfaceUtil
import io.joynr.generator.templates.util.MethodUtil
import io.joynr.generator.templates.util.NamingUtil
import org.franca.core.franca.FInterface
import org.franca.core.franca.FMethod
import org.franca.core.franca.FAttribute
class CppInterfaceUtil extends InterfaceUtil {
@Inject extension NamingUtil
@Inject extension CppStdTypeUtil
@Inject extension AttributeUtil
@Inject extension MethodUtil
@Inject extension JoynrCppGeneratorExtensions
def printFutureReturnDefinition()
'''
* @returns A future representing the result of the asynchronous method call. It provides methods
* to wait for completion, to get the result or the request status object.
'''
def printOnSuccessFctParamDefinition()
'''
* @param onSuccess A callback function to be called once the asynchronous computation has
* finished successfully. It must expect the method out parameters.
'''
def printOnRuntimeErrorFctParamDefinition()
'''
* @param onRuntimeError A callback function to be called once the asynchronous computation has
* failed with an unexpected non-modeled exception. It must expect a JoynrRuntimeException object.
'''
def printOnApplicationErrorFctParamDefinition()
'''
* @param onApplicationError A callback function to be called once the asynchronous computation has
* failed with an unexpected modeled exception. It must expect an Error enum as modeled in Franca.
'''
def printMessagingQosParamDefinition()
'''
* @param qos optional MessagingQos parameter; if specified, this will overwrite the MessagingQos that
* was specified when building the proxy.
'''
def produceSyncGetterSignature(FAttribute attribute, String className, boolean generateVersion)
'''
«val returnType = attribute.getTypeName(generateVersion)»
«val attributeName = attribute.joynrName»
void «IF className !== null»«className»::«ENDIF»get«attributeName.toFirstUpper»(«returnType»& «attributeName», boost::optional qos«IF className===null» = boost::none«ENDIF»)
'''
def produceSyncGetterSignature(FAttribute attribute, boolean generateVersion) {
return produceSyncGetterSignature(attribute, null, generateVersion);
}
def produceSyncGetterDeclarations(FInterface serviceInterface, boolean pure, boolean generateVersion)
'''
«FOR attribute: getAttributes(serviceInterface).filter[attribute | attribute.readable]»
«val attributeName = attribute.joynrName»
/**
* @brief Synchronous getter for the «attributeName» attribute.
*
* @param result The result that will be returned to the caller.
«printMessagingQosParamDefinition»
* @throws JoynrException if the request is not successful
*/
«IF pure»virtual «ENDIF»
«produceSyncGetterSignature(attribute, generateVersion)»
«IF pure»= 0«ELSE»override«ENDIF»;
«ENDFOR»
'''
def produceAsyncGetterSignature(FAttribute attribute, String className, boolean generateVersion)
'''
«val returnType = attribute.getTypeName(generateVersion)»
«val attributeName = attribute.joynrName»
«val defaultArg = if(className === null) " = nullptr" else ""»
std::shared_ptr > «IF className !== null»«className»::«ENDIF»get«attributeName.toFirstUpper»Async(
std::function onSuccess«defaultArg»,
std::function onError«defaultArg»,
boost::optional qos«IF className===null» = boost::none«ENDIF»)
noexcept
'''
def produceAsyncGetterSignature(FAttribute attribute, boolean generateVersion) {
return produceAsyncGetterSignature(attribute, null, generateVersion);
}
def produceAsyncGetterDeclarations(FInterface serviceInterface, boolean pure, boolean generateVersion)
'''
«FOR attribute: getAttributes(serviceInterface).filter[attribute | attribute.readable]»
«val attributeName = attribute.joynrName»
/**
* @brief Asynchronous getter for the «attributeName» attribute.
*
«printOnSuccessFctParamDefinition»
«printOnRuntimeErrorFctParamDefinition»
«printMessagingQosParamDefinition»
«printFutureReturnDefinition»
*/
«IF pure»virtual «ENDIF»
«produceAsyncGetterSignature(attribute, generateVersion)»
«IF pure»= 0«ELSE»override«ENDIF»;
«ENDFOR»
'''
def produceSyncSetterSignature(FAttribute attribute, String className, boolean generateVersion)
'''
«val returnType = attribute.getTypeName(generateVersion)»
«val attributeName = attribute.joynrName»
void «IF className !== null»«className»::«ENDIF»set«attributeName.toFirstUpper»(const «returnType»& «attributeName», boost::optional qos«IF className===null» = boost::none«ENDIF»)
'''
def produceSyncSetterSignature(FAttribute attribute, boolean generateVersion) {
return produceSyncSetterSignature(attribute, null, generateVersion);
}
def produceSyncSetterDeclarations(FInterface serviceInterface, boolean pure, boolean generateVersion)
'''
«FOR attribute: getAttributes(serviceInterface).filter[attribute | attribute.writable]»
«val attributeName = attribute.joynrName»
/**
* @brief Synchronous setter for the «attributeName» attribute.
*
* @param «attributeName» The value to set.
«printMessagingQosParamDefinition»
* @throws JoynrException if the request is not successful
*/
«IF pure»virtual «ENDIF»
«produceSyncSetterSignature(attribute, generateVersion)»
«IF pure»= 0«ELSE»override«ENDIF»;
«ENDFOR»
'''
def produceAsyncSetterSignature(FAttribute attribute, String className, boolean generateVersion)
'''
«val returnType = attribute.getTypeName(generateVersion)»
«val attributeName = attribute.joynrName»
«val defaultArg = if(className === null) " = nullptr" else ""»
std::shared_ptr > «IF className !== null»«className»::«ENDIF»set«attributeName.toFirstUpper»Async(
«returnType» «attributeName»,
std::function onSuccess«defaultArg»,
std::function onError«defaultArg»,
boost::optional qos«IF className===null» = boost::none«ENDIF»)
noexcept
'''
def produceAsyncSetterSignature(FAttribute attribute, boolean generateVersion) {
return produceAsyncSetterSignature(attribute, null, generateVersion);
}
def produceAsyncSetterDeclarations(FInterface serviceInterface, boolean pure, boolean generateVersion)
'''
«FOR attribute: getAttributes(serviceInterface).filter[attribute | attribute.writable]»
«val attributeName = attribute.joynrName»
/**
* @brief Asynchronous setter for the «attributeName» attribute.
*
* @param «attributeName» The value to set.
«printOnSuccessFctParamDefinition»
«printOnRuntimeErrorFctParamDefinition»
«printMessagingQosParamDefinition»
«printFutureReturnDefinition»
*/
«IF pure»virtual «ENDIF»
«produceAsyncSetterSignature(attribute, generateVersion)»
«IF pure»= 0«ELSE»override«ENDIF»;
«ENDFOR»
'''
def produceSyncMethodSignature(FMethod method, String className, boolean generateVersion)
'''
«val outputTypedParamList = method.getCommaSeperatedTypedOutputParameterList(generateVersion)»
«val inputTypedParamList = method.getCommaSeperatedTypedConstInputParameterList(generateVersion)»
void «IF className !== null»«className»::«ENDIF»«method.joynrName»(
«IF !method.outputParameters.empty»
«outputTypedParamList»,
«ENDIF»
«IF !method.inputParameters.empty»
«inputTypedParamList»,
«ENDIF»
boost::optional qos«IF className===null» = boost::none«ENDIF»
)
'''
def produceSyncMethodSignature(FMethod method, boolean generateVersion) {
return produceSyncMethodSignature(method, null, generateVersion);
}
def produceSyncMethodDeclarations(FInterface serviceInterface, boolean pure, boolean generateVersion)
'''
«FOR method: getMethods(serviceInterface).filter[!fireAndForget]»
/**
* @brief Synchronous operation «method.joynrName».
*
«FOR outputParam: method.outputParameters»
* @param «outputParam.getTypeName(generateVersion)» «outputParam.joynrName» this is an output parameter
* and will be set within function «method.joynrName»
«ENDFOR»
«FOR inputParam: method.inputParameters»
* @param «inputParam.getTypeName(generateVersion)» «inputParam.joynrName»
«ENDFOR»
«printMessagingQosParamDefinition»
* @throws JoynrException if the request is not successful
*/
«IF pure»virtual «ENDIF»
«produceSyncMethodSignature(method, generateVersion)»
«IF pure»= 0«ELSE»override«ENDIF»;
«ENDFOR»
'''
def getMethodErrorEnum(FInterface serviceInterface, FMethod method, boolean generateVersion) {
val methodToErrorEnumName = serviceInterface.methodToErrorEnumName;
if(method.errors !== null) {
val packagePath = getPackagePathWithJoynrPrefix(method.errors, "::", generateVersion);
return packagePath + "::" + methodToErrorEnumName.get(method) + "::" + nestedEnumName;
}
else {
return method.errorEnum.getTypeName(generateVersion);
}
}
def produceAsyncMethodSignature(FInterface serviceInterface, FMethod method, String className, boolean generateVersion)
'''
«val outputParameters = method.getCommaSeparatedOutputParameterTypes(generateVersion)»
«val outputTypedParamList = method.getCommaSeperatedTypedConstOutputParameterList(generateVersion)»
«val returnValue = "std::shared_ptr>"»
«val defaultArg = if(className === null) " = nullptr" else ""»
«returnValue» «IF className !== null»«className»::«ENDIF» «method.joynrName»Async(
«IF !method.inputParameters.empty»
«method.getCommaSeperatedTypedConstInputParameterList(generateVersion)»,
«ENDIF»
std::function onSuccess«defaultArg»,
«IF method.hasErrorEnum»
std::function onApplicationError«defaultArg»,
«ENDIF»
std::function onRuntimeError«defaultArg»,
boost::optional qos«IF className===null» = boost::none«ENDIF»
) noexcept
'''
def produceAsyncMethodSignature(FInterface serviceInterface, FMethod method, boolean generateVersion) {
return produceAsyncMethodSignature(serviceInterface, method, null, generateVersion);
}
def produceAsyncMethodDeclarations(FInterface serviceInterface, boolean pure, boolean useDefaultParam, boolean generateVersion)
'''
«FOR method: getMethods(serviceInterface).filter[!fireAndForget]»
/**
* @brief Asynchronous operation «method.joynrName».
*
«printOnSuccessFctParamDefinition»
«IF method.hasErrorEnum»
«printOnApplicationErrorFctParamDefinition»
«ENDIF»
«printOnRuntimeErrorFctParamDefinition»
«printMessagingQosParamDefinition»
«printFutureReturnDefinition»
*/
«IF pure»virtual «ENDIF»
«produceAsyncMethodSignature(serviceInterface, method, generateVersion)»
«IF pure»= 0«ELSE»override«ENDIF»;
«ENDFOR»
'''
def produceFireAndForgetMethodDeclarations(FInterface serviceInterface, boolean pure, boolean generateVersion)
'''
«FOR method: getMethods(serviceInterface).filter[fireAndForget]»
/**
* @brief FireAndForget operation «method.joynrName».
*
«FOR inputParam: method.inputParameters»
* @param «inputParam.getTypeName(generateVersion)» «inputParam.joynrName»
«ENDFOR»
«printMessagingQosParamDefinition»
*/
«IF pure»virtual «ENDIF»
«produceFireAndForgetMethodSignature(method, generateVersion)»
«IF pure»= 0«ELSE»override«ENDIF»;
«ENDFOR»
'''
def produceFireAndForgetMethodSignature(FMethod method, String className, boolean generateVersion)
'''
«val inputTypedParamList = method.getCommaSeperatedTypedConstInputParameterList(generateVersion)»
void «IF className !== null»«className»::«ENDIF»«method.joynrName»(
«IF !method.inputParameters.empty»
«inputTypedParamList»,
«ENDIF»
boost::optional qos«IF className===null» = boost::none«ENDIF»)
'''
def produceFireAndForgetMethodSignature(FMethod method, boolean generateVersion) {
return produceSyncMethodSignature(method, null, generateVersion);
}
def produceApplicationRuntimeErrorSplitForOnErrorWrapper(FInterface serviceInterface, FMethod method, boolean generateVersion)
'''
«IF method.hasErrorEnum»
future->onError(error);
if (const exceptions::JoynrRuntimeException* runtimeError = dynamic_cast(error.get())) {
if(onRuntimeError) {
onRuntimeError(*runtimeError);
}
}
else if (const exceptions::ApplicationException* applicationError = dynamic_cast(error.get())) {
const std::string& enumName = applicationError->getName();
if(onApplicationError) {
JOYNR_LOG_DEBUG(logger(), "An ApplicationException was received. Error: {}, message: {}", enumName, applicationError->getMessage());
onApplicationError(muesli::EnumTraits<«getMethodErrorEnum(serviceInterface, method, generateVersion)»>::Wrapper::getEnum(enumName));
}
else if (onRuntimeError) {
const std::string errorMessage = "An ApplicationException was received, but no onApplicationError callback function was provided." \
" Error " + enumName + ", message: " + applicationError->getMessage();
JOYNR_LOG_WARN(logger(), errorMessage);
onRuntimeError(exceptions::JoynrRuntimeException(errorMessage));
}
else{
JOYNR_LOG_WARN(logger(),
"An ApplicationException was received, but no callback function was provided. Error {}, message: {}",
enumName, applicationError->getMessage());
}
}
else {
const std::string errorMessage = "Unknown exception: " + error->getTypeName() + ": " + error->getMessage();
JOYNR_LOG_ERROR(logger(), errorMessage);
if (onRuntimeError) {
onRuntimeError(exceptions::JoynrRuntimeException(errorMessage));
}
}
«ELSE»
if (const exceptions::ApplicationException* applicationError = dynamic_cast(error.get())) {
const std::string& enumName = applicationError->getName();
const std::string errorMessage = "An ApplicationException was received, but none was expected." \
" Is the provider version incompatible with the consumer?" \
" Error " + enumName + ", message: " + applicationError->getMessage();
JOYNR_LOG_ERROR(logger(), errorMessage);
std::shared_ptr wrappedException = std::make_shared(errorMessage);
future->onError(wrappedException);
if (onRuntimeError) {
onRuntimeError(static_cast(*wrappedException));
}
}
else {
future->onError(error);
if (onRuntimeError) {
onRuntimeError(static_cast(*error));
}
}
«ENDIF»
'''
}
