Safe Haskell	Safe
Language	Haskell2010

HIE.Bios.Types

Synopsis

data BIOSVerbosity
- = Silent
- | Verbose
data CradleOpts = CradleOpts {
- cradleOptsVerbosity :: BIOSVerbosity
- cradleOptsHandle :: Maybe Handle
}
defaultCradleOpts :: CradleOpts
data OutputStyle
- = LispStyle
- | PlainStyle
newtype LineSeparator = LineSeparator String
data Options = Options {
- outputStyle :: OutputStyle
- hlintOpts :: [String]
- ghcOpts :: [String]
- operators :: Bool
- detailed :: Bool
- qualified :: Bool
- lineSeparator :: LineSeparator
}
defaultOptions :: Options
type Builder = String -> String
replace :: Char -> String -> String -> Builder
inter :: Char -> [Builder] -> Builder
convert :: ToString a => Options -> a -> String
class ToString a where
- toLisp :: Options -> a -> Builder
- toPlain :: Options -> a -> 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 = Cradle {
- cradleRootDir :: FilePath
- cradleOptsProg :: CradleAction
}
data CradleAction = CradleAction {
- actionName :: String
- getDependencies :: IO [FilePath]
- getOptions :: FilePath -> IO (ExitCode, String, [String])
}
data CompilerOptions = CompilerOptions {
- ghcOptions :: [String]
}

Documentation

data BIOSVerbosity Source #

Constructors

Silent
Verbose

data CradleOpts Source #

Constructors

CradleOpts
Fields cradleOptsVerbosity :: BIOSVerbosity cradleOptsHandle :: Maybe Handle The handle where to send output to, if not set, stderr

defaultCradleOpts :: CradleOpts Source #

data OutputStyle Source #

Output style.

Constructors

LispStyle	S expression style.
PlainStyle	Plain textstyle.

newtype LineSeparator Source #

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

Constructors

LineSeparator String

data Options Source #

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

A default Options.

type Builder = String -> String Source #

replace :: Char -> String -> String -> Builder Source #

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

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

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

class ToString a where Source #

Methods

toLisp :: Options -> a -> Builder Source #

toPlain :: Options -> a -> Builder Source #

Instances

ToString String Source #	`>>>` `toLisp defaultOptions "fo\"o" ""`"\"fo\\\"o\"" `>>>` `toPlain defaultOptions "foo" ""`"foo"
Instance details Defined in HIE.Bios.Types Methods toLisp :: Options -> String -> Builder Source # toPlain :: Options -> String -> Builder Source #
ToString [((Int, Int, Int, Int), String)] Source #	`>>>` `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\""
Instance details Defined in HIE.Bios.Types Methods toLisp :: Options -> [((Int, Int, Int, Int), String)] -> Builder Source # toPlain :: Options -> [((Int, Int, Int, Int), String)] -> Builder Source #
ToString [String] Source #	`>>>` `toLisp defaultOptions ["foo", "bar", "ba\"z"] ""`"(\"foo\" \"bar\" \"ba\\\"z\")" `>>>` `toPlain defaultOptions ["foo", "bar", "baz"] ""`"foo\nbar\nbaz"
Instance details Defined in HIE.Bios.Types Methods toLisp :: Options -> [String] -> Builder Source # toPlain :: Options -> [String] -> Builder Source #

lineSep :: Options -> String Source #

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

toSexp2 :: [Builder] -> Builder Source #

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

quote :: Options -> String -> Builder Source #

data Cradle Source #

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 Source #
Instance details Defined in HIE.Bios.Types Methods showsPrec :: Int -> Cradle -> ShowS # show :: Cradle -> String # showList :: [Cradle] -> ShowS #

data CradleAction Source #

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 Source #
Instance details Defined in HIE.Bios.Types Methods showsPrec :: Int -> CradleAction -> ShowS # show :: CradleAction -> String # showList :: [CradleAction] -> ShowS #

data CompilerOptions Source #

Option information for GHC

Constructors

CompilerOptions
Fields ghcOptions :: [String] Command line options

Instances

Eq CompilerOptions Source #
Instance details Defined in HIE.Bios.Types Methods (==) :: CompilerOptions -> CompilerOptions -> Bool # (/=) :: CompilerOptions -> CompilerOptions -> Bool #
Show CompilerOptions Source #
Instance details Defined in HIE.Bios.Types Methods showsPrec :: Int -> CompilerOptions -> ShowS # show :: CompilerOptions -> String # showList :: [CompilerOptions] -> ShowS #