go-hep.org/x/hep@v0.38.1/brio/cmd/brio-gen/internal/gen/gen.go

// Copyright ©2016 The go-hep Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.

package gen // import "go-hep.org/x/hep/brio/cmd/brio-gen/internal/gen"

import (
	"bytes"
	"fmt"
	"go/format"
	"go/types"
	"log"
	"strings"

	"golang.org/x/tools/go/packages"
)

var (
	binMa *types.Interface // encoding.BinaryMarshaler
	binUn *types.Interface // encoding.BinaryUnmarshaler
)

// Generator holds the state of the generation.
type Generator struct {
	buf *bytes.Buffer
	pkg *types.Package

	// set of imported packages.
	// usually: "encoding/binary", "math"
	imps map[string]int

	Verbose bool // enable verbose mode
}

// NewGenerator returns a new code generator for package p,
// where p is the package's import path.
func NewGenerator(p string) (*Generator, error) {
	pkg, err := importPkg(p)
	if err != nil {
		return nil, err
	}

	return &Generator{
		buf:  new(bytes.Buffer),
		pkg:  pkg,
		imps: map[string]int{"encoding/binary": 1},
	}, nil
}

func (g *Generator) printf(format string, args ...any) {
	fmt.Fprintf(g.buf, format, args...)
}

func (g *Generator) Generate(typeName string) {
	scope := g.pkg.Scope()
	obj := scope.Lookup(typeName)
	if obj == nil {
		log.Fatalf("no such type %q in package %q\n", typeName, g.pkg.Path()+"/"+g.pkg.Name())
	}

	tn, ok := obj.(*types.TypeName)
	if !ok {
		log.Fatalf("%q is not a type (%v)\n", typeName, obj)
	}

	typ, ok := tn.Type().Underlying().(*types.Struct)
	if !ok {
		log.Fatalf("%q is not a named struct (%v)\n", typeName, tn)
	}
	if g.Verbose {
		log.Printf("typ: %+v\n", typ)
	}

	g.genMarshal(typ, typeName)
	g.genUnmarshal(typ, typeName)
}

func (g *Generator) genMarshal(t types.Type, typeName string) {
	g.printf(`// MarshalBinary implements encoding.BinaryMarshaler
func (o *%[1]s) MarshalBinary() (data []byte, err error) {
	var buf [8]byte
`,
		typeName,
	)

	typ := t.Underlying().(*types.Struct)
	for i := range typ.NumFields() {
		ft := typ.Field(i)
		g.genMarshalType(ft.Type(), "o."+ft.Name())
	}

	g.printf("return data, err\n}\n\n")
}

