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


-- | A secure package manager for Arch Linux and the AUR.
--   
--   Aura is a package manager for Arch Linux. It connects to both the
--   official Arch repostitories and to the AUR, allowing easy control of
--   all packages on an Arch system. It allows <i>all</i> pacman operations
--   and provides <i>new</i> custom ones for dealing with AUR packages.
--   This differs from some other AUR package managers.
@package aura
@version 2.2.1


-- | Annotate <a>Doc</a> text with various colours.
module Aura.Colour

-- | Render an assembled <a>Doc</a> into strict <a>Text</a>.
dtot :: Doc AnsiStyle -> Text

-- | Colour a <a>Doc</a> cyan.
cyan :: Doc AnsiStyle -> Doc AnsiStyle

-- | Colour a <a>Doc</a> cyan and bold.
bCyan :: Doc AnsiStyle -> Doc AnsiStyle

-- | Colour a <a>Doc</a> green.
green :: Doc AnsiStyle -> Doc AnsiStyle

-- | Colour a <a>Doc</a> yellow.
yellow :: Doc AnsiStyle -> Doc AnsiStyle

-- | Colour a <a>Doc</a> red.
red :: Doc AnsiStyle -> Doc AnsiStyle

-- | Colour a <a>Doc</a> magenta.
magenta :: Doc AnsiStyle -> Doc AnsiStyle


-- | Core Aura types.
module Aura.Types

-- | A package to be installed.
data Package
FromRepo :: Prebuilt -> Package
FromAUR :: Buildable -> Package

-- | The name of a <a>Package</a>.
pname :: Package -> PkgName

-- | Other names which allow this <a>Package</a> to be satisfied as a
--   dependency.
pprov :: Package -> Provides

-- | The version of a <a>Package</a>.
pver :: Package -> Versioning
dividePkgs :: NESet Package -> These (NESet Prebuilt) (NESet Buildable)

-- | A dependency on another package.
data Dep
Dep :: !PkgName -> !VersionDemand -> Dep
[$sel:name:Dep] :: Dep -> !PkgName
[$sel:demand:Dep] :: Dep -> !VersionDemand

-- | Parse a dependency entry as it would appear in a PKGBUILD:
--   
--   <pre>
--   &gt;&gt;&gt; parseDep "pacman&gt;1.2.3"
--   Just (Dep {name = PkgName {name = "pacman"}, demand = &gt;1.2.3})
--   </pre>
parseDep :: Text -> Maybe Dep

-- | Renders the <a>Dep</a> into a form that <tt>pacman -T</tt>
--   understands. The dual of <a>parseDep</a>.
renderedDep :: Dep -> Text

-- | A <a>Package</a> from the AUR that's buildable in some way on the
--   user's machine.
data Buildable
Buildable :: !PkgName -> !Versioning -> !PkgName -> !Provides -> ![Dep] -> !Pkgbuild -> !Bool -> Buildable
[$sel:name:Buildable] :: Buildable -> !PkgName
[$sel:version:Buildable] :: Buildable -> !Versioning
[$sel:base:Buildable] :: Buildable -> !PkgName
[$sel:provides:Buildable] :: Buildable -> !Provides
[$sel:deps:Buildable] :: Buildable -> ![Dep]
[$sel:pkgbuild:Buildable] :: Buildable -> !Pkgbuild
[$sel:isExplicit:Buildable] :: Buildable -> !Bool

-- | A prebuilt <a>Package</a> from the official Arch repositories.
data Prebuilt
Prebuilt :: !PkgName -> !Versioning -> !PkgName -> !Provides -> Prebuilt
[$sel:name:Prebuilt] :: Prebuilt -> !PkgName
[$sel:version:Prebuilt] :: Prebuilt -> !Versioning
[$sel:base:Prebuilt] :: Prebuilt -> !PkgName
[$sel:provides:Prebuilt] :: Prebuilt -> !Provides

-- | A package name with its version number.
data SimplePkg
SimplePkg :: !PkgName -> !Versioning -> SimplePkg
[$sel:name:SimplePkg] :: SimplePkg -> !PkgName
[$sel:version:SimplePkg] :: SimplePkg -> !Versioning

-- | Attempt to create a <a>SimplePkg</a> from filepaths like
--   <tt>/var/cache/pacman/pkg/linux-3.2.14-1-x86_64.pkg.tar.xz</tt>
simplepkg :: PackagePath -> Maybe SimplePkg

-- | Attempt to create a <a>SimplePkg</a> from text like: xchat 2.8.8-19
simplepkg' :: Text -> Maybe SimplePkg

-- | Types whose members can be converted to CLI flags.
class Flagable a
asFlag :: Flagable a => a -> [Text]

-- | The versioning requirement of some package's dependency.
data VersionDemand
LessThan :: Versioning -> VersionDemand
AtLeast :: Versioning -> VersionDemand
MoreThan :: Versioning -> VersionDemand
MustBe :: Versioning -> VersionDemand
Anything :: VersionDemand

