org.wartremover.warts.Null.scala Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of wartremover_2.12.20 Show documentation
wartremover
There is a newer version: 3.2.4
package org.wartremover
package warts

import scala.reflect.NameTransformer

object Null extends WartTraverser {
  def apply(u: WartUniverse): u.Traverser = {
    import u.universe._

    val Equals = TermName(NameTransformer.encode("=="))
    val NotEquals = TermName(NameTransformer.encode("!="))
    val Eq = TermName(NameTransformer.encode("eq"))
    val Ne = TermName(NameTransformer.encode("ne"))
    val xmlSymbols = List(
      "scala.xml.Elem",
      "scala.xml.NamespaceBinding"
    ) // cannot do `map rootMirror.staticClass` here because then:
    //   scala.ScalaReflectionException: object scala.xml.Elem in compiler mirror not found.

    val optionSymbol = rootMirror.staticClass("scala.Option")
    val OrNull = TermName("orNull")

    new u.Traverser {
      override def traverse(tree: Tree): Unit = {
        val synthetic = isSynthetic(u)(tree)
        tree match {
          // Ignore trees marked by SuppressWarnings
          case t if hasWartAnnotation(u)(t) =>
          // Ignore xml literals
          case Apply(Select(left, _), _) if xmlSymbols.contains(left.tpe.typeSymbol.fullName) =>
          // Ignore synthetic methods in companion objects
          case ModuleDef(mods, _, Template(parents, self, stats)) =>
            mods.annotations foreach { annotation =>
              traverse(annotation)
            }
            parents foreach { parent =>
              traverse(parent)
            }
            traverse(self)
            stats filter {
              case dd: DefDef if isSynthetic(u)(dd) =>
                false
              case _ =>
                true
            } foreach { stat =>
              traverse(stat)
            }

          // Ignore null == _, null != _
          case Select(Literal(Constant(null)), Equals) =>
          case Select(Literal(Constant(null)), NotEquals) =>
          // Ignore _ == null, _ != null
          case Apply(Select(t, Equals), List(Literal(Constant(null)))) =>
            super.traverse(t)
          case Apply(Select(t, NotEquals), List(Literal(Constant(null)))) =>
            super.traverse(t)
          // Ignore null eq _, null ne _
          case Select(Literal(Constant(null)), Eq) =>
          case Select(Literal(Constant(null)), Ne) =>
          // Ignore _ eq null, _ ne null
          case Apply(Select(t, Eq), List(Literal(Constant(null)))) =>
            super.traverse(t)
          case Apply(Select(t, Ne), List(Literal(Constant(null)))) =>
            super.traverse(t)

          case Literal(Constant(null)) =>
            error(u)(tree.pos, "null is disabled")
            super.traverse(tree)

          // var s: String = _
          case ValDef(mods, name, t, _)
              if mods.hasFlag(Flag.DEFAULTINIT) && !isPrimitive(u)(t.tpe) && !(t.tpe <:< typeOf[Unit]) =>
            error(u)(tree.pos, "null is disabled")

          // Option.orNull (which returns null) is disabled.
          case Select(left, OrNull) if left.tpe.baseType(optionSymbol) != NoType =>
            error(u)(tree.pos, "Option#orNull is disabled")

          // Scala pattern matching outputs synthetic null.asInstanceOf[X]
          case ValDef(mods, _, _, _) if mods.hasFlag(Flag.MUTABLE) && synthetic =>
          // TODO: This ignores a lot
          case LabelDef(_, _, _) if synthetic =>
          case _ =>
            super.traverse(tree)
        }
      }
    }
  }
}