110 |
112 |
113 |
40 |
88 |
127 |
128 |
--------------------------------------------------------------------------------
/docs/-inikio/fp.serrano.inikio.plugin/-initial-style-d-s-l/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
89 |
106 |
126 |
107 |
114 |
124 |
125 |
40 |
88 |
131 |
132 |
--------------------------------------------------------------------------------
/docs/-inikio/fp.serrano.inikio/-program-builder/-state/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
89 |
106 |
130 |
107 |
129 |
108 |
109 |
118 |
128 |
110 | Initial
111 |
112 |
113 | Initial
111 | annotation class InitialStyleDSL
Instructs Inikio's KSP plug-in to create a Builder based on this hierarchy.
114 |
115 |
116 |
117 |
40 |
88 |
130 |
131 |
132 |
--------------------------------------------------------------------------------
/docs/-inikio/fp.serrano.inikio/-program-builder/-program-builder.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
40 |
88 |
126 |
127 |
128 |
--------------------------------------------------------------------------------
/gradlew:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 |
3 | #
4 | # Copyright © 2015-2021 the original authors.
5 | #
6 | # Licensed under the Apache License, Version 2.0 (the "License");
7 | # you may not use this file except in compliance with the License.
8 | # You may obtain a copy of the License at
9 | #
10 | # https://www.apache.org/licenses/LICENSE-2.0
11 | #
12 | # Unless required by applicable law or agreed to in writing, software
13 | # distributed under the License is distributed on an "AS IS" BASIS,
14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 | # See the License for the specific language governing permissions and
16 | # limitations under the License.
17 | #
18 | # SPDX-License-Identifier: Apache-2.0
19 | #
20 |
21 | ##############################################################################
22 | #
23 | # Gradle start up script for POSIX generated by Gradle.
24 | #
25 | # Important for running:
26 | #
27 | # (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is
28 | # noncompliant, but you have some other compliant shell such as ksh or
29 | # bash, then to run this script, type that shell name before the whole
30 | # command line, like:
31 | #
32 | # ksh Gradle
33 | #
34 | # Busybox and similar reduced shells will NOT work, because this script
35 | # requires all of these POSIX shell features:
36 | # * functions;
37 | # * expansions «$var», «${var}», «${var:-default}», «${var+SET}»,
38 | # «${var#prefix}», «${var%suffix}», and «$( cmd )»;
39 | # * compound commands having a testable exit status, especially «case»;
40 | # * various built-in commands including «command», «set», and «ulimit».
41 | #
42 | # Important for patching:
43 | #
44 | # (2) This script targets any POSIX shell, so it avoids extensions provided
45 | # by Bash, Ksh, etc; in particular arrays are avoided.
46 | #
47 | # The "traditional" practice of packing multiple parameters into a
48 | # space-separated string is a well documented source of bugs and security
49 | # problems, so this is (mostly) avoided, by progressively accumulating
50 | # options in "$@", and eventually passing that to Java.
51 | #
52 | # Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS,
53 | # and GRADLE_OPTS) rely on word-splitting, this is performed explicitly;
54 | # see the in-line comments for details.
55 | #
56 | # There are tweaks for specific operating systems such as AIX, CygWin,
57 | # Darwin, MinGW, and NonStop.
58 | #
59 | # (3) This script is generated from the Groovy template
60 | # https://github.com/gradle/gradle/blob/HEAD/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
61 | # within the Gradle project.
62 | #
63 | # You can find Gradle at https://github.com/gradle/gradle/.
64 | #
65 | ##############################################################################
66 |
67 | # Attempt to set APP_HOME
68 |
69 | # Resolve links: $0 may be a link
70 | app_path=$0
71 |
72 | # Need this for daisy-chained symlinks.
73 | while
74 | APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path
75 | [ -h "$app_path" ]
76 | do
77 | ls=$( ls -ld "$app_path" )
78 | link=${ls#*' -> '}
79 | case $link in #(
80 | /*) app_path=$link ;; #(
81 | *) app_path=$APP_HOME$link ;;
82 | esac
83 | done
84 |
85 | # This is normally unused
86 | # shellcheck disable=SC2034
87 | APP_BASE_NAME=${0##*/}
88 | # Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036)
89 | APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s\n' "$PWD" ) || exit
90 |
91 | # Use the maximum available, or set MAX_FD != -1 to use that value.
92 | MAX_FD=maximum
93 |
94 | warn () {
95 | echo "$*"
96 | } >&2
97 |
98 | die () {
99 | echo
100 | echo "$*"
101 | echo
102 | exit 1
103 | } >&2
104 |
105 | # OS specific support (must be 'true' or 'false').
106 | cygwin=false
107 | msys=false
108 | darwin=false
109 | nonstop=false
110 | case "$( uname )" in #(
111 | CYGWIN* ) cygwin=true ;; #(
112 | Darwin* ) darwin=true ;; #(
113 | MSYS* | MINGW* ) msys=true ;; #(
114 | NONSTOP* ) nonstop=true ;;
115 | esac
116 |
117 | CLASSPATH="\\\"\\\""
118 |
119 |
120 | # Determine the Java command to use to start the JVM.
121 | if [ -n "$JAVA_HOME" ] ; then
122 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
123 | # IBM's JDK on AIX uses strange locations for the executables
124 | JAVACMD=$JAVA_HOME/jre/sh/java
125 | else
126 | JAVACMD=$JAVA_HOME/bin/java
127 | fi
128 | if [ ! -x "$JAVACMD" ] ; then
129 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
130 |
131 | Please set the JAVA_HOME variable in your environment to match the
132 | location of your Java installation."
133 | fi
134 | else
135 | JAVACMD=java
136 | if ! command -v java >/dev/null 2>&1
137 | then
138 | die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
139 |
140 | Please set the JAVA_HOME variable in your environment to match the
141 | location of your Java installation."
142 | fi
143 | fi
144 |
145 | # Increase the maximum file descriptors if we can.
146 | if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
147 | case $MAX_FD in #(
148 | max*)
149 | # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked.
150 | # shellcheck disable=SC2039,SC3045
151 | MAX_FD=$( ulimit -H -n ) ||
152 | warn "Could not query maximum file descriptor limit"
153 | esac
154 | case $MAX_FD in #(
155 | '' | soft) :;; #(
156 | *)
157 | # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked.
158 | # shellcheck disable=SC2039,SC3045
159 | ulimit -n "$MAX_FD" ||
160 | warn "Could not set maximum file descriptor limit to $MAX_FD"
161 | esac
162 | fi
163 |
164 | # Collect all arguments for the java command, stacking in reverse order:
165 | # * args from the command line
166 | # * the main class name
167 | # * -classpath
168 | # * -D...appname settings
169 | # * --module-path (only if needed)
170 | # * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables.
171 |
172 | # For Cygwin or MSYS, switch paths to Windows format before running java
173 | if "$cygwin" || "$msys" ; then
174 | APP_HOME=$( cygpath --path --mixed "$APP_HOME" )
175 | CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" )
176 |
177 | JAVACMD=$( cygpath --unix "$JAVACMD" )
178 |
179 | # Now convert the arguments - kludge to limit ourselves to /bin/sh
180 | for arg do
181 | if
182 | case $arg in #(
183 | -*) false ;; # don't mess with options #(
184 | /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath
185 | [ -e "$t" ] ;; #(
186 | *) false ;;
187 | esac
188 | then
189 | arg=$( cygpath --path --ignore --mixed "$arg" )
190 | fi
191 | # Roll the args list around exactly as many times as the number of
192 | # args, so each arg winds up back in the position where it started, but
193 | # possibly modified.
194 | #
195 | # NB: a `for` loop captures its iteration list before it begins, so
196 | # changing the positional parameters here affects neither the number of
197 | # iterations, nor the values presented in `arg`.
198 | shift # remove old arg
199 | set -- "$@" "$arg" # push replacement arg
200 | done
201 | fi
202 |
203 |
204 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
205 | DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
206 |
207 | # Collect all arguments for the java command:
208 | # * DEFAULT_JVM_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments,
209 | # and any embedded shellness will be escaped.
210 | # * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be
211 | # treated as '${Hostname}' itself on the command line.
212 |
213 | set -- \
214 | "-Dorg.gradle.appname=$APP_BASE_NAME" \
215 | -classpath "$CLASSPATH" \
216 | -jar "$APP_HOME/gradle/wrapper/gradle-wrapper.jar" \
217 | "$@"
218 |
219 | # Stop when "xargs" is not available.
220 | if ! command -v xargs >/dev/null 2>&1
221 | then
222 | die "xargs is not available"
223 | fi
224 |
225 | # Use "xargs" to parse quoted args.
226 | #
227 | # With -n1 it outputs one arg per line, with the quotes and backslashes removed.
228 | #
229 | # In Bash we could simply go:
230 | #
231 | # readarray ARGS < <( xargs -n1 <<<"$var" ) &&
232 | # set -- "${ARGS[@]}" "$@"
233 | #
234 | # but POSIX shell has neither arrays nor command substitution, so instead we
235 | # post-process each arg (as a line of input to sed) to backslash-escape any
236 | # character that might be a shell metacharacter, then use eval to reverse
237 | # that process (while maintaining the separation between arguments), and wrap
238 | # the whole thing up as a single "set" statement.
239 | #
240 | # This will of course break if any of these variables contains a newline or
241 | # an unmatched quote.
242 | #
243 |
244 | eval "set -- $(
245 | printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" |
246 | xargs -n1 |
247 | sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' |
248 | tr '\n' ' '
249 | )" '"$@"'
250 |
251 | exec "$JAVACMD" "$@"
252 |
--------------------------------------------------------------------------------
/inikio-core/README.md:
--------------------------------------------------------------------------------
1 | # Module Inikio
2 |
3 | > Better initial-style DSLs in Kotlin
4 | 10 | 11 | * Initial-style DSLs 12 | * Execution 13 | *
suspended syntax
14 | * Compiler plug-in
15 | * Examples of DSLs
16 |
17 | Gradle set-up
18 | 19 | Inikio is available through [Jitpack](https://jitpack.io/). 20 | 21 | ```kotlin 22 | repositories { 23 | maven(url = "https://jitpack.io") 24 | } 25 | dependencies { 26 | implementation("com.github.serras.inikio:inikio-core:$inikioVersion") 27 | } 28 | ``` 29 | 30 |Initial-style DSLs
31 | 32 | Sometimes you need to model actions or behaviors as part of your model. For example, [rules for filtering data](https://engineering.fb.com/2015/06/26/security/fighting-spam-with-haskell/), [smart contracts](https://github.com/epfl-lara/smart/blob/master/core/src/sphinx/smartcontracts.rst), or [trading card games](https://serranofp.com/zurihac-workshop/). In most cases these actions come from a particular language, called a _domain-specific language_ (DSL for short). Some people separate those actions from the programming language were they are used by means tools like [JetBrains MPS](https://www.jetbrains.com/mps/), but here we're concerned with actually representing those actions in our favorite programming language, Kotlin. 33 | 34 | There are different patterns to embed DSLs in an existing language. _Initial-style_ is one of them, referring to the case in which the actions are represented as _data_. Here's an example showing the basic elements of this pattern: 35 | 36 | ```kotlin 37 | sealed interface CasinoExecution
66 | 67 | Values of that initial-style DSL can be _executed_ in different ways (sometimes we also say they are _interpreted_). In fact, the main advantage of describing actions using this pattern is that writing those interpretations is much simpler than in others. In most cases, you have a big `when` to handle each of the primitive instructions, which calls itself (tail recursively) with the continuation. 68 | 69 | ```kotlin 70 | tailrec fun Casino.execute(): A = 71 | when(this) { 72 | is Done -> result 73 | is FlipCoin -> next(Random.nextFlipOutcome()).execute() 74 | } 75 | 76 | fun Random.nextFlipOutcome(): FlipCoin.Outcome = 77 | if (nextBoolean()) FlipCoin.Outcome.HEADS else FlipCoin.Outcome.TAILS 78 | ``` 79 | 80 |suspended syntax
81 |
82 | As useful as it is for writing interpretations, initial-style DSLs suffer from a not-so-nice interface for creating values. The `doubleCoin` above is a prime example: you need to nest everytime you use a primitive action, and remember to wrap the final result with `Done`. Conceptually, though, that problem is a _sequence_ of operations, and we would like that to be reflected in the way we write our code.
83 |
84 | Fortunately, [Kotlin's coroutine system](https://kotlinlang.org/docs/coroutines-overview.html) gives us enough tools to fulfill our wishes. Inikio just wraps them in a nice package, and provides a small compiler plug-in for the boilerplate we need to write. The main idea is to have a `Builder` in which each primitive operation is represented as a `suspend`ed method, and a runner which turns the `Builder` into the actual initial-style DSL.
85 |
86 | ```kotlin
87 | // the builder class
88 | class CasinoBuilder: ProgramBuilder
40 |
88 |
151 |
152 |
--------------------------------------------------------------------------------
/docs/-inikio/fp.serrano.inikio/-program-builder/perform-unit.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
89 |
106 |
150 |
107 |
149 |
108 |
109 |
138 |
148 |
110 | Fixed
111 |
112 |
113 |
137 | Fixed
111 | Indicates that this DSL has a fixed result type, instead of being polymorphic on the result type.
The type must be a fully-qualified name. Unfortunately we cannot use a Class here because of limitations of KSP + Kotlin Multiplatform.
40 |
88 |
127 |
128 |
--------------------------------------------------------------------------------
/docs/-inikio/fp.serrano.inikio/-program-builder/perform.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
89 |
106 |
126 |
107 |
125 |
108 |
109 |
113 |
114 |
124 |
110 | perform
111 |
112 | perform
111 | Record the execution of an action which doesn't consume any value.
Record the execution of an action which doesn't consume any value, and requires an additional argument of type A.
Record the execution of an action which doesn't consume any value, and requires additional arguments of types A and B.
40 |
88 |
127 |
128 |
--------------------------------------------------------------------------------
/docs/-inikio/fp.serrano.inikio/program.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
89 |
106 |
126 |
107 |
125 |
108 |
109 |
113 |
114 |
124 |
110 |
112 | perform
111 |Record the execution of an action which consumes a value of type R.
Record the execution of an action which consumes a value of type R, and requires an additional argument of type A.
Record the execution of an action which consumes a value of type R, and requires additional arguments of types A and B.
40 |
88 |
127 |
128 |
--------------------------------------------------------------------------------
/docs/scripts/platform-content-handler.js:
--------------------------------------------------------------------------------
1 | /*
2 | * Copyright 2014-2024 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
3 | */
4 | /** When Dokka is viewed via iframe, local storage could be inaccessible (see https://github.com/Kotlin/dokka/issues/3323)
5 | * This is a wrapper around local storage to prevent errors in such cases
6 | * */
7 | const safeLocalStorage = (() => {
8 | let isLocalStorageAvailable = false;
9 | try {
10 | const testKey = '__testLocalStorageKey__';
11 | localStorage.setItem(testKey, testKey);
12 | localStorage.removeItem(testKey);
13 | isLocalStorageAvailable = true;
14 | } catch (e) {
15 | console.error('Local storage is not available', e);
16 | }
17 |
18 | return {
19 | getItem: (key) => {
20 | if (!isLocalStorageAvailable) {
21 | return null;
22 | }
23 | return localStorage.getItem(key);
24 | },
25 | setItem: (key, value) => {
26 | if (!isLocalStorageAvailable) {
27 | return;
28 | }
29 | localStorage.setItem(key, value);
30 | }
31 | };
32 | })();
33 |
34 | filteringContext = {
35 | dependencies: {},
36 | restrictedDependencies: [],
37 | activeFilters: []
38 | }
39 | let highlightedAnchor;
40 | let topNavbarOffset;
41 | let instances = [];
42 | let sourcesetNotification;
43 |
44 | const samplesDarkThemeName = 'darcula'
45 | const samplesLightThemeName = 'idea'
46 |
47 | window.addEventListener('load', () => {
48 | document.querySelectorAll("div[data-platform-hinted]")
49 | .forEach(elem => elem.addEventListener('click', (event) => togglePlatformDependent(event, elem)))
50 | const filterSection = document.getElementById('filter-section')
51 | if (filterSection) {
52 | filterSection.addEventListener('click', (event) => filterButtonHandler(event))
53 | initializeFiltering()
54 | }
55 | if (typeof initTabs === 'function') {
56 | initTabs() // initTabs comes from ui-kit/tabs
57 | }
58 | handleAnchor()
59 | topNavbarOffset = document.getElementById('navigation-wrapper')
60 | darkModeSwitch()
61 | })
62 |
63 | const darkModeSwitch = () => {
64 | const localStorageKey = "dokka-dark-mode"
65 | const storage = safeLocalStorage.getItem(localStorageKey)
66 | const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
67 | const darkModeEnabled = storage ? JSON.parse(storage) : osDarkSchemePreferred
68 | const element = document.getElementById("theme-toggle-button")
69 | initPlayground(darkModeEnabled ? samplesDarkThemeName : samplesLightThemeName)
70 |
71 | element.addEventListener('click', () => {
72 | const enabledClasses = document.getElementsByTagName("html")[0].classList
73 | enabledClasses.toggle("theme-dark")
74 |
75 | //if previously we had saved dark theme then we set it to light as this is what we save in local storage
76 | const darkModeEnabled = enabledClasses.contains("theme-dark")
77 | if (darkModeEnabled) {
78 | initPlayground(samplesDarkThemeName)
79 | } else {
80 | initPlayground(samplesLightThemeName)
81 | }
82 | safeLocalStorage.setItem(localStorageKey, JSON.stringify(darkModeEnabled))
83 | })
84 | }
85 |
86 | const initPlayground = (theme) => {
87 | if (!samplesAreEnabled()) return
88 | instances.forEach(instance => instance.destroy())
89 | instances = []
90 |
91 | // Manually tag code fragments as not processed by playground since we also manually destroy all of its instances
92 | document.querySelectorAll('code.runnablesample').forEach(node => {
93 | node.removeAttribute("data-kotlin-playground-initialized");
94 | })
95 |
96 | KotlinPlayground('code.runnablesample', {
97 | getInstance: playgroundInstance => {
98 | instances.push(playgroundInstance)
99 | },
100 | theme: theme
101 | });
102 | }
103 |
104 | // We check if type is accessible from the current scope to determine if samples script is present
105 | // As an alternative we could extract this samples-specific script to new js file but then we would handle dark mode in 2 separate files which is not ideal
106 | const samplesAreEnabled = () => {
107 | try {
108 | if (typeof KotlinPlayground === 'undefined') {
109 | // KotlinPlayground is exported universally as a global variable or as a module
110 | // Due to possible interaction with other js scripts KotlinPlayground may not be accessible directly from `window`, so we need an additional check
111 | KotlinPlayground = exports.KotlinPlayground;
112 | }
113 | return typeof KotlinPlayground === 'function';
114 | } catch (e) {
115 | return false
116 | }
117 | }
118 |
119 | // Hash change is needed in order to allow for linking inside the same page with anchors
120 | // If this is not present user is forced to refresh the site in order to use an anchor
121 | window.onhashchange = handleAnchor
122 |
123 | function scrollToElementInContent(element) {
124 | const scrollToElement = () => document.getElementById('main').scrollTo({
125 | top: element.offsetTop - topNavbarOffset.offsetHeight,
126 | behavior: "smooth"
127 | })
128 |
129 | const waitAndScroll = () => {
130 | setTimeout(() => {
131 | if (topNavbarOffset) {
132 | scrollToElement()
133 | } else {
134 | waitForScroll()
135 | }
136 | }, 50)
137 | }
138 |
139 | if (topNavbarOffset) {
140 | scrollToElement()
141 | } else {
142 | waitAndScroll()
143 | }
144 | }
145 |
146 |
147 | function handleAnchor() {
148 | if (highlightedAnchor) {
149 | highlightedAnchor.classList.remove('anchor-highlight')
150 | highlightedAnchor = null;
151 | }
152 |
153 | let searchForContentTarget = function (element) {
154 | if (element && element.hasAttribute) {
155 | if (element.hasAttribute("data-togglable")) return element.getAttribute("data-togglable");
156 | else return searchForContentTarget(element.parentNode)
157 | } else return null
158 | }
159 |
160 | let findAnyTab = function (target) {
161 | let result = null
162 | document.querySelectorAll('div[tabs-section] > button[data-togglable]')
163 | .forEach(node => {
164 | if(node.getAttribute("data-togglable").split(",").includes(target)) {
165 | result = node
166 | }
167 | })
168 | return result
169 | }
170 |
171 | let anchor = window.location.hash
172 | if (anchor !== "") {
173 | anchor = anchor.substring(1)
174 | let element = document.querySelector('a[data-name="' + anchor + '"]')
175 |
176 | if (element) {
177 | const content = element.nextElementSibling
178 | const contentStyle = window.getComputedStyle(content)
179 | if(contentStyle.display === 'none') {
180 | let tab = findAnyTab(searchForContentTarget(content))
181 | if (tab) {
182 | toggleSections(tab) // toggleSections comes from ui-kit/tabs
183 | }
184 | }
185 |
186 | if (content) {
187 | content.classList.add('anchor-highlight')
188 | highlightedAnchor = content
189 | }
190 |
191 | scrollToElementInContent(element)
192 | }
193 | }
194 | }
195 |
196 | function filterButtonHandler(event) {
197 | if (event.target.tagName === "BUTTON" && event.target.hasAttribute("data-filter")) {
198 | let sourceset = event.target.getAttribute("data-filter")
199 | if (filteringContext.activeFilters.indexOf(sourceset) !== -1) {
200 | filterSourceset(sourceset)
201 | } else {
202 | unfilterSourceset(sourceset)
203 | }
204 | }
205 | }
206 |
207 | function initializeFiltering() {
208 | filteringContext.dependencies = JSON.parse(sourceset_dependencies)
209 | document.querySelectorAll("#filter-section > button")
210 | .forEach(p => filteringContext.restrictedDependencies.push(p.getAttribute("data-filter")))
211 | Object.keys(filteringContext.dependencies).forEach(p => {
212 | filteringContext.dependencies[p] = filteringContext.dependencies[p]
213 | .filter(q => -1 !== filteringContext.restrictedDependencies.indexOf(q))
214 | })
215 | let cached = safeLocalStorage.getItem('inactive-filters')
216 | if (cached) {
217 | let parsed = JSON.parse(cached)
218 | filteringContext.activeFilters = filteringContext.restrictedDependencies
219 | .filter(q => parsed.indexOf(q) === -1)
220 | } else {
221 | filteringContext.activeFilters = filteringContext.restrictedDependencies
222 | }
223 | refreshFiltering()
224 | }
225 |
226 | function filterSourceset(sourceset) {
227 | filteringContext.activeFilters = filteringContext.activeFilters.filter(p => p !== sourceset)
228 | refreshFiltering()
229 | addSourcesetFilterToCache(sourceset)
230 | }
231 |
232 | function unfilterSourceset(sourceset) {
233 | if (filteringContext.activeFilters.length === 0) {
234 | filteringContext.activeFilters = filteringContext.dependencies[sourceset].concat([sourceset])
235 | refreshFiltering()
236 | filteringContext.dependencies[sourceset].concat([sourceset]).forEach(p => removeSourcesetFilterFromCache(p))
237 | } else {
238 | filteringContext.activeFilters.push(sourceset)
239 | refreshFiltering()
240 | removeSourcesetFilterFromCache(sourceset)
241 | }
242 |
243 | }
244 |
245 | function addSourcesetFilterToCache(sourceset) {
246 | let cached = safeLocalStorage.getItem('inactive-filters')
247 | if (cached) {
248 | let parsed = JSON.parse(cached)
249 | safeLocalStorage.setItem('inactive-filters', JSON.stringify(parsed.concat([sourceset])))
250 | } else {
251 | safeLocalStorage.setItem('inactive-filters', JSON.stringify([sourceset]))
252 | }
253 | }
254 |
255 | function removeSourcesetFilterFromCache(sourceset) {
256 | let cached = safeLocalStorage.getItem('inactive-filters')
257 | if (cached) {
258 | let parsed = JSON.parse(cached)
259 | safeLocalStorage.setItem('inactive-filters', JSON.stringify(parsed.filter(p => p !== sourceset)))
260 | }
261 | }
262 |
263 | function refreshSourcesetsCache() {
264 | safeLocalStorage.setItem('inactive-filters', JSON.stringify(filteringContext.restrictedDependencies.filter(p => -1 === filteringContext.activeFilters.indexOf(p))))
265 | }
266 |
267 |
268 | function togglePlatformDependent(e, container) {
269 | let target = e.target
270 | if (target.tagName !== 'BUTTON') return;
271 | let index = target.getAttribute('data-toggle')
272 |
273 | for (let child of container.children) {
274 | if (child.hasAttribute('data-toggle-list')) {
275 | for (let bm of child.children) {
276 | if (bm === target) {
277 | bm.setAttribute('data-active', "")
278 | } else if (bm !== target) {
279 | bm.removeAttribute('data-active')
280 | }
281 | }
282 | } else if (child.getAttribute('data-togglable') === index) {
283 | child.setAttribute('data-active', "")
284 | } else {
285 | child.removeAttribute('data-active')
286 | }
287 | }
288 | }
289 |
290 | function refreshFiltering() {
291 | let sourcesetList = filteringContext.activeFilters
292 | document.querySelectorAll("[data-filterable-set]")
293 | .forEach(
294 | elem => {
295 | let platformList = elem.getAttribute("data-filterable-set").split(',').filter(v => -1 !== sourcesetList.indexOf(v))
296 | elem.setAttribute("data-filterable-current", platformList.join(','))
297 | }
298 | )
299 | refreshFilterButtons()
300 | refreshPlatformTabs()
301 | refreshNoContentNotification()
302 | refreshPlaygroundSamples()
303 | }
304 |
305 | function refreshPlaygroundSamples() {
306 | document.querySelectorAll('code.runnablesample').forEach(node => {
307 | const playground = node.KotlinPlayground;
308 | /* Some samples may be hidden by filter, they have 0px height for visible code area
309 | * after rendering. Call this method for re-calculate code area height */
310 | playground && playground.view.codemirror.refresh();
311 | });
312 | }
313 |
314 | function refreshNoContentNotification() {
315 | const element = document.getElementsByClassName("main-content")[0]
316 | const filteredMessage = document.querySelector(".filtered-message")
317 |
318 | if(filteringContext.activeFilters.length === 0){
319 | element.style.display = "none";
320 |
321 | if (!filteredMessage) {
322 | const appended = document.createElement("div")
323 | appended.className = "filtered-message"
324 | appended.innerText = "All documentation is filtered, please adjust your source set filters in top-right corner of the screen"
325 | sourcesetNotification = appended
326 | element.parentNode.prepend(appended)
327 | }
328 | } else {
329 | if(sourcesetNotification) sourcesetNotification.remove()
330 | element.style.display = "block"
331 | }
332 | }
333 |
334 | function refreshPlatformTabs() {
335 | document.querySelectorAll(".platform-hinted > .platform-bookmarks-row").forEach(
336 | p => {
337 | let active = false;
338 | let firstAvailable = null
339 | p.childNodes.forEach(
340 | element => {
341 | if (element.getAttribute("data-filterable-current") !== '') {
342 | if (firstAvailable === null) {
343 | firstAvailable = element
344 | }
345 | if (element.hasAttribute("data-active")) {
346 | active = true;
347 | }
348 | }
349 | }
350 | )
351 | if (active === false && firstAvailable) {
352 | firstAvailable.click()
353 | }
354 | }
355 | )
356 | }
357 |
358 | function refreshFilterButtons() {
359 | document.querySelectorAll("#filter-section > button")
360 | .forEach(f => {
361 | if (filteringContext.activeFilters.indexOf(f.getAttribute("data-filter")) !== -1) {
362 | f.setAttribute("data-active", "")
363 | } else {
364 | f.removeAttribute("data-active")
365 | }
366 | })
367 | document.querySelectorAll("#filter-section .checkbox--input")
368 | .forEach(f => {
369 | f.checked = filteringContext.activeFilters.indexOf(f.getAttribute("data-filter")) !== -1;
370 | })
371 | }
372 |
--------------------------------------------------------------------------------
/docs/-inikio/fp.serrano.inikio.plugin/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
89 |
106 |
126 |
107 |
125 |
108 |
109 |
113 |
114 |
124 |
110 |
112 | program
111 |fun <Action, Result> program(endWith: (Result) -> Action, f: suspend ProgramBuilder<Action, Result>.() -> Result): Action
Turns the DSL provided by ProgramBuilder into an actual Action. This version is used for "pure" programs with no exceptional cases.
Parameters
end
Reference to the "final" instruction in Action.
Throws
fun <Action, Result> program(endWith: (Result) -> Action, exceptional: (Throwable) -> Action, f: suspend ProgramBuilder<Action, Result>.() -> Result): Action
Turns the DSL provided by ProgramBuilder into an actual Action.
Parameters
end
Reference to the "final" instruction in Action.
exceptional
Reference to the "error" instruction in Action.
fun <Action, Result, T : ProgramBuilder<Action, Result>> program(machine: T, f: suspend T.() -> Result): Action
Turns the DSL provided by a subclass T of ProgramBuilder into an actual Action.
40 |
88 |
166 |
167 |
--------------------------------------------------------------------------------
89 |
106 |
165 |
107 |
164 |
108 |
109 |
153 |
163 |
110 | Step 3, enjoy your new
112 |
113 | Package-level declarations
111 |Information about Inikio's compiler plug-in, that creates Builders automatically for your initial-style DSLs.
Step 1, add the plug-in to your build
The plug-in is based on KSP. If you are using Gradle you need to add the following to your build file.
repositories {
mavenCentral()
maven(url = "https://jitpack.io")
}
plugins {
id("com.google.devtools.ksp") version "2.0.20-1.0.24"
}
dependencies {
implementation("com.github.serras.inikio:inikio-core:$inikioVersion")
ksp("com.github.serras.inikio:inikio-ksp:$inikioVersion")
}Content copied to clipboard
If IntelliJ is your IDE of choice, we recommend configuring your build to make it aware of KSP.
Step 2, annotate your DSLs
You only need to add the @InitialStyleDSL annotation to the top of your hierarchy. Remember that you need to have one "finished" variant, in the example below is Done.
@InitialStyleDSL
sealed interface Casino<out A>
data class Done<out A>(val result: A): Casino<A>
data class FlipCoin<out A>(val next: (Outcome) -> Casino<A>): Casino<A> {
enum class Outcome { HEADS, TAILS }
}Content copied to clipboard
Step 3, enjoy your new Builder
From the definition above the plug-in generates a Builder class and a runner function.
The
Builderclass contains a method for each variant in the DSL, that is, for each basic instruction in your DSL.class CasinoBuilder<A> {
suspend fun flipCoin(): FlipCoin.Outcome
}Content copied to clipboardThe runner function takes a block with the
Builderas receiver, and converts it into the initial-style DSL.fun <A> casino(block: CasinoBuilder<A>.() -> A): Casino<A>Content copied to clipboard
You can use the combination of the runner and the Builder methods to create values of your initial-style DSL. For example, the following defines a game when only two heads win.
val doubleCoin = casino {
val o1 = flipCoin()
val o2 = flipCoin()
if (o1 == Outcome.HEADS && o2 == Outcome.HEADS) WIN
else LOSE
}Content copied to clipboard
Note the much nicer syntax with suspend that what you'd get with the data classes themselves. In particular, all the nesting is gone, and there's no need to call the final Done. The code above is equivalent to the following.
val casino =
FlipCoin { o1 ->
FlipCoin { o2 ->
if (o1 == Outcome.HEADS && o2 == Outcome.HEADS)
Done(WIN)
else
Done(LOSE)
}
}Content copied to clipboard
114 |
115 |
152 |
116 |
151 |
117 |
150 | Types
118 |
119 |
149 |
120 |
133 |
134 |
121 |
132 |
122 |
123 |
124 |
126 | Link copied to clipboard
125 |
127 |
131 |
128 |
129 |
130 | Indicates that this DSL has a fixed result type, instead of being polymorphic on the result type.
135 |
148 |
136 |
147 |
137 |
138 |
139 |
141 | Link copied to clipboard
140 |
142 |
146 |
143 |
144 |
145 | annotation class InitialStyleDSL
Instructs Inikio's KSP plug-in to create a Builder based on this hierarchy.