storyboard-warp/dev.bnorm.storyboard

Package-level declarations

Types

@Immutable

data class BasicCode(val code: String) : CodeBlock

@Immutable

interface CodeBlock

Represents a Scene that contains code among other things.

CodeToHtmlOptions

external interface CodeToHtmlOptions : JsAny

CodeToTokensOptions

external interface CodeToTokensOptions : JsAny

class Custom(val parser: Parser) : Language

A custom language that is Parser aware

@Immutable

data class DiffContents(val rows: List<List<State>>)

HighlighterCore

external interface HighlighterCore : JsAny

HighlighterCoreOptions

external interface HighlighterCoreOptions : JsAny

JavaScriptRegexEngineOptions

external interface JavaScriptRegexEngineOptions : JsAny

external object JSON

object Json : Language

JavaScript Object notation.

class Keys

object Kotlin : Language

The Kotlin programming language.

sealed interface Language

The canonical list of languages supported for parsing and rendering.

LanguageRegistry

class LanguageRegistry(language: Language) : Registry

interface Parser

A custom parser if you wanted full control on how to parse tokens.

external interface RegexEngine : JsAny

external interface Scope : JsAny

external object ShikiCore

external object ShikiEngine

sealed class State

external interface ThemedToken : JsAny

ThemedTokenScopeExplanation

external interface ThemedTokenScopeExplanation : JsAny

class Token(val content: String, val scope: String, val depth: Int, val language: Language, val allScopes: List<String>, val lineNumber: Int, val startIndex: Int, val endIndex: Int)

The Token that will be passed to the diffing algorithm to find structural similarities.

external interface TokensResult : JsAny

object Xml : Language

XML

Properties

GRAMMAR_REGISTRY

val GRAMMAR_REGISTRY: ScatterMap<Language, Lazy<IGrammarSource>>

A registry of known languages that can parsed and tokenized.

val LANGUAGE_NAMES: ScatterMap<Language, String>

LANGUAGE_REGISTRY

val LANGUAGE_REGISTRY: ScatterMap<Language, JsAny>

val THEME: JsAny

const val THEME_NAME: String

Functions

fun buildDiffList(codeBlocks: List<CodeBlock>, language: Language): List<DiffContents>

Builds a presentation for a group of slides that contain code codeBlocks.

fun State.content(): String

fun diff(previous: List<Token>, current: List<Token>, keys: Keys = Keys()): List<State>

expect fun parse(code: String, language: Language): List<Token>

actual fun parse(code: String, language: Language): List<Token>

actual fun parse(code: String, language: Language): List<Token>