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