Restore specific setters/getters in the API, changed implementation

Author: jacereda

src/Data/ArrayBuffer/DataView.js

@@ -33,7 +33,7 @@ exports.getterImpl = function getterImpl (data, v, o) {
         : data.nothing;
 };
 
-exports.setterImpl = function setterImpl (data,v,n,o) {
+exports.setterImpl = function setterImpl (data, v, o, n) {
     if (((o + data.bytesPerValue) >>> 0) <= v.byteLength) {
         v[data.functionName].call(v,o,n,data.littleEndian);
         return true;

src/Data/ArrayBuffer/DataView.purs

@@ -2,18 +2,56 @@
 -- | objects. See [MDN's spec](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/DataView) for details.
 
 module Data.ArrayBuffer.DataView
-  ( whole
-  , remainder
-  , part
-  , buffer
-  , byteOffset
-  , byteLength
-  , AProxy (..)
-  , class DataView
-  , getBE, getLE, setBE, setLE
-  ) where
-
-import Data.ArrayBuffer.Types (ByteOffset, DataView, ByteLength, ArrayBuffer, kind ArrayViewType, Int32, Int16, Int8, Uint32, Uint16, Uint8, Float32, Float64)
+       ( AProxy (..)
+       , Endian (..)
+       , buffer
+       , byteLength
+       , byteOffset
+       , class DataView
+       , class ViewTypeName
+       , get
+       , getBE
+       , getFloat32be
+       , getFloat32le
+       , getFloat64be
+       , getFloat64le
+       , getInt16be
+       , getInt16le
+       , getInt32be
+       , getInt32le
+       , getInt8
+       , getLE
+       , getUint16be
+       , getUint16le
+       , getUint32be
+       , getUint32le
+       , getUint8
+       , nm
+       , part
+       , remainder
+       , set
+       , setBE
+       , setFloat32be
+       , setFloat32le
+       , setFloat64be
+       , setFloat64le
+       , setInt16be
+       , setInt16le
+       , setInt32be
+       , setInt32le
+       , setInt8
+       , setLE
+       , setUint16be
+       , setUint16le
+       , setUint32be
+       , setUint32le
+       , setUint8
+       , whole
+       ) where
+
+import Prelude
+
+import Data.ArrayBuffer.Types (ArrayBuffer, ByteLength, ByteOffset, DataView, Float32, Float64, Int16, Int32, Int8, Uint16, Uint32, Uint8, Uint8Clamped, kind ArrayViewType)
 import Data.ArrayBuffer.ValueMapping (class BinaryValue, class BytesPerValue)
 import Data.Maybe (Maybe(..))
 import Data.Typelevel.Num (toInt', class Nat)
@@ -24,7 +62,6 @@ import Type.Proxy (Proxy(..))
 
 
 
-
 -- | View mapping the whole `ArrayBuffer`.
 foreign import whole :: ArrayBuffer -> DataView
 
@@ -52,13 +89,47 @@ foreign import byteLength :: DataView -> ByteLength
 
 data AProxy (a :: ArrayViewType) = AProxy
 
+data Endian = LE | BE
+
+instance eqEndian :: Eq Endian where
+  eq LE LE = true
+  eq BE BE = true
+  eq _ _ = false
+
+class (BinaryValue a t, ViewTypeName a) <= DataView (a :: ArrayViewType) t | a -> t
+
+instance dataViewUint8Clamped :: DataView Uint8Clamped UInt
+instance dataViewUint32 :: DataView Uint32 UInt
+instance dataViewUint16 :: DataView Uint16 UInt
+instance dataViewUint8 :: DataView Uint8 UInt
+instance dataViewInt32 :: DataView Int32 Int
+instance dataViewInt16 :: DataView Int16 Int
+instance dataViewInt8 :: DataView Int8 Int
+instance dataViewFloat32 :: DataView Float32 Number
+instance dataViewFloat64 :: DataView Float64 Number
 
-class BinaryValue a t <= DataView (a :: ArrayViewType) t | a -> t where
-  getLE :: AProxy a -> DataView -> ByteOffset -> Effect (Maybe t)
-  getBE :: AProxy a -> DataView -> ByteOffset -> Effect (Maybe t)
-  setBE :: AProxy a -> DataView -> t -> ByteOffset -> Effect Boolean
-  setLE :: AProxy a -> DataView -> t -> ByteOffset -> Effect Boolean
 
+class ViewTypeName vty where
+  nm :: AProxy vty -> String
+
+instance viewTypeNameUint8Clamped :: ViewTypeName Uint8Clamped where
+  nm _ = "Uint8Clamped"
+instance viewTypeNameViewUint32 :: ViewTypeName Uint32 where
+  nm _ = "Uint32"
+instance viewTypeNameViewUint16 :: ViewTypeName Uint16 where
+  nm _ = "Uint16"
+instance viewTypeNameViewUint8 :: ViewTypeName Uint8 where
+  nm _ = "Uint8"
+instance viewTypeNameViewInt32 :: ViewTypeName Int32 where
+  nm _ = "Int32"
+instance viewTypeNameViewInt16 :: ViewTypeName Int16 where
+  nm _ = "Int16"
+instance viewTypeNameViewInt8 :: ViewTypeName Int8 where
+  nm _ = "Int8"
+instance viewTypeNameViewFloat32 :: ViewTypeName Float32 where
+  nm _ = "Float32"
+instance viewTypeNameViewFloat64 :: ViewTypeName Float64 where
+  nm _ = "Float64"
 
 foreign import getterImpl :: forall t
                            . EffectFn3 { just :: t -> Maybe t
@@ -68,8 +139,8 @@ foreign import getterImpl :: forall t
                                        , bytesPerValue :: ByteLength
                                        } DataView ByteOffset (Maybe t)
 
-getter :: forall t
-        . { functionName :: String
+getter :: forall t.
+          { functionName :: String
           , bytesPerValue :: ByteLength
           , littleEndian :: Boolean
           }
@@ -83,64 +154,164 @@ getter data' d o =
     , bytesPerValue: data'.bytesPerValue
     } d o
 
+
+get :: forall a t b. DataView a t => BytesPerValue a b => Nat b => Endian -> AProxy a -> DataView -> ByteOffset -> Effect (Maybe t)
+get endian prx =
+  let le = endian == LE
+      pnm = "get" <> nm prx
+      bpv = toInt' (Proxy :: Proxy b)
+  in getter { functionName: pnm
+            , bytesPerValue: bpv
+            , littleEndian: le
+            }
+
+getBE :: forall a t b. DataView a t => BytesPerValue a b => Nat b => AProxy a -> DataView -> ByteOffset -> Effect (Maybe t)
+getBE = get BE
+
+getLE :: forall a t b. DataView a t => BytesPerValue a b => Nat b => AProxy a -> DataView -> ByteOffset -> Effect (Maybe t)
+getLE = get LE
+
 foreign import setterImpl :: forall t
                            . EffectFn4 { functionName :: String
                                        , littleEndian :: Boolean
                                        , bytesPerValue :: ByteLength
-                                       } DataView t ByteOffset Boolean
+                                       } DataView ByteOffset t Boolean
 
-setter :: forall t
-        . { functionName :: String
+setter :: forall t.
+          { functionName :: String
           , bytesPerValue :: ByteLength
           , littleEndian :: Boolean
-          } -> DataView -> t -> ByteOffset -> Effect Boolean
-setter d t o = runEffectFn4 setterImpl d t o
-
-
-instance dataViewInt8 :: (BytesPerValue Int8 b, Nat b) => DataView Int8 Int where
-  getBE AProxy = getter {functionName: "getInt8", bytesPerValue: toInt' (Proxy :: Proxy b), littleEndian: false}
-  setBE AProxy = setter {functionName: "setInt8", bytesPerValue: toInt' (Proxy :: Proxy b), littleEndian: false}
-  getLE AProxy = getter {functionName: "getInt8", bytesPerValue: toInt' (Proxy :: Proxy b), littleEndian: true}
-  setLE AProxy = setter {functionName: "setInt8", bytesPerValue: toInt' (Proxy :: Proxy b), littleEndian: true}
-
-instance dataViewInt16 :: (BytesPerValue Int16 b, Nat b) => DataView Int16 Int where
-  getBE AProxy = getter {functionName: "getInt16", bytesPerValue: toInt' (Proxy :: Proxy b), littleEndian: false}
-  setBE AProxy = setter {functionName: "setInt16", bytesPerValue: toInt' (Proxy :: Proxy b), littleEndian: false}
-  getLE AProxy = getter {functionName: "getInt16", bytesPerValue: toInt' (Proxy :: Proxy b), littleEndian: true}
-  setLE AProxy = setter {functionName: "setInt16", bytesPerValue: toInt' (Proxy :: Proxy b), littleEndian: true}
-
-instance dataViewInt32 :: (BytesPerValue Int32 b, Nat b) => DataView Int32 Int where
-  getBE AProxy = getter {functionName: "getInt32", bytesPerValue: toInt' (Proxy :: Proxy b), littleEndian: false}
-  setBE AProxy = setter {functionName: "setInt32", bytesPerValue: toInt' (Proxy :: Proxy b), littleEndian: false}
-  getLE AProxy = getter {functionName: "getInt32", bytesPerValue: toInt' (Proxy :: Proxy b), littleEndian: true}
-  setLE AProxy = setter {functionName: "setInt32", bytesPerValue: toInt' (Proxy :: Proxy b), littleEndian: true}
-
-instance dataViewUint8 :: (BytesPerValue Uint8 b, Nat b) => DataView Uint8 UInt where
-  getBE AProxy = getter {functionName: "getUint8", bytesPerValue: toInt' (Proxy :: Proxy b), littleEndian: false}
-  setBE AProxy = setter {functionName: "setUint8", bytesPerValue: toInt' (Proxy :: Proxy b), littleEndian: false}
-  getLE AProxy = getter {functionName: "getUint8", bytesPerValue: toInt' (Proxy :: Proxy b), littleEndian: true}
-  setLE AProxy = setter {functionName: "setUint8", bytesPerValue: toInt' (Proxy :: Proxy b), littleEndian: true}
-
-instance dataViewUint16 :: (BytesPerValue Uint16 b, Nat b) => DataView Uint16 UInt where
-  getBE AProxy = getter {functionName: "getUint16", bytesPerValue: toInt' (Proxy :: Proxy b), littleEndian: false}
-  setBE AProxy = setter {functionName: "setUint16", bytesPerValue: toInt' (Proxy :: Proxy b), littleEndian: false}
-  getLE AProxy = getter {functionName: "getUint16", bytesPerValue: toInt' (Proxy :: Proxy b), littleEndian: true}
-  setLE AProxy = setter {functionName: "setUint16", bytesPerValue: toInt' (Proxy :: Proxy b), littleEndian: true}
-
-instance dataViewUint32 :: (BytesPerValue Uint32 b, Nat b) => DataView Uint32 UInt where
-  getBE AProxy = getter {functionName: "getUint32", bytesPerValue: toInt' (Proxy :: Proxy b), littleEndian: false}
-  setBE AProxy = setter {functionName: "setUint32", bytesPerValue: toInt' (Proxy :: Proxy b), littleEndian: false}
-  getLE AProxy = getter {functionName: "getUint32", bytesPerValue: toInt' (Proxy :: Proxy b), littleEndian: true}
-  setLE AProxy = setter {functionName: "setUint32", bytesPerValue: toInt' (Proxy :: Proxy b), littleEndian: true}
-
-instance dataViewFloat32 :: (BytesPerValue Float32 b, Nat b) => DataView Float32 Number where
-  getBE AProxy = getter {functionName: "getFloat32", bytesPerValue: toInt' (Proxy :: Proxy b), littleEndian: false}
-  setBE AProxy = setter {functionName: "setFloat32", bytesPerValue: toInt' (Proxy :: Proxy b), littleEndian: false}
-  getLE AProxy = getter {functionName: "getFloat32", bytesPerValue: toInt' (Proxy :: Proxy b), littleEndian: true}
-  setLE AProxy = setter {functionName: "setFloat32", bytesPerValue: toInt' (Proxy :: Proxy b), littleEndian: true}
-
-instance dataViewFloat64 :: (BytesPerValue Float64 b, Nat b) => DataView Float64 Number where
-  getBE AProxy = getter {functionName: "getFloat64", bytesPerValue: toInt' (Proxy :: Proxy b), littleEndian: false}
-  setBE AProxy = setter {functionName: "setFloat64", bytesPerValue: toInt' (Proxy :: Proxy b), littleEndian: false}
-  getLE AProxy = getter {functionName: "getFloat64", bytesPerValue: toInt' (Proxy :: Proxy b), littleEndian: true}
-  setLE AProxy = setter {functionName: "setFloat64", bytesPerValue: toInt' (Proxy :: Proxy b), littleEndian: true}
+          } -> DataView -> ByteOffset -> t -> Effect Boolean
+setter d o t = runEffectFn4 setterImpl d o t
+
+set :: forall a t b. DataView a t => BytesPerValue a b => Nat b => Endian -> AProxy a -> DataView -> ByteOffset -> t -> Effect Boolean
+set endian prx =
+  let le = endian == LE
+      pnm = "set" <> nm prx
+      bpv = toInt' (Proxy :: Proxy b)
+  in setter { functionName: pnm
+            , bytesPerValue: bpv
+            , littleEndian: le
+            }
+
+-- | Fetch int8 value at a certain index in a `DataView`.
+getInt8 :: DataView -> ByteOffset -> Effect (Maybe Int)
+getInt8 = getLE (AProxy :: AProxy Int8)
+
+-- | Fetch big-endian int16 value at a certain index in a `DataView`.
+getInt16be :: DataView -> ByteOffset -> Effect (Maybe Int)
+getInt16be = getBE (AProxy :: AProxy Int16)
+
+-- | Fetch little-endian int16 value at a certain index in a `DataView`.
+getInt16le :: DataView -> ByteOffset -> Effect (Maybe Int)
+getInt16le = getLE (AProxy :: AProxy Int16)
+
+-- | Fetch big-endian int32 value at a certain index in a `DataView`.
+getInt32be :: DataView -> ByteOffset -> Effect (Maybe Int)
+getInt32be = getBE (AProxy :: AProxy Int32)
+
+-- | Fetch little-endian int32 value at a certain index in a `DataView`.
+getInt32le :: DataView -> ByteOffset -> Effect (Maybe Int)
+getInt32le = getLE (AProxy :: AProxy Int32)
+
+-- | Fetch uint8 value at a certain index in a `DataView`.
+getUint8 :: DataView -> ByteOffset -> Effect (Maybe UInt)
+getUint8 = getLE (AProxy :: AProxy Uint8)
+
+-- | Fetch big-endian uint16 value at a certain index in a `DataView`.
+getUint16be :: DataView -> ByteOffset -> Effect (Maybe UInt)
+getUint16be = getBE (AProxy :: AProxy Uint16)
+
+-- | Fetch little-endian uint16 value at a certain index in a `DataView`.
+getUint16le :: DataView -> ByteOffset -> Effect (Maybe UInt)
+getUint16le = getLE (AProxy :: AProxy Uint16)
+
+-- | Fetch big-endian uint32 value at a certain index in a `DataView`.
+getUint32be :: DataView -> ByteOffset -> Effect (Maybe UInt)
+getUint32be = getBE (AProxy :: AProxy Uint32)
+
+-- | Fetch little-endian uint32 value at a certain index in a `DataView`.
+getUint32le :: DataView -> ByteOffset -> Effect (Maybe UInt)
+getUint32le = getLE (AProxy :: AProxy Uint32)
+
+-- | Fetch big-endian float32 value at a certain index in a `DataView`.
+getFloat32be :: DataView -> ByteOffset -> Effect (Maybe Number)
+getFloat32be = getBE (AProxy :: AProxy Float32)
+
+-- | Fetch little-endian float32 value at a certain index in a `DataView`.
+getFloat32le :: DataView -> ByteOffset -> Effect (Maybe Number)
+getFloat32le = getLE (AProxy :: AProxy Float32)
+
+-- | Fetch big-endian float64 value at a certain index in a `DataView`.
+getFloat64be :: DataView -> ByteOffset -> Effect (Maybe Number)
+getFloat64be = getBE (AProxy :: AProxy Float64)
+
+-- | Fetch little-endian float64 value at a certain index in a `DataView`.
+getFloat64le :: DataView -> ByteOffset -> Effect (Maybe Number)
+getFloat64le = getLE (AProxy :: AProxy Float64)
+
+
+-- | Store big-endian value at a certain index in a `DataView`.
+setBE :: forall a t b. DataView a t => BytesPerValue a b => Nat b => AProxy a -> DataView -> ByteOffset -> t -> Effect Boolean
+setBE = set BE
+
+-- | Store little-endian value at a certain index in a `DataView`.
+setLE :: forall a t b. DataView a t => BytesPerValue a b => Nat b => AProxy a -> DataView -> ByteOffset -> t -> Effect Boolean
+setLE = set LE
+
+-- | Store int8 value at a certain index in a `DataView`.
+setInt8 :: DataView -> ByteOffset -> Int -> Effect Boolean
+setInt8 = setLE (AProxy :: AProxy Int8)
+
+-- | Store big-endian int16 value at a certain index in a `DataView`.
+setInt16be :: DataView -> ByteOffset -> Int -> Effect Boolean
+setInt16be = setBE (AProxy :: AProxy Int16)
+
+-- | Store little-endian int16 value at a certain index in a `DataView`.
+setInt16le :: DataView -> ByteOffset -> Int -> Effect Boolean
+setInt16le = setLE (AProxy :: AProxy Int16)
+
+-- | Store big-endian int32 value at a certain index in a `DataView`.
+setInt32be :: DataView -> ByteOffset -> Int -> Effect Boolean
+setInt32be = setBE (AProxy :: AProxy Int32)
+
+-- | Store little-endian int32 value at a certain index in a `DataView`.
+setInt32le :: DataView -> ByteOffset -> Int -> Effect Boolean
+setInt32le = setLE (AProxy :: AProxy Int32)
+
+-- | Store uint8 value at a certain index in a `DataView`.
+setUint8 :: DataView -> ByteOffset -> UInt -> Effect Boolean
+setUint8 = setLE (AProxy :: AProxy Uint8)
+
+
+-- | Store big-endian uint16 value at a certain index in a `DataView`.
+setUint16be :: DataView -> ByteOffset -> UInt -> Effect Boolean
+setUint16be = setBE (AProxy :: AProxy Uint16)
+
+-- | Store little-endian uint16 value at a certain index in a `DataView`.
+setUint16le :: DataView -> ByteOffset -> UInt -> Effect Boolean
+setUint16le = setLE (AProxy :: AProxy Uint16)
+
+-- | Store big-endian uint32 value at a certain index in a `DataView`.
+setUint32be :: DataView -> ByteOffset -> UInt -> Effect Boolean
+setUint32be = setBE (AProxy :: AProxy Uint32)
+
+-- | Store little-endian uint32 value at a certain index in a `DataView`.
+setUint32le :: DataView -> ByteOffset -> UInt -> Effect Boolean
+setUint32le = setLE (AProxy :: AProxy Uint32)
+
+-- | Store big-endian float32 value at a certain index in a `DataView`.
+setFloat32be :: DataView -> ByteOffset -> Number -> Effect Boolean
+setFloat32be = setBE (AProxy :: AProxy Float32)
+
+-- | Store little-endian float32 value at a certain index in a `DataView`.
+setFloat32le :: DataView -> ByteOffset -> Number -> Effect Boolean
+setFloat32le = setLE (AProxy :: AProxy Float32)
+
+-- | Store big-endian float64 value at a certain index in a `DataView`.
+setFloat64be :: DataView -> ByteOffset -> Number -> Effect Boolean
+setFloat64be = setBE (AProxy :: AProxy Float64)
+
+-- | Store little-endian float64 value at a certain index in a `DataView`.
+setFloat64le :: DataView -> ByteOffset -> Number -> Effect Boolean
+setFloat64le = setLE (AProxy :: AProxy Float64)