-- | Convenience hooks for writing custom @Setup.hs@ files for
-- bindings.
module Data.GI.CodeGen.CabalHooks
    ( setupBinding
    , setupCompatWrapper
    , configureDryRun
    , TaggedOverride(..)
    , TaggedPkgConfigVersions(..)
    ) where

import qualified Distribution.ModuleName as MN
import Distribution.Simple.LocalBuildInfo
import Distribution.Simple.Setup
import Distribution.Simple (UserHooks(..), simpleUserHooks,
                            defaultMainWithHooks, OptimisationLevel(..))
import Distribution.PackageDescription

import Data.GI.CodeGen.API (loadGIRInfo, GIRInfo(girPCPackages))
import Data.GI.CodeGen.Code (genCode, writeModuleTree, listModuleTree,
                             ModuleInfo, transitiveModuleDeps)
import Data.GI.CodeGen.CodeGen (genModule)
import Data.GI.CodeGen.Config (Config(..))
import Data.GI.CodeGen.LibGIRepository (setupTypelibSearchPath)
import Data.GI.CodeGen.ModulePath (toModulePath)
import Data.GI.CodeGen.Overrides (parseOverrides, girFixups,
                                  filterAPIsAndDeps)
import Data.GI.CodeGen.PkgConfig (pkgConfigModVersions,
                                  TaggedPkgConfigVersions(..))
import Data.GI.CodeGen.Util (utf8ReadFile, utf8WriteFile, ucFirst, splitOn)

import System.Directory (createDirectoryIfMissing)
import System.FilePath (joinPath, takeDirectory, (</>))

import Control.Monad (forM)

import Data.Maybe (fromJust, fromMaybe)
import qualified Data.Map as M
#if !MIN_VERSION_base(4,11,0)
import Data.Monoid ((<>))
#endif
import qualified Data.Set as S
import Data.Text (Text)
import qualified Data.Text as T

type ConfHook = (GenericPackageDescription, HookedBuildInfo) -> ConfigFlags
              -> IO LocalBuildInfo

-- | Included overrides file.
data TaggedOverride =
  TaggedOverride { TaggedOverride -> Text
overrideTag   :: Text
                   -- ^ Tag for the override, for error reporting purposes.
                 , TaggedOverride -> Text
overrideText  :: Text
                 }

-- | Generate the code for the given module. We also return the
-- pkg-config packages listed in the GIR file for the module.
genModuleCode :: Text -- ^ name
              -> Text -- ^ version
              -> Text -- ^ pkgName
              -> Text -- ^ pkgVersion
              -> Bool -- ^ verbose
              -> [TaggedOverride] -- ^ Explicit overrides
              -> [TaggedPkgConfigVersions] -- ^ Versions recorded
                                           -- by the dependencies
              -> IO (ModuleInfo, [Text])
genModuleCode :: Text
-> Text
-> Text
-> Text
-> Bool
-> [TaggedOverride]
-> [TaggedPkgConfigVersions]
-> IO (ModuleInfo, [Text])
genModuleCode Text
name Text
version Text
pkgName Text
pkgVersion Bool
verbosity [TaggedOverride]
overrides [TaggedPkgConfigVersions]
depVersions = do
  [[Char]] -> IO ()
setupTypelibSearchPath []

  parsed <- [TaggedOverride]
-> (TaggedOverride -> IO Overrides) -> IO [Overrides]
forall (t :: * -> *) (m :: * -> *) a b.
(Traversable t, Monad m) =>
t a -> (a -> m b) -> m (t b)
forM [TaggedOverride]
overrides ((TaggedOverride -> IO Overrides) -> IO [Overrides])
-> (TaggedOverride -> IO Overrides) -> IO [Overrides]
forall a b. (a -> b) -> a -> b
$ \(TaggedOverride Text
tag Text
ovText) -> do
    Text -> IO (Either Text Overrides)
parseOverrides Text
ovText IO (Either Text Overrides)
-> (Either Text Overrides -> IO Overrides) -> IO Overrides
forall a b. IO a -> (a -> IO b) -> IO b
forall (m :: * -> *) a b. Monad m => m a -> (a -> m b) -> m b
>>= \case
      Left Text
