handouts/amm-ho.tex
author Christian Urban <christian.urban@kcl.ac.uk>
Tue, 31 Aug 2021 11:49:09 +0100
changeset 830 c602edae2978
parent 760 e11aa9bf2600
child 838 113230908e2d
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
830
c602edae2978 updated
Christian Urban <christian.urban@kcl.ac.uk>
parents: 760
diff changeset
    16
hope you have fond memories of Scala from PEP. If you need a reminder
c602edae2978 updated
Christian Urban <christian.urban@kcl.ac.uk>
parents: 760
diff changeset
    17
of the Scala handouts for PEP have a look
c602edae2978 updated
Christian Urban <christian.urban@kcl.ac.uk>
parents: 760
diff changeset
    18
\hr{http://talisker.nms.kcl.ac.uk/cgi-bin/repos.cgi/pep-material/raw-file/tip/handouts/pep-ho.pdf}
c602edae2978 updated
Christian Urban <christian.urban@kcl.ac.uk>
parents: 760
diff changeset
    19
c602edae2978 updated
Christian Urban <christian.urban@kcl.ac.uk>
parents: 760
diff changeset
    20
c602edae2978 updated
Christian Urban <christian.urban@kcl.ac.uk>
parents: 760
diff changeset
    21
But as said, you do not need to use Scala for your own
c602edae2978 updated
Christian Urban <christian.urban@kcl.ac.uk>
parents: 760
diff changeset
    22
code.\footnote{Haskell, Rust, Ocaml were other languages that have
c602edae2978 updated
Christian Urban <christian.urban@kcl.ac.uk>
parents: 760
diff changeset
    23
  been used previously in CFL. I recommend to not use Java or C for
c602edae2978 updated
Christian Urban <christian.urban@kcl.ac.uk>
parents: 760
diff changeset
    24
  writing a compiler, but if you insist, feel free. It has been done
c602edae2978 updated
Christian Urban <christian.urban@kcl.ac.uk>
parents: 760
diff changeset
    25
before.}  I will use the
c602edae2978 updated
Christian Urban <christian.urban@kcl.ac.uk>
parents: 760
diff changeset
    26
current stable version of Scala, which is 2.13.6. For various reasons,
c602edae2978 updated
Christian Urban <christian.urban@kcl.ac.uk>
parents: 760
diff changeset
    27
I am NOT GOING TO USE THE LATEST VERSION OF SCALA 3.0! Please be
c602edae2978 updated
Christian Urban <christian.urban@kcl.ac.uk>
parents: 760
diff changeset
    28
aware of this when you run my code.
c602edae2978 updated
Christian Urban <christian.urban@kcl.ac.uk>
parents: 760
diff changeset
    29
\bigskip
754
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    30
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    31
\noindent
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    32
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
    33
I will use the Ammonite REPL
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    34
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    35
\begin{quote}
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    36
\url{https://ammonite.io/#Ammonite-REPL}
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    37
\end{quote}
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    38
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    39
\noindent
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    40
This is a drop-in replacement for the original Scala REPL and
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    41
works very similarly, for example
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    42
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    43
\begin{lstlisting}[language={},numbers=none,basicstyle=\ttfamily\small]
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    44
$ amm
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    45
Loading...  
830
c602edae2978 updated
Christian Urban <christian.urban@kcl.ac.uk>
parents: 760
diff changeset
    46
Welcome to the Ammonite Repl 2.3.8 (Scala 2.13.3 Java 9)
c602edae2978 updated
Christian Urban <christian.urban@kcl.ac.uk>
parents: 760
diff changeset
    47
scala> 1 + 2
754
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    48
res0: Int = 3
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    49
\end{lstlisting} %% $
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    50
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    51
\noindent
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    52
Ammonite uses the same Scala compiler, just adds some useful features
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    53
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
    54
therefore be very easy for you to install \texttt{amm}.
636ad159b4eb updated
Christian Urban <christian.urban@kcl.ac.uk>
parents: 756
diff changeset
    55
636ad159b4eb updated
Christian Urban <christian.urban@kcl.ac.uk>
parents: 756
diff changeset
    56
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
    57
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
    58
into smaller modules. For example reading and writing files in
636ad159b4eb updated
Christian Urban <christian.urban@kcl.ac.uk>
parents: 756
diff changeset
    59
Ammonite can be achieved with
754
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
\begin{lstlisting}[numbers=none,language=Scala]
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    62
scala> import ammonite.ops._
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
scala> read(pwd / "file.name")   
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    65
res1: String = """..."""
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    66
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    67
scala> write.over(pwd / "file.name", "foo bar")
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    68
\end{lstlisting}
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
\noindent
759
636ad159b4eb updated
Christian Urban <christian.urban@kcl.ac.uk>
parents: 756
diff changeset
    71
The latter writes the string \code{"foo bar"} into the file
636ad159b4eb updated
Christian Urban <christian.urban@kcl.ac.uk>
parents: 756
diff changeset
    72
\code{"file.name"}, which is located in the current working
636ad159b4eb updated
Christian Urban <christian.urban@kcl.ac.uk>
parents: 756
diff changeset
    73
directory. For loading and accessing code from another Scala file, you
636ad159b4eb updated
Christian Urban <christian.urban@kcl.ac.uk>
parents: 756
diff changeset
    74
can import it as follows:
754
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    75
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    76
\begin{lstlisting}[numbers=none,language=Scala]
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    77
import $file.name-of-the-file
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    78
import name-of-the-file._
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    79
\end{lstlisting}  %% $
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    80
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    81
\noindent
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    82
This assumes the other Scala file is called
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    83
\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
    84
directory where \texttt{amm} is working in. This will be very convenient 
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    85
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
    86
break up the code into the lexer, parser and code generator.
754
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    87
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    88
Another feature which exists in Ammonite, but not yet in the
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    89
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
    90
is that you can mark functions as \texttt{@main}. For example
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    91
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    92
\begin{lstlisting}[numbers=none,language=Scala]
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    93
@main
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    94
def foo() = ...
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    95
\end{lstlisting}
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    96
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    97
\noindent
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
    98
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
    99
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
   100
\begin{lstlisting}[numbers=none,language=Scala]
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
   101
$ amm file.sc foo
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
   102
\end{lstlisting} %% $
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
   103
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
   104
\noindent
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
   105
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
   106
a string, then you can write
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
   107
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
   108
\begin{lstlisting}[numbers=none,language=Scala]
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
   109
@main
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
   110
def bar(i: Int, s: String) = ...
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
   111
\end{lstlisting}
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
   112
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
   113
\noindent
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
   114
and then call
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
   115
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
   116
\begin{lstlisting}[numbers=none,language=Scala]
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
   117
$ amm file.sc 42 foobar
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
   118
\end{lstlisting} %% $
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
   119
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
   120
\noindent
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
   121
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
   122
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
   123
function you want to run as entry-point.
e11aa9bf2600 updated
Christian Urban <christian.urban@kcl.ac.uk>
parents: 759
diff changeset
   124
e11aa9bf2600 updated
Christian Urban <christian.urban@kcl.ac.uk>
parents: 759
diff changeset
   125
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
   126
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
   127
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
   128
e11aa9bf2600 updated
Christian Urban <christian.urban@kcl.ac.uk>
parents: 759
diff changeset
   129
\begin{lstlisting}[numbers=none,language=Scala]
e11aa9bf2600 updated
Christian Urban <christian.urban@kcl.ac.uk>
parents: 759
diff changeset
   130
$ amm -w file.sc
e11aa9bf2600 updated
Christian Urban <christian.urban@kcl.ac.uk>
parents: 759
diff changeset
   131
\end{lstlisting} %% $
e11aa9bf2600 updated
Christian Urban <christian.urban@kcl.ac.uk>
parents: 759
diff changeset
   132
e11aa9bf2600 updated
Christian Urban <christian.urban@kcl.ac.uk>
parents: 759
diff changeset
   133
\noindent Of course this requires that you use \texttt{println} for
e11aa9bf2600 updated
Christian Urban <christian.urban@kcl.ac.uk>
parents: 759
diff changeset
   134
inspecting any data, as otherwise nothing will be displayed at the
e11aa9bf2600 updated
Christian Urban <christian.urban@kcl.ac.uk>
parents: 759
diff changeset
   135
commandline.
e11aa9bf2600 updated
Christian Urban <christian.urban@kcl.ac.uk>
parents: 759
diff changeset
   136
\bigskip
754
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
\noindent
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
   139
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
   140
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
   141
of the ``Hands-on Scala'' book by Li Haoyi. These chapters are
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
   142
free and can be used as a reference, see:
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
\begin{center}
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
   145
\url{https://www.handsonscala.com/part-i-introduction-to-scala.html}
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
   146
\end{center}
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
   147
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
   148
\end{document}
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
   149
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
   150
%%% Local Variables: 
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
   151
%%% mode: latex
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
   152
%%% TeX-master: t
05a51fa5f7bb ammonite
Christian Urban <christian.urban@kcl.ac.uk>
parents:
diff changeset
   153
%%% End: