├── .idea
    ├── fileTemplates
    │   ├── Advent of Code.kt.child.0.txt
    │   └── Advent of Code.kt
    └── file.template.settings.xml
├── .gitignore
├── .github
    ├── readme
    │   ├── run.png
    │   ├── cover.png
    │   └── livestream.png
    ├── template-cleanup
    │   ├── settings.gradle.kts
    │   └── README.md
    └── workflows
    │   └── template-cleanup.yml
├── gradle
    └── wrapper
    │   ├── gradle-wrapper.jar
    │   └── gradle-wrapper.properties
├── settings.gradle.kts
├── src
    ├── Utils.kt
    └── Day01.kt
├── gradlew.bat
├── README.md
├── gradlew
└── LICENSE


/.idea/fileTemplates/Advent of Code.kt.child.0.txt:
--------------------------------------------------------------------------------
1 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | .gradle
2 | .idea
3 | .kotlin/
4 | build
5 | src/**/*.txt
6 | local.properties
7 | 


--------------------------------------------------------------------------------
/.github/readme/run.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/kotlin-hands-on/advent-of-code-kotlin-template/HEAD/.github/readme/run.png


--------------------------------------------------------------------------------
/.github/readme/cover.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/kotlin-hands-on/advent-of-code-kotlin-template/HEAD/.github/readme/cover.png


--------------------------------------------------------------------------------
/.github/readme/livestream.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/kotlin-hands-on/advent-of-code-kotlin-template/HEAD/.github/readme/livestream.png


--------------------------------------------------------------------------------
/gradle/wrapper/gradle-wrapper.jar:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/kotlin-hands-on/advent-of-code-kotlin-template/HEAD/gradle/wrapper/gradle-wrapper.jar


--------------------------------------------------------------------------------
/settings.gradle.kts:
--------------------------------------------------------------------------------
1 | rootProject.name = "Advent of Code Kotlin Template"
2 | 
3 | dependencyResolutionManagement {
4 |     repositories {
5 |         mavenCentral()
6 |     }
7 | }
8 | 


--------------------------------------------------------------------------------
/.github/template-cleanup/settings.gradle.kts:
--------------------------------------------------------------------------------
1 | rootProject.name = "%NAME%"
2 | 
3 | dependencyResolutionManagement {
4 |     repositories {
5 |         mavenCentral()
6 |     }
7 | }
8 | 


--------------------------------------------------------------------------------
/gradle/wrapper/gradle-wrapper.properties:
--------------------------------------------------------------------------------
1 | distributionBase=GRADLE_USER_HOME
2 | distributionPath=wrapper/dists
3 | distributionUrl=https\://services.gradle.org/distributions/gradle-9.2.1-bin.zip
4 | networkTimeout=10000
5 | validateDistributionUrl=true
6 | zipStoreBase=GRADLE_USER_HOME
7 | zipStorePath=wrapper/dists
8 | 


--------------------------------------------------------------------------------
/.idea/fileTemplates/Advent of Code.kt:
--------------------------------------------------------------------------------
 1 | #set( $Code = "bar" )
 2 | fun main() {
 3 |     fun part1(input: List<String>): Int {
 4 |         return input.size
 5 |     }
 6 | 
 7 |     fun part2(input: List<String>): Int {
 8 |         return input.size
 9 |     }
10 | 
11 |     check(part1(listOf("...")) == 1)
12 | 
13 |     val input = readInput("Day$Day")
14 |     part1(input).println()
15 |     part2(input).println()
16 | }
17 | 


--------------------------------------------------------------------------------
/src/Utils.kt:
--------------------------------------------------------------------------------
 1 | import java.math.BigInteger
 2 | import java.security.MessageDigest
 3 | import kotlin.io.path.Path
 4 | import kotlin.io.path.readText
 5 | 
 6 | /**
 7 |  * Reads lines from the given input txt file.
 8 |  */
 9 | fun readInput(name: String) = Path("src/$name.txt").readText().trim().lines()
10 | 
11 | /**
12 |  * Converts string to md5 hash.
13 |  */
14 | fun String.md5() = BigInteger(1, MessageDigest.getInstance("MD5").digest(toByteArray()))
15 |     .toString(16)
16 |     .padStart(32, '0')
17 | 
18 | /**
19 |  * The cleaner shorthand for printing output.
20 |  */
21 | fun Any?.println() = println(this)
22 | 


--------------------------------------------------------------------------------
/.idea/file.template.settings.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | <project version="4">
 3 |   <component name="ExportableFileTemplateSettings">
 4 |     <default_templates>
 5 |       <template name="Advent of Code.kt" file-name="Day${Day}" reformat="true" live-template-enabled="true">
 6 |         <template name="Advent of Code.kt.child.0.txt" file-name="Day${Day}" reformat="true" live-template-enabled="false" />
 7 |       </template>
 8 |       <template name="Advent of Code.kt.child.0.txt" file-name="Day${Day}" reformat="true" live-template-enabled="false" />
 9 |     </default_templates>
10 |   </component>
11 | </project>


