package
0.0.0-20241223201216-b2272ab2b612
Repository: https://github.com/susmdt/gscript.git
Documentation: pkg.go.dev
# Packages
Package computil Code generated by go-bindata.
No description provided by the author
No description provided by the author
# Functions
ExampleDecodeEmbed is a reference implementation of how embedded assets should be unpacked inside of a genesis engine.
GetDefaultImportNamespace returns the corrasponding namespace to the import path provided that is used in the intermediate representation.
IsBuiltInGoType takes a string argument and determines if is a valid built-in type in golang.
IsDefaultImport tests a golang import path to determine if it is already defined in the intermediate representation.
New returns a new compiler object.
NewEmbeddedFile takes a path on the local file system and returns an EmbeddedFile object reference.
NewGenesisVM creates a new virtual machine object for the compiler.
NewGoPackage is a constructor for a gopackage that will be used in dynamically linking native code.
NewGoParamDef creates a new definition object for a go parameter (either return or argument) and returns a pointer to itself.
NewLinker creates a new linker for the given genesis VM.
NewMaskedImport creates a new import mask based on an import path and old alias.
ScanForMacros takes the genesis comments from the AST and parses known macros out for the compiler.
# Variables
CallablesByEngineVersion is a table that maps the entry points to the expected script versions.
DefaultPriority is the default value for a script's priority during execution.
DefaultTimeout is the default time in seconds a script will be allowed to run.
NamespaceConversionMap is a temporary mapping to allow genesis scripts written in the v0 specification to be backwards compatible with v1 scripts.
# Structs
Compiler is the primary type for building native binaries with gscript.
EmbeddedFile is an object that manages the lifecycle of resolving and translating embedded assets referenced in the Genesis VM into callable values that are embedded by the compiler.
FunctionCall contains information relating to a Golang native function call that is being used within a genesis vm.
GenesisVM is the object representation of a genesis script including it's imports and dynamic linking targets.
GoConst defines the name of a golang constant declaration.
GoPackage holds all the information about a Golang package that is being resolved to a given script.
GoParamDef defines a type to represent parameters found in a Golang function declaration (arguments or return types).
GoStructDef defines a struct type definition to be used within the genesis engine.
GoVar defines a top level var declaration within a Golang package.
LegacyArgDef is used by LegacyFunctionCall objects to create mappings for legacy function argument's for the linker to inject into the build.
LegacyFunctionCall uses the old generator to represent v0 standard library functions so they can be deprecated in subsequent versions without forcing users to convert all v0 scripts to v1 at this time.
LegacyLibrary defines one of the original standard library golang packages for backward compatibility during linking to associate global namespace function calls with the v1 package style.
LegacyRetDef is used by LegacyFunctionCall objects to create mappings for legacy return values for the linker to inject into the build.
LinkedFunction is the type that represents the gscript <=> golang native binding so proper interfaces can be generated at compile time for calling native go from the genesis VM.
Linker holds the maps between functions called from the genesis script and their associated golang equivalent, including package references.
Macro defines the object created by each macro parsed by the preprocessor.
MaskedImport is used to separate import namespaces within the intermediate representation.