The prelude-safeenum package

[Tags: bsd3, library]

A redefinition of the Prelude's Enum class in order to render it safe. That is, the Haskell Language Report defines pred, succ, fromEnum, and toEnum to be partial functions when the type is Bounded, but this is unacceptable. We define a new type-class hierarchy for enumeration which is safe and also generalizes to cover types which can only be enumerated in one direction.


[Skip to ReadMe]

Properties

Versions0.1.0, 0.1.0.1, 0.1.1, 0.1.1.1, 0.1.1.2
Change logNone available
Dependenciesbase (<5) [details]
LicenseBSD3
CopyrightCopyright (c) 2012--2013 wren ng thornton
Authorwren ng thornton
Maintainerwren@community.haskell.org
Stabilityprovisional
CategoryPrelude
Home pagehttp://code.haskell.org/~wren/
Source repositoryhead: darcs get http://community.haskell.org/~wren/prelude-safeenum
UploadedWed May 29 23:16:05 UTC 2013 by WrenThornton
DistributionsNixOS:0.1.1.2
Downloads703 total (39 in last 30 days)
Votes
0 []
StatusDocs uploaded by user
Build status unknown [no reports yet]

Modules

[Index]

Flags

NameDescriptionDefaultType
base4base-4.0 emits "Prelude deprecated" messages in order to get people to be explicit about which version of base they use.EnabledAutomatic

Use -f <flag> to enable a flag, or -f -<flag> to disable that flag. More info

Downloads

Maintainers' corner

For package maintainers and hackage trustees

Readme for prelude-safeenum-0.1.0

prelude-safeenum
================

This is a very simple package and should be easy to install. You
should be able to use any of the following standard methods to
install it.

    -- With cabal-install and without the source:
    $> cabal install prelude-safeenum
    
    -- With cabal-install and with the source already:
    $> cd prelude-safeenum
    $> cabal install
    
    -- Without cabal-install, but with the source already:
    $> cd prelude-safeenum
    $> runhaskell Setup.hs configure --user
    $> runhaskell Setup.hs build
    $> runhaskell Setup.hs test
    $> runhaskell Setup.hs haddock --hyperlink-source
    $> runhaskell Setup.hs copy
    $> runhaskell Setup.hs register

The test step is optional and currently does nothing. The Haddock
step is also optional.


Portability
===========

An attempt has been made to keep this library portable; however,
it does rely on a few language extensions. All the required language
extensions are:

    CPP
    GeneralizedNewtypeDeriving
    MagicHash    -- only for GHC
    Trustworthy  -- only for GHC >= 7.1

The GeneralizedNewtypeDeriving extension is used for brevity in
Data.Number.CalkinWilf. If you'd like to use this package with a
compiler that does not support that extension, contact the maintainer
and it can be removed.

This package is only "Trustworthy" rather than "Safe" for two
reasons: (1) Data.Number.CalkinWilf uses GeneralizedNewtypeDeriving,
and (2) Prelude.SafeEnum imports GHC.Exts for build/foldr fusion
and for the Char instances.

----------------------------------------------------------- fin.