{-# LANGUAGE OverloadedStrings, TypeFamilies, FlexibleContexts #-}
-- |
-- Module: Data.Greskell.Gremlin
-- Description: Gremlin (Groovy/Java) utility classes
-- Maintainer: Toshio Ito <debug.ito@gmail.com>
--
-- This modules defines types and functions for utility classes in
-- Gremlin.
module Data.Greskell.Gremlin
       ( -- * Predicate
         Predicate(..),
         PredicateA(..),
         -- ** P class
         P,
         PLike(..),
         pNot,
         pEq,
         pNeq,
         pLt,
         pLte,
         pGt,
         pGte,
         pInside,
         pOutside,
         pBetween,
         pWithin,
         pWithout,
         -- * Comparator
         Comparator(..),
         ComparatorA(..),
         -- ** Order enum
         Order,
         oDecr,
         oIncr,
         oShuffle,
       ) where

import Data.Aeson (Value)
import Data.Monoid ((<>))
import Data.Greskell.GraphSON (GraphSONTyped(..))
import Data.Greskell.Greskell
  ( Greskell, unsafeGreskellLazy,
    toGremlin, toGremlinLazy, unsafeMethodCall, unsafeFunCall,
    ToGreskell
  )

-- $setup
--
-- >>> :set -XOverloadedStrings
-- >>> import Data.Text (Text)
-- >>> import Data.Greskell.Greskell (number, string)

-- | @java.util.function.Predicate@ interface.
--
-- A 'Predicate' @p@ is a function that takes 'PredicateArg' @p@ and
-- returns 'Bool'.
class Predicate p where
  type PredicateArg p
  -- | @.and@ method.
  pAnd :: Greskell p -> Greskell p -> Greskell p
  pAnd Greskell p
p1 Greskell p
p2 = Greskell p -> Text -> [Text] -> Greskell p
forall a b. Greskell a -> Text -> [Text] -> Greskell b
unsafeMethodCall Greskell p
p1 Text
"and" [Greskell p -> Text
forall a. ToGreskell a => a -> Text
toGremlin Greskell p
p2]
  -- | @.or@ method.
  pOr :: Greskell p -> Greskell p -> Greskell p
  pOr Greskell p
o1 Greskell p
o2 = Greskell p -> Text -> [Text] -> Greskell p
forall a b. Greskell a -> Text -> [Text] -> Greskell b
unsafeMethodCall Greskell p
o1 Text
"or" [Greskell p -> Text
forall a. ToGreskell a => a -> Text
toGremlin Greskell p
o2]
  -- | @.test@ method.
  pTest :: Greskell p -> Greskell (PredicateArg p) -> Greskell Bool
  pTest Greskell p
p Greskell (PredicateArg p)
arg = Greskell p -> Text -> [Text] -> Greskell Bool
forall a b. Greskell a -> Text -> [Text] -> Greskell b
unsafeMethodCall Greskell p
p Text
"test" [Greskell (PredicateArg p) -> Text
forall a. ToGreskell a => a -> Text
toGremlin Greskell (PredicateArg p)
arg]
  -- | @.nagate@ method.
  pNegate :: Greskell p -> Greskell p
  pNegate Greskell p
p = Greskell p -> Text -> [Text] -> Greskell p
forall a b. Greskell a -> Text -> [Text] -> Greskell b
unsafeMethodCall Greskell p
p Text
"negate" []

-- | Type for anonymous class of @Predicate@ interface.
newtype PredicateA a = PredicateA { PredicateA a -> a -> Bool
unPredicateA :: a -> Bool }

instance Predicate (PredicateA a) where
  type PredicateArg (PredicateA a) = a

-- | @org.apache.tinkerpop.gremlin.process.traversal.P@ class.
--
-- @P a@ keeps data of type @a@ and compares it with data of type @a@
-- given as the Predicate argument.
data P a

instance Predicate (P a) where
  type PredicateArg (P a) = a

instance GraphSONTyped (P a) where
  gsonTypeFor :: P a -> Text
gsonTypeFor P a
_ = Text
"g:P"

-- | Type that is compatible with 'P'. You can construct a value of
-- type @Greskell p@ using values of @PParameter p@.
--
-- Note that the type of constuctor arguments (i.e. @GreskellReturn (PParameter p)@)
-- should implement Java's @Comparable@ interface. This is true for most types,
-- so greskell doesn't have any explicit constraint about it.
--
-- @since 1.2.0.0
class (ToGreskell (PParameter p)) => PLike p where
  type PParameter p

-- | You can construct @Greskell (P a)@ from @Greskell a@.
instance PLike (P a) where
  type PParameter (P a) = Greskell a

-- | @P.not@ static method.
--
-- >>> toGremlin (pNot $ pEq $ 10 :: Greskell (P Int))
-- "P.not(P.eq(10))"
pNot :: PLike p => Greskell p -> Greskell p
pNot :: Greskell p -> Greskell p
pNot Greskell p
a = Text -> [Text] -> Greskell p
forall a. Text -> [Text] -> Greskell a
unsafeFunCall Text
"P.not" [Greskell p -> Text
forall a. ToGreskell a => a -> Text
toGremlin Greskell p
a]

-- | @P.eq@ static method.
--
-- >>> toGremlin (pEq $ string "hoge" :: Greskell (P Text))
-- "P.eq(\"hoge\")"
pEq :: PLike p => PParameter p -> Greskell p
pEq :: PParameter p -> Greskell p
pEq PParameter p
arg = Text -> [Text] -> Greskell p
forall a. Text -> [Text] -> Greskell a
unsafeFunCall Text
"P.eq" [PParameter p -> Text
forall a. ToGreskell a => a -> Text
toGremlin PParameter p
arg]

-- | @P.neq@ static method.
pNeq :: PLike p => PParameter p -> Greskell p
pNeq :: PParameter p -> Greskell p
pNeq PParameter p
arg = Text -> [Text] -> Greskell p
forall a. Text -> [Text] -> Greskell a
unsafeFunCall Text
"P.neq" [PParameter p -> Text
forall a. ToGreskell a => a -> Text
toGremlin PParameter p
arg]

-- | @P.lt@ static method.
pLt :: PLike p => PParameter p -> Greskell p
pLt :: PParameter p -> Greskell p
pLt PParameter p
arg = Text -> [Text] -> Greskell p
forall a. Text -> [Text] -> Greskell a
unsafeFunCall Text
"P.lt" [PParameter p -> Text
forall a. ToGreskell a => a -> Text
toGremlin PParameter p
arg]

-- | @P.lte@ static method.
pLte :: PLike p => PParameter p -> Greskell p
pLte :: PParameter p -> Greskell p
pLte PParameter p
arg = Text -> [Text] -> Greskell p
forall a. Text -> [Text] -> Greskell a
unsafeFunCall Text
"P.lte" [PParameter p -> Text
forall a. ToGreskell a => a -> Text
toGremlin PParameter p
arg]

-- | @P.gt@ static method.
pGt :: PLike p => PParameter p -> Greskell p
pGt :: PParameter p -> Greskell p
pGt PParameter p
arg = Text -> [Text] -> Greskell p
forall a. Text -> [Text] -> Greskell a
unsafeFunCall Text
"P.gt" [PParameter p -> Text
forall a. ToGreskell a => a -> Text
toGremlin PParameter p
arg]

-- | @P.gte@ static method.
pGte :: PLike p => PParameter p -> Greskell p
pGte :: PParameter p -> Greskell p
pGte PParameter p
arg = Text -> [Text] -> Greskell p
forall a. Text -> [Text] -> Greskell a
unsafeFunCall Text
"P.gte" [PParameter p -> Text
forall a. ToGreskell a => a -> Text
toGremlin PParameter p
arg]

-- | @P.inside@ static method.
--
-- >>> toGremlin (pInside 10 20 :: Greskell (P Int))
-- "P.inside(10,20)"
pInside :: PLike p => PParameter p -> PParameter p -> Greskell p
pInside :: PParameter p -> PParameter p -> Greskell p
pInside PParameter p
a PParameter p
b = Text -> [Text] -> Greskell p
forall a. Text -> [Text] -> Greskell a
unsafeFunCall Text
"P.inside" ([Text] -> Greskell p) -> [Text] -> Greskell p
forall a b. (a -> b) -> a -> b
$ (PParameter p -> Text) -> [PParameter p] -> [Text]
forall a b. (a -> b) -> [a] -> [b]
map PParameter p -> Text
forall a. ToGreskell a => a -> Text
toGremlin [PParameter p
a, PParameter p
b]

-- | @P.outside@ static method.
pOutside :: PLike p => PParameter p -> PParameter p -> Greskell p
pOutside :: PParameter p -> PParameter p -> Greskell p
pOutside PParameter p
a PParameter p
b = Text -> [Text] -> Greskell p
forall a. Text -> [Text] -> Greskell a
unsafeFunCall Text
"P.outside" ([Text] -> Greskell p) -> [Text] -> Greskell p
forall a b. (a -> b) -> a -> b
$ (PParameter p -> Text) -> [PParameter p] -> [Text]
forall a b. (a -> b) -> [a] -> [b]
map PParameter p -> Text
forall a. ToGreskell a => a -> Text
toGremlin [PParameter p
a, PParameter p
b]

-- | @P.between@ static method.
pBetween :: PLike p => PParameter p -> PParameter p -> Greskell p
pBetween :: PParameter p -> PParameter p -> Greskell p
pBetween PParameter p
a PParameter p
b = Text -> [Text] -> Greskell p
forall a. Text -> [Text] -> Greskell a
unsafeFunCall Text
"P.between" ([Text] -> Greskell p) -> [Text] -> Greskell p
forall a b. (a -> b) -> a -> b
$ (PParameter p -> Text) -> [PParameter p] -> [Text]
forall a b. (a -> b) -> [a] -> [b]
map PParameter p -> Text
forall a. ToGreskell a => a -> Text
toGremlin [PParameter p
a, PParameter p
b]

-- | @P.within@ static method.
--
-- >>> toGremlin (pWithin ["foo", "bar", "hoge"] :: Greskell (P Text))
-- "P.within(\"foo\",\"bar\",\"hoge\")"
pWithin :: PLike p => [PParameter p] -> Greskell p
pWithin :: [PParameter p] -> Greskell p
pWithin = Text -> [Text] -> Greskell p
forall a. Text -> [Text] -> Greskell a
unsafeFunCall Text
"P.within" ([Text] -> Greskell p)
-> ([PParameter p] -> [Text]) -> [PParameter p] -> Greskell p
forall b c a. (b -> c) -> (a -> b) -> a -> c
. (PParameter p -> Text) -> [PParameter p] -> [Text]
forall a b. (a -> b) -> [a] -> [b]
map PParameter p -> Text
forall a. ToGreskell a => a -> Text
toGremlin

-- | @P.without@ static method.
pWithout :: PLike p => [PParameter p] -> Greskell p
pWithout :: [PParameter p] -> Greskell p
pWithout = Text -> [Text] -> Greskell p
forall a. Text -> [Text] -> Greskell a
unsafeFunCall Text
"P.without" ([Text] -> Greskell p)
-> ([PParameter p] -> [Text]) -> [PParameter p] -> Greskell p
forall b c a. (b -> c) -> (a -> b) -> a -> c
. (PParameter p -> Text) -> [PParameter p] -> [Text]
forall a b. (a -> b) -> [a] -> [b]
map PParameter p -> Text
forall a. ToGreskell a => a -> Text
toGremlin

-- | @java.util.Comparator@ interface.
--
-- 'Comparator' compares two data of type 'CompareArg' @c@.
class Comparator c where
  type CompareArg c
  -- | @.compare@ method.
  cCompare :: Greskell c -> Greskell (CompareArg c) -> Greskell (CompareArg c) -> Greskell Int
  cCompare Greskell c
cmp Greskell (CompareArg c)
a Greskell (CompareArg c)
b = Greskell c -> Text -> [Text] -> Greskell Int
forall a b. Greskell a -> Text -> [Text] -> Greskell b
unsafeMethodCall Greskell c
cmp Text
"compare" ([Text] -> Greskell Int) -> [Text] -> Greskell Int
forall a b. (a -> b) -> a -> b
$ (Greskell (CompareArg c) -> Text)
-> [Greskell (CompareArg c)] -> [Text]
forall a b. (a -> b) -> [a] -> [b]
map Greskell (CompareArg c) -> Text
forall a. ToGreskell a => a -> Text
toGremlin [Greskell (CompareArg c)
a, Greskell (CompareArg c)
b]
  -- | @.reversed@ method.
  cReversed :: Greskell c -> Greskell c
  cReversed Greskell c
cmp = Greskell c -> Text -> [Text] -> Greskell c
forall a b. Greskell a -> Text -> [Text] -> Greskell b
unsafeMethodCall Greskell c
cmp Text
"reversed" []
  -- | @.thenComparing@ method.
  cThenComparing :: Greskell c -> Greskell c -> Greskell c
  cThenComparing Greskell c
cmp1 Greskell c
cmp2 = Greskell c -> Text -> [Text] -> Greskell c
forall a b. Greskell a -> Text -> [Text] -> Greskell b
unsafeMethodCall Greskell c
cmp1 Text
"thenComparing" [Greskell c -> Text
forall a. ToGreskell a => a -> Text
toGremlin Greskell c
cmp2]

-- | Type for anonymous class of @Comparator@ interface.
newtype ComparatorA a = ComparatorA { ComparatorA a -> a -> a -> Int
unComparatorA :: a -> a -> Int }

instance Comparator (ComparatorA a) where
  type CompareArg (ComparatorA a) = a

-- | @org.apache.tinkerpop.gremlin.process.traversal.Order@ enum.
data Order a

-- | @Order a@ compares the type @a@.
instance Comparator (Order a) where
  type CompareArg (Order a) = a

instance GraphSONTyped (Order a) where
  gsonTypeFor :: Order a -> Text
gsonTypeFor Order a
_ = Text
"g:Order"

-- | @decr@ order.
--
-- >>> toGremlin oDecr
-- "Order.decr"
oDecr :: Greskell (Order a)
oDecr :: Greskell (Order a)
oDecr = Text -> Greskell (Order a)
forall a. Text -> Greskell a
unsafeGreskellLazy Text
"Order.decr"

-- | @incr@ order.
oIncr :: Greskell (Order a)
oIncr :: Greskell (Order a)
oIncr = Text -> Greskell (Order a)
forall a. Text -> Greskell a
unsafeGreskellLazy Text
"Order.incr"

-- | @shuffle@ order.
oShuffle :: Greskell (Order a)
oShuffle :: Greskell (Order a)
oShuffle = Text -> Greskell (Order a)
forall a. Text -> Greskell a
unsafeGreskellLazy Text
"Order.shuffle"