Language.Haskell.GhcMod

The ghc-mod library.

Cradle

data Cradle

The environment where this library is used

Constructors

Cradle

Fields

cradleCurrentDir :: FilePath

The directory where this library is executed

cradleCabalDir :: Maybe FilePath

The directory where a cabal file is found

cradleCabalFile :: Maybe FilePath

The file name of the found cabal file

cradlePackageConf :: Maybe FilePath

The sandbox directory (e.g. "/foo/bar/packages-<ver>.conf/")

Instances

Eq Cradle

Show Cradle

findCradle

Arguments

:: Maybe FilePath

A FilePath for a sandbox

-> GHCVersion

-> IO Cradle

Finding Cradle. An error would be thrown.

GHC version

type GHCVersion = String

GHC version in String

getGHCVersion :: IO (GHCVersion, Int)

Getting GHC version. 7.6.3 becames 706 in the second of the result.

Options

data Options

Constructors

Options

Fields

outputStyle :: OutputStyle

hlintOpts :: [String]

ghcOpts :: [String]

operators :: Bool

detailed :: Bool

If True, browse also returns types.

expandSplice :: Bool

Whether or not Template Haskell should be expanded.

sandbox :: Maybe FilePath

The sandbox directory.

data OutputStyle

Output style.

Constructors

LispStyle

S expression style

PlainStyle

Plain textstyle

defaultOptions :: Options

A default Options.

Types

type ModuleString = String

Module name

type Expression = String

Haskell expression

IO utilities

browseModule

Arguments

:: Options

-> ModuleString

A module name. (e.g. "Data.List")

-> IO String

Getting functions, classes, etc from a module. If detailed is True, their types are also obtained.

checkSyntax

Arguments

:: Options

-> Cradle

-> FilePath

A target file

-> IO String

Checking syntax of a target file using GHC. Warnings and errors are returned.

lintSyntax

Arguments

:: Options

-> FilePath

A target file.

-> IO String

Checking syntax of a target file using hlint. Warnings and errors are returned.

infoExpr

Arguments

:: Options

-> Cradle

-> FilePath

A target file

-> ModuleString

A module name

-> Expression

A Haskell expression

-> IO String

Obtaining information of a target expression. (GHCi's info:)

typeExpr

Arguments

:: Options

-> Cradle

-> FilePath

A target file

-> ModuleString

A odule name

-> Int

Line number

-> Int

Column number

-> IO String

Obtaining type of a target expression. (GHCi's type:)

listModules :: Options -> IO String

Listing installed modules.

listLanguages :: Options -> IO String

Listing language extensions.

listFlags :: Options -> IO String

Listing GHC flags. (e.g -fno-warn-orphans)

debugInfo

Arguments

:: Options

-> Cradle

-> GHCVersion

-> FilePath

A target file

-> IO String

Obtaining debug information.

Converting the Ghc monad to the IO monad

withGHC

Arguments

:: Alternative m

=> FilePath

A target file displayed in an error message

-> Ghc (m a)

Ghc actions created by the Ghc utilities

-> IO (m a)

Converting the Ghc monad to the IO monad.

withGHCDummyFile

Arguments

:: Alternative m

=> Ghc (m a)

Ghc actions created by the Ghc utilities

-> IO (m a)

Converting the Ghc monad to the IO monad.

Ghc utilities

browse

Arguments

:: Options

-> ModuleString

A module name. (e.g. "Data.List")

-> Ghc [String]

Getting functions, classes, etc from a module. If detailed is True, their types are also obtained.

check

Arguments

:: Options

-> Cradle

-> FilePath

A target file

-> Ghc [String]

Checking syntax of a target file using GHC. Warnings and errors are returned.

info

Arguments

:: Options

-> Cradle

-> FilePath

A target file

-> ModuleString

A module name

-> Expression

A Haskell expression

-> Ghc String

Obtaining information of a target expression. (GHCi's info:)

typeOf

Arguments

:: Options

-> Cradle

-> FilePath

A target file

-> ModuleString

A odule name

-> Int

Line number

-> Int

Column number

-> Ghc String

Obtaining type of a target expression. (GHCi's type:)

listMods :: Options -> Ghc [String]

Listing installed modules.

debug

Arguments

:: Options

-> Cradle

-> GHCVersion

-> FilePath

A target file

-> Ghc [String]

Obtaining debug information.