err -> [Char] -> IO Overrides
forall a. HasCallStack => [Char] -> a
error ([Char] -> IO Overrides) -> [Char] -> IO Overrides
forall a b. (a -> b) -> a -> b
$ [Char]
"Error when parsing overrides file \""
                  [Char] -> [Char] -> [Char]
forall a. Semigroup a => a -> a -> a
<> Text -> [Char]
T.unpack Text
tag [Char] -> [Char] -> [Char]
forall a. Semigroup a => a -> a -> a
<> [Char]
"\":"
                  [Char] -> [Char] -> [Char]
forall a. Semigroup a => a -> a -> a
<> Text -> [Char]
T.unpack Text
err
      Right Overrides
ovs -> Overrides -> IO Overrides
forall a. a -> IO a
forall (m :: * -> *) a. Monad m => a -> m a
return Overrides
ovs

  let ovs = [Overrides] -> Overrides
forall a. Monoid a => [a] -> a
mconcat [Overrides]
parsed

  (gir, girDeps) <- loadGIRInfo verbosity name (Just version) [] (girFixups ovs)
                                   pkgName depVersions
  let (apis, deps) = filterAPIsAndDeps ovs gir girDeps
      allAPIs = Map Name API -> Map Name API -> Map Name API
forall k a. Ord k => Map k a -> Map k a -> Map k a
M.union Map Name API
apis Map Name API
deps
      cfg = Config {modName :: Text
modName = Text
name,
                    modVersion :: Text
modVersion = Text
version,
                    ghcPkgName :: Text
ghcPkgName = Text
pkgName,
                    ghcPkgVersion :: Text
ghcPkgVersion = Text
pkgVersion,
                    verbose :: Bool
verbose = Bool
verbosity,
                    overrides :: Overrides
overrides = Overrides
ovs}

  return (genCode cfg allAPIs (toModulePath name) (genModule apis),
          girPCPackages gir)

-- | Write a module containing information about the configuration for
-- the package.
genConfigModule :: Maybe FilePath -> Text -> Maybe TaggedOverride ->
                   M.Map Text Text -> [Text] -> IO ()
genConfigModule :: Maybe [Char]
-> Text -> Maybe TaggedOverride -> Map Text Text -> [Text] -> IO ()
genConfigModule Maybe [Char]
outputDir Text
modName Maybe TaggedOverride
maybeGiven Map Text Text
pcVersions [Text]
modules = do
  let fname :: [Char]
fname = [[Char]] -> [Char]
joinPath [ [Char] -> Maybe [Char] -> [Char]
forall a. a -> Maybe a -> a
fromMaybe [Char]
"" Maybe [Char]
outputDir
                       , [Char]
"GI"
                       , Text -> [Char]
T.unpack (Text -> Text
ucFirst Text
modName)
                       , [Char]
"Config.hs" ]
      dirname :: [Char]
dirname = [Char] -> [Char]
takeDirectory [Char]
fname

  Bool -> [Char] -> IO ()
createDirectoryIfMissing Bool
True [Char]
dirname

  [Char] -> Text -> IO ()
