type.go

package main

import (
	"bytes"
	"fmt"
	"strings"

	"github.com/llir/llvm/ir/types"
)

// TypeDefinition returns the definition (not just the name) of t.
func TypeDefinition(t types.Type) (string, error) {
	switch t := t.(type) {
	case *types.ArrayType:
		elemType, err := TypeSpec(t.ElemType)
		if err != nil {
			return "", err
		}
		return fmt.Sprintf("[%d]%s", t.Len, elemType), nil

	case *types.FloatType:
		switch t.Kind {
		case types.FloatKindFloat:
			return "float32", nil
		case types.FloatKindDouble, types.FloatKindX86_FP80:
			return "float64", nil
		default:
			return "", fmt.Errorf("unsupported floating-point type: %v", t.Kind)
		}

	case *types.FuncType:
		b := new(bytes.Buffer)
		b.WriteString("func(")
		for i, p := range t.Params {
			if i != 0 {
				b.WriteString(", ")
			}
			pt, err := TypeSpec(p)
			if err != nil {
				return "", fmt.Errorf("error converting type of parameter %d (%v): %v", i, p, err)
			}
			b.WriteString(pt)
		}
		b.WriteString(")")
		if !types.Equal(t.RetType, types.Void) {
			b.WriteString(" ")
			rt, err := TypeSpec(t.RetType)
			if err != nil {
				return "", fmt.Errorf("error converting return type (%v): %v", t.RetType, err)
			}
			b.WriteString(rt)
		}
		return b.String(), nil

	case *types.IntType:
		switch {
		case t.BitSize == 1:
			return "bool", nil
		case t.BitSize <= 8:
			return "byte", nil
		default:
			return fmt.Sprintf("int%d", t.BitSize), nil
		}

	case *types.PointerType:
		if _, ok := t.ElemType.(*types.FuncType); ok {
			// Translate a C function pointer type as a Go function type.
			return TypeDefinition(t.ElemType)
		}
		elemType, err := TypeSpec(t.ElemType)
		if err != nil {
			return "", err
		}
		return "*" + elemType, nil

	case *types.StructType:
		b := new(bytes.Buffer)
		b.WriteString("struct {\n")
		for i, field := range t.Fields {
			fieldType, err := TypeSpec(field)
			if err != nil {
				return "", fmt.Errorf("error converting type of field %d: %v", i, err)
			}
			fmt.Fprintf(b, "\tF%d %s\n", i, fieldType)
		}
		b.WriteString("}")
		return b.String(), nil

	case *types.VectorType:
		elemType, err := TypeSpec(t.ElemType)
		if err != nil {
			return "", err
		}
		return fmt.Sprintf("[%d]%s", t.Len, elemType), nil

	default:
		return "", fmt.Errorf("unsupported type %T", t)
	}
}

// TypeSpec returns the name (if it has one) or the definition of t.
func TypeSpec(t types.Type) (string, error) {
	if name := TypeName(t); name != "" {
		return name, nil
	}
	return TypeDefinition(t)
}

// TypeName returns t's name, or the empty string if t is not a named type.
func TypeName(t types.Type) string {
	name := t.Name()
	name = strings.TrimPrefix(name, "struct.")
	name = strings.TrimPrefix(name, "union.")

	if name == "anon" {
		return ""
	}

	if renamed, ok := libraryTypes[name]; ok {
		return renamed
	}

	return name
}

var libraryTypes = map[string]string{
	"FILE": "os.File",
}

// compatiblePointerTypes returns whether casting t1 to t2 can be allowed without
// causing too many problems for the garbage collector.
func compatiblePointerTypes(t1, t2 types.Type) bool {
	var e1, e2 types.Type
	if t1, ok := t1.(*types.PointerType); ok {
		e1 = t1.ElemType
	} else {
		return false
	}
	if t2, ok := t2.(*types.PointerType); ok {
		e2 = t2.ElemType
	} else {
		return false
	}

	if types.Equal(e1, e2) {
		return true
	}

	return !hasPointers(e1) && !hasPointers(e2)
}

// hasPointers returns whether t contains pointers.
func hasPointers(t types.Type) bool {
	switch t := t.(type) {
	case *types.ArrayType:
		return hasPointers(t.ElemType)
	case *types.FloatType:
		return false
	case *types.FuncType:
		return true
	case *types.IntType:
		return false
	case *types.PointerType:
		return true
	case *types.StructType:
		for _, f := range t.Fields {
			if hasPointers(f) {
				return true
			}
		}
		return false
	case *types.VectorType:
		return hasPointers(t.ElemType)
	default:
		// We don't know if it contains pointers, so we assume it does,
		// since that means we'll be more careful with it.
		return true
	}
}