android/src/com/android/tools/idea/quickfix/GradleDependencyFix.java

/*
 * Copyright (C) 2015 The Android Open Source Project
 *
 * 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.
 */
package com.android.tools.idea.quickfix;

import com.android.builder.model.AndroidProject;
import com.android.tools.idea.gradle.IdeaAndroidProject;
import com.android.tools.idea.gradle.parser.BuildFileKey;
import com.android.tools.idea.gradle.parser.BuildFileStatement;
import com.android.tools.idea.gradle.parser.Dependency;
import com.android.tools.idea.gradle.parser.GradleBuildFile;
import com.android.tools.idea.gradle.project.GradleProjectImporter;
import com.android.tools.idea.gradle.project.GradleSyncListener;
import com.google.common.base.Function;
import com.google.common.collect.Lists;
import com.intellij.codeInsight.daemon.impl.actions.AddImportAction;
import com.intellij.codeInsight.intention.HighPriorityAction;
import com.intellij.codeInsight.intention.IntentionAction;
import com.intellij.codeInspection.LocalQuickFix;
import com.intellij.codeInspection.ProblemDescriptor;
import com.intellij.openapi.editor.Editor;
import com.intellij.openapi.command.undo.BasicUndoableAction;
import com.intellij.openapi.command.undo.UndoManager;
import com.intellij.openapi.command.undo.UnexpectedUndoException;
import com.intellij.openapi.module.Module;
import com.intellij.openapi.project.DumbService;
import com.intellij.openapi.project.Project;
import com.intellij.psi.PsiClass;
import com.intellij.psi.PsiReference;
import org.jetbrains.android.facet.AndroidFacet;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

import java.util.List;

abstract class GradleDependencyFix implements IntentionAction, LocalQuickFix, HighPriorityAction {
  @Override
  public boolean startInWriteAction() {
    return true;
  }

  @Override
  @NotNull
  public String getName() {
    return getText();
  }

  @Override
  public void applyFix(@NotNull Project project, @NotNull ProblemDescriptor descriptor) {
    invoke(project, null, descriptor.getPsiElement().getContainingFile());
  }

  protected static void addDependency(@NotNull Module module, @NotNull Dependency dependency) {
    GradleBuildFile gradleBuildFile = GradleBuildFile.get(module);

    if (gradleBuildFile == null) {
      return;
    }

    List<BuildFileStatement> dependencies = Lists.newArrayList(gradleBuildFile.getDependencies());
    dependencies.add(dependency);

    gradleBuildFile.setValue(BuildFileKey.DEPENDENCIES, dependencies);
  }

  @NotNull
  protected static Dependency.Scope getDependencyScope(@NotNull Module module, boolean test) {
    Dependency.Scope testScope = Dependency.Scope.TEST_COMPILE;
    if (test) {
      AndroidFacet androidFacet = AndroidFacet.getInstance(module);
      if (androidFacet != null) {
        IdeaAndroidProject androidModel = androidFacet.getAndroidModel();
        if (androidModel != null && AndroidProject.ARTIFACT_ANDROID_TEST.equals(androidModel.getSelectedTestArtifactName())) {
          testScope = Dependency.Scope.ANDROID_TEST_COMPILE;
        }
      }
    }
    return test ? testScope : Dependency.Scope.COMPILE;
  }

  /**
   * After modifying the dependencies of the gradle file, trigger gradle sync and then try to add import statement to the source file.
   *
   * @param module the module in which the quick fix is invoked.
   * @param editor the editor in which the quick fix is invoked.
   * @param reference the PSI element that can't be resolved initially.
   * @param getTargetClasses the callback to find resolved classes for the reference after sync is done.
   */
  protected static void gradleSyncAndImportClass(@NotNull final Module module,
                                                 @Nullable final Editor editor,
                                                 @Nullable final PsiReference reference,
                                                 @Nullable final Function<Void, List<PsiClass>> getTargetClasses) {
    final Project project = module.getProject();
    GradleProjectImporter.getInstance().requestProjectSync(project, false /* Do not generate source */, new GradleSyncListener.Adapter() {
      @Override
      public void syncSucceeded(@NotNull final Project project) {
        if (editor != null && reference != null) {
          DumbService.getInstance(project).withAlternativeResolveEnabled(new Runnable() {
            @Override
            public void run() {
              List<PsiClass> targetClasses = null;
              if (getTargetClasses != null) {
                targetClasses = getTargetClasses.apply(null);
              }
              if (targetClasses != null) {
                new AddImportAction(project, reference, editor, targetClasses.toArray(new PsiClass[targetClasses.size()])).execute();
              }
            }
          });
        }
      }
    });
  }

  protected static void registerUndoAction(@NotNull final Project project) {
    UndoManager.getInstance(project).undoableActionPerformed(new BasicUndoableAction() {
      @Override
      public void undo() throws UnexpectedUndoException {
        GradleProjectImporter.getInstance().requestProjectSync(project, false, null);
      }

      @Override
      public void redo() throws UnexpectedUndoException {
        GradleProjectImporter.getInstance().requestProjectSync(project, false, null);
      }
    });
  }
}