Extensions for DSL building in Kotlin

Introduction

Extensions let you add new features to existing code easily. For DSLs, they help make code look simple and natural, like a special language just for your task.

When you want to create a simple and readable way to build complex objects.

When you want to add new functions to classes without changing their original code.

When you want to write code that looks like a small language for a specific job.

When you want to organize code clearly for building things step-by-step.

When you want to improve code readability by using natural language style.

Syntax

Kotlin

fun ReceiverType.extensionFunctionName(params) {
    // function body
}

ReceiverType is the class you add the function to.

This function can be called as if it belongs to the receiver object.

Examples

Adds a new function shout to String that makes text uppercase and adds an exclamation.

Kotlin

fun String.shout() = this.uppercase() + "!"

Adds a function to add the same number twice to a list of integers.

Kotlin

fun MutableList<Int>.addTwice(value: Int) {
    this.add(value)
    this.add(value)
}

Adds a new jump action to the Robot class without changing its code.

Kotlin

class Robot {
    fun move() = println("Moving")
}

fun Robot.jump() = println("Jumping")

Sample Program

This program shows how to add a new jump function to the Robot class using an extension. The robot can move and jump.

Kotlin

class Robot {
    fun move() = println("Moving")
}

fun Robot.jump() = println("Jumping")

fun main() {
    val robot = Robot()
    robot.move()
    robot.jump()
}

Important Notes

Extensions do not actually change the original class; they just add new functions you can use.

If an extension function has the same name as a member function, the member function is called instead.

Extensions help make DSLs by letting you write code that reads like natural instructions.

Summary

Extensions add new functions to existing classes without changing them.

They help create simple and readable DSLs by making code look like a special language.

Use extensions to organize code and improve clarity when building complex objects.

Practice

1. What is the main purpose of using extensions in Kotlin for DSL building?

easy

A. To add new functions to existing classes without modifying their source code

B. To create new classes from scratch

C. To change the behavior of existing functions permanently

D. To restrict access to class members

Solution

1. Step 1: Understand what extensions do

   Extensions allow adding new functions to existing classes without changing their original code.

2. Step 2: Relate to DSL building

   This helps create readable DSLs by extending classes with custom functions.

3. Final Answer:

   To add new functions to existing classes without modifying their source code -> Option A

4. Quick Check:

   Extensions add functions without modifying classes [OK]

Hint: Extensions add functions without changing original classes [OK]

Common Mistakes:

• Thinking extensions create new classes
• Believing extensions permanently change existing functions
• Confusing extensions with access control

2. Which of the following is the correct syntax to define an extension function greet for the String class in Kotlin?

easy

A. extension fun String greet() { println("Hello") }

B. fun greet(String) { println("Hello") }

C. fun String.greet() { println("Hello") }

D. fun greet() String { println("Hello") }

Solution

1. Step 1: Recall extension function syntax

   Extension functions are declared with fun ClassName.functionName().

2. Step 2: Match syntax to options

   fun String.greet() { println("Hello") } uses fun String.greet(), which is correct syntax.

3. Final Answer:

   fun String.greet() { println("Hello") } -> Option C

4. Quick Check:

   Extension syntax = fun ClassName.functionName() [OK]

Hint: Extension syntax: fun ClassName.functionName() [OK]

Common Mistakes:

• Placing class name as parameter instead of receiver
• Using 'extension' keyword which doesn't exist
• Incorrect function return type placement

3. What will be the output of the following Kotlin code?

class Box(var content: String)

fun Box.describe() = "Box contains: $content"

fun main() {
    val box = Box("Apples")
    println(box.describe())
}

medium

A. Box contains: Apples

B. Box contains: content

C. Compilation error

D. Box@<memory_address>

Solution

1. Step 1: Understand the extension function

   The extension function describe returns a string with the content property of Box.

2. Step 2: Check the main function output

   Creating Box("Apples") and calling describe() prints "Box contains: Apples".

3. Final Answer:

   Box contains: Apples -> Option A

4. Quick Check:

   Extension uses property value correctly [OK]

Hint: Extension functions use class properties directly [OK]

Common Mistakes:

• Expecting 'content' literal instead of property value
• Confusing extension with overriding toString()
• Thinking it prints memory address

4. Identify the error in this Kotlin code snippet that tries to build a simple DSL using extensions:

class Menu {
    val items = mutableListOf<String>()
}

fun Menu.addItem(name: String) {
    items.add(name)
}

fun buildMenu(block: Menu.() -> Unit): Menu {
    val menu = Menu()
    block(menu)
    return menu
}

fun main() {
    val menu = buildMenu {
        addItem("Home")
        addItem("About")
    }
    println(menu.items)
}

medium

A. The extension function addItem should be inside the Menu class

B. The block should be called with menu.block() instead of block(menu)

C. MutableList should be immutableList

D. No error, code runs correctly

Solution

1. Step 1: Understand the block parameter type

   The block is a lambda with receiver: Menu.() -> Unit, so it should be called as menu.block().

2. Step 2: Identify the call mistake

   The code calls block(menu), which treats block as a normal function, causing an error.

3. Final Answer:

   The block should be called with menu.block() instead of block(menu) -> Option B

4. Quick Check:

   Lambda with receiver called as receiver.lambda() [OK]

Hint: Call lambdas with receiver as receiver.lambda() [OK]

Common Mistakes:

• Calling lambda with receiver as normal function
• Placing extension function inside class unnecessarily
• Confusing mutable and immutable lists

5. Given the following Kotlin DSL code, what is the output?

class Html {
    val children = mutableListOf<String>()
}

fun Html.body(block: Html.() -> Unit) {
    this.block()
}

fun Html.p(text: String) {
    children.add("
$text
")
}

fun html(block: Html.() -> Unit): Html {
    val html = Html()
    html.block()
    return html
}

fun main() {
    val page = html {
        body {
            p("Hello")
            p("World")
        }
    }
    println(page.children)
}

hard

A. Compilation error due to missing body class

B. []

C. ["HelloWorld"]

D. ["Hello", "World"]

Solution

1. Step 1: Trace the DSL calls

   The html function creates an Html object and calls body extension, which calls p twice adding paragraphs to children.

2. Step 2: Check the children list content

   Both p calls add strings "

   Hello

   " and "

   World

   " to the children list.

3. Final Answer:

   ["

   Hello

   ", "

   World

   "] -> Option D

4. Quick Check:

   Extensions build nested structure as list of strings [OK]

Hint: Extensions add elements to list step-by-step [OK]

Common Mistakes:

• Expecting nested tags as single string
• Assuming body creates separate object
• Thinking code causes compilation error