[project @ 2002-02-04 03:40:31 by chak]
[ghc-hetmet.git] / ghc / compiler / main / HscMain.lhs
index 5d09d7b..9bf5b10 100644 (file)
@@ -7,28 +7,39 @@
 \begin{code}
 module HscMain ( HscResult(..), hscMain, 
 #ifdef GHCI
-                hscStmt,
+                hscStmt, hscThing, hscModuleContents,
 #endif
                 initPersistentCompilerState ) where
 
 #include "HsVersions.h"
 
 #ifdef GHCI
+import Interpreter
 import ByteCodeGen     ( byteCodeGen )
 import CoreTidy                ( tidyCoreExpr )
 import CorePrep                ( corePrepExpr )
-import Rename          ( renameStmt )
+import Rename          ( renameStmt, renameRdrName, slurpIface )
+import RdrName          ( rdrNameOcc, setRdrNameOcc )
 import RdrHsSyn                ( RdrNameStmt )
+import OccName          ( dataName, tcClsName, 
+                         occNameSpace, setOccNameSpace )
 import Type            ( Type )
 import Id              ( Id, idName, setGlobalIdDetails )
 import IdInfo          ( GlobalIdDetails(VanillaGlobal) )
-import HscTypes                ( InteractiveContext(..) )
+import Name            ( isLocalName )
+import NameEnv         ( lookupNameEnv )
+import RdrName         ( rdrEnvElts )
 import PrelNames       ( iNTERACTIVE )
 import StringBuffer    ( stringToStringBuffer )
+import FastString       ( mkFastString )
+import Maybes          ( catMaybes )
+
+import List            ( nub )
 #endif
 
 import HsSyn
 
+import RdrName         ( mkRdrOrig )
 import Id              ( idName )
 import IdInfo          ( CafInfo(..), CgInfoEnv, CgInfo(..) )
 import StringBuffer    ( hGetStringBuffer, freeStringBuffer )
@@ -39,7 +50,8 @@ import Finder         ( findModule )
 import Rename          ( checkOldIface, renameModule, closeIfaceDecls )
 import Rules           ( emptyRuleBase )
 import PrelInfo                ( wiredInThingEnv, wiredInThings )
-import PrelNames       ( vanillaSyntaxMap, knownKeyNames )
+import PrelRules       ( builtinRules )
+import PrelNames       ( knownKeyNames )
 import MkIface         ( mkFinalIface )
 import TcModule
 import InstEnv         ( emptyInstEnv )
@@ -55,16 +67,15 @@ import CodeGen              ( codeGen )
 import CodeOutput      ( codeOutput )
 
 import Module          ( ModuleName, moduleName, mkHomeModule, 
-                         moduleUserString )
+                         moduleUserString, lookupModuleEnv )
 import CmdLineOpts
+import DriverState     ( v_HCHeader )
 import ErrUtils                ( dumpIfSet_dyn, showPass, printError )
 import Util            ( unJust )
 import UniqSupply      ( mkSplitUniqSupply )
 
-import Bag             ( emptyBag )
+import Bag             ( consBag, emptyBag )
 import Outputable
-import Interpreter
-import CmStaticInfo    ( GhciMode(..) )
 import HscStats                ( ppSourceStats )
 import HscTypes
 import FiniteMap       ( FiniteMap, plusFM, emptyFM, addToFM )
@@ -73,7 +84,8 @@ import Name           ( Name, nameModule, nameOccName, getName, isGlobalName )
 import NameEnv         ( emptyNameEnv, mkNameEnv )
 import Module          ( Module )
 
-import IOExts          ( newIORef, readIORef, writeIORef, unsafePerformIO )
+import IOExts          ( newIORef, readIORef, writeIORef, modifyIORef,
+                         unsafePerformIO )
 
 import Monad           ( when )
 import Maybe           ( isJust, fromJust )
@@ -103,8 +115,11 @@ data HscResult
                  ModIface               -- new iface (if any compilation was done)
                 Bool                   -- stub_h exists
                 Bool                   -- stub_c exists
+#ifdef GHCI
                 (Maybe ([UnlinkedBCO],ItblEnv)) -- interpreted code, if any
