Files
wuffs/cmd/wuffs-c/internal/cgen/cgen.go
T
2018-08-18 10:11:43 +10:00

925 lines
24 KiB
Go

// Copyright 2017 The Wuffs Authors.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//go:generate go run gen.go
package cgen
import (
"bytes"
"errors"
"flag"
"fmt"
"io/ioutil"
"math/big"
"os"
"os/exec"
"path/filepath"
"sort"
"strings"
"github.com/google/wuffs/lang/builtin"
"github.com/google/wuffs/lang/check"
"github.com/google/wuffs/lang/generate"
cf "github.com/google/wuffs/cmd/commonflags"
a "github.com/google/wuffs/lang/ast"
t "github.com/google/wuffs/lang/token"
)
var (
zero = big.NewInt(0)
one = big.NewInt(1)
)
// Prefixes are prepended to names to form a namespace and to avoid e.g.
// "double" being a valid Wuffs variable name but not a valid C one.
const (
aPrefix = "a_" // Function argument.
cPrefix = "c_" // Coroutine state.
fPrefix = "f_" // Struct field.
iPrefix = "i_" // Iterate variable.
oPrefix = "o_" // Temporary io_bind variable.
tPrefix = "t_" // Temporary local variable.
uPrefix = "u_" // Derived from a local variable.
vPrefix = "v_" // Local variable.
)
// I/O (reader/writer) prefixes. In the generated C code, the variables with
// these prefixes all have type uint8_t*. The iop_etc variables are the key
// ones. For an io_reader or io_writer function argument a_src or a_dst,
// reading or writing the next byte (and advancing the stream) is essentially
// "etc = *iop_a_src++" or "*io_a_dst++ = etc".
//
// The other two prefixes, giving names like io0_etc and io1_etc, are
// auxilliary pointers: lower and upper inclusive bounds. As an iop_etc pointer
// advances, it cannot advance past io1_etc. In the rarer case that an iop_etc
// pointer retreats, undoing a read or write, it cannot retreat past io0_etc.
//
// At the start of a function, these pointers are initialized from an
// io_buffer's fields (ptr, ri, wi, len), or possibly a limit field. For an
// io_reader:
// - io0_etc = ptr + ri
// - iop_etc = ptr + ri
// - io1_etc = ptr + wi or limit
// and for an io_writer:
// - io0_etc = ptr + wi
// - iop_etc = ptr + wi
// - io1_etc = ptr + len or limit
//
// TODO: discuss marks and limits, and how (if at all) auxilliary pointers can
// change over a function's lifetime.
const (
io0Prefix = "io0_" // Lower bound.
io1Prefix = "io1_" // Upper bound.
iopPrefix = "iop_" // Pointer.
)
// Do transpiles a Wuffs program to a C program.
//
// The arguments list the source Wuffs files. If no arguments are given, it
// reads from stdin.
//
// The generated program is written to stdout.
func Do(args []string) error {
flags := flag.FlagSet{}
cformatterFlag := flags.String("cformatter", cf.CformatterDefault, cf.CformatterUsage)
return generate.Do(&flags, args, func(pkgName string, tm *t.Map, c *check.Checker, files []*a.File) ([]byte, error) {
if !cf.IsAlphaNumericIsh(*cformatterFlag) {
return nil, fmt.Errorf("bad -cformatter flag value %q", *cformatterFlag)
}
unformatted := []byte(nil)
if pkgName == "base" {
if len(files) != 0 {
return nil, fmt.Errorf("base package shouldn't have any .wuffs files")
}
buf := make(buffer, 0, 128*1024)
if err := expandBangBangInsert(&buf, baseBaseImplC, map[string]func(*buffer) error{
"// !! INSERT base-private.h.\n": insertBasePrivateH,
"// !! INSERT base-public.h.\n": insertBasePublicH,
"// !! INSERT wuffs_base__status strings.\n": func(b *buffer) error {
for _, z := range builtin.StatusList {
if z == "" {
continue
}
pre := "error"
if z[0] == '$' {
pre = "suspension"
}
b.printf("const char* wuffs_base__%s__%s = \"%sbase: %s\";\n",
pre, cName(z, ""), z[:1], z[1:])
}
return nil
},
}); err != nil {
return nil, err
}
unformatted = []byte(buf)
} else {
g := &gen{
pkgPrefix: "wuffs_" + pkgName + "__",
pkgName: pkgName,
tm: tm,
checker: c,
files: files,
}
var err error
unformatted, err = g.generate()
if err != nil {
return nil, err
}
}
stdout := &bytes.Buffer{}
cmd := exec.Command(*cformatterFlag, "-style=Chromium")
cmd.Stdin = bytes.NewReader(unformatted)
cmd.Stdout = stdout
cmd.Stderr = os.Stderr
if err := cmd.Run(); err != nil {
return nil, err
}
return stdout.Bytes(), nil
})
}
type replacementPolicy bool
const (
replaceNothing = replacementPolicy(false)
replaceCallSuspendibles = replacementPolicy(true)
)
type visibility uint32
const (
bothPubPri = visibility(iota)
pubOnly
priOnly
)
const (
maxIOBinds = 100
maxIOBindInFields = 100
maxTemp = 10000
)
type status struct {
cName string
msg string
public bool
}
func statusMsgIsError(msg string) bool {
return (len(msg) == 0) || (msg[0] != '$')
}
type buffer []byte
func (b *buffer) Write(p []byte) (int, error) {
*b = append(*b, p...)
return len(p), nil
}
func (b *buffer) printf(format string, args ...interface{}) { fmt.Fprintf(b, format, args...) }
func (b *buffer) writeb(x byte) { *b = append(*b, x) }
func (b *buffer) writes(s string) { *b = append(*b, s...) }
func (b *buffer) writex(s []byte) { *b = append(*b, s...) }
func expandBangBangInsert(b *buffer, s string, m map[string]func(*buffer) error) error {
for {
remaining := ""
if i := strings.IndexByte(s, '\n'); i >= 0 {
s, remaining = s[:i+1], s[i+1:]
}
const prefix = "// !! INSERT "
if !strings.HasPrefix(s, prefix) {
b.writes(s)
} else if f := m[s]; f == nil {
msg := []byte(fmt.Sprintf("unrecognized line %q, want one of:\n", s))
keys := []string(nil)
for k := range m {
keys = append(keys, k)
}
sort.Strings(keys)
for _, k := range keys {
msg = append(msg, '\t')
msg = append(msg, k...)
}
return errors.New(string(msg))
} else if err := f(b); err != nil {
return err
}
if remaining == "" {
break
}
s = remaining
}
return nil
}
func insertBasePrivateH(buf *buffer) error {
buf.writes(baseBasePrivateH)
return nil
}
func insertBasePublicH(buf *buffer) error {
buf.writes("// Code generated by wuffs-c. DO NOT EDIT.\n\n")
buf.writes("#ifndef WUFFS_INCLUDE_GUARD__BASE_PUBLIC\n")
buf.writes("#define WUFFS_INCLUDE_GUARD__BASE_PUBLIC\n\n")
if err := expandBangBangInsert(buf, baseBasePublicH, map[string]func(*buffer) error{
"// !! INSERT wuffs_base__status names.\n": func(b *buffer) error {
for _, z := range builtin.StatusList {
pre := "error"
if !statusMsgIsError(z) {
pre = "suspension"
}
b.printf("extern const char* wuffs_base__%s__%s;\n", pre, cName(z, ""))
}
return nil
},
}); err != nil {
return err
}
buf.writeb('\n')
buf.writes(baseImagePublicH)
buf.writes("\n#endif // WUFFS_INCLUDE_GUARD__BASE_PUBLIC\n\n")
return nil
}
type gen struct {
pkgPrefix string // e.g. "wuffs_jpeg__"
pkgName string // e.g. "jpeg"
tm *t.Map
checker *check.Checker
files []*a.File
statusList []status
statusMap map[t.QID]status
structList []*a.Struct
structMap map[t.QID]*a.Struct
usesList []string
usesMap map[string]struct{}
currFunk funk
funks map[t.QQID]funk
wuffsRoot string
}
func (g *gen) generate() ([]byte, error) {
b := new(buffer)
g.statusMap = map[t.QID]status{}
if err := g.forEachStatus(b, bothPubPri, (*gen).gatherStatuses); err != nil {
return nil, err
}
// Make a topologically sorted list of structs.
unsortedStructs := []*a.Struct(nil)
for _, file := range g.files {
for _, tld := range file.TopLevelDecls() {
if tld.Kind() == a.KStruct {
unsortedStructs = append(unsortedStructs, tld.AsStruct())
}
}
}
var ok bool
g.structList, ok = a.TopologicalSortStructs(unsortedStructs)
if !ok {
return nil, fmt.Errorf("cyclical struct definitions")
}
g.structMap = map[t.QID]*a.Struct{}
for _, n := range g.structList {
g.structMap[n.QID()] = n
}
g.funks = map[t.QQID]funk{}
if err := g.forEachFunc(nil, bothPubPri, (*gen).gatherFuncImpl); err != nil {
return nil, err
}
includeGuard := "WUFFS_INCLUDE_GUARD__" + strings.ToUpper(g.pkgName)
b.printf("#ifndef %s\n#define %s\n\n", includeGuard, includeGuard)
if err := g.genHeader(b); err != nil {
return nil, err
}
b.writex(wiStart)
if err := g.genImpl(b); err != nil {
return nil, err
}
b.writex(wiEnd)
b.printf("#endif // %s\n\n", includeGuard)
return *b, nil
}
func (g *gen) genHeader(b *buffer) error {
if err := insertBasePublicH(b); err != nil {
return err
}
b.writes("// ---------------- Use Declarations\n\n")
if err := g.forEachUse(b, (*gen).writeUse); err != nil {
return err
}
b.writes("\n#ifdef __cplusplus\nextern \"C\" {\n#endif\n\n")
b.writes("// ---------------- Status Codes\n\n")
for _, z := range g.statusList {
if !z.public {
continue
}
b.printf("extern const char* %s;\n", z.cName)
}
b.writes("\n")
b.writes("// ---------------- Public Consts\n\n")
if err := g.forEachConst(b, pubOnly, (*gen).writeConst); err != nil {
return err
}
b.writes("// ---------------- Structs\n\n")
for _, n := range g.structList {
if err := g.writeStruct(b, n); err != nil {
return err
}
}
b.writes("// ---------------- Public Initializer Prototypes\n\n")
for _, n := range g.structList {
if n.Public() {
if err := g.writeInitializerPrototype(b, n); err != nil {
return err
}
}
}
b.writes("// ---------------- Public Function Prototypes\n\n")
if err := g.forEachFunc(b, pubOnly, (*gen).writeFuncPrototype); err != nil {
return err
}
b.writes("// ---------------- C++ Convenience Methods \n\n")
if err := g.writeCppImpls(b); err != nil {
return err
}
b.writes("\n#ifdef __cplusplus\n} // extern \"C\"\n#endif\n\n")
return nil
}
func (g *gen) genImpl(b *buffer) error {
b.writes(baseBasePrivateH)
b.writeb('\n')
module := "!defined(WUFFS_CONFIG__MODULES) || defined(WUFFS_CONFIG__MODULE__" +
strings.ToUpper(g.pkgName) + ")"
b.printf("#if %s\n\n", module)
b.writes("// ---------------- Status Codes Implementations\n\n")
for _, z := range g.statusList {
if z.msg == "" {
continue
}
b.printf("const char* %s = \"%s%s: %s\";\n", z.cName, z.msg[:1], g.pkgName, z.msg[1:])
}
b.writes("\n")
b.writes("// ---------------- Private Consts\n\n")
if err := g.forEachConst(b, priOnly, (*gen).writeConst); err != nil {
return err
}
b.writes("// ---------------- Private Initializer Prototypes\n\n")
for _, n := range g.structList {
if !n.Public() {
if err := g.writeInitializerPrototype(b, n); err != nil {
return err
}
}
}
b.writes("// ---------------- Private Function Prototypes\n\n")
if err := g.forEachFunc(b, priOnly, (*gen).writeFuncPrototype); err != nil {
return err
}
b.writes("// ---------------- Initializer Implementations\n\n")
for _, n := range g.structList {
if err := g.writeInitializerImpl(b, n); err != nil {
return err
}
}
b.writes("// ---------------- Function Implementations\n\n")
if err := g.forEachFunc(b, bothPubPri, (*gen).writeFuncImpl); err != nil {
return err
}
b.printf("#endif // %s\n\n", module)
return nil
}
func (g *gen) forEachConst(b *buffer, v visibility, f func(*gen, *buffer, *a.Const) error) error {
for _, file := range g.files {
for _, tld := range file.TopLevelDecls() {
if tld.Kind() != a.KConst ||
(v == pubOnly && tld.AsRaw().Flags()&a.FlagsPublic == 0) ||
(v == priOnly && tld.AsRaw().Flags()&a.FlagsPublic != 0) {
continue
}
if err := f(g, b, tld.AsConst()); err != nil {
return err
}
}
}
return nil
}
func (g *gen) forEachFunc(b *buffer, v visibility, f func(*gen, *buffer, *a.Func) error) error {
for _, file := range g.files {
for _, tld := range file.TopLevelDecls() {
if tld.Kind() != a.KFunc ||
(v == pubOnly && tld.AsRaw().Flags()&a.FlagsPublic == 0) ||
(v == priOnly && tld.AsRaw().Flags()&a.FlagsPublic != 0) {
continue
}
if err := f(g, b, tld.AsFunc()); err != nil {
return err
}
}
}
return nil
}
func (g *gen) forEachStatus(b *buffer, v visibility, f func(*gen, *buffer, *a.Status) error) error {
for _, file := range g.files {
for _, tld := range file.TopLevelDecls() {
if tld.Kind() != a.KStatus ||
(v == pubOnly && tld.AsRaw().Flags()&a.FlagsPublic == 0) ||
(v == priOnly && tld.AsRaw().Flags()&a.FlagsPublic != 0) {
continue
}
if err := f(g, b, tld.AsStatus()); err != nil {
return err
}
}
}
return nil
}
func (g *gen) forEachUse(b *buffer, f func(*gen, *buffer, *a.Use) error) error {
for _, file := range g.files {
for _, tld := range file.TopLevelDecls() {
if tld.Kind() != a.KUse {
continue
}
if err := f(g, b, tld.AsUse()); err != nil {
return err
}
}
}
return nil
}
func (g *gen) cName(name string) string {
return cName(name, g.pkgPrefix)
}
func cName(name string, pkgPrefix string) string {
s := []byte(pkgPrefix)
underscore := true
for _, r := range name {
if 'A' <= r && r <= 'Z' {
s = append(s, byte(r+'a'-'A'))
underscore = false
} else if ('a' <= r && r <= 'z') || ('0' <= r && r <= '9') {
s = append(s, byte(r))
underscore = false
} else if !underscore {
s = append(s, '_')
underscore = true
}
}
if underscore {
s = s[:len(s)-1]
}
return string(s)
}
func uintBits(qid t.QID) uint32 {
if qid[0] == t.IDBase {
switch qid[1] {
case t.IDU8:
return 8
case t.IDU16:
return 16
case t.IDU32:
return 32
case t.IDU64:
return 64
}
}
return 0
}
func (g *gen) sizeof(typ *a.TypeExpr) (uint32, error) {
if typ.Decorator() == 0 {
if n := uintBits(typ.QID()); n != 0 {
return n / 8, nil
}
}
return 0, fmt.Errorf("unknown sizeof for %q", typ.Str(g.tm))
}
func (g *gen) gatherStatuses(b *buffer, n *a.Status) error {
raw := n.QID()[1].Str(g.tm)
msg, ok := t.Unescape(raw)
if !ok || msg == "" {
return fmt.Errorf("bad status message %q", raw)
}
errSus := "error__"
if msg[0] == '$' {
errSus = "suspension__"
}
z := status{
cName: g.pkgPrefix + errSus + cName(msg, ""),
msg: msg,
public: n.Public(),
}
g.statusList = append(g.statusList, z)
g.statusMap[n.QID()] = z
return nil
}
func (g *gen) writeConst(b *buffer, n *a.Const) error {
if n.Public() {
b.writes("WUFFS_BASE__MAYBE_STATIC ")
} else {
b.writes("static ")
}
b.writes("const ")
if err := g.writeCTypeName(b, n.XType(), g.pkgPrefix, n.QID()[1].Str(g.tm)); err != nil {
return err
}
b.writes(" = ")
if err := g.writeConstList(b, n.Value()); err != nil {
return err
}
b.writes(";\n\n")
return nil
}
func (g *gen) writeConstList(b *buffer, n *a.Expr) error {
if n.Operator() == t.IDComma {
b.writeb('{')
for _, o := range n.Args() {
if err := g.writeConstList(b, o.AsExpr()); err != nil {
return err
}
b.writeb(',')
}
b.writeb('}')
} else if cv := n.ConstValue(); cv != nil {
b.writes(cv.String())
} else {
return fmt.Errorf("invalid const value %q", n.Str(g.tm))
}
return nil
}
func (g *gen) writeStruct(b *buffer, n *a.Struct) error {
// For API/ABI compatibility, the very first field in the struct's
// private_impl must be the status code. This lets the initializer callee
// set "self->private_impl.status = wuffs_base__error__bad_wuffs_version;"
// regardless of the sizeof(*self) struct reserved by the caller and even
// if the caller and callee were built with different versions.
structName := n.QID().Str(g.tm)
b.writes("typedef struct {\n")
b.writes("// Do not access the private_impl's fields directly. There is no API/ABI\n")
b.writes("// compatibility or safety guarantee if you do so. Instead, use the\n")
b.printf("// %s%s__etc functions.\n", g.pkgPrefix, structName)
b.writes("//\n")
b.writes("// In C++, these fields would be \"private\", but C does not support that.\n")
b.writes("//\n")
b.writes("// It is a struct, not a struct*, so that it can be stack allocated.\n")
b.writes("struct {\n")
if n.Classy() {
b.printf("wuffs_base__status status;\n")
b.writes("uint32_t magic;\n")
b.writes("\n")
}
for _, o := range n.Fields() {
o := o.AsField()
if err := g.writeCTypeName(b, o.XType(), fPrefix, o.Name().Str(g.tm)); err != nil {
return err
}
b.writes(";\n")
}
if n.Classy() {
b.writeb('\n')
for _, file := range g.files {
for _, tld := range file.TopLevelDecls() {
if tld.Kind() != a.KFunc {
continue
}
o := tld.AsFunc()
if o.Receiver() != n.QID() || !o.Effect().Coroutine() {
continue
}
k := g.funks[o.QQID()]
if k.coroSuspPoint == 0 && !k.usesScratch {
continue
}
// TODO: allow max depth > 1 for recursive coroutines.
const maxDepth = 1
b.writes("struct {\n")
if k.coroSuspPoint != 0 {
b.writes("uint32_t coro_susp_point;\n")
if err := g.writeVars(b, o.Body(), true, true); err != nil {
return err
}
}
if k.usesScratch {
b.writes("uint64_t scratch;\n")
}
b.printf("} %s%s[%d];\n", cPrefix, o.FuncName().Str(g.tm), maxDepth)
}
}
}
b.writes("} private_impl;\n\n")
if n.AsNode().AsRaw().Flags()&a.FlagsPublic != 0 {
if err := g.writeCppPrototypes(b, n); err != nil {
return err
}
}
b.printf("} %s%s;\n\n", g.pkgPrefix, structName)
return nil
}
func (g *gen) writeCppPrototypes(b *buffer, n *a.Struct) error {
b.writes("#ifdef __cplusplus\n")
// The empty // comment makes clang-format place the function name
// at the start of a line.
b.writes("inline wuffs_base__status WUFFS_BASE__WARN_UNUSED_RESULT //\n" +
"check_wuffs_version(size_t sizeof_star_self, uint64_t wuffs_version);\n")
structID := n.QID()[1]
for _, file := range g.files {
for _, tld := range file.TopLevelDecls() {
if (tld.Kind() != a.KFunc) || (tld.AsRaw().Flags()&a.FlagsPublic == 0) {
continue
}
f := tld.AsFunc()
qqid := f.QQID()
if qqid[1] != structID {
continue
}
if err := g.writeFuncSignature(b, f, cppInsideStruct); err != nil {
return err
}
b.writes(";\n")
}
}
b.writes("#endif // __cplusplus\n\n")
return nil
}
func (g *gen) writeCppImpls(b *buffer) error {
b.writes("\n#ifdef __cplusplus\n\n")
publicStructs := map[t.ID]bool{}
for _, file := range g.files {
for _, tld := range file.TopLevelDecls() {
if (tld.Kind() != a.KStruct) || (tld.AsRaw().Flags()&a.FlagsPublic == 0) {
continue
}
n := tld.AsStruct()
structID := n.QID()[1]
structName := structID.Str(g.tm)
// The empty // comment makes clang-format place the function name
// at the start of a line.
b.writes("inline wuffs_base__status WUFFS_BASE__WARN_UNUSED_RESULT //\n")
b.printf("%s%s::check_wuffs_version(size_t sizeof_star_self, uint64_t wuffs_version) {\n",
g.pkgPrefix, structName)
b.printf("return %s%s__check_wuffs_version(this, sizeof_star_self, wuffs_version);\n",
g.pkgPrefix, structName)
b.printf("}\n\n")
publicStructs[structID] = true
}
}
for _, file := range g.files {
for _, tld := range file.TopLevelDecls() {
if (tld.Kind() != a.KFunc) || (tld.AsRaw().Flags()&a.FlagsPublic == 0) {
continue
}
n := tld.AsFunc()
if !publicStructs[n.QQID()[1]] {
continue
}
if err := g.writeFuncSignature(b, n, cppOutsideStruct); err != nil {
return err
}
b.writes("{ return ")
b.writes(g.funcCName(n))
b.writes("(this")
for _, o := range n.In().Fields() {
b.writeb(',')
b.writes(aPrefix)
b.writes(o.AsField().Name().Str(g.tm))
}
b.writes(");}\n\n")
}
}
b.writes("#endif // __cplusplus\n\n")
return nil
}
var (
wiStart = []byte("\n#ifdef WUFFS_IMPLEMENTATION\n\n")
wiEnd = []byte("\n#endif // WUFFS_IMPLEMENTATION\n\n")
wigbpStart = []byte("\n#ifndef WUFFS_INCLUDE_GUARD__BASE_PUBLIC\n")
wigbpEnd = []byte("\n#endif // WUFFS_INCLUDE_GUARD__BASE_PUBLIC\n")
)
func (g *gen) writeUse(b *buffer, n *a.Use) error {
useDirname := g.tm.ByID(n.Path())
useDirname, _ = t.Unescape(useDirname)
// TODO: sanity check useDirname via commonflags.IsValidUsePath?
if g.usesMap == nil {
g.usesMap = map[string]struct{}{}
} else if _, ok := g.usesMap[useDirname]; ok {
return nil
}
g.usesList = append(g.usesList, useDirname)
g.usesMap[useDirname] = struct{}{}
if g.wuffsRoot == "" {
var err error
g.wuffsRoot, err = generate.WuffsRoot()
if err != nil {
return err
}
}
useeFilename := filepath.Join(g.wuffsRoot, "gen", "c", filepath.FromSlash(useDirname)+".h")
usee, err := ioutil.ReadFile(useeFilename)
if err != nil {
return err
}
trimmed := []byte(nil)
if i := bytes.Index(usee, wiStart); i >= 0 {
remaining := usee[i+len(wiStart):]
if j := bytes.Index(remaining, wiEnd); j >= 0 {
trimmed = append(trimmed, usee[:i]...)
trimmed = append(trimmed, '\n')
trimmed = append(trimmed, remaining[j+len(wiEnd):]...)
usee = trimmed
}
}
if len(trimmed) == 0 {
return fmt.Errorf("use %q: previously generated code %q could not be inlined", useDirname, useeFilename)
}
b.printf("// ---------------- BEGIN USE %q\n\n", useDirname)
// Inline the previously generated .h file, stripping out the redundant
// copy of the WUFFS_INCLUDE_GUARD__BASE_PUBLIC code.
if i := bytes.Index(usee, wigbpStart); i < 0 {
return fmt.Errorf("use %q: previously generated code %q could not be inlined", useDirname, useeFilename)
} else {
b.Write(usee[:i])
usee = usee[i+len(wigbpStart):]
}
if i := bytes.Index(usee, wigbpEnd); i < 0 {
return fmt.Errorf("use %q: previously generated code %q could not be inlined", useDirname, useeFilename)
} else {
b.Write(usee[i+len(wigbpEnd):])
}
b.printf("\n\n// ---------------- END USE %q\n\n", useDirname)
return nil
}
func (g *gen) writeInitializerSignature(b *buffer, n *a.Struct, public bool) error {
structName := n.QID().Str(g.tm)
if public {
b.printf("// %s%s__check_wuffs_version is an initializer function.\n", g.pkgPrefix, structName)
b.printf("//\n")
b.printf("// It should be called before any other %s%s__* function.\n", g.pkgPrefix, structName)
b.printf("//\n")
b.printf("// Pass sizeof(*self) and WUFFS_VERSION for sizeof_star_self and wuffs_version.\n")
}
b.printf("wuffs_base__status WUFFS_BASE__WARN_UNUSED_RESULT //\n"+
"%s%s__check_wuffs_version(%s%s *self, size_t sizeof_star_self, uint64_t wuffs_version)",
g.pkgPrefix, structName, g.pkgPrefix, structName)
return nil
}
func (g *gen) writeInitializerPrototype(b *buffer, n *a.Struct) error {
if !n.Classy() {
return nil
}
if err := g.writeInitializerSignature(b, n, n.Public()); err != nil {
return err
}
b.writes(";\n\n")
return nil
}
func (g *gen) writeInitializerImpl(b *buffer, n *a.Struct) error {
if !n.Classy() {
return nil
}
if err := g.writeInitializerSignature(b, n, false); err != nil {
return err
}
b.writes("{\n")
b.writes("if (!self) { return wuffs_base__error__bad_receiver; }\n")
b.writes("if (sizeof(*self) != sizeof_star_self) {\n")
b.writes("return wuffs_base__error__bad_sizeof_receiver;\n")
b.writes("}\n")
b.writes("if (((wuffs_version >> 32) != WUFFS_VERSION_MAJOR) || " +
"(((wuffs_version >> 16) & 0xFFFF) > WUFFS_VERSION_MINOR)) {\n")
b.writes("return wuffs_base__error__bad_wuffs_version;\n")
b.writes("}\n")
b.writes("if (self->private_impl.magic != 0) {\n")
b.writes("return wuffs_base__error__check_wuffs_version_called_twice;\n")
b.writes("}\n")
// Call any ctors on sub-structs.
for _, f := range n.Fields() {
f := f.AsField()
x := f.XType()
if x != x.Innermost() {
// TODO: arrays of sub-structs.
continue
}
prefix := g.pkgPrefix
qid := x.QID()
if qid[0] == t.IDBase {
// Base types don't need further initialization.
continue
} else if qid[0] != 0 {
// See gen.packagePrefix for a related TODO with otherPkg.
otherPkg := g.tm.ByID(qid[0])
prefix = "wuffs_" + otherPkg + "__"
} else if g.structMap[qid] == nil {
continue
}
b.printf("{\n")
b.printf("wuffs_base__status z = %s%s__check_wuffs_version("+
"&self->private_impl.%s%s, sizeof(self->private_impl.%s%s), WUFFS_VERSION);\n",
prefix, qid[1].Str(g.tm), fPrefix, f.Name().Str(g.tm), fPrefix, f.Name().Str(g.tm))
b.printf("if (z) { return z; }\n")
b.printf("}\n")
}
b.writes("self->private_impl.magic = WUFFS_BASE__MAGIC;\n")
b.writes("return NULL;\n")
b.writes("}\n\n")
return nil
}