From dfee198c0e05b8ccc3206515d4a1232309cd5374 Mon Sep 17 00:00:00 2001 From: ghik Date: Sat, 11 Apr 2015 00:30:28 +0200 Subject: [PATCH] initial commit --- .gitignore | 20 ++ README.md | 2 + build.sbt | 16 ++ license.txt | 202 ++++++++++++++++++ project/build.properties | 1 + .../main/scala/rjghik/silencer/silent.scala | 10 + .../src/main/resources/scalac-plugin.xml | 4 + .../rjghik/silencer/SilencerPlugin.scala | 59 +++++ .../rjghik/silencer/SuppressingReporter.scala | 62 ++++++ .../rjghik/silencer/SilencerPluginTest.scala | 65 ++++++ .../testdata/classSuppression.scala | 10 + silencer-plugin/testdata/lateWarning.scala | 3 + .../testdata/localValueSuppression.scala | 11 + .../testdata/methodSuppression.scala | 10 + .../testdata/statementSuppression.scala | 9 + silencer-plugin/testdata/unsuppressed.scala | 7 + 16 files changed, 491 insertions(+) create mode 100644 .gitignore create mode 100644 README.md create mode 100644 build.sbt create mode 100644 license.txt create mode 100644 project/build.properties create mode 100644 silencer-lib/src/main/scala/rjghik/silencer/silent.scala create mode 100644 silencer-plugin/src/main/resources/scalac-plugin.xml create mode 100644 silencer-plugin/src/main/scala/rjghik/silencer/SilencerPlugin.scala create mode 100644 silencer-plugin/src/main/scala/rjghik/silencer/SuppressingReporter.scala create mode 100644 silencer-plugin/src/test/scala/rjghik/silencer/SilencerPluginTest.scala create mode 100644 silencer-plugin/testdata/classSuppression.scala create mode 100644 silencer-plugin/testdata/lateWarning.scala create mode 100644 silencer-plugin/testdata/localValueSuppression.scala create mode 100644 silencer-plugin/testdata/methodSuppression.scala create mode 100644 silencer-plugin/testdata/statementSuppression.scala create mode 100644 silencer-plugin/testdata/unsuppressed.scala diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..ddc7c82 --- /dev/null +++ b/.gitignore @@ -0,0 +1,20 @@ +*.class +*.log + +# sbt specific +.cache +.history +.lib/ +dist/* +target/ +lib_managed/ +src_managed/ +project/boot/ +project/plugins/project/ + +# IntelliJ specific +*.iml +*.ipr +*.iws +.idea/ + diff --git a/README.md b/README.md new file mode 100644 index 0000000..4f32b27 --- /dev/null +++ b/README.md @@ -0,0 +1,2 @@ +## Scala compiler plugin for annotation-based warning suppression + diff --git a/build.sbt b/build.sbt new file mode 100644 index 0000000..034c3f6 --- /dev/null +++ b/build.sbt @@ -0,0 +1,16 @@ +(name in Global) := "silencer" + +(organization in Global) := "rjghik" + +(version in Global) := "0.1" + +(scalaVersion in Global) := "2.11.6" + +lazy val `silencer-lib` = project + +lazy val `silencer-plugin` = project.dependsOn(`silencer-lib`).settings( + libraryDependencies ++= Seq( + "org.scala-lang" % "scala-compiler" % scalaVersion.value, + "org.scalatest" %% "scalatest" % "2.2.4" % "test" + ) +) diff --git a/license.txt b/license.txt new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/license.txt @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/project/build.properties b/project/build.properties new file mode 100644 index 0000000..a6e117b --- /dev/null +++ b/project/build.properties @@ -0,0 +1 @@ +sbt.version=0.13.8 diff --git a/silencer-lib/src/main/scala/rjghik/silencer/silent.scala b/silencer-lib/src/main/scala/rjghik/silencer/silent.scala new file mode 100644 index 0000000..7d27e49 --- /dev/null +++ b/silencer-lib/src/main/scala/rjghik/silencer/silent.scala @@ -0,0 +1,10 @@ +package rjghik.silencer + +import scala.annotation.StaticAnnotation + +/** + * When silencer compiler plugin is enabled, this annotation suppresses all warnings emitted by scalac for some portion + * of source code. It can be applied on any definition (`class`, def`, `val`, `var`, etc.) or on arbitrary expression, + * e.g. {123; 456}: @silent` + */ +class silent extends StaticAnnotation diff --git a/silencer-plugin/src/main/resources/scalac-plugin.xml b/silencer-plugin/src/main/resources/scalac-plugin.xml new file mode 100644 index 0000000..b9160be --- /dev/null +++ b/silencer-plugin/src/main/resources/scalac-plugin.xml @@ -0,0 +1,4 @@ + + silencer + rjghik.silencer.SilencerPlugin + diff --git a/silencer-plugin/src/main/scala/rjghik/silencer/SilencerPlugin.scala b/silencer-plugin/src/main/scala/rjghik/silencer/SilencerPlugin.scala new file mode 100644 index 0000000..6deaaf3 --- /dev/null +++ b/silencer-plugin/src/main/scala/rjghik/silencer/SilencerPlugin.scala @@ -0,0 +1,59 @@ +package rjghik.silencer + +import scala.reflect.internal.util.Position +import scala.tools.nsc.plugins.{Plugin, PluginComponent} +import scala.tools.nsc.{Global, Phase} + +class SilencerPlugin(val global: Global) extends Plugin { + plugin => + + val name = "SilencerPlugin" + val description = "Scala compiler plugin for warning suppression" + val components: List[PluginComponent] = List(component) + + private val reporter = new SuppressingReporter(global.reporter) + global.reporter = reporter + + private object component extends PluginComponent { + val global = plugin.global + val runsAfter = List("typer") + val phaseName = "silencer" + + import global._ + + def newPhase(prev: Phase) = new StdPhase(prev) { + def apply(unit: CompilationUnit) = applySuppressions(unit) + } + + def applySuppressions(unit: CompilationUnit): Unit = { + val silentAnnotType = typeOf[silent] + def isSilentAnnot(tree: Tree) = + tree.tpe != null && tree.tpe <:< silentAnnotType + + val suppressedTrees = unit.body.collect { + case Annotated(annot, tree) if isSilentAnnot(annot) => tree + case Typed(tree, tpt) if tpt.tpe.annotations.exists(ai => isSilentAnnot(ai.tree)) => tree + case md: MemberDef if md.symbol.annotations.exists(ai => isSilentAnnot(ai.tree)) => md + } + + def treeRangePos(tree: Tree): Position = { + // compute approximate range + var start = unit.source.length + var end = 0 + tree.foreach { child => + val pos = child.pos + if (pos.isDefined) { + start = start min pos.start + end = end max pos.end + } + } + Position.range(unit.source, start, start, end) + } + + val suppressedRanges = suppressedTrees.map(treeRangePos) + + plugin.reporter.setSuppressedRanges(unit.source, suppressedRanges) + } + } +} + diff --git a/silencer-plugin/src/main/scala/rjghik/silencer/SuppressingReporter.scala b/silencer-plugin/src/main/scala/rjghik/silencer/SuppressingReporter.scala new file mode 100644 index 0000000..0374653 --- /dev/null +++ b/silencer-plugin/src/main/scala/rjghik/silencer/SuppressingReporter.scala @@ -0,0 +1,62 @@ +package rjghik.silencer + +import scala.collection.mutable +import scala.collection.mutable.ArrayBuffer +import scala.reflect.internal.util.{Position, SourceFile} +import scala.tools.nsc.reporters.Reporter + +class SuppressingReporter(original: Reporter) extends Reporter { + private val deferredWarnings = new mutable.HashMap[SourceFile, ArrayBuffer[(Position, String)]] + private val suppressedRanges = new mutable.HashMap[SourceFile, List[Position]] + + def setSuppressedRanges(source: SourceFile, ranges: List[Position]): Unit = { + suppressedRanges(source) = ranges + for ((pos, msg) <- deferredWarnings.remove(source).getOrElse(Seq.empty) if !ranges.exists(_.includes(pos))) { + original.warning(pos, msg) + } + } + + override def reset() { + super.reset() + original.reset() + deferredWarnings.clear() + suppressedRanges.clear() + } + + protected def info0(pos: Position, msg: String, severity: Severity, force: Boolean) { + severity match { + case INFO => + original.info(pos, msg, force) + case WARNING if !suppressedRanges.contains(pos.source) => + deferredWarnings.getOrElseUpdate(pos.source, new ArrayBuffer) += ((pos, msg)) + case WARNING if !suppressedRanges(pos.source).exists(_.includes(pos)) => + original.warning(pos, msg) + case WARNING => + () + case ERROR => original.error(pos, msg) + } + updateCounts() + } + + private def updateCounts(): Unit = { + INFO.count = original.INFO.count + WARNING.count = original.WARNING.count + ERROR.count = original.ERROR.count + } + + private def originalSeverity(severity: Severity) = severity match { + case INFO => original.INFO + case WARNING => original.WARNING + case ERROR => original.ERROR + } + + override def resetCount(severity: Severity) = { + super.resetCount(severity) + original.resetCount(originalSeverity(severity)) + } + + override def flush() = { + super.flush() + original.flush() + } +} diff --git a/silencer-plugin/src/test/scala/rjghik/silencer/SilencerPluginTest.scala b/silencer-plugin/src/test/scala/rjghik/silencer/SilencerPluginTest.scala new file mode 100644 index 0000000..9d76a0d --- /dev/null +++ b/silencer-plugin/src/test/scala/rjghik/silencer/SilencerPluginTest.scala @@ -0,0 +1,65 @@ +package rjghik.silencer + +import java.io.File + +import org.scalatest.FunSuite + +import scala.reflect.io.VirtualDirectory +import scala.tools.nsc.reporters.ConsoleReporter +import scala.tools.nsc.{Global, Settings} + +class SilencerPluginTest extends FunSuite { + suite => + + val settings = new Settings + settings.usejavacp.value = true + // avoid saving classfiles to disk + settings.outputDirs.setSingleOutput(new VirtualDirectory("(memory)", None)) + val reporter = new ConsoleReporter(settings) + + val global = new Global(settings, reporter) { + override protected def loadRoughPluginsList() = + new SilencerPlugin(this) :: super.loadRoughPluginsList() + } + + def compile(filenames: String*): Unit = { + val run = new global.Run + run.compile(filenames.toList.map("testdata/" + _)) + } + + def assertWarnings(count: Int): Unit = { + assert(!reporter.hasErrors) + assert(count === reporter.warningCount) + } + + test("no suppression") { + compile("unsuppressed.scala") + assertWarnings(1) + } + + test("statement suppression") { + compile("statementSuppression.scala") + assertWarnings(0) + } + + test("local value suppression") { + compile("localValueSuppression.scala") + assertWarnings(0) + } + + test("method suppression") { + compile("methodSuppression.scala") + assertWarnings(0) + } + + test("class suppression") { + compile("classSuppression.scala") + assertWarnings(0) + } + + test("multiple files compilation") { + compile(new File("testdata").listFiles().map(_.getName): _*) + assertWarnings(1) + } + +} diff --git a/silencer-plugin/testdata/classSuppression.scala b/silencer-plugin/testdata/classSuppression.scala new file mode 100644 index 0000000..eb4a488 --- /dev/null +++ b/silencer-plugin/testdata/classSuppression.scala @@ -0,0 +1,10 @@ +package testdata + +import rjghik.silencer.silent + +@silent +object classSuppression { + def method(): Unit = { + 123 + } +} diff --git a/silencer-plugin/testdata/lateWarning.scala b/silencer-plugin/testdata/lateWarning.scala new file mode 100644 index 0000000..123aeb6 --- /dev/null +++ b/silencer-plugin/testdata/lateWarning.scala @@ -0,0 +1,3 @@ +object lateWarning { + +} diff --git a/silencer-plugin/testdata/localValueSuppression.scala b/silencer-plugin/testdata/localValueSuppression.scala new file mode 100644 index 0000000..5c3a718 --- /dev/null +++ b/silencer-plugin/testdata/localValueSuppression.scala @@ -0,0 +1,11 @@ +import rjghik.silencer.silent + +object localValueSuppression { + def method(): Unit = { + @silent + val stuff = { + 123 + 543 + } + } +} diff --git a/silencer-plugin/testdata/methodSuppression.scala b/silencer-plugin/testdata/methodSuppression.scala new file mode 100644 index 0000000..c995137 --- /dev/null +++ b/silencer-plugin/testdata/methodSuppression.scala @@ -0,0 +1,10 @@ +package testdata + +import rjghik.silencer.silent + +object methodSuppression { + @silent + def method(): Unit = { + 123 + } +} diff --git a/silencer-plugin/testdata/statementSuppression.scala b/silencer-plugin/testdata/statementSuppression.scala new file mode 100644 index 0000000..1fa265e --- /dev/null +++ b/silencer-plugin/testdata/statementSuppression.scala @@ -0,0 +1,9 @@ +package testdata + +import rjghik.silencer.silent + +object statementSuppression { + def method(): Unit = { + 123: @silent + } +} diff --git a/silencer-plugin/testdata/unsuppressed.scala b/silencer-plugin/testdata/unsuppressed.scala new file mode 100644 index 0000000..3d5e6f8 --- /dev/null +++ b/silencer-plugin/testdata/unsuppressed.scala @@ -0,0 +1,7 @@ +package testdata + +object unsuppressed { + def method(): Unit = { + 123 + } +}