e710142a7b053b247810723f2048688d1c80e3db
[phd-thesis.git] / dsl / class.tex
1 \documentclass[../thesis.tex]{subfiles}
2
3 \input{subfilepreamble}
4
5 \begin{document}
6 \input{subfileprefix}
7 \chapter{Deep embedding with class}%
8 \label{chp:classy_deep_embedding}
9
10 \begin{chapterabstract}
11 The two flavours of \gls{DSL} embedding are shallow and deep embedding.
12 In functional languages, shallow embedding models the language constructs as functions in which the semantics are embedded.
13 Adding semantics is therefore cumbersome while adding constructs is a breeze.
14 Upgrading the functions to type classes lifts this limitation to a certain extent.
15
16 Deeply embedded languages represent their language constructs as data and the semantics are functions on it.
17 As a result, the language constructs are embedded in the semantics, hence adding new language constructs is laborious where adding semantics is trouble free.
18
19 This paper shows that by abstracting the semantics functions in deep embedding to type classes, it is possible to easily add language constructs as well.
20 So-called classy deep embedding results in \glspl{DSL} that are extensible both in language constructs and in semantics while maintaining a concrete abstract syntax tree.
21 Additionally, little type-level trickery or complicated boilerplate code is required to achieve this.
22 \end{chapterabstract}
23
24 \section{Introduction}
25 The two flavours of \gls{DSL} embedding are deep and shallow embedding \citep{boulton_experience_1992}.
26 In \gls{FP} languages, shallow embedding models language constructs as functions in the host language.
27 As a result, adding new language constructs---extra functions---is easy.
28 However, the semantics of the language is embedded in these functions, making it troublesome to add semantics since it requires updating all existing language constructs.
29
30 On the other hand, deep embedding models language constructs as data in the host language.
31 The semantics of the language are represented by functions over the data.
32 Consequently, adding new semantics, i.e.\ novel functions, is straightforward.
33 It can be stated that the language constructs are embedded in the functions that form a semantics.
34 If one wants to add a language construct, all semantics functions must be revisited and revised to avoid ending up with partial functions.
35
36 This juxtaposition has been known for many years \citep{reynolds_user-defined_1978} and discussed by many others \citep{krishnamurthi_synthesizing_1998} but most famously dubbed the \emph{expression problem} by Wadler \citep{wadler_expression_1998}:
37
38 \begin{quote}
39 The \emph{expression problem} is a new name for an old problem.
40 The goal is to define a data type by cases, where one can add new cases to the data type and new functions over the data type, without recompiling existing code, and while retaining static type safety (e.g., no casts).
41 \end{quote}
42
43 In shallow embedding, abstracting the functions to type classes disentangles the language constructs from the semantics, allowing extension both ways.
44 This technique is dubbed tagless-final embedding \citep{carette_finally_2009}, nonetheless it is no silver bullet.
45 Some semantics that require an intensional analysis of the syntax tree, such as transformation and optimisations, are difficult to implement in shallow embedding due to the lack of an explicit data structure representing the abstract syntax tree.
46 The semantics of the \gls{DSL} have to be combined and must hold some kind of state or context, so that structural information is not lost \citep{kiselyov_typed_2012}.
47
48 \subsection{Research contribution}
49 This paper shows how to apply the technique observed in tagless-final embedding to deep embedding.
50 The presented basic technique, christened \emph{classy deep embedding}, does not require advanced type system extensions to be used.
51 However, it is suitable for type system extensions such as \glspl{GADT}.
52 While this paper is written as a literate
53 \Gls{HASKELL} \citep{peyton_jones_haskell_2003} program using some minor extensions provided by \gls{GHC} \citep{ghc_team_ghc_2021}, the idea is applicable to other languages as well\footnotemark.
54 \footnotetext{Lubbers, M. (2021): Literate Haskell/lhs2\TeX{} source code of the paper ``Deep Embedding
55 with Class'': TFP 2022.\ DANS.\ \url{https://doi.org/10.5281/zenodo.5081386}.}
56
57 \section{Deep embedding}
58 Pick a \gls{DSL}, any \gls{DSL}, pick the language of literal integers and addition.
59 In deep embedding, terms in the language are represented by data in the host language.
60 Hence, defining the constructs is as simple as creating the following algebraic data type\footnote{All data types and functions are subscripted to indicate the evolution.}.
61
62 \begin{lstHaskellLhstex}
63 data Expr_0
64 = Lit_0 Int
65 | Add_0 Expr_0 Expr_0
66 \end{lstHaskellLhstex}
67
68 Semantics are defined as functions on the \haskelllhstexinline{Expr_0} data type.
69 For example, a function transforming the term to an integer---an evaluator---is implemented as follows.
70
71 \begin{lstHaskellLhstex}
72 eval_0 :: Expr_0 -> Int
73 eval_0 (Lit_0 e) = e
74 eval_0 (Add_0 e1 e2) = eval_0 e1 + eval_0 e2
75 \end{lstHaskellLhstex}
76
77 Adding semantics---e.g.\ a printer---just means adding another function while the existing functions remain untouched.
78 I.e.\ the key property of deep embedding.
79 The following function, transforming the \haskelllhstexinline{Expr_0} data type to a string, defines a simple printer for our language.
80
81 \begin{lstHaskellLhstex}
82 print_0 :: Expr_0 -> String
83 print_0 (Lit_0 v) = show v
84 print_0 (Add_0 e1 e2) = "(" ++ print_0 e1 ++ "-" ++ print_0 e2 ++ ")"
85 \end{lstHaskellLhstex}
86
87 While the language is concise and elegant, it is not very expressive.
88 Traditionally, extending the language is achieved by adding a case to the \haskelllhstexinline{Expr_0} data type.
89 So, adding subtraction to the language results in the following revised data type.
90
91 \begin{lstHaskellLhstex}
92 data Expr_0
93 = Lit_0 Int
94 | Add_0 Expr_0 Expr_0
95 | Sub_0 Expr_0 Expr_0
96 \end{lstHaskellLhstex}
97
98 Extending the \gls{DSL} with language constructs exposes the Achilles' heel of deep embedding.
99 Adding a case to the data type means that all semantics functions have become partial and need to be updated to be able to handle this new case.
100 This does not seem like an insurmountable problem, but it does pose a problem if either the functions or the data type itself are written by others or are contained in a closed library.
101
102 \section{Shallow embedding}
103 Conversely, let us see how this would be done in shallow embedding.
104 First, the data type is represented by functions in the host language with embedded semantics.
105 Therefore, the evaluators for literals and addition both become a function in the host language as follows.
106
107 \begin{lstHaskellLhstex}
108 type Sem_s = Int
109
110 lit_s :: Int -> Sem_s
111 lit_s i = i
112
113 add_s :: Sem_s -> Sem_s -> Sem_s
114 add_s e1 e2 = e1 + e2
115 \end{lstHaskellLhstex}
116
117 Adding constructions to the language is done by adding functions.
118 Hence, the following function adds subtraction to our language.
119
120 \begin{lstHaskellLhstex}
121 sub_s :: Sem_s -> Sem_s -> Sem_s
122 sub_s e1 e2 = e1 - e2
123 \end{lstHaskellLhstex}
124
125 Adding semantics on the other hand---e.g.\ a printer---is not that simple because the semantics are part of the functions representing the language constructs.
126 One way to add semantics is to change all functions to execute both semantics at the same time.
127 In our case this means changing the type of \haskelllhstexinline{Sem_s} to be \haskelllhstexinline{(Int, String)} so that all functions operate on a tuple containing the result of the evaluator and the printed representation at the same time. %chktex 36
128 Alternatively, a single semantics can be defined that represents a fold over the language constructs \citep{gibbons_folding_2014}, delaying the selection of semantics to the moment the fold is applied.
129
130 \subsection{Tagless-final embedding}\label{sec:tagless-final_embedding}
131 Tagless-final embedding overcomes the limitations of standard shallow embedding.
132 To upgrade to this embedding technique, the language constructs are changed from functions to type classes.
133 For our language this results in the following type class definition.
134
135 \begin{lstHaskellLhstex}
136 class Expr_t s where
137 lit_t :: Int -> s
138 add_t :: s -> s -> s
139 \end{lstHaskellLhstex}
140
141 Semantics become data types implementing these type classes, resulting in the following instance for the evaluator\footnotemark.
142 \footnotetext{%
143 In this case \haskelllhstexinline{newtype}s are used instead of regular \haskelllhstexinline{data} declarations.
144 A \haskelllhstexinline{newtype} is a special data type with a single constructor containing a single value only to which it is isomorphic.
145 It allows the programmer to define separate class instances that the instances of the isomorphic type without any overhead.
146 During compilation the constructor is completely removed \citep[\citesection{4.2.3}]{peyton_jones_haskell_2003}.
147 }
148
149 \begin{lstHaskellLhstex}
150 newtype Eval_t = E_t Int
151
152 instance Expr_t Eval_t where
153 lit_t v = E_t v
154 add_t (E_t e1) (E_t e2) = E_t (e1 + e2)
155 \end{lstHaskellLhstex}
156
157 Adding constructs---e.g.\ subtraction---just results in an extra type class and corresponding instances.
158
159 \begin{lstHaskellLhstex}
160 class Sub_t s where
161 sub_t :: s -> s -> s
162
163 instance Sub_t Eval_t where
164 sub_t (E_t e1) (E_t e2) = E_t (e1 - e2)
165 \end{lstHaskellLhstex}
166
167 Finally, adding semantics such as a printer over the language is achieved by providing a data type representing the semantics accompanied by instances for the language constructs.
168
169 \begin{lstHaskellLhstex}
170 newtype Printer_t = P_t String
171
172 instance Expr_t Printer_t where
173 lit_t i = P_t (show i)
174 add_t (P_t e1) (P_t e2) = P_t ("(" ++ e1 ++ "+" ++ e2 ++ ")")
175
176 instance Sub_t Printer_t where
177 sub_t (P_t e1) (P_t e2) = P_t ("(" ++ e1 ++ "-" ++ e2 ++ ")")
178 \end{lstHaskellLhstex}
179
180 \section{Lifting the backends}%
181 Let us rethink the deeply embedded \gls{DSL} design.
182 Remember that in shallow embedding, the semantics are embedded in the language construct functions.
183 Obtaining extensibility both in constructs and semantics was accomplished by abstracting the semantics functions to type classes, making the constructs overloaded in the semantics.
184 In deep embedding, the constructs are embedded in the semantics functions instead.
185 So, let us apply the same technique, i.e.\ make the semantics overloaded in the language constructs by abstracting the semantics functions to type classes.
186 The same effect may be achieved when using similar techniques such as explicit dictionary passing or ML style modules.
187 In our language this results in the following type class.
188
189 \begin{lstHaskellLhstex}
190 class Eval_1 v where
191 eval_1 :: v -> Int
192
193 data Expr_1
194 = Lit_1 Int
195 | Add_1 Expr_1 Expr_1
196 \end{lstHaskellLhstex}
197
198 Implementing the semantics type class instances for the \haskelllhstexinline{Expr_1} data type is an elementary exercise.
199 By a copy-paste and some modifications, we come to the following implementation.
200
201 \begin{lstHaskellLhstex}
202 instance Eval_1 Expr_1 where
203 eval_1 (Lit_1 v) = v
204 eval_1 (Add_1 e1 e2) = eval_1 e1 + eval_1 e2
205 \end{lstHaskellLhstex}
206
207 Subtraction can now be defined in a separate data type, leaving the original data type intact.
208 Instances for the additional semantics can now be implemented separately as instances of the type classes.
209
210 \begin{lstHaskellLhstex}
211 data Sub_1 = Sub_1 Expr_1 Expr_1
212
213 instance Eval_1 Sub_1 where
214 eval_1 (Sub_1 e1 e2) = eval_1 e1 - eval_1 e2
215 \end{lstHaskellLhstex}
216
217 \section{Existential data types}%
218
219 The astute reader might have noticed that we have dissociated ourselves from the original data type.
220 It is only possible to create an expression with a subtraction on the top level.
221 The recursive knot is left untied and as a result, \haskelllhstexinline{Sub_1} can never be reached from an \haskelllhstexinline{Expr_1}.
222
223 Luckily, we can reconnect them by adding a special constructor to the \haskelllhstexinline{Expr_1} data type for housing extensions.
224 It contains an existentially quantified \citep{mitchell_abstract_1988} type with type class constraints \citep{laufer_combining_1994,laufer_type_1996} for all semantics type classes \citep[\citesection{6.4.6}]{ghc_team_ghc_2021} to allow it to house not just subtraction but any future extension.
225
226 \begin{lstHaskellLhstex}
227 data Expr_2
228 = Lit_2 Int
229 | Add_2 Expr_2 Expr_2
230 | forall x. Eval_2 x => Ext_2 x
231 \end{lstHaskellLhstex}
232
233 The implementation of the extension case in the semantics type classes is in most cases just a matter of calling the function for the argument as can be seen in the semantics instances shown below.
234
235 \begin{lstHaskellLhstex}
236 instance Eval_2 Expr_2 where
237 eval_2 (Lit_2 v) = v
238 eval_2 (Add_2 e1 e2) = eval_2 e1 + eval_2 e2
239 eval_2 (Ext_2 x) = eval_2 x
240 \end{lstHaskellLhstex}
241
242 Adding language construct extensions in different data types does mean that an extra \haskelllhstexinline{Ext_2} tag is introduced when using the extension.
243 This burden can be relieved by creating a smart constructor for it that automatically wraps the extension with the \haskelllhstexinline{Ext_2} constructor so that it is of the type of the main data type.
244
245 \begin{lstHaskellLhstex}
246 sub_2 :: Expr_2 -> Expr_2 -> Expr_2
247 sub_2 e1 e2 = Ext_2 (Sub_2 e1 e2)
248 \end{lstHaskellLhstex}
249
250 In our example this means that the programmer can write\footnotemark:
251 \footnotetext{%
252 Backticks are used to use functions or constructors in an infix fashion \citep[\citesection{4.3.3}]{peyton_jones_haskell_2003}.
253 }
254 \begin{lstHaskellLhstex}
255 e2 :: Expr_2
256 e2 = Lit_2 42 `sub_2` Lit_2 1
257 \end{lstHaskellLhstex}
258 instead of having to write
259 \begin{lstHaskellLhstex}
260 e2p :: Expr_2
261 e2p = Ext_2 (Lit_2 42 `Sub_2` Lit_2 1)
262 \end{lstHaskellLhstex}
263
264 \subsection{Unbraiding the semantics from the data}
265 This approach does reveal a minor problem.
266 Namely, that all semantics type classes are braided into our datatypes via the \haskelllhstexinline{Ext_2} constructor.
267 Say if we add the printer again, the \haskelllhstexinline{Ext_2} constructor has to be modified to contain the printer type class constraint as well.\footnote{Resulting in the following constructor: \haskelllhstexinline{forall x.(Eval_2 x, Print_2 x) => Ext_2 x}.} %chktex 36
268 Thus, if we add semantics, the main data type's type class constraints in the \haskelllhstexinline{Ext_2} constructor need to be updated.
269 To avoid this, the type classes can be bundled in a type class alias or type class collection as follows.
270
271 \begin{lstHaskellLhstex}
272 class (Eval_2 x, Print_2 x) => Semantics_2 x
273
274 data Expr_2
275 = Lit_2 Int
276 | Add_2 Expr_2 Expr_2
277 | forall x. Semantics_2 x => Ext_2 x
278 \end{lstHaskellLhstex}
279
280 The class alias removes the need for the programmer to visit the main data type when adding additional semantics.
281 Unfortunately, the compiler does need to visit the main data type again.
282 Some may argue that adding semantics happens less frequently than adding language constructs but in reality it means that we have to concede that the language is not as easily extensible in semantics as in language constructs.
283 More exotic type system extensions such as constraint kinds \citep{bolingbroke_constraint_2011,yorgey_giving_2012} can untangle the semantics from the data types by making the data types parametrised by the particular semantics.
284 However, by adding some boilerplate, even without this extension, the language constructs can be parametrised by the semantics by putting the semantics functions in a data type.
285 First the data types for the language constructs are parametrised by the type variable \haskelllhstexinline{d} as follows.
286
287 \begin{lstHaskellLhstex}
288 data Expr_3 d
289 = Lit_3 Int
290 | Add_3 (Expr_3 d) (Expr_3 d)
291 | forall x. Ext_3 (d x) x
292
293 data Sub_3 d = Sub_3 (Expr_3 d) (Expr_3 d)
294 \end{lstHaskellLhstex}
295
296 The \haskelllhstexinline{d} type variable is inhabited by an explicit dictionary for the semantics, i.e.\ a witness to the class instance.
297 Therefore, for all semantics type classes, a data type is made that contains the semantics function for the given semantics.
298 This means that for \haskelllhstexinline{Eval_3}, a dictionary with the function \haskelllhstexinline{EvalDict_3} is defined, a type class \haskelllhstexinline{HasEval_3} for retrieving the function from the dictionary and an instance for \haskelllhstexinline{HasEval_3} for \haskelllhstexinline{EvalDict_3}.
299
300 \begin{lstHaskellLhstex}
301 newtype EvalDict_3 v = EvalDict_3 (v -> Int)
302
303 class HasEval_3 d where
304 getEval_3 :: d v -> v -> Int
305
306 instance HasEval_3 EvalDict_3 where
307 getEval_3 (EvalDict_3 e) = e
308 \end{lstHaskellLhstex}
309
310 The instances for the type classes change as well according to the change in the datatype.
311 Given that there is a \haskelllhstexinline{HasEval_3} instance for the witness type \haskelllhstexinline{d}, we can provide an implementation of \haskelllhstexinline{Eval_3} for \haskelllhstexinline{Expr_3 d}.
312
313 \begin{lstHaskellLhstex}
314 instance HasEval_3 d => Eval_3 (Expr_3 d) where
315 eval_3 (Lit_3 v) = v
316 eval_3 (Add_3 e1 e2) = eval_3 e1 + eval_3 e2
317 eval_3 (Ext_3 d x) = getEval_3 d x
318
319 instance HasEval_3 d => Eval_3 (Sub_3 d) where
320 eval_3 (Sub_3 e1 e2) = eval_3 e1 - eval_3 e2
321 \end{lstHaskellLhstex}
322
323 Because the \haskelllhstexinline{Ext_3} constructor from \haskelllhstexinline{Expr_3} now contains a value of type \haskelllhstexinline{d}, the smart constructor for \haskelllhstexinline{Sub_3} must somehow come up with this value.
324 To achieve this, a type class is introduced that allows the generation of such a dictionary.
325
326 \begin{lstHaskellLhstex}
327 class GDict a where
328 gdict :: a
329 \end{lstHaskellLhstex}
330
331 This type class has individual instances for all semantics dictionaries, linking the class instance to the witness value.
332 I.e.\ if there is a type class instance known, a witness value can be conjured using the \haskelllhstexinline{gdict} function.
333
334 \begin{lstHaskellLhstex}
335 instance Eval_3 v => GDict (EvalDict_3 v) where
336 gdict = EvalDict_3 eval_3
337 \end{lstHaskellLhstex}
338
339 With these instances, the semantics function can be retrieved from the \haskelllhstexinline{Ext_3} constructor and in the smart constructors they can be generated as follows:
340
341 \begin{lstHaskellLhstex}
342 sub_3 :: GDict (d (Sub_3 d)) => Expr_3 d -> Expr_3 d -> Expr_3 d
343 sub_3 e1 e2 = Ext_3 gdict (Sub_3 e1 e2)
344 \end{lstHaskellLhstex}
345
346 Finally, we reached the end goal, orthogonal extension of both language constructs as shown by adding subtraction to the language and in language semantics.
347 Adding the printer can now be done without touching the original code as follows.
348 First the printer type class, dictionaries and instances for \haskelllhstexinline{GDict} are defined.
349
350 \begin{lstHaskellLhstex}
351 class Print_3 v where
352 print_3 :: v -> String
353
354 newtype PrintDict_3 v = PrintDict_3 (v -> String)
355
356 class HasPrint_3 d where
357 getPrint_3 :: d v -> v -> String
358
359 instance HasPrint_3 PrintDict_3 where
360 getPrint_3 (PrintDict_3 e) = e
361
362 instance Print_3 v => GDict (PrintDict_3 v) where
363 gdict = PrintDict_3 print_3
364 \end{lstHaskellLhstex}
365
366 Then the instances for \haskelllhstexinline{Print_3} of all the language constructs can be defined.
367
368 \begin{lstHaskellLhstex}
369 instance HasPrint_3 d => Print_3 (Expr_3 d) where
370 print_3 (Lit_3 v) = show v
371 print_3 (Add_3 e1 e2) = "(" ++ print_3 e1 ++ "+" ++ print_3 e2 ++ ")"
372 print_3 (Ext_3 d x) = getPrint_3 d x
373 instance HasPrint_3 d => Print_3 (Sub_3 d) where
374 print_3 (Sub_3 e1 e2) = "(" ++ print_3 e1 ++ "-" ++ print_3 e2 ++ ")"
375 \end{lstHaskellLhstex}
376
377 \section{Transformation semantics}
378 Most semantics convert a term to some final representation and can be expressed just by functions on the cases.
379 However, the implementation of semantics such as transformation or optimisation may benefit from a so-called intentional analysis of the abstract syntax tree.
380 In shallow embedding, the implementation for these types of semantics is difficult because there is no tangible abstract syntax tree.
381 In off-the-shelf deep embedding this is effortless since the function can pattern match on the constructor or structures of constructors.
382
383 To demonstrate intensional analyses in classy deep embedding we write an optimizer that removes addition and subtraction by zero.
384 In classy deep embedding, adding new semantics means first adding a new type class housing the function including the machinery for the extension constructor.
385
386 \begin{lstHaskellLhstex}
387 class Opt_3 v where
388 opt_3 :: v -> v
389
390 newtype OptDict_3 v = OptDict_3 (v -> v)
391
392 class HasOpt_3 d where
393 getOpt_3 :: d v -> v -> v
394
395 instance HasOpt_3 OptDict_3 where
396 getOpt_3 (OptDict_3 e) = e
397
398 instance Opt_3 v => GDict (OptDict_3 v) where
399 gdict = OptDict_3 opt_3
400 \end{lstHaskellLhstex}
401
402 The implementation of the optimizer for the \haskelllhstexinline{Expr_3} data type is no complicated task.
403 The only interesting bit occurs in the \haskelllhstexinline{Add_3} constructor, where we pattern match on the optimised children to determine whether an addition with zero is performed.
404 If this is the case, the addition is removed.
405
406 \begin{lstHaskellLhstex}
407 instance HasOpt_3 d => Opt_3 (Expr_3 d) where
408 opt_3 (Lit_3 v) = Lit_3 v
409 opt_3 (Add_3 e1 e2) = case (opt_3 e1, opt_3 e2) of
410 (Lit_3 0, e2p ) -> e2p
411 (e1p, Lit_3 0) -> e1p
412 (e1p, e2p ) -> Add_3 e1p e2p
413 opt_3 (Ext_3 d x) = Ext_3 d (getOpt_3 d x)
414 \end{lstHaskellLhstex}
415
416 Replicating this for the \haskelllhstexinline{Opt_3} instance of \haskelllhstexinline{Sub_3} seems a clear-cut task at first glance.
417
418 \begin{lstHaskellLhstex}
419 instance HasOpt_3 d => Opt_3 (Sub_3 d) where
420 opt_3 (Sub_3 e1 e2) = case (opt_3 e1, opt_3 e2) of
421 (e1p, Lit_3 0) -> e1p
422 (e1p, e2p ) -> Sub_3 e1p e2p
423 \end{lstHaskellLhstex}
424
425 Unsurprisingly, this code is rejected by the compiler.
426 When a literal zero is matched as the right-hand side of a subtraction, the left-hand side of type \haskelllhstexinline{Expr_3} is returned.
427 However, the type signature of the function dictates that it should be of type \haskelllhstexinline{Sub_3}.
428 To overcome this problem we add a convolution constructor.
429
430 \subsection{Convolution}
431 Adding a loopback case or convolution constructor to \haskelllhstexinline{Sub_3} allows the removal of the \haskelllhstexinline{Sub_3} constructor while remaining the \haskelllhstexinline{Sub_3} type.
432 It should be noted that a loopback case is \emph{only} required if the transformation actually removes tags.
433 This changes the \haskelllhstexinline{Sub_3} data type as follows.
434
435 \begin{lstHaskellLhstex}
436 data Sub_4 d
437 = Sub_4 (Expr_4 d) (Expr_4 d)
438 | SubLoop_4 (Expr_4 d)
439
440 instance HasEval_4 d => Eval_4 (Sub_4 d) where
441 eval_4 (Sub_4 e1 e2) = eval_4 e1 - eval_4 e2
442 eval_4 (SubLoop_4 e1) = eval_4 e1
443 \end{lstHaskellLhstex}
444
445 With this loopback case in the toolbox, the following \haskelllhstexinline{Sub} instance optimises away subtraction with zero literals.
446
447 \begin{lstHaskellLhstex}
448 instance HasOpt_4 d => Opt_4 (Sub_4 d) where
449 opt_4 (Sub_4 e1 e2) = case (opt_4 e1, opt_4 e2) of
450 (e1p, Lit_4 0) -> SubLoop_4 e1p
451 (e1p, e2p ) -> Sub_4 e1p e2p
452 opt_4 (SubLoop_4 e) = SubLoop_4 (opt_4 e)
453 \end{lstHaskellLhstex}
454
455 \subsection{Pattern matching}
456 Pattern matching within datatypes and from an extension to the main data type works out of the box.
457 Cross-extensional pattern matching on the other hand---matching on a particular extension---is something that requires a bit of extra care.
458 Take for example negation propagation and double negation elimination.
459 Pattern matching on values with an existential type is not possible without leveraging dynamic typing \citep{abadi_dynamic_1991,baars_typing_2002}.
460 To enable dynamic typing support, the \haskelllhstexinline{Typeable} type class as provided by \haskelllhstexinline{Data.Dynamic} \citep{ghc_team_datadynamic_2021} is added to the list of constraints in all places where we need to pattern match across extensions.
461 As a result, the \haskelllhstexinline{Typeable} type class constraints are added to the quantified type variable \haskelllhstexinline{x} of the \haskelllhstexinline{Ext_4} constructor and to \haskelllhstexinline{d}s in the smart constructors.
462
463 \begin{lstHaskellLhstex}
464 data Expr_4 d
465 = Lit_4 Int
466 | Add_4 (Expr_4 d) (Expr_4 d)
467 | forall x. Typeable x => Ext_4 (d x) x
468 \end{lstHaskellLhstex}
469
470 First let us add negation to the language by defining a datatype representing it.
471 Negation elimination requires the removal of negation constructors, so a convolution constructor is defined as well.
472
473 \begin{lstHaskellLhstex}
474 data Neg_4 d
475 = Neg_4 (Expr_4 d)
476 | NegLoop_4 (Expr_4 d)
477
478 neg_4 :: (Typeable d, GDict (d (Neg_4 d))) => Expr_4 d -> Expr_4 d
479 neg_4 e = Ext_4 gdict (Neg_4 e)
480 \end{lstHaskellLhstex}
481
482 The evaluation and printer instances for the \haskelllhstexinline{Neg_4} datatype are defined as follows.
483
484 \begin{lstHaskellLhstex}
485 instance HasEval_4 d => Eval_4 (Neg_4 d) where
486 eval_4 (Neg_4 e) = negate (eval_4 e)
487 eval_4 (NegLoop_4 e) = eval_4 e
488
489 instance HasPrint_4 d => Print_4 (Neg_4 d) where
490 print_4 (Neg_4 e) = "(~" ++ print_4 e ++ ")"
491 print_4 (NegLoop_4 e) = print_4 e
492 \end{lstHaskellLhstex}
493
494 The \haskelllhstexinline{Opt_4} instance contains the interesting bit.
495 If the sub expression of a negation is an addition, negation is propagated downwards.
496 If the sub expression is again a negation, something that can only be found out by a dynamic pattern match, it is replaced by a \haskelllhstexinline{NegLoop_4} constructor.
497
498 \begin{lstHaskellLhstex}
499 instance (Typeable d, GDict (d (Neg_4 d)), HasOpt_4 d) => Opt_4 (Neg_4 d) where
500 opt_4 (Neg_4 (Add_4 e1 e2))
501 = NegLoop_4 (Add_4 (opt_4 (neg_4 e1)) (opt_4 (neg_4 e2)))
502 opt_4 (Neg_4 (Ext_4 d x))
503 = case fromDynamic (toDyn (getOpt_4 d x)) of
504 Just (Neg_4 e) -> NegLoop_4 e
505 _ -> Neg_4 (Ext_4 d (getOpt_4 d x))
506 opt_4 (Neg_4 e) = Neg_4 (opt_4 e)
507 opt_4 (NegLoop_4 e) = NegLoop_4 (opt_4 e)
508 \end{lstHaskellLhstex}
509
510 Loopback cases do make cross-extensional pattern matching less modular in general.
511 For example, \haskelllhstexinline{Ext_4 d (SubLoop_4 (Lit_4 0))} is equivalent to \haskelllhstexinline{Lit_4 0} in the optimisation semantics and would require an extra pattern match.
512 Fortunately, this problem can be mitigated---if required---by just introducing an additional optimisation semantics that removes loopback cases.
513 Luckily, one does not need to resort to these arguably blunt matters often.
514 Dependent language functionality often does not need to span extensions, i.e.\ it is possible to group them in the same data type.
515
516 \subsection{Chaining semantics}
517 Now that the data types are parametrised by the semantics a final problem needs to be overcome.
518 The data type is parametrised by the semantics, thus, using multiple semantics, such as evaluation after optimising is not straightforwardly possible.
519 Luckily, a solution is readily at hand: introduce an ad-hoc combination semantics.
520
521 \begin{lstHaskellLhstex}
522 data OptPrintDict_4 v = OPD_4 (OptDict_4 v) (PrintDict_4 v)
523
524 instance HasOpt_4 OptPrintDict_4 where
525 getOpt_4 (OPD_4 v _) = getOpt_4 v
526 instance HasPrint_4 OptPrintDict_4 where
527 getPrint_4 (OPD_4 _ v) = getPrint_4 v
528
529 instance (Opt_4 v, Print_4 v) => GDict (OptPrintDict_4 v) where
530 gdict = OPD_4 gdict gdict
531 \end{lstHaskellLhstex}
532
533 And this allows us to write \haskelllhstexinline{print_4 (opt_4 e1)} resulting in \verb|"((~42)+(~38))"| when \haskelllhstexinline{e1} represents $(\sim(42+38))-0$ and is thus defined as follows.
534
535 \begin{lstHaskellLhstex}
536 e1 :: Expr_4 OptPrintDict_4
537 e1 = neg_4 (Lit_4 42 `Add_4` Lit_4 38) `sub_4` Lit_4 0
538 \end{lstHaskellLhstex}
539
540 When using classy deep embedding to the fullest, the ability of the compiler to infer very general types expires.
541 As a consequence, defining reusable expressions that are overloaded in their semantics requires quite some type class constraints that cannot be inferred by the compiler (yet) if they use many extensions.
542 Solving this remains future work.
543 For example, the expression $\sim(42-38)+1$ has to be defined as:
544
545 \begin{lstHaskellLhstex}
546 e3 :: (Typeable d, GDict (d (Neg_4 d)), GDict (d (Sub_4 d))) => Expr_4 d
547 e3 = neg_4 (Lit_4 42 `sub_4` Lit_4 38) `Add_4` Lit_4 1
548 \end{lstHaskellLhstex}
549
550 \section{\texorpdfstring{\Glsxtrlongpl{GADT}}{Generalised algebraic data types}}%
551 \Glspl{GADT} are enriched data types that allow the type instantiation of the constructor to be explicitly defined \citep{cheney_first-class_2003,hinze_fun_2003}.
552 Leveraging \glspl{GADT}, deeply embedded \glspl{DSL} can be made statically type safe even when different value types are supported.
553 Even when \glspl{GADT} are not supported natively in the language, they can be simulated using embedding-projection pairs or equivalence types \citep[\citesection{2.2}]{cheney_lightweight_2002}.
554 Where some solutions to the expression problem do not easily generalise to \glspl{GADT} (see \cref{sec:cde:related}), classy deep embedding does.
555 Generalising the data structure of our \gls{DSL} is fairly straightforward and to spice things up a bit, we add an equality and boolean not language construct.
556 To make the existing \gls{DSL} constructs more general, we relax the types of those constructors.
557 For example, operations on integers now work on all numerals instead.
558 Moreover, the \haskelllhstexinline{Lit_g} constructor can be used to lift values of any type to the \gls{DSL} domain as long as they have a \haskelllhstexinline{Show} instance, required for the printer.
559 Since some optimisations on \haskelllhstexinline{Not_g} remove constructors and therefore use cross-extensional pattern matches, \haskelllhstexinline{Typeable} constraints are added to \haskelllhstexinline{a}.
560 Furthermore, because the optimisations for \haskelllhstexinline{Add_g} and \haskelllhstexinline{Sub_g} are now more general, they do not only work for \haskelllhstexinline{Int}s but for any type with a \haskelllhstexinline{Num} instance, the \haskelllhstexinline{Eq} constraint is added to these constructors as well.
561 Finally, not to repeat ourselves too much, we only show the parts that substantially changed.
562 The omitted definitions and implementation can be found in \cref{sec:cde:appendix}.
563
564 \begin{lstHaskellLhstex}
565 data Expr_g d a where
566 Lit_g :: Show a => a -> Expr_g d a
567 Add_g :: (Eq a, Num a) => Expr_g d a -> Expr_g d a -> Expr_g d a
568 Ext_g :: Typeable x => d x -> x a -> Expr_g d a
569 data Neg_g d a where
570 Neg_g :: (Typeable a, Num a) => Expr_g d a -> Neg_g d a
571 NegLoop_g :: Expr_g d a -> Neg_g d a
572 data Not_g d a where
573 Not_g :: Expr_g d Bool -> Not_g d Bool
574 NotLoop_g :: Expr_g d a -> Not_g d a
575 \end{lstHaskellLhstex}
576
577 The smart constructors for the language extensions inherit the class constraints of their data types and include a \haskelllhstexinline{Typeable} constraint on the \haskelllhstexinline{d} type variable for it to be usable in the \haskelllhstexinline{Ext_g} constructor as can be seen in the smart constructor for \haskelllhstexinline{Neg_g}:
578
579 \begin{lstHaskellLhstex}
580 neg_g :: (Typeable d, GDict (d (Neg_g d)), Typeable a, Num a) =>
581 Expr_g d a -> Expr_g d a
582 neg_g e = Ext_g gdict (Neg_g e)
583
584 not_g :: (Typeable d, GDict (d (Not_g d))) =>
585 Expr_g d Bool -> Expr_g d Bool
586 not_g e = Ext_g gdict (Not_g e)
587 \end{lstHaskellLhstex}
588
589 Upgrading the semantics type classes to support \glspl{GADT} is done by an easy textual search and replace.
590 All occurrences of \haskelllhstexinline{v} are now parametrised by type variable \haskelllhstexinline{a}:
591
592 \begin{lstHaskellLhstex}
593 class Eval_g v where
594 eval_g :: v a -> a
595 class Print_g v where
596 print_g :: v a -> String
597 class Opt_g v where
598 opt_g :: v a -> v a
599 \end{lstHaskellLhstex}
600
601 Now that the shape of the type classes has changed, the dictionary data types and the type classes need to be adapted as well.
602 The introduced type variable \haskelllhstexinline{a} is not an argument to the type class, so it should not be an argument to the dictionary data type.
603 To represent this type class function, a rank-2 polymorphic function is needed \citep[\citesection{6.4.15}]{ghc_team_ghc_2021}\citep{odersky_putting_1996}.
604 Concretely, for the evaluatior this results in the following definitions:
605
606 \begin{lstHaskellLhstex}
607 newtype EvalDict_g v = EvalDict_g (forall a. v a -> a)
608 class HasEval_g d where
609 getEval_g :: d v -> v a -> a
610 instance HasEval_g EvalDict_g where
611 getEval_g (EvalDict_g e) = e
612 \end{lstHaskellLhstex}
613
614 The \haskelllhstexinline{GDict} type class is general enough, so the instances can remain the same.
615 The \haskelllhstexinline{Eval_g} instance of \haskelllhstexinline{GDict} looks as follows:
616
617 \begin{lstHaskellLhstex}
618 instance Eval_g v => GDict (EvalDict_g v) where
619 gdict = EvalDict_g eval_g
620 \end{lstHaskellLhstex}
621
622 Finally, the implementations for the instances can be ported without complication show using the optimisation instance of \haskelllhstexinline{Not_g}:
623
624 \begin{lstHaskellLhstex}
625 instance (Typeable d, GDict (d (Not_g d)), HasOpt_g d) => Opt_g (Not_g d) where
626 opt_g (Not_g (Ext_g d x))
627 = case fromDynamic (toDyn (getOpt_g d x)) :: Maybe (Not_g d Bool) of
628 Just (Not_g e) -> NotLoop_g e
629 _ -> Not_g (Ext_g d (getOpt_g d x))
630 opt_g (Not_g e) = Not_g (opt_g e)
631 opt_g (NotLoop_g e) = NotLoop_g (opt_g e)
632 \end{lstHaskellLhstex}
633
634 \section{Conclusion}%
635
636 Classy deep embedding is a novel organically grown embedding technique that alleviates deep embedding from the extensibility problem in most cases.
637
638 By abstracting the semantics functions to type classes they become overloaded in the language constructs.
639 Thus, making it possible to add new language constructs in a separate type.
640 These extensions are brought together in a special extension constructor residing in the main data type.
641 This extension case is overloaded by the language construct using a data type containing the class dictionary.
642 As a result, orthogonal extension is possible for language constructs and semantics using only little syntactic overhead or type annotations.
643 The basic technique only requires---well established through history and relatively standard---existential data types.
644 However, if needed, the technique generalises to \glspl{GADT} as well, adding rank-2 types to the list of type system requirements as well.
645 Finally, the abstract syntax tree remains observable which makes it suitable for intensional analyses, albeit using occasional dynamic typing for truly cross-extensional transformations.
646
647 Defining reusable expressions overloaded in semantics or using multiple semantics on a single expression requires some boilerplate still, getting around this remains future work.
648 \Cref{sec:classy_reprise} shows how the boilerplate can be minimised using advanced type system extensions.
649
650 \section{Related work}%
651 \label{sec:cde:related}
652
653 Embedded \gls{DSL} techniques in functional languages have been a topic of research for many years, thus we do not claim a complete overview of related work.
654
655 Clearly, classy deep embedding bears most similarity to the \emph{Datatypes \`a la Carte} \citep{swierstra_data_2008}.
656 In \citeauthor{swierstra_data_2008}'s approach, semantics are lifted to type classes similarly to classy deep embedding.
657 Each language construct is their own datatype parametrised by a type parameter.
658 This parameter contains some type level representation of language constructs that are in use.
659 In classy deep embedding, extensions only have to be enumerated at the type level when the term is required to be overloaded, in all other cases they are captured in the extension case.
660 Because all the constructs are expressed in the type system, nifty type system tricks need to be employed to convince the compiler that everything is type safe and the class constraints can be solved.
661 Furthermore, it requires some boilerplate code such as functor instances for the data types.
662 In return, pattern matching is easier and does not require dynamic typing.
663 Classy deep embedding only strains the programmer with writing the extension case for the main data type and the occasional loopback constructor.
664
665 \Citet{loh_open_2006} proposed a language extension that allows open data types and open functions, i.e.\ functions and data types that can be extended with more cases later on.
666 They hinted at the possibility of using type classes for open functions but had serious concerns that pattern matching would be crippled because constructors are becoming types, thus ultimately becoming impossible to type.
667 In contrast, this paper shows that pattern matching is easily attainable---albeit using dynamic types---and that the terms can be typed without complicated type system extensions.
668
669 A technique similar to classy deep embedding was proposed by \citet{najd_trees_2017} to tackle a slightly different problem, namely that of reusing a data type for multiple purposes in a slightly different form.
670 For example to decorate the abstract syntax tree of a compiler differently for each phase of the compiler.
671 They propose to add an extension descriptor as a type variable to a data type and a type family that can be used to decorate constructors with extra information and add additional constructors to the data type using an extension constructor.
672 Classy deep embedding works similarly but uses existentially quantified type variables to describe possible extensions instead of type variables and type families.
673 In classy deep embedding, the extensions do not need to be encoded in the type system and less boilerplate is required.
674 Furthermore, pattern matching on extensions becomes a bit more complicated but in return it allows for multiple extensions to be added orthogonally and avoids the necessity for type system extensions.
675
676 Tagless-final embedding is the shallowly embedded counterpart of classy deep embedding and was invented for the same purpose; overcoming the issues with standard shallow embedding \citep{carette_finally_2009}.
677 Classy deep embedding was organically grown from observing the evolution of tagless-final embedding.
678 The main difference between tagless-final embedding and classy deep embedding---and in general between shallow and deep embedding---is that intensional analyses of the abstract syntax tree is more difficult because there is no tangible abstract syntax tree data structure.
679 In classy deep embedding, it is possible to define transformations even across extensions.
680 Furthermore, in classy deep embedding, defining (mutual) dependent interpretations is automatically supported whereas in tagless-final embedding this requires some amount of code duplication \citep{sun_compositional_2022}.
681
682 Hybrid approaches between deep and shallow embedding exist as well.
683 For example, \citet{svenningsson_combining_2013} show that by expressing the deeply embedded language in a shallowly embedded core language, extensions can be made orthogonally as well.
684 This paper differs from those approaches in the sense that it does not require a core language in which all extensions need to be expressible.
685
686 \subsection{Comparison}
687 \todo[inline]{text moet beter}
688 No \gls{DSL} embedding technique is the silver bullet.
689 \Citet{sun_compositional_2022} provided a thorough comparison of embedding techniques including more axes than just the two stated in the expression problem.
690
691 \Cref{tbl:dsl_comparison_brief} shows a variant of their comparison table.
692 The first two rows describe the two axes of the original expression problem and the third row describes theadded axis of modular dependency handling as stated by \citeauthor{sun_compositional_2022}.
693 The \emph{poly.} style of embedding---including tagless-final---falls short of this requirement.
694
695 Intensional analysis is an umbrella term for pattern matching and transformations.
696 In shallow embedding, intensional analysis is more complex and requires stateful views describing context but it is possible to implement though.
697
698 Simple type system describes the whether it is possible to encode this embedding technique with many type system extensions.
699 In classy deep embedding, there is either a bit more scaffolding and boilerplate required or advanced type system extensions need to be used.
700
701 Little boilerplate denotes the amount of scaffolding and boilerplate required.
702 For example, hybrid embedding requires a transcoding step between the deep syntax and the shallow core language.
703
704 \begin{table}[ht]
705 \begin{threeparttable}[b]
706 \small
707 \caption{Comparison of embedding techniques, extended from \citet[\citesection{3.6}]{sun_compositional_2022}.}%
708 \label{tbl:dsl_comparison_brief}
709 \begin{tabular}{llllllll}
710 \toprule
711 & Shallow & Deep & Hybrid
712 & Poly. & Comp. & \`a la
713 & Classy\\
714 \midrule
715 Extend constructs & \CIRCLE{} & \Circle{} & \LEFTcircle{}\tnote{1}
716 & \CIRCLE{} & \CIRCLE{} & \CIRCLE{}
717 & \CIRCLE{}\\
718 Extend views & \Circle{} & \CIRCLE{} & \CIRCLE{}
719 & \CIRCLE{} & \CIRCLE{} & \CIRCLE{}
720 & \CIRCLE{}\\
721 Modular dependencies & \Circle{} & \CIRCLE{} & \CIRCLE{}
722 & \Circle{} & \CIRCLE{} & \CIRCLE{}
723 & \CIRCLE{}\\
724 Intensional analysis & \LEFTcircle{}\tnote{2} & \CIRCLE{} & \CIRCLE{}
725 & \LEFTcircle{}\tnote{2} & \LEFTcircle{}\tnote{2} & \CIRCLE{}
726 & \LEFTcircle{}\tnote{3}\\
727 Simple type system & \CIRCLE{} & \CIRCLE{} & \Circle{}
728 & \CIRCLE{} & \CIRCLE{} & \Circle{}
729 & \LEFTcircle{}\tnote{4}\\
730 Little boilerplate & \CIRCLE{} & \CIRCLE{} & \Circle{}
731 & \CIRCLE{} & \CIRCLE{} & \Circle{}
732 & \LEFTcircle{}\tnote{4}\\
733 \bottomrule
734 \end{tabular}
735 \begin{tablenotes}
736 \item [1] Only if the extension is expressible in the core language.
737 \item [2] Requires ingenuity and are sometimes awkward to write.
738 \item [3] Cross-extensional pattern matching requires \emph{safe} dynamic typing.
739 \item [4] Either a simple type system or little boilerplate.
740 \end{tablenotes}
741 \end{threeparttable}
742 \end{table}
743
744 \section*{Acknowledgements}
745 This research is partly funded by the Royal Netherlands Navy.
746 Furthermore, I would like to thank Pieter and Rinus for the fruitful discussions, Ralf for inspiring me to write a functional pearl, and the anonymous reviewers for their valuable and honest comments.
747
748 \begin{subappendices}
749 \section{Reprise: reducing boilerplate}%
750 \label{sec:classy_reprise}
751 One of the unique selling points of this novel \gls{DSL} embedding technique is that it, in its basic form, does not require advanced type system extensions nor a lot of boilerplate.
752 However, generalising the technique to \glspl{GADT} arguably unleashes a cesspool of \emph{unsafe} compiler extensions.
753 If we are willing to work with extensions, almost all of the boilerplate can be inferred or generated.
754
755 In classy deep embedding, the \gls{DSL} datatype is parametrised by a type variable providing a witness to the interpretation on the language.
756 When using multiple interpretations, these need to be bundled in a data type.
757 Using the \gls{GHC}'s \GHCmod{ConstraintKind} extension, we can make these witnesses explicit, tying into \gls{HASKELL}'s type system immediately.
758 Furthermore, this constraint does not necessarily has to be a single constraint, after enabling \GHCmod{DataKinds} and \GHCmod{TypeOperators}, we can encode lists of witnesses instead.
759 The data type for this list of witnesses is \haskelllhstexinline{Record} as shown in \cref{lst_cbde:record_type}.
760 This \gls{GADT} is parametrised by two type variables.
761 The first type variable (\haskelllhstexinline{dt}) is the type or type constructor on which the constraints can be applied and the second type variable (\haskelllhstexinline{clist}) is the list of constraints constructors itself.
762 This means that when \haskelllhstexinline{Cons} is pattern matched, the overloading of the type class constraint for \haskelllhstexinline{c dt} can be solved by the compiler.
763 \GHCmod{KindSignatures} is used to force the kinds of the type parameters and the kind of \haskelllhstexinline{dt} is polymorphic (\GHCmod{PolyKinds}) so that the \haskelllhstexinline{Record} data type can be used for \glspl{DSL} using type classes but also type constructor classes (e.g.\ when using \glspl{GADT}).
764
765 \begin{lstHaskellLhstex}[label={lst_cbde:record_type},caption={Data type for a list of constraints}]
766 data Record (dt :: k) (clist :: [k -> Constraint]) where
767 Nil :: Record dt '[]
768 Cons :: c dt => Record dt cs -> Record dt (c ': cs)
769 \end{lstHaskellLhstex}
770
771 To incorporate this type in the \haskelllhstexinline{Expr} type, the \haskelllhstexinline{Ext} constructor changes from containing a single witness dictionary to a \haskelllhstexinline{Record} type containing all the required dictionaries.
772
773 \begin{lstHaskellLhstex}[caption={Data type for a list of constraints}]
774 data Expr c
775 = Lit Int
776 | Add (Expr c) (Expr c)
777 | Ext (Record x c) x
778 \end{lstHaskellLhstex}
779
780 Furthermore, we define a type class (\haskelllhstexinline{In}) that allows us to extract explicit dictionaries \haskelllhstexinline{Dict} from these records if the constraint can is present in the list.
781 Since the constraints become available as soon as the \haskelllhstexinline{Cons} constructor is matched, the implementation is a trivial type-level list traversal.
782
783 \begin{lstHaskellLhstex}[caption={Membership functions for constraints}]
784 class c `In` cs where
785 project :: Record dt cs -> Dict (c dt)
786 instance {-# OVERLAPPING #-} c `In` (c ': cs) where
787 project (Cons _) = Dict
788 instance {-# OVERLAPPING #-} c `In` cs => c `In` (b ': cs) where
789 project (Cons xs) = project xs
790 \end{lstHaskellLhstex}
791
792 The final scaffolding is a multi-parameter type class \haskelllhstexinline{CreateRecord} (requiring the \GHCmod{MultiParamTypeclasses} and \GHCmod{FlexibleInstances} extension) to create these \haskelllhstexinline{Record} witnesses automatically.
793 This type class creates a record structure cons by cons if and only if all type class constraints are available in the list of constraints.
794 It is not required to provide instances for this for specific records or type classes, the two instances describe all the required constraints.
795
796 \begin{lstHaskellLhstex}[caption={Membership functions for constraints}]
797 class CreateRecord dt c where
798 createRecord :: Record dt c
799 instance CreateRecord d '[] where
800 createRecord = Nil
801 instance (c (d c0), CreateRecord (d c0) cs) =>
802 CreateRecord (d c0) (c ': cs) where
803 createRecord = Cons createRecord
804 \end{lstHaskellLhstex}
805
806 The class constraints for the interpretation instances can now be greatly simplified, as shown in the evaluation instance for \haskelllhstexinline{Expr}.
807 The implementation remains the same, only that for the extension case, a trick needs to be applied to convince the compiler of the correct instances.
808 Using \haskelllhstexinline{`In`}'s \haskelllhstexinline{project} function, a dictionary can be brought into scope.
809 This dictionary can then subsequently be used to apply the type class function on the extension using the \haskelllhstexinline{withDict} function from the \haskelllhstexinline{Data.Constraint} library.\footnote{\haskelllhstexinline{withDict :: Dict c -> (c => r) -> r}}
810 The \GHCmod{ScopedTypeVariables} extension is used to make sure the existentially quantified type variable for the extension is matched to the type of the dictionary.
811 Furthermore, because the class constraint is not smaller than the instance head, \GHCmod{UndecidableInstances} should be enabled.
812
813 \begin{lstHaskellLhstex}
814 class Eval v where
815 eval :: v -> Int
816
817 instance Eval `In` s => Eval (Expr s) where
818 eval (Lit i) = i
819 eval (Add l r) = eval l + eval r
820 eval (Ext r (e :: x)) = withDict (project r :: Dict (Eval x)) eval e
821 \end{lstHaskellLhstex}
822
823 Smart constructors need to be adapted as well, as can be seen from the smart constructor \haskelllhstexinline{subst}.
824 Instead of a \haskelllhstexinline{GDict} class constraint, a \haskelllhstexinline{CreateRecord} class constraint needs to be added.
825
826 \begin{lstHaskellLhstex}
827 subst :: (Typeable c, CreateRecord (Subt c) c)
828 => Expr c -> Expr c -> Expr c
829 subst l r = Ext createRecord (l `Subt` r)
830 \end{lstHaskellLhstex}
831
832 Finally, defining terms in the language can be done immediately if the interpretations are known.
833 For example, if we want to print and/or optimise the term $\displaystyle ~(~(42+(38-4)))$, we can define it as follows:
834
835 \begin{lstHaskellLhstex}
836 e0 :: Expr '[Print,Opt]
837 e0 = neg (neg (Lit 42 `Add` (Lit 38 `subt` Lit 4)))
838 \end{lstHaskellLhstex}
839
840 It is also possible to define terms in the \gls{DSL} as being overloaded in the interpretation.
841 This does require enumerating all the \haskelllhstexinline{CreateRecord} type classes for every extension in a similar fashion as was required for \haskelllhstexinline{GDict}.
842 At the call site, the concrete list of constraints must be known.
843
844 \begin{lstHaskellLhstex}
845 e1 :: (Typeable c, CreateRecord (Neg c) c, CreateRecord (Subst c) c)
846 => Expr c
847 e1 = neg (neg (Lit 42 `Add` (Lit 38 `subt` Lit 4)))
848 \end{lstHaskellLhstex}
849
850 Finally, using the \GHCmod{TypeFamilies} extension, type families can be created for bundling \haskelllhstexinline{`In`} constraints (\haskelllhstexinline{UsingExt}) and \haskelllhstexinline{CreateRecord} constraints (\haskelllhstexinline{DependsOn}), making the syntax even more descriptive.
851 E.g.\ \haskelllhstexinline{UsingExt '[A, B, C] c} expands to \haskelllhstexinline{(CreateRecord (A c) c, CreateRecord (B c) c, CreateRecord (C c) c)} and \haskelllhstexinline{DependsOn '[A, B, C] s} expands to \haskelllhstexinline{(A `In` s, B `In` s, C `In` s)}.
852
853 \begin{lstHaskellLhstex}
854 type family UsingExt cs c :: Constraint where
855 UsingExt '[] c = ()
856 UsingExt (d ': cs) c = (CreateRecord (d c) c, UsingExt cs c)
857
858 type family DependsOn cs c :: Constraint where
859 DependsOn '[] c = ()
860 DependsOn (d ': cs) c = (d `In` c, DependsOn cs c)
861 \end{lstHaskellLhstex}
862
863 Defining the previous expression can now be done with the following shortened type that describes the semantics better:
864
865 \begin{lstHaskellLhstex}
866 e1 :: (Typeable c, UsingExt '[Neg, Subst]) => Expr c
867 \end{lstHaskellLhstex}
868
869 Giving an instance for \haskelllhstexinline{Interp} for \haskelllhstexinline{DataType} that uses the extensions \haskelllhstexinline{e_1, e2, ...} and depends on interpretations \haskelllhstexinline{i_1,i_2, ...} is done as follows:
870
871 \begin{lstHaskellLhstex}
872 instance ( UsingExt '[e_1, e_2, ...] s, DependsOn '[i_1, i_2, ...] s)
873 => Interp (DataType s) where
874 ...
875 \end{lstHaskellLhstex}
876
877 With these enhancements, there is hardly any boilerplate required to use classy deep embedding.
878 The \haskelllhstexinline{Record} data type; the \haskelllhstexinline{CreateRecord} type class; and the \haskelllhstexinline{UsingExt} and \haskelllhstexinline{DependsOn} type families can be provided as a library only requiring the programmer to create the extension constructors with their respective implementations and smart constructors for language construct extensions.
879 The source code for this extension can be found here: \url{https://gitlab.com/mlubbers/classydeepembedding}.
880
881 \section{Data types and definitions}%
882 \label{sec:cde:appendix}
883 \lstset{basicstyle=\tt\footnotesize}
884 \begin{lstHaskellLhstex}[caption={Data type definitions.}]
885 data Sub_g d a where
886 Sub_g :: (Eq a, Num a) => Expr_g d a -> Expr_g d a -> Sub_g d a
887 SubLoop_g :: Expr_g d a -> Sub_g d a
888
889 data Eq_g d a where
890 Eq_g :: (Typeable a, Eq a) => Expr_g d a -> Expr_g d a -> Eq_g d Bool
891 EqLoop_g :: Expr_g d a -> Eq_g d a
892 \end{lstHaskellLhstex}
893
894 \begin{lstHaskellLhstex}[caption={Smart constructions.}]
895 sub_g :: (Typeable d, GDict (d (Sub_g d)), Eq a, Num a) =>
896 Expr_g d a -> Expr_g d a -> Expr_g d a
897 sub_g e1 e2 = Ext_g gdict (Sub_g e1 e2)
898
899 eq_g :: (Typeable d, GDict (d (Eq_g d)), Eq a, Typeable a) =>
900 Expr_g d a -> Expr_g d a -> Expr_g d Bool
901 eq_g e1 e2 = Ext_g gdict (Eq_g e1 e2)
902 \end{lstHaskellLhstex}
903
904 \begin{lstHaskellLhstex}[caption={Semantics classes and data types.}]
905 newtype PrintDict_g v = PrintDict_g (forall a.v a -> String)
906
907 class HasPrint_g d where
908 getPrint_g :: d v -> v a -> String
909
910 instance HasPrint_g PrintDict_g where
911 getPrint_g (PrintDict_g e) = e
912
913 newtype OptDict_g v = OptDict_g (forall a.v a -> v a)
914
915 class HasOpt_g d where
916 getOpt_g :: d v -> v a -> v a
917
918 instance HasOpt_g OptDict_g where
919 getOpt_g (OptDict_g e) = e
920 \end{lstHaskellLhstex}
921
922 \begin{lstHaskellLhstex}[caption={\texorpdfstring{\haskelllhstexinline{GDict}}{GDict} instances}]
923 instance Print_g v => GDict (PrintDict_g v) where
924 gdict = PrintDict_g print_g
925 instance Opt_g v => GDict (OptDict_g v) where
926 gdict = OptDict_g opt_g
927 \end{lstHaskellLhstex}
928
929 \begin{lstHaskellLhstex}[caption={Evaluator instances}]
930 instance HasEval_g d => Eval_g (Expr_g d) where
931 eval_g (Lit_g v) = v
932 eval_g (Add_g e1 e2) = eval_g e1 + eval_g e2
933 eval_g (Ext_g d x) = getEval_g d x
934
935 instance HasEval_g d => Eval_g (Sub_g d) where
936 eval_g (Sub_g e1 e2) = eval_g e1 - eval_g e2
937 eval_g (SubLoop_g e) = eval_g e
938
939 instance HasEval_g d => Eval_g (Neg_g d) where
940 eval_g (Neg_g e) = negate (eval_g e)
941 eval_g (NegLoop_g e) = eval_g e
942
943 instance HasEval_g d => Eval_g (Eq_g d) where
944 eval_g (Eq_g e1 e2) = eval_g e1 == eval_g e2
945 eval_g (EqLoop_g e) = eval_g e
946
947 instance HasEval_g d => Eval_g (Not_g d) where
948 eval_g (Not_g e) = not (eval_g e)
949 eval_g (NotLoop_g e) = eval_g e
950 \end{lstHaskellLhstex}
951
952 \begin{lstHaskellLhstex}[caption={Printer instances}]
953 instance HasPrint_g d => Print_g (Expr_g d) where
954 print_g (Lit_g v) = show v
955 print_g (Add_g e1 e2) = "(" ++ print_g e1 ++ "+" ++ print_g e2 ++ ")"
956 print_g (Ext_g d x) = getPrint_g d x
957
958 instance HasPrint_g d => Print_g (Sub_g d) where
959 print_g (Sub_g e1 e2) = "(" ++ print_g e1 ++ "-" ++ print_g e2 ++ ")"
960 print_g (SubLoop_g e) = print_g e
961
962 instance HasPrint_g d => Print_g (Neg_g d) where
963 print_g (Neg_g e) = "(negate " ++ print_g e ++ ")"
964 print_g (NegLoop_g e) = print_g e
965
966 instance HasPrint_g d => Print_g (Eq_g d) where
967 print_g (Eq_g e1 e2) = "(" ++ print_g e1 ++ "==" ++ print_g e2 ++ ")"
968 print_g (EqLoop_g e) = print_g e
969
970 instance HasPrint_g d => Print_g (Not_g d) where
971 print_g (Not_g e) = "(not " ++ print_g e ++ ")"
972 print_g (NotLoop_g e) = print_g e
973 \end{lstHaskellLhstex}
974
975 \begin{lstHaskellLhstex}[caption={Optimisation instances}]
976 instance HasOpt_g d => Opt_g (Expr_g d) where
977 opt_g (Lit_g v) = Lit_g v
978 opt_g (Add_g e1 e2) = case (opt_g e1, opt_g e2) of
979 (Lit_g 0, e2p ) -> e2p
980 (e1p, Lit_g 0) -> e1p
981 (e1p, e2p ) -> Add_g e1p e2p
982 opt_g (Ext_g d x) = Ext_g d (getOpt_g d x)
983
984 instance HasOpt_g d => Opt_g (Sub_g d) where
985 opt_g (Sub_g e1 e2) = case (opt_g e1, opt_g e2) of
986 (e1p, Lit_g 0) -> SubLoop_g e1p
987 (e1p, e2p ) -> Sub_g e1p e2p
988 opt_g (SubLoop_g e) = SubLoop_g (opt_g e)
989
990 instance (Typeable d, GDict (d (Neg_g d)), HasOpt_g d) => Opt_g (Neg_g d) where
991 opt_g (Neg_g (Add_g e1 e2))
992 = NegLoop_g (Add_g (opt_g (neg_g e1)) (opt_g (neg_g e2)))
993 opt_g (Neg_g (Ext_g d x))
994 = case fromDynamic (toDyn (getOpt_g d x)) of
995 Just (Neg_g e) -> NegLoop_g e
996 _ -> Neg_g (Ext_g d (getOpt_g d x))
997 opt_g (Neg_g e) = Neg_g (opt_g e)
998 opt_g (NegLoop_g e) = NegLoop_g (opt_g e)
999
1000 instance HasOpt_g d => Opt_g (Eq_g d) where
1001 opt_g (Eq_g e1 e2) = Eq_g (opt_g e1) (opt_g e2)
1002 opt_g (EqLoop_g e) = EqLoop_g (opt_g e)
1003 \end{lstHaskellLhstex}
1004 \lstset{basicstyle=\tt\small}
1005
1006 \end{subappendices}
1007
1008 \input{subfilepostamble}
1009 \end{document}