`th-desugar` release notes
==========================
Version 1.13 [2021.10.30]
-------------------------
* Support GHC 9.2.
* Add support for visible type application in data constructor patterns. As a
result of these changes, the `DConP` constructor now has an extra field to
represent type arguments:
```diff
data DPat
= ...
- | DConP Name [DPat] -- fun (Just x) = ...
+ | DConP Name [DType] [DPat] -- fun (Just @t x) = ...
| ...
```
* Add support for the `e.field` and `(.field)` syntax from the
`OverloadedRecordDot` language extension.
* The `Maybe [DTyVarBndrUnit]` fields in `DInstanceD` and `DStandaloneDerivD`
are no longer used when sweetening. Previously, `th-desugar` would attempt to
sweeten these `DTyVarBndrUnit`s by turning them into a nested `ForallT`, but
GHC 9.2 or later no longer allow this, as they forbid nested `forall`s in
instance heads entirely. As a result, the `Maybe [DTyVarBndrUnit]` fields are
now only useful for functions that consume `DDec`s directly.
* Fix a bug in which desugared GADT constructors would sometimes incorrectly
claim that they were declared infix, despite this not being the case.
Version 1.12 [2021.03.12]
-------------------------
* Support GHC 9.0.
* Add support for explicit specificity. As part of this change,
the way `th-desugar` represents type variable binders has been overhauled:
* The `DTyVarBndr` data type is now parameterized by a `flag` type parameter:
```hs
data DTyVarBndr flag
= DPlainTV Name flag
| DKindedTV Name flag DKind
```
This can be instantiated to `Specificity` (for type variable binders that
can be specified or inferred) or `()` (for type variable binders where
specificity is irrelevant). `DTyVarBndrSpec` and `DTyVarBndrUnit` are also
provided as type synonyms for `DTyVarBndr Specificity` and `DTyVarBndr ()`,
respectively.
* In order to interface with `TyVarBndr` (the TH counterpart to `DTyVarBndr`)
in a backwards-compatible way, `th-desugar` now depends on the
`th-abstraction` library.
* The `ForallVisFlag` has been removed in favor of the new `DForallTelescope`
data type, which not only distinguishes between invisible and visible
`forall`s but also uses the correct type variable flag for invisible type
variables (`Specificity`) and visible type variables (`()`).
* The type of the `dsTvb` is now different on pre-9.0 versions of GHC:
```hs
#if __GLASGOW_HASKELL__ >= 900
dsTvb :: DsMonad q => TyVarBndr flag -> q (DTyVarBndr flag)
#else
dsTvb :: DsMonad q => flag -> TyVarBndr -> q (DTyVarBndr flag)
#endif
```
This is unfortunately required by the fact that prior to GHC 9.0, there is
no `flag` information stored anywhere in a `TyVarBndr`. If you need to use
`dsTvb` in a backward-compatible way, `L.H.TH.Desugar` now provides
`dsTvbSpec` and `dsTvbUnit` functions which specialise `dsTvb` to
particular `flag` types:
```hs
dsTvbSpec :: DsMonad q => TyVarBndrSpec -> q DTyVarBndrSpec
dsTvbUnit :: DsMonad q => TyVarBndrUnit -> q DTyVarBndrUnit
```
* The type of the `getRecordSelectors` function has changed:
```diff
-getRecordSelectors :: DsMonad q => DType -> [DCon] -> q [DLetDec]
+getRecordSelectors :: DsMonad q => [DCon] -> q [DLetDec]
```
The old type signature had a `DType` argument whose sole purpose was to help
determine which type variables were existential, as this information was used
to filter out "naughty" record selectors, like the example below:
```hs
data Some :: (Type -> Type) -> Type where
MkSome :: { getSome :: f a } -> Some f
```
The old implementation of `getRecordSelectors` would not include `getSome` in
the returned list, as its type `f a` mentions an existential type variable,
`a`, that is not mentioned in the return type `Some f`. The new
implementation of `getRecordSelectors`, on the other hand, makes no attempt
to filter out naughty record selectors, so it would include `getSome`.
This reason for this change is ultimately because determining which type
variables are existentially quantified in the context of Template
Haskell is rather challenging in the general case. There are heuristics we
could employ to guess which variables are existential, but we have found
these heuristics difficult to predict (let alone specify). As a result, we
take the slightly less correct (but much easier to explain) approach of
returning all record selectors, regardless of whether they are naughty or not.
* The `conExistentialTvbs` function has been removed. It was horribly buggy,
especially in the presence of GADT constructors. Moreover, this function was
used in the implementation of `getRecordSelectors` function, so bugs in
`conExistentialTvbs` often affected the results of `getRecordSelectors`.
* The types of `decToTH`, `letDecToTH`, and `pragmaToTH` have changed:
```diff
-decToTH :: DDec -> [Dec]
+decToTH :: DDec -> Dec
-letDecToTH :: DLetDec -> Maybe Dec
+letDecToTH :: DLetDec -> Dec
-pragmaToTH :: DPragma -> Maybe Pragma
+pragmaToTH :: DPragma -> Pragma
```
The semantics of `pragmaToTH` have changed accordingly. Previously,
`pragmaToTH` would return `Nothing` when the argument is a `DPragma` that is
not supported on an old version of GHC, but now an error will be thrown
instead. `decToTH` and `letDecToTH`, which transitively invoke `pragmaToTH`,
have had their types updated to accommodate `pragmaToTH`'s type change.
* The type of the `substTyVarBndrs` function has been simplified to avoid the
needless use of continuation-passing style:
```diff
-substTyVarBndrs :: Quasi q => DSubst -> [DTyVarBndr flag] -> (DSubst -> [DTyVarBndr flag] -> q a) -> q a
+substTyVarBndrs :: Quasi q => DSubst -> [DTyVarBndr flag] -> q (DSubst, [DTyVarBndr flag])
```
* `mkDLamEFromDPats` has now generates slightly more direct code for certain
lambda expressions with `@`-patterns. For example, `\x@y -> f x y` would
previously desugar to `\arg -> case arg of { y -> let x = y in f x y }`, but
it now desugars to `\y -> let x = y in f x y`.
* `mkDLamEFromDPats` now requires only a `Quasi` context instead of `DsMonad`.
Version 1.11 [2020.03.25]
-------------------------
* Support GHC 8.10.
* Add support for visible dependent quantification. As part of this change,
the way `th-desugar` represents `forall` and constraint types has been
overhauled:
* The existing `DForallT` constructor has been split into two smaller
constructors:
```diff
data DType
= ...
- | DForallT [DTyVarBndr] DCxt DType
+ | DForallT ForallVisFlag [DTyVarBndr] DType
+ | DConstrainedT DCxt DType
| ...
+data ForallVisFlag
+ = ForallVis
+ | ForallInvis
```
The previous design combined `forall`s and constraints into a single
constructor, while the new design puts them in distinct constructors
`DForallT` and `DConstrainedT`, respectively. The new `DForallT`
constructor also has a `ForallVisFlag` field to distinguish invisible
`forall`s (e.g., `forall a. a`) from visible `forall`s (e.g.,
`forall a -> a`).
* The `unravel` function has been renamed to `unravelDType` and now returns
`(DFunArgs, DType)`, where `DFunArgs` is a data type that represents
the possible arguments in a function type (see the Haddocks for `DFunArgs`
for more details). There is also an `unravelDType` counterpart for `Type`s
named `unravelType`, complete with its own `FunArgs` data type.
`{D}FunArgs` also have some supporting operations, including
`filter{D}VisFunArgs` (to obtain only the visible arguments) and
`ravel{D}Type` (to construct a function type using `{D}FunArgs` and
a return `{D}Type`).
* Support standalone kind signatures by adding a `DKiSigD` constructor to
`DDec`.
* Add `dsReifyType`, `reifyTypeWithLocals_maybe`, and `reifyTypeWithLocals`,
which allow looking up the types or kinds of locally declared entities.
* Fix a bug in which `reifyFixityWithLocals` would not look into local fixity
declarations inside of type classes.
* Fix a bug in which `reifyFixityWithLocals` would return incorrect results
for classes with associated type family defaults.
Version 1.10
------------
* Support GHC 8.8. Drop support for GHC 7.6.
* Add support for visible kind application, type variable `foralls` in `RULES`,
and explicit `forall`s in type family instances. Correspondingly,
* There is now a `DAppKindT` constructor in `DType`.
* Previously, the `DDataInstD` constructor had fields of type `Name` and
`[DType]`. Those have been scrapped in favor of a single field of type
`DType`, representing the application of the data family name (which was
previously the `Name`) to its arguments (which was previously the
`[DType]`).
`DDataInstD` also has a new field of type `Maybe [DTyVarBndr]` to represent
its explicitly quantified type variables (if present).
* Previously, the `DTySynEqn` constructor had a field of type `[DType]`.
That has been scrapped in favor of a field of type `DType`, representing
the application of the type family name (which `DTySynEqn` did not used to
contain!) to its arguments (which was previously the `[DType]`).
`DTySynEqn` also has a new field of type `Maybe [DTyVarBndr]` to represent
its explicitly quantified type variables (if present).
* `DTySynInstD` no longer has a field of type `Name`, as that is redundant
now that each `DTySynEqn` contains the same `Name`.
* There is now a field of type `Maybe [DTyVarBndr]` in the `DRuleP`
constructor to represent bound type variables in `RULES` (if present).
* Add a field of type `Maybe [DTyVarBndr]` to `DInstanceD` and
`DStandaloneDerivD` for optionally quantifying type variables explicitly.
If supplied with a `Just`, this sweetens the instance type to use a `ForallT`
to represent the explicit quantification. This trick is not supported for
`InstanceD` on GHC 8.0 and for `StandaloneDerivD` on GHC 7.10 or 8.0, so be
aware of this limitation if you supply `Just` for this field.
* Add support for desugaring implicit params. This does not involve any changes
to the `th-desugar` AST, as:
* `(?x :: a) => ...` is desugared to `IP "x" a => ...`.
* `id ?x` is desugared to `id (ip @"x")`.
* `let ?x = 42 in ...` is desugared to
`let new_x_val = 42 in bindIP @"x" new_x_val ...` (where `bindIP` is a new
utility function exported by `Language.Haskell.TH.Desugar` on GHC 8.0 or
later).
In order to support this desugaring, the type signatures of `dsLetDec` and
`dsLetDecs` now return `([DLetDec], DExp -> DExp)` instead of just
`[DLetDec]`, where `DExp -> DExp` is the expression which binds the values of
implicit params (e.g., `\z -> bindIP @"x" new_x_val z`) if any are bound.
(If none are bound, this is simply the `id` function.)
* Fix a bug in which `toposortTyVarsOf` would error at runtime if given types
containing `forall`s as arguments.
* Fix a bug in which `fvDType` would return incorrect results if given a type
containing quantified constraints.
* Fix a bug in which `expandType` would not expand type synonyms in the kinds
of type variable binders in `forall`s.
* Fix a bug in which `getRecordSelectors` would omit record selectors from
GADT constructors.
* Fix a bug in which `toposortTyVarsOf` would sometimes not preserve
the left-to-right ordering of `Name`s generated with `qNewName`.
* Locally reified class methods, data constructors, and record selectors now
quantify kind variables properly.
* Desugared ADT constructors now quantify kind variables properly.
* Remove `DPred`, as it has become too similar to `DType`. This also means
that the `DPat` constructors, which previously ended with the suffix `Pa`,
can now use the suffix `P`, mirroring TH.
* The type of `applyDType` has changed from `DType -> [DType] -> DType` to
`DType -> [DTypeArg] -> DType`, where `DTypeArg` is a new data type that
encodes whether an argument is a normal type argument (e.g., the `Int` in
`Maybe Int`) or a visible kind argument (e.g., the `@Type` in
`Proxy @Type Char`). A `TypeArg` data type (which is like `DTypeArg`, but
with `Type`s/`Kind`s instead of `DType`s/`DKind`s) is also provided.
A handful of utility functions for manipulating `TypeArg`s and `DTypeArg`s
are also exported.
* `th-desugar` functions that compute free variables (e.g., `fvDType`) now
return an `OSet`, a variant of `Set` that remembers the order in which
elements were inserted. A consequence of this change is that it fixes a bug
that causes free variables to be computed in different orders depending on
which unique numbers GHC happened to generate internally.
* Substition and type synonym expansion are now more efficient by avoiding
the use of `syb` in inner loops.
Version 1.9
-----------
* Suppose GHC 8.6.
* Add support for `DerivingVia`. Correspondingly, there is now a
`DDerivStrategy` data type.
* Add support for `QuantifiedConstraints`. Correspondingly, there is now a
`DForallPr` constructor in `DPred` to represent quantified constraint types.
* Remove the `DStarT` constructor of `DType` in favor of `DConT ''Type`.
Two utility functions have been added to `Language.Haskell.TH.Desugar` to
ease this transition:
* `isTypeKindName`: returns `True` if the argument `Name` is that
of `Type` or `★` (or `*`, to support older GHCs).
* `typeKindName`: the name of `Type` (on GHC 8.0 or later) or `*` (on older
GHCs).
* `th-desugar` now desugars all data types to GADT syntax. The most significant
API-facing changes resulting from this new design are:
* The `DDataD`, `DDataFamilyD`, and `DDataFamInstD` constructors of `DDec`
now have `Maybe DKind` fields that either have `Just` an explicit return
kind (e.g., the `k -> Type -> Type` in `data Foo :: k -> Type -> Type`)
or `Nothing` (if lacking an explicit return kind).
* The `DCon` constructor previously had a field of type `Maybe DType`, since
there was a possibility it could be a GADT (with an explicit return type)
or non-GADT (without an explicit return type) constructor. Since all data
types are desugared to GADTs now, this field has been changed to be simply
a `DType`.
* The type signature of `dsCon` was previously:
```haskell
dsCon :: DsMonad q => Con -> q [DCon]
```
However, desugaring constructors now needs more information than before,
since GADT constructors have richer type signatures. Accordingly, the type
of `dsCon` is now:
```haskell
dsCon :: DsMonad q
=> [DTyVarBndr] -- ^ The universally quantified type variables
-- (used if desugaring a non-GADT constructor)
-> DType -- ^ The original data declaration's type
-- (used if desugaring a non-GADT constructor).
-> Con -> q [DCon]
```
The `instance Desugar [Con] [DCon]` has also been removed, as the previous
implementation of `desugar` (`concatMapM dsCon`) no longer has enough
information to work.
Some other utility functions have also been added as part of this change:
* A `conExistentialTvbs` function has been introduced to determine the
existentially quantified type variables of a `DCon`. Note that this
function is not 100% accurate—refer to the documentation for
`conExistentialTvbs` for more information.
* A `mkExtraDKindBinders` function has been introduced to turn a data type's
return kind into explicit, fresh type variable binders.
* A `toposortTyVarsOf` function, which finds the free variables of a list of
`DType`s and returns them in a well scoped list that has been sorted in
reverse topological order.
* `th-desugar` now desugars partial pattern matches in `do`-notation and
list/monad comprehensions to the appropriate invocation of `fail`.
(Previously, these were incorrectly desugared into `case` expressions with
incomplete patterns.)
* Add a `mkDLamEFromDPats` function for constructing a `DLamE` expression using
a list of `DPat` arguments and a `DExp` body.
* Add an `unravel` function for decomposing a function type into its `forall`'d
type variables, its context, its argument types, and its result type.
* Export a `substTyVarBndrs` function from `Language.Haskell.TH.Desugar.Subst`,
which substitutes over type variable binders in a capture-avoiding fashion.
* `getDataD`, `dataConNameToDataName`, and `dataConNameToCon` from
`Language.Haskell.TH.Desugar.Reify` now look up local declarations. As a
result, the contexts in their type signatures have been strengthened from
`Quasi` to `DsMonad`.
* Export a `dTyVarBndrToDType` function which converts a `DTyVarBndr` to a
`DType`, which preserves its kind.
* Previously, `th-desugar` would silently accept illegal uses of record
construction with fields that did not belong to the constructor, such as
`Identity { notAField = "wat" }`. This is now an error.
Version 1.8
-----------
* Support GHC 8.4.
* `substTy` now properly substitutes into kind signatures.
* Expose `fvDType`, which computes the free variables of a `DType`.
* Incorporate a `DDeclaredInfix` field into `DNormalC` to indicate if it is
a constructor that was declared infix.
* Implement `lookupValueNameWithLocals`, `lookupTypeNameWithLocals`,
`mkDataNameWithLocals`, and `mkTypeNameWithLocals`, counterparts to
`lookupValueName`, `lookupTypeName`, `mkDataName`, and `mkTypeName` which
have access to local Template Haskell declarations.
* Implement `reifyNameSpace` to determine a `Name`'s `NameSpace`.
* Export `reifyFixityWithLocals` from `Language.Haskell.TH.Desugar`.
* Export `matchTy` (among other goodies) from new module `Language.Haskell.TH.Subst`.
This function matches a type template against a target.
Version 1.7
-----------
* Support for TH's support for `TypeApplications`, thanks to @RyanGlScott.
* Support for unboxed sums, thanks to @RyanGlScott.
* Support for `COMPLETE` pragmas.
* `getRecordSelectors` now requires a list of `DCon`s as an argument. This
makes it easier to return correct record selector bindings in the event that
a record selector appears in multiple constructors. (See
[goldfirere/singletons#180](https://github.com/goldfirere/singletons/issues/180)
for an example of where the old behavior of `getRecordSelectors` went wrong.)
* Better type family expansion (expanding an open type family with variables works now).
Version 1.6
-----------
* Work with GHC 8, with thanks to @christiaanb for getting this change going.
This means that several core datatypes have changed: partcularly, we now have
`DTypeFamilyHead` and fixities are now reified separately from other things.
* `DKind` is merged with `DType`.
* `Generic` instances for everything.
Version 1.5.5
-------------
* Fix issue #34. This means that desugaring (twice) is idempotent over
expressions, after the second time. That is, if you desugar an expression,
sweeten it, desugar again, sweeten again, and then desugar a third time, you
get the same result as when you desugared the second time. (The extra
round-trip is necessary there to make the output smaller in certain common
cases.)
Version 1.5.4.1
---------------
* Fix issue #32, concerning reification of classes with default methods.
Version 1.5.4
-------------
* Added `expandUnsoundly`
Version 1.5.3
-------------
* More `DsMonad` instances, thanks to David Fox.
Version 1.5.2
-------------
* Sweeten kinds more, too.
Version 1.5.1
-------------
* Thanks to David Fox (@ddssff), sweetening now tries to use more of TH's `Type`
constructors.
* Also thanks to David Fox, depend usefully on the th-orphans package.
Version 1.5
-----------
* There is now a facility to register a list of `Dec` that internal reification
should use when necessary. This avoids the user needing to break up their
definition across different top-level splices. See `withLocalDeclarations`.
This has a side effect of changing the `Quasi` typeclass constraint on many
functions to be the new `DsMonad` constraint. Happily, there are `DsMonad`
instances for `Q` and `IO`, the two normal inhabitants of `Quasi`.
* "Match flattening" is implemented! The functions `scExp` and `scLetDec` remove
any nested pattern matches.
* More is now exported from `Language.Haskell.TH.Desugar` for ease of use.
* `expand` can now expand closed type families! It still requires that the
type to expand contain no type variables.
* Support for standalone-deriving and default signatures in GHC 7.10.
This means that there are now two new constructors for `DDec`.
* Support for `static` expressions, which are new in GHC 7.10.
Version 1.4.2
-------------
* `expand` functions now consider open type families, as long as the type
to be expanded has no free variables.
Version 1.4.1
-------------
* Added `Language.Haskell.TH.Desugar.Lift`, which provides `Lift` instances
for all of the th-desugar types, as well as several Template Haskell types.
* Added `applyDExp` and `applyDType` as convenience functions.
Version 1.4.0
-------------
* All `Dec`s can now be desugared, to the new `DDec` type.
* Sweetening `Dec`s that do not exist in GHC 7.6.3- works on a "best effort" basis:
closed type families are sweetened to open ones, and role annotations are dropped.
* `Info`s can now be desugared. Desugaring takes into account GHC bug #8884, which
meant that reifying poly-kinded type families in GHC 7.6.3- was subtly wrong.
* There is a new function `flattenDValD` which takes a binding like
`let (a,b) = foo` and breaks it apart into separate assignments for `a` and `b`.
* There is a new `Desugar` class with methods `desugar` and `sweeten`. See
the documentation in `Language.Haskell.TH.Desugar`.
* Variable names that are distinct in desugared code are now guaranteed to
have distinct answers to `nameBase`.
* Added a new function `getRecordSelectors` that extracts types and definitions
of record selectors from a datatype definition.
Version 1.3.1
-------------
* Update cabal file to include testing files in sdist.
Version 1.3.0
-------------
* Update to work with `type Pred = Type` in GHC 7.9. This changed the
`DPred` type for all GHC versions, though.
Version 1.2.0
-------------
* Generalized interface to allow any member of the `Qausi` class, instead of
just `Q`.
Version 1.1.1
-------------
* Made compatible with HEAD after change in role annotation syntax.
Version 1.1
-----------
* Added module `Language.Haskell.TH.Desugar.Expand`, which allows for expansion
of type synonyms in desugared types.
* Added `Show`, `Typeable`, and `Data` instances to desugared types.
* Fixed bug where an as-pattern in a `let` statement was scoped incorrectly.
* Changed signature of `dsPat` to be more specific to as-patterns; this allowed
for fixing the `let` scoping bug.
* Created new functions `dsPatOverExp` and `dsPatsOverExp` to allow for easy
desugaring of patterns.
* Changed signature of `dsLetDec` to return a list of `DLetDec`s.
* Added `dsLetDecs` for convenience. Now, instead
of using `mapM dsLetDec`, you should use `dsLetDecs`.
Version 1.0
-----------
* Initial release