# `base-orphans`
[![Hackage](https://img.shields.io/hackage/v/base-orphans.svg)][Hackage: base-orphans]
[![Hackage Dependencies](https://img.shields.io/hackage-deps/v/base-orphans.svg)](http://packdeps.haskellers.com/reverse/base-orphans)
[![Haskell Programming Language](https://img.shields.io/badge/language-Haskell-blue.svg)][Haskell.org]
[![BSD3 License](http://img.shields.io/badge/license-MIT-brightgreen.svg)][tl;dr Legal: MIT]
[![Build Status](https://github.com/haskell-compat/base-orphans/workflows/Haskell-CI/badge.svg)](https://github.com/haskell-compat/base-orphans/actions?query=workflow%3AHaskell-CI)

[Hackage: base-orphans]:
  http://hackage.haskell.org/package/base-orphans
  "base-orphans package on Hackage"
[Haskell.org]:
  http://www.haskell.org
  "The Haskell Programming Language"
[tl;dr Legal: MIT]:
  https://tldrlegal.com/license/mit-license
  "MIT License"

## Scope

`base-orphans` defines orphan instances that mimic instances available in later
versions of `base` to a wider (older) range of compilers. `base-orphans` does
not export anything except the orphan instances themselves and complements
[base-compat](http://hackage.haskell.org/package/base-compat).

Note that `base-orphans` doesn't cover every possible instance. See the
[What is not covered](#what-is-not-covered) section for exceptions.

## Usage

To use `base-orphans`, simply `import Data.Orphans ()`.

## What is covered

 * `Alternative`, `MonadPlus`, and `MonadZip` instances for `Proxy`
 * `Alternative`, `Applicative`, `Bounded`, `Data`, `Enum`, `Foldable`, `Functor`, `Ix`, `Monad`, `MonadFix`, `MonadPlus`, `MonadZip`, and `Traversable` instances for data types in `GHC.Generics`
 * `Alternative`, `Eq`, `Ord`, `Read`, `Show`, `Foldable`, and `Traversable` instances for `ZipList`
 * `Applicative` instance for `K1` from `GHC.Generics`
 * `Applicative`, `Bits`, `Bounded`, `Data`, `Enum`, `Eq1`, `FiniteBits`,
   `Floating`, `Foldable`, `Fractional`, `Functor`, `Integral`, `Ix`, `Ord1`,
   `Monad`, `MonadFix`, `MonadZip`, `Monoid`, `Num`, `Read`, `Read1`, `Real`,
   `RealFloat`, `RealFrac`, `Semigroup`, `Show`, `Show1`, `Storable`, and
   `Traversable` instances for `Down`
 * `Applicative` and `Alternative` instances for `ReadP` and `ReadPrec`
 * `Applicative` instance for strict and lazy `ST`
 * `Applicative`, `Foldable`, `Functor`, `Monad`, and `Traversable` instances for `Complex`,
   `Dual`, `First`, `Last`, `Product`, and `Sum`
 * `Bits` instance for `Bool`
 * `Bits`, `Bounded`, and `Integral` instances for `CDev`
 * `Bits`, `Bounded`, `Enum`, `FiniteBits`, `Floating`, `Fractional`, `Integral`, `IsString`, `Ix`, `Num`, `Real`, `RealFloat`, `RealFrac`, and `Storable` instances for `Const` and `Identity`
 * `Data` instances for `All`, `Any`, and `Const`, `IntPtr`, `WordPtr`,
   `WrappedArrow` and `WrappedMonad`
 * `Data`, `MonadFix` and `MonadZip` instances for `Alt`, `Dual`, `First`, `Last`,
   `Product`, and `Sum`
 * `Data` and `IsList` instances for `Version` and `ZipList`
 * `Eq{1,2}`, `Ord{1,2}`, `Show{1,2}`, and `Read{1,2}` instances for `(,,)` and `(,,,)`
 * `Eq` and `Ord` instances for `Control.Exception.ErrorCall`
 * `Eq`, `Ord`, `Read`, and `Show` instances for data types in `GHC.Generics`
 * `Eq`, `Ord`, `Bounded`, `Enum`, and `Ix` instances for `Solo`
 * `Eq1`, `Read1`, and `Show1` instances for `Complex`
 * `Eq1`, `Ord1`, `Read1`, and `Show1` instances for `NonEmpty`
 * `Foldable` instance for `Either`, `(,)` and `Const`
 * `Foldable` and `Traversable` instances for `Alt` from `Data.Monoid`
 * `Functor`, `Applicative`, and `Monad` instances for
   `(,,) a b` and `(,,,) a b c`
 * `Functor` instance for `Handler`, `ArgOrder`, `OptDescr`, and `ArgDescr`
 * `Functor`, `Applicative`, `Alternative`, and `MonadPlus` instances for `ArrowMonad`
 * `Functor`, `Applicative`, `Monad`, `Alternative`, and `MonadPlus` instances
   for `Kleisli`
 * `Ix` instances for tuples of size 6 through 15
 * `Monad` instance for `(,)`
 * `Monad` instance for `WrappedMonad`
 * `MonadFail`, `Monoid`, and `Semigroup` instances for strict `ST`
 * `MonadFix` and `MonadZip` instances for `Complex`
 * `MonadZip` instance for `Maybe`
 * `Monoid`, `Eq`, `Ord`, `Read`, and `Show` instances for `Const`
 * `Monoid` instances for `Identity` and `IO`
 * `Num` instance for `Sum` and `Product`
 * `Read` instance for `Fixed`
 * `Semigroup` instances for `IO`, `Event` and `Lifetime`
 * `Semigroup` instances for `V1`, `U1`, `Par1`, `Rec1`, `K1`, `M1`, `(:*:)`, and `(:.:)` from `GHC.Generics`.
   `Monoid` instances for the same types (except `V1`).
 * `Semigroup` and `Monoid` instances for `Data.Functor.Product` and `Data.Functor.Compose`
 * `Show` instance for `Fingerprint`
 * `Storable` instance for `()`, `Complex`, and `Ratio`
 * `TestEquality` instance for `Compose`
 * `Traversable` instance for `Either`, `(,)` and `Const`
 * `Ord` instance for `TyCon` and `TypeRep`.
 * `Typeable` instance for most data types, typeclasses, and promoted data constructors (when possible)

## What is not covered
`base-orphans` does not define the following instances:

* `Generic` or `Generic1` instances. These can be found in the
  [`Generics.Deriving.Instances`](https://hackage.haskell.org/package/generic-deriving-1.8.0/docs/Generics-Deriving-Instances.html)
  module of the [`generic-deriving`](https://hackage.haskell.org/package/generic-deriving)
  library.
* The `Alternative IO` and `MonadPlus IO` instances. These can be found in the
  [`Control.Monad.Trans.Error`](http://hackage.haskell.org/package/transformers-0.4.3.0/docs/src/Control-Monad-Trans-Error.html#line-69)
  module of the [`transformers`](http://hackage.haskell.org/package/transformers) library.

## Supported versions of GHC/`base`

 * `ghc-9.2.*`  / `base-4.16.*`
 * `ghc-9.0.*`  / `base-4.15.*`
 * `ghc-8.10.*` / `base-4.14.*`
 * `ghc-8.8.*`  / `base-4.13.*`
 * `ghc-8.6.*`  / `base-4.12.*`
 * `ghc-8.4.*`  / `base-4.11.*`
 * `ghc-8.2.*`  / `base-4.10.*`
 * `ghc-8.0.*`  / `base-4.9.*`
 * `ghc-7.10.*` / `base-4.8.*`
 * `ghc-7.8.*`  / `base-4.7.*`
 * `ghc-7.6.*`  / `base-4.6.*`
 * `ghc-7.4.*`  / `base-4.5.*`
 * `ghc-7.2.*`  / `base-4.4.*`
 * `ghc-7.0.*`  / `base-4.3.*`

We also make an attempt to keep `base-orphans` building with GHC HEAD, but due
to its volatility, it may not work at any given point in time. If it doesn't,
please report it!

Patches are welcome; add tests for new code!
