readingbat-core/com.readingbat.dsl

Package-level declarations

Types

ChallengeGroup

class ChallengeGroup<T : Challenge>(val languageGroup: LanguageGroup<T>, groupNameSuffix: GroupName)

A named group of programming challenges within a single language.

ContentCaches

object ContentCaches

Thread-safe caches for DSL code, source files, and directory listings to avoid redundant remote fetches.

ContentDsl

object ContentDsl

Holder for the DSL logger.

GitHubContent

class GitHubContent(ownerType: OwnerType, ownerName: String, repoName: String, branchName: String = "master", srcPath: String = "src/main/kotlin", fileName: String = "Content.kt") : GitHubFile

A reference to a Content DSL file hosted on GitHub.

LanguageGroup

class LanguageGroup<T : Challenge>(content: ReadingBatContent, languageType: LanguageType)

A container for all challenge groups within a single programming language.

LanguageType

enum LanguageType : Enum<LanguageType>

Enumerates the supported programming languages for challenges.

ReadingBatContent

class ReadingBatContent

Top-level container for all ReadingBat content, serving as the root of the DSL hierarchy.

ReadingBatDslMarker

@DslMarker

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.TYPE])

annotation class ReadingBatDslMarker

DSL marker annotation that restricts implicit receiver scope within ReadingBat DSL blocks.

ReturnType

enum ReturnType : Enum<ReturnType>

Defines the expected return type of a challenge function.

Functions

eval

fun ContentSource.eval(enclosingContent: ReadingBatContent, variableName: String = "content"): ReadingBatContent

Loads and evaluates a remote ContentSource (e.g., a GitHubContent file) as a Kotlin script, returning the resulting ReadingBatContent. The DSL file must define a variable with the given variableName (defaults to "content") that holds the ReadingBatContent result.

isProduction

fun isProduction(): Boolean

Returns true if the server is running in production mode. Accessible from Content.kt DSL files.

isTesting

fun isTesting(): Boolean

Returns true if the server is running in test mode. Accessible from Content.kt DSL files.

readingBatContent

fun readingBatContent(block: ReadingBatContent.() -> Unit): ReadingBatContent

Entry point for the ReadingBat content DSL. Creates and configures a ReadingBatContent instance.