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

   1 {-# LANGUAGE DeriveDataTypeable #-}
   2 {-# LANGUAGE DeriveGeneric #-}
   3 {-# LANGUAGE GeneralizedNewtypeDeriving #-}
   4
   5 module Distribution.Types.PackageName
   6   ( PackageName
   7   , unPackageName
   8   , mkPackageName
   9   , unPackageNameST
  10   , mkPackageNameST
  11   ) where
  12
  13 import Distribution.Compat.Prelude
  14 import Distribution.Utils.ShortText
  15 import Prelude ()
  16
  17 import Distribution.Parsec
  18 import Distribution.Pretty
  19 import qualified Text.PrettyPrint as Disp
  20
  21 -- | A package name.
  22 --
  23 -- Use 'mkPackageName' and 'unPackageName' to convert from/to a
  24 -- 'String'.
  25 --
  26 -- This type is opaque since @Cabal-2.0@
  27 --
  28 -- @since 2.0.0.2
  29 newtype PackageName = PackageName ShortText
  30   deriving (Generic, Read, Show, Eq, Ord, Typeable, Data)
  31
  32 -- | Convert 'PackageName' to 'String'
  33 unPackageName :: PackageName -> String
  34 unPackageName (PackageName s) = fromShortText s
  35
  36 -- | @since 3.4.0.0
  37 unPackageNameST :: PackageName -> ShortText
  38 unPackageNameST (PackageName s) = s
  39
  40 -- | Construct a 'PackageName' from a 'String'
  41 --
  42 -- 'mkPackageName' is the inverse to 'unPackageName'
  43 --
  44 -- Note: No validations are performed to ensure that the resulting
  45 -- 'PackageName' is valid
  46 --
  47 -- @since 2.0.0.2
  48 mkPackageName :: String -> PackageName
  49 mkPackageName = PackageName . toShortText
  50
  51 -- | Construct a 'PackageName' from a 'ShortText'
  52 --
  53 -- Note: No validations are performed to ensure that the resulting
  54 -- 'PackageName' is valid
  55 --
  56 -- @since 3.4.0.0
  57 mkPackageNameST :: ShortText -> PackageName
  58 mkPackageNameST = PackageName
  59
  60 -- | 'mkPackageName'
  61 --
  62 -- @since 2.0.0.2
  63 instance IsString PackageName where
  64   fromString = mkPackageName
  65
  66 instance Binary PackageName
  67 instance Structured PackageName
  68
  69 instance Pretty PackageName where
  70   pretty = Disp.text . unPackageName
  71
  72 instance Parsec PackageName where
  73   parsec = mkPackageName <$> parsecUnqualComponentName
  74
  75 instance NFData PackageName where
  76   rnf (PackageName pkg) = rnf pkg