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


-- | Core algorithms and datatypes used by vabal
--   
--   `vabal-lib` is the library powering <a>vabal</a>, it provides the
--   tools to analyze a '.cabal' file and check which versions of
--   <a>ghc</a> can comply with the constraints imposed on the following
--   dependencies:
--   
--   <ul>
--   <li><a>base</a></li>
--   <li><a>Cabal</a> (only constraints in the setup-depends stanza are
--   important).</li>
--   </ul>
@package vabal-lib
@version 2.0.0


-- | This module contains the <a>GhcDatabase</a>, which is a Map-like type
--   associating to each ghc version its <a>GhcMetadata</a> informations,
--   and utility functions to to manipulate and query it.
module GhcDatabase

-- | Metadata associated to a GHC version
data GhcMetadata
GhcMetadata :: Version -> Version -> GhcMetadata

-- | base version supported by this GHC
[baseVersion] :: GhcMetadata -> Version

-- | minimum version of Cabal that supports this GHC
[minCabalVersion] :: GhcMetadata -> Version

-- | Map associating to each GHC version its <a>GhcMetadata</a>
data GhcDatabase

-- | The URL from which you can download a ready to be used
--   <a>GhcDatabase</a>
defaultGhcDatabaseURL :: String

-- | <i>O(n*log n)</i>. Create a <a>GhcDatabase</a> from a list key-value
--   pairs.
--   
--   The key is the ghc version, the value is the <a>GhcMetadata</a> for
--   that version
dbFromList :: [(Version, GhcMetadata)] -> GhcDatabase

-- | <i>O(n)</i>. Convert the <a>GhcDatabase</a> to a list of key-value
--   pairs
dbToList :: GhcDatabase -> [(Version, GhcMetadata)]

-- | <i>O(n)</i>. Get all ghc versions contained in the database
ghcVersions :: GhcDatabase -> Set Version

-- | <i>O(1)</i>. Check whether the <a>GhcDatabase</a> is empty
isEmpty :: GhcDatabase -> Bool

-- | <i>O(log n)</i>. Get <a>GhcMetadata</a> for a GHC version, if it's in
--   the database
metadataForGhc :: GhcDatabase -> Version -> Maybe GhcMetadata

-- | <i>O(log n)</i>. Get base version for a GHC version, if it's in the
--   database
baseVersionForGhc :: GhcDatabase -> Version -> Maybe Version

-- | <i>O(log n)</i>. Get Supported Cabal version range for a GHC version,
--   if it's in the databasr
cabalLibRangeForGhc :: GhcDatabase -> Version -> Maybe VersionRange

-- | <i>O(log n)</i>. Check whether the database contains a GHC version
hasGhcVersion :: GhcDatabase -> Version -> Bool

-- | <i>O(log n)</i>. Get newest GHC (and its metadata) found in the
--   database
newest :: GhcDatabase -> Maybe (Version, GhcMetadata)

-- | Parse a <a>GhcDatabase</a> from a csv string. The format of the csv
--   string must be the following:
--   
--   The first line is the header, it is expected to contain these three
--   columns: ghcVersion, baseVersion, minCabalVersion Each line must at
--   least contain values for those three columns.
--   
--   A simple example:
--   
--   <pre>
--   ghcVersion,baseVersion,minCabalVersion
--   8.6.3,4.12.0.0,2.4
--   </pre>
parseGhcDatabase :: ByteString -> Either String GhcDatabase

-- | <i>O(m*log(n</i>m + 1)), m &lt;= n/. Get a restricted database with
--   only a set of GHC versions
filterGhcVersions :: GhcDatabase -> Set Version -> GhcDatabase

-- | <i>O(m*log(n</i>m + 1)), m &lt;= n/. Exclude all ghc versions in the
--   set from the database
excludeGhcVersions :: GhcDatabase -> Set Version -> GhcDatabase

-- | <i>O(n)</i>. Filter database entries with base version in the given
--   <a>VersionRange</a>
filterBaseVersionIn :: GhcDatabase -> VersionRange -> GhcDatabase

-- | <i>O(n)</i>. Filter database entries with supported Cabal version
--   range in the given <a>VersionRange</a>
filterMinCabalVersionIn :: GhcDatabase -> VersionRange -> GhcDatabase
instance Data.Csv.Conversion.FromNamedRecord GhcDatabase.MetadataEntry


-- | This is the central package of vabal-lib, it contains the functions to
--   analyze a cabal package and determine which versions of ghc can comply
--   with the constraints imposed on the following dependencies:
--   
--   <ul>
--   <li>base</li>
--   <li>Cabal (only constraints in the setup-depends stanza are
--   important)</li>
--   </ul>
module PackageSolver

-- | <a>analyzePackage</a> uses the provided flag assignment to configure
--   the package description. It returns a set of all ghc versions found in
--   the <a>GhcDatabase</a> that satisfy the base and Cabal (only Cabal in
--   setup-depends is considered) constraints.
analyzePackage :: FlagAssignment -> GhcDatabase -> GenericPackageDescription -> Set Version

-- | <a>doesGhcVersionSupportPackage</a> checks that the provided compiler
--   version is able to comply with the constraints of base and Cabal (only
--   Cabal in setup-depends is considered) of the package.
doesGhcVersionSupportPackage :: FlagAssignment -> GhcDatabase -> GenericPackageDescription -> Version -> Bool