-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | The Haskell Tool Stack
--   
--   Please see the README.md for usage information, and the wiki on Github
--   for more details. Also, note that the API for the library is not
--   currently stable, and may change significantly, even between minor
--   releases. It is currently only intended for use by the executable.
@package stack
@version 0.1.10.1

module Network.HTTP.Download.Verified

-- | Copied and extended version of Network.HTTP.Download.download.
--   
--   Has the following additional features: * Verifies that response
--   content-length header (if present) matches expected length * Limits
--   the download to (close to) the expected # of bytes * Verifies that the
--   expected # bytes were downloaded (not too few) * Verifies md5 if
--   response includes content-md5 header * Verifies the expected hashes
--   
--   Throws VerifiedDownloadException. Throws IOExceptions related to file
--   system operations. Throws HttpException.
verifiedDownload :: (MonadReader env m, HasHttpManager env, MonadIO m) => DownloadRequest -> Path Abs File -> (Maybe Integer -> Sink ByteString (ReaderT env IO) ()) -> m Bool

-- | A request together with some checks to perform.
data DownloadRequest
DownloadRequest :: Request -> [HashCheck] -> Maybe LengthCheck -> RetryPolicy -> DownloadRequest
[drRequest] :: DownloadRequest -> Request
[drHashChecks] :: DownloadRequest -> [HashCheck]
[drLengthCheck] :: DownloadRequest -> Maybe LengthCheck
[drRetryPolicy] :: DownloadRequest -> RetryPolicy

-- | Default to retrying thrice with a short constant delay.
drRetryPolicyDefault :: RetryPolicy
data HashCheck
HashCheck :: a -> CheckHexDigest -> HashCheck
[hashCheckAlgorithm] :: HashCheck -> a
[hashCheckHexDigest] :: HashCheck -> CheckHexDigest
data CheckHexDigest
CheckHexDigestString :: String -> CheckHexDigest
CheckHexDigestByteString :: ByteString -> CheckHexDigest
CheckHexDigestHeader :: ByteString -> CheckHexDigest
type LengthCheck = Int

-- | An exception regarding verification of a download.
data VerifiedDownloadException
WrongContentLength :: Request -> Int -> ByteString -> VerifiedDownloadException
WrongStreamLength :: Request -> Int -> Int -> VerifiedDownloadException
WrongDigest :: Request -> String -> CheckHexDigest -> String -> VerifiedDownloadException
instance GHC.Show.Show Network.HTTP.Download.Verified.VerifyFileException
instance GHC.Show.Show Network.HTTP.Download.Verified.CheckHexDigest
instance GHC.Show.Show Network.HTTP.Download.Verified.HashCheck
instance Data.String.IsString Network.HTTP.Download.Verified.CheckHexDigest
instance GHC.Show.Show Network.HTTP.Download.Verified.VerifiedDownloadException
instance GHC.Exception.Exception Network.HTTP.Download.Verified.VerifiedDownloadException
instance GHC.Exception.Exception Network.HTTP.Download.Verified.VerifyFileException


-- | Template name handling.
module Stack.Types.TemplateName

-- | A template name.
data TemplateName
TemplateName :: !Text -> !(Either (Path Abs File) (Path Rel File)) -> TemplateName

-- | An argument which accepts a template name of the format
--   <tt>foo.hsfiles</tt> or <tt>foo</tt>, ultimately normalized to
--   <tt>foo</tt>.
templateNameArgument :: Mod ArgumentFields TemplateName -> Parser TemplateName

-- | An argument which accepts a <tt>key:value</tt> pair for specifying
--   parameters.
templateParamArgument :: Mod OptionFields (Text, Text) -> Parser (Text, Text)

-- | Parse a template name from a string.
parseTemplateNameFromString :: String -> Either String TemplateName

-- | Make a template name.
mkTemplateName :: String -> Q Exp

-- | Get a text representation of the template name.
templateName :: TemplateName -> Text

-- | Get the path of the template.
templatePath :: TemplateName -> Either (Path Abs File) (Path Rel File)
instance GHC.Show.Show Stack.Types.TemplateName.TemplateName
instance GHC.Classes.Eq Stack.Types.TemplateName.TemplateName
instance GHC.Classes.Ord Stack.Types.TemplateName.TemplateName

module Stack.FileWatch
fileWatch :: ((Set (Path Abs File) -> IO ()) -> IO ()) -> IO ()
fileWatchPoll :: ((Set (Path Abs File) -> IO ()) -> IO ()) -> IO ()

-- | Print an exception to stderr
printExceptionStderr :: Exception e => e -> IO ()


-- | Separate module because TH.
module System.Process.Log

-- | Log running a process with its arguments, for debugging (-v).
logProcessRun :: Q Exp

-- | Show a process arg including speechmarks when necessary. Just for
--   debugging purposes, not functionally important.
showProcessArgDebug :: String -> Text


-- | Extra Maybe utilities.
module Data.Maybe.Extra

-- | Applicative <a>mapMaybe</a>.
mapMaybeA :: Applicative f => (a -> f (Maybe b)) -> [a] -> f [b]

-- | <pre>
--   <a>forMaybeA</a> <a>==</a> <a>flip</a> <a>mapMaybeA</a>
--   </pre>
forMaybeA :: Applicative f => [a] -> (a -> f (Maybe b)) -> f [b]

-- | Monadic <a>mapMaybe</a>.
mapMaybeM :: Monad m => (a -> m (Maybe b)) -> [a] -> m [b]

-- | <pre>
--   <a>forMaybeM</a> <a>==</a> <a>flip</a> <a>mapMaybeM</a>
--   </pre>
forMaybeM :: Monad m => [a] -> (a -> m (Maybe b)) -> m [b]


-- | Extra Path utilities.
module Path.Extra

-- | Convert to FilePath but don't add a trailing slash.
toFilePathNoTrailingSep :: Path loc Dir -> FilePath

-- | Drop the root (either <tt>/</tt> on POSIX or <tt>C:\</tt>,
--   <tt>D:\</tt>, etc. on Windows).
dropRoot :: Path Abs t -> Path Rel t

-- | Collapse intermediate "." and ".." directories from path, then parse
--   it with <a>parseAbsDir</a>. (probably should be moved to the Path
--   module)
parseCollapsedAbsDir :: MonadThrow m => FilePath -> m (Path Abs Dir)

-- | Collapse intermediate "." and ".." directories from path, then parse
--   it with <a>parseAbsFile</a>. (probably should be moved to the Path
--   module)
parseCollapsedAbsFile :: MonadThrow m => FilePath -> m (Path Abs File)


-- | IO actions that might be put in a package at some point.
module Path.IO

-- | Get the current working directory.
getWorkingDir :: (MonadIO m) => m (Path Abs Dir)

-- | Parse a directory path. If it's relative, then the absolute version is
--   yielded, based off the working directory.
--   
--   NOTE that this only works if the directory exists, but does not ensure
--   that it's a directory.
parseRelAsAbsDir :: (MonadThrow m, MonadIO m) => FilePath -> m (Path Abs Dir)

-- | Parse a file path. If it's relative, then the absolute version is
--   yielded, based off the working directory.
--   
--   NOTE that this only works if the file exists, but does not ensure that
--   it's a file.
parseRelAsAbsFile :: (MonadThrow m, MonadIO m) => FilePath -> m (Path Abs File)

-- | List objects in a directory, excluding "<tt>.</tt>" and "<tt>..</tt>".
--   Entries are not sorted.
listDirectory :: (MonadIO m, MonadThrow m) => Path Abs Dir -> m ([Path Abs Dir], [Path Abs File])

-- | Appends a stringly-typed relative path to an absolute path, and then
--   canonicalizes it.
resolveDir :: (MonadIO m, MonadThrow m) => Path Abs Dir -> FilePath -> m (Path Abs Dir)

-- | Appends a stringly-typed relative path to an absolute path, and then
--   canonicalizes it.
resolveFile :: (MonadIO m, MonadThrow m) => Path Abs Dir -> FilePath -> m (Path Abs File)

-- | Appends a stringly-typed relative path to an absolute path, and then
--   canonicalizes it. If the path doesn't exist (and therefore cannot be
--   canonicalized, <a>Nothing</a> is returned).
resolveDirMaybe :: (MonadIO m, MonadThrow m) => Path Abs Dir -> FilePath -> m (Maybe (Path Abs Dir))

-- | Appends a stringly-typed relative path to an absolute path, and then
--   canonicalizes it. If the path doesn't exist (and therefore cannot be
--   canonicalized, <a>Nothing</a> is returned).
resolveFileMaybe :: (MonadIO m, MonadThrow m) => Path Abs Dir -> FilePath -> m (Maybe (Path Abs File))
data ResolveException
ResolveDirFailed :: (Path Abs Dir) -> FilePath -> FilePath -> ResolveException
ResolveFileFailed :: (Path Abs Dir) -> FilePath -> FilePath -> ResolveException

-- | Remove a file. Bails out if it doesn't exist.
removeFile :: MonadIO m => Path b File -> m ()

-- | Remove a file. Optimistically assumes it exists. If it doesn't,
--   doesn't complain.
removeFileIfExists :: MonadIO m => Path b File -> m ()

-- | Remove a tree. Bails out if it doesn't exist.
removeTree :: MonadIO m => Path b Dir -> m ()

-- | Remove tree, don't complain about non-existent directories.
removeTreeIfExists :: MonadIO m => Path b Dir -> m ()

-- | Rename a file. Bails out if it doesn't exist.
renameFile :: MonadIO m => Path b1 File -> Path b2 File -> m ()

-- | Rename a file. Optimistically assumes it exists. If it doesn't,
--   doesn't complain.
renameFileIfExists :: MonadIO m => Path b1 File -> Path b2 File -> m ()
renameDir :: MonadIO m => Path b1 Dir -> Path b2 Dir -> m ()

-- | Rename a directory. Optimistically assumes it exists. If it doesn't,
--   doesn't complain.
renameDirIfExists :: MonadIO m => Path b1 Dir -> Path b2 Dir -> m ()

-- | Move a file. Bails out if it doesn't exist.
moveFile :: MonadIO m => Path b1 File -> Path b2 Dir -> m ()

-- | Move a file. Optimistically assumes it exists. If it doesn't, doesn't
--   complain.
moveFileIfExists :: MonadIO m => Path b1 File -> Path b2 Dir -> m ()

-- | Move a dir. Bails out if it doesn't exist.
moveDir :: MonadIO m => Path b1 Dir -> Path b2 Dir -> m ()

-- | Move a dir. Optimistically assumes it exists. If it doesn't, doesn't
--   complain.
moveDirIfExists :: MonadIO m => Path b1 Dir -> Path b2 Dir -> m ()

-- | Does the file exist?
fileExists :: MonadIO m => Path b File -> m Bool

-- | Does the directory exist?
dirExists :: MonadIO m => Path b Dir -> m Bool

-- | Copies a file to another path. Bails out if it doesn't exist.
copyFile :: MonadIO m => Path b1 File -> Path b2 File -> m ()

-- | Copies a file to another path. Optimistically assumes it exists. If it
--   doesn't, doesn't complain.
copyFileIfExists :: MonadIO m => Path b1 File -> Path b2 File -> m ()

-- | Copy a directory recursively. This just uses <a>copyFile</a>, so it is
--   not smart about symbolic links or other special files.
copyDirectoryRecursive :: (MonadIO m, MonadThrow m) => Path Abs Dir -> Path Abs Dir -> m ()

-- | Make a directory tree, creating parents if needed.
createTree :: MonadIO m => Path b Dir -> m ()
withCanonicalizedSystemTempDirectory :: (MonadMask m, MonadIO m) => String -> (Path Abs Dir -> m a) -> m a
withCanonicalizedTempDirectory :: (MonadMask m, MonadIO m) => FilePath -> String -> (Path Abs Dir -> m a) -> m a
instance GHC.Exception.Exception Path.IO.ResolveException
instance GHC.Show.Show Path.IO.ResolveException


-- | Reading from external processes.
module System.Process.Read

-- | Produce a strict <a>ByteString</a> from the stdout of a process.
--   
--   Throws a <a>ReadProcessException</a> exception if the process fails.
readProcessStdout :: (MonadIO m, MonadLogger m, MonadBaseControl IO m, MonadCatch m) => Maybe (Path Abs Dir) -> EnvOverride -> String -> [String] -> m ByteString

-- | Try to produce a strict <a>ByteString</a> from the stdout of a
--   process.
tryProcessStdout :: (MonadIO m, MonadLogger m, MonadBaseControl IO m, MonadCatch m) => Maybe (Path Abs Dir) -> EnvOverride -> String -> [String] -> m (Either ReadProcessException ByteString)

-- | Consume the stdout of a process feeding strict <a>ByteString</a>s to a
--   consumer. If the process fails, spits out stdout and stderr as error
--   log level. Should not be used for long-running processes or ones with
--   lots of output; for that use <tt>sinkProcessStdoutLogStderr</tt>.
sinkProcessStdout :: (MonadIO m, MonadLogger m, MonadBaseControl IO m, MonadCatch m) => Maybe (Path Abs Dir) -> EnvOverride -> String -> [String] -> Sink ByteString IO a -> m a

-- | Consume the stdout and stderr of a process feeding strict
--   <a>ByteString</a>s to the consumers.
sinkProcessStderrStdout :: (MonadIO m, MonadLogger m) => Maybe (Path Abs Dir) -> EnvOverride -> String -> [String] -> Sink ByteString IO e -> Sink ByteString IO o -> m (e, o)

-- | <tt>readProcess</tt> forks an external process, reads its standard
--   output strictly, blocking until the process terminates, and returns
--   the output string. The external process inherits the standard error.
--   
--   If an asynchronous exception is thrown to the thread executing
--   <tt>readProcess</tt>, the forked process will be terminated and
--   <tt>readProcess</tt> will wait (block) until the process has been
--   terminated.
--   
--   Output is returned strictly, so this is not suitable for interactive
--   applications.
--   
--   This function throws an <a>IOError</a> if the process <a>ExitCode</a>
--   is anything other than <a>ExitSuccess</a>. If instead you want to get
--   the <a>ExitCode</a> then use <a>readProcessWithExitCode</a>.
--   
--   Users of this function should compile with <tt>-threaded</tt> if they
--   want other Haskell threads to keep running while waiting on the result
--   of readProcess.
--   
--   <pre>
--   &gt; readProcess "date" [] []
--   "Thu Feb  7 10:03:39 PST 2008\n"
--   </pre>
--   
--   The arguments are:
--   
--   <ul>
--   <li>The command to run, which must be in the $PATH, or an absolute or
--   relative path</li>
--   <li>A list of separate command line arguments to the program</li>
--   <li>A string to pass on standard input to the forked process.</li>
--   </ul>
readProcess :: FilePath -> [String] -> String -> IO String

-- | Override the environment received by a child process.
data EnvOverride
EnvOverride :: Map Text Text -> [(String, String)] -> [FilePath] -> IORef (Map FilePath (Either ReadProcessException (Path Abs File))) -> String -> Platform -> EnvOverride

-- | Environment variables as map
[eoTextMap] :: EnvOverride -> Map Text Text

-- | Environment variables as association list
[eoStringList] :: EnvOverride -> [(String, String)]

-- | List of directories searched for executables (<tt>PATH</tt>)
[eoPath] :: EnvOverride -> [FilePath]
[eoExeCache] :: EnvOverride -> IORef (Map FilePath (Either ReadProcessException (Path Abs File)))

-- | <tt>""</tt> or <tt>".exe"</tt>, depending on the platform
[eoExeExtension] :: EnvOverride -> String
[eoPlatform] :: EnvOverride -> Platform

-- | Get the environment variables from an <a>EnvOverride</a>.
unEnvOverride :: EnvOverride -> Map Text Text

-- | Create a new <a>EnvOverride</a>.
mkEnvOverride :: MonadIO m => Platform -> Map Text Text -> m EnvOverride

-- | Modify the environment variables of an <a>EnvOverride</a>.
modifyEnvOverride :: MonadIO m => EnvOverride -> (Map Text Text -> Map Text Text) -> m EnvOverride

-- | Helper conversion function.
envHelper :: EnvOverride -> Maybe [(String, String)]

-- | Check if the given executable exists on the given PATH.
doesExecutableExist :: MonadIO m => EnvOverride -> String -> m Bool

-- | Find the complete path for the executable.
--   
--   Throws a <a>ReadProcessException</a> if unsuccessful.
findExecutable :: (MonadIO m, MonadThrow n) => EnvOverride -> String -> m (n (Path Abs File))

-- | Load up an <a>EnvOverride</a> from the standard environment.
getEnvOverride :: MonadIO m => Platform -> m EnvOverride

-- | Get the list of directories searched (<tt>PATH</tt>).
envSearchPath :: EnvOverride -> [FilePath]

-- | Perform pre-call-process tasks. Ensure the working directory exists
--   and find the executable path.
preProcess :: (MonadIO m) => Maybe (Path Abs Dir) -> EnvOverride -> String -> m FilePath

-- | Read from the process, ignoring any output.
readProcessNull :: (MonadIO m, MonadLogger m, MonadBaseControl IO m, MonadCatch m) => Maybe (Path Abs Dir) -> EnvOverride -> String -> [String] -> m ()

-- | Run the given command in the given directory. If it exits with
--   anything but success, prints an error and then calls <a>exitWith</a>
--   to exit the program.
readInNull :: (MonadIO m, MonadLogger m, MonadBaseControl IO m, MonadCatch m) => Path Abs Dir -> FilePath -> EnvOverride -> [String] -> Maybe Text -> m ()

-- | Log running a process with its arguments, for debugging (-v).
logProcessRun :: Q Exp

-- | An exception while trying to read from process.
data ReadProcessException
ReadProcessException :: CreateProcess -> ExitCode -> ByteString -> ByteString -> ReadProcessException
NoPathFound :: ReadProcessException
ExecutableNotFound :: String -> [FilePath] -> ReadProcessException
ExecutableNotFoundAt :: FilePath -> ReadProcessException

-- | Augment the PATH environment variable with the given extra paths.
augmentPath :: [FilePath] -> Maybe Text -> Text

-- | Apply <a>augmentPath</a> on the PATH value in the given Map.
augmentPathMap :: [FilePath] -> Map Text Text -> Map Text Text
instance GHC.Show.Show System.Process.Read.ReadProcessException
instance GHC.Exception.Exception System.Process.Read.ReadProcessException


-- | Run sub-processes.
module System.Process.Run

-- | Run the given command in the given directory, inheriting stdout and
--   stderr.
--   
--   If it exits with anything but success, prints an error and then calls
--   <a>exitWith</a> to exit the program.
runCmd :: (MonadLogger m, MonadIO m, MonadBaseControl IO m) => Cmd -> Maybe Text -> m ()
runCmd' :: (MonadLogger m, MonadIO m, MonadBaseControl IO m) => (CreateProcess -> CreateProcess) -> Cmd -> Maybe Text -> m ()

-- | Like <a>callProcess</a>, but takes an optional working directory and
--   environment override, and throws <a>ProcessExitedUnsuccessfully</a> if
--   the process exits unsuccessfully.
--   
--   Inherits stdout and stderr.
callProcess :: (MonadIO m, MonadLogger m) => Cmd -> m ()

-- | Like <a>callProcess</a>, but takes an optional working directory and
--   environment override, and throws <a>ProcessExitedUnsuccessfully</a> if
--   the process exits unsuccessfully.
--   
--   Inherits stdout and stderr.
callProcess' :: (MonadIO m, MonadLogger m) => (CreateProcess -> CreateProcess) -> Cmd -> m ()

-- | Indicates that a process exited with an non-success exit code.
--   
--   Since 0.1.7
data ProcessExitedUnsuccessfully :: *

-- | Cmd holds common infos needed to running a process in most cases
data Cmd
Cmd :: Maybe (Path Abs Dir) -> FilePath -> EnvOverride -> [String] -> Cmd

-- | directory to run in
[cmdDirectoryToRunIn] :: Cmd -> Maybe (Path Abs Dir)

-- | command to run
[cmdCommandToRun] :: Cmd -> FilePath
[cmdEnvOverride] :: Cmd -> EnvOverride

-- | command line arguments
[cmdCommandLineArguments] :: Cmd -> [String]


-- | Names for packages.
module Stack.Types.PackageName

-- | A package name.
data PackageName

-- | A parse fail.
data PackageNameParseFail
PackageNameParseFail :: ByteString -> PackageNameParseFail
CabalFileNameParseFail :: FilePath -> PackageNameParseFail
CabalFileNameInvalidPackageName :: FilePath -> PackageNameParseFail

-- | Attoparsec parser for a package name from bytestring.
packageNameParser :: Parser PackageName

-- | Convenient way to parse a package name from a bytestring.
parsePackageName :: MonadThrow m => ByteString -> m PackageName

-- | Migration function.
parsePackageNameFromString :: MonadThrow m => String -> m PackageName

-- | Produce a bytestring representation of a package name.
packageNameByteString :: PackageName -> ByteString

-- | Produce a string representation of a package name.
packageNameString :: PackageName -> String

-- | Produce a string representation of a package name.
packageNameText :: PackageName -> Text

-- | Convert from a Cabal package name.
fromCabalPackageName :: PackageName -> PackageName

-- | Convert to a Cabal package name.
toCabalPackageName :: PackageName -> PackageName

-- | Parse a package name from a file path.
parsePackageNameFromFilePath :: MonadThrow m => Path a File -> m PackageName

-- | Make a package name.
mkPackageName :: String -> Q Exp

-- | An argument which accepts a template name of the format
--   <tt>foo.hsfiles</tt>.
packageNameArgument :: Mod ArgumentFields PackageName -> Parser PackageName
instance GHC.Generics.Constructor Stack.Types.PackageName.C1_0PackageName
instance GHC.Generics.Datatype Stack.Types.PackageName.D1PackageName
instance Control.DeepSeq.NFData Stack.Types.PackageName.PackageName
instance Data.Binary.Class.Binary Stack.Types.PackageName.PackageName
instance Data.Hashable.Class.Hashable Stack.Types.PackageName.PackageName
instance GHC.Generics.Generic Stack.Types.PackageName.PackageName
instance Data.Data.Data Stack.Types.PackageName.PackageName
instance GHC.Classes.Ord Stack.Types.PackageName.PackageName
instance GHC.Classes.Eq Stack.Types.PackageName.PackageName
instance GHC.Exception.Exception Stack.Types.PackageName.PackageNameParseFail
instance GHC.Show.Show Stack.Types.PackageName.PackageNameParseFail
instance Language.Haskell.TH.Syntax.Lift Stack.Types.PackageName.PackageName
instance GHC.Show.Show Stack.Types.PackageName.PackageName
instance Data.Binary.Tagged.HasStructuralInfo Stack.Types.PackageName.PackageName
instance Data.Aeson.Types.Class.ToJSON Stack.Types.PackageName.PackageName
instance Data.Aeson.Types.Class.FromJSON Stack.Types.PackageName.PackageName
instance Data.Aeson.Types.Class.ToJSON a => Data.Aeson.Types.Class.ToJSON (Data.Map.Base.Map Stack.Types.PackageName.PackageName a)
instance Data.Aeson.Types.Class.FromJSON a => Data.Aeson.Types.Class.FromJSON (Data.Map.Base.Map Stack.Types.PackageName.PackageName a)


module Stack.Types.Sig

-- | A GPG signature.
newtype Signature
Signature :: ByteString -> Signature

-- | The GPG fingerprint.
newtype Fingerprint
Fingerprint :: Text -> Fingerprint
[fingerprintSample] :: Fingerprint -> Text

-- | Exceptions
data SigException
GPGFingerprintException :: String -> SigException
GPGSignException :: String -> SigException
GPGVerifyException :: String -> SigException
SigInvalidSDistTarBall :: SigException
SigNoProjectRootException :: SigException
SigServiceException :: String -> SigException
instance GHC.Classes.Eq a => GHC.Classes.Eq (Stack.Types.Sig.Aeson a)
instance GHC.Classes.Ord a => GHC.Classes.Ord (Stack.Types.Sig.Aeson a)
instance GHC.Show.Show Stack.Types.Sig.Fingerprint
instance GHC.Classes.Ord Stack.Types.Sig.Fingerprint
instance GHC.Classes.Eq Stack.Types.Sig.Fingerprint
instance GHC.Classes.Eq Stack.Types.Sig.Signature
instance GHC.Classes.Ord Stack.Types.Sig.Signature
instance GHC.Show.Show Stack.Types.Sig.Signature
instance Data.Aeson.Types.Class.FromJSON Stack.Types.Sig.Fingerprint
instance Data.Aeson.Types.Class.ToJSON Stack.Types.Sig.Fingerprint
instance Data.String.IsString Stack.Types.Sig.Fingerprint
instance Data.Aeson.Types.Class.FromJSON (Stack.Types.Sig.Aeson Stack.Types.PackageName.PackageName)
instance GHC.Exception.Exception Stack.Types.Sig.SigException
instance GHC.Show.Show Stack.Types.Sig.SigException


-- | Names for flags.
module Stack.Types.FlagName

-- | A flag name.
data FlagName

-- | A parse fail.
data FlagNameParseFail
FlagNameParseFail :: ByteString -> FlagNameParseFail

-- | Attoparsec parser for a flag name from bytestring.
flagNameParser :: Parser FlagName

-- | Convenient way to parse a flag name from a bytestring.
parseFlagName :: MonadThrow m => ByteString -> m FlagName

-- | Migration function.
parseFlagNameFromString :: MonadThrow m => String -> m FlagName

-- | Produce a string representation of a flag name.
flagNameString :: FlagName -> String

-- | Produce a string representation of a flag name.
flagNameText :: FlagName -> Text

-- | Convert from a Cabal flag name.
fromCabalFlagName :: FlagName -> FlagName

-- | Convert to a Cabal flag name.
toCabalFlagName :: FlagName -> FlagName

-- | Make a flag name.
mkFlagName :: String -> Q Exp
instance GHC.Generics.Constructor Stack.Types.FlagName.C1_0FlagName
instance GHC.Generics.Datatype Stack.Types.FlagName.D1FlagName
instance Control.DeepSeq.NFData Stack.Types.FlagName.FlagName
instance Data.Binary.Class.Binary Stack.Types.FlagName.FlagName
instance Data.Hashable.Class.Hashable Stack.Types.FlagName.FlagName
instance GHC.Generics.Generic Stack.Types.FlagName.FlagName
instance Data.Data.Data Stack.Types.FlagName.FlagName
instance GHC.Exception.Exception Stack.Types.FlagName.FlagNameParseFail
instance GHC.Show.Show Stack.Types.FlagName.FlagNameParseFail
instance Data.Binary.Tagged.HasStructuralInfo Stack.Types.FlagName.FlagName
instance GHC.Classes.Eq Stack.Types.FlagName.FlagName
instance GHC.Classes.Ord Stack.Types.FlagName.FlagName
instance Language.Haskell.TH.Syntax.Lift Stack.Types.FlagName.FlagName
instance GHC.Show.Show Stack.Types.FlagName.FlagName
instance Data.Aeson.Types.Class.FromJSON Stack.Types.FlagName.FlagName
instance Data.Aeson.Types.Class.ToJSON a => Data.Aeson.Types.Class.ToJSON (Data.Map.Base.Map Stack.Types.FlagName.FlagName a)
instance Data.Aeson.Types.Class.FromJSON a => Data.Aeson.Types.Class.FromJSON (Data.Map.Base.Map Stack.Types.FlagName.FlagName a)


-- | A ghc-pkg id.
module Stack.Types.GhcPkgId

-- | A ghc-pkg package identifier.
data GhcPkgId

-- | A parser for a package-version-hash pair.
ghcPkgIdParser :: Parser GhcPkgId

-- | Convenient way to parse a package name from a bytestring.
parseGhcPkgId :: MonadThrow m => ByteString -> m GhcPkgId

-- | Get a string representation of GHC package id.
ghcPkgIdString :: GhcPkgId -> String
instance GHC.Generics.Constructor Stack.Types.GhcPkgId.C1_0GhcPkgId
instance GHC.Generics.Datatype Stack.Types.GhcPkgId.D1GhcPkgId
instance GHC.Generics.Generic Stack.Types.GhcPkgId.GhcPkgId
instance Data.Data.Data Stack.Types.GhcPkgId.GhcPkgId
instance GHC.Classes.Ord Stack.Types.GhcPkgId.GhcPkgId
instance GHC.Classes.Eq Stack.Types.GhcPkgId.GhcPkgId
instance GHC.Show.Show Stack.Types.GhcPkgId.GhcPkgIdParseFail
instance GHC.Exception.Exception Stack.Types.GhcPkgId.GhcPkgIdParseFail
instance Data.Hashable.Class.Hashable Stack.Types.GhcPkgId.GhcPkgId
instance Data.Binary.Class.Binary Stack.Types.GhcPkgId.GhcPkgId
instance Control.DeepSeq.NFData Stack.Types.GhcPkgId.GhcPkgId
instance Data.Binary.Tagged.HasStructuralInfo Stack.Types.GhcPkgId.GhcPkgId
instance GHC.Show.Show Stack.Types.GhcPkgId.GhcPkgId
instance Data.Aeson.Types.Class.FromJSON Stack.Types.GhcPkgId.GhcPkgId
instance Data.Aeson.Types.Class.ToJSON Stack.Types.GhcPkgId.GhcPkgId


-- | Versions for packages.
module Stack.Types.Version

-- | A package version.
data Version
data VersionRange :: *
data VersionCheck
MatchMinor :: VersionCheck
MatchExact :: VersionCheck
NewerMinor :: VersionCheck

-- | Attoparsec parser for a package version from bytestring.
versionParser :: Parser Version

-- | Convenient way to parse a package version from a bytestring.
parseVersion :: MonadThrow m => ByteString -> m Version

-- | Migration function.
parseVersionFromString :: MonadThrow m => String -> m Version

-- | Get a string representation of a package version.
versionString :: Version -> String

-- | Get a string representation of a package version.
versionText :: Version -> Text

-- | Convert to a Cabal version.
toCabalVersion :: Version -> Version

-- | Convert from a Cabal version.
fromCabalVersion :: Version -> Version

-- | Make a package version.
mkVersion :: String -> Q Exp

-- | Display a version range
versionRangeText :: VersionRange -> Text

-- | Check if a version is within a version range.
withinRange :: Version -> VersionRange -> Bool

-- | A modified intersection which also simplifies, for better display.
intersectVersionRanges :: VersionRange -> VersionRange -> VersionRange

-- | Returns the first two components, defaulting to 0 if not present
toMajorVersion :: Version -> Version

-- | Given a version range and a set of versions, find the latest version
--   from the set that is within the range.
latestApplicableVersion :: VersionRange -> Set Version -> Maybe Version
checkVersion :: VersionCheck -> Version -> Version -> Bool

