parser

package
v1.3.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 29, 2025 License: Apache-2.0 Imports: 15 Imported by: 8

Documentation

Index

Constants

View Source 
const (
	KeywordIf          = "if"
	KeywordElse        = "else"
	KeywordWhile       = "while"
	KeywordBreak       = "break"
	KeywordContinue    = "continue"
	KeywordReturn      = "return"
	KeywordTrue        = "true"
	KeywordFalse       = "false"
	KeywordNil         = "nil"
	KeywordLet         = "let"
	KeywordVar         = "var"
	KeywordFun         = "fun"
	KeywordAs          = "as"
	KeywordCreate      = "create"
	KeywordDestroy     = "destroy"
	KeywordFor         = "for"
	KeywordIn          = "in"
	KeywordEmit        = "emit"
	KeywordAuth        = "auth"
	KeywordAccess      = "access"
	KeywordAll         = "all"
	KeywordSelf        = "self"
	KeywordInit        = "init"
	KeywordContract    = "contract"
	KeywordAccount     = "account"
	KeywordImport      = "import"
	KeywordFrom        = "from"
	KeywordPre         = "pre"
	KeywordPost        = "post"
	KeywordEvent       = "event"
	KeywordStruct      = "struct"
	KeywordResource    = "resource"
	KeywordInterface   = "interface"
	KeywordEntitlement = "entitlement"
	KeywordMapping     = "mapping"
	KeywordTransaction = "transaction"
	KeywordPrepare     = "prepare"
	KeywordExecute     = "execute"
	KeywordCase        = "case"
	KeywordSwitch      = "switch"
	KeywordDefault     = "default"
	KeywordEnum        = "enum"
	KeywordView        = "view"
	KeywordAttachment  = "attachment"
	KeywordAttach      = "attach"
	KeywordRemove      = "remove"
	KeywordTo          = "to"
	KeywordRequire     = "require"
	KeywordStatic      = "static"
	KeywordNative      = "native"
	KeywordPub         = "pub"
	KeywordPriv        = "priv"
	KeywordInclude     = "include"
	KeywordTry         = "try"
	KeywordCatch       = "catch"
	KeywordFinally     = "finally"
	KeywordGoto        = "goto"
	KeywordConst       = "const"
	KeywordExport      = "export"
	KeywordThrow       = "throw"
	KeywordThrows      = "throws"
	KeywordRequires    = "requires"
	KeywordWhere       = "where"
	KeywordFinal       = "final"
	KeywordInternal    = "internal"
	KeywordTypealias   = "typealias"
	KeywordType        = "type"
	KeywordRepeat      = "repeat"
	KeywordGuard       = "guard"
	KeywordIs          = "is"
)

NOTE: ensure to update allKeywords when adding a new keyword

Variables

View Source 
var HardKeywords = filter(
	allKeywords,
	func(keyword string) bool {
		_, ok := softKeywordsTable.Lookup(keyword)
		return !ok
	},
)

HardKeywords are restricted from being used as identifiers in certain places. i.e: places where ambiguity can exist, such as composite declaration names, function names, etc. However, they are not restricted to be used as fields names, and many other places.

View Source 
var SoftKeywords = []string{
	KeywordFrom,
	KeywordAccount,
	KeywordAll,
	KeywordView,
	KeywordAttach,
	KeywordRemove,
	KeywordTo,
	KeywordType,
}

SoftKeywords are keywords that can be used as identifiers anywhere, without any restriction or ambiguity.

Functions

func IsHardKeyword 

func IsHardKeyword(identifier string) bool

func Parse 

func Parse[T any](
	memoryGauge common.MemoryGauge,
	input []byte,
	parse func(*parser) (T, error),
	config Config,
) (result T, errors []error)

Parse creates a lexer to scan the given input string, and uses the given `parse` function to parse tokens into a result.

It can be composed with different parse functions to parse the input string into different results. See "ParseExpression", "ParseStatements" as examples.

func ParseArgumentList 

func ParseArgumentList(
	memoryGauge common.MemoryGauge,
	input []byte,
	config Config,
) (
	arguments ast.Arguments,
	errs []error,
)

func ParseDeclarations 

func ParseDeclarations(
	memoryGauge common.MemoryGauge,
	input []byte,
	config Config,
) (
	declarations []ast.Declaration,
	errs []error,
)

func ParseDocstringPragmaArguments 

func ParseDocstringPragmaArguments(docString string) []string

ParseDocstringPragmaArguments parses the docstring and returns the values of all pragma arguments declarations.

A pragma arguments declaration has the form `pragma arguments <argument-list>`, where <argument-list> is a Cadence argument list.

The validity of the argument list is NOT checked by this function.

func ParseDocstringPragmaSigners 