-             
+#else
+                (Maybe ())                      -- no interpreted code whatsoever
+#endif
 
        -- no errors or warnings; the individual passes
        -- (parse/rename/typecheck) print messages themselves
@@ -124,14 +139,15 @@ hscMain
 
 hscMain ghci_mode dflags mod location source_unchanged have_object 
        maybe_old_iface hst hit pcs
- = do {
+ = {-# SCC "hscMain" #-}
+   do {
       showPass dflags ("Checking old interface for hs = " 
                        ++ show (ml_hs_file location)
                        ++ ", hspp = " ++ show (ml_hspp_file location));
 
       (pcs_ch, errs_found, (recomp_reqd, maybe_checked_iface))
          <- _scc_ "checkOldIface"
-           checkOldIface ghci_mode dflags hit hst pcs (ml_hi_file location)
+           checkOldIface ghci_mode dflags hit hst pcs mod (ml_hi_file location)
                source_unchanged maybe_old_iface;
 
       if errs_found then
@@ -152,7 +168,8 @@ hscNoRecomp ghci_mode dflags have_object
            mod location (Just old_iface) hst hit pcs_ch
  | ghci_mode == OneShot
  = do {
-      hPutStrLn stderr "compilation IS NOT required";
+      when (verbosity dflags > 0) $
+         hPutStrLn stderr "compilation IS NOT required";
       let { bomb = panic "hscNoRecomp:OneShot" };
       return (HscNoRecomp pcs_ch bomb bomb)
       }
@@ -160,7 +177,7 @@ hscNoRecomp ghci_mode dflags have_object
  = do {
       when (verbosity dflags >= 1) $
                hPutStrLn stderr ("Skipping  " ++ 
-                       compMsg have_object mod location);
+                       showModMsg have_object mod location);
 
       -- CLOSURE
       (pcs_cl, closure_errs, cl_hs_decls) 
@@ -171,7 +188,7 @@ hscNoRecomp ghci_mode dflags have_object
 
       -- TYPECHECK
       maybe_tc_result 
-       <- typecheckIface dflags pcs_cl hst old_iface (vanillaSyntaxMap, cl_hs_decls);
+       <- typecheckIface dflags pcs_cl hst old_iface cl_hs_decls;
 
       case maybe_tc_result of {
          Nothing -> return (HscFail pcs_cl);
@@ -180,25 +197,16 @@ hscNoRecomp ghci_mode dflags have_object
       return (HscNoRecomp pcs_tc new_details old_iface)
       }}}
 
-compMsg use_object mod location =
-    mod_str ++ take (max 0 (16 - length mod_str)) (repeat ' ')
-    ++" ( " ++ unJust "hscRecomp" (ml_hs_file location) ++ ", "
-    ++ (if use_object
-         then unJust "hscRecomp" (ml_obj_file location)
-         else "interpreted")
-    ++ " )"
- where mod_str = moduleUserString mod
-
-
 hscRecomp ghci_mode dflags have_object 
          mod location maybe_checked_iface hst hit pcs_ch
  = do  {
          -- what target are we shooting for?
        ; let toInterp = dopt_HscLang dflags == HscInterpreted
+       ; let toNothing = dopt_HscLang dflags == HscNothing
 
-       ; when (verbosity dflags >= 1) $
+       ; when (ghci_mode /= OneShot && verbosity dflags >= 1) $
                hPutStrLn stderr ("Compiling " ++ 
-                       compMsg (not toInterp) mod location);
+                       showModMsg (not toInterp) mod location);
 
            -------------------
            -- PARSE
@@ -219,13 +227,15 @@ hscRecomp ghci_mode dflags have_object
        ; case maybe_rn_result of {
             Nothing -> return (HscFail pcs_ch{-was: pcs_rn-});
             Just (is_exported, new_iface, rn_hs_decls) -> do {
-    
-           -- In interactive mode, we don't want to discard any top-level entities at
-           -- all (eg. do not inline them away during simplification), and retain them
-           -- all in the TypeEnv so they are available from the command line.
-           --
-           -- isGlobalName separates the user-defined top-level names from those
-           -- introduced by the type checker.
+
+       -- In interactive mode, we don't want to discard any top-level
+       -- entities at all (eg. do not inline them away during
+       -- simplification), and retain them all in the TypeEnv so they are
+       -- available from the command line.
+       --
+       -- isGlobalName separates the user-defined top-level names from those
+       -- introduced by the type checker.
+
        ; let dont_discard | ghci_mode == Interactive = isGlobalName
                           | otherwise = is_exported
 
@@ -233,7 +243,8 @@ hscRecomp ghci_mode dflags have_object
            -- TYPECHECK
            -------------------
        ; maybe_tc_result 
-           <- _scc_ "TypeCheck" typecheckModule dflags pcs_rn hst new_iface 
+           <- _scc_ "TypeCheck" 
+              typecheckModule dflags pcs_rn hst new_iface 
                                             print_unqualified rn_hs_decls 
        ; case maybe_tc_result of {
             Nothing -> return (HscFail pcs_ch{-was: pcs_rn-});
@@ -247,7 +258,8 @@ hscRecomp ghci_mode dflags have_object
                deSugar dflags pcs_tc hst this_mod print_unqualified tc_result
 
        ; pcs_middle
-           <- if ghci_mode == OneShot 
+           <- _scc_ "pcs_middle"
+               if ghci_mode == OneShot 
                  then do init_pcs <- initPersistentCompilerState
                          init_prs <- initPersistentRenamerState
                          let 
@@ -260,6 +272,12 @@ hscRecomp ghci_mode dflags have_object
                                             pcs_rules = rules }
                  else return pcs_tc
 
+       -- alive at this point:  
+       --      pcs_middle
+       --      foreign_stuff
+       --      ds_details
+       --      new_iface               
+
            -------------------
            -- SIMPLIFY
            -------------------
@@ -293,11 +311,16 @@ hscRecomp ghci_mode dflags have_object
        --      new_iface               
 
        ; emitExternalCore dflags new_iface tidy_details 
+
+       ; let final_details = tidy_details {md_binds = []} 
+       ; final_details `seq` return ()
+
            -------------------
            -- PREPARE FOR CODE GENERATION
            -------------------
              -- Do saturation and convert to A-normal form
-       ; prepd_details <- _scc_ "CorePrep" corePrepPgm dflags tidy_details
+       ; prepd_details <- _scc_ "CorePrep" 
+                          corePrepPgm dflags tidy_details
 
            -------------------
            -- CONVERT TO STG and COMPLETE CODE GENERATION
@@ -313,12 +336,28 @@ hscRecomp ghci_mode dflags have_object
            mod_name_to_Module nm
                 = do m <- findModule nm ; return (fst (fromJust m))
 
-           (h_code,c_code,fe_binders) = foreign_stuff
+           (h_code, c_code, headers, fe_binders) = foreign_stuff
+
+           -- turn the list of headers requested in foreign import
+           -- declarations into a string suitable for emission into generated
+           -- C code...
+           --
+           foreign_headers =   
+               unlines 
+             . map (\fname -> "#include \"" ++ _UNPK_ fname ++ "\"")
+             . reverse 
+             $ headers
+
+         -- ...and add the string to the headers requested via command line
+         -- options 
+         --
+       ; modifyIORef v_HCHeader (++ foreign_headers)
 
         ; imported_modules <- mapM mod_name_to_Module imported_module_names
 
        ; (stub_h_exists, stub_c_exists, maybe_bcos, final_iface )
           <- if toInterp
+#ifdef GHCI
                then do 
                    -----------------  Generate byte code ------------------
                    (bcos,itbl_env) <- byteCodeGen dflags binds 
@@ -333,12 +372,15 @@ hscRecomp ghci_mode dflags have_object
                                    maybe_checked_iface new_iface tidy_details
 
                    return ( False, False, Just (bcos,itbl_env), final_iface )
+#else
+               then error "GHC not compiled with interpreter"
+#endif
 
                else do
                    -----------------  Convert to STG ------------------
                    (stg_binds, cost_centre_info, stg_back_end_info) 
                              <- _scc_ "CoreToStg"
-                                 myCoreToStg dflags this_mod binds
+                                myCoreToStg dflags this_mod binds
                    
                    -- Fill in the code-gen info for the earlier tidyCorePgm
                    writeIORef cg_info_ref (Just stg_back_end_info)
@@ -347,23 +389,23 @@ hscRecomp ghci_mode dflags have_object
                    final_iface <- _scc_ "MkFinalIface" 
                          mkFinalIface ghci_mode dflags location 
                                    maybe_checked_iface new_iface tidy_details
-
-                   ------------------  Code generation ------------------
-                   abstractC <- _scc_ "CodeGen"
-                                 codeGen dflags this_mod imported_modules
-                                        cost_centre_info fe_binders
-                                        local_tycons stg_binds
-                   
-                   ------------------  Code output -----------------------
-                   (stub_h_exists, stub_c_exists)
-                      <- codeOutput dflags this_mod local_tycons
-                            binds stg_binds
-                            c_code h_code abstractC
-                       
-                   return (stub_h_exists, stub_c_exists, Nothing, final_iface)
-
-       ; let final_details = tidy_details {md_binds = []} 
-
+                   if toNothing 
+                      then do
+                         return (False, False, Nothing, final_iface)
+                     else do
+                         ------------------  Code generation ------------------
+                         abstractC <- _scc_ "CodeGen"
+                                      codeGen dflags this_mod imported_modules
+                                              cost_centre_info fe_binders
+                                              local_tycons stg_binds
+                         
+                         ------------------  Code output -----------------------
+                         (stub_h_exists, stub_c_exists)
+                            <- codeOutput dflags this_mod [] --local_tycons
+                                  binds stg_binds
+                                  c_code h_code abstractC
+                             
+                         return (stub_h_exists, stub_c_exists, Nothing, final_iface)
 
          -- and the answer is ...
        ; return (HscRecomp pcs_final
@@ -408,27 +450,25 @@ myCoreToStg dflags this_mod tidy_binds
       () <- coreBindsSize tidy_binds `seq` return ()
       -- TEMP: the above call zaps some space usage allocated by the
       -- simplifier, which for reasons I don't understand, persists
-      -- thoroughout code generation
+      -- thoroughout code generation -- JRS
+      --
+      -- This is still necessary. -- SDM (10 Dec 2001)
 
-      stg_binds <- _scc_ "Core2Stg" coreToStg dflags tidy_binds
+      stg_binds <- _scc_ "Core2Stg" 
+            coreToStg dflags tidy_binds
 
-      (stg_binds2, cost_centre_info)
-          <- _scc_ "Core2Stg" stg2stg dflags this_mod stg_binds
+      (stg_binds2, cost_centre_info) <- _scc_ "Core2Stg" 
+            stg2stg dflags this_mod stg_binds
 
       let env_rhs :: CgInfoEnv
-         env_rhs = mkNameEnv [ (idName bndr, CgInfo (stgRhsArity rhs) caf_info)
+         env_rhs = mkNameEnv [ caf_info `seq` (idName bndr, CgInfo caf_info)
                              | (bind,_) <- stg_binds2, 
                                let caf_info 
                                     | stgBindHasCafRefs bind = MayHaveCafRefs
-                                    | otherwise = NoCafRefs,
-                               (bndr,rhs) <- stgBindPairs bind ]
+                                    | otherwise              = NoCafRefs,
+                               bndr <- stgBinders bind ]
 
       return (stg_binds2, cost_centre_info, env_rhs)
-   where
-      stgBindPairs (StgNonRec _ b r) = [(b,r)]
-      stgBindPairs (StgRec    _ prs) = prs
-
-
 \end{code}
 
 
@@ -482,19 +522,13 @@ A naked expression returns a singleton Name [it].
 
 \begin{code}
 hscStmt dflags hst hit pcs0 icontext stmt just_expr
-   = let 
-       InteractiveContext { 
-            ic_rn_env   = rn_env, 
-            ic_type_env = type_env,
-            ic_module   = scope_mod } = icontext
-     in
-     do { maybe_stmt <- hscParseStmt dflags stmt
+   =  do { maybe_stmt <- hscParseStmt dflags stmt
        ; case maybe_stmt of
             Nothing -> return (pcs0, Nothing)
             Just parsed_stmt -> do {
 
-          let { notExprStmt (ExprStmt _ _) = False;
-                notExprStmt _              = True 
+          let { notExprStmt (ExprStmt _ _ _) = False;
+                notExprStmt _                = True 
               };
 
           if (just_expr && notExprStmt parsed_stmt)
@@ -504,8 +538,7 @@ hscStmt dflags hst hit pcs0 icontext stmt just_expr
 
                -- Rename it
          (pcs1, print_unqual, maybe_renamed_stmt)
-                <- renameStmt dflags hit hst pcs0 scope_mod 
-                               iNTERACTIVE rn_env parsed_stmt
+                <- renameStmt dflags hit hst pcs0 icontext parsed_stmt
 
        ; case maybe_renamed_stmt of
                Nothing -> return (pcs0, Nothing)
@@ -514,10 +547,10 @@ hscStmt dflags hst hit pcs0 icontext stmt just_expr
                -- Typecheck it
          maybe_tc_return <- 
            if just_expr 
-               then case rn_stmt of { (syn, ExprStmt e _, decls) -> 
-                    typecheckExpr dflags pcs1 hst type_env
-                          print_unqual iNTERACTIVE (syn,e,decls) }
-               else typecheckStmt dflags pcs1 hst type_env
+               then case rn_stmt of { (ExprStmt e _ _, decls) -> 
+                    typecheckExpr dflags pcs1 hst (ic_type_env icontext)
+                          print_unqual iNTERACTIVE (e,decls) }
+               else typecheckStmt dflags pcs1 hst (ic_type_env icontext)
                           print_unqual iNTERACTIVE bound_names rn_stmt
 
        ; case maybe_tc_return of
@@ -556,7 +589,7 @@ hscParseStmt :: DynFlags -> String -> IO (Maybe RdrNameStmt)
 hscParseStmt dflags str
  = do --------------------------  Parser  ----------------
       showPass dflags "Parser"
-      _scc_ "Parser" do
+      _scc_ "Parser"  do
 
       buf <- stringToStringBuffer str
 
@@ -565,7 +598,7 @@ hscParseStmt dflags str
 
       case parseStmt buf PState{ bol = 0#, atbol = 1#,
                                 context = [], glasgow_exts = glaexts,
-                                loc = mkSrcLoc SLIT("<no file>") 0 } of {
+                                loc = mkSrcLoc SLIT("<interactive>") 1 } of {
 
        PFailed err -> do { hPutStrLn stderr (showSDoc err);
 --     Not yet implemented in <4.11    freeStringBuffer buf;
@@ -587,6 +620,139 @@ hscParseStmt dflags str
 
 %************************************************************************
 %*                                                                     *
+\subsection{Getting information about an identifer}
+%*                                                                     *
+%************************************************************************
+
+\begin{code}
+#ifdef GHCI
+hscThing -- like hscStmt, but deals with a single identifier
+  :: DynFlags
+  -> HomeSymbolTable
+  -> HomeIfaceTable
+  -> PersistentCompilerState    -- IN: persistent compiler state
+  -> InteractiveContext                -- Context for compiling
+  -> String                    -- The identifier
+  -> IO ( PersistentCompilerState,
+         [TyThing] )
+
+hscThing dflags hst hit pcs0 ic str
+   = do maybe_rdr_name <- myParseIdentifier dflags str
+       case maybe_rdr_name of {
+         Nothing -> return (pcs0, []);
+         Just rdr_name -> do
+
+       -- if the identifier is a constructor (begins with an
+       -- upper-case letter), then we need to consider both
+       -- constructor and type class identifiers.
+       let rdr_names
+               | occNameSpace occ == dataName = [ rdr_name, tccls_name ]
+               | otherwise                    = [ rdr_name ]
+             where
+               occ        = rdrNameOcc rdr_name
+               tccls_occ  = setOccNameSpace occ tcClsName
+               tccls_name = setRdrNameOcc rdr_name tccls_occ
+
+       (pcs, unqual, maybe_rn_result) <- 
+          renameRdrName dflags hit hst pcs0 ic rdr_names
+
+       case maybe_rn_result of {
+            Nothing -> return (pcs, []);
+            Just (names, decls) -> do {
+
+       maybe_pcs <- typecheckExtraDecls dflags pcs hst unqual
+                       iNTERACTIVE decls;
+
+       case maybe_pcs of {
+            Nothing -> return (pcs, []);
+            Just pcs ->
+               let do_lookup n
+                       | isLocalName n = lookupNameEnv (ic_type_env ic) n
+                       | otherwise     = lookupType hst (pcs_PTE pcs) n
+               
+                   maybe_ty_things = map do_lookup names
+               in
+               return (pcs, catMaybes maybe_ty_things) }
+        }}}
+
+myParseIdentifier dflags str
+  = do buf <- stringToStringBuffer str
+       let glaexts | dopt Opt_GlasgowExts dflags = 1#
+                  | otherwise                   = 0#
+
+       case parseIdentifier buf 
+               PState{ bol = 0#, atbol = 1#,
+                       context = [], glasgow_exts = glaexts,
+                       loc = mkSrcLoc SLIT("<interactive>") 1 } of
+
+         PFailed err -> do { hPutStrLn stderr (showSDoc err);
+                             freeStringBuffer buf;
+                              return Nothing }
+
+         POk _ rdr_name -> do { --should, but can't: freeStringBuffer buf;
+                                return (Just rdr_name) }
+#endif
+\end{code}
+
+%************************************************************************
+%*                                                                     *
+\subsection{Find all the things defined in a module}
+%*                                                                     *
+%************************************************************************
+
+\begin{code}
+#ifdef GHCI
+hscModuleContents
+  :: DynFlags
+  -> HomeSymbolTable
+  -> HomeIfaceTable
+  -> PersistentCompilerState    -- IN: persistent compiler state
+  -> Module                    -- module to inspect
+  -> Bool                      -- grab just the exports, or the whole toplev
+  -> IO (PersistentCompilerState, Maybe [TyThing])
+
+hscModuleContents dflags hst hit pcs0 mod exports_only = do {
+
+  -- slurp the interface if necessary
+  (pcs1, print_unqual, maybe_rn_stuff) 
+       <- slurpIface dflags hit hst pcs0 mod;
+
+  case maybe_rn_stuff of {
+       Nothing -> return (pcs0, Nothing);
+       Just (names, rn_decls) -> do {
+
+  -- Typecheck the declarations
+  maybe_pcs <-
+     typecheckExtraDecls dflags pcs1 hst print_unqual iNTERACTIVE rn_decls;
+
+  case maybe_pcs of {
+       Nothing   -> return (pcs1, Nothing);
+       Just pcs2 -> 
+
+  let { all_names 
+          | exports_only = names
+          | otherwise =
+            let { iface = fromJust (lookupModuleEnv hit mod);
+                  env   = fromJust (mi_globals iface);
+                  range = rdrEnvElts env;
+             } in
+            -- grab all the things from the global env that are locally def'd
+            nub [ n | elts <- range, GRE n LocalDef _ <- elts ];
+
+       pte = pcs_PTE pcs2;
+
+       ty_things = map (fromJust . lookupType hst pte) all_names;
+
+      } in
+
+  return (pcs2, Just ty_things)
+  }}}}
+#endif
+\end{code}
+
+%************************************************************************
+%*                                                                     *
 \subsection{Initial persistent state}
 %*                                                                     *
 %************************************************************************
@@ -612,10 +778,18 @@ initPersistentRenamerState :: IO PersistentRenamerState
                                      nsIPs   = emptyFM },
              prsDecls   = (emptyNameEnv, 0),
              prsInsts   = (emptyBag, 0),
-             prsRules   = (emptyBag, 0),
+             prsRules   = foldr add_rule (emptyBag, 0) builtinRules,
              prsImpMods = emptyFM
             }
         )
+  where
+    add_rule (name,rule) (rules, n_rules)
+        = (gated_decl `consBag` rules, n_rules+1)
+       where
+          gated_decl = (gate_fn, (mod, IfaceRuleOut rdr_name rule))
+          mod        = nameModule name
+          rdr_name   = mkRdrOrig (moduleName mod) (nameOccName name)
+          gate_fn vis_fn = vis_fn name -- Load the rule whenever name is visible
 
 initOrigNames :: FiniteMap (ModuleName,OccName) Name
 initOrigNames