plugins/hg4idea/src/org/zmlx/hg4idea/status/ui/HgStatusWidget.java

/*
 * Copyright 2000-2013 JetBrains s.r.o.
 *
 * 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 org.zmlx.hg4idea.status.ui;

import com.intellij.dvcs.DvcsUtil;
import com.intellij.openapi.fileEditor.FileEditorManager;
import com.intellij.openapi.fileEditor.FileEditorManagerEvent;
import com.intellij.openapi.project.Project;
import com.intellij.openapi.ui.popup.ListPopup;
import com.intellij.openapi.util.text.StringUtil;
import com.intellij.openapi.vfs.VirtualFile;
import com.intellij.openapi.wm.StatusBarWidget;
import com.intellij.openapi.wm.impl.status.EditorBasedWidget;
import com.intellij.util.Consumer;
import com.intellij.util.messages.MessageBusConnection;
import com.intellij.util.ui.UIUtil;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;
import org.zmlx.hg4idea.HgProjectSettings;
import org.zmlx.hg4idea.HgUpdater;
import org.zmlx.hg4idea.HgVcs;
import org.zmlx.hg4idea.branch.HgBranchPopup;
import org.zmlx.hg4idea.repo.HgRepository;
import org.zmlx.hg4idea.util.HgUtil;

import java.awt.event.MouseEvent;

/**
 * Widget to display basic hg status in the IJ status bar.
 */
public class HgStatusWidget extends EditorBasedWidget
  implements StatusBarWidget.MultipleTextValuesPresentation,
             StatusBarWidget.Multiframe, HgUpdater {

  private static final String MAX_STRING = "Hg: Merging default ";

  @NotNull private final HgVcs myVcs;
  @NotNull private final HgProjectSettings myProjectSettings;

  private volatile String myText = "";
  private volatile String myTooltip = "";

  public HgStatusWidget(@NotNull HgVcs vcs, @NotNull Project project, @NotNull HgProjectSettings projectSettings) {
    super(project);
    myVcs = vcs;
    myProjectSettings = projectSettings;
  }

  @Override
  public StatusBarWidget copy() {
    return new HgStatusWidget(myVcs, getProject(), myProjectSettings);
  }

  @NotNull
  @Override
  public String ID() {
    return HgStatusWidget.class.getName();
  }

  @Override
  public WidgetPresentation getPresentation(@NotNull PlatformType type) {
    return this;
  }

  @Override
  public void selectionChanged(@NotNull FileEditorManagerEvent event) {
    update();
  }

  @Override
  public void fileOpened(@NotNull FileEditorManager source, @NotNull VirtualFile file) {
    update();
  }

  @Override
  public void fileClosed(@NotNull FileEditorManager source, @NotNull VirtualFile file) {
    update();
  }

  @Override
  public ListPopup getPopupStep() {
    Project project = getProject();
    if (project == null) {
      return null;
    }
    VirtualFile root = HgUtil.getRootForSelectedFile(project);
    HgRepository repository = HgUtil.getRepositoryManager(project).getRepositoryForRoot(root);
    if (repository != null) {
      return HgBranchPopup.getInstance(project, repository).asListPopup();
    }
    return null;
  }

  @Override
  public String getSelectedValue() {
    final String text = myText;
    return StringUtil.isEmpty(text) ? "" : "hg: " + text;
  }

  @NotNull
  @Override
  @Deprecated
  public String getMaxValue() {
    return MAX_STRING;
  }


  @Override
  public String getTooltipText() {
    return myTooltip;
  }


  @Override
  // Updates branch information on click
  public Consumer<MouseEvent> getClickConsumer() {
    return new Consumer<MouseEvent>() {
      public void consume(MouseEvent mouseEvent) {
        update();
      }
    };
  }

  @Override
  public void update(final Project project, @Nullable VirtualFile root) {
    update();
  }

  public void update(final Project project) {
    UIUtil.invokeLaterIfNeeded(new Runnable() {
      @Override
      public void run() {
        if ((project == null) || project.isDisposed()) {
          emptyTextAndTooltip();
          return;
        }

        final HgRepository repo = HgUtil.getCurrentRepository(project);
        if (repo == null) { // the file is not under version control => display nothing
          emptyTextAndTooltip();
          return;
        }
        myTooltip = HgUtil.getDisplayableBranchOrBookmarkText(repo);
        myText = StringUtil.shortenTextWithEllipsis(myTooltip, MAX_STRING.length(), 5);
        if (!isDisposed() && myStatusBar != null) {
          myStatusBar.updateWidget(ID());
        }
      }
    });
  }


  public void activate() {
    Project project = getProject();
    if (null == project) {
      return;
    }

    MessageBusConnection busConnection = project.getMessageBus().connect();
    busConnection.subscribe(HgVcs.STATUS_TOPIC, this);
    busConnection.subscribe(HgVcs.BRANCH_TOPIC,this);

    DvcsUtil.installStatusBarWidget(myProject, this);
  }

  public void deactivate() {
    if (isDisposed()) return;
    DvcsUtil.removeStatusBarWidget(myProject, this);
  }

  private void update() {
    update(getProject());
  }

  public void dispose() {
    deactivate();
    super.dispose();
  }

  private void emptyTextAndTooltip() {
    myText = "";
    myTooltip = "";
  }
}