boot/SPDX.LicenseExceptionId.template.hs

   1 {-# LANGUAGE DeriveDataTypeable #-}
   2 {-# LANGUAGE DeriveGeneric      #-}
   3 module Distribution.SPDX.LicenseExceptionId (
   4     LicenseExceptionId (..),
   5     licenseExceptionId,
   6     licenseExceptionName,
   7     mkLicenseExceptionId,
   8     ) where
   9
  10 import Distribution.Compat.Prelude
  11 import Prelude ()
  12
  13 import Distribution.Pretty
  14 import Distribution.Parsec.Class
  15 import Distribution.Utils.Generic (isAsciiAlphaNum)
  16
  17 import qualified Distribution.Compat.Map.Strict as Map
  18 import qualified Distribution.Compat.CharParsing as P
  19 import qualified Text.PrettyPrint as Disp
  20
  21 -------------------------------------------------------------------------------
  22 -- LicenseExceptionId
  23 -------------------------------------------------------------------------------
  24
  25 -- | SPDX License identifier
  26 data LicenseExceptionId
  27 {{{ licenseIds }}}
  28   deriving (Eq, Ord, Enum, Bounded, Show, Read, Typeable, Data, Generic)
  29
  30 instance Binary LicenseExceptionId
  31
  32 instance Pretty LicenseExceptionId where
  33     pretty = Disp.text . licenseExceptionId
  34
  35 instance Parsec LicenseExceptionId where
  36     parsec = do
  37         n <- some $ P.satisfy $ \c -> isAsciiAlphaNum c || c == '-' || c == '.'
  38         maybe (fail $ "Unknown SPDX license exception identifier: " ++ n) return $ mkLicenseExceptionId n
  39
  40 instance NFData LicenseExceptionId where
  41     rnf l = l `seq` ()
  42
  43 -------------------------------------------------------------------------------
  44 -- License Data
  45 -------------------------------------------------------------------------------
  46
  47 -- | License SPDX identifier, e.g. @"BSD-3-Clause"@.
  48 licenseExceptionId :: LicenseExceptionId -> String
  49 {{#licenses}}
  50 licenseExceptionId {{licenseCon}} = {{{licenseId}}}
  51 {{/licenses}}
  52
  53 -- | License name, e.g. @"GNU General Public License v2.0 only"@
  54 licenseExceptionName :: LicenseExceptionId -> String
  55 {{#licenses}}
  56 licenseExceptionName {{licenseCon}} = {{{licenseName}}}
  57 {{/licenses}}
  58
  59 -------------------------------------------------------------------------------
  60 -- Creation
  61 -------------------------------------------------------------------------------
  62
  63 -- | Create a 'LicenseExceptionId' from a 'String'.
  64 mkLicenseExceptionId :: String -> Maybe LicenseExceptionId
  65 mkLicenseExceptionId s = Map.lookup s stringLookup
  66
  67 stringLookup :: Map String LicenseExceptionId
  68 stringLookup = Map.fromList $ map (\i -> (licenseExceptionId i, i)) $ [minBound .. maxBound]