-- | Attempt to zoom into the <a>Versioning</a> hiding within a
--   <a>VersionDemand</a>.
_VersionDemand :: Traversal' VersionDemand Versioning

-- | The installation method.
data InstallType
Pacman :: PkgName -> InstallType
Build :: Buildable -> InstallType

-- | The various ways that dependency resolution can fail.
data DepError
NonExistant :: PkgName -> DepError
VerConflict :: Doc AnsiStyle -> DepError
Ignored :: Doc AnsiStyle -> DepError
BrokenProvides :: PkgName -> Provides -> PkgName -> DepError

-- | Some failure message that when given the current runtime
--   <a>Language</a> will produce a human-friendly error.
newtype Failure
Failure :: (Language -> Doc AnsiStyle) -> Failure
[$sel:failure:Failure] :: Failure -> Language -> Doc AnsiStyle

-- | All human languages available for text output.
data Language
English :: Language
Japanese :: Language
Polish :: Language
Croatian :: Language
Swedish :: Language
German :: Language
Spanish :: Language
Portuguese :: Language
French :: Language
Russian :: Language
Italian :: Language
Serbian :: Language
Norwegian :: Language
Indonesia :: Language
Chinese :: Language
Esperanto :: Language

-- | The name of an Arch Linux package.
newtype PkgName
PkgName :: Text -> PkgName
[$sel:name:PkgName] :: PkgName -> Text

-- | A group that a <a>Package</a> could belong too, like <tt>base</tt>,
--   <tt>base-devel</tt>, etc.
newtype PkgGroup
PkgGroup :: Text -> PkgGroup
[$sel:group:PkgGroup] :: PkgGroup -> Text

-- | The dependency which some package provides. May not be the same name
--   as the package itself (e.g. cronie provides cron).
newtype Provides
Provides :: PkgName -> Provides
[$sel:provides:Provides] :: Provides -> PkgName

-- | Filepaths like:
--   
--   <ul>
--   <li>/var/cache/pacman/pkg/linux-3.2.14-1-x86_64.pkg.tar.xz</li>
--   <li>/var/cache/pacman/pkg/wine-1.4rc6-1-x86_64.pkg.tar.xz</li>
--   <li>/var/cache/pacman/pkg/ruby-1.9.3_p125-4-x86_64.pkg.tar.xz</li>
--   </ul>
newtype PackagePath
PackagePath :: Path Absolute -> PackagePath
[$sel:path:PackagePath] :: PackagePath -> Path Absolute

-- | The contents of a PKGBUILD file.
newtype Pkgbuild
Pkgbuild :: ByteString -> Pkgbuild
[$sel:pkgbuild:Pkgbuild] :: Pkgbuild -> ByteString

-- | Shell environment variables.
type Environment = Map Text Text

-- | The name of a user account on a Linux system.
newtype User
User :: Text -> User
[$sel:user:User] :: User -> Text
instance GHC.Classes.Eq Aura.Types.Package
instance GHC.Classes.Eq Aura.Types.InstallType
instance GHC.Generics.Generic Aura.Types.Buildable
instance GHC.Show.Show Aura.Types.Buildable
instance GHC.Classes.Ord Aura.Types.Buildable
instance GHC.Classes.Eq Aura.Types.Buildable
instance GHC.Generics.Generic Aura.Types.Prebuilt
instance GHC.Show.Show Aura.Types.Prebuilt
instance GHC.Classes.Ord Aura.Types.Prebuilt
instance GHC.Classes.Eq Aura.Types.Prebuilt
instance GHC.Generics.Generic Aura.Types.Provides
instance GHC.Show.Show Aura.Types.Provides
instance GHC.Classes.Ord Aura.Types.Provides
instance GHC.Classes.Eq Aura.Types.Provides
instance Aura.Types.Flagable Aura.Types.PkgGroup
instance GHC.Generics.Generic Aura.Types.PkgGroup
instance GHC.Show.Show Aura.Types.PkgGroup
instance GHC.Classes.Ord Aura.Types.PkgGroup
instance GHC.Classes.Eq Aura.Types.PkgGroup
instance GHC.Generics.Generic Aura.Types.Dep
instance GHC.Show.Show Aura.Types.Dep
instance GHC.Classes.Ord Aura.Types.Dep
instance GHC.Classes.Eq Aura.Types.Dep
instance GHC.Generics.Generic Aura.Types.SimplePkg
instance GHC.Show.Show Aura.Types.SimplePkg
instance GHC.Classes.Ord Aura.Types.SimplePkg
instance GHC.Classes.Eq Aura.Types.SimplePkg
instance Data.String.IsString Aura.Types.PkgName
instance Data.Aeson.Types.FromJSON.FromJSONKey Aura.Types.PkgName
instance Data.Aeson.Types.ToJSON.ToJSONKey Aura.Types.PkgName
instance Aura.Types.Flagable Aura.Types.PkgName
instance GHC.Generics.Generic Aura.Types.PkgName
instance GHC.Show.Show Aura.Types.PkgName
instance GHC.Classes.Ord Aura.Types.PkgName
instance GHC.Classes.Eq Aura.Types.PkgName
instance GHC.Generics.Generic Aura.Types.User
instance GHC.Show.Show Aura.Types.User
instance GHC.Classes.Eq Aura.Types.User
instance GHC.Show.Show Aura.Types.Language
instance GHC.Classes.Ord Aura.Types.Language
instance GHC.Enum.Bounded Aura.Types.Language
instance GHC.Enum.Enum Aura.Types.Language
instance GHC.Classes.Eq Aura.Types.Language
instance GHC.Generics.Generic Aura.Types.Pkgbuild
instance GHC.Show.Show Aura.Types.Pkgbuild
instance GHC.Classes.Ord Aura.Types.Pkgbuild
instance GHC.Classes.Eq Aura.Types.Pkgbuild
instance GHC.Generics.Generic Aura.Types.PackagePath
instance GHC.Classes.Eq Aura.Types.PackagePath
instance GHC.Classes.Ord Aura.Types.VersionDemand
instance GHC.Classes.Eq Aura.Types.VersionDemand
instance GHC.Classes.Ord Aura.Types.Package
instance GHC.Exception.Type.Exception Aura.Types.Failure
instance GHC.Show.Show Aura.Types.Failure
instance GHC.Classes.Ord Aura.Types.PackagePath
instance GHC.Show.Show Aura.Types.VersionDemand
instance Aura.Types.Flagable Data.Text.Internal.Text
instance (Data.Foldable.Foldable f, Aura.Types.Flagable a) => Aura.Types.Flagable (f a)


