{-# LANGUAGE DeriveAnyClass #-}

{- |
Module      : Servant.API.Routes.Internal.Param
Copyright   : (c) Frederick Pringle, 2025
License     : BSD-3-Clause
Maintainer  : frederick.pringle@fpringle.com

Internal module, subject to change.
-}
module Servant.API.Routes.Internal.Param
  ( Param (..)
  )
where

import Data.Aeson
import Data.Function (on)
import GHC.Generics
import qualified Servant.Links as S

{- | Newtype wrapper around servant's 'S.Param' so we can define a sensible
'Eq' instance for it.
-}
newtype Param = Param
  { Param -> Param
unParam :: S.Param
  }
  deriving (Int -> Param -> ShowS
[Param] -> ShowS
Param -> String
(Int -> Param -> ShowS)
-> (Param -> String) -> ([Param] -> ShowS) -> Show Param
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
$cshowsPrec :: Int -> Param -> ShowS
showsPrec :: Int -> Param -> ShowS
$cshow :: Param -> String
show :: Param -> String
$cshowList :: [Param] -> ShowS
showList :: [Param] -> ShowS
Show) via S.Param

instance Eq Param where
  == :: Param -> Param -> Bool
(==) = Param -> Param -> Bool
eq (Param -> Param -> Bool)
-> (Param -> Param) -> Param -> Param -> Bool
forall b c a. (b -> b -> c) -> (a -> b) -> a -> a -> c
`on` Param -> Param
unParam
    where
      S.SingleParam String
name1 Text
rep1 eq :: Param -> Param -> Bool
`eq` S.SingleParam String
name2 Text
rep2 =
        String
name1 String -> String -> Bool
forall a. Eq a => a -> a -> Bool
== String
name2 Bool -> Bool -> Bool
&& Text
rep1 Text -> Text -> Bool
forall a. Eq a => a -> a -> Bool
== Text
rep2
      S.ArrayElemParam String
name1 Text
rep1 `eq` S.ArrayElemParam String
name2 Text
rep2 =
        String
name1 String -> String -> Bool
forall a. Eq a => a -> a -> Bool
== String
name2 Bool -> Bool -> Bool
&& Text
rep1 Text -> Text -> Bool
forall a. Eq a => a -> a -> Bool
== Text
rep2
      S.FlagParam String
name1 `eq` S.FlagParam String
name2 =
        String
name1 String -> String -> Bool
forall a. Eq a => a -> a -> Bool
== String
name2
      Param
_ `eq` Param
_ = Bool
False

instance Ord Param where
  compare :: Param -> Param -> Ordering
compare = Param -> Param -> Ordering
comp (Param -> Param -> Ordering)
-> (Param -> Param) -> Param -> Param -> Ordering
forall b c a. (b -> b -> c) -> (a -> b) -> a -> a -> c
`on` Param -> Param
unParam
    where
      S.SingleParam String
name1 Text
rep1 comp :: Param -> Param -> Ordering
`comp` S.SingleParam String
name2 Text
rep2 =
        String
name1 String -> String -> Ordering
forall a. Ord a => a -> a -> Ordering
`compare` String
name2 Ordering -> Ordering -> Ordering
forall a. Semigroup a => a -> a -> a
<> Text
rep1 Text -> Text -> Ordering
forall a. Ord a => a -> a -> Ordering
`compare` Text
rep2
      S.ArrayElemParam String
name1 Text
rep1 `comp` S.ArrayElemParam String
name2 Text
rep2 =
        String
name1 String -> String -> Ordering
forall a. Ord a => a -> a -> Ordering
`compare` String
name2 Ordering -> Ordering -> Ordering
forall a. Semigroup a => a -> a -> a
<> Text
rep1 Text -> Text -> Ordering
forall a. Ord a => a -> a -> Ordering
`compare` Text
rep2
      S.FlagParam String
name1 `comp` S.FlagParam String
name2 =
        String
name1 String -> String -> Ordering
forall a. Ord a => a -> a -> Ordering
`compare` String
name2
      S.SingleParam {} `comp` Param
_ = Ordering
LT
      Param
_ `comp` S.SingleParam {} = Ordering
GT
      S.ArrayElemParam {} `comp` Param
_ = Ordering
LT
      Param
_ `comp` S.ArrayElemParam {} = Ordering
GT

data ParamType
  = SingleParam
  | ArrayElemParam
  | FlagParam
  deriving (Int -> ParamType -> ShowS
[ParamType] -> ShowS
ParamType -> String
(Int -> ParamType -> ShowS)
-> (ParamType -> String)
-> ([ParamType] -> ShowS)
-> Show ParamType
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
$cshowsPrec :: Int -> ParamType -> ShowS
showsPrec :: Int -> ParamType -> ShowS
$cshow :: ParamType -> String
show :: ParamType -> String
$cshowList :: [ParamType] -> ShowS
showList :: [ParamType] -> ShowS
Show, ParamType -> ParamType -> Bool
(ParamType -> ParamType -> Bool)
-> (ParamType -> ParamType -> Bool) -> Eq ParamType
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
$c== :: ParamType -> ParamType -> Bool
== :: ParamType -> ParamType -> Bool
$c/= :: ParamType -> ParamType -> Bool
/= :: ParamType -> ParamType -> Bool
Eq, Int -> ParamType
ParamType -> Int
ParamType -> [ParamType]
ParamType -> ParamType
ParamType -> ParamType -> [ParamType]
ParamType -> ParamType -> ParamType -> [ParamType]
(ParamType -> ParamType)
-> (ParamType -> ParamType)
-> (Int -> ParamType)
-> (ParamType -> Int)
-> (ParamType -> [ParamType])
-> (ParamType -> ParamType -> [ParamType])
-> (ParamType -> ParamType -> [ParamType])
-> (ParamType -> ParamType -> ParamType -> [ParamType])
-> Enum ParamType
forall a.
(a -> a)
-> (a -> a)
-> (Int -> a)
-> (a -> Int)
-> (a -> [a])
-> (a -> a -> [a])
-> (a -> a -> [a])
-> (a -> a -> a -> [a])
-> Enum a
$csucc :: ParamType -> ParamType
succ :: ParamType -> ParamType
$cpred :: ParamType -> ParamType
pred :: ParamType -> ParamType
$ctoEnum :: Int -> ParamType
toEnum :: Int -> ParamType
$cfromEnum :: ParamType -> Int
fromEnum :: ParamType -> Int
$cenumFrom :: ParamType -> [ParamType]
enumFrom :: ParamType -> [ParamType]
$cenumFromThen :: ParamType -> ParamType -> [ParamType]
enumFromThen :: ParamType -> ParamType -> [ParamType]
$cenumFromTo :: ParamType -> ParamType -> [ParamType]
enumFromTo :: ParamType -> ParamType -> [ParamType]
$cenumFromThenTo :: ParamType -> ParamType -> ParamType -> [ParamType]
enumFromThenTo :: ParamType -> ParamType -> ParamType -> [ParamType]
Enum, ParamType
ParamType -> ParamType -> Bounded ParamType
forall a. a -> a -> Bounded a
$cminBound :: ParamType
minBound :: ParamType
$cmaxBound :: ParamType
maxBound :: ParamType
Bounded, (forall x. ParamType -> Rep ParamType x)
-> (forall x. Rep ParamType x -> ParamType) -> Generic ParamType
forall x. Rep ParamType x -> ParamType
forall x. ParamType -> Rep ParamType x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cfrom :: forall x. ParamType -> Rep ParamType x
from :: forall x. ParamType -> Rep ParamType x
$cto :: forall x. Rep ParamType x -> ParamType
to :: forall x. Rep ParamType x -> ParamType
Generic)
  deriving ([ParamType] -> Value
[ParamType] -> Encoding
ParamType -> Bool
ParamType -> Value
ParamType -> Encoding
(ParamType -> Value)
-> (ParamType -> Encoding)
-> ([ParamType] -> Value)
-> ([ParamType] -> Encoding)
-> (ParamType -> Bool)
-> ToJSON ParamType
forall a.
(a -> Value)
-> (a -> Encoding)
-> ([a] -> Value)
-> ([a] -> Encoding)
-> (a -> Bool)
-> ToJSON a
$ctoJSON :: ParamType -> Value
toJSON :: ParamType -> Value
$ctoEncoding :: ParamType -> Encoding
toEncoding :: ParamType -> Encoding
$ctoJSONList :: [ParamType] -> Value
toJSONList :: [ParamType] -> Value
$ctoEncodingList :: [ParamType] -> Encoding
toEncodingList :: [ParamType] -> Encoding
$comitField :: ParamType -> Bool
omitField :: ParamType -> Bool
ToJSON)

instance ToJSON Param where
  toJSON :: Param -> Value
toJSON (Param Param
p) =
    [Pair] -> Value
object ([Pair] -> Value) -> [Pair] -> Value
forall a b. (a -> b) -> a -> b
$ case Param
p of
      S.SingleParam String
name Text
rep ->
        ParamType -> [Pair] -> [Pair]
forall {e} {a} {v}. (KeyValue e a, ToJSON v) => v -> [a] -> [a]
withType ParamType
SingleParam [Key
"name" Key -> String -> Pair
forall v. ToJSON v => Key -> v -> Pair
forall e kv v. (KeyValue e kv, ToJSON v) => Key -> v -> kv
.= String
name, Key
"param_type" Key -> Text -> Pair
forall v. ToJSON v => Key -> v -> Pair
forall e kv v. (KeyValue e kv, ToJSON v) => Key -> v -> kv
.= Text
rep]
      S.ArrayElemParam String
name Text
rep ->
        ParamType -> [Pair] -> [Pair]
forall {e} {a} {v}. (KeyValue e a, ToJSON v) => v -> [a] -> [a]
withType ParamType
ArrayElemParam [Key
"name" Key -> String -> Pair
forall v. ToJSON v => Key -> v -> Pair
forall e kv v. (KeyValue e kv, ToJSON v) => Key -> v -> kv
.= String
name, Key
"param_type" Key -> Text -> Pair
forall v. ToJSON v => Key -> v -> Pair
forall e kv v. (KeyValue e kv, ToJSON v) => Key -> v -> kv
.= Text
rep]
      S.FlagParam String
name ->
        ParamType -> [Pair] -> [Pair]
forall {e} {a} {v}. (KeyValue e a, ToJSON v) => v -> [a] -> [a]
withType ParamType
FlagParam [Key
"name" Key -> String -> Pair
forall v. ToJSON v => Key -> v -> Pair
forall e kv v. (KeyValue e kv, ToJSON v) => Key -> v -> kv
.= String
name]
    where
      withType :: v -> [a] -> [a]
withType v
t [a]
ps = (Key
"type" Key -> v -> a
forall v. ToJSON v => Key -> v -> a
forall e kv v. (KeyValue e kv, ToJSON v) => Key -> v -> kv
.= v
t) a -> [a] -> [a]
forall a. a -> [a] -> [a]
: [a]
ps