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