Merge pull request #153 from eagletmt/cradle-list-and-browse

Make `ghc-mod list` and `ghc-mod browse` sandbox-aware

Language/Haskell/GhcMod/Browse.hs

@@ -1,6 +1,7 @@
 module Language.Haskell.GhcMod.Browse (browseModule, browse) where
 
 import Control.Applicative
+import Control.Monad (void)
 import Data.Char
 import Data.List
 import Data.Maybe (fromMaybe)
@@ -21,9 +22,10 @@ import Var
 --   If 'detailed' is 'True', their types are also obtained.
 --   If 'operators' is 'True', operators are also returned.
 browseModule :: Options
+             -> Cradle
              -> ModuleString -- ^ A module name. (e.g. \"Data.List\")
              -> IO String
-browseModule opt mdlName = convert opt . format <$> withGHCDummyFile (browse opt mdlName)
+browseModule opt cradle mdlName = convert opt . format <$> withGHCDummyFile (browse opt cradle mdlName)
   where
     format
       | operators opt = formatOps
@@ -41,10 +43,11 @@ browseModule opt mdlName = convert opt . format <$> withGHCDummyFile (browse opt
 --   If 'detailed' is 'True', their types are also obtained.
 --   If 'operators' is 'True', operators are also returned.
 browse :: Options
+       -> Cradle
        -> ModuleString -- ^ A module name. (e.g. \"Data.List\")
        -> Ghc [String]
-browse opt mdlName = do
-    initializeFlags opt
+browse opt cradle mdlName = do
+    void $ initializeFlagsWithCradle opt cradle [] False
     getModule >>= getModuleInfo >>= listExports
   where
     getModule = findModule (mkModuleName mdlName) Nothing

Language/Haskell/GhcMod/List.hs

@@ -1,6 +1,7 @@
 module Language.Haskell.GhcMod.List (listModules, listMods) where
 
 import Control.Applicative
+import Control.Monad (void)
 import Data.List
 import GHC
 import Language.Haskell.GhcMod.GHCApi
@@ -11,13 +12,13 @@ import UniqFM
 ----------------------------------------------------------------
 
 -- | Listing installed modules.
-listModules :: Options -> IO String
-listModules opt = convert opt . nub . sort <$> withGHCDummyFile (listMods opt)
+listModules :: Options -> Cradle -> IO String
+listModules opt cradle = convert opt . nub . sort <$> withGHCDummyFile (listMods opt cradle)
 
 -- | Listing installed modules.
-listMods :: Options -> Ghc [String]
-listMods opt = do
-    initializeFlags opt
+listMods :: Options -> Cradle -> Ghc [String]
+listMods opt cradle = do
+    void $ initializeFlagsWithCradle opt cradle [] False
     getExposedModules <$> getSessionDynFlags
   where
     getExposedModules = map moduleNameString

src/GHCMod.hs

@@ -96,8 +96,8 @@ main = flip catches handlers $ do
                         then f
                         else throw (TooManyArguments cmdArg0)
     res <- case cmdArg0 of
-      "browse" -> concat <$> mapM (browseModule opt) remainingArgs
-      "list"   -> listModules opt
+      "browse" -> concat <$> mapM (browseModule opt cradle) remainingArgs
+      "list"   -> listModules opt cradle
       "check"  -> checkSyntax opt cradle remainingArgs
       "expand" -> checkSyntax opt { expandSplice = True } cradle remainingArgs
       "debug"  -> nArgs 1 $ debugInfo opt cradle cmdArg1
@@ -107,10 +107,10 @@ main = flip catches handlers $ do
       "lang"   -> listLanguages opt
       "flag"   -> listFlags opt
       "boot"   -> do
-         mods  <- listModules opt
+         mods  <- listModules opt cradle
          langs <- listLanguages opt
          flags <- listFlags opt
-         pre   <- concat <$> mapM (browseModule opt) preBrowsedModules
+         pre   <- concat <$> mapM (browseModule opt cradle) preBrowsedModules
          return $ mods ++ langs ++ flags ++ pre
       "help"   -> return $ usageInfo usage argspec
       cmd      -> throw (NoSuchCommand cmd)

test/BrowseSpec.hs

@@ -8,14 +8,17 @@ spec :: Spec
 spec = do
     describe "browseModule" $ do
         it "lists up symbols in the module" $ do
-            syms <- lines <$> browseModule defaultOptions "Data.Map"
+            cradle <- findCradle
+            syms <- lines <$> browseModule defaultOptions cradle "Data.Map"
             syms `shouldContain` ["differenceWithKey"]
 
     describe "browseModule -d" $ do
         it "lists up symbols with type info in the module" $ do
-            syms <- lines <$> browseModule defaultOptions { detailed = True } "Data.Either"
+            cradle <- findCradle
+            syms <- lines <$> browseModule defaultOptions { detailed = True } cradle "Data.Either"
             syms `shouldContain` ["either :: (a -> c) -> (b -> c) -> Either a b -> c"]
 
         it "lists up data constructors with type info in the module" $ do
-            syms <- lines <$> browseModule defaultOptions { detailed = True} "Data.Either"
+            cradle <- findCradle
+            syms <- lines <$> browseModule defaultOptions { detailed = True} cradle "Data.Either"
             syms `shouldContain` ["Left :: a -> Either a b"]

test/ListSpec.hs

@@ -8,5 +8,6 @@ spec :: Spec
 spec = do
     describe "listModules" $ do
         it "lists up module names" $ do
-            modules <- lines <$> listModules defaultOptions
+            cradle <- findCradle
+            modules <- lines <$> listModules defaultOptions cradle
             modules `shouldContain` ["Data.Map"]