@@ -1,486 +1,30 @@
1-----------------------------------------------------------------------------
1-----------------------------------------------------------------------------
3−-- Module : Language.PureScript.Declarations
3+-- Module : Language.PureScript.AST.Traversals
4−-- Copyright : (c) Phil Freeman 2013
4+-- Copyright : (c) 2013-14 Phil Freeman, (c) 2014 Gary Burgess, and other contributors
5-- License : MIT
5-- License : MIT
7-- Maintainer : Phil Freeman <paf31@cantab.net>
7-- Maintainer : Phil Freeman <paf31@cantab.net>
8-- Stability : experimental
8-- Stability : experimental
9-- Portability :
9-- Portability :
11−-- | Data types for modules and declarations
11+-- | AST traversal helpers
13-----------------------------------------------------------------------------
13-----------------------------------------------------------------------------
15−{-# LANGUAGE DeriveDataTypeable, ScopedTypeVariables #-}
17−module Language.PureScript.Declarations where
15+module Language.PureScript.AST.Traversals where
19import Data.Monoid (Monoid(..), mconcat)
17import Data.Monoid (Monoid(..), mconcat)
21−import qualified Data.Data as D
23import Control.Applicative
19import Control.Applicative
24import Control.Monad
20import Control.Monad
25import Control.Arrow ((***), (+++))
21import Control.Arrow ((***), (+++))
23+import Language.PureScript.AST.Binders
24+import Language.PureScript.AST.Declarations
27import Language.PureScript.Types
25import Language.PureScript.Types
28−import Language.PureScript.Names
29−import Language.PureScript.Kinds
30−import Language.PureScript.TypeClassDictionaries
31−import Language.PureScript.CodeGen.JS.AST
32−import Language.PureScript.Environment
33import Language.PureScript.Traversals
26import Language.PureScript.Traversals
36−-- A precedence level for an infix operator
38−type Precedence = Integer
41−-- Associativity for infix operators
43−data Associativity = Infixl | Infixr | Infix deriving (D.Data, D.Typeable)
45−instance Show Associativity where
46− show Infixl = "infixl"
47− show Infixr = "infixr"
51−-- Source position information
53−data SourcePos = SourcePos
61− , sourcePosLine :: Int
65− , sourcePosColumn :: Int
66− } deriving (D.Data, D.Typeable)
68−instance Show SourcePos where
69− show sp = (sourceName sp) ++ " line " ++ show (sourcePosLine sp) ++ ", column " ++ show (sourcePosColumn sp)
72−-- Fixity data for infix operators
74−data Fixity = Fixity Associativity Precedence deriving (Show, D.Data, D.Typeable)
77−-- A module declaration, consisting of a module name, a list of declarations, and a list of the
78−-- declarations that are explicitly exported. If the export list is Nothing, everything is exported.
80−data Module = Module ModuleName [Declaration] (Maybe [DeclarationRef]) deriving (Show, D.Data, D.Typeable)
83−-- An item in a list of explicit imports or exports
87− -- A type constructor with data constructors
89− = TypeRef ProperName (Maybe [ProperName])
97− | TypeClassRef ProperName
99− -- A type class instance, created during typeclass desugaring (name, class name, instance types)
101− | TypeInstanceRef Ident
103− -- A declaration reference with source position information
105− | PositionedDeclarationRef SourcePos DeclarationRef
106− deriving (Show, D.Data, D.Typeable)
108−instance Eq DeclarationRef where
109− (TypeRef name dctors) == (TypeRef name' dctors') = name == name' && dctors == dctors'
110− (ValueRef name) == (ValueRef name') = name == name'
111− (TypeClassRef name) == (TypeClassRef name') = name == name'
112− (TypeInstanceRef name) == (TypeInstanceRef name') = name == name'
113− (PositionedDeclarationRef _ r) == r' = r == r'
114− r == (PositionedDeclarationRef _ r') = r == r'
118−-- The data type which specifies type of import declaration
120−data ImportDeclarationType
122− -- Unqualified import
126− -- Qualified import with a list of references to import
128− | Qualifying [DeclarationRef]
130− -- Import with hiding clause with a list of references to hide
132− | Hiding [DeclarationRef]
133− deriving (Show, D.Data, D.Typeable)
136−-- The data type of declarations
140− -- A data type declaration (data or newtype, name, arguments, data constructors)
142− = DataDeclaration DataDeclType ProperName [(String, Maybe Kind)] [(ProperName, [Type])]
144− -- A minimal mutually recursive set of data type declarations
146− | DataBindingGroupDeclaration [Declaration]
148− -- A type synonym declaration (name, arguments, type)
150− | TypeSynonymDeclaration ProperName [(String, Maybe Kind)] Type
152− -- A type declaration for a value (name, ty)
154− | TypeDeclaration Ident Type
156− -- A value declaration (name, top-level binders, optional guard, value)
158− | ValueDeclaration Ident NameKind [Binder] (Either [(Guard, Expr)] Expr)
160− -- A minimal mutually recursive set of value declarations
162− | BindingGroupDeclaration [(Ident, NameKind, Expr)]
164− -- A foreign import declaration (type, name, optional inline Javascript, type)
166− | ExternDeclaration ForeignImportType Ident (Maybe JS) Type
168− -- A data type foreign import (name, kind)
170− | ExternDataDeclaration ProperName Kind
172− -- A type class instance foreign import
174− | ExternInstanceDeclaration Ident [(Qualified ProperName, [Type])] (Qualified ProperName) [Type]
176− -- A fixity declaration (fixity data, operator name)
178− | FixityDeclaration Fixity String
180− -- A module import (module name, qualified/unqualified/hiding, optional "qualified as" name)
182− | ImportDeclaration ModuleName ImportDeclarationType (Maybe ModuleName)
184− -- A type class declaration (name, argument, implies, member declarations)
186− | TypeClassDeclaration ProperName [(String, Maybe Kind)] [(Qualified ProperName, [Type])] [Declaration]
188− -- A type instance declaration (name, dependencies, class name, instance types, member
191− | TypeInstanceDeclaration Ident [(Qualified ProperName, [Type])] (Qualified ProperName) [Type] [Declaration]
193− -- A declaration with source position information
195− | PositionedDeclaration SourcePos Declaration
196− deriving (Show, D.Data, D.Typeable)
199−-- Test if a declaration is a value declaration
201−isValueDecl :: Declaration -> Bool
202−isValueDecl ValueDeclaration{} = True
203−isValueDecl (PositionedDeclaration _ d) = isValueDecl d
204−isValueDecl _ = False
207−-- Test if a declaration is a data type or type synonym declaration
209−isDataDecl :: Declaration -> Bool
210−isDataDecl DataDeclaration{} = True
211−isDataDecl TypeSynonymDeclaration{} = True
212−isDataDecl (PositionedDeclaration _ d) = isDataDecl d
216−-- Test if a declaration is a module import
218−isImportDecl :: Declaration -> Bool
219−isImportDecl ImportDeclaration{} = True
220−isImportDecl (PositionedDeclaration _ d) = isImportDecl d
221−isImportDecl _ = False
224−-- Test if a declaration is a data type foreign import
226−isExternDataDecl :: Declaration -> Bool
227−isExternDataDecl ExternDataDeclaration{} = True
228−isExternDataDecl (PositionedDeclaration _ d) = isExternDataDecl d
229−isExternDataDecl _ = False
232−-- Test if a declaration is a type class instance foreign import
234−isExternInstanceDecl :: Declaration -> Bool
235−isExternInstanceDecl ExternInstanceDeclaration{} = True
236−isExternInstanceDecl (PositionedDeclaration _ d) = isExternInstanceDecl d
237−isExternInstanceDecl _ = False
240−-- Test if a declaration is a fixity declaration
242−isFixityDecl :: Declaration -> Bool
243−isFixityDecl FixityDeclaration{} = True
244−isFixityDecl (PositionedDeclaration _ d) = isFixityDecl d
245−isFixityDecl _ = False
248−-- Test if a declaration is a foreign import
250−isExternDecl :: Declaration -> Bool
251−isExternDecl ExternDeclaration{} = True
252−isExternDecl (PositionedDeclaration _ d) = isExternDecl d
253−isExternDecl _ = False
256−-- Test if a declaration is a type class or instance declaration
258−isTypeClassDeclaration :: Declaration -> Bool
259−isTypeClassDeclaration TypeClassDeclaration{} = True
260−isTypeClassDeclaration TypeInstanceDeclaration{} = True
261−isTypeClassDeclaration (PositionedDeclaration _ d) = isTypeClassDeclaration d
262−isTypeClassDeclaration _ = False
265−-- A guard is just a boolean-valued expression that appears alongside a set of binders
270−-- Data type for expressions and terms
274− -- A numeric literal
276− = NumericLiteral (Either Integer Double)
280− | StringLiteral String
282− -- A boolean literal
284− | BooleanLiteral Bool
286− -- A prefix -, will be desugared
290− -- Binary operator application. During the rebracketing phase of desugaring, this data constructor
293− | BinaryNoParens (Qualified Ident) Expr Expr
295− -- Explicit parentheses. During the rebracketing phase of desugaring, this data constructor
302− | ArrayLiteral [Expr]
304− -- An object literal
306− | ObjectLiteral [(String, Expr)]
308− -- An record property accessor expression
310− | Accessor String Expr
312− -- Partial record update
314− | ObjectUpdate Expr [(String, Expr)]
316− -- Function introduction
318− | Abs (Either Ident Binder) Expr
320− -- Function application
326− | Var (Qualified Ident)
328− -- Conditional (if-then-else expression)
330− | IfThenElse Expr Expr Expr
332− -- A data constructor
334− | Constructor (Qualified ProperName)
336− -- A case expression. During the case expansion phase of desugaring, top-level binders will get
337− -- desugared into case expressions, hence the need for guards and multiple binders per branch here.
339− | Case [Expr] [CaseAlternative]
341− -- A value with a type annotation
343− | TypedValue Bool Expr Type
347− | Let [Declaration] Expr
349− -- A do-notation block
351− | Do [DoNotationElement]
353− -- An application of a typeclass dictionary constructor. The value should be
354− -- an ObjectLiteral.
356− | TypeClassDictionaryConstructorApp (Qualified ProperName) Expr
358− -- A placeholder for a type class dictionary to be inserted later. At the end of type checking, these
359− -- placeholders will be replaced with actual expressions representing type classes dictionaries which
360− -- can be evaluated at runtime. The constructor arguments represent (in order): whether or not to look
361− -- at superclass implementations when searching for a dictionary, the type class name and
362− -- instance type, and the type class dictionaries in scope.
364− | TypeClassDictionary Bool (Qualified ProperName, [Type]) [TypeClassDictionaryInScope]
366− -- A placeholder for a superclass dictionary to be turned into a TypeClassDictionary during typechecking
368− | SuperClassDictionary (Qualified ProperName) [Type]
370− -- A value with source position information
372− | PositionedValue SourcePos Expr deriving (Show, D.Data, D.Typeable)
375−-- An alternative in a case statement
377−data CaseAlternative = CaseAlternative
379− -- A collection of binders with which to match the inputs
381− caseAlternativeBinders :: [Binder]
383− -- The result expression or a collect of guarded expressions
385− , caseAlternativeResult :: Either [(Guard, Expr)] Expr
386− } deriving (Show, D.Data, D.Typeable)
389−-- Find the original dictionary which a type class dictionary in scope refers to
391−canonicalizeDictionary :: TypeClassDictionaryInScope -> Qualified Ident
392−canonicalizeDictionary (TypeClassDictionaryInScope { tcdType = TCDRegular, tcdName = nm }) = nm
393−canonicalizeDictionary (TypeClassDictionaryInScope { tcdType = TCDAlias nm }) = nm
396−-- A statement in a do-notation block
398−data DoNotationElement
400− -- A monadic value without a binder
402− = DoNotationValue Expr
404− -- A monadic value with a binder
406− | DoNotationBind Binder Expr
408− -- A let statement, i.e. a pure value with a binder
410− | DoNotationLet [Declaration]
412− -- A do notation element with source position information
414− | PositionedDoNotationElement SourcePos DoNotationElement deriving (Show, D.Data, D.Typeable)
417−-- Data type for binders
425− -- A binder which matches a boolean literal
427− | BooleanBinder Bool
429− -- A binder which matches a string literal
431− | StringBinder String
433− -- A binder which matches a numeric literal
435− | NumberBinder (Either Integer Double)
437− -- A binder which binds an identifier
441− -- A binder which matches a data constructor
443− | ConstructorBinder (Qualified ProperName) [Binder]
445− -- A binder which matches a record and binds its properties
447− | ObjectBinder [(String, Binder)]
449− -- A binder which matches an array and binds its elements
451− | ArrayBinder [Binder]
453− -- A binder which matches an array and binds its head and tail
455− | ConsBinder Binder Binder
457− -- A binder which binds its input to an identifier
459− | NamedBinder Ident Binder
461− -- A binder with source position information
463− | PositionedBinder SourcePos Binder deriving (Show, D.Data, D.Typeable)
466−-- Collect all names introduced in binders in an expression
468−binderNames :: Binder -> [Ident]
471− go ns (VarBinder name) = name : ns
472− go ns (ConstructorBinder _ bs) = foldl go ns bs
473− go ns (ObjectBinder bs) = foldl go ns (map snd bs)
474− go ns (ArrayBinder bs) = foldl go ns bs
475− go ns (ConsBinder b1 b2) = go (go ns b1) b2
476− go ns (NamedBinder name b) = go (name : ns) b
477− go ns (PositionedBinder _ b) = go ns b
484everywhereOnValues :: (Declaration -> Declaration) ->
28everywhereOnValues :: (Declaration -> Declaration) ->
485 (Expr -> Expr) ->
29 (Expr -> Expr) ->
486 (Binder -> Binder) ->
30 (Binder -> Binder) ->
@@ -545,7 +89,7 @@ everywhereOnValuesTopDownM :: (Functor m, Applicative m, Monad m) =>
545everywhereOnValuesTopDownM f g h = (f' <=< f, g' <=< g, h' <=< h)
89everywhereOnValuesTopDownM f g h = (f' <=< f, g' <=< g, h' <=< h)
547 f' (DataBindingGroupDeclaration ds) = DataBindingGroupDeclaration <$> mapM (f' <=< f) ds
91 f' (DataBindingGroupDeclaration ds) = DataBindingGroupDeclaration <$> mapM (f' <=< f) ds
548− f' (ValueDeclaration name nameKind bs val) = ValueDeclaration name nameKind <$> mapM (h' <=< h) bs <*> eitherM (mapM (pairM (g' <=< g) (g' <=< g))) (g' <=< g) val
92+ f' (ValueDeclaration name nameKind bs val) = ValueDeclaration name nameKind <$> mapM (h' <=< h) bs <*> eitherM (mapM (pairM (g' <=< g) (g' <=< g))) (g' <=< g) val
549 f' (BindingGroupDeclaration ds) = BindingGroupDeclaration <$> mapM (\(name, nameKind, val) -> (,,) name nameKind <$> (g val >>= g')) ds
93 f' (BindingGroupDeclaration ds) = BindingGroupDeclaration <$> mapM (\(name, nameKind, val) -> (,,) name nameKind <$> (g val >>= g')) ds
550 f' (TypeClassDeclaration name args implies ds) = TypeClassDeclaration name args implies <$> mapM (f' <=< f) ds
94 f' (TypeClassDeclaration name args implies ds) = TypeClassDeclaration name args implies <$> mapM (f' <=< f) ds
551 f' (TypeInstanceDeclaration name cs className args ds) = TypeInstanceDeclaration name cs className args <$> mapM (f' <=< f) ds
95 f' (TypeInstanceDeclaration name cs className args ds) = TypeInstanceDeclaration name cs className args <$> mapM (f' <=< f) ds
@@ -837,5 +381,3 @@ accumTypes f = everythingOnValues mappend forDecls forValues (const mempty) (con
837 forValues (SuperClassDictionary _ tys) = mconcat (map f tys)
381 forValues (SuperClassDictionary _ tys) = mconcat (map f tys)
838 forValues (TypedValue _ _ ty) = f ty
382 forValues (TypedValue _ _ ty) = f ty
839 forValues _ = mempty
383 forValues _ = mempty