pkg/analysis_server/lib/src/services/refactoring/rename_class_member.dart

// Copyright (c) 2014, the Dart project authors.  Please see the AUTHORS file
// for details. All rights reserved. Use of this source code is governed by a
// BSD-style license that can be found in the LICENSE file.

library services.src.refactoring.rename_class_member;

import 'dart:async';

import 'package:analysis_server/src/protocol_server.dart' hide Element,
    ElementKind;
import 'package:analysis_server/src/services/correction/status.dart';
import 'package:analysis_server/src/services/correction/util.dart';
import 'package:analysis_server/src/services/refactoring/naming_conventions.dart';
import 'package:analysis_server/src/services/refactoring/refactoring.dart';
import 'package:analysis_server/src/services/refactoring/refactoring_internal.dart';
import 'package:analysis_server/src/services/refactoring/rename.dart';
import 'package:analysis_server/src/services/search/hierarchy.dart';
import 'package:analysis_server/src/services/search/search_engine.dart';
import 'package:analyzer/src/generated/element.dart';
import 'package:analyzer/src/generated/java_core.dart';


/**
 * Checks if creating a method with the given [name] in [classElement] will
 * cause any conflicts.
 */
Future<RefactoringStatus> validateCreateMethod(SearchEngine searchEngine,
    ClassElement classElement, String name) {
  return new _ClassMemberValidator.forCreate(
      searchEngine,
      classElement,
      name).validate();
}


/**
 * A [Refactoring] for renaming class member [Element]s.
 */
class RenameClassMemberRefactoringImpl extends RenameRefactoringImpl {
  _ClassMemberValidator _validator;

  RenameClassMemberRefactoringImpl(SearchEngine searchEngine, Element element)
      : super(searchEngine, element);

  @override
  String get refactoringName {
    if (element is TypeParameterElement) {
      return "Rename Type Parameter";
    }
    if (element is FieldElement) {
      return "Rename Field";
    }
    return "Rename Method";
  }

  @override
  Future<RefactoringStatus> checkFinalConditions() {
    _validator =
        new _ClassMemberValidator.forRename(searchEngine, element, newName);
    return _validator.validate();
  }

  @override
  Future<RefactoringStatus> checkInitialConditions() {
    RefactoringStatus result = new RefactoringStatus();
    if (element is MethodElement && (element as MethodElement).isOperator) {
      result.addFatalError('Cannot rename operator.');
    }
    return new Future.value(result);
  }

  @override
  RefactoringStatus checkNewName() {
    RefactoringStatus result = super.checkNewName();
    if (element is FieldElement) {
      FieldElement fieldElement = element as FieldElement;
      if (fieldElement.isStatic && fieldElement.isConst) {
        result.addStatus(validateConstantName(newName));
      } else {
        result.addStatus(validateFieldName(newName));
      }
    }
    if (element is MethodElement) {
      result.addStatus(validateMethodName(newName));
    }
    return result;
  }

  @override
  Future fillChange() {
    // update declarations
    for (Element renameElement in _validator.elements) {
      if (renameElement.isSynthetic && renameElement is FieldElement) {
        addDeclarationEdit(renameElement.getter);
        addDeclarationEdit(renameElement.setter);
      } else {
        addDeclarationEdit(renameElement);
      }
    }
    // update references
    addReferenceEdits(_validator.references);
    // potential matches
    return searchEngine.searchMemberReferences(oldName).then((nameMatches) {
      List<SourceReference> nameRefs = getSourceReferences(nameMatches);
      for (SourceReference reference in nameRefs) {
        // ignore resolved reference, we have already updated it
        if (reference.isResolved) {
          continue;
        }
        // check the element being renamed is accessible
        {
          LibraryElement whereLibrary = reference.element.library;
          if (!element.isAccessibleIn(whereLibrary)) {
            continue;
          }
        }
        // add edit
        reference.addEdit(change, newName, id: _newPotentialId());
      }
    });
  }

  String _newPotentialId() {
    String id = potentialEditIds.length.toString();
    potentialEditIds.add(id);
    return id;
  }
}


