From 2f65d6fc74686f4906c4523e1d5630f1920dc595 Mon Sep 17 00:00:00 2001 From: Nigel Tao Date: Sun, 22 Aug 2021 12:52:52 +1000 Subject: [PATCH] Use go:embed instead of ".../internal/cgen/data" --- cmd/wuffs-c/release.go | 14 ++-- internal/cgen/cgen.go | 53 ++++++++------- internal/cgen/embed.go | 147 +++++++++++++++++++++++++++++++++++++++++ 3 files changed, 184 insertions(+), 30 deletions(-) create mode 100644 internal/cgen/embed.go diff --git a/cmd/wuffs-c/release.go b/cmd/wuffs-c/release.go index 30197976..d102e151 100644 --- a/cmd/wuffs-c/release.go +++ b/cmd/wuffs-c/release.go @@ -23,7 +23,7 @@ import ( "sort" "strings" - "github.com/google/wuffs/internal/cgen/data" + "github.com/google/wuffs/internal/cgen" cf "github.com/google/wuffs/cmd/commonflags" ) @@ -107,10 +107,10 @@ func doGenrelease(args []string) error { } out.WriteString("#if defined(__cplusplus) && defined(WUFFS_BASE__HAVE_UNIQUE_PTR)\n\n") - out.WriteString(data.AuxBaseHh) + out.WriteString(cgen.EmbeddedString_AuxBaseHh.Trim()) out.WriteString("\n") - for _, f := range data.AuxNonBaseHhFiles { - out.WriteString(f) + for _, f := range cgen.EmbeddedStrings_AuxNonBaseHhFiles { + out.WriteString(f.Trim()) out.WriteString("\n") } out.WriteString("#endif // defined(__cplusplus) && defined(WUFFS_BASE__HAVE_UNIQUE_PTR)\n") @@ -126,10 +126,10 @@ func doGenrelease(args []string) error { } out.WriteString("#if defined(__cplusplus) && defined(WUFFS_BASE__HAVE_UNIQUE_PTR)\n\n") - out.WriteString(data.AuxBaseCc) + out.WriteString(cgen.EmbeddedString_AuxBaseCc.Trim()) out.WriteString("\n") - for _, f := range data.AuxNonBaseCcFiles { - out.WriteString(f) + for _, f := range cgen.EmbeddedStrings_AuxNonBaseCcFiles { + out.WriteString(f.Trim()) out.WriteString("\n") } out.WriteString("#endif // defined(__cplusplus) && defined(WUFFS_BASE__HAVE_UNIQUE_PTR)\n\n") diff --git a/internal/cgen/cgen.go b/internal/cgen/cgen.go index fe7519a6..88c15881 100644 --- a/internal/cgen/cgen.go +++ b/internal/cgen/cgen.go @@ -22,7 +22,6 @@ import ( "sort" "strings" - "github.com/google/wuffs/internal/cgen/data" "github.com/google/wuffs/lang/builtin" "github.com/google/wuffs/lang/generate" "github.com/google/wuffs/lib/dumbindent" @@ -122,7 +121,7 @@ func Do(args []string) error { return nil, fmt.Errorf("base package shouldn't have any .wuffs files") } buf := make(buffer, 0, 128*1024) - if err := expandBangBangInsert(&buf, data.BaseAllImplC, map[string]func(*buffer) error{ + if err := expandBangBangInsert(&buf, embedBaseAllImplC.Trim(), map[string]func(*buffer) error{ "// ¡ INSERT InterfaceDeclarations.\n": insertInterfaceDeclarations, "// ¡ INSERT InterfaceDefinitions.\n": insertInterfaceDefinitions, "// ¡ INSERT base/all-private.h.\n": insertBaseAllPrivateH, @@ -270,24 +269,24 @@ func expandBangBangInsert(b *buffer, s string, m map[string]func(*buffer) error) } func insertBaseAllPrivateH(buf *buffer) error { - buf.writes(data.BaseFundamentalPrivateH) + buf.writes(embedBaseFundamentalPrivateH.Trim()) buf.writeb('\n') - buf.writes(data.BaseRangePrivateH) + buf.writes(embedBaseRangePrivateH.Trim()) buf.writeb('\n') - buf.writes(data.BaseIOPrivateH) + buf.writes(embedBaseIOPrivateH.Trim()) buf.writeb('\n') - buf.writes(data.BaseTokenPrivateH) + buf.writes(embedBaseTokenPrivateH.Trim()) buf.writeb('\n') - buf.writes(data.BaseMemoryPrivateH) + buf.writes(embedBaseMemoryPrivateH.Trim()) buf.writeb('\n') - buf.writes(data.BaseImagePrivateH) + buf.writes(embedBaseImagePrivateH.Trim()) buf.writeb('\n') - buf.writes(data.BaseStrConvPrivateH) + buf.writes(embedBaseStrConvPrivateH.Trim()) return nil } func insertBaseAllPublicH(buf *buffer) error { - if err := expandBangBangInsert(buf, data.BaseFundamentalPublicH, map[string]func(*buffer) error{ + if err := expandBangBangInsert(buf, embedBaseFundamentalPublicH.Trim(), map[string]func(*buffer) error{ "// ¡ INSERT FourCCs.\n": func(b *buffer) error { for i, z := range builtin.FourCCs { if i != 0 { @@ -340,49 +339,57 @@ func insertBaseAllPublicH(buf *buffer) error { } buf.writeb('\n') - buf.writes(data.BaseRangePublicH) + buf.writes(embedBaseRangePublicH.Trim()) buf.writeb('\n') - buf.writes(data.BaseIOPublicH) + buf.writes(embedBaseIOPublicH.Trim()) buf.writeb('\n') - buf.writes(data.BaseTokenPublicH) + buf.writes(embedBaseTokenPublicH.Trim()) buf.writeb('\n') - buf.writes(data.BaseMemoryPublicH) + buf.writes(embedBaseMemoryPublicH.Trim()) buf.writeb('\n') - buf.writes(data.BaseImagePublicH) + buf.writes(embedBaseImagePublicH.Trim()) buf.writeb('\n') - buf.writes(data.BaseStrConvPublicH) + buf.writes(embedBaseStrConvPublicH.Trim()) return nil } func insertBaseCopyright(buf *buffer) error { - buf.writes(data.BaseCopyright) + s := string(embedBaseAllImplC) + if strings.HasPrefix(s, "// After editing ") { + if i := strings.Index(s, "\n\n"); i >= 0 { + s = s[i+2:] + } + } + if i := strings.Index(s, "\n\n"); i >= 0 { + buf.writes(s[:i+1]) + } return nil } func insertBaseFloatConvSubmoduleC(buf *buffer) error { - buf.writes(data.BaseFloatConvSubmoduleDataC) + buf.writes(embedBaseFloatConvSubmoduleDataC.Trim()) buf.writeb('\n') - buf.writes(data.BaseFloatConvSubmoduleCodeC) + buf.writes(embedBaseFloatConvSubmoduleCodeC.Trim()) return nil } func insertBaseIntConvSubmoduleC(buf *buffer) error { - buf.writes(data.BaseIntConvSubmoduleC) + buf.writes(embedBaseIntConvSubmoduleC.Trim()) return nil } func insertBaseMagicSubmoduleC(buf *buffer) error { - buf.writes(data.BaseMagicSubmoduleC) + buf.writes(embedBaseMagicSubmoduleC.Trim()) return nil } func insertBasePixConvSubmoduleC(buf *buffer) error { - buf.writes(data.BasePixConvSubmoduleC) + buf.writes(embedBasePixConvSubmoduleC.Trim()) return nil } func insertBaseUTF8SubmoduleC(buf *buffer) error { - buf.writes(data.BaseUTF8SubmoduleC) + buf.writes(embedBaseUTF8SubmoduleC.Trim()) return nil } diff --git a/internal/cgen/embed.go b/internal/cgen/embed.go new file mode 100644 index 00000000..f3a4d0fd --- /dev/null +++ b/internal/cgen/embed.go @@ -0,0 +1,147 @@ +// Copyright 2021 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. + +package cgen + +import ( + _ "embed" + "strings" +) + +// EmbeddedString holds hand-written C/C++ code, exposed by this Go package by +// a "go:embed" directive. +type EmbeddedString string + +// Trim removes the leading "Copyright etc" boilerplate. +func (e EmbeddedString) Trim() string { + s := string(e) + if strings.HasPrefix(s, "// After editing ") { + if i := strings.Index(s, "\n\n"); i >= 0 { + s = s[i+2:] + } + } + if strings.HasPrefix(s, "// Copyright ") { + if i := strings.Index(s, "\n\n"); i >= 0 { + s = s[i+2:] + } + } + return s +} + +// ---- + +//go:embed base/all-impl.c +var embedBaseAllImplC EmbeddedString + +// ---- + +//go:embed base/fundamental-private.h +var embedBaseFundamentalPrivateH EmbeddedString + +//go:embed base/fundamental-public.h +var embedBaseFundamentalPublicH EmbeddedString + +//go:embed base/memory-private.h +var embedBaseMemoryPrivateH EmbeddedString + +//go:embed base/memory-public.h +var embedBaseMemoryPublicH EmbeddedString + +//go:embed base/image-private.h +var embedBaseImagePrivateH EmbeddedString + +//go:embed base/image-public.h +var embedBaseImagePublicH EmbeddedString + +//go:embed base/io-private.h +var embedBaseIOPrivateH EmbeddedString + +//go:embed base/io-public.h +var embedBaseIOPublicH EmbeddedString + +//go:embed base/range-private.h +var embedBaseRangePrivateH EmbeddedString + +//go:embed base/range-public.h +var embedBaseRangePublicH EmbeddedString + +//go:embed base/strconv-private.h +var embedBaseStrConvPrivateH EmbeddedString + +//go:embed base/strconv-public.h +var embedBaseStrConvPublicH EmbeddedString + +//go:embed base/token-private.h +var embedBaseTokenPrivateH EmbeddedString + +//go:embed base/token-public.h +var embedBaseTokenPublicH EmbeddedString + +// ---- + +//go:embed base/floatconv-submodule-code.c +var embedBaseFloatConvSubmoduleCodeC EmbeddedString + +//go:embed base/floatconv-submodule-data.c +var embedBaseFloatConvSubmoduleDataC EmbeddedString + +//go:embed base/intconv-submodule.c +var embedBaseIntConvSubmoduleC EmbeddedString + +//go:embed base/magic-submodule.c +var embedBaseMagicSubmoduleC EmbeddedString + +//go:embed base/pixconv-submodule.c +var embedBasePixConvSubmoduleC EmbeddedString + +//go:embed base/utf8-submodule.c +var embedBaseUTF8SubmoduleC EmbeddedString + +// ---- + +//go:embed auxiliary/base.cc +var EmbeddedString_AuxBaseCc EmbeddedString + +//go:embed auxiliary/base.hh +var EmbeddedString_AuxBaseHh EmbeddedString + +//go:embed auxiliary/cbor.cc +var embedAuxCborCc EmbeddedString + +//go:embed auxiliary/cbor.hh +var embedAuxCborHh EmbeddedString + +//go:embed auxiliary/image.cc +var embedAuxImageCc EmbeddedString + +//go:embed auxiliary/image.hh +var embedAuxImageHh EmbeddedString + +//go:embed auxiliary/json.cc +var embedAuxJsonCc EmbeddedString + +//go:embed auxiliary/json.hh +var embedAuxJsonHh EmbeddedString + +var EmbeddedStrings_AuxNonBaseCcFiles = []EmbeddedString{ + embedAuxCborCc, + embedAuxImageCc, + embedAuxJsonCc, +} + +var EmbeddedStrings_AuxNonBaseHhFiles = []EmbeddedString{ + embedAuxCborHh, + embedAuxImageHh, + embedAuxJsonHh, +}