@@ -1,486 +1,30 @@
11-----------------------------------------------------------------------------
22--
3−-- Module : Language.PureScript.Declarations
4−-- Copyright : (c) Phil Freeman 2013
3+-- Module : Language.PureScript.AST.Traversals
4+-- Copyright : (c) 2013-14 Phil Freeman, (c) 2014 Gary Burgess, and other contributors
55-- License : MIT
66--
77-- Maintainer : Phil Freeman <paf31@cantab.net>
88-- Stability : experimental
99-- Portability :
1010--
11−-- | Data types for modules and declarations
11+-- | AST traversal helpers
1212--
1313-----------------------------------------------------------------------------
1414
15−{-# LANGUAGE DeriveDataTypeable, ScopedTypeVariables #-}
16−
17−module Language.PureScript.Declarations where
15+module Language.PureScript.AST.Traversals where
1816
1917import Data.Monoid (Monoid(..), mconcat)
2018
21−import qualified Data.Data as D
22−
2319import Control.Applicative
2420import Control.Monad
2521import Control.Arrow ((***), (+++))
2622
23+import Language.PureScript.AST.Binders
24+import Language.PureScript.AST.Declarations
2725import 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
3326import Language.PureScript.Traversals
3427
35−-- |
36−-- A precedence level for an infix operator
37−--
38−type Precedence = Integer
39−
40−-- |
41−-- Associativity for infix operators
42−--
43−data Associativity = Infixl | Infixr | Infix deriving (D.Data, D.Typeable)
44−
45−instance Show Associativity where
46− show Infixl = "infixl"
47− show Infixr = "infixr"
48− show Infix = "infix"
49−
50−-- |
51−-- Source position information
52−--
53−data SourcePos = SourcePos
54− { -- |
55− -- Source name
56− --
57− sourceName :: String
58− -- |
59− -- Line number
60− --
61− , sourcePosLine :: Int
62− -- |
63− -- Column number
64− --
65− , sourcePosColumn :: Int
66− } deriving (D.Data, D.Typeable)
67−
68−instance Show SourcePos where
69− show sp = (sourceName sp) ++ " line " ++ show (sourcePosLine sp) ++ ", column " ++ show (sourcePosColumn sp)
70−
71−-- |
72−-- Fixity data for infix operators
73−--
74−data Fixity = Fixity Associativity Precedence deriving (Show, D.Data, D.Typeable)
75−
76−-- |
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.
79−--
80−data Module = Module ModuleName [Declaration] (Maybe [DeclarationRef]) deriving (Show, D.Data, D.Typeable)
81−
82−-- |
83−-- An item in a list of explicit imports or exports
84−--
85−data DeclarationRef
86− -- |
87− -- A type constructor with data constructors
88− --
89− = TypeRef ProperName (Maybe [ProperName])
90− -- |
91− -- A value
92− --
93− | ValueRef Ident
94− -- |
95− -- A type class
96− --
97− | TypeClassRef ProperName
98− -- |
99− -- A type class instance, created during typeclass desugaring (name, class name, instance types)
100− --
101− | TypeInstanceRef Ident
102− -- |
103− -- A declaration reference with source position information
104− --
105− | PositionedDeclarationRef SourcePos DeclarationRef
106− deriving (Show, D.Data, D.Typeable)
107−
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'
115− _ == _ = False
116−
117−-- |
118−-- The data type which specifies type of import declaration
119−--
120−data ImportDeclarationType
121− -- |
122− -- Unqualified import
123− --
124− = Unqualified
125− -- |
126− -- Qualified import with a list of references to import
127− --
128− | Qualifying [DeclarationRef]
129− -- |
130− -- Import with hiding clause with a list of references to hide
131− --
132− | Hiding [DeclarationRef]
133− deriving (Show, D.Data, D.Typeable)
134−
135−-- |
136−-- The data type of declarations
137−--
138−data Declaration
139− -- |
140− -- A data type declaration (data or newtype, name, arguments, data constructors)
141− --
142− = DataDeclaration DataDeclType ProperName [(String, Maybe Kind)] [(ProperName, [Type])]
143− -- |
144− -- A minimal mutually recursive set of data type declarations
145− --
146− | DataBindingGroupDeclaration [Declaration]
147− -- |
148− -- A type synonym declaration (name, arguments, type)
149− --
150− | TypeSynonymDeclaration ProperName [(String, Maybe Kind)] Type
151− -- |
152− -- A type declaration for a value (name, ty)
153− --
154− | TypeDeclaration Ident Type
155− -- |
156− -- A value declaration (name, top-level binders, optional guard, value)
157− --
158− | ValueDeclaration Ident NameKind [Binder] (Either [(Guard, Expr)] Expr)
159− -- |
160− -- A minimal mutually recursive set of value declarations
161− --
162− | BindingGroupDeclaration [(Ident, NameKind, Expr)]
163− -- |
164− -- A foreign import declaration (type, name, optional inline Javascript, type)
165− --
166− | ExternDeclaration ForeignImportType Ident (Maybe JS) Type
167− -- |
168− -- A data type foreign import (name, kind)
169− --
170− | ExternDataDeclaration ProperName Kind
171− -- |
172− -- A type class instance foreign import
173− --
174− | ExternInstanceDeclaration Ident [(Qualified ProperName, [Type])] (Qualified ProperName) [Type]
175− -- |
176− -- A fixity declaration (fixity data, operator name)
177− --
178− | FixityDeclaration Fixity String
179− -- |
180− -- A module import (module name, qualified/unqualified/hiding, optional "qualified as" name)
181− --
182− | ImportDeclaration ModuleName ImportDeclarationType (Maybe ModuleName)
183− -- |
184− -- A type class declaration (name, argument, implies, member declarations)
185− --
186− | TypeClassDeclaration ProperName [(String, Maybe Kind)] [(Qualified ProperName, [Type])] [Declaration]
187− -- |
188− -- A type instance declaration (name, dependencies, class name, instance types, member
189− -- declarations)
190− --
191− | TypeInstanceDeclaration Ident [(Qualified ProperName, [Type])] (Qualified ProperName) [Type] [Declaration]
192− -- |
193− -- A declaration with source position information
194− --
195− | PositionedDeclaration SourcePos Declaration
196− deriving (Show, D.Data, D.Typeable)
197−
198−-- |
199−-- Test if a declaration is a value declaration
200−--
201−isValueDecl :: Declaration -> Bool
202−isValueDecl ValueDeclaration{} = True
203−isValueDecl (PositionedDeclaration _ d) = isValueDecl d
204−isValueDecl _ = False
205−
206−-- |
207−-- Test if a declaration is a data type or type synonym declaration
208−--
209−isDataDecl :: Declaration -> Bool
210−isDataDecl DataDeclaration{} = True
211−isDataDecl TypeSynonymDeclaration{} = True
212−isDataDecl (PositionedDeclaration _ d) = isDataDecl d
213−isDataDecl _ = False
214−
215−-- |
216−-- Test if a declaration is a module import
217−--
218−isImportDecl :: Declaration -> Bool
219−isImportDecl ImportDeclaration{} = True
220−isImportDecl (PositionedDeclaration _ d) = isImportDecl d
221−isImportDecl _ = False
222−
223−-- |
224−-- Test if a declaration is a data type foreign import
225−--
226−isExternDataDecl :: Declaration -> Bool
227−isExternDataDecl ExternDataDeclaration{} = True
228−isExternDataDecl (PositionedDeclaration _ d) = isExternDataDecl d
229−isExternDataDecl _ = False
230−
231−-- |
232−-- Test if a declaration is a type class instance foreign import
233−--
234−isExternInstanceDecl :: Declaration -> Bool
235−isExternInstanceDecl ExternInstanceDeclaration{} = True
236−isExternInstanceDecl (PositionedDeclaration _ d) = isExternInstanceDecl d
237−isExternInstanceDecl _ = False
238−
239−-- |
240−-- Test if a declaration is a fixity declaration
241−--
242−isFixityDecl :: Declaration -> Bool
243−isFixityDecl FixityDeclaration{} = True
244−isFixityDecl (PositionedDeclaration _ d) = isFixityDecl d
245−isFixityDecl _ = False
246−
247−-- |
248−-- Test if a declaration is a foreign import
249−--
250−isExternDecl :: Declaration -> Bool
251−isExternDecl ExternDeclaration{} = True
252−isExternDecl (PositionedDeclaration _ d) = isExternDecl d
253−isExternDecl _ = False
254−
255−-- |
256−-- Test if a declaration is a type class or instance declaration
257−--
258−isTypeClassDeclaration :: Declaration -> Bool
259−isTypeClassDeclaration TypeClassDeclaration{} = True
260−isTypeClassDeclaration TypeInstanceDeclaration{} = True
261−isTypeClassDeclaration (PositionedDeclaration _ d) = isTypeClassDeclaration d
262−isTypeClassDeclaration _ = False
263−
264−-- |
265−-- A guard is just a boolean-valued expression that appears alongside a set of binders
266−--
267−type Guard = Expr
268−
269−-- |
270−-- Data type for expressions and terms
271−--
272−data Expr
273− -- |
274− -- A numeric literal
275− --
276− = NumericLiteral (Either Integer Double)
277− -- |
278− -- A string literal
279− --
280− | StringLiteral String
281− -- |
282− -- A boolean literal
283− --
284− | BooleanLiteral Bool
285− -- |
286− -- A prefix -, will be desugared
287− --
288− | UnaryMinus Expr
289− -- |
290− -- Binary operator application. During the rebracketing phase of desugaring, this data constructor
291− -- will be removed.
292− --
293− | BinaryNoParens (Qualified Ident) Expr Expr
294− -- |
295− -- Explicit parentheses. During the rebracketing phase of desugaring, this data constructor
296− -- will be removed.
297− --
298− | Parens Expr
299− -- |
300− -- An array literal
301− --
302− | ArrayLiteral [Expr]
303− -- |
304− -- An object literal
305− --
306− | ObjectLiteral [(String, Expr)]
307− -- |
308− -- An record property accessor expression
309− --
310− | Accessor String Expr
311− -- |
312− -- Partial record update
313− --
314− | ObjectUpdate Expr [(String, Expr)]
315− -- |
316− -- Function introduction
317− --
318− | Abs (Either Ident Binder) Expr
319− -- |
320− -- Function application
321− --
322− | App Expr Expr
323− -- |
324− -- Variable
325− --
326− | Var (Qualified Ident)
327− -- |
328− -- Conditional (if-then-else expression)
329− --
330− | IfThenElse Expr Expr Expr
331− -- |
332− -- A data constructor
333− --
334− | Constructor (Qualified ProperName)
335− -- |
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.
338− --
339− | Case [Expr] [CaseAlternative]
340− -- |
341− -- A value with a type annotation
342− --
343− | TypedValue Bool Expr Type
344− -- |
345− -- A let binding
346− --
347− | Let [Declaration] Expr
348− -- |
349− -- A do-notation block
350− --
351− | Do [DoNotationElement]
352− -- |
353− -- An application of a typeclass dictionary constructor. The value should be
354− -- an ObjectLiteral.
355− --
356− | TypeClassDictionaryConstructorApp (Qualified ProperName) Expr
357− -- |
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.
363− --
364− | TypeClassDictionary Bool (Qualified ProperName, [Type]) [TypeClassDictionaryInScope]
365− -- |
366− -- A placeholder for a superclass dictionary to be turned into a TypeClassDictionary during typechecking
367− --
368− | SuperClassDictionary (Qualified ProperName) [Type]
369− -- |
370− -- A value with source position information
371− --
372− | PositionedValue SourcePos Expr deriving (Show, D.Data, D.Typeable)
373−
374−-- |
375−-- An alternative in a case statement
376−--
377−data CaseAlternative = CaseAlternative
378− { -- |
379− -- A collection of binders with which to match the inputs
380− --
381− caseAlternativeBinders :: [Binder]
382− -- |
383− -- The result expression or a collect of guarded expressions
384− --
385− , caseAlternativeResult :: Either [(Guard, Expr)] Expr
386− } deriving (Show, D.Data, D.Typeable)
387−
388−-- |
389−-- Find the original dictionary which a type class dictionary in scope refers to
390−--
391−canonicalizeDictionary :: TypeClassDictionaryInScope -> Qualified Ident
392−canonicalizeDictionary (TypeClassDictionaryInScope { tcdType = TCDRegular, tcdName = nm }) = nm
393−canonicalizeDictionary (TypeClassDictionaryInScope { tcdType = TCDAlias nm }) = nm
394−
395−-- |
396−-- A statement in a do-notation block
397−--
398−data DoNotationElement
399− -- |
400− -- A monadic value without a binder
401− --
402− = DoNotationValue Expr
403− -- |
404− -- A monadic value with a binder
405− --
406− | DoNotationBind Binder Expr
407− -- |
408− -- A let statement, i.e. a pure value with a binder
409− --
410− | DoNotationLet [Declaration]
411− -- |
412− -- A do notation element with source position information
413− --
414− | PositionedDoNotationElement SourcePos DoNotationElement deriving (Show, D.Data, D.Typeable)
415−
416−-- |
417−-- Data type for binders
418−--
419−data Binder
420− -- |
421− -- Wildcard binder
422− --
423− = NullBinder
424− -- |
425− -- A binder which matches a boolean literal
426− --
427− | BooleanBinder Bool
428− -- |
429− -- A binder which matches a string literal
430− --
431− | StringBinder String
432− -- |
433− -- A binder which matches a numeric literal
434− --
435− | NumberBinder (Either Integer Double)
436− -- |
437− -- A binder which binds an identifier
438− --
439− | VarBinder Ident
440− -- |
441− -- A binder which matches a data constructor
442− --
443− | ConstructorBinder (Qualified ProperName) [Binder]
444− -- |
445− -- A binder which matches a record and binds its properties
446− --
447− | ObjectBinder [(String, Binder)]
448− -- |
449− -- A binder which matches an array and binds its elements
450− --
451− | ArrayBinder [Binder]
452− -- |
453− -- A binder which matches an array and binds its head and tail
454− --
455− | ConsBinder Binder Binder
456− -- |
457− -- A binder which binds its input to an identifier
458− --
459− | NamedBinder Ident Binder
460− -- |
461− -- A binder with source position information
462− --
463− | PositionedBinder SourcePos Binder deriving (Show, D.Data, D.Typeable)
464−
465−-- |
466−-- Collect all names introduced in binders in an expression
467−--
468−binderNames :: Binder -> [Ident]
469−binderNames = go []
470− where
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
478− go ns _ = ns
479−
480−--
481−-- Traversals
482−--
483−
48428everywhereOnValues :: (Declaration -> Declaration) ->
48529 (Expr -> Expr) ->
48630 (Binder -> Binder) ->
@@ -545,7 +89,7 @@ everywhereOnValuesTopDownM :: (Functor m, Applicative m, Monad m) =>
54589everywhereOnValuesTopDownM f g h = (f' <=< f, g' <=< g, h' <=< h)
54690 where
54791 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
54993 f' (BindingGroupDeclaration ds) = BindingGroupDeclaration <$> mapM (\(name, nameKind, val) -> (,,) name nameKind <$> (g val >>= g')) ds
55094 f' (TypeClassDeclaration name args implies ds) = TypeClassDeclaration name args implies <$> mapM (f' <=< f) ds
55195 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
837381 forValues (SuperClassDictionary _ tys) = mconcat (map f tys)
838382 forValues (TypedValue _ _ ty) = f ty
839383 forValues _ = mempty
840−
841−