Cabal-syntax/src/Distribution/Types/ComponentId.hs

   1 {-# LANGUAGE DeriveDataTypeable #-}
   2 {-# LANGUAGE DeriveGeneric #-}
   3 {-# LANGUAGE GeneralizedNewtypeDeriving #-}
   4
   5 module Distribution.Types.ComponentId
   6   ( ComponentId
   7   , unComponentId
   8   , mkComponentId
   9   ) where
  10
  11 import Distribution.Compat.Prelude
  12 import Distribution.Utils.ShortText
  13 import Prelude ()
  14
  15 import Distribution.Parsec
  16 import Distribution.Pretty
  17
  18 import qualified Distribution.Compat.CharParsing as P
  19 import Text.PrettyPrint (text)
  20
  21 -- | A 'ComponentId' uniquely identifies the transitive source
  22 -- code closure of a component (i.e. libraries, executables).
  23 --
  24 -- For non-Backpack components, this corresponds one to one with
  25 -- the 'UnitId', which serves as the basis for install paths,
  26 -- linker symbols, etc.
  27 --
  28 -- Use 'mkComponentId' and 'unComponentId' to convert from/to a
  29 -- 'String'.
  30 --
  31 -- This type is opaque since @Cabal-2.0@
  32 --
  33 -- @since 2.0.0.2
  34 newtype ComponentId = ComponentId ShortText
  35   deriving (Generic, Read, Show, Eq, Ord, Typeable, Data)
  36
  37 -- | Construct a 'ComponentId' from a 'String'
  38 --
  39 -- 'mkComponentId' is the inverse to 'unComponentId'
  40 --
  41 -- Note: No validations are performed to ensure that the resulting
  42 -- 'ComponentId' is valid
  43 --
  44 -- @since 2.0.0.2
  45 mkComponentId :: String -> ComponentId
  46 mkComponentId = ComponentId . toShortText
  47
  48 -- | Convert 'ComponentId' to 'String'
  49 --
  50 -- @since 2.0.0.2
  51 unComponentId :: ComponentId -> String
  52 unComponentId (ComponentId s) = fromShortText s
  53
  54 -- | 'mkComponentId'
  55 --
  56 -- @since 2.0.0.2
  57 instance IsString ComponentId where
  58   fromString = mkComponentId
  59
  60 instance Binary ComponentId
  61 instance Structured ComponentId
  62
  63 instance Pretty ComponentId where
  64   pretty = text . unComponentId
  65
  66 instance Parsec ComponentId where
  67   parsec = mkComponentId `fmap` P.munch1 abi_char
  68     where
  69       abi_char c = isAlphaNum c || c `elem` "-_."
  70
  71 instance NFData ComponentId where
  72   rnf = rnf . unComponentId