path: root/src/java/com/sun/gluegen/opengl/GLEmitter.java

/*
 * 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.opengl;

import java.io.*;
import java.text.MessageFormat;
import java.util.*;
import com.sun.gluegen.*;
import com.sun.gluegen.cgram.types.*;
import com.sun.gluegen.procaddress.*;
import com.sun.gluegen.runtime.*;
import com.sun.gluegen.runtime.opengl.GLExtensionNames;

/**
 * A subclass of ProcAddressEmitter with special OpenGL-specific
 * configuration abilities.
 */
public class GLEmitter extends ProcAddressEmitter
{
  // Keeps track of which MethodBindings were created for handling
  // Buffer Object variants. Used as a Set rather than a Map.
  private Map/*<MethodBinding>*/ bufferObjectMethodBindings = new IdentityHashMap();

  static class BufferObjectKind {
    private BufferObjectKind() {}

    static final BufferObjectKind UNPACK_PIXEL = new BufferObjectKind();
    static final BufferObjectKind PACK_PIXEL   = new BufferObjectKind();
    static final BufferObjectKind ARRAY        = new BufferObjectKind();
    static final BufferObjectKind ELEMENT      = new BufferObjectKind();
  }
  
  public void beginEmission(GlueEmitterControls controls) throws IOException
  {
    getGLConfig().parseGLHeaders(controls);
    super.beginEmission(controls);
  }

  class DefineEntry implements Cloneable {
    public DefineEntry(String namestr, String valuestr, String optionalComment) {
        this.name=new GLUnifiedName(namestr);
        this.value=getJavaValue(namestr, valuestr);
        this.type=getJavaType(namestr, this.value);
        this.radix=getJavaRadix(namestr, valuestr);
        this.optionalComment=optionalComment;
    }

    protected DefineEntry(GLUnifiedName name, String type, Object value, int radix, String optionalComment) {
        this.name=name;
        this.value=value;
        this.type=type;
        this.radix=radix;
        this.optionalComment=optionalComment;
    }

    public Object clone() {
        return new DefineEntry((GLUnifiedName)name.clone(), type, value, radix, optionalComment);
    }

    public boolean equals(Object obj) {
        if (obj == this) {
          return true;
        }
        if(null==obj || !(obj instanceof DefineEntry)) return false;
        DefineEntry de = (DefineEntry) obj;
        return name.getUni().equals(de.name.getUni()) &&
               type.equals(de.type) &&
               value.equals(de.value);
    }

    public String toString() {
        String res = "  public static final " + type + " " + name + " = ";
        if(16!=radix) {
            res = res + value;
        } else {
            res = res.concat("0x");
            if(value instanceof Integer) {
                res = res.concat( Integer.toString( ((Integer)value).intValue(), radix ).toUpperCase() );
            } else if(value instanceof Long) {
                res = res.concat( Long.toString( ((Long)value).longValue(), radix ).toUpperCase() );
            } else {
                res = res + value;
            }
        }

        return res.concat(";");
    }

    public String getOptCommentString() {
        if (optionalComment != null && optionalComment.length() > 0) {
          return "  /** " + optionalComment + " */";
        }
        return new String();
    }

    public void add(String name) {
        this.name.add(name);
    }
    public boolean isExtensionVEN() {
        return name.isExtensionVEN();
    }
    public void normalizeVEN() {
        name.normalizeVEN();
    }
    public boolean shouldIgnoreInInterface(GLConfiguration cfg) {
        return GLEmitter.this.shouldIgnoreInInterface(name, cfg);
    }

    protected GLUnifiedName name;
    protected Object value;
    protected String type;
    protected int radix;
    protected String optionalComment;
  }

  protected boolean shouldIgnoreInInterface(GLUnifiedName name, GLConfiguration cfg) {
        boolean res = cfg.shouldIgnoreInInterface(name.getUni(), name.isUnique());
        if(JavaConfiguration.DEBUG_IGNORES) {
            if(res) {
              System.err.println("Ignore If Uni: "+name);
            }
        } /*
        for (Iterator iter = name.getNameList().iterator(); !res && iter.hasNext(); ) {
            String s = (String)iter.next();
            res = cfg.shouldIgnoreInInterface(s, false);
            if(JavaConfiguration.DEBUG_IGNORES) {
                if(res) {
                  System.err.println("Ignore If Ext: "+name+", "+s);
                }
            }
        } */
        return res;
  }

  protected boolean shouldIgnoreInImpl(GLUnifiedName name, GLConfiguration cfg) {
        boolean res = cfg.shouldIgnoreInImpl(name.getUni(), name.isUnique());
        if(JavaConfiguration.DEBUG_IGNORES) {
          if(res) {
              System.err.println("Ignore Impl Uni: "+name);
          }
        }
        /*
        if(!cfg.extendedIfSymbolsOnly()) {
            for (Iterator iter = name.getNameList().iterator(); !res && iter.hasNext(); ) {
                String s = (String)iter.next();
                res = cfg.shouldIgnoreInImpl(s, false);
                if(JavaConfiguration.DEBUG_IGNORES) {
                  if(res) {
                      System.err.println("Ignore Impl Ext: "+name+", "+s);
                  }
                }
            }
        } */
        return res;
  }

  protected LinkedHashMap/*<String name, DefineEntry entry>*/ defineMap = new LinkedHashMap();

  public void beginDefines() throws Exception
  {
    super.beginDefines();
  }

  /**
   * Pass-1 Unify ARB extensions with the same value
   */
  public void emitDefine(String name, String value, String optionalComment) throws Exception {
    if (cfg.allStatic() || cfg.emitInterface()) {
      // unify ARB and map names
      DefineEntry deNew = new DefineEntry(name, value, optionalComment);
      DefineEntry deExist = (DefineEntry) defineMap.get(deNew.name.getUni());
      if(deExist!=null) {
        // non ARB counterpart exist ..
        if(deNew.equals(deExist)) {
            if(deNew.getOptCommentString().length()>deExist.getOptCommentString().length()) {
                deExist.optionalComment=deNew.optionalComment;
            }
            deExist.add(name);
            return; // done ..
        }
        deNew.name.resetUni();
        System.err.println("WARNING: Normalized ARB entry with different value exists (keep ARB orig):"+
                           "\n\tDef: "+deExist+
                           "\n\tNew: "+deNew);
      }
      defineMap.put(deNew.name.getUni(), deNew);
    }
  }

  /**
   * Pass-2 Unify vendor extensions, 
   *        if exist as an ARB extension with the same value.
   * Pass-3 Emit all ..
   */
  public void endDefines() throws Exception
  {
    if (cfg.allStatic() || cfg.emitInterface()) {
        Iterator/*<DefineEntry>*/ deIter = null; 

        // unify VEN
        deIter = defineMap.values().iterator();
        while( deIter.hasNext() ) {
            DefineEntry de = (DefineEntry) deIter.next();
            if(de.isExtensionVEN()) {
                String extSuffix = GLExtensionNames.getExtensionSuffix(de.name.getUni(), false);
                DefineEntry deUni = (DefineEntry) de.clone();
                deUni.normalizeVEN();
                DefineEntry deExist = (DefineEntry) defineMap.get(deUni.name.getUni());
                if(null!=deExist) {
                    if(deUni.equals(deExist)) {
                        if(deUni.getOptCommentString().length()>deExist.getOptCommentString().length()) {
                            deExist.optionalComment=deUni.optionalComment;
                        }
                        deIter.remove();
                        deExist.add(de.name.getUni());
                    } else {
                        if( ((GLConfiguration)cfg).getDropUniqVendorExtensions(extSuffix) ) {
                            deIter.remove(); // remove non unified (uniq) vendor extension
                            System.err.println("INFO: Drop uniq VEN entry: "+de.name.getUni());
                        } else {
                            System.err.println("INFO: Normalized VEN entry with different value exists (keep VEN orig):"+
                                               "\n\tDef: "+deExist+
                                               "\n\tNew: "+de);
                       }
                   }
                } else if( ((GLConfiguration)cfg).getDropUniqVendorExtensions(extSuffix) ) {
                    deIter.remove(); // remove non unified (uniq) vendor extension
                    System.err.println("INFO: Drop uniq VEN entry: "+de.name.getUni());
                }
            }
        }

        // add mapping and emit ..
        deIter = defineMap.values().iterator();
        while( deIter.hasNext() ) {
            DefineEntry de = (DefineEntry) deIter.next();
            if (de.shouldIgnoreInInterface((GLConfiguration)cfg)) {
                continue;
            }
            String comment = de.getOptCommentString();
            if (comment.length() != 0) {
              javaWriter().println(comment);
            } else {
                comment = de.name.getCommentString();
                if (comment.length() != 0) {
                  de.name.resetOriginal(); // just shorten the comment space
                  javaWriter().println(comment);
                }
            }
            javaWriter().println(de.toString());
        }
    }
    defineMap.clear();

    super.endDefines();
  }