func ParseDocstringPragmaSigners(docString string) []string

ParseDocstringPragmaSigners parses the docstring and returns the values of all pragma signers declarations.

A pragma signers declaration has the form `pragma signers <signers-list>`, where <signers-list> is a list of strings.

The validity of the argument list is NOT checked by this function.

func ParseExpression 

func ParseExpression(
	memoryGauge common.MemoryGauge,
	input []byte,
	config Config,
) (
	expression ast.Expression,
	errs []error,
)

func ParseProgram 

func ParseProgram(memoryGauge common.MemoryGauge, code []byte, config Config) (program *ast.Program, err error)

func ParseProgramFromFile 

func ParseProgramFromFile(
	memoryGauge common.MemoryGauge,
	filename string,
	config Config,
) (
	program *ast.Program,
	code []byte,
	err error,
)

func ParseProgramFromTokenStream 

func ParseProgramFromTokenStream(
	memoryGauge common.MemoryGauge,
	input lexer.TokenStream,
	config Config,
) (
	program *ast.Program,
	err error,
)

func ParseStatements 

func ParseStatements(
	memoryGauge common.MemoryGauge,
	input []byte,
	config Config,
) (
	statements []ast.Statement,
	errs []error,
)

func ParseStatementsFromTokenStream 

func ParseStatementsFromTokenStream(
	memoryGauge common.MemoryGauge,
	tokens lexer.TokenStream,
	config Config,
) (
	statements []ast.Statement,
	errs []error,
)

func ParseTokenStream 

func ParseTokenStream[T any](
	memoryGauge common.MemoryGauge,
	tokens lexer.TokenStream,
	parse func(*parser) (T, error),
	config Config,
) (
	result T,
	errs []error,
)

func ParseType 

func ParseType(memoryGauge common.MemoryGauge, input []byte, config Config) (ty ast.Type, errs []error)

Types

type Config 

type Config struct {
	// StaticModifierEnabled determines if the static modifier is enabled
	StaticModifierEnabled bool
	// NativeModifierEnabled determines if the native modifier is enabled
	NativeModifierEnabled bool
	// Deprecated: IgnoreLeadingIdentifierEnabled determines
	// if leading identifiers are ignored.
	//
	// Pre-Stable Cadence, identifiers preceding keywords were (incorrectly) ignored,
	// instead of being reported as invalid, e.g. `foo let bar: Int` was valid.
	// The new default behaviour is to report an error, e.g. for `foo` in the example above.
	//
	// This option exists so the old behaviour can be enabled to allow developers to update their code.
	IgnoreLeadingIdentifierEnabled bool
	// TypeParametersEnabled determines if type parameters are enabled
	TypeParametersEnabled bool
}

type CustomDestructorError 

type CustomDestructorError struct {
	Pos ast.Position
}

func (*CustomDestructorError) EndPosition 

func (e *CustomDestructorError) EndPosition(_ common.MemoryGauge) ast.Position

func (*CustomDestructorError) Error 

func (e *CustomDestructorError) Error() string

func (*CustomDestructorError) IsUserError 

func (*CustomDestructorError) IsUserError()

func (*CustomDestructorError) SecondaryError 

func (e *CustomDestructorError) SecondaryError() string

func (*CustomDestructorError) StartPosition 

func (e *CustomDestructorError) StartPosition() ast.Position

type Error 

type Error struct {
	Code   []byte
	Errors []error
}

func (Error) ChildErrors 

func (e Error) ChildErrors() []error

func (Error) Error 

func (e Error) Error() string

func (Error) Unwrap 

func (e Error) Unwrap() []error

type ExpressionDepthLimitReachedError 

type ExpressionDepthLimitReachedError struct {
	Pos ast.Position
}

ExpressionDepthLimitReachedError is reported when the expression depth limit was reached

func (ExpressionDepthLimitReachedError) EndPosition 

func (e ExpressionDepthLimitReachedError) EndPosition(_ common.MemoryGauge) ast.Position

func (ExpressionDepthLimitReachedError) Error 

func (e ExpressionDepthLimitReachedError) Error() string

func (ExpressionDepthLimitReachedError) IsUserError 

func (ExpressionDepthLimitReachedError) IsUserError()

func (ExpressionDepthLimitReachedError) StartPosition 

func (e ExpressionDepthLimitReachedError) StartPosition() ast.Position

type InvalidIntegerLiteralError 

type InvalidIntegerLiteralError struct {
	Literal                   string
	IntegerLiteralKind        common.IntegerLiteralKind
	InvalidIntegerLiteralKind InvalidNumberLiteralKind
	ast.Range
}

func (*InvalidIntegerLiteralError) Error 

func (e *InvalidIntegerLiteralError) Error() string

func (*InvalidIntegerLiteralError) IsUserError 