-- | Definition of the runtime environment.
module Aura.Settings

-- | The global settings as set by the user with command-line flags.
data Settings
Settings :: !Manager -> !Environment -> !Language -> !FilePath -> !Bool -> !Set PkgName -> !CommonConfig -> !BuildConfig -> !LogFunc -> Settings
[managerOf] :: Settings -> !Manager
[envOf] :: Settings -> !Environment
[langOf] :: Settings -> !Language
[editorOf] :: Settings -> !FilePath
[isTerminal] :: Settings -> !Bool
[ignoresOf] :: Settings -> !Set PkgName
[commonConfigOf] :: Settings -> !CommonConfig
[buildConfigOf] :: Settings -> !BuildConfig
[logFuncOf] :: Settings -> !LogFunc

-- | Settings unique to the AUR package building process.
data BuildConfig
BuildConfig :: !Set Makepkg -> !Path Absolute -> !Maybe User -> !Truncation -> !Set BuildSwitch -> BuildConfig
[makepkgFlagsOf] :: BuildConfig -> !Set Makepkg
[buildPathOf] :: BuildConfig -> !Path Absolute
[buildUserOf] :: BuildConfig -> !Maybe User
[truncationOf] :: BuildConfig -> !Truncation
[buildSwitchesOf] :: BuildConfig -> !Set BuildSwitch

-- | Extra options for customizing the build process.
data BuildSwitch
DeleteMakeDeps :: BuildSwitch
DiffPkgbuilds :: BuildSwitch
DontSuppressMakepkg :: BuildSwitch
DryRun :: BuildSwitch
HotEdit :: BuildSwitch
LowVerbosity :: BuildSwitch
RebuildDevel :: BuildSwitch
SortAlphabetically :: BuildSwitch
UseCustomizepkg :: BuildSwitch
ForceBuilding :: BuildSwitch
NoPkgbuildCheck :: BuildSwitch

-- | Is some Aura-specific setting turned on for this run?
switch :: Settings -> BuildSwitch -> Bool

-- | How <tt>-As</tt> should truncate its results.
data Truncation
None :: Truncation
Head :: Word -> Truncation
Tail :: Word -> Truncation

-- | Unless otherwise specified, packages will be built within
--   <tt>/tmp</tt>.
defaultBuildDir :: Path Absolute

-- | Flags that are common to both Aura and Pacman. Aura will react to
--   them, but also pass them through to <tt>pacman</tt> calls if
--   necessary.
data CommonConfig
CommonConfig :: !Either (Path Absolute) (Path Absolute) -> !Either (Path Absolute) (Path Absolute) -> !Either (Path Absolute) (Path Absolute) -> !Set CommonSwitch -> CommonConfig
[cachePathOf] :: CommonConfig -> !Either (Path Absolute) (Path Absolute)
[configPathOf] :: CommonConfig -> !Either (Path Absolute) (Path Absolute)
[logPathOf] :: CommonConfig -> !Either (Path Absolute) (Path Absolute)
[commonSwitchesOf] :: CommonConfig -> !Set CommonSwitch

