base/src/com/google/idea/blaze/base/lang/buildfile/references/ExternalWorkspaceReferenceFragment.java

/*
 * Copyright 2016 The Bazel Authors. All rights reserved.
 *
 * 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.google.idea.blaze.base.lang.buildfile.references;

import com.google.idea.blaze.base.lang.buildfile.psi.BuildFile;
import com.google.idea.blaze.base.lang.buildfile.psi.FuncallExpression;
import com.google.idea.blaze.base.lang.buildfile.psi.StringLiteral;
import com.google.idea.blaze.base.lang.buildfile.psi.util.PsiUtils;
import com.google.idea.blaze.base.model.primitives.WorkspacePath;
import com.google.idea.blaze.base.model.primitives.WorkspaceRoot;
import com.intellij.lang.ASTNode;
import com.intellij.openapi.project.Project;
import com.intellij.openapi.util.TextRange;
import com.intellij.psi.PsiElement;
import com.intellij.psi.PsiFileSystemItem;
import com.intellij.psi.PsiReferenceBase;
import com.intellij.util.IncorrectOperationException;
import com.intellij.util.ObjectUtils;
import javax.annotation.Nullable;

/** The external workspace component of a label (between '@' and '//') */
public class ExternalWorkspaceReferenceFragment extends PsiReferenceBase<StringLiteral> {

  public ExternalWorkspaceReferenceFragment(LabelReference labelReference) {
    super(labelReference.getElement(), labelReference.getRangeInElement(), labelReference.isSoft());
  }

  @Override
  public TextRange getRangeInElement() {
    String rawText = myElement.getText();
    boolean valid = LabelUtils.getExternalWorkspaceComponent(myElement.getStringContents()) != null;
    if (!valid) {
      return TextRange.EMPTY_RANGE;
    }
    int endIndex = rawText.indexOf("//");
    if (endIndex == -1) {
      endIndex = rawText.length() - 1;
    }
    return new TextRange(1, endIndex);
  }

  @Nullable
  @Override
  public FuncallExpression resolve() {
    String name = LabelUtils.getExternalWorkspaceComponent(myElement.getStringContents());
    if (name == null) {
      return null;
    }
    BuildFile workspaceFile = resolveProjectWorkspaceFile(myElement.getProject());
    return workspaceFile != null ? workspaceFile.findRule(name) : null;
  }

  @Nullable
  private static BuildFile resolveProjectWorkspaceFile(Project project) {
    WorkspaceRoot projectRoot = WorkspaceRoot.fromProject(project);
    if (projectRoot == null) {
      return null;
    }
    PsiFileSystemItem workspaceFile =
        BuildReferenceManager.getInstance(project)
            .resolveFile(projectRoot.fileForPath(new WorkspacePath("WORKSPACE")));
    return ObjectUtils.tryCast(workspaceFile, BuildFile.class);
  }

  @Override
  public Object[] getVariants() {
    return EMPTY_ARRAY;
  }

  @Override
  public PsiElement handleElementRename(String newElementName) throws IncorrectOperationException {
    String oldString = myElement.getStringContents();
    int slashesIndex = oldString.indexOf("//");
    String newString =
        String.format(
            "@%s%s", newElementName, slashesIndex == -1 ? "" : oldString.substring(slashesIndex));
    return handleRename(newString);
  }

  @Override
  public PsiElement bindToElement(PsiElement element) throws IncorrectOperationException {
    return myElement;
  }

  private PsiElement handleRename(String newStringContents) {
    ASTNode node = myElement.getNode();
    node.replaceChild(
        node.getFirstChildNode(),
        PsiUtils.createNewLabel(myElement.getProject(), newStringContents));
    return myElement;
  }
}