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.

cradleRootDir :: FilePath

The project root directory.

cradleCabalFile :: Maybe FilePath

The file name of the found cabal file.

cradlePkgDbStack :: [GhcPkgDb]

Package database stack

Instances

Eq Cradle

Show Cradle

findCradle :: IO Cradle

Finding Cradle. Find a cabal file by tracing ancestor directories. Find a sandbox according to a cabal sandbox config in a cabal directory.

Options

data Options

Constructors

Options

Fields

outputStyle :: OutputStyle

hlintOpts :: [String]

ghcOpts :: [GHCOption]

operators :: Bool

If True, browse also returns operators.

detailed :: Bool

If True, browse also returns types.

qualified :: Bool

If True, browse will return fully qualified name

lineSeparator :: LineSeparator

Line separator string.

newtype LineSeparator

The type for line separator. Historically, a Null string is used.

Constructors

LineSeparator String

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

bootInfo :: Options -> Cradle -> IO String

Printing necessary information for front-end booting.

browseModule

Arguments

:: Options

-> Cradle

-> 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. If operators is True, operators are also returned.

checkSyntax

Arguments

:: Options

-> Cradle

-> [FilePath]

The target files.

-> 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.

expandTemplate

Arguments

:: Options

-> Cradle

-> [FilePath]

The target files.

-> IO String

Expanding Haskell Template.

infoExpr

Arguments

:: Options

-> Cradle

-> FilePath

A target file.

-> Expression

A Haskell expression.

-> IO String

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

typeExpr

Arguments

:: Options

-> Cradle

-> FilePath

A target file.

-> Int

Line number.

-> Int

Column number.

-> IO String

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

listModules :: Options -> Cradle -> 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 :: Options -> Cradle -> IO String

Obtaining debug information.

rootInfo :: Options -> Cradle -> IO String

Obtaining root information.

packageDoc :: Options -> Cradle -> ModuleString -> IO String

Obtaining the package name and the doc path of a module.

findSymbol :: Options -> Cradle -> Symbol -> IO String

Finding modules to which the symbol belong.