Separating IO and Ghc.

Language/Haskell/GhcMod.hs

@@ -1,22 +1,33 @@
 module Language.Haskell.GhcMod (
-    browseModule
-  , checkSyntax
-  , check
-  , module Language.Haskell.GhcMod.Cradle
-  , debugInfo
-  , debug
-  , infoExpr
-  , info
-  , typeExpr
-  , typeOf
-  , listLanguages
-  , lintSyntax
-  , listModules
-  , module Language.Haskell.GhcMod.Types
-  , listFlags
+  -- * Cradle
+    Cradle(..)
+  , findCradle
+  -- * GHC version
   , getGHCVersion
-  , withGHCDummyFile
+  -- * Options
+  , Options(..)
+  , OutputStyle(..)
+  , defaultOptions
+  -- * 'IO' utilities
+  , browseModule
+  , checkSyntax
+  , debugInfo
+  , infoExpr
+  , typeExpr
+  , listModules
+  , listLanguages
+  , listFlags
+  , lintSyntax
+  -- * Converting the 'Ghc' monad to the 'IO' monad
   , withGHC
+  , withGHCDummyFile
+  -- * 'Ghc' utilities
+  , browse
+  , check
+  , debug
+  , info
+  , typeOf
+  , list
   ) where
 
 import Language.Haskell.GhcMod.Browse

Language/Haskell/GhcMod/Browse.hs

@@ -17,8 +17,8 @@ import Var
 
 ----------------------------------------------------------------
 
-browseModule :: Options -> String -> Ghc String
-browseModule opt mdlName = convert opt . format <$> browse opt mdlName
+browseModule :: Options -> String -> IO String
+browseModule opt mdlName = convert opt . format <$> withGHCDummyFile (browse opt mdlName)
   where
     format
       | operators opt = formatOps

Language/Haskell/GhcMod/Check.hs

@@ -12,12 +12,12 @@ import Prelude
 
 ----------------------------------------------------------------
 
-checkSyntax :: Options -> Cradle -> String -> Ghc String
-checkSyntax opt cradle file = unlines <$> check opt cradle file
+checkSyntax :: Options -> Cradle -> FilePath -> IO String
+checkSyntax opt cradle file = unlines <$> withGHC file (check opt cradle file)
 
 ----------------------------------------------------------------
 
-check :: Options -> Cradle -> String -> Ghc [String]
+check :: Options -> Cradle -> FilePath -> Ghc [String]
 check opt cradle fileName = checkIt `gcatch` handleErrMsg
   where
     checkIt = do

Language/Haskell/GhcMod/Debug.hs

@@ -14,10 +14,10 @@ import Prelude
 
 ----------------------------------------------------------------
 
-debugInfo :: Options -> Cradle -> String -> String -> Ghc String
-debugInfo opt cradle ver fileName = unlines <$> debug opt cradle ver fileName
+debugInfo :: Options -> Cradle -> String -> FilePath -> IO String
+debugInfo opt cradle ver fileName = unlines <$> withGHC fileName (debug opt cradle ver fileName)
 
-debug :: Options -> Cradle -> String -> String -> Ghc [String]
+debug :: Options -> Cradle -> String -> FilePath -> Ghc [String]
 debug opt cradle ver fileName = do
     (gopts, incDir, pkgs) <-
         if cabal then

Language/Haskell/GhcMod/Info.hs

@@ -36,8 +36,8 @@ data Cmd = Info | Type deriving Eq
 
 ----------------------------------------------------------------
 
-infoExpr :: Options -> Cradle -> ModuleString -> Expression -> FilePath -> Ghc String
-infoExpr opt cradle modstr expr file = (++ "\n") <$> info opt cradle file modstr expr
+infoExpr :: Options -> Cradle -> ModuleString -> Expression -> FilePath -> IO String
+infoExpr opt cradle modstr expr file = (++ "\n") <$> withGHCDummyFile (info opt cradle file modstr expr)
 
 info :: Options -> Cradle -> FilePath -> ModuleString -> Expression -> Ghc String
 info opt cradle fileName modstr expr =
@@ -67,8 +67,8 @@ instance HasType (LHsBind Id) where
 instance HasType (LPat Id) where
     getType _ (L spn pat) = return $ Just (spn, hsPatType pat)
 
-typeExpr :: Options -> Cradle -> ModuleString -> Int -> Int -> FilePath -> Ghc String
-typeExpr opt cradle modstr lineNo colNo file = typeOf opt cradle file modstr lineNo colNo
+typeExpr :: Options -> Cradle -> ModuleString -> Int -> Int -> FilePath -> IO String
+typeExpr opt cradle modstr lineNo colNo file = withGHCDummyFile $ typeOf opt cradle file modstr lineNo colNo
 
 typeOf :: Options -> Cradle -> FilePath -> ModuleString -> Int -> Int -> Ghc String
 typeOf opt cradle fileName modstr lineNo colNo =

Language/Haskell/GhcMod/List.hs

@@ -10,8 +10,8 @@ import UniqFM
 
 ----------------------------------------------------------------
 
-listModules :: Options -> Ghc String
-listModules opt = convert opt . nub . sort <$> list opt
+listModules :: Options -> IO String
+listModules opt = convert opt . nub . sort <$> withGHCDummyFile (list opt)
 
 list :: Options -> Ghc [String]
 list opt = do

src/GHCMod.hs

@@ -91,21 +91,21 @@ main = flip catches handlers $ do
         cmdArg3 = cmdArg !. 3
         cmdArg4 = cmdArg !. 4
     res <- case cmdArg0 of
