Compare commits
86 Commits
v1.0.4
...
1f60b854de
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
1f60b854de | ||
|
|
100054585f | ||
|
|
a7018b8c61 | ||
|
|
bec1fe02a7 | ||
|
|
69d19f89e3 | ||
|
|
c9bbea59b0 | ||
|
|
e1f01c4e2d | ||
|
|
c45c5b7afa | ||
|
|
6de95f7976 | ||
|
|
ea0b4fa95c | ||
|
|
9d52b152bd | ||
|
|
0fc7b16664 | ||
|
|
d3086a5ced | ||
|
|
2071084964 | ||
|
|
f51964831a | ||
|
|
60c50f078d | ||
|
|
54f5074483 | ||
|
|
772eeb0465 | ||
|
|
456f889b9c | ||
|
|
c3a4ca5925 | ||
|
|
06dc507590 | ||
|
|
5eaf027dba | ||
|
|
04c3728fcd | ||
|
|
d34050e9af | ||
|
|
2c8381deac | ||
|
|
4aacbc9dbc | ||
|
|
8a4e677ebf | ||
|
|
84e85f3240 | ||
|
|
e34a85ac39 | ||
|
|
c306088ea3 | ||
|
|
308c37720d | ||
|
|
90af315222 | ||
|
|
bd5e4f07ae | ||
|
|
ae4757fb9d | ||
|
|
5dd586f9af | ||
|
|
b69e838a8a | ||
|
|
8a2710339a | ||
|
|
dd773e3b16 | ||
|
|
72c94f280d | ||
|
|
809914274a | ||
|
|
6f16f1cb85 | ||
|
|
cad5b2dd95 | ||
|
|
74a6a65434 | ||
|
|
b0a6c701ae | ||
|
|
1bd47fcb21 | ||
|
|
20bd96918c | ||
|
|
60805b7187 | ||
|
|
12b1df764c | ||
|
|
43b8982b88 | ||
|
|
7be868648b | ||
|
|
1702d8dfb5 | ||
|
|
8ac2901e23 | ||
|
|
e47c8593da | ||
|
|
060f557752 | ||
|
|
224e4d8a29 | ||
|
|
4c8c8ecb05 | ||
|
|
1199ae2d14 | ||
|
|
784ab07442 | ||
|
|
0e53380420 | ||
|
|
c2ebd5dfe4 | ||
|
|
c320411a40 | ||
|
|
3c3d418aa2 | ||
|
|
f00ab975dc | ||
|
|
eb2d5f07be | ||
|
|
3f166aced0 | ||
|
|
8dbbd3b2f8 | ||
|
|
f8206013c2 | ||
|
|
cf3e5e2c6a | ||
|
|
5cdf1a9cbc | ||
|
|
c30d516bd2 | ||
|
|
dc0317daba | ||
|
|
9834cbf07c | ||
|
|
1b08504ab9 | ||
|
|
d49d813ab5 | ||
|
|
5dd80035e4 | ||
|
|
3e5401bd9d | ||
|
|
38c3c268c0 | ||
|
|
497aa61154 | ||
|
|
0ece34daf2 | ||
|
|
0a04ecd532 | ||
|
|
567e134b97 | ||
|
|
5adaec9c92 | ||
|
|
541249c84b | ||
|
|
9bf01704ee | ||
|
|
44acda139c | ||
|
|
6b57541b03 |
@@ -1,86 +0,0 @@
|
|||||||
version: 2.1
|
|
||||||
jobs:
|
|
||||||
build:
|
|
||||||
working_directory: ~/code
|
|
||||||
docker:
|
|
||||||
- image: circleci/android:api-29
|
|
||||||
environment:
|
|
||||||
JVM_OPTS: -Xmx3200m
|
|
||||||
steps:
|
|
||||||
- checkout
|
|
||||||
- restore_cache:
|
|
||||||
key: jars-{{ checksum "build.gradle" }}-{{ checksum "app/build.gradle" }}
|
|
||||||
- run:
|
|
||||||
name: Download Dependencies
|
|
||||||
command: ./gradlew androidDependencies
|
|
||||||
- save_cache:
|
|
||||||
paths:
|
|
||||||
- ~/.gradle
|
|
||||||
key: jars-{{ checksum "build.gradle" }}-{{ checksum "app/build.gradle" }}
|
|
||||||
|
|
||||||
tests:
|
|
||||||
working_directory: ~/code
|
|
||||||
docker:
|
|
||||||
- image: circleci/android:api-29
|
|
||||||
environment:
|
|
||||||
JVM_OPTS: -Xmx3200m
|
|
||||||
steps:
|
|
||||||
- checkout
|
|
||||||
- restore_cache:
|
|
||||||
key: jars-{{ checksum "build.gradle" }}-{{ checksum "app/build.gradle" }}
|
|
||||||
- store_artifacts:
|
|
||||||
path: app/build/reports
|
|
||||||
destination: reports
|
|
||||||
- run:
|
|
||||||
name: Run Lint Test
|
|
||||||
command: ./gradlew lint
|
|
||||||
- run:
|
|
||||||
name: Run Tests
|
|
||||||
command: ./gradlew lint test
|
|
||||||
- store_artifacts:
|
|
||||||
path: app/build/reports
|
|
||||||
destination: reports
|
|
||||||
- store_test_results:
|
|
||||||
path: app/build/test-results
|
|
||||||
|
|
||||||
deploy:
|
|
||||||
working_directory: ~/code
|
|
||||||
docker:
|
|
||||||
- image: circleci/android:api-29
|
|
||||||
environment:
|
|
||||||
JVM_OPTS: -Xmx3200m
|
|
||||||
steps:
|
|
||||||
- checkout
|
|
||||||
- restore_cache:
|
|
||||||
key: jars-{{ checksum "build.gradle" }}-{{ checksum "app/build.gradle" }}
|
|
||||||
- run:
|
|
||||||
name: Build Library
|
|
||||||
command: ./gradlew :treedatastructure:assembleRelease
|
|
||||||
- run:
|
|
||||||
name: Export key
|
|
||||||
command: |
|
|
||||||
mkdir treedatastructure/maven
|
|
||||||
echo ${GPG_KEY_CONTENTS} | base64 -d --ignore-garbage > treedatastructure/maven/secret.gpg
|
|
||||||
- run:
|
|
||||||
name: Staging
|
|
||||||
command: ./gradlew :treedatastructure:publishReleasePublicationToSonatypeRepository
|
|
||||||
- run:
|
|
||||||
name: Release Library
|
|
||||||
command: ./gradlew closeAndReleaseRepository
|
|
||||||
|
|
||||||
workflows:
|
|
||||||
version: 2.1
|
|
||||||
build-and-deploy:
|
|
||||||
jobs:
|
|
||||||
- build
|
|
||||||
filters: # required since `deploy` has tag filters AND requires `build`
|
|
||||||
tags:
|
|
||||||
only: /.*/
|
|
||||||
- deploy:
|
|
||||||
requires:
|
|
||||||
- build
|
|
||||||
filters:
|
|
||||||
tags:
|
|
||||||
only: /v[0-9]{1,3}\.[0-9]{1,3}\.?[0-9]{0,3}/
|
|
||||||
branches:
|
|
||||||
ignore: /.*/
|
|
||||||
46
.github/workflows/docs.yml
vendored
Normal file
@@ -0,0 +1,46 @@
|
|||||||
|
name: Docs
|
||||||
|
|
||||||
|
on:
|
||||||
|
release:
|
||||||
|
types: [released]
|
||||||
|
workflow_dispatch:
|
||||||
|
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
|
pages: write
|
||||||
|
id-token: write
|
||||||
|
|
||||||
|
concurrency:
|
||||||
|
group: pages
|
||||||
|
cancel-in-progress: false
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
build:
|
||||||
|
name: Build Dokka HTML
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: Check out code
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
- name: Set up JDK 21
|
||||||
|
uses: actions/setup-java@v4
|
||||||
|
with:
|
||||||
|
distribution: temurin
|
||||||
|
java-version: '21'
|
||||||
|
- name: Generate API docs
|
||||||
|
run: ./gradlew :dokkaGeneratePublicationHtml --console=plain
|
||||||
|
- name: Upload Pages artifact
|
||||||
|
uses: actions/upload-pages-artifact@v3
|
||||||
|
with:
|
||||||
|
path: build/dokka/html
|
||||||
|
|
||||||
|
deploy:
|
||||||
|
name: Deploy to GitHub Pages
|
||||||
|
needs: build
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
environment:
|
||||||
|
name: github-pages
|
||||||
|
url: ${{ steps.deployment.outputs.page_url }}
|
||||||
|
steps:
|
||||||
|
- name: Deploy
|
||||||
|
id: deployment
|
||||||
|
uses: actions/deploy-pages@v4
|
||||||
36
.github/workflows/publishRelease.yml
vendored
Normal file
@@ -0,0 +1,36 @@
|
|||||||
|
name: Publish
|
||||||
|
|
||||||
|
on:
|
||||||
|
release:
|
||||||
|
# We'll run this workflow when a new GitHub release is created
|
||||||
|
types: [released]
|
||||||
|
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
test:
|
||||||
|
uses: ./.github/workflows/test.yml
|
||||||
|
secrets: inherit
|
||||||
|
|
||||||
|
publish:
|
||||||
|
needs: test
|
||||||
|
name: Publish Production
|
||||||
|
environment: production
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: Check out code
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
- name: Set up JDK 21
|
||||||
|
uses: actions/setup-java@v4
|
||||||
|
with:
|
||||||
|
distribution: temurin
|
||||||
|
java-version: '21'
|
||||||
|
|
||||||
|
# Runs upload, and then closes & releases the repository
|
||||||
|
- name: Publish to MavenCentral
|
||||||
|
run: ./gradlew publishToMavenCentral
|
||||||
|
env:
|
||||||
|
ORG_GRADLE_PROJECT_mavenCentralUsername: ${{ secrets.MAVEN_CENTRAL_USERNAME }}
|
||||||
|
ORG_GRADLE_PROJECT_mavenCentralPassword: ${{ secrets.MAVEN_CENTRAL_PASSWORD }}
|
||||||
|
ORG_GRADLE_PROJECT_signingInMemoryKey: ${{ secrets.SIGNING_KEY }}
|
||||||
|
ORG_GRADLE_PROJECT_signingInMemoryKeyPassword: ${{ secrets.SIGNING_PASSWORD }}
|
||||||
|
SNAPSHOT: false
|
||||||
31
.github/workflows/test.yml
vendored
Normal file
@@ -0,0 +1,31 @@
|
|||||||
|
name: Test
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches-ignore: [master]
|
||||||
|
workflow_call:
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
test:
|
||||||
|
name: ${{ matrix.name }}
|
||||||
|
runs-on: ${{ matrix.os }}
|
||||||
|
strategy:
|
||||||
|
fail-fast: false
|
||||||
|
matrix:
|
||||||
|
include:
|
||||||
|
- name: JVM / JS / Wasm / Native + API check
|
||||||
|
os: ubuntu-latest
|
||||||
|
tasks: jvmTest jsNodeTest wasmJsNodeTest nativeTest apiCheck
|
||||||
|
- name: iOS
|
||||||
|
os: macos-latest
|
||||||
|
tasks: iosSimulatorArm64Test
|
||||||
|
steps:
|
||||||
|
- name: Check out code
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
- name: Set up JDK 21
|
||||||
|
uses: actions/setup-java@v4
|
||||||
|
with:
|
||||||
|
distribution: temurin
|
||||||
|
java-version: '21'
|
||||||
|
- name: Test
|
||||||
|
run: ./gradlew ${{ matrix.tasks }} --console=plain
|
||||||
7
.gitignore
vendored
@@ -1,5 +1,6 @@
|
|||||||
*.iml
|
*.iml
|
||||||
.gradle
|
.gradle
|
||||||
|
/.kotlin/
|
||||||
/local.properties
|
/local.properties
|
||||||
/.idea/caches
|
/.idea/caches
|
||||||
/.idea/libraries
|
/.idea/libraries
|
||||||
@@ -9,6 +10,12 @@
|
|||||||
/.idea/assetWizardSettings.xml
|
/.idea/assetWizardSettings.xml
|
||||||
.DS_Store
|
.DS_Store
|
||||||
/build
|
/build
|
||||||
|
build/
|
||||||
/captures
|
/captures
|
||||||
.externalNativeBuild
|
.externalNativeBuild
|
||||||
.cxx
|
.cxx
|
||||||
|
/.idea/.name
|
||||||
|
/.idea/compiler.xml
|
||||||
|
/.idea/jarRepositories.xml
|
||||||
|
/.idea/deploymentTargetDropDown.xml
|
||||||
|
/.idea/
|
||||||
|
|||||||
125
.idea/codeStyles/Project.xml
generated
@@ -1,125 +0,0 @@
|
|||||||
<component name="ProjectCodeStyleConfiguration">
|
|
||||||
<code_scheme name="Project" version="173">
|
|
||||||
<JetCodeStyleSettings>
|
|
||||||
<option name="CODE_STYLE_DEFAULTS" value="KOTLIN_OFFICIAL" />
|
|
||||||
</JetCodeStyleSettings>
|
|
||||||
<MarkdownNavigatorCodeStyleSettings>
|
|
||||||
<option name="RIGHT_MARGIN" value="72" />
|
|
||||||
</MarkdownNavigatorCodeStyleSettings>
|
|
||||||
<codeStyleSettings language="XML">
|
|
||||||
<indentOptions>
|
|
||||||
<option name="CONTINUATION_INDENT_SIZE" value="4" />
|
|
||||||
</indentOptions>
|
|
||||||
<arrangement>
|
|
||||||
<rules>
|
|
||||||
<section>
|
|
||||||
<rule>
|
|
||||||
<match>
|
|
||||||
<AND>
|
|
||||||
<NAME>xmlns:android</NAME>
|
|
||||||
<XML_ATTRIBUTE />
|
|
||||||
<XML_NAMESPACE>^$</XML_NAMESPACE>
|
|
||||||
</AND>
|
|
||||||
</match>
|
|
||||||
</rule>
|
|
||||||
</section>
|
|
||||||
<section>
|
|
||||||
<rule>
|
|
||||||
<match>
|
|
||||||
<AND>
|
|
||||||
<NAME>xmlns:.*</NAME>
|
|
||||||
<XML_ATTRIBUTE />
|
|
||||||
<XML_NAMESPACE>^$</XML_NAMESPACE>
|
|
||||||
</AND>
|
|
||||||
</match>
|
|
||||||
<order>BY_NAME</order>
|
|
||||||
</rule>
|
|
||||||
</section>
|
|
||||||
<section>
|
|
||||||
<rule>
|
|
||||||
<match>
|
|
||||||
<AND>
|
|
||||||
<NAME>.*:id</NAME>
|
|
||||||
<XML_ATTRIBUTE />
|
|
||||||
<XML_NAMESPACE>http://schemas.android.com/apk/res/android</XML_NAMESPACE>
|
|
||||||
</AND>
|
|
||||||
</match>
|
|
||||||
</rule>
|
|
||||||
</section>
|
|
||||||
<section>
|
|
||||||
<rule>
|
|
||||||
<match>
|
|
||||||
<AND>
|
|
||||||
<NAME>.*:name</NAME>
|
|
||||||
<XML_ATTRIBUTE />
|
|
||||||
<XML_NAMESPACE>http://schemas.android.com/apk/res/android</XML_NAMESPACE>
|
|
||||||
</AND>
|
|
||||||
</match>
|
|
||||||
</rule>
|
|
||||||
</section>
|
|
||||||
<section>
|
|
||||||
<rule>
|
|
||||||
<match>
|
|
||||||
<AND>
|
|
||||||
<NAME>name</NAME>
|
|
||||||
<XML_ATTRIBUTE />
|
|
||||||
<XML_NAMESPACE>^$</XML_NAMESPACE>
|
|
||||||
</AND>
|
|
||||||
</match>
|
|
||||||
</rule>
|
|
||||||
</section>
|
|
||||||
<section>
|
|
||||||
<rule>
|
|
||||||
<match>
|
|
||||||
<AND>
|
|
||||||
<NAME>style</NAME>
|
|
||||||
<XML_ATTRIBUTE />
|
|
||||||
<XML_NAMESPACE>^$</XML_NAMESPACE>
|
|
||||||
</AND>
|
|
||||||
</match>
|
|
||||||
</rule>
|
|
||||||
</section>
|
|
||||||
<section>
|
|
||||||
<rule>
|
|
||||||
<match>
|
|
||||||
<AND>
|
|
||||||
<NAME>.*</NAME>
|
|
||||||
<XML_ATTRIBUTE />
|
|
||||||
<XML_NAMESPACE>^$</XML_NAMESPACE>
|
|
||||||
</AND>
|
|
||||||
</match>
|
|
||||||
<order>BY_NAME</order>
|
|
||||||
</rule>
|
|
||||||
</section>
|
|
||||||
<section>
|
|
||||||
<rule>
|
|
||||||
<match>
|
|
||||||
<AND>
|
|
||||||
<NAME>.*</NAME>
|
|
||||||
<XML_ATTRIBUTE />
|
|
||||||
<XML_NAMESPACE>http://schemas.android.com/apk/res/android</XML_NAMESPACE>
|
|
||||||
</AND>
|
|
||||||
</match>
|
|
||||||
<order>ANDROID_ATTRIBUTE_ORDER</order>
|
|
||||||
</rule>
|
|
||||||
</section>
|
|
||||||
<section>
|
|
||||||
<rule>
|
|
||||||
<match>
|
|
||||||
<AND>
|
|
||||||
<NAME>.*</NAME>
|
|
||||||
<XML_ATTRIBUTE />
|
|
||||||
<XML_NAMESPACE>.*</XML_NAMESPACE>
|
|
||||||
</AND>
|
|
||||||
</match>
|
|
||||||
<order>BY_NAME</order>
|
|
||||||
</rule>
|
|
||||||
</section>
|
|
||||||
</rules>
|
|
||||||
</arrangement>
|
|
||||||
</codeStyleSettings>
|
|
||||||
<codeStyleSettings language="kotlin">
|
|
||||||
<option name="CODE_STYLE_DEFAULTS" value="KOTLIN_OFFICIAL" />
|
|
||||||
</codeStyleSettings>
|
|
||||||
</code_scheme>
|
|
||||||
</component>
|
|
||||||
5
.idea/codeStyles/codeStyleConfig.xml
generated
@@ -1,5 +0,0 @@
|
|||||||
<component name="ProjectCodeStyleConfiguration">
|
|
||||||
<state>
|
|
||||||
<option name="USE_PER_PROJECT_SETTINGS" value="true" />
|
|
||||||
</state>
|
|
||||||
</component>
|
|
||||||
20
.idea/gradle.xml
generated
@@ -1,20 +0,0 @@
|
|||||||
<?xml version="1.0" encoding="UTF-8"?>
|
|
||||||
<project version="4">
|
|
||||||
<component name="GradleSettings">
|
|
||||||
<option name="linkedExternalProjectsSettings">
|
|
||||||
<GradleProjectSettings>
|
|
||||||
<option name="distributionType" value="DEFAULT_WRAPPED" />
|
|
||||||
<option name="externalProjectPath" value="$PROJECT_DIR$" />
|
|
||||||
<option name="modules">
|
|
||||||
<set>
|
|
||||||
<option value="$PROJECT_DIR$" />
|
|
||||||
<option value="$PROJECT_DIR$/app" />
|
|
||||||
<option value="$PROJECT_DIR$/treedatastructure" />
|
|
||||||
</set>
|
|
||||||
</option>
|
|
||||||
<option name="resolveModulePerSourceSet" value="false" />
|
|
||||||
<option name="testRunner" value="PLATFORM" />
|
|
||||||
</GradleProjectSettings>
|
|
||||||
</option>
|
|
||||||
</component>
|
|
||||||
</project>
|
|
||||||
9
.idea/misc.xml
generated
@@ -1,9 +0,0 @@
|
|||||||
<?xml version="1.0" encoding="UTF-8"?>
|
|
||||||
<project version="4">
|
|
||||||
<component name="ProjectRootManager" version="2" languageLevel="JDK_1_7" project-jdk-name="1.8" project-jdk-type="JavaSDK">
|
|
||||||
<output url="file://$PROJECT_DIR$/build/classes" />
|
|
||||||
</component>
|
|
||||||
<component name="ProjectType">
|
|
||||||
<option name="id" value="Android" />
|
|
||||||
</component>
|
|
||||||
</project>
|
|
||||||
12
.idea/runConfigurations.xml
generated
@@ -1,12 +0,0 @@
|
|||||||
<?xml version="1.0" encoding="UTF-8"?>
|
|
||||||
<project version="4">
|
|
||||||
<component name="RunConfigurationProducerService">
|
|
||||||
<option name="ignoredProducers">
|
|
||||||
<set>
|
|
||||||
<option value="org.jetbrains.plugins.gradle.execution.test.runner.AllInPackageGradleConfigurationProducer" />
|
|
||||||
<option value="org.jetbrains.plugins.gradle.execution.test.runner.TestClassGradleConfigurationProducer" />
|
|
||||||
<option value="org.jetbrains.plugins.gradle.execution.test.runner.TestMethodGradleConfigurationProducer" />
|
|
||||||
</set>
|
|
||||||
</option>
|
|
||||||
</component>
|
|
||||||
</project>
|
|
||||||
6
.idea/vcs.xml
generated
@@ -1,6 +0,0 @@
|
|||||||
<?xml version="1.0" encoding="UTF-8"?>
|
|
||||||
<project version="4">
|
|
||||||
<component name="VcsDirectoryMappings">
|
|
||||||
<mapping directory="" vcs="Git" />
|
|
||||||
</component>
|
|
||||||
</project>
|
|
||||||
84
CHANGELOG.md
Normal file
@@ -0,0 +1,84 @@
|
|||||||
|
# Changelog
|
||||||
|
|
||||||
|
All notable changes to this project are documented here. The format is based on
|
||||||
|
[Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to
|
||||||
|
[Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
||||||
|
|
||||||
|
## [Unreleased]
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
- Rewrote the README for clarity: one consistent example tree, task-oriented sections
|
||||||
|
(building, traversal, navigation, functional, utilities, mutating), per-module usage, and a
|
||||||
|
condensed maintainer "Releasing" section.
|
||||||
|
|
||||||
|
## [4.0.0]
|
||||||
|
|
||||||
|
A breaking release that cleans up the core API and enforces an explicit public surface.
|
||||||
|
|
||||||
|
### Changed (breaking)
|
||||||
|
- `TreeNode.treeIterator` is now a read-only `val` (set it via the constructor). Use
|
||||||
|
`iterator(order)` or `asSequence(order)` to traverse in a different order per call.
|
||||||
|
- `removeChild(child)` now only removes a **direct** child of the receiver (previously it removed
|
||||||
|
the node from its actual parent regardless). Use `child.detach()` to unhook a node from wherever
|
||||||
|
it lives.
|
||||||
|
- `addChild(child)` now throws `TreeNodeException` if `child` already has a parent or if the
|
||||||
|
attachment would create a cycle. Call `detach()` first to move a node.
|
||||||
|
- `clear()` no longer detaches the receiver from its own parent; it only removes its descendants.
|
||||||
|
- `path(descendant)` now returns `List<TreeNode<T>>?` (`null` when `descendant` is the root or not a
|
||||||
|
descendant) instead of throwing `TreeNodeException`.
|
||||||
|
|
||||||
|
### Added
|
||||||
|
- `TreeNode.detach()` — removes a node from its parent.
|
||||||
|
- `TreeNode.iterator(order)` — a one-shot iterator in a specific order.
|
||||||
|
- Strict `explicitApi()` mode across all modules.
|
||||||
|
- New `tree-structure-compose` module: a `LazyTree` composable for Compose Multiplatform.
|
||||||
|
|
||||||
|
### Migration
|
||||||
|
- `node.treeIterator = PostOrder; for (n in node) { … }` → `for (n in node.asSequence(PostOrder)) { … }`
|
||||||
|
- `root.removeChild(deepNode)` → `deepNode.detach()`
|
||||||
|
- `try { node.path(x) } catch (e: TreeNodeException) { … }` → `node.path(x)?.let { … }`
|
||||||
|
|
||||||
|
## [3.4.0]
|
||||||
|
|
||||||
|
### Added
|
||||||
|
- Lazy `Sequence` traversal: `asSequence(order)`, `preOrderSequence()`, `postOrderSequence()`,
|
||||||
|
`levelOrderSequence()` — composes with the Kotlin stdlib and short-circuits.
|
||||||
|
- Navigation extensions: `isLeaf`, `degree`, `root()`, `ancestors()`, `siblings()`, `leaves()`,
|
||||||
|
`descendants()`.
|
||||||
|
- Functional extensions: `findNode`, `filterNodes`, `anyNode`, `allNodes`, `countNodes`,
|
||||||
|
`foldNodes`, `mapValues`, `deepCopy`, `structurallyEquals` (all stack-safe).
|
||||||
|
- New optional modules published as separate artifacts:
|
||||||
|
- `tree-structure-serialization` — `kotlinx.serialization` support via a `TreeNodeDto`.
|
||||||
|
- `tree-structure-coroutines` — `Flow` traversal (`asFlow`, `preOrderFlow`, …).
|
||||||
|
- `CHANGELOG.md`, expanded README examples, and class-level KDoc (thread-safety / complexity).
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
- `nodeCount()`, `height()`, `clear()` and the post-order iterator are now iterative — deep or
|
||||||
|
degenerate (linear) trees no longer throw `StackOverflowError`.
|
||||||
|
- Migrated to Kotlin 2.x (K2 compiler) and introduced a Gradle version catalog.
|
||||||
|
- Build now uses `binary-compatibility-validator` (committed `.api` baselines) and Kover.
|
||||||
|
|
||||||
|
## [3.1.5]
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
- Removed a stray `println` in `TreeNode.removeChild()` that printed to stdout on every removal.
|
||||||
|
|
||||||
|
### Removed
|
||||||
|
- Deleted the `Example.ws.kts` worksheet and the `kotlin("script-runtime")` dependency from the
|
||||||
|
published JVM artifact, plus the leftover `ExampleUnitTest` template test.
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
- Bumped `actions/checkout` v2 → v4 in CI workflows.
|
||||||
|
|
||||||
|
## [3.1.4]
|
||||||
|
- Updated Kotlin and JS dependencies; added the `wasmJs` target.
|
||||||
|
|
||||||
|
## [3.1.3]
|
||||||
|
- iOS targets and Maven Central (Sonatype Central Portal) publishing.
|
||||||
|
|
||||||
|
[Unreleased]: https://github.com/AdrianKuta/Tree-Data-Structure/compare/v4.0.0...HEAD
|
||||||
|
[4.0.0]: https://github.com/AdrianKuta/Tree-Data-Structure/compare/v3.4.0...v4.0.0
|
||||||
|
[3.4.0]: https://github.com/AdrianKuta/Tree-Data-Structure/compare/v3.1.5...v3.4.0
|
||||||
|
[3.1.5]: https://github.com/AdrianKuta/Tree-Data-Structure/compare/v3.1.3...v3.1.5
|
||||||
|
[3.1.4]: https://github.com/AdrianKuta/Tree-Data-Structure/releases/tag/v3.1.4
|
||||||
|
[3.1.3]: https://github.com/AdrianKuta/Tree-Data-Structure/releases/tag/v3.1.3
|
||||||
243
README.md
@@ -1,52 +1,219 @@
|
|||||||
# Tree (Data Structure)
|
# Tree (Data Structure)
|
||||||
[](https://search.maven.org/artifact/com.github.adriankuta/tree-structure)
|
[](https://mvnrepository.com/artifact/com.github.adriankuta/tree-structure)
|
||||||
[](https://github.com/AdrianKuta/Design-Patterns-Kotlin/blob/master/LICENSE)
|
[](https://github.com/AdrianKuta/Tree-Data-Structure/blob/master/LICENSE)
|
||||||
[](https://circleci.com/gh/AdrianKuta/Tree-Data-Structure)
|
[](https://github.com/AdrianKuta/Tree-Data-Structure/actions/workflows/publishRelease.yml)
|
||||||
|
[](https://adriankuta.github.io/Tree-Data-Structure/)
|
||||||
|
|
||||||
Simple implementation to store object in tree structure. Method `toString()` is overrided to provide nice tree view in logs.
|
📖 **[API reference](https://adriankuta.github.io/Tree-Data-Structure/)** — full KDoc for the core and all modules.
|
||||||
|
|
||||||
## Usage
|
A lightweight n-ary tree for Kotlin Multiplatform. You get a generic `TreeNode<T>`, a small DSL for
|
||||||
|
building trees, three traversal orders, lazy `Sequence` traversal, and a set of navigation and
|
||||||
|
functional helpers. The core artifact has no third-party dependencies.
|
||||||
|
|
||||||
|
It fits homogeneous trees of arbitrary depth: UI component hierarchies, file-system views, org
|
||||||
|
charts, and category menus. For fixed, typed hierarchies (like a compiler AST) a sealed class is
|
||||||
|
usually a better fit.
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
- Kotlin Multiplatform: JVM, JS, Wasm, iOS, and a native host target.
|
||||||
|
- Build trees with a `tree { child(...) }` DSL or node by node with `addChild`.
|
||||||
|
- Pre-order, post-order, and level-order traversal, as iterators or lazy `Sequence`s.
|
||||||
|
- Navigation: `root()`, `ancestors()`, `siblings()`, `leaves()`, `descendants()`, `isLeaf`, `degree`.
|
||||||
|
- Functional helpers: `findNode`, `filterNodes`, `anyNode`, `allNodes`, `foldNodes`, `mapValues`, `deepCopy`, `structurallyEquals`.
|
||||||
|
- Utilities: `nodeCount()`, `height()`, `depth()`, `path()`, `prettyString()`.
|
||||||
|
- Stack-safe: traversal and `height()`/`nodeCount()`/`clear()` handle very deep trees without `StackOverflowError`.
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
|
Gradle (Kotlin DSL):
|
||||||
```kotlin
|
```kotlin
|
||||||
val root = TreeNode<String>("Root")
|
// commonMain for KMP projects, or any sourceSet/module where you need it
|
||||||
val beveragesNode = TreeNode<String>("Beverages")
|
dependencies {
|
||||||
val curdNode = TreeNode<String>("Curd")
|
implementation("com.github.adriankuta:tree-structure:4.0.0") // latest version is on the badge above
|
||||||
root.addChild(beveragesNode)
|
}
|
||||||
root.addChild(curdNode)
|
|
||||||
|
|
||||||
val teaNode = TreeNode<String>("tea")
|
|
||||||
val coffeeNode = TreeNode<String>("coffee")
|
|
||||||
val milkShakeNode = TreeNode<String>("Milk Shake")
|
|
||||||
beveragesNode.addChild(teaNode)
|
|
||||||
beveragesNode.addChild(coffeeNode)
|
|
||||||
beveragesNode.addChild(milkShakeNode)
|
|
||||||
|
|
||||||
val gingerTeaNode = TreeNode<String>("ginger tea")
|
|
||||||
val normalTeaNode = TreeNode<String>("normal tea")
|
|
||||||
teaNode.addChild(gingerTeaNode)
|
|
||||||
teaNode.addChild(normalTeaNode)
|
|
||||||
|
|
||||||
val yogurtNode = TreeNode<String>("yogurt")
|
|
||||||
val lassiNode = TreeNode<String>("lassi")
|
|
||||||
curdNode.addChild(yogurtNode)
|
|
||||||
curdNode.addChild(lassiNode)
|
|
||||||
|
|
||||||
println(root)
|
|
||||||
System.out.println("Remove: ${curdNode.value}")
|
|
||||||
root.removeChild(curdNode)
|
|
||||||
System.out.println("Remove: ${gingerTeaNode.value}")
|
|
||||||
root.removeChild(gingerTeaNode)
|
|
||||||
println(root)
|
|
||||||
```
|
```
|
||||||
|
|
||||||
*Output:*
|
Gradle (Groovy):
|
||||||
|
```groovy
|
||||||
|
dependencies {
|
||||||
|
implementation "com.github.adriankuta:tree-structure:4.0.0"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
<img src="https://github.com/AdrianKuta/Tree-Collection/blob/master/images/console_output.png" width=400>
|
Maven:
|
||||||
|
```xml
|
||||||
|
<dependency>
|
||||||
|
<groupId>com.github.adriankuta</groupId>
|
||||||
|
<artifactId>tree-structure</artifactId>
|
||||||
|
<version>4.0.0</version>
|
||||||
|
</dependency>
|
||||||
|
```
|
||||||
|
|
||||||
|
## Building a tree
|
||||||
|
|
||||||
## Download
|
The DSL is the shortest way to build one:
|
||||||
|
```kotlin
|
||||||
|
val root = tree("World") {
|
||||||
|
child("North America") { child("USA") }
|
||||||
|
child("Europe") {
|
||||||
|
child("Poland")
|
||||||
|
child("Germany")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
implementation "com.github.adriankuta:tree-structure:$latest_versions"
|
The same node-by-node API works from Kotlin and Java:
|
||||||
|
```java
|
||||||
|
TreeNode<String> root = new TreeNode<>("World");
|
||||||
|
TreeNode<String> northAmerica = new TreeNode<>("North America");
|
||||||
|
root.addChild(northAmerica);
|
||||||
|
northAmerica.addChild(new TreeNode<>("USA"));
|
||||||
|
|
||||||
|
TreeNode<String> europe = new TreeNode<>("Europe");
|
||||||
|
root.addChild(europe);
|
||||||
|
europe.addChild(new TreeNode<>("Poland"));
|
||||||
|
europe.addChild(new TreeNode<>("Germany"));
|
||||||
|
```
|
||||||
|
|
||||||
|
`prettyString()` renders the tree for logs and debugging:
|
||||||
|
```
|
||||||
|
World
|
||||||
|
├── North America
|
||||||
|
│ └── USA
|
||||||
|
└── Europe
|
||||||
|
├── Poland
|
||||||
|
└── Germany
|
||||||
|
```
|
||||||
|
|
||||||
|
## Traversal
|
||||||
|
|
||||||
|
Iterating a node visits the node and all of its descendants. The default order is set in the
|
||||||
|
constructor (pre-order by default) and is read-only. Pass an order per call when you need a
|
||||||
|
different one:
|
||||||
|
```kotlin
|
||||||
|
for (node in root) println(node.value) // default pre-order
|
||||||
|
for (node in root.asSequence(TreeNodeIterators.PostOrder)) println(node.value)
|
||||||
|
```
|
||||||
|
|
||||||
|
Traversal is also exposed as a lazy `Sequence`, so it composes with the standard library and stops
|
||||||
|
early instead of materializing the whole tree:
|
||||||
|
```kotlin
|
||||||
|
root.preOrderSequence().map { it.value }.toList() // [World, North America, USA, Europe, Poland, Germany]
|
||||||
|
root.levelOrderSequence().first { it.value == "USA" } // stops as soon as it is found
|
||||||
|
root.asSequence(TreeNodeIterators.PostOrder).count() // 6
|
||||||
|
```
|
||||||
|
|
||||||
|
## Navigation
|
||||||
|
```kotlin
|
||||||
|
val usa = root.findNode { it == "USA" }!!
|
||||||
|
|
||||||
|
usa.isLeaf // true
|
||||||
|
usa.depth() // 2
|
||||||
|
usa.root().value // "World"
|
||||||
|
usa.ancestors().map { it.value } // [North America, World]
|
||||||
|
root.leaves().map { it.value } // [USA, Poland, Germany]
|
||||||
|
```
|
||||||
|
|
||||||
|
## Functional operations
|
||||||
|
```kotlin
|
||||||
|
root.anyNode { it == "Poland" } // true
|
||||||
|
root.filterNodes { it.length > 5 } // nodes whose value is longer than 5 characters
|
||||||
|
root.countNodes { it.startsWith("U") } // 1
|
||||||
|
|
||||||
|
val lengths: TreeNode<Int> = root.mapValues { it.length } // a new tree; the original is untouched
|
||||||
|
val copy = root.deepCopy()
|
||||||
|
root.structurallyEquals(copy) // true: same values and shape, different nodes
|
||||||
|
```
|
||||||
|
|
||||||
|
## Utilities
|
||||||
|
```kotlin
|
||||||
|
root.nodeCount() // number of descendants, excluding the root
|
||||||
|
root.height() // edges on the longest path down to a leaf
|
||||||
|
root.depth() // edges from this node up to the root
|
||||||
|
root.path(usa) // [USA, North America, World], or null if usa is not a descendant
|
||||||
|
```
|
||||||
|
|
||||||
|
## Mutating a tree
|
||||||
|
```kotlin
|
||||||
|
// addChild rejects a node that already has a parent or that would create a cycle.
|
||||||
|
root.addChild(TreeNode("Asia"))
|
||||||
|
|
||||||
|
// removeChild removes a direct child of the receiver and returns true if it was present.
|
||||||
|
root.removeChild(root.children.first())
|
||||||
|
|
||||||
|
// detach() unhooks a node from wherever it currently lives.
|
||||||
|
root.findNode { it == "Germany" }?.detach()
|
||||||
|
|
||||||
|
// clear() removes every descendant of the node.
|
||||||
|
root.clear()
|
||||||
|
```
|
||||||
|
|
||||||
|
## Optional modules
|
||||||
|
|
||||||
|
The core artifact has no third-party dependencies. Each integration is a separate, opt-in artifact
|
||||||
|
that depends on the core.
|
||||||
|
|
||||||
|
### Serialization (`tree-structure-serialization`)
|
||||||
|
|
||||||
|
`kotlinx.serialization` support. A `TreeNode` keeps a reference back to its parent, so it cannot be
|
||||||
|
`@Serializable` directly. Convert to and from the acyclic `TreeNodeDto` instead.
|
||||||
|
|
||||||
|
```kotlin
|
||||||
|
implementation("com.github.adriankuta:tree-structure-serialization:4.0.0")
|
||||||
|
```
|
||||||
|
```kotlin
|
||||||
|
val json = Json.encodeToString(root.toDto())
|
||||||
|
val restored = Json.decodeFromString<TreeNodeDto<String>>(json).toTreeNode()
|
||||||
|
```
|
||||||
|
|
||||||
|
### Coroutines (`tree-structure-coroutines`)
|
||||||
|
|
||||||
|
Traverse a tree as a cold `Flow`, which is handy inside coroutine and `ViewModel` pipelines.
|
||||||
|
|
||||||
|
```kotlin
|
||||||
|
implementation("com.github.adriankuta:tree-structure-coroutines:4.0.0")
|
||||||
|
```
|
||||||
|
```kotlin
|
||||||
|
root.preOrderFlow().collect { println(it.value) }
|
||||||
|
root.asFlow(TreeNodeIterators.LevelOrder).map { it.value }
|
||||||
|
```
|
||||||
|
|
||||||
|
### Compose UI (`tree-structure-compose`)
|
||||||
|
|
||||||
|
A `LazyTree` composable for Compose Multiplatform (JVM/desktop, iOS, Wasm). Only the visible nodes
|
||||||
|
are composed, and you decide how each node looks:
|
||||||
|
|
||||||
|
```kotlin
|
||||||
|
implementation("com.github.adriankuta:tree-structure-compose:4.0.0")
|
||||||
|
```
|
||||||
|
```kotlin
|
||||||
|
LazyTree(root) { node, depth, expanded, toggle ->
|
||||||
|
Row(Modifier.padding(start = (depth * 16).dp).clickable(onClick = toggle)) {
|
||||||
|
if (!node.isLeaf) Text(if (expanded) "▾ " else "▸ ")
|
||||||
|
Text(node.value.toString())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
## Notes
|
||||||
|
|
||||||
|
`TreeNode` is mutable and not thread-safe. Add your own synchronization if you share a tree across
|
||||||
|
threads, and do not modify a tree while you iterate it. Equality is by reference; use
|
||||||
|
`structurallyEquals` to compare two trees by value and shape.
|
||||||
|
|
||||||
|
Coming from 3.x? See [CHANGELOG.md](CHANGELOG.md) for the 4.0 migration notes.
|
||||||
|
|
||||||
|
## Releasing (maintainers)
|
||||||
|
|
||||||
|
Releases go to Maven Central through the Sonatype Central Portal using the
|
||||||
|
`com.vanniktech.maven.publish` plugin. Creating a GitHub release runs
|
||||||
|
`.github/workflows/publishRelease.yml`, which signs and uploads every module; the deployment is then
|
||||||
|
published from central.sonatype.com. The published version comes from `PUBLISH_VERSION` in
|
||||||
|
`build.gradle.kts`. CI needs the `MAVEN_CENTRAL_USERNAME`, `MAVEN_CENTRAL_PASSWORD`, `SIGNING_KEY`,
|
||||||
|
and `SIGNING_PASSWORD` repository secrets. To publish from a local machine, set the matching
|
||||||
|
`ORG_GRADLE_PROJECT_*` properties and run `./gradlew publishToMavenCentral` (add `-Psnapshot=true`
|
||||||
|
for a snapshot build).
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
|
|||||||
101
api/tree-structure.api
Normal file
@@ -0,0 +1,101 @@
|
|||||||
|
public abstract interface class com/github/adriankuta/datastructure/tree/ChildDeclarationInterface {
|
||||||
|
public abstract synthetic fun child (Ljava/lang/Object;Lkotlin/jvm/functions/Function1;)Lcom/github/adriankuta/datastructure/tree/TreeNode;
|
||||||
|
}
|
||||||
|
|
||||||
|
public final class com/github/adriankuta/datastructure/tree/ChildDeclarationInterface$DefaultImpls {
|
||||||
|
public static synthetic fun child$default (Lcom/github/adriankuta/datastructure/tree/ChildDeclarationInterface;Ljava/lang/Object;Lkotlin/jvm/functions/Function1;ILjava/lang/Object;)Lcom/github/adriankuta/datastructure/tree/TreeNode;
|
||||||
|
}
|
||||||
|
|
||||||
|
public class com/github/adriankuta/datastructure/tree/TreeNode : com/github/adriankuta/datastructure/tree/ChildDeclarationInterface, java/lang/Iterable, kotlin/jvm/internal/markers/KMappedMarker {
|
||||||
|
public fun <init> (Ljava/lang/Object;Lcom/github/adriankuta/datastructure/tree/iterators/TreeNodeIterators;)V
|
||||||
|
public synthetic fun <init> (Ljava/lang/Object;Lcom/github/adriankuta/datastructure/tree/iterators/TreeNodeIterators;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
|
||||||
|
public final fun addChild (Lcom/github/adriankuta/datastructure/tree/TreeNode;)V
|
||||||
|
public synthetic fun child (Ljava/lang/Object;Lkotlin/jvm/functions/Function1;)Lcom/github/adriankuta/datastructure/tree/TreeNode;
|
||||||
|
public final fun clear ()V
|
||||||
|
public final fun depth ()I
|
||||||
|
public final fun detach ()Z
|
||||||
|
public final fun getChildren ()Ljava/util/List;
|
||||||
|
public final fun getParent ()Lcom/github/adriankuta/datastructure/tree/TreeNode;
|
||||||
|
public final fun getTreeIterator ()Lcom/github/adriankuta/datastructure/tree/iterators/TreeNodeIterators;
|
||||||
|
public final fun getValue ()Ljava/lang/Object;
|
||||||
|
public final fun height ()I
|
||||||
|
public final fun isRoot ()Z
|
||||||
|
public fun iterator ()Ljava/util/Iterator;
|
||||||
|
public final fun iterator (Lcom/github/adriankuta/datastructure/tree/iterators/TreeNodeIterators;)Ljava/util/Iterator;
|
||||||
|
public final fun nodeCount ()I
|
||||||
|
public final fun path (Lcom/github/adriankuta/datastructure/tree/TreeNode;)Ljava/util/List;
|
||||||
|
public final fun prettyString ()Ljava/lang/String;
|
||||||
|
public final fun removeChild (Lcom/github/adriankuta/datastructure/tree/TreeNode;)Z
|
||||||
|
public fun toString ()Ljava/lang/String;
|
||||||
|
}
|
||||||
|
|
||||||
|
public final class com/github/adriankuta/datastructure/tree/TreeNodeFunctionalExtKt {
|
||||||
|
public static final fun allNodes (Lcom/github/adriankuta/datastructure/tree/TreeNode;Lkotlin/jvm/functions/Function1;)Z
|
||||||
|
public static final fun anyNode (Lcom/github/adriankuta/datastructure/tree/TreeNode;Lkotlin/jvm/functions/Function1;)Z
|
||||||
|
public static final fun countNodes (Lcom/github/adriankuta/datastructure/tree/TreeNode;Lkotlin/jvm/functions/Function1;)I
|
||||||
|
public static final fun deepCopy (Lcom/github/adriankuta/datastructure/tree/TreeNode;)Lcom/github/adriankuta/datastructure/tree/TreeNode;
|
||||||
|
public static final fun filterNodes (Lcom/github/adriankuta/datastructure/tree/TreeNode;Lkotlin/jvm/functions/Function1;)Ljava/util/List;
|
||||||
|
public static final fun findNode (Lcom/github/adriankuta/datastructure/tree/TreeNode;Lkotlin/jvm/functions/Function1;)Lcom/github/adriankuta/datastructure/tree/TreeNode;
|
||||||
|
public static final fun foldNodes (Lcom/github/adriankuta/datastructure/tree/TreeNode;Ljava/lang/Object;Lkotlin/jvm/functions/Function2;)Ljava/lang/Object;
|
||||||
|
public static final fun mapValues (Lcom/github/adriankuta/datastructure/tree/TreeNode;Lkotlin/jvm/functions/Function1;)Lcom/github/adriankuta/datastructure/tree/TreeNode;
|
||||||
|
public static final fun structurallyEquals (Lcom/github/adriankuta/datastructure/tree/TreeNode;Lcom/github/adriankuta/datastructure/tree/TreeNode;)Z
|
||||||
|
}
|
||||||
|
|
||||||
|
public final class com/github/adriankuta/datastructure/tree/TreeNodeNavigationExtKt {
|
||||||
|
public static final fun ancestors (Lcom/github/adriankuta/datastructure/tree/TreeNode;)Ljava/util/List;
|
||||||
|
public static final fun descendants (Lcom/github/adriankuta/datastructure/tree/TreeNode;)Ljava/util/List;
|
||||||
|
public static final fun getDegree (Lcom/github/adriankuta/datastructure/tree/TreeNode;)I
|
||||||
|
public static final fun isLeaf (Lcom/github/adriankuta/datastructure/tree/TreeNode;)Z
|
||||||
|
public static final fun leaves (Lcom/github/adriankuta/datastructure/tree/TreeNode;)Ljava/util/List;
|
||||||
|
public static final fun root (Lcom/github/adriankuta/datastructure/tree/TreeNode;)Lcom/github/adriankuta/datastructure/tree/TreeNode;
|
||||||
|
public static final fun siblings (Lcom/github/adriankuta/datastructure/tree/TreeNode;)Ljava/util/List;
|
||||||
|
}
|
||||||
|
|
||||||
|
public final class com/github/adriankuta/datastructure/tree/TreeNodeSequenceExtKt {
|
||||||
|
public static final fun asSequence (Lcom/github/adriankuta/datastructure/tree/TreeNode;Lcom/github/adriankuta/datastructure/tree/iterators/TreeNodeIterators;)Lkotlin/sequences/Sequence;
|
||||||
|
public static synthetic fun asSequence$default (Lcom/github/adriankuta/datastructure/tree/TreeNode;Lcom/github/adriankuta/datastructure/tree/iterators/TreeNodeIterators;ILjava/lang/Object;)Lkotlin/sequences/Sequence;
|
||||||
|
public static final fun levelOrderSequence (Lcom/github/adriankuta/datastructure/tree/TreeNode;)Lkotlin/sequences/Sequence;
|
||||||
|
public static final fun postOrderSequence (Lcom/github/adriankuta/datastructure/tree/TreeNode;)Lkotlin/sequences/Sequence;
|
||||||
|
public static final fun preOrderSequence (Lcom/github/adriankuta/datastructure/tree/TreeNode;)Lkotlin/sequences/Sequence;
|
||||||
|
}
|
||||||
|
|
||||||
|
public final class com/github/adriankuta/datastructure/tree/exceptions/TreeNodeException : java/lang/RuntimeException {
|
||||||
|
public fun <init> ()V
|
||||||
|
public fun <init> (Ljava/lang/String;)V
|
||||||
|
public fun <init> (Ljava/lang/String;Ljava/lang/Throwable;)V
|
||||||
|
public synthetic fun <init> (Ljava/lang/String;Ljava/lang/Throwable;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
|
||||||
|
}
|
||||||
|
|
||||||
|
public final class com/github/adriankuta/datastructure/tree/iterators/LevelOrderTreeIterator : java/util/Iterator, kotlin/jvm/internal/markers/KMappedMarker {
|
||||||
|
public fun <init> (Lcom/github/adriankuta/datastructure/tree/TreeNode;)V
|
||||||
|
public fun hasNext ()Z
|
||||||
|
public fun next ()Lcom/github/adriankuta/datastructure/tree/TreeNode;
|
||||||
|
public synthetic fun next ()Ljava/lang/Object;
|
||||||
|
public fun remove ()V
|
||||||
|
}
|
||||||
|
|
||||||
|
public final class com/github/adriankuta/datastructure/tree/iterators/PostOrderTreeIterator : java/util/Iterator, kotlin/jvm/internal/markers/KMappedMarker {
|
||||||
|
public fun <init> (Lcom/github/adriankuta/datastructure/tree/TreeNode;)V
|
||||||
|
public fun hasNext ()Z
|
||||||
|
public fun next ()Lcom/github/adriankuta/datastructure/tree/TreeNode;
|
||||||
|
public synthetic fun next ()Ljava/lang/Object;
|
||||||
|
public fun remove ()V
|
||||||
|
}
|
||||||
|
|
||||||
|
public final class com/github/adriankuta/datastructure/tree/iterators/PreOrderTreeIterator : java/util/Iterator, kotlin/jvm/internal/markers/KMappedMarker {
|
||||||
|
public fun <init> (Lcom/github/adriankuta/datastructure/tree/TreeNode;)V
|
||||||
|
public fun hasNext ()Z
|
||||||
|
public fun next ()Lcom/github/adriankuta/datastructure/tree/TreeNode;
|
||||||
|
public synthetic fun next ()Ljava/lang/Object;
|
||||||
|
public fun remove ()V
|
||||||
|
}
|
||||||
|
|
||||||
|
public final class com/github/adriankuta/datastructure/tree/iterators/TreeNodeIterators : java/lang/Enum {
|
||||||
|
public static final field LevelOrder Lcom/github/adriankuta/datastructure/tree/iterators/TreeNodeIterators;
|
||||||
|
public static final field PostOrder Lcom/github/adriankuta/datastructure/tree/iterators/TreeNodeIterators;
|
||||||
|
public static final field PreOrder Lcom/github/adriankuta/datastructure/tree/iterators/TreeNodeIterators;
|
||||||
|
public static fun getEntries ()Lkotlin/enums/EnumEntries;
|
||||||
|
public static fun valueOf (Ljava/lang/String;)Lcom/github/adriankuta/datastructure/tree/iterators/TreeNodeIterators;
|
||||||
|
public static fun values ()[Lcom/github/adriankuta/datastructure/tree/iterators/TreeNodeIterators;
|
||||||
|
}
|
||||||
|
|
||||||
1
app/.gitignore
vendored
@@ -1 +0,0 @@
|
|||||||
/build
|
|
||||||
@@ -1,35 +0,0 @@
|
|||||||
apply plugin: 'com.android.application'
|
|
||||||
|
|
||||||
apply plugin: 'kotlin-android'
|
|
||||||
|
|
||||||
apply plugin: 'kotlin-android-extensions'
|
|
||||||
|
|
||||||
android {
|
|
||||||
compileSdkVersion 29
|
|
||||||
buildToolsVersion "29.0.2"
|
|
||||||
defaultConfig {
|
|
||||||
applicationId "com.github.adriankuta.treedatastructure"
|
|
||||||
minSdkVersion 15
|
|
||||||
targetSdkVersion 29
|
|
||||||
versionCode 1
|
|
||||||
versionName "1.0"
|
|
||||||
testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
|
|
||||||
}
|
|
||||||
buildTypes {
|
|
||||||
release {
|
|
||||||
minifyEnabled false
|
|
||||||
proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
dependencies {
|
|
||||||
implementation fileTree(dir: 'libs', include: ['*.jar'])
|
|
||||||
implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version"
|
|
||||||
implementation 'androidx.appcompat:appcompat:1.0.2'
|
|
||||||
implementation 'androidx.core:core-ktx:1.0.2'
|
|
||||||
implementation 'androidx.constraintlayout:constraintlayout:1.1.3'
|
|
||||||
testImplementation 'junit:junit:4.12'
|
|
||||||
androidTestImplementation 'androidx.test.ext:junit:1.1.0'
|
|
||||||
androidTestImplementation 'androidx.test.espresso:espresso-core:3.1.1'
|
|
||||||
}
|
|
||||||
21
app/proguard-rules.pro
vendored
@@ -1,21 +0,0 @@
|
|||||||
# Add project specific ProGuard rules here.
|
|
||||||
# You can control the set of applied configuration files using the
|
|
||||||
# proguardFiles setting in build.gradle.
|
|
||||||
#
|
|
||||||
# For more details, see
|
|
||||||
# http://developer.android.com/guide/developing/tools/proguard.html
|
|
||||||
|
|
||||||
# If your project uses WebView with JS, uncomment the following
|
|
||||||
# and specify the fully qualified class name to the JavaScript interface
|
|
||||||
# class:
|
|
||||||
#-keepclassmembers class fqcn.of.javascript.interface.for.webview {
|
|
||||||
# public *;
|
|
||||||
#}
|
|
||||||
|
|
||||||
# Uncomment this to preserve the line number information for
|
|
||||||
# debugging stack traces.
|
|
||||||
#-keepattributes SourceFile,LineNumberTable
|
|
||||||
|
|
||||||
# If you keep the line number information, uncomment this to
|
|
||||||
# hide the original source file name.
|
|
||||||
#-renamesourcefileattribute SourceFile
|
|
||||||
@@ -1,24 +0,0 @@
|
|||||||
package com.github.adriankuta.treedatastructure
|
|
||||||
|
|
||||||
import androidx.test.platform.app.InstrumentationRegistry
|
|
||||||
import androidx.test.ext.junit.runners.AndroidJUnit4
|
|
||||||
|
|
||||||
import org.junit.Test
|
|
||||||
import org.junit.runner.RunWith
|
|
||||||
|
|
||||||
import org.junit.Assert.*
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Instrumented test, which will execute on an Android device.
|
|
||||||
*
|
|
||||||
* See [testing documentation](http://d.android.com/tools/testing).
|
|
||||||
*/
|
|
||||||
@RunWith(AndroidJUnit4::class)
|
|
||||||
class ExampleInstrumentedTest {
|
|
||||||
@Test
|
|
||||||
fun useAppContext() {
|
|
||||||
// Context of the app under test.
|
|
||||||
val appContext = InstrumentationRegistry.getInstrumentation().targetContext
|
|
||||||
assertEquals("com.github.adriankuta.treedatastructure", appContext.packageName)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,21 +0,0 @@
|
|||||||
<?xml version="1.0" encoding="utf-8"?>
|
|
||||||
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
|
|
||||||
package="com.github.adriankuta.treedatastructure">
|
|
||||||
|
|
||||||
<application
|
|
||||||
android:allowBackup="true"
|
|
||||||
android:icon="@mipmap/ic_launcher"
|
|
||||||
android:label="@string/app_name"
|
|
||||||
android:roundIcon="@mipmap/ic_launcher_round"
|
|
||||||
android:supportsRtl="true"
|
|
||||||
android:theme="@style/AppTheme">
|
|
||||||
<activity android:name=".MainActivity">
|
|
||||||
<intent-filter>
|
|
||||||
<action android:name="android.intent.action.MAIN" />
|
|
||||||
|
|
||||||
<category android:name="android.intent.category.LAUNCHER" />
|
|
||||||
</intent-filter>
|
|
||||||
</activity>
|
|
||||||
</application>
|
|
||||||
|
|
||||||
</manifest>
|
|
||||||
@@ -1,12 +0,0 @@
|
|||||||
package com.github.adriankuta.treedatastructure
|
|
||||||
|
|
||||||
import androidx.appcompat.app.AppCompatActivity
|
|
||||||
import android.os.Bundle
|
|
||||||
|
|
||||||
class MainActivity : AppCompatActivity() {
|
|
||||||
|
|
||||||
override fun onCreate(savedInstanceState: Bundle?) {
|
|
||||||
super.onCreate(savedInstanceState)
|
|
||||||
setContentView(R.layout.activity_main)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,34 +0,0 @@
|
|||||||
<vector xmlns:android="http://schemas.android.com/apk/res/android"
|
|
||||||
xmlns:aapt="http://schemas.android.com/aapt"
|
|
||||||
android:width="108dp"
|
|
||||||
android:height="108dp"
|
|
||||||
android:viewportWidth="108"
|
|
||||||
android:viewportHeight="108">
|
|
||||||
<path
|
|
||||||
android:fillType="evenOdd"
|
|
||||||
android:pathData="M32,64C32,64 38.39,52.99 44.13,50.95C51.37,48.37 70.14,49.57 70.14,49.57L108.26,87.69L108,109.01L75.97,107.97L32,64Z"
|
|
||||||
android:strokeWidth="1"
|
|
||||||
android:strokeColor="#00000000">
|
|
||||||
<aapt:attr name="android:fillColor">
|
|
||||||
<gradient
|
|
||||||
android:endX="78.5885"
|
|
||||||
android:endY="90.9159"
|
|
||||||
android:startX="48.7653"
|
|
||||||
android:startY="61.0927"
|
|
||||||
android:type="linear">
|
|
||||||
<item
|
|
||||||
android:color="#44000000"
|
|
||||||
android:offset="0.0" />
|
|
||||||
<item
|
|
||||||
android:color="#00000000"
|
|
||||||
android:offset="1.0" />
|
|
||||||
</gradient>
|
|
||||||
</aapt:attr>
|
|
||||||
</path>
|
|
||||||
<path
|
|
||||||
android:fillColor="#FFFFFF"
|
|
||||||
android:fillType="nonZero"
|
|
||||||
android:pathData="M66.94,46.02L66.94,46.02C72.44,50.07 76,56.61 76,64L32,64C32,56.61 35.56,50.11 40.98,46.06L36.18,41.19C35.45,40.45 35.45,39.3 36.18,38.56C36.91,37.81 38.05,37.81 38.78,38.56L44.25,44.05C47.18,42.57 50.48,41.71 54,41.71C57.48,41.71 60.78,42.57 63.68,44.05L69.11,38.56C69.84,37.81 70.98,37.81 71.71,38.56C72.44,39.3 72.44,40.45 71.71,41.19L66.94,46.02ZM62.94,56.92C64.08,56.92 65,56.01 65,54.88C65,53.76 64.08,52.85 62.94,52.85C61.8,52.85 60.88,53.76 60.88,54.88C60.88,56.01 61.8,56.92 62.94,56.92ZM45.06,56.92C46.2,56.92 47.13,56.01 47.13,54.88C47.13,53.76 46.2,52.85 45.06,52.85C43.92,52.85 43,53.76 43,54.88C43,56.01 43.92,56.92 45.06,56.92Z"
|
|
||||||
android:strokeWidth="1"
|
|
||||||
android:strokeColor="#00000000" />
|
|
||||||
</vector>
|
|
||||||
@@ -1,170 +0,0 @@
|
|||||||
<?xml version="1.0" encoding="utf-8"?>
|
|
||||||
<vector xmlns:android="http://schemas.android.com/apk/res/android"
|
|
||||||
android:width="108dp"
|
|
||||||
android:height="108dp"
|
|
||||||
android:viewportWidth="108"
|
|
||||||
android:viewportHeight="108">
|
|
||||||
<path
|
|
||||||
android:fillColor="#008577"
|
|
||||||
android:pathData="M0,0h108v108h-108z" />
|
|
||||||
<path
|
|
||||||
android:fillColor="#00000000"
|
|
||||||
android:pathData="M9,0L9,108"
|
|
||||||
android:strokeWidth="0.8"
|
|
||||||
android:strokeColor="#33FFFFFF" />
|
|
||||||
<path
|
|
||||||
android:fillColor="#00000000"
|
|
||||||
android:pathData="M19,0L19,108"
|
|
||||||
android:strokeWidth="0.8"
|
|
||||||
android:strokeColor="#33FFFFFF" />
|
|
||||||
<path
|
|
||||||
android:fillColor="#00000000"
|
|
||||||
android:pathData="M29,0L29,108"
|
|
||||||
android:strokeWidth="0.8"
|
|
||||||
android:strokeColor="#33FFFFFF" />
|
|
||||||
<path
|
|
||||||
android:fillColor="#00000000"
|
|
||||||
android:pathData="M39,0L39,108"
|
|
||||||
android:strokeWidth="0.8"
|
|
||||||
android:strokeColor="#33FFFFFF" />
|
|
||||||
<path
|
|
||||||
android:fillColor="#00000000"
|
|
||||||
android:pathData="M49,0L49,108"
|
|
||||||
android:strokeWidth="0.8"
|
|
||||||
android:strokeColor="#33FFFFFF" />
|
|
||||||
<path
|
|
||||||
android:fillColor="#00000000"
|
|
||||||
android:pathData="M59,0L59,108"
|
|
||||||
android:strokeWidth="0.8"
|
|
||||||
android:strokeColor="#33FFFFFF" />
|
|
||||||
<path
|
|
||||||
android:fillColor="#00000000"
|
|
||||||
android:pathData="M69,0L69,108"
|
|
||||||
android:strokeWidth="0.8"
|
|
||||||
android:strokeColor="#33FFFFFF" />
|
|
||||||
<path
|
|
||||||
android:fillColor="#00000000"
|
|
||||||
android:pathData="M79,0L79,108"
|
|
||||||
android:strokeWidth="0.8"
|
|
||||||
android:strokeColor="#33FFFFFF" />
|
|
||||||
<path
|
|
||||||
android:fillColor="#00000000"
|
|
||||||
android:pathData="M89,0L89,108"
|
|
||||||
android:strokeWidth="0.8"
|
|
||||||
android:strokeColor="#33FFFFFF" />
|
|
||||||
<path
|
|
||||||
android:fillColor="#00000000"
|
|
||||||
android:pathData="M99,0L99,108"
|
|
||||||
android:strokeWidth="0.8"
|
|
||||||
android:strokeColor="#33FFFFFF" />
|
|
||||||
<path
|
|
||||||
android:fillColor="#00000000"
|
|
||||||
android:pathData="M0,9L108,9"
|
|
||||||
android:strokeWidth="0.8"
|
|
||||||
android:strokeColor="#33FFFFFF" />
|
|
||||||
<path
|
|
||||||
android:fillColor="#00000000"
|
|
||||||
android:pathData="M0,19L108,19"
|
|
||||||
android:strokeWidth="0.8"
|
|
||||||
android:strokeColor="#33FFFFFF" />
|
|
||||||
<path
|
|
||||||
android:fillColor="#00000000"
|
|
||||||
android:pathData="M0,29L108,29"
|
|
||||||
android:strokeWidth="0.8"
|
|
||||||
android:strokeColor="#33FFFFFF" />
|
|
||||||
<path
|
|
||||||
android:fillColor="#00000000"
|
|
||||||
android:pathData="M0,39L108,39"
|
|
||||||
android:strokeWidth="0.8"
|
|
||||||
android:strokeColor="#33FFFFFF" />
|
|
||||||
<path
|
|
||||||
android:fillColor="#00000000"
|
|
||||||
android:pathData="M0,49L108,49"
|
|
||||||
android:strokeWidth="0.8"
|
|
||||||
android:strokeColor="#33FFFFFF" />
|
|
||||||
<path
|
|
||||||
android:fillColor="#00000000"
|
|
||||||
android:pathData="M0,59L108,59"
|
|
||||||
android:strokeWidth="0.8"
|
|
||||||
android:strokeColor="#33FFFFFF" />
|
|
||||||
<path
|
|
||||||
android:fillColor="#00000000"
|
|
||||||
android:pathData="M0,69L108,69"
|
|
||||||
android:strokeWidth="0.8"
|
|
||||||
android:strokeColor="#33FFFFFF" />
|
|
||||||
<path
|
|
||||||
android:fillColor="#00000000"
|
|
||||||
android:pathData="M0,79L108,79"
|
|
||||||
android:strokeWidth="0.8"
|
|
||||||
android:strokeColor="#33FFFFFF" />
|
|
||||||
<path
|
|
||||||
android:fillColor="#00000000"
|
|
||||||
android:pathData="M0,89L108,89"
|
|
||||||
android:strokeWidth="0.8"
|
|
||||||
android:strokeColor="#33FFFFFF" />
|
|
||||||
<path
|
|
||||||
android:fillColor="#00000000"
|
|
||||||
android:pathData="M0,99L108,99"
|
|
||||||
android:strokeWidth="0.8"
|
|
||||||
android:strokeColor="#33FFFFFF" />
|
|
||||||
<path
|
|
||||||
android:fillColor="#00000000"
|
|
||||||
android:pathData="M19,29L89,29"
|
|
||||||
android:strokeWidth="0.8"
|
|
||||||
android:strokeColor="#33FFFFFF" />
|
|
||||||
<path
|
|
||||||
android:fillColor="#00000000"
|
|
||||||
android:pathData="M19,39L89,39"
|
|
||||||
android:strokeWidth="0.8"
|
|
||||||
android:strokeColor="#33FFFFFF" />
|
|
||||||
<path
|
|
||||||
android:fillColor="#00000000"
|
|
||||||
android:pathData="M19,49L89,49"
|
|
||||||
android:strokeWidth="0.8"
|
|
||||||
android:strokeColor="#33FFFFFF" />
|
|
||||||
<path
|
|
||||||
android:fillColor="#00000000"
|
|
||||||
android:pathData="M19,59L89,59"
|
|
||||||
android:strokeWidth="0.8"
|
|
||||||
android:strokeColor="#33FFFFFF" />
|
|
||||||
<path
|
|
||||||
android:fillColor="#00000000"
|
|
||||||
android:pathData="M19,69L89,69"
|
|
||||||
android:strokeWidth="0.8"
|
|
||||||
android:strokeColor="#33FFFFFF" />
|
|
||||||
<path
|
|
||||||
android:fillColor="#00000000"
|
|
||||||
android:pathData="M19,79L89,79"
|
|
||||||
android:strokeWidth="0.8"
|
|
||||||
android:strokeColor="#33FFFFFF" />
|
|
||||||
<path
|
|
||||||
android:fillColor="#00000000"
|
|
||||||
android:pathData="M29,19L29,89"
|
|
||||||
android:strokeWidth="0.8"
|
|
||||||
android:strokeColor="#33FFFFFF" />
|
|
||||||
<path
|
|
||||||
android:fillColor="#00000000"
|
|
||||||
android:pathData="M39,19L39,89"
|
|
||||||
android:strokeWidth="0.8"
|
|
||||||
android:strokeColor="#33FFFFFF" />
|
|
||||||
<path
|
|
||||||
android:fillColor="#00000000"
|
|
||||||
android:pathData="M49,19L49,89"
|
|
||||||
android:strokeWidth="0.8"
|
|
||||||
android:strokeColor="#33FFFFFF" />
|
|
||||||
<path
|
|
||||||
android:fillColor="#00000000"
|
|
||||||
android:pathData="M59,19L59,89"
|
|
||||||
android:strokeWidth="0.8"
|
|
||||||
android:strokeColor="#33FFFFFF" />
|
|
||||||
<path
|
|
||||||
android:fillColor="#00000000"
|
|
||||||
android:pathData="M69,19L69,89"
|
|
||||||
android:strokeWidth="0.8"
|
|
||||||
android:strokeColor="#33FFFFFF" />
|
|
||||||
<path
|
|
||||||
android:fillColor="#00000000"
|
|
||||||
android:pathData="M79,19L79,89"
|
|
||||||
android:strokeWidth="0.8"
|
|
||||||
android:strokeColor="#33FFFFFF" />
|
|
||||||
</vector>
|
|
||||||
@@ -1,18 +0,0 @@
|
|||||||
<?xml version="1.0" encoding="utf-8"?>
|
|
||||||
<androidx.constraintlayout.widget.ConstraintLayout xmlns:android="http://schemas.android.com/apk/res/android"
|
|
||||||
xmlns:app="http://schemas.android.com/apk/res-auto"
|
|
||||||
xmlns:tools="http://schemas.android.com/tools"
|
|
||||||
android:layout_width="match_parent"
|
|
||||||
android:layout_height="match_parent"
|
|
||||||
tools:context=".MainActivity">
|
|
||||||
|
|
||||||
<TextView
|
|
||||||
android:layout_width="wrap_content"
|
|
||||||
android:layout_height="wrap_content"
|
|
||||||
android:text="Hello World!"
|
|
||||||
app:layout_constraintBottom_toBottomOf="parent"
|
|
||||||
app:layout_constraintLeft_toLeftOf="parent"
|
|
||||||
app:layout_constraintRight_toRightOf="parent"
|
|
||||||
app:layout_constraintTop_toTopOf="parent" />
|
|
||||||
|
|
||||||
</androidx.constraintlayout.widget.ConstraintLayout>
|
|
||||||
@@ -1,5 +0,0 @@
|
|||||||
<?xml version="1.0" encoding="utf-8"?>
|
|
||||||
<adaptive-icon xmlns:android="http://schemas.android.com/apk/res/android">
|
|
||||||
<background android:drawable="@drawable/ic_launcher_background" />
|
|
||||||
<foreground android:drawable="@drawable/ic_launcher_foreground" />
|
|
||||||
</adaptive-icon>
|
|
||||||
@@ -1,5 +0,0 @@
|
|||||||
<?xml version="1.0" encoding="utf-8"?>
|
|
||||||
<adaptive-icon xmlns:android="http://schemas.android.com/apk/res/android">
|
|
||||||
<background android:drawable="@drawable/ic_launcher_background" />
|
|
||||||
<foreground android:drawable="@drawable/ic_launcher_foreground" />
|
|
||||||
</adaptive-icon>
|
|
||||||
|
Before Width: | Height: | Size: 2.9 KiB |
|
Before Width: | Height: | Size: 4.8 KiB |
|
Before Width: | Height: | Size: 2.0 KiB |
|
Before Width: | Height: | Size: 2.7 KiB |
|
Before Width: | Height: | Size: 4.4 KiB |
|
Before Width: | Height: | Size: 6.7 KiB |
|
Before Width: | Height: | Size: 6.2 KiB |
|
Before Width: | Height: | Size: 10 KiB |
|
Before Width: | Height: | Size: 8.9 KiB |
|
Before Width: | Height: | Size: 15 KiB |
@@ -1,6 +0,0 @@
|
|||||||
<?xml version="1.0" encoding="utf-8"?>
|
|
||||||
<resources>
|
|
||||||
<color name="colorPrimary">#008577</color>
|
|
||||||
<color name="colorPrimaryDark">#00574B</color>
|
|
||||||
<color name="colorAccent">#D81B60</color>
|
|
||||||
</resources>
|
|
||||||
@@ -1,3 +0,0 @@
|
|||||||
<resources>
|
|
||||||
<string name="app_name">Tree Data Structure</string>
|
|
||||||
</resources>
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
<resources>
|
|
||||||
|
|
||||||
<!-- Base application theme. -->
|
|
||||||
<style name="AppTheme" parent="Theme.AppCompat.Light.DarkActionBar">
|
|
||||||
<!-- Customize your theme here. -->
|
|
||||||
<item name="colorPrimary">@color/colorPrimary</item>
|
|
||||||
<item name="colorPrimaryDark">@color/colorPrimaryDark</item>
|
|
||||||
<item name="colorAccent">@color/colorAccent</item>
|
|
||||||
</style>
|
|
||||||
|
|
||||||
</resources>
|
|
||||||
@@ -1,17 +0,0 @@
|
|||||||
package com.github.adriankuta.treedatastructure
|
|
||||||
|
|
||||||
import org.junit.Test
|
|
||||||
|
|
||||||
import org.junit.Assert.*
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Example local unit test, which will execute on the development machine (host).
|
|
||||||
*
|
|
||||||
* See [testing documentation](http://d.android.com/tools/testing).
|
|
||||||
*/
|
|
||||||
class ExampleUnitTest {
|
|
||||||
@Test
|
|
||||||
fun addition_isCorrect() {
|
|
||||||
assertEquals(4, 2 + 2)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
31
build.gradle
@@ -1,31 +0,0 @@
|
|||||||
// Top-level build file where you can add configuration options common to all sub-projects/modules.
|
|
||||||
|
|
||||||
buildscript {
|
|
||||||
ext.kotlin_version = '1.3.61'
|
|
||||||
repositories {
|
|
||||||
google()
|
|
||||||
jcenter()
|
|
||||||
|
|
||||||
}
|
|
||||||
dependencies {
|
|
||||||
classpath 'com.android.tools.build:gradle:3.5.3'
|
|
||||||
classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
|
|
||||||
classpath "io.codearte.gradle.nexus:gradle-nexus-staging-plugin:0.21.2"
|
|
||||||
// NOTE: Do not place your application dependencies here; they belong
|
|
||||||
// in the individual module build.gradle files
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
allprojects {
|
|
||||||
repositories {
|
|
||||||
google()
|
|
||||||
jcenter()
|
|
||||||
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
task clean(type: Delete) {
|
|
||||||
delete rootProject.buildDir
|
|
||||||
}
|
|
||||||
|
|
||||||
apply plugin: 'io.codearte.nexus-staging'
|
|
||||||
122
build.gradle.kts
Normal file
@@ -0,0 +1,122 @@
|
|||||||
|
import org.jetbrains.kotlin.gradle.ExperimentalWasmDsl
|
||||||
|
|
||||||
|
plugins {
|
||||||
|
alias(libs.plugins.kotlinMultiplatform)
|
||||||
|
alias(libs.plugins.dokka)
|
||||||
|
alias(libs.plugins.mavenPublish)
|
||||||
|
alias(libs.plugins.binaryCompatibilityValidator)
|
||||||
|
alias(libs.plugins.kover)
|
||||||
|
signing
|
||||||
|
}
|
||||||
|
|
||||||
|
val PUBLISH_GROUP_ID = "com.github.adriankuta"
|
||||||
|
val PUBLISH_ARTIFACT_ID = "tree-structure" // base artifact; KMP will add -jvm, -ios*, etc.
|
||||||
|
val PUBLISH_VERSION = "4.0.0"
|
||||||
|
|
||||||
|
val snapshot: String? by project
|
||||||
|
|
||||||
|
group = PUBLISH_GROUP_ID
|
||||||
|
version = if (snapshot.toBoolean()) "$PUBLISH_VERSION-SNAPSHOT" else PUBLISH_VERSION
|
||||||
|
|
||||||
|
mavenPublishing {
|
||||||
|
// Central Portal + auto release when we call publishAndReleaseToMavenCentral
|
||||||
|
publishToMavenCentral(automaticRelease = false)
|
||||||
|
signAllPublications()
|
||||||
|
|
||||||
|
coordinates(PUBLISH_GROUP_ID, PUBLISH_ARTIFACT_ID, version.toString())
|
||||||
|
|
||||||
|
pom {
|
||||||
|
name.set("Tree Data Structure")
|
||||||
|
description.set(
|
||||||
|
"Lightweight n-ary tree data structure for Kotlin Multiplatform (JVM, JS, Wasm, iOS, " +
|
||||||
|
"Native). DSL, pre/post/level-order traversal, lazy Sequence traversal, and pretty-print.",
|
||||||
|
)
|
||||||
|
url.set("https://github.com/AdrianKuta/Tree-Data-Structure")
|
||||||
|
|
||||||
|
licenses {
|
||||||
|
license {
|
||||||
|
name.set("MIT License")
|
||||||
|
url.set("https://opensource.org/licenses/MIT")
|
||||||
|
distribution.set("repo")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
developers {
|
||||||
|
developer {
|
||||||
|
id.set("AdrianKuta")
|
||||||
|
name.set("Adrian Kuta")
|
||||||
|
email.set("adrian.kuta93@gmail.com")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
scm {
|
||||||
|
url.set("https://github.com/AdrianKuta/Tree-Data-Structure")
|
||||||
|
connection.set("scm:git:https://github.com/AdrianKuta/Tree-Data-Structure.git")
|
||||||
|
developerConnection.set("scm:git:ssh://git@github.com/AdrianKuta/Tree-Data-Structure.git")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
repositories {
|
||||||
|
mavenCentral()
|
||||||
|
}
|
||||||
|
|
||||||
|
dependencies {
|
||||||
|
// Include this module's own docs in the aggregation — DGP v2 requires the
|
||||||
|
// aggregating project to list itself explicitly.
|
||||||
|
dokka(project(":"))
|
||||||
|
dokka(project(":tree-structure-serialization"))
|
||||||
|
dokka(project(":tree-structure-coroutines"))
|
||||||
|
dokka(project(":tree-structure-compose"))
|
||||||
|
}
|
||||||
|
|
||||||
|
dokka {
|
||||||
|
moduleName.set("Tree Data Structure")
|
||||||
|
dokkaSourceSets.configureEach {
|
||||||
|
sourceLink {
|
||||||
|
localDirectory.set(projectDir.resolve("src"))
|
||||||
|
// For the root project projectDir == rootDir, so `module` is "" and links resolve to /blob/master/src.
|
||||||
|
val module = projectDir.relativeTo(rootDir).invariantSeparatorsPath
|
||||||
|
val prefix = if (module.isEmpty()) "" else "$module/"
|
||||||
|
remoteUrl("https://github.com/AdrianKuta/Tree-Data-Structure/blob/master/${prefix}src")
|
||||||
|
remoteLineSuffix.set("#L")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
kotlin {
|
||||||
|
explicitApi()
|
||||||
|
jvmToolchain(21)
|
||||||
|
|
||||||
|
jvm()
|
||||||
|
|
||||||
|
js(IR) {
|
||||||
|
browser()
|
||||||
|
nodejs()
|
||||||
|
}
|
||||||
|
|
||||||
|
@OptIn(ExperimentalWasmDsl::class)
|
||||||
|
wasmJs {
|
||||||
|
browser()
|
||||||
|
nodejs()
|
||||||
|
}
|
||||||
|
|
||||||
|
// Apple targets
|
||||||
|
iosX64()
|
||||||
|
iosArm64()
|
||||||
|
iosSimulatorArm64()
|
||||||
|
|
||||||
|
// Native host target
|
||||||
|
val hostOs = System.getProperty("os.name")
|
||||||
|
val isMingwX64 = hostOs.startsWith("Windows")
|
||||||
|
when {
|
||||||
|
hostOs == "Mac OS X" -> macosX64("native")
|
||||||
|
hostOs == "Linux" -> linuxX64("native")
|
||||||
|
isMingwX64 -> mingwX64("native")
|
||||||
|
else -> throw GradleException("Host OS is not supported in Kotlin/Native.")
|
||||||
|
}
|
||||||
|
|
||||||
|
sourceSets {
|
||||||
|
commonTest.dependencies {
|
||||||
|
implementation(kotlin("test"))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
435
docs/superpowers/plans/2026-06-07-api-reference-github-pages.md
Normal file
@@ -0,0 +1,435 @@
|
|||||||
|
# API Reference (Dokka HTML) on GitHub Pages — Implementation Plan
|
||||||
|
|
||||||
|
> **For agentic workers:** REQUIRED SUB-SKILL: Use superpowers:subagent-driven-development (recommended) or superpowers:executing-plans to implement this plan task-by-task. Steps use checkbox (`- [ ]`) syntax for tracking.
|
||||||
|
|
||||||
|
**Goal:** Migrate Dokka to 2.x and publish an aggregated, source-linked multi-module API reference for all four modules to GitHub Pages on each release and on demand.
|
||||||
|
|
||||||
|
**Architecture:** Bump Dokka `1.9.20 → 2.2.0` and switch on the Dokka Gradle Plugin v2 (`V2Enabled`). The root project (the published core module) aggregates the three submodules via `dokka(project(...))` dependencies, producing one HTML site at `build/dokka/html`. A new `docs.yml` workflow builds that site and deploys it with the official GitHub Pages Actions. The vanniktech maven-publish plugin (0.34.0) keeps building the Maven Central `-javadoc.jar` — it already supports Dokka V2, so the release pipeline is unaffected.
|
||||||
|
|
||||||
|
**Tech Stack:** Kotlin Multiplatform 2.1.0, Gradle 8.5, Dokka Gradle Plugin 2.2.0, vanniktech maven-publish 0.34.0, GitHub Actions (`upload-pages-artifact@v3`, `deploy-pages@v4`).
|
||||||
|
|
||||||
|
**Spec:** `docs/superpowers/specs/2026-06-07-publish-api-reference-dokka-github-pages-design.md`
|
||||||
|
|
||||||
|
> **Note on "tests":** This is build/CI work, so each task's verification is a Gradle command or a YAML lint with a concrete expected result rather than a unit test. Treat the "verify" steps as the failing/passing check.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## File Structure
|
||||||
|
|
||||||
|
| File | Responsibility | Action |
|
||||||
|
| --- | --- | --- |
|
||||||
|
| `gradle/libs.versions.toml` | Centralized Dokka version | Modify (`dokka = "2.2.0"`) |
|
||||||
|
| `gradle.properties` | Enable DGP v2 plugin mode | Modify (add 2 flags) |
|
||||||
|
| `build.gradle.kts` (root) | Aggregate 3 submodules; root site title + source links | Modify (add `dependencies` + `dokka {}` blocks) |
|
||||||
|
| `tree-structure-serialization/build.gradle.kts` | Source links for this module | Modify (add `dokka {}` block) |
|
||||||
|
| `tree-structure-coroutines/build.gradle.kts` | Source links for this module | Modify (add `dokka {}` block) |
|
||||||
|
| `tree-structure-compose/build.gradle.kts` | Source links for this module | Modify (add `dokka {}` block) |
|
||||||
|
| `.github/workflows/docs.yml` | Build + deploy site to Pages | Create |
|
||||||
|
| `README.md` | Docs badge + link | Modify |
|
||||||
|
|
||||||
|
Work happens on branch `docs/api-reference-github-pages` (already created; spec already committed there).
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Task 1: Migrate Dokka to 2.2.0 and enable DGP v2
|
||||||
|
|
||||||
|
**Files:**
|
||||||
|
- Modify: `gradle/libs.versions.toml` (line `dokka = "1.9.20"`)
|
||||||
|
- Modify: `gradle.properties`
|
||||||
|
|
||||||
|
- [ ] **Step 1: Bump the Dokka version in the catalog**
|
||||||
|
|
||||||
|
In `gradle/libs.versions.toml`, change the `dokka` version under `[versions]`:
|
||||||
|
|
||||||
|
```toml
|
||||||
|
dokka = "2.2.0"
|
||||||
|
```
|
||||||
|
|
||||||
|
(Leave the `dokka = { id = "org.jetbrains.dokka", version.ref = "dokka" }` plugin line unchanged.)
|
||||||
|
|
||||||
|
- [ ] **Step 2: Enable the Dokka Gradle Plugin v2**
|
||||||
|
|
||||||
|
Append these two lines to `gradle.properties` (current content is only `kotlin.code.style=official`):
|
||||||
|
|
||||||
|
```properties
|
||||||
|
# Dokka Gradle Plugin v2 (https://kotl.in/dokka-gradle-migration)
|
||||||
|
org.jetbrains.dokka.experimental.gradle.pluginMode=V2Enabled
|
||||||
|
org.jetbrains.dokka.experimental.gradle.pluginMode.noWarn=true
|
||||||
|
```
|
||||||
|
|
||||||
|
- [ ] **Step 3: Verify the v2 task exists and there is no V1 warning**
|
||||||
|
|
||||||
|
Run: `./gradlew :dokkaGeneratePublicationHtml --dry-run --console=plain`
|
||||||
|
|
||||||
|
Expected: `BUILD SUCCESSFUL`, a list of `:dokkaGenerate*` tasks printed, and **no** message containing `Dokka Gradle plugin V1` or `migration guide`. (At this point only the root/core module is documented — aggregation is added in Task 2.)
|
||||||
|
|
||||||
|
- [ ] **Step 4: Verify the Maven Central javadoc jar still builds under Dokka 2.x**
|
||||||
|
|
||||||
|
Run: `./gradlew javadocJar --console=plain`
|
||||||
|
|
||||||
|
Expected: `BUILD SUCCESSFUL`. This is the vanniktech-generated jar that Maven Central requires; it must keep working. (If the task name isn't found, list it with `./gradlew tasks --all | grep -i javadoc` and run the reported task — it is the per-module `javadocJar`.)
|
||||||
|
|
||||||
|
- [ ] **Step 5: Commit**
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git add gradle/libs.versions.toml gradle.properties
|
||||||
|
git commit -m "build: migrate Dokka 1.9.20 -> 2.2.0 (DGP v2) (#32)"
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Task 2: Aggregate all modules + root site title and source links
|
||||||
|
|
||||||
|
**Files:**
|
||||||
|
- Modify: `build.gradle.kts` (root)
|
||||||
|
|
||||||
|
- [ ] **Step 1: Add the Dokka aggregation dependencies**
|
||||||
|
|
||||||
|
Add this top-level block to the root `build.gradle.kts` (place it after the `repositories { mavenCentral() }` block, at the top level — not inside `kotlin {}`):
|
||||||
|
|
||||||
|
```kotlin
|
||||||
|
dependencies {
|
||||||
|
dokka(project(":tree-structure-serialization"))
|
||||||
|
dokka(project(":tree-structure-coroutines"))
|
||||||
|
dokka(project(":tree-structure-compose"))
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
- [ ] **Step 2: Add the root `dokka {}` configuration (site title + source links)**
|
||||||
|
|
||||||
|
Add this top-level block to the root `build.gradle.kts` (e.g. right after the `dependencies {}` block from Step 1):
|
||||||
|
|
||||||
|
```kotlin
|
||||||
|
dokka {
|
||||||
|
moduleName.set("Tree Data Structure")
|
||||||
|
dokkaSourceSets.configureEach {
|
||||||
|
sourceLink {
|
||||||
|
localDirectory.set(projectDir.resolve("src"))
|
||||||
|
val module = projectDir.relativeTo(rootDir).invariantSeparatorsPath
|
||||||
|
val prefix = if (module.isEmpty()) "" else "$module/"
|
||||||
|
remoteUrl("https://github.com/AdrianKuta/Tree-Data-Structure/blob/master/${prefix}src")
|
||||||
|
remoteLineSuffix.set("#L")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
- [ ] **Step 3: Build the aggregated site**
|
||||||
|
|
||||||
|
Run: `./gradlew :dokkaGeneratePublicationHtml --console=plain`
|
||||||
|
|
||||||
|
Expected: `BUILD SUCCESSFUL` and the file `build/dokka/html/index.html` exists.
|
||||||
|
|
||||||
|
Run: `ls build/dokka/html`
|
||||||
|
|
||||||
|
Expected: per-module output directories including `tree-structure`, `tree-structure-serialization`, `tree-structure-coroutines`, and `tree-structure-compose` (plus `index.html`, `navigation.html`, assets).
|
||||||
|
|
||||||
|
- [ ] **Step 4: Verify the four modules and root source links are present**
|
||||||
|
|
||||||
|
Run: `grep -roh "tree-structure-serialization\|tree-structure-coroutines\|tree-structure-compose" build/dokka/html/index.html | sort -u`
|
||||||
|
|
||||||
|
Expected: all three submodule names listed (confirming aggregation).
|
||||||
|
|
||||||
|
Run: `grep -rl "github.com/AdrianKuta/Tree-Data-Structure/blob/master/src/" build/dokka/html/tree-structure | head -1`
|
||||||
|
|
||||||
|
Expected: at least one file path printed (confirming the root/core module's source links resolve to `.../blob/master/src/...`). Optionally open `build/dokka/html/index.html` in a browser and click a core class's "source" link to confirm it lands on the right GitHub file.
|
||||||
|
|
||||||
|
- [ ] **Step 5: Commit**
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git add build.gradle.kts
|
||||||
|
git commit -m "docs: aggregate all modules into one Dokka HTML site with source links (#32)"
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Task 3: Source links for the three submodules
|
||||||
|
|
||||||
|
The submodules are documented by the aggregation but need their own `sourceLink` so their symbols point at the correct subdirectory on GitHub. The block below is **path-derived and identical** for every module — add the exact same block to all three files.
|
||||||
|
|
||||||
|
**Files:**
|
||||||
|
- Modify: `tree-structure-serialization/build.gradle.kts`
|
||||||
|
- Modify: `tree-structure-coroutines/build.gradle.kts`
|
||||||
|
- Modify: `tree-structure-compose/build.gradle.kts`
|
||||||
|
|
||||||
|
- [ ] **Step 1: Add the `dokka {}` block to `tree-structure-serialization/build.gradle.kts`**
|
||||||
|
|
||||||
|
Add this top-level block (after the `repositories {}` block, before `kotlin {}`):
|
||||||
|
|
||||||
|
```kotlin
|
||||||
|
dokka {
|
||||||
|
dokkaSourceSets.configureEach {
|
||||||
|
sourceLink {
|
||||||
|
localDirectory.set(projectDir.resolve("src"))
|
||||||
|
val module = projectDir.relativeTo(rootDir).invariantSeparatorsPath
|
||||||
|
val prefix = if (module.isEmpty()) "" else "$module/"
|
||||||
|
remoteUrl("https://github.com/AdrianKuta/Tree-Data-Structure/blob/master/${prefix}src")
|
||||||
|
remoteLineSuffix.set("#L")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
- [ ] **Step 2: Add the same block to `tree-structure-coroutines/build.gradle.kts`**
|
||||||
|
|
||||||
|
Add the identical block (after `repositories {}`, before `kotlin {}`):
|
||||||
|
|
||||||
|
```kotlin
|
||||||
|
dokka {
|
||||||
|
dokkaSourceSets.configureEach {
|
||||||
|
sourceLink {
|
||||||
|
localDirectory.set(projectDir.resolve("src"))
|
||||||
|
val module = projectDir.relativeTo(rootDir).invariantSeparatorsPath
|
||||||
|
val prefix = if (module.isEmpty()) "" else "$module/"
|
||||||
|
remoteUrl("https://github.com/AdrianKuta/Tree-Data-Structure/blob/master/${prefix}src")
|
||||||
|
remoteLineSuffix.set("#L")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
- [ ] **Step 3: Add the same block to `tree-structure-compose/build.gradle.kts`**
|
||||||
|
|
||||||
|
Add the identical block (after the `repositories { mavenCentral(); google() }` block, before `kotlin {}`):
|
||||||
|
|
||||||
|
```kotlin
|
||||||
|
dokka {
|
||||||
|
dokkaSourceSets.configureEach {
|
||||||
|
sourceLink {
|
||||||
|
localDirectory.set(projectDir.resolve("src"))
|
||||||
|
val module = projectDir.relativeTo(rootDir).invariantSeparatorsPath
|
||||||
|
val prefix = if (module.isEmpty()) "" else "$module/"
|
||||||
|
remoteUrl("https://github.com/AdrianKuta/Tree-Data-Structure/blob/master/${prefix}src")
|
||||||
|
remoteLineSuffix.set("#L")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
- [ ] **Step 4: Rebuild the site**
|
||||||
|
|
||||||
|
Run: `./gradlew :dokkaGeneratePublicationHtml --console=plain`
|
||||||
|
|
||||||
|
Expected: `BUILD SUCCESSFUL`.
|
||||||
|
|
||||||
|
- [ ] **Step 5: Verify each submodule's source links resolve to its subdirectory**
|
||||||
|
|
||||||
|
Run:
|
||||||
|
```bash
|
||||||
|
for m in serialization coroutines compose; do
|
||||||
|
echo -n "tree-structure-$m: "
|
||||||
|
grep -rl "github.com/AdrianKuta/Tree-Data-Structure/blob/master/tree-structure-$m/src/" build/dokka/html/tree-structure-$m | head -1 || echo "MISSING"
|
||||||
|
done
|
||||||
|
```
|
||||||
|
|
||||||
|
Expected: a file path printed for each of the three modules (none "MISSING").
|
||||||
|
|
||||||
|
- [ ] **Step 6: Commit**
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git add tree-structure-serialization/build.gradle.kts tree-structure-coroutines/build.gradle.kts tree-structure-compose/build.gradle.kts
|
||||||
|
git commit -m "docs: add Dokka source links to serialization/coroutines/compose modules (#32)"
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Task 4: GitHub Pages workflow
|
||||||
|
|
||||||
|
**Files:**
|
||||||
|
- Create: `.github/workflows/docs.yml`
|
||||||
|
|
||||||
|
- [ ] **Step 1: Create the workflow file**
|
||||||
|
|
||||||
|
Create `.github/workflows/docs.yml` with exactly:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
name: Docs
|
||||||
|
|
||||||
|
on:
|
||||||
|
release:
|
||||||
|
types: [released]
|
||||||
|
workflow_dispatch:
|
||||||
|
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
|
pages: write
|
||||||
|
id-token: write
|
||||||
|
|
||||||
|
concurrency:
|
||||||
|
group: pages
|
||||||
|
cancel-in-progress: false
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
build:
|
||||||
|
name: Build Dokka HTML
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: Check out code
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
- name: Set up JDK 21
|
||||||
|
uses: actions/setup-java@v4
|
||||||
|
with:
|
||||||
|
distribution: temurin
|
||||||
|
java-version: '21'
|
||||||
|
- name: Generate API docs
|
||||||
|
run: ./gradlew :dokkaGeneratePublicationHtml --console=plain
|
||||||
|
- name: Upload Pages artifact
|
||||||
|
uses: actions/upload-pages-artifact@v3
|
||||||
|
with:
|
||||||
|
path: build/dokka/html
|
||||||
|
|
||||||
|
deploy:
|
||||||
|
name: Deploy to GitHub Pages
|
||||||
|
needs: build
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
environment:
|
||||||
|
name: github-pages
|
||||||
|
url: ${{ steps.deployment.outputs.page_url }}
|
||||||
|
steps:
|
||||||
|
- name: Deploy
|
||||||
|
id: deployment
|
||||||
|
uses: actions/deploy-pages@v4
|
||||||
|
```
|
||||||
|
|
||||||
|
- [ ] **Step 2: Validate the YAML is well-formed**
|
||||||
|
|
||||||
|
Run: `ruby -ryaml -e "YAML.load_file('.github/workflows/docs.yml'); puts 'OK'"`
|
||||||
|
|
||||||
|
Expected: prints `OK` with no error. (Ruby ships with macOS. Alternatively, if `actionlint` is installed: `actionlint .github/workflows/docs.yml` → no output.)
|
||||||
|
|
||||||
|
- [ ] **Step 3: Commit**
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git add .github/workflows/docs.yml
|
||||||
|
git commit -m "ci: add docs workflow to deploy Dokka HTML to GitHub Pages (#32)"
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Task 5: Link the site from the README
|
||||||
|
|
||||||
|
**Files:**
|
||||||
|
- Modify: `README.md` (top badge block, lines 1-6)
|
||||||
|
|
||||||
|
- [ ] **Step 1: Add the API docs badge**
|
||||||
|
|
||||||
|
In `README.md`, immediately after the existing `Publish` badge line:
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
[](https://github.com/AdrianKuta/Tree-Data-Structure/actions/workflows/publishRelease.yml)
|
||||||
|
```
|
||||||
|
|
||||||
|
add this new line:
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
[](https://adriankuta.github.io/Tree-Data-Structure/)
|
||||||
|
```
|
||||||
|
|
||||||
|
- [ ] **Step 2: Add a one-line pointer under the badges**
|
||||||
|
|
||||||
|
After the badge block and its following blank line, and **before** the intro paragraph that starts `A lightweight n-ary tree for Kotlin Multiplatform.`, insert:
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
📖 **[API reference](https://adriankuta.github.io/Tree-Data-Structure/)** — full KDoc for the core and all modules.
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
- [ ] **Step 3: Verify the link is present**
|
||||||
|
|
||||||
|
Run: `grep -n "adriankuta.github.io/Tree-Data-Structure" README.md`
|
||||||
|
|
||||||
|
Expected: two matches (the badge and the 📖 line).
|
||||||
|
|
||||||
|
- [ ] **Step 4: Commit**
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git add README.md
|
||||||
|
git commit -m "docs: link the published API reference from the README (#32)"
|
||||||
|
```
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Task 6: Full verification, push, and pull request
|
||||||
|
|
||||||
|
**Files:** none (verification + integration)
|
||||||
|
|
||||||
|
- [ ] **Step 1: Full local verification**
|
||||||
|
|
||||||
|
Run each and confirm `BUILD SUCCESSFUL`:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
./gradlew :dokkaGeneratePublicationHtml --console=plain # site builds, all 4 modules
|
||||||
|
./gradlew javadocJar --console=plain # release javadoc jar intact
|
||||||
|
./gradlew apiCheck --console=plain # binary-compat baseline unchanged
|
||||||
|
```
|
||||||
|
|
||||||
|
Expected: all three succeed. `apiCheck` must pass with no diff — this change touches only build config and docs, not public API. Optionally open `build/dokka/html/index.html` in a browser for a final visual check (module nav + a couple of source links).
|
||||||
|
|
||||||
|
- [ ] **Step 2: Push the branch**
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git push -u origin docs/api-reference-github-pages
|
||||||
|
```
|
||||||
|
|
||||||
|
- [ ] **Step 3: Open the pull request**
|
||||||
|
|
||||||
|
```bash
|
||||||
|
gh pr create --base master --head docs/api-reference-github-pages \
|
||||||
|
--title "Publish API reference (Dokka HTML) to GitHub Pages (#32)" \
|
||||||
|
--body "$(cat <<'EOF'
|
||||||
|
Closes #32.
|
||||||
|
|
||||||
|
Migrates Dokka 1.9.20 → 2.2.0 (DGP v2) and publishes an aggregated, source-linked
|
||||||
|
multi-module API reference to GitHub Pages.
|
||||||
|
|
||||||
|
## What changed
|
||||||
|
- **Dokka 2.2.0 / DGP v2** (`V2Enabled` in `gradle.properties`). Gradle 8.5 and Kotlin
|
||||||
|
2.1.0 already satisfy Dokka 2.2.0's minimums (7.6+ / 1.9+), so no wrapper/Kotlin bump.
|
||||||
|
- **Aggregation**: the root (core) module pulls in `-serialization`, `-coroutines`, and
|
||||||
|
`-compose` via `dokka(project(...))` → one site at `build/dokka/html`
|
||||||
|
(`:dokkaGeneratePublicationHtml`).
|
||||||
|
- **Source links** on every module, pointing each symbol at its source on `master`.
|
||||||
|
- **`.github/workflows/docs.yml`**: builds the site and deploys via the official Pages
|
||||||
|
Actions on each release and on manual `workflow_dispatch`.
|
||||||
|
- **README**: docs badge + link to https://adriankuta.github.io/Tree-Data-Structure/
|
||||||
|
|
||||||
|
## Release pipeline unaffected
|
||||||
|
vanniktech 0.34.0 already supports Dokka `V2Enabled`, so the Maven Central
|
||||||
|
`-javadoc.jar` keeps building (verified locally with `./gradlew javadocJar`).
|
||||||
|
|
||||||
|
## ⚠️ One-time manual step required before the site goes live
|
||||||
|
Enable Pages: **Settings → Pages → Source = "GitHub Actions"**. Until then the
|
||||||
|
`deploy` job will fail. After enabling, run the **Docs** workflow once via
|
||||||
|
*Actions → Docs → Run workflow* (`workflow_dispatch`) to publish without waiting for a
|
||||||
|
release.
|
||||||
|
EOF
|
||||||
|
)"
|
||||||
|
```
|
||||||
|
|
||||||
|
Expected: PR URL printed.
|
||||||
|
|
||||||
|
- [ ] **Step 4: Post-merge manual steps (call these out to the repo owner)**
|
||||||
|
|
||||||
|
1. **Settings → Pages → Source = "GitHub Actions"** (one-time; otherwise `deploy` fails).
|
||||||
|
2. Trigger **Actions → Docs → Run workflow** (`workflow_dispatch`) to publish immediately.
|
||||||
|
3. Confirm the site is live at https://adriankuta.github.io/Tree-Data-Structure/ and the module nav + source links work.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Self-Review
|
||||||
|
|
||||||
|
**Spec coverage:**
|
||||||
|
- Dokka 1.9.20 → 2.2.0 + V2 mode → Task 1 ✓
|
||||||
|
- Multi-module aggregation in root → Task 2 ✓
|
||||||
|
- Source links (root + 3 submodules) + site title → Tasks 2 & 3 ✓
|
||||||
|
- `docs.yml` (release + workflow_dispatch, official Pages Actions) → Task 4 ✓
|
||||||
|
- README badge + link → Task 5 ✓
|
||||||
|
- Verify javadoc jar / apiCheck / local docs build → Tasks 1, 2, 6 ✓
|
||||||
|
- Manual Pages-enable prerequisite → Tasks 4/6 PR body + post-merge steps ✓
|
||||||
|
- Out-of-scope items (versioned docs, Module.md, vanniktech swap, CI cache) → correctly excluded ✓
|
||||||
|
|
||||||
|
**Placeholder scan:** No TBD/TODO/"handle edge cases"/"similar to Task N". The identical source-link block is repeated in full in each of Task 3's steps (not referenced) ✓
|
||||||
|
|
||||||
|
**Type/name consistency:** Task name `:dokkaGeneratePublicationHtml`, output dir `build/dokka/html`, config functions (`moduleName.set`, `dokkaSourceSets.configureEach`, `sourceLink { localDirectory.set / remoteUrl / remoteLineSuffix.set }`), and `dokka(project(...))` aggregation are used identically across Tasks 1–6 and the workflow ✓
|
||||||
|
|
||||||
|
**Open risk carried from spec:** if Dokka cannot resolve Apple source sets on `ubuntu-latest` in CI (Task 4), switch the `build` job's `runs-on` to `macos-latest` (mirrors the iOS test job). Local verification runs on macOS, which covers Apple source sets.
|
||||||
@@ -0,0 +1,237 @@
|
|||||||
|
# Design: Publish API reference (Dokka HTML) to GitHub Pages
|
||||||
|
|
||||||
|
- **Issue:** [#32](https://github.com/AdrianKuta/Tree-Data-Structure/issues/32) — *Publish API reference (Dokka HTML) to GitHub Pages*
|
||||||
|
- **Date:** 2026-06-07
|
||||||
|
- **Status:** Approved (design); pending spec review
|
||||||
|
|
||||||
|
## Summary
|
||||||
|
|
||||||
|
Generate a browsable, multi-module API reference with Dokka and host it on GitHub
|
||||||
|
Pages. The site aggregates the core (`tree-structure`) plus the `-serialization`,
|
||||||
|
`-coroutines`, and `-compose` modules, links every symbol back to its source on
|
||||||
|
GitHub, and is (re)deployed on each GitHub release or on demand. The README points
|
||||||
|
to it.
|
||||||
|
|
||||||
|
## Background / current state
|
||||||
|
|
||||||
|
- **Dokka 1.9.20** is applied to all four modules (root core + three submodules) via
|
||||||
|
`alias(libs.plugins.dokka)`. Today it runs only because the **vanniktech
|
||||||
|
maven-publish plugin (0.34.0)** uses it to build the `-javadoc.jar` that Maven
|
||||||
|
Central requires. There is no aggregation config, no docs site, no source links.
|
||||||
|
- Plugin/library versions are centralized in `gradle/libs.versions.toml`.
|
||||||
|
- The **root project is itself the published core module** and the natural Dokka
|
||||||
|
aggregation root.
|
||||||
|
- Existing workflows: `test.yml` (reusable matrix: JVM/JS/Wasm/Native + `apiCheck`,
|
||||||
|
plus iOS on macOS) and `publishRelease.yml` (on GitHub release → tests →
|
||||||
|
`./gradlew publishToMavenCentral`). Both use `actions/checkout@v4` +
|
||||||
|
`actions/setup-java@v4` (temurin, JDK 21) with no Gradle cache action.
|
||||||
|
- Gradle wrapper **8.5**; Kotlin **2.1.0**.
|
||||||
|
|
||||||
|
### Verified compatibility (de-risking)
|
||||||
|
|
||||||
|
- **Dokka 2.2.0** (latest stable) requires **Gradle 7.6+** and **Kotlin 1.9+** → our
|
||||||
|
8.5 / 2.1.0 satisfy both. **No wrapper bump, no Kotlin bump.**
|
||||||
|
- **vanniktech 0.34.0** already supports Dokka `V2Enabled` (added in 0.30.0), so the
|
||||||
|
Maven Central `-javadoc.jar` keeps building under Dokka 2.x. **No vanniktech bump.**
|
||||||
|
(For reference, 0.36.0 *removes* Dokka v1 support entirely — so V2 is the forward
|
||||||
|
direction regardless.)
|
||||||
|
|
||||||
|
## Goals
|
||||||
|
|
||||||
|
1. Migrate Dokka `1.9.20` → `2.2.0` (DGP v2 / `V2Enabled`) without breaking the
|
||||||
|
release pipeline's javadoc jar.
|
||||||
|
2. Produce one aggregated multi-module HTML site for all four modules.
|
||||||
|
3. Link every documented symbol to its source on GitHub.
|
||||||
|
4. Deploy the site to GitHub Pages on each release and on manual dispatch.
|
||||||
|
5. Link the site from the README.
|
||||||
|
|
||||||
|
## Non-goals (per the issue's "follow-up" note)
|
||||||
|
|
||||||
|
- Versioned / per-release docs (one published version at a time, tracking the latest
|
||||||
|
release / manual run).
|
||||||
|
- Long-form `Module.md` package descriptions.
|
||||||
|
- Changing the publishing tool (vanniktech stays; out of scope for #32).
|
||||||
|
- Adding a Gradle cache action to CI (keep parity with existing workflows).
|
||||||
|
|
||||||
|
## Detailed design
|
||||||
|
|
||||||
|
### 1. Dokka 2.x migration
|
||||||
|
|
||||||
|
**`gradle/libs.versions.toml`**
|
||||||
|
|
||||||
|
```toml
|
||||||
|
dokka = "2.2.0" # was 1.9.20
|
||||||
|
```
|
||||||
|
|
||||||
|
**`gradle.properties`** — enable DGP v2 and silence the migration notice:
|
||||||
|
|
||||||
|
```properties
|
||||||
|
org.jetbrains.dokka.experimental.gradle.pluginMode=V2Enabled
|
||||||
|
org.jetbrains.dokka.experimental.gradle.pluginMode.noWarn=true
|
||||||
|
```
|
||||||
|
|
||||||
|
The four `alias(libs.plugins.dokka)` plugin applications stay unchanged.
|
||||||
|
|
||||||
|
### 2. Multi-module aggregation (root `build.gradle.kts`)
|
||||||
|
|
||||||
|
Add a top-level `dependencies { }` block declaring the three submodules as Dokka
|
||||||
|
aggregation inputs. The root documents itself and pulls in the three:
|
||||||
|
|
||||||
|
```kotlin
|
||||||
|
dependencies {
|
||||||
|
dokka(project(":tree-structure-serialization"))
|
||||||
|
dokka(project(":tree-structure-coroutines"))
|
||||||
|
dokka(project(":tree-structure-compose"))
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
- Generating task: **`:dokkaGeneratePublicationHtml`** (root project).
|
||||||
|
- Output directory: **`build/dokka/html`** (the aggregated site, default location).
|
||||||
|
|
||||||
|
### 3. Source links + site title
|
||||||
|
|
||||||
|
A `dokka { }` block is added to **each of the four module build files**. The
|
||||||
|
`sourceLink` derives the per-module GitHub path from the project layout so each
|
||||||
|
module is correct without hardcoding paths:
|
||||||
|
|
||||||
|
```kotlin
|
||||||
|
dokka {
|
||||||
|
dokkaSourceSets.configureEach {
|
||||||
|
sourceLink {
|
||||||
|
localDirectory.set(projectDir.resolve("src"))
|
||||||
|
val module = projectDir.relativeTo(rootDir).invariantSeparatorsPath
|
||||||
|
val prefix = if (module.isEmpty()) "" else "$module/"
|
||||||
|
remoteUrl("https://github.com/AdrianKuta/Tree-Data-Structure/blob/master/${prefix}src")
|
||||||
|
remoteLineSuffix.set("#L")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
- For the **root** module, `module` is empty → links resolve to `…/blob/master/src/…`.
|
||||||
|
- For a submodule (e.g. serialization) → `…/blob/master/tree-structure-serialization/src/…`.
|
||||||
|
- Links point at the **`master`** branch. Trade-off: a previously deployed page links
|
||||||
|
to current `master`, which may have drifted. Accepted for simplicity; tag-accurate
|
||||||
|
links are a possible follow-up.
|
||||||
|
|
||||||
|
The **root** module additionally sets a friendly site title:
|
||||||
|
|
||||||
|
```kotlin
|
||||||
|
dokka {
|
||||||
|
moduleName.set("Tree Data Structure")
|
||||||
|
// ...sourceLink block as above...
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
Submodules keep their default module names (`tree-structure-serialization`,
|
||||||
|
`tree-structure-coroutines`, `tree-structure-compose`).
|
||||||
|
|
||||||
|
### 4. Pages workflow — `.github/workflows/docs.yml`
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
name: Docs
|
||||||
|
|
||||||
|
on:
|
||||||
|
release:
|
||||||
|
types: [released]
|
||||||
|
workflow_dispatch:
|
||||||
|
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
|
pages: write
|
||||||
|
id-token: write
|
||||||
|
|
||||||
|
concurrency:
|
||||||
|
group: pages
|
||||||
|
cancel-in-progress: false
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
build:
|
||||||
|
name: Build Dokka HTML
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- name: Check out code
|
||||||
|
uses: actions/checkout@v4
|
||||||
|
- name: Set up JDK 21
|
||||||
|
uses: actions/setup-java@v4
|
||||||
|
with:
|
||||||
|
distribution: temurin
|
||||||
|
java-version: '21'
|
||||||
|
- name: Generate API docs
|
||||||
|
run: ./gradlew :dokkaGeneratePublicationHtml --console=plain
|
||||||
|
- name: Upload Pages artifact
|
||||||
|
uses: actions/upload-pages-artifact@v3
|
||||||
|
with:
|
||||||
|
path: build/dokka/html
|
||||||
|
|
||||||
|
deploy:
|
||||||
|
name: Deploy to GitHub Pages
|
||||||
|
needs: build
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
environment:
|
||||||
|
name: github-pages
|
||||||
|
url: ${{ steps.deployment.outputs.page_url }}
|
||||||
|
steps:
|
||||||
|
- name: Deploy
|
||||||
|
id: deployment
|
||||||
|
uses: actions/deploy-pages@v4
|
||||||
|
```
|
||||||
|
|
||||||
|
- Triggers: `release: [released]` (matches the issue) **+** `workflow_dispatch`
|
||||||
|
(manual rebuild without a release).
|
||||||
|
- Official GitHub Pages Actions (no `gh-pages` branch).
|
||||||
|
- Runs on `ubuntu-latest` to match `publishRelease.yml`. **Fallback:** if Dokka
|
||||||
|
cannot resolve the Apple source sets on Linux CI, switch the `build` job to
|
||||||
|
`macos-latest` (as the iOS test job already does).
|
||||||
|
|
||||||
|
### 5. README
|
||||||
|
|
||||||
|
In the badge row near the top, add a docs badge and a one-line pointer:
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
[](https://adriankuta.github.io/Tree-Data-Structure/)
|
||||||
|
```
|
||||||
|
|
||||||
|
Plus a short line under the badges:
|
||||||
|
|
||||||
|
```markdown
|
||||||
|
📖 **[API reference](https://adriankuta.github.io/Tree-Data-Structure/)** — full KDoc for all modules.
|
||||||
|
```
|
||||||
|
|
||||||
|
Site URL: `https://adriankuta.github.io/Tree-Data-Structure/`.
|
||||||
|
|
||||||
|
### 6. One-time manual step (repo owner, not code)
|
||||||
|
|
||||||
|
GitHub Pages must be enabled once: **Settings → Pages → Source = "GitHub Actions"**.
|
||||||
|
Until then the `deploy` job fails. This will be called out in the PR / final summary.
|
||||||
|
|
||||||
|
## Verification (before claiming done)
|
||||||
|
|
||||||
|
1. `./gradlew :dokkaGeneratePublicationHtml --console=plain` locally on **macOS**
|
||||||
|
(covers Apple source sets) → confirm `build/dokka/html/index.html` exists and the
|
||||||
|
site lists **all four** modules, with working source links.
|
||||||
|
2. `./gradlew javadocJar --console=plain` → confirm the vanniktech javadoc jar(s)
|
||||||
|
still build under Dokka 2.x (release pipeline unaffected). Optionally
|
||||||
|
`./gradlew publishToMavenLocal -Psnapshot=true` for an end-to-end check.
|
||||||
|
3. `./gradlew apiCheck` and the existing test tasks still pass (no API/source impact).
|
||||||
|
4. Validate `docs.yml` YAML (well-formed, correct action versions).
|
||||||
|
|
||||||
|
## Risks & mitigations
|
||||||
|
|
||||||
|
| Risk | Mitigation |
|
||||||
|
| --- | --- |
|
||||||
|
| Dokka 2.x breaks the javadoc jar | vanniktech 0.34.0 supports `V2Enabled`; verify with `javadocJar` step 2 above. |
|
||||||
|
| Dokka can't resolve Apple source sets on Linux CI | Verify locally on macOS; fallback `macos-latest` for the build job. |
|
||||||
|
| Source-link paths wrong for a module | Derived from `projectDir.relativeTo(rootDir)`; visually verify links in step 1. |
|
||||||
|
| Pages deploy fails on first run | Documented manual prerequisite (Settings → Pages → GitHub Actions). |
|
||||||
|
|
||||||
|
## Files touched
|
||||||
|
|
||||||
|
- `gradle/libs.versions.toml` — Dokka version bump.
|
||||||
|
- `gradle.properties` — `V2Enabled` flags.
|
||||||
|
- `build.gradle.kts` (root) — aggregation `dependencies`, `dokka { moduleName + sourceLink }`.
|
||||||
|
- `tree-structure-serialization/build.gradle.kts` — `dokka { sourceLink }`.
|
||||||
|
- `tree-structure-coroutines/build.gradle.kts` — `dokka { sourceLink }`.
|
||||||
|
- `tree-structure-compose/build.gradle.kts` — `dokka { sourceLink }`.
|
||||||
|
- `.github/workflows/docs.yml` — new Pages workflow.
|
||||||
|
- `README.md` — docs badge + link.
|
||||||
@@ -1,21 +1,4 @@
|
|||||||
# Project-wide Gradle settings.
|
|
||||||
# IDE (e.g. Android Studio) users:
|
|
||||||
# Gradle settings configured through the IDE *will override*
|
|
||||||
# any settings specified in this file.
|
|
||||||
# For more details on how to configure your build environment visit
|
|
||||||
# http://www.gradle.org/docs/current/userguide/build_environment.html
|
|
||||||
# Specifies the JVM arguments used for the daemon process.
|
|
||||||
# The setting is particularly useful for tweaking memory settings.
|
|
||||||
org.gradle.jvmargs=-Xmx1536m
|
|
||||||
# When configured, Gradle will run in incubating parallel mode.
|
|
||||||
# This option should only be used with decoupled projects. More details, visit
|
|
||||||
# http://www.gradle.org/docs/current/userguide/multi_project_builds.html#sec:decoupled_projects
|
|
||||||
# org.gradle.parallel=true
|
|
||||||
# AndroidX package structure to make it clearer which packages are bundled with the
|
|
||||||
# Android operating system, and which are packaged with your app's APK
|
|
||||||
# https://developer.android.com/topic/libraries/support-library/androidx-rn
|
|
||||||
android.useAndroidX=true
|
|
||||||
# Automatically convert third-party libraries to use AndroidX
|
|
||||||
android.enableJetifier=true
|
|
||||||
# Kotlin code style for this project: "official" or "obsolete":
|
|
||||||
kotlin.code.style=official
|
kotlin.code.style=official
|
||||||
|
# Dokka Gradle Plugin v2 (https://kotl.in/dokka-gradle-migration)
|
||||||
|
org.jetbrains.dokka.experimental.gradle.pluginMode=V2Enabled
|
||||||
|
org.jetbrains.dokka.experimental.gradle.pluginMode.noWarn=true
|
||||||
|
|||||||
24
gradle/libs.versions.toml
Normal file
@@ -0,0 +1,24 @@
|
|||||||
|
[versions]
|
||||||
|
kotlin = "2.1.0"
|
||||||
|
dokka = "2.2.0"
|
||||||
|
mavenPublish = "0.34.0"
|
||||||
|
binaryCompatibilityValidator = "0.16.3"
|
||||||
|
kover = "0.8.3"
|
||||||
|
coroutines = "1.9.0"
|
||||||
|
kotlinxSerialization = "1.7.3"
|
||||||
|
composeMultiplatform = "1.7.3"
|
||||||
|
|
||||||
|
[plugins]
|
||||||
|
kotlinMultiplatform = { id = "org.jetbrains.kotlin.multiplatform", version.ref = "kotlin" }
|
||||||
|
kotlinSerialization = { id = "org.jetbrains.kotlin.plugin.serialization", version.ref = "kotlin" }
|
||||||
|
dokka = { id = "org.jetbrains.dokka", version.ref = "dokka" }
|
||||||
|
mavenPublish = { id = "com.vanniktech.maven.publish", version.ref = "mavenPublish" }
|
||||||
|
binaryCompatibilityValidator = { id = "org.jetbrains.kotlinx.binary-compatibility-validator", version.ref = "binaryCompatibilityValidator" }
|
||||||
|
kover = { id = "org.jetbrains.kotlinx.kover", version.ref = "kover" }
|
||||||
|
composeMultiplatform = { id = "org.jetbrains.compose", version.ref = "composeMultiplatform" }
|
||||||
|
composeCompiler = { id = "org.jetbrains.kotlin.plugin.compose", version.ref = "kotlin" }
|
||||||
|
|
||||||
|
[libraries]
|
||||||
|
kotlinx-coroutines-core = { module = "org.jetbrains.kotlinx:kotlinx-coroutines-core", version.ref = "coroutines" }
|
||||||
|
kotlinx-coroutines-test = { module = "org.jetbrains.kotlinx:kotlinx-coroutines-test", version.ref = "coroutines" }
|
||||||
|
kotlinx-serialization-json = { module = "org.jetbrains.kotlinx:kotlinx-serialization-json", version.ref = "kotlinxSerialization" }
|
||||||
BIN
gradle/wrapper/gradle-wrapper.jar
vendored
5
gradle/wrapper/gradle-wrapper.properties
vendored
@@ -1,6 +1,7 @@
|
|||||||
#Wed Jan 08 12:28:15 CET 2020
|
|
||||||
distributionBase=GRADLE_USER_HOME
|
distributionBase=GRADLE_USER_HOME
|
||||||
distributionPath=wrapper/dists
|
distributionPath=wrapper/dists
|
||||||
|
distributionUrl=https\://services.gradle.org/distributions/gradle-8.5-bin.zip
|
||||||
|
networkTimeout=10000
|
||||||
|
validateDistributionUrl=true
|
||||||
zipStoreBase=GRADLE_USER_HOME
|
zipStoreBase=GRADLE_USER_HOME
|
||||||
zipStorePath=wrapper/dists
|
zipStorePath=wrapper/dists
|
||||||
distributionUrl=https\://services.gradle.org/distributions/gradle-5.4.1-all.zip
|
|
||||||
|
|||||||
309
gradlew
vendored
@@ -1,78 +1,127 @@
|
|||||||
#!/usr/bin/env sh
|
#!/bin/sh
|
||||||
|
|
||||||
|
#
|
||||||
|
# Copyright © 2015-2021 the original authors.
|
||||||
|
#
|
||||||
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
# you may not use this file except in compliance with the License.
|
||||||
|
# You may obtain a copy of the License at
|
||||||
|
#
|
||||||
|
# https://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
#
|
||||||
|
# Unless required by applicable law or agreed to in writing, software
|
||||||
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
# See the License for the specific language governing permissions and
|
||||||
|
# limitations under the License.
|
||||||
|
#
|
||||||
|
|
||||||
##############################################################################
|
##############################################################################
|
||||||
##
|
#
|
||||||
## Gradle start up script for UN*X
|
# Gradle start up script for POSIX generated by Gradle.
|
||||||
##
|
#
|
||||||
|
# Important for running:
|
||||||
|
#
|
||||||
|
# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is
|
||||||
|
# noncompliant, but you have some other compliant shell such as ksh or
|
||||||
|
# bash, then to run this script, type that shell name before the whole
|
||||||
|
# command line, like:
|
||||||
|
#
|
||||||
|
# ksh Gradle
|
||||||
|
#
|
||||||
|
# Busybox and similar reduced shells will NOT work, because this script
|
||||||
|
# requires all of these POSIX shell features:
|
||||||
|
# * functions;
|
||||||
|
# * expansions «$var», «${var}», «${var:-default}», «${var+SET}»,
|
||||||
|
# «${var#prefix}», «${var%suffix}», and «$( cmd )»;
|
||||||
|
# * compound commands having a testable exit status, especially «case»;
|
||||||
|
# * various built-in commands including «command», «set», and «ulimit».
|
||||||
|
#
|
||||||
|
# Important for patching:
|
||||||
|
#
|
||||||
|
# (2) This script targets any POSIX shell, so it avoids extensions provided
|
||||||
|
# by Bash, Ksh, etc; in particular arrays are avoided.
|
||||||
|
#
|
||||||
|
# The "traditional" practice of packing multiple parameters into a
|
||||||
|
# space-separated string is a well documented source of bugs and security
|
||||||
|
# problems, so this is (mostly) avoided, by progressively accumulating
|
||||||
|
# options in "$@", and eventually passing that to Java.
|
||||||
|
#
|
||||||
|
# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS,
|
||||||
|
# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly;
|
||||||
|
# see the in-line comments for details.
|
||||||
|
#
|
||||||
|
# There are tweaks for specific operating systems such as AIX, CygWin,
|
||||||
|
# Darwin, MinGW, and NonStop.
|
||||||
|
#
|
||||||
|
# (3) This script is generated from the Groovy template
|
||||||
|
# https://github.com/gradle/gradle/blob/HEAD/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
|
||||||
|
# within the Gradle project.
|
||||||
|
#
|
||||||
|
# You can find Gradle at https://github.com/gradle/gradle/.
|
||||||
|
#
|
||||||
##############################################################################
|
##############################################################################
|
||||||
|
|
||||||
# Attempt to set APP_HOME
|
# Attempt to set APP_HOME
|
||||||
|
|
||||||
# Resolve links: $0 may be a link
|
# Resolve links: $0 may be a link
|
||||||
PRG="$0"
|
app_path=$0
|
||||||
# Need this for relative symlinks.
|
|
||||||
while [ -h "$PRG" ] ; do
|
# Need this for daisy-chained symlinks.
|
||||||
ls=`ls -ld "$PRG"`
|
while
|
||||||
link=`expr "$ls" : '.*-> \(.*\)$'`
|
APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path
|
||||||
if expr "$link" : '/.*' > /dev/null; then
|
[ -h "$app_path" ]
|
||||||
PRG="$link"
|
do
|
||||||
else
|
ls=$( ls -ld "$app_path" )
|
||||||
PRG=`dirname "$PRG"`"/$link"
|
link=${ls#*' -> '}
|
||||||
fi
|
case $link in #(
|
||||||
|
/*) app_path=$link ;; #(
|
||||||
|
*) app_path=$APP_HOME$link ;;
|
||||||
|
esac
|
||||||
done
|
done
|
||||||
SAVED="`pwd`"
|
|
||||||
cd "`dirname \"$PRG\"`/" >/dev/null
|
|
||||||
APP_HOME="`pwd -P`"
|
|
||||||
cd "$SAVED" >/dev/null
|
|
||||||
|
|
||||||
APP_NAME="Gradle"
|
# This is normally unused
|
||||||
APP_BASE_NAME=`basename "$0"`
|
# shellcheck disable=SC2034
|
||||||
|
APP_BASE_NAME=${0##*/}
|
||||||
# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
|
# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036)
|
||||||
DEFAULT_JVM_OPTS=""
|
APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit
|
||||||
|
|
||||||
# Use the maximum available, or set MAX_FD != -1 to use that value.
|
# Use the maximum available, or set MAX_FD != -1 to use that value.
|
||||||
MAX_FD="maximum"
|
MAX_FD=maximum
|
||||||
|
|
||||||
warn () {
|
warn () {
|
||||||
echo "$*"
|
echo "$*"
|
||||||
}
|
} >&2
|
||||||
|
|
||||||
die () {
|
die () {
|
||||||
echo
|
echo
|
||||||
echo "$*"
|
echo "$*"
|
||||||
echo
|
echo
|
||||||
exit 1
|
exit 1
|
||||||
}
|
} >&2
|
||||||
|
|
||||||
# OS specific support (must be 'true' or 'false').
|
# OS specific support (must be 'true' or 'false').
|
||||||
cygwin=false
|
cygwin=false
|
||||||
msys=false
|
msys=false
|
||||||
darwin=false
|
darwin=false
|
||||||
nonstop=false
|
nonstop=false
|
||||||
case "`uname`" in
|
case "$( uname )" in #(
|
||||||
CYGWIN* )
|
CYGWIN* ) cygwin=true ;; #(
|
||||||
cygwin=true
|
Darwin* ) darwin=true ;; #(
|
||||||
;;
|
MSYS* | MINGW* ) msys=true ;; #(
|
||||||
Darwin* )
|
NONSTOP* ) nonstop=true ;;
|
||||||
darwin=true
|
|
||||||
;;
|
|
||||||
MINGW* )
|
|
||||||
msys=true
|
|
||||||
;;
|
|
||||||
NONSTOP* )
|
|
||||||
nonstop=true
|
|
||||||
;;
|
|
||||||
esac
|
esac
|
||||||
|
|
||||||
CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
|
CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
|
||||||
|
|
||||||
|
|
||||||
# Determine the Java command to use to start the JVM.
|
# Determine the Java command to use to start the JVM.
|
||||||
if [ -n "$JAVA_HOME" ] ; then
|
if [ -n "$JAVA_HOME" ] ; then
|
||||||
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
|
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
|
||||||
# IBM's JDK on AIX uses strange locations for the executables
|
# IBM's JDK on AIX uses strange locations for the executables
|
||||||
JAVACMD="$JAVA_HOME/jre/sh/java"
|
JAVACMD=$JAVA_HOME/jre/sh/java
|
||||||
else
|
else
|
||||||
JAVACMD="$JAVA_HOME/bin/java"
|
JAVACMD=$JAVA_HOME/bin/java
|
||||||
fi
|
fi
|
||||||
if [ ! -x "$JAVACMD" ] ; then
|
if [ ! -x "$JAVACMD" ] ; then
|
||||||
die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
|
die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
|
||||||
@@ -81,92 +130,120 @@ Please set the JAVA_HOME variable in your environment to match the
|
|||||||
location of your Java installation."
|
location of your Java installation."
|
||||||
fi
|
fi
|
||||||
else
|
else
|
||||||
JAVACMD="java"
|
JAVACMD=java
|
||||||
which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
|
if ! command -v java >/dev/null 2>&1
|
||||||
|
then
|
||||||
|
die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
|
||||||
|
|
||||||
Please set the JAVA_HOME variable in your environment to match the
|
Please set the JAVA_HOME variable in your environment to match the
|
||||||
location of your Java installation."
|
location of your Java installation."
|
||||||
fi
|
fi
|
||||||
|
fi
|
||||||
|
|
||||||
# Increase the maximum file descriptors if we can.
|
# Increase the maximum file descriptors if we can.
|
||||||
if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
|
if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
|
||||||
MAX_FD_LIMIT=`ulimit -H -n`
|
case $MAX_FD in #(
|
||||||
if [ $? -eq 0 ] ; then
|
max*)
|
||||||
if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
|
# In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked.
|
||||||
MAX_FD="$MAX_FD_LIMIT"
|
# shellcheck disable=SC2039,SC3045
|
||||||
fi
|
MAX_FD=$( ulimit -H -n ) ||
|
||||||
ulimit -n $MAX_FD
|
warn "Could not query maximum file descriptor limit"
|
||||||
if [ $? -ne 0 ] ; then
|
esac
|
||||||
warn "Could not set maximum file descriptor limit: $MAX_FD"
|
case $MAX_FD in #(
|
||||||
fi
|
'' | soft) :;; #(
|
||||||
else
|
*)
|
||||||
warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
|
# In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked.
|
||||||
fi
|
# shellcheck disable=SC2039,SC3045
|
||||||
fi
|
ulimit -n "$MAX_FD" ||
|
||||||
|
warn "Could not set maximum file descriptor limit to $MAX_FD"
|
||||||
# For Darwin, add options to specify how the application appears in the dock
|
|
||||||
if $darwin; then
|
|
||||||
GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
|
|
||||||
fi
|
|
||||||
|
|
||||||
# For Cygwin, switch paths to Windows format before running java
|
|
||||||
if $cygwin ; then
|
|
||||||
APP_HOME=`cygpath --path --mixed "$APP_HOME"`
|
|
||||||
CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
|
|
||||||
JAVACMD=`cygpath --unix "$JAVACMD"`
|
|
||||||
|
|
||||||
# We build the pattern for arguments to be converted via cygpath
|
|
||||||
ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
|
|
||||||
SEP=""
|
|
||||||
for dir in $ROOTDIRSRAW ; do
|
|
||||||
ROOTDIRS="$ROOTDIRS$SEP$dir"
|
|
||||||
SEP="|"
|
|
||||||
done
|
|
||||||
OURCYGPATTERN="(^($ROOTDIRS))"
|
|
||||||
# Add a user-defined pattern to the cygpath arguments
|
|
||||||
if [ "$GRADLE_CYGPATTERN" != "" ] ; then
|
|
||||||
OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
|
|
||||||
fi
|
|
||||||
# Now convert the arguments - kludge to limit ourselves to /bin/sh
|
|
||||||
i=0
|
|
||||||
for arg in "$@" ; do
|
|
||||||
CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
|
|
||||||
CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option
|
|
||||||
|
|
||||||
if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition
|
|
||||||
eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
|
|
||||||
else
|
|
||||||
eval `echo args$i`="\"$arg\""
|
|
||||||
fi
|
|
||||||
i=$((i+1))
|
|
||||||
done
|
|
||||||
case $i in
|
|
||||||
(0) set -- ;;
|
|
||||||
(1) set -- "$args0" ;;
|
|
||||||
(2) set -- "$args0" "$args1" ;;
|
|
||||||
(3) set -- "$args0" "$args1" "$args2" ;;
|
|
||||||
(4) set -- "$args0" "$args1" "$args2" "$args3" ;;
|
|
||||||
(5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
|
|
||||||
(6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
|
|
||||||
(7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
|
|
||||||
(8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
|
|
||||||
(9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
|
|
||||||
esac
|
esac
|
||||||
fi
|
fi
|
||||||
|
|
||||||
# Escape application args
|
# Collect all arguments for the java command, stacking in reverse order:
|
||||||
save () {
|
# * args from the command line
|
||||||
for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
|
# * the main class name
|
||||||
echo " "
|
# * -classpath
|
||||||
}
|
# * -D...appname settings
|
||||||
APP_ARGS=$(save "$@")
|
# * --module-path (only if needed)
|
||||||
|
# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables.
|
||||||
|
|
||||||
# Collect all arguments for the java command, following the shell quoting and substitution rules
|
# For Cygwin or MSYS, switch paths to Windows format before running java
|
||||||
eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
|
if "$cygwin" || "$msys" ; then
|
||||||
|
APP_HOME=$( cygpath --path --mixed "$APP_HOME" )
|
||||||
|
CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" )
|
||||||
|
|
||||||
# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong
|
JAVACMD=$( cygpath --unix "$JAVACMD" )
|
||||||
if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then
|
|
||||||
cd "$(dirname "$0")"
|
# Now convert the arguments - kludge to limit ourselves to /bin/sh
|
||||||
|
for arg do
|
||||||
|
if
|
||||||
|
case $arg in #(
|
||||||
|
-*) false ;; # don't mess with options #(
|
||||||
|
/?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath
|
||||||
|
[ -e "$t" ] ;; #(
|
||||||
|
*) false ;;
|
||||||
|
esac
|
||||||
|
then
|
||||||
|
arg=$( cygpath --path --ignore --mixed "$arg" )
|
||||||
|
fi
|
||||||
|
# Roll the args list around exactly as many times as the number of
|
||||||
|
# args, so each arg winds up back in the position where it started, but
|
||||||
|
# possibly modified.
|
||||||
|
#
|
||||||
|
# NB: a `for` loop captures its iteration list before it begins, so
|
||||||
|
# changing the positional parameters here affects neither the number of
|
||||||
|
# iterations, nor the values presented in `arg`.
|
||||||
|
shift # remove old arg
|
||||||
|
set -- "$@" "$arg" # push replacement arg
|
||||||
|
done
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
|
||||||
|
# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
|
||||||
|
DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
|
||||||
|
|
||||||
|
# Collect all arguments for the java command:
|
||||||
|
# * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments,
|
||||||
|
# and any embedded shellness will be escaped.
|
||||||
|
# * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be
|
||||||
|
# treated as '${Hostname}' itself on the command line.
|
||||||
|
|
||||||
|
set -- \
|
||||||
|
"-Dorg.gradle.appname=$APP_BASE_NAME" \
|
||||||
|
-classpath "$CLASSPATH" \
|
||||||
|
org.gradle.wrapper.GradleWrapperMain \
|
||||||
|
"$@"
|
||||||
|
|
||||||
|
# Stop when "xargs" is not available.
|
||||||
|
if ! command -v xargs >/dev/null 2>&1
|
||||||
|
then
|
||||||
|
die "xargs is not available"
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Use "xargs" to parse quoted args.
|
||||||
|
#
|
||||||
|
# With -n1 it outputs one arg per line, with the quotes and backslashes removed.
|
||||||
|
#
|
||||||
|
# In Bash we could simply go:
|
||||||
|
#
|
||||||
|
# readarray ARGS < <( xargs -n1 <<<"$var" ) &&
|
||||||
|
# set -- "${ARGS[@]}" "$@"
|
||||||
|
#
|
||||||
|
# but POSIX shell has neither arrays nor command substitution, so instead we
|
||||||
|
# post-process each arg (as a line of input to sed) to backslash-escape any
|
||||||
|
# character that might be a shell metacharacter, then use eval to reverse
|
||||||
|
# that process (while maintaining the separation between arguments), and wrap
|
||||||
|
# the whole thing up as a single "set" statement.
|
||||||
|
#
|
||||||
|
# This will of course break if any of these variables contains a newline or
|
||||||
|
# an unmatched quote.
|
||||||
|
#
|
||||||
|
|
||||||
|
eval "set -- $(
|
||||||
|
printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" |
|
||||||
|
xargs -n1 |
|
||||||
|
sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' |
|
||||||
|
tr '\n' ' '
|
||||||
|
)" '"$@"'
|
||||||
|
|
||||||
exec "$JAVACMD" "$@"
|
exec "$JAVACMD" "$@"
|
||||||
|
|||||||
52
gradlew.bat
vendored
@@ -1,3 +1,19 @@
|
|||||||
|
@rem
|
||||||
|
@rem Copyright 2015 the original author or authors.
|
||||||
|
@rem
|
||||||
|
@rem Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
@rem you may not use this file except in compliance with the License.
|
||||||
|
@rem You may obtain a copy of the License at
|
||||||
|
@rem
|
||||||
|
@rem https://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
@rem
|
||||||
|
@rem Unless required by applicable law or agreed to in writing, software
|
||||||
|
@rem distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
@rem See the License for the specific language governing permissions and
|
||||||
|
@rem limitations under the License.
|
||||||
|
@rem
|
||||||
|
|
||||||
@if "%DEBUG%"=="" @echo off
|
@if "%DEBUG%"=="" @echo off
|
||||||
@rem ##########################################################################
|
@rem ##########################################################################
|
||||||
@rem
|
@rem
|
||||||
@@ -10,18 +26,22 @@ if "%OS%"=="Windows_NT" setlocal
|
|||||||
|
|
||||||
set DIRNAME=%~dp0
|
set DIRNAME=%~dp0
|
||||||
if "%DIRNAME%"=="" set DIRNAME=.
|
if "%DIRNAME%"=="" set DIRNAME=.
|
||||||
|
@rem This is normally unused
|
||||||
set APP_BASE_NAME=%~n0
|
set APP_BASE_NAME=%~n0
|
||||||
set APP_HOME=%DIRNAME%
|
set APP_HOME=%DIRNAME%
|
||||||
|
|
||||||
|
@rem Resolve any "." and ".." in APP_HOME to make it shorter.
|
||||||
|
for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi
|
||||||
|
|
||||||
@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
|
@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
|
||||||
set DEFAULT_JVM_OPTS=
|
set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m"
|
||||||
|
|
||||||
@rem Find java.exe
|
@rem Find java.exe
|
||||||
if defined JAVA_HOME goto findJavaFromJavaHome
|
if defined JAVA_HOME goto findJavaFromJavaHome
|
||||||
|
|
||||||
set JAVA_EXE=java.exe
|
set JAVA_EXE=java.exe
|
||||||
%JAVA_EXE% -version >NUL 2>&1
|
%JAVA_EXE% -version >NUL 2>&1
|
||||||
if "%ERRORLEVEL%" == "0" goto init
|
if %ERRORLEVEL% equ 0 goto execute
|
||||||
|
|
||||||
echo.
|
echo.
|
||||||
echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
|
echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
|
||||||
@@ -35,7 +55,7 @@ goto fail
|
|||||||
set JAVA_HOME=%JAVA_HOME:"=%
|
set JAVA_HOME=%JAVA_HOME:"=%
|
||||||
set JAVA_EXE=%JAVA_HOME%/bin/java.exe
|
set JAVA_EXE=%JAVA_HOME%/bin/java.exe
|
||||||
|
|
||||||
if exist "%JAVA_EXE%" goto init
|
if exist "%JAVA_EXE%" goto execute
|
||||||
|
|
||||||
echo.
|
echo.
|
||||||
echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
|
echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
|
||||||
@@ -45,38 +65,26 @@ echo location of your Java installation.
|
|||||||
|
|
||||||
goto fail
|
goto fail
|
||||||
|
|
||||||
:init
|
|
||||||
@rem Get command-line arguments, handling Windows variants
|
|
||||||
|
|
||||||
if not "%OS%" == "Windows_NT" goto win9xME_args
|
|
||||||
|
|
||||||
:win9xME_args
|
|
||||||
@rem Slurp the command line arguments.
|
|
||||||
set CMD_LINE_ARGS=
|
|
||||||
set _SKIP=2
|
|
||||||
|
|
||||||
:win9xME_args_slurp
|
|
||||||
if "x%~1" == "x" goto execute
|
|
||||||
|
|
||||||
set CMD_LINE_ARGS=%*
|
|
||||||
|
|
||||||
:execute
|
:execute
|
||||||
@rem Setup the command line
|
@rem Setup the command line
|
||||||
|
|
||||||
set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
|
set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
|
||||||
|
|
||||||
|
|
||||||
@rem Execute Gradle
|
@rem Execute Gradle
|
||||||
"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS%
|
"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %*
|
||||||
|
|
||||||
:end
|
:end
|
||||||
@rem End local scope for the variables with windows NT shell
|
@rem End local scope for the variables with windows NT shell
|
||||||
if "%ERRORLEVEL%"=="0" goto mainEnd
|
if %ERRORLEVEL% equ 0 goto mainEnd
|
||||||
|
|
||||||
:fail
|
:fail
|
||||||
rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
|
rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
|
||||||
rem the _cmd.exe /c_ return code!
|
rem the _cmd.exe /c_ return code!
|
||||||
if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1
|
set EXIT_CODE=%ERRORLEVEL%
|
||||||
exit /b 1
|
if %EXIT_CODE% equ 0 set EXIT_CODE=1
|
||||||
|
if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE%
|
||||||
|
exit /b %EXIT_CODE%
|
||||||
|
|
||||||
:mainEnd
|
:mainEnd
|
||||||
if "%OS%"=="Windows_NT" endlocal
|
if "%OS%"=="Windows_NT" endlocal
|
||||||
|
|||||||
|
Before Width: | Height: | Size: 71 KiB |
1999
kotlin-js-store/yarn.lock
Normal file
@@ -1,122 +0,0 @@
|
|||||||
task androidSourcesJar(type: Jar) {
|
|
||||||
archiveClassifier.set("sources")
|
|
||||||
from android.sourceSets.main.java.source
|
|
||||||
}
|
|
||||||
|
|
||||||
artifacts {
|
|
||||||
archives androidSourcesJar
|
|
||||||
}
|
|
||||||
|
|
||||||
apply plugin: 'maven-publish'
|
|
||||||
apply plugin: 'signing'
|
|
||||||
|
|
||||||
group = PUBLISH_GROUP_ID
|
|
||||||
version = PUBLISH_VERSION
|
|
||||||
|
|
||||||
ext["signing.keyId"] = ''
|
|
||||||
ext["signing.password"] = ''
|
|
||||||
ext["signing.secretKeyRingFile"] = ''
|
|
||||||
ext["ossrhUsername"] = ''
|
|
||||||
ext["ossrhPassword"] = ''
|
|
||||||
|
|
||||||
File secretPropsFile = project.rootProject.file('local.properties')
|
|
||||||
if (secretPropsFile.exists()) {
|
|
||||||
println "Found secret props file, loading props"
|
|
||||||
Properties p = new Properties()
|
|
||||||
p.load(new FileInputStream(secretPropsFile))
|
|
||||||
p.each { name, value ->
|
|
||||||
ext[name] = value
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
println "No props file, loading env vars"
|
|
||||||
ext["signing.keyId"] = System.getenv('SIGNING_KEY_ID')
|
|
||||||
ext["signing.password"] = System.getenv('SIGNING_PASSWORD')
|
|
||||||
ext["signing.secretKeyRingFile"] = System.getenv('SIGNING_SECRET_KEY_RING_FILE')
|
|
||||||
ext["ossrhUsername"] = System.getenv('OSSRH_USERNAME')
|
|
||||||
ext["ossrhPassword"] = System.getenv('OSSRH_PASSWORD')
|
|
||||||
}
|
|
||||||
|
|
||||||
nexusStaging {
|
|
||||||
packageGroup = PUBLISH_GROUP_ID
|
|
||||||
stagingProfileId = '2097bad464f778'
|
|
||||||
username = ossrhUsername
|
|
||||||
password = ossrhPassword
|
|
||||||
}
|
|
||||||
|
|
||||||
publishing {
|
|
||||||
publications {
|
|
||||||
release(MavenPublication) {
|
|
||||||
// The coordinates of the library, being set from variables that
|
|
||||||
// we'll set up in a moment
|
|
||||||
groupId PUBLISH_GROUP_ID
|
|
||||||
artifactId PUBLISH_ARTIFACT_ID
|
|
||||||
version PUBLISH_VERSION
|
|
||||||
|
|
||||||
// Two artifacts, the `aar` and the sources
|
|
||||||
artifact("$buildDir/outputs/aar/${project.getName()}-release.aar")
|
|
||||||
artifact androidSourcesJar
|
|
||||||
|
|
||||||
// Self-explanatory metadata for the most part
|
|
||||||
pom {
|
|
||||||
name = PUBLISH_ARTIFACT_ID
|
|
||||||
description = 'Simple implementation to store object in tree structure.'
|
|
||||||
// If your project has a dedicated site, use its URL here
|
|
||||||
url = 'https://github.com/AdrianKuta/Tree-Data-Structure'
|
|
||||||
licenses {
|
|
||||||
license {
|
|
||||||
name = 'MIT License'
|
|
||||||
url = 'https://www.mit.edu/~amini/LICENSE.md'
|
|
||||||
}
|
|
||||||
}
|
|
||||||
developers {
|
|
||||||
developer {
|
|
||||||
name = 'Adrian Kuta'
|
|
||||||
email = 'adrian.kuta93@gmail.com'
|
|
||||||
}
|
|
||||||
}
|
|
||||||
// Version control info, if you're using GitHub, follow the format as seen here
|
|
||||||
scm {
|
|
||||||
connection = 'scm:git:github.com/AdrianKuta/Tree-Data-Structure.git'
|
|
||||||
developerConnection = 'scm:git:ssh://github.com/AdrianKuta/Tree-Data-Structure.git'
|
|
||||||
url = 'https://github.com/AdrianKuta/Tree-Data-Structure/tree/master'
|
|
||||||
}
|
|
||||||
// A slightly hacky fix so that your POM will include any transitive dependencies
|
|
||||||
// that your library builds upon
|
|
||||||
withXml {
|
|
||||||
def dependenciesNode = asNode().appendNode('dependencies')
|
|
||||||
|
|
||||||
project.configurations.implementation.allDependencies.each {
|
|
||||||
def dependencyNode = dependenciesNode.appendNode('dependency')
|
|
||||||
dependencyNode.appendNode('groupId', it.group)
|
|
||||||
dependencyNode.appendNode('artifactId', it.name)
|
|
||||||
dependencyNode.appendNode('version', it.version)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
repositories {
|
|
||||||
// The repository to publish to, Sonatype/MavenCentral
|
|
||||||
maven {
|
|
||||||
// This is an arbitrary name, you may also use "mavencentral" or
|
|
||||||
// any other name that's descriptive for you
|
|
||||||
name = "sonatype"
|
|
||||||
|
|
||||||
def releasesRepoUrl = "https://oss.sonatype.org/service/local/staging/deploy/maven2/"
|
|
||||||
def snapshotsRepoUrl = "https://oss.sonatype.org/content/repositories/snapshots/"
|
|
||||||
// You only need this if you want to publish snapshots, otherwise just set the URL
|
|
||||||
// to the release repo directly
|
|
||||||
url = version.endsWith('SNAPSHOT') ? snapshotsRepoUrl : releasesRepoUrl
|
|
||||||
|
|
||||||
// The username and password we've fetched earlier
|
|
||||||
credentials {
|
|
||||||
username ossrhUsername
|
|
||||||
password ossrhPassword
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
signing {
|
|
||||||
sign publishing.publications
|
|
||||||
}
|
|
||||||
@@ -1,2 +0,0 @@
|
|||||||
include ':app', ':treedatastructure'
|
|
||||||
rootProject.name='Tree Data Structure'
|
|
||||||
5
settings.gradle.kts
Normal file
@@ -0,0 +1,5 @@
|
|||||||
|
rootProject.name = "tree-structure"
|
||||||
|
|
||||||
|
include(":tree-structure-serialization")
|
||||||
|
include(":tree-structure-coroutines")
|
||||||
|
include(":tree-structure-compose")
|
||||||
@@ -0,0 +1,24 @@
|
|||||||
|
package com.github.adriankuta.datastructure.tree
|
||||||
|
|
||||||
|
import kotlin.jvm.JvmSynthetic
|
||||||
|
|
||||||
|
public interface ChildDeclarationInterface<T> {
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This method is used to easily create child in node.
|
||||||
|
* ```
|
||||||
|
* val root = tree("World") {
|
||||||
|
* child("North America") {
|
||||||
|
* child("USA")
|
||||||
|
* }
|
||||||
|
* child("Europe") {
|
||||||
|
* child("Poland")
|
||||||
|
* child("Germany")
|
||||||
|
* }
|
||||||
|
* }
|
||||||
|
* ```
|
||||||
|
* @return New created TreeNode.
|
||||||
|
*/
|
||||||
|
@JvmSynthetic
|
||||||
|
public fun child(value: T, childDeclaration: ChildDeclaration<T>? = null): TreeNode<T>
|
||||||
|
}
|
||||||
@@ -0,0 +1,247 @@
|
|||||||
|
package com.github.adriankuta.datastructure.tree
|
||||||
|
|
||||||
|
import com.github.adriankuta.datastructure.tree.exceptions.TreeNodeException
|
||||||
|
import com.github.adriankuta.datastructure.tree.iterators.LevelOrderTreeIterator
|
||||||
|
import com.github.adriankuta.datastructure.tree.iterators.PostOrderTreeIterator
|
||||||
|
import com.github.adriankuta.datastructure.tree.iterators.PreOrderTreeIterator
|
||||||
|
import com.github.adriankuta.datastructure.tree.iterators.TreeNodeIterators
|
||||||
|
import com.github.adriankuta.datastructure.tree.iterators.TreeNodeIterators.*
|
||||||
|
import kotlin.jvm.JvmSynthetic
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A node in a generic, mutable n-ary tree. Each node holds a [value], a reference to its [parent]
|
||||||
|
* and an ordered list of [children].
|
||||||
|
*
|
||||||
|
* Iterating a node (via [iterator], or the lazy [asSequence]/[preOrderSequence] extensions) visits
|
||||||
|
* the node and all of its descendants. Traversal and the [height]/[nodeCount]/[clear] helpers are
|
||||||
|
* implemented iteratively, so they are safe on arbitrarily deep trees.
|
||||||
|
*
|
||||||
|
* **Not thread-safe.** Nodes are mutable ([addChild]/[removeChild]/[clear] mutate the structure and
|
||||||
|
* parent pointers). Sharing a tree across threads requires external synchronization, and the tree
|
||||||
|
* must not be modified while it is being iterated.
|
||||||
|
*
|
||||||
|
* Equality is by reference (identity); use the `structurallyEquals` extension to compare two trees
|
||||||
|
* by value and shape.
|
||||||
|
*
|
||||||
|
* @param value the value stored in this node.
|
||||||
|
* @param treeIterator the default traversal order used by [iterator]. Prefer the
|
||||||
|
* `asSequence(order)` / `preOrderSequence()` extensions to choose an order without mutating state.
|
||||||
|
*/
|
||||||
|
public open class TreeNode<T>(public val value: T, public val treeIterator: TreeNodeIterators = PreOrder) : Iterable<TreeNode<T>>, ChildDeclarationInterface<T> {
|
||||||
|
|
||||||
|
private var _parent: TreeNode<T>? = null
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The converse notion of a child, an immediate ancestor.
|
||||||
|
*/
|
||||||
|
public val parent: TreeNode<T>?
|
||||||
|
get() = _parent
|
||||||
|
|
||||||
|
private val _children = mutableListOf<TreeNode<T>>()
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A group of nodes with the same parent.
|
||||||
|
*/
|
||||||
|
public val children: List<TreeNode<T>>
|
||||||
|
get() = _children
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Checks whether the current tree node is the root of the tree
|
||||||
|
* @return `true` if the current tree node is root of the tree, `false` otherwise.
|
||||||
|
*/
|
||||||
|
public val isRoot: Boolean
|
||||||
|
get() = _parent == null
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Adds [child] as a direct child of this node.
|
||||||
|
*
|
||||||
|
* @param child a node that is not already attached to a tree. To move a node that already has a
|
||||||
|
* parent, call [detach] on it first.
|
||||||
|
* @throws TreeNodeException if [child] already has a parent, or if attaching it here would create
|
||||||
|
* a cycle (i.e. [child] is this node or one of its ancestors).
|
||||||
|
*/
|
||||||
|
public fun addChild(child: TreeNode<T>) {
|
||||||
|
if (child._parent != null) {
|
||||||
|
throw TreeNodeException("$child already has a parent; call detach() before re-attaching it.")
|
||||||
|
}
|
||||||
|
if (child === this) {
|
||||||
|
throw TreeNodeException("Adding $child here would create a cycle.")
|
||||||
|
}
|
||||||
|
// Only a node that already has its own subtree can contain `this` and thus form a cycle.
|
||||||
|
// Skipping this walk for leaves keeps building deep trees O(n) instead of O(n²).
|
||||||
|
if (child._children.isNotEmpty()) {
|
||||||
|
var ancestor: TreeNode<T>? = _parent
|
||||||
|
while (ancestor != null) {
|
||||||
|
if (ancestor === child) {
|
||||||
|
throw TreeNodeException("Adding $child here would create a cycle.")
|
||||||
|
}
|
||||||
|
ancestor = ancestor._parent
|
||||||
|
}
|
||||||
|
}
|
||||||
|
child._parent = this
|
||||||
|
_children.add(child)
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Detaches this node from its parent, removing it from the parent's [children].
|
||||||
|
*
|
||||||
|
* @return `true` if this node was attached and is now detached; `false` if it was already a root.
|
||||||
|
*/
|
||||||
|
public fun detach(): Boolean {
|
||||||
|
val currentParent = _parent ?: return false
|
||||||
|
currentParent._children.remove(this)
|
||||||
|
_parent = null
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
@JvmSynthetic
|
||||||
|
public override fun child(value: T, childDeclaration: ChildDeclaration<T>?): TreeNode<T> {
|
||||||
|
val newChild = TreeNode(value)
|
||||||
|
newChild._parent = this
|
||||||
|
if (childDeclaration != null)
|
||||||
|
newChild.childDeclaration()
|
||||||
|
_children.add(newChild)
|
||||||
|
return newChild
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Removes [child] from this node's direct [children], if present.
|
||||||
|
*
|
||||||
|
* This only removes a *direct* child of the receiver; it does not reach into other nodes. To
|
||||||
|
* remove a node from wherever it currently lives, call [detach] on it instead.
|
||||||
|
*
|
||||||
|
* @return `true` if [child] was a direct child and has been removed; `false` otherwise.
|
||||||
|
*/
|
||||||
|
public fun removeChild(child: TreeNode<T>): Boolean {
|
||||||
|
val removed = _children.remove(child)
|
||||||
|
if (removed) child._parent = null
|
||||||
|
return removed
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This function go through tree and counts children. Root element is not counted.
|
||||||
|
* @return All child and nested child count.
|
||||||
|
*/
|
||||||
|
public fun nodeCount(): Int {
|
||||||
|
var count = 0
|
||||||
|
val stack = ArrayDeque<TreeNode<T>>()
|
||||||
|
stack.addAll(_children)
|
||||||
|
while (stack.isNotEmpty()) {
|
||||||
|
val node = stack.removeLast()
|
||||||
|
count++
|
||||||
|
stack.addAll(node._children)
|
||||||
|
}
|
||||||
|
return count
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @return The number of edges on the longest path between current node and a descendant leaf.
|
||||||
|
*/
|
||||||
|
public fun height(): Int {
|
||||||
|
var maxDepth = 0
|
||||||
|
val stack = ArrayDeque<Pair<TreeNode<T>, Int>>()
|
||||||
|
stack.addLast(this to 0)
|
||||||
|
while (stack.isNotEmpty()) {
|
||||||
|
val (node, depthSoFar) = stack.removeLast()
|
||||||
|
if (depthSoFar > maxDepth) maxDepth = depthSoFar
|
||||||
|
node._children.forEach { stack.addLast(it to depthSoFar + 1) }
|
||||||
|
}
|
||||||
|
return maxDepth
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Distance is the number of edges along the shortest path between two nodes.
|
||||||
|
* @return The distance between current node and the root.
|
||||||
|
*/
|
||||||
|
public fun depth(): Int {
|
||||||
|
var depth = 0
|
||||||
|
var tempParent = parent
|
||||||
|
|
||||||
|
while (tempParent != null) {
|
||||||
|
depth++
|
||||||
|
tempParent = tempParent.parent
|
||||||
|
}
|
||||||
|
return depth
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns the chain of nodes from [descendant] up to and including this node, or `null` if
|
||||||
|
* [descendant] is not a strict descendant of this node.
|
||||||
|
*
|
||||||
|
* @param descendant the node to walk up from.
|
||||||
|
* @return the path `[descendant, …, this]`, or `null` if [descendant] is the root or is not
|
||||||
|
* located in this node's subtree.
|
||||||
|
*/
|
||||||
|
public fun path(descendant: TreeNode<T>): List<TreeNode<T>>? {
|
||||||
|
if (descendant.isRoot) return null
|
||||||
|
val path = mutableListOf<TreeNode<T>>()
|
||||||
|
var node = descendant
|
||||||
|
path.add(node)
|
||||||
|
while (!node.isRoot) {
|
||||||
|
node = node.parent!!
|
||||||
|
path.add(node)
|
||||||
|
if (node == this) return path
|
||||||
|
}
|
||||||
|
return null
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Removes every descendant of this node. Afterwards [children] is empty and all former
|
||||||
|
* descendants are detached (their parent is `null`). This node itself stays attached to its own
|
||||||
|
* parent.
|
||||||
|
*/
|
||||||
|
public fun clear() {
|
||||||
|
val descendants = ArrayDeque<TreeNode<T>>()
|
||||||
|
val stack = ArrayDeque<TreeNode<T>>()
|
||||||
|
stack.addAll(_children)
|
||||||
|
while (stack.isNotEmpty()) {
|
||||||
|
val node = stack.removeLast()
|
||||||
|
descendants.addLast(node)
|
||||||
|
stack.addAll(node._children)
|
||||||
|
}
|
||||||
|
descendants.forEach { node ->
|
||||||
|
node._parent = null
|
||||||
|
node._children.clear()
|
||||||
|
}
|
||||||
|
_children.clear()
|
||||||
|
}
|
||||||
|
|
||||||
|
public override fun toString(): String {
|
||||||
|
return value.toString()
|
||||||
|
}
|
||||||
|
|
||||||
|
public fun prettyString(): String {
|
||||||
|
val stringBuilder = StringBuilder()
|
||||||
|
print(stringBuilder, "", "")
|
||||||
|
return stringBuilder.toString()
|
||||||
|
}
|
||||||
|
|
||||||
|
private fun print(stringBuilder: StringBuilder, prefix: String, childrenPrefix: String) {
|
||||||
|
stringBuilder.append(prefix)
|
||||||
|
stringBuilder.append(value)
|
||||||
|
stringBuilder.append('\n')
|
||||||
|
val childIterator = _children.iterator()
|
||||||
|
while (childIterator.hasNext()) {
|
||||||
|
val node = childIterator.next()
|
||||||
|
if (childIterator.hasNext()) {
|
||||||
|
node.print(stringBuilder, "$childrenPrefix├── ", "$childrenPrefix│ ")
|
||||||
|
} else {
|
||||||
|
node.print(stringBuilder, "$childrenPrefix└── ", "$childrenPrefix ")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns an iterator over this node and its descendants using the default [treeIterator] order.
|
||||||
|
* Use [iterator] with an explicit order, or the `asSequence(order)` extension, to traverse in a
|
||||||
|
* different order without changing this node's default.
|
||||||
|
*/
|
||||||
|
public override fun iterator(): Iterator<TreeNode<T>> = iterator(treeIterator)
|
||||||
|
|
||||||
|
/** Returns an iterator over this node and its descendants in the given [order]. */
|
||||||
|
public fun iterator(order: TreeNodeIterators): Iterator<TreeNode<T>> = when (order) {
|
||||||
|
PreOrder -> PreOrderTreeIterator(this)
|
||||||
|
PostOrder -> PostOrderTreeIterator(this)
|
||||||
|
LevelOrder -> LevelOrderTreeIterator(this)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,25 @@
|
|||||||
|
package com.github.adriankuta.datastructure.tree
|
||||||
|
|
||||||
|
import com.github.adriankuta.datastructure.tree.iterators.TreeNodeIterators
|
||||||
|
import kotlin.jvm.JvmSynthetic
|
||||||
|
|
||||||
|
public typealias ChildDeclaration<T> = ChildDeclarationInterface<T>.() -> Unit
|
||||||
|
|
||||||
|
/**
|
||||||
|
* This method can be used to initialize new tree.
|
||||||
|
* ```
|
||||||
|
* val root = tree("World") { ... }
|
||||||
|
* ```
|
||||||
|
* @param root Root element of new tree.
|
||||||
|
* @see [ChildDeclarationInterface.child]
|
||||||
|
*/
|
||||||
|
@JvmSynthetic
|
||||||
|
public inline fun <reified T> tree(
|
||||||
|
root: T,
|
||||||
|
defaultIterator: TreeNodeIterators = TreeNodeIterators.PreOrder,
|
||||||
|
childDeclaration: ChildDeclaration<T>
|
||||||
|
): TreeNode<T> {
|
||||||
|
val treeNode = TreeNode(root, defaultIterator)
|
||||||
|
treeNode.childDeclaration()
|
||||||
|
return treeNode
|
||||||
|
}
|
||||||
@@ -0,0 +1,65 @@
|
|||||||
|
package com.github.adriankuta.datastructure.tree
|
||||||
|
|
||||||
|
/** Returns the first node (pre-order) whose value matches [predicate], or `null`. Short-circuits. */
|
||||||
|
public fun <T> TreeNode<T>.findNode(predicate: (T) -> Boolean): TreeNode<T>? =
|
||||||
|
preOrderSequence().firstOrNull { predicate(it.value) }
|
||||||
|
|
||||||
|
/** All nodes (pre-order) whose value matches [predicate]. */
|
||||||
|
public fun <T> TreeNode<T>.filterNodes(predicate: (T) -> Boolean): List<TreeNode<T>> =
|
||||||
|
preOrderSequence().filter { predicate(it.value) }.toList()
|
||||||
|
|
||||||
|
/** `true` if any node's value matches [predicate]. Short-circuits. */
|
||||||
|
public fun <T> TreeNode<T>.anyNode(predicate: (T) -> Boolean): Boolean =
|
||||||
|
preOrderSequence().any { predicate(it.value) }
|
||||||
|
|
||||||
|
/** `true` if every node's value matches [predicate]. Short-circuits. */
|
||||||
|
public fun <T> TreeNode<T>.allNodes(predicate: (T) -> Boolean): Boolean =
|
||||||
|
preOrderSequence().all { predicate(it.value) }
|
||||||
|
|
||||||
|
/** Counts nodes whose value matches [predicate]. */
|
||||||
|
public fun <T> TreeNode<T>.countNodes(predicate: (T) -> Boolean): Int =
|
||||||
|
preOrderSequence().count { predicate(it.value) }
|
||||||
|
|
||||||
|
/** Folds [operation] over all nodes in pre-order, starting from [initial]. */
|
||||||
|
public fun <T, R> TreeNode<T>.foldNodes(initial: R, operation: (acc: R, node: TreeNode<T>) -> R): R =
|
||||||
|
preOrderSequence().fold(initial) { acc, node -> operation(acc, node) }
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns a new tree with the same shape whose values are produced by [transform]. The original is
|
||||||
|
* left untouched. Stack-safe (iterative), so it handles arbitrarily deep trees.
|
||||||
|
*/
|
||||||
|
public fun <T, R> TreeNode<T>.mapValues(transform: (T) -> R): TreeNode<R> {
|
||||||
|
val newRoot = TreeNode(transform(value), treeIterator)
|
||||||
|
val stack = ArrayDeque<Pair<TreeNode<T>, TreeNode<R>>>()
|
||||||
|
stack.addLast(this to newRoot)
|
||||||
|
while (stack.isNotEmpty()) {
|
||||||
|
val (source, target) = stack.removeLast()
|
||||||
|
source.children.forEach { child ->
|
||||||
|
val mappedChild = TreeNode(transform(child.value), child.treeIterator)
|
||||||
|
target.addChild(mappedChild)
|
||||||
|
stack.addLast(child to mappedChild)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return newRoot
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Returns an independent deep copy of this subtree (same values, same shape, new nodes). */
|
||||||
|
public fun <T> TreeNode<T>.deepCopy(): TreeNode<T> = mapValues { it }
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Structural equality: `true` when [other] holds the same values in the same shape. Unlike
|
||||||
|
* [TreeNode]'s reference equality, this compares the entire subtree. Stack-safe.
|
||||||
|
*/
|
||||||
|
public fun <T> TreeNode<T>.structurallyEquals(other: TreeNode<T>): Boolean {
|
||||||
|
val stack = ArrayDeque<Pair<TreeNode<T>, TreeNode<T>>>()
|
||||||
|
stack.addLast(this to other)
|
||||||
|
while (stack.isNotEmpty()) {
|
||||||
|
val (a, b) = stack.removeLast()
|
||||||
|
if (a.value != b.value) return false
|
||||||
|
if (a.children.size != b.children.size) return false
|
||||||
|
for (i in a.children.indices) {
|
||||||
|
stack.addLast(a.children[i] to b.children[i])
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return true
|
||||||
|
}
|
||||||
@@ -0,0 +1,41 @@
|
|||||||
|
package com.github.adriankuta.datastructure.tree
|
||||||
|
|
||||||
|
/** `true` when this node has no children. */
|
||||||
|
public val <T> TreeNode<T>.isLeaf: Boolean get() = children.isEmpty()
|
||||||
|
|
||||||
|
/** The number of direct children of this node. */
|
||||||
|
public val <T> TreeNode<T>.degree: Int get() = children.size
|
||||||
|
|
||||||
|
/** Walks up the parent chain and returns the topmost ancestor (the tree root). */
|
||||||
|
public fun <T> TreeNode<T>.root(): TreeNode<T> {
|
||||||
|
var node = this
|
||||||
|
var parent = node.parent
|
||||||
|
while (parent != null) {
|
||||||
|
node = parent
|
||||||
|
parent = node.parent
|
||||||
|
}
|
||||||
|
return node
|
||||||
|
}
|
||||||
|
|
||||||
|
/** The chain of ancestors from the immediate [parent] up to (and including) the root. */
|
||||||
|
public fun <T> TreeNode<T>.ancestors(): List<TreeNode<T>> {
|
||||||
|
val result = mutableListOf<TreeNode<T>>()
|
||||||
|
var parent = this.parent
|
||||||
|
while (parent != null) {
|
||||||
|
result.add(parent)
|
||||||
|
parent = parent.parent
|
||||||
|
}
|
||||||
|
return result
|
||||||
|
}
|
||||||
|
|
||||||
|
/** The other children of this node's parent (excludes this node). Empty for the root. */
|
||||||
|
public fun <T> TreeNode<T>.siblings(): List<TreeNode<T>> =
|
||||||
|
parent?.children?.filter { it !== this } ?: emptyList()
|
||||||
|
|
||||||
|
/** All leaf nodes in this subtree, in pre-order. */
|
||||||
|
public fun <T> TreeNode<T>.leaves(): List<TreeNode<T>> =
|
||||||
|
preOrderSequence().filter { it.isLeaf }.toList()
|
||||||
|
|
||||||
|
/** All nodes in this subtree except this node, in pre-order. */
|
||||||
|
public fun <T> TreeNode<T>.descendants(): List<TreeNode<T>> =
|
||||||
|
preOrderSequence().filter { it !== this }.toList()
|
||||||
@@ -0,0 +1,31 @@
|
|||||||
|
package com.github.adriankuta.datastructure.tree
|
||||||
|
|
||||||
|
import com.github.adriankuta.datastructure.tree.iterators.LevelOrderTreeIterator
|
||||||
|
import com.github.adriankuta.datastructure.tree.iterators.PostOrderTreeIterator
|
||||||
|
import com.github.adriankuta.datastructure.tree.iterators.PreOrderTreeIterator
|
||||||
|
import com.github.adriankuta.datastructure.tree.iterators.TreeNodeIterators
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Lazily traverses this subtree in the given [order] as a [Sequence], without forcing the whole
|
||||||
|
* traversal up front. Pairs with the Kotlin stdlib, e.g.
|
||||||
|
* `root.asSequence().map { it.value }.firstOrNull { it == target }`.
|
||||||
|
*/
|
||||||
|
public fun <T> TreeNode<T>.asSequence(
|
||||||
|
order: TreeNodeIterators = TreeNodeIterators.PreOrder,
|
||||||
|
): Sequence<TreeNode<T>> {
|
||||||
|
val self = this
|
||||||
|
return when (order) {
|
||||||
|
TreeNodeIterators.PreOrder -> Sequence { PreOrderTreeIterator(self) }
|
||||||
|
TreeNodeIterators.PostOrder -> Sequence { PostOrderTreeIterator(self) }
|
||||||
|
TreeNodeIterators.LevelOrder -> Sequence { LevelOrderTreeIterator(self) }
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/** Lazy pre-order traversal as a [Sequence]. */
|
||||||
|
public fun <T> TreeNode<T>.preOrderSequence(): Sequence<TreeNode<T>> = asSequence(TreeNodeIterators.PreOrder)
|
||||||
|
|
||||||
|
/** Lazy post-order traversal as a [Sequence]. */
|
||||||
|
public fun <T> TreeNode<T>.postOrderSequence(): Sequence<TreeNode<T>> = asSequence(TreeNodeIterators.PostOrder)
|
||||||
|
|
||||||
|
/** Lazy level-order (breadth-first) traversal as a [Sequence]. */
|
||||||
|
public fun <T> TreeNode<T>.levelOrderSequence(): Sequence<TreeNode<T>> = asSequence(TreeNodeIterators.LevelOrder)
|
||||||
@@ -0,0 +1,6 @@
|
|||||||
|
package com.github.adriankuta.datastructure.tree.exceptions
|
||||||
|
|
||||||
|
import kotlin.jvm.JvmOverloads
|
||||||
|
|
||||||
|
public class TreeNodeException @JvmOverloads constructor(message: String? = null, cause: Throwable? = null) :
|
||||||
|
RuntimeException(message, cause)
|
||||||
@@ -0,0 +1,39 @@
|
|||||||
|
package com.github.adriankuta.datastructure.tree.iterators
|
||||||
|
|
||||||
|
import com.github.adriankuta.datastructure.tree.TreeNode
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Tree is iterated by using `Level-order Traversal Algorithm"
|
||||||
|
* In level-order traversal we iterating nodes level by level,
|
||||||
|
* starting from root, and going deeper and deeper in tree.
|
||||||
|
* ```
|
||||||
|
* E.g.
|
||||||
|
* 1
|
||||||
|
* / | \
|
||||||
|
* / | \
|
||||||
|
* 2 3 4
|
||||||
|
* / \ / | \
|
||||||
|
* 5 6 7 8 9
|
||||||
|
* / / | \
|
||||||
|
* 10 11 12 13
|
||||||
|
*
|
||||||
|
* Output: 1 2 3 4 5 6 7 8 9 10 11 12 13
|
||||||
|
* ```
|
||||||
|
*/
|
||||||
|
public class LevelOrderTreeIterator<T>(root: TreeNode<T>) : Iterator<TreeNode<T>> {
|
||||||
|
|
||||||
|
private val stack = ArrayDeque<TreeNode<T>>()
|
||||||
|
|
||||||
|
init {
|
||||||
|
stack.addLast(root)
|
||||||
|
}
|
||||||
|
|
||||||
|
public override fun hasNext(): Boolean = stack.isNotEmpty()
|
||||||
|
|
||||||
|
public override fun next(): TreeNode<T> {
|
||||||
|
val node = stack.removeFirst()
|
||||||
|
node.children
|
||||||
|
.forEach { stack.addLast(it) }
|
||||||
|
return node
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,43 @@
|
|||||||
|
package com.github.adriankuta.datastructure.tree.iterators
|
||||||
|
|
||||||
|
import com.github.adriankuta.datastructure.tree.TreeNode
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Tree is iterated by using `Post-order Traversal Algorithm"
|
||||||
|
* In post-order traversal, we starting from most left child.
|
||||||
|
* First visit all children of parent, then parent.
|
||||||
|
* ```
|
||||||
|
* E.g.
|
||||||
|
* 1
|
||||||
|
* / | \
|
||||||
|
* / | \
|
||||||
|
* 2 3 4
|
||||||
|
* / \ / | \
|
||||||
|
* 5 6 7 8 9
|
||||||
|
* / / | \
|
||||||
|
* 10 11 12 13
|
||||||
|
*
|
||||||
|
* Output: 10 5 11 12 13 6 2 3 7 8 9 4 1
|
||||||
|
* ```
|
||||||
|
*/
|
||||||
|
public class PostOrderTreeIterator<T>(root: TreeNode<T>) : Iterator<TreeNode<T>> {
|
||||||
|
|
||||||
|
private val result = ArrayDeque<TreeNode<T>>()
|
||||||
|
|
||||||
|
init {
|
||||||
|
// Iterative post-order: pop a node, prepend it to `result`, then push its children
|
||||||
|
// left-to-right. Reading `result` front-to-back yields post-order — without the deep
|
||||||
|
// recursion that overflowed the stack on degenerate (linear) trees.
|
||||||
|
val stack = ArrayDeque<TreeNode<T>>()
|
||||||
|
stack.addLast(root)
|
||||||
|
while (stack.isNotEmpty()) {
|
||||||
|
val node = stack.removeLast()
|
||||||
|
result.addFirst(node)
|
||||||
|
node.children.forEach { stack.addLast(it) }
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
public override fun hasNext(): Boolean = result.isNotEmpty()
|
||||||
|
|
||||||
|
public override fun next(): TreeNode<T> = result.removeFirst()
|
||||||
|
}
|
||||||
@@ -0,0 +1,40 @@
|
|||||||
|
package com.github.adriankuta.datastructure.tree.iterators
|
||||||
|
|
||||||
|
import com.github.adriankuta.datastructure.tree.TreeNode
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Tree is iterated by using `Pre-order Traversal Algorithm"
|
||||||
|
* The pre-order traversal is a topologically sorted one,
|
||||||
|
* because a parent node is processed before any of its child nodes is done.
|
||||||
|
* ```
|
||||||
|
* E.g.
|
||||||
|
* 1
|
||||||
|
* / | \
|
||||||
|
* / | \
|
||||||
|
* 2 3 4
|
||||||
|
* / \ / | \
|
||||||
|
* 5 6 7 8 9
|
||||||
|
* / / | \
|
||||||
|
* 10 11 12 13
|
||||||
|
*
|
||||||
|
* Output: 1 2 5 10 6 11 12 13 3 4 7 8 9
|
||||||
|
* ```
|
||||||
|
*/
|
||||||
|
public class PreOrderTreeIterator<T>(root: TreeNode<T>) : Iterator<TreeNode<T>> {
|
||||||
|
|
||||||
|
private val stack = ArrayDeque<TreeNode<T>>()
|
||||||
|
|
||||||
|
init {
|
||||||
|
stack.addLast(root)
|
||||||
|
}
|
||||||
|
|
||||||
|
public override fun hasNext(): Boolean = stack.isNotEmpty()
|
||||||
|
|
||||||
|
public override fun next(): TreeNode<T> {
|
||||||
|
val node = stack.removeLast()
|
||||||
|
node.children
|
||||||
|
.asReversed()
|
||||||
|
.forEach { stack.addLast(it) }
|
||||||
|
return node
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,68 @@
|
|||||||
|
package com.github.adriankuta.datastructure.tree.iterators
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @see PreOrder
|
||||||
|
* @see PostOrder
|
||||||
|
* @see LevelOrder
|
||||||
|
*/
|
||||||
|
public enum class TreeNodeIterators {
|
||||||
|
/**
|
||||||
|
* Tree is iterated by using `Pre-order Traversal Algorithm"
|
||||||
|
* The pre-order traversal is a topologically sorted one,
|
||||||
|
* because a parent node is processed before any of its child nodes is done.
|
||||||
|
* ```
|
||||||
|
* E.g.
|
||||||
|
* 1
|
||||||
|
* / | \
|
||||||
|
* / | \
|
||||||
|
* 2 3 4
|
||||||
|
* / \ / | \
|
||||||
|
* 5 6 7 8 9
|
||||||
|
* / / | \
|
||||||
|
* 10 11 12 13
|
||||||
|
*
|
||||||
|
* Output: 1 2 5 10 6 11 12 13 3 4 7 8 9
|
||||||
|
* ```
|
||||||
|
*/
|
||||||
|
PreOrder,
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Tree is iterated by using `Post-order Traversal Algorithm"
|
||||||
|
* In post-order traversal, we starting from most left child.
|
||||||
|
* First visit all children of parent, then parent.
|
||||||
|
* ```
|
||||||
|
* E.g.
|
||||||
|
* 1
|
||||||
|
* / | \
|
||||||
|
* / | \
|
||||||
|
* 2 3 4
|
||||||
|
* / \ / | \
|
||||||
|
* 5 6 7 8 9
|
||||||
|
* / / | \
|
||||||
|
* 10 11 12 13
|
||||||
|
*
|
||||||
|
* Output: 10 5 11 12 13 6 2 3 7 8 9 4 1
|
||||||
|
* ```
|
||||||
|
*/
|
||||||
|
PostOrder,
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Tree is iterated by using `Level-order Traversal Algorithm"
|
||||||
|
* In level-order traversal we iterating nodes level by level,
|
||||||
|
* starting from root, and going deeper and deeper in tree.
|
||||||
|
* ```
|
||||||
|
* E.g.
|
||||||
|
* 1
|
||||||
|
* / | \
|
||||||
|
* / | \
|
||||||
|
* 2 3 4
|
||||||
|
* / \ / | \
|
||||||
|
* 5 6 7 8 9
|
||||||
|
* / / | \
|
||||||
|
* 10 11 12 13
|
||||||
|
*
|
||||||
|
* Output: 1 2 3 4 5 6 7 8 9 10 11 12 13
|
||||||
|
* ```
|
||||||
|
*/
|
||||||
|
LevelOrder
|
||||||
|
}
|
||||||
@@ -0,0 +1,78 @@
|
|||||||
|
package com.github.adriankuta.datastructure.tree
|
||||||
|
|
||||||
|
import kotlin.test.Test
|
||||||
|
import kotlin.test.assertContentEquals
|
||||||
|
import kotlin.test.assertEquals
|
||||||
|
import kotlin.test.assertFalse
|
||||||
|
import kotlin.test.assertNotSame
|
||||||
|
import kotlin.test.assertNull
|
||||||
|
import kotlin.test.assertSame
|
||||||
|
import kotlin.test.assertTrue
|
||||||
|
|
||||||
|
class TreeNodeFunctionalTest {
|
||||||
|
|
||||||
|
private fun sample() = tree(1) {
|
||||||
|
child(2) {
|
||||||
|
child(4)
|
||||||
|
child(5)
|
||||||
|
}
|
||||||
|
child(3) {
|
||||||
|
child(6)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun findNode() {
|
||||||
|
assertEquals(6, sample().findNode { it == 6 }?.value)
|
||||||
|
assertNull(sample().findNode { it == 99 })
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun filterNodes() =
|
||||||
|
assertContentEquals(listOf(2, 4, 6), sample().filterNodes { it % 2 == 0 }.map { it.value })
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun anyNode() {
|
||||||
|
assertTrue(sample().anyNode { it == 6 })
|
||||||
|
assertFalse(sample().anyNode { it == 99 })
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun allNodes() {
|
||||||
|
assertTrue(sample().allNodes { it > 0 })
|
||||||
|
assertFalse(sample().allNodes { it < 5 })
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun countNodes() = assertEquals(3, sample().countNodes { it > 3 })
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun foldNodes() = assertEquals(21, sample().foldNodes(0) { acc, node -> acc + node.value })
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun mapPreservesStructureAndTransformsValues() {
|
||||||
|
val mapped = sample().mapValues { it * 10 }
|
||||||
|
assertContentEquals(
|
||||||
|
listOf(10, 20, 40, 50, 30, 60),
|
||||||
|
mapped.preOrderSequence().map { it.value }.toList(),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun deepCopyIsStructurallyEqualButDistinct() {
|
||||||
|
val original = sample()
|
||||||
|
val copy = original.deepCopy()
|
||||||
|
assertNotSame(original, copy)
|
||||||
|
assertTrue(original.structurallyEquals(copy))
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun structurallyEqualsDistinguishesByValueAndShape() {
|
||||||
|
assertTrue(sample().structurallyEquals(sample()))
|
||||||
|
val different = tree(1) {
|
||||||
|
child(2) { child(4) }
|
||||||
|
child(3) { child(6) }
|
||||||
|
}
|
||||||
|
assertFalse(sample().structurallyEquals(different))
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,66 @@
|
|||||||
|
package com.github.adriankuta.datastructure.tree
|
||||||
|
|
||||||
|
import kotlin.test.Test
|
||||||
|
import kotlin.test.assertContentEquals
|
||||||
|
import kotlin.test.assertEquals
|
||||||
|
import kotlin.test.assertFalse
|
||||||
|
import kotlin.test.assertSame
|
||||||
|
import kotlin.test.assertTrue
|
||||||
|
|
||||||
|
class TreeNodeNavigationTest {
|
||||||
|
|
||||||
|
private val root = TreeNode(1)
|
||||||
|
private val n2 = TreeNode(2)
|
||||||
|
private val n3 = TreeNode(3)
|
||||||
|
private val n4 = TreeNode(4)
|
||||||
|
private val n5 = TreeNode(5)
|
||||||
|
private val n6 = TreeNode(6)
|
||||||
|
|
||||||
|
init {
|
||||||
|
root.addChild(n2)
|
||||||
|
root.addChild(n3)
|
||||||
|
n2.addChild(n4)
|
||||||
|
n2.addChild(n5)
|
||||||
|
n3.addChild(n6)
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun isLeaf() {
|
||||||
|
assertTrue(n4.isLeaf)
|
||||||
|
assertFalse(root.isLeaf)
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun degree() {
|
||||||
|
assertEquals(2, root.degree)
|
||||||
|
assertEquals(0, n4.degree)
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun root() {
|
||||||
|
assertSame(root, n6.root())
|
||||||
|
assertSame(root, root.root())
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun ancestors() {
|
||||||
|
assertContentEquals(listOf(n2, root), n4.ancestors())
|
||||||
|
assertContentEquals(emptyList(), root.ancestors())
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun siblings() {
|
||||||
|
assertContentEquals(listOf(n5), n4.siblings())
|
||||||
|
assertContentEquals(emptyList(), root.siblings())
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun leaves() {
|
||||||
|
assertContentEquals(listOf(n4, n5, n6), root.leaves())
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun descendants() {
|
||||||
|
assertContentEquals(listOf(n2, n4, n5, n3, n6), root.descendants())
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,46 @@
|
|||||||
|
package com.github.adriankuta.datastructure.tree
|
||||||
|
|
||||||
|
import com.github.adriankuta.datastructure.tree.iterators.TreeNodeIterators
|
||||||
|
import kotlin.test.Test
|
||||||
|
import kotlin.test.assertContentEquals
|
||||||
|
import kotlin.test.assertEquals
|
||||||
|
|
||||||
|
class TreeNodeSequenceTest {
|
||||||
|
|
||||||
|
private fun sample() = tree(1) {
|
||||||
|
child(2) {
|
||||||
|
child(4)
|
||||||
|
child(5)
|
||||||
|
}
|
||||||
|
child(3) {
|
||||||
|
child(6)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun preOrderSequence() =
|
||||||
|
assertContentEquals(listOf(1, 2, 4, 5, 3, 6), sample().preOrderSequence().map { it.value }.toList())
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun postOrderSequence() =
|
||||||
|
assertContentEquals(listOf(4, 5, 2, 6, 3, 1), sample().postOrderSequence().map { it.value }.toList())
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun levelOrderSequence() =
|
||||||
|
assertContentEquals(listOf(1, 2, 3, 4, 5, 6), sample().levelOrderSequence().map { it.value }.toList())
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun asSequenceDefaultsToPreOrder() =
|
||||||
|
assertContentEquals(listOf(1, 2, 4, 5, 3, 6), sample().asSequence().map { it.value }.toList())
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun asSequenceHonorsExplicitOrder() =
|
||||||
|
assertContentEquals(
|
||||||
|
listOf(1, 2, 3, 4, 5, 6),
|
||||||
|
sample().asSequence(TreeNodeIterators.LevelOrder).map { it.value }.toList(),
|
||||||
|
)
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun sequenceShortCircuitsLazily() =
|
||||||
|
assertEquals(4, sample().preOrderSequence().map { it.value }.first { it == 4 })
|
||||||
|
}
|
||||||
@@ -0,0 +1,47 @@
|
|||||||
|
package com.github.adriankuta.datastructure.tree
|
||||||
|
|
||||||
|
import com.github.adriankuta.datastructure.tree.iterators.TreeNodeIterators
|
||||||
|
import kotlin.test.Test
|
||||||
|
import kotlin.test.assertEquals
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A deep, degenerate (linear) tree must not overflow the call stack. These tests build a chain
|
||||||
|
* thousands of nodes deep — recursive implementations of [TreeNode.height], [TreeNode.nodeCount]
|
||||||
|
* and the post-order iterator blow the stack here, so they pin the iterative rewrites.
|
||||||
|
*/
|
||||||
|
class TreeNodeStackSafetyTest {
|
||||||
|
|
||||||
|
private val depth = 50_000
|
||||||
|
|
||||||
|
private fun deepChain(): TreeNode<Int> {
|
||||||
|
val root = TreeNode(0)
|
||||||
|
var current = root
|
||||||
|
for (i in 1..depth) {
|
||||||
|
val child = TreeNode(i)
|
||||||
|
current.addChild(child)
|
||||||
|
current = child
|
||||||
|
}
|
||||||
|
return root
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun heightDoesNotOverflowOnDeepTree() {
|
||||||
|
assertEquals(depth, deepChain().height())
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun nodeCountDoesNotOverflowOnDeepTree() {
|
||||||
|
// nodeCount() excludes the root, so a chain of `depth` extra nodes counts as `depth`.
|
||||||
|
assertEquals(depth, deepChain().nodeCount())
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun postOrderIterationDoesNotOverflowOnDeepTree() {
|
||||||
|
assertEquals(depth + 1, deepChain().asSequence(TreeNodeIterators.PostOrder).count())
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun preOrderIterationDoesNotOverflowOnDeepTree() {
|
||||||
|
assertEquals(depth + 1, deepChain().asSequence(TreeNodeIterators.PreOrder).count())
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,242 @@
|
|||||||
|
package com.github.adriankuta.datastructure.tree
|
||||||
|
|
||||||
|
import com.github.adriankuta.datastructure.tree.iterators.TreeNodeIterators
|
||||||
|
import kotlin.test.Test
|
||||||
|
import kotlin.test.assertContentEquals
|
||||||
|
import kotlin.test.assertEquals
|
||||||
|
import kotlin.test.assertFalse
|
||||||
|
import kotlin.test.assertNull
|
||||||
|
import kotlin.test.assertTrue
|
||||||
|
|
||||||
|
class TreeNodeTest {
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun removeNodeTest() {
|
||||||
|
val root = TreeNode("Root")
|
||||||
|
val beveragesNode = TreeNode("Beverages")
|
||||||
|
val curdNode = TreeNode("Curd")
|
||||||
|
root.addChild(beveragesNode)
|
||||||
|
root.addChild(curdNode)
|
||||||
|
|
||||||
|
val teaNode = TreeNode("tea")
|
||||||
|
val coffeeNode = TreeNode("coffee")
|
||||||
|
val milkShakeNode = TreeNode("Milk Shake")
|
||||||
|
beveragesNode.addChild(teaNode)
|
||||||
|
beveragesNode.addChild(coffeeNode)
|
||||||
|
beveragesNode.addChild(milkShakeNode)
|
||||||
|
|
||||||
|
val gingerTeaNode = TreeNode("ginger tea")
|
||||||
|
val normalTeaNode = TreeNode("normal tea")
|
||||||
|
teaNode.addChild(gingerTeaNode)
|
||||||
|
teaNode.addChild(normalTeaNode)
|
||||||
|
|
||||||
|
val yogurtNode = TreeNode("yogurt")
|
||||||
|
val lassiNode = TreeNode("lassi")
|
||||||
|
curdNode.addChild(yogurtNode)
|
||||||
|
curdNode.addChild(lassiNode)
|
||||||
|
|
||||||
|
assertEquals(
|
||||||
|
"Root\n" +
|
||||||
|
"├── Beverages\n" +
|
||||||
|
"│ ├── tea\n" +
|
||||||
|
"│ │ ├── ginger tea\n" +
|
||||||
|
"│ │ └── normal tea\n" +
|
||||||
|
"│ ├── coffee\n" +
|
||||||
|
"│ └── Milk Shake\n" +
|
||||||
|
"└── Curd\n" +
|
||||||
|
" ├── yogurt\n" +
|
||||||
|
" └── lassi\n",
|
||||||
|
root.prettyString(),
|
||||||
|
"Pretty print test"
|
||||||
|
)
|
||||||
|
|
||||||
|
root.removeChild(curdNode)
|
||||||
|
gingerTeaNode.detach()
|
||||||
|
assertEquals(
|
||||||
|
"Root\n" +
|
||||||
|
"└── Beverages\n" +
|
||||||
|
" ├── tea\n" +
|
||||||
|
" │ └── normal tea\n" +
|
||||||
|
" ├── coffee\n" +
|
||||||
|
" └── Milk Shake\n",
|
||||||
|
root.prettyString(),
|
||||||
|
"Remove node test"
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun removeChildReturnsTrueWhenPresentFalseOtherwise() {
|
||||||
|
val root = TreeNode("Root")
|
||||||
|
val child = TreeNode("Child")
|
||||||
|
root.addChild(child)
|
||||||
|
|
||||||
|
assertTrue(root.removeChild(child), "Removing a present child returns true")
|
||||||
|
assertFalse(root.removeChild(child), "Removing an already-removed child returns false")
|
||||||
|
assertNull(child.parent, "Removed child is detached from its parent")
|
||||||
|
assertEquals(emptyList(), root.children)
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun clearTest() {
|
||||||
|
val root = TreeNode("Root")
|
||||||
|
val beveragesNode = TreeNode("Beverages")
|
||||||
|
val curdNode = TreeNode("Curd")
|
||||||
|
root.addChild(beveragesNode)
|
||||||
|
root.addChild(curdNode)
|
||||||
|
|
||||||
|
val teaNode = TreeNode("tea")
|
||||||
|
val coffeeNode = TreeNode("coffee")
|
||||||
|
val milkShakeNode = TreeNode("Milk Shake")
|
||||||
|
beveragesNode.addChild(teaNode)
|
||||||
|
beveragesNode.addChild(coffeeNode)
|
||||||
|
beveragesNode.addChild(milkShakeNode)
|
||||||
|
|
||||||
|
val gingerTeaNode = TreeNode("ginger tea")
|
||||||
|
val normalTeaNode = TreeNode("normal tea")
|
||||||
|
teaNode.addChild(gingerTeaNode)
|
||||||
|
teaNode.addChild(normalTeaNode)
|
||||||
|
|
||||||
|
val yogurtNode = TreeNode("yogurt")
|
||||||
|
val lassiNode = TreeNode("lassi")
|
||||||
|
curdNode.addChild(yogurtNode)
|
||||||
|
curdNode.addChild(lassiNode)
|
||||||
|
|
||||||
|
root.clear()
|
||||||
|
assertEquals(root.children, emptyList())
|
||||||
|
assertEquals(beveragesNode.children, emptyList())
|
||||||
|
assertEquals(curdNode.children, emptyList())
|
||||||
|
assertEquals(teaNode.children, emptyList())
|
||||||
|
assertEquals(coffeeNode.children, emptyList())
|
||||||
|
assertEquals(milkShakeNode.children, emptyList())
|
||||||
|
assertEquals(gingerTeaNode.children, emptyList())
|
||||||
|
assertEquals(normalTeaNode.children, emptyList())
|
||||||
|
assertEquals(yogurtNode.children, emptyList())
|
||||||
|
assertEquals(lassiNode.children, emptyList())
|
||||||
|
|
||||||
|
assertNull(root.parent)
|
||||||
|
assertNull(beveragesNode.parent)
|
||||||
|
assertNull(curdNode.parent)
|
||||||
|
assertNull(teaNode.parent)
|
||||||
|
assertNull(coffeeNode.parent)
|
||||||
|
assertNull(milkShakeNode.parent)
|
||||||
|
assertNull(gingerTeaNode.parent)
|
||||||
|
assertNull(normalTeaNode.parent)
|
||||||
|
assertNull(yogurtNode.parent)
|
||||||
|
assertNull(lassiNode.parent)
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun kotlinExtTest() {
|
||||||
|
val root = TreeNode("World")
|
||||||
|
val northA = TreeNode("North America")
|
||||||
|
val europe = TreeNode("Europe")
|
||||||
|
root.addChild(northA)
|
||||||
|
root.addChild(europe)
|
||||||
|
|
||||||
|
val usa = TreeNode("USA")
|
||||||
|
northA.addChild(usa)
|
||||||
|
|
||||||
|
val poland = TreeNode("Poland")
|
||||||
|
val france = TreeNode("France")
|
||||||
|
europe.addChild(poland)
|
||||||
|
europe.addChild(france)
|
||||||
|
|
||||||
|
val rootExt = tree("World") {
|
||||||
|
child("North America") {
|
||||||
|
child("USA")
|
||||||
|
}
|
||||||
|
child("Europe") {
|
||||||
|
child("Poland")
|
||||||
|
child("France")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
assertEquals(root.prettyString(), rootExt.prettyString())
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun preOrderIteratorTest() {
|
||||||
|
val tree = tree("F") {
|
||||||
|
child("B") {
|
||||||
|
child("A")
|
||||||
|
child("D") {
|
||||||
|
child("C")
|
||||||
|
child("E")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
child("G") {
|
||||||
|
child("I") {
|
||||||
|
child("H")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
val expectedPreOrder = listOf("F", "B", "A", "D", "C", "E", "G", "I", "H")
|
||||||
|
assertContentEquals(expectedPreOrder, tree.toList().map { it.toString() })
|
||||||
|
}
|
||||||
|
@Test
|
||||||
|
fun postOrderIteratorTest() {
|
||||||
|
val tree = tree("A", TreeNodeIterators.PostOrder) {
|
||||||
|
child("B") {
|
||||||
|
child("E")
|
||||||
|
}
|
||||||
|
child("C")
|
||||||
|
child("D") {
|
||||||
|
child("F")
|
||||||
|
child("G")
|
||||||
|
child("H")
|
||||||
|
child("I")
|
||||||
|
child("J")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
val expectedPreOrder = listOf("E", "B", "C", "F", "G", "H", "I", "J", "D", "A")
|
||||||
|
assertContentEquals(expectedPreOrder, tree.toList().map { it.toString() })
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun secondPostOrderIteratorTest() {
|
||||||
|
val tree = tree(1, TreeNodeIterators.PostOrder) {
|
||||||
|
child(2) {
|
||||||
|
child(5) {
|
||||||
|
child(10)
|
||||||
|
}
|
||||||
|
child(6) {
|
||||||
|
child(11)
|
||||||
|
child(12)
|
||||||
|
child(13)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
child(3)
|
||||||
|
child(4) {
|
||||||
|
child(7)
|
||||||
|
child(8)
|
||||||
|
child(9)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
val expectedOrder = listOf(10, 5, 11, 12, 13, 6, 2, 3, 7, 8, 9, 4, 1)
|
||||||
|
assertContentEquals(expectedOrder, tree.toList().map { it.value })
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun levelOrderIteratorTest() {
|
||||||
|
val tree = tree(1, TreeNodeIterators.LevelOrder) {
|
||||||
|
child(2) {
|
||||||
|
child(5) {
|
||||||
|
child(10)
|
||||||
|
}
|
||||||
|
child(6) {
|
||||||
|
child(11)
|
||||||
|
child(12)
|
||||||
|
child(13)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
child(3)
|
||||||
|
child(4) {
|
||||||
|
child(7)
|
||||||
|
child(8)
|
||||||
|
child(9)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
val expectedOrder = listOf(1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13)
|
||||||
|
assertContentEquals(expectedOrder, tree.toList().map { it.value })
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,53 @@
|
|||||||
|
package com.github.adriankuta.datastructure.tree
|
||||||
|
|
||||||
|
import kotlin.test.Test
|
||||||
|
import kotlin.test.assertContentEquals
|
||||||
|
import kotlin.test.assertEquals
|
||||||
|
import kotlin.test.assertNull
|
||||||
|
|
||||||
|
class TreeNodeUtilitiesTest {
|
||||||
|
|
||||||
|
private val root = TreeNode(1)
|
||||||
|
private val a = TreeNode(2)
|
||||||
|
private val b = TreeNode(3)
|
||||||
|
|
||||||
|
init {
|
||||||
|
root.addChild(a)
|
||||||
|
a.addChild(b)
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun nodeCountCountsDescendantsExcludingRoot() {
|
||||||
|
assertEquals(0, TreeNode("solo").nodeCount())
|
||||||
|
assertEquals(2, root.nodeCount())
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun heightIsLongestEdgePathToLeaf() {
|
||||||
|
assertEquals(0, TreeNode("solo").height())
|
||||||
|
assertEquals(2, root.height())
|
||||||
|
assertEquals(1, a.height())
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun depthIsDistanceToRoot() {
|
||||||
|
assertEquals(0, root.depth())
|
||||||
|
assertEquals(1, a.depth())
|
||||||
|
assertEquals(2, b.depth())
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun pathReturnsDescendantToReceiverChain() {
|
||||||
|
assertContentEquals(listOf(b, a, root), root.path(b))
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun pathReturnsNullWhenNotADescendant() {
|
||||||
|
assertNull(root.path(TreeNode(99)))
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun pathReturnsNullWhenDescendantIsRootItself() {
|
||||||
|
assertNull(root.path(root))
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,105 @@
|
|||||||
|
package com.github.adriankuta.datastructure.tree
|
||||||
|
|
||||||
|
import com.github.adriankuta.datastructure.tree.exceptions.TreeNodeException
|
||||||
|
import com.github.adriankuta.datastructure.tree.iterators.TreeNodeIterators
|
||||||
|
import kotlin.test.Test
|
||||||
|
import kotlin.test.assertContentEquals
|
||||||
|
import kotlin.test.assertEquals
|
||||||
|
import kotlin.test.assertFailsWith
|
||||||
|
import kotlin.test.assertFalse
|
||||||
|
import kotlin.test.assertNull
|
||||||
|
import kotlin.test.assertSame
|
||||||
|
import kotlin.test.assertTrue
|
||||||
|
|
||||||
|
class TreeNodeV4Test {
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun addChildRejectsNodeThatAlreadyHasAParent() {
|
||||||
|
val a = TreeNode("a")
|
||||||
|
val b = TreeNode("b")
|
||||||
|
a.addChild(b)
|
||||||
|
|
||||||
|
val other = TreeNode("other")
|
||||||
|
assertFailsWith<TreeNodeException> { other.addChild(b) }
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun addChildRejectsCycles() {
|
||||||
|
val root = TreeNode("root")
|
||||||
|
val child = TreeNode("child")
|
||||||
|
root.addChild(child)
|
||||||
|
|
||||||
|
// Attaching an ancestor under its own descendant would create a cycle.
|
||||||
|
assertFailsWith<TreeNodeException> { child.addChild(root) }
|
||||||
|
// Attaching a node under itself is also a cycle.
|
||||||
|
assertFailsWith<TreeNodeException> { root.addChild(root) }
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun detachRemovesFromParent() {
|
||||||
|
val root = TreeNode("root")
|
||||||
|
val child = TreeNode("child")
|
||||||
|
root.addChild(child)
|
||||||
|
|
||||||
|
assertTrue(child.detach())
|
||||||
|
assertNull(child.parent)
|
||||||
|
assertContentEquals(emptyList(), root.children)
|
||||||
|
// Detached node can now be re-attached elsewhere.
|
||||||
|
val newParent = TreeNode("newParent")
|
||||||
|
newParent.addChild(child)
|
||||||
|
assertSame(newParent, child.parent)
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun detachOnRootReturnsFalse() {
|
||||||
|
assertFalse(TreeNode("root").detach())
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun removeChildOnlyRemovesDirectChildren() {
|
||||||
|
val root = TreeNode("root")
|
||||||
|
val parent = TreeNode("parent")
|
||||||
|
val grandchild = TreeNode("grandchild")
|
||||||
|
root.addChild(parent)
|
||||||
|
parent.addChild(grandchild)
|
||||||
|
|
||||||
|
// grandchild is not a direct child of root -> no-op, returns false.
|
||||||
|
assertFalse(root.removeChild(grandchild))
|
||||||
|
assertSame(parent, grandchild.parent)
|
||||||
|
|
||||||
|
// direct child removal works.
|
||||||
|
assertTrue(parent.removeChild(grandchild))
|
||||||
|
assertNull(grandchild.parent)
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun clearOnNonRootKeepsItAttachedToItsParent() {
|
||||||
|
val root = TreeNode("root")
|
||||||
|
val branch = TreeNode("branch")
|
||||||
|
val leaf = TreeNode("leaf")
|
||||||
|
root.addChild(branch)
|
||||||
|
branch.addChild(leaf)
|
||||||
|
|
||||||
|
branch.clear()
|
||||||
|
|
||||||
|
assertContentEquals(emptyList(), branch.children)
|
||||||
|
assertSame(root, branch.parent) // branch stays attached to root
|
||||||
|
assertContentEquals(listOf(branch), root.children)
|
||||||
|
assertNull(leaf.parent) // former descendant is detached
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun iteratorAcceptsExplicitOrderWithoutMutatingDefault() {
|
||||||
|
val tree = tree(1) {
|
||||||
|
child(2) { child(4) }
|
||||||
|
child(3)
|
||||||
|
}
|
||||||
|
|
||||||
|
val postOrder = tree.iterator(TreeNodeIterators.PostOrder).asSequence().map { it.value }.toList()
|
||||||
|
assertContentEquals(listOf(4, 2, 3, 1), postOrder)
|
||||||
|
|
||||||
|
// Default order is unchanged (PreOrder).
|
||||||
|
assertEquals(TreeNodeIterators.PreOrder, tree.treeIterator)
|
||||||
|
assertContentEquals(listOf(1, 2, 4, 3), tree.map { it.value })
|
||||||
|
}
|
||||||
|
}
|
||||||
4
tree-structure-compose/api/tree-structure-compose.api
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
public final class com/github/adriankuta/datastructure/tree/compose/LazyTreeKt {
|
||||||
|
public static final fun LazyTree (Lcom/github/adriankuta/datastructure/tree/TreeNode;Landroidx/compose/ui/Modifier;ZLkotlin/jvm/functions/Function6;Landroidx/compose/runtime/Composer;II)V
|
||||||
|
}
|
||||||
|
|
||||||
87
tree-structure-compose/build.gradle.kts
Normal file
@@ -0,0 +1,87 @@
|
|||||||
|
import org.jetbrains.kotlin.gradle.ExperimentalWasmDsl
|
||||||
|
|
||||||
|
plugins {
|
||||||
|
alias(libs.plugins.kotlinMultiplatform)
|
||||||
|
alias(libs.plugins.composeMultiplatform)
|
||||||
|
alias(libs.plugins.composeCompiler)
|
||||||
|
alias(libs.plugins.dokka)
|
||||||
|
alias(libs.plugins.mavenPublish)
|
||||||
|
signing
|
||||||
|
}
|
||||||
|
|
||||||
|
group = "com.github.adriankuta"
|
||||||
|
version = rootProject.version
|
||||||
|
|
||||||
|
mavenPublishing {
|
||||||
|
publishToMavenCentral(automaticRelease = false)
|
||||||
|
signAllPublications()
|
||||||
|
|
||||||
|
coordinates("com.github.adriankuta", "tree-structure-compose", version.toString())
|
||||||
|
|
||||||
|
pom {
|
||||||
|
name.set("Tree Data Structure — Compose Multiplatform")
|
||||||
|
description.set("A LazyTree composable (expand/collapse, lazy rendering) for the tree-structure library.")
|
||||||
|
url.set("https://github.com/AdrianKuta/Tree-Data-Structure")
|
||||||
|
licenses {
|
||||||
|
license {
|
||||||
|
name.set("MIT License")
|
||||||
|
url.set("https://opensource.org/licenses/MIT")
|
||||||
|
distribution.set("repo")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
developers {
|
||||||
|
developer {
|
||||||
|
id.set("AdrianKuta")
|
||||||
|
name.set("Adrian Kuta")
|
||||||
|
email.set("adrian.kuta93@gmail.com")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
scm {
|
||||||
|
url.set("https://github.com/AdrianKuta/Tree-Data-Structure")
|
||||||
|
connection.set("scm:git:https://github.com/AdrianKuta/Tree-Data-Structure.git")
|
||||||
|
developerConnection.set("scm:git:ssh://git@github.com/AdrianKuta/Tree-Data-Structure.git")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
repositories {
|
||||||
|
mavenCentral()
|
||||||
|
google()
|
||||||
|
}
|
||||||
|
|
||||||
|
dokka {
|
||||||
|
dokkaSourceSets.configureEach {
|
||||||
|
sourceLink {
|
||||||
|
// Resolve this module's GitHub source path relative to the repo root.
|
||||||
|
localDirectory.set(projectDir.resolve("src"))
|
||||||
|
val module = projectDir.relativeTo(rootDir).invariantSeparatorsPath
|
||||||
|
val prefix = if (module.isEmpty()) "" else "$module/"
|
||||||
|
remoteUrl("https://github.com/AdrianKuta/Tree-Data-Structure/blob/master/${prefix}src")
|
||||||
|
remoteLineSuffix.set("#L")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
kotlin {
|
||||||
|
explicitApi()
|
||||||
|
jvmToolchain(21)
|
||||||
|
|
||||||
|
jvm()
|
||||||
|
|
||||||
|
@OptIn(ExperimentalWasmDsl::class)
|
||||||
|
wasmJs {
|
||||||
|
browser()
|
||||||
|
}
|
||||||
|
|
||||||
|
iosX64()
|
||||||
|
iosArm64()
|
||||||
|
iosSimulatorArm64()
|
||||||
|
|
||||||
|
sourceSets {
|
||||||
|
commonMain.dependencies {
|
||||||
|
api(project(":"))
|
||||||
|
implementation(compose.runtime)
|
||||||
|
implementation(compose.foundation)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,71 @@
|
|||||||
|
package com.github.adriankuta.datastructure.tree.compose
|
||||||
|
|
||||||
|
import androidx.compose.foundation.lazy.LazyColumn
|
||||||
|
import androidx.compose.runtime.Composable
|
||||||
|
import androidx.compose.runtime.mutableStateMapOf
|
||||||
|
import androidx.compose.runtime.remember
|
||||||
|
import androidx.compose.ui.Modifier
|
||||||
|
import com.github.adriankuta.datastructure.tree.TreeNode
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A lazily-rendered, expand/collapse tree for Compose Multiplatform. Only the currently-visible
|
||||||
|
* nodes are composed, so it scales to large trees. Expansion state is remembered internally, keyed
|
||||||
|
* by node identity.
|
||||||
|
*
|
||||||
|
* ```
|
||||||
|
* LazyTree(root) { node, depth, expanded, toggle ->
|
||||||
|
* Row(Modifier.padding(start = (depth * 16).dp).clickable(onClick = toggle)) {
|
||||||
|
* if (!node.isLeaf) Text(if (expanded) "▾" else "▸")
|
||||||
|
* Text(node.value.toString())
|
||||||
|
* }
|
||||||
|
* }
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* @param root the root of the tree to display.
|
||||||
|
* @param modifier the [Modifier] applied to the underlying [LazyColumn].
|
||||||
|
* @param initiallyExpanded whether nodes start expanded.
|
||||||
|
* @param nodeContent renders a single node. Receives the node, its depth (root = 0), whether it is
|
||||||
|
* expanded, and a `toggle` callback that flips this node's expansion state.
|
||||||
|
*/
|
||||||
|
@Composable
|
||||||
|
public fun <T> LazyTree(
|
||||||
|
root: TreeNode<T>,
|
||||||
|
modifier: Modifier = Modifier,
|
||||||
|
initiallyExpanded: Boolean = true,
|
||||||
|
nodeContent: @Composable (node: TreeNode<T>, depth: Int, expanded: Boolean, toggle: () -> Unit) -> Unit,
|
||||||
|
) {
|
||||||
|
val expansion = remember(root) { mutableStateMapOf<TreeNode<T>, Boolean>() }
|
||||||
|
val isExpanded: (TreeNode<T>) -> Boolean = { node -> expansion[node] ?: initiallyExpanded }
|
||||||
|
|
||||||
|
val visible = flattenVisible(root, isExpanded)
|
||||||
|
|
||||||
|
LazyColumn(modifier = modifier) {
|
||||||
|
items(visible.size) { index ->
|
||||||
|
val (node, depth) = visible[index]
|
||||||
|
nodeContent(node, depth, isExpanded(node)) {
|
||||||
|
expansion[node] = !isExpanded(node)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Flattens the tree into the list of currently-visible `(node, depth)` pairs in pre-order, skipping
|
||||||
|
* the subtrees of collapsed nodes. Iterative, so it is safe on deep trees.
|
||||||
|
*/
|
||||||
|
private fun <T> flattenVisible(
|
||||||
|
root: TreeNode<T>,
|
||||||
|
isExpanded: (TreeNode<T>) -> Boolean,
|
||||||
|
): List<Pair<TreeNode<T>, Int>> {
|
||||||
|
val result = mutableListOf<Pair<TreeNode<T>, Int>>()
|
||||||
|
val stack = ArrayDeque<Pair<TreeNode<T>, Int>>()
|
||||||
|
stack.addLast(root to 0)
|
||||||
|
while (stack.isNotEmpty()) {
|
||||||
|
val (node, depth) = stack.removeLast()
|
||||||
|
result.add(node to depth)
|
||||||
|
if (isExpanded(node)) {
|
||||||
|
node.children.asReversed().forEach { child -> stack.addLast(child to depth + 1) }
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return result
|
||||||
|
}
|
||||||
@@ -0,0 +1,8 @@
|
|||||||
|
public final class com/github/adriankuta/datastructure/tree/coroutines/TreeNodeFlowExtKt {
|
||||||
|
public static final fun asFlow (Lcom/github/adriankuta/datastructure/tree/TreeNode;Lcom/github/adriankuta/datastructure/tree/iterators/TreeNodeIterators;)Lkotlinx/coroutines/flow/Flow;
|
||||||
|
public static synthetic fun asFlow$default (Lcom/github/adriankuta/datastructure/tree/TreeNode;Lcom/github/adriankuta/datastructure/tree/iterators/TreeNodeIterators;ILjava/lang/Object;)Lkotlinx/coroutines/flow/Flow;
|
||||||
|
public static final fun levelOrderFlow (Lcom/github/adriankuta/datastructure/tree/TreeNode;)Lkotlinx/coroutines/flow/Flow;
|
||||||
|
public static final fun postOrderFlow (Lcom/github/adriankuta/datastructure/tree/TreeNode;)Lkotlinx/coroutines/flow/Flow;
|
||||||
|
public static final fun preOrderFlow (Lcom/github/adriankuta/datastructure/tree/TreeNode;)Lkotlinx/coroutines/flow/Flow;
|
||||||
|
}
|
||||||
|
|
||||||
102
tree-structure-coroutines/build.gradle.kts
Normal file
@@ -0,0 +1,102 @@
|
|||||||
|
import org.jetbrains.kotlin.gradle.ExperimentalWasmDsl
|
||||||
|
|
||||||
|
plugins {
|
||||||
|
alias(libs.plugins.kotlinMultiplatform)
|
||||||
|
alias(libs.plugins.dokka)
|
||||||
|
alias(libs.plugins.mavenPublish)
|
||||||
|
signing
|
||||||
|
}
|
||||||
|
|
||||||
|
group = "com.github.adriankuta"
|
||||||
|
version = rootProject.version
|
||||||
|
|
||||||
|
mavenPublishing {
|
||||||
|
publishToMavenCentral(automaticRelease = false)
|
||||||
|
signAllPublications()
|
||||||
|
|
||||||
|
coordinates("com.github.adriankuta", "tree-structure-coroutines", version.toString())
|
||||||
|
|
||||||
|
pom {
|
||||||
|
name.set("Tree Data Structure — coroutines")
|
||||||
|
description.set("kotlinx.coroutines Flow traversal for the tree-structure library.")
|
||||||
|
url.set("https://github.com/AdrianKuta/Tree-Data-Structure")
|
||||||
|
licenses {
|
||||||
|
license {
|
||||||
|
name.set("MIT License")
|
||||||
|
url.set("https://opensource.org/licenses/MIT")
|
||||||
|
distribution.set("repo")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
developers {
|
||||||
|
developer {
|
||||||
|
id.set("AdrianKuta")
|
||||||
|
name.set("Adrian Kuta")
|
||||||
|
email.set("adrian.kuta93@gmail.com")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
scm {
|
||||||
|
url.set("https://github.com/AdrianKuta/Tree-Data-Structure")
|
||||||
|
connection.set("scm:git:https://github.com/AdrianKuta/Tree-Data-Structure.git")
|
||||||
|
developerConnection.set("scm:git:ssh://git@github.com/AdrianKuta/Tree-Data-Structure.git")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
repositories {
|
||||||
|
mavenCentral()
|
||||||
|
}
|
||||||
|
|
||||||
|
dokka {
|
||||||
|
dokkaSourceSets.configureEach {
|
||||||
|
sourceLink {
|
||||||
|
// Resolve this module's GitHub source path relative to the repo root.
|
||||||
|
localDirectory.set(projectDir.resolve("src"))
|
||||||
|
val module = projectDir.relativeTo(rootDir).invariantSeparatorsPath
|
||||||
|
val prefix = if (module.isEmpty()) "" else "$module/"
|
||||||
|
remoteUrl("https://github.com/AdrianKuta/Tree-Data-Structure/blob/master/${prefix}src")
|
||||||
|
remoteLineSuffix.set("#L")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
kotlin {
|
||||||
|
explicitApi()
|
||||||
|
jvmToolchain(21)
|
||||||
|
|
||||||
|
jvm()
|
||||||
|
|
||||||
|
js(IR) {
|
||||||
|
browser()
|
||||||
|
nodejs()
|
||||||
|
}
|
||||||
|
|
||||||
|
@OptIn(ExperimentalWasmDsl::class)
|
||||||
|
wasmJs {
|
||||||
|
browser()
|
||||||
|
nodejs()
|
||||||
|
}
|
||||||
|
|
||||||
|
iosX64()
|
||||||
|
iosArm64()
|
||||||
|
iosSimulatorArm64()
|
||||||
|
|
||||||
|
val hostOs = System.getProperty("os.name")
|
||||||
|
val isMingwX64 = hostOs.startsWith("Windows")
|
||||||
|
when {
|
||||||
|
hostOs == "Mac OS X" -> macosX64("native")
|
||||||
|
hostOs == "Linux" -> linuxX64("native")
|
||||||
|
isMingwX64 -> mingwX64("native")
|
||||||
|
else -> throw GradleException("Host OS is not supported in Kotlin/Native.")
|
||||||
|
}
|
||||||
|
|
||||||
|
sourceSets {
|
||||||
|
commonMain.dependencies {
|
||||||
|
api(project(":"))
|
||||||
|
api(libs.kotlinx.coroutines.core)
|
||||||
|
}
|
||||||
|
commonTest.dependencies {
|
||||||
|
implementation(kotlin("test"))
|
||||||
|
implementation(libs.kotlinx.coroutines.test)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,24 @@
|
|||||||
|
package com.github.adriankuta.datastructure.tree.coroutines
|
||||||
|
|
||||||
|
import com.github.adriankuta.datastructure.tree.TreeNode
|
||||||
|
import com.github.adriankuta.datastructure.tree.asSequence
|
||||||
|
import com.github.adriankuta.datastructure.tree.iterators.TreeNodeIterators
|
||||||
|
import kotlinx.coroutines.flow.Flow
|
||||||
|
import kotlinx.coroutines.flow.asFlow
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Emits this node and all of its descendants as a cold [Flow], traversed in the given [order].
|
||||||
|
* Useful for plugging tree traversal into coroutine/Flow pipelines (e.g. in a ViewModel).
|
||||||
|
*/
|
||||||
|
public fun <T> TreeNode<T>.asFlow(
|
||||||
|
order: TreeNodeIterators = TreeNodeIterators.PreOrder,
|
||||||
|
): Flow<TreeNode<T>> = asSequence(order).asFlow()
|
||||||
|
|
||||||
|
/** Pre-order traversal as a cold [Flow]. */
|
||||||
|
public fun <T> TreeNode<T>.preOrderFlow(): Flow<TreeNode<T>> = asFlow(TreeNodeIterators.PreOrder)
|
||||||
|
|
||||||
|
/** Post-order traversal as a cold [Flow]. */
|
||||||
|
public fun <T> TreeNode<T>.postOrderFlow(): Flow<TreeNode<T>> = asFlow(TreeNodeIterators.PostOrder)
|
||||||
|
|
||||||
|
/** Level-order (breadth-first) traversal as a cold [Flow]. */
|
||||||
|
public fun <T> TreeNode<T>.levelOrderFlow(): Flow<TreeNode<T>> = asFlow(TreeNodeIterators.LevelOrder)
|
||||||
@@ -0,0 +1,35 @@
|
|||||||
|
package com.github.adriankuta.datastructure.tree.coroutines
|
||||||
|
|
||||||
|
import com.github.adriankuta.datastructure.tree.iterators.TreeNodeIterators
|
||||||
|
import com.github.adriankuta.datastructure.tree.tree
|
||||||
|
import kotlinx.coroutines.flow.map
|
||||||
|
import kotlinx.coroutines.flow.toList
|
||||||
|
import kotlinx.coroutines.test.runTest
|
||||||
|
import kotlin.test.Test
|
||||||
|
import kotlin.test.assertEquals
|
||||||
|
|
||||||
|
class TreeNodeFlowTest {
|
||||||
|
|
||||||
|
private fun sample() = tree(1) {
|
||||||
|
child(2) {
|
||||||
|
child(4)
|
||||||
|
child(5)
|
||||||
|
}
|
||||||
|
child(3) {
|
||||||
|
child(6)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun preOrderFlowEmitsInPreOrder() = runTest {
|
||||||
|
assertEquals(listOf(1, 2, 4, 5, 3, 6), sample().preOrderFlow().map { it.value }.toList())
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun levelOrderFlowEmitsInLevelOrder() = runTest {
|
||||||
|
assertEquals(
|
||||||
|
listOf(1, 2, 3, 4, 5, 6),
|
||||||
|
sample().asFlow(TreeNodeIterators.LevelOrder).map { it.value }.toList(),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,35 @@
|
|||||||
|
public final class com/github/adriankuta/datastructure/tree/serialization/TreeNodeDto {
|
||||||
|
public static final field Companion Lcom/github/adriankuta/datastructure/tree/serialization/TreeNodeDto$Companion;
|
||||||
|
public fun <init> (Ljava/lang/Object;Ljava/util/List;)V
|
||||||
|
public synthetic fun <init> (Ljava/lang/Object;Ljava/util/List;ILkotlin/jvm/internal/DefaultConstructorMarker;)V
|
||||||
|
public final fun component1 ()Ljava/lang/Object;
|
||||||
|
public final fun component2 ()Ljava/util/List;
|
||||||
|
public final fun copy (Ljava/lang/Object;Ljava/util/List;)Lcom/github/adriankuta/datastructure/tree/serialization/TreeNodeDto;
|
||||||
|
public static synthetic fun copy$default (Lcom/github/adriankuta/datastructure/tree/serialization/TreeNodeDto;Ljava/lang/Object;Ljava/util/List;ILjava/lang/Object;)Lcom/github/adriankuta/datastructure/tree/serialization/TreeNodeDto;
|
||||||
|
public fun equals (Ljava/lang/Object;)Z
|
||||||
|
public final fun getChildren ()Ljava/util/List;
|
||||||
|
public final fun getValue ()Ljava/lang/Object;
|
||||||
|
public fun hashCode ()I
|
||||||
|
public fun toString ()Ljava/lang/String;
|
||||||
|
}
|
||||||
|
|
||||||
|
public synthetic class com/github/adriankuta/datastructure/tree/serialization/TreeNodeDto$$serializer : kotlinx/serialization/internal/GeneratedSerializer {
|
||||||
|
public fun <init> (Lkotlinx/serialization/KSerializer;)V
|
||||||
|
public final fun childSerializers ()[Lkotlinx/serialization/KSerializer;
|
||||||
|
public final fun deserialize (Lkotlinx/serialization/encoding/Decoder;)Lcom/github/adriankuta/datastructure/tree/serialization/TreeNodeDto;
|
||||||
|
public synthetic fun deserialize (Lkotlinx/serialization/encoding/Decoder;)Ljava/lang/Object;
|
||||||
|
public final fun getDescriptor ()Lkotlinx/serialization/descriptors/SerialDescriptor;
|
||||||
|
public final fun serialize (Lkotlinx/serialization/encoding/Encoder;Lcom/github/adriankuta/datastructure/tree/serialization/TreeNodeDto;)V
|
||||||
|
public synthetic fun serialize (Lkotlinx/serialization/encoding/Encoder;Ljava/lang/Object;)V
|
||||||
|
public final fun typeParametersSerializers ()[Lkotlinx/serialization/KSerializer;
|
||||||
|
}
|
||||||
|
|
||||||
|
public final class com/github/adriankuta/datastructure/tree/serialization/TreeNodeDto$Companion {
|
||||||
|
public final fun serializer (Lkotlinx/serialization/KSerializer;)Lkotlinx/serialization/KSerializer;
|
||||||
|
}
|
||||||
|
|
||||||
|
public final class com/github/adriankuta/datastructure/tree/serialization/TreeNodeDtoKt {
|
||||||
|
public static final fun toDto (Lcom/github/adriankuta/datastructure/tree/TreeNode;)Lcom/github/adriankuta/datastructure/tree/serialization/TreeNodeDto;
|
||||||
|
public static final fun toTreeNode (Lcom/github/adriankuta/datastructure/tree/serialization/TreeNodeDto;)Lcom/github/adriankuta/datastructure/tree/TreeNode;
|
||||||
|
}
|
||||||
|
|
||||||
102
tree-structure-serialization/build.gradle.kts
Normal file
@@ -0,0 +1,102 @@
|
|||||||
|
import org.jetbrains.kotlin.gradle.ExperimentalWasmDsl
|
||||||
|
|
||||||
|
plugins {
|
||||||
|
alias(libs.plugins.kotlinMultiplatform)
|
||||||
|
alias(libs.plugins.kotlinSerialization)
|
||||||
|
alias(libs.plugins.dokka)
|
||||||
|
alias(libs.plugins.mavenPublish)
|
||||||
|
signing
|
||||||
|
}
|
||||||
|
|
||||||
|
group = "com.github.adriankuta"
|
||||||
|
version = rootProject.version
|
||||||
|
|
||||||
|
mavenPublishing {
|
||||||
|
publishToMavenCentral(automaticRelease = false)
|
||||||
|
signAllPublications()
|
||||||
|
|
||||||
|
coordinates("com.github.adriankuta", "tree-structure-serialization", version.toString())
|
||||||
|
|
||||||
|
pom {
|
||||||
|
name.set("Tree Data Structure — kotlinx.serialization")
|
||||||
|
description.set("kotlinx.serialization support (TreeNodeDto round-trip) for the tree-structure library.")
|
||||||
|
url.set("https://github.com/AdrianKuta/Tree-Data-Structure")
|
||||||
|
licenses {
|
||||||
|
license {
|
||||||
|
name.set("MIT License")
|
||||||
|
url.set("https://opensource.org/licenses/MIT")
|
||||||
|
distribution.set("repo")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
developers {
|
||||||
|
developer {
|
||||||
|
id.set("AdrianKuta")
|
||||||
|
name.set("Adrian Kuta")
|
||||||
|
email.set("adrian.kuta93@gmail.com")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
scm {
|
||||||
|
url.set("https://github.com/AdrianKuta/Tree-Data-Structure")
|
||||||
|
connection.set("scm:git:https://github.com/AdrianKuta/Tree-Data-Structure.git")
|
||||||
|
developerConnection.set("scm:git:ssh://git@github.com/AdrianKuta/Tree-Data-Structure.git")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
repositories {
|
||||||
|
mavenCentral()
|
||||||
|
}
|
||||||
|
|
||||||
|
dokka {
|
||||||
|
dokkaSourceSets.configureEach {
|
||||||
|
sourceLink {
|
||||||
|
// Resolve this module's GitHub source path relative to the repo root.
|
||||||
|
localDirectory.set(projectDir.resolve("src"))
|
||||||
|
val module = projectDir.relativeTo(rootDir).invariantSeparatorsPath
|
||||||
|
val prefix = if (module.isEmpty()) "" else "$module/"
|
||||||
|
remoteUrl("https://github.com/AdrianKuta/Tree-Data-Structure/blob/master/${prefix}src")
|
||||||
|
remoteLineSuffix.set("#L")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
kotlin {
|
||||||
|
explicitApi()
|
||||||
|
jvmToolchain(21)
|
||||||
|
|
||||||
|
jvm()
|
||||||
|
|
||||||
|
js(IR) {
|
||||||
|
browser()
|
||||||
|
nodejs()
|
||||||
|
}
|
||||||
|
|
||||||
|
@OptIn(ExperimentalWasmDsl::class)
|
||||||
|
wasmJs {
|
||||||
|
browser()
|
||||||
|
nodejs()
|
||||||
|
}
|
||||||
|
|
||||||
|
iosX64()
|
||||||
|
iosArm64()
|
||||||
|
iosSimulatorArm64()
|
||||||
|
|
||||||
|
val hostOs = System.getProperty("os.name")
|
||||||
|
val isMingwX64 = hostOs.startsWith("Windows")
|
||||||
|
when {
|
||||||
|
hostOs == "Mac OS X" -> macosX64("native")
|
||||||
|
hostOs == "Linux" -> linuxX64("native")
|
||||||
|
isMingwX64 -> mingwX64("native")
|
||||||
|
else -> throw GradleException("Host OS is not supported in Kotlin/Native.")
|
||||||
|
}
|
||||||
|
|
||||||
|
sourceSets {
|
||||||
|
commonMain.dependencies {
|
||||||
|
api(project(":"))
|
||||||
|
api(libs.kotlinx.serialization.json)
|
||||||
|
}
|
||||||
|
commonTest.dependencies {
|
||||||
|
implementation(kotlin("test"))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,30 @@
|
|||||||
|
package com.github.adriankuta.datastructure.tree.serialization
|
||||||
|
|
||||||
|
import com.github.adriankuta.datastructure.tree.TreeNode
|
||||||
|
import kotlinx.serialization.Serializable
|
||||||
|
|
||||||
|
/**
|
||||||
|
* A serializable, acyclic view of a [TreeNode] subtree. [TreeNode] itself holds a back-reference to
|
||||||
|
* its parent (a cycle), so it cannot be `@Serializable` directly — convert to/from this DTO instead.
|
||||||
|
*
|
||||||
|
* ```
|
||||||
|
* val json = Json.encodeToString(tree.toDto())
|
||||||
|
* val restored = Json.decodeFromString<TreeNodeDto<String>>(json).toTreeNode()
|
||||||
|
* ```
|
||||||
|
*/
|
||||||
|
@Serializable
|
||||||
|
public data class TreeNodeDto<T>(
|
||||||
|
public val value: T,
|
||||||
|
public val children: List<TreeNodeDto<T>> = emptyList(),
|
||||||
|
)
|
||||||
|
|
||||||
|
/** Converts this subtree into a serializable [TreeNodeDto], preserving values and shape. */
|
||||||
|
public fun <T> TreeNode<T>.toDto(): TreeNodeDto<T> =
|
||||||
|
TreeNodeDto(value, children.map { it.toDto() })
|
||||||
|
|
||||||
|
/** Rebuilds a mutable [TreeNode] tree from this DTO. */
|
||||||
|
public fun <T> TreeNodeDto<T>.toTreeNode(): TreeNode<T> {
|
||||||
|
val node = TreeNode(value)
|
||||||
|
children.forEach { node.addChild(it.toTreeNode()) }
|
||||||
|
return node
|
||||||
|
}
|
||||||
@@ -0,0 +1,40 @@
|
|||||||
|
package com.github.adriankuta.datastructure.tree.serialization
|
||||||
|
|
||||||
|
import com.github.adriankuta.datastructure.tree.structurallyEquals
|
||||||
|
import com.github.adriankuta.datastructure.tree.tree
|
||||||
|
import kotlinx.serialization.encodeToString
|
||||||
|
import kotlinx.serialization.json.Json
|
||||||
|
import kotlin.test.Test
|
||||||
|
import kotlin.test.assertEquals
|
||||||
|
import kotlin.test.assertTrue
|
||||||
|
|
||||||
|
class TreeNodeSerializationTest {
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun roundTripsThroughJson() {
|
||||||
|
val original = tree("World") {
|
||||||
|
child("North America") { child("USA") }
|
||||||
|
child("Europe") {
|
||||||
|
child("Poland")
|
||||||
|
child("Germany")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
val json = Json.encodeToString(original.toDto())
|
||||||
|
val restored = Json.decodeFromString<TreeNodeDto<String>>(json).toTreeNode()
|
||||||
|
|
||||||
|
assertTrue(original.structurallyEquals(restored))
|
||||||
|
}
|
||||||
|
|
||||||
|
@Test
|
||||||
|
fun dtoMirrorsTreeShape() {
|
||||||
|
val dto = tree(1) {
|
||||||
|
child(2)
|
||||||
|
child(3) { child(4) }
|
||||||
|
}.toDto()
|
||||||
|
|
||||||
|
assertEquals(1, dto.value)
|
||||||
|
assertEquals(2, dto.children.size)
|
||||||
|
assertEquals(4, dto.children[1].children[0].value)
|
||||||
|
}
|
||||||
|
}
|
||||||
1
treedatastructure/.gitignore
vendored
@@ -1 +0,0 @@
|
|||||||
/build
|
|
||||||
@@ -1,49 +0,0 @@
|
|||||||
apply plugin: 'com.android.library'
|
|
||||||
apply plugin: 'kotlin-android'
|
|
||||||
apply plugin: 'kotlin-android-extensions'
|
|
||||||
|
|
||||||
afterEvaluate {
|
|
||||||
generateReleaseBuildConfig.enabled = false
|
|
||||||
}
|
|
||||||
|
|
||||||
android {
|
|
||||||
compileSdkVersion 29
|
|
||||||
buildToolsVersion "29.0.2"
|
|
||||||
|
|
||||||
|
|
||||||
defaultConfig {
|
|
||||||
minSdkVersion 15
|
|
||||||
targetSdkVersion 29
|
|
||||||
versionCode 1
|
|
||||||
versionName "1.0.4"
|
|
||||||
|
|
||||||
testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
|
|
||||||
consumerProguardFiles 'consumer-rules.pro'
|
|
||||||
}
|
|
||||||
|
|
||||||
buildTypes {
|
|
||||||
release {
|
|
||||||
minifyEnabled false
|
|
||||||
proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
}
|
|
||||||
|
|
||||||
dependencies {
|
|
||||||
implementation fileTree(dir: 'libs', include: ['*.jar'])
|
|
||||||
implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk8:$kotlin_version"
|
|
||||||
implementation 'androidx.appcompat:appcompat:1.1.0'
|
|
||||||
implementation 'androidx.core:core-ktx:1.1.0'
|
|
||||||
testImplementation 'junit:junit:4.12'
|
|
||||||
androidTestImplementation 'androidx.test.ext:junit:1.1.1'
|
|
||||||
androidTestImplementation 'androidx.test.espresso:espresso-core:3.2.0'
|
|
||||||
}
|
|
||||||
|
|
||||||
ext {
|
|
||||||
PUBLISH_GROUP_ID = 'com.github.adriankuta'
|
|
||||||
PUBLISH_ARTIFACT_ID = 'tree-structure'
|
|
||||||
PUBLISH_VERSION = android.defaultConfig.versionName
|
|
||||||
}
|
|
||||||
|
|
||||||
apply from: "${rootProject.projectDir}/scripts/publish-mavencentral.gradle"
|
|
||||||
21
treedatastructure/proguard-rules.pro
vendored
@@ -1,21 +0,0 @@
|
|||||||
# Add project specific ProGuard rules here.
|
|
||||||
# You can control the set of applied configuration files using the
|
|
||||||
# proguardFiles setting in build.gradle.
|
|
||||||
#
|
|
||||||
# For more details, see
|
|
||||||
# http://developer.android.com/guide/developing/tools/proguard.html
|
|
||||||
|
|
||||||
# If your project uses WebView with JS, uncomment the following
|
|
||||||
# and specify the fully qualified class name to the JavaScript interface
|
|
||||||
# class:
|
|
||||||
#-keepclassmembers class fqcn.of.javascript.interface.for.webview {
|
|
||||||
# public *;
|
|
||||||
#}
|
|
||||||
|
|
||||||
# Uncomment this to preserve the line number information for
|
|
||||||
# debugging stack traces.
|
|
||||||
#-keepattributes SourceFile,LineNumberTable
|
|
||||||
|
|
||||||
# If you keep the line number information, uncomment this to
|
|
||||||
# hide the original source file name.
|
|
||||||
#-renamesourcefileattribute SourceFile
|
|
||||||
@@ -1,24 +0,0 @@
|
|||||||
package com.github.adriankuta.datastructure.tree
|
|
||||||
|
|
||||||
import androidx.test.platform.app.InstrumentationRegistry
|
|
||||||
import androidx.test.ext.junit.runners.AndroidJUnit4
|
|
||||||
|
|
||||||
import org.junit.Test
|
|
||||||
import org.junit.runner.RunWith
|
|
||||||
|
|
||||||
import org.junit.Assert.*
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Instrumented test, which will execute on an Android device.
|
|
||||||
*
|
|
||||||
* See [testing documentation](http://d.android.com/tools/testing).
|
|
||||||
*/
|
|
||||||
@RunWith(AndroidJUnit4::class)
|
|
||||||
class ExampleInstrumentedTest {
|
|
||||||
@Test
|
|
||||||
fun useAppContext() {
|
|
||||||
// Context of the app under test.
|
|
||||||
val appContext = InstrumentationRegistry.getInstrumentation().targetContext
|
|
||||||
assertEquals("com.github.adriankuta.datastructure.tree.test", appContext.packageName)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,2 +0,0 @@
|
|||||||
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
|
|
||||||
package="com.github.adriankuta.datastructure.tree" />
|
|
||||||
@@ -1,63 +0,0 @@
|
|||||||
package com.github.adriankuta.datastructure.tree
|
|
||||||
|
|
||||||
class TreeNode<T>(val value: T) {
|
|
||||||
|
|
||||||
private var parent: TreeNode<T>? = null
|
|
||||||
private val children = mutableListOf<TreeNode<T>>()
|
|
||||||
|
|
||||||
fun addChild(child: TreeNode<T>) {
|
|
||||||
child.parent = this
|
|
||||||
children += child
|
|
||||||
}
|
|
||||||
|
|
||||||
fun removeChild(child: TreeNode<T>): Boolean {
|
|
||||||
if (children.isEmpty()) {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
|
|
||||||
val nestedChildRemoved = children.map {
|
|
||||||
it.removeChild(child)
|
|
||||||
}.reduce { acc, b -> acc or b }
|
|
||||||
|
|
||||||
return children.remove(child) or nestedChildRemoved
|
|
||||||
}
|
|
||||||
|
|
||||||
fun getParent(): TreeNode<T>? = parent
|
|
||||||
|
|
||||||
fun getChildren(): List<TreeNode<T>> = children
|
|
||||||
|
|
||||||
fun size(): Int {
|
|
||||||
if (children.isEmpty())
|
|
||||||
return 0
|
|
||||||
return children.size +
|
|
||||||
children.sumBy { it.size() }
|
|
||||||
|
|
||||||
}
|
|
||||||
|
|
||||||
fun depth(): Int {
|
|
||||||
|
|
||||||
val childrenMaxDepth = children.map { it.depth() }.max() ?: 0
|
|
||||||
return childrenMaxDepth + 1
|
|
||||||
}
|
|
||||||
|
|
||||||
override fun toString(): String {
|
|
||||||
val stringBuilder = StringBuilder()
|
|
||||||
print(stringBuilder, "", "")
|
|
||||||
return stringBuilder.toString()
|
|
||||||
}
|
|
||||||
|
|
||||||
private fun print(stringBuilder: StringBuilder, prefix: String, childrenPrefix: String) {
|
|
||||||
stringBuilder.append(prefix)
|
|
||||||
stringBuilder.append(value)
|
|
||||||
stringBuilder.append('\n')
|
|
||||||
val childIterator = children.iterator()
|
|
||||||
while (childIterator.hasNext()) {
|
|
||||||
val node = childIterator.next()
|
|
||||||
if(childIterator.hasNext()) {
|
|
||||||
node.print(stringBuilder, "$childrenPrefix├── ", "$childrenPrefix│ ")
|
|
||||||
} else {
|
|
||||||
node.print(stringBuilder, "$childrenPrefix└── ", "$childrenPrefix ")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,3 +0,0 @@
|
|||||||
<resources>
|
|
||||||
<string name="app_name">Tree Data Structure</string>
|
|
||||||
</resources>
|
|
||||||
@@ -1,17 +0,0 @@
|
|||||||
package com.github.adriankuta.datastructure.tree
|
|
||||||
|
|
||||||
import org.junit.Test
|
|
||||||
|
|
||||||
import org.junit.Assert.*
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Example local unit test, which will execute on the development machine (host).
|
|
||||||
*
|
|
||||||
* See [testing documentation](http://d.android.com/tools/testing).
|
|
||||||
*/
|
|
||||||
class ExampleUnitTest {
|
|
||||||
@Test
|
|
||||||
fun addition_isCorrect() {
|
|
||||||
assertEquals(4, 2 + 2)
|
|
||||||
}
|
|
||||||
}
|
|
||||||