DSL scope control with @DslMarker in Kotlin - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the purpose of the @DslMarker annotation in Kotlin DSLs?

The @DslMarker annotation helps control the scope in Kotlin DSLs by preventing unintentional access to members of outer DSL receivers, making the DSL usage safer and clearer.

beginner

How do you define a custom @DslMarker annotation in Kotlin?

You define it by creating a new annotation class and marking it with <code>@DslMarker</code>. For example:<br><pre>@DslMarker<br>annotation class MyDslMarker</pre>

intermediate

What happens if you don't use @DslMarker in nested DSLs?

Without @DslMarker, you can accidentally access members from outer DSL scopes, which can cause confusion or errors because the DSL context is unclear.

intermediate

In a Kotlin DSL, how does @DslMarker affect the resolution of members when nested receivers have the same annotation?

When nested receivers share the same @DslMarker annotation, Kotlin restricts access to members of outer receivers, so you can only access members of the closest receiver with that annotation.

advanced

Can you use multiple different @DslMarker annotations in the same Kotlin DSL?

Yes, you can define multiple @DslMarker annotations for different DSL parts. Each controls scope separately, allowing fine-grained control over nested DSL scopes.

What does the @DslMarker annotation primarily help with in Kotlin DSLs?

A Controlling scope to avoid accidental access to outer receivers

B Improving runtime performance

C Automatically generating DSL code

D Changing the visibility of functions

@DslMarker helps control scope by restricting access to outer receivers in nested DSLs, preventing mistakes.

How do you apply a @DslMarker annotation to a DSL class?

A By inheriting from a special DSL base class

B By marking the class as <code>open</code>

C By using the <code>override</code> keyword

D By annotating the class with the custom <code>@DslMarker</code> annotation

You annotate the DSL class with your custom @DslMarker annotation to control scope.

What happens if two nested DSL receivers have different @DslMarker annotations?

A Access is restricted to the closest receiver with the same annotation

B Only the outer receiver's members are accessible

C Both receivers' members are accessible without restriction

D Only the inner receiver's members are accessible

If the annotations differ, Kotlin treats them as separate scopes, so members from both receivers are accessible.

Why might you want to create multiple @DslMarker annotations in a complex DSL?

A To separate scope control for different DSL parts

B To speed up compilation

C To reduce code size

D To enable inheritance between DSL classes

Multiple @DslMarker annotations allow you to control scope separately for different DSL components.

Which of the following is a correct way to define a @DslMarker annotation?

A class MyDslMarker @DslMarker

B @DslMarker annotation class MyDslMarker

C fun MyDslMarker() @DslMarker

D val MyDslMarker = @DslMarker

The correct syntax is to declare an annotation class and mark it with @DslMarker.

Explain how @DslMarker helps manage scope in Kotlin DSLs and why it is important.

Think about how nested blocks in a DSL might access variables or functions from outer blocks.

Describe the steps to create and use a custom @DslMarker annotation in a Kotlin DSL.

Start with creating the annotation, then apply it to classes, then observe the effect.

Practice

1. What is the main purpose of the @DslMarker annotation in Kotlin DSLs?

easy

A. To limit function visibility and prevent accidental calls to outer DSL scopes inside nested blocks.

B. To mark a function as deprecated in DSL usage.

C. To automatically generate DSL builder classes.

D. To enable inline functions in DSL builders.

Solution

1. Step 1: Understand DSL nesting problem

   In nested DSL blocks, functions from outer scopes can be accidentally called inside inner blocks, causing confusion.

2. Step 2: Role of @DslMarker

   @DslMarker annotation marks DSL builder classes to restrict visibility of outer scope functions inside nested DSL blocks, preventing accidental calls.

3. Final Answer:

   To limit function visibility and prevent accidental calls to outer DSL scopes inside nested blocks. -> Option A

4. Quick Check:

   @DslMarker controls scope visibility = A [OK]

Hint: Remember: @DslMarker hides outer DSL functions inside nested blocks [OK]

Common Mistakes:

• Thinking @DslMarker generates code automatically
• Confusing @DslMarker with deprecation annotations
• Assuming @DslMarker enables inline functions

2. Which of the following is the correct way to define a DSL marker annotation in Kotlin?

easy

A. fun @DslMarker MyDslMarker() {}"

B. annotation class DslMarker

C. @DslMarker fun MyDslMarker() {}

D. @DslMarker annotation class MyDslMarker

Solution

1. Step 1: Recall syntax for DSL marker annotation

   DSL marker annotations must be annotated with @DslMarker and declared as annotation classes.

2. Step 2: Identify correct syntax

   @DslMarker annotation class MyDslMarker correctly declares an annotation class with @DslMarker annotation: @DslMarker annotation class MyDslMarker.

3. Final Answer:

   @DslMarker annotation class MyDslMarker -> Option D

4. Quick Check:

   DSL marker annotation syntax = A [OK]

Hint: DSL marker annotations are annotation classes with @DslMarker prefix [OK]

