HIE.Bios.Types

Documentation

data BIOSVerbosity

Constructors

Silent

Verbose

data CradleOpts

Constructors

CradleOpts

Fields

• cradleOptsVerbosity :: BIOSVerbosity
• cradleOptsHandle :: Maybe Handle

  The handle where to send output to, if not set, stderr

defaultCradleOpts :: CradleOpts

data OutputStyle

Output style.

Constructors

LispStyle

S expression style.

PlainStyle

Plain textstyle.

newtype LineSeparator

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

Constructors

LineSeparator String

data Options

Constructors

Options

Fields

• outputStyle :: OutputStyle
• hlintOpts :: [String]
• ghcOpts :: [String]
• 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.

defaultOptions :: Options

A default Options.

type Builder = String -> String

replace :: Char -> String -> String -> Builder

>>> replace '"' "\\\"" "foo\"bar" ""
"foo\\\"bar"

inter :: Char -> [Builder] -> Builder

convert :: ToString a => Options -> a -> String

class ToString a where

Methods

toLisp :: Options -> a -> Builder

toPlain :: Options -> a -> Builder

Instances

ToString String

>>> toLisp defaultOptions "fo\"o" ""
"\"fo\\\"o\""
>>> toPlain defaultOptions "foo" ""
"foo"

Defined in HIE.Bios.Types

Methods

toLisp :: Options -> String -> Builder

toPlain :: Options -> String -> Builder

ToString [((Int, Int, Int, Int), String)]

>>> let inp = [((1,2,3,4),"foo"),((5,6,7,8),"bar")] :: [((Int,Int,Int,Int),String)]
>>> toLisp defaultOptions inp ""
"((1 2 3 4 \"foo\") (5 6 7 8 \"bar\"))"
>>> toPlain defaultOptions inp ""
"1 2 3 4 \"foo\"\n5 6 7 8 \"bar\""

Defined in HIE.Bios.Types

Methods

toLisp :: Options -> [((Int, Int, Int, Int), String)] -> Builder

toPlain :: Options -> [((Int, Int, Int, Int), String)] -> Builder

ToString [String]

>>> toLisp defaultOptions ["foo", "bar", "ba\"z"] ""
"(\"foo\" \"bar\" \"ba\\\"z\")"
>>> toPlain defaultOptions ["foo", "bar", "baz"] ""
"foo\nbar\nbaz"

Defined in HIE.Bios.Types

Methods

toLisp :: Options -> [String] -> Builder

toPlain :: Options -> [String] -> Builder

lineSep :: Options -> String

toSexp1 :: Options -> [String] -> Builder

toSexp2 :: [Builder] -> Builder

tupToString :: Options -> ((Int, Int, Int, Int), String) -> Builder

quote :: Options -> String -> Builder

data Cradle

The environment where this library is used.

Constructors

Cradle

Fields

• cradleRootDir :: FilePath

  The project root directory.

• cradleOptsProg :: CradleAction

  The action which needs to be executed to get the correct command line arguments

Instances

Show Cradle

Defined in HIE.Bios.Types

Methods

showsPrec :: Int -> Cradle -> ShowS

show :: Cradle -> String

showList :: [Cradle] -> ShowS

data CradleAction

Constructors

CradleAction

Fields

• actionName :: String

  Name of the action

• getDependencies :: IO [FilePath]

  Dependencies of a cradle that might change the cradle. Contains both files specified in hie.yaml as well as specified by the build-tool if there is any. FilePaths are expected to be relative to the cradleRootDir to which this CradleAction belongs to. Files returned by this action might not actually exist. This is useful, because, sometimes, adding specific files changes the options that a Cradle may return, thus, needs reload as soon as these files are created.

• getOptions :: FilePath -> IO (ExitCode, String, [String])

  Options to compile the given file with. The result consists of the return code of the operation that has been run, the stdout of the process, and a list of options that are needed to compile the given file.

Instances

Show CradleAction

Defined in HIE.Bios.Types

Methods

showsPrec :: Int -> CradleAction -> ShowS

show :: CradleAction -> String

showList :: [CradleAction] -> ShowS

data CompilerOptions

Option information for GHC

Constructors

CompilerOptions

Fields

• ghcOptions :: [String]

  Command line options

Instances

Eq CompilerOptions

Defined in HIE.Bios.Types

Methods

(==) :: CompilerOptions -> CompilerOptions -> Bool

(/=) :: CompilerOptions -> CompilerOptions -> Bool

Show CompilerOptions

Defined in HIE.Bios.Types

Methods

showsPrec :: Int -> CompilerOptions -> ShowS

show :: CompilerOptions -> String

showList :: [CompilerOptions] -> ShowS