Rename Undefined to NFDataX

We didn't like the name `Undefined` because:

1. We were creating unknown values, not undefined values
2. Also, not the entire value is unkown, just the leafs
3. It also traverses data-structures, without touching
   unknown values (which throw XExceptions)

We went through multiple alternatives: `Unknown`, `Spine`,
`SpineX`, `LeafX`, `ClashData`, etc. all somewhat horrible.

Ultimately we decided to call it `NFDataX`, because it has some
`NFData`-like functionality.

Author: christiaanb

clash-cosim/src/Clash/CoSim/Types.hs

@@ -14,7 +14,7 @@ module Clash.CoSim.Types where
 import Data.Data (Data, Typeable)
 
 import Clash.Prelude (BitPack, BitSize, KnownNat)
-import Clash.XException (Undefined)
+import Clash.XException (NFDataX)
 
 -- | Settings passed to the simulator. Does not affect synthetization.
 data CoSimSettings = CoSimSettings
@@ -45,7 +45,7 @@ defaultSettings = CoSimSettings
 -- can be simultated.
 type ClashType a = ( BitPack a
                    , KnownNat (BitSize a)
-                   , Undefined a
+                   , NFDataX a
                    )
 
 -- | Supported simulators

clash-cosim/tests/test.hs

@@ -28,7 +28,7 @@ tests = testGroup "Inline verilog"
 -- "normal" Haskell types.
 bin
     :: forall t a
-     . (t ~ Signal System a, Undefined a)
+     . (t ~ Signal System a, NFDataX a)
     => (t -> t -> t)
     -> a
     -> a

clash-prelude/clash-prelude.cabal

@@ -323,7 +323,7 @@ test-suite unittests
                  Clash.Tests.DerivingDataRepr
                  Clash.Tests.DerivingDataReprTypes
                  Clash.Tests.Signal
-                 Clash.Tests.Undefined
+                 Clash.Tests.NFDataX
 
 
 benchmark benchmark-clash-prelude

clash-prelude/src/Clash/Examples.hs

@@ -195,7 +195,7 @@ data RxReg
   , _rx_d1         :: Bit
   , _rx_d2         :: Bit
   , _rx_busy       :: Bool
-  } deriving (Generic, Undefined)
+  } deriving (Generic, NFDataX)
 
 makeLenses ''RxReg
 
@@ -207,7 +207,7 @@ data TxReg
   , _tx_out      :: Bit
   , _tx_cnt      :: Unsigned 4
   }
-  deriving (Generic, Undefined)
+  deriving (Generic, NFDataX)
 
 makeLenses ''TxReg
 

clash-prelude/src/Clash/Explicit/BlockRam.hs

@@ -424,7 +424,7 @@ import           Clash.Sized.Index      (Index)
 import           Clash.Sized.Vector     (Vec, replicate, toList, iterateI)
 import qualified Clash.Sized.Vector     as CV
 import           Clash.XException
-  (maybeIsX, seqX, Undefined, deepErrorX, defaultSeqX, errorX)
+  (maybeIsX, seqX, NFDataX, deepErrorX, defaultSeqX, errorX)
 
 {- $setup
 >>> import Clash.Explicit.Prelude as C
@@ -442,7 +442,7 @@ data Reg
   | RegC
   | RegD
   | RegE
-  deriving (Eq,Show,Enum,C.Generic,Undefined)
+  deriving (Eq,Show,Enum,C.Generic,NFDataX)
 :}
 
 >>> :{
@@ -719,7 +719,7 @@ fromJustX (Just x) = x
 blockRam
   :: ( KnownDomain dom
      , HasCallStack
-     , Undefined a
+     , NFDataX a
      , Enum addr )
   => Clock dom
   -- ^ 'Clock' to synchronize to
@@ -765,7 +765,7 @@ blockRam = \clk gen content rd wrM ->
 blockRamPow2
   :: ( KnownDomain dom
      , HasCallStack
-     , Undefined a
+     , NFDataX a
      , KnownNat n )
   => Clock dom
   -- ^ 'Clock' to synchronize to
@@ -798,7 +798,7 @@ blockRamU
    :: forall n dom a r addr
    . ( KnownDomain dom
      , HasCallStack
-     , Undefined a
+     , NFDataX a
      , Enum addr
      , 1 <= n )
   => Clock dom
@@ -855,7 +855,7 @@ blockRamU#
   :: forall n dom a
    . ( KnownDomain dom
      , HasCallStack
-     , Undefined a )
+     , NFDataX a )
   => Clock dom
   -- ^ 'Clock' to synchronize to
   -> Enable dom
