parser

Documentation

Overview

Package parser implements a participle parser for the TSCN file format

Index

• Constants
• type GdField
• type GdMapField
  • func (kv *GdMapField) ToString() string
• type GdResource
  • func (res *GdResource) GetAttribute(name string) (*GdValue, error)
  • func (res *GdResource) GetField(name string) (*GdValue, error)
• type GdType
• type GdValue
  • func (v *GdValue) Raw() interface{}
  • func (v *GdValue) ToString() string
• type TscnFile
  • func Parse(r io.Reader) (*TscnFile, error)
  • func (tscn *TscnFile) GetAttribute(name string) (*GdValue, error)

Constants

const (
	ResourceTypeExtResource = "ext_resource"
	ResourceTypeSubResource = "sub_resource"
	ResourceTypeEditable    = "editable"
	ResourceTypeConnection  = "connection"
	ResourceTypeNode        = "node"
	ResourceTypeResource    = "resource"
)

Supported resource types

Types

type GdField

type GdField struct {
	Key   string   `parser:"@Ident '='"`
	Value *GdValue `parser:" @@"`
	Pos   lexer.Position
}

GdField represents a field with a value

type GdMapField

type GdMapField struct {
	Key   string   `parser:"@String ':'"`
	Value *GdValue `parser:" @@"`
	Pos   lexer.Position
}

GdMapField represents a field with a value within a map

func (*GdMapField) ToString

func (kv *GdMapField) ToString() string

ToString returns a string representation of a GdMapField

type GdResource

type GdResource struct {
	ResourceType string     `parser:"'[' @Ident "`
	Attributes   []*GdField `parser:"@@* ']'"`
	Fields       []*GdField `parser:"@@*"`
	Pos          lexer.Position
}

GdResource represents a resource within a TSCN file

func (*GdResource) GetAttribute

func (res *GdResource) GetAttribute(name string) (*GdValue, error)

GetAttribute finds an attribute by name, returns error if not found

func (*GdResource) GetField

func (res *GdResource) GetField(name string) (*GdValue, error)

GetField finds an attribute by name, returns error if not found

type GdType

type GdType struct {
	Key        string     `parser:" @Ident ('('"`
	Parameters []*GdValue `parser:"(@@ ( ',' @@ )* )? ')')?"`
	Pos        lexer.Position
}

GdType represents a type with values

type GdValue

type GdValue struct {
	IsEmptyMap   *bool         `parser:" (@'{' '}')"`
	Map          []*GdMapField `parser:"| '{' ( @@ ( ',' @@ )* )? '}'"`
	KeyValuePair *GdMapField   `parser:"| @@"`
	IsEmptyArray *bool         `parser:"| (@'[' ']')"`
	Array        []*GdValue    `parser:"| '[' ( @@ ( ',' @@ )* )? (',')? ']'"`
	String       *string       `parser:"| @String"`
	Integer      *int64        `parser:"| @Int"`
	Float        *float64      `parser:"| @Float"`
	Bool         *bool         `parser:"| (@'true' | 'false')"`
	Null         *bool         `parser:"| (@'null')"`
	Type         *GdType       `parser:"| @@"`
	Pos          lexer.Position
}

GdValue represents a value

func (*GdValue) Raw

func (v *GdValue) Raw() interface{}

Raw returns an interface{} which contains the actual value of the associated GdValue

func (*GdValue) ToString

func (v *GdValue) ToString() string

ToString returns a string representation of the associated GdValue

type TscnFile

type TscnFile struct {
	Key        string        `parser:"('[' @Ident"`
	Attributes []*GdField    `parser:"@@* ']')?"`
	Fields     []*GdField    `parser:"@@*"`
	Sections   []*GdResource `parser:"@@*"`
	Pos        lexer.Position
}

TscnFile represents a .tscn file

func Parse

func Parse(r io.Reader) (*TscnFile, error)

Parse content and return a simple representation of the file format.

func (*TscnFile) GetAttribute

func (tscn *TscnFile) GetAttribute(name string) (*GdValue, error)

GetAttribute finds an attribute by name, returns error if not found