Use OPTIONS rather than OPTIONS_GHC for pragmas
[ghc-hetmet.git] / compiler / iface / BuildTyCl.lhs
index 5f23fd5..242772f 100644 (file)
@@ -1,66 +1,73 @@
 %
+% (c) The University of Glasgow 2006
 % (c) The GRASP/AQUA Project, Glasgow University, 1992-1998
 %
 
 \begin{code}
+{-# OPTIONS -w #-}
+-- The above warning supression flag is a temporary kludge.
+-- While working on this module you are encouraged to remove it and fix
+-- any warnings in the module. See
+--     http://hackage.haskell.org/trac/ghc/wiki/CodingStyle#Warnings
+-- for details
+
 module BuildTyCl (
        buildSynTyCon, buildAlgTyCon, buildDataCon,
        buildClass,
-       mkAbstractTyConRhs, mkOpenDataTyConRhs, mkOpenNewTyConRhs,
+       mkAbstractTyConRhs, mkOpenDataTyConRhs, 
        mkNewTyConRhs, mkDataTyConRhs 
     ) where
 
 #include "HsVersions.h"
 
-import IfaceEnv                ( newImplicitBinder )
+import IfaceEnv
 import TcRnMonad
 
-import DataCon         ( DataCon, isNullarySrcDataCon, dataConUnivTyVars,
-                         mkDataCon, dataConFieldLabels, dataConInstOrigArgTys,
-                          dataConTyCon )
-import Var             ( tyVarKind, TyVar, Id )
-import VarSet          ( isEmptyVarSet, intersectVarSet, elemVarSet )
-import TysWiredIn      ( unitTy )
-import BasicTypes      ( RecFlag, StrictnessMark(..) )
-import Name            ( Name )
-import OccName         ( mkDataConWrapperOcc, mkDataConWorkerOcc,
-                         mkClassTyConOcc, mkClassDataConOcc,
-                         mkSuperDictSelOcc, mkNewTyCoOcc, mkInstTyTcOcc,
-                         mkInstTyCoOcc ) 
-import MkId            ( mkDataConIds, mkRecordSelId, mkDictSelId )
-import Class           ( mkClass, Class( classTyCon), FunDep, DefMeth(..) )
-import TyCon           ( mkSynTyCon, mkAlgTyCon, visibleDataCons,
-                         tyConStupidTheta, tyConDataCons, isNewTyCon,
-                         mkClassTyCon, TyCon( tyConTyVars ),
-                         isRecursiveTyCon, tyConArity, AlgTyConRhs(..),
-                         SynTyConRhs(..), newTyConRhs, AlgTyConParent(..) )
-import Type            ( mkArrowKinds, liftedTypeKind, typeKind, 
-                         tyVarsOfType, tyVarsOfTypes, tyVarsOfPred,
-                         splitTyConApp_maybe, splitAppTy_maybe,
-                         getTyVar_maybe, 
-                         mkPredTys, mkTyVarTys, ThetaType, Type, Kind,
-                         TyThing(..), 
-                         substTyWith, zipTopTvSubst, substTheta, mkForAllTys,
-                          mkTyConApp, mkTyVarTy )
-import Coercion         ( mkNewTypeCoercion, mkDataInstCoercion )
+import DataCon
+import Var
+import VarSet
+import TysWiredIn
+import BasicTypes
+import Name
+import OccName
+import MkId
+import Class
+import TyCon
+import Type
+import Coercion
+
+import TcRnMonad
 import Outputable
-import List            ( nub )
 
+import Data.List
 \end{code}
        
 
 \begin{code}
 ------------------------------------------------------
-buildSynTyCon :: Name -> [TyVar] -> SynTyConRhs -> TyCon
-buildSynTyCon name tvs rhs@(OpenSynTyCon rhs_ki)
-  = mkSynTyCon name kind tvs rhs
-  where
-    kind = mkArrowKinds (map tyVarKind tvs) rhs_ki
-buildSynTyCon name tvs rhs@(SynonymTyCon rhs_ty)
-  = mkSynTyCon name kind tvs rhs
-  where
-    kind = mkArrowKinds (map tyVarKind tvs) (typeKind rhs_ty)
-
+buildSynTyCon :: Name -> [TyVar] 
+              -> SynTyConRhs 
+             -> Maybe (TyCon, [Type])  -- family instance if applicable
+              -> TcRnIf m n TyCon
+
+buildSynTyCon tc_name tvs rhs@(OpenSynTyCon rhs_ki _) _
+  = let
+      kind = mkArrowKinds (map tyVarKind tvs) rhs_ki
+    in
+    return $ mkSynTyCon tc_name kind tvs rhs NoParentTyCon
+    
+buildSynTyCon tc_name tvs rhs@(SynonymTyCon rhs_ty) mb_family
+  = do { -- We need to tie a knot as the coercion of a data instance depends
+        -- on the instance representation tycon and vice versa.
+       ; tycon <- fixM (\ tycon_rec -> do 
+        { parent <- mkParentInfo mb_family tc_name tvs tycon_rec
+        ; let { tycon   = mkSynTyCon tc_name kind tvs rhs parent
+              ; kind    = mkArrowKinds (map tyVarKind tvs) (typeKind rhs_ty)
+              }
+         ; return tycon
+         })
+       ; return tycon 
+       }
 
 ------------------------------------------------------
 buildAlgTyCon :: Name -> [TyVar] 
@@ -69,8 +76,7 @@ buildAlgTyCon :: Name -> [TyVar]
              -> RecFlag
              -> Bool                   -- True <=> want generics functions
              -> Bool                   -- True <=> was declared in GADT syntax
-             -> Maybe (TyCon, [Type])  -- Just (family, tys) 
-                                       -- <=> instance of `family' at `tys'
+             -> Maybe (TyCon, [Type])  -- family instance if applicable
              -> TcRnIf m n TyCon
 
 buildAlgTyCon tc_name tvs stupid_theta rhs is_rec want_generics gadt_syn
@@ -78,8 +84,8 @@ buildAlgTyCon tc_name tvs stupid_theta rhs is_rec want_generics gadt_syn
   = do { -- We need to tie a knot as the coercion of a data instance depends
         -- on the instance representation tycon and vice versa.
        ; tycon <- fixM (\ tycon_rec -> do 
-        { (final_name, parent) <- maybeComputeFamilyInfo mb_family tycon_rec
-        ; let { tycon = mkAlgTyCon final_name kind tvs stupid_theta rhs
+        { parent <- mkParentInfo mb_family tc_name tvs tycon_rec
+        ; let { tycon = mkAlgTyCon tc_name kind tvs stupid_theta rhs
                                    fields parent is_rec want_generics gadt_syn
               ; kind    = mkArrowKinds (map tyVarKind tvs) liftedTypeKind
               ; fields  = mkTyConSelIds tycon rhs
@@ -88,46 +94,38 @@ buildAlgTyCon tc_name tvs stupid_theta rhs is_rec want_generics gadt_syn
          })
        ; return tycon 
        }
-  where
-    -- If a family tycon with instance types is given, the current tycon is an
-    -- instance of that family and we have to perform three extra tasks:
-    --
-    -- (1) The instance tycon (representing the family at a particular type
-    --     instance) need to get a new, derived name - we may not reuse the
-    --     family name.
-    -- (2) Create a coercion that identifies the family instance type and the
-    --     representation type from Step (1); ie, it is of the form 
-    --    `Co tvs :: F ts :=: R tvs', where `Co' is the name of the coercion,
-    --    `F' the family tycon and `R' the (derived) representation tycon.
-    -- (3) Produce a `AlgTyConParent' value containing the parent and coercion
-    --     information.
-    --
-    maybeComputeFamilyInfo Nothing                  rep_tycon = 
-      return (tc_name, NoParentTyCon)
-    maybeComputeFamilyInfo (Just (family, instTys)) rep_tycon =
-      do { -- (1) New, derived name for the instance tycon
-        ; uniq <- newUnique
-        ; final_name <- newImplicitBinder tc_name (mkInstTyTcOcc uniq)
-
-          -- (2) Create the coercion.
-        ; co_tycon_name <- newImplicitBinder tc_name (mkInstTyCoOcc uniq)
-        ; let co_tycon = mkDataInstCoercion co_tycon_name tvs
-                                            family instTys rep_tycon
-
-          -- (3) Produce parent information.
-        ; return (final_name, FamilyTyCon family instTys co_tycon)
-        }
-    
 
+-- If a family tycon with instance types is given, the current tycon is an
+-- instance of that family and we need to
+--
+-- (1) create a coercion that identifies the family instance type and the
+--     representation type from Step (1); ie, it is of the form 
+--        `Co tvs :: F ts :=: R tvs', where `Co' is the name of the coercion,
+--        `F' the family tycon and `R' the (derived) representation tycon,
+--        and
+-- (2) produce a `TyConParent' value containing the parent and coercion
+--     information.
+--
+mkParentInfo :: Maybe (TyCon, [Type]) 
+             -> Name -> [TyVar] 
+             -> TyCon 
+             -> TcRnIf m n TyConParent
+mkParentInfo Nothing                  _       _   _         =
+  return NoParentTyCon
+mkParentInfo (Just (family, instTys)) tc_name tvs rep_tycon =
+  do { -- Create the coercion
+     ; co_tycon_name <- newImplicitBinder tc_name mkInstTyCoOcc
+     ; let co_tycon = mkFamInstCoercion co_tycon_name tvs
+                                        family instTys rep_tycon
+     ; return $ FamilyTyCon family instTys co_tycon
+     }
+    
 ------------------------------------------------------
 mkAbstractTyConRhs :: AlgTyConRhs
 mkAbstractTyConRhs = AbstractTyCon
 
 mkOpenDataTyConRhs :: AlgTyConRhs
-mkOpenDataTyConRhs = OpenDataTyCon
-
-mkOpenNewTyConRhs :: AlgTyConRhs
-mkOpenNewTyConRhs = OpenNewTyCon
+mkOpenDataTyConRhs = OpenTyCon Nothing
 
 mkDataTyConRhs :: [DataCon] -> AlgTyConRhs
 mkDataTyConRhs cons
@@ -139,41 +137,49 @@ mkNewTyConRhs :: Name -> TyCon -> DataCon -> TcRnIf m n AlgTyConRhs
 -- because the latter is part of a knot, whereas the former is not.
 mkNewTyConRhs tycon_name tycon con 
   = do { co_tycon_name <- newImplicitBinder tycon_name mkNewTyCoOcc
-       ; let co_tycon = mkNewTypeCoercion co_tycon_name tycon tvs rhs_ty
-              cocon_maybe 
-                | all_coercions || isRecursiveTyCon tycon 
-                = Just co_tycon
-                | otherwise              
-                = Nothing
-       ; return (NewTyCon { data_con = con, 
-                            nt_co = cocon_maybe, 
+       ; let co_tycon = mkNewTypeCoercion co_tycon_name tycon etad_tvs etad_rhs
+              cocon_maybe | all_coercions || isRecursiveTyCon tycon 
+                         = Just co_tycon
+                         | otherwise              
+                         = Nothing
+       ; traceIf (text "mkNewTyConRhs" <+> ppr cocon_maybe)
+       ; return (NewTyCon { data_con    = con, 
+                            nt_rhs      = rhs_ty,
+                            nt_etad_rhs = (etad_tvs, etad_rhs),
+                            nt_co       = cocon_maybe, 
                              -- Coreview looks through newtypes with a Nothing
                              -- for nt_co, or uses explicit coercions otherwise
-                            nt_rhs = rhs_ty,
-                            nt_etad_rhs = eta_reduce tvs rhs_ty,
                             nt_rep = mkNewTyConRep tycon rhs_ty }) }
   where
-        -- if all_coercions is True then we use coercions for all newtypes
+        -- If all_coercions is True then we use coercions for all newtypes
         -- otherwise we use coercions for recursive newtypes and look through
         -- non-recursive newtypes
     all_coercions = True
     tvs    = tyConTyVars tycon
-    rhs_ty = head (dataConInstOrigArgTys con (mkTyVarTys tvs))
+    rhs_ty = ASSERT(not (null (dataConInstOrigDictsAndArgTys con (mkTyVarTys tvs)))) 
+            -- head (dataConInstOrigArgTys con (mkTyVarTys tvs))
+            head (dataConInstOrigDictsAndArgTys con (mkTyVarTys tvs))
        -- Instantiate the data con with the 
        -- type variables from the tycon
-
-    eta_reduce [] ty = ([], ty)
-    eta_reduce (a:as) ty | null as', 
-                          Just (fun, arg) <- splitAppTy_maybe ty',
+       -- NB: a newtype DataCon has no existentials; hence the
+       --     call to dataConInstOrigArgTys has the right type args
+
+    etad_tvs :: [TyVar]        -- Matched lazily, so that mkNewTypeCoercion can
+    etad_rhs :: Type   -- return a TyCon without pulling on rhs_ty
+                       -- See Note [Tricky iface loop] in LoadIface
+    (etad_tvs, etad_rhs) = eta_reduce (reverse tvs) rhs_ty
+    eta_reduce :: [TyVar]              -- Reversed
+              -> Type                  -- Rhs type
+              -> ([TyVar], Type)       -- Eta-reduced version (tyvars in normal order)
+    eta_reduce (a:as) ty | Just (fun, arg) <- splitAppTy_maybe ty,
                           Just tv <- getTyVar_maybe arg,
                           tv == a,
                           not (a `elemVarSet` tyVarsOfType fun)
-                        = ([], fun)    -- Successful eta reduction
-                        | otherwise
-                        = (a:as', ty')
-       where
-         (as', ty') = eta_reduce as ty
+                        = eta_reduce as fun
+    eta_reduce tvs ty = (reverse tvs, ty)
                                
+
 mkNewTyConRep :: TyCon         -- The original type constructor
              -> Type           -- The arg type of its constructor
              -> Type           -- Chosen representation type
@@ -281,49 +287,53 @@ buildClass :: Name -> [TyVar] -> ThetaType
           -> TcRnIf m n Class
 
 buildClass class_name tvs sc_theta fds ats sig_stuff tc_isrec
-  = do { tycon_name <- newImplicitBinder class_name mkClassTyConOcc
+  = do { traceIf (text "buildClass")
+       ; tycon_name <- newImplicitBinder class_name mkClassTyConOcc
        ; datacon_name <- newImplicitBinder class_name mkClassDataConOcc
                -- The class name is the 'parent' for this datacon, not its tycon,
                -- because one should import the class to get the binding for 
                -- the datacon
-       ; sc_sel_names <- mapM (newImplicitBinder class_name . mkSuperDictSelOcc) 
-                               [1..length sc_theta]
-             -- We number off the superclass selectors, 1, 2, 3 etc so that we 
-             -- can construct names for the selectors.  Thus
-             --      class (C a, C b) => D a b where ...
-             -- gives superclass selectors
-             --      D_sc1, D_sc2
-             -- (We used to call them D_C, but now we can have two different
-             --  superclasses both called C!)
 
        ; fixM (\ rec_clas -> do {      -- Only name generation inside loop
 
-         let { rec_tycon          = classTyCon rec_clas
-             ; op_tys             = [ty | (_,_,ty) <- sig_stuff]
-             ; sc_tys             = mkPredTys sc_theta
-             ; dict_component_tys = sc_tys ++ op_tys
-             ; sc_sel_ids         = [mkDictSelId sc_name rec_clas | sc_name <- sc_sel_names]
-             ; op_items = [ (mkDictSelId op_name rec_clas, dm_info)
-                          | (op_name, dm_info, _) <- sig_stuff ] }
+         let { rec_tycon  = classTyCon rec_clas
+             ; op_tys     = [ty | (_,_,ty) <- sig_stuff]
+             ; op_items   = [ (mkDictSelId op_name rec_clas, dm_info)
+                            | (op_name, dm_info, _) <- sig_stuff ] }
                        -- Build the selector id and default method id
 
        ; dict_con <- buildDataCon datacon_name
                                   False        -- Not declared infix
-                                  (map (const NotMarkedStrict) dict_component_tys)
+                                  (map (const NotMarkedStrict) op_tys)
                                   [{- No labelled fields -}]
                                   tvs [{- no existentials -}]
-                                   [{- No equalities -}] [{-No context-}] 
-                                   dict_component_tys 
+                                   [{- No GADT equalities -}] sc_theta 
+                                   op_tys
                                   rec_tycon
 
-       ; rhs <- case dict_component_tys of
-                           [rep_ty] -> mkNewTyConRhs tycon_name rec_tycon dict_con
-                           other    -> return (mkDataTyConRhs [dict_con])
+       ; sc_sel_names <- mapM (newImplicitBinder class_name . mkSuperDictSelOcc) 
+                               [1..length (dataConDictTheta dict_con)]
+             -- We number off the Dict superclass selectors, 1, 2, 3 etc so that we 
+             -- can construct names for the selectors.  Thus
+             --      class (C a, C b) => D a b where ...
+             -- gives superclass selectors
+             --      D_sc1, D_sc2
+             -- (We used to call them D_C, but now we can have two different
+             --  superclasses both called C!)
+        ; let sc_sel_ids = [mkDictSelId sc_name rec_clas | sc_name <- sc_sel_names]
+
+               -- Use a newtype if the class constructor has exactly one field:
+               -- i.e. exactly one operation or superclass taken together
+               -- Watch out: the sc_theta includes equality predicates,
+               --            which don't count for this purpose; hence dataConDictTheta
+       ; rhs <- if ((length $ dataConDictTheta dict_con) + length sig_stuff) == 1
+                then mkNewTyConRhs tycon_name rec_tycon dict_con
+                else return (mkDataTyConRhs [dict_con])
 
        ; let { clas_kind = mkArrowKinds (map tyVarKind tvs) liftedTypeKind
 
              ; tycon = mkClassTyCon tycon_name clas_kind tvs
-                             rhs rec_clas tc_isrec
+                                    rhs rec_clas tc_isrec
                -- A class can be recursive, and in the case of newtypes 
                -- this matters.  For example
                --      class C a where { op :: C b => a -> b -> Int }
@@ -333,10 +343,13 @@ buildClass class_name tvs sc_theta fds ats sig_stuff tc_isrec
                -- newtype like a synonym, but that will lead to an infinite
                -- type]
              ; atTyCons = [tycon | ATyCon tycon <- ats]
+
+             ; result = mkClass class_name tvs fds 
+                                sc_theta sc_sel_ids atTyCons
+                                op_items tycon
              }
-       ; return (mkClass class_name tvs fds 
-                      sc_theta sc_sel_ids atTyCons op_items
-                      tycon)
+       ; traceIf (text "buildClass" <+> ppr tycon) 
+       ; return result
        })}
 \end{code}