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

   1 {-# LANGUAGE DeriveDataTypeable #-}
   2 {-# LANGUAGE DeriveGeneric #-}
   3 {-# LANGUAGE GeneralizedNewtypeDeriving #-}
   4
   5 module Distribution.Types.AbiHash
   6   ( AbiHash
   7   , unAbiHash
   8   , mkAbiHash
   9   ) where
  10
  11 import Distribution.Compat.Prelude
  12 import Distribution.Utils.ShortText
  13 import Prelude ()
  14
  15 import qualified Distribution.Compat.CharParsing as P
  16 import Distribution.Parsec
  17 import Distribution.Pretty
  18
  19 import Text.PrettyPrint (text)
  20
  21 -- | ABI Hashes
  22 --
  23 -- Use 'mkAbiHash' and 'unAbiHash' 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 AbiHash = AbiHash ShortText
  30   deriving (Eq, Show, Read, Generic, Typeable)
  31
  32 -- | Convert 'AbiHash' to 'String'
  33 --
  34 -- @since 2.0.0.2
  35 unAbiHash :: AbiHash -> String
  36 unAbiHash (AbiHash h) = fromShortText h
  37
  38 -- | Construct a 'AbiHash' from a 'String'
  39 --
  40 -- 'mkAbiHash' is the inverse to 'unAbiHash'
  41 --
  42 -- Note: No validations are performed to ensure that the resulting
  43 -- 'AbiHash' is valid
  44 --
  45 -- @since 2.0.0.2
  46 mkAbiHash :: String -> AbiHash
  47 mkAbiHash = AbiHash . toShortText
  48
  49 -- | 'mkAbiHash'
  50 --
  51 -- @since 2.0.0.2
  52 instance IsString AbiHash where
  53   fromString = mkAbiHash
  54
  55 instance Binary AbiHash
  56 instance Structured AbiHash
  57 instance NFData AbiHash where rnf = genericRnf
  58
  59 instance Pretty AbiHash where
  60   pretty = text . unAbiHash
  61
  62 instance Parsec AbiHash where
  63   parsec = fmap mkAbiHash (P.munch isAlphaNum)