GivenComponent.hs

{-# LANGUAGE DeriveGeneric #-}

module Distribution.Types.GivenComponent
  ( GivenComponent (..)
  , PromisedComponent (..)
  ) where

import Distribution.Compat.Prelude

import Distribution.Types.ComponentId
import Distribution.Types.LibraryName
import Distribution.Types.PackageId
import Distribution.Types.PackageName

-- | 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
--
-- @since 2.3.0.0
data GivenComponent = GivenComponent
  { givenComponentPackage :: PackageName
  , givenComponentName :: LibraryName -- --dependency is for libraries
  -- only, not for any component
  , givenComponentId :: ComponentId
  }
  deriving (Generic, Read, Show, Eq)

instance Binary GivenComponent
instance Structured GivenComponent

-- | A 'PromisedComponent' represents a promised library depended on and explicitly
-- specified by the user/client with @--promised-dependency@
--
-- It enables Cabal to know which 'ComponentId' to associate with a library
--
-- @since 3.14.0.0
data PromisedComponent = PromisedComponent
  { promisedComponentPackage :: PackageId
  , promisedComponentName :: LibraryName -- --dependency is for libraries
  -- only, not for any component
  , promisedComponentId :: ComponentId
  }
  deriving (Generic, Read, Show, Eq)

instance Binary PromisedComponent
instance Structured PromisedComponent