func (g *Generator) genMarshalType(t types.Type, n string) {
	if types.Implements(t, binMa) || types.Implements(types.NewPointer(t), binMa) {
		g.printf("{\nsub, err := %s.MarshalBinary()\n", n)
		g.printf("if err != nil {\nreturn nil, err\n}\n")
		g.printf("binary.LittleEndian.PutUint64(buf[:8], uint64(len(sub)))\n")
		g.printf("data = append(data, buf[:8]...)\n")
		g.printf("data = append(data, sub...)\n")
		g.printf("}\n")
		return
	}

	ut := t.Underlying()
	switch ut := ut.(type) {
	case *types.Basic:
		switch kind := ut.Kind(); kind {

		case types.Bool:
			g.printf("switch %s {\ncase false:\n data = append(data, uint8(0))\n", n)
			g.printf("default:\ndata = append(data, uint8(1))\n}\n")

		case types.Uint:
			g.printf("binary.LittleEndian.PutUint64(buf[:8], uint64(%s))\n", n)
			g.printf("data = append(data, buf[:8]...)\n")

		case types.Uint8:
			g.printf("data = append(data, byte(%s))\n", n)

		case types.Uint16:
			g.printf(
				"binary.LittleEndian.PutUint16(buf[:2], uint16(%s))\n",
				n,
			)
			g.printf("data = append(data, buf[:2]...)\n")

		case types.Uint32:
			g.printf(
				"binary.LittleEndian.PutUint32(buf[:4], uint32(%s))\n",
				n,
			)
			g.printf("data = append(data, buf[:4]...)\n")

		case types.Uint64:
			g.printf(
				"binary.LittleEndian.PutUint64(buf[:8], uint64(%s))\n",
				n,
			)
			g.printf("data = append(data, buf[:8]...)\n")

		case types.Int:
			g.printf(
				"binary.LittleEndian.PutUint64(buf[:8], uint64(%s))\n",
				n,
			)
			g.printf("data = append(data, buf[:8]...)\n")

		case types.Int8:
			g.printf("data = append(data, byte(%s))\n", n)

		case types.Int16:
			g.printf(
				"binary.LittleEndian.PutUint16(buf[:2], uint16(%s))\n",
				n,
			)
			g.printf("data = append(data, buf[:2]...)\n")

		case types.Int32:
			g.printf(
				"binary.LittleEndian.PutUint32(buf[:4], uint32(%s))\n",
				n,
			)
			g.printf("data = append(data, buf[:4]...)\n")

		case types.Int64:
			g.printf(
				"binary.LittleEndian.PutUint64(buf[:8], uint64(%s))\n",
				n,
			)
			g.printf("data = append(data, buf[:8]...)\n")

		case types.Float32:
			g.imps["math"] = 1
			g.printf(
				"binary.LittleEndian.PutUint32(buf[:4], math.Float32bits(%s))\n",
				n,
			)
			g.printf("data = append(data, buf[:4]...)\n")

		case types.Float64:
			g.imps["math"] = 1
			g.printf(
				"binary.LittleEndian.PutUint64(buf[:8], math.Float64bits(%s))\n",
				n,
			)
			g.printf("data = append(data, buf[:8]...)\n")

		case types.Complex64:
			g.imps["math"] = 1
			g.printf(
				"binary.LittleEndian.PutUint64(buf[:4], math.Float32bits(real(%s)))\n",
				n,
			)
			g.printf("data = append(data, buf[:4]...)\n")
			g.printf(
				"binary.LittleEndian.PutUint64(buf[:4], math.Float32bits(imag(%s)))\n",
				n,
			)
			g.printf("data = append(data, buf[:4]...)\n")

		case types.Complex128:
			g.imps["math"] = 1
			g.printf(
				"binary.LittleEndian.PutUint64(buf[:8], math.Float64bits(real(%s)))\n",
				n,
			)
			g.printf("data = append(data, buf[:8]...)\n")
			g.printf(
				"binary.LittleEndian.PutUint64(buf[:8], math.Float64bits(imag(%s)))\n",
				n,
			)
			g.printf("data = append(data, buf[:8]...)\n")

		case types.String:
			g.printf(
				"binary.LittleEndian.PutUint64(buf[:8], uint64(len(%s)))\n",
				n,
			)
			g.printf("data = append(data, buf[:8]...)\n")
			g.printf("data = append(data, []byte(%s)...)\n", n)

		default:
			log.Fatalf("unhandled type: %v (underlying: %v)\n", t, ut)
		}

	case *types.Struct:
		switch t.(type) {
		case *types.Named:
			g.printf("{\nsub, err := %s.MarshalBinary()\n", n)
			g.printf("if err != nil {\nreturn nil, err\n}\n")
			g.printf("binary.LittleEndian.PutUint64(buf[:8], uint64(len(sub)))\n")
			g.printf("data = append(data, buf[:8]...)\n")
			g.printf("data = append(data, sub...)\n")
			g.printf("}\n")
		default:
			// un-named
			for i := range ut.NumFields() {
				elem := ut.Field(i)
				g.genMarshalType(elem.Type(), n+"."+elem.Name())
			}
		}

	case *types.Array:
		if isByteType(ut.Elem()) {
			g.printf("data = append(data, %s[:]...)\n", n)
		} else {
			g.printf("for i := range %s {\n", n)
			if _, ok := ut.Elem().(*types.Pointer); ok {
				g.printf("o := %s[i]\n", n)
			} else {
				g.printf("o := &%s[i]\n", n)
			}
			g.genMarshalType(ut.Elem(), "o")
			g.printf("}\n")
		}

	case *types.Slice:
		g.printf(
			"binary.LittleEndian.PutUint64(buf[:8], uint64(len(%s)))\n",
			n,
		)
		g.printf("data = append(data, buf[:8]...)\n")
		if isByteType(ut.Elem()) {
			g.printf("data = append(data, %s...)\n", n)
		} else {
			g.printf("for i := range %s {\n", n)
			if _, ok := ut.Elem().(*types.Pointer); ok {
				g.printf("o := %s[i]\n", n)
			} else {
				g.printf("o := &%s[i]\n", n)
			}
			g.genMarshalType(ut.Elem(), "o")
			g.printf("}\n")
		}

	case *types.Pointer:
		g.printf("{\n")
		g.printf("v := *%s\n", n)
		g.genMarshalType(ut.Elem(), "v")
		g.printf("}\n")

	case *types.Interface:
		log.Fatalf("marshal interface not supported (type=%v)\n", t)

	default:
		log.Fatalf("unhandled type: %v (underlying: %v)\n", t, ut)
	}
}

func (g *Generator) genUnmarshal(t types.Type, typeName string) {
	g.printf(`// UnmarshalBinary implements encoding.BinaryUnmarshaler
func (o *%[1]s) UnmarshalBinary(data []byte) (err error) {
`,
		typeName,
	)

	typ := t.Underlying().(*types.Struct)
	for i := range typ.NumFields() {
		ft := typ.Field(i)
		g.genUnmarshalType(ft.Type(), "o."+ft.Name())
	}

	g.printf("_ = data\n")
	g.printf("return err\n}\n\n")
}

