aboutsummaryrefslogtreecommitdiffstats
path: root/src/classes/com/sun/gluegen/procaddress/ProcAddressCMethodBindingEmitter.java
blob: 423f009e21ac14af10805657756f04f5981f88e4 (plain)
1
2
3
4
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
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
/*
 * Copyright (c) 2003-2005 Sun Microsystems, Inc. All Rights Reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 * 
 * - Redistribution of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * 
 * - Redistribution in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 * 
 * Neither the name of Sun Microsystems, Inc. or the names of
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 * 
 * This software is provided "AS IS," without a warranty of any kind. ALL
 * EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND WARRANTIES,
 * INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A
 * PARTICULAR PURPOSE OR NON-INFRINGEMENT, ARE HEREBY EXCLUDED. SUN
 * MICROSYSTEMS, INC. ("SUN") AND ITS LICENSORS SHALL NOT BE LIABLE FOR
 * ANY DAMAGES SUFFERED BY LICENSEE AS A RESULT OF USING, MODIFYING OR
 * DISTRIBUTING THIS SOFTWARE OR ITS DERIVATIVES. IN NO EVENT WILL SUN OR
 * ITS LICENSORS BE LIABLE FOR ANY LOST REVENUE, PROFIT OR DATA, OR FOR
 * DIRECT, INDIRECT, SPECIAL, CONSEQUENTIAL, INCIDENTAL OR PUNITIVE
 * DAMAGES, HOWEVER CAUSED AND REGARDLESS OF THE THEORY OF LIABILITY,
 * ARISING OUT OF THE USE OF OR INABILITY TO USE THIS SOFTWARE, EVEN IF
 * SUN HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
 * 
 * You acknowledge that this software is not designed or intended for use
 * in the design, construction, operation or maintenance of any nuclear
 * facility.
 * 
 * Sun gratefully acknowledges that this software was originally authored
 * and developed by Kenneth Bradley Russell and Christopher John Kline.
 */

package com.sun.gluegen.procaddress;

import java.io.*;
import java.util.*;
import com.sun.gluegen.*;
import com.sun.gluegen.cgram.types.*;

public class ProcAddressCMethodBindingEmitter extends CMethodBindingEmitter {
  private boolean callThroughProcAddress;
  private static String procAddressJavaTypeName =
    JavaType.createForClass(Long.TYPE).jniTypeName();
  private ProcAddressEmitter emitter;

  public ProcAddressCMethodBindingEmitter(CMethodBindingEmitter methodToWrap,
                                          final boolean callThroughProcAddress,
                                          ProcAddressEmitter emitter) {
    super(
      new MethodBinding(methodToWrap.getBinding()) {
        public String getName() {
          if (callThroughProcAddress) {
            return ProcAddressEmitter.WRAP_PREFIX + super.getName();
          } else {
            return super.getName();
          }
        }

        public String getRenamedMethodName() {
          if (callThroughProcAddress) {
            return ProcAddressEmitter.WRAP_PREFIX + super.getRenamedMethodName();
          } else {
            return super.getRenamedMethodName();
          }
        }
      },
      methodToWrap.getDefaultOutput(),
      methodToWrap.getJavaPackageName(),
      methodToWrap.getJavaClassName(),
      methodToWrap.getIsOverloadedBinding(),
      methodToWrap.getIsJavaMethodStatic(),
      true,
      methodToWrap.forIndirectBufferAndArrayImplementation()
    );

    if (methodToWrap.getReturnValueCapacityExpression() != null) {
      setReturnValueCapacityExpression(methodToWrap.getReturnValueCapacityExpression());
    }
    if (methodToWrap.getReturnValueLengthExpression() != null) {
      setReturnValueLengthExpression(methodToWrap.getReturnValueLengthExpression());
    }
    setTemporaryCVariableDeclarations(methodToWrap.getTemporaryCVariableDeclarations());
    setTemporaryCVariableAssignments (methodToWrap.getTemporaryCVariableAssignments ());
    
    setCommentEmitter(defaultCommentEmitter);
    this.callThroughProcAddress = callThroughProcAddress;
    this.emitter = emitter;
  }
  
  protected int emitArguments(PrintWriter writer) {
    int numEmitted = super.emitArguments(writer);
    if (callThroughProcAddress) {
      if (numEmitted > 0)
        {
          writer.print(", ");
        }
      writer.print(procAddressJavaTypeName);
      writer.print(" procAddress");
      ++numEmitted;
    }

    return numEmitted;
  }

  protected void emitBodyVariableDeclarations(PrintWriter writer) {
    if (callThroughProcAddress) {
      // create variable for the function pointer with the right type, and set
      // it to the value of the passed-in glProcAddress 
      FunctionSymbol cSym = getBinding().getCSymbol();
      String funcPointerTypedefName =
        emitter.getFunctionPointerTypedefName(cSym);
    
      writer.print("  ");
      writer.print(funcPointerTypedefName);
      writer.print(" ptr_");
      writer.print(cSym.getName());
      writer.println(";");
    }

    super.emitBodyVariableDeclarations(writer);
  }

  protected void emitBodyVariablePreCallSetup(PrintWriter writer,
                                              boolean emittingPrimitiveArrayCritical) {
    super.emitBodyVariablePreCallSetup(writer, emittingPrimitiveArrayCritical);

    if (callThroughProcAddress) {
      if (!emittingPrimitiveArrayCritical) {
        // set the function pointer to the value of the passed-in glProcAddress
        FunctionSymbol cSym = getBinding().getCSymbol();
        String funcPointerTypedefName = emitter.getFunctionPointerTypedefName(cSym);

        String ptrVarName = "ptr_" + cSym.getName();
    
        writer.print("  ");
        writer.print(ptrVarName);
        writer.print(" = (");
        writer.print(funcPointerTypedefName);
        writer.println(") (intptr_t) procAddress;");

        writer.println("  assert(" + ptrVarName + " != NULL);");
      }
    }
  }

  protected void emitBodyCallCFunction(PrintWriter writer) {
    if (!callThroughProcAddress) {
      super.emitBodyCallCFunction(writer);
    } else {
      // Make the call to the actual C function
      writer.print("  ");

      // WARNING: this code assumes that the return type has already been
      // typedef-resolved.
      Type cReturnType = binding.getCReturnType();

      if (!cReturnType.isVoid()) {
        writer.print("_res = ");
      }
      MethodBinding binding = getBinding();
      if (binding.hasContainingType()) {
        // FIXME: this can and should be handled and unified with the
        // associated code in the CMethodBindingEmitter
        throw new IllegalStateException("Cannot call through function pointer because binding has containing type: " + binding);
      }

      // call throught the run-time function pointer
      writer.print("(* ptr_");
      writer.print(binding.getCSymbol().getName());
      writer.print(") ");
      writer.print("(");
      emitBodyPassCArguments(writer);
      writer.println(");");
    }
  }

  protected String jniMangle(MethodBinding binding) {
    StringBuffer buf = new StringBuffer(super.jniMangle(binding));
    if (callThroughProcAddress) {
      jniMangle(Long.TYPE, buf, false);  // to account for the additional _addr_ parameter
    }
    return buf.toString();
  }
}