com4j.tlbimp.DispInterfaceGenerator Maven / Gradle / Ivy

Go to download
package com4j.tlbimp;

import com4j.GUID;
import com4j.IID;
import com4j.tlbimp.def.IMethod;
import com4j.tlbimp.def.IDispInterfaceDecl;
import com4j.tlbimp.def.IProperty;
import com4j.tlbimp.def.IType;
import com4j.tlbimp.Generator.LibBinder;

import java.util.List;
import java.util.ArrayList;

/**
 * Generates a disp-only interface.
 *
 * @author Kohsuke Kawaguchi
 * @author Michael Schnell (scm, (C) 2008, [email protected])
 */
final class DispInterfaceGenerator extends InvocableInterfaceGenerator {

    public DispInterfaceGenerator(LibBinder lib, IDispInterfaceDecl t) {
        super(lib, t);
    }

    protected List getBaseTypes() {
        return new ArrayList(); // needs to return a fresh list
    }

    protected GUID getIID() {
        return GUID_IDISPATCH;
    }

    protected MethodBinderImpl createMethodBinder(IMethod m) throws BindingException {
        if(EventInterfaceGenerator.isBogusDispatchMethod(m))
            return null;
        else
            return new MethodBinderImpl(g,m);
    }

    private final class MethodBinderImpl extends InvocableInterfaceGenerator.MethodBinderImpl {
        public MethodBinderImpl(Generator g, IMethod method) throws BindingException {
            super(g, method);
        }

        @Override
        protected IType getReturnTypeBinding() {
            return getDispInterfaceReturnType();
        }

        @Override
        protected void annotate(IndentingWriter o) {
            super.annotate(o);
            if(t.isDual()){
                o.printf("@VTID(%1d)",method.getVtableIndex());
                o.println();
            }
            o.printf("@DISPID(%1d)",method.getDispId());
            o.println();
            switch(method.getKind()) {
            case PROPERTYGET:
                o.println("@PropGet");
                break;
            case PROPERTYPUT:
            case PROPERTYPUTREF:
                o.println("@PropPut");
                break;
            }
        }
    }

    @Override
    protected void generateProperty(IProperty p, IndentingWriter o) throws BindingException {
      TypeBinding tb = TypeBinding.bind(this.g, p.getType(), null);
      String typeString = tb.javaType;

      String propName = p.getName().substring(0, 1).toUpperCase() + p.getName().substring(1);

      o.beginJavaDocMode();
      String help = p.getHelpString();
      if(help != null){
        o.println("");
        o.println(help);
        o.println("");
      }
      o.println("");
      o.println("Getter method for the COM property \""+p.getName()+"\"");
      o.println("");
      o.println("@return The COM property " + p.getName() + " as a " + typeString);
      o.endJavaDocMode();
      o.printf("@DISPID(%1d)", p.getDispId());
      o.println();
      o.println("@PropGet");
      o.printf("%s get%s();", typeString, propName);
      o.println();
      o.println();

      o.beginJavaDocMode();
      if(help != null){
        o.println("");
        o.print(help);
        o.println("");
      }
      o.println("");
      o.println("Setter method for the COM property \""+p.getName()+"\"");
      o.println("");
      o.println("@param newValue The new value for the COM property " + p.getName() + " as a " + typeString);
      o.endJavaDocMode();
      o.printf("@DISPID(%1d)", p.getDispId());
      o.println();
      o.println("@PropPut");
      o.printf("void set%s(%s newValue);", propName, typeString);
      o.println();
      o.println();
    }

    private static final GUID GUID_IDISPATCH = new GUID(IID.IDispatch);
}