Files
wuffs/cmd/puffs-gen-c/main.go
T

652 lines
16 KiB
Go

// Use of this source code is governed by a BSD-style license that can be found
// in the LICENSE file.
//go:generate go run gen.go
// puffs-gen-c transpiles a Puffs program to a C program.
//
// The command line arguments list the source Puffs files. If no arguments are
// given, it reads from stdin.
//
// The generated program is written to stdout.
package main
import (
"bytes"
"fmt"
"os"
"os/exec"
"strings"
"github.com/google/puffs/lang/generate"
a "github.com/google/puffs/lang/ast"
t "github.com/google/puffs/lang/token"
)
func main() {
generate.Main(func(pkgName string, idMap *t.IDMap, files []*a.File) ([]byte, error) {
g := &gen{
pkgName: pkgName,
idMap: idMap,
files: files,
}
if err := g.generate(); err != nil {
return nil, err
}
stdout := &bytes.Buffer{}
cmd := exec.Command("clang-format", "-style=Chromium")
cmd.Stdin = &g.buffer
cmd.Stdout = stdout
cmd.Stderr = os.Stderr
if err := cmd.Run(); err != nil {
return nil, err
}
return stdout.Bytes(), nil
})
}
type visibility uint32
const (
bothPubPri visibility = iota
pubOnly
priOnly
)
type gen struct {
buffer bytes.Buffer
pkgName string
idMap *t.IDMap
files []*a.File
}
func (g *gen) printf(format string, args ...interface{}) { fmt.Fprintf(&g.buffer, format, args...) }
func (g *gen) writeb(b byte) { g.buffer.WriteByte(b) }
func (g *gen) writes(s string) { g.buffer.WriteString(s) }
func (g *gen) generate() error {
includeGuard := "PUFFS_" + strings.ToUpper(g.pkgName) + "_H"
g.printf("#ifndef %s\n#define %s\n\n", includeGuard, includeGuard)
g.printf("// Code generated by puffs-gen-c. DO NOT EDIT.\n\n")
g.writes(baseHeader)
g.writes("\n#ifdef __cplusplus\nextern \"C\" {\n#endif\n\n")
g.writes("// ---------------- Status Codes\n\n")
g.writes("// Status codes are non-positive integers.\n")
g.writes("//\n")
g.writes("// The least significant bit indicates a non-recoverable status code: an error.\n")
g.writes("typedef enum {\n")
g.printf("puffs_%s_status_ok = 0,\n", g.pkgName)
g.printf("puffs_%s_error_bad_version = -2 + 1,\n", g.pkgName)
g.printf("puffs_%s_error_null_receiver = -4 + 1,\n", g.pkgName)
g.printf("puffs_%s_error_constructor_not_called= -6 + 1,\n", g.pkgName)
g.printf("puffs_%s_status_short_dst = -8,\n", g.pkgName)
g.printf("puffs_%s_status_short_src = -10,\n", g.pkgName)
g.printf("} puffs_%s_status;\n\n", g.pkgName)
g.writes("// ---------------- Public Structs\n\n")
if err := g.forEachStruct(pubOnly, (*gen).writeStruct); err != nil {
return err
}
g.writes("// ---------------- Public Constructor and Destructor Prototypes\n\n")
if err := g.forEachStruct(pubOnly, (*gen).writeCtorPrototypesPub); err != nil {
return err
}
g.writes("// ---------------- Public Function Prototypes\n\n")
if err := g.forEachFunc(pubOnly, (*gen).writeFuncPrototype); err != nil {
return err
}
// Finish up the header, which is also the first part of the .c file.
g.writes("\n#ifdef __cplusplus\n} // extern \"C\"\n#endif\n\n")
g.printf("#endif // %s\n\n", includeGuard)
g.writes("// C HEADER ENDS HERE.\n\n")
g.writes(baseImpl)
g.writes("\n")
g.writes("// ---------------- Private Structs\n\n")
if err := g.forEachStruct(priOnly, (*gen).writeStruct); err != nil {
return err
}
g.writes("// ---------------- Private Constructor and Destructor Prototypes\n\n")
if err := g.forEachStruct(priOnly, (*gen).writeCtorPrototypesPri); err != nil {
return err
}
g.writes("// ---------------- Private Function Prototypes\n\n")
if err := g.forEachFunc(priOnly, (*gen).writeFuncPrototype); err != nil {
return err
}
g.writes("// ---------------- Constructor and Destructor Implementations\n\n")
g.writes("// PUFFS_MAGIC is a magic number to check that constructors are called. It's\n")
g.writes("// not foolproof, given C doesn't automatically zero memory before use, but it\n")
g.writes("// should catch 99.99% of cases.\n")
g.writes("//\n")
g.writes("// Its (non-zero) value is arbitrary, based on md5sum(\"puffs\").\n")
g.writes("#define PUFFS_MAGIC (0xCB3699CCU)\n\n")
g.writes("// PUFFS_ALREADY_ZEROED is passed from a container struct's constructor to a\n")
g.writes("// containee struct's constructor when the container has already zeroed the\n")
g.writes("// containee's memory.\n")
g.writes("//\n")
g.writes("// Its (non-zero) value is arbitrary, based on md5sum(\"zeroed\").\n")
g.writes("#define PUFFS_ALREADY_ZEROED (0x68602EF1U)\n\n")
if err := g.forEachStruct(bothPubPri, (*gen).writeCtorImpls); err != nil {
return err
}
g.writes("// ---------------- Function Implementations\n\n")
if err := g.forEachFunc(bothPubPri, (*gen).writeFuncImpl); err != nil {
return err
}
return nil
}
func (g *gen) forEachFunc(v visibility, f func(*gen, *a.Func) error) error {
for _, file := range g.files {
for _, n := range file.TopLevelDecls() {
if n.Kind() != a.KFunc ||
(v == pubOnly && n.Raw().Flags()&a.FlagsPublic == 0) ||
(v == priOnly && n.Raw().Flags()&a.FlagsPublic != 0) {
continue
}
if err := f(g, n.Func()); err != nil {
return err
}
}
}
return nil
}
func (g *gen) forEachStruct(v visibility, f func(*gen, *a.Struct) error) error {
for _, file := range g.files {
for _, n := range file.TopLevelDecls() {
if n.Kind() != a.KStruct ||
(v == pubOnly && n.Raw().Flags()&a.FlagsPublic == 0) ||
(v == priOnly && n.Raw().Flags()&a.FlagsPublic != 0) {
continue
}
if err := f(g, n.Struct()); err != nil {
return err
}
}
}
return nil
}
func (g *gen) writeStruct(n *a.Struct) error {
structName := n.Name().String(g.idMap)
g.printf("typedef struct {\n")
if n.Suspendible() {
g.printf("puffs_%s_status status;\n", g.pkgName)
g.printf("uint32_t magic;\n")
}
for _, f := range n.Fields() {
if err := g.writeField(f.Field()); err != nil {
return err
}
}
g.printf("} puffs_%s_%s;\n\n", g.pkgName, structName)
return nil
}
func (g *gen) writeCtorSignature(n *a.Struct, public bool, ctor bool) {
structName := n.Name().String(g.idMap)
ctorName := "destructor"
if ctor {
ctorName = "constructor"
if public {
g.printf("// puffs_%s_%s_%s is a constructor function.\n", g.pkgName, structName, ctorName)
g.printf("//\n")
g.printf("// It should be called before any other puffs_%s_%s_* function.\n",
g.pkgName, structName)
g.printf("//\n")
g.printf("// Pass PUFFS_VERSION and 0 for puffs_version and for_internal_use_only.\n")
}
}
g.printf("void puffs_%s_%s_%s(puffs_%s_%s *self", g.pkgName, structName, ctorName, g.pkgName, structName)
if ctor {
g.printf(", uint32_t puffs_version, uint32_t for_internal_use_only")
}
g.printf(")")
}
func (g *gen) writeCtorPrototypesPub(n *a.Struct) error {
return g.writeCtorPrototypes(n, true)
}
func (g *gen) writeCtorPrototypesPri(n *a.Struct) error {
return g.writeCtorPrototypes(n, false)
}
func (g *gen) writeCtorPrototypes(n *a.Struct, public bool) error {
if !n.Suspendible() {
return nil
}
for _, ctor := range []bool{true, false} {
g.writeCtorSignature(n, public, ctor)
g.writes(";\n\n")
}
return nil
}
func (g *gen) writeCtorImpls(n *a.Struct) error {
if !n.Suspendible() {
return nil
}
for _, ctor := range []bool{true, false} {
g.writeCtorSignature(n, false, ctor)
g.printf("{\n")
g.printf("if (!self) { return; }\n")
if ctor {
g.printf("if (puffs_version != PUFFS_VERSION) {\n")
g.printf("self->status = puffs_%s_error_bad_version;\n", g.pkgName)
g.printf("return;\n")
g.printf("}\n")
g.writes("if (for_internal_use_only != PUFFS_ALREADY_ZEROED) {" +
"memset(self, 0, sizeof(*self)); }\n")
g.writes("self->magic = PUFFS_MAGIC;\n")
for _, f := range n.Fields() {
f := f.Field()
if dv := f.DefaultValue(); dv != nil {
// TODO: set default values for array types.
g.printf("self->f_%s = %d;\n", f.Name().String(g.idMap), dv.ConstValue())
}
}
}
// TODO: call any ctor/dtors on sub-structures.
g.writes("}\n\n")
}
return nil
}
func (g *gen) writeFuncSignature(n *a.Func) {
if n.Suspendible() {
g.printf("puffs_%s_status", g.pkgName)
} else {
g.printf("void")
}
g.printf(" puffs_%s", g.pkgName)
if r := n.Receiver(); r != 0 {
g.printf("_%s", r.String(g.idMap))
}
g.printf("_%s(", n.Name().String(g.idMap))
if r := n.Receiver(); r != 0 {
g.printf("puffs_%s_%s *self", g.pkgName, r.String(g.idMap))
}
// TODO: write n's args.
g.printf(")")
}
func (g *gen) writeFuncPrototype(n *a.Func) error {
g.writeFuncSignature(n)
g.writes(";\n\n")
return nil
}
func (g *gen) writeFuncImpl(n *a.Func) error {
g.writeFuncSignature(n)
g.writes("{\n")
cleanup0 := false
// Check the previous status and the args.
if n.Public() {
if n.Receiver() != 0 {
g.printf("if (!self) { return puffs_%s_error_null_receiver; }\n", g.pkgName)
}
}
if n.Suspendible() {
g.printf("puffs_%s_status status = ", g.pkgName)
if n.Receiver() != 0 {
g.printf("self->status;\n")
if n.Public() {
g.printf("if (status & 1) { return status; }")
}
} else {
g.printf("puffs_%s_status_ok;\n", g.pkgName)
}
if n.Public() {
g.printf("if (self->magic != PUFFS_MAGIC) {"+
"status = puffs_%s_error_constructor_not_called; goto cleanup0; }\n", g.pkgName)
cleanup0 = true
}
} else if r := n.Receiver(); r != 0 {
// TODO: fix this.
return fmt.Errorf(`cannot convert Puffs function "%s.%s" to C`,
r.String(g.idMap), n.Name().String(g.idMap))
}
// TODO: check the args.
g.writes("\n")
// Generate the local variables.
if err := g.writeVars(n.Node(), 0); err != nil {
return err
}
g.writes("\n")
// Generate the function body.
for _, o := range n.Body() {
if err := g.writeStatement(o, 0); err != nil {
return err
}
}
g.writes("\n")
if cleanup0 {
g.printf("cleanup0: self->status = status;\n")
}
if n.Suspendible() {
g.printf("return status;\n")
}
g.writes("}\n\n")
return nil
}
func (g *gen) writeField(n *a.Field) error {
convertible := true
for x := n.XType(); x != nil; x = x.Inner() {
if p := x.PackageOrDecorator(); p != 0 && p != t.IDOpenBracket {
convertible = false
break
}
if x.Inner() != nil {
continue
}
if k := x.Name().Key(); k < t.Key(len(cTypeNames)) {
if s := cTypeNames[k]; s != "" {
g.writes(s)
g.writeb(' ')
continue
}
}
convertible = false
break
}
if !convertible {
// TODO: fix this.
return fmt.Errorf("cannot convert Puffs type %q to C", n.XType().String(g.idMap))
}
g.writes("f_")
g.writes(n.Name().String(g.idMap))
for x := n.XType(); x != nil; x = x.Inner() {
if x.PackageOrDecorator() == t.IDOpenBracket {
g.writeb('[')
g.writes(x.ArrayLength().ConstValue().String())
g.writeb(']')
}
}
g.writes(";\n")
return nil
}
func (g *gen) writeVars(n *a.Node, depth uint32) error {
if depth > a.MaxBodyDepth {
return fmt.Errorf("body recursion depth too large")
}
depth++
if n.Kind() == a.KVar {
x := n.Var().XType()
if k := x.Name().Key(); k < t.Key(len(cTypeNames)) {
if s := cTypeNames[k]; s != "" {
g.printf("%s v_%s;\n", s, n.Var().Name().String(g.idMap))
return nil
}
}
// TODO: fix this.
return fmt.Errorf("cannot convert Puffs type %q to C", x.String(g.idMap))
}
for _, l := range n.Raw().SubLists() {
for _, o := range l {
if err := g.writeVars(o, depth); err != nil {
return err
}
}
}
return nil
}
func (g *gen) writeStatement(n *a.Node, depth uint32) error {
if depth > a.MaxBodyDepth {
return fmt.Errorf("body recursion depth too large")
}
depth++
switch n.Kind() {
case a.KAssert:
// Assertions only apply at compile-time.
return nil
case a.KAssign:
n := n.Assign()
if err := g.writeExpr(n.LHS(), depth); err != nil {
return err
}
// TODO: does KeyAmpHatEq need special consideration?
g.writes(cOpNames[0xFF&n.Operator().Key()])
if err := g.writeExpr(n.RHS(), depth); err != nil {
return err
}
g.writes(";\n")
return nil
case a.KIf:
// TODO.
case a.KJump:
// TODO.
case a.KReturn:
// TODO.
case a.KVar:
n := n.Var()
g.printf("v_%s = ", n.Name().String(g.idMap))
if v := n.Value(); v != nil {
if err := g.writeExpr(v, 0); err != nil {
return err
}
} else {
g.writeb('0')
}
g.writes(";\n")
return nil
case a.KWhile:
n := n.While()
g.writes("while (")
if err := g.writeExpr(n.Condition(), 0); err != nil {
return err
}
g.writes(") {\n")
for _, o := range n.Body() {
if err := g.writeStatement(o, depth); err != nil {
return err
}
}
g.writes("}\n")
return nil
// TODO.
}
return fmt.Errorf("unrecognized ast.Kind (%s) for writeStatement", n.Kind())
}
func (g *gen) writeExpr(n *a.Expr, depth uint32) error {
if depth > a.MaxExprDepth {
return fmt.Errorf("expression recursion depth too large")
}
depth++
if cv := n.ConstValue(); cv != nil {
// TODO: write false/true instead of 0/1 if n.MType() is bool?
g.writes(cv.String())
return nil
}
switch n.ID0().Flags() & (t.FlagsUnaryOp | t.FlagsBinaryOp | t.FlagsAssociativeOp) {
case 0:
if err := g.writeExprOther(n, depth); err != nil {
return err
}
case t.FlagsUnaryOp:
if err := g.writeExprUnaryOp(n, depth); err != nil {
return err
}
case t.FlagsBinaryOp:
if err := g.writeExprBinaryOp(n, depth); err != nil {
return err
}
case t.FlagsAssociativeOp:
if err := g.writeExprAssociativeOp(n, depth); err != nil {
return err
}
default:
return fmt.Errorf("unrecognized token.Key (0x%X) for writeExpr", n.ID0().Key())
}
return nil
}
func (g *gen) writeExprOther(n *a.Expr, depth uint32) error {
switch n.ID0().Key() {
case 0:
if id1 := n.ID1(); id1.Key() == t.KeyThis {
g.writes("self")
} else {
// TODO: don't assume that the v_ prefix is necessary.
g.writes("v_")
g.writes(id1.String(g.idMap))
}
return nil
case t.KeyOpenParen:
// n is a function call.
// TODO.
case t.KeyOpenBracket:
// n is an index.
// TODO.
case t.KeyColon:
// n is a slice.
// TODO.
case t.KeyDot:
if err := g.writeExpr(n.LHS().Expr(), depth); err != nil {
return err
}
// TODO: choose between . vs -> operators.
//
// TODO: don't assume that the f_ prefix is necessary.
g.writes("->f_")
g.writes(n.ID1().String(g.idMap))
return nil
}
return fmt.Errorf("unrecognized token.Key (0x%X) for writeExprOther", n.ID0().Key())
}
func (g *gen) writeExprUnaryOp(n *a.Expr, depth uint32) error {
// TODO.
return nil
}
func (g *gen) writeExprBinaryOp(n *a.Expr, depth uint32) error {
op := n.ID0()
if op.Key() == t.KeyXBinaryAs {
// TODO.
return nil
}
g.writeb('(')
if err := g.writeExpr(n.LHS().Expr(), depth); err != nil {
return err
}
// TODO: does KeyXBinaryAmpHat need special consideration?
g.writes(cOpNames[0xFF&op.Key()])
if err := g.writeExpr(n.RHS().Expr(), depth); err != nil {
return err
}
g.writeb(')')
return nil
}
func (g *gen) writeExprAssociativeOp(n *a.Expr, depth uint32) error {
// TODO.
return nil
}
var cTypeNames = [...]string{
t.KeyI8: "int8_t",
t.KeyI16: "int16_t",
t.KeyI32: "int32_t",
t.KeyI64: "int64_t",
t.KeyU8: "uint8_t",
t.KeyU16: "uint16_t",
t.KeyU32: "uint32_t",
t.KeyU64: "uint64_t",
t.KeyUsize: "size_t",
t.KeyBool: "bool",
}
var cOpNames = [256]string{
t.KeyEq: " = ",
t.KeyPlusEq: " += ",
t.KeyMinusEq: " -= ",
t.KeyStarEq: " *= ",
t.KeySlashEq: " /= ",
t.KeyShiftLEq: " <<= ",
t.KeyShiftREq: " >>= ",
t.KeyAmpEq: " &= ",
t.KeyAmpHatEq: " no_such_amp_hat_C_operator ",
t.KeyPipeEq: " |= ",
t.KeyHatEq: " ^= ",
t.KeyXUnaryPlus: "+",
t.KeyXUnaryMinus: "-",
t.KeyXUnaryNot: "!",
t.KeyXBinaryPlus: " + ",
t.KeyXBinaryMinus: " - ",
t.KeyXBinaryStar: " * ",
t.KeyXBinarySlash: " / ",
t.KeyXBinaryShiftL: " << ",
t.KeyXBinaryShiftR: " >> ",
t.KeyXBinaryAmp: " & ",
t.KeyXBinaryAmpHat: " no_such_amp_hat_C_operator ",
t.KeyXBinaryPipe: " | ",
t.KeyXBinaryHat: " ^ ",
t.KeyXBinaryNotEq: " != ",
t.KeyXBinaryLessThan: " < ",
t.KeyXBinaryLessEq: " <= ",
t.KeyXBinaryEqEq: " == ",
t.KeyXBinaryGreaterEq: " >= ",
t.KeyXBinaryGreaterThan: " > ",
t.KeyXBinaryAnd: " && ",
t.KeyXBinaryOr: " || ",
t.KeyXBinaryAs: " no_such_as_C_operator ",
t.KeyXAssociativePlus: " + ",
t.KeyXAssociativeStar: " * ",
t.KeyXAssociativeAmp: " & ",
t.KeyXAssociativePipe: " | ",
t.KeyXAssociativeHat: " ^ ",
t.KeyXAssociativeAnd: " && ",
t.KeyXAssociativeOr: " || ",
}