src/compiler/Types.h

//
// Copyright (c) 2002-2010 The ANGLE Project Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
//

#ifndef _TYPES_INCLUDED
#define _TYPES_INCLUDED

#include "compiler/Common.h"
#include "compiler/BaseTypes.h"

//
// Need to have association of line numbers to types in a list for building structs.
//
class TType;
struct TTypeLine {
	TType* type;
	int line;
};
typedef TVector<TTypeLine> TTypeList;

inline TTypeList* NewPoolTTypeList()
{
	void* memory = GlobalPoolAllocator.allocate(sizeof(TTypeList));
	return new(memory) TTypeList;
}

//
// This is a workaround for a problem with the yacc stack,  It can't have
// types that it thinks have non-trivial constructors.  It should
// just be used while recognizing the grammar, not anything else.  Pointers
// could be used, but also trying to avoid lots of memory management overhead.
//
// Not as bad as it looks, there is no actual assumption that the fields
// match up or are name the same or anything like that.
//
class TPublicType {
public:
	TBasicType type;
	TQualifier qualifier;
	TPrecision precision;
	int size;          // size of vector or matrix, not size of array
	bool matrix;
	bool array;
	int arraySize;
	TType* userDef;
	int line;

	void setBasic(TBasicType bt, TQualifier q, int ln = 0)
	{
		type = bt;
		qualifier = q;
		precision = EbpHigh;
		size = 1;
		matrix = false;
		array = false;
		arraySize = 0;
		userDef = 0;
		line = ln;
	}

	void setPrecision(TPrecision pcs)
	{
		precision = pcs;
	}

	void setAggregate(int s, bool m = false)
	{
		size = s;
		matrix = m;
	}

	void setArray(bool a, int s = 0)
	{
		array = a;
		arraySize = s;
	}
};

typedef TMap<TTypeList*, TTypeList*> TStructureMap;
typedef TMap<TTypeList*, TTypeList*>::iterator TStructureMapIterator;
//
// Base class for things that have a type.
//
class TType {
public:
	POOL_ALLOCATOR_NEW_DELETE(GlobalPoolAllocator)
	explicit TType(TBasicType t, TQualifier q = EvqTemporary, int s = 1, bool m = false, bool a = false, TPrecision p = EbpHigh) :
							type(t), precision(p), qualifier(q), size(s), matrix(m), array(a), arraySize(0),
							structure(0), structureSize(0), maxArraySize(0), arrayInformationType(0), fieldName(0), mangled(0), typeName(0)
							{ }
	explicit TType(const TPublicType &p) :
							type(p.type), precision(p.precision), qualifier(p.qualifier), size(p.size), matrix(p.matrix), array(p.array), arraySize(p.arraySize),
							structure(0), structureSize(0), maxArraySize(0), arrayInformationType(0), fieldName(0), mangled(0), typeName(0)
							{
							  if (p.userDef) {
								  structure = p.userDef->getStruct();
								  typeName = NewPoolTString(p.userDef->getTypeName().c_str());
							  }
							}
	explicit TType(TTypeList* userDef, const TString& n, TPrecision p = EbpHigh) :
							type(EbtStruct), precision(p), qualifier(EvqTemporary), size(1), matrix(false), array(false), arraySize(0),
							structure(userDef), structureSize(0), maxArraySize(0), arrayInformationType(0), fieldName(0), mangled(0) {
								typeName = NewPoolTString(n.c_str());
							}
	explicit TType() {}
	virtual ~TType() {}

	TType(const TType& type) { *this = type; }

	void copyType(const TType& copyOf, TStructureMap& remapper)
	{
		type = copyOf.type;
		precision = copyOf.precision;
		qualifier = copyOf.qualifier;
		size = copyOf.size;
		matrix = copyOf.matrix;
		array = copyOf.array;
		arraySize = copyOf.arraySize;

		TStructureMapIterator iter;
		if (copyOf.structure) {
			if ((iter = remapper.find(structure)) == remapper.end()) {
				// create the new structure here
				structure = NewPoolTTypeList();
				for (unsigned int i = 0; i < copyOf.structure->size(); ++i) {
					TTypeLine typeLine;
					typeLine.line = (*copyOf.structure)[i].line;
					typeLine.type = (*copyOf.structure)[i].type->clone(remapper);
					structure->push_back(typeLine);
				}
			} else {
				structure = iter->second;
			}
		} else
			structure = 0;

		fieldName = 0;
		if (copyOf.fieldName)
			fieldName = NewPoolTString(copyOf.fieldName->c_str());
		typeName = 0;
		if (copyOf.typeName)
			typeName = NewPoolTString(copyOf.typeName->c_str());

		mangled = 0;
		if (copyOf.mangled)
			mangled = NewPoolTString(copyOf.mangled->c_str());

		structureSize = copyOf.structureSize;
		maxArraySize = copyOf.maxArraySize;
		assert(copyOf.arrayInformationType == 0);
		arrayInformationType = 0; // arrayInformationType should not be set for builtIn symbol table level
	}

