5
0
mirror of https://github.com/wailsapp/wails.git synced 2025-05-04 07:29:56 +08:00
wails/v3/internal/flags/bindings.go
Fabio Massaioli 37673eb24d
[v3] Fix binding generator bugs and prepare for Go 1.24 (#4045)
* Rename predicates source file

* Overhaul and document type predicates

* Fix model collection logic for named types

* Fix map key type rendering

* Fix map creation code

* Fix rendering of structs that implement marshaler interfaces

* Fix type cycle detection to take type args into account

* Fix enum and typeparam field initialisation

* Improve unsupported type warnings

* Remove internal models file

* Deduplicate template code

* Accept generic aliases in static analyser

* Support new `encoding/json` flag `omitzero`

* Handle special cases when rendering generic aliases

* Update npm test dependencies

* Test class aliases and implicit private dependencies

* Test marshaler combinations

* Test map key types

* Remove bad map keys from unrelated tests

* Test service discovery through generic aliases

* Test generic aliases

* Test warning messages

* Disable go1.24 tests

* Update changelog

* Restore rendering of injected lines in index file

* Test directives

* Add wails:ignore directive

* Fix typo

* Move injections to the bottom of service files

* Handle errors from closing files

* Do not emit messages when services define only lifecycle methods

* Add internal directive for services and models

* Update changelog

* Fix error in service templates

* Test internal directive on services/models

* Fix error in index template

* Base testdata updates

* Testdata for class aliases and implicit private dependencies

* Testdata for marshaler combinations

* Testdata for map key types

* Testdata for bad map key fixes

* Add weakly typed enums aka alias constants

* Testdata for enum and typeparam field fixes

* Testdata for generic aliases

* Testdata for warning messages

* Testdata for directives

* Testdata for weakly typed enums

* Update binding example

* Update services example

* Remove go1.24 testdata

* Update cli doc

* Fix analyser tests

* Fix windows tests... hopefully

* go mod tidy on examples

* Update bindings guide

---------

Co-authored-by: Lea Anthony <lea.anthony@gmail.com>
2025-02-09 09:44:34 +11:00

97 lines
3.4 KiB
Go

package flags
import (
"errors"
"slices"
"strings"
"unicode/utf8"
)
type GenerateBindingsOptions struct {
BuildFlagsString string `name:"f" description:"A list of additional space-separated Go build flags. Flags (or parts of them) can be wrapped in single or double quotes to include spaces"`
OutputDirectory string `name:"d" description:"The output directory" default:"frontend/bindings"`
ModelsFilename string `name:"models" description:"File name for exported JS/TS models (excluding the extension)" default:"models"`
IndexFilename string `name:"index" description:"File name for JS/TS package indexes (excluding the extension)" default:"index"`
TS bool `name:"ts" description:"Generate Typescript bindings"`
UseInterfaces bool `name:"i" description:"Generate Typescript interfaces instead of classes"`
UseBundledRuntime bool `name:"b" description:"Use the bundled runtime instead of importing the npm package"`
UseNames bool `name:"names" description:"Use names instead of IDs for the binding calls"`
NoIndex bool `name:"noindex" description:"Do not generate JS/TS index files"`
DryRun bool `name:"dry" description:"Do not write output files"`
Silent bool `name:"silent" description:"Silent mode"`
Verbose bool `name:"v" description:"Enable debug output"`
Clean bool `name:"clean" description:"Clean output directory before generation" default:"true"`
}
var ErrUnmatchedQuote = errors.New("build flags contain an unmatched quote")
func isWhitespace(r rune) bool {
// We use Go's definition of whitespace instead of the Unicode ones
return r == ' ' || r == '\t' || r == '\r' || r == '\n'
}
func isNonWhitespace(r rune) bool {
return !isWhitespace(r)
}
func isQuote(r rune) bool {
return r == '\'' || r == '"'
}
func isQuoteOrWhitespace(r rune) bool {
return isQuote(r) || isWhitespace(r)
}
func (options *GenerateBindingsOptions) BuildFlags() (flags []string, err error) {
str := options.BuildFlagsString
// temporary buffer for flag assembly
flag := make([]byte, 0, 32)
for start := strings.IndexFunc(str, isNonWhitespace); start >= 0; start = strings.IndexFunc(str, isNonWhitespace) {
// each iteration starts at the beginning of a flag
// skip initial whitespace
str = str[start:]
// iterate over all quoted and unquoted parts of the flag and join them
for {
breakpoint := strings.IndexFunc(str, isQuoteOrWhitespace)
if breakpoint < 0 {
breakpoint = len(str)
}
// append everything up to the breakpoint
flag = append(flag, str[:breakpoint]...)
str = str[breakpoint:]
quote, quoteSize := utf8.DecodeRuneInString(str)
if !isQuote(quote) {
// if the breakpoint is not a quote, we reached the end of the flag
break
}
// otherwise, look for the closing quote
str = str[quoteSize:]
closingQuote := strings.IndexRune(str, quote)
// closing quote not found, append everything to the last flag and raise an error
if closingQuote < 0 {
flag = append(flag, str...)
str = ""
err = ErrUnmatchedQuote
break
}
// closing quote found, append quoted content to the flag and restart after the quote
flag = append(flag, str[:closingQuote]...)
str = str[closingQuote+quoteSize:]
}
// append a clone of the flag to the result, then reuse buffer space
flags = append(flags, string(slices.Clone(flag)))
flag = flag[:0]
}
return
}