  protected JavaConfiguration createConfig() {
    return new GLConfiguration(this);
  }

  /** In order to implement Buffer Object variants of certain
      functions we generate another MethodBinding which maps the void*
      argument to a Java long. The generation of emitters then takes
      place as usual. We do however need to keep track of the modified
      MethodBinding object so that we can also modify the emitters
      later to inform them that their argument has changed. We might
      want to push this functionality down into the MethodBinding
      (i.e., mutators for argument names). We also would need to
      inform the CMethodBindingEmitter that it is overloaded in this
      case (though we default to true currently). */
  protected List/*<MethodBinding>*/ expandMethodBinding(MethodBinding binding) {
    List/*<MethodBinding>*/ bindings = super.expandMethodBinding(binding);
    
    if (!getGLConfig().isBufferObjectFunction(binding.getName())) {
      return bindings;
    }

    List/*<MethodBinding>*/ newBindings = new ArrayList();
    newBindings.addAll(bindings);

    // Need to expand each one of the generated bindings to take a
    // Java long instead of a Buffer for each void* argument
    for (Iterator iter = bindings.iterator(); iter.hasNext(); ) {
      MethodBinding cur = (MethodBinding) iter.next();
      
      // Some of these routines (glBitmap) take strongly-typed
      // primitive pointers as arguments which are expanded into
      // non-void* arguments
      // This test (rather than !signatureUsesNIO) is used to catch
      // more unexpected situations
      if (cur.signatureUsesJavaPrimitiveArrays()) {
        continue;
      }

      MethodBinding result = cur;
      for (int i = 0; i < cur.getNumArguments(); i++) {
        if (cur.getJavaArgumentType(i).isNIOBuffer()) {
          result = result.replaceJavaArgumentType(i, JavaType.createForClass(Long.TYPE));
        }
      }

      if (result == cur) {
        throw new RuntimeException("Error: didn't find any void* arguments for BufferObject function " +
                                   binding.getName());
      }

      newBindings.add(result);
      // Now need to flag this MethodBinding so that we generate the
      // correct flags in the emitters later
      bufferObjectMethodBindings.put(result, result);
    }

    return newBindings;
  }

  protected boolean needsModifiedEmitters(FunctionSymbol sym) {
    if ((!needsProcAddressWrapper(sym) && !needsBufferObjectVariant(sym)) ||
        getConfig().isUnimplemented(sym.getName())) {
      return false;
    }

    return true;
  }

  public boolean isBufferObjectMethodBinding(MethodBinding binding) {
    return bufferObjectMethodBindings.containsKey(binding);
  }

  //----------------------------------------------------------------------
  // Internals only below this point
  //

