package js
import "github.com/tdewolff/parse/v2/js"
Package js is an ECMAScript5.1 lexer following the specifications at http://www.ecma-international.org/ecma-262/5.1/.
Index ¶
- Variables
- func AsDecimalLiteral(b []byte) bool
- func AsIdentifierName(b []byte) bool
- func IsIdentifier(tt TokenType) bool
- func IsIdentifierContinue(b []byte) bool
- func IsIdentifierEnd(b []byte) bool
- func IsIdentifierName(tt TokenType) bool
- func IsIdentifierStart(b []byte) bool
- func IsNumeric(tt TokenType) bool
- func IsOperator(tt TokenType) bool
- func IsPunctuator(tt TokenType) bool
- func IsReservedWord(tt TokenType) bool
- type AST
- type Alias
- type Args
- type ArrayExpr
- type ArrowFunc
- type BinaryExpr
- type BindingArray
- type BindingElement
- type BindingObject
- type BindingObjectItem
- type BlockStmt
- type BranchStmt
- type CallExpr
- type CaseClause
- type ClassDecl
- type CondExpr
- type DebuggerStmt
- type DeclType
- type DoWhileStmt
- type DotExpr
- type Element
- type EmptyStmt
- type ExportStmt
- type ExprStmt
- type ForInStmt
- type ForOfStmt
- type ForStmt
- type FuncDecl
- type GroupExpr
- type IBinding
- type IExpr
- type IStmt
- type IfStmt
- type ImportMetaExpr
- type ImportStmt
- type IndexExpr
- type LabelledStmt
- type Lexer
- func NewLexer(r *parse.Input) *Lexer
- func (l *Lexer) Err() error
- func (l *Lexer) Next() (TokenType, []byte)
- func (l *Lexer) RegExp() (TokenType, []byte)
- type LiteralExpr
- type MethodDecl
- type NewExpr
- type NewTargetExpr
- type ObjectExpr
- type OpPrec
- type OptChainExpr
- type Params
- type Parser
- type Property
- type PropertyName
- func (n PropertyName) IsComputed() bool
- func (n PropertyName) IsIdent(data []byte) bool
- func (n PropertyName) IsSet() bool
- func (n PropertyName) String() string
- type ReturnStmt
- type Scope
- func (s *Scope) Declare(decl DeclType, name []byte) (*Var, bool)
- func (s *Scope) HoistUndeclared()
- func (s *Scope) MarkArguments()
- func (s *Scope) MarkForInit()
- func (s Scope) String() string
- func (s *Scope) UndeclareScope()
- func (s *Scope) Use(name []byte) *Var
- type SwitchStmt
- type TemplateExpr
- type TemplatePart
- type ThrowStmt
- type TokenType
- type TryStmt
- type UnaryExpr
- type Var
- type VarArray
- type VarDecl
- type VarsByUses
- func (vs VarsByUses) Len() int
- func (vs VarsByUses) Less(i, j int) bool
- func (vs VarsByUses) Swap(i, j int)
- type WhileStmt
- type WithStmt
- type YieldExpr
Examples ¶
Variables ¶
var Keywords = map[string]TokenType{ "await": AwaitToken, "break": BreakToken, "case": CaseToken, "catch": CatchToken, "class": ClassToken, "const": ConstToken, "continue": ContinueToken, "debugger": DebuggerToken, "default": DefaultToken, "delete": DeleteToken, "do": DoToken, "else": ElseToken, "enum": EnumToken, "export": ExportToken, "extends": ExtendsToken, "false": FalseToken, "finally": FinallyToken, "for": ForToken, "function": FunctionToken, "if": IfToken, "import": ImportToken, "in": InToken, "instanceof": InstanceofToken, "new": NewToken, "null": NullToken, "return": ReturnToken, "super": SuperToken, "switch": SwitchToken, "this": ThisToken, "throw": ThrowToken, "true": TrueToken, "try": TryToken, "typeof": TypeofToken, "var": VarToken, "void": VoidToken, "while": WhileToken, "with": WithToken, "yield": YieldToken, "let": LetToken, "static": StaticToken, "implements": ImplementsToken, "interface": InterfaceToken, "package": PackageToken, "private": PrivateToken, "protected": ProtectedToken, "public": PublicToken, "as": AsToken, "async": AsyncToken, "from": FromToken, "get": GetToken, "meta": MetaToken, "of": OfToken, "set": SetToken, "target": TargetToken, }
Keywords is a map of reserved, strict, and other keywords
Functions ¶
func AsDecimalLiteral ¶
AsDecimalLiteral returns true if a valid decimal literal is given.
func AsIdentifierName ¶
AsIdentifierName returns true if a valid identifier name is given.
func IsIdentifier ¶
IsIdentifier matches Identifier, i.e. IdentifierName but not ReservedWord. Does not match yield or await.
func IsIdentifierContinue ¶
IsIdentifierContinue returns true if the byte-slice start is a continuation of an identifier
func IsIdentifierEnd ¶
IsIdentifierEnd returns true if the byte-slice end is a start or continuation of an identifier
func IsIdentifierName ¶
IsIdentifierName matches IdentifierName, i.e. any identifier
func IsIdentifierStart ¶
IsIdentifierStart returns true if the byte-slice start is the start of an identifier
func IsNumeric ¶
IsNumeric return true if token is numeric.
func IsOperator ¶
IsOperator return true if token is an operator.
func IsPunctuator ¶
IsPunctuator return true if token is a punctuator.
func IsReservedWord ¶
IsReservedWord matches ReservedWord
Types ¶
type AST ¶
AST is the full ECMAScript abstract syntax tree.
func Parse ¶
Parse returns a JS AST tree of.
func (*AST) String ¶
type Alias ¶
Alias is a name space import or import/export specifier for import/export statements.
func (Alias) String ¶
type Args ¶
Args is a list of arguments as used by new and call expressions.
func (Args) String ¶
type ArrayExpr ¶
type ArrayExpr struct { List []Element }
ArrayExpr is an array literal.
func (ArrayExpr) String ¶
type ArrowFunc ¶
ArrowFunc is an (async) arrow function.
func (ArrowFunc) String ¶
type BinaryExpr ¶
BinaryExpr is a binary expression.
func (BinaryExpr) String ¶
func (n BinaryExpr) String() string
type BindingArray ¶
type BindingArray struct { List []BindingElement Rest IBinding // can be nil }
BindingArray is an array binding pattern.
func (BindingArray) String ¶
func (n BindingArray) String() string
type BindingElement ¶
type BindingElement struct { Binding IBinding // can be nil (in case of ellision) Default IExpr // can be nil }
BindingElement is a binding element.
func (BindingElement) String ¶
func (n BindingElement) String() string
type BindingObject ¶
type BindingObject struct { List []BindingObjectItem Rest *Var // can be nil }
BindingObject is an object binding pattern.
func (BindingObject) String ¶
func (n BindingObject) String() string
type BindingObjectItem ¶
type BindingObjectItem struct { Key *PropertyName // can be nil Value BindingElement }
BindingObjectItem is a binding property.
type BlockStmt ¶
BlockStmt is a block statement.
func (BlockStmt) String ¶
type BranchStmt ¶
BranchStmt is a continue or break statement.
func (BranchStmt) String ¶
func (n BranchStmt) String() string
type CallExpr ¶
CallExpr is a call expression.
func (CallExpr) String ¶
type CaseClause ¶
CaseClause is a case clause or default clause for a switch statement.
type ClassDecl ¶
type ClassDecl struct { Name *Var // can be nil Extends IExpr // can be nil Methods []MethodDecl }
ClassDecl is a class declaration.
func (ClassDecl) String ¶
type CondExpr ¶
type CondExpr struct { Cond, X, Y IExpr }
CondExpr is a conditional expression.
func (CondExpr) String ¶
type DebuggerStmt ¶
type DebuggerStmt struct { }
DebuggerStmt is a debugger statement.
func (DebuggerStmt) String ¶
func (n DebuggerStmt) String() string
type DeclType ¶
type DeclType uint16
DeclType specifies the kind of declaration.
const ( NoDecl DeclType = iota // undeclared variables VariableDecl // var FunctionDecl // function LexicalDecl // let, const, class ArgumentDecl // function, method, and catch statement arguments ExprDecl // function expression name or class expression name )
DeclType values.
func (DeclType) String ¶
type DoWhileStmt ¶
DoWhileStmt is a do-while iteration statement.
func (DoWhileStmt) String ¶
func (n DoWhileStmt) String() string
type DotExpr ¶
type DotExpr struct { X IExpr Y LiteralExpr Prec OpPrec }
DotExpr is a member/call expression, super property, or optional chain with a dot expression.
func (DotExpr) String ¶
type Element ¶
Element is an array literal element.
type EmptyStmt ¶
type EmptyStmt struct { }
EmptyStmt is an empty statement.
func (EmptyStmt) String ¶
type ExportStmt ¶
ExportStmt is an export statement.
func (ExportStmt) String ¶
func (n ExportStmt) String() string
type ExprStmt ¶
type ExprStmt struct { Value IExpr }
ExprStmt is an expression statement.
func (ExprStmt) String ¶
type ForInStmt ¶
ForInStmt is a for-in iteration statement.
func (ForInStmt) String ¶
type ForOfStmt ¶
ForOfStmt is a for-of iteration statement.
func (ForOfStmt) String ¶
type ForStmt ¶
type ForStmt struct { Init IExpr // can be nil Cond IExpr // can be nil Post IExpr // can be nil Body BlockStmt }
ForStmt is a regular for iteration statement.
func (ForStmt) String ¶
type FuncDecl ¶
type FuncDecl struct { Async bool Generator bool Name *Var // can be nil Params Params Body BlockStmt }
FuncDecl is an (async) (generator) function declaration or expression.
func (FuncDecl) String ¶
type GroupExpr ¶
type GroupExpr struct { X IExpr }
GroupExpr is a parenthesized expression.
func (GroupExpr) String ¶
type IBinding ¶
type IBinding interface { String() string // contains filtered or unexported methods }
IBinding is a dummy interface for bindings.
type IExpr ¶
type IExpr interface { String() string // contains filtered or unexported methods }
IExpr is a dummy interface for expressions.
type IStmt ¶
type IStmt interface { String() string // contains filtered or unexported methods }
IStmt is a dummy interface for statements.
type IfStmt ¶
IfStmt is an if statement.
func (IfStmt) String ¶
type ImportMetaExpr ¶
type ImportMetaExpr struct { }
ImportMetaExpr is a import meta meta property.
func (ImportMetaExpr) String ¶
func (n ImportMetaExpr) String() string
type ImportStmt ¶
ImportStmt is an import statement.
func (ImportStmt) String ¶
func (n ImportStmt) String() string
type IndexExpr ¶
IndexExpr is a member/call expression, super property, or optional chain with an index expression.
func (IndexExpr) String ¶
type LabelledStmt ¶
LabelledStmt is a labelled statement.
func (LabelledStmt) String ¶
func (n LabelledStmt) String() string
type Lexer ¶
type Lexer struct {
// contains filtered or unexported fields
}
Lexer is the state for the lexer.
func NewLexer ¶
func NewLexer(r *parse.Input) *Lexer
NewLexer returns a new Lexer for a given io.Reader.
Code:
Output:Example¶
{
l := NewLexer(parse.NewInputString("var x = 'lorem ipsum';"))
out := ""
for {
tt, data := l.Next()
if tt == ErrorToken {
break
}
out += string(data)
}
fmt.Println(out)
// Output: var x = 'lorem ipsum';
}
var x = 'lorem ipsum';
func (*Lexer) Err ¶
Err returns the error encountered during lexing, this is often io.EOF but also other errors can be returned.
func (*Lexer) Next ¶
Next returns the next Token. It returns ErrorToken when an error was encountered. Using Err() one can retrieve the error message.
func (*Lexer) RegExp ¶
RegExp reparses the input stream for a regular expression. It is assumed that we just received DivToken or DivEqToken with Next(). This function will go back and read that as a regular expression.
type LiteralExpr ¶
LiteralExpr can be this, null, boolean, numeric, string, or regular expression literals.
func (LiteralExpr) String ¶
func (n LiteralExpr) String() string
type MethodDecl ¶
type MethodDecl struct { Static bool Async bool Generator bool Get bool Set bool Name PropertyName Params Params Body BlockStmt }
MethodDecl is a method definition in a class declaration.
func (MethodDecl) String ¶
func (n MethodDecl) String() string
type NewExpr ¶
NewExpr is a new expression or new member expression.
func (NewExpr) String ¶
type NewTargetExpr ¶
type NewTargetExpr struct { }
NewTargetExpr is a new target meta property.
func (NewTargetExpr) String ¶
func (n NewTargetExpr) String() string
type ObjectExpr ¶
type ObjectExpr struct { List []Property }
ObjectExpr is an object literal.
func (ObjectExpr) String ¶
func (n ObjectExpr) String() string
type OpPrec ¶
type OpPrec int
OpPrec is the operator precedence
const ( OpExpr OpPrec = iota // a,b OpAssign // a?b:c, yield x, ()=>x, async ()=>x, a=b, a+=b, ... OpCoalesce // a??b OpOr // a||b OpAnd // a&&b OpBitOr // a|b OpBitXor // a^b OpBitAnd // a&b OpEquals // a==b, a!=b, a===b, a!==b OpCompare // a<b, a>b, a<=b, a>=b, a instanceof b, a in b OpShift // a<<b, a>>b, a>>>b OpAdd // a+b, a-b OpMul // a*b, a/b, a%b OpExp // a**b OpUnary // ++x, --x, delete x, void x, typeof x, +x, -x, ~x, !x, await x OpUpdate // x++, x-- OpLHS // CallExpr/OptChainExpr or NewExpr OpCall // a?.b, a(b), super(a), import(a) OpNew // new a OpMember // a[b], a.b, a`b`, super[x], super.x, new.target, import.meta, new a(b) OpPrimary // literal, function, class, parenthesized )
OpPrec values.
func (OpPrec) String ¶
type OptChainExpr ¶
type OptChainExpr struct { X IExpr Y IExpr // can be CallExpr, IndexExpr, LiteralExpr, or TemplateExpr }
OptChainExpr is an optional chain.
func (OptChainExpr) String ¶
func (n OptChainExpr) String() string
type Params ¶
type Params struct { List []BindingElement Rest IBinding // can be nil }
Params is a list of parameters for functions, methods, and arrow function.
func (Params) String ¶
type Parser ¶
type Parser struct {
// contains filtered or unexported fields
}
Parser is the state for the parser.
type Property ¶
type Property struct { // either Name or Spread are set. When Spread is set then Value is AssignmentExpression // if Init is set then Value is IdentifierReference, otherwise it can also be MethodDefinition Name *PropertyName // can be nil Spread bool Value IExpr Init IExpr // can be nil }
Property is a property definition in an object literal.
func (Property) String ¶
type PropertyName ¶
type PropertyName struct { Literal LiteralExpr Computed IExpr // can be nil }
PropertyName is a property name for binding properties, method names, and in object literals.
func (PropertyName) IsComputed ¶
func (n PropertyName) IsComputed() bool
IsComputed returns true if PropertyName is computed.
func (PropertyName) IsIdent ¶
func (n PropertyName) IsIdent(data []byte) bool
IsIdent returns true if PropertyName equals the given identifier name.
func (PropertyName) IsSet ¶
func (n PropertyName) IsSet() bool
IsSet returns true is PropertyName is not nil.
func (PropertyName) String ¶
func (n PropertyName) String() string
type ReturnStmt ¶
type ReturnStmt struct { Value IExpr // can be nil }
ReturnStmt is a return statement.
func (ReturnStmt) String ¶
func (n ReturnStmt) String() string
type Scope ¶
type Scope struct { Parent, Func *Scope // Parent is nil for global scope, Parent equals Func for function scope Declared VarArray // Link in Var are always nil Undeclared VarArray NumVarDecls uint16 // number of variable declaration statements in a function scope NumForInit uint16 // offset into Declared to mark variables used in for initializer NumArguments uint16 // offset into Undeclared to mark variables used in arguments IsGlobalOrFunc bool HasWith bool }
Scope is a function or block scope with a list of variables declared and used.
func (*Scope) Declare ¶
Declare declares a new variable.
func (*Scope) HoistUndeclared ¶
func (s *Scope) HoistUndeclared()
HoistUndeclared copies all undeclared variables of the current scope to the parent scope.
func (*Scope) MarkArguments ¶
func (s *Scope) MarkArguments()
MarkArguments marks the undeclared variables in the current scope as function arguments. It ensures different b's in `function f(a=b){var b}`.
func (*Scope) MarkForInit ¶
func (s *Scope) MarkForInit()
MarkForInit marks the declared variables in current scope as for statement initializer to distinguish from declarations in body.
func (Scope) String ¶
func (*Scope) UndeclareScope ¶
func (s *Scope) UndeclareScope()
UndeclareScope undeclares all declared variables in the current scope and adds them to the parent scope. Called when possible arrow func ends up being a parenthesized expression, scope is not further used.
func (*Scope) Use ¶
Use increments the usage of a variable.
type SwitchStmt ¶
type SwitchStmt struct { Init IExpr List []CaseClause }
SwitchStmt is a switch statement.
func (SwitchStmt) String ¶
func (n SwitchStmt) String() string
type TemplateExpr ¶
type TemplateExpr struct { Tag IExpr // can be nil List []TemplatePart Tail []byte Prec OpPrec }
TemplateExpr is a template literal or member/call expression, super property, or optional chain with template literal.
func (TemplateExpr) String ¶
func (n TemplateExpr) String() string
type TemplatePart ¶
TemplatePart is a template head or middle.
type ThrowStmt ¶
type ThrowStmt struct { Value IExpr }
ThrowStmt is a throw statement.
func (ThrowStmt) String ¶
type TokenType ¶
type TokenType uint16 // from LSB to MSB: 8 bits for tokens per category, 1 bit for numeric, 1 bit for punctuator, 1 bit for operator, 1 bit for identifier, 4 bits unused
TokenType determines the type of token, eg. a number or a semicolon.
const ( ErrorToken TokenType = iota // extra token when errors occur WhitespaceToken LineTerminatorToken // \r \n \r\n CommentToken CommentLineTerminatorToken StringToken TemplateToken TemplateStartToken TemplateMiddleToken TemplateEndToken RegExpToken )
TokenType values.
const ( NumericToken TokenType = 0x0100 + iota DecimalToken BinaryToken OctalToken HexadecimalToken BigIntToken )
Numeric token values.
const ( PunctuatorToken TokenType = 0x0200 + iota OpenBraceToken // { CloseBraceToken // } OpenParenToken // ( CloseParenToken // ) OpenBracketToken // [ CloseBracketToken // ] DotToken // . SemicolonToken // ; CommaToken // , QuestionToken // ? ColonToken // : ArrowToken // => EllipsisToken // ... )
Punctuator token values.
const ( OperatorToken TokenType = 0x0600 + iota EqToken // = EqEqToken // == EqEqEqToken // === NotToken // ! NotEqToken // != NotEqEqToken // !== LtToken // < LtEqToken // <= LtLtToken // << LtLtEqToken // <<= GtToken // > GtEqToken // >= GtGtToken // >> GtGtEqToken // >>= GtGtGtToken // >>> GtGtGtEqToken // >>>= AddToken // + AddEqToken // += IncrToken // ++ SubToken // - SubEqToken // -= DecrToken // -- MulToken // * MulEqToken // *= ExpToken // ** ExpEqToken // **= DivToken // / DivEqToken // /= ModToken // % ModEqToken // %= BitAndToken // & BitOrToken // | BitXorToken // ^ BitNotToken // ~ BitAndEqToken // &= BitOrEqToken // |= BitXorEqToken // ^= AndToken // && OrToken // || NullishToken // ?? OptChainToken // ?. // unused in lexer PosToken // +a NegToken // -a PreIncrToken // ++a PreDecrToken // --a PostIncrToken // a++ PostDecrToken // a-- )
Operator token values.
const ( ReservedToken TokenType = 0x0800 + iota AwaitToken BreakToken CaseToken CatchToken ClassToken ConstToken ContinueToken DebuggerToken DefaultToken DeleteToken DoToken ElseToken EnumToken ExportToken ExtendsToken FalseToken FinallyToken ForToken FunctionToken IfToken ImportToken InToken InstanceofToken NewToken NullToken ReturnToken SuperToken SwitchToken ThisToken ThrowToken TrueToken TryToken TypeofToken YieldToken VarToken VoidToken WhileToken WithToken )
Reserved token values.
const ( IdentifierToken TokenType = 0x1000 + iota AsToken AsyncToken FromToken GetToken ImplementsToken InterfaceToken LetToken MetaToken OfToken PackageToken PrivateToken ProtectedToken PublicToken SetToken StaticToken TargetToken )
Identifier token values.
func (TokenType) Bytes ¶
Bytes returns the string representation of a TokenType.
func (TokenType) String ¶
type TryStmt ¶
type TryStmt struct { Body BlockStmt Binding IBinding // can be nil Catch *BlockStmt // can be nil Finally *BlockStmt // can be nil }
TryStmt is a try statement.
func (TryStmt) String ¶
type UnaryExpr ¶
UnaryExpr is an update or unary expression.
func (UnaryExpr) String ¶
type Var ¶
type Var struct { Data []byte Link *Var // is set when merging variable uses, as in: {a} {var a} where the first lins to the second Uses uint16 Decl DeclType }
Var is a variable, where Decl is the type of declaration and can be var|function for function scoped variables, let|const|class for block scoped variables.
func (*Var) Name ¶
Name returns the variable name.
func (*Var) String ¶
type VarArray ¶
type VarArray []*Var
VarArray is a set of variables in scopes.
func (VarArray) String ¶
type VarDecl ¶
type VarDecl struct { TokenType List []BindingElement }
VarDecl is a variable statement or lexical declaration.
func (VarDecl) String ¶
type VarsByUses ¶
type VarsByUses VarArray
VarsByUses is sortable by uses in descending order.
func (VarsByUses) Len ¶
func (vs VarsByUses) Len() int
func (VarsByUses) Less ¶
func (vs VarsByUses) Less(i, j int) bool
func (VarsByUses) Swap ¶
func (vs VarsByUses) Swap(i, j int)
type WhileStmt ¶
WhileStmt is a while iteration statement.
func (WhileStmt) String ¶
type WithStmt ¶
WithStmt is a with statement.
func (WithStmt) String ¶
type YieldExpr ¶
YieldExpr is a yield expression.
func (YieldExpr) String ¶
Source Files ¶
ast.go lex.go parse.go table.go tokentype.go util.go
- Version
- v2.5.7
- Published
- Dec 24, 2020
- Platform
- js/wasm
- Imports
- 9 packages
- Last checked
- 2 hours ago –
Tools for package owners.