de687c64fafc63295ffa3d335c1aa6b7c3d553c1
[ghc.git] / libraries / base / changelog.md
1 # Changelog for [`base` package](http://hackage.haskell.org/package/base)
2
3 ## 4.9.0.0  *TBA*
4
5   * Bundled with GHC 8.0
6
7   * The restore operation provided by `mask` and `uninterruptibleMask` now
8     restores the previous masking state whatever the current masking state is.
9
10   * `Alt`, `Dual`, `First`, `Last`, `Product`, and `Sum` now have `Data`,
11     `MonadZip`, and `MonadFix` instances
12
13   * `Maybe` now has a `MonadZip` instance
14
15   * `All` and `Any` now have `Data` instances
16
17   * `Dual`, `First`, `Last`, `Product`, and `Sum` now have `Foldable` and
18     `Traversable` instances
19
20   * `Dual`, `Product`, and `Sum` now have `Functor`, `Applicative`, and
21     `Monad` instances
22
23   * `(,) a` now has a `Monad` instance
24
25   * `ZipList` now has `Foldable` and `Traversable` instances
26
27   * `Identity` now has a `Monoid` instance
28
29   * `()` now has a `Storable` instance
30
31   * Redundant typeclass constraints have been removed:
32      - `Data.Ratio.{denominator,numerator}` have no `Integral` constraint anymore
33      - **TODO**
34
35   * New `GHC.Generics.packageName` operation
36
37   * New `GHC.Stack.CallStack` data type
38
39   * `Complex` now has `Generic`, `Generic1`, `Functor`, `Foldable`, `Traversable`,
40     `Applicative`, and `Monad` instances
41
42   * `System.Exit.ExitCode` now has a `Generic` instance
43
44   * `Data.Version.Version` now has a `Generic` instance
45
46   * `IO` now has a `Monoid` instance
47
48   * Generalize `Debug.Trace.{traceM, traceShowM}` from `Monad` to `Applicative`
49     (#10023)
50
51   * Generalise `forever` from `Monad` to `Applicative`
52
53   * Exported `GiveGCStats`, `DoCostCentres`, `DoHeapProfile`, `DoTrace`,
54     `RtsTime`, and `RtsNat` from `GHC.RTS.Flags`
55
56   * New function `GHC.IO.interruptible` used to correctly implement
57     `Control.Exception.allowInterrupt` (#9516)
58
59   * Made `PatternMatchFail`, `RecSelError`, `RecConError`, `RecUpdError`,
60     `NoMethodError`, and `AssertionFailed` newtypes (#10738)
61
62   * New module `Control.Monad.IO.Class` (previously provided by `transformers`
63     package). (#10773)
64
65   * The `Generic` instance for `Proxy` is now poly-kinded (#10775)
66
67   * add `Data.List.NonEmpty` and `Data.Semigroup` (to become
68     super-class of `Monoid` in the future). These modules were
69     provided by the `semigroups` package previously. (#10365)
70
71   * Add `URec`, `UAddr`, `UChar`, `UDouble`, `UFloat`, `UInt`, and `UWord` to
72     `GHC.Generics` as part of making GHC generics capable of handling
73     unlifted types (#10868)
74
75   * Keep `shift{L,R}` on `Integer` with negative shift-arguments from
76     segfaulting (#10571)
77
78   * Add `forkOSWithUnmask` to `Control.Concurrent`, which is like
79     `forkIOWithUnmask`, but the child is run in a bound thread.
80
81   * The `MINIMAL` definition of `Arrow` is now `arr AND (first OR (***))`.
82
83   * The `MINIMAL` definition of `ArrowChoice` is now `left OR (+++)`.
84
85 ## 4.8.2.0  *Oct 2015*
86
87   * Bundled with GHC 7.10.3
88
89   * The restore operation provided by `mask` and `uninterruptibleMask` now
90     restores the previous masking state whatever the current masking state is.
91
92   * Exported `GiveGCStats`, `DoCostCentres`, `DoHeapProfile`, `DoTrace`,
93     `RtsTime`, and `RtsNat` from `GHC.RTS.Flags`
94
95 ## 4.8.1.0  *Jul 2015*
96
97   * Bundled with GHC 7.10.2
98
99   * `Lifetime` is now exported from `GHC.Event`
100
101   * Implicit-parameter based source location support exposed in `GHC.SrcLoc`.
102     See GHC User's Manual for more information.
103
104 ## 4.8.0.0  *Mar 2015*
105
106   * Bundled with GHC 7.10.1
107
108   * Make `Applicative` a superclass of `Monad`
109
110   * Add reverse application operator `Data.Function.(&)`
111
112   * Add `Data.List.sortOn` sorting function
113
114   * Add `System.Exit.die`
115
116   * Deprecate `versionTags` field of `Data.Version.Version`.
117     Add `makeVersion :: [Int] -> Version` constructor function to aid
118     migration to a future `versionTags`-less `Version`.
119
120   * Add `IsList Version` instance
121
122   * Weaken RealFloat constraints on some `Data.Complex` functions
123
124   * Add `Control.Monad.(<$!>)` as a strict version of `(<$>)`
125
126   * The `Data.Monoid` module now has the `PolyKinds` extension
127     enabled, so that the `Monoid` instance for `Proxy` are polykinded
128     like `Proxy` itself is.
129
130   * Make `abs` and `signum` handle (-0.0) correctly per IEEE-754.
131
132   * Re-export `Data.Word.Word` from `Prelude`
133
134   * Add `countLeadingZeros` and `countTrailingZeros` methods to
135     `Data.Bits.FiniteBits` class
136
137   * Add `Data.List.uncons` list destructor (#9550)
138
139   * Export `Monoid(..)` from `Prelude`
140
141   * Export `Foldable(..)` from `Prelude`
142     (hiding `fold`, `foldl'`, `foldr'`, and `toList`)
143
144   * Export `Traversable(..)` from `Prelude`
145
146   * Set fixity for `Data.Foldable.{elem,notElem}` to match the
147     conventional one set for `Data.List.{elem,notElem}` (#9610)
148
149   * Turn `toList`, `elem`, `sum`, `product`, `maximum`, and `minimum`
150     into `Foldable` methods (#9621)
151
152   * Replace the `Data.List`-exported functions
153
154     ```
155     all, and, any, concat, concatMap, elem, find, product, sum,
156     mapAccumL, mapAccumR
157     ```
158
159     by re-exports of their generalised `Data.Foldable`/`Data.Traversable`
160     counterparts.  In other words, unqualified imports of `Data.List`
161     and `Data.Foldable`/`Data.Traversable` no longer lead to conflicting
162     definitions. (#9586)
163
164   * New (unofficial) module `GHC.OldList` containing only list-specialised
165     versions of the functions from `Data.List` (in other words, `GHC.OldList`
166     corresponds to `base-4.7.0.2`'s `Data.List`)
167
168   * Replace the `Control.Monad`-exported functions
169
170     ```
171     sequence_, msum, mapM_, forM_,
172     forM, mapM, sequence
173     ```
174
175     by re-exports of their generalised `Data.Foldable`/`Data.Traversable`
176     counterparts.  In other words, unqualified imports of `Control.Monad`
177     and `Data.Foldable`/`Data.Traversable` no longer lead to conflicting
178     definitions. (#9586)
179
180   * Generalise `Control.Monad.{when,unless,guard}` from `Monad` to
181     `Applicative` and from `MonadPlus` to `Alternative` respectively.
182
183   * Generalise `Control.Monad.{foldM,foldM_}` to `Foldable`
184
185   * `scanr`, `mapAccumL` and `filterM` now take part in list fusion (#9355,
186     #9502, #9546)
187
188   * Remove deprecated `Data.OldTypeable` (#9639)
189
190   * New module `Data.Bifunctor` providing the `Bifunctor(bimap,first,second)`
191     class (previously defined in `bifunctors` package) (#9682)
192
193   * New module `Data.Void` providing the canonical uninhabited type `Void`
194     (previously defined in `void` package) (#9814)
195
196   * Update Unicode class definitions to Unicode version 7.0
197
198   * Add `Alt`, an `Alternative` wrapper, to `Data.Monoid`. (#9759)
199
200   * Add `isSubsequenceOf` to `Data.List` (#9767)
201
202   * The arguments to `==` and `eq` in `Data.List.nub` and `Data.List.nubBy`
203     are swapped, such that `Data.List.nubBy (<) [1,2]` now returns `[1]`
204     instead of `[1,2]` (#2528, #3280, #7913)
205
206   * New module `Data.Functor.Identity` (previously provided by `transformers`
207     package). (#9664)
208
209   * Add `scanl'`, a strictly accumulating version of `scanl`, to `Data.List`
210     and `Data.OldList`. (#9368)
211
212   * Add `fillBytes` to `Foreign.Marshal.Utils`.
213
214   * Add new `displayException` method to `Exception` typeclass. (#9822)
215
216   * Add `Data.Bits.toIntegralSized`, a size-checked version of
217     `fromIntegral`. (#9816)
218
219   * New module `Numeric.Natural` providing new `Natural` type
220     representing non-negative arbitrary-precision integers.  The `GHC.Natural`
221     module exposes additional GHC-specific primitives. (#9818)
222
223   * Add `(Storable a, Integeral a) => Storable (Ratio a)` instance (#9826)
224
225   * Add `Storable a => Storable (Complex a)` instance (#9826)
226
227   * New module `GHC.RTS.Flags` that provides accessors to runtime flags.
228
229   * Expose functions for per-thread allocation counters and limits in `GHC.Conc`
230
231         disableAllocationLimit :: IO ()
232         enableAllocationLimit :: IO ()
233         getAllocationCounter :: IO Int64
234         setAllocationCounter :: Int64 -> IO ()
235
236     together with a new exception `AllocationLimitExceeded`.
237
238   * Make `read . show = id` for `Data.Fixed` (#9240)
239
240   * Add `calloc` and `callocBytes` to `Foreign.Marshal.Alloc`. (#9859)
241
242   * Add `callocArray` and `callocArray0` to `Foreign.Marshal.Array`. (#9859)
243
244   * Restore invariant in `Data (Ratio a)` instance (#10011)
245
246   * Add/expose `rnfTypeRep`, `rnfTyCon`, `typeRepFingerprint`, and
247     `tyConFingerprint` helpers to `Data.Typeable`.
248
249   * Define proper `MINIMAL` pragma for `class Ix`. (#10142)
250
251 ## 4.7.0.2  *Dec 2014*
252
253   * Bundled with GHC 7.8.4
254
255   * Fix performance bug in `Data.List.inits` (#9345)
256
257   * Fix handling of null bytes in `Debug.Trace.trace` (#9395)
258
259 ## 4.7.0.1  *Jul 2014*
260
261   * Bundled with GHC 7.8.3
262
263   * Unhide `Foreign.ForeignPtr` in Haddock (#8475)
264
265   * Fix recomputation of `TypeRep` in `Typeable` type-application instance
266     (#9203)
267
268   * Fix regression in Data.Fixed Read instance (#9231)
269
270   * Fix `fdReady` to honor `FD_SETSIZE` (#9168)
271
272 ## 4.7.0.0  *Apr 2014*
273
274   * Bundled with GHC 7.8.1
275
276   * Add `/Since: 4.[4567].0.0/` Haddock annotations to entities
277     denoting the package version, when the given entity was introduced
278     (or its type signature changed in a non-compatible way)
279
280   * The `Control.Category` module now has the `PolyKinds` extension
281     enabled, meaning that instances of `Category` no longer need be of
282     kind `* -> * -> *`.
283
284   * There are now `Foldable` and `Traversable` instances for `Either a`,
285    `Const r`, and `(,) a`.
286
287   * There are now `Show`, `Read`, `Eq`, `Ord`, `Monoid`, `Generic`, and
288     `Generic1` instances for `Const`.
289
290   * There is now a `Data` instance for `Data.Version`.
291
292   * A new `Data.Bits.FiniteBits` class has been added to represent
293     types with fixed bit-count. The existing `Bits` class is extended
294     with a `bitSizeMaybe` method to replace the now obsolete
295     `bitsize` method.
296
297   * `Data.Bits.Bits` gained a new `zeroBits` method which completes the
298     `Bits` API with a direct way to introduce a value with all bits cleared.
299
300   * There are now `Bits` and `FiniteBits` instances for `Bool`.
301
302   * There are now `Eq`, `Ord`, `Show`, `Read`, `Generic`. and `Generic1`
303     instances for `ZipList`.
304
305   * There are now `Eq`, `Ord`, `Show` and `Read` instances for `Down`.
306
307   * There are now `Eq`, `Ord`, `Show`, `Read` and `Generic` instances
308     for types in GHC.Generics (`U1`, `Par1`, `Rec1`, `K1`, `M1`,
309     `(:+:)`, `(:*:)`, `(:.:)`).
310
311   * `Data.Monoid`: There are now `Generic` instances for `Dual`, `Endo`,
312     `All`, `Any`, `Sum`, `Product`, `First`, and `Last`; as well as
313     `Generic1` instances for `Dual`, `Sum`, `Product`, `First`, and `Last`.
314
315   * The `Data.Monoid.{Product,Sum}` newtype wrappers now have `Num` instances.
316
317   * There are now `Functor` instances for `System.Console.GetOpt`'s
318     `ArgOrder`, `OptDescr`, and `ArgDescr`.
319
320   * A zero-width unboxed poly-kinded `Proxy#` was added to
321     `GHC.Prim`. It can be used to make it so that there is no the
322     operational overhead for passing around proxy arguments to model
323     type application.
324
325   * New `Data.Proxy` module providing a concrete, poly-kinded proxy type.
326
327   * New `Data.Coerce` module which exports the new `Coercible` class
328     together with the `coerce` primitive which provide safe coercion
329     (wrt role checking) between types with same representation.
330
331   * `Control.Concurrent.MVar` has a new implementation of `readMVar`,
332     which fixes a long-standing bug where `readMVar` is only atomic if
333     there are no other threads running `putMVar`.  `readMVar` now is
334     atomic, and is guaranteed to return the value from the first
335     `putMVar`.  There is also a new `tryReadMVar` which is a
336     non-blocking version.
337
338   * New `Control.Concurrent.MVar.withMVarMasked` which executes
339     `IO` action with asynchronous exceptions masked in the same style
340     as the existing `modifyMVarMasked` and `modifyMVarMasked_`.
341
342   * New `threadWait{Read,Write}STM :: Fd -> IO (STM (), IO ())`
343     functions added to `Control.Concurrent` for waiting on FD
344     readiness with STM actions.
345
346   * Expose `Data.Fixed.Fixed`'s constructor.
347
348   * There are now byte endian-swapping primitives
349     `byteSwap{16,32,64}` available in `Data.Word`, which use
350     optimized machine instructions when available.
351
352   * `Data.Bool` now exports `bool :: a -> a -> Bool -> a`, analogously
353     to `maybe` and `either` in their respective modules.
354
355   * `Data.Either` now exports `isLeft, isRight :: Either a b -> Bool`.
356
357   * `Debug.Trace` now exports `traceId`, `traceShowId`, `traceM`,
358     and `traceShowM`.
359
360   * `Data.Functor` now exports `($>)` and `void`.
361
362   * Rewrote portions of `Text.Printf`, and made changes to `Numeric`
363     (added `Numeric.showFFloatAlt` and `Numeric.showGFloatAlt`) and
364     `GHC.Float` (added `formatRealFloatAlt`) to support it.  The
365     rewritten version is extensible to user types, adds a "generic"
366     format specifier "`%v`", extends the `printf` spec to support much
367     of C's `printf(3)` functionality, and fixes the spurious warnings
368     about using `Text.Printf.printf` at `(IO a)` while ignoring the
369     return value.  These changes were contributed by Bart Massey.
370
371   * The minimal complete definitions for all type-classes with cyclic
372     default implementations have been explicitly annotated with the
373     new `{-# MINIMAL #-}` pragma.
374
375   * `Control.Applicative.WrappedMonad`, which can be used to convert a
376     `Monad` to an `Applicative`, has now a
377     `Monad m => Monad (WrappedMonad m)` instance.
378
379   * There is now a `Generic` and a `Generic1` instance for `WrappedMonad`
380     and `WrappedArrow`.
381
382   * Handle `ExitFailure (-sig)` on Unix by killing process with signal `sig`.
383
384   * New module `Data.Type.Bool` providing operations on type-level booleans.
385
386   * Expose `System.Mem.performMinorGC` for triggering minor GCs.
387
388   * New `System.Environment.{set,unset}Env` for manipulating
389     environment variables.
390
391   * Add `Typeable` instance for `(->)` and `RealWorld`.
392
393   * Declare CPP header `<Typeable.h>` officially obsolete as GHC 7.8+
394     does not support hand-written `Typeable` instances anymore.
395
396   * Remove (unmaintained) Hugs98 and NHC98 specific code.
397
398   * Optimize `System.Timeout.timeout` for the threaded RTS.
399
400   * Remove deprecated functions `unsafeInterleaveST`, `unsafeIOToST`,
401     and `unsafeSTToIO` from `Control.Monad.ST`.
402
403   * Add a new superclass `SomeAsyncException` for all asynchronous exceptions
404     and makes the existing `AsyncException` and `Timeout` exception children
405     of `SomeAsyncException` in the hierarchy.
406
407   * Remove deprecated functions `blocked`, `unblock`, and `block` from
408     `Control.Exception`.
409
410   * Remove deprecated function `forkIOUnmasked` from `Control.Concurrent`.
411
412   * Remove deprecated function `unsafePerformIO` export from `Foreign`
413     (still available via `System.IO.Unsafe.unsafePerformIO`).
414
415   * Various fixes and other improvements (see Git history for full details).