-- |
-- Module      : Data.TypeID.Error
-- License     : MIT
-- Maintainer  : mmzk1526@outlook.com
-- Portability : GHC
--
-- TypeID Error type.
--
module Data.TypeID.Error
 (
  -- * Data type
  TypeIDError(..)
 ) where

import           Control.Exception

-- | Errors from parsing TypeIDs.
--
-- Should NOT rely on \"grepping\" the output produced by 'show' since the
-- exact output format may differ across library versions.
data TypeIDError
  = -- | The prefix is longer than 63 characters.
    TypeIDErrorPrefixTooLong String
    -- | The ID contains an extra underscore separator.
  | TypeIDExtraSeparator
    -- | The ID starts with an underscore separator.
  | TypeIDStartWithUnderscore String
    -- | The ID ends with an underscore separator.
  | TypeIDEndWithUnderscore String
    -- | The prefix contains an invalid character, namely not lowercase Latin.
  | TypeIDErrorPrefixInvalidChar String Char
    -- | From a 'Data.KindID.V7KindID' conversion. The prefix doesn't match with
    -- the expected.
  | TypeIDErrorPrefixMismatch String String
    -- | The 'Data.UUID.Types.Internal.UUID' suffix has errors.
  | TypeIDErrorUUIDError
  deriving (TypeIDError -> TypeIDError -> Bool
(TypeIDError -> TypeIDError -> Bool)
-> (TypeIDError -> TypeIDError -> Bool) -> Eq TypeIDError
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
$c== :: TypeIDError -> TypeIDError -> Bool
== :: TypeIDError -> TypeIDError -> Bool
$c/= :: TypeIDError -> TypeIDError -> Bool
/= :: TypeIDError -> TypeIDError -> Bool
Eq, Eq TypeIDError
Eq TypeIDError
-> (TypeIDError -> TypeIDError -> Ordering)
-> (TypeIDError -> TypeIDError -> Bool)
-> (TypeIDError -> TypeIDError -> Bool)
-> (TypeIDError -> TypeIDError -> Bool)
-> (TypeIDError -> TypeIDError -> Bool)
-> (TypeIDError -> TypeIDError -> TypeIDError)
-> (TypeIDError -> TypeIDError -> TypeIDError)
-> Ord TypeIDError
TypeIDError -> TypeIDError -> Bool
TypeIDError -> TypeIDError -> Ordering
TypeIDError -> TypeIDError -> TypeIDError
forall a.
Eq a
-> (a -> a -> Ordering)
-> (a -> a -> Bool)
-> (a -> a -> Bool)
-> (a -> a -> Bool)
-> (a -> a -> Bool)
-> (a -> a -> a)
-> (a -> a -> a)
-> Ord a
$ccompare :: TypeIDError -> TypeIDError -> Ordering
compare :: TypeIDError -> TypeIDError -> Ordering
$c< :: TypeIDError -> TypeIDError -> Bool
< :: TypeIDError -> TypeIDError -> Bool
$c<= :: TypeIDError -> TypeIDError -> Bool
<= :: TypeIDError -> TypeIDError -> Bool
$c> :: TypeIDError -> TypeIDError -> Bool
> :: TypeIDError -> TypeIDError -> Bool
$c>= :: TypeIDError -> TypeIDError -> Bool
>= :: TypeIDError -> TypeIDError -> Bool
$cmax :: TypeIDError -> TypeIDError -> TypeIDError
max :: TypeIDError -> TypeIDError -> TypeIDError
$cmin :: TypeIDError -> TypeIDError -> TypeIDError
min :: TypeIDError -> TypeIDError -> TypeIDError
Ord)

instance Show TypeIDError where
  show :: TypeIDError -> String
  show :: TypeIDError -> String
show (TypeIDErrorPrefixTooLong String
txt)
    = [String] -> String
forall (t :: * -> *) a. Foldable t => t [a] -> [a]
concat [ String
"The prefix ", ShowS
forall a. Show a => a -> String
show String
txt
             , String
" with ", Int -> String
forall a. Show a => a -> String
show (String -> Int
forall a. [a] -> Int
forall (t :: * -> *) a. Foldable t => t a -> Int
length String
txt), String
" characters is too long!" ]
  show TypeIDError
TypeIDExtraSeparator
    = String
"The underscore separator should not be present if the prefix is empty!"
  show (TypeIDStartWithUnderscore String
txt)
    = [String] -> String
forall (t :: * -> *) a. Foldable t => t [a] -> [a]
concat [String
"The prefix ", ShowS
forall a. Show a => a -> String
show String
txt, String
" should not start with an underscore!"]
  show (TypeIDEndWithUnderscore String
txt)
    = [String] -> String
forall (t :: * -> *) a. Foldable t => t [a] -> [a]
concat [String
"The prefix ", ShowS
forall a. Show a => a -> String
show String
txt, String
" should not end with an underscore!"]
  show (TypeIDErrorPrefixInvalidChar String
txt Char
c)
    = [String] -> String
forall (t :: * -> *) a. Foldable t => t [a] -> [a]
concat [ String
"The prefix ", ShowS
forall a. Show a => a -> String
show String
txt
             , String
" contains invalid character ", Char -> String
forall a. Show a => a -> String
show Char
c, String
"!"]
  show (TypeIDErrorPrefixMismatch String
expPrefix String
actPrefix)
    = [String] -> String
forall (t :: * -> *) a. Foldable t => t [a] -> [a]
concat [ String
"Expected prefix ", ShowS
forall a. Show a => a -> String
show String
expPrefix, String
" but got "
             , ShowS
forall a. Show a => a -> String
show String
actPrefix, String
"!" ]
  show TypeIDError
TypeIDErrorUUIDError
    = String
"Invalid UUID part!"
  {-# INLINE show #-}

instance Exception TypeIDError