utf8WriteFile [Char]
fname (Text -> IO ()) -> Text -> IO ()
forall a b. (a -> b) -> a -> b
$ [Text] -> Text
T.unlines
    [ Text
"{-# LANGUAGE OverloadedStrings #-}"
    , Text
"-- | Build time configuration used during code generation."
    , Text
"module GI." Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> Text -> Text
ucFirst Text
modName Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> Text
".Config ( overrides, modules, pkgConfigVersions ) where"
    , Text
""
    , Text
"import qualified Data.Map as M"
    , Text
"import qualified Data.Text as T"
    , Text
"import Data.Text (Text)"
    , Text
""
    , Text
"-- | Overrides used when generating these bindings."
    , Text
"overrides :: Text"
    , Text
"overrides = T.unlines"
    , [Text] -> Text
forall a. Show a => [a] -> Text
formatList (Maybe TaggedOverride -> [Text]
overrides Maybe TaggedOverride
maybeGiven)
    , Text
""
    , Text
"-- | Modules in this package"
    , Text
"modules :: [Text]"
    , Text
"modules = " Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<>
      [Text] -> Text
forall a. Show a => [a] -> Text
formatList ((Text
"GI." Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> Text -> Text
ucFirst Text
modName Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> Text
".Config") Text -> [Text] -> [Text]
forall a. a -> [a] -> [a]
: [Text]
modules)
    , Text
""
    , Text
"-- | Versions of the pkg-config packages (as listed in the"
    , Text
"-- introspection data) at the time the bindings were generated."
    , Text
"pkgConfigVersions :: M.Map Text Text"
    , Text
"pkgConfigVersions = M.fromList"
    , [(Text, Text)] -> Text
forall a. Show a => [a] -> Text
formatList (Map Text Text -> [(Text, Text)]
forall k a. Map k a -> [(k, a)]
M.toList Map Text Text
pcVersions)
    ]

  where overrides :: Maybe TaggedOverride -> [Text]
        overrides :: Maybe TaggedOverride -> [Text]
overrides Maybe TaggedOverride
Nothing = []
        overrides (Just (TaggedOverride Text
_ Text
ovText)) = Text -> [Text]
T.lines Text
ovText

        formatList :: Show a => [a] -> Text
        formatList :: forall a. Show a => [a] -> Text
formatList [a]
l = Text
" [ "
                       Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> Text -> [Text] -> Text
T.intercalate Text
"\n , " ((a -> Text) -> [a] -> [Text]
forall a b. (a -> b) -> [a] -> [b]
map ([Char] -> Text
T.pack ([Char] -> Text) -> (a -> [Char]) -> a -> Text
forall b c a. (b -> c) -> (a -> b) -> a -> c
. a -> [Char]
forall a. Show a => a -> [Char]
show) [a]
l)
                       Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> Text
"]"

-- | A convenience helper for `confHook`, such that bindings for the
-- given module are generated in the @configure@ step of @cabal@.
confCodeGenHook :: Text -- ^ name
                -> Text -- ^ version
                -> Text -- ^ pkgName
                -> Text -- ^ pkgVersion
                -> Bool -- ^ verbose
                -> Maybe FilePath -- ^ overrides file
                -> [TaggedOverride] -- ^ other overrides
                -> [TaggedPkgConfigVersions] -- ^ dependency versions
                -> Maybe FilePath -- ^ output dir
                -> ConfHook -- ^ previous `confHook`
                -> ConfHook
confCodeGenHook :: Text
-> Text
-> Text
-> Text
-> Bool
-> Maybe [Char]
-> [TaggedOverride]
-> [TaggedPkgConfigVersions]
-> Maybe [Char]
-> ConfHook
-> ConfHook
confCodeGenHook Text
name Text
version Text
pkgName Text
pkgVersion Bool
verbosity
                Maybe [Char]
overridesFile [TaggedOverride]
inheritedOverrides [TaggedPkgConfigVersions]
depVersions Maybe [Char]
outputDir
                ConfHook
defaultConfHook (GenericPackageDescription
gpd, HookedBuildInfo
hbi) ConfigFlags
flags = do

  givenOvs <- ([Char] -> IO TaggedOverride)
-> Maybe [Char] -> IO (Maybe TaggedOverride)
forall (t :: * -> *) (f :: * -> *) a b.
(Traversable t, Applicative f) =>
(a -> f b) -> t a -> f (t b)
forall (f :: * -> *) a b.
Applicative f =>
(a -> f b) -> Maybe a -> f (Maybe b)
traverse (\[Char]
fname -> Text -> Text -> TaggedOverride
TaggedOverride ([Char] -> Text
T.pack [Char]
fname) (Text -> TaggedOverride) -> IO Text -> IO TaggedOverride
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> [Char] -> IO Text
utf8ReadFile [Char]
fname) Maybe [Char]
overridesFile

  let ovs = [TaggedOverride]
