TH: make `Lift` and `TExp` levity-polymorphic
[ghc.git] / libraries / template-haskell / changelog.md
1 # Changelog for [`template-haskell` package](http://hackage.haskell.org/package/template-haskell)
2
3 ## 2.16.0.0 *TBA*
4
5   * Introduce a `liftTyped` method to the `Lift` class and set the default
6     implementations of `lift` in terms of `liftTyped`.
7
8   * Add a `ForallVisT` constructor to `Type` to represent visible, dependent
9     quantification.
10
11   * Introduce support for `Bytes` literals (raw bytes embedded into the output
12     binary)
13
14   * Make the `Lift` typeclass levity-polymorphic and add instances for unboxed
15     tuples, unboxed sums, `Int#`, `Word#`, `Addr#`, `Float#`, and `Double#`.
16
17 ## 2.15.0.0 *TBA*
18
19   * In `Language.Haskell.TH.Syntax`, `DataInstD`, `NewTypeInstD`, `TySynEqn`,
20     and `RuleP` now all have a `Maybe [TyVarBndr]` argument, which contains a
21     list of quantified type variables if an explicit `forall` is present, and
22     `Nothing` otherwise. `DataInstD`, `NewTypeInstD`, `TySynEqn` also now use
23     a single `Type` argument to represent the left-hand-side to avoid
24     malformed type family equations and allow visible kind application.
25
26     Correspondingly, in `Language.Haskell.TH.Lib.Internal`, `pragRuleD`,
27     `dataInstD`, `newtypeInstD`, and `tySynEqn` now all have a
28     `Maybe [TyVarBndrQ]` argument. Non-API-breaking versions of these
29     functions can be found in `Language.Haskell.TH.Lib`. The type signature
30     of `tySynEqn` has also changed from `[TypeQ] -> TypeQ -> TySynEqnQ` to
31     `(Maybe [TyVarBndrQ]) -> TypeQ -> TypeQ -> TySynEqnQ`, for the same reason
32     as in `Language.Haskell.TH.Syntax` above. Consequently, `tySynInstD` also
33     changes from `Name -> TySynEqnQ -> DecQ` to `TySynEqnQ -> DecQ`.
34
35   * Add `Lift` instances for `NonEmpty` and `Void`
36
37 ## 2.14.0.0 *TBA*
38
39   * Introduce an `addForeignFilePath` function, as well as a corresponding
40     `qAddForeignFile` class method to `Quasi`. Unlike `addForeignFile`, which
41     takes the contents of the file as an argument, `addForeignFilePath` takes
42     as an argument a path pointing to a foreign file. A new `addForeignSource`
43     function has also been added which takes a file's contents as an argument.
44
45     The old `addForeignFile` function is now deprecated in favor of
46     `addForeignSource`, and the `qAddForeignFile` method of `Quasi` has been
47     removed entirely.
48
49   * Introduce an `addTempFile` function, as well as a corresponding
50     `qAddTempFile` method to `Quasi`, which requests a temporary file of
51     a given suffix.
52
53   * Add a `ViaStrategy` constructor to `DerivStrategy`.
54
55   * Add support for `-XImplicitParams` via `ImplicitParamT`,
56     `ImplicitParamVarE`, and `ImplicitParamBindD`.
57
58   * Add support for `-XRecursiveDo` via `MDoE` and `RecS`.
59
60 ## 2.13.0.0 *March 2018*
61
62   * Bundled with GHC 8.4.1
63
64   * `Language.Haskell.TH.FamFlavour`, which was deprecated in 2.11,
65     has been removed.
66
67   * Add support for overloaded labels. Introduces `labelE :: String -> ExpQ`.
68
69   * Add `KindQ`, `TyVarBndrQ`, and `FamilyResultSigQ` aliases to
70     `Language.Haskell.TH.Lib`.
71
72   * Add `Language.Haskell.TH.Lib.Internal` module, which exposes some
73     additional functionality that is used internally in GHC's integration
74     with Template Haskell. This is not a part of the public API, and as
75     such, there are no API guarantees for this module from version to version.
76
77   * `MonadIO` is now a superclass of `Quasi`, `qRunIO` has a default
78     implementation `qRunIO = liftIO`
79
80   * Add `MonadIO Q` instance
81
82 ## 2.12.0.0 *July 2017*
83
84   * Bundled with GHC 8.2.1
85
86   * Add support for pattern synonyms. This introduces one new constructor to
87     `Info` (`PatSynI`), two new constructors to `Dec` (`PatSynD` and
88     `PatSynSigD`), and two new data types (`PatSynDir` and `PatSynArgs`),
89     among other changes. (#8761)
90
91   * Add support for unboxed sums. (#12478)
92
93   * Add support for visible type applications. (#12530)
94
95   * Add support for attaching deriving strategies to `deriving` statements
96     (#10598)
97
98   * Add support for `COMPLETE` pragmas. (#13098)
99
100   * `unboxedTupleTypeName` and `unboxedTupleDataName` now work for unboxed
101     0-tuples and 1-tuples (#12977)
102
103   * `Language.Haskell.TH` now reexports all of `Language.Haskell.TH.Lib`.
104     (#12992). This causes `Language.Haskell.TH` to export more types and
105     functions that it did before:
106     - `TExp`, `BangQ`, and `FieldExpQ`
107     - `unboxedTupP`, `unboxedTupE` and `unboundVarE`
108     - `infixLD`, `infixRD`, and `infixND`
109     - `unboxedTupleT` and `wildCardT`
110     - `plainTV` and `kindedTV`
111     - `interruptible` and `funDep`
112     - `valueAnnotation`, `typeAnnotation`, and `moduleAnnotation`
113
114   * Add support for overloaded labels.
115
116 ## 2.11.0.0  *May 2016*
117
118   * Bundled with GHC 8.0.1
119
120   * The compiler can now resolve infix operator fixities in types on its own.
121     The `UInfixT` constructor of `Type` is analoguous to `UInfixE` for expressions
122     and can contain a tree of infix type applications which will be reassociated
123     according to the fixities of the operators. The `ParensT` constructor can be
124     used to explicitly group expressions.
125
126   * Add `namePackage` and `nameSpace`
127
128   * Make `dataToQa` and `dataToExpQ` able to handle `Data` instances whose
129     `toConstr` implementation relies on a function instead of a data
130     constructor (#10796)
131
132   * Add `Show` instances for `NameFlavour` and `NameSpace`
133
134   * Remove `FamilyD` and `FamFlavour`.  Add `DataFamilyD` and `OpenTypeFamilyD`
135     as the representation of data families and open type families
136     respectively. (#6018)
137
138   * Add `TypeFamilyHead` for common elements of `OpenTypeFamilyD` and
139     `ClosedTypeFamilyD` (#10902)
140
141   * The `Strict` datatype was split among different datatypes: three for
142     writing the strictness information of data constructors' fields as denoted
143     in Haskell source code (`SourceUnpackedness` and `SourceStrictness`, as
144     well as `Bang`), and one for strictness information after a constructor is
145     compiled (`DecidedStrictness`). `Strict`, `StrictType` and `VarStrictType`
146     have been deprecated in favor of `Bang`, `BangType` and `VarBangType`.
147     (#10697)
148
149   * Add `reifyConStrictness` to query a data constructor's `DecidedStrictness`
150     values for its fields (#10697)
151
152   * The `ClassOpI`, `DataConI`, and `VarI` constructors no longer have a
153     `Fixity` field. Instead, all `Fixity` information for a given `Name` is
154     now determined through the `reifyFixity` function, which returns `Just` the
155     fixity if there is an explicit fixity declaration for that `Name`, and
156     `Nothing` otherwise (#10704 and #11345)
157
158   * Add `MonadFail Q` instance for GHC 8.0 and later (#11661)
159
160   * Add support for OVERLAP(S/PED/PING) pragmas on instances
161
162
163 ## 2.10.0.0  *Mar 2015*
164
165   * Bundled with GHC 7.10.1
166   * Remove build-dependency on `containers` package
167   * Make `Pred` a type synonym of `Type`, and deprecate `classP`/`equalP` (#7021)
168   * Add support for `LINE` pragma via `prageLineD` and `LineP`
169   * Replace `Int#` with `!Int` in `NameFlavour` constructors
170   * Derive `Generic` for TH types (#9527)
171   * Add `standaloneDerivD` (#8100)
172   * Add support for generic default signatures via `defaultSigD` (#9064)
173   * Add `Lift` instances for `()` and `Rational`
174   * Derive new `Show` and `Data` instances for `Loc`
175   * Derive `Eq` instances for `Loc`, `Info`, and `ModuleInfo`
176   * Make calling conventions available in template haskell consistent
177     with those from GHC (#9703)
178   * Add support for `-XStaticValues` via `staticE`
179   * Add `Ord` instances to TH types
180   * Merge some instances from `th-orphans` (`Ppr` instances for `Lit`
181     and `Loc` as well as `Lift` instances for numeric types
182   * Put parens around `(ty :: kind)` when pretty-printing TH syntax