Merge pull request #2604 from clash-lang/fix_doctest_ghc_9_6

Fix doctest on GHC 9.2-9.6 without multiple hidden

Author: christiaanb

cabal.project

@@ -16,7 +16,7 @@ write-ghc-environment-files: always
 -- index state, to go along with the cabal.project.freeze file. update the index
 -- state by running `cabal update` twice and looking at the index state it
 -- displays to you (as the second update will be a no-op)
-index-state: 2023-09-12T05:36:44Z
+index-state: 2023-10-18T12:11:41Z
 
 -- For some reason the `clash-testsuite` executable fails to run without
 -- this, as it cannot find the related library...

clash-prelude/clash-prelude.cabal

@@ -385,12 +385,15 @@ test-suite doctests
     build-depends:
       base,
       clash-prelude,
-      doctest-parallel >= 0.2 && < 0.4,
+      doctest-parallel >= 0.3.1 && < 0.4,
       filepath
 
   if flag(workaround-ghc-mmap-crash)
     ghc-options:    -with-rtsopts=-xm20000000
 
+  if flag(multiple-hidden)
+    CPP-Options: -DCLASH_MULTIPLE_HIDDEN
+
 
 test-suite unittests
   import:           common-options

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

@@ -846,6 +846,13 @@ readNew (blockRam (0 :> 1 :> Nil))
      ... =>
      Signal dom addr -> Signal dom (Maybe (addr, a)) -> Signal dom a
 
+#elif __GLASGOW_HASKELL__ >= 902 && !defined(CLASH_MULTIPLE_HIDDEN)
+>>> :t readNew (blockRam (0 :> 1 :> Nil))
+readNew (blockRam (0 :> 1 :> Nil))
+  :: ...
+     ... =>
+     Signal dom addr -> Signal dom (Maybe (addr, a)) -> Signal dom a
+
 #else
 >>> :t readNew (blockRam (0 :> 1 :> Nil))
 readNew (blockRam (0 :> 1 :> Nil))

clash-prelude/tests/doctests.hs

@@ -1,7 +1,21 @@
+{-# LANGUAGE CPP #-}
 module Main where
 
-import System.Environment (getArgs)
 import Test.DocTest (mainFromCabal)
+import System.Environment (getArgs)
 
 main :: IO ()
-main = mainFromCabal "clash-prelude" =<< getArgs
+main = mainFromCabal "clash-prelude" =<< fmap (extraArgs ++) getArgs
+
+extraArgs :: [String]
+extraArgs = map ("--ghc-arg=" ++)
+  [
+#if __GLASGOW_HASKELL__ >= 904
+    "-DCLASH_OPAQUE=OPAQUE"
+#else
+    "-DCLASH_OPAQUE=NOINLINE"
+#endif
+#ifdef CLASH_MULTIPLE_HIDDEN
+  , "-DCLASH_MULTIPLE_HIDDEN"
+#endif
+  ]

nix/overlay.nix

@@ -48,6 +48,8 @@ let
           "ghc-typelits-natnormalise"
           "${ghc-typelits-natnormalise}"
           { };
+      # doctest-parallel = hprev.callHackage "doctest-parallel" "0.3.1" { };
+      doctest-parallel = hprev.callHackageDirect { pkg = "doctest-parallel"; ver = "0.3.1"; sha256 = "sha256-j0mk4RTEau6Cl90E8vMWZiA/ldRRurtLSYbGGE+q/vk="; } {};
     };
 
   # An overlay with the packages in this repository.