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

   1 {-# LANGUAGE DeriveDataTypeable #-}
   2 {-# LANGUAGE DeriveGeneric #-}
   3 {-# LANGUAGE GeneralizedNewtypeDeriving #-}
   4
   5 module Distribution.Types.PkgconfigName
   6   ( PkgconfigName
   7   , unPkgconfigName
   8   , mkPkgconfigName
   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 qualified Text.PrettyPrint as Disp
  20
  21 -- | A pkg-config library name
  22 --
  23 -- This is parsed as any valid argument to the pkg-config utility.
  24 --
  25 -- @since 2.0.0.2
  26 newtype PkgconfigName = PkgconfigName ShortText
  27   deriving (Generic, Read, Show, Eq, Ord, Typeable, Data)
  28
  29 -- | Convert 'PkgconfigName' to 'String'
  30 --
  31 -- @since 2.0.0.2
  32 unPkgconfigName :: PkgconfigName -> String
  33 unPkgconfigName (PkgconfigName s) = fromShortText s
  34
  35 -- | Construct a 'PkgconfigName' from a 'String'
  36 --
  37 -- 'mkPkgconfigName' is the inverse to 'unPkgconfigName'
  38 --
  39 -- Note: No validations are performed to ensure that the resulting
  40 -- 'PkgconfigName' is valid
  41 --
  42 -- @since 2.0.0.2
  43 mkPkgconfigName :: String -> PkgconfigName
  44 mkPkgconfigName = PkgconfigName . toShortText
  45
  46 -- | 'mkPkgconfigName'
  47 --
  48 -- @since 2.0.0.2
  49 instance IsString PkgconfigName where
  50   fromString = mkPkgconfigName
  51
  52 instance Binary PkgconfigName
  53 instance Structured PkgconfigName
  54
  55 -- pkg-config allows versions and other letters in package names, eg
  56 -- "gtk+-2.0" is a valid pkg-config package _name_.  It then has a package
  57 -- version number like 2.10.13
  58 instance Pretty PkgconfigName where
  59   pretty = Disp.text . unPkgconfigName
  60
  61 instance Parsec PkgconfigName where
  62   parsec = mkPkgconfigName <$> P.munch1 isNameChar
  63     where
  64       -- https://gitlab.haskell.org/ghc/ghc/issues/17752
  65       isNameChar '-' = True
  66       isNameChar '_' = True
  67       isNameChar '.' = True
  68       isNameChar '+' = True
  69       isNameChar c = isAlphaNum c
  70
  71 instance NFData PkgconfigName where
  72   rnf (PkgconfigName pkg) = rnf pkg