  protected void validateFunctionsToBind(Set/*FunctionSymbol*/ funcsSet) {

    String localCallingConvention = ((GLConfiguration)cfg).getLocalProcAddressCallingConvention4All();
    if(null==localCallingConvention) {
        localCallingConvention="GL_APIENTRY";
    }
    ArrayList newUniFuncs = new ArrayList();

    // 1st Pass: map function names and process ARB extensions
    for (Iterator iter = funcsSet.iterator(); iter.hasNext(); ) {
      FunctionSymbol fsOrig = (FunctionSymbol) iter.next();
      String fname = fsOrig.getName();
      GLUnifiedName uniName;
      {
          uniName = (GLUnifiedName) GLUnifiedName.getOrPut(cfg.getUniqNameMap(), fname);
          String renamedName = cfg.getJavaMethodRename(fname);
          if(null!=renamedName) {
            fname = renamedName;
            uniName.setUni(fname);
            uniName.remapAllNames(cfg.getUniqNameMap());
          }
      }

      if(GLExtensionNames.isExtensionARB(fname, true)) {
          if(!((GLConfiguration)cfg).skipProcAddressGen(fname)) {
              // Do not process ignored functions with this logic
              // because if we do then we will not be able to later
              // tell that the function should be ignored
              if (!((GLConfiguration)cfg).shouldIgnoreInImpl(fname)) {
                  FunctionSymbol fsUni = new FunctionSymbol(uniName.getUni(), fsOrig.getType());
                  if(!funcsSet.contains(fsUni)) {
                      newUniFuncs.add(fsUni); // add new uni name
                      System.err.println("INFO: New ARB Normalized Function:"+
                                         "\n\tARB: "+fsOrig+
                                         "\n\tUNI: "+fsUni);
                  } else {
                      System.err.println("INFO: Dub ARB Normalized Function:"+
                                         "\n\tARB: "+fsOrig+
                                         "\n\tDUB: "+fsUni);
                  }

                  iter.remove(); // remove ARB function
                  // make the function being dynamical fetched, due to it's dynamic naming scheme
                  ((GLConfiguration)cfg).addForceProcAddressGen(uniName.getUni());
                  // Make sure we produce the right calling convention for
                  // the typedefed function pointers on Windows
                  ((GLConfiguration)cfg).addLocalProcAddressCallingConvention(uniName.getUni(), localCallingConvention);
              }
          }
      }
      if(JavaConfiguration.DEBUG_IGNORES) {
          System.err.println("1st Pass: "+uniName); 
      }
    }
    funcsSet.addAll(newUniFuncs);

    // 2nd Pass: Unify VEN extensions
    for (Iterator iter = funcsSet.iterator(); iter.hasNext(); ) {
      FunctionSymbol fsOrig = (FunctionSymbol) iter.next();
      String fname = fsOrig.getName();
      GLUnifiedName uniName = (GLUnifiedName)cfg.getUniqNameMap().get(fname);
      if(null==uniName) {
        throw new RuntimeException("no mapping found for: "+fname);
      }

      if(GLExtensionNames.isExtensionVEN(fname, true)) {
          uniName.normalizeVEN();
          uniName.remapAllNames(cfg.getUniqNameMap());
          String extSuffix = GLExtensionNames.getExtensionSuffix(fname, true);
          FunctionSymbol fsUni = new FunctionSymbol(uniName.getUni(), fsOrig.getType());
          if(funcsSet.contains(fsUni)) {
              iter.remove(); // remove VEN function (already incl. as ARB)
              System.err.println("INFO: Dub VEN Function:"+
                                 "\n\tVEN: "+fsOrig+
                                 "\n\tDUB: "+fsUni);
          } else if( ((GLConfiguration)cfg).getDropUniqVendorExtensions(extSuffix) ) {
            iter.remove(); // remove non unified (uniq) vendor extension
            System.err.println("INFO: Drop uniq VEN Function: "+fsOrig.getName());
          }
      }
      if(JavaConfiguration.DEBUG_IGNORES) {
          System.err.println("2nd Pass: "+uniName); 
      }
    }

    // 3rd Pass: Remove all ignored functions
    for (Iterator iter = funcsSet.iterator(); iter.hasNext(); ) {
      FunctionSymbol fsOrig = (FunctionSymbol) iter.next();
      GLUnifiedName uniName = (GLUnifiedName)cfg.getUniqNameMap().get(fsOrig.getName());
      if(null==uniName) {
        throw new RuntimeException("no mapping found for: "+fsOrig.getName());
      }
      if (cfg.shouldIgnoreInImpl(fsOrig.getName())) {
        if(JavaConfiguration.DEBUG_IGNORES) {
            System.err.println("INFO: Ignored: Remove Function:"+ uniName);
        }
        iter.remove(); // remove ignored function 
      }
    }
  }

  
  protected void generateModifiedEmitters(JavaMethodBindingEmitter baseJavaEmitter, List emitters) {
    List superEmitters = new ArrayList();
    super.generateModifiedEmitters(baseJavaEmitter, superEmitters);

    // See whether this is one of the Buffer Object variants
    boolean bufferObjectVariant = bufferObjectMethodBindings.containsKey(baseJavaEmitter.getBinding());

    for (Iterator iter = superEmitters.iterator(); iter.hasNext(); ) {
        JavaMethodBindingEmitter emitter = (JavaMethodBindingEmitter) iter.next();
        if (emitter instanceof ProcAddressJavaMethodBindingEmitter) {
          emitters.add(new GLJavaMethodBindingEmitter((ProcAddressJavaMethodBindingEmitter) emitter, this, bufferObjectVariant));
        } else {
          emitters.add(emitter);
        }
    }
  }