-- | Yes/No-style switches that are common to both Aura and Pacman. Aura
--   acts on them first, then passes them down to <tt>pacman</tt> if
--   necessary.
data CommonSwitch
NoConfirm :: CommonSwitch
NeededOnly :: CommonSwitch
Debug :: CommonSwitch
Colour :: ColourMode -> CommonSwitch
Overwrite :: Text -> CommonSwitch

-- | Matches Pacman's colour options. <a>Auto</a> will ensure that text
--   will only be coloured when the output target is a terminal.
data ColourMode
Never :: ColourMode
Always :: ColourMode
Auto :: ColourMode

-- | Is some Aura/Pacman common setting turned on for this run?
shared :: Settings -> CommonSwitch -> Bool

-- | CLI flags that will be passed down to <tt>makepkg</tt> when building
--   packages.
data Makepkg
IgnoreArch :: Makepkg
AllSource :: Makepkg
SkipInteg :: Makepkg
instance GHC.Generics.Generic Aura.Settings.Settings
instance GHC.Show.Show Aura.Settings.BuildConfig
instance GHC.Show.Show Aura.Settings.BuildSwitch
instance GHC.Classes.Ord Aura.Settings.BuildSwitch
instance GHC.Classes.Eq Aura.Settings.BuildSwitch
instance GHC.Generics.Generic Aura.Settings.CommonConfig
instance GHC.Show.Show Aura.Settings.CommonConfig
instance GHC.Show.Show Aura.Settings.CommonSwitch
instance GHC.Classes.Ord Aura.Settings.CommonSwitch
instance GHC.Classes.Eq Aura.Settings.CommonSwitch
instance GHC.Show.Show Aura.Settings.ColourMode
instance GHC.Classes.Ord Aura.Settings.ColourMode
instance GHC.Classes.Eq Aura.Settings.ColourMode
instance GHC.Show.Show Aura.Settings.Makepkg
instance GHC.Classes.Ord Aura.Settings.Makepkg
instance GHC.Classes.Eq Aura.Settings.Makepkg
instance GHC.Show.Show Aura.Settings.Truncation
instance GHC.Classes.Eq Aura.Settings.Truncation
instance Aura.Types.Flagable Aura.Settings.CommonConfig
instance Aura.Types.Flagable Aura.Settings.CommonSwitch
instance Aura.Types.Flagable Aura.Settings.ColourMode
instance Aura.Types.Flagable Aura.Settings.Makepkg


-- | Diffing files.
module Aura.Diff

-- | Given two filepaths, output the diff of the two files. Output will be
--   coloured unless colour is deactivated by `--color never` or by
--   detection of a non-terminal output target.
diff :: MonadIO m => Settings -> Path Absolute -> Path Absolute -> m ()


module Aura.Pkgbuild.Base

-- | The default location: /var/cache/aura/pkgbuilds/
pkgbuildCache :: Path Absolute

-- | The expected path to a stored PKGBUILD, given some package name.
pkgbuildPath :: PkgName -> Path Absolute


-- | Handle the storing of PKGBUILDs.
module Aura.Pkgbuild.Records

-- | Does a given package has a PKGBUILD stored? This is <a>True</a> when a
--   package has been built successfully once before.
hasPkgbuildStored :: PkgName -> IO Bool

-- | Write the PKGBUILDs of some <a>Buildable</a>s to disk.
storePkgbuilds :: NESet Buildable -> IO ()


-- | The various fields for <tt>-Ai</tt> output.
module Aura.Languages.Fields


-- | All output strings that a user can be shown. All normal restrictions
--   on line length do not apply for this file, and this file only.
module Aura.Languages


-- | Analyse PKGBUILDs for potentially malicious bash code.
module Aura.Pkgbuild.Security

-- | A bash term which should never appear in a PKGBUILD. If one does, it's
--   either a sign of maintainer negligence or malicious behaviour.
data BannedTerm
BannedTerm :: Text -> BanCategory -> BannedTerm

-- | The reason why the bash term is black-listed.
data BanCategory
Downloading :: BanCategory
ScriptRunning :: BanCategory
Permissions :: BanCategory
InlinedBash :: BanCategory
StrangeBashism :: BanCategory
CleverRedirect :: BanCategory

-- | Attempt to parse a PKGBUILD. Should succeed for all reasonable
--   PKGBUILDs.
parsedPB :: Pkgbuild -> Maybe List

-- | Discover any banned terms lurking in a parsed PKGBUILD, paired with
--   the surrounding context lines.
bannedTerms :: List -> [(ShellCommand, BannedTerm)]

