{-# LANGUAGE CPP                   #-}
{-# LANGUAGE DefaultSignatures     #-}
{-# LANGUAGE DeriveDataTypeable    #-}
{-# LANGUAGE FlexibleContexts      #-}
{-# LANGUAGE FlexibleInstances     #-}
{-# LANGUAGE MultiParamTypeClasses #-}
{-# LANGUAGE PatternSynonyms       #-}
{-# LANGUAGE RankNTypes            #-}
{-# LANGUAGE Trustworthy           #-}
{-# LANGUAGE TypeFamilies          #-}
{-# LANGUAGE ViewPatterns          #-}
{-# OPTIONS_GHC -fno-warn-orphans #-}
--------------------------------------------------------------------
-- |
-- Copyright :  (c) Oleg Grenrus 2019, (c) Edward Kmett 2013-2019, (c) Paul Wilson 2012
-- License   :  MIT
-- Maintainer:  Edward Kmett <ekmett@gmail.com>
-- Stability :  experimental
-- Portability: non-portable
--
-- This module also exports orphan @'Ixed' 'Value'@ and
-- @'Plated' 'Value'@ instances.
--------------------------------------------------------------------
module Data.Aeson.Optics
  (
  -- * Numbers
    AsNumber(..)
  , _Integral
  , nonNull
  -- * Objects and Arrays
  , AsValue(..)
  , key, members
  , nth, values
  , IsKey (..)
  -- * Decoding
  , AsJSON(..)
  , _JSON'
  -- * Pattern Synonyms
  , pattern JSON
  , pattern Value_
  , pattern Number_
  , pattern Double
  , pattern Integer
  , pattern Integral
  , pattern Bool_
  , pattern String_
  , pattern Null_
  , pattern Key_
  ) where

import Prelude hiding (null)

import Data.Aeson
       (FromJSON, Result (..), ToJSON, Value (..), encode, fromJSON, toJSON)
import Data.Aeson.Parser               (value)
import Data.Attoparsec.ByteString.Lazy (maybeResult, parse)
import Data.Scientific                 (Scientific)
import Data.Text                       (Text)
import Data.Text.Optics                (packed)
import Data.Text.Short                 (ShortText)
import Data.Vector                     (Vector)

import Optics.At ()
import Optics.Core
import Optics.Indexed ()

import qualified Data.Aeson.Key             as Key
import qualified Data.Aeson.KeyMap          as KM
import qualified Data.ByteString            as Strict
import qualified Data.ByteString.Lazy       as LBS
import qualified Data.Scientific            as Scientific
import qualified Data.Text                  as StrictText
import qualified Data.Text.Encoding         as StrictText
import qualified Data.Text.Lazy             as LazyText
import qualified Data.Text.Lazy.Encoding    as LazyText

-- $setup
-- >>> import Optics.Core
-- >>> import Data.Aeson (Value (..))
-- >>> import Data.Text (Text)
-- >>> import qualified Data.ByteString             as Strict
-- >>> import qualified Data.ByteString.Char8       as Strict.Char8
-- >>> import qualified Data.ByteString.Lazy        as Lazy
-- >>> import qualified Data.ByteString.Lazy.Char8  as Lazy.Char8
-- >>> import qualified Data.Aeson.KeyMap           as KeyMap
-- >>> import qualified Data.Vector                 as Vector
-- >>> :set -XOverloadedStrings
-- >>> import Optics.Operators

------------------------------------------------------------------------------
-- Scientific prisms
------------------------------------------------------------------------------

class AsNumber t where
  -- |
  -- >>> "[1, \"x\"]" ^? nth 0 % _Number
  -- Just 1.0
  --
  -- >>> "[1, \"x\"]" ^? nth 1 % _Number
  -- Nothing
  _Number :: Prism' t Scientific
  default _Number :: AsValue t => Prism' t Scientific
  _Number = Prism' t Value
forall t. AsValue t => Prism' t Value
_ValuePrism' t Value
-> Optic A_Prism NoIx Value Value Scientific Scientific
-> Prism' t Scientific
forall k l m (is :: IxList) (js :: IxList) (ks :: IxList) s t u v a
       b.
(JoinKinds k l m, AppendIndices is js ks) =>
Optic k is s t u v -> Optic l js u v a b -> Optic m ks s t a b
%Optic A_Prism NoIx Value Value Scientific Scientific
forall t. AsNumber t => Prism' t Scientific
_Number
  {-# INLINE _Number #-}

  -- |
  -- Prism into an 'Double' over a 'Value', 'Primitive' or 'Scientific'
  --
  -- >>> "[10.2]" ^? nth 0 % _Double
  -- Just 10.2
  _Double :: Prism' t Double
  _Double = Prism' t Scientific
forall t. AsNumber t => Prism' t Scientific
_NumberPrism' t Scientific
-> Optic An_Iso NoIx Scientific Scientific Double Double
-> Prism' t Double
forall k l m (is :: IxList) (js :: IxList) (ks :: IxList) s t u v a
       b.
(JoinKinds k l m, AppendIndices is js ks) =>
Optic k is s t u v -> Optic l js u v a b -> Optic m ks s t a b
%(Scientific -> Double)
-> (Double -> Scientific)
-> Optic An_Iso NoIx Scientific Scientific Double Double
forall s a b t. (s -> a) -> (b -> t) -> Iso s t a b
iso Scientific -> Double
forall a. RealFloat a => Scientific -> a
Scientific.toRealFloat Double -> Scientific
forall a b. (Real a, Fractional b) => a -> b
realToFrac
  {-# INLINE _Double #-}

  -- |
  -- Prism into an 'Integer' over a 'Value', 'Primitive' or 'Scientific'
  --
  -- >>> "[10]" ^? nth 0 % _Integer
  -- Just 10
  --
  -- >>> "[10.5]" ^? nth 0 % _Integer
  -- Just 10
  --
  -- >>> "42" ^? _Integer
  -- Just 42
  _Integer :: Prism' t Integer
  _Integer = Prism' t Scientific
forall t. AsNumber t => Prism' t Scientific
_NumberPrism' t Scientific
-> Optic An_Iso NoIx Scientific Scientific Integer Integer
-> Prism' t Integer
forall k l m (is :: IxList) (js :: IxList) (ks :: IxList) s t u v a
       b.
(JoinKinds k l m, AppendIndices is js ks) =>
Optic k is s t u v -> Optic l js u v a b -> Optic m ks s t a b
%(Scientific -> Integer)
-> (Integer -> Scientific)
-> Optic An_Iso NoIx Scientific Scientific Integer Integer
forall s a b t. (s -> a) -> (b -> t) -> Iso s t a b
iso Scientific -> Integer
forall a b. (RealFrac a, Integral b) => a -> b
floor Integer -> Scientific
forall a b. (Integral a, Num b) => a -> b
fromIntegral
  {-# INLINE _Integer #-}

instance AsNumber Value where
  _Number :: Optic A_Prism NoIx Value Value Scientific Scientific
_Number = (Scientific -> Value)
-> (Value -> Either Value Scientific)
-> Optic A_Prism NoIx Value Value Scientific Scientific
forall b t s a. (b -> t) -> (s -> Either t a) -> Prism s t a b
prism Scientific -> Value
Number ((Value -> Either Value Scientific)
 -> Optic A_Prism NoIx Value Value Scientific Scientific)
-> (Value -> Either Value Scientific)
-> Optic A_Prism NoIx Value Value Scientific Scientific
forall a b. (a -> b) -> a -> b
$ \Value
v -> case Value
v of Number Scientific
n -> Scientific -> Either Value Scientific
forall a b. b -> Either a b
Right Scientific
n; Value
_ -> Value -> Either Value Scientific
forall a b. a -> Either a b
Left Value
v
  {-# INLINE _Number #-}

instance AsNumber Scientific where
  _Number :: Prism' Scientific Scientific
_Number = Optic An_Iso NoIx Scientific Scientific Scientific Scientific
-> Prism' Scientific Scientific
forall destKind srcKind (is :: IxList) s t a b.
Is srcKind destKind =>
Optic srcKind is s t a b -> Optic destKind is s t a b
castOptic Optic An_Iso NoIx Scientific Scientific Scientific Scientific
forall a. Iso' a a
simple
  {-# INLINE _Number #-}

instance AsNumber Strict.ByteString
instance AsNumber LBS.ByteString
instance AsNumber Text
instance AsNumber LazyText.Text
instance AsNumber String

------------------------------------------------------------------------------
-- Conversion Prisms
------------------------------------------------------------------------------

-- | Access Integer 'Value's as Integrals.
--
-- >>> "[10]" ^? nth 0 % _Integral
-- Just 10
--
-- >>> "[10.5]" ^? nth 0 % _Integral
-- Just 10
_Integral :: (AsNumber t, Integral a) => Prism' t a
_Integral :: Prism' t a
_Integral = Prism' t Scientific
forall t. AsNumber t => Prism' t Scientific
_Number Prism' t Scientific
-> Optic An_Iso NoIx Scientific Scientific a a -> Prism' t a
forall k l m (is :: IxList) (js :: IxList) (ks :: IxList) s t u v a
       b.
(JoinKinds k l m, AppendIndices is js ks) =>
Optic k is s t u v -> Optic l js u v a b -> Optic m ks s t a b
% (Scientific -> a)
-> (a -> Scientific) -> Optic An_Iso NoIx Scientific Scientific a a
forall s a b t. (s -> a) -> (b -> t) -> Iso s t a b
iso Scientific -> a
forall a b. (RealFrac a, Integral b) => a -> b
floor a -> Scientific
forall a b. (Integral a, Num b) => a -> b
fromIntegral
{-# INLINE _Integral #-}

-- | Prism into non-'Null' values
--
-- >>> "{\"a\": \"xyz\", \"b\": null}" ^? key "a" % nonNull
-- Just (String "xyz")
--
-- >>> "{\"a\": {}, \"b\": null}" ^? key "a" % nonNull
-- Just (Object (fromList []))
--
-- >>> "{\"a\": \"xyz\", \"b\": null}" ^? key "b" % nonNull
-- Nothing
nonNull :: Prism' Value Value
nonNull :: Prism' Value Value
nonNull = (Value -> Value)
-> (Value -> Either Value Value) -> Prism' Value Value
forall b t s a. (b -> t) -> (s -> Either t a) -> Prism s t a b
prism Value -> Value
forall a. a -> a
id (\Value
v -> if Optic' A_Prism NoIx Value () -> Value -> Bool
forall k (is :: IxList) s a.
Is k An_AffineFold =>
Optic' k is s a -> s -> Bool
isn't Optic' A_Prism NoIx Value ()
forall t. AsValue t => Prism' t ()
_Null Value
v then Value -> Either Value Value
forall a b. b -> Either a b
Right Value
v else Value -> Either Value Value
forall a b. a -> Either a b
Left Value
v)
{-# INLINE nonNull #-}

------------------------------------------------------------------------------
-- Non-primitive traversals
------------------------------------------------------------------------------

class AsNumber t => AsValue t where
  -- |
  -- >>> preview _Value "[1,2,3]" == Just (Array (Vector.fromList [Number 1.0,Number 2.0,Number 3.0]))
  -- True
  _Value :: Prism' t Value

  -- |
  -- >>> "{\"a\": {}, \"b\": null}" ^? key "a" % _Object
  -- Just (fromList [])
  --
  -- >>> "{\"a\": {}, \"b\": null}" ^? key "b" % _Object
  -- Nothing
  --
  -- >>> _Object # KeyMap.fromList [("key", _String # "value")] :: String
  -- "{\"key\":\"value\"}"
  _Object :: Prism' t (KM.KeyMap Value)
  _Object = Prism' t Value
forall t. AsValue t => Prism' t Value
_ValuePrism' t Value
-> Optic A_Prism NoIx Value Value (KeyMap Value) (KeyMap Value)
-> Prism' t (KeyMap Value)
forall k l m (is :: IxList) (js :: IxList) (ks :: IxList) s t u v a
       b.
(JoinKinds k l m, AppendIndices is js ks) =>
Optic k is s t u v -> Optic l js u v a b -> Optic m ks s t a b
%(KeyMap Value -> Value)
-> (Value -> Either Value (KeyMap Value))
-> Optic A_Prism NoIx Value Value (KeyMap Value) (KeyMap Value)
forall b t s a. (b -> t) -> (s -> Either t a) -> Prism s t a b
prism KeyMap Value -> Value
Object  (\Value
v -> case Value
v of Object KeyMap Value
o -> KeyMap Value -> Either Value (KeyMap Value)
forall a b. b -> Either a b
Right KeyMap Value
o; Value
_ -> Value -> Either Value (KeyMap Value)
forall a b. a -> Either a b
Left Value
v)

  -- |
  -- >>> preview _Array "[1,2,3]" == Just (Vector.fromList [Number 1.0,Number 2.0,Number 3.0])
  -- True
  _Array :: Prism' t (Vector Value)
  _Array = Prism' t Value
forall t. AsValue t => Prism' t Value
_ValuePrism' t Value
-> Optic A_Prism NoIx Value Value (Vector Value) (Vector Value)
-> Prism' t (Vector Value)
forall k l m (is :: IxList) (js :: IxList) (ks :: IxList) s t u v a
       b.
(JoinKinds k l m, AppendIndices is js ks) =>
Optic k is s t u v -> Optic l js u v a b -> Optic m ks s t a b
%(Vector Value -> Value)
-> (Value -> Either Value (Vector Value))
-> Optic A_Prism NoIx Value Value (Vector Value) (Vector Value)
forall b t s a. (b -> t) -> (s -> Either t a) -> Prism s t a b
prism Vector Value -> Value
Array (\Value
v -> case Value
v of Array Vector Value
a -> Vector Value -> Either Value (Vector Value)
forall a b. b -> Either a b
Right Vector Value
a; Value
_ -> Value -> Either Value (Vector Value)
forall a b. a -> Either a b
Left Value
v)
  {-# INLINE _Array #-}

  -- |
  -- >>> "{\"a\": \"xyz\", \"b\": true}" ^? key "a" % _String
  -- Just "xyz"
  --
  -- >>> "{\"a\": \"xyz\", \"b\": true}" ^? key "b" % _String
  -- Nothing
  --
  -- >>> _Object # KeyMap.fromList [("key", _String # "value")] :: String
  -- "{\"key\":\"value\"}"
  _String :: Prism' t Text
  _String = Prism' t Value
forall t. AsValue t => Prism' t Value
_ValuePrism' t Value
-> Optic A_Prism NoIx Value Value Text Text -> Prism' t Text
forall k l m (is :: IxList) (js :: IxList) (ks :: IxList) s t u v a
       b.
(JoinKinds k l m, AppendIndices is js ks) =>
Optic k is s t u v -> Optic l js u v a b -> Optic m ks s t a b
%(Text -> Value)
-> (Value -> Either Value Text)
-> Optic A_Prism NoIx Value Value Text Text
forall b t s a. (b -> t) -> (s -> Either t a) -> Prism s t a b
prism Text -> Value
String (\Value
v -> case Value
v of String Text
s -> Text -> Either Value Text
forall a b. b -> Either a b
Right Text
s; Value
_ -> Value -> Either Value Text
forall a b. a -> Either a b
Left Value
v)
  {-# INLINE _String #-}

  -- |
  -- >>> "{\"a\": \"xyz\", \"b\": true}" ^? key "b" % _Bool
  -- Just True
  --
  -- >>> "{\"a\": \"xyz\", \"b\": true}" ^? key "a" % _Bool
  -- Nothing
  --
  -- >>> _Bool # True :: String
  -- "true"
  --
  -- >>> _Bool # False :: String
  -- "false"
  _Bool :: Prism' t Bool
  _Bool = Prism' t Value
forall t. AsValue t => Prism' t Value
_ValuePrism' t Value
-> Optic A_Prism NoIx Value Value Bool Bool -> Prism' t Bool
forall k l m (is :: IxList) (js :: IxList) (ks :: IxList) s t u v a
       b.
(JoinKinds k l m, AppendIndices is js ks) =>
Optic k is s t u v -> Optic l js u v a b -> Optic m ks s t a b
%(Bool -> Value)
-> (Value -> Either Value Bool)
-> Optic A_Prism NoIx Value Value Bool Bool
forall b t s a. (b -> t) -> (s -> Either t a) -> Prism s t a b
prism Bool -> Value
Bool (\Value
v -> case Value
v of Bool Bool
b -> Bool -> Either Value Bool
forall a b. b -> Either a b
Right Bool
b; Value
_ -> Value -> Either Value Bool
forall a b. a -> Either a b
Left Value
v)
  {-# INLINE _Bool #-}

  -- |
  -- >>> "{\"a\": \"xyz\", \"b\": null}" ^? key "b" % _Null
  -- Just ()
  --
  -- >>> "{\"a\": \"xyz\", \"b\": null}" ^? key "a" % _Null
  -- Nothing
  --
  -- >>> _Null # () :: String
  -- "null"
  _Null :: Prism' t ()
  _Null = Prism' t Value
forall t. AsValue t => Prism' t Value
_Value Prism' t Value -> Optic' A_Prism NoIx Value () -> Prism' t ()
forall k l m (is :: IxList) (js :: IxList) (ks :: IxList) s t u v a
       b.
(JoinKinds k l m, AppendIndices is js ks) =>
Optic k is s t u v -> Optic l js u v a b -> Optic m ks s t a b
% (() -> Value)
-> (Value -> Either Value ()) -> Optic' A_Prism NoIx Value ()
forall b t s a. (b -> t) -> (s -> Either t a) -> Prism s t a b
prism (Value -> () -> Value
forall a b. a -> b -> a
const Value
Null) (\Value
v -> case Value
v of Value
Null -> () -> Either Value ()
forall a b. b -> Either a b
Right (); Value
_ -> Value -> Either Value ()
forall a b. a -> Either a b
Left Value
v)
  {-# INLINE _Null #-}


instance AsValue Value where
  _Value :: Prism' Value Value
_Value = Optic An_Iso NoIx Value Value Value Value -> Prism' Value Value
forall destKind srcKind (is :: IxList) s t a b.
Is srcKind destKind =>
Optic srcKind is s t a b -> Optic destKind is s t a b
castOptic Optic An_Iso NoIx Value Value Value Value
forall a. Iso' a a
simple
  {-# INLINE _Value #-}

instance AsValue Strict.ByteString where
  _Value :: Prism' ByteString Value
_Value = Prism' ByteString Value
forall t a b. (AsJSON t, FromJSON a, ToJSON b) => Prism t t a b
_JSON
  {-# INLINE _Value #-}

instance AsValue LBS.ByteString where
  _Value :: Prism' ByteString Value
_Value = Prism' ByteString Value
forall t a b. (AsJSON t, FromJSON a, ToJSON b) => Prism t t a b
_JSON
  {-# INLINE _Value #-}

instance AsValue String where
  _Value :: Prism' String Value
_Value = Iso' String ByteString
strictUtf8Iso' String ByteString
-> Prism' ByteString Value -> Prism' String Value
forall k l m (is :: IxList) (js :: IxList) (ks :: IxList) s t u v a
       b.
(JoinKinds k l m, AppendIndices is js ks) =>
Optic k is s t u v -> Optic l js u v a b -> Optic m ks s t a b
%Prism' ByteString Value
forall t a b. (AsJSON t, FromJSON a, ToJSON b) => Prism t t a b
_JSON
  {-# INLINE _Value #-}

instance AsValue Text where
  _Value :: Prism' Text Value
_Value = Iso' Text ByteString
strictTextUtf8Iso' Text ByteString
-> Prism' ByteString Value -> Prism' Text Value
forall k l m (is :: IxList) (js :: IxList) (ks :: IxList) s t u v a
       b.
(JoinKinds k l m, AppendIndices is js ks) =>
Optic k is s t u v -> Optic l js u v a b -> Optic m ks s t a b
%Prism' ByteString Value
forall t a b. (AsJSON t, FromJSON a, ToJSON b) => Prism t t a b
_JSON
  {-# INLINE _Value #-}

instance AsValue LazyText.Text where
  _Value :: Prism' Text Value
_Value = Iso' Text ByteString
lazyTextUtf8Iso' Text ByteString
-> Prism' ByteString Value -> Prism' Text Value
forall k l m (is :: IxList) (js :: IxList) (ks :: IxList) s t u v a
       b.
(JoinKinds k l m, AppendIndices is js ks) =>
Optic k is s t u v -> Optic l js u v a b -> Optic m ks s t a b
%Prism' ByteString Value
forall t a b. (AsJSON t, FromJSON a, ToJSON b) => Prism t t a b
_JSON
  {-# INLINE _Value #-}

-- |
-- Like 'ix', but for 'Object' with Text indices. This often has better
-- inference than 'ix' when used with OverloadedStrings.
--
-- >>> "{\"a\": 100, \"b\": 200}" ^? key "a"
-- Just (Number 100.0)
--
-- >>> "[1,2,3]" ^? key "a"
-- Nothing
key :: AsValue t => Key.Key -> AffineTraversal' t Value
key :: Key -> AffineTraversal' t Value
key Key
i = Prism' t (KeyMap Value)
forall t. AsValue t => Prism' t (KeyMap Value)
_Object Prism' t (KeyMap Value)
-> Optic
     An_AffineTraversal NoIx (KeyMap Value) (KeyMap Value) Value Value
-> AffineTraversal' t Value
forall k l m (is :: IxList) (js :: IxList) (ks :: IxList) s t u v a
       b.
(JoinKinds k l m, AppendIndices is js ks) =>
Optic k is s t u v -> Optic l js u v a b -> Optic m ks s t a b
% Index (KeyMap Value)
-> Optic'
     (IxKind (KeyMap Value))
     NoIx
     (KeyMap Value)
     (IxValue (KeyMap Value))
forall m. Ixed m => Index m -> Optic' (IxKind m) NoIx m (IxValue m)
ix Key
Index (KeyMap Value)
i
{-# INLINE key #-}

-- | An indexed Traversal into Object properties
--
-- >>> Data.List.sort (itoListOf (members % _Number) "{\"a\": 4, \"b\": 7}")
-- [("a",4.0),("b",7.0)]
--
-- >>> "{\"a\": 4}" & members % _Number %~ (*10)
-- "{\"a\":40}"
members :: AsValue t => IxTraversal' Key.Key t Value
members :: IxTraversal' Key t Value
members = Prism' t (KeyMap Value)
forall t. AsValue t => Prism' t (KeyMap Value)
_Object Prism' t (KeyMap Value)
-> Optic
     A_Traversal (WithIx Key) (KeyMap Value) (KeyMap Value) Value Value
-> IxTraversal' Key t Value
forall k l m (is :: IxList) (js :: IxList) (ks :: IxList) s t u v a
       b.
(JoinKinds k l m, AppendIndices is js ks) =>
Optic k is s t u v -> Optic l js u v a b -> Optic m ks s t a b
% Optic
  A_Traversal (WithIx Key) (KeyMap Value) (KeyMap Value) Value Value
forall i (f :: * -> *) a b.
TraversableWithIndex i f =>
IxTraversal i (f a) (f b) a b
itraversed
{-# INLINE members #-}

-- | Like 'ix', but for Arrays with Int indexes
--
-- >>> "[1,2,3]" ^? nth 1
-- Just (Number 2.0)
--
-- >>> "{\"a\": 100, \"b\": 200}" ^? nth 1
-- Nothing
--
-- >>> "[1,2,3]" & nth 1 .~ Number 20
-- "[1,20,3]"
nth :: AsValue t => Int -> AffineTraversal' t Value
nth :: Int -> AffineTraversal' t Value
nth Int
i = Prism' t (Vector Value)
forall t. AsValue t => Prism' t (Vector Value)
_Array Prism' t (Vector Value)
-> Optic
     An_AffineTraversal NoIx (Vector Value) (Vector Value) Value Value
-> AffineTraversal' t Value
forall k l m (is :: IxList) (js :: IxList) (ks :: IxList) s t u v a
       b.
(JoinKinds k l m, AppendIndices is js ks) =>
Optic k is s t u v -> Optic l js u v a b -> Optic m ks s t a b
% Index (Vector Value)
-> Optic'
     (IxKind (Vector Value))
     NoIx
     (Vector Value)
     (IxValue (Vector Value))
forall m. Ixed m => Index m -> Optic' (IxKind m) NoIx m (IxValue m)
ix Int
Index (Vector Value)
i
{-# INLINE nth #-}

-- | An indexed Traversal into Array elements
--
-- >>> "[1,2,3]" ^.. values
-- [Number 1.0,Number 2.0,Number 3.0]
--
-- >>> "[1,2,3]" & values % _Number %~ (*10)
-- "[10,20,30]"
values :: AsValue t => IxTraversal' Int t Value
values :: IxTraversal' Int t Value
values = Prism' t (Vector Value)
forall t. AsValue t => Prism' t (Vector Value)
_Array Prism' t (Vector Value)
-> Optic
     A_Traversal (WithIx Int) (Vector Value) (Vector Value) Value Value
-> IxTraversal' Int t Value
forall k l m (is :: IxList) (js :: IxList) (ks :: IxList) s t u v a
       b.
(JoinKinds k l m, AppendIndices is js ks) =>
Optic k is s t u v -> Optic l js u v a b -> Optic m ks s t a b
% Optic
  A_Traversal (WithIx Int) (Vector Value) (Vector Value) Value Value
forall i (f :: * -> *) a b.
TraversableWithIndex i f =>
IxTraversal i (f a) (f b) a b
itraversed
{-# INLINE values #-}

strictUtf8 :: Iso' String Strict.ByteString
strictUtf8 :: Iso' String ByteString
strictUtf8 = Iso' String Text
forall t. IsText t => Iso' String t
packed Iso' String Text -> Iso' Text ByteString -> Iso' String ByteString
forall k l m (is :: IxList) (js :: IxList) (ks :: IxList) s t u v a
       b.
(JoinKinds k l m, AppendIndices is js ks) =>
Optic k is s t u v -> Optic l js u v a b -> Optic m ks s t a b
% Iso' Text ByteString
strictTextUtf8

strictTextUtf8 :: Iso' StrictText.Text Strict.ByteString
strictTextUtf8 :: Iso' Text ByteString
strictTextUtf8 = (Text -> ByteString)
-> (ByteString -> Text) -> Iso' Text ByteString
forall s a b t. (s -> a) -> (b -> t) -> Iso s t a b
iso Text -> ByteString
StrictText.encodeUtf8 ByteString -> Text
StrictText.decodeUtf8

lazyTextUtf8 :: Iso' LazyText.Text LBS.ByteString
lazyTextUtf8 :: Iso' Text ByteString
lazyTextUtf8 = (Text -> ByteString)
-> (ByteString -> Text) -> Iso' Text ByteString
forall s a b t. (s -> a) -> (b -> t) -> Iso s t a b
iso Text -> ByteString
LazyText.encodeUtf8 ByteString -> Text
LazyText.decodeUtf8

_JSON' :: (AsJSON t, FromJSON a, ToJSON a) => Prism' t a
_JSON' :: Prism' t a
_JSON' = Prism' t a
forall t a b. (AsJSON t, FromJSON a, ToJSON b) => Prism t t a b
_JSON

class IsKey t where
  -- | '_Key' is an 'Iso' from something to a 'Key'. This is primarily intended
  -- for situations where one wishes to use object keys that are not string
  -- literals and therefore must be converted:
  --
  -- >>> let k = "a" :: Text
  -- >>> "{\"a\": 100, \"b\": 200}" ^? key (k ^. _Key)
  -- Just (Number 100.0)
  --
  -- Note that applying '_Key' directly to a string literal
  -- (e.g., @\"a\" ^. '_Key'@) will likely not typecheck when
  -- @OverloadedStrings@ is enabled.
  _Key :: Iso' t Key.Key

instance IsKey Key.Key where
  _Key :: Iso' Key Key
_Key = Iso' Key Key
forall a. Iso' a a
simple
  {-# INLINE _Key #-}

instance IsKey String where
  _Key :: Iso' String Key
_Key = (String -> Key) -> (Key -> String) -> Iso' String Key
forall s a b t. (s -> a) -> (b -> t) -> Iso s t a b
iso String -> Key
Key.fromString Key -> String
Key.toString
  {-# INLINE _Key #-}

instance IsKey Text where
  _Key :: Iso' Text Key
_Key = (Text -> Key) -> (Key -> Text) -> Iso' Text Key
forall s a b t. (s -> a) -> (b -> t) -> Iso s t a b
iso Text -> Key
Key.fromText Key -> Text
Key.toText
  {-# INLINE _Key #-}

instance IsKey LazyText.Text where
  _Key :: Iso' Text Key
_Key = (Text -> Text) -> (Text -> Text) -> Iso Text Text Text Text
forall s a b t. (s -> a) -> (b -> t) -> Iso s t a b
iso Text -> Text
LazyText.toStrict Text -> Text
LazyText.fromStrict Iso Text Text Text Text -> Iso' Text Key -> Iso' Text Key
forall k l m (is :: IxList) (js :: IxList) (ks :: IxList) s t u v a
       b.
(JoinKinds k l m, AppendIndices is js ks) =>
Optic k is s t u v -> Optic l js u v a b -> Optic m ks s t a b
% Iso' Text Key
forall t. IsKey t => Iso' t Key
_Key
  {-# INLINE _Key #-}

instance IsKey ShortText where
  _Key :: Iso' ShortText Key
_Key = (ShortText -> Key) -> (Key -> ShortText) -> Iso' ShortText Key
forall s a b t. (s -> a) -> (b -> t) -> Iso s t a b
iso ShortText -> Key
Key.fromShortText Key -> ShortText
Key.toShortText
  {-# INLINE _Key #-}

{-
https://github.com/lens/lens-aeson/issues/48
instance IsKey Strict.ByteString where
  _Key = from strictTextUtf8._Key
  {-# INLINE _Key #-}

instance IsKey LBS.ByteString where
  _Key = from lazyTextUtf8._Key
  {-# INLINE _Key #-}
-}

class AsJSON t where
  -- | '_JSON' is a 'Prism' from something containing JSON to something encoded in that structure
  _JSON :: (FromJSON a, ToJSON b) => Prism t t a b

instance AsJSON Strict.ByteString where
  _JSON :: Prism ByteString ByteString a b
_JSON = (ByteString -> ByteString)
-> (ByteString -> ByteString)
-> Iso ByteString ByteString ByteString ByteString
forall s a b t. (s -> a) -> (b -> t) -> Iso s t a b
iso ByteString -> ByteString
LBS.fromStrict ByteString -> ByteString
LBS.toStrict Iso ByteString ByteString ByteString ByteString
-> Optic A_Prism NoIx ByteString ByteString a b
-> Prism ByteString ByteString a b
forall k l m (is :: IxList) (js :: IxList) (ks :: IxList) s t u v a
       b.
(JoinKinds k l m, AppendIndices is js ks) =>
Optic k is s t u v -> Optic l js u v a b -> Optic m ks s t a b
% Optic A_Prism NoIx ByteString ByteString a b
forall t a b. (AsJSON t, FromJSON a, ToJSON b) => Prism t t a b
_JSON
  {-# INLINE _JSON #-}

instance AsJSON LBS.ByteString where
  _JSON :: Prism ByteString ByteString a b
_JSON = (b -> ByteString)
-> (ByteString -> Maybe a) -> Prism ByteString ByteString a b
forall b s a. (b -> s) -> (s -> Maybe a) -> Prism s s a b
prism' b -> ByteString
forall a. ToJSON a => a -> ByteString
encode ByteString -> Maybe a
forall a. FromJSON a => ByteString -> Maybe a
decodeValue
    where
      decodeValue :: (FromJSON a) => LBS.ByteString -> Maybe a
      decodeValue :: ByteString -> Maybe a
decodeValue ByteString
s = Result Value -> Maybe Value
forall r. Result r -> Maybe r
maybeResult (Parser Value -> ByteString -> Result Value
forall a. Parser a -> ByteString -> Result a
parse Parser Value
value ByteString
s) Maybe Value -> (Value -> Maybe a) -> Maybe a
forall (m :: * -> *) a b. Monad m => m a -> (a -> m b) -> m b
>>= \Value
x -> case Value -> Result a
forall a. FromJSON a => Value -> Result a
fromJSON Value
x of
        Success a
v -> a -> Maybe a
forall a. a -> Maybe a
Just a
v
        Result a
_         -> Maybe a
forall a. Maybe a
Nothing
  {-# INLINE _JSON #-}

instance AsJSON String where
  _JSON :: Prism String String a b
_JSON = Iso' String ByteString
strictUtf8 Iso' String ByteString
-> Optic A_Prism NoIx ByteString ByteString a b
-> Prism String String a b
forall k l m (is :: IxList) (js :: IxList) (ks :: IxList) s t u v a
       b.
(JoinKinds k l m, AppendIndices is js ks) =>
Optic k is s t u v -> Optic l js u v a b -> Optic m ks s t a b
% Optic A_Prism NoIx ByteString ByteString a b
forall t a b. (AsJSON t, FromJSON a, ToJSON b) => Prism t t a b
_JSON
  {-# INLINE _JSON #-}

instance AsJSON Text where
  _JSON :: Prism Text Text a b
_JSON = Iso' Text ByteString
strictTextUtf8 Iso' Text ByteString
-> Optic A_Prism NoIx ByteString ByteString a b
-> Prism Text Text a b
forall k l m (is :: IxList) (js :: IxList) (ks :: IxList) s t u v a
       b.
(JoinKinds k l m, AppendIndices is js ks) =>
Optic k is s t u v -> Optic l js u v a b -> Optic m ks s t a b
% Optic A_Prism NoIx ByteString ByteString a b
forall t a b. (AsJSON t, FromJSON a, ToJSON b) => Prism t t a b
_JSON
  {-# INLINE _JSON #-}

instance AsJSON LazyText.Text where
  _JSON :: Prism Text Text a b
_JSON = Iso' Text ByteString
lazyTextUtf8 Iso' Text ByteString
-> Optic A_Prism NoIx ByteString ByteString a b
-> Prism Text Text a b
forall k l m (is :: IxList) (js :: IxList) (ks :: IxList) s t u v a
       b.
(JoinKinds k l m, AppendIndices is js ks) =>
Optic k is s t u v -> Optic l js u v a b -> Optic m ks s t a b
% Optic A_Prism NoIx ByteString ByteString a b
forall t a b. (AsJSON t, FromJSON a, ToJSON b) => Prism t t a b
_JSON
  {-# INLINE _JSON #-}

instance AsJSON Value where
  _JSON :: Prism Value Value a b
_JSON = (b -> Value) -> (Value -> Either Value a) -> Prism Value Value a b
forall b t s a. (b -> t) -> (s -> Either t a) -> Prism s t a b
prism b -> Value
forall a. ToJSON a => a -> Value
toJSON ((Value -> Either Value a) -> Prism Value Value a b)
-> (Value -> Either Value a) -> Prism Value Value a b
forall a b. (a -> b) -> a -> b
$ \Value
x -> case Value -> Result a
forall a. FromJSON a => Value -> Result a
fromJSON Value
x of
    Success a
y -> a -> Either Value a
forall a b. b -> Either a b
Right a
y;
    Result a
_         -> Value -> Either Value a
forall a b. a -> Either a b
Left Value
x
  {-# INLINE _JSON #-}

------------------------------------------------------------------------------
-- Some additional tests for prismhood; see https://github.com/ekmett/lens/issues/439.
------------------------------------------------------------------------------

-- $LazyByteStringTests
-- >>> "42" ^? (_JSON :: Prism' Lazy.ByteString Value)
-- Just (Number 42.0)
--
-- >>> preview (_Integer :: Prism' Lazy.ByteString Integer) "42"
-- Just 42
--
-- >>> Lazy.Char8.unpack (review (_Integer :: Prism' Lazy.ByteString Integer) 42)
-- "42"

-- $StrictByteStringTests
-- >>> "42" ^? (_JSON :: Prism' Strict.ByteString Value)
-- Just (Number 42.0)
--
-- >>> preview (_Integer :: Prism' Strict.ByteString Integer) "42"
-- Just 42
--
-- >>> Strict.Char8.unpack (review (_Integer :: Prism' Strict.ByteString Integer) 42)
-- "42"

-- $StringTests
-- >>> "42" ^? (_JSON :: Prism' String Value)
-- Just (Number 42.0)
--
-- >>> preview (_Integer :: Prism' String Integer) "42"
-- Just 42
--
-- >>> review (_Integer :: Prism' String Integer) 42
-- "42"

------------------------------------------------------------------------------
-- Orphan instances for lens library interop
------------------------------------------------------------------------------

type instance Index Value = Key.Key

type instance IxValue Value = Value
instance Ixed Value where
  ix :: Index Value -> Optic' (IxKind Value) NoIx Value (IxValue Value)
ix Index Value
i = Optic A_Prism NoIx Value Value (KeyMap Value) (KeyMap Value)
forall t. AsValue t => Prism' t (KeyMap Value)
_Object Optic A_Prism NoIx Value Value (KeyMap Value) (KeyMap Value)
-> Optic
     An_AffineTraversal NoIx (KeyMap Value) (KeyMap Value) Value Value
-> Optic An_AffineTraversal NoIx Value Value Value Value
forall k l m (is :: IxList) (js :: IxList) (ks :: IxList) s t u v a
       b.
(JoinKinds k l m, AppendIndices is js ks) =>
Optic k is s t u v -> Optic l js u v a b -> Optic m ks s t a b
% Index (KeyMap Value)
-> Optic'
     (IxKind (KeyMap Value))
     NoIx
     (KeyMap Value)
     (IxValue (KeyMap Value))
forall m. Ixed m => Index m -> Optic' (IxKind m) NoIx m (IxValue m)
ix Index Value
Index (KeyMap Value)
i
  {-# INLINE ix #-}

{-
instance Plated Value where
  plate f (Object o) = Object <$> traverse f o
  plate f (Array a) = Array <$> traverse f a
  plate _ xs = pure xs
  {-# INLINE plate #-}
-}

type instance Index (KM.KeyMap v) = Key.Key
type instance IxValue (KM.KeyMap v) = v

instance Ixed (KM.KeyMap v)

instance At (KM.KeyMap v) where
  at :: Index (KeyMap v) -> Lens' (KeyMap v) (Maybe (IxValue (KeyMap v)))
at Index (KeyMap v)
i = LensVL (KeyMap v) (KeyMap v) (Maybe v) (Maybe v)
-> Lens (KeyMap v) (KeyMap v) (Maybe v) (Maybe v)
forall s t a b. LensVL s t a b -> Lens s t a b
lensVL (\Maybe v -> f (Maybe v)
f -> (Maybe v -> f (Maybe v)) -> Key -> KeyMap v -> f (KeyMap v)
forall (f :: * -> *) v.
Functor f =>
(Maybe v -> f (Maybe v)) -> Key -> KeyMap v -> f (KeyMap v)
KM.alterF Maybe v -> f (Maybe v)
f Key
Index (KeyMap v)
i)
  {-# INLINE at #-}

instance Each Key.Key (KM.KeyMap a) (KM.KeyMap b) a b where
  each :: IxTraversal Key (KeyMap a) (KeyMap b) a b
each = IxTraversalVL Key (KeyMap a) (KeyMap b) a b
-> IxTraversal Key (KeyMap a) (KeyMap b) a b
forall i s t a b. IxTraversalVL i s t a b -> IxTraversal i s t a b
itraversalVL IxTraversalVL Key (KeyMap a) (KeyMap b) a b
forall (f :: * -> *) v1 v2.
Applicative f =>
(Key -> v1 -> f v2) -> KeyMap v1 -> f (KeyMap v2)
KM.traverseWithKey
  {-# INLINE[1] each #-}

------------------------------------------------------------------------------
-- Pattern Synonyms
------------------------------------------------------------------------------

pattern JSON :: (FromJSON a, ToJSON a, AsJSON t) => () => a -> t
pattern $bJSON :: a -> t
$mJSON :: forall r a t.
(FromJSON a, ToJSON a, AsJSON t) =>
t -> (a -> r) -> (Void# -> r) -> r
JSON a <- (preview _JSON -> Just a) where
  JSON a
a = Prism t t a a
forall t a b. (AsJSON t, FromJSON a, ToJSON b) => Prism t t a b
_JSON Prism t t a a -> a -> t
forall k (is :: IxList) t b.
Is k A_Review =>
Optic' k is t b -> b -> t
# a
a

pattern Value_ :: (FromJSON a, ToJSON a) => () => a -> Value
pattern $bValue_ :: a -> Value
$mValue_ :: forall r a.
(FromJSON a, ToJSON a) =>
Value -> (a -> r) -> (Void# -> r) -> r
Value_ a <- (fromJSON -> Success a) where
  Value_ a
a = a -> Value
forall a. ToJSON a => a -> Value
toJSON a
a

pattern Number_ :: AsNumber t => Scientific -> t
pattern $bNumber_ :: Scientific -> t
$mNumber_ :: forall r t.
AsNumber t =>
t -> (Scientific -> r) -> (Void# -> r) -> r
Number_ n <- (preview _Number -> Just n) where
  Number_ Scientific
n = Prism' t Scientific
forall t. AsNumber t => Prism' t Scientific
_Number Prism' t Scientific -> Scientific -> t
forall k (is :: IxList) t b.
Is k A_Review =>
Optic' k is t b -> b -> t
# Scientific
n

pattern Double :: AsNumber t => Double -> t
pattern $bDouble :: Double -> t
$mDouble :: forall r t. AsNumber t => t -> (Double -> r) -> (Void# -> r) -> r
Double d <- (preview _Double -> Just d) where
  Double Double
d = Prism' t Double
forall t. AsNumber t => Prism' t Double
_Double Prism' t Double -> Double -> t
forall k (is :: IxList) t b.
Is k A_Review =>
Optic' k is t b -> b -> t
# Double
d

pattern Integer :: AsNumber t => Integer -> t
pattern $bInteger :: Integer -> t
$mInteger :: forall r t. AsNumber t => t -> (Integer -> r) -> (Void# -> r) -> r
Integer i <- (preview _Integer -> Just i) where
  Integer Integer
i = Prism' t Integer
forall t. AsNumber t => Prism' t Integer
_Integer Prism' t Integer -> Integer -> t
forall k (is :: IxList) t b.
Is k A_Review =>
Optic' k is t b -> b -> t
# Integer
i

pattern Integral :: (AsNumber t, Integral a) => a -> t
pattern $bIntegral :: a -> t
$mIntegral :: forall r t a.
(AsNumber t, Integral a) =>
t -> (a -> r) -> (Void# -> r) -> r
Integral d <- (preview _Integral -> Just d) where
  Integral a
d = Prism' t a
forall t a. (AsNumber t, Integral a) => Prism' t a
_Integral Prism' t a -> a -> t
forall k (is :: IxList) t b.
Is k A_Review =>
Optic' k is t b -> b -> t
# a
d

pattern Bool_ :: AsValue t => Bool -> t
pattern $bBool_ :: Bool -> t
$mBool_ :: forall r t. AsValue t => t -> (Bool -> r) -> (Void# -> r) -> r
Bool_ b <- (preview _Bool -> Just b) where
  Bool_ Bool
b = Prism' t Bool
forall t. AsValue t => Prism' t Bool
_Bool Prism' t Bool -> Bool -> t
forall k (is :: IxList) t b.
Is k A_Review =>
Optic' k is t b -> b -> t
# Bool
b

pattern String_ :: AsValue t => Text -> t
pattern $bString_ :: Text -> t
$mString_ :: forall r t. AsValue t => t -> (Text -> r) -> (Void# -> r) -> r
String_ p <- (preview _String -> Just p) where
  String_ Text
p = Prism' t Text
forall t. AsValue t => Prism' t Text
_String Prism' t Text -> Text -> t
forall k (is :: IxList) t b.
Is k A_Review =>
Optic' k is t b -> b -> t
# Text
p

pattern Null_ :: AsValue t => t
pattern $bNull_ :: t
$mNull_ :: forall r t. AsValue t => t -> (Void# -> r) -> (Void# -> r) -> r
Null_ <- (preview _Null -> Just ()) where
  Null_ = Prism' t ()
forall t. AsValue t => Prism' t ()
_Null Prism' t () -> () -> t
forall k (is :: IxList) t b.
Is k A_Review =>
Optic' k is t b -> b -> t
# ()

pattern Key_ :: IsKey t => Key.Key -> t
pattern $bKey_ :: Key -> t
$mKey_ :: forall r t. IsKey t => t -> (Key -> r) -> (Void# -> r) -> r
Key_ k <- (preview _Key -> Just k) where
  Key_ Key
k = Iso' t Key
forall t. IsKey t => Iso' t Key
_Key Iso' t Key -> Key -> t
forall k (is :: IxList) t b.
Is k A_Review =>
Optic' k is t b -> b -> t
# Key
k