Safe Haskell	None
Language	Haskell2010

Hhp

Contents

Cradle
Options
Types
IO utilities

Description

The Happy Haskell Programming library. API for commands.

Synopsis

data Cradle = Cradle {
- cradleCurrentDir :: FilePath
- cradleRootDir :: FilePath
- cradleCabalFile :: Maybe FilePath
- cradlePkgDbStack :: [GhcPkgDb]
}
findCradle :: IO Cradle
data Options = Options {
- outputStyle :: OutputStyle
- hlintOpts :: [String]
- ghcOpts :: [GHCOption]
- operators :: Bool
- detailed :: Bool
- qualified :: Bool
- lineSeparator :: LineSeparator
}
newtype LineSeparator = LineSeparator String
data OutputStyle
- = LispStyle
- | PlainStyle
defaultOptions :: Options
type ModuleString = String
type Expression = String
bootInfo :: Options -> Cradle -> IO String
browseModule :: Options -> Cradle -> ModuleString -> IO String
checkSyntax :: Options -> Cradle -> [FilePath] -> IO String
lintSyntax :: Options -> FilePath -> IO String
expandTemplate :: Options -> Cradle -> [FilePath] -> IO String
infoExpr :: Options -> Cradle -> FilePath -> Expression -> IO String
typeExpr :: Options -> Cradle -> FilePath -> Int -> Int -> IO String
listModules :: Options -> Cradle -> IO String
listLanguages :: Options -> IO String
listFlags :: Options -> IO String
debugInfo :: Options -> Cradle -> IO String
rootInfo :: Options -> Cradle -> IO String
packageDoc :: Options -> Cradle -> ModuleString -> IO String
findSymbol :: Options -> Cradle -> Symbol -> IO String

Cradle

data Cradle Source #

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 Source #
Instance details Defined in Hhp.Types Methods (==) :: Cradle -> Cradle -> Bool # (/=) :: Cradle -> Cradle -> Bool #
Show Cradle Source #
Instance details Defined in Hhp.Types Methods showsPrec :: Int -> Cradle -> ShowS # show :: Cradle -> String # showList :: [Cradle] -> ShowS #

findCradle :: IO Cradle Source #

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 Source #

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 Source #

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

Constructors

LineSeparator String

data OutputStyle Source #

Output style.

Constructors

LispStyle	S expression style.
PlainStyle	Plain textstyle.

defaultOptions :: Options Source #

A default Options.

Types

type ModuleString = String Source #

Module name.

type Expression = String Source #

Haskell expression.

`IO` utilities

bootInfo :: Options -> Cradle -> IO String Source #

Printing necessary information for front-end booting.

browseModule Source #

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 Source #

Arguments