mirror of
https://github.com/hajimehoshi/ebiten.git
synced 2025-02-10 18:13:18 +01:00
internal/shaderlister: introduce ebitengine:shaderfile to replace ebitengine:embeddedshader
Updates #3157
This commit is contained in:
parent
a060eea178
commit
76bba89589
@ -14,8 +14,6 @@
|
||||
|
||||
//go:build ignore
|
||||
|
||||
//ebitengine:embeddedshader
|
||||
|
||||
//kage:unit pixels
|
||||
|
||||
// Reference: a public domain CRT effect
|
||||
|
@ -43,6 +43,8 @@ var flagCRT = flag.Bool("crt", false, "enable the CRT effect")
|
||||
//go:embed crt.go
|
||||
var crtGo []byte
|
||||
|
||||
//ebitengine:shaderfile crt.go
|
||||
|
||||
func floorDiv(x, y int) int {
|
||||
d := x / y
|
||||
if d*y == x || x >= 0 {
|
||||
|
@ -14,8 +14,6 @@
|
||||
|
||||
//go:build ignore
|
||||
|
||||
//ebitengine:embeddedshader
|
||||
|
||||
//kage:unit pixels
|
||||
|
||||
package main
|
||||
|
@ -14,8 +14,6 @@
|
||||
|
||||
//go:build ignore
|
||||
|
||||
//ebitengine:embeddedshader
|
||||
|
||||
//kage:unit pixels
|
||||
|
||||
package main
|
||||
|
@ -14,8 +14,6 @@
|
||||
|
||||
//go:build ignore
|
||||
|
||||
//ebitengine:embeddedshader
|
||||
|
||||
//kage:unit pixels
|
||||
|
||||
package main
|
||||
|
@ -14,8 +14,6 @@
|
||||
|
||||
//go:build ignore
|
||||
|
||||
//ebitengine:embeddedshader
|
||||
|
||||
//kage:unit pixels
|
||||
|
||||
package main
|
||||
|
@ -50,6 +50,17 @@ var (
|
||||
water_go []byte
|
||||
)
|
||||
|
||||
// These directives are used for an shader analyzer in the future.
|
||||
// See also #3157.
|
||||
|
||||
//ebitengine:shaderfile default.go
|
||||
//ebitengine:shaderfile texel.go
|
||||
//ebitengine:shaderfile lighting.go
|
||||
//ebitengine:shaderfile radialblur.go
|
||||
//ebitengine:shaderfile chromaticaberration.go
|
||||
//ebitengine:shaderfile dissolve.go
|
||||
//ebitengine:shaderfile water.go
|
||||
|
||||
const (
|
||||
screenWidth = 640
|
||||
screenHeight = 480
|
||||
|
@ -14,8 +14,6 @@
|
||||
|
||||
//go:build ignore
|
||||
|
||||
//ebitengine:embeddedshader
|
||||
|
||||
//kage:unit pixels
|
||||
|
||||
package main
|
||||
|
@ -14,8 +14,6 @@
|
||||
|
||||
//go:build ignore
|
||||
|
||||
//ebitengine:embeddedshader
|
||||
|
||||
//kage:unit pixels
|
||||
|
||||
package main
|
||||
|
@ -14,8 +14,6 @@
|
||||
|
||||
//go:build ignore
|
||||
|
||||
//ebitengine:embeddedshader
|
||||
|
||||
//kage:unit pixels
|
||||
|
||||
package main
|
||||
|
@ -17,6 +17,7 @@ package main
|
||||
import (
|
||||
"bufio"
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"flag"
|
||||
"fmt"
|
||||
"go/ast"
|
||||
@ -25,6 +26,7 @@ import (
|
||||
"go/types"
|
||||
"log/slog"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"regexp"
|
||||
"strings"
|
||||
|
||||
@ -94,7 +96,7 @@ func xmain() error {
|
||||
}
|
||||
|
||||
pkgs, err := packages.Load(&packages.Config{
|
||||
Mode: packages.NeedName | packages.NeedImports | packages.NeedDeps | packages.NeedTypes | packages.NeedSyntax | packages.NeedTypesInfo | packages.NeedEmbedFiles,
|
||||
Mode: packages.NeedName | packages.NeedImports | packages.NeedDeps | packages.NeedTypes | packages.NeedSyntax | packages.NeedTypesInfo,
|
||||
}, flag.Args()...)
|
||||
if err != nil {
|
||||
return err
|
||||
@ -180,16 +182,16 @@ func isStandardImportPath(path string) bool {
|
||||
}
|
||||
|
||||
const (
|
||||
shaderSourceDirective = "ebitengine:shadersource"
|
||||
embeddedShaderDirective = "ebitengine:embeddedshader"
|
||||
shaderSourceDirective = "ebitengine:shadersource"
|
||||
shaderFileDirective = "ebitengine:shaderfile"
|
||||
)
|
||||
|
||||
var (
|
||||
reShaderSourceDirective = regexp.MustCompile(`(?m)^\s*//` + regexp.QuoteMeta(shaderSourceDirective))
|
||||
reEmbeddedShaderDirective = regexp.MustCompile(`(?m)^\s*//` + regexp.QuoteMeta(embeddedShaderDirective))
|
||||
reShaderSourceDirective = regexp.MustCompile(`(?m)^\s*//` + regexp.QuoteMeta(shaderSourceDirective) + `$`)
|
||||
reShaderFileDirective = regexp.MustCompile(`(?m)^\s*//` + regexp.QuoteMeta(shaderFileDirective) + ` (.+)$`)
|
||||
)
|
||||
|
||||
func hasShaderDirectiveInComment(commentGroup *ast.CommentGroup) bool {
|
||||
func hasShaderSourceDirectiveInComment(commentGroup *ast.CommentGroup) bool {
|
||||
for _, line := range commentGroup.List {
|
||||
if reShaderSourceDirective.MatchString(line.Text) {
|
||||
return true
|
||||
@ -210,8 +212,54 @@ func appendShaderSources(shaders []Shader, pkg *packages.Package) ([]Shader, err
|
||||
return ok
|
||||
}
|
||||
|
||||
var genDeclStack []*ast.GenDecl
|
||||
// Resolve ebitengine:shaderfile directives.
|
||||
for _, f := range pkg.Syntax {
|
||||
for _, c := range f.Comments {
|
||||
for _, l := range c.List {
|
||||
m := reShaderFileDirective.FindStringSubmatch(l.Text)
|
||||
if len(m) == 0 {
|
||||
continue
|
||||
}
|
||||
pattern := filepath.Join(pkg.Dir, filepath.FromSlash(m[1]))
|
||||
stat, err := os.Stat(pattern)
|
||||
if err == nil && stat.IsDir() {
|
||||
// If the pattern is a directory, read all files in the directory recursively.
|
||||
if err := filepath.WalkDir(pattern, func(path string, d os.DirEntry, err error) error {
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
if d.IsDir() {
|
||||
return nil
|
||||
}
|
||||
shaders, err = appendShaderFromFile(shaders, pkg.PkgPath, path)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
return nil
|
||||
}); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
continue
|
||||
}
|
||||
if err != nil && !errors.Is(err, os.ErrNotExist) {
|
||||
return nil, err
|
||||
}
|
||||
paths, err := filepath.Glob(pattern)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
for _, path := range paths {
|
||||
shaders, err = appendShaderFromFile(shaders, pkg.PkgPath, path)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Resolve ebitengine:shadersource directives.
|
||||
var genDeclStack []*ast.GenDecl
|
||||
in := inspector.New(pkg.Syntax)
|
||||
in.Nodes([]ast.Node{
|
||||
(*ast.GenDecl)(nil),
|
||||
@ -228,7 +276,7 @@ func appendShaderSources(shaders []Shader, pkg *packages.Package) ([]Shader, err
|
||||
// If the GenDecl is with parentheses (e.g. `const ( ... )`), check the GenDecl's comment.
|
||||
// The directive doesn't work, so if the directive is found, warn it.
|
||||
if genDecl.Lparen != token.NoPos {
|
||||
if genDecl.Doc != nil && hasShaderDirectiveInComment(genDecl.Doc) {
|
||||
if genDecl.Doc != nil && hasShaderSourceDirectiveInComment(genDecl.Doc) {
|
||||
pos := pkg.Fset.Position(genDecl.Doc.Pos())
|
||||
slog.Warn(fmt.Sprintf("misplaced %s directive", shaderSourceDirective),
|
||||
"package", pkg.PkgPath,
|
||||
@ -240,7 +288,7 @@ func appendShaderSources(shaders []Shader, pkg *packages.Package) ([]Shader, err
|
||||
if genDecl.Doc == nil {
|
||||
return false
|
||||
}
|
||||
if !hasShaderDirectiveInComment(genDecl.Doc) {
|
||||
if !hasShaderSourceDirectiveInComment(genDecl.Doc) {
|
||||
return false
|
||||
}
|
||||
}
|
||||
@ -264,7 +312,7 @@ func appendShaderSources(shaders []Shader, pkg *packages.Package) ([]Shader, err
|
||||
if spec.Doc == nil {
|
||||
return false
|
||||
}
|
||||
if !hasShaderDirectiveInComment(spec.Doc) {
|
||||
if !hasShaderSourceDirectiveInComment(spec.Doc) {
|
||||
return false
|
||||
}
|
||||
}
|
||||
@ -335,21 +383,19 @@ func appendShaderSources(shaders []Shader, pkg *packages.Package) ([]Shader, err
|
||||
}
|
||||
})
|
||||
|
||||
for _, file := range pkg.EmbedFiles {
|
||||
content, err := os.ReadFile(file)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
if !reEmbeddedShaderDirective.Match(content) {
|
||||
continue
|
||||
}
|
||||
shaders = append(shaders, Shader{
|
||||
Package: pkg.PkgPath,
|
||||
File: file,
|
||||
Source: string(content),
|
||||
})
|
||||
}
|
||||
return shaders, nil
|
||||
}
|
||||
|
||||
func appendShaderFromFile(shaders []Shader, pkgPath string, filePath string) ([]Shader, error) {
|
||||
content, err := os.ReadFile(filePath)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
shaders = append(shaders, Shader{
|
||||
Package: pkgPath,
|
||||
File: filePath,
|
||||
Source: string(content),
|
||||
})
|
||||
return shaders, nil
|
||||
}
|
||||
|
||||
|
@ -82,7 +82,7 @@ func TestRun(t *testing.T) {
|
||||
})
|
||||
|
||||
if got, want := len(filteredShaders), 9; got != want {
|
||||
t.Fatalf("len(shaders): got: %d, want: %d", got, want)
|
||||
t.Errorf("len(shaders): got: %d, want: %d", got, want)
|
||||
}
|
||||
|
||||
for i, s := range filteredShaders {
|
||||
|
@ -15,8 +15,6 @@
|
||||
package shaderlistertest
|
||||
|
||||
import (
|
||||
"embed"
|
||||
|
||||
"github.com/hajimehoshi/ebiten/v2/internal/shaderlister/shaderlistertest2"
|
||||
)
|
||||
|
||||
@ -71,8 +69,7 @@ const (
|
||||
_, _ = "ignored", "ignored again" // multiple consts are ignored to avoid confusion.
|
||||
)
|
||||
|
||||
//go:embed *kage.go
|
||||
var embed_go embed.FS
|
||||
//ebitengine:shaderfile *_kage.go
|
||||
//ebitengine:shaderfile resource
|
||||
|
||||
//go:embed resource
|
||||
var embed2_go embed.FS
|
||||
//ebitengine:shaderfile nonexistent.go
|
||||
|
@ -14,8 +14,6 @@
|
||||
|
||||
//go:build ignore
|
||||
|
||||
//ebitengine:embeddedshader
|
||||
|
||||
package main
|
||||
|
||||
// shader 8
|
@ -14,8 +14,6 @@
|
||||
|
||||
//go:build ignore
|
||||
|
||||
//ebitengine:embeddedshader
|
||||
|
||||
package main
|
||||
|
||||
// shader 7
|
@ -14,8 +14,6 @@
|
||||
|
||||
//go:build ignore
|
||||
|
||||
// This file lacks the directive `ebitengine:embeddedshader`, so this is not considered as a shader file by shaderlister.
|
||||
|
||||
package main
|
||||
|
||||
// shader 0
|
@ -14,8 +14,6 @@
|
||||
|
||||
//go:build ignore
|
||||
|
||||
//ebitengine:embeddedshader
|
||||
|
||||
package main
|
||||
|
||||
// shader 9
|
@ -1,21 +0,0 @@
|
||||
// Copyright 2025 The Ebitengine 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
|
||||
//
|
||||
// http://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:build ignore
|
||||
|
||||
// This file lacks the directive `ebitengine:embeddedshader`, so this is not considered as a shader file by shaderlister.
|
||||
|
||||
package main
|
||||
|
||||
// shader 0
|
Loading…
Reference in New Issue
Block a user