f07bc6bd55c2785eb007992e77ce4e52a0cbaf4a
[phd-thesis.git] / appendix / clean_for_haskell_programmers.tex
1 \documentclass[../thesis.tex]{subfiles}
2
3 \begin{document}
4
5 \ifSubfilesClassLoaded{
6 \pagenumbering{arabic}
7 \author{Mart Lubbers\and Peter Achten}
8 \title{Clean for Haskell Programmers}
9 \date{\today}
10
11 \stopthumb{}%
12 \setcounter{chapter}{1}
13
14 {
15 \let\clearpage\relax
16 \let\vfil\relax
17 \let\cleardoublepage\relax
18 \let\newpage\relax
19 \maketitle
20 \tableofcontents
21 }
22
23 }{
24 \chapter{\glsentrytext{CLEAN} for \glsentrytext{HASKELL} Programmers}%
25 \label{chp:clean_for_haskell_programmers}
26 }
27
28 While \gls{CLEAN} and \gls{HASKELL} were both conceived around 1987 and have similar syntax, there are some subtle differences in syntax and functionality.
29 This section describes some of the history of \gls{CLEAN} and provides a crash course in \gls{CLEAN} pecularities written for \gls{HASKELL} programmers.
30 It is based on the
31
32 \Gls{CLEAN}---acronym for Clean \acrlong{LEAN}~\cite{barendregt_towards_1987}---, was originally designed as a \gls{GRS} core language but quickly served as an intermediate language for other functional languages~\cite{brus_clean_1987}.
33 In the early days it has also been called \emph{Concurrent} \gls{CLEAN}~\cite{nocker_concurrent_1991} but these days the language has no support for this anymore.
34 Fast forward thirty years, \gls{CLEAN} is now a robust language with state-of-the-art features and is actually used in industry as well as academia---albeit in select areas of the world~\cite{plasmeijer_clean_2021}.
35
36 Initially, when it was used mostly as an intermediate language, it had a fairly spartan syntax.
37 However, over the years, the syntax got friendlier and it currently it looks a lot like \gls{HASKELL}.
38 In the past, a \emph{double-edged} fronted even existed that allowed \gls{CLEAN} to be extended with \gls{HASKELL98} syntax and vice versa, however this frontend is no longer maintained~\cite{groningen_exchanging_2010}.
39 This chapter therefore gives a brief syntactical and functional comparison, a complete specification of the \gls{CLEAN} language can be found in the latest language report~\cite{plasmeijer_clean_2021}.
40 Many of this is based on work by Achten although that was based on \gls{CLEAN} 2.1 and \gls{HASKELL98}~\cite{achten_clean_2007}.
41 When \gls{HASKELL} is mentioned we actually mean \gls{GHC}'s \gls{HASKELL} and by \gls{CLEAN} we mean \gls{CLEAN} 3.1's \gls{ITASK} compiler.
42
43 \section{Features}
44 \subsection{Modules}
45 \Gls{CLEAN} has separate implementation and definition modules.
46 The definition module contains the class definitions, instances, function types and type definitions (possibly abstract).
47 Implementation modules contain the function implementations as well.
48 This means that only what is defined in the definition module is exported in \gls{CLEAN}.
49 This differs greatly from \gls{HASKELL}, as there is only a module file there.
50 Choosing what is exported in \gls{HASKELL} is done using the \haskellinline{module Mod(...)} syntax.
51
52 \subsection{Strictness}
53 In \gls{CLEAN}, by default, all expressions are evaluated lazily.
54 Types can be annotated with a strictness attribute (\cleaninline{!}), resulting in the values being evaluated to head-normal form before the function is entered.
55 In \gls{HASKELL}, in patterns, strictness can be enforced using \haskellinline{!}\requiresGHCmod{BangPatterns}.
56 Within functions the strict let (\cleaninline{#!}) can be used to force evaluate an expression, in \gls{HASKELL} \haskellinline{seq} or \haskellinline{\$!} is used for this.
57
58 \subsection{Uniqueness typing}
59 Types in \gls{CLEAN} may be \emph{unique}, which means that they may not be shared\todo{cite}.
60 The uniqueness type system allows the compiler to generate efficient code because unique data structures can be destructively updated.
61 Furthermore, uniqueness typing serves as a model for side effects as well.
62 \Gls{CLEAN} uses the \emph{world-as-value} paradigm where \cleaninline{World} represents the external environment and is always unique.
63 A program with side effects is characterised by a \cleaninline{Start :: *World -> *World} start function.
64 In \gls{HASKELL}, interaction with the world is done using the \haskellinline{IO} monad.
65 The \haskellinline{IO} monad could very well be---and actually is---implemented in \gls{CLEAN} using a state monad with the \cleaninline{World} as a state.
66 Besides marking types as unique, it is also possible to mark them with uniqueness attributes variables \cleaninline{u:} and define constraints on them.
67 For example, to make sure that an argument of a function is at least as unique as another argument.
68 Finally, using \cleaninline{.} (a dot), it is possible to state that several variables are equally unique.
69 Uniqueness is propagated automatically in function types but must be marked manually in data types.
70 Examples can be seen in \cref{lst:unique_examples}.
71
72 \begin{lstClean}[label={lst:unique_examples},caption={Examples of uniqueness annotations in \gls{CLEAN}.}]
73 f :: *a -> *a // f works on unique values only
74 f :: .a -> .a // f works on unique and non-unique values
75 f :: v:a u:b -> u:b, [v<=u] // f works when a is less unique than b
76 \end{lstClean}
77 %f :: (Int, *World) -> *World // The uniqueness is propagated automatically (i.e. *(Int, *World)))
78 %:: T = T *(Int, *World) // Writing :: T = T (Int, *World) won't work
79 %:: T = T (Int -> *(*World -> *World)) // Writing :: T = T (Int *World -> *World) won't work
80
81 \subsection{Expressions}
82 \todo[inline]{Matches pattern expression \texttt{=:}}
83
84 \todo[inline]{Let before}
85
86 \subsection{Generics}
87 Polytypic functions~\cite{jeuring_polytypic_1996}---also known as generic or kind-indexed fuctions---are built into \gls{CLEAN}~\cite[Chp.~7.1]{plasmeijer_clean_2021}\cite{alimarine_generic_2005} whereas in \gls{HASKELL} they are implemented as a library~\cite[Chp.~6.19.1]{ghc_team_ghc_2021}.
88 The implementation of generics in \gls{CLEAN} is very similar to that of Generic H$\forall$skell~\cite{hinze_generic_2003}.
89 %When calling a generic function, the kind must always be specified and depending on the kind, the function may require more arguments.
90
91 For example, defining a generic equality is done as in \cref{lst:generic_eq}.
92 \lstinputlisting[language=Clean,firstline=4,label={lst:generic_eq},caption={Generic equality function in \gls{CLEAN}.}.]{lst/generic_eq.icl}
93
94 Metadata about the types is available using the \cleaninline{of} syntax that gives the function access to metadata records, as can be seen in \cref{lst:generic_print} showing a generic print function. This abundance of metadata allows for very complex generic functions that near the expression level of template metaprogramming\ifSubfilesClassLoaded{}{ (See \cref{chp:first-class_datatypes})}.
95 \lstinputlisting[language=Clean,firstline=4,label={lst:generic_print},caption={Generic print function in \gls{CLEAN}.}]{lst/generic_print.icl}
96
97 \subsection{\glsentrytext{GADT}s}
98 GADTs are enriched data types that allow the type instantiation of the constructor to be explicitly defined~\cite{cheney_first-class_2003,hinze_fun_2003}.
99 While \glspl{GADT} are not natively supported in \gls{CLEAN}, they can be simulated using embedding-projection pairs or equivalence types~\cite[Sec.~2.2]{cheney_lightweight_2002}.
100 To illustrate this, \cref{lst:gadt_clean} shows an example \gls{GADT} that would be implemented in \gls{HASKELL} as done in \cref{lst:gadt_haskell}\requiresGHCmod{GADTs}.
101
102 \lstinputlisting[language=Clean,firstline=4,label={lst:gadt_clean},caption={Expression \gls{GADT} using equivalence types in \gls{CLEAN}.}]{lst/expr_gadt.icl}
103 \lstinputlisting[language=Haskell,style=haskell,firstline=4,label={lst:gadt_haskell},caption={Expression \gls{GADT} in \gls{HASKELL}.}]{lst/expr_gadt.hs}
104
105 \section{Syntax}
106 \begin{longtable}{p{.45\linewidth}p{.5\linewidth}}
107 \caption[]{Syntactical differences between \gls{CLEAN} and \gls{HASKELL}.}%
108 \label{tbl:syn_clean_haskell}\\
109 \toprule
110 \gls{CLEAN} & \gls{HASKELL}\\
111 \midrule
112 \endfirsthead%
113 \caption[]{(continued)}\\
114 \toprule
115 \gls{CLEAN} & \gls{HASKELL}\\
116 \midrule
117 \endhead%
118
119 \midrule
120 \multicolumn{2}{c}{Comments}\\
121 \midrule
122 \cleaninline{// single line} & \haskellinline{-- single line}\\
123 \cleaninline{/* multi line /* nested */ */} & \haskellinline{\{- multi line \{- nested -\} \}}\\
124
125 \midrule
126 \multicolumn{2}{c}{Imports}\\
127 \midrule
128 \cleaninline{import Mod => qualified f1, :: t} & \haskellinline{import qualified Mod (f1, t)}\\
129 & \haskellinline{import Mod hiding (f1, t)}\\
130 \cleaninline{/* multi line /* nested */ */} & \haskellinline{\{- multi line \{- nested -\} \}}\\
131
132 \midrule
133 \multicolumn{2}{c}{Basic types}\\
134 \midrule
135 \cleaninline{42 :: Int} & \haskellinline{42 :: Int}\\
136 \cleaninline{True :: Bool} & \haskellinline{True :: Bool}\\
137 \cleaninline{toInteger 42 :: Integer} & \haskellinline{42 :: Integer}\\
138 \cleaninline{38.0 :: Real} & \haskellinline{38.0 :: Float -- or Double}\\
139 \cleaninline{\"Hello\" +++ \"World\" :: String}\footnote{Strings are represented as unboxed character arrays.}
140 & \haskellinline{\"Hello\" ++ \"World\" :: String}\footnote{Strings are represented as lists of characters by default but may be overloaded as well if \GHCmod{OverloadedStrings} is enabled.}\\
141 \cleaninline{['Hello'] :: [Char]} & \haskellinline{\"Hello\" :: String}\\
142 \cleaninline{?t} & \haskellinline{Maybe t}\\
143 \cleaninline{(?None, ?Just e)} & \haskellinline{(Nothing, Just e)}\\
144
145 \midrule
146 \multicolumn{2}{c}{Type definitions}\\
147 \midrule
148 \cleaninline{:: T a0 ... :== t} & \haskellinline{type T a0 ... = t}\\
149 \cleaninline{:: T a0 ... } & \haskellinline{data T a1 ...}\\
150 \quad\cleaninline{= C1 f0 ... fn \| ... \| Cn f0 ... fn} & \quad\haskellinline{= C1 f0 ... fn \| ... \| Cn f0 ... fn}\\
151 \cleaninline{:: T a0 ...} & \haskellinline{data T a0 ...}\\
152 \quad\cleaninline{= \{ f0 :: t0, ..., fn :: tn \} } & \quad\haskellinline{= T \{ f0 :: t0, ..., fn :: tn \} }\\
153 \cleaninline{:: T a0 ... =: t} & \haskellinline{newtype T a0 ... = t}\\
154 \cleaninline{:: T = E.t: Box t \& C t} & \haskellinline{data T = forall t.C t => Box t}\requiresGHCmod{ExistentialQuantification}\\
155
156 \midrule
157 \multicolumn{2}{c}{Function types}\\
158 \midrule
159 \cleaninline{f0 :: a0 a1 ... -> t}
160 & \haskellinline{f0 :: (c0 v0, c1 v1, c2 v2) =>}\\
161 \quad\cleaninline{\| c0 v0 \& c1, c2 v1}
162 & \quad\haskellinline{a0 -> a1 ... -> t}\\
163 \cleaninline{(+) infixl 6 :: Int Int -> Int} & \haskellinline{infixl 6 +}\\
164 & \haskellinline{(+) :: Int -> Int -> Int}\\
165 \cleaninline{qid :: (A.a: a -> a) -> (Bool, Int)}
166 & \haskellinline{qid :: (forall a: a -> a) -> (Bool, Int)}\requiresGHCmod{RankNTypes}\\
167 \cleaninline{qid id = (id True, id 42)} &
168 \haskellinline{qid id = (id True, id 42)}\\
169
170 \midrule
171 \multicolumn{2}{c}{Type classes}\\
172 \midrule
173 \cleaninline{class f a :: t} & \haskellinline{class f a where f :: t}\\
174 \cleaninline{class C a \| C0, ... , Cn a}\footnote{In contrast to the \gls{HASKELL} variant, this does not require an instance.} & \haskellinline{class (C0 a, ..., Cn, a) => C a}\\
175 \cleaninline{class C s ~m where ...} & \haskellinline{class C s m \| m -> s where ...}\requiresGHCmod{MultiParamTypeClasses}\\
176 \cleaninline{instance C t \| C0, ..., Cn a} & \haskellinline{instance (C0 a, ..., Cn a) => C t}\\
177 \quad\cleaninline{where ...} & \quad\haskellinline{where ...}\\
178
179 \midrule
180 \multicolumn{2}{c}{As pattern}\\
181 \midrule
182 \cleaninline{x=:p} & \haskellinline{x@p}\\
183
184 \midrule
185 \multicolumn{2}{c}{Lists}\\
186 \midrule
187 \cleaninline{[1,2,3]} & \haskellinline{[1,2,3]}\\
188 \cleaninline{[x:xs]} & \haskellinline{x:xs}\\
189 \cleaninline{[e \\\\ e <- xs \| p e]} & \haskellinline{[e \| e <- xs, p e]}\\
190 \cleaninline{[l \\\\ l <- xs, r <- ys]} & \haskellinline{[l \| l <- xs, r <- ys]}\\
191 \cleaninline{[(l, r) \\\\ l <- xs \& r <- ys]} & \haskellinline{[(l, r) \| (l, r) <- zip xs ys]}\\
192 & or \haskellinline{[(l, r) \| l <- xs \| r <- ys]}\requiresGHCmod{ParallelListComp}\\
193
194 \midrule
195 \multicolumn{2}{c}{Lambda expressions}\\
196 \midrule
197 \cleaninline{\\a0 a1 ...->e} or \cleaninline{\\....e} or \cleaninline{\\...=e} & \haskellinline{\\a0 a1 ...->e}\\
198
199 \midrule
200 \multicolumn{2}{c}{Case distinction}\\
201 \midrule
202 \cleaninline{if p e0 e1} & \haskellinline{if p then e0 else e1}\\
203 \cleaninline{case e of p0 -> e0; ...} & \haskellinline{case e of p0 -> e0; ...}\\
204 \quad or \cleaninline{case e of p0 = e0; ...}\\
205 \cleaninline{f p0 ... pn} & \haskellinline{f p0 ... pn}\\
206 \quad\cleaninline{\| c = t} & \quad\haskellinline{\| c = t}\\
207 \quad\cleaninline{\| otherwise = t} or \cleaninline{= t} & \quad\haskellinline{\| otherwise = t}\\
208
209 \midrule
210 \multicolumn{2}{c}{Record expressions}\\
211 \midrule
212 \cleaninline{:: R = \{ f :: t \}} & \haskellinline{data R = R \{ f :: t \}}\\
213 \cleaninline{r = \{ f = e \}} & \haskellinline{r = R \{e\}}\\
214 \cleaninline{r.f} & \haskellinline{f r}\\
215 \cleaninline{r!f}\footnote{This operator allows for field selection from unique records.} & \haskellinline{(\\v->(f v, v)) r}\\
216 \cleaninline{\{r \& f = e \}} & \haskellinline{r \{ f = e \}}\\
217
218 \midrule
219 \multicolumn{2}{c}{Record patterns}\\
220 \midrule
221 \cleaninline{:: R0 = \{ f0 :: R1 \}} & \haskellinline{data R0 = R0 \{ f0 :: R1 \}}\\
222 \cleaninline{:: R1 = \{ f1 :: t \}} & \haskellinline{data R1 = R1 \{ f1 :: t \}}\\
223 \cleaninline{g \{ f0 \} = e f0} & \haskellinline{g (R0 \{f0=x\}) = e x}\\
224 & or \haskellinline{g (R0 \{f0\}) = e f0}\requiresGHCmod{RecordPuns}\\
225 \cleaninline{g \{ f0 = \{f1\} \} = e f1} & \haskellinline{g (R0 \{f0=R1 \{f1=x\}\}) = e x}\\
226
227 \midrule
228 \multicolumn{2}{c}{Arrays}\\
229 \midrule
230 \cleaninline{:: A :== \{t\}} & \haskellinline{type A = Array Int t}\\
231 \cleaninline{a = \{v0, ..., vn\}} & \haskellinline{a = array (0, n+1)}\\
232 & \quad\haskellinline{[(0, v0), ..., (n, vn)]}\\
233 \cleaninline{a = \{e \\\\ p <-: a\}} & \haskellinline{a = array (0, length a-1)}\\
234 & \quad\haskellinline{[e \| (i, a) <- [0..] `zip` a]}\\
235 \cleaninline{a.[i]} & \haskellinline{a!i}\\
236 \cleaninline{a![i]}\footnote{This operator allows for field selection from unique arrays.} & \haskellinline{(\v->(v!i, v)) a}\\
237 \cleaninline{\{ a \& [i] = e\}} & \haskellinline{a//[(i, e)]}\\
238
239 \midrule
240 \multicolumn{2}{c}{Dynamics}\\
241 \midrule
242 \cleaninline{f :: a -> Dynamic \| TC a} & \haskellinline{f :: Typeable a => a -> Dynamic}\\
243 \cleaninline{f e = dynamic e} & \haskellinline{f e = toDyn (e)}\\
244 \cleaninline{g :: Dynamic -> t} & \haskellinline{g :: Dynamic -> t}\\
245 \cleaninline{g (e :: t) = e0} & \haskellinline{g d = case fromDynamic d}\\
246 \cleaninline{g e = e1} & \quad\haskellinline{Just e -> e0}\\
247 & \quad\haskellinline{Nothing -> e1}\\
248
249 \bottomrule
250 \end{longtable}
251
252 \input{subfilepostamble}
253 \end{document}