DSL scope control with @DslMarker in Kotlin

Introduction

When writing Kotlin DSLs, @DslMarker helps avoid confusion by controlling which functions and properties are visible in nested scopes. It keeps your code clear and prevents mistakes.

You build a Kotlin DSL with nested blocks and want to avoid accidentally calling functions from the wrong scope.

You want to make your DSL easier to read by limiting what is accessible inside nested lambdas.

You create multiple DSL builders that can be nested and want to prevent mixing their members.

You want to catch scope-related errors at compile time instead of runtime.

Syntax

Kotlin

 @DslMarker
annotation class MyDslMarker

@MyDslMarker
class Outer {
    fun outerFunction() {}
    fun inner(block: Inner.() -> Unit) {
        Inner().block()
    }
}

@MyDslMarker
class Inner {
    fun innerFunction() {}
}

The @DslMarker annotation defines a marker annotation class.

Apply your marker annotation to DSL builder classes to control scope visibility.

Examples

This example shows a simple HTML DSL with @DslMarker to separate Html and Body scopes.

Kotlin

 @DslMarker
annotation class HtmlTagMarker

@HtmlTagMarker
class Html {
    fun body(block: Body.() -> Unit) {
        Body().block()
    }
}

@HtmlTagMarker
class Body {
    fun p(text: String) {}
}

Here, @DslMarker is used to avoid calling Config functions inside Database block accidentally.

Kotlin

 @DslMarker
annotation class ConfigMarker

@ConfigMarker
class Config {
    fun database(block: Database.() -> Unit) {
        Database().block()
    }
}

@ConfigMarker
class Database {
    fun url(value: String) {}
}

Sample Program

This program defines a simple robot DSL with @DslMarker to separate Robot and Move scopes. Inside move block, you cannot call Robot's stop() directly, preventing mistakes.

Kotlin

 @DslMarker
annotation class MyDsl

@MyDsl
class Robot {
    fun move(block: Move.() -> Unit) {
        Move().block()
    }
    fun stop() {
        println("Robot stopped")
    }
}

@MyDsl
class Move {
    fun forward() {
        println("Moving forward")
    }
    fun backward() {
        println("Moving backward")
    }
}

fun robot(block: Robot.() -> Unit) {
    Robot().block()
}

fun main() {
    robot {
        move {
            forward()
            // stop() // This would be an error due to @DslMarker
        }
        stop()
    }
}

Important Notes

@DslMarker helps the compiler warn you if you try to call functions from the wrong nested scope.

Without @DslMarker, nested DSL blocks can access all outer scopes, which can cause confusion.

You can create your own marker annotation with @DslMarker to suit your DSL design.

Summary

@DslMarker controls which functions are visible inside nested DSL blocks.

It prevents accidental calls to outer scope functions inside inner blocks.

Use it by creating a marker annotation and applying it to DSL builder classes.

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