@@ -5,19 +5,16 @@
55{-# LANGUAGE FlexibleInstances #-}
66{-# LANGUAGE GADTs #-}
77{-# LANGUAGE MultiParamTypeClasses #-}
8−{-# LANGUAGE NamedFieldPuns #-}
8+{-# LANGUAGE NoImplicitPrelude #-}
99{-# LANGUAGE OverloadedStrings #-}
10+{-# LANGUAGE PolyKinds #-}
1011{-# LANGUAGE RecordWildCards #-}
1112{-# LANGUAGE ScopedTypeVariables #-}
1213{-# LANGUAGE TypeOperators #-}
13−{-# LANGUAGE TypeSynonymInstances #-}
14+{-# LANGUAGE TupleSections #-}
1415{-# LANGUAGE UndecidableInstances #-}
1516{-# LANGUAGE ViewPatterns #-}
1617
17−#if __GLASGOW_HASKELL__ >= 706
18−{-# LANGUAGE PolyKinds #-}
19−#endif
20−
2118#include "incoherent-compat.h"
2219#include "overlapping-compat.h"
2320
@@ -45,6 +42,9 @@ module Data.Aeson.Types.FromJSON
4542 , coerceFromJSONKeyFunction
4643 , mapFromJSONKeyFunction
4744
45+ , GFromJSONKey()
46+ , genericFromJSONKey
47+
4848 -- * List functions
4949 , listParser
5050
@@ -52,7 +52,6 @@ module Data.Aeson.Types.FromJSON
5252 , withObject
5353 , withText
5454 , withArray
55− , withNumber
5655 , withScientific
5756 , withBool
5857 , withEmbeddedJSON
@@ -61,12 +60,14 @@ module Data.Aeson.Types.FromJSON
6160 , fromJSON
6261 , ifromJSON
6362 , typeMismatch
63+ , unexpected
6464 , parseField
6565 , parseFieldMaybe
6666 , parseFieldMaybe'
6767 , explicitParseField
6868 , explicitParseFieldMaybe
6969 , explicitParseFieldMaybe'
70+ , parseIndexedJSON
7071 -- ** Operators
7172 , (.:)
7273 , (.:?)
@@ -77,18 +78,16 @@ module Data.Aeson.Types.FromJSON
7778 , parseOptionalFieldWith
7879 ) where
7980
80−import Prelude ()
8181import Prelude.Compat
8282
83−import Control.Applicative ((<|>), Const(..))
84−import Control.Monad ((<=<), zipWithM)
83+import Control.Applicative ((<|>), Const(..), liftA2)
84+import Control.Monad (zipWithM)
8585import Data.Aeson.Internal.Functions (mapKey)
8686import Data.Aeson.Parser.Internal (eitherDecodeWith, jsonEOF)
8787import Data.Aeson.Types.Generic
8888import Data.Aeson.Types.Internal
89−import Data.Attoparsec.Number (Number(..))
9089import Data.Bits (unsafeShiftR)
91−import Data.Fixed (Fixed, HasResolution)
90+import Data.Fixed (Fixed, HasResolution (resolution), Nano)
9291import Data.Functor.Compose (Compose(..))
9392import Data.Functor.Identity (Identity(..))
9493import Data.Functor.Product (Product(..))
@@ -100,15 +99,18 @@ import Data.Maybe (fromMaybe)
10099import Data.Semigroup ((<>))
101100import Data.Proxy (Proxy(..))
102101import Data.Ratio ((%), Ratio)
103−import Data.Scientific (Scientific)
102+import Data.Scientific (Scientific, base10Exponent)
104103import Data.Tagged (Tagged(..))
105104import Data.Text (Text, pack, unpack)
106105import Data.Time (Day, DiffTime, LocalTime, NominalDiffTime, TimeOfDay, UTCTime, ZonedTime)
107−import Data.Time.Format (parseTime)
108−import Data.Time.Locale.Compat (defaultTimeLocale)
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)
109110import Data.Traversable as Tr (sequence)
110111import Data.Vector (Vector)
111112import Data.Version (Version, parseVersion)
113+import Data.Void (Void)
112114import Data.Word (Word16, Word32, Word64, Word8)
113115import Foreign.Storable (Storable)
114116import Foreign.C.Types (CTime (..))
@@ -116,9 +118,9 @@ import GHC.Generics
116118import Numeric.Natural (Natural)
117119import Text.ParserCombinators.ReadP (readP_to_S)
118120import Unsafe.Coerce (unsafeCoerce)
119−import qualified Data.Aeson.Compat as Compat
120121import qualified Data.Aeson.Parser.Time as Time
121122import qualified Data.Attoparsec.ByteString.Char8 as A (endOfInput, parseOnly, scientific)
123+import qualified Data.ByteString.Lazy as L
122124import qualified Data.DList as DList
123125import qualified Data.HashMap.Strict as H
124126import qualified Data.HashSet as HashSet
@@ -141,18 +143,20 @@ import qualified Data.Vector.Primitive as VP
141143import qualified Data.Vector.Storable as VS
142144import qualified Data.Vector.Unboxed as VU
143145
144−#ifndef HAS_COERCIBLE
145−#define HAS_COERCIBLE (__GLASGOW_HASKELL__ >= 707)
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
150+
151+#if MIN_VERSION_primitive(0,6,4)
152+#if !MIN_VERSION_primitive(0,7,0)
153+import qualified Data.Primitive.UnliftedArray as PM
146154#endif
155+import qualified Data.Primitive.PrimArray as PM
156+#endif
157+
147158
148−#if HAS_COERCIBLE
149159import Data.Coerce (Coercible, coerce)
150−coerce' :: Coercible a b => a -> b
151−coerce' = coerce
152−#else
153−coerce' :: a -> b
154−coerce' = unsafeCoerce
155−#endif
156160
157161parseIndexedJSON :: (Value -> Parser a) -> Int -> Value -> Parser a
158162parseIndexedJSON p idx value = p value <?> Index idx
@@ -161,7 +165,7 @@ parseIndexedJSON p idx value = p value <?> Index idx
161165parseIndexedJSONPair :: (Value -> Parser a) -> (Value -> Parser b) -> Int -> Value -> Parser (a, b)
162166parseIndexedJSONPair keyParser valParser idx value = p value <?> Index idx
163167 where
164− p = withArray "(k,v)" $ \ab ->
168+ p = withArray "(k, v)" $ \ab ->
165169 let n = V.length ab
166170 in if n == 2
167171 then (,) <$> parseJSONElemAtIndex keyParser 0 ab
@@ -173,43 +177,34 @@ parseIndexedJSONPair keyParser valParser idx value = p value <?> Index idx
173177parseJSONElemAtIndex :: (Value -> Parser a) -> Int -> V.Vector Value -> Parser a
174178parseJSONElemAtIndex p idx ary = p (V.unsafeIndex ary idx) <?> Index idx
175179
176−scientificToNumber :: Scientific -> Number
177−scientificToNumber s
178− | e < 0 = D $ Scientific.toRealFloat s
179− | otherwise = I $ c * 10 ^ e
180− where
181− e = Scientific.base10Exponent s
182− c = Scientific.coefficient s
183−{-# INLINE scientificToNumber #-}
184−
185180parseRealFloat :: RealFloat a => String -> Value -> Parser a
186−parseRealFloat _ (Number s) = pure $ Scientific.toRealFloat s
187−parseRealFloat _ Null = pure (0/0)
188−parseRealFloat expected v = typeMismatch expected v
181+parseRealFloat _ (Number s) = pure $ Scientific.toRealFloat s
182+parseRealFloat _ Null = pure (0/0)
183+parseRealFloat name v = prependContext name (unexpected v)
189184{-# INLINE parseRealFloat #-}
190185
191−parseIntegralFromScientific :: forall a. Integral a => String -> Scientific -> Parser a
192−parseIntegralFromScientific expected s =
186+parseIntegralFromScientific :: forall a. Integral a => Scientific -> Parser a
187+parseIntegralFromScientific s =
193188 case Scientific.floatingOrInteger s :: Either Double a of
194189 Right x -> pure x
195− Left _ -> fail $ "expected " ++ expected ++ ", encountered floating number " ++ show s
190+ Left _ -> fail $ "unexpected floating number " ++ show s
196191{-# INLINE parseIntegralFromScientific #-}
197192
198193parseIntegral :: Integral a => String -> Value -> Parser a
199−parseIntegral expected =
200− withScientific expected $ parseIntegralFromScientific expected
194+parseIntegral name =
195+ prependContext name . withBoundedScientific' parseIntegralFromScientific
201196{-# INLINE parseIntegral #-}
202197
203−parseBoundedIntegralFromScientific :: (Bounded a, Integral a) => String -> Scientific -> Parser a
204−parseBoundedIntegralFromScientific expected s = maybe
205− (fail $ expected ++ " is either floating or will cause over or underflow: " ++ show s)
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)
206201 pure
207202 (Scientific.toBoundedInteger s)
208203{-# INLINE parseBoundedIntegralFromScientific #-}
209204
210205parseBoundedIntegral :: (Bounded a, Integral a) => String -> Value -> Parser a
211−parseBoundedIntegral expected =
212− withScientific expected $ parseBoundedIntegralFromScientific expected
206+parseBoundedIntegral name =
207+ prependContext name . withScientific' parseBoundedIntegralFromScientific
213208{-# INLINE parseBoundedIntegral #-}
214209
215210parseScientificText :: Text -> Parser Scientific
@@ -219,13 +214,20 @@ parseScientificText
219214 . T.encodeUtf8
220215
221216parseIntegralText :: Integral a => String -> Text -> Parser a
222−parseIntegralText expected t =
223− parseScientificText t >>= parseIntegralFromScientific expected
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)
224225{-# INLINE parseIntegralText #-}
225226
226227parseBoundedIntegralText :: (Bounded a, Integral a) => String -> Text -> Parser a
227−parseBoundedIntegralText expected t =
228− parseScientificText t >>= parseBoundedIntegralFromScientific expected
228+parseBoundedIntegralText name t =
229+ prependContext name $
230+ parseScientificText t >>= parseBoundedIntegralFromScientific
229231
230232parseOptionalFieldWith :: (Value -> Parser (Maybe a))
231233 -> Object -> Text -> Parser (Maybe a)
@@ -285,14 +287,21 @@ genericLiftParseJSON opts pj pjl = fmap to1 . gParseJSON opts (From1Args pj pjl)
285287--
286288-- The basic ways to signal a failed conversion are as follows:
287289--
288−-- * 'empty' and 'mzero' work, but are terse and uninformative;
290+-- * 'fail' yields a custom error message: it is the recommended way of
291+-- reporting a failure;
292+--
293+-- * 'Control.Applicative.empty' (or 'Control.Monad.mzero') is uninformative:
294+-- use it when the error is meant to be caught by some @('<|>')@;
289295--
290−-- * 'fail' yields a custom error message;
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.
291300--
292−-- * 'typeMismatch' produces an informative message for cases when the
293−-- value encountered is not of the expected type.
301+-- 'prependFailure' (or 'modifyFailure') add more information to a parser's
302+-- error messages.
294303--
295−-- An example type and instance using 'typeMismatch':
304+-- An example type and instance using 'typeMismatch' and 'prependFailure':
296305--
297306-- @
298307-- \-- Allow ourselves to write 'Text' literals.
@@ -306,13 +315,15 @@ genericLiftParseJSON opts pj pjl = fmap to1 . gParseJSON opts (From1Args pj pjl)
306315-- '<*>' v '.:' \"y\"
307316--
308317-- \-- We do not expect a non-'Object' value here.
309−-- \-- We could use 'mzero' to fail, but 'typeMismatch'
318+-- \-- We could use 'Control.Applicative.empty' to fail, but 'typeMismatch'
310319-- \-- gives a much more informative error message.
311−-- 'parseJSON' invalid = 'typeMismatch' \"Coord\" invalid
320+-- 'parseJSON' invalid =
321+-- 'prependFailure' "parsing Coord failed, "
322+-- ('typeMismatch' \"Object\" invalid)
312323-- @
313324--
314325-- For this common case of only being concerned with a single
315−-- type of JSON value, the functions 'withObject', 'withNumber', etc.
326+-- type of JSON value, the functions 'withObject', 'withScientific', etc.
316327-- are provided. Their use is to be preferred when possible, since
317328-- they are more terse. Using 'withObject', we can rewrite the above instance
318329-- (assuming the same language extension and data type) as:
@@ -351,7 +362,7 @@ genericLiftParseJSON opts pj pjl = fmap to1 . gParseJSON opts (From1Args pj pjl)
351362-- @
352363--
353364-- The default implementation will be equivalent to
354−-- @parseJSON = 'genericParseJSON' 'defaultOptions'@; If you need different
365+-- @parseJSON = 'genericParseJSON' 'defaultOptions'@; if you need different
355366-- options, you can customize the generic decoding by defining:
356367--
357368-- @
@@ -369,13 +380,11 @@ class FromJSON a where
369380 parseJSON = genericParseJSON defaultOptions
370381
371382 parseJSONList :: Value -> Parser [a]
372− parseJSONList (Array a)
373− = zipWithM (parseIndexedJSON parseJSON) [0..]
383+ parseJSONList = withArray "[]" $ \a ->
384+ zipWithM (parseIndexedJSON parseJSON) [0..]
374385 . V.toList
375386 $ a
376387
377− parseJSONList v = typeMismatch "[a]" v
378−
379388-------------------------------------------------------------------------------
380389-- Classes and types for map keys
381390-------------------------------------------------------------------------------
@@ -387,6 +396,16 @@ class FromJSON a where
387396-- > newtype SomeId = SomeId { getSomeId :: Text }
388397-- > deriving (Eq,Ord,Hashable,FromJSONKey)
389398--
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+-- @
390409class FromJSONKey a where
391410 -- | Strategy for parsing the key of a map-like container.
392411 fromJSONKey :: FromJSONKeyFunction a
@@ -409,11 +428,7 @@ class FromJSONKey a where
409428-- At the moment this type is intentionally not exported. 'FromJSONKeyFunction'
410429-- can be inspected, but cannot be constructed.
411430data CoerceText a where
412−#if HAS_COERCIBLE
413431 CoerceText :: Coercible Text a => CoerceText a
414−#else
415− CoerceText :: CoerceText a
416−#endif
417432
418433-- | This type is related to 'ToJSONKeyFunction'. If 'FromJSONKeyValue' is used in the
419434-- 'FromJSONKey' instance, then 'ToJSONKeyValue' should be used in the 'ToJSONKey'
@@ -433,7 +448,7 @@ data FromJSONKeyFunction a
433448
434449-- | Only law abiding up to interpretation
435450instance Functor FromJSONKeyFunction where
436− fmap h (FromJSONKeyCoerce CoerceText) = FromJSONKeyText (h . coerce')
451+ fmap h (FromJSONKeyCoerce CoerceText) = FromJSONKeyText (h . coerce)
437452 fmap h (FromJSONKeyText f) = FromJSONKeyText (h . f)
438453 fmap h (FromJSONKeyTextParser f) = FromJSONKeyTextParser (fmap h . f)
439454 fmap h (FromJSONKeyValue f) = FromJSONKeyValue (fmap h . f)
@@ -447,9 +462,7 @@ instance Functor FromJSONKeyFunction where
447462--
448463-- On pre GHC 7.8 this is unconstrainted function.
449464fromJSONKeyCoerce ::
450−#if HAS_COERCIBLE
451465 Coercible Text a =>
452−#endif
453466 FromJSONKeyFunction a
454467fromJSONKeyCoerce = FromJSONKeyCoerce CoerceText
455468
@@ -457,60 +470,91 @@ fromJSONKeyCoerce = FromJSONKeyCoerce CoerceText
457470--
458471-- See note on 'fromJSONKeyCoerce'.
459472coerceFromJSONKeyFunction ::
460−#if HAS_COERCIBLE
461473 Coercible a b =>
462−#endif
463474 FromJSONKeyFunction a -> FromJSONKeyFunction b
464−#if HAS_COERCIBLE
465475coerceFromJSONKeyFunction = coerce
466−#else
467−coerceFromJSONKeyFunction (FromJSONKeyCoerce CoerceText) = FromJSONKeyCoerce CoerceText
468−coerceFromJSONKeyFunction (FromJSONKeyText f) = FromJSONKeyText (coerce' . f)
469−coerceFromJSONKeyFunction (FromJSONKeyTextParser f) = FromJSONKeyTextParser (fmap coerce' . f)
470−coerceFromJSONKeyFunction (FromJSONKeyValue f) = FromJSONKeyValue (fmap coerce' . f)
471−#endif
472476
473477{-# RULES
474478 "FromJSONKeyCoerce: fmap id" forall (x :: FromJSONKeyFunction a).
475479 fmap id x = x
476480 #-}
477−#if HAS_COERCIBLE
478481{-# RULES
479482 "FromJSONKeyCoerce: fmap coerce" forall x .
480483 fmap coerce x = coerceFromJSONKeyFunction x
481484 #-}
482−#endif
483485
484486-- | Same as 'fmap'. Provided for the consistency with 'ToJSONKeyFunction'.
485487mapFromJSONKeyFunction :: (a -> b) -> FromJSONKeyFunction a -> FromJSONKeyFunction b
486488mapFromJSONKeyFunction = fmap
487489
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+
488519-------------------------------------------------------------------------------
489520-- Functions needed for documentation
490521-------------------------------------------------------------------------------
491522
492523-- | Fail parsing due to a type mismatch, with a descriptive message.
493524--
494−-- Example usage:
525+-- The following wrappers should generally be prefered:
526+-- 'withObject', 'withArray', 'withText', 'withBool'.
495527--
496−-- @
497−-- instance FromJSON Coord where
498−-- parseJSON ('Object' v) = {- type matches, life is good -}
499−-- parseJSON wat = 'typeMismatch' \"Coord\" wat
500−-- @
501−typeMismatch :: String -- ^ The name of the type you are trying to parse.
528+-- ==== Error message example
529+--
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\"@).
502535 -> Value -- ^ The actual value encountered.
503536 -> Parser a
504537typeMismatch expected actual =
505− fail $ "expected " ++ expected ++ ", encountered " ++ name
506− where
507− name = case actual of
508− Object _ -> "Object"
509− Array _ -> "Array"
510− String _ -> "String"
511− Number _ -> "Number"
512− Bool _ -> "Boolean"
513− Null -> "Null"
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"
514558
515559-------------------------------------------------------------------------------
516560-- Lifings of FromJSON and ToJSON to unary and binary type constructors
@@ -591,9 +635,8 @@ class FromJSON2 f where
591635 -> (Value -> Parser b)
592636 -> (Value -> Parser [b])
593637 -> Value -> Parser [f a b]
594− liftParseJSONList2 fa ga fb gb v = case v of
595− Array vals -> fmap V.toList (V.mapM (liftParseJSON2 fa ga fb gb) vals)
596− _ -> typeMismatch "[a]" v
638+ liftParseJSONList2 fa ga fb gb = withArray "[]" $ \vals ->
639+ fmap V.toList (V.mapM (liftParseJSON2 fa ga fb gb) vals)
597640
598641-- | Lift the standard 'parseJSON' function through the type constructor.
599642parseJSON2 :: (FromJSON2 f, FromJSON a, FromJSON b) => Value -> Parser (f a b)
@@ -607,7 +650,7 @@ parseJSON2 = liftParseJSON2 parseJSON parseJSONList parseJSON parseJSONList
607650-- | Helper function to use with 'liftParseJSON'. See 'Data.Aeson.ToJSON.listEncoding'.
608651listParser :: (Value -> Parser a) -> Value -> Parser [a]
609652listParser f (Array xs) = fmap V.toList (V.mapM f xs)
610−listParser _ v = typeMismatch "[a]" v
653+listParser _ v = typeMismatch "Array" v
611654{-# INLINE listParser #-}
612655
613656-------------------------------------------------------------------------------
@@ -625,57 +668,137 @@ instance (FromJSON a) => FromJSON [a] where
625668-- Functions
626669-------------------------------------------------------------------------------
627670
628−-- | @'withObject' expected f value@ applies @f@ to the 'Object' when @value@
629−-- is an 'Object' and fails using @'typeMismatch' expected@ otherwise.
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"
630686withObject :: String -> (Object -> Parser a) -> Value -> Parser a
631−withObject _ f (Object obj) = f obj
632−withObject expected _ v = typeMismatch expected v
687+withObject _ f (Object obj) = f obj
688+withObject name _ v = prependContext name (typeMismatch "Object" v)
633689{-# INLINE withObject #-}
634690
635−-- | @'withText' expected f value@ applies @f@ to the 'Text' when @value@ is a
636−-- 'String' and fails using @'typeMismatch' expected@ otherwise.
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"
637698withText :: String -> (Text -> Parser a) -> Value -> Parser a
638−withText _ f (String txt) = f txt
639−withText expected _ v = typeMismatch expected v
699+withText _ f (String txt) = f txt
700+withText name _ v = prependContext name (typeMismatch "String" v)
640701{-# INLINE withText #-}
641702
642703-- | @'withArray' expected f value@ applies @f@ to the 'Array' when @value@ is
643−-- an 'Array' and fails using @'typeMismatch' expected@ otherwise.
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"
644710withArray :: String -> (Array -> Parser a) -> Value -> Parser a
645−withArray _ f (Array arr) = f arr
646−withArray expected _ v = typeMismatch expected v
711+withArray _ f (Array arr) = f arr
712+withArray name _ v = prependContext name (typeMismatch "Array" v)
647713{-# INLINE withArray #-}
648714
649−-- | @'withNumber' expected f value@ applies @f@ to the 'Number' when @value@
650−-- is a 'Number' and fails using @'typeMismatch' expected@ otherwise.
651−withNumber :: String -> (Number -> Parser a) -> Value -> Parser a
652−withNumber expected f = withScientific expected (f . scientificToNumber)
653−{-# INLINE withNumber #-}
654−{-# DEPRECATED withNumber "Use withScientific instead" #-}
655−
656−-- | @'withScientific' expected f value@ applies @f@ to the 'Scientific' number
657−-- when @value@ is a 'Number' and fails using @'typeMismatch' expected@
715+-- | @'withScientific' name f value@ applies @f@ to the 'Scientific' number
716+-- when @value@ is a 'Data.Aeson.Number' and fails using 'typeMismatch'
658717-- 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"
659728withScientific :: String -> (Scientific -> Parser a) -> Value -> Parser a
660−withScientific _ f (Number scientific) = f scientific
661−withScientific expected _ v = typeMismatch expected v
729+withScientific _ f (Number scientific) = f scientific
730+withScientific name _ v = prependContext name (typeMismatch "Number" v)
662731{-# INLINE withScientific #-}
663732
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+
664782-- | @'withBool' expected f value@ applies @f@ to the 'Bool' when @value@ is a
665−-- 'Bool' and fails using @'typeMismatch' expected@ otherwise.
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"
666789withBool :: String -> (Bool -> Parser a) -> Value -> Parser a
667−withBool _ f (Bool arr) = f arr
668−withBool expected _ v = typeMismatch expected v
790+withBool _ f (Bool arr) = f arr
791+withBool name _ v = prependContext name (typeMismatch "Boolean" v)
669792{-# INLINE withBool #-}
670793
671794-- | Decode a nested JSON-encoded string.
672795withEmbeddedJSON :: String -> (Value -> Parser a) -> Value -> Parser a
673796withEmbeddedJSON _ innerParser (String txt) =
674− either fail innerParser $ eitherDecode (Compat.fromStrict $ T.encodeUtf8 txt)
797+ either fail innerParser $ eitherDecode (L.fromStrict $ T.encodeUtf8 txt)
675798 where
676799 eitherDecode = eitherFormatError . eitherDecodeWith jsonEOF ifromJSON
677800 eitherFormatError = either (Left . uncurry formatError) Right
678−withEmbeddedJSON name _ v = typeMismatch name v
801+withEmbeddedJSON name _ v = prependContext name (typeMismatch "String" v)
679802{-# INLINE withEmbeddedJSON #-}
680803
681804-- | Convert a value from JSON, failing if the types do not match.
@@ -740,7 +863,7 @@ parseFieldMaybe' = (.:!)
740863-- E.g. @'explicitParseField' 'parseJSON1' :: ('FromJSON1' f, 'FromJSON' a) -> 'Object' -> 'Text' -> 'Parser' (f a)@
741864explicitParseField :: (Value -> Parser a) -> Object -> Text -> Parser a
742865explicitParseField p obj key = case H.lookup key obj of
743− Nothing -> fail $ "key " ++ show key ++ " not present"
866+ Nothing -> fail $ "key " ++ show key ++ " not found"
744867 Just v -> p v <?> Key key
745868{-# INLINE explicitParseField #-}
746869
@@ -780,11 +903,47 @@ pmval .!= val = fromMaybe val <$> pmval
780903-- Generic parseJSON
781904-------------------------------------------------------------------------------
782905
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+
783911instance OVERLAPPABLE_ (GFromJSON arity a) => GFromJSON arity (M1 i c a) where
784912 -- Meta-information, which is not handled elsewhere, is just added to the
785913 -- parsed value:
786914 gParseJSON opts fargs = fmap M1 . gParseJSON opts fargs
787915
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+
788947instance (FromJSON a) => GFromJSON arity (K1 i a) where
789948 -- Constant values are decoded using their FromJSON instance:
790949 gParseJSON _opts _ = fmap K1 . parseJSON
@@ -799,342 +958,499 @@ instance (FromJSON1 f) => GFromJSON One (Rec1 f) where
799958 -- FromJSON1 instance:
800959 gParseJSON _opts (From1Args pj pjl) = fmap Rec1 . liftParseJSON pj pjl
801960
802−instance GFromJSON arity U1 where
803− -- Empty constructors are expected to be encoded as an empty array:
804− gParseJSON _opts _ v
805− | isEmptyArray v = pure U1
806− | otherwise = typeMismatch "unit constructor (U1)" v
961+instance (FromJSON1 f, GFromJSON One g) => GFromJSON One (f :.: g) where
962+ -- If an occurrence of the last type parameter is nested inside two
963+ -- composed types, it is decoded by using the outermost type's FromJSON1
964+ -- instance to generically decode the innermost type:
965+ 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)
807985
986+-- | Single constructor.
808987instance ( ConsFromJSON arity a
809988 , AllNullary (C1 c a) allNullary
810989 , ParseSum arity (C1 c a) allNullary
811− ) => GFromJSON arity (D1 d (C1 c a)) where
990+ , Constructor c
991+ ) => GFromJSON' arity (C1 c a) where
812992 -- The option 'tagSingleConstructors' determines whether to wrap
813993 -- a single-constructor type.
814− gParseJSON opts fargs
994+ gParseJSON' p@(_ :* opts :* _)
815995 | tagSingleConstructors opts
816− = fmap M1
817− . (unTagged :: Tagged allNullary (Parser (C1 c a p)) -> Parser (C1 c a p))
818− . parseSum opts fargs
819− | otherwise = fmap M1 . fmap M1 . consParseJSON opts fargs
820−
821−instance (ConsFromJSON arity a) => GFromJSON arity (C1 c a) where
822− -- Constructors need to be decoded differently depending on whether they're
823− -- a record or not. This distinction is made by consParseJSON:
824− gParseJSON opts fargs = fmap M1 . consParseJSON opts fargs
825−
826−instance ( FromProduct arity a, FromProduct arity b
827− , ProductSize a, ProductSize b
828− ) => GFromJSON arity (a :*: b) where
829− -- Products are expected to be encoded to an array. Here we check whether we
830− -- got an array of the same size as the product, then parse each of the
831− -- product's elements using parseProduct:
832− gParseJSON opts fargs = withArray "product (:*:)" $ \arr ->
833− let lenArray = V.length arr
834− lenProduct = (unTagged2 :: Tagged2 (a :*: b) Int -> Int)
835− productSize in
836− if lenArray == lenProduct
837− then parseProduct opts fargs arr 0 lenProduct
838− else fail $ "When expecting a product of " ++ show lenProduct ++
839− " values, encountered an Array of " ++ show lenArray ++
840− " elements instead"
841−
842−instance ( AllNullary (a :+: b) allNullary
843− , ParseSum arity (a :+: b) allNullary
844− ) => GFromJSON arity (a :+: b) where
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
8451006 -- If all constructors of a sum datatype are nullary and the
8461007 -- 'allNullaryToStringTag' option is set they are expected to be
8471008 -- encoded as strings. This distinction is made by 'parseSum':
848− gParseJSON opts fargs =
849− (unTagged :: Tagged allNullary (Parser ((a :+: b) d)) ->
850− Parser ((a :+: b) d))
851− . parseSum opts fargs
852−
853−instance (FromJSON1 f, GFromJSON One g) => GFromJSON One (f :.: g) where
854− -- If an occurrence of the last type parameter is nested inside two
855− -- composed types, it is decoded by using the outermost type's FromJSON1
856− -- instance to generically decode the innermost type:
857− gParseJSON opts fargs =
858− let gpj = gParseJSON opts fargs in
859− fmap Comp1 . liftParseJSON gpj (listParser gpj)
1009+ gParseJSON' p =
1010+ (unTagged :: Tagged allNullary (Parser ((a :+: b) _d)) ->
1011+ Parser ((a :+: b) _d))
1012+ . parseSum p
8601013
8611014--------------------------------------------------------------------------------
8621015
8631016class ParseSum arity f allNullary where
864− parseSum :: Options -> FromArgs arity a
865− -> Value -> Tagged allNullary (Parser (f a))
1017+ parseSum :: TypeName :* Options :* FromArgs arity a
1018+ -> Value
1019+ -> Tagged allNullary (Parser (f a))
8661020
867−instance ( SumFromString f
1021+instance ( ConstructorNames f
1022+ , SumFromString f
8681023 , FromPair arity f
8691024 , FromTaggedObject arity f
8701025 , FromUntaggedValue arity f
8711026 ) => ParseSum arity f True where
872− parseSum opts fargs
873− | allNullaryToStringTag opts = Tagged . parseAllNullarySum opts
874− | otherwise = Tagged . parseNonAllNullarySum opts fargs
1027+ parseSum p@(tname :* opts :* _)
1028+ | allNullaryToStringTag opts = Tagged . parseAllNullarySum tname opts
1029+ | otherwise = Tagged . parseNonAllNullarySum p
8751030
876−instance ( FromPair arity f
1031+instance ( ConstructorNames f
1032+ , FromPair arity f
8771033 , FromTaggedObject arity f
8781034 , FromUntaggedValue arity f
8791035 ) => ParseSum arity f False where
880− parseSum opts fargs = Tagged . parseNonAllNullarySum opts fargs
1036+ parseSum p = Tagged . parseNonAllNullarySum p
8811037
8821038--------------------------------------------------------------------------------
8831039
884−parseAllNullarySum :: SumFromString f => Options -> Value -> Parser (f a)
885−parseAllNullarySum opts = withText "Text" $ \key ->
886− maybe (notFound key) return $
887− parseSumFromString opts key
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])
8881062
8891063class SumFromString f where
890− parseSumFromString :: Options -> Text -> Maybe (f a)
1064+ parseSumFromString :: (String -> String) -> Text -> Maybe (f a)
8911065
8921066instance (SumFromString a, SumFromString b) => SumFromString (a :+: b) where
8931067 parseSumFromString opts key = (L1 <$> parseSumFromString opts key) <|>
8941068 (R1 <$> parseSumFromString opts key)
8951069
8961070instance (Constructor c) => SumFromString (C1 c U1) where
897− parseSumFromString opts key | key == name = Just $ M1 U1
898− | otherwise = Nothing
899− where
900− name = pack $ constructorTagModifier opts $
901− conName (undefined :: t c U1 p)
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)
9021076
903−--------------------------------------------------------------------------------
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
9041111
905−parseNonAllNullarySum :: ( FromPair arity f
1112+--------------------------------------------------------------------------------
1113+parseNonAllNullarySum :: forall f c arity.
1114+ ( FromPair arity f
9061115 , FromTaggedObject arity f
9071116 , FromUntaggedValue arity f
908− ) => Options -> FromArgs arity c
1117+ , ConstructorNames f
1118+ ) => TypeName :* Options :* FromArgs arity c
9091119 -> Value -> Parser (f c)
910−parseNonAllNullarySum opts fargs =
1120+parseNonAllNullarySum p@(tname :* opts :* _) =
9111121 case sumEncoding opts of
9121122 TaggedObject{..} ->
913− withObject "Object" $ \obj -> do
914− tag <- obj .: pack tagFieldName
915− fromMaybe (notFound tag) $
916− parseFromTaggedObject opts fargs contentsFieldName obj tag
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])
9171133
9181134 ObjectWithSingleField ->
919− withObject "Object" $ \obj ->
920− case H.toList obj of
921− [pair@(tag, _)] -> fromMaybe (notFound tag) $
922− parsePair opts fargs pair
923− _ -> fail "Object doesn't have a single field"
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
9241145
9251146 TwoElemArray ->
926− withArray "Array" $ \arr ->
927− if V.length arr == 2
928− then case V.unsafeIndex arr 0 of
929− String tag -> fromMaybe (notFound tag) $
930− parsePair opts fargs (tag, V.unsafeIndex arr 1)
931− _ -> fail "First element is not a String"
932− else fail "Array doesn't have 2 elements"
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
9331161
934− UntaggedValue -> parseUntaggedValue opts fargs
1162+ UntaggedValue -> parseUntaggedValue p
1163+ where
1164+ failWith_ = failWithCTags tname (constructorTagModifier opts)
9351165
9361166--------------------------------------------------------------------------------
9371167
9381168class FromTaggedObject arity f where
939− parseFromTaggedObject :: Options -> FromArgs arity a
940− -> String -> Object
941− -> Text -> Maybe (Parser (f a))
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))
9421175
9431176instance ( FromTaggedObject arity a, FromTaggedObject arity b) =>
9441177 FromTaggedObject arity (a :+: b) where
945− parseFromTaggedObject opts fargs contentsFieldName obj tag =
946− (fmap L1 <$> parseFromTaggedObject opts fargs contentsFieldName obj tag) <|>
947− (fmap R1 <$> parseFromTaggedObject opts fargs contentsFieldName obj tag)
1178+ parseFromTaggedObject p obj =
1179+ (fmap L1 <$> parseFromTaggedObject p obj) <|>
1180+ (fmap R1 <$> parseFromTaggedObject p obj)
9481181
949−instance ( FromTaggedObject' arity f
1182+instance ( IsRecord f isRecord
1183+ , FromTaggedObject' arity f isRecord
9501184 , Constructor c
9511185 ) => FromTaggedObject arity (C1 c f) where
952− parseFromTaggedObject opts fargs contentsFieldName obj tag
953− | tag == name = Just $ M1 <$> parseFromTaggedObject'
954− opts fargs contentsFieldName obj
955− | otherwise = Nothing
956− where
957− name = pack $ constructorTagModifier opts $
958− conName (undefined :: t c f p)
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)
9591195
9601196--------------------------------------------------------------------------------
9611197
962−class FromTaggedObject' arity f where
963− parseFromTaggedObject' :: Options -> FromArgs arity a -> String
964− -> Object -> Parser (f a)
965−
966−class FromTaggedObject'' arity f isRecord where
967− parseFromTaggedObject'' :: Options -> FromArgs arity a -> String
968− -> Object -> Tagged isRecord (Parser (f a))
969−
970−instance ( IsRecord f isRecord
971− , FromTaggedObject'' arity f isRecord
972− ) => FromTaggedObject' arity f where
973− parseFromTaggedObject' opts fargs contentsFieldName =
974− (unTagged :: Tagged isRecord (Parser (f a)) -> Parser (f a)) .
975− parseFromTaggedObject'' opts fargs contentsFieldName
976−
977−instance (FromRecord arity f) => FromTaggedObject'' arity f True where
978− parseFromTaggedObject'' opts fargs _ =
979− Tagged . parseRecord opts fargs
980−
981−instance (GFromJSON arity f) => FromTaggedObject'' arity f False where
982− parseFromTaggedObject'' opts fargs contentsFieldName = Tagged .
983− (gParseJSON opts fargs <=< (.: pack contentsFieldName))
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
9841216
985−instance OVERLAPPING_ FromTaggedObject'' arity U1 False where
986− parseFromTaggedObject'' _ _ _ _ = Tagged (pure U1)
1217+instance OVERLAPPING_ FromTaggedObject' arity U1 False where
1218+ -- Nullary constructors don't need a contents field
1219+ parseFromTaggedObject' _ _ = Tagged (pure U1)
9871220
9881221--------------------------------------------------------------------------------
9891222
1223+-- | Constructors need to be decoded differently depending on whether they're
1224+-- a record or not. This distinction is made by 'ConsParseJSON'.
9901225class ConsFromJSON arity f where
991− consParseJSON :: Options -> FromArgs arity a
992− -> Value -> Parser (f a)
1226+ consParseJSON
1227+ :: ConName :* TypeName :* Options :* FromArgs arity a
1228+ -> Value -> Parser (f a)
9931229
9941230class ConsFromJSON' arity f isRecord where
995− consParseJSON' :: Options -> FromArgs arity a
996− -> Value -> Tagged isRecord (Parser (f a))
1231+ consParseJSON'
1232+ :: ConName :* TypeName :* Options :* FromArgs arity a
1233+ -> Value -> Tagged isRecord (Parser (f a))
9971234
9981235instance ( IsRecord f isRecord
9991236 , ConsFromJSON' arity f isRecord
10001237 ) => ConsFromJSON arity f where
1001− consParseJSON opts fargs =
1238+ consParseJSON p =
10021239 (unTagged :: Tagged isRecord (Parser (f a)) -> Parser (f a))
1003− . consParseJSON' opts fargs
1240+ . consParseJSON' p
10041241
10051242instance OVERLAPPING_
1006− ( GFromJSON arity a, FromRecord arity (S1 s a)
1243+ ( GFromJSON arity a, RecordFromJSON arity (S1 s a)
10071244 ) => ConsFromJSON' arity (S1 s a) True where
1008− consParseJSON' opts fargs
1009− | unwrapUnaryRecords opts = Tagged . gParseJSON opts fargs
1010− | otherwise = Tagged . withObject "unary record" (parseRecord opts fargs)
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))
10111252
1012−instance FromRecord arity f => ConsFromJSON' arity f True where
1013− consParseJSON' opts fargs =
1014− Tagged . withObject "record (:*:)" (parseRecord opts fargs)
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)
1265+
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
10151270
1016−instance GFromJSON arity f => ConsFromJSON' arity f False where
1017− consParseJSON' opts fargs = Tagged . gParseJSON opts fargs
1271+instance (ProductFromJSON arity f, ProductSize f
1272+ ) => ConsFromJSON' arity f False where
1273+ consParseJSON' p = Tagged . productParseJSON0 p
10181274
10191275--------------------------------------------------------------------------------
10201276
1021−class FromRecord arity f where
1022− parseRecord :: Options -> FromArgs arity a
1023− -> Object -> Parser (f a)
1277+class FieldNames f where
1278+ fieldNames :: f a -> [Text] -> [Text]
10241279
1025−instance ( FromRecord arity a
1026− , FromRecord arity b
1027− ) => FromRecord arity (a :*: b) where
1028− parseRecord opts fargs obj =
1029− (:*:) <$> parseRecord opts fargs obj
1030− <*> parseRecord opts fargs obj
1280+instance (FieldNames a, FieldNames b) => FieldNames (a :*: b) where
1281+ fieldNames _ =
1282+ fieldNames (undefined :: a x) .
1283+ fieldNames (undefined :: b y)
10311284
1032−instance OVERLAPPABLE_ (Selector s, GFromJSON arity a) =>
1033− FromRecord arity (S1 s a) where
1034− parseRecord opts fargs =
1035− (<?> Key label) . gParseJSON opts fargs <=< (.: label)
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)
1292+
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
10361298 where
1037− label = pack . fieldLabelModifier opts $ selName (undefined :: t s a p)
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)
10381331
10391332instance INCOHERENT_ (Selector s, FromJSON a) =>
1040− FromRecord arity (S1 s (K1 i (Maybe a))) where
1041− parseRecord opts _ obj = M1 . K1 <$> obj .:? pack label
1042− where
1043− label = fieldLabelModifier opts $
1044− selName (undefined :: t s (K1 i (Maybe a)) p)
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)
10451338
10461339-- Parse an Option like a Maybe.
10471340instance INCOHERENT_ (Selector s, FromJSON a) =>
1048− FromRecord arity (S1 s (K1 i (Semigroup.Option a))) where
1049− parseRecord opts fargs obj = wrap <$> parseRecord opts fargs obj
1341+ RecordFromJSON' arity (S1 s (K1 i (Semigroup.Option a))) where
1342+ recordParseJSON' p obj = wrap <$> recordParseJSON' p obj
10501343 where
10511344 wrap :: S1 s (K1 i (Maybe a)) p -> S1 s (K1 i (Semigroup.Option a)) p
10521345 wrap (M1 (K1 a)) = M1 (K1 (Semigroup.Option a))
10531346
10541347--------------------------------------------------------------------------------
10551348
1056−class FromProduct arity f where
1057− parseProduct :: Options -> FromArgs arity a
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
10581371 -> Array -> Int -> Int
10591372 -> Parser (f a)
10601373
1061−instance ( FromProduct arity a
1062− , FromProduct arity b
1063− ) => FromProduct arity (a :*: b) where
1064− parseProduct opts fargs arr ix len =
1065− (:*:) <$> parseProduct opts fargs arr ix lenL
1066− <*> parseProduct opts fargs arr ixR lenR
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
10671380 where
10681381 lenL = len `unsafeShiftR` 1
10691382 ixR = ix + lenL
10701383 lenR = len - lenL
10711384
1072−instance (GFromJSON arity a) => FromProduct arity (S1 s a) where
1073− parseProduct opts fargs arr ix _ =
1074− gParseJSON opts fargs $ V.unsafeIndex arr ix
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
10751388
10761389--------------------------------------------------------------------------------
10771390
10781391class FromPair arity f where
1079− parsePair :: Options -> FromArgs arity a
1080− -> Pair -> Maybe (Parser (f a))
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))
10811396
10821397instance ( FromPair arity a
10831398 , FromPair arity b
10841399 ) => FromPair arity (a :+: b) where
1085− parsePair opts fargs pair = (fmap L1 <$> parsePair opts fargs pair) <|>
1086− (fmap R1 <$> parsePair opts fargs pair)
1400+ parsePair p pair =
1401+ (fmap L1 <$> parsePair p pair) <|>
1402+ (fmap R1 <$> parsePair p pair)
10871403
10881404instance ( Constructor c
1089− , GFromJSON arity a
10901405 , ConsFromJSON arity a
10911406 ) => FromPair arity (C1 c a) where
1092− parsePair opts fargs (tag, value)
1093− | tag == tag' = Just $ gParseJSON opts fargs value
1407+ parsePair (tag :* p@(_ :* opts :* _)) v
1408+ | tag == tag' = Just $ M1 <$> consParseJSON (cname :* p) v
10941409 | otherwise = Nothing
1095− where
1096− tag' = pack $ constructorTagModifier opts $
1097− conName (undefined :: t c a p)
1410+ where
1411+ tag' = pack $ constructorTagModifier opts cname
1412+ cname = conName (undefined :: M1 _i c _a _p)
10981413
10991414--------------------------------------------------------------------------------
11001415
11011416class FromUntaggedValue arity f where
1102− parseUntaggedValue :: Options -> FromArgs arity a
1103− -> Value -> Parser (f a)
1417+ parseUntaggedValue :: TypeName :* Options :* FromArgs arity a
1418+ -> Value
1419+ -> Parser (f a)
11041420
11051421instance
11061422 ( FromUntaggedValue arity a
11071423 , FromUntaggedValue arity b
11081424 ) => FromUntaggedValue arity (a :+: b)
11091425 where
1110− parseUntaggedValue opts fargs value =
1111− L1 <$> parseUntaggedValue opts fargs value <|>
1112− R1 <$> parseUntaggedValue opts fargs value
1426+ parseUntaggedValue p value =
1427+ L1 <$> parseUntaggedValue p value <|>
1428+ R1 <$> parseUntaggedValue p value
11131429
11141430instance OVERLAPPABLE_
1115− ( GFromJSON arity a
1116− , ConsFromJSON arity a
1431+ ( ConsFromJSON arity a
1432+ , Constructor c
11171433 ) => FromUntaggedValue arity (C1 c a)
11181434 where
1119− parseUntaggedValue = gParseJSON
1435+ parseUntaggedValue p = fmap M1 . consParseJSON (cname :* p)
1436+ where
1437+ cname = conName (undefined :: M1 _i c _f _p)
11201438
11211439instance OVERLAPPING_
11221440 ( Constructor c )
11231441 => FromUntaggedValue arity (C1 c U1)
11241442 where
1125− parseUntaggedValue opts _ (String s)
1126− | s == pack (constructorTagModifier opts (conName (undefined :: t c U1 p))) =
1127− pure $ M1 U1
1128− | otherwise =
1129− fail $ "Invalid tag: " ++ unpack s
1130− parseUntaggedValue _ _ v = typeMismatch (conName (undefined :: t c U1 p)) v
1131−
1132−
1133−--------------------------------------------------------------------------------
1134−
1135−notFound :: Text -> Parser a
1136−notFound key = fail $ "The key \"" ++ unpack key ++ "\" was not found"
1137−{-# INLINE notFound #-}
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
11381454
11391455-------------------------------------------------------------------------------
11401456-- Instances
@@ -1192,17 +1508,20 @@ instance (FromJSON a, FromJSON b) => FromJSON (Either a b) where
11921508 parseJSON = parseJSON2
11931509 {-# INLINE parseJSON #-}
11941510
1195−
1511+instance FromJSON Void where
1512+ parseJSON _ = fail "Cannot parse Void"
1513+ {-# INLINE parseJSON #-}
11961514
11971515instance FromJSON Bool where
1198− parseJSON = withBool "Bool" pure
1516+ parseJSON (Bool b) = pure b
1517+ parseJSON v = typeMismatch "Bool" v
11991518 {-# INLINE parseJSON #-}
12001519
12011520instance FromJSONKey Bool where
12021521 fromJSONKey = FromJSONKeyTextParser $ \t -> case t of
12031522 "true" -> pure True
12041523 "false" -> pure False
1205− _ -> fail $ "Cannot parse key into Bool: " ++ T.unpack t
1524+ _ -> fail $ "cannot parse key " ++ show t ++ " into Bool"
12061525
12071526instance FromJSON Ordering where
12081527 parseJSON = withText "Ordering" $ \s ->
@@ -1210,25 +1529,30 @@ instance FromJSON Ordering where
12101529 "LT" -> return LT
12111530 "EQ" -> return EQ
12121531 "GT" -> return GT
1213− _ -> fail "Parsing Ordering value failed: expected \"LT\", \"EQ\", or \"GT\""
1532+ _ -> fail $ "parsing Ordering failed, unexpected " ++ show s ++
1533+ " (expected \"LT\", \"EQ\", or \"GT\")"
12141534
12151535instance FromJSON () where
12161536 parseJSON = withArray "()" $ \v ->
12171537 if V.null v
12181538 then pure ()
1219− else fail "Expected an empty array"
1539+ else prependContext "()" $ fail "expected an empty array"
12201540 {-# INLINE parseJSON #-}
12211541
12221542instance FromJSON Char where
1223− parseJSON = withText "Char" $ \t ->
1224− if T.compareLength t 1 == EQ
1225− then pure $ T.head t
1226− else fail "Expected a string of length 1"
1543+ parseJSON = withText "Char" parseChar
12271544 {-# INLINE parseJSON #-}
12281545
1229− parseJSONList = withText "String" $ pure . T.unpack
1546+ parseJSONList (String s) = pure (T.unpack s)
1547+ parseJSONList v = typeMismatch "String" v
12301548 {-# INLINE parseJSONList #-}
12311549
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+
12321556instance FromJSON Double where
12331557 parseJSON = parseRealFloat "Double"
12341558 {-# INLINE parseJSON #-}
@@ -1240,12 +1564,6 @@ instance FromJSONKey Double where
12401564 "-Infinity" -> pure (negate 1/0)
12411565 _ -> Scientific.toRealFloat <$> parseScientificText t
12421566
1243−instance FromJSON Number where
1244− parseJSON (Number s) = pure $ scientificToNumber s
1245− parseJSON Null = pure (D (0/0))
1246− parseJSON v = typeMismatch "Number" v
1247− {-# INLINE parseJSON #-}
1248−
12491567instance FromJSON Float where
12501568 parseJSON = parseRealFloat "Float"
12511569 {-# INLINE parseJSON #-}
@@ -1258,17 +1576,30 @@ instance FromJSONKey Float where
12581576 _ -> Scientific.toRealFloat <$> parseScientificText t
12591577
12601578instance (FromJSON a, Integral a) => FromJSON (Ratio a) where
1261− parseJSON = withObject "Rational" $ \obj ->
1262− (%) <$> obj .: "numerator"
1263− <*> obj .: "denominator"
1264− {-# INLINE parseJSON #-}
1265−
1266−-- | /WARNING:/ Only parse fixed-precision numbers from trusted input
1267−-- since an attacker could easily fill up the memory of the target
1268−-- system by specifying a scientific number with a big exponent like
1269−-- @1e1000000000@.
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.
12701601instance HasResolution a => FromJSON (Fixed a) where
1271− parseJSON = withScientific "Fixed" $ pure . realToFrac
1602+ parseJSON = prependContext "Fixed" . withBoundedScientific' (pure . realToFrac)
12721603 {-# INLINE parseJSON #-}
12731604
12741605instance FromJSON Int where
@@ -1278,10 +1609,10 @@ instance FromJSON Int where
12781609instance FromJSONKey Int where
12791610 fromJSONKey = FromJSONKeyTextParser $ parseBoundedIntegralText "Int"
12801611
1281−-- | /WARNING:/ Only parse Integers from trusted input since an
1282−-- attacker could easily fill up the memory of the target system by
1283−-- specifying a scientific number with a big exponent like
1284−-- @1e1000000000@.
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.
12851616instance FromJSON Integer where
12861617 parseJSON = parseIntegral "Integer"
12871618 {-# INLINE parseJSON #-}
@@ -1291,19 +1622,20 @@ instance FromJSONKey Integer where
12911622
12921623instance FromJSON Natural where
12931624 parseJSON value = do
1294− integer :: Integer <- parseIntegral "Natural" value
1295− if integer < 0 then
1296− fail $ "expected Natural, encountered negative number " <> show integer
1297− else
1298− pure $ fromIntegral integer
1625+ integer <- parseIntegral "Natural" value
1626+ parseNatural integer
12991627
13001628instance FromJSONKey Natural where
13011629 fromJSONKey = FromJSONKeyTextParser $ \text -> do
1302− integer :: Integer <- parseIntegralText "Natural" text
1303− if integer < 0 then
1304− fail $ "expected Natural, encountered negative number " <> show integer
1305− else
1306− pure $ fromIntegral integer
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
13071639
13081640instance FromJSON Int8 where
13091641 parseJSON = parseBoundedIntegral "Int8"
@@ -1400,17 +1732,17 @@ parseVersionText = go . readP_to_S parseVersion . unpack
14001732 where
14011733 go [(v,[])] = return v
14021734 go (_ : xs) = go xs
1403− go _ = fail "could not parse Version"
1735+ go _ = fail "parsing Version failed"
14041736
14051737-------------------------------------------------------------------------------
14061738-- semigroups NonEmpty
14071739-------------------------------------------------------------------------------
14081740
14091741instance FromJSON1 NonEmpty where
1410− liftParseJSON p _ = withArray "NonEmpty a" $
1742+ liftParseJSON p _ = withArray "NonEmpty" $
14111743 (>>= ne) . Tr.sequence . zipWith (parseIndexedJSON p) [0..] . V.toList
14121744 where
1413− ne [] = fail "Expected a NonEmpty but got an empty list"
1745+ ne [] = fail "parsing NonEmpty failed, unexpected empty list"
14141746 ne (x:xs) = pure (x :| xs)
14151747 {-# INLINE liftParseJSON #-}
14161748
@@ -1431,7 +1763,7 @@ instance FromJSON Scientific where
14311763-------------------------------------------------------------------------------
14321764
14331765instance FromJSON1 DList.DList where
1434− liftParseJSON p _ = withArray "DList a" $
1766+ liftParseJSON p _ = withArray "DList" $
14351767 fmap DList.fromList .
14361768 Tr.sequence . zipWith (parseIndexedJSON p) [0..] . V.toList
14371769 {-# INLINE liftParseJSON #-}
@@ -1508,7 +1840,7 @@ instance (FromJSON1 f, FromJSON1 g) => FromJSON1 (Sum f g) where
15081840 inr = "InR"
15091841
15101842 liftParseJSON _ _ _ = fail $
1511− "expected an object with a single property " ++
1843+ "parsing Sum failed, expected an object with a single property " ++
15121844 "where the property key should be either " ++
15131845 "\"InL\" or \"InR\""
15141846 {-# INLINE liftParseJSON #-}
@@ -1522,7 +1854,7 @@ instance (FromJSON1 f, FromJSON1 g, FromJSON a) => FromJSON (Sum f g a) where
15221854-------------------------------------------------------------------------------
15231855
15241856instance FromJSON1 Seq.Seq where
1525− liftParseJSON p _ = withArray "Seq a" $
1857+ liftParseJSON p _ = withArray "Seq" $
15261858 fmap Seq.fromList .
15271859 Tr.sequence . zipWith (parseIndexedJSON p) [0..] . V.toList
15281860 {-# INLINE liftParseJSON #-}
@@ -1556,13 +1888,13 @@ instance FromJSON a => FromJSON (IntMap.IntMap a) where
15561888
15571889instance (FromJSONKey k, Ord k) => FromJSON1 (M.Map k) where
15581890 liftParseJSON p _ = case fromJSONKey of
1559− FromJSONKeyCoerce _-> withObject "Map k v" $
1891+ FromJSONKeyCoerce _ -> withObject "Map" $
15601892 fmap (H.foldrWithKey (M.insert . unsafeCoerce) M.empty) . H.traverseWithKey (\k v -> p v <?> Key k)
1561− FromJSONKeyText f -> withObject "Map k v" $
1893+ FromJSONKeyText f -> withObject "Map" $
15621894 fmap (H.foldrWithKey (M.insert . f) M.empty) . H.traverseWithKey (\k v -> p v <?> Key k)
1563− FromJSONKeyTextParser f -> withObject "Map k v" $
1895+ FromJSONKeyTextParser f -> withObject "Map" $
15641896 H.foldrWithKey (\k v m -> M.insert <$> f k <?> Key k <*> p v <?> Key k <*> m) (pure M.empty)
1565− FromJSONKeyValue f -> withArray "Map k v" $ \arr ->
1897+ FromJSONKeyValue f -> withArray "Map" $ \arr ->
15661898 fmap M.fromList . Tr.sequence .
15671899 zipWith (parseIndexedJSONPair f p) [0..] . V.toList $ arr
15681900 {-# INLINE liftParseJSON #-}
@@ -1590,18 +1922,18 @@ instance (FromJSON v) => FromJSON (Tree.Tree v) where
15901922
15911923instance FromJSON UUID.UUID where
15921924 parseJSON = withText "UUID" $
1593− maybe (fail "Invalid UUID") pure . UUID.fromText
1925+ maybe (fail "invalid UUID") pure . UUID.fromText
15941926
15951927instance FromJSONKey UUID.UUID where
15961928 fromJSONKey = FromJSONKeyTextParser $
1597− maybe (fail "Invalid UUID") pure . UUID.fromText
1929+ maybe (fail "invalid UUID") pure . UUID.fromText
15981930
15991931-------------------------------------------------------------------------------
16001932-- vector
16011933-------------------------------------------------------------------------------
16021934
16031935instance FromJSON1 Vector where
1604− liftParseJSON p _ = withArray "Vector a" $
1936+ liftParseJSON p _ = withArray "Vector" $
16051937 V.mapM (uncurry $ parseIndexedJSON p) . V.indexed
16061938 {-# INLINE liftParseJSON #-}
16071939
@@ -1615,14 +1947,14 @@ vectorParseJSON s = withArray s $ fmap V.convert . V.mapM (uncurry $ parseIndexe
16151947{-# INLINE vectorParseJSON #-}
16161948
16171949instance (Storable a, FromJSON a) => FromJSON (VS.Vector a) where
1618− parseJSON = vectorParseJSON "Data.Vector.Storable.Vector a"
1950+ parseJSON = vectorParseJSON "Data.Vector.Storable.Vector"
16191951
16201952instance (VP.Prim a, FromJSON a) => FromJSON (VP.Vector a) where
1621− parseJSON = vectorParseJSON "Data.Vector.Primitive.Vector a"
1953+ parseJSON = vectorParseJSON "Data.Vector.Primitive.Vector"
16221954 {-# INLINE parseJSON #-}
16231955
16241956instance (VG.Vector VU.Vector a, FromJSON a) => FromJSON (VU.Vector a) where
1625− parseJSON = vectorParseJSON "Data.Vector.Unboxed.Vector a"
1957+ parseJSON = vectorParseJSON "Data.Vector.Unboxed.Vector"
16261958 {-# INLINE parseJSON #-}
16271959
16281960-------------------------------------------------------------------------------
@@ -1636,13 +1968,13 @@ instance (Eq a, Hashable a, FromJSON a) => FromJSON (HashSet.HashSet a) where
16361968
16371969instance (FromJSONKey k, Eq k, Hashable k) => FromJSON1 (H.HashMap k) where
16381970 liftParseJSON p _ = case fromJSONKey of
1639− FromJSONKeyCoerce _ -> withObject "HashMap ~Text v" $
1971+ FromJSONKeyCoerce _ -> withObject "HashMap ~Text" $
16401972 uc . H.traverseWithKey (\k v -> p v <?> Key k)
1641− FromJSONKeyText f -> withObject "HashMap k v" $
1973+ FromJSONKeyText f -> withObject "HashMap" $
16421974 fmap (mapKey f) . H.traverseWithKey (\k v -> p v <?> Key k)
1643− FromJSONKeyTextParser f -> withObject "HashMap k v" $
1975+ FromJSONKeyTextParser f -> withObject "HashMap" $
16441976 H.foldrWithKey (\k v m -> H.insert <$> f k <?> Key k <*> p v <?> Key k <*> m) (pure H.empty)
1645− FromJSONKeyValue f -> withArray "Map k v" $ \arr ->
1977+ FromJSONKeyValue f -> withArray "Map" $ \arr ->
16461978 fmap H.fromList . Tr.sequence .
16471979 zipWith (parseIndexedJSONPair f p) [0..] . V.toList $ arr
16481980 where
@@ -1665,11 +1997,33 @@ instance FromJSON DotNetTime where
16651997 parseJSON = withText "DotNetTime" $ \t ->
16661998 let (s,m) = T.splitAt (T.length t - 5) t
16671999 t' = T.concat [s,".",m]
1668− in case parseTime defaultTimeLocale "/Date(%s%Q)/" (unpack t') of
2000+ in case parseTimeM True defaultTimeLocale "/Date(%s%Q)/" (unpack t') of
16692001 Just d -> pure (DotNetTime d)
16702002 _ -> fail "could not parse .NET time"
16712003 {-# INLINE parseJSON #-}
16722004
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+
16732027-------------------------------------------------------------------------------
16742028-- time
16752029-------------------------------------------------------------------------------
@@ -1720,22 +2074,56 @@ instance FromJSONKey UTCTime where
17202074 fromJSONKey = FromJSONKeyTextParser (Time.run Time.utcTime)
17212075
17222076
1723−-- | /WARNING:/ Only parse lengths of time from trusted input
1724−-- since an attacker could easily fill up the memory of the target
1725−-- system by specifying a scientific number with a big exponent like
1726−-- @1e1000000000@.
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.
17272081instance FromJSON NominalDiffTime where
1728− parseJSON = withScientific "NominalDiffTime" $ pure . realToFrac
2082+ parseJSON = withBoundedScientific "NominalDiffTime" $ pure . realToFrac
17292083 {-# INLINE parseJSON #-}
17302084
17312085
1732−-- | /WARNING:/ Only parse lengths of time from trusted input
1733−-- since an attacker could easily fill up the memory of the target
1734−-- system by specifying a scientific number with a big exponent like
1735−-- @1e1000000000@.
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.
17362090instance FromJSON DiffTime where
1737− parseJSON = withScientific "DiffTime" $ pure . realToFrac
1738− {-# INLINE parseJSON #-}
2091+ parseJSON = withBoundedScientific "DiffTime" $ pure . realToFrac
2092+ {-# INLINE parseJSON #-}
2093+
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
17392127
17402128-------------------------------------------------------------------------------
17412129-- base Monoid/Semigroup
@@ -1857,14 +2245,15 @@ instance FromJSON a => FromJSON (Semigroup.Option a) where
18572245
18582246instance FromJSON1 Proxy where
18592247 {-# INLINE liftParseJSON #-}
1860− liftParseJSON _ _ Null = pure Proxy
1861− liftParseJSON _ _ v = typeMismatch "Proxy" v
2248+ liftParseJSON _ _ = fromNull "Proxy" Proxy
18622249
18632250instance FromJSON (Proxy a) where
18642251 {-# INLINE parseJSON #-}
1865− parseJSON Null = pure Proxy
1866− parseJSON v = typeMismatch "Proxy" v
2252+ parseJSON = fromNull "Proxy" Proxy
18672253
2254+fromNull :: String -> a -> Value -> Parser a
2255+fromNull _ a Null = pure a
2256+fromNull c _ v = prependContext c (typeMismatch "Null" v)
18682257
18692258instance FromJSON2 Tagged where
18702259 liftParseJSON2 _ _ p _ = fmap Tagged . p
@@ -1891,10 +2280,7 @@ instance (FromJSON a, FromJSON b, FromJSON c) => FromJSONKey (a,b,c)
18912280instance (FromJSON a, FromJSON b, FromJSON c, FromJSON d) => FromJSONKey (a,b,c,d)
18922281
18932282instance FromJSONKey Char where
1894− fromJSONKey = FromJSONKeyTextParser $ \t ->
1895− if T.length t == 1
1896− then return (T.index t 0)
1897− else typeMismatch "Expected Char but String didn't contain exactly one character" (String t)
2283+ fromJSONKey = FromJSONKeyTextParser parseChar
18982284 fromJSONKeyList = FromJSONKeyText T.unpack
18992285
19002286instance (FromJSONKey a, FromJSON a) => FromJSONKey [a] where