{-# LANGUAGE DeriveGeneric #-} module Language.PureScript.Environment where import Prelude.Compat import Protolude (ordNub) import GHC.Generics (Generic) import Control.DeepSeq (NFData) import Data.Aeson ((.=), (.:)) import qualified Data.Aeson as A import qualified Data.Map as M import qualified Data.Set as S import Data.Maybe (fromMaybe, mapMaybe) import Data.Text (Text) import qualified Data.Text as T import Data.Tree (Tree, rootLabel) import qualified Data.Graph as G import Data.Foldable (toList, fold) import qualified Data.List.NonEmpty as NEL import Language.PureScript.AST.SourcePos import Language.PureScript.Crash import Language.PureScript.Kinds import Language.PureScript.Names import Language.PureScript.TypeClassDictionaries import Language.PureScript.Types import qualified Language.PureScript.Constants as C -- | The @Environment@ defines all values and types which are currently in scope: data Environment = Environment { names :: M.Map (Qualified Ident) (SourceType, NameKind, NameVisibility) -- ^ Values currently in scope , types :: M.Map (Qualified (ProperName 'TypeName)) (SourceKind, TypeKind) -- ^ Type names currently in scope , dataConstructors :: M.Map (Qualified (ProperName 'ConstructorName)) (DataDeclType, ProperName 'TypeName, SourceType, [Ident]) -- ^ Data constructors currently in scope, along with their associated type -- constructor name, argument types and return type. , typeSynonyms :: M.Map (Qualified (ProperName 'TypeName)) ([(Text, Maybe SourceKind)], SourceType) -- ^ Type synonyms currently in scope , typeClassDictionaries :: M.Map (Maybe ModuleName) (M.Map (Qualified (ProperName 'ClassName)) (M.Map (Qualified Ident) (NEL.NonEmpty NamedDict))) -- ^ Available type class dictionaries. When looking up 'Nothing' in the -- outer map, this returns the map of type class dictionaries in local -- scope (ie dictionaries brought in by a constrained type). , typeClasses :: M.Map (Qualified (ProperName 'ClassName)) TypeClassData -- ^ Type classes , kinds :: S.Set (Qualified (ProperName 'KindName)) -- ^ Kinds in scope } deriving (Show, Generic) instance NFData Environment -- | Information about a type class data TypeClassData = TypeClassData { typeClassArguments :: [(Text, Maybe SourceKind)] -- ^ A list of type argument names, and their kinds, where kind annotations -- were provided. , typeClassMembers :: [(Ident, SourceType)] -- ^ A list of type class members and their types. Type arguments listed above -- are considered bound in these types. , typeClassSuperclasses :: [SourceConstraint] -- ^ A list of superclasses of this type class. Type arguments listed above -- are considered bound in the types appearing in these constraints. , typeClassDependencies :: [FunctionalDependency] -- ^ A list of functional dependencies for the type arguments of this class. , typeClassDeterminedArguments :: S.Set Int -- ^ A set of indexes of type argument that are fully determined by other -- arguments via functional dependencies. This can be computed from both -- typeClassArguments and typeClassDependencies. , typeClassCoveringSets :: S.Set (S.Set Int) -- ^ A sets of arguments that can be used to infer all other arguments. } deriving (Show, Generic) instance NFData TypeClassData -- | A functional dependency indicates a relationship between two sets of -- type arguments in a class declaration. data FunctionalDependency = FunctionalDependency { fdDeterminers :: [Int] -- ^ the type arguments which determine the determined type arguments , fdDetermined :: [Int] -- ^ the determined type arguments } deriving (Show, Generic) instance NFData FunctionalDependency instance A.FromJSON FunctionalDependency where parseJSON = A.withObject "FunctionalDependency" $ \o -> FunctionalDependency <$> o .: "determiners" <*> o .: "determined" instance A.ToJSON FunctionalDependency where toJSON FunctionalDependency{..} = A.object [ "determiners" .= fdDeterminers , "determined" .= fdDetermined ] -- | The initial environment with no values and only the default javascript types defined initEnvironment :: Environment initEnvironment = Environment M.empty allPrimTypes M.empty M.empty M.empty allPrimClasses allPrimKinds -- | A constructor for TypeClassData that computes which type class arguments are fully determined -- and argument covering sets. -- Fully determined means that this argument cannot be used when selecting a type class instance. -- A covering set is a minimal collection of arguments that can be used to find an instance and -- therefore determine all other type arguments. -- -- An example of the difference between determined and fully determined would be with the class: -- ```class C a b c | a -> b, b -> a, b -> c``` -- In this case, `a` must differ when `b` differs, and vice versa - each is determined by the other. -- Both `a` and `b` can be used in selecting a type class instance. However, `c` cannot - it is -- fully determined by `a` and `b`. -- -- Define a graph of type class arguments with edges being fundep determiners to determined. Each -- argument also has a self looping edge. -- An argument is fully determined if doesn't appear at the start of a path of strongly connected components. -- An argument is not fully determined otherwise. -- -- The way we compute this is by saying: an argument X is fully determined if there are arguments that -- determine X that X does not determine. This is the same thing: everything X determines includes everything -- in its SCC, and everything determining X is either before it in an SCC path, or in the same SCC. makeTypeClassData :: [(Text, Maybe SourceKind)] -> [(Ident, SourceType)] -> [SourceConstraint] -> [FunctionalDependency] -> TypeClassData makeTypeClassData args m s deps = TypeClassData args m s deps determinedArgs coveringSets where argumentIndicies = [0 .. length args - 1] -- each argument determines themselves identities = (\i -> (i, [i])) <$> argumentIndicies -- list all the edges in the graph: for each fundep an edge exists for each determiner to each determined contributingDeps = M.fromListWith (++) $ identities ++ do fd <- deps src <- fdDeterminers fd (src, fdDetermined fd) : map (, []) (fdDetermined fd) -- build a graph of which arguments determine other arguments (depGraph, fromVertex, fromKey) = G.graphFromEdges ((\(n, v) -> (n, n, ordNub v)) <$> M.toList contributingDeps) -- do there exist any arguments that contribute to `arg` that `arg` doesn't contribute to isFunDepDetermined :: Int -> Bool isFunDepDetermined arg = case fromKey arg of Nothing -> internalError "Unknown argument index in makeTypeClassData" Just v -> let contributesToVar = G.reachable (G.transposeG depGraph) v varContributesTo = G.reachable depGraph v in any (\r -> not (r `elem` varContributesTo)) contributesToVar -- find all the arguments that are determined determinedArgs :: S.Set Int determinedArgs = S.fromList $ filter isFunDepDetermined argumentIndicies argFromVertex :: G.Vertex -> Int argFromVertex index = let (_, arg, _) = fromVertex index in arg isVertexDetermined :: G.Vertex -> Bool isVertexDetermined = isFunDepDetermined . argFromVertex -- from an scc find the non-determined args sccNonDetermined :: Tree G.Vertex -> Maybe [Int] sccNonDetermined tree -- if any arg in an scc is determined then all of them are | isVertexDetermined (rootLabel tree) = Nothing | otherwise = Just (argFromVertex <$> toList tree) -- find the covering sets coveringSets :: S.Set (S.Set Int) coveringSets = let funDepSets = sequence (mapMaybe sccNonDetermined (G.scc depGraph)) in S.fromList (S.fromList <$> funDepSets) -- | The visibility of a name in scope data NameVisibility = Undefined -- ^ The name is defined in the current binding group, but is not visible | Defined -- ^ The name is defined in the another binding group, or has been made visible by a function binder deriving (Show, Eq, Generic) instance NFData NameVisibility -- | A flag for whether a name is for an private or public value - only public values will be -- included in a generated externs file. data NameKind = Private -- ^ A private value introduced as an artifact of code generation (class instances, class member -- accessors, etc.) | Public -- ^ A public value for a module member or foreing import declaration | External -- ^ A name for member introduced by foreign import deriving (Show, Eq, Generic) instance NFData NameKind -- | The kinds of a type data TypeKind = DataType [(Text, Maybe SourceKind)] [(ProperName 'ConstructorName, [SourceType])] -- ^ Data type | TypeSynonym -- ^ Type synonym | ExternData -- ^ Foreign data | LocalTypeVariable -- ^ A local type variable | ScopedTypeVar -- ^ A scoped type variable deriving (Show, Eq, Generic) instance NFData TypeKind instance A.ToJSON TypeKind where toJSON (DataType args ctors) = A.object [ T.pack "DataType" .= A.object ["args" .= args, "ctors" .= ctors] ] toJSON TypeSynonym = A.toJSON (T.pack "TypeSynonym") toJSON ExternData = A.toJSON (T.pack "ExternData") toJSON LocalTypeVariable = A.toJSON (T.pack "LocalTypeVariable") toJSON ScopedTypeVar = A.toJSON (T.pack "ScopedTypeVar") instance A.FromJSON TypeKind where parseJSON (A.Object o) = do args <- o .: "DataType" A.withObject "args" (\o1 -> DataType <$> o1 .: "args" <*> o1 .: "ctors") args parseJSON (A.String s) = case s of "TypeSynonym" -> pure TypeSynonym "ExternData" -> pure ExternData "LocalTypeVariable" -> pure LocalTypeVariable "ScopedTypeVar" -> pure ScopedTypeVar _ -> fail "Unknown TypeKind" parseJSON _ = fail "Invalid TypeKind" -- | The type ('data' or 'newtype') of a data type declaration data DataDeclType = Data -- ^ A standard data constructor | Newtype -- ^ A newtype constructor deriving (Show, Eq, Ord, Generic) instance NFData DataDeclType showDataDeclType :: DataDeclType -> Text showDataDeclType Data = "data" showDataDeclType Newtype = "newtype" instance A.ToJSON DataDeclType where toJSON = A.toJSON . showDataDeclType instance A.FromJSON DataDeclType where parseJSON = A.withText "DataDeclType" $ \str -> case str of "data" -> return Data "newtype" -> return Newtype other -> fail $ "invalid type: '" ++ T.unpack other ++ "'" -- | Construct a ProperName in the Prim module primName :: Text -> Qualified (ProperName a) primName = Qualified (Just $ ModuleName [ProperName C.prim]) . ProperName -- | Construct a 'ProperName' in the @Prim.NAME@ module. primSubName :: Text -> Text -> Qualified (ProperName a) primSubName sub = Qualified (Just $ ModuleName [ProperName C.prim, ProperName sub]) . ProperName primKind :: Text -> SourceKind primKind = NamedKind nullSourceAnn . primName primSubKind :: Text -> Text -> SourceKind primSubKind sub = NamedKind nullSourceAnn . primSubName sub -- | Kind of ground types kindType :: SourceKind kindType = primKind C.typ kindConstraint :: SourceKind kindConstraint = kindType isKindType :: Kind a -> Bool isKindType (NamedKind _ n) = n == primName C.typ isKindType _ = False -- To make reading the kind signatures below easier (-:>) :: SourceKind -> SourceKind -> SourceKind (-:>) = FunKind nullSourceAnn infixr 4 -:> kindSymbol :: SourceKind kindSymbol = primKind C.symbol kindDoc :: SourceKind kindDoc = primSubKind C.typeError C.doc kindBoolean :: SourceKind kindBoolean = primSubKind C.moduleBoolean C.kindBoolean kindOrdering :: SourceKind kindOrdering = primSubKind C.moduleOrdering C.kindOrdering kindRowList :: SourceKind kindRowList = primSubKind C.moduleRowList C.kindRowList kindRow :: SourceKind -> SourceKind kindRow = Row nullSourceAnn -- | Construct a type in the Prim module primTy :: Text -> SourceType primTy = TypeConstructor nullSourceAnn . primName -- | Type constructor for functions tyFunction :: SourceType tyFunction = primTy "Function" -- | Type constructor for strings tyString :: SourceType tyString = primTy "String" -- | Type constructor for strings tyChar :: SourceType tyChar = primTy "Char" -- | Type constructor for numbers tyNumber :: SourceType tyNumber = primTy "Number" -- | Type constructor for integers tyInt :: SourceType tyInt = primTy "Int" -- | Type constructor for booleans tyBoolean :: SourceType tyBoolean = primTy "Boolean" -- | Type constructor for arrays tyArray :: SourceType tyArray = primTy "Array" -- | Type constructor for records tyRecord :: SourceType tyRecord = primTy "Record" -- | Check whether a type is a record isObject :: Type a -> Bool isObject = isTypeOrApplied tyRecord -- | Check whether a type is a function isFunction :: Type a -> Bool isFunction = isTypeOrApplied tyFunction isTypeOrApplied :: Type a -> Type b -> Bool isTypeOrApplied t1 (TypeApp _ t2 _) = eqType t1 t2 isTypeOrApplied t1 t2 = eqType t1 t2 -- | Smart constructor for function types function :: SourceType -> SourceType -> SourceType function t1 t2 = TypeApp nullSourceAnn (TypeApp nullSourceAnn tyFunction t1) t2 -- | Kinds in @Prim@ primKinds :: S.Set (Qualified (ProperName 'KindName)) primKinds = S.fromList [ primName C.typ , primName C.symbol ] -- | Kinds in @Prim.Boolean@ primBooleanKinds :: S.Set (Qualified (ProperName 'KindName)) primBooleanKinds = S.fromList [ primSubName C.moduleBoolean C.kindBoolean ] -- | Kinds in @Prim.Ordering@ primOrderingKinds :: S.Set (Qualified (ProperName 'KindName)) primOrderingKinds = S.fromList [ primSubName C.moduleOrdering C.kindOrdering ] -- | Kinds in @Prim.RowList@ primRowListKinds :: S.Set (Qualified (ProperName 'KindName)) primRowListKinds = S.fromList [ primSubName C.moduleRowList C.kindRowList ] -- | Kinds in @Prim.TypeError@ primTypeErrorKinds :: S.Set (Qualified (ProperName 'KindName)) primTypeErrorKinds = S.fromList [ primSubName C.typeError C.doc ] -- | All primitive kinds allPrimKinds :: S.Set (Qualified (ProperName 'KindName)) allPrimKinds = fold [ primKinds , primBooleanKinds , primOrderingKinds , primRowListKinds , primTypeErrorKinds ] -- | The primitive types in the external javascript environment with their -- associated kinds. There are also pseudo `Fail`, `Warn`, and `Partial` types -- that correspond to the classes with the same names. primTypes :: M.Map (Qualified (ProperName 'TypeName)) (SourceKind, TypeKind) primTypes = M.fromList [ (primName "Function", (kindType -:> kindType -:> kindType, ExternData)) , (primName "Array", (kindType -:> kindType, ExternData)) , (primName "Record", (kindRow kindType -:> kindType, ExternData)) , (primName "String", (kindType, ExternData)) , (primName "Char", (kindType, ExternData)) , (primName "Number", (kindType, ExternData)) , (primName "Int", (kindType, ExternData)) , (primName "Boolean", (kindType, ExternData)) , (primName "Partial", (kindConstraint, ExternData)) ] -- | This 'Map' contains all of the prim types from all Prim modules. allPrimTypes :: M.Map (Qualified (ProperName 'TypeName)) (SourceKind, TypeKind) allPrimTypes = M.unions [ primTypes , primBooleanTypes , primOrderingTypes , primRowTypes , primRowListTypes , primSymbolTypes , primTypeErrorTypes ] primBooleanTypes :: M.Map (Qualified (ProperName 'TypeName)) (SourceKind, TypeKind) primBooleanTypes = M.fromList [ (primSubName C.moduleBoolean "True", (kindBoolean, ExternData)) , (primSubName C.moduleBoolean "False", (kindBoolean, ExternData)) ] primOrderingTypes :: M.Map (Qualified (ProperName 'TypeName)) (SourceKind, TypeKind) primOrderingTypes = M.fromList [ (primSubName C.moduleOrdering "LT", (kindOrdering, ExternData)) , (primSubName C.moduleOrdering "EQ", (kindOrdering, ExternData)) , (primSubName C.moduleOrdering "GT", (kindOrdering, ExternData)) ] primRowTypes :: M.Map (Qualified (ProperName 'TypeName)) (SourceKind, TypeKind) primRowTypes = M.fromList [ (primSubName C.moduleRow "Union", (kindRow kindType -:> kindRow kindType -:> kindRow kindType -:> kindConstraint, ExternData)) , (primSubName C.moduleRow "Nub", (kindRow kindType -:> kindRow kindType -:> kindConstraint, ExternData)) , (primSubName C.moduleRow "Lacks", (kindSymbol -:> kindRow kindType -:> kindConstraint, ExternData)) , (primSubName C.moduleRow "Cons", (kindSymbol -:> kindType -:> kindRow kindType -:> kindRow kindType -:> kindConstraint, ExternData)) ] primRowListTypes :: M.Map (Qualified (ProperName 'TypeName)) (SourceKind, TypeKind) primRowListTypes = M.fromList [ (primSubName C.moduleRowList "Cons", (kindSymbol -:> kindType -:> kindRowList -:> kindRowList, ExternData)) , (primSubName C.moduleRowList "Nil", (kindRowList, ExternData)) , (primSubName C.moduleRowList "RowToList", (kindRow kindType -:> kindRowList -:> kindConstraint, ExternData)) ] primSymbolTypes :: M.Map (Qualified (ProperName 'TypeName)) (SourceKind, TypeKind) primSymbolTypes = M.fromList [ (primSubName C.moduleSymbol "Append", (kindSymbol -:> kindSymbol -:> kindSymbol -:> kindConstraint, ExternData)) , (primSubName C.moduleSymbol "Compare", (kindSymbol -:> kindSymbol -:> kindOrdering -:> kindConstraint, ExternData)) , (primSubName C.moduleSymbol "Cons", (kindSymbol -:> kindSymbol -:> kindSymbol -:> kindConstraint, ExternData)) ] primTypeErrorTypes :: M.Map (Qualified (ProperName 'TypeName)) (SourceKind, TypeKind) primTypeErrorTypes = M.fromList [ (primSubName C.typeError "Fail", (kindDoc -:> kindConstraint, ExternData)) , (primSubName C.typeError "Warn", (kindDoc -:> kindConstraint, ExternData)) , (primSubName C.typeError "Text", (kindSymbol -:> kindDoc, ExternData)) , (primSubName C.typeError "Quote", (kindType -:> kindDoc, ExternData)) , (primSubName C.typeError "QuoteLabel", (kindSymbol -:> kindDoc, ExternData)) , (primSubName C.typeError "Beside", (kindDoc -:> kindDoc -:> kindDoc, ExternData)) , (primSubName C.typeError "Above", (kindDoc -:> kindDoc -:> kindDoc, ExternData)) ] -- | The primitive class map. This just contains the `Partial` class. -- `Partial` is used as a kind of magic constraint for partial functions. primClasses :: M.Map (Qualified (ProperName 'ClassName)) TypeClassData primClasses = M.fromList [ (primName "Partial", (makeTypeClassData [] [] [] [])) ] -- | This contains all of the type classes from all Prim modules. allPrimClasses :: M.Map (Qualified (ProperName 'ClassName)) TypeClassData allPrimClasses = M.unions [ primClasses , primRowClasses , primRowListClasses , primSymbolClasses , primTypeErrorClasses ] primRowClasses :: M.Map (Qualified (ProperName 'ClassName)) TypeClassData primRowClasses = M.fromList -- class Union (left :: # Type) (right :: # Type) (union :: # Type) | left right -> union, right union -> left, union left -> right [ (primSubName C.moduleRow "Union", makeTypeClassData [ ("left", Just (kindRow kindType)) , ("right", Just (kindRow kindType)) , ("union", Just (kindRow kindType)) ] [] [] [ FunctionalDependency [0, 1] [2] , FunctionalDependency [1, 2] [0] , FunctionalDependency [2, 0] [1] ]) -- class Nub (original :: # Type) (nubbed :: # Type) | i -> o , (primSubName C.moduleRow "Nub", makeTypeClassData [ ("original", Just (kindRow kindType)) , ("nubbed", Just (kindRow kindType)) ] [] [] [ FunctionalDependency [0] [1] ]) -- class Lacks (label :: Symbol) (row :: # Type) , (primSubName C.moduleRow "Lacks", makeTypeClassData [ ("label", Just kindSymbol) , ("row", Just (kindRow kindType)) ] [] [] []) -- class RowCons (label :: Symbol) (a :: Type) (tail :: # Type) (row :: # Type) | label tail a -> row, label row -> tail a , (primSubName C.moduleRow "Cons", makeTypeClassData [ ("label", Just kindSymbol) , ("a", Just kindType) , ("tail", Just (kindRow kindType)) , ("row", Just (kindRow kindType)) ] [] [] [ FunctionalDependency [0, 1, 2] [3] , FunctionalDependency [0, 3] [1, 2] ]) ] primRowListClasses :: M.Map (Qualified (ProperName 'ClassName)) TypeClassData primRowListClasses = M.fromList -- class RowToList (row :: # Type) (list :: RowList) | row -> list [ (primSubName C.moduleRowList "RowToList", makeTypeClassData [ ("row", Just (kindRow kindType)) , ("list", Just kindRowList) ] [] [] [ FunctionalDependency [0] [1] ]) ] primSymbolClasses :: M.Map (Qualified (ProperName 'ClassName)) TypeClassData primSymbolClasses = M.fromList -- class Append (left :: Symbol) (right :: Symbol) (appended :: Symbol) | left right -> appended, right appended -> left, appended left -> right [ (primSubName C.moduleSymbol "Append", makeTypeClassData [ ("left", Just kindSymbol) , ("right", Just kindSymbol) , ("appended", Just kindSymbol) ] [] [] [ FunctionalDependency [0, 1] [2] , FunctionalDependency [1, 2] [0] , FunctionalDependency [2, 0] [1] ]) -- class Compare (left :: Symbol) (right :: Symbol) (ordering :: Ordering) | left right -> ordering , (primSubName C.moduleSymbol "Compare", makeTypeClassData [ ("left", Just kindSymbol) , ("right", Just kindSymbol) , ("ordering", Just kindOrdering) ] [] [] [ FunctionalDependency [0, 1] [2] ]) -- class Cons (head :: Symbol) (tail :: Symbol) (symbol :: Symbol) | head tail -> symbol, symbol -> head tail , (primSubName C.moduleSymbol "Cons", makeTypeClassData [ ("head", Just kindSymbol) , ("tail", Just kindSymbol) , ("symbol", Just kindSymbol) ] [] [] [ FunctionalDependency [0, 1] [2] , FunctionalDependency [2] [0, 1] ]) ] primTypeErrorClasses :: M.Map (Qualified (ProperName 'ClassName)) TypeClassData primTypeErrorClasses = M.fromList -- class Fail (message :: Symbol) [ (primSubName C.typeError "Fail", makeTypeClassData [("message", Just kindDoc)] [] [] []) -- class Warn (message :: Symbol) , (primSubName C.typeError "Warn", makeTypeClassData [("message", Just kindDoc)] [] [] []) ] -- | Finds information about data constructors from the current environment. lookupConstructor :: Environment -> Qualified (ProperName 'ConstructorName) -> (DataDeclType, ProperName 'TypeName, SourceType, [Ident]) lookupConstructor env ctor = fromMaybe (internalError "Data constructor not found") $ ctor `M.lookup` dataConstructors env -- | Checks whether a data constructor is for a newtype. isNewtypeConstructor :: Environment -> Qualified (ProperName 'ConstructorName) -> Bool isNewtypeConstructor e ctor = case lookupConstructor e ctor of (Newtype, _, _, _) -> True (Data, _, _, _) -> False -- | Finds information about values from the current environment. lookupValue :: Environment -> Qualified Ident -> Maybe (SourceType, NameKind, NameVisibility) lookupValue env ident = ident `M.lookup` names env