func (g *Generator) genUnmarshalType(t types.Type, n string) {
	if types.Implements(t, binUn) || types.Implements(types.NewPointer(t), binUn) {
		g.printf("{\n")
		g.printf("n := int(binary.LittleEndian.Uint64(data[:8]))\n")
		g.printf("data = data[8:]\n")
		g.printf("err = %s.UnmarshalBinary(data[:n])\n", n)
		g.printf("if err != nil {\nreturn err\n}\n")
		g.printf("data = data[n:]\n")
		g.printf("}\n")
		return
	}

	tn := types.TypeString(t, types.RelativeTo(g.pkg))
	ut := t.Underlying()
	switch ut := ut.(type) {
	case *types.Basic:
		switch kind := ut.Kind(); kind {

		case types.Bool:
			g.printf("switch data[i] {\ncase 0:\n%s = false\n", n)
			g.printf("default:\n%s = true\n}\n", n)
			g.printf("data = data[1:]\n")

		case types.Uint:
			g.printf("%s = %s(binary.LittleEndian.Uint64(data[:8]))\n", n, tn)
			g.printf("data = data[8:]\n")

		case types.Uint8:
			g.printf("%s = %s(data[0])\n", n, tn)
			g.printf("data = data[1:]\n")

		case types.Uint16:
			g.printf("%s = %s(binary.LittleEndian.Uint16(data[:2]))\n", n, tn)
			g.printf("data = data[2:]\n")

		case types.Uint32:
			g.printf("%s = %s(binary.LittleEndian.Uint32(data[:4]))\n", n, tn)
			g.printf("data = data[4:]\n")

		case types.Uint64:
			g.printf("%s = %s(binary.LittleEndian.Uint64(data[:8]))\n", n, tn)
			g.printf("data = data[8:]\n")

		case types.Int:
			g.printf("%s = %s(binary.LittleEndian.Uint64(data[:8]))\n", n, tn)
			g.printf("data = data[8:]\n")

		case types.Int8:
			g.printf("%s = %s(data[0])\n", n, tn)
			g.printf("data = data[1:]\n")

		case types.Int16:
			g.printf("%s = %s(binary.LittleEndian.Uint16(data[:2]))\n", n, tn)
			g.printf("data = data[2:]\n")

		case types.Int32:
			g.printf("%s = %s(binary.LittleEndian.Uint32(data[:4]))\n", n, tn)
			g.printf("data = data[4:]\n")

		case types.Int64:
			g.printf("%s = %s(binary.LittleEndian.Uint64(data[:8]))\n", n, tn)
			g.printf("data = data[8:]\n")

		case types.Float32:
			g.imps["math"] = 1
			g.printf("%s = %s(math.Float32frombits(binary.LittleEndian.Uint32(data[:4])))\n", n, tn)
			g.printf("data = data[4:]\n")

		case types.Float64:
			g.imps["math"] = 1
			g.printf("%s = %s(math.Float64frombits(binary.LittleEndian.Uint64(data[:8])))\n", n, tn)
			g.printf("data = data[8:]\n")

		case types.Complex64:
			g.imps["math"] = 1
			g.printf("%s = %s(complex(math.Float32frombits(binary.LittleEndian.Uint32(data[:4])), math.Float32frombits(binary.LittleEndian.Uint32(data[4:8]))))\n", n, tn)
			g.printf("data = data[8:]\n")

		case types.Complex128:
			g.imps["math"] = 1
			g.printf("%s = %s(complex(math.Float64frombits(binary.LittleEndian.Uint64(data[:8])), math.Float64frombits(binary.LittleEndian.Uint64(data[8:16]))))\n", n, tn)
			g.printf("data = data[16:]\n")

		case types.String:
			g.printf("{\n")
			g.printf("n := int(binary.LittleEndian.Uint64(data[:8]))\n")
			g.printf("data = data[8:]\n")
			g.printf("%s = %s(data[:n])\n", n, tn)
			g.printf("data = data[n:]\n")
			g.printf("}\n")

		default:
			log.Fatalf("unhandled type: %v (underlying: %v)\n", t, ut)
		}

	case *types.Struct:
		switch t.(type) {
		case *types.Named:
			g.printf("{\n")
			g.printf("n := int(binary.LittleEndian.Uint64(data[:8]))\n")
			g.printf("data = data[8:]\n")
			g.printf("err = %s.UnmarshalBinary(data[:n])\n", n)
			g.printf("if err != nil {\nreturn err\n}\n")
			g.printf("data = data[n:]\n")
			g.printf("}\n")
		default:
			// un-named.
			for i := range ut.NumFields() {
				elem := ut.Field(i)
				g.genUnmarshalType(elem.Type(), n+"."+elem.Name())
			}
		}

	case *types.Array:
		if isByteType(ut.Elem()) {
			g.printf("copy(%s[:], data[:n])\n", n)
			g.printf("data = data[n:]\n")
		} else {
			g.printf("for i := range %s {\n", n)
			nn := n + "[i]"
			if pt, ok := ut.Elem().(*types.Pointer); ok {
				g.printf("var oi %s\n", qualTypeName(pt.Elem(), g.pkg))
				nn = "oi"
			}
			if _, ok := ut.Elem().Underlying().(*types.Struct); ok {
				g.printf("oi := &%s[i]\n", n)
				nn = "oi"
			}
			g.genUnmarshalType(ut.Elem(), nn)
			if _, ok := ut.Elem().(*types.Pointer); ok {
				g.printf("%s[i] = oi\n", n)
			}
			g.printf("}\n")
		}

	case *types.Slice:
		g.printf("{\n")
		g.printf("n := int(binary.LittleEndian.Uint64(data[:8]))\n")
		g.printf("%[1]s = make([]%[2]s, n)\n", n, qualTypeName(ut.Elem(), g.pkg))
		g.printf("data = data[8:]\n")
		if isByteType(ut.Elem()) {
			g.printf("%[1]s = append(%[1]s, data[:n]...)\n", n)
			g.printf("data = data[n:]\n")
		} else {
			g.printf("for i := range %s {\n", n)
			nn := n + "[i]"
			if pt, ok := ut.Elem().(*types.Pointer); ok {
				g.printf("var oi %s\n", qualTypeName(pt.Elem(), g.pkg))
				nn = "oi"
			}
			if _, ok := ut.Elem().Underlying().(*types.Struct); ok {
				g.printf("oi := &%s[i]\n", n)
				nn = "oi"
			}
			g.genUnmarshalType(ut.Elem(), nn)
			if _, ok := ut.Elem().(*types.Pointer); ok {
				g.printf("%s[i] = oi\n", n)
			}
			g.printf("}\n")
		}
		g.printf("}\n")

	case *types.Pointer:
		g.printf("{\n")
		elt := ut.Elem()
		g.printf("var v %s\n", qualTypeName(elt, g.pkg))
		g.genUnmarshalType(elt, "v")
		g.printf("%s = &v\n\n", n)
		g.printf("}\n")

	case *types.Interface:
		log.Fatalf("marshal interface not supported (type=%v)\n", t)

	default:
		log.Fatalf("unhandled type: %v (underlying: %v)\n", t, ut)
	}

}

