Issue 3753. Support for @deprecated annotation

editor/tools/plugins/com.google.dart.tools.ui/src/com/google/dart/tools/ui/internal/text/editor/SemanticHighlightings.java

 /*
  * Copyright (c) 2012, the Dart project authors.
  * 
  * Licensed under the Eclipse Public License v1.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.eclipse.org/legal/epl-v10.html
  * 
  * 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.
  */
 package com.google.dart.tools.ui.internal.text.editor;
 
 import com.google.dart.compiler.ast.DartIdentifier;
 import com.google.dart.compiler.ast.Modifiers;
 import com.google.dart.compiler.resolver.FieldElement;
 import com.google.dart.compiler.resolver.NodeElement;
 import com.google.dart.tools.core.utilities.ast.DynamicTypesFinder;
 import com.google.dart.tools.ui.PreferenceConstants;
 
 import org.eclipse.jface.preference.IPreferenceStore;
 import org.eclipse.jface.preference.PreferenceConverter;
 import org.eclipse.jface.util.PropertyChangeEvent;
 import org.eclipse.swt.graphics.RGB;
 
 /**
- * Semantic highlightings
+ * Semantic highlightings.
  */
 public class SemanticHighlightings {
 
   /**
+   * Abstract {@link SemanticHighlighting} with empty methods by default.
+   */
+  private static abstract class DefaultSemanticHighlighting extends SemanticHighlighting {
+
+    @Override
+    public RGB getDefaultDefaultTextColor() {
+      return new RGB(0, 0, 0);
+    }
+
+    @Override
+    public boolean isBoldByDefault() {
+      return false;
+    }
+
+    @Override
+    public boolean isEnabledByDefault() {
+      return false;
+    }
+
+    @Override
+    public boolean isItalicByDefault() {
+      return false;
+    }
+
+    @Override
+    public boolean isStrikethroughByDefault() {
+      return false;
+    }
+
+    @Override
+    public boolean isUnderlineByDefault() {
+      return false;
+    }
+  }
+
+  /**
+   * Semantic highlighting deprecated elements.
+   */
+  private static final class DeprecatedElementHighlighting extends DefaultSemanticHighlighting {
+    @Override
+    public boolean consumes(SemanticToken token) {
+      DartIdentifier node = token.getNode();
+      NodeElement element = node.getElement();
+      return element != null && element.getMetadata().isDeprecated();
+    }
+
+    @Override
+    public String getDisplayName() {
+      return DartEditorMessages.SemanticHighlighting_deprecatedElement;
+    }
+
+    @Override
+    public String getPreferenceKey() {
+      return DEPRECATED_ELEMENT;
+    }
+
+    @Override
+    public boolean isStrikethroughByDefault() {
+      return true;
+    }
+  }
+
+  /**
    * Semantic highlighting for variables with dynamic types.
    */
-  private static final class DynamicTypeHighlighting extends SemanticHighlighting {
+  private static final class DynamicTypeHighlighting extends DefaultSemanticHighlighting {
 
     @Override
     public boolean consumes(SemanticToken token) {
       DartIdentifier node = token.getNode();
       return DynamicTypesFinder.isDynamic(node);
     }
 
     @Override
     public RGB getDefaultDefaultTextColor() {
 //      return new RGB(237, 145, 33); //carrot
 //      return new RGB(184, 115, 51); //copper
 //      return new RGB(0xd7, 0x96, 0x7d); //taupe
       return new RGB(0x67, 0x4C, 0x47); //dark taupe
     }
 
     @Override
     public String getDisplayName() {
       return DartEditorMessages.SemanticHighlighting_dynamicType;
     }
 
     @Override
     public String getPreferenceKey() {
       return DYNAMIC_TYPE;
     }
-
-    @Override
-    public boolean isBoldByDefault() {
-      return false;
-    }
-
-    @Override
-    public boolean isEnabledByDefault() {
-      return false;
-    }
-
-    @Override
-    public boolean isItalicByDefault() {
-      return false;
-    }
-
-    @Override
-    public boolean isUnderlineByDefault() {
-      return false;
-    }
   }
 
   /**
    * Semantic highlighting for fields.
    */
-  private static class FieldHighlighting extends SemanticHighlighting {
+  private static class FieldHighlighting extends DefaultSemanticHighlighting {
 
     @Override
     public boolean consumes(SemanticToken token) {
       DartIdentifier node = token.getNode();
       NodeElement element = node.getElement();
       if (element == null || element.isDynamic()) {
         return false;
       }
       if (element instanceof FieldElement) {
         FieldElement field = (FieldElement) element;
@@ skipping 11 matching lines @@
 
     @Override
     public String getDisplayName() {
       return DartEditorMessages.SemanticHighlighting_field;
     }
 
     @Override
     public String getPreferenceKey() {
       return FIELD;
     }
-
-    @Override
-    public boolean isBoldByDefault() {
-      return false;
-    }
-
-    @Override
-    public boolean isEnabledByDefault() {
-      return false;
-    }
-
-    @Override
-    public boolean isItalicByDefault() {
-      return false;
-    }
-
-    @Override
-    public boolean isUnderlineByDefault() {
-      return false;
-    }
   }
 
   /**
    * Semantic highlighting for static fields.
    */
-  private static class StaticFieldHighlighting extends FieldHighlighting {
+  private static class StaticFieldHighlighting extends DefaultSemanticHighlighting {
     @Override
     public boolean consumes(SemanticToken token) {
       DartIdentifier node = token.getNode();
       NodeElement element = node.getElement();
       if (element == null || element.isDynamic()) {
         return false;
       }
       if (element instanceof FieldElement) {
         return ((FieldElement) element).isStatic();
       }
@@ skipping 11 matching lines @@
     }
 
     @Override
     public boolean isItalicByDefault() {
       return true;
     }
 
   }
 
   /**
+   * A named preference part that controls the highlighting of deprecated elements.
+   */
+  public static final String DEPRECATED_ELEMENT = "deprecated"; //$NON-NLS-1$
+
+  /**
    * A named preference part that controls the highlighting of static final fields.
    */
   public static final String STATIC_FINAL_FIELD = "staticFinalField"; //$NON-NLS-1$
 
   /**
    * A named preference part that controls the highlighting of static fields.
    */
   public static final String STATIC_FIELD = "staticField"; //$NON-NLS-1$
 
   /**
@@ skipping 170 matching lines @@
         + PreferenceConstants.EDITOR_SEMANTIC_HIGHLIGHTING_ITALIC_SUFFIX;
   }
 
   /**
    * @return The semantic highlightings, the order defines the precedence of matches, the first
    *         match wins.
    */
   public static SemanticHighlighting[] getSemanticHighlightings() {
     if (SEMANTIC_HIGHTLIGHTINGS == null) {
       SEMANTIC_HIGHTLIGHTINGS = new SemanticHighlighting[] {
-          new StaticFieldHighlighting(), new FieldHighlighting(), new DynamicTypeHighlighting()};
+          new DeprecatedElementHighlighting(), new StaticFieldHighlighting(),
+          new FieldHighlighting(), new DynamicTypeHighlighting()};
     }
     return SEMANTIC_HIGHTLIGHTINGS;
   }
 
   /**
    * A named preference that controls if the given semantic highlighting has the text attribute
    * strikethrough.
    * 
    * @param semanticHighlighting the semantic highlighting
    * @return the strikethrough preference key
@@ skipping 91 matching lines @@
   /**
    * Do not instantiate
    */
   private SemanticHighlightings() {
   }
 
   public RGB getDefaultDefaultTextColor() {
     return new RGB(13, 100, 0);
   }
 }