{-# OPTIONS_HADDOCK not-home #-}

{-# LANGUAGE Arrows #-}
{-# LANGUAGE TypeSynonymInstances #-}

module Opaleye.Internal.QueryArr where

import           Prelude hiding (id)

import qualified Opaleye.Internal.Unpackspec as U
import qualified Opaleye.Internal.Tag as Tag
import           Opaleye.Internal.Tag (Tag)
import qualified Opaleye.Internal.PrimQuery as PQ

import qualified Opaleye.Internal.HaskellDB.PrimQuery as HPQ

import qualified Control.Arrow as Arr
import           Control.Arrow ((&&&), (***), arr, returnA)
import qualified Control.Category as C
import           Control.Category ((<<<), id)
import           Control.Applicative (Applicative, pure, (<*>))
import           Control.Monad.Trans.State.Strict (State, runState, state)
import qualified Data.Profunctor as P
import qualified Data.Profunctor.Product as PP
import           Data.Semigroup ((<>))

-- | A parametrised 'Select'.  A @SelectArr a b@ accepts an argument
-- of type @a@.
--
-- @SelectArr a b@ is analogous to a Haskell function @a -> [b]@.
newtype SelectArr a b = QueryArr { SelectArr a b -> a -> State Tag (b, PrimQueryArr)
unQueryArr :: a -> State Tag (b, PQ.PrimQueryArr) }

type QueryArr = SelectArr
type Query = SelectArr ()

productQueryArr' :: (a -> State Tag (b, PQ.PrimQuery)) -> QueryArr a b
productQueryArr' :: (a -> State Tag (b, PrimQuery)) -> QueryArr a b
productQueryArr' a -> State Tag (b, PrimQuery)
f = (a -> State Tag (b, PrimQueryArr)) -> QueryArr a b
forall a b. (a -> State Tag (b, PrimQueryArr)) -> SelectArr a b
QueryArr ((a -> State Tag (b, PrimQueryArr)) -> QueryArr a b)
-> (a -> State Tag (b, PrimQueryArr)) -> QueryArr a b
forall a b. (a -> b) -> a -> b
$ \a
a -> do
  (b
b, PrimQuery
pq) <- a -> State Tag (b, PrimQuery)
f a
a
  (b, PrimQueryArr) -> State Tag (b, PrimQueryArr)
forall (f :: * -> *) a. Applicative f => a -> f a
pure (b
b, PrimQuery -> PrimQueryArr
PQ.aProduct PrimQuery
pq)

leftJoinQueryArr' :: (a -> State Tag (b, HPQ.PrimExpr, PQ.PrimQuery)) -> QueryArr a b
leftJoinQueryArr' :: (a -> State Tag (b, PrimExpr, PrimQuery)) -> QueryArr a b
leftJoinQueryArr' a -> State Tag (b, PrimExpr, PrimQuery)
f = (a -> State Tag (b, PrimQueryArr)) -> QueryArr a b
forall a b. (a -> State Tag (b, PrimQueryArr)) -> SelectArr a b
QueryArr ((a -> State Tag (b, PrimQueryArr)) -> QueryArr a b)
-> (a -> State Tag (b, PrimQueryArr)) -> QueryArr a b
forall a b. (a -> b) -> a -> b
$ \a
a -> do
  (b
a1, PrimExpr
cond, PrimQuery
primQuery') <- a -> State Tag (b, PrimExpr, PrimQuery)
f a
a
  (b, PrimQueryArr) -> State Tag (b, PrimQueryArr)
forall (f :: * -> *) a. Applicative f => a -> f a
pure (b
a1, PrimExpr -> PrimQuery -> PrimQueryArr
PQ.aLeftJoin PrimExpr
cond PrimQuery
primQuery')

runSimpleQueryArr' :: QueryArr a b -> a -> State Tag (b, PQ.PrimQuery)
runSimpleQueryArr' :: QueryArr a b -> a -> State Tag (b, PrimQuery)
runSimpleQueryArr' QueryArr a b
f a
a = do
  (b
b, PrimQueryArr
pqf) <- QueryArr a b -> a -> State Tag (b, PrimQueryArr)
forall a b. SelectArr a b -> a -> State Tag (b, PrimQueryArr)
unQueryArr QueryArr a b
f a
a
  (b, PrimQuery) -> State Tag (b, PrimQuery)
forall (f :: * -> *) a. Applicative f => a -> f a
pure (b
b, PrimQueryArr -> PrimQuery
PQ.toPrimQuery PrimQueryArr
pqf)

runStateQueryArr :: QueryArr a b -> a -> Tag -> (b, PQ.PrimQueryArr, Tag)
runStateQueryArr :: QueryArr a b -> a -> Tag -> (b, PrimQueryArr, Tag)
runStateQueryArr (QueryArr a -> State Tag (b, PrimQueryArr)
f) a
a Tag
tag =
  let ((b
b, PrimQueryArr
pq), Tag
tag') = State Tag (b, PrimQueryArr) -> Tag -> ((b, PrimQueryArr), Tag)
forall s a. State s a -> s -> (a, s)
runState (a -> State Tag (b, PrimQueryArr)
f a
a) Tag
tag
  in (b
b, PrimQueryArr
pq, Tag
tag')

stateQueryArr :: (a -> Tag -> (b, PQ.PrimQueryArr, Tag)) -> QueryArr a b
stateQueryArr :: (a -> Tag -> (b, PrimQueryArr, Tag)) -> QueryArr a b
stateQueryArr a -> Tag -> (b, PrimQueryArr, Tag)
f = (a -> State Tag (b, PrimQueryArr)) -> QueryArr a b
forall a b. (a -> State Tag (b, PrimQueryArr)) -> SelectArr a b
QueryArr ((a -> State Tag (b, PrimQueryArr)) -> QueryArr a b)
-> (a -> State Tag (b, PrimQueryArr)) -> QueryArr a b
forall a b. (a -> b) -> a -> b
$ \a
a -> (Tag -> ((b, PrimQueryArr), Tag)) -> State Tag (b, PrimQueryArr)
forall (m :: * -> *) s a. Monad m => (s -> (a, s)) -> StateT s m a
state ((Tag -> ((b, PrimQueryArr), Tag)) -> State Tag (b, PrimQueryArr))
-> (Tag -> ((b, PrimQueryArr), Tag)) -> State Tag (b, PrimQueryArr)
forall a b. (a -> b) -> a -> b
$ \Tag
tag ->
  let (b
b, PrimQueryArr
pq, Tag
tag') = a -> Tag -> (b, PrimQueryArr, Tag)
f a
a Tag
tag
  in ((b
b, PrimQueryArr
pq), Tag
tag')

runSimpleQueryArrStart :: QueryArr a b -> a -> (b, PQ.PrimQuery, Tag)
runSimpleQueryArrStart :: QueryArr a b -> a -> (b, PrimQuery, Tag)
runSimpleQueryArrStart QueryArr a b
q a
a =
  let ((b
b, PrimQuery
pqa), Tag
t') = State Tag (b, PrimQuery) -> Tag -> ((b, PrimQuery), Tag)
forall s a. State s a -> s -> (a, s)
runState (QueryArr a b -> a -> State Tag (b, PrimQuery)
forall a b. QueryArr a b -> a -> State Tag (b, PrimQuery)
runSimpleQueryArr' QueryArr a b
q a
a) Tag
Tag.start
  in (b
b, PrimQuery
pqa, Tag
t')

runQueryArrUnpack :: U.Unpackspec a b
                  -> Query a -> ([HPQ.PrimExpr], PQ.PrimQuery, Tag)
runQueryArrUnpack :: Unpackspec a b -> Query a -> ([PrimExpr], PrimQuery, Tag)
runQueryArrUnpack Unpackspec a b
unpackspec Query a
q = ([PrimExpr]
primExprs, PrimQuery
primQ, Tag
endTag)
  where (a
columns, PrimQuery
primQ, Tag
endTag) = Query a -> () -> (a, PrimQuery, Tag)
forall a b. QueryArr a b -> a -> (b, PrimQuery, Tag)
runSimpleQueryArrStart Query a
q ()
        primExprs :: [PrimExpr]
primExprs = Unpackspec a b -> a -> [PrimExpr]
forall s t. Unpackspec s t -> s -> [PrimExpr]
U.collectPEs Unpackspec a b
unpackspec a
columns

-- | A @SELECT@, i.e. an SQL query which produces a collection of
-- rows.
--
-- @Select a@ is analogous to a Haskell value @[a]@.
type Select = SelectArr ()

-- | Implements @LATERAL@ subqueries.
--
-- You might find it easier to use 'Opaleye.Lateral.laterally' (if you
-- want to apply 'Opaleye.Aggregate.aggregate',
-- 'Opaleye.Order.orderBy' or 'Opaleye.Order.limit' to a 'SelectArr')
-- or 'Opaleye.Lateral.bilaterally' (if you want to apply
-- 'Opaleye.Binary.union', 'Opaleye.Binary.intersect' and
-- 'Opaleye.Binary.except' to two 'SelectArr's).
lateral :: (i -> Select a) -> SelectArr i a
lateral :: (i -> Select a) -> SelectArr i a
lateral i -> Select a
f = (i -> State Tag (a, PrimQueryArr)) -> SelectArr i a
forall a b. (a -> State Tag (b, PrimQueryArr)) -> SelectArr a b
QueryArr ((i -> State Tag (a, PrimQueryArr)) -> SelectArr i a)
-> (i -> State Tag (a, PrimQueryArr)) -> SelectArr i a
forall a b. (a -> b) -> a -> b
$ \i
i -> do
  (a
a, PrimQueryArr
primQueryR) <- Select a -> () -> State Tag (a, PrimQueryArr)
forall a b. SelectArr a b -> a -> State Tag (b, PrimQueryArr)
unQueryArr (i -> Select a
f i
i) ()
  (a, PrimQueryArr) -> State Tag (a, PrimQueryArr)
forall (f :: * -> *) a. Applicative f => a -> f a
pure (a
a, PrimQueryArr -> PrimQueryArr
PQ.lateral PrimQueryArr
primQueryR)

-- | Convert an arrow argument into a function argument so that it can
-- be applied inside @do@-notation rather than arrow notation.
viaLateral :: SelectArr i a -> i -> Select a
viaLateral :: SelectArr i a -> i -> Select a
viaLateral SelectArr i a
s i
i = SelectArr i a
s SelectArr i a -> SelectArr () i -> Select a
forall k (cat :: k -> k -> *) (b :: k) (c :: k) (a :: k).
Category cat =>
cat b c -> cat a b -> cat a c
<<< i -> SelectArr () i
forall (f :: * -> *) a. Applicative f => a -> f a
pure i
i

bind :: SelectArr i a -> (a -> SelectArr i b) -> SelectArr i b
bind :: SelectArr i a -> (a -> SelectArr i b) -> SelectArr i b
bind SelectArr i a
s a -> SelectArr i b
f = proc i
i -> do
  a
a <- SelectArr i a
s -< i
i
  b
b <- ((a, i) -> Select b) -> SelectArr (a, i) b
forall i a. (i -> Select a) -> SelectArr i a
lateral (\(a
a, i
i) -> SelectArr i b -> i -> Select b
forall i a. SelectArr i a -> i -> Select a
viaLateral (a -> SelectArr i b
f a
a) i
i) -< (a
a, i
i)
  SelectArr b b
forall (a :: * -> * -> *) b. Arrow a => a b b
returnA -< b
b

arrowApply :: SelectArr (SelectArr i a, i) a
arrowApply :: SelectArr (SelectArr i a, i) a
arrowApply = ((SelectArr i a, i) -> Select a) -> SelectArr (SelectArr i a, i) a
forall i a. (i -> Select a) -> SelectArr i a
lateral (\(SelectArr i a
f, i
i) -> SelectArr i a -> i -> Select a
forall i a. SelectArr i a -> i -> Select a
viaLateral SelectArr i a
f i
i)

instance C.Category QueryArr where
  id :: QueryArr a a
id = (a -> a) -> QueryArr a a
forall (a :: * -> * -> *) b c. Arrow a => (b -> c) -> a b c
arr a -> a
forall k (cat :: k -> k -> *) (a :: k). Category cat => cat a a
id
  QueryArr b -> State Tag (c, PrimQueryArr)
f . :: QueryArr b c -> QueryArr a b -> QueryArr a c
. QueryArr a -> State Tag (b, PrimQueryArr)
g = (a -> State Tag (c, PrimQueryArr)) -> QueryArr a c
forall a b. (a -> State Tag (b, PrimQueryArr)) -> SelectArr a b
QueryArr ((a -> State Tag (c, PrimQueryArr)) -> QueryArr a c)
-> (a -> State Tag (c, PrimQueryArr)) -> QueryArr a c
forall a b. (a -> b) -> a -> b
$ \a
a -> do
    (b
b, PrimQueryArr
pqf)  <- a -> State Tag (b, PrimQueryArr)
g a
a
    (c
c, PrimQueryArr
pqf') <- b -> State Tag (c, PrimQueryArr)
f b
b
    (c, PrimQueryArr) -> State Tag (c, PrimQueryArr)
forall (f :: * -> *) a. Applicative f => a -> f a
pure (c
c, PrimQueryArr
pqf PrimQueryArr -> PrimQueryArr -> PrimQueryArr
forall a. Semigroup a => a -> a -> a
<> PrimQueryArr
pqf')

instance Arr.Arrow QueryArr where
  arr :: (b -> c) -> QueryArr b c
arr b -> c
f   = (b -> State Tag (c, PrimQueryArr)) -> QueryArr b c
forall a b. (a -> State Tag (b, PrimQueryArr)) -> SelectArr a b
QueryArr (\b
a -> (c, PrimQueryArr) -> State Tag (c, PrimQueryArr)
forall (f :: * -> *) a. Applicative f => a -> f a
pure (b -> c
f b
a, PrimQueryArr
forall a. Monoid a => a
mempty))
  first :: QueryArr b c -> QueryArr (b, d) (c, d)
first (QueryArr b -> State Tag (c, PrimQueryArr)
f) = ((b, d) -> State Tag ((c, d), PrimQueryArr))
-> QueryArr (b, d) (c, d)
forall a b. (a -> State Tag (b, PrimQueryArr)) -> SelectArr a b
QueryArr (b, d) -> State Tag ((c, d), PrimQueryArr)
forall b. (b, b) -> StateT Tag Identity ((c, b), PrimQueryArr)
g
    where g :: (b, b) -> StateT Tag Identity ((c, b), PrimQueryArr)
g (b
b, b
d) = do
            (c
c, PrimQueryArr
pq) <- b -> State Tag (c, PrimQueryArr)
f b
b
            ((c, b), PrimQueryArr)
-> StateT Tag Identity ((c, b), PrimQueryArr)
forall (f :: * -> *) a. Applicative f => a -> f a
pure ((c
c, b
d), PrimQueryArr
pq)

instance Arr.ArrowChoice QueryArr where
  left :: QueryArr b c -> QueryArr (Either b d) (Either c d)
left (QueryArr b -> State Tag (c, PrimQueryArr)
f) = (Either b d -> State Tag (Either c d, PrimQueryArr))
-> QueryArr (Either b d) (Either c d)
forall a b. (a -> State Tag (b, PrimQueryArr)) -> SelectArr a b
QueryArr Either b d -> State Tag (Either c d, PrimQueryArr)
forall b.
Either b b -> StateT Tag Identity (Either c b, PrimQueryArr)
g
    where g :: Either b b -> StateT Tag Identity (Either c b, PrimQueryArr)
g Either b b
e = case Either b b
e of
            Left b
a -> do
              (c
r, PrimQueryArr
pq) <- b -> State Tag (c, PrimQueryArr)
f b
a
              (Either c b, PrimQueryArr)
-> StateT Tag Identity (Either c b, PrimQueryArr)
forall (f :: * -> *) a. Applicative f => a -> f a
pure (c -> Either c b
forall a b. a -> Either a b
Left c
r, PrimQueryArr
pq)
            Right b
b -> (Either c b, PrimQueryArr)
-> StateT Tag Identity (Either c b, PrimQueryArr)
forall (f :: * -> *) a. Applicative f => a -> f a
pure (b -> Either c b
forall a b. b -> Either a b
Right b
b, PrimQueryArr
forall a. Monoid a => a
mempty)

instance Arr.ArrowApply QueryArr where
  app :: QueryArr (QueryArr b c, b) c
app = QueryArr (QueryArr b c, b) c
forall b c. QueryArr (QueryArr b c, b) c
arrowApply

instance Functor (QueryArr a) where
  fmap :: (a -> b) -> QueryArr a a -> QueryArr a b
fmap a -> b
f = ((a -> b) -> SelectArr a b
forall (a :: * -> * -> *) b c. Arrow a => (b -> c) -> a b c
arr a -> b
f SelectArr a b -> QueryArr a a -> QueryArr a b
forall k (cat :: k -> k -> *) (b :: k) (c :: k) (a :: k).
Category cat =>
cat b c -> cat a b -> cat a c
<<<)

instance Applicative (QueryArr a) where
  pure :: a -> QueryArr a a
pure = (a -> a) -> QueryArr a a
forall (a :: * -> * -> *) b c. Arrow a => (b -> c) -> a b c
arr ((a -> a) -> QueryArr a a) -> (a -> a -> a) -> a -> QueryArr a a
forall b c a. (b -> c) -> (a -> b) -> a -> c
. a -> a -> a
forall a b. a -> b -> a
const
  QueryArr a (a -> b)
f <*> :: QueryArr a (a -> b) -> QueryArr a a -> QueryArr a b
<*> QueryArr a a
g = ((a -> b, a) -> b) -> SelectArr (a -> b, a) b
forall (a :: * -> * -> *) b c. Arrow a => (b -> c) -> a b c
arr (((a -> b) -> a -> b) -> (a -> b, a) -> b
forall a b c. (a -> b -> c) -> (a, b) -> c
uncurry (a -> b) -> a -> b
forall a b. (a -> b) -> a -> b
($)) SelectArr (a -> b, a) b -> SelectArr a (a -> b, a) -> QueryArr a b
forall k (cat :: k -> k -> *) (b :: k) (c :: k) (a :: k).
Category cat =>
cat b c -> cat a b -> cat a c
<<< (QueryArr a (a -> b)
f QueryArr a (a -> b) -> QueryArr a a -> SelectArr a (a -> b, a)
forall (a :: * -> * -> *) b c c'.
Arrow a =>
a b c -> a b c' -> a b (c, c')
&&& QueryArr a a
g)

instance Monad (QueryArr a) where
  return :: a -> QueryArr a a
return = a -> QueryArr a a
forall (f :: * -> *) a. Applicative f => a -> f a
pure
  >>= :: QueryArr a a -> (a -> QueryArr a b) -> QueryArr a b
(>>=) = QueryArr a a -> (a -> QueryArr a b) -> QueryArr a b
forall a a b. QueryArr a a -> (a -> QueryArr a b) -> QueryArr a b
bind

instance P.Profunctor QueryArr where
  dimap :: (a -> b) -> (c -> d) -> QueryArr b c -> QueryArr a d
dimap a -> b
f c -> d
g QueryArr b c
a = (c -> d) -> SelectArr c d
forall (a :: * -> * -> *) b c. Arrow a => (b -> c) -> a b c
arr c -> d
g SelectArr c d -> SelectArr a c -> QueryArr a d
forall k (cat :: k -> k -> *) (b :: k) (c :: k) (a :: k).
Category cat =>
cat b c -> cat a b -> cat a c
<<< QueryArr b c
a QueryArr b c -> SelectArr a b -> SelectArr a c
forall k (cat :: k -> k -> *) (b :: k) (c :: k) (a :: k).
Category cat =>
cat b c -> cat a b -> cat a c
<<< (a -> b) -> SelectArr a b
forall (a :: * -> * -> *) b c. Arrow a => (b -> c) -> a b c
arr a -> b
f

instance PP.ProductProfunctor QueryArr where
  empty :: QueryArr () ()
empty = QueryArr () ()
forall k (cat :: k -> k -> *) (a :: k). Category cat => cat a a
id
  ***! :: QueryArr a b -> QueryArr a' b' -> QueryArr (a, a') (b, b')
(***!) = QueryArr a b -> QueryArr a' b' -> QueryArr (a, a') (b, b')
forall (a :: * -> * -> *) b c b' c'.
Arrow a =>
a b c -> a b' c' -> a (b, b') (c, c')
(***)