Language.JavaScript.Parser

Documentation

parse

Arguments

:: String

The input stream (Javascript source code).

-> String

The name of the Javascript source (filename or input device).

-> Either String JSNode

An error or maybe the abstract syntax tree (AST) of zero or more Javascript statements, plus comments.

Parse one compound statement, or a sequence of simple statements. Generally used for interactive input, such as from the command line of an interpreter. Return comments in addition to the parsed statements.

readJs :: String -> JSNode

parseFile :: FilePath -> IO JSNode

Parse the given file. For UTF-8 support, make sure your locale is set such that "System.IO.localeEncoding" returns "utf8"

parseFileUtf8 :: FilePath -> IO JSNode

Parse the given file, explicitly setting the encoding to UTF8 when reading it

showStripped :: JSNode -> String

showStrippedMaybe :: Show a => Either a JSNode -> String

data JSNode

The JSNode is the building block of the AST. Each has a syntactic part Node. In addition, the leaf elements (terminals) have a position TokenPosn, as well as an array of comments and/or whitespace that was collected while parsing.

Constructors

NN Node

Non Terminal node, does not have any position or comment information

NT Node TokenPosn [CommentAnnotation]

Terminal node, including position and comment/whitespace information

Instances

Eq JSNode

Methods

(==) :: JSNode -> JSNode -> Bool

(/=) :: JSNode -> JSNode -> Bool

Data JSNode

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> JSNode -> c JSNode

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c JSNode

toConstr :: JSNode -> Constr

dataTypeOf :: JSNode -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c JSNode)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c JSNode)

gmapT :: (forall b. Data b => b -> b) -> JSNode -> JSNode

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> JSNode -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> JSNode -> r

gmapQ :: (forall d. Data d => d -> u) -> JSNode -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> JSNode -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> JSNode -> m JSNode

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> JSNode -> m JSNode

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> JSNode -> m JSNode

Read JSNode

Methods

readsPrec :: Int -> ReadS JSNode

readList :: ReadS [JSNode]

readPrec :: ReadPrec JSNode

readListPrec :: ReadPrec [JSNode]

Show JSNode

Methods

showsPrec :: Int -> JSNode -> ShowS

show :: JSNode -> String

showList :: [JSNode] -> ShowS

data Node

Constructors

JSIdentifier String

Terminals

JSDecimal String

JSLiteral String

JSHexInteger String

JSOctal String

JSStringLiteral Char [Char]

JSRegEx String

JSArguments JSNode [JSNode] JSNode

lb, args, rb

JSArrayLiteral JSNode [JSNode] JSNode

lb, contents, rb

JSBlock [JSNode] [JSNode] [JSNode]

optional lb,optional block statements,optional rb

JSBreak JSNode [JSNode] JSNode

break, optional identifier, autosemi

JSCallExpression String [JSNode] [JSNode] [JSNode]