func (*InvalidIntegerLiteralError) IsUserError()

func (*InvalidIntegerLiteralError) SecondaryError 

func (e *InvalidIntegerLiteralError) SecondaryError() string

type InvalidNumberLiteralKind 

type InvalidNumberLiteralKind uint
const (
	InvalidNumberLiteralKindUnknown InvalidNumberLiteralKind = iota
	InvalidNumberLiteralKindLeadingUnderscore
	InvalidNumberLiteralKindTrailingUnderscore
	InvalidNumberLiteralKindUnknownPrefix
	InvalidNumberLiteralKindMissingDigits
)

func (InvalidNumberLiteralKind) Description 

func (k InvalidNumberLiteralKind) Description() string

func (InvalidNumberLiteralKind) String 

func (i InvalidNumberLiteralKind) String() string

type JuxtaposedUnaryOperatorsError 

type JuxtaposedUnaryOperatorsError struct {
	Pos ast.Position
}

func (*JuxtaposedUnaryOperatorsError) EndPosition 

func (e *JuxtaposedUnaryOperatorsError) EndPosition(_ common.MemoryGauge) ast.Position

func (*JuxtaposedUnaryOperatorsError) Error 

func (e *JuxtaposedUnaryOperatorsError) Error() string

func (*JuxtaposedUnaryOperatorsError) IsUserError 

func (*JuxtaposedUnaryOperatorsError) IsUserError()

func (*JuxtaposedUnaryOperatorsError) StartPosition 

func (e *JuxtaposedUnaryOperatorsError) StartPosition() ast.Position

type MissingCommaInParameterListError 

type MissingCommaInParameterListError struct {
	Pos ast.Position
}

func (*MissingCommaInParameterListError) EndPosition 

func (e *MissingCommaInParameterListError) EndPosition(_ common.MemoryGauge) ast.Position

func (*MissingCommaInParameterListError) Error 

func (e *MissingCommaInParameterListError) Error() string

func (*MissingCommaInParameterListError) IsUserError 

func (*MissingCommaInParameterListError) IsUserError()

func (*MissingCommaInParameterListError) StartPosition 

func (e *MissingCommaInParameterListError) StartPosition() ast.Position

type ParseError 

type ParseError interface {
	errors.UserError
	ast.HasPosition
	// contains filtered or unexported methods
}

type RestrictedTypeError 

type RestrictedTypeError struct {
	ast.Range
}

func (*RestrictedTypeError) Error 

func (e *RestrictedTypeError) Error() string

func (*RestrictedTypeError) IsUserError 

func (*RestrictedTypeError) IsUserError()

type SyntaxError 

type SyntaxError struct {
	Message string
	Pos     ast.Position
}

func NewSyntaxError 

func NewSyntaxError(pos ast.Position, message string, params ...any) *SyntaxError

func (*SyntaxError) EndPosition 

func (e *SyntaxError) EndPosition(_ common.MemoryGauge) ast.Position

func (*SyntaxError) Error 

func (e *SyntaxError) Error() string

func (*SyntaxError) IsUserError 

func (*SyntaxError) IsUserError()

func (*SyntaxError) StartPosition 

func (e *SyntaxError) StartPosition() ast.Position

type SyntaxErrorWithSuggestedReplacement 

type SyntaxErrorWithSuggestedReplacement struct {
	Message      string
	SuggestedFix string
	ast.Range
}

func NewSyntaxErrorWithSuggestedReplacement 

func NewSyntaxErrorWithSuggestedReplacement(r ast.Range, message string, suggestedFix string) *SyntaxErrorWithSuggestedReplacement

func (*SyntaxErrorWithSuggestedReplacement) Error 

func (e *SyntaxErrorWithSuggestedReplacement) Error() string

func (*SyntaxErrorWithSuggestedReplacement) IsUserError 

func (*SyntaxErrorWithSuggestedReplacement) IsUserError()

func (*SyntaxErrorWithSuggestedReplacement) SuggestFixes 

func (e *SyntaxErrorWithSuggestedReplacement) SuggestFixes(_ string) []errors.SuggestedFix[ast.TextEdit]

type TypeDepthLimitReachedError 

type TypeDepthLimitReachedError struct {
	Pos ast.Position
}

func (TypeDepthLimitReachedError) EndPosition 

func (e TypeDepthLimitReachedError) EndPosition(_ common.MemoryGauge) ast.Position

func (TypeDepthLimitReachedError) Error 

func (e TypeDepthLimitReachedError) Error() string

func (TypeDepthLimitReachedError) IsUserError 

func (TypeDepthLimitReachedError) IsUserError()

func (TypeDepthLimitReachedError) StartPosition 

func (e TypeDepthLimitReachedError) StartPosition() ast.Position

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.