diff --git a/CHANGELOG.md b/CHANGELOG.md --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,36 +1,155 @@ -# Changelog for the [`clash-ghc`](http://hackage.haskell.org/package/clash-ghc) package +# Changelog for the Clash project -## 1.0.1 +## 1.2.0 *March 5th 2020* +As promised when releasing 1.0, we've tried our best to keep the API stable. We +think most designs will continue to compile with this new version, although special +care needs to be taken when using: + + * Use inline blackboxes. Instead of taking a single HDL, inline primitives now + take multiple. For example, `InlinePrimitive VHDL ".."` must now be written + as `InlinePrimitive [VHDL] ".."`. + + * Use the `Enum` instance for `BitVector`, `Index`, `Signed`, or `Unsigned`, as + they now respect their `maxBound`. See [#1089](https://github.com/clash-lang/clash-compiler/issues/1089). + +On top of that, we've added a number of new features: + + * `makeTopEntity`: Template Haskell function for generating TopEntity annotations. See [the documentation on Haddock](http://hackage.haskell.org/package/clash-prelude-1.2.0/docs/Clash-Annotations-TopEntity.html) for more information. + + * `Clash.Explicit.SimIO`: ((System)Verilog only) I/O actions that can be translated to HDL I/O. See [the documentation on Haddock](http://hackage.haskell.org/package/clash-prelude-1.2.0/docs/Clash-Explicit-SimIO.html) for more information. + + * `Clash.Class.AutoReg`: A smart register that improves the chances of synthesis tools inferring clock-gated registers, when used. See [the documentation on Haddock](http://hackage.haskell.org/package/clash-prelude-1.2.0/docs/Clash-Class-AutoReg.html) for more information. + +The full list of changes follows. Happy hacking! + +* New features (API): + * `Clash.Class.Parity` type class replaces Prelude `odd` and `even` functions due to assumptions that don't hold for Clash specific numerical types, see [#970](https://github.com/clash-lang/clash-compiler/pull/970). + * `NFDataX.ensureSpine`, see [#748](https://github.com/clash-lang/clash-compiler/pull/803) + * `makeTopEntity` Template Haskell function for generating TopEntity annotations + intended to cover the majority of use cases. Generation failures should either + result in an explicit error, or a valid annotation of an empty `PortProduct`. + Any discrepancy between the _shape_ of generated annotations and the _shape_ + of the Clash compiler is a bug. See [#795](https://github.com/clash-lang/clash-compiler/pull/795). + Known limitations: + * Type application (excluding `Signal`s and `:::`) is best effort: + * Data types with type parameters will work if the generator can discover a single relevant constructor after attempting type application. + * Arbitrary explicit clock/reset/enables are supported, but only a single `HiddenClockResetEnable` constraint is supported. + * Data/type family support is best effort. + * Added `Bundle ((f :*: g) a)` instance + * Added `NFDataX CUShort` instance + * 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). + * `Clash.Magic.suffixNameP`, `Clash.Magic.suffixNameFromNatP`: enable prefixing of name suffixes + * Added `Clash.Magic.noDeDup`: can be used to instruct Clash to /not/ share a function between multiple branches + * A `BitPack a` constraint now implies a `KnownNat (BitSize a)` constraint, so you won't have to add it manually anymore. See [#942](https://github.com/clash-lang/clash-compiler/pull/942). + * `Clash.Explicit.SimIO`: ((System)Verilog only) I/O actions that can be translated to HDL I/O; useful for generated test benches. + * Export `Clash.Explicit.Testbench.assertBitVector` [#888](https://github.com/clash-lang/clash-compiler/pull/888/files) + * Add `Clash.Prelude.Testbench.assertBitVector` to achieve feature parity with `Clash.Explicit.Testbench`. [#891](https://github.com/clash-lang/clash-compiler/pull/891/files) + * Add `Clash.XException.NFDataX.ensureSpine` [#803](https://github.com/clash-lang/clash-compiler/pull/803) + * Add `Clash.Class.BitPack.bitCoerceMap` [#798](https://github.com/clash-lang/clash-compiler/pull/798) + * Add `Clash.Magic.deDup`: instruct Clash to force sharing an operator between multiple branches of a case-expression + * `InlinePrimitive` can now support multiple backends simultaneously [#425](https://github.com/clash-lang/clash-compiler/issues/425) + * Add `Clash.XException.hwSeqX`: render declarations of an argument, but don't assign it to a result signal + * Add `Clash.Signal.Bundle.TaggedEmptyTuple`: allows users to emulate the pre-1.0 behavior of "Bundle ()". See [#1100](https://github.com/clash-lang/clash-compiler/pull/1100) + +* New features (Compiler): + * [#961](https://github.com/clash-lang/clash-compiler/pull/961): Show `-fclash-*` Options in `clash --show-options` + +* New internal features: + * [#918](https://github.com/clash-lang/clash-compiler/pull/935): Add X-Optimization to normalization passes (-fclash-aggressive-x-optimization) + * [#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 + * [#911](https://github.com/clash-lang/clash-compiler/pull/911): Add 'RenderVoid' option to blackboxes + * [#958](https://github.com/clash-lang/clash-compiler/pull/958): Prefix names of inlined functions + * [#947](https://github.com/clash-lang/clash-compiler/pull/947): Add "Clash.Core.TermLiteral" + * [#887](https://github.com/clash-lang/clash-compiler/pull/887): Show nicer error messages when failing in TH code + * [#884](https://github.com/clash-lang/clash-compiler/pull/884): Teach reduceTypeFamily about AppendSymbol and CmpSymbol + * [#784](https://github.com/clash-lang/clash-compiler/pull/784): Print whether `Id` is global or local in ppr output + * [#781](https://github.com/clash-lang/clash-compiler/pull/781): Use naming contexts in register names + * [#1061](https://github.com/clash-lang/clash-compiler/pull/1061): Add 'usedArguments' to BlackBoxHaskell blackboxes + * Fixes issues: + * [#974](https://github.com/clash-lang/clash-compiler/issues/974): Fix indirect shadowing in `reduceNonRepPrim` + * [#964](https://github.com/clash-lang/clash-compiler/issues/964): SaturatingNum instance of `Index` now behaves correctly when the size of the index overflows + an `Int`. * [#810](https://github.com/clash-lang/clash-compiler/issues/810): Verilog backend now correctly specifies type of `BitVector 1` * [#811](https://github.com/clash-lang/clash-compiler/issues/811): Improve module load behavior in clashi * [#439](https://github.com/clash-lang/clash-compiler/issues/439): Template Haskell splices and TopEntity annotations can now be used in clashi - * [#818](https://github.com/clash-lang/clash-compiler/issues/818): Fixed various mistakes in tutorial * [#662](https://github.com/clash-lang/clash-compiler/issues/662): Clash will now constant specialize partially constant constructs * [#700](https://github.com/clash-lang/clash-compiler/issues/700): Check work content of expression in cast before warning users. Should eliminate a lot of (superfluous) warnings about "specializing on non work-free cast"s. * [#837](https://github.com/clash-lang/clash-compiler/issues/837): Blackboxes will now report clearer error messages if they're given unexpected arguments. + * [#869](https://github.com/clash-lang/clash-compiler/issues/869): PLL is no longer duplicated in Blinker.hs example + * [#749](https://github.com/clash-lang/clash-compiler/issues/749): Clash's dependencies now all work with GHC 8.8, allowing `clash-{prelude,lib,ghc}` to be compiled from Hackage soon. + * [#871](https://github.com/clash-lang/clash-compiler/issues/871): RTree Bundle instance is now properly lazy + * [#895](https://github.com/clash-lang/clash-compiler/issues/895): VHDL type error when generating `Maybe (Vec 2 (Signed 8), Index 1)` + * [#880](https://github.com/clash-lang/clash-compiler/issues/880): Custom bit representations can now be used on product types too + * [#976](https://github.com/clash-lang/clash-compiler/issues/976): Prevent shadowing in Clash's core evaluator + * [#1007](https://github.com/clash-lang/clash-compiler/issues/1007): Can't translate domain tagType.Errors.IfStuck... + * [#967](https://github.com/clash-lang/clash-compiler/issues/967): Naming registers disconnects their output + * [#990](https://github.com/clash-lang/clash-compiler/issues/990): Internal shadowing bug results in incorrect HDL + * [#945](https://github.com/clash-lang/clash-compiler/issues/945): Rewrite rules for Vec Applicative Functor + * [#919](https://github.com/clash-lang/clash-compiler/issues/919): Clash generating invalid Verilog after Vec operations #919 + * [#996](https://github.com/clash-lang/clash-compiler/issues/996): Ambiguous clock when using `ClearOnReset` and `resetGen` together + * [#701](https://github.com/clash-lang/clash-compiler/issues/701): Unexpected behaviour with the `Synthesize` annotation + * [#694](https://github.com/clash-lang/clash-compiler/issues/694): Custom bit representation error only with VHDL + * [#347](https://github.com/clash-lang/clash-compiler/issues/347): topEntity synthesis fails due to insufficient type-level normalisation + * [#626](https://github.com/clash-lang/clash-compiler/issues/626): Missing Clash.Explicit.Prelude definitions + * [#960](https://github.com/clash-lang/clash-compiler/issues/626): Blackbox Error Caused by Simple map + * [#1012](https://github.com/clash-lang/clash-compiler/issues/1012): Case-let doesn't look through ticks + * [#430](https://github.com/clash-lang/clash-compiler/issues/430): Issue warning when not compiled with `executable-dynamic: True` + * [#374](https://github.com/clash-lang/clash-compiler/issues/1012): Clash.Sized.Fixed: fromInteger and fromRational don't saturate correctly + * [#836](https://github.com/clash-lang/clash-compiler/issues/836): Generate warning when `toInteger` blackbox drops MSBs + * [#1019](https://github.com/clash-lang/clash-compiler/issues/1019): Clash breaks on constants defined in terms of `GHC.Natural.gcdNatural` + * [#1025](https://github.com/clash-lang/clash-compiler/issues/1025): `inlineCleanup`will not produce empty letrecs anymore + * [#1030](https://github.com/clash-lang/clash-compiler/issues/1030): `bindConstantVar` will bind (workfree) constructs + * [#1034](https://github.com/clash-lang/clash-compiler/issues/1034): Error (10137): object "pllLock" on lhs must have a variable data type + * [#1046](https://github.com/clash-lang/clash-compiler/issues/1046): Don't confuse term/type namespaces in 'lookupIdSubst' + * [#1041](https://github.com/clash-lang/clash-compiler/issues/1041): Nested product types incorrectly decomposed into ports + * [#1058](https://github.com/clash-lang/clash-compiler/issues/1058): Prevent substitution warning when using type equalities in top entities + * [#1033](https://github.com/clash-lang/clash-compiler/issues/1033): Fix issue where Clash breaks when using Clock/Reset/Enable in product types in combination with Synthesize annotations + * [#1075](https://github.com/clash-lang/clash-compiler/issues/1075): Removed superfluous constraints on 'maybeX' and 'maybeIsX' + * [#1085](https://github.com/clash-lang/clash-compiler/issues/1085): Suggest exporting topentities if they can't be found in a module + * [#1065](https://github.com/clash-lang/clash-compiler/pull/1065): Report polymorphic topEntities as errors + * [#1089](https://github.com/clash-lang/clash-compiler/issues/1089): Respect maxBound in Enum instances for BitVector,Index,Signed,Unsigned -* Small fixes without issue reports: - * Fix bug in `rnfX` defined for `Down` ([814fd52](https://github.com/clash-lang/clash-compiler/commit/814fd520191123be38af8ef28fc49130424f3b93)) +* Fixes without issue reports: + * Fix bug in `rnfX` defined for `Down` ([baef30e](https://github.com/clash-lang/clash-compiler/commit/baef30eae03dc02ba847ffbb8fae7f365c5287c2)) + * Render numbers inside gensym ([bc76f0f](https://github.com/clash-lang/clash-compiler/commit/bc76f0f1934fd6e6ed9c33bcf950dae21e2f7903)) * Report blackbox name when encountering an error in 'setSym' ([#858](https://github.com/clash-lang/clash-compiler/pull/858)) + * Fix blackbox issues causing Clash to generate invalid HDL ([#865](https://github.com/clash-lang/clash-compiler/pull/865)) + * Treat types with a zero-width custom bit representation like other zero-width constructs ([#874](https://github.com/clash-lang/clash-compiler/pull/874)) + * 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)) + * Throw an error if there's data left to parse after successfully parsing a valid JSON construct ([#904](https://github.com/clash-lang/clash-compiler/pull/904)) + * `Data.gfoldl` is now manually implemented, in turn fixing issues with `gshow` ([#933](https://github.com/clash-lang/clash-compiler/pull/933)) + * Fix a number of issues with blackbox implementations ([#934](https://github.com/clash-lang/clash-compiler/pull/934)) + * Don't inline registers with non-constant clock and reset ([#998](https://github.com/clash-lang/clash-compiler/pull/998)) + * Inline let-binders called [dsN | N <- [1..]] ([#992](https://github.com/clash-lang/clash-compiler/pull/992)) + * ClockGens use their name at the Haskell level [#827](https://github.com/clash-lang/clash-compiler/pull/827) + * Render numbers inside gensym [#809](https://github.com/clash-lang/clash-compiler/pull/809) + * Don't overwrite existing binders when specializing [#790](https://github.com/clash-lang/clash-compiler/pull/790) + * Deshadow in 'caseCase' [#1067](https://github.com/clash-lang/clash-compiler/pull/1067) + * Deshadow in 'caseLet' and 'nonRepANF' [#1071](https://github.com/clash-lang/clash-compiler/pull/1071) +* 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 + * [#986](https://github.com/clash-lang/clash-compiler/issues/986) Remove -fclash-allow-zero-width flag + ## 1.0.0 *September 3rd 2019* * 10x - 50x faster compile times * New features: * API changes: check the migration guide at the end of `Clash.Tutorial` - * All memory elements now have an (implicit) enable line; "Gated" clocks have - been removed as the clock wasn't actually gated, but implemented as an - enable line. + * All memory elements now have an (implicit) enable line; "Gated" clocks have been removed as the clock wasn't actually gated, but implemented as an enable line. * Circuit domains are now configurable in: * (old) The clock period - * (new) Clock edge on which memory elements latch their inputs - (rising edge or falling edge) - * (new) Whether the reset port of a memory element is level sensitive - (asynchronous reset) or edge sensitive (synchronous reset) - * (new) Whether the reset port of a memory element is active-high or - active-low (negated reset) - * (new) Whether memory element power on in a configurable/defined state - (common on FPGAs) or in an undefined state (ASICs) + * (new) Clock edge on which memory elements latch their inputs (rising edge or falling edge) + * (new) Whether the reset port of a memory element is level sensitive asynchronous reset) or edge sensitive (synchronous reset) + * (new) Whether the reset port of a memory element is active-high or active-low (negated reset) + * (new) Whether memory element power on in a configurable/defined state (common on FPGAs) or in an undefined state (ASICs) * See the [blog post](https://clash-lang.org/blog/0005-synthesis-domain/) on this new feature * Data types can now be given custom bit-representations: http://hackage.haskell.org/package/clash-prelude/docs/Clash-Annotations-BitRepresentation.html @@ -50,95 +169,95 @@ See for example: http://hackage.haskell.org/package/clash-lib/docs/Clash-Primitives-Intel-ClockGen.html * Fixes issues: - * [#316](https://github.com/clash-lang/clash-prelude/issues/316) - * [#319](https://github.com/clash-lang/clash-prelude/issues/319) - * [#323](https://github.com/clash-lang/clash-prelude/issues/323) - * [#324](https://github.com/clash-lang/clash-prelude/issues/324) - * [#329](https://github.com/clash-lang/clash-prelude/issues/329) - * [#331](https://github.com/clash-lang/clash-prelude/issues/331) - * [#332](https://github.com/clash-lang/clash-prelude/issues/332) - * [#335](https://github.com/clash-lang/clash-prelude/issues/335) - * [#348](https://github.com/clash-lang/clash-prelude/issues/348) - * [#349](https://github.com/clash-lang/clash-prelude/issues/349) - * [#350](https://github.com/clash-lang/clash-prelude/issues/350) - * [#351](https://github.com/clash-lang/clash-prelude/issues/351) - * [#352](https://github.com/clash-lang/clash-prelude/issues/352) - * [#353](https://github.com/clash-lang/clash-prelude/issues/353) - * [#358](https://github.com/clash-lang/clash-prelude/issues/358) - * [#359](https://github.com/clash-lang/clash-prelude/issues/359) - * [#363](https://github.com/clash-lang/clash-prelude/issues/363) - * [#364](https://github.com/clash-lang/clash-prelude/issues/364) - * [#365](https://github.com/clash-lang/clash-prelude/issues/365) - * [#371](https://github.com/clash-lang/clash-prelude/issues/371) - * [#372](https://github.com/clash-lang/clash-prelude/issues/372) - * [#373](https://github.com/clash-lang/clash-prelude/issues/373) - * [#378](https://github.com/clash-lang/clash-prelude/issues/378) - * [#380](https://github.com/clash-lang/clash-prelude/issues/380) - * [#381](https://github.com/clash-lang/clash-prelude/issues/381) - * [#382](https://github.com/clash-lang/clash-prelude/issues/382) - * [#383](https://github.com/clash-lang/clash-prelude/issues/383) - * [#387](https://github.com/clash-lang/clash-prelude/issues/387) - * [#393](https://github.com/clash-lang/clash-prelude/issues/393) - * [#396](https://github.com/clash-lang/clash-prelude/issues/396) - * [#398](https://github.com/clash-lang/clash-prelude/issues/398) - * [#399](https://github.com/clash-lang/clash-prelude/issues/399) - * [#401](https://github.com/clash-lang/clash-prelude/issues/401) - * [#403](https://github.com/clash-lang/clash-prelude/issues/403) - * [#407](https://github.com/clash-lang/clash-prelude/issues/407) - * [#412](https://github.com/clash-lang/clash-prelude/issues/412) - * [#413](https://github.com/clash-lang/clash-prelude/issues/413) - * [#420](https://github.com/clash-lang/clash-prelude/issues/420) - * [#422](https://github.com/clash-lang/clash-prelude/issues/422) - * [#423](https://github.com/clash-lang/clash-prelude/issues/423) - * [#424](https://github.com/clash-lang/clash-prelude/issues/424) - * [#438](https://github.com/clash-lang/clash-prelude/issues/438) - * [#450](https://github.com/clash-lang/clash-prelude/issues/450) - * [#452](https://github.com/clash-lang/clash-prelude/issues/452) - * [#455](https://github.com/clash-lang/clash-prelude/issues/455) - * [#460](https://github.com/clash-lang/clash-prelude/issues/460) - * [#461](https://github.com/clash-lang/clash-prelude/issues/461) - * [#463](https://github.com/clash-lang/clash-prelude/issues/463) - * [#468](https://github.com/clash-lang/clash-prelude/issues/468) - * [#475](https://github.com/clash-lang/clash-prelude/issues/475) - * [#476](https://github.com/clash-lang/clash-prelude/issues/476) - * [#500](https://github.com/clash-lang/clash-prelude/issues/500) - * [#507](https://github.com/clash-lang/clash-prelude/issues/507) - * [#512](https://github.com/clash-lang/clash-prelude/issues/512) - * [#516](https://github.com/clash-lang/clash-prelude/issues/516) - * [#517](https://github.com/clash-lang/clash-prelude/issues/517) - * [#526](https://github.com/clash-lang/clash-prelude/issues/526) - * [#556](https://github.com/clash-lang/clash-prelude/issues/556) - * [#560](https://github.com/clash-lang/clash-prelude/issues/560) - * [#566](https://github.com/clash-lang/clash-prelude/issues/566) - * [#567](https://github.com/clash-lang/clash-prelude/issues/567) - * [#569](https://github.com/clash-lang/clash-prelude/issues/569) - * [#573](https://github.com/clash-lang/clash-prelude/issues/573) - * [#575](https://github.com/clash-lang/clash-prelude/issues/575) - * [#581](https://github.com/clash-lang/clash-prelude/issues/581) - * [#582](https://github.com/clash-lang/clash-prelude/issues/582) - * [#586](https://github.com/clash-lang/clash-prelude/issues/586) - * [#588](https://github.com/clash-lang/clash-prelude/issues/588) - * [#591](https://github.com/clash-lang/clash-prelude/issues/591) - * [#596](https://github.com/clash-lang/clash-prelude/issues/596) - * [#601](https://github.com/clash-lang/clash-prelude/issues/601) - * [#607](https://github.com/clash-lang/clash-prelude/issues/607) - * [#629](https://github.com/clash-lang/clash-prelude/issues/629) - * [#637](https://github.com/clash-lang/clash-prelude/issues/637) - * [#644](https://github.com/clash-lang/clash-prelude/issues/644) - * [#647](https://github.com/clash-lang/clash-prelude/issues/647) - * [#661](https://github.com/clash-lang/clash-prelude/issues/661) - * [#668](https://github.com/clash-lang/clash-prelude/issues/668) - * [#677](https://github.com/clash-lang/clash-prelude/issues/677) - * [#678](https://github.com/clash-lang/clash-prelude/issues/678) - * [#682](https://github.com/clash-lang/clash-prelude/issues/682) - * [#691](https://github.com/clash-lang/clash-prelude/issues/691) - * [#703](https://github.com/clash-lang/clash-prelude/issues/703) - * [#713](https://github.com/clash-lang/clash-prelude/issues/713) - * [#715](https://github.com/clash-lang/clash-prelude/issues/715) - * [#727](https://github.com/clash-lang/clash-prelude/issues/727) - * [#730](https://github.com/clash-lang/clash-prelude/issues/730) - * [#736](https://github.com/clash-lang/clash-prelude/issues/736) - * [#738](https://github.com/clash-lang/clash-prelude/issues/738) + * [#316](https://github.com/clash-lang/clash-compiler/issues/316) + * [#319](https://github.com/clash-lang/clash-compiler/issues/319) + * [#323](https://github.com/clash-lang/clash-compiler/issues/323) + * [#324](https://github.com/clash-lang/clash-compiler/issues/324) + * [#329](https://github.com/clash-lang/clash-compiler/issues/329) + * [#331](https://github.com/clash-lang/clash-compiler/issues/331) + * [#332](https://github.com/clash-lang/clash-compiler/issues/332) + * [#335](https://github.com/clash-lang/clash-compiler/issues/335) + * [#348](https://github.com/clash-lang/clash-compiler/issues/348) + * [#349](https://github.com/clash-lang/clash-compiler/issues/349) + * [#350](https://github.com/clash-lang/clash-compiler/issues/350) + * [#351](https://github.com/clash-lang/clash-compiler/issues/351) + * [#352](https://github.com/clash-lang/clash-compiler/issues/352) + * [#353](https://github.com/clash-lang/clash-compiler/issues/353) + * [#358](https://github.com/clash-lang/clash-compiler/issues/358) + * [#359](https://github.com/clash-lang/clash-compiler/issues/359) + * [#363](https://github.com/clash-lang/clash-compiler/issues/363) + * [#364](https://github.com/clash-lang/clash-compiler/issues/364) + * [#365](https://github.com/clash-lang/clash-compiler/issues/365) + * [#371](https://github.com/clash-lang/clash-compiler/issues/371) + * [#372](https://github.com/clash-lang/clash-compiler/issues/372) + * [#373](https://github.com/clash-lang/clash-compiler/issues/373) + * [#378](https://github.com/clash-lang/clash-compiler/issues/378) + * [#380](https://github.com/clash-lang/clash-compiler/issues/380) + * [#381](https://github.com/clash-lang/clash-compiler/issues/381) + * [#382](https://github.com/clash-lang/clash-compiler/issues/382) + * [#383](https://github.com/clash-lang/clash-compiler/issues/383) + * [#387](https://github.com/clash-lang/clash-compiler/issues/387) + * [#393](https://github.com/clash-lang/clash-compiler/issues/393) + * [#396](https://github.com/clash-lang/clash-compiler/issues/396) + * [#398](https://github.com/clash-lang/clash-compiler/issues/398) + * [#399](https://github.com/clash-lang/clash-compiler/issues/399) + * [#401](https://github.com/clash-lang/clash-compiler/issues/401) + * [#403](https://github.com/clash-lang/clash-compiler/issues/403) + * [#407](https://github.com/clash-lang/clash-compiler/issues/407) + * [#412](https://github.com/clash-lang/clash-compiler/issues/412) + * [#413](https://github.com/clash-lang/clash-compiler/issues/413) + * [#420](https://github.com/clash-lang/clash-compiler/issues/420) + * [#422](https://github.com/clash-lang/clash-compiler/issues/422) + * [#423](https://github.com/clash-lang/clash-compiler/issues/423) + * [#424](https://github.com/clash-lang/clash-compiler/issues/424) + * [#438](https://github.com/clash-lang/clash-compiler/issues/438) + * [#450](https://github.com/clash-lang/clash-compiler/issues/450) + * [#452](https://github.com/clash-lang/clash-compiler/issues/452) + * [#455](https://github.com/clash-lang/clash-compiler/issues/455) + * [#460](https://github.com/clash-lang/clash-compiler/issues/460) + * [#461](https://github.com/clash-lang/clash-compiler/issues/461) + * [#463](https://github.com/clash-lang/clash-compiler/issues/463) + * [#468](https://github.com/clash-lang/clash-compiler/issues/468) + * [#475](https://github.com/clash-lang/clash-compiler/issues/475) + * [#476](https://github.com/clash-lang/clash-compiler/issues/476) + * [#500](https://github.com/clash-lang/clash-compiler/issues/500) + * [#507](https://github.com/clash-lang/clash-compiler/issues/507) + * [#512](https://github.com/clash-lang/clash-compiler/issues/512) + * [#516](https://github.com/clash-lang/clash-compiler/issues/516) + * [#517](https://github.com/clash-lang/clash-compiler/issues/517) + * [#526](https://github.com/clash-lang/clash-compiler/issues/526) + * [#556](https://github.com/clash-lang/clash-compiler/issues/556) + * [#560](https://github.com/clash-lang/clash-compiler/issues/560) + * [#566](https://github.com/clash-lang/clash-compiler/issues/566) + * [#567](https://github.com/clash-lang/clash-compiler/issues/567) + * [#569](https://github.com/clash-lang/clash-compiler/issues/569) + * [#573](https://github.com/clash-lang/clash-compiler/issues/573) + * [#575](https://github.com/clash-lang/clash-compiler/issues/575) + * [#581](https://github.com/clash-lang/clash-compiler/issues/581) + * [#582](https://github.com/clash-lang/clash-compiler/issues/582) + * [#586](https://github.com/clash-lang/clash-compiler/issues/586) + * [#588](https://github.com/clash-lang/clash-compiler/issues/588) + * [#591](https://github.com/clash-lang/clash-compiler/issues/591) + * [#596](https://github.com/clash-lang/clash-compiler/issues/596) + * [#601](https://github.com/clash-lang/clash-compiler/issues/601) + * [#607](https://github.com/clash-lang/clash-compiler/issues/607) + * [#629](https://github.com/clash-lang/clash-compiler/issues/629) + * [#637](https://github.com/clash-lang/clash-compiler/issues/637) + * [#644](https://github.com/clash-lang/clash-compiler/issues/644) + * [#647](https://github.com/clash-lang/clash-compiler/issues/647) + * [#661](https://github.com/clash-lang/clash-compiler/issues/661) + * [#668](https://github.com/clash-lang/clash-compiler/issues/668) + * [#677](https://github.com/clash-lang/clash-compiler/issues/677) + * [#678](https://github.com/clash-lang/clash-compiler/issues/678) + * [#682](https://github.com/clash-lang/clash-compiler/issues/682) + * [#691](https://github.com/clash-lang/clash-compiler/issues/691) + * [#703](https://github.com/clash-lang/clash-compiler/issues/703) + * [#713](https://github.com/clash-lang/clash-compiler/issues/713) + * [#715](https://github.com/clash-lang/clash-compiler/issues/715) + * [#727](https://github.com/clash-lang/clash-compiler/issues/727) + * [#730](https://github.com/clash-lang/clash-compiler/issues/730) + * [#736](https://github.com/clash-lang/clash-compiler/issues/736) + * [#738](https://github.com/clash-lang/clash-compiler/issues/738) ## 0.99.3 *July 28th 2018* * Fixes bugs: @@ -150,16 +269,38 @@ * Create empty component when result needs 0 bits * Evaluator performs BigNat arithmetic +* Features: + * Bundle and BitPack instances up to and including 62-tuples + * Handle undefined writes to RAM properly + * Handle undefined clock enables properly + + ## 0.99.1 *May 12th 2018* * Allow `~NAME[N]` tag inside `~GENSYM[X]` * Support HDL record selector generation [#313](https://github.com/clash-lang/clash-compiler/pull/313) * `InlinePrimitive` support: specify HDL primitives inline with Haskell code +* Support for `ghc-typelits-natnormalise-0.6.1` +* `Lift` instances for `TopEntity` and `PortName` +* `InlinePrimitive` support: specify HDL primitives inline with Haskell code ## 0.99 *March 31st 2018* * New features: - * Support for `clash-prelude-0.99`: - * Explicit clock and reset arguments - * Overhaul of `TopEntity` annotations + * Major API overhaul: check the migration guide at the end of `Clash.Tutorial` + * New features: + * Explicit clock and reset arguments + * Rename `CLaSH` to `Clash` + * Implicit/`Hidden` clock and reset arguments using a combination of + `reflection` and `ImplicitParams`. + * Large overhaul of `TopEntity` annotations + * PLL and other clock sources can now be instantiated using regular functions: + `Clash.Intel.ClockGen` and `Clash.Xilinx.ClockGen`. + * DDR registers: + * Generic/ASIC: `Clash.Explicit.DDR` + * Intel: `Clash.Intel.DDR` + * Xilinx: `Clash.Intel.Xilinx` + * `Bit` is now a `newtype` instead of a `type` synonym and will be mapped to + a HDL scalar instead of an array of one (e.g `std_logic` instead of + `std_logic_vector(0 downto 0)`) * Hierarchies with multiple synthesisable boundaries by allowing more than one function in scope to have a `Synthesize` annotation. * Local caching of functions with a `Synthesize` annotation @@ -169,357 +310,10 @@ * Improved compile-time computation * Many bug fixes -## 0.7.2 -* New features: - * Sum-of-product types: unused bits now "don't-care" [#212](https://github.com/clash-lang/clash-compiler/commit/fabf745793491ce3baf84ef0066b4ccf0753d503) -* Fixes bugs: - * Eagerness bug in `regEn` [#104](https://github.com/clash-lang/clash-prelude/issues/104) (Thanks to @cbiffle) +## Older versions +Check out: + * https://github.com/clash-lang/clash-compiler/blob/3649a2962415ea8ca2d6f7f5e673b4c14de26b4f/clash-prelude/CHANGELOG.md + * https://github.com/clash-lang/clash-compiler/blob/3649a2962415ea8ca2d6f7f5e673b4c14de26b4f/clash-lib/CHANGELOG.md + * https://github.com/clash-lang/clash-compiler/blob/3649a2962415ea8ca2d6f7f5e673b4c14de26b4f/clash-ghc/CHANGELOG.md -## 0.7.1 *April 11th 2017* -* New features: - * Support distribution of primitive templates with Cabal/Hackage packages [commit](https://github.com/clash-lang/clash-compiler/commit/82cd31863aafcbaf3bdbf7746d89d13859af5aaf) - * Find memory data files and primitive files relative to import dirs (`-i`) - * Add 'clashi' program and 'clash-ghc' package [#208](https://github.com/clash-lang/clash-compiler/issues/208), thanks to @thoughtpolice -* Fixes bugs: - * `case (EmptyCase ty) of ty' { ... }` -> `EmptyCase ty'` [#198](https://github.com/clash-lang/clash-compiler/issues/198) - * `BitVector.split#` apply the correct type arguments -## 0.7.0.1 *January 17th 2017 -* Fixes bugs: - * Include HsVersions.h in source distribution - -## 0.7 *January 16th 2017* -* New features: - * Support for `clash-prelude` 0.11 - * Primitive templates can include QSys files - * VHDL blackboxes: support additional libraries and uses keywords in generated VHDL - * Highly limited Float/Double support (literals and `Rational` conversion), hidden behind the `-clash-float-support` flag. -* Fixes bugs: - * Reduce type families inside clock period calculation [#180](https://github.com/clash-lang/clash-compiler/issues/180) - * Only output signed literals as hex when they're multiple of 4 bits [#187](https://github.com/clash-lang/clash-compiler/issues/187) - * Correctly print negative hex literals - -## 0.6.24 *October 17th 20168 -* Call generatePrimMap after loadModules [#175](https://github.com/clash-lang/clash-compiler/pull/175) -* Fixes bugs: - * (System)Verilog: CLaSH.Sized.Vector.imap primitive gets indices in reverse order - * Template Haskell splices are run twice - * CLaSH errors out when observing the constructor for `Signal` [#174](https://github.com/clash-lang/clash-compiler/issues/174) - -## 0.6.23 *August 18th 2015* -* Fixes bugs: - * Type families are not being reduced correctly [#167](https://github.com/clash-lang/clash-compiler/issues/167) - * (System)Verilog: Fix primitives for {Signed,Unsigned} rotateL# and rotateR# [#169](https://github.com/clash-lang/clash-compiler/issues/169) - -## 0.6.22 *August 3rd 2016* -* Fixes bugs: - * Bug in DEC transformation overwrites case-alternatives - * Bug in DEC transformation creates non-representable let-binders - * VHDL: Incorrect primitive for `Integer`s `ltInteger#` and `geInteger#` - * (System)Verilog: Fix primitive for CLaSH.Sized.Internal.Signed.mod# and GHC.Type.Integer.modInteger [#164](https://github.com/clash-lang/clash-compiler/issues/164) - -## 0.6.21 *July 19th 2016* -* Fixes bugs: - * Rounding error in `logBase` calculation - * VHDL: Incorrect primitive for `Index`s `*#` - * VHDL: Incorrect handling of `Index`s `fromInteger#` and `maxBound#` primitives for values larger than 2^MACHINE_WIDTH - -## 0.6.20 *July 15th 2016* -* New features: - * Better error location reporting -* Fixes bugs: - * `CLaSH.Sized.Internal.Unsigned.maxBound#` not evaluated at compile-time [#155](https://github.com/clash-lang/clash-compiler/issues/155) - * `CLaSH.Sized.Internal.Unsigned.minBound#` not evaluated at compile-time [#157](https://github.com/clash-lang/clash-compiler/issues/157) - * Values of type Index 'n', where 'n' > 2^MACHINE_WIDTH, incorrectly considered non-synthesisable due to overflow - * VHDL: Types in generated types.vhdl incorrectly sorted - * Casts of CLaSH numeric types result in incorrect VHDL/Verilog (Such casts are now reported as an error) - -## 0.6.19 *June 9th 2016* -* Fixes bugs: - * `Eq` instance of `Vec` sometimes not synthesisable - * VHDL: Converting product types to std_logic_vector fails when the `clash-hdlsyn Vivado` flag is enabled - -## 0.6.18 *June 7th 2016* -* New features: - * DEC transformation also lifts HO-primitives applied to "interesting" primitives (i.e. `zipWith (*)`) - * New `-clash-hdlsyn Xilinx` flag to generate HDL tweaked for Xilinx synthesis tools (both ISE and Vivado) -* Fixes bugs: - * replicate unfolded incorrectly [#150](https://github.com/clash-lang/clash-compiler/issues/150) - * `imap` is not unrolled [#151](https://github.com/clash-lang/clash-compiler/issues/151) - * VHDL: Incorrect primitive specification for `snatToInteger` [#149](https://github.com/clash-lang/clash-compiler/issues/149) - -## 0.6.17 *April 7th 2016* -* New features: - * Up to 2x reduced compilation times when working with large `Vec` literals -* Fixes bugs: - * VHDL: Incorrect primitives for `BitVector`s `quot#` and `rem#` - * VHDL: Bit indexing and replacement primitives fail to synthesise in Synopsis tools - * Bug in DEC transformation throws CLaSH into an endless loop [#140](https://github.com/clash-lang/clash-compiler/issues/140) - * Missed constant folding opportunity results in an error [#50](https://github.com/clash-lang/clash-prelude/issues/50) - -## 0.6.16 *March 21st 2016* -* New features: - * Also generate testbench for circuits without input ports [#135](https://github.com/clash-lang/clash-compiler/issues/135) -* Fixes bugs: - * `clockWizard` broken [#49](https://github.com/clash-lang/clash-prelude/issues/49) - -## 0.6.15 *March 15th 2016* -* Fixes bugs: - * XST cannot finds "_types" package unless it is prefixed with "work." [#133](https://github.com/clash-lang/clash-compiler/pull/133) - -## 0.6.14 *March 15th 2016* -* Fixes bugs: - * XST cannot finds "_types" package unless it is prefixed with "work." [#133](https://github.com/clash-lang/clash-compiler/pull/133) - -## 0.6.13 *March 14th 2016* -* Fixes bugs: - * Not all lambda's in a function position removed - -## 0.6.12 *March 14th 2016* -* Fixes bugs: - * Not all lambda's in a function position removed due to bad eta-expansion [#132](https://github.com/clash-lang/clash-compiler/issues/132) - -## 0.6.11 *March 11th 2016* -* New features: - * Add support for HDL synthesis tool specific HDL generation: - * New `-clash-hdlsyn Vivado` flag to generate HDL tweaked for Xilinx Vivado - * Preserve more Haskell names in generated HDL [#128](https://github.com/clash-lang/clash-compiler/issues/128) -* Fixes bugs: - * VHDL: Vivado fails to infer block ram [#127](https://github.com/clash-lang/clash-compiler/issues/127) - * Users must use the `-clash-hdlsyn Vivado` flag in order to generate Xilinx Vivado specific HDL for which Vivado can infer block RAM. - -## 0.6.10 *February 10th 2016* -* New features: - * hdl files can be written to a directory (set by the `-clash-hdldir` flag) other than the current working directory [#125](https://github.com/clash-lang/clash-compiler/issues/125). - Also respects the `-outputdir` directory, _unless_: - * `-clash-hdldir` is set to a different directory. - * `-hidir`, `-stubdir`, and `-dumbdir` are not the same directory as `-odir` -* Fixes bugs: - * `caseCon` transformation does not work on non-exhaustive case-expressions [#123](https://github.com/clash-lang/clash-compiler/issues/123) - * VHDL: insufficient type-qualifiers for concatenation operator [#121](https://github.com/clash-lang/clash-compiler/issues/121) - * Primitive reductions don't look through `Signal` [#126](https://github.com/clash-lang/clash-compiler/issues/126) - -## 0.6.9 *January 29th 2016* -* New features: - * Support for `Debug.Trace.trace`, thanks to @ggreif - -* Fixes bugs: - * `case undefined of ...` should reduce to `undefined` [#116](https://github.com/clash-lang/clash-compiler/issues/109) - * VHDL/SystemVerilog: BlockRAM elements must be bit vectors [#113](https://github.com/clash-lang/clash-compiler/issues/113) - * Type families obscure eligibility for synthesis [#114](https://github.com/clash-lang/clash-compiler/issues/114) - -## 0.6.8 *January 13th 2016* -* New features: - * Support for Haskell's: `Char`, `Int8`, `Int16`, `Int32`, `Int64`, `Word`, `Word8`, `Word16`, `Word32`, `Word64`. - * Int/Word/Integer bitwidth for generated HDL is configurable using the `-clash-intwidth=N` flag, where `N` can be either 32 or 64. -* Fixes bugs: - * Cannot reduce `case error ... of ...` to `error ...` [#109](https://github.com/clash-lang/clash-compiler/issues/109) - -## 0.6.7 *December 21st 2015* -* Support for `unbound-generics-0.3` -* New features: - * Only look for 'topEntity' in the root module. [#22](https://github.com/clash-lang/clash-compiler/issues/22) -* Fixes bugs: - * Unhelpful error message when GHC is not in PATH [#104](https://github.com/clash-lang/clash-compiler/issues/104) - -## 0.6.6 *December 11th 2015* -* New features: - * Remove all existing HDL files before generating new ones. This can be disabled by the `-clash-noclean` flag. [#96](https://github.com/clash-lang/clash-compiler/issues/96) - * Support for `clash-prelude` 0.10.4 - -## 0.6.5 *November 17th 2015* -* Fixes bugs: - * Integer literals used as arguments not always properly annotated with their type. - * Verilog: Name collision in verilog code [#93](https://github.com/clash-lang/clash-compiler/issues/93) - * (System)Verilog: Integer literals missing "32'sd" prefix when used in assignments. - * VHDL: Integer literals should only be capped to 32-bit when used in assignments. - * Verilog: HO-primitives incorrect for nested vectors. - -## 0.6.4 *November 12th 2015* -* Fixes bugs: - * Reversing alternatives is not meaning preserving for literal patterns [#91](https://github.com/clash-lang/clash-compiler/issues/91) - * DEC: root of the case-tree must contain at least 2 alternatives [#92](https://github.com/clash-lang/clash-compiler/issues/92) - * Do not generate overlapping literal patterns in VHDL [#91](https://github.com/clash-lang/clash-compiler/issues/91) - -## 0.6.3 *October 24th 2015* -* New features: - * Improve DEC transformation: consider alternatives before the subject when checking for disjoint expressions. -* Fixes bugs: - * DEC: don't generate single-branch case-expressions [#90](https://github.com/clash-lang/clash-compiler/issues/90) - -## 0.6.2 *October 21st 2015* -* New features: - * Support `clash-prelude` 0.10.2 - -* Fixes bugs: - * CLaSH interpreter was reading '.ghci' file instead of '.clashi' file [#87](https://github.com/clash-lang/clash-compiler/issues/87) - * DEC: Subject and alternatives are not disjoint [#88](https://github.com/clash-lang/clash-compiler/issues/88) - -## 0.6.1 *October 16th 2015* -* New features: - * Support for `clash-prelude` 0.10.1 - * Transformation that lifts applications of the same function out of alternatives of case-statements. e.g. - - ```haskell - case x of - A -> f 3 y - B -> f x x - C -> h x - ``` - - is transformed into: - - ```haskell - let f_arg0 = case x of {A -> 3; B -> x} - f_arg1 = case x of {A -> y; B -> x} - f_out = f f_arg0 f_arg1 - in case x of - A -> f_out - B -> f_out - C -> h x - ``` - -* Fixes bugs: - * clash won't run when not compiled with usual ghc [#82](https://github.com/clash-lang/clash-compiler/issues/82) - * Fail to generate VHDL with blockRamFile' in clash-ghc 0.6 [#85](https://github.com/clash-lang/clash-compiler/issues/85) - * Case-statements acting like normal decoder circuits are erroneously synthesised to priority decoder circuits. - -## 0.6 *October 3rd 2015* -* New features: - * Support `clash-prelude-0.10` - * Pattern matching on `CLaSH.Sized.Vector`'s `:>` is now supported - * Unroll "definitions" of the following primitives: `fold`, `dfold`, `foldr` - -## 0.5.15 *September 21st 2015* -* New features: - * Report simulation time in (System)Verilog assert messages - -* Fixes bugs: - * Performance bug: top-level definitions of type "Signal" erroneously inlined. - * Fix Index maxBound [#79](https://github.com/clash-lang/clash-compiler/pull/79) - -## 0.5.14 *September 14th 2015* -* New features: - * Completely unroll "definitions" of some higher-order primitives with non-representable argument or result vectors: - It is now possible to translate e.g. `f xs ys = zipWith ($) (map (+) xs) ys :: Vec 4 Int -> Vec 4 Int -> Vec 4 Int` - -* Fixes bugs: - * Converting Bool to Unsigned generates broken VHDL [#77](https://github.com/clash-lang/clash-compiler/issues/77) - * `topLet` transformation erroneously not performed in a top-down traversal - * Specialisation limit unchecked on types and constants - * Vector of functions cannot be translated [#25](https://github.com/clash-lang/clash-compiler/issues/25 ) - * CLaSH fails to generate VHDL when map is applied [#78](https://github.com/clash-lang/clash-compiler/issues/78) - -## 0.5.13 *September 8th 2015* -* Fixes bugs: - * Cannot translate GHC `MachLabel` literal - * Maybe (Index n) not translatable to VHDL [#75](https://github.com/clash-lang/clash-compiler/issues/75) - -## 0.5.12 *September 7th 2015* -* New features: - * Modest compilation time speed-up. Compilation time of the [I2C](https://github.com/clash-lang/clash-compiler/tree/master/examples/i2c) module on my machine went down from 43s to 24s, and maximum memory usage went down from 840 MB to 700 MB. - -* Fixes bugs: - * Bug in VHDL ROM generation [#69](https://github.com/clash-lang/clash-compiler/issues/69) - * Clash running out of memory on Simple-ish project [#70](https://github.com/clash-lang/clash-compiler/issues/70) - * Fix asyncRom VHDL primitive [#71](https://github.com/clash-lang/clash-compiler/pull/71) - * Fix primitive for CLaSH.Sized.Internal.Signed.size# [#72](https://github.com/clash-lang/clash-compiler/pull/72) - * rem and quot on Signed are broken [#73](https://github.com/clash-lang/clash-compiler/issues/73) - -## 0.5.11 *August 2nd 2015* -* New features: - * Re-enable GHC's strictness analysis pass, which improves dead-code removal, which hopefully leads to smaller circuits. - -## 0.5.10 *July 9th 2015* -* New features: - * Use new VHDL backend which outputs VHDL-93 instead of VHDL-2002: generated VHDL is now accepted by a larger number of tools. - * Treat all so-called bottom values (`error "FOO"`, `let x = x in x`, etc.) occuring in installed libraries as `undefined`. - Before, there were (very) rare situations where we couldn't find the expressions belonging to a function and demanded a BlackBox, even though we knew the expression would be a bottom value. - Now, we stop demanding a BlackBox for such a function and simply treat it as `undefined`, thus allowing a greater range of circuit descriptions that we can compile. - -## 0.5.9 *June 26th 2015* -* New features: - * Use new verilog backend which outputs Verilog-2001 instead of Verilog-2005: generated Verilog is now accepted by Altera/Quartus - -* Fixes bugs: - * `--systemverilog` switch incorrectly generates verilog code instead of systemverilog code - -## 0.5.8 *June 25th 2015* -* New features: - * Support for copying string literals from Haskell to generated code - * Support `clash-prelude-0.9` - * Size at below which functions are always inlined is configurable, run with `-clash-inline-below=N` to set the size limit to `N` - -## 0.5.7 *June 3rd 2015* -* New features: - * New Verilog backend, run `:verilog` in interactive mode, or `--verilog` for batch mode - * Generated component names are prefixed by the name of the module containing the `topEntity` - -## 0.5.6 *May 18th 2015* -* New features: - * Inlining limit is configurable, run with `-clash-inline-limit=N` to set the inlining limit to `N` - * Specialisation limit is configurable, run with `clash-spec-limit=N` to set the inline limit to `N` - * Debug level is configurable, run with `-clash-debug ` where `` can be: `DebugNone, DebugFinal, DebugName, DebugApplied, DebugAll`. Be default, `clash` runs with `DebugNone`. - -* Fixes bugs: - * Extend evaluator for `GHC.Integer.Type.minusInteger` and `CLaSH.Promoted.Nat.SNat`. - -## 0.5.5 *May 5th 2015* -* New features: - * `TopEntity` wrappers are now specified as `ANN` annotation pragmas [#42](https://github.com/clash-lang/clash-compiler/issues/42) - -## 0.5.4 *May 1st 2015* -* New features: - * Generate wrappers around `topEntity` that have constant names and types - -## 0.5.3 *April 24th 2015* -* Fixes bugs: - * Fix bug where not enough array type definitions were created by the VHDL backend - -## 0.5.2 *April 21st 2015* -* Use latest ghc-typelits-natnormalise - -## 0.5.1 *April 20th 2015* -* New features: - * GHC 7.10 support - * Update to clash-prelude 0.7.2 - * Use http://hackage.haskell.org/package/ghc-typelits-natnormalise typechecker plugin for better type-level natural number handling - -## 0.5 *March 11th 2015* -* New features: - * SystemVerilog backend. [#45](https://github.com/clash-lang/clash-compiler/issues/45) - -## 0.4.1 *February 4th 2015* -* Include bug fixes from clash-lib 0.4.1 - -## 0.4 *November 17th 2014* -* New features: - * Support for clash-prelude 0.6 - -* Fixes bugs: - * clash-ghc ignores "-package-db" flag [#35](https://github.com/christiaanb/clash2/issues/35) - -## 0.3.3 *August 12th 2014* -* Fixes bugs: - * Compile with GHC 7.8.3 [#31](https://github.com/christiaanb/clash2/issues/31) - -## 0.3.2 *June 5th 2014* - -* Fixes bugs: - * Type synonym improperly expanded [#17](https://github.com/christiaanb/clash2/issues/17) - * BlackBox for `Signed` `maxBound` and `minBound` generate incorrect VHDL. [#19](https://github.com/christiaanb/clash2/issues/19) - * Generate failure code in the VHDL for recSelError [#23](https://github.com/christiaanb/clash2/issues/23) - -## 0.3.1 *May 15th 2014* - -* New features: - * Hardcode `fromInteger` for `Signed` and `Unsigned` [#9](https://github.com/christiaanb/clash2/issues/9) - * Better blackbox operation for vindex [#12](https://github.com/christiaanb/clash2/issues/12) - * Replace VHDL default hole by error hole [#13](https://github.com/christiaanb/clash2/issues/13) - -* Fixes bugs: - * Update GHC2Core.hs [#1](https://github.com/christiaanb/clash2/issues/1) - * primitives (clash.sized.vector) [#2](https://github.com/christiaanb/clash2/issues/2) - * Type families are not expanded [#3](https://github.com/christiaanb/clash2/issues/3) - * Incorrect vhdl generation for default value in blackbox [#6](https://github.com/christiaanb/clash2/issues/6) - * Missing begin keyword in Signed/Unsigned JSON files [#16](https://github.com/christiaanb/clash2/issues/16) diff --git a/clash-ghc.cabal b/clash-ghc.cabal --- a/clash-ghc.cabal +++ b/clash-ghc.cabal @@ -1,5 +1,6 @@ +Cabal-version: 2.2 Name: clash-ghc -Version: 1.0.1 +Version: 1.2.0 Synopsis: CAES Language for Synchronous Hardware Description: Clash is a functional hardware description language that borrows both its @@ -29,10 +30,10 @@ * Clash Compiler binary using GHC/Haskell as a frontend . . - Prelude library: -Homepage: http://www.clash-lang.org/ -bug-reports: http://github.com/clash-lang/clash-compiler/issues -License: BSD2 + Prelude library: +Homepage: https://clash-lang.org/ +bug-reports: https://github.com/clash-lang/clash-compiler/issues +License: BSD-2-Clause License-file: LICENSE Author: The Clash Authors Maintainer: QBayLogic B.V. @@ -46,14 +47,12 @@ CHANGELOG.md, LICENSE_GHC, cbits/PosixSource.h, - src-bin-821/Clash/GHCi/HsVersions.h src-bin-841/Clash/GHCi/HsVersions.h -Cabal-version: >=1.10 - source-repository head type: git location: https://github.com/clash-lang/clash-compiler.git + subdir: clash-ghc flag dynamic description: @@ -85,39 +84,48 @@ extra-libraries: pthread default-language: Haskell2010 +common common-options + default-language: Haskell2010 + default-extensions: BangPatterns + BinaryLiterals + DataKinds + DefaultSignatures + DeriveDataTypeable + DeriveFoldable + DeriveFunctor + DeriveGeneric + DeriveLift + DeriveTraversable + DerivingStrategies + InstanceSigs + KindSignatures + ScopedTypeVariables + StandaloneDeriving + TupleSections + TypeApplications + TypeOperators + ViewPatterns + + if impl(ghc >= 8.6) + default-extensions: NoStarIsType + library + import: common-options HS-Source-Dirs: src-ghc, src-bin-common - -- when we move to `cabal-version: 2.2`, we can use elif instead of these nested ifs, but ghc-8.2 comes with cabal-2.0 if impl(ghc >= 8.7.0) - HS-Source-Dirs: src-bin-881 - else - if impl(ghc >= 8.6.0) - HS-Source-Dirs: src-bin-861 - else - if impl(ghc >= 8.4.1) - HS-Source-Dirs: src-bin-841 - else - if impl(ghc >= 8.2.1) - HS-Source-Dirs: src-bin-821 + HS-Source-Dirs: src-bin-881 + elif impl(ghc >= 8.6.0) + HS-Source-Dirs: src-bin-861 + elif impl(ghc >= 8.4.1) + HS-Source-Dirs: src-bin-841 - default-language: Haskell2010 - GHC-Options: -Wall -fno-warn-name-shadowing + GHC-Options: -Wall CPP-Options: -DGHCI - default-extensions: ForeignFunctionInterface - UnboxedTuples - FlexibleInstances - MagicHash - CPP - PatternGuards - NondecreasingIndentation other-extensions: FlexibleContexts OverloadedStrings RecordWildCards - ScopedTypeVariables TemplateHaskell - TupleSections - ViewPatterns Build-Depends: array >= 0.4 && < 0.6, base >= 4.10 && < 5, @@ -126,27 +134,28 @@ containers >= 0.5.4.0 && < 0.7, directory >= 1.2 && < 1.4, filepath >= 1.3 && < 1.5, - ghc >= 8.2.0 && < 8.9, + ghc >= 8.4.0 && < 8.9, process >= 1.2 && < 1.7, hashable >= 1.1.2.3 && < 1.4, - haskeline >= 0.7.0.3 && < 0.8, - lens >= 4.0.5 && < 4.19, + haskeline >= 0.7.0.3 && < 0.9, + lens >= 4.10 && < 4.20, mtl >= 2.1.1 && < 2.3, + split >= 0.2.3 && < 0.3, text >= 1.2.2 && < 1.3, transformers >= 0.5.2.0 && < 0.6, unordered-containers >= 0.2.1.0 && < 0.3, - clash-lib >= 1.0 && < 1.1, - clash-prelude >= 1.0 && < 1.1, + clash-lib == 1.2.0, + clash-prelude == 1.2.0, concurrent-supply >= 0.1.7 && < 0.2, - ghc-typelits-extra >= 0.3.1 && < 0.4, + ghc-typelits-extra >= 0.3.2 && < 0.4, ghc-typelits-knownnat >= 0.6 && < 0.8, ghc-typelits-natnormalise >= 0.6 && < 0.8, deepseq >= 1.3.0.2 && < 1.5, time >= 1.4.0.1 && < 1.10, - ghc-boot >= 8.2.0 && < 8.9, + ghc-boot >= 8.4.0 && < 8.9, ghc-prim >= 0.3.1.0 && < 0.6, - ghci >= 8.2.0 && < 8.9, + ghci >= 8.4.0 && < 8.9, uniplate >= 1.6.12 && < 1.8, reflection >= 2.1.2 && < 3.0, integer-gmp >= 1.0.1.0 && < 2.0, @@ -165,6 +174,8 @@ Include-dirs: cbits C-Sources: cbits/hschooks.c + + Autogen-Modules: Paths_clash_ghc Exposed-Modules: Clash.Main diff --git a/src-bin-821/Clash/GHCi/HsVersions.h b/src-bin-821/Clash/GHCi/HsVersions.h deleted file mode 100644 --- a/src-bin-821/Clash/GHCi/HsVersions.h +++ /dev/null @@ -1,68 +0,0 @@ -#ifndef HSVERSIONS_H -#define HSVERSIONS_H - -#if 0 - -IMPORTANT! If you put extra tabs/spaces in these macro definitions, -you will screw up the layout where they are used in case expressions! - -(This is cpp-dependent, of course) - -#endif - -/* Useful in the headers that we share with the RTS */ -#define COMPILING_GHC 1 - -/* Pull in all the platform defines for this build (foo_TARGET_ARCH etc.) */ -/* #include "ghc_boot_platform.h" */ - -/* Pull in the autoconf defines (HAVE_FOO), but don't include - * ghcconfig.h, because that will include ghcplatform.h which has the - * wrong platform settings for the compiler (it has the platform - * settings for the target plat instead). */ -/* #include "ghcautoconf.h" */ - -#define GLOBAL_VAR(name,value,ty) \ -{-# NOINLINE name #-}; \ -name :: IORef (ty); \ -name = Util.global (value); - -#define GLOBAL_VAR_M(name,value,ty) \ -{-# NOINLINE name #-}; \ -name :: IORef (ty); \ -name = Util.globalM (value); - - -#define SHARED_GLOBAL_VAR(name,accessor,saccessor,value,ty) \ -{-# NOINLINE name #-}; \ -name :: IORef (ty); \ -name = Util.sharedGlobal (value) (accessor); \ -foreign import ccall unsafe saccessor \ - accessor :: Ptr (IORef a) -> IO (Ptr (IORef a)); - -#define SHARED_GLOBAL_VAR_M(name,accessor,saccessor,value,ty) \ -{-# NOINLINE name #-}; \ -name :: IORef (ty); \ -name = Util.sharedGlobalM (value) (accessor); \ -foreign import ccall unsafe saccessor \ - accessor :: Ptr (IORef a) -> IO (Ptr (IORef a)); - - -#define ASSERT(e) if debugIsOn && not (e) then (assertPanic __FILE__ __LINE__) else -#define ASSERT2(e,msg) if debugIsOn && not (e) then (assertPprPanic __FILE__ __LINE__ (msg)) else -#define WARN( e, msg ) (warnPprTrace (e) __FILE__ __LINE__ (msg)) $ - --- Examples: Assuming flagSet :: String -> m Bool --- --- do { c <- getChar; MASSERT( isUpper c ); ... } --- do { c <- getChar; MASSERT2( isUpper c, text "Bad" ); ... } --- do { str <- getStr; ASSERTM( flagSet str ); .. } --- do { str <- getStr; ASSERTM2( flagSet str, text "Bad" ); .. } --- do { str <- getStr; WARNM2( flagSet str, text "Flag is set" ); .. } -#define MASSERT(e) ASSERT(e) return () -#define MASSERT2(e,msg) ASSERT2(e,msg) return () -#define ASSERTM(e) do { bool <- e; MASSERT(bool) } -#define ASSERTM2(e,msg) do { bool <- e; MASSERT2(bool,msg) } -#define WARNM2(e,msg) do { bool <- e; WARN(bool, msg) return () } - -#endif /* HsVersions.h */ diff --git a/src-bin-821/Clash/GHCi/UI.hs b/src-bin-821/Clash/GHCi/UI.hs deleted file mode 100644 --- a/src-bin-821/Clash/GHCi/UI.hs +++ /dev/null @@ -1,3893 +0,0 @@ -{-# LANGUAGE BangPatterns #-} -{-# LANGUAGE CPP #-} -{-# LANGUAGE LambdaCase #-} -{-# LANGUAGE MagicHash #-} -{-# LANGUAGE MultiWayIf #-} -{-# LANGUAGE NondecreasingIndentation #-} -{-# LANGUAGE OverloadedStrings #-} -{-# LANGUAGE RecordWildCards #-} -{-# LANGUAGE TupleSections #-} -{-# LANGUAGE ViewPatterns #-} - -{-# OPTIONS -fno-cse #-} --- -fno-cse is needed for GLOBAL_VAR's to behave properly - ------------------------------------------------------------------------------ --- --- GHC Interactive User Interface --- --- (c) The GHC Team 2005-2006 --- ------------------------------------------------------------------------------ - -module Clash.GHCi.UI ( - interactiveUI, - GhciSettings(..), - defaultGhciSettings, - ghciCommands, - ghciWelcomeMsg, - makeHDL - ) where - -#include "HsVersions.h" - --- GHCi -import qualified Clash.GHCi.UI.Monad as GhciMonad ( args, runStmt, runDecls ) -import Clash.GHCi.UI.Monad hiding ( args, runStmt, runDecls ) -import Clash.GHCi.UI.Tags -import Clash.GHCi.UI.Info -import Debugger - --- The GHC interface -import GHCi -import GHCi.RemoteTypes -import GHCi.BreakArray -import DynFlags -import ErrUtils -import GhcMonad ( modifySession ) -import qualified GHC -import GHC ( LoadHowMuch(..), Target(..), TargetId(..), InteractiveImport(..), - TyThing(..), Phase, BreakIndex, Resume, SingleStep, Ghc, - getModuleGraph, handleSourceError ) -import HsImpExp -import HsSyn -import HscTypes ( tyThingParent_maybe, handleFlagWarnings, getSafeMode, hsc_IC, - setInteractivePrintName, hsc_dflags, msObjFilePath ) -import Module -import Name -import Packages ( trusted, getPackageDetails, getInstalledPackageDetails, - listVisibleModuleNames, pprFlag ) -import IfaceSyn ( showToHeader ) -import PprTyThing -import PrelNames -import RdrName ( RdrName, getGRE_NameQualifier_maybes, getRdrName ) -import SrcLoc -import qualified Lexer - -import StringBuffer -import Outputable hiding ( printForUser, printForUserPartWay ) - --- Other random utilities -import BasicTypes hiding ( isTopLevel ) -import Digraph -import Encoding -import FastString -import Linker -import Maybes ( orElse, expectJust ) -import NameSet -import Panic hiding ( showException ) -import Util -import qualified GHC.LanguageExtensions as LangExt - --- Haskell Libraries -import System.Console.Haskeline as Haskeline - -import Control.Applicative hiding (empty) -import Control.DeepSeq (deepseq) -import Control.Monad as Monad -import Control.Monad.IO.Class -import Control.Monad.Trans.Class -import Control.Monad.Trans.Except - -import Data.Array -import qualified Data.ByteString.Char8 as BS -import Data.Char -import Data.Function -import Data.IORef ( IORef, modifyIORef, newIORef, readIORef, writeIORef ) -import Data.List ( find, group, intercalate, intersperse, isPrefixOf, nub, - partition, sort, sortBy ) -import qualified Data.Set as S -import Data.Maybe -import qualified Data.Map as M -import Data.Time.LocalTime ( getZonedTime ) -import Data.Time.Format ( formatTime, defaultTimeLocale ) -import Data.Version ( showVersion ) - -import Exception hiding (catch) -import Foreign hiding (void) -import GHC.Stack hiding (SrcLoc(..)) - -import System.Directory -import System.Environment -import System.Exit ( exitWith, ExitCode(..) ) -import System.FilePath -import System.Info -import System.IO -import System.IO.Error -import System.IO.Unsafe ( unsafePerformIO ) -import System.Process -import Text.Printf -import Text.Read ( readMaybe ) -import Text.Read.Lex (isSymbolChar) - -import Unsafe.Coerce - -#if !defined(mingw32_HOST_OS) -import System.Posix hiding ( getEnv ) -#else -import qualified System.Win32 -#endif - -import GHC.IO.Exception ( IOErrorType(InvalidArgument) ) -import GHC.IO.Handle ( hFlushAll ) -import GHC.TopHandler ( topHandler ) - --- clash additions -import qualified Clash.Backend -import Clash.Backend.SystemVerilog (SystemVerilogState) -import Clash.Backend.VHDL (VHDLState) -import Clash.Backend.Verilog (VerilogState) -import qualified Clash.Driver -import Clash.Driver.Types (ClashOpts (..)) -import Clash.GHC.Evaluator -import Clash.GHC.GenerateBindings -import Clash.GHC.NetlistTypes -import Clash.GHCi.Common -import Clash.Netlist.BlackBox.Types (HdlSyn) -import Clash.Util (clashLibVersion, reportTimeDiff) -import qualified Data.Time.Clock as Clock -import qualified Paths_clash_ghc - -import Clash.Annotations.BitRepresentation.Internal (buildCustomReprs) - ------------------------------------------------------------------------------ - -data GhciSettings = GhciSettings { - availableCommands :: [Command], - shortHelpText :: String, - fullHelpText :: String, - defPrompt :: PromptFunction, - defPromptCont :: PromptFunction - } - -defaultGhciSettings :: IORef ClashOpts -> GhciSettings -defaultGhciSettings opts = - GhciSettings { - availableCommands = ghciCommands opts, - shortHelpText = defShortHelpText, - defPrompt = default_prompt, - defPromptCont = default_prompt_cont, - fullHelpText = defFullHelpText - } - -ghciWelcomeMsg :: String -ghciWelcomeMsg = "Clashi, version " ++ Data.Version.showVersion Paths_clash_ghc.version ++ - " (using clash-lib, version " ++ Data.Version.showVersion clashLibVersion ++ - "):\nhttp://www.clash-lang.org/ :? for help" - -ghciCommands :: IORef ClashOpts -> [Command] -ghciCommands opts = map mkCmd [ - -- Hugs users are accustomed to :e, so make sure it doesn't overlap - ("?", keepGoing help, noCompletion), - ("add", keepGoingPaths addModule, completeFilename), - ("abandon", keepGoing abandonCmd, noCompletion), - ("break", keepGoing breakCmd, completeIdentifier), - ("back", keepGoing backCmd, noCompletion), - ("browse", keepGoing' (browseCmd False), completeModule), - ("browse!", keepGoing' (browseCmd True), completeModule), - ("cd", keepGoing' changeDirectory, completeFilename), - ("check", keepGoing' checkModule, completeHomeModule), - ("continue", keepGoing continueCmd, noCompletion), - ("cmd", keepGoing cmdCmd, completeExpression), - ("ctags", keepGoing createCTagsWithLineNumbersCmd, completeFilename), - ("ctags!", keepGoing createCTagsWithRegExesCmd, completeFilename), - ("def", keepGoing (defineMacro False), completeExpression), - ("def!", keepGoing (defineMacro True), completeExpression), - ("delete", keepGoing deleteCmd, noCompletion), - ("edit", keepGoing' editFile, completeFilename), - ("etags", keepGoing createETagsFileCmd, completeFilename), - ("force", keepGoing forceCmd, completeExpression), - ("forward", keepGoing forwardCmd, noCompletion), - ("help", keepGoing help, noCompletion), - ("history", keepGoing historyCmd, noCompletion), - ("info", keepGoing' (info False), completeIdentifier), - ("info!", keepGoing' (info True), completeIdentifier), - ("issafe", keepGoing' isSafeCmd, completeModule), - ("kind", keepGoing' (kindOfType False), completeIdentifier), - ("kind!", keepGoing' (kindOfType True), completeIdentifier), - ("load", keepGoingPaths loadModule_, completeHomeModuleOrFile), - ("load!", keepGoingPaths loadModuleDefer, completeHomeModuleOrFile), - ("list", keepGoing' listCmd, noCompletion), - ("module", keepGoing moduleCmd, completeSetModule), - ("main", keepGoing runMain, completeFilename), - ("print", keepGoing printCmd, completeExpression), - ("quit", quit, noCompletion), - ("reload", keepGoing' reloadModule, noCompletion), - ("reload!", keepGoing' reloadModuleDefer, noCompletion), - ("run", keepGoing runRun, completeFilename), - ("script", keepGoing' scriptCmd, completeFilename), - ("set", keepGoing setCmd, completeSetOptions), - ("seti", keepGoing setiCmd, completeSeti), - ("show", keepGoing showCmd, completeShowOptions), - ("showi", keepGoing showiCmd, completeShowiOptions), - ("sprint", keepGoing sprintCmd, completeExpression), - ("step", keepGoing stepCmd, completeIdentifier), - ("steplocal", keepGoing stepLocalCmd, completeIdentifier), - ("stepmodule",keepGoing stepModuleCmd, completeIdentifier), - ("type", keepGoing' typeOfExpr, completeExpression), - ("trace", keepGoing traceCmd, completeExpression), - ("undef", keepGoing undefineMacro, completeMacro), - ("unset", keepGoing unsetOptions, completeSetOptions), - ("where", keepGoing whereCmd, noCompletion), - ("vhdl", keepGoingPaths (makeVHDL opts), completeHomeModuleOrFile), - ("verilog", keepGoingPaths (makeVerilog opts), completeHomeModuleOrFile), - ("systemverilog", keepGoingPaths (makeSystemVerilog opts), completeHomeModuleOrFile) - ] ++ map mkCmdHidden [ -- hidden commands - ("all-types", keepGoing' allTypesCmd), - ("complete", keepGoing completeCmd), - ("loc-at", keepGoing' locAtCmd), - ("type-at", keepGoing' typeAtCmd), - ("uses", keepGoing' usesCmd) - ] - where - mkCmd (n,a,c) = Command { cmdName = n - , cmdAction = a - , cmdHidden = False - , cmdCompletionFunc = c - } - - mkCmdHidden (n,a) = Command { cmdName = n - , cmdAction = a - , cmdHidden = True - , cmdCompletionFunc = noCompletion - } - --- We initialize readline (in the interactiveUI function) to use --- word_break_chars as the default set of completion word break characters. --- This can be overridden for a particular command (for example, filename --- expansion shouldn't consider '/' to be a word break) by setting the third --- entry in the Command tuple above. --- --- NOTE: in order for us to override the default correctly, any custom entry --- must be a SUBSET of word_break_chars. -word_break_chars :: String -word_break_chars = spaces ++ specials ++ symbols - -symbols, specials, spaces :: String -symbols = "!#$%&*+/<=>?@\\^|-~" -specials = "(),;[]`{}" -spaces = " \t\n" - -flagWordBreakChars :: String -flagWordBreakChars = " \t\n" - - -keepGoing :: (String -> GHCi ()) -> (String -> InputT GHCi Bool) -keepGoing a str = keepGoing' (lift . a) str - -keepGoing' :: Monad m => (String -> m ()) -> String -> m Bool -keepGoing' a str = a str >> return False - -keepGoingPaths :: ([FilePath] -> InputT GHCi ()) -> (String -> InputT GHCi Bool) -keepGoingPaths a str - = do case toArgs str of - Left err -> liftIO $ hPutStrLn stderr err - Right args -> a args - return False - -defShortHelpText :: String -defShortHelpText = "use :? for help.\n" - -defFullHelpText :: String -defFullHelpText = - " Commands available from the prompt:\n" ++ - "\n" ++ - " evaluate/run \n" ++ - " : repeat last command\n" ++ - " :{\\n ..lines.. \\n:}\\n multiline command\n" ++ - " :add [*] ... add module(s) to the current target set\n" ++ - " :browse[!] [[*]] display the names defined by module \n" ++ - " (!: more details; *: all top-level names)\n" ++ - " :cd change directory to \n" ++ - " :cmd run the commands returned by ::IO String\n" ++ - " :complete [] list completions for partial input string\n" ++ - " :ctags[!] [] create tags file for Vi (default: \"tags\")\n" ++ - " (!: use regex instead of line number)\n" ++ - " :def define command : (later defined command has\n" ++ - " precedence, :: is always a builtin command)\n" ++ - " :edit edit file\n" ++ - " :edit edit last module\n" ++ - " :etags [] create tags file for Emacs (default: \"TAGS\")\n" ++ - " :help, :? display this list of commands\n" ++ - " :info[!] [ ...] display information about the given names\n" ++ - " (!: do not filter instances)\n" ++ - " :issafe [] display safe haskell information of module \n" ++ - " :kind[!] show the kind of \n" ++ - " (!: also print the normalised type)\n" ++ - " :load[!] [*] ... load module(s) and their dependents\n" ++ - " (!: defer type errors)\n" ++ - " :main [ ...] run the main function with the given arguments\n" ++ - " :module [+/-] [*] ... set the context for expression evaluation\n" ++ - " :quit exit GHCi\n" ++ - " :reload[!] reload the current module set\n" ++ - " (!: defer type errors)\n" ++ - " :run function [ ...] run the function with the given arguments\n" ++ - " :script run the script \n" ++ - " :type show the type of \n" ++ - " :type +d show the type of , defaulting type variables\n" ++ - " :type +v show the type of , with its specified tyvars\n" ++ - " :undef undefine user-defined command :\n" ++ - " :! run the shell command \n" ++ - " :vhdl synthesize currently loaded module to vhdl\n" ++ - " :vhdl [] synthesize specified modules/files to vhdl\n" ++ - " :verilog synthesize currently loaded module to verilog\n" ++ - " :verilog [] synthesize specified modules/files to verilog\n" ++ - " :systemverilog synthesize currently loaded module to systemverilog\n" ++ - " :systemverilog [] synthesize specified modules/files to systemverilog\n" ++ - "\n" ++ - " -- Commands for debugging:\n" ++ - "\n" ++ - " :abandon at a breakpoint, abandon current computation\n" ++ - " :back [] go back in the history N steps (after :trace)\n" ++ - " :break [] [] set a breakpoint at the specified location\n" ++ - " :break set a breakpoint on the specified function\n" ++ - " :continue resume after a breakpoint\n" ++ - " :delete delete the specified breakpoint\n" ++ - " :delete * delete all breakpoints\n" ++ - " :force print , forcing unevaluated parts\n" ++ - " :forward [] go forward in the history N step s(after :back)\n" ++ - " :history [] after :trace, show the execution history\n" ++ - " :list show the source code around current breakpoint\n" ++ - " :list show the source code for \n" ++ - " :list [] show the source code around line number \n" ++ - " :print [ ...] show a value without forcing its computation\n" ++ - " :sprint [ ...] simplified version of :print\n" ++ - " :step single-step after stopping at a breakpoint\n"++ - " :step single-step into \n"++ - " :steplocal single-step within the current top-level binding\n"++ - " :stepmodule single-step restricted to the current module\n"++ - " :trace trace after stopping at a breakpoint\n"++ - " :trace evaluate with tracing on (see :history)\n"++ - - "\n" ++ - " -- Commands for changing settings:\n" ++ - "\n" ++ - " :set