-- | Get the next major version number for the given version
nextMajorVersion :: Version -> Version
instance GHC.Generics.Selector Stack.Types.Version.S1_0_0Version
instance GHC.Generics.Constructor Stack.Types.Version.C1_0Version
instance GHC.Generics.Datatype Stack.Types.Version.D1Version
instance GHC.Classes.Ord Stack.Types.Version.VersionCheck
instance GHC.Classes.Eq Stack.Types.Version.VersionCheck
instance GHC.Show.Show Stack.Types.Version.VersionCheck
instance Control.DeepSeq.NFData Stack.Types.Version.Version
instance Data.Binary.Class.Binary Stack.Types.Version.Version
instance GHC.Generics.Generic Stack.Types.Version.Version
instance Data.Data.Data Stack.Types.Version.Version
instance GHC.Classes.Ord Stack.Types.Version.Version
instance GHC.Classes.Eq Stack.Types.Version.Version
instance GHC.Exception.Exception Stack.Types.Version.VersionParseFail
instance GHC.Show.Show Stack.Types.Version.VersionParseFail
instance Data.Binary.Tagged.HasStructuralInfo Stack.Types.Version.Version
instance Data.Hashable.Class.Hashable Stack.Types.Version.Version
instance Language.Haskell.TH.Syntax.Lift Stack.Types.Version.Version
instance GHC.Show.Show Stack.Types.Version.Version
instance Data.Aeson.Types.Class.ToJSON Stack.Types.Version.Version
instance Data.Aeson.Types.Class.FromJSON Stack.Types.Version.Version
instance Data.Aeson.Types.Class.FromJSON a => Data.Aeson.Types.Class.FromJSON (Data.Map.Base.Map Stack.Types.Version.Version a)
instance Data.Aeson.Types.Class.ToJSON Stack.Types.Version.VersionCheck
instance Data.Aeson.Types.Class.FromJSON Stack.Types.Version.VersionCheck

module Stack.Types.Compiler

-- | Variety of compiler to use.
data WhichCompiler
Ghc :: WhichCompiler
Ghcjs :: WhichCompiler

