What Scala concepts are being used to make Scalatra DSL work?

Question

I'm trying to get into Scala by trying to use Scalatra. I finished Martin Odersky course on coursera some time ago but I still have a hard time understaning how this works:

package com.example.app
import org.scalatra._

class HelloWorldApp extends ScalatraFilter {
  get("/") {
    <h1>Hello, {params("name")}</h1>
  }
}

This example is taken from Scalatra main page: http://www.scalatra.org/

How this statement is executed:

get("/") {
    Hello, {params("name")}
}

Is {} a parameter of get() method? Can you explain what features of Scala language are in use here? Pointers at Scalatra source code would be perfect defining this would be perfect.

At present, I would expect this to be closed as "unclear what you're asking" or "too broad". Presumably you understand some of the statements. Can you be more explicit about which parts you're having problems with? — The Archetypal Paul, Jul 11 '14 at 08:54

score 8 · Accepted Answer · edited May 23 '17 at 11:45

get is defined in CoreDsl as follows

def get(transformers: RouteTransformer*)(block: => Any): Route

So, get takes two parameters, a sequence of route transformers (strings are implicitly converted into route transformers) and a parameterless method that outputs something of type Any. The interesting part here is this second parameter.

The first thing to understand is that parameterless methods as function arguments are handled specially in Scala, namely as call-by-name, see Automatic Type-Dependent Closure Construction and also Scala Language Reference, Section 6.6, p. 78, which is p. 86 of the PDF:

The case of a formal parameter with a parameterless method type => T is treated specially. In this case, the corresponding actual argument expression e is not evaluated before the application. Instead, every use of the formal parameter on the right-hand side of the rewrite rule entails a re-evaluation of e. In other words, the evaluation order for =>-parameters is call-by-name whereas the evaluation order for normal parameters is call-by-value.

The second aspect is that in function application, arguments can be enclosed either in () (the "regular" arguments) or {} (more precisely, in this case they must be block expressions, and they can even start on a new line), see Scala Language Reference on Function Application, Section 6.6 on p. 77, which is p. 85 of the PDF.

Note also how these two features are a significant part of what makes Scala an attractive language for defining DSLs (or new keyword-like features).

Parts of the following question might also be interesting What's the difference between multiple parameters lists and multiple parameters per list in Scala?

Thank you! This shows the required level of knowledge to knowingly use tools like Scalatra. — atok, Jul 11 '14 at 10:55
Well,maybe. Actually, you can use it without knowing most of this - as @godfatherofpolka says, it's what makes it attractive as for DSL/keywords, but a user doesn't need to know how they are implemented — The Archetypal Paul, Jul 11 '14 at 12:12
Could you explain how
... line is parsed and evaluated?Are there predifined literals for that? Cannot find anything related in the source code.. — DimG, Mar 07 '19 at 11:11
@DimG Scala has (somewhat controversial) XML literals: https://www.scala-lang.org/files/archive/spec/2.12/10-xml-expressions-and-patterns.html The
... line is an example of them — godfatherofpolka, Mar 07 '19 at 11:24

score 1 · Answer 2 · answered Jul 11 '14 at 09:18

Is {} a parameter of get() method?

Yes. get will have two parameter lists. One is for the path "\" and the other for the block to execute. Blocks are enclosed in {}, parameters in (). So you would seem to have to call it as

class HelloWorldApp extends ScalatraFilter {
  get("/") ({
    <h1>Hello, {params("name")}</h1>
  })
}

but there's some syntactic sugar that allows a single parameter in {} to be passed without having to add the (). You see this more commonly in things like

myList foreach { do_something() }

It's a very useful feature for writing what look like, and are used like, new control structures but are actually just functions.

What Scala concepts are being used to make Scalatra DSL work?

2 Answers2

... line is parsed and evaluated?Are there predifined literals for that? Cannot find anything related in the source code..

... line is an example of them