CHE-3570. Add ability to turn on/off autosave mode for editor content

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

@@ -13,8 +13,8 @@
 import com.google.gwt.user.client.rpc.AsyncCallback;
 import com.google.gwt.user.client.ui.IsWidget;
 
-import org.eclipse.che.ide.api.parts.AbstractPartPresenter;
 import org.eclipse.che.ide.api.editor.EditorAgent.OpenEditorCallback;
+import org.eclipse.che.ide.api.parts.AbstractPartPresenter;
 
 import javax.validation.constraints.NotNull;
 import java.util.ArrayList;

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

@@ -112,7 +112,7 @@ public interface EditorAgent {
      *
      * @param callback
      */
-    void saveAll(AsyncCallback callback);
+    void saveAll(AsyncCallback<Void> callback);
 
     /**
      * Current active editor

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

@@ -64,6 +64,9 @@ public interface EditorLocalizationConstants extends Messages {
     @DefaultMessage("Soft Wrap")
     String propertySoftWrap();
 
+    @DefaultMessage("Enable Autosave")
+    String propertyAutoSave();
+
     @DefaultMessage("Autopair (Parentheses)")
     String propertyAutoPairParentheses();
 

ide/che-core-ide-api/src/main/java/org/eclipse/che/ide/api/editor/autosave/AutoSaveMode.java

@@ -0,0 +1,65 @@
+/*******************************************************************************
+ * Copyright (c) 2012-2017 Codenvy, S.A.
+ * 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:
+ *   Codenvy, S.A. - initial API and implementation
+ *******************************************************************************/
+package org.eclipse.che.ide.api.editor.autosave;
+
+import org.eclipse.che.ide.api.editor.document.UseDocumentHandle;
+import org.eclipse.che.ide.api.editor.events.DocumentChangeHandler;
+import org.eclipse.che.ide.api.editor.texteditor.TextEditor;
+
+/**
+ * Editor content auto save functionality.
+ *
+ * @author Roman Nikitenko
+ */
+public interface AutoSaveMode extends DocumentChangeHandler, UseDocumentHandle {
+
+    /**
+     * Installs auto save mode on the given editor.
+     */
+    void install(TextEditor editor);
+
+    /**
+     * Removes auto save mode from editor.
+     */
+    void uninstall();
+
+    /**
+     * Suspends auto save mode for editor content.
+     */
+    void suspend();
+
+    /**
+     * Resumes auto save mode for editor content and sets mode corresponding to 'Enable Autosave' option in editor preferences.
+     */
+    void resume();
+
+    /**
+     * Return true if auto save mode is activated, false otherwise.
+     */
+    boolean isActivated();
+
+    enum Mode {
+        /**
+         * The state when auto save mode of editor content is turned on.
+         * Corresponds to the case when the 'Enable Autosave' option in editor preferences is enabled.
+         */
+        ACTIVATED,
+
+        /** Corresponds to the state when auto save mode is suspended for processing some operations (java refactoring, for example) */
+        SUSPENDED,
+
+        /**
+         * The state when auto save mode of editor content is turned off.
+         * Corresponds to the case when the 'Enable Autosave' option in editor preferences is disabled.
+         */
+        DEACTIVATED
+    }
+}

ide/che-core-ide-api/src/main/java/org/eclipse/che/ide/api/editor/defaulteditor/AbstractTextEditorProvider.java

@@ -13,7 +13,7 @@
 import com.google.inject.Inject;
 
 import org.eclipse.che.ide.api.editor.EditorProvider;
-import org.eclipse.che.ide.api.editor.editorconfig.AutoSaveTextEditorConfiguration;
+import org.eclipse.che.ide.api.editor.editorconfig.DefaultTextEditorConfiguration;
 import org.eclipse.che.ide.api.editor.editorconfig.TextEditorConfiguration;
 import org.eclipse.che.ide.api.editor.texteditor.TextEditor;
 import org.eclipse.che.ide.util.loging.Log;
@@ -25,7 +25,7 @@
  * implementation for the {@link #getId()} and {@link #getDescription()} methods.
  * <p>The method {@link #getEditor()} returns {@link TextEditor}
  * that is initialized by configuration returned by {@link #getEditorConfiguration()} method.
- * <p>The method {@link #getEditorConfiguration()} returns {@link AutoSaveTextEditorConfiguration}
+ * <p>The method {@link #getEditorConfiguration()} returns {@link DefaultTextEditorConfiguration}
  * instance and may be overridden in order to provide another configuration for the editor
  * which is returned by {@link #getEditor()} method.
  *
@@ -38,7 +38,7 @@ public abstract class AbstractTextEditorProvider implements EditorProvider {
 
     /** Returns configuration for initializing an editor returned by {@link #getEditor()} method. */
     protected TextEditorConfiguration getEditorConfiguration() {
-        return new AutoSaveTextEditorConfiguration();
+        return new DefaultTextEditorConfiguration();
     }
 
     @Override

ide/che-core-ide-api/src/main/java/org/eclipse/che/ide/api/editor/editorconfig/AutoSaveTextEditorConfiguration.java

@@ -17,7 +17,7 @@
 /**
  * @author Evgen Vidolob
  */
-public class AutoSaveTextEditorConfiguration extends DefaultTextEditorConfiguration{
+public class AutoSaveTextEditorConfiguration extends DefaultTextEditorConfiguration {
 
     private ReconcilerWithAutoSave reconcilerWithAutoSave =
             new ReconcilerWithAutoSave(DocumentPartitioner.DEFAULT_CONTENT_TYPE, getPartitioner());

ide/che-core-ide-api/src/main/java/org/eclipse/che/ide/api/editor/editorconfig/DefaultTextEditorConfiguration.java

@@ -18,16 +18,20 @@
 import org.eclipse.che.ide.api.editor.partition.DocumentPartitioner;
 import org.eclipse.che.ide.api.editor.partition.DocumentPositionMap;
 import org.eclipse.che.ide.api.editor.quickfix.QuickAssistProcessor;
+import org.eclipse.che.ide.api.editor.reconciler.DefaultReconciler;
 import org.eclipse.che.ide.api.editor.reconciler.Reconciler;
 import org.eclipse.che.ide.api.editor.signature.SignatureHelpProvider;
 
 import java.util.Map;
 
+import static org.eclipse.che.ide.api.editor.partition.DocumentPartitioner.DEFAULT_CONTENT_TYPE;
+
 /**
  * Default implementation of the {@link TextEditorConfiguration}.
  */
 public class DefaultTextEditorConfiguration implements TextEditorConfiguration {
 
+    private DefaultReconciler reconciler;
     private ConstantPartitioner partitioner;
 
     @Override
@@ -47,15 +51,13 @@ public Map<String, CodeAssistProcessor> getContentAssistantProcessors() {
 
     @Override
     public Reconciler getReconciler() {
-        return null;
+        return reconciler == null ? reconciler = new DefaultReconciler(DEFAULT_CONTENT_TYPE, getPartitioner()) : reconciler;
+
     }
 
     @Override
     public DocumentPartitioner getPartitioner() {
-        if(partitioner == null) {
-            partitioner = new ConstantPartitioner();
-        }
-        return partitioner;
+        return partitioner == null ? partitioner = new ConstantPartitioner() : partitioner;
     }
 
     @Override

ide/che-core-ide-api/src/main/java/org/eclipse/che/ide/api/editor/reconciler/DefaultReconciler.java

@@ -0,0 +1,103 @@
+/*******************************************************************************
+ * Copyright (c) 2012-2017 Codenvy, S.A.
+ * 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:
+ *   Codenvy, S.A. - initial API and implementation
+ *******************************************************************************/
+package org.eclipse.che.ide.api.editor.reconciler;
+
+import com.google.inject.assistedinject.Assisted;
+import com.google.inject.assistedinject.AssistedInject;
+
+import org.eclipse.che.ide.api.editor.document.Document;
+import org.eclipse.che.ide.api.editor.document.DocumentHandle;
+import org.eclipse.che.ide.api.editor.events.DocumentChangeEvent;
+import org.eclipse.che.ide.api.editor.partition.DocumentPartitioner;
+import org.eclipse.che.ide.api.editor.texteditor.TextEditor;
+
+import java.util.HashMap;
+import java.util.Map;
+
+/**
+ * Default implementation of {@link Reconciler}.
+ *
+ * @author Roman Nikitenko
+ */
+public class DefaultReconciler implements Reconciler {
+
+    private final String                           partition;
+    private final DocumentPartitioner              partitioner;
+    private final Map<String, ReconcilingStrategy> strategies;
+
+    private DocumentHandle documentHandle;
+    private TextEditor     editor;
+
+
+    @AssistedInject
+    public DefaultReconciler(@Assisted final String partition,
+                             @Assisted final DocumentPartitioner partitioner) {
+        this.partition = partition;
+        this.partitioner = partitioner;
+        strategies = new HashMap<>();
+    }
+
+    @Override
+    public void install(TextEditor editor) {
+        this.editor = editor;
+        reconcilerDocumentChanged();
+    }
+
+    @Override
+    public void uninstall() {
+        strategies.values().forEach(ReconcilingStrategy::closeReconciler);
+    }
+
+    @Override
+    public ReconcilingStrategy getReconcilingStrategy(final String contentType) {
+        return strategies.get(contentType);
+    }
+
+    @Override
+    public void addReconcilingStrategy(final String contentType, final ReconcilingStrategy strategy) {
+        strategies.put(contentType, strategy);
+    }
+
+    @Override
+    public String getDocumentPartitioning() {
+        return partition;
+    }
+
+    @Override
+    public void onDocumentChange(final DocumentChangeEvent event) {
+    }
+
+    @Override
+    public DocumentHandle getDocumentHandle() {
+        return this.documentHandle;
+    }
+
+    @Override
+    public void setDocumentHandle(final DocumentHandle handle) {
+        this.documentHandle = handle;
+    }
+
+    /**
+     * Returns the input document of the text view this reconciler is installed on.
+     *
+     * @return the reconciler document
+     */
+    protected Document getDocument() {
+        return documentHandle.getDocument();
+    }
+
+    private void reconcilerDocumentChanged() {
+        strategies.keySet().forEach(key -> {
+            ReconcilingStrategy reconcilingStrategy = strategies.get(key);
+            reconcilingStrategy.setDocument(documentHandle.getDocument());
+        });
+    }
+}

ide/che-core-ide-api/src/main/java/org/eclipse/che/ide/api/editor/reconciler/DirtyRegionQueue.java

@@ -14,10 +14,10 @@
 import java.util.List;
 
 /**
- * Queue used by {@link ReconcilerWithAutoSave} to manage dirty regions. When a dirty region is inserted into the queue, the queue tries to fold it
+ * Queue used to manage dirty regions. When a dirty region is inserted into the queue, the queue tries to fold it
  * into the neighboring dirty region.
  */
-class DirtyRegionQueue {
+public class DirtyRegionQueue {
 
     /** The list of dirty regions. */
     private final List<DirtyRegion> fDirtyRegions = new ArrayList<>();

ide/che-core-ide-api/src/main/java/org/eclipse/che/ide/api/editor/reconciler/ReconcilingStrategy.java

@@ -17,8 +17,7 @@
  * A reconciling strategy is used by an reconciler to reconcile a model
  * based on text of a particular content type.
  *
- * @author <a href="mailto:evidolob@exoplatform.com">Evgen Vidolob</a>
- * @version $Id:
+ * @author Evgen Vidolob
  */
 public interface ReconcilingStrategy {
     /**
@@ -38,7 +37,7 @@ public interface ReconcilingStrategy {
      * As a dirty region might span multiple content types, the segment of the
      * dirty region which should be investigated is also provided to this
      * reconciling strategy. The given regions refer to the document passed into
-     * the most recent call of {@link #setDocument(org.eclipse.che.ide.api.editor.document.Document)}.
+     * the most recent call of {@link #setDocument(Document)}.
      *
      * @param dirtyRegion
      *         the document region which has been changed
@@ -50,7 +49,7 @@ public interface ReconcilingStrategy {
     /**
      * Activates non-incremental reconciling. The reconciling strategy is just told
      * that there are changes and that it should reconcile the given partition of the
-     * document most recently passed into {@link #setDocument(org.eclipse.che.ide.api.editor.document.Document)}.
+     * document most recently passed into {@link #setDocument(Document)}.
      *
      * @param partition
      *         the document partition to be reconciled

ide/che-core-ide-api/src/main/java/org/eclipse/che/ide/api/parts/EditorTab.java

@@ -10,8 +10,6 @@
  *******************************************************************************/
 package org.eclipse.che.ide.api.parts;
 
-import com.google.gwt.event.dom.client.DoubleClickHandler;
-
 import org.eclipse.che.ide.api.editor.EditorPartPresenter;
 import org.eclipse.che.ide.api.mvp.View;
 import org.eclipse.che.ide.api.parts.PartStackView.TabItem;
@@ -54,6 +52,14 @@ public interface EditorTab extends View<EditorTab.ActionDelegate>, TabItem {
      */
     EditorPartPresenter getRelativeEditorPart();
 
+    /**
+     * Set unsaved data mark to editor tab item.
+     *
+     * @param hasUnsavedData
+     *         true if tab should display 'unsaved data' mark, otherwise false
+     */
+    void setUnsavedDataMark(boolean hasUnsavedData);
+
     /**
      * Set pin mark to editor tab item.
      *

ide/che-core-ide-api/src/main/java/org/eclipse/che/ide/api/resources/Resource.java

@@ -14,6 +14,7 @@
 import com.google.common.base.Optional;
 
 import org.eclipse.che.api.promises.client.Promise;
+import org.eclipse.che.commons.annotation.Nullable;
 import org.eclipse.che.ide.api.app.AppContext;
 import org.eclipse.che.ide.api.resources.Project.ProjectRequest;
 import org.eclipse.che.ide.api.resources.marker.Marker;
@@ -478,6 +479,7 @@ public interface Resource extends Comparable<Resource> {
      * @return the bound instance of {@link Project} or null
      * @since 5.1.0
      */
+    @Nullable
     Project getProject();
 
     /**

ide/che-core-ide-api/src/main/java/org/eclipse/che/ide/api/resources/VirtualFile.java

@@ -10,8 +10,6 @@
  *******************************************************************************/
 package org.eclipse.che.ide.api.resources;
 
-import com.google.common.annotations.Beta;
-
 import org.eclipse.che.api.promises.client.Promise;
 import org.eclipse.che.ide.resource.Path;