Common Mistakes:

• Defining DSL marker as a function instead of annotation class
• Missing the @DslMarker annotation on the annotation class
• Using incorrect placement of @DslMarker keyword

3. Consider the following Kotlin DSL code snippet with two DSL marker annotations applied:

@DslMarker
annotation class FirstDsl

@DslMarker
annotation class SecondDsl

@FirstDsl
class BuilderA {
    fun a() = println("A")
    fun buildB(block: BuilderB.() -> Unit) {
        BuilderB().apply(block)
    }
}

@SecondDsl
class BuilderB {
    fun b() = println("B")
    fun buildA(block: BuilderA.() -> Unit) {
        BuilderA().apply(block)
    }
}

fun main() {
    BuilderA().apply {
        a()
        buildB {
            b()
            // Which call is allowed here?
            // a() or b() or both?
        }
    }
}

Which function call is allowed inside the buildB block?

medium

A. Only a() is allowed; b() is not visible.

B. Both a() and b() are allowed inside buildB block.

C. Only b() is allowed; a() is not visible due to DSL marker scope control.

D. Neither a() nor b() is allowed inside buildB block.

Solution

1. Step 1: Understand effect of multiple @DslMarker annotations

   Each DSL marker annotation restricts visibility of outer scope functions from classes annotated with different DSL markers.

2. Step 2: Analyze nested block visibility

   Inside buildB block (BuilderB scope), only b() is visible. The a() function from BuilderA is hidden due to different DSL markers.

3. Final Answer:

   Only b() is allowed; a() is not visible due to DSL marker scope control. -> Option C

4. Quick Check:

   Different DSL markers hide outer scope functions = C [OK]

Hint: Different DSL markers hide outer scope functions inside nested blocks [OK]

Common Mistakes:

• Assuming all functions from outer scopes are visible
• Ignoring effect of multiple DSL markers
• Confusing which DSL marker applies where

4. Given the following Kotlin DSL code, what is the error and how to fix it?

@DslMarker
annotation class MyDsl

@MyDsl
class Outer {
    fun outerFun() = println("Outer")
    fun inner(block: Inner.() -> Unit) {
        Inner().apply(block)
    }
}

@MyDsl
class Inner {
    fun innerFun() = println("Inner")
}

fun main() {
    Outer().apply {
        outerFun()
        inner {
            outerFun() // Error here
            innerFun()
        }
    }
}

medium

A. Error: innerFun() is not visible; fix by removing @MyDsl annotation.

B. Error: Cannot call outerFun() inside inner block due to DSL marker scope control; fix by qualifying with [e-mail]().

C. Error: inner block is not called; fix by changing Inner().block() to Inner().apply(block).

D. No error; code runs fine.

Solution

1. Step 1: Identify cause of error

   Inside the inner block, outerFun() is not directly visible because @MyDsl restricts access to outer scope functions.

2. Step 2: Fix by explicit qualification

   Use explicit label [e-mail]() to call the outer function inside the inner block, bypassing DSL marker restriction.

3. Final Answer:

   Error: Cannot call outerFun() inside inner block due to DSL marker scope control; fix by qualifying with [e-mail](). -> Option B

4. Quick Check:

   Use explicit this@Outer to access outer functions [OK]

Hint: Use this@Outer to call outer functions blocked by DSL marker [OK]

Common Mistakes:

• Removing @DslMarker annotation instead of qualifying call
• Ignoring the need for explicit receiver labels
• Assuming innerFun() visibility causes error

5. You want to create a Kotlin DSL for building HTML-like structures with nested tags. You define two builder classes HtmlBuilder and BodyBuilder, both annotated with the same @DslMarker annotation. How does using @DslMarker help prevent mistakes when writing nested DSL code like html { body { div { ... } } }?

hard

A. It prevents calling functions from HtmlBuilder inside BodyBuilder blocks unless explicitly qualified, avoiding accidental outer scope calls.

B. It automatically generates HTML tags for each builder class.

C. It allows calling any function from HtmlBuilder inside BodyBuilder without restrictions.

D. It disables nested DSL blocks to simplify code.

Solution

1. Step 1: Understand nested DSL structure

   In nested DSLs like HTML, inner blocks (BodyBuilder) are inside outer blocks (HtmlBuilder).

2. Step 2: Role of @DslMarker in nested builders

   @DslMarker annotation restricts visibility of outer builder functions inside inner builder blocks, preventing accidental calls to outer scope functions without explicit qualification.

3. Final Answer:

   It prevents calling functions from HtmlBuilder inside BodyBuilder blocks unless explicitly qualified, avoiding accidental outer scope calls. -> Option A

4. Quick Check:

   @DslMarker hides outer builder functions inside nested blocks [OK]

Hint: Use @DslMarker to avoid accidental outer scope calls in nested DSLs [OK]

Common Mistakes:

• Thinking @DslMarker generates code automatically
• Assuming all functions remain visible inside nested blocks
• Believing @DslMarker disables nesting