-- | Dispatch different error messages depending on the category of a
--   <a>BannedTerm</a>.
reportExploit :: BannedTerm -> Language -> Doc AnsiStyle
instance GHC.Generics.Generic Aura.Pkgbuild.Security.BannedTerm
instance GHC.Show.Show Aura.Pkgbuild.Security.BannedTerm
instance GHC.Classes.Ord Aura.Pkgbuild.Security.BannedTerm
instance GHC.Classes.Eq Aura.Pkgbuild.Security.BannedTerm
instance GHC.Show.Show Aura.Pkgbuild.Security.BanCategory
instance GHC.Classes.Ord Aura.Pkgbuild.Security.BanCategory
instance GHC.Classes.Eq Aura.Pkgbuild.Security.BanCategory


-- | An interface to <tt>pacman</tt>. Takes any pacman arguments and
--   applies it to pacman through the shell.
module Aura.Pacman

-- | Run a pacman action that may fail.
pacman :: [Text] -> IO ()

-- | Runs pacman silently and returns only the stdout.
pacmanOutput :: [Text] -> IO ByteString

-- | Run some <a>pacman</a> process, but only care about whether it
--   succeeded.
pacmanSuccess :: [Text] -> IO Bool

-- | Runs pacman silently and returns the stdout as UTF8-decoded
--   <a>Text</a> lines.
pacmanLines :: [Text] -> IO [Text]

-- | Default location of the pacman database lock file:
--   /var/lib/pacman/db.lck
lockFile :: Path Absolute

-- | Default location of the pacman config file: /etc/pacman.conf
pacmanConfFile :: Path Absolute

-- | Default location of the pacman log flie: /var/log/pacman.log
defaultLogFile :: Path Absolute

-- | Fetches the <tt>CacheDir</tt> entry from the config, if it's there.
getCachePath :: Config -> Maybe (Path Absolute)

-- | Fetches the <tt>LogFile</tt> entry from the config, if it's there.
getLogFilePath :: Config -> Maybe (Path Absolute)

-- | The (meaningful) contents of the Pacman config file.
newtype Config
Config :: Map Text [Text] -> Config

-- | Parse a <a>Config</a>, the pacman configuration file.
config :: Parsec Void Text Config

-- | Given a filepath to the pacman config, try to parse its contents.
getPacmanConf :: Path Absolute -> IO (Either Failure Config)

-- | Fetches the <tt>IgnorePkg</tt> entry from the config, if it's there.
getIgnoredPkgs :: Config -> Set PkgName

-- | Fetches the <tt>IgnoreGroup</tt> entry from the config, if it's there.
getIgnoredGroups :: Config -> Set PkgGroup

-- | Given a <a>Set</a> of package groups, yield all the packages they
--   contain.
groupPackages :: NESet PkgGroup -> IO (Set PkgName)

-- | Yields the lines given by `pacman -V` with the pacman image stripped.
versionInfo :: IO [Text]

-- | The amount of whitespace before text in the lines given by `pacman -V`
verMsgPad :: Int
instance GHC.Show.Show Aura.Pacman.Config


-- | Reading and searching the package cache.
module Aura.Cache

-- | Every package in the current cache, paired with its original filename.
newtype Cache
Cache :: Map SimplePkg PackagePath -> Cache
[_cache] :: Cache -> Map SimplePkg PackagePath

-- | Given a path to the package cache, yields its contents in a usable
--   form.
cacheContents :: Path Absolute -> IO Cache

-- | The default location of the package cache: /var/cache/pacman/pkg/
defaultPackageCache :: Path Absolute

-- | Any entries (filepaths) in the cache that match a given <a>Text</a>.
cacheMatches :: Settings -> Text -> IO [PackagePath]

-- | All packages from a given <a>Set</a> who have a copy in the cache.
pkgsInCache :: Settings -> NESet PkgName -> IO (Set PkgName)


-- | Utility functions specific to Aura.
module Aura.Utils

-- | For regex-like find-and-replace in some <a>Text</a>.
data Pattern
Pattern :: Text -> Text -> Pattern
[_pattern] :: Pattern -> Text
[_target] :: Pattern -> Text

-- | Replaces a (p)attern with a (t)arget in a line if possible.
replaceByPatt :: [Pattern] -> Text -> Text

-- | Find lines which contain some given <a>Text</a>.
searchLines :: Text -> [Text] -> [Text]

-- | Assumes the given URL is correctly formatted.
urlContents :: Manager -> String -> IO (Maybe ByteString)

-- | Code borrowed from `ansi-terminal` library by Max Bolingbroke.
csi :: [Int] -> ByteString -> ByteString

-- | Terminal code for raising the cursor.
cursorUpLineCode :: Int -> ByteString

-- | Hide the cursor in a terminal.
hideCursor :: IO ()

-- | Restore a cursor to visiblity in the terminal.
showCursor :: IO ()

-- | Raise the cursor by <tt>n</tt> lines.
raiseCursorBy :: Int -> IO ()

-- | This will get the true user name regardless of sudo-ing.
getTrueUser :: Environment -> Maybe User

-- | <tt>vi</tt> is a sensible default, it should be installed by on any
--   Arch system.
getEditor :: Environment -> FilePath