@@ -889,7 +889,7 @@ blockRam1
    :: forall n dom a r addr
    . ( KnownDomain dom
      , HasCallStack
-     , Undefined a
+     , NFDataX a
      , Enum addr
      , 1 <= n )
   => Clock dom
@@ -946,7 +946,7 @@ blockRam1#
   :: forall n dom a
    . ( KnownDomain dom
      , HasCallStack
-     , Undefined a )
+     , NFDataX a )
   => Clock dom
   -- ^ 'Clock' to synchronize to
   -> Enable dom
@@ -975,7 +975,7 @@ blockRam1# clk en n a =
 blockRam#
   :: ( KnownDomain dom
      , HasCallStack
-     , Undefined a )
+     , NFDataX a )
   => Clock dom
   -- ^ 'Clock' to synchronize to
   -> Enable dom
@@ -1022,7 +1022,7 @@ blockRam# (Clock _) gen content rd wen =
 -- | Create read-after-write blockRAM from a read-before-write one
 readNew
   :: ( KnownDomain dom
-     , Undefined a
+     , NFDataX a
      , Eq addr )
   => Clock dom
   -> Reset dom

clash-prelude/src/Clash/Explicit/DDR.hs

@@ -56,7 +56,7 @@ import Clash.Signal.Internal
 -- [(X,X),((-1),(-2)),((-3),2),(3,4),(5,6)]
 ddrIn
   :: ( HasCallStack
-     , Undefined a
+     , NFDataX a
      , KnownConfiguration fast ('DomainConfiguration fast fPeriod edge reset init polarity)
      , KnownConfiguration slow ('DomainConfiguration slow (2*fPeriod) edge reset init polarity) )
   => Clock slow
@@ -79,7 +79,7 @@ ddrIn clk rst en (i0,i1,i2) =
 ddrIn#
   :: forall a slow fast fPeriod polarity edge reset init
    . ( HasCallStack
-     , Undefined a
+     , NFDataX a
      , KnownConfiguration fast ('DomainConfiguration fast fPeriod edge reset init polarity)
      , KnownConfiguration slow ('DomainConfiguration slow (2*fPeriod) edge reset init polarity) )
   => Clock slow
@@ -142,7 +142,7 @@ ddrIn# (Clock _) (unsafeToHighPolarity -> hRst) (fromEnable -> ena) i0 i1 i2 =
 -- [-1,-1,-1,2,3,4,5]
 ddrOut
   :: ( HasCallStack
-     , Undefined a
+     , NFDataX a
      , KnownConfiguration fast ('DomainConfiguration fast fPeriod edge reset init polarity)
      , KnownConfiguration slow ('DomainConfiguration slow (2*fPeriod) edge reset init polarity) )
   => Clock slow
@@ -160,7 +160,7 @@ ddrOut clk rst en i0 =
 
 ddrOut#
   :: ( HasCallStack
-     , Undefined a
+     , NFDataX a
      , KnownConfiguration fast ('DomainConfiguration fast fPeriod edge reset init polarity)
      , KnownConfiguration slow ('DomainConfiguration slow (2*fPeriod) edge reset init polarity) )
   => Clock slow

clash-prelude/src/Clash/Explicit/Mealy.hs

@@ -23,7 +23,7 @@ where
 
 import           Clash.Explicit.Signal
   (KnownDomain, Bundle (..), Clock, Reset, Signal, Enable, register)
-import           Clash.XException      (Undefined)
+import           Clash.XException      (NFDataX)
 
 {- $setup
 >>> :set -XDataKinds -XTypeApplications
@@ -85,7 +85,7 @@ let macT s (x,y) = (s',s)
 -- @
 mealy
   :: ( KnownDomain dom
-     , Undefined s )
+     , NFDataX s )
   => Clock dom
   -- ^ 'Clock' to synchronize to
   -> Reset dom
@@ -132,7 +132,7 @@ mealy clk rst en f iS =
 -- @
 mealyB
   :: ( KnownDomain dom
-     , Undefined s
+     , NFDataX s
      , Bundle i
      , Bundle o )
   => Clock dom

clash-prelude/src/Clash/Explicit/Moore.hs

@@ -25,7 +25,7 @@ where
 
 import           Clash.Explicit.Signal
   (KnownDomain, Bundle (..), Clock, Reset, Signal, Enable, register)
-import           Clash.XException                 (Undefined)
+import           Clash.XException                 (NFDataX)
 
 {- $setup
 >>> :set -XDataKinds -XTypeApplications
@@ -77,7 +77,7 @@ import           Clash.XException                 (Undefined)
 -- @
 moore
   :: ( KnownDomain dom
-     , Undefined s )
+     , NFDataX s )
   => Clock dom
   -- ^ 'Clock' to synchronize to
   -> Reset dom
@@ -101,7 +101,7 @@ moore clk rst en ft fo iS =
 -- a moore machine without any output logic
 medvedev
   :: ( KnownDomain dom
-     , Undefined s )
+     , NFDataX s )
   => Clock dom
   -> Reset dom
   -> Enable dom
@@ -140,7 +140,7 @@ medvedev clk rst en tr st = moore clk rst en tr id st
 -- @
 mooreB
   :: ( KnownDomain dom
-     , Undefined s
+     , NFDataX s
      , Bundle i
      , Bundle o )
   => Clock dom
@@ -163,7 +163,7 @@ mooreB clk rst en ft fo iS i = unbundle (moore clk rst en ft fo iS (bundle i))
 -- | A version of 'medvedev' that does automatic 'Bundle'ing
 medvedevB
   :: ( KnownDomain dom
-     , Undefined s
+     , NFDataX s
      , Bundle i
      , Bundle s )
   => Clock dom

clash-prelude/src/Clash/Explicit/Prelude.hs

@@ -198,7 +198,7 @@ import Clash.XException
 window
   :: ( KnownNat n
      , KnownDomain dom
-     , Undefined a
+     , NFDataX a
      , Default a
      )
   => Clock dom
@@ -236,7 +236,7 @@ window clk rst en x = res
 -- ...
 windowD
   :: ( KnownNat n
-     , Undefined a
+     , NFDataX a
      , Default a
      , KnownDomain dom )
   => Clock dom

clash-prelude/src/Clash/Explicit/Prelude/Safe.hs

@@ -165,7 +165,7 @@ import Clash.XException
 -- ...
 registerB
   :: ( KnownDomain dom
-     , Undefined a
+     , NFDataX a
      , Bundle a )
   => Clock dom
   -> Reset dom
@@ -180,7 +180,7 @@ registerB clk rst en i =
 -- | Give a pulse when the 'Signal' goes from 'minBound' to 'maxBound'
 isRising
   :: ( KnownDomain dom
-     , Undefined a
+     , NFDataX a
      , Bounded a
      , Eq a )
   => Clock dom
@@ -198,7 +198,7 @@ isRising clk rst en is s = liftA2 edgeDetect prev s
 -- | Give a pulse when the 'Signal' goes from 'maxBound' to 'minBound'
 isFalling
   :: ( KnownDomain dom
-     , Undefined a
+     , NFDataX a
      , Bounded a
      , Eq a )
   => Clock dom