eu.doppel_helix.jna.tlbcodegenerator.Interface.ftl Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of TlbCodeGenerator Show documentation
Code generator for JNA COM support
The newest version!
[#ftl]
[#--
Copyright (c) 2016 Matthias Bläsing, All Rights Reserved

The contents of this file is dual-licensed under 2
alternative Open Source/Free licenses: LGPL 2.1 or later and
Apache License 2.0.

You can freely decide which license you want to apply to
the project.

You may obtain a copy of the LGPL License at:

http://www.gnu.org/licenses/licenses.html

A copy is also included in the downloadable source code package
containing JNA, in file "LGPL2.1".

You may obtain a copy of the Apache License at:

http://www.apache.org/licenses/

A copy is also included in the downloadable source code package
containing JNA, in file "AL2.0".
--]

[#macro paramList params][#list params as param]
[#if param?index > 0]            [/#if][#if (param.out)]VARIANT[#else]${typeLib.mapPrimitiveIfExists(param.javaType)}[/#if] ${param.name}[#sep],
[/#sep][/#list][/#macro]
[#macro paramListDoc params][#list params as param]
     * @param ${param.name} ${"["}[#if (param.in)]in[/#if][#if (param.out)]out[/#if][#if (param.optional)], optional[/#if]${"]"} {@code ${param.type}}
[/#list][/#macro]

package ${package};

import com.sun.jna.platform.win32.COM.util.annotation.ComInterface;
import com.sun.jna.platform.win32.COM.util.annotation.ComMethod;
import com.sun.jna.platform.win32.COM.util.annotation.ComProperty;
import com.sun.jna.platform.win32.COM.util.IDispatch;
import com.sun.jna.platform.win32.COM.util.IUnknown;
import com.sun.jna.platform.win32.COM.util.IRawDispatchHandle;
import com.sun.jna.platform.win32.Variant.VARIANT;

/**
[#if (entry.docString)?has_content] * ${entry.docString!}
 *
[/#if] * uuid(${entry.guid})
 */
@ComInterface(iid="${entry.guid}")
public interface ${javaName} extends IUnknown, IRawDispatchHandle[#if (entry.dual || entry.dispatch || entry.dispatchable)], IDispatch[/#if] {
    [#list entry.functions as function]
    /**
[#if (function.documentation)?has_content]
     * ${function.documentation}
     *
[/#if]
     * id(${fh.formatHex(function.memberId)})
[#if (function.vtableId)?has_content]
     * vtableId(${function.vtableId})
[/#if]
[@paramListDoc params=function.params/]
     */
    [#if function.property]@ComProperty[#else]@ComMethod[/#if](name = "${function.methodName}", dispId = ${fh.formatHex(function.memberId)})
    ${typeLib.mapPrimitiveIfExists(function.returnType)} ${fh.prepareProperty(function.methodName, function.property, function.setter)}([@paramList params=function.params/]);
            
    [/#list]
    
    [#list entry.dispatchableVariables as variable]
    /**
[#if (variable.documentation)?has_content]
     * ${variable.documentation}
     *
[/#if]
     * id(${fh.formatHex(variable.memberId)})
     */
    @ComProperty(name = "${variable.name}", dispId = ${fh.formatHex(variable.memberId)})
    ${typeLib.mapPrimitiveIfExists(variable.type)} ${fh.preparePropertyGetter(variable.name)}();

[#if ! variable.readonly]
    /**
[#if (variable.documentation)?has_content]
     * ${variable.documentation}
     *
[/#if]
     * id(${fh.formatHex(variable.memberId)})
     */
    @ComProperty(name = "${variable.name}", dispId = ${fh.formatHex(variable.memberId)})
    void ${fh.preparePropertySetter(variable.name)}(${typeLib.mapPrimitiveIfExists(variable.type)} value);

[/#if]
    [/#list]
}