├── .editorconfig ├── .github └── workflows │ ├── gradle.yml │ └── lint.yml ├── .gitignore ├── LICENSE.txt ├── README.md ├── build.gradle.kts ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── gradlew ├── gradlew.bat ├── kotlin-ir-plugin-gradle ├── build.gradle.kts └── src │ └── main │ └── kotlin │ └── com │ └── bnorm │ └── template │ ├── TemplateGradleExtension.kt │ └── TemplateGradlePlugin.kt ├── kotlin-ir-plugin ├── build.gradle.kts └── src │ ├── main │ └── kotlin │ │ └── com │ │ └── bnorm │ │ └── template │ │ ├── TemplateCommandLineProcessor.kt │ │ ├── TemplateCompilerRegistrar.kt │ │ └── TemplateIrGenerationExtension.kt │ └── test │ └── kotlin │ └── com │ └── bnorm │ └── template │ └── IrPluginTest.kt └── settings.gradle.kts /.editorconfig: -------------------------------------------------------------------------------- 1 | root = true 2 | 3 | [*] 4 | end_of_line = lf 5 | insert_final_newline = true 6 | 7 | [*.{kt,kts}] 8 | ktlint_code_style = intellij_idea 9 | indent_style = space 10 | indent_size = 2 11 | -------------------------------------------------------------------------------- /.github/workflows/gradle.yml: -------------------------------------------------------------------------------- 1 | name: Project Build 2 | 3 | on: [push, pull_request] 4 | 5 | env: 6 | GRADLE_OPTS: "-Dorg.gradle.jvmargs=-Xmx4g -Dorg.gradle.daemon=false -Dkotlin.incremental=false" 7 | 8 | jobs: 9 | build: 10 | runs-on: ubuntu-latest 11 | 12 | steps: 13 | - uses: actions/checkout@v2 14 | - uses: gradle/wrapper-validation-action@v1 15 | - uses: actions/setup-java@v1 16 | with: 17 | java-version: 1.8 18 | 19 | - run: ./gradlew build 20 | -------------------------------------------------------------------------------- /.github/workflows/lint.yml: -------------------------------------------------------------------------------- 1 | name: lint 2 | 3 | on: [pull_request] 4 | 5 | jobs: 6 | ktlint: 7 | runs-on: ubuntu-latest 8 | 9 | steps: 10 | - uses: actions/checkout@v2 11 | 12 | - name: Run ktlint 13 | uses: ScaCap/action-ktlint@1.1 14 | with: 15 | github_token: ${{ secrets.GITHUB_TOKEN }} 16 | reporter: github-pr-check 17 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Gradle 2 | build/ 3 | .gradle/ 4 | 5 | # IDEA 6 | out/ 7 | .idea/ 8 | *.iml 9 | -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright [yyyy] [name of copyright owner] 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # kotlin-ir-plugin-template 2 | 3 | > [!IMPORTANT] 4 | > This project is no longer being actively maintained 5 | > as an official compiler plugin template is available: 6 | > [kotlin-compiler-plugin-template](https://github.com/Kotlin/kotlin-compiler-plugin-template) 7 | 8 | Template project for building Kotlin compiler plugins using IR. 9 | -------------------------------------------------------------------------------- /build.gradle.kts: -------------------------------------------------------------------------------- 1 | buildscript { 2 | extra["kotlin_plugin_id"] = "com.bnorm.template.kotlin-ir-plugin" 3 | } 4 | 5 | plugins { 6 | kotlin("jvm") version "1.9.22" apply false 7 | id("org.jetbrains.dokka") version "1.9.10" apply false 8 | id("com.gradle.plugin-publish") version "1.2.1" apply false 9 | id("com.github.gmazzo.buildconfig") version "5.3.5" apply false 10 | } 11 | 12 | allprojects { 13 | group = "com.bnorm.template" 14 | version = "0.1.0-SNAPSHOT" 15 | } 16 | 17 | subprojects { 18 | repositories { 19 | mavenCentral() 20 | } 21 | } 22 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/bnorm/kotlin-ir-plugin-template/56328f7adaf116987294a78e9b026ea719cd6109/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | distributionBase=GRADLE_USER_HOME 2 | distributionPath=wrapper/dists 3 | distributionUrl=https\://services.gradle.org/distributions/gradle-7.5-bin.zip 4 | zipStoreBase=GRADLE_USER_HOME 5 | zipStorePath=wrapper/dists 6 | -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | # 4 | # Copyright © 2015-2021 the original authors. 5 | # 6 | # Licensed under the Apache License, Version 2.0 (the "License"); 7 | # you may not use this file except in compliance with the License. 8 | # You may obtain a copy of the License at 9 | # 10 | # https://www.apache.org/licenses/LICENSE-2.0 11 | # 12 | # Unless required by applicable law or agreed to in writing, software 13 | # distributed under the License is distributed on an "AS IS" BASIS, 14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | # See the License for the specific language governing permissions and 16 | # limitations under the License. 17 | # 18 | 19 | ############################################################################## 20 | # 21 | # Gradle start up script for POSIX generated by Gradle. 22 | # 23 | # Important for running: 24 | # 25 | # (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is 26 | # noncompliant, but you have some other compliant shell such as ksh or 27 | # bash, then to run this script, type that shell name before the whole 28 | # command line, like: 29 | # 30 | # ksh Gradle 31 | # 32 | # Busybox and similar reduced shells will NOT work, because this script 33 | # requires all of these POSIX shell features: 34 | # * functions; 35 | # * expansions «$var», «${var}», «${var:-default}», «${var+SET}», 36 | # «${var#prefix}», «${var%suffix}», and «$( cmd )»; 37 | # * compound commands having a testable exit status, especially «case»; 38 | # * various built-in commands including «command», «set», and «ulimit». 39 | # 40 | # Important for patching: 41 | # 42 | # (2) This script targets any POSIX shell, so it avoids extensions provided 43 | # by Bash, Ksh, etc; in particular arrays are avoided. 44 | # 45 | # The "traditional" practice of packing multiple parameters into a 46 | # space-separated string is a well documented source of bugs and security 47 | # problems, so this is (mostly) avoided, by progressively accumulating 48 | # options in "$@", and eventually passing that to Java. 49 | # 50 | # Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS, 51 | # and GRADLE_OPTS) rely on word-splitting, this is performed explicitly; 52 | # see the in-line comments for details. 53 | # 54 | # There are tweaks for specific operating systems such as AIX, CygWin, 55 | # Darwin, MinGW, and NonStop. 56 | # 57 | # (3) This script is generated from the Groovy template 58 | # https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt 59 | # within the Gradle project. 60 | # 61 | # You can find Gradle at https://github.com/gradle/gradle/. 62 | # 63 | ############################################################################## 64 | 65 | # Attempt to set APP_HOME 66 | 67 | # Resolve links: $0 may be a link 68 | app_path=$0 69 | 70 | # Need this for daisy-chained symlinks. 71 | while 72 | APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path 73 | [ -h "$app_path" ] 74 | do 75 | ls=$( ls -ld "$app_path" ) 76 | link=${ls#*' -> '} 77 | case $link in #( 78 | /*) app_path=$link ;; #( 79 | *) app_path=$APP_HOME$link ;; 80 | esac 81 | done 82 | 83 | APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit 84 | 85 | APP_NAME="Gradle" 86 | APP_BASE_NAME=${0##*/} 87 | 88 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 89 | DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' 90 | 91 | # Use the maximum available, or set MAX_FD != -1 to use that value. 92 | MAX_FD=maximum 93 | 94 | warn () { 95 | echo "$*" 96 | } >&2 97 | 98 | die () { 99 | echo 100 | echo "$*" 101 | echo 102 | exit 1 103 | } >&2 104 | 105 | # OS specific support (must be 'true' or 'false'). 106 | cygwin=false 107 | msys=false 108 | darwin=false 109 | nonstop=false 110 | case "$( uname )" in #( 111 | CYGWIN* ) cygwin=true ;; #( 112 | Darwin* ) darwin=true ;; #( 113 | MSYS* | MINGW* ) msys=true ;; #( 114 | NONSTOP* ) nonstop=true ;; 115 | esac 116 | 117 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 118 | 119 | 120 | # Determine the Java command to use to start the JVM. 121 | if [ -n "$JAVA_HOME" ] ; then 122 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 123 | # IBM's JDK on AIX uses strange locations for the executables 124 | JAVACMD=$JAVA_HOME/jre/sh/java 125 | else 126 | JAVACMD=$JAVA_HOME/bin/java 127 | fi 128 | if [ ! -x "$JAVACMD" ] ; then 129 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 130 | 131 | Please set the JAVA_HOME variable in your environment to match the 132 | location of your Java installation." 133 | fi 134 | else 135 | JAVACMD=java 136 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 137 | 138 | Please set the JAVA_HOME variable in your environment to match the 139 | location of your Java installation." 140 | fi 141 | 142 | # Increase the maximum file descriptors if we can. 143 | if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then 144 | case $MAX_FD in #( 145 | max*) 146 | MAX_FD=$( ulimit -H -n ) || 147 | warn "Could not query maximum file descriptor limit" 148 | esac 149 | case $MAX_FD in #( 150 | '' | soft) :;; #( 151 | *) 152 | ulimit -n "$MAX_FD" || 153 | warn "Could not set maximum file descriptor limit to $MAX_FD" 154 | esac 155 | fi 156 | 157 | # Collect all arguments for the java command, stacking in reverse order: 158 | # * args from the command line 159 | # * the main class name 160 | # * -classpath 161 | # * -D...appname settings 162 | # * --module-path (only if needed) 163 | # * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables. 164 | 165 | # For Cygwin or MSYS, switch paths to Windows format before running java 166 | if "$cygwin" || "$msys" ; then 167 | APP_HOME=$( cygpath --path --mixed "$APP_HOME" ) 168 | CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" ) 169 | 170 | JAVACMD=$( cygpath --unix "$JAVACMD" ) 171 | 172 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 173 | for arg do 174 | if 175 | case $arg in #( 176 | -*) false ;; # don't mess with options #( 177 | /?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath 178 | [ -e "$t" ] ;; #( 179 | *) false ;; 180 | esac 181 | then 182 | arg=$( cygpath --path --ignore --mixed "$arg" ) 183 | fi 184 | # Roll the args list around exactly as many times as the number of 185 | # args, so each arg winds up back in the position where it started, but 186 | # possibly modified. 187 | # 188 | # NB: a `for` loop captures its iteration list before it begins, so 189 | # changing the positional parameters here affects neither the number of 190 | # iterations, nor the values presented in `arg`. 191 | shift # remove old arg 192 | set -- "$@" "$arg" # push replacement arg 193 | done 194 | fi 195 | 196 | # Collect all arguments for the java command; 197 | # * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of 198 | # shell script including quotes and variable substitutions, so put them in 199 | # double quotes to make sure that they get re-expanded; and 200 | # * put everything else in single quotes, so that it's not re-expanded. 201 | 202 | set -- \ 203 | "-Dorg.gradle.appname=$APP_BASE_NAME" \ 204 | -classpath "$CLASSPATH" \ 205 | org.gradle.wrapper.GradleWrapperMain \ 206 | "$@" 207 | 208 | # Stop when "xargs" is not available. 209 | if ! command -v xargs >/dev/null 2>&1 210 | then 211 | die "xargs is not available" 212 | fi 213 | 214 | # Use "xargs" to parse quoted args. 215 | # 216 | # With -n1 it outputs one arg per line, with the quotes and backslashes removed. 217 | # 218 | # In Bash we could simply go: 219 | # 220 | # readarray ARGS < <( xargs -n1 <<<"$var" ) && 221 | # set -- "${ARGS[@]}" "$@" 222 | # 223 | # but POSIX shell has neither arrays nor command substitution, so instead we 224 | # post-process each arg (as a line of input to sed) to backslash-escape any 225 | # character that might be a shell metacharacter, then use eval to reverse 226 | # that process (while maintaining the separation between arguments), and wrap 227 | # the whole thing up as a single "set" statement. 228 | # 229 | # This will of course break if any of these variables contains a newline or 230 | # an unmatched quote. 231 | # 232 | 233 | eval "set -- $( 234 | printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" | 235 | xargs -n1 | 236 | sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' | 237 | tr '\n' ' ' 238 | )" '"$@"' 239 | 240 | exec "$JAVACMD" "$@" 241 | -------------------------------------------------------------------------------- /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 | 17 | @if "%DEBUG%"=="" @echo off 18 | @rem ########################################################################## 19 | @rem 20 | @rem Gradle startup script for Windows 21 | @rem 22 | @rem ########################################################################## 23 | 24 | @rem Set local scope for the variables with windows NT shell 25 | if "%OS%"=="Windows_NT" setlocal 26 | 27 | set DIRNAME=%~dp0 28 | if "%DIRNAME%"=="" set DIRNAME=. 29 | set APP_BASE_NAME=%~n0 30 | set APP_HOME=%DIRNAME% 31 | 32 | @rem Resolve any "." and ".." in APP_HOME to make it shorter. 33 | for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi 34 | 35 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 36 | set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" 37 | 38 | @rem Find java.exe 39 | if defined JAVA_HOME goto findJavaFromJavaHome 40 | 41 | set JAVA_EXE=java.exe 42 | %JAVA_EXE% -version >NUL 2>&1 43 | if %ERRORLEVEL% equ 0 goto execute 44 | 45 | echo. 46 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 47 | echo. 48 | echo Please set the JAVA_HOME variable in your environment to match the 49 | echo location of your Java installation. 50 | 51 | goto fail 52 | 53 | :findJavaFromJavaHome 54 | set JAVA_HOME=%JAVA_HOME:"=% 55 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 56 | 57 | if exist "%JAVA_EXE%" goto execute 58 | 59 | echo. 60 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 61 | echo. 62 | echo Please set the JAVA_HOME variable in your environment to match the 63 | echo location of your Java installation. 64 | 65 | goto fail 66 | 67 | :execute 68 | @rem Setup the command line 69 | 70 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 71 | 72 | 73 | @rem Execute Gradle 74 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* 75 | 76 | :end 77 | @rem End local scope for the variables with windows NT shell 78 | if %ERRORLEVEL% equ 0 goto mainEnd 79 | 80 | :fail 81 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 82 | rem the _cmd.exe /c_ return code! 83 | set EXIT_CODE=%ERRORLEVEL% 84 | if %EXIT_CODE% equ 0 set EXIT_CODE=1 85 | if not ""=="%GRADLE_EXIT_CONSOLE%" exit %EXIT_CODE% 86 | exit /b %EXIT_CODE% 87 | 88 | :mainEnd 89 | if "%OS%"=="Windows_NT" endlocal 90 | 91 | :omega 92 | -------------------------------------------------------------------------------- /kotlin-ir-plugin-gradle/build.gradle.kts: -------------------------------------------------------------------------------- 1 | plugins { 2 | id("java-gradle-plugin") 3 | kotlin("jvm") 4 | id("com.github.gmazzo.buildconfig") 5 | } 6 | 7 | dependencies { 8 | implementation(kotlin("gradle-plugin-api")) 9 | } 10 | 11 | buildConfig { 12 | val project = project(":kotlin-ir-plugin") 13 | packageName(project.group.toString()) 14 | buildConfigField("String", "KOTLIN_PLUGIN_ID", "\"${rootProject.extra["kotlin_plugin_id"]}\"") 15 | buildConfigField("String", "KOTLIN_PLUGIN_GROUP", "\"${project.group}\"") 16 | buildConfigField("String", "KOTLIN_PLUGIN_NAME", "\"${project.name}\"") 17 | buildConfigField("String", "KOTLIN_PLUGIN_VERSION", "\"${project.version}\"") 18 | } 19 | 20 | gradlePlugin { 21 | plugins { 22 | create("kotlinIrPluginTemplate") { 23 | id = rootProject.extra["kotlin_plugin_id"] as String 24 | displayName = "Kotlin Ir Plugin Template" 25 | description = "Kotlin Ir Plugin Template" 26 | implementationClass = "com.bnorm.template.TemplateGradlePlugin" 27 | } 28 | } 29 | } 30 | -------------------------------------------------------------------------------- /kotlin-ir-plugin-gradle/src/main/kotlin/com/bnorm/template/TemplateGradleExtension.kt: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (C) 2020 Brian Norman 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | package com.bnorm.template 18 | 19 | import org.gradle.api.file.RegularFileProperty 20 | import org.gradle.api.model.ObjectFactory 21 | import org.gradle.api.provider.Property 22 | 23 | open class TemplateGradleExtension(objects: ObjectFactory) { 24 | val stringProperty: Property = objects.property(String::class.java) 25 | val fileProperty: RegularFileProperty = objects.fileProperty() 26 | } 27 | -------------------------------------------------------------------------------- /kotlin-ir-plugin-gradle/src/main/kotlin/com/bnorm/template/TemplateGradlePlugin.kt: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (C) 2020 Brian Norman 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | package com.bnorm.template 18 | 19 | import org.gradle.api.Project 20 | import org.gradle.api.provider.Provider 21 | import org.jetbrains.kotlin.gradle.plugin.KotlinCompilation 22 | import org.jetbrains.kotlin.gradle.plugin.KotlinCompilerPluginSupportPlugin 23 | import org.jetbrains.kotlin.gradle.plugin.SubpluginArtifact 24 | import org.jetbrains.kotlin.gradle.plugin.SubpluginOption 25 | 26 | class TemplateGradlePlugin : KotlinCompilerPluginSupportPlugin { 27 | override fun apply(target: Project): Unit = with(target) { 28 | extensions.create("template", TemplateGradleExtension::class.java) 29 | } 30 | 31 | override fun isApplicable(kotlinCompilation: KotlinCompilation<*>): Boolean = true 32 | 33 | override fun getCompilerPluginId(): String = BuildConfig.KOTLIN_PLUGIN_ID 34 | 35 | override fun getPluginArtifact(): SubpluginArtifact = SubpluginArtifact( 36 | groupId = BuildConfig.KOTLIN_PLUGIN_GROUP, 37 | artifactId = BuildConfig.KOTLIN_PLUGIN_NAME, 38 | version = BuildConfig.KOTLIN_PLUGIN_VERSION 39 | ) 40 | 41 | override fun applyToCompilation( 42 | kotlinCompilation: KotlinCompilation<*> 43 | ): Provider> { 44 | val project = kotlinCompilation.target.project 45 | val extension = project.extensions.getByType(TemplateGradleExtension::class.java) 46 | return project.provider { 47 | listOf( 48 | SubpluginOption(key = "string", value = extension.stringProperty.get()), 49 | SubpluginOption(key = "file", value = extension.fileProperty.get().asFile.path), 50 | ) 51 | } 52 | } 53 | } 54 | -------------------------------------------------------------------------------- /kotlin-ir-plugin/build.gradle.kts: -------------------------------------------------------------------------------- 1 | plugins { 2 | kotlin("jvm") 3 | kotlin("kapt") 4 | id("com.github.gmazzo.buildconfig") 5 | } 6 | 7 | dependencies { 8 | compileOnly("org.jetbrains.kotlin:kotlin-compiler-embeddable") 9 | 10 | kapt("com.google.auto.service:auto-service:1.1.1") 11 | compileOnly("com.google.auto.service:auto-service-annotations:1.1.1") 12 | 13 | testImplementation(kotlin("test-junit")) 14 | testImplementation("org.jetbrains.kotlin:kotlin-compiler-embeddable") 15 | testImplementation("dev.zacsweers.kctfork:core:0.4.0") 16 | } 17 | 18 | buildConfig { 19 | packageName(group.toString()) 20 | buildConfigField("String", "KOTLIN_PLUGIN_ID", "\"${rootProject.extra["kotlin_plugin_id"]}\"") 21 | } 22 | -------------------------------------------------------------------------------- /kotlin-ir-plugin/src/main/kotlin/com/bnorm/template/TemplateCommandLineProcessor.kt: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (C) 2020 Brian Norman 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | @file:OptIn(ExperimentalCompilerApi::class) 18 | 19 | package com.bnorm.template 20 | 21 | import com.google.auto.service.AutoService 22 | import org.jetbrains.kotlin.compiler.plugin.AbstractCliOption 23 | import org.jetbrains.kotlin.compiler.plugin.CliOption 24 | import org.jetbrains.kotlin.compiler.plugin.CommandLineProcessor 25 | import org.jetbrains.kotlin.compiler.plugin.ExperimentalCompilerApi 26 | import org.jetbrains.kotlin.config.CompilerConfiguration 27 | import org.jetbrains.kotlin.config.CompilerConfigurationKey 28 | 29 | @AutoService(CommandLineProcessor::class) 30 | class TemplateCommandLineProcessor : CommandLineProcessor { 31 | companion object { 32 | private const val OPTION_STRING = "string" 33 | private const val OPTION_FILE = "file" 34 | 35 | val ARG_STRING = CompilerConfigurationKey(OPTION_STRING) 36 | val ARG_FILE = CompilerConfigurationKey(OPTION_FILE) 37 | } 38 | 39 | override val pluginId: String = BuildConfig.KOTLIN_PLUGIN_ID 40 | 41 | override val pluginOptions: Collection = listOf( 42 | CliOption( 43 | optionName = OPTION_STRING, 44 | valueDescription = "string", 45 | description = "sample string argument", 46 | required = false, 47 | ), 48 | CliOption( 49 | optionName = OPTION_FILE, 50 | valueDescription = "file", 51 | description = "sample file argument", 52 | required = false, 53 | ), 54 | ) 55 | 56 | override fun processOption( 57 | option: AbstractCliOption, 58 | value: String, 59 | configuration: CompilerConfiguration 60 | ) { 61 | return when (option.optionName) { 62 | OPTION_STRING -> configuration.put(ARG_STRING, value) 63 | OPTION_FILE -> configuration.put(ARG_FILE, value) 64 | else -> throw IllegalArgumentException("Unexpected config option ${option.optionName}") 65 | } 66 | } 67 | } 68 | -------------------------------------------------------------------------------- /kotlin-ir-plugin/src/main/kotlin/com/bnorm/template/TemplateCompilerRegistrar.kt: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (C) 2020 Brian Norman 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | @file:OptIn(ExperimentalCompilerApi::class) 18 | 19 | package com.bnorm.template 20 | 21 | import com.google.auto.service.AutoService 22 | import org.jetbrains.kotlin.backend.common.extensions.IrGenerationExtension 23 | import org.jetbrains.kotlin.cli.common.CLIConfigurationKeys 24 | import org.jetbrains.kotlin.cli.common.messages.MessageCollector 25 | import org.jetbrains.kotlin.compiler.plugin.CompilerPluginRegistrar 26 | import org.jetbrains.kotlin.compiler.plugin.ExperimentalCompilerApi 27 | import org.jetbrains.kotlin.config.CompilerConfiguration 28 | 29 | @AutoService(CompilerPluginRegistrar::class) 30 | class TemplateCompilerRegistrar( 31 | private val defaultString: String, 32 | private val defaultFile: String, 33 | ) : CompilerPluginRegistrar() { 34 | override val supportsK2 = true 35 | 36 | @Suppress("unused") // Used by service loader 37 | constructor() : this( 38 | defaultString = "Hello, World!", 39 | defaultFile = "file.txt" 40 | ) 41 | 42 | override fun ExtensionStorage.registerExtensions(configuration: CompilerConfiguration) { 43 | val messageCollector = configuration.get(CLIConfigurationKeys.MESSAGE_COLLECTOR_KEY, MessageCollector.NONE) 44 | val string = configuration.get(TemplateCommandLineProcessor.ARG_STRING, defaultString) 45 | val file = configuration.get(TemplateCommandLineProcessor.ARG_FILE, defaultFile) 46 | 47 | IrGenerationExtension.registerExtension(TemplateIrGenerationExtension(messageCollector, string, file)) 48 | } 49 | } 50 | -------------------------------------------------------------------------------- /kotlin-ir-plugin/src/main/kotlin/com/bnorm/template/TemplateIrGenerationExtension.kt: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (C) 2020 Brian Norman 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | package com.bnorm.template 18 | 19 | import org.jetbrains.kotlin.backend.common.extensions.IrGenerationExtension 20 | import org.jetbrains.kotlin.backend.common.extensions.IrPluginContext 21 | import org.jetbrains.kotlin.cli.common.messages.CompilerMessageSeverity 22 | import org.jetbrains.kotlin.cli.common.messages.MessageCollector 23 | import org.jetbrains.kotlin.ir.declarations.IrModuleFragment 24 | 25 | class TemplateIrGenerationExtension( 26 | private val messageCollector: MessageCollector, 27 | private val string: String, 28 | private val file: String 29 | ) : IrGenerationExtension { 30 | override fun generate(moduleFragment: IrModuleFragment, pluginContext: IrPluginContext) { 31 | messageCollector.report(CompilerMessageSeverity.INFO, "Argument 'string' = $string") 32 | messageCollector.report(CompilerMessageSeverity.INFO, "Argument 'file' = $file") 33 | } 34 | } 35 | -------------------------------------------------------------------------------- /kotlin-ir-plugin/src/test/kotlin/com/bnorm/template/IrPluginTest.kt: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (C) 2020 Brian Norman 3 | * 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | */ 16 | 17 | @file:OptIn(ExperimentalCompilerApi::class) 18 | 19 | package com.bnorm.template 20 | 21 | import com.tschuchort.compiletesting.JvmCompilationResult 22 | import com.tschuchort.compiletesting.KotlinCompilation 23 | import com.tschuchort.compiletesting.SourceFile 24 | import org.jetbrains.kotlin.compiler.plugin.CompilerPluginRegistrar 25 | import kotlin.test.assertEquals 26 | import org.jetbrains.kotlin.compiler.plugin.ExperimentalCompilerApi 27 | import org.junit.Test 28 | 29 | class IrPluginTest { 30 | @Test 31 | fun `IR plugin success`() { 32 | val result = compile( 33 | sourceFile = SourceFile.kotlin( 34 | "main.kt", """ 35 | fun main() { 36 | println(debug()) 37 | } 38 | 39 | fun debug() = "Hello, World!" 40 | """ 41 | ) 42 | ) 43 | assertEquals(KotlinCompilation.ExitCode.OK, result.exitCode) 44 | } 45 | } 46 | 47 | fun compile( 48 | sourceFiles: List, 49 | plugin: CompilerPluginRegistrar = TemplateCompilerRegistrar(), 50 | ): JvmCompilationResult { 51 | return KotlinCompilation().apply { 52 | sources = sourceFiles 53 | compilerPluginRegistrars = listOf(plugin) 54 | inheritClassPath = true 55 | }.compile() 56 | } 57 | 58 | fun compile( 59 | sourceFile: SourceFile, 60 | plugin: CompilerPluginRegistrar = TemplateCompilerRegistrar(), 61 | ): JvmCompilationResult { 62 | return compile(listOf(sourceFile), plugin) 63 | } 64 | -------------------------------------------------------------------------------- /settings.gradle.kts: -------------------------------------------------------------------------------- 1 | rootProject.name = "kotlin-ir-plugin-template" 2 | 3 | include(":kotlin-ir-plugin-gradle") 4 | include(":kotlin-ir-plugin") 5 | --------------------------------------------------------------------------------