Infix functions in DSLs in Kotlin

Introduction

Infix functions let you write code that looks like natural language. They make your code easier to read and write, especially in small, special languages inside Kotlin called DSLs.

When you want to create a simple, readable way to combine two values or actions.

When building a small language inside Kotlin to describe something clearly, like building HTML or queries.

When you want to call a function with one argument without using dots or parentheses.

When you want your code to look like a sentence for better understanding.

When you want to improve the style of your Kotlin code for specific tasks.

Syntax

Kotlin

infix fun functionName(parameter: Type): ReturnType {
    // function body
}

The function must be a member function or an extension function.

It must have exactly one parameter.

Examples

This defines an infix function times that repeats a string a number of times.

Kotlin

infix fun Int.times(str: String) = str.repeat(this)

Calls the infix function without dots or parentheses, making it look like natural language.

Kotlin

val result = 3 times "Hi"

An infix function to check if a string matches an expected value, useful in tests or DSLs.

Kotlin

infix fun String.shouldBe(expected: String) {
    if (this != expected) throw AssertionError("Expected $expected but got $this")
}

Sample Program

This program defines a Robot class with an infix function moves. It lets you write robot moves "forward" instead of robot.moves("forward"), making it easier to read.

Kotlin

class Robot {
    infix fun moves(direction: String) = "Robot moves $direction"
}

fun main() {
    val robot = Robot()
    println(robot moves "forward")
}

Important Notes

Infix functions improve readability but should be used only when it makes the code clearer.

They can only have one parameter, so they are simple by design.

Use infix functions to create small, easy-to-read DSLs inside Kotlin.

Summary

Infix functions let you call functions with one argument without dots or parentheses.

They make code look like natural language, great for DSLs.

Use them to write clearer and more readable Kotlin code.

Practice

1. What is the main benefit of using infix functions in Kotlin DSLs?

easy

A. They allow calling functions without dots or parentheses, making code more readable.

B. They improve the performance of the program.

C. They enable functions to have multiple return types.

D. They automatically generate UI components.

Solution

1. Step 1: Understand the purpose of infix functions

   Infix functions let you call a function with one argument without using dots or parentheses, making code look cleaner.

2. Step 2: Identify the benefit in DSLs

   This style makes domain-specific languages (DSLs) easier to read and write, resembling natural language.

3. Final Answer:

   They allow calling functions without dots or parentheses, making code more readable. -> Option A

4. Quick Check:

   Infix functions improve readability = C [OK]

Hint: Infix means no dots or parentheses for one-argument calls [OK]

Common Mistakes:

• Thinking infix improves performance
• Believing infix allows multiple return types
• Assuming infix auto-generates UI

2. Which of the following is the correct syntax to declare an infix function in Kotlin?

easy

A. infix fun add(x: Int) { }

B. fun infix add(x: Int) { }

C. fun add infix(x: Int) { }

D. fun add(x: Int) infix { }

Solution

1. Step 1: Recall infix function declaration rules

   In Kotlin, the keyword infix must appear before fun when declaring an infix function.

2. Step 2: Match the correct syntax

   infix fun add(x: Int) { } correctly places infix before fun and declares the function with one parameter.

3. Final Answer:

   infix fun add(x: Int) { } -> Option A

4. Quick Check:

   Keyword order: infix before fun = A [OK]

Hint: Remember: 'infix' keyword comes before 'fun' in declaration [OK]

Common Mistakes:

• Placing 'infix' after function name
• Putting 'infix' after parameter list
• Omitting 'infix' keyword entirely

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

class Builder {
    infix fun add(value: String) {
        println("Added: $value")
    }
}

fun main() {
    val b = Builder()
    b add "Kotlin"
}

medium

A. No output

B. b add Kotlin

C. Syntax error

D. Added: Kotlin

Solution

1. Step 1: Understand infix function call

   The infix function add is called on object b with argument "Kotlin" without dots or parentheses.

2. Step 2: Check the function behavior

   The function prints "Added: Kotlin" to the console.

3. Final Answer:

   Added: Kotlin -> Option D

4. Quick Check:

   Infix call prints 'Added: Kotlin' = A [OK]

Hint: Infix calls print inside function as expected [OK]

Common Mistakes:

• Expecting syntax error due to missing parentheses
• Thinking it prints the call expression
• Assuming no output without explicit print

4. Identify the error in this Kotlin code using an infix function:

class Config {
    infix fun set(key: String, value: String) {
        println("$key = $value")
    }
}

fun main() {
    val c = Config()
    c set ("color", "blue")
}

medium

A. Missing return type declaration.

B. Infix functions cannot have more than one parameter.

C. The function name 'set' is reserved and cannot be infix.

D. Parentheses are not allowed in infix calls.

Solution

1. Step 1: Check infix function parameter count

   Kotlin infix functions must have exactly one parameter, but here set has two parameters.

2. Step 2: Understand the error cause

   This causes a compilation error because infix functions cannot have multiple parameters.

3. Final Answer:

   Infix functions cannot have more than one parameter. -> Option B

4. Quick Check:

   One parameter only for infix = D [OK]

Hint: Infix functions accept exactly one parameter [OK]

Common Mistakes:

• Trying to use multiple parameters in infix
• Assuming parentheses are forbidden in all calls
• Thinking 'set' is a reserved infix name

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

class HtmlTag(val name: String) {
    private val children = mutableListOf<HtmlTag>()
    infix fun add(child: HtmlTag) {
        children.add(child)
    }
    fun render(): String {
        val inner = children.joinToString("") { it.render() }
        return "<$name>$inner</$name>"
    }
}

fun main() {
    val html = HtmlTag("html")
    val body = HtmlTag("body")
    val p = HtmlTag("p")
    html add body
    body add p
    println(html.render())
}

hard

A.

B.

C.

D. Compilation error due to infix usage

Solution

1. Step 1: Understand the infix add function

   The infix function add adds child tags to the parent's children list, building a tree structure.

2. Step 2: Trace the tag hierarchy and rendering

   html adds body, body adds p, so the structure is html > body > p. The render function outputs nested tags accordingly.

3. Final Answer:

   <html><body><p></p></body></html> -> Option C

4. Quick Check:

   Nested tags render correctly = B [OK]

Hint: Infix builds nested structure; render outputs nested tags [OK]

Common Mistakes:

• Mixing tag closing order
• Assuming infix causes compile error
• Ignoring nested children in render