  protected boolean needsBufferObjectVariant(FunctionSymbol sym) {
    return getGLConfig().isBufferObjectFunction(sym.getName());
  }
  
  protected GLConfiguration getGLConfig() {
    return (GLConfiguration) getConfig();
  }

  protected void endProcAddressTable() throws Exception
  {
    PrintWriter w = tableWriter;

    w.println("  /**");
    w.println("   * This is a convenience method to get (by name) the native function");
    w.println("   * pointer for a given function. It lets you avoid having to");
    w.println("   * manually compute the &quot;" + PROCADDRESS_VAR_PREFIX + " + ");
    w.println("   * &lt;functionName&gt;&quot; member variable name and look it up via");
    w.println("   * reflection; it also will throw an exception if you try to get the");
    w.println("   * address of an unknown function, or one that is statically linked");
    w.println("   * and therefore does not have a function pointer in this table.");
    w.println("   *");
    w.println("   * @throws RuntimeException if the function pointer was not found in");
    w.println("   *   this table, either because the function was unknown or because");
    w.println("   *   it was statically linked.");
    w.println("   */");
    w.println("  public long getAddressFor(String functionNameUsr) {");
    w.println("    String functionNameBase = com.sun.gluegen.runtime.opengl.GLExtensionNames.normalizeVEN(com.sun.gluegen.runtime.opengl.GLExtensionNames.normalizeARB(functionNameUsr, true), true);");
    w.println("    String addressFieldNameBase = " + getProcAddressConfig().gluegenRuntimePackage() + ".ProcAddressHelper.PROCADDRESS_VAR_PREFIX + functionNameBase;");
    w.println("    java.lang.reflect.Field addressField = null;");
    w.println("    int  funcNamePermNum = com.sun.gluegen.runtime.opengl.GLExtensionNames.getFuncNamePermutationNumber(functionNameBase);");
    w.println("    for(int i = 0; null==addressField && i < funcNamePermNum; i++) {");
    w.println("        String addressFieldName = com.sun.gluegen.runtime.opengl.GLExtensionNames.getFuncNamePermutation(addressFieldNameBase, i);");
    w.println("        try {");
    w.println("          addressField = getClass().getField(addressFieldName);");
    w.println("        } catch (Exception e) { }");
    w.println("    }");
    w.println("");
    w.println("    if(null==addressField) {");
    w.println("      // The user is calling a bogus function or one which is not");
    w.println("      // runtime linked");
    w.println("      throw new RuntimeException(");
    w.println("          \"WARNING: Address field query failed for \\\"\" + functionNameBase + \"\\\"/\\\"\" + functionNameUsr +");
    w.println("          \"\\\"; it's either statically linked or address field is not a known \" +");
    w.println("          \"function\");");
    w.println("    } ");
    w.println("    try {");
    w.println("      return addressField.getLong(this);");
    w.println("    } catch (Exception e) {");
    w.println("      throw new RuntimeException(");
    w.println("          \"WARNING: Address query failed for \\\"\" + functionNameBase + \"\\\"/\\\"\" + functionNameUsr +");
    w.println("          \"\\\"; it's either statically linked or is not a known \" +");
    w.println("          \"function\", e);");
    w.println("    }");
    w.println("  }");

    w.println("} // end of class " + tableClassName);
    w.flush();
    w.close();
  }

  protected void emitProcAddressTableEntryForSymbol(FunctionSymbol cFunc)
  {
    emitProcAddressTableEntryForString(cFunc.getName());
  }

  protected void emitProcAddressTableEntryForString(String str)
  {
    // Deal gracefully with forced proc address generation in the face
    // of having the function pointer typedef in the header file too
    if (emittedTableEntries.contains(str))
      return;
    emittedTableEntries.add(str);
    tableWriter.print("  public long ");
    tableWriter.print(PROCADDRESS_VAR_PREFIX);
    tableWriter.print(str);
    tableWriter.println(";");
  }

}