ghc-magic-dict-compat: A compatibility layer and GHC plugin for `withDict` from "GHC.Magic.Dict".

[ bsd3, compatibility, library, type-system ] [ Propose Tags ]

Downloads

Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees

Candidates

  • No Candidates
Versions [RSS] 0.0.0.0
Change log CHANGELOG.md
Dependencies base (>=4.7 && <5), dlist, ghc, ghc-prim, ghc-tcplugins-extra [details]
License BSD-3-Clause
Copyright 2023 (c) Hiromi ISHII
Author Hiromi ISHII
Maintainer konn.jinro_at_gmail.com
Category Type System, Compatibility
Home page https://github.com/konn/ghc-magic-dict-compat#readme
Bug tracker https://github.com/konn/ghc-magic-dict-compat/issues
Source repo head: git clone https://github.com/konn/ghc-magic-dict-compat
Uploaded by HiromiIshii at 2023-12-31T08:12:55Z
Distributions NixOS:0.0.0.0
Downloads 45 total (6 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs available [build log]
Last success reported on 2023-12-31 [all 1 reports]

Readme for ghc-magic-dict-compat-0.0.0.0

[back to package description]

ghc-magic-dict-compat - A compatibility layer and GHC Plugin for withDict magic function

Since GHC 9.4, the compiler provides magic type-class WithDict and its member function withDict:

withDict :: 
  forall cls meth {rr} (r :: Type rr).
  WithDict cls meth =>
  meth ->
  (cls => r) ->
  r

This is the much safer version of unsafeCoerce to (unsafely) produce an instance dictionary for singleton classes dynamically - the compiler checks the preconditions statically at the compile time. Although it is potentially unsafe, this combinator is particularly useful when one writes the library manipulating instance dictionary dynamically.

This package provides a thin compatibility layer for withDict from GHC.Magic.Dict for GHC <9.4. The package consists of the following two modules:

  • GHC.Magic.Dict.Compat
  • GHC.Magic.Dict.Plugin

All you have to do is to import GHC.Magic.Dict.Compat and put the following at the top of modules calling withDict:

{-# OPTIONS_GHC -fplugin GHC.Magic.Dict.Plugin #-}

GHC.Magic.Dict.Compat provides a type-class WithDict and withDict combinator for GHC <9.4; it just re-expose them for GHC >= 9.4. For GHC <9.4, user-facing API is almost the same, except for withDict is not a member function of WithDict. This is to prevent user-defined instances of WithDict by imposing unsolvable default signatures for hidden member functions. Still, users can refer to WithDict the constraint and use withDict function almost the same way as in GHC >=9.4, so this subtle difference should not be a big problem.

As users cannot define the instance of WithDict manually, the GHC.Magic.Dict.Compat module alone is not enough. Here, the GHC Plugin GHC.Magic.Dict.Plugin comes into play. For GHC <9.4, the plugin generates the dictionary for WithDict dynamically at the compile time, employing the almost the same logic as GHC >= 9.4. For newer GHC, it does no-op.

Usage

  1. Import withDict (and WithDict if necessary) from GHC.Magic.Dict.Compat
  2. Enable GHC Plugin GHC.Magic.Dict.Plugin either by placing {-# GHC_OPTIONS -fplugin GHC.Magic.Dict.Plugin #-} at the top or adding -fplugin GHC.Magic.Dict.Plugin to ghc-options of the package.

With this, you can freely use withDict both with GHC <9.4 and >=9.4.

Example

{-# LANGUAGE RankNTypes, ScopedTypeVariables, TypeApplications, ConstraintKinds #-}
{-# GHC_OPTIONS -fplugin GHC.Magic.Dict.Plugin #-}
module MyModule where
import GHC.Magic.Dict.Compat

class Given a where
  given :: a

give :: a -> (Given a => r) -> r
give = withDict @(Given a) @a