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