-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/
-- | A framework for packaging Haskell software
--
-- The Haskell Common Architecture for Building Applications and
-- Libraries: a framework defining a common interface for authors to more
-- easily build their Haskell applications in a portable way.
--
-- The Haskell Cabal is part of a larger infrastructure for distributing,
-- organizing, and cataloging Haskell libraries and tools.
@package Cabal
@version 3.6.1.0
module Distribution.Compat.Binary
decodeOrFailIO :: Binary a => ByteString -> IO (Either String a)
-- | Lazily reconstruct a value previously written to a file.
decodeFileOrFail' :: Binary a => FilePath -> IO (Either String a)
module Distribution.Compat.CreatePipe
-- | Create a pipe for interprocess communication and return a
-- (readEnd, writeEnd) Handle pair.
createPipe :: IO (Handle, Handle)
module Distribution.Compat.Directory
-- | listDirectory dir returns a list of all entries
-- in dir without the special entries (. and
-- ..).
--
-- The operation may fail with:
--
--
-- - HardwareFault A physical I/O error has occurred.
-- [EIO]
-- - InvalidArgument The operand is not a valid directory
-- name. [ENAMETOOLONG, ELOOP]
-- - isDoesNotExistError The directory does not exist.
-- [ENOENT, ENOTDIR]
-- - isPermissionError The process has insufficient privileges
-- to perform the operation. [EACCES]
-- - isFullError Insufficient resources are available to perform
-- the operation. [EMFILE, ENFILE]
-- - InappropriateType The path refers to an existing
-- non-directory object. [ENOTDIR]
--
listDirectory :: FilePath -> IO [FilePath]
-- | Convert a path into an absolute path. If the given path is relative,
-- the current directory is prepended and then the combined result is
-- normalized. If the path is already absolute, the path is simply
-- normalized. The function preserves the presence or absence of the
-- trailing path separator unless the path refers to the root directory
-- /.
--
-- If the path is already absolute, the operation never fails. Otherwise,
-- the operation may fail with the same exceptions as
-- getCurrentDirectory.
makeAbsolute :: FilePath -> IO FilePath
-- | Test whether the given path points to an existing filesystem object.
-- If the user lacks necessary permissions to search the parent
-- directories, this function may return false even if the file does
-- actually exist.
doesPathExist :: FilePath -> IO Bool
module Distribution.Compat.Exception
-- | Catch IOException.
catchIO :: IO a -> (IOException -> IO a) -> IO a
-- | Catch ExitCode
catchExit :: IO a -> (ExitCode -> IO a) -> IO a
-- | Try IOException.
tryIO :: IO a -> IO (Either IOException a)
-- | Render this exception value in a human-friendly manner.
--
-- Default implementation: show.
displayException :: Exception e => e -> String
module Distribution.Compat.FilePath
-- | Does the given filename have the specified extension?
--
--
-- "png" `isExtensionOf` "/directory/file.png" == True
-- ".png" `isExtensionOf` "/directory/file.png" == True
-- ".tar.gz" `isExtensionOf` "bar/foo.tar.gz" == True
-- "ar.gz" `isExtensionOf` "bar/foo.tar.gz" == False
-- "png" `isExtensionOf` "/directory/file.png.jpg" == False
-- "csv/table.csv" `isExtensionOf` "/data/csv/table.csv" == False
--
isExtensionOf :: String -> FilePath -> Bool
-- | Drop the given extension from a FilePath, and the "."
-- preceding it. Returns Nothing if the FilePath does not have the
-- given extension, or Just and the part before the extension if
-- it does.
--
-- This function can be more predictable than dropExtensions,
-- especially if the filename might itself contain . characters.
--
--
-- stripExtension "hs.o" "foo.x.hs.o" == Just "foo.x"
-- stripExtension "hi.o" "foo.x.hs.o" == Nothing
-- dropExtension x == fromJust (stripExtension (takeExtension x) x)
-- dropExtensions x == fromJust (stripExtension (takeExtensions x) x)
-- stripExtension ".c.d" "a.b.c.d" == Just "a.b"
-- stripExtension ".c.d" "a.b..c.d" == Just "a.b."
-- stripExtension "baz" "foo.bar" == Nothing
-- stripExtension "bar" "foobar" == Nothing
-- stripExtension "" x == Just x
--
stripExtension :: String -> FilePath -> Maybe FilePath
-- | Per Conor McBride, the Newtype typeclass represents the packing
-- and unpacking of a newtype, and allows you to operatate under that
-- newtype with functions such as ala.
module Distribution.Compat.Newtype
-- | The FunctionalDependencies version of Newtype
-- type-class.
--
-- Since Cabal-3.0 class arguments are in a different order than in
-- newtype package. This change is to allow usage with
-- DeriveAnyClass (and DerivingStrategies, in GHC-8.2).
-- Unfortunately one has to repeat inner type.
--
--
-- newtype New = New Old
-- deriving anyclass (Newtype Old)
--
--
-- Another approach would be to use TypeFamilies (and possibly
-- compute inner type using GHC.Generics), but we think
-- FunctionalDependencies version gives cleaner type signatures.
class Newtype o n | n -> o
pack :: Newtype o n => o -> n
pack :: (Newtype o n, Coercible o n) => o -> n
unpack :: Newtype o n => n -> o
unpack :: (Newtype o n, Coercible n o) => n -> o
-- |
-- >>> ala Sum foldMap [1, 2, 3, 4 :: Int]
-- 10
--
--
-- Note: the user supplied function for the newtype is
-- ignored.
--
--
-- >>> ala (Sum . (+1)) foldMap [1, 2, 3, 4 :: Int]
-- 10
--
ala :: (Newtype o n, Newtype o' n') => (o -> n) -> ((o -> n) -> b -> n') -> b -> o'
-- |
-- >>> alaf Sum foldMap length ["cabal", "install"]
-- 12
--
--
-- Note: as with ala, the user supplied function for the
-- newtype is ignored.
alaf :: (Newtype o n, Newtype o' n') => (o -> n) -> ((a -> n) -> b -> n') -> (a -> o) -> b -> o'
-- | Variant of pack, which takes a phantom type.
pack' :: Newtype o n => (o -> n) -> o -> n
-- | Variant of unpack, which takes a phantom type.
unpack' :: Newtype o n => (o -> n) -> n -> o
instance Distribution.Compat.Newtype.Newtype a (Data.Functor.Identity.Identity a)
instance Distribution.Compat.Newtype.Newtype a (Data.Semigroup.Internal.Sum a)
instance Distribution.Compat.Newtype.Newtype a (Data.Semigroup.Internal.Product a)
instance Distribution.Compat.Newtype.Newtype (a -> a) (Data.Semigroup.Internal.Endo a)
module Distribution.Compat.Process
-- | createProcess with process jobs enabled when appropriate. See
-- enableProcessJobs.
createProcess :: CreateProcess -> IO (Maybe Handle, Maybe Handle, Maybe Handle, ProcessHandle)
-- | runInteractiveProcess with process jobs enabled when
-- appropriate. See enableProcessJobs.
runInteractiveProcess :: FilePath -> [String] -> Maybe FilePath -> Maybe [(String, String)] -> IO (Handle, Handle, Handle, ProcessHandle)
-- | rawSystem with process jobs enabled when appropriate. See
-- enableProcessJobs.
rawSystem :: String -> [String] -> IO ExitCode
-- | Enable process jobs to ensure accurate determination of process
-- completion in the presence of exec(3) on Windows.
--
-- Unfortunately the process job support is badly broken in
-- process releases prior to 1.6.9, so we disable it in these
-- versions, despite the fact that this means we may see sporatic build
-- failures without jobs.
enableProcessJobs :: CreateProcess -> CreateProcess
module Distribution.Compat.Stack
type WithCallStack a = HasCallStack => a
-- | CallStacks are a lightweight method of obtaining a partial
-- call-stack at any point in the program.
--
-- A function can request its call-site with the HasCallStack
-- constraint. For example, we can define
--
--
-- putStrLnWithCallStack :: HasCallStack => String -> IO ()
--
--
-- as a variant of putStrLn that will get its call-site and
-- print it, along with the string given as argument. We can access the
-- call-stack inside putStrLnWithCallStack with
-- callStack.
--
--
-- putStrLnWithCallStack :: HasCallStack => String -> IO ()
-- putStrLnWithCallStack msg = do
-- putStrLn msg
-- putStrLn (prettyCallStack callStack)
--
--
-- Thus, if we call putStrLnWithCallStack we will get a
-- formatted call-stack alongside our string.
--
--
-- >>> putStrLnWithCallStack "hello"
-- hello
-- CallStack (from HasCallStack):
-- putStrLnWithCallStack, called at <interactive>:2:1 in interactive:Ghci1
--
--
-- GHC solves HasCallStack constraints in three steps:
--
--
-- - If there is a CallStack in scope -- i.e. the enclosing
-- function has a HasCallStack constraint -- GHC will append the
-- new call-site to the existing CallStack.
-- - If there is no CallStack in scope -- e.g. in the GHCi
-- session above -- and the enclosing definition does not have an
-- explicit type signature, GHC will infer a HasCallStack
-- constraint for the enclosing definition (subject to the monomorphism
-- restriction).
-- - If there is no CallStack in scope and the enclosing
-- definition has an explicit type signature, GHC will solve the
-- HasCallStack constraint for the singleton CallStack
-- containing just the current call-site.
--
--
-- CallStacks do not interact with the RTS and do not require
-- compilation with -prof. On the other hand, as they are built
-- up explicitly via the HasCallStack constraints, they will
-- generally not contain as much information as the simulated call-stacks
-- maintained by the RTS.
--
-- A CallStack is a [(String, SrcLoc)]. The
-- String is the name of function that was called, the
-- SrcLoc is the call-site. The list is ordered with the most
-- recently called function at the head.
--
-- NOTE: The intrepid user may notice that HasCallStack is just an
-- alias for an implicit parameter ?callStack :: CallStack. This
-- is an implementation detail and should not be considered part
-- of the CallStack API, we may decide to change the
-- implementation in the future.
data CallStack
-- | This function is for when you *really* want to add a call stack to
-- raised IO, but you don't have a Verbosity so you can't use
-- annotateIO. If you have a Verbosity, please use that
-- function instead.
annotateCallStackIO :: WithCallStack (IO a -> IO a)
-- | Perform some computation without adding new entries to the
-- CallStack.
withFrozenCallStack :: HasCallStack => (HasCallStack => a) -> a
withLexicalCallStack :: (a -> WithCallStack (IO b)) -> WithCallStack (a -> IO b)
-- | Return the current CallStack.
--
-- Does *not* include the call-site of callStack.
callStack :: HasCallStack => CallStack
-- | Pretty print a CallStack.
prettyCallStack :: CallStack -> String
-- | Give the *parent* of the person who invoked this; so it's most
-- suitable for being called from a utility function. You probably want
-- to call this using withFrozenCallStack; otherwise it's not very
-- useful. We didn't implement this for base-4.8.1 because we cannot rely
-- on freezing to have taken place.
parentSrcLocPrefix :: WithCallStack String
module Distribution.Compat.Typeable
-- | The class Typeable allows a concrete representation of a type
-- to be calculated.
class Typeable (a :: k)
-- | A quantified type representation.
type TypeRep = SomeTypeRep
-- | Takes a value of type a and returns a concrete representation
-- of that type.
typeRep :: forall k proxy (a :: k). Typeable a => proxy a -> TypeRep
-- | Common utils used by modules under Distribution.PackageDescription.*.
module Distribution.PackageDescription.Utils
cabalBug :: String -> a
userBug :: String -> a
module Distribution.Utils.MD5
type MD5 = Fingerprint
-- | Show MD5 in human readable form
--
--
-- >>> showMD5 (Fingerprint 123 456)
-- "000000000000007b00000000000001c8"
--
--
--
-- >>> showMD5 $ md5 $ BS.pack [0..127]
-- "37eff01866ba3f538421b30b7cbefcac"
--
--
-- @since 3.2.0.0
showMD5 :: MD5 -> String
-- | @since 3.2.0.0
md5 :: ByteString -> MD5
-- |
-- >>> showMD5 $ md5FromInteger 0x37eff01866ba3f538421b30b7cbefcac
-- "37eff01866ba3f538421b30b7cbefcac"
--
--
-- Note: the input is truncated:
--
--
-- >>> showMD5 $ md5FromInteger 0x1230000037eff01866ba3f538421b30b7cbefcac
-- "37eff01866ba3f538421b30b7cbefcac"
--
--
-- Yet, negative numbers are not a problem...
--
--
-- >>> showMD5 $ md5FromInteger (-1)
-- "ffffffffffffffffffffffffffffffff"
--
md5FromInteger :: Integer -> MD5
-- | @since 3.2.0.0
binaryPutMD5 :: MD5 -> Put
-- | @since 3.2.0.0
binaryGetMD5 :: Get MD5
-- | Structurally tag binary serialisaton stream. Useful when most
-- Binary instances are Generic derived.
--
-- Say you have a data type
--
--
-- data Record = Record
-- { _recordFields :: HM.HashMap Text (Integer, ByteString)
-- , _recordEnabled :: Bool
-- }
-- deriving (Eq, Show, Generic)
--
-- instance Binary Record
-- instance Structured Record
--
--
-- then you can serialise and deserialise Record values with a
-- structure tag by simply
--
--
-- structuredEncode record :: ByteString
-- structuredDecode lbs :: IO Record
--
--
-- If structure of Record changes in between, deserialisation
-- will fail early.
--
-- Technically, Structured is not related to Binary, and
-- may be useful in other uses.
module Distribution.Utils.Structured
-- | Structured encode. Encode a value to using binary serialisation
-- to a lazy ByteString. Encoding starts with 16 byte large
-- structure hash.
structuredEncode :: forall a. (Binary a, Structured a) => a -> ByteString
-- | Lazily serialise a value to a file
structuredEncodeFile :: (Binary a, Structured a) => FilePath -> a -> IO ()
-- | Structured decode. Decode a value from a lazy
-- ByteString, reconstructing the original structure. Throws pure
-- exception on invalid inputs.
structuredDecode :: forall a. (Binary a, Structured a) => ByteString -> a
structuredDecodeOrFailIO :: (Binary a, Structured a) => ByteString -> IO (Either String a)
-- | Lazily reconstruct a value previously written to a file.
structuredDecodeFileOrFail :: (Binary a, Structured a) => FilePath -> IO (Either String a)
-- | Class of types with a known Structure.
--
-- For regular data types Structured can be derived generically.
--
--
-- data Record = Record { a :: Int, b :: Bool, c :: [Char] } deriving (Generic)
-- instance Structured Record
--
class Typeable a => Structured a
structure :: Structured a => Proxy a -> Structure
structure :: (Structured a, Generic a, GStructured (Rep a)) => Proxy a -> Structure
type MD5 = Fingerprint
-- | Semantically hashStructure . structure.
structureHash :: forall a. Structured a => Proxy a -> MD5
-- | Flatten Structure into something we can calculate hash of.
--
-- As Structure can be potentially infinite. For mutually
-- recursive types, we keep track of TypeReps, and put just
-- TypeRep name when it's occurred another time.
structureBuilder :: Structure -> Builder
-- | Derive structure genrically.
genericStructure :: forall a. (Typeable a, Generic a, GStructured (Rep a)) => Proxy a -> Structure
-- | Used to implement genericStructure.
class GStructured (f :: Type -> Type)
-- | Use Typeable to infer name
nominalStructure :: Typeable a => Proxy a -> Structure
containerStructure :: forall f a. (Typeable f, Structured a) => Proxy (f a) -> Structure
-- | Structure of a datatype.
--
-- It can be infinite, as far as TypeReps involved are finite.
-- (e.g. polymorphic recursion might cause troubles).
data Structure
-- | nominal, yet can be parametrised by other structures.
Nominal :: !TypeRep -> !TypeVersion -> TypeName -> [Structure] -> Structure
-- | a newtype wrapper
Newtype :: !TypeRep -> !TypeVersion -> TypeName -> Structure -> Structure
-- | sum-of-products structure
Structure :: !TypeRep -> !TypeVersion -> TypeName -> SopStructure -> Structure
data Tag a
Tag :: Tag a
type TypeName = String
type ConstructorName = String
-- | A sematic version of a data type. Usually 0.
type TypeVersion = Word32
type SopStructure = [(ConstructorName, [Structure])]
-- | A MD5 hash digest of Structure.
hashStructure :: Structure -> MD5
-- | A van-Laarhoven lens into TypeVersion of Structure
--
--
-- typeVersion :: Lens' Structure TypeVersion
--
typeVersion :: Functor f => (TypeVersion -> f TypeVersion) -> Structure -> f Structure
-- | A van-Laarhoven lens into TypeName of Structure
--
--
-- typeName :: Lens' Structure TypeName
--
typeName :: Functor f => (TypeName -> f TypeName) -> Structure -> f Structure
instance GHC.Generics.Generic Distribution.Utils.Structured.Structure
instance GHC.Show.Show Distribution.Utils.Structured.Structure
instance GHC.Classes.Ord Distribution.Utils.Structured.Structure
instance GHC.Classes.Eq Distribution.Utils.Structured.Structure
instance (i GHC.Types.~ GHC.Generics.C, GHC.Generics.Constructor c, Distribution.Utils.Structured.GStructuredProd f) => Distribution.Utils.Structured.GStructuredSum (GHC.Generics.M1 i c f)
instance (i GHC.Types.~ GHC.Generics.S, Distribution.Utils.Structured.GStructuredProd f) => Distribution.Utils.Structured.GStructuredProd (GHC.Generics.M1 i c f)
instance Distribution.Utils.Structured.Structured c => Distribution.Utils.Structured.GStructuredProd (GHC.Generics.K1 i c)
instance Distribution.Utils.Structured.GStructuredProd GHC.Generics.U1
instance (Distribution.Utils.Structured.GStructuredProd f, Distribution.Utils.Structured.GStructuredProd g) => Distribution.Utils.Structured.GStructuredProd (f GHC.Generics.:*: g)
instance (i GHC.Types.~ GHC.Generics.D, GHC.Generics.Datatype c, Distribution.Utils.Structured.GStructuredSum f) => Distribution.Utils.Structured.GStructured (GHC.Generics.M1 i c f)
instance (Distribution.Utils.Structured.GStructuredSum f, Distribution.Utils.Structured.GStructuredSum g) => Distribution.Utils.Structured.GStructuredSum (f GHC.Generics.:+: g)
instance Distribution.Utils.Structured.GStructuredSum GHC.Generics.V1
instance Distribution.Utils.Structured.Structured a => Data.Binary.Class.Binary (Distribution.Utils.Structured.Tag a)
instance Distribution.Utils.Structured.Structured ()
instance Distribution.Utils.Structured.Structured GHC.Types.Bool
instance Distribution.Utils.Structured.Structured GHC.Types.Ordering
instance Distribution.Utils.Structured.Structured GHC.Types.Char
instance Distribution.Utils.Structured.Structured GHC.Types.Int
instance Distribution.Utils.Structured.Structured GHC.Integer.Type.Integer
instance Distribution.Utils.Structured.Structured GHC.Types.Word
instance Distribution.Utils.Structured.Structured GHC.Int.Int8
instance Distribution.Utils.Structured.Structured GHC.Int.Int16
instance Distribution.Utils.Structured.Structured GHC.Int.Int32
instance Distribution.Utils.Structured.Structured GHC.Int.Int64
instance Distribution.Utils.Structured.Structured GHC.Word.Word8
instance Distribution.Utils.Structured.Structured GHC.Word.Word16
instance Distribution.Utils.Structured.Structured GHC.Word.Word32
instance Distribution.Utils.Structured.Structured GHC.Word.Word64
instance Distribution.Utils.Structured.Structured GHC.Types.Float
instance Distribution.Utils.Structured.Structured GHC.Types.Double
instance Distribution.Utils.Structured.Structured a => Distribution.Utils.Structured.Structured (GHC.Maybe.Maybe a)
instance (Distribution.Utils.Structured.Structured a, Distribution.Utils.Structured.Structured b) => Distribution.Utils.Structured.Structured (Data.Either.Either a b)
instance Distribution.Utils.Structured.Structured a => Distribution.Utils.Structured.Structured (GHC.Real.Ratio a)
instance Distribution.Utils.Structured.Structured a => Distribution.Utils.Structured.Structured [a]
instance Distribution.Utils.Structured.Structured a => Distribution.Utils.Structured.Structured (GHC.Base.NonEmpty a)
instance (Distribution.Utils.Structured.Structured a1, Distribution.Utils.Structured.Structured a2) => Distribution.Utils.Structured.Structured (a1, a2)
instance (Distribution.Utils.Structured.Structured a1, Distribution.Utils.Structured.Structured a2, Distribution.Utils.Structured.Structured a3) => Distribution.Utils.Structured.Structured (a1, a2, a3)
instance (Distribution.Utils.Structured.Structured a1, Distribution.Utils.Structured.Structured a2, Distribution.Utils.Structured.Structured a3, Distribution.Utils.Structured.Structured a4) => Distribution.Utils.Structured.Structured (a1, a2, a3, a4)
instance (Distribution.Utils.Structured.Structured a1, Distribution.Utils.Structured.Structured a2, Distribution.Utils.Structured.Structured a3, Distribution.Utils.Structured.Structured a4, Distribution.Utils.Structured.Structured a5) => Distribution.Utils.Structured.Structured (a1, a2, a3, a4, a5)
instance (Distribution.Utils.Structured.Structured a1, Distribution.Utils.Structured.Structured a2, Distribution.Utils.Structured.Structured a3, Distribution.Utils.Structured.Structured a4, Distribution.Utils.Structured.Structured a5, Distribution.Utils.Structured.Structured a6) => Distribution.Utils.Structured.Structured (a1, a2, a3, a4, a5, a6)
instance (Distribution.Utils.Structured.Structured a1, Distribution.Utils.Structured.Structured a2, Distribution.Utils.Structured.Structured a3, Distribution.Utils.Structured.Structured a4, Distribution.Utils.Structured.Structured a5, Distribution.Utils.Structured.Structured a6, Distribution.Utils.Structured.Structured a7) => Distribution.Utils.Structured.Structured (a1, a2, a3, a4, a5, a6, a7)
instance Distribution.Utils.Structured.Structured Data.ByteString.Internal.ByteString
instance Distribution.Utils.Structured.Structured Data.ByteString.Lazy.Internal.ByteString
instance Distribution.Utils.Structured.Structured Data.Text.Internal.Text
instance Distribution.Utils.Structured.Structured Data.Text.Internal.Lazy.Text
instance (Distribution.Utils.Structured.Structured k, Distribution.Utils.Structured.Structured v) => Distribution.Utils.Structured.Structured (Data.Map.Internal.Map k v)
instance Distribution.Utils.Structured.Structured k => Distribution.Utils.Structured.Structured (Data.Set.Internal.Set k)
instance Distribution.Utils.Structured.Structured v => Distribution.Utils.Structured.Structured (Data.IntMap.Internal.IntMap v)
instance Distribution.Utils.Structured.Structured Data.IntSet.Internal.IntSet
instance Distribution.Utils.Structured.Structured v => Distribution.Utils.Structured.Structured (Data.Sequence.Internal.Seq v)
instance Distribution.Utils.Structured.Structured Data.Time.Clock.Internal.UTCTime.UTCTime
instance Distribution.Utils.Structured.Structured Data.Time.Clock.Internal.DiffTime.DiffTime
instance Distribution.Utils.Structured.Structured Data.Time.Clock.Internal.UniversalTime.UniversalTime
instance Distribution.Utils.Structured.Structured Data.Time.Clock.Internal.NominalDiffTime.NominalDiffTime
instance Distribution.Utils.Structured.Structured Data.Time.Calendar.Days.Day
instance Distribution.Utils.Structured.Structured Data.Time.LocalTime.Internal.TimeZone.TimeZone
instance Distribution.Utils.Structured.Structured Data.Time.LocalTime.Internal.TimeOfDay.TimeOfDay
instance Distribution.Utils.Structured.Structured Data.Time.LocalTime.Internal.LocalTime.LocalTime
-- | Compatibility layer for Data.Semigroup
module Distribution.Compat.Semigroup
-- | The class of semigroups (types with an associative binary operation).
--
-- Instances should satisfy the following:
--
--
-- - Associativity x <> (y <> z) =
-- (x <> y) <> z
--
class Semigroup a
-- | An associative operation.
--
--
-- >>> [1,2,3] <> [4,5,6]
-- [1,2,3,4,5,6]
--
(<>) :: Semigroup a => a -> a -> a
infixr 6 <>
-- | The class of monoids (types with an associative binary operation that
-- has an identity). Instances should satisfy the following:
--
--
--
-- The method names refer to the monoid of lists under concatenation, but
-- there are many other instances.
--
-- Some types can be viewed as a monoid in more than one way, e.g. both
-- addition and multiplication on numbers. In such cases we often define
-- newtypes and make those instances of Monoid, e.g.
-- Sum and Product.
--
-- NOTE: Semigroup is a superclass of Monoid since
-- base-4.11.0.0.
class Semigroup a => Monoid a
-- | Identity of mappend
--
--
-- >>> "Hello world" <> mempty
-- "Hello world"
--
mempty :: Monoid a => a
-- | An associative operation
--
-- NOTE: This method is redundant and has the default
-- implementation mappend = (<>) since
-- base-4.11.0.0. Should it be implemented manually, since
-- mappend is a synonym for (<>), it is expected that
-- the two functions are defined the same way. In a future GHC release
-- mappend will be removed from Monoid.
mappend :: Monoid a => a -> a -> a
-- | Fold a list using the monoid.
--
-- For most types, the default definition for mconcat will be
-- used, but the function is included in the class definition so that an
-- optimized version can be provided for specific types.
--
--
-- >>> mconcat ["Hello", " ", "Haskell", "!"]
-- "Hello Haskell!"
--
mconcat :: Monoid a => [a] -> a
-- | Boolean monoid under conjunction (&&).
--
--
-- >>> getAll (All True <> mempty <> All False)
-- False
--
--
--
-- >>> getAll (mconcat (map (\x -> All (even x)) [2,4,6,7,8]))
-- False
--
newtype All
All :: Bool -> All
[getAll] :: All -> Bool
-- | Boolean monoid under disjunction (||).
--
--
-- >>> getAny (Any True <> mempty <> Any False)
-- True
--
--
--
-- >>> getAny (mconcat (map (\x -> Any (even x)) [2,4,6,7,8]))
-- True
--
newtype Any
Any :: Bool -> Any
[getAny] :: Any -> Bool
-- | A copy of First.
newtype First' a
First' :: a -> First' a
[getFirst'] :: First' a -> a
-- | A copy of Last.
newtype Last' a
Last' :: a -> Last' a
[getLast'] :: Last' a -> a
-- | A wrapper around Maybe, providing the Semigroup and
-- Monoid instances implemented for Maybe since
-- base-4.11.
newtype Option' a
Option' :: Maybe a -> Option' a
[getOption'] :: Option' a -> Maybe a
-- | Generically generate a Semigroup (<>) operation
-- for any type implementing Generic. This operation will append
-- two values by point-wise appending their component fields. It is only
-- defined for product types.
--
--
-- gmappend a (gmappend b c) = gmappend (gmappend a b) c
--
gmappend :: (Generic a, GSemigroup (Rep a)) => a -> a -> a
-- | Generically generate a Monoid mempty for any
-- product-like type implementing Generic.
--
-- It is only defined for product types.
--
--
-- gmappend gmempty a = a = gmappend a gmempty
--
gmempty :: (Generic a, GMonoid (Rep a)) => a
instance GHC.Show.Show a => GHC.Show.Show (Distribution.Compat.Semigroup.First' a)
instance GHC.Classes.Ord a => GHC.Classes.Ord (Distribution.Compat.Semigroup.First' a)
instance GHC.Classes.Eq a => GHC.Classes.Eq (Distribution.Compat.Semigroup.First' a)
instance Data.Binary.Class.Binary a => Data.Binary.Class.Binary (Distribution.Compat.Semigroup.Last' a)
instance GHC.Generics.Generic (Distribution.Compat.Semigroup.Last' a)
instance GHC.Show.Show a => GHC.Show.Show (Distribution.Compat.Semigroup.Last' a)
instance GHC.Read.Read a => GHC.Read.Read (Distribution.Compat.Semigroup.Last' a)
instance GHC.Classes.Ord a => GHC.Classes.Ord (Distribution.Compat.Semigroup.Last' a)
instance GHC.Classes.Eq a => GHC.Classes.Eq (Distribution.Compat.Semigroup.Last' a)
instance GHC.Base.Functor Distribution.Compat.Semigroup.Option'
instance GHC.Generics.Generic (Distribution.Compat.Semigroup.Option' a)
instance Data.Binary.Class.Binary a => Data.Binary.Class.Binary (Distribution.Compat.Semigroup.Option' a)
instance GHC.Show.Show a => GHC.Show.Show (Distribution.Compat.Semigroup.Option' a)
instance GHC.Read.Read a => GHC.Read.Read (Distribution.Compat.Semigroup.Option' a)
instance GHC.Classes.Ord a => GHC.Classes.Ord (Distribution.Compat.Semigroup.Option' a)
instance GHC.Classes.Eq a => GHC.Classes.Eq (Distribution.Compat.Semigroup.Option' a)
instance (GHC.Base.Semigroup a, GHC.Base.Monoid a) => Distribution.Compat.Semigroup.GMonoid (GHC.Generics.K1 i a)
instance Distribution.Compat.Semigroup.GMonoid f => Distribution.Compat.Semigroup.GMonoid (GHC.Generics.M1 i c f)
instance (Distribution.Compat.Semigroup.GMonoid f, Distribution.Compat.Semigroup.GMonoid g) => Distribution.Compat.Semigroup.GMonoid (f GHC.Generics.:*: g)
instance GHC.Base.Semigroup a => Distribution.Compat.Semigroup.GSemigroup (GHC.Generics.K1 i a)
instance Distribution.Compat.Semigroup.GSemigroup f => Distribution.Compat.Semigroup.GSemigroup (GHC.Generics.M1 i c f)
instance (Distribution.Compat.Semigroup.GSemigroup f, Distribution.Compat.Semigroup.GSemigroup g) => Distribution.Compat.Semigroup.GSemigroup (f GHC.Generics.:*: g)
instance Distribution.Utils.Structured.Structured a => Distribution.Utils.Structured.Structured (Distribution.Compat.Semigroup.Option' a)
instance GHC.Base.Semigroup a => GHC.Base.Semigroup (Distribution.Compat.Semigroup.Option' a)
instance GHC.Base.Semigroup a => GHC.Base.Monoid (Distribution.Compat.Semigroup.Option' a)
instance Distribution.Utils.Structured.Structured a => Distribution.Utils.Structured.Structured (Distribution.Compat.Semigroup.Last' a)
instance GHC.Base.Semigroup (Distribution.Compat.Semigroup.Last' a)
instance GHC.Base.Functor Distribution.Compat.Semigroup.Last'
instance GHC.Base.Semigroup (Distribution.Compat.Semigroup.First' a)
module Distribution.Compat.NonEmptySet
data NonEmptySet a
singleton :: a -> NonEmptySet a
insert :: Ord a => a -> NonEmptySet a -> NonEmptySet a
delete :: Ord a => a -> NonEmptySet a -> Maybe (NonEmptySet a)
toNonEmpty :: NonEmptySet a -> NonEmpty a
fromNonEmpty :: Ord a => NonEmpty a -> NonEmptySet a
toList :: NonEmptySet a -> [a]
toSet :: NonEmptySet a -> Set a
member :: Ord a => a -> NonEmptySet a -> Bool
map :: Ord b => (a -> b) -> NonEmptySet a -> NonEmptySet b
instance (GHC.Read.Read a, GHC.Classes.Ord a) => GHC.Read.Read (Distribution.Compat.NonEmptySet.NonEmptySet a)
instance (Data.Data.Data a, GHC.Classes.Ord a) => Data.Data.Data (Distribution.Compat.NonEmptySet.NonEmptySet a)
instance GHC.Classes.Ord a => GHC.Classes.Ord (Distribution.Compat.NonEmptySet.NonEmptySet a)
instance GHC.Classes.Eq a => GHC.Classes.Eq (Distribution.Compat.NonEmptySet.NonEmptySet a)
instance GHC.Show.Show a => GHC.Show.Show (Distribution.Compat.NonEmptySet.NonEmptySet a)
instance Data.Binary.Class.Binary a => Data.Binary.Class.Binary (Distribution.Compat.NonEmptySet.NonEmptySet a)
instance Distribution.Utils.Structured.Structured a => Distribution.Utils.Structured.Structured (Distribution.Compat.NonEmptySet.NonEmptySet a)
instance Control.DeepSeq.NFData a => Control.DeepSeq.NFData (Distribution.Compat.NonEmptySet.NonEmptySet a)
instance GHC.Classes.Ord a => GHC.Base.Semigroup (Distribution.Compat.NonEmptySet.NonEmptySet a)
instance Data.Foldable.Foldable Distribution.Compat.NonEmptySet.NonEmptySet
-- | Compact representation of short Strings
--
-- This module is designed to be import qualifeid
--
--
-- import Distribution.Utils.ShortText (ShortText)
-- import qualified Distribution.Utils.ShortText as ShortText
--
module Distribution.Utils.ShortText
-- | Compact representation of short Strings
--
-- The data is stored internally as UTF8 in an ShortByteString
-- when compiled against bytestring >= 0.10.4, and otherwise
-- the fallback is to use plain old non-compat '[Char]'.
--
-- Note: This type is for internal uses (such as e.g.
-- PackageName) and shall not be exposed in Cabal's API
data ShortText
-- | Construct ShortText from String
toShortText :: String -> ShortText
-- | Convert ShortText to String
fromShortText :: ShortText -> String
-- | Convert from UTF-8 encoded strict ByteString.
unsafeFromUTF8BS :: ByteString -> ShortText
-- | Text whether ShortText is empty.
null :: ShortText -> Bool
-- | O(n). Length in characters. Slow as converts to string.
length :: ShortText -> Int
-- | Decode String from UTF8-encoded octets.
--
-- Invalid data in the UTF8 stream (this includes code-points
-- U+D800 through U+DFFF) will be decoded as the
-- replacement character (U+FFFD).
--
-- See also encodeStringUtf8
decodeStringUtf8 :: [Word8] -> String
-- | Encode String to a list of UTF8-encoded octets
--
-- Code-points in the U+D800-U+DFFF range will be
-- encoded as the replacement character (i.e. U+FFFD).
--
-- See also decodeUtf8
encodeStringUtf8 :: String -> [Word8]
instance Data.Data.Data Distribution.Utils.ShortText.ShortText
instance GHC.Generics.Generic Distribution.Utils.ShortText.ShortText
instance GHC.Classes.Ord Distribution.Utils.ShortText.ShortText
instance GHC.Classes.Eq Distribution.Utils.ShortText.ShortText
instance Data.Binary.Class.Binary Distribution.Utils.ShortText.ShortText
instance Distribution.Utils.Structured.Structured Distribution.Utils.ShortText.ShortText
instance Control.DeepSeq.NFData Distribution.Utils.ShortText.ShortText
instance GHC.Show.Show Distribution.Utils.ShortText.ShortText
instance GHC.Read.Read Distribution.Utils.ShortText.ShortText
instance GHC.Base.Semigroup Distribution.Utils.ShortText.ShortText
instance GHC.Base.Monoid Distribution.Utils.ShortText.ShortText
instance Data.String.IsString Distribution.Utils.ShortText.ShortText
-- | A progress monad, which we use to report failure and logging from
-- otherwise pure code.
module Distribution.Utils.Progress
-- | A type to represent the unfolding of an expensive long running
-- calculation that may fail (or maybe not expensive, but complicated!)
-- We may get intermediate steps before the final result which may be
-- used to indicate progress and/or logging messages.
--
-- TODO: Apply Codensity to avoid left-associativity problem. See
-- http://comonad.com/reader/2011/free-monads-for-less/ and
-- http://blog.ezyang.com/2012/01/problem-set-the-codensity-transformation/
data Progress step fail done
-- | Emit a step and then continue.
stepProgress :: step -> Progress step fail ()
-- | Fail the computation.
failProgress :: fail -> Progress step fail done
-- | Consume a Progress calculation. Much like foldr for
-- lists but with two base cases, one for a final result and one for
-- failure.
--
-- Eg to convert into a simple Either result use:
--
--
-- foldProgress (flip const) Left Right
--
foldProgress :: (step -> a -> a) -> (fail -> a) -> (done -> a) -> Progress step fail done -> a
instance GHC.Base.Functor (Distribution.Utils.Progress.Progress step fail)
instance GHC.Base.Monad (Distribution.Utils.Progress.Progress step fail)
instance GHC.Base.Applicative (Distribution.Utils.Progress.Progress step fail)
instance GHC.Base.Monoid fail => GHC.Base.Alternative (Distribution.Utils.Progress.Progress step fail)
module Distribution.Utils.MapAccum
-- | Monadic variant of mapAccumL.
mapAccumM :: (Monad m, Traversable t) => (a -> b -> m (a, c)) -> a -> t b -> m (a, t c)
instance GHC.Base.Functor m => GHC.Base.Functor (Distribution.Utils.MapAccum.StateM s m)
instance GHC.Base.Monad m => GHC.Base.Applicative (Distribution.Utils.MapAccum.StateM s m)
module Distribution.Utils.IOData
-- | Represents either textual or binary data passed via I/O functions
-- which support binary/text mode
data IOData
-- | How Text gets encoded is usually locale-dependent.
IODataText :: String -> IOData
-- | Raw binary which gets read/written in binary mode.
IODataBinary :: ByteString -> IOData
data IODataMode mode
[IODataModeText] :: IODataMode String
[IODataModeBinary] :: IODataMode ByteString
class NFData mode => KnownIODataMode mode
-- | IOData Wrapper for hGetContents
--
-- Note: This operation uses lazy I/O. Use NFData to force
-- all data to be read and consequently the internal file handle to be
-- closed.
hGetIODataContents :: KnownIODataMode mode => Handle -> IO mode
toIOData :: KnownIODataMode mode => mode -> IOData
iodataMode :: KnownIODataMode mode => IODataMode mode
withIOData :: IOData -> (forall mode. IODataMode mode -> mode -> r) -> r
-- | Test whether IOData is empty
null :: IOData -> Bool
-- | IOData Wrapper for hPutStr and hClose
--
-- This is the dual operation ot hGetIODataContents, and
-- consequently the handle is closed with hClose.
--
-- Note: this performs lazy-IO.
hPutContents :: Handle -> IOData -> IO ()
instance (a GHC.Types.~ GHC.Types.Char) => Distribution.Utils.IOData.KnownIODataMode [a]
instance Distribution.Utils.IOData.KnownIODataMode Data.ByteString.Lazy.Internal.ByteString
instance Control.DeepSeq.NFData Distribution.Utils.IOData.IOData
-- | A large and somewhat miscellaneous collection of utility functions
-- used throughout the rest of the Cabal lib and in other tools that use
-- the Cabal lib like cabal-install. It has a very simple set of
-- logging actions. It has low level functions for running programs, a
-- bunch of wrappers for various directory and file functions that do
-- extra logging.
module Distribution.Utils.Generic
-- | Gets the contents of a file, but guarantee that it gets closed.
--
-- The file is read lazily but if it is not fully consumed by the action
-- then the remaining input is truncated and the file is closed.
withFileContents :: FilePath -> (String -> IO a) -> IO a
-- | Writes a file atomically.
--
-- The file is either written successfully or an IO exception is raised
-- and the original file is left unchanged.
--
-- On windows it is not possible to delete a file that is open by a
-- process. This case will give an IO exception but the atomic property
-- is not affected.
writeFileAtomic :: FilePath -> ByteString -> IO ()
-- | Decode String from UTF8-encoded ByteString
--
-- Invalid data in the UTF8 stream (this includes code-points
-- U+D800 through U+DFFF) will be decoded as the
-- replacement character (U+FFFD).
fromUTF8BS :: ByteString -> String
-- | Variant of fromUTF8BS for lazy ByteStrings
fromUTF8LBS :: ByteString -> String
-- | Encode String to UTF8-encoded ByteString
--
-- Code-points in the U+D800-U+DFFF range will be
-- encoded as the replacement character (i.e. U+FFFD).
toUTF8BS :: String -> ByteString
-- | Variant of toUTF8BS for lazy ByteStrings
toUTF8LBS :: String -> ByteString
-- | Check that strict ByteString is valid UTF8. Returns 'Just
-- offset' if it's not.
validateUTF8 :: ByteString -> Maybe Int
-- | Reads a UTF8 encoded text file as a Unicode String
--
-- Reads lazily using ordinary readFile.
readUTF8File :: FilePath -> IO String
-- | Reads a UTF8 encoded text file as a Unicode String
--
-- Same behaviour as withFileContents.
withUTF8FileContents :: FilePath -> (String -> IO a) -> IO a
-- | Writes a Unicode String as a UTF8 encoded text file.
--
-- Uses writeFileAtomic, so provides the same guarantees.
writeUTF8File :: FilePath -> String -> IO ()
-- | Ignore a Unicode byte order mark (BOM) at the beginning of the input
ignoreBOM :: String -> String
-- | Fix different systems silly line ending conventions
normaliseLineEndings :: String -> String
-- | dropWhileEndLE p is equivalent to reverse . dropWhile p .
-- reverse, but quite a bit faster. The difference between
-- "Data.List.dropWhileEnd" and this version is that the one in
-- Data.List is strict in elements, but spine-lazy, while this one
-- is spine-strict but lazy in elements. That's what LE stands
-- for - "lazy in elements".
--
-- Example:
--
--
-- >>> safeTail $ Data.List.dropWhileEnd (<3) [undefined, 5, 4, 3, 2, 1]
-- *** Exception: Prelude.undefined
-- ...
--
--
--
-- >>> safeTail $ dropWhileEndLE (<3) [undefined, 5, 4, 3, 2, 1]
-- [5,4,3]
--
--
--
-- >>> take 3 $ Data.List.dropWhileEnd (<3) [5, 4, 3, 2, 1, undefined]
-- [5,4,3]
--
--
--
-- >>> take 3 $ dropWhileEndLE (<3) [5, 4, 3, 2, 1, undefined]
-- *** Exception: Prelude.undefined
-- ...
--
dropWhileEndLE :: (a -> Bool) -> [a] -> [a]
-- | takeWhileEndLE p is equivalent to reverse . takeWhile p .
-- reverse, but is usually faster (as well as being easier to read).
takeWhileEndLE :: (a -> Bool) -> [a] -> [a]
equating :: Eq a => (b -> a) -> b -> b -> Bool
-- |
-- comparing p x y = compare (p x) (p y)
--
--
-- Useful combinator for use in conjunction with the xxxBy
-- family of functions from Data.List, for example:
--
--
-- ... sortBy (comparing fst) ...
--
comparing :: Ord a => (b -> a) -> b -> b -> Ordering
-- | The isInfixOf function takes two lists and returns True
-- iff the first list is contained, wholly and intact, anywhere within
-- the second.
--
--
-- >>> isInfixOf "Haskell" "I really like Haskell."
-- True
--
--
--
-- >>> isInfixOf "Ial" "I really like Haskell."
-- False
--
isInfixOf :: Eq a => [a] -> [a] -> Bool
-- | intercalate xs xss is equivalent to (concat
-- (intersperse xs xss)). It inserts the list xs in
-- between the lists in xss and concatenates the result.
--
--
-- >>> intercalate ", " ["Lorem", "ipsum", "dolor"]
-- "Lorem, ipsum, dolor"
--
intercalate :: [a] -> [[a]] -> [a]
-- | Lower case string
--
--
-- >>> lowercase "Foobar"
-- "foobar"
--
lowercase :: String -> String
-- | Ascii characters
isAscii :: Char -> Bool
-- | Ascii letters.
isAsciiAlpha :: Char -> Bool
-- | Ascii letters and digits.
--
--
-- >>> isAsciiAlphaNum 'a'
-- True
--
--
--
-- >>> isAsciiAlphaNum 'ä'
-- False
--
isAsciiAlphaNum :: Char -> Bool
-- | Like "Data.List.union", but has O(n log n) complexity instead
-- of O(n^2).
listUnion :: Ord a => [a] -> [a] -> [a]
-- | A right-biased version of listUnion.
--
-- Example:
--
--
-- >>> listUnion [1,2,3,4,3] [2,1,1]
-- [1,2,3,4,3]
--
--
--
-- >>> listUnionRight [1,2,3,4,3] [2,1,1]
-- [4,3,2,1,1]
--
listUnionRight :: Ord a => [a] -> [a] -> [a]
-- | Like nub, but has O(n log n) complexity instead of
-- O(n^2). Code for ordNub and listUnion taken
-- from Niklas Hambüchen's ordnub package.
ordNub :: Ord a => [a] -> [a]
-- | Like ordNub and nubBy. Selects a key for each element
-- and takes the nub based on that key.
ordNubBy :: Ord b => (a -> b) -> [a] -> [a]
-- | A right-biased version of ordNub.
--
-- Example:
--
--
-- >>> ordNub [1,2,1] :: [Int]
-- [1,2]
--
--
--
-- >>> ordNubRight [1,2,1] :: [Int]
-- [2,1]
--
ordNubRight :: Ord a => [a] -> [a]
-- | A total variant of head.
safeHead :: [a] -> Maybe a
-- | A total variant of tail.
safeTail :: [a] -> [a]
-- | A total variant of last.
safeLast :: [a] -> Maybe a
-- | A total variant of init.
safeInit :: [a] -> [a]
unintersperse :: Char -> String -> [String]
-- | Wraps text to the default line width. Existing newlines are preserved.
wrapText :: String -> String
-- | Wraps a list of words to a list of lines of words of a particular
-- width.
wrapLine :: Int -> [String] -> [[String]]
-- | unfoldr with monadic action.
--
--
-- >>> take 5 $ unfoldrM (\b r -> Just (r + b, b + 1)) (1 :: Int) 2
-- [3,4,5,6,7]
--
unfoldrM :: Monad m => (b -> m (Maybe (a, b))) -> b -> m [a]
-- | Like span but with Maybe predicate
--
--
-- >>> spanMaybe listToMaybe [[1,2],[3],[],[4,5],[6,7]]
-- ([1,3],[[],[4,5],[6,7]])
--
--
--
-- >>> spanMaybe (readMaybe :: String -> Maybe Int) ["1", "2", "foo"]
-- ([1,2],["foo"])
--
spanMaybe :: (a -> Maybe b) -> [a] -> ([b], [a])
-- | Like break, but with Maybe predicate
--
--
-- >>> breakMaybe (readMaybe :: String -> Maybe Int) ["foo", "bar", "1", "2", "quu"]
-- (["foo","bar"],Just (1,["2","quu"]))
--
--
--
-- >>> breakMaybe (readMaybe :: String -> Maybe Int) ["foo", "bar"]
-- (["foo","bar"],Nothing)
--
breakMaybe :: (a -> Maybe b) -> [a] -> ([a], Maybe (b, [a]))
-- | The opposite of snoc, which is the reverse of cons
--
-- Example:
--
--
-- >>> unsnoc [1, 2, 3]
-- Just ([1,2],3)
--
--
--
-- >>> unsnoc []
-- Nothing
--
unsnoc :: [a] -> Maybe ([a], a)
-- | Like unsnoc, but for NonEmpty so without the
-- Maybe
--
-- Example:
--
--
-- >>> unsnocNE (1 :| [2, 3])
-- ([1,2],3)
--
--
--
-- >>> unsnocNE (1 :| [])
-- ([],1)
--
unsnocNE :: NonEmpty a -> ([a], a)
fstOf3 :: (a, b, c) -> a
sndOf3 :: (a, b, c) -> b
trdOf3 :: (a, b, c) -> c
-- | isAbsoluteOnAnyPlatform and isRelativeOnAnyPlatform are
-- like isAbsolute and isRelative but have platform
-- independent heuristics. The System.FilePath exists in two versions,
-- Windows and Posix. The two versions don't agree on what is a relative
-- path and we don't know if we're given Windows or Posix paths. This
-- results in false positives when running on Posix and inspecting
-- Windows paths, like the hackage server does.
-- System.FilePath.Posix.isAbsolute "C:\hello" == False
-- System.FilePath.Windows.isAbsolute "/hello" == False This means that
-- we would treat paths that start with "/" to be absolute. On Posix they
-- are indeed absolute, while on Windows they are not.
--
-- The portable versions should be used when we might deal with paths
-- that are from another OS than the host OS. For example, the Hackage
-- Server deals with both Windows and Posix paths while performing the
-- PackageDescription checks. In contrast, when we run 'cabal configure'
-- we do expect the paths to be correct for our OS and we should not have
-- to use the platform independent heuristics.
isAbsoluteOnAnyPlatform :: FilePath -> Bool
-- |
-- isRelativeOnAnyPlatform = not . isAbsoluteOnAnyPlatform
--
isRelativeOnAnyPlatform :: FilePath -> Bool
module Distribution.Types.Condition
-- | A boolean expression parameterized over the variable type used.
data Condition c
Var :: c -> Condition c
Lit :: Bool -> Condition c
CNot :: Condition c -> Condition c
COr :: Condition c -> Condition c -> Condition c
CAnd :: Condition c -> Condition c -> Condition c
-- | Boolean negation of a Condition value.
cNot :: Condition a -> Condition a
-- | Boolean AND of two Condtion values.
cAnd :: Condition a -> Condition a -> Condition a
-- | Boolean OR of two Condition values.
cOr :: Eq v => Condition v -> Condition v -> Condition v
-- | Simplify the condition and return its free variables.
simplifyCondition :: Condition c -> (c -> Either d Bool) -> (Condition d, [d])
instance GHC.Generics.Generic (Distribution.Types.Condition.Condition c)
instance Data.Data.Data c => Data.Data.Data (Distribution.Types.Condition.Condition c)
instance GHC.Classes.Eq c => GHC.Classes.Eq (Distribution.Types.Condition.Condition c)
instance GHC.Show.Show c => GHC.Show.Show (Distribution.Types.Condition.Condition c)
instance GHC.Base.Functor Distribution.Types.Condition.Condition
instance Data.Foldable.Foldable Distribution.Types.Condition.Condition
instance Data.Traversable.Traversable Distribution.Types.Condition.Condition
instance GHC.Base.Applicative Distribution.Types.Condition.Condition
instance GHC.Base.Monad Distribution.Types.Condition.Condition
instance GHC.Base.Monoid (Distribution.Types.Condition.Condition a)
instance GHC.Base.Semigroup (Distribution.Types.Condition.Condition a)
instance GHC.Base.Alternative Distribution.Types.Condition.Condition
instance GHC.Base.MonadPlus Distribution.Types.Condition.Condition
instance Data.Binary.Class.Binary c => Data.Binary.Class.Binary (Distribution.Types.Condition.Condition c)
instance Distribution.Utils.Structured.Structured c => Distribution.Utils.Structured.Structured (Distribution.Types.Condition.Condition c)
instance Control.DeepSeq.NFData c => Control.DeepSeq.NFData (Distribution.Types.Condition.Condition c)
-- | This module defines the detailed test suite interface which makes it
-- possible to expose individual tests to Cabal or other test agents.
module Distribution.TestSuite
data TestInstance
TestInstance :: IO Progress -> String -> [String] -> [OptionDescr] -> (String -> String -> Either String TestInstance) -> TestInstance
-- | Perform the test.
[run] :: TestInstance -> IO Progress
-- | A name for the test, unique within a test suite.
[name] :: TestInstance -> String
-- | Users can select groups of tests by their tags.
[tags] :: TestInstance -> [String]
-- | Descriptions of the options recognized by this test.
[options] :: TestInstance -> [OptionDescr]
-- | Try to set the named option to the given value. Returns an error
-- message if the option is not supported or the value could not be
-- correctly parsed; otherwise, a TestInstance with the option set
-- to the given value is returned.
[setOption] :: TestInstance -> String -> String -> Either String TestInstance
data OptionDescr
OptionDescr :: String -> String -> OptionType -> Maybe String -> OptionDescr
[optionName] :: OptionDescr -> String
-- | A human-readable description of the option to guide the user setting
-- it.
[optionDescription] :: OptionDescr -> String
[optionType] :: OptionDescr -> OptionType
[optionDefault] :: OptionDescr -> Maybe String
data OptionType
OptionFile :: Bool -> Bool -> [String] -> OptionType
[optionFileMustExist] :: OptionType -> Bool
[optionFileIsDir] :: OptionType -> Bool
[optionFileExtensions] :: OptionType -> [String]
OptionString :: Bool -> OptionType
[optionStringMultiline] :: OptionType -> Bool
OptionNumber :: Bool -> (Maybe String, Maybe String) -> OptionType
[optionNumberIsInt] :: OptionType -> Bool
[optionNumberBounds] :: OptionType -> (Maybe String, Maybe String)
OptionBool :: OptionType
OptionEnum :: [String] -> OptionType
OptionSet :: [String] -> OptionType
OptionRngSeed :: OptionType
data Test
Test :: TestInstance -> Test
Group :: String -> Bool -> [Test] -> Test
[groupName] :: Test -> String
-- | If true, then children of this group may be run in parallel. Note that
-- this setting is not inherited by children. In particular, consider a
-- group F with "concurrently = False" that has some children, including
-- a group T with "concurrently = True". The children of group T may be
-- run concurrently with each other, as long as none are run at the same
-- time as any of the direct children of group F.
[concurrently] :: Test -> Bool
[groupTests] :: Test -> [Test]
ExtraOptions :: [OptionDescr] -> Test -> Test
type Options = [(String, String)]
data Progress
Finished :: Result -> Progress
Progress :: String -> IO Progress -> Progress
data Result
Pass :: Result
Fail :: String -> Result
Error :: String -> Result
-- | Create a named group of tests, which are assumed to be safe to run in
-- parallel.
testGroup :: String -> [Test] -> Test
instance GHC.Show.Show Distribution.TestSuite.OptionType
instance GHC.Read.Read Distribution.TestSuite.OptionType
instance GHC.Classes.Eq Distribution.TestSuite.OptionType
instance GHC.Show.Show Distribution.TestSuite.OptionDescr
instance GHC.Read.Read Distribution.TestSuite.OptionDescr
instance GHC.Classes.Eq Distribution.TestSuite.OptionDescr
instance GHC.Show.Show Distribution.TestSuite.Result
instance GHC.Read.Read Distribution.TestSuite.Result
instance GHC.Classes.Eq Distribution.TestSuite.Result
-- | Internal utilities used by Distribution.Simple.Program.*.
module Distribution.Simple.Program.Internal
-- | Extract the version number from the output of 'strip --version'.
--
-- Invoking "strip --version" gives very inconsistent results. We ignore
-- everything in parentheses (see #2497), look for the first word that
-- starts with a number, and try parsing out the first two components of
-- it. Non-GNU strip doesn't appear to have a version flag.
stripExtractVersion :: String -> String
-- | Remove the "literal" markups from a Haskell source file, including
-- ">", "\begin{code}", "\end{code}", and
-- "#"
module Distribution.Simple.PreProcess.Unlit
-- | unlit takes a filename (for error reports), and transforms the
-- given string, to eliminate the literate comments from the program
-- text.
unlit :: FilePath -> String -> Either String String
-- | No unliteration.
plain :: String -> String -> String
module Distribution.Simple.InstallDirs.Internal
data PathComponent
Ordinary :: FilePath -> PathComponent
Variable :: PathTemplateVariable -> PathComponent
data PathTemplateVariable
-- | The $prefix path variable
PrefixVar :: PathTemplateVariable
-- | The $bindir path variable
BindirVar :: PathTemplateVariable
-- | The $libdir path variable
LibdirVar :: PathTemplateVariable
-- | The $libsubdir path variable
LibsubdirVar :: PathTemplateVariable
-- | The $dynlibdir path variable
DynlibdirVar :: PathTemplateVariable
-- | The $datadir path variable
DatadirVar :: PathTemplateVariable
-- | The $datasubdir path variable
DatasubdirVar :: PathTemplateVariable
-- | The $docdir path variable
DocdirVar :: PathTemplateVariable
-- | The $htmldir path variable
HtmldirVar :: PathTemplateVariable
-- | The $pkg package name path variable
PkgNameVar :: PathTemplateVariable
-- | The $version package version path variable
PkgVerVar :: PathTemplateVariable
-- | The $pkgid package Id path variable, eg foo-1.0
PkgIdVar :: PathTemplateVariable
-- | The $libname path variable
LibNameVar :: PathTemplateVariable
-- | The compiler name and version, eg ghc-6.6.1
CompilerVar :: PathTemplateVariable
-- | The operating system name, eg windows or linux
OSVar :: PathTemplateVariable
-- | The CPU architecture name, eg i386 or x86_64
ArchVar :: PathTemplateVariable
-- | The compiler's ABI identifier,
AbiVar :: PathTemplateVariable
-- | The optional ABI tag for the compiler
AbiTagVar :: PathTemplateVariable
-- | The executable name; used in shell wrappers
ExecutableNameVar :: PathTemplateVariable
-- | The name of the test suite being run
TestSuiteNameVar :: PathTemplateVariable
-- | The result of the test suite being run, eg pass,
-- fail, or error.
TestSuiteResultVar :: PathTemplateVariable
-- | The name of the benchmark being run
BenchmarkNameVar :: PathTemplateVariable
instance GHC.Generics.Generic Distribution.Simple.InstallDirs.Internal.PathTemplateVariable
instance GHC.Classes.Ord Distribution.Simple.InstallDirs.Internal.PathTemplateVariable
instance GHC.Classes.Eq Distribution.Simple.InstallDirs.Internal.PathTemplateVariable
instance GHC.Generics.Generic Distribution.Simple.InstallDirs.Internal.PathComponent
instance GHC.Classes.Ord Distribution.Simple.InstallDirs.Internal.PathComponent
instance GHC.Classes.Eq Distribution.Simple.InstallDirs.Internal.PathComponent
instance Data.Binary.Class.Binary Distribution.Simple.InstallDirs.Internal.PathComponent
instance Distribution.Utils.Structured.Structured Distribution.Simple.InstallDirs.Internal.PathComponent
instance GHC.Show.Show Distribution.Simple.InstallDirs.Internal.PathComponent
instance GHC.Read.Read Distribution.Simple.InstallDirs.Internal.PathComponent
instance Data.Binary.Class.Binary Distribution.Simple.InstallDirs.Internal.PathTemplateVariable
instance Distribution.Utils.Structured.Structured Distribution.Simple.InstallDirs.Internal.PathTemplateVariable
instance GHC.Show.Show Distribution.Simple.InstallDirs.Internal.PathTemplateVariable
instance GHC.Read.Read Distribution.Simple.InstallDirs.Internal.PathTemplateVariable
-- | Defines the Flag type and it's Monoid instance, see
-- http://www.haskell.org/pipermail/cabal-devel/2007-December/001509.html
-- for an explanation.
--
-- Split off from Distribution.Simple.Setup to break import
-- cycles.
module Distribution.Simple.Flag
-- | All flags are monoids, they come in two flavours:
--
--
-- - list flags eg
--
--
--
-- --ghc-option=foo --ghc-option=bar
--
--
-- gives us all the values ["foo", "bar"]
--
--
-- - singular value flags, eg:
--
--
--
-- --enable-foo --disable-foo
--
--
-- gives us Just False So this Flag type is for the latter singular kind
-- of flag. Its monoid instance gives us the behaviour where it starts
-- out as NoFlag and later flags override earlier ones.
data Flag a
Flag :: a -> Flag a
NoFlag :: Flag a
allFlags :: [Flag Bool] -> Flag Bool
toFlag :: a -> Flag a
fromFlag :: WithCallStack (Flag a -> a)
fromFlagOrDefault :: a -> Flag a -> a
flagElim :: b -> (a -> b) -> Flag a -> b
flagToMaybe :: Flag a -> Maybe a
flagToList :: Flag a -> [a]
maybeToFlag :: Maybe a -> Flag a
-- | Types that represent boolean flags.
class BooleanFlag a
asBool :: BooleanFlag a => a -> Bool
instance GHC.Read.Read a => GHC.Read.Read (Distribution.Simple.Flag.Flag a)
instance GHC.Show.Show a => GHC.Show.Show (Distribution.Simple.Flag.Flag a)
instance GHC.Generics.Generic (Distribution.Simple.Flag.Flag a)
instance GHC.Classes.Eq a => GHC.Classes.Eq (Distribution.Simple.Flag.Flag a)
instance Distribution.Simple.Flag.BooleanFlag GHC.Types.Bool
instance Data.Binary.Class.Binary a => Data.Binary.Class.Binary (Distribution.Simple.Flag.Flag a)
instance Distribution.Utils.Structured.Structured a => Distribution.Utils.Structured.Structured (Distribution.Simple.Flag.Flag a)
instance GHC.Base.Functor Distribution.Simple.Flag.Flag
instance GHC.Base.Applicative Distribution.Simple.Flag.Flag
instance GHC.Base.Monoid (Distribution.Simple.Flag.Flag a)
instance GHC.Base.Semigroup (Distribution.Simple.Flag.Flag a)
instance GHC.Enum.Bounded a => GHC.Enum.Bounded (Distribution.Simple.Flag.Flag a)
instance GHC.Enum.Enum a => GHC.Enum.Enum (Distribution.Simple.Flag.Flag a)
-- | This simple package provides types and functions for interacting with
-- C compilers. Currently it's just a type enumerating extant C-like
-- languages, which we call dialects.
module Distribution.Simple.CCompiler
-- | Represents a dialect of C. The Monoid instance expresses backward
-- compatibility, in the sense that 'mappend a b' is the least inclusive
-- dialect which both a and b can be correctly
-- interpreted as.
data CDialect
C :: CDialect
ObjectiveC :: CDialect
CPlusPlus :: CDialect
ObjectiveCPlusPlus :: CDialect
-- | A list of all file extensions which are recognized as possibly
-- containing some dialect of C code. Note that this list is only for
-- source files, not for header files.
cSourceExtensions :: [String]
-- | Takes a dialect of C and whether code is intended to be passed through
-- the preprocessor, and returns a filename extension for containing that
-- code.
cDialectFilenameExtension :: CDialect -> Bool -> String
-- | Infers from a filename's extension the dialect of C which it contains,
-- and whether it is intended to be passed through the preprocessor.
filenameCDialect :: String -> Maybe (CDialect, Bool)
instance GHC.Show.Show Distribution.Simple.CCompiler.CDialect
instance GHC.Classes.Eq Distribution.Simple.CCompiler.CDialect
instance GHC.Base.Monoid Distribution.Simple.CCompiler.CDialect
instance GHC.Base.Semigroup Distribution.Simple.CCompiler.CDialect
module Distribution.Parsec.Position
-- | 1-indexed row and column positions in a file.
data Position
Position :: {-# UNPACK #-} !Int -> {-# UNPACK #-} !Int -> Position
-- | Shift position by n columns to the right.
incPos :: Int -> Position -> Position
-- | Shift position to beginning of next row.
retPos :: Position -> Position
showPos :: Position -> String
zeroPos :: Position
positionCol :: Position -> Int
positionRow :: Position -> Int
instance GHC.Generics.Generic Distribution.Parsec.Position.Position
instance GHC.Show.Show Distribution.Parsec.Position.Position
instance GHC.Classes.Ord Distribution.Parsec.Position.Position
instance GHC.Classes.Eq Distribution.Parsec.Position.Position
instance Data.Binary.Class.Binary Distribution.Parsec.Position.Position
instance Control.DeepSeq.NFData Distribution.Parsec.Position.Position
module Distribution.Parsec.Warning
-- | Parser warning.
data PWarning
PWarning :: !PWarnType -> !Position -> String -> PWarning
-- | Type of parser warning. We do classify warnings.
--
-- Different application may decide not to show some, or have fatal
-- behaviour on others
data PWarnType
-- | Unclassified warning
PWTOther :: PWarnType
-- | Invalid UTF encoding
PWTUTF :: PWarnType
-- | true or false, not True or False
PWTBoolCase :: PWarnType
-- | there are version with tags
PWTVersionTag :: PWarnType
-- | New syntax used, but no cabal-version: >= 1.2 specified
PWTNewSyntax :: PWarnType
-- | Old syntax used, and cabal-version >= 1.2 specified
PWTOldSyntax :: PWarnType
PWTDeprecatedField :: PWarnType
PWTInvalidSubsection :: PWarnType
PWTUnknownField :: PWarnType
PWTUnknownSection :: PWarnType
PWTTrailingFields :: PWarnType
-- | extra main-is field
PWTExtraMainIs :: PWarnType
-- | extra test-module field
PWTExtraTestModule :: PWarnType
-- | extra benchmark-module field
PWTExtraBenchmarkModule :: PWarnType
PWTLexNBSP :: PWarnType
PWTLexBOM :: PWarnType
PWTLexTab :: PWarnType
-- | legacy cabal file that we know how to patch
PWTQuirkyCabalFile :: PWarnType
-- | Double dash token, most likely it's a mistake - it's not a comment
PWTDoubleDash :: PWarnType
-- | e.g. name or version should be specified only once.
PWTMultipleSingularField :: PWarnType
-- | Workaround for derive-package having build-type: Default. See
-- https://github.com/haskell/cabal/issues/5020.
PWTBuildTypeDefault :: PWarnType
-- | Version operators used (without cabal-version: 1.8)
PWTVersionOperator :: PWarnType
-- | Version wildcard used (without cabal-version: 1.6)
PWTVersionWildcard :: PWarnType
-- | Warnings about cabal-version format.
PWTSpecVersion :: PWarnType
-- | Empty filepath, i.e. literally ""
PWTEmptyFilePath :: PWarnType
-- | Experimental feature
PWTExperimental :: PWarnType
showPWarning :: FilePath -> PWarning -> String
instance GHC.Generics.Generic Distribution.Parsec.Warning.PWarnType
instance GHC.Enum.Bounded Distribution.Parsec.Warning.PWarnType
instance GHC.Enum.Enum Distribution.Parsec.Warning.PWarnType
instance GHC.Show.Show Distribution.Parsec.Warning.PWarnType
instance GHC.Classes.Ord Distribution.Parsec.Warning.PWarnType
instance GHC.Classes.Eq Distribution.Parsec.Warning.PWarnType
instance GHC.Generics.Generic Distribution.Parsec.Warning.PWarning
instance GHC.Show.Show Distribution.Parsec.Warning.PWarning
instance Data.Binary.Class.Binary Distribution.Parsec.Warning.PWarning
instance Control.DeepSeq.NFData Distribution.Parsec.Warning.PWarning
instance Data.Binary.Class.Binary Distribution.Parsec.Warning.PWarnType
instance Control.DeepSeq.NFData Distribution.Parsec.Warning.PWarnType
module Distribution.Parsec.FieldLineStream
-- | This is essentially a lazy bytestring, but chunks are glued with
-- newline '\n'.
data FieldLineStream
FLSLast :: !ByteString -> FieldLineStream
FLSCons :: {-# UNPACK #-} !ByteString -> FieldLineStream -> FieldLineStream
-- | Convert String to FieldLineStream.
--
-- Note: inefficient!
fieldLineStreamFromString :: String -> FieldLineStream
fieldLineStreamFromBS :: ByteString -> FieldLineStream
fieldLineStreamEnd :: FieldLineStream
instance GHC.Show.Show Distribution.Parsec.FieldLineStream.FieldLineStream
instance GHC.Base.Monad m => Text.Parsec.Prim.Stream Distribution.Parsec.FieldLineStream.FieldLineStream m GHC.Types.Char
module Distribution.Parsec.Error
-- | Parser error.
data PError
PError :: Position -> String -> PError
showPError :: FilePath -> PError -> String
instance GHC.Generics.Generic Distribution.Parsec.Error.PError
instance GHC.Show.Show Distribution.Parsec.Error.PError
instance Data.Binary.Class.Binary Distribution.Parsec.Error.PError
instance Control.DeepSeq.NFData Distribution.Parsec.Error.PError
module Distribution.PackageDescription.Quirks
-- | Patch legacy .cabal file contents to allow parsec parser to
-- accept all of Hackage.
--
-- Bool part of the result tells whether the output is modified.
patchQuirks :: ByteString -> (Bool, ByteString)
module Distribution.Fields.LexerMonad
type InputStream = ByteString
data LexState
LexState :: {-# UNPACK #-} !Position -> {-# UNPACK #-} !InputStream -> {-# UNPACK #-} !StartCode -> [LexWarning] -> LexState
-- | position at current input location
[curPos] :: LexState -> {-# UNPACK #-} !Position
-- | the current input
[curInput] :: LexState -> {-# UNPACK #-} !InputStream
-- | lexer code
[curCode] :: LexState -> {-# UNPACK #-} !StartCode
[warnings] :: LexState -> [LexWarning]
data LexResult a
LexResult :: {-# UNPACK #-} !LexState -> a -> LexResult a
newtype Lex a
Lex :: (LexState -> LexResult a) -> Lex a
[unLex] :: Lex a -> LexState -> LexResult a
-- | Execute the given lexer on the supplied input stream.
execLexer :: Lex a -> InputStream -> ([LexWarning], a)
getPos :: Lex Position
setPos :: Position -> Lex ()
adjustPos :: (Position -> Position) -> Lex ()
getInput :: Lex InputStream
setInput :: InputStream -> Lex ()
getStartCode :: Lex Int
setStartCode :: Int -> Lex ()
data LexWarning
LexWarning :: !LexWarningType -> {-# UNPACK #-} !Position -> LexWarning
data LexWarningType
-- | Encountered non breaking space
LexWarningNBSP :: LexWarningType
-- | BOM at the start of the cabal file
LexWarningBOM :: LexWarningType
-- | Leading tags
LexWarningTab :: LexWarningType
-- | Add warning at the current position
addWarning :: LexWarningType -> Lex ()
toPWarnings :: [LexWarning] -> [PWarning]
instance GHC.Show.Show Distribution.Fields.LexerMonad.LexWarningType
instance GHC.Classes.Ord Distribution.Fields.LexerMonad.LexWarningType
instance GHC.Classes.Eq Distribution.Fields.LexerMonad.LexWarningType
instance GHC.Show.Show Distribution.Fields.LexerMonad.LexWarning
instance GHC.Base.Functor Distribution.Fields.LexerMonad.Lex
instance GHC.Base.Applicative Distribution.Fields.LexerMonad.Lex
instance GHC.Base.Monad Distribution.Fields.LexerMonad.Lex
-- | Lexer for the cabal files.
module Distribution.Fields.Lexer
ltest :: Int -> String -> IO ()
lexToken :: Lex LToken
-- | Tokens of outer cabal file structure. Field values are treated
-- opaquely.
data Token
-- | Haskell-like identifier, number or operator
TokSym :: !ByteString -> Token
-- | String in quotes
TokStr :: !ByteString -> Token
-- | Operators and parens
TokOther :: !ByteString -> Token
-- | Indentation token
Indent :: !Int -> Token
-- | Lines after :
TokFieldLine :: !ByteString -> Token
Colon :: Token
OpenBrace :: Token
CloseBrace :: Token
EOF :: Token
LexicalError :: InputStream -> Token
data LToken
L :: !Position -> !Token -> LToken
bol_section :: Int
in_section :: Int
in_field_layout :: Int
in_field_braces :: Int
mkLexState :: ByteString -> LexState
instance GHC.Show.Show Distribution.Fields.Lexer.Token
instance GHC.Show.Show Distribution.Fields.Lexer.LToken
module Distribution.Compat.ResponseFile
expandResponse :: [String] -> IO [String]
-- | This module re-exports the non-exposed
-- Distribution.Compat.Prelude module for reuse by
-- cabal-install's Distribution.Client.Compat.Prelude
-- module.
--
-- It is highly discouraged to rely on this module for Setup.hs
-- scripts since its API is not stable.
-- | Warning: This modules' API is not stable. Use at your own risk, or
-- better yet, use base-compat!
module Distribution.Compat.Prelude.Internal
-- | Append two lists, i.e.,
--
--
-- [x1, ..., xm] ++ [y1, ..., yn] == [x1, ..., xm, y1, ..., yn]
-- [x1, ..., xm] ++ [y1, ...] == [x1, ..., xm, y1, ...]
--
--
-- If the first list is not finite, the result is the first list.
(++) :: [a] -> [a] -> [a]
infixr 5 ++
-- | The value of seq a b is bottom if a is bottom, and
-- otherwise equal to b. In other words, it evaluates the first
-- argument a to weak head normal form (WHNF). seq is
-- usually introduced to improve performance by avoiding unneeded
-- laziness.
--
-- A note on evaluation order: the expression seq a b does
-- not guarantee that a will be evaluated before
-- b. The only guarantee given by seq is that the both
-- a and b will be evaluated before seq
-- returns a value. In particular, this means that b may be
-- evaluated before a. If you need to guarantee a specific order
-- of evaluation, you must use the function pseq from the
-- "parallel" package.
seq :: forall (r :: RuntimeRep) a (b :: TYPE r). a -> b -> b
infixr 0 `seq`
-- | <math>. filter, applied to a predicate and a list,
-- returns the list of those elements that satisfy the predicate; i.e.,
--
--
-- filter p xs = [ x | x <- xs, p x]
--
--
--
-- >>> filter odd [1, 2, 3]
-- [1,3]
--
filter :: (a -> Bool) -> [a] -> [a]
-- | <math>. zip takes two lists and returns a list of
-- corresponding pairs.
--
--
-- zip [1, 2] ['a', 'b'] = [(1, 'a'), (2, 'b')]
--
--
-- If one input list is short, excess elements of the longer list are
-- discarded:
--
--
-- zip [1] ['a', 'b'] = [(1, 'a')]
-- zip [1, 2] ['a'] = [(1, 'a')]
--
--
-- zip is right-lazy:
--
--
-- zip [] _|_ = []
-- zip _|_ [] = _|_
--
--
-- zip is capable of list fusion, but it is restricted to its
-- first list argument and its resulting list.
zip :: [a] -> [b] -> [(a, b)]
-- | The print function outputs a value of any printable type to the
-- standard output device. Printable types are those that are instances
-- of class Show; print converts values to strings for
-- output using the show operation and adds a newline.
--
-- For example, a program to print the first 20 integers and their powers
-- of 2 could be written as:
--
--
-- main = print ([(n, 2^n) | n <- [0..19]])
--
print :: Show a => a -> IO ()
-- | Extract the first component of a pair.
fst :: (a, b) -> a
-- | Extract the second component of a pair.
snd :: (a, b) -> b
-- | otherwise is defined as the value True. It helps to make
-- guards more readable. eg.
--
--
-- f x | x < 0 = ...
-- | otherwise = ...
--
otherwise :: Bool
-- | <math>. map f xs is the list obtained by
-- applying f to each element of xs, i.e.,
--
--
-- map f [x1, x2, ..., xn] == [f x1, f x2, ..., f xn]
-- map f [x1, x2, ...] == [f x1, f x2, ...]
--
--
--
-- >>> map (+1) [1, 2, 3]
--
map :: (a -> b) -> [a] -> [b]
-- | Application operator. This operator is redundant, since ordinary
-- application (f x) means the same as (f $ x).
-- However, $ has low, right-associative binding precedence, so it
-- sometimes allows parentheses to be omitted; for example:
--
--
-- f $ g $ h x = f (g (h x))
--
--
-- It is also useful in higher-order situations, such as map
-- ($ 0) xs, or zipWith ($) fs xs.
--
-- Note that ($) is levity-polymorphic in its result
-- type, so that foo $ True where foo :: Bool ->
-- Int# is well-typed.
($) :: forall (r :: RuntimeRep) a (b :: TYPE r). (a -> b) -> a -> b
infixr 0 $
-- | general coercion from integral types
fromIntegral :: (Integral a, Num b) => a -> b
-- | general coercion to fractional types
realToFrac :: (Real a, Fractional b) => a -> b
-- | The Bounded class is used to name the upper and lower limits of
-- a type. Ord is not a superclass of Bounded since types
-- that are not totally ordered may also have upper and lower bounds.
--
-- The Bounded class may be derived for any enumeration type;
-- minBound is the first constructor listed in the data
-- declaration and maxBound is the last. Bounded may also
-- be derived for single-constructor datatypes whose constituent types
-- are in Bounded.
class Bounded a
minBound :: Bounded a => a
maxBound :: Bounded a => a
-- | Class Enum defines operations on sequentially ordered types.
--
-- The enumFrom... methods are used in Haskell's translation of
-- arithmetic sequences.
--
-- Instances of Enum may be derived for any enumeration type
-- (types whose constructors have no fields). The nullary constructors
-- are assumed to be numbered left-to-right by fromEnum from
-- 0 through n-1. See Chapter 10 of the Haskell
-- Report for more details.
--
-- For any type that is an instance of class Bounded as well as
-- Enum, the following should hold:
--
--
--
--
-- enumFrom x = enumFromTo x maxBound
-- enumFromThen x y = enumFromThenTo x y bound
-- where
-- bound | fromEnum y >= fromEnum x = maxBound
-- | otherwise = minBound
--
class Enum a
-- | the successor of a value. For numeric types, succ adds 1.
succ :: Enum a => a -> a
-- | the predecessor of a value. For numeric types, pred subtracts
-- 1.
pred :: Enum a => a -> a
-- | Convert from an Int.
toEnum :: Enum a => Int -> a
-- | Convert to an Int. It is implementation-dependent what
-- fromEnum returns when applied to a value that is too large to
-- fit in an Int.
fromEnum :: Enum a => a -> Int
-- | Used in Haskell's translation of [n..] with [n..] =
-- enumFrom n, a possible implementation being enumFrom n = n :
-- enumFrom (succ n). For example:
--
--
-- enumFrom 4 :: [Integer] = [4,5,6,7,...]
enumFrom 6 :: [Int] = [6,7,8,9,...,maxBound ::
-- Int]
enumFrom :: Enum a => a -> [a]
-- | Used in Haskell's translation of [n,n'..] with [n,n'..] =
-- enumFromThen n n', a possible implementation being
-- enumFromThen n n' = n : n' : worker (f x) (f x n'),
-- worker s v = v : worker s (s v), x = fromEnum n' -
-- fromEnum n and f n y | n > 0 = f (n - 1) (succ y) | n <
-- 0 = f (n + 1) (pred y) | otherwise = y For example:
--
--
-- enumFromThen 4 6 :: [Integer] = [4,6,8,10...]
enumFromThen 6 2 :: [Int] = [6,2,-2,-6,...,minBound ::
-- Int]
enumFromThen :: Enum a => a -> a -> [a]
-- | Used in Haskell's translation of [n..m] with [n..m] =
-- enumFromTo n m, a possible implementation being enumFromTo n
-- m | n <= m = n : enumFromTo (succ n) m | otherwise = []. For
-- example:
--
--
-- enumFromTo 6 10 :: [Int] = [6,7,8,9,10]
enumFromTo 42 1 :: [Integer] = []
enumFromTo :: Enum a => a -> a -> [a]
-- | Used in Haskell's translation of [n,n'..m] with [n,n'..m]
-- = enumFromThenTo n n' m, a possible implementation being
-- enumFromThenTo n n' m = worker (f x) (c x) n m, x =
-- fromEnum n' - fromEnum n, c x = bool (>=) ((x
-- 0) f n y | n > 0 = f (n - 1) (succ y) | n < 0 = f (n +
-- 1) (pred y) | otherwise = y and worker s c v m | c v m = v :
-- worker s c (s v) m | otherwise = [] For example:
--
--
-- enumFromThenTo 4 2 -6 :: [Integer] =
-- [4,2,0,-2,-4,-6]
enumFromThenTo 6 8 2 :: [Int] = []
enumFromThenTo :: Enum a => a -> a -> a -> [a]
-- | The Eq class defines equality (==) and inequality
-- (/=). All the basic datatypes exported by the Prelude
-- are instances of Eq, and Eq may be derived for any
-- datatype whose constituents are also instances of Eq.
--
-- The Haskell Report defines no laws for Eq. However, ==
-- is customarily expected to implement an equivalence relationship where
-- two values comparing equal are indistinguishable by "public"
-- functions, with a "public" function being one not allowing to see
-- implementation details. For example, for a type representing
-- non-normalised natural numbers modulo 100, a "public" function doesn't
-- make the difference between 1 and 201. It is expected to have the
-- following properties:
--
--
-- - Reflexivity x == x = True
-- - Symmetry x == y = y == x
-- - Transitivity if x == y && y == z =
-- True, then x == z = True
-- - Substitutivity if x == y = True and
-- f is a "public" function whose return type is an instance of
-- Eq, then f x == f y = True
-- - Negation x /= y = not (x ==
-- y)
--
--
-- Minimal complete definition: either == or /=.
class Eq a
(==) :: Eq a => a -> a -> Bool
(/=) :: Eq a => a -> a -> Bool
infix 4 ==
infix 4 /=
-- | Trigonometric and hyperbolic functions and related functions.
--
-- The Haskell Report defines no laws for Floating. However,
-- (+), (*) and exp are
-- customarily expected to define an exponential field and have the
-- following properties:
--
--
-- - exp (a + b) = exp a * exp b
-- - exp (fromInteger 0) = fromInteger 1
--
class Fractional a => Floating a
pi :: Floating a => a
exp :: Floating a => a -> a
log :: Floating a => a -> a
sqrt :: Floating a => a -> a
(**) :: Floating a => a -> a -> a
logBase :: Floating a => a -> a -> a
sin :: Floating a => a -> a
cos :: Floating a => a -> a
tan :: Floating a => a -> a
asin :: Floating a => a -> a
acos :: Floating a => a -> a
atan :: Floating a => a -> a
sinh :: Floating a => a -> a
cosh :: Floating a => a -> a
tanh :: Floating a => a -> a
asinh :: Floating a => a -> a
acosh :: Floating a => a -> a
atanh :: Floating a => a -> a
infixr 8 **
-- | Fractional numbers, supporting real division.
--
-- The Haskell Report defines no laws for Fractional. However,
-- (+) and (*) are customarily expected
-- to define a division ring and have the following properties:
--
--
-- - recip gives the multiplicative inverse x
-- * recip x = recip x * x = fromInteger 1
--
--
-- Note that it isn't customarily expected that a type instance of
-- Fractional implement a field. However, all instances in
-- base do.
class Num a => Fractional a
-- | Fractional division.
(/) :: Fractional a => a -> a -> a
-- | Reciprocal fraction.
recip :: Fractional a => a -> a
-- | Conversion from a Rational (that is Ratio
-- Integer). A floating literal stands for an application of
-- fromRational to a value of type Rational, so such
-- literals have type (Fractional a) => a.
fromRational :: Fractional a => Rational -> a
infixl 7 /
-- | Integral numbers, supporting integer division.
--
-- The Haskell Report defines no laws for Integral. However,
-- Integral instances are customarily expected to define a
-- Euclidean domain and have the following properties for the
-- div/mod and quot/rem pairs, given suitable
-- Euclidean functions f and g:
--
--
-- - x = y * quot x y + rem x y with rem x y
-- = fromInteger 0 or g (rem x y) < g
-- y
-- - x = y * div x y + mod x y with mod x y
-- = fromInteger 0 or f (mod x y) < f
-- y
--
--
-- An example of a suitable Euclidean function, for Integer's
-- instance, is abs.
class (Real a, Enum a) => Integral a
-- | integer division truncated toward zero
quot :: Integral a => a -> a -> a
-- | integer remainder, satisfying
--
--
-- (x `quot` y)*y + (x `rem` y) == x
--
rem :: Integral a => a -> a -> a
-- | integer division truncated toward negative infinity
div :: Integral a => a -> a -> a
-- | integer modulus, satisfying
--
--
-- (x `div` y)*y + (x `mod` y) == x
--
mod :: Integral a => a -> a -> a
-- | simultaneous quot and rem
quotRem :: Integral a => a -> a -> (a, a)
-- | simultaneous div and mod
divMod :: Integral a => a -> a -> (a, a)
-- | conversion to Integer
toInteger :: Integral a => a -> Integer
infixl 7 `mod`
infixl 7 `div`
infixl 7 `rem`
infixl 7 `quot`
-- | The Monad class defines the basic operations over a
-- monad, a concept from a branch of mathematics known as
-- category theory. From the perspective of a Haskell programmer,
-- however, it is best to think of a monad as an abstract datatype
-- of actions. Haskell's do expressions provide a convenient
-- syntax for writing monadic expressions.
--
-- Instances of Monad should satisfy the following:
--
--
--
-- Furthermore, the Monad and Applicative operations should
-- relate as follows:
--
--
--
-- The above laws imply:
--
--
--
-- and that pure and (<*>) satisfy the applicative
-- functor laws.
--
-- The instances of Monad for lists, Maybe and IO
-- defined in the Prelude satisfy these laws.
class Applicative m => Monad (m :: Type -> Type)
-- | Sequentially compose two actions, passing any value produced by the
-- first as an argument to the second.
--
-- 'as >>= bs' can be understood as the do
-- expression
--
--
-- do a <- as
-- bs a
--
(>>=) :: Monad m => m a -> (a -> m b) -> m b
-- | Sequentially compose two actions, discarding any value produced by the
-- first, like sequencing operators (such as the semicolon) in imperative
-- languages.
--
-- 'as >> bs' can be understood as the do
-- expression
--
--
-- do as
-- bs
--
(>>) :: Monad m => m a -> m b -> m b
-- | Inject a value into the monadic type.
return :: Monad m => a -> m a
infixl 1 >>=
infixl 1 >>
-- | A type f is a Functor if it provides a function fmap
-- which, given any types a and b lets you apply any
-- function from (a -> b) to turn an f a into an
-- f b, preserving the structure of f. Furthermore
-- f needs to adhere to the following:
--
--
--
-- Note, that the second law follows from the free theorem of the type
-- fmap and the first law, so you need only check that the former
-- condition holds.
class Functor (f :: Type -> Type)
-- | Using ApplicativeDo: 'fmap f as' can be
-- understood as the do expression
--
--
-- do a <- as
-- pure (f a)
--
--
-- with an inferred Functor constraint.
fmap :: Functor f => (a -> b) -> f a -> f b
-- | Replace all locations in the input with the same value. The default
-- definition is fmap . const, but this may be
-- overridden with a more efficient version.
--
-- Using ApplicativeDo: 'a <$ bs' can be
-- understood as the do expression
--
--
-- do bs
-- pure a
--
--
-- with an inferred Functor constraint.
(<$) :: Functor f => a -> f b -> f a
infixl 4 <$
-- | Basic numeric class.
--
-- The Haskell Report defines no laws for Num. However,
-- (+) and (*) are customarily expected
-- to define a ring and have the following properties:
--
--
-- - Associativity of (+) (x + y) +
-- z = x + (y + z)
-- - Commutativity of (+) x + y
-- = y + x
-- - fromInteger 0 is the additive
-- identity x + fromInteger 0 = x
-- - negate gives the additive inverse x +
-- negate x = fromInteger 0
-- - Associativity of (*) (x * y) *
-- z = x * (y * z)
-- - fromInteger 1 is the multiplicative
-- identity x * fromInteger 1 = x and
-- fromInteger 1 * x = x
-- - Distributivity of (*) with respect to
-- (+) a * (b + c) = (a * b) + (a *
-- c) and (b + c) * a = (b * a) + (c * a)
--
--
-- Note that it isn't customarily expected that a type instance of
-- both Num and Ord implement an ordered ring. Indeed, in
-- base only Integer and Rational do.
class Num a
(+) :: Num a => a -> a -> a
(-) :: Num a => a -> a -> a
(*) :: Num a => a -> a -> a
-- | Unary negation.
negate :: Num a => a -> a
-- | Absolute value.
abs :: Num a => a -> a
-- | Sign of a number. The functions abs and signum should
-- satisfy the law:
--
--
-- abs x * signum x == x
--
--
-- For real numbers, the signum is either -1 (negative),
-- 0 (zero) or 1 (positive).
signum :: Num a => a -> a
-- | Conversion from an Integer. An integer literal represents the
-- application of the function fromInteger to the appropriate
-- value of type Integer, so such literals have type
-- (Num a) => a.
fromInteger :: Num a => Integer -> a
infixl 6 -
infixl 6 +
infixl 7 *
-- | The Ord class is used for totally ordered datatypes.
--
-- Instances of Ord can be derived for any user-defined datatype
-- whose constituent types are in Ord. The declared order of the
-- constructors in the data declaration determines the ordering in
-- derived Ord instances. The Ordering datatype allows a
-- single comparison to determine the precise ordering of two objects.
--
-- The Haskell Report defines no laws for Ord. However,
-- <= is customarily expected to implement a non-strict partial
-- order and have the following properties:
--
--
-- - Transitivity if x <= y && y <=
-- z = True, then x <= z = True
-- - Reflexivity x <= x = True
-- - Antisymmetry if x <= y && y <=
-- x = True, then x == y = True
--
--
-- Note that the following operator interactions are expected to hold:
--
--
-- - x >= y = y <= x
-- - x < y = x <= y && x /= y
-- - x > y = y < x
-- - x < y = compare x y == LT
-- - x > y = compare x y == GT
-- - x == y = compare x y == EQ
-- - min x y == if x <= y then x else y = True
-- - max x y == if x >= y then x else y = True
--
--
-- Note that (7.) and (8.) do not require min and
-- max to return either of their arguments. The result is merely
-- required to equal one of the arguments in terms of (==).
--
-- Minimal complete definition: either compare or <=.
-- Using compare can be more efficient for complex types.
class Eq a => Ord a
compare :: Ord a => a -> a -> Ordering
(<) :: Ord a => a -> a -> Bool
(<=) :: Ord a => a -> a -> Bool
(>) :: Ord a => a -> a -> Bool
(>=) :: Ord a => a -> a -> Bool
max :: Ord a => a -> a -> a
min :: Ord a => a -> a -> a
infix 4 <
infix 4 <=
infix 4 >
infix 4 >=
-- | Parsing of Strings, producing values.
--
-- Derived instances of Read make the following assumptions, which
-- derived instances of Show obey:
--
--
-- - If the constructor is defined to be an infix operator, then the
-- derived Read instance will parse only infix applications of the
-- constructor (not the prefix form).
-- - Associativity is not used to reduce the occurrence of parentheses,
-- although precedence may be.
-- - If the constructor is defined using record syntax, the derived
-- Read will parse only the record-syntax form, and furthermore,
-- the fields must be given in the same order as the original
-- declaration.
-- - The derived Read instance allows arbitrary Haskell
-- whitespace between tokens of the input string. Extra parentheses are
-- also allowed.
--
--
-- For example, given the declarations
--
--
-- infixr 5 :^:
-- data Tree a = Leaf a | Tree a :^: Tree a
--
--
-- the derived instance of Read in Haskell 2010 is equivalent to
--
--
-- instance (Read a) => Read (Tree a) where
--
-- readsPrec d r = readParen (d > app_prec)
-- (\r -> [(Leaf m,t) |
-- ("Leaf",s) <- lex r,
-- (m,t) <- readsPrec (app_prec+1) s]) r
--
-- ++ readParen (d > up_prec)
-- (\r -> [(u:^:v,w) |
-- (u,s) <- readsPrec (up_prec+1) r,
-- (":^:",t) <- lex s,
-- (v,w) <- readsPrec (up_prec+1) t]) r
--
-- where app_prec = 10
-- up_prec = 5
--
--
-- Note that right-associativity of :^: is unused.
--
-- The derived instance in GHC is equivalent to
--
--
-- instance (Read a) => Read (Tree a) where
--
-- readPrec = parens $ (prec app_prec $ do
-- Ident "Leaf" <- lexP
-- m <- step readPrec
-- return (Leaf m))
--
-- +++ (prec up_prec $ do
-- u <- step readPrec
-- Symbol ":^:" <- lexP
-- v <- step readPrec
-- return (u :^: v))
--
-- where app_prec = 10
-- up_prec = 5
--
-- readListPrec = readListPrecDefault
--
--
-- Why do both readsPrec and readPrec exist, and why does
-- GHC opt to implement readPrec in derived Read instances
-- instead of readsPrec? The reason is that readsPrec is
-- based on the ReadS type, and although ReadS is mentioned
-- in the Haskell 2010 Report, it is not a very efficient parser data
-- structure.
--
-- readPrec, on the other hand, is based on a much more efficient
-- ReadPrec datatype (a.k.a "new-style parsers"), but its
-- definition relies on the use of the RankNTypes language
-- extension. Therefore, readPrec (and its cousin,
-- readListPrec) are marked as GHC-only. Nevertheless, it is
-- recommended to use readPrec instead of readsPrec
-- whenever possible for the efficiency improvements it brings.
--
-- As mentioned above, derived Read instances in GHC will
-- implement readPrec instead of readsPrec. The default
-- implementations of readsPrec (and its cousin, readList)
-- will simply use readPrec under the hood. If you are writing a
-- Read instance by hand, it is recommended to write it like so:
--
--
-- instance Read T where
-- readPrec = ...
-- readListPrec = readListPrecDefault
--
class Read a
-- | attempts to parse a value from the front of the string, returning a
-- list of (parsed value, remaining string) pairs. If there is no
-- successful parse, the returned list is empty.
--
-- Derived instances of Read and Show satisfy the
-- following:
--
--
--
-- That is, readsPrec parses the string produced by
-- showsPrec, and delivers the value that showsPrec started
-- with.
readsPrec :: Read a => Int -> ReadS a
-- | The method readList is provided to allow the programmer to give
-- a specialised way of parsing lists of values. For example, this is
-- used by the predefined Read instance of the Char type,
-- where values of type String should be are expected to use
-- double quotes, rather than square brackets.
readList :: Read a => ReadS [a]
class (Num a, Ord a) => Real a
-- | the rational equivalent of its real argument with full precision
toRational :: Real a => a -> Rational
-- | Efficient, machine-independent access to the components of a
-- floating-point number.
class (RealFrac a, Floating a) => RealFloat a
-- | a constant function, returning the radix of the representation (often
-- 2)
floatRadix :: RealFloat a => a -> Integer
-- | a constant function, returning the number of digits of
-- floatRadix in the significand
floatDigits :: RealFloat a => a -> Int
-- | a constant function, returning the lowest and highest values the
-- exponent may assume
floatRange :: RealFloat a => a -> (Int, Int)
-- | The function decodeFloat applied to a real floating-point
-- number returns the significand expressed as an Integer and an
-- appropriately scaled exponent (an Int). If
-- decodeFloat x yields (m,n), then x
-- is equal in value to m*b^^n, where b is the
-- floating-point radix, and furthermore, either m and
-- n are both zero or else b^(d-1) <= abs m <
-- b^d, where d is the value of floatDigits
-- x. In particular, decodeFloat 0 = (0,0). If the
-- type contains a negative zero, also decodeFloat (-0.0) =
-- (0,0). The result of decodeFloat x is
-- unspecified if either of isNaN x or
-- isInfinite x is True.
decodeFloat :: RealFloat a => a -> (Integer, Int)
-- | encodeFloat performs the inverse of decodeFloat in the
-- sense that for finite x with the exception of -0.0,
-- uncurry encodeFloat (decodeFloat x) = x.
-- encodeFloat m n is one of the two closest
-- representable floating-point numbers to m*b^^n (or
-- ±Infinity if overflow occurs); usually the closer, but if
-- m contains too many bits, the result may be rounded in the
-- wrong direction.
encodeFloat :: RealFloat a => Integer -> Int -> a
-- | exponent corresponds to the second component of
-- decodeFloat. exponent 0 = 0 and for finite
-- nonzero x, exponent x = snd (decodeFloat x)
-- + floatDigits x. If x is a finite floating-point
-- number, it is equal in value to significand x * b ^^
-- exponent x, where b is the floating-point radix.
-- The behaviour is unspecified on infinite or NaN values.
exponent :: RealFloat a => a -> Int
-- | The first component of decodeFloat, scaled to lie in the open
-- interval (-1,1), either 0.0 or of absolute
-- value >= 1/b, where b is the floating-point
-- radix. The behaviour is unspecified on infinite or NaN
-- values.
significand :: RealFloat a => a -> a
-- | multiplies a floating-point number by an integer power of the radix
scaleFloat :: RealFloat a => Int -> a -> a
-- | True if the argument is an IEEE "not-a-number" (NaN) value
isNaN :: RealFloat a => a -> Bool
-- | True if the argument is an IEEE infinity or negative infinity
isInfinite :: RealFloat a => a -> Bool
-- | True if the argument is too small to be represented in
-- normalized format
isDenormalized :: RealFloat a => a -> Bool
-- | True if the argument is an IEEE negative zero
isNegativeZero :: RealFloat a => a -> Bool
-- | True if the argument is an IEEE floating point number
isIEEE :: RealFloat a => a -> Bool
-- | a version of arctangent taking two real floating-point arguments. For
-- real floating x and y, atan2 y x
-- computes the angle (from the positive x-axis) of the vector from the
-- origin to the point (x,y). atan2 y x returns
-- a value in the range [-pi, pi]. It follows the
-- Common Lisp semantics for the origin when signed zeroes are supported.
-- atan2 y 1, with y in a type that is
-- RealFloat, should return the same value as atan
-- y. A default definition of atan2 is provided, but
-- implementors can provide a more accurate implementation.
atan2 :: RealFloat a => a -> a -> a
-- | Extracting components of fractions.
class (Real a, Fractional a) => RealFrac a
-- | The function properFraction takes a real fractional number
-- x and returns a pair (n,f) such that x =
-- n+f, and:
--
--
-- - n is an integral number with the same sign as x;
-- and
-- - f is a fraction with the same type and sign as
-- x, and with absolute value less than 1.
--
--
-- The default definitions of the ceiling, floor,
-- truncate and round functions are in terms of
-- properFraction.
properFraction :: (RealFrac a, Integral b) => a -> (b, a)
-- | truncate x returns the integer nearest x
-- between zero and x
truncate :: (RealFrac a, Integral b) => a -> b
-- | round x returns the nearest integer to x; the
-- even integer if x is equidistant between two integers
round :: (RealFrac a, Integral b) => a -> b
-- | ceiling x returns the least integer not less than
-- x
ceiling :: (RealFrac a, Integral b) => a -> b
-- | floor x returns the greatest integer not greater than
-- x
floor :: (RealFrac a, Integral b) => a -> b
-- | Conversion of values to readable Strings.
--
-- Derived instances of Show have the following properties, which
-- are compatible with derived instances of Read:
--
--
-- - The result of show is a syntactically correct Haskell
-- expression containing only constants, given the fixity declarations in
-- force at the point where the type is declared. It contains only the
-- constructor names defined in the data type, parentheses, and spaces.
-- When labelled constructor fields are used, braces, commas, field
-- names, and equal signs are also used.
-- - If the constructor is defined to be an infix operator, then
-- showsPrec will produce infix applications of the
-- constructor.
-- - the representation will be enclosed in parentheses if the
-- precedence of the top-level constructor in x is less than
-- d (associativity is ignored). Thus, if d is
-- 0 then the result is never surrounded in parentheses; if
-- d is 11 it is always surrounded in parentheses,
-- unless it is an atomic expression.
-- - If the constructor is defined using record syntax, then
-- show will produce the record-syntax form, with the fields given
-- in the same order as the original declaration.
--
--
-- For example, given the declarations
--
--
-- infixr 5 :^:
-- data Tree a = Leaf a | Tree a :^: Tree a
--
--
-- the derived instance of Show is equivalent to
--
--
-- instance (Show a) => Show (Tree a) where
--
-- showsPrec d (Leaf m) = showParen (d > app_prec) $
-- showString "Leaf " . showsPrec (app_prec+1) m
-- where app_prec = 10
--
-- showsPrec d (u :^: v) = showParen (d > up_prec) $
-- showsPrec (up_prec+1) u .
-- showString " :^: " .
-- showsPrec (up_prec+1) v
-- where up_prec = 5
--
--
-- Note that right-associativity of :^: is ignored. For example,
--
--
-- - show (Leaf 1 :^: Leaf 2 :^: Leaf 3) produces the
-- string "Leaf 1 :^: (Leaf 2 :^: Leaf 3)".
--
class Show a
-- | Convert a value to a readable String.
--
-- showsPrec should satisfy the law
--
--
-- showsPrec d x r ++ s == showsPrec d x (r ++ s)
--
--
-- Derived instances of Read and Show satisfy the
-- following:
--
--
--
-- That is, readsPrec parses the string produced by
-- showsPrec, and delivers the value that showsPrec started
-- with.
showsPrec :: Show a => Int -> a -> ShowS
-- | A specialised variant of showsPrec, using precedence context
-- zero, and returning an ordinary String.
show :: Show a => a -> String
-- | The method showList is provided to allow the programmer to give
-- a specialised way of showing lists of values. For example, this is
-- used by the predefined Show instance of the Char type,
-- where values of type String should be shown in double quotes,
-- rather than between square brackets.
showList :: Show a => [a] -> ShowS
-- | When a value is bound in do-notation, the pattern on the left
-- hand side of <- might not match. In this case, this class
-- provides a function to recover.
--
-- A Monad without a MonadFail instance may only be used in
-- conjunction with pattern that always match, such as newtypes, tuples,
-- data types with only a single data constructor, and irrefutable
-- patterns (~pat).
--
-- Instances of MonadFail should satisfy the following law:
-- fail s should be a left zero for >>=,
--
--
-- fail s >>= f = fail s
--
--
-- If your Monad is also MonadPlus, a popular definition is
--
--
-- fail _ = mzero
--
class Monad m => MonadFail (m :: Type -> Type)
fail :: MonadFail m => String -> m a
-- | A functor with application, providing operations to
--
--
-- - embed pure expressions (pure), and
-- - sequence computations and combine their results (<*>
-- and liftA2).
--
--
-- A minimal complete definition must include implementations of
-- pure and of either <*> or liftA2. If it
-- defines both, then they must behave the same as their default
-- definitions:
--
--
-- (<*>) = liftA2 id
--
--
--
-- liftA2 f x y = f <$> x <*> y
--
--
-- Further, any definition must satisfy the following:
--
--
--
-- The other methods have the following default definitions, which may be
-- overridden with equivalent specialized implementations:
--
--
--
-- As a consequence of these laws, the Functor instance for
-- f will satisfy
--
--
--
-- It may be useful to note that supposing
--
--
-- forall x y. p (q x y) = f x . g y
--
--
-- it follows from the above that
--
--
-- liftA2 p (liftA2 q u v) = liftA2 f u . liftA2 g v
--
--
-- If f is also a Monad, it should satisfy
--
--
--
-- (which implies that pure and <*> satisfy the
-- applicative functor laws).
class Functor f => Applicative (f :: Type -> Type)
-- | Lift a value.
pure :: Applicative f => a -> f a
-- | Sequential application.
--
-- A few functors support an implementation of <*> that is
-- more efficient than the default one.
--
-- Using ApplicativeDo: 'fs <*> as' can be
-- understood as the do expression
--
--
-- do f <- fs
-- a <- as
-- pure (f a)
--
(<*>) :: Applicative f => f (a -> b) -> f a -> f b
-- | Sequence actions, discarding the value of the first argument.
--
-- 'as *> bs' can be understood as the do
-- expression
--
--
-- do as
-- bs
--
--
-- This is a tad complicated for our ApplicativeDo extension
-- which will give it a Monad constraint. For an
-- Applicative constraint we write it of the form
--
--
-- do _ <- as
-- b <- bs
-- pure b
--
(*>) :: Applicative f => f a -> f b -> f b
-- | Sequence actions, discarding the value of the second argument.
--
-- Using ApplicativeDo: 'as <* bs' can be
-- understood as the do expression
--
--
-- do a <- as
-- bs
-- pure a
--
(<*) :: Applicative f => f a -> f b -> f a
infixl 4 <*
infixl 4 *>
infixl 4 <*>
-- | Does the element occur in the structure?
elem :: (Foldable t, Eq a) => a -> t a -> Bool
infix 4 `elem`
-- | The least element of a non-empty structure.
minimum :: (Foldable t, Ord a) => t a -> a
-- | The largest element of a non-empty structure.
maximum :: (Foldable t, Ord a) => t a -> a
-- | The product function computes the product of the numbers of a
-- structure.
product :: (Foldable t, Num a) => t a -> a
-- | Left-associative fold of a structure.
--
-- In the case of lists, foldl, when applied to a binary operator,
-- a starting value (typically the left-identity of the operator), and a
-- list, reduces the list using the binary operator, from left to right:
--
--
-- foldl f z [x1, x2, ..., xn] == (...((z `f` x1) `f` x2) `f`...) `f` xn
--
--
-- Note that to produce the outermost application of the operator the
-- entire input list must be traversed. This means that foldl'
-- will diverge if given an infinite list.
--
-- Also note that if you want an efficient left-fold, you probably want
-- to use foldl' instead of foldl. The reason for this is
-- that latter does not force the "inner" results (e.g. z `f` x1
-- in the above example) before applying them to the operator (e.g. to
-- (`f` x2)). This results in a thunk chain <math>
-- elements long, which then must be evaluated from the outside-in.
--
-- For a general Foldable structure this should be semantically
-- identical to,
--
--
-- foldl f z = foldl f z . toList
--
foldl :: Foldable t => (b -> a -> b) -> b -> t a -> b
-- | The sum function computes the sum of the numbers of a
-- structure.
sum :: (Foldable t, Num a) => t a -> a
-- | The class of monoids (types with an associative binary operation that
-- has an identity). Instances should satisfy the following:
--
--
--
-- The method names refer to the monoid of lists under concatenation, but
-- there are many other instances.
--
-- Some types can be viewed as a monoid in more than one way, e.g. both
-- addition and multiplication on numbers. In such cases we often define
-- newtypes and make those instances of Monoid, e.g.
-- Sum and Product.
--
-- NOTE: Semigroup is a superclass of Monoid since
-- base-4.11.0.0.
class Semigroup a => Monoid a
-- | Identity of mappend
--
--
-- >>> "Hello world" <> mempty
-- "Hello world"
--
mempty :: Monoid a => a
-- | An associative operation
--
-- NOTE: This method is redundant and has the default
-- implementation mappend = (<>) since
-- base-4.11.0.0. Should it be implemented manually, since
-- mappend is a synonym for (<>), it is expected that
-- the two functions are defined the same way. In a future GHC release
-- mappend will be removed from Monoid.
mappend :: Monoid a => a -> a -> a
-- | Fold a list using the monoid.
--
-- For most types, the default definition for mconcat will be
-- used, but the function is included in the class definition so that an
-- optimized version can be provided for specific types.
--
--
-- >>> mconcat ["Hello", " ", "Haskell", "!"]
-- "Hello Haskell!"
--
mconcat :: Monoid a => [a] -> a
data Bool
False :: Bool
True :: Bool
-- | The character type Char is an enumeration whose values
-- represent Unicode (or equivalently ISO/IEC 10646) code points (i.e.
-- characters, see http://www.unicode.org/ for details). This set
-- extends the ISO 8859-1 (Latin-1) character set (the first 256
-- characters), which is itself an extension of the ASCII character set
-- (the first 128 characters). A character literal in Haskell has type
-- Char.
--
-- To convert a Char to or from the corresponding Int value
-- defined by Unicode, use toEnum and fromEnum from the
-- Enum class respectively (or equivalently ord and
-- chr).
data Char
-- | Double-precision floating point numbers. It is desirable that this
-- type be at least equal in range and precision to the IEEE
-- double-precision type.
data Double
-- | Single-precision floating point numbers. It is desirable that this
-- type be at least equal in range and precision to the IEEE
-- single-precision type.
data Float
-- | A fixed-precision integer type with at least the range [-2^29 ..
-- 2^29-1]. The exact range for a given implementation can be
-- determined by using minBound and maxBound from the
-- Bounded class.
data Int
-- | Arbitrary precision integers. In contrast with fixed-size integral
-- types such as Int, the Integer type represents the
-- entire infinite range of integers.
--
-- For more information about this type's representation, see the
-- comments in its implementation.
data Integer
-- | The Maybe type encapsulates an optional value. A value of type
-- Maybe a either contains a value of type a
-- (represented as Just a), or it is empty (represented
-- as Nothing). Using Maybe is a good way to deal with
-- errors or exceptional cases without resorting to drastic measures such
-- as error.
--
-- The Maybe type is also a monad. It is a simple kind of error
-- monad, where all errors are represented by Nothing. A richer
-- error monad can be built using the Either type.
data Maybe a
Nothing :: Maybe a
Just :: a -> Maybe a
data Ordering
LT :: Ordering
EQ :: Ordering
GT :: Ordering
-- | Arbitrary-precision rational numbers, represented as a ratio of two
-- Integer values. A rational number may be constructed using the
-- % operator.
type Rational = Ratio Integer
-- | A value of type IO a is a computation which, when
-- performed, does some I/O before returning a value of type a.
--
-- There is really only one way to "perform" an I/O action: bind it to
-- Main.main in your program. When your program is run, the I/O
-- will be performed. It isn't possible to perform I/O from an arbitrary
-- function, unless that function is itself in the IO monad and
-- called at some point, directly or indirectly, from Main.main.
--
-- IO is a monad, so IO actions can be combined using
-- either the do-notation or the >> and >>=
-- operations from the Monad class.
data IO a
-- | The Either type represents values with two possibilities: a
-- value of type Either a b is either Left
-- a or Right b.
--
-- The Either type is sometimes used to represent a value which is
-- either correct or an error; by convention, the Left constructor
-- is used to hold an error value and the Right constructor is
-- used to hold a correct value (mnemonic: "right" also means "correct").
--
-- Examples
--
-- The type Either String Int is the type
-- of values which can be either a String or an Int. The
-- Left constructor can be used only on Strings, and the
-- Right constructor can be used only on Ints:
--
--
-- >>> let s = Left "foo" :: Either String Int
--
-- >>> s
-- Left "foo"
--
-- >>> let n = Right 3 :: Either String Int
--
-- >>> n
-- Right 3
--
-- >>> :type s
-- s :: Either String Int
--
-- >>> :type n
-- n :: Either String Int
--
--
-- The fmap from our Functor instance will ignore
-- Left values, but will apply the supplied function to values
-- contained in a Right:
--
--
-- >>> let s = Left "foo" :: Either String Int
--
-- >>> let n = Right 3 :: Either String Int
--
-- >>> fmap (*2) s
-- Left "foo"
--
-- >>> fmap (*2) n
-- Right 6
--
--
-- The Monad instance for Either allows us to chain
-- together multiple actions which may fail, and fail overall if any of
-- the individual steps failed. First we'll write a function that can
-- either parse an Int from a Char, or fail.
--
--
-- >>> import Data.Char ( digitToInt, isDigit )
--
-- >>> :{
-- let parseEither :: Char -> Either String Int
-- parseEither c
-- | isDigit c = Right (digitToInt c)
-- | otherwise = Left "parse error"
--
-- >>> :}
--
--
-- The following should work, since both '1' and '2'
-- can be parsed as Ints.
--
--
-- >>> :{
-- let parseMultiple :: Either String Int
-- parseMultiple = do
-- x <- parseEither '1'
-- y <- parseEither '2'
-- return (x + y)
--
-- >>> :}
--
--
--
-- >>> parseMultiple
-- Right 3
--
--
-- But the following should fail overall, since the first operation where
-- we attempt to parse 'm' as an Int will fail:
--
--
-- >>> :{
-- let parseMultiple :: Either String Int
-- parseMultiple = do
-- x <- parseEither 'm'
-- y <- parseEither '2'
-- return (x + y)
--
-- >>> :}
--
--
--
-- >>> parseMultiple
-- Left "parse error"
--
data Either a b
Left :: a -> Either a b
Right :: b -> Either a b
-- | The readIO function is similar to read except that it
-- signals parse failure to the IO monad instead of terminating
-- the program.
readIO :: Read a => String -> IO a
-- | The readLn function combines getLine and readIO.
readLn :: Read a => IO a
-- | The computation appendFile file str function appends
-- the string str, to the file file.
--
-- Note that writeFile and appendFile write a literal
-- string to a file. To write a value of any printable type, as with
-- print, use the show function to convert the value to a
-- string first.
--
--
-- main = appendFile "squares" (show [(x,x*x) | x <- [0,0.1..2]])
--
appendFile :: FilePath -> String -> IO ()
-- | The computation writeFile file str function writes the
-- string str, to the file file.
writeFile :: FilePath -> String -> IO ()
-- | The readFile function reads a file and returns the contents of
-- the file as a string. The file is read lazily, on demand, as with
-- getContents.
readFile :: FilePath -> IO String
-- | The interact function takes a function of type
-- String->String as its argument. The entire input from the
-- standard input device is passed to this function as its argument, and
-- the resulting string is output on the standard output device.
interact :: (String -> String) -> IO ()
-- | The getContents operation returns all user input as a single
-- string, which is read lazily as it is needed (same as
-- hGetContents stdin).
getContents :: IO String
-- | Read a line from the standard input device (same as hGetLine
-- stdin).
getLine :: IO String
-- | Read a character from the standard input device (same as
-- hGetChar stdin).
getChar :: IO Char
-- | The same as putStr, but adds a newline character.
putStrLn :: String -> IO ()
-- | Write a string to the standard output device (same as hPutStr
-- stdout).
putStr :: String -> IO ()
-- | Write a character to the standard output device (same as
-- hPutChar stdout).
putChar :: Char -> IO ()
-- | Raise an IOError in the IO monad.
ioError :: IOError -> IO a
-- | File and directory names are values of type String, whose
-- precise meaning is operating system dependent. Files can be opened,
-- yielding a handle which can then be used to operate on the contents of
-- that file.
type FilePath = String
-- | Construct an IOError value with a string describing the error.
-- The fail method of the IO instance of the Monad
-- class raises a userError, thus:
--
--
-- instance Monad IO where
-- ...
-- fail s = ioError (userError s)
--
userError :: String -> IOError
-- | The Haskell 2010 type for exceptions in the IO monad. Any I/O
-- operation may raise an IOError instead of returning a result.
-- For a more general type of exception, including also those that arise
-- in pure code, see Exception.
--
-- In Haskell 2010, this is an opaque type.
type IOError = IOException
-- | notElem is the negation of elem.
notElem :: (Foldable t, Eq a) => a -> t a -> Bool
infix 4 `notElem`
-- | or returns the disjunction of a container of Bools. For the
-- result to be False, the container must be finite; True,
-- however, results from a True value finitely far from the left
-- end.
or :: Foldable t => t Bool -> Bool
-- | and returns the conjunction of a container of Bools. For the
-- result to be True, the container must be finite; False,
-- however, results from a False value finitely far from the left
-- end.
and :: Foldable t => t Bool -> Bool
-- | Map a function over all the elements of a container and concatenate
-- the resulting lists.
concatMap :: Foldable t => (a -> [b]) -> t a -> [b]
-- | The concatenation of all the elements of a container of lists.
concat :: Foldable t => t [a] -> [a]
-- | Evaluate each monadic action in the structure from left to right, and
-- ignore the results. For a version that doesn't ignore the results see
-- sequence.
--
-- As of base 4.8.0.0, sequence_ is just sequenceA_,
-- specialized to Monad.
sequence_ :: (Foldable t, Monad m) => t (m a) -> m ()
-- | unwords is an inverse operation to words. It joins words
-- with separating spaces.
--
--
-- >>> unwords ["Lorem", "ipsum", "dolor"]
-- "Lorem ipsum dolor"
--
unwords :: [String] -> String
-- | words breaks a string up into a list of words, which were
-- delimited by white space.
--
--
-- >>> words "Lorem ipsum\ndolor"
-- ["Lorem","ipsum","dolor"]
--
words :: String -> [String]
-- | unlines is an inverse operation to lines. It joins
-- lines, after appending a terminating newline to each.
--
--
-- >>> unlines ["Hello", "World", "!"]
-- "Hello\nWorld\n!\n"
--
unlines :: [String] -> String
-- | lines breaks a string up into a list of strings at newline
-- characters. The resulting strings do not contain newlines.
--
-- Note that after splitting the string at newline characters, the last
-- part of the string is considered a line even if it doesn't end with a
-- newline. For example,
--
--
-- >>> lines ""
-- []
--
--
--
-- >>> lines "\n"
-- [""]
--
--
--
-- >>> lines "one"
-- ["one"]
--
--
--
-- >>> lines "one\n"
-- ["one"]
--
--
--
-- >>> lines "one\n\n"
-- ["one",""]
--
--
--
-- >>> lines "one\ntwo"
-- ["one","two"]
--
--
--
-- >>> lines "one\ntwo\n"
-- ["one","two"]
--
--
-- Thus lines s contains at least as many elements as
-- newlines in s.
lines :: String -> [String]
-- | equivalent to readsPrec with a precedence of 0.
reads :: Read a => ReadS a
-- | Case analysis for the Either type. If the value is
-- Left a, apply the first function to a; if it
-- is Right b, apply the second function to b.
--
-- Examples
--
-- We create two values of type Either String
-- Int, one using the Left constructor and another
-- using the Right constructor. Then we apply "either" the
-- length function (if we have a String) or the "times-two"
-- function (if we have an Int):
--
--
-- >>> let s = Left "foo" :: Either String Int
--
-- >>> let n = Right 3 :: Either String Int
--
-- >>> either length (*2) s
-- 3
--
-- >>> either length (*2) n
-- 6
--
either :: (a -> c) -> (b -> c) -> Either a b -> c
-- | The lex function reads a single lexeme from the input,
-- discarding initial white space, and returning the characters that
-- constitute the lexeme. If the input string contains only white space,
-- lex returns a single successful `lexeme' consisting of the
-- empty string. (Thus lex "" = [("","")].) If there is
-- no legal lexeme at the beginning of the input string, lex fails
-- (i.e. returns []).
--
-- This lexer is not completely faithful to the Haskell lexical syntax in
-- the following respects:
--
--
-- - Qualified names are not handled properly
-- - Octal and hexadecimal numerics are not recognized as a single
-- token
-- - Comments are not treated properly
--
lex :: ReadS String
-- | readParen True p parses what p parses,
-- but surrounded with parentheses.
--
-- readParen False p parses what p
-- parses, but optionally surrounded with parentheses.
readParen :: Bool -> ReadS a -> ReadS a
-- | A parser for a type a, represented as a function that takes a
-- String and returns a list of possible parses as
-- (a,String) pairs.
--
-- Note that this kind of backtracking parser is very inefficient;
-- reading a large structure may be quite slow (cf ReadP).
type ReadS a = String -> [(a, String)]
-- | lcm x y is the smallest positive integer that both
-- x and y divide.
lcm :: Integral a => a -> a -> a
-- | gcd x y is the non-negative factor of both x
-- and y of which every common factor of x and
-- y is also a factor; for example gcd 4 2 = 2,
-- gcd (-4) 6 = 2, gcd 0 4 = 4.
-- gcd 0 0 = 0. (That is, the common divisor
-- that is "greatest" in the divisibility preordering.)
--
-- Note: Since for signed fixed-width integer types, abs
-- minBound < 0, the result may be negative if one of the
-- arguments is minBound (and necessarily is if the other
-- is 0 or minBound) for such types.
gcd :: Integral a => a -> a -> a
-- | raise a number to an integral power
(^^) :: (Fractional a, Integral b) => a -> b -> a
infixr 8 ^^
-- | raise a number to a non-negative integral power
(^) :: (Num a, Integral b) => a -> b -> a
infixr 8 ^
odd :: Integral a => a -> Bool
even :: Integral a => a -> Bool
-- | utility function that surrounds the inner show function with
-- parentheses when the Bool parameter is True.
showParen :: Bool -> ShowS -> ShowS
-- | utility function converting a String to a show function that
-- simply prepends the string unchanged.
showString :: String -> ShowS
-- | utility function converting a Char to a show function that
-- simply prepends the character unchanged.
showChar :: Char -> ShowS
-- | equivalent to showsPrec with a precedence of 0.
shows :: Show a => a -> ShowS
-- | The shows functions return a function that prepends the
-- output String to an existing String. This allows
-- constant-time concatenation of results using function composition.
type ShowS = String -> String
-- | The unzip3 function takes a list of triples and returns three
-- lists, analogous to unzip.
unzip3 :: [(a, b, c)] -> ([a], [b], [c])
-- | unzip transforms a list of pairs into a list of first
-- components and a list of second components.
unzip :: [(a, b)] -> ([a], [b])
-- | The zipWith3 function takes a function which combines three
-- elements, as well as three lists and returns a list of their
-- point-wise combination, analogous to zipWith. It is capable of
-- list fusion, but it is restricted to its first list argument and its
-- resulting list.
zipWith3 :: (a -> b -> c -> d) -> [a] -> [b] -> [c] -> [d]
-- | <math>. zipWith generalises zip by zipping with
-- the function given as the first argument, instead of a tupling
-- function. For example, zipWith (+) is applied to two
-- lists to produce the list of corresponding sums:
--
--
-- >>> zipWith (+) [1, 2, 3] [4, 5, 6]
-- [5,7,9]
--
--
-- zipWith is right-lazy:
--
--
-- zipWith f [] _|_ = []
--
--
-- zipWith is capable of list fusion, but it is restricted to its
-- first list argument and its resulting list.
zipWith :: (a -> b -> c) -> [a] -> [b] -> [c]
-- | zip3 takes three lists and returns a list of triples, analogous
-- to zip. It is capable of list fusion, but it is restricted to
-- its first list argument and its resulting list.
zip3 :: [a] -> [b] -> [c] -> [(a, b, c)]
-- | List index (subscript) operator, starting from 0. It is an instance of
-- the more general genericIndex, which takes an index of any
-- integral type.
(!!) :: [a] -> Int -> a
infixl 9 !!
-- | <math>. lookup key assocs looks up a key in an
-- association list.
--
--
-- >>> lookup 2 [(1, "first"), (2, "second"), (3, "third")]
-- Just "second"
--
lookup :: Eq a => a -> [(a, b)] -> Maybe b
-- | reverse xs returns the elements of xs in
-- reverse order. xs must be finite.
reverse :: [a] -> [a]
-- | break, applied to a predicate p and a list
-- xs, returns a tuple where first element is longest prefix
-- (possibly empty) of xs of elements that do not satisfy
-- p and second element is the remainder of the list:
--
--
-- break (> 3) [1,2,3,4,1,2,3,4] == ([1,2,3],[4,1,2,3,4])
-- break (< 9) [1,2,3] == ([],[1,2,3])
-- break (> 9) [1,2,3] == ([1,2,3],[])
--
--
-- break p is equivalent to span (not .
-- p).
break :: (a -> Bool) -> [a] -> ([a], [a])
-- | span, applied to a predicate p and a list xs,
-- returns a tuple where first element is longest prefix (possibly empty)
-- of xs of elements that satisfy p and second element
-- is the remainder of the list:
--
--
-- span (< 3) [1,2,3,4,1,2,3,4] == ([1,2],[3,4,1,2,3,4])
-- span (< 9) [1,2,3] == ([1,2,3],[])
-- span (< 0) [1,2,3] == ([],[1,2,3])
--
--
-- span p xs is equivalent to (takeWhile p xs,
-- dropWhile p xs)
span :: (a -> Bool) -> [a] -> ([a], [a])
-- | splitAt n xs returns a tuple where first element is
-- xs prefix of length n and second element is the
-- remainder of the list:
--
--
-- splitAt 6 "Hello World!" == ("Hello ","World!")
-- splitAt 3 [1,2,3,4,5] == ([1,2,3],[4,5])
-- splitAt 1 [1,2,3] == ([1],[2,3])
-- splitAt 3 [1,2,3] == ([1,2,3],[])
-- splitAt 4 [1,2,3] == ([1,2,3],[])
-- splitAt 0 [1,2,3] == ([],[1,2,3])
-- splitAt (-1) [1,2,3] == ([],[1,2,3])
--
--
-- It is equivalent to (take n xs, drop n xs) when
-- n is not _|_ (splitAt _|_ xs = _|_).
-- splitAt is an instance of the more general
-- genericSplitAt, in which n may be of any integral
-- type.
splitAt :: Int -> [a] -> ([a], [a])
-- | drop n xs returns the suffix of xs after the
-- first n elements, or [] if n > length
-- xs:
--
--
-- drop 6 "Hello World!" == "World!"
-- drop 3 [1,2,3,4,5] == [4,5]
-- drop 3 [1,2] == []
-- drop 3 [] == []
-- drop (-1) [1,2] == [1,2]
-- drop 0 [1,2] == [1,2]
--
--
-- It is an instance of the more general genericDrop, in which
-- n may be of any integral type.
drop :: Int -> [a] -> [a]
-- | take n, applied to a list xs, returns the
-- prefix of xs of length n, or xs itself if
-- n > length xs:
--
--
-- take 5 "Hello World!" == "Hello"
-- take 3 [1,2,3,4,5] == [1,2,3]
-- take 3 [1,2] == [1,2]
-- take 3 [] == []
-- take (-1) [1,2] == []
-- take 0 [1,2] == []
--
--
-- It is an instance of the more general genericTake, in which
-- n may be of any integral type.
take :: Int -> [a] -> [a]
-- | dropWhile p xs returns the suffix remaining after
-- takeWhile p xs:
--
--
-- dropWhile (< 3) [1,2,3,4,5,1,2,3] == [3,4,5,1,2,3]
-- dropWhile (< 9) [1,2,3] == []
-- dropWhile (< 0) [1,2,3] == [1,2,3]
--
dropWhile :: (a -> Bool) -> [a] -> [a]
-- | takeWhile, applied to a predicate p and a list
-- xs, returns the longest prefix (possibly empty) of
-- xs of elements that satisfy p:
--
--
-- takeWhile (< 3) [1,2,3,4,1,2,3,4] == [1,2]
-- takeWhile (< 9) [1,2,3] == [1,2,3]
-- takeWhile (< 0) [1,2,3] == []
--
takeWhile :: (a -> Bool) -> [a] -> [a]
-- | cycle ties a finite list into a circular one, or equivalently,
-- the infinite repetition of the original list. It is the identity on
-- infinite lists.
cycle :: [a] -> [a]
-- | replicate n x is a list of length n with
-- x the value of every element. It is an instance of the more
-- general genericReplicate, in which n may be of any
-- integral type.
replicate :: Int -> a -> [a]
-- | repeat x is an infinite list, with x the
-- value of every element.
repeat :: a -> [a]
-- | iterate f x returns an infinite list of repeated
-- applications of f to x:
--
--
-- iterate f x == [x, f x, f (f x), ...]
--
--
-- Note that iterate is lazy, potentially leading to thunk
-- build-up if the consumer doesn't force each iterate. See
-- iterate' for a strict variant of this function.
iterate :: (a -> a) -> a -> [a]
-- | <math>. scanr1 is a variant of scanr that has no
-- starting value argument.
scanr1 :: (a -> a -> a) -> [a] -> [a]
-- | <math>. scanr is the right-to-left dual of scanl.
-- Note that
--
--
-- head (scanr f z xs) == foldr f z xs.
--
scanr :: (a -> b -> b) -> b -> [a] -> [b]
-- | <math>. scanl1 is a variant of scanl that has no
-- starting value argument:
--
--
-- scanl1 f [x1, x2, ...] == [x1, x1 `f` x2, ...]
--
scanl1 :: (a -> a -> a) -> [a] -> [a]
-- | <math>. scanl is similar to foldl, but returns a
-- list of successive reduced values from the left:
--
--
-- scanl f z [x1, x2, ...] == [z, z `f` x1, (z `f` x1) `f` x2, ...]
--
--
-- Note that
--
--
-- last (scanl f z xs) == foldl f z xs.
--
scanl :: (b -> a -> b) -> b -> [a] -> [b]
-- | The maybe function takes a default value, a function, and a
-- Maybe value. If the Maybe value is Nothing, the
-- function returns the default value. Otherwise, it applies the function
-- to the value inside the Just and returns the result.
--
-- Examples
--
-- Basic usage:
--
--
-- >>> maybe False odd (Just 3)
-- True
--
--
--
-- >>> maybe False odd Nothing
-- False
--
--
-- Read an integer from a string using readMaybe. If we succeed,
-- return twice the integer; that is, apply (*2) to it. If
-- instead we fail to parse an integer, return 0 by default:
--
--
-- >>> import Text.Read ( readMaybe )
--
-- >>> maybe 0 (*2) (readMaybe "5")
-- 10
--
-- >>> maybe 0 (*2) (readMaybe "")
-- 0
--
--
-- Apply show to a Maybe Int. If we have Just n,
-- we want to show the underlying Int n. But if we have
-- Nothing, we return the empty string instead of (for example)
-- "Nothing":
--
--
-- >>> maybe "" show (Just 5)
-- "5"
--
-- >>> maybe "" show Nothing
-- ""
--
maybe :: b -> (a -> b) -> Maybe a -> b
-- | An infix synonym for fmap.
--
-- The name of this operator is an allusion to $. Note the
-- similarities between their types:
--
--
-- ($) :: (a -> b) -> a -> b
-- (<$>) :: Functor f => (a -> b) -> f a -> f b
--
--
-- Whereas $ is function application, <$> is function
-- application lifted over a Functor.
--
-- Examples
--
-- Convert from a Maybe Int to a Maybe
-- String using show:
--
--
-- >>> show <$> Nothing
-- Nothing
--
-- >>> show <$> Just 3
-- Just "3"
--
--
-- Convert from an Either Int Int to an
-- Either Int String using show:
--
--
-- >>> show <$> Left 17
-- Left 17
--
-- >>> show <$> Right 17
-- Right "17"
--
--
-- Double each element of a list:
--
--
-- >>> (*2) <$> [1,2,3]
-- [2,4,6]
--
--
-- Apply even to the second element of a pair:
--
--
-- >>> even <$> (2,2)
-- (2,True)
--
(<$>) :: Functor f => (a -> b) -> f a -> f b
infixl 4 <$>
-- | uncurry converts a curried function to a function on pairs.
--
-- Examples
--
--
-- >>> uncurry (+) (1,2)
-- 3
--
--
--
-- >>> uncurry ($) (show, 1)
-- "1"
--
--
--
-- >>> map (uncurry max) [(1,2), (3,4), (6,8)]
-- [2,4,8]
--
uncurry :: (a -> b -> c) -> (a, b) -> c
-- | curry converts an uncurried function to a curried function.
--
-- Examples
--
--
-- >>> curry fst 1 2
-- 1
--
curry :: ((a, b) -> c) -> a -> b -> c
-- | the same as flip (-).
--
-- Because - is treated specially in the Haskell grammar,
-- (- e) is not a section, but an application of
-- prefix negation. However, (subtract
-- exp) is equivalent to the disallowed section.
subtract :: Num a => a -> a -> a
-- | asTypeOf is a type-restricted version of const. It is
-- usually used as an infix operator, and its typing forces its first
-- argument (which is usually overloaded) to have the same type as the
-- second.
asTypeOf :: a -> a -> a
-- | until p f yields the result of applying f
-- until p holds.
until :: (a -> Bool) -> (a -> a) -> a -> a
-- | Strict (call-by-value) application operator. It takes a function and
-- an argument, evaluates the argument to weak head normal form (WHNF),
-- then calls the function with that value.
($!) :: forall (r :: RuntimeRep) a (b :: TYPE r). (a -> b) -> a -> b
infixr 0 $!
-- | flip f takes its (first) two arguments in the reverse
-- order of f.
--
--
-- >>> flip (++) "hello" "world"
-- "worldhello"
--
flip :: (a -> b -> c) -> b -> a -> c
-- | Function composition.
(.) :: (b -> c) -> (a -> b) -> a -> c
infixr 9 .
-- | const x is a unary function which evaluates to x for
-- all inputs.
--
--
-- >>> const 42 "hello"
-- 42
--
--
--
-- >>> map (const 42) [0..3]
-- [42,42,42,42]
--
const :: a -> b -> a
-- | Identity function.
--
--
-- id x = x
--
id :: a -> a
-- | Same as >>=, but with the arguments interchanged.
(=<<) :: Monad m => (a -> m b) -> m a -> m b
infixr 1 =<<
-- | A String is a list of characters. String constants in Haskell
-- are values of type String.
--
-- See Data.List for operations on lists.
type String = [Char]
-- | A special case of error. It is expected that compilers will
-- recognize this and insert error messages which are more appropriate to
-- the context in which undefined appears.
undefined :: forall (r :: RuntimeRep) (a :: TYPE r). HasCallStack => a
-- | A variant of error that does not produce a stack trace.
errorWithoutStackTrace :: forall (r :: RuntimeRep) (a :: TYPE r). [Char] -> a
-- | error stops execution and displays an error message.
error :: forall (r :: RuntimeRep) (a :: TYPE r). HasCallStack => [Char] -> a
-- | Boolean "and", lazy in the second argument
(&&) :: Bool -> Bool -> Bool
infixr 3 &&
-- | Boolean "or", lazy in the second argument
(||) :: Bool -> Bool -> Bool
infixr 2 ||
-- | Boolean "not"
not :: Bool -> Bool
-- | The class of semigroups (types with an associative binary operation).
--
-- Instances should satisfy the following:
--
--
-- - Associativity x <> (y <> z) =
-- (x <> y) <> z
--
class Semigroup a
-- | An associative operation.
--
--
-- >>> [1,2,3] <> [4,5,6]
-- [1,2,3,4,5,6]
--
(<>) :: Semigroup a => a -> a -> a
infixr 6 <>
-- | Generically generate a Semigroup (<>) operation
-- for any type implementing Generic. This operation will append
-- two values by point-wise appending their component fields. It is only
-- defined for product types.
--
--
-- gmappend a (gmappend b c) = gmappend (gmappend a b) c
--
gmappend :: (Generic a, GSemigroup (Rep a)) => a -> a -> a
-- | Generically generate a Monoid mempty for any
-- product-like type implementing Generic.
--
-- It is only defined for product types.
--
--
-- gmappend gmempty a = a = gmappend a gmempty
--
gmempty :: (Generic a, GMonoid (Rep a)) => a
-- | The class Typeable allows a concrete representation of a type
-- to be calculated.
class Typeable (a :: k)
-- | A quantified type representation.
type TypeRep = SomeTypeRep
-- | Takes a value of type a and returns a concrete representation
-- of that type.
typeRep :: forall k proxy (a :: k). Typeable a => proxy a -> TypeRep
-- | The Data class comprehends a fundamental primitive
-- gfoldl for folding over constructor applications, say terms.
-- This primitive can be instantiated in several ways to map over the
-- immediate subterms of a term; see the gmap combinators later
-- in this class. Indeed, a generic programmer does not necessarily need
-- to use the ingenious gfoldl primitive but rather the intuitive
-- gmap combinators. The gfoldl primitive is completed by
-- means to query top-level constructors, to turn constructor
-- representations into proper terms, and to list all possible datatype
-- constructors. This completion allows us to serve generic programming
-- scenarios like read, show, equality, term generation.
--
-- The combinators gmapT, gmapQ, gmapM, etc are all
-- provided with default definitions in terms of gfoldl, leaving
-- open the opportunity to provide datatype-specific definitions. (The
-- inclusion of the gmap combinators as members of class
-- Data allows the programmer or the compiler to derive
-- specialised, and maybe more efficient code per datatype. Note:
-- gfoldl is more higher-order than the gmap combinators.
-- This is subject to ongoing benchmarking experiments. It might turn out
-- that the gmap combinators will be moved out of the class
-- Data.)
--
-- Conceptually, the definition of the gmap combinators in terms
-- of the primitive gfoldl requires the identification of the
-- gfoldl function arguments. Technically, we also need to
-- identify the type constructor c for the construction of the
-- result type from the folded term type.
--
-- In the definition of gmapQx combinators, we use
-- phantom type constructors for the c in the type of
-- gfoldl because the result type of a query does not involve the
-- (polymorphic) type of the term argument. In the definition of
-- gmapQl we simply use the plain constant type constructor
-- because gfoldl is left-associative anyway and so it is readily
-- suited to fold a left-associative binary operation over the immediate
-- subterms. In the definition of gmapQr, extra effort is needed. We use
-- a higher-order accumulation trick to mediate between left-associative
-- constructor application vs. right-associative binary operation (e.g.,
-- (:)). When the query is meant to compute a value of type
-- r, then the result type withing generic folding is r
-- -> r. So the result of folding is a function to which we
-- finally pass the right unit.
--
-- With the -XDeriveDataTypeable option, GHC can generate
-- instances of the Data class automatically. For example, given
-- the declaration
--
--
-- data T a b = C1 a b | C2 deriving (Typeable, Data)
--
--
-- GHC will generate an instance that is equivalent to
--
--
-- instance (Data a, Data b) => Data (T a b) where
-- gfoldl k z (C1 a b) = z C1 `k` a `k` b
-- gfoldl k z C2 = z C2
--
-- gunfold k z c = case constrIndex c of
-- 1 -> k (k (z C1))
-- 2 -> z C2
--
-- toConstr (C1 _ _) = con_C1
-- toConstr C2 = con_C2
--
-- dataTypeOf _ = ty_T
--
-- con_C1 = mkConstr ty_T "C1" [] Prefix
-- con_C2 = mkConstr ty_T "C2" [] Prefix
-- ty_T = mkDataType "Module.T" [con_C1, con_C2]
--
--
-- This is suitable for datatypes that are exported transparently.
class Typeable a => Data a
-- | Representable types of kind *. This class is derivable in GHC
-- with the DeriveGeneric flag on.
--
-- A Generic instance must satisfy the following laws:
--
--
-- from . to ≡ id
-- to . from ≡ id
--
class Generic a
-- | A class of types that can be fully evaluated.
class NFData a
-- | rnf should reduce its argument to normal form (that is, fully
-- evaluate all sub-components), and then return ().
--
--
--
-- Starting with GHC 7.2, you can automatically derive instances for
-- types possessing a Generic instance.
--
-- Note: Generic1 can be auto-derived starting with GHC 7.4
--
--
-- {-# LANGUAGE DeriveGeneric #-}
--
-- import GHC.Generics (Generic, Generic1)
-- import Control.DeepSeq
--
-- data Foo a = Foo a String
-- deriving (Eq, Generic, Generic1)
--
-- instance NFData a => NFData (Foo a)
-- instance NFData1 Foo
--
-- data Colour = Red | Green | Blue
-- deriving Generic
--
-- instance NFData Colour
--
--
-- Starting with GHC 7.10, the example above can be written more
-- concisely by enabling the new DeriveAnyClass extension:
--
--
-- {-# LANGUAGE DeriveGeneric, DeriveAnyClass #-}
--
-- import GHC.Generics (Generic)
-- import Control.DeepSeq
--
-- data Foo a = Foo a String
-- deriving (Eq, Generic, Generic1, NFData, NFData1)
--
-- data Colour = Red | Green | Blue
-- deriving (Generic, NFData)
--
--
-- Compatibility with previous deepseq versions
--
-- Prior to version 1.4.0.0, the default implementation of the rnf
-- method was defined as
--
--
-- rnf a = seq a ()
--
--
-- However, starting with deepseq-1.4.0.0, the default
-- implementation is based on DefaultSignatures allowing for
-- more accurate auto-derived NFData instances. If you need the
-- previously used exact default rnf method implementation
-- semantics, use
--
--
-- instance NFData Colour where rnf x = seq x ()
--
--
-- or alternatively
--
--
-- instance NFData Colour where rnf = rwhnf
--
--
-- or
--
--
-- {-# LANGUAGE BangPatterns #-}
-- instance NFData Colour where rnf !_ = ()
--
rnf :: NFData a => a -> ()
-- | GHC.Generics-based rnf implementation
--
-- This is needed in order to support deepseq < 1.4 which
-- didn't have a Generic-based default rnf implementation
-- yet.
--
-- In order to define instances, use e.g.
--
--
-- instance NFData MyType where rnf = genericRnf
--
--
-- The implementation has been taken from deepseq-1.4.2's
-- default rnf implementation.
genericRnf :: (Generic a, GNFData (Rep a)) => a -> ()
-- | The Binary class provides put and get, methods to
-- encode and decode a Haskell value to a lazy ByteString. It
-- mirrors the Read and Show classes for textual
-- representation of Haskell types, and is suitable for serialising
-- Haskell values to disk, over the network.
--
-- For decoding and generating simple external binary formats (e.g. C
-- structures), Binary may be used, but in general is not suitable for
-- complex protocols. Instead use the Put and Get
-- primitives directly.
--
-- Instances of Binary should satisfy the following property:
--
--
-- decode . encode == id
--
--
-- That is, the get and put methods should be the inverse
-- of each other. A range of instances are provided for basic Haskell
-- types.
class Binary t
-- | Encode a value in the Put monad.
put :: Binary t => t -> Put
-- | Decode a value in the Get monad
get :: Binary t => Get t
-- | Encode a list of values in the Put monad. The default implementation
-- may be overridden to be more efficient but must still have the same
-- encoding format.
putList :: Binary t => [t] -> Put
-- | Class of types with a known Structure.
--
-- For regular data types Structured can be derived generically.
--
--
-- data Record = Record { a :: Int, b :: Bool, c :: [Char] } deriving (Generic)
-- instance Structured Record
--
class Typeable a => Structured a
-- | A monoid on applicative functors.
--
-- If defined, some and many should be the least solutions
-- of the equations:
--
--
class Applicative f => Alternative (f :: Type -> Type)
-- | The identity of <|>
empty :: Alternative f => f a
-- | An associative binary operation
(<|>) :: Alternative f => f a -> f a -> f a
-- | One or more.
some :: Alternative f => f a -> f [a]
-- | Zero or more.
many :: Alternative f => f a -> f [a]
infixl 3 <|>
-- | Monads that also support choice and failure.
class (Alternative m, Monad m) => MonadPlus (m :: Type -> Type)
-- | The identity of mplus. It should also satisfy the equations
--
--
-- mzero >>= f = mzero
-- v >> mzero = mzero
--
--
-- The default definition is
--
--
-- mzero = empty
--
mzero :: MonadPlus m => m a
-- | An associative operation. The default definition is
--
--
-- mplus = (<|>)
--
mplus :: MonadPlus m => m a -> m a -> m a
-- | Class for string-like datastructures; used by the overloaded string
-- extension (-XOverloadedStrings in GHC).
class IsString a
fromString :: IsString a => String -> a
-- | A Map from keys k to values a.
--
-- The Semigroup operation for Map is union, which
-- prefers values from the left operand. If m1 maps a key
-- k to a value a1, and m2 maps the same key
-- to a different value a2, then their union m1 <>
-- m2 maps k to a1.
data Map k a
-- | A set of values a.
data Set a
data NonEmptySet a
-- | Identity functor and monad. (a non-strict monad)
newtype Identity a
Identity :: a -> Identity a
[runIdentity] :: Identity a -> a
-- | Proxy is a type that holds no data, but has a phantom parameter
-- of arbitrary type (or even kind). Its use is to provide type
-- information, even though there is no value available of that type (or
-- it may be too costly to create one).
--
-- Historically, Proxy :: Proxy a is a safer
-- alternative to the undefined :: a idiom.
--
--
-- >>> Proxy :: Proxy (Void, Int -> Int)
-- Proxy
--
--
-- Proxy can even hold types of higher kinds,
--
--
-- >>> Proxy :: Proxy Either
-- Proxy
--
--
--
-- >>> Proxy :: Proxy Functor
-- Proxy
--
--
--
-- >>> Proxy :: Proxy complicatedStructure
-- Proxy
--
data Proxy (t :: k)
Proxy :: Proxy (t :: k)
-- | The Const functor.
newtype Const a (b :: k)
Const :: a -> Const a (b :: k)
[getConst] :: Const a (b :: k) -> a
-- | Uninhabited data type
data Void
-- | Partitions a list of Either into two lists. All the Left
-- elements are extracted, in order, to the first component of the
-- output. Similarly the Right elements are extracted to the
-- second component of the output.
--
-- Examples
--
-- Basic usage:
--
--
-- >>> let list = [ Left "foo", Right 3, Left "bar", Right 7, Left "baz" ]
--
-- >>> partitionEithers list
-- (["foo","bar","baz"],[3,7])
--
--
-- The pair returned by partitionEithers x should be the
-- same pair as (lefts x, rights x):
--
--
-- >>> let list = [ Left "foo", Right 3, Left "bar", Right 7, Left "baz" ]
--
-- >>> partitionEithers list == (lefts list, rights list)
-- True
--
partitionEithers :: [Either a b] -> ([a], [b])
-- | The catMaybes function takes a list of Maybes and
-- returns a list of all the Just values.
--
-- Examples
--
-- Basic usage:
--
--
-- >>> catMaybes [Just 1, Nothing, Just 3]
-- [1,3]
--
--
-- When constructing a list of Maybe values, catMaybes can
-- be used to return all of the "success" results (if the list is the
-- result of a map, then mapMaybe would be more
-- appropriate):
--
--
-- >>> import Text.Read ( readMaybe )
--
-- >>> [readMaybe x :: Maybe Int | x <- ["1", "Foo", "3"] ]
-- [Just 1,Nothing,Just 3]
--
-- >>> catMaybes $ [readMaybe x :: Maybe Int | x <- ["1", "Foo", "3"] ]
-- [1,3]
--
catMaybes :: [Maybe a] -> [a]
-- | The mapMaybe function is a version of map which can
-- throw out elements. In particular, the functional argument returns
-- something of type Maybe b. If this is Nothing,
-- no element is added on to the result list. If it is Just
-- b, then b is included in the result list.
--
-- Examples
--
-- Using mapMaybe f x is a shortcut for
-- catMaybes $ map f x in most cases:
--
--
-- >>> import Text.Read ( readMaybe )
--
-- >>> let readMaybeInt = readMaybe :: String -> Maybe Int
--
-- >>> mapMaybe readMaybeInt ["1", "Foo", "3"]
-- [1,3]
--
-- >>> catMaybes $ map readMaybeInt ["1", "Foo", "3"]
-- [1,3]
--
--
-- If we map the Just constructor, the entire list should be
-- returned:
--
--
-- >>> mapMaybe Just [1,2,3]
-- [1,2,3]
--
mapMaybe :: (a -> Maybe b) -> [a] -> [b]
-- | The fromMaybe function takes a default value and and
-- Maybe value. If the Maybe is Nothing, it returns
-- the default values; otherwise, it returns the value contained in the
-- Maybe.
--
-- Examples
--
-- Basic usage:
--
--
-- >>> fromMaybe "" (Just "Hello, World!")
-- "Hello, World!"
--
--
--
-- >>> fromMaybe "" Nothing
-- ""
--
--
-- Read an integer from a string using readMaybe. If we fail to
-- parse an integer, we want to return 0 by default:
--
--
-- >>> import Text.Read ( readMaybe )
--
-- >>> fromMaybe 0 (readMaybe "5")
-- 5
--
-- >>> fromMaybe 0 (readMaybe "")
-- 0
--
fromMaybe :: a -> Maybe a -> a
-- | The maybeToList function returns an empty list when given
-- Nothing or a singleton list when given Just.
--
-- Examples
--
-- Basic usage:
--
--
-- >>> maybeToList (Just 7)
-- [7]
--
--
--
-- >>> maybeToList Nothing
-- []
--
--
-- One can use maybeToList to avoid pattern matching when combined
-- with a function that (safely) works on lists:
--
--
-- >>> import Text.Read ( readMaybe )
--
-- >>> sum $ maybeToList (readMaybe "3")
-- 3
--
-- >>> sum $ maybeToList (readMaybe "")
-- 0
--
maybeToList :: Maybe a -> [a]
-- | The listToMaybe function returns Nothing on an empty
-- list or Just a where a is the first element
-- of the list.
--
-- Examples
--
-- Basic usage:
--
--
-- >>> listToMaybe []
-- Nothing
--
--
--
-- >>> listToMaybe [9]
-- Just 9
--
--
--
-- >>> listToMaybe [1,2,3]
-- Just 1
--
--
-- Composing maybeToList with listToMaybe should be the
-- identity on singleton/empty lists:
--
--
-- >>> maybeToList $ listToMaybe [5]
-- [5]
--
-- >>> maybeToList $ listToMaybe []
-- []
--
--
-- But not on lists with more than one element:
--
--
-- >>> maybeToList $ listToMaybe [1,2,3]
-- [1]
--
listToMaybe :: [a] -> Maybe a
-- | The isNothing function returns True iff its argument is
-- Nothing.
--
-- Examples
--
-- Basic usage:
--
--
-- >>> isNothing (Just 3)
-- False
--
--
--
-- >>> isNothing (Just ())
-- False
--
--
--
-- >>> isNothing Nothing
-- True
--
--
-- Only the outer constructor is taken into consideration:
--
--
-- >>> isNothing (Just Nothing)
-- False
--
isNothing :: Maybe a -> Bool
-- | The isJust function returns True iff its argument is of
-- the form Just _.
--
-- Examples
--
-- Basic usage:
--
--
-- >>> isJust (Just 3)
-- True
--
--
--
-- >>> isJust (Just ())
-- True
--
--
--
-- >>> isJust Nothing
-- False
--
--
-- Only the outer constructor is taken into consideration:
--
--
-- >>> isJust (Just Nothing)
-- True
--
isJust :: Maybe a -> Bool
-- | The unfoldr function is a `dual' to foldr: while
-- foldr reduces a list to a summary value, unfoldr builds
-- a list from a seed value. The function takes the element and returns
-- Nothing if it is done producing the list or returns Just
-- (a,b), in which case, a is a prepended to the list
-- and b is used as the next element in a recursive call. For
-- example,
--
--
-- iterate f == unfoldr (\x -> Just (x, f x))
--
--
-- In some cases, unfoldr can undo a foldr operation:
--
--
-- unfoldr f' (foldr f z xs) == xs
--
--
-- if the following holds:
--
--
-- f' (f x y) = Just (x,y)
-- f' z = Nothing
--
--
-- A simple use of unfoldr:
--
--
-- >>> unfoldr (\b -> if b == 0 then Nothing else Just (b, b-1)) 10
-- [10,9,8,7,6,5,4,3,2,1]
--
unfoldr :: (b -> Maybe (a, b)) -> b -> [a]
-- | <math>. The isPrefixOf function takes two lists and
-- returns True iff the first list is a prefix of the second.
--
--
-- >>> "Hello" `isPrefixOf` "Hello World!"
-- True
--
--
--
-- >>> "Hello" `isPrefixOf` "Wello Horld!"
-- False
--
isPrefixOf :: Eq a => [a] -> [a] -> Bool
-- | The isSuffixOf function takes two lists and returns True
-- iff the first list is a suffix of the second. The second list must be
-- finite.
--
--
-- >>> "ld!" `isSuffixOf` "Hello World!"
-- True
--
--
--
-- >>> "World" `isSuffixOf` "Hello World!"
-- False
--
isSuffixOf :: Eq a => [a] -> [a] -> Bool
-- | intercalate xs xss is equivalent to (concat
-- (intersperse xs xss)). It inserts the list xs in
-- between the lists in xss and concatenates the result.
--
--
-- >>> intercalate ", " ["Lorem", "ipsum", "dolor"]
-- "Lorem, ipsum, dolor"
--
intercalate :: [a] -> [[a]] -> [a]
-- | <math>. The intersperse function takes an element and a
-- list and `intersperses' that element between the elements of the list.
-- For example,
--
--
-- >>> intersperse ',' "abcde"
-- "a,b,c,d,e"
--
intersperse :: a -> [a] -> [a]
-- | The sort function implements a stable sorting algorithm. It is
-- a special case of sortBy, which allows the programmer to supply
-- their own comparison function.
--
-- Elements are arranged from lowest to highest, keeping duplicates in
-- the order they appeared in the input.
--
--
-- >>> sort [1,6,4,3,2,5]
-- [1,2,3,4,5,6]
--
sort :: Ord a => [a] -> [a]
-- | The sortBy function is the non-overloaded version of
-- sort.
--
--
-- >>> sortBy (\(a,_) (b,_) -> compare a b) [(2, "world"), (4, "!"), (1, "Hello")]
-- [(1,"Hello"),(2,"world"),(4,"!")]
--
sortBy :: (a -> a -> Ordering) -> [a] -> [a]
-- | <math>. The nub function removes duplicate elements from
-- a list. In particular, it keeps only the first occurrence of each
-- element. (The name nub means `essence'.) It is a special case
-- of nubBy, which allows the programmer to supply their own
-- equality test.
--
--
-- >>> nub [1,2,3,4,3,2,1,2,4,3,5]
-- [1,2,3,4,5]
--
nub :: Eq a => [a] -> [a]
-- | The nubBy function behaves just like nub, except it uses
-- a user-supplied equality predicate instead of the overloaded ==
-- function.
--
--
-- >>> nubBy (\x y -> mod x 3 == mod y 3) [1,2,4,5,6]
-- [1,2,6]
--
nubBy :: (a -> a -> Bool) -> [a] -> [a]
-- | The partition function takes a predicate a list and returns the
-- pair of lists of elements which do and do not satisfy the predicate,
-- respectively; i.e.,
--
--
-- partition p xs == (filter p xs, filter (not . p) xs)
--
--
--
-- >>> partition (`elem` "aeiou") "Hello World!"
-- ("eoo","Hll Wrld!")
--
partition :: (a -> Bool) -> [a] -> ([a], [a])
-- | Non-empty (and non-strict) list type.
data NonEmpty a
(:|) :: a -> [a] -> NonEmpty a
infixr 5 :|
-- | nonEmpty efficiently turns a normal list into a NonEmpty
-- stream, producing Nothing if the input is empty.
nonEmpty :: [a] -> Maybe (NonEmpty a)
foldl1 :: (a -> a -> a) -> NonEmpty a -> a
foldr1 :: (a -> a -> a) -> NonEmpty a -> a
-- | Extract the first element of the stream.
head :: NonEmpty a -> a
-- | Extract the possibly-empty tail of the stream.
tail :: NonEmpty a -> [a]
-- | Extract the last element of the stream.
last :: NonEmpty a -> a
-- | Extract everything except the last element of the stream.
init :: NonEmpty a -> [a]
-- | Data structures that can be folded.
--
-- For example, given a data type
--
--
-- data Tree a = Empty | Leaf a | Node (Tree a) a (Tree a)
--
--
-- a suitable instance would be
--
--
-- instance Foldable Tree where
-- foldMap f Empty = mempty
-- foldMap f (Leaf x) = f x
-- foldMap f (Node l k r) = foldMap f l `mappend` f k `mappend` foldMap f r
--
--
-- This is suitable even for abstract types, as the monoid is assumed to
-- satisfy the monoid laws. Alternatively, one could define
-- foldr:
--
--
-- instance Foldable Tree where
-- foldr f z Empty = z
-- foldr f z (Leaf x) = f x z
-- foldr f z (Node l k r) = foldr f (f k (foldr f z r)) l
--
--
-- Foldable instances are expected to satisfy the following
-- laws:
--
--
-- foldr f z t = appEndo (foldMap (Endo . f) t ) z
--
--
--
-- foldl f z t = appEndo (getDual (foldMap (Dual . Endo . flip f) t)) z
--
--
--
-- fold = foldMap id
--
--
--
-- length = getSum . foldMap (Sum . const 1)
--
--
-- sum, product, maximum, and minimum
-- should all be essentially equivalent to foldMap forms, such
-- as
--
--
-- sum = getSum . foldMap Sum
--
--
-- but may be less defined.
--
-- If the type is also a Functor instance, it should satisfy
--
--
-- foldMap f = fold . fmap f
--
--
-- which implies that
--
--
-- foldMap f . fmap g = foldMap (f . g)
--
class Foldable (t :: Type -> Type)
-- | Map each element of the structure to a monoid, and combine the
-- results.
foldMap :: (Foldable t, Monoid m) => (a -> m) -> t a -> m
-- | Right-associative fold of a structure.
--
-- In the case of lists, foldr, when applied to a binary operator,
-- a starting value (typically the right-identity of the operator), and a
-- list, reduces the list using the binary operator, from right to left:
--
--
-- foldr f z [x1, x2, ..., xn] == x1 `f` (x2 `f` ... (xn `f` z)...)
--
--
-- Note that, since the head of the resulting expression is produced by
-- an application of the operator to the first element of the list,
-- foldr can produce a terminating expression from an infinite
-- list.
--
-- For a general Foldable structure this should be semantically
-- identical to,
--
--
-- foldr f z = foldr f z . toList
--
foldr :: Foldable t => (a -> b -> b) -> b -> t a -> b
-- | Test whether the structure is empty. The default implementation is
-- optimized for structures that are similar to cons-lists, because there
-- is no general way to do better.
null :: Foldable t => t a -> Bool
-- | Returns the size/length of a finite structure as an Int. The
-- default implementation is optimized for structures that are similar to
-- cons-lists, because there is no general way to do better.
length :: Foldable t => t a -> Int
-- | The find function takes a predicate and a structure and returns
-- the leftmost element of the structure matching the predicate, or
-- Nothing if there is no such element.
find :: Foldable t => (a -> Bool) -> t a -> Maybe a
-- | Left-associative fold of a structure but with strict application of
-- the operator.
--
-- This ensures that each step of the fold is forced to weak head normal
-- form before being applied, avoiding the collection of thunks that
-- would otherwise occur. This is often what you want to strictly reduce
-- a finite list to a single, monolithic result (e.g. length).
--
-- For a general Foldable structure this should be semantically
-- identical to,
--
--
-- foldl' f z = foldl' f z . toList
--
foldl' :: Foldable t => (b -> a -> b) -> b -> t a -> b
-- | Map each element of a structure to an action, evaluate these actions
-- from left to right, and ignore the results. For a version that doesn't
-- ignore the results see traverse.
traverse_ :: (Foldable t, Applicative f) => (a -> f b) -> t a -> f ()
-- | for_ is traverse_ with its arguments flipped. For a
-- version that doesn't ignore the results see for.
--
--
-- >>> for_ [1..4] print
-- 1
-- 2
-- 3
-- 4
--
for_ :: (Foldable t, Applicative f) => t a -> (a -> f b) -> f ()
-- | Determines whether any element of the structure satisfies the
-- predicate.
any :: Foldable t => (a -> Bool) -> t a -> Bool
-- | Determines whether all elements of the structure satisfy the
-- predicate.
all :: Foldable t => (a -> Bool) -> t a -> Bool
-- | List of elements of a structure, from left to right.
toList :: Foldable t => t a -> [a]
-- | Functors representing data structures that can be traversed from left
-- to right.
--
-- A definition of traverse must satisfy the following laws:
--
--
--
-- A definition of sequenceA must satisfy the following laws:
--
--
--
-- where an applicative transformation is a function
--
--
-- t :: (Applicative f, Applicative g) => f a -> g a
--
--
-- preserving the Applicative operations, i.e.
--
--
-- t (pure x) = pure x
-- t (f <*> x) = t f <*> t x
--
--
-- and the identity functor Identity and composition functors
-- Compose are from Data.Functor.Identity and
-- Data.Functor.Compose.
--
-- A result of the naturality law is a purity law for traverse
--
--
-- traverse pure = pure
--
--
-- (The naturality law is implied by parametricity and thus so is the
-- purity law [1, p15].)
--
-- Instances are similar to Functor, e.g. given a data type
--
--
-- data Tree a = Empty | Leaf a | Node (Tree a) a (Tree a)
--
--
-- a suitable instance would be
--
--
-- instance Traversable Tree where
-- traverse f Empty = pure Empty
-- traverse f (Leaf x) = Leaf <$> f x
-- traverse f (Node l k r) = Node <$> traverse f l <*> f k <*> traverse f r
--
--
-- This is suitable even for abstract types, as the laws for
-- <*> imply a form of associativity.
--
-- The superclass instances should satisfy the following:
--
--
-- - In the Functor instance, fmap should be equivalent
-- to traversal with the identity applicative functor
-- (fmapDefault).
-- - In the Foldable instance, foldMap should be
-- equivalent to traversal with a constant applicative functor
-- (foldMapDefault).
--
--
-- References: [1] The Essence of the Iterator Pattern, Jeremy Gibbons
-- and Bruno C. d. S. Oliveira
class (Functor t, Foldable t) => Traversable (t :: Type -> Type)
-- | Map each element of a structure to an action, evaluate these actions
-- from left to right, and collect the results. For a version that
-- ignores the results see traverse_.
traverse :: (Traversable t, Applicative f) => (a -> f b) -> t a -> f (t b)
-- | Evaluate each action in the structure from left to right, and collect
-- the results. For a version that ignores the results see
-- sequenceA_.
sequenceA :: (Traversable t, Applicative f) => t (f a) -> f (t a)
-- | for is traverse with its arguments flipped. For a
-- version that ignores the results see for_.
for :: (Traversable t, Applicative f) => t a -> (a -> f b) -> f (t b)
-- | on b u x y runs the binary function b
-- on the results of applying unary function u to two
-- arguments x and y. From the opposite perspective, it
-- transforms two inputs and combines the outputs.
--
--
-- ((+) `on` f) x y = f x + f y
--
--
-- Typical usage: sortBy (compare `on`
-- fst).
--
-- Algebraic properties:
--
--
-- (*) `on` id = (*) -- (if (*) ∉ {⊥, const
-- ⊥})((*) `on` f) `on` g = (*) `on` (f . g)
flip on f . flip on g = flip on (g .
-- f)
on :: (b -> b -> c) -> (a -> b) -> a -> a -> c
infixl 0 `on`
-- |
-- comparing p x y = compare (p x) (p y)
--
--
-- Useful combinator for use in conjunction with the xxxBy
-- family of functions from Data.List, for example:
--
--
-- ... sortBy (comparing fst) ...
--
comparing :: Ord a => (b -> a) -> b -> b -> Ordering
-- | Send the first component of the input through the argument arrow, and
-- copy the rest unchanged to the output.
first :: Arrow a => a b c -> a (b, d) (c, d)
-- | Promote a function to a monad.
liftM :: Monad m => (a1 -> r) -> m a1 -> m r
-- | Promote a function to a monad, scanning the monadic arguments from
-- left to right. For example,
--
--
-- liftM2 (+) [0,1] [0,2] = [0,2,1,3]
-- liftM2 (+) (Just 1) Nothing = Nothing
--
liftM2 :: Monad m => (a1 -> a2 -> r) -> m a1 -> m a2 -> m r
-- | The reverse of when.
unless :: Applicative f => Bool -> f () -> f ()
-- | Conditional execution of Applicative expressions. For example,
--
--
-- when debug (putStrLn "Debugging")
--
--
-- will output the string Debugging if the Boolean value
-- debug is True, and otherwise do nothing.
when :: Applicative f => Bool -> f () -> f ()
-- | In many situations, the liftM operations can be replaced by
-- uses of ap, which promotes function application.
--
--
-- return f `ap` x1 `ap` ... `ap` xn
--
--
-- is equivalent to
--
--
-- liftMn f x1 x2 ... xn
--
ap :: Monad m => m (a -> b) -> m a -> m b
-- | void value discards or ignores the result of
-- evaluation, such as the return value of an IO action.
--
-- Using ApplicativeDo: 'void as' can be
-- understood as the do expression
--
--
-- do as
-- pure ()
--
--
-- with an inferred Functor constraint.
--
-- Examples
--
-- Replace the contents of a Maybe Int with unit:
--
--
-- >>> void Nothing
-- Nothing
--
-- >>> void (Just 3)
-- Just ()
--
--
-- Replace the contents of an Either Int
-- Int with unit, resulting in an Either
-- Int ():
--
--
-- >>> void (Left 8675309)
-- Left 8675309
--
-- >>> void (Right 8675309)
-- Right ()
--
--
-- Replace every element of a list with unit:
--
--
-- >>> void [1,2,3]
-- [(),(),()]
--
--
-- Replace the second element of a pair with unit:
--
--
-- >>> void (1,2)
-- (1,())
--
--
-- Discard the result of an IO action:
--
--
-- >>> mapM print [1,2]
-- 1
-- 2
-- [(),()]
--
-- >>> void $ mapM print [1,2]
-- 1
-- 2
--
void :: Functor f => f a -> f ()
-- | The foldM function is analogous to foldl, except that
-- its result is encapsulated in a monad. Note that foldM works
-- from left-to-right over the list arguments. This could be an issue
-- where (>>) and the `folded function' are not
-- commutative.
--
--
-- foldM f a1 [x1, x2, ..., xm]
--
-- ==
--
-- do
-- a2 <- f a1 x1
-- a3 <- f a2 x2
-- ...
-- f am xm
--
--
-- If right-to-left evaluation is required, the input list should be
-- reversed.
--
-- Note: foldM is the same as foldlM
foldM :: (Foldable t, Monad m) => (b -> a -> m b) -> b -> t a -> m b
-- | This generalizes the list-based filter function.
filterM :: Applicative m => (a -> m Bool) -> [a] -> m [a]
-- | The join function is the conventional monad join operator. It
-- is used to remove one level of monadic structure, projecting its bound
-- argument into the outer level.
--
-- 'join bss' can be understood as the do
-- expression
--
--
-- do bs <- bss
-- bs
--
--
-- Examples
--
-- A common use of join is to run an IO computation
-- returned from an STM transaction, since STM transactions
-- can't perform IO directly. Recall that
--
--
-- atomically :: STM a -> IO a
--
--
-- is used to run STM transactions atomically. So, by specializing
-- the types of atomically and join to
--
--
-- atomically :: STM (IO b) -> IO (IO b)
-- join :: IO (IO b) -> IO b
--
--
-- we can compose them as
--
--
-- join . atomically :: STM (IO b) -> IO b
--
--
-- to run an STM transaction and the IO action it returns.
join :: Monad m => m (m a) -> m a
-- | Conditional failure of Alternative computations. Defined by
--
--
-- guard True = pure ()
-- guard False = empty
--
--
-- Examples
--
-- Common uses of guard include conditionally signaling an error
-- in an error monad and conditionally rejecting the current choice in an
-- Alternative-based parser.
--
-- As an example of signaling an error in the error monad Maybe,
-- consider a safe division function safeDiv x y that returns
-- Nothing when the denominator y is zero and
-- Just (x `div` y) otherwise. For example:
--
--
-- >>> safeDiv 4 0
-- Nothing
-- >>> safeDiv 4 2
-- Just 2
--
--
-- A definition of safeDiv using guards, but not guard:
--
--
-- safeDiv :: Int -> Int -> Maybe Int
-- safeDiv x y | y /= 0 = Just (x `div` y)
-- | otherwise = Nothing
--
--
-- A definition of safeDiv using guard and Monad
-- do-notation:
--
--
-- safeDiv :: Int -> Int -> Maybe Int
-- safeDiv x y = do
-- guard (y /= 0)
-- return (x `div` y)
--
guard :: Alternative f => Bool -> f ()
-- | This is the simplest of the exception-catching functions. It takes a
-- single argument, runs it, and if an exception is raised the "handler"
-- is executed, with the value of the exception passed as an argument.
-- Otherwise, the result is returned as normal. For example:
--
--
-- catch (readFile f)
-- (\e -> do let err = show (e :: IOException)
-- hPutStr stderr ("Warning: Couldn't open " ++ f ++ ": " ++ err)
-- return "")
--
--
-- Note that we have to give a type signature to e, or the
-- program will not typecheck as the type is ambiguous. While it is
-- possible to catch exceptions of any type, see the section "Catching
-- all exceptions" (in Control.Exception) for an explanation of
-- the problems with doing so.
--
-- For catching exceptions in pure (non-IO) expressions, see the
-- function evaluate.
--
-- Note that due to Haskell's unspecified evaluation order, an expression
-- may throw one of several possible exceptions: consider the expression
-- (error "urk") + (1 `div` 0). Does the expression throw
-- ErrorCall "urk", or DivideByZero?
--
-- The answer is "it might throw either"; the choice is
-- non-deterministic. If you are catching any type of exception then you
-- might catch either. If you are calling catch with type IO
-- Int -> (ArithException -> IO Int) -> IO Int then the
-- handler may get run with DivideByZero as an argument, or an
-- ErrorCall "urk" exception may be propogated further up. If
-- you call it again, you might get a the opposite behaviour. This is ok,
-- because catch is an IO computation.
catch :: Exception e => IO a -> (e -> IO a) -> IO a
-- | A variant of throw that can only be used within the IO
-- monad.
--
-- Although throwIO has a type that is an instance of the type of
-- throw, the two functions are subtly different:
--
--
-- throw e `seq` x ===> throw e
-- throwIO e `seq` x ===> x
--
--
-- The first example will cause the exception e to be raised,
-- whereas the second one won't. In fact, throwIO will only cause
-- an exception to be raised when it is used within the IO monad.
-- The throwIO variant should be used in preference to
-- throw to raise an exception within the IO monad because
-- it guarantees ordering with respect to other IO operations,
-- whereas throw does not.
throwIO :: Exception e => e -> IO a
-- | Evaluate the argument to weak head normal form.
--
-- evaluate is typically used to uncover any exceptions that a
-- lazy value may contain, and possibly handle them.
--
-- evaluate only evaluates to weak head normal form. If
-- deeper evaluation is needed, the force function from
-- Control.DeepSeq may be handy:
--
--
-- evaluate $ force x
--
--
-- There is a subtle difference between evaluate x and
-- return $! x, analogous to the difference
-- between throwIO and throw. If the lazy value x
-- throws an exception, return $! x will fail to
-- return an IO action and will throw an exception instead.
-- evaluate x, on the other hand, always produces an
-- IO action; that action will throw an exception upon
-- execution iff x throws an exception upon
-- evaluation.
--
-- The practical implication of this difference is that due to the
-- imprecise exceptions semantics,
--
--
-- (return $! error "foo") >> error "bar"
--
--
-- may throw either "foo" or "bar", depending on the
-- optimizations performed by the compiler. On the other hand,
--
--
-- evaluate (error "foo") >> error "bar"
--
--
-- is guaranteed to throw "foo".
--
-- The rule of thumb is to use evaluate to force or handle
-- exceptions in lazy values. If, on the other hand, you are forcing a
-- lazy value for efficiency reasons only and do not care about
-- exceptions, you may use return $! x.
evaluate :: a -> IO a
-- | Any type that you wish to throw or catch as an exception must be an
-- instance of the Exception class. The simplest case is a new
-- exception type directly below the root:
--
--
-- data MyException = ThisException | ThatException
-- deriving Show
--
-- instance Exception MyException
--
--
-- The default method definitions in the Exception class do what
-- we need in this case. You can now throw and catch
-- ThisException and ThatException as exceptions:
--
--
-- *Main> throw ThisException `catch` \e -> putStrLn ("Caught " ++ show (e :: MyException))
-- Caught ThisException
--
--
-- In more complicated examples, you may wish to define a whole hierarchy
-- of exceptions:
--
--
-- ---------------------------------------------------------------------
-- -- Make the root exception type for all the exceptions in a compiler
--
-- data SomeCompilerException = forall e . Exception e => SomeCompilerException e
--
-- instance Show SomeCompilerException where
-- show (SomeCompilerException e) = show e
--
-- instance Exception SomeCompilerException
--
-- compilerExceptionToException :: Exception e => e -> SomeException
-- compilerExceptionToException = toException . SomeCompilerException
--
-- compilerExceptionFromException :: Exception e => SomeException -> Maybe e
-- compilerExceptionFromException x = do
-- SomeCompilerException a <- fromException x
-- cast a
--
-- ---------------------------------------------------------------------
-- -- Make a subhierarchy for exceptions in the frontend of the compiler
--
-- data SomeFrontendException = forall e . Exception e => SomeFrontendException e
--
-- instance Show SomeFrontendException where
-- show (SomeFrontendException e) = show e
--
-- instance Exception SomeFrontendException where
-- toException = compilerExceptionToException
-- fromException = compilerExceptionFromException
--
-- frontendExceptionToException :: Exception e => e -> SomeException
-- frontendExceptionToException = toException . SomeFrontendException
--
-- frontendExceptionFromException :: Exception e => SomeException -> Maybe e
-- frontendExceptionFromException x = do
-- SomeFrontendException a <- fromException x
-- cast a
--
-- ---------------------------------------------------------------------
-- -- Make an exception type for a particular frontend compiler exception
--
-- data MismatchedParentheses = MismatchedParentheses
-- deriving Show
--
-- instance Exception MismatchedParentheses where
-- toException = frontendExceptionToException
-- fromException = frontendExceptionFromException
--
--
-- We can now catch a MismatchedParentheses exception as
-- MismatchedParentheses, SomeFrontendException or
-- SomeCompilerException, but not other types, e.g.
-- IOException:
--
--
-- *Main> throw MismatchedParentheses `catch` \e -> putStrLn ("Caught " ++ show (e :: MismatchedParentheses))
-- Caught MismatchedParentheses
-- *Main> throw MismatchedParentheses `catch` \e -> putStrLn ("Caught " ++ show (e :: SomeFrontendException))
-- Caught MismatchedParentheses
-- *Main> throw MismatchedParentheses `catch` \e -> putStrLn ("Caught " ++ show (e :: SomeCompilerException))
-- Caught MismatchedParentheses
-- *Main> throw MismatchedParentheses `catch` \e -> putStrLn ("Caught " ++ show (e :: IOException))
-- *** Exception: MismatchedParentheses
--
class (Typeable e, Show e) => Exception e
toException :: Exception e => e -> SomeException
fromException :: Exception e => SomeException -> Maybe e
-- | Render this exception value in a human-friendly manner.
--
-- Default implementation: show.
displayException :: Exception e => e -> String
-- | Exceptions that occur in the IO monad. An
-- IOException records a more specific error type, a descriptive
-- string and maybe the handle that was used when the error was flagged.
data IOException
-- | The SomeException type is the root of the exception type
-- hierarchy. When an exception of type e is thrown, behind the
-- scenes it is encapsulated in a SomeException.
data SomeException
SomeException :: e -> SomeException
-- | Try IOException.
tryIO :: IO a -> IO (Either IOException a)
-- | Catch IOException.
catchIO :: IO a -> (IOException -> IO a) -> IO a
-- | Catch ExitCode
catchExit :: IO a -> (ExitCode -> IO a) -> IO a
-- | deepseq: fully evaluates the first argument, before returning
-- the second.
--
-- The name deepseq is used to illustrate the relationship to
-- seq: where seq is shallow in the sense that it only
-- evaluates the top level of its argument, deepseq traverses the
-- entire data structure evaluating it completely.
--
-- deepseq can be useful for forcing pending exceptions,
-- eradicating space leaks, or forcing lazy I/O to happen. It is also
-- useful in conjunction with parallel Strategies (see the
-- parallel package).
--
-- There is no guarantee about the ordering of evaluation. The
-- implementation may evaluate the components of the structure in any
-- order or in parallel. To impose an actual order on evaluation, use
-- pseq from Control.Parallel in the parallel
-- package.
deepseq :: NFData a => a -> b -> b
-- | a variant of deepseq that is useful in some circumstances:
--
--
-- force x = x `deepseq` x
--
--
-- force x fully evaluates x, and then returns it. Note
-- that force x only performs evaluation when the value of
-- force x itself is demanded, so essentially it turns shallow
-- evaluation into deep evaluation.
--
-- force can be conveniently used in combination with
-- ViewPatterns:
--
--
-- {-# LANGUAGE BangPatterns, ViewPatterns #-}
-- import Control.DeepSeq
--
-- someFun :: ComplexData -> SomeResult
-- someFun (force -> !arg) = {- 'arg' will be fully evaluated -}
--
--
-- Another useful application is to combine force with
-- evaluate in order to force deep evaluation relative to other
-- IO operations:
--
--
-- import Control.Exception (evaluate)
-- import Control.DeepSeq
--
-- main = do
-- result <- evaluate $ force $ pureComputation
-- {- 'result' will be fully evaluated at this point -}
-- return ()
--
--
-- Finally, here's an exception safe variant of the readFile'
-- example:
--
--
-- readFile' :: FilePath -> IO String
-- readFile' fn = bracket (openFile fn ReadMode) hClose $ \h ->
-- evaluate . force =<< hGetContents h
--
force :: NFData a => a -> a
-- | Returns True for any Unicode space character, and the control
-- characters \t, \n, \r, \f,
-- \v.
isSpace :: Char -> Bool
-- | Selects ASCII digits, i.e. '0'..'9'.
isDigit :: Char -> Bool
-- | Selects upper-case or title-case alphabetic Unicode characters
-- (letters). Title case is used by a small number of letter ligatures
-- like the single-character form of Lj.
isUpper :: Char -> Bool
-- | Selects alphabetic Unicode characters (lower-case, upper-case and
-- title-case letters, plus letters of caseless scripts and modifiers
-- letters). This function is equivalent to isLetter.
isAlpha :: Char -> Bool
-- | Selects alphabetic or numeric Unicode characters.
--
-- Note that numeric digits outside the ASCII range, as well as numeric
-- characters which aren't digits, are selected by this function but not
-- by isDigit. Such characters may be part of identifiers but are
-- not used by the printer and reader to represent numbers.
isAlphaNum :: Char -> Bool
-- | The toEnum method restricted to the type Char.
chr :: Int -> Char
-- | The fromEnum method restricted to the type Char.
ord :: Char -> Int
-- | Convert a letter to the corresponding lower-case letter, if any. Any
-- other character is returned unchanged.
toLower :: Char -> Char
-- | Convert a letter to the corresponding upper-case letter, if any. Any
-- other character is returned unchanged.
toUpper :: Char -> Char
-- | Since Void values logically don't exist, this witnesses the
-- logical reasoning tool of "ex falso quodlibet".
--
--
-- >>> let x :: Either Void Int; x = Right 5
--
-- >>> :{
-- case x of
-- Right r -> r
-- Left l -> absurd l
-- :}
-- 5
--
absurd :: Void -> a
-- | If Void is uninhabited then any Functor that holds only
-- values of type Void is holding no values.
--
-- Using ApplicativeDo: 'vacuous theVoid' can be
-- understood as the do expression
--
--
-- do void <- theVoid
-- pure (absurd void)
--
--
-- with an inferred Functor constraint.
vacuous :: Functor f => f Void -> f a
-- | A Word is an unsigned integral type, with the same size as
-- Int.
data Word
-- | 8-bit unsigned integer type
data Word8
-- | 16-bit unsigned integer type
data Word16
-- | 32-bit unsigned integer type
data Word32
-- | 64-bit unsigned integer type
data Word64
-- | 8-bit signed integer type
data Int8
-- | 16-bit signed integer type
data Int16
-- | 32-bit signed integer type
data Int32
-- | 64-bit signed integer type
data Int64
-- | New name for <>
(<<>>) :: Doc -> Doc -> Doc
-- | Beside, separated by space, unless one of the arguments is
-- empty. <+> is associative, with identity
-- empty.
(<+>) :: Doc -> Doc -> Doc
infixl 6 <+>
-- | Defines the exit codes that a program can return.
data ExitCode
-- | indicates successful termination;
ExitSuccess :: ExitCode
-- | indicates program failure with an exit code. The exact interpretation
-- of the code is operating-system dependent. In particular, some values
-- may be prohibited (e.g. 0 on a POSIX-compliant system).
ExitFailure :: Int -> ExitCode
-- | Computation exitWith code throws ExitCode
-- code. Normally this terminates the program, returning
-- code to the program's caller.
--
-- On program termination, the standard Handles stdout and
-- stderr are flushed automatically; any other buffered
-- Handles need to be flushed manually, otherwise the buffered
-- data will be discarded.
--
-- A program that fails in any other way is treated as if it had called
-- exitFailure. A program that terminates successfully without
-- calling exitWith explicitly is treated as if it had called
-- exitWith ExitSuccess.
--
-- As an ExitCode is not an IOError, exitWith
-- bypasses the error handling in the IO monad and cannot be
-- intercepted by catch from the Prelude. However it is a
-- SomeException, and can be caught using the functions of
-- Control.Exception. This means that cleanup computations added
-- with bracket (from Control.Exception) are also executed
-- properly on exitWith.
--
-- Note: in GHC, exitWith should be called from the main program
-- thread in order to exit the process. When called from another thread,
-- exitWith will throw an ExitException as normal, but
-- the exception will not cause the process itself to exit.
exitWith :: ExitCode -> IO a
-- | The computation exitSuccess is equivalent to exitWith
-- ExitSuccess, It terminates the program successfully.
exitSuccess :: IO a
-- | The computation exitFailure is equivalent to exitWith
-- (ExitFailure exitfail), where
-- exitfail is implementation-dependent.
exitFailure :: IO a
-- | Parse a string using the Read instance. Succeeds if there is
-- exactly one valid result.
--
--
-- >>> readMaybe "123" :: Maybe Int
-- Just 123
--
--
--
-- >>> readMaybe "hello" :: Maybe Int
-- Nothing
--
readMaybe :: Read a => String -> Maybe a
-- | Deprecated: Don't leave me in the code
trace :: String -> a -> a
-- | Deprecated: Don't leave me in the code
traceShow :: Show a => a -> b -> b
-- | Deprecated: Don't leave me in the code
traceShowId :: Show a => a -> a
-- | Alternative parser combinators.
--
-- Originally in parsers package.
module Distribution.Compat.Parsing
-- | choice ps tries to apply the parsers in the list ps
-- in order, until one of them succeeds. Returns the value of the
-- succeeding parser.
choice :: Alternative m => [m a] -> m a
-- | option x p tries to apply parser p. If p
-- fails without consuming input, it returns the value x,
-- otherwise the value returned by p.
--
--
-- priority = option 0 (digitToInt <$> digit)
--
option :: Alternative m => a -> m a -> m a
-- | One or none.
optional :: Alternative f => f a -> f (Maybe a)
-- | skipOptional p tries to apply parser p. It will
-- parse p or nothing. It only fails if p fails after
-- consuming input. It discards the result of p. (Plays the role
-- of parsec's optional, which conflicts with Applicative's optional)
skipOptional :: Alternative m => m a -> m ()
-- | between open close p parses open, followed by
-- p and close. Returns the value returned by
-- p.
--
--
-- braces = between (symbol "{") (symbol "}")
--
between :: Applicative m => m bra -> m ket -> m a -> m a
-- | One or more.
some :: Alternative f => f a -> f [a]
-- | Zero or more.
many :: Alternative f => f a -> f [a]
-- | sepBy p sep parses zero or more occurrences of
-- p, separated by sep. Returns a list of values
-- returned by p.
--
--
-- commaSep p = p `sepBy` (symbol ",")
--
sepBy :: Alternative m => m a -> m sep -> m [a]
-- | sepByNonEmpty p sep parses one or more occurrences of
-- p, separated by sep. Returns a non-empty list of
-- values returned by p.
sepByNonEmpty :: Alternative m => m a -> m sep -> m (NonEmpty a)
-- | sepEndByNonEmpty p sep parses one or more occurrences
-- of p, separated and optionally ended by sep. Returns
-- a non-empty list of values returned by p.
sepEndByNonEmpty :: Alternative m => m a -> m sep -> m (NonEmpty a)
-- | sepEndBy p sep parses zero or more occurrences of
-- p, separated and optionally ended by sep, ie.
-- haskell style statements. Returns a list of values returned by
-- p.
--
--
-- haskellStatements = haskellStatement `sepEndBy` semi
--
sepEndBy :: Alternative m => m a -> m sep -> m [a]
-- | endByNonEmpty p sep parses one or more occurrences of
-- p, separated and ended by sep. Returns a non-empty
-- list of values returned by p.
endByNonEmpty :: Alternative m => m a -> m sep -> m (NonEmpty a)
-- | endBy p sep parses zero or more occurrences of
-- p, separated and ended by sep. Returns a list of
-- values returned by p.
--
--
-- cStatements = cStatement `endBy` semi
--
endBy :: Alternative m => m a -> m sep -> m [a]
-- | count n p parses n occurrences of p. If
-- n is smaller or equal to zero, the parser equals to
-- return []. Returns a list of n values returned by
-- p.
count :: Applicative m => Int -> m a -> m [a]
-- | chainl p op x parses zero or more occurrences of
-- p, separated by op. Returns a value obtained by a
-- left associative application of all functions returned by
-- op to the values returned by p. If there are zero
-- occurrences of p, the value x is returned.
chainl :: Alternative m => m a -> m (a -> a -> a) -> a -> m a
-- | chainr p op x parses zero or more occurrences of
-- p, separated by op Returns a value obtained by a
-- right associative application of all functions returned by
-- op to the values returned by p. If there are no
-- occurrences of p, the value x is returned.
chainr :: Alternative m => m a -> m (a -> a -> a) -> a -> m a
-- | chainl1 p op x parses one or more occurrences of
-- p, separated by op Returns a value obtained by a
-- left associative application of all functions returned by
-- op to the values returned by p. . This parser can
-- for example be used to eliminate left recursion which typically occurs
-- in expression grammars.
--
--
-- expr = term `chainl1` addop
-- term = factor `chainl1` mulop
-- factor = parens expr <|> integer
--
-- mulop = (*) <$ symbol "*"
-- <|> div <$ symbol "/"
--
-- addop = (+) <$ symbol "+"
-- <|> (-) <$ symbol "-"
--
chainl1 :: Alternative m => m a -> m (a -> a -> a) -> m a
-- | chainr1 p op x parses one or more occurrences of
-- p, separated by op Returns a value obtained by a
-- right associative application of all functions returned by
-- op to the values returned by p.
chainr1 :: Alternative m => m a -> m (a -> a -> a) -> m a
-- | manyTill p end applies parser p zero or more
-- times until parser end succeeds. Returns the list of values
-- returned by p. This parser can be used to scan comments:
--
--
-- simpleComment = do{ string "<!--"
-- ; manyTill anyChar (try (string "-->"))
-- }
--
--
-- Note the overlapping parsers anyChar and string
-- "-->", and therefore the use of the try combinator.
manyTill :: Alternative m => m a -> m end -> m [a]
-- | Additional functionality needed to describe parsers independent of
-- input type.
class Alternative m => Parsing m
-- | Take a parser that may consume input, and on failure, go back to where
-- we started and fail as if we didn't consume input.
try :: Parsing m => m a -> m a
-- | Give a parser a name
() :: Parsing m => m a -> String -> m a
-- | A version of many that discards its input. Specialized because it can
-- often be implemented more cheaply.
skipMany :: Parsing m => m a -> m ()
-- | skipSome p applies the parser p one or more
-- times, skipping its result. (aka skipMany1 in parsec)
skipSome :: Parsing m => m a -> m ()
-- | Used to emit an error on an unexpected token
unexpected :: Parsing m => String -> m a
-- | This parser only succeeds at the end of the input. This is not a
-- primitive parser but it is defined using notFollowedBy.
--
--
-- eof = notFollowedBy anyChar <?> "end of input"
--
eof :: Parsing m => m ()
-- | notFollowedBy p only succeeds when parser p fails.
-- This parser does not consume any input. This parser can be used to
-- implement the 'longest match' rule. For example, when recognizing
-- keywords (for example let), we want to make sure that a
-- keyword is not followed by a legal identifier character, in which case
-- the keyword is actually an identifier (for example lets). We
-- can program this behaviour as follows:
--
--
-- keywordLet = try $ string "let" <* notFollowedBy alphaNum
--
notFollowedBy :: (Parsing m, Show a) => m a -> m ()
infixr 0
instance (Distribution.Compat.Parsing.Parsing m, GHC.Base.MonadPlus m) => Distribution.Compat.Parsing.Parsing (Control.Monad.Trans.State.Lazy.StateT s m)
instance (Distribution.Compat.Parsing.Parsing m, GHC.Base.MonadPlus m) => Distribution.Compat.Parsing.Parsing (Control.Monad.Trans.State.Strict.StateT s m)
instance (Distribution.Compat.Parsing.Parsing m, GHC.Base.MonadPlus m) => Distribution.Compat.Parsing.Parsing (Control.Monad.Trans.Reader.ReaderT e m)
instance (Distribution.Compat.Parsing.Parsing m, GHC.Base.MonadPlus m, GHC.Base.Monoid w) => Distribution.Compat.Parsing.Parsing (Control.Monad.Trans.Writer.Strict.WriterT w m)
instance (Distribution.Compat.Parsing.Parsing m, GHC.Base.MonadPlus m, GHC.Base.Monoid w) => Distribution.Compat.Parsing.Parsing (Control.Monad.Trans.Writer.Lazy.WriterT w m)
instance (Distribution.Compat.Parsing.Parsing m, GHC.Base.MonadPlus m, GHC.Base.Monoid w) => Distribution.Compat.Parsing.Parsing (Control.Monad.Trans.RWS.Lazy.RWST r w s m)
instance (Distribution.Compat.Parsing.Parsing m, GHC.Base.MonadPlus m, GHC.Base.Monoid w) => Distribution.Compat.Parsing.Parsing (Control.Monad.Trans.RWS.Strict.RWST r w s m)
instance (Distribution.Compat.Parsing.Parsing m, GHC.Base.Monad m) => Distribution.Compat.Parsing.Parsing (Control.Monad.Trans.Identity.IdentityT m)
instance (Text.Parsec.Prim.Stream s m t, GHC.Show.Show t) => Distribution.Compat.Parsing.Parsing (Text.Parsec.Prim.ParsecT s u m)
-- | A very simple difference list.
module Distribution.Compat.DList
-- | Difference list.
data DList a
runDList :: DList a -> [a]
empty :: DList a
-- | Make DList containing single element.
singleton :: a -> DList a
fromList :: [a] -> DList a
toList :: DList a -> [a]
snoc :: DList a -> a -> DList a
instance GHC.Base.Monoid (Distribution.Compat.DList.DList a)
instance GHC.Base.Semigroup (Distribution.Compat.DList.DList a)
-- | This module provides very basic lens functionality, without extra
-- dependencies.
--
-- For the documentation of the combinators see lens package. This
-- module uses the same vocabulary.
module Distribution.Compat.Lens
type Lens s t a b = forall f. Functor f => LensLike f s t a b
type Lens' s a = Lens s s a a
type Traversal s t a b = forall f. Applicative f => LensLike f s t a b
type Traversal' s a = Traversal s s a a
type LensLike f s t a b = (a -> f b) -> s -> f t
type LensLike' f s a = (a -> f a) -> s -> f s
type Getting r s a = LensLike (Const r) s s a a
type AGetter s a = LensLike (Const a) s s a a
type ASetter s t a b = LensLike Identity s t a b
type ALens s t a b = LensLike (Pretext a b) s t a b
type ALens' s a = ALens s s a a
view :: Getting a s a -> s -> a
use :: MonadState s m => Getting a s a -> m a
-- |
-- >>> (3 :: Int) ^. getting (+2) . getting show
-- "5"
--
getting :: (s -> a) -> Getting r s a
set :: ASetter s t a b -> b -> s -> t
over :: ASetter s t a b -> (a -> b) -> s -> t
toDListOf :: Getting (DList a) s a -> s -> DList a
toListOf :: Getting (DList a) s a -> s -> [a]
toSetOf :: Getting (Set a) s a -> s -> Set a
cloneLens :: Functor f => ALens s t a b -> LensLike f s t a b
aview :: ALens s t a b -> s -> a
_1 :: Lens (a, c) (b, c) a b
_2 :: Lens (c, a) (c, b) a b
-- | & is a reverse application operator
(&) :: a -> (a -> b) -> b
infixl 1 &
(^.) :: s -> Getting a s a -> a
infixl 8 ^.
(.~) :: ASetter s t a b -> b -> s -> t
infixr 4 .~
(?~) :: ASetter s t a (Maybe b) -> b -> s -> t
infixr 4 ?~
(%~) :: ASetter s t a b -> (a -> b) -> s -> t
infixr 4 %~
(.=) :: MonadState s m => ASetter s s a b -> b -> m ()
infixr 4 .=
(?=) :: MonadState s m => ASetter s s a (Maybe b) -> b -> m ()
infixr 4 ?=
(%=) :: MonadState s m => ASetter s s a b -> (a -> b) -> m ()
infixr 4 %=
(^#) :: s -> ALens s t a b -> a
infixl 8 ^#
(#~) :: ALens s t a b -> b -> s -> t
infixr 4 #~
(#%~) :: ALens s t a b -> (a -> b) -> s -> t
infixr 4 #%~
-- | lens variant is also parametrised by profunctor.
data Pretext a b t
Pretext :: (forall f. Functor f => (a -> f b) -> f t) -> Pretext a b t
[runPretext] :: Pretext a b t -> forall f. Functor f => (a -> f b) -> f t
instance GHC.Base.Functor (Distribution.Compat.Lens.Pretext a b)
module Distribution.Types.CondTree
-- | A CondTree is used to represent the conditional structure of a
-- Cabal file, reflecting a syntax element subject to constraints, and
-- then any number of sub-elements which may be enabled subject to some
-- condition. Both a and c are usually Monoids.
--
-- To be more concrete, consider the following fragment of a
-- Cabal file:
--
--
-- build-depends: base >= 4.0
-- if flag(extra)
-- build-depends: base >= 4.2
--
--
-- One way to represent this is to have CondTree
-- ConfVar [Dependency] BuildInfo. Here,
-- condTreeData represents the actual fields which are not behind
-- any conditional, while condTreeComponents recursively records
-- any further fields which are behind a conditional.
-- condTreeConstraints records the constraints (in this case,
-- base >= 4.0) which would be applied if you use this
-- syntax; in general, this is derived off of targetBuildInfo
-- (perhaps a good refactoring would be to convert this into an opaque
-- type, with a smart constructor that pre-computes the dependencies.)
data CondTree v c a
CondNode :: a -> c -> [CondBranch v c a] -> CondTree v c a
[condTreeData] :: CondTree v c a -> a
[condTreeConstraints] :: CondTree v c a -> c
[condTreeComponents] :: CondTree v c a -> [CondBranch v c a]
-- | A CondBranch represents a conditional branch, e.g., if
-- flag(foo) on some syntax a. It also has an optional
-- false branch.
data CondBranch v c a
CondBranch :: Condition v -> CondTree v c a -> Maybe (CondTree v c a) -> CondBranch v c a
[condBranchCondition] :: CondBranch v c a -> Condition v
[condBranchIfTrue] :: CondBranch v c a -> CondTree v c a
[condBranchIfFalse] :: CondBranch v c a -> Maybe (CondTree v c a)
condIfThen :: Condition v -> CondTree v c a -> CondBranch v c a
condIfThenElse :: Condition v -> CondTree v c a -> CondTree v c a -> CondBranch v c a
mapCondTree :: (a -> b) -> (c -> d) -> (Condition v -> Condition w) -> CondTree v c a -> CondTree w d b
mapTreeConstrs :: (c -> d) -> CondTree v c a -> CondTree v d a
mapTreeConds :: (Condition v -> Condition w) -> CondTree v c a -> CondTree w c a
mapTreeData :: (a -> b) -> CondTree v c a -> CondTree v c b
-- | @Traversal@ for the variables
traverseCondTreeV :: Traversal (CondTree v c a) (CondTree w c a) v w
-- | @Traversal@ for the variables
traverseCondBranchV :: Traversal (CondBranch v c a) (CondBranch w c a) v w
-- | @Traversal@ for the aggregated constraints
traverseCondTreeC :: Traversal (CondTree v c a) (CondTree v d a) c d
-- | @Traversal@ for the aggregated constraints
traverseCondBranchC :: Traversal (CondBranch v c a) (CondBranch v d a) c d
-- | Extract the condition matched by the given predicate from a cond tree.
--
-- We use this mainly for extracting buildable conditions (see the Note
-- in Distribution.PackageDescription.Configuration), but the function is
-- in fact more general.
extractCondition :: Eq v => (a -> Bool) -> CondTree v c a -> Condition v
-- | Flattens a CondTree using a partial flag assignment. When a condition
-- cannot be evaluated, both branches are ignored.
simplifyCondTree :: (Semigroup a, Semigroup d) => (v -> Either v Bool) -> CondTree v d a -> (d, a)
-- | Flatten a CondTree. This will resolve the CondTree by taking all
-- possible paths into account. Note that since branches represent
-- exclusive choices this may not result in a "sane" result.
ignoreConditions :: (Semigroup a, Semigroup c) => CondTree v c a -> (a, c)
instance Data.Traversable.Traversable (Distribution.Types.CondTree.CondTree v c)
instance Data.Foldable.Foldable (Distribution.Types.CondTree.CondTree v c)
instance GHC.Base.Functor (Distribution.Types.CondTree.CondTree v c)
instance GHC.Generics.Generic (Distribution.Types.CondTree.CondTree v c a)
instance (Data.Data.Data v, Data.Data.Data c, Data.Data.Data a) => Data.Data.Data (Distribution.Types.CondTree.CondTree v c a)
instance (GHC.Classes.Eq a, GHC.Classes.Eq c, GHC.Classes.Eq v) => GHC.Classes.Eq (Distribution.Types.CondTree.CondTree v c a)
instance (GHC.Show.Show a, GHC.Show.Show c, GHC.Show.Show v) => GHC.Show.Show (Distribution.Types.CondTree.CondTree v c a)
instance Data.Traversable.Traversable (Distribution.Types.CondTree.CondBranch v c)
instance GHC.Base.Functor (Distribution.Types.CondTree.CondBranch v c)
instance GHC.Generics.Generic (Distribution.Types.CondTree.CondBranch v c a)
instance (Data.Data.Data v, Data.Data.Data c, Data.Data.Data a) => Data.Data.Data (Distribution.Types.CondTree.CondBranch v c a)
instance (GHC.Classes.Eq v, GHC.Classes.Eq a, GHC.Classes.Eq c) => GHC.Classes.Eq (Distribution.Types.CondTree.CondBranch v c a)
instance (GHC.Show.Show v, GHC.Show.Show a, GHC.Show.Show c) => GHC.Show.Show (Distribution.Types.CondTree.CondBranch v c a)
instance (Data.Binary.Class.Binary v, Data.Binary.Class.Binary c, Data.Binary.Class.Binary a) => Data.Binary.Class.Binary (Distribution.Types.CondTree.CondTree v c a)
instance (Distribution.Utils.Structured.Structured v, Distribution.Utils.Structured.Structured c, Distribution.Utils.Structured.Structured a) => Distribution.Utils.Structured.Structured (Distribution.Types.CondTree.CondTree v c a)
instance (Control.DeepSeq.NFData v, Control.DeepSeq.NFData c, Control.DeepSeq.NFData a) => Control.DeepSeq.NFData (Distribution.Types.CondTree.CondTree v c a)
instance Data.Foldable.Foldable (Distribution.Types.CondTree.CondBranch v c)
instance (Data.Binary.Class.Binary v, Data.Binary.Class.Binary c, Data.Binary.Class.Binary a) => Data.Binary.Class.Binary (Distribution.Types.CondTree.CondBranch v c a)
instance (Distribution.Utils.Structured.Structured v, Distribution.Utils.Structured.Structured c, Distribution.Utils.Structured.Structured a) => Distribution.Utils.Structured.Structured (Distribution.Types.CondTree.CondBranch v c a)
instance (Control.DeepSeq.NFData v, Control.DeepSeq.NFData c, Control.DeepSeq.NFData a) => Control.DeepSeq.NFData (Distribution.Types.CondTree.CondBranch v c a)
-- | Parsers for character streams
--
-- Originally in parsers package.
module Distribution.Compat.CharParsing
-- | oneOf cs succeeds if the current character is in the supplied
-- list of characters cs. Returns the parsed character. See also
-- satisfy.
--
--
-- vowel = oneOf "aeiou"
--
oneOf :: CharParsing m => [Char] -> m Char
-- | As the dual of oneOf, noneOf cs succeeds if the
-- current character is not in the supplied list of characters
-- cs. Returns the parsed character.
--
--
-- consonant = noneOf "aeiou"
--
noneOf :: CharParsing m => [Char] -> m Char
-- | Skips zero or more white space characters. See also
-- skipMany.
spaces :: CharParsing m => m ()
-- | Parses a white space character (any character which satisfies
-- isSpace) Returns the parsed character.
space :: CharParsing m => m Char
-- | Parses a newline character ('\n'). Returns a newline character.
newline :: CharParsing m => m Char
-- | Parses a tab character ('\t'). Returns a tab character.
tab :: CharParsing m => m Char
-- | Parses an upper case letter. Returns the parsed character.
upper :: CharParsing m => m Char
-- | Parses a lower case character. Returns the parsed character.
lower :: CharParsing m => m Char
-- | Parses a letter or digit. Returns the parsed character.
alphaNum :: CharParsing m => m Char
-- | Parses a letter (an upper case or lower case character). Returns the
-- parsed character.
letter :: CharParsing m => m Char
-- | Parses a digit. Returns the parsed character.
digit :: CharParsing m => m Char
-- | Parses a hexadecimal digit (a digit or a letter between 'a' and 'f' or
-- 'A' and 'F'). Returns the parsed character.
hexDigit :: CharParsing m => m Char
-- | Parses an octal digit (a character between '0' and '7'). Returns the
-- parsed character.
octDigit :: CharParsing m => m Char
satisfyRange :: CharParsing m => Char -> Char -> m Char
-- | Additional functionality needed to parse character streams.
class Parsing m => CharParsing m
-- | Parse a single character of the input, with UTF-8 decoding
satisfy :: CharParsing m => (Char -> Bool) -> m Char
-- | char c parses a single character c. Returns the
-- parsed character (i.e. c).
--
-- e.g.
--
--
-- semiColon = char ';'
--
char :: CharParsing m => Char -> m Char
-- | notChar c parses any single character other than c.
-- Returns the parsed character.
notChar :: CharParsing m => Char -> m Char
-- | This parser succeeds for any character. Returns the parsed character.
anyChar :: CharParsing m => m Char
-- | string s parses a sequence of characters given by s.
-- Returns the parsed string (i.e. s).
--
--
-- divOrMod = string "div"
-- <|> string "mod"
--
string :: CharParsing m => String -> m String
-- | text t parses a sequence of characters determined by the text
-- t Returns the parsed text fragment (i.e. t).
--
-- Using OverloadedStrings:
--
--
-- divOrMod = text "div"
-- <|> text "mod"
--
text :: CharParsing m => Text -> m Text
integral :: (CharParsing m, Integral a) => m a
-- | Accepts negative (starting with -) and positive (without
-- sign) integral numbers.
signedIntegral :: (CharParsing m, Integral a) => m a
-- | Greedily munch characters while predicate holds. Require at least one
-- character.
munch1 :: CharParsing m => (Char -> Bool) -> m String
-- | Greedely munch characters while predicate holds. Always succeeds.
munch :: CharParsing m => (Char -> Bool) -> m String
skipSpaces1 :: CharParsing m => m ()
instance (Distribution.Compat.CharParsing.CharParsing m, GHC.Base.MonadPlus m) => Distribution.Compat.CharParsing.CharParsing (Control.Monad.Trans.State.Lazy.StateT s m)
instance (Distribution.Compat.CharParsing.CharParsing m, GHC.Base.MonadPlus m) => Distribution.Compat.CharParsing.CharParsing (Control.Monad.Trans.State.Strict.StateT s m)
instance (Distribution.Compat.CharParsing.CharParsing m, GHC.Base.MonadPlus m) => Distribution.Compat.CharParsing.CharParsing (Control.Monad.Trans.Reader.ReaderT e m)
instance (Distribution.Compat.CharParsing.CharParsing m, GHC.Base.MonadPlus m, GHC.Base.Monoid w) => Distribution.Compat.CharParsing.CharParsing (Control.Monad.Trans.Writer.Strict.WriterT w m)
instance (Distribution.Compat.CharParsing.CharParsing m, GHC.Base.MonadPlus m, GHC.Base.Monoid w) => Distribution.Compat.CharParsing.CharParsing (Control.Monad.Trans.Writer.Lazy.WriterT w m)
instance (Distribution.Compat.CharParsing.CharParsing m, GHC.Base.MonadPlus m, GHC.Base.Monoid w) => Distribution.Compat.CharParsing.CharParsing (Control.Monad.Trans.RWS.Lazy.RWST r w s m)
instance (Distribution.Compat.CharParsing.CharParsing m, GHC.Base.MonadPlus m, GHC.Base.Monoid w) => Distribution.Compat.CharParsing.CharParsing (Control.Monad.Trans.RWS.Strict.RWST r w s m)
instance (Distribution.Compat.CharParsing.CharParsing m, GHC.Base.MonadPlus m) => Distribution.Compat.CharParsing.CharParsing (Control.Monad.Trans.Identity.IdentityT m)
instance Text.Parsec.Prim.Stream s m GHC.Types.Char => Distribution.Compat.CharParsing.CharParsing (Text.Parsec.Prim.ParsecT s u m)
module Distribution.CabalSpecVersion
-- | Different Cabal-the-spec versions.
--
-- We branch based on this at least in the parser.
data CabalSpecVersion
-- | this is older than CabalSpecV1_2
CabalSpecV1_0 :: CabalSpecVersion
-- | new syntax (sections)
CabalSpecV1_2 :: CabalSpecVersion
CabalSpecV1_4 :: CabalSpecVersion
CabalSpecV1_6 :: CabalSpecVersion
CabalSpecV1_8 :: CabalSpecVersion
CabalSpecV1_10 :: CabalSpecVersion
CabalSpecV1_12 :: CabalSpecVersion
CabalSpecV1_18 :: CabalSpecVersion
CabalSpecV1_20 :: CabalSpecVersion
CabalSpecV1_22 :: CabalSpecVersion
CabalSpecV1_24 :: CabalSpecVersion
CabalSpecV2_0 :: CabalSpecVersion
CabalSpecV2_2 :: CabalSpecVersion
CabalSpecV2_4 :: CabalSpecVersion
CabalSpecV3_0 :: CabalSpecVersion
CabalSpecV3_4 :: CabalSpecVersion
CabalSpecV3_6 :: CabalSpecVersion
-- | Show cabal spec version, but not the way in the .cabal files
showCabalSpecVersion :: CabalSpecVersion -> String
cabalSpecLatest :: CabalSpecVersion
-- | Parse CabalSpecVersion from version digits.
--
-- It may fail if for recent versions the version is not exact.
cabalSpecFromVersionDigits :: [Int] -> Maybe CabalSpecVersion
cabalSpecToVersionDigits :: CabalSpecVersion -> [Int]
-- | What is the minimum Cabal library version which knows how handle this
-- spec version.
--
-- Note: this is a point where we could decouple cabal-spec and
-- Cabal versions, if we ever want that.
--
--
-- >>> cabalSpecMinimumLibraryVersion CabalSpecV3_0
-- [2,5]
--
--
--
-- >>> cabalSpecMinimumLibraryVersion CabalSpecV2_4
-- [2,3]
--
cabalSpecMinimumLibraryVersion :: CabalSpecVersion -> [Int]
specHasCommonStanzas :: CabalSpecVersion -> HasCommonStanzas
specHasElif :: CabalSpecVersion -> HasElif
data HasElif
HasElif :: HasElif
NoElif :: HasElif
data HasCommonStanzas
HasCommonStanzas :: HasCommonStanzas
NoCommonStanzas :: HasCommonStanzas
data HasGlobstar
HasGlobstar :: HasGlobstar
NoGlobstar :: HasGlobstar
instance GHC.Generics.Generic Distribution.CabalSpecVersion.CabalSpecVersion
instance Data.Data.Data Distribution.CabalSpecVersion.CabalSpecVersion
instance GHC.Enum.Bounded Distribution.CabalSpecVersion.CabalSpecVersion
instance GHC.Enum.Enum Distribution.CabalSpecVersion.CabalSpecVersion
instance GHC.Read.Read Distribution.CabalSpecVersion.CabalSpecVersion
instance GHC.Show.Show Distribution.CabalSpecVersion.CabalSpecVersion
instance GHC.Classes.Ord Distribution.CabalSpecVersion.CabalSpecVersion
instance GHC.Classes.Eq Distribution.CabalSpecVersion.CabalSpecVersion
instance GHC.Show.Show Distribution.CabalSpecVersion.HasElif
instance GHC.Classes.Eq Distribution.CabalSpecVersion.HasElif
instance GHC.Show.Show Distribution.CabalSpecVersion.HasCommonStanzas
instance GHC.Classes.Eq Distribution.CabalSpecVersion.HasCommonStanzas
instance Data.Binary.Class.Binary Distribution.CabalSpecVersion.CabalSpecVersion
instance Distribution.Utils.Structured.Structured Distribution.CabalSpecVersion.CabalSpecVersion
instance Control.DeepSeq.NFData Distribution.CabalSpecVersion.CabalSpecVersion
module Distribution.SPDX.LicenseListVersion
-- | SPDX License List version Cabal is aware of.
data LicenseListVersion
LicenseListVersion_3_0 :: LicenseListVersion
LicenseListVersion_3_2 :: LicenseListVersion
LicenseListVersion_3_6 :: LicenseListVersion
LicenseListVersion_3_9 :: LicenseListVersion
LicenseListVersion_3_10 :: LicenseListVersion
cabalSpecVersionToSPDXListVersion :: CabalSpecVersion -> LicenseListVersion
instance GHC.Enum.Bounded Distribution.SPDX.LicenseListVersion.LicenseListVersion
instance GHC.Enum.Enum Distribution.SPDX.LicenseListVersion.LicenseListVersion
instance GHC.Show.Show Distribution.SPDX.LicenseListVersion.LicenseListVersion
instance GHC.Classes.Ord Distribution.SPDX.LicenseListVersion.LicenseListVersion
instance GHC.Classes.Eq Distribution.SPDX.LicenseListVersion.LicenseListVersion
module Distribution.Pretty
class Pretty a
pretty :: Pretty a => a -> Doc
prettyVersioned :: Pretty a => CabalSpecVersion -> a -> Doc
prettyShow :: Pretty a => a -> String
-- | The default rendering style used in Cabal for console output. It has a
-- fixed page width and adds line breaks automatically.
defaultStyle :: Style
-- | A style for rendering all on one line.
flatStyle :: Style
showFilePath :: FilePath -> Doc
showToken :: String -> Doc
showTokenStr :: String -> String
-- | Pretty-print free-format text, ensuring that it is vertically aligned,
-- and with blank lines replaced by dots for correct re-parsing.
showFreeText :: String -> Doc
-- | Pretty-print free-format text. Since cabal-version: 3.0 we
-- don't replace blank lines with dots.
showFreeTextV3 :: String -> Doc
type Separator = [Doc] -> Doc
instance Distribution.Pretty.Pretty Text.PrettyPrint.HughesPJ.Doc
instance Distribution.Pretty.Pretty GHC.Types.Bool
instance Distribution.Pretty.Pretty GHC.Types.Int
instance Distribution.Pretty.Pretty a => Distribution.Pretty.Pretty (Data.Functor.Identity.Identity a)
module Distribution.Parsec
-- | Class for parsing with parsec. Mainly used for
-- .cabal file fields.
--
-- For parsing .cabal like file structure, see
-- Distribution.Fields.
class Parsec a
parsec :: (Parsec a, CabalParsing m) => m a
newtype ParsecParser a
PP :: (CabalSpecVersion -> Parsec FieldLineStream [PWarning] a) -> ParsecParser a
[unPP] :: ParsecParser a -> CabalSpecVersion -> Parsec FieldLineStream [PWarning] a
-- | Run ParsecParser with cabalSpecLatest.
runParsecParser :: ParsecParser a -> FilePath -> FieldLineStream -> Either ParseError a
-- | Like runParsecParser but lets specify CabalSpecVersion
-- used.
runParsecParser' :: CabalSpecVersion -> ParsecParser a -> FilePath -> FieldLineStream -> Either ParseError a
-- | Parse a String with lexemeParsec.
simpleParsec :: Parsec a => String -> Maybe a
-- | Like simpleParsec but for ByteString
simpleParsecBS :: Parsec a => ByteString -> Maybe a
-- | Parse a String with lexemeParsec using specific
-- CabalSpecVersion.
simpleParsec' :: Parsec a => CabalSpecVersion -> String -> Maybe a
-- | Parse a String with lexemeParsec using specific
-- CabalSpecVersion. Fail if there are any warnings.
simpleParsecW' :: Parsec a => CabalSpecVersion -> String -> Maybe a
-- | parsec could consume trailing spaces, this function
-- will consume.
lexemeParsec :: (CabalParsing m, Parsec a) => m a
-- | Parse a String with lexemeParsec.
eitherParsec :: Parsec a => String -> Either String a
-- | Parse a String with given ParsecParser. Trailing
-- whitespace is accepted.
explicitEitherParsec :: ParsecParser a -> String -> Either String a
-- | Parse a String with given ParsecParser and
-- CabalSpecVersion. Trailing whitespace is accepted. See
-- explicitEitherParsec.
explicitEitherParsec' :: CabalSpecVersion -> ParsecParser a -> String -> Either String a
-- | Parsing class which
--
--
-- - can report Cabal parser warnings.
-- - knows cabal-version we work with
--
class (CharParsing m, MonadPlus m, MonadFail m) => CabalParsing m
parsecWarning :: CabalParsing m => PWarnType -> String -> m ()
parsecHaskellString :: CabalParsing m => m String
askCabalSpecVersion :: CabalParsing m => m CabalSpecVersion
-- | Type of parser warning. We do classify warnings.
--
-- Different application may decide not to show some, or have fatal
-- behaviour on others
data PWarnType
-- | Unclassified warning
PWTOther :: PWarnType
-- | Invalid UTF encoding
PWTUTF :: PWarnType
-- | true or false, not True or False
PWTBoolCase :: PWarnType
-- | there are version with tags
PWTVersionTag :: PWarnType
-- | New syntax used, but no cabal-version: >= 1.2 specified
PWTNewSyntax :: PWarnType
-- | Old syntax used, and cabal-version >= 1.2 specified
PWTOldSyntax :: PWarnType
PWTDeprecatedField :: PWarnType
PWTInvalidSubsection :: PWarnType
PWTUnknownField :: PWarnType
PWTUnknownSection :: PWarnType
PWTTrailingFields :: PWarnType
-- | extra main-is field
PWTExtraMainIs :: PWarnType
-- | extra test-module field
PWTExtraTestModule :: PWarnType
-- | extra benchmark-module field
PWTExtraBenchmarkModule :: PWarnType
PWTLexNBSP :: PWarnType
PWTLexBOM :: PWarnType
PWTLexTab :: PWarnType
-- | legacy cabal file that we know how to patch
PWTQuirkyCabalFile :: PWarnType
-- | Double dash token, most likely it's a mistake - it's not a comment
PWTDoubleDash :: PWarnType
-- | e.g. name or version should be specified only once.
PWTMultipleSingularField :: PWarnType
-- | Workaround for derive-package having build-type: Default. See
-- https://github.com/haskell/cabal/issues/5020.
PWTBuildTypeDefault :: PWarnType
-- | Version operators used (without cabal-version: 1.8)
PWTVersionOperator :: PWarnType
-- | Version wildcard used (without cabal-version: 1.6)
PWTVersionWildcard :: PWarnType
-- | Warnings about cabal-version format.
PWTSpecVersion :: PWarnType
-- | Empty filepath, i.e. literally ""
PWTEmptyFilePath :: PWarnType
-- | Experimental feature
PWTExperimental :: PWarnType
-- | Parser warning.
data PWarning
PWarning :: !PWarnType -> !Position -> String -> PWarning
showPWarning :: FilePath -> PWarning -> String
-- | Parser error.
data PError
PError :: Position -> String -> PError
showPError :: FilePath -> PError -> String
-- | 1-indexed row and column positions in a file.
data Position
Position :: {-# UNPACK #-} !Int -> {-# UNPACK #-} !Int -> Position
-- | Shift position by n columns to the right.
incPos :: Int -> Position -> Position
-- | Shift position to beginning of next row.
retPos :: Position -> Position
showPos :: Position -> String
zeroPos :: Position
-- |
-- [^ ,]
--
parsecToken :: CabalParsing m => m String
-- |
-- [^ ]
--
parsecToken' :: CabalParsing m => m String
parsecFilePath :: CabalParsing m => m FilePath
-- | Content isn't unquoted
parsecQuoted :: CabalParsing m => m a -> m a
-- | parsecMaybeQuoted p = parsecQuoted p | p.
parsecMaybeQuoted :: CabalParsing m => m a -> m a
parsecCommaList :: CabalParsing m => m a -> m [a]
parsecCommaNonEmpty :: CabalParsing m => m a -> m (NonEmpty a)
-- | Like parsecCommaList but accept leading or trailing comma.
--
--
-- p (comma p)* -- p sepBy comma
-- (comma p)* -- leading comma
-- (p comma)* -- trailing comma
--
parsecLeadingCommaList :: CabalParsing m => m a -> m [a]
parsecLeadingCommaNonEmpty :: CabalParsing m => m a -> m (NonEmpty a)
parsecOptCommaList :: CabalParsing m => m a -> m [a]
-- | Like parsecOptCommaList but
--
--
-- - require all or none commas
-- - accept leading or trailing comma.
--
--
--
-- p (comma p)* -- p sepBy comma
-- (comma p)* -- leading comma
-- (p comma)* -- trailing comma
-- p* -- no commas: many p
--
parsecLeadingOptCommaList :: CabalParsing m => m a -> m [a]
-- | Parse a benchmark/test-suite types.
parsecStandard :: (CabalParsing m, Parsec ver) => (ver -> String -> a) -> m a
parsecUnqualComponentName :: forall m. CabalParsing m => m String
instance GHC.Base.Functor Distribution.Parsec.ParsecParser
instance GHC.Base.Applicative Distribution.Parsec.ParsecParser
instance GHC.Base.Alternative Distribution.Parsec.ParsecParser
instance GHC.Base.Monad Distribution.Parsec.ParsecParser
instance GHC.Base.MonadPlus Distribution.Parsec.ParsecParser
instance Control.Monad.Fail.MonadFail Distribution.Parsec.ParsecParser
instance Distribution.Compat.Parsing.Parsing Distribution.Parsec.ParsecParser
instance Distribution.Compat.CharParsing.CharParsing Distribution.Parsec.ParsecParser
instance Distribution.Parsec.CabalParsing Distribution.Parsec.ParsecParser
instance Distribution.Parsec.Parsec a => Distribution.Parsec.Parsec (Data.Functor.Identity.Identity a)
instance Distribution.Parsec.Parsec GHC.Types.Bool
module Distribution.Utils.Path
-- | Symbolic paths.
--
-- These paths are system independent and relative. They are *symbolic*
-- which means we cannot perform any IO until we interpret them.
data SymbolicPath from to
-- | Extract underlying FilePath.
--
-- Avoid using this in new code.
getSymbolicPath :: SymbolicPath from to -> FilePath
sameDirectory :: (IsDir from, IsDir to) => SymbolicPath from to
-- | Make SymbolicPath without performing any checks.
unsafeMakeSymbolicPath :: FilePath -> SymbolicPath from to
data PackageDir
data SourceDir
data LicenseFile
-- | Class telling that index is for directories.
class IsDir dir
instance (Data.Data.Data from, Data.Data.Data to) => Data.Data.Data (Distribution.Utils.Path.SymbolicPath from to)
instance GHC.Classes.Ord (Distribution.Utils.Path.SymbolicPath from to)
instance GHC.Classes.Eq (Distribution.Utils.Path.SymbolicPath from to)
instance GHC.Read.Read (Distribution.Utils.Path.SymbolicPath from to)
instance GHC.Show.Show (Distribution.Utils.Path.SymbolicPath from to)
instance GHC.Generics.Generic (Distribution.Utils.Path.SymbolicPath from to)
instance Data.Data.Data Distribution.Utils.Path.PackageDir
instance Data.Data.Data Distribution.Utils.Path.SourceDir
instance Data.Data.Data Distribution.Utils.Path.LicenseFile
instance Distribution.Utils.Path.IsDir Distribution.Utils.Path.SourceDir
instance Distribution.Utils.Path.IsDir Distribution.Utils.Path.PackageDir
instance Data.Binary.Class.Binary (Distribution.Utils.Path.SymbolicPath from to)
instance (Data.Typeable.Internal.Typeable from, Data.Typeable.Internal.Typeable to) => Distribution.Utils.Structured.Structured (Distribution.Utils.Path.SymbolicPath from to)
instance Control.DeepSeq.NFData (Distribution.Utils.Path.SymbolicPath from to)
instance Distribution.Parsec.Parsec (Distribution.Utils.Path.SymbolicPath from to)
instance Distribution.Pretty.Pretty (Distribution.Utils.Path.SymbolicPath from to)
module Distribution.Types.Version
-- | A Version represents the version of a software entity.
--
-- Instances of Eq and Ord are provided, which gives exact
-- equality and lexicographic ordering of the version number components
-- (i.e. 2.1 > 2.0, 1.2.3 > 1.2.2, etc.).
--
-- This type is opaque and distinct from the Version type in
-- Data.Version since Cabal-2.0. The difference extends
-- to the Binary instance using a different (and more compact)
-- encoding.
data Version
-- | Construct Version from list of version number components.
--
-- For instance, mkVersion [3,2,1] constructs a Version
-- representing the version 3.2.1.
--
-- All version components must be non-negative. mkVersion []
-- currently represents the special null version; see also
-- nullVersion.
mkVersion :: [Int] -> Version
-- | Variant of mkVersion which converts a Data.Version
-- Version into Cabal's Version type.
mkVersion' :: Version -> Version
-- | Unpack Version into list of version number components.
--
-- This is the inverse to mkVersion, so the following holds:
--
--
-- (versionNumbers . mkVersion) vs == vs
--
versionNumbers :: Version -> [Int]
-- | Constant representing the special null Version
--
-- The nullVersion compares (via Ord) as less than every
-- proper Version value.
nullVersion :: Version
-- | Apply function to list of version number components
--
--
-- alterVersion f == mkVersion . f . versionNumbers
--
alterVersion :: ([Int] -> [Int]) -> Version -> Version
-- | Version 0. A lower bound of Version.
version0 :: Version
validVersion :: Version -> Bool
-- | An integral without leading zeroes.
versionDigitParser :: CabalParsing m => m Int
instance GHC.Generics.Generic Distribution.Types.Version.Version
instance GHC.Classes.Eq Distribution.Types.Version.Version
instance Data.Data.Data Distribution.Types.Version.Version
instance GHC.Classes.Ord Distribution.Types.Version.Version
instance GHC.Show.Show Distribution.Types.Version.Version
instance GHC.Read.Read Distribution.Types.Version.Version
instance Data.Binary.Class.Binary Distribution.Types.Version.Version
instance Distribution.Utils.Structured.Structured Distribution.Types.Version.Version
instance Control.DeepSeq.NFData Distribution.Types.Version.Version
instance Distribution.Pretty.Pretty Distribution.Types.Version.Version
instance Distribution.Parsec.Parsec Distribution.Types.Version.Version
-- | The only purpose of this module is to prevent the export of
-- VersionRange constructors from VersionRange. To avoid
-- creating orphan instances, a lot of related code had to be moved here
-- too.
module Distribution.Types.VersionRange.Internal
data VersionRange
ThisVersion :: Version -> VersionRange
LaterVersion :: Version -> VersionRange
OrLaterVersion :: Version -> VersionRange
EarlierVersion :: Version -> VersionRange
OrEarlierVersion :: Version -> VersionRange
MajorBoundVersion :: Version -> VersionRange
UnionVersionRanges :: VersionRange -> VersionRange -> VersionRange
IntersectVersionRanges :: VersionRange -> VersionRange -> VersionRange
-- | The version range -any. That is, a version range containing
-- all versions.
--
--
-- withinRange v anyVersion = True
--
anyVersion :: VersionRange
-- | The empty version range, that is a version range containing no
-- versions.
--
-- This can be constructed using any unsatisfiable version range
-- expression, for example < 0.
--
--
-- withinRange v noVersion = False
--
noVersion :: VersionRange
-- | The version range == v
--
--
-- withinRange v' (thisVersion v) = v' == v
--
thisVersion :: Version -> VersionRange
-- | The version range || v
--
--
-- withinRange v' (notThisVersion v) = v' /= v
--
notThisVersion :: Version -> VersionRange
-- | The version range > v
--
--
-- withinRange v' (laterVersion v) = v' > v
--
laterVersion :: Version -> VersionRange
-- | The version range < v
--
--
-- withinRange v' (earlierVersion v) = v' < v
--
earlierVersion :: Version -> VersionRange
-- | The version range >= v
--
--
-- withinRange v' (orLaterVersion v) = v' >= v
--
orLaterVersion :: Version -> VersionRange
-- | The version range <= v
--
--
-- withinRange v' (orEarlierVersion v) = v' <= v
--
orEarlierVersion :: Version -> VersionRange
-- | The version range vr1 || vr2
--
--
-- withinRange v' (unionVersionRanges vr1 vr2)
-- = withinRange v' vr1 || withinRange v' vr2
--
unionVersionRanges :: VersionRange -> VersionRange -> VersionRange
-- | The version range vr1 && vr2
--
--
-- withinRange v' (intersectVersionRanges vr1 vr2)
-- = withinRange v' vr1 && withinRange v' vr2
--
intersectVersionRanges :: VersionRange -> VersionRange -> VersionRange
-- | The version range == v.*.
--
-- For example, for version 1.2, the version range ==
-- 1.2.* is the same as >= 1.2 && < 1.3
--
--
-- withinRange v' (laterVersion v) = v' >= v && v' < upper v
-- where
-- upper (Version lower t) = Version (init lower ++ [last lower + 1]) t
--
withinVersion :: Version -> VersionRange
-- | The version range ^>= v.
--
-- For example, for version 1.2.3.4, the version range
-- ^>= 1.2.3.4 is the same as >= 1.2.3.4 &&
-- < 1.3.
--
-- Note that ^>= 1 is equivalent to >= 1 &&
-- < 1.1.
majorBoundVersion :: Version -> VersionRange
-- | F-Algebra of VersionRange. See cataVersionRange.
data VersionRangeF a
ThisVersionF :: Version -> VersionRangeF a
LaterVersionF :: Version -> VersionRangeF a
OrLaterVersionF :: Version -> VersionRangeF a
EarlierVersionF :: Version -> VersionRangeF a
OrEarlierVersionF :: Version -> VersionRangeF a
MajorBoundVersionF :: Version -> VersionRangeF a
UnionVersionRangesF :: a -> a -> VersionRangeF a
IntersectVersionRangesF :: a -> a -> VersionRangeF a
projectVersionRange :: VersionRange -> VersionRangeF VersionRange
embedVersionRange :: VersionRangeF VersionRange -> VersionRange
-- | Fold VersionRange.
cataVersionRange :: (VersionRangeF a -> a) -> VersionRange -> a
-- | Unfold VersionRange.
anaVersionRange :: (a -> VersionRangeF a) -> a -> VersionRange
-- | Refold VersionRange
hyloVersionRange :: (VersionRangeF VersionRange -> VersionRange) -> (VersionRange -> VersionRangeF VersionRange) -> VersionRange -> VersionRange
-- | VersionRange parser parametrised by version digit parser
--
--
versionRangeParser :: forall m. CabalParsing m => m Int -> CabalSpecVersion -> m VersionRange
-- | Compute next greater major version to be used as upper bound
--
-- Example: 0.4.1 produces the version 0.5 which then
-- can be used to construct a range >= 0.4.1 && <
-- 0.5
majorUpperBound :: Version -> Version
wildcardUpperBound :: Version -> Version
instance GHC.Show.Show Distribution.Types.VersionRange.Internal.VersionRange
instance GHC.Read.Read Distribution.Types.VersionRange.Internal.VersionRange
instance GHC.Generics.Generic Distribution.Types.VersionRange.Internal.VersionRange
instance GHC.Classes.Eq Distribution.Types.VersionRange.Internal.VersionRange
instance Data.Data.Data Distribution.Types.VersionRange.Internal.VersionRange
instance Data.Traversable.Traversable Distribution.Types.VersionRange.Internal.VersionRangeF
instance Data.Foldable.Foldable Distribution.Types.VersionRange.Internal.VersionRangeF
instance GHC.Base.Functor Distribution.Types.VersionRange.Internal.VersionRangeF
instance GHC.Show.Show a => GHC.Show.Show (Distribution.Types.VersionRange.Internal.VersionRangeF a)
instance GHC.Read.Read a => GHC.Read.Read (Distribution.Types.VersionRange.Internal.VersionRangeF a)
instance GHC.Generics.Generic (Distribution.Types.VersionRange.Internal.VersionRangeF a)
instance GHC.Classes.Eq a => GHC.Classes.Eq (Distribution.Types.VersionRange.Internal.VersionRangeF a)
instance Data.Data.Data a => Data.Data.Data (Distribution.Types.VersionRange.Internal.VersionRangeF a)
instance Data.Binary.Class.Binary Distribution.Types.VersionRange.Internal.VersionRange
instance Distribution.Utils.Structured.Structured Distribution.Types.VersionRange.Internal.VersionRange
instance Control.DeepSeq.NFData Distribution.Types.VersionRange.Internal.VersionRange
instance Distribution.Pretty.Pretty Distribution.Types.VersionRange.Internal.VersionRange
instance Distribution.Parsec.Parsec Distribution.Types.VersionRange.Internal.VersionRange
-- | This is old version of Distribution.Types.VersionInterval
-- module.
--
-- It will be removed in Cabal-3.8.
-- | Deprecated: Use Distribution.Types.VersionInterval instead
module Distribution.Types.VersionInterval.Legacy
-- | A complementary representation of a VersionRange. Instead of a
-- boolean version predicate it uses an increasing sequence of
-- non-overlapping, non-empty intervals.
--
-- The key point is that this representation gives a canonical
-- representation for the semantics of VersionRanges. This makes
-- it easier to check things like whether a version range is empty,
-- covers all versions, or requires a certain minimum or maximum version.
-- It also makes it easy to check equality or containment. It also makes
-- it easier to identify 'simple' version predicates for translation into
-- foreign packaging systems that do not support complex version range
-- expressions.
data VersionIntervals
-- | Convert a VersionRange to a sequence of version intervals.
toVersionIntervals :: VersionRange -> VersionIntervals
-- | Convert a VersionIntervals value back into a
-- VersionRange expression representing the version intervals.
fromVersionIntervals :: VersionIntervals -> VersionRange
-- | Test if a version falls within the version intervals.
--
-- It exists mostly for completeness and testing. It satisfies the
-- following properties:
--
--
-- withinIntervals v (toVersionIntervals vr) = withinRange v vr
-- withinIntervals v ivs = withinRange v (fromVersionIntervals ivs)
--
withinIntervals :: Version -> VersionIntervals -> Bool
-- | Inspect the list of version intervals.
versionIntervals :: VersionIntervals -> [VersionInterval]
-- | Directly construct a VersionIntervals from a list of intervals.
--
-- In Cabal-2.2 the Maybe is dropped from the result
-- type.
mkVersionIntervals :: [VersionInterval] -> VersionIntervals
unionVersionIntervals :: VersionIntervals -> VersionIntervals -> VersionIntervals
intersectVersionIntervals :: VersionIntervals -> VersionIntervals -> VersionIntervals
invertVersionIntervals :: VersionIntervals -> VersionIntervals
relaxLastInterval :: VersionIntervals -> VersionIntervals
relaxHeadInterval :: VersionIntervals -> VersionIntervals
-- | View a VersionRange as a union of intervals.
--
-- This provides a canonical view of the semantics of a
-- VersionRange as opposed to the syntax of the expression used to
-- define it. For the syntactic view use foldVersionRange.
--
-- Each interval is non-empty. The sequence is in increasing order and no
-- intervals overlap or touch. Therefore only the first and last can be
-- unbounded. The sequence can be empty if the range is empty (e.g. a
-- range expression like && 2).
--
-- Other checks are trivial to implement using this view. For example:
--
--
-- isNoVersion vr | [] <- asVersionIntervals vr = True
-- | otherwise = False
--
--
--
-- isSpecificVersion vr
-- | [(LowerBound v InclusiveBound
-- ,UpperBound v' InclusiveBound)] <- asVersionIntervals vr
-- , v == v' = Just v
-- | otherwise = Nothing
--
asVersionIntervals :: VersionRange -> [VersionInterval]
type VersionInterval = (LowerBound, UpperBound)
data LowerBound
LowerBound :: Version -> !Bound -> LowerBound
data UpperBound
NoUpperBound :: UpperBound
UpperBound :: Version -> !Bound -> UpperBound
data Bound
ExclusiveBound :: Bound
InclusiveBound :: Bound
instance GHC.Show.Show Distribution.Types.VersionInterval.Legacy.Bound
instance GHC.Classes.Eq Distribution.Types.VersionInterval.Legacy.Bound
instance GHC.Show.Show Distribution.Types.VersionInterval.Legacy.UpperBound
instance GHC.Classes.Eq Distribution.Types.VersionInterval.Legacy.UpperBound
instance GHC.Show.Show Distribution.Types.VersionInterval.Legacy.LowerBound
instance GHC.Classes.Eq Distribution.Types.VersionInterval.Legacy.LowerBound
instance GHC.Show.Show Distribution.Types.VersionInterval.Legacy.VersionIntervals
instance GHC.Classes.Eq Distribution.Types.VersionInterval.Legacy.VersionIntervals
instance GHC.Classes.Ord Distribution.Types.VersionInterval.Legacy.LowerBound
instance GHC.Classes.Ord Distribution.Types.VersionInterval.Legacy.UpperBound
-- | In Cabal-3.6 this module have been rewritten.
module Distribution.Types.VersionInterval
-- | A complementary representation of a VersionRange. Instead of a
-- boolean version predicate it uses an increasing sequence of
-- non-overlapping, non-empty intervals.
--
-- The key point is that this representation gives a canonical
-- representation for the semantics of VersionRanges. This makes
-- it easier to check things like whether a version range is empty,
-- covers all versions, or requires a certain minimum or maximum version.
-- It also makes it easy to check equality or containment. It also makes
-- it easier to identify 'simple' version predicates for translation into
-- foreign packaging systems that do not support complex version range
-- expressions.
data VersionIntervals
-- | Inspect the list of version intervals.
unVersionIntervals :: VersionIntervals -> [VersionInterval]
-- | Convert a VersionRange to a sequence of version intervals.
toVersionIntervals :: VersionRange -> VersionIntervals
-- | Convert a VersionIntervals value back into a
-- VersionRange expression representing the version intervals.
fromVersionIntervals :: VersionIntervals -> VersionRange
-- | Since Cabal-3.6 this function.. TODO
normaliseVersionRange2 :: VersionRange -> VersionRange
relaxLastInterval :: VersionIntervals -> VersionIntervals
relaxHeadInterval :: VersionIntervals -> VersionIntervals
-- | View a VersionRange as a union of intervals.
--
-- This provides a canonical view of the semantics of a
-- VersionRange as opposed to the syntax of the expression used to
-- define it. For the syntactic view use foldVersionRange.
--
-- Each interval is non-empty. The sequence is in increasing order and no
-- intervals overlap or touch. Therefore only the first and last can be
-- unbounded. The sequence can be empty if the range is empty (e.g. a
-- range expression like && 2).
--
-- Other checks are trivial to implement using this view. For example:
--
--
-- isNoVersion vr | [] <- asVersionIntervals vr = True
-- | otherwise = False
--
--
--
-- isSpecificVersion vr
-- | [(LowerBound v InclusiveBound
-- ,UpperBound v' InclusiveBound)] <- asVersionIntervals vr
-- , v == v' = Just v
-- | otherwise = Nothing
--
asVersionIntervals :: VersionRange -> [VersionInterval]
data VersionInterval
VersionInterval :: !LowerBound -> !UpperBound -> VersionInterval
data LowerBound
LowerBound :: !Version -> !Bound -> LowerBound
data UpperBound
NoUpperBound :: UpperBound
UpperBound :: !Version -> !Bound -> UpperBound
data Bound
ExclusiveBound :: Bound
InclusiveBound :: Bound
-- | VersionIntervals invariant:
--
--
-- - all intervals are valid (lower bound is less then upper bound,
-- i.e. non-empty)
-- - intervals doesn't touch each other (distinct)
--
invariantVersionIntervals :: VersionIntervals -> Bool
instance GHC.Show.Show Distribution.Types.VersionInterval.Bound
instance GHC.Classes.Eq Distribution.Types.VersionInterval.Bound
instance GHC.Show.Show Distribution.Types.VersionInterval.UpperBound
instance GHC.Classes.Eq Distribution.Types.VersionInterval.UpperBound
instance GHC.Show.Show Distribution.Types.VersionInterval.LowerBound
instance GHC.Classes.Eq Distribution.Types.VersionInterval.LowerBound
instance GHC.Show.Show Distribution.Types.VersionInterval.VersionInterval
instance GHC.Classes.Eq Distribution.Types.VersionInterval.VersionInterval
instance GHC.Show.Show Distribution.Types.VersionInterval.VersionIntervals
instance GHC.Classes.Eq Distribution.Types.VersionInterval.VersionIntervals
module Distribution.Types.VersionRange
data VersionRange
-- | The version range -any. That is, a version range containing
-- all versions.
--
--
-- withinRange v anyVersion = True
--
anyVersion :: VersionRange
-- | The empty version range, that is a version range containing no
-- versions.
--
-- This can be constructed using any unsatisfiable version range
-- expression, for example < 0.
--
--
-- withinRange v noVersion = False
--
noVersion :: VersionRange
-- | The version range == v
--
--
-- withinRange v' (thisVersion v) = v' == v
--
thisVersion :: Version -> VersionRange
-- | The version range || v
--
--
-- withinRange v' (notThisVersion v) = v' /= v
--
notThisVersion :: Version -> VersionRange
-- | The version range > v
--
--
-- withinRange v' (laterVersion v) = v' > v
--
laterVersion :: Version -> VersionRange
-- | The version range < v
--
--
-- withinRange v' (earlierVersion v) = v' < v
--
earlierVersion :: Version -> VersionRange
-- | The version range >= v
--
--
-- withinRange v' (orLaterVersion v) = v' >= v
--
orLaterVersion :: Version -> VersionRange
-- | The version range <= v
--
--
-- withinRange v' (orEarlierVersion v) = v' <= v
--
orEarlierVersion :: Version -> VersionRange
-- | The version range vr1 || vr2
--
--
-- withinRange v' (unionVersionRanges vr1 vr2)
-- = withinRange v' vr1 || withinRange v' vr2
--
unionVersionRanges :: VersionRange -> VersionRange -> VersionRange
-- | The version range vr1 && vr2
--
--
-- withinRange v' (intersectVersionRanges vr1 vr2)
-- = withinRange v' vr1 && withinRange v' vr2
--
intersectVersionRanges :: VersionRange -> VersionRange -> VersionRange
-- | The version range == v.*.
--
-- For example, for version 1.2, the version range ==
-- 1.2.* is the same as >= 1.2 && < 1.3
--
--
-- withinRange v' (laterVersion v) = v' >= v && v' < upper v
-- where
-- upper (Version lower t) = Version (init lower ++ [last lower + 1]) t
--
withinVersion :: Version -> VersionRange
-- | The version range ^>= v.
--
-- For example, for version 1.2.3.4, the version range
-- ^>= 1.2.3.4 is the same as >= 1.2.3.4 &&
-- < 1.3.
--
-- Note that ^>= 1 is equivalent to >= 1 &&
-- < 1.1.
majorBoundVersion :: Version -> VersionRange
-- | Does this version fall within the given range?
--
-- This is the evaluation function for the VersionRange type.
withinRange :: Version -> VersionRange -> Bool
-- | Fold over the basic syntactic structure of a VersionRange.
--
-- This provides a syntactic view of the expression defining the version
-- range. The syntactic sugar ">= v", "<= v" and
-- "== v.*" is presented in terms of the other basic syntax.
--
-- For a semantic view use asVersionIntervals.
foldVersionRange :: a -> (Version -> a) -> (Version -> a) -> (Version -> a) -> (a -> a -> a) -> (a -> a -> a) -> VersionRange -> a
-- | Normalise VersionRange.
--
-- In particular collapse (== v || > v) into >=
-- v, and so on.
normaliseVersionRange :: VersionRange -> VersionRange
-- | Remove VersionRangeParens constructors.
--
-- Since version 3.4 this function is id, there aren't
-- VersionRangeParens constructor in VersionRange
-- anymore.
stripParensVersionRange :: VersionRange -> VersionRange
-- | Does the version range have an upper bound?
hasUpperBound :: VersionRange -> Bool
-- | Does the version range have an explicit lower bound?
--
-- Note: this function only considers the user-specified lower bounds,
-- but not the implicit >=0 lower bound.
hasLowerBound :: VersionRange -> Bool
-- | F-Algebra of VersionRange. See cataVersionRange.
data VersionRangeF a
ThisVersionF :: Version -> VersionRangeF a
LaterVersionF :: Version -> VersionRangeF a
OrLaterVersionF :: Version -> VersionRangeF a
EarlierVersionF :: Version -> VersionRangeF a
OrEarlierVersionF :: Version -> VersionRangeF a
MajorBoundVersionF :: Version -> VersionRangeF a
UnionVersionRangesF :: a -> a -> VersionRangeF a
IntersectVersionRangesF :: a -> a -> VersionRangeF a
-- | Fold VersionRange.
cataVersionRange :: (VersionRangeF a -> a) -> VersionRange -> a
-- | Unfold VersionRange.
anaVersionRange :: (a -> VersionRangeF a) -> a -> VersionRange
-- | Refold VersionRange
hyloVersionRange :: (VersionRangeF VersionRange -> VersionRange) -> (VersionRange -> VersionRangeF VersionRange) -> VersionRange -> VersionRange
projectVersionRange :: VersionRange -> VersionRangeF VersionRange
embedVersionRange :: VersionRangeF VersionRange -> VersionRange
-- | Does this VersionRange place any restriction on the
-- Version or is it in fact equivalent to AnyVersion.
--
-- Note this is a semantic check, not simply a syntactic check. So for
-- example the following is True (for all v).
--
--
-- isAnyVersion (EarlierVersion v `UnionVersionRanges` orLaterVersion v)
--
isAnyVersion :: VersionRange -> Bool
isAnyVersionLight :: VersionRange -> Bool
wildcardUpperBound :: Version -> Version
-- | Compute next greater major version to be used as upper bound
--
-- Example: 0.4.1 produces the version 0.5 which then
-- can be used to construct a range >= 0.4.1 && <
-- 0.5
majorUpperBound :: Version -> Version
isWildcardRange :: Version -> Version -> Bool
-- | VersionRange parser parametrised by version digit parser
--
--
versionRangeParser :: forall m. CabalParsing m => m Int -> CabalSpecVersion -> m VersionRange
module Distribution.Types.SourceRepo
-- | Information about the source revision control system for a package.
--
-- When specifying a repo it is useful to know the meaning or intention
-- of the information as doing so enables automation. There are two
-- obvious common purposes: one is to find the repo for the latest
-- development version, the other is to find the repo for this specific
-- release. The ReopKind specifies which one we mean (or another
-- custom one).
--
-- A package can specify one or the other kind or both. Most will specify
-- just a head repo but some may want to specify a repo to reconstruct
-- the sources for this package release.
--
-- The required information is the RepoType which tells us if it's
-- using Darcs, Git for example. The repoLocation
-- and other details are interpreted according to the repo type.
data SourceRepo
SourceRepo :: RepoKind -> Maybe RepoType -> Maybe String -> Maybe String -> Maybe String -> Maybe String -> Maybe FilePath -> SourceRepo
-- | The kind of repo. This field is required.
[repoKind] :: SourceRepo -> RepoKind
-- | The type of the source repository system for this repo, eg
-- Darcs or Git. This field is required.
[repoType] :: SourceRepo -> Maybe RepoType
-- | The location of the repository. For most RepoTypes this is a
-- URL. This field is required.
[repoLocation] :: SourceRepo -> Maybe String
-- | CVS can put multiple "modules" on one server and requires a
-- module name in addition to the location to identify a particular repo.
-- Logically this is part of the location but unfortunately has to be
-- specified separately. This field is required for the CVS
-- RepoType and should not be given otherwise.
[repoModule] :: SourceRepo -> Maybe String
-- | The name or identifier of the branch, if any. Many source control
-- systems have the notion of multiple branches in a repo that exist in
-- the same location. For example Git and CVS use this
-- while systems like Darcs use different locations for different
-- branches. This field is optional but should be used if necessary to
-- identify the sources, especially for the RepoThis repo kind.
[repoBranch] :: SourceRepo -> Maybe String
-- | The tag identify a particular state of the repository. This should be
-- given for the RepoThis repo kind and not for RepoHead
-- kind.
[repoTag] :: SourceRepo -> Maybe String
-- | Some repositories contain multiple projects in different
-- subdirectories This field specifies the subdirectory where this
-- packages sources can be found, eg the subdirectory containing the
-- .cabal file. It is interpreted relative to the root of the
-- repository. This field is optional. If not given the default is "." ie
-- no subdirectory.
[repoSubdir] :: SourceRepo -> Maybe FilePath
-- | What this repo info is for, what it represents.
data RepoKind
-- | The repository for the "head" or development version of the project.
-- This repo is where we should track the latest development activity or
-- the usual repo people should get to contribute patches.
RepoHead :: RepoKind
-- | The repository containing the sources for this exact package version
-- or release. For this kind of repo a tag should be given to give enough
-- information to re-create the exact sources.
RepoThis :: RepoKind
RepoKindUnknown :: String -> RepoKind
data RepoType
KnownRepoType :: KnownRepoType -> RepoType
OtherRepoType :: String -> RepoType
-- | An enumeration of common source control systems. The fields used in
-- the SourceRepo depend on the type of repo. The tools and
-- methods used to obtain and track the repo depend on the repo type.
data KnownRepoType
Darcs :: KnownRepoType
Git :: KnownRepoType
SVN :: KnownRepoType
CVS :: KnownRepoType
Mercurial :: KnownRepoType
GnuArch :: KnownRepoType
Bazaar :: KnownRepoType
Monotone :: KnownRepoType
Pijul :: KnownRepoType
knownRepoTypes :: [KnownRepoType]
emptySourceRepo :: RepoKind -> SourceRepo
classifyRepoType :: String -> RepoType
classifyRepoKind :: String -> RepoKind
instance Data.Data.Data Distribution.Types.SourceRepo.RepoKind
instance GHC.Show.Show Distribution.Types.SourceRepo.RepoKind
instance GHC.Read.Read Distribution.Types.SourceRepo.RepoKind
instance GHC.Classes.Ord Distribution.Types.SourceRepo.RepoKind
instance GHC.Generics.Generic Distribution.Types.SourceRepo.RepoKind
instance GHC.Classes.Eq Distribution.Types.SourceRepo.RepoKind
instance GHC.Enum.Bounded Distribution.Types.SourceRepo.KnownRepoType
instance GHC.Enum.Enum Distribution.Types.SourceRepo.KnownRepoType
instance Data.Data.Data Distribution.Types.SourceRepo.KnownRepoType
instance GHC.Show.Show Distribution.Types.SourceRepo.KnownRepoType
instance GHC.Read.Read Distribution.Types.SourceRepo.KnownRepoType
instance GHC.Classes.Ord Distribution.Types.SourceRepo.KnownRepoType
instance GHC.Generics.Generic Distribution.Types.SourceRepo.KnownRepoType
instance GHC.Classes.Eq Distribution.Types.SourceRepo.KnownRepoType
instance Data.Data.Data Distribution.Types.SourceRepo.RepoType
instance GHC.Show.Show Distribution.Types.SourceRepo.RepoType
instance GHC.Read.Read Distribution.Types.SourceRepo.RepoType
instance GHC.Classes.Ord Distribution.Types.SourceRepo.RepoType
instance GHC.Generics.Generic Distribution.Types.SourceRepo.RepoType
instance GHC.Classes.Eq Distribution.Types.SourceRepo.RepoType
instance Data.Data.Data Distribution.Types.SourceRepo.SourceRepo
instance GHC.Show.Show Distribution.Types.SourceRepo.SourceRepo
instance GHC.Read.Read Distribution.Types.SourceRepo.SourceRepo
instance GHC.Generics.Generic Distribution.Types.SourceRepo.SourceRepo
instance GHC.Classes.Ord Distribution.Types.SourceRepo.SourceRepo
instance GHC.Classes.Eq Distribution.Types.SourceRepo.SourceRepo
instance Data.Binary.Class.Binary Distribution.Types.SourceRepo.SourceRepo
instance Distribution.Utils.Structured.Structured Distribution.Types.SourceRepo.SourceRepo
instance Control.DeepSeq.NFData Distribution.Types.SourceRepo.SourceRepo
instance Data.Binary.Class.Binary Distribution.Types.SourceRepo.RepoType
instance Distribution.Utils.Structured.Structured Distribution.Types.SourceRepo.RepoType
instance Control.DeepSeq.NFData Distribution.Types.SourceRepo.RepoType
instance Distribution.Parsec.Parsec Distribution.Types.SourceRepo.RepoType
instance Distribution.Pretty.Pretty Distribution.Types.SourceRepo.RepoType
instance Data.Binary.Class.Binary Distribution.Types.SourceRepo.KnownRepoType
instance Distribution.Utils.Structured.Structured Distribution.Types.SourceRepo.KnownRepoType
instance Control.DeepSeq.NFData Distribution.Types.SourceRepo.KnownRepoType
instance Distribution.Parsec.Parsec Distribution.Types.SourceRepo.KnownRepoType
instance Distribution.Pretty.Pretty Distribution.Types.SourceRepo.KnownRepoType
instance Data.Binary.Class.Binary Distribution.Types.SourceRepo.RepoKind
instance Distribution.Utils.Structured.Structured Distribution.Types.SourceRepo.RepoKind
instance Control.DeepSeq.NFData Distribution.Types.SourceRepo.RepoKind
instance Distribution.Pretty.Pretty Distribution.Types.SourceRepo.RepoKind
instance Distribution.Parsec.Parsec Distribution.Types.SourceRepo.RepoKind
module Distribution.Types.SourceRepo.Lens
-- | Information about the source revision control system for a package.
--
-- When specifying a repo it is useful to know the meaning or intention
-- of the information as doing so enables automation. There are two
-- obvious common purposes: one is to find the repo for the latest
-- development version, the other is to find the repo for this specific
-- release. The ReopKind specifies which one we mean (or another
-- custom one).
--
-- A package can specify one or the other kind or both. Most will specify
-- just a head repo but some may want to specify a repo to reconstruct
-- the sources for this package release.
--
-- The required information is the RepoType which tells us if it's
-- using Darcs, Git for example. The repoLocation
-- and other details are interpreted according to the repo type.
data SourceRepo
repoKind :: Lens' SourceRepo RepoKind
repoType :: Lens' SourceRepo (Maybe RepoType)
repoLocation :: Lens' SourceRepo (Maybe String)
repoModule :: Lens' SourceRepo (Maybe String)
repoBranch :: Lens' SourceRepo (Maybe String)
repoTag :: Lens' SourceRepo (Maybe String)
repoSubdir :: Lens' SourceRepo (Maybe FilePath)
module Distribution.Types.PkgconfigVersion
-- | pkg-config versions.
--
-- In fact, this can be arbitrary ByteString, but Parsec
-- instance is a little pickier.
newtype PkgconfigVersion
PkgconfigVersion :: ByteString -> PkgconfigVersion
-- | Compare two version strings as pkg-config would compare them.
rpmvercmp :: ByteString -> ByteString -> Ordering
instance Data.Data.Data Distribution.Types.PkgconfigVersion.PkgconfigVersion
instance GHC.Show.Show Distribution.Types.PkgconfigVersion.PkgconfigVersion
instance GHC.Read.Read Distribution.Types.PkgconfigVersion.PkgconfigVersion
instance GHC.Generics.Generic Distribution.Types.PkgconfigVersion.PkgconfigVersion
instance GHC.Classes.Eq Distribution.Types.PkgconfigVersion.PkgconfigVersion
instance GHC.Classes.Ord Distribution.Types.PkgconfigVersion.PkgconfigVersion
instance Data.Binary.Class.Binary Distribution.Types.PkgconfigVersion.PkgconfigVersion
instance Distribution.Utils.Structured.Structured Distribution.Types.PkgconfigVersion.PkgconfigVersion
instance Control.DeepSeq.NFData Distribution.Types.PkgconfigVersion.PkgconfigVersion
instance Distribution.Pretty.Pretty Distribution.Types.PkgconfigVersion.PkgconfigVersion
instance Distribution.Parsec.Parsec Distribution.Types.PkgconfigVersion.PkgconfigVersion
module Distribution.Types.PkgconfigVersionRange
data PkgconfigVersionRange
PcAnyVersion :: PkgconfigVersionRange
PcThisVersion :: PkgconfigVersion -> PkgconfigVersionRange
PcLaterVersion :: PkgconfigVersion -> PkgconfigVersionRange
PcEarlierVersion :: PkgconfigVersion -> PkgconfigVersionRange
PcOrLaterVersion :: PkgconfigVersion -> PkgconfigVersionRange
PcOrEarlierVersion :: PkgconfigVersion -> PkgconfigVersionRange
PcUnionVersionRanges :: PkgconfigVersionRange -> PkgconfigVersionRange -> PkgconfigVersionRange
PcIntersectVersionRanges :: PkgconfigVersionRange -> PkgconfigVersionRange -> PkgconfigVersionRange
anyPkgconfigVersion :: PkgconfigVersionRange
-- | TODO: this is not precise, but used only to prettify output.
isAnyPkgconfigVersion :: PkgconfigVersionRange -> Bool
withinPkgconfigVersionRange :: PkgconfigVersion -> PkgconfigVersionRange -> Bool
versionToPkgconfigVersion :: Version -> PkgconfigVersion
versionRangeToPkgconfigVersionRange :: VersionRange -> PkgconfigVersionRange
instance Data.Data.Data Distribution.Types.PkgconfigVersionRange.PkgconfigVersionRange
instance GHC.Classes.Eq Distribution.Types.PkgconfigVersionRange.PkgconfigVersionRange
instance GHC.Show.Show Distribution.Types.PkgconfigVersionRange.PkgconfigVersionRange
instance GHC.Read.Read Distribution.Types.PkgconfigVersionRange.PkgconfigVersionRange
instance GHC.Generics.Generic Distribution.Types.PkgconfigVersionRange.PkgconfigVersionRange
instance Data.Binary.Class.Binary Distribution.Types.PkgconfigVersionRange.PkgconfigVersionRange
instance Distribution.Utils.Structured.Structured Distribution.Types.PkgconfigVersionRange.PkgconfigVersionRange
instance Control.DeepSeq.NFData Distribution.Types.PkgconfigVersionRange.PkgconfigVersionRange
instance Distribution.Pretty.Pretty Distribution.Types.PkgconfigVersionRange.PkgconfigVersionRange
instance Distribution.Parsec.Parsec Distribution.Types.PkgconfigVersionRange.PkgconfigVersionRange
module Distribution.Types.PkgconfigName
-- | A pkg-config library name
--
-- This is parsed as any valid argument to the pkg-config utility.
data PkgconfigName
-- | Convert PkgconfigName to String
unPkgconfigName :: PkgconfigName -> String
-- | Construct a PkgconfigName from a String
--
-- mkPkgconfigName is the inverse to unPkgconfigName
--
-- Note: No validations are performed to ensure that the resulting
-- PkgconfigName is valid
mkPkgconfigName :: String -> PkgconfigName
instance Data.Data.Data Distribution.Types.PkgconfigName.PkgconfigName
instance GHC.Classes.Ord Distribution.Types.PkgconfigName.PkgconfigName
instance GHC.Classes.Eq Distribution.Types.PkgconfigName.PkgconfigName
instance GHC.Show.Show Distribution.Types.PkgconfigName.PkgconfigName
instance GHC.Read.Read Distribution.Types.PkgconfigName.PkgconfigName
instance GHC.Generics.Generic Distribution.Types.PkgconfigName.PkgconfigName
instance Data.String.IsString Distribution.Types.PkgconfigName.PkgconfigName
instance Data.Binary.Class.Binary Distribution.Types.PkgconfigName.PkgconfigName
instance Distribution.Utils.Structured.Structured Distribution.Types.PkgconfigName.PkgconfigName
instance Distribution.Pretty.Pretty Distribution.Types.PkgconfigName.PkgconfigName
instance Distribution.Parsec.Parsec Distribution.Types.PkgconfigName.PkgconfigName
instance Control.DeepSeq.NFData Distribution.Types.PkgconfigName.PkgconfigName
module Distribution.Types.PkgconfigDependency
-- | Describes a dependency on a pkg-config library
data PkgconfigDependency
PkgconfigDependency :: PkgconfigName -> PkgconfigVersionRange -> PkgconfigDependency
instance Data.Data.Data Distribution.Types.PkgconfigDependency.PkgconfigDependency
instance GHC.Classes.Eq Distribution.Types.PkgconfigDependency.PkgconfigDependency
instance GHC.Show.Show Distribution.Types.PkgconfigDependency.PkgconfigDependency
instance GHC.Read.Read Distribution.Types.PkgconfigDependency.PkgconfigDependency
instance GHC.Generics.Generic Distribution.Types.PkgconfigDependency.PkgconfigDependency
instance Data.Binary.Class.Binary Distribution.Types.PkgconfigDependency.PkgconfigDependency
instance Distribution.Utils.Structured.Structured Distribution.Types.PkgconfigDependency.PkgconfigDependency
instance Control.DeepSeq.NFData Distribution.Types.PkgconfigDependency.PkgconfigDependency
instance Distribution.Pretty.Pretty Distribution.Types.PkgconfigDependency.PkgconfigDependency
instance Distribution.Parsec.Parsec Distribution.Types.PkgconfigDependency.PkgconfigDependency
module Distribution.Types.PackageName
-- | A package name.
--
-- Use mkPackageName and unPackageName to convert from/to a
-- String.
--
-- This type is opaque since Cabal-2.0
data PackageName
-- | Convert PackageName to String
unPackageName :: PackageName -> String
-- | Construct a PackageName from a String
--
-- mkPackageName is the inverse to unPackageName
--
-- Note: No validations are performed to ensure that the resulting
-- PackageName is valid
mkPackageName :: String -> PackageName
unPackageNameST :: PackageName -> ShortText
-- | Construct a PackageName from a ShortText
--
-- Note: No validations are performed to ensure that the resulting
-- PackageName is valid
mkPackageNameST :: ShortText -> PackageName
instance Data.Data.Data Distribution.Types.PackageName.PackageName
instance GHC.Classes.Ord Distribution.Types.PackageName.PackageName
instance GHC.Classes.Eq Distribution.Types.PackageName.PackageName
instance GHC.Show.Show Distribution.Types.PackageName.PackageName
instance GHC.Read.Read Distribution.Types.PackageName.PackageName
instance GHC.Generics.Generic Distribution.Types.PackageName.PackageName
instance Data.String.IsString Distribution.Types.PackageName.PackageName
instance Data.Binary.Class.Binary Distribution.Types.PackageName.PackageName
instance Distribution.Utils.Structured.Structured Distribution.Types.PackageName.PackageName
instance Distribution.Pretty.Pretty Distribution.Types.PackageName.PackageName
instance Distribution.Parsec.Parsec Distribution.Types.PackageName.PackageName
instance Control.DeepSeq.NFData Distribution.Types.PackageName.PackageName
module Distribution.Types.UnqualComponentName
-- | An unqualified component name, for any kind of component.
--
-- This is distinguished from a ComponentName and
-- ComponentId. The former also states which of a library,
-- executable, etc the name refers too. The later uniquely identifiers a
-- component and its closure.
data UnqualComponentName
-- | Convert UnqualComponentName to String
unUnqualComponentName :: UnqualComponentName -> String
unUnqualComponentNameST :: UnqualComponentName -> ShortText
-- | Construct a UnqualComponentName from a String
--
-- mkUnqualComponentName is the inverse to
-- unUnqualComponentName
--
-- Note: No validations are performed to ensure that the resulting
-- UnqualComponentName is valid
mkUnqualComponentName :: String -> UnqualComponentName
-- | Converts a package name to an unqualified component name
--
-- Useful in legacy situations where a package name may refer to an
-- internal component, if one is defined with that name.
--
-- 2018-12-21: These "legacy" situations are not legacy. We can
-- build-depends on the internal library. However Now dependency
-- contains Set LibraryName, and we should use that.
packageNameToUnqualComponentName :: PackageName -> UnqualComponentName
-- | Converts an unqualified component name to a package name
--
-- packageNameToUnqualComponentName is the inverse of
-- unqualComponentNameToPackageName.
--
-- Useful in legacy situations where a package name may refer to an
-- internal component, if one is defined with that name.
unqualComponentNameToPackageName :: UnqualComponentName -> PackageName
instance GHC.Base.Monoid Distribution.Types.UnqualComponentName.UnqualComponentName
instance GHC.Base.Semigroup Distribution.Types.UnqualComponentName.UnqualComponentName
instance Data.Data.Data Distribution.Types.UnqualComponentName.UnqualComponentName
instance GHC.Classes.Ord Distribution.Types.UnqualComponentName.UnqualComponentName
instance GHC.Classes.Eq Distribution.Types.UnqualComponentName.UnqualComponentName
instance GHC.Show.Show Distribution.Types.UnqualComponentName.UnqualComponentName
instance GHC.Read.Read Distribution.Types.UnqualComponentName.UnqualComponentName
instance GHC.Generics.Generic Distribution.Types.UnqualComponentName.UnqualComponentName
instance Data.String.IsString Distribution.Types.UnqualComponentName.UnqualComponentName
instance Data.Binary.Class.Binary Distribution.Types.UnqualComponentName.UnqualComponentName
instance Distribution.Utils.Structured.Structured Distribution.Types.UnqualComponentName.UnqualComponentName
instance Distribution.Pretty.Pretty Distribution.Types.UnqualComponentName.UnqualComponentName
instance Distribution.Parsec.Parsec Distribution.Types.UnqualComponentName.UnqualComponentName
instance Control.DeepSeq.NFData Distribution.Types.UnqualComponentName.UnqualComponentName
module Distribution.Types.LibraryVisibility
-- | Multi-lib visibility
data LibraryVisibility
-- | Can be depenendent from other packages
LibraryVisibilityPublic :: LibraryVisibility
-- | Internal library, default
LibraryVisibilityPrivate :: LibraryVisibility
instance Data.Data.Data Distribution.Types.LibraryVisibility.LibraryVisibility
instance GHC.Classes.Eq Distribution.Types.LibraryVisibility.LibraryVisibility
instance GHC.Read.Read Distribution.Types.LibraryVisibility.LibraryVisibility
instance GHC.Show.Show Distribution.Types.LibraryVisibility.LibraryVisibility
instance GHC.Generics.Generic Distribution.Types.LibraryVisibility.LibraryVisibility
instance Distribution.Pretty.Pretty Distribution.Types.LibraryVisibility.LibraryVisibility
instance Distribution.Parsec.Parsec Distribution.Types.LibraryVisibility.LibraryVisibility
instance Data.Binary.Class.Binary Distribution.Types.LibraryVisibility.LibraryVisibility
instance Distribution.Utils.Structured.Structured Distribution.Types.LibraryVisibility.LibraryVisibility
instance Control.DeepSeq.NFData Distribution.Types.LibraryVisibility.LibraryVisibility
instance GHC.Base.Semigroup Distribution.Types.LibraryVisibility.LibraryVisibility
instance GHC.Base.Monoid Distribution.Types.LibraryVisibility.LibraryVisibility
module Distribution.Types.LibraryName
data LibraryName
LMainLibName :: LibraryName
LSubLibName :: UnqualComponentName -> LibraryName
defaultLibName :: LibraryName
-- | Convert the UnqualComponentName of a library into a
-- LibraryName.
maybeToLibraryName :: Maybe UnqualComponentName -> LibraryName
showLibraryName :: LibraryName -> String
libraryNameStanza :: LibraryName -> String
libraryNameString :: LibraryName -> Maybe UnqualComponentName
-- | Pretty print LibraryName in build-target-ish syntax.
--
-- Note: there are no Pretty or Parsec instances, as
-- there's other way to represent LibraryName, namely as bare
-- UnqualComponentName.
prettyLibraryNameComponent :: LibraryName -> Doc
parsecLibraryNameComponent :: CabalParsing m => m LibraryName
instance Data.Data.Data Distribution.Types.LibraryName.LibraryName
instance GHC.Show.Show Distribution.Types.LibraryName.LibraryName
instance GHC.Read.Read Distribution.Types.LibraryName.LibraryName
instance GHC.Classes.Ord Distribution.Types.LibraryName.LibraryName
instance GHC.Generics.Generic Distribution.Types.LibraryName.LibraryName
instance GHC.Classes.Eq Distribution.Types.LibraryName.LibraryName
instance Data.Binary.Class.Binary Distribution.Types.LibraryName.LibraryName
instance Distribution.Utils.Structured.Structured Distribution.Types.LibraryName.LibraryName
instance Control.DeepSeq.NFData Distribution.Types.LibraryName.LibraryName
module Distribution.Types.MungedPackageName
-- | A combination of a package and component name used in various legacy
-- interfaces, chiefly bundled with a version as
-- MungedPackageId. It's generally better to use a
-- UnitId to opaquely refer to some compilation/packing unit,
-- but that doesn't always work, e.g. where a "name" is needed, in which
-- case this can be used as a fallback.
--
-- Use mkMungedPackageName and unMungedPackageName to
-- convert from/to a String.
--
-- In 3.0.0.0 representation was changed from opaque (string) to
-- semantic representation.
data MungedPackageName
MungedPackageName :: !PackageName -> !LibraryName -> MungedPackageName
-- | Intended for internal use only
--
--
-- >>> decodeCompatPackageName "z-servant-z-lackey"
-- MungedPackageName (PackageName "servant") (LSubLibName (UnqualComponentName "lackey"))
--
decodeCompatPackageName :: PackageName -> MungedPackageName
-- | Intended for internal use only
--
--
-- >>> encodeCompatPackageName $ MungedPackageName "servant" (LSubLibName "lackey")
-- PackageName "z-servant-z-lackey"
--
--
-- This is used in cabal-install in the Solver. May become
-- obsolete as solver moves to per-component solving.
encodeCompatPackageName :: MungedPackageName -> PackageName
instance Data.Data.Data Distribution.Types.MungedPackageName.MungedPackageName
instance GHC.Classes.Ord Distribution.Types.MungedPackageName.MungedPackageName
instance GHC.Classes.Eq Distribution.Types.MungedPackageName.MungedPackageName
instance GHC.Show.Show Distribution.Types.MungedPackageName.MungedPackageName
instance GHC.Read.Read Distribution.Types.MungedPackageName.MungedPackageName
instance GHC.Generics.Generic Distribution.Types.MungedPackageName.MungedPackageName
instance Data.Binary.Class.Binary Distribution.Types.MungedPackageName.MungedPackageName
instance Distribution.Utils.Structured.Structured Distribution.Types.MungedPackageName.MungedPackageName
instance Control.DeepSeq.NFData Distribution.Types.MungedPackageName.MungedPackageName
instance Distribution.Pretty.Pretty Distribution.Types.MungedPackageName.MungedPackageName
instance Distribution.Parsec.Parsec Distribution.Types.MungedPackageName.MungedPackageName
module Distribution.Types.ForeignLibType
-- | What kind of foreign library is to be built?
data ForeignLibType
-- | A native shared library (.so on Linux, .dylib on
-- OSX, or .dll on Windows).
ForeignLibNativeShared :: ForeignLibType
-- | A native static library (not currently supported.)
ForeignLibNativeStatic :: ForeignLibType
ForeignLibTypeUnknown :: ForeignLibType
knownForeignLibTypes :: [ForeignLibType]
foreignLibTypeIsShared :: ForeignLibType -> Bool
instance Data.Data.Data Distribution.Types.ForeignLibType.ForeignLibType
instance GHC.Classes.Eq Distribution.Types.ForeignLibType.ForeignLibType
instance GHC.Read.Read Distribution.Types.ForeignLibType.ForeignLibType
instance GHC.Show.Show Distribution.Types.ForeignLibType.ForeignLibType
instance GHC.Generics.Generic Distribution.Types.ForeignLibType.ForeignLibType
instance Distribution.Pretty.Pretty Distribution.Types.ForeignLibType.ForeignLibType
instance Distribution.Parsec.Parsec Distribution.Types.ForeignLibType.ForeignLibType
instance Data.Binary.Class.Binary Distribution.Types.ForeignLibType.ForeignLibType
instance Distribution.Utils.Structured.Structured Distribution.Types.ForeignLibType.ForeignLibType
instance Control.DeepSeq.NFData Distribution.Types.ForeignLibType.ForeignLibType
instance GHC.Base.Semigroup Distribution.Types.ForeignLibType.ForeignLibType
instance GHC.Base.Monoid Distribution.Types.ForeignLibType.ForeignLibType
module Distribution.Types.ForeignLibOption
data ForeignLibOption
-- | Merge in all dependent libraries (i.e., use ghc -shared
-- -static rather than just record the dependencies, ala ghc
-- -shared -dynamic). This option is compulsory on Windows and
-- unsupported on other platforms.
ForeignLibStandalone :: ForeignLibOption
instance Data.Data.Data Distribution.Types.ForeignLibOption.ForeignLibOption
instance GHC.Classes.Eq Distribution.Types.ForeignLibOption.ForeignLibOption
instance GHC.Read.Read Distribution.Types.ForeignLibOption.ForeignLibOption
instance GHC.Show.Show Distribution.Types.ForeignLibOption.ForeignLibOption
instance GHC.Generics.Generic Distribution.Types.ForeignLibOption.ForeignLibOption
instance Distribution.Pretty.Pretty Distribution.Types.ForeignLibOption.ForeignLibOption
instance Distribution.Parsec.Parsec Distribution.Types.ForeignLibOption.ForeignLibOption
instance Data.Binary.Class.Binary Distribution.Types.ForeignLibOption.ForeignLibOption
instance Distribution.Utils.Structured.Structured Distribution.Types.ForeignLibOption.ForeignLibOption
instance Control.DeepSeq.NFData Distribution.Types.ForeignLibOption.ForeignLibOption
module Distribution.Types.Flag
-- | A flag can represent a feature to be included, or a way of linking a
-- target against its dependencies, or in fact whatever you can think of.
data PackageFlag
MkPackageFlag :: FlagName -> String -> Bool -> Bool -> PackageFlag
[flagName] :: PackageFlag -> FlagName
[flagDescription] :: PackageFlag -> String
[flagDefault] :: PackageFlag -> Bool
[flagManual] :: PackageFlag -> Bool
-- | A PackageFlag initialized with default parameters.
emptyFlag :: FlagName -> PackageFlag
-- | A FlagName is the name of a user-defined configuration flag
--
-- Use mkFlagName and unFlagName to convert from/to a
-- String.
--
-- This type is opaque since Cabal-2.0
data FlagName
-- | Construct a FlagName from a String
--
-- mkFlagName is the inverse to unFlagName
--
-- Note: No validations are performed to ensure that the resulting
-- FlagName is valid
mkFlagName :: String -> FlagName
-- | Convert FlagName to String
unFlagName :: FlagName -> String
-- | A FlagAssignment is a total or partial mapping of
-- FlagNames to Bool flag values. It represents the flags
-- chosen by the user or discovered during configuration. For example
-- --flags=foo --flags=-bar becomes [("foo", True), ("bar",
-- False)]
--
-- TODO: Why we record the multiplicity of the flag?
data FlagAssignment
-- | Construct a FlagAssignment from a list of flag/value pairs.
--
-- If duplicate flags occur in the input list, the later entries in the
-- list will take precedence.
mkFlagAssignment :: [(FlagName, Bool)] -> FlagAssignment
-- | Deconstruct a FlagAssignment into a list of flag/value pairs.
--
--
-- null (findDuplicateFlagAssignments fa) ==> (mkFlagAssignment . unFlagAssignment) fa == fa
--
unFlagAssignment :: FlagAssignment -> [(FlagName, Bool)]
-- | Lookup the value for a flag
--
-- Returns Nothing if the flag isn't contained in the
-- FlagAssignment.
lookupFlagAssignment :: FlagName -> FlagAssignment -> Maybe Bool
-- | Insert or update the boolean value of a flag.
--
-- If the flag is already present in the FlagAssigment, the
-- value will be updated and the fact that multiple values have been
-- provided for that flag will be recorded so that a warning can be
-- generated later on.
insertFlagAssignment :: FlagName -> Bool -> FlagAssignment -> FlagAssignment
-- | Remove all flag-assignments from the first FlagAssignment that
-- are contained in the second FlagAssignment
--
-- NB/TODO: This currently only removes flag assignments which also match
-- the value assignment! We should review the code which uses this
-- operation to figure out if this it's not enough to only compare the
-- flagnames without the values.
diffFlagAssignment :: FlagAssignment -> FlagAssignment -> FlagAssignment
-- | Find the FlagNames that have been listed more than once.
findDuplicateFlagAssignments :: FlagAssignment -> [FlagName]
-- | Test whether FlagAssignment is empty.
nullFlagAssignment :: FlagAssignment -> Bool
-- | String representation of a flag-value pair.
showFlagValue :: (FlagName, Bool) -> String
-- | Pretty-prints a flag assignment.
dispFlagAssignment :: FlagAssignment -> Doc
-- | Show flag assignment.
showFlagAssignment :: FlagAssignment -> String
-- | Parses a flag assignment.
parsecFlagAssignment :: CabalParsing m => m FlagAssignment
-- | Parse a non-empty flag assignment
--
-- The flags have to explicitly start with minus or plus.
parsecFlagAssignmentNonEmpty :: CabalParsing m => m FlagAssignment
-- | We need this as far as we support custom setups older than 2.2.0.0
legacyShowFlagAssignment :: FlagAssignment -> String
legacyShowFlagAssignment' :: FlagAssignment -> [String]
-- | We need this as far as we support custom setups older than 2.2.0.0
legacyParsecFlagAssignment :: CabalParsing m => m FlagAssignment
instance Control.DeepSeq.NFData Distribution.Types.Flag.FlagName
instance Data.Data.Data Distribution.Types.Flag.FlagName
instance GHC.Read.Read Distribution.Types.Flag.FlagName
instance GHC.Show.Show Distribution.Types.Flag.FlagName
instance GHC.Classes.Ord Distribution.Types.Flag.FlagName
instance GHC.Generics.Generic Distribution.Types.Flag.FlagName
instance GHC.Classes.Eq Distribution.Types.Flag.FlagName
instance GHC.Generics.Generic Distribution.Types.Flag.PackageFlag
instance Data.Data.Data Distribution.Types.Flag.PackageFlag
instance GHC.Classes.Eq Distribution.Types.Flag.PackageFlag
instance GHC.Show.Show Distribution.Types.Flag.PackageFlag
instance Control.DeepSeq.NFData Distribution.Types.Flag.FlagAssignment
instance GHC.Generics.Generic Distribution.Types.Flag.FlagAssignment
instance Data.Binary.Class.Binary Distribution.Types.Flag.FlagAssignment
instance Distribution.Utils.Structured.Structured Distribution.Types.Flag.FlagAssignment
instance GHC.Classes.Eq Distribution.Types.Flag.FlagAssignment
instance GHC.Classes.Ord Distribution.Types.Flag.FlagAssignment
instance GHC.Base.Semigroup Distribution.Types.Flag.FlagAssignment
instance GHC.Base.Monoid Distribution.Types.Flag.FlagAssignment
instance GHC.Read.Read Distribution.Types.Flag.FlagAssignment
instance GHC.Show.Show Distribution.Types.Flag.FlagAssignment
instance Distribution.Pretty.Pretty Distribution.Types.Flag.FlagAssignment
instance Distribution.Parsec.Parsec Distribution.Types.Flag.FlagAssignment
instance Data.Binary.Class.Binary Distribution.Types.Flag.PackageFlag
instance Distribution.Utils.Structured.Structured Distribution.Types.Flag.PackageFlag
instance Control.DeepSeq.NFData Distribution.Types.Flag.PackageFlag
instance Data.String.IsString Distribution.Types.Flag.FlagName
instance Data.Binary.Class.Binary Distribution.Types.Flag.FlagName
instance Distribution.Utils.Structured.Structured Distribution.Types.Flag.FlagName
instance Distribution.Pretty.Pretty Distribution.Types.Flag.FlagName
instance Distribution.Parsec.Parsec Distribution.Types.Flag.FlagName
module Distribution.Types.ExecutableScope
data ExecutableScope
ExecutablePublic :: ExecutableScope
ExecutablePrivate :: ExecutableScope
instance Data.Data.Data Distribution.Types.ExecutableScope.ExecutableScope
instance GHC.Classes.Eq Distribution.Types.ExecutableScope.ExecutableScope
instance GHC.Read.Read Distribution.Types.ExecutableScope.ExecutableScope
instance GHC.Show.Show Distribution.Types.ExecutableScope.ExecutableScope
instance GHC.Generics.Generic Distribution.Types.ExecutableScope.ExecutableScope
instance Distribution.Pretty.Pretty Distribution.Types.ExecutableScope.ExecutableScope
instance Distribution.Parsec.Parsec Distribution.Types.ExecutableScope.ExecutableScope
instance Data.Binary.Class.Binary Distribution.Types.ExecutableScope.ExecutableScope
instance Distribution.Utils.Structured.Structured Distribution.Types.ExecutableScope.ExecutableScope
instance Control.DeepSeq.NFData Distribution.Types.ExecutableScope.ExecutableScope
instance GHC.Base.Semigroup Distribution.Types.ExecutableScope.ExecutableScope
instance GHC.Base.Monoid Distribution.Types.ExecutableScope.ExecutableScope
module Distribution.Types.ComponentName
data ComponentName
CLibName :: LibraryName -> ComponentName
CFLibName :: UnqualComponentName -> ComponentName
CExeName :: UnqualComponentName -> ComponentName
CTestName :: UnqualComponentName -> ComponentName
CBenchName :: UnqualComponentName -> ComponentName
showComponentName :: ComponentName -> String
componentNameStanza :: ComponentName -> String
-- | This gets the underlying unqualified component name. In fact, it is
-- guaranteed to uniquely identify a component, returning
-- Nothing if the ComponentName was for the public
-- library.
componentNameString :: ComponentName -> Maybe UnqualComponentName
instance GHC.Show.Show Distribution.Types.ComponentName.ComponentName
instance GHC.Read.Read Distribution.Types.ComponentName.ComponentName
instance GHC.Classes.Ord Distribution.Types.ComponentName.ComponentName
instance GHC.Generics.Generic Distribution.Types.ComponentName.ComponentName
instance GHC.Classes.Eq Distribution.Types.ComponentName.ComponentName
instance Data.Binary.Class.Binary Distribution.Types.ComponentName.ComponentName
instance Distribution.Utils.Structured.Structured Distribution.Types.ComponentName.ComponentName
instance Distribution.Pretty.Pretty Distribution.Types.ComponentName.ComponentName
instance Distribution.Parsec.Parsec Distribution.Types.ComponentName.ComponentName
module Distribution.Types.ComponentId
-- | A ComponentId uniquely identifies the transitive source code
-- closure of a component (i.e. libraries, executables).
--
-- For non-Backpack components, this corresponds one to one with the
-- UnitId, which serves as the basis for install paths, linker
-- symbols, etc.
--
-- Use mkComponentId and unComponentId to convert from/to a
-- String.
--
-- This type is opaque since Cabal-2.0
data ComponentId
-- | Convert ComponentId to String
unComponentId :: ComponentId -> String
-- | Construct a ComponentId from a String
--
-- mkComponentId is the inverse to unComponentId
--
-- Note: No validations are performed to ensure that the resulting
-- ComponentId is valid
mkComponentId :: String -> ComponentId
instance Data.Data.Data Distribution.Types.ComponentId.ComponentId
instance GHC.Classes.Ord Distribution.Types.ComponentId.ComponentId
instance GHC.Classes.Eq Distribution.Types.ComponentId.ComponentId
instance GHC.Show.Show Distribution.Types.ComponentId.ComponentId
instance GHC.Read.Read Distribution.Types.ComponentId.ComponentId
instance GHC.Generics.Generic Distribution.Types.ComponentId.ComponentId
instance Data.String.IsString Distribution.Types.ComponentId.ComponentId
instance Data.Binary.Class.Binary Distribution.Types.ComponentId.ComponentId
instance Distribution.Utils.Structured.Structured Distribution.Types.ComponentId.ComponentId
instance Distribution.Pretty.Pretty Distribution.Types.ComponentId.ComponentId
instance Distribution.Parsec.Parsec Distribution.Types.ComponentId.ComponentId
instance Control.DeepSeq.NFData Distribution.Types.ComponentId.ComponentId
module Distribution.Types.GivenComponent
-- | A GivenComponent represents a library depended on and
-- explicitly specified by the user/client with --dependency
--
-- It enables Cabal to know which ComponentId to associate with a
-- library
data GivenComponent
GivenComponent :: PackageName -> LibraryName -> ComponentId -> GivenComponent
[givenComponentPackage] :: GivenComponent -> PackageName
[givenComponentName] :: GivenComponent -> LibraryName
[givenComponentId] :: GivenComponent -> ComponentId
instance GHC.Classes.Eq Distribution.Types.GivenComponent.GivenComponent
instance GHC.Show.Show Distribution.Types.GivenComponent.GivenComponent
instance GHC.Read.Read Distribution.Types.GivenComponent.GivenComponent
instance GHC.Generics.Generic Distribution.Types.GivenComponent.GivenComponent
instance Data.Binary.Class.Binary Distribution.Types.GivenComponent.GivenComponent
instance Distribution.Utils.Structured.Structured Distribution.Types.GivenComponent.GivenComponent
module Distribution.Types.BuildType
-- | The type of build system used by this package.
data BuildType
-- | calls Distribution.Simple.defaultMain
Simple :: BuildType
-- | calls Distribution.Simple.defaultMainWithHooks
-- defaultUserHooks, which invokes configure to generate
-- additional build information used by later phases.
Configure :: BuildType
-- | calls Distribution.Make.defaultMain
Make :: BuildType
-- | uses user-supplied Setup.hs or Setup.lhs (default)
Custom :: BuildType
knownBuildTypes :: [BuildType]
instance Data.Data.Data Distribution.Types.BuildType.BuildType
instance GHC.Classes.Eq Distribution.Types.BuildType.BuildType
instance GHC.Read.Read Distribution.Types.BuildType.BuildType
instance GHC.Show.Show Distribution.Types.BuildType.BuildType
instance GHC.Generics.Generic Distribution.Types.BuildType.BuildType
instance Data.Binary.Class.Binary Distribution.Types.BuildType.BuildType
instance Distribution.Utils.Structured.Structured Distribution.Types.BuildType.BuildType
instance Control.DeepSeq.NFData Distribution.Types.BuildType.BuildType
instance Distribution.Pretty.Pretty Distribution.Types.BuildType.BuildType
instance Distribution.Parsec.Parsec Distribution.Types.BuildType.BuildType
module Distribution.Types.AbiHash
-- | ABI Hashes
--
-- Use mkAbiHash and unAbiHash to convert from/to a
-- String.
--
-- This type is opaque since Cabal-2.0
data AbiHash
-- | Construct a AbiHash from a String
--
-- mkAbiHash is the inverse to unAbiHash
--
-- Note: No validations are performed to ensure that the resulting
-- AbiHash is valid
unAbiHash :: AbiHash -> String
-- | Convert AbiHash to String
mkAbiHash :: String -> AbiHash
instance GHC.Generics.Generic Distribution.Types.AbiHash.AbiHash
instance GHC.Read.Read Distribution.Types.AbiHash.AbiHash
instance GHC.Show.Show Distribution.Types.AbiHash.AbiHash
instance GHC.Classes.Eq Distribution.Types.AbiHash.AbiHash
instance Data.String.IsString Distribution.Types.AbiHash.AbiHash
instance Data.Binary.Class.Binary Distribution.Types.AbiHash.AbiHash
instance Distribution.Utils.Structured.Structured Distribution.Types.AbiHash.AbiHash
instance Control.DeepSeq.NFData Distribution.Types.AbiHash.AbiHash
instance Distribution.Pretty.Pretty Distribution.Types.AbiHash.AbiHash
instance Distribution.Parsec.Parsec Distribution.Types.AbiHash.AbiHash
module Distribution.Text
display :: Pretty a => a -> String
simpleParse :: Parsec a => String -> Maybe a
-- | Cabal often needs to do slightly different things on specific
-- platforms. You probably know about the os however using that is
-- very inconvenient because it is a string and different Haskell
-- implementations do not agree on using the same strings for the same
-- platforms! (In particular see the controversy over "windows" vs
-- "mingw32"). So to make it more consistent and easy to use we have an
-- OS enumeration.
module Distribution.System
-- | These are the known OS names: Linux, Windows, OSX ,FreeBSD, OpenBSD,
-- NetBSD, DragonFly ,Solaris, AIX, HPUX, IRIX ,HaLVM ,Hurd ,IOS,
-- Android,Ghcjs
--
-- The following aliases can also be used:, * Windows aliases: mingw32,
-- win32, cygwin32 * OSX alias: darwin * Hurd alias: gnu * FreeBSD alias:
-- kfreebsdgnu * Solaris alias: solaris2
data OS
Linux :: OS
Windows :: OS
OSX :: OS
FreeBSD :: OS
OpenBSD :: OS
NetBSD :: OS
DragonFly :: OS
Solaris :: OS
AIX :: OS
HPUX :: OS
IRIX :: OS
HaLVM :: OS
Hurd :: OS
IOS :: OS
Android :: OS
Ghcjs :: OS
OtherOS :: String -> OS
buildOS :: OS
-- | These are the known Arches: I386, X86_64, PPC, PPC64, Sparc, Arm,
-- AArch64, Mips, SH, IA64, S39, Alpha, Hppa, Rs6000, M68k, Vax, and
-- JavaScript.
--
-- The following aliases can also be used: * PPC alias: powerpc * PPC64
-- alias : powerpc64, powerpc64le * Sparc aliases: sparc64, sun4 * Mips
-- aliases: mipsel, mipseb * Arm aliases: armeb, armel * AArch64 aliases:
-- arm64
data Arch
I386 :: Arch
X86_64 :: Arch
PPC :: Arch
PPC64 :: Arch
Sparc :: Arch
Arm :: Arch
AArch64 :: Arch
Mips :: Arch
SH :: Arch
IA64 :: Arch
S390 :: Arch
Alpha :: Arch
Hppa :: Arch
Rs6000 :: Arch
M68k :: Arch
Vax :: Arch
JavaScript :: Arch
OtherArch :: String -> Arch
buildArch :: Arch
data Platform
Platform :: Arch -> OS -> Platform
-- | The platform Cabal was compiled on. In most cases,
-- LocalBuildInfo.hostPlatform should be used instead (the
-- platform we're targeting).
buildPlatform :: Platform
platformFromTriple :: String -> Maybe Platform
knownOSs :: [OS]
knownArches :: [Arch]
-- | How strict to be when classifying strings into the OS and
-- Arch enums.
--
-- The reason we have multiple ways to do the classification is because
-- there are two situations where we need to do it.
--
-- For parsing OS and arch names in .cabal files we really want everyone
-- to be referring to the same or arch by the same name. Variety is not a
-- virtue in this case. We don't mind about case though.
--
-- For the System.Info.os/arch different Haskell implementations use
-- different names for the same or/arch. Also they tend to distinguish
-- versions of an OS/arch which we just don't care about.
--
-- The Compat classification allows us to recognise aliases that
-- are already in common use but it allows us to distinguish them from
-- the canonical name which enables us to warn about such deprecated
-- aliases.
data ClassificationStrictness
Permissive :: ClassificationStrictness
Compat :: ClassificationStrictness
Strict :: ClassificationStrictness
classifyOS :: ClassificationStrictness -> String -> OS
classifyArch :: ClassificationStrictness -> String -> Arch
instance Data.Data.Data Distribution.System.OS
instance GHC.Read.Read Distribution.System.OS
instance GHC.Show.Show Distribution.System.OS
instance GHC.Classes.Ord Distribution.System.OS
instance GHC.Generics.Generic Distribution.System.OS
instance GHC.Classes.Eq Distribution.System.OS
instance Data.Data.Data Distribution.System.Arch
instance GHC.Read.Read Distribution.System.Arch
instance GHC.Show.Show Distribution.System.Arch
instance GHC.Classes.Ord Distribution.System.Arch
instance GHC.Generics.Generic Distribution.System.Arch
instance GHC.Classes.Eq Distribution.System.Arch
instance Data.Data.Data Distribution.System.Platform
instance GHC.Read.Read Distribution.System.Platform
instance GHC.Show.Show Distribution.System.Platform
instance GHC.Classes.Ord Distribution.System.Platform
instance GHC.Generics.Generic Distribution.System.Platform
instance GHC.Classes.Eq Distribution.System.Platform
instance Data.Binary.Class.Binary Distribution.System.Platform
instance Distribution.Utils.Structured.Structured Distribution.System.Platform
instance Control.DeepSeq.NFData Distribution.System.Platform
instance Distribution.Pretty.Pretty Distribution.System.Platform
instance Distribution.Parsec.Parsec Distribution.System.Platform
instance Data.Binary.Class.Binary Distribution.System.Arch
instance Distribution.Utils.Structured.Structured Distribution.System.Arch
instance Control.DeepSeq.NFData Distribution.System.Arch
instance Distribution.Pretty.Pretty Distribution.System.Arch
instance Distribution.Parsec.Parsec Distribution.System.Arch
instance Data.Binary.Class.Binary Distribution.System.OS
instance Distribution.Utils.Structured.Structured Distribution.System.OS
instance Control.DeepSeq.NFData Distribution.System.OS
instance Distribution.Pretty.Pretty Distribution.System.OS
instance Distribution.Parsec.Parsec Distribution.System.OS
module Distribution.SPDX.LicenseReference
-- | A user defined license reference denoted by
-- LicenseRef-[idstring] (for a license not on the SPDX License
-- List);
data LicenseRef
-- | License reference.
licenseRef :: LicenseRef -> String
-- | Document reference.
licenseDocumentRef :: LicenseRef -> Maybe String
-- | Create LicenseRef from optional document ref and name.
mkLicenseRef :: Maybe String -> String -> Maybe LicenseRef
-- | Like mkLicenseRef but convert invalid characters into
-- -.
mkLicenseRef' :: Maybe String -> String -> LicenseRef
instance GHC.Generics.Generic Distribution.SPDX.LicenseReference.LicenseRef
instance Data.Data.Data Distribution.SPDX.LicenseReference.LicenseRef
instance GHC.Classes.Ord Distribution.SPDX.LicenseReference.LicenseRef
instance GHC.Classes.Eq Distribution.SPDX.LicenseReference.LicenseRef
instance GHC.Read.Read Distribution.SPDX.LicenseReference.LicenseRef
instance GHC.Show.Show Distribution.SPDX.LicenseReference.LicenseRef
instance Data.Binary.Class.Binary Distribution.SPDX.LicenseReference.LicenseRef
instance Distribution.Utils.Structured.Structured Distribution.SPDX.LicenseReference.LicenseRef
instance Control.DeepSeq.NFData Distribution.SPDX.LicenseReference.LicenseRef
instance Distribution.Pretty.Pretty Distribution.SPDX.LicenseReference.LicenseRef
instance Distribution.Parsec.Parsec Distribution.SPDX.LicenseReference.LicenseRef
module Distribution.SPDX.LicenseId
-- | SPDX License identifier
data LicenseId
-- | 0BSD, BSD Zero Clause License
NullBSD :: LicenseId
-- | AAL, Attribution Assurance License
AAL :: LicenseId
-- | Abstyles, Abstyles License
Abstyles :: LicenseId
-- | Adobe-2006, Adobe Systems Incorporated Source Code License
-- Agreement
Adobe_2006 :: LicenseId
-- | Adobe-Glyph, Adobe Glyph List License
Adobe_Glyph :: LicenseId
-- | ADSL, Amazon Digital Services License
ADSL :: LicenseId
-- | AFL-1.1, Academic Free License v1.1
AFL_1_1 :: LicenseId
-- | AFL-1.2, Academic Free License v1.2
AFL_1_2 :: LicenseId
-- | AFL-2.0, Academic Free License v2.0
AFL_2_0 :: LicenseId
-- | AFL-2.1, Academic Free License v2.1
AFL_2_1 :: LicenseId
-- | AFL-3.0, Academic Free License v3.0
AFL_3_0 :: LicenseId
-- | Afmparse, Afmparse License
Afmparse :: LicenseId
-- | AGPL-1.0, Affero General Public License v1.0, SPDX License
-- List 3.0
AGPL_1_0 :: LicenseId
-- | AGPL-1.0-only, Affero General Public License v1.0 only, SPDX
-- License List 3.2, SPDX License List 3.6, SPDX License List 3.9, SPDX
-- License List 3.10
AGPL_1_0_only :: LicenseId
-- | AGPL-1.0-or-later, Affero General Public License v1.0 or
-- later, SPDX License List 3.2, SPDX License List 3.6, SPDX License List
-- 3.9, SPDX License List 3.10
AGPL_1_0_or_later :: LicenseId
-- | AGPL-3.0-only, GNU Affero General Public License v3.0 only
AGPL_3_0_only :: LicenseId
-- | AGPL-3.0-or-later, GNU Affero General Public License v3.0 or
-- later
AGPL_3_0_or_later :: LicenseId
-- | Aladdin, Aladdin Free Public License
Aladdin :: LicenseId
-- | AMDPLPA, AMD's plpa_map.c License
AMDPLPA :: LicenseId
-- | AML, Apple MIT License
AML :: LicenseId
-- | AMPAS, Academy of Motion Picture Arts and Sciences BSD
AMPAS :: LicenseId
-- | ANTLR-PD, ANTLR Software Rights Notice
ANTLR_PD :: LicenseId
-- | Apache-1.0, Apache License 1.0
Apache_1_0 :: LicenseId
-- | Apache-1.1, Apache License 1.1
Apache_1_1 :: LicenseId
-- | Apache-2.0, Apache License 2.0
Apache_2_0 :: LicenseId
-- | APAFML, Adobe Postscript AFM License
APAFML :: LicenseId
-- | APL-1.0, Adaptive Public License 1.0
APL_1_0 :: LicenseId
-- | APSL-1.0, Apple Public Source License 1.0
APSL_1_0 :: LicenseId
-- | APSL-1.1, Apple Public Source License 1.1
APSL_1_1 :: LicenseId
-- | APSL-1.2, Apple Public Source License 1.2
APSL_1_2 :: LicenseId
-- | APSL-2.0, Apple Public Source License 2.0
APSL_2_0 :: LicenseId
-- | Artistic-1.0-cl8, Artistic License 1.0 w/clause 8
Artistic_1_0_cl8 :: LicenseId
-- | Artistic-1.0-Perl, Artistic License 1.0 (Perl)
Artistic_1_0_Perl :: LicenseId
-- | Artistic-1.0, Artistic License 1.0
Artistic_1_0 :: LicenseId
-- | Artistic-2.0, Artistic License 2.0
Artistic_2_0 :: LicenseId
-- | Bahyph, Bahyph License
Bahyph :: LicenseId
-- | Barr, Barr License
Barr :: LicenseId
-- | Beerware, Beerware License
Beerware :: LicenseId
-- | BitTorrent-1.0, BitTorrent Open Source License v1.0
BitTorrent_1_0 :: LicenseId
-- | BitTorrent-1.1, BitTorrent Open Source License v1.1
BitTorrent_1_1 :: LicenseId
-- | blessing, SQLite Blessing, SPDX License List 3.6, SPDX
-- License List 3.9, SPDX License List 3.10
Blessing :: LicenseId
-- | BlueOak-1.0.0, Blue Oak Model License 1.0.0, SPDX License
-- List 3.6, SPDX License List 3.9, SPDX License List 3.10
BlueOak_1_0_0 :: LicenseId
-- | Borceux, Borceux license
Borceux :: LicenseId
-- | BSD-1-Clause, BSD 1-Clause License
BSD_1_Clause :: LicenseId
-- | BSD-2-Clause-FreeBSD, BSD 2-Clause FreeBSD License, SPDX
-- License List 3.0, SPDX License List 3.2, SPDX License List 3.6, SPDX
-- License List 3.9
BSD_2_Clause_FreeBSD :: LicenseId
-- | BSD-2-Clause-NetBSD, BSD 2-Clause NetBSD License, SPDX
-- License List 3.0, SPDX License List 3.2, SPDX License List 3.6
BSD_2_Clause_NetBSD :: LicenseId
-- | BSD-2-Clause-Patent, BSD-2-Clause Plus Patent License
BSD_2_Clause_Patent :: LicenseId
-- | BSD-2-Clause-Views, BSD 2-Clause with views sentence, SPDX
-- License List 3.10
BSD_2_Clause_Views :: LicenseId
-- | BSD-2-Clause, BSD 2-Clause Simplified License
BSD_2_Clause :: LicenseId
-- | BSD-3-Clause-Attribution, BSD with attribution
BSD_3_Clause_Attribution :: LicenseId
-- | BSD-3-Clause-Clear, BSD 3-Clause Clear License
BSD_3_Clause_Clear :: LicenseId
-- | BSD-3-Clause-LBNL, Lawrence Berkeley National Labs BSD
-- variant license
BSD_3_Clause_LBNL :: LicenseId
-- | BSD-3-Clause-No-Nuclear-License-2014, BSD 3-Clause No Nuclear
-- License 2014
BSD_3_Clause_No_Nuclear_License_2014 :: LicenseId
-- | BSD-3-Clause-No-Nuclear-License, BSD 3-Clause No Nuclear
-- License
BSD_3_Clause_No_Nuclear_License :: LicenseId
-- | BSD-3-Clause-No-Nuclear-Warranty, BSD 3-Clause No Nuclear
-- Warranty
BSD_3_Clause_No_Nuclear_Warranty :: LicenseId
-- | BSD-3-Clause-Open-MPI, BSD 3-Clause Open MPI variant, SPDX
-- License List 3.6, SPDX License List 3.9, SPDX License List 3.10
BSD_3_Clause_Open_MPI :: LicenseId
-- | BSD-3-Clause, BSD 3-Clause New or Revised
-- License
BSD_3_Clause :: LicenseId
-- | BSD-4-Clause-UC, BSD-4-Clause (University of
-- California-Specific)
BSD_4_Clause_UC :: LicenseId
-- | BSD-4-Clause, BSD 4-Clause Original or Old
-- License
BSD_4_Clause :: LicenseId
-- | BSD-Protection, BSD Protection License
BSD_Protection :: LicenseId
-- | BSD-Source-Code, BSD Source Code Attribution
BSD_Source_Code :: LicenseId
-- | BSL-1.0, Boost Software License 1.0
BSL_1_0 :: LicenseId
-- | bzip2-1.0.5, bzip2 and libbzip2 License v1.0.5
Bzip2_1_0_5 :: LicenseId
-- | bzip2-1.0.6, bzip2 and libbzip2 License v1.0.6
Bzip2_1_0_6 :: LicenseId
-- | CAL-1.0-Combined-Work-Exception, Cryptographic Autonomy
-- License 1.0 (Combined Work Exception), SPDX License List 3.9, SPDX
-- License List 3.10
CAL_1_0_Combined_Work_Exception :: LicenseId
-- | CAL-1.0, Cryptographic Autonomy License 1.0, SPDX License
-- List 3.9, SPDX License List 3.10
CAL_1_0 :: LicenseId
-- | Caldera, Caldera License
Caldera :: LicenseId
-- | CATOSL-1.1, Computer Associates Trusted Open Source License
-- 1.1
CATOSL_1_1 :: LicenseId
-- | CC-BY-1.0, Creative Commons Attribution 1.0 Generic
CC_BY_1_0 :: LicenseId
-- | CC-BY-2.0, Creative Commons Attribution 2.0 Generic
CC_BY_2_0 :: LicenseId
-- | CC-BY-2.5, Creative Commons Attribution 2.5 Generic
CC_BY_2_5 :: LicenseId
-- | CC-BY-3.0-AT, Creative Commons Attribution 3.0 Austria, SPDX
-- License List 3.10
CC_BY_3_0_AT :: LicenseId
-- | CC-BY-3.0, Creative Commons Attribution 3.0 Unported
CC_BY_3_0 :: LicenseId
-- | CC-BY-4.0, Creative Commons Attribution 4.0 International
CC_BY_4_0 :: LicenseId
-- | CC-BY-NC-1.0, Creative Commons Attribution Non Commercial 1.0
-- Generic
CC_BY_NC_1_0 :: LicenseId
-- | CC-BY-NC-2.0, Creative Commons Attribution Non Commercial 2.0
-- Generic
CC_BY_NC_2_0 :: LicenseId
-- | CC-BY-NC-2.5, Creative Commons Attribution Non Commercial 2.5
-- Generic
CC_BY_NC_2_5 :: LicenseId
-- | CC-BY-NC-3.0, Creative Commons Attribution Non Commercial 3.0
-- Unported
CC_BY_NC_3_0 :: LicenseId
-- | CC-BY-NC-4.0, Creative Commons Attribution Non Commercial 4.0
-- International
CC_BY_NC_4_0 :: LicenseId
-- | CC-BY-NC-ND-1.0, Creative Commons Attribution Non Commercial
-- No Derivatives 1.0 Generic
CC_BY_NC_ND_1_0 :: LicenseId
-- | CC-BY-NC-ND-2.0, Creative Commons Attribution Non Commercial
-- No Derivatives 2.0 Generic
CC_BY_NC_ND_2_0 :: LicenseId
-- | CC-BY-NC-ND-2.5, Creative Commons Attribution Non Commercial
-- No Derivatives 2.5 Generic
CC_BY_NC_ND_2_5 :: LicenseId
-- | CC-BY-NC-ND-3.0-IGO, Creative Commons Attribution Non
-- Commercial No Derivatives 3.0 IGO, SPDX License List 3.10
CC_BY_NC_ND_3_0_IGO :: LicenseId
-- | CC-BY-NC-ND-3.0, Creative Commons Attribution Non Commercial
-- No Derivatives 3.0 Unported
CC_BY_NC_ND_3_0 :: LicenseId
-- | CC-BY-NC-ND-4.0, Creative Commons Attribution Non Commercial
-- No Derivatives 4.0 International
CC_BY_NC_ND_4_0 :: LicenseId
-- | CC-BY-NC-SA-1.0, Creative Commons Attribution Non Commercial
-- Share Alike 1.0 Generic
CC_BY_NC_SA_1_0 :: LicenseId
-- | CC-BY-NC-SA-2.0, Creative Commons Attribution Non Commercial
-- Share Alike 2.0 Generic
CC_BY_NC_SA_2_0 :: LicenseId
-- | CC-BY-NC-SA-2.5, Creative Commons Attribution Non Commercial
-- Share Alike 2.5 Generic
CC_BY_NC_SA_2_5 :: LicenseId
-- | CC-BY-NC-SA-3.0, Creative Commons Attribution Non Commercial
-- Share Alike 3.0 Unported
CC_BY_NC_SA_3_0 :: LicenseId
-- | CC-BY-NC-SA-4.0, Creative Commons Attribution Non Commercial
-- Share Alike 4.0 International
CC_BY_NC_SA_4_0 :: LicenseId
-- | CC-BY-ND-1.0, Creative Commons Attribution No Derivatives 1.0
-- Generic
CC_BY_ND_1_0 :: LicenseId
-- | CC-BY-ND-2.0, Creative Commons Attribution No Derivatives 2.0
-- Generic
CC_BY_ND_2_0 :: LicenseId
-- | CC-BY-ND-2.5, Creative Commons Attribution No Derivatives 2.5
-- Generic
CC_BY_ND_2_5 :: LicenseId
-- | CC-BY-ND-3.0, Creative Commons Attribution No Derivatives 3.0
-- Unported
CC_BY_ND_3_0 :: LicenseId
-- | CC-BY-ND-4.0, Creative Commons Attribution No Derivatives 4.0
-- International
CC_BY_ND_4_0 :: LicenseId
-- | CC-BY-SA-1.0, Creative Commons Attribution Share Alike 1.0
-- Generic
CC_BY_SA_1_0 :: LicenseId
-- | CC-BY-SA-2.0, Creative Commons Attribution Share Alike 2.0
-- Generic
CC_BY_SA_2_0 :: LicenseId
-- | CC-BY-SA-2.5, Creative Commons Attribution Share Alike 2.5
-- Generic
CC_BY_SA_2_5 :: LicenseId
-- | CC-BY-SA-3.0-AT, Creative Commons Attribution-Share Alike 3.0
-- Austria, SPDX License List 3.10
CC_BY_SA_3_0_AT :: LicenseId
-- | CC-BY-SA-3.0, Creative Commons Attribution Share Alike 3.0
-- Unported
CC_BY_SA_3_0 :: LicenseId
-- | CC-BY-SA-4.0, Creative Commons Attribution Share Alike 4.0
-- International
CC_BY_SA_4_0 :: LicenseId
-- | CC-PDDC, Creative Commons Public Domain Dedication and
-- Certification, SPDX License List 3.6, SPDX License List 3.9, SPDX
-- License List 3.10
CC_PDDC :: LicenseId
-- | CC0-1.0, Creative Commons Zero v1.0 Universal
CC0_1_0 :: LicenseId
-- | CDDL-1.0, Common Development and Distribution License 1.0
CDDL_1_0 :: LicenseId
-- | CDDL-1.1, Common Development and Distribution License 1.1
CDDL_1_1 :: LicenseId
-- | CDLA-Permissive-1.0, Community Data License Agreement
-- Permissive 1.0
CDLA_Permissive_1_0 :: LicenseId
-- | CDLA-Sharing-1.0, Community Data License Agreement Sharing
-- 1.0
CDLA_Sharing_1_0 :: LicenseId
-- | CECILL-1.0, CeCILL Free Software License Agreement v1.0
CECILL_1_0 :: LicenseId
-- | CECILL-1.1, CeCILL Free Software License Agreement v1.1
CECILL_1_1 :: LicenseId
-- | CECILL-2.0, CeCILL Free Software License Agreement v2.0
CECILL_2_0 :: LicenseId
-- | CECILL-2.1, CeCILL Free Software License Agreement v2.1
CECILL_2_1 :: LicenseId
-- | CECILL-B, CeCILL-B Free Software License Agreement
CECILL_B :: LicenseId
-- | CECILL-C, CeCILL-C Free Software License Agreement
CECILL_C :: LicenseId
-- | CERN-OHL-1.1, CERN Open Hardware Licence v1.1, SPDX License
-- List 3.6, SPDX License List 3.9, SPDX License List 3.10
CERN_OHL_1_1 :: LicenseId
-- | CERN-OHL-1.2, CERN Open Hardware Licence v1.2, SPDX License
-- List 3.6, SPDX License List 3.9, SPDX License List 3.10
CERN_OHL_1_2 :: LicenseId
-- | CERN-OHL-P-2.0, CERN Open Hardware Licence Version 2 -
-- Permissive, SPDX License List 3.9, SPDX License List 3.10
CERN_OHL_P_2_0 :: LicenseId
-- | CERN-OHL-S-2.0, CERN Open Hardware Licence Version 2 -
-- Strongly Reciprocal, SPDX License List 3.9, SPDX License List 3.10
CERN_OHL_S_2_0 :: LicenseId
-- | CERN-OHL-W-2.0, CERN Open Hardware Licence Version 2 - Weakly
-- Reciprocal, SPDX License List 3.9, SPDX License List 3.10
CERN_OHL_W_2_0 :: LicenseId
-- | ClArtistic, Clarified Artistic License
ClArtistic :: LicenseId
-- | CNRI-Jython, CNRI Jython License
CNRI_Jython :: LicenseId
-- | CNRI-Python-GPL-Compatible, CNRI Python Open Source GPL
-- Compatible License Agreement
CNRI_Python_GPL_Compatible :: LicenseId
-- | CNRI-Python, CNRI Python License
CNRI_Python :: LicenseId
-- | Condor-1.1, Condor Public License v1.1
Condor_1_1 :: LicenseId
-- | copyleft-next-0.3.0, copyleft-next 0.3.0, SPDX License List
-- 3.6, SPDX License List 3.9, SPDX License List 3.10
Copyleft_next_0_3_0 :: LicenseId
-- | copyleft-next-0.3.1, copyleft-next 0.3.1, SPDX License List
-- 3.6, SPDX License List 3.9, SPDX License List 3.10
Copyleft_next_0_3_1 :: LicenseId
-- | CPAL-1.0, Common Public Attribution License 1.0
CPAL_1_0 :: LicenseId
-- | CPL-1.0, Common Public License 1.0
CPL_1_0 :: LicenseId
-- | CPOL-1.02, Code Project Open License 1.02
CPOL_1_02 :: LicenseId
-- | Crossword, Crossword License
Crossword :: LicenseId
-- | CrystalStacker, CrystalStacker License
CrystalStacker :: LicenseId
-- | CUA-OPL-1.0, CUA Office Public License v1.0
CUA_OPL_1_0 :: LicenseId
-- | Cube, Cube License
Cube :: LicenseId
-- | curl, curl License
Curl :: LicenseId
-- | D-FSL-1.0, Deutsche Freie Software Lizenz
D_FSL_1_0 :: LicenseId
-- | diffmark, diffmark license
Diffmark :: LicenseId
-- | DOC, DOC License
DOC :: LicenseId
-- | Dotseqn, Dotseqn License
Dotseqn :: LicenseId
-- | DSDP, DSDP License
DSDP :: LicenseId
-- | dvipdfm, dvipdfm License
Dvipdfm :: LicenseId
-- | ECL-1.0, Educational Community License v1.0
ECL_1_0 :: LicenseId
-- | ECL-2.0, Educational Community License v2.0
ECL_2_0 :: LicenseId
-- | EFL-1.0, Eiffel Forum License v1.0
EFL_1_0 :: LicenseId
-- | EFL-2.0, Eiffel Forum License v2.0
EFL_2_0 :: LicenseId
-- | eGenix, eGenix.com Public License 1.1.0
EGenix :: LicenseId
-- | Entessa, Entessa Public License v1.0
Entessa :: LicenseId
-- | EPICS, EPICS Open License, SPDX License List 3.10
EPICS :: LicenseId
-- | EPL-1.0, Eclipse Public License 1.0
EPL_1_0 :: LicenseId
-- | EPL-2.0, Eclipse Public License 2.0
EPL_2_0 :: LicenseId
-- | ErlPL-1.1, Erlang Public License v1.1
ErlPL_1_1 :: LicenseId
-- | etalab-2.0, Etalab Open License 2.0, SPDX License List 3.9,
-- SPDX License List 3.10
Etalab_2_0 :: LicenseId
-- | EUDatagrid, EU DataGrid Software License
EUDatagrid :: LicenseId
-- | EUPL-1.0, European Union Public License 1.0
EUPL_1_0 :: LicenseId
-- | EUPL-1.1, European Union Public License 1.1
EUPL_1_1 :: LicenseId
-- | EUPL-1.2, European Union Public License 1.2
EUPL_1_2 :: LicenseId
-- | Eurosym, Eurosym License
Eurosym :: LicenseId
-- | Fair, Fair License
Fair :: LicenseId
-- | Frameworx-1.0, Frameworx Open License 1.0
Frameworx_1_0 :: LicenseId
-- | FreeImage, FreeImage Public License v1.0
FreeImage :: LicenseId
-- | FSFAP, FSF All Permissive License
FSFAP :: LicenseId
-- | FSFULLR, FSF Unlimited License (with License Retention)
FSFULLR :: LicenseId
-- | FSFUL, FSF Unlimited License
FSFUL :: LicenseId
-- | FTL, Freetype Project License
FTL :: LicenseId
-- | GFDL-1.1-invariants-only, GNU Free Documentation License v1.1
-- only - invariants, SPDX License List 3.10
GFDL_1_1_invariants_only :: LicenseId
-- | GFDL-1.1-invariants-or-later, GNU Free Documentation License
-- v1.1 or later - invariants, SPDX License List 3.10
GFDL_1_1_invariants_or_later :: LicenseId
-- | GFDL-1.1-no-invariants-only, GNU Free Documentation License
-- v1.1 only - no invariants, SPDX License List 3.10
GFDL_1_1_no_invariants_only :: LicenseId
-- | GFDL-1.1-no-invariants-or-later, GNU Free Documentation
-- License v1.1 or later - no invariants, SPDX License List 3.10
GFDL_1_1_no_invariants_or_later :: LicenseId
-- | GFDL-1.1-only, GNU Free Documentation License v1.1 only
GFDL_1_1_only :: LicenseId
-- | GFDL-1.1-or-later, GNU Free Documentation License v1.1 or
-- later
GFDL_1_1_or_later :: LicenseId
-- | GFDL-1.2-invariants-only, GNU Free Documentation License v1.2
-- only - invariants, SPDX License List 3.10
GFDL_1_2_invariants_only :: LicenseId
-- | GFDL-1.2-invariants-or-later, GNU Free Documentation License
-- v1.2 or later - invariants, SPDX License List 3.10
GFDL_1_2_invariants_or_later :: LicenseId
-- | GFDL-1.2-no-invariants-only, GNU Free Documentation License
-- v1.2 only - no invariants, SPDX License List 3.10
GFDL_1_2_no_invariants_only :: LicenseId
-- | GFDL-1.2-no-invariants-or-later, GNU Free Documentation
-- License v1.2 or later - no invariants, SPDX License List 3.10
GFDL_1_2_no_invariants_or_later :: LicenseId
-- | GFDL-1.2-only, GNU Free Documentation License v1.2 only
GFDL_1_2_only :: LicenseId
-- | GFDL-1.2-or-later, GNU Free Documentation License v1.2 or
-- later
GFDL_1_2_or_later :: LicenseId
-- | GFDL-1.3-invariants-only, GNU Free Documentation License v1.3
-- only - invariants, SPDX License List 3.10
GFDL_1_3_invariants_only :: LicenseId
-- | GFDL-1.3-invariants-or-later, GNU Free Documentation License
-- v1.3 or later - invariants, SPDX License List 3.10
GFDL_1_3_invariants_or_later :: LicenseId
-- | GFDL-1.3-no-invariants-only, GNU Free Documentation License
-- v1.3 only - no invariants, SPDX License List 3.10
GFDL_1_3_no_invariants_only :: LicenseId
-- | GFDL-1.3-no-invariants-or-later, GNU Free Documentation
-- License v1.3 or later - no invariants, SPDX License List 3.10
GFDL_1_3_no_invariants_or_later :: LicenseId
-- | GFDL-1.3-only, GNU Free Documentation License v1.3 only
GFDL_1_3_only :: LicenseId
-- | GFDL-1.3-or-later, GNU Free Documentation License v1.3 or
-- later
GFDL_1_3_or_later :: LicenseId
-- | Giftware, Giftware License
Giftware :: LicenseId
-- | GL2PS, GL2PS License
GL2PS :: LicenseId
-- | Glide, 3dfx Glide License
Glide :: LicenseId
-- | Glulxe, Glulxe License
Glulxe :: LicenseId
-- | GLWTPL, Good Luck With That Public License, SPDX License List
-- 3.10
GLWTPL :: LicenseId
-- | gnuplot, gnuplot License
Gnuplot :: LicenseId
-- | GPL-1.0-only, GNU General Public License v1.0 only
GPL_1_0_only :: LicenseId
-- | GPL-1.0-or-later, GNU General Public License v1.0 or later
GPL_1_0_or_later :: LicenseId
-- | GPL-2.0-only, GNU General Public License v2.0 only
GPL_2_0_only :: LicenseId
-- | GPL-2.0-or-later, GNU General Public License v2.0 or later
GPL_2_0_or_later :: LicenseId
-- | GPL-3.0-only, GNU General Public License v3.0 only
GPL_3_0_only :: LicenseId
-- | GPL-3.0-or-later, GNU General Public License v3.0 or later
GPL_3_0_or_later :: LicenseId
-- | gSOAP-1.3b, gSOAP Public License v1.3b
GSOAP_1_3b :: LicenseId
-- | HaskellReport, Haskell Language Report License
HaskellReport :: LicenseId
-- | Hippocratic-2.1, Hippocratic License 2.1, SPDX License List
-- 3.9, SPDX License List 3.10
Hippocratic_2_1 :: LicenseId
-- | HPND-sell-variant, Historical Permission Notice and
-- Disclaimer - sell variant, SPDX License List 3.6, SPDX License List
-- 3.9, SPDX License List 3.10
HPND_sell_variant :: LicenseId
-- | HPND, Historical Permission Notice and Disclaimer
HPND :: LicenseId
-- | IBM-pibs, IBM PowerPC Initialization and Boot Software
IBM_pibs :: LicenseId
-- | ICU, ICU License
ICU :: LicenseId
-- | IJG, Independent JPEG Group License
IJG :: LicenseId
-- | ImageMagick, ImageMagick License
ImageMagick :: LicenseId
-- | iMatix, iMatix Standard Function Library Agreement
IMatix :: LicenseId
-- | Imlib2, Imlib2 License
Imlib2 :: LicenseId
-- | Info-ZIP, Info-ZIP License
Info_ZIP :: LicenseId
-- | Intel-ACPI, Intel ACPI Software License Agreement
Intel_ACPI :: LicenseId
-- | Intel, Intel Open Source License
Intel :: LicenseId
-- | Interbase-1.0, Interbase Public License v1.0
Interbase_1_0 :: LicenseId
-- | IPA, IPA Font License
IPA :: LicenseId
-- | IPL-1.0, IBM Public License v1.0
IPL_1_0 :: LicenseId
-- | ISC, ISC License
ISC :: LicenseId
-- | JasPer-2.0, JasPer License
JasPer_2_0 :: LicenseId
-- | JPNIC, Japan Network Information Center License, SPDX License
-- List 3.6, SPDX License List 3.9, SPDX License List 3.10
JPNIC :: LicenseId
-- | JSON, JSON License
JSON :: LicenseId
-- | LAL-1.2, Licence Art Libre 1.2
LAL_1_2 :: LicenseId
-- | LAL-1.3, Licence Art Libre 1.3
LAL_1_3 :: LicenseId
-- | Latex2e, Latex2e License
Latex2e :: LicenseId
-- | Leptonica, Leptonica License
Leptonica :: LicenseId
-- | LGPL-2.0-only, GNU Library General Public License v2 only
LGPL_2_0_only :: LicenseId
-- | LGPL-2.0-or-later, GNU Library General Public License v2 or
-- later
LGPL_2_0_or_later :: LicenseId
-- | LGPL-2.1-only, GNU Lesser General Public License v2.1 only
LGPL_2_1_only :: LicenseId
-- | LGPL-2.1-or-later, GNU Lesser General Public License v2.1 or
-- later
LGPL_2_1_or_later :: LicenseId
-- | LGPL-3.0-only, GNU Lesser General Public License v3.0 only
LGPL_3_0_only :: LicenseId
-- | LGPL-3.0-or-later, GNU Lesser General Public License v3.0 or
-- later
LGPL_3_0_or_later :: LicenseId
-- | LGPLLR, Lesser General Public License For Linguistic
-- Resources
LGPLLR :: LicenseId
-- | libpng-2.0, PNG Reference Library version 2, SPDX License
-- List 3.6, SPDX License List 3.9, SPDX License List 3.10
Libpng_2_0 :: LicenseId
-- | Libpng, libpng License
Libpng :: LicenseId
-- | libselinux-1.0, libselinux public domain notice, SPDX License
-- List 3.9, SPDX License List 3.10
Libselinux_1_0 :: LicenseId
-- | libtiff, libtiff License
Libtiff :: LicenseId
-- | LiLiQ-P-1.1, Licence Libre du Québec – Permissive version 1.1
LiLiQ_P_1_1 :: LicenseId
-- | LiLiQ-R-1.1, Licence Libre du Québec – Réciprocité version
-- 1.1
LiLiQ_R_1_1 :: LicenseId
-- | LiLiQ-Rplus-1.1, Licence Libre du Québec – Réciprocité forte
-- version 1.1
LiLiQ_Rplus_1_1 :: LicenseId
-- | Linux-OpenIB, Linux Kernel Variant of OpenIB.org license,
-- SPDX License List 3.2, SPDX License List 3.6, SPDX License List 3.9,
-- SPDX License List 3.10
Linux_OpenIB :: LicenseId
-- | LPL-1.02, Lucent Public License v1.02
LPL_1_02 :: LicenseId
-- | LPL-1.0, Lucent Public License Version 1.0
LPL_1_0 :: LicenseId
-- | LPPL-1.0, LaTeX Project Public License v1.0
LPPL_1_0 :: LicenseId
-- | LPPL-1.1, LaTeX Project Public License v1.1
LPPL_1_1 :: LicenseId
-- | LPPL-1.2, LaTeX Project Public License v1.2
LPPL_1_2 :: LicenseId
-- | LPPL-1.3a, LaTeX Project Public License v1.3a
LPPL_1_3a :: LicenseId
-- | LPPL-1.3c, LaTeX Project Public License v1.3c
LPPL_1_3c :: LicenseId
-- | MakeIndex, MakeIndex License
MakeIndex :: LicenseId
-- | MirOS, The MirOS Licence
MirOS :: LicenseId
-- | MIT-0, MIT No Attribution, SPDX License List 3.2, SPDX
-- License List 3.6, SPDX License List 3.9, SPDX License List 3.10
MIT_0 :: LicenseId
-- | MIT-advertising, Enlightenment License (e16)
MIT_advertising :: LicenseId
-- | MIT-CMU, CMU License
MIT_CMU :: LicenseId
-- | MIT-enna, enna License
MIT_enna :: LicenseId
-- | MIT-feh, feh License
MIT_feh :: LicenseId
-- | MITNFA, MIT +no-false-attribs license
MITNFA :: LicenseId
-- | MIT, MIT License
MIT :: LicenseId
-- | Motosoto, Motosoto License
Motosoto :: LicenseId
-- | mpich2, mpich2 License
Mpich2 :: LicenseId
-- | MPL-1.0, Mozilla Public License 1.0
MPL_1_0 :: LicenseId
-- | MPL-1.1, Mozilla Public License 1.1
MPL_1_1 :: LicenseId
-- | MPL-2.0-no-copyleft-exception, Mozilla Public License 2.0 (no
-- copyleft exception)
MPL_2_0_no_copyleft_exception :: LicenseId
-- | MPL-2.0, Mozilla Public License 2.0
MPL_2_0 :: LicenseId
-- | MS-PL, Microsoft Public License
MS_PL :: LicenseId
-- | MS-RL, Microsoft Reciprocal License
MS_RL :: LicenseId
-- | MTLL, Matrix Template Library License
MTLL :: LicenseId
-- | MulanPSL-1.0, Mulan Permissive Software License, Version 1,
-- SPDX License List 3.9, SPDX License List 3.10
MulanPSL_1_0 :: LicenseId
-- | MulanPSL-2.0, Mulan Permissive Software License, Version 2,
-- SPDX License List 3.9, SPDX License List 3.10
MulanPSL_2_0 :: LicenseId
-- | Multics, Multics License
Multics :: LicenseId
-- | Mup, Mup License
Mup :: LicenseId
-- | NASA-1.3, NASA Open Source Agreement 1.3
NASA_1_3 :: LicenseId
-- | Naumen, Naumen Public License
Naumen :: LicenseId
-- | NBPL-1.0, Net Boolean Public License v1
NBPL_1_0 :: LicenseId
-- | NCGL-UK-2.0, Non-Commercial Government Licence, SPDX License
-- List 3.9, SPDX License List 3.10
NCGL_UK_2_0 :: LicenseId
-- | NCSA, University of Illinois/NCSA Open Source License
NCSA :: LicenseId
-- | Net-SNMP, Net-SNMP License
Net_SNMP :: LicenseId
-- | NetCDF, NetCDF license
NetCDF :: LicenseId
-- | Newsletr, Newsletr License
Newsletr :: LicenseId
-- | NGPL, Nethack General Public License
NGPL :: LicenseId
-- | NIST-PD-fallback, NIST Public Domain Notice with license
-- fallback, SPDX License List 3.10
NIST_PD_fallback :: LicenseId
-- | NIST-PD, NIST Public Domain Notice, SPDX License List 3.10
NIST_PD :: LicenseId
-- | NLOD-1.0, Norwegian Licence for Open Government Data
NLOD_1_0 :: LicenseId
-- | NLPL, No Limit Public License
NLPL :: LicenseId
-- | Nokia, Nokia Open Source License
Nokia :: LicenseId
-- | NOSL, Netizen Open Source License
NOSL :: LicenseId
-- | Noweb, Noweb License
Noweb :: LicenseId
-- | NPL-1.0, Netscape Public License v1.0
NPL_1_0 :: LicenseId
-- | NPL-1.1, Netscape Public License v1.1
NPL_1_1 :: LicenseId
-- | NPOSL-3.0, Non-Profit Open Software License 3.0
NPOSL_3_0 :: LicenseId
-- | NRL, NRL License
NRL :: LicenseId
-- | NTP-0, NTP No Attribution, SPDX License List 3.9, SPDX
-- License List 3.10
NTP_0 :: LicenseId
-- | NTP, NTP License
NTP :: LicenseId
-- | O-UDA-1.0, Open Use of Data Agreement v1.0, SPDX License List
-- 3.9, SPDX License List 3.10
O_UDA_1_0 :: LicenseId
-- | OCCT-PL, Open CASCADE Technology Public License
OCCT_PL :: LicenseId
-- | OCLC-2.0, OCLC Research Public License 2.0
OCLC_2_0 :: LicenseId
-- | ODbL-1.0, ODC Open Database License v1.0
ODbL_1_0 :: LicenseId
-- | ODC-By-1.0, Open Data Commons Attribution License v1.0, SPDX
-- License List 3.2, SPDX License List 3.6, SPDX License List 3.9, SPDX
-- License List 3.10
ODC_By_1_0 :: LicenseId
-- | OFL-1.0-no-RFN, SIL Open Font License 1.0 with no Reserved
-- Font Name, SPDX License List 3.9, SPDX License List 3.10
OFL_1_0_no_RFN :: LicenseId
-- | OFL-1.0-RFN, SIL Open Font License 1.0 with Reserved Font
-- Name, SPDX License List 3.9, SPDX License List 3.10
OFL_1_0_RFN :: LicenseId
-- | OFL-1.0, SIL Open Font License 1.0
OFL_1_0 :: LicenseId
-- | OFL-1.1-no-RFN, SIL Open Font License 1.1 with no Reserved
-- Font Name, SPDX License List 3.9, SPDX License List 3.10
OFL_1_1_no_RFN :: LicenseId
-- | OFL-1.1-RFN, SIL Open Font License 1.1 with Reserved Font
-- Name, SPDX License List 3.9, SPDX License List 3.10
OFL_1_1_RFN :: LicenseId
-- | OFL-1.1, SIL Open Font License 1.1
OFL_1_1 :: LicenseId
-- | OGC-1.0, OGC Software License, Version 1.0, SPDX License List
-- 3.9, SPDX License List 3.10
OGC_1_0 :: LicenseId
-- | OGL-Canada-2.0, Open Government Licence - Canada, SPDX
-- License List 3.9, SPDX License List 3.10
OGL_Canada_2_0 :: LicenseId
-- | OGL-UK-1.0, Open Government Licence v1.0, SPDX License List
-- 3.6, SPDX License List 3.9, SPDX License List 3.10
OGL_UK_1_0 :: LicenseId
-- | OGL-UK-2.0, Open Government Licence v2.0, SPDX License List
-- 3.6, SPDX License List 3.9, SPDX License List 3.10
OGL_UK_2_0 :: LicenseId
-- | OGL-UK-3.0, Open Government Licence v3.0, SPDX License List
-- 3.6, SPDX License List 3.9, SPDX License List 3.10
OGL_UK_3_0 :: LicenseId
-- | OGTSL, Open Group Test Suite License
OGTSL :: LicenseId
-- | OLDAP-1.1, Open LDAP Public License v1.1
OLDAP_1_1 :: LicenseId
-- | OLDAP-1.2, Open LDAP Public License v1.2
OLDAP_1_2 :: LicenseId
-- | OLDAP-1.3, Open LDAP Public License v1.3
OLDAP_1_3 :: LicenseId
-- | OLDAP-1.4, Open LDAP Public License v1.4
OLDAP_1_4 :: LicenseId
-- | OLDAP-2.0.1, Open LDAP Public License v2.0.1
OLDAP_2_0_1 :: LicenseId
-- | OLDAP-2.0, Open LDAP Public License v2.0 (or possibly 2.0A
-- and 2.0B)
OLDAP_2_0 :: LicenseId
-- | OLDAP-2.1, Open LDAP Public License v2.1
OLDAP_2_1 :: LicenseId
-- | OLDAP-2.2.1, Open LDAP Public License v2.2.1
OLDAP_2_2_1 :: LicenseId
-- | OLDAP-2.2.2, Open LDAP Public License 2.2.2
OLDAP_2_2_2 :: LicenseId
-- | OLDAP-2.2, Open LDAP Public License v2.2
OLDAP_2_2 :: LicenseId
-- | OLDAP-2.3, Open LDAP Public License v2.3
OLDAP_2_3 :: LicenseId
-- | OLDAP-2.4, Open LDAP Public License v2.4
OLDAP_2_4 :: LicenseId
-- | OLDAP-2.5, Open LDAP Public License v2.5
OLDAP_2_5 :: LicenseId
-- | OLDAP-2.6, Open LDAP Public License v2.6
OLDAP_2_6 :: LicenseId
-- | OLDAP-2.7, Open LDAP Public License v2.7
OLDAP_2_7 :: LicenseId
-- | OLDAP-2.8, Open LDAP Public License v2.8
OLDAP_2_8 :: LicenseId
-- | OML, Open Market License
OML :: LicenseId
-- | OpenSSL, OpenSSL License
OpenSSL :: LicenseId
-- | OPL-1.0, Open Public License v1.0
OPL_1_0 :: LicenseId
-- | OSET-PL-2.1, OSET Public License version 2.1
OSET_PL_2_1 :: LicenseId
-- | OSL-1.0, Open Software License 1.0
OSL_1_0 :: LicenseId
-- | OSL-1.1, Open Software License 1.1
OSL_1_1 :: LicenseId
-- | OSL-2.0, Open Software License 2.0
OSL_2_0 :: LicenseId
-- | OSL-2.1, Open Software License 2.1
OSL_2_1 :: LicenseId
-- | OSL-3.0, Open Software License 3.0
OSL_3_0 :: LicenseId
-- | Parity-6.0.0, The Parity Public License 6.0.0, SPDX License
-- List 3.6, SPDX License List 3.9, SPDX License List 3.10
Parity_6_0_0 :: LicenseId
-- | Parity-7.0.0, The Parity Public License 7.0.0, SPDX License
-- List 3.9, SPDX License List 3.10
Parity_7_0_0 :: LicenseId
-- | PDDL-1.0, ODC Public Domain Dedication & License 1.0
PDDL_1_0 :: LicenseId
-- | PHP-3.01, PHP License v3.01
PHP_3_01 :: LicenseId
-- | PHP-3.0, PHP License v3.0
PHP_3_0 :: LicenseId
-- | Plexus, Plexus Classworlds License
Plexus :: LicenseId
-- | PolyForm-Noncommercial-1.0.0, PolyForm Noncommercial License
-- 1.0.0, SPDX License List 3.9, SPDX License List 3.10
PolyForm_Noncommercial_1_0_0 :: LicenseId
-- | PolyForm-Small-Business-1.0.0, PolyForm Small Business
-- License 1.0.0, SPDX License List 3.9, SPDX License List 3.10
PolyForm_Small_Business_1_0_0 :: LicenseId
-- | PostgreSQL, PostgreSQL License
PostgreSQL :: LicenseId
-- | PSF-2.0, Python Software Foundation License 2.0, SPDX License
-- List 3.9, SPDX License List 3.10
PSF_2_0 :: LicenseId
-- | psfrag, psfrag License
Psfrag :: LicenseId
-- | psutils, psutils License
Psutils :: LicenseId
-- | Python-2.0, Python License 2.0
Python_2_0 :: LicenseId
-- | Qhull, Qhull License
Qhull :: LicenseId
-- | QPL-1.0, Q Public License 1.0
QPL_1_0 :: LicenseId
-- | Rdisc, Rdisc License
Rdisc :: LicenseId
-- | RHeCos-1.1, Red Hat eCos Public License v1.1
RHeCos_1_1 :: LicenseId
-- | RPL-1.1, Reciprocal Public License 1.1
RPL_1_1 :: LicenseId
-- | RPL-1.5, Reciprocal Public License 1.5
RPL_1_5 :: LicenseId
-- | RPSL-1.0, RealNetworks Public Source License v1.0
RPSL_1_0 :: LicenseId
-- | RSA-MD, RSA Message-Digest License
RSA_MD :: LicenseId
-- | RSCPL, Ricoh Source Code Public License
RSCPL :: LicenseId
-- | Ruby, Ruby License
Ruby :: LicenseId
-- | SAX-PD, Sax Public Domain Notice
SAX_PD :: LicenseId
-- | Saxpath, Saxpath License
Saxpath :: LicenseId
-- | SCEA, SCEA Shared Source License
SCEA :: LicenseId
-- | Sendmail-8.23, Sendmail License 8.23, SPDX License List 3.6,
-- SPDX License List 3.9, SPDX License List 3.10
Sendmail_8_23 :: LicenseId
-- | Sendmail, Sendmail License
Sendmail :: LicenseId
-- | SGI-B-1.0, SGI Free Software License B v1.0
SGI_B_1_0 :: LicenseId
-- | SGI-B-1.1, SGI Free Software License B v1.1
SGI_B_1_1 :: LicenseId
-- | SGI-B-2.0, SGI Free Software License B v2.0
SGI_B_2_0 :: LicenseId
-- | SHL-0.51, Solderpad Hardware License, Version 0.51, SPDX
-- License List 3.6, SPDX License List 3.9, SPDX License List 3.10
SHL_0_51 :: LicenseId
-- | SHL-0.5, Solderpad Hardware License v0.5, SPDX License List
-- 3.6, SPDX License List 3.9, SPDX License List 3.10
SHL_0_5 :: LicenseId
-- | SimPL-2.0, Simple Public License 2.0
SimPL_2_0 :: LicenseId
-- | SISSL-1.2, Sun Industry Standards Source License v1.2
SISSL_1_2 :: LicenseId
-- | SISSL, Sun Industry Standards Source License v1.1
SISSL :: LicenseId
-- | Sleepycat, Sleepycat License
Sleepycat :: LicenseId
-- | SMLNJ, Standard ML of New Jersey License
SMLNJ :: LicenseId
-- | SMPPL, Secure Messaging Protocol Public License
SMPPL :: LicenseId
-- | SNIA, SNIA Public License 1.1
SNIA :: LicenseId
-- | Spencer-86, Spencer License 86
Spencer_86 :: LicenseId
-- | Spencer-94, Spencer License 94
Spencer_94 :: LicenseId
-- | Spencer-99, Spencer License 99
Spencer_99 :: LicenseId
-- | SPL-1.0, Sun Public License v1.0
SPL_1_0 :: LicenseId
-- | SSH-OpenSSH, SSH OpenSSH license, SPDX License List 3.9, SPDX
-- License List 3.10
SSH_OpenSSH :: LicenseId
-- | SSH-short, SSH short notice, SPDX License List 3.9, SPDX
-- License List 3.10
SSH_short :: LicenseId
-- | SSPL-1.0, Server Side Public License, v 1, SPDX License List
-- 3.6, SPDX License List 3.9, SPDX License List 3.10
SSPL_1_0 :: LicenseId
-- | SugarCRM-1.1.3, SugarCRM Public License v1.1.3
SugarCRM_1_1_3 :: LicenseId
-- | SWL, Scheme Widget Library (SWL) Software License Agreement
SWL :: LicenseId
-- | TAPR-OHL-1.0, TAPR Open Hardware License v1.0, SPDX License
-- List 3.6, SPDX License List 3.9, SPDX License List 3.10
TAPR_OHL_1_0 :: LicenseId
-- | TCL, TCL/TK License
TCL :: LicenseId
-- | TCP-wrappers, TCP Wrappers License
TCP_wrappers :: LicenseId
-- | TMate, TMate Open Source License
TMate :: LicenseId
-- | TORQUE-1.1, TORQUE v2.5+ Software License v1.1
TORQUE_1_1 :: LicenseId
-- | TOSL, Trusster Open Source License
TOSL :: LicenseId
-- | TU-Berlin-1.0, Technische Universitaet Berlin License 1.0,
-- SPDX License List 3.2, SPDX License List 3.6, SPDX License List 3.9,
-- SPDX License List 3.10
TU_Berlin_1_0 :: LicenseId
-- | TU-Berlin-2.0, Technische Universitaet Berlin License 2.0,
-- SPDX License List 3.2, SPDX License List 3.6, SPDX License List 3.9,
-- SPDX License List 3.10
TU_Berlin_2_0 :: LicenseId
-- | UCL-1.0, Upstream Compatibility License v1.0, SPDX License
-- List 3.9, SPDX License List 3.10
UCL_1_0 :: LicenseId
-- | Unicode-DFS-2015, Unicode License Agreement - Data Files and
-- Software (2015)
Unicode_DFS_2015 :: LicenseId
-- | Unicode-DFS-2016, Unicode License Agreement - Data Files and
-- Software (2016)
Unicode_DFS_2016 :: LicenseId
-- | Unicode-TOU, Unicode Terms of Use
Unicode_TOU :: LicenseId
-- | Unlicense, The Unlicense
Unlicense :: LicenseId
-- | UPL-1.0, Universal Permissive License v1.0
UPL_1_0 :: LicenseId
-- | Vim, Vim License
Vim :: LicenseId
-- | VOSTROM, VOSTROM Public License for Open Source
VOSTROM :: LicenseId
-- | VSL-1.0, Vovida Software License v1.0
VSL_1_0 :: LicenseId
-- | W3C-19980720, W3C Software Notice and License (1998-07-20)
W3C_19980720 :: LicenseId
-- | W3C-20150513, W3C Software Notice and Document License
-- (2015-05-13)
W3C_20150513 :: LicenseId
-- | W3C, W3C Software Notice and License (2002-12-31)
W3C :: LicenseId
-- | Watcom-1.0, Sybase Open Watcom Public License 1.0
Watcom_1_0 :: LicenseId
-- | Wsuipa, Wsuipa License
Wsuipa :: LicenseId
-- | WTFPL, Do What The F*ck You Want To Public License
WTFPL :: LicenseId
-- | X11, X11 License
X11 :: LicenseId
-- | Xerox, Xerox License
Xerox :: LicenseId
-- | XFree86-1.1, XFree86 License 1.1
XFree86_1_1 :: LicenseId
-- | xinetd, xinetd License
Xinetd :: LicenseId
-- | Xnet, X.Net License
Xnet :: LicenseId
-- | xpp, XPP License
Xpp :: LicenseId
-- | XSkat, XSkat License
XSkat :: LicenseId
-- | YPL-1.0, Yahoo! Public License v1.0
YPL_1_0 :: LicenseId
-- | YPL-1.1, Yahoo! Public License v1.1
YPL_1_1 :: LicenseId
-- | Zed, Zed License
Zed :: LicenseId
-- | Zend-2.0, Zend License v2.0
Zend_2_0 :: LicenseId
-- | Zimbra-1.3, Zimbra Public License v1.3
Zimbra_1_3 :: LicenseId
-- | Zimbra-1.4, Zimbra Public License v1.4
Zimbra_1_4 :: LicenseId
-- | zlib-acknowledgement, zlib/libpng License with
-- Acknowledgement
Zlib_acknowledgement :: LicenseId
-- | Zlib, zlib License
Zlib :: LicenseId
-- | ZPL-1.1, Zope Public License 1.1
ZPL_1_1 :: LicenseId
-- | ZPL-2.0, Zope Public License 2.0
ZPL_2_0 :: LicenseId
-- | ZPL-2.1, Zope Public License 2.1
ZPL_2_1 :: LicenseId
-- | License SPDX identifier, e.g. "BSD-3-Clause".
licenseId :: LicenseId -> String
-- | License name, e.g. "GNU General Public License v2.0 only"
licenseName :: LicenseId -> String
-- | Whether the license is approved by Open Source Initiative (OSI).
--
-- See https://opensource.org/licenses/alphabetical.
licenseIsOsiApproved :: LicenseId -> Bool
-- | Whether the license is considered libre by Free Software Foundation
-- (FSF).
--
-- See https://www.gnu.org/licenses/license-list.en.html
licenseIsFsfLibre :: LicenseId -> Bool
-- | Create a LicenseId from a String.
mkLicenseId :: LicenseListVersion -> String -> Maybe LicenseId
licenseIdList :: LicenseListVersion -> [LicenseId]
-- | Help message for migrating from non-SPDX license identifiers.
--
-- Old License is almost SPDX, except for BSD2,
-- BSD3. This function suggests SPDX variant:
--
--
-- >>> licenseIdMigrationMessage "BSD3"
-- "Do you mean BSD-3-Clause?"
--
--
-- Also OtherLicense, AllRightsReserved, and
-- PublicDomain aren't valid SPDX identifiers
--
--
-- >>> traverse_ (print . licenseIdMigrationMessage) [ "OtherLicense", "AllRightsReserved", "PublicDomain" ]
-- "SPDX license list contains plenty of licenses. See https://spdx.org/licenses/. Also they can be combined into complex expressions with AND and OR."
-- "You can use NONE as a value of license field."
-- "Public Domain is a complex matter. See https://wiki.spdx.org/view/Legal_Team/Decisions/Dealing_with_Public_Domain_within_SPDX_Files. Consider using a proper license."
--
--
-- SPDX License list version 3.0 introduced "-only" and "-or-later"
-- variants for GNU family of licenses. See
-- https://spdx.org/news/news/2018/01/license-list-30-released
-- >>> licenseIdMigrationMessage "GPL-2.0" "SPDX license list
-- 3.0 deprecated suffixless variants of GNU family of licenses. Use
-- GPL-2.0-only or GPL-2.0-or-later."
--
-- For other common licenses their old license format coincides with the
-- SPDX identifiers:
--
--
-- >>> traverse eitherParsec ["GPL-2.0-only", "GPL-3.0-only", "LGPL-2.1-only", "MIT", "ISC", "MPL-2.0", "Apache-2.0"] :: Either String [LicenseId]
-- Right [GPL_2_0_only,GPL_3_0_only,LGPL_2_1_only,MIT,ISC,MPL_2_0,Apache_2_0]
--
licenseIdMigrationMessage :: String -> String
instance GHC.Generics.Generic Distribution.SPDX.LicenseId.LicenseId
instance Data.Data.Data Distribution.SPDX.LicenseId.LicenseId
instance GHC.Read.Read Distribution.SPDX.LicenseId.LicenseId
instance GHC.Show.Show Distribution.SPDX.LicenseId.LicenseId
instance GHC.Enum.Bounded Distribution.SPDX.LicenseId.LicenseId
instance GHC.Enum.Enum Distribution.SPDX.LicenseId.LicenseId
instance GHC.Classes.Ord Distribution.SPDX.LicenseId.LicenseId
instance GHC.Classes.Eq Distribution.SPDX.LicenseId.LicenseId
instance Data.Binary.Class.Binary Distribution.SPDX.LicenseId.LicenseId
instance Distribution.Utils.Structured.Structured Distribution.SPDX.LicenseId.LicenseId
instance Distribution.Pretty.Pretty Distribution.SPDX.LicenseId.LicenseId
instance Distribution.Parsec.Parsec Distribution.SPDX.LicenseId.LicenseId
instance Control.DeepSeq.NFData Distribution.SPDX.LicenseId.LicenseId
module Distribution.SPDX.LicenseExceptionId
-- | SPDX License identifier
data LicenseExceptionId
-- | 389-exception, 389 Directory Server Exception
DS389_exception :: LicenseExceptionId
-- | Autoconf-exception-2.0, Autoconf exception 2.0
Autoconf_exception_2_0 :: LicenseExceptionId
-- | Autoconf-exception-3.0, Autoconf exception 3.0
Autoconf_exception_3_0 :: LicenseExceptionId
-- | Bison-exception-2.2, Bison exception 2.2
Bison_exception_2_2 :: LicenseExceptionId
-- | Bootloader-exception, Bootloader Distribution Exception
Bootloader_exception :: LicenseExceptionId
-- | Classpath-exception-2.0, Classpath exception 2.0
Classpath_exception_2_0 :: LicenseExceptionId
-- | CLISP-exception-2.0, CLISP exception 2.0
CLISP_exception_2_0 :: LicenseExceptionId
-- | DigiRule-FOSS-exception, DigiRule FOSS License Exception
DigiRule_FOSS_exception :: LicenseExceptionId
-- | eCos-exception-2.0, eCos exception 2.0
ECos_exception_2_0 :: LicenseExceptionId
-- | Fawkes-Runtime-exception, Fawkes Runtime Exception
Fawkes_Runtime_exception :: LicenseExceptionId
-- | FLTK-exception, FLTK exception
FLTK_exception :: LicenseExceptionId
-- | Font-exception-2.0, Font exception 2.0
Font_exception_2_0 :: LicenseExceptionId
-- | freertos-exception-2.0, FreeRTOS Exception 2.0
Freertos_exception_2_0 :: LicenseExceptionId
-- | GCC-exception-2.0, GCC Runtime Library exception 2.0
GCC_exception_2_0 :: LicenseExceptionId
-- | GCC-exception-3.1, GCC Runtime Library exception 3.1
GCC_exception_3_1 :: LicenseExceptionId
-- | gnu-javamail-exception, GNU JavaMail exception
Gnu_javamail_exception :: LicenseExceptionId
-- | GPL-3.0-linking-exception, GPL-3.0 Linking Exception, SPDX
-- License List 3.9, SPDX License List 3.10
GPL_3_0_linking_exception :: LicenseExceptionId
-- | GPL-3.0-linking-source-exception, GPL-3.0 Linking Exception
-- (with Corresponding Source), SPDX License List 3.9, SPDX License List
-- 3.10
GPL_3_0_linking_source_exception :: LicenseExceptionId
-- | GPL-CC-1.0, GPL Cooperation Commitment 1.0, SPDX License List
-- 3.6, SPDX License List 3.9, SPDX License List 3.10
GPL_CC_1_0 :: LicenseExceptionId
-- | i2p-gpl-java-exception, i2p GPL+Java Exception
I2p_gpl_java_exception :: LicenseExceptionId
-- | LGPL-3.0-linking-exception, LGPL-3.0 Linking Exception, SPDX
-- License List 3.9, SPDX License List 3.10
LGPL_3_0_linking_exception :: LicenseExceptionId
-- | Libtool-exception, Libtool Exception
Libtool_exception :: LicenseExceptionId
-- | Linux-syscall-note, Linux Syscall Note
Linux_syscall_note :: LicenseExceptionId
-- | LLVM-exception, LLVM Exception, SPDX License List 3.2, SPDX
-- License List 3.6, SPDX License List 3.9, SPDX License List 3.10
LLVM_exception :: LicenseExceptionId
-- | LZMA-exception, LZMA exception
LZMA_exception :: LicenseExceptionId
-- | mif-exception, Macros and Inline Functions Exception
Mif_exception :: LicenseExceptionId
-- | Nokia-Qt-exception-1.1, Nokia Qt LGPL exception 1.1, SPDX
-- License List 3.0, SPDX License List 3.2
Nokia_Qt_exception_1_1 :: LicenseExceptionId
-- | OCaml-LGPL-linking-exception, OCaml LGPL Linking Exception,
-- SPDX License List 3.6, SPDX License List 3.9, SPDX License List 3.10
OCaml_LGPL_linking_exception :: LicenseExceptionId
-- | OCCT-exception-1.0, Open CASCADE Exception 1.0
OCCT_exception_1_0 :: LicenseExceptionId
-- | OpenJDK-assembly-exception-1.0, OpenJDK Assembly exception
-- 1.0, SPDX License List 3.2, SPDX License List 3.6, SPDX License List
-- 3.9, SPDX License List 3.10
OpenJDK_assembly_exception_1_0 :: LicenseExceptionId
-- | openvpn-openssl-exception, OpenVPN OpenSSL Exception
Openvpn_openssl_exception :: LicenseExceptionId
-- | PS-or-PDF-font-exception-20170817, PS/PDF font exception
-- (2017-08-17), SPDX License List 3.2, SPDX License List 3.6, SPDX
-- License List 3.9, SPDX License List 3.10
PS_or_PDF_font_exception_20170817 :: LicenseExceptionId
-- | Qt-GPL-exception-1.0, Qt GPL exception 1.0, SPDX License List
-- 3.2, SPDX License List 3.6, SPDX License List 3.9, SPDX License List
-- 3.10
Qt_GPL_exception_1_0 :: LicenseExceptionId
-- | Qt-LGPL-exception-1.1, Qt LGPL exception 1.1, SPDX License
-- List 3.2, SPDX License List 3.6, SPDX License List 3.9, SPDX License
-- List 3.10
Qt_LGPL_exception_1_1 :: LicenseExceptionId
-- | Qwt-exception-1.0, Qwt exception 1.0
Qwt_exception_1_0 :: LicenseExceptionId
-- | SHL-2.0, Solderpad Hardware License v2.0, SPDX License List
-- 3.9, SPDX License List 3.10
SHL_2_0 :: LicenseExceptionId
-- | SHL-2.1, Solderpad Hardware License v2.1, SPDX License List
-- 3.9, SPDX License List 3.10
SHL_2_1 :: LicenseExceptionId
-- | Swift-exception, Swift Exception, SPDX License List 3.6, SPDX
-- License List 3.9, SPDX License List 3.10
Swift_exception :: LicenseExceptionId
-- | u-boot-exception-2.0, U-Boot exception 2.0
U_boot_exception_2_0 :: LicenseExceptionId
-- | Universal-FOSS-exception-1.0, Universal FOSS Exception,
-- Version 1.0, SPDX License List 3.6, SPDX License List 3.9, SPDX
-- License List 3.10
Universal_FOSS_exception_1_0 :: LicenseExceptionId
-- | WxWindows-exception-3.1, WxWindows Library Exception 3.1
WxWindows_exception_3_1 :: LicenseExceptionId
-- | License SPDX identifier, e.g. "BSD-3-Clause".
licenseExceptionId :: LicenseExceptionId -> String
-- | License name, e.g. "GNU General Public License v2.0 only"
licenseExceptionName :: LicenseExceptionId -> String
-- | Create a LicenseExceptionId from a String.
mkLicenseExceptionId :: LicenseListVersion -> String -> Maybe LicenseExceptionId
licenseExceptionIdList :: LicenseListVersion -> [LicenseExceptionId]
instance GHC.Generics.Generic Distribution.SPDX.LicenseExceptionId.LicenseExceptionId
instance Data.Data.Data Distribution.SPDX.LicenseExceptionId.LicenseExceptionId
instance GHC.Read.Read Distribution.SPDX.LicenseExceptionId.LicenseExceptionId
instance GHC.Show.Show Distribution.SPDX.LicenseExceptionId.LicenseExceptionId
instance GHC.Enum.Bounded Distribution.SPDX.LicenseExceptionId.LicenseExceptionId
instance GHC.Enum.Enum Distribution.SPDX.LicenseExceptionId.LicenseExceptionId
instance GHC.Classes.Ord Distribution.SPDX.LicenseExceptionId.LicenseExceptionId
instance GHC.Classes.Eq Distribution.SPDX.LicenseExceptionId.LicenseExceptionId
instance Data.Binary.Class.Binary Distribution.SPDX.LicenseExceptionId.LicenseExceptionId
instance Distribution.Utils.Structured.Structured Distribution.SPDX.LicenseExceptionId.LicenseExceptionId
instance Distribution.Pretty.Pretty Distribution.SPDX.LicenseExceptionId.LicenseExceptionId
instance Distribution.Parsec.Parsec Distribution.SPDX.LicenseExceptionId.LicenseExceptionId
instance Control.DeepSeq.NFData Distribution.SPDX.LicenseExceptionId.LicenseExceptionId
module Distribution.SPDX.LicenseExpression
-- | SPDX License Expression.
--
--
-- idstring = 1*(ALPHA / DIGIT / "-" / "." )
-- license id = <short form license identifier inAppendix I.1>
-- license exception id = <short form license exception identifier inAppendix I.2>
-- license ref = ["DocumentRef-"1*(idstring)":"]"LicenseRef-"1*(idstring)
--
-- simple expression = license id / license id"+" / license ref
--
-- compound expression = 1*1(simple expression /
-- simple expression "WITH" license exception id /
-- compound expression "AND" compound expression /
-- compound expression "OR" compound expression ) /
-- "(" compound expression ")" )
--
-- license expression = 1*1(simple expression / compound expression)
--
data LicenseExpression
ELicense :: !SimpleLicenseExpression -> !Maybe LicenseExceptionId -> LicenseExpression
EAnd :: !LicenseExpression -> !LicenseExpression -> LicenseExpression
EOr :: !LicenseExpression -> !LicenseExpression -> LicenseExpression
-- | Simple License Expressions.
data SimpleLicenseExpression
-- | An SPDX License List Short Form Identifier. For example:
-- GPL-2.0-only
ELicenseId :: LicenseId -> SimpleLicenseExpression
-- | An SPDX License List Short Form Identifier with a unary"+" operator
-- suffix to represent the current version of the license or any later
-- version. For example: GPL-2.0+
ELicenseIdPlus :: LicenseId -> SimpleLicenseExpression
-- | A SPDX user defined license reference: For example:
-- LicenseRef-23, LicenseRef-MIT-Style-1, or
-- DocumentRef-spdx-tool-1.2:LicenseRef-MIT-Style-2
ELicenseRef :: LicenseRef -> SimpleLicenseExpression
simpleLicenseExpression :: LicenseId -> LicenseExpression
instance GHC.Generics.Generic Distribution.SPDX.LicenseExpression.SimpleLicenseExpression
instance Data.Data.Data Distribution.SPDX.LicenseExpression.SimpleLicenseExpression
instance GHC.Classes.Ord Distribution.SPDX.LicenseExpression.SimpleLicenseExpression
instance GHC.Classes.Eq Distribution.SPDX.LicenseExpression.SimpleLicenseExpression
instance GHC.Read.Read Distribution.SPDX.LicenseExpression.SimpleLicenseExpression
instance GHC.Show.Show Distribution.SPDX.LicenseExpression.SimpleLicenseExpression
instance GHC.Generics.Generic Distribution.SPDX.LicenseExpression.LicenseExpression
instance Data.Data.Data Distribution.SPDX.LicenseExpression.LicenseExpression
instance GHC.Classes.Ord Distribution.SPDX.LicenseExpression.LicenseExpression
instance GHC.Classes.Eq Distribution.SPDX.LicenseExpression.LicenseExpression
instance GHC.Read.Read Distribution.SPDX.LicenseExpression.LicenseExpression
instance GHC.Show.Show Distribution.SPDX.LicenseExpression.LicenseExpression
instance Data.Binary.Class.Binary Distribution.SPDX.LicenseExpression.LicenseExpression
instance Distribution.Utils.Structured.Structured Distribution.SPDX.LicenseExpression.LicenseExpression
instance Distribution.Pretty.Pretty Distribution.SPDX.LicenseExpression.LicenseExpression
instance Distribution.Parsec.Parsec Distribution.SPDX.LicenseExpression.LicenseExpression
instance Control.DeepSeq.NFData Distribution.SPDX.LicenseExpression.LicenseExpression
instance Data.Binary.Class.Binary Distribution.SPDX.LicenseExpression.SimpleLicenseExpression
instance Distribution.Utils.Structured.Structured Distribution.SPDX.LicenseExpression.SimpleLicenseExpression
instance Distribution.Pretty.Pretty Distribution.SPDX.LicenseExpression.SimpleLicenseExpression
instance Distribution.Parsec.Parsec Distribution.SPDX.LicenseExpression.SimpleLicenseExpression
instance Control.DeepSeq.NFData Distribution.SPDX.LicenseExpression.SimpleLicenseExpression
module Distribution.SPDX.License
-- | Declared license. See section 3.15 of SPDX Specification 2.1
--
-- Note: the NOASSERTION case is omitted.
--
-- Old License can be migrated using following rules:
--
--
-- - AllRightsReserved and UnspecifiedLicense to
-- NONE. No license specified which legally defaults to All
-- Rights Reserved. The package may not be legally modified or
-- redistributed by anyone but the rightsholder.
-- - OtherLicense can be converted to LicenseRef
-- pointing to the file in the package.
-- - UnknownLicense i.e. other licenses of the form
-- name-x.y, should be covered by SPDX license list, otherwise
-- use LicenseRef.
-- - PublicDomain isn't covered. Consider using CC0. See
-- https://wiki.spdx.org/view/Legal_Team/Decisions/Dealing_with_Public_Domain_within_SPDX_Files
-- for more information.
--
data License
-- | if the package contains no license information whatsoever; or
NONE :: License
-- | A valid SPDX License Expression as defined in Appendix IV.
License :: LicenseExpression -> License
instance GHC.Generics.Generic Distribution.SPDX.License.License
instance Data.Data.Data Distribution.SPDX.License.License
instance GHC.Classes.Ord Distribution.SPDX.License.License
instance GHC.Classes.Eq Distribution.SPDX.License.License
instance GHC.Read.Read Distribution.SPDX.License.License
instance GHC.Show.Show Distribution.SPDX.License.License
instance Data.Binary.Class.Binary Distribution.SPDX.License.License
instance Distribution.Utils.Structured.Structured Distribution.SPDX.License.License
instance Control.DeepSeq.NFData Distribution.SPDX.License.License
instance Distribution.Pretty.Pretty Distribution.SPDX.License.License
instance Distribution.Parsec.Parsec Distribution.SPDX.License.License
-- | This module implements SPDX specification version 2.1 with a version
-- 3.0 license list.
--
-- Specification is available on https://spdx.org/specifications
module Distribution.SPDX
-- | Declared license. See section 3.15 of SPDX Specification 2.1
--
-- Note: the NOASSERTION case is omitted.
--
-- Old License can be migrated using following rules:
--
--
-- - AllRightsReserved and UnspecifiedLicense to
-- NONE. No license specified which legally defaults to All
-- Rights Reserved. The package may not be legally modified or
-- redistributed by anyone but the rightsholder.
-- - OtherLicense can be converted to LicenseRef
-- pointing to the file in the package.
-- - UnknownLicense i.e. other licenses of the form
-- name-x.y, should be covered by SPDX license list, otherwise
-- use LicenseRef.
-- - PublicDomain isn't covered. Consider using CC0. See
-- https://wiki.spdx.org/view/Legal_Team/Decisions/Dealing_with_Public_Domain_within_SPDX_Files
-- for more information.
--
data License
-- | if the package contains no license information whatsoever; or
NONE :: License
-- | A valid SPDX License Expression as defined in Appendix IV.
License :: LicenseExpression -> License
-- | SPDX License Expression.
--
--
-- idstring = 1*(ALPHA / DIGIT / "-" / "." )
-- license id = <short form license identifier inAppendix I.1>
-- license exception id = <short form license exception identifier inAppendix I.2>
-- license ref = ["DocumentRef-"1*(idstring)":"]"LicenseRef-"1*(idstring)
--
-- simple expression = license id / license id"+" / license ref
--
-- compound expression = 1*1(simple expression /
-- simple expression "WITH" license exception id /
-- compound expression "AND" compound expression /
-- compound expression "OR" compound expression ) /
-- "(" compound expression ")" )
--
-- license expression = 1*1(simple expression / compound expression)
--
data LicenseExpression
ELicense :: !SimpleLicenseExpression -> !Maybe LicenseExceptionId -> LicenseExpression
EAnd :: !LicenseExpression -> !LicenseExpression -> LicenseExpression
EOr :: !LicenseExpression -> !LicenseExpression -> LicenseExpression
-- | Simple License Expressions.
data SimpleLicenseExpression
-- | An SPDX License List Short Form Identifier. For example:
-- GPL-2.0-only
ELicenseId :: LicenseId -> SimpleLicenseExpression
-- | An SPDX License List Short Form Identifier with a unary"+" operator
-- suffix to represent the current version of the license or any later
-- version. For example: GPL-2.0+
ELicenseIdPlus :: LicenseId -> SimpleLicenseExpression
-- | A SPDX user defined license reference: For example:
-- LicenseRef-23, LicenseRef-MIT-Style-1, or
-- DocumentRef-spdx-tool-1.2:LicenseRef-MIT-Style-2
ELicenseRef :: LicenseRef -> SimpleLicenseExpression
simpleLicenseExpression :: LicenseId -> LicenseExpression
-- | SPDX License identifier
data LicenseId
-- | 0BSD, BSD Zero Clause License
NullBSD :: LicenseId
-- | AAL, Attribution Assurance License
AAL :: LicenseId
-- | Abstyles, Abstyles License
Abstyles :: LicenseId
-- | Adobe-2006, Adobe Systems Incorporated Source Code License
-- Agreement
Adobe_2006 :: LicenseId
-- | Adobe-Glyph, Adobe Glyph List License
Adobe_Glyph :: LicenseId
-- | ADSL, Amazon Digital Services License
ADSL :: LicenseId
-- | AFL-1.1, Academic Free License v1.1
AFL_1_1 :: LicenseId
-- | AFL-1.2, Academic Free License v1.2
AFL_1_2 :: LicenseId
-- | AFL-2.0, Academic Free License v2.0
AFL_2_0 :: LicenseId
-- | AFL-2.1, Academic Free License v2.1
AFL_2_1 :: LicenseId
-- | AFL-3.0, Academic Free License v3.0
AFL_3_0 :: LicenseId
-- | Afmparse, Afmparse License
Afmparse :: LicenseId
-- | AGPL-1.0, Affero General Public License v1.0, SPDX License
-- List 3.0
AGPL_1_0 :: LicenseId
-- | AGPL-1.0-only, Affero General Public License v1.0 only, SPDX
-- License List 3.2, SPDX License List 3.6, SPDX License List 3.9, SPDX
-- License List 3.10
AGPL_1_0_only :: LicenseId
-- | AGPL-1.0-or-later, Affero General Public License v1.0 or
-- later, SPDX License List 3.2, SPDX License List 3.6, SPDX License List
-- 3.9, SPDX License List 3.10
AGPL_1_0_or_later :: LicenseId
-- | AGPL-3.0-only, GNU Affero General Public License v3.0 only
AGPL_3_0_only :: LicenseId
-- | AGPL-3.0-or-later, GNU Affero General Public License v3.0 or
-- later
AGPL_3_0_or_later :: LicenseId
-- | Aladdin, Aladdin Free Public License
Aladdin :: LicenseId
-- | AMDPLPA, AMD's plpa_map.c License
AMDPLPA :: LicenseId
-- | AML, Apple MIT License
AML :: LicenseId
-- | AMPAS, Academy of Motion Picture Arts and Sciences BSD
AMPAS :: LicenseId
-- | ANTLR-PD, ANTLR Software Rights Notice
ANTLR_PD :: LicenseId
-- | Apache-1.0, Apache License 1.0
Apache_1_0 :: LicenseId
-- | Apache-1.1, Apache License 1.1
Apache_1_1 :: LicenseId
-- | Apache-2.0, Apache License 2.0
Apache_2_0 :: LicenseId
-- | APAFML, Adobe Postscript AFM License
APAFML :: LicenseId
-- | APL-1.0, Adaptive Public License 1.0
APL_1_0 :: LicenseId
-- | APSL-1.0, Apple Public Source License 1.0
APSL_1_0 :: LicenseId
-- | APSL-1.1, Apple Public Source License 1.1
APSL_1_1 :: LicenseId
-- | APSL-1.2, Apple Public Source License 1.2
APSL_1_2 :: LicenseId
-- | APSL-2.0, Apple Public Source License 2.0
APSL_2_0 :: LicenseId
-- | Artistic-1.0-cl8, Artistic License 1.0 w/clause 8
Artistic_1_0_cl8 :: LicenseId
-- | Artistic-1.0-Perl, Artistic License 1.0 (Perl)
Artistic_1_0_Perl :: LicenseId
-- | Artistic-1.0, Artistic License 1.0
Artistic_1_0 :: LicenseId
-- | Artistic-2.0, Artistic License 2.0
Artistic_2_0 :: LicenseId
-- | Bahyph, Bahyph License
Bahyph :: LicenseId
-- | Barr, Barr License
Barr :: LicenseId
-- | Beerware, Beerware License
Beerware :: LicenseId
-- | BitTorrent-1.0, BitTorrent Open Source License v1.0
BitTorrent_1_0 :: LicenseId
-- | BitTorrent-1.1, BitTorrent Open Source License v1.1
BitTorrent_1_1 :: LicenseId
-- | blessing, SQLite Blessing, SPDX License List 3.6, SPDX
-- License List 3.9, SPDX License List 3.10
Blessing :: LicenseId
-- | BlueOak-1.0.0, Blue Oak Model License 1.0.0, SPDX License
-- List 3.6, SPDX License List 3.9, SPDX License List 3.10
BlueOak_1_0_0 :: LicenseId
-- | Borceux, Borceux license
Borceux :: LicenseId
-- | BSD-1-Clause, BSD 1-Clause License
BSD_1_Clause :: LicenseId
-- | BSD-2-Clause-FreeBSD, BSD 2-Clause FreeBSD License, SPDX
-- License List 3.0, SPDX License List 3.2, SPDX License List 3.6, SPDX
-- License List 3.9
BSD_2_Clause_FreeBSD :: LicenseId
-- | BSD-2-Clause-NetBSD, BSD 2-Clause NetBSD License, SPDX
-- License List 3.0, SPDX License List 3.2, SPDX License List 3.6
BSD_2_Clause_NetBSD :: LicenseId
-- | BSD-2-Clause-Patent, BSD-2-Clause Plus Patent License
BSD_2_Clause_Patent :: LicenseId
-- | BSD-2-Clause-Views, BSD 2-Clause with views sentence, SPDX
-- License List 3.10
BSD_2_Clause_Views :: LicenseId
-- | BSD-2-Clause, BSD 2-Clause Simplified License
BSD_2_Clause :: LicenseId
-- | BSD-3-Clause-Attribution, BSD with attribution
BSD_3_Clause_Attribution :: LicenseId
-- | BSD-3-Clause-Clear, BSD 3-Clause Clear License
BSD_3_Clause_Clear :: LicenseId
-- | BSD-3-Clause-LBNL, Lawrence Berkeley National Labs BSD
-- variant license
BSD_3_Clause_LBNL :: LicenseId
-- | BSD-3-Clause-No-Nuclear-License-2014, BSD 3-Clause No Nuclear
-- License 2014
BSD_3_Clause_No_Nuclear_License_2014 :: LicenseId
-- | BSD-3-Clause-No-Nuclear-License, BSD 3-Clause No Nuclear
-- License
BSD_3_Clause_No_Nuclear_License :: LicenseId
-- | BSD-3-Clause-No-Nuclear-Warranty, BSD 3-Clause No Nuclear
-- Warranty
BSD_3_Clause_No_Nuclear_Warranty :: LicenseId
-- | BSD-3-Clause-Open-MPI, BSD 3-Clause Open MPI variant, SPDX
-- License List 3.6, SPDX License List 3.9, SPDX License List 3.10
BSD_3_Clause_Open_MPI :: LicenseId
-- | BSD-3-Clause, BSD 3-Clause New or Revised
-- License
BSD_3_Clause :: LicenseId
-- | BSD-4-Clause-UC, BSD-4-Clause (University of
-- California-Specific)
BSD_4_Clause_UC :: LicenseId
-- | BSD-4-Clause, BSD 4-Clause Original or Old
-- License
BSD_4_Clause :: LicenseId
-- | BSD-Protection, BSD Protection License
BSD_Protection :: LicenseId
-- | BSD-Source-Code, BSD Source Code Attribution
BSD_Source_Code :: LicenseId
-- | BSL-1.0, Boost Software License 1.0
BSL_1_0 :: LicenseId
-- | bzip2-1.0.5, bzip2 and libbzip2 License v1.0.5
Bzip2_1_0_5 :: LicenseId
-- | bzip2-1.0.6, bzip2 and libbzip2 License v1.0.6
Bzip2_1_0_6 :: LicenseId
-- | CAL-1.0-Combined-Work-Exception, Cryptographic Autonomy
-- License 1.0 (Combined Work Exception), SPDX License List 3.9, SPDX
-- License List 3.10
CAL_1_0_Combined_Work_Exception :: LicenseId
-- | CAL-1.0, Cryptographic Autonomy License 1.0, SPDX License
-- List 3.9, SPDX License List 3.10
CAL_1_0 :: LicenseId
-- | Caldera, Caldera License
Caldera :: LicenseId
-- | CATOSL-1.1, Computer Associates Trusted Open Source License
-- 1.1
CATOSL_1_1 :: LicenseId
-- | CC-BY-1.0, Creative Commons Attribution 1.0 Generic
CC_BY_1_0 :: LicenseId
-- | CC-BY-2.0, Creative Commons Attribution 2.0 Generic
CC_BY_2_0 :: LicenseId
-- | CC-BY-2.5, Creative Commons Attribution 2.5 Generic
CC_BY_2_5 :: LicenseId
-- | CC-BY-3.0-AT, Creative Commons Attribution 3.0 Austria, SPDX
-- License List 3.10
CC_BY_3_0_AT :: LicenseId
-- | CC-BY-3.0, Creative Commons Attribution 3.0 Unported
CC_BY_3_0 :: LicenseId
-- | CC-BY-4.0, Creative Commons Attribution 4.0 International
CC_BY_4_0 :: LicenseId
-- | CC-BY-NC-1.0, Creative Commons Attribution Non Commercial 1.0
-- Generic
CC_BY_NC_1_0 :: LicenseId
-- | CC-BY-NC-2.0, Creative Commons Attribution Non Commercial 2.0
-- Generic
CC_BY_NC_2_0 :: LicenseId
-- | CC-BY-NC-2.5, Creative Commons Attribution Non Commercial 2.5
-- Generic
CC_BY_NC_2_5 :: LicenseId
-- | CC-BY-NC-3.0, Creative Commons Attribution Non Commercial 3.0
-- Unported
CC_BY_NC_3_0 :: LicenseId
-- | CC-BY-NC-4.0, Creative Commons Attribution Non Commercial 4.0
-- International
CC_BY_NC_4_0 :: LicenseId
-- | CC-BY-NC-ND-1.0, Creative Commons Attribution Non Commercial
-- No Derivatives 1.0 Generic
CC_BY_NC_ND_1_0 :: LicenseId
-- | CC-BY-NC-ND-2.0, Creative Commons Attribution Non Commercial
-- No Derivatives 2.0 Generic
CC_BY_NC_ND_2_0 :: LicenseId
-- | CC-BY-NC-ND-2.5, Creative Commons Attribution Non Commercial
-- No Derivatives 2.5 Generic
CC_BY_NC_ND_2_5 :: LicenseId
-- | CC-BY-NC-ND-3.0-IGO, Creative Commons Attribution Non
-- Commercial No Derivatives 3.0 IGO, SPDX License List 3.10
CC_BY_NC_ND_3_0_IGO :: LicenseId
-- | CC-BY-NC-ND-3.0, Creative Commons Attribution Non Commercial
-- No Derivatives 3.0 Unported
CC_BY_NC_ND_3_0 :: LicenseId
-- | CC-BY-NC-ND-4.0, Creative Commons Attribution Non Commercial
-- No Derivatives 4.0 International
CC_BY_NC_ND_4_0 :: LicenseId
-- | CC-BY-NC-SA-1.0, Creative Commons Attribution Non Commercial
-- Share Alike 1.0 Generic
CC_BY_NC_SA_1_0 :: LicenseId
-- | CC-BY-NC-SA-2.0, Creative Commons Attribution Non Commercial
-- Share Alike 2.0 Generic
CC_BY_NC_SA_2_0 :: LicenseId
-- | CC-BY-NC-SA-2.5, Creative Commons Attribution Non Commercial
-- Share Alike 2.5 Generic
CC_BY_NC_SA_2_5 :: LicenseId
-- | CC-BY-NC-SA-3.0, Creative Commons Attribution Non Commercial
-- Share Alike 3.0 Unported
CC_BY_NC_SA_3_0 :: LicenseId
-- | CC-BY-NC-SA-4.0, Creative Commons Attribution Non Commercial
-- Share Alike 4.0 International
CC_BY_NC_SA_4_0 :: LicenseId
-- | CC-BY-ND-1.0, Creative Commons Attribution No Derivatives 1.0
-- Generic
CC_BY_ND_1_0 :: LicenseId
-- | CC-BY-ND-2.0, Creative Commons Attribution No Derivatives 2.0
-- Generic
CC_BY_ND_2_0 :: LicenseId
-- | CC-BY-ND-2.5, Creative Commons Attribution No Derivatives 2.5
-- Generic
CC_BY_ND_2_5 :: LicenseId
-- | CC-BY-ND-3.0, Creative Commons Attribution No Derivatives 3.0
-- Unported
CC_BY_ND_3_0 :: LicenseId
-- | CC-BY-ND-4.0, Creative Commons Attribution No Derivatives 4.0
-- International
CC_BY_ND_4_0 :: LicenseId
-- | CC-BY-SA-1.0, Creative Commons Attribution Share Alike 1.0
-- Generic
CC_BY_SA_1_0 :: LicenseId
-- | CC-BY-SA-2.0, Creative Commons Attribution Share Alike 2.0
-- Generic
CC_BY_SA_2_0 :: LicenseId
-- | CC-BY-SA-2.5, Creative Commons Attribution Share Alike 2.5
-- Generic
CC_BY_SA_2_5 :: LicenseId
-- | CC-BY-SA-3.0-AT, Creative Commons Attribution-Share Alike 3.0
-- Austria, SPDX License List 3.10
CC_BY_SA_3_0_AT :: LicenseId
-- | CC-BY-SA-3.0, Creative Commons Attribution Share Alike 3.0
-- Unported
CC_BY_SA_3_0 :: LicenseId
-- | CC-BY-SA-4.0, Creative Commons Attribution Share Alike 4.0
-- International
CC_BY_SA_4_0 :: LicenseId
-- | CC-PDDC, Creative Commons Public Domain Dedication and
-- Certification, SPDX License List 3.6, SPDX License List 3.9, SPDX
-- License List 3.10
CC_PDDC :: LicenseId
-- | CC0-1.0, Creative Commons Zero v1.0 Universal
CC0_1_0 :: LicenseId
-- | CDDL-1.0, Common Development and Distribution License 1.0
CDDL_1_0 :: LicenseId
-- | CDDL-1.1, Common Development and Distribution License 1.1
CDDL_1_1 :: LicenseId
-- | CDLA-Permissive-1.0, Community Data License Agreement
-- Permissive 1.0
CDLA_Permissive_1_0 :: LicenseId
-- | CDLA-Sharing-1.0, Community Data License Agreement Sharing
-- 1.0
CDLA_Sharing_1_0 :: LicenseId
-- | CECILL-1.0, CeCILL Free Software License Agreement v1.0
CECILL_1_0 :: LicenseId
-- | CECILL-1.1, CeCILL Free Software License Agreement v1.1
CECILL_1_1 :: LicenseId
-- | CECILL-2.0, CeCILL Free Software License Agreement v2.0
CECILL_2_0 :: LicenseId
-- | CECILL-2.1, CeCILL Free Software License Agreement v2.1
CECILL_2_1 :: LicenseId
-- | CECILL-B, CeCILL-B Free Software License Agreement
CECILL_B :: LicenseId
-- | CECILL-C, CeCILL-C Free Software License Agreement
CECILL_C :: LicenseId
-- | CERN-OHL-1.1, CERN Open Hardware Licence v1.1, SPDX License
-- List 3.6, SPDX License List 3.9, SPDX License List 3.10
CERN_OHL_1_1 :: LicenseId
-- | CERN-OHL-1.2, CERN Open Hardware Licence v1.2, SPDX License
-- List 3.6, SPDX License List 3.9, SPDX License List 3.10
CERN_OHL_1_2 :: LicenseId
-- | CERN-OHL-P-2.0, CERN Open Hardware Licence Version 2 -
-- Permissive, SPDX License List 3.9, SPDX License List 3.10
CERN_OHL_P_2_0 :: LicenseId
-- | CERN-OHL-S-2.0, CERN Open Hardware Licence Version 2 -
-- Strongly Reciprocal, SPDX License List 3.9, SPDX License List 3.10
CERN_OHL_S_2_0 :: LicenseId
-- | CERN-OHL-W-2.0, CERN Open Hardware Licence Version 2 - Weakly
-- Reciprocal, SPDX License List 3.9, SPDX License List 3.10
CERN_OHL_W_2_0 :: LicenseId
-- | ClArtistic, Clarified Artistic License
ClArtistic :: LicenseId
-- | CNRI-Jython, CNRI Jython License
CNRI_Jython :: LicenseId
-- | CNRI-Python-GPL-Compatible, CNRI Python Open Source GPL
-- Compatible License Agreement
CNRI_Python_GPL_Compatible :: LicenseId
-- | CNRI-Python, CNRI Python License
CNRI_Python :: LicenseId
-- | Condor-1.1, Condor Public License v1.1
Condor_1_1 :: LicenseId
-- | copyleft-next-0.3.0, copyleft-next 0.3.0, SPDX License List
-- 3.6, SPDX License List 3.9, SPDX License List 3.10
Copyleft_next_0_3_0 :: LicenseId
-- | copyleft-next-0.3.1, copyleft-next 0.3.1, SPDX License List
-- 3.6, SPDX License List 3.9, SPDX License List 3.10
Copyleft_next_0_3_1 :: LicenseId
-- | CPAL-1.0, Common Public Attribution License 1.0
CPAL_1_0 :: LicenseId
-- | CPL-1.0, Common Public License 1.0
CPL_1_0 :: LicenseId
-- | CPOL-1.02, Code Project Open License 1.02
CPOL_1_02 :: LicenseId
-- | Crossword, Crossword License
Crossword :: LicenseId
-- | CrystalStacker, CrystalStacker License
CrystalStacker :: LicenseId
-- | CUA-OPL-1.0, CUA Office Public License v1.0
CUA_OPL_1_0 :: LicenseId
-- | Cube, Cube License
Cube :: LicenseId
-- | curl, curl License
Curl :: LicenseId
-- | D-FSL-1.0, Deutsche Freie Software Lizenz
D_FSL_1_0 :: LicenseId
-- | diffmark, diffmark license
Diffmark :: LicenseId
-- | DOC, DOC License
DOC :: LicenseId
-- | Dotseqn, Dotseqn License
Dotseqn :: LicenseId
-- | DSDP, DSDP License
DSDP :: LicenseId
-- | dvipdfm, dvipdfm License
Dvipdfm :: LicenseId
-- | ECL-1.0, Educational Community License v1.0
ECL_1_0 :: LicenseId
-- | ECL-2.0, Educational Community License v2.0
ECL_2_0 :: LicenseId
-- | EFL-1.0, Eiffel Forum License v1.0
EFL_1_0 :: LicenseId
-- | EFL-2.0, Eiffel Forum License v2.0
EFL_2_0 :: LicenseId
-- | eGenix, eGenix.com Public License 1.1.0
EGenix :: LicenseId
-- | Entessa, Entessa Public License v1.0
Entessa :: LicenseId
-- | EPICS, EPICS Open License, SPDX License List 3.10
EPICS :: LicenseId
-- | EPL-1.0, Eclipse Public License 1.0
EPL_1_0 :: LicenseId
-- | EPL-2.0, Eclipse Public License 2.0
EPL_2_0 :: LicenseId
-- | ErlPL-1.1, Erlang Public License v1.1
ErlPL_1_1 :: LicenseId
-- | etalab-2.0, Etalab Open License 2.0, SPDX License List 3.9,
-- SPDX License List 3.10
Etalab_2_0 :: LicenseId
-- | EUDatagrid, EU DataGrid Software License
EUDatagrid :: LicenseId
-- | EUPL-1.0, European Union Public License 1.0
EUPL_1_0 :: LicenseId
-- | EUPL-1.1, European Union Public License 1.1
EUPL_1_1 :: LicenseId
-- | EUPL-1.2, European Union Public License 1.2
EUPL_1_2 :: LicenseId
-- | Eurosym, Eurosym License
Eurosym :: LicenseId
-- | Fair, Fair License
Fair :: LicenseId
-- | Frameworx-1.0, Frameworx Open License 1.0
Frameworx_1_0 :: LicenseId
-- | FreeImage, FreeImage Public License v1.0
FreeImage :: LicenseId
-- | FSFAP, FSF All Permissive License
FSFAP :: LicenseId
-- | FSFULLR, FSF Unlimited License (with License Retention)
FSFULLR :: LicenseId
-- | FSFUL, FSF Unlimited License
FSFUL :: LicenseId
-- | FTL, Freetype Project License
FTL :: LicenseId
-- | GFDL-1.1-invariants-only, GNU Free Documentation License v1.1
-- only - invariants, SPDX License List 3.10
GFDL_1_1_invariants_only :: LicenseId
-- | GFDL-1.1-invariants-or-later, GNU Free Documentation License
-- v1.1 or later - invariants, SPDX License List 3.10
GFDL_1_1_invariants_or_later :: LicenseId
-- | GFDL-1.1-no-invariants-only, GNU Free Documentation License
-- v1.1 only - no invariants, SPDX License List 3.10
GFDL_1_1_no_invariants_only :: LicenseId
-- | GFDL-1.1-no-invariants-or-later, GNU Free Documentation
-- License v1.1 or later - no invariants, SPDX License List 3.10
GFDL_1_1_no_invariants_or_later :: LicenseId
-- | GFDL-1.1-only, GNU Free Documentation License v1.1 only
GFDL_1_1_only :: LicenseId
-- | GFDL-1.1-or-later, GNU Free Documentation License v1.1 or
-- later
GFDL_1_1_or_later :: LicenseId
-- | GFDL-1.2-invariants-only, GNU Free Documentation License v1.2
-- only - invariants, SPDX License List 3.10
GFDL_1_2_invariants_only :: LicenseId
-- | GFDL-1.2-invariants-or-later, GNU Free Documentation License
-- v1.2 or later - invariants, SPDX License List 3.10
GFDL_1_2_invariants_or_later :: LicenseId
-- | GFDL-1.2-no-invariants-only, GNU Free Documentation License
-- v1.2 only - no invariants, SPDX License List 3.10
GFDL_1_2_no_invariants_only :: LicenseId
-- | GFDL-1.2-no-invariants-or-later, GNU Free Documentation
-- License v1.2 or later - no invariants, SPDX License List 3.10
GFDL_1_2_no_invariants_or_later :: LicenseId
-- | GFDL-1.2-only, GNU Free Documentation License v1.2 only
GFDL_1_2_only :: LicenseId
-- | GFDL-1.2-or-later, GNU Free Documentation License v1.2 or
-- later
GFDL_1_2_or_later :: LicenseId
-- | GFDL-1.3-invariants-only, GNU Free Documentation License v1.3
-- only - invariants, SPDX License List 3.10
GFDL_1_3_invariants_only :: LicenseId
-- | GFDL-1.3-invariants-or-later, GNU Free Documentation License
-- v1.3 or later - invariants, SPDX License List 3.10
GFDL_1_3_invariants_or_later :: LicenseId
-- | GFDL-1.3-no-invariants-only, GNU Free Documentation License
-- v1.3 only - no invariants, SPDX License List 3.10
GFDL_1_3_no_invariants_only :: LicenseId
-- | GFDL-1.3-no-invariants-or-later, GNU Free Documentation
-- License v1.3 or later - no invariants, SPDX License List 3.10
GFDL_1_3_no_invariants_or_later :: LicenseId
-- | GFDL-1.3-only, GNU Free Documentation License v1.3 only
GFDL_1_3_only :: LicenseId
-- | GFDL-1.3-or-later, GNU Free Documentation License v1.3 or
-- later
GFDL_1_3_or_later :: LicenseId
-- | Giftware, Giftware License
Giftware :: LicenseId
-- | GL2PS, GL2PS License
GL2PS :: LicenseId
-- | Glide, 3dfx Glide License
Glide :: LicenseId
-- | Glulxe, Glulxe License
Glulxe :: LicenseId
-- | GLWTPL, Good Luck With That Public License, SPDX License List
-- 3.10
GLWTPL :: LicenseId
-- | gnuplot, gnuplot License
Gnuplot :: LicenseId
-- | GPL-1.0-only, GNU General Public License v1.0 only
GPL_1_0_only :: LicenseId
-- | GPL-1.0-or-later, GNU General Public License v1.0 or later
GPL_1_0_or_later :: LicenseId
-- | GPL-2.0-only, GNU General Public License v2.0 only
GPL_2_0_only :: LicenseId
-- | GPL-2.0-or-later, GNU General Public License v2.0 or later
GPL_2_0_or_later :: LicenseId
-- | GPL-3.0-only, GNU General Public License v3.0 only
GPL_3_0_only :: LicenseId
-- | GPL-3.0-or-later, GNU General Public License v3.0 or later
GPL_3_0_or_later :: LicenseId
-- | gSOAP-1.3b, gSOAP Public License v1.3b
GSOAP_1_3b :: LicenseId
-- | HaskellReport, Haskell Language Report License
HaskellReport :: LicenseId
-- | Hippocratic-2.1, Hippocratic License 2.1, SPDX License List
-- 3.9, SPDX License List 3.10
Hippocratic_2_1 :: LicenseId
-- | HPND-sell-variant, Historical Permission Notice and
-- Disclaimer - sell variant, SPDX License List 3.6, SPDX License List
-- 3.9, SPDX License List 3.10
HPND_sell_variant :: LicenseId
-- | HPND, Historical Permission Notice and Disclaimer
HPND :: LicenseId
-- | IBM-pibs, IBM PowerPC Initialization and Boot Software
IBM_pibs :: LicenseId
-- | ICU, ICU License
ICU :: LicenseId
-- | IJG, Independent JPEG Group License
IJG :: LicenseId
-- | ImageMagick, ImageMagick License
ImageMagick :: LicenseId
-- | iMatix, iMatix Standard Function Library Agreement
IMatix :: LicenseId
-- | Imlib2, Imlib2 License
Imlib2 :: LicenseId
-- | Info-ZIP, Info-ZIP License
Info_ZIP :: LicenseId
-- | Intel-ACPI, Intel ACPI Software License Agreement
Intel_ACPI :: LicenseId
-- | Intel, Intel Open Source License
Intel :: LicenseId
-- | Interbase-1.0, Interbase Public License v1.0
Interbase_1_0 :: LicenseId
-- | IPA, IPA Font License
IPA :: LicenseId
-- | IPL-1.0, IBM Public License v1.0
IPL_1_0 :: LicenseId
-- | ISC, ISC License
ISC :: LicenseId
-- | JasPer-2.0, JasPer License
JasPer_2_0 :: LicenseId
-- | JPNIC, Japan Network Information Center License, SPDX License
-- List 3.6, SPDX License List 3.9, SPDX License List 3.10
JPNIC :: LicenseId
-- | JSON, JSON License
JSON :: LicenseId
-- | LAL-1.2, Licence Art Libre 1.2
LAL_1_2 :: LicenseId
-- | LAL-1.3, Licence Art Libre 1.3
LAL_1_3 :: LicenseId
-- | Latex2e, Latex2e License
Latex2e :: LicenseId
-- | Leptonica, Leptonica License
Leptonica :: LicenseId
-- | LGPL-2.0-only, GNU Library General Public License v2 only
LGPL_2_0_only :: LicenseId
-- | LGPL-2.0-or-later, GNU Library General Public License v2 or
-- later
LGPL_2_0_or_later :: LicenseId
-- | LGPL-2.1-only, GNU Lesser General Public License v2.1 only
LGPL_2_1_only :: LicenseId
-- | LGPL-2.1-or-later, GNU Lesser General Public License v2.1 or
-- later
LGPL_2_1_or_later :: LicenseId
-- | LGPL-3.0-only, GNU Lesser General Public License v3.0 only
LGPL_3_0_only :: LicenseId
-- | LGPL-3.0-or-later, GNU Lesser General Public License v3.0 or
-- later
LGPL_3_0_or_later :: LicenseId
-- | LGPLLR, Lesser General Public License For Linguistic
-- Resources
LGPLLR :: LicenseId
-- | libpng-2.0, PNG Reference Library version 2, SPDX License
-- List 3.6, SPDX License List 3.9, SPDX License List 3.10
Libpng_2_0 :: LicenseId
-- | Libpng, libpng License
Libpng :: LicenseId
-- | libselinux-1.0, libselinux public domain notice, SPDX License
-- List 3.9, SPDX License List 3.10
Libselinux_1_0 :: LicenseId
-- | libtiff, libtiff License
Libtiff :: LicenseId
-- | LiLiQ-P-1.1, Licence Libre du Québec – Permissive version 1.1
LiLiQ_P_1_1 :: LicenseId
-- | LiLiQ-R-1.1, Licence Libre du Québec – Réciprocité version
-- 1.1
LiLiQ_R_1_1 :: LicenseId
-- | LiLiQ-Rplus-1.1, Licence Libre du Québec – Réciprocité forte
-- version 1.1
LiLiQ_Rplus_1_1 :: LicenseId
-- | Linux-OpenIB, Linux Kernel Variant of OpenIB.org license,
-- SPDX License List 3.2, SPDX License List 3.6, SPDX License List 3.9,
-- SPDX License List 3.10
Linux_OpenIB :: LicenseId
-- | LPL-1.02, Lucent Public License v1.02
LPL_1_02 :: LicenseId
-- | LPL-1.0, Lucent Public License Version 1.0
LPL_1_0 :: LicenseId
-- | LPPL-1.0, LaTeX Project Public License v1.0
LPPL_1_0 :: LicenseId
-- | LPPL-1.1, LaTeX Project Public License v1.1
LPPL_1_1 :: LicenseId
-- | LPPL-1.2, LaTeX Project Public License v1.2
LPPL_1_2 :: LicenseId
-- | LPPL-1.3a, LaTeX Project Public License v1.3a
LPPL_1_3a :: LicenseId
-- | LPPL-1.3c, LaTeX Project Public License v1.3c
LPPL_1_3c :: LicenseId
-- | MakeIndex, MakeIndex License
MakeIndex :: LicenseId
-- | MirOS, The MirOS Licence
MirOS :: LicenseId
-- | MIT-0, MIT No Attribution, SPDX License List 3.2, SPDX
-- License List 3.6, SPDX License List 3.9, SPDX License List 3.10
MIT_0 :: LicenseId
-- | MIT-advertising, Enlightenment License (e16)
MIT_advertising :: LicenseId
-- | MIT-CMU, CMU License
MIT_CMU :: LicenseId
-- | MIT-enna, enna License
MIT_enna :: LicenseId
-- | MIT-feh, feh License
MIT_feh :: LicenseId
-- | MITNFA, MIT +no-false-attribs license
MITNFA :: LicenseId
-- | MIT, MIT License
MIT :: LicenseId
-- | Motosoto, Motosoto License
Motosoto :: LicenseId
-- | mpich2, mpich2 License
Mpich2 :: LicenseId
-- | MPL-1.0, Mozilla Public License 1.0
MPL_1_0 :: LicenseId
-- | MPL-1.1, Mozilla Public License 1.1
MPL_1_1 :: LicenseId
-- | MPL-2.0-no-copyleft-exception, Mozilla Public License 2.0 (no
-- copyleft exception)
MPL_2_0_no_copyleft_exception :: LicenseId
-- | MPL-2.0, Mozilla Public License 2.0
MPL_2_0 :: LicenseId
-- | MS-PL, Microsoft Public License
MS_PL :: LicenseId
-- | MS-RL, Microsoft Reciprocal License
MS_RL :: LicenseId
-- | MTLL, Matrix Template Library License
MTLL :: LicenseId
-- | MulanPSL-1.0, Mulan Permissive Software License, Version 1,
-- SPDX License List 3.9, SPDX License List 3.10
MulanPSL_1_0 :: LicenseId
-- | MulanPSL-2.0, Mulan Permissive Software License, Version 2,
-- SPDX License List 3.9, SPDX License List 3.10
MulanPSL_2_0 :: LicenseId
-- | Multics, Multics License
Multics :: LicenseId
-- | Mup, Mup License
Mup :: LicenseId
-- | NASA-1.3, NASA Open Source Agreement 1.3
NASA_1_3 :: LicenseId
-- | Naumen, Naumen Public License
Naumen :: LicenseId
-- | NBPL-1.0, Net Boolean Public License v1
NBPL_1_0 :: LicenseId
-- | NCGL-UK-2.0, Non-Commercial Government Licence, SPDX License
-- List 3.9, SPDX License List 3.10
NCGL_UK_2_0 :: LicenseId
-- | NCSA, University of Illinois/NCSA Open Source License
NCSA :: LicenseId
-- | Net-SNMP, Net-SNMP License
Net_SNMP :: LicenseId
-- | NetCDF, NetCDF license
NetCDF :: LicenseId
-- | Newsletr, Newsletr License
Newsletr :: LicenseId
-- | NGPL, Nethack General Public License
NGPL :: LicenseId
-- | NIST-PD-fallback, NIST Public Domain Notice with license
-- fallback, SPDX License List 3.10
NIST_PD_fallback :: LicenseId
-- | NIST-PD, NIST Public Domain Notice, SPDX License List 3.10
NIST_PD :: LicenseId
-- | NLOD-1.0, Norwegian Licence for Open Government Data
NLOD_1_0 :: LicenseId
-- | NLPL, No Limit Public License
NLPL :: LicenseId
-- | Nokia, Nokia Open Source License
Nokia :: LicenseId
-- | NOSL, Netizen Open Source License
NOSL :: LicenseId
-- | Noweb, Noweb License
Noweb :: LicenseId
-- | NPL-1.0, Netscape Public License v1.0
NPL_1_0 :: LicenseId
-- | NPL-1.1, Netscape Public License v1.1
NPL_1_1 :: LicenseId
-- | NPOSL-3.0, Non-Profit Open Software License 3.0
NPOSL_3_0 :: LicenseId
-- | NRL, NRL License
NRL :: LicenseId
-- | NTP-0, NTP No Attribution, SPDX License List 3.9, SPDX
-- License List 3.10
NTP_0 :: LicenseId
-- | NTP, NTP License
NTP :: LicenseId
-- | O-UDA-1.0, Open Use of Data Agreement v1.0, SPDX License List
-- 3.9, SPDX License List 3.10
O_UDA_1_0 :: LicenseId
-- | OCCT-PL, Open CASCADE Technology Public License
OCCT_PL :: LicenseId
-- | OCLC-2.0, OCLC Research Public License 2.0
OCLC_2_0 :: LicenseId
-- | ODbL-1.0, ODC Open Database License v1.0
ODbL_1_0 :: LicenseId
-- | ODC-By-1.0, Open Data Commons Attribution License v1.0, SPDX
-- License List 3.2, SPDX License List 3.6, SPDX License List 3.9, SPDX
-- License List 3.10
ODC_By_1_0 :: LicenseId
-- | OFL-1.0-no-RFN, SIL Open Font License 1.0 with no Reserved
-- Font Name, SPDX License List 3.9, SPDX License List 3.10
OFL_1_0_no_RFN :: LicenseId
-- | OFL-1.0-RFN, SIL Open Font License 1.0 with Reserved Font
-- Name, SPDX License List 3.9, SPDX License List 3.10
OFL_1_0_RFN :: LicenseId
-- | OFL-1.0, SIL Open Font License 1.0
OFL_1_0 :: LicenseId
-- | OFL-1.1-no-RFN, SIL Open Font License 1.1 with no Reserved
-- Font Name, SPDX License List 3.9, SPDX License List 3.10
OFL_1_1_no_RFN :: LicenseId
-- | OFL-1.1-RFN, SIL Open Font License 1.1 with Reserved Font
-- Name, SPDX License List 3.9, SPDX License List 3.10
OFL_1_1_RFN :: LicenseId
-- | OFL-1.1, SIL Open Font License 1.1
OFL_1_1 :: LicenseId
-- | OGC-1.0, OGC Software License, Version 1.0, SPDX License List
-- 3.9, SPDX License List 3.10
OGC_1_0 :: LicenseId
-- | OGL-Canada-2.0, Open Government Licence - Canada, SPDX
-- License List 3.9, SPDX License List 3.10
OGL_Canada_2_0 :: LicenseId
-- | OGL-UK-1.0, Open Government Licence v1.0, SPDX License List
-- 3.6, SPDX License List 3.9, SPDX License List 3.10
OGL_UK_1_0 :: LicenseId
-- | OGL-UK-2.0, Open Government Licence v2.0, SPDX License List
-- 3.6, SPDX License List 3.9, SPDX License List 3.10
OGL_UK_2_0 :: LicenseId
-- | OGL-UK-3.0, Open Government Licence v3.0, SPDX License List
-- 3.6, SPDX License List 3.9, SPDX License List 3.10
OGL_UK_3_0 :: LicenseId
-- | OGTSL, Open Group Test Suite License
OGTSL :: LicenseId
-- | OLDAP-1.1, Open LDAP Public License v1.1
OLDAP_1_1 :: LicenseId
-- | OLDAP-1.2, Open LDAP Public License v1.2
OLDAP_1_2 :: LicenseId
-- | OLDAP-1.3, Open LDAP Public License v1.3
OLDAP_1_3 :: LicenseId
-- | OLDAP-1.4, Open LDAP Public License v1.4
OLDAP_1_4 :: LicenseId
-- | OLDAP-2.0.1, Open LDAP Public License v2.0.1
OLDAP_2_0_1 :: LicenseId
-- | OLDAP-2.0, Open LDAP Public License v2.0 (or possibly 2.0A
-- and 2.0B)
OLDAP_2_0 :: LicenseId
-- | OLDAP-2.1, Open LDAP Public License v2.1
OLDAP_2_1 :: LicenseId
-- | OLDAP-2.2.1, Open LDAP Public License v2.2.1
OLDAP_2_2_1 :: LicenseId
-- | OLDAP-2.2.2, Open LDAP Public License 2.2.2
OLDAP_2_2_2 :: LicenseId
-- | OLDAP-2.2, Open LDAP Public License v2.2
OLDAP_2_2 :: LicenseId
-- | OLDAP-2.3, Open LDAP Public License v2.3
OLDAP_2_3 :: LicenseId
-- | OLDAP-2.4, Open LDAP Public License v2.4
OLDAP_2_4 :: LicenseId
-- | OLDAP-2.5, Open LDAP Public License v2.5
OLDAP_2_5 :: LicenseId
-- | OLDAP-2.6, Open LDAP Public License v2.6
OLDAP_2_6 :: LicenseId
-- | OLDAP-2.7, Open LDAP Public License v2.7
OLDAP_2_7 :: LicenseId
-- | OLDAP-2.8, Open LDAP Public License v2.8
OLDAP_2_8 :: LicenseId
-- | OML, Open Market License
OML :: LicenseId
-- | OpenSSL, OpenSSL License
OpenSSL :: LicenseId
-- | OPL-1.0, Open Public License v1.0
OPL_1_0 :: LicenseId
-- | OSET-PL-2.1, OSET Public License version 2.1
OSET_PL_2_1 :: LicenseId
-- | OSL-1.0, Open Software License 1.0
OSL_1_0 :: LicenseId
-- | OSL-1.1, Open Software License 1.1
OSL_1_1 :: LicenseId
-- | OSL-2.0, Open Software License 2.0
OSL_2_0 :: LicenseId
-- | OSL-2.1, Open Software License 2.1
OSL_2_1 :: LicenseId
-- | OSL-3.0, Open Software License 3.0
OSL_3_0 :: LicenseId
-- | Parity-6.0.0, The Parity Public License 6.0.0, SPDX License
-- List 3.6, SPDX License List 3.9, SPDX License List 3.10
Parity_6_0_0 :: LicenseId
-- | Parity-7.0.0, The Parity Public License 7.0.0, SPDX License
-- List 3.9, SPDX License List 3.10
Parity_7_0_0 :: LicenseId
-- | PDDL-1.0, ODC Public Domain Dedication & License 1.0
PDDL_1_0 :: LicenseId
-- | PHP-3.01, PHP License v3.01
PHP_3_01 :: LicenseId
-- | PHP-3.0, PHP License v3.0
PHP_3_0 :: LicenseId
-- | Plexus, Plexus Classworlds License
Plexus :: LicenseId
-- | PolyForm-Noncommercial-1.0.0, PolyForm Noncommercial License
-- 1.0.0, SPDX License List 3.9, SPDX License List 3.10
PolyForm_Noncommercial_1_0_0 :: LicenseId
-- | PolyForm-Small-Business-1.0.0, PolyForm Small Business
-- License 1.0.0, SPDX License List 3.9, SPDX License List 3.10
PolyForm_Small_Business_1_0_0 :: LicenseId
-- | PostgreSQL, PostgreSQL License
PostgreSQL :: LicenseId
-- | PSF-2.0, Python Software Foundation License 2.0, SPDX License
-- List 3.9, SPDX License List 3.10
PSF_2_0 :: LicenseId
-- | psfrag, psfrag License
Psfrag :: LicenseId
-- | psutils, psutils License
Psutils :: LicenseId
-- | Python-2.0, Python License 2.0
Python_2_0 :: LicenseId
-- | Qhull, Qhull License
Qhull :: LicenseId
-- | QPL-1.0, Q Public License 1.0
QPL_1_0 :: LicenseId
-- | Rdisc, Rdisc License
Rdisc :: LicenseId
-- | RHeCos-1.1, Red Hat eCos Public License v1.1
RHeCos_1_1 :: LicenseId
-- | RPL-1.1, Reciprocal Public License 1.1
RPL_1_1 :: LicenseId
-- | RPL-1.5, Reciprocal Public License 1.5
RPL_1_5 :: LicenseId
-- | RPSL-1.0, RealNetworks Public Source License v1.0
RPSL_1_0 :: LicenseId
-- | RSA-MD, RSA Message-Digest License
RSA_MD :: LicenseId
-- | RSCPL, Ricoh Source Code Public License
RSCPL :: LicenseId
-- | Ruby, Ruby License
Ruby :: LicenseId
-- | SAX-PD, Sax Public Domain Notice
SAX_PD :: LicenseId
-- | Saxpath, Saxpath License
Saxpath :: LicenseId
-- | SCEA, SCEA Shared Source License
SCEA :: LicenseId
-- | Sendmail-8.23, Sendmail License 8.23, SPDX License List 3.6,
-- SPDX License List 3.9, SPDX License List 3.10
Sendmail_8_23 :: LicenseId
-- | Sendmail, Sendmail License
Sendmail :: LicenseId
-- | SGI-B-1.0, SGI Free Software License B v1.0
SGI_B_1_0 :: LicenseId
-- | SGI-B-1.1, SGI Free Software License B v1.1
SGI_B_1_1 :: LicenseId
-- | SGI-B-2.0, SGI Free Software License B v2.0
SGI_B_2_0 :: LicenseId
-- | SHL-0.51, Solderpad Hardware License, Version 0.51, SPDX
-- License List 3.6, SPDX License List 3.9, SPDX License List 3.10
SHL_0_51 :: LicenseId
-- | SHL-0.5, Solderpad Hardware License v0.5, SPDX License List
-- 3.6, SPDX License List 3.9, SPDX License List 3.10
SHL_0_5 :: LicenseId
-- | SimPL-2.0, Simple Public License 2.0
SimPL_2_0 :: LicenseId
-- | SISSL-1.2, Sun Industry Standards Source License v1.2
SISSL_1_2 :: LicenseId
-- | SISSL, Sun Industry Standards Source License v1.1
SISSL :: LicenseId
-- | Sleepycat, Sleepycat License
Sleepycat :: LicenseId
-- | SMLNJ, Standard ML of New Jersey License
SMLNJ :: LicenseId
-- | SMPPL, Secure Messaging Protocol Public License
SMPPL :: LicenseId
-- | SNIA, SNIA Public License 1.1
SNIA :: LicenseId
-- | Spencer-86, Spencer License 86
Spencer_86 :: LicenseId
-- | Spencer-94, Spencer License 94
Spencer_94 :: LicenseId
-- | Spencer-99, Spencer License 99
Spencer_99 :: LicenseId
-- | SPL-1.0, Sun Public License v1.0
SPL_1_0 :: LicenseId
-- | SSH-OpenSSH, SSH OpenSSH license, SPDX License List 3.9, SPDX
-- License List 3.10
SSH_OpenSSH :: LicenseId
-- | SSH-short, SSH short notice, SPDX License List 3.9, SPDX
-- License List 3.10
SSH_short :: LicenseId
-- | SSPL-1.0, Server Side Public License, v 1, SPDX License List
-- 3.6, SPDX License List 3.9, SPDX License List 3.10
SSPL_1_0 :: LicenseId
-- | SugarCRM-1.1.3, SugarCRM Public License v1.1.3
SugarCRM_1_1_3 :: LicenseId
-- | SWL, Scheme Widget Library (SWL) Software License Agreement
SWL :: LicenseId
-- | TAPR-OHL-1.0, TAPR Open Hardware License v1.0, SPDX License
-- List 3.6, SPDX License List 3.9, SPDX License List 3.10
TAPR_OHL_1_0 :: LicenseId
-- | TCL, TCL/TK License
TCL :: LicenseId
-- | TCP-wrappers, TCP Wrappers License
TCP_wrappers :: LicenseId
-- | TMate, TMate Open Source License
TMate :: LicenseId
-- | TORQUE-1.1, TORQUE v2.5+ Software License v1.1
TORQUE_1_1 :: LicenseId
-- | TOSL, Trusster Open Source License
TOSL :: LicenseId
-- | TU-Berlin-1.0, Technische Universitaet Berlin License 1.0,
-- SPDX License List 3.2, SPDX License List 3.6, SPDX License List 3.9,
-- SPDX License List 3.10
TU_Berlin_1_0 :: LicenseId
-- | TU-Berlin-2.0, Technische Universitaet Berlin License 2.0,
-- SPDX License List 3.2, SPDX License List 3.6, SPDX License List 3.9,
-- SPDX License List 3.10
TU_Berlin_2_0 :: LicenseId
-- | UCL-1.0, Upstream Compatibility License v1.0, SPDX License
-- List 3.9, SPDX License List 3.10
UCL_1_0 :: LicenseId
-- | Unicode-DFS-2015, Unicode License Agreement - Data Files and
-- Software (2015)
Unicode_DFS_2015 :: LicenseId
-- | Unicode-DFS-2016, Unicode License Agreement - Data Files and
-- Software (2016)
Unicode_DFS_2016 :: LicenseId
-- | Unicode-TOU, Unicode Terms of Use
Unicode_TOU :: LicenseId
-- | Unlicense, The Unlicense
Unlicense :: LicenseId
-- | UPL-1.0, Universal Permissive License v1.0
UPL_1_0 :: LicenseId
-- | Vim, Vim License
Vim :: LicenseId
-- | VOSTROM, VOSTROM Public License for Open Source
VOSTROM :: LicenseId
-- | VSL-1.0, Vovida Software License v1.0
VSL_1_0 :: LicenseId
-- | W3C-19980720, W3C Software Notice and License (1998-07-20)
W3C_19980720 :: LicenseId
-- | W3C-20150513, W3C Software Notice and Document License
-- (2015-05-13)
W3C_20150513 :: LicenseId
-- | W3C, W3C Software Notice and License (2002-12-31)
W3C :: LicenseId
-- | Watcom-1.0, Sybase Open Watcom Public License 1.0
Watcom_1_0 :: LicenseId
-- | Wsuipa, Wsuipa License
Wsuipa :: LicenseId
-- | WTFPL, Do What The F*ck You Want To Public License
WTFPL :: LicenseId
-- | X11, X11 License
X11 :: LicenseId
-- | Xerox, Xerox License
Xerox :: LicenseId
-- | XFree86-1.1, XFree86 License 1.1
XFree86_1_1 :: LicenseId
-- | xinetd, xinetd License
Xinetd :: LicenseId
-- | Xnet, X.Net License
Xnet :: LicenseId
-- | xpp, XPP License
Xpp :: LicenseId
-- | XSkat, XSkat License
XSkat :: LicenseId
-- | YPL-1.0, Yahoo! Public License v1.0
YPL_1_0 :: LicenseId
-- | YPL-1.1, Yahoo! Public License v1.1
YPL_1_1 :: LicenseId
-- | Zed, Zed License
Zed :: LicenseId
-- | Zend-2.0, Zend License v2.0
Zend_2_0 :: LicenseId
-- | Zimbra-1.3, Zimbra Public License v1.3
Zimbra_1_3 :: LicenseId
-- | Zimbra-1.4, Zimbra Public License v1.4
Zimbra_1_4 :: LicenseId
-- | zlib-acknowledgement, zlib/libpng License with
-- Acknowledgement
Zlib_acknowledgement :: LicenseId
-- | Zlib, zlib License
Zlib :: LicenseId
-- | ZPL-1.1, Zope Public License 1.1
ZPL_1_1 :: LicenseId
-- | ZPL-2.0, Zope Public License 2.0
ZPL_2_0 :: LicenseId
-- | ZPL-2.1, Zope Public License 2.1
ZPL_2_1 :: LicenseId
-- | License SPDX identifier, e.g. "BSD-3-Clause".
licenseId :: LicenseId -> String
-- | License name, e.g. "GNU General Public License v2.0 only"
licenseName :: LicenseId -> String
-- | Whether the license is approved by Open Source Initiative (OSI).
--
-- See https://opensource.org/licenses/alphabetical.
licenseIsOsiApproved :: LicenseId -> Bool
-- | Create a LicenseId from a String.
mkLicenseId :: LicenseListVersion -> String -> Maybe LicenseId
licenseIdList :: LicenseListVersion -> [LicenseId]
-- | SPDX License identifier
data LicenseExceptionId
-- | 389-exception, 389 Directory Server Exception
DS389_exception :: LicenseExceptionId
-- | Autoconf-exception-2.0, Autoconf exception 2.0
Autoconf_exception_2_0 :: LicenseExceptionId
-- | Autoconf-exception-3.0, Autoconf exception 3.0
Autoconf_exception_3_0 :: LicenseExceptionId
-- | Bison-exception-2.2, Bison exception 2.2
Bison_exception_2_2 :: LicenseExceptionId
-- | Bootloader-exception, Bootloader Distribution Exception
Bootloader_exception :: LicenseExceptionId
-- | Classpath-exception-2.0, Classpath exception 2.0
Classpath_exception_2_0 :: LicenseExceptionId
-- | CLISP-exception-2.0, CLISP exception 2.0
CLISP_exception_2_0 :: LicenseExceptionId
-- | DigiRule-FOSS-exception, DigiRule FOSS License Exception
DigiRule_FOSS_exception :: LicenseExceptionId
-- | eCos-exception-2.0, eCos exception 2.0
ECos_exception_2_0 :: LicenseExceptionId
-- | Fawkes-Runtime-exception, Fawkes Runtime Exception
Fawkes_Runtime_exception :: LicenseExceptionId
-- | FLTK-exception, FLTK exception
FLTK_exception :: LicenseExceptionId
-- | Font-exception-2.0, Font exception 2.0
Font_exception_2_0 :: LicenseExceptionId
-- | freertos-exception-2.0, FreeRTOS Exception 2.0
Freertos_exception_2_0 :: LicenseExceptionId
-- | GCC-exception-2.0, GCC Runtime Library exception 2.0
GCC_exception_2_0 :: LicenseExceptionId
-- | GCC-exception-3.1, GCC Runtime Library exception 3.1
GCC_exception_3_1 :: LicenseExceptionId
-- | gnu-javamail-exception, GNU JavaMail exception
Gnu_javamail_exception :: LicenseExceptionId
-- | GPL-3.0-linking-exception, GPL-3.0 Linking Exception, SPDX
-- License List 3.9, SPDX License List 3.10
GPL_3_0_linking_exception :: LicenseExceptionId
-- | GPL-3.0-linking-source-exception, GPL-3.0 Linking Exception
-- (with Corresponding Source), SPDX License List 3.9, SPDX License List
-- 3.10
GPL_3_0_linking_source_exception :: LicenseExceptionId
-- | GPL-CC-1.0, GPL Cooperation Commitment 1.0, SPDX License List
-- 3.6, SPDX License List 3.9, SPDX License List 3.10
GPL_CC_1_0 :: LicenseExceptionId
-- | i2p-gpl-java-exception, i2p GPL+Java Exception
I2p_gpl_java_exception :: LicenseExceptionId
-- | LGPL-3.0-linking-exception, LGPL-3.0 Linking Exception, SPDX
-- License List 3.9, SPDX License List 3.10
LGPL_3_0_linking_exception :: LicenseExceptionId
-- | Libtool-exception, Libtool Exception
Libtool_exception :: LicenseExceptionId
-- | Linux-syscall-note, Linux Syscall Note
Linux_syscall_note :: LicenseExceptionId
-- | LLVM-exception, LLVM Exception, SPDX License List 3.2, SPDX
-- License List 3.6, SPDX License List 3.9, SPDX License List 3.10
LLVM_exception :: LicenseExceptionId
-- | LZMA-exception, LZMA exception
LZMA_exception :: LicenseExceptionId
-- | mif-exception, Macros and Inline Functions Exception
Mif_exception :: LicenseExceptionId
-- | Nokia-Qt-exception-1.1, Nokia Qt LGPL exception 1.1, SPDX
-- License List 3.0, SPDX License List 3.2
Nokia_Qt_exception_1_1 :: LicenseExceptionId
-- | OCaml-LGPL-linking-exception, OCaml LGPL Linking Exception,
-- SPDX License List 3.6, SPDX License List 3.9, SPDX License List 3.10
OCaml_LGPL_linking_exception :: LicenseExceptionId
-- | OCCT-exception-1.0, Open CASCADE Exception 1.0
OCCT_exception_1_0 :: LicenseExceptionId
-- | OpenJDK-assembly-exception-1.0, OpenJDK Assembly exception
-- 1.0, SPDX License List 3.2, SPDX License List 3.6, SPDX License List
-- 3.9, SPDX License List 3.10
OpenJDK_assembly_exception_1_0 :: LicenseExceptionId
-- | openvpn-openssl-exception, OpenVPN OpenSSL Exception
Openvpn_openssl_exception :: LicenseExceptionId
-- | PS-or-PDF-font-exception-20170817, PS/PDF font exception
-- (2017-08-17), SPDX License List 3.2, SPDX License List 3.6, SPDX
-- License List 3.9, SPDX License List 3.10
PS_or_PDF_font_exception_20170817 :: LicenseExceptionId
-- | Qt-GPL-exception-1.0, Qt GPL exception 1.0, SPDX License List
-- 3.2, SPDX License List 3.6, SPDX License List 3.9, SPDX License List
-- 3.10
Qt_GPL_exception_1_0 :: LicenseExceptionId
-- | Qt-LGPL-exception-1.1, Qt LGPL exception 1.1, SPDX License
-- List 3.2, SPDX License List 3.6, SPDX License List 3.9, SPDX License
-- List 3.10
Qt_LGPL_exception_1_1 :: LicenseExceptionId
-- | Qwt-exception-1.0, Qwt exception 1.0
Qwt_exception_1_0 :: LicenseExceptionId
-- | SHL-2.0, Solderpad Hardware License v2.0, SPDX License List
-- 3.9, SPDX License List 3.10
SHL_2_0 :: LicenseExceptionId
-- | SHL-2.1, Solderpad Hardware License v2.1, SPDX License List
-- 3.9, SPDX License List 3.10
SHL_2_1 :: LicenseExceptionId
-- | Swift-exception, Swift Exception, SPDX License List 3.6, SPDX
-- License List 3.9, SPDX License List 3.10
Swift_exception :: LicenseExceptionId
-- | u-boot-exception-2.0, U-Boot exception 2.0
U_boot_exception_2_0 :: LicenseExceptionId
-- | Universal-FOSS-exception-1.0, Universal FOSS Exception,
-- Version 1.0, SPDX License List 3.6, SPDX License List 3.9, SPDX
-- License List 3.10
Universal_FOSS_exception_1_0 :: LicenseExceptionId
-- | WxWindows-exception-3.1, WxWindows Library Exception 3.1
WxWindows_exception_3_1 :: LicenseExceptionId
-- | License SPDX identifier, e.g. "BSD-3-Clause".
licenseExceptionId :: LicenseExceptionId -> String
-- | License name, e.g. "GNU General Public License v2.0 only"
licenseExceptionName :: LicenseExceptionId -> String
-- | Create a LicenseExceptionId from a String.
mkLicenseExceptionId :: LicenseListVersion -> String -> Maybe LicenseExceptionId
licenseExceptionIdList :: LicenseListVersion -> [LicenseExceptionId]
-- | A user defined license reference denoted by
-- LicenseRef-[idstring] (for a license not on the SPDX License
-- List);
data LicenseRef
-- | License reference.
licenseRef :: LicenseRef -> String
-- | Document reference.
licenseDocumentRef :: LicenseRef -> Maybe String
-- | Create LicenseRef from optional document ref and name.
mkLicenseRef :: Maybe String -> String -> Maybe LicenseRef
-- | Like mkLicenseRef but convert invalid characters into
-- -.
mkLicenseRef' :: Maybe String -> String -> LicenseRef
-- | SPDX License List version Cabal is aware of.
data LicenseListVersion
LicenseListVersion_3_0 :: LicenseListVersion
LicenseListVersion_3_2 :: LicenseListVersion
LicenseListVersion_3_6 :: LicenseListVersion
LicenseListVersion_3_9 :: LicenseListVersion
LicenseListVersion_3_10 :: LicenseListVersion
cabalSpecVersionToSPDXListVersion :: CabalSpecVersion -> LicenseListVersion
-- | Simple parsing with failure
module Distribution.ReadE
-- | Parser with simple error reporting
newtype ReadE a
ReadE :: (String -> Either ErrorMsg a) -> ReadE a
[runReadE] :: ReadE a -> String -> Either ErrorMsg a
succeedReadE :: (String -> a) -> ReadE a
failReadE :: ErrorMsg -> ReadE a
readEOrFail :: ReadE a -> String -> a
parsecToReadE :: (String -> ErrorMsg) -> ParsecParser a -> ReadE a
instance GHC.Base.Functor Distribution.ReadE.ReadE
-- | Data type for Haskell module names.
module Distribution.ModuleName
-- | A valid Haskell module name.
data ModuleName
fromString :: IsString a => String -> a
-- | Construct a ModuleName from valid module components, i.e. parts
-- separated by dots.
-- | Deprecated: Exists for cabal-install only
fromComponents :: [String] -> ModuleName
-- | The individual components of a hierarchical module name. For example
--
--
-- components (fromString "A.B.C") = ["A", "B", "C"]
--
components :: ModuleName -> [String]
-- | Convert a module name to a file path, but without any file extension.
-- For example:
--
--
-- toFilePath (fromString "A.B.C") = "A/B/C"
--
toFilePath :: ModuleName -> FilePath
-- | The module name Main.
main :: ModuleName
validModuleComponent :: String -> Bool
instance Data.Data.Data Distribution.ModuleName.ModuleName
instance GHC.Show.Show Distribution.ModuleName.ModuleName
instance GHC.Read.Read Distribution.ModuleName.ModuleName
instance GHC.Classes.Ord Distribution.ModuleName.ModuleName
instance GHC.Generics.Generic Distribution.ModuleName.ModuleName
instance GHC.Classes.Eq Distribution.ModuleName.ModuleName
instance Data.Binary.Class.Binary Distribution.ModuleName.ModuleName
instance Distribution.Utils.Structured.Structured Distribution.ModuleName.ModuleName
instance Control.DeepSeq.NFData Distribution.ModuleName.ModuleName
instance Distribution.Pretty.Pretty Distribution.ModuleName.ModuleName
instance Distribution.Parsec.Parsec Distribution.ModuleName.ModuleName
instance Data.String.IsString Distribution.ModuleName.ModuleName
module Distribution.Types.ModuleRenaming
-- | Renaming applied to the modules provided by a package. The boolean
-- indicates whether or not to also include all of the original names of
-- modules. Thus, ModuleRenaming False [] is "don't expose any
-- modules, and ModuleRenaming True [(Data.Bool,
-- Bool)] is, "expose all modules, but also expose
-- Data.Bool as Bool". If a renaming is omitted you get
-- the DefaultRenaming.
--
-- (NB: This is a list not a map so that we can preserve order.)
data ModuleRenaming
-- | A module renaming/thinning; e.g., (A as B, C as C) brings
-- B and C into scope.
ModuleRenaming :: [(ModuleName, ModuleName)] -> ModuleRenaming
-- | The default renaming, bringing all exported modules into scope.
DefaultRenaming :: ModuleRenaming
-- | Hiding renaming, e.g., hiding (A, B), bringing all exported
-- modules into scope except the hidden ones.
HidingRenaming :: [ModuleName] -> ModuleRenaming
-- | Interpret a ModuleRenaming as a partial map from
-- ModuleName to ModuleName. For efficiency, you should
-- partially apply it with ModuleRenaming and then reuse it.
interpModuleRenaming :: ModuleRenaming -> ModuleName -> Maybe ModuleName
-- | The default renaming, if something is specified in
-- build-depends only.
defaultRenaming :: ModuleRenaming
-- | Tests if its the default renaming; we can use a more compact syntax in
-- IncludeRenaming in this case.
isDefaultRenaming :: ModuleRenaming -> Bool
instance GHC.Generics.Generic Distribution.Types.ModuleRenaming.ModuleRenaming
instance Data.Data.Data Distribution.Types.ModuleRenaming.ModuleRenaming
instance GHC.Classes.Ord Distribution.Types.ModuleRenaming.ModuleRenaming
instance GHC.Classes.Eq Distribution.Types.ModuleRenaming.ModuleRenaming
instance GHC.Read.Read Distribution.Types.ModuleRenaming.ModuleRenaming
instance GHC.Show.Show Distribution.Types.ModuleRenaming.ModuleRenaming
instance Data.Binary.Class.Binary Distribution.Types.ModuleRenaming.ModuleRenaming
instance Distribution.Utils.Structured.Structured Distribution.Types.ModuleRenaming.ModuleRenaming
instance Control.DeepSeq.NFData Distribution.Types.ModuleRenaming.ModuleRenaming
instance Distribution.Pretty.Pretty Distribution.Types.ModuleRenaming.ModuleRenaming
instance Distribution.Parsec.Parsec Distribution.Types.ModuleRenaming.ModuleRenaming
module Distribution.Types.IncludeRenaming
-- | A renaming on an include: (provides renaming, requires renaming)
data IncludeRenaming
IncludeRenaming :: ModuleRenaming -> ModuleRenaming -> IncludeRenaming
[includeProvidesRn] :: IncludeRenaming -> ModuleRenaming
[includeRequiresRn] :: IncludeRenaming -> ModuleRenaming
-- | The defaultIncludeRenaming applied when you only
-- build-depends on a package.
defaultIncludeRenaming :: IncludeRenaming
-- | Is an IncludeRenaming the default one?
isDefaultIncludeRenaming :: IncludeRenaming -> Bool
instance GHC.Generics.Generic Distribution.Types.IncludeRenaming.IncludeRenaming
instance Data.Data.Data Distribution.Types.IncludeRenaming.IncludeRenaming
instance GHC.Classes.Ord Distribution.Types.IncludeRenaming.IncludeRenaming
instance GHC.Classes.Eq Distribution.Types.IncludeRenaming.IncludeRenaming
instance GHC.Read.Read Distribution.Types.IncludeRenaming.IncludeRenaming
instance GHC.Show.Show Distribution.Types.IncludeRenaming.IncludeRenaming
instance Data.Binary.Class.Binary Distribution.Types.IncludeRenaming.IncludeRenaming
instance Distribution.Utils.Structured.Structured Distribution.Types.IncludeRenaming.IncludeRenaming
instance Control.DeepSeq.NFData Distribution.Types.IncludeRenaming.IncludeRenaming
instance Distribution.Pretty.Pretty Distribution.Types.IncludeRenaming.IncludeRenaming
instance Distribution.Parsec.Parsec Distribution.Types.IncludeRenaming.IncludeRenaming
module Distribution.Types.Mixin
-- | Invariant: if mixinLibraryName is LSubLibName,
-- it's not the same as mixinPackageName. In other words, the same
-- invariant as Dependency has.
data Mixin
Mixin :: PackageName -> LibraryName -> IncludeRenaming -> Mixin
[mixinPackageName] :: Mixin -> PackageName
[mixinLibraryName] :: Mixin -> LibraryName
[mixinIncludeRenaming] :: Mixin -> IncludeRenaming
-- | Smart constructor of Mixin, enforces invariant.
mkMixin :: PackageName -> LibraryName -> IncludeRenaming -> Mixin
-- | Restore invariant
normaliseMixin :: Mixin -> Mixin
instance GHC.Generics.Generic Distribution.Types.Mixin.Mixin
instance Data.Data.Data Distribution.Types.Mixin.Mixin
instance GHC.Classes.Ord Distribution.Types.Mixin.Mixin
instance GHC.Classes.Eq Distribution.Types.Mixin.Mixin
instance GHC.Read.Read Distribution.Types.Mixin.Mixin
instance GHC.Show.Show Distribution.Types.Mixin.Mixin
instance Data.Binary.Class.Binary Distribution.Types.Mixin.Mixin
instance Distribution.Utils.Structured.Structured Distribution.Types.Mixin.Mixin
instance Control.DeepSeq.NFData Distribution.Types.Mixin.Mixin
instance Distribution.Pretty.Pretty Distribution.Types.Mixin.Mixin
instance Distribution.Parsec.Parsec Distribution.Types.Mixin.Mixin
module Distribution.Types.ModuleReexport
data ModuleReexport
ModuleReexport :: Maybe PackageName -> ModuleName -> ModuleName -> ModuleReexport
[moduleReexportOriginalPackage] :: ModuleReexport -> Maybe PackageName
[moduleReexportOriginalName] :: ModuleReexport -> ModuleName
[moduleReexportName] :: ModuleReexport -> ModuleName
instance Data.Data.Data Distribution.Types.ModuleReexport.ModuleReexport
instance GHC.Show.Show Distribution.Types.ModuleReexport.ModuleReexport
instance GHC.Read.Read Distribution.Types.ModuleReexport.ModuleReexport
instance GHC.Generics.Generic Distribution.Types.ModuleReexport.ModuleReexport
instance GHC.Classes.Eq Distribution.Types.ModuleReexport.ModuleReexport
instance Data.Binary.Class.Binary Distribution.Types.ModuleReexport.ModuleReexport
instance Distribution.Utils.Structured.Structured Distribution.Types.ModuleReexport.ModuleReexport
instance Control.DeepSeq.NFData Distribution.Types.ModuleReexport.ModuleReexport
instance Distribution.Pretty.Pretty Distribution.Types.ModuleReexport.ModuleReexport
instance Distribution.Parsec.Parsec Distribution.Types.ModuleReexport.ModuleReexport
-- | A data type representing directed graphs, backed by Data.Graph.
-- It is strict in the node type.
--
-- This is an alternative interface to Data.Graph. In this
-- interface, nodes (identified by the IsNode type class) are
-- associated with a key and record the keys of their neighbors. This
-- interface is more convenient than Graph, which requires
-- vertices to be explicitly handled by integer indexes.
--
-- The current implementation has somewhat peculiar performance
-- characteristics. The asymptotics of all map-like operations mirror
-- their counterparts in Data.Map. However, to perform a graph
-- operation, we first must build the Data.Graph representation,
-- an operation that takes O(V + E log V). However, this operation
-- can be amortized across all queries on that particular graph.
--
-- Some nodes may be broken, i.e., refer to neighbors which are not
-- stored in the graph. In our graph algorithms, we transparently ignore
-- such edges; however, you can easily query for the broken vertices of a
-- graph using broken (and should, e.g., to ensure that a closure
-- of a graph is well-formed.) It's possible to take a closed subset of a
-- broken graph and get a well-formed graph.
module Distribution.Compat.Graph
-- | A graph of nodes a. The nodes are expected to have instance
-- of class IsNode.
data Graph a
-- | The IsNode class is used for datatypes which represent directed
-- graph nodes. A node of type a is associated with some unique
-- key of type Key a; given a node we can determine its
-- key (nodeKey) and the keys of its neighbors
-- (nodeNeighbors).
class Ord (Key a) => IsNode a where {
type family Key a;
}
nodeKey :: IsNode a => a -> Key a
nodeNeighbors :: IsNode a => a -> [Key a]
-- | O(1). Is the graph empty?
null :: Graph a -> Bool
-- | O(1). The number of nodes in the graph.
size :: Graph a -> Int
-- | O(log V). Check if the key is in the graph.
member :: IsNode a => Key a -> Graph a -> Bool
-- | O(log V). Lookup the node at a key in the graph.
lookup :: IsNode a => Key a -> Graph a -> Maybe a
-- | O(1). The empty graph.
empty :: IsNode a => Graph a
-- | O(log V). Insert a node into a graph.
insert :: IsNode a => a -> Graph a -> Graph a
-- | O(log V). Delete the node at a key from the graph.
deleteKey :: IsNode a => Key a -> Graph a -> Graph a
-- | O(log V). Lookup and delete. This function returns the deleted
-- value if it existed.
deleteLookup :: IsNode a => Key a -> Graph a -> (Maybe a, Graph a)
-- | O(V + V'). Left-biased union, preferring entries from the first
-- map when conflicts occur.
unionLeft :: IsNode a => Graph a -> Graph a -> Graph a
-- | O(V + V'). Right-biased union, preferring entries from the
-- second map when conflicts occur. nodeKey x = nodeKey
-- (f x).
unionRight :: IsNode a => Graph a -> Graph a -> Graph a
-- | Ω(V + E). Compute the strongly connected components of a graph.
-- Requires amortized construction of graph.
stronglyConnComp :: Graph a -> [SCC a]
-- | Strongly connected component.
data SCC vertex
-- | A single vertex that is not in any cycle.
AcyclicSCC :: vertex -> SCC vertex
-- | A maximal set of mutually reachable vertices.
CyclicSCC :: [vertex] -> SCC vertex
-- | Ω(V + E). Compute the cycles of a graph. Requires amortized
-- construction of graph.
cycles :: Graph a -> [[a]]
-- | O(1). Return a list of nodes paired with their broken neighbors
-- (i.e., neighbor keys which are not in the graph). Requires amortized
-- construction of graph.
broken :: Graph a -> [(a, [Key a])]
-- | Lookup the immediate neighbors from a key in the graph. Requires
-- amortized construction of graph.
neighbors :: Graph a -> Key a -> Maybe [a]
-- | Lookup the immediate reverse neighbors from a key in the graph.
-- Requires amortized construction of graph.
revNeighbors :: Graph a -> Key a -> Maybe [a]
-- | Compute the subgraph which is the closure of some set of keys. Returns
-- Nothing if one (or more) keys are not present in the graph.
-- Requires amortized construction of graph.
closure :: Graph a -> [Key a] -> Maybe [a]
-- | Compute the reverse closure of a graph from some set of keys. Returns
-- Nothing if one (or more) keys are not present in the graph.
-- Requires amortized construction of graph.
revClosure :: Graph a -> [Key a] -> Maybe [a]
-- | Topologically sort the nodes of a graph. Requires amortized
-- construction of graph.
topSort :: Graph a -> [a]
-- | Reverse topologically sort the nodes of a graph. Requires amortized
-- construction of graph.
revTopSort :: Graph a -> [a]
-- | O(1). Convert a graph into a map from keys to nodes. The
-- resulting map m is guaranteed to have the property that
-- all ((k,n) -> k == nodeKey n) (toList
-- m).
toMap :: Graph a -> Map (Key a) a
-- | O(V log V). Convert a list of nodes (with distinct keys) into a
-- graph.
fromDistinctList :: (IsNode a, Show (Key a)) => [a] -> Graph a
-- | O(V). Convert a graph into a list of nodes.
toList :: Graph a -> [a]
-- | O(V). Convert a graph into a list of keys.
keys :: Graph a -> [Key a]
-- | O(V). Convert a graph into a set of keys.
keysSet :: Graph a -> Set (Key a)
-- | O(1). Convert a graph into a Graph. Requires amortized
-- construction of graph.
toGraph :: Graph a -> (Graph, Vertex -> a, Key a -> Maybe Vertex)
-- | A simple, trivial data type which admits an IsNode instance.
data Node k a
N :: a -> k -> [k] -> Node k a
-- | Get the value from a Node.
nodeValue :: Node k a -> a
instance (GHC.Classes.Eq a, GHC.Classes.Eq k) => GHC.Classes.Eq (Distribution.Compat.Graph.Node k a)
instance (GHC.Show.Show a, GHC.Show.Show k) => GHC.Show.Show (Distribution.Compat.Graph.Node k a)
instance GHC.Base.Functor (Distribution.Compat.Graph.Node k)
instance GHC.Classes.Ord k => Distribution.Compat.Graph.IsNode (Distribution.Compat.Graph.Node k a)
instance GHC.Show.Show a => GHC.Show.Show (Distribution.Compat.Graph.Graph a)
instance (Distribution.Compat.Graph.IsNode a, GHC.Read.Read a, GHC.Show.Show (Distribution.Compat.Graph.Key a)) => GHC.Read.Read (Distribution.Compat.Graph.Graph a)
instance (Distribution.Compat.Graph.IsNode a, Data.Binary.Class.Binary a, GHC.Show.Show (Distribution.Compat.Graph.Key a)) => Data.Binary.Class.Binary (Distribution.Compat.Graph.Graph a)
instance Distribution.Utils.Structured.Structured a => Distribution.Utils.Structured.Structured (Distribution.Compat.Graph.Graph a)
instance (GHC.Classes.Eq (Distribution.Compat.Graph.Key a), GHC.Classes.Eq a) => GHC.Classes.Eq (Distribution.Compat.Graph.Graph a)
instance Data.Foldable.Foldable Distribution.Compat.Graph.Graph
instance (Control.DeepSeq.NFData a, Control.DeepSeq.NFData (Distribution.Compat.Graph.Key a)) => Control.DeepSeq.NFData (Distribution.Compat.Graph.Graph a)
instance (Distribution.Compat.Graph.IsNode a, Distribution.Compat.Graph.IsNode b, Distribution.Compat.Graph.Key a GHC.Types.~ Distribution.Compat.Graph.Key b) => Distribution.Compat.Graph.IsNode (Data.Either.Either a b)
module Distribution.Verbosity.Internal
data VerbosityLevel
Silent :: VerbosityLevel
Normal :: VerbosityLevel
Verbose :: VerbosityLevel
Deafening :: VerbosityLevel
data VerbosityFlag
VCallStack :: VerbosityFlag
VCallSite :: VerbosityFlag
VNoWrap :: VerbosityFlag
VMarkOutput :: VerbosityFlag
VTimestamp :: VerbosityFlag
VStderr :: VerbosityFlag
instance GHC.Enum.Bounded Distribution.Verbosity.Internal.VerbosityLevel
instance GHC.Enum.Enum Distribution.Verbosity.Internal.VerbosityLevel
instance GHC.Classes.Ord Distribution.Verbosity.Internal.VerbosityLevel
instance GHC.Classes.Eq Distribution.Verbosity.Internal.VerbosityLevel
instance GHC.Read.Read Distribution.Verbosity.Internal.VerbosityLevel
instance GHC.Show.Show Distribution.Verbosity.Internal.VerbosityLevel
instance GHC.Generics.Generic Distribution.Verbosity.Internal.VerbosityLevel
instance GHC.Enum.Bounded Distribution.Verbosity.Internal.VerbosityFlag
instance GHC.Enum.Enum Distribution.Verbosity.Internal.VerbosityFlag
instance GHC.Classes.Ord Distribution.Verbosity.Internal.VerbosityFlag
instance GHC.Classes.Eq Distribution.Verbosity.Internal.VerbosityFlag
instance GHC.Read.Read Distribution.Verbosity.Internal.VerbosityFlag
instance GHC.Show.Show Distribution.Verbosity.Internal.VerbosityFlag
instance GHC.Generics.Generic Distribution.Verbosity.Internal.VerbosityFlag
instance Data.Binary.Class.Binary Distribution.Verbosity.Internal.VerbosityFlag
instance Distribution.Utils.Structured.Structured Distribution.Verbosity.Internal.VerbosityFlag
instance Data.Binary.Class.Binary Distribution.Verbosity.Internal.VerbosityLevel
instance Distribution.Utils.Structured.Structured Distribution.Verbosity.Internal.VerbosityLevel
-- | A Verbosity type with associated utilities.
--
-- There are 4 standard verbosity levels from silent,
-- normal, verbose up to deafening. This is used for
-- deciding what logging messages to print.
--
-- Verbosity also is equipped with some internal settings which can be
-- used to control at a fine granularity the verbosity of specific
-- settings (e.g., so that you can trace only particular things you are
-- interested in.) It's important to note that the instances for
-- Verbosity assume that this does not exist.
module Distribution.Verbosity
data Verbosity
silent :: Verbosity
normal :: Verbosity
verbose :: Verbosity
deafening :: Verbosity
moreVerbose :: Verbosity -> Verbosity
lessVerbose :: Verbosity -> Verbosity
-- | Test if we had called lessVerbose on the verbosity
isVerboseQuiet :: Verbosity -> Bool
intToVerbosity :: Int -> Maybe Verbosity
flagToVerbosity :: ReadE Verbosity
showForCabal :: Verbosity -> String
showForGHC :: Verbosity -> String
-- | Turn off all flags
verboseNoFlags :: Verbosity -> Verbosity
verboseHasFlags :: Verbosity -> Bool
-- | Combinator for transforming verbosity level while retaining the
-- original hidden state.
--
-- For instance, the following property holds
--
--
-- isVerboseNoWrap (modifyVerbosity (max verbose) v) == isVerboseNoWrap v
--
--
-- Note: you can use modifyVerbosity (const v1) v0 to
-- overwrite v1's flags with v0's flags.
modifyVerbosity :: (Verbosity -> Verbosity) -> Verbosity -> Verbosity
-- | Turn on verbose call-site printing when we log.
verboseCallSite :: Verbosity -> Verbosity
-- | Turn on verbose call-stack printing when we log.
verboseCallStack :: Verbosity -> Verbosity
-- | Test if we should output call sites when we log.
isVerboseCallSite :: Verbosity -> Bool
-- | Test if we should output call stacks when we log.
isVerboseCallStack :: Verbosity -> Bool
-- | Turn on -----BEGIN CABAL OUTPUT----- markers for output from
-- Cabal (as opposed to GHC, or system dependent).
verboseMarkOutput :: Verbosity -> Verbosity
-- | Test if we should output markets.
isVerboseMarkOutput :: Verbosity -> Bool
-- | Turn off marking; useful for suppressing nondeterministic output.
verboseUnmarkOutput :: Verbosity -> Verbosity
-- | Disable line-wrapping for log messages.
verboseNoWrap :: Verbosity -> Verbosity
-- | Test if line-wrapping is disabled for log messages.
isVerboseNoWrap :: Verbosity -> Bool
-- | Turn on timestamps for log messages.
verboseTimestamp :: Verbosity -> Verbosity
-- | Test if we should output timestamps when we log.
isVerboseTimestamp :: Verbosity -> Bool
-- | Turn off timestamps for log messages.
verboseNoTimestamp :: Verbosity -> Verbosity
-- | Turn on timestamps for log messages.
verboseStderr :: Verbosity -> Verbosity
-- | Test if we should output to stderr when we log.
isVerboseStderr :: Verbosity -> Bool
-- | Turn off timestamps for log messages.
verboseNoStderr :: Verbosity -> Verbosity
instance GHC.Read.Read Distribution.Verbosity.Verbosity
instance GHC.Show.Show Distribution.Verbosity.Verbosity
instance GHC.Generics.Generic Distribution.Verbosity.Verbosity
instance GHC.Classes.Eq Distribution.Verbosity.Verbosity
instance GHC.Classes.Ord Distribution.Verbosity.Verbosity
instance GHC.Enum.Enum Distribution.Verbosity.Verbosity
instance GHC.Enum.Bounded Distribution.Verbosity.Verbosity
instance Data.Binary.Class.Binary Distribution.Verbosity.Verbosity
instance Distribution.Utils.Structured.Structured Distribution.Verbosity.Verbosity
instance Distribution.Parsec.Parsec Distribution.Verbosity.Verbosity
instance Distribution.Pretty.Pretty Distribution.Verbosity.Verbosity
-- | Exports the Version type along with a parser and pretty
-- printer. A version is something like "1.3.3". It also defines
-- the VersionRange data types. Version ranges are like ">=
-- 1.2 && < 2".
module Distribution.Version
-- | A Version represents the version of a software entity.
--
-- Instances of Eq and Ord are provided, which gives exact
-- equality and lexicographic ordering of the version number components
-- (i.e. 2.1 > 2.0, 1.2.3 > 1.2.2, etc.).
--
-- This type is opaque and distinct from the Version type in
-- Data.Version since Cabal-2.0. The difference extends
-- to the Binary instance using a different (and more compact)
-- encoding.
data Version
-- | Version 0. A lower bound of Version.
version0 :: Version
-- | Construct Version from list of version number components.
--
-- For instance, mkVersion [3,2,1] constructs a Version
-- representing the version 3.2.1.
--
-- All version components must be non-negative. mkVersion []
-- currently represents the special null version; see also
-- nullVersion.
mkVersion :: [Int] -> Version
-- | Variant of mkVersion which converts a Data.Version
-- Version into Cabal's Version type.
mkVersion' :: Version -> Version
-- | Unpack Version into list of version number components.
--
-- This is the inverse to mkVersion, so the following holds:
--
--
-- (versionNumbers . mkVersion) vs == vs
--
versionNumbers :: Version -> [Int]
-- | Constant representing the special null Version
--
-- The nullVersion compares (via Ord) as less than every
-- proper Version value.
nullVersion :: Version
-- | Apply function to list of version number components
--
--
-- alterVersion f == mkVersion . f . versionNumbers
--
alterVersion :: ([Int] -> [Int]) -> Version -> Version
data VersionRange
-- | The version range -any. That is, a version range containing
-- all versions.
--
--
-- withinRange v anyVersion = True
--
anyVersion :: VersionRange
-- | The empty version range, that is a version range containing no
-- versions.
--
-- This can be constructed using any unsatisfiable version range
-- expression, for example < 0.
--
--
-- withinRange v noVersion = False
--
noVersion :: VersionRange
-- | The version range == v
--
--
-- withinRange v' (thisVersion v) = v' == v
--
thisVersion :: Version -> VersionRange
-- | The version range || v
--
--
-- withinRange v' (notThisVersion v) = v' /= v
--
notThisVersion :: Version -> VersionRange
-- | The version range > v
--
--
-- withinRange v' (laterVersion v) = v' > v
--
laterVersion :: Version -> VersionRange
-- | The version range < v
--
--
-- withinRange v' (earlierVersion v) = v' < v
--
earlierVersion :: Version -> VersionRange
-- | The version range >= v
--
--
-- withinRange v' (orLaterVersion v) = v' >= v
--
orLaterVersion :: Version -> VersionRange
-- | The version range <= v
--
--
-- withinRange v' (orEarlierVersion v) = v' <= v
--
orEarlierVersion :: Version -> VersionRange
-- | The version range vr1 || vr2
--
--
-- withinRange v' (unionVersionRanges vr1 vr2)
-- = withinRange v' vr1 || withinRange v' vr2
--
unionVersionRanges :: VersionRange -> VersionRange -> VersionRange
-- | The version range vr1 && vr2
--
--
-- withinRange v' (intersectVersionRanges vr1 vr2)
-- = withinRange v' vr1 && withinRange v' vr2
--
intersectVersionRanges :: VersionRange -> VersionRange -> VersionRange
-- | The version range == v.*.
--
-- For example, for version 1.2, the version range ==
-- 1.2.* is the same as >= 1.2 && < 1.3
--
--
-- withinRange v' (laterVersion v) = v' >= v && v' < upper v
-- where
-- upper (Version lower t) = Version (init lower ++ [last lower + 1]) t
--
withinVersion :: Version -> VersionRange
-- | The version range ^>= v.
--
-- For example, for version 1.2.3.4, the version range
-- ^>= 1.2.3.4 is the same as >= 1.2.3.4 &&
-- < 1.3.
--
-- Note that ^>= 1 is equivalent to >= 1 &&
-- < 1.1.
majorBoundVersion :: Version -> VersionRange
-- | Does this version fall within the given range?
--
-- This is the evaluation function for the VersionRange type.
withinRange :: Version -> VersionRange -> Bool
-- | Does this VersionRange place any restriction on the
-- Version or is it in fact equivalent to AnyVersion.
--
-- Note this is a semantic check, not simply a syntactic check. So for
-- example the following is True (for all v).
--
--
-- isAnyVersion (EarlierVersion v `UnionVersionRanges` orLaterVersion v)
--
isAnyVersion :: VersionRange -> Bool
-- | This is the converse of isAnyVersion. It check if the version
-- range is empty, if there is no possible version that satisfies the
-- version range.
--
-- For example this is True (for all v):
--
--
-- isNoVersion (EarlierVersion v `IntersectVersionRanges` LaterVersion v)
--
isNoVersion :: VersionRange -> Bool
-- | Is this version range in fact just a specific version?
--
-- For example the version range ">= 3 && <= 3"
-- contains only the version 3.
isSpecificVersion :: VersionRange -> Maybe Version
-- | Simplify a VersionRange expression. For non-empty version
-- ranges this produces a canonical form. Empty or inconsistent version
-- ranges are left as-is because that provides more information.
--
-- If you need a canonical form use fromVersionIntervals .
-- toVersionIntervals
--
-- It satisfies the following properties:
--
--
-- withinRange v (simplifyVersionRange r) = withinRange v r
--
--
--
-- withinRange v r = withinRange v r'
-- ==> simplifyVersionRange r = simplifyVersionRange r'
-- || isNoVersion r
-- || isNoVersion r'
--
simplifyVersionRange :: VersionRange -> VersionRange
-- | Fold over the basic syntactic structure of a VersionRange.
--
-- This provides a syntactic view of the expression defining the version
-- range. The syntactic sugar ">= v", "<= v" and
-- "== v.*" is presented in terms of the other basic syntax.
--
-- For a semantic view use asVersionIntervals.
foldVersionRange :: a -> (Version -> a) -> (Version -> a) -> (Version -> a) -> (a -> a -> a) -> (a -> a -> a) -> VersionRange -> a
-- | Normalise VersionRange.
--
-- In particular collapse (== v || > v) into >=
-- v, and so on.
normaliseVersionRange :: VersionRange -> VersionRange
-- | Remove VersionRangeParens constructors.
--
-- Since version 3.4 this function is id, there aren't
-- VersionRangeParens constructor in VersionRange
-- anymore.
stripParensVersionRange :: VersionRange -> VersionRange
-- | Does the version range have an upper bound?
hasUpperBound :: VersionRange -> Bool
-- | Does the version range have an explicit lower bound?
--
-- Note: this function only considers the user-specified lower bounds,
-- but not the implicit >=0 lower bound.
hasLowerBound :: VersionRange -> Bool
-- | F-Algebra of VersionRange. See cataVersionRange.
data VersionRangeF a
ThisVersionF :: Version -> VersionRangeF a
LaterVersionF :: Version -> VersionRangeF a
OrLaterVersionF :: Version -> VersionRangeF a
EarlierVersionF :: Version -> VersionRangeF a
OrEarlierVersionF :: Version -> VersionRangeF a
MajorBoundVersionF :: Version -> VersionRangeF a
UnionVersionRangesF :: a -> a -> VersionRangeF a
IntersectVersionRangesF :: a -> a -> VersionRangeF a
-- | Fold VersionRange.
cataVersionRange :: (VersionRangeF a -> a) -> VersionRange -> a
-- | Unfold VersionRange.
anaVersionRange :: (a -> VersionRangeF a) -> a -> VersionRange
-- | Refold VersionRange
hyloVersionRange :: (VersionRangeF VersionRange -> VersionRange) -> (VersionRange -> VersionRangeF VersionRange) -> VersionRange -> VersionRange
projectVersionRange :: VersionRange -> VersionRangeF VersionRange
embedVersionRange :: VersionRangeF VersionRange -> VersionRange
wildcardUpperBound :: Version -> Version
-- | Compute next greater major version to be used as upper bound
--
-- Example: 0.4.1 produces the version 0.5 which then
-- can be used to construct a range >= 0.4.1 && <
-- 0.5
majorUpperBound :: Version -> Version
-- | Given a version range, remove the highest upper bound. Example:
-- (>= 1 && < 3) || (>= 4 && < 5) is
-- converted to (>= 1 && || (= 4).
removeUpperBound :: VersionRange -> VersionRange
-- | Given a version range, remove the lowest lower bound. Example:
-- (>= 1 && || (= 4 && < 5) is
-- converted to (>= 0 && || (= 4 && <
-- 5).
removeLowerBound :: VersionRange -> VersionRange
-- | Rewrite ^>= x.y.z into >= x.y.z && <
-- x.(y+1)
transformCaret :: VersionRange -> VersionRange
-- | Rewrite ^>= x.y.z into >= x.y.z
transformCaretUpper :: VersionRange -> VersionRange
-- | Rewrite ^>= x.y.z into <x.(y+1)
transformCaretLower :: VersionRange -> VersionRange
-- | View a VersionRange as a union of intervals.
--
-- This provides a canonical view of the semantics of a
-- VersionRange as opposed to the syntax of the expression used to
-- define it. For the syntactic view use foldVersionRange.
--
-- Each interval is non-empty. The sequence is in increasing order and no
-- intervals overlap or touch. Therefore only the first and last can be
-- unbounded. The sequence can be empty if the range is empty (e.g. a
-- range expression like && 2).
--
-- Other checks are trivial to implement using this view. For example:
--
--
-- isNoVersion vr | [] <- asVersionIntervals vr = True
-- | otherwise = False
--
--
--
-- isSpecificVersion vr
-- | [(LowerBound v InclusiveBound
-- ,UpperBound v' InclusiveBound)] <- asVersionIntervals vr
-- , v == v' = Just v
-- | otherwise = Nothing
--
asVersionIntervals :: VersionRange -> [VersionInterval]
data VersionInterval
VersionInterval :: !LowerBound -> !UpperBound -> VersionInterval
data LowerBound
LowerBound :: !Version -> !Bound -> LowerBound
data UpperBound
NoUpperBound :: UpperBound
UpperBound :: !Version -> !Bound -> UpperBound
data Bound
ExclusiveBound :: Bound
InclusiveBound :: Bound
-- | A complementary representation of a VersionRange. Instead of a
-- boolean version predicate it uses an increasing sequence of
-- non-overlapping, non-empty intervals.
--
-- The key point is that this representation gives a canonical
-- representation for the semantics of VersionRanges. This makes
-- it easier to check things like whether a version range is empty,
-- covers all versions, or requires a certain minimum or maximum version.
-- It also makes it easy to check equality or containment. It also makes
-- it easier to identify 'simple' version predicates for translation into
-- foreign packaging systems that do not support complex version range
-- expressions.
data VersionIntervals
-- | Convert a VersionRange to a sequence of version intervals.
toVersionIntervals :: VersionRange -> VersionIntervals
-- | Convert a VersionIntervals value back into a
-- VersionRange expression representing the version intervals.
fromVersionIntervals :: VersionIntervals -> VersionRange
-- | Inspect the list of version intervals.
unVersionIntervals :: VersionIntervals -> [VersionInterval]
module Distribution.Types.TestType
-- | The "test-type" field in the test suite stanza.
data TestType
-- | "type: exitcode-stdio-x.y"
TestTypeExe :: Version -> TestType
-- | "type: detailed-x.y"
TestTypeLib :: Version -> TestType
-- | Some unknown test type e.g. "type: foo"
TestTypeUnknown :: String -> Version -> TestType
knownTestTypes :: [TestType]
instance Data.Data.Data Distribution.Types.TestType.TestType
instance GHC.Classes.Eq Distribution.Types.TestType.TestType
instance GHC.Read.Read Distribution.Types.TestType.TestType
instance GHC.Show.Show Distribution.Types.TestType.TestType
instance GHC.Generics.Generic Distribution.Types.TestType.TestType
instance Data.Binary.Class.Binary Distribution.Types.TestType.TestType
instance Distribution.Utils.Structured.Structured Distribution.Types.TestType.TestType
instance Control.DeepSeq.NFData Distribution.Types.TestType.TestType
instance Distribution.Pretty.Pretty Distribution.Types.TestType.TestType
instance Distribution.Parsec.Parsec Distribution.Types.TestType.TestType
module Distribution.Types.TestSuiteInterface
-- | The test suite interfaces that are currently defined. Each test suite
-- must specify which interface it supports.
--
-- More interfaces may be defined in future, either new revisions or
-- totally new interfaces.
data TestSuiteInterface
-- | Test interface "exitcode-stdio-1.0". The test-suite takes the form of
-- an executable. It returns a zero exit code for success, non-zero for
-- failure. The stdout and stderr channels may be logged. It takes no
-- command line parameters and nothing on stdin.
TestSuiteExeV10 :: Version -> FilePath -> TestSuiteInterface
-- | Test interface "detailed-0.9". The test-suite takes the form of a
-- library containing a designated module that exports "tests :: [Test]".
TestSuiteLibV09 :: Version -> ModuleName -> TestSuiteInterface
-- | A test suite that does not conform to one of the above interfaces for
-- the given reason (e.g. unknown test type).
TestSuiteUnsupported :: TestType -> TestSuiteInterface
instance Data.Data.Data Distribution.Types.TestSuiteInterface.TestSuiteInterface
instance GHC.Show.Show Distribution.Types.TestSuiteInterface.TestSuiteInterface
instance GHC.Read.Read Distribution.Types.TestSuiteInterface.TestSuiteInterface
instance GHC.Generics.Generic Distribution.Types.TestSuiteInterface.TestSuiteInterface
instance GHC.Classes.Eq Distribution.Types.TestSuiteInterface.TestSuiteInterface
instance Data.Binary.Class.Binary Distribution.Types.TestSuiteInterface.TestSuiteInterface
instance Distribution.Utils.Structured.Structured Distribution.Types.TestSuiteInterface.TestSuiteInterface
instance Control.DeepSeq.NFData Distribution.Types.TestSuiteInterface.TestSuiteInterface
instance GHC.Base.Monoid Distribution.Types.TestSuiteInterface.TestSuiteInterface
instance GHC.Base.Semigroup Distribution.Types.TestSuiteInterface.TestSuiteInterface
module Distribution.Types.PackageId
-- | The name and version of a package.
data PackageIdentifier
PackageIdentifier :: PackageName -> Version -> PackageIdentifier
-- | The name of this package, eg. foo
[pkgName] :: PackageIdentifier -> PackageName
-- | the version of this package, eg 1.2
[pkgVersion] :: PackageIdentifier -> Version
-- | Type alias so we can use the shorter name PackageId.
type PackageId = PackageIdentifier
instance Data.Data.Data Distribution.Types.PackageId.PackageIdentifier
instance GHC.Classes.Ord Distribution.Types.PackageId.PackageIdentifier
instance GHC.Classes.Eq Distribution.Types.PackageId.PackageIdentifier
instance GHC.Show.Show Distribution.Types.PackageId.PackageIdentifier
instance GHC.Read.Read Distribution.Types.PackageId.PackageIdentifier
instance GHC.Generics.Generic Distribution.Types.PackageId.PackageIdentifier
instance Data.Binary.Class.Binary Distribution.Types.PackageId.PackageIdentifier
instance Distribution.Utils.Structured.Structured Distribution.Types.PackageId.PackageIdentifier
instance Distribution.Pretty.Pretty Distribution.Types.PackageId.PackageIdentifier
instance Distribution.Parsec.Parsec Distribution.Types.PackageId.PackageIdentifier
instance Control.DeepSeq.NFData Distribution.Types.PackageId.PackageIdentifier
module Distribution.Types.UnitId
-- | A unit identifier identifies a (possibly instantiated)
-- package/component that can be installed the installed package
-- database. There are several types of components that can be installed:
--
--
-- - A traditional library with no holes, so that unitIdHash
-- is Nothing. In the absence of Backpack, UnitId is the
-- same as a ComponentId.
-- - An indefinite, Backpack library with holes. In this case,
-- unitIdHash is still Nothing, but in the install,
-- there are only interfaces, no compiled objects.
-- - An instantiated Backpack library with all the holes filled in.
-- unitIdHash is a Just a hash of the instantiating
-- mapping.
--
--
-- A unit is a component plus the additional information on how the holes
-- are filled in. Thus there is a one to many relationship: for a
-- particular component there are many different ways of filling in the
-- holes, and each different combination is a unit (and has a separate
-- UnitId).
--
-- UnitId is distinct from OpenUnitId, in that it is
-- always installed, whereas OpenUnitId are intermediate unit
-- identities that arise during mixin linking, and don't necessarily
-- correspond to any actually installed unit. Since the mapping is not
-- actually recorded in a UnitId, you can't actually substitute
-- over them (but you can substitute over OpenUnitId). See also
-- Distribution.Backpack.FullUnitId for a mechanism for expanding
-- an instantiated UnitId to retrieve its mapping.
--
-- Backwards compatibility note: if you need to get the string
-- representation of a UnitId to pass, e.g., as a -package-id
-- flag, use the display function, which will work on all
-- versions of Cabal.
data UnitId
-- | If you need backwards compatibility, consider using display
-- instead, which is supported by all versions of Cabal.
unUnitId :: UnitId -> String
mkUnitId :: String -> UnitId
-- | A UnitId for a definite package. The DefUnitId invariant
-- says that a UnitId identified this way is definite; i.e., it
-- has no unfilled holes.
data DefUnitId
-- | Unsafely create a DefUnitId from a UnitId. Your
-- responsibility is to ensure that the DefUnitId invariant holds.
unsafeMkDefUnitId :: UnitId -> DefUnitId
unDefUnitId :: DefUnitId -> UnitId
-- | Create a unit identity with no associated hash directly from a
-- ComponentId.
newSimpleUnitId :: ComponentId -> UnitId
-- | Make an old-style UnitId from a package identifier. Assumed to be for
-- the public library
mkLegacyUnitId :: PackageId -> UnitId
-- | Returns library name prefixed with HS, suitable for filenames
getHSLibraryName :: UnitId -> String
instance Control.DeepSeq.NFData Distribution.Types.UnitId.UnitId
instance Data.Data.Data Distribution.Types.UnitId.UnitId
instance GHC.Classes.Ord Distribution.Types.UnitId.UnitId
instance GHC.Classes.Eq Distribution.Types.UnitId.UnitId
instance GHC.Show.Show Distribution.Types.UnitId.UnitId
instance GHC.Read.Read Distribution.Types.UnitId.UnitId
instance GHC.Generics.Generic Distribution.Types.UnitId.UnitId
instance Distribution.Pretty.Pretty Distribution.Types.UnitId.DefUnitId
instance Control.DeepSeq.NFData Distribution.Types.UnitId.DefUnitId
instance Data.Binary.Class.Binary Distribution.Types.UnitId.DefUnitId
instance Data.Data.Data Distribution.Types.UnitId.DefUnitId
instance GHC.Classes.Ord Distribution.Types.UnitId.DefUnitId
instance GHC.Classes.Eq Distribution.Types.UnitId.DefUnitId
instance GHC.Show.Show Distribution.Types.UnitId.DefUnitId
instance GHC.Read.Read Distribution.Types.UnitId.DefUnitId
instance GHC.Generics.Generic Distribution.Types.UnitId.DefUnitId
instance Distribution.Utils.Structured.Structured Distribution.Types.UnitId.DefUnitId
instance Distribution.Parsec.Parsec Distribution.Types.UnitId.DefUnitId
instance Data.Binary.Class.Binary Distribution.Types.UnitId.UnitId
instance Distribution.Utils.Structured.Structured Distribution.Types.UnitId.UnitId
instance Distribution.Pretty.Pretty Distribution.Types.UnitId.UnitId
instance Distribution.Parsec.Parsec Distribution.Types.UnitId.UnitId
instance Data.String.IsString Distribution.Types.UnitId.UnitId
module Distribution.Types.Module
-- | A module identity uniquely identifies a Haskell module by qualifying a
-- ModuleName with the UnitId which defined it. This type
-- distinguishes between two packages which provide a module with the
-- same name, or a module from the same package compiled with different
-- dependencies. There are a few cases where Cabal needs to know about
-- module identities, e.g., when writing out reexported modules in the
-- InstalledPackageInfo.
data Module
Module :: DefUnitId -> ModuleName -> Module
instance Data.Data.Data Distribution.Types.Module.Module
instance GHC.Classes.Ord Distribution.Types.Module.Module
instance GHC.Classes.Eq Distribution.Types.Module.Module
instance GHC.Show.Show Distribution.Types.Module.Module
instance GHC.Read.Read Distribution.Types.Module.Module
instance GHC.Generics.Generic Distribution.Types.Module.Module
instance Data.Binary.Class.Binary Distribution.Types.Module.Module
instance Distribution.Utils.Structured.Structured Distribution.Types.Module.Module
instance Distribution.Pretty.Pretty Distribution.Types.Module.Module
instance Distribution.Parsec.Parsec Distribution.Types.Module.Module
instance Control.DeepSeq.NFData Distribution.Types.Module.Module
-- | This module defines the core data types for Backpack. For more
-- details, see:
--
--
-- https://github.com/ezyang/ghc-proposals/blob/backpack/proposals/0000-backpack.rst
module Distribution.Backpack
-- | An OpenUnitId describes a (possibly partially) instantiated
-- Backpack component, with a description of how the holes are filled in.
-- Unlike OpenUnitId, the ModuleSubst is kept in a
-- structured form that allows for substitution (which fills in holes.)
-- This form of unit cannot be installed. It must first be converted to a
-- UnitId.
--
-- In the absence of Backpack, there are no holes to fill, so any such
-- component always has an empty module substitution; thus we can lossly
-- represent it as an 'OpenUnitId uid'.
--
-- For a source component using Backpack, however, there is more
-- structure as components may be parametrized over some signatures, and
-- these "holes" may be partially or wholly filled.
--
-- OpenUnitId plays an important role when we are mix-in linking, and is
-- recorded to the installed packaged database for indefinite packages;
-- however, for compiled packages that are fully instantiated, we
-- instantiate OpenUnitId into UnitId.
--
-- For more details see the Backpack spec
-- https://github.com/ezyang/ghc-proposals/blob/backpack/proposals/0000-backpack.rst
data OpenUnitId
-- | Identifies a component which may have some unfilled holes; specifying
-- its ComponentId and its OpenModuleSubst. TODO: Invariant
-- that OpenModuleSubst is non-empty? See also the Text instance.
IndefFullUnitId :: ComponentId -> OpenModuleSubst -> OpenUnitId
-- | Identifies a fully instantiated component, which has been compiled and
-- abbreviated as a hash. The embedded UnitId MUST NOT be for an
-- indefinite component; an OpenUnitId is guaranteed not to have
-- any holes.
DefiniteUnitId :: DefUnitId -> OpenUnitId
-- | Get the set of holes (ModuleVar) embedded in a UnitId.
openUnitIdFreeHoles :: OpenUnitId -> Set ModuleName
-- | Safe constructor from a UnitId. The only way to do this safely is if
-- the instantiation is provided.
mkOpenUnitId :: UnitId -> ComponentId -> OpenModuleSubst -> OpenUnitId
-- | A UnitId for a definite package. The DefUnitId invariant
-- says that a UnitId identified this way is definite; i.e., it
-- has no unfilled holes.
data DefUnitId
unDefUnitId :: DefUnitId -> UnitId
-- | Create a DefUnitId from a ComponentId and an
-- instantiation with no holes.
mkDefUnitId :: ComponentId -> Map ModuleName Module -> DefUnitId
-- | Unlike a Module, an OpenModule is either an ordinary
-- module from some unit, OR an OpenModuleVar, representing a hole
-- that needs to be filled in. Substitutions are over module variables.
data OpenModule
OpenModule :: OpenUnitId -> ModuleName -> OpenModule
OpenModuleVar :: ModuleName -> OpenModule
-- | Get the set of holes (ModuleVar) embedded in a Module.
openModuleFreeHoles :: OpenModule -> Set ModuleName
-- | An explicit substitution on modules.
--
-- NB: These substitutions are NOT idempotent, for example, a valid
-- substitution is (A -> B, B -> A).
type OpenModuleSubst = Map ModuleName OpenModule
-- | Pretty-print the entries of a module substitution, suitable for
-- embedding into a OpenUnitId or passing to GHC via
-- --instantiate-with.
dispOpenModuleSubst :: OpenModuleSubst -> Doc
-- | Pretty-print a single entry of a module substitution.
dispOpenModuleSubstEntry :: (ModuleName, OpenModule) -> Doc
-- | Inverse to dispModSubst.
parsecOpenModuleSubst :: CabalParsing m => m OpenModuleSubst
-- | Inverse to dispModSubstEntry.
parsecOpenModuleSubstEntry :: CabalParsing m => m (ModuleName, OpenModule)
-- | Get the set of holes (ModuleVar) embedded in a
-- OpenModuleSubst. This is NOT the domain of the substitution.
openModuleSubstFreeHoles :: OpenModuleSubst -> Set ModuleName
-- | When typechecking, we don't demand that a freshly instantiated
-- IndefFullUnitId be compiled; instead, we just depend on the
-- installed indefinite unit installed at the ComponentId.
abstractUnitId :: OpenUnitId -> UnitId
-- | Take a module substitution and hash it into a string suitable for
-- UnitId. Note that since this takes Module, not
-- OpenModule, you are responsible for recursively converting
-- OpenModule into Module. See also
-- Distribution.Backpack.ReadyComponent.
hashModuleSubst :: Map ModuleName Module -> Maybe String
instance Data.Data.Data Distribution.Backpack.OpenUnitId
instance GHC.Classes.Ord Distribution.Backpack.OpenUnitId
instance GHC.Classes.Eq Distribution.Backpack.OpenUnitId
instance GHC.Show.Show Distribution.Backpack.OpenUnitId
instance GHC.Read.Read Distribution.Backpack.OpenUnitId
instance GHC.Generics.Generic Distribution.Backpack.OpenUnitId
instance Data.Data.Data Distribution.Backpack.OpenModule
instance GHC.Classes.Ord Distribution.Backpack.OpenModule
instance GHC.Classes.Eq Distribution.Backpack.OpenModule
instance GHC.Show.Show Distribution.Backpack.OpenModule
instance GHC.Read.Read Distribution.Backpack.OpenModule
instance GHC.Generics.Generic Distribution.Backpack.OpenModule
instance Data.Binary.Class.Binary Distribution.Backpack.OpenUnitId
instance Distribution.Utils.Structured.Structured Distribution.Backpack.OpenUnitId
instance Control.DeepSeq.NFData Distribution.Backpack.OpenUnitId
instance Distribution.Pretty.Pretty Distribution.Backpack.OpenUnitId
instance Distribution.Parsec.Parsec Distribution.Backpack.OpenUnitId
instance Data.Binary.Class.Binary Distribution.Backpack.OpenModule
instance Distribution.Utils.Structured.Structured Distribution.Backpack.OpenModule
instance Control.DeepSeq.NFData Distribution.Backpack.OpenModule
instance Distribution.Pretty.Pretty Distribution.Backpack.OpenModule
instance Distribution.Parsec.Parsec Distribution.Backpack.OpenModule
module Distribution.Types.ExposedModule
data ExposedModule
ExposedModule :: ModuleName -> Maybe OpenModule -> ExposedModule
[exposedName] :: ExposedModule -> ModuleName
[exposedReexport] :: ExposedModule -> Maybe OpenModule
instance GHC.Show.Show Distribution.Types.ExposedModule.ExposedModule
instance GHC.Read.Read Distribution.Types.ExposedModule.ExposedModule
instance GHC.Generics.Generic Distribution.Types.ExposedModule.ExposedModule
instance GHC.Classes.Eq Distribution.Types.ExposedModule.ExposedModule
instance Distribution.Pretty.Pretty Distribution.Types.ExposedModule.ExposedModule
instance Distribution.Parsec.Parsec Distribution.Types.ExposedModule.ExposedModule
instance Data.Binary.Class.Binary Distribution.Types.ExposedModule.ExposedModule
instance Distribution.Utils.Structured.Structured Distribution.Types.ExposedModule.ExposedModule
instance Control.DeepSeq.NFData Distribution.Types.ExposedModule.ExposedModule
-- | A type class ModSubst for objects which can have
-- ModuleSubst applied to them.
--
-- See also
-- https://github.com/ezyang/ghc-proposals/blob/backpack/proposals/0000-backpack.rst
module Distribution.Backpack.ModSubst
-- | Applying module substitutions to semantic objects.
class ModSubst a
modSubst :: ModSubst a => OpenModuleSubst -> a -> a
instance Distribution.Backpack.ModSubst.ModSubst Distribution.Backpack.OpenModule
instance Distribution.Backpack.ModSubst.ModSubst Distribution.Backpack.OpenUnitId
instance Distribution.Backpack.ModSubst.ModSubst (Data.Set.Internal.Set Distribution.ModuleName.ModuleName)
instance Distribution.Backpack.ModSubst.ModSubst a => Distribution.Backpack.ModSubst.ModSubst (Data.Map.Internal.Map k a)
instance Distribution.Backpack.ModSubst.ModSubst a => Distribution.Backpack.ModSubst.ModSubst [a]
instance Distribution.Backpack.ModSubst.ModSubst a => Distribution.Backpack.ModSubst.ModSubst (k, a)
module Distribution.Backpack.FullUnitId
data FullUnitId
FullUnitId :: ComponentId -> OpenModuleSubst -> FullUnitId
type FullDb = DefUnitId -> FullUnitId
expandOpenUnitId :: FullDb -> OpenUnitId -> FullUnitId
expandUnitId :: FullDb -> DefUnitId -> FullUnitId
instance GHC.Generics.Generic Distribution.Backpack.FullUnitId.FullUnitId
instance GHC.Show.Show Distribution.Backpack.FullUnitId.FullUnitId
module Distribution.Types.PackageVersionConstraint
-- | A version constraint on a package. Different from
-- ExeDependency and Dependency since it does not
-- specify the need for a component, not even the main library. There are
-- a few places in the codebase where Dependency was used where
-- PackageVersionConstraint is not used instead (#5570).
data PackageVersionConstraint
PackageVersionConstraint :: PackageName -> VersionRange -> PackageVersionConstraint
thisPackageVersionConstraint :: PackageIdentifier -> PackageVersionConstraint
simplifyPackageVersionConstraint :: PackageVersionConstraint -> PackageVersionConstraint
instance Data.Data.Data Distribution.Types.PackageVersionConstraint.PackageVersionConstraint
instance GHC.Classes.Eq Distribution.Types.PackageVersionConstraint.PackageVersionConstraint
instance GHC.Show.Show Distribution.Types.PackageVersionConstraint.PackageVersionConstraint
instance GHC.Read.Read Distribution.Types.PackageVersionConstraint.PackageVersionConstraint
instance GHC.Generics.Generic Distribution.Types.PackageVersionConstraint.PackageVersionConstraint
instance Data.Binary.Class.Binary Distribution.Types.PackageVersionConstraint.PackageVersionConstraint
instance Distribution.Utils.Structured.Structured Distribution.Types.PackageVersionConstraint.PackageVersionConstraint
instance Control.DeepSeq.NFData Distribution.Types.PackageVersionConstraint.PackageVersionConstraint
instance Distribution.Pretty.Pretty Distribution.Types.PackageVersionConstraint.PackageVersionConstraint
instance Distribution.Parsec.Parsec Distribution.Types.PackageVersionConstraint.PackageVersionConstraint
-- | Magic PackageNames.
module Distribution.Types.PackageName.Magic
-- | Used as a placeholder in Distribution.Backpack.ReadyComponent
nonExistentPackageThisIsCabalBug :: PackageName
-- | Used by cabal new-repl and cabal new-run
fakePackageName :: PackageName
-- | fakePackageName with version0.
fakePackageId :: PackageId
module Distribution.Types.PackageId.Lens
-- | The name and version of a package.
data PackageIdentifier
pkgName :: Lens' PackageIdentifier PackageName
pkgVersion :: Lens' PackageIdentifier Version
module Distribution.Types.MungedPackageId
-- | A simple pair of a MungedPackageName and Version.
-- MungedPackageName is to MungedPackageId as
-- PackageName is to PackageId. See
-- MungedPackageName for more info.
data MungedPackageId
MungedPackageId :: MungedPackageName -> Version -> MungedPackageId
-- | The combined package and component name. see documentation for
-- MungedPackageName.
[mungedName] :: MungedPackageId -> MungedPackageName
-- | The version of this package / component, eg 1.2
[mungedVersion] :: MungedPackageId -> Version
computeCompatPackageId :: PackageId -> LibraryName -> MungedPackageId
instance Data.Data.Data Distribution.Types.MungedPackageId.MungedPackageId
instance GHC.Classes.Ord Distribution.Types.MungedPackageId.MungedPackageId
instance GHC.Classes.Eq Distribution.Types.MungedPackageId.MungedPackageId
instance GHC.Show.Show Distribution.Types.MungedPackageId.MungedPackageId
instance GHC.Read.Read Distribution.Types.MungedPackageId.MungedPackageId
instance GHC.Generics.Generic Distribution.Types.MungedPackageId.MungedPackageId
instance Data.Binary.Class.Binary Distribution.Types.MungedPackageId.MungedPackageId
instance Distribution.Utils.Structured.Structured Distribution.Types.MungedPackageId.MungedPackageId
instance Distribution.Pretty.Pretty Distribution.Types.MungedPackageId.MungedPackageId
instance Distribution.Parsec.Parsec Distribution.Types.MungedPackageId.MungedPackageId
instance Control.DeepSeq.NFData Distribution.Types.MungedPackageId.MungedPackageId
module Distribution.Types.LegacyExeDependency
-- | Describes a legacy `build-tools`-style dependency on an executable
--
-- It is "legacy" because we do not know what the build-tool referred to.
-- It could refer to a pkg-config executable (PkgconfigName), or an
-- internal executable (UnqualComponentName). Thus the name is stringly
-- typed.
data LegacyExeDependency
LegacyExeDependency :: String -> VersionRange -> LegacyExeDependency
instance Data.Data.Data Distribution.Types.LegacyExeDependency.LegacyExeDependency
instance GHC.Classes.Eq Distribution.Types.LegacyExeDependency.LegacyExeDependency
instance GHC.Show.Show Distribution.Types.LegacyExeDependency.LegacyExeDependency
instance GHC.Read.Read Distribution.Types.LegacyExeDependency.LegacyExeDependency
instance GHC.Generics.Generic Distribution.Types.LegacyExeDependency.LegacyExeDependency
instance Data.Binary.Class.Binary Distribution.Types.LegacyExeDependency.LegacyExeDependency
instance Distribution.Utils.Structured.Structured Distribution.Types.LegacyExeDependency.LegacyExeDependency
instance Control.DeepSeq.NFData Distribution.Types.LegacyExeDependency.LegacyExeDependency
instance Distribution.Pretty.Pretty Distribution.Types.LegacyExeDependency.LegacyExeDependency
instance Distribution.Parsec.Parsec Distribution.Types.LegacyExeDependency.LegacyExeDependency
module Distribution.Types.ExeDependency
-- | Describes a dependency on an executable from a package
data ExeDependency
ExeDependency :: PackageName -> UnqualComponentName -> VersionRange -> ExeDependency
qualifiedExeName :: ExeDependency -> ComponentName
instance Data.Data.Data Distribution.Types.ExeDependency.ExeDependency
instance GHC.Classes.Eq Distribution.Types.ExeDependency.ExeDependency
instance GHC.Show.Show Distribution.Types.ExeDependency.ExeDependency
instance GHC.Read.Read Distribution.Types.ExeDependency.ExeDependency
instance GHC.Generics.Generic Distribution.Types.ExeDependency.ExeDependency
instance Data.Binary.Class.Binary Distribution.Types.ExeDependency.ExeDependency
instance Distribution.Utils.Structured.Structured Distribution.Types.ExeDependency.ExeDependency
instance Control.DeepSeq.NFData Distribution.Types.ExeDependency.ExeDependency
instance Distribution.Pretty.Pretty Distribution.Types.ExeDependency.ExeDependency
instance Distribution.Parsec.Parsec Distribution.Types.ExeDependency.ExeDependency
module Distribution.Types.Dependency
-- | Describes a dependency on a source package (API)
--
-- Invariant: package name does not appear as LSubLibName
-- in set of library names.
data Dependency
-- | The set of libraries required from the package. Only the selected
-- libraries will be built. It does not affect the cabal-install solver
-- yet.
Dependency :: PackageName -> VersionRange -> NonEmptySet LibraryName -> Dependency
-- | Smart constructor of Dependency.
--
-- If PackageName is appears as LSubLibName in a set of
-- sublibraries, it is automatically converted to LMainLibName.
mkDependency :: PackageName -> VersionRange -> NonEmptySet LibraryName -> Dependency
depPkgName :: Dependency -> PackageName
depVerRange :: Dependency -> VersionRange
depLibraries :: Dependency -> NonEmptySet LibraryName
-- | Simplify the VersionRange expression in a Dependency.
-- See simplifyVersionRange.
simplifyDependency :: Dependency -> Dependency
-- | Library set with main library.
mainLibSet :: NonEmptySet LibraryName
instance Data.Data.Data Distribution.Types.Dependency.Dependency
instance GHC.Classes.Eq Distribution.Types.Dependency.Dependency
instance GHC.Show.Show Distribution.Types.Dependency.Dependency
instance GHC.Read.Read Distribution.Types.Dependency.Dependency
instance GHC.Generics.Generic Distribution.Types.Dependency.Dependency
instance Data.Binary.Class.Binary Distribution.Types.Dependency.Dependency
instance Distribution.Utils.Structured.Structured Distribution.Types.Dependency.Dependency
instance Control.DeepSeq.NFData Distribution.Types.Dependency.Dependency
instance Distribution.Pretty.Pretty Distribution.Types.Dependency.Dependency
instance Distribution.Parsec.Parsec Distribution.Types.Dependency.Dependency
module Distribution.Types.SetupBuildInfo
data SetupBuildInfo
SetupBuildInfo :: [Dependency] -> Bool -> SetupBuildInfo
[setupDepends] :: SetupBuildInfo -> [Dependency]
-- | Is this a default 'custom-setup' section added by the cabal-install
-- code (as opposed to user-provided)? This field is only used
-- internally, and doesn't correspond to anything in the .cabal file. See
-- #3199.
[defaultSetupDepends] :: SetupBuildInfo -> Bool
instance Data.Data.Data Distribution.Types.SetupBuildInfo.SetupBuildInfo
instance GHC.Read.Read Distribution.Types.SetupBuildInfo.SetupBuildInfo
instance GHC.Classes.Eq Distribution.Types.SetupBuildInfo.SetupBuildInfo
instance GHC.Show.Show Distribution.Types.SetupBuildInfo.SetupBuildInfo
instance GHC.Generics.Generic Distribution.Types.SetupBuildInfo.SetupBuildInfo
instance Data.Binary.Class.Binary Distribution.Types.SetupBuildInfo.SetupBuildInfo
instance Distribution.Utils.Structured.Structured Distribution.Types.SetupBuildInfo.SetupBuildInfo
instance Control.DeepSeq.NFData Distribution.Types.SetupBuildInfo.SetupBuildInfo
instance GHC.Base.Monoid Distribution.Types.SetupBuildInfo.SetupBuildInfo
instance GHC.Base.Semigroup Distribution.Types.SetupBuildInfo.SetupBuildInfo
module Distribution.Types.SetupBuildInfo.Lens
data SetupBuildInfo
setupDepends :: Lens' SetupBuildInfo [Dependency]
defaultSetupDepends :: Lens' SetupBuildInfo Bool
module Distribution.Types.DependencyMap
-- | A map of dependencies. Newtyped since the default monoid instance is
-- not appropriate. The monoid instance uses
-- intersectVersionRanges.
data DependencyMap
toDepMap :: [Dependency] -> DependencyMap
fromDepMap :: DependencyMap -> [Dependency]
constrainBy :: DependencyMap -> [PackageVersionConstraint] -> DependencyMap
instance GHC.Read.Read Distribution.Types.DependencyMap.DependencyMap
instance GHC.Show.Show Distribution.Types.DependencyMap.DependencyMap
instance GHC.Base.Monoid Distribution.Types.DependencyMap.DependencyMap
instance GHC.Base.Semigroup Distribution.Types.DependencyMap.DependencyMap
module Distribution.Types.BenchmarkType
-- | The "benchmark-type" field in the benchmark stanza.
data BenchmarkType
-- | "type: exitcode-stdio-x.y"
BenchmarkTypeExe :: Version -> BenchmarkType
-- | Some unknown benchmark type e.g. "type: foo"
BenchmarkTypeUnknown :: String -> Version -> BenchmarkType
knownBenchmarkTypes :: [BenchmarkType]
instance Data.Data.Data Distribution.Types.BenchmarkType.BenchmarkType
instance GHC.Classes.Eq Distribution.Types.BenchmarkType.BenchmarkType
instance GHC.Read.Read Distribution.Types.BenchmarkType.BenchmarkType
instance GHC.Show.Show Distribution.Types.BenchmarkType.BenchmarkType
instance GHC.Generics.Generic Distribution.Types.BenchmarkType.BenchmarkType
instance Data.Binary.Class.Binary Distribution.Types.BenchmarkType.BenchmarkType
instance Distribution.Utils.Structured.Structured Distribution.Types.BenchmarkType.BenchmarkType
instance Control.DeepSeq.NFData Distribution.Types.BenchmarkType.BenchmarkType
instance Distribution.Pretty.Pretty Distribution.Types.BenchmarkType.BenchmarkType
instance Distribution.Parsec.Parsec Distribution.Types.BenchmarkType.BenchmarkType
module Distribution.Types.BenchmarkInterface
-- | The benchmark interfaces that are currently defined. Each benchmark
-- must specify which interface it supports.
--
-- More interfaces may be defined in future, either new revisions or
-- totally new interfaces.
data BenchmarkInterface
-- | Benchmark interface "exitcode-stdio-1.0". The benchmark takes the form
-- of an executable. It returns a zero exit code for success, non-zero
-- for failure. The stdout and stderr channels may be logged. It takes no
-- command line parameters and nothing on stdin.
BenchmarkExeV10 :: Version -> FilePath -> BenchmarkInterface
-- | A benchmark that does not conform to one of the above interfaces for
-- the given reason (e.g. unknown benchmark type).
BenchmarkUnsupported :: BenchmarkType -> BenchmarkInterface
instance Data.Data.Data Distribution.Types.BenchmarkInterface.BenchmarkInterface
instance GHC.Show.Show Distribution.Types.BenchmarkInterface.BenchmarkInterface
instance GHC.Read.Read Distribution.Types.BenchmarkInterface.BenchmarkInterface
instance GHC.Generics.Generic Distribution.Types.BenchmarkInterface.BenchmarkInterface
instance GHC.Classes.Eq Distribution.Types.BenchmarkInterface.BenchmarkInterface
instance Data.Binary.Class.Binary Distribution.Types.BenchmarkInterface.BenchmarkInterface
instance Distribution.Utils.Structured.Structured Distribution.Types.BenchmarkInterface.BenchmarkInterface
instance Control.DeepSeq.NFData Distribution.Types.BenchmarkInterface.BenchmarkInterface
instance GHC.Base.Monoid Distribution.Types.BenchmarkInterface.BenchmarkInterface
instance GHC.Base.Semigroup Distribution.Types.BenchmarkInterface.BenchmarkInterface
-- | Defines a package identifier along with a parser and pretty printer
-- for it. PackageIdentifiers consist of a name and an exact
-- version. It also defines a Dependency data type. A dependency
-- is a package name and a version range, like "foo >= 1.2
-- && < 2".
module Distribution.Package
-- | Class of things that have a PackageIdentifier
--
-- Types in this class are all notions of a package. This allows us to
-- have different types for the different phases that packages go though,
-- from simple name/id, package description, configured or installed
-- packages.
--
-- Not all kinds of packages can be uniquely identified by a
-- PackageIdentifier. In particular, installed packages cannot,
-- there may be many installed instances of the same source package.
class Package pkg
packageId :: Package pkg => pkg -> PackageIdentifier
packageName :: Package pkg => pkg -> PackageName
packageVersion :: Package pkg => pkg -> Version
class HasMungedPackageId pkg
mungedId :: HasMungedPackageId pkg => pkg -> MungedPackageId
mungedName' :: HasMungedPackageId pkg => pkg -> MungedPackageName
mungedVersion' :: HasMungedPackageId munged => munged -> Version
-- | Packages that have an installed unit ID
class Package pkg => HasUnitId pkg
installedUnitId :: HasUnitId pkg => pkg -> UnitId
-- | Class of installed packages.
--
-- The primary data type which is an instance of this package is
-- InstalledPackageInfo, but when we are doing install plans in
-- Cabal install we may have other, installed package-like things which
-- contain more metadata. Installed packages have exact dependencies
-- installedDepends.
class (HasUnitId pkg) => PackageInstalled pkg
installedDepends :: PackageInstalled pkg => pkg -> [UnitId]
instance Distribution.Package.HasMungedPackageId Distribution.Types.MungedPackageId.MungedPackageId
instance Distribution.Package.Package Distribution.Types.PackageId.PackageIdentifier
module Distribution.Types.AnnotatedId
-- | An AnnotatedId is a ComponentId, UnitId, etc.
-- which is annotated with some other useful information that is useful
-- for printing to users, etc.
--
-- Invariant: if ann_id x == ann_id y, then ann_pid x == ann_pid y and
-- ann_cname x == ann_cname y
data AnnotatedId id
AnnotatedId :: PackageId -> ComponentName -> id -> AnnotatedId id
[ann_pid] :: AnnotatedId id -> PackageId
[ann_cname] :: AnnotatedId id -> ComponentName
[ann_id] :: AnnotatedId id -> id
instance GHC.Show.Show id => GHC.Show.Show (Distribution.Types.AnnotatedId.AnnotatedId id)
instance GHC.Classes.Eq id => GHC.Classes.Eq (Distribution.Types.AnnotatedId.AnnotatedId id)
instance GHC.Classes.Ord id => GHC.Classes.Ord (Distribution.Types.AnnotatedId.AnnotatedId id)
instance Distribution.Package.Package (Distribution.Types.AnnotatedId.AnnotatedId id)
instance GHC.Base.Functor Distribution.Types.AnnotatedId.AnnotatedId
module Distribution.Types.ComponentInclude
data ComponentInclude id rn
ComponentInclude :: AnnotatedId id -> rn -> Bool -> ComponentInclude id rn
[ci_ann_id] :: ComponentInclude id rn -> AnnotatedId id
[ci_renaming] :: ComponentInclude id rn -> rn
-- | Did this come from an entry in mixins, or was implicitly
-- generated by build-depends?
[ci_implicit] :: ComponentInclude id rn -> Bool
ci_id :: ComponentInclude id rn -> id
ci_pkgid :: ComponentInclude id rn -> PackageId
-- | This should always return CLibName or CSubLibName
ci_cname :: ComponentInclude id rn -> ComponentName
module Distribution.Types.AbiDependency
-- | An ABI dependency is a dependency on a library which also records the
-- ABI hash (abiHash) of the library it depends on.
--
-- The primary utility of this is to enable an extra sanity when GHC
-- loads libraries: it can check if the dependency has a matching ABI and
-- if not, refuse to load this library. This information is critical if
-- we are shadowing libraries; differences in the ABI hash let us know
-- what packages get shadowed by the new version of a package.
data AbiDependency
AbiDependency :: UnitId -> AbiHash -> AbiDependency
[depUnitId] :: AbiDependency -> UnitId
[depAbiHash] :: AbiDependency -> AbiHash
instance GHC.Show.Show Distribution.Types.AbiDependency.AbiDependency
instance GHC.Read.Read Distribution.Types.AbiDependency.AbiDependency
instance GHC.Generics.Generic Distribution.Types.AbiDependency.AbiDependency
instance GHC.Classes.Eq Distribution.Types.AbiDependency.AbiDependency
instance Distribution.Pretty.Pretty Distribution.Types.AbiDependency.AbiDependency
instance Distribution.Parsec.Parsec Distribution.Types.AbiDependency.AbiDependency
instance Data.Binary.Class.Binary Distribution.Types.AbiDependency.AbiDependency
instance Distribution.Utils.Structured.Structured Distribution.Types.AbiDependency.AbiDependency
instance Control.DeepSeq.NFData Distribution.Types.AbiDependency.AbiDependency
-- | Package descriptions contain fields for specifying the name of a
-- software license and the name of the file containing the text of that
-- license. While package authors may choose any license they like, Cabal
-- provides an enumeration of a small set of common free and open source
-- software licenses. This is done so that Hackage can recognise
-- licenses, so that tools can detect licensing conflicts, and to
-- deter license proliferation.
--
-- It is recommended that all package authors use the
-- license-file or license-files fields in their
-- package descriptions. Further information about these fields can be
-- found in the Cabal users guide.
--
-- Additional resources
--
-- The following websites provide information about free and open source
-- software licenses:
--
--
--
-- Disclaimer
--
-- The descriptions of software licenses provided by this documentation
-- are intended for informational purposes only and in no way constitute
-- legal advice. Please read the text of the licenses and consult a
-- lawyer for any advice regarding software licensing.
module Distribution.License
-- | Indicates the license under which a package's source code is released.
-- Versions of the licenses not listed here will be rejected by Hackage
-- and cause cabal check to issue a warning.
data License
-- | GNU General Public License, version 2 or version 3.
GPL :: Maybe Version -> License
-- | GNU Affero General Public License, version 3.
AGPL :: Maybe Version -> License
-- | GNU Lesser General Public License, version 2.1 or version
-- 3.
LGPL :: Maybe Version -> License
-- | 2-clause BSD license.
BSD2 :: License
-- | 3-clause BSD license.
BSD3 :: License
-- | 4-clause BSD license. This license has not been approved by the
-- OSI and is incompatible with the GNU GPL. It is provided for
-- historical reasons and should be avoided.
BSD4 :: License
-- | MIT license.
MIT :: License
-- | ISC license
ISC :: License
-- | Mozilla Public License, version 2.0.
MPL :: Version -> License
-- | Apache License, version 2.0.
Apache :: Maybe Version -> License
-- | The author of a package disclaims any copyright to its source code and
-- dedicates it to the public domain. This is not a software license.
-- Please note that it is not possible to dedicate works to the public
-- domain in every jurisdiction, nor is a work that is in the public
-- domain in one jurisdiction necessarily in the public domain elsewhere.
PublicDomain :: License
-- | Explicitly 'All Rights Reserved', eg for proprietary software. The
-- package may not be legally modified or redistributed by anyone but the
-- rightsholder.
AllRightsReserved :: License
-- | No license specified which legally defaults to 'All Rights Reserved'.
-- The package may not be legally modified or redistributed by anyone but
-- the rightsholder.
UnspecifiedLicense :: License
-- | Any other software license.
OtherLicense :: License
-- | Indicates an erroneous license name.
UnknownLicense :: String -> License
-- | The list of all currently recognised licenses.
knownLicenses :: [License]
-- | Convert old License to SPDX License. Non-SPDX licenses
-- are converted to LicenseRef.
licenseToSPDX :: License -> License
-- | Convert License to License,
--
-- This is lossy conversion. We try our best.
--
--
-- >>> licenseFromSPDX . licenseToSPDX $ BSD3
-- BSD3
--
--
--
-- >>> licenseFromSPDX . licenseToSPDX $ GPL (Just (mkVersion [3]))
-- GPL (Just (mkVersion [3]))
--
--
--
-- >>> licenseFromSPDX . licenseToSPDX $ PublicDomain
-- UnknownLicense "LicenseRefPublicDomain"
--
--
--
-- >>> licenseFromSPDX $ SPDX.License $ SPDX.simpleLicenseExpression SPDX.EUPL_1_1
-- UnknownLicense "EUPL-1.1"
--
--
--
-- >>> licenseFromSPDX . licenseToSPDX $ AllRightsReserved
-- AllRightsReserved
--
--
--
-- >>> licenseFromSPDX <$> simpleParsec "BSD-3-Clause OR GPL-3.0-only"
-- Just (UnknownLicense "BSD3ClauseORGPL30only")
--
licenseFromSPDX :: License -> License
instance Data.Data.Data Distribution.License.License
instance GHC.Classes.Eq Distribution.License.License
instance GHC.Show.Show Distribution.License.License
instance GHC.Read.Read Distribution.License.License
instance GHC.Generics.Generic Distribution.License.License
instance Data.Binary.Class.Binary Distribution.License.License
instance Distribution.Utils.Structured.Structured Distribution.License.License
instance Control.DeepSeq.NFData Distribution.License.License
instance Distribution.Pretty.Pretty Distribution.License.License
instance Distribution.Parsec.Parsec Distribution.License.License
module Distribution.Types.InstalledPackageInfo
data InstalledPackageInfo
InstalledPackageInfo :: PackageId -> LibraryName -> ComponentId -> LibraryVisibility -> UnitId -> [(ModuleName, OpenModule)] -> String -> Either License License -> !ShortText -> !ShortText -> !ShortText -> !ShortText -> !ShortText -> !ShortText -> !ShortText -> !ShortText -> !ShortText -> AbiHash -> Bool -> Bool -> [ExposedModule] -> [ModuleName] -> Bool -> [FilePath] -> [FilePath] -> [FilePath] -> FilePath -> [String] -> [String] -> [String] -> [FilePath] -> [String] -> [UnitId] -> [AbiDependency] -> [String] -> [String] -> [String] -> [FilePath] -> [String] -> [FilePath] -> [FilePath] -> Maybe FilePath -> InstalledPackageInfo
[sourcePackageId] :: InstalledPackageInfo -> PackageId
[sourceLibName] :: InstalledPackageInfo -> LibraryName
[installedComponentId_] :: InstalledPackageInfo -> ComponentId
[libVisibility] :: InstalledPackageInfo -> LibraryVisibility
[installedUnitId] :: InstalledPackageInfo -> UnitId
[instantiatedWith] :: InstalledPackageInfo -> [(ModuleName, OpenModule)]
[compatPackageKey] :: InstalledPackageInfo -> String
[license] :: InstalledPackageInfo -> Either License License
[copyright] :: InstalledPackageInfo -> !ShortText
[maintainer] :: InstalledPackageInfo -> !ShortText
[author] :: InstalledPackageInfo -> !ShortText
[stability] :: InstalledPackageInfo -> !ShortText
[homepage] :: InstalledPackageInfo -> !ShortText
[pkgUrl] :: InstalledPackageInfo -> !ShortText
[synopsis] :: InstalledPackageInfo -> !ShortText
[description] :: InstalledPackageInfo -> !ShortText
[category] :: InstalledPackageInfo -> !ShortText
[abiHash] :: InstalledPackageInfo -> AbiHash
[indefinite] :: InstalledPackageInfo -> Bool
[exposed] :: InstalledPackageInfo -> Bool
[exposedModules] :: InstalledPackageInfo -> [ExposedModule]
[hiddenModules] :: InstalledPackageInfo -> [ModuleName]
[trusted] :: InstalledPackageInfo -> Bool
[importDirs] :: InstalledPackageInfo -> [FilePath]
[libraryDirs] :: InstalledPackageInfo -> [FilePath]
-- | overrides libraryDirs
[libraryDynDirs] :: InstalledPackageInfo -> [FilePath]
[dataDir] :: InstalledPackageInfo -> FilePath
[hsLibraries] :: InstalledPackageInfo -> [String]
[extraLibraries] :: InstalledPackageInfo -> [String]
[extraGHCiLibraries] :: InstalledPackageInfo -> [String]
[includeDirs] :: InstalledPackageInfo -> [FilePath]
[includes] :: InstalledPackageInfo -> [String]
[depends] :: InstalledPackageInfo -> [UnitId]
[abiDepends] :: InstalledPackageInfo -> [AbiDependency]
[ccOptions] :: InstalledPackageInfo -> [String]
[cxxOptions] :: InstalledPackageInfo -> [String]
[ldOptions] :: InstalledPackageInfo -> [String]
[frameworkDirs] :: InstalledPackageInfo -> [FilePath]
[frameworks] :: InstalledPackageInfo -> [String]
[haddockInterfaces] :: InstalledPackageInfo -> [FilePath]
[haddockHTMLs] :: InstalledPackageInfo -> [FilePath]
[pkgRoot] :: InstalledPackageInfo -> Maybe FilePath
emptyInstalledPackageInfo :: InstalledPackageInfo
mungedPackageId :: InstalledPackageInfo -> MungedPackageId
-- | Returns the munged package name, which we write into name for
-- compatibility with old versions of GHC.
mungedPackageName :: InstalledPackageInfo -> MungedPackageName
-- | An ABI dependency is a dependency on a library which also records the
-- ABI hash (abiHash) of the library it depends on.
--
-- The primary utility of this is to enable an extra sanity when GHC
-- loads libraries: it can check if the dependency has a matching ABI and
-- if not, refuse to load this library. This information is critical if
-- we are shadowing libraries; differences in the ABI hash let us know
-- what packages get shadowed by the new version of a package.
data AbiDependency
AbiDependency :: UnitId -> AbiHash -> AbiDependency
[depUnitId] :: AbiDependency -> UnitId
[depAbiHash] :: AbiDependency -> AbiHash
data ExposedModule
ExposedModule :: ModuleName -> Maybe OpenModule -> ExposedModule
[exposedName] :: ExposedModule -> ModuleName
[exposedReexport] :: ExposedModule -> Maybe OpenModule
instance GHC.Show.Show Distribution.Types.InstalledPackageInfo.InstalledPackageInfo
instance GHC.Read.Read Distribution.Types.InstalledPackageInfo.InstalledPackageInfo
instance GHC.Generics.Generic Distribution.Types.InstalledPackageInfo.InstalledPackageInfo
instance GHC.Classes.Eq Distribution.Types.InstalledPackageInfo.InstalledPackageInfo
instance Data.Binary.Class.Binary Distribution.Types.InstalledPackageInfo.InstalledPackageInfo
instance Distribution.Utils.Structured.Structured Distribution.Types.InstalledPackageInfo.InstalledPackageInfo
instance Control.DeepSeq.NFData Distribution.Types.InstalledPackageInfo.InstalledPackageInfo
instance Distribution.Package.HasMungedPackageId Distribution.Types.InstalledPackageInfo.InstalledPackageInfo
instance Distribution.Package.Package Distribution.Types.InstalledPackageInfo.InstalledPackageInfo
instance Distribution.Package.HasUnitId Distribution.Types.InstalledPackageInfo.InstalledPackageInfo
instance Distribution.Package.PackageInstalled Distribution.Types.InstalledPackageInfo.InstalledPackageInfo
instance Distribution.Compat.Graph.IsNode Distribution.Types.InstalledPackageInfo.InstalledPackageInfo
module Distribution.Types.InstalledPackageInfo.Lens
data InstalledPackageInfo
sourcePackageId :: Lens' InstalledPackageInfo PackageIdentifier
installedUnitId :: Lens' InstalledPackageInfo UnitId
installedComponentId_ :: Lens' InstalledPackageInfo ComponentId
instantiatedWith :: Lens' InstalledPackageInfo [(ModuleName, OpenModule)]
sourceLibName :: Lens' InstalledPackageInfo LibraryName
compatPackageKey :: Lens' InstalledPackageInfo String
license :: Lens' InstalledPackageInfo (Either License License)
copyright :: Lens' InstalledPackageInfo ShortText
maintainer :: Lens' InstalledPackageInfo ShortText
author :: Lens' InstalledPackageInfo ShortText
stability :: Lens' InstalledPackageInfo ShortText
homepage :: Lens' InstalledPackageInfo ShortText
pkgUrl :: Lens' InstalledPackageInfo ShortText
synopsis :: Lens' InstalledPackageInfo ShortText
description :: Lens' InstalledPackageInfo ShortText
category :: Lens' InstalledPackageInfo ShortText
abiHash :: Lens' InstalledPackageInfo AbiHash
indefinite :: Lens' InstalledPackageInfo Bool
exposed :: Lens' InstalledPackageInfo Bool
exposedModules :: Lens' InstalledPackageInfo [ExposedModule]
hiddenModules :: Lens' InstalledPackageInfo [ModuleName]
trusted :: Lens' InstalledPackageInfo Bool
importDirs :: Lens' InstalledPackageInfo [FilePath]
libraryDirs :: Lens' InstalledPackageInfo [FilePath]
libraryDynDirs :: Lens' InstalledPackageInfo [FilePath]
dataDir :: Lens' InstalledPackageInfo FilePath
hsLibraries :: Lens' InstalledPackageInfo [String]
extraLibraries :: Lens' InstalledPackageInfo [String]
extraGHCiLibraries :: Lens' InstalledPackageInfo [String]
includeDirs :: Lens' InstalledPackageInfo [FilePath]
includes :: Lens' InstalledPackageInfo [String]
depends :: Lens' InstalledPackageInfo [UnitId]
abiDepends :: Lens' InstalledPackageInfo [AbiDependency]
ccOptions :: Lens' InstalledPackageInfo [String]
cxxOptions :: Lens' InstalledPackageInfo [String]
ldOptions :: Lens' InstalledPackageInfo [String]
frameworkDirs :: Lens' InstalledPackageInfo [FilePath]
frameworks :: Lens' InstalledPackageInfo [String]
haddockInterfaces :: Lens' InstalledPackageInfo [FilePath]
haddockHTMLs :: Lens' InstalledPackageInfo [FilePath]
pkgRoot :: Lens' InstalledPackageInfo (Maybe FilePath)
libVisibility :: Lens' InstalledPackageInfo LibraryVisibility
-- | Haskell language dialects and extensions
module Language.Haskell.Extension
-- | This represents a Haskell language dialect.
--
-- Language Extensions are interpreted relative to one of these
-- base languages.
data Language
-- | The Haskell 98 language as defined by the Haskell 98 report.
-- http://haskell.org/onlinereport/
Haskell98 :: Language
-- | The Haskell 2010 language as defined by the Haskell 2010 report.
-- http://www.haskell.org/onlinereport/haskell2010
Haskell2010 :: Language
-- | The GHC2021 collection of language extensions.
-- https://github.com/ghc-proposals/ghc-proposals/blob/master/proposals/0380-ghc2021.rst
GHC2021 :: Language
-- | An unknown language, identified by its name.
UnknownLanguage :: String -> Language
-- | List of known (supported) languages for GHC
knownLanguages :: [Language]
classifyLanguage :: String -> Language
-- | This represents language extensions beyond a base Language
-- definition (such as Haskell98) that are supported by some
-- implementations, usually in some special mode.
--
-- Where applicable, references are given to an implementation's official
-- documentation.
data Extension
-- | Enable a known extension
EnableExtension :: KnownExtension -> Extension
-- | Disable a known extension
DisableExtension :: KnownExtension -> Extension
-- | An unknown extension, identified by the name of its LANGUAGE
-- pragma.
UnknownExtension :: String -> Extension
data KnownExtension
-- | Allow overlapping class instances, provided there is a unique most
-- specific instance for each use.
--
--
OverlappingInstances :: KnownExtension
-- | Ignore structural rules guaranteeing the termination of class instance
-- resolution. Termination is guaranteed by a fixed-depth recursion
-- stack, and compilation may fail if this depth is exceeded.
--
--
UndecidableInstances :: KnownExtension
-- | Implies OverlappingInstances. Allow the implementation to
-- choose an instance even when it is possible that further instantiation
-- of types will lead to a more specific instance being applicable.
--
--
IncoherentInstances :: KnownExtension
-- | (deprecated) Deprecated in favour of RecursiveDo.
--
-- Old description: Allow recursive bindings in do blocks, using
-- the rec keyword. See also RecursiveDo.
DoRec :: KnownExtension
-- | Allow recursive bindings in do blocks, using the rec
-- keyword, or mdo, a variant of do.
--
--
RecursiveDo :: KnownExtension
-- | Provide syntax for writing list comprehensions which iterate over
-- several lists together, like the zipWith family of functions.
--
--
ParallelListComp :: KnownExtension
-- | Allow multiple parameters in a type class.
--
--
MultiParamTypeClasses :: KnownExtension
-- | Enable the dreaded monomorphism restriction.
--
--
MonomorphismRestriction :: KnownExtension
-- | Allow a specification attached to a multi-parameter type class which
-- indicates that some parameters are entirely determined by others. The
-- implementation will check that this property holds for the declared
-- instances, and will use this property to reduce ambiguity in instance
-- resolution.
--
--
FunctionalDependencies :: KnownExtension
-- | (deprecated) A synonym for RankNTypes.
--
-- Old description: Like RankNTypes but does not allow a
-- higher-rank type to itself appear on the left of a function arrow.
--
--
Rank2Types :: KnownExtension
-- | Allow a universally-quantified type to occur on the left of a function
-- arrow.
--
--
RankNTypes :: KnownExtension
-- | (deprecated) A synonym for RankNTypes.
--
-- Old description: Allow data constructors to have polymorphic
-- arguments. Unlike RankNTypes, does not allow this for ordinary
-- functions.
--
--
PolymorphicComponents :: KnownExtension
-- | Allow existentially-quantified data constructors.
--
--
ExistentialQuantification :: KnownExtension
-- | Cause a type variable in a signature, which has an explicit
-- forall quantifier, to scope over the definition of the
-- accompanying value declaration.
--
--
ScopedTypeVariables :: KnownExtension
-- | Deprecated, use ScopedTypeVariables instead.
PatternSignatures :: KnownExtension
-- | Enable implicit function parameters with dynamic scope.
--
--
ImplicitParams :: KnownExtension
-- | Relax some restrictions on the form of the context of a type
-- signature.
--
--
FlexibleContexts :: KnownExtension
-- | Relax some restrictions on the form of the context of an instance
-- declaration.
--
--
FlexibleInstances :: KnownExtension
-- | Allow data type declarations with no constructors.
--
--
EmptyDataDecls :: KnownExtension
-- | Run the C preprocessor on Haskell source code.
--
--
CPP :: KnownExtension
-- | Allow an explicit kind signature giving the kind of types over which a
-- type variable ranges.
--
--
KindSignatures :: KnownExtension
-- | Enable a form of pattern which forces evaluation before an attempted
-- match, and a form of strict let/where binding.
--
--
BangPatterns :: KnownExtension
-- | Allow type synonyms in instance heads.
--
--
TypeSynonymInstances :: KnownExtension
-- | Enable Template Haskell, a system for compile-time metaprogramming.
--
--
TemplateHaskell :: KnownExtension
-- | Enable the Foreign Function Interface. In GHC, implements the standard
-- Haskell 98 Foreign Function Interface Addendum, plus some GHC-specific
-- extensions.
--
--
ForeignFunctionInterface :: KnownExtension
-- | Enable arrow notation.
--
--
Arrows :: KnownExtension
-- | (deprecated) Enable generic type classes, with default
-- instances defined in terms of the algebraic structure of a type.
--
--
Generics :: KnownExtension
-- | Enable the implicit importing of the module Prelude. When
-- disabled, when desugaring certain built-in syntax into ordinary
-- identifiers, use whatever is in scope rather than the Prelude
-- -- version.
--
--
ImplicitPrelude :: KnownExtension
-- | Enable syntax for implicitly binding local names corresponding to the
-- field names of a record. Puns bind specific names, unlike
-- RecordWildCards.
--
--
NamedFieldPuns :: KnownExtension
-- | Enable a form of guard which matches a pattern and binds variables.
--
--
PatternGuards :: KnownExtension
-- | Allow a type declared with newtype to use deriving
-- for any class with an instance for the underlying type.
--
--
GeneralizedNewtypeDeriving :: KnownExtension
GeneralisedNewtypeDeriving :: KnownExtension
-- | Enable the "Trex" extensible records system.
--
--
ExtensibleRecords :: KnownExtension
-- | Enable type synonyms which are transparent in some definitions and
-- opaque elsewhere, as a way of implementing abstract datatypes.
--
--
RestrictedTypeSynonyms :: KnownExtension
-- | Enable an alternate syntax for string literals, with string
-- templating.
--
--
HereDocuments :: KnownExtension
-- | Allow the character # as a postfix modifier on identifiers.
-- Also enables literal syntax for unboxed values.
--
--
MagicHash :: KnownExtension
-- | Allow data types and type synonyms which are indexed by types, i.e.
-- ad-hoc polymorphism for types.
--
--
TypeFamilies :: KnownExtension
-- | Allow a standalone declaration which invokes the type class
-- deriving mechanism.
--
--
StandaloneDeriving :: KnownExtension
-- | Allow certain Unicode characters to stand for certain ASCII character
-- sequences, e.g. keywords and punctuation.
--
--
UnicodeSyntax :: KnownExtension
-- | Allow the use of unboxed types as foreign types, e.g. in foreign
-- import and foreign export.
--
--
UnliftedFFITypes :: KnownExtension
-- | Enable interruptible FFI.
--
--
InterruptibleFFI :: KnownExtension
-- | Allow use of CAPI FFI calling convention (foreign import
-- capi).
--
--
CApiFFI :: KnownExtension
-- | Defer validity checking of types until after expanding type synonyms,
-- relaxing the constraints on how synonyms may be used.
--
--
LiberalTypeSynonyms :: KnownExtension
-- | Allow the name of a type constructor, type class, or type variable to
-- be an infix operator. *
-- https://www.haskell.org/ghc/docs/latest/html/users_guide/glasgow_exts.html#ghc-flag--XTypeOperators
TypeOperators :: KnownExtension
-- | Enable syntax for implicitly binding local names corresponding to the
-- field names of a record. A wildcard binds all unmentioned names,
-- unlike NamedFieldPuns.
--
--
RecordWildCards :: KnownExtension
-- | Deprecated, use NamedFieldPuns instead.
RecordPuns :: KnownExtension
-- | Allow a record field name to be disambiguated by the type of the
-- record it's in.
--
--
DisambiguateRecordFields :: KnownExtension
-- | Enable traditional record syntax (as supported by Haskell 98)
--
--
TraditionalRecordSyntax :: KnownExtension
-- | Enable overloading of string literals using a type class, much like
-- integer literals.
--
--
OverloadedStrings :: KnownExtension
-- | Enable generalized algebraic data types, in which type variables may
-- be instantiated on a per-constructor basis. Implies GADTSyntax.
--
--
GADTs :: KnownExtension
-- | Enable GADT syntax for declaring ordinary algebraic datatypes.
--
--
GADTSyntax :: KnownExtension
-- | (deprecated) Has no effect.
--
-- Old description: Make pattern bindings monomorphic.
--
--
MonoPatBinds :: KnownExtension
-- | Relax the requirements on mutually-recursive polymorphic functions.
--
--
RelaxedPolyRec :: KnownExtension
-- | Allow default instantiation of polymorphic types in more situations.
--
--
ExtendedDefaultRules :: KnownExtension
-- | Enable unboxed tuples.
--
--
UnboxedTuples :: KnownExtension
-- | Enable deriving for classes Typeable and Data.
--
--
DeriveDataTypeable :: KnownExtension
-- | Enable deriving for Generic and Generic1.
--
--
DeriveGeneric :: KnownExtension
-- | Enable support for default signatures.
--
--
DefaultSignatures :: KnownExtension
-- | Allow type signatures to be specified in instance declarations.
--
--
InstanceSigs :: KnownExtension
-- | Allow a class method's type to place additional constraints on a class
-- type variable.
--
--
ConstrainedClassMethods :: KnownExtension
-- | Allow imports to be qualified by the package name the module is
-- intended to be imported from, e.g.
--
--
-- import "network" Network.Socket
--
--
--
PackageImports :: KnownExtension
-- | (deprecated) Allow a type variable to be instantiated at a
-- polymorphic type.
--
--
ImpredicativeTypes :: KnownExtension
-- | (deprecated) Change the syntax for qualified infix operators.
--
--
NewQualifiedOperators :: KnownExtension
-- | Relax the interpretation of left operator sections to allow unary
-- postfix operators.
--
--
PostfixOperators :: KnownExtension
-- | Enable quasi-quotation, a mechanism for defining new concrete syntax
-- for expressions and patterns.
--
--
QuasiQuotes :: KnownExtension
-- | Enable generalized list comprehensions, supporting operations such as
-- sorting and grouping.
--
--
TransformListComp :: KnownExtension
-- | Enable monad comprehensions, which generalise the list comprehension
-- syntax to work for any monad.
--
--
MonadComprehensions :: KnownExtension
-- | Enable view patterns, which match a value by applying a function and
-- matching on the result.
--
--
ViewPatterns :: KnownExtension
-- | Allow concrete XML syntax to be used in expressions and patterns, as
-- per the Haskell Server Pages extension language:
-- http://www.haskell.org/haskellwiki/HSP. The ideas behind it are
-- discussed in the paper "Haskell Server Pages through Dynamic Loading"
-- by Niklas Broberg, from Haskell Workshop '05.
XmlSyntax :: KnownExtension
-- | Allow regular pattern matching over lists, as discussed in the paper
-- "Regular Expression Patterns" by Niklas Broberg, Andreas Farre and
-- Josef Svenningsson, from ICFP '04.
RegularPatterns :: KnownExtension
-- | Enable the use of tuple sections, e.g. (, True) desugars into
-- x -> (x, True).
--
--
TupleSections :: KnownExtension
-- | Allow GHC primops, written in C--, to be imported into a Haskell file.
GHCForeignImportPrim :: KnownExtension
-- | Support for patterns of the form n + k, where k is
-- an integer literal.
--
--
NPlusKPatterns :: KnownExtension
-- | Improve the layout rule when if expressions are used in a
-- do block.
DoAndIfThenElse :: KnownExtension
-- | Enable support for multi-way if-expressions.
--
--
MultiWayIf :: KnownExtension
-- | Enable support lambda-case expressions.
--
--
LambdaCase :: KnownExtension
-- | Makes much of the Haskell sugar be desugared into calls to the
-- function with a particular name that is in scope.
--
--
RebindableSyntax :: KnownExtension
-- | Make forall a keyword in types, which can be used to give the
-- generalisation explicitly.
--
--
ExplicitForAll :: KnownExtension
-- | Allow contexts to be put on datatypes, e.g. the Eq a in
-- data Eq a => Set a = NilSet | ConsSet a (Set a).
--
--
DatatypeContexts :: KnownExtension
-- | Local (let and where) bindings are monomorphic.
--
--
MonoLocalBinds :: KnownExtension
-- | Enable deriving for the Functor class.
--
--
DeriveFunctor :: KnownExtension
-- | Enable deriving for the Traversable class.
--
--
DeriveTraversable :: KnownExtension
-- | Enable deriving for the Foldable class.
--
--
DeriveFoldable :: KnownExtension
-- | Enable non-decreasing indentation for do blocks.
--
--
NondecreasingIndentation :: KnownExtension
-- | Allow imports to be qualified with a safe keyword that requires the
-- imported module be trusted as according to the Safe Haskell definition
-- of trust.
--
--
-- import safe Network.Socket
--
--
--
SafeImports :: KnownExtension
-- | Compile a module in the Safe, Safe Haskell mode -- a restricted form
-- of the Haskell language to ensure type safety.
--
--
Safe :: KnownExtension
-- | Compile a module in the Trustworthy, Safe Haskell mode -- no
-- restrictions apply but the module is marked as trusted as long as the
-- package the module resides in is trusted.
--
--
Trustworthy :: KnownExtension
-- | Compile a module in the Unsafe, Safe Haskell mode so that modules
-- compiled using Safe, Safe Haskell mode can't import it.
--
--
Unsafe :: KnownExtension
-- | Allow type classimplicit parameterequality constraints to be
-- used as types with the special kind constraint. Also generalise the
-- (ctxt => ty) syntax so that any type of kind constraint
-- can occur before the arrow.
--
--
ConstraintKinds :: KnownExtension
-- | Enable kind polymorphism.
--
--
PolyKinds :: KnownExtension
-- | Enable datatype promotion.
--
--
DataKinds :: KnownExtension
-- | Enable parallel arrays syntax ([:, :]) for Data
-- Parallel Haskell.
--
--
ParallelArrays :: KnownExtension
-- | Enable explicit role annotations, like in (type role Foo
-- representational representational).
--
--
RoleAnnotations :: KnownExtension
-- | Enable overloading of list literals, arithmetic sequences and list
-- patterns using the IsList type class.
--
--
OverloadedLists :: KnownExtension
-- | Enable case expressions that have no alternatives. Also applies to
-- lambda-case expressions if they are enabled.
--
--
EmptyCase :: KnownExtension
-- | (deprecated) Deprecated in favour of DeriveDataTypeable.
--
-- Old description: Triggers the generation of derived Typeable
-- instances for every datatype and type class declaration.
--
--
AutoDeriveTypeable :: KnownExtension
-- | Desugars negative literals directly (without using negate).
--
--
NegativeLiterals :: KnownExtension
-- | Allow the use of binary integer literal syntax (e.g.
-- 0b11001001 to denote 201).
--
--
BinaryLiterals :: KnownExtension
-- | Allow the use of floating literal syntax for all instances of
-- Num, including Int and Integer.
--
--
NumDecimals :: KnownExtension
-- | Enable support for type classes with no type parameter.
--
--
NullaryTypeClasses :: KnownExtension
-- | Enable explicit namespaces in module import/export lists.
--
--
ExplicitNamespaces :: KnownExtension
-- | Allow the user to write ambiguous types, and the type inference engine
-- to infer them.
--
--
AllowAmbiguousTypes :: KnownExtension
-- | Enable foreign import javascript.
JavaScriptFFI :: KnownExtension
-- | Allow giving names to and abstracting over patterns.
--
--
PatternSynonyms :: KnownExtension
-- | Allow anonymous placeholders (underscore) inside type signatures. The
-- type inference engine will generate a message describing the type
-- inferred at the hole's location.
--
--
PartialTypeSignatures :: KnownExtension
-- | Allow named placeholders written with a leading underscore inside type
-- signatures. Wildcards with the same name unify to the same type.
--
--
NamedWildCards :: KnownExtension
-- | Enable deriving for any class.
--
--
DeriveAnyClass :: KnownExtension
-- | Enable deriving for the Lift class.
--
--
DeriveLift :: KnownExtension
-- | Enable support for 'static pointers' (and the static keyword)
-- to refer to globally stable names, even across different programs.
--
--
StaticPointers :: KnownExtension
-- | Switches data type declarations to be strict by default (as if they
-- had a bang using BangPatterns), and allow opt-in field
-- laziness using ~.
--
--
StrictData :: KnownExtension
-- | Switches all pattern bindings to be strict by default (as if they had
-- a bang using BangPatterns), ordinary patterns are recovered
-- using ~. Implies StrictData.
--
--
Strict :: KnownExtension
-- | Allows do-notation for types that are
-- Applicative as well as Monad. When
-- enabled, desugaring do notation tries to use
-- (*) and fmap and join
-- as far as possible.
ApplicativeDo :: KnownExtension
-- | Allow records to use duplicated field labels for accessors.
DuplicateRecordFields :: KnownExtension
-- | Enable explicit type applications with the syntax id @Int.
TypeApplications :: KnownExtension
-- | Dissolve the distinction between types and kinds, allowing the
-- compiler to reason about kind equality and therefore enabling GADTs to
-- be promoted to the type-level.
TypeInType :: KnownExtension
-- | Allow recursive (and therefore undecidable) super-class relationships.
UndecidableSuperClasses :: KnownExtension
-- | A temporary extension to help library authors check if their code will
-- compile with the new planned desugaring of fail.
MonadFailDesugaring :: KnownExtension
-- | A subset of TemplateHaskell including only quoting.
TemplateHaskellQuotes :: KnownExtension
-- | Allows use of the #label syntax.
OverloadedLabels :: KnownExtension
-- | Allow functional dependency annotations on type families to declare
-- them as injective.
TypeFamilyDependencies :: KnownExtension
-- | Allow multiple deriving clauses, each optionally qualified
-- with a strategy.
DerivingStrategies :: KnownExtension
-- | Enable deriving instances via types of the same runtime
-- representation. Implies DerivingStrategies.
DerivingVia :: KnownExtension
-- | Enable the use of unboxed sum syntax.
UnboxedSums :: KnownExtension
-- | Allow use of hexadecimal literal notation for floating-point values.
HexFloatLiterals :: KnownExtension
-- | Allow do blocks etc. in argument position.
BlockArguments :: KnownExtension
-- | Allow use of underscores in numeric literals.
NumericUnderscores :: KnownExtension
-- | Allow forall in constraints.
QuantifiedConstraints :: KnownExtension
-- | Have * refer to Type.
StarIsType :: KnownExtension
-- | Liberalises deriving to provide instances for empty data types.
--
--
EmptyDataDeriving :: KnownExtension
-- | Enable detection of complete user-supplied kind signatures.
CUSKs :: KnownExtension
-- | Allows the syntax import M qualified.
ImportQualifiedPost :: KnownExtension
-- | Allow the use of standalone kind signatures.
StandaloneKindSignatures :: KnownExtension
-- | Enable unlifted newtypes.
UnliftedNewtypes :: KnownExtension
-- | Use whitespace to determine whether the minus sign stands for negation
-- or subtraction.
LexicalNegation :: KnownExtension
-- | Enable qualified do-notation desugaring.
QualifiedDo :: KnownExtension
-- | Enable linear types.
LinearTypes :: KnownExtension
-- | Enable the generation of selector functions corresponding to record
-- fields.
FieldSelectors :: KnownExtension
-- | Enable the use of record dot-accessor and updater syntax
OverloadedRecordDot :: KnownExtension
-- | Enable data types for which an unlifted or levity-polymorphic result
-- kind is inferred.
UnliftedDatatypes :: KnownExtension
-- | Extensions that have been deprecated, possibly paired with another
-- extension that replaces it.
deprecatedExtensions :: [(Extension, Maybe Extension)]
classifyExtension :: String -> Extension
instance Data.Data.Data Language.Haskell.Extension.Language
instance GHC.Classes.Eq Language.Haskell.Extension.Language
instance GHC.Read.Read Language.Haskell.Extension.Language
instance GHC.Show.Show Language.Haskell.Extension.Language
instance GHC.Generics.Generic Language.Haskell.Extension.Language
instance Data.Data.Data Language.Haskell.Extension.KnownExtension
instance GHC.Enum.Bounded Language.Haskell.Extension.KnownExtension
instance GHC.Enum.Enum Language.Haskell.Extension.KnownExtension
instance GHC.Classes.Ord Language.Haskell.Extension.KnownExtension
instance GHC.Classes.Eq Language.Haskell.Extension.KnownExtension
instance GHC.Read.Read Language.Haskell.Extension.KnownExtension
instance GHC.Show.Show Language.Haskell.Extension.KnownExtension
instance GHC.Generics.Generic Language.Haskell.Extension.KnownExtension
instance Data.Data.Data Language.Haskell.Extension.Extension
instance GHC.Classes.Ord Language.Haskell.Extension.Extension
instance GHC.Classes.Eq Language.Haskell.Extension.Extension
instance GHC.Read.Read Language.Haskell.Extension.Extension
instance GHC.Show.Show Language.Haskell.Extension.Extension
instance GHC.Generics.Generic Language.Haskell.Extension.Extension
instance Data.Binary.Class.Binary Language.Haskell.Extension.Extension
instance Distribution.Utils.Structured.Structured Language.Haskell.Extension.Extension
instance Control.DeepSeq.NFData Language.Haskell.Extension.Extension
instance Distribution.Pretty.Pretty Language.Haskell.Extension.Extension
instance Distribution.Parsec.Parsec Language.Haskell.Extension.Extension
instance Data.Binary.Class.Binary Language.Haskell.Extension.KnownExtension
instance Distribution.Utils.Structured.Structured Language.Haskell.Extension.KnownExtension
instance Control.DeepSeq.NFData Language.Haskell.Extension.KnownExtension
instance Distribution.Pretty.Pretty Language.Haskell.Extension.KnownExtension
instance Data.Binary.Class.Binary Language.Haskell.Extension.Language
instance Distribution.Utils.Structured.Structured Language.Haskell.Extension.Language
instance Control.DeepSeq.NFData Language.Haskell.Extension.Language
instance Distribution.Pretty.Pretty Language.Haskell.Extension.Language
instance Distribution.Parsec.Parsec Language.Haskell.Extension.Language
-- | This has an enumeration of the various compilers that Cabal knows
-- about. It also specifies the default compiler. Sadly you'll often see
-- code that does case analysis on this compiler flavour enumeration
-- like:
--
--
-- case compilerFlavor comp of
-- GHC -> GHC.getInstalledPackages verbosity packageDb progdb
--
--
-- Obviously it would be better to use the proper Compiler
-- abstraction because that would keep all the compiler-specific code
-- together. Unfortunately we cannot make this change yet without
-- breaking the UserHooks api, which would break all custom
-- Setup.hs files, so for the moment we just have to live with
-- this deficiency. If you're interested, see ticket #57.
module Distribution.Compiler
data CompilerFlavor
GHC :: CompilerFlavor
GHCJS :: CompilerFlavor
NHC :: CompilerFlavor
YHC :: CompilerFlavor
Hugs :: CompilerFlavor
HBC :: CompilerFlavor
Helium :: CompilerFlavor
JHC :: CompilerFlavor
LHC :: CompilerFlavor
UHC :: CompilerFlavor
Eta :: CompilerFlavor
HaskellSuite :: String -> CompilerFlavor
OtherCompiler :: String -> CompilerFlavor
buildCompilerId :: CompilerId
buildCompilerFlavor :: CompilerFlavor
-- | The default compiler flavour to pick when compiling stuff. This
-- defaults to the compiler used to build the Cabal lib.
--
-- However if it's not a recognised compiler then it's Nothing and
-- the user will have to specify which compiler they want.
defaultCompilerFlavor :: Maybe CompilerFlavor
classifyCompilerFlavor :: String -> CompilerFlavor
knownCompilerFlavors :: [CompilerFlavor]
-- | PerCompilerFlavor carries only info per GHC and GHCJS
--
-- Cabal parses only ghc-options and ghcjs-options,
-- others are omitted.
data PerCompilerFlavor v
PerCompilerFlavor :: v -> v -> PerCompilerFlavor v
perCompilerFlavorToList :: PerCompilerFlavor v -> [(CompilerFlavor, v)]
data CompilerId
CompilerId :: CompilerFlavor -> Version -> CompilerId
-- | Compiler information used for resolving configurations. Some fields
-- can be set to Nothing to indicate that the information is unknown.
data CompilerInfo
CompilerInfo :: CompilerId -> AbiTag -> Maybe [CompilerId] -> Maybe [Language] -> Maybe [Extension] -> CompilerInfo
-- | Compiler flavour and version.
[compilerInfoId] :: CompilerInfo -> CompilerId
-- | Tag for distinguishing incompatible ABI's on the same architecture/os.
[compilerInfoAbiTag] :: CompilerInfo -> AbiTag
-- | Other implementations that this compiler claims to be compatible with,
-- if known.
[compilerInfoCompat] :: CompilerInfo -> Maybe [CompilerId]
-- | Supported language standards, if known.
[compilerInfoLanguages] :: CompilerInfo -> Maybe [Language]
-- | Supported extensions, if known.
[compilerInfoExtensions] :: CompilerInfo -> Maybe [Extension]
-- | Make a CompilerInfo of which only the known information is its
-- CompilerId, its AbiTag and that it does not claim to be compatible
-- with other compiler id's.
unknownCompilerInfo :: CompilerId -> AbiTag -> CompilerInfo
data AbiTag
NoAbiTag :: AbiTag
AbiTag :: String -> AbiTag
abiTagString :: AbiTag -> String
instance Data.Data.Data Distribution.Compiler.CompilerFlavor
instance GHC.Classes.Ord Distribution.Compiler.CompilerFlavor
instance GHC.Classes.Eq Distribution.Compiler.CompilerFlavor
instance GHC.Read.Read Distribution.Compiler.CompilerFlavor
instance GHC.Show.Show Distribution.Compiler.CompilerFlavor
instance GHC.Generics.Generic Distribution.Compiler.CompilerFlavor
instance Data.Traversable.Traversable Distribution.Compiler.PerCompilerFlavor
instance Data.Foldable.Foldable Distribution.Compiler.PerCompilerFlavor
instance GHC.Base.Functor Distribution.Compiler.PerCompilerFlavor
instance Data.Data.Data v => Data.Data.Data (Distribution.Compiler.PerCompilerFlavor v)
instance GHC.Classes.Eq v => GHC.Classes.Eq (Distribution.Compiler.PerCompilerFlavor v)
instance GHC.Read.Read v => GHC.Read.Read (Distribution.Compiler.PerCompilerFlavor v)
instance GHC.Show.Show v => GHC.Show.Show (Distribution.Compiler.PerCompilerFlavor v)
instance GHC.Generics.Generic (Distribution.Compiler.PerCompilerFlavor v)
instance GHC.Show.Show Distribution.Compiler.CompilerId
instance GHC.Read.Read Distribution.Compiler.CompilerId
instance GHC.Classes.Ord Distribution.Compiler.CompilerId
instance GHC.Generics.Generic Distribution.Compiler.CompilerId
instance GHC.Classes.Eq Distribution.Compiler.CompilerId
instance GHC.Read.Read Distribution.Compiler.AbiTag
instance GHC.Show.Show Distribution.Compiler.AbiTag
instance GHC.Generics.Generic Distribution.Compiler.AbiTag
instance GHC.Classes.Eq Distribution.Compiler.AbiTag
instance GHC.Read.Read Distribution.Compiler.CompilerInfo
instance GHC.Show.Show Distribution.Compiler.CompilerInfo
instance GHC.Generics.Generic Distribution.Compiler.CompilerInfo
instance Data.Binary.Class.Binary Distribution.Compiler.CompilerInfo
instance Data.Binary.Class.Binary Distribution.Compiler.AbiTag
instance Distribution.Utils.Structured.Structured Distribution.Compiler.AbiTag
instance Distribution.Pretty.Pretty Distribution.Compiler.AbiTag
instance Distribution.Parsec.Parsec Distribution.Compiler.AbiTag
instance Data.Binary.Class.Binary Distribution.Compiler.CompilerId
instance Distribution.Utils.Structured.Structured Distribution.Compiler.CompilerId
instance Control.DeepSeq.NFData Distribution.Compiler.CompilerId
instance Distribution.Pretty.Pretty Distribution.Compiler.CompilerId
instance Distribution.Parsec.Parsec Distribution.Compiler.CompilerId
instance Data.Binary.Class.Binary a => Data.Binary.Class.Binary (Distribution.Compiler.PerCompilerFlavor a)
instance Distribution.Utils.Structured.Structured a => Distribution.Utils.Structured.Structured (Distribution.Compiler.PerCompilerFlavor a)
instance Control.DeepSeq.NFData a => Control.DeepSeq.NFData (Distribution.Compiler.PerCompilerFlavor a)
instance GHC.Base.Semigroup a => GHC.Base.Semigroup (Distribution.Compiler.PerCompilerFlavor a)
instance (GHC.Base.Semigroup a, GHC.Base.Monoid a) => GHC.Base.Monoid (Distribution.Compiler.PerCompilerFlavor a)
instance Data.Binary.Class.Binary Distribution.Compiler.CompilerFlavor
instance Distribution.Utils.Structured.Structured Distribution.Compiler.CompilerFlavor
instance Control.DeepSeq.NFData Distribution.Compiler.CompilerFlavor
instance Distribution.Pretty.Pretty Distribution.Compiler.CompilerFlavor
instance Distribution.Parsec.Parsec Distribution.Compiler.CompilerFlavor
module Distribution.Types.ConfVar
-- | A ConfVar represents the variable type used.
data ConfVar
OS :: OS -> ConfVar
Arch :: Arch -> ConfVar
PackageFlag :: FlagName -> ConfVar
Impl :: CompilerFlavor -> VersionRange -> ConfVar
instance GHC.Generics.Generic Distribution.Types.ConfVar.ConfVar
instance Data.Data.Data Distribution.Types.ConfVar.ConfVar
instance GHC.Show.Show Distribution.Types.ConfVar.ConfVar
instance GHC.Classes.Eq Distribution.Types.ConfVar.ConfVar
instance Data.Binary.Class.Binary Distribution.Types.ConfVar.ConfVar
instance Distribution.Utils.Structured.Structured Distribution.Types.ConfVar.ConfVar
instance Control.DeepSeq.NFData Distribution.Types.ConfVar.ConfVar
module Distribution.Types.BuildInfo
data BuildInfo
BuildInfo :: Bool -> [LegacyExeDependency] -> [ExeDependency] -> [String] -> [String] -> [String] -> [String] -> [String] -> [String] -> [String] -> [PkgconfigDependency] -> [String] -> [String] -> [FilePath] -> [FilePath] -> [FilePath] -> [FilePath] -> [FilePath] -> [SymbolicPath PackageDir SourceDir] -> [ModuleName] -> [ModuleName] -> [ModuleName] -> Maybe Language -> [Language] -> [Extension] -> [Extension] -> [Extension] -> [String] -> [String] -> [String] -> [String] -> [String] -> [String] -> [FilePath] -> [FilePath] -> [FilePath] -> [FilePath] -> PerCompilerFlavor [String] -> PerCompilerFlavor [String] -> PerCompilerFlavor [String] -> PerCompilerFlavor [String] -> [(String, String)] -> [Dependency] -> [Mixin] -> BuildInfo
-- | component is buildable here
[buildable] :: BuildInfo -> Bool
-- | Tools needed to build this bit.
--
-- This is a legacy field that buildToolDepends largely
-- supersedes.
--
-- Unless use are very sure what you are doing, use the functions in
-- Distribution.Simple.BuildToolDepends rather than accessing this
-- field directly.
[buildTools] :: BuildInfo -> [LegacyExeDependency]
-- | Haskell tools needed to build this bit
--
-- This field is better than buildTools because it allows one to
-- precisely specify an executable in a package.
--
-- Unless use are very sure what you are doing, use the functions in
-- Distribution.Simple.BuildToolDepends rather than accessing this
-- field directly.
[buildToolDepends] :: BuildInfo -> [ExeDependency]
-- | options for pre-processing Haskell code
[cppOptions] :: BuildInfo -> [String]
-- | options for assmebler
[asmOptions] :: BuildInfo -> [String]
-- | options for C-- compiler
[cmmOptions] :: BuildInfo -> [String]
-- | options for C compiler
[ccOptions] :: BuildInfo -> [String]
-- | options for C++ compiler
[cxxOptions] :: BuildInfo -> [String]
-- | options for linker
[ldOptions] :: BuildInfo -> [String]
-- | options for hsc2hs
[hsc2hsOptions] :: BuildInfo -> [String]
-- | pkg-config packages that are used
[pkgconfigDepends] :: BuildInfo -> [PkgconfigDependency]
-- | support frameworks for Mac OS X
[frameworks] :: BuildInfo -> [String]
-- | extra locations to find frameworks.
[extraFrameworkDirs] :: BuildInfo -> [String]
-- | Assembly files.
[asmSources] :: BuildInfo -> [FilePath]
-- | C-- files.
[cmmSources] :: BuildInfo -> [FilePath]
[cSources] :: BuildInfo -> [FilePath]
[cxxSources] :: BuildInfo -> [FilePath]
[jsSources] :: BuildInfo -> [FilePath]
-- | where to look for the Haskell module hierarchy
[hsSourceDirs] :: BuildInfo -> [SymbolicPath PackageDir SourceDir]
-- | non-exposed or non-main modules
[otherModules] :: BuildInfo -> [ModuleName]
-- | exposed modules that do not have a source file (e.g. GHC.Prim
-- from ghc-prim package)
[virtualModules] :: BuildInfo -> [ModuleName]
-- | not present on sdist, Paths_* or user-generated with a custom Setup.hs
[autogenModules] :: BuildInfo -> [ModuleName]
-- | language used when not explicitly specified
[defaultLanguage] :: BuildInfo -> Maybe Language
-- | other languages used within the package
[otherLanguages] :: BuildInfo -> [Language]
-- | language extensions used by all modules
[defaultExtensions] :: BuildInfo -> [Extension]
-- | other language extensions used within the package
[otherExtensions] :: BuildInfo -> [Extension]
-- | the old extensions field, treated same as defaultExtensions
[oldExtensions] :: BuildInfo -> [Extension]
-- | what libraries to link with when compiling a program that uses your
-- package
[extraLibs] :: BuildInfo -> [String]
-- | if present, overrides extraLibs when package is loaded with GHCi.
[extraGHCiLibs] :: BuildInfo -> [String]
-- | if present, adds libs to hs-libraries, which become part of the
-- package. Example: the Cffi library shipping with the rts, alognside
-- the HSrts-1.0.a,.o,... Example 2: a library that is being built by a
-- foreing tool (e.g. rust) and copied and registered together with this
-- library. The logic on how this library is built will have to be
-- encoded in a custom Setup for now. Otherwise cabal would need to lear
-- how to call arbitrary library builders.
[extraBundledLibs] :: BuildInfo -> [String]
-- | Hidden Flag. This set of strings, will be appended to all libraries
-- when copying. E.g. [libHSname_flavour | flavour <-
-- extraLibFlavours]. This should only be needed in very specific cases,
-- e.g. the rts package, where there are multiple copies of
-- slightly differently built libs.
[extraLibFlavours] :: BuildInfo -> [String]
-- | Hidden Flag. This set of strings will be appended to all
-- dynamic libraries when copying. This is particularly useful
-- with the rts package, where we want different dynamic
-- flavours of the RTS library to be installed.
[extraDynLibFlavours] :: BuildInfo -> [String]
[extraLibDirs] :: BuildInfo -> [String]
-- | directories to find .h files
[includeDirs] :: BuildInfo -> [FilePath]
-- | The .h files to be found in includeDirs
[includes] :: BuildInfo -> [FilePath]
-- | The .h files to be generated (e.g. by autoconf)
[autogenIncludes] :: BuildInfo -> [FilePath]
-- | .h files to install with the package
[installIncludes] :: BuildInfo -> [FilePath]
[options] :: BuildInfo -> PerCompilerFlavor [String]
[profOptions] :: BuildInfo -> PerCompilerFlavor [String]
[sharedOptions] :: BuildInfo -> PerCompilerFlavor [String]
[staticOptions] :: BuildInfo -> PerCompilerFlavor [String]
-- | Custom fields starting with x-, stored in a simple assoc-list.
[customFieldsBI] :: BuildInfo -> [(String, String)]
-- | Dependencies specific to a library or executable target
[targetBuildDepends] :: BuildInfo -> [Dependency]
[mixins] :: BuildInfo -> [Mixin]
emptyBuildInfo :: BuildInfo
-- | The Languages used by this component
allLanguages :: BuildInfo -> [Language]
-- | The Extensions that are used somewhere by this component
allExtensions :: BuildInfo -> [Extension]
-- | The Extensions that are used by all modules in this component
usedExtensions :: BuildInfo -> [Extension]
-- | Whether any modules in this component use Template Haskell or Quasi
-- Quotes
usesTemplateHaskellOrQQ :: BuildInfo -> Bool
-- | Select options for a particular Haskell compiler.
hcOptions :: CompilerFlavor -> BuildInfo -> [String]
hcProfOptions :: CompilerFlavor -> BuildInfo -> [String]
hcSharedOptions :: CompilerFlavor -> BuildInfo -> [String]
hcStaticOptions :: CompilerFlavor -> BuildInfo -> [String]
instance Data.Data.Data Distribution.Types.BuildInfo.BuildInfo
instance GHC.Classes.Eq Distribution.Types.BuildInfo.BuildInfo
instance GHC.Read.Read Distribution.Types.BuildInfo.BuildInfo
instance GHC.Show.Show Distribution.Types.BuildInfo.BuildInfo
instance GHC.Generics.Generic Distribution.Types.BuildInfo.BuildInfo
instance Data.Binary.Class.Binary Distribution.Types.BuildInfo.BuildInfo
instance Distribution.Utils.Structured.Structured Distribution.Types.BuildInfo.BuildInfo
instance Control.DeepSeq.NFData Distribution.Types.BuildInfo.BuildInfo
instance GHC.Base.Monoid Distribution.Types.BuildInfo.BuildInfo
instance GHC.Base.Semigroup Distribution.Types.BuildInfo.BuildInfo
module Distribution.Types.HookedBuildInfo
-- | HookedBuildInfo is mechanism that hooks can use to override the
-- BuildInfos inside packages. One example use-case (which is used
-- in core libraries today) is as a way of passing flags which are
-- computed by a configure script into Cabal. In this case, the autoconf
-- build type adds hooks to read in a textual HookedBuildInfo
-- format prior to doing any operations.
--
-- Quite honestly, this mechanism is a massive hack since we shouldn't be
-- editing the PackageDescription data structure (it's easy to
-- assume that this data structure shouldn't change and run into bugs,
-- see for example 1c20a6328579af9e37677d507e2e9836ef70ab9d). But it's a
-- bit convenient, because there isn't another data structure that allows
-- adding extra BuildInfo style things.
--
-- In any case, a lot of care has to be taken to make sure the
-- HookedBuildInfo is applied to the PackageDescription.
-- In general this process occurs in Distribution.Simple, which is
-- responsible for orchestrating the hooks mechanism. The general
-- strategy:
--
--
-- - We run the pre-hook, which produces a HookedBuildInfo
-- (e.g., in the Autoconf case, it reads it out from a file).
-- - We sanity-check the hooked build info with
-- sanityCheckHookedBuildInfo.
-- - We update our PackageDescription (either freshly read or
-- cached from LocalBuildInfo) with
-- updatePackageDescription.
--
--
-- In principle, we are also supposed to update the copy of the
-- PackageDescription stored in LocalBuildInfo at
-- localPkgDescr. Unfortunately, in practice, there are lots of
-- Custom setup scripts which fail to update localPkgDescr so
-- you really shouldn't rely on it. It's not DEPRECATED because there are
-- legitimate uses for it, but... yeah. Sharp knife. See
-- https://github.com/haskell/cabal/issues/3606 for more
-- information on the issue.
--
-- It is not well-specified whether or not a HookedBuildInfo
-- applied at configure time is persistent to the
-- LocalBuildInfo. The fact that HookedBuildInfo is
-- passed to confHook MIGHT SUGGEST that the
-- HookedBuildInfo is applied at this time, but actually since
-- 9317b67e6122ab14e53f81b573bd0ecb388eca5a it has been ONLY used to
-- create a modified package description that we check for problems: it
-- is never actually saved to the LBI. Since HookedBuildInfo is
-- applied monoidally to the existing build infos (and it is not an
-- idempotent monoid), it could break things to save it, since we are
-- obligated to apply any new HookedBuildInfo and then we'd get
-- the effect twice. But this does mean we have to re-apply it every
-- time. Hey, it's more flexibility.
type HookedBuildInfo = (Maybe BuildInfo, [(UnqualComponentName, BuildInfo)])
emptyHookedBuildInfo :: HookedBuildInfo
module Distribution.Types.BuildInfo.Lens
data BuildInfo
-- | Classy lenses for BuildInfo.
class HasBuildInfo a
buildInfo :: HasBuildInfo a => Lens' a BuildInfo
buildable :: HasBuildInfo a => Lens' a Bool
buildTools :: HasBuildInfo a => Lens' a [LegacyExeDependency]
buildToolDepends :: HasBuildInfo a => Lens' a [ExeDependency]
cppOptions :: HasBuildInfo a => Lens' a [String]
asmOptions :: HasBuildInfo a => Lens' a [String]
cmmOptions :: HasBuildInfo a => Lens' a [String]
ccOptions :: HasBuildInfo a => Lens' a [String]
cxxOptions :: HasBuildInfo a => Lens' a [String]
ldOptions :: HasBuildInfo a => Lens' a [String]
hsc2hsOptions :: HasBuildInfo a => Lens' a [String]
pkgconfigDepends :: HasBuildInfo a => Lens' a [PkgconfigDependency]
frameworks :: HasBuildInfo a => Lens' a [String]
extraFrameworkDirs :: HasBuildInfo a => Lens' a [String]
asmSources :: HasBuildInfo a => Lens' a [FilePath]
cmmSources :: HasBuildInfo a => Lens' a [FilePath]
cSources :: HasBuildInfo a => Lens' a [FilePath]
cxxSources :: HasBuildInfo a => Lens' a [FilePath]
jsSources :: HasBuildInfo a => Lens' a [FilePath]
hsSourceDirs :: HasBuildInfo a => Lens' a [SymbolicPath PackageDir SourceDir]
otherModules :: HasBuildInfo a => Lens' a [ModuleName]
virtualModules :: HasBuildInfo a => Lens' a [ModuleName]
autogenModules :: HasBuildInfo a => Lens' a [ModuleName]
defaultLanguage :: HasBuildInfo a => Lens' a (Maybe Language)
otherLanguages :: HasBuildInfo a => Lens' a [Language]
defaultExtensions :: HasBuildInfo a => Lens' a [Extension]
otherExtensions :: HasBuildInfo a => Lens' a [Extension]
oldExtensions :: HasBuildInfo a => Lens' a [Extension]
extraLibs :: HasBuildInfo a => Lens' a [String]
extraGHCiLibs :: HasBuildInfo a => Lens' a [String]
extraBundledLibs :: HasBuildInfo a => Lens' a [String]
extraLibFlavours :: HasBuildInfo a => Lens' a [String]
extraDynLibFlavours :: HasBuildInfo a => Lens' a [String]
extraLibDirs :: HasBuildInfo a => Lens' a [String]
includeDirs :: HasBuildInfo a => Lens' a [FilePath]
includes :: HasBuildInfo a => Lens' a [FilePath]
autogenIncludes :: HasBuildInfo a => Lens' a [FilePath]
installIncludes :: HasBuildInfo a => Lens' a [FilePath]
options :: HasBuildInfo a => Lens' a (PerCompilerFlavor [String])
profOptions :: HasBuildInfo a => Lens' a (PerCompilerFlavor [String])
sharedOptions :: HasBuildInfo a => Lens' a (PerCompilerFlavor [String])
staticOptions :: HasBuildInfo a => Lens' a (PerCompilerFlavor [String])
customFieldsBI :: HasBuildInfo a => Lens' a [(String, String)]
targetBuildDepends :: HasBuildInfo a => Lens' a [Dependency]
mixins :: HasBuildInfo a => Lens' a [Mixin]
class HasBuildInfos a
traverseBuildInfos :: HasBuildInfos a => Traversal' a BuildInfo
instance Distribution.Types.BuildInfo.Lens.HasBuildInfo Distribution.Types.BuildInfo.BuildInfo
module Distribution.Types.TestSuite
-- | A "test-suite" stanza in a cabal file.
data TestSuite
TestSuite :: UnqualComponentName -> TestSuiteInterface -> BuildInfo -> TestSuite
[testName] :: TestSuite -> UnqualComponentName
[testInterface] :: TestSuite -> TestSuiteInterface
[testBuildInfo] :: TestSuite -> BuildInfo
emptyTestSuite :: TestSuite
testType :: TestSuite -> TestType
-- | Get all the module names from a test suite.
testModules :: TestSuite -> [ModuleName]
-- | Get all the auto generated module names from a test suite. This are a
-- subset of testModules.
testModulesAutogen :: TestSuite -> [ModuleName]
instance Data.Data.Data Distribution.Types.TestSuite.TestSuite
instance GHC.Classes.Eq Distribution.Types.TestSuite.TestSuite
instance GHC.Read.Read Distribution.Types.TestSuite.TestSuite
instance GHC.Show.Show Distribution.Types.TestSuite.TestSuite
instance GHC.Generics.Generic Distribution.Types.TestSuite.TestSuite
instance Distribution.Types.BuildInfo.Lens.HasBuildInfo Distribution.Types.TestSuite.TestSuite
instance Data.Binary.Class.Binary Distribution.Types.TestSuite.TestSuite
instance Distribution.Utils.Structured.Structured Distribution.Types.TestSuite.TestSuite
instance Control.DeepSeq.NFData Distribution.Types.TestSuite.TestSuite
instance GHC.Base.Monoid Distribution.Types.TestSuite.TestSuite
instance GHC.Base.Semigroup Distribution.Types.TestSuite.TestSuite
module Distribution.Types.TestSuite.Lens
-- | A "test-suite" stanza in a cabal file.
data TestSuite
testName :: Lens' TestSuite UnqualComponentName
testInterface :: Lens' TestSuite TestSuiteInterface
testBuildInfo :: Lens' TestSuite BuildInfo
module Distribution.Types.Library
data Library
Library :: LibraryName -> [ModuleName] -> [ModuleReexport] -> [ModuleName] -> Bool -> LibraryVisibility -> BuildInfo -> Library
[libName] :: Library -> LibraryName
[exposedModules] :: Library -> [ModuleName]
[reexportedModules] :: Library -> [ModuleReexport]
-- | What sigs need implementations?
[signatures] :: Library -> [ModuleName]
-- | Is the lib to be exposed by default? (i.e. whether its modules
-- available in GHCi for example)
[libExposed] :: Library -> Bool
-- | Whether this multilib can be dependent from outside.
[libVisibility] :: Library -> LibraryVisibility
[libBuildInfo] :: Library -> BuildInfo
emptyLibrary :: Library
-- | Get all the module names from the library (exposed and internal
-- modules) which are explicitly listed in the package description which
-- would need to be compiled. (This does not include reexports, which do
-- not need to be compiled.) This may not include all modules for which
-- GHC generated interface files (i.e., implicit modules.)
explicitLibModules :: Library -> [ModuleName]
-- | Get all the auto generated module names from the library, exposed or
-- not. This are a subset of libModules.
libModulesAutogen :: Library -> [ModuleName]
instance Data.Data.Data Distribution.Types.Library.Library
instance GHC.Read.Read Distribution.Types.Library.Library
instance GHC.Classes.Eq Distribution.Types.Library.Library
instance GHC.Show.Show Distribution.Types.Library.Library
instance GHC.Generics.Generic Distribution.Types.Library.Library
instance Distribution.Types.BuildInfo.Lens.HasBuildInfo Distribution.Types.Library.Library
instance Data.Binary.Class.Binary Distribution.Types.Library.Library
instance Distribution.Utils.Structured.Structured Distribution.Types.Library.Library
instance Control.DeepSeq.NFData Distribution.Types.Library.Library
instance GHC.Base.Monoid Distribution.Types.Library.Library
instance GHC.Base.Semigroup Distribution.Types.Library.Library
module Distribution.Types.Library.Lens
data Library
libName :: Lens' Library LibraryName
exposedModules :: Lens' Library [ModuleName]
reexportedModules :: Lens' Library [ModuleReexport]
signatures :: Lens' Library [ModuleName]
libExposed :: Lens' Library Bool
libVisibility :: Lens' Library LibraryVisibility
libBuildInfo :: Lens' Library BuildInfo
module Distribution.Types.ForeignLib
-- | A foreign library stanza is like a library stanza, except that the
-- built code is intended for consumption by a non-Haskell client.
data ForeignLib
ForeignLib :: UnqualComponentName -> ForeignLibType -> [ForeignLibOption] -> BuildInfo -> Maybe LibVersionInfo -> Maybe Version -> [FilePath] -> ForeignLib
-- | Name of the foreign library
[foreignLibName] :: ForeignLib -> UnqualComponentName
-- | What kind of foreign library is this (static or dynamic).
[foreignLibType] :: ForeignLib -> ForeignLibType
-- | What options apply to this foreign library (e.g., are we merging in
-- all foreign dependencies.)
[foreignLibOptions] :: ForeignLib -> [ForeignLibOption]
-- | Build information for this foreign library.
[foreignLibBuildInfo] :: ForeignLib -> BuildInfo
-- | Libtool-style version-info data to compute library version. Refer to
-- the libtool documentation on the current:revision:age versioning
-- scheme.
[foreignLibVersionInfo] :: ForeignLib -> Maybe LibVersionInfo
-- | Linux library version
[foreignLibVersionLinux] :: ForeignLib -> Maybe Version
-- | (Windows-specific) module definition files
--
-- This is a list rather than a maybe field so that we can flatten the
-- condition trees (for instance, when creating an sdist)
[foreignLibModDefFile] :: ForeignLib -> [FilePath]
-- | An empty foreign library.
emptyForeignLib :: ForeignLib
-- | Modules defined by a foreign library.
foreignLibModules :: ForeignLib -> [ModuleName]
-- | Is the foreign library shared?
foreignLibIsShared :: ForeignLib -> Bool
-- | Get a version number for a foreign library. If we're on Linux, and a
-- Linux version is specified, use that. If we're on Linux, and
-- libtool-style version-info is specified, translate that field into
-- appropriate version numbers. Otherwise, this feature is unsupported so
-- we don't return any version data.
foreignLibVersion :: ForeignLib -> OS -> [Int]
data LibVersionInfo
-- | Construct LibVersionInfo from (current, revision, age)
-- numbers.
--
-- For instance, mkLibVersionInfo (3,0,0) constructs a
-- LibVersionInfo representing the version-info 3:0:0.
--
-- All version components must be non-negative.
mkLibVersionInfo :: (Int, Int, Int) -> LibVersionInfo
-- | From a given LibVersionInfo, extract the (current,
-- revision, age) numbers.
libVersionInfoCRA :: LibVersionInfo -> (Int, Int, Int)
-- | Given a version-info field, produce a major.minor.build
-- version
libVersionNumber :: LibVersionInfo -> (Int, Int, Int)
-- | Given a version-info field, return "major.minor.build" as a
-- String
libVersionNumberShow :: LibVersionInfo -> String
-- | Return the major version of a version-info field.
libVersionMajor :: LibVersionInfo -> Int
instance GHC.Generics.Generic Distribution.Types.ForeignLib.LibVersionInfo
instance GHC.Classes.Eq Distribution.Types.ForeignLib.LibVersionInfo
instance Data.Data.Data Distribution.Types.ForeignLib.LibVersionInfo
instance Data.Data.Data Distribution.Types.ForeignLib.ForeignLib
instance GHC.Classes.Eq Distribution.Types.ForeignLib.ForeignLib
instance GHC.Read.Read Distribution.Types.ForeignLib.ForeignLib
instance GHC.Show.Show Distribution.Types.ForeignLib.ForeignLib
instance GHC.Generics.Generic Distribution.Types.ForeignLib.ForeignLib
instance Distribution.Types.BuildInfo.Lens.HasBuildInfo Distribution.Types.ForeignLib.ForeignLib
instance Data.Binary.Class.Binary Distribution.Types.ForeignLib.ForeignLib
instance Distribution.Utils.Structured.Structured Distribution.Types.ForeignLib.ForeignLib
instance Control.DeepSeq.NFData Distribution.Types.ForeignLib.ForeignLib
instance GHC.Base.Semigroup Distribution.Types.ForeignLib.ForeignLib
instance GHC.Base.Monoid Distribution.Types.ForeignLib.ForeignLib
instance GHC.Classes.Ord Distribution.Types.ForeignLib.LibVersionInfo
instance GHC.Show.Show Distribution.Types.ForeignLib.LibVersionInfo
instance GHC.Read.Read Distribution.Types.ForeignLib.LibVersionInfo
instance Data.Binary.Class.Binary Distribution.Types.ForeignLib.LibVersionInfo
instance Distribution.Utils.Structured.Structured Distribution.Types.ForeignLib.LibVersionInfo
instance Control.DeepSeq.NFData Distribution.Types.ForeignLib.LibVersionInfo
instance Distribution.Pretty.Pretty Distribution.Types.ForeignLib.LibVersionInfo
instance Distribution.Parsec.Parsec Distribution.Types.ForeignLib.LibVersionInfo
module Distribution.Types.ForeignLib.Lens
-- | A foreign library stanza is like a library stanza, except that the
-- built code is intended for consumption by a non-Haskell client.
data ForeignLib
foreignLibName :: Lens' ForeignLib UnqualComponentName
foreignLibType :: Lens' ForeignLib ForeignLibType
foreignLibOptions :: Lens' ForeignLib [ForeignLibOption]
foreignLibBuildInfo :: Lens' ForeignLib BuildInfo
foreignLibVersionInfo :: Lens' ForeignLib (Maybe LibVersionInfo)
foreignLibVersionLinux :: Lens' ForeignLib (Maybe Version)
foreignLibModDefFile :: Lens' ForeignLib [FilePath]
module Distribution.Types.Executable
data Executable
Executable :: UnqualComponentName -> FilePath -> ExecutableScope -> BuildInfo -> Executable
[exeName] :: Executable -> UnqualComponentName
[modulePath] :: Executable -> FilePath
[exeScope] :: Executable -> ExecutableScope
[buildInfo] :: Executable -> BuildInfo
emptyExecutable :: Executable
-- | Get all the module names from an exe
exeModules :: Executable -> [ModuleName]
-- | Get all the auto generated module names from an exe This are a subset
-- of exeModules.
exeModulesAutogen :: Executable -> [ModuleName]
instance Data.Data.Data Distribution.Types.Executable.Executable
instance GHC.Classes.Eq Distribution.Types.Executable.Executable
instance GHC.Read.Read Distribution.Types.Executable.Executable
instance GHC.Show.Show Distribution.Types.Executable.Executable
instance GHC.Generics.Generic Distribution.Types.Executable.Executable
instance Distribution.Types.BuildInfo.Lens.HasBuildInfo Distribution.Types.Executable.Executable
instance Data.Binary.Class.Binary Distribution.Types.Executable.Executable
instance Distribution.Utils.Structured.Structured Distribution.Types.Executable.Executable
instance Control.DeepSeq.NFData Distribution.Types.Executable.Executable
instance GHC.Base.Monoid Distribution.Types.Executable.Executable
instance GHC.Base.Semigroup Distribution.Types.Executable.Executable
module Distribution.Types.Executable.Lens
data Executable
exeName :: Lens' Executable UnqualComponentName
modulePath :: Lens' Executable String
exeScope :: Lens' Executable ExecutableScope
exeBuildInfo :: Lens' Executable BuildInfo
module Distribution.Types.Benchmark
-- | A "benchmark" stanza in a cabal file.
data Benchmark
Benchmark :: UnqualComponentName -> BenchmarkInterface -> BuildInfo -> Benchmark
[benchmarkName] :: Benchmark -> UnqualComponentName
[benchmarkInterface] :: Benchmark -> BenchmarkInterface
[benchmarkBuildInfo] :: Benchmark -> BuildInfo
emptyBenchmark :: Benchmark
benchmarkType :: Benchmark -> BenchmarkType
-- | Get all the module names from a benchmark.
benchmarkModules :: Benchmark -> [ModuleName]
-- | Get all the auto generated module names from a benchmark. This are a
-- subset of benchmarkModules.
benchmarkModulesAutogen :: Benchmark -> [ModuleName]
instance Data.Data.Data Distribution.Types.Benchmark.Benchmark
instance GHC.Classes.Eq Distribution.Types.Benchmark.Benchmark
instance GHC.Read.Read Distribution.Types.Benchmark.Benchmark
instance GHC.Show.Show Distribution.Types.Benchmark.Benchmark
instance GHC.Generics.Generic Distribution.Types.Benchmark.Benchmark
instance Data.Binary.Class.Binary Distribution.Types.Benchmark.Benchmark
instance Distribution.Utils.Structured.Structured Distribution.Types.Benchmark.Benchmark
instance Control.DeepSeq.NFData Distribution.Types.Benchmark.Benchmark
instance Distribution.Types.BuildInfo.Lens.HasBuildInfo Distribution.Types.Benchmark.Benchmark
instance GHC.Base.Monoid Distribution.Types.Benchmark.Benchmark
instance GHC.Base.Semigroup Distribution.Types.Benchmark.Benchmark
module Distribution.Types.Component
data Component
CLib :: Library -> Component
CFLib :: ForeignLib -> Component
CExe :: Executable -> Component
CTest :: TestSuite -> Component
CBench :: Benchmark -> Component
foldComponent :: (Library -> a) -> (ForeignLib -> a) -> (Executable -> a) -> (TestSuite -> a) -> (Benchmark -> a) -> Component -> a
componentBuildInfo :: Component -> BuildInfo
-- | Is a component buildable (i.e., not marked with buildable:
-- False)? See also this note in
-- Distribution.Types.ComponentRequestedSpec#buildable_vs_enabled_components.
componentBuildable :: Component -> Bool
componentName :: Component -> ComponentName
partitionComponents :: [Component] -> ([Library], [ForeignLib], [Executable], [TestSuite], [Benchmark])
instance GHC.Read.Read Distribution.Types.Component.Component
instance GHC.Classes.Eq Distribution.Types.Component.Component
instance GHC.Show.Show Distribution.Types.Component.Component
instance GHC.Base.Semigroup Distribution.Types.Component.Component
instance Distribution.Types.BuildInfo.Lens.HasBuildInfo Distribution.Types.Component.Component
module Distribution.Types.ComponentRequestedSpec
-- | Describes what components are enabled by user-interaction. See also
-- this note in
-- Distribution.Types.ComponentRequestedSpec#buildable_vs_enabled_components.
data ComponentRequestedSpec
ComponentRequestedSpec :: Bool -> Bool -> ComponentRequestedSpec
[testsRequested] :: ComponentRequestedSpec -> Bool
[benchmarksRequested] :: ComponentRequestedSpec -> Bool
OneComponentRequestedSpec :: ComponentName -> ComponentRequestedSpec
-- | A reason explaining why a component is disabled.
data ComponentDisabledReason
DisabledComponent :: ComponentDisabledReason
DisabledAllTests :: ComponentDisabledReason
DisabledAllBenchmarks :: ComponentDisabledReason
DisabledAllButOne :: String -> ComponentDisabledReason
-- | The default set of enabled components. Historically tests and
-- benchmarks are NOT enabled by default.
defaultComponentRequestedSpec :: ComponentRequestedSpec
-- | Is this component name enabled? See also this note in
-- Distribution.Types.ComponentRequestedSpec#buildable_vs_enabled_components.
componentNameRequested :: ComponentRequestedSpec -> ComponentName -> Bool
-- | Is this component enabled? See also this note in
-- Distribution.Types.ComponentRequestedSpec#buildable_vs_enabled_components.
componentEnabled :: ComponentRequestedSpec -> Component -> Bool
-- | Is this component disabled, and if so, why?
componentDisabledReason :: ComponentRequestedSpec -> Component -> Maybe ComponentDisabledReason
instance GHC.Classes.Eq Distribution.Types.ComponentRequestedSpec.ComponentRequestedSpec
instance GHC.Show.Show Distribution.Types.ComponentRequestedSpec.ComponentRequestedSpec
instance GHC.Read.Read Distribution.Types.ComponentRequestedSpec.ComponentRequestedSpec
instance GHC.Generics.Generic Distribution.Types.ComponentRequestedSpec.ComponentRequestedSpec
instance Data.Binary.Class.Binary Distribution.Types.ComponentRequestedSpec.ComponentRequestedSpec
instance Distribution.Utils.Structured.Structured Distribution.Types.ComponentRequestedSpec.ComponentRequestedSpec
-- | This defines the data structure for the .cabal file format.
-- There are several parts to this structure. It has top level info and
-- then Library, Executable, TestSuite, and
-- Benchmark sections each of which have associated
-- BuildInfo data that's used to build the library, exe, test, or
-- benchmark. To further complicate things there is both a
-- PackageDescription and a GenericPackageDescription.
-- This distinction relates to cabal configurations. When we initially
-- read a .cabal file we get a
-- GenericPackageDescription which has all the conditional
-- sections. Before actually building a package we have to decide on each
-- conditional. Once we've done that we get a PackageDescription.
-- It was done this way initially to avoid breaking too much stuff when
-- the feature was introduced. It could probably do with being
-- rationalised at some point to make it simpler.
module Distribution.Types.PackageDescription
-- | This data type is the internal representation of the file
-- pkg.cabal. It contains two kinds of information about the
-- package: information which is needed for all packages, such as the
-- package name and version, and information which is needed for the
-- simple build system only, such as the compiler options and library
-- name.
data PackageDescription
PackageDescription :: CabalSpecVersion -> PackageIdentifier -> Either License License -> [SymbolicPath PackageDir LicenseFile] -> !ShortText -> !ShortText -> !ShortText -> !ShortText -> [(CompilerFlavor, VersionRange)] -> !ShortText -> !ShortText -> !ShortText -> [SourceRepo] -> !ShortText -> !ShortText -> !ShortText -> [(String, String)] -> Maybe BuildType -> Maybe SetupBuildInfo -> Maybe Library -> [Library] -> [Executable] -> [ForeignLib] -> [TestSuite] -> [Benchmark] -> [FilePath] -> FilePath -> [FilePath] -> [FilePath] -> [FilePath] -> PackageDescription
-- | The version of the Cabal spec that this package description uses.
[specVersion] :: PackageDescription -> CabalSpecVersion
[package] :: PackageDescription -> PackageIdentifier
[licenseRaw] :: PackageDescription -> Either License License
[licenseFiles] :: PackageDescription -> [SymbolicPath PackageDir LicenseFile]
[copyright] :: PackageDescription -> !ShortText
[maintainer] :: PackageDescription -> !ShortText
[author] :: PackageDescription -> !ShortText
[stability] :: PackageDescription -> !ShortText
[testedWith] :: PackageDescription -> [(CompilerFlavor, VersionRange)]
[homepage] :: PackageDescription -> !ShortText
[pkgUrl] :: PackageDescription -> !ShortText
[bugReports] :: PackageDescription -> !ShortText
[sourceRepos] :: PackageDescription -> [SourceRepo]
-- | A one-line summary of this package
[synopsis] :: PackageDescription -> !ShortText
-- | A more verbose description of this package
[description] :: PackageDescription -> !ShortText
[category] :: PackageDescription -> !ShortText
-- | Custom fields starting with x-, stored in a simple assoc-list.
[customFieldsPD] :: PackageDescription -> [(String, String)]
-- | The original build-type value as parsed from the
-- .cabal file without defaulting. See also buildType.
[buildTypeRaw] :: PackageDescription -> Maybe BuildType
[setupBuildInfo] :: PackageDescription -> Maybe SetupBuildInfo
[library] :: PackageDescription -> Maybe Library
[subLibraries] :: PackageDescription -> [Library]
[executables] :: PackageDescription -> [Executable]
[foreignLibs] :: PackageDescription -> [ForeignLib]
[testSuites] :: PackageDescription -> [TestSuite]
[benchmarks] :: PackageDescription -> [Benchmark]
[dataFiles] :: PackageDescription -> [FilePath]
[dataDir] :: PackageDescription -> FilePath
[extraSrcFiles] :: PackageDescription -> [FilePath]
[extraTmpFiles] :: PackageDescription -> [FilePath]
[extraDocFiles] :: PackageDescription -> [FilePath]
-- | The SPDX LicenseExpression of the package.
license :: PackageDescription -> License
-- | See license.
license' :: Either License License -> License
-- | The effective build-type after applying defaulting rules.
--
-- The original build-type value parsed is stored in the
-- buildTypeRaw field. However, the build-type field is
-- optional and can therefore be empty in which case we need to compute
-- the effective build-type. This function implements the
-- following defaulting rules:
--
--
-- - For cabal-version:2.0 and below, default to the
-- Custom build-type unconditionally.
-- - Otherwise, if a custom-setup stanza is defined, default
-- to the Custom build-type; else default to Simple
-- build-type.
--
buildType :: PackageDescription -> BuildType
emptyPackageDescription :: PackageDescription
-- | Does this package have a buildable PUBLIC library?
hasPublicLib :: PackageDescription -> Bool
-- | Does this package have any libraries?
hasLibs :: PackageDescription -> Bool
allLibraries :: PackageDescription -> [Library]
-- | If the package description has a buildable library section, call the
-- given function with the library build info as argument. You probably
-- want withLibLBI if you have a LocalBuildInfo, see
-- the note in
-- Distribution.Types.ComponentRequestedSpec#buildable_vs_enabled_components
-- for more information.
withLib :: PackageDescription -> (Library -> IO ()) -> IO ()
-- | does this package have any executables?
hasExes :: PackageDescription -> Bool
-- | Perform the action on each buildable Executable in the package
-- description. You probably want withExeLBI if you have a
-- LocalBuildInfo, see the note in
-- Distribution.Types.ComponentRequestedSpec#buildable_vs_enabled_components
-- for more information.
withExe :: PackageDescription -> (Executable -> IO ()) -> IO ()
-- | Does this package have any test suites?
hasTests :: PackageDescription -> Bool
-- | Perform an action on each buildable TestSuite in a package. You
-- probably want withTestLBI if you have a
-- LocalBuildInfo, see the note in
-- Distribution.Types.ComponentRequestedSpec#buildable_vs_enabled_components
-- for more information.
withTest :: PackageDescription -> (TestSuite -> IO ()) -> IO ()
-- | Does this package have any benchmarks?
hasBenchmarks :: PackageDescription -> Bool
-- | Perform an action on each buildable Benchmark in a package. You
-- probably want withBenchLBI if you have a
-- LocalBuildInfo, see the note in
-- Distribution.Types.ComponentRequestedSpec#buildable_vs_enabled_components
-- for more information.
withBenchmark :: PackageDescription -> (Benchmark -> IO ()) -> IO ()
-- | Does this package have any foreign libraries?
hasForeignLibs :: PackageDescription -> Bool
-- | Perform the action on each buildable ForeignLib in the package
-- description.
withForeignLib :: PackageDescription -> (ForeignLib -> IO ()) -> IO ()
-- | All BuildInfo in the PackageDescription: libraries,
-- executables, test-suites and benchmarks.
--
-- Useful for implementing package checks.
allBuildInfo :: PackageDescription -> [BuildInfo]
-- | Return all of the BuildInfos of enabled components, i.e., all
-- of the ones that would be built if you run ./Setup build.
enabledBuildInfos :: PackageDescription -> ComponentRequestedSpec -> [BuildInfo]
-- | Get the combined build-depends entries of all components.
allBuildDepends :: PackageDescription -> [Dependency]
-- | Get the combined build-depends entries of all enabled components, per
-- the given request spec.
enabledBuildDepends :: PackageDescription -> ComponentRequestedSpec -> [Dependency]
updatePackageDescription :: HookedBuildInfo -> PackageDescription -> PackageDescription
-- | All the components in the package.
pkgComponents :: PackageDescription -> [Component]
-- | A list of all components in the package that are buildable, i.e., were
-- not marked with buildable: False. This does NOT indicate if
-- we are actually going to build the component, see
-- enabledComponents instead.
pkgBuildableComponents :: PackageDescription -> [Component]
-- | A list of all components in the package that are enabled.
enabledComponents :: PackageDescription -> ComponentRequestedSpec -> [Component]
lookupComponent :: PackageDescription -> ComponentName -> Maybe Component
getComponent :: PackageDescription -> ComponentName -> Component
instance Data.Data.Data Distribution.Types.PackageDescription.PackageDescription
instance GHC.Classes.Eq Distribution.Types.PackageDescription.PackageDescription
instance GHC.Read.Read Distribution.Types.PackageDescription.PackageDescription
instance GHC.Show.Show Distribution.Types.PackageDescription.PackageDescription
instance GHC.Generics.Generic Distribution.Types.PackageDescription.PackageDescription
instance Data.Binary.Class.Binary Distribution.Types.PackageDescription.PackageDescription
instance Distribution.Utils.Structured.Structured Distribution.Types.PackageDescription.PackageDescription
instance Control.DeepSeq.NFData Distribution.Types.PackageDescription.PackageDescription
instance Distribution.Package.Package Distribution.Types.PackageDescription.PackageDescription
instance Distribution.Types.BuildInfo.Lens.HasBuildInfos Distribution.Types.PackageDescription.PackageDescription
module Distribution.Types.GenericPackageDescription
data GenericPackageDescription
GenericPackageDescription :: PackageDescription -> Maybe Version -> [PackageFlag] -> Maybe (CondTree ConfVar [Dependency] Library) -> [(UnqualComponentName, CondTree ConfVar [Dependency] Library)] -> [(UnqualComponentName, CondTree ConfVar [Dependency] ForeignLib)] -> [(UnqualComponentName, CondTree ConfVar [Dependency] Executable)] -> [(UnqualComponentName, CondTree ConfVar [Dependency] TestSuite)] -> [(UnqualComponentName, CondTree ConfVar [Dependency] Benchmark)] -> GenericPackageDescription
[packageDescription] :: GenericPackageDescription -> PackageDescription
-- | This is a version as specified in source. We populate this field in
-- index reading for dummy GPDs, only when GPD reading failed, but
-- scanning haven't.
--
-- Cabal-the-library never produces GPDs with Just as gpdScannedVersion.
--
-- Perfectly, PackageIndex should have sum type, so we don't need to have
-- dummy GPDs.
[gpdScannedVersion] :: GenericPackageDescription -> Maybe Version
[genPackageFlags] :: GenericPackageDescription -> [PackageFlag]
[condLibrary] :: GenericPackageDescription -> Maybe (CondTree ConfVar [Dependency] Library)
[condSubLibraries] :: GenericPackageDescription -> [(UnqualComponentName, CondTree ConfVar [Dependency] Library)]
[condForeignLibs] :: GenericPackageDescription -> [(UnqualComponentName, CondTree ConfVar [Dependency] ForeignLib)]
[condExecutables] :: GenericPackageDescription -> [(UnqualComponentName, CondTree ConfVar [Dependency] Executable)]
[condTestSuites] :: GenericPackageDescription -> [(UnqualComponentName, CondTree ConfVar [Dependency] TestSuite)]
[condBenchmarks] :: GenericPackageDescription -> [(UnqualComponentName, CondTree ConfVar [Dependency] Benchmark)]
emptyGenericPackageDescription :: GenericPackageDescription
instance GHC.Generics.Generic Distribution.Types.GenericPackageDescription.GenericPackageDescription
instance Data.Data.Data Distribution.Types.GenericPackageDescription.GenericPackageDescription
instance GHC.Classes.Eq Distribution.Types.GenericPackageDescription.GenericPackageDescription
instance GHC.Show.Show Distribution.Types.GenericPackageDescription.GenericPackageDescription
instance Distribution.Package.Package Distribution.Types.GenericPackageDescription.GenericPackageDescription
instance Data.Binary.Class.Binary Distribution.Types.GenericPackageDescription.GenericPackageDescription
instance Distribution.Utils.Structured.Structured Distribution.Types.GenericPackageDescription.GenericPackageDescription
instance Control.DeepSeq.NFData Distribution.Types.GenericPackageDescription.GenericPackageDescription
instance Distribution.Types.BuildInfo.Lens.HasBuildInfos Distribution.Types.GenericPackageDescription.GenericPackageDescription
module Distribution.Types.GenericPackageDescription.Lens
data GenericPackageDescription
-- | A flag can represent a feature to be included, or a way of linking a
-- target against its dependencies, or in fact whatever you can think of.
data PackageFlag
-- | A FlagName is the name of a user-defined configuration flag
--
-- Use mkFlagName and unFlagName to convert from/to a
-- String.
--
-- This type is opaque since Cabal-2.0
data FlagName
-- | A ConfVar represents the variable type used.
data ConfVar
OS :: OS -> ConfVar
Arch :: Arch -> ConfVar
PackageFlag :: FlagName -> ConfVar
Impl :: CompilerFlavor -> VersionRange -> ConfVar
packageDescription :: Lens' GenericPackageDescription PackageDescription
gpdScannedVersion :: Lens' GenericPackageDescription (Maybe Version)
genPackageFlags :: Lens' GenericPackageDescription [PackageFlag]
condLibrary :: Lens' GenericPackageDescription (Maybe (CondTree ConfVar [Dependency] Library))
condSubLibraries :: Lens' GenericPackageDescription [(UnqualComponentName, CondTree ConfVar [Dependency] Library)]
condForeignLibs :: Lens' GenericPackageDescription [(UnqualComponentName, CondTree ConfVar [Dependency] ForeignLib)]
condExecutables :: Lens' GenericPackageDescription [(UnqualComponentName, CondTree ConfVar [Dependency] Executable)]
condTestSuites :: Lens' GenericPackageDescription [(UnqualComponentName, CondTree ConfVar [Dependency] TestSuite)]
condBenchmarks :: Lens' GenericPackageDescription [(UnqualComponentName, CondTree ConfVar [Dependency] Benchmark)]
allCondTrees :: Applicative f => (forall a. CondTree ConfVar [Dependency] a -> f (CondTree ConfVar [Dependency] a)) -> GenericPackageDescription -> f GenericPackageDescription
flagName :: Lens' PackageFlag FlagName
flagDescription :: Lens' PackageFlag String
flagDefault :: Lens' PackageFlag Bool
flagManual :: Lens' PackageFlag Bool
_OS :: Traversal' ConfVar OS
_Arch :: Traversal' ConfVar Arch
_PackageFlag :: Traversal' ConfVar FlagName
_Impl :: Traversal' ConfVar (CompilerFlavor, VersionRange)
module Distribution.Types.Benchmark.Lens
-- | A "benchmark" stanza in a cabal file.
data Benchmark
benchmarkName :: Lens' Benchmark UnqualComponentName
benchmarkInterface :: Lens' Benchmark BenchmarkInterface
benchmarkBuildInfo :: Lens' Benchmark BuildInfo
module Distribution.Types.PackageDescription.Lens
-- | This data type is the internal representation of the file
-- pkg.cabal. It contains two kinds of information about the
-- package: information which is needed for all packages, such as the
-- package name and version, and information which is needed for the
-- simple build system only, such as the compiler options and library
-- name.
data PackageDescription
package :: Lens' PackageDescription PackageIdentifier
licenseRaw :: Lens' PackageDescription (Either License License)
licenseFiles :: Lens' PackageDescription [SymbolicPath PackageDir LicenseFile]
copyright :: Lens' PackageDescription ShortText
maintainer :: Lens' PackageDescription ShortText
author :: Lens' PackageDescription ShortText
stability :: Lens' PackageDescription ShortText
testedWith :: Lens' PackageDescription [(CompilerFlavor, VersionRange)]
homepage :: Lens' PackageDescription ShortText
pkgUrl :: Lens' PackageDescription ShortText
bugReports :: Lens' PackageDescription ShortText
sourceRepos :: Lens' PackageDescription [SourceRepo]
synopsis :: Lens' PackageDescription ShortText
description :: Lens' PackageDescription ShortText
category :: Lens' PackageDescription ShortText
customFieldsPD :: Lens' PackageDescription [(String, String)]
specVersion :: Lens' PackageDescription CabalSpecVersion
buildTypeRaw :: Lens' PackageDescription (Maybe BuildType)
setupBuildInfo :: Lens' PackageDescription (Maybe SetupBuildInfo)
library :: Lens' PackageDescription (Maybe Library)
subLibraries :: Lens' PackageDescription [Library]
executables :: Lens' PackageDescription [Executable]
foreignLibs :: Lens' PackageDescription [ForeignLib]
testSuites :: Lens' PackageDescription [TestSuite]
benchmarks :: Lens' PackageDescription [Benchmark]
dataFiles :: Lens' PackageDescription [FilePath]
dataDir :: Lens' PackageDescription FilePath
extraSrcFiles :: Lens' PackageDescription [String]
extraTmpFiles :: Lens' PackageDescription [String]
extraDocFiles :: Lens' PackageDescription [String]
allLibraries :: Traversal' PackageDescription Library
componentModules :: Monoid r => ComponentName -> Getting r PackageDescription [ModuleName]
componentBuildInfo :: ComponentName -> Traversal' PackageDescription BuildInfo
module Distribution.Types.Lens
-- | Backwards compatibility reexport of most things you need to know about
-- .cabal files.
module Distribution.PackageDescription
-- | This modules provides functions for working with both the legacy
-- "build-tools" field, and its replacement, "build-tool-depends". Prefer
-- using the functions contained to access those fields directly.
module Distribution.Simple.BuildToolDepends
-- | Desugar a "build-tools" entry into proper a executable dependency if
-- possible.
--
-- An entry can be so desguared in two cases:
--
--
-- - The name in build-tools matches a locally defined executable. The
-- executable dependency produced is on that exe in the current
-- package.
-- - The name in build-tools matches a hard-coded set of known tools.
-- For now, the executable dependency produced is one an executable in a
-- package of the same, but the hard-coding could just as well be
-- per-key.
--
--
-- The first cases matches first.
desugarBuildTool :: PackageDescription -> LegacyExeDependency -> Maybe ExeDependency
-- | Get everything from "build-tool-depends", along with entries from
-- "build-tools" that we know how to desugar.
--
-- This should almost always be used instead of just accessing the
-- buildToolDepends field directly.
getAllToolDependencies :: PackageDescription -> BuildInfo -> [ExeDependency]
-- | Does the given executable dependency map to this current package?
--
-- This is a tiny function, but used in a number of places.
--
-- This function is only sound to call on BuildInfos from the
-- given package description. This is because it just filters the package
-- names of each dependency, and does not check whether version bounds in
-- fact exclude the current package, or the referenced components in fact
-- exist in the current package.
--
-- This is OK because when a package is loaded, it is checked (in
-- Check) that dependencies matching internal components do indeed
-- have version bounds accepting the current package, and any depended-on
-- component in the current package actually exists. In fact this check
-- is performed by gathering the internal tool dependencies of each
-- component of the package according to this module, and ensuring those
-- properties on each so-gathered dependency.
--
-- version bounds and components of the package are unchecked. This is
-- because we sanitize exe deps so that the matching name implies these
-- other conditions.
isInternal :: PackageDescription -> ExeDependency -> Bool
-- | Get internal "build-tool-depends", along with internal "build-tools"
--
-- This is a tiny function, but used in a number of places. The same
-- restrictions that apply to isInternal also apply to this
-- function.
getAllInternalToolDependencies :: PackageDescription -> BuildInfo -> [UnqualComponentName]
-- | This manages everything to do with where files get installed (though
-- does not get involved with actually doing any installation). It
-- provides an InstallDirs type which is a set of directories for
-- where to install things. It also handles the fact that we use
-- templates in these install dirs. For example most install dirs are
-- relative to some $prefix and by changing the prefix all other
-- dirs still end up changed appropriately. So it provides a
-- PathTemplate type and functions for substituting for these
-- templates.
module Distribution.Simple.InstallDirs
-- | The directories where we will install files for packages.
--
-- We have several different directories for different types of files
-- since many systems have conventions whereby different types of files
-- in a package are installed in different directories. This is
-- particularly the case on Unix style systems.
data InstallDirs dir
InstallDirs :: dir -> dir -> dir -> dir -> dir -> dir -> dir -> dir -> dir -> dir -> dir -> dir -> dir -> dir -> dir -> dir -> InstallDirs dir
[prefix] :: InstallDirs dir -> dir
[bindir] :: InstallDirs dir -> dir
[libdir] :: InstallDirs dir -> dir
[libsubdir] :: InstallDirs dir -> dir
[dynlibdir] :: InstallDirs dir -> dir
-- | foreign libraries
[flibdir] :: InstallDirs dir -> dir
[libexecdir] :: InstallDirs dir -> dir
[libexecsubdir] :: InstallDirs dir -> dir
[includedir] :: InstallDirs dir -> dir
[datadir] :: InstallDirs dir -> dir
[datasubdir] :: InstallDirs dir -> dir
[docdir] :: InstallDirs dir -> dir
[mandir] :: InstallDirs dir -> dir
[htmldir] :: InstallDirs dir -> dir
[haddockdir] :: InstallDirs dir -> dir
[sysconfdir] :: InstallDirs dir -> dir
-- | The installation directories in terms of PathTemplates that
-- contain variables.
--
-- The defaults for most of the directories are relative to each other,
-- in particular they are all relative to a single prefix. This makes it
-- convenient for the user to override the default installation directory
-- by only having to specify --prefix=... rather than overriding each
-- individually. This is done by allowing $-style variables in the dirs.
-- These are expanded by textual substitution (see
-- substPathTemplate).
--
-- A few of these installation directories are split into two components,
-- the dir and subdir. The full installation path is formed by combining
-- the two together with /. The reason for this is compatibility
-- with other Unix build systems which also support --libdir and
-- --datadir. We would like users to be able to configure
-- --libdir=/usr/lib64 for example but because by default we
-- want to support installing multiple versions of packages and building
-- the same package for multiple compilers we append the libsubdir to
-- get: /usr/lib64/$libname/$compiler.
--
-- An additional complication is the need to support relocatable packages
-- on systems which support such things, like Windows.
type InstallDirTemplates = InstallDirs PathTemplate
defaultInstallDirs :: CompilerFlavor -> Bool -> Bool -> IO InstallDirTemplates
defaultInstallDirs' :: Bool -> CompilerFlavor -> Bool -> Bool -> IO InstallDirTemplates
combineInstallDirs :: (a -> b -> c) -> InstallDirs a -> InstallDirs b -> InstallDirs c
-- | Convert from abstract install directories to actual absolute ones by
-- substituting for all the variables in the abstract paths, to get real
-- absolute path.
absoluteInstallDirs :: PackageIdentifier -> UnitId -> CompilerInfo -> CopyDest -> Platform -> InstallDirs PathTemplate -> InstallDirs FilePath
-- | The location prefix for the copy command.
data CopyDest
NoCopyDest :: CopyDest
CopyTo :: FilePath -> CopyDest
-- | when using the ${pkgroot} as prefix. The CopyToDb will adjust the
-- paths to be relative to the provided package database when copying /
-- installing.
CopyToDb :: FilePath -> CopyDest
-- | Check which of the paths are relative to the installation $prefix.
--
-- If any of the paths are not relative, ie they are absolute paths, then
-- it prevents us from making a relocatable package (also known as a
-- "prefix independent" package).
prefixRelativeInstallDirs :: PackageIdentifier -> UnitId -> CompilerInfo -> Platform -> InstallDirTemplates -> InstallDirs (Maybe FilePath)
-- | Substitute the install dir templates into each other.
--
-- To prevent cyclic substitutions, only some variables are allowed in
-- particular dir templates. If out of scope vars are present, they are
-- not substituted for. Checking for any remaining unsubstituted vars can
-- be done as a subsequent operation.
--
-- The reason it is done this way is so that in
-- prefixRelativeInstallDirs we can replace prefix with the
-- PrefixVar and get resulting PathTemplates that still
-- have the PrefixVar in them. Doing this makes it each to check
-- which paths are relative to the $prefix.
substituteInstallDirTemplates :: PathTemplateEnv -> InstallDirTemplates -> InstallDirTemplates
-- | An abstract path, possibly containing variables that need to be
-- substituted for to get a real FilePath.
data PathTemplate
data PathTemplateVariable
-- | The $prefix path variable
PrefixVar :: PathTemplateVariable
-- | The $bindir path variable
BindirVar :: PathTemplateVariable
-- | The $libdir path variable
LibdirVar :: PathTemplateVariable
-- | The $libsubdir path variable
LibsubdirVar :: PathTemplateVariable
-- | The $dynlibdir path variable
DynlibdirVar :: PathTemplateVariable
-- | The $datadir path variable
DatadirVar :: PathTemplateVariable
-- | The $datasubdir path variable
DatasubdirVar :: PathTemplateVariable
-- | The $docdir path variable
DocdirVar :: PathTemplateVariable
-- | The $htmldir path variable
HtmldirVar :: PathTemplateVariable
-- | The $pkg package name path variable
PkgNameVar :: PathTemplateVariable
-- | The $version package version path variable
PkgVerVar :: PathTemplateVariable
-- | The $pkgid package Id path variable, eg foo-1.0
PkgIdVar :: PathTemplateVariable
-- | The $libname path variable
LibNameVar :: PathTemplateVariable
-- | The compiler name and version, eg ghc-6.6.1
CompilerVar :: PathTemplateVariable
-- | The operating system name, eg windows or linux
OSVar :: PathTemplateVariable
-- | The CPU architecture name, eg i386 or x86_64
ArchVar :: PathTemplateVariable
-- | The compiler's ABI identifier,
AbiVar :: PathTemplateVariable
-- | The optional ABI tag for the compiler
AbiTagVar :: PathTemplateVariable
-- | The executable name; used in shell wrappers
ExecutableNameVar :: PathTemplateVariable
-- | The name of the test suite being run
TestSuiteNameVar :: PathTemplateVariable
-- | The result of the test suite being run, eg pass,
-- fail, or error.
TestSuiteResultVar :: PathTemplateVariable
-- | The name of the benchmark being run
BenchmarkNameVar :: PathTemplateVariable
type PathTemplateEnv = [(PathTemplateVariable, PathTemplate)]
-- | Convert a FilePath to a PathTemplate including any
-- template vars.
toPathTemplate :: FilePath -> PathTemplate
-- | Convert back to a path, any remaining vars are included
fromPathTemplate :: PathTemplate -> FilePath
combinePathTemplate :: PathTemplate -> PathTemplate -> PathTemplate
substPathTemplate :: PathTemplateEnv -> PathTemplate -> PathTemplate
-- | The initial environment has all the static stuff but no paths
initialPathTemplateEnv :: PackageIdentifier -> UnitId -> CompilerInfo -> Platform -> PathTemplateEnv
platformTemplateEnv :: Platform -> PathTemplateEnv
compilerTemplateEnv :: CompilerInfo -> PathTemplateEnv
packageTemplateEnv :: PackageIdentifier -> UnitId -> PathTemplateEnv
abiTemplateEnv :: CompilerInfo -> Platform -> PathTemplateEnv
installDirsTemplateEnv :: InstallDirs PathTemplate -> PathTemplateEnv
instance GHC.Generics.Generic (Distribution.Simple.InstallDirs.InstallDirs dir)
instance GHC.Base.Functor Distribution.Simple.InstallDirs.InstallDirs
instance GHC.Show.Show dir => GHC.Show.Show (Distribution.Simple.InstallDirs.InstallDirs dir)
instance GHC.Read.Read dir => GHC.Read.Read (Distribution.Simple.InstallDirs.InstallDirs dir)
instance GHC.Classes.Eq dir => GHC.Classes.Eq (Distribution.Simple.InstallDirs.InstallDirs dir)
instance GHC.Generics.Generic Distribution.Simple.InstallDirs.CopyDest
instance GHC.Show.Show Distribution.Simple.InstallDirs.CopyDest
instance GHC.Classes.Eq Distribution.Simple.InstallDirs.CopyDest
instance GHC.Generics.Generic Distribution.Simple.InstallDirs.PathTemplate
instance GHC.Classes.Ord Distribution.Simple.InstallDirs.PathTemplate
instance GHC.Classes.Eq Distribution.Simple.InstallDirs.PathTemplate
instance Data.Binary.Class.Binary Distribution.Simple.InstallDirs.PathTemplate
instance Distribution.Utils.Structured.Structured Distribution.Simple.InstallDirs.PathTemplate
instance GHC.Show.Show Distribution.Simple.InstallDirs.PathTemplate
instance GHC.Read.Read Distribution.Simple.InstallDirs.PathTemplate
instance Data.Binary.Class.Binary Distribution.Simple.InstallDirs.CopyDest
instance Data.Binary.Class.Binary dir => Data.Binary.Class.Binary (Distribution.Simple.InstallDirs.InstallDirs dir)
instance Distribution.Utils.Structured.Structured dir => Distribution.Utils.Structured.Structured (Distribution.Simple.InstallDirs.InstallDirs dir)
instance (GHC.Base.Semigroup dir, GHC.Base.Monoid dir) => GHC.Base.Monoid (Distribution.Simple.InstallDirs.InstallDirs dir)
instance GHC.Base.Semigroup dir => GHC.Base.Semigroup (Distribution.Simple.InstallDirs.InstallDirs dir)
-- | This module provides newtype wrappers to be used with
-- Distribution.FieldGrammar.
module Distribution.FieldGrammar.Newtypes
-- | alaList and alaList' are simply List, with
-- additional phantom arguments to constrain the resulting type
--
--
-- >>> :t alaList VCat
-- alaList VCat :: [a] -> List VCat (Identity a) a
--
--
--
-- >>> :t alaList' FSep Token
-- alaList' FSep Token :: [String] -> List FSep Token String
--
alaList :: sep -> [a] -> List sep (Identity a) a
-- | More general version of alaList.
alaList' :: sep -> (a -> b) -> [a] -> List sep b a
-- | Vertical list with commas. Displayed with vcat
data CommaVCat
CommaVCat :: CommaVCat
-- | Paragraph fill list with commas. Displayed with fsep
data CommaFSep
CommaFSep :: CommaFSep
-- | Vertical list with optional commas. Displayed with vcat.
data VCat
VCat :: VCat
-- | Paragraph fill list with optional commas. Displayed with fsep.
data FSep
FSep :: FSep
-- | Paragraph fill list without commas. Displayed with fsep.
data NoCommaFSep
NoCommaFSep :: NoCommaFSep
class Sep sep
prettySep :: Sep sep => Proxy sep -> [Doc] -> Doc
parseSep :: (Sep sep, CabalParsing m) => Proxy sep -> m a -> m [a]
parseSepNE :: (Sep sep, CabalParsing m) => Proxy sep -> m a -> m (NonEmpty a)
-- | List separated with optional commas. Displayed with sep,
-- arguments of type a are parsed and pretty-printed as
-- b.
data List sep b a
-- | alaSet and alaSet' are simply Set' constructor,
-- with additional phantom arguments to constrain the resulting type
--
--
-- >>> :t alaSet VCat
-- alaSet VCat :: Set a -> Set' VCat (Identity a) a
--
--
--
-- >>> :t alaSet' FSep Token
-- alaSet' FSep Token :: Set String -> Set' FSep Token String
--
--
--
-- >>> unpack' (alaSet' FSep Token) <$> eitherParsec "foo bar foo"
-- Right (fromList ["bar","foo"])
--
alaSet :: sep -> Set a -> Set' sep (Identity a) a
-- | More general version of alaSet.
alaSet' :: sep -> (a -> b) -> Set a -> Set' sep b a
-- | Like List, but for Set.
data Set' sep b a
-- | alaNonEmpty and alaNonEmpty' are simply NonEmpty'
-- constructor, with additional phantom arguments to constrain the
-- resulting type
--
--
-- >>> :t alaNonEmpty VCat
-- alaNonEmpty VCat :: NonEmpty a -> NonEmpty' VCat (Identity a) a
--
--
--
-- >>> unpack' (alaNonEmpty' FSep Token) <$> eitherParsec "foo bar foo"
-- Right ("foo" :| ["bar","foo"])
--
alaNonEmpty :: sep -> NonEmpty a -> NonEmpty' sep (Identity a) a
-- | More general version of alaNonEmpty.
alaNonEmpty' :: sep -> (a -> b) -> NonEmpty a -> NonEmpty' sep b a
-- | Like List, but for NonEmpty.
data NonEmpty' sep b a
-- | Version range or just version, i.e. cabal-version field.
--
-- There are few things to consider:
--
--
-- - Starting with 2.2 the cabal-version field should be the first
-- field in the file and only exact version is accepted. Therefore if we
-- get e.g. >= 2.2, we fail. See
-- https://github.com/haskell/cabal/issues/4899
--
--
-- We have this newtype, as writing Parsec and Pretty instances for
-- CabalSpecVersion would cause cycle in modules: Version ->
-- CabalSpecVersion -> Parsec -> ...
newtype SpecVersion
SpecVersion :: CabalSpecVersion -> SpecVersion
[getSpecVersion] :: SpecVersion -> CabalSpecVersion
-- | Version range or just version
newtype TestedWith
TestedWith :: (CompilerFlavor, VersionRange) -> TestedWith
[getTestedWith] :: TestedWith -> (CompilerFlavor, VersionRange)
-- | SPDX License expression or legacy license
newtype SpecLicense
SpecLicense :: Either License License -> SpecLicense
[getSpecLicense] :: SpecLicense -> Either License License
-- | Haskell string or [^ ,]+
newtype Token
Token :: String -> Token
[getToken] :: Token -> String
-- | Haskell string or [^ ]+
newtype Token'
Token' :: String -> Token'
[getToken'] :: Token' -> String
-- | Either "quoted" or un-quoted.
newtype MQuoted a
MQuoted :: a -> MQuoted a
[getMQuoted] :: MQuoted a -> a
-- | Filepath are parsed as Token.
newtype FilePathNT
FilePathNT :: String -> FilePathNT
[getFilePathNT] :: FilePathNT -> String
instance GHC.Show.Show Distribution.FieldGrammar.Newtypes.SpecVersion
instance GHC.Classes.Eq Distribution.FieldGrammar.Newtypes.SpecVersion
instance Distribution.Compat.Newtype.Newtype (Distribution.Compiler.CompilerFlavor, Distribution.Types.VersionRange.Internal.VersionRange) Distribution.FieldGrammar.Newtypes.TestedWith
instance Distribution.Parsec.Parsec Distribution.FieldGrammar.Newtypes.TestedWith
instance Distribution.Pretty.Pretty Distribution.FieldGrammar.Newtypes.TestedWith
instance Distribution.Compat.Newtype.Newtype (Data.Either.Either Distribution.SPDX.License.License Distribution.License.License) Distribution.FieldGrammar.Newtypes.SpecLicense
instance Distribution.Parsec.Parsec Distribution.FieldGrammar.Newtypes.SpecLicense
instance Distribution.Pretty.Pretty Distribution.FieldGrammar.Newtypes.SpecLicense
instance Distribution.Compat.Newtype.Newtype Distribution.CabalSpecVersion.CabalSpecVersion Distribution.FieldGrammar.Newtypes.SpecVersion
instance Distribution.Parsec.Parsec Distribution.FieldGrammar.Newtypes.SpecVersion
instance Distribution.Pretty.Pretty Distribution.FieldGrammar.Newtypes.SpecVersion
instance Distribution.Compat.Newtype.Newtype GHC.Base.String Distribution.FieldGrammar.Newtypes.FilePathNT
instance Distribution.Parsec.Parsec Distribution.FieldGrammar.Newtypes.FilePathNT
instance Distribution.Pretty.Pretty Distribution.FieldGrammar.Newtypes.FilePathNT
instance Distribution.Compat.Newtype.Newtype a (Distribution.FieldGrammar.Newtypes.MQuoted a)
instance Distribution.Parsec.Parsec a => Distribution.Parsec.Parsec (Distribution.FieldGrammar.Newtypes.MQuoted a)
instance Distribution.Pretty.Pretty a => Distribution.Pretty.Pretty (Distribution.FieldGrammar.Newtypes.MQuoted a)
instance Distribution.Compat.Newtype.Newtype GHC.Base.String Distribution.FieldGrammar.Newtypes.Token'
instance Distribution.Parsec.Parsec Distribution.FieldGrammar.Newtypes.Token'
instance Distribution.Pretty.Pretty Distribution.FieldGrammar.Newtypes.Token'
instance Distribution.Compat.Newtype.Newtype GHC.Base.String Distribution.FieldGrammar.Newtypes.Token
instance Distribution.Parsec.Parsec Distribution.FieldGrammar.Newtypes.Token
instance Distribution.Pretty.Pretty Distribution.FieldGrammar.Newtypes.Token
instance Distribution.Compat.Newtype.Newtype (GHC.Base.NonEmpty a) (Distribution.FieldGrammar.Newtypes.NonEmpty' sep wrapper a)
instance (Distribution.Compat.Newtype.Newtype a b, Distribution.FieldGrammar.Newtypes.Sep sep, Distribution.Parsec.Parsec b) => Distribution.Parsec.Parsec (Distribution.FieldGrammar.Newtypes.NonEmpty' sep b a)
instance (Distribution.Compat.Newtype.Newtype a b, Distribution.FieldGrammar.Newtypes.Sep sep, Distribution.Pretty.Pretty b) => Distribution.Pretty.Pretty (Distribution.FieldGrammar.Newtypes.NonEmpty' sep b a)
instance Distribution.Compat.Newtype.Newtype (Data.Set.Internal.Set a) (Distribution.FieldGrammar.Newtypes.Set' sep wrapper a)
instance (Distribution.Compat.Newtype.Newtype a b, GHC.Classes.Ord a, Distribution.FieldGrammar.Newtypes.Sep sep, Distribution.Parsec.Parsec b) => Distribution.Parsec.Parsec (Distribution.FieldGrammar.Newtypes.Set' sep b a)
instance (Distribution.Compat.Newtype.Newtype a b, Distribution.FieldGrammar.Newtypes.Sep sep, Distribution.Pretty.Pretty b) => Distribution.Pretty.Pretty (Distribution.FieldGrammar.Newtypes.Set' sep b a)
instance Distribution.Compat.Newtype.Newtype [a] (Distribution.FieldGrammar.Newtypes.List sep wrapper a)
instance (Distribution.Compat.Newtype.Newtype a b, Distribution.FieldGrammar.Newtypes.Sep sep, Distribution.Parsec.Parsec b) => Distribution.Parsec.Parsec (Distribution.FieldGrammar.Newtypes.List sep b a)
instance (Distribution.Compat.Newtype.Newtype a b, Distribution.FieldGrammar.Newtypes.Sep sep, Distribution.Pretty.Pretty b) => Distribution.Pretty.Pretty (Distribution.FieldGrammar.Newtypes.List sep b a)
instance Distribution.FieldGrammar.Newtypes.Sep Distribution.FieldGrammar.Newtypes.CommaVCat
instance Distribution.FieldGrammar.Newtypes.Sep Distribution.FieldGrammar.Newtypes.CommaFSep
instance Distribution.FieldGrammar.Newtypes.Sep Distribution.FieldGrammar.Newtypes.VCat
instance Distribution.FieldGrammar.Newtypes.Sep Distribution.FieldGrammar.Newtypes.FSep
instance Distribution.FieldGrammar.Newtypes.Sep Distribution.FieldGrammar.Newtypes.NoCommaFSep
-- | A large and somewhat miscellaneous collection of utility functions
-- used throughout the rest of the Cabal lib and in other tools that use
-- the Cabal lib like cabal-install. It has a very simple set of
-- logging actions. It has low level functions for running programs, a
-- bunch of wrappers for various directory and file functions that do
-- extra logging.
module Distribution.Simple.Utils
cabalVersion :: Version
dieNoVerbosity :: String -> IO a
die' :: Verbosity -> String -> IO a
dieWithLocation' :: Verbosity -> FilePath -> Maybe Int -> String -> IO a
dieNoWrap :: Verbosity -> String -> IO a
topHandler :: IO a -> IO a
topHandlerWith :: forall a. (SomeException -> IO a) -> IO a -> IO a
-- | Non fatal conditions that may be indicative of an error or problem.
--
-- We display these at the normal verbosity level.
warn :: Verbosity -> String -> IO ()
-- | Useful status messages.
--
-- We display these at the normal verbosity level.
--
-- This is for the ordinary helpful status messages that users see. Just
-- enough information to know that things are working but not floods of
-- detail.
notice :: Verbosity -> String -> IO ()
-- | Display a message at normal verbosity level, but without
-- wrapping.
noticeNoWrap :: Verbosity -> String -> IO ()
-- | Pretty-print a Doc status message at normal verbosity
-- level. Use this if you need fancy formatting.
noticeDoc :: Verbosity -> Doc -> IO ()
-- | Display a "setup status message". Prefer using setupMessage' if
-- possible.
setupMessage :: Verbosity -> String -> PackageIdentifier -> IO ()
-- | More detail on the operation of some action.
--
-- We display these messages when the verbosity level is verbose
info :: Verbosity -> String -> IO ()
infoNoWrap :: Verbosity -> String -> IO ()
-- | Detailed internal debugging information
--
-- We display these messages when the verbosity level is deafening
debug :: Verbosity -> String -> IO ()
-- | A variant of debug that doesn't perform the automatic line
-- wrapping. Produces better output in some cases.
debugNoWrap :: Verbosity -> String -> IO ()
-- | Perform an IO action, catching any IO exceptions and printing an error
-- if one occurs.
chattyTry :: String -> IO () -> IO ()
-- | Given a block of IO code that may raise an exception, annotate it with
-- the metadata from the current scope. Use this as close to external
-- code that raises IO exceptions as possible, since this function
-- unconditionally wraps the error message with a trace (so it is NOT
-- idempotent.)
annotateIO :: Verbosity -> IO a -> IO a
printRawCommandAndArgs :: Verbosity -> FilePath -> [String] -> IO ()
printRawCommandAndArgsAndEnv :: Verbosity -> FilePath -> [String] -> Maybe FilePath -> Maybe [(String, String)] -> IO ()
-- | Wrap output with a marker if +markoutput verbosity flag is
-- set.
--
-- NB: Why is markoutput done with start/end markers, and not prefixes?
-- Markers are more convenient to add (if we want to add prefixes, we
-- have to lines and then map; here's it's just some
-- concatenates). Note that even in the prefix case, we can't guarantee
-- that the markers are unambiguous, because some of Cabal's output comes
-- straight from external programs, where we don't have the ability to
-- interpose on the output.
--
-- This is used by withMetadata
withOutputMarker :: Verbosity -> String -> String
-- | Run an IO computation, returning e if it raises a "file does
-- not exist" error.
handleDoesNotExist :: a -> IO a -> IO a
rawSystemExit :: Verbosity -> FilePath -> [String] -> IO ()
rawSystemExitCode :: Verbosity -> FilePath -> [String] -> IO ExitCode
rawSystemExitWithEnv :: Verbosity -> FilePath -> [String] -> [(String, String)] -> IO ()
-- | Run a command and return its output.
--
-- The output is assumed to be text in the locale encoding.
rawSystemStdout :: forall mode. KnownIODataMode mode => Verbosity -> FilePath -> [String] -> IO mode
-- | Run a command and return its output, errors and exit status.
-- Optionally also supply some input. Also provides control over whether
-- the binary/text mode of the input and output.
rawSystemStdInOut :: KnownIODataMode mode => Verbosity -> FilePath -> [String] -> Maybe FilePath -> Maybe [(String, String)] -> Maybe IOData -> IODataMode mode -> IO (mode, String, ExitCode)
rawSystemIOWithEnv :: Verbosity -> FilePath -> [String] -> Maybe FilePath -> Maybe [(String, String)] -> Maybe Handle -> Maybe Handle -> Maybe Handle -> IO ExitCode
rawSystemIOWithEnvAndAction :: Verbosity -> FilePath -> [String] -> Maybe FilePath -> Maybe [(String, String)] -> IO a -> Maybe Handle -> Maybe Handle -> Maybe Handle -> IO (ExitCode, a)
createProcessWithEnv :: Verbosity -> FilePath -> [String] -> Maybe FilePath -> Maybe [(String, String)] -> StdStream -> StdStream -> StdStream -> IO (Maybe Handle, Maybe Handle, Maybe Handle, ProcessHandle)
maybeExit :: IO ExitCode -> IO ()
-- | Like the Unix xargs program. Useful for when we've got very long
-- command lines that might overflow an OS limit on command line length
-- and so you need to invoke a command multiple times to get all the args
-- in.
--
-- Use it with either of the rawSystem variants above. For example:
--
--
-- xargs (32*1024) (rawSystemExit verbosity) prog fixedArgs bigArgs
--
xargs :: Int -> ([String] -> IO ()) -> [String] -> [String] -> IO ()
-- | Look for a program and try to find it's version number. It can accept
-- either an absolute path or the name of a program binary, in which case
-- we will look for the program on the path.
findProgramVersion :: String -> (String -> String) -> Verbosity -> FilePath -> IO (Maybe Version)
-- | Represents either textual or binary data passed via I/O functions
-- which support binary/text mode
data IOData
-- | How Text gets encoded is usually locale-dependent.
IODataText :: String -> IOData
-- | Raw binary which gets read/written in binary mode.
IODataBinary :: ByteString -> IOData
class NFData mode => KnownIODataMode mode
-- | IOData Wrapper for hGetContents
--
-- Note: This operation uses lazy I/O. Use NFData to force
-- all data to be read and consequently the internal file handle to be
-- closed.
hGetIODataContents :: KnownIODataMode mode => Handle -> IO mode
toIOData :: KnownIODataMode mode => mode -> IOData
iodataMode :: KnownIODataMode mode => IODataMode mode
data IODataMode mode
[IODataModeText] :: IODataMode String
[IODataModeBinary] :: IODataMode ByteString
-- | Same as createDirectoryIfMissing but logs at higher verbosity
-- levels.
createDirectoryIfMissingVerbose :: Verbosity -> Bool -> FilePath -> IO ()
-- | Copies a file without copying file permissions. The target file is
-- created with default permissions. Any existing target file is
-- replaced.
--
-- At higher verbosity levels it logs an info message.
copyFileVerbose :: Verbosity -> FilePath -> FilePath -> IO ()
-- | Copies a bunch of files to a target directory, preserving the
-- directory structure in the target location. The target directories are
-- created if they do not exist.
--
-- The files are identified by a pair of base directory and a path
-- relative to that base. It is only the relative part that is preserved
-- in the destination.
--
-- For example:
--
--
-- copyFiles normal "dist/src"
-- [("", "src/Foo.hs"), ("dist/build/", "src/Bar.hs")]
--
--
-- This would copy "src/Foo.hs" to "dist/src/src/Foo.hs" and copy
-- "dist/build/src/Bar.hs" to "dist/src/src/Bar.hs".
--
-- This operation is not atomic. Any IO failure during the copy
-- (including any missing source files) leaves the target in an unknown
-- state so it is best to use it with a freshly created directory so that
-- it can be simply deleted if anything goes wrong.
copyFiles :: Verbosity -> FilePath -> [(FilePath, FilePath)] -> IO ()
-- | Given a relative path to a file, copy it to the given directory,
-- preserving the relative path and creating the parent directories if
-- needed.
copyFileTo :: Verbosity -> FilePath -> FilePath -> IO ()
-- | Install an ordinary file. This is like a file copy but the permissions
-- are set appropriately for an installed file. On Unix it is
-- "-rw-r--r--" while on Windows it uses the default permissions for the
-- target directory.
installOrdinaryFile :: Verbosity -> FilePath -> FilePath -> IO ()
-- | Install an executable file. This is like a file copy but the
-- permissions are set appropriately for an installed file. On Unix it is
-- "-rwxr-xr-x" while on Windows it uses the default permissions for the
-- target directory.
installExecutableFile :: Verbosity -> FilePath -> FilePath -> IO ()
-- | Install a file that may or not be executable, preserving permissions.
installMaybeExecutableFile :: Verbosity -> FilePath -> FilePath -> IO ()
-- | This is like copyFiles but uses installOrdinaryFile.
installOrdinaryFiles :: Verbosity -> FilePath -> [(FilePath, FilePath)] -> IO ()
-- | This is like copyFiles but uses installExecutableFile.
installExecutableFiles :: Verbosity -> FilePath -> [(FilePath, FilePath)] -> IO ()
-- | This is like copyFiles but uses
-- installMaybeExecutableFile.
installMaybeExecutableFiles :: Verbosity -> FilePath -> [(FilePath, FilePath)] -> IO ()
-- | This installs all the files in a directory to a target location,
-- preserving the directory layout. All the files are assumed to be
-- ordinary rather than executable files.
installDirectoryContents :: Verbosity -> FilePath -> FilePath -> IO ()
-- | Recursively copy the contents of one directory to another path.
copyDirectoryRecursive :: Verbosity -> FilePath -> FilePath -> IO ()
-- | Like doesFileExist, but also checks that the file is
-- executable.
doesExecutableExist :: FilePath -> IO Bool
setFileOrdinary :: FilePath -> IO ()
setFileExecutable :: FilePath -> IO ()
-- | The path name that represents the current directory. In Unix, it's
-- ".", but this is system-specific. (E.g. AmigaOS uses the
-- empty string "" for the current directory.)
currentDir :: FilePath
shortRelativePath :: FilePath -> FilePath -> FilePath
-- | Drop the extension if it's one of exeExtensions, or return the
-- path unchanged.
dropExeExtension :: FilePath -> FilePath
-- | List of possible executable file extensions on the current build
-- platform.
exeExtensions :: [String]
-- | Find a file by looking in a search path. The file path must match
-- exactly.
findFileEx :: Verbosity -> [FilePath] -> FilePath -> IO FilePath
-- | Find a file by looking in a search path. The file path must match
-- exactly.
findFileCwd :: Verbosity -> FilePath -> [FilePath] -> FilePath -> IO FilePath
findFirstFile :: (a -> FilePath) -> [a] -> IO (Maybe a)
-- | Find a file by looking in a search path with one of a list of possible
-- file extensions. The file base name should be given and it will be
-- tried with each of the extensions in each element of the search path.
findFileWithExtension :: [String] -> [FilePath] -> FilePath -> IO (Maybe FilePath)
findFileCwdWithExtension :: FilePath -> [String] -> [FilePath] -> FilePath -> IO (Maybe FilePath)
-- | Like findFileWithExtension but returns which element of the
-- search path the file was found in, and the file path relative to that
-- base directory.
findFileWithExtension' :: [String] -> [FilePath] -> FilePath -> IO (Maybe (FilePath, FilePath))
findAllFilesWithExtension :: [String] -> [FilePath] -> FilePath -> IO [FilePath]
findAllFilesCwdWithExtension :: FilePath -> [String] -> [FilePath] -> FilePath -> IO [FilePath]
-- | Find the file corresponding to a Haskell module name.
--
-- This is similar to findFileWithExtension' but specialised to a
-- module name. The function fails if the file corresponding to the
-- module is missing.
findModuleFileEx :: Verbosity -> [FilePath] -> [String] -> ModuleName -> IO (FilePath, FilePath)
-- | Finds the files corresponding to a list of Haskell module names.
--
-- As findModuleFile but for a list of module names.
findModuleFilesEx :: Verbosity -> [FilePath] -> [String] -> [ModuleName] -> IO [(FilePath, FilePath)]
-- | List all the files in a directory and all subdirectories.
--
-- The order places files in sub-directories after all the files in their
-- parent directories. The list is generated lazily so is not well
-- defined if the source directory structure changes before the list is
-- used.
getDirectoryContentsRecursive :: FilePath -> IO [FilePath]
-- | Is this directory in the system search path?
isInSearchPath :: FilePath -> IO Bool
addLibraryPath :: OS -> [FilePath] -> [(String, String)] -> [(String, String)]
-- | Compare the modification times of two files to see if the first is
-- newer than the second. The first file must exist but the second need
-- not. The expected use case is when the second file is generated using
-- the first. In this use case, if the result is True then the second
-- file is out of date.
moreRecentFile :: FilePath -> FilePath -> IO Bool
-- | Like moreRecentFile, but also checks that the first file
-- exists.
existsAndIsMoreRecentThan :: FilePath -> FilePath -> IO Bool
-- | Advanced options for withTempFile and withTempDirectory.
data TempFileOptions
TempFileOptions :: Bool -> TempFileOptions
-- | Keep temporary files?
[optKeepTempFiles] :: TempFileOptions -> Bool
defaultTempFileOptions :: TempFileOptions
-- | Use a temporary filename that doesn't already exist.
withTempFile :: FilePath -> String -> (FilePath -> Handle -> IO a) -> IO a
-- | A version of withTempFile that additionally takes a
-- TempFileOptions argument.
withTempFileEx :: TempFileOptions -> FilePath -> String -> (FilePath -> Handle -> IO a) -> IO a
-- | Create and use a temporary directory.
--
-- Creates a new temporary directory inside the given directory, making
-- use of the template. The temp directory is deleted after use. For
-- example:
--
--
-- withTempDirectory verbosity "src" "sdist." $ \tmpDir -> do ...
--
--
-- The tmpDir will be a new subdirectory of the given directory,
-- e.g. src/sdist.342.
withTempDirectory :: Verbosity -> FilePath -> String -> (FilePath -> IO a) -> IO a
-- | A version of withTempDirectory that additionally takes a
-- TempFileOptions argument.
withTempDirectoryEx :: Verbosity -> TempFileOptions -> FilePath -> String -> (FilePath -> IO a) -> IO a
createTempDirectory :: FilePath -> String -> IO FilePath
-- | Package description file (pkgname.cabal)
defaultPackageDesc :: Verbosity -> IO FilePath
-- | Find a package description file in the given directory. Looks for
-- .cabal files.
findPackageDesc :: FilePath -> IO (Either String FilePath)
findPackageDescCwd :: FilePath -> FilePath -> IO (Either String FilePath)
-- | Like findPackageDesc, but calls die in case of error.
tryFindPackageDesc :: Verbosity -> FilePath -> IO FilePath
-- | Like findPackageDescCwd, but calls die in case of
-- error.
tryFindPackageDescCwd :: Verbosity -> FilePath -> FilePath -> IO FilePath
-- | Find auxiliary package information in the given directory. Looks for
-- .buildinfo files.
findHookedPackageDesc :: Verbosity -> FilePath -> IO (Maybe FilePath)
-- | Gets the contents of a file, but guarantee that it gets closed.
--
-- The file is read lazily but if it is not fully consumed by the action
-- then the remaining input is truncated and the file is closed.
withFileContents :: FilePath -> (String -> IO a) -> IO a
-- | Writes a file atomically.
--
-- The file is either written successfully or an IO exception is raised
-- and the original file is left unchanged.
--
-- On windows it is not possible to delete a file that is open by a
-- process. This case will give an IO exception but the atomic property
-- is not affected.
writeFileAtomic :: FilePath -> ByteString -> IO ()
-- | Write a file but only if it would have new content. If we would be
-- writing the same as the existing content then leave the file as is so
-- that we do not update the file's modification time.
--
-- NB: Before Cabal-3.0 the file content was assumed to be
-- ASCII-representable. Since Cabal-3.0 the file is assumed to be UTF-8
-- encoded.
rewriteFileEx :: Verbosity -> FilePath -> String -> IO ()
-- | Same as rewriteFileEx but for ByteStrings.
rewriteFileLBS :: Verbosity -> FilePath -> ByteString -> IO ()
-- | Decode String from UTF8-encoded ByteString
--
-- Invalid data in the UTF8 stream (this includes code-points
-- U+D800 through U+DFFF) will be decoded as the
-- replacement character (U+FFFD).
fromUTF8BS :: ByteString -> String
-- | Variant of fromUTF8BS for lazy ByteStrings
fromUTF8LBS :: ByteString -> String
-- | Encode String to UTF8-encoded ByteString
--
-- Code-points in the U+D800-U+DFFF range will be
-- encoded as the replacement character (i.e. U+FFFD).
toUTF8BS :: String -> ByteString
-- | Variant of toUTF8BS for lazy ByteStrings
toUTF8LBS :: String -> ByteString
-- | Reads a UTF8 encoded text file as a Unicode String
--
-- Reads lazily using ordinary readFile.
readUTF8File :: FilePath -> IO String
-- | Reads a UTF8 encoded text file as a Unicode String
--
-- Same behaviour as withFileContents.
withUTF8FileContents :: FilePath -> (String -> IO a) -> IO a
-- | Writes a Unicode String as a UTF8 encoded text file.
--
-- Uses writeFileAtomic, so provides the same guarantees.
writeUTF8File :: FilePath -> String -> IO ()
-- | Fix different systems silly line ending conventions
normaliseLineEndings :: String -> String
-- | Ignore a Unicode byte order mark (BOM) at the beginning of the input
ignoreBOM :: String -> String
-- | dropWhileEndLE p is equivalent to reverse . dropWhile p .
-- reverse, but quite a bit faster. The difference between
-- "Data.List.dropWhileEnd" and this version is that the one in
-- Data.List is strict in elements, but spine-lazy, while this one
-- is spine-strict but lazy in elements. That's what LE stands
-- for - "lazy in elements".
--
-- Example:
--
--
-- >>> safeTail $ Data.List.dropWhileEnd (<3) [undefined, 5, 4, 3, 2, 1]
-- *** Exception: Prelude.undefined
-- ...
--
--
--
-- >>> safeTail $ dropWhileEndLE (<3) [undefined, 5, 4, 3, 2, 1]
-- [5,4,3]
--
--
--
-- >>> take 3 $ Data.List.dropWhileEnd (<3) [5, 4, 3, 2, 1, undefined]
-- [5,4,3]
--
--
--
-- >>> take 3 $ dropWhileEndLE (<3) [5, 4, 3, 2, 1, undefined]
-- *** Exception: Prelude.undefined
-- ...
--
dropWhileEndLE :: (a -> Bool) -> [a] -> [a]
-- | takeWhileEndLE p is equivalent to reverse . takeWhile p .
-- reverse, but is usually faster (as well as being easier to read).
takeWhileEndLE :: (a -> Bool) -> [a] -> [a]
equating :: Eq a => (b -> a) -> b -> b -> Bool
-- |
-- comparing p x y = compare (p x) (p y)
--
--
-- Useful combinator for use in conjunction with the xxxBy
-- family of functions from Data.List, for example:
--
--
-- ... sortBy (comparing fst) ...
--
comparing :: Ord a => (b -> a) -> b -> b -> Ordering
-- | The isInfixOf function takes two lists and returns True
-- iff the first list is contained, wholly and intact, anywhere within
-- the second.
--
--
-- >>> isInfixOf "Haskell" "I really like Haskell."
-- True
--
--
--
-- >>> isInfixOf "Ial" "I really like Haskell."
-- False
--
isInfixOf :: Eq a => [a] -> [a] -> Bool
-- | intercalate xs xss is equivalent to (concat
-- (intersperse xs xss)). It inserts the list xs in
-- between the lists in xss and concatenates the result.
--
--
-- >>> intercalate ", " ["Lorem", "ipsum", "dolor"]
-- "Lorem, ipsum, dolor"
--
intercalate :: [a] -> [[a]] -> [a]
-- | Lower case string
--
--
-- >>> lowercase "Foobar"
-- "foobar"
--
lowercase :: String -> String
-- | Like "Data.List.union", but has O(n log n) complexity instead
-- of O(n^2).
listUnion :: Ord a => [a] -> [a] -> [a]
-- | A right-biased version of listUnion.
--
-- Example:
--
--
-- >>> listUnion [1,2,3,4,3] [2,1,1]
-- [1,2,3,4,3]
--
--
--
-- >>> listUnionRight [1,2,3,4,3] [2,1,1]
-- [4,3,2,1,1]
--
listUnionRight :: Ord a => [a] -> [a] -> [a]
-- | Like nub, but has O(n log n) complexity instead of
-- O(n^2). Code for ordNub and listUnion taken
-- from Niklas Hambüchen's ordnub package.
ordNub :: Ord a => [a] -> [a]
-- | Like ordNub and nubBy. Selects a key for each element
-- and takes the nub based on that key.
ordNubBy :: Ord b => (a -> b) -> [a] -> [a]
-- | A right-biased version of ordNub.
--
-- Example:
--
--
-- >>> ordNub [1,2,1] :: [Int]
-- [1,2]
--
--
--
-- >>> ordNubRight [1,2,1] :: [Int]
-- [2,1]
--
ordNubRight :: Ord a => [a] -> [a]
-- | A total variant of head.
safeHead :: [a] -> Maybe a
-- | A total variant of tail.
safeTail :: [a] -> [a]
-- | A total variant of last.
safeLast :: [a] -> Maybe a
-- | A total variant of init.
safeInit :: [a] -> [a]
unintersperse :: Char -> String -> [String]
-- | Wraps text to the default line width. Existing newlines are preserved.
wrapText :: String -> String
-- | Wraps a list of words to a list of lines of words of a particular
-- width.
wrapLine :: Int -> [String] -> [[String]]
-- | isAbsoluteOnAnyPlatform and isRelativeOnAnyPlatform are
-- like isAbsolute and isRelative but have platform
-- independent heuristics. The System.FilePath exists in two versions,
-- Windows and Posix. The two versions don't agree on what is a relative
-- path and we don't know if we're given Windows or Posix paths. This
-- results in false positives when running on Posix and inspecting
-- Windows paths, like the hackage server does.
-- System.FilePath.Posix.isAbsolute "C:\hello" == False
-- System.FilePath.Windows.isAbsolute "/hello" == False This means that
-- we would treat paths that start with "/" to be absolute. On Posix they
-- are indeed absolute, while on Windows they are not.
--
-- The portable versions should be used when we might deal with paths
-- that are from another OS than the host OS. For example, the Hackage
-- Server deals with both Windows and Posix paths while performing the
-- PackageDescription checks. In contrast, when we run 'cabal configure'
-- we do expect the paths to be correct for our OS and we should not have
-- to use the platform independent heuristics.
isAbsoluteOnAnyPlatform :: FilePath -> Bool
-- |
-- isRelativeOnAnyPlatform = not . isAbsoluteOnAnyPlatform
--
isRelativeOnAnyPlatform :: FilePath -> Bool
-- | Deprecated: Use findFileEx instead. This symbol will be removed in
-- Cabal 3.2 (est. December 2019)
findFile :: [FilePath] -> FilePath -> IO FilePath
-- | Deprecated: Use findModuleFileEx instead. This symbol will be
-- removed in Cabal 3.2 (est. December 2019)
findModuleFile :: [FilePath] -> [String] -> ModuleName -> IO (FilePath, FilePath)
-- | Deprecated: Use findModuleFilesEx instead. This symbol will be
-- removed in Cabal 3.2 (est. December 2019)
findModuleFiles :: [FilePath] -> [String] -> [ModuleName] -> IO [(FilePath, FilePath)]
instance GHC.Classes.Eq Distribution.Simple.Utils.TraceWhen
module Distribution.Utils.NubList
-- | NubList : A de-duplicated list that maintains the original order.
data NubList a
-- | Smart constructor for the NubList type.
toNubList :: Ord a => [a] -> NubList a
fromNubList :: NubList a -> [a]
-- | Lift a function over lists to a function over NubLists.
overNubList :: Ord a => ([a] -> [a]) -> NubList a -> NubList a
-- | NubListR : A right-biased version of NubList. That is
-- toNubListR ["-XNoFoo", "-XFoo", "-XNoFoo"] will result in
-- ["-XFoo", "-XNoFoo"], unlike the normal NubList, which
-- is left-biased. Built on top of ordNubRight and
-- listUnionRight.
data NubListR a
-- | Smart constructor for the NubListR type.
toNubListR :: Ord a => [a] -> NubListR a
fromNubListR :: NubListR a -> [a]
-- | Lift a function over lists to a function over NubListRs.
overNubListR :: Ord a => ([a] -> [a]) -> NubListR a -> NubListR a
instance GHC.Generics.Generic (Distribution.Utils.NubList.NubList a)
instance GHC.Classes.Eq a => GHC.Classes.Eq (Distribution.Utils.NubList.NubList a)
instance GHC.Classes.Eq a => GHC.Classes.Eq (Distribution.Utils.NubList.NubListR a)
instance GHC.Classes.Ord a => GHC.Base.Monoid (Distribution.Utils.NubList.NubListR a)
instance GHC.Classes.Ord a => GHC.Base.Semigroup (Distribution.Utils.NubList.NubListR a)
instance GHC.Show.Show a => GHC.Show.Show (Distribution.Utils.NubList.NubListR a)
instance (GHC.Classes.Ord a, GHC.Read.Read a) => GHC.Read.Read (Distribution.Utils.NubList.NubListR a)
instance GHC.Classes.Ord a => GHC.Base.Monoid (Distribution.Utils.NubList.NubList a)
instance GHC.Classes.Ord a => GHC.Base.Semigroup (Distribution.Utils.NubList.NubList a)
instance GHC.Show.Show a => GHC.Show.Show (Distribution.Utils.NubList.NubList a)
instance (GHC.Classes.Ord a, GHC.Read.Read a) => GHC.Read.Read (Distribution.Utils.NubList.NubList a)
instance (GHC.Classes.Ord a, Data.Binary.Class.Binary a) => Data.Binary.Class.Binary (Distribution.Utils.NubList.NubList a)
instance Distribution.Utils.Structured.Structured a => Distribution.Utils.Structured.Structured (Distribution.Utils.NubList.NubList a)
module Distribution.Utils.LogProgress
-- | The Progress monad with specialized logging and error messages.
data LogProgress a
-- | Run LogProgress, outputting traces according to
-- Verbosity, die if there is an error.
runLogProgress :: Verbosity -> LogProgress a -> IO a
-- | Output a warning trace message in LogProgress.
warnProgress :: Doc -> LogProgress ()
-- | Output an informational trace message in LogProgress.
infoProgress :: Doc -> LogProgress ()
-- | Fail the computation with an error message.
dieProgress :: Doc -> LogProgress a
-- | Add a message to the error/warning context.
addProgressCtx :: CtxMsg -> LogProgress a -> LogProgress a
instance GHC.Base.Functor Distribution.Utils.LogProgress.LogProgress
instance GHC.Base.Applicative Distribution.Utils.LogProgress.LogProgress
instance GHC.Base.Monad Distribution.Utils.LogProgress.LogProgress
module Distribution.Simple.Program.ResponseFile
withResponseFile :: Verbosity -> TempFileOptions -> FilePath -> FilePath -> Maybe TextEncoding -> [String] -> (FilePath -> IO a) -> IO a
-- | A somewhat extended notion of the normal program search path concept.
--
-- Usually when finding executables we just want to look in the usual
-- places using the OS's usual method for doing so. In Haskell the normal
-- OS-specific method is captured by findExecutable. On all common
-- OSs that makes use of a PATH environment variable, (though on
-- Windows it is not just the PATH).
--
-- However it is sometimes useful to be able to look in additional
-- locations without having to change the process-global PATH
-- environment variable. So we need an extension of the usual
-- findExecutable that can look in additional locations, either
-- before, after or instead of the normal OS locations.
module Distribution.Simple.Program.Find
-- | A search path to use when locating executables. This is analogous to
-- the unix $PATH or win32 %PATH% but with the ability
-- to use the system default method for finding executables
-- (findExecutable which on unix is simply looking on the
-- $PATH but on win32 is a bit more complicated).
--
-- The default to use is [ProgSearchPathDefault] but you can add
-- extra dirs either before, after or instead of the default, e.g. here
-- we add an extra dir to search after the usual ones.
--
--
-- ['ProgramSearchPathDefault', 'ProgramSearchPathDir' dir]
--
type ProgramSearchPath = [ProgramSearchPathEntry]
data ProgramSearchPathEntry
-- | A specific dir
ProgramSearchPathDir :: FilePath -> ProgramSearchPathEntry
-- | The system default
ProgramSearchPathDefault :: ProgramSearchPathEntry
defaultProgramSearchPath :: ProgramSearchPath
findProgramOnSearchPath :: Verbosity -> ProgramSearchPath -> FilePath -> IO (Maybe (FilePath, [FilePath]))
-- | Interpret a ProgramSearchPath to construct a new $PATH
-- env var. Note that this is close but not perfect because on Windows
-- the search algorithm looks at more than just the %PATH%.
programSearchPathAsPATHVar :: ProgramSearchPath -> IO String
-- | Get the system search path. On Unix systems this is just the
-- $PATH env var, but on windows it's a bit more complicated.
getSystemSearchPath :: IO [FilePath]
instance GHC.Generics.Generic Distribution.Simple.Program.Find.ProgramSearchPathEntry
instance GHC.Classes.Eq Distribution.Simple.Program.Find.ProgramSearchPathEntry
instance Data.Binary.Class.Binary Distribution.Simple.Program.Find.ProgramSearchPathEntry
instance Distribution.Utils.Structured.Structured Distribution.Simple.Program.Find.ProgramSearchPathEntry
-- | This provides an abstraction which deals with configuring and running
-- programs. A Program is a static notion of a known program. A
-- ConfiguredProgram is a Program that has been found on
-- the current machine and is ready to be run (possibly with some
-- user-supplied default args). Configuring a program involves finding
-- its location and if necessary finding its version. There's reasonable
-- default behavior for trying to find "foo" in PATH, being able to
-- override its location, etc.
module Distribution.Simple.Program.Types
-- | Represents a program which can be configured.
--
-- Note: rather than constructing this directly, start with
-- simpleProgram and override any extra fields.
data Program
Program :: String -> (Verbosity -> ProgramSearchPath -> IO (Maybe (FilePath, [FilePath]))) -> (Verbosity -> FilePath -> IO (Maybe Version)) -> (Verbosity -> ConfiguredProgram -> IO ConfiguredProgram) -> (Maybe Version -> PackageDescription -> [String] -> [String]) -> Program
-- | The simple name of the program, eg. ghc
[programName] :: Program -> String
-- | A function to search for the program if its location was not specified
-- by the user. Usually this will just be a call to
-- findProgramOnSearchPath.
--
-- It is supplied with the prevailing search path which will typically
-- just be used as-is, but can be extended or ignored as needed.
--
-- For the purpose of change monitoring, in addition to the location
-- where the program was found, it returns all the other places that were
-- tried.
[programFindLocation] :: Program -> Verbosity -> ProgramSearchPath -> IO (Maybe (FilePath, [FilePath]))
-- | Try to find the version of the program. For many programs this is not
-- possible or is not necessary so it's OK to return Nothing.
[programFindVersion] :: Program -> Verbosity -> FilePath -> IO (Maybe Version)
-- | A function to do any additional configuration after we have located
-- the program (and perhaps identified its version). For example it could
-- add args, or environment vars.
[programPostConf] :: Program -> Verbosity -> ConfiguredProgram -> IO ConfiguredProgram
-- | A function that filters any arguments that don't impact the output
-- from a commandline. Used to limit the volatility of dependency hashes
-- when using new-build.
[programNormaliseArgs] :: Program -> Maybe Version -> PackageDescription -> [String] -> [String]
-- | A search path to use when locating executables. This is analogous to
-- the unix $PATH or win32 %PATH% but with the ability
-- to use the system default method for finding executables
-- (findExecutable which on unix is simply looking on the
-- $PATH but on win32 is a bit more complicated).
--
-- The default to use is [ProgSearchPathDefault] but you can add
-- extra dirs either before, after or instead of the default, e.g. here
-- we add an extra dir to search after the usual ones.
--
--
-- ['ProgramSearchPathDefault', 'ProgramSearchPathDir' dir]
--
type ProgramSearchPath = [ProgramSearchPathEntry]
data ProgramSearchPathEntry
-- | A specific dir
ProgramSearchPathDir :: FilePath -> ProgramSearchPathEntry
-- | The system default
ProgramSearchPathDefault :: ProgramSearchPathEntry
-- | Make a simple named program.
--
-- By default we'll just search for it in the path and not try to find
-- the version name. You can override these behaviours if necessary, eg:
--
--
-- (simpleProgram "foo") { programFindLocation = ... , programFindVersion ... }
--
simpleProgram :: String -> Program
-- | Represents a program which has been configured and is thus ready to be
-- run.
--
-- These are usually made by configuring a Program, but if you
-- have to construct one directly then start with
-- simpleConfiguredProgram and override any extra fields.
data ConfiguredProgram
ConfiguredProgram :: String -> Maybe Version -> [String] -> [String] -> [(String, Maybe String)] -> Map String String -> ProgramLocation -> [FilePath] -> ConfiguredProgram
-- | Just the name again
[programId] :: ConfiguredProgram -> String
-- | The version of this program, if it is known.
[programVersion] :: ConfiguredProgram -> Maybe Version
-- | Default command-line args for this program. These flags will appear
-- first on the command line, so they can be overridden by subsequent
-- flags.
[programDefaultArgs] :: ConfiguredProgram -> [String]
-- | Override command-line args for this program. These flags will appear
-- last on the command line, so they override all earlier flags.
[programOverrideArgs] :: ConfiguredProgram -> [String]
-- | Override environment variables for this program. These env vars will
-- extend/override the prevailing environment of the current to form the
-- environment for the new process.
[programOverrideEnv] :: ConfiguredProgram -> [(String, Maybe String)]
-- | A key-value map listing various properties of the program, useful for
-- feature detection. Populated during the configuration step, key names
-- depend on the specific program.
[programProperties] :: ConfiguredProgram -> Map String String
-- | Location of the program. eg. /usr/bin/ghc-6.4
[programLocation] :: ConfiguredProgram -> ProgramLocation
-- | In addition to the programLocation where the program was found,
-- these are additional locations that were looked at. The combination of
-- ths found location and these not-found locations can be used to
-- monitor to detect when the re-configuring the program might give a
-- different result (e.g. found in a different location).
[programMonitorFiles] :: ConfiguredProgram -> [FilePath]
-- | The full path of a configured program.
programPath :: ConfiguredProgram -> FilePath
-- | Suppress any extra arguments added by the user.
suppressOverrideArgs :: ConfiguredProgram -> ConfiguredProgram
type ProgArg = String
-- | Where a program was found. Also tells us whether it's specified by
-- user or not. This includes not just the path, but the program as well.
data ProgramLocation
-- | The user gave the path to this program, eg.
-- --ghc-path=/usr/bin/ghc-6.6
UserSpecified :: FilePath -> ProgramLocation
[locationPath] :: ProgramLocation -> FilePath
-- | The program was found automatically.
FoundOnSystem :: FilePath -> ProgramLocation
[locationPath] :: ProgramLocation -> FilePath
-- | Make a simple ConfiguredProgram.
--
--
-- simpleConfiguredProgram "foo" (FoundOnSystem path)
--
simpleConfiguredProgram :: String -> ProgramLocation -> ConfiguredProgram
instance GHC.Show.Show Distribution.Simple.Program.Types.ProgramLocation
instance GHC.Read.Read Distribution.Simple.Program.Types.ProgramLocation
instance GHC.Generics.Generic Distribution.Simple.Program.Types.ProgramLocation
instance GHC.Classes.Eq Distribution.Simple.Program.Types.ProgramLocation
instance GHC.Show.Show Distribution.Simple.Program.Types.ConfiguredProgram
instance GHC.Read.Read Distribution.Simple.Program.Types.ConfiguredProgram
instance GHC.Generics.Generic Distribution.Simple.Program.Types.ConfiguredProgram
instance GHC.Classes.Eq Distribution.Simple.Program.Types.ConfiguredProgram
instance GHC.Show.Show Distribution.Simple.Program.Types.Program
instance Data.Binary.Class.Binary Distribution.Simple.Program.Types.ConfiguredProgram
instance Distribution.Utils.Structured.Structured Distribution.Simple.Program.Types.ConfiguredProgram
instance Data.Binary.Class.Binary Distribution.Simple.Program.Types.ProgramLocation
instance Distribution.Utils.Structured.Structured Distribution.Simple.Program.Types.ProgramLocation
-- | This module provides a data type for program invocations and functions
-- to run them.
module Distribution.Simple.Program.Run
-- | Represents a specific invocation of a specific program.
--
-- This is used as an intermediate type between deciding how to call a
-- program and actually doing it. This provides the opportunity to the
-- caller to adjust how the program will be called. These invocations can
-- either be run directly or turned into shell or batch scripts.
data ProgramInvocation
ProgramInvocation :: FilePath -> [String] -> [(String, Maybe String)] -> [FilePath] -> Maybe FilePath -> Maybe IOData -> IOEncoding -> IOEncoding -> ProgramInvocation
[progInvokePath] :: ProgramInvocation -> FilePath
[progInvokeArgs] :: ProgramInvocation -> [String]
[progInvokeEnv] :: ProgramInvocation -> [(String, Maybe String)]
[progInvokePathEnv] :: ProgramInvocation -> [FilePath]
[progInvokeCwd] :: ProgramInvocation -> Maybe FilePath
[progInvokeInput] :: ProgramInvocation -> Maybe IOData
-- | TODO: remove this, make user decide when constructing
-- progInvokeInput.
[progInvokeInputEncoding] :: ProgramInvocation -> IOEncoding
[progInvokeOutputEncoding] :: ProgramInvocation -> IOEncoding
data IOEncoding
IOEncodingText :: IOEncoding
IOEncodingUTF8 :: IOEncoding
emptyProgramInvocation :: ProgramInvocation
simpleProgramInvocation :: FilePath -> [String] -> ProgramInvocation
programInvocation :: ConfiguredProgram -> [String] -> ProgramInvocation
-- | Like the unix xargs program. Useful for when we've got very long
-- command lines that might overflow an OS limit on command line length
-- and so you need to invoke a command multiple times to get all the args
-- in.
--
-- It takes four template invocations corresponding to the simple,
-- initial, middle and last invocations. If the number of args given is
-- small enough that we can get away with just a single invocation then
-- the simple one is used:
--
--
-- $ simple args
--
--
-- If the number of args given means that we need to use multiple
-- invocations then the templates for the initial, middle and last
-- invocations are used:
--
--
-- $ initial args_0
-- $ middle args_1
-- $ middle args_2
-- ...
-- $ final args_n
--
multiStageProgramInvocation :: ProgramInvocation -> (ProgramInvocation, ProgramInvocation, ProgramInvocation) -> [String] -> [ProgramInvocation]
runProgramInvocation :: Verbosity -> ProgramInvocation -> IO ()
getProgramInvocationOutput :: Verbosity -> ProgramInvocation -> IO String
getProgramInvocationLBS :: Verbosity -> ProgramInvocation -> IO ByteString
getProgramInvocationOutputAndErrors :: Verbosity -> ProgramInvocation -> IO (String, String, ExitCode)
-- | Return the current environment extended with the given overrides. If
-- an entry is specified twice in overrides, the second entry
-- takes precedence.
getEffectiveEnvironment :: [(String, Maybe String)] -> IO (Maybe [(String, String)])
-- | This module provides an library interface to the hc-pkg
-- program. Currently only GHC and LHC have hc-pkg programs.
module Distribution.Simple.Program.Script
-- | Generate a system script, either POSIX shell script or Windows batch
-- file as appropriate for the given system.
invocationAsSystemScript :: OS -> ProgramInvocation -> String
-- | Generate a POSIX shell script that invokes a program.
invocationAsShellScript :: ProgramInvocation -> String
-- | Generate a Windows batch file that invokes a program.
invocationAsBatchFile :: ProgramInvocation -> String
-- | This module provides an library interface to the hpc program.
module Distribution.Simple.Program.Hpc
-- | Invoke hpc with the given parameters.
--
-- Prior to HPC version 0.7 (packaged with GHC 7.8), hpc did not handle
-- multiple .mix paths correctly, so we print a warning, and only pass it
-- the first path in the list. This means that e.g. test suites that
-- import their library as a dependency can still work, but those that
-- include the library modules directly (in other-modules) don't.
markup :: ConfiguredProgram -> Version -> Verbosity -> FilePath -> [FilePath] -> FilePath -> [ModuleName] -> IO ()
union :: ConfiguredProgram -> Verbosity -> [FilePath] -> FilePath -> [ModuleName] -> IO ()
-- | Simple file globbing.
module Distribution.Simple.Glob
data GlobSyntaxError
StarInDirectory :: GlobSyntaxError
StarInFileName :: GlobSyntaxError
StarInExtension :: GlobSyntaxError
NoExtensionOnStar :: GlobSyntaxError
EmptyGlob :: GlobSyntaxError
LiteralFileNameGlobStar :: GlobSyntaxError
VersionDoesNotSupportGlobStar :: GlobSyntaxError
VersionDoesNotSupportGlob :: GlobSyntaxError
data GlobResult a
-- | The glob matched the value supplied.
GlobMatch :: a -> GlobResult a
-- | The glob did not match the value supplied because the cabal-version is
-- too low and the extensions on the file did not precisely match the
-- glob's extensions, but rather the glob was a proper suffix of the
-- file's extensions; i.e., if not for the low cabal-version, it would
-- have matched.
GlobWarnMultiDot :: a -> GlobResult a
-- | The glob couldn't match because the directory named doesn't exist. The
-- directory will be as it appears in the glob (i.e., relative to the
-- directory passed to matchDirFileGlob, and, for 'data-files',
-- relative to 'data-dir').
GlobMissingDirectory :: FilePath -> GlobResult a
-- | This will die' when the glob matches no files, or if the glob
-- refers to a missing directory, or if the glob fails to parse.
--
-- The Version argument must be the spec version of the package
-- description being processed, as globs behave slightly differently in
-- different spec versions.
--
-- The first FilePath argument is the directory that the glob is
-- relative to. It must be a valid directory (and hence it can't be the
-- empty string). The returned values will not include this prefix.
--
-- The second FilePath is the glob itself.
matchDirFileGlob :: Verbosity -> CabalSpecVersion -> FilePath -> FilePath -> IO [FilePath]
-- | Like matchDirFileGlob but with customizable die
matchDirFileGlobWithDie :: Verbosity -> (Verbosity -> String -> IO [FilePath]) -> CabalSpecVersion -> FilePath -> FilePath -> IO [FilePath]
-- | Match files against a pre-parsed glob, starting in a directory.
--
-- The Version argument must be the spec version of the package
-- description being processed, as globs behave slightly differently in
-- different spec versions.
--
-- The FilePath argument is the directory that the glob is
-- relative to. It must be a valid directory (and hence it can't be the
-- empty string). The returned values will not include this prefix.
runDirFileGlob :: Verbosity -> FilePath -> Glob -> IO [GlobResult FilePath]
-- | Returns Nothing if the glob didn't match at all, or Just
-- the result if the glob matched (or would have matched with a higher
-- cabal-version).
fileGlobMatches :: Glob -> FilePath -> Maybe (GlobResult FilePath)
parseFileGlob :: CabalSpecVersion -> FilePath -> Either GlobSyntaxError Glob
explainGlobSyntaxError :: FilePath -> GlobSyntaxError -> String
data Glob
instance GHC.Base.Functor Distribution.Simple.Glob.GlobResult
instance GHC.Classes.Ord a => GHC.Classes.Ord (Distribution.Simple.Glob.GlobResult a)
instance GHC.Classes.Eq a => GHC.Classes.Eq (Distribution.Simple.Glob.GlobResult a)
instance GHC.Show.Show a => GHC.Show.Show (Distribution.Simple.Glob.GlobResult a)
instance GHC.Show.Show Distribution.Simple.Glob.GlobSyntaxError
instance GHC.Classes.Eq Distribution.Simple.Glob.GlobSyntaxError
-- | This should be a much more sophisticated abstraction than it is.
-- Currently it's just a bit of data about the compiler, like its flavour
-- and name and version. The reason it's just data is because currently
-- it has to be in Read and Show so it can be saved along
-- with the LocalBuildInfo. The only interesting bit of info it
-- contains is a mapping between language extensions and compiler command
-- line flags. This module also defines a PackageDB type which is
-- used to refer to package databases. Most compilers only know about a
-- single global package collection but GHC has a global and per-user one
-- and it lets you create arbitrary other package databases. We do not
-- yet fully support this latter feature.
module Distribution.Simple.Compiler
data Compiler
Compiler :: CompilerId -> AbiTag -> [CompilerId] -> [(Language, CompilerFlag)] -> [(Extension, Maybe CompilerFlag)] -> Map String String -> Compiler
-- | Compiler flavour and version.
[compilerId] :: Compiler -> CompilerId
-- | Tag for distinguishing incompatible ABI's on the same architecture/os.
[compilerAbiTag] :: Compiler -> AbiTag
-- | Other implementations that this compiler claims to be compatible with.
[compilerCompat] :: Compiler -> [CompilerId]
-- | Supported language standards.
[compilerLanguages] :: Compiler -> [(Language, CompilerFlag)]
-- | Supported extensions.
[compilerExtensions] :: Compiler -> [(Extension, Maybe CompilerFlag)]
-- | A key-value map for properties not covered by the above fields.
[compilerProperties] :: Compiler -> Map String String
showCompilerId :: Compiler -> String
showCompilerIdWithAbi :: Compiler -> String
compilerFlavor :: Compiler -> CompilerFlavor
compilerVersion :: Compiler -> Version
-- | Is this compiler compatible with the compiler flavour we're interested
-- in?
--
-- For example this checks if the compiler is actually GHC or is another
-- compiler that claims to be compatible with some version of GHC, e.g.
-- GHCJS.
--
--
-- if compilerCompatFlavor GHC compiler then ... else ...
--
compilerCompatFlavor :: CompilerFlavor -> Compiler -> Bool
-- | Is this compiler compatible with the compiler flavour we're interested
-- in, and if so what version does it claim to be compatible with.
--
-- For example this checks if the compiler is actually GHC-7.x or is
-- another compiler that claims to be compatible with some GHC-7.x
-- version.
--
--
-- case compilerCompatVersion GHC compiler of
-- Just (Version (7:_)) -> ...
-- _ -> ...
--
compilerCompatVersion :: CompilerFlavor -> Compiler -> Maybe Version
compilerInfo :: Compiler -> CompilerInfo
-- | Some compilers have a notion of a database of available packages. For
-- some there is just one global db of packages, other compilers support
-- a per-user or an arbitrary db specified at some location in the file
-- system. This can be used to build isloated environments of packages,
-- for example to build a collection of related packages without
-- installing them globally.
data PackageDB
GlobalPackageDB :: PackageDB
UserPackageDB :: PackageDB
SpecificPackageDB :: FilePath -> PackageDB
-- | We typically get packages from several databases, and stack them
-- together. This type lets us be explicit about that stacking. For
-- example typical stacks include:
--
--
-- [GlobalPackageDB]
-- [GlobalPackageDB, UserPackageDB]
-- [GlobalPackageDB, SpecificPackageDB "package.conf.inplace"]
--
--
-- Note that the GlobalPackageDB is invariably at the bottom since
-- it contains the rts, base and other special compiler-specific
-- packages.
--
-- We are not restricted to using just the above combinations. In
-- particular we can use several custom package dbs and the user package
-- db together.
--
-- When it comes to writing, the top most (last) package is used.
type PackageDBStack = [PackageDB]
-- | Return the package that we should register into. This is the package
-- db at the top of the stack.
registrationPackageDB :: PackageDBStack -> PackageDB
-- | Make package paths absolute
absolutePackageDBPaths :: PackageDBStack -> IO PackageDBStack
absolutePackageDBPath :: PackageDB -> IO PackageDB
-- | Some compilers support optimising. Some have different levels. For
-- compilers that do not the level is just capped to the level they do
-- support.
data OptimisationLevel
NoOptimisation :: OptimisationLevel
NormalOptimisation :: OptimisationLevel
MaximumOptimisation :: OptimisationLevel
flagToOptimisationLevel :: Maybe String -> OptimisationLevel
-- | Some compilers support emitting debug info. Some have different
-- levels. For compilers that do not the level is just capped to the
-- level they do support.
data DebugInfoLevel
NoDebugInfo :: DebugInfoLevel
MinimalDebugInfo :: DebugInfoLevel
NormalDebugInfo :: DebugInfoLevel
MaximalDebugInfo :: DebugInfoLevel
flagToDebugInfoLevel :: Maybe String -> DebugInfoLevel
type CompilerFlag = String
languageToFlags :: Compiler -> Maybe Language -> [CompilerFlag]
unsupportedLanguages :: Compiler -> [Language] -> [Language]
-- | For the given compiler, return the flags for the supported extensions.
extensionsToFlags :: Compiler -> [Extension] -> [CompilerFlag]
-- | For the given compiler, return the extensions it does not support.
unsupportedExtensions :: Compiler -> [Extension] -> [Extension]
-- | Does this compiler support parallel --make mode?
parmakeSupported :: Compiler -> Bool
-- | Does this compiler support reexported-modules?
reexportedModulesSupported :: Compiler -> Bool
-- | Does this compiler support thinning/renaming on package flags?
renamingPackageFlagsSupported :: Compiler -> Bool
-- | Does this compiler have unified IPIDs (so no package keys)
unifiedIPIDRequired :: Compiler -> Bool
-- | Does this compiler support package keys?
packageKeySupported :: Compiler -> Bool
-- | Does this compiler support unit IDs?
unitIdSupported :: Compiler -> Bool
-- | Does this compiler support Haskell program coverage?
coverageSupported :: Compiler -> Bool
-- | Does this compiler support profiling?
profilingSupported :: Compiler -> Bool
-- | Does this compiler support Backpack?
backpackSupported :: Compiler -> Bool
-- | Does this compiler's "ar" command supports response file arguments
-- (i.e. @file-style arguments).
arResponseFilesSupported :: Compiler -> Bool
-- | Does this compiler support a package database entry with:
-- "dynamic-library-dirs"?
libraryDynDirSupported :: Compiler -> Bool
-- | Does this compiler support a package database entry with:
-- "visibility"?
libraryVisibilitySupported :: Compiler -> Bool
-- | Some compilers (notably GHC) support profiling and can instrument
-- programs so the system can account costs to different functions. There
-- are different levels of detail that can be used for this accounting.
-- For compilers that do not support this notion or the particular detail
-- levels, this is either ignored or just capped to some similar level
-- they do support.
data ProfDetailLevel
ProfDetailNone :: ProfDetailLevel
ProfDetailDefault :: ProfDetailLevel
ProfDetailExportedFunctions :: ProfDetailLevel
ProfDetailToplevelFunctions :: ProfDetailLevel
ProfDetailAllFunctions :: ProfDetailLevel
ProfDetailOther :: String -> ProfDetailLevel
knownProfDetailLevels :: [(String, [String], ProfDetailLevel)]
flagToProfDetailLevel :: String -> ProfDetailLevel
showProfDetailLevel :: ProfDetailLevel -> String
instance GHC.Read.Read Distribution.Simple.Compiler.PackageDB
instance GHC.Show.Show Distribution.Simple.Compiler.PackageDB
instance GHC.Classes.Ord Distribution.Simple.Compiler.PackageDB
instance GHC.Generics.Generic Distribution.Simple.Compiler.PackageDB
instance GHC.Classes.Eq Distribution.Simple.Compiler.PackageDB
instance GHC.Show.Show Distribution.Simple.Compiler.OptimisationLevel
instance GHC.Read.Read Distribution.Simple.Compiler.OptimisationLevel
instance GHC.Generics.Generic Distribution.Simple.Compiler.OptimisationLevel
instance GHC.Classes.Eq Distribution.Simple.Compiler.OptimisationLevel
instance GHC.Enum.Enum Distribution.Simple.Compiler.OptimisationLevel
instance GHC.Enum.Bounded Distribution.Simple.Compiler.OptimisationLevel
instance GHC.Show.Show Distribution.Simple.Compiler.DebugInfoLevel
instance GHC.Read.Read Distribution.Simple.Compiler.DebugInfoLevel
instance GHC.Generics.Generic Distribution.Simple.Compiler.DebugInfoLevel
instance GHC.Classes.Eq Distribution.Simple.Compiler.DebugInfoLevel
instance GHC.Enum.Enum Distribution.Simple.Compiler.DebugInfoLevel
instance GHC.Enum.Bounded Distribution.Simple.Compiler.DebugInfoLevel
instance GHC.Read.Read Distribution.Simple.Compiler.Compiler
instance GHC.Show.Show Distribution.Simple.Compiler.Compiler
instance GHC.Generics.Generic Distribution.Simple.Compiler.Compiler
instance GHC.Classes.Eq Distribution.Simple.Compiler.Compiler
instance GHC.Show.Show Distribution.Simple.Compiler.ProfDetailLevel
instance GHC.Read.Read Distribution.Simple.Compiler.ProfDetailLevel
instance GHC.Generics.Generic Distribution.Simple.Compiler.ProfDetailLevel
instance GHC.Classes.Eq Distribution.Simple.Compiler.ProfDetailLevel
instance Data.Binary.Class.Binary Distribution.Simple.Compiler.ProfDetailLevel
instance Distribution.Utils.Structured.Structured Distribution.Simple.Compiler.ProfDetailLevel
instance Data.Binary.Class.Binary Distribution.Simple.Compiler.Compiler
instance Distribution.Utils.Structured.Structured Distribution.Simple.Compiler.Compiler
instance Data.Binary.Class.Binary Distribution.Simple.Compiler.DebugInfoLevel
instance Distribution.Utils.Structured.Structured Distribution.Simple.Compiler.DebugInfoLevel
instance Data.Binary.Class.Binary Distribution.Simple.Compiler.OptimisationLevel
instance Distribution.Utils.Structured.Structured Distribution.Simple.Compiler.OptimisationLevel
instance Data.Binary.Class.Binary Distribution.Simple.Compiler.PackageDB
instance Distribution.Utils.Structured.Structured Distribution.Simple.Compiler.PackageDB
module Distribution.Simple.Program.GHC
-- | A structured set of GHC options/flags
--
-- Note that options containing lists fall into two categories:
--
--
-- - options that can be safely deduplicated, e.g. input modules or
-- enabled extensions;
-- - options that cannot be deduplicated in general without changing
-- semantics, e.g. extra ghc options or linking options.
--
data GhcOptions
GhcOptions :: Flag GhcMode -> [String] -> [String] -> NubListR FilePath -> NubListR ModuleName -> Flag FilePath -> Flag FilePath -> Flag Bool -> NubListR FilePath -> Flag String -> Flag ComponentId -> [(ModuleName, OpenModule)] -> Flag Bool -> PackageDBStack -> NubListR (OpenUnitId, ModuleRenaming) -> Flag Bool -> Flag Bool -> Flag Bool -> [FilePath] -> NubListR FilePath -> [String] -> NubListR String -> NubListR String -> Flag Bool -> Flag Bool -> NubListR FilePath -> [String] -> [String] -> [String] -> [String] -> NubListR FilePath -> NubListR FilePath -> NubListR FilePath -> Flag Language -> NubListR Extension -> Map Extension (Maybe CompilerFlag) -> Flag GhcOptimisation -> Flag DebugInfoLevel -> Flag Bool -> Flag GhcProfAuto -> Flag Bool -> Flag Bool -> Flag (Maybe Int) -> Flag FilePath -> [FilePath] -> Flag String -> Flag String -> Flag String -> Flag String -> Flag FilePath -> Flag FilePath -> Flag FilePath -> Flag FilePath -> Flag GhcDynLinkMode -> Flag Bool -> Flag Bool -> Flag Bool -> Flag String -> NubListR FilePath -> Flag Verbosity -> NubListR FilePath -> Flag Bool -> GhcOptions
-- | The major mode for the ghc invocation.
[ghcOptMode] :: GhcOptions -> Flag GhcMode
-- | Any extra options to pass directly to ghc. These go at the end and
-- hence override other stuff.
[ghcOptExtra] :: GhcOptions -> [String]
-- | Extra default flags to pass directly to ghc. These go at the beginning
-- and so can be overridden by other stuff.
[ghcOptExtraDefault] :: GhcOptions -> [String]
-- | The main input files; could be .hs, .hi, .c, .o, depending on mode.
[ghcOptInputFiles] :: GhcOptions -> NubListR FilePath
-- | The names of input Haskell modules, mainly for --make mode.
[ghcOptInputModules] :: GhcOptions -> NubListR ModuleName
-- | Location for output file; the ghc -o flag.
[ghcOptOutputFile] :: GhcOptions -> Flag FilePath
-- | Location for dynamic output file in GhcStaticAndDynamic mode;
-- the ghc -dyno flag.
[ghcOptOutputDynFile] :: GhcOptions -> Flag FilePath
-- | Start with an empty search path for Haskell source files; the ghc
-- -i flag (-i on its own with no path argument).
[ghcOptSourcePathClear] :: GhcOptions -> Flag Bool
-- | Search path for Haskell source files; the ghc -i flag.
[ghcOptSourcePath] :: GhcOptions -> NubListR FilePath
-- | The unit ID the modules will belong to; the ghc -this-unit-id
-- flag (or -this-package-key or -package-name on older
-- versions of GHC). This is a String because we assume you've
-- already figured out what the correct format for this string is (we
-- need to handle backwards compatibility.)
[ghcOptThisUnitId] :: GhcOptions -> Flag String
-- | GHC doesn't make any assumptions about the format of definite unit
-- ids, so when we are instantiating a package it needs to be told
-- explicitly what the component being instantiated is. This only gets
-- set when ghcOptInstantiatedWith is non-empty
[ghcOptThisComponentId] :: GhcOptions -> Flag ComponentId
-- | How the requirements of the package being compiled are to be filled.
-- When typechecking an indefinite package, the OpenModule is
-- always a OpenModuleVar; otherwise, it specifies the installed
-- module that instantiates a package.
[ghcOptInstantiatedWith] :: GhcOptions -> [(ModuleName, OpenModule)]
-- | No code? (But we turn on interface writing
[ghcOptNoCode] :: GhcOptions -> Flag Bool
-- | GHC package databases to use, the ghc -package-conf flag.
[ghcOptPackageDBs] :: GhcOptions -> PackageDBStack
-- | The GHC packages to bring into scope when compiling, the ghc
-- -package-id flags.
[ghcOptPackages] :: GhcOptions -> NubListR (OpenUnitId, ModuleRenaming)
-- | Start with a clean package set; the ghc -hide-all-packages
-- flag
[ghcOptHideAllPackages] :: GhcOptions -> Flag Bool
-- | Warn about modules, not listed in command line
[ghcOptWarnMissingHomeModules] :: GhcOptions -> Flag Bool
-- | Don't automatically link in Haskell98 etc; the ghc
-- -no-auto-link-packages flag.
[ghcOptNoAutoLinkPackages] :: GhcOptions -> Flag Bool
-- | Names of libraries to link in; the ghc -l flag.
[ghcOptLinkLibs] :: GhcOptions -> [FilePath]
-- | Search path for libraries to link in; the ghc -L flag.
[ghcOptLinkLibPath] :: GhcOptions -> NubListR FilePath
-- | Options to pass through to the linker; the ghc -optl flag.
[ghcOptLinkOptions] :: GhcOptions -> [String]
-- | OSX only: frameworks to link in; the ghc -framework flag.
[ghcOptLinkFrameworks] :: GhcOptions -> NubListR String
-- | OSX only: Search path for frameworks to link in; the ghc
-- -framework-path flag.
[ghcOptLinkFrameworkDirs] :: GhcOptions -> NubListR String
-- | Don't do the link step, useful in make mode; the ghc -no-link
-- flag.
[ghcOptNoLink] :: GhcOptions -> Flag Bool
-- | Don't link in the normal RTS main entry point; the ghc
-- -no-hs-main flag.
[ghcOptLinkNoHsMain] :: GhcOptions -> Flag Bool
-- | Module definition files (Windows specific)
[ghcOptLinkModDefFiles] :: GhcOptions -> NubListR FilePath
-- | Options to pass through to the C compiler; the ghc -optc
-- flag.
[ghcOptCcOptions] :: GhcOptions -> [String]
-- | Options to pass through to the C++ compiler.
[ghcOptCxxOptions] :: GhcOptions -> [String]
-- | Options to pass through to the Assembler.
[ghcOptAsmOptions] :: GhcOptions -> [String]
-- | Options to pass through to CPP; the ghc -optP flag.
[ghcOptCppOptions] :: GhcOptions -> [String]
-- | Search path for CPP includes like header files; the ghc -I
-- flag.
[ghcOptCppIncludePath] :: GhcOptions -> NubListR FilePath
-- | Extra header files to include at CPP stage; the ghc
-- -optP-include flag.
[ghcOptCppIncludes] :: GhcOptions -> NubListR FilePath
-- | Extra header files to include for old-style FFI; the ghc
-- -#include flag.
[ghcOptFfiIncludes] :: GhcOptions -> NubListR FilePath
-- | The base language; the ghc -XHaskell98 or
-- -XHaskell2010 flag.
[ghcOptLanguage] :: GhcOptions -> Flag Language
-- | The language extensions; the ghc -X flag.
[ghcOptExtensions] :: GhcOptions -> NubListR Extension
-- | A GHC version-dependent mapping of extensions to flags. This must be
-- set to be able to make use of the ghcOptExtensions.
[ghcOptExtensionMap] :: GhcOptions -> Map Extension (Maybe CompilerFlag)
-- | What optimisation level to use; the ghc -O flag.
[ghcOptOptimisation] :: GhcOptions -> Flag GhcOptimisation
-- | Emit debug info; the ghc -g flag.
[ghcOptDebugInfo] :: GhcOptions -> Flag DebugInfoLevel
-- | Compile in profiling mode; the ghc -prof flag.
[ghcOptProfilingMode] :: GhcOptions -> Flag Bool
-- | Automatically add profiling cost centers; the ghc
-- -fprof-auto* flags.
[ghcOptProfilingAuto] :: GhcOptions -> Flag GhcProfAuto
-- | Use the "split sections" feature; the ghc -split-sections
-- flag.
[ghcOptSplitSections] :: GhcOptions -> Flag Bool
-- | Use the "split object files" feature; the ghc -split-objs
-- flag.
[ghcOptSplitObjs] :: GhcOptions -> Flag Bool
-- | Run N jobs simultaneously (if possible).
[ghcOptNumJobs] :: GhcOptions -> Flag (Maybe Int)
-- | Enable coverage analysis; the ghc -fhpc -hpcdir flags.
[ghcOptHPCDir] :: GhcOptions -> Flag FilePath
-- | Extra GHCi startup scripts; the -ghci-script flag
[ghcOptGHCiScripts] :: GhcOptions -> [FilePath]
[ghcOptHiSuffix] :: GhcOptions -> Flag String
[ghcOptObjSuffix] :: GhcOptions -> Flag String
-- | only in GhcStaticAndDynamic mode
[ghcOptDynHiSuffix] :: GhcOptions -> Flag String
-- | only in GhcStaticAndDynamic mode
[ghcOptDynObjSuffix] :: GhcOptions -> Flag String
[ghcOptHiDir] :: GhcOptions -> Flag FilePath
[ghcOptObjDir] :: GhcOptions -> Flag FilePath
[ghcOptOutputDir] :: GhcOptions -> Flag FilePath
[ghcOptStubDir] :: GhcOptions -> Flag FilePath
[ghcOptDynLinkMode] :: GhcOptions -> Flag GhcDynLinkMode
[ghcOptStaticLib] :: GhcOptions -> Flag Bool
[ghcOptShared] :: GhcOptions -> Flag Bool
[ghcOptFPic] :: GhcOptions -> Flag Bool
[ghcOptDylibName] :: GhcOptions -> Flag String
[ghcOptRPaths] :: GhcOptions -> NubListR FilePath
-- | Get GHC to be quiet or verbose with what it's doing; the ghc
-- -v flag.
[ghcOptVerbosity] :: GhcOptions -> Flag Verbosity
-- | Put the extra folders in the PATH environment variable we invoke GHC
-- with
[ghcOptExtraPath] :: GhcOptions -> NubListR FilePath
-- | Let GHC know that it is Cabal that's calling it. Modifies some of the
-- GHC error messages.
[ghcOptCabal] :: GhcOptions -> Flag Bool
data GhcMode
-- |
-- ghc -c
--
GhcModeCompile :: GhcMode
-- |
-- ghc
--
GhcModeLink :: GhcMode
-- |
-- ghc --make
--
GhcModeMake :: GhcMode
-- | ghci / ghc --interactive
GhcModeInteractive :: GhcMode
-- | ghc --abi-hash | GhcModeDepAnalysis -- ^ ghc -M |
-- GhcModeEvaluate -- ^ ghc -e
GhcModeAbiHash :: GhcMode
data GhcOptimisation
-- |
-- -O0
--
GhcNoOptimisation :: GhcOptimisation
-- |
-- -O
--
GhcNormalOptimisation :: GhcOptimisation
-- |
-- -O2
--
GhcMaximumOptimisation :: GhcOptimisation
-- | e.g. -Odph
GhcSpecialOptimisation :: String -> GhcOptimisation
data GhcDynLinkMode
-- |
-- -static
--
GhcStaticOnly :: GhcDynLinkMode
-- |
-- -dynamic
--
GhcDynamicOnly :: GhcDynLinkMode
-- |
-- -static -dynamic-too
--
GhcStaticAndDynamic :: GhcDynLinkMode
data GhcProfAuto
-- |
-- -fprof-auto
--
GhcProfAutoAll :: GhcProfAuto
-- |
-- -fprof-auto-top
--
GhcProfAutoToplevel :: GhcProfAuto
-- |
-- -fprof-auto-exported
--
GhcProfAutoExported :: GhcProfAuto
ghcInvocation :: ConfiguredProgram -> Compiler -> Platform -> GhcOptions -> ProgramInvocation
renderGhcOptions :: Compiler -> Platform -> GhcOptions -> [String]
runGHC :: Verbosity -> ConfiguredProgram -> Compiler -> Platform -> GhcOptions -> IO ()
-- | GHC >= 7.6 uses the '-package-db' flag. See
-- https://gitlab.haskell.org/ghc/ghc/-/issues/5977.
packageDbArgsDb :: PackageDBStack -> [String]
normaliseGhcArgs :: Maybe Version -> PackageDescription -> [String] -> [String]
instance GHC.Classes.Eq Distribution.Simple.Program.GHC.GhcMode
instance GHC.Show.Show Distribution.Simple.Program.GHC.GhcMode
instance GHC.Classes.Eq Distribution.Simple.Program.GHC.GhcOptimisation
instance GHC.Show.Show Distribution.Simple.Program.GHC.GhcOptimisation
instance GHC.Classes.Eq Distribution.Simple.Program.GHC.GhcDynLinkMode
instance GHC.Show.Show Distribution.Simple.Program.GHC.GhcDynLinkMode
instance GHC.Classes.Eq Distribution.Simple.Program.GHC.GhcProfAuto
instance GHC.Show.Show Distribution.Simple.Program.GHC.GhcProfAuto
instance GHC.Generics.Generic Distribution.Simple.Program.GHC.GhcOptions
instance GHC.Show.Show Distribution.Simple.Program.GHC.GhcOptions
instance GHC.Base.Monoid Distribution.Simple.Program.GHC.GhcOptions
instance GHC.Base.Semigroup Distribution.Simple.Program.GHC.GhcOptions
-- | The module defines all the known built-in Programs.
--
-- Where possible we try to find their version numbers.
module Distribution.Simple.Program.Builtin
-- | The default list of programs. These programs are typically used
-- internally to Cabal.
builtinPrograms :: [Program]
ghcProgram :: Program
ghcPkgProgram :: Program
runghcProgram :: Program
ghcjsProgram :: Program
ghcjsPkgProgram :: Program
hmakeProgram :: Program
jhcProgram :: Program
haskellSuiteProgram :: Program
haskellSuitePkgProgram :: Program
uhcProgram :: Program
gccProgram :: Program
arProgram :: Program
stripProgram :: Program
happyProgram :: Program
alexProgram :: Program
hsc2hsProgram :: Program
c2hsProgram :: Program
cpphsProgram :: Program
hscolourProgram :: Program
doctestProgram :: Program
haddockProgram :: Program
greencardProgram :: Program
ldProgram :: Program
tarProgram :: Program
cppProgram :: Program
pkgConfigProgram :: Program
hpcProgram :: Program
-- | This provides a ProgramDb type which holds configured and
-- not-yet configured programs. It is the parameter to lots of actions
-- elsewhere in Cabal that need to look up and run programs. If we had a
-- Cabal monad, the ProgramDb would probably be a reader or state
-- component of it.
--
-- One nice thing about using it is that any program that is registered
-- with Cabal will get some "configure" and ".cabal" helpers like
-- --with-foo-args --foo-path= and extra-foo-args.
--
-- There's also a hook for adding programs in a Setup.lhs script. See
-- hookedPrograms in UserHooks. This gives a hook user the ability
-- to get the above flags and such so that they don't have to write all
-- the PATH logic inside Setup.lhs.
module Distribution.Simple.Program.Db
-- | The configuration is a collection of information about programs. It
-- contains information both about configured programs and also about
-- programs that we are yet to configure.
--
-- The idea is that we start from a collection of unconfigured programs
-- and one by one we try to configure them at which point we move them
-- into the configured collection. For unconfigured programs we record
-- not just the Program but also any user-provided arguments and
-- location for the program.
data ProgramDb
emptyProgramDb :: ProgramDb
defaultProgramDb :: ProgramDb
-- | The Read/Show and Binary instances do not
-- preserve all the unconfigured Programs because Program
-- is not in Read/Show because it contains functions. So to
-- fully restore a deserialised ProgramDb use this function to add
-- back all the known Programs.
--
--
-- - It does not add the default programs, but you probably want them,
-- use builtinPrograms in addition to any extra you might
-- need.
--
restoreProgramDb :: [Program] -> ProgramDb -> ProgramDb
-- | Add a known program that we may configure later
addKnownProgram :: Program -> ProgramDb -> ProgramDb
addKnownPrograms :: [Program] -> ProgramDb -> ProgramDb
lookupKnownProgram :: String -> ProgramDb -> Maybe Program
knownPrograms :: ProgramDb -> [(Program, Maybe ConfiguredProgram)]
-- | Get the current ProgramSearchPath used by the ProgramDb.
-- This is the default list of locations where programs are looked for
-- when configuring them. This can be overridden for specific programs
-- (with userSpecifyPath), and specific known programs can modify
-- or ignore this search path in their own configuration code.
getProgramSearchPath :: ProgramDb -> ProgramSearchPath
-- | Change the current ProgramSearchPath used by the
-- ProgramDb. This will affect programs that are configured from
-- here on, so you should usually set it before configuring any programs.
setProgramSearchPath :: ProgramSearchPath -> ProgramDb -> ProgramDb
-- | Modify the current ProgramSearchPath used by the
-- ProgramDb. This will affect programs that are configured from
-- here on, so you should usually modify it before configuring any
-- programs.
modifyProgramSearchPath :: (ProgramSearchPath -> ProgramSearchPath) -> ProgramDb -> ProgramDb
-- | User-specify this path. Basically override any path information for
-- this program in the configuration. If it's not a known program ignore
-- it.
userSpecifyPath :: String -> FilePath -> ProgramDb -> ProgramDb
-- | Like userSpecifyPath but for a list of progs and their paths.
userSpecifyPaths :: [(String, FilePath)] -> ProgramDb -> ProgramDb
userMaybeSpecifyPath :: String -> Maybe FilePath -> ProgramDb -> ProgramDb
-- | User-specify the arguments for this program. Basically override any
-- args information for this program in the configuration. If it's not a
-- known program, ignore it..
userSpecifyArgs :: String -> [ProgArg] -> ProgramDb -> ProgramDb
-- | Like userSpecifyPath but for a list of progs and their args.
userSpecifyArgss :: [(String, [ProgArg])] -> ProgramDb -> ProgramDb
-- | Get any extra args that have been previously specified for a program.
userSpecifiedArgs :: Program -> ProgramDb -> [ProgArg]
-- | Try to find a configured program
lookupProgram :: Program -> ProgramDb -> Maybe ConfiguredProgram
-- | Update a configured program in the database.
updateProgram :: ConfiguredProgram -> ProgramDb -> ProgramDb
-- | List all configured programs.
configuredPrograms :: ProgramDb -> [ConfiguredProgram]
-- | Try to configure a specific program. If the program is already
-- included in the collection of unconfigured programs then we use any
-- user-supplied location and arguments. If the program gets configured
-- successfully it gets added to the configured collection.
--
-- Note that it is not a failure if the program cannot be configured.
-- It's only a failure if the user supplied a location and the program
-- could not be found at that location.
--
-- The reason for it not being a failure at this stage is that we don't
-- know up front all the programs we will need, so we try to configure
-- them all. To verify that a program was actually successfully
-- configured use requireProgram.
configureProgram :: Verbosity -> Program -> ProgramDb -> IO ProgramDb
-- | Try to configure all the known programs that have not yet been
-- configured.
configureAllKnownPrograms :: Verbosity -> ProgramDb -> IO ProgramDb
-- | Unconfigure a program. This is basically a hack and you shouldn't use
-- it, but it can be handy for making sure a requireProgram
-- actually reconfigures.
unconfigureProgram :: String -> ProgramDb -> ProgramDb
-- | Check that a program is configured and available to be run.
--
-- Additionally check that the program version number is suitable and
-- return it. For example you could require AnyVersion or
-- orLaterVersion (Version [1,0] [])
--
-- It returns the configured program, its version number and a possibly
-- updated ProgramDb. If the program could not be configured or
-- the version is unsuitable, it returns an error value.
lookupProgramVersion :: Verbosity -> Program -> VersionRange -> ProgramDb -> IO (Either String (ConfiguredProgram, Version, ProgramDb))
-- | reconfigure a bunch of programs given new user-specified args. It
-- takes the same inputs as userSpecifyPath and
-- userSpecifyArgs and for all progs with a new path it calls
-- configureProgram.
reconfigurePrograms :: Verbosity -> [(String, FilePath)] -> [(String, [ProgArg])] -> ProgramDb -> IO ProgramDb
-- | Check that a program is configured and available to be run.
--
-- It raises an exception if the program could not be configured,
-- otherwise it returns the configured program.
requireProgram :: Verbosity -> Program -> ProgramDb -> IO (ConfiguredProgram, ProgramDb)
-- | Like lookupProgramVersion, but raises an exception in case of
-- error instead of returning 'Left errMsg'.
requireProgramVersion :: Verbosity -> Program -> VersionRange -> ProgramDb -> IO (ConfiguredProgram, Version, ProgramDb)
-- | Check that a program is configured and available to be run.
--
-- It returns Nothing if the program couldn't be configured, or is
-- not found.
needProgram :: Verbosity -> Program -> ProgramDb -> IO (Maybe (ConfiguredProgram, ProgramDb))
instance GHC.Show.Show Distribution.Simple.Program.Db.ProgramDb
instance GHC.Read.Read Distribution.Simple.Program.Db.ProgramDb
instance Data.Binary.Class.Binary Distribution.Simple.Program.Db.ProgramDb
instance Distribution.Utils.Structured.Structured Distribution.Simple.Program.Db.ProgramDb
-- | This provides an abstraction which deals with configuring and running
-- programs. A Program is a static notion of a known program. A
-- ConfiguredProgram is a Program that has been found on
-- the current machine and is ready to be run (possibly with some
-- user-supplied default args). Configuring a program involves finding
-- its location and if necessary finding its version. There is also a
-- ProgramDb type which holds configured and not-yet configured
-- programs. It is the parameter to lots of actions elsewhere in Cabal
-- that need to look up and run programs. If we had a Cabal monad, the
-- ProgramDb would probably be a reader or state component of it.
--
-- The module also defines all the known built-in Programs and the
-- defaultProgramDb which contains them all.
--
-- One nice thing about using it is that any program that is registered
-- with Cabal will get some "configure" and ".cabal" helpers like
-- --with-foo-args --foo-path= and extra-foo-args.
--
-- There's also good default behavior for trying to find "foo" in PATH,
-- being able to override its location, etc.
--
-- There's also a hook for adding programs in a Setup.lhs script. See
-- hookedPrograms in UserHooks. This gives a hook user the ability
-- to get the above flags and such so that they don't have to write all
-- the PATH logic inside Setup.lhs.
module Distribution.Simple.Program
-- | Represents a program which can be configured.
--
-- Note: rather than constructing this directly, start with
-- simpleProgram and override any extra fields.
data Program
Program :: String -> (Verbosity -> ProgramSearchPath -> IO (Maybe (FilePath, [FilePath]))) -> (Verbosity -> FilePath -> IO (Maybe Version)) -> (Verbosity -> ConfiguredProgram -> IO ConfiguredProgram) -> (Maybe Version -> PackageDescription -> [String] -> [String]) -> Program
-- | The simple name of the program, eg. ghc
[programName] :: Program -> String
-- | A function to search for the program if its location was not specified
-- by the user. Usually this will just be a call to
-- findProgramOnSearchPath.
--
-- It is supplied with the prevailing search path which will typically
-- just be used as-is, but can be extended or ignored as needed.
--
-- For the purpose of change monitoring, in addition to the location
-- where the program was found, it returns all the other places that were
-- tried.
[programFindLocation] :: Program -> Verbosity -> ProgramSearchPath -> IO (Maybe (FilePath, [FilePath]))
-- | Try to find the version of the program. For many programs this is not
-- possible or is not necessary so it's OK to return Nothing.
[programFindVersion] :: Program -> Verbosity -> FilePath -> IO (Maybe Version)
-- | A function to do any additional configuration after we have located
-- the program (and perhaps identified its version). For example it could
-- add args, or environment vars.
[programPostConf] :: Program -> Verbosity -> ConfiguredProgram -> IO ConfiguredProgram
-- | A function that filters any arguments that don't impact the output
-- from a commandline. Used to limit the volatility of dependency hashes
-- when using new-build.
[programNormaliseArgs] :: Program -> Maybe Version -> PackageDescription -> [String] -> [String]
-- | A search path to use when locating executables. This is analogous to
-- the unix $PATH or win32 %PATH% but with the ability
-- to use the system default method for finding executables
-- (findExecutable which on unix is simply looking on the
-- $PATH but on win32 is a bit more complicated).
--
-- The default to use is [ProgSearchPathDefault] but you can add
-- extra dirs either before, after or instead of the default, e.g. here
-- we add an extra dir to search after the usual ones.
--
--
-- ['ProgramSearchPathDefault', 'ProgramSearchPathDir' dir]
--
type ProgramSearchPath = [ProgramSearchPathEntry]
data ProgramSearchPathEntry
-- | A specific dir
ProgramSearchPathDir :: FilePath -> ProgramSearchPathEntry
-- | The system default
ProgramSearchPathDefault :: ProgramSearchPathEntry
-- | Make a simple named program.
--
-- By default we'll just search for it in the path and not try to find
-- the version name. You can override these behaviours if necessary, eg:
--
--
-- (simpleProgram "foo") { programFindLocation = ... , programFindVersion ... }
--
simpleProgram :: String -> Program
findProgramOnSearchPath :: Verbosity -> ProgramSearchPath -> FilePath -> IO (Maybe (FilePath, [FilePath]))
defaultProgramSearchPath :: ProgramSearchPath
-- | Look for a program and try to find it's version number. It can accept
-- either an absolute path or the name of a program binary, in which case
-- we will look for the program on the path.
findProgramVersion :: String -> (String -> String) -> Verbosity -> FilePath -> IO (Maybe Version)
-- | Represents a program which has been configured and is thus ready to be
-- run.
--
-- These are usually made by configuring a Program, but if you
-- have to construct one directly then start with
-- simpleConfiguredProgram and override any extra fields.
data ConfiguredProgram
ConfiguredProgram :: String -> Maybe Version -> [String] -> [String] -> [(String, Maybe String)] -> Map String String -> ProgramLocation -> [FilePath] -> ConfiguredProgram
-- | Just the name again
[programId] :: ConfiguredProgram -> String
-- | The version of this program, if it is known.
[programVersion] :: ConfiguredProgram -> Maybe Version
-- | Default command-line args for this program. These flags will appear
-- first on the command line, so they can be overridden by subsequent
-- flags.
[programDefaultArgs] :: ConfiguredProgram -> [String]
-- | Override command-line args for this program. These flags will appear
-- last on the command line, so they override all earlier flags.
[programOverrideArgs] :: ConfiguredProgram -> [String]
-- | Override environment variables for this program. These env vars will
-- extend/override the prevailing environment of the current to form the
-- environment for the new process.
[programOverrideEnv] :: ConfiguredProgram -> [(String, Maybe String)]
-- | A key-value map listing various properties of the program, useful for
-- feature detection. Populated during the configuration step, key names
-- depend on the specific program.
[programProperties] :: ConfiguredProgram -> Map String String
-- | Location of the program. eg. /usr/bin/ghc-6.4
[programLocation] :: ConfiguredProgram -> ProgramLocation
-- | In addition to the programLocation where the program was found,
-- these are additional locations that were looked at. The combination of
-- ths found location and these not-found locations can be used to
-- monitor to detect when the re-configuring the program might give a
-- different result (e.g. found in a different location).
[programMonitorFiles] :: ConfiguredProgram -> [FilePath]
-- | The full path of a configured program.
programPath :: ConfiguredProgram -> FilePath
type ProgArg = String
-- | Where a program was found. Also tells us whether it's specified by
-- user or not. This includes not just the path, but the program as well.
data ProgramLocation
-- | The user gave the path to this program, eg.
-- --ghc-path=/usr/bin/ghc-6.6
UserSpecified :: FilePath -> ProgramLocation
[locationPath] :: ProgramLocation -> FilePath
-- | The program was found automatically.
FoundOnSystem :: FilePath -> ProgramLocation
[locationPath] :: ProgramLocation -> FilePath
-- | Runs the given configured program.
runProgram :: Verbosity -> ConfiguredProgram -> [ProgArg] -> IO ()
-- | Runs the given configured program and gets the output.
getProgramOutput :: Verbosity -> ConfiguredProgram -> [ProgArg] -> IO String
-- | Suppress any extra arguments added by the user.
suppressOverrideArgs :: ConfiguredProgram -> ConfiguredProgram
-- | Represents a specific invocation of a specific program.
--
-- This is used as an intermediate type between deciding how to call a
-- program and actually doing it. This provides the opportunity to the
-- caller to adjust how the program will be called. These invocations can
-- either be run directly or turned into shell or batch scripts.
data ProgramInvocation
ProgramInvocation :: FilePath -> [String] -> [(String, Maybe String)] -> [FilePath] -> Maybe FilePath -> Maybe IOData -> IOEncoding -> IOEncoding -> ProgramInvocation
[progInvokePath] :: ProgramInvocation -> FilePath
[progInvokeArgs] :: ProgramInvocation -> [String]
[progInvokeEnv] :: ProgramInvocation -> [(String, Maybe String)]
[progInvokePathEnv] :: ProgramInvocation -> [FilePath]
[progInvokeCwd] :: ProgramInvocation -> Maybe FilePath
[progInvokeInput] :: ProgramInvocation -> Maybe IOData
-- | TODO: remove this, make user decide when constructing
-- progInvokeInput.
[progInvokeInputEncoding] :: ProgramInvocation -> IOEncoding
[progInvokeOutputEncoding] :: ProgramInvocation -> IOEncoding
emptyProgramInvocation :: ProgramInvocation
simpleProgramInvocation :: FilePath -> [String] -> ProgramInvocation
programInvocation :: ConfiguredProgram -> [String] -> ProgramInvocation
runProgramInvocation :: Verbosity -> ProgramInvocation -> IO ()
getProgramInvocationOutput :: Verbosity -> ProgramInvocation -> IO String
getProgramInvocationLBS :: Verbosity -> ProgramInvocation -> IO ByteString
-- | The default list of programs. These programs are typically used
-- internally to Cabal.
builtinPrograms :: [Program]
-- | The configuration is a collection of information about programs. It
-- contains information both about configured programs and also about
-- programs that we are yet to configure.
--
-- The idea is that we start from a collection of unconfigured programs
-- and one by one we try to configure them at which point we move them
-- into the configured collection. For unconfigured programs we record
-- not just the Program but also any user-provided arguments and
-- location for the program.
data ProgramDb
defaultProgramDb :: ProgramDb
emptyProgramDb :: ProgramDb
-- | The Read/Show and Binary instances do not
-- preserve all the unconfigured Programs because Program
-- is not in Read/Show because it contains functions. So to
-- fully restore a deserialised ProgramDb use this function to add
-- back all the known Programs.
--
--
-- - It does not add the default programs, but you probably want them,
-- use builtinPrograms in addition to any extra you might
-- need.
--
restoreProgramDb :: [Program] -> ProgramDb -> ProgramDb
-- | Add a known program that we may configure later
addKnownProgram :: Program -> ProgramDb -> ProgramDb
addKnownPrograms :: [Program] -> ProgramDb -> ProgramDb
lookupKnownProgram :: String -> ProgramDb -> Maybe Program
knownPrograms :: ProgramDb -> [(Program, Maybe ConfiguredProgram)]
-- | Get the current ProgramSearchPath used by the ProgramDb.
-- This is the default list of locations where programs are looked for
-- when configuring them. This can be overridden for specific programs
-- (with userSpecifyPath), and specific known programs can modify
-- or ignore this search path in their own configuration code.
getProgramSearchPath :: ProgramDb -> ProgramSearchPath
-- | Change the current ProgramSearchPath used by the
-- ProgramDb. This will affect programs that are configured from
-- here on, so you should usually set it before configuring any programs.
setProgramSearchPath :: ProgramSearchPath -> ProgramDb -> ProgramDb
-- | User-specify this path. Basically override any path information for
-- this program in the configuration. If it's not a known program ignore
-- it.
userSpecifyPath :: String -> FilePath -> ProgramDb -> ProgramDb
-- | Like userSpecifyPath but for a list of progs and their paths.
userSpecifyPaths :: [(String, FilePath)] -> ProgramDb -> ProgramDb
userMaybeSpecifyPath :: String -> Maybe FilePath -> ProgramDb -> ProgramDb
-- | User-specify the arguments for this program. Basically override any
-- args information for this program in the configuration. If it's not a
-- known program, ignore it..
userSpecifyArgs :: String -> [ProgArg] -> ProgramDb -> ProgramDb
-- | Like userSpecifyPath but for a list of progs and their args.
userSpecifyArgss :: [(String, [ProgArg])] -> ProgramDb -> ProgramDb
-- | Get any extra args that have been previously specified for a program.
userSpecifiedArgs :: Program -> ProgramDb -> [ProgArg]
-- | Try to find a configured program
lookupProgram :: Program -> ProgramDb -> Maybe ConfiguredProgram
-- | Check that a program is configured and available to be run.
--
-- Additionally check that the program version number is suitable and
-- return it. For example you could require AnyVersion or
-- orLaterVersion (Version [1,0] [])
--
-- It returns the configured program, its version number and a possibly
-- updated ProgramDb. If the program could not be configured or
-- the version is unsuitable, it returns an error value.
lookupProgramVersion :: Verbosity -> Program -> VersionRange -> ProgramDb -> IO (Either String (ConfiguredProgram, Version, ProgramDb))
-- | Update a configured program in the database.
updateProgram :: ConfiguredProgram -> ProgramDb -> ProgramDb
-- | Try to configure a specific program. If the program is already
-- included in the collection of unconfigured programs then we use any
-- user-supplied location and arguments. If the program gets configured
-- successfully it gets added to the configured collection.
--
-- Note that it is not a failure if the program cannot be configured.
-- It's only a failure if the user supplied a location and the program
-- could not be found at that location.
--
-- The reason for it not being a failure at this stage is that we don't
-- know up front all the programs we will need, so we try to configure
-- them all. To verify that a program was actually successfully
-- configured use requireProgram.
configureProgram :: Verbosity -> Program -> ProgramDb -> IO ProgramDb
-- | Try to configure all the known programs that have not yet been
-- configured.
configureAllKnownPrograms :: Verbosity -> ProgramDb -> IO ProgramDb
-- | reconfigure a bunch of programs given new user-specified args. It
-- takes the same inputs as userSpecifyPath and
-- userSpecifyArgs and for all progs with a new path it calls
-- configureProgram.
reconfigurePrograms :: Verbosity -> [(String, FilePath)] -> [(String, [ProgArg])] -> ProgramDb -> IO ProgramDb
-- | Check that a program is configured and available to be run.
--
-- It raises an exception if the program could not be configured,
-- otherwise it returns the configured program.
requireProgram :: Verbosity -> Program -> ProgramDb -> IO (ConfiguredProgram, ProgramDb)
-- | Like lookupProgramVersion, but raises an exception in case of
-- error instead of returning 'Left errMsg'.
requireProgramVersion :: Verbosity -> Program -> VersionRange -> ProgramDb -> IO (ConfiguredProgram, Version, ProgramDb)
-- | Check that a program is configured and available to be run.
--
-- It returns Nothing if the program couldn't be configured, or is
-- not found.
needProgram :: Verbosity -> Program -> ProgramDb -> IO (Maybe (ConfiguredProgram, ProgramDb))
-- | Looks up the given program in the program database and runs it.
runDbProgram :: Verbosity -> Program -> ProgramDb -> [ProgArg] -> IO ()
-- | Looks up the given program in the program database and runs it.
getDbProgramOutput :: Verbosity -> Program -> ProgramDb -> [ProgArg] -> IO String
ghcProgram :: Program
ghcPkgProgram :: Program
ghcjsProgram :: Program
ghcjsPkgProgram :: Program
hmakeProgram :: Program
jhcProgram :: Program
uhcProgram :: Program
gccProgram :: Program
arProgram :: Program
stripProgram :: Program
happyProgram :: Program
alexProgram :: Program
hsc2hsProgram :: Program
c2hsProgram :: Program
cpphsProgram :: Program
hscolourProgram :: Program
doctestProgram :: Program
haddockProgram :: Program
greencardProgram :: Program
ldProgram :: Program
tarProgram :: Program
cppProgram :: Program
pkgConfigProgram :: Program
hpcProgram :: Program
-- | This module provides an library interface to the strip
-- program.
module Distribution.Simple.Program.Strip
stripLib :: Verbosity -> Platform -> ProgramDb -> FilePath -> IO ()
stripExe :: Verbosity -> Platform -> ProgramDb -> FilePath -> IO ()
-- | This is to do with command line handling. The Cabal command line is
-- organised into a number of named sub-commands (much like darcs). The
-- CommandUI abstraction represents one of these sub-commands,
-- with a name, description, a set of flags. Commands can be associated
-- with actions and run. It handles some common stuff automatically, like
-- the --help and command line completion flags. It is designed
-- to allow other tools make derived commands. This feature is used
-- heavily in cabal-install.
module Distribution.Simple.Command
data CommandUI flags
CommandUI :: String -> String -> (String -> String) -> Maybe (String -> String) -> Maybe (String -> String) -> flags -> (ShowOrParseArgs -> [OptionField flags]) -> CommandUI flags
-- | The name of the command as it would be entered on the command line.
-- For example "build".
[commandName] :: CommandUI flags -> String
-- | A short, one line description of the command to use in help texts.
[commandSynopsis] :: CommandUI flags -> String
-- | A function that maps a program name to a usage summary for this
-- command.
[commandUsage] :: CommandUI flags -> String -> String
-- | Additional explanation of the command to use in help texts.
[commandDescription] :: CommandUI flags -> Maybe (String -> String)
-- | Post-Usage notes and examples in help texts
[commandNotes] :: CommandUI flags -> Maybe (String -> String)
-- | Initial / empty flags
[commandDefaultFlags] :: CommandUI flags -> flags
-- | All the Option fields for this command
[commandOptions] :: CommandUI flags -> ShowOrParseArgs -> [OptionField flags]
-- | Show flags in the standard long option command line format
commandShowOptions :: CommandUI flags -> flags -> [String]
data CommandParse flags
CommandHelp :: (String -> String) -> CommandParse flags
CommandList :: [String] -> CommandParse flags
CommandErrors :: [String] -> CommandParse flags
CommandReadyToGo :: flags -> CommandParse flags
-- | Parse a bunch of command line arguments
commandParseArgs :: CommandUI flags -> Bool -> [String] -> CommandParse (flags -> flags, [String])
-- | Helper function for creating globalCommand description
getNormalCommandDescriptions :: [Command action] -> [(String, String)]
helpCommandUI :: CommandUI ()
data ShowOrParseArgs
ShowArgs :: ShowOrParseArgs
ParseArgs :: ShowOrParseArgs
-- | Default "usage" documentation text for commands.
usageDefault :: String -> String -> String
-- | Create "usage" documentation from a list of parameter configurations.
usageAlternatives :: String -> [String] -> String -> String
-- | Make a Command from standard GetOpt options.
mkCommandUI :: String -> String -> [String] -> flags -> (ShowOrParseArgs -> [OptionField flags]) -> CommandUI flags
-- | Mark command as hidden. Hidden commands don't show up in the 'progname
-- help' or 'progname --help' output.
hiddenCommand :: Command action -> Command action
data Command action
commandAddAction :: CommandUI flags -> (flags -> [String] -> action) -> Command action
-- | Utility function, many commands do not accept additional flags. This
-- action fails with a helpful error message if the user supplies any
-- extra.
noExtraFlags :: [String] -> IO ()
data CommandType
NormalCommand :: CommandType
HiddenCommand :: CommandType
-- | wraps a CommandUI together with a function that turns it into
-- a Command. By hiding the type of flags for the UI allows
-- construction of a list of all UIs at the top level of the program.
-- That list can then be used for generation of manual page as well as
-- for executing the selected command.
data CommandSpec action
CommandSpec :: CommandUI flags -> (CommandUI flags -> Command action) -> CommandType -> CommandSpec action
commandFromSpec :: CommandSpec a -> Command a
commandsRun :: CommandUI a -> [Command action] -> [String] -> CommandParse (a, CommandParse action)
-- | We usually have a data type for storing configuration values, where
-- every field stores a configuration option, and the user sets the value
-- either via command line flags or a configuration file. An individual
-- OptionField models such a field, and we usually build a list of
-- options associated to a configuration data type.
data OptionField a
OptionField :: Name -> [OptDescr a] -> OptionField a
[optionName] :: OptionField a -> Name
[optionDescr] :: OptionField a -> [OptDescr a]
type Name = String
-- | Create an option taking a single OptDescr. No explicit Name is given
-- for the Option, the name is the first LFlag given.
option :: SFlags -> LFlags -> Description -> get -> set -> MkOptDescr get set a -> OptionField a
-- | Create an option taking several OptDescrs. You will have to give the
-- flags and description individually to the OptDescr constructor.
multiOption :: Name -> get -> set -> [get -> set -> OptDescr a] -> OptionField a
liftOption :: (b -> a) -> (a -> b -> b) -> OptionField a -> OptionField b
liftOptionL :: ALens' b a -> OptionField a -> OptionField b
-- | An OptionField takes one or more OptDescrs, describing the command
-- line interface for the field.
data OptDescr a
ReqArg :: Description -> OptFlags -> ArgPlaceHolder -> ReadE (a -> a) -> (a -> [String]) -> OptDescr a
OptArg :: Description -> OptFlags -> ArgPlaceHolder -> ReadE (a -> a) -> (a -> a) -> (a -> [Maybe String]) -> OptDescr a
ChoiceOpt :: [(Description, OptFlags, a -> a, a -> Bool)] -> OptDescr a
BoolOpt :: Description -> OptFlags -> OptFlags -> (Bool -> a -> a) -> (a -> Maybe Bool) -> OptDescr a
type Description = String
-- | Short command line option strings
type SFlags = [Char]
-- | Long command line option strings
type LFlags = [String]
type OptFlags = (SFlags, LFlags)
type ArgPlaceHolder = String
type MkOptDescr get set a = SFlags -> LFlags -> Description -> get -> set -> OptDescr a
-- | Create a string-valued command line interface.
reqArg :: Monoid b => ArgPlaceHolder -> ReadE b -> (b -> [String]) -> MkOptDescr (a -> b) (b -> a -> a) a
-- | (String -> a) variant of "reqArg"
reqArg' :: Monoid b => ArgPlaceHolder -> (String -> b) -> (b -> [String]) -> MkOptDescr (a -> b) (b -> a -> a) a
-- | Create a string-valued command line interface with a default value.
optArg :: Monoid b => ArgPlaceHolder -> ReadE b -> b -> (b -> [Maybe String]) -> MkOptDescr (a -> b) (b -> a -> a) a
-- | (String -> a) variant of "optArg"
optArg' :: Monoid b => ArgPlaceHolder -> (Maybe String -> b) -> (b -> [Maybe String]) -> MkOptDescr (a -> b) (b -> a -> a) a
noArg :: Eq b => b -> MkOptDescr (a -> b) (b -> a -> a) a
boolOpt :: (b -> Maybe Bool) -> (Bool -> b) -> SFlags -> SFlags -> MkOptDescr (a -> b) (b -> a -> a) a
boolOpt' :: (b -> Maybe Bool) -> (Bool -> b) -> OptFlags -> OptFlags -> MkOptDescr (a -> b) (b -> a -> a) a
-- | create a Choice option
choiceOpt :: Eq b => [(b, OptFlags, Description)] -> MkOptDescr (a -> b) (b -> a -> a) a
-- | create a Choice option out of an enumeration type. As long flags, the
-- Show output is used. As short flags, the first character which does
-- not conflict with a previous one is used.
choiceOptFromEnum :: (Bounded b, Enum b, Show b, Eq b) => MkOptDescr (a -> b) (b -> a -> a) a
instance GHC.Base.Functor Distribution.Simple.Command.CommandParse
-- | This is a big module, but not very complicated. The code is very
-- regular and repetitive. It defines the command line interface for all
-- the Cabal commands. For each command (like configure,
-- build etc) it defines a type that holds all the flags, the
-- default set of flags and a CommandUI that maps command line
-- flags to and from the corresponding flags type.
--
-- All the flags types are instances of Monoid, see
-- http://www.haskell.org/pipermail/cabal-devel/2007-December/001509.html
-- for an explanation.
--
-- The types defined here get used in the front end and especially in
-- cabal-install which has to do quite a bit of manipulating
-- sets of command line flags.
--
-- This is actually relatively nice, it works quite well. The main change
-- it needs is to unify it with the code for managing sets of fields that
-- can be read and written from files. This would allow us to save
-- configure flags in config files.
module Distribution.Simple.Setup
-- | Flags that apply at the top level, not to any sub-command.
data GlobalFlags
GlobalFlags :: Flag Bool -> Flag Bool -> GlobalFlags
[globalVersion] :: GlobalFlags -> Flag Bool
[globalNumericVersion] :: GlobalFlags -> Flag Bool
emptyGlobalFlags :: GlobalFlags
defaultGlobalFlags :: GlobalFlags
globalCommand :: [Command action] -> CommandUI GlobalFlags
-- | Flags to configure command.
--
-- IMPORTANT: every time a new flag is added, filterConfigureFlags
-- should be updated. IMPORTANT: every time a new flag is added, it
-- should be added to the Eq instance
data ConfigFlags
ConfigFlags :: [String] -> Option' (Last' ProgramDb) -> [(String, FilePath)] -> [(String, [String])] -> NubList FilePath -> Flag CompilerFlavor -> Flag FilePath -> Flag FilePath -> Flag Bool -> Flag Bool -> Flag Bool -> Flag Bool -> Flag Bool -> Flag Bool -> Flag Bool -> Flag Bool -> Flag ProfDetailLevel -> Flag ProfDetailLevel -> [String] -> Flag OptimisationLevel -> Flag PathTemplate -> Flag PathTemplate -> InstallDirs (Flag PathTemplate) -> Flag FilePath -> [FilePath] -> [FilePath] -> [FilePath] -> Flag String -> Flag ComponentId -> Flag Bool -> Flag FilePath -> Flag FilePath -> Flag Verbosity -> Flag Bool -> [Maybe PackageDB] -> Flag Bool -> Flag Bool -> Flag Bool -> Flag Bool -> Flag Bool -> [PackageVersionConstraint] -> [GivenComponent] -> [(ModuleName, Module)] -> FlagAssignment -> Flag Bool -> Flag Bool -> Flag Bool -> Flag Bool -> Flag Bool -> Flag String -> Flag Bool -> Flag DebugInfoLevel -> Flag Bool -> Flag Bool -> ConfigFlags
[configArgs] :: ConfigFlags -> [String]
-- | All programs that cabal may run
[configPrograms_] :: ConfigFlags -> Option' (Last' ProgramDb)
-- | user specified programs paths
[configProgramPaths] :: ConfigFlags -> [(String, FilePath)]
-- | user specified programs args
[configProgramArgs] :: ConfigFlags -> [(String, [String])]
-- | Extend the $PATH
[configProgramPathExtra] :: ConfigFlags -> NubList FilePath
-- | The "flavor" of the compiler, e.g. GHC.
[configHcFlavor] :: ConfigFlags -> Flag CompilerFlavor
-- | given compiler location
[configHcPath] :: ConfigFlags -> Flag FilePath
-- | given hc-pkg location
[configHcPkg] :: ConfigFlags -> Flag FilePath
-- | Enable vanilla library
[configVanillaLib] :: ConfigFlags -> Flag Bool
-- | Enable profiling in the library
[configProfLib] :: ConfigFlags -> Flag Bool
-- | Build shared library
[configSharedLib] :: ConfigFlags -> Flag Bool
-- | Build static library
[configStaticLib] :: ConfigFlags -> Flag Bool
-- | Enable dynamic linking of the executables.
[configDynExe] :: ConfigFlags -> Flag Bool
-- | Enable fully static linking of the executables.
[configFullyStaticExe] :: ConfigFlags -> Flag Bool
-- | Enable profiling in the executables.
[configProfExe] :: ConfigFlags -> Flag Bool
-- | Enable profiling in the library and executables.
[configProf] :: ConfigFlags -> Flag Bool
-- | Profiling detail level in the library and executables.
[configProfDetail] :: ConfigFlags -> Flag ProfDetailLevel
-- | Profiling detail level in the library
[configProfLibDetail] :: ConfigFlags -> Flag ProfDetailLevel
-- | Extra arguments to configure
[configConfigureArgs] :: ConfigFlags -> [String]
-- | Enable optimization.
[configOptimization] :: ConfigFlags -> Flag OptimisationLevel
-- | Installed executable prefix.
[configProgPrefix] :: ConfigFlags -> Flag PathTemplate
-- | Installed executable suffix.
[configProgSuffix] :: ConfigFlags -> Flag PathTemplate
-- | Installation paths
[configInstallDirs] :: ConfigFlags -> InstallDirs (Flag PathTemplate)
[configScratchDir] :: ConfigFlags -> Flag FilePath
-- | path to search for extra libraries
[configExtraLibDirs] :: ConfigFlags -> [FilePath]
-- | path to search for extra frameworks (OS X only)
[configExtraFrameworkDirs] :: ConfigFlags -> [FilePath]
-- | path to search for header files
[configExtraIncludeDirs] :: ConfigFlags -> [FilePath]
-- | explicit IPID to be used
[configIPID] :: ConfigFlags -> Flag String
-- | explicit CID to be used
[configCID] :: ConfigFlags -> Flag ComponentId
-- | be as deterministic as possible (e.g., invariant over GHC, database,
-- etc). Used by the test suite
[configDeterministic] :: ConfigFlags -> Flag Bool
-- | "dist" prefix
[configDistPref] :: ConfigFlags -> Flag FilePath
-- | Cabal file to use
[configCabalFilePath] :: ConfigFlags -> Flag FilePath
-- | verbosity level
[configVerbosity] :: ConfigFlags -> Flag Verbosity
-- | The --user/--global flag
[configUserInstall] :: ConfigFlags -> Flag Bool
-- | Which package DBs to use
[configPackageDBs] :: ConfigFlags -> [Maybe PackageDB]
-- | Enable compiling library for GHCi
[configGHCiLib] :: ConfigFlags -> Flag Bool
-- | Enable -split-sections with GHC
[configSplitSections] :: ConfigFlags -> Flag Bool
-- | Enable -split-objs with GHC
[configSplitObjs] :: ConfigFlags -> Flag Bool
-- | Enable executable stripping
[configStripExes] :: ConfigFlags -> Flag Bool
-- | Enable library stripping
[configStripLibs] :: ConfigFlags -> Flag Bool
-- | Additional constraints for dependencies.
[configConstraints] :: ConfigFlags -> [PackageVersionConstraint]
-- | The packages depended on.
[configDependencies] :: ConfigFlags -> [GivenComponent]
-- | The requested Backpack instantiation. If empty, either this package
-- does not use Backpack, or we just want to typecheck the indefinite
-- package.
[configInstantiateWith] :: ConfigFlags -> [(ModuleName, Module)]
[configConfigurationsFlags] :: ConfigFlags -> FlagAssignment
-- | Enable test suite compilation
[configTests] :: ConfigFlags -> Flag Bool
-- | Enable benchmark compilation
[configBenchmarks] :: ConfigFlags -> Flag Bool
-- | Enable program coverage
[configCoverage] :: ConfigFlags -> Flag Bool
-- | Enable program coverage (deprecated)
[configLibCoverage] :: ConfigFlags -> Flag Bool
-- | All direct dependencies and flags are provided on the command line by
-- the user via the '--dependency' and '--flags' options.
[configExactConfiguration] :: ConfigFlags -> Flag Bool
-- | Halt and show an error message indicating an error in flag assignment
[configFlagError] :: ConfigFlags -> Flag String
-- | Enable relocatable package built
[configRelocatable] :: ConfigFlags -> Flag Bool
-- | Emit debug info.
[configDebugInfo] :: ConfigFlags -> Flag DebugInfoLevel
-- | Whether to use response files at all. They're used for such tools as
-- haddock, or ld.
[configUseResponseFiles] :: ConfigFlags -> Flag Bool
-- | Allow depending on private sublibraries. This is used by external
-- tools (like cabal-install) so they can add multiple-public-libraries
-- compatibility to older ghcs by checking visibility externally.
[configAllowDependingOnPrivateLibs] :: ConfigFlags -> Flag Bool
emptyConfigFlags :: ConfigFlags
defaultConfigFlags :: ProgramDb -> ConfigFlags
configureCommand :: ProgramDb -> CommandUI ConfigFlags
-- | More convenient version of configPrograms. Results in an
-- error if internal invariant is violated.
configPrograms :: WithCallStack (ConfigFlags -> ProgramDb)
configAbsolutePaths :: ConfigFlags -> IO ConfigFlags
readPackageDbList :: String -> [Maybe PackageDB]
showPackageDbList :: [Maybe PackageDB] -> [String]
-- | Flags to copy: (destdir, copy-prefix (backwards compat),
-- verbosity)
data CopyFlags
CopyFlags :: Flag CopyDest -> Flag FilePath -> Flag Verbosity -> [String] -> Flag FilePath -> CopyFlags
[copyDest] :: CopyFlags -> Flag CopyDest
[copyDistPref] :: CopyFlags -> Flag FilePath
[copyVerbosity] :: CopyFlags -> Flag Verbosity
[copyArgs] :: CopyFlags -> [String]
[copyCabalFilePath] :: CopyFlags -> Flag FilePath
emptyCopyFlags :: CopyFlags
defaultCopyFlags :: CopyFlags
copyCommand :: CommandUI CopyFlags
-- | Flags to install: (package db, verbosity)
data InstallFlags
InstallFlags :: Flag PackageDB -> Flag CopyDest -> Flag FilePath -> Flag Bool -> Flag Bool -> Flag Verbosity -> Flag FilePath -> InstallFlags
[installPackageDB] :: InstallFlags -> Flag PackageDB
[installDest] :: InstallFlags -> Flag CopyDest
[installDistPref] :: InstallFlags -> Flag FilePath
[installUseWrapper] :: InstallFlags -> Flag Bool
[installInPlace] :: InstallFlags -> Flag Bool
[installVerbosity] :: InstallFlags -> Flag Verbosity
[installCabalFilePath] :: InstallFlags -> Flag FilePath
emptyInstallFlags :: InstallFlags
defaultInstallFlags :: InstallFlags
installCommand :: CommandUI InstallFlags
-- | When we build haddock documentation, there are two cases:
--
--
-- - We build haddocks only for the current development version,
-- intended for local use and not for distribution. In this case, we
-- store the generated documentation in
-- distdochtml/name.
-- - We build haddocks for intended for uploading them to hackage. In
-- this case, we need to follow the layout that hackage expects from
-- documentation tarballs, and we might also want to use different flags
-- than for development builds, so in this case we store the generated
-- documentation in
-- distdochtml/id-docs.
--
data HaddockTarget
ForHackage :: HaddockTarget
ForDevelopment :: HaddockTarget
data HaddockFlags
HaddockFlags :: [(String, FilePath)] -> [(String, [String])] -> Flag Bool -> Flag Bool -> Flag String -> Flag HaddockTarget -> Flag Bool -> Flag Bool -> Flag Bool -> Flag Bool -> Flag Bool -> Flag FilePath -> Flag Bool -> Flag Bool -> Flag FilePath -> Flag PathTemplate -> Flag FilePath -> Flag Bool -> Flag Verbosity -> Flag FilePath -> [String] -> HaddockFlags
[haddockProgramPaths] :: HaddockFlags -> [(String, FilePath)]
[haddockProgramArgs] :: HaddockFlags -> [(String, [String])]
[haddockHoogle] :: HaddockFlags -> Flag Bool
[haddockHtml] :: HaddockFlags -> Flag Bool
[haddockHtmlLocation] :: HaddockFlags -> Flag String
[haddockForHackage] :: HaddockFlags -> Flag HaddockTarget
[haddockExecutables] :: HaddockFlags -> Flag Bool
[haddockTestSuites] :: HaddockFlags -> Flag Bool
[haddockBenchmarks] :: HaddockFlags -> Flag Bool
[haddockForeignLibs] :: HaddockFlags -> Flag Bool
[haddockInternal] :: HaddockFlags -> Flag Bool
[haddockCss] :: HaddockFlags -> Flag FilePath
[haddockLinkedSource] :: HaddockFlags -> Flag Bool
[haddockQuickJump] :: HaddockFlags -> Flag Bool
[haddockHscolourCss] :: HaddockFlags -> Flag FilePath
[haddockContents] :: HaddockFlags -> Flag PathTemplate
[haddockDistPref] :: HaddockFlags -> Flag FilePath
[haddockKeepTempFiles] :: HaddockFlags -> Flag Bool
[haddockVerbosity] :: HaddockFlags -> Flag Verbosity
[haddockCabalFilePath] :: HaddockFlags -> Flag FilePath
[haddockArgs] :: HaddockFlags -> [String]
emptyHaddockFlags :: HaddockFlags
defaultHaddockFlags :: HaddockFlags
haddockCommand :: CommandUI HaddockFlags
data HscolourFlags
HscolourFlags :: Flag FilePath -> Flag Bool -> Flag Bool -> Flag Bool -> Flag Bool -> Flag FilePath -> Flag Verbosity -> Flag FilePath -> HscolourFlags
[hscolourCSS] :: HscolourFlags -> Flag FilePath
[hscolourExecutables] :: HscolourFlags -> Flag Bool
[hscolourTestSuites] :: HscolourFlags -> Flag Bool
[hscolourBenchmarks] :: HscolourFlags -> Flag Bool
[hscolourForeignLibs] :: HscolourFlags -> Flag Bool
[hscolourDistPref] :: HscolourFlags -> Flag FilePath
[hscolourVerbosity] :: HscolourFlags -> Flag Verbosity
[hscolourCabalFilePath] :: HscolourFlags -> Flag FilePath
emptyHscolourFlags :: HscolourFlags
defaultHscolourFlags :: HscolourFlags
hscolourCommand :: CommandUI HscolourFlags
data BuildFlags
BuildFlags :: [(String, FilePath)] -> [(String, [String])] -> Flag FilePath -> Flag Verbosity -> Flag (Maybe Int) -> [String] -> Flag FilePath -> BuildFlags
[buildProgramPaths] :: BuildFlags -> [(String, FilePath)]
[buildProgramArgs] :: BuildFlags -> [(String, [String])]
[buildDistPref] :: BuildFlags -> Flag FilePath
[buildVerbosity] :: BuildFlags -> Flag Verbosity
[buildNumJobs] :: BuildFlags -> Flag (Maybe Int)
[buildArgs] :: BuildFlags -> [String]
[buildCabalFilePath] :: BuildFlags -> Flag FilePath
emptyBuildFlags :: BuildFlags
defaultBuildFlags :: BuildFlags
buildCommand :: ProgramDb -> CommandUI BuildFlags
data ShowBuildInfoFlags
ShowBuildInfoFlags :: BuildFlags -> Maybe FilePath -> ShowBuildInfoFlags
[buildInfoBuildFlags] :: ShowBuildInfoFlags -> BuildFlags
[buildInfoOutputFile] :: ShowBuildInfoFlags -> Maybe FilePath
defaultShowBuildFlags :: ShowBuildInfoFlags
showBuildInfoCommand :: ProgramDb -> CommandUI ShowBuildInfoFlags
data ReplFlags
ReplFlags :: [(String, FilePath)] -> [(String, [String])] -> Flag FilePath -> Flag Verbosity -> Flag Bool -> [String] -> ReplFlags
[replProgramPaths] :: ReplFlags -> [(String, FilePath)]
[replProgramArgs] :: ReplFlags -> [(String, [String])]
[replDistPref] :: ReplFlags -> Flag FilePath
[replVerbosity] :: ReplFlags -> Flag Verbosity
[replReload] :: ReplFlags -> Flag Bool
[replReplOptions] :: ReplFlags -> [String]
defaultReplFlags :: ReplFlags
replCommand :: ProgramDb -> CommandUI ReplFlags
data CleanFlags
CleanFlags :: Flag Bool -> Flag FilePath -> Flag Verbosity -> Flag FilePath -> CleanFlags
[cleanSaveConf] :: CleanFlags -> Flag Bool
[cleanDistPref] :: CleanFlags -> Flag FilePath
[cleanVerbosity] :: CleanFlags -> Flag Verbosity
[cleanCabalFilePath] :: CleanFlags -> Flag FilePath
emptyCleanFlags :: CleanFlags
defaultCleanFlags :: CleanFlags
cleanCommand :: CommandUI CleanFlags
-- | Flags to register and unregister: (user package,
-- gen-script, in-place, verbosity)
data RegisterFlags
RegisterFlags :: Flag PackageDB -> Flag Bool -> Flag (Maybe FilePath) -> Flag Bool -> Flag FilePath -> Flag Bool -> Flag Verbosity -> [String] -> Flag FilePath -> RegisterFlags
[regPackageDB] :: RegisterFlags -> Flag PackageDB
[regGenScript] :: RegisterFlags -> Flag Bool
[regGenPkgConf] :: RegisterFlags -> Flag (Maybe FilePath)
[regInPlace] :: RegisterFlags -> Flag Bool
[regDistPref] :: RegisterFlags -> Flag FilePath
[regPrintId] :: RegisterFlags -> Flag Bool
[regVerbosity] :: RegisterFlags -> Flag Verbosity
[regArgs] :: RegisterFlags -> [String]
[regCabalFilePath] :: RegisterFlags -> Flag FilePath
emptyRegisterFlags :: RegisterFlags
defaultRegisterFlags :: RegisterFlags
registerCommand :: CommandUI RegisterFlags
unregisterCommand :: CommandUI RegisterFlags
-- | Flags to sdist: (snapshot, verbosity)
data SDistFlags
SDistFlags :: Flag Bool -> Flag FilePath -> Flag FilePath -> Flag FilePath -> Flag Verbosity -> SDistFlags
[sDistSnapshot] :: SDistFlags -> Flag Bool
[sDistDirectory] :: SDistFlags -> Flag FilePath
[sDistDistPref] :: SDistFlags -> Flag FilePath
[sDistListSources] :: SDistFlags -> Flag FilePath
[sDistVerbosity] :: SDistFlags -> Flag Verbosity
emptySDistFlags :: SDistFlags
defaultSDistFlags :: SDistFlags
sdistCommand :: CommandUI SDistFlags
data TestFlags
TestFlags :: Flag FilePath -> Flag Verbosity -> Flag PathTemplate -> Flag PathTemplate -> Flag TestShowDetails -> Flag Bool -> Flag FilePath -> Flag Bool -> [PathTemplate] -> TestFlags
[testDistPref] :: TestFlags -> Flag FilePath
[testVerbosity] :: TestFlags -> Flag Verbosity
[testHumanLog] :: TestFlags -> Flag PathTemplate
[testMachineLog] :: TestFlags -> Flag PathTemplate
[testShowDetails] :: TestFlags -> Flag TestShowDetails
[testKeepTix] :: TestFlags -> Flag Bool
[testWrapper] :: TestFlags -> Flag FilePath
[testFailWhenNoTestSuites] :: TestFlags -> Flag Bool
[testOptions] :: TestFlags -> [PathTemplate]
emptyTestFlags :: TestFlags
defaultTestFlags :: TestFlags
testCommand :: CommandUI TestFlags
data TestShowDetails
Never :: TestShowDetails
Failures :: TestShowDetails
Always :: TestShowDetails
Streaming :: TestShowDetails
Direct :: TestShowDetails
data BenchmarkFlags
BenchmarkFlags :: Flag FilePath -> Flag Verbosity -> [PathTemplate] -> BenchmarkFlags
[benchmarkDistPref] :: BenchmarkFlags -> Flag FilePath
[benchmarkVerbosity] :: BenchmarkFlags -> Flag Verbosity
[benchmarkOptions] :: BenchmarkFlags -> [PathTemplate]
emptyBenchmarkFlags :: BenchmarkFlags
defaultBenchmarkFlags :: BenchmarkFlags
benchmarkCommand :: CommandUI BenchmarkFlags
-- | The location prefix for the copy command.
data CopyDest
NoCopyDest :: CopyDest
CopyTo :: FilePath -> CopyDest
-- | when using the ${pkgroot} as prefix. The CopyToDb will adjust the
-- paths to be relative to the provided package database when copying /
-- installing.
CopyToDb :: FilePath -> CopyDest
-- | Arguments to pass to a configure script, e.g. generated by
-- autoconf.
configureArgs :: Bool -> ConfigFlags -> [String]
configureOptions :: ShowOrParseArgs -> [OptionField ConfigFlags]
configureCCompiler :: Verbosity -> ProgramDb -> IO (FilePath, [String])
configureLinker :: Verbosity -> ProgramDb -> IO (FilePath, [String])
buildOptions :: ProgramDb -> ShowOrParseArgs -> [OptionField BuildFlags]
haddockOptions :: ShowOrParseArgs -> [OptionField HaddockFlags]
installDirsOptions :: [OptionField (InstallDirs (Flag PathTemplate))]
testOptions' :: ShowOrParseArgs -> [OptionField TestFlags]
benchmarkOptions' :: ShowOrParseArgs -> [OptionField BenchmarkFlags]
-- | For each known program PROG in progDb, produce a
-- PROG-options OptionField.
programDbOptions :: ProgramDb -> ShowOrParseArgs -> (flags -> [(String, [String])]) -> ([(String, [String])] -> flags -> flags) -> [OptionField flags]
-- | Like programDbPaths, but allows to customise the option name.
programDbPaths' :: (String -> String) -> ProgramDb -> ShowOrParseArgs -> (flags -> [(String, FilePath)]) -> ([(String, FilePath)] -> flags -> flags) -> [OptionField flags]
programFlagsDescription :: ProgramDb -> String
replOptions :: ShowOrParseArgs -> [OptionField [String]]
-- | Helper function to split a string into a list of arguments. It's
-- supposed to handle quoted things sensibly, eg:
--
--
-- splitArgs "--foo=\"C:/Program Files/Bar/" --baz"
-- = ["--foo=C:/Program Files/Bar", "--baz"]
--
--
--
-- splitArgs "\"-DMSGSTR=\\\"foo bar\\\"\" --baz"
-- = ["-DMSGSTR=\"foo bar\"","--baz"]
--
splitArgs :: String -> [String]
defaultDistPref :: FilePath
optionDistPref :: (flags -> Flag FilePath) -> (Flag FilePath -> flags -> flags) -> ShowOrParseArgs -> OptionField flags
-- | All flags are monoids, they come in two flavours:
--
--
-- - list flags eg
--
--
--
-- --ghc-option=foo --ghc-option=bar
--
--
-- gives us all the values ["foo", "bar"]
--
--
-- - singular value flags, eg:
--
--
--
-- --enable-foo --disable-foo
--
--
-- gives us Just False So this Flag type is for the latter singular kind
-- of flag. Its monoid instance gives us the behaviour where it starts
-- out as NoFlag and later flags override earlier ones.
data Flag a
Flag :: a -> Flag a
NoFlag :: Flag a
toFlag :: a -> Flag a
fromFlag :: WithCallStack (Flag a -> a)
fromFlagOrDefault :: a -> Flag a -> a
flagToMaybe :: Flag a -> Maybe a
flagToList :: Flag a -> [a]
maybeToFlag :: Maybe a -> Flag a
-- | Types that represent boolean flags.
class BooleanFlag a
asBool :: BooleanFlag a => a -> Bool
boolOpt :: SFlags -> SFlags -> MkOptDescr (a -> Flag Bool) (Flag Bool -> a -> a) a
boolOpt' :: OptFlags -> OptFlags -> MkOptDescr (a -> Flag Bool) (Flag Bool -> a -> a) a
trueArg :: MkOptDescr (a -> Flag Bool) (Flag Bool -> a -> a) a
falseArg :: MkOptDescr (a -> Flag Bool) (Flag Bool -> a -> a) a
optionVerbosity :: (flags -> Flag Verbosity) -> (Flag Verbosity -> flags -> flags) -> OptionField flags
optionNumJobs :: (flags -> Flag (Maybe Int)) -> (Flag (Maybe Int) -> flags -> flags) -> OptionField flags
instance GHC.Generics.Generic Distribution.Simple.Setup.GlobalFlags
instance GHC.Show.Show Distribution.Simple.Setup.ConfigFlags
instance GHC.Read.Read Distribution.Simple.Setup.ConfigFlags
instance GHC.Generics.Generic Distribution.Simple.Setup.ConfigFlags
instance GHC.Generics.Generic Distribution.Simple.Setup.CopyFlags
instance GHC.Show.Show Distribution.Simple.Setup.CopyFlags
instance GHC.Generics.Generic Distribution.Simple.Setup.InstallFlags
instance GHC.Show.Show Distribution.Simple.Setup.InstallFlags
instance GHC.Generics.Generic Distribution.Simple.Setup.SDistFlags
instance GHC.Show.Show Distribution.Simple.Setup.SDistFlags
instance GHC.Generics.Generic Distribution.Simple.Setup.RegisterFlags
instance GHC.Show.Show Distribution.Simple.Setup.RegisterFlags
instance GHC.Generics.Generic Distribution.Simple.Setup.HscolourFlags
instance GHC.Show.Show Distribution.Simple.Setup.HscolourFlags
instance GHC.Generics.Generic Distribution.Simple.Setup.HaddockTarget
instance GHC.Show.Show Distribution.Simple.Setup.HaddockTarget
instance GHC.Classes.Eq Distribution.Simple.Setup.HaddockTarget
instance GHC.Generics.Generic Distribution.Simple.Setup.HaddockFlags
instance GHC.Show.Show Distribution.Simple.Setup.HaddockFlags
instance GHC.Generics.Generic Distribution.Simple.Setup.CleanFlags
instance GHC.Show.Show Distribution.Simple.Setup.CleanFlags
instance GHC.Generics.Generic Distribution.Simple.Setup.BuildFlags
instance GHC.Show.Show Distribution.Simple.Setup.BuildFlags
instance GHC.Read.Read Distribution.Simple.Setup.BuildFlags
instance GHC.Generics.Generic Distribution.Simple.Setup.ReplFlags
instance GHC.Show.Show Distribution.Simple.Setup.ReplFlags
instance GHC.Show.Show Distribution.Simple.Setup.TestShowDetails
instance GHC.Generics.Generic Distribution.Simple.Setup.TestShowDetails
instance GHC.Enum.Bounded Distribution.Simple.Setup.TestShowDetails
instance GHC.Enum.Enum Distribution.Simple.Setup.TestShowDetails
instance GHC.Classes.Ord Distribution.Simple.Setup.TestShowDetails
instance GHC.Classes.Eq Distribution.Simple.Setup.TestShowDetails
instance GHC.Generics.Generic Distribution.Simple.Setup.TestFlags
instance GHC.Show.Show Distribution.Simple.Setup.TestFlags
instance GHC.Generics.Generic Distribution.Simple.Setup.BenchmarkFlags
instance GHC.Show.Show Distribution.Simple.Setup.BenchmarkFlags
instance GHC.Show.Show Distribution.Simple.Setup.ShowBuildInfoFlags
instance GHC.Base.Monoid Distribution.Simple.Setup.BenchmarkFlags
instance GHC.Base.Semigroup Distribution.Simple.Setup.BenchmarkFlags
instance GHC.Base.Monoid Distribution.Simple.Setup.TestFlags
instance GHC.Base.Semigroup Distribution.Simple.Setup.TestFlags
instance Data.Binary.Class.Binary Distribution.Simple.Setup.TestShowDetails
instance Distribution.Utils.Structured.Structured Distribution.Simple.Setup.TestShowDetails
instance Distribution.Pretty.Pretty Distribution.Simple.Setup.TestShowDetails
instance Distribution.Parsec.Parsec Distribution.Simple.Setup.TestShowDetails
instance GHC.Base.Monoid Distribution.Simple.Setup.TestShowDetails
instance GHC.Base.Semigroup Distribution.Simple.Setup.TestShowDetails
instance GHC.Base.Monoid Distribution.Simple.Setup.ReplFlags
instance GHC.Base.Semigroup Distribution.Simple.Setup.ReplFlags
instance GHC.Base.Monoid Distribution.Simple.Setup.BuildFlags
instance GHC.Base.Semigroup Distribution.Simple.Setup.BuildFlags
instance GHC.Base.Monoid Distribution.Simple.Setup.CleanFlags
instance GHC.Base.Semigroup Distribution.Simple.Setup.CleanFlags
instance GHC.Base.Monoid Distribution.Simple.Setup.HaddockFlags
instance GHC.Base.Semigroup Distribution.Simple.Setup.HaddockFlags
instance Data.Binary.Class.Binary Distribution.Simple.Setup.HaddockTarget
instance Distribution.Utils.Structured.Structured Distribution.Simple.Setup.HaddockTarget
instance Distribution.Pretty.Pretty Distribution.Simple.Setup.HaddockTarget
instance Distribution.Parsec.Parsec Distribution.Simple.Setup.HaddockTarget
instance GHC.Base.Monoid Distribution.Simple.Setup.HscolourFlags
instance GHC.Base.Semigroup Distribution.Simple.Setup.HscolourFlags
instance GHC.Base.Monoid Distribution.Simple.Setup.RegisterFlags
instance GHC.Base.Semigroup Distribution.Simple.Setup.RegisterFlags
instance GHC.Base.Monoid Distribution.Simple.Setup.SDistFlags
instance GHC.Base.Semigroup Distribution.Simple.Setup.SDistFlags
instance GHC.Base.Monoid Distribution.Simple.Setup.InstallFlags
instance GHC.Base.Semigroup Distribution.Simple.Setup.InstallFlags
instance GHC.Base.Monoid Distribution.Simple.Setup.CopyFlags
instance GHC.Base.Semigroup Distribution.Simple.Setup.CopyFlags
instance Data.Binary.Class.Binary Distribution.Simple.Setup.ConfigFlags
instance Distribution.Utils.Structured.Structured Distribution.Simple.Setup.ConfigFlags
instance GHC.Classes.Eq Distribution.Simple.Setup.ConfigFlags
instance GHC.Base.Monoid Distribution.Simple.Setup.ConfigFlags
instance GHC.Base.Semigroup Distribution.Simple.Setup.ConfigFlags
instance GHC.Base.Monoid Distribution.Simple.Setup.GlobalFlags
instance GHC.Base.Semigroup Distribution.Simple.Setup.GlobalFlags
-- | This is about the cabal configurations feature. It exports
-- finalizePD and flattenPackageDescription which are
-- functions for converting GenericPackageDescriptions down to
-- PackageDescriptions. It has code for working with the tree of
-- conditions and resolving or flattening conditions.
module Distribution.PackageDescription.Configuration
-- | Create a package description with all configurations resolved.
--
-- This function takes a GenericPackageDescription and several
-- environment parameters and tries to generate PackageDescription
-- by finding a flag assignment that result in satisfiable dependencies.
--
-- It takes as inputs a not necessarily complete specifications of flags
-- assignments, an optional package index as well as platform parameters.
-- If some flags are not assigned explicitly, this function will try to
-- pick an assignment that causes this function to succeed. The package
-- index is optional since on some platforms we cannot determine which
-- packages have been installed before. When no package index is
-- supplied, every dependency is assumed to be satisfiable, therefore all
-- not explicitly assigned flags will get their default values.
--
-- This function will fail if it cannot find a flag assignment that leads
-- to satisfiable dependencies. (It will not try alternative assignments
-- for explicitly specified flags.) In case of failure it will return the
-- missing dependencies that it encountered when trying different flag
-- assignments. On success, it will return the package description and
-- the full flag assignment chosen.
--
-- Note that this drops any stanzas which have buildable: False.
-- While this is arguably the right thing to do, it means we give bad
-- error messages in some situations, see #3858.
finalizePD :: FlagAssignment -> ComponentRequestedSpec -> (Dependency -> Bool) -> Platform -> CompilerInfo -> [PackageVersionConstraint] -> GenericPackageDescription -> Either [Dependency] (PackageDescription, FlagAssignment)
-- | Flatten a generic package description by ignoring all conditions and
-- just join the field descriptors into on package description. Note,
-- however, that this may lead to inconsistent field values, since all
-- values are joined into one field, which may not be possible in the
-- original package description, due to the use of exclusive choices (if
-- ... else ...).
--
-- TODO: One particularly tricky case is defaulting. In the original
-- package description, e.g., the source directory might either be the
-- default or a certain, explicitly set path. Since defaults are filled
-- in only after the package has been resolved and when no explicit value
-- has been set, the default path will be missing from the package
-- description returned by this function.
flattenPackageDescription :: GenericPackageDescription -> PackageDescription
-- | Parse a configuration condition from a string.
parseCondition :: CabalParsing m => m (Condition ConfVar)
freeVars :: CondTree ConfVar c a -> [FlagName]
-- | Extract the condition matched by the given predicate from a cond tree.
--
-- We use this mainly for extracting buildable conditions (see the Note
-- in Distribution.PackageDescription.Configuration), but the function is
-- in fact more general.
extractCondition :: Eq v => (a -> Bool) -> CondTree v c a -> Condition v
-- | Extract conditions matched by the given predicate from all cond trees
-- in a GenericPackageDescription.
extractConditions :: (BuildInfo -> Bool) -> GenericPackageDescription -> [Condition ConfVar]
-- | Transforms a CondTree by putting the input under the "then"
-- branch of a conditional that is True when Buildable is True. If
-- addBuildableCondition can determine that Buildable is always
-- True, it returns the input unchanged. If Buildable is always False, it
-- returns the empty CondTree.
addBuildableCondition :: (Eq v, Monoid a, Monoid c) => (a -> BuildInfo) -> CondTree v c a -> CondTree v c a
mapCondTree :: (a -> b) -> (c -> d) -> (Condition v -> Condition w) -> CondTree v c a -> CondTree w d b
mapTreeData :: (a -> b) -> CondTree v c a -> CondTree v c b
mapTreeConds :: (Condition v -> Condition w) -> CondTree v c a -> CondTree w c a
mapTreeConstrs :: (c -> d) -> CondTree v c a -> CondTree v d a
transformAllBuildInfos :: (BuildInfo -> BuildInfo) -> (SetupBuildInfo -> SetupBuildInfo) -> GenericPackageDescription -> GenericPackageDescription
-- | Walk a GenericPackageDescription and apply f to all
-- nested build-depends fields.
transformAllBuildDepends :: (Dependency -> Dependency) -> GenericPackageDescription -> GenericPackageDescription
-- | Walk a GenericPackageDescription and apply f to all
-- nested build-depends fields.
transformAllBuildDependsN :: ([Dependency] -> [Dependency]) -> GenericPackageDescription -> GenericPackageDescription
instance GHC.Show.Show Distribution.PackageDescription.Configuration.PDTagged
instance GHC.Base.Monoid Distribution.PackageDescription.Configuration.PDTagged
instance GHC.Base.Semigroup Distribution.PackageDescription.Configuration.PDTagged
instance GHC.Base.Semigroup Distribution.PackageDescription.Configuration.DepMapUnion
instance GHC.Base.Semigroup d => GHC.Base.Monoid (Distribution.PackageDescription.Configuration.DepTestRslt d)
instance GHC.Base.Semigroup d => GHC.Base.Semigroup (Distribution.PackageDescription.Configuration.DepTestRslt d)
-- | This is an alternative build system that delegates everything to the
-- make program. All the commands just end up calling
-- make with appropriate arguments. The intention was to allow
-- preexisting packages that used makefiles to be wrapped into Cabal
-- packages. In practice essentially all such packages were converted
-- over to the "Simple" build system instead. Consequently this module is
-- not used much and it certainly only sees cursory maintenance and no
-- testing. Perhaps at some point we should stop pretending that it
-- works.
--
-- Uses the parsed command-line from Distribution.Simple.Setup in
-- order to build Haskell tools using a back-end build system based on
-- make. Obviously we assume that there is a configure script, and that
-- after the ConfigCmd has been run, there is a Makefile. Further
-- assumptions:
--
--
-- - ConfigCmd We assume the configure script accepts
-- --with-hc, --with-hc-pkg, --prefix,
-- --bindir, --libdir, --libexecdir,
-- --datadir.
-- - BuildCmd We assume that the default Makefile target will
-- build everything.
-- - InstallCmd We assume there is an install target.
-- Note that we assume that this does *not* register the package!
-- - CopyCmd We assume there is a copy target, and a
-- variable $(destdir). The copy target should probably
-- just invoke make install recursively (e.g. $(MAKE)
-- install prefix=$(destdir)/$(prefix) bindir=$(destdir)/$(bindir).
-- The reason we can't invoke make install directly here is that
-- we don't know the value of $(prefix).
-- - SDistCmd We assume there is a dist target.
-- - RegisterCmd We assume there is a register target
-- and a variable $(user).
-- - UnregisterCmd We assume there is an unregister
-- target.
-- - HaddockCmd We assume there is a docs or
-- doc target.
--
module Distribution.Make
-- | Indicates the license under which a package's source code is released.
-- Versions of the licenses not listed here will be rejected by Hackage
-- and cause cabal check to issue a warning.
data License
-- | GNU General Public License, version 2 or version 3.
GPL :: Maybe Version -> License
-- | GNU Affero General Public License, version 3.
AGPL :: Maybe Version -> License
-- | GNU Lesser General Public License, version 2.1 or version
-- 3.
LGPL :: Maybe Version -> License
-- | 2-clause BSD license.
BSD2 :: License
-- | 3-clause BSD license.
BSD3 :: License
-- | 4-clause BSD license. This license has not been approved by the
-- OSI and is incompatible with the GNU GPL. It is provided for
-- historical reasons and should be avoided.
BSD4 :: License
-- | MIT license.
MIT :: License
-- | ISC license
ISC :: License
-- | Mozilla Public License, version 2.0.
MPL :: Version -> License
-- | Apache License, version 2.0.
Apache :: Maybe Version -> License
-- | The author of a package disclaims any copyright to its source code and
-- dedicates it to the public domain. This is not a software license.
-- Please note that it is not possible to dedicate works to the public
-- domain in every jurisdiction, nor is a work that is in the public
-- domain in one jurisdiction necessarily in the public domain elsewhere.
PublicDomain :: License
-- | Explicitly 'All Rights Reserved', eg for proprietary software. The
-- package may not be legally modified or redistributed by anyone but the
-- rightsholder.
AllRightsReserved :: License
-- | No license specified which legally defaults to 'All Rights Reserved'.
-- The package may not be legally modified or redistributed by anyone but
-- the rightsholder.
UnspecifiedLicense :: License
-- | Any other software license.
OtherLicense :: License
-- | Indicates an erroneous license name.
UnknownLicense :: String -> License
-- | A Version represents the version of a software entity.
--
-- Instances of Eq and Ord are provided, which gives exact
-- equality and lexicographic ordering of the version number components
-- (i.e. 2.1 > 2.0, 1.2.3 > 1.2.2, etc.).
--
-- This type is opaque and distinct from the Version type in
-- Data.Version since Cabal-2.0. The difference extends
-- to the Binary instance using a different (and more compact)
-- encoding.
data Version
defaultMain :: IO ()
defaultMainArgs :: [String] -> IO ()
-- | A parse result type for parsers from AST to Haskell types.
module Distribution.Fields.ParseResult
-- | A monad with failure and accumulating errors and warnings.
data ParseResult a
-- | Destruct a ParseResult into the emitted warnings and either a
-- successful value or list of errors and possibly recovered a
-- spec-version declaration.
runParseResult :: ParseResult a -> ([PWarning], Either (Maybe Version, NonEmpty PError) a)
-- | Recover the parse result, so we can proceed parsing.
-- runParseResult will still result in Nothing, if there
-- are recorded errors.
recoverWith :: ParseResult a -> a -> ParseResult a
-- | Add a warning. This doesn't fail the parsing process.
parseWarning :: Position -> PWarnType -> String -> ParseResult ()
-- | Add multiple warnings at once.
parseWarnings :: [PWarning] -> ParseResult ()
-- | Add an error, but not fail the parser yet.
--
-- For fatal failure use parseFatalFailure
parseFailure :: Position -> String -> ParseResult ()
-- | Add an fatal error.
parseFatalFailure :: Position -> String -> ParseResult a
-- | A mzero.
parseFatalFailure' :: ParseResult a
-- | Get cabal spec version.
getCabalSpecVersion :: ParseResult (Maybe Version)
-- | Set cabal spec version.
setCabalSpecVersion :: Maybe Version -> ParseResult ()
-- | Helper combinator to do parsing plumbing for files.
--
-- Given a parser and a filename, return the parse of the file, after
-- checking if the file exists.
--
-- Argument order is chosen to encourage partial application.
readAndParseFile :: (ByteString -> ParseResult a) -> Verbosity -> FilePath -> IO a
parseString :: (ByteString -> ParseResult a) -> Verbosity -> String -> ByteString -> IO a
-- | Forget ParseResults warnings.
withoutWarnings :: ParseResult a -> ParseResult a
instance GHC.Base.Functor Distribution.Fields.ParseResult.ParseResult
instance GHC.Base.Applicative Distribution.Fields.ParseResult.ParseResult
instance GHC.Base.Monad Distribution.Fields.ParseResult.ParseResult
-- | Cabal-like file AST types: Field, Section etc
--
-- These types are parametrized by an annotation.
module Distribution.Fields.Field
-- | A Cabal-like file consists of a series of fields (foo: bar)
-- and sections (library ...).
data Field ann
Field :: !Name ann -> [FieldLine ann] -> Field ann
Section :: !Name ann -> [SectionArg ann] -> [Field ann] -> Field ann
-- | Section of field name
fieldName :: Field ann -> Name ann
fieldAnn :: Field ann -> ann
-- | All transitive descendants of Field, including itself.
--
-- Note: the resulting list is never empty.
fieldUniverse :: Field ann -> [Field ann]
-- | A line of text representing the value of a field from a Cabal file. A
-- field may contain multiple lines.
--
-- Invariant: ByteString has no newlines.
data FieldLine ann
FieldLine :: !ann -> !ByteString -> FieldLine ann
fieldLineAnn :: FieldLine ann -> ann
fieldLineBS :: FieldLine ann -> ByteString
-- | Section arguments, e.g. name of the library
data SectionArg ann
-- | identifier, or something which looks like number. Also many dot
-- numbers, i.e. "7.6.3"
SecArgName :: !ann -> !ByteString -> SectionArg ann
-- | quoted string
SecArgStr :: !ann -> !ByteString -> SectionArg ann
-- | everything else, mm. operators (e.g. in if-section conditionals)
SecArgOther :: !ann -> !ByteString -> SectionArg ann
-- | Extract annotation from SectionArg.
sectionArgAnn :: SectionArg ann -> ann
type FieldName = ByteString
-- | A field name.
--
-- Invariant: ByteString is lower-case ASCII.
data Name ann
Name :: !ann -> !FieldName -> Name ann
mkName :: ann -> FieldName -> Name ann
getName :: Name ann -> FieldName
nameAnn :: Name ann -> ann
sectionArgsToString :: [SectionArg ann] -> String
-- | Convert [FieldLine] into String.
--
-- Note: this doesn't preserve indentation or empty lines, as the
-- annotations (e.g. positions) are ignored.
fieldLinesToString :: [FieldLine ann] -> String
instance Data.Traversable.Traversable Distribution.Fields.Field.FieldLine
instance Data.Foldable.Foldable Distribution.Fields.Field.FieldLine
instance GHC.Base.Functor Distribution.Fields.Field.FieldLine
instance GHC.Show.Show ann => GHC.Show.Show (Distribution.Fields.Field.FieldLine ann)
instance GHC.Classes.Eq ann => GHC.Classes.Eq (Distribution.Fields.Field.FieldLine ann)
instance Data.Traversable.Traversable Distribution.Fields.Field.SectionArg
instance Data.Foldable.Foldable Distribution.Fields.Field.SectionArg
instance GHC.Base.Functor Distribution.Fields.Field.SectionArg
instance GHC.Show.Show ann => GHC.Show.Show (Distribution.Fields.Field.SectionArg ann)
instance GHC.Classes.Eq ann => GHC.Classes.Eq (Distribution.Fields.Field.SectionArg ann)
instance Data.Traversable.Traversable Distribution.Fields.Field.Name
instance Data.Foldable.Foldable Distribution.Fields.Field.Name
instance GHC.Base.Functor Distribution.Fields.Field.Name
instance GHC.Show.Show ann => GHC.Show.Show (Distribution.Fields.Field.Name ann)
instance GHC.Classes.Eq ann => GHC.Classes.Eq (Distribution.Fields.Field.Name ann)
instance Data.Traversable.Traversable Distribution.Fields.Field.Field
instance Data.Foldable.Foldable Distribution.Fields.Field.Field
instance GHC.Base.Functor Distribution.Fields.Field.Field
instance GHC.Show.Show ann => GHC.Show.Show (Distribution.Fields.Field.Field ann)
instance GHC.Classes.Eq ann => GHC.Classes.Eq (Distribution.Fields.Field.Field ann)
module Distribution.Fields.Parser
-- | A Cabal-like file consists of a series of fields (foo: bar)
-- and sections (library ...).
data Field ann
Field :: !Name ann -> [FieldLine ann] -> Field ann
Section :: !Name ann -> [SectionArg ann] -> [Field ann] -> Field ann
-- | A field name.
--
-- Invariant: ByteString is lower-case ASCII.
data Name ann
Name :: !ann -> !FieldName -> Name ann
-- | A line of text representing the value of a field from a Cabal file. A
-- field may contain multiple lines.
--
-- Invariant: ByteString has no newlines.
data FieldLine ann
FieldLine :: !ann -> !ByteString -> FieldLine ann
-- | Section arguments, e.g. name of the library
data SectionArg ann
-- | identifier, or something which looks like number. Also many dot
-- numbers, i.e. "7.6.3"
SecArgName :: !ann -> !ByteString -> SectionArg ann
-- | quoted string
SecArgStr :: !ann -> !ByteString -> SectionArg ann
-- | everything else, mm. operators (e.g. in if-section conditionals)
SecArgOther :: !ann -> !ByteString -> SectionArg ann
-- | Parse cabal style ByteString into list of Fields, i.e.
-- the cabal AST.
readFields :: ByteString -> Either ParseError [Field Position]
-- | Like readFields but also return lexer warnings
readFields' :: ByteString -> Either ParseError ([Field Position], [LexWarning])
instance Text.Parsec.Prim.Stream Distribution.Fields.Parser.LexState' Data.Functor.Identity.Identity Distribution.Fields.Lexer.LToken
-- | Cabal-like file AST types: Field, Section etc,
--
-- This (intermediate) data type is used for pretty-printing.
module Distribution.Fields.Pretty
data PrettyField ann
PrettyField :: ann -> FieldName -> Doc -> PrettyField ann
PrettySection :: ann -> FieldName -> [Doc] -> [PrettyField ann] -> PrettyField ann
-- | Prettyprint a list of fields.
--
-- Note: the first argument should return Strings without newlines
-- and properly prefixes (with --) to count as comments. This
-- unsafety is left in place so one could generate empty lines between
-- comment lines.
showFields :: (ann -> [String]) -> [PrettyField ann] -> String
-- | showFields with user specified indentation.
showFields' :: (ann -> [String]) -> (ann -> [String] -> [String]) -> Int -> [PrettyField ann] -> String
-- | Simple variant of genericFromParsecField
fromParsecFields :: [Field ann] -> [PrettyField ann]
genericFromParsecFields :: Applicative f => (FieldName -> [FieldLine ann] -> f Doc) -> (FieldName -> [SectionArg ann] -> f [Doc]) -> [Field ann] -> f [PrettyField ann]
-- | Used in fromParsecFields.
prettyFieldLines :: FieldName -> [FieldLine ann] -> Doc
-- | Used in fromParsecFields.
prettySectionArgs :: FieldName -> [SectionArg ann] -> [Doc]
instance Data.Traversable.Traversable Distribution.Fields.Pretty.PrettyField
instance Data.Foldable.Foldable Distribution.Fields.Pretty.PrettyField
instance GHC.Base.Functor Distribution.Fields.Pretty.PrettyField
instance GHC.Classes.Eq Distribution.Fields.Pretty.Margin
instance GHC.Base.Semigroup Distribution.Fields.Pretty.Margin
module Distribution.Fields.ConfVar
-- | Parse Condition ConfVar from section arguments
-- provided by parsec based outline parser.
parseConditionConfVar :: [SectionArg Position] -> ParseResult (Condition ConfVar)
-- | Utilitiies to work with .cabal like file structure.
module Distribution.Fields
-- | A Cabal-like file consists of a series of fields (foo: bar)
-- and sections (library ...).
data Field ann
Field :: !Name ann -> [FieldLine ann] -> Field ann
Section :: !Name ann -> [SectionArg ann] -> [Field ann] -> Field ann
-- | A field name.
--
-- Invariant: ByteString is lower-case ASCII.
data Name ann
Name :: !ann -> !FieldName -> Name ann
-- | A line of text representing the value of a field from a Cabal file. A
-- field may contain multiple lines.
--
-- Invariant: ByteString has no newlines.
data FieldLine ann
FieldLine :: !ann -> !ByteString -> FieldLine ann
-- | Section arguments, e.g. name of the library
data SectionArg ann
-- | identifier, or something which looks like number. Also many dot
-- numbers, i.e. "7.6.3"
SecArgName :: !ann -> !ByteString -> SectionArg ann
-- | quoted string
SecArgStr :: !ann -> !ByteString -> SectionArg ann
-- | everything else, mm. operators (e.g. in if-section conditionals)
SecArgOther :: !ann -> !ByteString -> SectionArg ann
type FieldName = ByteString
-- | Parse cabal style ByteString into list of Fields, i.e.
-- the cabal AST.
readFields :: ByteString -> Either ParseError [Field Position]
-- | Like readFields but also return lexer warnings
readFields' :: ByteString -> Either ParseError ([Field Position], [LexWarning])
-- | A monad with failure and accumulating errors and warnings.
data ParseResult a
-- | Destruct a ParseResult into the emitted warnings and either a
-- successful value or list of errors and possibly recovered a
-- spec-version declaration.
runParseResult :: ParseResult a -> ([PWarning], Either (Maybe Version, NonEmpty PError) a)
parseString :: (ByteString -> ParseResult a) -> Verbosity -> String -> ByteString -> IO a
-- | Add a warning. This doesn't fail the parsing process.
parseWarning :: Position -> PWarnType -> String -> ParseResult ()
-- | Add multiple warnings at once.
parseWarnings :: [PWarning] -> ParseResult ()
-- | Add an error, but not fail the parser yet.
--
-- For fatal failure use parseFatalFailure
parseFailure :: Position -> String -> ParseResult ()
-- | Add an fatal error.
parseFatalFailure :: Position -> String -> ParseResult a
-- | Type of parser warning. We do classify warnings.
--
-- Different application may decide not to show some, or have fatal
-- behaviour on others
data PWarnType
-- | Unclassified warning
PWTOther :: PWarnType
-- | Invalid UTF encoding
PWTUTF :: PWarnType
-- | true or false, not True or False
PWTBoolCase :: PWarnType
-- | there are version with tags
PWTVersionTag :: PWarnType
-- | New syntax used, but no cabal-version: >= 1.2 specified
PWTNewSyntax :: PWarnType
-- | Old syntax used, and cabal-version >= 1.2 specified
PWTOldSyntax :: PWarnType
PWTDeprecatedField :: PWarnType
PWTInvalidSubsection :: PWarnType
PWTUnknownField :: PWarnType
PWTUnknownSection :: PWarnType
PWTTrailingFields :: PWarnType
-- | extra main-is field
PWTExtraMainIs :: PWarnType
-- | extra test-module field
PWTExtraTestModule :: PWarnType
-- | extra benchmark-module field
PWTExtraBenchmarkModule :: PWarnType
PWTLexNBSP :: PWarnType
PWTLexBOM :: PWarnType
PWTLexTab :: PWarnType
-- | legacy cabal file that we know how to patch
PWTQuirkyCabalFile :: PWarnType
-- | Double dash token, most likely it's a mistake - it's not a comment
PWTDoubleDash :: PWarnType
-- | e.g. name or version should be specified only once.
PWTMultipleSingularField :: PWarnType
-- | Workaround for derive-package having build-type: Default. See
-- https://github.com/haskell/cabal/issues/5020.
PWTBuildTypeDefault :: PWarnType
-- | Version operators used (without cabal-version: 1.8)
PWTVersionOperator :: PWarnType
-- | Version wildcard used (without cabal-version: 1.6)
PWTVersionWildcard :: PWarnType
-- | Warnings about cabal-version format.
PWTSpecVersion :: PWarnType
-- | Empty filepath, i.e. literally ""
PWTEmptyFilePath :: PWarnType
-- | Experimental feature
PWTExperimental :: PWarnType
-- | Parser warning.
data PWarning
PWarning :: !PWarnType -> !Position -> String -> PWarning
showPWarning :: FilePath -> PWarning -> String
-- | Parser error.
data PError
PError :: Position -> String -> PError
showPError :: FilePath -> PError -> String
data PrettyField ann
PrettyField :: ann -> FieldName -> Doc -> PrettyField ann
PrettySection :: ann -> FieldName -> [Doc] -> [PrettyField ann] -> PrettyField ann
-- | Prettyprint a list of fields.
--
-- Note: the first argument should return Strings without newlines
-- and properly prefixes (with --) to count as comments. This
-- unsafety is left in place so one could generate empty lines between
-- comment lines.
showFields :: (ann -> [String]) -> [PrettyField ann] -> String
genericFromParsecFields :: Applicative f => (FieldName -> [FieldLine ann] -> f Doc) -> (FieldName -> [SectionArg ann] -> f [Doc]) -> [Field ann] -> f [PrettyField ann]
-- | Simple variant of genericFromParsecField
fromParsecFields :: [Field ann] -> [PrettyField ann]
module Distribution.FieldGrammar.Class
-- | FieldGrammar is parametrised by
--
--
-- - s which is a structure we are parsing. We need this to
-- provide prettyprinter functionality
-- - a type of the field.
--
--
-- Note: We'd like to have forall s. Applicative (f s)
-- context.
class (c SpecVersion, c TestedWith, c SpecLicense, c Token, c Token', c FilePathNT) => FieldGrammar c g | g -> c
-- | Unfocus, zoom out, blur FieldGrammar.
blurFieldGrammar :: FieldGrammar c g => ALens' a b -> g b d -> g a d
-- | Field which should be defined, exactly once.
uniqueFieldAla :: (FieldGrammar c g, c b, Newtype a b) => FieldName -> (a -> b) -> ALens' s a -> g s a
-- | Boolean field with a default value.
booleanFieldDef :: FieldGrammar c g => FieldName -> ALens' s Bool -> Bool -> g s Bool
-- | Optional field.
optionalFieldAla :: (FieldGrammar c g, c b, Newtype a b) => FieldName -> (a -> b) -> ALens' s (Maybe a) -> g s (Maybe a)
-- | Optional field with default value.
optionalFieldDefAla :: (FieldGrammar c g, c b, Newtype a b, Eq a) => FieldName -> (a -> b) -> ALens' s a -> a -> g s a
freeTextField :: FieldGrammar c g => FieldName -> ALens' s (Maybe String) -> g s (Maybe String)
freeTextFieldDef :: FieldGrammar c g => FieldName -> ALens' s String -> g s String
freeTextFieldDefST :: FieldGrammar c g => FieldName -> ALens' s ShortText -> g s ShortText
-- | Monoidal field.
--
-- Values are combined with mappend.
--
-- Note: optionalFieldAla is a monoidalField with
-- Last monoid.
monoidalFieldAla :: (FieldGrammar c g, c b, Monoid a, Newtype a b) => FieldName -> (a -> b) -> ALens' s a -> g s a
-- | Parser matching all fields with a name starting with a prefix.
prefixedFields :: FieldGrammar c g => FieldName -> ALens' s [(String, String)] -> g s [(String, String)]
-- | Known field, which we don't parse, nor pretty print.
knownField :: FieldGrammar c g => FieldName -> g s ()
-- | Field which is parsed but not pretty printed.
hiddenField :: FieldGrammar c g => g s a -> g s a
-- | Deprecated since
deprecatedSince :: FieldGrammar c g => CabalSpecVersion -> String -> g s a -> g s a
-- | Removed in. If we encounter removed field, parsing fails.
removedIn :: FieldGrammar c g => CabalSpecVersion -> String -> g s a -> g s a
-- | Annotate field with since spec-version.
availableSince :: FieldGrammar c g => CabalSpecVersion -> a -> g s a -> g s a
-- | Annotate field with since spec-version. This is used to recognise, but
-- warn about the field. It is used to process other-extensions
-- field.
--
-- Default implementation is to not warn.
availableSinceWarn :: FieldGrammar c g => CabalSpecVersion -> g s a -> g s a
-- | Field which can be defined at most once.
uniqueField :: (FieldGrammar c g, c (Identity a)) => FieldName -> ALens' s a -> g s a
-- | Field which can be defined at most once.
optionalField :: (FieldGrammar c g, c (Identity a)) => FieldName -> ALens' s (Maybe a) -> g s (Maybe a)
-- | Optional field with default value.
optionalFieldDef :: (FieldGrammar c g, Functor (g s), c (Identity a), Eq a) => FieldName -> ALens' s a -> a -> g s a
-- | Field which can be define multiple times, and the results are
-- mappended.
monoidalField :: (FieldGrammar c g, c (Identity a), Monoid a) => FieldName -> ALens' s a -> g s a
-- | Default implementation for freeTextFieldDefST.
defaultFreeTextFieldDefST :: (Functor (g s), FieldGrammar c g) => FieldName -> ALens' s ShortText -> g s ShortText
module Distribution.FieldGrammar.Pretty
data PrettyFieldGrammar s a
-- | We can use PrettyFieldGrammar to pp print the s.
--
-- Note: there is not trailing ($+$ text "").
prettyFieldGrammar :: CabalSpecVersion -> PrettyFieldGrammar s a -> s -> [PrettyField ()]
instance GHC.Base.Functor (Distribution.FieldGrammar.Pretty.PrettyFieldGrammar s)
instance GHC.Base.Applicative (Distribution.FieldGrammar.Pretty.PrettyFieldGrammar s)
instance Distribution.FieldGrammar.Class.FieldGrammar Distribution.Pretty.Pretty Distribution.FieldGrammar.Pretty.PrettyFieldGrammar
-- | This module provides a FieldGrammarParser, one way to parse
-- .cabal -like files.
--
-- Fields can be specified multiple times in the .cabal files. The order
-- of such entries is important, but the mutual ordering of different
-- fields is not.Also conditional sections are considered after
-- non-conditional data. The example of this silent-commutation quirk is
-- the fact that
--
--
-- buildable: True
-- if os(linux)
-- buildable: False
--
--
-- and
--
--
-- if os(linux)
-- buildable: False
-- buildable: True
--
--
-- behave the same! This is the limitation of
-- GeneralPackageDescription structure.
--
-- So we transform the list of fields [Field ann] into a
-- map of grouped ordinary fields and a list of lists of sections:
-- Fields ann = Map FieldName
-- [NamelessField ann] and [[Section ann]].
--
-- We need list of list of sections, because we need to distinguish
-- situations where there are fields in between. For example
--
--
-- if flag(bytestring-lt-0_10_4)
-- build-depends: bytestring < 0.10.4
--
-- default-language: Haskell2020
--
-- else
-- build-depends: bytestring >= 0.10.4
--
--
-- is obviously invalid specification.
--
-- We can parse Fields like we parse aeson objects, yet
-- we use slightly higher-level API, so we can process unspecified
-- fields, to report unknown fields and save custom x-fields.
module Distribution.FieldGrammar.Parsec
data ParsecFieldGrammar s a
parseFieldGrammar :: CabalSpecVersion -> Fields Position -> ParsecFieldGrammar s a -> ParseResult a
fieldGrammarKnownFieldList :: ParsecFieldGrammar s a -> [FieldName]
type Fields ann = Map FieldName [NamelessField ann]
-- | Single field, without name, but with its annotation.
data NamelessField ann
MkNamelessField :: !ann -> [FieldLine ann] -> NamelessField ann
namelessFieldAnn :: NamelessField ann -> ann
-- | The Section constructor of Field.
data Section ann
MkSection :: !Name ann -> [SectionArg ann] -> [Field ann] -> Section ann
runFieldParser :: Position -> ParsecParser a -> CabalSpecVersion -> [FieldLine Position] -> ParseResult a
runFieldParser' :: [Position] -> ParsecParser a -> CabalSpecVersion -> FieldLineStream -> ParseResult a
fieldLinesToStream :: [FieldLine ann] -> FieldLineStream
instance GHC.Base.Functor Distribution.FieldGrammar.Parsec.NamelessField
instance GHC.Show.Show ann => GHC.Show.Show (Distribution.FieldGrammar.Parsec.NamelessField ann)
instance GHC.Classes.Eq ann => GHC.Classes.Eq (Distribution.FieldGrammar.Parsec.NamelessField ann)
instance GHC.Base.Functor Distribution.FieldGrammar.Parsec.Section
instance GHC.Show.Show ann => GHC.Show.Show (Distribution.FieldGrammar.Parsec.Section ann)
instance GHC.Classes.Eq ann => GHC.Classes.Eq (Distribution.FieldGrammar.Parsec.Section ann)
instance GHC.Base.Functor (Distribution.FieldGrammar.Parsec.ParsecFieldGrammar s)
instance GHC.Base.Applicative (Distribution.FieldGrammar.Parsec.ParsecFieldGrammar s)
instance Distribution.FieldGrammar.Class.FieldGrammar Distribution.Parsec.Parsec Distribution.FieldGrammar.Parsec.ParsecFieldGrammar
-- | This module provides a way to specify a grammar of .cabal
-- -like files.
module Distribution.FieldGrammar
-- | FieldGrammar is parametrised by
--
--
-- - s which is a structure we are parsing. We need this to
-- provide prettyprinter functionality
-- - a type of the field.
--
--
-- Note: We'd like to have forall s. Applicative (f s)
-- context.
class (c SpecVersion, c TestedWith, c SpecLicense, c Token, c Token', c FilePathNT) => FieldGrammar c g | g -> c
-- | Unfocus, zoom out, blur FieldGrammar.
blurFieldGrammar :: FieldGrammar c g => ALens' a b -> g b d -> g a d
-- | Field which should be defined, exactly once.
uniqueFieldAla :: (FieldGrammar c g, c b, Newtype a b) => FieldName -> (a -> b) -> ALens' s a -> g s a
-- | Boolean field with a default value.
booleanFieldDef :: FieldGrammar c g => FieldName -> ALens' s Bool -> Bool -> g s Bool
-- | Optional field.
optionalFieldAla :: (FieldGrammar c g, c b, Newtype a b) => FieldName -> (a -> b) -> ALens' s (Maybe a) -> g s (Maybe a)
-- | Optional field with default value.
optionalFieldDefAla :: (FieldGrammar c g, c b, Newtype a b, Eq a) => FieldName -> (a -> b) -> ALens' s a -> a -> g s a
freeTextField :: FieldGrammar c g => FieldName -> ALens' s (Maybe String) -> g s (Maybe String)
freeTextFieldDef :: FieldGrammar c g => FieldName -> ALens' s String -> g s String
freeTextFieldDefST :: FieldGrammar c g => FieldName -> ALens' s ShortText -> g s ShortText
-- | Monoidal field.
--
-- Values are combined with mappend.
--
-- Note: optionalFieldAla is a monoidalField with
-- Last monoid.
monoidalFieldAla :: (FieldGrammar c g, c b, Monoid a, Newtype a b) => FieldName -> (a -> b) -> ALens' s a -> g s a
-- | Parser matching all fields with a name starting with a prefix.
prefixedFields :: FieldGrammar c g => FieldName -> ALens' s [(String, String)] -> g s [(String, String)]
-- | Known field, which we don't parse, nor pretty print.
knownField :: FieldGrammar c g => FieldName -> g s ()
-- | Field which is parsed but not pretty printed.
hiddenField :: FieldGrammar c g => g s a -> g s a
-- | Deprecated since
deprecatedSince :: FieldGrammar c g => CabalSpecVersion -> String -> g s a -> g s a
-- | Removed in. If we encounter removed field, parsing fails.
removedIn :: FieldGrammar c g => CabalSpecVersion -> String -> g s a -> g s a
-- | Annotate field with since spec-version.
availableSince :: FieldGrammar c g => CabalSpecVersion -> a -> g s a -> g s a
-- | Annotate field with since spec-version. This is used to recognise, but
-- warn about the field. It is used to process other-extensions
-- field.
--
-- Default implementation is to not warn.
availableSinceWarn :: FieldGrammar c g => CabalSpecVersion -> g s a -> g s a
-- | Field which can be defined at most once.
uniqueField :: (FieldGrammar c g, c (Identity a)) => FieldName -> ALens' s a -> g s a
-- | Field which can be defined at most once.
optionalField :: (FieldGrammar c g, c (Identity a)) => FieldName -> ALens' s (Maybe a) -> g s (Maybe a)
-- | Optional field with default value.
optionalFieldDef :: (FieldGrammar c g, Functor (g s), c (Identity a), Eq a) => FieldName -> ALens' s a -> a -> g s a
-- | Field which can be define multiple times, and the results are
-- mappended.
monoidalField :: (FieldGrammar c g, c (Identity a), Monoid a) => FieldName -> ALens' s a -> g s a
data ParsecFieldGrammar s a
type ParsecFieldGrammar' a = ParsecFieldGrammar a a
parseFieldGrammar :: CabalSpecVersion -> Fields Position -> ParsecFieldGrammar s a -> ParseResult a
fieldGrammarKnownFieldList :: ParsecFieldGrammar s a -> [FieldName]
data PrettyFieldGrammar s a
type PrettyFieldGrammar' a = PrettyFieldGrammar a a
-- | We can use PrettyFieldGrammar to pp print the s.
--
-- Note: there is not trailing ($+$ text "").
prettyFieldGrammar :: CabalSpecVersion -> PrettyFieldGrammar s a -> s -> [PrettyField ()]
-- | Reverse function application which binds tighter than <$>
-- and <*>. Useful for refining grammar specification.
--
--
-- <*> monoidalFieldAla "extensions" (alaList' FSep MQuoted) oldExtensions
-- ^^^ deprecatedSince [1,12] "Please use 'default-extensions' or 'other-extensions' fields."
--
(^^^) :: a -> (a -> b) -> b
infixl 5 ^^^
-- | The Section constructor of Field.
data Section ann
MkSection :: !Name ann -> [SectionArg ann] -> [Field ann] -> Section ann
type Fields ann = Map FieldName [NamelessField ann]
-- | Partition field list into field map and groups of sections.
partitionFields :: [Field ann] -> (Fields ann, [[Section ann]])
-- | Take all fields from the front.
takeFields :: [Field ann] -> (Fields ann, [Field ann])
runFieldParser :: Position -> ParsecParser a -> CabalSpecVersion -> [FieldLine Position] -> ParseResult a
runFieldParser' :: [Position] -> ParsecParser a -> CabalSpecVersion -> FieldLineStream -> ParseResult a
-- | Default implementation for freeTextFieldDefST.
defaultFreeTextFieldDefST :: (Functor (g s), FieldGrammar c g) => FieldName -> ALens' s ShortText -> g s ShortText
-- | GenericPackageDescription Field descriptions
module Distribution.PackageDescription.FieldGrammar
packageDescriptionFieldGrammar :: (FieldGrammar c g, Applicative (g PackageDescription), Applicative (g PackageIdentifier), c (Identity BuildType), c (Identity PackageName), c (Identity Version), c (List FSep FilePathNT String), c (List FSep CompatFilePath String), c (List FSep (Identity (SymbolicPath PackageDir LicenseFile)) (SymbolicPath PackageDir LicenseFile)), c (List FSep TestedWith (CompilerFlavor, VersionRange)), c (List VCat FilePathNT String), c FilePathNT, c CompatLicenseFile, c CompatFilePath, c SpecLicense, c SpecVersion) => g PackageDescription PackageDescription
libraryFieldGrammar :: (FieldGrammar c g, Applicative (g Library), Applicative (g BuildInfo), c (Identity LibraryVisibility), c (List CommaFSep (Identity ExeDependency) ExeDependency), c (List CommaFSep (Identity LegacyExeDependency) LegacyExeDependency), c (List CommaFSep (Identity PkgconfigDependency) PkgconfigDependency), c (List CommaVCat (Identity Dependency) Dependency), c (List CommaVCat (Identity Mixin) Mixin), c (List CommaVCat (Identity ModuleReexport) ModuleReexport), c (List FSep (MQuoted Extension) Extension), c (List FSep (MQuoted Language) Language), c (List FSep FilePathNT String), c (List FSep Token String), c (List NoCommaFSep Token' String), c (List VCat (MQuoted ModuleName) ModuleName), c (List VCat FilePathNT String), c (List FSep (Identity (SymbolicPath PackageDir SourceDir)) (SymbolicPath PackageDir SourceDir)), c (List VCat Token String), c (MQuoted Language)) => LibraryName -> g Library Library
foreignLibFieldGrammar :: (FieldGrammar c g, Applicative (g ForeignLib), Applicative (g BuildInfo), c (Identity ForeignLibType), c (Identity LibVersionInfo), c (Identity Version), c (List CommaFSep (Identity ExeDependency) ExeDependency), c (List CommaFSep (Identity LegacyExeDependency) LegacyExeDependency), c (List CommaFSep (Identity PkgconfigDependency) PkgconfigDependency), c (List CommaVCat (Identity Dependency) Dependency), c (List CommaVCat (Identity Mixin) Mixin), c (List FSep (Identity ForeignLibOption) ForeignLibOption), c (List FSep (MQuoted Extension) Extension), c (List FSep (MQuoted Language) Language), c (List FSep FilePathNT String), c (List FSep Token String), c (List FSep (Identity (SymbolicPath PackageDir SourceDir)) (SymbolicPath PackageDir SourceDir)), c (List NoCommaFSep Token' String), c (List VCat (MQuoted ModuleName) ModuleName), c (List VCat FilePathNT String), c (List VCat Token String), c (MQuoted Language)) => UnqualComponentName -> g ForeignLib ForeignLib
executableFieldGrammar :: (FieldGrammar c g, Applicative (g Executable), Applicative (g BuildInfo), c (Identity ExecutableScope), c (List CommaFSep (Identity ExeDependency) ExeDependency), c (List CommaFSep (Identity LegacyExeDependency) LegacyExeDependency), c (List CommaFSep (Identity PkgconfigDependency) PkgconfigDependency), c (List CommaVCat (Identity Dependency) Dependency), c (List CommaVCat (Identity Mixin) Mixin), c (List FSep (MQuoted Extension) Extension), c (List FSep (MQuoted Language) Language), c (List FSep FilePathNT String), c (List FSep Token String), c (List FSep (Identity (SymbolicPath PackageDir SourceDir)) (SymbolicPath PackageDir SourceDir)), c (List NoCommaFSep Token' String), c (List VCat (MQuoted ModuleName) ModuleName), c (List VCat FilePathNT String), c (List VCat Token String), c (MQuoted Language)) => UnqualComponentName -> g Executable Executable
-- | An intermediate type just used for parsing the test-suite stanza.
-- After validation it is converted into the proper TestSuite
-- type.
data TestSuiteStanza
TestSuiteStanza :: Maybe TestType -> Maybe FilePath -> Maybe ModuleName -> BuildInfo -> TestSuiteStanza
[_testStanzaTestType] :: TestSuiteStanza -> Maybe TestType
[_testStanzaMainIs] :: TestSuiteStanza -> Maybe FilePath
[_testStanzaTestModule] :: TestSuiteStanza -> Maybe ModuleName
[_testStanzaBuildInfo] :: TestSuiteStanza -> BuildInfo
testSuiteFieldGrammar :: (FieldGrammar c g, Applicative (g TestSuiteStanza), Applicative (g BuildInfo), c (Identity ModuleName), c (Identity TestType), c (List CommaFSep (Identity ExeDependency) ExeDependency), c (List CommaFSep (Identity LegacyExeDependency) LegacyExeDependency), c (List CommaFSep (Identity PkgconfigDependency) PkgconfigDependency), c (List CommaVCat (Identity Dependency) Dependency), c (List CommaVCat (Identity Mixin) Mixin), c (List FSep (MQuoted Extension) Extension), c (List FSep (MQuoted Language) Language), c (List FSep FilePathNT String), c (List FSep Token String), c (List NoCommaFSep Token' String), c (List VCat (MQuoted ModuleName) ModuleName), c (List VCat FilePathNT String), c (List FSep (Identity (SymbolicPath PackageDir SourceDir)) (SymbolicPath PackageDir SourceDir)), c (List VCat Token String), c (MQuoted Language)) => g TestSuiteStanza TestSuiteStanza
validateTestSuite :: Position -> TestSuiteStanza -> ParseResult TestSuite
unvalidateTestSuite :: TestSuite -> TestSuiteStanza
testStanzaTestType :: Lens' TestSuiteStanza (Maybe TestType)
testStanzaMainIs :: Lens' TestSuiteStanza (Maybe FilePath)
testStanzaTestModule :: Lens' TestSuiteStanza (Maybe ModuleName)
testStanzaBuildInfo :: Lens' TestSuiteStanza BuildInfo
-- | An intermediate type just used for parsing the benchmark stanza. After
-- validation it is converted into the proper Benchmark type.
data BenchmarkStanza
BenchmarkStanza :: Maybe BenchmarkType -> Maybe FilePath -> Maybe ModuleName -> BuildInfo -> BenchmarkStanza
[_benchmarkStanzaBenchmarkType] :: BenchmarkStanza -> Maybe BenchmarkType
[_benchmarkStanzaMainIs] :: BenchmarkStanza -> Maybe FilePath
[_benchmarkStanzaBenchmarkModule] :: BenchmarkStanza -> Maybe ModuleName
[_benchmarkStanzaBuildInfo] :: BenchmarkStanza -> BuildInfo
benchmarkFieldGrammar :: (FieldGrammar c g, Applicative (g BenchmarkStanza), Applicative (g BuildInfo), c (Identity BenchmarkType), c (Identity ModuleName), c (List CommaFSep (Identity ExeDependency) ExeDependency), c (List CommaFSep (Identity LegacyExeDependency) LegacyExeDependency), c (List CommaFSep (Identity PkgconfigDependency) PkgconfigDependency), c (List CommaVCat (Identity Dependency) Dependency), c (List CommaVCat (Identity Mixin) Mixin), c (List FSep (MQuoted Extension) Extension), c (List FSep (MQuoted Language) Language), c (List FSep FilePathNT String), c (List FSep Token String), c (List NoCommaFSep Token' String), c (List VCat (MQuoted ModuleName) ModuleName), c (List VCat FilePathNT String), c (List FSep (Identity (SymbolicPath PackageDir SourceDir)) (SymbolicPath PackageDir SourceDir)), c (List VCat Token String), c (MQuoted Language)) => g BenchmarkStanza BenchmarkStanza
validateBenchmark :: Position -> BenchmarkStanza -> ParseResult Benchmark
unvalidateBenchmark :: Benchmark -> BenchmarkStanza
formatDependencyList :: [Dependency] -> List CommaVCat (Identity Dependency) Dependency
formatExposedModules :: [ModuleName] -> List VCat (MQuoted ModuleName) ModuleName
formatExtraSourceFiles :: [FilePath] -> List VCat FilePathNT FilePath
formatHsSourceDirs :: [SymbolicPath PackageDir SourceDir] -> List FSep (Identity (SymbolicPath PackageDir SourceDir)) (SymbolicPath PackageDir SourceDir)
formatMixinList :: [Mixin] -> List CommaVCat (Identity Mixin) Mixin
formatOtherExtensions :: [Extension] -> List FSep (MQuoted Extension) Extension
formatOtherModules :: [ModuleName] -> List VCat (MQuoted ModuleName) ModuleName
benchmarkStanzaBenchmarkType :: Lens' BenchmarkStanza (Maybe BenchmarkType)
benchmarkStanzaMainIs :: Lens' BenchmarkStanza (Maybe FilePath)
benchmarkStanzaBenchmarkModule :: Lens' BenchmarkStanza (Maybe ModuleName)
benchmarkStanzaBuildInfo :: Lens' BenchmarkStanza BuildInfo
flagFieldGrammar :: (FieldGrammar c g, Applicative (g PackageFlag)) => FlagName -> g PackageFlag PackageFlag
sourceRepoFieldGrammar :: (FieldGrammar c g, Applicative (g SourceRepo), c (Identity RepoType), c Token, c FilePathNT) => RepoKind -> g SourceRepo SourceRepo
setupBInfoFieldGrammar :: (FieldGrammar c g, Functor (g SetupBuildInfo), c (List CommaVCat (Identity Dependency) Dependency)) => Bool -> g SetupBuildInfo SetupBuildInfo
buildInfoFieldGrammar :: (FieldGrammar c g, Applicative (g BuildInfo), c (List CommaFSep (Identity ExeDependency) ExeDependency), c (List CommaFSep (Identity LegacyExeDependency) LegacyExeDependency), c (List CommaFSep (Identity PkgconfigDependency) PkgconfigDependency), c (List CommaVCat (Identity Dependency) Dependency), c (List CommaVCat (Identity Mixin) Mixin), c (List FSep (MQuoted Extension) Extension), c (List FSep (MQuoted Language) Language), c (List FSep FilePathNT String), c (List FSep Token String), c (List NoCommaFSep Token' String), c (List VCat (MQuoted ModuleName) ModuleName), c (List VCat FilePathNT String), c (List FSep (Identity (SymbolicPath PackageDir SourceDir)) (SymbolicPath PackageDir SourceDir)), c (List VCat Token String), c (MQuoted Language)) => g BuildInfo BuildInfo
instance Distribution.Compat.Newtype.Newtype [Distribution.Utils.Path.SymbolicPath Distribution.Utils.Path.PackageDir Distribution.Utils.Path.LicenseFile] Distribution.PackageDescription.FieldGrammar.CompatLicenseFile
instance Distribution.Parsec.Parsec Distribution.PackageDescription.FieldGrammar.CompatLicenseFile
instance Distribution.Pretty.Pretty Distribution.PackageDescription.FieldGrammar.CompatLicenseFile
instance Distribution.Compat.Newtype.Newtype GHC.Base.String Distribution.PackageDescription.FieldGrammar.CompatFilePath
instance Distribution.Parsec.Parsec Distribution.PackageDescription.FieldGrammar.CompatFilePath
instance Distribution.Pretty.Pretty Distribution.PackageDescription.FieldGrammar.CompatFilePath
instance Distribution.Types.BuildInfo.Lens.HasBuildInfo Distribution.PackageDescription.FieldGrammar.BenchmarkStanza
instance Distribution.Types.BuildInfo.Lens.HasBuildInfo Distribution.PackageDescription.FieldGrammar.TestSuiteStanza
-- | Pretty printing for cabal files
module Distribution.PackageDescription.PrettyPrint
-- | Writes a .cabal file from a generic package description
writeGenericPackageDescription :: FilePath -> GenericPackageDescription -> IO ()
-- | Writes a generic package description to a string
showGenericPackageDescription :: GenericPackageDescription -> String
-- | Convert a generic package description to PrettyFields.
ppGenericPackageDescription :: CabalSpecVersion -> GenericPackageDescription -> [PrettyField ()]
writePackageDescription :: FilePath -> PackageDescription -> IO ()
showPackageDescription :: PackageDescription -> String
writeHookedBuildInfo :: FilePath -> HookedBuildInfo -> IO ()
showHookedBuildInfo :: HookedBuildInfo -> String
-- | This defined parsers and partial pretty printers for the
-- .cabal format.
module Distribution.PackageDescription.Parsec
-- | Parse the given package file.
readGenericPackageDescription :: Verbosity -> FilePath -> IO GenericPackageDescription
-- | Parses the given file into a GenericPackageDescription.
--
-- In Cabal 1.2 the syntax for package descriptions was changed to a
-- format with sections and possibly indented property descriptions.
parseGenericPackageDescription :: ByteString -> ParseResult GenericPackageDescription
-- | Maybe variant of parseGenericPackageDescription
parseGenericPackageDescriptionMaybe :: ByteString -> Maybe GenericPackageDescription
-- | A monad with failure and accumulating errors and warnings.
data ParseResult a
-- | Destruct a ParseResult into the emitted warnings and either a
-- successful value or list of errors and possibly recovered a
-- spec-version declaration.
runParseResult :: ParseResult a -> ([PWarning], Either (Maybe Version, NonEmpty PError) a)
-- | Quickly scan new-style spec-version
--
-- A new-style spec-version declaration begins the .cabal file and follow
-- the following case-insensitive grammar (expressed in RFC5234 ABNF):
--
--
-- newstyle-spec-version-decl = "cabal-version" *WS ":" *WS newstyle-pec-version *WS
--
-- spec-version = NUM "." NUM [ "." NUM ]
--
-- NUM = DIGIT0 / DIGITP 1*DIGIT0
-- DIGIT0 = %x30-39
-- DIGITP = %x31-39
-- WS = %20
--
scanSpecVersion :: ByteString -> Maybe Version
readHookedBuildInfo :: Verbosity -> FilePath -> IO HookedBuildInfo
parseHookedBuildInfo :: ByteString -> ParseResult HookedBuildInfo
instance GHC.Show.Show Distribution.PackageDescription.Parsec.Syntax
instance GHC.Classes.Eq Distribution.PackageDescription.Parsec.Syntax
instance Distribution.PackageDescription.Parsec.FromBuildInfo Distribution.Types.BuildInfo.BuildInfo
instance Distribution.PackageDescription.Parsec.FromBuildInfo Distribution.Types.ForeignLib.ForeignLib
instance Distribution.PackageDescription.Parsec.FromBuildInfo Distribution.Types.Executable.Executable
instance Distribution.PackageDescription.Parsec.FromBuildInfo Distribution.PackageDescription.FieldGrammar.TestSuiteStanza
instance Distribution.PackageDescription.Parsec.FromBuildInfo Distribution.PackageDescription.FieldGrammar.BenchmarkStanza
module Distribution.FieldGrammar.FieldDescrs
-- | A collection of field parsers and pretty-printers.
data FieldDescrs s a
-- | Lookup a field value pretty-printer.
fieldDescrPretty :: FieldDescrs s a -> FieldName -> Maybe (s -> Doc)
-- | Lookup a field value parser.
fieldDescrParse :: CabalParsing m => FieldDescrs s a -> FieldName -> Maybe (s -> m s)
fieldDescrsToList :: CabalParsing m => FieldDescrs s a -> [(FieldName, s -> Doc, s -> m s)]
instance GHC.Base.Functor (Distribution.FieldGrammar.FieldDescrs.FieldDescrs s)
instance Distribution.FieldGrammar.Class.FieldGrammar Distribution.FieldGrammar.FieldDescrs.ParsecPretty Distribution.FieldGrammar.FieldDescrs.FieldDescrs
instance (Distribution.Parsec.Parsec a, Distribution.Pretty.Pretty a) => Distribution.FieldGrammar.FieldDescrs.ParsecPretty a
instance GHC.Base.Applicative (Distribution.FieldGrammar.FieldDescrs.FieldDescrs s)
module Distribution.Types.InstalledPackageInfo.FieldGrammar
ipiFieldGrammar :: (FieldGrammar c g, Applicative (g InstalledPackageInfo), Applicative (g Basic), c (Identity AbiHash), c (Identity LibraryVisibility), c (Identity PackageName), c (Identity UnitId), c (Identity UnqualComponentName), c (List FSep (Identity AbiDependency) AbiDependency), c (List FSep (Identity UnitId) UnitId), c (List FSep (MQuoted ModuleName) ModuleName), c (List FSep FilePathNT String), c (List FSep Token String), c (MQuoted MungedPackageName), c (MQuoted Version), c CompatPackageKey, c ExposedModules, c InstWith, c SpecLicenseLenient) => g InstalledPackageInfo InstalledPackageInfo
instance Distribution.Compat.Newtype.Newtype (Data.Either.Either Distribution.SPDX.License.License Distribution.License.License) Distribution.Types.InstalledPackageInfo.FieldGrammar.SpecLicenseLenient
instance Distribution.Parsec.Parsec Distribution.Types.InstalledPackageInfo.FieldGrammar.SpecLicenseLenient
instance Distribution.Pretty.Pretty Distribution.Types.InstalledPackageInfo.FieldGrammar.SpecLicenseLenient
instance Distribution.Compat.Newtype.Newtype [(Distribution.ModuleName.ModuleName, Distribution.Backpack.OpenModule)] Distribution.Types.InstalledPackageInfo.FieldGrammar.InstWith
instance Distribution.Pretty.Pretty Distribution.Types.InstalledPackageInfo.FieldGrammar.InstWith
instance Distribution.Parsec.Parsec Distribution.Types.InstalledPackageInfo.FieldGrammar.InstWith
instance Distribution.Compat.Newtype.Newtype GHC.Base.String Distribution.Types.InstalledPackageInfo.FieldGrammar.CompatPackageKey
instance Distribution.Pretty.Pretty Distribution.Types.InstalledPackageInfo.FieldGrammar.CompatPackageKey
instance Distribution.Parsec.Parsec Distribution.Types.InstalledPackageInfo.FieldGrammar.CompatPackageKey
instance Distribution.Compat.Newtype.Newtype [Distribution.Types.ExposedModule.ExposedModule] Distribution.Types.InstalledPackageInfo.FieldGrammar.ExposedModules
instance Distribution.Parsec.Parsec Distribution.Types.InstalledPackageInfo.FieldGrammar.ExposedModules
instance Distribution.Pretty.Pretty Distribution.Types.InstalledPackageInfo.FieldGrammar.ExposedModules
-- | This is the information about an installed package that is
-- communicated to the ghc-pkg program in order to register a
-- package. ghc-pkg now consumes this package format (as of
-- version 6.4). This is specific to GHC at the moment.
--
-- The .cabal file format is for describing a package that is
-- not yet installed. It has a lot of flexibility, like conditionals and
-- dependency ranges. As such, that format is not at all suitable for
-- describing a package that has already been built and installed. By the
-- time we get to that stage, we have resolved all conditionals and
-- resolved dependency version constraints to exact versions of dependent
-- packages. So, this module defines the InstalledPackageInfo data
-- structure that contains all the info we keep about an installed
-- package. There is a parser and pretty printer. The textual format is
-- rather simpler than the .cabal format: there are no sections,
-- for example.
module Distribution.InstalledPackageInfo
data InstalledPackageInfo
InstalledPackageInfo :: PackageId -> LibraryName -> ComponentId -> LibraryVisibility -> UnitId -> [(ModuleName, OpenModule)] -> String -> Either License License -> !ShortText -> !ShortText -> !ShortText -> !ShortText -> !ShortText -> !ShortText -> !ShortText -> !ShortText -> !ShortText -> AbiHash -> Bool -> Bool -> [ExposedModule] -> [ModuleName] -> Bool -> [FilePath] -> [FilePath] -> [FilePath] -> FilePath -> [String] -> [String] -> [String] -> [FilePath] -> [String] -> [UnitId] -> [AbiDependency] -> [String] -> [String] -> [String] -> [FilePath] -> [String] -> [FilePath] -> [FilePath] -> Maybe FilePath -> InstalledPackageInfo
[sourcePackageId] :: InstalledPackageInfo -> PackageId
[sourceLibName] :: InstalledPackageInfo -> LibraryName
[installedComponentId_] :: InstalledPackageInfo -> ComponentId
[libVisibility] :: InstalledPackageInfo -> LibraryVisibility
[installedUnitId] :: InstalledPackageInfo -> UnitId
[instantiatedWith] :: InstalledPackageInfo -> [(ModuleName, OpenModule)]
[compatPackageKey] :: InstalledPackageInfo -> String
[license] :: InstalledPackageInfo -> Either License License
[copyright] :: InstalledPackageInfo -> !ShortText
[maintainer] :: InstalledPackageInfo -> !ShortText
[author] :: InstalledPackageInfo -> !ShortText
[stability] :: InstalledPackageInfo -> !ShortText
[homepage] :: InstalledPackageInfo -> !ShortText
[pkgUrl] :: InstalledPackageInfo -> !ShortText
[synopsis] :: InstalledPackageInfo -> !ShortText
[description] :: InstalledPackageInfo -> !ShortText
[category] :: InstalledPackageInfo -> !ShortText
[abiHash] :: InstalledPackageInfo -> AbiHash
[indefinite] :: InstalledPackageInfo -> Bool
[exposed] :: InstalledPackageInfo -> Bool
[exposedModules] :: InstalledPackageInfo -> [ExposedModule]
[hiddenModules] :: InstalledPackageInfo -> [ModuleName]
[trusted] :: InstalledPackageInfo -> Bool
[importDirs] :: InstalledPackageInfo -> [FilePath]
[libraryDirs] :: InstalledPackageInfo -> [FilePath]
-- | overrides libraryDirs
[libraryDynDirs] :: InstalledPackageInfo -> [FilePath]
[dataDir] :: InstalledPackageInfo -> FilePath
[hsLibraries] :: InstalledPackageInfo -> [String]
[extraLibraries] :: InstalledPackageInfo -> [String]
[extraGHCiLibraries] :: InstalledPackageInfo -> [String]
[includeDirs] :: InstalledPackageInfo -> [FilePath]
[includes] :: InstalledPackageInfo -> [String]
[depends] :: InstalledPackageInfo -> [UnitId]
[abiDepends] :: InstalledPackageInfo -> [AbiDependency]
[ccOptions] :: InstalledPackageInfo -> [String]
[cxxOptions] :: InstalledPackageInfo -> [String]
[ldOptions] :: InstalledPackageInfo -> [String]
[frameworkDirs] :: InstalledPackageInfo -> [FilePath]
[frameworks] :: InstalledPackageInfo -> [String]
[haddockInterfaces] :: InstalledPackageInfo -> [FilePath]
[haddockHTMLs] :: InstalledPackageInfo -> [FilePath]
[pkgRoot] :: InstalledPackageInfo -> Maybe FilePath
installedComponentId :: InstalledPackageInfo -> ComponentId
-- | Get the indefinite unit identity representing this package. This IS
-- NOT guaranteed to give you a substitution; for instantiated packages
-- you will get DefiniteUnitId (installedUnitId ipi). For
-- indefinite libraries, however, you will correctly get an
-- OpenUnitId with the appropriate OpenModuleSubst.
installedOpenUnitId :: InstalledPackageInfo -> OpenUnitId
sourceComponentName :: InstalledPackageInfo -> ComponentName
-- | Returns the set of module names which need to be filled for an
-- indefinite package, or the empty set if the package is definite.
requiredSignatures :: InstalledPackageInfo -> Set ModuleName
data ExposedModule
ExposedModule :: ModuleName -> Maybe OpenModule -> ExposedModule
[exposedName] :: ExposedModule -> ModuleName
[exposedReexport] :: ExposedModule -> Maybe OpenModule
-- | An ABI dependency is a dependency on a library which also records the
-- ABI hash (abiHash) of the library it depends on.
--
-- The primary utility of this is to enable an extra sanity when GHC
-- loads libraries: it can check if the dependency has a matching ABI and
-- if not, refuse to load this library. This information is critical if
-- we are shadowing libraries; differences in the ABI hash let us know
-- what packages get shadowed by the new version of a package.
data AbiDependency
AbiDependency :: UnitId -> AbiHash -> AbiDependency
[depUnitId] :: AbiDependency -> UnitId
[depAbiHash] :: AbiDependency -> AbiHash
emptyInstalledPackageInfo :: InstalledPackageInfo
-- | Return either errors, or IPI with list of warnings
parseInstalledPackageInfo :: ByteString -> Either (NonEmpty String) ([String], InstalledPackageInfo)
-- | Pretty print InstalledPackageInfo.
--
-- pkgRoot isn't printed, as ghc-pkg prints it manually (as
-- GHC-8.4).
showInstalledPackageInfo :: InstalledPackageInfo -> String
-- | The variant of showInstalledPackageInfo which outputs
-- pkgroot field too.
showFullInstalledPackageInfo :: InstalledPackageInfo -> String
-- |
-- >>> let ipi = emptyInstalledPackageInfo { maintainer = "Tester" }
--
-- >>> fmap ($ ipi) $ showInstalledPackageInfoField "maintainer"
-- Just "maintainer: Tester"
--
showInstalledPackageInfoField :: String -> Maybe (InstalledPackageInfo -> String)
showSimpleInstalledPackageInfoField :: String -> Maybe (InstalledPackageInfo -> String)
module Distribution.Types.ComponentLocalBuildInfo
-- | The first five fields are common across all algebraic variants.
data ComponentLocalBuildInfo
LibComponentLocalBuildInfo :: ComponentName -> ComponentId -> UnitId -> Bool -> [(ModuleName, OpenModule)] -> [(UnitId, MungedPackageId)] -> [(OpenUnitId, ModuleRenaming)] -> [UnitId] -> [UnitId] -> String -> MungedPackageName -> [ExposedModule] -> Bool -> ComponentLocalBuildInfo
-- | It would be very convenient to store the literal Library here, but if
-- we do that, it will get serialized (via the Binary) instance twice. So
-- instead we just provide the ComponentName, which can be used to find
-- the Component in the PackageDescription. NB: eventually, this will NOT
-- uniquely identify the ComponentLocalBuildInfo.
[componentLocalName] :: ComponentLocalBuildInfo -> ComponentName
-- | The computed ComponentId of this component.
[componentComponentId] :: ComponentLocalBuildInfo -> ComponentId
-- | The computed UnitId which uniquely identifies this component.
-- Might be hashed.
[componentUnitId] :: ComponentLocalBuildInfo -> UnitId
-- | Is this an indefinite component (i.e. has unfilled holes)?
[componentIsIndefinite_] :: ComponentLocalBuildInfo -> Bool
-- | How the component was instantiated
[componentInstantiatedWith] :: ComponentLocalBuildInfo -> [(ModuleName, OpenModule)]
-- | Resolved internal and external package dependencies for this
-- component. The BuildInfo specifies a set of build
-- dependencies that must be satisfied in terms of version ranges. This
-- field fixes those dependencies to the specific versions available on
-- this machine for this compiler.
[componentPackageDeps] :: ComponentLocalBuildInfo -> [(UnitId, MungedPackageId)]
-- | The set of packages that are brought into scope during compilation,
-- including a ModuleRenaming which may used to hide or rename
-- modules. This is what gets translated into -package-id
-- arguments. This is a modernized version of
-- componentPackageDeps, which is kept around for BC purposes.
[componentIncludes] :: ComponentLocalBuildInfo -> [(OpenUnitId, ModuleRenaming)]
[componentExeDeps] :: ComponentLocalBuildInfo -> [UnitId]
-- | The internal dependencies which induce a graph on the
-- ComponentLocalBuildInfo of this package. This does NOT coincide
-- with componentPackageDeps because it ALSO records 'build-tool'
-- dependencies on executables. Maybe one day cabal-install will
-- also handle these correctly too!
[componentInternalDeps] :: ComponentLocalBuildInfo -> [UnitId]
-- | Compatibility "package key" that we pass to older versions of GHC.
[componentCompatPackageKey] :: ComponentLocalBuildInfo -> String
-- | Compatibility "package name" that we register this component as.
[componentCompatPackageName] :: ComponentLocalBuildInfo -> MungedPackageName
-- | A list of exposed modules (either defined in this component, or
-- reexported from another component.)
[componentExposedModules] :: ComponentLocalBuildInfo -> [ExposedModule]
-- | Convenience field, specifying whether or not this is the "public
-- library" that has the same name as the package.
[componentIsPublic] :: ComponentLocalBuildInfo -> Bool
FLibComponentLocalBuildInfo :: ComponentName -> ComponentId -> UnitId -> [(UnitId, MungedPackageId)] -> [(OpenUnitId, ModuleRenaming)] -> [UnitId] -> [UnitId] -> ComponentLocalBuildInfo
-- | It would be very convenient to store the literal Library here, but if
-- we do that, it will get serialized (via the Binary) instance twice. So
-- instead we just provide the ComponentName, which can be used to find
-- the Component in the PackageDescription. NB: eventually, this will NOT
-- uniquely identify the ComponentLocalBuildInfo.
[componentLocalName] :: ComponentLocalBuildInfo -> ComponentName
-- | The computed ComponentId of this component.
[componentComponentId] :: ComponentLocalBuildInfo -> ComponentId
-- | The computed UnitId which uniquely identifies this component.
-- Might be hashed.
[componentUnitId] :: ComponentLocalBuildInfo -> UnitId
-- | Resolved internal and external package dependencies for this
-- component. The BuildInfo specifies a set of build
-- dependencies that must be satisfied in terms of version ranges. This
-- field fixes those dependencies to the specific versions available on
-- this machine for this compiler.
[componentPackageDeps] :: ComponentLocalBuildInfo -> [(UnitId, MungedPackageId)]
-- | The set of packages that are brought into scope during compilation,
-- including a ModuleRenaming which may used to hide or rename
-- modules. This is what gets translated into -package-id
-- arguments. This is a modernized version of
-- componentPackageDeps, which is kept around for BC purposes.
[componentIncludes] :: ComponentLocalBuildInfo -> [(OpenUnitId, ModuleRenaming)]
[componentExeDeps] :: ComponentLocalBuildInfo -> [UnitId]
-- | The internal dependencies which induce a graph on the
-- ComponentLocalBuildInfo of this package. This does NOT coincide
-- with componentPackageDeps because it ALSO records 'build-tool'
-- dependencies on executables. Maybe one day cabal-install will
-- also handle these correctly too!
[componentInternalDeps] :: ComponentLocalBuildInfo -> [UnitId]
ExeComponentLocalBuildInfo :: ComponentName -> ComponentId -> UnitId -> [(UnitId, MungedPackageId)] -> [(OpenUnitId, ModuleRenaming)] -> [UnitId] -> [UnitId] -> ComponentLocalBuildInfo
-- | It would be very convenient to store the literal Library here, but if
-- we do that, it will get serialized (via the Binary) instance twice. So
-- instead we just provide the ComponentName, which can be used to find
-- the Component in the PackageDescription. NB: eventually, this will NOT
-- uniquely identify the ComponentLocalBuildInfo.
[componentLocalName] :: ComponentLocalBuildInfo -> ComponentName
-- | The computed ComponentId of this component.
[componentComponentId] :: ComponentLocalBuildInfo -> ComponentId
-- | The computed UnitId which uniquely identifies this component.
-- Might be hashed.
[componentUnitId] :: ComponentLocalBuildInfo -> UnitId
-- | Resolved internal and external package dependencies for this
-- component. The BuildInfo specifies a set of build
-- dependencies that must be satisfied in terms of version ranges. This
-- field fixes those dependencies to the specific versions available on
-- this machine for this compiler.
[componentPackageDeps] :: ComponentLocalBuildInfo -> [(UnitId, MungedPackageId)]
-- | The set of packages that are brought into scope during compilation,
-- including a ModuleRenaming which may used to hide or rename
-- modules. This is what gets translated into -package-id
-- arguments. This is a modernized version of
-- componentPackageDeps, which is kept around for BC purposes.
[componentIncludes] :: ComponentLocalBuildInfo -> [(OpenUnitId, ModuleRenaming)]
[componentExeDeps] :: ComponentLocalBuildInfo -> [UnitId]
-- | The internal dependencies which induce a graph on the
-- ComponentLocalBuildInfo of this package. This does NOT coincide
-- with componentPackageDeps because it ALSO records 'build-tool'
-- dependencies on executables. Maybe one day cabal-install will
-- also handle these correctly too!
[componentInternalDeps] :: ComponentLocalBuildInfo -> [UnitId]
TestComponentLocalBuildInfo :: ComponentName -> ComponentId -> UnitId -> [(UnitId, MungedPackageId)] -> [(OpenUnitId, ModuleRenaming)] -> [UnitId] -> [UnitId] -> ComponentLocalBuildInfo
-- | It would be very convenient to store the literal Library here, but if
-- we do that, it will get serialized (via the Binary) instance twice. So
-- instead we just provide the ComponentName, which can be used to find
-- the Component in the PackageDescription. NB: eventually, this will NOT
-- uniquely identify the ComponentLocalBuildInfo.
[componentLocalName] :: ComponentLocalBuildInfo -> ComponentName
-- | The computed ComponentId of this component.
[componentComponentId] :: ComponentLocalBuildInfo -> ComponentId
-- | The computed UnitId which uniquely identifies this component.
-- Might be hashed.
[componentUnitId] :: ComponentLocalBuildInfo -> UnitId
-- | Resolved internal and external package dependencies for this
-- component. The BuildInfo specifies a set of build
-- dependencies that must be satisfied in terms of version ranges. This
-- field fixes those dependencies to the specific versions available on
-- this machine for this compiler.
[componentPackageDeps] :: ComponentLocalBuildInfo -> [(UnitId, MungedPackageId)]
-- | The set of packages that are brought into scope during compilation,
-- including a ModuleRenaming which may used to hide or rename
-- modules. This is what gets translated into -package-id
-- arguments. This is a modernized version of
-- componentPackageDeps, which is kept around for BC purposes.
[componentIncludes] :: ComponentLocalBuildInfo -> [(OpenUnitId, ModuleRenaming)]
[componentExeDeps] :: ComponentLocalBuildInfo -> [UnitId]
-- | The internal dependencies which induce a graph on the
-- ComponentLocalBuildInfo of this package. This does NOT coincide
-- with componentPackageDeps because it ALSO records 'build-tool'
-- dependencies on executables. Maybe one day cabal-install will
-- also handle these correctly too!
[componentInternalDeps] :: ComponentLocalBuildInfo -> [UnitId]
BenchComponentLocalBuildInfo :: ComponentName -> ComponentId -> UnitId -> [(UnitId, MungedPackageId)] -> [(OpenUnitId, ModuleRenaming)] -> [UnitId] -> [UnitId] -> ComponentLocalBuildInfo
-- | It would be very convenient to store the literal Library here, but if
-- we do that, it will get serialized (via the Binary) instance twice. So
-- instead we just provide the ComponentName, which can be used to find
-- the Component in the PackageDescription. NB: eventually, this will NOT
-- uniquely identify the ComponentLocalBuildInfo.
[componentLocalName] :: ComponentLocalBuildInfo -> ComponentName
-- | The computed ComponentId of this component.
[componentComponentId] :: ComponentLocalBuildInfo -> ComponentId
-- | The computed UnitId which uniquely identifies this component.
-- Might be hashed.
[componentUnitId] :: ComponentLocalBuildInfo -> UnitId
-- | Resolved internal and external package dependencies for this
-- component. The BuildInfo specifies a set of build
-- dependencies that must be satisfied in terms of version ranges. This
-- field fixes those dependencies to the specific versions available on
-- this machine for this compiler.
[componentPackageDeps] :: ComponentLocalBuildInfo -> [(UnitId, MungedPackageId)]
-- | The set of packages that are brought into scope during compilation,
-- including a ModuleRenaming which may used to hide or rename
-- modules. This is what gets translated into -package-id
-- arguments. This is a modernized version of
-- componentPackageDeps, which is kept around for BC purposes.
[componentIncludes] :: ComponentLocalBuildInfo -> [(OpenUnitId, ModuleRenaming)]
[componentExeDeps] :: ComponentLocalBuildInfo -> [UnitId]
-- | The internal dependencies which induce a graph on the
-- ComponentLocalBuildInfo of this package. This does NOT coincide
-- with componentPackageDeps because it ALSO records 'build-tool'
-- dependencies on executables. Maybe one day cabal-install will
-- also handle these correctly too!
[componentInternalDeps] :: ComponentLocalBuildInfo -> [UnitId]
componentIsIndefinite :: ComponentLocalBuildInfo -> Bool
maybeComponentInstantiatedWith :: ComponentLocalBuildInfo -> Maybe [(ModuleName, OpenModule)]
instance GHC.Show.Show Distribution.Types.ComponentLocalBuildInfo.ComponentLocalBuildInfo
instance GHC.Read.Read Distribution.Types.ComponentLocalBuildInfo.ComponentLocalBuildInfo
instance GHC.Generics.Generic Distribution.Types.ComponentLocalBuildInfo.ComponentLocalBuildInfo
instance Data.Binary.Class.Binary Distribution.Types.ComponentLocalBuildInfo.ComponentLocalBuildInfo
instance Distribution.Utils.Structured.Structured Distribution.Types.ComponentLocalBuildInfo.ComponentLocalBuildInfo
instance Distribution.Compat.Graph.IsNode Distribution.Types.ComponentLocalBuildInfo.ComponentLocalBuildInfo
module Distribution.Types.TargetInfo
-- | The TargetInfo contains all the information necessary to build
-- a specific target (e.g., componentmodulefile) in a package. In
-- principle, one can get the Component from a
-- ComponentLocalBuildInfo and LocalBuildInfo, but it is
-- much more convenient to have the component in hand.
data TargetInfo
TargetInfo :: ComponentLocalBuildInfo -> Component -> TargetInfo
[targetCLBI] :: TargetInfo -> ComponentLocalBuildInfo
[targetComponent] :: TargetInfo -> Component
instance Distribution.Compat.Graph.IsNode Distribution.Types.TargetInfo.TargetInfo
-- | This module provides an library interface to the hc-pkg
-- program. Currently only GHC and GHCJS have hc-pkg programs.
module Distribution.Simple.Program.HcPkg
-- | Information about the features and capabilities of an hc-pkg
-- program.
data HcPkgInfo
HcPkgInfo :: ConfiguredProgram -> Bool -> Bool -> Bool -> Bool -> Bool -> Bool -> Bool -> Bool -> HcPkgInfo
[hcPkgProgram] :: HcPkgInfo -> ConfiguredProgram
-- | no package DB stack supported
[noPkgDbStack] :: HcPkgInfo -> Bool
-- | hc-pkg does not support verbosity flags
[noVerboseFlag] :: HcPkgInfo -> Bool
-- | use package-conf option instead of package-db
[flagPackageConf] :: HcPkgInfo -> Bool
-- | supports directory style package databases
[supportsDirDbs] :: HcPkgInfo -> Bool
-- | requires directory style package databases
[requiresDirDbs] :: HcPkgInfo -> Bool
-- | supports --enable-multi-instance flag
[nativeMultiInstance] :: HcPkgInfo -> Bool
-- | supports multi-instance via recache
[recacheMultiInstance] :: HcPkgInfo -> Bool
-- | supports --force-files or equivalent
[suppressFilesCheck] :: HcPkgInfo -> Bool
-- | Additional variations in the behaviour for register.
data RegisterOptions
RegisterOptions :: Bool -> Bool -> Bool -> RegisterOptions
-- | Allows re-registering / overwriting an existing package
[registerAllowOverwrite] :: RegisterOptions -> Bool
-- | Insist on the ability to register multiple instances of a single
-- version of a single package. This will fail if the hc-pkg
-- does not support it, see nativeMultiInstance and
-- recacheMultiInstance.
[registerMultiInstance] :: RegisterOptions -> Bool
-- | Require that no checks are performed on the existence of package files
-- mentioned in the registration info. This must be used if registering
-- prior to putting the files in their final place. This will fail if the
-- hc-pkg does not support it, see suppressFilesCheck.
[registerSuppressFilesCheck] :: RegisterOptions -> Bool
-- | Defaults are True, False and False
defaultRegisterOptions :: RegisterOptions
-- | Call hc-pkg to initialise a package database at the location
-- {path}.
--
--
-- hc-pkg init {path}
--
init :: HcPkgInfo -> Verbosity -> Bool -> FilePath -> IO ()
-- | Run hc-pkg using a given package DB stack, directly
-- forwarding the provided command-line arguments to it.
invoke :: HcPkgInfo -> Verbosity -> PackageDBStack -> [String] -> IO ()
-- | Call hc-pkg to register a package.
--
--
-- hc-pkg register {filename | -} [--user | --global | --package-db]
--
register :: HcPkgInfo -> Verbosity -> PackageDBStack -> InstalledPackageInfo -> RegisterOptions -> IO ()
-- | Call hc-pkg to unregister a package
--
--
-- hc-pkg unregister [pkgid] [--user | --global | --package-db]
--
unregister :: HcPkgInfo -> Verbosity -> PackageDB -> PackageId -> IO ()
-- | Call hc-pkg to recache the registered packages.
--
--
-- hc-pkg recache [--user | --global | --package-db]
--
recache :: HcPkgInfo -> Verbosity -> PackageDB -> IO ()
-- | Call hc-pkg to expose a package.
--
--
-- hc-pkg expose [pkgid] [--user | --global | --package-db]
--
expose :: HcPkgInfo -> Verbosity -> PackageDB -> PackageId -> IO ()
-- | Call hc-pkg to hide a package.
--
--
-- hc-pkg hide [pkgid] [--user | --global | --package-db]
--
hide :: HcPkgInfo -> Verbosity -> PackageDB -> PackageId -> IO ()
-- | Call hc-pkg to get all the details of all the packages in the
-- given package database.
dump :: HcPkgInfo -> Verbosity -> PackageDB -> IO [InstalledPackageInfo]
-- | Call hc-pkg to retrieve a specific package
--
--
-- hc-pkg describe [pkgid] [--user | --global | --package-db]
--
describe :: HcPkgInfo -> Verbosity -> PackageDBStack -> PackageId -> IO [InstalledPackageInfo]
-- | Call hc-pkg to get the source package Id of all the packages
-- in the given package database.
--
-- This is much less information than with dump, but also rather
-- quicker. Note in particular that it does not include the
-- UnitId, just the source PackageId which is not
-- necessarily unique in any package db.
list :: HcPkgInfo -> Verbosity -> PackageDB -> IO [PackageId]
initInvocation :: HcPkgInfo -> Verbosity -> FilePath -> ProgramInvocation
registerInvocation :: HcPkgInfo -> Verbosity -> PackageDBStack -> InstalledPackageInfo -> RegisterOptions -> ProgramInvocation
unregisterInvocation :: HcPkgInfo -> Verbosity -> PackageDB -> PackageId -> ProgramInvocation
recacheInvocation :: HcPkgInfo -> Verbosity -> PackageDB -> ProgramInvocation
exposeInvocation :: HcPkgInfo -> Verbosity -> PackageDB -> PackageId -> ProgramInvocation
hideInvocation :: HcPkgInfo -> Verbosity -> PackageDB -> PackageId -> ProgramInvocation
dumpInvocation :: HcPkgInfo -> Verbosity -> PackageDB -> ProgramInvocation
describeInvocation :: HcPkgInfo -> Verbosity -> PackageDBStack -> PackageId -> ProgramInvocation
listInvocation :: HcPkgInfo -> Verbosity -> PackageDB -> ProgramInvocation
-- | An index of packages whose primary key is UnitId. Public
-- libraries are additionally indexed by PackageName and
-- Version. Technically, these are an index of *units* (so we
-- should eventually rename it to UnitIndex); but in the absence
-- of internal libraries or Backpack each unit is equivalent to a
-- package.
--
-- While PackageIndex is parametric over what it actually records,
-- it is in fact only ever instantiated with a single element: The
-- InstalledPackageIndex (defined here) contains a graph of
-- InstalledPackageInfos representing the packages in a package
-- database stack. It is used in a variety of ways:
--
--
-- - The primary use to let Cabal access the same installed package
-- database which is used by GHC during compilation. For example, this
-- data structure is used by 'ghc-pkg' and Cabal to do
-- consistency checks on the database (are the references closed).
-- - Given a set of dependencies, we can compute the transitive closure
-- of dependencies. This is to check if the versions of packages are
-- consistent, and also needed by multiple tools (Haddock must be
-- explicitly told about the every transitive package to do cross-package
-- linking; preprocessors must know about the include paths of all
-- transitive dependencies.)
--
--
-- This PackageIndex is NOT to be confused with
-- PackageIndex, which indexes packages only by PackageName
-- (this makes it suitable for indexing source packages, for which we
-- don't know UnitIds.)
module Distribution.Simple.PackageIndex
-- | The default package index which contains
-- InstalledPackageInfo. Normally use this.
type InstalledPackageIndex = PackageIndex InstalledPackageInfo
-- | The collection of information about packages from one or more
-- PackageDBs. These packages generally should have an instance
-- of PackageInstalled
--
-- Packages are uniquely identified in by their UnitId, they can
-- also be efficiently looked up by package name or by name and version.
data PackageIndex a
-- | Build an index out of a bunch of packages.
--
-- If there are duplicates by UnitId then later ones mask earlier
-- ones.
fromList :: [InstalledPackageInfo] -> InstalledPackageIndex
-- | Merge two indexes.
--
-- Packages from the second mask packages from the first if they have the
-- exact same UnitId.
--
-- For packages with the same source PackageId, packages from the
-- second are "preferred" over those from the first. Being preferred
-- means they are top result when we do a lookup by source
-- PackageId. This is the mechanism we use to prefer user packages
-- over global packages.
merge :: InstalledPackageIndex -> InstalledPackageIndex -> InstalledPackageIndex
-- | Inserts a single package into the index.
--
-- This is equivalent to (but slightly quicker than) using mappend
-- or merge with a singleton index.
insert :: InstalledPackageInfo -> InstalledPackageIndex -> InstalledPackageIndex
-- | Removes a single installed package from the index.
deleteUnitId :: UnitId -> InstalledPackageIndex -> InstalledPackageIndex
-- | Removes all packages with this source PackageId from the index.
deleteSourcePackageId :: PackageId -> InstalledPackageIndex -> InstalledPackageIndex
-- | Removes all packages with this (case-sensitive) name from the index.
--
-- NB: Does NOT delete internal libraries from this package.
deletePackageName :: PackageName -> InstalledPackageIndex -> InstalledPackageIndex
-- | Does a lookup by unit identifier.
--
-- Since multiple package DBs mask each other by UnitId, then we
-- get back at most one package.
lookupUnitId :: PackageIndex a -> UnitId -> Maybe a
-- | Does a lookup by component identifier. In the absence of Backpack,
-- this is just a lookupUnitId.
lookupComponentId :: PackageIndex a -> ComponentId -> Maybe a
-- | Does a lookup by source package id (name & version).
--
-- There can be multiple installed packages with the same source
-- PackageId but different UnitId. They are returned in
-- order of preference, with the most preferred first.
lookupSourcePackageId :: PackageIndex a -> PackageId -> [a]
-- | Convenient alias of lookupSourcePackageId, but assuming only
-- one package per package ID.
lookupPackageId :: PackageIndex a -> PackageId -> Maybe a
-- | Does a lookup by source package name.
lookupPackageName :: PackageIndex a -> PackageName -> [(Version, [a])]
-- | Does a lookup by source package name and a range of versions.
--
-- We get back any number of versions of the specified package name, all
-- satisfying the version range constraint.
--
-- This does NOT work for internal dependencies, DO NOT use this function
-- on those; use lookupInternalDependency instead.
--
-- INVARIANT: List of eligible InstalledPackageInfo is non-empty.
lookupDependency :: InstalledPackageIndex -> PackageName -> VersionRange -> [(Version, [InstalledPackageInfo])]
-- | Does a lookup by source package name and a range of versions.
--
-- We get back any number of versions of the specified package name, all
-- satisfying the version range constraint.
--
-- INVARIANT: List of eligible InstalledPackageInfo is non-empty.
lookupInternalDependency :: InstalledPackageIndex -> PackageName -> VersionRange -> LibraryName -> [(Version, [InstalledPackageInfo])]
-- | Does a case-insensitive search by package name.
--
-- If there is only one package that compares case-insensitively to this
-- name then the search is unambiguous and we get back all versions of
-- that package. If several match case-insensitively but one matches
-- exactly then it is also unambiguous.
--
-- If however several match case-insensitively and none match exactly
-- then we have an ambiguous result, and we get back all the versions of
-- all the packages. The list of ambiguous results is split by exact
-- package name. So it is a non-empty list of non-empty lists.
searchByName :: PackageIndex a -> String -> SearchResult [a]
data SearchResult a
None :: SearchResult a
Unambiguous :: a -> SearchResult a
Ambiguous :: [a] -> SearchResult a
-- | Does a case-insensitive substring search by package name.
--
-- That is, all packages that contain the given string in their name.
searchByNameSubstring :: PackageIndex a -> String -> [a]
searchWithPredicate :: PackageIndex a -> (String -> Bool) -> [a]
-- | Get all the packages from the index.
allPackages :: PackageIndex a -> [a]
-- | Get all the packages from the index.
--
-- They are grouped by package name (case-sensitively).
--
-- (Doesn't include private libraries.)
allPackagesByName :: PackageIndex a -> [(PackageName, [a])]
-- | Get all the packages from the index.
--
-- They are grouped by source package id (package name and version).
--
-- (Doesn't include private libraries)
allPackagesBySourcePackageId :: HasUnitId a => PackageIndex a -> [(PackageId, [a])]
-- | Get all the packages from the index.
--
-- They are grouped by source package id and library name.
--
-- This DOES include internal libraries.
allPackagesBySourcePackageIdAndLibName :: HasUnitId a => PackageIndex a -> [((PackageId, LibraryName), [a])]
-- | All packages that have immediate dependencies that are not in the
-- index.
--
-- Returns such packages along with the dependencies that they're
-- missing.
brokenPackages :: PackageInstalled a => PackageIndex a -> [(a, [UnitId])]
-- | Tries to take the transitive closure of the package dependencies.
--
-- If the transitive closure is complete then it returns that subset of
-- the index. Otherwise it returns the broken packages as in
-- brokenPackages.
--
--
-- - Note that if the result is Right [] it is because at
-- least one of the original given PackageIds do not occur in the
-- index.
--
dependencyClosure :: InstalledPackageIndex -> [UnitId] -> Either InstalledPackageIndex [(InstalledPackageInfo, [UnitId])]
-- | Takes the transitive closure of the packages reverse dependencies.
--
--
-- - The given PackageIds must be in the index.
--
reverseDependencyClosure :: PackageInstalled a => PackageIndex a -> [UnitId] -> [a]
topologicalOrder :: PackageInstalled a => PackageIndex a -> [a]
reverseTopologicalOrder :: PackageInstalled a => PackageIndex a -> [a]
-- | Given a package index where we assume we want to use all the packages
-- (use dependencyClosure if you need to get such a index subset)
-- find out if the dependencies within it use consistent versions of each
-- package. Return all cases where multiple packages depend on different
-- versions of some other package.
--
-- Each element in the result is a package name along with the packages
-- that depend on it and the versions they require. These are guaranteed
-- to be distinct.
dependencyInconsistencies :: InstalledPackageIndex -> [(DepUniqueKey, [(UnitId, [InstalledPackageInfo])])]
-- | Find if there are any cycles in the dependency graph. If there are no
-- cycles the result is [].
--
-- This actually computes the strongly connected components. So it gives
-- us a list of groups of packages where within each group they all
-- depend on each other, directly or indirectly.
dependencyCycles :: PackageInstalled a => PackageIndex a -> [[a]]
-- | Builds a graph of the package dependencies.
--
-- Dependencies on other packages that are not in the index are
-- discarded. You can check if there are any such dependencies with
-- brokenPackages.
dependencyGraph :: PackageInstalled a => PackageIndex a -> (Graph, Vertex -> a, UnitId -> Maybe Vertex)
-- | A rough approximation of GHC's module finder, takes a
-- InstalledPackageIndex and turns it into a map from module names
-- to their source packages. It's used to initialize the
-- build-deps field in cabal init.
moduleNameIndex :: InstalledPackageIndex -> Map ModuleName [InstalledPackageInfo]
instance GHC.Read.Read a => GHC.Read.Read (Distribution.Simple.PackageIndex.PackageIndex a)
instance GHC.Show.Show a => GHC.Show.Show (Distribution.Simple.PackageIndex.PackageIndex a)
instance GHC.Generics.Generic (Distribution.Simple.PackageIndex.PackageIndex a)
instance GHC.Classes.Eq a => GHC.Classes.Eq (Distribution.Simple.PackageIndex.PackageIndex a)
instance Data.Binary.Class.Binary a => Data.Binary.Class.Binary (Distribution.Simple.PackageIndex.PackageIndex a)
instance Distribution.Utils.Structured.Structured a => Distribution.Utils.Structured.Structured (Distribution.Simple.PackageIndex.PackageIndex a)
instance GHC.Base.Monoid (Distribution.Simple.PackageIndex.PackageIndex Distribution.Types.InstalledPackageInfo.InstalledPackageInfo)
instance GHC.Base.Semigroup (Distribution.Simple.PackageIndex.PackageIndex Distribution.Types.InstalledPackageInfo.InstalledPackageInfo)
module Distribution.Types.LocalBuildInfo
-- | Data cached after configuration step. See also ConfigFlags.
data LocalBuildInfo
LocalBuildInfo :: ConfigFlags -> FlagAssignment -> ComponentRequestedSpec -> [String] -> InstallDirTemplates -> Compiler -> Platform -> FilePath -> Maybe FilePath -> Graph ComponentLocalBuildInfo -> Map ComponentName [ComponentLocalBuildInfo] -> InstalledPackageIndex -> Maybe FilePath -> PackageDescription -> ProgramDb -> PackageDBStack -> Bool -> Bool -> Bool -> Bool -> Bool -> Bool -> Bool -> ProfDetailLevel -> ProfDetailLevel -> OptimisationLevel -> DebugInfoLevel -> Bool -> Bool -> Bool -> Bool -> Bool -> Bool -> Bool -> PathTemplate -> PathTemplate -> Bool -> LocalBuildInfo
-- | Options passed to the configuration step. Needed to re-run
-- configuration when .cabal is out of date
[configFlags] :: LocalBuildInfo -> ConfigFlags
-- | The final set of flags which were picked for this package
[flagAssignment] :: LocalBuildInfo -> FlagAssignment
-- | What components were enabled during configuration, and why.
[componentEnabledSpec] :: LocalBuildInfo -> ComponentRequestedSpec
-- | Extra args on the command line for the configuration step. Needed to
-- re-run configuration when .cabal is out of date
[extraConfigArgs] :: LocalBuildInfo -> [String]
-- | The installation directories for the various different kinds of files
-- TODO: inplaceDirTemplates :: InstallDirs FilePath
[installDirTemplates] :: LocalBuildInfo -> InstallDirTemplates
-- | The compiler we're building with
[compiler] :: LocalBuildInfo -> Compiler
-- | The platform we're building for
[hostPlatform] :: LocalBuildInfo -> Platform
-- | Where to build the package.
[buildDir] :: LocalBuildInfo -> FilePath
-- | Path to the cabal file, if given during configuration.
[cabalFilePath] :: LocalBuildInfo -> Maybe FilePath
-- | All the components to build, ordered by topological sort, and with
-- their INTERNAL dependencies over the intrapackage dependency graph.
-- TODO: this is assumed to be short; otherwise we want some sort of
-- ordered map.
[componentGraph] :: LocalBuildInfo -> Graph ComponentLocalBuildInfo
-- | A map from component name to all matching components. These coincide
-- with componentGraph
[componentNameMap] :: LocalBuildInfo -> Map ComponentName [ComponentLocalBuildInfo]
-- | All the info about the installed packages that the current package
-- depends on (directly or indirectly). The copy saved on disk does NOT
-- include internal dependencies (because we just don't have enough
-- information at this point to have an InstalledPackageInfo for
-- an internal dep), but we will often update it with the internal
-- dependencies; see for example build. (This admonition doesn't
-- apply for per-component builds.)
[installedPkgs] :: LocalBuildInfo -> InstalledPackageIndex
-- | the filename containing the .cabal file, if available
[pkgDescrFile] :: LocalBuildInfo -> Maybe FilePath
-- | WARNING WARNING WARNING Be VERY careful about using this function; we
-- haven't deprecated it but using it could introduce subtle bugs related
-- to HookedBuildInfo.
--
-- In principle, this is supposed to contain the resolved package
-- description, that does not contain any conditionals. However, it MAY
-- NOT contain the description with a HookedBuildInfo applied to
-- it; see HookedBuildInfo for the whole sordid saga. As much as
-- possible, Cabal library should avoid using this parameter.
[localPkgDescr] :: LocalBuildInfo -> PackageDescription
-- | Location and args for all programs
[withPrograms] :: LocalBuildInfo -> ProgramDb
-- | What package database to use, global/user
[withPackageDB] :: LocalBuildInfo -> PackageDBStack
-- | Whether to build normal libs.
[withVanillaLib] :: LocalBuildInfo -> Bool
-- | Whether to build profiling versions of libs.
[withProfLib] :: LocalBuildInfo -> Bool
-- | Whether to build shared versions of libs.
[withSharedLib] :: LocalBuildInfo -> Bool
-- | Whether to build static versions of libs (with all other libs rolled
-- in)
[withStaticLib] :: LocalBuildInfo -> Bool
-- | Whether to link executables dynamically
[withDynExe] :: LocalBuildInfo -> Bool
-- | Whether to link executables fully statically
[withFullyStaticExe] :: LocalBuildInfo -> Bool
-- | Whether to build executables for profiling.
[withProfExe] :: LocalBuildInfo -> Bool
-- | Level of automatic profile detail.
[withProfLibDetail] :: LocalBuildInfo -> ProfDetailLevel
-- | Level of automatic profile detail.
[withProfExeDetail] :: LocalBuildInfo -> ProfDetailLevel
-- | Whether to build with optimization (if available).
[withOptimization] :: LocalBuildInfo -> OptimisationLevel
-- | Whether to emit debug info (if available).
[withDebugInfo] :: LocalBuildInfo -> DebugInfoLevel
-- | Whether to build libs suitable for use with GHCi.
[withGHCiLib] :: LocalBuildInfo -> Bool
-- | Use -split-sections with GHC, if available
[splitSections] :: LocalBuildInfo -> Bool
-- | Use -split-objs with GHC, if available
[splitObjs] :: LocalBuildInfo -> Bool
-- | Whether to strip executables during install
[stripExes] :: LocalBuildInfo -> Bool
-- | Whether to strip libraries during install
[stripLibs] :: LocalBuildInfo -> Bool
-- | Whether to enable executable program coverage
[exeCoverage] :: LocalBuildInfo -> Bool
-- | Whether to enable library program coverage
[libCoverage] :: LocalBuildInfo -> Bool
-- | Prefix to be prepended to installed executables
[progPrefix] :: LocalBuildInfo -> PathTemplate
-- | Suffix to be appended to installed executables
[progSuffix] :: LocalBuildInfo -> PathTemplate
[relocatable] :: LocalBuildInfo -> Bool
-- | Extract the ComponentId from the public library component of a
-- LocalBuildInfo if it exists, or make a fake component ID based
-- on the package ID.
localComponentId :: LocalBuildInfo -> ComponentId
-- | Extract the UnitId from the library component of a
-- LocalBuildInfo if it exists, or make a fake unit ID based on
-- the package ID.
localUnitId :: LocalBuildInfo -> UnitId
-- | Extract the compatibility package key from the public library
-- component of a LocalBuildInfo if it exists, or make a fake
-- package key based on the package ID.
localCompatPackageKey :: LocalBuildInfo -> String
-- | Extract the PackageIdentifier of a LocalBuildInfo. This
-- is a "safe" use of localPkgDescr
localPackage :: LocalBuildInfo -> PackageId
-- | Return all ComponentLocalBuildInfos associated with
-- ComponentName. In the presence of Backpack there may be more
-- than one!
componentNameCLBIs :: LocalBuildInfo -> ComponentName -> [ComponentLocalBuildInfo]
-- | Return all TargetInfos associated with ComponentName. In
-- the presence of Backpack there may be more than one! Has a prime
-- because it takes a PackageDescription argument which may
-- disagree with localPkgDescr in LocalBuildInfo.
componentNameTargets' :: PackageDescription -> LocalBuildInfo -> ComponentName -> [TargetInfo]
unitIdTarget' :: PackageDescription -> LocalBuildInfo -> UnitId -> Maybe TargetInfo
-- | Return the list of default TargetInfos associated with a
-- configured package, in the order they need to be built. Has a prime
-- because it takes a PackageDescription argument which may
-- disagree with localPkgDescr in LocalBuildInfo.
allTargetsInBuildOrder' :: PackageDescription -> LocalBuildInfo -> [TargetInfo]
-- | Execute f for every TargetInfo in the package,
-- respecting the build dependency order. (TODO: We should use Shake!)
-- Has a prime because it takes a PackageDescription argument
-- which may disagree with localPkgDescr in LocalBuildInfo.
withAllTargetsInBuildOrder' :: PackageDescription -> LocalBuildInfo -> (TargetInfo -> IO ()) -> IO ()
-- | Return the list of all targets needed to build the uids, in
-- the order they need to be built. Has a prime because it takes a
-- PackageDescription argument which may disagree with
-- localPkgDescr in LocalBuildInfo.
neededTargetsInBuildOrder' :: PackageDescription -> LocalBuildInfo -> [UnitId] -> [TargetInfo]
-- | Execute f for every TargetInfo needed to build
-- uids, respecting the build dependency order. Has a prime
-- because it takes a PackageDescription argument which may
-- disagree with localPkgDescr in LocalBuildInfo.
withNeededTargetsInBuildOrder' :: PackageDescription -> LocalBuildInfo -> [UnitId] -> (TargetInfo -> IO ()) -> IO ()
-- | Is coverage enabled for test suites? In practice, this requires
-- library and executable profiling to be enabled.
testCoverage :: LocalBuildInfo -> Bool
-- | Warning: By using this function, you may be introducing a bug where
-- you retrieve a Component which does not have
-- HookedBuildInfo applied to it. See the documentation for
-- HookedBuildInfo for an explanation of the issue. If you have a
-- PakcageDescription handy (NOT from the
-- LocalBuildInfo), try using the primed version of the function,
-- which takes it as an extra argument.
componentNameTargets :: LocalBuildInfo -> ComponentName -> [TargetInfo]
-- | Warning: By using this function, you may be introducing a bug where
-- you retrieve a Component which does not have
-- HookedBuildInfo applied to it. See the documentation for
-- HookedBuildInfo for an explanation of the issue. If you have a
-- PakcageDescription handy (NOT from the
-- LocalBuildInfo), try using the primed version of the function,
-- which takes it as an extra argument.
unitIdTarget :: LocalBuildInfo -> UnitId -> Maybe TargetInfo
-- | Warning: By using this function, you may be introducing a bug where
-- you retrieve a Component which does not have
-- HookedBuildInfo applied to it. See the documentation for
-- HookedBuildInfo for an explanation of the issue. If you have a
-- PakcageDescription handy (NOT from the
-- LocalBuildInfo), try using the primed version of the function,
-- which takes it as an extra argument.
allTargetsInBuildOrder :: LocalBuildInfo -> [TargetInfo]
-- | Warning: By using this function, you may be introducing a bug where
-- you retrieve a Component which does not have
-- HookedBuildInfo applied to it. See the documentation for
-- HookedBuildInfo for an explanation of the issue. If you have a
-- PakcageDescription handy (NOT from the
-- LocalBuildInfo), try using the primed version of the function,
-- which takes it as an extra argument.
withAllTargetsInBuildOrder :: LocalBuildInfo -> (TargetInfo -> IO ()) -> IO ()
-- | Warning: By using this function, you may be introducing a bug where
-- you retrieve a Component which does not have
-- HookedBuildInfo applied to it. See the documentation for
-- HookedBuildInfo for an explanation of the issue. If you have a
-- PakcageDescription handy (NOT from the
-- LocalBuildInfo), try using the primed version of the function,
-- which takes it as an extra argument.
neededTargetsInBuildOrder :: LocalBuildInfo -> [UnitId] -> [TargetInfo]
-- | Warning: By using this function, you may be introducing a bug where
-- you retrieve a Component which does not have
-- HookedBuildInfo applied to it. See the documentation for
-- HookedBuildInfo for an explanation of the issue. If you have a
-- PakcageDescription handy (NOT from the
-- LocalBuildInfo), try using the primed version of the function,
-- which takes it as an extra argument.
withNeededTargetsInBuildOrder :: LocalBuildInfo -> [UnitId] -> (TargetInfo -> IO ()) -> IO ()
instance GHC.Show.Show Distribution.Types.LocalBuildInfo.LocalBuildInfo
instance GHC.Read.Read Distribution.Types.LocalBuildInfo.LocalBuildInfo
instance GHC.Generics.Generic Distribution.Types.LocalBuildInfo.LocalBuildInfo
instance Data.Binary.Class.Binary Distribution.Types.LocalBuildInfo.LocalBuildInfo
instance Distribution.Utils.Structured.Structured Distribution.Types.LocalBuildInfo.LocalBuildInfo
-- | Once a package has been configured we have resolved conditionals and
-- dependencies, configured the compiler and other needed external
-- programs. The LocalBuildInfo is used to hold all this
-- information. It holds the install dirs, the compiler, the exact
-- package dependencies, the configured programs, the package database to
-- use and a bunch of miscellaneous configure flags. It gets saved and
-- reloaded from a file (dist/setup-config). It gets passed in
-- to very many subsequent build actions.
module Distribution.Simple.LocalBuildInfo
-- | Data cached after configuration step. See also ConfigFlags.
data LocalBuildInfo
LocalBuildInfo :: ConfigFlags -> FlagAssignment -> ComponentRequestedSpec -> [String] -> InstallDirTemplates -> Compiler -> Platform -> FilePath -> Maybe FilePath -> Graph ComponentLocalBuildInfo -> Map ComponentName [ComponentLocalBuildInfo] -> InstalledPackageIndex -> Maybe FilePath -> PackageDescription -> ProgramDb -> PackageDBStack -> Bool -> Bool -> Bool -> Bool -> Bool -> Bool -> Bool -> ProfDetailLevel -> ProfDetailLevel -> OptimisationLevel -> DebugInfoLevel -> Bool -> Bool -> Bool -> Bool -> Bool -> Bool -> Bool -> PathTemplate -> PathTemplate -> Bool -> LocalBuildInfo
-- | Options passed to the configuration step. Needed to re-run
-- configuration when .cabal is out of date
[configFlags] :: LocalBuildInfo -> ConfigFlags
-- | The final set of flags which were picked for this package
[flagAssignment] :: LocalBuildInfo -> FlagAssignment
-- | What components were enabled during configuration, and why.
[componentEnabledSpec] :: LocalBuildInfo -> ComponentRequestedSpec
-- | Extra args on the command line for the configuration step. Needed to
-- re-run configuration when .cabal is out of date
[extraConfigArgs] :: LocalBuildInfo -> [String]
-- | The installation directories for the various different kinds of files
-- TODO: inplaceDirTemplates :: InstallDirs FilePath
[installDirTemplates] :: LocalBuildInfo -> InstallDirTemplates
-- | The compiler we're building with
[compiler] :: LocalBuildInfo -> Compiler
-- | The platform we're building for
[hostPlatform] :: LocalBuildInfo -> Platform
-- | Where to build the package.
[buildDir] :: LocalBuildInfo -> FilePath
-- | Path to the cabal file, if given during configuration.
[cabalFilePath] :: LocalBuildInfo -> Maybe FilePath
-- | All the components to build, ordered by topological sort, and with
-- their INTERNAL dependencies over the intrapackage dependency graph.
-- TODO: this is assumed to be short; otherwise we want some sort of
-- ordered map.
[componentGraph] :: LocalBuildInfo -> Graph ComponentLocalBuildInfo
-- | A map from component name to all matching components. These coincide
-- with componentGraph
[componentNameMap] :: LocalBuildInfo -> Map ComponentName [ComponentLocalBuildInfo]
-- | All the info about the installed packages that the current package
-- depends on (directly or indirectly). The copy saved on disk does NOT
-- include internal dependencies (because we just don't have enough
-- information at this point to have an InstalledPackageInfo for
-- an internal dep), but we will often update it with the internal
-- dependencies; see for example build. (This admonition doesn't
-- apply for per-component builds.)
[installedPkgs] :: LocalBuildInfo -> InstalledPackageIndex
-- | the filename containing the .cabal file, if available
[pkgDescrFile] :: LocalBuildInfo -> Maybe FilePath
-- | WARNING WARNING WARNING Be VERY careful about using this function; we
-- haven't deprecated it but using it could introduce subtle bugs related
-- to HookedBuildInfo.
--
-- In principle, this is supposed to contain the resolved package
-- description, that does not contain any conditionals. However, it MAY
-- NOT contain the description with a HookedBuildInfo applied to
-- it; see HookedBuildInfo for the whole sordid saga. As much as
-- possible, Cabal library should avoid using this parameter.
[localPkgDescr] :: LocalBuildInfo -> PackageDescription
-- | Location and args for all programs
[withPrograms] :: LocalBuildInfo -> ProgramDb
-- | What package database to use, global/user
[withPackageDB] :: LocalBuildInfo -> PackageDBStack
-- | Whether to build normal libs.
[withVanillaLib] :: LocalBuildInfo -> Bool
-- | Whether to build profiling versions of libs.
[withProfLib] :: LocalBuildInfo -> Bool
-- | Whether to build shared versions of libs.
[withSharedLib] :: LocalBuildInfo -> Bool
-- | Whether to build static versions of libs (with all other libs rolled
-- in)
[withStaticLib] :: LocalBuildInfo -> Bool
-- | Whether to link executables dynamically
[withDynExe] :: LocalBuildInfo -> Bool
-- | Whether to link executables fully statically
[withFullyStaticExe] :: LocalBuildInfo -> Bool
-- | Whether to build executables for profiling.
[withProfExe] :: LocalBuildInfo -> Bool
-- | Level of automatic profile detail.
[withProfLibDetail] :: LocalBuildInfo -> ProfDetailLevel
-- | Level of automatic profile detail.
[withProfExeDetail] :: LocalBuildInfo -> ProfDetailLevel
-- | Whether to build with optimization (if available).
[withOptimization] :: LocalBuildInfo -> OptimisationLevel
-- | Whether to emit debug info (if available).
[withDebugInfo] :: LocalBuildInfo -> DebugInfoLevel
-- | Whether to build libs suitable for use with GHCi.
[withGHCiLib] :: LocalBuildInfo -> Bool
-- | Use -split-sections with GHC, if available
[splitSections] :: LocalBuildInfo -> Bool
-- | Use -split-objs with GHC, if available
[splitObjs] :: LocalBuildInfo -> Bool
-- | Whether to strip executables during install
[stripExes] :: LocalBuildInfo -> Bool
-- | Whether to strip libraries during install
[stripLibs] :: LocalBuildInfo -> Bool
-- | Whether to enable executable program coverage
[exeCoverage] :: LocalBuildInfo -> Bool
-- | Whether to enable library program coverage
[libCoverage] :: LocalBuildInfo -> Bool
-- | Prefix to be prepended to installed executables
[progPrefix] :: LocalBuildInfo -> PathTemplate
-- | Suffix to be appended to installed executables
[progSuffix] :: LocalBuildInfo -> PathTemplate
[relocatable] :: LocalBuildInfo -> Bool
-- | Extract the ComponentId from the public library component of a
-- LocalBuildInfo if it exists, or make a fake component ID based
-- on the package ID.
localComponentId :: LocalBuildInfo -> ComponentId
-- | Extract the UnitId from the library component of a
-- LocalBuildInfo if it exists, or make a fake unit ID based on
-- the package ID.
localUnitId :: LocalBuildInfo -> UnitId
-- | Extract the compatibility package key from the public library
-- component of a LocalBuildInfo if it exists, or make a fake
-- package key based on the package ID.
localCompatPackageKey :: LocalBuildInfo -> String
data Component
CLib :: Library -> Component
CFLib :: ForeignLib -> Component
CExe :: Executable -> Component
CTest :: TestSuite -> Component
CBench :: Benchmark -> Component
data ComponentName
CLibName :: LibraryName -> ComponentName
CFLibName :: UnqualComponentName -> ComponentName
CExeName :: UnqualComponentName -> ComponentName
CTestName :: UnqualComponentName -> ComponentName
CBenchName :: UnqualComponentName -> ComponentName
data LibraryName
LMainLibName :: LibraryName
LSubLibName :: UnqualComponentName -> LibraryName
defaultLibName :: LibraryName
showComponentName :: ComponentName -> String
-- | This gets the underlying unqualified component name. In fact, it is
-- guaranteed to uniquely identify a component, returning
-- Nothing if the ComponentName was for the public
-- library.
componentNameString :: ComponentName -> Maybe UnqualComponentName
-- | The first five fields are common across all algebraic variants.
data ComponentLocalBuildInfo
LibComponentLocalBuildInfo :: ComponentName -> ComponentId -> UnitId -> Bool -> [(ModuleName, OpenModule)] -> [(UnitId, MungedPackageId)] -> [(OpenUnitId, ModuleRenaming)] -> [UnitId] -> [UnitId] -> String -> MungedPackageName -> [ExposedModule] -> Bool -> ComponentLocalBuildInfo
-- | It would be very convenient to store the literal Library here, but if
-- we do that, it will get serialized (via the Binary) instance twice. So
-- instead we just provide the ComponentName, which can be used to find
-- the Component in the PackageDescription. NB: eventually, this will NOT
-- uniquely identify the ComponentLocalBuildInfo.
[componentLocalName] :: ComponentLocalBuildInfo -> ComponentName
-- | The computed ComponentId of this component.
[componentComponentId] :: ComponentLocalBuildInfo -> ComponentId
-- | The computed UnitId which uniquely identifies this component.
-- Might be hashed.
[componentUnitId] :: ComponentLocalBuildInfo -> UnitId
-- | Is this an indefinite component (i.e. has unfilled holes)?
[componentIsIndefinite_] :: ComponentLocalBuildInfo -> Bool
-- | How the component was instantiated
[componentInstantiatedWith] :: ComponentLocalBuildInfo -> [(ModuleName, OpenModule)]
-- | Resolved internal and external package dependencies for this
-- component. The BuildInfo specifies a set of build
-- dependencies that must be satisfied in terms of version ranges. This
-- field fixes those dependencies to the specific versions available on
-- this machine for this compiler.
[componentPackageDeps] :: ComponentLocalBuildInfo -> [(UnitId, MungedPackageId)]
-- | The set of packages that are brought into scope during compilation,
-- including a ModuleRenaming which may used to hide or rename
-- modules. This is what gets translated into -package-id
-- arguments. This is a modernized version of
-- componentPackageDeps, which is kept around for BC purposes.
[componentIncludes] :: ComponentLocalBuildInfo -> [(OpenUnitId, ModuleRenaming)]
[componentExeDeps] :: ComponentLocalBuildInfo -> [UnitId]
-- | The internal dependencies which induce a graph on the
-- ComponentLocalBuildInfo of this package. This does NOT coincide
-- with componentPackageDeps because it ALSO records 'build-tool'
-- dependencies on executables. Maybe one day cabal-install will
-- also handle these correctly too!
[componentInternalDeps] :: ComponentLocalBuildInfo -> [UnitId]
-- | Compatibility "package key" that we pass to older versions of GHC.
[componentCompatPackageKey] :: ComponentLocalBuildInfo -> String
-- | Compatibility "package name" that we register this component as.
[componentCompatPackageName] :: ComponentLocalBuildInfo -> MungedPackageName
-- | A list of exposed modules (either defined in this component, or
-- reexported from another component.)
[componentExposedModules] :: ComponentLocalBuildInfo -> [ExposedModule]
-- | Convenience field, specifying whether or not this is the "public
-- library" that has the same name as the package.
[componentIsPublic] :: ComponentLocalBuildInfo -> Bool
FLibComponentLocalBuildInfo :: ComponentName -> ComponentId -> UnitId -> [(UnitId, MungedPackageId)] -> [(OpenUnitId, ModuleRenaming)] -> [UnitId] -> [UnitId] -> ComponentLocalBuildInfo
-- | It would be very convenient to store the literal Library here, but if
-- we do that, it will get serialized (via the Binary) instance twice. So
-- instead we just provide the ComponentName, which can be used to find
-- the Component in the PackageDescription. NB: eventually, this will NOT
-- uniquely identify the ComponentLocalBuildInfo.
[componentLocalName] :: ComponentLocalBuildInfo -> ComponentName
-- | The computed ComponentId of this component.
[componentComponentId] :: ComponentLocalBuildInfo -> ComponentId
-- | The computed UnitId which uniquely identifies this component.
-- Might be hashed.
[componentUnitId] :: ComponentLocalBuildInfo -> UnitId
-- | Resolved internal and external package dependencies for this
-- component. The BuildInfo specifies a set of build
-- dependencies that must be satisfied in terms of version ranges. This
-- field fixes those dependencies to the specific versions available on
-- this machine for this compiler.
[componentPackageDeps] :: ComponentLocalBuildInfo -> [(UnitId, MungedPackageId)]
-- | The set of packages that are brought into scope during compilation,
-- including a ModuleRenaming which may used to hide or rename
-- modules. This is what gets translated into -package-id
-- arguments. This is a modernized version of
-- componentPackageDeps, which is kept around for BC purposes.
[componentIncludes] :: ComponentLocalBuildInfo -> [(OpenUnitId, ModuleRenaming)]
[componentExeDeps] :: ComponentLocalBuildInfo -> [UnitId]
-- | The internal dependencies which induce a graph on the
-- ComponentLocalBuildInfo of this package. This does NOT coincide
-- with componentPackageDeps because it ALSO records 'build-tool'
-- dependencies on executables. Maybe one day cabal-install will
-- also handle these correctly too!
[componentInternalDeps] :: ComponentLocalBuildInfo -> [UnitId]
ExeComponentLocalBuildInfo :: ComponentName -> ComponentId -> UnitId -> [(UnitId, MungedPackageId)] -> [(OpenUnitId, ModuleRenaming)] -> [UnitId] -> [UnitId] -> ComponentLocalBuildInfo
-- | It would be very convenient to store the literal Library here, but if
-- we do that, it will get serialized (via the Binary) instance twice. So
-- instead we just provide the ComponentName, which can be used to find
-- the Component in the PackageDescription. NB: eventually, this will NOT
-- uniquely identify the ComponentLocalBuildInfo.
[componentLocalName] :: ComponentLocalBuildInfo -> ComponentName
-- | The computed ComponentId of this component.
[componentComponentId] :: ComponentLocalBuildInfo -> ComponentId
-- | The computed UnitId which uniquely identifies this component.
-- Might be hashed.
[componentUnitId] :: ComponentLocalBuildInfo -> UnitId
-- | Resolved internal and external package dependencies for this
-- component. The BuildInfo specifies a set of build
-- dependencies that must be satisfied in terms of version ranges. This
-- field fixes those dependencies to the specific versions available on
-- this machine for this compiler.
[componentPackageDeps] :: ComponentLocalBuildInfo -> [(UnitId, MungedPackageId)]
-- | The set of packages that are brought into scope during compilation,
-- including a ModuleRenaming which may used to hide or rename
-- modules. This is what gets translated into -package-id
-- arguments. This is a modernized version of
-- componentPackageDeps, which is kept around for BC purposes.
[componentIncludes] :: ComponentLocalBuildInfo -> [(OpenUnitId, ModuleRenaming)]
[componentExeDeps] :: ComponentLocalBuildInfo -> [UnitId]
-- | The internal dependencies which induce a graph on the
-- ComponentLocalBuildInfo of this package. This does NOT coincide
-- with componentPackageDeps because it ALSO records 'build-tool'
-- dependencies on executables. Maybe one day cabal-install will
-- also handle these correctly too!
[componentInternalDeps] :: ComponentLocalBuildInfo -> [UnitId]
TestComponentLocalBuildInfo :: ComponentName -> ComponentId -> UnitId -> [(UnitId, MungedPackageId)] -> [(OpenUnitId, ModuleRenaming)] -> [UnitId] -> [UnitId] -> ComponentLocalBuildInfo
-- | It would be very convenient to store the literal Library here, but if
-- we do that, it will get serialized (via the Binary) instance twice. So
-- instead we just provide the ComponentName, which can be used to find
-- the Component in the PackageDescription. NB: eventually, this will NOT
-- uniquely identify the ComponentLocalBuildInfo.
[componentLocalName] :: ComponentLocalBuildInfo -> ComponentName
-- | The computed ComponentId of this component.
[componentComponentId] :: ComponentLocalBuildInfo -> ComponentId
-- | The computed UnitId which uniquely identifies this component.
-- Might be hashed.
[componentUnitId] :: ComponentLocalBuildInfo -> UnitId
-- | Resolved internal and external package dependencies for this
-- component. The BuildInfo specifies a set of build
-- dependencies that must be satisfied in terms of version ranges. This
-- field fixes those dependencies to the specific versions available on
-- this machine for this compiler.
[componentPackageDeps] :: ComponentLocalBuildInfo -> [(UnitId, MungedPackageId)]
-- | The set of packages that are brought into scope during compilation,
-- including a ModuleRenaming which may used to hide or rename
-- modules. This is what gets translated into -package-id
-- arguments. This is a modernized version of
-- componentPackageDeps, which is kept around for BC purposes.
[componentIncludes] :: ComponentLocalBuildInfo -> [(OpenUnitId, ModuleRenaming)]
[componentExeDeps] :: ComponentLocalBuildInfo -> [UnitId]
-- | The internal dependencies which induce a graph on the
-- ComponentLocalBuildInfo of this package. This does NOT coincide
-- with componentPackageDeps because it ALSO records 'build-tool'
-- dependencies on executables. Maybe one day cabal-install will
-- also handle these correctly too!
[componentInternalDeps] :: ComponentLocalBuildInfo -> [UnitId]
BenchComponentLocalBuildInfo :: ComponentName -> ComponentId -> UnitId -> [(UnitId, MungedPackageId)] -> [(OpenUnitId, ModuleRenaming)] -> [UnitId] -> [UnitId] -> ComponentLocalBuildInfo
-- | It would be very convenient to store the literal Library here, but if
-- we do that, it will get serialized (via the Binary) instance twice. So
-- instead we just provide the ComponentName, which can be used to find
-- the Component in the PackageDescription. NB: eventually, this will NOT
-- uniquely identify the ComponentLocalBuildInfo.
[componentLocalName] :: ComponentLocalBuildInfo -> ComponentName
-- | The computed ComponentId of this component.
[componentComponentId] :: ComponentLocalBuildInfo -> ComponentId
-- | The computed UnitId which uniquely identifies this component.
-- Might be hashed.
[componentUnitId] :: ComponentLocalBuildInfo -> UnitId
-- | Resolved internal and external package dependencies for this
-- component. The BuildInfo specifies a set of build
-- dependencies that must be satisfied in terms of version ranges. This
-- field fixes those dependencies to the specific versions available on
-- this machine for this compiler.
[componentPackageDeps] :: ComponentLocalBuildInfo -> [(UnitId, MungedPackageId)]
-- | The set of packages that are brought into scope during compilation,
-- including a ModuleRenaming which may used to hide or rename
-- modules. This is what gets translated into -package-id
-- arguments. This is a modernized version of
-- componentPackageDeps, which is kept around for BC purposes.
[componentIncludes] :: ComponentLocalBuildInfo -> [(OpenUnitId, ModuleRenaming)]
[componentExeDeps] :: ComponentLocalBuildInfo -> [UnitId]
-- | The internal dependencies which induce a graph on the
-- ComponentLocalBuildInfo of this package. This does NOT coincide
-- with componentPackageDeps because it ALSO records 'build-tool'
-- dependencies on executables. Maybe one day cabal-install will
-- also handle these correctly too!
[componentInternalDeps] :: ComponentLocalBuildInfo -> [UnitId]
componentBuildDir :: LocalBuildInfo -> ComponentLocalBuildInfo -> FilePath
foldComponent :: (Library -> a) -> (ForeignLib -> a) -> (Executable -> a) -> (TestSuite -> a) -> (Benchmark -> a) -> Component -> a
componentName :: Component -> ComponentName
componentBuildInfo :: Component -> BuildInfo
-- | Is a component buildable (i.e., not marked with buildable:
-- False)? See also this note in
-- Distribution.Types.ComponentRequestedSpec#buildable_vs_enabled_components.
componentBuildable :: Component -> Bool
-- | All the components in the package.
pkgComponents :: PackageDescription -> [Component]
-- | A list of all components in the package that are buildable, i.e., were
-- not marked with buildable: False. This does NOT indicate if
-- we are actually going to build the component, see
-- enabledComponents instead.
pkgBuildableComponents :: PackageDescription -> [Component]
lookupComponent :: PackageDescription -> ComponentName -> Maybe Component
getComponent :: PackageDescription -> ComponentName -> Component
allComponentsInBuildOrder :: LocalBuildInfo -> [ComponentLocalBuildInfo]
-- | Determine the directories containing the dynamic libraries of the
-- transitive dependencies of the component we are building.
--
-- When wanted, and possible, returns paths relative to the installDirs
-- prefix
depLibraryPaths :: Bool -> Bool -> LocalBuildInfo -> ComponentLocalBuildInfo -> IO [FilePath]
-- | Get all module names that needed to be built by GHC; i.e., all of
-- these ModuleNames have interface files associated with them
-- that need to be installed.
allLibModules :: Library -> ComponentLocalBuildInfo -> [ModuleName]
-- | Perform the action on each buildable Library or
-- Executable (Component) in the PackageDescription, subject to
-- the build order specified by the compBuildOrder field of the
-- given LocalBuildInfo
withAllComponentsInBuildOrder :: PackageDescription -> LocalBuildInfo -> (Component -> ComponentLocalBuildInfo -> IO ()) -> IO ()
-- | Perform the action on each enabled library in the package
-- description with the ComponentLocalBuildInfo.
withLibLBI :: PackageDescription -> LocalBuildInfo -> (Library -> ComponentLocalBuildInfo -> IO ()) -> IO ()
-- | Perform the action on each enabled Executable in the package
-- description. Extended version of withExe that also gives
-- corresponding build info.
withExeLBI :: PackageDescription -> LocalBuildInfo -> (Executable -> ComponentLocalBuildInfo -> IO ()) -> IO ()
-- | Perform the action on each enabled Benchmark in the package
-- description.
withBenchLBI :: PackageDescription -> LocalBuildInfo -> (Benchmark -> ComponentLocalBuildInfo -> IO ()) -> IO ()
withTestLBI :: PackageDescription -> LocalBuildInfo -> (TestSuite -> ComponentLocalBuildInfo -> IO ()) -> IO ()
enabledTestLBIs :: PackageDescription -> LocalBuildInfo -> [(TestSuite, ComponentLocalBuildInfo)]
enabledBenchLBIs :: PackageDescription -> LocalBuildInfo -> [(Benchmark, ComponentLocalBuildInfo)]
data PathTemplateVariable
-- | The $prefix path variable
PrefixVar :: PathTemplateVariable
-- | The $bindir path variable
BindirVar :: PathTemplateVariable
-- | The $libdir path variable
LibdirVar :: PathTemplateVariable
-- | The $libsubdir path variable
LibsubdirVar :: PathTemplateVariable
-- | The $dynlibdir path variable
DynlibdirVar :: PathTemplateVariable
-- | The $datadir path variable
DatadirVar :: PathTemplateVariable
-- | The $datasubdir path variable
DatasubdirVar :: PathTemplateVariable
-- | The $docdir path variable
DocdirVar :: PathTemplateVariable
-- | The $htmldir path variable
HtmldirVar :: PathTemplateVariable
-- | The $pkg package name path variable
PkgNameVar :: PathTemplateVariable
-- | The $version package version path variable
PkgVerVar :: PathTemplateVariable
-- | The $pkgid package Id path variable, eg foo-1.0
PkgIdVar :: PathTemplateVariable
-- | The $libname path variable
LibNameVar :: PathTemplateVariable
-- | The compiler name and version, eg ghc-6.6.1
CompilerVar :: PathTemplateVariable
-- | The operating system name, eg windows or linux
OSVar :: PathTemplateVariable
-- | The CPU architecture name, eg i386 or x86_64
ArchVar :: PathTemplateVariable
-- | The compiler's ABI identifier,
AbiVar :: PathTemplateVariable
-- | The optional ABI tag for the compiler
AbiTagVar :: PathTemplateVariable
-- | The executable name; used in shell wrappers
ExecutableNameVar :: PathTemplateVariable
-- | The name of the test suite being run
TestSuiteNameVar :: PathTemplateVariable
-- | The result of the test suite being run, eg pass,
-- fail, or error.
TestSuiteResultVar :: PathTemplateVariable
-- | The name of the benchmark being run
BenchmarkNameVar :: PathTemplateVariable
type PathTemplateEnv = [(PathTemplateVariable, PathTemplate)]
-- | An abstract path, possibly containing variables that need to be
-- substituted for to get a real FilePath.
data PathTemplate
-- | The location prefix for the copy command.
data CopyDest
NoCopyDest :: CopyDest
CopyTo :: FilePath -> CopyDest
-- | when using the ${pkgroot} as prefix. The CopyToDb will adjust the
-- paths to be relative to the provided package database when copying /
-- installing.
CopyToDb :: FilePath -> CopyDest
-- | The installation directories in terms of PathTemplates that
-- contain variables.
--
-- The defaults for most of the directories are relative to each other,
-- in particular they are all relative to a single prefix. This makes it
-- convenient for the user to override the default installation directory
-- by only having to specify --prefix=... rather than overriding each
-- individually. This is done by allowing $-style variables in the dirs.
-- These are expanded by textual substitution (see
-- substPathTemplate).
--
-- A few of these installation directories are split into two components,
-- the dir and subdir. The full installation path is formed by combining
-- the two together with /. The reason for this is compatibility
-- with other Unix build systems which also support --libdir and
-- --datadir. We would like users to be able to configure
-- --libdir=/usr/lib64 for example but because by default we
-- want to support installing multiple versions of packages and building
-- the same package for multiple compilers we append the libsubdir to
-- get: /usr/lib64/$libname/$compiler.
--
-- An additional complication is the need to support relocatable packages
-- on systems which support such things, like Windows.
type InstallDirTemplates = InstallDirs PathTemplate
-- | The directories where we will install files for packages.
--
-- We have several different directories for different types of files
-- since many systems have conventions whereby different types of files
-- in a package are installed in different directories. This is
-- particularly the case on Unix style systems.
data InstallDirs dir
InstallDirs :: dir -> dir -> dir -> dir -> dir -> dir -> dir -> dir -> dir -> dir -> dir -> dir -> dir -> dir -> dir -> dir -> InstallDirs dir
[prefix] :: InstallDirs dir -> dir
[bindir] :: InstallDirs dir -> dir
[libdir] :: InstallDirs dir -> dir
[libsubdir] :: InstallDirs dir -> dir
[dynlibdir] :: InstallDirs dir -> dir
-- | foreign libraries
[flibdir] :: InstallDirs dir -> dir
[libexecdir] :: InstallDirs dir -> dir
[libexecsubdir] :: InstallDirs dir -> dir
[includedir] :: InstallDirs dir -> dir
[datadir] :: InstallDirs dir -> dir
[datasubdir] :: InstallDirs dir -> dir
[docdir] :: InstallDirs dir -> dir
[mandir] :: InstallDirs dir -> dir
[htmldir] :: InstallDirs dir -> dir
[haddockdir] :: InstallDirs dir -> dir
[sysconfdir] :: InstallDirs dir -> dir
combineInstallDirs :: (a -> b -> c) -> InstallDirs a -> InstallDirs b -> InstallDirs c
defaultInstallDirs :: CompilerFlavor -> Bool -> Bool -> IO InstallDirTemplates
defaultInstallDirs' :: Bool -> CompilerFlavor -> Bool -> Bool -> IO InstallDirTemplates
-- | Substitute the install dir templates into each other.
--
-- To prevent cyclic substitutions, only some variables are allowed in
-- particular dir templates. If out of scope vars are present, they are
-- not substituted for. Checking for any remaining unsubstituted vars can
-- be done as a subsequent operation.
--
-- The reason it is done this way is so that in
-- prefixRelativeInstallDirs we can replace prefix with the
-- PrefixVar and get resulting PathTemplates that still
-- have the PrefixVar in them. Doing this makes it each to check
-- which paths are relative to the $prefix.
substituteInstallDirTemplates :: PathTemplateEnv -> InstallDirTemplates -> InstallDirTemplates
-- | Convert a FilePath to a PathTemplate including any
-- template vars.
toPathTemplate :: FilePath -> PathTemplate
-- | Convert back to a path, any remaining vars are included
fromPathTemplate :: PathTemplate -> FilePath
combinePathTemplate :: PathTemplate -> PathTemplate -> PathTemplate
-- | The initial environment has all the static stuff but no paths
initialPathTemplateEnv :: PackageIdentifier -> UnitId -> CompilerInfo -> Platform -> PathTemplateEnv
packageTemplateEnv :: PackageIdentifier -> UnitId -> PathTemplateEnv
compilerTemplateEnv :: CompilerInfo -> PathTemplateEnv
platformTemplateEnv :: Platform -> PathTemplateEnv
abiTemplateEnv :: CompilerInfo -> Platform -> PathTemplateEnv
installDirsTemplateEnv :: InstallDirs PathTemplate -> PathTemplateEnv
-- | Backwards compatibility function which computes the InstallDirs
-- assuming that $libname points to the public library (or some
-- fake package identifier if there is no public library.) IF AT ALL
-- POSSIBLE, please use absoluteComponentInstallDirs instead.
absoluteInstallDirs :: PackageDescription -> LocalBuildInfo -> CopyDest -> InstallDirs FilePath
-- | Backwards compatibility function which computes the InstallDirs
-- assuming that $libname points to the public library (or some
-- fake package identifier if there is no public library.) IF AT ALL
-- POSSIBLE, please use prefixRelativeComponentInstallDirs
-- instead.
prefixRelativeInstallDirs :: PackageId -> LocalBuildInfo -> InstallDirs (Maybe FilePath)
absoluteInstallCommandDirs :: PackageDescription -> LocalBuildInfo -> UnitId -> CopyDest -> InstallDirs FilePath
-- | See absoluteInstallDirs.
absoluteComponentInstallDirs :: PackageDescription -> LocalBuildInfo -> UnitId -> CopyDest -> InstallDirs FilePath
-- | See prefixRelativeInstallDirs
prefixRelativeComponentInstallDirs :: PackageId -> LocalBuildInfo -> UnitId -> InstallDirs (Maybe FilePath)
substPathTemplate :: PackageId -> LocalBuildInfo -> UnitId -> PathTemplate -> FilePath
module Distribution.Simple.Test.Log
-- | Logs all test results for a package, broken down first by test suite
-- and then by test case.
data PackageLog
PackageLog :: PackageId -> CompilerId -> Platform -> [TestSuiteLog] -> PackageLog
[package] :: PackageLog -> PackageId
[compiler] :: PackageLog -> CompilerId
[platform] :: PackageLog -> Platform
[testSuites] :: PackageLog -> [TestSuiteLog]
data TestLogs
TestLog :: String -> Options -> Result -> TestLogs
[testName] :: TestLogs -> String
[testOptionsReturned] :: TestLogs -> Options
[testResult] :: TestLogs -> Result
GroupLogs :: String -> [TestLogs] -> TestLogs
-- | Logs test suite results, itemized by test case.
data TestSuiteLog
TestSuiteLog :: UnqualComponentName -> TestLogs -> FilePath -> TestSuiteLog
[testSuiteName] :: TestSuiteLog -> UnqualComponentName
[testLogs] :: TestSuiteLog -> TestLogs
[logFile] :: TestSuiteLog -> FilePath
-- | Count the number of pass, fail, and error test results in a
-- TestLogs tree.
countTestResults :: TestLogs -> (Int, Int, Int)
-- | A PackageLog with package and platform information specified.
localPackageLog :: PackageDescription -> LocalBuildInfo -> PackageLog
-- | Print a summary to the console after all test suites have been run
-- indicating the number of successful test suites and cases. Returns
-- True if all test suites passed and False otherwise.
summarizePackage :: Verbosity -> PackageLog -> IO Bool
-- | Print a summary of the test suite's results on the console,
-- suppressing output for certain verbosity or test filter levels.
summarizeSuiteFinish :: TestSuiteLog -> String
summarizeSuiteStart :: String -> String
-- | Print a summary of a single test case's result to the console,
-- suppressing output for certain verbosity or test filter levels.
summarizeTest :: Verbosity -> TestShowDetails -> TestLogs -> IO ()
-- | From a TestSuiteLog, determine if the test suite encountered
-- errors.
suiteError :: TestLogs -> Bool
-- | From a TestSuiteLog, determine if the test suite failed.
suiteFailed :: TestLogs -> Bool
-- | From a TestSuiteLog, determine if the test suite passed.
suitePassed :: TestLogs -> Bool
testSuiteLogPath :: PathTemplate -> PackageDescription -> LocalBuildInfo -> String -> TestLogs -> FilePath
instance GHC.Classes.Eq Distribution.Simple.Test.Log.TestLogs
instance GHC.Show.Show Distribution.Simple.Test.Log.TestLogs
instance GHC.Read.Read Distribution.Simple.Test.Log.TestLogs
instance GHC.Classes.Eq Distribution.Simple.Test.Log.TestSuiteLog
instance GHC.Show.Show Distribution.Simple.Test.Log.TestSuiteLog
instance GHC.Read.Read Distribution.Simple.Test.Log.TestSuiteLog
instance GHC.Classes.Eq Distribution.Simple.Test.Log.PackageLog
instance GHC.Show.Show Distribution.Simple.Test.Log.PackageLog
instance GHC.Read.Read Distribution.Simple.Test.Log.PackageLog
-- | This module provides an library interface to the ld linker
-- program.
module Distribution.Simple.Program.Ld
-- | Call ld -r to link a bunch of object files together.
combineObjectFiles :: Verbosity -> LocalBuildInfo -> ConfiguredProgram -> FilePath -> [FilePath] -> IO ()
-- | This module provides an library interface to the ar program.
module Distribution.Simple.Program.Ar
-- | Call ar to create a library archive from a bunch of object
-- files.
createArLibArchive :: Verbosity -> LocalBuildInfo -> FilePath -> [FilePath] -> IO ()
-- | Like the unix xargs program. Useful for when we've got very long
-- command lines that might overflow an OS limit on command line length
-- and so you need to invoke a command multiple times to get all the args
-- in.
--
-- It takes four template invocations corresponding to the simple,
-- initial, middle and last invocations. If the number of args given is
-- small enough that we can get away with just a single invocation then
-- the simple one is used:
--
--
-- $ simple args
--
--
-- If the number of args given means that we need to use multiple
-- invocations then the templates for the initial, middle and last
-- invocations are used:
--
--
-- $ initial args_0
-- $ middle args_1
-- $ middle args_2
-- ...
-- $ final args_n
--
multiStageProgramInvocation :: ProgramInvocation -> (ProgramInvocation, ProgramInvocation, ProgramInvocation) -> [String] -> [ProgramInvocation]
-- | This module provides functions for locating various HPC-related paths
-- and a function for adding the necessary options to a
-- PackageDescription to build test suites with HPC enabled.
module Distribution.Simple.Hpc
data Way
Vanilla :: Way
Prof :: Way
Dyn :: Way
-- | Attempt to guess the way the test suites in this package were compiled
-- and linked with the library so the correct module interfaces are
-- found.
guessWay :: LocalBuildInfo -> Way
htmlDir :: FilePath -> Way -> FilePath -> FilePath
mixDir :: FilePath -> Way -> FilePath -> FilePath
tixDir :: FilePath -> Way -> FilePath -> FilePath
-- | Path to the .tix file containing a test suite's sum statistics.
tixFilePath :: FilePath -> Way -> FilePath -> FilePath
-- | Generate the HTML markup for all of a package's test suites.
markupPackage :: Verbosity -> LocalBuildInfo -> FilePath -> PackageDescription -> [TestSuite] -> IO ()
-- | Generate the HTML markup for a test suite.
markupTest :: Verbosity -> LocalBuildInfo -> FilePath -> String -> TestSuite -> Library -> IO ()
instance GHC.Show.Show Distribution.Simple.Hpc.Way
instance GHC.Read.Read Distribution.Simple.Hpc.Way
instance GHC.Classes.Eq Distribution.Simple.Hpc.Way
instance GHC.Enum.Enum Distribution.Simple.Hpc.Way
instance GHC.Enum.Bounded Distribution.Simple.Hpc.Way
-- | Handling for user-specified build targets
module Distribution.Simple.BuildTarget
-- | Take a list of String build targets, and parse and validate
-- them into actual TargetInfos to be
-- builtregisteredwhatever.
readTargetInfos :: Verbosity -> PackageDescription -> LocalBuildInfo -> [String] -> IO [TargetInfo]
-- | Read a list of user-supplied build target strings and resolve them to
-- BuildTargets according to a PackageDescription. If there
-- are problems with any of the targets e.g. they don't exist or are
-- misformatted, throw an IOException.
readBuildTargets :: Verbosity -> PackageDescription -> [String] -> IO [BuildTarget]
-- | A fully resolved build target.
data BuildTarget
-- | A specific component
BuildTargetComponent :: ComponentName -> BuildTarget
-- | A specific module within a specific component.
BuildTargetModule :: ComponentName -> ModuleName -> BuildTarget
-- | A specific file within a specific component.
BuildTargetFile :: ComponentName -> FilePath -> BuildTarget
-- | Unambiguously render a BuildTarget, so that it can be parsed in
-- all situations.
showBuildTarget :: PackageId -> BuildTarget -> String
data QualLevel
QL1 :: QualLevel
QL2 :: QualLevel
QL3 :: QualLevel
buildTargetComponentName :: BuildTarget -> ComponentName
-- | Various ways that a user may specify a build target.
data UserBuildTarget
readUserBuildTargets :: [String] -> ([UserBuildTargetProblem], [UserBuildTarget])
showUserBuildTarget :: UserBuildTarget -> String
data UserBuildTargetProblem
UserBuildTargetUnrecognised :: String -> UserBuildTargetProblem
reportUserBuildTargetProblems :: Verbosity -> [UserBuildTargetProblem] -> IO ()
-- | Given a bunch of user-specified targets, try to resolve what it is
-- they refer to.
resolveBuildTargets :: PackageDescription -> [(UserBuildTarget, Bool)] -> ([BuildTargetProblem], [BuildTarget])
data BuildTargetProblem
-- |
-- - expected thing (actually got)
--
BuildTargetExpected :: UserBuildTarget -> [String] -> String -> BuildTargetProblem
-- |
-- - (no such thing, actually got)
--
BuildTargetNoSuch :: UserBuildTarget -> [(String, String)] -> BuildTargetProblem
BuildTargetAmbiguous :: UserBuildTarget -> [(UserBuildTarget, BuildTarget)] -> BuildTargetProblem
reportBuildTargetProblems :: Verbosity -> [BuildTargetProblem] -> IO ()
instance GHC.Classes.Ord Distribution.Simple.BuildTarget.UserBuildTarget
instance GHC.Classes.Eq Distribution.Simple.BuildTarget.UserBuildTarget
instance GHC.Show.Show Distribution.Simple.BuildTarget.UserBuildTarget
instance GHC.Generics.Generic Distribution.Simple.BuildTarget.BuildTarget
instance GHC.Show.Show Distribution.Simple.BuildTarget.BuildTarget
instance GHC.Classes.Eq Distribution.Simple.BuildTarget.BuildTarget
instance GHC.Show.Show Distribution.Simple.BuildTarget.UserBuildTargetProblem
instance GHC.Show.Show Distribution.Simple.BuildTarget.BuildTargetProblem
instance GHC.Show.Show Distribution.Simple.BuildTarget.QualLevel
instance GHC.Enum.Enum Distribution.Simple.BuildTarget.QualLevel
instance GHC.Enum.Bounded Distribution.Simple.BuildTarget.ComponentKind
instance GHC.Enum.Enum Distribution.Simple.BuildTarget.ComponentKind
instance GHC.Show.Show Distribution.Simple.BuildTarget.ComponentKind
instance GHC.Classes.Ord Distribution.Simple.BuildTarget.ComponentKind
instance GHC.Classes.Eq Distribution.Simple.BuildTarget.ComponentKind
instance GHC.Classes.Eq Distribution.Simple.BuildTarget.MatchError
instance GHC.Show.Show Distribution.Simple.BuildTarget.MatchError
instance GHC.Show.Show a => GHC.Show.Show (Distribution.Simple.BuildTarget.Match a)
instance GHC.Show.Show a => GHC.Show.Show (Distribution.Simple.BuildTarget.MaybeAmbiguous a)
instance GHC.Base.Alternative Distribution.Simple.BuildTarget.Match
instance GHC.Base.MonadPlus Distribution.Simple.BuildTarget.Match
instance GHC.Base.Functor Distribution.Simple.BuildTarget.Match
instance GHC.Base.Applicative Distribution.Simple.BuildTarget.Match
instance GHC.Base.Monad Distribution.Simple.BuildTarget.Match
instance Data.Binary.Class.Binary Distribution.Simple.BuildTarget.BuildTarget
-- | A bunch of dirs, paths and file names used for intermediate build
-- steps.
module Distribution.Simple.BuildPaths
defaultDistPref :: FilePath
srcPref :: FilePath -> FilePath
-- | This is the name of the directory in which the generated haddocks
-- should be stored. It does not include the
-- distdochtml prefix.
haddockDirName :: HaddockTarget -> PackageDescription -> FilePath
hscolourPref :: HaddockTarget -> FilePath -> PackageDescription -> FilePath
-- | The directory to which generated haddock documentation should be
-- written.
haddockPref :: HaddockTarget -> FilePath -> PackageDescription -> FilePath
-- | The directory in which we put auto-generated modules for EVERY
-- component in the package.
autogenPackageModulesDir :: LocalBuildInfo -> String
-- | The directory in which we put auto-generated modules for a particular
-- component.
autogenComponentModulesDir :: LocalBuildInfo -> ComponentLocalBuildInfo -> String
-- | The name of the auto-generated Paths_* module associated with a
-- package
autogenPathsModuleName :: PackageDescription -> ModuleName
cppHeaderName :: String
haddockName :: PackageDescription -> FilePath
-- | Create a library name for a static library from a given name. Prepends
-- lib and appends the static library extension (.a).
mkGenericStaticLibName :: String -> String
mkLibName :: UnitId -> String
mkProfLibName :: UnitId -> String
-- | Create a library name for a shared library from a given name. Prepends
-- lib and appends the
-- -<compilerFlavour><compilerVersion> as well as
-- the shared library extension.
mkGenericSharedLibName :: Platform -> CompilerId -> String -> String
mkSharedLibName :: Platform -> CompilerId -> UnitId -> String
mkStaticLibName :: Platform -> CompilerId -> UnitId -> String
-- | Create a library name for a bundled shared library from a given name.
-- This matches the naming convention for shared libraries as implemented
-- in GHC's packageHsLibs function in the Packages module. If the given
-- name is prefixed with HS, then this prepends lib and appends
-- the compiler flavour/version and shared library extension e.g.:
-- "HSrts-1.0" -> "libHSrts-1.0-ghc8.7.20190109.so" Otherwise the
-- given name should be prefixed with C, then this strips the
-- C, prepends lib and appends the shared library
-- extension e.g.: Cffi -> "libffi.so"
mkGenericSharedBundledLibName :: Platform -> CompilerId -> String -> String
-- | Default extension for executable files on the current platform.
-- (typically "" on Unix and "exe" on Windows or OS/2)
exeExtension :: Platform -> String
-- | Extension for object files. For GHC the extension is "o".
objExtension :: String
-- | Extension for dynamically linked (or shared) libraries (typically
-- "so" on Unix and "dll" on Windows)
dllExtension :: Platform -> String
-- | Extension for static libraries
--
-- TODO: Here, as well as in dllExtension, it's really the target OS that
-- we're interested in, not the build OS.
staticLibExtension :: Platform -> String
getSourceFiles :: Verbosity -> [FilePath] -> [ModuleName] -> IO [(ModuleName, FilePath)]
getLibSourceFiles :: Verbosity -> LocalBuildInfo -> Library -> ComponentLocalBuildInfo -> IO [(ModuleName, FilePath)]
getExeSourceFiles :: Verbosity -> LocalBuildInfo -> Executable -> ComponentLocalBuildInfo -> IO [(ModuleName, FilePath)]
getFLibSourceFiles :: Verbosity -> LocalBuildInfo -> ForeignLib -> ComponentLocalBuildInfo -> IO [(ModuleName, FilePath)]
-- | The directory where we put build results for an executable
exeBuildDir :: LocalBuildInfo -> Executable -> FilePath
-- | The directory where we put build results for a foreign library
flibBuildDir :: LocalBuildInfo -> ForeignLib -> FilePath
-- | This module contains most of the UHC-specific code for configuring,
-- building and installing packages.
--
-- Thanks to the authors of the other implementation-specific files, in
-- particular to Isaac Jones, Duncan Coutts and Henning Thielemann, for
-- inspiration on how to design this module.
module Distribution.Simple.UHC
configure :: Verbosity -> Maybe FilePath -> Maybe FilePath -> ProgramDb -> IO (Compiler, Maybe Platform, ProgramDb)
getInstalledPackages :: Verbosity -> Compiler -> PackageDBStack -> ProgramDb -> IO InstalledPackageIndex
buildLib :: Verbosity -> PackageDescription -> LocalBuildInfo -> Library -> ComponentLocalBuildInfo -> IO ()
buildExe :: Verbosity -> PackageDescription -> LocalBuildInfo -> Executable -> ComponentLocalBuildInfo -> IO ()
installLib :: Verbosity -> LocalBuildInfo -> FilePath -> FilePath -> FilePath -> PackageDescription -> Library -> ComponentLocalBuildInfo -> IO ()
registerPackage :: Verbosity -> Compiler -> ProgramDb -> PackageDBStack -> InstalledPackageInfo -> IO ()
inplacePackageDbPath :: LocalBuildInfo -> FilePath
-- | This has code for checking for various problems in packages. There is
-- one set of checks that just looks at a PackageDescription in
-- isolation and another set of checks that also looks at files in the
-- package. Some of the checks are basic sanity checks, others are
-- portability standards that we'd like to encourage. There is a
-- PackageCheck type that distinguishes the different kinds of
-- checks so we can see which ones are appropriate to report in different
-- situations. This code gets used when configuring a package when we
-- consider only basic problems. The higher standard is used when
-- preparing a source tarball and by Hackage when uploading new packages.
-- The reason for this is that we want to hold packages that are expected
-- to be distributed to a higher standard than packages that are only
-- ever expected to be used on the author's own environment.
module Distribution.PackageDescription.Check
-- | Results of some kind of failed package check.
--
-- There are a range of severities, from merely dubious to totally
-- insane. All of them come with a human readable explanation. In future
-- we may augment them with more machine readable explanations, for
-- example to help an IDE suggest automatic corrections.
data PackageCheck
-- | This package description is no good. There's no way it's going to
-- build sensibly. This should give an error at configure time.
PackageBuildImpossible :: String -> PackageCheck
[explanation] :: PackageCheck -> String
-- | A problem that is likely to affect building the package, or an issue
-- that we'd like every package author to be aware of, even if the
-- package is never distributed.
PackageBuildWarning :: String -> PackageCheck
[explanation] :: PackageCheck -> String
-- | An issue that might not be a problem for the package author but might
-- be annoying or detrimental when the package is distributed to users.
-- We should encourage distributed packages to be free from these issues,
-- but occasionally there are justifiable reasons so we cannot ban them
-- entirely.
PackageDistSuspicious :: String -> PackageCheck
[explanation] :: PackageCheck -> String
-- | Like PackageDistSuspicious but will only display warnings rather than
-- causing abnormal exit when you run 'cabal check'.
PackageDistSuspiciousWarn :: String -> PackageCheck
[explanation] :: PackageCheck -> String
-- | An issue that is OK in the author's environment but is almost certain
-- to be a portability problem for other environments. We can quite
-- legitimately refuse to publicly distribute packages with these
-- problems.
PackageDistInexcusable :: String -> PackageCheck
[explanation] :: PackageCheck -> String
-- | Check for common mistakes and problems in package descriptions.
--
-- This is the standard collection of checks covering all aspects except
-- for checks that require looking at files within the package. For those
-- see checkPackageFiles.
--
-- It requires the GenericPackageDescription and optionally a
-- particular configuration of that package. If you pass Nothing
-- then we just check a version of the generic description using
-- flattenPackageDescription.
checkPackage :: GenericPackageDescription -> Maybe PackageDescription -> [PackageCheck]
checkConfiguredPackage :: PackageDescription -> [PackageCheck]
-- | Sanity check things that requires IO. It looks at the files in the
-- package and expects to find the package unpacked in at the given file
-- path.
checkPackageFiles :: Verbosity -> PackageDescription -> FilePath -> IO [PackageCheck]
-- | Sanity check things that requires looking at files in the package.
-- This is a generalised version of checkPackageFiles that can
-- work in any monad for which you can provide
-- CheckPackageContentOps operations.
--
-- The point of this extra generality is to allow doing checks in some
-- virtual file system, for example a tarball in memory.
checkPackageContent :: (Monad m, Applicative m) => CheckPackageContentOps m -> PackageDescription -> m [PackageCheck]
-- | A record of operations needed to check the contents of packages. Used
-- by checkPackageContent.
data CheckPackageContentOps m
CheckPackageContentOps :: (FilePath -> m Bool) -> (FilePath -> m Bool) -> (FilePath -> m [FilePath]) -> (FilePath -> m ByteString) -> CheckPackageContentOps m
[doesFileExist] :: CheckPackageContentOps m -> FilePath -> m Bool
[doesDirectoryExist] :: CheckPackageContentOps m -> FilePath -> m Bool
[getDirectoryContents] :: CheckPackageContentOps m -> FilePath -> m [FilePath]
[getFileContents] :: CheckPackageContentOps m -> FilePath -> m ByteString
-- | Check the names of all files in a package for portability problems.
-- This should be done for example when creating or validating a package
-- tarball.
checkPackageFileNames :: [FilePath] -> [PackageCheck]
instance GHC.Classes.Ord Distribution.PackageDescription.Check.PackageCheck
instance GHC.Classes.Eq Distribution.PackageDescription.Check.PackageCheck
instance GHC.Show.Show Distribution.PackageDescription.Check.PackageCheck
-- | Generating the Paths_pkgname module.
--
-- This is a module that Cabal generates for the benefit of packages. It
-- enables them to find their version number and find any installed data
-- files at runtime. This code should probably be split off into another
-- module.
module Distribution.Simple.Build.PathsModule
generatePathsModule :: PackageDescription -> LocalBuildInfo -> ComponentLocalBuildInfo -> String
-- | Generates the name of the environment variable controlling the path
-- component of interest.
--
-- Note: The format of these strings is part of Cabal's public API;
-- changing this function constitutes a *backwards-compatibility* break.
pkgPathEnvVar :: PackageDescription -> String -> String
module Distribution.Simple.Test.LibV09
runTest :: PackageDescription -> LocalBuildInfo -> ComponentLocalBuildInfo -> TestFlags -> TestSuite -> IO TestSuiteLog
-- | Source code for library test suite stub executable
simpleTestStub :: ModuleName -> String
-- | The filename of the source file for the stub executable associated
-- with a library TestSuite.
stubFilePath :: TestSuite -> FilePath
-- | Main function for test stubs. Once, it was written directly into the
-- stub, but minimizing the amount of code actually in the stub maximizes
-- the number of detectable errors when Cabal is compiled.
stubMain :: IO [Test] -> IO ()
-- | The name of the stub executable associated with a library
-- TestSuite.
stubName :: TestSuite -> FilePath
-- | From a test stub, write the TestSuiteLog to temporary file for
-- the calling Cabal process to read.
stubWriteLog :: FilePath -> UnqualComponentName -> TestLogs -> IO ()
-- | Write the source file for a library TestSuite stub
-- executable.
writeSimpleTestStub :: TestSuite -> FilePath -> IO ()
module Distribution.Simple.Test.ExeV10
runTest :: PackageDescription -> LocalBuildInfo -> ComponentLocalBuildInfo -> TestFlags -> TestSuite -> IO TestSuiteLog
-- | Generate cabal_macros.h - CPP macros for package version testing
--
-- When using CPP you get
--
--
-- VERSION_<package>
-- MIN_VERSION_<package>(A,B,C)
--
--
-- for each package in build-depends, which is true if
-- the version of package in use is >= A.B.C, using
-- the normal ordering on version numbers.
--
-- TODO Figure out what to do about backpack and internal libraries. It
-- is very suspecious that this stuff works with munged package
-- identifiers
module Distribution.Simple.Build.Macros
-- | The contents of the cabal_macros.h for the given configured
-- package.
generateCabalMacrosHeader :: PackageDescription -> LocalBuildInfo -> ComponentLocalBuildInfo -> String
-- | Helper function that generates just the VERSION_pkg and
-- MIN_VERSION_pkg macros for a list of package ids (usually
-- used with the specific deps of a configured package).
generatePackageVersionMacros :: Version -> [PackageId] -> String
-- | See
-- https://github.com/ezyang/ghc-proposals/blob/backpack/proposals/0000-backpack.rst
module Distribution.Backpack.ConfiguredComponent
-- | A configured component, we know exactly what its ComponentId
-- is, and the ComponentIds of the things it depends on.
data ConfiguredComponent
ConfiguredComponent :: AnnotatedId ComponentId -> Component -> Bool -> [AnnotatedId ComponentId] -> [ComponentInclude ComponentId IncludeRenaming] -> ConfiguredComponent
-- | Unique identifier of component, plus extra useful info.
[cc_ann_id] :: ConfiguredComponent -> AnnotatedId ComponentId
-- | The fragment of syntax from the Cabal file describing this component.
[cc_component] :: ConfiguredComponent -> Component
-- | Is this the public library component of the package? (If we invoke
-- Setup with an instantiation, this is the component the instantiation
-- applies to.) Note that in one-component configure mode, this is always
-- True, because any component is the "public" one.)
[cc_public] :: ConfiguredComponent -> Bool
-- | Dependencies on executables from build-tools and
-- build-tool-depends.
[cc_exe_deps] :: ConfiguredComponent -> [AnnotatedId ComponentId]
-- | The mixins of this package, including both explicit (from the
-- mixins field) and implicit (from build-depends). Not
-- mix-in linked yet; component configuration only looks at
-- ComponentIds.
[cc_includes] :: ConfiguredComponent -> [ComponentInclude ComponentId IncludeRenaming]
-- | The ComponentName of a component; this uniquely identifies a
-- fragment of syntax within a specified Cabal file describing the
-- component.
cc_name :: ConfiguredComponent -> ComponentName
-- | Uniquely identifies a configured component.
cc_cid :: ConfiguredComponent -> ComponentId
-- | The package this component came from.
cc_pkgid :: ConfiguredComponent -> PackageId
toConfiguredComponent :: PackageDescription -> ComponentId -> ConfiguredComponentMap -> ConfiguredComponentMap -> Component -> LogProgress ConfiguredComponent
toConfiguredComponents :: Bool -> FlagAssignment -> Bool -> Flag String -> Flag ComponentId -> PackageDescription -> ConfiguredComponentMap -> [Component] -> LogProgress [ConfiguredComponent]
-- | Pretty-print a ConfiguredComponent.
dispConfiguredComponent :: ConfiguredComponent -> Doc
type ConfiguredComponentMap = Map PackageName (Map ComponentName (AnnotatedId ComponentId))
extendConfiguredComponentMap :: ConfiguredComponent -> ConfiguredComponentMap -> ConfiguredComponentMap
newPackageDepsBehaviour :: PackageDescription -> Bool
-- | See
-- https://github.com/ezyang/ghc-proposals/blob/backpack/proposals/0000-backpack.rst
module Distribution.Backpack.ComponentsGraph
-- | A graph of source-level components by their source-level dependencies
type ComponentsGraph = Graph (Node ComponentName Component)
-- | A list of components associated with the source level dependencies
-- between them.
type ComponentsWithDeps = [(Component, [ComponentName])]
-- | Create a Graph of Component, or report a cycle if there
-- is a problem.
mkComponentsGraph :: ComponentRequestedSpec -> PackageDescription -> Either [ComponentName] ComponentsGraph
-- | Given the package description and a PackageDescription (used to
-- determine if a package name is internal or not), sort the components
-- in dependency order (fewest dependencies first). This is NOT
-- necessarily the build order (although it is in the absence of
-- Backpack.)
componentsGraphToList :: ComponentsGraph -> ComponentsWithDeps
-- | Pretty-print ComponentsWithDeps.
dispComponentsWithDeps :: ComponentsWithDeps -> Doc
-- | Error message when there is a cycle; takes the SCC of components.
componentCycleMsg :: PackageIdentifier -> [ComponentName] -> Doc
module Distribution.Simple.HaskellSuite
configure :: Verbosity -> Maybe FilePath -> Maybe FilePath -> ProgramDb -> IO (Compiler, Maybe Platform, ProgramDb)
hstoolVersion :: Verbosity -> FilePath -> IO (Maybe Version)
numericVersion :: Verbosity -> FilePath -> IO (Maybe Version)
getCompilerVersion :: Verbosity -> ConfiguredProgram -> IO (String, Version)
getExtensions :: Verbosity -> ConfiguredProgram -> IO [(Extension, Maybe CompilerFlag)]
getLanguages :: Verbosity -> ConfiguredProgram -> IO [(Language, CompilerFlag)]
getInstalledPackages :: Verbosity -> PackageDBStack -> ProgramDb -> IO InstalledPackageIndex
buildLib :: Verbosity -> PackageDescription -> LocalBuildInfo -> Library -> ComponentLocalBuildInfo -> IO ()
installLib :: Verbosity -> LocalBuildInfo -> FilePath -> FilePath -> FilePath -> PackageDescription -> Library -> ComponentLocalBuildInfo -> IO ()
registerPackage :: Verbosity -> ProgramDb -> PackageDBStack -> InstalledPackageInfo -> IO ()
initPackageDB :: Verbosity -> ProgramDb -> FilePath -> IO ()
packageDbOpt :: PackageDB -> String
module Distribution.Simple.GHCJS
getGhcInfo :: Verbosity -> ConfiguredProgram -> IO [(String, String)]
configure :: Verbosity -> Maybe FilePath -> Maybe FilePath -> ProgramDb -> IO (Compiler, Maybe Platform, ProgramDb)
-- | Given a package DB stack, return all installed packages.
getInstalledPackages :: Verbosity -> PackageDBStack -> ProgramDb -> IO InstalledPackageIndex
-- | Get the packages from specific PackageDBs, not cumulative.
getInstalledPackagesMonitorFiles :: Verbosity -> Platform -> ProgramDb -> [PackageDB] -> IO [FilePath]
-- | Given a single package DB, return all installed packages.
getPackageDBContents :: Verbosity -> PackageDB -> ProgramDb -> IO InstalledPackageIndex
buildLib :: Verbosity -> Flag (Maybe Int) -> PackageDescription -> LocalBuildInfo -> Library -> ComponentLocalBuildInfo -> IO ()
-- | Build a foreign library
buildFLib :: Verbosity -> Flag (Maybe Int) -> PackageDescription -> LocalBuildInfo -> ForeignLib -> ComponentLocalBuildInfo -> IO ()
-- | Build an executable with GHC.
buildExe :: Verbosity -> Flag (Maybe Int) -> PackageDescription -> LocalBuildInfo -> Executable -> ComponentLocalBuildInfo -> IO ()
replLib :: [String] -> Verbosity -> Flag (Maybe Int) -> PackageDescription -> LocalBuildInfo -> Library -> ComponentLocalBuildInfo -> IO ()
replFLib :: [String] -> Verbosity -> Flag (Maybe Int) -> PackageDescription -> LocalBuildInfo -> ForeignLib -> ComponentLocalBuildInfo -> IO ()
replExe :: [String] -> Verbosity -> Flag (Maybe Int) -> PackageDescription -> LocalBuildInfo -> Executable -> ComponentLocalBuildInfo -> IO ()
-- | Start a REPL without loading any source files.
startInterpreter :: Verbosity -> ProgramDb -> Compiler -> Platform -> PackageDBStack -> IO ()
-- | Install for ghc, .hi, .a and, if --with-ghci given, .o
installLib :: Verbosity -> LocalBuildInfo -> FilePath -> FilePath -> FilePath -> PackageDescription -> Library -> ComponentLocalBuildInfo -> IO ()
-- | Install foreign library for GHC.
installFLib :: Verbosity -> LocalBuildInfo -> FilePath -> FilePath -> PackageDescription -> ForeignLib -> IO ()
-- | Install executables for GHCJS.
installExe :: Verbosity -> LocalBuildInfo -> FilePath -> FilePath -> (FilePath, FilePath) -> PackageDescription -> Executable -> IO ()
-- | Extracts a String representing a hash of the ABI of a built library.
-- It can fail if the library has not yet been built.
libAbiHash :: Verbosity -> PackageDescription -> LocalBuildInfo -> Library -> ComponentLocalBuildInfo -> IO String
hcPkgInfo :: ProgramDb -> HcPkgInfo
registerPackage :: Verbosity -> ProgramDb -> PackageDBStack -> InstalledPackageInfo -> RegisterOptions -> IO ()
componentGhcOptions :: Verbosity -> LocalBuildInfo -> BuildInfo -> ComponentLocalBuildInfo -> FilePath -> GhcOptions
componentCcGhcOptions :: Verbosity -> LocalBuildInfo -> BuildInfo -> ComponentLocalBuildInfo -> FilePath -> FilePath -> GhcOptions
getLibDir :: Verbosity -> LocalBuildInfo -> IO FilePath
isDynamic :: Compiler -> Bool
-- | Return the FilePath to the global GHC package database.
getGlobalPackageDB :: Verbosity -> ConfiguredProgram -> IO FilePath
pkgRoot :: Verbosity -> LocalBuildInfo -> PackageDB -> IO FilePath
-- | Get the JavaScript file name and command and arguments to run a
-- program compiled by GHCJS the exe should be the base program name
-- without exe extension
runCmd :: ProgramDb -> FilePath -> (FilePath, FilePath, [String])
-- | The kinds of entries we can stick in a .ghc.environment file.
data GhcEnvironmentFileEntry
-- |
-- -- a comment
--
GhcEnvFileComment :: String -> GhcEnvironmentFileEntry
-- |
-- package-id foo-1.0-4fe301a...
--
GhcEnvFilePackageId :: UnitId -> GhcEnvironmentFileEntry
-- | global-package-db, user-package-db or package-db
-- blahpackage.conf.d
GhcEnvFilePackageDb :: PackageDB -> GhcEnvironmentFileEntry
-- |
-- clear-package-db
--
GhcEnvFileClearPackageDbStack :: GhcEnvironmentFileEntry
-- | Make entries for a GHC environment file based on a
-- PackageDBStack and a bunch of package (unit) ids.
--
-- If you need to do anything more complicated then either use this as a
-- basis and add more entries, or just make all the entries directly.
simpleGhcEnvironmentFile :: PackageDBStack -> [UnitId] -> [GhcEnvironmentFileEntry]
-- | Render a bunch of GHC environment file entries
renderGhcEnvironmentFile :: [GhcEnvironmentFileEntry] -> String
-- | Write a .ghc.environment-$arch-$os-$ver file in the given
-- directory.
--
-- The Platform and GHC Version are needed as part of the
-- file name.
--
-- Returns the name of the file written.
writeGhcEnvironmentFile :: FilePath -> Platform -> Version -> [GhcEnvironmentFileEntry] -> IO FilePath
-- | GHC's rendering of its platform and compiler version string as used in
-- certain file locations (such as user package db location). For example
-- x86_64-linux-7.10.4
ghcPlatformAndVersionString :: Platform -> Version -> String
readGhcEnvironmentFile :: FilePath -> IO [GhcEnvironmentFileEntry]
parseGhcEnvironmentFile :: Parser [GhcEnvironmentFileEntry]
newtype ParseErrorExc
ParseErrorExc :: ParseError -> ParseErrorExc
getImplInfo :: Compiler -> GhcImplInfo
-- | Information about features and quirks of a GHC-based implementation.
--
-- Compiler flavors based on GHC behave similarly enough that some of the
-- support code for them is shared. Every implementation has its own
-- peculiarities, that may or may not be a direct result of the
-- underlying GHC version. This record keeps track of these differences.
--
-- All shared code (i.e. everything not in the Distribution.Simple.FLAVOR
-- module) should use implementation info rather than version numbers to
-- test for supported features.
data GhcImplInfo
GhcImplInfo :: Bool -> Bool -> Bool -> Bool -> Bool -> Bool -> Bool -> Bool -> Bool -> Bool -> Bool -> GhcImplInfo
-- |
-- - XHaskell2010 and -XHaskell98 flags
--
[supportsHaskell2010] :: GhcImplInfo -> Bool
-- |
[supportsGHC2021] :: GhcImplInfo -> Bool
-- |
-- - -supported-languages gives Ext and NoExt
--
[reportsNoExt] :: GhcImplInfo -> Bool
-- | NondecreasingIndentation is always on
[alwaysNondecIndent] :: GhcImplInfo -> Bool
-- |
-- - ghci-script flag supported
--
[flagGhciScript] :: GhcImplInfo -> Bool
-- | new style -fprof-auto* flags
[flagProfAuto] :: GhcImplInfo -> Bool
-- | use package-conf instead of package-db
[flagPackageConf] :: GhcImplInfo -> Bool
-- |
[flagDebugInfo] :: GhcImplInfo -> Bool
-- | supports numeric -g levels
[supportsDebugLevels] :: GhcImplInfo -> Bool
-- | picks up .ghc.environment files
[supportsPkgEnvFiles] :: GhcImplInfo -> Bool
-- |
-- - Wmissing-home-modules is supported
--
[flagWarnMissingHomeModules] :: GhcImplInfo -> Bool
-- | This is a fairly large module. It contains most of the GHC-specific
-- code for configuring, building and installing packages. It also
-- exports a function for finding out what packages are already
-- installed. Configuring involves finding the ghc and
-- ghc-pkg programs, finding what language extensions this
-- version of ghc supports and returning a Compiler value.
--
-- getInstalledPackages involves calling the ghc-pkg
-- program to find out what packages are installed.
--
-- Building is somewhat complex as there is quite a bit of information to
-- take into account. We have to build libs and programs, possibly for
-- profiling and shared libs. We have to support building libraries that
-- will be usable by GHCi and also ghc's -split-objs feature. We
-- have to compile any C files using ghc. Linking, especially for
-- split-objs is remarkably complex, partly because there tend
-- to be 1,000's of .o files and this can often be more than we
-- can pass to the ld or ar programs in one go.
--
-- Installing for libs and exes involves finding the right files and
-- copying them to the right places. One of the more tricky things about
-- this module is remembering the layout of files in the build directory
-- (which is not explicitly documented) and thus what search dirs are
-- used for various kinds of files.
module Distribution.Simple.GHC
getGhcInfo :: Verbosity -> ConfiguredProgram -> IO [(String, String)]
configure :: Verbosity -> Maybe FilePath -> Maybe FilePath -> ProgramDb -> IO (Compiler, Maybe Platform, ProgramDb)
-- | Given a package DB stack, return all installed packages.
getInstalledPackages :: Verbosity -> Compiler -> PackageDBStack -> ProgramDb -> IO InstalledPackageIndex
getInstalledPackagesMonitorFiles :: Verbosity -> Platform -> ProgramDb -> [PackageDB] -> IO [FilePath]
-- | Given a single package DB, return all installed packages.
getPackageDBContents :: Verbosity -> PackageDB -> ProgramDb -> IO InstalledPackageIndex
buildLib :: Verbosity -> Flag (Maybe Int) -> PackageDescription -> LocalBuildInfo -> Library -> ComponentLocalBuildInfo -> IO ()
-- | Build a foreign library
buildFLib :: Verbosity -> Flag (Maybe Int) -> PackageDescription -> LocalBuildInfo -> ForeignLib -> ComponentLocalBuildInfo -> IO ()
-- | Build an executable with GHC.
buildExe :: Verbosity -> Flag (Maybe Int) -> PackageDescription -> LocalBuildInfo -> Executable -> ComponentLocalBuildInfo -> IO ()
replLib :: [String] -> Verbosity -> Flag (Maybe Int) -> PackageDescription -> LocalBuildInfo -> Library -> ComponentLocalBuildInfo -> IO ()
replFLib :: [String] -> Verbosity -> Flag (Maybe Int) -> PackageDescription -> LocalBuildInfo -> ForeignLib -> ComponentLocalBuildInfo -> IO ()
replExe :: [String] -> Verbosity -> Flag (Maybe Int) -> PackageDescription -> LocalBuildInfo -> Executable -> ComponentLocalBuildInfo -> IO ()
-- | Start a REPL without loading any source files.
startInterpreter :: Verbosity -> ProgramDb -> Compiler -> Platform -> PackageDBStack -> IO ()
-- | Install for ghc, .hi, .a and, if --with-ghci given, .o
installLib :: Verbosity -> LocalBuildInfo -> FilePath -> FilePath -> FilePath -> PackageDescription -> Library -> ComponentLocalBuildInfo -> IO ()
-- | Install foreign library for GHC.
installFLib :: Verbosity -> LocalBuildInfo -> FilePath -> FilePath -> PackageDescription -> ForeignLib -> IO ()
-- | Install executables for GHC.
installExe :: Verbosity -> LocalBuildInfo -> FilePath -> FilePath -> (FilePath, FilePath) -> PackageDescription -> Executable -> IO ()
-- | Extracts a String representing a hash of the ABI of a built library.
-- It can fail if the library has not yet been built.
libAbiHash :: Verbosity -> PackageDescription -> LocalBuildInfo -> Library -> ComponentLocalBuildInfo -> IO String
hcPkgInfo :: ProgramDb -> HcPkgInfo
registerPackage :: Verbosity -> ProgramDb -> PackageDBStack -> InstalledPackageInfo -> RegisterOptions -> IO ()
componentGhcOptions :: Verbosity -> LocalBuildInfo -> BuildInfo -> ComponentLocalBuildInfo -> FilePath -> GhcOptions
componentCcGhcOptions :: Verbosity -> LocalBuildInfo -> BuildInfo -> ComponentLocalBuildInfo -> FilePath -> FilePath -> GhcOptions
-- | Return the FilePath to the GHC application data directory.
getGhcAppDir :: IO FilePath
getLibDir :: Verbosity -> LocalBuildInfo -> IO FilePath
isDynamic :: Compiler -> Bool
-- | Return the FilePath to the global GHC package database.
getGlobalPackageDB :: Verbosity -> ConfiguredProgram -> IO FilePath
pkgRoot :: Verbosity -> LocalBuildInfo -> PackageDB -> IO FilePath
-- | The kinds of entries we can stick in a .ghc.environment file.
data GhcEnvironmentFileEntry
-- |
-- -- a comment
--
GhcEnvFileComment :: String -> GhcEnvironmentFileEntry
-- |
-- package-id foo-1.0-4fe301a...
--
GhcEnvFilePackageId :: UnitId -> GhcEnvironmentFileEntry
-- | global-package-db, user-package-db or package-db
-- blahpackage.conf.d
GhcEnvFilePackageDb :: PackageDB -> GhcEnvironmentFileEntry
-- |
-- clear-package-db
--
GhcEnvFileClearPackageDbStack :: GhcEnvironmentFileEntry
-- | Make entries for a GHC environment file based on a
-- PackageDBStack and a bunch of package (unit) ids.
--
-- If you need to do anything more complicated then either use this as a
-- basis and add more entries, or just make all the entries directly.
simpleGhcEnvironmentFile :: PackageDBStack -> [UnitId] -> [GhcEnvironmentFileEntry]
-- | Render a bunch of GHC environment file entries
renderGhcEnvironmentFile :: [GhcEnvironmentFileEntry] -> String
-- | Write a .ghc.environment-$arch-$os-$ver file in the given
-- directory.
--
-- The Platform and GHC Version are needed as part of the
-- file name.
--
-- Returns the name of the file written.
writeGhcEnvironmentFile :: FilePath -> Platform -> Version -> [GhcEnvironmentFileEntry] -> IO FilePath
-- | GHC's rendering of its platform and compiler version string as used in
-- certain file locations (such as user package db location). For example
-- x86_64-linux-7.10.4
ghcPlatformAndVersionString :: Platform -> Version -> String
readGhcEnvironmentFile :: FilePath -> IO [GhcEnvironmentFileEntry]
parseGhcEnvironmentFile :: Parser [GhcEnvironmentFileEntry]
newtype ParseErrorExc
ParseErrorExc :: ParseError -> ParseErrorExc
getImplInfo :: Compiler -> GhcImplInfo
-- | Information about features and quirks of a GHC-based implementation.
--
-- Compiler flavors based on GHC behave similarly enough that some of the
-- support code for them is shared. Every implementation has its own
-- peculiarities, that may or may not be a direct result of the
-- underlying GHC version. This record keeps track of these differences.
--
-- All shared code (i.e. everything not in the Distribution.Simple.FLAVOR
-- module) should use implementation info rather than version numbers to
-- test for supported features.
data GhcImplInfo
GhcImplInfo :: Bool -> Bool -> Bool -> Bool -> Bool -> Bool -> Bool -> Bool -> Bool -> Bool -> Bool -> GhcImplInfo
-- |
-- - XHaskell2010 and -XHaskell98 flags
--
[supportsHaskell2010] :: GhcImplInfo -> Bool
-- |
[supportsGHC2021] :: GhcImplInfo -> Bool
-- |
-- - -supported-languages gives Ext and NoExt
--
[reportsNoExt] :: GhcImplInfo -> Bool
-- | NondecreasingIndentation is always on
[alwaysNondecIndent] :: GhcImplInfo -> Bool
-- |
-- - ghci-script flag supported
--
[flagGhciScript] :: GhcImplInfo -> Bool
-- | new style -fprof-auto* flags
[flagProfAuto] :: GhcImplInfo -> Bool
-- | use package-conf instead of package-db
[flagPackageConf] :: GhcImplInfo -> Bool
-- |
[flagDebugInfo] :: GhcImplInfo -> Bool
-- | supports numeric -g levels
[supportsDebugLevels] :: GhcImplInfo -> Bool
-- | picks up .ghc.environment files
[supportsPkgEnvFiles] :: GhcImplInfo -> Bool
-- |
-- - Wmissing-home-modules is supported
--
[flagWarnMissingHomeModules] :: GhcImplInfo -> Bool
-- | This module defines a simple JSON-based format for exporting basic
-- information about a Cabal package and the compiler configuration Cabal
-- would use to build it. This can be produced with the cabal
-- new-show-build-info command.
--
-- This format is intended for consumption by external tooling and should
-- therefore be rather stable. Moreover, this allows tooling users to
-- avoid linking against Cabal. This is an important advantage as direct
-- API usage tends to be rather fragile in the presence of user-initiated
-- upgrades of Cabal.
--
-- Below is an example of the output this module produces,
--
--
-- { "cabal-version": "1.23.0.0",
-- "compiler": {
-- "flavour": GHC,
-- "compiler-id": "ghc-7.10.2",
-- "path": "usrbin/ghc",
-- },
-- "components": [
-- { "type": "lib",
-- "name": "lib:Cabal",
-- "compiler-args":
-- ["-O", "-XHaskell98", "-Wall",
-- "-package-id", "parallel-3.2.0.6-b79c38c5c25fff77f3ea7271851879eb"]
-- "modules": [Project.ModA, Project.ModB, Paths_project],
-- "src-files": [],
-- "src-dirs": ["src"]
-- }
-- ]
-- }
--
--
-- The cabal-version property provides the version of the Cabal
-- library which generated the output. The compiler property
-- gives some basic information about the compiler Cabal would use to
-- compile the package.
--
-- The components property gives a list of the Cabal
-- Components defined by the package. Each has,
--
--
-- - type: the type of the component (one of lib,
-- exe, test, bench, or flib)
-- - name: a string serving to uniquely identify the component
-- within the package.
-- - compiler-args: the command-line arguments Cabal would
-- pass to the compiler to compile the component
-- - modules: the modules belonging to the component
-- - src-dirs: a list of directories where the modules might
-- be found
-- - src-files: any other Haskell sources needed by the
-- component
--
--
-- Note: At the moment this is only supported when using the GHC
-- compiler.
module Distribution.Simple.ShowBuildInfo
-- | Construct a JSON document describing the build information for a
-- package.
mkBuildInfo :: PackageDescription -> LocalBuildInfo -> BuildFlags -> [TargetInfo] -> Json
-- | This is the entry point into installing a built package. Performs the
-- "./setup install" and "./setup copy" actions. It
-- moves files into place based on the prefix argument. It does the
-- generic bits and then calls compiler-specific functions to do the
-- rest.
module Distribution.Simple.Install
-- | Perform the "./setup install" and "./setup copy"
-- actions. Move files into place based on the prefix argument.
--
-- This does NOT register libraries, you should call register to
-- do that.
install :: PackageDescription -> LocalBuildInfo -> CopyFlags -> IO ()
-- | See
-- https://github.com/ezyang/ghc-proposals/blob/backpack/proposals/0000-backpack.rst
module Distribution.Backpack.ModuleShape
-- | A ModuleShape describes the provisions and requirements of a
-- library. We can extract a ModuleShape from an
-- InstalledPackageInfo.
data ModuleShape
ModuleShape :: OpenModuleSubst -> Set ModuleName -> ModuleShape
[modShapeProvides] :: ModuleShape -> OpenModuleSubst
[modShapeRequires] :: ModuleShape -> Set ModuleName
-- | The default module shape, with no provisions and no requirements.
emptyModuleShape :: ModuleShape
shapeInstalledPackage :: InstalledPackageInfo -> ModuleShape
instance GHC.Generics.Generic Distribution.Backpack.ModuleShape.ModuleShape
instance GHC.Show.Show Distribution.Backpack.ModuleShape.ModuleShape
instance GHC.Classes.Eq Distribution.Backpack.ModuleShape.ModuleShape
instance Data.Binary.Class.Binary Distribution.Backpack.ModuleShape.ModuleShape
instance Distribution.Utils.Structured.Structured Distribution.Backpack.ModuleShape.ModuleShape
instance Distribution.Backpack.ModSubst.ModSubst Distribution.Backpack.ModuleShape.ModuleShape
module Distribution.Backpack.PreModuleShape
data PreModuleShape
PreModuleShape :: Set ModuleName -> Set ModuleName -> PreModuleShape
[preModShapeProvides] :: PreModuleShape -> Set ModuleName
[preModShapeRequires] :: PreModuleShape -> Set ModuleName
toPreModuleShape :: ModuleShape -> PreModuleShape
renamePreModuleShape :: PreModuleShape -> IncludeRenaming -> PreModuleShape
mixLinkPreModuleShape :: [PreModuleShape] -> PreModuleShape
instance GHC.Generics.Generic Distribution.Backpack.PreModuleShape.PreModuleShape
instance GHC.Show.Show Distribution.Backpack.PreModuleShape.PreModuleShape
instance GHC.Classes.Eq Distribution.Backpack.PreModuleShape.PreModuleShape
-- | See
-- https://github.com/ezyang/ghc-proposals/blob/backpack/proposals/0000-backpack.rst
module Distribution.Backpack.LinkedComponent
-- | A linked component is a component that has been mix-in linked, at
-- which point we have determined how all the dependencies of the
-- component are explicitly instantiated (in the form of an OpenUnitId).
-- ConfiguredComponent is mix-in linked into
-- LinkedComponent, which is then instantiated into
-- ReadyComponent.
data LinkedComponent
LinkedComponent :: AnnotatedId ComponentId -> Component -> [AnnotatedId OpenUnitId] -> Bool -> [ComponentInclude OpenUnitId ModuleRenaming] -> [ComponentInclude OpenUnitId ModuleRenaming] -> ModuleShape -> LinkedComponent
-- | Uniquely identifies linked component
[lc_ann_id] :: LinkedComponent -> AnnotatedId ComponentId
-- | Corresponds to cc_component.
[lc_component] :: LinkedComponent -> Component
-- | build-tools and build-tool-depends dependencies.
-- Corresponds to cc_exe_deps.
[lc_exe_deps] :: LinkedComponent -> [AnnotatedId OpenUnitId]
-- | Is this the public library of a package? Corresponds to
-- cc_public.
[lc_public] :: LinkedComponent -> Bool
-- | Corresponds to cc_includes, but (1) this does not contain
-- includes of signature packages (packages with no exports), and (2) the
-- ModuleRenaming for requirements (stored in
-- IncludeRenaming) has been removed, as it is reflected in
-- OpenUnitId.)
[lc_includes] :: LinkedComponent -> [ComponentInclude OpenUnitId ModuleRenaming]
-- | Like lc_includes, but this specifies includes on signature
-- packages which have no exports.
[lc_sig_includes] :: LinkedComponent -> [ComponentInclude OpenUnitId ModuleRenaming]
-- | The module shape computed by mix-in linking. This is newly computed
-- from ConfiguredComponent
[lc_shape] :: LinkedComponent -> ModuleShape
-- | The instantiation of lc_uid; this always has the invariant that
-- it is a mapping from a module name A to A
-- (the hole A).
lc_insts :: LinkedComponent -> [(ModuleName, OpenModule)]
-- | The OpenUnitId of this component in the "default"
-- instantiation. See also lc_insts. LinkedComponents
-- cannot be instantiated (e.g., there is no ModSubst instance
-- for them).
lc_uid :: LinkedComponent -> OpenUnitId
-- | Uniquely identifies a LinkedComponent. Corresponds to
-- cc_cid.
lc_cid :: LinkedComponent -> ComponentId
-- | Corresponds to cc_pkgid.
lc_pkgid :: LinkedComponent -> PackageId
toLinkedComponent :: Verbosity -> FullDb -> PackageId -> LinkedComponentMap -> ConfiguredComponent -> LogProgress LinkedComponent
toLinkedComponents :: Verbosity -> FullDb -> PackageId -> LinkedComponentMap -> [ConfiguredComponent] -> LogProgress [LinkedComponent]
dispLinkedComponent :: LinkedComponent -> Doc
type LinkedComponentMap = Map ComponentId (OpenUnitId, ModuleShape)
extendLinkedComponentMap :: LinkedComponent -> LinkedComponentMap -> LinkedComponentMap
instance Distribution.Package.Package Distribution.Backpack.LinkedComponent.LinkedComponent
module Distribution.Compat.Time
-- | An opaque type representing a file's modification time, represented
-- internally as a 64-bit unsigned integer in the Windows UTC format.
newtype ModTime
ModTime :: Word64 -> ModTime
-- | Return modification time of the given file. Works around the low clock
-- resolution problem that getModificationTime has on GHC <
-- 7.8.
--
-- This is a modified version of the code originally written for Shake by
-- Neil Mitchell. See module Development.Shake.FileInfo.
getModTime :: FilePath -> IO ModTime
-- | Return age of given file in days.
getFileAge :: FilePath -> IO Double
-- | Return the current time as ModTime.
getCurTime :: IO ModTime
-- | Convert POSIX seconds to ModTime.
posixSecondsToModTime :: Int64 -> ModTime
-- | Based on code written by Neil Mitchell for Shake. See
-- sleepFileTimeCalibrate in Type. Returns a pair of
-- microsecond values: first, the maximum delay seen, and the recommended
-- delay to use before testing for file modification change. The returned
-- delay is never smaller than 10 ms, but never larger than 1 second.
calibrateMtimeChangeDelay :: IO (Int, Int)
instance GHC.Classes.Ord Distribution.Compat.Time.ModTime
instance GHC.Classes.Eq Distribution.Compat.Time.ModTime
instance GHC.Enum.Bounded Distribution.Compat.Time.ModTime
instance GHC.Generics.Generic Distribution.Compat.Time.ModTime
instance Data.Binary.Class.Binary Distribution.Compat.Time.ModTime
instance Distribution.Utils.Structured.Structured Distribution.Compat.Time.ModTime
instance GHC.Show.Show Distribution.Compat.Time.ModTime
instance GHC.Read.Read Distribution.Compat.Time.ModTime
-- | See
-- https://github.com/ezyang/ghc-proposals/blob/backpack/proposals/0000-backpack.rst
--
-- WARNING: The contents of this module are HIGHLY experimental. We may
-- refactor it under you.
module Distribution.Backpack.Configure
configureComponentLocalBuildInfos :: Verbosity -> Bool -> ComponentRequestedSpec -> Bool -> Flag String -> Flag ComponentId -> PackageDescription -> [PreExistingComponent] -> FlagAssignment -> [(ModuleName, Module)] -> InstalledPackageIndex -> Compiler -> LogProgress ([ComponentLocalBuildInfo], InstalledPackageIndex)
module Distribution.Backpack.DescribeUnitId
-- | Print a Setup message stating (1) what operation we are doing, for (2)
-- which component (with enough details to uniquely identify the build in
-- question.)
setupMessage' :: Pretty a => Verbosity -> String -> PackageIdentifier -> ComponentName -> Maybe [(ModuleName, a)] -> IO ()
-- | This module deals with registering and unregistering packages. There
-- are a couple ways it can do this, one is to do it directly. Another is
-- to generate a script that can be run later to do it. The idea here
-- being that the user is shielded from the details of what command to
-- use for package registration for a particular compiler. In practice
-- this aspect was not especially popular so we also provide a way to
-- simply generate the package registration file which then must be
-- manually passed to ghc-pkg. It is possible to generate
-- registration information for where the package is to be installed, or
-- alternatively to register the package in place in the build tree. The
-- latter is occasionally handy, and will become more important when we
-- try to build multi-package systems.
--
-- This module does not delegate anything to the per-compiler modules but
-- just mixes it all in this module, which is rather unsatisfactory. The
-- script generation and the unregister feature are not well used or
-- tested.
module Distribution.Simple.Register
register :: PackageDescription -> LocalBuildInfo -> RegisterFlags -> IO ()
unregister :: PackageDescription -> LocalBuildInfo -> RegisterFlags -> IO ()
internalPackageDBPath :: LocalBuildInfo -> FilePath -> FilePath
initPackageDB :: Verbosity -> Compiler -> ProgramDb -> FilePath -> IO ()
doesPackageDBExist :: FilePath -> IO Bool
-- | Create an empty package DB at the specified location.
createPackageDB :: Verbosity -> Compiler -> ProgramDb -> Bool -> FilePath -> IO ()
deletePackageDB :: FilePath -> IO ()
-- | Compute the AbiHash of a library that we built inplace.
abiHash :: Verbosity -> PackageDescription -> FilePath -> LocalBuildInfo -> Library -> ComponentLocalBuildInfo -> IO AbiHash
-- | Run hc-pkg using a given package DB stack, directly
-- forwarding the provided command-line arguments to it.
invokeHcPkg :: Verbosity -> Compiler -> ProgramDb -> PackageDBStack -> [String] -> IO ()
registerPackage :: Verbosity -> Compiler -> ProgramDb -> PackageDBStack -> InstalledPackageInfo -> RegisterOptions -> IO ()
-- | Additional variations in the behaviour for register.
data RegisterOptions
RegisterOptions :: Bool -> Bool -> Bool -> RegisterOptions
-- | Allows re-registering / overwriting an existing package
[registerAllowOverwrite] :: RegisterOptions -> Bool
-- | Insist on the ability to register multiple instances of a single
-- version of a single package. This will fail if the hc-pkg
-- does not support it, see nativeMultiInstance and
-- recacheMultiInstance.
[registerMultiInstance] :: RegisterOptions -> Bool
-- | Require that no checks are performed on the existence of package files
-- mentioned in the registration info. This must be used if registering
-- prior to putting the files in their final place. This will fail if the
-- hc-pkg does not support it, see suppressFilesCheck.
[registerSuppressFilesCheck] :: RegisterOptions -> Bool
-- | Defaults are True, False and False
defaultRegisterOptions :: RegisterOptions
generateRegistrationInfo :: Verbosity -> PackageDescription -> Library -> LocalBuildInfo -> ComponentLocalBuildInfo -> Bool -> Bool -> FilePath -> PackageDB -> IO InstalledPackageInfo
-- | Construct InstalledPackageInfo for a library that is in place
-- in the build tree.
--
-- This function knows about the layout of in place packages.
inplaceInstalledPackageInfo :: FilePath -> FilePath -> PackageDescription -> AbiHash -> Library -> LocalBuildInfo -> ComponentLocalBuildInfo -> InstalledPackageInfo
-- | Construct InstalledPackageInfo for the final install location
-- of a library package.
--
-- This function knows about the layout of installed packages.
absoluteInstalledPackageInfo :: PackageDescription -> AbiHash -> Library -> LocalBuildInfo -> ComponentLocalBuildInfo -> InstalledPackageInfo
-- | Construct InstalledPackageInfo for a library in a package,
-- given a set of installation directories.
generalInstalledPackageInfo :: ([FilePath] -> [FilePath]) -> PackageDescription -> AbiHash -> Library -> LocalBuildInfo -> ComponentLocalBuildInfo -> InstallDirs FilePath -> InstalledPackageInfo
-- | This defines a PreProcessor abstraction which represents a
-- pre-processor that can transform one kind of file into another. There
-- is also a PPSuffixHandler which is a combination of a file
-- extension and a function for configuring a PreProcessor. It
-- defines a bunch of known built-in preprocessors like cpp,
-- cpphs, c2hs, hsc2hs, happy,
-- alex etc and lists them in knownSuffixHandlers. On top
-- of this it provides a function for actually preprocessing some sources
-- given a bunch of known suffix handlers. This module is not as good as
-- it could be, it could really do with a rewrite to address some of the
-- problems we have with pre-processors.
module Distribution.Simple.PreProcess
-- | Apply preprocessors to the sources from hsSourceDirs for a
-- given component (lib, exe, or test suite).
--
-- XXX: This is terrible
preprocessComponent :: PackageDescription -> Component -> LocalBuildInfo -> ComponentLocalBuildInfo -> Bool -> Verbosity -> [PPSuffixHandler] -> IO ()
-- | Find any extra C sources generated by preprocessing that need to be
-- added to the component (addresses issue #238).
preprocessExtras :: Verbosity -> Component -> LocalBuildInfo -> IO [FilePath]
-- | Standard preprocessors: GreenCard, c2hs, hsc2hs, happy, alex and
-- cpphs.
knownSuffixHandlers :: [PPSuffixHandler]
-- | Convenience function; get the suffixes of these preprocessors.
ppSuffixes :: [PPSuffixHandler] -> [String]
-- | A preprocessor for turning non-Haskell files with the given extension
-- into plain Haskell source files.
type PPSuffixHandler = (String, BuildInfo -> LocalBuildInfo -> ComponentLocalBuildInfo -> PreProcessor)
-- | The interface to a preprocessor, which may be implemented using an
-- external program, but need not be. The arguments are the name of the
-- input file, the name of the output file and a verbosity level. Here is
-- a simple example that merely prepends a comment to the given source
-- file:
--
--
-- ppTestHandler :: PreProcessor
-- ppTestHandler =
-- PreProcessor {
-- platformIndependent = True,
-- runPreProcessor = mkSimplePreProcessor $ \inFile outFile verbosity ->
-- do info verbosity (inFile++" has been preprocessed to "++outFile)
-- stuff <- readFile inFile
-- writeFile outFile ("-- preprocessed as a test\n\n" ++ stuff)
-- return ExitSuccess
--
--
-- We split the input and output file names into a base directory and the
-- rest of the file name. The input base dir is the path in the list of
-- search dirs that this file was found in. The output base dir is the
-- build dir where all the generated source files are put.
--
-- The reason for splitting it up this way is that some pre-processors
-- don't simply generate one output .hs file from one input file but have
-- dependencies on other generated files (notably c2hs, where building
-- one .hs file may require reading other .chi files, and then compiling
-- the .hs file may require reading a generated .h file). In these cases
-- the generated files need to embed relative path names to each other
-- (eg the generated .hs file mentions the .h file in the FFI imports).
-- This path must be relative to the base directory where the generated
-- files are located, it cannot be relative to the top level of the build
-- tree because the compilers do not look for .h files relative to there,
-- ie we do not use "-I .", instead we use "-I dist/build" (or whatever
-- dist dir has been set by the user)
--
-- Most pre-processors do not care of course, so mkSimplePreProcessor and
-- runSimplePreProcessor functions handle the simple case.
data PreProcessor
PreProcessor :: Bool -> ((FilePath, FilePath) -> (FilePath, FilePath) -> Verbosity -> IO ()) -> PreProcessor
[platformIndependent] :: PreProcessor -> Bool
[runPreProcessor] :: PreProcessor -> (FilePath, FilePath) -> (FilePath, FilePath) -> Verbosity -> IO ()
mkSimplePreProcessor :: (FilePath -> FilePath -> Verbosity -> IO ()) -> (FilePath, FilePath) -> (FilePath, FilePath) -> Verbosity -> IO ()
runSimplePreProcessor :: PreProcessor -> FilePath -> FilePath -> Verbosity -> IO ()
ppCpp :: BuildInfo -> LocalBuildInfo -> ComponentLocalBuildInfo -> PreProcessor
ppCpp' :: [String] -> BuildInfo -> LocalBuildInfo -> ComponentLocalBuildInfo -> PreProcessor
ppGreenCard :: BuildInfo -> LocalBuildInfo -> ComponentLocalBuildInfo -> PreProcessor
ppC2hs :: BuildInfo -> LocalBuildInfo -> ComponentLocalBuildInfo -> PreProcessor
ppHsc2hs :: BuildInfo -> LocalBuildInfo -> ComponentLocalBuildInfo -> PreProcessor
ppHappy :: BuildInfo -> LocalBuildInfo -> ComponentLocalBuildInfo -> PreProcessor
ppAlex :: BuildInfo -> LocalBuildInfo -> ComponentLocalBuildInfo -> PreProcessor
ppUnlit :: PreProcessor
platformDefines :: LocalBuildInfo -> [String]
-- | This defines the API that Setup.hs scripts can use to
-- customise the way the build works. This module just defines the
-- UserHooks type. The predefined sets of hooks that implement the
-- Simple, Make and Configure build systems
-- are defined in Distribution.Simple. The UserHooks is a
-- big record of functions. There are 3 for each action, a pre, post and
-- the action itself. There are few other miscellaneous hooks, ones to
-- extend the set of programs and preprocessors and one to override the
-- function used to read the .cabal file.
--
-- This hooks type is widely agreed to not be the right solution. Partly
-- this is because changes to it usually break custom Setup.hs
-- files and yet many internal code changes do require changes to the
-- hooks. For example we cannot pass any extra parameters to most of the
-- functions that implement the various phases because it would involve
-- changing the types of the corresponding hook. At some point it will
-- have to be replaced.
module Distribution.Simple.UserHooks
-- | Hooks allow authors to add specific functionality before and after a
-- command is run, and also to specify additional preprocessors.
--
--
-- - WARNING: The hooks interface is under rather constant flux as we
-- try to understand users needs. Setup files that depend on this
-- interface may break in future releases.
--
data UserHooks
UserHooks :: IO (Maybe GenericPackageDescription) -> [PPSuffixHandler] -> [Program] -> (Args -> ConfigFlags -> IO HookedBuildInfo) -> ((GenericPackageDescription, HookedBuildInfo) -> ConfigFlags -> IO LocalBuildInfo) -> (Args -> ConfigFlags -> PackageDescription -> LocalBuildInfo -> IO ()) -> (Args -> BuildFlags -> IO HookedBuildInfo) -> (PackageDescription -> LocalBuildInfo -> UserHooks -> BuildFlags -> IO ()) -> (Args -> BuildFlags -> PackageDescription -> LocalBuildInfo -> IO ()) -> (Args -> ReplFlags -> IO HookedBuildInfo) -> (PackageDescription -> LocalBuildInfo -> UserHooks -> ReplFlags -> [String] -> IO ()) -> (Args -> ReplFlags -> PackageDescription -> LocalBuildInfo -> IO ()) -> (Args -> CleanFlags -> IO HookedBuildInfo) -> (PackageDescription -> () -> UserHooks -> CleanFlags -> IO ()) -> (Args -> CleanFlags -> PackageDescription -> () -> IO ()) -> (Args -> CopyFlags -> IO HookedBuildInfo) -> (PackageDescription -> LocalBuildInfo -> UserHooks -> CopyFlags -> IO ()) -> (Args -> CopyFlags -> PackageDescription -> LocalBuildInfo -> IO ()) -> (Args -> InstallFlags -> IO HookedBuildInfo) -> (PackageDescription -> LocalBuildInfo -> UserHooks -> InstallFlags -> IO ()) -> (Args -> InstallFlags -> PackageDescription -> LocalBuildInfo -> IO ()) -> (Args -> RegisterFlags -> IO HookedBuildInfo) -> (PackageDescription -> LocalBuildInfo -> UserHooks -> RegisterFlags -> IO ()) -> (Args -> RegisterFlags -> PackageDescription -> LocalBuildInfo -> IO ()) -> (Args -> RegisterFlags -> IO HookedBuildInfo) -> (PackageDescription -> LocalBuildInfo -> UserHooks -> RegisterFlags -> IO ()) -> (Args -> RegisterFlags -> PackageDescription -> LocalBuildInfo -> IO ()) -> (Args -> HscolourFlags -> IO HookedBuildInfo) -> (PackageDescription -> LocalBuildInfo -> UserHooks -> HscolourFlags -> IO ()) -> (Args -> HscolourFlags -> PackageDescription -> LocalBuildInfo -> IO ()) -> (Args -> HaddockFlags -> IO HookedBuildInfo) -> (PackageDescription -> LocalBuildInfo -> UserHooks -> HaddockFlags -> IO ()) -> (Args -> HaddockFlags -> PackageDescription -> LocalBuildInfo -> IO ()) -> (Args -> TestFlags -> IO HookedBuildInfo) -> (Args -> PackageDescription -> LocalBuildInfo -> UserHooks -> TestFlags -> IO ()) -> (Args -> TestFlags -> PackageDescription -> LocalBuildInfo -> IO ()) -> (Args -> BenchmarkFlags -> IO HookedBuildInfo) -> (Args -> PackageDescription -> LocalBuildInfo -> UserHooks -> BenchmarkFlags -> IO ()) -> (Args -> BenchmarkFlags -> PackageDescription -> LocalBuildInfo -> IO ()) -> UserHooks
-- | Read the description file
[readDesc] :: UserHooks -> IO (Maybe GenericPackageDescription)
-- | Custom preprocessors in addition to and overriding
-- knownSuffixHandlers.
[hookedPreProcessors] :: UserHooks -> [PPSuffixHandler]
-- | These programs are detected at configure time. Arguments for them are
-- added to the configure command.
[hookedPrograms] :: UserHooks -> [Program]
-- | Hook to run before configure command
[preConf] :: UserHooks -> Args -> ConfigFlags -> IO HookedBuildInfo
-- | Over-ride this hook to get different behavior during configure.
[confHook] :: UserHooks -> (GenericPackageDescription, HookedBuildInfo) -> ConfigFlags -> IO LocalBuildInfo
-- | Hook to run after configure command
[postConf] :: UserHooks -> Args -> ConfigFlags -> PackageDescription -> LocalBuildInfo -> IO ()
-- | Hook to run before build command. Second arg indicates verbosity
-- level.
[preBuild] :: UserHooks -> Args -> BuildFlags -> IO HookedBuildInfo
-- | Over-ride this hook to get different behavior during build.
[buildHook] :: UserHooks -> PackageDescription -> LocalBuildInfo -> UserHooks -> BuildFlags -> IO ()
-- | Hook to run after build command. Second arg indicates verbosity level.
[postBuild] :: UserHooks -> Args -> BuildFlags -> PackageDescription -> LocalBuildInfo -> IO ()
-- | Hook to run before repl command. Second arg indicates verbosity level.
[preRepl] :: UserHooks -> Args -> ReplFlags -> IO HookedBuildInfo
-- | Over-ride this hook to get different behavior during interpretation.
[replHook] :: UserHooks -> PackageDescription -> LocalBuildInfo -> UserHooks -> ReplFlags -> [String] -> IO ()
-- | Hook to run after repl command. Second arg indicates verbosity level.
[postRepl] :: UserHooks -> Args -> ReplFlags -> PackageDescription -> LocalBuildInfo -> IO ()
-- | Hook to run before clean command. Second arg indicates verbosity
-- level.
[preClean] :: UserHooks -> Args -> CleanFlags -> IO HookedBuildInfo
-- | Over-ride this hook to get different behavior during clean.
[cleanHook] :: UserHooks -> PackageDescription -> () -> UserHooks -> CleanFlags -> IO ()
-- | Hook to run after clean command. Second arg indicates verbosity level.
[postClean] :: UserHooks -> Args -> CleanFlags -> PackageDescription -> () -> IO ()
-- | Hook to run before copy command
[preCopy] :: UserHooks -> Args -> CopyFlags -> IO HookedBuildInfo
-- | Over-ride this hook to get different behavior during copy.
[copyHook] :: UserHooks -> PackageDescription -> LocalBuildInfo -> UserHooks -> CopyFlags -> IO ()
-- | Hook to run after copy command
[postCopy] :: UserHooks -> Args -> CopyFlags -> PackageDescription -> LocalBuildInfo -> IO ()
-- | Hook to run before install command
[preInst] :: UserHooks -> Args -> InstallFlags -> IO HookedBuildInfo
-- | Over-ride this hook to get different behavior during install.
[instHook] :: UserHooks -> PackageDescription -> LocalBuildInfo -> UserHooks -> InstallFlags -> IO ()
-- | Hook to run after install command. postInst should be run on the
-- target, not on the build machine.
[postInst] :: UserHooks -> Args -> InstallFlags -> PackageDescription -> LocalBuildInfo -> IO ()
-- | Hook to run before register command
[preReg] :: UserHooks -> Args -> RegisterFlags -> IO HookedBuildInfo
-- | Over-ride this hook to get different behavior during registration.
[regHook] :: UserHooks -> PackageDescription -> LocalBuildInfo -> UserHooks -> RegisterFlags -> IO ()
-- | Hook to run after register command
[postReg] :: UserHooks -> Args -> RegisterFlags -> PackageDescription -> LocalBuildInfo -> IO ()
-- | Hook to run before unregister command
[preUnreg] :: UserHooks -> Args -> RegisterFlags -> IO HookedBuildInfo
-- | Over-ride this hook to get different behavior during unregistration.
[unregHook] :: UserHooks -> PackageDescription -> LocalBuildInfo -> UserHooks -> RegisterFlags -> IO ()
-- | Hook to run after unregister command
[postUnreg] :: UserHooks -> Args -> RegisterFlags -> PackageDescription -> LocalBuildInfo -> IO ()
-- | Hook to run before hscolour command. Second arg indicates verbosity
-- level.
[preHscolour] :: UserHooks -> Args -> HscolourFlags -> IO HookedBuildInfo
-- | Over-ride this hook to get different behavior during hscolour.
[hscolourHook] :: UserHooks -> PackageDescription -> LocalBuildInfo -> UserHooks -> HscolourFlags -> IO ()
-- | Hook to run after hscolour command. Second arg indicates verbosity
-- level.
[postHscolour] :: UserHooks -> Args -> HscolourFlags -> PackageDescription -> LocalBuildInfo -> IO ()
-- | Hook to run before haddock command. Second arg indicates verbosity
-- level.
[preHaddock] :: UserHooks -> Args -> HaddockFlags -> IO HookedBuildInfo
-- | Over-ride this hook to get different behavior during haddock.
[haddockHook] :: UserHooks -> PackageDescription -> LocalBuildInfo -> UserHooks -> HaddockFlags -> IO ()
-- | Hook to run after haddock command. Second arg indicates verbosity
-- level.
[postHaddock] :: UserHooks -> Args -> HaddockFlags -> PackageDescription -> LocalBuildInfo -> IO ()
-- | Hook to run before test command.
[preTest] :: UserHooks -> Args -> TestFlags -> IO HookedBuildInfo
-- | Over-ride this hook to get different behavior during test.
[testHook] :: UserHooks -> Args -> PackageDescription -> LocalBuildInfo -> UserHooks -> TestFlags -> IO ()
-- | Hook to run after test command.
[postTest] :: UserHooks -> Args -> TestFlags -> PackageDescription -> LocalBuildInfo -> IO ()
-- | Hook to run before bench command.
[preBench] :: UserHooks -> Args -> BenchmarkFlags -> IO HookedBuildInfo
-- | Over-ride this hook to get different behavior during bench.
[benchHook] :: UserHooks -> Args -> PackageDescription -> LocalBuildInfo -> UserHooks -> BenchmarkFlags -> IO ()
-- | Hook to run after bench command.
[postBench] :: UserHooks -> Args -> BenchmarkFlags -> PackageDescription -> LocalBuildInfo -> IO ()
type Args = [String]
-- | Empty UserHooks which do nothing.
emptyUserHooks :: UserHooks
-- | This is the entry point into testing a built package. It performs the
-- "./setup test" action. It runs test suites designated in the
-- package description and reports on the results.
module Distribution.Simple.Test
-- | Perform the "./setup test" action.
test :: Args -> PackageDescription -> LocalBuildInfo -> TestFlags -> IO ()
-- | This is the entry point into running the benchmarks in a built
-- package. It performs the "./setup bench" action. It runs
-- benchmarks designated in the package description.
module Distribution.Simple.Bench
-- | Perform the "./setup bench" action.
bench :: Args -> PackageDescription -> LocalBuildInfo -> BenchmarkFlags -> IO ()
-- | This deals with the configure phase. It provides the
-- configure action which is given the package description and
-- configure flags. It then tries to: configure the compiler; resolves
-- any conditionals in the package description; resolve the package
-- dependencies; check if all the extensions used by this package are
-- supported by the compiler; check that all the build tools are
-- available (including version checks if appropriate); checks for any
-- required pkg-config packages (updating the BuildInfo
-- with the results)
--
-- Then based on all this it saves the info in the LocalBuildInfo
-- and writes it out to the dist/setup-config file. It also
-- displays various details to the user, the amount of information
-- displayed depending on the verbosity level.
module Distribution.Simple.Configure
-- | Perform the "./setup configure" action. Returns the
-- .setup-config file.
configure :: (GenericPackageDescription, HookedBuildInfo) -> ConfigFlags -> IO LocalBuildInfo
-- | After running configure, output the LocalBuildInfo to the
-- localBuildInfoFile.
writePersistBuildConfig :: FilePath -> LocalBuildInfo -> IO ()
-- | Read the localBuildInfoFile. Throw an exception if the file is
-- missing, if the file cannot be read, or if the file was created by an
-- older version of Cabal.
getConfigStateFile :: FilePath -> IO LocalBuildInfo
-- | Read the localBuildInfoFile. Throw an exception if the file is
-- missing, if the file cannot be read, or if the file was created by an
-- older version of Cabal.
getPersistBuildConfig :: FilePath -> IO LocalBuildInfo
-- | Check that localBuildInfoFile is up-to-date with respect to the .cabal
-- file.
checkPersistBuildConfigOutdated :: FilePath -> FilePath -> IO Bool
-- | Try to read the localBuildInfoFile.
tryGetPersistBuildConfig :: FilePath -> IO (Either ConfigStateFileError LocalBuildInfo)
-- | Try to read the localBuildInfoFile.
maybeGetPersistBuildConfig :: FilePath -> IO (Maybe LocalBuildInfo)
-- | Return the "dist/" prefix, or the default prefix. The prefix is taken
-- from (in order of highest to lowest preference) the override prefix,
-- the "CABAL_BUILDDIR" environment variable, or the default prefix.
findDistPref :: FilePath -> Flag FilePath -> IO FilePath
-- | Return the "dist/" prefix, or the default prefix. The prefix is taken
-- from (in order of highest to lowest preference) the override prefix,
-- the "CABAL_BUILDDIR" environment variable, or defaultDistPref
-- is used. Call this function to resolve a *DistPref flag
-- whenever it is not known to be set. (The *DistPref flags are
-- always set to a definite value before invoking UserHooks.)
findDistPrefOrDefault :: Flag FilePath -> IO FilePath
-- | Create a PackageIndex that makes *any libraries that might be* defined
-- internally to this package look like installed packages, in case an
-- executable should refer to any of them as dependencies.
--
-- It must be *any libraries that might be* defined rather than the
-- actual definitions, because these depend on conditionals in the .cabal
-- file, and we haven't resolved them yet. finalizePD does the resolution
-- of conditionals, and it takes internalPackageSet as part of its input.
getInternalLibraries :: GenericPackageDescription -> Set LibraryName
-- | This method computes a default, "good enough" ComponentId for a
-- package. The intent is that cabal-install (or the user) will specify a
-- more detailed IPID via the --ipid flag if necessary.
computeComponentId :: Bool -> Flag String -> Flag ComponentId -> PackageIdentifier -> ComponentName -> Maybe ([ComponentId], FlagAssignment) -> ComponentId
-- | In GHC 8.0, the string we pass to GHC to use for symbol names for a
-- package can be an arbitrary, IPID-compatible string. However, prior to
-- GHC 8.0 there are some restrictions on what format this string can be
-- (due to how ghc-pkg parsed the key):
--
--
-- - In GHC 7.10, the string had either be of the form foo_ABCD, where
-- foo is a non-semantic alphanumeric/hyphenated prefix and ABCD is two
-- base-64 encoded 64-bit integers, or a GHC 7.8 style identifier.
-- - In GHC 7.8, the string had to be a valid package identifier like
-- foo-0.1.
--
--
-- So, the problem is that Cabal, in general, has a general IPID, but
-- needs to figure out a package key / package ID that the old ghc-pkg
-- will actually accept. But there's an EVERY WORSE problem: if ghc-pkg
-- decides to parse an identifier foo-0.1-xxx as if it were a package
-- identifier, which means it will SILENTLY DROP the "xxx" (because it's
-- a tag, and Cabal does not allow tags.) So we must CONNIVE to ensure
-- that we don't pick something that looks like this.
--
-- So this function attempts to define a mapping into the old formats.
--
-- The mapping for GHC 7.8 and before:
--
--
-- - We use the *compatibility* package name and version. For public
-- libraries this is just the package identifier; for internal libraries,
-- it's something like "z-pkgname-z-libname-0.1". See
-- computeCompatPackageName for more details.
--
--
-- The mapping for GHC 7.10:
--
--
-- - For CLibName: If the IPID is of the form foo-0.1-ABCDEF where
-- foo_ABCDEF would validly parse as a package key, we pass
-- ABCDEF. (NB: not all hashes parse this way, because GHC 7.10
-- mandated that these hashes be two base-62 encoded 64 bit integers),
-- but hashes that Cabal generated using computeComponentId are
-- guaranteed to have this form.If it is not of this form, we rehash the
-- IPID into the correct form and pass that.
-- - For sub-components, we rehash the IPID into the correct format and
-- pass that.
--
computeCompatPackageKey :: Compiler -> MungedPackageName -> Version -> UnitId -> String
-- | Get the path of dist/setup-config.
localBuildInfoFile :: FilePath -> FilePath
-- | List all installed packages in the given package databases.
-- Non-existent package databases do not cause errors, they just get
-- skipped with a warning and treated as empty ones, since technically
-- they do not contain any package.
getInstalledPackages :: Verbosity -> Compiler -> PackageDBStack -> ProgramDb -> IO InstalledPackageIndex
-- | A set of files (or directories) that can be monitored to detect when
-- there might have been a change in the installed packages.
getInstalledPackagesMonitorFiles :: Verbosity -> Compiler -> PackageDBStack -> ProgramDb -> Platform -> IO [FilePath]
-- | Like getInstalledPackages, but for a single package DB.
--
-- NB: Why isn't this always a fall through to
-- getInstalledPackages? That is because
-- getInstalledPackages performs some sanity checks on the package
-- database stack in question. However, when sandboxes are involved these
-- sanity checks are not desirable.
getPackageDBContents :: Verbosity -> Compiler -> PackageDB -> ProgramDb -> IO InstalledPackageIndex
configCompilerEx :: Maybe CompilerFlavor -> Maybe FilePath -> Maybe FilePath -> ProgramDb -> Verbosity -> IO (Compiler, Platform, ProgramDb)
configCompilerAuxEx :: ConfigFlags -> IO (Compiler, Platform, ProgramDb)
-- | Compute the effective value of the profiling flags
-- --enable-library-profiling and
-- --enable-executable-profiling from the specified
-- ConfigFlags. This may be useful for external Cabal tools which
-- need to interact with Setup in a backwards-compatible way: the most
-- predictable mechanism for enabling profiling across many legacy
-- versions is to NOT use --enable-profiling and use those two
-- flags instead.
--
-- Note that --enable-executable-profiling also affects
-- profiling of benchmarks and (non-detailed) test suites.
computeEffectiveProfiling :: ConfigFlags -> (Bool, Bool)
-- | Makes a BuildInfo from C compiler and linker flags.
--
-- This can be used with the output from configuration programs like
-- pkg-config and similar package-specific programs like mysql-config,
-- freealut-config etc. For example:
--
--
-- ccflags <- getDbProgramOutput verbosity prog progdb ["--cflags"]
-- ldflags <- getDbProgramOutput verbosity prog progdb ["--libs"]
-- return (ccldOptionsBuildInfo (words ccflags) (words ldflags))
--
ccLdOptionsBuildInfo :: [String] -> [String] -> BuildInfo
checkForeignDeps :: PackageDescription -> LocalBuildInfo -> Verbosity -> IO ()
-- | The user interface specifies the package dbs to use with a combination
-- of --global, --user and
-- --package-db=global|user|clear|$file. This function combines
-- the global/user flag and interprets the package-db flag into a single
-- package db stack.
interpretPackageDbFlags :: Bool -> [Maybe PackageDB] -> PackageDBStack
-- | The errors that can be thrown when reading the setup-config
-- file.
data ConfigStateFileError
-- | No header found.
ConfigStateFileNoHeader :: ConfigStateFileError
-- | Incorrect header.
ConfigStateFileBadHeader :: ConfigStateFileError
-- | Cannot parse file contents.
ConfigStateFileNoParse :: ConfigStateFileError
-- | No file!
ConfigStateFileMissing :: ConfigStateFileError
-- | Mismatched version.
ConfigStateFileBadVersion :: PackageIdentifier -> PackageIdentifier -> Either ConfigStateFileError LocalBuildInfo -> ConfigStateFileError
-- | Read the localBuildInfoFile, returning either an error or the
-- local build info.
tryGetConfigStateFile :: FilePath -> IO (Either ConfigStateFileError LocalBuildInfo)
platformDefines :: LocalBuildInfo -> [String]
instance GHC.Show.Show Distribution.Simple.Configure.ConfigStateFileError
instance GHC.Exception.Type.Exception Distribution.Simple.Configure.ConfigStateFileError
-- | This handles the sdist command. The module exports an
-- sdist action but also some of the phases that make it up so
-- that other tools can use just the bits they need. In particular the
-- preparation of the tree of files to go into the source tarball is
-- separated from actually building the source tarball.
--
-- The createArchive action uses the external tar program
-- and assumes that it accepts the -z flag. Neither of these
-- assumptions are valid on Windows. The sdist action now also
-- does some distribution QA checks.
module Distribution.Simple.SrcDist
-- | Create a source distribution.
sdist :: PackageDescription -> SDistFlags -> (FilePath -> FilePath) -> [PPSuffixHandler] -> IO ()
-- | Note: must be called with the CWD set to the directory containing the
-- '.cabal' file.
printPackageProblems :: Verbosity -> PackageDescription -> IO ()
-- | Prepare a directory tree of source files.
prepareTree :: Verbosity -> PackageDescription -> FilePath -> [PPSuffixHandler] -> IO ()
-- | Create an archive from a tree of source files, and clean up the tree.
createArchive :: Verbosity -> PackageDescription -> FilePath -> FilePath -> IO FilePath
-- | Prepare a directory tree of source files for a snapshot version. It is
-- expected that the appropriate snapshot version has already been set in
-- the package description, eg using snapshotPackage or
-- snapshotVersion.
prepareSnapshotTree :: Verbosity -> PackageDescription -> FilePath -> [PPSuffixHandler] -> IO ()
-- | Modifies a PackageDescription by appending a snapshot number
-- corresponding to the given date.
snapshotPackage :: UTCTime -> PackageDescription -> PackageDescription
-- | Modifies a Version by appending a snapshot number corresponding
-- to the given date.
snapshotVersion :: UTCTime -> Version -> Version
-- | Given a date produce a corresponding integer representation. For
-- example given a date 18032008 produce the number
-- 20080318.
dateToSnapshotNumber :: UTCTime -> Int
-- | List all source files of a package.
--
-- Since Cabal-3.4 returns a single list. There shouldn't be any
-- executable files, they are hardly portable.
listPackageSources :: Verbosity -> FilePath -> PackageDescription -> [PPSuffixHandler] -> IO [FilePath]
-- | A variant of listPackageSources with configurable die.
--
-- Note: may still die directly. For example on missing
-- include file.
--
-- Since @3.4.0.0
listPackageSourcesWithDie :: Verbosity -> (Verbosity -> String -> IO [FilePath]) -> FilePath -> PackageDescription -> [PPSuffixHandler] -> IO [FilePath]
-- | This is the entry point to actually building the modules in a package.
-- It doesn't actually do much itself, most of the work is delegated to
-- compiler-specific actions. It does do some non-compiler specific bits
-- like running pre-processors.
module Distribution.Simple.Build
-- | Build the libraries and executables in this package.
build :: PackageDescription -> LocalBuildInfo -> BuildFlags -> [PPSuffixHandler] -> IO ()
showBuildInfo :: PackageDescription -> LocalBuildInfo -> BuildFlags -> IO String
repl :: PackageDescription -> LocalBuildInfo -> ReplFlags -> [PPSuffixHandler] -> [String] -> IO ()
-- | Start an interpreter without loading any package files.
startInterpreter :: Verbosity -> ProgramDb -> Compiler -> Platform -> PackageDBStack -> IO ()
-- | Runs componentInitialBuildSteps on every configured component.
initialBuildSteps :: FilePath -> PackageDescription -> LocalBuildInfo -> Verbosity -> IO ()
-- | Initialize a new package db file for libraries defined internally to
-- the package.
createInternalPackageDB :: Verbosity -> LocalBuildInfo -> FilePath -> IO PackageDB
-- | Creates the autogenerated files for a particular configured component.
componentInitialBuildSteps :: FilePath -> PackageDescription -> LocalBuildInfo -> ComponentLocalBuildInfo -> Verbosity -> IO ()
-- | Generate and write out the Paths_pkg.hs and cabal_macros.h
-- files
writeAutogenFiles :: Verbosity -> PackageDescription -> LocalBuildInfo -> ComponentLocalBuildInfo -> IO ()
-- | This module deals with the haddock and hscolour
-- commands. It uses information about installed packages (from
-- ghc-pkg) to find the locations of documentation for dependent
-- packages, so it can create links.
--
-- The hscolour support allows generating HTML versions of the
-- original source, with coloured syntax highlighting.
module Distribution.Simple.Haddock
haddock :: PackageDescription -> LocalBuildInfo -> [PPSuffixHandler] -> HaddockFlags -> IO ()
hscolour :: PackageDescription -> LocalBuildInfo -> [PPSuffixHandler] -> HscolourFlags -> IO ()
-- | Given a list of InstalledPackageInfos, return a list of
-- interfaces and HTML paths, and an optional warning for packages with
-- missing documentation.
haddockPackagePaths :: [InstalledPackageInfo] -> Maybe (InstalledPackageInfo -> FilePath) -> IO ([(FilePath, Maybe FilePath, Maybe FilePath)], Maybe String)
instance GHC.Classes.Ord Distribution.Simple.Haddock.Directory
instance GHC.Classes.Eq Distribution.Simple.Haddock.Directory
instance GHC.Show.Show Distribution.Simple.Haddock.Directory
instance GHC.Read.Read Distribution.Simple.Haddock.Directory
instance GHC.Generics.Generic Distribution.Simple.Haddock.HaddockArgs
instance GHC.Base.Monoid Distribution.Simple.Haddock.HaddockArgs
instance GHC.Base.Semigroup Distribution.Simple.Haddock.HaddockArgs
instance GHC.Base.Monoid Distribution.Simple.Haddock.Directory
instance GHC.Base.Semigroup Distribution.Simple.Haddock.Directory
-- | This is the command line front end to the Simple build system. When
-- given the parsed command-line args and package information, is able to
-- perform basic commands like configure, build, install, register, etc.
--
-- This module exports the main functions that Setup.hs scripts use. It
-- re-exports the UserHooks type, the standard entry points like
-- defaultMain and defaultMainWithHooks and the predefined
-- sets of UserHooks that custom Setup.hs scripts can
-- extend to add their own behaviour.
--
-- This module isn't called "Simple" because it's simple. Far from it.
-- It's called "Simple" because it does complicated things to simple
-- software.
--
-- The original idea was that there could be different build systems that
-- all presented the same compatible command line interfaces. There is
-- still a Distribution.Make system but in practice no packages
-- use it.
module Distribution.Simple
-- | A simple implementation of main for a Cabal setup script. It
-- reads the package description file using IO, and performs the action
-- specified on the command line.
defaultMain :: IO ()
-- | Like defaultMain, but accepts the package description as input
-- rather than using IO to read it.
defaultMainNoRead :: GenericPackageDescription -> IO ()
-- | A version of defaultMain that is passed the command line
-- arguments, rather than getting them from the environment.
defaultMainArgs :: [String] -> IO ()
-- | Hooks allow authors to add specific functionality before and after a
-- command is run, and also to specify additional preprocessors.
--
--
-- - WARNING: The hooks interface is under rather constant flux as we
-- try to understand users needs. Setup files that depend on this
-- interface may break in future releases.
--
data UserHooks
UserHooks :: IO (Maybe GenericPackageDescription) -> [PPSuffixHandler] -> [Program] -> (Args -> ConfigFlags -> IO HookedBuildInfo) -> ((GenericPackageDescription, HookedBuildInfo) -> ConfigFlags -> IO LocalBuildInfo) -> (Args -> ConfigFlags -> PackageDescription -> LocalBuildInfo -> IO ()) -> (Args -> BuildFlags -> IO HookedBuildInfo) -> (PackageDescription -> LocalBuildInfo -> UserHooks -> BuildFlags -> IO ()) -> (Args -> BuildFlags -> PackageDescription -> LocalBuildInfo -> IO ()) -> (Args -> ReplFlags -> IO HookedBuildInfo) -> (PackageDescription -> LocalBuildInfo -> UserHooks -> ReplFlags -> [String] -> IO ()) -> (Args -> ReplFlags -> PackageDescription -> LocalBuildInfo -> IO ()) -> (Args -> CleanFlags -> IO HookedBuildInfo) -> (PackageDescription -> () -> UserHooks -> CleanFlags -> IO ()) -> (Args -> CleanFlags -> PackageDescription -> () -> IO ()) -> (Args -> CopyFlags -> IO HookedBuildInfo) -> (PackageDescription -> LocalBuildInfo -> UserHooks -> CopyFlags -> IO ()) -> (Args -> CopyFlags -> PackageDescription -> LocalBuildInfo -> IO ()) -> (Args -> InstallFlags -> IO HookedBuildInfo) -> (PackageDescription -> LocalBuildInfo -> UserHooks -> InstallFlags -> IO ()) -> (Args -> InstallFlags -> PackageDescription -> LocalBuildInfo -> IO ()) -> (Args -> RegisterFlags -> IO HookedBuildInfo) -> (PackageDescription -> LocalBuildInfo -> UserHooks -> RegisterFlags -> IO ()) -> (Args -> RegisterFlags -> PackageDescription -> LocalBuildInfo -> IO ()) -> (Args -> RegisterFlags -> IO HookedBuildInfo) -> (PackageDescription -> LocalBuildInfo -> UserHooks -> RegisterFlags -> IO ()) -> (Args -> RegisterFlags -> PackageDescription -> LocalBuildInfo -> IO ()) -> (Args -> HscolourFlags -> IO HookedBuildInfo) -> (PackageDescription -> LocalBuildInfo -> UserHooks -> HscolourFlags -> IO ()) -> (Args -> HscolourFlags -> PackageDescription -> LocalBuildInfo -> IO ()) -> (Args -> HaddockFlags -> IO HookedBuildInfo) -> (PackageDescription -> LocalBuildInfo -> UserHooks -> HaddockFlags -> IO ()) -> (Args -> HaddockFlags -> PackageDescription -> LocalBuildInfo -> IO ()) -> (Args -> TestFlags -> IO HookedBuildInfo) -> (Args -> PackageDescription -> LocalBuildInfo -> UserHooks -> TestFlags -> IO ()) -> (Args -> TestFlags -> PackageDescription -> LocalBuildInfo -> IO ()) -> (Args -> BenchmarkFlags -> IO HookedBuildInfo) -> (Args -> PackageDescription -> LocalBuildInfo -> UserHooks -> BenchmarkFlags -> IO ()) -> (Args -> BenchmarkFlags -> PackageDescription -> LocalBuildInfo -> IO ()) -> UserHooks
-- | Read the description file
[readDesc] :: UserHooks -> IO (Maybe GenericPackageDescription)
-- | Custom preprocessors in addition to and overriding
-- knownSuffixHandlers.
[hookedPreProcessors] :: UserHooks -> [PPSuffixHandler]
-- | These programs are detected at configure time. Arguments for them are
-- added to the configure command.
[hookedPrograms] :: UserHooks -> [Program]
-- | Hook to run before configure command
[preConf] :: UserHooks -> Args -> ConfigFlags -> IO HookedBuildInfo
-- | Over-ride this hook to get different behavior during configure.
[confHook] :: UserHooks -> (GenericPackageDescription, HookedBuildInfo) -> ConfigFlags -> IO LocalBuildInfo
-- | Hook to run after configure command
[postConf] :: UserHooks -> Args -> ConfigFlags -> PackageDescription -> LocalBuildInfo -> IO ()
-- | Hook to run before build command. Second arg indicates verbosity
-- level.
[preBuild] :: UserHooks -> Args -> BuildFlags -> IO HookedBuildInfo
-- | Over-ride this hook to get different behavior during build.
[buildHook] :: UserHooks -> PackageDescription -> LocalBuildInfo -> UserHooks -> BuildFlags -> IO ()
-- | Hook to run after build command. Second arg indicates verbosity level.
[postBuild] :: UserHooks -> Args -> BuildFlags -> PackageDescription -> LocalBuildInfo -> IO ()
-- | Hook to run before repl command. Second arg indicates verbosity level.
[preRepl] :: UserHooks -> Args -> ReplFlags -> IO HookedBuildInfo
-- | Over-ride this hook to get different behavior during interpretation.
[replHook] :: UserHooks -> PackageDescription -> LocalBuildInfo -> UserHooks -> ReplFlags -> [String] -> IO ()
-- | Hook to run after repl command. Second arg indicates verbosity level.
[postRepl] :: UserHooks -> Args -> ReplFlags -> PackageDescription -> LocalBuildInfo -> IO ()
-- | Hook to run before clean command. Second arg indicates verbosity
-- level.
[preClean] :: UserHooks -> Args -> CleanFlags -> IO HookedBuildInfo
-- | Over-ride this hook to get different behavior during clean.
[cleanHook] :: UserHooks -> PackageDescription -> () -> UserHooks -> CleanFlags -> IO ()
-- | Hook to run after clean command. Second arg indicates verbosity level.
[postClean] :: UserHooks -> Args -> CleanFlags -> PackageDescription -> () -> IO ()
-- | Hook to run before copy command
[preCopy] :: UserHooks -> Args -> CopyFlags -> IO HookedBuildInfo
-- | Over-ride this hook to get different behavior during copy.
[copyHook] :: UserHooks -> PackageDescription -> LocalBuildInfo -> UserHooks -> CopyFlags -> IO ()
-- | Hook to run after copy command
[postCopy] :: UserHooks -> Args -> CopyFlags -> PackageDescription -> LocalBuildInfo -> IO ()
-- | Hook to run before install command
[preInst] :: UserHooks -> Args -> InstallFlags -> IO HookedBuildInfo
-- | Over-ride this hook to get different behavior during install.
[instHook] :: UserHooks -> PackageDescription -> LocalBuildInfo -> UserHooks -> InstallFlags -> IO ()
-- | Hook to run after install command. postInst should be run on the
-- target, not on the build machine.
[postInst] :: UserHooks -> Args -> InstallFlags -> PackageDescription -> LocalBuildInfo -> IO ()
-- | Hook to run before register command
[preReg] :: UserHooks -> Args -> RegisterFlags -> IO HookedBuildInfo
-- | Over-ride this hook to get different behavior during registration.
[regHook] :: UserHooks -> PackageDescription -> LocalBuildInfo -> UserHooks -> RegisterFlags -> IO ()
-- | Hook to run after register command
[postReg] :: UserHooks -> Args -> RegisterFlags -> PackageDescription -> LocalBuildInfo -> IO ()
-- | Hook to run before unregister command
[preUnreg] :: UserHooks -> Args -> RegisterFlags -> IO HookedBuildInfo
-- | Over-ride this hook to get different behavior during unregistration.
[unregHook] :: UserHooks -> PackageDescription -> LocalBuildInfo -> UserHooks -> RegisterFlags -> IO ()
-- | Hook to run after unregister command
[postUnreg] :: UserHooks -> Args -> RegisterFlags -> PackageDescription -> LocalBuildInfo -> IO ()
-- | Hook to run before hscolour command. Second arg indicates verbosity
-- level.
[preHscolour] :: UserHooks -> Args -> HscolourFlags -> IO HookedBuildInfo
-- | Over-ride this hook to get different behavior during hscolour.
[hscolourHook] :: UserHooks -> PackageDescription -> LocalBuildInfo -> UserHooks -> HscolourFlags -> IO ()
-- | Hook to run after hscolour command. Second arg indicates verbosity
-- level.
[postHscolour] :: UserHooks -> Args -> HscolourFlags -> PackageDescription -> LocalBuildInfo -> IO ()
-- | Hook to run before haddock command. Second arg indicates verbosity
-- level.
[preHaddock] :: UserHooks -> Args -> HaddockFlags -> IO HookedBuildInfo
-- | Over-ride this hook to get different behavior during haddock.
[haddockHook] :: UserHooks -> PackageDescription -> LocalBuildInfo -> UserHooks -> HaddockFlags -> IO ()
-- | Hook to run after haddock command. Second arg indicates verbosity
-- level.
[postHaddock] :: UserHooks -> Args -> HaddockFlags -> PackageDescription -> LocalBuildInfo -> IO ()
-- | Hook to run before test command.
[preTest] :: UserHooks -> Args -> TestFlags -> IO HookedBuildInfo
-- | Over-ride this hook to get different behavior during test.
[testHook] :: UserHooks -> Args -> PackageDescription -> LocalBuildInfo -> UserHooks -> TestFlags -> IO ()
-- | Hook to run after test command.
[postTest] :: UserHooks -> Args -> TestFlags -> PackageDescription -> LocalBuildInfo -> IO ()
-- | Hook to run before bench command.
[preBench] :: UserHooks -> Args -> BenchmarkFlags -> IO HookedBuildInfo
-- | Over-ride this hook to get different behavior during bench.
[benchHook] :: UserHooks -> Args -> PackageDescription -> LocalBuildInfo -> UserHooks -> BenchmarkFlags -> IO ()
-- | Hook to run after bench command.
[postBench] :: UserHooks -> Args -> BenchmarkFlags -> PackageDescription -> LocalBuildInfo -> IO ()
type Args = [String]
-- | A customizable version of defaultMain.
defaultMainWithHooks :: UserHooks -> IO ()
-- | A customizable version of defaultMain that also takes the
-- command line arguments.
defaultMainWithHooksArgs :: UserHooks -> [String] -> IO ()
-- | A customizable version of defaultMainNoRead.
defaultMainWithHooksNoRead :: UserHooks -> GenericPackageDescription -> IO ()
-- | A customizable version of defaultMainNoRead that also takes the
-- command line arguments.
defaultMainWithHooksNoReadArgs :: UserHooks -> GenericPackageDescription -> [String] -> IO ()
-- | Hooks that correspond to a plain instantiation of the "simple" build
-- system
simpleUserHooks :: UserHooks
-- | Basic autoconf UserHooks:
--
--
--
-- Thus configure can use local system information to generate
-- package.buildinfo and possibly other files.
autoconfUserHooks :: UserHooks
-- | Empty UserHooks which do nothing.
emptyUserHooks :: UserHooks