1-----------------------------------------------------------------------------
3-- Module : Language.PureScript.Declarations
4-- Copyright : (c) Phil Freeman 2013
7-- Maintainer : Phil Freeman <paf31@cantab.net>
8-- Stability : experimental
11-- | Data types for modules and declarations
13-----------------------------------------------------------------------------
15{-# LANGUAGE DeriveDataTypeable #-}
17module Language.PureScript.Declarations where
19import Language.PureScript.Values
20import Language.PureScript.Types
21import Language.PureScript.Names
22import Language.PureScript.Kinds
23import Language.PureScript.CodeGen.JS.AST
25import qualified Data.Data as D
28-- A precedence level for an infix operator
30type Precedence = Integer
33-- Associativity for infix operators
35data Associativity = Infixl | Infixr deriving (Show, D.Data, D.Typeable)
38-- Fixity data for infix operators
40data Fixity = Fixity Associativity Precedence deriving (Show, D.Data, D.Typeable)
43-- A module declaration, consisting of a module name and a list of declarations
45data Module = Module ModuleName [Declaration] deriving (Show, D.Data, D.Typeable)
48-- The type of a foreign import
52 -- A regular foreign import
56 -- A foreign import which contains inline Javascript as a string literal
60 -- A type class dictionary import, generated during desugaring of type class declarations
62 | TypeClassDictionaryImport
64 -- A type class dictionary member accessor import, generated during desugaring of type class declarations
66 | TypeClassAccessorImport deriving (Show, Eq, D.Data, D.Typeable)
69-- An item in a list of explicit imports
73 -- A type constructor import
75 = TypeImport ProperName
77 -- A declaration import
80 deriving (Show, D.Data, D.Typeable)
83-- The data type of declarations
87 -- A data type declaration (name, arguments, data constructors)
89 = DataDeclaration ProperName [String] [(ProperName, [Type])]
91 -- A minimal mutually recursive set of data type declarations
93 | DataBindingGroupDeclaration [Declaration]
95 -- A type synonym declaration (name, arguments, type)
97 | TypeSynonymDeclaration ProperName [String] Type
99 -- A type declaration for a value (name, ty)
101 | TypeDeclaration Ident Type
103 -- A value declaration (name, top-level binders, optional guard, value)
105 | ValueDeclaration Ident [Binder] (Maybe Guard) Value
107 -- A minimal mutually recursive set of value declarations
109 | BindingGroupDeclaration [(Ident, Value)]
111 -- A foreign import declaration (type, name, optional inline Javascript, type)
113 | ExternDeclaration ForeignImportType Ident (Maybe JS) Type
115 -- A data type foreign import (name, kind)
117 | ExternDataDeclaration ProperName Kind
119 -- A fixity declaration (fixity data, operator name)
121 | FixityDeclaration Fixity String
123 -- A module import (module name, optional set of identifiers to import)
125 | ImportDeclaration ModuleName (Maybe [ImportType])
127 -- A type class declaration (name, argument, member declarations)
129 | TypeClassDeclaration ProperName [String] [Declaration]
131 -- A type instance declaration (dependencies, class name, instance type, member declarations)
133 | TypeInstanceDeclaration [(Qualified ProperName, [Type])] (Qualified ProperName) [Type] [Declaration]
134 deriving (Show, D.Data, D.Typeable)
137-- Test if a declaration is a value declaration
139isValueDecl :: Declaration -> Bool
140isValueDecl ValueDeclaration{} = True
144-- Test if a declaration is a data type or type synonym declaration
146isDataDecl :: Declaration -> Bool
147isDataDecl DataDeclaration{} = True
148isDataDecl TypeSynonymDeclaration{} = True
152-- Test if a declaration is a module import
154isImportDecl :: Declaration -> Bool
155isImportDecl ImportDeclaration{} = True
156isImportDecl _ = False
159-- Test if a declaration is a data type foreign import
161isExternDataDecl :: Declaration -> Bool
162isExternDataDecl ExternDataDeclaration{} = True
163isExternDataDecl _ = False
166-- Test if a declaration is a fixity declaration
168isFixityDecl :: Declaration -> Bool
169isFixityDecl FixityDeclaration{} = True
170isFixityDecl _ = False
173-- Test if a declaration is a foreign import
175isExternDecl :: Declaration -> Bool
176isExternDecl ExternDeclaration{} = True
177isExternDecl _ = False
180-- Test if a declaration is a type class or instance declaration
182isTypeClassDeclaration :: Declaration -> Bool
183isTypeClassDeclaration TypeClassDeclaration{} = True
184isTypeClassDeclaration TypeInstanceDeclaration{} = True
185isTypeClassDeclaration _ = False
188-- Extracts names from a list of explicit imports.
190nameImports :: [ImportType] -> [Ident]
191nameImports ((NameImport ident):xs) = ident : nameImports xs
192nameImports (_ : xs) = nameImports xs
196-- Extracts types from a list of explicit imports.
198typeImports :: [ImportType] -> [ProperName]
199typeImports (TypeImport ident : xs) = ident : typeImports xs
200typeImports (_ : xs) = typeImports xs
204-- Extracts classes from a list of explicit imports.
205-- note: class imports are indistinguishable from types at the moment
207classImports :: [ImportType] -> [ProperName]
208classImports = typeImports
keysesc to close
- j k
- move down, up
- enter
- open
- esc
- back, or up a level
- 1 2 3 4
- readme, files, commits, refs
- /
- filter
- y
- copy the clone command
- c
- compare the chosen commit with another (or shift-click both)
- ?
- show or hide this list