feat(ast): add Generic and NFData derivations to AST types

Implements PR #122 by adding Generic and NFData instances to all 36 AST
data types in Language.JavaScript.Parser.AST module.

- Add DeriveGeneric and DeriveAnyClass language extensions
- Import Control.DeepSeq (NFData) and GHC.Generics (Generic)
- Update all deriving clauses to include Generic and NFData
- Enables performance benchmarking and space leak prevention

Author: quintenkasteel

src/Language/JavaScript/Parser/AST.hs

@@ -1,4 +1,4 @@
-{-# LANGUAGE DeriveDataTypeable, FlexibleInstances #-}
+{-# LANGUAGE DeriveDataTypeable, DeriveGeneric, DeriveAnyClass, FlexibleInstances #-}
 
 module Language.JavaScript.Parser.AST
     ( JSExpression (..)
@@ -45,8 +45,10 @@ module Language.JavaScript.Parser.AST
     , showStripped
     ) where
 
+import Control.DeepSeq (NFData)
 import Data.Data
 import Data.List
+import GHC.Generics (Generic)
 import Language.JavaScript.Parser.SrcLocation (TokenPosn (..))
 import Language.JavaScript.Parser.Token
 
@@ -56,7 +58,7 @@ data JSAnnot
     = JSAnnot !TokenPosn ![CommentAnnotation] -- ^Annotation: position and comment/whitespace information
     | JSAnnotSpace -- ^A single space character
     | JSNoAnnot -- ^No annotation
-    deriving (Data, Eq, Show, Typeable)
+    deriving (Data, Eq, Generic, NFData, Show, Typeable)
 
 
 data JSAST
@@ -65,67 +67,67 @@ data JSAST
     | JSAstStatement !JSStatement !JSAnnot
     | JSAstExpression !JSExpression !JSAnnot
     | JSAstLiteral !JSExpression !JSAnnot
-    deriving (Data, Eq, Show, Typeable)
+    deriving (Data, Eq, Generic, NFData, Show, Typeable)
 
 -- Shift AST
 -- https://github.com/shapesecurity/shift-spec/blob/83498b92c436180cc0e2115b225a68c08f43c53e/spec.idl#L229-L234
 data JSModuleItem
     = JSModuleImportDeclaration !JSAnnot !JSImportDeclaration -- ^import,decl
     | JSModuleExportDeclaration !JSAnnot !JSExportDeclaration -- ^export,decl
     | JSModuleStatementListItem !JSStatement
-    deriving (Data, Eq, Show, Typeable)
+    deriving (Data, Eq, Generic, NFData, Show, Typeable)
 
 data JSImportDeclaration
     = JSImportDeclaration !JSImportClause !JSFromClause !JSSemi -- ^imports, module, semi
     | JSImportDeclarationBare !JSAnnot !String !JSSemi -- ^module, module, semi
-    deriving (Data, Eq, Show, Typeable)
+    deriving (Data, Eq, Generic, NFData, Show, Typeable)
 
 data JSImportClause
     = JSImportClauseDefault !JSIdent -- ^default
     | JSImportClauseNameSpace !JSImportNameSpace -- ^namespace
     | JSImportClauseNamed !JSImportsNamed -- ^named imports
     | JSImportClauseDefaultNameSpace !JSIdent !JSAnnot !JSImportNameSpace -- ^default, comma, namespace
     | JSImportClauseDefaultNamed !JSIdent !JSAnnot !JSImportsNamed -- ^default, comma, named imports
-    deriving (Data, Eq, Show, Typeable)
+    deriving (Data, Eq, Generic, NFData, Show, Typeable)
 
 data JSFromClause
     = JSFromClause !JSAnnot !JSAnnot !String -- ^ from, string literal, string literal contents
-    deriving (Data, Eq, Show, Typeable)
+    deriving (Data, Eq, Generic, NFData, Show, Typeable)
 
 -- | Import namespace, e.g. '* as whatever'
 data JSImportNameSpace
     = JSImportNameSpace !JSBinOp !JSAnnot !JSIdent -- ^ *, as, ident
-    deriving (Data, Eq, Show, Typeable)
+    deriving (Data, Eq, Generic, NFData, Show, Typeable)
 
 -- | Named imports, e.g. '{ foo, bar, baz as quux }'
 data JSImportsNamed
     = JSImportsNamed !JSAnnot !(JSCommaList JSImportSpecifier) !JSAnnot -- ^lb, specifiers, rb
-    deriving (Data, Eq, Show, Typeable)
+    deriving (Data, Eq, Generic, NFData, Show, Typeable)
 
 -- |
 -- Note that this data type is separate from ExportSpecifier because the
 -- grammar is slightly different (e.g. in handling of reserved words).
 data JSImportSpecifier
     = JSImportSpecifier !JSIdent -- ^ident
     | JSImportSpecifierAs !JSIdent !JSAnnot !JSIdent -- ^ident, as, ident
-    deriving (Data, Eq, Show, Typeable)
+    deriving (Data, Eq, Generic, NFData, Show, Typeable)
 
 data JSExportDeclaration
     -- = JSExportAllFrom
     = JSExportFrom JSExportClause JSFromClause !JSSemi -- ^exports, module, semi
     | JSExportLocals JSExportClause !JSSemi -- ^exports, autosemi
     | JSExport !JSStatement !JSSemi -- ^body, autosemi
     -- | JSExportDefault
-    deriving (Data, Eq, Show, Typeable)
+    deriving (Data, Eq, Generic, NFData, Show, Typeable)
 
 data JSExportClause
     = JSExportClause !JSAnnot !(JSCommaList JSExportSpecifier) !JSAnnot -- ^lb, specifiers, rb
-    deriving (Data, Eq, Show, Typeable)
+    deriving (Data, Eq, Generic, NFData, Show, Typeable)
 
 data JSExportSpecifier
     = JSExportSpecifier !JSIdent -- ^ident
     | JSExportSpecifierAs !JSIdent !JSAnnot !JSIdent -- ^ident1, as, ident2
-    deriving (Data, Eq, Show, Typeable)
+    deriving (Data, Eq, Generic, NFData, Show, Typeable)
 
 data JSStatement
     = JSStatementBlock !JSAnnot ![JSStatement] !JSAnnot !JSSemi     -- ^lbrace, stmts, rbrace, autosemi
@@ -164,7 +166,7 @@ data JSStatement
     | JSVariable !JSAnnot !(JSCommaList JSExpression) !JSSemi -- ^var, decl, autosemi
     | JSWhile !JSAnnot !JSAnnot !JSExpression !JSAnnot !JSStatement -- ^while,lb,expr,rb,stmt
     | JSWith !JSAnnot !JSAnnot !JSExpression !JSAnnot !JSStatement !JSSemi -- ^with,lb,expr,rb,stmt list
-    deriving (Data, Eq, Show, Typeable)
+    deriving (Data, Eq, Generic, NFData, Show, Typeable)
 
 data JSExpression
     -- | Terminals
@@ -208,17 +210,17 @@ data JSExpression
     | JSVarInitExpression !JSExpression !JSVarInitializer -- ^identifier, initializer
     | JSYieldExpression !JSAnnot !(Maybe JSExpression) -- ^yield, optional expr
     | JSYieldFromExpression !JSAnnot !JSAnnot !JSExpression -- ^yield, *, expr
-    deriving (Data, Eq, Show, Typeable)
+    deriving (Data, Eq, Generic, NFData, Show, Typeable)
 
 data JSArrowParameterList
     = JSUnparenthesizedArrowParameter !JSIdent
     | JSParenthesizedArrowParameterList !JSAnnot !(JSCommaList JSExpression) !JSAnnot
-    deriving (Data, Eq, Show, Typeable)
+    deriving (Data, Eq, Generic, NFData, Show, Typeable)
 
 data JSConciseBody
     = JSConciseFunctionBody !JSBlock
     | JSConciseExpressionBody !JSExpression
-    deriving (Data, Eq, Show, Typeable)
+    deriving (Data, Eq, Generic, NFData, Show, Typeable)
 
 data JSBinOp
     = JSBinOpAnd !JSAnnot
@@ -246,7 +248,7 @@ data JSBinOp
     | JSBinOpStrictNeq !JSAnnot
     | JSBinOpTimes !JSAnnot
     | JSBinOpUrsh !JSAnnot
-    deriving (Data, Eq, Show, Typeable)
+    deriving (Data, Eq, Generic, NFData, Show, Typeable)
 
 data JSUnaryOp
     = JSUnaryOpDecr !JSAnnot
@@ -258,12 +260,12 @@ data JSUnaryOp
     | JSUnaryOpTilde !JSAnnot
     | JSUnaryOpTypeof !JSAnnot
     | JSUnaryOpVoid !JSAnnot
-    deriving (Data, Eq, Show, Typeable)
+    deriving (Data, Eq, Generic, NFData, Show, Typeable)
 
 data JSSemi
     = JSSemi !JSAnnot
     | JSSemiAuto
-    deriving (Data, Eq, Show, Typeable)
+    deriving (Data, Eq, Generic, NFData, Show, Typeable)
 
 data JSAssignOp
     = JSAssign !JSAnnot
@@ -278,95 +280,95 @@ data JSAssignOp
     | JSBwAndAssign !JSAnnot
     | JSBwXorAssign !JSAnnot
     | JSBwOrAssign !JSAnnot
-    deriving (Data, Eq, Show, Typeable)
+    deriving (Data, Eq, Generic, NFData, Show, Typeable)
 
 data JSTryCatch
     = JSCatch !JSAnnot !JSAnnot !JSExpression !JSAnnot !JSBlock -- ^catch,lb,ident,rb,block
     | JSCatchIf !JSAnnot !JSAnnot !JSExpression !JSAnnot !JSExpression !JSAnnot !JSBlock -- ^catch,lb,ident,if,expr,rb,block
-    deriving (Data, Eq, Show, Typeable)
+    deriving (Data, Eq, Generic, NFData, Show, Typeable)
 
 data JSTryFinally
     = JSFinally !JSAnnot !JSBlock -- ^finally,block
     | JSNoFinally
-    deriving (Data, Eq, Show, Typeable)
+    deriving (Data, Eq, Generic, NFData, Show, Typeable)
 
 data JSBlock
     = JSBlock !JSAnnot ![JSStatement] !JSAnnot -- ^lbrace, stmts, rbrace
-    deriving (Data, Eq, Show, Typeable)
+    deriving (Data, Eq, Generic, NFData, Show, Typeable)
 
 data JSSwitchParts
     = JSCase !JSAnnot !JSExpression !JSAnnot ![JSStatement]    -- ^expr,colon,stmtlist
     | JSDefault !JSAnnot !JSAnnot ![JSStatement] -- ^colon,stmtlist
-    deriving (Data, Eq, Show, Typeable)
+    deriving (Data, Eq, Generic, NFData, Show, Typeable)
 
 data JSVarInitializer
     = JSVarInit !JSAnnot !JSExpression -- ^ assignop, initializer
     | JSVarInitNone
-    deriving (Data, Eq, Show, Typeable)
+    deriving (Data, Eq, Generic, NFData, Show, Typeable)
 
 data JSObjectProperty
     = JSPropertyNameandValue !JSPropertyName !JSAnnot ![JSExpression] -- ^name, colon, value
     | JSPropertyIdentRef !JSAnnot !String
     | JSObjectMethod !JSMethodDefinition
     | JSObjectSpread !JSAnnot !JSExpression -- ^..., expression
-    deriving (Data, Eq, Show, Typeable)
+    deriving (Data, Eq, Generic, NFData, Show, Typeable)
 
 data JSMethodDefinition
     = JSMethodDefinition !JSPropertyName !JSAnnot !(JSCommaList JSExpression) !JSAnnot !JSBlock -- name, lb, params, rb, block
     | JSGeneratorMethodDefinition !JSAnnot !JSPropertyName !JSAnnot !(JSCommaList JSExpression) !JSAnnot !JSBlock -- ^*, name, lb, params, rb, block
     | JSPropertyAccessor !JSAccessor !JSPropertyName !JSAnnot !(JSCommaList JSExpression) !JSAnnot !JSBlock -- ^get/set, name, lb, params, rb, block
-    deriving (Data, Eq, Show, Typeable)
+    deriving (Data, Eq, Generic, NFData, Show, Typeable)
 
 data JSPropertyName
     = JSPropertyIdent !JSAnnot !String
     | JSPropertyString !JSAnnot !String
     | JSPropertyNumber !JSAnnot !String
     | JSPropertyComputed !JSAnnot !JSExpression !JSAnnot -- ^lb, expr, rb
-    deriving (Data, Eq, Show, Typeable)
+    deriving (Data, Eq, Generic, NFData, Show, Typeable)
 
 type JSObjectPropertyList = JSCommaTrailingList JSObjectProperty
 
 -- | Accessors for JSObjectProperty is either 'get' or 'set'.
 data JSAccessor
     = JSAccessorGet !JSAnnot
     | JSAccessorSet !JSAnnot
-    deriving (Data, Eq, Show, Typeable)
+    deriving (Data, Eq, Generic, NFData, Show, Typeable)
 
 data JSIdent
     = JSIdentName !JSAnnot !String
     | JSIdentNone
-    deriving (Data, Eq, Show, Typeable)
+    deriving (Data, Eq, Generic, NFData, Show, Typeable)
 
 data JSArrayElement
     = JSArrayElement !JSExpression
     | JSArrayComma !JSAnnot
-    deriving (Data, Eq, Show, Typeable)
+    deriving (Data, Eq, Generic, NFData, Show, Typeable)
 
 data JSCommaList a
     = JSLCons !(JSCommaList a) !JSAnnot !a -- ^head, comma, a
     | JSLOne !a -- ^ single element (no comma)
     | JSLNil
-    deriving (Data, Eq, Show, Typeable)
+    deriving (Data, Eq, Generic, NFData, Show, Typeable)
 
 data JSCommaTrailingList a
     = JSCTLComma !(JSCommaList a) !JSAnnot -- ^list, trailing comma
     | JSCTLNone !(JSCommaList a) -- ^list
-    deriving (Data, Eq, Show, Typeable)
+    deriving (Data, Eq, Generic, NFData, Show, Typeable)
 
 data JSTemplatePart
     = JSTemplatePart !JSExpression !JSAnnot !String -- ^expr, rb, suffix
-    deriving (Data, Eq, Show, Typeable)
+    deriving (Data, Eq, Generic, NFData, Show, Typeable)
 
 data JSClassHeritage
     = JSExtends !JSAnnot !JSExpression
     | JSExtendsNone
-    deriving (Data, Eq, Show, Typeable)
+    deriving (Data, Eq, Generic, NFData, Show, Typeable)
 
 data JSClassElement
     = JSClassInstanceMethod !JSMethodDefinition
     | JSClassStaticMethod !JSAnnot !JSMethodDefinition
     | JSClassSemi !JSAnnot
-    deriving (Data, Eq, Show, Typeable)
+    deriving (Data, Eq, Generic, NFData, Show, Typeable)
 
 -- -----------------------------------------------------------------------------
 -- | Show the AST elements stripped of their JSAnnot data.