-- | This will get the locale variable for translations from the
--   environment
getLocale :: Environment -> Text

-- | Is the user root, or using sudo?
hasRootPriv :: Environment -> Bool

-- | Is the current user of Aura the true <tt>root</tt> user, and not just
--   a sudo user?
isTrueRoot :: Environment -> Bool

-- | Mark some <a>Path</a> as being owned by a <a>User</a>.
chown :: MonadIO m => User -> Path Absolute -> [String] -> m ()

-- | If a file exists, it performs action <tt>t</tt> on the argument. | If
--   the file doesn't exist, it performs <tt>f</tt> and returns the
--   argument.
ifFile :: MonadIO m => (a -> m a) -> m b -> Path Absolute -> a -> m a

-- | Print a <a>Doc</a> with Aura flair after performing a
--   <a>colourCheck</a>.
putStrLnA :: Settings -> Doc AnsiStyle -> IO ()
putText :: Text -> IO ()
putTextLn :: Text -> IO ()

-- | Strip colours from a <a>Doc</a> if <tt>--color=never</tt> is
--   specified, or if the output target isn't a terminal.
colourCheck :: Settings -> Doc ann -> Doc ann

-- | Format two lists into two nice rows a la `-Qi` or `-Si`.
entrify :: Settings -> [Text] -> [Doc AnsiStyle] -> Doc AnsiStyle

-- | Doesn't prompt when `--noconfirm` is used.
optionalPrompt :: Settings -> (Language -> Doc AnsiStyle) -> IO Bool

-- | Given a number of selections, allows the user to choose one.
getSelection :: Foldable f => (a -> Text) -> f a -> IO a

-- | <a>maybe</a> with the function at the end.
maybe' :: b -> Maybe a -> (a -> b) -> b

-- | Borrowed from Compactable.
fmapEither :: (a -> Either b c) -> [a] -> ([b], [c])

-- | Borrowed from Compactable.
traverseEither :: Applicative f => (a -> f (Either b c)) -> [a] -> f ([b], [c])

-- | Break a list into groups of <tt>n</tt> elements. The last item in the
--   result is not guaranteed to have the same length as the others.
groupsOf :: Int -> [a] -> [[a]]


-- | Query the AUR for a package's PKGBUILD.
module Aura.Pkgbuild.Fetch

-- | The PKGBUILD of a given package, retrieved from the AUR servers.
getPkgbuild :: Manager -> PkgName -> IO (Maybe Pkgbuild)

-- | The location of a given package's PKGBUILD on the AUR servers.
pkgbuildUrl :: String -> String


-- | For handling the editing of PKGBUILDs.
module Aura.Pkgbuild.Editing

-- | Allow the user to edit the PKGBUILD if they asked to do so.
hotEdit :: Settings -> Buildable -> IO Buildable


-- | Interface to <a>makepkg</a>.
module Aura.MakePkg

-- | Given the current user name, build the package of whatever directory
--   we're in.
makepkg :: Settings -> User -> IO (Either Failure (NESet (Path Absolute)))

-- | Make a source package. See `man makepkg` and grep for `--allsource`.
makepkgSource :: User -> IO [Path Absolute]

-- | The default location of the makepkg configuration: /etc/makepkg.conf
makepkgConfFile :: Path Absolute


-- | Print an animated AURA version message.
module Aura.Logo

-- | Show an animated version message, but only when the output target is a
--   terminal.
animateVersionMsg :: Settings -> Text -> [Text] -> IO ()
instance GHC.Classes.Eq Aura.Logo.MouthState


-- | Core types and functions which belong nowhere else.
module Aura.Core

-- | The complete Aura runtime environment. <a>Repository</a> has internal
--   caches instantiated in <a>IO</a>, while <a>Settings</a> is mostly
--   static and derived from command-line arguments.
data Env
Env :: !Repository -> !Settings -> Env
[repository] :: Env -> !Repository
[settings] :: Env -> !Settings

-- | A <a>Repository</a> is a place where packages may be fetched from.
--   Multiple repositories can be combined with the <a>Semigroup</a>
--   instance. Checks packages in batches for efficiency.
data Repository
Repository :: !TVar (Map PkgName Package) -> (Settings -> NESet PkgName -> IO (Maybe (Set PkgName, Set Package))) -> Repository
[repoCache] :: Repository -> !TVar (Map PkgName Package)
[repoLookup] :: Repository -> Settings -> NESet PkgName -> IO (Maybe (Set PkgName, Set Package))
liftMaybeM :: (MonadThrow m, Exception e) => e -> m (Maybe a) -> m a

-- | Action won't be allowed unless user is root, or using sudo.
sudo :: RIO Env a -> RIO Env a

-- | Stop the user if they are the true root. Building as root isn't
--   allowed since makepkg v4.2.
trueRoot :: RIO Env a -> RIO Env a

