From d3b89cc19da117568efb43e783a1e90d9c17bd4f Mon Sep 17 00:00:00 2001
From: Simon Schaefer <mail@antoras.de>
Date: Tue, 9 Sep 2014 21:08:40 +0200
Subject: [PATCH] Refactorings in `AddMissingOverride`

---
 .../saveactions/AddMissingOverride.scala      | 56 ++++++++++---------
 1 file changed, 31 insertions(+), 25 deletions(-)

diff --git a/org.scala-ide.sdt.core/src/org/scalaide/extensions/saveactions/AddMissingOverride.scala b/org.scala-ide.sdt.core/src/org/scalaide/extensions/saveactions/AddMissingOverride.scala
index 25e76464b2..33066dcef1 100644
--- a/org.scala-ide.sdt.core/src/org/scalaide/extensions/saveactions/AddMissingOverride.scala
+++ b/org.scala-ide.sdt.core/src/org/scalaide/extensions/saveactions/AddMissingOverride.scala
@@ -29,21 +29,14 @@ trait AddMissingOverride extends SaveAction with CompilerSupport {
     def canOverride(sym: Symbol) = sym.isOverridingSymbol && !sym.isOverride && !sym.isAbstractOverride
 
     val symbolWithoutOverride = filter {
-      case d: ValDef if isJavaField(getterOf(d.symbol)) ⇒
+      case d: ValOrDefDef if overridesJavaField(d.symbol) ⇒
         false
 
-      case d: DefDef if isJavaField(d.symbol) ⇒
+      case d: ValDef if d.mods.positions.contains(Tokens.VAR) && !overridesVar(d.symbol) ⇒
         false
 
-      case d: ValDef if d.mods.positions.contains(Tokens.VAR) && !overridesVar(getterOf(d.symbol)) ⇒
-        false
-
-      case d: ValDef =>
-        val getter = getterOf(d.symbol)
-        canOverride(if (getter != NoSymbol) getter else d.symbol)
-
-      case d @ (_: DefDef | _: TypeDef) =>
-        canOverride(d.symbol)
+      case d: MemberDef =>
+        canOverride(accessorOf(d.symbol))
     }
 
     val addOverrideKeyword = transform {
@@ -84,27 +77,40 @@ trait AddMissingOverride extends SaveAction with CompilerSupport {
     transformFile(refactoring)
   }
 
-  private def getterOf(sym: Symbol): Symbol =
-    sym.getterIn(sym.owner)
+  /**
+   * Returns the getter of `symbol` or `symbol` itself if no getter exists.
+   */
+  private def accessorOf(symbol: Symbol): Symbol =
+    if (symbol.hasGetter) symbol.getterIn(symbol.owner) else symbol
 
+  /**
+   * Returns true if `symbol` overrides a var.
+   */
   private def overridesVar(symbol: Symbol): Boolean = {
-    val base = symbol.owner
-    val baseType = base.toType
-    val bcs = base.info.baseClasses dropWhile (symbol.owner != _) drop 1
+    val s = superSymbolOf(accessorOf(symbol))
+    s.setterIn(s.owner) != NoSymbol
+  }
 
-    bcs exists { sym ⇒
-      symbol.matchingSymbol(sym, baseType).setterIn(sym) != NoSymbol
-    }
+  /**
+   * Returns true if `symbol` overrides a field defined with Java.
+   */
+  private def overridesJavaField(symbol: Symbol): Boolean = {
+    val s = superSymbolOf(accessorOf(symbol))
+    s.isJava && !s.isMethod
   }
 
-  private def isJavaField(symbol: Symbol): Boolean = {
+  /**
+   * Finds the symbol which is overridden by `symbol`. If there exists more than
+   * one (which can be the case in a deep inheritance hierarchy) the first one
+   * that is found is returned.
+   *
+   * Returns `NoSymbol` if no overridden symbol is found.
+   */
+  private def superSymbolOf(symbol: Symbol): Symbol = {
     val base = symbol.owner
     val baseType = base.toType
-    val bcs = base.info.baseClasses dropWhile (symbol.owner != _) drop 1
+    val bcs = base.info.baseClasses.iterator dropWhile (symbol.owner != _) drop 1
 
-    bcs exists { sym ⇒
-      val s = symbol.matchingSymbol(sym, baseType)
-      s.isJava && !s.isMethod
-    }
+    bcs map (symbol.matchingSymbol(_, baseType)) find (_ != NoSymbol) getOrElse NoSymbol
   }
 }