-> (TaggedOverride -> [TaggedOverride])
-> Maybe TaggedOverride
-> [TaggedOverride]
forall b a. b -> (a -> b) -> Maybe a -> b
maybe [TaggedOverride]
inheritedOverrides (TaggedOverride -> [TaggedOverride] -> [TaggedOverride]
forall a. a -> [a] -> [a]
:[TaggedOverride]
inheritedOverrides) Maybe TaggedOverride
givenOvs
  (m, pcPackages) <- genModuleCode name version pkgName pkgVersion
                                   verbosity ovs depVersions

  pcVersions <- pkgConfigModVersions pcPackages

  let buildInfo = [Char] -> ModuleName
forall a. IsString a => [Char] -> a
MN.fromString ([Char] -> ModuleName) -> (Text -> [Char]) -> Text -> ModuleName
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Text -> [Char]
T.unpack (Text -> ModuleName) -> Text -> ModuleName
forall a b. (a -> b) -> a -> b
$ Text
"GI." Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> Text -> Text
ucFirst Text
name Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> Text
".Config"
      em' = ModuleName
buildInfo ModuleName -> [ModuleName] -> [ModuleName]
forall a. a -> [a] -> [a]
: (Text -> ModuleName) -> [Text] -> [ModuleName]
forall a b. (a -> b) -> [a] -> [b]
map ([Char] -> ModuleName
forall a. IsString a => [Char] -> a
MN.fromString ([Char] -> ModuleName) -> (Text -> [Char]) -> Text -> ModuleName
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Text -> [Char]
T.unpack) (ModuleInfo -> [Text]
listModuleTree ModuleInfo
m)
      lib = ((CondTree ConfVar [Dependency] Library -> Library
forall v c a. CondTree v c a -> a
condTreeData (CondTree ConfVar [Dependency] Library -> Library)
-> (GenericPackageDescription
    -> CondTree ConfVar [Dependency] Library)
-> GenericPackageDescription
-> Library
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Maybe (CondTree ConfVar [Dependency] Library)
-> CondTree ConfVar [Dependency] Library
forall a. HasCallStack => Maybe a -> a
fromJust (Maybe (CondTree ConfVar [Dependency] Library)
 -> CondTree ConfVar [Dependency] Library)
-> (GenericPackageDescription
    -> Maybe (CondTree ConfVar [Dependency] Library))
-> GenericPackageDescription
-> CondTree ConfVar [Dependency] Library
forall b c a. (b -> c) -> (a -> b) -> a -> c
. GenericPackageDescription
-> Maybe (CondTree ConfVar [Dependency] Library)
condLibrary) GenericPackageDescription
gpd)
      bi = Library -> BuildInfo
libBuildInfo Library
lib
#if MIN_VERSION_base(4,11,0)
      bi' = BuildInfo