-- | A list of non-prebuilt packages installed on the system. `-Qm` yields
--   a list of sorted values.
foreignPackages :: IO (Set SimplePkg)

-- | Packages marked as a dependency, yet are required by no other package.
orphans :: IO (Set PkgName)

-- | Any package whose name is suffixed by git, hg, svn, darcs, cvs, or
--   bzr.
develPkgs :: IO (Set PkgName)

-- | Depedencies which are not installed, or otherwise provided by some
--   installed package.
newtype Unsatisfied
Unsatisfied :: NESet Dep -> Unsatisfied

-- | The opposite of <a>Unsatisfied</a>.
newtype Satisfied
Satisfied :: NESet Dep -> Satisfied

-- | Similar to <tt>isSatisfied</tt>, but dependencies are checked in a
--   batch, since <tt>-T</tt> can accept multiple inputs.
areSatisfied :: NESet Dep -> IO (These Unsatisfied Satisfied)

-- | Returns what it was given if the package is already installed.
--   Reasoning: Using raw bools can be less expressive.
isInstalled :: PkgName -> IO (Maybe PkgName)

-- | Block further action until the database is free.
checkDBLock :: Settings -> IO ()

-- | An <tt>-Rsu</tt> call.
removePkgs :: NESet PkgName -> RIO Env ()

-- | Partition a list of packages into pacman and buildable groups. Yes,
--   this is the correct signature. As far as this function (in isolation)
--   is concerned, there is no way to guarantee that the list of
--   <a>NESet</a>s will itself be non-empty.
partitionPkgs :: NonEmpty (NESet Package) -> ([Prebuilt], [NESet Buildable])

-- | Package a Buildable, running the customization handler first.
packageBuildable :: Settings -> Buildable -> IO Package

-- | Print some message in green with Aura flair.
notify :: Settings -> Doc AnsiStyle -> IO ()

-- | Print some message in yellow with Aura flair.
warn :: Settings -> Doc AnsiStyle -> IO ()

-- | Print some message in red with Aura flair.
scold :: Settings -> Doc AnsiStyle -> IO ()

-- | Report a message with multiple associated items. Usually a list of
--   naughty packages.
report :: (Doc AnsiStyle -> Doc AnsiStyle) -> (Language -> Doc AnsiStyle) -> NonEmpty PkgName -> RIO Env ()
instance GHC.Generics.Generic Aura.Core.Env
instance RIO.Prelude.Logger.HasLogFunc Aura.Core.Env
instance GHC.Base.Semigroup Aura.Core.Repository


-- | Handle the saving and restoring of installed package states.
module Aura.State

-- | All packages installed at some specific <a>ZonedTime</a>. Any "pinned"
--   PkgState will never be deleted by `-Bc`.
data PkgState
PkgState :: !ZonedTime -> !Bool -> !Map PkgName Versioning -> PkgState
[timeOf] :: PkgState -> !ZonedTime
[pinnedOf] :: PkgState -> !Bool
[pkgsOf] :: PkgState -> !Map PkgName Versioning

-- | Save a package state. In writing the first state file, the
--   <tt>states</tt> directory is created automatically.
saveState :: Settings -> IO ()

-- | Does its best to restore a state chosen by the user.
restoreState :: RIO Env ()

-- | Does a given package have an entry in a particular <a>PkgState</a>?
inState :: SimplePkg -> PkgState -> Bool

-- | Given a <a>FilePath</a> to a package state file, attempt to read and
--   parse its contents. As of Aura 2.0, only state files in JSON format
--   are accepted.
readState :: Path Absolute -> IO (Maybe PkgState)

-- | The default location of all saved states: /var/cache/aura/states
stateCache :: Path Absolute

-- | The filepaths of every saved package state.
getStateFiles :: IO [Path Absolute]
instance Data.Aeson.Types.ToJSON.ToJSON Aura.State.PkgState
instance Data.Aeson.Types.FromJSON.FromJSON Aura.State.PkgState


-- | Handle the testing and dependency solving of official repository
--   packages.
module Aura.Packages.Repository

-- | Repository package source. We expect no matches to be found when the
--   package is actually an AUR package.
pacmanRepo :: IO Repository

-- | Parses the version number of a package from the result of a <tt>pacman
--   -Si</tt> call.
extractVersion :: Text -> Maybe Versioning


-- | Module for connecting to the AUR servers, downloading PKGBUILDs and
--   package sources.
module Aura.Packages.AUR

-- | Attempt to retrieve info about a given <a>Set</a> of packages from the
--   AUR.
aurLookup :: Manager -> NESet PkgName -> IO (Maybe (Set PkgName, Set Buildable))

-- | Yield fully realized <a>Package</a>s from the AUR.
aurRepo :: IO Repository

-- | Frontend to the <tt>aur</tt> library. For <tt>-Ai</tt>.
aurInfo :: NonEmpty PkgName -> RIO Env [AurInfo]

