modfile

type Class ¶ added in v0.10.0

type Class struct {
	Ext      string // can be "_[class].gox" or ".[class]", eg. "_yap.gox" or ".spx"
	FullExt  string // can be "*_[class].gox", "_[class].gox", "*.[class]" or ".[class]"
	Class    string // "Sprite"
	Proto    string // prototype of the work class (not empty if multiple work classes)
	Prefix   string // prefix of the work class
	Embedded bool   // if true, the class instance will be embedded in the project
	Syntax   *Line
}

A Class is the work class statement.

type Comment ¶

type Comment = modfile.Comment

A Comment represents a single // comment.

type CommentBlock ¶

type CommentBlock = modfile.CommentBlock

A CommentBlock represents a top-level block of comments separate from any rule.

type Comments ¶

type Comments = modfile.Comments

Comments collects the comments associated with an expression.

type Compiler ¶ added in v0.13.12

type Compiler struct {
	Name    string
	Version string
}

type Error ¶

type Error modfile.Error

func (p *Error) Error() string

func (p *Error) Summary() string

func (p *Error) Unwrap() error

type ErrorList ¶

type ErrorList = errors.List

type Expr ¶

type Expr = modfile.Expr

An Expr represents an input element.

type File ¶

type File struct {
	XGo       *XGo
	Compiler  *Compiler // the underlying go compiler in go.mod (not gox.mod)
	Projects  []*Project
	ClassMods []string // calc by require statements in go.mod (not gox.mod)

	Syntax *FileSyntax
}

A File is the parsed, interpreted form of a gox.mod file.

func New(goxmod, xgoVer string) *File

func Parse(file string, data []byte, fix VersionFixer) (*File, error)

func ParseLax(file string, data []byte, fix VersionFixer) (*File, error)

type FileSyntax ¶

type FileSyntax = modfile.FileSyntax

A FileSyntax represents an entire gox.mod file.

type Import ¶ added in v0.11.1

type Import struct {
	Name   string // maybe empty
	Path   string
	Syntax *Line
}

A Import is the import statement.

type InvalidExtError ¶

type InvalidExtError struct {
	Ext string
	Err error
}

func (e *InvalidExtError) Error() string

func (e *InvalidExtError) Unwrap() error

type InvalidSymbolError ¶ added in v0.10.0

type InvalidSymbolError struct {
	Sym string
	Err error
}

func (e *InvalidSymbolError) Error() string

func (e *InvalidSymbolError) Unwrap() error

type LParen ¶

type LParen = modfile.LParen

An LParen represents the beginning of a parenthesized line block. It is a place to store suffix comments.

type Line ¶

type Line = modfile.Line

A Line is a single line of tokens.

type LineBlock ¶

type LineBlock = modfile.LineBlock

A LineBlock is a factored block of lines, like

require (
	"x"
	"y"
)

type Position ¶

type Position = modfile.Position

A Position describes an arbitrary source position in a file, including the file, line, column, and byte offset.

type Project ¶ added in v0.10.0

type Project struct {
	Ext      string    // can be "_[class].gox" or ".[class]", eg. "_yap.gox" or ".gmx"
	FullExt  string    // can be "main_[class].gox", "*_[class].gox", "_[class].gox", "main.[class]", "*.[class]" or ".[class]"
	Class    string    // "Game"
	Works    []*Class  // work class of classfile
	PkgPaths []string  // package paths of classfile and optional inline-imported packages.
	Import   []*Import // auto-imported packages
	Runner   *Runner   // custom runner
	Syntax   *Line
}

A Project is the project statement.

func (p *Project) IsProj(ext, fname string) bool

type RParen ¶

type RParen = modfile.RParen

An RParen represents the end of a parenthesized line block. It is a place to store whole-line (before) comments.

type Runner ¶ added in v0.18.0

type Runner struct {
	Path    string // package path of the runner
	Version string // optional version of the runner
	Syntax  *Line
}

A Runner is the runner statement that specifies a custom runner for the project. The runner directive must appear after a project statement and only one runner per project is allowed. Example: runner github.com/goplus/spx/v2/cmd/spxrun Example with version: runner github.com/goplus/spx/v2/cmd/spxrun v2.0.1

type VersionFixer ¶

type VersionFixer = modfile.VersionFixer

type XGo ¶ added in v0.17.0

type XGo = modfile.Go

A XGo is the xgo statement.