@@ -1,28 +1,29 @@
1−{-# LANGUAGE CPP #-}
2−{-# LANGUAGE DataKinds #-}
3−{-# LANGUAGE DefaultSignatures #-}
4−{-# LANGUAGE FlexibleContexts #-}
5−{-# LANGUAGE FlexibleInstances #-}
6−{-# LANGUAGE GADTs #-}
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE DataKinds #-}
3+{-# LANGUAGE DefaultSignatures #-}
4+{-# LANGUAGE FlexibleContexts #-}
5+{-# LANGUAGE FlexibleInstances #-}
6+{-# LANGUAGE GADTs #-}
77{-# LANGUAGE MultiParamTypeClasses #-}
8−{-# LANGUAGE NoImplicitPrelude #-}
9−{-# LANGUAGE OverloadedStrings #-}
10−{-# LANGUAGE PolyKinds #-}
11−{-# LANGUAGE RecordWildCards #-}
12−{-# LANGUAGE ScopedTypeVariables #-}
13−{-# LANGUAGE TypeOperators #-}
14−{-# LANGUAGE TupleSections #-}
15−{-# LANGUAGE UndecidableInstances #-}
16−{-# LANGUAGE ViewPatterns #-}
17−
18−#include "incoherent-compat.h"
8+{-# LANGUAGE NamedFieldPuns #-}
9+{-# LANGUAGE OverloadedStrings #-}
10+{-# LANGUAGE RecordWildCards #-}
11+{-# LANGUAGE ScopedTypeVariables #-}
12+{-# LANGUAGE TypeOperators #-}
13+{-# LANGUAGE TypeSynonymInstances #-}
14+{-# LANGUAGE UndecidableInstances #-}
15+{-# LANGUAGE ViewPatterns #-}
16+
17+#if __GLASGOW_HASKELL__ >= 706
18+{-# LANGUAGE PolyKinds #-}
19+#endif
20+
1921#include "overlapping-compat.h"
2022
2123-- TODO: Drop this when we remove support for Data.Attoparsec.Number
2224{-# OPTIONS_GHC -fno-warn-deprecations #-}
2325
24−module Data.Aeson.Types.FromJSON
25− (
26+module Data.Aeson.Types.FromJSON (
2627 -- * Core JSON classes
2728 FromJSON(..)
2829 -- * Liftings to unary and binary type constructors
@@ -42,121 +43,106 @@ module Data.Aeson.Types.FromJSON
4243 , coerceFromJSONKeyFunction
4344 , mapFromJSONKeyFunction
4445
45− , GFromJSONKey()
46− , genericFromJSONKey
47−
4846 -- * List functions
4947 , listParser
5048
51− -- * Inspecting @'Value's@
49+ -- * Inspecting @'Value's@
5250 , withObject
5351 , withText
5452 , withArray
53+ , withNumber
5554 , withScientific
5655 , withBool
57− , withEmbeddedJSON
5856
5957 -- * Functions
6058 , fromJSON
6159 , ifromJSON
62− , typeMismatch
63− , unexpected
64− , parseField
65− , parseFieldMaybe
66− , parseFieldMaybe'
67− , explicitParseField
68− , explicitParseFieldMaybe
69− , explicitParseFieldMaybe'
70− , parseIndexedJSON
71− -- ** Operators
7260 , (.:)
7361 , (.:?)
7462 , (.:!)
7563 , (.!=)
64+ , typeMismatch
7665
7766 -- * Internal
7867 , parseOptionalFieldWith
7968 ) where
8069
81−import Prelude.Compat
70+import Prelude ()
71+import Prelude.Compat hiding (foldr)
8272
83−import Control.Applicative ((<|>), Const(..), liftA2)
84−import Control.Monad (zipWithM)
8573import Data.Aeson.Internal.Functions (mapKey)
86−import Data.Aeson.Parser.Internal (eitherDecodeWith, jsonEOF)
8774import Data.Aeson.Types.Generic
8875import Data.Aeson.Types.Internal
89−import Data.Bits (unsafeShiftR)
90−import Data.Fixed (Fixed, HasResolution (resolution), Nano)
91−import Data.Functor.Compose (Compose(..))
92−import Data.Functor.Identity (Identity(..))
93−import Data.Functor.Product (Product(..))
94−import Data.Functor.Sum (Sum(..))
95−import Data.Hashable (Hashable(..))
96−import Data.Int (Int16, Int32, Int64, Int8)
97−import Data.List.NonEmpty (NonEmpty(..))
98−import Data.Maybe (fromMaybe)
99−import Data.Semigroup ((<>))
100−import Data.Proxy (Proxy(..))
101−import Data.Ratio ((%), Ratio)
102−import Data.Scientific (Scientific, base10Exponent)
103−import Data.Tagged (Tagged(..))
104−import Data.Text (Text, pack, unpack)
105−import Data.Time (Day, DiffTime, LocalTime, NominalDiffTime, TimeOfDay, UTCTime, ZonedTime)
106−import Data.Time.Calendar.Compat (CalendarDiffDays (..), DayOfWeek (..))
107−import Data.Time.LocalTime.Compat (CalendarDiffTime (..))
108−import Data.Time.Clock.System.Compat (SystemTime (..))
109−import Data.Time.Format.Compat (parseTimeM, defaultTimeLocale)
110−import Data.Traversable as Tr (sequence)
111−import Data.Vector (Vector)
112−import Data.Version (Version, parseVersion)
113−import Data.Void (Void)
114−import Data.Word (Word16, Word32, Word64, Word8)
115−import Foreign.Storable (Storable)
116−import Foreign.C.Types (CTime (..))
76+
77+import qualified Data.Aeson.Parser.Time as Time
78+import qualified Data.Attoparsec.ByteString.Char8 as A (endOfInput, parseOnly,
79+ scientific)
80+
81+import Control.Applicative (Const (..), (<|>))
82+import Control.Monad ((<=<), zipWithM)
83+import Data.Attoparsec.Number (Number (..))
84+import Data.Bits (unsafeShiftR)
85+import Data.Fixed (Fixed, HasResolution)
86+import Data.Functor.Compose (Compose (..))
87+import Data.Functor.Identity (Identity (..))
88+import Data.Functor.Product (Product (..))
89+import Data.Functor.Sum (Sum (..))
90+import Data.Hashable (Hashable (..))
91+import Data.Int (Int16, Int32, Int64, Int8)
92+import Data.List.NonEmpty (NonEmpty (..))
93+import Data.Maybe (fromMaybe)
94+import Data.Monoid (Dual (..), First (..), Last (..), (<>))
95+import Data.Proxy (Proxy (..))
96+import Data.Ratio (Ratio, (%))
97+import Data.Scientific (Scientific)
98+import Data.Tagged (Tagged (..))
99+import Data.Text (Text, pack, unpack)
100+import Data.Time (Day, LocalTime, NominalDiffTime, TimeOfDay,
101+ UTCTime, ZonedTime)
102+import Data.Time.Format (parseTime)
103+import Data.Time.Locale.Compat (defaultTimeLocale)
104+import Data.Traversable as Tr (sequence)
105+import Data.Vector (Vector)
106+import Data.Version (Version, parseVersion)
107+import Data.Word (Word16, Word32, Word64, Word8)
108+import Foreign.Storable (Storable)
117109import GHC.Generics
118−import Numeric.Natural (Natural)
110+import Numeric.Natural (Natural)
119111import Text.ParserCombinators.ReadP (readP_to_S)
120−import Unsafe.Coerce (unsafeCoerce)
121−import qualified Data.Aeson.Parser.Time as Time
122−import qualified Data.Attoparsec.ByteString.Char8 as A (endOfInput, parseOnly, scientific)
123−import qualified Data.ByteString.Lazy as L
124−import qualified Data.DList as DList
125−import qualified Data.HashMap.Strict as H
126−import qualified Data.HashSet as HashSet
127−import qualified Data.IntMap as IntMap
128−import qualified Data.IntSet as IntSet
129−import qualified Data.Map as M
130−import qualified Data.Monoid as Monoid
131−import qualified Data.Scientific as Scientific
132−import qualified Data.Semigroup as Semigroup
133−import qualified Data.Sequence as Seq
134−import qualified Data.Set as Set
135−import qualified Data.Text as T
136−import qualified Data.Text.Encoding as T
137−import qualified Data.Text.Lazy as LT
138−import qualified Data.Tree as Tree
139−import qualified Data.UUID.Types as UUID
140−import qualified Data.Vector as V
141−import qualified Data.Vector.Generic as VG
112+
113+import qualified Data.DList as DList
114+import qualified Data.HashMap.Strict as H
115+import qualified Data.HashSet as HashSet
116+import qualified Data.IntMap as IntMap
117+import qualified Data.IntSet as IntSet
118+import qualified Data.Map as M
119+import qualified Data.Scientific as Scientific
120+import qualified Data.Sequence as Seq
121+import qualified Data.Set as Set
122+import qualified Data.Text as T
123+import qualified Data.Text.Encoding as T
124+import qualified Data.Text.Lazy as LT
125+import qualified Data.Tree as Tree
126+import qualified Data.Vector as V
127+import qualified Data.Vector.Generic as VG
142128import qualified Data.Vector.Primitive as VP
143−import qualified Data.Vector.Storable as VS
144−import qualified Data.Vector.Unboxed as VU
129+import qualified Data.Vector.Storable as VS
130+import qualified Data.Vector.Unboxed as VU
145131
146−import qualified GHC.Exts as Exts
147−import qualified Data.Primitive.Array as PM
148−import qualified Data.Primitive.SmallArray as PM
149−import qualified Data.Primitive.Types as PM
132+import Unsafe.Coerce (unsafeCoerce)
150133
151−#if MIN_VERSION_primitive(0,6,4)
152−#if !MIN_VERSION_primitive(0,7,0)
153−import qualified Data.Primitive.UnliftedArray as PM
134+#ifndef HAS_COERCIBLE
135+#define HAS_COERCIBLE (__GLASGOW_HASKELL__ >= 707)
154136#endif
155−import qualified Data.Primitive.PrimArray as PM
156−#endif
157−
158137
138+#if HAS_COERCIBLE
159139import Data.Coerce (Coercible, coerce)
140+coerce' :: Coercible a b => a -> b
141+coerce' = coerce
142+#else
143+coerce' :: a -> b
144+coerce' = unsafeCoerce
145+#endif
160146
161147parseIndexedJSON :: (Value -> Parser a) -> Int -> Value -> Parser a
162148parseIndexedJSON p idx value = p value <?> Index idx
@@ -165,7 +151,7 @@ parseIndexedJSON p idx value = p value <?> Index idx
165151parseIndexedJSONPair :: (Value -> Parser a) -> (Value -> Parser b) -> Int -> Value -> Parser (a, b)
166152parseIndexedJSONPair keyParser valParser idx value = p value <?> Index idx
167153 where
168− p = withArray "(k, v)" $ \ab ->
154+ p = withArray "(k,v)" $ \ab ->
169155 let n = V.length ab
170156 in if n == 2
171157 then (,) <$> parseJSONElemAtIndex keyParser 0 ab
@@ -177,34 +163,43 @@ parseIndexedJSONPair keyParser valParser idx value = p value <?> Index idx
177163parseJSONElemAtIndex :: (Value -> Parser a) -> Int -> V.Vector Value -> Parser a
178164parseJSONElemAtIndex p idx ary = p (V.unsafeIndex ary idx) <?> Index idx
179165
166+scientificToNumber :: Scientific -> Number
167+scientificToNumber s
168+ | e < 0 = D $ Scientific.toRealFloat s
169+ | otherwise = I $ c * 10 ^ e
170+ where
171+ e = Scientific.base10Exponent s
172+ c = Scientific.coefficient s
173+{-# INLINE scientificToNumber #-}
174+
180175parseRealFloat :: RealFloat a => String -> Value -> Parser a
181−parseRealFloat _ (Number s) = pure $ Scientific.toRealFloat s
182−parseRealFloat _ Null = pure (0/0)
183−parseRealFloat name v = prependContext name (unexpected v)
176+parseRealFloat _ (Number s) = pure $ Scientific.toRealFloat s
177+parseRealFloat _ Null = pure (0/0)
178+parseRealFloat expected v = typeMismatch expected v
184179{-# INLINE parseRealFloat #-}
185180
186−parseIntegralFromScientific :: forall a. Integral a => Scientific -> Parser a
187−parseIntegralFromScientific s =
181+parseIntegralFromScientific :: forall a. Integral a => String -> Scientific -> Parser a
182+parseIntegralFromScientific expected s =
188183 case Scientific.floatingOrInteger s :: Either Double a of
189184 Right x -> pure x
190− Left _ -> fail $ "unexpected floating number " ++ show s
185+ Left _ -> fail $ "Floating number specified for " ++ expected ++ ": " ++ show s
191186{-# INLINE parseIntegralFromScientific #-}
192187
193188parseIntegral :: Integral a => String -> Value -> Parser a
194−parseIntegral name =
195− prependContext name . withBoundedScientific' parseIntegralFromScientific
189+parseIntegral expected =
190+ withScientific expected $ parseIntegralFromScientific expected
196191{-# INLINE parseIntegral #-}
197192
198−parseBoundedIntegralFromScientific :: (Bounded a, Integral a) => Scientific -> Parser a
199−parseBoundedIntegralFromScientific s = maybe
200− (fail $ "value is either floating or will cause over or underflow " ++ show s)
193+parseBoundedIntegralFromScientific :: (Bounded a, Integral a) => String -> Scientific -> Parser a
194+parseBoundedIntegralFromScientific expected s = maybe
195+ (fail $ expected ++ " is either floating or will cause over or underflow: " ++ show s)
201196 pure
202197 (Scientific.toBoundedInteger s)
203198{-# INLINE parseBoundedIntegralFromScientific #-}
204199
205200parseBoundedIntegral :: (Bounded a, Integral a) => String -> Value -> Parser a
206−parseBoundedIntegral name =
207− prependContext name . withScientific' parseBoundedIntegralFromScientific
201+parseBoundedIntegral expected =
202+ withScientific expected $ parseBoundedIntegralFromScientific expected
208203{-# INLINE parseBoundedIntegral #-}
209204
210205parseScientificText :: Text -> Parser Scientific
@@ -214,20 +209,13 @@ parseScientificText
214209 . T.encodeUtf8
215210
216211parseIntegralText :: Integral a => String -> Text -> Parser a
217−parseIntegralText name t =
218− prependContext name $
219− parseScientificText t
220− >>= rejectLargeExponent
221− >>= parseIntegralFromScientific
222− where
223− rejectLargeExponent :: Scientific -> Parser Scientific
224− rejectLargeExponent s = withBoundedScientific' pure (Number s)
212+parseIntegralText expected t =
213+ parseScientificText t >>= parseIntegralFromScientific expected
225214{-# INLINE parseIntegralText #-}
226215
227216parseBoundedIntegralText :: (Bounded a, Integral a) => String -> Text -> Parser a
228−parseBoundedIntegralText name t =
229− prependContext name $
230− parseScientificText t >>= parseBoundedIntegralFromScientific
217+parseBoundedIntegralText expected t =
218+ parseScientificText t >>= parseBoundedIntegralFromScientific expected
231219
232220parseOptionalFieldWith :: (Value -> Parser (Maybe a))
233221 -> Object -> Text -> Parser (Maybe a)
@@ -287,21 +275,14 @@ genericLiftParseJSON opts pj pjl = fmap to1 . gParseJSON opts (From1Args pj pjl)
287275--
288276-- The basic ways to signal a failed conversion are as follows:
289277--
290−-- * 'fail' yields a custom error message: it is the recommended way of
291−-- reporting a failure;
278+-- * 'empty' and 'mzero' work, but are terse and uninformative
292279--
293−-- * 'Control.Applicative.empty' (or 'Control.Monad.mzero') is uninformative:
294−-- use it when the error is meant to be caught by some @('<|>')@;
280+-- * 'fail' yields a custom error message
295281--
296−-- * 'typeMismatch' can be used to report a failure when the encountered value
297−-- is not of the expected JSON type; 'unexpected' is an appropriate alternative
298−-- when more than one type may be expected, or to keep the expected type
299−-- implicit.
282+-- * 'typeMismatch' produces an informative message for cases when the
283+-- value encountered is not of the expected type
300284--
301−-- 'prependFailure' (or 'modifyFailure') add more information to a parser's
302−-- error messages.
303−--
304−-- An example type and instance using 'typeMismatch' and 'prependFailure':
285+-- An example type and instance:
305286--
306287-- @
307288-- \-- Allow ourselves to write 'Text' literals.
@@ -309,30 +290,15 @@ genericLiftParseJSON opts pj pjl = fmap to1 . gParseJSON opts (From1Args pj pjl)
309290--
310291-- data Coord = Coord { x :: Double, y :: Double }
311292--
312−-- instance 'FromJSON' Coord where
313−-- 'parseJSON' ('Object' v) = Coord
314−-- '<$>' v '.:' \"x\"
315−-- '<*>' v '.:' \"y\"
293+-- instance FromJSON Coord where
294+-- parseJSON ('Object' v) = Coord '<$>'
295+-- v '.:' \"x\" '<*>'
296+-- v '.:' \"y\"
316297--
317−-- \-- We do not expect a non-'Object' value here.
318−-- \-- We could use 'Control.Applicative.empty' to fail, but 'typeMismatch'
319−-- \-- gives a much more informative error message.
320−-- 'parseJSON' invalid =
321−-- 'prependFailure' "parsing Coord failed, "
322−-- ('typeMismatch' \"Object\" invalid)
323−-- @
324−--
325−-- For this common case of only being concerned with a single
326−-- type of JSON value, the functions 'withObject', 'withScientific', etc.
327−-- are provided. Their use is to be preferred when possible, since
328−-- they are more terse. Using 'withObject', we can rewrite the above instance
329−-- (assuming the same language extension and data type) as:
330−--
331−-- @
332−-- instance 'FromJSON' Coord where
333−-- 'parseJSON' = 'withObject' \"Coord\" $ \\v -> Coord
334−-- '<$>' v '.:' \"x\"
335−-- '<*>' v '.:' \"y\"
298+-- \-- We do not expect a non-'Object' value here.
299+-- \-- We could use 'mzero' to fail, but 'typeMismatch'
300+-- \-- gives a much more informative error message.
301+-- parseJSON invalid = 'typeMismatch' \"Coord\" invalid
336302-- @
337303--
338304-- Instead of manually writing your 'FromJSON' instance, there are two options
@@ -340,7 +306,7 @@ genericLiftParseJSON opts pj pjl = fmap to1 . gParseJSON opts (From1Args pj pjl)
340306--
341307-- * "Data.Aeson.TH" provides Template Haskell functions which will derive an
342308-- instance at compile time. The generated instance is optimized for your type
343−-- so it will probably be more efficient than the following option.
309+-- so will probably be more efficient than the following two options:
344310--
345311-- * The compiler can provide a default generic implementation for
346312-- 'parseJSON'.
@@ -358,21 +324,18 @@ genericLiftParseJSON opts pj pjl = fmap to1 . gParseJSON opts (From1Args pj pjl)
358324--
359325-- data Coord = Coord { x :: Double, y :: Double } deriving 'Generic'
360326--
361−-- instance 'FromJSON' Coord
327+-- instance FromJSON Coord
362328-- @
363329--
364−-- The default implementation will be equivalent to
365−-- @parseJSON = 'genericParseJSON' 'defaultOptions'@; if you need different
366−-- options, you can customize the generic decoding by defining:
330+-- If @DefaultSignatures@ doesn't give exactly the results you want,
331+-- you can customize the generic decoding with only a tiny amount of
332+-- effort, using 'genericParseJSON' with your preferred 'Options':
367333--
368334-- @
369−-- customOptions = 'defaultOptions'
370−-- { 'fieldLabelModifier' = 'map' 'Data.Char.toUpper'
371−-- }
372−--
373−-- instance 'FromJSON' Coord where
374−-- 'parseJSON' = 'genericParseJSON' customOptions
335+-- instance FromJSON Coord where
336+-- parseJSON = 'genericParseJSON' 'defaultOptions'
375337-- @
338+
376339class FromJSON a where
377340 parseJSON :: Value -> Parser a
378341
@@ -380,11 +343,13 @@ class FromJSON a where
380343 parseJSON = genericParseJSON defaultOptions
381344
382345 parseJSONList :: Value -> Parser [a]
383− parseJSONList = withArray "[]" $ \a ->
384− zipWithM (parseIndexedJSON parseJSON) [0..]
346+ parseJSONList (Array a)
347+ = zipWithM (parseIndexedJSON parseJSON) [0..]
385348 . V.toList
386349 $ a
387350
351+ parseJSONList v = typeMismatch "[a]" v
352+
388353-------------------------------------------------------------------------------
389354-- Classes and types for map keys
390355-------------------------------------------------------------------------------
@@ -396,16 +361,6 @@ class FromJSON a where
396361-- > newtype SomeId = SomeId { getSomeId :: Text }
397362-- > deriving (Eq,Ord,Hashable,FromJSONKey)
398363--
399−-- If you have a sum of nullary constructors, you may use the generic
400−-- implementation:
401−--
402−-- @
403−-- data Color = Red | Green | Blue
404−-- deriving Generic
405−--
406−-- instance 'FromJSONKey' Color where
407−-- 'fromJSONKey' = 'genericFromJSONKey' 'defaultJSONKeyOptions'
408−-- @
409364class FromJSONKey a where
410365 -- | Strategy for parsing the key of a map-like container.
411366 fromJSONKey :: FromJSONKeyFunction a
@@ -428,7 +383,11 @@ class FromJSONKey a where
428383-- At the moment this type is intentionally not exported. 'FromJSONKeyFunction'
429384-- can be inspected, but cannot be constructed.
430385data CoerceText a where
386+#if HAS_COERCIBLE
431387 CoerceText :: Coercible Text a => CoerceText a
388+#else
389+ CoerceText :: CoerceText a
390+#endif
432391
433392-- | This type is related to 'ToJSONKeyFunction'. If 'FromJSONKeyValue' is used in the
434393-- 'FromJSONKey' instance, then 'ToJSONKeyValue' should be used in the 'ToJSONKey'
@@ -448,7 +407,7 @@ data FromJSONKeyFunction a
448407
449408-- | Only law abiding up to interpretation
450409instance Functor FromJSONKeyFunction where
451− fmap h (FromJSONKeyCoerce CoerceText) = FromJSONKeyText (h . coerce)
410+ fmap h (FromJSONKeyCoerce CoerceText) = FromJSONKeyText (h . coerce')
452411 fmap h (FromJSONKeyText f) = FromJSONKeyText (h . f)
453412 fmap h (FromJSONKeyTextParser f) = FromJSONKeyTextParser (fmap h . f)
454413 fmap h (FromJSONKeyValue f) = FromJSONKeyValue (fmap h . f)
@@ -462,7 +421,9 @@ instance Functor FromJSONKeyFunction where
462421--
463422-- On pre GHC 7.8 this is unconstrainted function.
464423fromJSONKeyCoerce ::
424+#if HAS_COERCIBLE
465425 Coercible Text a =>
426+#endif
466427 FromJSONKeyFunction a
467428fromJSONKeyCoerce = FromJSONKeyCoerce CoerceText
468429
@@ -470,91 +431,60 @@ fromJSONKeyCoerce = FromJSONKeyCoerce CoerceText
470431--
471432-- See note on 'fromJSONKeyCoerce'.
472433coerceFromJSONKeyFunction ::
434+#if HAS_COERCIBLE
473435 Coercible a b =>
436+#endif
474437 FromJSONKeyFunction a -> FromJSONKeyFunction b
438+#if HAS_COERCIBLE
475439coerceFromJSONKeyFunction = coerce
440+#else
441+coerceFromJSONKeyFunction (FromJSONKeyCoerce CoerceText) = FromJSONKeyCoerce CoerceText
442+coerceFromJSONKeyFunction (FromJSONKeyText f) = FromJSONKeyText (coerce' . f)
443+coerceFromJSONKeyFunction (FromJSONKeyTextParser f) = FromJSONKeyTextParser (fmap coerce' . f)
444+coerceFromJSONKeyFunction (FromJSONKeyValue f) = FromJSONKeyValue (fmap coerce' . f)
445+#endif
476446
477447{-# RULES
478448 "FromJSONKeyCoerce: fmap id" forall (x :: FromJSONKeyFunction a).
479449 fmap id x = x
480450 #-}
451+#if HAS_COERCIBLE
481452{-# RULES
482453 "FromJSONKeyCoerce: fmap coerce" forall x .
483454 fmap coerce x = coerceFromJSONKeyFunction x
484455 #-}
456+#endif
485457
486458-- | Same as 'fmap'. Provided for the consistency with 'ToJSONKeyFunction'.
487459mapFromJSONKeyFunction :: (a -> b) -> FromJSONKeyFunction a -> FromJSONKeyFunction b
488460mapFromJSONKeyFunction = fmap
489461
490−-- | 'fromJSONKey' for 'Generic' types.
491−-- These types must be sums of nullary constructors, whose names will be used
492−-- as keys for JSON objects.
493−--
494−-- See also 'genericToJSONKey'.
495−--
496−-- === __Example__
497−--
498−-- @
499−-- data Color = Red | Green | Blue
500−-- deriving 'Generic'
501−--
502−-- instance 'FromJSONKey' Color where
503−-- 'fromJSONKey' = 'genericFromJSONKey' 'defaultJSONKeyOptions'
504−-- @
505−genericFromJSONKey :: forall a. (Generic a, GFromJSONKey (Rep a))
506− => JSONKeyOptions
507− -> FromJSONKeyFunction a
508−genericFromJSONKey opts = FromJSONKeyTextParser $ \t ->
509− case parseSumFromString (keyModifier opts) t of
510− Nothing -> fail $
511− "invalid key " ++ show t ++ ", expected one of " ++ show cnames
512− Just k -> pure (to k)
513− where
514− cnames = unTagged2 (constructorTags (keyModifier opts) :: Tagged2 (Rep a) [String])
515−
516−class (ConstructorNames f, SumFromString f) => GFromJSONKey f where
517−instance (ConstructorNames f, SumFromString f) => GFromJSONKey f where
518−
519462-------------------------------------------------------------------------------
520463-- Functions needed for documentation
521464-------------------------------------------------------------------------------
522465
523466-- | Fail parsing due to a type mismatch, with a descriptive message.
524467--
525−-- The following wrappers should generally be prefered:
526−-- 'withObject', 'withArray', 'withText', 'withBool'.
527−--
528−-- ==== Error message example
468+-- Example usage:
529469--
530−-- > typeMismatch "Object" (String "oops")
531−-- > -- Error: "expected Object, but encountered String"
532−typeMismatch :: String -- ^ The name of the JSON type being parsed
533− -- (@\"Object\"@, @\"Array\"@, @\"String\"@, @\"Number\"@,
534− -- @\"Boolean\"@, or @\"Null\"@).
470+-- @
471+-- instance FromJSON Coord where
472+-- parseJSON ('Object' v) = {- type matches, life is good -}
473+-- parseJSON wat = 'typeMismatch' \"Coord\" wat
474+-- @
475+typeMismatch :: String -- ^ The name of the type you are trying to parse.
535476 -> Value -- ^ The actual value encountered.
536477 -> Parser a
537478typeMismatch expected actual =
538− fail $ "expected " ++ expected ++ ", but encountered " ++ typeOf actual
539−
540−-- | Fail parsing due to a type mismatch, when the expected types are implicit.
541−--
542−-- ==== Error message example
543−--
544−-- > unexpected (String "oops")
545−-- > -- Error: "unexpected String"
546−unexpected :: Value -> Parser a
547−unexpected actual = fail $ "unexpected " ++ typeOf actual
548−
549−-- | JSON type of a value, name of the head constructor.
550−typeOf :: Value -> String
551−typeOf v = case v of
552− Object _ -> "Object"
553− Array _ -> "Array"
554− String _ -> "String"
555− Number _ -> "Number"
556− Bool _ -> "Boolean"
557− Null -> "Null"
479+ fail $ "expected " ++ expected ++ ", encountered " ++ name
480+ where
481+ name = case actual of
482+ Object _ -> "Object"
483+ Array _ -> "Array"
484+ String _ -> "String"
485+ Number _ -> "Number"
486+ Bool _ -> "Boolean"
487+ Null -> "Null"
558488
559489-------------------------------------------------------------------------------
560490-- Lifings of FromJSON and ToJSON to unary and binary type constructors
@@ -567,7 +497,7 @@ typeOf v = case v of
567497--
568498-- * "Data.Aeson.TH" provides Template Haskell functions which will derive an
569499-- instance at compile time. The generated instance is optimized for your type
570−-- so it will probably be more efficient than the following option.
500+-- so will probably be more efficient than the following two options:
571501--
572502-- * The compiler can provide a default generic implementation for
573503-- 'liftParseJSON'.
@@ -585,20 +515,16 @@ typeOf v = case v of
585515--
586516-- data Pair a b = Pair { pairFst :: a, pairSnd :: b } deriving 'Generic1'
587517--
588−-- instance 'FromJSON' a => 'FromJSON1' (Pair a)
518+-- instance FromJSON a => FromJSON1 (Pair a)
589519-- @
590520--
591−-- If the default implementation doesn't give exactly the results you want,
521+-- If @DefaultSignatures@ doesn't give exactly the results you want,
592522-- you can customize the generic decoding with only a tiny amount of
593523-- effort, using 'genericLiftParseJSON' with your preferred 'Options':
594524--
595525-- @
596−-- customOptions = 'defaultOptions'
597−-- { 'fieldLabelModifier' = 'map' 'Data.Char.toUpper'
598−-- }
599−--
600−-- instance 'FromJSON' a => 'FromJSON1' (Pair a) where
601−-- 'liftParseJSON' = 'genericLiftParseJSON' customOptions
526+-- instance FromJSON a => FromJSON1 (Pair a) where
527+-- liftParseJSON = 'genericLiftParseJSON' 'defaultOptions'
602528-- @
603529class FromJSON1 f where
604530 liftParseJSON :: (Value -> Parser a) -> (Value -> Parser [a]) -> Value -> Parser (f a)
@@ -635,8 +561,9 @@ class FromJSON2 f where
635561 -> (Value -> Parser b)
636562 -> (Value -> Parser [b])
637563 -> Value -> Parser [f a b]
638− liftParseJSONList2 fa ga fb gb = withArray "[]" $ \vals ->
639− fmap V.toList (V.mapM (liftParseJSON2 fa ga fb gb) vals)
564+ liftParseJSONList2 fa ga fb gb v = case v of
565+ Array vals -> fmap V.toList (V.mapM (liftParseJSON2 fa ga fb gb) vals)
566+ _ -> typeMismatch "[a]" v
640567
641568-- | Lift the standard 'parseJSON' function through the type constructor.
642569parseJSON2 :: (FromJSON2 f, FromJSON a, FromJSON b) => Value -> Parser (f a b)
@@ -650,7 +577,7 @@ parseJSON2 = liftParseJSON2 parseJSON parseJSONList parseJSON parseJSONList
650577-- | Helper function to use with 'liftParseJSON'. See 'Data.Aeson.ToJSON.listEncoding'.
651578listParser :: (Value -> Parser a) -> Value -> Parser [a]
652579listParser f (Array xs) = fmap V.toList (V.mapM f xs)
653−listParser _ v = typeMismatch "Array" v
580+listParser _ v = typeMismatch "[a]" v
654581{-# INLINE listParser #-}
655582
656583-------------------------------------------------------------------------------
@@ -668,139 +595,48 @@ instance (FromJSON a) => FromJSON [a] where
668595-- Functions
669596-------------------------------------------------------------------------------
670597
671−-- | Add context to a failure message, indicating the name of the structure
672−-- being parsed.
673−--
674−-- > prependContext "MyType" (fail "[error message]")
675−-- > -- Error: "parsing MyType failed, [error message]"
676−prependContext :: String -> Parser a -> Parser a
677−prependContext name = prependFailure ("parsing " ++ name ++ " failed, ")
678−
679−-- | @'withObject' name f value@ applies @f@ to the 'Object' when @value@
680−-- is an 'Data.Aeson.Object' and fails otherwise.
681−--
682−-- ==== Error message example
683−--
684−-- > withObject "MyType" f (String "oops")
685−-- > -- Error: "parsing MyType failed, expected Object, but encountered String"
598+-- | @withObject expected f value@ applies @f@ to the 'Object' when @value@ is an @Object@
599+-- and fails using @'typeMismatch' expected@ otherwise.
686600withObject :: String -> (Object -> Parser a) -> Value -> Parser a
687−withObject _ f (Object obj) = f obj
688−withObject name _ v = prependContext name (typeMismatch "Object" v)
601+withObject _ f (Object obj) = f obj
602+withObject expected _ v = typeMismatch expected v
689603{-# INLINE withObject #-}
690604
691−-- | @'withText' name f value@ applies @f@ to the 'Text' when @value@ is a
692−-- 'Data.Aeson.String' and fails otherwise.
693−--
694−-- ==== Error message example
695−--
696−-- > withText "MyType" f Null
697−-- > -- Error: "parsing MyType failed, expected String, but encountered Null"
605+-- | @withText expected f value@ applies @f@ to the 'Text' when @value@ is a @String@
606+-- and fails using @'typeMismatch' expected@ otherwise.
698607withText :: String -> (Text -> Parser a) -> Value -> Parser a
699−withText _ f (String txt) = f txt
700−withText name _ v = prependContext name (typeMismatch "String" v)
608+withText _ f (String txt) = f txt
609+withText expected _ v = typeMismatch expected v
701610{-# INLINE withText #-}
702611
703−-- | @'withArray' expected f value@ applies @f@ to the 'Array' when @value@ is
704−-- an 'Data.Aeson.Array' and fails otherwise.
705−--
706−-- ==== Error message example
707−--
708−-- > withArray "MyType" f (String "oops")
709−-- > -- Error: "parsing MyType failed, expected Array, but encountered String"
612+-- | @withArray expected f value@ applies @f@ to the 'Array' when @value@ is an @Array@
613+-- and fails using @'typeMismatch' expected@ otherwise.
710614withArray :: String -> (Array -> Parser a) -> Value -> Parser a
711−withArray _ f (Array arr) = f arr
712−withArray name _ v = prependContext name (typeMismatch "Array" v)
615+withArray _ f (Array arr) = f arr
616+withArray expected _ v = typeMismatch expected v
713617{-# INLINE withArray #-}
714618
715−-- | @'withScientific' name f value@ applies @f@ to the 'Scientific' number
716−-- when @value@ is a 'Data.Aeson.Number' and fails using 'typeMismatch'
717−-- otherwise.
718−--
719−-- /Warning/: If you are converting from a scientific to an unbounded
720−-- type such as 'Integer' you may want to add a restriction on the
721−-- size of the exponent (see 'withBoundedScientific') to prevent
722−-- malicious input from filling up the memory of the target system.
723−--
724−-- ==== Error message example
725−--
726−-- > withScientific "MyType" f (String "oops")
727−-- > -- Error: "parsing MyType failed, expected Number, but encountered String"
619+-- | @withNumber expected f value@ applies @f@ to the 'Number' when @value@ is a 'Number'.
620+-- and fails using @'typeMismatch' expected@ otherwise.
621+withNumber :: String -> (Number -> Parser a) -> Value -> Parser a
622+withNumber expected f = withScientific expected (f . scientificToNumber)
623+{-# INLINE withNumber #-}
624+{-# DEPRECATED withNumber "Use withScientific instead" #-}
625+
626+-- | @withScientific expected f value@ applies @f@ to the 'Scientific' number when @value@ is a 'Number'.
627+-- and fails using @'typeMismatch' expected@ otherwise.
728628withScientific :: String -> (Scientific -> Parser a) -> Value -> Parser a
729−withScientific _ f (Number scientific) = f scientific
730−withScientific name _ v = prependContext name (typeMismatch "Number" v)
629+withScientific _ f (Number scientific) = f scientific
630+withScientific expected _ v = typeMismatch expected v
731631{-# INLINE withScientific #-}
732632
733−-- | A variant of 'withScientific' which doesn't use 'prependContext', so that
734−-- such context can be added separately in a way that also applies when the
735−-- continuation @f :: Scientific -> Parser a@ fails.
736−--
737−-- /Warning/: If you are converting from a scientific to an unbounded
738−-- type such as 'Integer' you may want to add a restriction on the
739−-- size of the exponent (see 'withBoundedScientific') to prevent
740−-- malicious input from filling up the memory of the target system.
741−--
742−-- ==== Error message examples
743−--
744−-- > withScientific' f (String "oops")
745−-- > -- Error: "unexpected String"
746−-- >
747−-- > prependContext "MyType" (withScientific' f (String "oops"))
748−-- > -- Error: "parsing MyType failed, unexpected String"
749−withScientific' :: (Scientific -> Parser a) -> Value -> Parser a
750−withScientific' f v = case v of
751− Number n -> f n
752− _ -> typeMismatch "Number" v
753−{-# INLINE withScientific' #-}
754−
755−-- | @'withBoundedScientific' name f value@ applies @f@ to the 'Scientific' number
756−-- when @value@ is a 'Number' with exponent less than or equal to 1024.
757−withBoundedScientific :: String -> (Scientific -> Parser a) -> Value -> Parser a
758−withBoundedScientific name f v = withBoundedScientific_ (prependContext name) f v
759−{-# INLINE withBoundedScientific #-}
760−
761−-- | A variant of 'withBoundedScientific' which doesn't use 'prependContext',
762−-- so that such context can be added separately in a way that also applies
763−-- when the continuation @f :: Scientific -> Parser a@ fails.
764−withBoundedScientific' :: (Scientific -> Parser a) -> Value -> Parser a
765−withBoundedScientific' f v = withBoundedScientific_ id f v
766−{-# INLINE withBoundedScientific' #-}
767−
768−-- | A variant of 'withBoundedScientific_' parameterized by a function to apply
769−-- to the 'Parser' in case of failure.
770−withBoundedScientific_ :: (Parser a -> Parser a) -> (Scientific -> Parser a) -> Value -> Parser a
771−withBoundedScientific_ whenFail f (Number scientific) =
772− if exp10 > 1024
773− then whenFail (fail msg)
774− else f scientific
775− where
776− exp10 = base10Exponent scientific
777− msg = "found a number with exponent " ++ show exp10 ++ ", but it must not be greater than 1024"
778−withBoundedScientific_ whenFail _ v =
779− whenFail (typeMismatch "Number" v)
780−{-# INLINE withBoundedScientific_ #-}
781−
782−-- | @'withBool' expected f value@ applies @f@ to the 'Bool' when @value@ is a
783−-- 'Boolean' and fails otherwise.
784−--
785−-- ==== Error message example
786−--
787−-- > withBool "MyType" f (String "oops")
788−-- > -- Error: "parsing MyType failed, expected Boolean, but encountered String"
633+-- | @withBool expected f value@ applies @f@ to the 'Bool' when @value@ is a @Bool@
634+-- and fails using @'typeMismatch' expected@ otherwise.
789635withBool :: String -> (Bool -> Parser a) -> Value -> Parser a
790−withBool _ f (Bool arr) = f arr
791−withBool name _ v = prependContext name (typeMismatch "Boolean" v)
636+withBool _ f (Bool arr) = f arr
637+withBool expected _ v = typeMismatch expected v
792638{-# INLINE withBool #-}
793639
794−-- | Decode a nested JSON-encoded string.
795−withEmbeddedJSON :: String -> (Value -> Parser a) -> Value -> Parser a
796−withEmbeddedJSON _ innerParser (String txt) =
797− either fail innerParser $ eitherDecode (L.fromStrict $ T.encodeUtf8 txt)
798− where
799− eitherDecode = eitherFormatError . eitherDecodeWith jsonEOF ifromJSON
800− eitherFormatError = either (Left . uncurry formatError) Right
801−withEmbeddedJSON name _ v = prependContext name (typeMismatch "String" v)
802−{-# INLINE withEmbeddedJSON #-}
803−
804640-- | Convert a value from JSON, failing if the types do not match.
805641fromJSON :: (FromJSON a) => Value -> Result a
806642fromJSON = parse parseJSON
@@ -819,68 +655,32 @@ ifromJSON = iparse parseJSON
819655-- in an object for it to be valid. If the key and value are
820656-- optional, use '.:?' instead.
821657(.:) :: (FromJSON a) => Object -> Text -> Parser a
822−(.:) = explicitParseField parseJSON
658+obj .: key = case H.lookup key obj of
659+ Nothing -> fail $ "key " ++ show key ++ " not present"
660+ Just v -> parseJSON v <?> Key key
823661{-# INLINE (.:) #-}
824662
825−-- | Retrieve the value associated with the given key of an 'Object'. The
826−-- result is 'Nothing' if the key is not present or if its value is 'Null',
827−-- or 'empty' if the value cannot be converted to the desired type.
663+-- | Retrieve the value associated with the given key of an 'Object'. The
664+-- result is 'Nothing' if the key is not present or value is 'Null', or 'empty'
665+-- if the value cannot be converted to the desired type.
828666--
829667-- This accessor is most useful if the key and value can be absent
830668-- from an object without affecting its validity. If the key and
831669-- value are mandatory, use '.:' instead.
832670(.:?) :: (FromJSON a) => Object -> Text -> Parser (Maybe a)
833−(.:?) = explicitParseFieldMaybe parseJSON
671+obj .:? key = case H.lookup key obj of
672+ Nothing -> pure Nothing
673+ Just v -> parseJSON v <?> Key key
834674{-# INLINE (.:?) #-}
835675
836−-- | Retrieve the value associated with the given key of an 'Object'.
837−-- The result is 'Nothing' if the key is not present or 'empty' if the
838−-- value cannot be converted to the desired type.
839−--
840−-- This differs from '.:?' by attempting to parse 'Null' the same as any
841−-- other JSON value, instead of interpreting it as 'Nothing'.
676+-- | Like '.:?', but the resulting parser will fail,
677+-- if the key is present but is 'Null'.
842678(.:!) :: (FromJSON a) => Object -> Text -> Parser (Maybe a)
843−(.:!) = explicitParseFieldMaybe' parseJSON
679+obj .:! key = case H.lookup key obj of
680+ Nothing -> pure Nothing
681+ Just v -> Just <$> parseJSON v <?> Key key
844682{-# INLINE (.:!) #-}
845683
846−-- | Function variant of '.:'.
847−parseField :: (FromJSON a) => Object -> Text -> Parser a
848−parseField = (.:)
849−{-# INLINE parseField #-}
850−
851−-- | Function variant of '.:?'.
852−parseFieldMaybe :: (FromJSON a) => Object -> Text -> Parser (Maybe a)
853−parseFieldMaybe = (.:?)
854−{-# INLINE parseFieldMaybe #-}
855−
856−-- | Function variant of '.:!'.
857−parseFieldMaybe' :: (FromJSON a) => Object -> Text -> Parser (Maybe a)
858−parseFieldMaybe' = (.:!)
859−{-# INLINE parseFieldMaybe' #-}
860−
861−-- | Variant of '.:' with explicit parser function.
862−--
863−-- E.g. @'explicitParseField' 'parseJSON1' :: ('FromJSON1' f, 'FromJSON' a) -> 'Object' -> 'Text' -> 'Parser' (f a)@
864−explicitParseField :: (Value -> Parser a) -> Object -> Text -> Parser a
865−explicitParseField p obj key = case H.lookup key obj of
866− Nothing -> fail $ "key " ++ show key ++ " not found"
867− Just v -> p v <?> Key key
868−{-# INLINE explicitParseField #-}
869−
870−-- | Variant of '.:?' with explicit parser function.
871−explicitParseFieldMaybe :: (Value -> Parser a) -> Object -> Text -> Parser (Maybe a)
872−explicitParseFieldMaybe p obj key = case H.lookup key obj of
873− Nothing -> pure Nothing
874− Just v -> liftParseJSON p (listParser p) v <?> Key key -- listParser isn't used by maybe instance.
875−{-# INLINE explicitParseFieldMaybe #-}
876−
877−-- | Variant of '.:!' with explicit parser function.
878−explicitParseFieldMaybe' :: (Value -> Parser a) -> Object -> Text -> Parser (Maybe a)
879−explicitParseFieldMaybe' p obj key = case H.lookup key obj of
880− Nothing -> pure Nothing
881− Just v -> Just <$> p v <?> Key key
882−{-# INLINE explicitParseFieldMaybe' #-}
883−
884684-- | Helper for use in combination with '.:?' to provide default
885685-- values for optional JSON object fields.
886686--
@@ -903,47 +703,11 @@ pmval .!= val = fromMaybe val <$> pmval
903703-- Generic parseJSON
904704-------------------------------------------------------------------------------
905705
906−instance GFromJSON arity V1 where
907− -- Whereof we cannot format, thereof we cannot parse:
908− gParseJSON _ _ _ = fail "Attempted to parse empty type"
909−
910−
911706instance OVERLAPPABLE_ (GFromJSON arity a) => GFromJSON arity (M1 i c a) where
912707 -- Meta-information, which is not handled elsewhere, is just added to the
913708 -- parsed value:
914709 gParseJSON opts fargs = fmap M1 . gParseJSON opts fargs
915710
916−-- Information for error messages
917−
918−type TypeName = String
919−type ConName = String
920−
921−-- | Add the name of the type being parsed to a parser's error messages.
922−contextType :: TypeName -> Parser a -> Parser a
923−contextType = prependContext
924−
925−-- | Add the tagKey that will be looked up while building an ADT
926−-- | Produce the error equivalent to
927−-- | Left "Error in $: parsing T failed, expected an object with keys "tag" and
928−-- | "contents", where "tag" i-- |s associated to one of ["Foo", "Bar"],
929−-- | The parser returned error was: could not find key "tag"
930−contextTag :: Text -> [String] -> Parser a -> Parser a
931−contextTag tagKey cnames = prependFailure
932− ("expected Object with key \"" ++ unpack tagKey ++ "\"" ++
933− " containing one of " ++ show cnames ++ ", ")
934−
935−-- | Add the name of the constructor being parsed to a parser's error messages.
936−contextCons :: ConName -> TypeName -> Parser a -> Parser a
937−contextCons cname tname = prependContext (showCons cname tname)
938−
939−-- | Render a constructor as @\"MyType(MyConstructor)\"@.
940−showCons :: ConName -> TypeName -> String
941−showCons cname tname = tname ++ "(" ++ cname ++ ")"
942−
943−--------------------------------------------------------------------------------
944−
945−-- Parsing single fields
946−
947711instance (FromJSON a) => GFromJSON arity (K1 i a) where
948712 -- Constant values are decoded using their FromJSON instance:
949713 gParseJSON _opts _ = fmap K1 . parseJSON
@@ -958,499 +722,288 @@ instance (FromJSON1 f) => GFromJSON One (Rec1 f) where
958722 -- FromJSON1 instance:
959723 gParseJSON _opts (From1Args pj pjl) = fmap Rec1 . liftParseJSON pj pjl
960724
725+instance GFromJSON arity U1 where
726+ -- Empty constructors are expected to be encoded as an empty array:
727+ gParseJSON _opts _ v
728+ | isEmptyArray v = pure U1
729+ | otherwise = typeMismatch "unit constructor (U1)" v
730+
731+instance (ConsFromJSON arity a) => GFromJSON arity (C1 c a) where
732+ -- Constructors need to be decoded differently depending on whether they're
733+ -- a record or not. This distinction is made by consParseJSON:
734+ gParseJSON opts fargs = fmap M1 . consParseJSON opts fargs
735+
736+instance ( FromProduct arity a, FromProduct arity b
737+ , ProductSize a, ProductSize b
738+ ) => GFromJSON arity (a :*: b) where
739+ -- Products are expected to be encoded to an array. Here we check whether we
740+ -- got an array of the same size as the product, then parse each of the
741+ -- product's elements using parseProduct:
742+ gParseJSON opts fargs = withArray "product (:*:)" $ \arr ->
743+ let lenArray = V.length arr
744+ lenProduct = (unTagged2 :: Tagged2 (a :*: b) Int -> Int)
745+ productSize in
746+ if lenArray == lenProduct
747+ then parseProduct opts fargs arr 0 lenProduct
748+ else fail $ "When expecting a product of " ++ show lenProduct ++
749+ " values, encountered an Array of " ++ show lenArray ++
750+ " elements instead"
751+
752+instance ( AllNullary (a :+: b) allNullary
753+ , ParseSum arity (a :+: b) allNullary
754+ ) => GFromJSON arity (a :+: b) where
755+ -- If all constructors of a sum datatype are nullary and the
756+ -- 'allNullaryToStringTag' option is set they are expected to be
757+ -- encoded as strings. This distinction is made by 'parseSum':
758+ gParseJSON opts fargs =
759+ (unTagged :: Tagged allNullary (Parser ((a :+: b) d)) ->
760+ Parser ((a :+: b) d))
761+ . parseSum opts fargs
762+
961763instance (FromJSON1 f, GFromJSON One g) => GFromJSON One (f :.: g) where
962764 -- If an occurrence of the last type parameter is nested inside two
963765 -- composed types, it is decoded by using the outermost type's FromJSON1
964766 -- instance to generically decode the innermost type:
965767 gParseJSON opts fargs =
966− let gpj = gParseJSON opts fargs in
967− fmap Comp1 . liftParseJSON gpj (listParser gpj)
968−
969−--------------------------------------------------------------------------------
970−
971−instance (GFromJSON' arity a, Datatype d) => GFromJSON arity (D1 d a) where
972− -- Meta-information, which is not handled elsewhere, is just added to the
973− -- parsed value:
974− gParseJSON opts fargs = fmap M1 . gParseJSON' (tname :* opts :* fargs)
975− where
976− tname = moduleName proxy ++ "." ++ datatypeName proxy
977− proxy = undefined :: M1 _i d _f _p
978−
979−-- | 'GFromJSON', after unwrapping the 'D1' constructor, now carrying the data
980−-- type's name.
981−class GFromJSON' arity f where
982− gParseJSON' :: TypeName :* Options :* FromArgs arity a
983− -> Value
984− -> Parser (f a)
985−
986−-- | Single constructor.
987−instance ( ConsFromJSON arity a
988− , AllNullary (C1 c a) allNullary
989− , ParseSum arity (C1 c a) allNullary
990− , Constructor c
991− ) => GFromJSON' arity (C1 c a) where
992− -- The option 'tagSingleConstructors' determines whether to wrap
993− -- a single-constructor type.
994− gParseJSON' p@(_ :* opts :* _)
995− | tagSingleConstructors opts
996− = (unTagged :: Tagged allNullary (Parser (C1 c a p)) -> Parser (C1 c a p))
997− . parseSum p
998− | otherwise = fmap M1 . consParseJSON (cname :* p)
999− where
1000− cname = conName (undefined :: M1 _i c _f _p)
1001−
1002−-- | Multiple constructors.
1003−instance ( AllNullary (a :+: b) allNullary
1004− , ParseSum arity (a :+: b) allNullary
1005− ) => GFromJSON' arity (a :+: b) where
1006− -- If all constructors of a sum datatype are nullary and the
1007− -- 'allNullaryToStringTag' option is set they are expected to be
1008− -- encoded as strings. This distinction is made by 'parseSum':
1009− gParseJSON' p =
1010− (unTagged :: Tagged allNullary (Parser ((a :+: b) _d)) ->
1011− Parser ((a :+: b) _d))
1012− . parseSum p
768+ let gpj = gParseJSON opts fargs in
769+ fmap Comp1 . liftParseJSON gpj (listParser gpj)
1013770
1014771--------------------------------------------------------------------------------
1015772
1016773class ParseSum arity f allNullary where
1017− parseSum :: TypeName :* Options :* FromArgs arity a
1018− -> Value
1019− -> Tagged allNullary (Parser (f a))
1020−
1021−instance ( ConstructorNames f
1022− , SumFromString f
1023− , FromPair arity f
1024− , FromTaggedObject arity f
1025− , FromUntaggedValue arity f
1026− ) => ParseSum arity f True where
1027− parseSum p@(tname :* opts :* _)
1028− | allNullaryToStringTag opts = Tagged . parseAllNullarySum tname opts
1029− | otherwise = Tagged . parseNonAllNullarySum p
1030−
1031−instance ( ConstructorNames f
1032− , FromPair arity f
1033− , FromTaggedObject arity f
1034− , FromUntaggedValue arity f
1035− ) => ParseSum arity f False where
1036− parseSum p = Tagged . parseNonAllNullarySum p
774+ parseSum :: Options -> FromArgs arity a
775+ -> Value -> Tagged allNullary (Parser (f a))
776+
777+instance ( SumFromString (a :+: b)
778+ , FromPair arity (a :+: b)
779+ , FromTaggedObject arity (a :+: b)
780+ ) => ParseSum arity (a :+: b) True where
781+ parseSum opts fargs
782+ | allNullaryToStringTag opts = Tagged . parseAllNullarySum opts
783+ | otherwise = Tagged . parseNonAllNullarySum opts fargs
784+
785+instance ( FromPair arity (a :+: b)
786+ , FromTaggedObject arity (a :+: b)
787+ ) => ParseSum arity (a :+: b) False where
788+ parseSum opts fargs = Tagged . parseNonAllNullarySum opts fargs
1037789
1038790--------------------------------------------------------------------------------
1039791
1040−parseAllNullarySum :: (SumFromString f, ConstructorNames f)
1041− => TypeName -> Options -> Value -> Parser (f a)
1042−parseAllNullarySum tname opts =
1043− withText tname $ \tag ->
1044− maybe (badTag tag) return $
1045− parseSumFromString modifier tag
1046− where
1047− badTag tag = failWithCTags tname modifier $ \cnames ->
1048− "expected one of the tags " ++ show cnames ++
1049− ", but found tag " ++ show tag
1050− modifier = constructorTagModifier opts
1051−
1052−-- | Fail with an informative error message about a mismatched tag.
1053−-- The error message is parameterized by the list of expected tags,
1054−-- to be inferred from the result type of the parser.
1055−failWithCTags
1056− :: forall f a t. ConstructorNames f
1057− => TypeName -> (String -> t) -> ([t] -> String) -> Parser (f a)
1058−failWithCTags tname modifier f =
1059− contextType tname . fail $ f cnames
1060− where
1061− cnames = unTagged2 (constructorTags modifier :: Tagged2 f [t])
792+parseAllNullarySum :: SumFromString f => Options -> Value -> Parser (f a)
793+parseAllNullarySum opts = withText "Text" $ \key ->
794+ maybe (notFound key) return $
795+ parseSumFromString opts key
1062796
1063797class SumFromString f where
1064− parseSumFromString :: (String -> String) -> Text -> Maybe (f a)
798+ parseSumFromString :: Options -> Text -> Maybe (f a)
1065799
1066800instance (SumFromString a, SumFromString b) => SumFromString (a :+: b) where
1067801 parseSumFromString opts key = (L1 <$> parseSumFromString opts key) <|>
1068802 (R1 <$> parseSumFromString opts key)
1069803
1070804instance (Constructor c) => SumFromString (C1 c U1) where
1071− parseSumFromString modifier key
1072− | key == name = Just $ M1 U1
1073− | otherwise = Nothing
1074− where
1075− name = pack $ modifier $ conName (undefined :: M1 _i c _f _p)
1076−
1077−-- For genericFromJSONKey
1078−instance SumFromString a => SumFromString (D1 d a) where
1079− parseSumFromString modifier key = M1 <$> parseSumFromString modifier key
1080−
1081−-- | List of all constructor tags.
1082−constructorTags :: ConstructorNames a => (String -> t) -> Tagged2 a [t]
1083−constructorTags modifier =
1084− fmap DList.toList (constructorNames' modifier)
1085−
1086−-- | List of all constructor names of an ADT, after a given conversion
1087−-- function. (Better inlining.)
1088−class ConstructorNames a where
1089− constructorNames' :: (String -> t) -> Tagged2 a (DList.DList t)
1090−
1091−instance (ConstructorNames a, ConstructorNames b) => ConstructorNames (a :+: b) where
1092− constructorNames' = liftA2 append constructorNames' constructorNames'
1093− where
1094− append
1095− :: Tagged2 a (DList.DList t)
1096− -> Tagged2 b (DList.DList t)
1097− -> Tagged2 (a :+: b) (DList.DList t)
1098− append (Tagged2 xs) (Tagged2 ys) = Tagged2 (DList.append xs ys)
1099−
1100−instance Constructor c => ConstructorNames (C1 c a) where
1101− constructorNames' f = Tagged2 (pure (f cname))
1102− where
1103− cname = conName (undefined :: M1 _i c _f _p)
1104−
1105−-- For genericFromJSONKey
1106−instance ConstructorNames a => ConstructorNames (D1 d a) where
1107− constructorNames' = retag . constructorNames'
1108− where
1109− retag :: Tagged2 a u -> Tagged2 (D1 d a) u
1110− retag (Tagged2 x) = Tagged2 x
805+ parseSumFromString opts key | key == name = Just $ M1 U1
806+ | otherwise = Nothing
807+ where
808+ name = pack $ constructorTagModifier opts $
809+ conName (undefined :: t c U1 p)
1111810
1112811--------------------------------------------------------------------------------
1113−parseNonAllNullarySum :: forall f c arity.
1114− ( FromPair arity f
1115− , FromTaggedObject arity f
1116− , FromUntaggedValue arity f
1117− , ConstructorNames f
1118− ) => TypeName :* Options :* FromArgs arity c
1119− -> Value -> Parser (f c)
1120−parseNonAllNullarySum p@(tname :* opts :* _) =
812+
813+parseNonAllNullarySum :: ( FromPair arity (a :+: b)
814+ , FromTaggedObject arity (a :+: b)
815+ ) => Options -> FromArgs arity c
816+ -> Value -> Parser ((a :+: b) c)
817+parseNonAllNullarySum opts fargs =
1121818 case sumEncoding opts of
1122819 TaggedObject{..} ->
1123− withObject tname $ \obj -> do
1124− tag <- contextType tname . contextTag tagKey cnames_ $ obj .: tagKey
1125− fromMaybe (badTag tag <?> Key tagKey) $
1126− parseFromTaggedObject (tag :* contentsFieldName :* p) obj
1127− where
1128− tagKey = pack tagFieldName
1129− badTag tag = failWith_ $ \cnames ->
1130− "expected tag field to be one of " ++ show cnames ++
1131− ", but found tag " ++ show tag
1132− cnames_ = unTagged2 (constructorTags (constructorTagModifier opts) :: Tagged2 f [String])
820+ withObject "Object" $ \obj -> do
821+ tag <- obj .: pack tagFieldName
822+ fromMaybe (notFound tag) $
823+ parseFromTaggedObject opts fargs contentsFieldName obj tag
1133824
1134825 ObjectWithSingleField ->
1135− withObject tname $ \obj -> case H.toList obj of
1136− [(tag, v)] -> maybe (badTag tag) (<?> Key tag) $
1137− parsePair (tag :* p) v
1138− _ -> contextType tname . fail $
1139− "expected an Object with a single pair, but found " ++
1140− show (H.size obj) ++ " pairs"
1141− where
1142− badTag tag = failWith_ $ \cnames ->
1143− "expected an Object with a single pair where the tag is one of " ++
1144− show cnames ++ ", but found tag " ++ show tag
826+ withObject "Object" $ \obj ->
827+ case H.toList obj of
828+ [pair@(tag, _)] -> fromMaybe (notFound tag) $
829+ parsePair opts fargs pair
830+ _ -> fail "Object doesn't have a single field"
1145831
1146832 TwoElemArray ->
1147− withArray tname $ \arr -> case V.length arr of
1148− 2 | String tag <- V.unsafeIndex arr 0 ->
1149− maybe (badTag tag <?> Index 0) (<?> Index 1) $
1150− parsePair (tag :* p) (V.unsafeIndex arr 1)
1151− | otherwise ->
1152− contextType tname $
1153− fail "tag element is not a String" <?> Index 0
1154− len -> contextType tname . fail $
1155− "expected a 2-element Array, but encountered an Array of length " ++
1156− show len
1157− where
1158− badTag tag = failWith_ $ \cnames ->
1159− "expected tag of the 2-element Array to be one of " ++
1160− show cnames ++ ", but found tag " ++ show tag
1161−
1162− UntaggedValue -> parseUntaggedValue p
1163− where
1164− failWith_ = failWithCTags tname (constructorTagModifier opts)
833+ withArray "Array" $ \arr ->
834+ if V.length arr == 2
835+ then case V.unsafeIndex arr 0 of
836+ String tag -> fromMaybe (notFound tag) $
837+ parsePair opts fargs (tag, V.unsafeIndex arr 1)
838+ _ -> fail "First element is not a String"
839+ else fail "Array doesn't have 2 elements"
1165840
1166841--------------------------------------------------------------------------------
1167842
1168843class FromTaggedObject arity f where
1169− -- The first two components of the parameter tuple are: the constructor tag
1170− -- to match against, and the contents field name.
1171− parseFromTaggedObject
1172− :: Text :* String :* TypeName :* Options :* FromArgs arity a
1173− -> Object
1174− -> Maybe (Parser (f a))
844+ parseFromTaggedObject :: Options -> FromArgs arity a
845+ -> String -> Object
846+ -> Text -> Maybe (Parser (f a))
1175847
1176848instance ( FromTaggedObject arity a, FromTaggedObject arity b) =>
1177849 FromTaggedObject arity (a :+: b) where
1178− parseFromTaggedObject p obj =
1179− (fmap L1 <$> parseFromTaggedObject p obj) <|>
1180− (fmap R1 <$> parseFromTaggedObject p obj)
850+ parseFromTaggedObject opts fargs contentsFieldName obj tag =
851+ (fmap L1 <$> parseFromTaggedObject opts fargs contentsFieldName obj tag) <|>
852+ (fmap R1 <$> parseFromTaggedObject opts fargs contentsFieldName obj tag)
1181853
1182−instance ( IsRecord f isRecord
1183− , FromTaggedObject' arity f isRecord
854+instance ( FromTaggedObject' arity f
1184855 , Constructor c
1185856 ) => FromTaggedObject arity (C1 c f) where
1186− parseFromTaggedObject (tag :* contentsFieldName :* p@(_ :* opts :* _))
1187− | tag == tag'
1188− = Just . fmap M1 .
1189− (unTagged :: Tagged isRecord (Parser (f a)) -> Parser (f a)) .
1190− parseFromTaggedObject' (contentsFieldName :* cname :* p)
1191− | otherwise = const Nothing
1192− where
1193− tag' = pack $ constructorTagModifier opts cname
1194− cname = conName (undefined :: M1 _i c _f _p)
857+ parseFromTaggedObject opts fargs contentsFieldName obj tag
858+ | tag == name = Just $ M1 <$> parseFromTaggedObject'
859+ opts fargs contentsFieldName obj
860+ | otherwise = Nothing
861+ where
862+ name = pack $ constructorTagModifier opts $
863+ conName (undefined :: t c f p)
1195864
1196865--------------------------------------------------------------------------------
1197866
1198−class FromTaggedObject' arity f isRecord where
1199− -- The first component of the parameter tuple is the contents field name.
1200− parseFromTaggedObject'
1201− :: String :* ConName :* TypeName :* Options :* FromArgs arity a
1202− -> Object -> Tagged isRecord (Parser (f a))
1203−
1204−instance (RecordFromJSON arity f, FieldNames f) => FromTaggedObject' arity f True where
1205− -- Records are unpacked in the tagged object
1206− parseFromTaggedObject' (_ :* p) = Tagged . recordParseJSON (True :* p)
1207−
1208−instance (ConsFromJSON arity f) => FromTaggedObject' arity f False where
1209− -- Nonnullary nonrecords are encoded in the contents field
1210− parseFromTaggedObject' p obj = Tagged $ do
1211− contents <- contextCons cname tname (obj .: key)
1212− consParseJSON p' contents <?> Key key
1213− where
1214− key = pack contentsFieldName
1215− contentsFieldName :* p'@(cname :* tname :* _) = p
867+class FromTaggedObject' arity f where
868+ parseFromTaggedObject' :: Options -> FromArgs arity a -> String
869+ -> Object -> Parser (f a)
870+
871+class FromTaggedObject'' arity f isRecord where
872+ parseFromTaggedObject'' :: Options -> FromArgs arity a -> String
873+ -> Object -> Tagged isRecord (Parser (f a))
874+
875+instance ( IsRecord f isRecord
876+ , FromTaggedObject'' arity f isRecord
877+ ) => FromTaggedObject' arity f where
878+ parseFromTaggedObject' opts fargs contentsFieldName =
879+ (unTagged :: Tagged isRecord (Parser (f a)) -> Parser (f a)) .
880+ parseFromTaggedObject'' opts fargs contentsFieldName
1216881
1217−instance OVERLAPPING_ FromTaggedObject' arity U1 False where
1218− -- Nullary constructors don't need a contents field
1219− parseFromTaggedObject' _ _ = Tagged (pure U1)
882+instance (FromRecord arity f) => FromTaggedObject'' arity f True where
883+ parseFromTaggedObject'' opts fargs _ =
884+ Tagged . parseRecord opts fargs Nothing
885+
886+instance (GFromJSON arity f) => FromTaggedObject'' arity f False where
887+ parseFromTaggedObject'' opts fargs contentsFieldName = Tagged .
888+ (gParseJSON opts fargs <=< (.: pack contentsFieldName))
889+
890+instance OVERLAPPING_ FromTaggedObject'' arity U1 False where
891+ parseFromTaggedObject'' _ _ _ _ = Tagged (pure U1)
1220892
1221893--------------------------------------------------------------------------------
1222894
1223−-- | Constructors need to be decoded differently depending on whether they're
1224−-- a record or not. This distinction is made by 'ConsParseJSON'.
1225895class ConsFromJSON arity f where
1226− consParseJSON
1227− :: ConName :* TypeName :* Options :* FromArgs arity a
1228− -> Value -> Parser (f a)
896+ consParseJSON :: Options -> FromArgs arity a
897+ -> Value -> Parser (f a)
1229898
1230899class ConsFromJSON' arity f isRecord where
1231− consParseJSON'
1232− :: ConName :* TypeName :* Options :* FromArgs arity a
1233− -> Value -> Tagged isRecord (Parser (f a))
900+ consParseJSON' :: Options -> FromArgs arity a
901+ -> Maybe Text -- ^ A dummy label
902+ -- (Nothing to use proper label)
903+ -> Value -> Tagged isRecord (Parser (f a))
1234904
1235905instance ( IsRecord f isRecord
1236906 , ConsFromJSON' arity f isRecord
1237907 ) => ConsFromJSON arity f where
1238− consParseJSON p =
1239− (unTagged :: Tagged isRecord (Parser (f a)) -> Parser (f a))
1240− . consParseJSON' p
1241−
1242−instance OVERLAPPING_
1243− ( GFromJSON arity a, RecordFromJSON arity (S1 s a)
1244− ) => ConsFromJSON' arity (S1 s a) True where
1245− consParseJSON' p@(cname :* tname :* opts :* fargs)
1246− | unwrapUnaryRecords opts = Tagged . fmap M1 . gParseJSON opts fargs
1247− | otherwise = Tagged . withObject (showCons cname tname) (recordParseJSON (False :* p))
1248−
1249−instance RecordFromJSON arity f => ConsFromJSON' arity f True where
1250− consParseJSON' p@(cname :* tname :* _) =
1251− Tagged . withObject (showCons cname tname) (recordParseJSON (False :* p))
1252−
1253−instance OVERLAPPING_
1254− ConsFromJSON' arity U1 False where
1255− -- Empty constructors are expected to be encoded as an empty array:
1256− consParseJSON' (cname :* tname :* _) v =
1257− Tagged . contextCons cname tname $ case v of
1258− Array a | V.null a -> pure U1
1259− | otherwise -> fail_ a
1260− _ -> typeMismatch "Array" v
1261− where
1262− fail_ a = fail $
1263− "expected an empty Array, but encountered an Array of length " ++
1264− show (V.length a)
908+ consParseJSON opts fargs v = let
909+ (v2,lab) = case (unwrapUnaryRecords opts,isUnary (undefined :: f a)) of
910+ -- use a dummy object with a dummy label
911+ (True,True) -> (object [(pack "dummy",v)], Just $ pack "dummy")
912+ _ ->(v,Nothing)
913+ in (unTagged :: Tagged isRecord (Parser (f a)) -> Parser (f a))
914+ $ consParseJSON' opts fargs lab v2
1265915
1266−instance OVERLAPPING_
1267− GFromJSON arity f => ConsFromJSON' arity (S1 s f) False where
1268− consParseJSON' (_ :* _ :* opts :* fargs) =
1269− Tagged . fmap M1 . gParseJSON opts fargs
1270916
1271−instance (ProductFromJSON arity f, ProductSize f
1272− ) => ConsFromJSON' arity f False where
1273− consParseJSON' p = Tagged . productParseJSON0 p
917+instance (FromRecord arity f) => ConsFromJSON' arity f True where
918+ consParseJSON' opts fargs mlab = Tagged . withObject "record (:*:)"
919+ (parseRecord opts fargs mlab)
1274920
1275−--------------------------------------------------------------------------------
921+instance (GFromJSON arity f) => ConsFromJSON' arity f False where
922+ consParseJSON' opts fargs _ = Tagged . gParseJSON opts fargs
1276923
1277−class FieldNames f where
1278− fieldNames :: f a -> [Text] -> [Text]
1279−
1280−instance (FieldNames a, FieldNames b) => FieldNames (a :*: b) where
1281− fieldNames _ =
1282− fieldNames (undefined :: a x) .
1283− fieldNames (undefined :: b y)
1284−
1285−instance (Selector s) => FieldNames (S1 s f) where
1286− fieldNames _ = (pack (selName (undefined :: M1 _i s _f _p)) :)
1287−
1288−class RecordFromJSON arity f where
1289− recordParseJSON
1290− :: Bool :* ConName :* TypeName :* Options :* FromArgs arity a
1291− -> Object -> Parser (f a)
924+--------------------------------------------------------------------------------
1292925
1293−instance ( FieldNames f
1294− , RecordFromJSON' arity f
1295− ) => RecordFromJSON arity f where
1296− recordParseJSON (fromTaggedSum :* p@(cname :* tname :* opts :* _)) =
1297− \obj -> checkUnknown obj >> recordParseJSON' p obj
926+class FromRecord arity f where
927+ parseRecord :: Options -> FromArgs arity a
928+ -> Maybe Text -- ^ A dummy label
929+ -- (Nothing to use proper label)
930+ -> Object -> Parser (f a)
931+
932+instance ( FromRecord arity a
933+ , FromRecord arity b
934+ ) => FromRecord arity (a :*: b) where
935+ parseRecord opts fargs _ obj =
936+ (:*:) <$> parseRecord opts fargs Nothing obj
937+ <*> parseRecord opts fargs Nothing obj
938+
939+instance ( Selector s
940+ , GFromJSON arity a
941+ ) => FromRecord arity (S1 s a) where
942+ parseRecord opts fargs lab =
943+ (<?> Key label) . gParseJSON opts fargs <=< (.: label)
1298944 where
1299− knownFields :: H.HashMap Text ()
1300− knownFields = H.fromList $ map (,()) $
1301− fieldNames (undefined :: f a)
1302− [pack (tagFieldName (sumEncoding opts)) | fromTaggedSum]
1303− checkUnknown =
1304− if not (rejectUnknownFields opts)
1305− then \_ -> return ()
1306− else \obj -> case H.keys (H.difference obj knownFields) of
1307− [] -> return ()
1308− unknownFields -> contextCons cname tname $
1309− fail ("unknown fields: " ++ show unknownFields)
1310−
1311−class RecordFromJSON' arity f where
1312− recordParseJSON'
1313− :: ConName :* TypeName :* Options :* FromArgs arity a
1314− -> Object -> Parser (f a)
1315−
1316−instance ( RecordFromJSON' arity a
1317− , RecordFromJSON' arity b
1318− ) => RecordFromJSON' arity (a :*: b) where
1319− recordParseJSON' p obj =
1320− (:*:) <$> recordParseJSON' p obj
1321− <*> recordParseJSON' p obj
1322−
1323−instance OVERLAPPABLE_ (Selector s, GFromJSON arity a) =>
1324− RecordFromJSON' arity (S1 s a) where
1325− recordParseJSON' (cname :* tname :* opts :* fargs) obj = do
1326− fv <- contextCons cname tname (obj .: label)
1327− M1 <$> gParseJSON opts fargs fv <?> Key label
1328− where
1329− label = pack $ fieldLabelModifier opts sname
1330− sname = selName (undefined :: M1 _i s _f _p)
1331−
1332−instance INCOHERENT_ (Selector s, FromJSON a) =>
1333− RecordFromJSON' arity (S1 s (K1 i (Maybe a))) where
1334− recordParseJSON' (_ :* _ :* opts :* _) obj = M1 . K1 <$> obj .:? pack label
1335− where
1336− label = fieldLabelModifier opts sname
1337− sname = selName (undefined :: M1 _i s _f _p)
1338−
1339−-- Parse an Option like a Maybe.
1340−instance INCOHERENT_ (Selector s, FromJSON a) =>
1341− RecordFromJSON' arity (S1 s (K1 i (Semigroup.Option a))) where
1342− recordParseJSON' p obj = wrap <$> recordParseJSON' p obj
1343− where
1344− wrap :: S1 s (K1 i (Maybe a)) p -> S1 s (K1 i (Semigroup.Option a)) p
1345− wrap (M1 (K1 a)) = M1 (K1 (Semigroup.Option a))
945+ label = fromMaybe defLabel lab
946+ defLabel = pack . fieldLabelModifier opts $
947+ selName (undefined :: t s a p)
948+
949+instance OVERLAPPING_ (Selector s, FromJSON a) =>
950+ FromRecord arity (S1 s (K1 i (Maybe a))) where
951+ parseRecord _ _ (Just lab) obj = (M1 . K1) <$> obj .:? lab
952+ parseRecord opts _ Nothing obj = (M1 . K1) <$> obj .:? pack label
953+ where
954+ label = fieldLabelModifier opts $
955+ selName (undefined :: t s (K1 i (Maybe a)) p)
1346956
1347957--------------------------------------------------------------------------------
1348958
1349−productParseJSON0
1350− :: forall f arity a. (ProductFromJSON arity f, ProductSize f)
1351− => ConName :* TypeName :* Options :* FromArgs arity a
1352− -> Value -> Parser (f a)
1353− -- Products are expected to be encoded to an array. Here we check whether we
1354− -- got an array of the same size as the product, then parse each of the
1355− -- product's elements using productParseJSON:
1356−productParseJSON0 p@(cname :* tname :* _ :* _) =
1357− withArray (showCons cname tname) $ \arr ->
1358− let lenArray = V.length arr
1359− lenProduct = (unTagged2 :: Tagged2 f Int -> Int)
1360− productSize in
1361− if lenArray == lenProduct
1362− then productParseJSON p arr 0 lenProduct
1363− else contextCons cname tname $
1364− fail $ "expected an Array of length " ++ show lenProduct ++
1365− ", but encountered an Array of length " ++ show lenArray
1366−
1367−--
1368−
1369−class ProductFromJSON arity f where
1370− productParseJSON :: ConName :* TypeName :* Options :* FromArgs arity a
959+class FromProduct arity f where
960+ parseProduct :: Options -> FromArgs arity a
1371961 -> Array -> Int -> Int
1372962 -> Parser (f a)
1373963
1374−instance ( ProductFromJSON arity a
1375− , ProductFromJSON arity b
1376− ) => ProductFromJSON arity (a :*: b) where
1377− productParseJSON p arr ix len =
1378− (:*:) <$> productParseJSON p arr ix lenL
1379− <*> productParseJSON p arr ixR lenR
964+instance ( FromProduct arity a
965+ , FromProduct arity b
966+ ) => FromProduct arity (a :*: b) where
967+ parseProduct opts fargs arr ix len =
968+ (:*:) <$> parseProduct opts fargs arr ix lenL
969+ <*> parseProduct opts fargs arr ixR lenR
1380970 where
1381971 lenL = len `unsafeShiftR` 1
1382972 ixR = ix + lenL
1383973 lenR = len - lenL
1384974
1385−instance (GFromJSON arity a) => ProductFromJSON arity (S1 s a) where
1386− productParseJSON (_ :* _ :* opts :* fargs) arr ix _ =
1387− M1 <$> gParseJSON opts fargs (V.unsafeIndex arr ix) <?> Index ix
975+instance (GFromJSON arity a) => FromProduct arity (S1 s a) where
976+ parseProduct opts fargs arr ix _ =
977+ gParseJSON opts fargs $ V.unsafeIndex arr ix
1388978
1389979--------------------------------------------------------------------------------
1390980
1391981class FromPair arity f where
1392− -- The first component of the parameter tuple is the tag to match.
1393− parsePair :: Text :* TypeName :* Options :* FromArgs arity a
1394− -> Value
1395− -> Maybe (Parser (f a))
982+ parsePair :: Options -> FromArgs arity a
983+ -> Pair -> Maybe (Parser (f a))
1396984
1397985instance ( FromPair arity a
1398986 , FromPair arity b
1399987 ) => FromPair arity (a :+: b) where
1400− parsePair p pair =
1401− (fmap L1 <$> parsePair p pair) <|>
1402− (fmap R1 <$> parsePair p pair)
988+ parsePair opts fargs pair = (fmap L1 <$> parsePair opts fargs pair) <|>
989+ (fmap R1 <$> parsePair opts fargs pair)
1403990
1404991instance ( Constructor c
992+ , GFromJSON arity a
1405993 , ConsFromJSON arity a
1406994 ) => FromPair arity (C1 c a) where
1407− parsePair (tag :* p@(_ :* opts :* _)) v
1408− | tag == tag' = Just $ M1 <$> consParseJSON (cname :* p) v
995+ parsePair opts fargs (tag, value)
996+ | tag == tag' = Just $ gParseJSON opts fargs value
1409997 | otherwise = Nothing
1410− where
1411− tag' = pack $ constructorTagModifier opts cname
1412− cname = conName (undefined :: M1 _i c _a _p)
998+ where
999+ tag' = pack $ constructorTagModifier opts $
1000+ conName (undefined :: t c a p)
14131001
14141002--------------------------------------------------------------------------------
14151003
1416−class FromUntaggedValue arity f where
1417− parseUntaggedValue :: TypeName :* Options :* FromArgs arity a
1418− -> Value
1419− -> Parser (f a)
1420−
1421−instance
1422− ( FromUntaggedValue arity a
1423− , FromUntaggedValue arity b
1424− ) => FromUntaggedValue arity (a :+: b)
1425− where
1426− parseUntaggedValue p value =
1427− L1 <$> parseUntaggedValue p value <|>
1428− R1 <$> parseUntaggedValue p value
1429−
1430−instance OVERLAPPABLE_
1431− ( ConsFromJSON arity a
1432− , Constructor c
1433− ) => FromUntaggedValue arity (C1 c a)
1434− where
1435− parseUntaggedValue p = fmap M1 . consParseJSON (cname :* p)
1436− where
1437− cname = conName (undefined :: M1 _i c _f _p)
1438−
1439−instance OVERLAPPING_
1440− ( Constructor c )
1441− => FromUntaggedValue arity (C1 c U1)
1442− where
1443− parseUntaggedValue (tname :* opts :* _) v =
1444− contextCons cname tname $ case v of
1445− String tag
1446− | tag == tag' -> pure $ M1 U1
1447− | otherwise -> fail_ tag
1448− _ -> typeMismatch "String" v
1449− where
1450− tag' = pack $ constructorTagModifier opts cname
1451− cname = conName (undefined :: M1 _i c _f _p)
1452− fail_ tag = fail $
1453− "expected tag " ++ show tag' ++ ", but found tag " ++ show tag
1004+notFound :: Text -> Parser a
1005+notFound key = fail $ "The key \"" ++ unpack key ++ "\" was not found"
1006+{-# INLINE notFound #-}
14541007
14551008-------------------------------------------------------------------------------
14561009-- Instances
@@ -1508,20 +1061,17 @@ instance (FromJSON a, FromJSON b) => FromJSON (Either a b) where
15081061 parseJSON = parseJSON2
15091062 {-# INLINE parseJSON #-}
15101063
1511−instance FromJSON Void where
1512− parseJSON _ = fail "Cannot parse Void"
1513− {-# INLINE parseJSON #-}
1064+
15141065
15151066instance FromJSON Bool where
1516− parseJSON (Bool b) = pure b
1517− parseJSON v = typeMismatch "Bool" v
1067+ parseJSON = withBool "Bool" pure
15181068 {-# INLINE parseJSON #-}
15191069
15201070instance FromJSONKey Bool where
15211071 fromJSONKey = FromJSONKeyTextParser $ \t -> case t of
15221072 "true" -> pure True
15231073 "false" -> pure False
1524− _ -> fail $ "cannot parse key " ++ show t ++ " into Bool"
1074+ _ -> fail $ "Cannot parse key into Bool: " ++ T.unpack t
15251075
15261076instance FromJSON Ordering where
15271077 parseJSON = withText "Ordering" $ \s ->
@@ -1529,30 +1079,25 @@ instance FromJSON Ordering where
15291079 "LT" -> return LT
15301080 "EQ" -> return EQ
15311081 "GT" -> return GT
1532− _ -> fail $ "parsing Ordering failed, unexpected " ++ show s ++
1533− " (expected \"LT\", \"EQ\", or \"GT\")"
1082+ _ -> fail "Parsing Ordering value failed: expected \"LT\", \"EQ\", or \"GT\""
15341083
15351084instance FromJSON () where
15361085 parseJSON = withArray "()" $ \v ->
15371086 if V.null v
15381087 then pure ()
1539− else prependContext "()" $ fail "expected an empty array"
1088+ else fail "Expected an empty array"
15401089 {-# INLINE parseJSON #-}
15411090
15421091instance FromJSON Char where
1543− parseJSON = withText "Char" parseChar
1092+ parseJSON = withText "Char" $ \t ->
1093+ if T.compareLength t 1 == EQ
1094+ then pure $ T.head t
1095+ else fail "Expected a string of length 1"
15441096 {-# INLINE parseJSON #-}
15451097
1546− parseJSONList (String s) = pure (T.unpack s)
1547− parseJSONList v = typeMismatch "String" v
1098+ parseJSONList = withText "String" $ pure . T.unpack
15481099 {-# INLINE parseJSONList #-}
15491100
1550−parseChar :: Text -> Parser Char
1551−parseChar t =
1552− if T.compareLength t 1 == EQ
1553− then pure $ T.head t
1554− else prependContext "Char" $ fail "expected a string of length 1"
1555−
15561101instance FromJSON Double where
15571102 parseJSON = parseRealFloat "Double"
15581103 {-# INLINE parseJSON #-}
@@ -1564,6 +1109,12 @@ instance FromJSONKey Double where
15641109 "-Infinity" -> pure (negate 1/0)
15651110 _ -> Scientific.toRealFloat <$> parseScientificText t
15661111
1112+instance FromJSON Number where
1113+ parseJSON (Number s) = pure $ scientificToNumber s
1114+ parseJSON Null = pure (D (0/0))
1115+ parseJSON v = typeMismatch "Number" v
1116+ {-# INLINE parseJSON #-}
1117+
15671118instance FromJSON Float where
15681119 parseJSON = parseRealFloat "Float"
15691120 {-# INLINE parseJSON #-}
@@ -1576,30 +1127,17 @@ instance FromJSONKey Float where
15761127 _ -> Scientific.toRealFloat <$> parseScientificText t
15771128
15781129instance (FromJSON a, Integral a) => FromJSON (Ratio a) where
1579− parseJSON (Number x)
1580− | exp10 <= 1024
1581− , exp10 >= -1024 = return $! realToFrac x
1582− | otherwise = prependContext "Ratio" $ fail msg
1583− where
1584− exp10 = base10Exponent x
1585− msg = "found a number with exponent " ++ show exp10
1586− ++ ", but it must not be greater than 1024 or less than -1024"
1587− parseJSON o = objParser o
1588− where
1589− objParser = withObject "Rational" $ \obj -> do
1590− numerator <- obj .: "numerator"
1591− denominator <- obj .: "denominator"
1592− if denominator == 0
1593− then fail "Ratio denominator was 0"
1594− else pure $ numerator % denominator
1595− {-# INLINE parseJSON #-}
1596−
1597−-- | This instance includes a bounds check to prevent maliciously
1598−-- large inputs to fill up the memory of the target system. You can
1599−-- newtype 'Scientific' and provide your own instance using
1600−-- 'withScientific' if you want to allow larger inputs.
1130+ parseJSON = withObject "Rational" $ \obj ->
1131+ (%) <$> obj .: "numerator"
1132+ <*> obj .: "denominator"
1133+ {-# INLINE parseJSON #-}
1134+
1135+-- | /WARNING:/ Only parse fixed-precision numbers from trusted input
1136+-- since an attacker could easily fill up the memory of the target
1137+-- system by specifying a scientific number with a big exponent like
1138+-- @1e1000000000@.
16011139instance HasResolution a => FromJSON (Fixed a) where
1602− parseJSON = prependContext "Fixed" . withBoundedScientific' (pure . realToFrac)
1140+ parseJSON = withScientific "Fixed" $ pure . realToFrac
16031141 {-# INLINE parseJSON #-}
16041142
16051143instance FromJSON Int where
@@ -1607,12 +1145,12 @@ instance FromJSON Int where
16071145 {-# INLINE parseJSON #-}
16081146
16091147instance FromJSONKey Int where
1610− fromJSONKey = FromJSONKeyTextParser $ parseBoundedIntegralText "Int"
1148+ fromJSONKey = FromJSONKeyTextParser $ parseBoundedIntegralText "Int"
16111149
1612−-- | This instance includes a bounds check to prevent maliciously
1613−-- large inputs to fill up the memory of the target system. You can
1614−-- newtype 'Scientific' and provide your own instance using
1615−-- 'withScientific' if you want to allow larger inputs.
1150+-- | /WARNING:/ Only parse Integers from trusted input since an
1151+-- attacker could easily fill up the memory of the target system by
1152+-- specifying a scientific number with a big exponent like
1153+-- @1e1000000000@.
16161154instance FromJSON Integer where
16171155 parseJSON = parseIntegral "Integer"
16181156 {-# INLINE parseJSON #-}
@@ -1621,21 +1159,16 @@ instance FromJSONKey Integer where
16211159 fromJSONKey = FromJSONKeyTextParser $ parseIntegralText "Integer"
16221160
16231161instance FromJSON Natural where
1624− parseJSON value = do
1625− integer <- parseIntegral "Natural" value
1626− parseNatural integer
1162+ parseJSON = withScientific "Natural" $ \s ->
1163+ if Scientific.coefficient s < 0
1164+ then fail $ "Expected a Natural number but got the negative number: " <> show s
1165+ else pure $ truncate s
16271166
16281167instance FromJSONKey Natural where
1629− fromJSONKey = FromJSONKeyTextParser $ \text -> do
1630− integer <- parseIntegralText "Natural" text
1631− parseNatural integer
1632−
1633−parseNatural :: Integer -> Parser Natural
1634−parseNatural integer =
1635− if integer < 0 then
1636− fail $ "parsing Natural failed, unexpected negative number " <> show integer
1637− else
1638− pure $ fromIntegral integer
1168+ fromJSONKey = FromJSONKeyTextParser $ \t -> parseScientificText t >>= \s ->
1169+ if Scientific.coefficient s < 0
1170+ then fail $ "Expected a Natural number but got the negative number: " <> show s
1171+ else pure $ truncate s
16391172
16401173instance FromJSON Int8 where
16411174 parseJSON = parseBoundedIntegral "Int8"
@@ -1700,9 +1233,6 @@ instance FromJSON Word64 where
17001233instance FromJSONKey Word64 where
17011234 fromJSONKey = FromJSONKeyTextParser $ parseBoundedIntegralText "Word64"
17021235
1703−instance FromJSON CTime where
1704− parseJSON = fmap CTime . parseJSON
1705− {-# INLINE parseJSON #-}
17061236
17071237instance FromJSON Text where
17081238 parseJSON = withText "Text" pure
@@ -1732,17 +1262,17 @@ parseVersionText = go . readP_to_S parseVersion . unpack
17321262 where
17331263 go [(v,[])] = return v
17341264 go (_ : xs) = go xs
1735− go _ = fail "parsing Version failed"
1265+ go _ = fail "could not parse Version"
17361266
17371267-------------------------------------------------------------------------------
17381268-- semigroups NonEmpty
17391269-------------------------------------------------------------------------------
17401270
17411271instance FromJSON1 NonEmpty where
1742− liftParseJSON p _ = withArray "NonEmpty" $
1272+ liftParseJSON p _ = withArray "NonEmpty a" $
17431273 (>>= ne) . Tr.sequence . zipWith (parseIndexedJSON p) [0..] . V.toList
17441274 where
1745− ne [] = fail "parsing NonEmpty failed, unexpected empty list"
1275+ ne [] = fail "Expected a NonEmpty but got an empty list"
17461276 ne (x:xs) = pure (x :| xs)
17471277 {-# INLINE liftParseJSON #-}
17481278
@@ -1763,7 +1293,7 @@ instance FromJSON Scientific where
17631293-------------------------------------------------------------------------------
17641294
17651295instance FromJSON1 DList.DList where
1766− liftParseJSON p _ = withArray "DList" $
1296+ liftParseJSON p _ = withArray "DList a" $
17671297 fmap DList.fromList .
17681298 Tr.sequence . zipWith (parseIndexedJSON p) [0..] . V.toList
17691299 {-# INLINE liftParseJSON #-}
@@ -1790,7 +1320,7 @@ instance (FromJSON a) => FromJSON (Identity a) where
17901320 parseJSONList = liftParseJSONList parseJSON parseJSONList
17911321 {-# INLINE parseJSONList #-}
17921322
1793−instance (FromJSONKey a) => FromJSONKey (Identity a) where
1323+instance (FromJSONKey a, FromJSON a) => FromJSONKey (Identity a) where
17941324 fromJSONKey = coerceFromJSONKeyFunction (fromJSONKey :: FromJSONKeyFunction a)
17951325 fromJSONKeyList = coerceFromJSONKeyFunction (fromJSONKeyList :: FromJSONKeyFunction [a])
17961326
@@ -1840,7 +1370,7 @@ instance (FromJSON1 f, FromJSON1 g) => FromJSON1 (Sum f g) where
18401370 inr = "InR"
18411371
18421372 liftParseJSON _ _ _ = fail $
1843− "parsing Sum failed, expected an object with a single property " ++
1373+ "expected an object with a single property " ++
18441374 "where the property key should be either " ++
18451375 "\"InL\" or \"InR\""
18461376 {-# INLINE liftParseJSON #-}
@@ -1854,7 +1384,7 @@ instance (FromJSON1 f, FromJSON1 g, FromJSON a) => FromJSON (Sum f g a) where
18541384-------------------------------------------------------------------------------
18551385
18561386instance FromJSON1 Seq.Seq where
1857− liftParseJSON p _ = withArray "Seq" $
1387+ liftParseJSON p _ = withArray "Seq a" $
18581388 fmap Seq.fromList .
18591389 Tr.sequence . zipWith (parseIndexedJSON p) [0..] . V.toList
18601390 {-# INLINE liftParseJSON #-}
@@ -1888,15 +1418,15 @@ instance FromJSON a => FromJSON (IntMap.IntMap a) where
18881418
18891419instance (FromJSONKey k, Ord k) => FromJSON1 (M.Map k) where
18901420 liftParseJSON p _ = case fromJSONKey of
1891− FromJSONKeyCoerce _ -> withObject "Map" $
1421+ FromJSONKeyCoerce _-> withObject "Map k v" $
18921422 fmap (H.foldrWithKey (M.insert . unsafeCoerce) M.empty) . H.traverseWithKey (\k v -> p v <?> Key k)
1893− FromJSONKeyText f -> withObject "Map" $
1423+ FromJSONKeyText f -> withObject "Map k v" $
18941424 fmap (H.foldrWithKey (M.insert . f) M.empty) . H.traverseWithKey (\k v -> p v <?> Key k)
1895− FromJSONKeyTextParser f -> withObject "Map" $
1425+ FromJSONKeyTextParser f -> withObject "Map k v" $
18961426 H.foldrWithKey (\k v m -> M.insert <$> f k <?> Key k <*> p v <?> Key k <*> m) (pure M.empty)
1897− FromJSONKeyValue f -> withArray "Map" $ \arr ->
1898− fmap M.fromList . Tr.sequence .
1899− zipWith (parseIndexedJSONPair f p) [0..] . V.toList $ arr
1427+ FromJSONKeyValue f -> withArray "Map k v" $ \arr ->
1428+ M.fromList <$> (Tr.sequence .
1429+ zipWith (parseIndexedJSONPair f p) [0..] . V.toList $ arr)
19001430 {-# INLINE liftParseJSON #-}
19011431
19021432instance (FromJSONKey k, Ord k, FromJSON v) => FromJSON (M.Map k v) where
@@ -1916,24 +1446,12 @@ instance (FromJSON v) => FromJSON (Tree.Tree v) where
19161446 parseJSON = parseJSON1
19171447 {-# INLINE parseJSON #-}
19181448
1919−-------------------------------------------------------------------------------
1920−-- uuid
1921−-------------------------------------------------------------------------------
1922−
1923−instance FromJSON UUID.UUID where
1924− parseJSON = withText "UUID" $
1925− maybe (fail "invalid UUID") pure . UUID.fromText
1926−
1927−instance FromJSONKey UUID.UUID where
1928− fromJSONKey = FromJSONKeyTextParser $
1929− maybe (fail "invalid UUID") pure . UUID.fromText
1930−
19311449-------------------------------------------------------------------------------
19321450-- vector
19331451-------------------------------------------------------------------------------
19341452
19351453instance FromJSON1 Vector where
1936− liftParseJSON p _ = withArray "Vector" $
1454+ liftParseJSON p _ = withArray "Vector a" $
19371455 V.mapM (uncurry $ parseIndexedJSON p) . V.indexed
19381456 {-# INLINE liftParseJSON #-}
19391457
@@ -1947,14 +1465,14 @@ vectorParseJSON s = withArray s $ fmap V.convert . V.mapM (uncurry $ parseIndexe
19471465{-# INLINE vectorParseJSON #-}
19481466
19491467instance (Storable a, FromJSON a) => FromJSON (VS.Vector a) where
1950− parseJSON = vectorParseJSON "Data.Vector.Storable.Vector"
1468+ parseJSON = vectorParseJSON "Data.Vector.Storable.Vector a"
19511469
19521470instance (VP.Prim a, FromJSON a) => FromJSON (VP.Vector a) where
1953− parseJSON = vectorParseJSON "Data.Vector.Primitive.Vector"
1471+ parseJSON = vectorParseJSON "Data.Vector.Primitive.Vector a"
19541472 {-# INLINE parseJSON #-}
19551473
19561474instance (VG.Vector VU.Vector a, FromJSON a) => FromJSON (VU.Vector a) where
1957− parseJSON = vectorParseJSON "Data.Vector.Unboxed.Vector"
1475+ parseJSON = vectorParseJSON "Data.Vector.Unboxed.Vector a"
19581476 {-# INLINE parseJSON #-}
19591477
19601478-------------------------------------------------------------------------------
@@ -1968,15 +1486,15 @@ instance (Eq a, Hashable a, FromJSON a) => FromJSON (HashSet.HashSet a) where
19681486
19691487instance (FromJSONKey k, Eq k, Hashable k) => FromJSON1 (H.HashMap k) where
19701488 liftParseJSON p _ = case fromJSONKey of
1971− FromJSONKeyCoerce _ -> withObject "HashMap ~Text" $
1489+ FromJSONKeyCoerce _ -> withObject "HashMap ~Text v" $
19721490 uc . H.traverseWithKey (\k v -> p v <?> Key k)
1973− FromJSONKeyText f -> withObject "HashMap" $
1491+ FromJSONKeyText f -> withObject "HashMap k v" $
19741492 fmap (mapKey f) . H.traverseWithKey (\k v -> p v <?> Key k)
1975− FromJSONKeyTextParser f -> withObject "HashMap" $
1493+ FromJSONKeyTextParser f -> withObject "HashMap k v" $
19761494 H.foldrWithKey (\k v m -> H.insert <$> f k <?> Key k <*> p v <?> Key k <*> m) (pure H.empty)
1977− FromJSONKeyValue f -> withArray "Map" $ \arr ->
1978− fmap H.fromList . Tr.sequence .
1979− zipWith (parseIndexedJSONPair f p) [0..] . V.toList $ arr
1495+ FromJSONKeyValue f -> withArray "Map k v" $ \arr ->
1496+ H.fromList <$> (Tr.sequence .
1497+ zipWith (parseIndexedJSONPair f p) [0..] . V.toList $ arr)
19801498 where
19811499 uc :: Parser (H.HashMap Text v) -> Parser (H.HashMap k v)
19821500 uc = unsafeCoerce
@@ -1997,33 +1515,11 @@ instance FromJSON DotNetTime where
19971515 parseJSON = withText "DotNetTime" $ \t ->
19981516 let (s,m) = T.splitAt (T.length t - 5) t
19991517 t' = T.concat [s,".",m]
2000− in case parseTimeM True defaultTimeLocale "/Date(%s%Q)/" (unpack t') of
1518+ in case parseTime defaultTimeLocale "/Date(%s%Q)/" (unpack t') of
20011519 Just d -> pure (DotNetTime d)
20021520 _ -> fail "could not parse .NET time"
20031521 {-# INLINE parseJSON #-}
20041522
2005−-------------------------------------------------------------------------------
2006−-- primitive
2007−-------------------------------------------------------------------------------
2008−
2009−instance FromJSON a => FromJSON (PM.Array a) where
2010− -- note: we could do better than this if vector exposed the data
2011− -- constructor in Data.Vector.
2012− parseJSON = fmap Exts.fromList . parseJSON
2013−
2014−instance FromJSON a => FromJSON (PM.SmallArray a) where
2015− parseJSON = fmap Exts.fromList . parseJSON
2016−
2017−#if MIN_VERSION_primitive(0,6,4)
2018−instance (PM.Prim a,FromJSON a) => FromJSON (PM.PrimArray a) where
2019− parseJSON = fmap Exts.fromList . parseJSON
2020−
2021−#if !MIN_VERSION_primitive(0,7,0)
2022−instance (PM.PrimUnlifted a,FromJSON a) => FromJSON (PM.UnliftedArray a) where
2023− parseJSON = fmap Exts.fromList . parseJSON
2024−#endif
2025−#endif
2026−
20271523-------------------------------------------------------------------------------
20281524-- time
20291525-------------------------------------------------------------------------------
@@ -2049,17 +1545,6 @@ instance FromJSONKey LocalTime where
20491545 fromJSONKey = FromJSONKeyTextParser (Time.run Time.localTime)
20501546
20511547
2052−-- | Supported string formats:
2053−--
2054−-- @YYYY-MM-DD HH:MM Z@
2055−-- @YYYY-MM-DD HH:MM:SS Z@
2056−-- @YYYY-MM-DD HH:MM:SS.SSS Z@
2057−--
2058−-- The first space may instead be a @T@, and the second space is
2059−-- optional. The @Z@ represents UTC. The @Z@ may be replaced with a
2060−-- time zone offset of the form @+0000@ or @-08:00@, where the first
2061−-- two digits are hours, the @:@ is optional and the second two digits
2062−-- (also optional) are minutes.
20631548instance FromJSON ZonedTime where
20641549 parseJSON = withText "ZonedTime" (Time.run Time.zonedTime)
20651550
@@ -2074,168 +1559,41 @@ instance FromJSONKey UTCTime where
20741559 fromJSONKey = FromJSONKeyTextParser (Time.run Time.utcTime)
20751560
20761561
2077−-- | This instance includes a bounds check to prevent maliciously
2078−-- large inputs to fill up the memory of the target system. You can
2079−-- newtype 'Scientific' and provide your own instance using
2080−-- 'withScientific' if you want to allow larger inputs.
1562+-- | /WARNING:/ Only parse lengths of time from trusted input
1563+-- since an attacker could easily fill up the memory of the target
1564+-- system by specifying a scientific number with a big exponent like
1565+-- @1e1000000000@.
20811566instance FromJSON NominalDiffTime where
2082− parseJSON = withBoundedScientific "NominalDiffTime" $ pure . realToFrac
2083− {-# INLINE parseJSON #-}
2084−
2085−
2086−-- | This instance includes a bounds check to prevent maliciously
2087−-- large inputs to fill up the memory of the target system. You can
2088−-- newtype 'Scientific' and provide your own instance using
2089−-- 'withScientific' if you want to allow larger inputs.
2090−instance FromJSON DiffTime where
2091− parseJSON = withBoundedScientific "DiffTime" $ pure . realToFrac
1567+ parseJSON = withScientific "NominalDiffTime" $ pure . realToFrac
20921568 {-# INLINE parseJSON #-}
20931569
2094−instance FromJSON SystemTime where
2095− parseJSON v = prependContext "SystemTime" $ do
2096− n <- parseJSON v
2097− let n' = floor (n * fromInteger (resolution n) :: Nano)
2098− let (secs, nano) = n' `divMod` resolution n
2099− return (MkSystemTime (fromInteger secs) (fromInteger nano))
2100−
2101−instance FromJSON CalendarDiffTime where
2102− parseJSON = withObject "CalendarDiffTime" $ \obj -> CalendarDiffTime
2103− <$> obj .: "months"
2104− <*> obj .: "time"
2105−
2106−instance FromJSON CalendarDiffDays where
2107− parseJSON = withObject "CalendarDiffDays" $ \obj -> CalendarDiffDays
2108− <$> obj .: "months"
2109− <*> obj .: "days"
2110−
2111−instance FromJSON DayOfWeek where
2112− parseJSON = withText "DaysOfWeek" parseDayOfWeek
2113−
2114−parseDayOfWeek :: T.Text -> Parser DayOfWeek
2115−parseDayOfWeek t = case T.toLower t of
2116− "monday" -> return Monday
2117− "tuesday" -> return Tuesday
2118− "wednesday" -> return Wednesday
2119− "thursday" -> return Thursday
2120− "friday" -> return Friday
2121− "saturday" -> return Saturday
2122− "sunday" -> return Sunday
2123− _ -> fail "Invalid week day"
2124−
2125−instance FromJSONKey DayOfWeek where
2126− fromJSONKey = FromJSONKeyTextParser parseDayOfWeek
2127−
21281570-------------------------------------------------------------------------------
21291571-- base Monoid/Semigroup
21301572-------------------------------------------------------------------------------
21311573
2132−instance FromJSON1 Monoid.Dual where
2133− liftParseJSON p _ = fmap Monoid.Dual . p
1574+instance FromJSON1 Dual where
1575+ liftParseJSON p _ = fmap Dual . p
21341576 {-# INLINE liftParseJSON #-}
21351577
2136−instance FromJSON a => FromJSON (Monoid.Dual a) where
1578+instance FromJSON a => FromJSON (Dual a) where
21371579 parseJSON = parseJSON1
21381580 {-# INLINE parseJSON #-}
21391581
21401582
2141−instance FromJSON1 Monoid.First where
2142− liftParseJSON p p' = fmap Monoid.First . liftParseJSON p p'
1583+instance FromJSON1 First where
1584+ liftParseJSON p p' = fmap First . liftParseJSON p p'
21431585 {-# INLINE liftParseJSON #-}
21441586
2145−instance FromJSON a => FromJSON (Monoid.First a) where
1587+instance FromJSON a => FromJSON (First a) where
21461588 parseJSON = parseJSON1
21471589 {-# INLINE parseJSON #-}
21481590
21491591
2150−instance FromJSON1 Monoid.Last where
2151− liftParseJSON p p' = fmap Monoid.Last . liftParseJSON p p'
1592+instance FromJSON1 Last where
1593+ liftParseJSON p p' = fmap Last . liftParseJSON p p'
21521594 {-# INLINE liftParseJSON #-}
21531595
2154−instance FromJSON a => FromJSON (Monoid.Last a) where
2155− parseJSON = parseJSON1
2156− {-# INLINE parseJSON #-}
2157−
2158−
2159−instance FromJSON1 Semigroup.Min where
2160− liftParseJSON p _ a = Semigroup.Min <$> p a
2161− {-# INLINE liftParseJSON #-}
2162−
2163− liftParseJSONList _ p a = fmap Semigroup.Min <$> p a
2164− {-# INLINE liftParseJSONList #-}
2165−
2166−instance (FromJSON a) => FromJSON (Semigroup.Min a) where
2167− parseJSON = parseJSON1
2168− {-# INLINE parseJSON #-}
2169−
2170− parseJSONList = liftParseJSONList parseJSON parseJSONList
2171− {-# INLINE parseJSONList #-}
2172−
2173−
2174−instance FromJSON1 Semigroup.Max where
2175− liftParseJSON p _ a = Semigroup.Max <$> p a
2176− {-# INLINE liftParseJSON #-}
2177−
2178− liftParseJSONList _ p a = fmap Semigroup.Max <$> p a
2179− {-# INLINE liftParseJSONList #-}
2180−
2181−instance (FromJSON a) => FromJSON (Semigroup.Max a) where
2182− parseJSON = parseJSON1
2183− {-# INLINE parseJSON #-}
2184−
2185− parseJSONList = liftParseJSONList parseJSON parseJSONList
2186− {-# INLINE parseJSONList #-}
2187−
2188−
2189−instance FromJSON1 Semigroup.First where
2190− liftParseJSON p _ a = Semigroup.First <$> p a
2191− {-# INLINE liftParseJSON #-}
2192−
2193− liftParseJSONList _ p a = fmap Semigroup.First <$> p a
2194− {-# INLINE liftParseJSONList #-}
2195−
2196−instance (FromJSON a) => FromJSON (Semigroup.First a) where
2197− parseJSON = parseJSON1
2198− {-# INLINE parseJSON #-}
2199−
2200− parseJSONList = liftParseJSONList parseJSON parseJSONList
2201− {-# INLINE parseJSONList #-}
2202−
2203−
2204−instance FromJSON1 Semigroup.Last where
2205− liftParseJSON p _ a = Semigroup.Last <$> p a
2206− {-# INLINE liftParseJSON #-}
2207−
2208− liftParseJSONList _ p a = fmap Semigroup.Last <$> p a
2209− {-# INLINE liftParseJSONList #-}
2210−
2211−instance (FromJSON a) => FromJSON (Semigroup.Last a) where
2212− parseJSON = parseJSON1
2213− {-# INLINE parseJSON #-}
2214−
2215− parseJSONList = liftParseJSONList parseJSON parseJSONList
2216− {-# INLINE parseJSONList #-}
2217−
2218−
2219−instance FromJSON1 Semigroup.WrappedMonoid where
2220− liftParseJSON p _ a = Semigroup.WrapMonoid <$> p a
2221− {-# INLINE liftParseJSON #-}
2222−
2223− liftParseJSONList _ p a = fmap Semigroup.WrapMonoid <$> p a
2224− {-# INLINE liftParseJSONList #-}
2225−
2226−instance (FromJSON a) => FromJSON (Semigroup.WrappedMonoid a) where
2227− parseJSON = parseJSON1
2228− {-# INLINE parseJSON #-}
2229−
2230− parseJSONList = liftParseJSONList parseJSON parseJSONList
2231− {-# INLINE parseJSONList #-}
2232−
2233−
2234−instance FromJSON1 Semigroup.Option where
2235− liftParseJSON p p' = fmap Semigroup.Option . liftParseJSON p p'
2236− {-# INLINE liftParseJSON #-}
2237−
2238−instance FromJSON a => FromJSON (Semigroup.Option a) where
1596+instance FromJSON a => FromJSON (Last a) where
22391597 parseJSON = parseJSON1
22401598 {-# INLINE parseJSON #-}
22411599
@@ -2243,21 +1601,11 @@ instance FromJSON a => FromJSON (Semigroup.Option a) where
22431601-- tagged
22441602-------------------------------------------------------------------------------
22451603
2246−instance FromJSON1 Proxy where
2247− {-# INLINE liftParseJSON #-}
2248− liftParseJSON _ _ = fromNull "Proxy" Proxy
2249−
22501604instance FromJSON (Proxy a) where
22511605 {-# INLINE parseJSON #-}
2252− parseJSON = fromNull "Proxy" Proxy
1606+ parseJSON Null = pure Proxy
1607+ parseJSON v = typeMismatch "Proxy" v
22531608
2254−fromNull :: String -> a -> Value -> Parser a
2255−fromNull _ a Null = pure a
2256−fromNull c _ v = prependContext c (typeMismatch "Null" v)
2257−
2258−instance FromJSON2 Tagged where
2259− liftParseJSON2 _ _ p _ = fmap Tagged . p
2260− {-# INLINE liftParseJSON2 #-}
22611609
22621610instance FromJSON1 (Tagged a) where
22631611 liftParseJSON p _ = fmap Tagged . p
@@ -2280,7 +1628,10 @@ instance (FromJSON a, FromJSON b, FromJSON c) => FromJSONKey (a,b,c)
22801628instance (FromJSON a, FromJSON b, FromJSON c, FromJSON d) => FromJSONKey (a,b,c,d)
22811629
22821630instance FromJSONKey Char where
2283− fromJSONKey = FromJSONKeyTextParser parseChar
1631+ fromJSONKey = FromJSONKeyTextParser $ \t ->
1632+ if T.length t == 1
1633+ then return (T.index t 0)
1634+ else typeMismatch "Expected Char but String didn't contain exactly one character" (String t)
22841635 fromJSONKeyList = FromJSONKeyText T.unpack
22851636
22861637instance (FromJSONKey a, FromJSON a) => FromJSONKey [a] where