DSL scope control with @DslMarker in Kotlin - Mini Project: Build & Apply

DSL Scope Control with @DslMarker in Kotlin

📖 Scenario: Imagine you are building a simple Kotlin DSL (Domain Specific Language) to create a menu for a restaurant. You want to organize the menu into sections like Starters and Main Courses. To avoid confusion when adding items to different sections, you will use Kotlin's @DslMarker annotation to control the scope and prevent mistakes.

🎯 Goal: You will build a Kotlin DSL that lets you define a menu with sections and items. You will use @DslMarker to keep the scopes clear so that you cannot accidentally add a menu item to the wrong section.

📋 What You'll Learn

Create a @DslMarker annotation called MenuDsl

Define classes Menu, Section, and Item with DSL builder functions

Use @MenuDsl on the DSL classes to control scope

Build a menu with two sections: Starters and Main Courses

Add items to each section using the DSL

Print the menu showing sections and their items

💡 Why This Matters

🌍 Real World

DSLs help create readable and easy-to-write code for specific tasks like building menus, UI layouts, or configuration files.

💼 Career

Understanding Kotlin DSLs and scope control with <code>@DslMarker</code> is useful for Android developers and Kotlin backend developers who build custom DSLs or use libraries with DSLs.

1

Create the DSL marker and data classes

Create a @DslMarker annotation called MenuDsl. Then create three classes: Menu, Section, and Item. Each class should have a name property of type String. The Menu class should have a mutable list of Section called sections. The Section class should have a mutable list of Item called items. Annotate all three classes with @MenuDsl.

Kotlin

# Your code here

Hint

Start by defining the @DslMarker annotation. Then create the classes with the required properties and annotate them with @MenuDsl.

2

Add builder functions for Menu and Section

Add a function section inside the Menu class that takes a name: String and a lambda with receiver Section. Inside this function, create a new Section with the given name, apply the lambda to it, and add it to the sections list. Also add a function item inside the Section class that takes a name: String and creates an Item with that name, adding it to the items list.

Kotlin

@DslMarker
annotation class MenuDsl

@MenuDsl
class Menu(val name: String) {
    val sections = mutableListOf()

    // Add section function here
    # Your code here
}

@MenuDsl
class Section(val name: String) {
    val items = mutableListOf()

    // Add item function here
    # Your code here
}

@MenuDsl
class Item(val name: String)

Hint

Inside Menu, write a section function that creates and adds a Section. Inside Section, write an item function that adds an Item.

3

Create the menu using the DSL

Create a variable menu by calling Menu("Dinner Menu") and use the section function to add two sections: "Starters" and "Main Courses". Inside the "Starters" section, add items "Soup" and "Salad". Inside the "Main Courses" section, add items "Steak" and "Pasta".

Kotlin

@DslMarker
annotation class MenuDsl

@MenuDsl
class Menu(val name: String) {
    val sections = mutableListOf()

    fun section(name: String, block: Section.() -> Unit) {
        val section = Section(name)
        section.block()
        sections.add(section)
    }
}

@MenuDsl
class Section(val name: String) {
    val items = mutableListOf()

    fun item(name: String) {
        items.add(Item(name))
    }
}

@MenuDsl
class Item(val name: String)

// Create the menu variable below
# Your code here

Hint

Create the menu variable using Menu("Dinner Menu") and add two sections with their items using the DSL functions.

4

Print the menu with sections and items

Write code to print the menu name, then for each section print its name, and for each item in the section print its name indented. Use a for loop with variables section and item to iterate over menu.sections and section.items. The output should look like this exactly: Dinner Menu Starters Soup Salad Main Courses Steak Pasta

Kotlin

@DslMarker
annotation class MenuDsl

@MenuDsl
class Menu(val name: String) {
    val sections = mutableListOf()

    fun section(name: String, block: Section.() -> Unit) {
        val section = Section(name)
        section.block()
        sections.add(section)
    }
}

@MenuDsl
class Section(val name: String) {
    val items = mutableListOf()

    fun item(name: String) {
        items.add(Item(name))
    }
}

@MenuDsl
class Item(val name: String)

val menu = Menu("Dinner Menu").apply {
    section("Starters") {
        item("Soup")
        item("Salad")
    }
    section("Main Courses") {
        item("Steak")
        item("Pasta")
    }
}

// Print the menu below
# Your code here

Hint

Print the menu name first. Then use nested for loops to print each section and its items with indentation.

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