func isByteType(t types.Type) bool {
	b, ok := t.Underlying().(*types.Basic)
	if !ok {
		return false
	}
	return b.Kind() == types.Byte
}

func qualTypeName(t types.Type, pkg *types.Package) string {
	n := types.TypeString(t, types.RelativeTo(pkg))
	i := strings.LastIndex(n, "/")
	if i < 0 {
		return n
	}
	return string(n[i+1:])
}

func (g *Generator) Format() ([]byte, error) {
	buf := new(bytes.Buffer)

	// See standard at https://golang.org/s/generatedcode
	buf.WriteString(fmt.Sprintf(`// Code generated by %[1]s; DO NOT EDIT.

package %[2]s

import (
	"encoding/binary"
`,
		"brio-gen",
		g.pkg.Name(),
	))

	for k := range g.imps {
		fmt.Fprintf(buf, "%q\n", k)
	}
	fmt.Fprintf(buf, ")\n\n")

	buf.Write(g.buf.Bytes())

	src, err := format.Source(buf.Bytes())
	if err != nil {
		log.Printf("=== error ===\n%s\n", buf.Bytes())
	}
	return src, err
}

func importPkg(p string) (*types.Package, error) {
	cfg := &packages.Config{Mode: packages.NeedTypes | packages.NeedTypesInfo | packages.NeedTypesSizes | packages.NeedDeps}
	pkgs, err := packages.Load(cfg, p)
	if err != nil {
		return nil, fmt.Errorf("could not load package %q: %w", p, err)
	}

	return pkgs[0].Types, nil
}

func init() {
	pkg, err := importPkg("encoding")
	if err != nil {
		log.Fatalf("error finding package \"encoding\": %v\n", err)
	}

	o := pkg.Scope().Lookup("BinaryMarshaler")
	if o == nil {
		log.Fatalf("could not find interface encoding.BinaryMarshaler\n")
	}
	binMa = o.(*types.TypeName).Type().Underlying().(*types.Interface)

	o = pkg.Scope().Lookup("BinaryUnmarshaler")
	if o == nil {
		log.Fatalf("could not find interface encoding.BinaryUnmarshaler\n")
	}
	binUn = o.(*types.TypeName).Type().Underlying().(*types.Interface)
}