/*
 * 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.util.*;
import com.sun.gluegen.*;
import com.sun.gluegen.cgram.types.*;
import com.sun.gluegen.procaddress.*;

/** A specialization of the proc address emitter which knows how to
    change argument names to take into account Vertex Buffer Object /
    Pixel Buffer Object variants. */

public class GLJavaMethodBindingEmitter extends ProcAddressJavaMethodBindingEmitter {
  protected boolean bufferObjectVariant;
  protected GLEmitter glEmitter;
  protected CommentEmitter glCommentEmitter = new GLCommentEmitter();
  
  public GLJavaMethodBindingEmitter(JavaMethodBindingEmitter methodToWrap,
                                    boolean callThroughProcAddress,
                                    String  getProcAddressTableExpr,
                                    boolean changeNameAndArguments,
                                    boolean bufferObjectVariant,
                                    GLEmitter emitter) {
    super(methodToWrap,
          callThroughProcAddress,
          getProcAddressTableExpr,
          changeNameAndArguments,
          emitter);
    this.bufferObjectVariant = bufferObjectVariant;
    this.glEmitter=emitter;
    setCommentEmitter(glCommentEmitter);
  }

  public GLJavaMethodBindingEmitter(ProcAddressJavaMethodBindingEmitter methodToWrap,
                                    GLEmitter emitter,
                                    boolean bufferObjectVariant) {
    super(methodToWrap);
    this.bufferObjectVariant = bufferObjectVariant;
    this.glEmitter=emitter;
    setCommentEmitter(glCommentEmitter);
  }

  public GLJavaMethodBindingEmitter(GLJavaMethodBindingEmitter methodToWrap) {
    this(methodToWrap, methodToWrap.glEmitter, methodToWrap.bufferObjectVariant);
  }

  protected String getArgumentName(int i) {
    String name = super.getArgumentName(i);

    if (!bufferObjectVariant) {
      return name;
    }

    // Emitters for VBO/PBO-related routines change the outgoing
    // argument name for the buffer
    if (binding.getJavaArgumentType(i).isLong()) {
      Type cType = binding.getCArgumentType(i);
      if (cType.isPointer() &&
          (cType.asPointer().getTargetType().isVoid() ||
           cType.asPointer().getTargetType().isPrimitive())) {
        return name + "_buffer_offset";
      }
    }

    return name;
  }

  protected class GLCommentEmitter
    extends JavaMethodBindingEmitter.DefaultCommentEmitter
  {
    protected void emitBindingCSignature(MethodBinding binding, PrintWriter writer) {      
      super.emitBindingCSignature(binding, writer);
      String extensionName = glEmitter.getGLConfig().getExtension(binding.getCSymbol().getName());
      if(null!=extensionName) {
          writer.print("<br>Part of <code>"+extensionName+"</code>");
      } else {
          writer.print("<br>Part of <code>unknown extension</code>");
      }
    }
  }
}