handouts/amm-ho.tex
author Christian Urban <christian.urban@kcl.ac.uk>
Mon, 21 Sep 2020 13:16:02 +0100
changeset 760 e11aa9bf2600
parent 759 636ad159b4eb
child 830 c602edae2978
permissions -rw-r--r--
updated
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
754
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
     1
\documentclass{article}
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
     2
\usepackage{../style}
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
     3
\usepackage{../langs}
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
     4
\usepackage{marvosym}
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
     5
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
     6
%cheat sheet
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
     7
%http://worldline.github.io/scala-cheatsheet/
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
     8
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
     9
\begin{document}
755
40e890446213 updated
Christian Urban <christian.urban@kcl.ac.uk>
parents: 754
diff changeset
    10
\fnote{\copyright{} Christian Urban, King's College London, 2020}
754
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    11
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    12
\section*{Scala in 6CCS3CFL}
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    13
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    14
For the coursework in this module you are free to use any programming
756
cb2918e02806 updated
Christian Urban <christian.urban@kcl.ac.uk>
parents: 755
diff changeset
    15
language you like, but I will show you all my code using Scala---I
cb2918e02806 updated
Christian Urban <christian.urban@kcl.ac.uk>
parents: 755
diff changeset
    16
hope you have fond memories of Scala from PEP. But as said, you do not
cb2918e02806 updated
Christian Urban <christian.urban@kcl.ac.uk>
parents: 755
diff changeset
    17
need to use Scala for your own code.\footnote{Haskell, Rust, Ocaml
cb2918e02806 updated
Christian Urban <christian.urban@kcl.ac.uk>
parents: 755
diff changeset
    18
  were other languages that have been used previously in CFL. I
cb2918e02806 updated
Christian Urban <christian.urban@kcl.ac.uk>
parents: 755
diff changeset
    19
  recommend to not use Java or C for writing a compiler, but if you
cb2918e02806 updated
Christian Urban <christian.urban@kcl.ac.uk>
parents: 755
diff changeset
    20
  insist, feel free.}  I will use the current stable version of
cb2918e02806 updated
Christian Urban <christian.urban@kcl.ac.uk>
parents: 755
diff changeset
    21
Scala, which is 2.13.3. If you need a reminder of the Scala handouts
cb2918e02806 updated
Christian Urban <christian.urban@kcl.ac.uk>
parents: 755
diff changeset
    22
for PEP have a look
754
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    23
\hr{http://talisker.nms.kcl.ac.uk/cgi-bin/repos.cgi/pep-material/raw-file/tip/handouts/pep-ho.pdf}\bigskip
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    24
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    25
\noindent
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    26
The main difference to the Scala I showed you in PEP is that in CFL
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    27
I will use the Ammonite REPL
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    28
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    29
\begin{quote}
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    30
\url{https://ammonite.io/#Ammonite-REPL}
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    31
\end{quote}
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    32
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    33
\noindent
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    34
This is a drop-in replacement for the original Scala REPL and
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    35
works very similarly, for example
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    36
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    37
\begin{lstlisting}[language={},numbers=none,basicstyle=\ttfamily\small]
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    38
$ amm
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    39
Loading...  
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    40
Welcome to the Ammonite Repl 2.2.0 (Scala 2.13.3 Java 9)
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    41
scala> 1 + 2 
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    42
res0: Int = 3
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    43
\end{lstlisting} %% $
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    44
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    45
\noindent
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    46
Ammonite uses the same Scala compiler, just adds some useful features
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    47
on top of it. It is quite main-stream in the Scala community and it should
759
636ad159b4eb updated
Christian Urban <christian.urban@kcl.ac.uk>
parents: 756
diff changeset
    48
therefore be very easy for you to install \texttt{amm}.
636ad159b4eb updated
Christian Urban <christian.urban@kcl.ac.uk>
parents: 756
diff changeset
    49
636ad159b4eb updated
Christian Urban <christian.urban@kcl.ac.uk>
parents: 756
diff changeset
    50
The big advantage of Ammonite is that it comes with some additional
636ad159b4eb updated
Christian Urban <christian.urban@kcl.ac.uk>
parents: 756
diff changeset
    51
libraries already built-in and also allows one to easily break up code
636ad159b4eb updated
Christian Urban <christian.urban@kcl.ac.uk>
parents: 756
diff changeset
    52
into smaller modules. For example reading and writing files in
636ad159b4eb updated
Christian Urban <christian.urban@kcl.ac.uk>
parents: 756
diff changeset
    53
Ammonite can be achieved with
754
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    54
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    55
\begin{lstlisting}[numbers=none,language=Scala]
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    56
scala> import ammonite.ops._
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    57
  
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    58
scala> read(pwd / "file.name")   
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    59
res1: String = """..."""
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    60
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    61
scala> write.over(pwd / "file.name", "foo bar")
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    62
\end{lstlisting}
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    63
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    64
\noindent
759
636ad159b4eb updated
Christian Urban <christian.urban@kcl.ac.uk>
parents: 756
diff changeset
    65
The latter writes the string \code{"foo bar"} into the file
636ad159b4eb updated
Christian Urban <christian.urban@kcl.ac.uk>
parents: 756
diff changeset
    66
\code{"file.name"}, which is located in the current working
636ad159b4eb updated
Christian Urban <christian.urban@kcl.ac.uk>
parents: 756
diff changeset
    67
directory. For loading and accessing code from another Scala file, you
636ad159b4eb updated
Christian Urban <christian.urban@kcl.ac.uk>
parents: 756
diff changeset
    68
can import it as follows:
754
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    69
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    70
\begin{lstlisting}[numbers=none,language=Scala]
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    71
import $file.name-of-the-file
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    72
import name-of-the-file._
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    73
\end{lstlisting}  %% $
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    74
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    75
\noindent
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    76
This assumes the other Scala file is called
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    77
\texttt{name-of-the-file.sc} and requires the file to be in the same
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    78
directory where \texttt{amm} is working in. This will be very convenient 
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    79
for the compiler we implement in CFL, because it allows us to easily
760
e11aa9bf2600 updated
Christian Urban <christian.urban@kcl.ac.uk>
parents: 759
diff changeset
    80
break up the code into the lexer, parser and code generator.
754
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    81
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    82
Another feature which exists in Ammonite, but not yet in the
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    83
current version of Scala (it will be in the next version called dotty)
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    84
is that you can mark functions as \texttt{@main}. For example
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    85
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    86
\begin{lstlisting}[numbers=none,language=Scala]
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    87
@main
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    88
def foo() = ...
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    89
\end{lstlisting}
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    90
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    91
\noindent
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    92
This means you can now call that function from the command line like
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    93
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    94
\begin{lstlisting}[numbers=none,language=Scala]
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    95
$ amm file.sc foo
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    96
\end{lstlisting} %% $
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    97
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    98
\noindent
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    99
If you want to specify an argument on the commandline, say an int and
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
   100
a string, then you can write
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
   101
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
   102
\begin{lstlisting}[numbers=none,language=Scala]
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
   103
@main
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
   104
def bar(i: Int, s: String) = ...
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
   105
\end{lstlisting}
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
   106
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
   107
\noindent
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
   108
and then call
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
   109
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
   110
\begin{lstlisting}[numbers=none,language=Scala]
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
   111
$ amm file.sc 42 foobar
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
   112
\end{lstlisting} %% $
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
   113
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
   114
\noindent
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
   115
What is also good in Ammonite that you can specify more than one
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
   116
function to be ``main'' and then specify on the command line which
760
e11aa9bf2600 updated
Christian Urban <christian.urban@kcl.ac.uk>
parents: 759
diff changeset
   117
function you want to run as entry-point.
e11aa9bf2600 updated
Christian Urban <christian.urban@kcl.ac.uk>
parents: 759
diff changeset
   118
e11aa9bf2600 updated
Christian Urban <christian.urban@kcl.ac.uk>
parents: 759
diff changeset
   119
Another feature you might like to use is that Ammonite can ``watch'' files.
e11aa9bf2600 updated
Christian Urban <christian.urban@kcl.ac.uk>
parents: 759
diff changeset
   120
This means it can automatically re-run a file when it is saved. For this
e11aa9bf2600 updated
Christian Urban <christian.urban@kcl.ac.uk>
parents: 759
diff changeset
   121
you have to call \texttt{amm} with the option \texttt{-w}, as in
e11aa9bf2600 updated
Christian Urban <christian.urban@kcl.ac.uk>
parents: 759
diff changeset
   122
e11aa9bf2600 updated
Christian Urban <christian.urban@kcl.ac.uk>
parents: 759
diff changeset
   123
\begin{lstlisting}[numbers=none,language=Scala]
e11aa9bf2600 updated
Christian Urban <christian.urban@kcl.ac.uk>
parents: 759
diff changeset
   124
$ amm -w file.sc
e11aa9bf2600 updated
Christian Urban <christian.urban@kcl.ac.uk>
parents: 759
diff changeset
   125
\end{lstlisting} %% $
e11aa9bf2600 updated
Christian Urban <christian.urban@kcl.ac.uk>
parents: 759
diff changeset
   126
e11aa9bf2600 updated
Christian Urban <christian.urban@kcl.ac.uk>
parents: 759
diff changeset
   127
\noindent Of course this requires that you use \texttt{println} for
e11aa9bf2600 updated
Christian Urban <christian.urban@kcl.ac.uk>
parents: 759
diff changeset
   128
inspecting any data, as otherwise nothing will be displayed at the
e11aa9bf2600 updated
Christian Urban <christian.urban@kcl.ac.uk>
parents: 759
diff changeset
   129
commandline.
e11aa9bf2600 updated
Christian Urban <christian.urban@kcl.ac.uk>
parents: 759
diff changeset
   130
\bigskip
754
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
   131
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
   132
\noindent
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
   133
To sum up, Ammonite is a really useful addition to the Scala ecosystem.
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
   134
You can find more information about how to use it in the first five chapters
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
   135
of the ``Hands-on Scala'' book by Li Haoyi. These chapters are
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
   136
free and can be used as a reference, see:
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
   137
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
   138
\begin{center}
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
   139
\url{https://www.handsonscala.com/part-i-introduction-to-scala.html}
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
   140
\end{center}
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
   141
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
   142
\end{document}
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
   143
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
   144
%%% Local Variables: 
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
   145
%%% mode: latex
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
   146
%%% TeX-master: t
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
   147
%%% End: