Print infix function definitions correctly in HsSyn
[ghc-hetmet.git] / compiler / rename / RnSource.lhs
index 38211b9..59ca11b 100644 (file)
@@ -6,7 +6,7 @@
 \begin{code}
 module RnSource ( 
        rnSrcDecls, addTcgDUs, 
-       rnTyClDecls, checkModDeprec,
+       rnTyClDecls, 
        rnSplice, checkTH
     ) where
 
@@ -15,8 +15,8 @@ module RnSource (
 import {-# SOURCE #-} RnExpr( rnLExpr )
 
 import HsSyn
-import RdrName         ( RdrName, isRdrDataCon, elemLocalRdrEnv, globalRdrEnvElts,
-                         GlobalRdrElt(..), isLocalGRE )
+import RdrName         ( RdrName, isRdrDataCon, elemLocalRdrEnv, 
+                         globalRdrEnvElts, GlobalRdrElt(..), isLocalGRE )
 import RdrHsSyn                ( extractGenericPatTyVars, extractHsRhoRdrTyVars )
 import RnHsSyn
 import RnTypes         ( rnLHsType, rnLHsTypes, rnHsSigType, rnHsTypeFVs, rnContext )
@@ -28,10 +28,10 @@ import RnEnv                ( lookupLocalDataTcNames,
                          bindTyVarsRn, extendTyVarEnvFVRn,
                          bindLocalNames, checkDupNames, mapFvRn
                        )
+import RnHsDoc          ( rnHsDoc, rnMbLHsDoc )
 import TcRnMonad
 
-import HscTypes                ( FixityEnv, FixItem(..),
-                         Deprecations, Deprecs(..), DeprecTxt, plusDeprecs )
+import HscTypes                ( FixityEnv, FixItem(..), Deprecations, Deprecs(..), plusDeprecs )
 import Class           ( FunDep )
 import Name            ( Name, nameOccName )
 import NameSet
@@ -42,6 +42,7 @@ import SrcLoc         ( Located(..), unLoc, noLoc )
 import DynFlags        ( DynFlag(..) )
 import Maybes          ( seqMaybe )
 import Maybe            ( isNothing )
+import Monad           ( liftM, when )
 import BasicTypes       ( Boxity(..) )
 \end{code}
 
@@ -67,11 +68,13 @@ rnSrcDecls :: HsGroup RdrName -> RnM (TcGblEnv, HsGroup Name)
 rnSrcDecls (HsGroup { hs_valds  = val_decls,
                      hs_tyclds = tycl_decls,
                      hs_instds = inst_decls,
+                      hs_derivds = deriv_decls,
                      hs_fixds  = fix_decls,
                      hs_depds  = deprec_decls,
                      hs_fords  = foreign_decls,
                      hs_defds  = default_decls,
-                     hs_ruleds = rule_decls })
+                     hs_ruleds = rule_decls,
+          hs_docs   = docs })
 
  = do {                -- Deal with deprecations (returns only the extra deprecations)
        deprecs <- rnSrcDeprecDecls deprec_decls ;
@@ -81,15 +84,10 @@ rnSrcDecls (HsGroup { hs_valds  = val_decls,
                -- Deal with top-level fixity decls 
                -- (returns the total new fixity env)
         rn_fix_decls <- rnSrcFixityDecls fix_decls ;
-       fix_env <- rnSrcFixityDeclsEnv rn_fix_decls ;
-       updGblEnv (\gbl -> gbl { tcg_fix_env = fix_env })
-                 $ do {
-
-               -- Rename other declarations
-       traceRn (text "Start rnmono") ;
-       (rn_val_decls, bind_dus) <- rnTopBinds val_decls ;
-       traceRn (text "finish rnmono" <+> ppr rn_val_decls) ;
+       tcg_env      <- extendGblFixityEnv rn_fix_decls ;
+       setGblEnv tcg_env $ do {
 
+               -- Rename type and class decls
                -- You might think that we could build proper def/use information
                -- for type and class declarations, but they can be involved
                -- in mutual recursion across modules, and we only do the SCC
@@ -97,28 +95,41 @@ rnSrcDecls (HsGroup { hs_valds  = val_decls,
                -- So we content ourselves with gathering uses only; that
                -- means we'll only report a declaration as unused if it isn't
                -- mentioned at all.  Ah well.
-       (rn_tycl_decls,    src_fvs1)
-          <- mapFvRn (wrapLocFstM rnTyClDecl) tycl_decls ;
-       (rn_inst_decls,    src_fvs2)
-          <- mapFvRn (wrapLocFstM rnSrcInstDecl) inst_decls ;
-       (rn_rule_decls,    src_fvs3)
-          <- mapFvRn (wrapLocFstM rnHsRuleDecl) rule_decls ;
-       (rn_foreign_decls, src_fvs4)
-          <- mapFvRn (wrapLocFstM rnHsForeignDecl) foreign_decls ;
-       (rn_default_decls, src_fvs5)
-          <- mapFvRn (wrapLocFstM rnDefaultDecl) default_decls ;
-       
+       traceRn (text "Start rnTyClDecls") ;
+       (rn_tycl_decls,    src_fvs1) <- rnList rnTyClDecl tycl_decls ;
+
+               -- Extract the mapping from data constructors to field names
+       tcg_env <- extendRecordFieldEnv rn_tycl_decls ;
+       setGblEnv tcg_env $ do {
+
+               -- Value declarations
+       traceRn (text "Start rnmono") ;
+       (rn_val_decls, bind_dus) <- rnTopBinds val_decls ;
+       traceRn (text "finish rnmono" <+> ppr rn_val_decls) ;
+
+               -- Other decls
+       (rn_inst_decls,    src_fvs2) <- rnList rnSrcInstDecl   inst_decls ;
+       (rn_rule_decls,    src_fvs3) <- rnList rnHsRuleDecl    rule_decls ;
+       (rn_foreign_decls, src_fvs4) <- rnList rnHsForeignDecl foreign_decls ;
+       (rn_default_decls, src_fvs5) <- rnList rnDefaultDecl   default_decls ;
+       (rn_deriv_decls,   src_fvs6) <- rnList rnSrcDerivDecl  deriv_decls ;
+
+  -- Haddock docs; no free vars
+       rn_docs <- mapM (wrapLocM rnDocDecl) docs ;
+
        let {
           rn_group = HsGroup { hs_valds  = rn_val_decls,
                                hs_tyclds = rn_tycl_decls,
                                hs_instds = rn_inst_decls,
+                                hs_derivds = rn_deriv_decls,
                                hs_fixds  = rn_fix_decls,
                                hs_depds  = [],
                                hs_fords  = rn_foreign_decls,
                                hs_defds  = rn_default_decls,
-                               hs_ruleds = rn_rule_decls } ;
+                               hs_ruleds = rn_rule_decls,
+            hs_docs   = rn_docs } ;
 
-          other_fvs = plusFVs [src_fvs1, src_fvs2, src_fvs3, 
+          other_fvs = plusFVs [src_fvs1, src_fvs2, src_fvs6, src_fvs3, 
                                src_fvs4, src_fvs5] ;
           src_dus = bind_dus `plusDU` usesOnly other_fvs 
                -- Note: src_dus will contain *uses* for locally-defined types
@@ -129,17 +140,42 @@ rnSrcDecls (HsGroup { hs_valds  = val_decls,
 
        traceRn (text "finish rnSrc" <+> ppr rn_group) ;
        traceRn (text "finish Dus" <+> ppr src_dus ) ;
-       tcg_env <- getGblEnv ;
        return (tcg_env `addTcgDUs` src_dus, rn_group)
-    }}}
+    }}}}
 
 rnTyClDecls :: [LTyClDecl RdrName] -> RnM [LTyClDecl Name]
-rnTyClDecls tycl_decls = do 
-  (decls', fvs) <- mapFvRn (wrapLocFstM rnTyClDecl) tycl_decls
-  return decls'
+-- Used for external core
+rnTyClDecls tycl_decls = do  (decls', fvs) <- rnList rnTyClDecl tycl_decls
+                            return decls'
 
 addTcgDUs :: TcGblEnv -> DefUses -> TcGblEnv 
 addTcgDUs tcg_env dus = tcg_env { tcg_dus = tcg_dus tcg_env `plusDU` dus }
+
+rnList :: (a -> RnM (b, FreeVars)) -> [Located a] -> RnM ([Located b], FreeVars)
+rnList f xs = mapFvRn (wrapLocFstM f) xs
+\end{code}
+
+
+%*********************************************************
+%*                                                      *
+       HsDoc stuff
+%*                                                      *
+%*********************************************************
+
+\begin{code}
+rnDocDecl :: DocDecl RdrName -> RnM (DocDecl Name)
+rnDocDecl (DocCommentNext doc) = do 
+  rn_doc <- rnHsDoc doc
+  return (DocCommentNext rn_doc)
+rnDocDecl (DocCommentPrev doc) = do 
+  rn_doc <- rnHsDoc doc
+  return (DocCommentPrev rn_doc)
+rnDocDecl (DocCommentNamed str doc) = do
+  rn_doc <- rnHsDoc doc
+  return (DocCommentNamed str rn_doc)
+rnDocDecl (DocGroup lev doc) = do
+  rn_doc <- rnHsDoc doc
+  return (DocGroup lev rn_doc)
 \end{code}
 
 
@@ -151,38 +187,39 @@ addTcgDUs tcg_env dus = tcg_env { tcg_dus = tcg_dus tcg_env `plusDU` dus }
 
 \begin{code}
 rnSrcFixityDecls :: [LFixitySig RdrName] -> RnM [LFixitySig Name]
+-- First rename the fixity decls, so we can put
+-- the renamed decls in the renamed syntax tre
 rnSrcFixityDecls fix_decls
-    = do fix_decls <- mapM rnFixityDecl fix_decls
-         return (concat fix_decls)
-
-rnFixityDecl :: LFixitySig RdrName -> RnM [LFixitySig Name]
-rnFixityDecl (L loc (FixitySig (L nameLoc rdr_name) fixity))
-    = setSrcSpan nameLoc $
+  = do fix_decls <- mapM rn_decl fix_decls
+       return (concat fix_decls)
+  where
+    rn_decl :: LFixitySig RdrName -> RnM [LFixitySig Name]
         -- GHC extension: look up both the tycon and data con 
-       -- for con-like things
+       -- for con-like things; hence returning a list
        -- If neither are in scope, report an error; otherwise
        -- add both to the fixity env
-      do names <- lookupLocalDataTcNames rdr_name
-         return [ L loc (FixitySig (L nameLoc name) fixity)
-                      | name <- names ]
-
-rnSrcFixityDeclsEnv :: [LFixitySig Name] -> RnM FixityEnv
-rnSrcFixityDeclsEnv fix_decls
-  = getGblEnv                                  `thenM` \ gbl_env ->
-    foldlM rnFixityDeclEnv (tcg_fix_env gbl_env) 
-           fix_decls                                   `thenM` \ fix_env ->
-    traceRn (text "fixity env" <+> pprFixEnv fix_env)  `thenM_`
-    returnM fix_env
-
-rnFixityDeclEnv :: FixityEnv -> LFixitySig Name -> RnM FixityEnv
-rnFixityDeclEnv fix_env (L loc (FixitySig (L nameLoc name) fixity))
-  = case lookupNameEnv fix_env name of
-      Just (FixItem _ _ loc') 
-         -> do addLocErr (L nameLoc name) (dupFixityDecl loc')
-               return fix_env
-      Nothing
-          -> return (extendNameEnv fix_env name fix_item)
-    where fix_item = FixItem (nameOccName name) fixity nameLoc
+    rn_decl (L loc (FixitySig (L name_loc rdr_name) fixity))
+      = setSrcSpan name_loc $
+        do names <- lookupLocalDataTcNames rdr_name
+           return [ L loc (FixitySig (L name_loc name) fixity)
+                  | name <- names ]
+
+extendGblFixityEnv :: [LFixitySig Name] -> RnM TcGblEnv
+-- Extend the global envt with fixity decls, checking for duplicate decls
+extendGblFixityEnv decls
+  = do { env <- getGblEnv
+       ; fix_env' <- foldlM add_one (tcg_fix_env env) decls
+       ; return (env { tcg_fix_env = fix_env' }) }
+  where
+    add_one fix_env (L loc (FixitySig (L name_loc name) fixity))
+       | Just (FixItem _ _ loc') <- lookupNameEnv fix_env name
+       = do { setSrcSpan loc $
+              addLocErr (L name_loc name) (dupFixityDecl loc')
+            ; return fix_env }
+       | otherwise
+       = return (extendNameEnv fix_env name fix_item)
+      where 
+       fix_item = FixItem (nameOccName name) fixity loc
 
 pprFixEnv :: FixityEnv -> SDoc
 pprFixEnv env 
@@ -218,11 +255,6 @@ rnSrcDeprecDecls decls
    rn_deprec (Deprecation rdr_name txt)
      = lookupLocalDataTcNames rdr_name `thenM` \ names ->
        returnM [(name, (nameOccName name, txt)) | name <- names]
-
-checkModDeprec :: Maybe DeprecTxt -> Deprecations
--- Check for a module deprecation; done once at top level
-checkModDeprec Nothing    = NoDeprecs
-checkModDeprec (Just txt) = DeprecAll txt
 \end{code}
 
 %*********************************************************
@@ -254,7 +286,7 @@ rnHsForeignDecl (ForeignImport name ty spec)
 rnHsForeignDecl (ForeignExport name ty spec)
   = lookupLocatedOccRn name            `thenM` \ name' ->
     rnHsTypeFVs (fo_decl_msg name) ty          `thenM` \ (ty', fvs) ->
-    returnM (ForeignExport name' ty' spec, fvs )
+    returnM (ForeignExport name' ty' spec, fvs `addOneFV` unLoc name')
        -- NB: a foreign export is an *occurrence site* for name, so 
        --     we add it to the free-variable list.  It might, for example,
        --     be imported from another module
@@ -270,10 +302,20 @@ fo_decl_msg name = ptext SLIT("In the foreign declaration for") <+> ppr name
 %*********************************************************
 
 \begin{code}
-rnSrcInstDecl (InstDecl inst_ty mbinds uprags)
+rnSrcInstDecl (InstDecl inst_ty mbinds uprags ats)
        -- Used for both source and interface file decls
   = rnHsSigType (text "an instance decl") inst_ty      `thenM` \ inst_ty' ->
 
+       -- Rename the associated types
+       -- The typechecker (not the renamer) checks that all 
+       -- the declarations are for the right class
+    let
+       at_doc   = text "In the associated types of an instance declaration"
+       at_names = map (head . tyClDeclNames . unLoc) ats
+    in
+    checkDupNames at_doc at_names              `thenM_`
+    rnATInsts ats                              `thenM` \ (ats', at_fvs) ->
+
        -- Rename the bindings
        -- The typechecker (not the renamer) checks that all 
        -- the bindings are for the right class
@@ -302,9 +344,33 @@ rnSrcInstDecl (InstDecl inst_ty mbinds uprags)
     in
     bindLocalNames binders (renameSigs ok_sig uprags)  `thenM` \ uprags' ->
 
-    returnM (InstDecl inst_ty' mbinds' uprags',
-            meth_fvs `plusFV` hsSigsFVs uprags'
+    returnM (InstDecl inst_ty' mbinds' uprags' ats',
+            meth_fvs `plusFV` at_fvs
+                     `plusFV` hsSigsFVs uprags'
                      `plusFV` extractHsTyNames inst_ty')
+             -- We return the renamed associated data type declarations so
+             -- that they can be entered into the list of type declarations
+             -- for the binding group, but we also keep a copy in the instance.
+             -- The latter is needed for well-formedness checks in the type
+             -- checker (eg, to ensure that all ATs of the instance actually
+             -- receive a declaration). 
+            -- NB: Even the copies in the instance declaration carry copies of
+            --     the instance context after renaming.  This is a bit
+            --     strange, but should not matter (and it would be more work
+            --     to remove the context).
+\end{code}
+
+Renaming of the associated types in instances.  
+
+\begin{code}
+rnATInsts :: [LTyClDecl RdrName] -> RnM ([LTyClDecl Name], FreeVars)
+rnATInsts atDecls = rnList rnATInst atDecls
+  where
+    rnATInst tydecl@TyData     {} = rnTyClDecl tydecl
+    rnATInst tydecl@TySynonym  {} = rnTyClDecl tydecl
+    rnATInst tydecl               =
+      pprPanic "RnSource.rnATInsts: invalid AT instance" 
+              (ppr (tcdName tydecl))
 \end{code}
 
 For the method bindings in class and instance decls, we extend the 
@@ -312,13 +378,26 @@ type variable environment iff -fglasgow-exts
 
 \begin{code}
 extendTyVarEnvForMethodBinds tyvars thing_inside
-  = doptM Opt_GlasgowExts                      `thenM` \ opt_GlasgowExts ->
-    if opt_GlasgowExts then
-       extendTyVarEnvFVRn (map hsLTyVarName tyvars) thing_inside
-    else
-       thing_inside
+  = do { scoped_tvs <- doptM Opt_ScopedTypeVariables
+       ; if scoped_tvs then
+               extendTyVarEnvFVRn (map hsLTyVarName tyvars) thing_inside
+         else
+               thing_inside }
 \end{code}
 
+%*********************************************************
+%*                                                     *
+\subsection{Stand-alone deriving declarations}
+%*                                                     *
+%*********************************************************
+
+\begin{code}
+rnSrcDerivDecl :: DerivDecl RdrName -> RnM (DerivDecl Name, FreeVars)
+rnSrcDerivDecl (DerivDecl ty)
+  = do ty' <- rnLHsType (text "a deriving decl") ty
+       let fvs = extractHsTyNames ty'
+       return (DerivDecl ty', fvs)
+\end{code}
 
 %*********************************************************
 %*                                                     *
@@ -335,15 +414,9 @@ rnHsRuleDecl (HsRule rule_name act vars lhs fv_lhs rhs fv_rhs)
 
     rnLExpr lhs                                        `thenM` \ (lhs', fv_lhs') ->
     rnLExpr rhs                                        `thenM` \ (rhs', fv_rhs') ->
-    let
-       mb_bad = validRuleLhs ids lhs'
-    in
-    checkErr (isNothing mb_bad)
-            (badRuleLhsErr rule_name lhs' mb_bad)      `thenM_`
-    let
-       bad_vars = [var | var <- ids, not (var `elemNameSet` fv_lhs')]
-    in
-    mappM (addErr . badRuleVar rule_name) bad_vars     `thenM_`
+
+    checkValidRule rule_name ids lhs' fv_lhs'  `thenM_`
+
     returnM (HsRule rule_name act vars' lhs' fv_lhs' rhs' fv_rhs',
             fv_vars `plusFV` fv_lhs' `plusFV` fv_rhs')
   where
@@ -379,6 +452,16 @@ lambdas.  So it seems simmpler not to check at all, and that is why
 check_e is commented out.
        
 \begin{code}
+checkValidRule rule_name ids lhs' fv_lhs'
+  = do         {       -- Check for the form of the LHS
+         case (validRuleLhs ids lhs') of
+               Nothing  -> return ()
+               Just bad -> failWithTc (badRuleLhsErr rule_name lhs' bad)
+
+               -- Check that LHS vars are all bound
+       ; let bad_vars = [var | var <- ids, not (var `elemNameSet` fv_lhs')]
+       ; mappM (addErr . badRuleVar rule_name) bad_vars }
+
 validRuleLhs :: [Name] -> LHsExpr Name -> Maybe (HsExpr Name)
 -- Nothing => OK
 -- Just e  => Not ok, and e is the offending expression
@@ -411,7 +494,7 @@ validRuleLhs foralls lhs
     checkl_es es = foldr (seqMaybe . checkl_e) Nothing es
 -}
 
-badRuleLhsErr name lhs (Just bad_e)
+badRuleLhsErr name lhs bad_e
   = sep [ptext SLIT("Rule") <+> ftext name <> colon,
         nest 4 (vcat [ptext SLIT("Illegal expression:") <+> ppr bad_e, 
                       ptext SLIT("in left-hand side:") <+> ppr lhs])]
@@ -445,28 +528,46 @@ rnTyClDecl (ForeignType {tcdLName = name, tcdFoType = fo_type, tcdExtName = ext_
     returnM (ForeignType {tcdLName = name', tcdFoType = fo_type, tcdExtName = ext_name},
             emptyFVs)
 
-rnTyClDecl (TyData {tcdND = new_or_data, tcdCtxt = context, tcdLName = tycon,
-                   tcdTyVars = tyvars, tcdCons = condecls, 
-                   tcdKindSig = sig, tcdDerivs = derivs})
-  | is_vanilla -- Normal Haskell data type decl
+-- all flavours of type family declarations ("type family", "newtype fanily",
+-- and "data family")
+rnTyClDecl (tydecl@TyFamily {}) =
+  rnFamily tydecl bindTyVarsRn
+
+-- "data", "newtype", "data instance, and "newtype instance" declarations
+rnTyClDecl (tydecl@TyData {tcdND = new_or_data, tcdCtxt = context, 
+                          tcdLName = tycon, tcdTyVars = tyvars, 
+                          tcdTyPats = typatsMaybe, tcdCons = condecls, 
+                          tcdKindSig = sig, tcdDerivs = derivs})
+  | is_vanilla           -- Normal Haskell data type decl
   = ASSERT( isNothing sig )    -- In normal H98 form, kind signature on the 
                                -- data type is syntactically illegal
     bindTyVarsRn data_doc tyvars               $ \ tyvars' ->
-    do { tycon' <- lookupLocatedTopBndrRn tycon
+    do { tycon' <- if isFamInstDecl tydecl
+                   then lookupLocatedOccRn     tycon -- may be imported family
+                   else lookupLocatedTopBndrRn tycon
        ; context' <- rnContext data_doc context
+       ; typats' <- rnTyPats data_doc typatsMaybe
        ; (derivs', deriv_fvs) <- rn_derivs derivs
        ; checkDupNames data_doc con_names
        ; condecls' <- rnConDecls (unLoc tycon') condecls
-       ; returnM (TyData {tcdND = new_or_data, tcdCtxt = context', tcdLName = tycon',
-                          tcdTyVars = tyvars', tcdKindSig = Nothing, tcdCons = condecls', 
-                          tcdDerivs = derivs'}, 
+       ; returnM (TyData {tcdND = new_or_data, tcdCtxt = context', 
+                          tcdLName = tycon', tcdTyVars = tyvars', 
+                          tcdTyPats = typats', tcdKindSig = Nothing, 
+                          tcdCons = condecls', tcdDerivs = derivs'}, 
                   delFVs (map hsLTyVarName tyvars')    $
                   extractHsCtxtTyNames context'        `plusFV`
-                  plusFVs (map conDeclFVs condecls') `plusFV`
-                  deriv_fvs) }
-
-  | otherwise  -- GADT
-  = do { tycon' <- lookupLocatedTopBndrRn tycon
+                  plusFVs (map conDeclFVs condecls')   `plusFV`
+                  deriv_fvs                            `plusFV`
+                  (if isFamInstDecl tydecl
+                  then unitFV (unLoc tycon')   -- type instance => use
+                  else emptyFVs)) 
+        }
+
+  | otherwise            -- GADT
+  = ASSERT( none typatsMaybe )    -- GADTs cannot have type patterns for now
+    do { tycon' <- if isFamInstDecl tydecl
+                   then lookupLocatedOccRn     tycon -- may be imported family
+                   else lookupLocatedTopBndrRn tycon
        ; checkTc (null (unLoc context)) (badGadtStupidTheta tycon)
        ; tyvars' <- bindTyVarsRn data_doc tyvars 
                                  (\ tyvars' -> return tyvars')
@@ -476,17 +577,26 @@ rnTyClDecl (TyData {tcdND = new_or_data, tcdCtxt = context, tcdLName = tycon,
        ; (derivs', deriv_fvs) <- rn_derivs derivs
        ; checkDupNames data_doc con_names
        ; condecls' <- rnConDecls (unLoc tycon') condecls
-       ; returnM (TyData {tcdND = new_or_data, tcdCtxt = noLoc [], tcdLName = tycon',
-                          tcdTyVars = tyvars', tcdCons = condecls', tcdKindSig = sig,
-                          tcdDerivs = derivs'}, 
-                  plusFVs (map conDeclFVs condecls') `plusFV` deriv_fvs) }
-
+       ; returnM (TyData {tcdND = new_or_data, tcdCtxt = noLoc [], 
+                          tcdLName = tycon', tcdTyVars = tyvars', 
+                          tcdTyPats = Nothing, tcdKindSig = sig,
+                          tcdCons = condecls', tcdDerivs = derivs'}, 
+                  plusFVs (map conDeclFVs condecls') `plusFV` 
+                  deriv_fvs                          `plusFV`
+                  (if isFamInstDecl tydecl
+                  then unitFV (unLoc tycon')   -- type instance => use
+                  else emptyFVs))
+        }
   where
     is_vanilla = case condecls of      -- Yuk
                     []                    -> True
                     L _ (ConDecl { con_res = ResTyH98 }) : _  -> True
                     other                 -> False
 
+    none Nothing   = True
+    none (Just []) = True
+    none _         = False
+
     data_doc = text "In the data type declaration for" <+> quotes (ppr tycon)
     con_names = map con_names_helper condecls
 
@@ -495,40 +605,53 @@ rnTyClDecl (TyData {tcdND = new_or_data, tcdCtxt = context, tcdLName = tycon,
     rn_derivs Nothing   = returnM (Nothing, emptyFVs)
     rn_derivs (Just ds) = rnLHsTypes data_doc ds       `thenM` \ ds' -> 
                          returnM (Just ds', extractHsTyNames_s ds')
-    
-rnTyClDecl (TySynonym {tcdLName = name, tcdTyVars = tyvars, tcdSynRhs = ty})
-  = lookupLocatedTopBndrRn name                        `thenM` \ name' ->
-    bindTyVarsRn syn_doc tyvars                $ \ tyvars' ->
-    rnHsTypeFVs syn_doc ty                     `thenM` \ (ty', fvs) ->
-    returnM (TySynonym {tcdLName = name', tcdTyVars = tyvars', 
-                       tcdSynRhs = ty'},
-            delFVs (map hsLTyVarName tyvars') fvs)
+
+-- "type" and "type instance" declarations
+rnTyClDecl tydecl@(TySynonym {tcdLName = name, tcdTyVars = tyvars,
+                             tcdTyPats = typatsMaybe, tcdSynRhs = ty})
+  = bindTyVarsRn syn_doc tyvars                        $ \ tyvars' ->
+    do { name' <- if isFamInstDecl tydecl
+                 then lookupLocatedOccRn     name -- may be imported family
+                 else lookupLocatedTopBndrRn name
+       ; typats' <- rnTyPats syn_doc typatsMaybe
+       ; (ty', fvs) <- rnHsTypeFVs syn_doc ty
+       ; returnM (TySynonym {tcdLName = name', tcdTyVars = tyvars', 
+                            tcdTyPats = typats', tcdSynRhs = ty'},
+                 delFVs (map hsLTyVarName tyvars') $
+                 fvs                         `plusFV`
+                  (if isFamInstDecl tydecl
+                  then unitFV (unLoc name')    -- type instance => use
+                  else emptyFVs))
+       }
   where
     syn_doc = text "In the declaration for type synonym" <+> quotes (ppr name)
 
 rnTyClDecl (ClassDecl {tcdCtxt = context, tcdLName = cname, 
                       tcdTyVars = tyvars, tcdFDs = fds, tcdSigs = sigs, 
-                      tcdMeths = mbinds})
-  = lookupLocatedTopBndrRn cname               `thenM` \ cname' ->
+                      tcdMeths = mbinds, tcdATs = ats, tcdDocs = docs})
+  = do { cname' <- lookupLocatedTopBndrRn cname
 
        -- Tyvars scope over superclass context and method signatures
-    bindTyVarsRn cls_doc tyvars                        ( \ tyvars' ->
-       rnContext cls_doc context       `thenM` \ context' ->
-       rnFds cls_doc fds               `thenM` \ fds' ->
-       renameSigs okClsDclSig sigs     `thenM` \ sigs' ->
-       returnM   (tyvars', context', fds', sigs')
-    )  `thenM` \ (tyvars', context', fds', sigs') ->
+       ; (tyvars', context', fds', ats', ats_fvs, sigs')
+           <- bindTyVarsRn cls_doc tyvars $ \ tyvars' -> do
+            { context' <- rnContext cls_doc context
+            ; fds' <- rnFds cls_doc fds
+            ; (ats', ats_fvs) <- rnATs ats
+            ; sigs' <- renameSigs okClsDclSig sigs
+            ; return   (tyvars', context', fds', ats', ats_fvs, sigs') }
+
+       -- Check for duplicates among the associated types
+       ; let at_rdr_names_w_locs = [tcdLName ty | L _ ty <- ats]
+       ; checkDupNames at_doc at_rdr_names_w_locs
 
        -- Check the signatures
        -- First process the class op sigs (op_sigs), then the fixity sigs (non_op_sigs).
-    let
-       sig_rdr_names_w_locs   = [op | L _ (TypeSig op _) <- sigs]
-    in
-    checkDupNames sig_doc sig_rdr_names_w_locs `thenM_` 
-       -- Typechecker is responsible for checking that we only
-       -- give default-method bindings for things in this class.
-       -- The renamer *could* check this for class decls, but can't
-       -- for instance decls.
+       ; let sig_rdr_names_w_locs = [op | L _ (TypeSig op _) <- sigs]
+       ; checkDupNames sig_doc sig_rdr_names_w_locs
+               -- Typechecker is responsible for checking that we only
+               -- give default-method bindings for things in this class.
+               -- The renamer *could* check this for class decls, but can't
+               -- for instance decls.
 
        -- The newLocals call is tiresome: given a generic class decl
        --      class C a where
@@ -538,30 +661,34 @@ rnTyClDecl (ClassDecl {tcdCtxt = context, tcdLName = cname,
        --        op {| a*b |} (a*b)   = ...
        -- we want to name both "x" tyvars with the same unique, so that they are
        -- easy to group together in the typechecker.  
-    extendTyVarEnvForMethodBinds tyvars' (
-        getLocalRdrEnv                                 `thenM` \ name_env ->
-        let
-            meth_rdr_names_w_locs = collectHsBindLocatedBinders mbinds
-            gen_rdr_tyvars_w_locs = 
-               [ tv | tv <- extractGenericPatTyVars mbinds,
-                     not (unLoc tv `elemLocalRdrEnv` name_env) ]
-        in
-        checkDupNames meth_doc meth_rdr_names_w_locs   `thenM_`
-        newLocalsRn gen_rdr_tyvars_w_locs      `thenM` \ gen_tyvars ->
-        rnMethodBinds (unLoc cname') (mkSigTvFn sigs') gen_tyvars mbinds
-    ) `thenM` \ (mbinds', meth_fvs) ->
-
-    returnM (ClassDecl { tcdCtxt = context', tcdLName = cname', tcdTyVars = tyvars',
-                        tcdFDs = fds', tcdSigs = sigs', tcdMeths = mbinds'},
-            delFVs (map hsLTyVarName tyvars')  $
-            extractHsCtxtTyNames context'          `plusFV`
-            plusFVs (map extractFunDepNames (map unLoc fds'))  `plusFV`
-            hsSigsFVs sigs'                        `plusFV`
-            meth_fvs)
+       ; (mbinds', meth_fvs) 
+           <- extendTyVarEnvForMethodBinds tyvars' $ do
+           { name_env <- getLocalRdrEnv
+           ; let meth_rdr_names_w_locs = collectHsBindLocatedBinders mbinds
+                 gen_rdr_tyvars_w_locs = [ tv | tv <- extractGenericPatTyVars mbinds,
+                                                not (unLoc tv `elemLocalRdrEnv` name_env) ]
+           ; checkDupNames meth_doc meth_rdr_names_w_locs
+           ; gen_tyvars <- newLocalsRn gen_rdr_tyvars_w_locs
+           ; rnMethodBinds (unLoc cname') (mkSigTvFn sigs') gen_tyvars mbinds }
+
+  -- Haddock docs 
+       ; docs' <- mapM (wrapLocM rnDocDecl) docs
+
+       ; return (ClassDecl { tcdCtxt = context', tcdLName = cname', 
+                             tcdTyVars = tyvars', tcdFDs = fds', tcdSigs = sigs',
+                             tcdMeths = mbinds', tcdATs = ats', tcdDocs = docs'},
+
+                 delFVs (map hsLTyVarName tyvars')     $
+                 extractHsCtxtTyNames context'         `plusFV`
+                 plusFVs (map extractFunDepNames (map unLoc fds'))  `plusFV`
+                 hsSigsFVs sigs'                       `plusFV`
+                 meth_fvs                              `plusFV`
+                 ats_fvs) }
   where
     meth_doc = text "In the default-methods for class" <+> ppr cname
     cls_doc  = text "In the declaration for class"     <+> ppr cname
     sig_doc  = text "In the signatures for class"      <+> ppr cname
+    at_doc   = text "In the associated types for class"        <+> ppr cname
 
 badGadtStupidTheta tycon
   = vcat [ptext SLIT("No context is allowed on a GADT-style data declaration"),
@@ -575,12 +702,20 @@ badGadtStupidTheta tycon
 %*********************************************************
 
 \begin{code}
+-- Although, we are processing type patterns here, all type variables will
+-- already be in scope (they are the same as in the 'tcdTyVars' field of the
+-- type declaration to which these patterns belong)
+--
+rnTyPats :: SDoc -> Maybe [LHsType RdrName] -> RnM (Maybe [LHsType Name])
+rnTyPats _   Nothing       = return Nothing
+rnTyPats doc (Just typats) = liftM Just $ rnLHsTypes doc typats
+
 rnConDecls :: Name -> [LConDecl RdrName] -> RnM [LConDecl Name]
 rnConDecls tycon condecls
   = mappM (wrapLocM rnConDecl) condecls
 
 rnConDecl :: ConDecl RdrName -> RnM (ConDecl Name)
-rnConDecl (ConDecl name expl tvs cxt details res_ty)
+rnConDecl (ConDecl name expl tvs cxt details res_ty mb_doc)
   = do { addLocM checkConName name
 
        ; new_name <- lookupLocatedTopBndrRn name
@@ -590,7 +725,7 @@ rnConDecl (ConDecl name expl tvs cxt details res_ty)
        -- For GADT syntax, the tvs are all the quantified tyvars
        -- Hence the 'filter' in the ResTyH98 case only
        ; let not_in_scope  = not . (`elemLocalRdrEnv` name_env) . unLoc
-             arg_tys       = hsConArgs details
+             arg_tys       = hsConDeclArgTys details
              implicit_tvs  = case res_ty of
                                ResTyH98 -> filter not_in_scope $
                                                get_rdr_tvs arg_tys
@@ -599,12 +734,14 @@ rnConDecl (ConDecl name expl tvs cxt details res_ty)
                        Explicit -> tvs
                        Implicit -> userHsTyVarBndrs implicit_tvs
 
+       ; mb_doc' <- rnMbLHsDoc mb_doc 
+
        ; bindTyVarsRn doc tvs' $ \new_tyvars -> do
        { new_context <- rnContext doc cxt
-        ; new_details <- rnConDetails doc details
+        ; new_details <- rnConDeclDetails doc details
         ; (new_details', new_res_ty)  <- rnConResult doc new_details res_ty
-        ; return (ConDecl new_name expl new_tyvars new_context new_details' new_res_ty) }}
-  where
+        ; return (ConDecl new_name expl new_tyvars new_context new_details' new_res_ty mb_doc') }}
+ where
     doc = text "In the definition of data constructor" <+> quotes (ppr name)
     get_rdr_tvs tys  = extractHsRhoRdrTyVars cxt (noLoc (HsTupleTy Boxed tys))
 
@@ -619,26 +756,102 @@ rnConResult doc details (ResTyGADT ty) = do
        RecCon fields -> return (details, ResTyGADT ty')
        InfixCon {}   -> panic "rnConResult"
 
-rnConDetails doc (PrefixCon tys)
+rnConDeclDetails doc (PrefixCon tys)
   = mappM (rnLHsType doc) tys  `thenM` \ new_tys  ->
     returnM (PrefixCon new_tys)
 
-rnConDetails doc (InfixCon ty1 ty2)
+rnConDeclDetails doc (InfixCon ty1 ty2)
   = rnLHsType doc ty1                  `thenM` \ new_ty1 ->
     rnLHsType doc ty2                  `thenM` \ new_ty2 ->
     returnM (InfixCon new_ty1 new_ty2)
 
-rnConDetails doc (RecCon fields)
-  = checkDupNames doc field_names      `thenM_`
-    mappM (rnField doc) fields         `thenM` \ new_fields ->
-    returnM (RecCon new_fields)
-  where
-    field_names = [fld | (fld, _) <- fields]
+rnConDeclDetails doc (RecCon fields)
+  = do { checkDupNames doc (map cd_fld_name fields)
+       ; new_fields <- mappM (rnField doc) fields
+       ; return (RecCon new_fields) }
 
-rnField doc (name, ty)
+rnField doc (ConDeclField name ty haddock_doc)
   = lookupLocatedTopBndrRn name        `thenM` \ new_name ->
     rnLHsType doc ty           `thenM` \ new_ty ->
-    returnM (new_name, new_ty) 
+    rnMbLHsDoc haddock_doc      `thenM` \ new_haddock_doc ->
+    returnM (ConDeclField new_name new_ty new_haddock_doc) 
+
+-- Rename family declarations
+--
+-- * This function is parametrised by the routine handling the index
+--   variables.  On the toplevel, these are defining occurences, whereas they
+--   are usage occurences for associated types.
+--
+rnFamily :: TyClDecl RdrName 
+         -> (SDoc -> [LHsTyVarBndr RdrName] -> 
+            ([LHsTyVarBndr Name] -> RnM (TyClDecl Name, FreeVars)) ->
+            RnM (TyClDecl Name, FreeVars))
+         -> RnM (TyClDecl Name, FreeVars)
+
+rnFamily (tydecl@TyFamily {tcdFlavour = flavour, 
+                          tcdLName = tycon, tcdTyVars = tyvars}) 
+        bindIdxVars =
+      do { checkM (isDataFlavour flavour                      -- for synonyms,
+                  || not (null tyvars)) $ addErr needOneIdx  -- #indexes >= 1
+        ; bindIdxVars (family_doc tycon) tyvars $ \tyvars' -> do {
+        ; tycon' <- lookupLocatedTopBndrRn tycon
+        ; returnM (TyFamily {tcdFlavour = flavour, tcdLName = tycon', 
+                             tcdTyVars = tyvars', tcdKind = tcdKind tydecl}, 
+                   emptyFVs) 
+         } }
+      where
+        isDataFlavour DataFamily = True
+       isDataFlavour _          = False
+
+family_doc tycon = text "In the family declaration for" <+> quotes (ppr tycon)
+needOneIdx = text "Type family declarations requires at least one type index"
+
+-- Rename associated type declarations (in classes)
+--
+-- * This can be family declarations and (default) type instances
+--
+rnATs :: [LTyClDecl RdrName] -> RnM ([LTyClDecl Name], FreeVars)
+rnATs ats = mapFvRn (wrapLocFstM rn_at) ats
+  where
+    rn_at (tydecl@TyFamily  {}) = rnFamily tydecl lookupIdxVars
+    rn_at (tydecl@TySynonym {}) = 
+      do
+        checkM (isNothing (tcdTyPats tydecl)) $ addErr noPatterns
+        rnTyClDecl tydecl
+    rn_at _                      = panic "RnSource.rnATs: invalid TyClDecl"
+
+    lookupIdxVars _ tyvars cont = 
+      do { checkForDups tyvars;
+        ; tyvars' <- mappM lookupIdxVar tyvars
+        ; cont tyvars'
+        }
+    -- Type index variables must be class parameters, which are the only
+    -- type variables in scope at this point.
+    lookupIdxVar (L l tyvar) =
+      do
+       name' <- lookupOccRn (hsTyVarName tyvar)
+       return $ L l (replaceTyVarName tyvar name')
+
+    -- Type variable may only occur once.
+    --
+    checkForDups [] = return ()
+    checkForDups (L loc tv:ltvs) = 
+      do { setSrcSpan loc $
+            when (hsTyVarName tv `ltvElem` ltvs) $
+              addErr (repeatedTyVar tv)
+        ; checkForDups ltvs
+        }
+
+    rdrName `ltvElem` [] = False
+    rdrName `ltvElem` (L _ tv:ltvs)
+      | rdrName == hsTyVarName tv = True
+      | otherwise                = rdrName `ltvElem` ltvs
+
+noPatterns = text "Default definition for an associated synonym cannot have"
+            <+> text "type pattern"
+
+repeatedTyVar tv = ptext SLIT("Illegal repeated type variable") <+>
+                  quotes (ppr tv)
 
 -- This data decl will parse OK
 --     data T = a Int
@@ -659,6 +872,30 @@ badDataCon name
 
 %*********************************************************
 %*                                                     *
+\subsection{Support code for type/data declarations}
+%*                                                     *
+%*********************************************************
+
+Get the mapping from constructors to fields for this module.
+It's convenient to do this after the data type decls have been renamed
+\begin{code}
+extendRecordFieldEnv :: [LTyClDecl Name] -> TcM TcGblEnv
+extendRecordFieldEnv decls 
+  = do { tcg_env <- getGblEnv
+       ; let field_env' = foldr get (tcg_field_env tcg_env) decls
+       ; return (tcg_env { tcg_field_env = field_env' }) }
+  where
+    get (L _ (TyData { tcdCons = cons })) env = foldr get_con env cons
+    get other                            env = env
+
+    get_con (L _ (ConDecl { con_name = con, con_details = RecCon flds })) env
+       = extendNameEnv env (unLoc con) (map (unLoc . cd_fld_name) flds)
+    get_con other env
+       = env
+\end{code}
+
+%*********************************************************
+%*                                                     *
 \subsection{Support code to rename types}
 %*                                                     *
 %*********************************************************