Add git changes markers to the editor (eclipse-che#6054)

Author: vinokurig

ide/che-core-ide-api/src/main/java/org/eclipse/che/ide/api/editor/gutter/Gutter.java

@@ -23,6 +23,20 @@ public interface Gutter {
    */
   void addGutterItem(int line, String gutterId, Element element);
 
+  /**
+   * Adds a gutter item.
+   *
+   * @param lineStart the first line of the item
+   * @param lineEnd the last line of the item
+   * @param gutterId the gutter identifier
+   * @param element the (DOM) element to add
+   */
+  default void addGutterItem(int lineStart, int lineEnd, String gutterId, Element element) {
+    for (int i = lineStart; i <= lineEnd; i++) {
+      addGutterItem(i, gutterId, element);
+    }
+  }
+
   /**
    * Adds a gutter item.
    *

ide/che-core-ide-api/src/main/java/org/eclipse/che/ide/api/editor/gutter/Gutters.java

@@ -17,6 +17,9 @@ private Gutters() {}
   /** Logical identifer for the breakpoints gutter. */
   public static final String BREAKPOINTS_GUTTER = "breakpoints";
 
+  /** Logical identifer for the vcs change markers gutter. */
+  public static final String VCS_CHANGE_MARKERS_GUTTER = "vcsChangeMarkersGutter";
+
   /** Logical identifer for the line number gutter. */
   public static final String LINE_NUMBERS_GUTTER = "lineNumbers";
 

ide/che-core-ide-api/src/main/java/org/eclipse/che/ide/api/git/GitServiceClient.java

@@ -16,6 +16,7 @@
 import org.eclipse.che.api.git.shared.BranchListMode;
 import org.eclipse.che.api.git.shared.CheckoutRequest;
 import org.eclipse.che.api.git.shared.DiffType;
+import org.eclipse.che.api.git.shared.EditedRegion;
 import org.eclipse.che.api.git.shared.LogResponse;
 import org.eclipse.che.api.git.shared.MergeResult;
 import org.eclipse.che.api.git.shared.PullResponse;
@@ -286,6 +287,14 @@ Promise<String> diff(
       String commitA,
       boolean cached);
 
+  /**
+   * Get list of edited regions (insertions, modifications, removals) of the file.
+   *
+   * @param project project (root of GIT repository)
+   * @param filePath path to the file
+   */
+  Promise<List<EditedRegion>> getEditedRegions(Path project, Path filePath);
+
   /**
    * Get the file content from specified revision or branch.
    *

ide/che-core-ide-api/src/main/java/org/eclipse/che/ide/api/git/GitServiceClientImpl.java

@@ -32,6 +32,7 @@
 import org.eclipse.che.api.git.shared.CloneRequest;
 import org.eclipse.che.api.git.shared.CommitRequest;
 import org.eclipse.che.api.git.shared.DiffType;
+import org.eclipse.che.api.git.shared.EditedRegion;
 import org.eclipse.che.api.git.shared.FetchRequest;
 import org.eclipse.che.api.git.shared.LogResponse;
 import org.eclipse.che.api.git.shared.MergeRequest;
@@ -76,6 +77,7 @@ public class GitServiceClientImpl implements GitServiceClient {
   private static final String COMMIT = "/git/commit";
   private static final String CONFIG = "/git/config";
   private static final String DIFF = "/git/diff";
+  private static final String EDITS = "/git/edits";
   private static final String FETCH = "/git/fetch";
   private static final String INIT = "/git/init";
   private static final String LOG = "/git/log";
@@ -440,6 +442,20 @@ public Promise<String> diff(
         .send(new StringUnmarshaller());
   }
 
+  @Override
+  public Promise<List<EditedRegion>> getEditedRegions(Path project, Path filePath) {
+    String url =
+        getWsAgentBaseUrl()
+            + EDITS
+            + "?projectPath="
+            + encodePath(project)
+            + "&filePath="
+            + encodePath(filePath);
+    return asyncRequestFactory
+        .createGetRequest(url)
+        .send(dtoUnmarshallerFactory.newListUnmarshaller(EditedRegion.class));
+  }
+
   private AsyncRequest diff(
       Path project,
       List<String> fileFilter,

ide/che-core-ide-api/src/main/java/org/eclipse/che/ide/api/theme/Theme.java

@@ -1550,6 +1550,12 @@ public interface Theme {
 
   String vcsStatusUntrackedColor();
 
+  String vcsChangeMarkerInsertionColor();
+
+  String vcsChangeMarkerModificationColor();
+
+  String vcsChangeMarkerDeletionColor();
+
   String editorPreferenceCategoryBackgroundColor();
 
   /**

ide/che-core-ide-api/src/main/java/org/eclipse/che/ide/api/vcs/HasVcsChangeMarkerRender.java

@@ -0,0 +1,18 @@
+/*
+ * Copyright (c) 2012-2017 Red Hat, Inc.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ *   Red Hat, Inc. - initial API and implementation
+ */
+package org.eclipse.che.ide.api.vcs;
+
+/** Indicates that the editor can handle VCS change markers. */
+public interface HasVcsChangeMarkerRender {
+
+  /** Returns an instance of {@link VcsChangeMarkerRender}. */
+  VcsChangeMarkerRender getVcsChangeMarkersRender();
+}

ide/che-core-ide-api/src/main/java/org/eclipse/che/ide/api/vcs/VcsChangeMarkerRender.java

@@ -0,0 +1,29 @@
+/*
+ * Copyright (c) 2012-2017 Red Hat, Inc.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ *   Red Hat, Inc. - initial API and implementation
+ */
+package org.eclipse.che.ide.api.vcs;
+
+import org.eclipse.che.api.git.shared.EditedRegionType;
+
+/** Component that handles VCS change markers. */
+public interface VcsChangeMarkerRender {
+
+  /**
+   * Add change marker to the gutter on the given lines.
+   *
+   * @param lineStart the first line number of the marker
+   * @param lineEnd the last line number of the marker
+   * @param type type of the marker e.g. insertion, modification, deletion
+   */
+  void addChangeMarker(int lineStart, int lineEnd, EditedRegionType type);
+
+  /** Clear all VCS change markers in the gutter. */
+  void clearAllChangeMarkers();
+}

ide/che-core-ide-api/src/main/java/org/eclipse/che/ide/api/vcs/VcsChangeMarkerRenderFactory.java

@@ -0,0 +1,27 @@
+/*
+ * Copyright (c) 2012-2017 Red Hat, Inc.
+ * All rights reserved. This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v1.0
+ * which accompanies this distribution, and is available at
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ *   Red Hat, Inc. - initial API and implementation
+ */
+package org.eclipse.che.ide.api.vcs;
+
+import org.eclipse.che.ide.api.editor.gutter.Gutter;
+
+/**
+ * Factory for {@link VcsChangeMarkerRender} instances.
+ *
+ * @author Igor Vinokur
+ */
+public interface VcsChangeMarkerRenderFactory {
+  /**
+   * Creates an instance of {@link VcsChangeMarkerRender}.
+   *
+   * @param hasGutter the gutter manager
+   */
+  VcsChangeMarkerRender create(Gutter hasGutter);
+}

ide/che-core-ide-app/src/main/java/org/eclipse/che/ide/editor/EditorAgentImpl.java

@@ -345,6 +345,8 @@ public void onEditorOpened(EditorPartPresenter editor) {
             removeFromOpeningFilesList(file.getLocation(), editorPartStack);
 
             openEditorCallback.onEditorOpened(editor);
+
+            eventBus.fireEvent(new EditorOpenedEvent(file, editor));
           }
 
           @Override
@@ -381,7 +383,6 @@ private void finalizeInit(
             }
 
             eventBus.fireEvent(FileEvent.createFileOpenedEvent(file));
-            eventBus.fireEvent(new EditorOpenedEvent(file, editor));
           }
         });
   }
@@ -742,6 +743,8 @@ public void onEditorOpened(EditorPartPresenter editor) {
 
                   promiseCallback.onSuccess(null);
                   openEditorCallback.onEditorOpened(editor);
+
+                  eventBus.fireEvent(new EditorOpenedEvent(file, editor));
                 }
 
                 @Override

ide/che-core-ide-app/src/main/java/org/eclipse/che/ide/theme/DarkTheme.java

@@ -1632,6 +1632,21 @@ public String vcsStatusUntrackedColor() {
     return "#e0b91d";
   }
 
+  @Override
+  public String vcsChangeMarkerInsertionColor() {
+    return "rgba(114, 173, 66, 0.65)";
+  }
+
+  @Override
+  public String vcsChangeMarkerModificationColor() {
+    return "rgba(224, 185, 29, 0.65)";
+  }
+
+  @Override
+  public String vcsChangeMarkerDeletionColor() {
+    return "#bfc6ce";
+  }
+
   @Override
   public String editorPreferenceCategoryBackgroundColor() {
     return "rgba(215, 215, 215, 0.10)";