	TType* clone(TStructureMap& remapper)
	{
		TType *newType = new TType();
		newType->copyType(*this, remapper);

		return newType;
	}

	virtual void setType(TBasicType t, int s, bool m, bool a, int aS = 0)
							{ type = t; size = s; matrix = m; array = a; arraySize = aS; }
	virtual void setType(TBasicType t, int s, bool m, TType* userDef = 0)
							{ type = t;
							  size = s;
							  matrix = m;
							  if (userDef)
								  structure = userDef->getStruct();
							  // leave array information intact.
							}
	virtual void setTypeName(const TString& n) { typeName = NewPoolTString(n.c_str()); }
	virtual void setFieldName(const TString& n) { fieldName = NewPoolTString(n.c_str()); }
	virtual const TString& getTypeName() const
	{
		assert(typeName);
		return *typeName;
	}

	virtual const TString& getFieldName() const
	{
		assert(fieldName);
		return *fieldName;
	}

	virtual TBasicType getBasicType() const { return type; }
	virtual TPrecision getPrecision() const { return precision; }
	virtual TQualifier getQualifier() const { return qualifier; }
	virtual void changePrecision(TPrecision p) { precision = p; }
	virtual void changeQualifier(TQualifier q) { qualifier = q; }

	// One-dimensional size of single instance type
	virtual int getNominalSize() const { return size; }

	// Full-dimensional size of single instance of type
	virtual int getInstanceSize() const
	{
		if (matrix)
			return size * size;
		else
			return size;
	}

	virtual bool isMatrix() const { return matrix ? true : false; }
	virtual bool isArray() const  { return array ? true : false; }
	bool isField() const { return fieldName != 0; }
	int getArraySize() const { return arraySize; }
	void setArraySize(int s) { array = true; arraySize = s; }
	void setMaxArraySize (int s) { maxArraySize = s; }
	int getMaxArraySize () const { return maxArraySize; }
	void clearArrayness() { array = false; arraySize = 0; maxArraySize = 0; }
	void setArrayInformationType(TType* t) { arrayInformationType = t; }
	TType* getArrayInformationType() const { return arrayInformationType; }
	virtual bool isVector() const { return size > 1 && !matrix; }
    virtual bool isScalar() const { return size == 1 && !matrix && !structure; }
	static const char* getBasicString(TBasicType t) {
		switch (t) {
		case EbtVoid:              return "void";              break;
		case EbtFloat:             return "float";             break;
		case EbtInt:               return "int";               break;
		case EbtBool:              return "bool";              break;
		case EbtSampler2D:         return "sampler2D";         break;
		case EbtSamplerCube:       return "samplerCube";       break;
		case EbtStruct:            return "structure";         break;
		default:                   return "unknown type";
		}
	}
	const char* getBasicString() const { return TType::getBasicString(type); }
	const char* getPrecisionString() const { return ::getPrecisionString(precision); }
	const char* getQualifierString() const { return ::getQualifierString(qualifier); }
	TTypeList* getStruct() { return structure; }

	int getObjectSize() const
	{
		int totalSize;

		if (getBasicType() == EbtStruct)
			totalSize = getStructSize();
		else if (matrix)
			totalSize = size * size;
		else
			totalSize = size;

		if (isArray())
			totalSize *= Max(getArraySize(), getMaxArraySize());

		return totalSize;
	}

	TTypeList* getStruct() const { return structure; }
	TString& getMangledName() {
		if (!mangled) {
			mangled = NewPoolTString("");
			buildMangledName(*mangled);
			*mangled += ';' ;
		}

		return *mangled;
	}
	bool sameElementType(const TType& right) const {
		return      type == right.type   &&
					size == right.size   &&
				  matrix == right.matrix &&
			   structure == right.structure;
	}
	bool operator==(const TType& right) const {
		return      type == right.type   &&
					size == right.size   &&
				  matrix == right.matrix &&
				   array == right.array  && (!array || arraySize == right.arraySize) &&
			   structure == right.structure;
		// don't check the qualifier, it's not ever what's being sought after
	}
	bool operator!=(const TType& right) const {
		return !operator==(right);
	}
    bool operator<(const TType& right) const {
        if (type != right.type) return type < right.type;
        if (size != right.size) return size < right.size;
        if (matrix != right.matrix) return matrix < right.matrix;
        if (array != right.array) return array < right.array;
        if (arraySize != right.arraySize) return arraySize < right.arraySize;
        if (structure != right.structure) return structure < right.structure;

        return false;
	}
	TString getCompleteString() const;

protected:
	void buildMangledName(TString&);
	int getStructSize() const;

	TBasicType type      : 6;
	TPrecision precision;
	TQualifier qualifier : 7;
	int size             : 8; // size of vector or matrix, not size of array
	unsigned int matrix  : 1;
	unsigned int array   : 1;
	int arraySize;

	TTypeList* structure;      // 0 unless this is a struct
	mutable int structureSize;
	int maxArraySize;
	TType* arrayInformationType;
	TString *fieldName;         // for structure field names
	TString *mangled;
	TString *typeName;          // for structure field type name
};

#endif // _TYPES_INCLUDED_