type : ., (), []; opening [ or ., contents, closing

JSCase JSNode JSNode JSNode [JSNode]

case,expr,colon,stmtlist

JSCatch JSNode JSNode JSNode [JSNode] JSNode JSNode

catch,lb,ident,[if,expr],rb,block

JSContinue JSNode [JSNode] JSNode

continue,optional identifier,autosemi

JSDefault JSNode JSNode [JSNode]

default,colon,stmtlist

JSDoWhile JSNode JSNode JSNode JSNode JSNode JSNode JSNode

do,stmt,while,lb,expr,rb,autosemi

JSElision JSNode

comma

JSExpression [JSNode]

expression components

JSExpressionBinary String [JSNode] JSNode [JSNode]

what, lhs, op, rhs

JSExpressionParen JSNode JSNode JSNode

lb,expression,rb

JSExpressionPostfix String [JSNode] JSNode

type, expression, operator

JSExpressionTernary [JSNode] JSNode [JSNode] JSNode [JSNode]

cond, ?, trueval, :, falseval

JSFinally JSNode JSNode

finally,block

JSFor JSNode JSNode [JSNode] JSNode [JSNode] JSNode [JSNode] JSNode JSNode

for,lb,expr,semi,expr,semi,expr,rb.stmt

JSForIn JSNode JSNode [JSNode] JSNode JSNode JSNode JSNode

for,lb,expr,in,expr,rb,stmt

JSForVar JSNode JSNode JSNode [JSNode] JSNode [JSNode] JSNode [JSNode] JSNode JSNode

for,lb,var,vardecl,semi,expr,semi,expr,rb,stmt

JSForVarIn JSNode JSNode JSNode JSNode JSNode JSNode JSNode JSNode

for,lb,var,vardecl,in,expr,rb,stmt

JSFunction JSNode JSNode JSNode [JSNode] JSNode JSNode

fn,name, lb,parameter list,rb,block | JSFunctionBody [JSNode] -- ^body

JSFunctionExpression JSNode [JSNode] JSNode [JSNode] JSNode JSNode

fn,[name],lb, parameter list,rb,block`

JSIf JSNode JSNode JSNode JSNode [JSNode] [JSNode]

if,(,expr,),stmt,optional rest

JSLabelled JSNode JSNode JSNode

identifier,colon,stmt

JSMemberDot [JSNode] JSNode JSNode

firstpart, dot, name

JSMemberSquare [JSNode] JSNode JSNode JSNode

firstpart, lb, expr, rb

JSObjectLiteral JSNode [JSNode] JSNode

lbrace contents rbrace

JSOperator JSNode

opnode

JSPropertyAccessor JSNode JSNode JSNode [JSNode] JSNode JSNode

(get|set), name, lb, params, rb, block

JSPropertyNameandValue JSNode JSNode [JSNode]

name, colon, value

JSReturn JSNode [JSNode] JSNode

return,optional expression,autosemi | JSSourceElements [JSNode] -- ^source elements

JSSourceElementsTop [JSNode]

source elements | JSStatementBlock JSNode JSNode JSNode -- ^lb,block,rb | JSStatementList [JSNode] -- ^statements

JSSwitch JSNode JSNode JSNode JSNode JSNode

switch,lb,expr,rb,caseblock

JSThrow JSNode JSNode

throw val

JSTry JSNode JSNode [JSNode]

try,block,rest

JSUnary String JSNode

type, operator

JSVarDecl JSNode [JSNode]

identifier, optional initializer

JSVariables JSNode [JSNode] JSNode

var|const, decl, autosemi

JSWhile JSNode JSNode JSNode JSNode JSNode

while,lb,expr,rb,stmt

JSWith JSNode JSNode JSNode JSNode [JSNode]

with,lb,expr,rb,stmt list

Instances

Eq Node

Methods

(==) :: Node -> Node -> Bool

(/=) :: Node -> Node -> Bool

Data Node

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Node -> c Node

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Node

toConstr :: Node -> Constr

dataTypeOf :: Node -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c Node)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Node)

gmapT :: (forall b. Data b => b -> b) -> Node -> Node

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Node -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Node -> r

gmapQ :: (forall d. Data d => d -> u) -> Node -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Node -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Node -> m Node

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Node -> m Node

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Node -> m Node

Read Node

Methods

readsPrec :: Int -> ReadS Node

readList :: ReadS [Node]

readPrec :: ReadPrec Node

readListPrec :: ReadPrec [Node]

Show Node

Methods

showsPrec :: Int -> Node -> ShowS

show :: Node -> String

showList :: [Node] -> ShowS

data CommentAnnotation

Constructors

CommentA TokenPosn String

WhiteSpace TokenPosn String

NoComment

Instances

Eq CommentAnnotation

Methods

(==) :: CommentAnnotation -> CommentAnnotation -> Bool

(/=) :: CommentAnnotation -> CommentAnnotation -> Bool

Data CommentAnnotation

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CommentAnnotation -> c CommentAnnotation

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CommentAnnotation

toConstr :: CommentAnnotation -> Constr

dataTypeOf :: CommentAnnotation -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c CommentAnnotation)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CommentAnnotation)

gmapT :: (forall b. Data b => b -> b) -> CommentAnnotation -> CommentAnnotation

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CommentAnnotation -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CommentAnnotation -> r

gmapQ :: (forall d. Data d => d -> u) -> CommentAnnotation -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> CommentAnnotation -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> CommentAnnotation -> m CommentAnnotation

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CommentAnnotation -> m CommentAnnotation

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CommentAnnotation -> m CommentAnnotation

Read CommentAnnotation

Methods

readsPrec :: Int -> ReadS CommentAnnotation

readList :: ReadS [CommentAnnotation]

readPrec :: ReadPrec CommentAnnotation

readListPrec :: ReadPrec [CommentAnnotation]

Show CommentAnnotation

Methods

showsPrec :: Int -> CommentAnnotation -> ShowS

show :: CommentAnnotation -> String

showList :: [CommentAnnotation] -> ShowS

data TokenPosn

TokenPosn records the location of a token in the input text. It has three fields: the address (number of characters preceding the token), line number and column of a token within the file. Note: The lexer assumes the usual eight character tab stops.

Constructors

TokenPn !Int !Int !Int

Instances

Eq TokenPosn

Methods

(==) :: TokenPosn -> TokenPosn -> Bool

(/=) :: TokenPosn -> TokenPosn -> Bool

Data TokenPosn

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> TokenPosn -> c TokenPosn

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c TokenPosn

toConstr :: TokenPosn -> Constr

dataTypeOf :: TokenPosn -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c TokenPosn)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c TokenPosn)

gmapT :: (forall b. Data b => b -> b) -> TokenPosn -> TokenPosn

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> TokenPosn -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> TokenPosn -> r

gmapQ :: (forall d. Data d => d -> u) -> TokenPosn -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> TokenPosn -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> TokenPosn -> m TokenPosn

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> TokenPosn -> m TokenPosn

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> TokenPosn -> m TokenPosn

Read TokenPosn

Methods

readsPrec :: Int -> ReadS TokenPosn

readList :: ReadS [TokenPosn]

readPrec :: ReadPrec TokenPosn

readListPrec :: ReadPrec [TokenPosn]

Show TokenPosn

Methods

showsPrec :: Int -> TokenPosn -> ShowS

show :: TokenPosn -> String

showList :: [TokenPosn] -> ShowS

tokenPosnEmpty :: TokenPosn

Pretty Printing

renderJS :: JSNode -> Builder

renderToString :: JSNode -> String