-- | Frontend to the <tt>aur</tt> library. For <tt>-As</tt>.
aurSearch :: Text -> RIO Env [AurInfo]

-- | Attempt to clone a package source from the AUR.
clone :: Buildable -> IO (Maybe (Path Absolute))

-- | A package's home URL on the AUR.
pkgUrl :: PkgName -> Text


-- | Library for handling package dependencies and version conflicts.
module Aura.Dependencies

-- | Given some <a>Package</a>s, determine its full dependency graph. The
--   graph is collapsed into layers of packages which are not
--   interdependent, and thus can be built and installed as a group.
--   
--   Deeper layers of the result list (generally) depend on the previous
--   layers.
resolveDeps :: Repository -> NESet Package -> RIO Env (NonEmpty (NESet Package))
instance GHC.Generics.Generic Aura.Dependencies.Resolution


-- | Handle all <tt>-O</tt> flags - those which involve orphan packages.
module Aura.Commands.O

-- | Print the result of <tt>pacman -Qqdt</tt>
displayOrphans :: IO ()

-- | Identical to <tt>-D --asexplicit</tt>.
adoptPkg :: NESet PkgName -> RIO Env ()


-- | Handle all <tt>-L</tt> flags - those which involve the pacman log
--   file.
module Aura.Commands.L

-- | Pipes the pacman log file through a <tt>less</tt> session.
viewLogFile :: RIO Env ()

-- | Print all lines in the log file which contain a given <a>Text</a>.
searchLogFile :: Settings -> Text -> IO ()

-- | The result of <tt>-Li</tt>.
logInfoOnPkg :: NESet PkgName -> RIO Env ()


-- | Handle all <tt>-C</tt> flags - those which involve the package cache.
module Aura.Commands.C

-- | Interactive. Gives the user a choice as to exactly what versions they
--   want to downgrade to.
downgradePackages :: NESet PkgName -> RIO Env ()

-- | Print all package filenames that match a given <a>Text</a>.
searchCache :: Text -> RIO Env ()

-- | The destination folder must already exist for the back-up to begin.
backupCache :: Path Absolute -> RIO Env ()

-- | Keeps a certain number of package files in the cache according to a
--   number provided by the user. The rest are deleted.
cleanCache :: Word -> RIO Env ()

-- | Only package files with a version not in any PkgState will be removed.
cleanNotSaved :: RIO Env ()


-- | Handle all <tt>-B</tt> flags - those which involve saved package
--   states.
module Aura.Commands.B

-- | Save a package state. In writing the first state file, the
--   <tt>states</tt> directory is created automatically.
saveState :: Settings -> IO ()

-- | Does its best to restore a state chosen by the user.
restoreState :: RIO Env ()

-- | Remove all but the newest <tt>n</tt> package states. Any "pinned"
--   states will also remain.
cleanStates :: Settings -> Word -> IO ()

-- | The result of <tt>-Bl</tt>.
listStates :: IO ()


-- | Agnostically builds packages, regardless of original source.
module Aura.Build

-- | Expects files like: /var/cache/pacman/pkg/*.pkg.tar.xz
installPkgFiles :: NESet PackagePath -> RIO Env ()

-- | All building occurs within temp directories, or in a location
--   specified by the user with flags.
buildPackages :: NESet Buildable -> RIO Env (NESet PackagePath)


-- | Layer for AUR package installation. Backend for <a>A</a>.
module Aura.Install

-- | High level <a>install</a> command. Handles installing dependencies.
install :: NESet PkgName -> RIO Env ()

-- | Display dependencies. The result of <tt>-Ad</tt>.
displayPkgDeps :: NESet PkgName -> RIO Env ()


-- | Handle all <tt>-A</tt> flags - those which involve viewing and
--   building packages from the AUR.
module Aura.Commands.A

-- | High level <a>install</a> command. Handles installing dependencies.
install :: NESet PkgName -> RIO Env ()

-- | The result of <tt>-Au</tt>.
upgradeAURPkgs :: Set PkgName -> RIO Env ()

-- | The result of <tt>-Ai</tt>.
aurPkgInfo :: NESet PkgName -> RIO Env ()

-- | The result of <tt>-As</tt>.
aurPkgSearch :: Text -> RIO Env ()

-- | Display dependencies. The result of <tt>-Ad</tt>.
displayPkgDeps :: NESet PkgName -> RIO Env ()

-- | The result of <tt>-Ap</tt>.
displayPkgbuild :: NESet PkgName -> RIO Env ()

-- | Similar to <tt>-Ai</tt>, but yields the raw data as JSON instead.
aurJson :: NESet PkgName -> RIO Env ()

-- | <pre>
--   <a>https://aur.archlinux.org/cgit/aur.git/snapshot/aura-bin.tar.gz</a>
--   </pre>
fetchTarball :: NESet PkgName -> RIO Env ()