-- | Specifies a compiler and its version number(s).
--   
--   Note that despite having this datatype, stack isn't in a hurry to
--   support compilers other than GHC.
--   
--   NOTE: updating this will change its binary serialization. The version
--   number in the <tt>BinarySchema</tt> instance for
--   <tt>MiniBuildPlan</tt> should be updated.
data CompilerVersion
GhcVersion :: {-# UNPACK #-} !Version -> CompilerVersion
GhcjsVersion :: {-# UNPACK #-} !Version -> {-# UNPACK #-} !Version -> CompilerVersion
parseCompilerVersion :: Text -> Maybe CompilerVersion
compilerVersionText :: CompilerVersion -> Text
compilerVersionString :: CompilerVersion -> String
whichCompiler :: CompilerVersion -> WhichCompiler
isWantedCompiler :: VersionCheck -> CompilerVersion -> CompilerVersion -> Bool
getGhcVersion :: CompilerVersion -> Version
compilerExeName :: WhichCompiler -> String
haddockExeName :: WhichCompiler -> String
instance GHC.Generics.Constructor Stack.Types.Compiler.C1_1CompilerVersion
instance GHC.Generics.Constructor Stack.Types.Compiler.C1_0CompilerVersion
instance GHC.Generics.Datatype Stack.Types.Compiler.D1CompilerVersion
instance GHC.Classes.Ord Stack.Types.Compiler.CompilerVersion
instance GHC.Classes.Eq Stack.Types.Compiler.CompilerVersion
instance GHC.Show.Show Stack.Types.Compiler.CompilerVersion
instance GHC.Generics.Generic Stack.Types.Compiler.CompilerVersion
instance GHC.Classes.Ord Stack.Types.Compiler.WhichCompiler
instance GHC.Classes.Eq Stack.Types.Compiler.WhichCompiler
instance GHC.Show.Show Stack.Types.Compiler.WhichCompiler
instance Data.Binary.Class.Binary Stack.Types.Compiler.CompilerVersion
instance Data.Binary.Tagged.HasStructuralInfo Stack.Types.Compiler.CompilerVersion
instance Control.DeepSeq.NFData Stack.Types.Compiler.CompilerVersion
instance Data.Aeson.Types.Class.ToJSON Stack.Types.Compiler.CompilerVersion
instance Data.Aeson.Types.Class.FromJSON Stack.Types.Compiler.CompilerVersion
instance Data.Aeson.Types.Class.FromJSON a => Data.Aeson.Types.Class.FromJSON (Data.Map.Base.Map Stack.Types.Compiler.CompilerVersion a)


-- | Package identifier (name-version).
module Stack.Types.PackageIdentifier

-- | A pkg-ver combination.
data PackageIdentifier
PackageIdentifier :: !PackageName -> !Version -> PackageIdentifier

-- | Get the name part of the identifier.
[packageIdentifierName] :: PackageIdentifier -> !PackageName

-- | Get the version part of the identifier.
[packageIdentifierVersion] :: PackageIdentifier -> !Version

-- | Convert from a package identifier to a tuple.
toTuple :: PackageIdentifier -> (PackageName, Version)

-- | Convert from a tuple to a package identifier.
fromTuple :: (PackageName, Version) -> PackageIdentifier

-- | Convenient way to parse a package identifier from a bytestring.
parsePackageIdentifier :: MonadThrow m => ByteString -> m PackageIdentifier

-- | Migration function.
parsePackageIdentifierFromString :: MonadThrow m => String -> m PackageIdentifier

-- | A parser for a package-version pair.
packageIdentifierParser :: Parser PackageIdentifier

-- | Get a string representation of the package identifier; name-ver.
packageIdentifierString :: PackageIdentifier -> String

-- | Get a Text representation of the package identifier; name-ver.
packageIdentifierText :: PackageIdentifier -> Text
instance GHC.Generics.Selector Stack.Types.PackageIdentifier.S1_0_1PackageIdentifier
instance GHC.Generics.Selector Stack.Types.PackageIdentifier.S1_0_0PackageIdentifier
instance GHC.Generics.Constructor Stack.Types.PackageIdentifier.C1_0PackageIdentifier
instance GHC.Generics.Datatype Stack.Types.PackageIdentifier.D1PackageIdentifier
instance Data.Data.Data Stack.Types.PackageIdentifier.PackageIdentifier
instance GHC.Generics.Generic Stack.Types.PackageIdentifier.PackageIdentifier
instance GHC.Classes.Ord Stack.Types.PackageIdentifier.PackageIdentifier
instance GHC.Classes.Eq Stack.Types.PackageIdentifier.PackageIdentifier
instance GHC.Show.Show Stack.Types.PackageIdentifier.PackageIdentifierParseFail
instance GHC.Exception.Exception Stack.Types.PackageIdentifier.PackageIdentifierParseFail
instance Control.DeepSeq.NFData Stack.Types.PackageIdentifier.PackageIdentifier
instance Data.Hashable.Class.Hashable Stack.Types.PackageIdentifier.PackageIdentifier
instance Data.Binary.Class.Binary Stack.Types.PackageIdentifier.PackageIdentifier
instance Data.Binary.Tagged.HasStructuralInfo Stack.Types.PackageIdentifier.PackageIdentifier
instance GHC.Show.Show Stack.Types.PackageIdentifier.PackageIdentifier
instance Data.Aeson.Types.Class.ToJSON Stack.Types.PackageIdentifier.PackageIdentifier
instance Data.Aeson.Types.Class.FromJSON Stack.Types.PackageIdentifier.PackageIdentifier

module Stack.Types.PackageIndex
data PackageDownload
PackageDownload :: !ByteString -> !ByteString -> !Word64 -> PackageDownload
[pdSHA512] :: PackageDownload -> !ByteString
[pdUrl] :: PackageDownload -> !ByteString
[pdSize] :: PackageDownload -> !Word64
data PackageCache
PackageCache :: !Int64 -> !Int64 -> !(Maybe PackageDownload) -> PackageCache

-- | offset in bytes into the 00-index.tar file for the .cabal file
--   contents
[pcOffset] :: PackageCache -> !Int64

-- | size in bytes of the .cabal file
[pcSize] :: PackageCache -> !Int64
[pcDownload] :: PackageCache -> !(Maybe PackageDownload)
newtype PackageCacheMap
PackageCacheMap :: (Map PackageIdentifier PackageCache) -> PackageCacheMap
instance GHC.Generics.Constructor Stack.Types.PackageIndex.C1_0PackageCacheMap
instance GHC.Generics.Datatype Stack.Types.PackageIndex.D1PackageCacheMap
instance GHC.Generics.Selector Stack.Types.PackageIndex.S1_0_2PackageCache
instance GHC.Generics.Selector Stack.Types.PackageIndex.S1_0_1PackageCache
instance GHC.Generics.Selector Stack.Types.PackageIndex.S1_0_0PackageCache
instance GHC.Generics.Constructor Stack.Types.PackageIndex.C1_0PackageCache
instance GHC.Generics.Datatype Stack.Types.PackageIndex.D1PackageCache
instance GHC.Generics.Selector Stack.Types.PackageIndex.S1_0_2PackageDownload
instance GHC.Generics.Selector Stack.Types.PackageIndex.S1_0_1PackageDownload
instance GHC.Generics.Selector Stack.Types.PackageIndex.S1_0_0PackageDownload
instance GHC.Generics.Constructor Stack.Types.PackageIndex.C1_0PackageDownload
instance GHC.Generics.Datatype Stack.Types.PackageIndex.D1PackageDownload
instance Control.DeepSeq.NFData Stack.Types.PackageIndex.PackageCacheMap
instance Data.Binary.Class.Binary Stack.Types.PackageIndex.PackageCacheMap
instance GHC.Generics.Generic Stack.Types.PackageIndex.PackageCacheMap
instance GHC.Generics.Generic Stack.Types.PackageIndex.PackageCache
instance GHC.Generics.Generic Stack.Types.PackageIndex.PackageDownload
instance GHC.Show.Show Stack.Types.PackageIndex.PackageDownload
instance Data.Binary.Class.Binary Stack.Types.PackageIndex.PackageCache
instance Control.DeepSeq.NFData Stack.Types.PackageIndex.PackageCache
instance Data.Binary.Tagged.HasStructuralInfo Stack.Types.PackageIndex.PackageCache
instance Data.Binary.Tagged.HasStructuralInfo Stack.Types.PackageIndex.PackageCacheMap
instance Data.Binary.Tagged.HasSemanticVersion Stack.Types.PackageIndex.PackageCacheMap
instance Data.Binary.Class.Binary Stack.Types.PackageIndex.PackageDownload
instance Data.Binary.Tagged.HasStructuralInfo Stack.Types.PackageIndex.PackageDownload
instance Control.DeepSeq.NFData Stack.Types.PackageIndex.PackageDownload
instance Data.Aeson.Types.Class.FromJSON Stack.Types.PackageIndex.PackageDownload


-- | Docker types.
module Stack.Types.Docker

-- | Docker configuration.
data DockerOpts
DockerOpts :: !Bool -> !String -> !Bool -> !(Maybe String) -> !(Maybe String) -> !Bool -> !Bool -> !Bool -> !(Maybe String) -> ![String] -> ![Mount] -> ![String] -> !(Path Abs File) -> !(Maybe DockerStackExe) -> !(Maybe Bool) -> !VersionRange -> DockerOpts

-- | Is using Docker enabled?
[dockerEnable] :: DockerOpts -> !Bool

-- | Exact Docker image tag or ID. Overrides docker-repo-*/tag.
[dockerImage] :: DockerOpts -> !String

-- | Does registry require login for pulls?
[dockerRegistryLogin] :: DockerOpts -> !Bool

-- | Optional username for Docker registry.
[dockerRegistryUsername] :: DockerOpts -> !(Maybe String)

-- | Optional password for Docker registry.
[dockerRegistryPassword] :: DockerOpts -> !(Maybe String)

-- | Automatically pull new images.
[dockerAutoPull] :: DockerOpts -> !Bool

-- | Whether to run a detached container
[dockerDetach] :: DockerOpts -> !Bool

-- | Create a persistent container (don't remove it when finished). Implied
--   by <a>dockerDetach</a>.
[dockerPersist] :: DockerOpts -> !Bool

-- | Container name to use, only makes sense from command-line with
--   <a>dockerPersist</a> or <a>dockerDetach</a>.
[dockerContainerName] :: DockerOpts -> !(Maybe String)

-- | Arguments to pass directly to <tt>docker run</tt>.
[dockerRunArgs] :: DockerOpts -> ![String]

-- | Volumes to mount in the container.
[dockerMount] :: DockerOpts -> ![Mount]

-- | Environment variables to set in the container.
[dockerEnv] :: DockerOpts -> ![String]

-- | Location of image usage database.
[dockerDatabasePath] :: DockerOpts -> !(Path Abs File)

-- | Location of container-compatible stack executable
[dockerStackExe] :: DockerOpts -> !(Maybe DockerStackExe)

-- | Set in-container user to match host's
[dockerSetUser] :: DockerOpts -> !(Maybe Bool)

-- | Require a version of Docker within this range.
[dockerRequireDockerVersion] :: DockerOpts -> !VersionRange

-- | An uninterpreted representation of docker options. Configurations may
--   be "cascaded" using mappend (left-biased).
data DockerOptsMonoid
DockerOptsMonoid :: !Bool -> !(Maybe Bool) -> !(Maybe DockerMonoidRepoOrImage) -> !(Maybe Bool) -> !(Maybe String) -> !(Maybe String) -> !(Maybe Bool) -> !(Maybe Bool) -> !(Maybe Bool) -> !(Maybe String) -> ![String] -> ![Mount] -> ![String] -> !(Maybe String) -> !(Maybe String) -> !(Maybe Bool) -> !VersionRange -> DockerOptsMonoid

-- | Should Docker be defaulted to enabled (does <tt>docker:</tt> section
--   exist in the config)?
[dockerMonoidDefaultEnable] :: DockerOptsMonoid -> !Bool

-- | Is using Docker enabled?
[dockerMonoidEnable] :: DockerOptsMonoid -> !(Maybe Bool)

-- | Docker repository name (e.g. <tt>fpco/stack-build</tt> or
--   <tt>fpco/stack-full:lts-2.8</tt>)
[dockerMonoidRepoOrImage] :: DockerOptsMonoid -> !(Maybe DockerMonoidRepoOrImage)

-- | Does registry require login for pulls?
[dockerMonoidRegistryLogin] :: DockerOptsMonoid -> !(Maybe Bool)

-- | Optional username for Docker registry.
[dockerMonoidRegistryUsername] :: DockerOptsMonoid -> !(Maybe String)

-- | Optional password for Docker registry.
[dockerMonoidRegistryPassword] :: DockerOptsMonoid -> !(Maybe String)

-- | Automatically pull new images.
[dockerMonoidAutoPull] :: DockerOptsMonoid -> !(Maybe Bool)

-- | Whether to run a detached container
[dockerMonoidDetach] :: DockerOptsMonoid -> !(Maybe Bool)

-- | Create a persistent container (don't remove it when finished). Implied
--   by <a>dockerDetach</a>.
[dockerMonoidPersist] :: DockerOptsMonoid -> !(Maybe Bool)

-- | Container name to use, only makes sense from command-line with
--   <a>dockerPersist</a> or <a>dockerDetach</a>.
[dockerMonoidContainerName] :: DockerOptsMonoid -> !(Maybe String)

-- | Arguments to pass directly to <tt>docker run</tt>
[dockerMonoidRunArgs] :: DockerOptsMonoid -> ![String]

-- | Volumes to mount in the container
[dockerMonoidMount] :: DockerOptsMonoid -> ![Mount]

-- | Environment variables to set in the container
[dockerMonoidEnv] :: DockerOptsMonoid -> ![String]

-- | Location of image usage database.
[dockerMonoidDatabasePath] :: DockerOptsMonoid -> !(Maybe String)

-- | Location of container-compatible stack executable
[dockerMonoidStackExe] :: DockerOptsMonoid -> !(Maybe String)

-- | Set in-container user to match host's
[dockerMonoidSetUser] :: DockerOptsMonoid -> !(Maybe Bool)

-- | See: <a>dockerRequireDockerVersion</a>
[dockerMonoidRequireDockerVersion] :: DockerOptsMonoid -> !VersionRange

-- | Decode uninterpreted docker options from JSON/YAML.

-- | Left-biased combine Docker options

-- | Where to get the <tt>stack</tt> executable to run in Docker containers
data DockerStackExe

-- | Download from official bindist
DockerStackExeDownload :: DockerStackExe

-- | Host's <tt>stack</tt> (linux-x86_64 only)
DockerStackExeHost :: DockerStackExe

-- | Docker image's <tt>stack</tt> (versions must match)
DockerStackExeImage :: DockerStackExe

-- | Executable at given path
DockerStackExePath :: (Path Abs File) -> DockerStackExe

-- | Parse <a>DockerStackExe</a>.
parseDockerStackExe :: (MonadThrow m) => String -> m DockerStackExe

-- | Docker volume mount.
data Mount
Mount :: String -> String -> Mount

-- | For optparse-applicative.

-- | Show instance.

-- | For YAML.

-- | Options for Docker repository or image.
data DockerMonoidRepoOrImage
DockerMonoidRepo :: String -> DockerMonoidRepoOrImage
DockerMonoidImage :: String -> DockerMonoidRepoOrImage

-- | Newtype for non-orphan FromJSON instance.
newtype VersionRangeJSON
VersionRangeJSON :: VersionRange -> VersionRangeJSON
[unVersionRangeJSON] :: VersionRangeJSON -> VersionRange

-- | Parse VersionRange.

-- | Docker enable argument name.
dockerEnableArgName :: Text

-- | Docker repo arg argument name.
dockerRepoArgName :: Text

-- | Docker image argument name.
dockerImageArgName :: Text

-- | Docker registry login argument name.
dockerRegistryLoginArgName :: Text

-- | Docker registry username argument name.
dockerRegistryUsernameArgName :: Text

-- | Docker registry password argument name.
dockerRegistryPasswordArgName :: Text

-- | Docker auto-pull argument name.
dockerAutoPullArgName :: Text

-- | Docker detach argument name.
dockerDetachArgName :: Text

-- | Docker run args argument name.
dockerRunArgsArgName :: Text

-- | Docker mount argument name.
dockerMountArgName :: Text

-- | Docker environment variable argument name.
dockerEnvArgName :: Text

-- | Docker container name argument name.
dockerContainerNameArgName :: Text

-- | Docker persist argument name.
dockerPersistArgName :: Text

-- | Docker database path argument name.
dockerDatabasePathArgName :: Text

-- | Docker database path argument name.
dockerStackExeArgName :: Text

-- | Value for <tt>--docker-stack-exe=download</tt>
dockerStackExeDownloadVal :: String

-- | Value for <tt>--docker-stack-exe=host</tt>
dockerStackExeHostVal :: String

-- | Value for <tt>--docker-stack-exe=image</tt>
dockerStackExeImageVal :: String

-- | Docker <tt>set-user</tt> argument name
dockerSetUserArgName :: Text

-- | Docker <tt>require-version</tt> argument name
dockerRequireDockerVersionArgName :: Text

-- | Argument name used to pass docker entrypoint data (only used
--   internally)
dockerEntrypointArgName :: String
instance GHC.Show.Show Stack.Types.Docker.DockerOptsMonoid
instance GHC.Show.Show Stack.Types.Docker.DockerMonoidRepoOrImage
instance GHC.Show.Show Stack.Types.Docker.DockerOpts
instance GHC.Show.Show Stack.Types.Docker.DockerStackExe
instance Data.Aeson.Types.Class.FromJSON (Stack.Types.Docker.DockerOptsMonoid, [Data.Aeson.Extended.JSONWarning])
instance GHC.Base.Monoid Stack.Types.Docker.DockerOptsMonoid
instance GHC.Read.Read Stack.Types.Docker.Mount
instance GHC.Show.Show Stack.Types.Docker.Mount
instance Data.Aeson.Types.Class.FromJSON Stack.Types.Docker.Mount
instance Data.Aeson.Types.Class.FromJSON Stack.Types.Docker.VersionRangeJSON


-- | Shared types for various stackage packages.
module Stack.Types.BuildPlan
data BuildPlan
BuildPlan :: SystemInfo -> Vector (PackageName, Version) -> Map PackageName PackagePlan -> Map Text (Set Text) -> BuildPlan
[bpSystemInfo] :: BuildPlan -> SystemInfo
[bpTools] :: BuildPlan -> Vector (PackageName, Version)
[bpPackages] :: BuildPlan -> Map PackageName PackagePlan
[bpGithubUsers] :: BuildPlan -> Map Text (Set Text)
data PackagePlan
PackagePlan :: Version -> Set Text -> Set PackageName -> PackageConstraints -> SimpleDesc -> PackagePlan
[ppVersion] :: PackagePlan -> Version
[ppGithubPings] :: PackagePlan -> Set Text
[ppUsers] :: PackagePlan -> Set PackageName
[ppConstraints] :: PackagePlan -> PackageConstraints
[ppDesc] :: PackagePlan -> SimpleDesc
data PackageConstraints
PackageConstraints :: VersionRange -> Maybe Maintainer -> TestState -> TestState -> Bool -> Map FlagName Bool -> Bool -> PackageConstraints
[pcVersionRange] :: PackageConstraints -> VersionRange
[pcMaintainer] :: PackageConstraints -> Maybe Maintainer
[pcTests] :: PackageConstraints -> TestState
[pcHaddocks] :: PackageConstraints -> TestState
[pcBuildBenchmarks] :: PackageConstraints -> Bool
[pcFlagOverrides] :: PackageConstraints -> Map FlagName Bool
[pcEnableLibProfile] :: PackageConstraints -> Bool
data TestState
ExpectSuccess :: TestState
ExpectFailure :: TestState

-- | when the test suite will pull in things we don't want
Don'tBuild :: TestState
data SystemInfo
SystemInfo :: CompilerVersion -> OS -> Arch -> Map PackageName Version -> Set ExeName -> SystemInfo
[siCompilerVersion] :: SystemInfo -> CompilerVersion
[siOS] :: SystemInfo -> OS
[siArch] :: SystemInfo -> Arch
[siCorePackages] :: SystemInfo -> Map PackageName Version
[siCoreExecutables] :: SystemInfo -> Set ExeName
newtype Maintainer
Maintainer :: Text -> Maintainer
[unMaintainer] :: Maintainer -> Text

-- | Name of an executable.
newtype ExeName
ExeName :: ByteString -> ExeName
[unExeName] :: ExeName -> ByteString

-- | A simplified package description that tracks:
--   
--   <ul>
--   <li>Package dependencies</li>
--   <li>Build tool dependencies</li>
--   <li>Provided executables</li>
--   </ul>
--   
--   It has fully resolved all conditionals
data SimpleDesc
SimpleDesc :: Map PackageName DepInfo -> Map ExeName DepInfo -> Set ExeName -> Set Text -> SimpleDesc
[sdPackages] :: SimpleDesc -> Map PackageName DepInfo
[sdTools] :: SimpleDesc -> Map ExeName DepInfo
[sdProvidedExes] :: SimpleDesc -> Set ExeName

-- | modules exported by the library
[sdModules] :: SimpleDesc -> Set Text
data DepInfo
DepInfo :: Set Component -> VersionRange -> DepInfo
[diComponents] :: DepInfo -> Set Component
[diRange] :: DepInfo -> VersionRange
data Component
CompLibrary :: Component
CompExecutable :: Component
CompTestSuite :: Component
CompBenchmark :: Component

-- | The name of an LTS Haskell or Stackage Nightly snapshot.
data SnapName
LTS :: !Int -> !Int -> SnapName
Nightly :: !Day -> SnapName

-- | A simplified version of the <a>BuildPlan</a> + cabal file.
data MiniBuildPlan
MiniBuildPlan :: !CompilerVersion -> !(Map PackageName MiniPackageInfo) -> MiniBuildPlan
[mbpCompilerVersion] :: MiniBuildPlan -> !CompilerVersion
[mbpPackages] :: MiniBuildPlan -> !(Map PackageName MiniPackageInfo)

-- | Information on a single package for the <a>MiniBuildPlan</a>.
data MiniPackageInfo
MiniPackageInfo :: !Version -> !(Map FlagName Bool) -> !(Set PackageName) -> !(Set ByteString) -> !(Set ExeName) -> !Bool -> MiniPackageInfo
[mpiVersion] :: MiniPackageInfo -> !Version
[mpiFlags] :: MiniPackageInfo -> !(Map FlagName Bool)
[mpiPackageDeps] :: MiniPackageInfo -> !(Set PackageName)

-- | Due to ambiguity in Cabal, it is unclear whether this refers to the
--   executable name, the package name, or something else. We have to guess
--   based on what's available, which is why we store this is an unwrapped
--   <a>ByteString</a>.
[mpiToolDeps] :: MiniPackageInfo -> !(Set ByteString)

-- | Executables provided by this package
[mpiExes] :: MiniPackageInfo -> !(Set ExeName)

-- | Is there a library present?
[mpiHasLibrary] :: MiniPackageInfo -> !Bool

-- | Convert a <a>SnapName</a> into its short representation, e.g.
--   <tt>lts-2.8</tt>, <tt>nightly-2015-03-05</tt>.
renderSnapName :: SnapName -> Text

-- | Parse the short representation of a <a>SnapName</a>.
parseSnapName :: MonadThrow m => Text -> m SnapName
instance GHC.Generics.Selector Stack.Types.BuildPlan.S1_0_1MiniBuildPlan
instance GHC.Generics.Selector Stack.Types.BuildPlan.S1_0_0MiniBuildPlan
instance GHC.Generics.Constructor Stack.Types.BuildPlan.C1_0MiniBuildPlan
instance GHC.Generics.Datatype Stack.Types.BuildPlan.D1MiniBuildPlan
instance GHC.Generics.Selector Stack.Types.BuildPlan.S1_0_5MiniPackageInfo
instance GHC.Generics.Selector Stack.Types.BuildPlan.S1_0_4MiniPackageInfo
instance GHC.Generics.Selector Stack.Types.BuildPlan.S1_0_3MiniPackageInfo
instance GHC.Generics.Selector Stack.Types.BuildPlan.S1_0_2MiniPackageInfo
instance GHC.Generics.Selector Stack.Types.BuildPlan.S1_0_1MiniPackageInfo
instance GHC.Generics.Selector Stack.Types.BuildPlan.S1_0_0MiniPackageInfo
instance GHC.Generics.Constructor Stack.Types.BuildPlan.C1_0MiniPackageInfo
instance GHC.Generics.Datatype Stack.Types.BuildPlan.D1MiniPackageInfo
instance GHC.Generics.Selector Stack.Types.BuildPlan.S1_0_0ExeName
instance GHC.Generics.Constructor Stack.Types.BuildPlan.C1_0ExeName
instance GHC.Generics.Datatype Stack.Types.BuildPlan.D1ExeName
instance GHC.Classes.Eq Stack.Types.BuildPlan.MiniBuildPlan
instance GHC.Show.Show Stack.Types.BuildPlan.MiniBuildPlan
instance GHC.Generics.Generic Stack.Types.BuildPlan.MiniBuildPlan
instance GHC.Classes.Eq Stack.Types.BuildPlan.MiniPackageInfo
instance GHC.Show.Show Stack.Types.BuildPlan.MiniPackageInfo
instance GHC.Generics.Generic Stack.Types.BuildPlan.MiniPackageInfo
instance GHC.Classes.Eq Stack.Types.BuildPlan.BuildPlan
instance GHC.Show.Show Stack.Types.BuildPlan.BuildPlan
instance GHC.Classes.Eq Stack.Types.BuildPlan.PackagePlan
instance GHC.Show.Show Stack.Types.BuildPlan.PackagePlan
instance GHC.Classes.Eq Stack.Types.BuildPlan.SimpleDesc
instance GHC.Show.Show Stack.Types.BuildPlan.SimpleDesc
instance GHC.Classes.Eq Stack.Types.BuildPlan.DepInfo
instance GHC.Show.Show Stack.Types.BuildPlan.DepInfo
instance GHC.Enum.Bounded Stack.Types.BuildPlan.Component
instance GHC.Enum.Enum Stack.Types.BuildPlan.Component
instance GHC.Classes.Ord Stack.Types.BuildPlan.Component
instance GHC.Classes.Eq Stack.Types.BuildPlan.Component
instance GHC.Read.Read Stack.Types.BuildPlan.Component
instance GHC.Show.Show Stack.Types.BuildPlan.Component
instance GHC.Classes.Ord Stack.Types.BuildPlan.SystemInfo
instance GHC.Classes.Eq Stack.Types.BuildPlan.SystemInfo
instance GHC.Show.Show Stack.Types.BuildPlan.SystemInfo
instance Control.DeepSeq.NFData Stack.Types.BuildPlan.ExeName
instance Data.Binary.Class.Binary Stack.Types.BuildPlan.ExeName
instance GHC.Generics.Generic Stack.Types.BuildPlan.ExeName
instance Data.String.IsString Stack.Types.BuildPlan.ExeName
instance Data.Hashable.Class.Hashable Stack.Types.BuildPlan.ExeName
instance GHC.Classes.Ord Stack.Types.BuildPlan.ExeName
instance GHC.Classes.Eq Stack.Types.BuildPlan.ExeName
instance GHC.Show.Show Stack.Types.BuildPlan.ExeName
instance GHC.Classes.Eq Stack.Types.BuildPlan.PackageConstraints
instance GHC.Show.Show Stack.Types.BuildPlan.PackageConstraints
instance Data.String.IsString Stack.Types.BuildPlan.Maintainer
instance Data.Aeson.Types.Class.FromJSON Stack.Types.BuildPlan.Maintainer
instance Data.Aeson.Types.Class.ToJSON Stack.Types.BuildPlan.Maintainer
instance Data.Hashable.Class.Hashable Stack.Types.BuildPlan.Maintainer
instance GHC.Classes.Ord Stack.Types.BuildPlan.Maintainer
instance GHC.Classes.Eq Stack.Types.BuildPlan.Maintainer
instance GHC.Show.Show Stack.Types.BuildPlan.Maintainer
instance GHC.Enum.Enum Stack.Types.BuildPlan.TestState
instance GHC.Enum.Bounded Stack.Types.BuildPlan.TestState
instance GHC.Classes.Ord Stack.Types.BuildPlan.TestState
instance GHC.Classes.Eq Stack.Types.BuildPlan.TestState
instance GHC.Show.Show Stack.Types.BuildPlan.TestState
instance GHC.Classes.Ord Stack.Types.BuildPlan.SnapName
instance GHC.Classes.Eq Stack.Types.BuildPlan.SnapName
instance GHC.Show.Show Stack.Types.BuildPlan.SnapName
instance Data.Aeson.Types.Class.ToJSON Stack.Types.BuildPlan.BuildPlan
instance Data.Aeson.Types.Class.FromJSON Stack.Types.BuildPlan.BuildPlan
instance Data.Aeson.Types.Class.ToJSON Stack.Types.BuildPlan.PackagePlan
instance Data.Aeson.Types.Class.FromJSON Stack.Types.BuildPlan.PackagePlan
instance GHC.Exception.Exception Stack.Types.BuildPlan.BuildPlanTypesException
instance GHC.Show.Show Stack.Types.BuildPlan.BuildPlanTypesException
instance Data.Aeson.Types.Class.ToJSON Stack.Types.BuildPlan.PackageConstraints
instance Data.Aeson.Types.Class.FromJSON Stack.Types.BuildPlan.PackageConstraints
instance Data.Aeson.Types.Class.ToJSON Stack.Types.BuildPlan.TestState
instance Data.Aeson.Types.Class.FromJSON Stack.Types.BuildPlan.TestState
instance Data.Aeson.Types.Class.ToJSON Stack.Types.BuildPlan.SystemInfo
instance Data.Aeson.Types.Class.FromJSON Stack.Types.BuildPlan.SystemInfo
instance Data.Binary.Tagged.HasStructuralInfo Stack.Types.BuildPlan.ExeName
instance Data.Aeson.Types.Class.ToJSON Stack.Types.BuildPlan.ExeName
instance Data.Aeson.Types.Class.FromJSON Stack.Types.BuildPlan.ExeName
instance GHC.Base.Monoid Stack.Types.BuildPlan.SimpleDesc
instance Data.Aeson.Types.Class.ToJSON Stack.Types.BuildPlan.SimpleDesc
instance Data.Aeson.Types.Class.FromJSON Stack.Types.BuildPlan.SimpleDesc
instance GHC.Base.Monoid Stack.Types.BuildPlan.DepInfo
instance Data.Aeson.Types.Class.ToJSON Stack.Types.BuildPlan.DepInfo
instance Data.Aeson.Types.Class.FromJSON Stack.Types.BuildPlan.DepInfo
instance Data.Aeson.Types.Class.ToJSON Stack.Types.BuildPlan.Component
instance Data.Aeson.Types.Class.FromJSON Stack.Types.BuildPlan.Component
instance Data.Aeson.Types.Class.ToJSON a => Data.Aeson.Types.Class.ToJSON (Data.Map.Base.Map Stack.Types.BuildPlan.ExeName a)
instance Data.Aeson.Types.Class.FromJSON a => Data.Aeson.Types.Class.FromJSON (Data.Map.Base.Map Stack.Types.BuildPlan.ExeName a)
instance Data.Binary.Class.Binary Stack.Types.BuildPlan.MiniBuildPlan
instance Control.DeepSeq.NFData Stack.Types.BuildPlan.MiniBuildPlan
instance Data.Binary.Tagged.HasStructuralInfo Stack.Types.BuildPlan.MiniBuildPlan
instance Data.Binary.Tagged.HasSemanticVersion Stack.Types.BuildPlan.MiniBuildPlan
instance Data.Binary.Class.Binary Stack.Types.BuildPlan.MiniPackageInfo
instance Data.Binary.Tagged.HasStructuralInfo Stack.Types.BuildPlan.MiniPackageInfo
instance Control.DeepSeq.NFData Stack.Types.BuildPlan.MiniPackageInfo


-- | Nix types.
module Stack.Types.Nix

-- | Nix configuration.
data NixOpts
NixOpts :: !Bool -> ![Text] -> !(Maybe String) -> ![Text] -> NixOpts
[nixEnable] :: NixOpts -> !Bool

-- | The system packages to be installed in the environment before it runs
[nixPackages] :: NixOpts -> ![Text]

-- | The path of a file containing preconfiguration of the environment (e.g
--   shell.nix)
[nixInitFile] :: NixOpts -> !(Maybe String)

-- | Options to be given to the nix-shell command line
[nixShellOptions] :: NixOpts -> ![Text]

-- | An uninterpreted representation of nix options. Configurations may be
--   "cascaded" using mappend (left-biased).
data NixOptsMonoid
NixOptsMonoid :: !Bool -> !(Maybe Bool) -> ![Text] -> !(Maybe String) -> ![Text] -> NixOptsMonoid

-- | Should nix-shell be defaulted to enabled (does <tt>nix:</tt> section
--   exist in the config)?
[nixMonoidDefaultEnable] :: NixOptsMonoid -> !Bool

-- | Is using nix-shell enabled?
[nixMonoidEnable] :: NixOptsMonoid -> !(Maybe Bool)

-- | System packages to use (given to nix-shell)
[nixMonoidPackages] :: NixOptsMonoid -> ![Text]

-- | The path of a file containing preconfiguration of the environment (e.g
--   shell.nix)
[nixMonoidInitFile] :: NixOptsMonoid -> !(Maybe String)

-- | Options to be given to the nix-shell command line
[nixMonoidShellOptions] :: NixOptsMonoid -> ![Text]

-- | Decode uninterpreted nix options from JSON/YAML.

-- | Left-biased combine nix options

-- | Nix enable argument name.
nixEnableArgName :: Text

-- | Nix packages (build inputs) argument name.
nixPackagesArgName :: Text

-- | shell.nix file path argument name.
nixInitFileArgName :: Text

-- | Extra options for the nix-shell command argument name.
nixShellOptsArgName :: Text
instance GHC.Show.Show Stack.Types.Nix.NixOptsMonoid
instance GHC.Show.Show Stack.Types.Nix.NixOpts
instance Data.Aeson.Types.Class.FromJSON (Stack.Types.Nix.NixOptsMonoid, [Data.Aeson.Extended.JSONWarning])
instance GHC.Base.Monoid Stack.Types.Nix.NixOptsMonoid

module Stack.Types.Image

-- | Image options. Currently only Docker image options.
data ImageOpts
ImageOpts :: !(Maybe ImageDockerOpts) -> ImageOpts

-- | Maybe a section for docker image settings.
[imgDocker] :: ImageOpts -> !(Maybe ImageDockerOpts)
data ImageDockerOpts
ImageDockerOpts :: !(Maybe String) -> !(Maybe [String]) -> !(Map FilePath FilePath) -> !(Maybe String) -> ImageDockerOpts

-- | Maybe have a docker base image name. (Although we will not be able to
--   create any Docker images without this.)
[imgDockerBase] :: ImageDockerOpts -> !(Maybe String)

-- | Maybe have a specific ENTRYPOINT list that will be used to create
--   images.
[imgDockerEntrypoints] :: ImageDockerOpts -> !(Maybe [String])

-- | Maybe have some static project content to include in a specific
--   directory in all the images.
[imgDockerAdd] :: ImageDockerOpts -> !(Map FilePath FilePath)

-- | Maybe have a name for the image we are creating
[imgDockerImageName] :: ImageDockerOpts -> !(Maybe String)
data ImageOptsMonoid
ImageOptsMonoid :: !(Maybe ImageDockerOptsMonoid) -> ImageOptsMonoid
[imgMonoidDocker] :: ImageOptsMonoid -> !(Maybe ImageDockerOptsMonoid)
data ImageDockerOptsMonoid
ImageDockerOptsMonoid :: !(Maybe String) -> !(Maybe [String]) -> !(Maybe (Map String FilePath)) -> !(Maybe String) -> ImageDockerOptsMonoid
[imgDockerMonoidBase] :: ImageDockerOptsMonoid -> !(Maybe String)
[imgDockerMonoidEntrypoints] :: ImageDockerOptsMonoid -> !(Maybe [String])
[imgDockerMonoidAdd] :: ImageDockerOptsMonoid -> !(Maybe (Map String FilePath))
[imgDockerMonoidImageName] :: ImageDockerOptsMonoid -> !(Maybe String)
imgArgName :: Text
imgDockerArgName :: Text
imgDockerBaseArgName :: Text
imgDockerAddArgName :: Text
imgDockerEntrypointsArgName :: Text
imgDockerImageNameArgName :: Text
instance GHC.Show.Show Stack.Types.Image.ImageOptsMonoid
instance GHC.Show.Show Stack.Types.Image.ImageDockerOptsMonoid
instance GHC.Show.Show Stack.Types.Image.ImageOpts
instance GHC.Show.Show Stack.Types.Image.ImageDockerOpts
instance Data.Aeson.Types.Class.FromJSON (Stack.Types.Image.ImageOptsMonoid, [Data.Aeson.Extended.JSONWarning])
instance GHC.Base.Monoid Stack.Types.Image.ImageOptsMonoid
instance Data.Aeson.Types.Class.FromJSON (Stack.Types.Image.ImageDockerOptsMonoid, [Data.Aeson.Extended.JSONWarning])
instance GHC.Base.Monoid Stack.Types.Image.ImageDockerOptsMonoid


-- | Simple interface to complicated program arguments.
--   
--   This is a "fork" of the <tt>optparse-simple</tt> package that has some
--   workarounds for optparse-applicative issues that become problematic
--   with programs that have many options and subcommands. Because it makes
--   the interface more complex, these workarounds are not suitable for
--   pushing upstream to optparse-applicative.
module Options.Applicative.Complicated

-- | Add a command to the options dispatcher.
addCommand :: String -> String -> String -> (a -> b) -> Parser c -> Parser a -> EitherT b (Writer (Mod CommandFields (b, c))) ()

-- | Add a command that takes sub-commands to the options dispatcher.
addSubCommands :: Monoid c => String -> String -> String -> Parser c -> EitherT b (Writer (Mod CommandFields (b, c))) () -> EitherT b (Writer (Mod CommandFields (b, c))) ()

-- | Generate and execute a complicated options parser.
complicatedOptions :: Monoid a => Version -> Maybe String -> String -> String -> Parser a -> Maybe (ParserFailure ParserHelp -> [String] -> IO (a, (b, a))) -> EitherT b (Writer (Mod CommandFields (b, a))) () -> IO (a, b)

-- | Generate a complicated options parser.
complicatedParser :: Monoid a => Parser a -> EitherT b (Writer (Mod CommandFields (b, a))) () -> Parser (a, (b, a))


-- | Parsing argument-like things.
module Data.Attoparsec.Args

-- | Mode for parsing escape characters.
data EscapingMode
Escaping :: EscapingMode
NoEscaping :: EscapingMode

-- | A basic argument parser. It supports space-separated text, and string
--   quotation with identity escaping: x -&gt; x.
argsParser :: EscapingMode -> Parser Text [String]

-- | Parse arguments using <a>argsParser</a>.
parseArgs :: EscapingMode -> Text -> Either String [String]

-- | Use <a>withArgs</a> on result of <a>getInterpreterArgs</a>.
withInterpreterArgs :: String -> ([String] -> Bool -> IO a) -> IO a
instance GHC.Enum.Enum Data.Attoparsec.Args.EscapingMode
instance GHC.Classes.Eq Data.Attoparsec.Args.EscapingMode
instance GHC.Show.Show Data.Attoparsec.Args.EscapingMode


-- | The Config type.
module Stack.Types.Config

-- | Class for environment values which have a Platform
class HasPlatform env
getPlatform :: HasPlatform env => env -> Platform
getPlatformVariant :: HasPlatform env => env -> PlatformVariant

-- | Class for environment values which have access to the stack root
class HasStackRoot env
getStackRoot :: HasStackRoot env => env -> Path Abs Dir

-- | A variant of the platform, used to differentiate Docker builds from
--   host
data PlatformVariant
PlatformVariantNone :: PlatformVariant
PlatformVariant :: String -> PlatformVariant

-- | The top-level Stackage configuration.
data Config
Config :: !(Path Abs Dir) -> !(Path Rel Dir) -> !(Path Abs File) -> !DockerOpts -> !NixOpts -> !(EnvSettings -> IO EnvOverride) -> !(Path Abs Dir) -> !(Path Abs Dir) -> !Int -> !Bool -> !Platform -> !PlatformVariant -> !(Maybe GHCVariant) -> !Text -> ![PackageIndex] -> !Bool -> !Bool -> !Bool -> !Bool -> !VersionCheck -> !(Path Abs Dir) -> !VersionRange -> !Int -> !(Set Text) -> !(Set Text) -> !ConfigMonoid -> !Bool -> !ImageOpts -> !(Map Text Text) -> !(Maybe SCM) -> !(Map (Maybe PackageName) [Text]) -> ![SetupInfoLocation] -> !PvpBounds -> !Bool -> !(Map (Maybe PackageName) Bool) -> !Bool -> !ApplyGhcOptions -> !Bool -> Config

-- | ~/.stack more often than not
[configStackRoot] :: Config -> !(Path Abs Dir)

-- | this allows to override .stack-work directory
[configWorkDir] :: Config -> !(Path Rel Dir)

-- | Path to user configuration file (usually ~<i>.stack</i>config.yaml)
[configUserConfigPath] :: Config -> !(Path Abs File)

-- | Docker configuration
[configDocker] :: Config -> !DockerOpts

-- | Execution environment (e.g nix-shell) configuration
[configNix] :: Config -> !NixOpts

-- | Environment variables to be passed to external tools
[configEnvOverride] :: Config -> !(EnvSettings -> IO EnvOverride)

-- | Non-platform-specific path containing local installations
[configLocalProgramsBase] :: Config -> !(Path Abs Dir)

-- | Path containing local installations (mainly GHC)
[configLocalPrograms] :: Config -> !(Path Abs Dir)

-- | How many concurrent connections are allowed when downloading
[configConnectionCount] :: Config -> !Int

-- | Hide the Template Haskell "Loading package ..." messages from the
--   console
[configHideTHLoading] :: Config -> !Bool

-- | The platform we're building for, used in many directory names
[configPlatform] :: Config -> !Platform

-- | Variant of the platform, also used in directory names
[configPlatformVariant] :: Config -> !PlatformVariant

-- | The variant of GHC requested by the user. In most cases, use
--   <a>BuildConfig</a> or <tt>MiniConfig</tt>s version instead, which will
--   have an auto-detected default.
[configGHCVariant0] :: Config -> !(Maybe GHCVariant)

-- | URL for a JSON file containing information on the latest snapshots
--   available.
[configLatestSnapshotUrl] :: Config -> !Text

-- | Information on package indices. This is left biased, meaning that
--   packages in an earlier index will shadow those in a later index.
--   
--   Warning: if you override packages in an index vs what's available
--   upstream, you may correct your compiled snapshots, as different
--   projects may have different definitions of what pkg-ver means! This
--   feature is primarily intended for adding local packages, not
--   overriding. Overriding is better accomplished by adding to your list
--   of packages.
--   
--   Note that indices specified in a later config file will override
--   previous indices, <i>not</i> extend them.
--   
--   Using an assoc list instead of a Map to keep track of priority
[configPackageIndices] :: Config -> ![PackageIndex]

-- | Should we use the system-installed GHC (on the PATH) if available? Can
--   be overridden by command line options.
[configSystemGHC] :: Config -> !Bool

-- | Should we automatically install GHC if missing or the wrong version is
--   available? Can be overridden by command line options.
[configInstallGHC] :: Config -> !Bool

-- | Don't bother checking the GHC version or architecture.
[configSkipGHCCheck] :: Config -> !Bool

-- | On Windows: don't use a locally installed MSYS
[configSkipMsys] :: Config -> !Bool

-- | Specifies which versions of the compiler are acceptable.
[configCompilerCheck] :: Config -> !VersionCheck

-- | Directory we should install executables into
[configLocalBin] :: Config -> !(Path Abs Dir)

-- | Require a version of stack within this range.
[configRequireStackVersion] :: Config -> !VersionRange

-- | How many concurrent jobs to run, defaults to number of capabilities
[configJobs] :: Config -> !Int

-- | <ul>
--   <li>-extra-include-dirs arguments</li>
--   </ul>
[configExtraIncludeDirs] :: Config -> !(Set Text)

-- | <ul>
--   <li>-extra-lib-dirs arguments</li>
--   </ul>
[configExtraLibDirs] :: Config -> !(Set Text)

-- | <tt>ConfigMonoid</tt> used to generate this
[configConfigMonoid] :: Config -> !ConfigMonoid

-- | Run test suites concurrently
[configConcurrentTests] :: Config -> !Bool
[configImage] :: Config -> !ImageOpts

-- | Parameters for templates.
[configTemplateParams] :: Config -> !(Map Text Text)

-- | Initialize SCM (e.g. git) when creating new projects.
[configScmInit] :: Config -> !(Maybe SCM)

-- | Additional GHC options to apply to either all packages (Nothing) or a
--   specific package (Just).
[configGhcOptions] :: Config -> !(Map (Maybe PackageName) [Text])

-- | Additional SetupInfo (inline or remote) to use to find tools.
[configSetupInfoLocations] :: Config -> ![SetupInfoLocation]

-- | How PVP upper bounds should be added to packages
[configPvpBounds] :: Config -> !PvpBounds

-- | Force the code page to UTF-8 on Windows
[configModifyCodePage] :: Config -> !Bool

-- | See <a>explicitSetupDeps</a>. <a>Nothing</a> provides the default
--   value.
[configExplicitSetupDeps] :: Config -> !(Map (Maybe PackageName) Bool)

-- | Rebuild on GHC options changes
[configRebuildGhcOptions] :: Config -> !Bool

-- | Which packages to ghc-options on the command line apply to?
[configApplyGhcOptions] :: Config -> !ApplyGhcOptions

-- | Ignore version ranges in .cabal files. Funny naming chosen to match
--   cabal.
[configAllowNewer] :: Config -> !Bool

-- | Class for environment values that can provide a <a>Config</a>.
class (HasStackRoot env, HasPlatform env) => HasConfig env
getConfig :: HasConfig env => env -> Config

-- | Helper function to ask the environment and apply getConfig
askConfig :: (MonadReader env m, HasConfig env) => m Config

-- | Get the URL to request the information on the latest snapshots
askLatestSnapshotUrl :: (MonadReader env m, HasConfig env) => m Text

-- | Provide an explicit list of package dependencies when running a custom
--   Setup.hs
explicitSetupDeps :: (MonadReader env m, HasConfig env) => PackageName -> m Bool

-- | Get the minimal environment override, useful for just calling external
--   processes like git or ghc
getMinimalEnvOverride :: (MonadReader env m, HasConfig env, MonadIO m) => m EnvOverride

-- | A superset of <a>Config</a> adding information on how to build code.
--   The reason for this breakdown is because we will need some of the
--   information from <a>Config</a> in order to determine the values here.
data BuildConfig
BuildConfig :: !Config -> !Resolver -> !CompilerVersion -> ![PackageEntry] -> !(Map PackageName Version) -> ![Path Abs Dir] -> !(Path Abs File) -> !(Map PackageName (Map FlagName Bool)) -> !Bool -> !GHCVariant -> !(Map PackageIdentifier (PackageIndex, PackageCache)) -> BuildConfig
[bcConfig] :: BuildConfig -> !Config

-- | How we resolve which dependencies to install given a set of packages.
[bcResolver] :: BuildConfig -> !Resolver

-- | Compiler version wanted for this build
[bcWantedCompiler] :: BuildConfig -> !CompilerVersion

-- | Local packages identified by a path, Bool indicates whether it is a
--   non-dependency (the opposite of <a>peExtraDep</a>)
[bcPackageEntries] :: BuildConfig -> ![PackageEntry]

-- | Extra dependencies specified in configuration.
--   
--   These dependencies will not be installed to a shared location, and
--   will override packages provided by the resolver.
[bcExtraDeps] :: BuildConfig -> !(Map PackageName Version)

-- | Extra package databases
[bcExtraPackageDBs] :: BuildConfig -> ![Path Abs Dir]

-- | Location of the stack.yaml file.
--   
--   Note: if the STACK_YAML environment variable is used, this may be
--   different from bcRoot <a>/</a> "stack.yaml"
[bcStackYaml] :: BuildConfig -> !(Path Abs File)

-- | Per-package flag overrides
[bcFlags] :: BuildConfig -> !(Map PackageName (Map FlagName Bool))

-- | Are we loading from the implicit global stack.yaml? This is useful for
--   providing better error messages.
[bcImplicitGlobal] :: BuildConfig -> !Bool

-- | The variant of GHC used to select a GHC bindist.
[bcGHCVariant] :: BuildConfig -> !GHCVariant

-- | Shared package cache map
[bcPackageCaches] :: BuildConfig -> !(Map PackageIdentifier (PackageIndex, PackageCache))

-- | Directory containing the project's stack.yaml file
bcRoot :: BuildConfig -> Path Abs Dir

-- | <pre>
--   "<a>bcRoot</a>/.stack-work"
--   </pre>
bcWorkDir :: (MonadReader env m, HasConfig env) => BuildConfig -> m (Path Abs Dir)

-- | Class for environment values that can provide a <a>BuildConfig</a>.
class HasConfig env => HasBuildConfig env
getBuildConfig :: HasBuildConfig env => env -> BuildConfig

-- | Specialized bariant of GHC (e.g. libgmp4 or integer-simple)
data GHCVariant

-- | Standard bindist
GHCStandard :: GHCVariant

-- | Bindist that supports libgmp4 (centos66)
GHCGMP4 :: GHCVariant

-- | Bindist built on Arch Linux (bleeding-edge)
GHCArch :: GHCVariant

-- | Bindist that uses integer-simple
GHCIntegerSimple :: GHCVariant

-- | Other bindists
GHCCustom :: String -> GHCVariant

-- | Render a GHC variant to a String.
ghcVariantName :: GHCVariant -> String

-- | Render a GHC variant to a String suffix.
ghcVariantSuffix :: GHCVariant -> String

-- | Parse GHC variant from a String.
parseGHCVariant :: (MonadThrow m) => String -> m GHCVariant

-- | Class for environment values which have a GHCVariant
class HasGHCVariant env
getGHCVariant :: HasGHCVariant env => env -> GHCVariant

-- | Directory containing snapshots
snapshotsDir :: (MonadReader env m, HasConfig env, HasGHCVariant env, MonadThrow m) => m (Path Abs Dir)

-- | Configuration after the environment has been setup.
data EnvConfig
EnvConfig :: !BuildConfig -> !Version -> !CompilerVersion -> !(Map (Path Abs Dir) Bool) -> EnvConfig
[envConfigBuildConfig] :: EnvConfig -> !BuildConfig
[envConfigCabalVersion] :: EnvConfig -> !Version
[envConfigCompilerVersion] :: EnvConfig -> !CompilerVersion
[envConfigPackages] :: EnvConfig -> !(Map (Path Abs Dir) Bool)
class (HasBuildConfig r, HasGHCVariant r) => HasEnvConfig r
getEnvConfig :: HasEnvConfig r => r -> EnvConfig
getWhichCompiler :: (MonadReader env m, HasEnvConfig env) => m WhichCompiler

-- | Which packages to ghc-options on the command line apply to?
data ApplyGhcOptions

-- | all local targets
AGOTargets :: ApplyGhcOptions

-- | all local packages, even non-targets
AGOLocals :: ApplyGhcOptions

-- | every package
AGOEverything :: ApplyGhcOptions
data ConfigException
ParseConfigFileException :: (Path Abs File) -> ParseException -> ConfigException
ParseResolverException :: Text -> ConfigException
NoProjectConfigFound :: (Path Abs Dir) -> (Maybe Text) -> ConfigException
UnexpectedTarballContents :: [Path Abs Dir] -> [Path Abs File] -> ConfigException
BadStackVersionException :: VersionRange -> ConfigException
NoMatchingSnapshot :: [SnapName] -> ConfigException
NoSuchDirectory :: FilePath -> ConfigException
ParseGHCVariantException :: String -> ConfigException
data ConfigMonoid
ConfigMonoid :: !(Maybe FilePath) -> !DockerOptsMonoid -> !NixOptsMonoid -> !(Maybe Int) -> !(Maybe Bool) -> !(Maybe Text) -> !(Maybe [PackageIndex]) -> !(Maybe Bool) -> !(Maybe Bool) -> !(Maybe Bool) -> !(Maybe Bool) -> !(Maybe VersionCheck) -> !VersionRange -> !(Maybe String) -> !(Maybe String) -> !(Maybe GHCVariant) -> !(Maybe Int) -> !(Set Text) -> !(Set Text) -> !(Maybe Bool) -> !(Maybe FilePath) -> !ImageOptsMonoid -> !(Map Text Text) -> !(Maybe SCM) -> !(Map (Maybe PackageName) [Text]) -> ![Path Abs Dir] -> ![SetupInfoLocation] -> !(Maybe PvpBounds) -> !(Maybe Bool) -> !(Map (Maybe PackageName) Bool) -> !(Maybe Bool) -> !(Maybe ApplyGhcOptions) -> !(Maybe Bool) -> ConfigMonoid

-- | See: <a>configWorkDir</a>.
[configMonoidWorkDir] :: ConfigMonoid -> !(Maybe FilePath)

-- | Docker options.
[configMonoidDockerOpts] :: ConfigMonoid -> !DockerOptsMonoid

-- | Options for the execution environment (nix-shell or container)
[configMonoidNixOpts] :: ConfigMonoid -> !NixOptsMonoid

-- | See: <a>configConnectionCount</a>
[configMonoidConnectionCount] :: ConfigMonoid -> !(Maybe Int)

-- | See: <a>configHideTHLoading</a>
[configMonoidHideTHLoading] :: ConfigMonoid -> !(Maybe Bool)

-- | See: <a>configLatestSnapshotUrl</a>
[configMonoidLatestSnapshotUrl] :: ConfigMonoid -> !(Maybe Text)

-- | See: <a>configPackageIndices</a>
[configMonoidPackageIndices] :: ConfigMonoid -> !(Maybe [PackageIndex])

-- | See: <a>configSystemGHC</a>
[configMonoidSystemGHC] :: ConfigMonoid -> !(Maybe Bool)

-- | See: <a>configInstallGHC</a>
[configMonoidInstallGHC] :: ConfigMonoid -> !(Maybe Bool)

-- | See: <a>configSkipGHCCheck</a>
[configMonoidSkipGHCCheck] :: ConfigMonoid -> !(Maybe Bool)

-- | See: <a>configSkipMsys</a>
[configMonoidSkipMsys] :: ConfigMonoid -> !(Maybe Bool)

-- | See: <a>configCompilerCheck</a>
[configMonoidCompilerCheck] :: ConfigMonoid -> !(Maybe VersionCheck)

-- | See: <a>configRequireStackVersion</a>
[configMonoidRequireStackVersion] :: ConfigMonoid -> !VersionRange

-- | Used for overriding the platform
[configMonoidOS] :: ConfigMonoid -> !(Maybe String)

-- | Used for overriding the platform
[configMonoidArch] :: ConfigMonoid -> !(Maybe String)

-- | Used for overriding the GHC variant
[configMonoidGHCVariant] :: ConfigMonoid -> !(Maybe GHCVariant)

-- | See: <a>configJobs</a>
[configMonoidJobs] :: ConfigMonoid -> !(Maybe Int)

-- | See: <a>configExtraIncludeDirs</a>
[configMonoidExtraIncludeDirs] :: ConfigMonoid -> !(Set Text)

-- | See: <a>configExtraLibDirs</a>
[configMonoidExtraLibDirs] :: ConfigMonoid -> !(Set Text)

-- | See: <a>configConcurrentTests</a>
[configMonoidConcurrentTests] :: ConfigMonoid -> !(Maybe Bool)

-- | Used to override the binary installation dir
[configMonoidLocalBinPath] :: ConfigMonoid -> !(Maybe FilePath)

-- | Image creation options.
[configMonoidImageOpts] :: ConfigMonoid -> !ImageOptsMonoid

-- | Template parameters.
[configMonoidTemplateParameters] :: ConfigMonoid -> !(Map Text Text)

-- | Initialize SCM (e.g. git init) when making new projects?
[configMonoidScmInit] :: ConfigMonoid -> !(Maybe SCM)

-- | See <a>configGhcOptions</a>
[configMonoidGhcOptions] :: ConfigMonoid -> !(Map (Maybe PackageName) [Text])

-- | Additional paths to search for executables in
[configMonoidExtraPath] :: ConfigMonoid -> ![Path Abs Dir]

-- | Additional setup info (inline or remote) to use for installing tools
[configMonoidSetupInfoLocations] :: ConfigMonoid -> ![SetupInfoLocation]

-- | See <a>configPvpBounds</a>
[configMonoidPvpBounds] :: ConfigMonoid -> !(Maybe PvpBounds)

-- | See <a>configModifyCodePage</a>
[configMonoidModifyCodePage] :: ConfigMonoid -> !(Maybe Bool)

-- | See <a>configExplicitSetupDeps</a>
[configMonoidExplicitSetupDeps] :: ConfigMonoid -> !(Map (Maybe PackageName) Bool)

-- | See <a>configMonoidRebuildGhcOptions</a>
[configMonoidRebuildGhcOptions] :: ConfigMonoid -> !(Maybe Bool)

-- | See <a>configApplyGhcOptions</a>
[configMonoidApplyGhcOptions] :: ConfigMonoid -> !(Maybe ApplyGhcOptions)

-- | See <a>configMonoidAllowNewer</a>
[configMonoidAllowNewer] :: ConfigMonoid -> !(Maybe Bool)

-- | Controls which version of the environment is used
data EnvSettings
EnvSettings :: !Bool -> !Bool -> !Bool -> !Bool -> EnvSettings

-- | include local project bin directory, GHC_PACKAGE_PATH, etc
[esIncludeLocals] :: EnvSettings -> !Bool

-- | include the GHC_PACKAGE_PATH variable
[esIncludeGhcPackagePath] :: EnvSettings -> !Bool

-- | set the STACK_EXE variable to the current executable name
[esStackExe] :: EnvSettings -> !Bool

-- | set the locale to C.UTF-8
[esLocaleUtf8] :: EnvSettings -> !Bool
minimalEnvSettings :: EnvSettings

-- | Parsed global command-line options.
data GlobalOpts
GlobalOpts :: !(Maybe String) -> !(Maybe DockerEntrypoint) -> !LogLevel -> !ConfigMonoid -> !(Maybe AbstractResolver) -> !(Maybe CompilerVersion) -> !Bool -> !(Maybe FilePath) -> GlobalOpts

-- | Expected re-exec in container version
[globalReExecVersion] :: GlobalOpts -> !(Maybe String)

-- | Data used when stack is acting as a Docker entrypoint (internal use
--   only)
[globalDockerEntrypoint] :: GlobalOpts -> !(Maybe DockerEntrypoint)

-- | Log level
[globalLogLevel] :: GlobalOpts -> !LogLevel

-- | Config monoid, for passing into <tt>loadConfig</tt>
[globalConfigMonoid] :: GlobalOpts -> !ConfigMonoid

-- | Resolver override
[globalResolver] :: GlobalOpts -> !(Maybe AbstractResolver)

-- | Compiler override
[globalCompiler] :: GlobalOpts -> !(Maybe CompilerVersion)

-- | We're in a terminal?
[globalTerminal] :: GlobalOpts -> !Bool

-- | Override project stack.yaml
[globalStackYaml] :: GlobalOpts -> !(Maybe FilePath)

-- | Parsed global command-line options monoid.
data GlobalOptsMonoid
GlobalOptsMonoid :: !(Maybe String) -> !(Maybe DockerEntrypoint) -> !(Maybe LogLevel) -> !ConfigMonoid -> !(Maybe AbstractResolver) -> !(Maybe CompilerVersion) -> !(Maybe Bool) -> !(Maybe FilePath) -> GlobalOptsMonoid

-- | Expected re-exec in container version
[globalMonoidReExecVersion] :: GlobalOptsMonoid -> !(Maybe String)

-- | Data used when stack is acting as a Docker entrypoint (internal use
--   only)
[globalMonoidDockerEntrypoint] :: GlobalOptsMonoid -> !(Maybe DockerEntrypoint)

-- | Log level
[globalMonoidLogLevel] :: GlobalOptsMonoid -> !(Maybe LogLevel)

-- | Config monoid, for passing into <tt>loadConfig</tt>
[globalMonoidConfigMonoid] :: GlobalOptsMonoid -> !ConfigMonoid

-- | Resolver override
[globalMonoidResolver] :: GlobalOptsMonoid -> !(Maybe AbstractResolver)

-- | Compiler override
[globalMonoidCompiler] :: GlobalOptsMonoid -> !(Maybe CompilerVersion)

-- | We're in a terminal?
[globalMonoidTerminal] :: GlobalOptsMonoid -> !(Maybe Bool)

-- | Override project stack.yaml
[globalMonoidStackYaml] :: GlobalOptsMonoid -> !(Maybe FilePath)

-- | Default logging level should be something useful but not crazy.
defaultLogLevel :: LogLevel

-- | Value returned by <a>loadConfig</a>.
data LoadConfig m
LoadConfig :: !Config -> !(Maybe CompilerVersion -> m BuildConfig) -> !(Maybe (Path Abs Dir)) -> LoadConfig m

-- | Top-level Stack configuration.
[lcConfig] :: LoadConfig m -> !Config

-- | Action to load the remaining <a>BuildConfig</a>.
[lcLoadBuildConfig] :: LoadConfig m -> !(Maybe CompilerVersion -> m BuildConfig)

-- | The project root directory, if in a project.
[lcProjectRoot] :: LoadConfig m -> !(Maybe (Path Abs Dir))
data PackageEntry
PackageEntry :: !(Maybe Bool) -> !(Maybe Bool) -> !PackageLocation -> ![FilePath] -> PackageEntry

-- | Is this package a dependency? This means the local package will be
--   treated just like an extra-deps: it will only be built as a dependency
--   for others, and its test suite/benchmarks will not be run.
--   
--   Useful modifying an upstream package, see:
--   <a>https://github.com/commercialhaskell/stack/issues/219</a>
--   <a>https://github.com/commercialhaskell/stack/issues/386</a>
[peExtraDepMaybe] :: PackageEntry -> !(Maybe Bool)

-- | Deprecated name meaning the opposite of peExtraDep. Only present to
--   provide deprecation warnings to users.
[peValidWanted] :: PackageEntry -> !(Maybe Bool)
[peLocation] :: PackageEntry -> !PackageLocation
[peSubdirs] :: PackageEntry -> ![FilePath]

-- | Once peValidWanted is removed, this should just become the field name
--   in PackageEntry.
peExtraDep :: PackageEntry -> Bool
data PackageLocation

-- | Note that we use <tt>FilePath</tt> and not <tt>Path</tt>s. The goal
--   is: first parse the value raw, and then use <tt>canonicalizePath</tt>
--   and <tt>parseAbsDir</tt>.
PLFilePath :: FilePath -> PackageLocation

-- | URL and further details
PLRemote :: Text -> RemotePackageType -> PackageLocation
data RemotePackageType
RPTHttpTarball :: RemotePackageType

-- | Commit
RPTGit :: Text -> RemotePackageType

-- | Commit
RPTHg :: Text -> RemotePackageType

-- | Information on a single package index
data PackageIndex
PackageIndex :: !IndexName -> !IndexLocation -> !Text -> !Bool -> !Bool -> PackageIndex
[indexName] :: PackageIndex -> !IndexName
[indexLocation] :: PackageIndex -> !IndexLocation

-- | URL prefix for downloading packages
[indexDownloadPrefix] :: PackageIndex -> !Text

-- | GPG-verify the package index during download. Only applies to Git
--   repositories for now.
[indexGpgVerify] :: PackageIndex -> !Bool

-- | Require that hashes and package size information be available for
--   packages in this index
[indexRequireHashes] :: PackageIndex -> !Bool

-- | Unique name for a package index
newtype IndexName
IndexName :: ByteString -> IndexName
[unIndexName] :: IndexName -> ByteString

-- | Location of the 00-index.tar file
configPackageIndex :: (MonadReader env m, HasConfig env, MonadThrow m) => IndexName -> m (Path Abs File)

-- | Location of the 00-index.cache file
configPackageIndexCache :: (MonadReader env m, HasConfig env, MonadThrow m) => IndexName -> m (Path Abs File)

-- | Location of the 00-index.tar.gz file
configPackageIndexGz :: (MonadReader env m, HasConfig env, MonadThrow m) => IndexName -> m (Path Abs File)

-- | Root for a specific package index
configPackageIndexRoot :: (MonadReader env m, HasConfig env, MonadThrow m) => IndexName -> m (Path Abs Dir)

-- | Location of a package tarball
configPackageTarball :: (MonadReader env m, HasConfig env, MonadThrow m) => IndexName -> PackageIdentifier -> m (Path Abs File)
indexNameText :: IndexName -> Text

-- | Location of the package index. This ensures that at least one of Git
--   or HTTP is available.
data IndexLocation
ILGit :: !Text -> IndexLocation
ILHttp :: !Text -> IndexLocation
ILGitHttp :: !Text -> !Text -> IndexLocation

-- | A project is a collection of packages. We can have multiple stack.yaml
--   files, but only one of them may contain project information.
data Project
Project :: ![PackageEntry] -> !(Map PackageName Version) -> !(Map PackageName (Map FlagName Bool)) -> !Resolver -> !(Maybe CompilerVersion) -> ![FilePath] -> Project

-- | Components of the package list
[projectPackages] :: Project -> ![PackageEntry]

-- | Components of the package list referring to package/version combos,
--   see: <a>https://github.com/fpco/stack/issues/41</a>
[projectExtraDeps] :: Project -> !(Map PackageName Version)

-- | Per-package flag overrides
[projectFlags] :: Project -> !(Map PackageName (Map FlagName Bool))

-- | How we resolve which dependencies to use
[projectResolver] :: Project -> !Resolver

-- | When specified, overrides which compiler to use
[projectCompiler] :: Project -> !(Maybe CompilerVersion)
[projectExtraPackageDBs] :: Project -> ![FilePath]
data ProjectAndConfigMonoid
ProjectAndConfigMonoid :: !Project -> !ConfigMonoid -> ProjectAndConfigMonoid

-- | How PVP bounds should be added to .cabal files
data PvpBounds
PvpBoundsNone :: PvpBounds
PvpBoundsUpper :: PvpBounds
PvpBoundsLower :: PvpBounds
PvpBoundsBoth :: PvpBounds
parsePvpBounds :: Text -> Either String PvpBounds

-- | How we resolve which dependencies to install given a set of packages.
data Resolver

-- | Use an official snapshot from the Stackage project, either an LTS
--   Haskell or Stackage Nightly
ResolverSnapshot :: SnapName -> Resolver

-- | Require a specific compiler version, but otherwise provide no build
--   plan. Intended for use cases where end user wishes to specify all
--   upstream dependencies manually, such as using a dependency solver.
ResolverCompiler :: !CompilerVersion -> Resolver

-- | A custom resolver based on the given name and URL. This file is
--   assumed to be completely immutable.
ResolverCustom :: !Text -> !Text -> Resolver

-- | Try to parse a <tt>Resolver</tt> from a <tt>Text</tt>. Won't work for
--   complex resolvers (like custom).
parseResolverText :: MonadThrow m => Text -> m Resolver

-- | Convert a Resolver into its <tt>Text</tt> representation, as will be
--   used by directory names
resolverName :: Resolver -> Text

-- | Either an actual resolver value, or an abstract description of one
--   (e.g., latest nightly).
data AbstractResolver
ARLatestNightly :: AbstractResolver
ARLatestLTS :: AbstractResolver
ARLatestLTSMajor :: !Int -> AbstractResolver
ARResolver :: !Resolver -> AbstractResolver
ARGlobal :: AbstractResolver

-- | A software control system.
data SCM
Git :: SCM

-- | Suffix applied to an installation root to get the bin dir
bindirSuffix :: Path Rel Dir

-- | File containing the installed cache, see <a>Stack.PackageDump</a>
configInstalledCache :: (HasBuildConfig env, MonadReader env m) => m (Path Abs File)

-- | Where to store mini build plan caches
configMiniBuildPlanCache :: (MonadThrow m, MonadReader env m, HasConfig env, HasGHCVariant env) => SnapName -> m (Path Abs File)

-- | Per-project work dir
configProjectWorkDir :: (HasBuildConfig env, MonadReader env m) => m (Path Abs Dir)

-- | Suffix applied to an installation root to get the doc dir
docDirSuffix :: Path Rel Dir

-- | Directory for holding flag cache information
flagCacheLocal :: (MonadThrow m, MonadReader env m, HasEnvConfig env) => m (Path Abs Dir)

-- | Get the extra bin directories (for the PATH). Puts more local first
--   
--   Bool indicates whether or not to include the locals
extraBinDirs :: (MonadThrow m, MonadReader env m, HasEnvConfig env) => m (Bool -> [Path Abs Dir])

-- | Where HPC reports and tix files get stored.
hpcReportDir :: (MonadThrow m, MonadReader env m, HasEnvConfig env) => m (Path Abs Dir)

-- | Installation root for dependencies
installationRootDeps :: (MonadThrow m, MonadReader env m, HasEnvConfig env) => m (Path Abs Dir)

-- | Installation root for locals
installationRootLocal :: (MonadThrow m, MonadReader env m, HasEnvConfig env) => m (Path Abs Dir)

-- | Package database for installing dependencies into
packageDatabaseDeps :: (MonadThrow m, MonadReader env m, HasEnvConfig env) => m (Path Abs Dir)

-- | Extra package databases
packageDatabaseExtra :: (MonadThrow m, MonadReader env m, HasEnvConfig env) => m [Path Abs Dir]

-- | Package database for installing local packages into
packageDatabaseLocal :: (MonadThrow m, MonadReader env m, HasEnvConfig env) => m (Path Abs Dir)

-- | Relative directory for the platform identifier
platformOnlyRelDir :: (MonadReader env m, HasPlatform env, MonadThrow m) => m (Path Rel Dir)

-- | Relative directory for the platform identifier
platformVariantRelDir :: (MonadReader env m, HasPlatform env, HasGHCVariant env, MonadThrow m) => m (Path Rel Dir)

-- | This is an attempt to shorten stack paths on Windows to decrease our
--   chances of hitting 260 symbol path limit. The idea is to calculate
--   SHA1 hash of the path used on other architectures, encode with base 16
--   and take first 8 symbols of it.
useShaPathOnWindows :: MonadThrow m => Path Rel Dir -> m (Path Rel Dir)

-- | <pre>
--   ".stack-work"
--   </pre>
getWorkDir :: (MonadReader env m, HasConfig env) => m (Path Rel Dir)
data EvalOpts
EvalOpts :: !String -> !ExecOptsExtra -> EvalOpts
[evalArg] :: EvalOpts -> !String
[evalExtra] :: EvalOpts -> !ExecOptsExtra
data ExecOpts
ExecOpts :: !SpecialExecCmd -> ![String] -> !ExecOptsExtra -> ExecOpts
[eoCmd] :: ExecOpts -> !SpecialExecCmd
[eoArgs] :: ExecOpts -> ![String]
[eoExtra] :: ExecOpts -> !ExecOptsExtra
data SpecialExecCmd
ExecCmd :: String -> SpecialExecCmd
ExecGhc :: SpecialExecCmd
ExecRunGhc :: SpecialExecCmd
data ExecOptsExtra
ExecOptsPlain :: ExecOptsExtra
ExecOptsEmbellished :: !EnvSettings -> ![String] -> ExecOptsExtra
[eoEnvSettings] :: ExecOptsExtra -> !EnvSettings
[eoPackages] :: ExecOptsExtra -> ![String]

-- | Information for a file to download.
data DownloadInfo
DownloadInfo :: Text -> Maybe Int -> Maybe ByteString -> DownloadInfo
[downloadInfoUrl] :: DownloadInfo -> Text
[downloadInfoContentLength] :: DownloadInfo -> Maybe Int
[downloadInfoSha1] :: DownloadInfo -> Maybe ByteString
data VersionedDownloadInfo
VersionedDownloadInfo :: Version -> DownloadInfo -> VersionedDownloadInfo
[vdiVersion] :: VersionedDownloadInfo -> Version
[vdiDownloadInfo] :: VersionedDownloadInfo -> DownloadInfo
data SetupInfo
SetupInfo :: Maybe DownloadInfo -> Maybe DownloadInfo -> Map Text VersionedDownloadInfo -> Map Text (Map Version DownloadInfo) -> Map Text (Map CompilerVersion DownloadInfo) -> Map Text (Map Version DownloadInfo) -> SetupInfo
[siSevenzExe] :: SetupInfo -> Maybe DownloadInfo
[siSevenzDll] :: SetupInfo -> Maybe DownloadInfo
[siMsys2] :: SetupInfo -> Map Text VersionedDownloadInfo
[siGHCs] :: SetupInfo -> Map Text (Map Version DownloadInfo)
[siGHCJSs] :: SetupInfo -> Map Text (Map CompilerVersion DownloadInfo)
[siStack] :: SetupInfo -> Map Text (Map Version DownloadInfo)

-- | Remote or inline <a>SetupInfo</a>
data SetupInfoLocation
SetupInfoFileOrURL :: String -> SetupInfoLocation
SetupInfoInline :: SetupInfo -> SetupInfoLocation

-- | Data passed into Docker container for the Docker entrypoint's use
data DockerEntrypoint
DockerEntrypoint :: !(Maybe (UserID, GroupID)) -> DockerEntrypoint

-- | UID<i>GID of host user, if we wish to perform UID</i>GID switch in
--   container
[deUidGid] :: DockerEntrypoint -> !(Maybe (UserID, GroupID))
instance GHC.Show.Show Stack.Types.Config.GlobalOpts
instance GHC.Show.Show Stack.Types.Config.GlobalOptsMonoid
instance GHC.Show.Show Stack.Types.Config.DockerEntrypoint
instance GHC.Read.Read Stack.Types.Config.DockerEntrypoint
instance GHC.Show.Show Stack.Types.Config.ConfigMonoid
instance GHC.Enum.Bounded Stack.Types.Config.PvpBounds
instance GHC.Enum.Enum Stack.Types.Config.PvpBounds
instance GHC.Classes.Ord Stack.Types.Config.PvpBounds
instance GHC.Classes.Eq Stack.Types.Config.PvpBounds
instance GHC.Read.Read Stack.Types.Config.PvpBounds
instance GHC.Show.Show Stack.Types.Config.PvpBounds
instance GHC.Show.Show Stack.Types.Config.SetupInfoLocation
instance GHC.Show.Show Stack.Types.Config.SetupInfo
instance GHC.Show.Show Stack.Types.Config.VersionedDownloadInfo
instance GHC.Show.Show Stack.Types.Config.DownloadInfo
instance GHC.Show.Show Stack.Types.Config.GHCVariant
instance GHC.Show.Show Stack.Types.Config.SCM
instance GHC.Show.Show Stack.Types.Config.AbstractResolver
instance GHC.Show.Show Stack.Types.Config.Project
instance GHC.Show.Show Stack.Types.Config.Resolver
instance GHC.Show.Show Stack.Types.Config.PackageEntry
instance GHC.Show.Show Stack.Types.Config.PackageLocation
instance GHC.Show.Show Stack.Types.Config.RemotePackageType
instance GHC.Show.Show Stack.Types.Config.EvalOpts
instance GHC.Show.Show Stack.Types.Config.ExecOpts
instance GHC.Show.Show Stack.Types.Config.ExecOptsExtra
instance GHC.Classes.Eq Stack.Types.Config.SpecialExecCmd
instance GHC.Show.Show Stack.Types.Config.SpecialExecCmd
instance GHC.Classes.Ord Stack.Types.Config.EnvSettings
instance GHC.Classes.Eq Stack.Types.Config.EnvSettings
instance GHC.Show.Show Stack.Types.Config.EnvSettings
instance GHC.Show.Show Stack.Types.Config.PackageIndex
instance GHC.Classes.Ord Stack.Types.Config.IndexLocation
instance GHC.Classes.Eq Stack.Types.Config.IndexLocation
instance GHC.Show.Show Stack.Types.Config.IndexLocation
instance Data.Binary.Class.Binary Stack.Types.Config.IndexName
instance Data.Hashable.Class.Hashable Stack.Types.Config.IndexName
instance GHC.Classes.Ord Stack.Types.Config.IndexName
instance GHC.Classes.Eq Stack.Types.Config.IndexName
instance GHC.Show.Show Stack.Types.Config.IndexName
instance GHC.Enum.Bounded Stack.Types.Config.ApplyGhcOptions
instance GHC.Enum.Enum Stack.Types.Config.ApplyGhcOptions
instance GHC.Classes.Ord Stack.Types.Config.ApplyGhcOptions
instance GHC.Classes.Eq Stack.Types.Config.ApplyGhcOptions
instance GHC.Read.Read Stack.Types.Config.ApplyGhcOptions
instance GHC.Show.Show Stack.Types.Config.ApplyGhcOptions
instance Data.Aeson.Types.Class.FromJSON Stack.Types.Config.ApplyGhcOptions
instance Data.Aeson.Types.Class.FromJSON (Stack.Types.Config.PackageIndex, [Data.Aeson.Extended.JSONWarning])
instance Data.Aeson.Types.Class.ToJSON Stack.Types.Config.IndexName
instance Data.Aeson.Types.Class.FromJSON Stack.Types.Config.IndexName
instance GHC.Base.Monoid Stack.Types.Config.GlobalOptsMonoid
instance Stack.Types.Config.HasBuildConfig Stack.Types.Config.EnvConfig
instance Stack.Types.Config.HasConfig Stack.Types.Config.EnvConfig
instance Stack.Types.Config.HasPlatform Stack.Types.Config.EnvConfig
instance Stack.Types.Config.HasGHCVariant Stack.Types.Config.EnvConfig
instance Stack.Types.Config.HasStackRoot Stack.Types.Config.EnvConfig
instance Stack.Types.Config.HasEnvConfig Stack.Types.Config.EnvConfig
instance Data.Aeson.Types.Class.ToJSON Stack.Types.Config.PackageEntry
instance Data.Aeson.Types.Class.FromJSON (Stack.Types.Config.PackageEntry, [Data.Aeson.Extended.JSONWarning])
instance Data.Aeson.Types.Class.ToJSON Stack.Types.Config.PackageLocation
instance Data.Aeson.Types.Class.FromJSON (Stack.Types.Config.PackageLocation, [Data.Aeson.Extended.JSONWarning])
instance Data.Aeson.Types.Class.ToJSON Stack.Types.Config.Project
instance Data.Aeson.Types.Class.ToJSON Stack.Types.Config.Resolver
instance Data.Aeson.Types.Class.FromJSON (Stack.Types.Config.Resolver, [Data.Aeson.Extended.JSONWarning])
instance Stack.Types.Config.HasPlatform (Distribution.System.Platform, Stack.Types.Config.PlatformVariant)
instance Stack.Types.Config.HasGHCVariant Stack.Types.Config.GHCVariant
instance Stack.Types.Config.HasStackRoot Stack.Types.Config.Config
instance Stack.Types.Config.HasPlatform Stack.Types.Config.Config
instance Stack.Types.Config.HasConfig Stack.Types.Config.Config
instance Stack.Types.Config.HasStackRoot Stack.Types.Config.BuildConfig
instance Stack.Types.Config.HasPlatform Stack.Types.Config.BuildConfig
instance Stack.Types.Config.HasGHCVariant Stack.Types.Config.BuildConfig
instance Stack.Types.Config.HasConfig Stack.Types.Config.BuildConfig
instance Stack.Types.Config.HasBuildConfig Stack.Types.Config.BuildConfig
instance GHC.Base.Monoid Stack.Types.Config.ConfigMonoid
instance Data.Aeson.Types.Class.FromJSON (Stack.Types.Config.ConfigMonoid, [Data.Aeson.Extended.JSONWarning])
instance GHC.Show.Show Stack.Types.Config.ConfigException
instance GHC.Exception.Exception Stack.Types.Config.ConfigException
instance (warnings ~ [Data.Aeson.Extended.JSONWarning]) => Data.Aeson.Types.Class.FromJSON (Stack.Types.Config.ProjectAndConfigMonoid, warnings)
instance Data.Aeson.Types.Class.FromJSON Stack.Types.Config.SCM
instance Data.Aeson.Types.Class.ToJSON Stack.Types.Config.SCM
instance Data.Aeson.Types.Class.FromJSON Stack.Types.Config.GHCVariant
instance Data.Aeson.Types.Class.FromJSON (Stack.Types.Config.DownloadInfo, [Data.Aeson.Extended.JSONWarning])
instance Data.Aeson.Types.Class.FromJSON (Stack.Types.Config.VersionedDownloadInfo, [Data.Aeson.Extended.JSONWarning])
instance Data.Aeson.Types.Class.FromJSON (Stack.Types.Config.SetupInfo, [Data.Aeson.Extended.JSONWarning])
instance GHC.Base.Monoid Stack.Types.Config.SetupInfo
instance Data.Aeson.Types.Class.FromJSON (Stack.Types.Config.SetupInfoLocation, [Data.Aeson.Extended.JSONWarning])
instance Data.Aeson.Types.Class.ToJSON Stack.Types.Config.PvpBounds
instance Data.Aeson.Types.Class.FromJSON Stack.Types.Config.PvpBounds


-- | Constants used throughout the project.
module Stack.Constants

-- | The filename used for completed build indicators.
builtConfigFileFromDir :: (MonadThrow m, MonadReader env m, HasPlatform env, HasEnvConfig env) => Path Abs Dir -> m (Path Abs File)

-- | The filename used for completed build indicators.
builtFileFromDir :: (MonadThrow m, MonadReader env m, HasPlatform env, HasEnvConfig env) => Path Abs Dir -> m (Path Abs File)

-- | Path where build plans are stored.
buildPlanDir :: Path Abs Dir -> Path Abs Dir

-- | The filename used for completed configure indicators.
configuredFileFromDir :: (MonadThrow m, MonadReader env m, HasPlatform env, HasEnvConfig env) => Path Abs Dir -> m (Path Abs File)

-- | Default shake thread count for parallel builds.
defaultShakeThreads :: Int

-- | Package's build artifacts directory.
distDirFromDir :: (MonadThrow m, MonadReader env m, HasPlatform env, HasEnvConfig env) => Path Abs Dir -> m (Path Abs Dir)

-- | Relative location of build artifacts.
distRelativeDir :: (MonadThrow m, MonadReader env m, HasPlatform env, HasEnvConfig env) => m (Path Rel Dir)

-- | Extensions for anything that can be a Haskell module.
haskellModuleExts :: [Text]

-- | Image staging dir from project root.
imageStagingDir :: (MonadReader env m, HasConfig env) => Path Abs Dir -> m (Path Abs Dir)

-- | Docker sandbox from project root.
projectDockerSandboxDir :: (MonadReader env m, HasConfig env) => Path Abs Dir -> m (Path Abs Dir)

-- | Get a URL for a raw file on Github
rawGithubUrl :: Text -> Text -> Text -> Text -> Text

-- | The filename used for the stack config file.
stackDotYaml :: Path Rel File

-- | Environment variable used to override the '~/.stack' location.
stackRootEnvVar :: String

-- | User documentation directory.
userDocsDir :: Config -> Path Abs Dir

-- | The filename used for dirtiness check of config.
configCacheFile :: (MonadThrow m, MonadReader env m, HasPlatform env, HasEnvConfig env) => Path Abs Dir -> m (Path Abs File)

-- | The filename used for modification check of .cabal
configCabalMod :: (MonadThrow m, MonadReader env m, HasPlatform env, HasEnvConfig env) => Path Abs Dir -> m (Path Abs File)

-- | The filename used for dirtiness check of source files.
buildCacheFile :: (MonadThrow m, MonadReader env m, HasPlatform env, HasEnvConfig env) => Path Abs Dir -> m (Path Abs File)

-- | The filename used to mark tests as having succeeded
testSuccessFile :: (MonadThrow m, MonadReader env m, HasPlatform env, HasEnvConfig env) => Path Abs Dir -> m (Path Abs File)

-- | The filename used to mark tests as having built
testBuiltFile :: (MonadThrow m, MonadReader env m, HasPlatform env, HasEnvConfig env) => Path Abs Dir -> m (Path Abs File)

-- | The filename used to mark benchmarks as having built
benchBuiltFile :: (MonadThrow m, MonadReader env m, HasPlatform env, HasEnvConfig env) => Path Abs Dir -> m (Path Abs File)

-- | Name of the <tt>stack</tt> program.
stackProgName :: String

-- | Name of the <tt>stack</tt> program, uppercased
stackProgNameUpper :: String
wiredInPackages :: HashSet PackageName
ghcjsBootPackages :: HashSet PackageName

-- | Just to avoid repetition and magic strings.
cabalPackageName :: PackageName

-- | Deprecated implicit global project directory used when outside of a
--   project.
implicitGlobalProjectDirDeprecated :: Path Abs Dir -> Path Abs Dir

-- | Implicit global project directory used when outside of a project.
--   Normally, <tt>getImplicitGlobalProjectDir</tt> should be used instead.
implicitGlobalProjectDir :: Path Abs Dir -> Path Abs Dir

-- | Relative location of directory for HPC work.
hpcRelativeDir :: (MonadThrow m, MonadReader env m, HasPlatform env, HasEnvConfig env) => m (Path Rel Dir)

-- | Directory for HPC work.
hpcDirFromDir :: (MonadThrow m, MonadReader env m, HasPlatform env, HasEnvConfig env) => Path Abs Dir -> m (Path Abs Dir)

-- | Output .o/.hi directory.
objectInterfaceDir :: (MonadReader env m, HasConfig env) => BuildConfig -> m (Path Abs Dir)

-- | Directory for project templates.
templatesDir :: Config -> Path Abs Dir

-- | Deprecated default global config path.
defaultUserConfigPathDeprecated :: Path Abs Dir -> Path Abs File

-- | Default global config path. Normally,
--   <tt>getDefaultUserConfigPath</tt> should be used instead.
defaultUserConfigPath :: Path Abs Dir -> Path Abs File

-- | Deprecated default global config path. Note that this will be
--   <tt>Nothing</tt> on Windows, which is by design.
defaultGlobalConfigPathDeprecated :: Maybe (Path Abs File)

-- | Default global config path. Normally,
--   <tt>getDefaultGlobalConfigPath</tt> should be used instead. Note that
--   this will be <tt>Nothing</tt> on Windows, which is by design.
defaultGlobalConfigPath :: Maybe (Path Abs File)

-- | Environment variable that stores a variant to append to
--   platform-specific directory names. Used to ensure incompatible
--   binaries aren't shared between Docker builds and host
platformVariantEnvVar :: String


-- | Internal types to the library.
module Stack.Types.Internal

-- | Monadic environment.
data Env config
Env :: !config -> !LogLevel -> !Bool -> !Bool -> !Manager -> !Sticky -> !Bool -> Env config
[envConfig] :: Env config -> !config
[envLogLevel] :: Env config -> !LogLevel
[envTerminal] :: Env config -> !Bool
[envReExec] :: Env config -> !Bool
[envManager] :: Env config -> !Manager
[envSticky] :: Env config -> !Sticky
[envSupportsUnicode] :: Env config -> !Bool
class HasLogLevel r
getLogLevel :: HasLogLevel r => r -> LogLevel
class HasTerminal r
getTerminal :: HasTerminal r => r -> Bool
class HasReExec r
getReExec :: HasReExec r => r -> Bool
class HasSupportsUnicode r
getSupportsUnicode :: HasSupportsUnicode r => r -> Bool
newtype Sticky
Sticky :: Maybe (MVar (Maybe Text)) -> Sticky
[unSticky] :: Sticky -> Maybe (MVar (Maybe Text))
class HasSticky r
getSticky :: HasSticky r => r -> Sticky
instance Stack.Types.Config.HasStackRoot config => Stack.Types.Config.HasStackRoot (Stack.Types.Internal.Env config)
instance Stack.Types.Config.HasPlatform config => Stack.Types.Config.HasPlatform (Stack.Types.Internal.Env config)
instance Stack.Types.Config.HasGHCVariant config => Stack.Types.Config.HasGHCVariant (Stack.Types.Internal.Env config)
instance Stack.Types.Config.HasConfig config => Stack.Types.Config.HasConfig (Stack.Types.Internal.Env config)
instance Stack.Types.Config.HasBuildConfig config => Stack.Types.Config.HasBuildConfig (Stack.Types.Internal.Env config)
instance Stack.Types.Config.HasEnvConfig config => Stack.Types.Config.HasEnvConfig (Stack.Types.Internal.Env config)
instance Network.HTTP.Client.Types.HasHttpManager (Stack.Types.Internal.Env config)
instance Stack.Types.Internal.HasLogLevel (Stack.Types.Internal.Env config)
instance Stack.Types.Internal.HasLogLevel Control.Monad.Logger.LogLevel
instance Stack.Types.Internal.HasTerminal (Stack.Types.Internal.Env config)
instance Stack.Types.Internal.HasReExec (Stack.Types.Internal.Env config)
instance Stack.Types.Internal.HasSupportsUnicode (Stack.Types.Internal.Env config)
instance Stack.Types.Internal.HasSticky (Stack.Types.Internal.Env config)


-- | The monad used for the command-line executable <tt>stack</tt>.
module Stack.Types.StackT

-- | The monad used for the executable <tt>stack</tt>.
data StackT config m a

-- | The monad used for logging in the executable <tt>stack</tt> before
--   anything has been initialized.
data StackLoggingT m a

-- | Run a Stack action.
runStackT :: (MonadIO m, MonadBaseControl IO m) => Manager -> LogLevel -> config -> Bool -> Bool -> StackT config m a -> m a

-- | Run a Stack action, using global options.
runStackTGlobal :: (MonadIO m, MonadBaseControl IO m) => Manager -> config -> GlobalOpts -> StackT config m a -> m a

-- | Run the logging monad.
runStackLoggingT :: MonadIO m => Manager -> LogLevel -> Bool -> Bool -> StackLoggingT m a -> m a

-- | Run the logging monad, using global options.
runStackLoggingTGlobal :: MonadIO m => Manager -> GlobalOpts -> StackLoggingT m a -> m a
runInnerStackT :: (HasHttpManager r, HasLogLevel r, HasTerminal r, HasReExec r, MonadReader r m, MonadIO m) => config -> StackT config IO a -> m a
runInnerStackLoggingT :: (HasHttpManager r, HasLogLevel r, HasTerminal r, HasReExec r, MonadReader r m, MonadIO m) => StackLoggingT IO a -> m a

-- | Convenience for getting a <a>Manager</a>
newTLSManager :: MonadIO m => m Manager

-- | Write a "sticky" line to the terminal. Any subsequent lines will
--   overwrite this one, and that same line will be repeated below again.
--   In other words, the line sticks at the bottom of the output forever.
--   Running this function again will replace the sticky line with a new
--   sticky line. When you want to get rid of the sticky line, run
--   <a>logStickyDone</a>.
logSticky :: Q Exp

-- | This will print out the given message with a newline and disable any
--   further stickiness of the line until a new call to <a>logSticky</a>
--   happens.
--   
--   It might be better at some point to have a <tt>runSticky</tt> function
--   that encompasses the logSticky-&gt;logStickyDone pairing.
logStickyDone :: Q Exp
instance Control.Monad.Trans.Class.MonadTrans Stack.Types.StackT.StackLoggingT
instance Control.Monad.Catch.MonadMask m => Control.Monad.Catch.MonadMask (Stack.Types.StackT.StackLoggingT m)
instance Control.Monad.Catch.MonadCatch m => Control.Monad.Catch.MonadCatch (Stack.Types.StackT.StackLoggingT m)
instance GHC.Base.Monad m => Control.Monad.Reader.Class.MonadReader Stack.Types.StackT.LoggingEnv (Stack.Types.StackT.StackLoggingT m)
instance Control.Monad.Catch.MonadThrow m => Control.Monad.Catch.MonadThrow (Stack.Types.StackT.StackLoggingT m)
instance Control.Monad.IO.Class.MonadIO m => Control.Monad.IO.Class.MonadIO (Stack.Types.StackT.StackLoggingT m)
instance GHC.Base.Monad m => GHC.Base.Monad (Stack.Types.StackT.StackLoggingT m)
instance GHC.Base.Applicative m => GHC.Base.Applicative (Stack.Types.StackT.StackLoggingT m)
instance GHC.Base.Functor m => GHC.Base.Functor (Stack.Types.StackT.StackLoggingT m)
instance Control.Monad.Trans.Class.MonadTrans (Stack.Types.StackT.StackT config)
instance Control.Monad.Catch.MonadMask m => Control.Monad.Catch.MonadMask (Stack.Types.StackT.StackT config m)
instance Control.Monad.Catch.MonadCatch m => Control.Monad.Catch.MonadCatch (Stack.Types.StackT.StackT config m)
instance Control.Monad.Catch.MonadThrow m => Control.Monad.Catch.MonadThrow (Stack.Types.StackT.StackT config m)
instance GHC.Base.Monad m => Control.Monad.Reader.Class.MonadReader (Stack.Types.Internal.Env config) (Stack.Types.StackT.StackT config m)
instance Control.Monad.IO.Class.MonadIO m => Control.Monad.IO.Class.MonadIO (Stack.Types.StackT.StackT config m)
instance GHC.Base.Monad m => GHC.Base.Monad (Stack.Types.StackT.StackT config m)
instance GHC.Base.Applicative m => GHC.Base.Applicative (Stack.Types.StackT.StackT config m)
instance GHC.Base.Functor m => GHC.Base.Functor (Stack.Types.StackT.StackT config m)
instance Control.Monad.Base.MonadBase b m => Control.Monad.Base.MonadBase b (Stack.Types.StackT.StackT config m)
instance Control.Monad.Base.MonadBase b m => Control.Monad.Base.MonadBase b (Stack.Types.StackT.StackLoggingT m)
instance Control.Monad.Trans.Control.MonadBaseControl b m => Control.Monad.Trans.Control.MonadBaseControl b (Stack.Types.StackT.StackT config m)
instance Control.Monad.Trans.Control.MonadTransControl (Stack.Types.StackT.StackT config)
instance Control.Monad.IO.Class.MonadIO m => Control.Monad.Logger.MonadLogger (Stack.Types.StackT.StackT config m)
instance Control.Monad.Trans.Control.MonadBaseControl b m => Control.Monad.Trans.Control.MonadBaseControl b (Stack.Types.StackT.StackLoggingT m)
instance Control.Monad.Trans.Control.MonadTransControl Stack.Types.StackT.StackLoggingT
instance Control.Monad.IO.Class.MonadIO m => Control.Monad.Logger.MonadLogger (Stack.Types.StackT.StackLoggingT m)
instance Stack.Types.Internal.HasSticky Stack.Types.StackT.LoggingEnv
instance Stack.Types.Internal.HasLogLevel Stack.Types.StackT.LoggingEnv
instance Network.HTTP.Client.Types.HasHttpManager Stack.Types.StackT.LoggingEnv
instance Stack.Types.Internal.HasTerminal Stack.Types.StackT.LoggingEnv
instance Stack.Types.Internal.HasReExec Stack.Types.StackT.LoggingEnv
instance Stack.Types.Internal.HasSupportsUnicode Stack.Types.StackT.LoggingEnv


-- | Global sqlite database shared by all projects. Warning: this is
--   currently only accessible from <b>outside</b> a Docker container.
module Stack.Docker.GlobalDB

-- | Update last used time and project for a Docker image hash.
updateDockerImageLastUsed :: Config -> String -> FilePath -> IO ()

-- | Get a list of Docker image hashes and when they were last used.
getDockerImagesLastUsed :: Config -> IO [DockerImageLastUsed]

-- | Given a list of all existing Docker images, remove any that no longer
--   exist from the database.
pruneDockerImagesLastUsed :: Config -> [String] -> IO ()

-- | Date and project path where Docker image hash last used.
type DockerImageLastUsed = (String, [(UTCTime, FilePath)])
type DockerImageProjectId = Key DockerImageProject

-- | Get the record of whether an executable is compatible with a Docker
--   image
getDockerImageExe :: Config -> String -> FilePath -> UTCTime -> IO (Maybe Bool)

-- | Seet the record of whether an executable is compatible with a Docker
--   image
setDockerImageExe :: Config -> String -> FilePath -> UTCTime -> Bool -> IO ()
type DockerImageExeId = Key DockerImageExe
instance Data.Aeson.Types.Class.FromJSON (Database.Persist.Class.PersistEntity.Key Stack.Docker.GlobalDB.DockerImageProject)
instance Data.Aeson.Types.Class.ToJSON (Database.Persist.Class.PersistEntity.Key Stack.Docker.GlobalDB.DockerImageProject)
instance Database.Persist.Sql.Class.PersistFieldSql (Database.Persist.Class.PersistEntity.Key Stack.Docker.GlobalDB.DockerImageProject)
instance Database.Persist.Class.PersistField.PersistField (Database.Persist.Class.PersistEntity.Key Stack.Docker.GlobalDB.DockerImageProject)
instance Web.HttpApiData.Internal.FromHttpApiData (Database.Persist.Class.PersistEntity.Key Stack.Docker.GlobalDB.DockerImageProject)
instance Web.HttpApiData.Internal.ToHttpApiData (Database.Persist.Class.PersistEntity.Key Stack.Docker.GlobalDB.DockerImageProject)
instance Web.PathPieces.PathPiece (Database.Persist.Class.PersistEntity.Key Stack.Docker.GlobalDB.DockerImageProject)
instance GHC.Classes.Ord (Database.Persist.Class.PersistEntity.Key Stack.Docker.GlobalDB.DockerImageProject)
instance GHC.Classes.Eq (Database.Persist.Class.PersistEntity.Key Stack.Docker.GlobalDB.DockerImageProject)
instance GHC.Read.Read (Database.Persist.Class.PersistEntity.Key Stack.Docker.GlobalDB.DockerImageProject)
instance GHC.Show.Show (Database.Persist.Class.PersistEntity.Key Stack.Docker.GlobalDB.DockerImageProject)
instance Data.Aeson.Types.Class.FromJSON (Database.Persist.Class.PersistEntity.Key Stack.Docker.GlobalDB.DockerImageExe)
instance Data.Aeson.Types.Class.ToJSON (Database.Persist.Class.PersistEntity.Key Stack.Docker.GlobalDB.DockerImageExe)
instance Database.Persist.Sql.Class.PersistFieldSql (Database.Persist.Class.PersistEntity.Key Stack.Docker.GlobalDB.DockerImageExe)
instance Database.Persist.Class.PersistField.PersistField (Database.Persist.Class.PersistEntity.Key Stack.Docker.GlobalDB.DockerImageExe)
instance Web.HttpApiData.Internal.FromHttpApiData (Database.Persist.Class.PersistEntity.Key Stack.Docker.GlobalDB.DockerImageExe)
instance Web.HttpApiData.Internal.ToHttpApiData (Database.Persist.Class.PersistEntity.Key Stack.Docker.GlobalDB.DockerImageExe)
instance Web.PathPieces.PathPiece (Database.Persist.Class.PersistEntity.Key Stack.Docker.GlobalDB.DockerImageExe)
instance GHC.Classes.Ord (Database.Persist.Class.PersistEntity.Key Stack.Docker.GlobalDB.DockerImageExe)
instance GHC.Classes.Eq (Database.Persist.Class.PersistEntity.Key Stack.Docker.GlobalDB.DockerImageExe)
instance GHC.Read.Read (Database.Persist.Class.PersistEntity.Key Stack.Docker.GlobalDB.DockerImageExe)
instance GHC.Show.Show (Database.Persist.Class.PersistEntity.Key Stack.Docker.GlobalDB.DockerImageExe)
instance GHC.Show.Show Stack.Docker.GlobalDB.DockerImageExe
instance GHC.Show.Show Stack.Docker.GlobalDB.DockerImageProject
instance Database.Persist.Class.PersistField.PersistField Stack.Docker.GlobalDB.DockerImageProject
instance Database.Persist.Sql.Class.PersistFieldSql Stack.Docker.GlobalDB.DockerImageProject
instance Database.Persist.Class.PersistField.PersistField Stack.Docker.GlobalDB.DockerImageExe
instance Database.Persist.Sql.Class.PersistFieldSql Stack.Docker.GlobalDB.DockerImageExe
instance Database.Persist.Class.PersistEntity.PersistEntity Stack.Docker.GlobalDB.DockerImageProject
instance Database.Persist.Class.PersistStore.ToBackendKey Database.Persist.Sql.Types.SqlBackend Stack.Docker.GlobalDB.DockerImageProject
instance Database.Persist.Class.PersistEntity.PersistEntity Stack.Docker.GlobalDB.DockerImageExe
instance Database.Persist.Class.PersistStore.ToBackendKey Database.Persist.Sql.Types.SqlBackend Stack.Docker.GlobalDB.DockerImageExe


module Stack.Types.Package

-- | All exceptions thrown by the library.
data PackageException
PackageInvalidCabalFile :: (Maybe (Path Abs File)) -> PError -> PackageException
PackageNoCabalFileFound :: (Path Abs Dir) -> PackageException
PackageMultipleCabalFilesFound :: (Path Abs Dir) -> [Path Abs File] -> PackageException
MismatchedCabalName :: (Path Abs File) -> PackageName -> PackageException

-- | Some package info.
data Package
Package :: !PackageName -> !Version -> !GetPackageFiles -> !(Map PackageName VersionRange) -> ![Dependency] -> !(Set PackageName) -> !(Map FlagName Bool) -> !Bool -> !(Map Text TestSuiteInterface) -> !(Set Text) -> !(Set Text) -> !GetPackageOpts -> !Bool -> !Bool -> !(Set FlagName) -> Package

-- | Name of the package.
[packageName] :: Package -> !PackageName

-- | Version of the package
[packageVersion] :: Package -> !Version

-- | Get all files of the package.
[packageFiles] :: Package -> !GetPackageFiles

-- | Packages that the package depends on.
[packageDeps] :: Package -> !(Map PackageName VersionRange)

-- | A build tool name.
[packageTools] :: Package -> ![Dependency]

-- | Original dependencies (not sieved).
[packageAllDeps] :: Package -> !(Set PackageName)

-- | Flags used on package.
[packageFlags] :: Package -> !(Map FlagName Bool)

-- | does the package have a buildable library stanza?
[packageHasLibrary] :: Package -> !Bool

-- | names and interfaces of test suites
[packageTests] :: Package -> !(Map Text TestSuiteInterface)

-- | names of benchmarks
[packageBenchmarks] :: Package -> !(Set Text)

-- | names of executables
[packageExes] :: Package -> !(Set Text)

-- | Args to pass to GHC.
[packageOpts] :: Package -> !GetPackageOpts

-- | Does the package have exposed modules?
[packageHasExposedModules] :: Package -> !Bool

-- | Does the package of build-type: Simple
[packageSimpleType] :: Package -> !Bool

-- | All flags defined in the .cabal file
[packageDefinedFlags] :: Package -> !(Set FlagName)

-- | Files that the package depends on, relative to package directory.
--   Argument is the location of the .cabal file
newtype GetPackageOpts
GetPackageOpts :: (forall env m. (MonadIO m, HasEnvConfig env, HasPlatform env, MonadThrow m, MonadReader env m, MonadLogger m, MonadCatch m) => SourceMap -> InstalledMap -> [PackageName] -> Path Abs File -> m (Map NamedComponent (Set ModuleName), Map NamedComponent (Set DotCabalPath), Map NamedComponent BuildInfoOpts)) -> GetPackageOpts
[getPackageOpts] :: GetPackageOpts -> forall env m. (MonadIO m, HasEnvConfig env, HasPlatform env, MonadThrow m, MonadReader env m, MonadLogger m, MonadCatch m) => SourceMap -> InstalledMap -> [PackageName] -> Path Abs File -> m (Map NamedComponent (Set ModuleName), Map NamedComponent (Set DotCabalPath), Map NamedComponent BuildInfoOpts)

-- | GHC options based on cabal information and ghc-options.
data BuildInfoOpts
BuildInfoOpts :: [String] -> [String] -> Maybe (Path Abs File) -> BuildInfoOpts
[bioOpts] :: BuildInfoOpts -> [String]

-- | These options can safely have <tt>nubOrd</tt> applied to them, as
--   there are no multi-word options (see
--   <a>https://github.com/commercialhaskell/stack/issues/1255)</a>
[bioOneWordOpts] :: BuildInfoOpts -> [String]
[bioCabalMacros] :: BuildInfoOpts -> Maybe (Path Abs File)

-- | Files to get for a cabal package.
data CabalFileType
AllFiles :: CabalFileType
Modules :: CabalFileType

-- | Files that the package depends on, relative to package directory.
--   Argument is the location of the .cabal file
newtype GetPackageFiles
GetPackageFiles :: (forall m env. (MonadIO m, MonadLogger m, MonadThrow m, MonadCatch m, MonadReader env m, HasPlatform env, HasEnvConfig env) => Path Abs File -> m (Map NamedComponent (Set ModuleName), Map NamedComponent (Set DotCabalPath), Set (Path Abs File), [PackageWarning])) -> GetPackageFiles
[getPackageFiles] :: GetPackageFiles -> forall m env. (MonadIO m, MonadLogger m, MonadThrow m, MonadCatch m, MonadReader env m, HasPlatform env, HasEnvConfig env) => Path Abs File -> m (Map NamedComponent (Set ModuleName), Map NamedComponent (Set DotCabalPath), Set (Path Abs File), [PackageWarning])

-- | Warning generated when reading a package
data PackageWarning

-- | Modules found that are not listed in cabal file
UnlistedModulesWarning :: (Path Abs File) -> (Maybe String) -> [ModuleName] -> PackageWarning

-- | Package build configuration
data PackageConfig
PackageConfig :: !Bool -> !Bool -> !(Map FlagName Bool) -> !CompilerVersion -> !Platform -> PackageConfig

-- | Are tests enabled?
[packageConfigEnableTests] :: PackageConfig -> !Bool

-- | Are benchmarks enabled?
[packageConfigEnableBenchmarks] :: PackageConfig -> !Bool

-- | Package config flags.
[packageConfigFlags] :: PackageConfig -> !(Map FlagName Bool)

-- | GHC version
[packageConfigCompilerVersion] :: PackageConfig -> !CompilerVersion

-- | host platform
[packageConfigPlatform] :: PackageConfig -> !Platform

-- | Compares the package name.

-- | Compares the package name.
type SourceMap = Map PackageName PackageSource

-- | Where the package's source is located: local directory or package
--   index
data PackageSource
PSLocal :: LocalPackage -> PackageSource

-- | Upstream packages could be installed in either local or snapshot
--   databases; this is what <a>InstallLocation</a> specifies.
PSUpstream :: Version -> InstallLocation -> (Map FlagName Bool) -> PackageSource

-- | Datatype which tells how which version of a package to install and
--   where to install it into
class PackageInstallInfo a
piiVersion :: PackageInstallInfo a => a -> Version
piiLocation :: PackageInstallInfo a => a -> InstallLocation

-- | Information on a locally available package of source code
data LocalPackage
LocalPackage :: !Package -> !(Set NamedComponent) -> !(Set NamedComponent) -> !Bool -> !(Map PackageName VersionRange) -> !(Map PackageName VersionRange) -> !(Maybe Package) -> !(Path Abs Dir) -> !(Path Abs File) -> !(Maybe (Set FilePath)) -> !(Map FilePath FileCacheInfo) -> !(Set (Path Abs File)) -> LocalPackage

-- | The <tt>Package</tt> info itself, after resolution with package flags,
--   with tests and benchmarks disabled
[lpPackage] :: LocalPackage -> !Package

-- | Components to build, not including the library component.
[lpComponents] :: LocalPackage -> !(Set NamedComponent)

-- | Components explicitly requested for build, that are marked "buildable:
--   false".
[lpUnbuildable] :: LocalPackage -> !(Set NamedComponent)

-- | Whether this package is wanted as a target.
[lpWanted] :: LocalPackage -> !Bool

-- | Used for determining if we can use --enable-tests in a normal build.
[lpTestDeps] :: LocalPackage -> !(Map PackageName VersionRange)

-- | Used for determining if we can use --enable-benchmarks in a normal
--   build.
[lpBenchDeps] :: LocalPackage -> !(Map PackageName VersionRange)

-- | This stores the <a>Package</a> with tests and benchmarks enabled, if
--   either is asked for by the user.
[lpTestBench] :: LocalPackage -> !(Maybe Package)

-- | Directory of the package.
[lpDir] :: LocalPackage -> !(Path Abs Dir)

-- | The .cabal file
[lpCabalFile] :: LocalPackage -> !(Path Abs File)

-- | Nothing == not dirty, Just == dirty. Note that the Set may be empty if
--   we forced the build to treat packages as dirty. Also, the Set may not
--   include all modified files.
[lpDirtyFiles] :: LocalPackage -> !(Maybe (Set FilePath))

-- | current state of the files
[lpNewBuildCache] :: LocalPackage -> !(Map FilePath FileCacheInfo)

-- | all files used by this package
[lpFiles] :: LocalPackage -> !(Set (Path Abs File))

-- | A single, fully resolved component of a package
data NamedComponent
CLib :: NamedComponent
CExe :: !Text -> NamedComponent
CTest :: !Text -> NamedComponent
CBench :: !Text -> NamedComponent
renderComponent :: NamedComponent -> ByteString
renderPkgComponents :: [(PackageName, NamedComponent)] -> Text
renderPkgComponent :: (PackageName, NamedComponent) -> Text
exeComponents :: Set NamedComponent -> Set Text
testComponents :: Set NamedComponent -> Set Text
benchComponents :: Set NamedComponent -> Set Text
isCLib :: NamedComponent -> Bool
isCExe :: NamedComponent -> Bool
isCTest :: NamedComponent -> Bool
isCBench :: NamedComponent -> Bool

-- | A location to install a package into, either snapshot or local
data InstallLocation
Snap :: InstallLocation
Local :: InstallLocation
data InstalledPackageLocation
InstalledTo :: InstallLocation -> InstalledPackageLocation
ExtraGlobal :: InstalledPackageLocation
data FileCacheInfo
FileCacheInfo :: !ModTime -> !Word64 -> !ByteString -> FileCacheInfo
[fciModTime] :: FileCacheInfo -> !ModTime
[fciSize] :: FileCacheInfo -> !Word64
[fciHash] :: FileCacheInfo -> !ByteString

-- | Used for storage and comparison.
newtype ModTime
ModTime :: (Integer, Rational) -> ModTime

-- | A descriptor from a .cabal file indicating one of the following:
--   
--   exposed-modules: Foo other-modules: Foo or main-is: Foo.hs
data DotCabalDescriptor
DotCabalModule :: !ModuleName -> DotCabalDescriptor
DotCabalMain :: !FilePath -> DotCabalDescriptor
DotCabalFile :: !FilePath -> DotCabalDescriptor
DotCabalCFile :: !FilePath -> DotCabalDescriptor

-- | Maybe get the module name from the .cabal descriptor.
dotCabalModule :: DotCabalDescriptor -> Maybe ModuleName

-- | Maybe get the main name from the .cabal descriptor.
dotCabalMain :: DotCabalDescriptor -> Maybe FilePath

-- | A path resolved from the .cabal file, which is either main-is or an
--   exposed<i>internal</i>referenced module.
data DotCabalPath
DotCabalModulePath :: !(Path Abs File) -> DotCabalPath
DotCabalMainPath :: !(Path Abs File) -> DotCabalPath
DotCabalFilePath :: !(Path Abs File) -> DotCabalPath
DotCabalCFilePath :: !(Path Abs File) -> DotCabalPath

-- | Get the module path.
dotCabalModulePath :: DotCabalPath -> Maybe (Path Abs File)

-- | Get the main path.
dotCabalMainPath :: DotCabalPath -> Maybe (Path Abs File)

-- | Get the c file path.
dotCabalCFilePath :: DotCabalPath -> Maybe (Path Abs File)

-- | Get the path.
dotCabalGetPath :: DotCabalPath -> Path Abs File
type InstalledMap = Map PackageName (InstallLocation, Installed)
data Installed
Library :: PackageIdentifier -> GhcPkgId -> Installed
Executable :: PackageIdentifier -> Installed

-- | Get the installed Version.
installedVersion :: Installed -> Version
instance GHC.Generics.Selector Stack.Types.Package.S1_0_2FileCacheInfo
instance GHC.Generics.Selector Stack.Types.Package.S1_0_1FileCacheInfo
instance GHC.Generics.Selector Stack.Types.Package.S1_0_0FileCacheInfo
instance GHC.Generics.Constructor Stack.Types.Package.C1_0FileCacheInfo
instance GHC.Generics.Datatype Stack.Types.Package.D1FileCacheInfo
instance GHC.Generics.Constructor Stack.Types.Package.C1_0ModTime
instance GHC.Generics.Datatype Stack.Types.Package.D1ModTime
instance GHC.Show.Show Stack.Types.Package.Package
instance GHC.Show.Show Stack.Types.Package.LocalPackage
instance GHC.Show.Show Stack.Types.Package.PackageSource
instance GHC.Classes.Ord Stack.Types.Package.Installed
instance GHC.Classes.Eq Stack.Types.Package.Installed
instance GHC.Show.Show Stack.Types.Package.Installed
instance GHC.Show.Show Stack.Types.Package.DotCabalPath
instance GHC.Classes.Ord Stack.Types.Package.DotCabalPath
instance GHC.Classes.Eq Stack.Types.Package.DotCabalPath
instance GHC.Show.Show Stack.Types.Package.DotCabalDescriptor
instance GHC.Classes.Ord Stack.Types.Package.DotCabalDescriptor
instance GHC.Classes.Eq Stack.Types.Package.DotCabalDescriptor
instance GHC.Show.Show Stack.Types.Package.FileCacheInfo
instance GHC.Generics.Generic Stack.Types.Package.FileCacheInfo
instance Data.Binary.Class.Binary Stack.Types.Package.ModTime
instance Control.DeepSeq.NFData Stack.Types.Package.ModTime
instance GHC.Classes.Eq Stack.Types.Package.ModTime
instance GHC.Generics.Generic Stack.Types.Package.ModTime
instance GHC.Show.Show Stack.Types.Package.ModTime
instance GHC.Classes.Ord Stack.Types.Package.ModTime
instance GHC.Classes.Eq Stack.Types.Package.InstalledPackageLocation
instance GHC.Show.Show Stack.Types.Package.InstalledPackageLocation
instance GHC.Classes.Eq Stack.Types.Package.InstallLocation
instance GHC.Show.Show Stack.Types.Package.InstallLocation
instance GHC.Classes.Ord Stack.Types.Package.NamedComponent
instance GHC.Classes.Eq Stack.Types.Package.NamedComponent
instance GHC.Show.Show Stack.Types.Package.NamedComponent
instance GHC.Show.Show Stack.Types.Package.PackageConfig
instance GHC.Show.Show Stack.Types.Package.BuildInfoOpts
instance GHC.Exception.Exception Stack.Types.Package.PackageException
instance GHC.Show.Show Stack.Types.Package.PackageException
instance GHC.Show.Show Stack.Types.Package.GetPackageOpts
instance GHC.Show.Show Stack.Types.Package.GetPackageFiles
instance GHC.Show.Show Stack.Types.Package.PackageWarning
instance GHC.Classes.Ord Stack.Types.Package.Package
instance GHC.Classes.Eq Stack.Types.Package.Package
instance Stack.Types.Package.PackageInstallInfo Stack.Types.Package.PackageSource
instance GHC.Base.Monoid Stack.Types.Package.InstallLocation
instance Data.Binary.Class.Binary Stack.Types.Package.FileCacheInfo
instance Data.Binary.Tagged.HasStructuralInfo Stack.Types.Package.FileCacheInfo
instance Control.DeepSeq.NFData Stack.Types.Package.FileCacheInfo
instance Data.Binary.Tagged.HasStructuralInfo Stack.Types.Package.ModTime
instance Data.Binary.Tagged.HasSemanticVersion Stack.Types.Package.ModTime


-- | Build-specific types.
module Stack.Types.Build
data StackBuildException
Couldn'tFindPkgId :: PackageName -> StackBuildException

-- | Path to the stack.yaml file
CompilerVersionMismatch :: (Maybe (CompilerVersion, Arch)) -> (CompilerVersion, Arch) -> GHCVariant -> VersionCheck -> (Maybe (Path Abs File)) -> Text -> StackBuildException
Couldn'tParseTargets :: [Text] -> StackBuildException
UnknownTargets :: (Set PackageName) -> (Map PackageName Version) -> (Path Abs File) -> StackBuildException
TestSuiteFailure :: PackageIdentifier -> (Map Text (Maybe ExitCode)) -> (Maybe (Path Abs File)) -> ByteString -> StackBuildException
TestSuiteTypeUnsupported :: TestSuiteInterface -> StackBuildException
ConstructPlanExceptions :: [ConstructPlanException] -> (Path Abs File) -> StackBuildException
CabalExitedUnsuccessfully :: ExitCode -> PackageIdentifier -> (Path Abs File) -> [String] -> (Maybe (Path Abs File)) -> [ByteString] -> StackBuildException
ExecutionFailure :: [SomeException] -> StackBuildException
LocalPackageDoesn'tMatchTarget :: PackageName -> Version -> Version -> StackBuildException
NoSetupHsFound :: (Path Abs Dir) -> StackBuildException
InvalidFlagSpecification :: (Set UnusedFlags) -> StackBuildException
TargetParseException :: [Text] -> StackBuildException
DuplicateLocalPackageNames :: [(PackageName, [Path Abs Dir])] -> StackBuildException
SolverMissingCabalInstall :: StackBuildException
SolverMissingGHC :: StackBuildException
SolverNoCabalFiles :: StackBuildException
SomeTargetsNotBuildable :: [(PackageName, NamedComponent)] -> StackBuildException
data FlagSource
FSCommandLine :: FlagSource
FSStackYaml :: FlagSource
data UnusedFlags
UFNoPackage :: FlagSource -> PackageName -> UnusedFlags
UFFlagsNotDefined :: FlagSource -> Package -> (Set FlagName) -> UnusedFlags
UFSnapshot :: PackageName -> UnusedFlags

-- | A location to install a package into, either snapshot or local
data InstallLocation
Snap :: InstallLocation
Local :: InstallLocation

-- | Used for storage and comparison.
data ModTime

-- | One-way conversion to serialized time.
modTime :: UTCTime -> ModTime
data Installed
Library :: PackageIdentifier -> GhcPkgId -> Installed
Executable :: PackageIdentifier -> Installed

-- | Datatype which tells how which version of a package to install and
--   where to install it into
class PackageInstallInfo a
piiVersion :: PackageInstallInfo a => a -> Version
piiLocation :: PackageInstallInfo a => a -> InstallLocation

-- | A task to perform when building
data Task
Task :: !PackageIdentifier -> !TaskType -> !TaskConfigOpts -> !(Map PackageIdentifier GhcPkgId) -> !Bool -> Task

-- | the package/version to be built
[taskProvides] :: Task -> !PackageIdentifier

-- | the task type, telling us how to build this
[taskType] :: Task -> !TaskType
[taskConfigOpts] :: Task -> !TaskConfigOpts

-- | GhcPkgIds of already-installed dependencies
[taskPresent] :: Task -> !(Map PackageIdentifier GhcPkgId)

-- | indicates that the package can be built in one step
[taskAllInOne] :: Task -> !Bool
taskLocation :: Task -> InstallLocation

-- | Information on a locally available package of source code
data LocalPackage
LocalPackage :: !Package -> !(Set NamedComponent) -> !(Set NamedComponent) -> !Bool -> !(Map PackageName VersionRange) -> !(Map PackageName VersionRange) -> !(Maybe Package) -> !(Path Abs Dir) -> !(Path Abs File) -> !(Maybe (Set FilePath)) -> !(Map FilePath FileCacheInfo) -> !(Set (Path Abs File)) -> LocalPackage

-- | The <tt>Package</tt> info itself, after resolution with package flags,
--   with tests and benchmarks disabled
[lpPackage] :: LocalPackage -> !Package

-- | Components to build, not including the library component.
[lpComponents] :: LocalPackage -> !(Set NamedComponent)

-- | Components explicitly requested for build, that are marked "buildable:
--   false".
[lpUnbuildable] :: LocalPackage -> !(Set NamedComponent)

-- | Whether this package is wanted as a target.
[lpWanted] :: LocalPackage -> !Bool

-- | Used for determining if we can use --enable-tests in a normal build.
[lpTestDeps] :: LocalPackage -> !(Map PackageName VersionRange)

-- | Used for determining if we can use --enable-benchmarks in a normal
--   build.
[lpBenchDeps] :: LocalPackage -> !(Map PackageName VersionRange)

-- | This stores the <a>Package</a> with tests and benchmarks enabled, if
--   either is asked for by the user.
[lpTestBench] :: LocalPackage -> !(Maybe Package)

-- | Directory of the package.
[lpDir] :: LocalPackage -> !(Path Abs Dir)

-- | The .cabal file
[lpCabalFile] :: LocalPackage -> !(Path Abs File)

-- | Nothing == not dirty, Just == dirty. Note that the Set may be empty if
--   we forced the build to treat packages as dirty. Also, the Set may not
--   include all modified files.
[lpDirtyFiles] :: LocalPackage -> !(Maybe (Set FilePath))

-- | current state of the files
[lpNewBuildCache] :: LocalPackage -> !(Map FilePath FileCacheInfo)

-- | all files used by this package
[lpFiles] :: LocalPackage -> !(Set (Path Abs File))

-- | Basic information used to calculate what the configure options are
data BaseConfigOpts
BaseConfigOpts :: !(Path Abs Dir) -> !(Path Abs Dir) -> !(Path Abs Dir) -> !(Path Abs Dir) -> !BuildOpts -> ![(Path Abs Dir)] -> BaseConfigOpts
[bcoSnapDB] :: BaseConfigOpts -> !(Path Abs Dir)
[bcoLocalDB] :: BaseConfigOpts -> !(Path Abs Dir)
[bcoSnapInstallRoot] :: BaseConfigOpts -> !(Path Abs Dir)
[bcoLocalInstallRoot] :: BaseConfigOpts -> !(Path Abs Dir)
[bcoBuildOpts] :: BaseConfigOpts -> !BuildOpts
[bcoExtraDBs] :: BaseConfigOpts -> ![(Path Abs Dir)]

-- | A complete plan of what needs to be built and how to do it
data Plan
Plan :: !(Map PackageName Task) -> !(Map PackageName Task) -> !(Map GhcPkgId (PackageIdentifier, Maybe Text)) -> !(Map Text InstallLocation) -> Plan
[planTasks] :: Plan -> !(Map PackageName Task)

-- | Final actions to be taken (test, benchmark, etc)
[planFinals] :: Plan -> !(Map PackageName Task)

-- | Text is reason we're unregistering, for display only
[planUnregisterLocal] :: Plan -> !(Map GhcPkgId (PackageIdentifier, Maybe Text))

-- | Executables that should be installed after successful building
[planInstallExes] :: Plan -> !(Map Text InstallLocation)

-- | Options for the <tt>FinalAction</tt> <tt>DoTests</tt>
data TestOpts
TestOpts :: !Bool -> ![String] -> !Bool -> !Bool -> TestOpts

-- | Whether successful tests will be run gain
[toRerunTests] :: TestOpts -> !Bool

-- | Arguments passed to the test program
[toAdditionalArgs] :: TestOpts -> ![String]

-- | Generate a code coverage report
[toCoverage] :: TestOpts -> !Bool

-- | Disable running of tests
[toDisableRun] :: TestOpts -> !Bool

-- | Options for the <tt>FinalAction</tt> <tt>DoBenchmarks</tt>
data BenchmarkOpts
BenchmarkOpts :: !(Maybe String) -> !Bool -> BenchmarkOpts

-- | Arguments passed to the benchmark program
[beoAdditionalArgs] :: BenchmarkOpts -> !(Maybe String)

-- | Disable running of benchmarks
[beoDisableRun] :: BenchmarkOpts -> !Bool
data FileWatchOpts
NoFileWatch :: FileWatchOpts
FileWatch :: FileWatchOpts
FileWatchPoll :: FileWatchOpts

-- | Configuration for building.
data BuildOpts
BuildOpts :: ![Text] -> !Bool -> !Bool -> !Bool -> !(Maybe Bool) -> !Bool -> ![Text] -> !(Map (Maybe PackageName) (Map FlagName Bool)) -> !Bool -> !Bool -> !BuildSubset -> !FileWatchOpts -> !(Maybe Bool) -> !Bool -> !Bool -> !TestOpts -> !Bool -> !BenchmarkOpts -> ![(String, [String])] -> !Bool -> !Bool -> !Bool -> BuildOpts
[boptsTargets] :: BuildOpts -> ![Text]
[boptsLibProfile] :: BuildOpts -> !Bool
[boptsExeProfile] :: BuildOpts -> !Bool

-- | Build haddocks?
[boptsHaddock] :: BuildOpts -> !Bool

-- | Build haddocks for dependencies?
[boptsHaddockDeps] :: BuildOpts -> !(Maybe Bool)
[boptsDryrun] :: BuildOpts -> !Bool
[boptsGhcOptions] :: BuildOpts -> ![Text]
[boptsFlags] :: BuildOpts -> !(Map (Maybe PackageName) (Map FlagName Bool))

-- | Install executables to user path after building?
[boptsInstallExes] :: BuildOpts -> !Bool

-- | Fetch all packages immediately
[boptsPreFetch] :: BuildOpts -> !Bool
[boptsBuildSubset] :: BuildOpts -> !BuildSubset

-- | Watch files for changes and automatically rebuild
[boptsFileWatch] :: BuildOpts -> !FileWatchOpts

-- | Keep building/running after failure
[boptsKeepGoing] :: BuildOpts -> !(Maybe Bool)

-- | Force treating all local packages as having dirty files
[boptsForceDirty] :: BuildOpts -> !Bool

-- | Turn on tests for local targets
[boptsTests] :: BuildOpts -> !Bool

-- | Additional test arguments
[boptsTestOpts] :: BuildOpts -> !TestOpts

-- | Turn on benchmarks for local targets
[boptsBenchmarks] :: BuildOpts -> !Bool

-- | Additional test arguments
[boptsBenchmarkOpts] :: BuildOpts -> !BenchmarkOpts

-- | Commands (with arguments) to run after a successful build
[boptsExec] :: BuildOpts -> ![(String, [String])]

-- | Only perform the configure step when building
[boptsOnlyConfigure] :: BuildOpts -> !Bool

-- | Perform the configure step even if already configured
[boptsReconfigure] :: BuildOpts -> !Bool

-- | Ask Cabal to be verbose in its builds
[boptsCabalVerbose] :: BuildOpts -> !Bool

-- | Which subset of packages to build
data BuildSubset
BSAll :: BuildSubset

-- | Only install packages in the snapshot database, skipping packages
--   intended for the local database.
BSOnlySnapshot :: BuildSubset
BSOnlyDependencies :: BuildSubset
defaultBuildOpts :: BuildOpts

-- | The type of a task, either building local code or something from the
--   package index (upstream)
data TaskType
TTLocal :: LocalPackage -> TaskType
TTUpstream :: Package -> InstallLocation -> TaskType

-- | Given the IDs of any missing packages, produce the configure options
data TaskConfigOpts
TaskConfigOpts :: !(Set PackageIdentifier) -> !(Map PackageIdentifier GhcPkgId -> ConfigureOpts) -> TaskConfigOpts

-- | Dependencies for which we don't yet have an GhcPkgId
[tcoMissing] :: TaskConfigOpts -> !(Set PackageIdentifier)

-- | Produce the list of options given the missing <tt>GhcPkgId</tt>s
[tcoOpts] :: TaskConfigOpts -> !(Map PackageIdentifier GhcPkgId -> ConfigureOpts)

-- | Stored on disk to know whether the flags have changed or any files
--   have changed.
data ConfigCache
ConfigCache :: !ConfigureOpts -> !(Set GhcPkgId) -> !(Set ByteString) -> !Bool -> ConfigCache

-- | All options used for this package.
[configCacheOpts] :: ConfigCache -> !ConfigureOpts

-- | The GhcPkgIds of all of the dependencies. Since Cabal doesn't take the
--   complete GhcPkgId (only a PackageIdentifier) in the configure options,
--   just using the previous value is insufficient to know if dependencies
--   have changed.
[configCacheDeps] :: ConfigCache -> !(Set GhcPkgId)

-- | The components to be built. It's a bit of a hack to include this in
--   here, as it's not a configure option (just a build option), but this
--   is a convenient way to force compilation when the components change.
[configCacheComponents] :: ConfigCache -> !(Set ByteString)

-- | Are haddocks to be built?
[configCacheHaddock] :: ConfigCache -> !Bool
data ConstructPlanException
DependencyCycleDetected :: [PackageName] -> ConstructPlanException
DependencyPlanFailures :: PackageIdentifier -> (Map PackageName (VersionRange, LatestApplicableVersion, BadDependency)) -> ConstructPlanException

-- | Recommend adding to extra-deps, give a helpful version number?
UnknownPackage :: PackageName -> ConstructPlanException

-- | Render a <tt>BaseConfigOpts</tt> to an actual list of options
configureOpts :: EnvConfig -> BaseConfigOpts -> Map PackageIdentifier GhcPkgId -> Bool -> Bool -> InstallLocation -> Package -> ConfigureOpts

-- | Reason why a dependency was not used
data BadDependency
NotInBuildPlan :: BadDependency
Couldn'tResolveItsDependencies :: BadDependency
DependencyMismatch :: Version -> BadDependency

-- | Get set of wanted package names from locals.
wantedLocalPackages :: [LocalPackage] -> Set PackageName
data FileCacheInfo
FileCacheInfo :: !ModTime -> !Word64 -> !ByteString -> FileCacheInfo
[fciModTime] :: FileCacheInfo -> !ModTime
[fciSize] :: FileCacheInfo -> !Word64
[fciHash] :: FileCacheInfo -> !ByteString

-- | Configure options to be sent to Setup.hs configure
data ConfigureOpts
ConfigureOpts :: ![String] -> ![String] -> ConfigureOpts

-- | Options related to various paths. We separate these out since they do
--   not have an impact on the contents of the compiled binary for checking
--   if we can use an existing precompiled cache.
[coDirs] :: ConfigureOpts -> ![String]
[coNoDirs] :: ConfigureOpts -> ![String]

-- | Information on a compiled package: the library conf file (if
--   relevant), and all of the executable paths.
data PrecompiledCache
PrecompiledCache :: !(Maybe FilePath) -> ![FilePath] -> PrecompiledCache

-- | .conf file inside the package database
[pcLibrary] :: PrecompiledCache -> !(Maybe FilePath)

-- | Full paths to executables
[pcExes] :: PrecompiledCache -> ![FilePath]
instance GHC.Generics.Selector Stack.Types.Build.S1_0_1PrecompiledCache
instance GHC.Generics.Selector Stack.Types.Build.S1_0_0PrecompiledCache
instance GHC.Generics.Constructor Stack.Types.Build.C1_0PrecompiledCache
instance GHC.Generics.Datatype Stack.Types.Build.D1PrecompiledCache
instance GHC.Generics.Selector Stack.Types.Build.S1_0_3ConfigCache
instance GHC.Generics.Selector Stack.Types.Build.S1_0_2ConfigCache
instance GHC.Generics.Selector Stack.Types.Build.S1_0_1ConfigCache
instance GHC.Generics.Selector Stack.Types.Build.S1_0_0ConfigCache
instance GHC.Generics.Constructor Stack.Types.Build.C1_0ConfigCache
instance GHC.Generics.Datatype Stack.Types.Build.D1ConfigCache
instance GHC.Generics.Selector Stack.Types.Build.S1_0_1ConfigureOpts
instance GHC.Generics.Selector Stack.Types.Build.S1_0_0ConfigureOpts
instance GHC.Generics.Constructor Stack.Types.Build.C1_0ConfigureOpts
instance GHC.Generics.Datatype Stack.Types.Build.D1ConfigureOpts
instance GHC.Generics.Generic Stack.Types.Build.PrecompiledCache
instance GHC.Classes.Eq Stack.Types.Build.PrecompiledCache
instance GHC.Show.Show Stack.Types.Build.PrecompiledCache
instance GHC.Show.Show Stack.Types.Build.ConfigCache
instance GHC.Classes.Eq Stack.Types.Build.ConfigCache
instance GHC.Generics.Generic Stack.Types.Build.ConfigCache
instance GHC.Show.Show Stack.Types.Build.Plan
instance GHC.Show.Show Stack.Types.Build.Task
instance GHC.Generics.Generic Stack.Types.Build.ConfigureOpts
instance GHC.Classes.Eq Stack.Types.Build.ConfigureOpts
instance GHC.Show.Show Stack.Types.Build.ConfigureOpts
instance GHC.Show.Show Stack.Types.Build.TaskType
instance Control.DeepSeq.NFData Stack.Types.Build.PkgDepsOracle
instance Data.Binary.Class.Binary Stack.Types.Build.PkgDepsOracle
instance Data.Hashable.Class.Hashable Stack.Types.Build.PkgDepsOracle
instance GHC.Classes.Eq Stack.Types.Build.PkgDepsOracle
instance GHC.Show.Show Stack.Types.Build.PkgDepsOracle
instance GHC.Show.Show Stack.Types.Build.BuildOpts
instance GHC.Classes.Eq Stack.Types.Build.FileWatchOpts
instance GHC.Show.Show Stack.Types.Build.FileWatchOpts
instance GHC.Show.Show Stack.Types.Build.BenchmarkOpts
instance GHC.Classes.Eq Stack.Types.Build.BenchmarkOpts
instance GHC.Show.Show Stack.Types.Build.TestOpts
instance GHC.Classes.Eq Stack.Types.Build.TestOpts
instance GHC.Classes.Eq Stack.Types.Build.BuildSubset
instance GHC.Show.Show Stack.Types.Build.BuildSubset
instance GHC.Classes.Eq Stack.Types.Build.ConstructPlanException
instance GHC.Classes.Eq Stack.Types.Build.BadDependency
instance GHC.Classes.Ord Stack.Types.Build.UnusedFlags
instance GHC.Classes.Eq Stack.Types.Build.UnusedFlags
instance GHC.Show.Show Stack.Types.Build.UnusedFlags
instance GHC.Classes.Ord Stack.Types.Build.FlagSource
instance GHC.Classes.Eq Stack.Types.Build.FlagSource
instance GHC.Show.Show Stack.Types.Build.FlagSource
instance GHC.Show.Show Stack.Types.Build.StackBuildException
instance GHC.Exception.Exception Stack.Types.Build.StackBuildException
instance GHC.Show.Show Stack.Types.Build.ConstructPlanException
instance Data.Binary.Class.Binary Stack.Types.Build.ConfigCache
instance Control.DeepSeq.NFData Stack.Types.Build.ConfigCache
instance Data.Binary.Tagged.HasStructuralInfo Stack.Types.Build.ConfigCache
instance Data.Binary.Tagged.HasSemanticVersion Stack.Types.Build.ConfigCache
instance GHC.Show.Show Stack.Types.Build.TaskConfigOpts
instance Data.Binary.Class.Binary Stack.Types.Build.ConfigureOpts
instance Data.Binary.Tagged.HasStructuralInfo Stack.Types.Build.ConfigureOpts
instance Control.DeepSeq.NFData Stack.Types.Build.ConfigureOpts
instance Data.Binary.Class.Binary Stack.Types.Build.PrecompiledCache
instance Data.Binary.Tagged.HasSemanticVersion Stack.Types.Build.PrecompiledCache
instance Data.Binary.Tagged.HasStructuralInfo Stack.Types.Build.PrecompiledCache
instance Control.DeepSeq.NFData Stack.Types.Build.PrecompiledCache


-- | All types.
module Stack.Types


-- | Parsing command line targets
module Stack.Build.Target

-- | The name of a component, which applies to executables, test suites,
--   and benchmarks
type ComponentName = Text

-- | Either a fully resolved component, or a component name that could be
--   either an executable, test, or benchmark
data UnresolvedComponent
ResolvedComponent :: !NamedComponent -> UnresolvedComponent
UnresolvedComponent :: !ComponentName -> UnresolvedComponent

-- | Raw command line input, without checking against any databases or list
--   of locals. Does not deal with directories
data RawTarget (a :: RawTargetType)
RTPackageComponent :: !PackageName -> !UnresolvedComponent -> RawTarget a
RTComponent :: !ComponentName -> RawTarget a
RTPackage :: !PackageName -> RawTarget a
RTPackageIdentifier :: !PackageIdentifier -> RawTarget HasIdents

-- | A view of a local package needed for resolving components
data LocalPackageView
LocalPackageView :: !Version -> !(Path Abs Dir) -> !(Path Abs File) -> !(Set NamedComponent) -> !Bool -> LocalPackageView
[lpvVersion] :: LocalPackageView -> !Version
[lpvRoot] :: LocalPackageView -> !(Path Abs Dir)
[lpvCabalFP] :: LocalPackageView -> !(Path Abs File)
[lpvComponents] :: LocalPackageView -> !(Set NamedComponent)
[lpvExtraDep] :: LocalPackageView -> !Bool
data SimpleTarget
STUnknown :: SimpleTarget
STNonLocal :: SimpleTarget
STLocalComps :: !(Set NamedComponent) -> SimpleTarget
STLocalAll :: SimpleTarget

-- | Need targets, e.g. `stack build` or allow none?
data NeedTargets
NeedTargets :: NeedTargets
AllowNoTargets :: NeedTargets

-- | If this function returns <tt>Nothing</tt>, the input should be treated
--   as a directory.
parseRawTarget :: Text -> Maybe (RawTarget HasIdents)
parseTargets :: (MonadThrow m, MonadIO m) => NeedTargets -> Bool -> Map PackageName Version -> Map PackageName Version -> Map PackageName LocalPackageView -> Path Abs Dir -> [Text] -> m (Map PackageName Version, Map PackageName SimpleTarget)
instance GHC.Classes.Ord Stack.Build.Target.SimpleTarget
instance GHC.Classes.Eq Stack.Build.Target.SimpleTarget
instance GHC.Show.Show Stack.Build.Target.SimpleTarget
instance GHC.Classes.Ord Stack.Build.Target.UnresolvedComponent
instance GHC.Classes.Eq Stack.Build.Target.UnresolvedComponent
instance GHC.Show.Show Stack.Build.Target.UnresolvedComponent
instance GHC.Show.Show (Stack.Build.Target.RawTarget a)
instance GHC.Classes.Eq (Stack.Build.Target.RawTarget a)
instance GHC.Classes.Ord (Stack.Build.Target.RawTarget a)


-- | Docker configuration
module Stack.Config.Docker

-- | Interprets DockerOptsMonoid options.
dockerOptsFromMonoid :: MonadThrow m => Maybe Project -> Path Abs Dir -> Maybe AbstractResolver -> DockerOptsMonoid -> m DockerOpts

-- | Exceptions thrown by Stack.Docker.Config.
data StackDockerConfigException

-- | Only LTS resolvers are supported for default image tag.
ResolverNotSupportedException :: String -> StackDockerConfigException

-- | Invalid global database path.
InvalidDatabasePathException :: SomeException -> StackDockerConfigException

-- | Exception instance for StackDockerConfigException.

-- | Show instance for StackDockerConfigException.
instance GHC.Exception.Exception Stack.Config.Docker.StackDockerConfigException
instance GHC.Show.Show Stack.Config.Docker.StackDockerConfigException


-- | Nix configuration
module Stack.Config.Nix

-- | Interprets NixOptsMonoid options.
nixOptsFromMonoid :: (Monad m, MonadCatch m) => Maybe Project -> Path Abs Dir -> NixOptsMonoid -> m NixOpts
data StackNixException

-- | Nix can't be given packages and a shell file at the same time
NixCannotUseShellFileAndPackagesException :: StackNixException
instance GHC.Exception.Exception Stack.Config.Nix.StackNixException
instance GHC.Show.Show Stack.Config.Nix.StackNixException


-- | This module builds Docker (OpenContainer) images.
module Stack.Image

-- | Stages the executables &amp; additional content in a staging directory
--   under '.stack-work'
stageContainerImageArtifacts :: Build e m => m ()

-- | Builds a Docker (OpenContainer) image extending the <tt>base</tt>
--   image specified in the project's stack.yaml. Then new image will be
--   extended with an ENTRYPOINT specified for each <tt>entrypoint</tt>
--   listed in the config file.
createContainerImageFromStage :: Assemble e m => m ()

-- | The command name for dealing with images.
imgCmdName :: String

-- | The command name for building a docker container.
imgDockerCmdName :: String

-- | Convert image opts monoid to image options.
imgOptsFromMonoid :: ImageOptsMonoid -> ImageOpts

-- | Convert Docker image opts monoid to Docker image options.
imgDockerOptsFromMonoid :: ImageDockerOptsMonoid -> ImageDockerOpts

-- | A parser for ImageOptsMonoid.
imgOptsParser :: Parser ImageOptsMonoid

-- | A parser for ImageDockerOptsMonoid.
imgDockerOptsParser :: Parser ImageDockerOptsMonoid
instance GHC.Exception.Exception Stack.Image.StackImageException
instance GHC.Show.Show Stack.Image.StackImageException


-- | Dealing with the 00-index file and all its cabal files.
module Stack.PackageIndex

-- | Update all of the package indices
updateAllIndices :: (MonadIO m, MonadLogger m, MonadThrow m, MonadReader env m, HasHttpManager env, HasConfig env, MonadBaseControl IO m, MonadCatch m) => EnvOverride -> m ()

-- | Load the cached package URLs, or created the cache if necessary.
getPackageCaches :: (MonadIO m, MonadLogger m, MonadReader env m, HasConfig env, MonadThrow m, HasHttpManager env, MonadBaseControl IO m, MonadCatch m) => EnvOverride -> m (Map PackageIdentifier (PackageIndex, PackageCache))
instance GHC.Exception.Exception Stack.PackageIndex.PackageIndexException
instance GHC.Show.Show Stack.PackageIndex.PackageIndexException


-- | Functions for the GHC package database.
module Stack.GhcPkg

-- | Get the global package database
getGlobalDB :: (MonadIO m, MonadLogger m, MonadBaseControl IO m, MonadCatch m, MonadThrow m) => EnvOverride -> WhichCompiler -> m (Path Abs Dir)

-- | Override the environment received by a child process.
data EnvOverride

-- | Helper conversion function.
envHelper :: EnvOverride -> Maybe [(String, String)]

-- | Create a package database in the given directory, if it doesn't exist.
createDatabase :: (MonadIO m, MonadLogger m, MonadBaseControl IO m, MonadCatch m, MonadThrow m) => EnvOverride -> WhichCompiler -> Path Abs Dir -> m ()
unregisterGhcPkgId :: (MonadIO m, MonadLogger m, MonadThrow m, MonadCatch m, MonadBaseControl IO m) => EnvOverride -> WhichCompiler -> CompilerVersion -> Path Abs Dir -> GhcPkgId -> PackageIdentifier -> m ()

-- | Get the version of Cabal from the global package database.
getCabalPkgVer :: (MonadThrow m, MonadIO m, MonadLogger m, MonadBaseControl IO m, MonadCatch m) => EnvOverride -> WhichCompiler -> m Version

-- | Get the name to use for "ghc-pkg", given the compiler version.
ghcPkgExeName :: WhichCompiler -> String

-- | Get the value for GHC_PACKAGE_PATH
mkGhcPackagePath :: Bool -> Path Abs Dir -> Path Abs Dir -> [Path Abs Dir] -> Path Abs Dir -> Text


-- | Functionality for downloading packages securely for cabal's usage.
module Stack.Fetch

-- | Intended to work for the command line command.
unpackPackages :: (MonadIO m, MonadBaseControl IO m, MonadReader env m, HasHttpManager env, HasConfig env, MonadThrow m, MonadLogger m, MonadCatch m) => EnvOverride -> FilePath -> [String] -> m ()

-- | Ensure that all of the given package idents are unpacked into the
--   build unpack directory, and return the paths to all of the
--   subdirectories.
unpackPackageIdents :: (MonadBaseControl IO m, MonadIO m, MonadReader env m, HasHttpManager env, HasConfig env, MonadThrow m, MonadLogger m, MonadCatch m) => EnvOverride -> Path Abs Dir -> Maybe (Path Rel Dir) -> Set PackageIdentifier -> m (Map PackageIdentifier (Path Abs Dir))

-- | Fetch packages into the cache without unpacking
fetchPackages :: (MonadIO m, MonadBaseControl IO m, MonadReader env m, HasHttpManager env, HasConfig env, MonadThrow m, MonadLogger m, MonadCatch m) => EnvOverride -> Set PackageIdentifier -> m ()

-- | Resolve a set of package names and identifiers into
--   <tt>FetchPackage</tt> values.
resolvePackages :: (MonadIO m, MonadReader env m, HasHttpManager env, HasConfig env, MonadLogger m, MonadBaseControl IO m, MonadCatch m) => EnvOverride -> Set PackageIdentifier -> Set PackageName -> m (Map PackageIdentifier ResolvedPackage)
resolvePackagesAllowMissing :: (MonadIO m, MonadReader env m, HasHttpManager env, HasConfig env, MonadLogger m, MonadThrow m, MonadBaseControl IO m, MonadCatch m) => EnvOverride -> Set PackageIdentifier -> Set PackageName -> m (Set PackageName, Set PackageIdentifier, Map PackageIdentifier ResolvedPackage)
data ResolvedPackage
ResolvedPackage :: !PackageCache -> !PackageIndex -> ResolvedPackage
[rpCache] :: ResolvedPackage -> !PackageCache
[rpIndex] :: ResolvedPackage -> !PackageIndex

-- | Add the cabal files to a list of idents with their caches.
withCabalFiles :: (MonadThrow m, MonadIO m, MonadReader env m, HasConfig env) => IndexName -> [(PackageIdentifier, PackageCache, a)] -> (PackageIdentifier -> a -> ByteString -> IO b) -> m [b]

-- | Provide a function which will load up a cabal <tt>ByteString</tt> from
--   the package indices.
withCabalLoader :: (MonadThrow m, MonadIO m, MonadReader env m, HasConfig env, MonadLogger m, HasHttpManager env, MonadBaseControl IO m, MonadCatch m) => EnvOverride -> ((PackageIdentifier -> IO ByteString) -> m a) -> m a
instance GHC.Exception.Exception Stack.Fetch.FetchException
instance GHC.Show.Show Stack.Fetch.FetchException


-- | Execute commands within the properly configured Stack environment.
module Stack.Exec

-- | Default <tt>EnvSettings</tt> which includes locals and
--   GHC_PACKAGE_PATH
defaultEnvSettings :: EnvSettings

-- | Environment settings which do not embellish the environment
plainEnvSettings :: EnvSettings

-- | Execute a process within the Stack configured environment.
exec :: (MonadIO m, MonadLogger m, MonadThrow m, MonadBaseControl IO m) => EnvOverride -> String -> [String] -> m b


-- | Create new a new project directory populated with a basic working
--   project.
module Stack.New

-- | Create a new project with the given options.
new :: (HasConfig r, MonadReader r m, MonadLogger m, MonadCatch m, MonadThrow m, MonadIO m, HasHttpManager r) => NewOpts -> m (Path Abs Dir)

-- | Options for creating a new project.
data NewOpts
NewOpts :: PackageName -> Bool -> TemplateName -> Map Text Text -> NewOpts

-- | Name of the project to create.
[newOptsProjectName] :: NewOpts -> PackageName

-- | Whether to create the project without a directory.
[newOptsCreateBare] :: NewOpts -> Bool

-- | Name of the template to use.
[newOptsTemplate] :: NewOpts -> TemplateName

-- | Nonce parameters specified just for this invocation.
[newOptsNonceParams] :: NewOpts -> Map Text Text

-- | The default template name you can use if you don't have one.
defaultTemplateName :: TemplateName

-- | An argument which accepts a template name of the format
--   <tt>foo.hsfiles</tt> or <tt>foo</tt>, ultimately normalized to
--   <tt>foo</tt>.
templateNameArgument :: Mod ArgumentFields TemplateName -> Parser TemplateName

-- | Get the set of templates.
getTemplates :: (MonadIO m, MonadThrow m, MonadReader r m, HasHttpManager r, MonadCatch m) => m (Set TemplateName)

-- | A template name.
data TemplateName
listTemplates :: (MonadIO m, MonadThrow m, MonadReader r m, HasHttpManager r, MonadCatch m, MonadLogger m) => m ()
instance GHC.Exception.Exception Stack.New.NewException
instance GHC.Show.Show Stack.New.NewException

module Stack.Setup.Installed
getCompilerVersion :: (MonadLogger m, MonadCatch m, MonadBaseControl IO m, MonadIO m) => EnvOverride -> WhichCompiler -> m CompilerVersion
markInstalled :: (MonadIO m, MonadReader env m, HasConfig env, MonadThrow m) => Path Abs Dir -> Tool -> m ()
unmarkInstalled :: (MonadIO m, MonadReader env m, HasConfig env, MonadThrow m) => Path Abs Dir -> Tool -> m ()
listInstalled :: (MonadIO m, MonadReader env m, HasConfig env, MonadThrow m) => Path Abs Dir -> m [Tool]
data Tool

-- | e.g. ghc-7.8.4, msys2-20150512
Tool :: PackageIdentifier -> Tool

-- | e.g. ghcjs-0.1.0_ghc-7.10.2
ToolGhcjs :: CompilerVersion -> Tool
toolString :: Tool -> String
toolNameString :: Tool -> String
parseToolText :: Text -> Maybe Tool
data ExtraDirs
ExtraDirs :: ![FilePath] -> ![FilePath] -> ![FilePath] -> ExtraDirs
[edBins] :: ExtraDirs -> ![FilePath]
[edInclude] :: ExtraDirs -> ![FilePath]
[edLib] :: ExtraDirs -> ![FilePath]

-- | Binary directories for the given installed package
extraDirs :: (MonadReader env m, HasConfig env, MonadThrow m, MonadLogger m) => Tool -> m ExtraDirs
installDir :: (MonadReader env m, HasConfig env, MonadThrow m, MonadLogger m) => Path Abs Dir -> Tool -> m (Path Abs Dir)
instance GHC.Base.Monoid Stack.Setup.Installed.ExtraDirs


module Stack.Sig.GPG

-- | Extract the full long <tt>fingerprint</tt> given a short (or long)
--   <tt>fingerprint</tt>
fullFingerprint :: (Monad m, MonadIO m, MonadThrow m) => Fingerprint -> m Fingerprint

-- | Sign a file path with GPG, returning the <tt>Signature</tt>.
signPackage :: (Monad m, MonadIO m, MonadThrow m) => Path Abs File -> m Signature

-- | Verify the <tt>Signature</tt> of a file path returning the
--   <tt>Fingerprint</tt>.
verifyFile :: (Monad m, MonadIO m, MonadThrow m) => Signature -> Path Abs File -> m Fingerprint


-- | Provide ability to upload tarballs to Hackage.
module Stack.Upload
nopUploader :: Config -> UploadSettings -> IO Uploader

-- | Turn the given settings into an <tt>Uploader</tt>.
--   
--   Since 0.1.0.0
mkUploader :: Config -> UploadSettings -> IO Uploader

-- | The computed value from a <tt>UploadSettings</tt>.
--   
--   Typically, you want to use this with <a>upload</a>.
--   
--   Since 0.1.0.0
data Uploader

-- | Upload a single tarball with the given <tt>Uploader</tt>.
--   
--   Since 0.1.0.0
upload :: Uploader -> FilePath -> IO ()

-- | Upload a single tarball with the given <tt>Uploader</tt>. Instead of
--   sending a file like <a>upload</a>, this sends a lazy bytestring.
--   
--   Since 0.1.2.1
uploadBytes :: Uploader -> String -> ByteString -> IO ()

-- | Settings for creating an <tt>Uploader</tt>.
--   
--   Since 0.1.0.0
data UploadSettings

-- | Default value for <tt>UploadSettings</tt>.
--   
--   Use setter functions to change defaults.
--   
--   Since 0.1.0.0
defaultUploadSettings :: UploadSettings

-- | Change the upload URL.
--   
--   Default: "<a>https://hackage.haskell.org/packages/"</a>
--   
--   Since 0.1.0.0
setUploadUrl :: String -> UploadSettings -> UploadSettings

-- | How to get an HTTP connection manager.
--   
--   Default: <tt>newManager tlsManagerSettings</tt>
--   
--   Since 0.1.0.0
setGetManager :: IO Manager -> UploadSettings -> UploadSettings

-- | How to get the Hackage credentials.
--   
--   Default: <tt>fromAnywhere</tt>
--   
--   Since 0.1.0.0
setCredsSource :: (Config -> HackageCredsSource) -> UploadSettings -> UploadSettings

-- | Save new credentials to the config file.
--   
--   Default: <tt>True</tt>
--   
--   Since 0.1.0.0
setSaveCreds :: Bool -> UploadSettings -> UploadSettings

-- | Username and password to log into Hackage.
--   
--   Since 0.1.0.0
data HackageCreds

-- | Load Hackage credentials from the given source.
--   
--   Since 0.1.0.0
loadCreds :: HackageCredsSource -> IO (HackageCreds, FromFile)

-- | Save the given credentials to the credentials file.
--   
--   Since 0.1.0.0
saveCreds :: Config -> HackageCreds -> IO ()

-- | Whether the Hackage credentials were loaded from a file.
--   
--   This information is useful since, typically, you only want to save the
--   credentials to a file if it wasn't already loaded from there.
--   
--   Since 0.1.0.0
type FromFile = Bool

-- | A source for getting Hackage credentials.
--   
--   Since 0.1.0.0
data HackageCredsSource

-- | Try to load the credentials from the config file. If that fails, ask
--   the user to enter them.
--   
--   Since 0.1.0.0
fromAnywhere :: Config -> HackageCredsSource

-- | Load the Hackage credentials from the prompt, asking the user to type
--   them in.
--   
--   Since 0.1.0.0
fromPrompt :: HackageCredsSource

-- | Load the Hackage credentials from the JSON config file.
--   
--   Since 0.1.0.0
fromFile :: Config -> HackageCredsSource

-- | Load the Hackage credentials from the given arguments.
--   
--   Since 0.1.0.0
fromMemory :: Text -> Text -> HackageCredsSource
instance GHC.Show.Show Stack.Upload.HackageCredsExceptions
instance GHC.Show.Show Stack.Upload.HackageCreds
instance Data.Aeson.Types.Class.ToJSON Stack.Upload.HackageCreds
instance Data.Aeson.Types.Class.FromJSON Stack.Upload.HackageCreds
instance GHC.Exception.Exception Stack.Upload.HackageCredsExceptions


-- | Cache information about previous builds
module Stack.Build.Cache

-- | Try to read the dirtiness cache for the given package directory.
tryGetBuildCache :: (MonadIO m, MonadReader env m, HasConfig env, MonadThrow m, MonadLogger m, HasEnvConfig env) => Path Abs Dir -> m (Maybe (Map FilePath FileCacheInfo))

-- | Try to read the dirtiness cache for the given package directory.
tryGetConfigCache :: (MonadIO m, MonadReader env m, HasConfig env, MonadThrow m, MonadLogger m, HasEnvConfig env) => Path Abs Dir -> m (Maybe ConfigCache)

-- | Try to read the mod time of the cabal file from the last build
tryGetCabalMod :: (MonadIO m, MonadReader env m, HasConfig env, MonadThrow m, MonadLogger m, HasEnvConfig env) => Path Abs Dir -> m (Maybe ModTime)

-- | Get all of the installed executables
getInstalledExes :: (MonadReader env m, HasEnvConfig env, MonadIO m, MonadThrow m) => InstallLocation -> m [PackageIdentifier]

-- | Modification times of files.
buildCacheTimes :: BuildCache -> (Map FilePath FileCacheInfo)

-- | Loads the flag cache for the given installed extra-deps
tryGetFlagCache :: (MonadIO m, MonadThrow m, MonadReader env m, HasEnvConfig env) => Installed -> m (Maybe ConfigCache)

-- | Delete the caches for the project.
deleteCaches :: (MonadIO m, MonadReader env m, HasConfig env, MonadLogger m, MonadThrow m, HasEnvConfig env) => Path Abs Dir -> m ()

-- | Mark the given executable as installed
markExeInstalled :: (MonadReader env m, HasEnvConfig env, MonadIO m, MonadThrow m) => InstallLocation -> PackageIdentifier -> m ()

-- | Mark the given executable as not installed
markExeNotInstalled :: (MonadReader env m, HasEnvConfig env, MonadIO m, MonadThrow m) => InstallLocation -> PackageIdentifier -> m ()
writeFlagCache :: (MonadIO m, MonadReader env m, HasEnvConfig env, MonadThrow m) => Installed -> ConfigCache -> m ()

-- | Write the dirtiness cache for this package's files.
writeBuildCache :: (MonadIO m, MonadReader env m, HasConfig env, MonadThrow m, MonadLogger m, HasEnvConfig env) => Path Abs Dir -> Map FilePath FileCacheInfo -> m ()

-- | Write the dirtiness cache for this package's configuration.
writeConfigCache :: (MonadIO m, MonadReader env m, HasConfig env, MonadThrow m, MonadLogger m, HasEnvConfig env) => Path Abs Dir -> ConfigCache -> m ()

-- | See <a>tryGetCabalMod</a>
writeCabalMod :: (MonadIO m, MonadReader env m, HasConfig env, MonadThrow m, MonadLogger m, HasEnvConfig env) => Path Abs Dir -> ModTime -> m ()

-- | Mark a test suite as having succeeded
setTestSuccess :: (MonadIO m, MonadLogger m, MonadThrow m, MonadReader env m, HasConfig env, HasEnvConfig env) => Path Abs Dir -> m ()

-- | Mark a test suite as not having succeeded
unsetTestSuccess :: (MonadIO m, MonadLogger m, MonadThrow m, MonadReader env m, HasConfig env, HasEnvConfig env) => Path Abs Dir -> m ()

-- | Check if the test suite already passed
checkTestSuccess :: (MonadIO m, MonadLogger m, MonadThrow m, MonadReader env m, HasConfig env, HasEnvConfig env) => Path Abs Dir -> m Bool

-- | Write out information about a newly built package
writePrecompiledCache :: (MonadThrow m, MonadReader env m, HasEnvConfig env, MonadIO m) => BaseConfigOpts -> PackageIdentifier -> ConfigureOpts -> Set GhcPkgId -> Installed -> Set Text -> m ()

-- | Check the cache for a precompiled package matching the given
--   configuration.
readPrecompiledCache :: (MonadThrow m, MonadReader env m, HasEnvConfig env, MonadIO m) => PackageIdentifier -> ConfigureOpts -> Set GhcPkgId -> m (Maybe PrecompiledCache)
instance GHC.Generics.Selector Stack.Build.Cache.S1_0_0BuildCache
instance GHC.Generics.Constructor Stack.Build.Cache.C1_0BuildCache
instance GHC.Generics.Datatype Stack.Build.Cache.D1BuildCache
instance GHC.Generics.Generic Stack.Build.Cache.BuildCache
instance Data.Binary.Class.Binary Stack.Build.Cache.BuildCache
instance Data.Binary.Tagged.HasStructuralInfo Stack.Build.Cache.BuildCache
instance Data.Binary.Tagged.HasSemanticVersion Stack.Build.Cache.BuildCache
instance Control.DeepSeq.NFData Stack.Build.Cache.BuildCache

module Stack.PackageDump

-- | A single line of input, not including line endings
type Line = ByteString

-- | Apply the given Sink to each section of output, broken by a single
--   line containing ---
eachSection :: Monad m => Sink Line m a -> Conduit ByteString m a

-- | Grab each key/value pair
eachPair :: Monad m => (ByteString -> Sink Line m a) -> Conduit Line m a

-- | Dump information for a single package
data DumpPackage profiling haddock
DumpPackage :: !GhcPkgId -> !PackageIdentifier -> ![FilePath] -> ![ByteString] -> !Bool -> ![GhcPkgId] -> ![FilePath] -> !(Maybe FilePath) -> !profiling -> !haddock -> !Bool -> DumpPackage profiling haddock
[dpGhcPkgId] :: DumpPackage profiling haddock -> !GhcPkgId
[dpPackageIdent] :: DumpPackage profiling haddock -> !PackageIdentifier
[dpLibDirs] :: DumpPackage profiling haddock -> ![FilePath]
[dpLibraries] :: DumpPackage profiling haddock -> ![ByteString]
[dpHasExposedModules] :: DumpPackage profiling haddock -> !Bool
[dpDepends] :: DumpPackage profiling haddock -> ![GhcPkgId]
[dpHaddockInterfaces] :: DumpPackage profiling haddock -> ![FilePath]
[dpHaddockHtml] :: DumpPackage profiling haddock -> !(Maybe FilePath)
[dpProfiling] :: DumpPackage profiling haddock -> !profiling
[dpHaddock] :: DumpPackage profiling haddock -> !haddock
[dpIsExposed] :: DumpPackage profiling haddock -> !Bool

-- | Convert a stream of bytes into a stream of <tt>DumpPackage</tt>s
conduitDumpPackage :: MonadThrow m => Conduit ByteString m (DumpPackage () ())

-- | Call ghc-pkg dump with appropriate flags and stream to the given
--   <tt>Sink</tt>, for a single database
ghcPkgDump :: (MonadIO m, MonadLogger m, MonadBaseControl IO m, MonadCatch m, MonadThrow m) => EnvOverride -> WhichCompiler -> [Path Abs Dir] -> Sink ByteString IO a -> m a

-- | Call ghc-pkg describe with appropriate flags and stream to the given
--   <tt>Sink</tt>, for a single database
ghcPkgDescribe :: (MonadIO m, MonadLogger m, MonadBaseControl IO m, MonadCatch m, MonadThrow m) => PackageName -> EnvOverride -> WhichCompiler -> [Path Abs Dir] -> Sink ByteString IO a -> m a

-- | Cached information on whether package have profiling libraries and
--   haddocks.
data InstalledCache

-- | Cached information on whether a package has profiling libraries and
--   haddocks.
data InstalledCacheEntry
InstalledCacheEntry :: !Bool -> !Bool -> !PackageIdentifier -> InstalledCacheEntry
[installedCacheProfiling] :: InstalledCacheEntry -> !Bool
[installedCacheHaddock] :: InstalledCacheEntry -> !Bool
[installedCacheIdent] :: InstalledCacheEntry -> !PackageIdentifier

-- | Create a new, empty <tt>InstalledCache</tt>
newInstalledCache :: MonadIO m => m InstalledCache

-- | Load a <tt>InstalledCache</tt> from disk, swallowing any errors and
--   returning an empty cache.
loadInstalledCache :: (MonadLogger m, MonadIO m) => Path Abs File -> m InstalledCache

-- | Save a <tt>InstalledCache</tt> to disk
saveInstalledCache :: MonadIO m => Path Abs File -> InstalledCache -> m ()

-- | Add profiling information to the stream of <tt>DumpPackage</tt>s
addProfiling :: MonadIO m => InstalledCache -> Conduit (DumpPackage a b) m (DumpPackage Bool b)

-- | Add haddock information to the stream of <tt>DumpPackage</tt>s
addHaddock :: MonadIO m => InstalledCache -> Conduit (DumpPackage a b) m (DumpPackage a Bool)

-- | Find the package IDs matching the given constraints with all
--   dependencies installed. Packages not mentioned in the provided
--   <tt>Map</tt> are allowed to be present too.
sinkMatching :: Monad m => Bool -> Bool -> Map PackageName Version -> Consumer (DumpPackage Bool Bool) m (Map PackageName (DumpPackage Bool Bool))

-- | Prune a list of possible packages down to those whose dependencies are
--   met.
--   
--   <ul>
--   <li>id uniquely identifies an item</li>
--   <li>There can be multiple items per name</li>
--   </ul>
pruneDeps :: (Ord name, Ord id) => (id -> name) -> (item -> id) -> (item -> [id]) -> (item -> item -> item) -> [item] -> Map name item
instance GHC.Generics.Constructor Stack.PackageDump.C1_0InstalledCacheInner
instance GHC.Generics.Datatype Stack.PackageDump.D1InstalledCacheInner
instance GHC.Generics.Selector Stack.PackageDump.S1_0_2InstalledCacheEntry
instance GHC.Generics.Selector Stack.PackageDump.S1_0_1InstalledCacheEntry
instance GHC.Generics.Selector Stack.PackageDump.S1_0_0InstalledCacheEntry
instance GHC.Generics.Constructor Stack.PackageDump.C1_0InstalledCacheEntry
instance GHC.Generics.Datatype Stack.PackageDump.D1InstalledCacheEntry
instance (GHC.Classes.Ord profiling, GHC.Classes.Ord haddock) => GHC.Classes.Ord (Stack.PackageDump.DumpPackage profiling haddock)
instance (GHC.Classes.Eq profiling, GHC.Classes.Eq haddock) => GHC.Classes.Eq (Stack.PackageDump.DumpPackage profiling haddock)
instance (GHC.Show.Show profiling, GHC.Show.Show haddock) => GHC.Show.Show (Stack.PackageDump.DumpPackage profiling haddock)
instance GHC.Generics.Generic Stack.PackageDump.InstalledCacheInner
instance Control.DeepSeq.NFData Stack.PackageDump.InstalledCacheInner
instance Data.Binary.Class.Binary Stack.PackageDump.InstalledCacheInner
instance GHC.Generics.Generic Stack.PackageDump.InstalledCacheEntry
instance GHC.Classes.Eq Stack.PackageDump.InstalledCacheEntry
instance Data.Binary.Tagged.HasStructuralInfo Stack.PackageDump.InstalledCacheInner
instance Data.Binary.Tagged.HasSemanticVersion Stack.PackageDump.InstalledCacheInner
instance Data.Binary.Class.Binary Stack.PackageDump.InstalledCacheEntry
instance Data.Binary.Tagged.HasStructuralInfo Stack.PackageDump.InstalledCacheEntry
instance Control.DeepSeq.NFData Stack.PackageDump.InstalledCacheEntry
instance GHC.Exception.Exception Stack.PackageDump.PackageDumpException
instance GHC.Show.Show Stack.PackageDump.PackageDumpException

module Stack.Build.Installed
type InstalledMap = Map PackageName (InstallLocation, Installed)
data Installed
Library :: PackageIdentifier -> GhcPkgId -> Installed
Executable :: PackageIdentifier -> Installed

-- | Options for <a>getInstalled</a>.
data GetInstalledOpts
GetInstalledOpts :: !Bool -> !Bool -> GetInstalledOpts

-- | Require profiling libraries?
[getInstalledProfiling] :: GetInstalledOpts -> !Bool

-- | Require haddocks?
[getInstalledHaddock] :: GetInstalledOpts -> !Bool

-- | Returns the new InstalledMap and all of the locally registered
--   packages.
getInstalled :: (M env m, PackageInstallInfo pii) => EnvOverride -> GetInstalledOpts -> Map PackageName pii -> m (InstalledMap, [DumpPackage () ()], [DumpPackage () ()], [DumpPackage () ()])
instance GHC.Show.Show Stack.Build.Installed.LoadHelper
instance GHC.Show.Show Stack.Build.Installed.Allowed
instance GHC.Classes.Eq Stack.Build.Installed.Allowed


-- | Dealing with Cabal.
module Stack.Package

-- | Reads and exposes the package information
readPackage :: (MonadLogger m, MonadIO m, MonadThrow m, MonadCatch m) => PackageConfig -> Path Abs File -> m ([PWarning], Package)

-- | Reads and exposes the package information, from a ByteString
readPackageBS :: (MonadThrow m) => PackageConfig -> ByteString -> m ([PWarning], Package)

-- | Get <a>GenericPackageDescription</a> and <a>PackageDescription</a>
--   reading info from given directory.
readPackageDescriptionDir :: (MonadLogger m, MonadIO m, MonadThrow m, MonadCatch m) => PackageConfig -> Path Abs Dir -> m (GenericPackageDescription, PackageDescription)

-- | Read the raw, unresolved package information.
readPackageUnresolved :: (MonadIO m, MonadThrow m) => Path Abs File -> m ([PWarning], GenericPackageDescription)

-- | Read the raw, unresolved package information from a ByteString.
readPackageUnresolvedBS :: (MonadThrow m) => Maybe (Path Abs File) -> ByteString -> m ([PWarning], GenericPackageDescription)

-- | Resolve a parsed cabal file into a <a>Package</a>.
resolvePackage :: PackageConfig -> GenericPackageDescription -> Package

-- | Get the filename for the cabal file in the given directory.
--   
--   If no .cabal file is present, or more than one is present, an
--   exception is thrown via <a>throwM</a>.
getCabalFileName :: (MonadThrow m, MonadIO m) => Path Abs Dir -> m (Path Abs File)

-- | Some package info.
data Package
Package :: !PackageName -> !Version -> !GetPackageFiles -> !(Map PackageName VersionRange) -> ![Dependency] -> !(Set PackageName) -> !(Map FlagName Bool) -> !Bool -> !(Map Text TestSuiteInterface) -> !(Set Text) -> !(Set Text) -> !GetPackageOpts -> !Bool -> !Bool -> !(Set FlagName) -> Package

-- | Name of the package.
[packageName] :: Package -> !PackageName

-- | Version of the package
[packageVersion] :: Package -> !Version

-- | Get all files of the package.
[packageFiles] :: Package -> !GetPackageFiles

-- | Packages that the package depends on.
[packageDeps] :: Package -> !(Map PackageName VersionRange)

-- | A build tool name.
[packageTools] :: Package -> ![Dependency]

-- | Original dependencies (not sieved).
[packageAllDeps] :: Package -> !(Set PackageName)

-- | Flags used on package.
[packageFlags] :: Package -> !(Map FlagName Bool)

-- | does the package have a buildable library stanza?
[packageHasLibrary] :: Package -> !Bool

-- | names and interfaces of test suites
[packageTests] :: Package -> !(Map Text TestSuiteInterface)

-- | names of benchmarks
[packageBenchmarks] :: Package -> !(Set Text)

-- | names of executables
[packageExes] :: Package -> !(Set Text)

-- | Args to pass to GHC.
[packageOpts] :: Package -> !GetPackageOpts

-- | Does the package have exposed modules?
[packageHasExposedModules] :: Package -> !Bool

-- | Does the package of build-type: Simple
[packageSimpleType] :: Package -> !Bool

-- | All flags defined in the .cabal file
[packageDefinedFlags] :: Package -> !(Set FlagName)

-- | Files that the package depends on, relative to package directory.
--   Argument is the location of the .cabal file
newtype GetPackageFiles
GetPackageFiles :: (forall m env. (MonadIO m, MonadLogger m, MonadThrow m, MonadCatch m, MonadReader env m, HasPlatform env, HasEnvConfig env) => Path Abs File -> m (Map NamedComponent (Set ModuleName), Map NamedComponent (Set DotCabalPath), Set (Path Abs File), [PackageWarning])) -> GetPackageFiles
[getPackageFiles] :: GetPackageFiles -> forall m env. (MonadIO m, MonadLogger m, MonadThrow m, MonadCatch m, MonadReader env m, HasPlatform env, HasEnvConfig env) => Path Abs File -> m (Map NamedComponent (Set ModuleName), Map NamedComponent (Set DotCabalPath), Set (Path Abs File), [PackageWarning])

-- | Files that the package depends on, relative to package directory.
--   Argument is the location of the .cabal file
newtype GetPackageOpts
GetPackageOpts :: (forall env m. (MonadIO m, HasEnvConfig env, HasPlatform env, MonadThrow m, MonadReader env m, MonadLogger m, MonadCatch m) => SourceMap -> InstalledMap -> [PackageName] -> Path Abs File -> m (Map NamedComponent (Set ModuleName), Map NamedComponent (Set DotCabalPath), Map NamedComponent BuildInfoOpts)) -> GetPackageOpts
[getPackageOpts] :: GetPackageOpts -> forall env m. (MonadIO m, HasEnvConfig env, HasPlatform env, MonadThrow m, MonadReader env m, MonadLogger m, MonadCatch m) => SourceMap -> InstalledMap -> [PackageName] -> Path Abs File -> m (Map NamedComponent (Set ModuleName), Map NamedComponent (Set DotCabalPath), Map NamedComponent BuildInfoOpts)

-- | Package build configuration
data PackageConfig
PackageConfig :: !Bool -> !Bool -> !(Map FlagName Bool) -> !CompilerVersion -> !Platform -> PackageConfig

-- | Are tests enabled?
[packageConfigEnableTests] :: PackageConfig -> !Bool

-- | Are benchmarks enabled?
[packageConfigEnableBenchmarks] :: PackageConfig -> !Bool

-- | Package config flags.
[packageConfigFlags] :: PackageConfig -> !(Map FlagName Bool)

-- | GHC version
[packageConfigCompilerVersion] :: PackageConfig -> !CompilerVersion

-- | host platform
[packageConfigPlatform] :: PackageConfig -> !Platform

-- | Path for the package's build log.
buildLogPath :: (MonadReader env m, HasBuildConfig env, MonadThrow m) => Package -> Maybe String -> m (Path Abs File)

-- | All exceptions thrown by the library.
data PackageException
PackageInvalidCabalFile :: (Maybe (Path Abs File)) -> PError -> PackageException
PackageNoCabalFileFound :: (Path Abs Dir) -> PackageException
PackageMultipleCabalFilesFound :: (Path Abs Dir) -> [Path Abs File] -> PackageException
MismatchedCabalName :: (Path Abs File) -> PackageName -> PackageException

-- | Get all dependencies of a package, including library, executables,
--   tests, benchmarks.
resolvePackageDescription :: PackageConfig -> GenericPackageDescription -> PackageDescription

-- | Get all build tool dependencies of the package (buildable targets
--   only).
packageToolDependencies :: PackageDescription -> Map ByteString VersionRange

-- | Get all dependencies of the package (buildable targets only).
packageDependencies :: PackageDescription -> Map PackageName VersionRange
packageIdentifier :: Package -> PackageIdentifier

-- | Make the autogen dir.
autogenDir :: Path Abs Dir -> Path Abs Dir

-- | Check if the given name in the <tt>Package</tt> matches the name of
--   the .cabal file
checkCabalFileName :: MonadThrow m => PackageName -> Path Abs File -> m ()

-- | Print cabal file warnings.
printCabalFileWarning :: (MonadLogger m) => Path Abs File -> PWarning -> m ()

-- | Extract the <tt>PackageIdentifier</tt> given an exploded haskell
--   package path.
cabalFilePackageId :: (Applicative m, MonadIO m, MonadThrow m) => Path Abs File -> m PackageIdentifier


-- | Resolving a build plan for a set of packages in a given Stackage
--   snapshot.
module Stack.BuildPlan
data BuildPlanException
UnknownPackages :: (Path Abs File) -> (Map PackageName (Maybe Version, Set PackageName)) -> (Map PackageName (Set PackageIdentifier)) -> BuildPlanException
SnapshotNotFound :: SnapName -> BuildPlanException

-- | A simplified version of the <a>BuildPlan</a> + cabal file.
data MiniBuildPlan
MiniBuildPlan :: !CompilerVersion -> !(Map PackageName MiniPackageInfo) -> MiniBuildPlan
[mbpCompilerVersion] :: MiniBuildPlan -> !CompilerVersion
[mbpPackages] :: MiniBuildPlan -> !(Map PackageName MiniPackageInfo)

-- | Information on a single package for the <a>MiniBuildPlan</a>.
data MiniPackageInfo
MiniPackageInfo :: !Version -> !(Map FlagName Bool) -> !(Set PackageName) -> !(Set ByteString) -> !(Set ExeName) -> !Bool -> MiniPackageInfo
[mpiVersion] :: MiniPackageInfo -> !Version
[mpiFlags] :: MiniPackageInfo -> !(Map FlagName Bool)
[mpiPackageDeps] :: MiniPackageInfo -> !(Set PackageName)

-- | Due to ambiguity in Cabal, it is unclear whether this refers to the
--   executable name, the package name, or something else. We have to guess
--   based on what's available, which is why we store this is an unwrapped
--   <a>ByteString</a>.
[mpiToolDeps] :: MiniPackageInfo -> !(Set ByteString)

-- | Executables provided by this package
[mpiExes] :: MiniPackageInfo -> !(Set ExeName)

-- | Is there a library present?
[mpiHasLibrary] :: MiniPackageInfo -> !Bool

-- | Most recent Nightly and newest LTS version per major release.
data Snapshots
Snapshots :: !Day -> !(IntMap Int) -> Snapshots
[snapshotsNightly] :: Snapshots -> !Day
[snapshotsLts] :: Snapshots -> !(IntMap Int)

-- | Download the <a>Snapshots</a> value from stackage.org.
getSnapshots :: (MonadThrow m, MonadIO m, MonadReader env m, HasHttpManager env, HasStackRoot env, HasConfig env) => m Snapshots

-- | Load up a <a>MiniBuildPlan</a>, preferably from cache
loadMiniBuildPlan :: (MonadIO m, MonadThrow m, MonadLogger m, MonadReader env m, HasHttpManager env, HasConfig env, HasGHCVariant env, MonadBaseControl IO m, MonadCatch m) => SnapName -> m MiniBuildPlan

-- | Determine the necessary packages to install to have the given set of
--   packages available.
--   
--   This function will not provide test suite and benchmark dependencies.
--   
--   This may fail if a target package is not present in the
--   <tt>BuildPlan</tt>.
resolveBuildPlan :: (MonadThrow m, MonadIO m, MonadReader env m, HasBuildConfig env, MonadLogger m, HasHttpManager env, MonadBaseControl IO m, MonadCatch m) => MiniBuildPlan -> (PackageName -> Bool) -> Map PackageName (Set PackageName) -> m (Map PackageName (Version, Map FlagName Bool), Map PackageName (Set PackageName))

-- | Find a snapshot and set of flags that is compatible with the given
--   <a>GenericPackageDescription</a>. Returns <a>Nothing</a> if no such
--   snapshot is found.
findBuildPlan :: (MonadIO m, MonadCatch m, MonadLogger m, MonadReader env m, HasHttpManager env, HasConfig env, HasGHCVariant env, MonadBaseControl IO m) => [GenericPackageDescription] -> [SnapName] -> m (Maybe (SnapName, Map PackageName (Map FlagName Bool)))

-- | Look up with packages provide which tools.
type ToolMap = Map ByteString (Set PackageName)

-- | Map from tool name to package providing it
getToolMap :: MiniBuildPlan -> Map ByteString (Set PackageName)
shadowMiniBuildPlan :: MiniBuildPlan -> Set PackageName -> (MiniBuildPlan, Map PackageName MiniPackageInfo)
parseCustomMiniBuildPlan :: (MonadIO m, MonadCatch m, MonadLogger m, MonadReader env m, HasHttpManager env, HasConfig env, MonadBaseControl IO m) => Path Abs File -> Text -> m MiniBuildPlan
instance GHC.Show.Show Stack.BuildPlan.Snapshots
instance GHC.Exception.Exception Stack.BuildPlan.BuildPlanException
instance GHC.Show.Show Stack.BuildPlan.BuildPlanException
instance Data.Aeson.Types.Class.FromJSON Stack.BuildPlan.Snapshots
instance GHC.Base.Monoid Stack.BuildPlan.DepError
instance Data.Aeson.Types.Class.FromJSON Stack.BuildPlan.CustomSnapshot

module Stack.Solver
cabalSolver :: (MonadIO m, MonadLogger m, MonadMask m, MonadBaseControl IO m, MonadReader env m, HasConfig env) => WhichCompiler -> [Path Abs Dir] -> Map PackageName Version -> Map PackageName (Map FlagName Bool) -> [String] -> m (CompilerVersion, Map PackageName (Version, Map FlagName Bool))

-- | Determine missing extra-deps
solveExtraDeps :: (MonadReader env m, HasEnvConfig env, MonadIO m, MonadMask m, MonadLogger m, MonadBaseControl IO m, HasHttpManager env) => Bool -> m ()

module Stack.Build.Source
loadSourceMap :: (MonadIO m, MonadCatch m, MonadReader env m, HasBuildConfig env, MonadBaseControl IO m, HasHttpManager env, MonadLogger m, HasEnvConfig env) => NeedTargets -> BuildOpts -> m (Map PackageName SimpleTarget, MiniBuildPlan, [LocalPackage], Set PackageName, SourceMap)
type SourceMap = Map PackageName PackageSource

-- | Where the package's source is located: local directory or package
--   index
data PackageSource
PSLocal :: LocalPackage -> PackageSource

-- | Upstream packages could be installed in either local or snapshot
--   databases; this is what <a>InstallLocation</a> specifies.
PSUpstream :: Version -> InstallLocation -> (Map FlagName Bool) -> PackageSource

-- | All flags for a local package
localFlags :: (Map (Maybe PackageName) (Map FlagName Bool)) -> BuildConfig -> PackageName -> Map FlagName Bool

-- | Parse out the local package views for the current project
getLocalPackageViews :: (MonadThrow m, MonadIO m, MonadReader env m, HasEnvConfig env, MonadLogger m) => m (Map PackageName (LocalPackageView, GenericPackageDescription))

-- | Upgrade the initial local package info to a full-blown
--   <tt>LocalPackage</tt> based on the selected components
loadLocalPackage :: (MonadReader env m, HasEnvConfig env, MonadCatch m, MonadLogger m, MonadIO m) => BuildOpts -> Map PackageName SimpleTarget -> (PackageName, (LocalPackageView, GenericPackageDescription)) -> m LocalPackage

-- | Use the build options and environment to parse targets.
parseTargetsFromBuildOpts :: (MonadIO m, MonadCatch m, MonadReader env m, HasBuildConfig env, MonadBaseControl IO m, HasHttpManager env, MonadLogger m, HasEnvConfig env) => NeedTargets -> BuildOpts -> m (MiniBuildPlan, Map PackageName Version, Map PackageName SimpleTarget)

-- | Returns entries to add to the build cache for any newly found unlisted
--   modules
addUnlistedToBuildCache :: (MonadIO m, MonadReader env m, MonadCatch m, MonadLogger m, HasEnvConfig env) => ModTime -> Package -> Path Abs File -> Map FilePath a -> m ([Map FilePath FileCacheInfo], [PackageWarning])

-- | Get <a>PackageConfig</a> for package given its name.
getPackageConfig :: (MonadIO m, MonadThrow m, MonadCatch m, MonadLogger m, MonadReader env m, HasEnvConfig env) => BuildOpts -> PackageName -> m PackageConfig


-- | Clean a project.
module Stack.Clean

-- | Reset the build, i.e. remove the <tt>dist</tt> directory (for example
--   <tt>.stack-work/dist/x84_64-linux/Cabal-1.22.4.0</tt>) for all
--   targets.
--   
--   Throws <a>StackCleanException</a>.
clean :: (MonadThrow m, MonadIO m, MonadReader env m, HasEnvConfig env, MonadLogger m) => CleanOpts -> m ()

-- | Options for cleaning a project.
newtype CleanOpts
CleanOpts :: [PackageName] -> CleanOpts

-- | Names of the packages to clean. If the list is empty, every local
--   package should be cleaned.
[cleanOptsTargets] :: CleanOpts -> [PackageName]

-- | Exceptions during cleanup.
newtype StackCleanException
NonLocalPackages :: [PackageName] -> StackCleanException
instance GHC.Show.Show Stack.Clean.StackCleanException
instance GHC.Exception.Exception Stack.Clean.StackCleanException

module Stack.Init
findCabalFiles :: MonadIO m => Bool -> Path Abs Dir -> m [Path Abs File]

-- | Generate stack.yaml
initProject :: (MonadIO m, MonadMask m, MonadReader env m, HasConfig env, HasHttpManager env, HasGHCVariant env, MonadLogger m, MonadBaseControl IO m) => Path Abs Dir -> InitOpts -> m ()
data InitOpts
InitOpts :: !Method -> Bool -> Bool -> InitOpts

-- | Preferred snapshots
[ioMethod] :: InitOpts -> !Method

-- | Overwrite existing files
[forceOverwrite] :: InitOpts -> Bool

-- | If True, include all .cabal files found in any sub directories
[includeSubDirs] :: InitOpts -> Bool
data SnapPref
PrefNone :: SnapPref
PrefLTS :: SnapPref
PrefNightly :: SnapPref

-- | Method of initializing
data Method
MethodSnapshot :: SnapPref -> Method
MethodResolver :: AbstractResolver -> Method
MethodSolver :: Method

-- | Turn an <a>AbstractResolver</a> into a <a>Resolver</a>.
makeConcreteResolver :: (MonadIO m, MonadReader env m, HasConfig env, MonadThrow m, HasHttpManager env, MonadLogger m) => AbstractResolver -> m Resolver

-- | If deprecated path exists, use it and print a warning. Otherwise,
--   return the new path.
tryDeprecatedPath :: (MonadIO m, MonadLogger m) => Maybe Text -> (Path Abs a -> m Bool) -> Path Abs a -> Path Abs a -> m (Path Abs a, Bool)

-- | Get the location of the implicit global project directory. If the
--   directory already exists at the deprecated location, its location is
--   returned. Otherwise, the new location is returned.
getImplicitGlobalProjectDir :: (MonadIO m, MonadLogger m) => Config -> m (Path Abs Dir)


-- | The general Stack configuration that starts everything off. This
--   should be smart to falback if there is no stack.yaml, instead relying
--   on whatever files are available.
--   
--   If there is no stack.yaml, and there is a cabal.config, we read in
--   those constraints, and if there's a cabal.sandbox.config, we read any
--   constraints from there and also find the package database from there,
--   etc. And if there's nothing, we should probably default to behaving
--   like cabal, possibly with spitting out a warning that "you should run
--   `stk init` to make things better".
module Stack.Config

-- | An environment with a subset of BuildConfig used for setup.
data MiniConfig

-- | Load the configuration, using current directory, environment
--   variables, and defaults as necessary.
loadConfig :: (MonadLogger m, MonadIO m, MonadCatch m, MonadThrow m, MonadBaseControl IO m, MonadReader env m, HasHttpManager env, HasTerminal env) => ConfigMonoid -> Maybe (Path Abs File) -> Maybe (AbstractResolver) -> m (LoadConfig m)

-- | Load the <a>MiniConfig</a>.
loadMiniConfig :: (MonadIO m, HasHttpManager a, MonadReader a m, MonadBaseControl IO m, MonadCatch m, MonadLogger m) => Config -> m MiniConfig
packagesParser :: Parser [String]

-- | Resolve a PackageEntry into a list of paths, downloading and cloning
--   as necessary.
resolvePackageEntry :: (MonadIO m, MonadThrow m, MonadReader env m, HasHttpManager env, MonadLogger m, MonadCatch m, MonadBaseControl IO m, HasConfig env) => EnvOverride -> Path Abs Dir -> PackageEntry -> m [(Path Abs Dir, Bool)]

-- | Get the location of the implicit global project directory. If the
--   directory already exists at the deprecated location, its location is
--   returned. Otherwise, the new location is returned.
getImplicitGlobalProjectDir :: (MonadIO m, MonadLogger m) => Config -> m (Path Abs Dir)
getIsGMP4 :: (MonadIO m, MonadBaseControl IO m, MonadCatch m, MonadLogger m) => EnvOverride -> m Bool
instance Stack.Types.Config.HasConfig Stack.Config.MiniConfig
instance Stack.Types.Config.HasStackRoot Stack.Config.MiniConfig
instance Network.HTTP.Client.Types.HasHttpManager Stack.Config.MiniConfig
instance Stack.Types.Config.HasPlatform Stack.Config.MiniConfig
instance Stack.Types.Config.HasGHCVariant Stack.Config.MiniConfig


-- | Make changes to the stack yaml file
module Stack.ConfigCmd
data ConfigCmdSet
ConfigCmdSetResolver :: AbstractResolver -> ConfigCmdSet
cfgCmdSet :: (MonadIO m, MonadBaseControl IO m, MonadMask m, MonadReader env m, HasConfig env, HasBuildConfig env, HasHttpManager env, HasGHCVariant env, MonadThrow m, MonadLogger m) => ConfigCmdSet -> m ()
cfgCmdSetName :: String
cfgCmdName :: String


-- | Generate HPC (Haskell Program Coverage) reports
module Stack.Coverage

-- | Invoked at the beginning of running with "--coverage"
deleteHpcReports :: (MonadIO m, MonadThrow m, MonadReader env m, HasEnvConfig env) => m ()

-- | Move a tix file into a sub-directory of the hpc report directory.
--   Deletes the old one if one is present.
updateTixFile :: (MonadIO m, MonadReader env m, HasConfig env, MonadLogger m, MonadBaseControl IO m, MonadCatch m, HasEnvConfig env) => PackageName -> Path Abs File -> m ()
testExeName :: (MonadReader env m, HasConfig env) => String -> m String

-- | Generates the HTML coverage report and shows a textual coverage
--   summary for a package.
generateHpcReport :: (MonadIO m, MonadReader env m, HasConfig env, MonadLogger m, MonadBaseControl IO m, MonadCatch m, HasEnvConfig env) => Path Abs Dir -> Package -> [Text] -> m ()
data HpcReportOpts
HpcReportOpts :: [Text] -> Bool -> Maybe String -> HpcReportOpts
[hroptsInputs] :: HpcReportOpts -> [Text]
[hroptsAll] :: HpcReportOpts -> Bool
[hroptsDestDir] :: HpcReportOpts -> Maybe String
generateHpcReportForTargets :: (MonadIO m, HasHttpManager env, MonadReader env m, MonadBaseControl IO m, MonadCatch m, MonadLogger m, HasEnvConfig env) => HpcReportOpts -> m ()
generateHpcUnifiedReport :: (MonadIO m, MonadReader env m, HasConfig env, MonadLogger m, MonadBaseControl IO m, MonadCatch m, HasEnvConfig env) => m ()
generateHpcMarkupIndex :: (MonadIO m, MonadReader env m, MonadLogger m, MonadCatch m, HasEnvConfig env) => m ()
instance GHC.Show.Show Stack.Coverage.HpcReportOpts


module Stack.Sig.Sign

-- | Sign a haskell package with the given url of the signature service and
--   a path to a tarball.
sign :: (MonadCatch m, MonadBaseControl IO m, MonadIO m, MonadMask m, MonadLogger m, MonadThrow m, MonadReader env m, HasConfig env) => Maybe (Path Abs Dir) -> String -> Path Abs File -> m ()

-- | Sign a haskell package with the given url to the signature service, a
--   package tarball path (package tarball name) and a lazy bytestring of
--   bytes that represent the tarball bytestream. The function will write
--   the bytes to the path in a temp dir and sign the tarball with GPG.
signTarBytes :: (MonadCatch m, MonadBaseControl IO m, MonadIO m, MonadMask m, MonadLogger m, MonadThrow m, MonadReader env m, HasConfig env) => Maybe (Path Abs Dir) -> String -> Path Rel File -> ByteString -> m ()


module Stack.Sig

-- | The command name for dealing with signatures.
sigCmdName :: String

-- | The command name for signing packages.
sigSignCmdName :: String

-- | The command name for signing all your packages from hackage.org.
sigSignHackageCmdName :: String

-- | Signature sign (hackage) options
sigSignHackageOpts :: Parser (String, String)

-- | The command name for signing an sdist package file.
sigSignSdistCmdName :: String

-- | Signature sign (sdist) options
sigSignSdistOpts :: Parser (String, String)


-- | Generate haddocks
module Stack.Build.Haddock

-- | Generate Haddock index and contents for local packages.
generateLocalHaddockIndex :: (MonadIO m, MonadCatch m, MonadThrow m, MonadLogger m, MonadBaseControl IO m) => EnvOverride -> WhichCompiler -> BaseConfigOpts -> Map GhcPkgId (DumpPackage () ()) -> [LocalPackage] -> m ()

-- | Generate Haddock index and contents for local packages and their
--   dependencies.
generateDepsHaddockIndex :: (MonadIO m, MonadCatch m, MonadThrow m, MonadLogger m, MonadBaseControl IO m) => EnvOverride -> WhichCompiler -> BaseConfigOpts -> Map GhcPkgId (DumpPackage () ()) -> Map GhcPkgId (DumpPackage () ()) -> Map GhcPkgId (DumpPackage () ()) -> [LocalPackage] -> m ()

-- | Generate Haddock index and contents for all snapshot packages.
generateSnapHaddockIndex :: (MonadIO m, MonadCatch m, MonadThrow m, MonadLogger m, MonadBaseControl IO m) => EnvOverride -> WhichCompiler -> BaseConfigOpts -> Map GhcPkgId (DumpPackage () ()) -> Map GhcPkgId (DumpPackage () ()) -> m ()

-- | Determine whether we should haddock for a package.
shouldHaddockPackage :: BuildOpts -> Set PackageName -> PackageName -> Bool

-- | Determine whether to build haddocks for dependencies.
shouldHaddockDeps :: BuildOpts -> Bool


-- | Perform a build
module Stack.Build.Execute

-- | Print a description of build plan for human consumption.
printPlan :: M env m => Plan -> m ()

-- | Fetch the packages necessary for a build, for example in combination
--   with a dry run.
preFetch :: M env m => Plan -> m ()

-- | Perform the actual plan
executePlan :: M env m => EnvOverride -> BuildOpts -> BaseConfigOpts -> [LocalPackage] -> [DumpPackage () ()] -> [DumpPackage () ()] -> [DumpPackage () ()] -> InstalledMap -> Plan -> m ()
data ExecuteEnv

-- | Execute a callback that takes an <a>ExecuteEnv</a>.
withExecuteEnv :: M env m => EnvOverride -> BuildOpts -> BaseConfigOpts -> [LocalPackage] -> [DumpPackage () ()] -> [DumpPackage () ()] -> [DumpPackage () ()] -> (ExecuteEnv -> m a) -> m a
withSingleContext :: M env m => (m () -> IO ()) -> ActionContext -> ExecuteEnv -> Task -> Maybe (Map PackageIdentifier GhcPkgId) -> Maybe String -> (Package -> Path Abs File -> Path Abs Dir -> (Bool -> [String] -> m ()) -> (Text -> m ()) -> Bool -> Maybe (Path Abs File, Handle) -> m a) -> m a


-- | Construct a <tt>Plan</tt> for how to build
module Stack.Build.ConstructPlan
constructPlan :: (MonadCatch m, MonadReader env m, HasEnvConfig env, MonadIO m, MonadLogger m, MonadBaseControl IO m, HasHttpManager env) => MiniBuildPlan -> BaseConfigOpts -> [LocalPackage] -> Set PackageName -> [DumpPackage () ()] -> (PackageName -> Version -> Map FlagName Bool -> IO Package) -> SourceMap -> InstalledMap -> m Plan
instance GHC.Show.Show Stack.Build.ConstructPlan.AddDepRes
instance GHC.Base.Monoid Stack.Build.ConstructPlan.W
instance Stack.Types.Config.HasStackRoot Stack.Build.ConstructPlan.Ctx
instance Stack.Types.Config.HasPlatform Stack.Build.ConstructPlan.Ctx
instance Stack.Types.Config.HasGHCVariant Stack.Build.ConstructPlan.Ctx
instance Stack.Types.Config.HasConfig Stack.Build.ConstructPlan.Ctx
instance Stack.Types.Config.HasBuildConfig Stack.Build.ConstructPlan.Ctx
instance Stack.Types.Config.HasEnvConfig Stack.Build.ConstructPlan.Ctx


-- | Build the project.
module Stack.Build

-- | Build.
--   
--   If a buildLock is passed there is an important contract here. That
--   lock must protect the snapshot, and it must be safe to unlock it if
--   there are no further modifications to the snapshot to be performed by
--   this build.
build :: M env m => (Set (Path Abs File) -> IO ()) -> Maybe FileLock -> BuildOpts -> m ()

-- | Provide a function for loading package information from the package
--   index
withLoadPackage :: (MonadIO m, HasHttpManager env, MonadReader env m, MonadBaseControl IO m, MonadCatch m, MonadLogger m, HasEnvConfig env) => EnvOverride -> ((PackageName -> Version -> Map FlagName Bool -> IO Package) -> m a) -> m a

-- | Get the <tt>BaseConfigOpts</tt> necessary for constructing configure
--   options
mkBaseConfigOpts :: (MonadIO m, MonadReader env m, HasEnvConfig env, MonadThrow m) => BuildOpts -> m BaseConfigOpts

-- | Query information about the build and print the result to stdout in
--   YAML format.
queryBuildInfo :: M env m => [Text] -> m ()

module Stack.Setup

-- | Modify the environment variables (like PATH) appropriately, possibly
--   doing installation too
setupEnv :: (MonadIO m, MonadMask m, MonadLogger m, MonadReader env m, HasBuildConfig env, HasHttpManager env, HasTerminal env, HasReExec env, HasLogLevel env, HasGHCVariant env, MonadBaseControl IO m) => Maybe Text -> m EnvConfig

-- | Ensure compiler (ghc or ghcjs) is installed and provide the PATHs to
--   add if necessary
ensureCompiler :: (MonadIO m, MonadMask m, MonadLogger m, MonadReader env m, HasConfig env, HasHttpManager env, HasTerminal env, HasReExec env, HasLogLevel env, HasGHCVariant env, MonadBaseControl IO m) => SetupOpts -> m (Maybe ExtraDirs)
ensureDockerStackExe :: (MonadIO m, MonadMask m, MonadLogger m, MonadReader env m, HasConfig env, HasHttpManager env, MonadBaseControl IO m) => Platform -> m (Path Abs File)
data SetupOpts
SetupOpts :: !Bool -> !Bool -> !CompilerVersion -> !VersionCheck -> !(Maybe (Path Abs File)) -> !Bool -> !Bool -> !Bool -> !Bool -> !Bool -> !(Maybe Text) -> !FilePath -> !(Maybe String) -> SetupOpts
[soptsInstallIfMissing] :: SetupOpts -> !Bool
[soptsUseSystem] :: SetupOpts -> !Bool
[soptsWantedCompiler] :: SetupOpts -> !CompilerVersion
[soptsCompilerCheck] :: SetupOpts -> !VersionCheck

-- | If we got the desired GHC version from that file
[soptsStackYaml] :: SetupOpts -> !(Maybe (Path Abs File))
[soptsForceReinstall] :: SetupOpts -> !Bool

-- | Run a sanity check on the selected GHC
[soptsSanityCheck] :: SetupOpts -> !Bool

-- | Don't check for a compatible GHC version/architecture
[soptsSkipGhcCheck] :: SetupOpts -> !Bool

-- | Do not use a custom msys installation on Windows
[soptsSkipMsys] :: SetupOpts -> !Bool

-- | Upgrade the global Cabal library in the database to the newest
--   version. Only works reliably with a stack-managed installation.
[soptsUpgradeCabal] :: SetupOpts -> !Bool

-- | Message shown to user for how to resolve the missing GHC
[soptsResolveMissingGHC] :: SetupOpts -> !(Maybe Text)

-- | Location of the main stack-setup.yaml file
[soptsStackSetupYaml] :: SetupOpts -> !FilePath

-- | Alternate GHC binary distribution (requires custom GHCVariant)
[soptsGHCBindistURL] :: SetupOpts -> !(Maybe String)

-- | Default location of the stack-setup.yaml file
defaultStackSetupYaml :: String
instance GHC.Base.Functor Stack.Setup.CheckDependency
instance GHC.Show.Show Stack.Setup.SetupOpts
instance GHC.Exception.Exception Stack.Setup.SetupException
instance GHC.Show.Show Stack.Setup.SetupException
instance GHC.Base.Applicative Stack.Setup.CheckDependency
instance GHC.Base.Alternative Stack.Setup.CheckDependency


-- | Run commands in Docker containers
module Stack.Docker

-- | Clean-up old docker images and containers.
cleanup :: M env m => CleanupOpts -> m ()

-- | Options for <a>cleanup</a>.
data CleanupOpts
CleanupOpts :: !CleanupAction -> !(Maybe Integer) -> !(Maybe Integer) -> !(Maybe Integer) -> !(Maybe Integer) -> !(Maybe Integer) -> CleanupOpts
[dcAction] :: CleanupOpts -> !CleanupAction
[dcRemoveKnownImagesLastUsedDaysAgo] :: CleanupOpts -> !(Maybe Integer)
[dcRemoveUnknownImagesCreatedDaysAgo] :: CleanupOpts -> !(Maybe Integer)
[dcRemoveDanglingImagesCreatedDaysAgo] :: CleanupOpts -> !(Maybe Integer)
[dcRemoveStoppedContainersCreatedDaysAgo] :: CleanupOpts -> !(Maybe Integer)
[dcRemoveRunningContainersCreatedDaysAgo] :: CleanupOpts -> !(Maybe Integer)

-- | Cleanup action.
data CleanupAction
CleanupInteractive :: CleanupAction
CleanupImmediate :: CleanupAction
CleanupDryRun :: CleanupAction

-- | Command-line argument for <tt>docker cleanup</tt>.
dockerCleanupCmdName :: String

-- | Command-line argument for "docker"
dockerCmdName :: String

-- | Command-line argument for <tt>docker pull</tt>.
dockerPullCmdName :: String

-- | The Docker container "entrypoint": special actions performed when
--   first entering a container, such as switching the UID/GID to the
--   "outside-Docker" user's.
entrypoint :: (MonadIO m, MonadBaseControl IO m, MonadCatch m, MonadLogger m) => Config -> DockerEntrypoint -> m ()

-- | Error if running in a container.
preventInContainer :: (MonadIO m, MonadThrow m) => m () -> m ()

-- | Pull latest version of configured Docker image from registry.
pull :: M env m => m ()

-- | If Docker is enabled, re-runs the currently running OS command in a
--   Docker container. Otherwise, runs the inner action.
--   
--   This takes an optional release action which should be taken IFF
--   control is transfering away from the current process to the
--   intra-container one. The main use for this is releasing a lock. After
--   launching reexecution, the host process becomes nothing but an manager
--   for the call into docker and thus may not hold the lock.
reexecWithOptionalContainer :: M env m => Maybe (Path Abs Dir) -> Maybe (m ()) -> IO () -> Maybe (m ()) -> Maybe (m ()) -> m ()

-- | Remove the project's Docker sandbox.
reset :: (MonadIO m, MonadReader env m, HasConfig env) => Maybe (Path Abs Dir) -> Bool -> m ()

-- | Command-line option for <tt>--internal-re-exec-version</tt>.
reExecArgName :: String

-- | Exceptions thrown by Stack.Docker.
data StackDockerException

-- | Docker must be enabled to use the command.
DockerMustBeEnabledException :: StackDockerException

-- | Command must be run on host OS (not in a container).
OnlyOnHostException :: StackDockerException

-- | <tt>docker inspect</tt> failed.
InspectFailedException :: String -> StackDockerException

-- | Image does not exist.
NotPulledException :: String -> StackDockerException

-- | Input to <tt>docker cleanup</tt> has invalid command.
InvalidCleanupCommandException :: String -> StackDockerException

-- | Invalid output from <tt>docker images</tt>.
InvalidImagesOutputException :: String -> StackDockerException

-- | Invalid output from <tt>docker ps</tt>.
InvalidPSOutputException :: String -> StackDockerException

-- | Invalid output from <tt>docker inspect</tt>.
InvalidInspectOutputException :: String -> StackDockerException

-- | Could not pull a Docker image.
PullFailedException :: String -> StackDockerException

-- | Installed version of <tt>docker</tt> below minimum version.
DockerTooOldException :: Version -> Version -> StackDockerException

-- | Installed version of <tt>docker</tt> is prohibited.
DockerVersionProhibitedException :: [Version] -> Version -> StackDockerException

-- | Installed version of <tt>docker</tt> is out of range specified in
--   config file.
BadDockerVersionException :: VersionRange -> Version -> StackDockerException

-- | Invalid output from <tt>docker --version</tt>.
InvalidVersionOutputException :: StackDockerException

-- | Version of <tt>stack</tt> on host is too old for version in image.
HostStackTooOldException :: Version -> (Maybe Version) -> StackDockerException

-- | Version of <tt>stack</tt> in container/image is too old for version on
--   host.
ContainerStackTooOldException :: Version -> Version -> StackDockerException

-- | Can't determine the project root (where to put docker sandbox).
CannotDetermineProjectRootException :: StackDockerException

-- | <tt>docker --version</tt> failed.
DockerNotInstalledException :: StackDockerException

-- | Using host stack-exe on unsupported platform.
UnsupportedStackExeHostPlatformException :: StackDockerException
instance GHC.Show.Show Stack.Docker.Inspect
instance GHC.Show.Show Stack.Docker.ImageConfig
instance GHC.Show.Show Stack.Docker.CleanupOpts
instance GHC.Show.Show Stack.Docker.CleanupAction
instance Data.Aeson.Types.Class.FromJSON Stack.Docker.Inspect
instance Data.Aeson.Types.Class.FromJSON Stack.Docker.ImageConfig
instance GHC.Exception.Exception Stack.Docker.StackDockerException
instance GHC.Show.Show Stack.Docker.StackDockerException


-- | Run commands in a nix-shell
module Stack.Nix

-- | If Nix is enabled, re-runs the currently running OS command in a Nix
--   container. Otherwise, runs the inner action.
reexecWithOptionalShell :: M env m => IO () -> m ()

-- | Command-line argument for "nix"
nixCmdName :: String

module Stack.Dot

-- | Visualize the project's dependencies as a graphviz graph
dot :: (HasEnvConfig env, HasHttpManager env, HasLogLevel env, MonadBaseControl IO m, MonadCatch m, MonadLogger m, MonadIO m, MonadMask m, MonadReader env m) => DotOpts -> m ()
listDependencies :: (HasEnvConfig env, HasHttpManager env, HasLogLevel env, MonadBaseControl IO m, MonadCatch m, MonadLogger m, MonadMask m, MonadIO m, MonadReader env m) => Text -> m ()

-- | Options record for <tt>stack dot</tt>
data DotOpts
DotOpts :: Bool -> Bool -> Maybe Int -> Set String -> DotOpts

-- | Include external dependencies
[dotIncludeExternal] :: DotOpts -> Bool

-- | Include dependencies on base
[dotIncludeBase] :: DotOpts -> Bool

-- | Limit the depth of dependency resolution to (Just n) or continue until
--   fixpoint
[dotDependencyDepth] :: DotOpts -> Maybe Int

-- | Package names to prune from the graph
[dotPrune] :: DotOpts -> Set String

-- | Resolve the dependency graph up to (Just depth) or until fixpoint is
--   reached
resolveDependencies :: (Applicative m, Monad m) => Maybe Int -> Map PackageName (Set PackageName, Maybe Version) -> (PackageName -> m (Set PackageName, Maybe Version)) -> m (Map PackageName (Set PackageName, Maybe Version))

-- | Print a graphviz graph of the edges in the Map and highlight the given
--   local packages
printGraph :: (Applicative m, MonadIO m) => DotOpts -> Set PackageName -> Map PackageName (Set PackageName, Maybe Version) -> m ()

-- | <tt>pruneGraph dontPrune toPrune graph</tt> prunes all packages in
--   <tt>graph</tt> with a name in <tt>toPrune</tt> and removes resulting
--   orphans unless they are in <tt>dontPrune</tt>
pruneGraph :: (Foldable f, Foldable g, Eq a) => f PackageName -> g String -> Map PackageName (Set PackageName, a) -> Map PackageName (Set PackageName, a)


-- | Run a GHCi configured with the user's package(s).
module Stack.Ghci

-- | Command-line options for GHC.
data GhciOpts
GhciOpts :: !Bool -> ![String] -> !(Maybe FilePath) -> !Bool -> ![String] -> !(Maybe Text) -> !Bool -> !BuildOpts -> GhciOpts
[ghciNoBuild] :: GhciOpts -> !Bool
[ghciArgs] :: GhciOpts -> ![String]
[ghciGhcCommand] :: GhciOpts -> !(Maybe FilePath)
[ghciNoLoadModules] :: GhciOpts -> !Bool
[ghciAdditionalPackages] :: GhciOpts -> ![String]
[ghciMainIs] :: GhciOpts -> !(Maybe Text)
[ghciSkipIntermediate] :: GhciOpts -> !Bool
[ghciBuildOpts] :: GhciOpts -> !BuildOpts

-- | Necessary information to load a package or its components.
data GhciPkgInfo
GhciPkgInfo :: !PackageName -> ![(NamedComponent, BuildInfoOpts)] -> !(Path Abs Dir) -> !(Set ModuleName) -> !(Set (Path Abs File)) -> !(Set (Path Abs File)) -> !(Map NamedComponent (Set (Path Abs File))) -> !Package -> GhciPkgInfo
[ghciPkgName] :: GhciPkgInfo -> !PackageName
[ghciPkgOpts] :: GhciPkgInfo -> ![(NamedComponent, BuildInfoOpts)]
[ghciPkgDir] :: GhciPkgInfo -> !(Path Abs Dir)
[ghciPkgModules] :: GhciPkgInfo -> !(Set ModuleName)

-- | Module file paths.
[ghciPkgModFiles] :: GhciPkgInfo -> !(Set (Path Abs File))

-- | C files.
[ghciPkgCFiles] :: GhciPkgInfo -> !(Set (Path Abs File))
[ghciPkgMainIs] :: GhciPkgInfo -> !(Map NamedComponent (Set (Path Abs File)))
[ghciPkgPackage] :: GhciPkgInfo -> !Package

-- | Create a list of infos for each target containing necessary
--   information to load that package/components.
ghciSetup :: (HasConfig r, HasHttpManager r, HasBuildConfig r, MonadMask m, HasTerminal r, HasLogLevel r, HasEnvConfig r, MonadReader r m, MonadIO m, MonadThrow m, MonadLogger m, MonadCatch m, MonadBaseControl IO m) => BuildOpts -> Bool -> Bool -> Maybe Text -> m (Map PackageName SimpleTarget, Maybe (Map PackageName SimpleTarget), [GhciPkgInfo])

-- | Launch a GHCi session for the given local package targets with the
--   given options and configure it with the load paths and extensions of
--   those targets.
ghci :: (HasConfig r, HasBuildConfig r, HasHttpManager r, MonadMask m, HasLogLevel r, HasTerminal r, HasEnvConfig r, MonadReader r m, MonadIO m, MonadThrow m, MonadLogger m, MonadCatch m, MonadBaseControl IO m) => GhciOpts -> m ()
instance GHC.Show.Show Stack.Ghci.GhciPkgInfo
instance GHC.Show.Show Stack.Ghci.GhciOpts


-- | Run a IDE configured with the user's package(s).
module Stack.Ide

-- | Launch a GHCi IDE for the given local project targets with the given
--   options and configure it with the load paths and extensions of those
--   targets.
ide :: (HasConfig r, HasBuildConfig r, HasTerminal r, HasLogLevel r, MonadMask m, HasEnvConfig r, MonadReader r m, MonadIO m, MonadThrow m, MonadLogger m, MonadCatch m, MonadBaseControl IO m, HasHttpManager r) => [Text] -> [String] -> m ()

-- | Get options and target files for the given package info.
getPackageOptsAndTargetFiles :: (MonadThrow m, MonadIO m, MonadReader env m, HasEnvConfig env) => Path Abs Dir -> GhciPkgInfo -> m ([FilePath], [FilePath])

module Stack.SDist

-- | Given the path to a local package, creates its source distribution
--   tarball.
--   
--   While this yields a <a>FilePath</a>, the name of the tarball, this
--   tarball is not written to the disk and instead yielded as a lazy
--   bytestring.
getSDistTarball :: M env m => Maybe PvpBounds -> Path Abs Dir -> m (FilePath, ByteString)

-- | Check package in given tarball. This will log all warnings and will
--   throw an exception in case of critical errors.
--   
--   Note that we temporarily decompress the archive to analyze it.
checkSDistTarball :: (MonadIO m, MonadMask m, MonadThrow m, MonadCatch m, MonadLogger m, MonadReader env m, HasEnvConfig env) => Path Abs File -> m ()

-- | Version of <a>checkSDistTarball</a> that first saves lazy bytestring
--   to temporary directory and then calls <a>checkSDistTarball</a> on it.
checkSDistTarball' :: (MonadIO m, MonadMask m, MonadThrow m, MonadCatch m, MonadLogger m, MonadReader env m, HasEnvConfig env) => String -> ByteString -> m ()
instance GHC.Exception.Exception Stack.SDist.CheckException
instance GHC.Show.Show Stack.SDist.CheckException

module Stack.Upgrade
upgrade :: (MonadIO m, MonadMask m, MonadReader env m, HasConfig env, HasHttpManager env, MonadLogger m, HasTerminal env, HasReExec env, HasLogLevel env, MonadBaseControl IO m) => Maybe String -> Maybe AbstractResolver -> Maybe String -> m ()


-- | Accepting arguments to be passed through to a sub-process.
module Options.Applicative.Args

-- | An argument which accepts a list of arguments e.g.
--   <tt>--ghc-options="-X P.hs "this""</tt>.
argsArgument :: Mod ArgumentFields [String] -> Parser [String]

-- | An option which accepts a list of arguments e.g. <tt>--ghc-options="-X
--   P.hs "this""</tt>.
argsOption :: Mod OptionFields [String] -> Parser [String]

-- | An option which accepts a command and a list of arguments e.g.
--   <tt>--exec "echo hello world"</tt>
cmdOption :: Mod OptionFields (String, [String]) -> Parser (String, [String])

-- | Parse from a string.
parseArgsFromString :: String -> Either String [String]


-- | Extra functions for optparse-applicative.
module Options.Applicative.Builder.Extra

-- | Enable/disable flags for a <a>Bool</a>.
boolFlags :: Bool -> String -> String -> Mod FlagFields Bool -> Parser Bool

-- | Enable/disable flags for a <a>Bool</a>, without a default case (to
--   allow chaining with <a>&lt;|&gt;</a>).
boolFlagsNoDefault :: Maybe Bool -> String -> String -> Mod FlagFields Bool -> Parser Bool

-- | Enable/disable flags for a <tt>(<a>Maybe</a> <a>Bool</a>)</tt>.
maybeBoolFlags :: String -> String -> Mod FlagFields (Maybe Bool) -> Parser (Maybe Bool)

-- | Enable/disable flags for any type.
enableDisableFlags :: (Eq a) => a -> a -> a -> String -> String -> Mod FlagFields a -> Parser a

-- | Enable/disable flags for any type, without a default (to allow
--   chaining with <a>&lt;|&gt;</a>)
enableDisableFlagsNoDefault :: (Eq a) => a -> a -> Maybe a -> String -> String -> Mod FlagFields a -> Parser a

-- | Show an extra help option (e.g. <tt>--docker-help</tt> shows help for
--   all <tt>--docker*</tt> args).
--   
--   To actually have that help appear, use <a>execExtraHelp</a> before
--   executing the main parser.
extraHelpOption :: Bool -> String -> String -> String -> Parser (a -> a)

-- | Display extra help if extra help option passed in arguments.
--   
--   Since optparse-applicative doesn't allow an arbitrary IO action for an
--   <a>abortOption</a>, this was the best way I found that doesn't require
--   manually formatting the help.
execExtraHelp :: [String] -> String -> Parser a -> String -> IO ()

-- | <a>option</a>, specialized to <a>Text</a>.
textOption :: Mod OptionFields Text -> Parser Text

-- | <a>argument</a>, specialized to <a>Text</a>.
textArgument :: Mod ArgumentFields Text -> Parser Text

module Stack.Options

-- | Command sum type for conditional arguments.
data Command
Build :: Command
Test :: Command
Haddock :: Command
Bench :: Command
Install :: Command

-- | Parser for bench arguments.
benchOptsParser :: Parser BenchmarkOpts

-- | Parser for build arguments.
buildOptsParser :: Command -> Parser BuildOpts

-- | Command-line parser for the clean command.
cleanOptsParser :: Parser CleanOpts
configCmdSetParser :: Parser ConfigCmdSet

-- | Command-line arguments parser for configuration.
configOptsParser :: Bool -> Parser ConfigMonoid

-- | Options parser configuration for Docker.
dockerOptsParser :: Bool -> Parser DockerOptsMonoid

-- | Parser for docker cleanup arguments.
dockerCleanupOptsParser :: Parser CleanupOpts

-- | Parser for arguments to `stack dot`
dotOptsParser :: Parser DotOpts

-- | Parser for exec command
execOptsParser :: Maybe SpecialExecCmd -> Parser ExecOpts
evalOptsParser :: String -> Parser EvalOpts

-- | Parser for global command-line options.
globalOptsParser :: Bool -> Parser GlobalOptsMonoid
initOptsParser :: Parser InitOpts

-- | Parser for <tt>stack new</tt>.
newOptsParser :: Parser (NewOpts, InitOpts)
nixOptsParser :: Bool -> Parser NixOptsMonoid

-- | Parser for a logging level.
logLevelOptsParser :: Bool -> Parser (Maybe LogLevel)
ghciOptsParser :: Parser GhciOpts

-- | Parser for <tt>solverCmd</tt>
solverOptsParser :: Parser Bool

-- | Parser for test arguments.
testOptsParser :: Parser TestOpts

-- | Parser for <tt>stack hpc report</tt>.
hpcReportOptsParser :: Parser HpcReportOpts
pvpBoundsOption :: Parser PvpBounds

-- | Create GlobalOpts from GlobalOptsMonoid.
globalOptsFromMonoid :: Bool -> GlobalOptsMonoid -> GlobalOpts
instance GHC.Classes.Eq Stack.Options.Command