bi {autogenModules = em'}
#else
      bi' = bi
#endif
      lib' = Library
lib {exposedModules = em', libBuildInfo = bi'}
      cL' = ((Maybe (CondTree ConfVar [Dependency] Library)
-> CondTree ConfVar [Dependency] Library
forall a. HasCallStack => Maybe a -> a
fromJust (Maybe (CondTree ConfVar [Dependency] Library)
 -> CondTree ConfVar [Dependency] Library)
-> (GenericPackageDescription
    -> Maybe (CondTree ConfVar [Dependency] Library))
-> GenericPackageDescription
-> CondTree ConfVar [Dependency] Library
forall b c a. (b -> c) -> (a -> b) -> a -> c
. GenericPackageDescription
-> Maybe (CondTree ConfVar [Dependency] Library)
condLibrary) GenericPackageDescription
gpd) {condTreeData = lib'}
      gpd' = GenericPackageDescription
gpd {condLibrary = Just cL'}

  modules <- writeModuleTree verbosity outputDir m

  genConfigModule outputDir name givenOvs pcVersions modules

  lbi <- defaultConfHook (gpd', hbi) flags

  return (lbi {withOptimization = NoOptimisation})

-- | The entry point for @Setup.hs@ files in bindings. The
-- `TaggedPkgConfigVersions` should be taken from the
-- @pkgConfigVersions@ entries of the @GI.<Name>.Config@ modules of the
-- dependencies: if they do not agree with the versions currently
-- reported by pkg-config a warning will be printed, since this
-- typically leads to compilation errors.
setupBinding :: Text -- ^ name
             -> Text -- ^ version
             -> Text -- ^ pkgName
             -> Text -- ^ pkgVersion
             -> Bool -- ^ verbose
             -> Maybe FilePath -- ^ overrides file
             -> [TaggedOverride] -- ^ Explicit overrides
             -> [TaggedPkgConfigVersions] -- ^ Dependency versions
             -> Maybe FilePath -- ^ output dir
             -> IO ()
setupBinding :: Text
-> Text
-> Text
-> Text
-> Bool
-> Maybe [Char]
-> [TaggedOverride]
-> [TaggedPkgConfigVersions]
-> Maybe [Char]
-> IO ()
setupBinding Text
name Text
version Text
pkgName Text
pkgVersion Bool
verbose
             Maybe [Char]
overridesFile [TaggedOverride]
overrides [TaggedPkgConfigVersions]
depVersions Maybe [Char]
outputDir =
    UserHooks -> IO ()
defaultMainWithHooks (UserHooks
simpleUserHooks {
                            confHook = confCodeGenHook name version
                                       pkgName pkgVersion
                                       verbose
                                       overridesFile overrides
                                       depVersions outputDir
                                       (confHook simpleUserHooks)
                          })

compatGenConfHook :: String -- ^ New version of the package
                  -> [Text] -- ^ The list of modules to re-export
                  -> ConfHook -- ^ previous `confHook`
                  -> ConfHook
compatGenConfHook :: [Char] -> [Text] -> ConfHook -> ConfHook
compatGenConfHook [Char]
newVersion [Text]
modules ConfHook
defaultConfHook (GenericPackageDescription
gpd, HookedBuildInfo
hbi) ConfigFlags
flags = do
  let em' :: [ModuleName]
em' = (Text -> ModuleName) -> [Text] -> [ModuleName]
forall a b. (a -> b) -> [a] -> [b]
map ([Char] -> ModuleName
forall a. IsString a => [Char] -> a
MN.fromString ([Char] -> ModuleName) -> (Text -> [Char]) -> Text -> ModuleName
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Text -> [Char]
T.unpack) [Text]
modules
      lib :: Library
lib = ((CondTree ConfVar [Dependency] Library -> Library
forall v c a. CondTree v c a -> a
condTreeData (CondTree ConfVar [Dependency] Library -> Library)
-> (GenericPackageDescription
    -> CondTree ConfVar [Dependency] Library)
-> GenericPackageDescription
-> Library
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Maybe (CondTree ConfVar [Dependency] Library)
-> CondTree ConfVar [Dependency] Library
forall a. HasCallStack => Maybe a -> a
fromJust (Maybe (CondTree ConfVar [Dependency] Library)
 -> CondTree ConfVar [Dependency] Library)
-> (GenericPackageDescription
    -> Maybe (CondTree ConfVar [Dependency] Library))
-> GenericPackageDescription
-> CondTree ConfVar [Dependency] Library
forall b c a. (b -> c) -> (a -> b) -> a -> c
. GenericPackageDescription
-> Maybe (CondTree ConfVar [Dependency] Library)
condLibrary) GenericPackageDescription
gpd)
      bi :: BuildInfo
bi = Library -> BuildInfo
libBuildInfo Library
lib
#if MIN_VERSION_base(4,11,0)
      bi' :: BuildInfo
bi' = BuildInfo
bi {autogenModules = em'}
#else
      bi' = bi
#endif
      lib' :: Library
lib' = Library
lib {exposedModules = em', libBuildInfo = bi'}
      cL' :: CondTree ConfVar [Dependency] Library
cL' = ((Maybe (CondTree ConfVar [Dependency] Library)
-> CondTree ConfVar [Dependency] Library
forall a. HasCallStack => Maybe a -> a
fromJust (Maybe (CondTree ConfVar [Dependency] Library)
 -> CondTree ConfVar [Dependency] Library)
-> (GenericPackageDescription
    -> Maybe (CondTree ConfVar [Dependency] Library))
-> GenericPackageDescription
-> CondTree ConfVar [Dependency] Library
forall b c a. (b -> c) -> (a -> b) -> a -> c
. GenericPackageDescription
-> Maybe (CondTree ConfVar [Dependency] Library)
condLibrary) GenericPackageDescription
gpd) {condTreeData = lib'}
      gpd' :: GenericPackageDescription
gpd' = GenericPackageDescription
gpd {condLibrary = Just cL'}

  (Text -> IO ()) -> [Text] -> IO ()
forall (t :: * -> *) (m :: * -> *) a b.
(Foldable t, Monad m) =>
(a -> m b) -> t a -> m ()
mapM_ ([Char] -> IO ()
writeCompatModule ([Char] -> IO ()) -> (Text -> [Char]) -> Text -> IO ()
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Text -> [Char]
T.unpack) [Text]
modules

  lbi <- ConfHook
defaultConfHook (GenericPackageDescription
gpd', HookedBuildInfo
hbi) ConfigFlags
flags

  return (lbi {withOptimization = NoOptimisation})

  where
    writeCompatModule :: String -> IO ()
    writeCompatModule :: [Char] -> IO ()
writeCompatModule [Char]
modName = do
      fname <- case [[Char]] -> Maybe ([[Char]], [Char])
forall a. [a] -> Maybe ([a], a)
unsnoc (Char -> [Char] -> [[Char]]
forall a. Eq a => a -> [a] -> [[a]]
splitOn Char
'.' [Char]
modName) of
                 Maybe ([[Char]], [Char])
Nothing -> [Char] -> IO [Char]
forall a. a -> IO a
forall (m :: * -> *) a. Monad m => a -> m a
return ([Char] -> IO [Char]) -> [Char] -> IO [Char]
forall a b. (a -> b) -> a -> b
$ [Char]
modName [Char] -> [Char] -> [Char]
forall a. Semigroup a => a -> a -> a
<> [Char]
".hs"
                 Just ([], [Char]
last) -> [Char] -> IO [Char]
forall a. a -> IO a
forall (m :: * -> *) a. Monad m => a -> m a
return ([Char] -> IO [Char]) -> [Char] -> IO [Char]
forall a b. (a -> b) -> a -> b
$ [Char]
last [Char] -> [Char] -> [Char]
forall a. Semigroup a => a -> a -> a
<> [Char]
".hs"
                 Just ([[Char]]
init, [Char]
last) -> let path :: [Char]
path = [[Char]] -> [Char]
joinPath [[Char]]
init
                                      in do
                                        Bool -> [Char] -> IO ()
createDirectoryIfMissing Bool
True [Char]
path
                                        [Char] -> IO [Char]
forall a. a -> IO a
forall (m :: * -> *) a. Monad m => a -> m a
return ([Char] -> IO [Char]) -> [Char] -> IO [Char]
forall a b. (a -> b) -> a -> b
$ [Char]
path [Char] -> [Char] -> [Char]
</> ([Char]
last [Char] -> [Char] -> [Char]
forall a. Semigroup a => a -> a -> a
<> [Char]
".hs")
      utf8WriteFile fname modContents

      where modContents :: Text
            modContents :: Text
modContents = let
              mod :: Text
mod = [Char] -> Text
T.pack [Char]
modName
              link :: Text
link = Text
"[" Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> [Char] -> Text
T.pack [Char]
newVersion
                     Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> Text
"](https://hackage.haskell.org/package/"
                     Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> [Char] -> Text
T.pack [Char]
newVersion Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> Text
")"
              in [Text] -> Text
T.unlines [
              Text
"{-# LANGUAGE PackageImports #-}"
              , Text
"{- | This is a backwards-compatibility module re-exporting the contents of the "
              , Text
mod Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> Text
" module in the " Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> Text
link Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> Text
" package."
              , Text
""
              , Text
"The link below will take you to the relevant entry in the " Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> Text
link Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> Text
" documentation."
              , Text
"-}"
              , Text
"module " Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> Text
mod Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> Text
" ("
              , Text
"  module X) where"
              , Text
""
              , Text
"import \"" Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> [Char] -> Text
T.pack [Char]
newVersion Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> Text
"\" " Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> Text
mod Text -> Text -> Text
forall a. Semigroup a => a -> a -> a
<> Text
" as X"
              ]

            -- Data.List.unsnoc is relatively recent (base 4.19.0.0),
            -- so we just copy the definition.
            unsnoc :: [a] -> Maybe ([a], a)
            unsnoc :: forall a. [a] -> Maybe ([a], a)
unsnoc = (a -> Maybe ([a], a) -> Maybe ([a], a))
-> Maybe ([a], a) -> [a] -> Maybe ([a], a)
forall a b. (a -> b -> b) -> b -> [a] -> b
forall (t :: * -> *) a b.
Foldable t =>
(a -> b -> b) -> b -> t a -> b
foldr (\a
x -> ([a], a) -> Maybe ([a], a)
forall a. a -> Maybe a
Just (([a], a) -> Maybe ([a], a))
-> (Maybe ([a], a) -> ([a], a)) -> Maybe ([a], a) -> Maybe ([a], a)
forall b c a. (b -> c) -> (a -> b) -> a -> c
. ([a], a) -> (([a], a) -> ([a], a)) -> Maybe ([a], a) -> ([a], a)
forall b a. b -> (a -> b) -> Maybe a -> b
maybe ([], a
x) (\(~([a]
a, a
b)) -> (a
x a -> [a] -> [a]
forall a. a -> [a] -> [a]
: [a]
a, a
b))) Maybe ([a], a)
forall a. Maybe a
Nothing

-- | The entry point for @Setup.hs@ files in compat bindings.
setupCompatWrapper :: String   -- ^ New package
                   -> [Text] -- ^ List of files in the new package
                   -> IO ()
setupCompatWrapper :: [Char] -> [Text] -> IO ()
setupCompatWrapper [Char]
newPackage [Text]
modules =
    UserHooks -> IO ()
defaultMainWithHooks (UserHooks
simpleUserHooks {
                            confHook = compatGenConfHook newPackage modules
                                       (confHook simpleUserHooks)
                          })

-- | Return the list of modules that `setupHaskellGIBinding` would
-- create, together with the set of dependencies loaded while
-- generating the code.
configureDryRun :: Text -- ^ name
                -> Text -- ^ version
                -> Text -- ^ pkgName
                -> Text -- ^ pkgVersion
                -> Maybe FilePath -- ^ Overrides file
                -> [TaggedOverride] -- ^ Other overrides to load
                -> IO ([Text], S.Set Text)
configureDryRun :: Text
-> Text
-> Text
-> Text
-> Maybe [Char]
-> [TaggedOverride]
-> IO ([Text], Set Text)
configureDryRun Text
name Text
version Text
pkgName Text
pkgVersion Maybe [Char]
overridesFile [TaggedOverride]
inheritedOverrides = do
  givenOvs <- ([Char] -> IO TaggedOverride)
-> Maybe [Char] -> IO (Maybe TaggedOverride)
forall (t :: * -> *) (f :: * -> *) a b.
(Traversable t, Applicative f) =>
(a -> f b) -> t a -> f (t b)
forall (f :: * -> *) a b.
Applicative f =>
(a -> f b) -> Maybe a -> f (Maybe b)
traverse (\[Char]
fname -> Text -> Text -> TaggedOverride
TaggedOverride ([Char] -> Text
T.pack [Char]
fname) (Text -> TaggedOverride) -> IO Text -> IO TaggedOverride
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> [Char] -> IO Text
utf8ReadFile [Char]
fname) Maybe [Char]
overridesFile

  let ovs = [TaggedOverride]
-> (TaggedOverride -> [TaggedOverride])
-> Maybe TaggedOverride
-> [TaggedOverride]
forall b a. b -> (a -> b) -> Maybe a -> b
maybe [TaggedOverride]
inheritedOverrides (TaggedOverride -> [TaggedOverride] -> [TaggedOverride]
forall a. a -> [a] -> [a]
:[TaggedOverride]
inheritedOverrides) Maybe TaggedOverride
givenOvs
  (m, _) <- genModuleCode name version pkgName pkgVersion False ovs []

  return (("GI." <> ucFirst name <> ".Config") : listModuleTree m,
           transitiveModuleDeps m)