lwjgl/src/java/org/lwjgl/util/generator/NativeTypeTranslator.java

/*
 * Copyright (c) 2002-2008 LWJGL Project
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 * * Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 *
 * * Redistributions 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 'LWJGL' nor the names of
 *   its contributors may be used to endorse or promote products derived
 *   from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

package org.lwjgl.util.generator;

/**
 *
 * A TypeVisitor that translates types (and optional native type
 * annotations) to the native type string.
 *
 * @author elias_naur <elias_naur@users.sourceforge.net>
 * @version $Revision$
 * $Id$
 */

import org.lwjgl.opengl.PointerWrapper;

import com.sun.mirror.declaration.*;
import com.sun.mirror.type.*;
import com.sun.mirror.util.*;

import java.util.Collection;
import java.util.ArrayList;

import java.nio.*;

import java.lang.annotation.Annotation;

/**
 * $Id$
 *
 * A TypeVisitor that translates (annotated) TypeMirrors to
 * native types
 *
 * @author elias_naur <elias_naur@users.sourceforge.net>
 * @version $Revision$
 */
public class NativeTypeTranslator implements TypeVisitor {
	private Collection<Class> native_types;
	private boolean is_indirect;
	private final Declaration declaration;
	private final TypeMap type_map;

	public NativeTypeTranslator(TypeMap type_map, Declaration declaration) {
		this.declaration = declaration;
		this.type_map = type_map;
	}

	public String getSignature() {
		StringBuilder signature = new StringBuilder();
		if (declaration.getAnnotation(Const.class) != null)
			signature.append("const ");

		if ( declaration.getAnnotation(GLpointer.class) != null ) {
			signature.append(declaration.getAnnotation(GLpointer.class).value());
		} else {
			// Use the name of the native type annotation as the C type name
			signature.append(getAnnotationType().getSimpleName());
		}

		if (is_indirect)
			signature.append(" *");
		return signature.toString();
	}

	public Class getAnnotationType() {
		if (native_types.size() != 1)
			throw new RuntimeException("Expected only one native type for declaration " + declaration +
					", but got " + native_types.size());
		return native_types.iterator().next();
	}

	public void visitAnnotationType(AnnotationType t) {
		throw new RuntimeException(t + " is not allowed");
	}

	public void visitArrayType(ArrayType t) {
		if ( "java.lang.CharSequence".equals(t.getComponentType().toString()) ) {
			is_indirect = true;
			native_types = new ArrayList<Class>();
			native_types.add(GLchar.class);
		} else
			throw new RuntimeException(t + " is not allowed");
	}

	public static PrimitiveType.Kind getPrimitiveKindFromBufferClass(Class c) {
		if (IntBuffer.class.equals(c))
			return PrimitiveType.Kind.INT;
		else if (DoubleBuffer.class.equals(c))
			return PrimitiveType.Kind.DOUBLE;
		else if (ShortBuffer.class.equals(c))
			return PrimitiveType.Kind.SHORT;
		else if (ByteBuffer.class.equals(c))
			return PrimitiveType.Kind.BYTE;
		else if (FloatBuffer.class.equals(c))
			return PrimitiveType.Kind.FLOAT;
		else if (LongBuffer.class.equals(c))
			return PrimitiveType.Kind.LONG;
		else
			throw new RuntimeException(c + " is not allowed");
	}

	public static Class<?> getClassFromType(DeclaredType t) {
		try {
			return Class.forName(t.getDeclaration().getQualifiedName());
		} catch (ClassNotFoundException e) {
			throw new RuntimeException(e);
		}
	}

	private void getNativeTypeFromAnnotatedPrimitiveType(PrimitiveType.Kind kind) {
		native_types = translateAnnotations();
		if (native_types.size() == 0)
			native_types.add(type_map.getNativeTypeFromPrimitiveType(kind));
	}

	public void visitClassType(ClassType t) {
		is_indirect = true;

		Class<?> c = getClassFromType(t);
		if (String.class.equals(c)) {
			native_types = new ArrayList<Class>();
			native_types.add(type_map.getStringElementType());
		} else if (Buffer.class.equals(c)) {
			native_types = new ArrayList<Class>();
			native_types.add(type_map.getVoidType());
		} else if (Buffer.class.isAssignableFrom(c)) {
			PrimitiveType.Kind kind = getPrimitiveKindFromBufferClass(c);
			getNativeTypeFromAnnotatedPrimitiveType(kind);
		} else if ( PointerWrapper.class.isAssignableFrom(c) ) {
			native_types = new ArrayList<Class>();
			native_types.add(GLpointer.class);

			is_indirect = false;
		} else
			throw new RuntimeException(t + " is not allowed");
	}

	public void visitPrimitiveType(PrimitiveType t) {
		getNativeTypeFromAnnotatedPrimitiveType(t.getKind());
	}

	public void visitDeclaredType(DeclaredType t) {
		throw new RuntimeException(t + " is not allowed");
	}

	public void visitEnumType(EnumType t) {
		throw new RuntimeException(t + " is not allowed");
	}

	public void visitInterfaceType(InterfaceType t) {
		throw new RuntimeException(t + " is not allowed");
	}

	// Check if the annotation is itself annotated with a certain annotation type
	public static <T extends Annotation> T getAnnotation(AnnotationMirror annotation, Class<T> type) {
		return annotation.getAnnotationType().getDeclaration().getAnnotation(type);
	}

	private static Class translateAnnotation(AnnotationMirror annotation) {
		NativeType native_type = getAnnotation(annotation, NativeType.class);
		if (native_type != null) {
			return getClassFromType(annotation.getAnnotationType());
		} else
			return null;
	}

	private Collection<Class> translateAnnotations() {
		Collection<Class> result = new ArrayList<Class>();
		for (AnnotationMirror annotation : Utils.getSortedAnnotations(declaration.getAnnotationMirrors())) {
			Class translated_result = translateAnnotation(annotation);
			if (translated_result != null) {
				result.add(translated_result);
			}
		}
		return result;
	}

	public void visitReferenceType(ReferenceType t) {
		throw new RuntimeException(t + " is not allowed");
	}

	public void visitTypeMirror(TypeMirror t) {
		throw new RuntimeException(t + " is not allowed");
	}

	public void visitTypeVariable(TypeVariable t) {
		throw new RuntimeException(t + " is not allowed");
	}

	public void visitVoidType(VoidType t) {
		native_types = translateAnnotations();
		if (native_types.size() == 0)
			native_types.add(void.class);
	}

	public void visitWildcardType(WildcardType t) {
		throw new RuntimeException(t + " is not allowed");
	}
}