{-# LANGUAGE DeriveGeneric #-}
module Distribution.Solver.Types.ConstraintSource
    ( ConstraintSource(..)
    , showConstraintSource
    ) where

import Distribution.Solver.Compat.Prelude
import Prelude ()

-- | Source of a 'PackageConstraint'.
data ConstraintSource =

  -- | Main config file, which is ~/.cabal/config by default.
  ConstraintSourceMainConfig FilePath

  -- | Local cabal.project file
  | ConstraintSourceProjectConfig FilePath

  -- | User config file, which is ./cabal.config by default.
  | ConstraintSourceUserConfig FilePath

  -- | Flag specified on the command line.
  | ConstraintSourceCommandlineFlag

  -- | Target specified by the user, e.g., @cabal install package-0.1.0.0@
  -- implies @package==0.1.0.0@.
  | ConstraintSourceUserTarget

  -- | Internal requirement to use installed versions of packages like ghc-prim.
  | ConstraintSourceNonUpgradeablePackage

  -- | Internal constraint used by @cabal freeze@.
  | ConstraintSourceFreeze

  -- | Constraint specified by a config file, a command line flag, or a user
  -- target, when a more specific source is not known.
  | ConstraintSourceConfigFlagOrTarget

  -- | The source of the constraint is not specified.
  | ConstraintSourceUnknown

  -- | An internal constraint due to compatibility issues with the Setup.hs
  -- command line interface requires a minimum lower bound on Cabal
  | ConstraintSetupCabalMinVersion

  -- | An internal constraint due to compatibility issues with the Setup.hs
  -- command line interface requires a maximum upper bound on Cabal
  | ConstraintSetupCabalMaxVersion
  deriving (ConstraintSource -> ConstraintSource -> Bool
(ConstraintSource -> ConstraintSource -> Bool)
-> (ConstraintSource -> ConstraintSource -> Bool)
-> Eq ConstraintSource
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ConstraintSource -> ConstraintSource -> Bool
$c/= :: ConstraintSource -> ConstraintSource -> Bool
== :: ConstraintSource -> ConstraintSource -> Bool
$c== :: ConstraintSource -> ConstraintSource -> Bool
Eq, Int -> ConstraintSource -> ShowS
[ConstraintSource] -> ShowS
ConstraintSource -> String
(Int -> ConstraintSource -> ShowS)
-> (ConstraintSource -> String)
-> ([ConstraintSource] -> ShowS)
-> Show ConstraintSource
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ConstraintSource] -> ShowS
$cshowList :: [ConstraintSource] -> ShowS
show :: ConstraintSource -> String
$cshow :: ConstraintSource -> String
showsPrec :: Int -> ConstraintSource -> ShowS
$cshowsPrec :: Int -> ConstraintSource -> ShowS
Show, (forall x. ConstraintSource -> Rep ConstraintSource x)
-> (forall x. Rep ConstraintSource x -> ConstraintSource)
-> Generic ConstraintSource
forall x. Rep ConstraintSource x -> ConstraintSource
forall x. ConstraintSource -> Rep ConstraintSource x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ConstraintSource x -> ConstraintSource
$cfrom :: forall x. ConstraintSource -> Rep ConstraintSource x
Generic)

instance Binary ConstraintSource
instance Structured ConstraintSource

-- | Description of a 'ConstraintSource'.
showConstraintSource :: ConstraintSource -> String
showConstraintSource :: ConstraintSource -> String
showConstraintSource (ConstraintSourceMainConfig String
path) =
    String
"main config " String -> ShowS
forall a. [a] -> [a] -> [a]
++ String
path
showConstraintSource (ConstraintSourceProjectConfig String
path) =
    String
"project config " String -> ShowS
forall a. [a] -> [a] -> [a]
++ String
path
showConstraintSource (ConstraintSourceUserConfig String
path)= String
"user config " String -> ShowS
forall a. [a] -> [a] -> [a]
++ String
path
showConstraintSource ConstraintSource
ConstraintSourceCommandlineFlag = String
"command line flag"
showConstraintSource ConstraintSource
ConstraintSourceUserTarget = String
"user target"
showConstraintSource ConstraintSource
ConstraintSourceNonUpgradeablePackage =
    String
"non-upgradeable package"
showConstraintSource ConstraintSource
ConstraintSourceFreeze = String
"cabal freeze"
showConstraintSource ConstraintSource
ConstraintSourceConfigFlagOrTarget =
    String
"config file, command line flag, or user target"
showConstraintSource ConstraintSource
ConstraintSourceUnknown = String
"unknown source"
showConstraintSource ConstraintSource
ConstraintSetupCabalMinVersion =
    String
"minimum version of Cabal used by Setup.hs"
showConstraintSource ConstraintSource
ConstraintSetupCabalMaxVersion =
    String
"maximum version of Cabal used by Setup.hs"