-      "browse" -> withGHCDummyFile $ concat <$> mapM (browseModule opt) (tail cmdArg)
-      "list"   -> withGHCDummyFile $ listModules opt
-      "check"  -> withGHCFile (checkSyntax opt cradle) cmdArg1
-      "expand" -> withGHCFile (checkSyntax opt { expandSplice = True } cradle) cmdArg1
-      "debug"  -> withGHCFile (debugInfo opt cradle strVer) cmdArg1
-      "type"   -> withGHCFile (typeExpr opt cradle cmdArg2 (read cmdArg3) (read cmdArg4)) cmdArg1
-      "info"   -> withGHCFile (infoExpr opt cradle cmdArg2 cmdArg3) cmdArg1
+      "browse" -> concat <$> mapM (browseModule opt) (tail cmdArg)
+      "list"   -> listModules opt
+      "check"  -> checkSyntax opt cradle cmdArg1
+      "expand" -> checkSyntax opt { expandSplice = True } cradle cmdArg1
+      "debug"  -> debugInfo opt cradle strVer cmdArg1
+      "type"   -> typeExpr opt cradle cmdArg2 (read cmdArg3) (read cmdArg4) cmdArg1
+      "info"   -> infoExpr opt cradle cmdArg2 cmdArg3 cmdArg1
       "lint"   -> withFile (lintSyntax opt) cmdArg1
       "lang"   -> listLanguages opt
       "flag"   -> listFlags opt
       "boot"   -> do
-         mods  <- withGHCDummyFile $ listModules opt
+         mods  <- listModules opt
          langs <- listLanguages opt
          flags <- listFlags opt
-         pre   <- withGHCDummyFile $ concat <$> mapM (browseModule opt) preBrowsedModules
+         pre   <- concat <$> mapM (browseModule opt) preBrowsedModules
          return $ mods ++ langs ++ flags ++ pre
       cmd      -> throw (NoSuchCommand cmd)
     putStr res
@@ -130,7 +130,6 @@ main = flip catches handlers $ do
         if exist
             then cmd file
             else throw (FileNotExist file)
-    withGHCFile cmd = withFile (\f -> withGHC f (cmd f))
     xs !. idx
       | length xs <= idx = throw SafeList
       | otherwise = xs !! idx

test/BrowseSpec.hs

@@ -1,10 +1,9 @@
 module BrowseSpec where
 
 import Control.Applicative
-import Test.Hspec
-import Browse
 import Expectation
-import Types
+import Language.Haskell.GhcMod
+import Test.Hspec
 
 spec :: Spec
 spec = do

test/CabalApiSpec.hs

@@ -1,8 +1,8 @@
 module CabalApiSpec where
 
 import Control.Applicative
+import Language.Haskell.GhcMod.CabalApi
 import Test.Hspec
-import CabalApi
 
 spec :: Spec
 spec = do

test/CheckSpec.hs

@@ -1,13 +1,10 @@
 module CheckSpec where
 
-import CabalApi
-import Check
-import Cradle
 import Data.List (isSuffixOf, isInfixOf, isPrefixOf)
 import Expectation
-import Test.Hspec
-import Types
+import Language.Haskell.GhcMod
 import System.FilePath
+import Test.Hspec
 
 spec :: Spec
 spec = do

test/CradleSpec.hs

@@ -1,13 +1,12 @@
 module CradleSpec where
 
 import Control.Applicative
-import Cradle
 import Data.List (isPrefixOf)
 import Expectation
+import Language.Haskell.GhcMod
+import System.Directory (canonicalizePath)
 import System.FilePath (addTrailingPathSeparator, (</>))
 import Test.Hspec
-import Types
-import System.Directory (canonicalizePath)
 
 spec :: Spec
 spec = do

test/DebugSpec.hs

@@ -1,18 +1,15 @@
 module DebugSpec where
 
-import CabalApi
-import Cradle
-import Debug
 import Expectation
+import Language.Haskell.GhcMod
 import Test.Hspec
-import Types
 
 checkFast :: String -> String -> IO ()
 checkFast file ans = withDirectory_ "test/data" $ do
     (strVer,_) <- getGHCVersion
     cradle <- findCradle Nothing strVer
-    res <- debug defaultOptions cradle strVer file
-    res `shouldContain` ans
+    res <- debugInfo defaultOptions cradle strVer file
+    lines res `shouldContain` ans
 
 spec :: Spec
 spec = do

test/FlagSpec.hs

@@ -1,10 +1,9 @@
 module FlagSpec where
 
 import Control.Applicative
-import Test.Hspec
 import Expectation
-import Flag
-import Types
+import Language.Haskell.GhcMod
+import Test.Hspec
 
 spec :: Spec
 spec = do

test/InfoSpec.hs

@@ -1,14 +1,11 @@
 module InfoSpec where
 
-import CabalApi
-import Cradle
 import Data.List (isPrefixOf)
 import Expectation
-import Info
-import Test.Hspec
-import Types
-import System.Process
+import Language.Haskell.GhcMod
 import System.Exit
+import System.Process
+import Test.Hspec
 
 spec :: Spec
 spec = do

test/LangSpec.hs

@@ -1,10 +1,9 @@
 module LangSpec where
 
 import Control.Applicative
-import Test.Hspec
 import Expectation
-import Lang
-import Types
+import Language.Haskell.GhcMod
+import Test.Hspec
 
 spec :: Spec
 spec = do

test/LintSpec.hs

@@ -1,8 +1,7 @@
 module LintSpec where
 
+import Language.Haskell.GhcMod
 import Test.Hspec
-import Lint
-import Types
 
 spec :: Spec
 spec = do

test/ListSpec.hs

@@ -1,10 +1,9 @@
 module ListSpec where
 
 import Control.Applicative
-import Test.Hspec
 import Expectation
-import List
-import Types
+import Language.Haskell.GhcMod
+import Test.Hspec
 
 spec :: Spec
 spec = do