/**
 * Helper to check if the created or renamed [Element] will cause any conflicts.
 */
class _ClassMemberValidator {
  final SearchEngine searchEngine;
  final Element element;
  final ClassElement elementClass;
  final ElementKind elementKind;
  final String name;
  final bool isRename;

  Set<Element> elements = new Set<Element>();
  List<SearchMatch> references = <SearchMatch>[];

  _ClassMemberValidator.forCreate(this.searchEngine, this.elementClass,
      this.name)
      : isRename = false,
        element = null,
        elementKind = ElementKind.METHOD;

  _ClassMemberValidator.forRename(this.searchEngine, Element element, this.name)
      : isRename = true,
        element = element,
        elementClass = element.enclosingElement,
        elementKind = element.kind;

  Future<RefactoringStatus> validate() {
    RefactoringStatus result = new RefactoringStatus();
    // check if there is a member with "newName" in the same ClassElement
    for (Element newNameMember in getChildren(elementClass, name)) {
      result.addError(
          format(
              "Class '{0}' already declares {1} with name '{2}'.",
              elementClass.displayName,
              getElementKindName(newNameMember),
              name),
          newLocation_fromElement(newNameMember));
    }
    // do chained computations
    Set<ClassElement> superClasses = getSuperClasses(elementClass);
    Set<ClassElement> subClasses;
    return _prepareReferences().then((_) {
      return getSubClasses(searchEngine, elementClass).then((_subs) {
        subClasses = _subs;
      });
    }).then((_) {
      // check shadowing in hierarchy
      return searchEngine.searchElementDeclarations(name).then((decls) {
        for (SearchMatch decl in decls) {
          Element nameElement = getSyntheticAccessorVariable(decl.element);
          Element nameClass = nameElement.enclosingElement;
          // renamed Element shadows member of superclass
          if (superClasses.contains(nameClass)) {
            result.addError(
                format(
                    isRename ?
                        "Renamed {0} will shadow {1} '{2}'." :
                        "Created {0} will shadow {1} '{2}'.",
                    elementKind.displayName,
                    getElementKindName(nameElement),
                    getElementQualifiedName(nameElement)),
                newLocation_fromElement(nameElement));
          }
          // renamed Element is shadowed by member of subclass
          if (isRename && subClasses.contains(nameClass)) {
            result.addError(
                format(
                    "Renamed {0} will be shadowed by {1} '{2}'.",
                    elementKind.displayName,
                    getElementKindName(nameElement),
                    getElementQualifiedName(nameElement)),
                newLocation_fromElement(nameElement));
          }
          // renamed Element is shadowed by local
          if (nameElement is LocalElement) {
            LocalElement localElement = nameElement;
            ClassElement enclosingClass =
                nameElement.getAncestor((element) => element is ClassElement);
            if (enclosingClass == elementClass ||
                subClasses.contains(enclosingClass)) {
              for (SearchMatch reference in references) {
                if (isReferenceInLocalRange(localElement, reference)) {
                  result.addError(
                      format(
                          "Usage of renamed {0} will be shadowed by {1} '{2}'.",
                          elementKind.displayName,
                          getElementKindName(localElement),
                          localElement.displayName),
                      newLocation_fromMatch(reference));
                }
              }
            }
          }
        }
      });
    }).then((_) => result);
  }

  /**
   * Fills [elements] with [Element]s to rename.
   */
  Future _prepareElements() {
    if (element is ClassMemberElement) {
      return getHierarchyMembers(
          searchEngine,
          element).then((Set<Element> elements) {
        this.elements = elements;
      });
    } else {
      elements = new Set.from([element]);
      return new Future.value();
    }
  }

  /**
   * Fills [references] with all references to [elements].
   */
  Future _prepareReferences() {
    if (!isRename) {
      return new Future.value();
    }
    return _prepareElements().then((_) {
      return Future.forEach(elements, (Element element) {
        return searchEngine.searchReferences(element).then((references) {
          this.references.addAll(references);
        });
      });
    });
  }
}