--------------------------------------------------------------------------------
/src/Day01.kt:
--------------------------------------------------------------------------------
 1 | fun main() {
 2 |     fun part1(input: List<String>): Int {
 3 |         return input.size
 4 |     }
 5 | 
 6 |     fun part2(input: List<String>): Int {
 7 |         return input.size
 8 |     }
 9 | 
10 |     // Test if implementation meets criteria from the description, like:
11 |     check(part1(listOf("test_input")) == 1)
12 | 
13 |     // Or read a large test input from the `src/Day01_test.txt` file:
14 |     val testInput = readInput("Day01_test")
15 |     check(part1(testInput) == 1)
16 | 
17 |     // Read the input from the `src/Day01.txt` file.
18 |     val input = readInput("Day01")
19 |     part1(input).println()
20 |     part2(input).println()
21 | }
22 | 


--------------------------------------------------------------------------------
/.github/template-cleanup/README.md:
--------------------------------------------------------------------------------
 1 | # %NAME%
 2 | 
 3 | Welcome to the Advent of Code[^aoc] Kotlin project created by [%ACTOR%][github] using the [Advent of Code Kotlin Template][template] delivered by JetBrains.
 4 | 
 5 | In this repository, %ACTOR% is about to provide solutions for the puzzles using [Kotlin][kotlin] language.
 6 | 
 7 | If you're stuck with Kotlin-specific questions or anything related to this template, check out the following resources:
 8 | 
 9 | - [Kotlin docs][docs]
10 | - [Kotlin Slack][slack]
11 | - Template [issue tracker][issues]
12 | 
13 | 
14 | [^aoc]:
15 |     [Advent of Code][aoc] – An annual event of Christmas-oriented programming challenges started December 2015.
16 |     Every year since then, beginning on the first day of December, a programming puzzle is published every day for twenty-five days.
17 |     You can solve the puzzle and provide an answer using the language of your choice.
18 | 
19 | [aoc]: https://adventofcode.com
20 | [docs]: https://kotlinlang.org/docs/home.html
21 | [github]: https://github.com/%ACTOR%
22 | [issues]: https://github.com/kotlin-hands-on/advent-of-code-kotlin-template/issues
23 | [kotlin]: https://kotlinlang.org
24 | [slack]: https://surveys.jetbrains.com/s3/kotlin-slack-sign-up
25 | [template]: https://github.com/kotlin-hands-on/advent-of-code-kotlin-template
26 | 


--------------------------------------------------------------------------------
/.github/workflows/template-cleanup.yml:
--------------------------------------------------------------------------------
 1 | # GitHub Actions Workflow responsible for cleaning up the Advent of Code Kotlin Template repository from
 2 | # the template-specific files and configurations. This workflow is supposed to be triggered automatically
 3 | # when a new template-based repository has been created.
 4 | 
 5 | name: Template Cleanup
 6 | on:
 7 |   push:
 8 |     branches: [main]
 9 | 
10 | jobs:
11 | 
12 |   # Run cleaning process only if workflow is triggered by the non-"advent-of-code-kotlin-template" repository.
13 |   template-cleanup:
14 |     name: Template Cleanup
15 |     runs-on: ubuntu-latest
16 |     if: github.event.repository.name != 'advent-of-code-kotlin-template'
17 |     permissions:
18 |       contents: write
19 |     steps:
20 | 
21 |       # Check out current repository
22 |       - name: Fetch Sources
23 |         uses: actions/checkout@v4
24 | 
25 |       # Cleanup project
26 |       - name: Cleanup
27 |         run: |
28 |           export LC_CTYPE=C
29 |           export LANG=C
30 | 
31 |           # Prepare variables
32 |           NAME="${GITHUB_REPOSITORY##*/}"
33 |           ACTOR=$(echo $GITHUB_ACTOR | tr '[:upper:]' '[:lower:]')
34 |           SAFE_NAME=$(echo $NAME | sed 's/[^a-zA-Z0-9]//g' | tr '[:upper:]' '[:lower:]')
35 |           SAFE_ACTOR=$(echo $ACTOR | sed 's/[^a-zA-Z0-9]//g' | tr '[:upper:]' '[:lower:]')
36 |           GROUP="com.github.$SAFE_ACTOR.$SAFE_NAME"
37 | 
38 |           # Replace placeholders in the template-cleanup files
39 |           sed -i "s/%ACTOR%/$ACTOR/g" .github/template-cleanup/*
40 |           sed -i "s/%NAME%/$NAME/g" .github/template-cleanup/*
41 |           sed -i "s/%REPOSITORY%/${GITHUB_REPOSITORY/\//\\/}/g" .github/template-cleanup/*
42 |           sed -i "s/%GROUP%/$GROUP/g" .github/template-cleanup/*
43 | 
44 |           # Move content
45 |           cp -R .github/template-cleanup/* .
46 | 
47 |           # Cleanup
48 |           rm -rf \
49 |             .github/readme \
50 |             .github/template-cleanup \
51 |             .github/workflows/template-cleanup.yml \
52 |             LICENSE
53 |           
54 |           # Remove leftover empty directories
55 |           find . -type d -empty -delete
56 | 
57 |       # Commit modified files
58 |       - name: Commit files
59 |         run: |
60 |           git config --local user.email "action@github.com"
61 |           git config --local user.name "GitHub Action"
62 |           git add .
63 |           git commit -m "Template cleanup"
64 | 
65 |       # Push changes
66 |       - name: Push changes
67 |         uses: ad-m/github-push-action@master
68 |         with:
69 |           branch: main
70 |           github_token: ${{ secrets.GITHUB_TOKEN }}
71 | 


--------------------------------------------------------------------------------
/gradlew.bat:
--------------------------------------------------------------------------------
 1 | @rem
 2 | @rem Copyright 2015 the original author or authors.
 3 | @rem
 4 | @rem Licensed under the Apache License, Version 2.0 (the "License");
 5 | @rem you may not use this file except in compliance with the License.
 6 | @rem You may obtain a copy of the License at
 7 | @rem
 8 | @rem      https://www.apache.org/licenses/LICENSE-2.0
 9 | @rem
10 | @rem Unless required by applicable law or agreed to in writing, software
11 | @rem distributed under the License is distributed on an "AS IS" BASIS,
12 | @rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 | @rem See the License for the specific language governing permissions and
14 | @rem limitations under the License.
15 | @rem
16 | @rem SPDX-License-Identifier: Apache-2.0
17 | @rem
18 | 
19 | @if "%DEBUG%"=="" @echo off
20 | @rem ##########################################################################
21 | @rem
22 | @rem  Gradle startup script for Windows
23 | @rem
24 | @rem ##########################################################################
25 | 
26 | @rem Set local scope for the variables with windows NT shell
27 | if "%OS%"=="Windows_NT" setlocal
28 | 
29 | set DIRNAME=%~dp0
30 | if "%DIRNAME%"=="" set DIRNAME=.
31 | @rem This is normally unused
32 | set APP_BASE_NAME=%~n0
33 | set APP_HOME=%DIRNAME%
34 | 
35 | @rem Resolve any "." and ".." in APP_HOME to make it shorter.
36 | for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi
37 | 
38 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
39 | set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m"
40 | 
41 | @rem Find java.exe
42 | if defined JAVA_HOME goto findJavaFromJavaHome
43 | 
44 | set JAVA_EXE=java.exe
45 | %JAVA_EXE% -version >NUL 2>&1
46 | if %ERRORLEVEL% equ 0 goto execute
47 | 
48 | echo. 1>&2
49 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 1>&2
50 | echo. 1>&2
51 | echo Please set the JAVA_HOME variable in your environment to match the 1>&2
52 | echo location of your Java installation. 1>&2
53 | 
54 | goto fail
55 | 
56 | :findJavaFromJavaHome
57 | set JAVA_HOME=%JAVA_HOME:"=%
58 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe
59 | 
60 | if exist "%JAVA_EXE%" goto execute
61 | 
62 | echo. 1>&2
63 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 1>&2
64 | echo. 1>&2
65 | echo Please set the JAVA_HOME variable in your environment to match the 1>&2
66 | echo location of your Java installation. 1>&2
67 | 
68 | goto fail
69 | 
70 | :execute
71 | @rem Setup the command line
72 | 
73 | 
74 | 
75 | @rem Execute Gradle
76 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -jar "%APP_HOME%\gradle\wrapper\gradle-wrapper.jar" %*
77 | 
78 | :end
79 | @rem End local scope for the variables with windows NT shell
80 | if %ERRORLEVEL% equ 0 goto mainEnd
81 | 
82 | :fail
83 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of
84 | rem the _cmd.exe /c_ return code!
85 | set EXIT_CODE=%ERRORLEVEL%
86 | if %EXIT_CODE% equ 0 set EXIT_CODE=1
87 | if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE%
88 | exit /b %EXIT_CODE%
89 | 
90 | :mainEnd
91 | if "%OS%"=="Windows_NT" endlocal
92 | 
93 | :omega
94 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
  1 | # Advent of Code Kotlin Template
  2 | 
  3 | [Advent of Code][aoc] – an annual event in December since 2015.
  4 | Every year since then, with the first day of December, a programming puzzles contest is published every day for twenty-five days.
  5 | A set of Christmas-oriented challenges provides any input you have to use to answer using the language of your choice.
  6 | We offer you a template prepared to use with [Kotlin][kotlin] language within this repository.
  7 | 
  8 | ![][file:cover]
  9 | 
 10 | ## Live Streams
 11 | 
 12 | Join us as we solve the Advent of Code challenges live on stream!
 13 | Follow along to see step-by-step solutions, participate in problem-solving, and learn new strategies to tackle the puzzles.
 14 | Whether you're stuck on a particular problem or just looking to improve your Kotlin skills, our live streams are here to help.
 15 | 
 16 | [Watch the live streams here!][youtube-playlist]
 17 | 
 18 | [![][file:livestream]][youtube-playlist]
 19 | 
 20 | ## Workflow
 21 | **Advent of Code Kotlin Template** is a particular type of GitHub repository that lets you speed up the setup phase and start writing your AoC solutions immediately.
 22 | 
 23 | The general idea is straightforward – to create a new project based on this template, you need to log in to your GitHub account and use the **Use this template** green button.
 24 | And remember – **do not fork it!**
 25 | 
 26 | After creating a new project based on this template in your account, a dedicated GitHub Actions workflow will start and clean up the code from redundant files.
 27 | It will also personalize code to use your username and project name in namespaces and Gradle properties.
 28 | How cool is that?
 29 | 
 30 | You can clone it within the IntelliJ IDEA whenever the [@actions-user][actions-user] actor pushes the second commit to your repository.
 31 | 
 32 | > [!IMPORTANT]
 33 | >
 34 | > Right after opening the project in IntelliJ IDEA, verify if you use at least **Java 11** as Project SDK.
 35 | > To do that, visit [Project Structure Settings][docs-project-structure] (<kbd>⌘ Cmd</kbd><kbd>;</kbd> on macOS or <kbd>Ctrl</kbd><kbd>Alt</kbd><kbd>Shift</kbd><kbd>S</kbd> on Windows/Linux).
 36 | 
 37 | From now on, everything's in your hands!
 38 | Join the [Advent of Code][aoc] contest to solve the *Day 01* as soon as it is published.
 39 | 
 40 | Copy the `Day01.kt` solution file for the following days and increment the day number.
 41 | 
 42 | > [!NOTE]
 43 | >
 44 | > Remember to join the Kotlin contest!
 45 | >
 46 | > To do that, edit your project's _About_ section with ⚙️ icon and add the `aoc-2025-in-kotlin` topic to your project.
 47 | >
 48 | > **We will find your repository and count you in our giveaway.**
 49 | 
 50 | ## Setup
 51 | 
 52 | After you create a new project based on the current template repository using the **Use this template** button, a bare minimal scaffold will appear in your GitHub account with the following structure:
 53 | 
 54 | ```
 55 | .
 56 | ├── README.md               README file
 57 | ├── build.gradle.kts        Gradle configuration created with Kotlin DSL
 58 | ├── settings.gradle.kts     Gradle project settings
 59 | ├── gradle*                 Gradle wrapper files
 60 | └── src
 61 |     ├── Day01.kt            An empty implementation for the first AoC day
 62 |     ├── Utils.kt            A set of utility methods shared across your days
 63 |     │                       
 64 |     │                       (create those files manually)
 65 |     ├── Day01.txt           An empty file for the Day 01 input data
 66 |     └── Day01_test.txt      An optional Day 01 test input data used for checks
 67 | ```
 68 | 
 69 | > [!NOTE]
 70 | >
 71 | > All task input files (`src/*.txt`) are excluded from the repository with `.gitignore` – we should not post them publicly, as [Eric Wastl requested for](https://twitter.com/ericwastl/status/1465805354214830081).
 72 | 
 73 | When the first puzzle appears, go to the `Day01.kt`, and for each `part1` and `part2` function, provide an algorithm implementation using the `input` data loaded from the `src/Day01.txt` file.
 74 | This input data is common for both parts, and you can find it at the bottom of each day on the [Advent of Code][aoc] page.
 75 | 
 76 | To read the input data, you can go with the `readInput(name: String)` utility method provided in the [`Utils.kt`][file:utils] file, like:
 77 | 
 78 | ```kotlin
 79 | fun main() {
 80 |     fun part1(input: List<String>): Int {
 81 |         return input.size
 82 |     }
 83 | 
 84 |     val input = readInput("Day01")
 85 |     println(part1(input))
 86 | }
 87 | ```
 88 | 
 89 | ## Running
 90 | 
 91 | To call the algorithm you're implementing, click the green Play button next to the `fun main()` definition.
 92 | 
 93 | ![img.png](.github/readme/run.png)
 94 | 
 95 | > [!IMPORTANT]
 96 | >
 97 | > Create relevant files Before running tasks or tests, like: `src/Day01.txt` or `src/Day01_test.txt`.
 98 | 
 99 | The [`Utils.kt`][file:utils] file also contains the `String.md5()` method for generating MD5 hash out of the given string and expects more helper functions for the sake of the [KISS principle][kiss].
100 | 
101 | Each puzzle describes some test conditions, a small portion of the information that helps check if the produced value for the given test input is valid.
102 | To handle that case, you can put such an input into a separate file and perform a check against the output, like:
103 | 
104 | ```kotlin
105 | fun main() {
106 |     // ...
107 |     
108 |     val testInput = readInput("Day01_test")
109 |     check(part1(testInput) == 13)
110 | }
111 | ```
112 | 
113 | The current approach of providing both `part1` and `part2` solutions within the single `Day##.kt` file may sometimes bring a disadvantage due to the first solution calculation when we expect to work on the second part only.
114 | With simple cases that don't consume too much of your time and resources that can be almost unnoticeable, but when the solution takes seconds, it is worth considering breaking the daily solution into two separated pieces, like `Day07_part1.kt` and `Day07_part2.kt`.
115 | 
116 | The final result of your algorithm will be printed on the screen so that you can pass it to the Advent of Code website.
117 | 
118 | To go with the next day, place the `Day02.txt` file into the `src` with relevant input data and create a `Day02.kt` file with a similar code scaffold:
119 | 
120 | ```kotlin
121 | fun main() {
122 |     fun part1(input: List<String>): Int {
123 |         return 0
124 |     }
125 | 
126 |     fun part2(input: List<String>): Int {
127 |         return 0
128 |     }
129 | 
130 |     val input = readInput("Day02")
131 |     println(part1(input))
132 |     println(part2(input))
133 | }
134 | ```
135 | 
136 | > [!NOTE]
137 | >
138 | > There is a fork of this repository available that utilizes the Amper tool for project configuration, recently [introduced by JetBrains][amper].
139 | >
140 | > For more, see [Advent of Code Kotlin Template — Amper][amper-template] project.
141 | 
142 | ## Getting help
143 | 
144 | If you are stuck with Kotlin-specific questions or anything related to this template, check out the following resources:
145 | 
146 | - [Kotlin docs][docs]
147 | - [Kotlin Slack][slack]
148 | - Template [issue tracker][issues]
149 | 
150 | 
151 | [actions-user]: https://github.com/actions-user
152 | [aoc]: https://adventofcode.com
153 | [amper]: https://blog.jetbrains.com/blog/2023/11/09/amper-improving-the-build-tooling-user-experience/
154 | [amper-template]: https://github.com/kotlin-hands-on/advent-of-code-kotlin-template-amper
155 | [docs]: https://kotlinlang.org/docs/home.html
156 | [docs-project-structure]: https://www.jetbrains.com/help/idea/project-settings-and-structure.html
157 | [issues]: https://github.com/kotlin-hands-on/advent-of-code-kotlin-template/issues
158 | [kiss]: https://en.wikipedia.org/wiki/KISS_principle
159 | [kotlin]: https://kotlinlang.org
160 | [slack]: https://surveys.jetbrains.com/s3/kotlin-slack-sign-up
161 | [file:cover]: .github/readme/cover.png
162 | [file:livestream]: .github/readme/livestream.png
163 | [file:utils]: src/Utils.kt
164 | [youtube-playlist]: https://www.youtube.com/playlist?list=PLlFc5cFwUnmwHaD3-qeoLHnho_PY2g9JX
165 | 


--------------------------------------------------------------------------------
/gradlew:
--------------------------------------------------------------------------------
  1 | #!/bin/sh
  2 | 
  3 | #
  4 | # Copyright © 2015 the original authors.
  5 | #
  6 | # Licensed under the Apache License, Version 2.0 (the "License");
  7 | # you may not use this file except in compliance with the License.
  8 | # You may obtain a copy of the License at
  9 | #
 10 | #      https://www.apache.org/licenses/LICENSE-2.0
 11 | #
 12 | # Unless required by applicable law or agreed to in writing, software
 13 | # distributed under the License is distributed on an "AS IS" BASIS,
 14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 15 | # See the License for the specific language governing permissions and
 16 | # limitations under the License.
 17 | #
 18 | # SPDX-License-Identifier: Apache-2.0
 19 | #
 20 | 
 21 | ##############################################################################
 22 | #
 23 | #   Gradle start up script for POSIX generated by Gradle.
 24 | #
 25 | #   Important for running:
 26 | #
 27 | #   (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is
 28 | #       noncompliant, but you have some other compliant shell such as ksh or
 29 | #       bash, then to run this script, type that shell name before the whole
 30 | #       command line, like:
 31 | #
 32 | #           ksh Gradle
 33 | #
 34 | #       Busybox and similar reduced shells will NOT work, because this script
 35 | #       requires all of these POSIX shell features:
 36 | #         * functions;
 37 | #         * expansions «$var», «${var}», «${var:-default}», «${var+SET}»,
 38 | #           «${var#prefix}», «${var%suffix}», and «$( cmd )»;
 39 | #         * compound commands having a testable exit status, especially «case»;
 40 | #         * various built-in commands including «command», «set», and «ulimit».
 41 | #
 42 | #   Important for patching:
 43 | #
 44 | #   (2) This script targets any POSIX shell, so it avoids extensions provided
 45 | #       by Bash, Ksh, etc; in particular arrays are avoided.
 46 | #
 47 | #       The "traditional" practice of packing multiple parameters into a
 48 | #       space-separated string is a well documented source of bugs and security
 49 | #       problems, so this is (mostly) avoided, by progressively accumulating
 50 | #       options in "$@", and eventually passing that to Java.
 51 | #
 52 | #       Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS,
 53 | #       and GRADLE_OPTS) rely on word-splitting, this is performed explicitly;
 54 | #       see the in-line comments for details.
 55 | #
 56 | #       There are tweaks for specific operating systems such as AIX, CygWin,
 57 | #       Darwin, MinGW, and NonStop.
 58 | #
 59 | #   (3) This script is generated from the Groovy template
 60 | #       https://github.com/gradle/gradle/blob/HEAD/platforms/jvm/plugins-application/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
 61 | #       within the Gradle project.
 62 | #
 63 | #       You can find Gradle at https://github.com/gradle/gradle/.
 64 | #
 65 | ##############################################################################
 66 | 
 67 | # Attempt to set APP_HOME
 68 | 
 69 | # Resolve links: $0 may be a link
 70 | app_path=$0
 71 | 
 72 | # Need this for daisy-chained symlinks.
 73 | while
 74 |     APP_HOME=${app_path%"${app_path##*/}"}  # leaves a trailing /; empty if no leading path
 75 |     [ -h "$app_path" ]
 76 | do
 77 |     ls=$( ls -ld "$app_path" )
 78 |     link=${ls#*' -> '}
 79 |     case $link in             #(
 80 |       /*)   app_path=$link ;; #(
 81 |       *)    app_path=$APP_HOME$link ;;
 82 |     esac
 83 | done
 84 | 
 85 | # This is normally unused
 86 | # shellcheck disable=SC2034
 87 | APP_BASE_NAME=${0##*/}
 88 | # Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036)
 89 | APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s\n' "$PWD" ) || exit
 90 | 
 91 | # Use the maximum available, or set MAX_FD != -1 to use that value.
 92 | MAX_FD=maximum
 93 | 
 94 | warn () {
 95 |     echo "$*"
 96 | } >&2
 97 | 
 98 | die () {
 99 |     echo
100 |     echo "$*"
101 |     echo
102 |     exit 1
103 | } >&2
104 | 
105 | # OS specific support (must be 'true' or 'false').
106 | cygwin=false
107 | msys=false
108 | darwin=false
109 | nonstop=false
110 | case "$( uname )" in                #(
111 |   CYGWIN* )         cygwin=true  ;; #(
112 |   Darwin* )         darwin=true  ;; #(
113 |   MSYS* | MINGW* )  msys=true    ;; #(
114 |   NONSTOP* )        nonstop=true ;;
115 | esac
116 | 
117 | 
118 | 
119 | # Determine the Java command to use to start the JVM.
120 | if [ -n "$JAVA_HOME" ] ; then
121 |     if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
122 |         # IBM's JDK on AIX uses strange locations for the executables
123 |         JAVACMD=$JAVA_HOME/jre/sh/java
124 |     else
125 |         JAVACMD=$JAVA_HOME/bin/java
126 |     fi
127 |     if [ ! -x "$JAVACMD" ] ; then
128 |         die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
129 | 
130 | Please set the JAVA_HOME variable in your environment to match the
131 | location of your Java installation."
132 |     fi
133 | else
134 |     JAVACMD=java
135 |     if ! command -v java >/dev/null 2>&1
136 |     then
137 |         die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
138 | 
139 | Please set the JAVA_HOME variable in your environment to match the
140 | location of your Java installation."
141 |     fi
142 | fi
143 | 
144 | # Increase the maximum file descriptors if we can.
145 | if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
146 |     case $MAX_FD in #(
147 |       max*)
148 |         # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked.
149 |         # shellcheck disable=SC2039,SC3045
150 |         MAX_FD=$( ulimit -H -n ) ||
151 |             warn "Could not query maximum file descriptor limit"
152 |     esac
153 |     case $MAX_FD in  #(
154 |       '' | soft) :;; #(
155 |       *)
156 |         # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked.
157 |         # shellcheck disable=SC2039,SC3045
158 |         ulimit -n "$MAX_FD" ||
159 |             warn "Could not set maximum file descriptor limit to $MAX_FD"
160 |     esac
161 | fi
162 | 
163 | # Collect all arguments for the java command, stacking in reverse order:
164 | #   * args from the command line
165 | #   * the main class name
166 | #   * -classpath
167 | #   * -D...appname settings
168 | #   * --module-path (only if needed)
169 | #   * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables.
170 | 
171 | # For Cygwin or MSYS, switch paths to Windows format before running java
172 | if "$cygwin" || "$msys" ; then
173 |     APP_HOME=$( cygpath --path --mixed "$APP_HOME" )
174 | 
175 |     JAVACMD=$( cygpath --unix "$JAVACMD" )
176 | 
177 |     # Now convert the arguments - kludge to limit ourselves to /bin/sh
178 |     for arg do
179 |         if
180 |             case $arg in                                #(
181 |               -*)   false ;;                            # don't mess with options #(
182 |               /?*)  t=${arg#/} t=/${t%%/*}              # looks like a POSIX filepath
183 |                     [ -e "$t" ] ;;                      #(
184 |               *)    false ;;
185 |             esac
186 |         then
187 |             arg=$( cygpath --path --ignore --mixed "$arg" )
188 |         fi
189 |         # Roll the args list around exactly as many times as the number of
190 |         # args, so each arg winds up back in the position where it started, but
191 |         # possibly modified.
192 |         #
193 |         # NB: a `for` loop captures its iteration list before it begins, so
194 |         # changing the positional parameters here affects neither the number of
195 |         # iterations, nor the values presented in `arg`.
196 |         shift                   # remove old arg
197 |         set -- "$@" "$arg"      # push replacement arg
198 |     done
199 | fi
200 | 
201 | 
202 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
203 | DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
204 | 
205 | # Collect all arguments for the java command:
206 | #   * DEFAULT_JVM_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments,
207 | #     and any embedded shellness will be escaped.
208 | #   * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be
209 | #     treated as '${Hostname}' itself on the command line.
210 | 
211 | set -- \
212 |         "-Dorg.gradle.appname=$APP_BASE_NAME" \
213 |         -jar "$APP_HOME/gradle/wrapper/gradle-wrapper.jar" \
214 |         "$@"
215 | 
216 | # Stop when "xargs" is not available.
217 | if ! command -v xargs >/dev/null 2>&1
218 | then
219 |     die "xargs is not available"
220 | fi
221 | 
222 | # Use "xargs" to parse quoted args.
223 | #
224 | # With -n1 it outputs one arg per line, with the quotes and backslashes removed.
225 | #
226 | # In Bash we could simply go:
227 | #
228 | #   readarray ARGS < <( xargs -n1 <<<"$var" ) &&
229 | #   set -- "${ARGS[@]}" "$@"
230 | #
231 | # but POSIX shell has neither arrays nor command substitution, so instead we
232 | # post-process each arg (as a line of input to sed) to backslash-escape any
233 | # character that might be a shell metacharacter, then use eval to reverse
234 | # that process (while maintaining the separation between arguments), and wrap
235 | # the whole thing up as a single "set" statement.
236 | #
237 | # This will of course break if any of these variables contains a newline or
238 | # an unmatched quote.
239 | #
240 | 
241 | eval "set -- $(
242 |         printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" |
243 |         xargs -n1 |
244 |         sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' |
245 |         tr '\n' ' '
246 |     )" '"$@"'
247 | 
248 | exec "$JAVACMD" "$@"
249 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
  1 |                                  Apache License
  2 |                            Version 2.0, January 2004
  3 |                         http://www.apache.org/licenses/
  4 | 
  5 |    TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
  6 | 
  7 |    1. Definitions.
  8 | 
  9 |       "License" shall mean the terms and conditions for use, reproduction,
 10 |       and distribution as defined by Sections 1 through 9 of this document.
 11 | 
 12 |       "Licensor" shall mean the copyright owner or entity authorized by
 13 |       the copyright owner that is granting the License.
 14 | 
 15 |       "Legal Entity" shall mean the union of the acting entity and all
 16 |       other entities that control, are controlled by, or are under common
 17 |       control with that entity. For the purposes of this definition,
 18 |       "control" means (i) the power, direct or indirect, to cause the
 19 |       direction or management of such entity, whether by contract or
 20 |       otherwise, or (ii) ownership of fifty percent (50%) or more of the
 21 |       outstanding shares, or (iii) beneficial ownership of such entity.
 22 | 
 23 |       "You" (or "Your") shall mean an individual or Legal Entity
 24 |       exercising permissions granted by this License.
 25 | 
 26 |       "Source" form shall mean the preferred form for making modifications,
 27 |       including but not limited to software source code, documentation
 28 |       source, and configuration files.
 29 | 
 30 |       "Object" form shall mean any form resulting from mechanical
 31 |       transformation or translation of a Source form, including but
 32 |       not limited to compiled object code, generated documentation,
 33 |       and conversions to other media types.
 34 | 
 35 |       "Work" shall mean the work of authorship, whether in Source or
 36 |       Object form, made available under the License, as indicated by a
 37 |       copyright notice that is included in or attached to the work
 38 |       (an example is provided in the Appendix below).
 39 | 
 40 |       "Derivative Works" shall mean any work, whether in Source or Object
 41 |       form, that is based on (or derived from) the Work and for which the
 42 |       editorial revisions, annotations, elaborations, or other modifications
 43 |       represent, as a whole, an original work of authorship. For the purposes
 44 |       of this License, Derivative Works shall not include works that remain
 45 |       separable from, or merely link (or bind by name) to the interfaces of,
 46 |       the Work and Derivative Works thereof.
 47 | 
 48 |       "Contribution" shall mean any work of authorship, including
 49 |       the original version of the Work and any modifications or additions
 50 |       to that Work or Derivative Works thereof, that is intentionally
 51 |       submitted to Licensor for inclusion in the Work by the copyright owner
 52 |       or by an individual or Legal Entity authorized to submit on behalf of
 53 |       the copyright owner. For the purposes of this definition, "submitted"
 54 |       means any form of electronic, verbal, or written communication sent
 55 |       to the Licensor or its representatives, including but not limited to
 56 |       communication on electronic mailing lists, source code control systems,
 57 |       and issue tracking systems that are managed by, or on behalf of, the
 58 |       Licensor for the purpose of discussing and improving the Work, but
 59 |       excluding communication that is conspicuously marked or otherwise
 60 |       designated in writing by the copyright owner as "Not a Contribution."
 61 | 
 62 |       "Contributor" shall mean Licensor and any individual or Legal Entity
 63 |       on behalf of whom a Contribution has been received by Licensor and
 64 |       subsequently incorporated within the Work.
 65 | 
 66 |    2. Grant of Copyright License. Subject to the terms and conditions of
 67 |       this License, each Contributor hereby grants to You a perpetual,
 68 |       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
 69 |       copyright license to reproduce, prepare Derivative Works of,
 70 |       publicly display, publicly perform, sublicense, and distribute the
 71 |       Work and such Derivative Works in Source or Object form.
 72 | 
 73 |    3. Grant of Patent License. Subject to the terms and conditions of
 74 |       this License, each Contributor hereby grants to You a perpetual,
 75 |       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
 76 |       (except as stated in this section) patent license to make, have made,
 77 |       use, offer to sell, sell, import, and otherwise transfer the Work,
 78 |       where such license applies only to those patent claims licensable
 79 |       by such Contributor that are necessarily infringed by their
 80 |       Contribution(s) alone or by combination of their Contribution(s)
 81 |       with the Work to which such Contribution(s) was submitted. If You
 82 |       institute patent litigation against any entity (including a
 83 |       cross-claim or counterclaim in a lawsuit) alleging that the Work
 84 |       or a Contribution incorporated within the Work constitutes direct
 85 |       or contributory patent infringement, then any patent licenses
 86 |       granted to You under this License for that Work shall terminate
 87 |       as of the date such litigation is filed.
 88 | 
 89 |    4. Redistribution. You may reproduce and distribute copies of the
 90 |       Work or Derivative Works thereof in any medium, with or without
 91 |       modifications, and in Source or Object form, provided that You
 92 |       meet the following conditions:
 93 | 
 94 |       (a) You must give any other recipients of the Work or
 95 |           Derivative Works a copy of this License; and
 96 | 
 97 |       (b) You must cause any modified files to carry prominent notices
 98 |           stating that You changed the files; and
 99 | 
100 |       (c) You must retain, in the Source form of any Derivative Works
101 |           that You distribute, all copyright, patent, trademark, and
102 |           attribution notices from the Source form of the Work,
103 |           excluding those notices that do not pertain to any part of
104 |           the Derivative Works; and
105 | 
106 |       (d) If the Work includes a "NOTICE" text file as part of its
107 |           distribution, then any Derivative Works that You distribute must
108 |           include a readable copy of the attribution notices contained
109 |           within such NOTICE file, excluding those notices that do not
110 |           pertain to any part of the Derivative Works, in at least one
111 |           of the following places: within a NOTICE text file distributed
112 |           as part of the Derivative Works; within the Source form or
113 |           documentation, if provided along with the Derivative Works; or,
114 |           within a display generated by the Derivative Works, if and
115 |           wherever such third-party notices normally appear. The contents
116 |           of the NOTICE file are for informational purposes only and
117 |           do not modify the License. You may add Your own attribution
118 |           notices within Derivative Works that You distribute, alongside
119 |           or as an addendum to the NOTICE text from the Work, provided
120 |           that such additional attribution notices cannot be construed
121 |           as modifying the License.
122 | 
123 |       You may add Your own copyright statement to Your modifications and
124 |       may provide additional or different license terms and conditions
125 |       for use, reproduction, or distribution of Your modifications, or
126 |       for any such Derivative Works as a whole, provided Your use,
127 |       reproduction, and distribution of the Work otherwise complies with
128 |       the conditions stated in this License.
129 | 
130 |    5. Submission of Contributions. Unless You explicitly state otherwise,
131 |       any Contribution intentionally submitted for inclusion in the Work
132 |       by You to the Licensor shall be under the terms and conditions of
133 |       this License, without any additional terms or conditions.
134 |       Notwithstanding the above, nothing herein shall supersede or modify
135 |       the terms of any separate license agreement you may have executed
136 |       with Licensor regarding such Contributions.
137 | 
138 |    6. Trademarks. This License does not grant permission to use the trade
139 |       names, trademarks, service marks, or product names of the Licensor,
140 |       except as required for reasonable and customary use in describing the
141 |       origin of the Work and reproducing the content of the NOTICE file.
142 | 
143 |    7. Disclaimer of Warranty. Unless required by applicable law or
144 |       agreed to in writing, Licensor provides the Work (and each
145 |       Contributor provides its Contributions) on an "AS IS" BASIS,
146 |       WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 |       implied, including, without limitation, any warranties or conditions
148 |       of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 |       PARTICULAR PURPOSE. You are solely responsible for determining the
150 |       appropriateness of using or redistributing the Work and assume any
151 |       risks associated with Your exercise of permissions under this License.
152 | 
153 |    8. Limitation of Liability. In no event and under no legal theory,
154 |       whether in tort (including negligence), contract, or otherwise,
155 |       unless required by applicable law (such as deliberate and grossly
156 |       negligent acts) or agreed to in writing, shall any Contributor be
157 |       liable to You for damages, including any direct, indirect, special,
158 |       incidental, or consequential damages of any character arising as a
159 |       result of this License or out of the use or inability to use the
160 |       Work (including but not limited to damages for loss of goodwill,
161 |       work stoppage, computer failure or malfunction, or any and all
162 |       other commercial damages or losses), even if such Contributor
163 |       has been advised of the possibility of such damages.
164 | 
165 |    9. Accepting Warranty or Additional Liability. While redistributing
166 |       the Work or Derivative Works thereof, You may choose to offer,
167 |       and charge a fee for, acceptance of support, warranty, indemnity,
168 |       or other liability obligations and/or rights consistent with this
169 |       License. However, in accepting such obligations, You may act only
170 |       on Your own behalf and on Your sole responsibility, not on behalf
171 |       of any other Contributor, and only if You agree to indemnify,
172 |       defend, and hold each Contributor harmless for any liability
173 |       incurred by, or claims asserted against, such Contributor by reason
174 |       of your accepting any such warranty or additional liability.
175 | 
176 |    END OF TERMS AND CONDITIONS
177 | 
178 |    APPENDIX: How to apply the Apache License to your work.
179 | 
180 |       To apply the Apache License to your work, attach the following
181 |       boilerplate notice, with the fields enclosed by brackets "[]"
182 |       replaced with your own identifying information. (Don't include
183 |       the brackets!)  The text should be enclosed in the appropriate
184 |       comment syntax for the file format. We also recommend that a
185 |       file or class name and description of purpose be included on the
186 |       same "printed page" as the copyright notice for easier
187 |       identification within third-party archives.
188 | 
189 |    Copyright [yyyy] [name of copyright owner]
190 | 
191 |    Licensed under the Apache License, Version 2.0 (the "License");
192 |    you may not use this file except in compliance with the License.
193 |    You may obtain a copy of the License at
194 | 
195 |        http://www.apache.org/licenses/LICENSE-2.0
196 | 
197 |    Unless required by applicable law or agreed to in writing, software
198 |    distributed under the License is distributed on an "AS IS" BASIS,
199 |    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 |    See the License for the specific language governing permissions and
201 |    limitations under the License.
202 | 


--------------------------------------------------------------------------------