Generate C structs.

This commit is contained in:
Nigel Tao committed 2017-05-26 14:45:20 +10:00
1 parent 7e18d9b549
commit d7403b8e57
8 files changed
+146 -46

No files matched your search

+89 -9
View File
@@ -10,6 +10,9 @@ import (
"fmt"
"os"
"os/exec"
a "github.com/google/puffs/lang/ast"
t "github.com/google/puffs/lang/token"
)
type Generator struct {
@@ -17,26 +20,90 @@ type Generator struct {
Extension byte
}
func (g *Generator) WritePreamble(w *bytes.Buffer) error {
fmt.Fprintf(w, "// Code generated by puffs-gen-%c. DO NOT EDIT.\n\n", g.Extension)
w.WriteString(preamble)
func (g *Generator) Generate(packageName string, m *t.IDMap, files []*a.File) ([]byte, error) {
b := &bytes.Buffer{}
// Write preamble.
fmt.Fprintf(b, "// Code generated by puffs-gen-%c. DO NOT EDIT.\n\n", g.Extension)
b.WriteString(preamble)
b.WriteByte('\n')
if g.Extension == 'h' {
w.WriteString("\n#ifdef __cplusplus\nextern \"C\" {\n#endif\n\n")
b.WriteString("#ifdef __cplusplus\nextern \"C\" {\n#endif\n\n")
}
// Write structs.
for _, f := range files {
for _, n := range f.TopLevelDecls() {
if n.Kind() == a.KStruct {
if err := writeStruct(b, packageName, m, n.Struct()); err != nil {
return nil, err
}
}
}
}
// Write postamble.
if g.Extension == 'h' {
b.WriteString("\n#ifdef __cplusplus\n} // extern \"C\"\n#endif\n")
}
return format(b)
}
func writeStruct(b *bytes.Buffer, packageName string, m *t.IDMap, n *a.Struct) error {
fmt.Fprintf(b, "typedef struct {\n")
for _, f := range n.Fields() {
if err := writeField(b, m, f.Field()); err != nil {
return err
}
}
fmt.Fprintf(b, "} puffs_%s_%s;\n", packageName, n.Name().String(m))
return nil
}
func (g *Generator) WritePostamble(w *bytes.Buffer) error {
if g.Extension == 'h' {
w.WriteString("\n#ifdef __cplusplus\n} // extern \"C\"\n#endif\n")
func writeField(b *bytes.Buffer, m *t.IDMap, 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 != "" {
b.WriteString(s)
b.WriteByte(' ')
continue
}
}
convertible = false
break
}
if !convertible {
// TODO: fix this.
return fmt.Errorf("cannot convert Puffs type %q to C", n.XType().String(m))
}
b.WriteString(n.Name().String(m))
for x := n.XType(); x != nil; x = x.Inner() {
if x.PackageOrDecorator() == t.IDOpenBracket {
b.WriteByte('[')
b.WriteString(x.ArrayLength().ConstValue().String())
b.WriteByte(']')
}
}
b.WriteString(";\n")
return nil
}
func (g *Generator) Format(rawSource []byte) ([]byte, error) {
func format(rawSource *bytes.Buffer) ([]byte, error) {
stdout := &bytes.Buffer{}
cmd := exec.Command("clang-format", "-style=Chromium")
cmd.Stdin = bytes.NewReader(rawSource)
cmd.Stdin = rawSource
cmd.Stdout = stdout
cmd.Stderr = os.Stderr
if err := cmd.Run(); err != nil {
@@ -44,3 +111,16 @@ func (g *Generator) Format(rawSource []byte) ([]byte, error) {
}
return stdout.Bytes(), 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",
}
+1 -1
View File
@@ -6,5 +6,5 @@
package cgen
const preamble = "" +
"// Use of this source code is governed by a BSD-style license that can be found\n// in the LICENSE file.\n\n#include <stdint.h>\n\n#if __WORDSIZE < 32\n#error \"Puffs requires a word size of at least 32 bits\"\n#endif\n" +
"// Use of this source code is governed by a BSD-style license that can be found\n// in the LICENSE file.\n\n#include <stdbool.h>\n#include <stdint.h>\n\n#if __WORDSIZE < 32\n#error \"Puffs requires a word size of at least 32 bits\"\n#endif\n" +
""
+1
View File
@@ -3,6 +3,7 @@
// Use of this source code is governed by a BSD-style license that can be found
// in the LICENSE file.
#include <stdbool.h>
#include <stdint.h>
#if __WORDSIZE < 32
+4 -3
View File
@@ -94,15 +94,16 @@ func genDir(puffsRoot string, dirname string, filenames []string, langs []string
return err
}
}
if _, err := check.Check(idMap, files...); err != nil {
if _, err := check.Check(idMap, 0, files...); err != nil {
return err
}
combinedSrc := buf.Bytes()
packageName := filepath.Base(dirname)
for _, lang := range langs {
command := "puffs-gen-" + lang
stdout := &bytes.Buffer{}
cmd := exec.Command(command, "-assume_already_checked")
cmd := exec.Command(command, "-assume_already_checked", "-package_name", packageName)
cmd.Stdin = bytes.NewReader(combinedSrc)
cmd.Stdout = stdout
cmd.Stderr = os.Stderr
@@ -115,7 +116,7 @@ func genDir(puffsRoot string, dirname string, filenames []string, langs []string
}
out := stdout.Bytes()
outDirname := filepath.Join(puffsRoot, "gen", lang)
outFilename := filepath.Join(outDirname, filepath.Base(dirname)+"."+lang)
outFilename := filepath.Join(outDirname, packageName+"."+lang)
if existing, err := ioutil.ReadFile(outFilename); err == nil && bytes.Equal(existing, out) {
fmt.Println("gen unchanged: ", outFilename)
continue
+8
View File
@@ -3,8 +3,16 @@
// Use of this source code is governed by a BSD-style license that can be found
// in the LICENSE file.
#include <stdbool.h>
#include <stdint.h>
#if __WORDSIZE < 32
#error "Puffs requires a word size of at least 32 bits"
#endif
typedef struct {
uint32_t literal_width;
uint8_t stack[4096];
uint8_t suffixes[4096];
uint16_t prefixes[4096];
} puffs_gif_lzw_decoder;
+8
View File
@@ -3,6 +3,7 @@
// Use of this source code is governed by a BSD-style license that can be found
// in the LICENSE file.
#include <stdbool.h>
#include <stdint.h>
#if __WORDSIZE < 32
@@ -13,6 +14,13 @@
extern "C" {
#endif
typedef struct {
uint32_t literal_width;
uint8_t stack[4096];
uint8_t suffixes[4096];
uint16_t prefixes[4096];
} puffs_gif_lzw_decoder;
#ifdef __cplusplus
} // extern "C"
#endif
+19 -9
View File
@@ -11,6 +11,12 @@ import (
t "github.com/google/puffs/lang/token"
)
type Flags uint32
const (
FlagsOnlyTypeCheck = Flags(0x0001)
)
type Error struct {
Err error
Filename string
@@ -65,7 +71,7 @@ type Func struct {
LocalVars TypeMap
}
func Check(m *t.IDMap, files ...*a.File) (*Checker, error) {
func Check(m *t.IDMap, flags Flags, files ...*a.File) (*Checker, error) {
for _, f := range files {
if f == nil {
return nil, errors.New("check: Check given a nil *ast.File")
@@ -89,6 +95,7 @@ func Check(m *t.IDMap, files ...*a.File) (*Checker, error) {
}
}
c := &Checker{
flags: flags,
idMap: m,
reasonMap: rMap,
structs: map[t.ID]Struct{},
@@ -123,6 +130,7 @@ var phases = [...]struct {
}
type Checker struct {
flags Flags
idMap *t.IDMap
reasonMap reasonMap
structs map[t.ID]Struct
@@ -303,14 +311,16 @@ func (c *Checker) checkFuncBody(node *a.Node) error {
}
// Run bounds checks.
for _, o := range n.Body() {
if err := q.bcheckStatement(o); err != nil {
return &Error{
Err: err,
Filename: q.errFilename,
Line: q.errLine,
IDMap: c.idMap,
Facts: q.facts,
if c.flags&FlagsOnlyTypeCheck == 0 {
for _, o := range n.Body() {
if err := q.bcheckStatement(o); err != nil {
return &Error{
Err: err,
Filename: q.errFilename,
Line: q.errLine,
IDMap: c.idMap,
Facts: q.facts,
}
}
}
}
+16 -24
View File
@@ -4,7 +4,6 @@
package generate
import (
"bytes"
"flag"
"io/ioutil"
"os"
@@ -18,13 +17,13 @@ import (
var (
assumeAlreadyChecked = flag.Bool("assume_already_checked", false,
"whether to skip type- and bounds-checking; unsafe unless some other program checks the inputs")
"whether to skip bounds-checking; unsafe unless some other program checks the inputs")
packageName = flag.String("package_name", "", "the package name of the Puffs input code")
)
type Generator interface {
WritePreamble(w *bytes.Buffer) error
WritePostamble(w *bytes.Buffer) error
Format(rawSource []byte) ([]byte, error)
Generate(packageName string, m *token.IDMap, files []*ast.File) ([]byte, error)
}
func Main(g Generator) {
@@ -43,30 +42,23 @@ func main1(g Generator) error {
if err != nil {
return err
}
if !*assumeAlreadyChecked {
for _, f := range files {
if _, err := check.Check(idMap, f); err != nil {
return err
}
}
// Even if we can skip the bounds-checking, we still need to type-check to
// evaluate e.g. the constant N expression in the type "[N]u8".
checkFlags := check.Flags(0)
if *assumeAlreadyChecked {
checkFlags |= check.FlagsOnlyTypeCheck
}
if _, err := check.Check(idMap, checkFlags, files...); err != nil {
return err
}
b := &bytes.Buffer{}
if err := g.WritePreamble(b); err != nil {
return err
}
for _, f := range files {
// TODO: call g.WriteFoo methods.
_ = f
}
if err := g.WritePostamble(b); err != nil {
return err
}
formatted, err := g.Format(b.Bytes())
out, err := g.Generate(*packageName, idMap, files)
if err != nil {
return err
}
if _, err := os.Stdout.Write(formatted); err != nil {
if _, err := os.Stdout.Write(out); err != nil {
return err
}
return nil