Various small changes

CHANGELOG.md

@@ -20,11 +20,10 @@
   * Clash's internal type family solver now recognizes `AppendSymbol` and `CmpSymbol`
   * Added `Clash.Magic.suffixNameFromNat`: can be used in cases where `suffixName` is too slow
   * Added `Clash.Class.AutoReg`. Improves the chances of synthesis tools inferring clock-gated registers, when used. See [#873](https://github.com/clash-lang/clash-compiler/pull/873).
-  
+
 * New internal features:
   * [#821](https://github.com/clash-lang/clash-compiler/pull/821): Add `DebugTry`: print name of all tried transformations, even if they didn't succeed
   * [#856](https://github.com/clash-lang/clash-compiler/pull/856): Add `-fclash-debug-transformations`: only print debug info for specific transformations
-  * [#879](https://github.com/clash-lang/clash-compiler/pull/879): Add `-fclash-no-catch-errors`: don't try and catch errors in Clash compiler; let GHC handle it instead
 
 * Fixes issues:
   * [#810](https://github.com/clash-lang/clash-compiler/issues/810): Verilog backend now correctly specifies type of `BitVector 1`
@@ -48,10 +47,12 @@
   * TH code for auto deriving bit representations now produces nicer error messages ([7190793](https://github.com/clash-lang/clash-compiler/commit/7190793928545f85157f9b8d4b8ec2edb2cd8a26))
   * Adds '--enable-shared-executables' for nix builds; this should make Clash run _much_ faster ([#894](https://github.com/clash-lang/clash-compiler/pull/894))
   * Custom bit representations can now mark fields as zero-width without crashing the compiler ([#898](https://github.com/clash-lang/clash-compiler/pull/898))
-
+  * Error on unparsed trailing garbage in JSON "files"
+
 * Deprecations & removals:
   * Removed support for GHC 8.2 ([#842](https://github.com/clash-lang/clash-compiler/pull/842))
   * Removed support for older cabal versions, only Cabal >=2.2 supported ([#851](https://github.com/clash-lang/clash-compiler/pull/851))
+  * Reset and Enable constructors are now only exported from Clash.Signal.Internal
 
 ## 1.0.0 *September 3rd 2019*
 * 10x - 50x faster compile times

cabal.project

@@ -32,6 +32,5 @@ package clash-lib
   flags: debug
 
 optional-packages:
-  clash-cosim/clash-cosim.cabal,
-  clash-term/clash-term.cabal,
-  clash-cores/clash-cores.cabal
+  ./clash-cosim
+  ./clash-cores

clash-ghc/src-bin-841/Clash/Main.hs

@@ -294,12 +294,7 @@ main' postLoadMode dflags0 args flagWarnings clashOpts = do
        GHC.printException e
        liftIO $ exitWith (ExitFailure 1)) $ do
     clashOpts' <- liftIO (readIORef clashOpts)
-    let
-      clash fun =
-        if opt_catchErrors clashOpts' then
-          gcatch (fun clashOpts srcs) (handleClashException dflags6 clashOpts')
-        else
-          fun clashOpts srcs
+    let clash fun = gcatch (fun clashOpts srcs) (handleClashException dflags6 clashOpts')
     case postLoadMode of
        ShowInterface f        -> liftIO $ doShowIface dflags6 f
        DoMake                 -> doMake srcs

clash-ghc/src-bin-861/Clash/Main.hs

@@ -285,12 +285,7 @@ main' postLoadMode dflags0 args flagWarnings clashOpts = do
        GHC.printException e
        liftIO $ exitWith (ExitFailure 1)) $ do
     clashOpts' <- liftIO (readIORef clashOpts)
-    let
-      clash fun =
-        if opt_catchErrors clashOpts' then
-          gcatch (fun clashOpts srcs) (handleClashException dflags6 clashOpts')
-        else
-          fun clashOpts srcs
+    let clash fun = gcatch (fun clashOpts srcs) (handleClashException dflags6 clashOpts')
     case postLoadMode of
        ShowInterface f        -> liftIO $ doShowIface dflags6 f
        DoMake                 -> doMake srcs

clash-ghc/src-bin-881/Clash/Main.hs

@@ -295,12 +295,7 @@ main' postLoadMode dflags0 args flagWarnings clashOpts = do
        GHC.printException e
        liftIO $ exitWith (ExitFailure 1)) $ do
     clashOpts' <- liftIO (readIORef clashOpts)
-    let
-      clash fun =
-        if opt_catchErrors clashOpts' then
-          gcatch (fun clashOpts srcs) (handleClashException dflags6 clashOpts')
-        else
-          fun clashOpts srcs
+    let clash fun = gcatch (fun clashOpts srcs) (handleClashException dflags6 clashOpts')
     case postLoadMode of
        ShowInterface f        -> liftIO $ doShowIface dflags6 f
        DoMake                 -> doMake srcs

clash-ghc/src-ghc/Clash/GHC/ClashFlags.hs

@@ -84,7 +84,6 @@ flagsClash r = [
   , defFlag "fclash-no-escaped-identifiers"      $ NoArg (liftEwM (setNoEscapedIds r))
   , defFlag "fclash-compile-ultra"               $ NoArg (liftEwM (setUltra r))
   , defFlag "fclash-force-undefined"             $ OptIntSuffix (setUndefined r)
-  , defFlag "fclash-no-catch-errors"             $ NoArg (liftEwM (setNoCatchErrors r))
   ]
 
 -- | Print deprecated flag warning
@@ -147,9 +146,6 @@ setNoCache r = modifyIORef r (\c -> c {opt_cachehdl = False})
 setNoIDirCheck :: IORef ClashOpts -> IO ()
 setNoIDirCheck r = modifyIORef r (\c -> c {opt_checkIDir = False})
 
-setNoCatchErrors :: IORef ClashOpts -> IO ()
-setNoCatchErrors r = modifyIORef r (\c -> c {opt_catchErrors = False})
-
 setNoClean :: IORef ClashOpts -> IO ()
 setNoClean r = modifyIORef r (\c -> c {opt_cleanhdl = False})
 

clash-ghc/src-ghc/Clash/GHC/LoadModules.hs

@@ -643,14 +643,14 @@ wantedLanguageExtensions df =
              , LangExt.TemplateHaskellQuotes
              , LangExt.TypeApplications
              , LangExt.TypeFamilies
-             , LangExt.TypeOperators
 #if __GLASGOW_HASKELL__ < 806
              , LangExt.TypeInType
 #endif
+             , LangExt.TypeOperators
              ]
     unwanted = [ LangExt.ImplicitPrelude
                , LangExt.MonomorphismRestriction
-#if MIN_VERSION_ghc(8,6,0)
+#if __GLASGOW_HASKELL__ >= 806
                , LangExt.StarIsType
 #endif
                , LangExt.Strict

clash-ghc/src-ghc/Clash/GHC/Util.hs

@@ -24,8 +24,8 @@ handleClashException df opts e = case fromException e of
                  | otherwise = empty
     throwOneError (mkPlainErrMsg df sp (text s $$ srcInfo' $$ showExtra (opt_errorExtra opts) eM))
   _ -> case fromException e of
-    Just (ErrorCall msg) ->
-      throwOneError (mkPlainErrMsg df noSrcSpan (text "Clash error call:" $$ text msg))
+    Just (ErrorCallWithLocation _ _) ->
+      throwOneError (mkPlainErrMsg df noSrcSpan (text "Clash error call:" $$ text (show e)))
     _ -> case fromException e of
       Just (e' :: SourceError) -> do
         GHC.printException e'

clash-lib/src/Clash/Driver/Types.hs

@@ -89,12 +89,6 @@ data ClashOpts = ClashOpts { opt_inlineLimit :: Int
                            -- * /Just (Just x)/: replace undefined's by /x/ in
                            -- the HDL
                            , opt_checkIDir   :: Bool
-                           , opt_catchErrors :: Bool
-                           -- ^ Whether to catch errors in Clash. Settings this
-                           -- to false might cause 'please report as GHC bug' to
-                           -- appear. On the flipside, it might generate more
-                           -- informative error messages when debugging the
-                           -- compiler - especially on profiling builds.
                            }
 
 
@@ -123,7 +117,6 @@ defClashOpts
   , opt_ultra               = False
   , opt_forceUndefined      = Nothing
   , opt_checkIDir           = True
-  , opt_catchErrors         = True
   }
 
 -- | Information about the generated HDL between (sub)runs of the compiler

clash-lib/src/Clash/Netlist/Util.hs

@@ -170,7 +170,7 @@ unsafeCoreTypeToHWType
   -> State HWMap FilteredHWType
 unsafeCoreTypeToHWType sp loc builtInTranslation reprs m ty =
   either (\msg -> throw (ClashException sp (loc ++ msg) Nothing)) id <$>
-  coreTypeToHWType builtInTranslation reprs m ty
+    coreTypeToHWType builtInTranslation reprs m ty
 
 -- | Same as @unsafeCoreTypeToHWTypeM@, but discards void filter information
 unsafeCoreTypeToHWTypeM'

clash-lib/src/Data/Aeson/Extra.hs

@@ -14,6 +14,8 @@ import           Data.List            (intercalate)
 import           Data.Aeson           (FromJSON, Result (..), fromJSON, json)
 import           Data.Attoparsec.Lazy (Result (..), parse)
 import           Data.ByteString.Lazy (ByteString)
+import qualified Data.ByteString.Lazy as BS
+import qualified Data.ByteString.Lazy.Char8 as BSChar
 import           System.FilePath      ()
 
 import           Clash.Util           (ClashException(..))
@@ -55,8 +57,12 @@ decodeOrErr
   -> a
 decodeOrErr path contents =
   case parse json contents of
-    Done _ v ->
+    Done leftover v ->
       case fromJSON v of
+        Success _ | BS.any notWhitespace leftover ->
+          clashError ("After parsing " ++  show path
+                 ++ ", found unparsed trailing garbage:\n"
+                 ++ BSChar.unpack leftover)
         Success a ->
           a
         Error msg ->
@@ -77,3 +83,5 @@ decodeOrErr path contents =
   where
     loc = mkGeneralSrcSpan $ mkFastString path
     clashError msg = throw $ ClashException loc msg Nothing
+    notWhitespace c = BS.notElem c whitespace
+      where whitespace = BSChar.pack " \t\n\r"

clash-prelude/src/Clash/Annotations/Primitive.hs

@@ -221,7 +221,7 @@ data HDL
 -- {\-\# ANN example (InlinePrimitive VHDL $ unindent [i|
 --   [ { \"BlackBox\" :
 --       { "name" : "InlinePrimitive.example"
---       , "kind": "Declaration"
+--       , "kind": \"Declaration\"
 --       , "template" :
 --   "-- begin InlinePrimitive example:
 --   ~GENSYM[example][0] : block

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

@@ -189,7 +189,7 @@ module Clash.Explicit.Signal
   , initBehavior
   , resetPolarity
     -- ** Enabling
-  , Enable(..)
+  , Enable
   , toEnable
   , fromEnable
   , enableGen
@@ -202,7 +202,7 @@ module Clash.Explicit.Signal
   , unsafeSynchronizer
   , veryUnsafeSynchronizer
     -- * Reset
-  , Reset(..)
+  , Reset
   , unsafeToReset
   , unsafeFromReset
   , unsafeToHighPolarity

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

@@ -52,9 +52,9 @@ import Clash.Promoted.Symbol (SSymbol (..))
 import Clash.Explicit.Signal
   (Clock, Reset, System, Signal, clockPeriod, toEnable, fromList, register,
   unbundle, unsafeSynchronizer, veryUnsafeSynchronizer)
-import Clash.Signal.Internal (Clock (..))
+import Clash.Signal.Internal (Clock (..), Reset (..))
 import Clash.Signal
-  (mux, DomainResetKind, ResetKind(Asynchronous), KnownDomain, Reset(..),
+  (mux, DomainResetKind, ResetKind(Asynchronous), KnownDomain,
   Enable)
 import Clash.Sized.Index     (Index)
 import Clash.Sized.Internal.BitVector

clash-prelude/src/Clash/Signal.hs

@@ -140,7 +140,7 @@ module Clash.Signal
   , unsafeSynchronizer
 #endif
     -- * Reset
-  , Reset(..)
+  , Reset
   , unsafeToReset
   , unsafeFromReset
   , unsafeToHighPolarity
@@ -153,7 +153,7 @@ module Clash.Signal
   , E.resetSynchronizer
   , holdReset
     -- ** Enabling
-  , Enable(..)
+  , Enable
   , toEnable
   , fromEnable
   , S.enableGen

clash-prelude/src/Clash/Signal/Bundle.hs

@@ -70,11 +70,25 @@ import Clash.Sized.RTree            (RTree, lazyT)
 -- data D = A | B
 --
 -- instance Bundle D where
---   type 'Unbundled'' clk D = 'Signal'' clk D
---   'bundle'   _ s = s
---   'unbundle' _ s = s
+--   type 'Unbundled' clk D = 'Signal' clk D
+--   'bundle'   s = s
+--   'unbundle' s = s
 -- @
 --
+-- For custom product types you'll have to write the instance manually:
+-- @
+-- data Pair a b = MkPair { getA :: a, getB :: b }
+--
+-- instance Bundle (Pair a b) where
+--   type Unbundled dom (Pair a b) = Pair (Signal dom a) (Signal dom b)
+--
+--   -- bundle :: Pair (Signal dom a) (Signal dom b) -> Signal dom (Pair a b)
+--   bundle   (MkPair as bs) = MkPair <$> as <*> bs
+--
+--   -- unbundle :: Signal dom (Pair a b) -> Pair (Signal dom a) (Signal dom b)
+--   unbundle pairs = MkPair (getA <$> pairs) (getB <$> pairs)
+-- @
+
 class Bundle a where
   type Unbundled (dom :: Domain) a = res | res -> dom a
   type Unbundled dom a = Signal dom a

clash-prelude/src/Clash/Signal/Delayed/Bundle.hs

@@ -69,9 +69,9 @@ import           GHC.TypeLits                  (Nat)
 -- data D = A | B
 --
 -- instance Bundle D where
---   type 'Unbundled' dom delay D = 'DSignal' dom d D
---   'bundle'   _ s = s
---   'unbundle' _ s = s
+--   type 'Unbundled' dom delay D = 'DSignal' dom delay D
+--   'bundle'   s = s
+--   'unbundle' s = s
 -- @
 --
 class Bundle a where

clash-prelude/src/Clash/Tutorial.hs

@@ -892,14 +892,14 @@ import "Clash.Intel.ClockGen"
 'createDomain' vSystem{vName=\"Dom50\", vPeriod=50000}
 
 topEntity
-  :: Clock \"DomInput\"
-  -> Signal \"DomInput\" Bool
-  -> Signal \"Dom50\" Bit
-  -> Signal \"Dom50\" (BitVector 8)
+  :: Clock DomInput
+  -> Signal DomInput Bool
+  -> Signal Dom50 Bit
+  -> Signal Dom50 (BitVector 8)
 topEntity clk rst =
     'exposeClockResetEnable' ('mealy' blinkerT (1,False,0) . Clash.Prelude.isRising 1) pllOut rstSync 'enableGen'
   where
-    (pllOut,pllStable) = 'Clash.Intel.ClockGen.altpll' @"Dom50" (SSymbol @"altpll50") clk ('Clash.Signal.unsafeFromLowPolarity' rst)
+    (pllOut,pllStable) = 'Clash.Intel.ClockGen.altpll' \@Dom50 (SSymbol \@\"altpll50\") clk ('Clash.Signal.unsafeFromLowPolarity' rst)
     rstSync            = 'Clash.Signal.resetSynchronizer' pllOut ('Clash.Signal.unsafeFromLowPolarity' pllStable) enableGen
 
 blinkerT (leds,mode,cntr) key1R = ((leds',mode',cntr'),leds)
@@ -2434,7 +2434,7 @@ topEntity
 topEntity clk rst =
     exposeClockReset (mealy blinkerT (1,False,0) . isRising 1) pllOut rstSync
   where
-    (pllOut,pllStable) = altpll \@Dom50 (SSymbol \@ \"altpll50\") clk rst
+    (pllOut,pllStable) = altpll \@Dom50 (SSymbol \@\"altpll50\") clk rst
     rstSync            = resetSynchronizer pllOut (unsafeToAsyncReset pllStable)
 
 blinkerT (leds,mode,cntr) key1R = ((leds',mode',cntr'),leds)

clash-term/README.md

@@ -8,9 +8,15 @@ For detailed documentation and example visualizations, see the following [README
 
 ## Usage Instructions
 
-1. Run `clash` with the 'history' flag, which will write the rewrite history in `history.dat`:
+0. Enable the `history` flag on the clash-lib package, by adding to your cabal.project.local:
+```
+package clash-lib
+  flags: history
+```
+
+1. Run `clash`, which will write the rewrite history in `history.dat`:
 ```bash
-> cabal new-run -- clash --vhdl -f history DebugName examples/ALU.hs
+> cabal new-run -- clash --vhdl examples/ALU.hs
 ```
 
 2. The rewrite history has now been dumped to the file system, in `history.dat`.