by Claudia Doppioslash
14 April 2015 at Liverpool Javascript User Group
Elm is a Functional Reactive Language for interactive applications.
Based on Bret Victor's talk Inventing on principle which also inspired LightTable. (See 12:00)
Demo: latest version of Evan's Mario example in elm-reactor. Note the tracing of the path and Hot Swapping of code changes (when it works).
Demo: Castle of Elm, change type of tiles with hot swapping, see the result immediately
If you have tried Erlang, you know the joy of not needing to recompile the whole project just to test out a tiny change.
Any change shows immediately and if tracing is on (when it works) you can see how it affects the past of the program as well.
Elm is an opinionated language, which specifically wants you to build your code around its FRP implementation.
In Evan's thesis you can find an interesting survey of past FRP implementations, and the consequences of the choices they made.
Elm has opted to avoid lazyness as it makes it hard to predict the performance of the FRP implementation.
(RP has been adapted to OOP but it was born as FRP in Haskell)
You most likely have known the pain of having to put null guards. No more. Union Types and pattern matching will spare you from that.
We'll show the Maybe type later on.
Single assignment makes concurrency easier.
(See Erlang)
It forces you to model your program as much without side effects as possible.
It also enables elm-reactor to let you scrub through the past of your program session as well. (!)
Wondering how this can work? Applying update function to model over time.
With Signals. A signal is a value that changes over time, which updates all the values that depend on it.
It can also be described as a stream of values. That also means that the changes in your program can be tracked (as seen in elm-reactor)
It really is like a normal mutable variable, but with controlled updates.
FRP is well suited for GUIs and games.
If you have had to wrangle with MVC and MVVM and more of those acronyms in the past you know that UI programming is hardly solved.
Just to open elm-lang.org/try in a browser. It includes an editor and a preview, it supports hot code reloading too.
Download the installer from
elm-lang.org/Install.elm, it's available for Mac and Windows.
Try your luck with Cabal.
Elm is implemented in Haskell.
Halcyon can be helpful.
import Graphics.Element (..) import Text (..) main : Element main = plainText "Hello, World!"
Import modules ->
<- Import all symbols in the module
Type signature ->
<- Main function
- Hello World -
These are the 3 necessary elements of an Elm program:
If you've ever tried Haskell you'll find the syntax familiar.
The type signature goes before the function.
But Elm has type inference so most of the time you'll be able to skip writing it down.
import Graphics.Element (..)
Packages are found on:
Will import all functions in Graphics.Elements, you'll be able to use them without prefix.
import Graphics.Element as el
You'll be able to use them with prefix el.namefunction
- Hello World -
square : Int -> Int
Is the signature of a function that takes an Integer and returns an Integer.
add : Int -> Int -> Int
Is the signature of a function that takes two Integers and returns an Integer.
- Hello World -
The main function is the entry point of program execution, so you need one, or your code won't run.
It is wired to one or more Signals that drive the whole application.
- Hello World -
import Graphics.Element (..)
import Signal (Signal, map)
import Mouse
import Text (asText)
main : Signal Element
main =
map asText Mouse.position
[from examples]
Signals are values that change over time. They are Inputs that can only be transformed, merged and filtered.
In practice it's similar to how a spreadsheet works.
Simple program which shows the mouse position.
- Fundamental Concepts -
A union type is a way to put together many different types. Somewhat a more powerful enum.
type Action = Increment | Decrement
type Action = Increment Int | Decrement Int
Plain enumeration
Enumeration + Data
- Fundamental Concepts -
It's a much more powerful switch case statement. Made to be use in combination with Union Types, it will accept any type the Union Type has attached.
type alias Model = Int
update : Action -> Model -> Model
update action model =
case action of
Increment -> model + 1
Decrement -> model - 1
type alias Model = Int
update : Action -> Model -> Model
update action model =
case action of
Increment value -> model + value
Decrement value -> model - value
Plain enumeration
Enumeration + Data
- Fundamental Concepts -
type Maybe Int = Just Int | Nothing
The Maybe type allows us to avoid null checks. If there is a value it will be Just value if there isn't it will be Nothing.
- Fundamental Concepts -
String.toInt : String -> Maybe Int
toMonth : String -> Maybe Int
toMonth rawString =
case String.toInt rawString of
Nothing -> Nothing
Just n ->
if n > 0 && n <= 12 then Just n else Nothing
- Fundamental Concepts -
- Fundamental Concepts -
Folding over the past, a function that is applied on a signal in time.
Where the state is, without breaking our system of getting updated values by applying functions.
foldp : (a -> b -> b) -> b -> Signal a -> Signal b
Its arguments are:
The two args of the function are the current value of the input signal, and the past value or default value if there is no past value.
- Fundamental Concepts -
apply this function at every new value in the Signal and use the result as an input when applying it at the next value.
Model - a full definition of the application's state
Update - a function applied on the model that creates a new model that will have the view function applied to
View - a way to visualize our application state with HTML, applied to the Model data structure
Signals - the signals and inputs necessary to manage events (inputs will be signals)
[example from elm-architecture]
- Architecture -
-- MODEL
type alias Model = { ... }
-- UPDATE
type Action = Reset | ...
update : Action -> Model -> Model
update action model =
case action of
Reset -> ...
...
-- VIEW
view : Model -> Html
view =
...
<- type alias
<- Union type action
<- update function
<- View update function
- Architecture -
A data structure which contains our state. We skipped over Records so we'll stick to a plain Int.
type alias Model = Int
- Architecture -
type Action = Increment | Decrement
update : Action -> Model -> Model
update action model =
case action of
Increment -> model + 1
Decrement -> model - 1
- Architecture -
view : Model -> Html
view model =
div []
[ button [ onClick (Signal.send actionChannel Decrement) ] [ text "-" ]
, div [ countStyle ] [ text (toString model) ]
, button [ onClick (Signal.send actionChannel Increment) ] [ text "+" ]
]
countStyle : Attribute
countStyle =
style
[ ("font-size", "20px")
, ("font-family", "monospace")
, ("display", "inline-block")
, ("width", "50px")
, ("text-align", "center")
]
The function which applied to the model creates the new view state.
main : Signal Html
main =
Signal.map view model
model : Signal Model
model =
Signal.foldp update 0 (Signal.subscribe actionChannel)
actionChannel : Signal.Channel Action
actionChannel =
Signal.channel Increment
- Architecture -
The main function is driven by the Signals. It is updated every time we click on the buttons we create in the view.
(Signal.send actionChannel Decrement)
From buttons ->
Use elm-package to install community packages:
elm-package install user/project
elm-package is sandboxed by default. All packages are installed on a per-project basis, so all your projects dependencies are independent.
[from elm web site]
You can also put the dependencies of a project in the elm-package.json file, for convenient dependency handling.
Workflow:
Command:
elm-make Main.elm --output=main.html
Workflow:
Command:
elm-reactor
In the root of your elm files.
Example of a more complex program
Castle of Elm is a small proof of concept made for #7DRL (7 days rogue like) (more like 3 days I got to spend on it)
It's supposed to be a Castle of the Winds clone, but I only got around to making a flexible tile system with character collisions.
There is a supposedly nice Javascript library to make Roguelikes but I wanted to really try and stick to FRP from top to bottom and didn't want to mix in OOP/imperative style.
The Elm experience
Compared to my coding in other functional and OOP languages the main takeaways were:
Make a project from scratch
We'll need elm-make elm-package and elm-reactor.
A simple mkdir will do.
Inside we'll make an appropriate elm-package.json. We only need elm-lang/core but there are many available libraries.
Now we can make a .elm file to start coding in.
Draft
I find that union types are really handy when getting an idea of what you'll want in your program and how it will look like.
This is the first Action type I made, which is a pretty concise and faithful translation of Castle of the Winds' game design.
type Action
= NoOp
| Move Direction
| Use (Thing, Tile)
| Open Thing
| Close Thing
| Rest
| Disarm Trap
| Search Tile
| Get Tile
| FreeHand
| ShowMap
| ShowInventory
| TakeStairs Tile
| MoveMoveOver Tile
Set up signals
The next step was choosing a signal to drive the program. I could sample the inputs on the render frame tick, but for now I decided to just stick to updating when the user presses the arrow keys.
input : Signal (Float, Keys)
input =
let
delta = Signal.map (\t -> t/20) (fps 60)
deltaArrows = Signal.map2 (,) delta (Signal.map
(Debug.watch "arrows") Keyboard.arrows)
in
Signal.sampleOn delta deltaArrows
Sample on fps tick
<- Debug.watch makes it visible in elm-reactor
- Set up signals -
input : Signal Keys
input =
Signal.map (Debug.watch "arrows") Keyboard.arrows
Just observe Keyboard arrows signal
main : Signal Element
main = map view (foldp update model input)
We're just using input to drive the foldp and our view as well, all chained together.
Records
A record is quite simply a bunch of named values stitched together. It's immutable, there is a specific syntax to update it and you can make types out of it.
There is the ability of coding to an interface but we don't need it now.
type alias Character =
{ x : Float
, y : Float
, dir: Direction
}
pcState : Character
pcState =
{ x = 0
, y = 0
, dir = Right
}
type alias of a record
A record in use
Updating a record
{ pc | y <- pc.y + 1, dir <- Up }
Scaling the Architecture
The program structure we saw before scales surprisingly well.
Empirical way to cope with more:
Use modules when code size becomes too much.
Updating Nested Records
model : Model
model =
{ grid = mainGrid
, gridSide = gridWidth
, pc = pcState }
update : Direction -> Model -> Model
update dir model =
model
|> movepc dir
movepc : Direction -> Model -> Model movepc dir model = let updatePc pc dir = case dir of Up -> { pc | y <- pc.y + 1, dir <- Up } Down -> { pc | y <- pc.y - 1, dir <- Down } Left -> { pc | x <- pc.x - 1, dir <- Left } Right -> { pc | x <- pc.x + 1, dir <- Right } None -> pc in { model | pc <- updatePc model.pc dir }
< we call the function in the let
Updating Nested Records
Refs:
thanks to elm IRC channel
https://github.com/evancz/focus/tree/1.0.0
https://github.com/evancz/elm-todomvc/blob/master/Todo.elm#L102
The Grid
type Tile
| BackGround BackGroundTile
type BackGroundTile
= Floor
| WallOver WallTile
| Wall
| Water
type alias WallTile = {
r: WallJunction,
l: WallJunction,
u: WallJunction,
d: WallJunction }
fffe : WallTile
fffe = { r = Flat, u = Flat, l = Flat, d = Empty }
Grid:
[BackGround (WallOver ffee), ... ]
Debug.watch "name"
Debug.trace "name"
Will show the value in elm-reactor
Will trace the position visually in elm-reactor
Changing grid with hot code reloading.
You should now:
Interestingly, however, we will see that lazy evaluation is actually crucial to building efficient data structures in purely functional languages (i.e. without mutable variables).
To bridge this gap, Elm (and most other ML dialects) do provide mechanisms for lazy evaluation on top of the eager semantics.
Fin.