[
{
"path": ".github/stale.yml",
"content": "# Number of days of inactivity before an issue becomes stale\ndaysUntilStale: 7\n# Number of days of inactivity before a stale issue is closed\ndaysUntilClose: 7\n# Issues with these labels will never be considered stale\nexemptLabels:\n - bug\n - enhancement\n - feature\n - documentation\n - build stability\n# Label to use when marking an issue as stale\nstaleLabel: stale\n# Comment to post when marking an issue as stale. Set to `false` to disable\nmarkComment: >\n This issue has been automatically marked as stale because it has not had\n activity in the last seven days. It will be closed if no further activity\n occurs within the next seven days. Thank you for your contributions.\n# Comment to post when closing a stale issue. Set to `false` to disable\ncloseComment: false\nunmarkComment: false\n"
},
{
"path": ".github/workflows/build.yml",
"content": "name: Android CI\n\non:\n push:\n pull_request:\n\njobs:\n build:\n runs-on: ubuntu-latest\n steps:\n - name: Checkout project\n uses: actions/checkout@v4\n\n - name: Setup Java\n uses: actions/setup-java@v4\n with:\n distribution: \"zulu\"\n java-version: \"17\"\n\n - name: Setup Gradle\n uses: gradle/actions/setup-gradle@v4\n\n - name: Run Gradle Build\n run: |\n ./gradlew build \\\n -x :library:test:testDebugUnitTest \\\n :library:test:assembleDebugUnitTest \\\n -x :library:testDebugUnitTest \\\n :library:assembleDebugUnitTest \\\n -x :annotation:ksp:test:testDebugUnitTest \\\n :annotation:ksp:test:assembleDebugUnitTest \\\n -x :third_party:disklrucache:testDebugUnitTest \\\n :third_party:disklrucache:assembleDebugUnitTest \\\n -x :integration:cronet:testDebugUnitTest \\\n :integration:cronet:assembleDebugUnitTest \\\n -x :integration:gifencoder:testDebugUnitTest \\\n :integration:gifencoder:assembleDebugUnitTest \\\n -x :integration:ktx:testDebugUnitTest \\\n :integration:ktx:assembleDebugUnitTest \\\n -x :integration:concurrent:testDebugUnitTest \\\n :integration:concurrent:assembleDebugUnitTest \\\n -x :integration:volley:testDebugUnitTest \\\n :integration:volley:assembleDebugUnitTest \\\n -x :integration:sqljournaldiskcache:testDebugUnitTest \\\n :integration:sqljournaldiskcache:assembleDebugUnitTest \\\n -x :third_party:gif_decoder:testDebugUnitTest \\\n :third_party:gif_decoder:assembleDebugUnitTest \\\n :samples:flickr:build \\\n :samples:giphy:build \\\n :samples:contacturi:build \\\n :samples:gallery:build \\\n :samples:imgur:build \\\n :samples:svg:build \\\n :instrumentation:assembleAndroidTest \\\n :benchmark:assembleAndroidTest \\\n :glide:releaseJavadoc \\\n :annotation:ksp:test:test \\\n :integration:ktx:apiCheck \\\n :annotation:ksp:integrationtest:test \\\n --parallel\n"
},
{
"path": ".github/workflows/publish-manual.yml",
"content": "name: Publish to Maven (manual)\n\non:\n workflow_dispatch:\n\njobs:\n build:\n runs-on: ubuntu-latest\n steps:\n - name: Checkout project\n uses: actions/checkout@v4\n - name: Make Gradle wrapper executable\n run: chmod +x ./gradlew\n - uses: actions/setup-java@v4\n with:\n distribution: \"zulu\"\n java-version: \"17\"\n - name: Build and publish everything to Maven Central\n # This can be improved in Gradle\n run: ./gradlew :mocks:publishToMavenCentral :annotation:publishToMavenCentral :annotation:compiler:publishToMavenCentral :library:publishToMavenCentral :integration:sqljournaldiskcache:publishToMavenCentral :annotation:ksp:publishToMavenCentral :integration:recyclerview:publishToMavenCentral :integration:avif:publishToMavenCentral :integration:okhttp:publishToMavenCentral :integration:gifencoder:publishToMavenCentral :integration:ktx:publishToMavenCentral :integration:okhttp4:publishToMavenCentral :integration:volley:publishToMavenCentral :integration:concurrent:publishToMavenCentral :integration:cronet:publishToMavenCentral :integration:okhttp3:publishToMavenCentral :integration:compose:publishToMavenCentral :third_party:disklrucache:publishToMavenCentral :third_party:gif_decoder:publishToMavenCentral\n env:\n ORG_GRADLE_PROJECT_mavenCentralUsername: ${{ secrets.MAVEN_CENTRAL_USERNAME }}\n ORG_GRADLE_PROJECT_mavenCentralPassword: ${{ secrets.MAVEN_CENTRAL_PASSWORD }}\n ORG_GRADLE_PROJECT_signingInMemoryKeyId: ${{ secrets.MAVEN_SIGNING_KEY_ID }}\n ORG_GRADLE_PROJECT_signingInMemoryKey: ${{ secrets.MAVEN_SIGNING_PRIVATE_KEY }}\n ORG_GRADLE_PROJECT_signingInMemoryKeyPassword: ${{ secrets.MAVEN_SIGNING_PRIVATE_KEY_PASSWORD }}\n ORG_GRADLE_PROJECT_mavenCentralPublishing: true\n ORG_GRADLE_PROJECT_mavenCentralAutomaticPublishing: false\n"
},
{
"path": ".gitignore",
"content": "# Android\nlocal.properties\n*.keystore\n*.DS_Store\n\n# Gradle\n.gradle\nbuild\njacoco.exec\n\n# gh-pages\ndoc/**\n_site/*\n_pages/*\ndocs/**/*\n\n# Vim\n*.swp\n*.swo\n\n# sed\n*.bak\n\n# Intellij\n*.iml\n*.ipr\n*.iws\n.idea/**\n!.idea/codeStyleSettings.xml\n!.idea/inspectionProfiles\n!.idea/inspectionProfiles/Project_Default.xml\n\n"
},
{
"path": ".gitmodules",
"content": ""
},
{
"path": ".idea/codeStyleSettings.xml",
"content": "\n\n \n \n \n \n\n"
},
{
"path": ".idea/inspectionProfiles/Project_Default.xml",
"content": "\n \n \n \n \n \n \n \n"
},
{
"path": "CONTRIBUTING.md",
"content": "# Contributing\nContributions of all types are welcome.\nWe use GitHub as our bug and feature tracker both for code and for other aspects of the library (documentation, the wiki, etc.).\n\n\n## Asking Questions\nThe best way to ask general questions is to send an email to our [mailing list][2], or join [#glide-library on freenode.org][3].\n\n\n## Filing issues\nWhen in doubt, file an issue. We'd rather close a few duplicate issues than let a problem go unnoticed.\nSimilarly if you support a particular feature request, feel free to let us know by commenting on the issue or [subscribing][6] to the issue.\n\nTo file a new issue, please use our issue template and fill out the template as much as possible (remove irrelevant parts).\nThe more information you can provide, the more likely we are to be able help.\n\n\n## Contributing code\nPull requests are welcome for all parts of the codebase, especially the integration libraries.\nYou can find instructions on building the project in [README.md][5].\nOur code style is defined in Intellij project files in the repo and also by our Checkstyle config.\nIf you'd like to submit code, but can't get the style checks to pass, feel free to put up your pull request anyway and we can help you fix the style issues.\nIf you'd like to contribute code, you will need to sign [Google's individual contributor license agreement][4] which will be asked when you create the PR by [googlebot](https://github.com/googlebot) should you forget it.\n\n## Labels\nLabels on issues are managed by contributors, you don't have to worry about them. Here's a list of what they mean:\n\n * **bug**: feature that should work, but doesn't\n * **enhancement**: minor tweak/addition to existing behavior\n * **feature**: new behavior, bigger than enhancement, it gives more bang to Glide\n * **question**: no need to modify Glide to fix the issue, usually a usage problem\n * **reproducible**: has enough information to very easily reproduce, mostly in form of a small project in a GitHub repo\n * **repro-needed**: we need some code to be able to reproduce and debug locally, otherwise there's not much we can do\n * **duplicate**: there's another issue which already covers/tracks this\n * **wontfix**: working as intended, or won't be fixed due to compatibility or other reasons\n * **invalid**: there isn't enough information to make a verdict, or unrelated to Glide\n * **non-library**: issue is not in the core library code, but rather in documentation, samples, build process, releases\n * **v4**: problem originated in v4, or question about v4 (while v3 is in wide use)\n\n*bug + enhancement: feature that doesn't work, but it's an edge case that either has a workaround or doesn't affect many users*\n\n\n[1]: https://github.com/bumptech/glide/issues/new?body=**Glide%20Version**%3A%0A**Integration%20libraries**%3A%0A**Device/Android%20Version**%3A%0A**Issue%20details%20/%20Repro%20steps%20/%20Use%20case%20background**%3A%0A%0A**Glide%20load%20line**%3A%0A%60%60%60java%0AGlide.with%28...%29.....load%28...%29.....into%28...%29%3B%0A%60%60%60%0A%0A**Layout%20XML**%3A%0A%60%60%60xml%0A%3C...Layout%3E%0A%20%20%20%20%3CImageView%20android%3AscaleType%3D%22...%22%20...%20/%3E%0A%3C/..Layout%3E%0A%60%60%60%0A%0A**Stack%20trace%20/%20LogCat**%3A%0A%60%60%60ruby%0Apaste%20stack%20trace%20here%0A%60%60%60\n[2]: https://groups.google.com/forum/#!forum/glidelibrary\n[3]: http://webchat.freenode.net/?channels=glide-library\n[4]: https://developers.google.com/open-source/cla/individual\n[5]: https://github.com/bumptech/glide\n[6]: https://help.github.com/articles/subscribing-to-conversations/\n"
},
{
"path": "ISSUE_TEMPLATE.md",
"content": "\n\n\n\n**Glide Version**:\n\n\n**Integration libraries**:\n\n\n**Device/Android Version**:\n\n\n**Issue details / Repro steps / Use case background**: \n\n\n**Glide load line / `GlideModule` (if any) / list Adapter code (if any)**:\n```java\nGlide.with...\n```\n\n\n**Layout XML**:\n```xml\n\n**Stack trace / LogCat**:\n```ruby\npaste stack trace and/or log here\n```\n\n\n"
},
{
"path": "LICENSE",
"content": "License for everything not in third_party and not otherwise marked:\n\nCopyright 2014 Google, Inc. All rights reserved.\n\nRedistribution and use in source and binary forms, with or without modification, are\npermitted provided that the following conditions are met:\n\n 1. Redistributions of source code must retain the above copyright notice, this list of\n conditions and the following disclaimer.\n\n 2. Redistributions in binary form must reproduce the above copyright notice, this list\n of conditions and the following disclaimer in the documentation and/or other materials\n provided with the distribution.\n\nTHIS SOFTWARE IS PROVIDED BY GOOGLE, INC. ``AS IS'' AND ANY EXPRESS OR IMPLIED\nWARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND\nFITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GOOGLE, INC. OR\nCONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR\nCONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR\nSERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON\nANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING\nNEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF\nADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n\nThe views and conclusions contained in the software and documentation are those of the\nauthors and should not be interpreted as representing official policies, either expressed\nor implied, of Google, Inc.\n---------------------------------------------------------------------------------------------\nLicense for third_party/disklrucache:\n\nCopyright 2012 Jake Wharton\nCopyright 2011 The Android Open Source Project\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n---------------------------------------------------------------------------------------------\nLicense for third_party/gif_decoder:\n\nCopyright (c) 2013 Xcellent Creations, Inc.\n\nPermission is hereby granted, free of charge, to any person obtaining\na copy of this software and associated documentation files (the\n\"Software\"), to deal in the Software without restriction, including\nwithout limitation the rights to use, copy, modify, merge, publish,\ndistribute, sublicense, and/or sell copies of the Software, and to\npermit persons to whom the Software is furnished to do so, subject to\nthe following conditions:\n\nThe above copyright notice and this permission notice shall be\nincluded in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND,\nEXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\nMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND\nNONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE\nLIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION\nOF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION\nWITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n---------------------------------------------------------------------------------------------\nLicense for third_party/gif_encoder/AnimatedGifEncoder.java and\nthird_party/gif_encoder/LZWEncoder.java:\n\nNo copyright asserted on the source code of this class. May be used for any\npurpose, however, refer to the Unisys LZW patent for restrictions on use of\nthe associated LZWEncoder class. Please forward any corrections to\nkweiner@fmsware.com.\n\n-----------------------------------------------------------------------------\nLicense for third_party/gif_encoder/NeuQuant.java\n\nCopyright (c) 1994 Anthony Dekker\n\nNEUQUANT Neural-Net quantization algorithm by Anthony Dekker, 1994. See\n\"Kohonen neural networks for optimal colour quantization\" in \"Network:\nComputation in Neural Systems\" Vol. 5 (1994) pp 351-367. for a discussion of\nthe algorithm.\n\nAny party obtaining a copy of these files from the author, directly or\nindirectly, is granted, free of charge, a full and unrestricted irrevocable,\nworld-wide, paid up, royalty-free, nonexclusive right and license to deal in\nthis software and documentation files (the \"Software\"), including without\nlimitation the rights to use, copy, modify, merge, publish, distribute,\nsublicense, and/or sell copies of the Software, and to permit persons who\nreceive copies from any such party to do so, with the only requirement being\nthat this copyright notice remain intact.\n"
},
{
"path": "PULL_REQUEST_TEMPLATE.md",
"content": "\n\n\n\n\n## Description\n\n\n\n## Motivation and Context\n\n\n\n"
},
{
"path": "README.md",
"content": "Glide\n=====\n\n[](https://maven-badges.herokuapp.com/maven-central/com.github.bumptech.glide/glide)\n| [View Glide's documentation][20] | [简体中文文档][22] | [Report an issue with Glide][5]\n\nGlide is a fast and efficient open source media management and image loading framework for Android that wraps media\ndecoding, memory and disk caching, and resource pooling into a simple and easy to use interface.\n\n\n\nGlide supports fetching, decoding, and displaying video stills, images, and animated GIFs. Glide includes a flexible API\nthat allows developers to plug in to almost any network stack. By default Glide uses a custom `HttpUrlConnection` based\nstack, but also includes utility libraries plug in to Google's Volley project or Square's OkHttp library instead.\n\nGlide's primary focus is on making scrolling any kind of a list of images as smooth and fast as possible, but Glide is\nalso effective for almost any case where you need to fetch, resize, and display a remote image.\n\nDownload\n--------\nFor detailed instructions and requirements, see Glide's [download and setup docs page][28].\n\nYou can download a jar from GitHub's [releases page][1].\n\nOr use Gradle:\n\n```gradle\nrepositories {\n google()\n mavenCentral()\n}\n\ndependencies {\n implementation 'com.github.bumptech.glide:glide:5.0.5'\n}\n```\n\nOr Maven:\n\n```xml\n\n com.github.bumptech.glide\n glide\n 5.0.5\n\n```\n\nFor info on using the bleeding edge, see the [Snapshots][17] docs page.\n\nR8 / Proguard\n--------\nThe specific rules are [already bundled](library/proguard-rules.txt) into the aar which can be interpreted by R8 automatically\n\nHow do I use Glide?\n-------------------\nCheck out the [documentation][20] for pages on a variety of topics, and see the [javadocs][3].\n\nFor Glide v3, see the [wiki][2].\n\nSimple use cases will look something like this:\n\n```java\n// For a simple view:\n@Override public void onCreate(Bundle savedInstanceState) {\n ...\n ImageView imageView = (ImageView) findViewById(R.id.my_image_view);\n\n Glide.with(this).load(\"https://goo.gl/gEgYUd\").into(imageView);\n}\n\n// For a simple image list:\n@Override public View getView(int position, View recycled, ViewGroup container) {\n final ImageView myImageView;\n if (recycled == null) {\n myImageView = (ImageView) inflater.inflate(R.layout.my_image_view, container, false);\n } else {\n myImageView = (ImageView) recycled;\n }\n\n String url = myUrls.get(position);\n\n Glide\n .with(myFragment)\n .load(url)\n .centerCrop()\n .placeholder(R.drawable.loading_spinner)\n .into(myImageView);\n\n return myImageView;\n}\n```\n\nStatus\n------\nVersion 4 is now released and stable. Updates are released periodically with new features and bug fixes.\n\nComments/bugs/questions/pull requests are always welcome! Please read [CONTRIBUTING.md][5] on how to report issues.\n\nCompatibility\n-------------\n\n * **Minimum Android SDK**: Glide v4 requires a minimum API level of 14.\n * **Compile Android SDK**: Glide v4 requires you to compile against API 26 or later.\n\n If you need to support older versions of Android, consider staying on [Glide v3][14], which works on API 10, but is not actively maintained.\n\n * **OkHttp 3.x**: There is an optional dependency available called `okhttp3-integration`, see the [docs page][23].\n * **Volley**: There is an optional dependency available called `volley-integration`, see the [docs page][24].\n * **Round Pictures**: `CircleImageView`/`CircularImageView`/`RoundedImageView` are known to have [issues][18] with `TransitionDrawable` (`.crossFade()` with `.thumbnail()` or `.placeholder()`) and animated GIFs, use a [`BitmapTransformation`][19] (`.circleCrop()` will be available in v4) or `.dontAnimate()` to fix the issue.\n * **Huge Images** (maps, comic strips): Glide can load huge images by downsampling them, but does not support zooming and panning `ImageView`s as they require special resource optimizations (such as tiling) to work without `OutOfMemoryError`s.\n\nBuild\n-----\nBuilding Glide with gradle is fairly straight forward:\n\n```shell\ngit clone https://github.com/bumptech/glide.git\ncd glide\n./gradlew jar\n```\n\n**Note**: Make sure your *Android SDK* has the *Android Support Repository* installed, and that your `$ANDROID_HOME` environment\nvariable is pointing at the SDK or add a `local.properties` file in the root project with a `sdk.dir=...` line.\n\nSamples\n-------\nFollow the steps in the [Build](#build) section to set up the project and then:\n\n```shell\n./gradlew :samples:flickr:run\n./gradlew :samples:giphy:run\n./gradlew :samples:svg:run\n./gradlew :samples:contacturi:run\n```\nYou may also find precompiled APKs on the [releases page][1].\n\nDevelopment\n-----------\nFollow the steps in the [Build](#build) section to setup the project and then edit the files however you wish.\n[Android Studio][26] cleanly imports both Glide's source and tests and is the recommended way to work with Glide.\n\nTo open the project in Android Studio:\n\n1. Go to *File* menu or the *Welcome Screen*\n2. Click on *Open...*\n3. Navigate to Glide's root directory.\n4. Select `setting.gradle`\n\nFor more details, see the [Contributing docs page][27].\n\nGetting Help\n------------\nTo report a specific problem or feature request, [open a new issue on Github][5]. For questions, suggestions, or\nanything else, email [Glide's discussion group][6], or join our IRC channel: [irc.freenode.net#glide-library][13].\n\nContributing\n------------\nBefore submitting pull requests, contributors must sign Google's [individual contributor license agreement][7].\n\nThanks\n------\n* The **Android team** and **Jake Wharton** for the [disk cache implementation][8] Glide's disk cache is based on.\n* **Dave Smith** for the [GIF decoder gist][9] Glide's GIF decoder is based on.\n* **Chris Banes** for his [gradle-mvn-push][10] script.\n* **Corey Hall** for Glide's [amazing logo][11].\n* Everyone who has contributed code and reported issues!\n\nAuthor\n------\nSam Judd - @sjudd on GitHub, @samajudd on Twitter\n\nLicense\n-------\nBSD, part MIT and Apache 2.0. See the [LICENSE][16] file for details.\n\nDisclaimer\n---------\nThis is not an official Google product.\n\n[1]: https://github.com/bumptech/glide/releases\n[2]: https://github.com/bumptech/glide/wiki\n[3]: https://bumptech.github.io/glide/ref/javadocs.html\n[4]: https://www.jetbrains.com/idea/download/\n[5]: https://github.com/bumptech/glide/blob/master/CONTRIBUTING.md\n[6]: https://groups.google.com/forum/#!forum/glidelibrary\n[7]: https://developers.google.com/open-source/cla/individual\n[8]: https://github.com/JakeWharton/DiskLruCache\n[9]: https://gist.github.com/devunwired/4479231\n[10]: https://github.com/chrisbanes/gradle-mvn-push\n[11]: static/glide_logo.png\n[12]: https://github.com/bumptech/glide/wiki/Integration-Libraries\n[13]: http://webchat.freenode.net/?channels=glide-library\n[14]: https://github.com/bumptech/glide/tree/3.0\n[15]: https://github.com/bumptech/glide/tree/master\n[16]: https://github.com/bumptech/glide/blob/master/LICENSE\n[17]: http://bumptech.github.io/glide/dev/snapshots.html\n[18]: https://github.com/bumptech/glide/issues?q=is%3Aissue+CircleImageView+OR+CircularImageView+OR+RoundedImageView\n[19]: https://github.com/wasabeef/glide-transformations\n[20]: https://bumptech.github.io/glide/\n[22]: https://muyangmin.github.io/glide-docs-cn/\n[23]: http://bumptech.github.io/glide/int/okhttp3.html\n[24]: http://bumptech.github.io/glide/int/volley.html\n[25]: http://bumptech.github.io/glide/doc/download-setup.html#proguard\n[26]: https://developer.android.com/studio/index.html\n[27]: http://bumptech.github.io/glide/dev/contributing.html\n[28]: http://bumptech.github.io/glide/doc/download-setup.html\n"
},
{
"path": "annotation/.gitignore",
"content": "/build\n"
},
{
"path": "annotation/build.gradle.kts",
"content": "plugins {\n id(\"java\")\n}\n\napply(from = \"${rootProject.projectDir}/scripts/upload.gradle.kts\")\n\njava {\n sourceCompatibility = JavaVersion.VERSION_1_7\n targetCompatibility = JavaVersion.VERSION_1_7\n}"
},
{
"path": "annotation/compiler/.gitignore",
"content": "/build\n"
},
{
"path": "annotation/compiler/build.gradle.kts",
"content": "plugins {\n id(\"java\")\n}\n\ndependencies {\n implementation(libs.javapoet)\n implementation(libs.guava)\n\n compileOnly(libs.autoservice)\n compileOnly(libs.findbugs.jsr305)\n\n implementation(project(\":annotation\"))\n annotationProcessor(libs.autoservice)\n}\n\ntasks.withType {\n isFailOnError = false\n}\n\napply(from = \"${rootProject.projectDir}/scripts/upload.gradle.kts\")"
},
{
"path": "annotation/compiler/gradle.properties",
"content": "POM_NAME=Glide Annotation processor\nPOM_ARTIFACT_ID=compiler\nPOM_PACKAGING=jar\nPOM_DESCRIPTION=Glide's anntation processor. Should be included in all Applications and in all libraries that use Glide's modules for configuration.\n"
},
{
"path": "annotation/compiler/proguard.pro",
"content": "-verbose\n# Use ProGuard only to get rid of unused classes\n-dontobfuscate\n-dontoptimize\n-keepattributes *\n-keep class !com.bumptech.glide.repackaged.**,com.bumptech.glide.**\n\n# Keep the entry point to this library, see META-INF\\services\\javax.annotation.processing.Processor\n-keep class com.bumptech.glide.annotation.compiler.GlideAnnotationProcessor\n\n\n# \"duplicate definition of library class\"\n-dontnote sun.applet.**\n# \"duplicate definition of library class\"\n-dontnote sun.tools.jar.**\n# Reflective accesses in com.google.common.util.concurrent.* and some others\n-dontnote com.bumptech.glide.repackaged.com.google.common.**\n# com.google.common.collect.* and some others (….common.*.*)\n-dontwarn com.google.j2objc.annotations.Weak\n# com.google.common.util.concurrent.FuturesGetChecked$GetCheckedTypeValidatorHolder$ClassValueValidator\n-dontwarn org.codehaus.mojo.animal_sniffer.IgnoreJRERequirement\n#-dontwarn **\n"
},
{
"path": "annotation/compiler/src/main/java/com/bumptech/glide/annotation/compiler/AppModuleGenerator.java",
"content": "package com.bumptech.glide.annotation.compiler;\n\nimport com.bumptech.glide.annotation.Excludes;\nimport com.squareup.javapoet.AnnotationSpec;\nimport com.squareup.javapoet.ClassName;\nimport com.squareup.javapoet.MethodSpec;\nimport com.squareup.javapoet.ParameterSpec;\nimport com.squareup.javapoet.ParameterizedTypeName;\nimport com.squareup.javapoet.TypeName;\nimport com.squareup.javapoet.TypeSpec;\nimport com.squareup.javapoet.TypeSpec.Builder;\nimport com.squareup.javapoet.WildcardTypeName;\nimport java.util.ArrayList;\nimport java.util.Collection;\nimport java.util.Collections;\nimport java.util.HashSet;\nimport java.util.List;\nimport java.util.Set;\nimport javax.annotation.processing.ProcessingEnvironment;\nimport javax.lang.model.element.Element;\nimport javax.lang.model.element.ElementKind;\nimport javax.lang.model.element.ExecutableElement;\nimport javax.lang.model.element.Modifier;\nimport javax.lang.model.element.TypeElement;\nimport javax.lang.model.element.VariableElement;\nimport javax.lang.model.type.TypeMirror;\n\n/**\n * Generates a new implementation of a AppGlideModule that calls all included LibraryGlideModules\n * and the original AppGlideModule.\n *\n *
The generated class will always call the AppGlideModule last to give it priority over choices\n * made or classes registered in LibraryGlideModules.\n *\n *
Android logging is included to allow developers to see exactly which modules are included at\n * runtime.\n *\n *
The generated class looks something like this:\n *\n *
\n */\nfinal class AppModuleGenerator {\n static final String GENERATED_ROOT_MODULE_PACKAGE_NAME = \"com.bumptech.glide\";\n private static final String GLIDE_LOG_TAG = \"Glide\";\n private static final String GENERATED_APP_MODULE_IMPL_SIMPLE_NAME = \"GeneratedAppGlideModuleImpl\";\n private static final String GENERATED_ROOT_MODULE_SIMPLE_NAME = \"GeneratedAppGlideModule\";\n\n private final ProcessingEnvironment processingEnv;\n private final ProcessorUtil processorUtil;\n\n AppModuleGenerator(ProcessingEnvironment processingEnv, ProcessorUtil processorUtil) {\n this.processingEnv = processingEnv;\n this.processorUtil = processorUtil;\n }\n\n TypeSpec generate(TypeElement appGlideModule, Set libraryGlideModuleClassNames) {\n ClassName appGlideModuleClassName = ClassName.get(appGlideModule);\n List excludedGlideModuleClassNames = getExcludedGlideModuleClassNames(appGlideModule);\n\n List orderedLibraryGlideModuleClassNames =\n new ArrayList<>(libraryGlideModuleClassNames);\n Collections.sort(orderedLibraryGlideModuleClassNames);\n\n MethodSpec constructor =\n generateConstructor(\n appGlideModuleClassName,\n orderedLibraryGlideModuleClassNames,\n excludedGlideModuleClassNames);\n\n MethodSpec registerComponents =\n generateRegisterComponents(\n orderedLibraryGlideModuleClassNames, excludedGlideModuleClassNames);\n\n MethodSpec getExcludedModuleClasses =\n generateGetExcludedModuleClasses(excludedGlideModuleClassNames);\n\n MethodSpec applyOptions =\n MethodSpec.methodBuilder(\"applyOptions\")\n .addModifiers(Modifier.PUBLIC)\n .addAnnotation(Override.class)\n .addParameter(\n ParameterSpec.builder(ClassName.get(\"android.content\", \"Context\"), \"context\")\n .addAnnotation(processorUtil.nonNull())\n .build())\n .addParameter(\n ParameterSpec.builder(\n ClassName.get(\"com.bumptech.glide\", \"GlideBuilder\"), \"builder\")\n .addAnnotation(processorUtil.nonNull())\n .build())\n .addStatement(\"appGlideModule.applyOptions(context, builder)\", appGlideModule)\n .build();\n\n MethodSpec isManifestParsingEnabled =\n MethodSpec.methodBuilder(\"isManifestParsingEnabled\")\n .addModifiers(Modifier.PUBLIC)\n .addAnnotation(Override.class)\n .returns(boolean.class)\n .addStatement(\"return appGlideModule.isManifestParsingEnabled()\", appGlideModule)\n .build();\n\n Builder builder =\n TypeSpec.classBuilder(GENERATED_APP_MODULE_IMPL_SIMPLE_NAME)\n .addModifiers(Modifier.FINAL)\n .addAnnotation(\n AnnotationSpec.builder(SuppressWarnings.class)\n .addMember(\"value\", \"$S\", \"deprecation\")\n .build())\n .superclass(\n ClassName.get(\n GENERATED_ROOT_MODULE_PACKAGE_NAME, GENERATED_ROOT_MODULE_SIMPLE_NAME))\n .addField(appGlideModuleClassName, \"appGlideModule\", Modifier.PRIVATE, Modifier.FINAL)\n .addMethod(constructor)\n .addMethod(applyOptions)\n .addMethod(registerComponents)\n .addMethod(isManifestParsingEnabled)\n .addMethod(getExcludedModuleClasses);\n\n ClassName generatedRequestManagerFactoryClassName =\n ClassName.get(\n RequestManagerFactoryGenerator.GENERATED_REQUEST_MANAGER_FACTORY_PACKAGE_NAME,\n RequestManagerFactoryGenerator.GENERATED_REQUEST_MANAGER_FACTORY_SIMPLE_NAME);\n\n builder.addMethod(\n MethodSpec.methodBuilder(\"getRequestManagerFactory\")\n .addAnnotation(Override.class)\n .addAnnotation(processorUtil.nonNull())\n .returns(generatedRequestManagerFactoryClassName)\n .addStatement(\"return new $T()\", generatedRequestManagerFactoryClassName)\n .build());\n return builder.build();\n }\n\n // TODO: When we drop support for parsing GlideModules from AndroidManifests, remove this method.\n private MethodSpec generateGetExcludedModuleClasses(Collection excludedClassNames) {\n TypeName wildCardOfObject = WildcardTypeName.subtypeOf(Object.class);\n ParameterizedTypeName classOfWildcardOfObjet =\n ParameterizedTypeName.get(ClassName.get(Class.class), wildCardOfObject);\n ParameterizedTypeName setOfClassOfWildcardOfObject =\n ParameterizedTypeName.get(ClassName.get(Set.class), classOfWildcardOfObjet);\n ParameterizedTypeName hashSetOfClassOfWildcardOfObject =\n ParameterizedTypeName.get(ClassName.get(HashSet.class), classOfWildcardOfObjet);\n MethodSpec.Builder builder =\n MethodSpec.methodBuilder(\"getExcludedModuleClasses\")\n .addModifiers(Modifier.PUBLIC)\n .addAnnotation(Override.class)\n .addAnnotation(processorUtil.nonNull())\n .returns(setOfClassOfWildcardOfObject);\n\n if (excludedClassNames.isEmpty()) {\n builder.addStatement(\"return $T.emptySet()\", Collections.class);\n } else {\n builder.addStatement(\n \"$T excludedClasses = new $T()\",\n setOfClassOfWildcardOfObject,\n hashSetOfClassOfWildcardOfObject);\n for (String excludedClassName : excludedClassNames) {\n // TODO: Remove this when we no longer support manifest parsing.\n // Using a Literal ($L) instead of a type ($T) to get a fully qualified import that allows\n // us to suppress deprecation warnings. Aimed at deprecated GlideModules.\n builder.addStatement(\"excludedClasses.add($L.class)\", excludedClassName);\n }\n builder.addStatement(\"return excludedClasses\");\n }\n\n return builder.build();\n }\n\n private MethodSpec generateRegisterComponents(\n Collection libraryGlideModuleClassNames,\n Collection excludedGlideModuleClassNames) {\n MethodSpec.Builder registerComponents =\n MethodSpec.methodBuilder(\"registerComponents\")\n .addModifiers(Modifier.PUBLIC)\n .addAnnotation(Override.class)\n .addParameter(\n ParameterSpec.builder(ClassName.get(\"android.content\", \"Context\"), \"context\")\n .addAnnotation(processorUtil.nonNull())\n .build())\n .addParameter(\n ParameterSpec.builder(ClassName.get(\"com.bumptech.glide\", \"Glide\"), \"glide\")\n .addAnnotation(processorUtil.nonNull())\n .build())\n .addParameter(\n ParameterSpec.builder(ClassName.get(\"com.bumptech.glide\", \"Registry\"), \"registry\")\n .addAnnotation(processorUtil.nonNull())\n .build());\n\n for (String glideModule : libraryGlideModuleClassNames) {\n if (excludedGlideModuleClassNames.contains(glideModule)) {\n continue;\n }\n ClassName moduleClassName = ClassName.bestGuess(glideModule);\n registerComponents.addStatement(\n \"new $T().registerComponents(context, glide, registry)\", moduleClassName);\n }\n // Order matters here. The AppGlideModule must be called last.\n registerComponents.addStatement(\"appGlideModule.registerComponents(context, glide, registry)\");\n return registerComponents.build();\n }\n\n private boolean doesAppGlideModuleConstructorAcceptContext(ClassName appGlideModule) {\n TypeElement appGlideModuleType =\n processingEnv.getElementUtils().getTypeElement(appGlideModule.reflectionName());\n\n for (Element enclosed : appGlideModuleType.getEnclosedElements()) {\n if (enclosed.getKind() == ElementKind.CONSTRUCTOR) {\n ExecutableElement constructor = (ExecutableElement) enclosed;\n List parameters = constructor.getParameters();\n if (parameters.isEmpty()) {\n return false;\n } else if (parameters.size() > 1) {\n throw new IllegalStateException(\n \"Constructor for \"\n + appGlideModule\n + \" accepts too many parameters\"\n + \", it should accept no parameters, or a single Context\");\n } else {\n VariableElement parameter = parameters.get(0);\n TypeMirror parameterType = parameter.asType();\n TypeMirror contextType =\n processingEnv.getElementUtils().getTypeElement(\"android.content.Context\").asType();\n if (!processingEnv.getTypeUtils().isSameType(parameterType, contextType)) {\n throw new IllegalStateException(\"Unrecognized type: \" + parameterType);\n }\n return true;\n }\n }\n }\n return false;\n }\n\n private MethodSpec generateConstructor(\n ClassName appGlideModule,\n Collection libraryGlideModuleClassNames,\n Collection excludedGlideModuleClassNames) {\n MethodSpec.Builder constructorBuilder =\n MethodSpec.constructorBuilder()\n .addModifiers(Modifier.PUBLIC)\n .addParameter(\n ParameterSpec.builder(ClassName.get(\"android.content\", \"Context\"), \"context\")\n .build());\n\n if (doesAppGlideModuleConstructorAcceptContext(appGlideModule)) {\n constructorBuilder.addStatement(\"appGlideModule = new $T(context)\", appGlideModule);\n } else {\n constructorBuilder.addStatement(\"appGlideModule = new $T()\", appGlideModule);\n }\n\n ClassName androidLogName = ClassName.get(\"android.util\", \"Log\");\n\n // Add some log lines to indicate to developers which modules where discovered.\n constructorBuilder.beginControlFlow(\n \"if ($T.isLoggable($S, $T.DEBUG))\", androidLogName, GLIDE_LOG_TAG, androidLogName);\n constructorBuilder.addStatement(\n \"$T.d($S, $S)\",\n androidLogName,\n GLIDE_LOG_TAG,\n \"Discovered AppGlideModule from annotation: \" + appGlideModule);\n // Excluded GlideModule classes from the manifest are logged in Glide's singleton.\n for (String glideModule : libraryGlideModuleClassNames) {\n if (excludedGlideModuleClassNames.contains(glideModule)) {\n constructorBuilder.addStatement(\n \"$T.d($S, $S)\",\n androidLogName,\n GLIDE_LOG_TAG,\n \"AppGlideModule excludes LibraryGlideModule from annotation: \" + glideModule);\n } else {\n constructorBuilder.addStatement(\n \"$T.d($S, $S)\",\n androidLogName,\n GLIDE_LOG_TAG,\n \"Discovered LibraryGlideModule from annotation: \" + glideModule);\n }\n }\n constructorBuilder.endControlFlow();\n return constructorBuilder.build();\n }\n\n private List getExcludedGlideModuleClassNames(TypeElement appGlideModule) {\n Set names =\n processorUtil.findClassValuesFromAnnotationOnClassAsNames(appGlideModule, Excludes.class);\n List result = new ArrayList<>(names);\n Collections.sort(result);\n return result;\n }\n}\n"
},
{
"path": "annotation/compiler/src/main/java/com/bumptech/glide/annotation/compiler/AppModuleProcessor.java",
"content": "package com.bumptech.glide.annotation.compiler;\n\nimport com.bumptech.glide.annotation.GlideModule;\nimport com.squareup.javapoet.TypeSpec;\nimport java.util.ArrayList;\nimport java.util.Collections;\nimport java.util.HashSet;\nimport java.util.List;\nimport java.util.Set;\nimport javax.annotation.processing.ProcessingEnvironment;\nimport javax.annotation.processing.RoundEnvironment;\nimport javax.lang.model.element.Element;\nimport javax.lang.model.element.PackageElement;\nimport javax.lang.model.element.TypeElement;\n\n/**\n * Runs the final steps of Glide's annotation process and generates the combined {@code\n * AppGlideModule}, {@code com.bumptech.glide.Glide}, {@code com.bumptech.glide.RequestManager}, and\n * {@code com.bumptech.glide.request.RequestOptions} classes.\n */\nfinal class AppModuleProcessor {\n private static final String COMPILER_PACKAGE_NAME =\n GlideAnnotationProcessor.class.getPackage().getName();\n\n private final ProcessingEnvironment processingEnv;\n private final ProcessorUtil processorUtil;\n private final List appGlideModules = new ArrayList<>();\n private final RequestOptionsGenerator requestOptionsGenerator;\n private final RequestManagerGenerator requestManagerGenerator;\n private final AppModuleGenerator appModuleGenerator;\n private final RequestBuilderGenerator requestBuilderGenerator;\n private final RequestManagerFactoryGenerator requestManagerFactoryGenerator;\n private final GlideGenerator glideGenerator;\n\n AppModuleProcessor(ProcessingEnvironment processingEnv, ProcessorUtil processorUtil) {\n this.processingEnv = processingEnv;\n this.processorUtil = processorUtil;\n\n appModuleGenerator = new AppModuleGenerator(processingEnv, processorUtil);\n requestOptionsGenerator = new RequestOptionsGenerator(processingEnv, processorUtil);\n requestManagerGenerator = new RequestManagerGenerator(processingEnv, processorUtil);\n requestManagerFactoryGenerator =\n new RequestManagerFactoryGenerator(processingEnv, processorUtil);\n glideGenerator = new GlideGenerator(processingEnv, processorUtil);\n requestBuilderGenerator = new RequestBuilderGenerator(processingEnv, processorUtil);\n }\n\n void processModules(Set set, RoundEnvironment env) {\n for (TypeElement element : processorUtil.getElementsFor(GlideModule.class, env)) {\n if (processorUtil.isAppGlideModule(element)) {\n appGlideModules.add(element);\n }\n }\n\n processorUtil.debugLog(\"got app modules: \" + appGlideModules);\n\n if (appGlideModules.size() > 1) {\n throw new IllegalStateException(\n \"You cannot have more than one AppGlideModule, found: \" + appGlideModules);\n }\n }\n\n boolean maybeWriteAppModule() {\n // appGlideModules is added to in order to catch errors where multiple AppGlideModules may be\n // present for a single application or library. Because we only add to appGlideModules, we use\n // isGeneratedAppGlideModuleWritten to make sure the GeneratedAppGlideModule is written at\n // most once.\n if (appGlideModules.isEmpty()) {\n return false;\n }\n TypeElement appModule = appGlideModules.get(0);\n processorUtil.debugLog(\"Processing app module: \" + appModule);\n // If this package is null, it means there are no classes with this package name. One way this\n // could happen is if we process an annotation and reach this point without writing something\n // to the package. We do not error check here because that shouldn't happen with the\n // current implementation.\n PackageElement glideGenPackage =\n processingEnv.getElementUtils().getPackageElement(COMPILER_PACKAGE_NAME);\n FoundIndexedClassNames indexedClassNames = getIndexedClassNames(glideGenPackage);\n\n // Write all generated code to the package containing the AppGlideModule. Doing so fixes\n // classpath collisions if more than one Application containing a AppGlideModule is included\n // in a project.\n String generatedCodePackageName = appModule.getEnclosingElement().toString();\n\n TypeSpec generatedRequestOptions =\n requestOptionsGenerator.generate(generatedCodePackageName, indexedClassNames.extensions);\n writeRequestOptions(generatedCodePackageName, generatedRequestOptions);\n\n TypeSpec generatedRequestBuilder =\n requestBuilderGenerator.generate(\n generatedCodePackageName, indexedClassNames.extensions, generatedRequestOptions);\n writeRequestBuilder(generatedCodePackageName, generatedRequestBuilder);\n\n TypeSpec requestManager =\n requestManagerGenerator.generate(\n generatedCodePackageName,\n generatedRequestOptions,\n generatedRequestBuilder,\n indexedClassNames.extensions);\n writeRequestManager(generatedCodePackageName, requestManager);\n\n TypeSpec requestManagerFactory =\n requestManagerFactoryGenerator.generate(generatedCodePackageName, requestManager);\n writeRequestManagerFactory(requestManagerFactory);\n\n TypeSpec glide =\n glideGenerator.generate(generatedCodePackageName, getGlideName(appModule), requestManager);\n writeGlide(generatedCodePackageName, glide);\n\n TypeSpec generatedAppGlideModule =\n appModuleGenerator.generate(appModule, indexedClassNames.glideModules);\n writeAppModule(generatedAppGlideModule);\n\n processorUtil.infoLog(\"Wrote GeneratedAppGlideModule with: \" + indexedClassNames.glideModules);\n\n return true;\n }\n\n private String getGlideName(TypeElement appModule) {\n return appModule.getAnnotation(GlideModule.class).glideName();\n }\n\n @SuppressWarnings(\"unchecked\")\n private FoundIndexedClassNames getIndexedClassNames(PackageElement glideGenPackage) {\n Set glideModules = new HashSet<>();\n Set extensions = new HashSet<>();\n List glideGeneratedElements = glideGenPackage.getEnclosedElements();\n for (Element indexer : glideGeneratedElements) {\n Index annotation = indexer.getAnnotation(Index.class);\n // If the annotation is null, it means we've come across another class in the same package\n // that we can safely ignore.\n if (annotation != null) {\n Collections.addAll(glideModules, annotation.modules());\n Collections.addAll(extensions, annotation.extensions());\n }\n }\n\n processorUtil.debugLog(\"Found GlideModules: \" + glideModules);\n return new FoundIndexedClassNames(glideModules, extensions);\n }\n\n private void writeGlide(String packageName, TypeSpec glide) {\n processorUtil.writeClass(packageName, glide);\n }\n\n private void writeRequestManager(String packageName, TypeSpec requestManager) {\n processorUtil.writeClass(packageName, requestManager);\n }\n\n // We dont' care about collisions in IDEs since this class isn't an API class.\n private void writeRequestManagerFactory(TypeSpec requestManagerFactory) {\n processorUtil.writeClass(\n AppModuleGenerator.GENERATED_ROOT_MODULE_PACKAGE_NAME, requestManagerFactory);\n }\n\n // The app module we generate subclasses a package private class. We don't care about classpath\n // collisions in IDEs since this class isn't an API class.\n private void writeAppModule(TypeSpec appModule) {\n processorUtil.writeClass(AppModuleGenerator.GENERATED_ROOT_MODULE_PACKAGE_NAME, appModule);\n }\n\n private void writeRequestOptions(String packageName, TypeSpec requestOptions) {\n processorUtil.writeClass(packageName, requestOptions);\n }\n\n private void writeRequestBuilder(String packageName, TypeSpec requestBuilder) {\n processorUtil.writeClass(packageName, requestBuilder);\n }\n\n private static final class FoundIndexedClassNames {\n private final Set glideModules;\n private final Set extensions;\n\n private FoundIndexedClassNames(Set glideModules, Set extensions) {\n this.glideModules = glideModules;\n this.extensions = extensions;\n }\n }\n}\n"
},
{
"path": "annotation/compiler/src/main/java/com/bumptech/glide/annotation/compiler/ExtensionProcessor.java",
"content": "package com.bumptech.glide.annotation.compiler;\n\nimport com.bumptech.glide.annotation.GlideExtension;\nimport com.squareup.javapoet.TypeSpec;\nimport java.util.Collections;\nimport java.util.List;\nimport java.util.Set;\nimport javax.annotation.processing.ProcessingEnvironment;\nimport javax.annotation.processing.RoundEnvironment;\nimport javax.lang.model.element.TypeElement;\n\n/**\n * Writes Indexer classes annotated with {@link Index} for all classes found annotated with {@link\n * GlideExtension}.\n */\nfinal class ExtensionProcessor {\n private final ProcessorUtil processorUtil;\n private final IndexerGenerator indexerGenerator;\n private final GlideExtensionValidator extensionValidator;\n\n ExtensionProcessor(\n ProcessingEnvironment processingEnvironment,\n ProcessorUtil processorUtil,\n IndexerGenerator indexerGenerator) {\n this.processorUtil = processorUtil;\n this.indexerGenerator = indexerGenerator;\n extensionValidator = new GlideExtensionValidator(processingEnvironment, processorUtil);\n }\n\n boolean processExtensions(RoundEnvironment env) {\n List elements = processorUtil.getElementsFor(GlideExtension.class, env);\n processorUtil.debugLog(\"Processing types : \" + elements);\n for (TypeElement typeElement : elements) {\n extensionValidator.validateExtension(typeElement);\n processorUtil.debugLog(\"Processing elements: \" + typeElement.getEnclosedElements());\n }\n\n if (elements.isEmpty()) {\n return false;\n }\n TypeSpec spec = indexerGenerator.generate(elements);\n processorUtil.writeIndexer(spec);\n return true;\n }\n\n Set getSupportedAnnotationTypes() {\n return Collections.singleton(GlideExtension.class.getName());\n }\n}\n"
},
{
"path": "annotation/compiler/src/main/java/com/bumptech/glide/annotation/compiler/GlideAnnotationProcessor.java",
"content": "package com.bumptech.glide.annotation.compiler;\n\nimport com.bumptech.glide.annotation.GlideType;\nimport com.google.auto.service.AutoService;\nimport java.util.HashSet;\nimport java.util.Set;\nimport javax.annotation.processing.AbstractProcessor;\nimport javax.annotation.processing.ProcessingEnvironment;\nimport javax.annotation.processing.Processor;\nimport javax.annotation.processing.RoundEnvironment;\nimport javax.lang.model.SourceVersion;\nimport javax.lang.model.element.TypeElement;\n\n// Links in Javadoc will work due to build setup, even though there is no direct dependency here.\n/**\n * Generates classes based on Glide's annotations that configure Glide, add support for additional\n * resource types, and/or extend Glide's API.\n *\n *
This processor discovers all {@code AppGlideModule} and {@code LibraryGlideModule}\n * implementations that are annotated with {@link com.bumptech.glide.annotation.GlideModule}. Any\n * implementations missing the annotation will be ignored.\n *\n *
This processor also discovers all {@link com.bumptech.glide.annotation.GlideExtension}\n * annotated classes.\n *\n *
Multiple classes are generated by this processor:\n *\n *
\n *
For {@code LibraryGlideModule}s - A GlideIndexer class in a specific package that will\n * later be used by the processor to discover all {@code LibraryGlideModule} classes.\n *
For {@code AppGlideModule}s - A single {@code AppGlideModule} implementation ({@code\n * com.bumptech.glide.GeneratedAppGlideModule}) that calls all {@code LibraryGlideModule}s and\n * the original {@code AppGlideModule} in the correct order when Glide is initialized.\n *
A {@code com.bumptech.glide.request.RequestOptions} implementation that contains\n * static versions of all builder methods in the base class and both static and instance\n * versions of methods in all {@link com.bumptech.glide.annotation.GlideExtension}s.\n *
If one or more methods in one or more {@link\n * com.bumptech.glide.annotation.GlideExtension} annotated classes are annotated with\n * {@link GlideType}:\n *
\n *
A {@code com.bumptech.glide.RequestManager} implementation containing a\n * generated method for each method annotated with {@link GlideType}.\n *
A {@code\n * com.bumptech.glide.manager.RequestManagerRetriever.RequestManagerFactory}\n * implementation that produces the generated {@code\n * com.bumptech.glide.RequestManager}s.\n *
A {@code com.bumptech.glide.Glide} look-alike that implements all static\n * methods in the {@code com.bumptech.glide.Glide} singleton and returns the\n * generated {@code com.bumptech.glide.RequestManager} implementation when\n * appropriate.\n *
\n *
\n *
\n *\n *
{@code AppGlideModule} implementations must only be included in applications, not in\n * libraries. There must be exactly one {@code AppGlideModule} implementation per Application. The\n * {@code AppGlideModule} class is used as a signal that all modules have been found and that the\n * final merged {@code com.bumptech.glide.GeneratedAppGlideModule} impl can be created.\n */\n@AutoService(Processor.class)\npublic final class GlideAnnotationProcessor extends AbstractProcessor {\n static final boolean DEBUG = false;\n private ProcessorUtil processorUtil;\n private LibraryModuleProcessor libraryModuleProcessor;\n private AppModuleProcessor appModuleProcessor;\n private boolean isGeneratedAppGlideModuleWritten;\n private ExtensionProcessor extensionProcessor;\n\n @Override\n public synchronized void init(ProcessingEnvironment processingEnvironment) {\n super.init(processingEnvironment);\n processorUtil = new ProcessorUtil(processingEnvironment);\n IndexerGenerator indexerGenerator = new IndexerGenerator(processorUtil);\n libraryModuleProcessor = new LibraryModuleProcessor(processorUtil, indexerGenerator);\n appModuleProcessor = new AppModuleProcessor(processingEnvironment, processorUtil);\n extensionProcessor =\n new ExtensionProcessor(processingEnvironment, processorUtil, indexerGenerator);\n }\n\n @Override\n public Set getSupportedAnnotationTypes() {\n Set result = new HashSet<>();\n result.addAll(libraryModuleProcessor.getSupportedAnnotationTypes());\n result.addAll(extensionProcessor.getSupportedAnnotationTypes());\n return result;\n }\n\n @Override\n public SourceVersion getSupportedSourceVersion() {\n return SourceVersion.latestSupported();\n }\n\n /**\n * Each round we do the following:\n *\n * \n *
Find all {@code AppGlideModule}s and save them to an instance variable (throw if > 1).\n *
Find all {@code LibraryGlideModule}s\n *
For each {@code LibraryGlideModule}, write an {@code Indexer} with an Annotation with the\n * class name.\n *
If we wrote any {@code Indexer}s, return and wait for the next round.\n *
If we didn't write any {@code Indexer}s and there is a {@code AppGlideModule}, write the\n * {@code GeneratedAppGlideModule}. Once the {@code GeneratedAppGlideModule} is written, we\n * expect to be finished. Any further generation of related classes will result in errors.\n *
\n */\n @Override\n public boolean process(Set set, RoundEnvironment env) {\n processorUtil.process();\n boolean newModulesWritten = libraryModuleProcessor.processModules(env);\n boolean newExtensionWritten = extensionProcessor.processExtensions(env);\n appModuleProcessor.processModules(set, env);\n\n if (newExtensionWritten || newModulesWritten) {\n if (isGeneratedAppGlideModuleWritten) {\n throw new IllegalStateException(\"Cannot process annotations after writing AppGlideModule\");\n }\n return false;\n }\n\n if (!isGeneratedAppGlideModuleWritten) {\n isGeneratedAppGlideModuleWritten = appModuleProcessor.maybeWriteAppModule();\n }\n return false;\n }\n}\n"
},
{
"path": "annotation/compiler/src/main/java/com/bumptech/glide/annotation/compiler/GlideExtensionValidator.java",
"content": "package com.bumptech.glide.annotation.compiler;\n\nimport static com.bumptech.glide.annotation.compiler.ProcessorUtil.nonNulls;\n\nimport com.bumptech.glide.annotation.GlideOption;\nimport com.bumptech.glide.annotation.GlideType;\nimport com.google.common.base.Function;\nimport com.google.common.collect.FluentIterable;\nimport com.squareup.javapoet.ClassName;\nimport java.util.ArrayList;\nimport java.util.List;\nimport java.util.Set;\nimport javax.annotation.processing.ProcessingEnvironment;\nimport javax.lang.model.element.AnnotationMirror;\nimport javax.lang.model.element.Element;\nimport javax.lang.model.element.ElementKind;\nimport javax.lang.model.element.ExecutableElement;\nimport javax.lang.model.element.Modifier;\nimport javax.lang.model.element.TypeElement;\nimport javax.lang.model.element.VariableElement;\nimport javax.lang.model.type.DeclaredType;\nimport javax.lang.model.type.TypeMirror;\nimport javax.tools.Diagnostic.Kind;\n\n/**\n * Validates that classes annotated with {@link com.bumptech.glide.annotation.GlideExtension}\n * contains methods with the expected format.\n *\n *
Validation is performed so that errors can be found when a library is compiled. Without\n * validation, an error written in to a library wouldn't be found until Glide tried to generate code\n * for an Application.\n */\nfinal class GlideExtensionValidator {\n private final ProcessingEnvironment processingEnvironment;\n private final ProcessorUtil processorUtil;\n\n GlideExtensionValidator(\n ProcessingEnvironment processingEnvironment, ProcessorUtil processorUtil) {\n this.processingEnvironment = processingEnvironment;\n this.processorUtil = processorUtil;\n }\n\n void validateExtension(TypeElement typeElement) {\n if (!typeElement.getModifiers().contains(Modifier.PUBLIC)) {\n throw new IllegalArgumentException(\n \"RequestOptionsExtensions must be public, including: \" + getName(typeElement));\n }\n for (Element element : typeElement.getEnclosedElements()) {\n if (element.getKind() == ElementKind.CONSTRUCTOR) {\n validateExtensionConstructor(element);\n } else if (element.getKind() == ElementKind.METHOD) {\n ExecutableElement executableElement = (ExecutableElement) element;\n if (executableElement.getAnnotation(GlideOption.class) != null) {\n validateGlideOption(executableElement);\n } else if (executableElement.getAnnotation(GlideType.class) != null) {\n validateGlideType(executableElement);\n }\n }\n }\n }\n\n private static String getQualifiedMethodName(ExecutableElement executableElement) {\n return getEnclosingClassName(executableElement) + \"#\" + getName(executableElement);\n }\n\n private static String getEnclosingClassName(Element element) {\n return element.getEnclosingElement().toString();\n }\n\n private static String getName(Element element) {\n return element.toString();\n }\n\n private static void validateExtensionConstructor(Element element) {\n if (!element.getModifiers().contains(Modifier.PRIVATE)) {\n throw new IllegalArgumentException(\n \"RequestOptionsExtensions must be public, with private constructors and only static\"\n + \" methods. Found a non-private constructor in: \"\n + getEnclosingClassName(element));\n }\n ExecutableElement executableElement = (ExecutableElement) element;\n if (!executableElement.getParameters().isEmpty()) {\n throw new IllegalArgumentException(\n \"RequestOptionsExtensions must be public, with private constructors and only static\"\n + \" methods. Found parameters in the constructor of: \"\n + getEnclosingClassName(element));\n }\n }\n\n private void validateGlideOption(ExecutableElement executableElement) {\n validateGlideOptionAnnotations(executableElement);\n validateGlideOptionParameters(executableElement);\n TypeMirror returnType = executableElement.getReturnType();\n if (!isBaseRequestOptions(returnType)) {\n throw new IllegalArgumentException(\n \"@GlideOption methods should return a\"\n + \" BaseRequestOptions object, but \"\n + getQualifiedMethodName(executableElement)\n + \" returns \"\n + returnType\n + \". If you're using old style @GlideOption methods, your\"\n + \" method may have a void return type, but doing so is deprecated and support will\"\n + \" be removed in a future version\");\n }\n validateGlideOptionOverride(executableElement);\n }\n\n private void validateGlideOptionAnnotations(ExecutableElement executableElement) {\n validateAnnotatedNonNull(executableElement);\n }\n\n private static void validateGlideOptionParameters(ExecutableElement executableElement) {\n if (executableElement.getParameters().isEmpty()) {\n throw new IllegalArgumentException(\n \"@GlideOption methods must take a \"\n + \"BaseRequestOptions object as their first parameter, but \"\n + getQualifiedMethodName(executableElement)\n + \" has none\");\n }\n VariableElement first = executableElement.getParameters().get(0);\n TypeMirror expected = first.asType();\n if (!isBaseRequestOptions(expected)) {\n throw new IllegalArgumentException(\n \"@GlideOption methods must take a\"\n + \" BaseRequestOptions object as their first parameter, but the first parameter\"\n + \" in \"\n + getQualifiedMethodName(executableElement)\n + \" is \"\n + expected);\n }\n }\n\n private static boolean isBaseRequestOptions(TypeMirror typeMirror) {\n return typeMirror.toString().equals(\"com.bumptech.glide.request.BaseRequestOptions\");\n }\n\n private void validateGlideOptionOverride(ExecutableElement element) {\n int overrideType = processorUtil.getOverrideType(element);\n boolean isOverridingBaseRequestOptionsMethod = isMethodInBaseRequestOptions(element);\n if (isOverridingBaseRequestOptionsMethod && overrideType == GlideOption.OVERRIDE_NONE) {\n throw new IllegalArgumentException(\n \"Accidentally attempting to override a method in\"\n + \" BaseRequestOptions. Add an 'override' value in the @GlideOption annotation\"\n + \" if this is intentional. Offending method: \"\n + getQualifiedMethodName(element));\n } else if (!isOverridingBaseRequestOptionsMethod && overrideType != GlideOption.OVERRIDE_NONE) {\n throw new IllegalArgumentException(\n \"Requested to override an existing method in\"\n + \" BaseRequestOptions, but no such method was found. Offending method: \"\n + getQualifiedMethodName(element));\n }\n }\n\n private boolean isMethodInBaseRequestOptions(ExecutableElement toFind) {\n // toFind is a method in a GlideExtension whose first argument is a BaseRequestOptions type.\n // Since we're comparing against methods in BaseRequestOptions itself, we need to drop that\n // first type.\n TypeElement requestOptionsType =\n processingEnvironment\n .getElementUtils()\n .getTypeElement(RequestOptionsGenerator.BASE_REQUEST_OPTIONS_QUALIFIED_NAME);\n List toFindParameterNames = getComparableParameterNames(toFind, true /*skipFirst*/);\n String toFindSimpleName = toFind.getSimpleName().toString();\n for (Element element : requestOptionsType.getEnclosedElements()) {\n if (element.getKind() != ElementKind.METHOD) {\n continue;\n }\n ExecutableElement inBase = (ExecutableElement) element;\n if (toFindSimpleName.equals(inBase.getSimpleName().toString())) {\n List parameterNamesInBase =\n getComparableParameterNames(inBase, false /*skipFirst*/);\n if (parameterNamesInBase.equals(toFindParameterNames)) {\n return true;\n }\n }\n }\n return false;\n }\n\n private static List getComparableParameterNames(\n ExecutableElement element, boolean skipFirst) {\n List parameters = element.getParameters();\n if (skipFirst) {\n parameters = parameters.subList(1, parameters.size());\n }\n List result = new ArrayList<>(parameters.size());\n for (VariableElement parameter : parameters) {\n result.add(parameter.asType().toString());\n }\n return result;\n }\n\n private void validateGlideType(ExecutableElement executableElement) {\n TypeMirror returnType = executableElement.getReturnType();\n validateGlideTypeAnnotations(executableElement);\n if (!isRequestBuilder(returnType) || !typeMatchesExpected(returnType, executableElement)) {\n String expectedClassName = getGlideTypeValue(executableElement);\n throw new IllegalArgumentException(\n \"@GlideType methods should return a RequestBuilder<\"\n + expectedClassName\n + \"> object, but \"\n + getQualifiedMethodName(executableElement)\n + \" returns: \"\n + returnType\n + \". If you're using old style @GlideType methods, your\"\n + \" method may have a void return type, but doing so is deprecated and support will\"\n + \" be removed in a future version\");\n }\n validateGlideTypeParameters(executableElement);\n }\n\n private String getGlideTypeValue(ExecutableElement executableElement) {\n return processorUtil\n .findClassValuesFromAnnotationOnClassAsNames(executableElement, GlideType.class)\n .iterator()\n .next();\n }\n\n private boolean typeMatchesExpected(TypeMirror returnType, ExecutableElement executableElement) {\n if (!(returnType instanceof DeclaredType)) {\n return false;\n }\n List typeArguments = ((DeclaredType) returnType).getTypeArguments();\n if (typeArguments.size() != 1) {\n return false;\n }\n TypeMirror argument = typeArguments.get(0);\n String expected = getGlideTypeValue(executableElement);\n return argument.toString().equals(expected);\n }\n\n private boolean isRequestBuilder(TypeMirror typeMirror) {\n TypeMirror toCompare = processingEnvironment.getTypeUtils().erasure(typeMirror);\n return toCompare.toString().equals(\"com.bumptech.glide.RequestBuilder\");\n }\n\n private static void validateGlideTypeParameters(ExecutableElement executableElement) {\n if (executableElement.getParameters().size() != 1) {\n throw new IllegalArgumentException(\n \"@GlideType methods must take a\"\n + \" RequestBuilder object as their first and only parameter, but given multiple for: \"\n + getQualifiedMethodName(executableElement));\n }\n\n VariableElement first = executableElement.getParameters().get(0);\n TypeMirror argumentType = first.asType();\n if (!argumentType.toString().startsWith(\"com.bumptech.glide.RequestBuilder\")) {\n throw new IllegalArgumentException(\n \"@GlideType methods must take a\"\n + \" RequestBuilder object as their first and only parameter, but given: \"\n + argumentType\n + \" for: \"\n + getQualifiedMethodName(executableElement));\n }\n }\n\n private void validateGlideTypeAnnotations(ExecutableElement executableElement) {\n validateAnnotatedNonNull(executableElement);\n }\n\n private void validateAnnotatedNonNull(ExecutableElement executableElement) {\n Set annotationNames =\n FluentIterable.from(executableElement.getAnnotationMirrors())\n .transform(\n new Function() {\n @Override\n public String apply(AnnotationMirror input) {\n return input.getAnnotationType().asElement().toString();\n }\n })\n .toSet();\n boolean noNonNull = true;\n for (ClassName nonNull : nonNulls()) {\n if (annotationNames.contains(nonNull.reflectionName())) {\n noNonNull = false;\n break;\n }\n }\n if (noNonNull) {\n processingEnvironment\n .getMessager()\n .printMessage(\n Kind.WARNING,\n getQualifiedMethodName(executableElement)\n + \" is missing the \"\n + processorUtil.nonNull().reflectionName()\n + \" annotation,\"\n + \" please add it to ensure that your extension methods are always returning\"\n + \" non-null values\");\n }\n }\n}\n"
},
{
"path": "annotation/compiler/src/main/java/com/bumptech/glide/annotation/compiler/GlideGenerator.java",
"content": "package com.bumptech.glide.annotation.compiler;\n\nimport com.bumptech.glide.annotation.GlideExtension;\nimport com.google.common.base.Function;\nimport com.google.common.base.Preconditions;\nimport com.google.common.collect.Lists;\nimport com.squareup.javapoet.AnnotationSpec;\nimport com.squareup.javapoet.ClassName;\nimport com.squareup.javapoet.MethodSpec;\nimport com.squareup.javapoet.MethodSpec.Builder;\nimport com.squareup.javapoet.ParameterSpec;\nimport com.squareup.javapoet.TypeSpec;\nimport java.util.ArrayList;\nimport java.util.List;\nimport javax.annotation.processing.ProcessingEnvironment;\nimport javax.lang.model.element.AnnotationMirror;\nimport javax.lang.model.element.ExecutableElement;\nimport javax.lang.model.element.Modifier;\nimport javax.lang.model.element.TypeElement;\nimport javax.lang.model.util.Elements;\n\n/**\n * Generates a Glide look-alike that acts as the entry point to the generated API\n * (GlideApp.with(...)).\n *\n *
Generated {@code com.bumptech.glide.Glide} look-alikes look like this (note that the name is\n * configurable in {@link com.bumptech.glide.annotation.GlideModule}):\n *\n *