Tested and Enabled incremental document syncing.

Fixes eclipse-lemminx#133 Incremental sync is off by default preference to turn on is: "xml.experimental.incrementalSupport.enabled": true|false Signed-off-by: Nikolas <[email protected]>
NikolasKomonen · Jun 11, 2019 · 0abccf3 · 0abccf3
1 parent 867aae2
commit 0abccf3
Show file tree

Hide file tree

Showing 11 changed files with 353 additions and 71 deletions.
diff --git a/org.eclipse.lsp4xml/src/main/java/org/eclipse/lsp4xml/XMLLanguageServer.java b/org.eclipse.lsp4xml/src/main/java/org/eclipse/lsp4xml/XMLLanguageServer.java
@@ -46,9 +46,10 @@
 import org.eclipse.lsp4xml.settings.LogsSettings;
 import org.eclipse.lsp4xml.settings.ServerSettings;
 import org.eclipse.lsp4xml.settings.SharedSettings;
-import org.eclipse.lsp4xml.settings.XMLExperimentalCapabilities;
+import org.eclipse.lsp4xml.settings.XMLExperimentalSettings;
 import org.eclipse.lsp4xml.settings.XMLFormattingOptions;
 import org.eclipse.lsp4xml.settings.XMLGeneralClientSettings;
+import org.eclipse.lsp4xml.settings.XMLIncrementalSupportSettings;
 import org.eclipse.lsp4xml.settings.XMLSymbolSettings;
 import org.eclipse.lsp4xml.settings.capabilities.ServerCapabilitiesInitializer;
 import org.eclipse.lsp4xml.settings.capabilities.XMLCapabilityManager;
@@ -116,7 +117,7 @@ public void initialized(InitializedParams params) {
 	 * 
 	 * @param initializationOptionsSettings the XML settings
 	 */
-	public void updateSettings(Object initializationOptionsSettings) {
+	public synchronized void updateSettings(Object initializationOptionsSettings) {
 		if (initializationOptionsSettings == null) {
 			return;
 		}
@@ -150,14 +151,13 @@ public void updateSettings(Object initializationOptionsSettings) {
 				String workDir = serverSettings.getNormalizedWorkDir();
 				FilesUtils.setCachePathSetting(workDir);
 			}
-
-			// Experimental capabilities
-			XMLExperimentalCapabilities experimental = xmlClientSettings.getExperimental();
-			if (experimental != null) {
-				boolean incrementalSupport = experimental.getIncrementalSupport() != null
-						&& experimental.getIncrementalSupport().getEnabled() != null
-						&& experimental.getIncrementalSupport().getEnabled().booleanValue();
-				xmlTextDocumentService.setIncrementalSupport(incrementalSupport);
+
+			XMLExperimentalSettings experimentalSettings = xmlClientSettings.getExperimental();
+			if(experimentalSettings != null) {
+				XMLIncrementalSupportSettings incrementalSettings = experimentalSettings.getIncrementalSupport();
+				if(incrementalSettings != null) {
+					xmlTextDocumentService.updateIncrementalSettings(incrementalSettings);
+				}
 			}
 		}
 		ContentModelSettings cmSettings = ContentModelSettings.getContentModelXMLSettings(initializationOptionsSettings);

diff --git a/org.eclipse.lsp4xml/src/main/java/org/eclipse/lsp4xml/XMLTextDocumentService.java b/org.eclipse.lsp4xml/src/main/java/org/eclipse/lsp4xml/XMLTextDocumentService.java
@@ -74,6 +74,7 @@
 import org.eclipse.lsp4xml.services.extensions.save.AbstractSaveContext;
 import org.eclipse.lsp4xml.settings.SharedSettings;
 import org.eclipse.lsp4xml.settings.XMLFormattingOptions;
+import org.eclipse.lsp4xml.settings.XMLIncrementalSupportSettings;
 import org.eclipse.lsp4xml.settings.XMLSymbolSettings;
 
 /**
@@ -435,7 +436,7 @@ private XMLLanguageService getXMLLanguageService() {
 	}
 
 	public void updateCompletionSettings(CompletionSettings newCompletion) {
-		sharedSettings.completionSettings.setAutoCloseTags(newCompletion.isAutoCloseTags());
+		sharedSettings.setCompletionSettings(newCompletion);
 	}
 
 	public void updateSymbolSettings(XMLSymbolSettings newSettings) {
@@ -454,10 +455,6 @@ public XMLFormattingOptions getSharedFormattingSettings() {
 		return sharedSettings.formattingSettings;
 	}
 
-	public void setIncrementalSupport(boolean incrementalSupport) {
-		this.documents.setIncremental(incrementalSupport);
-	}
-
 	public XMLValidationSettings getValidationSettings() {
 
 		return sharedSettings.validationSettings;
@@ -467,4 +464,9 @@ public SharedSettings getSharedSettings() {
 		return this.sharedSettings;
 	}
 
+	public void updateIncrementalSettings(XMLIncrementalSupportSettings settings) {
+		sharedSettings.experimentalSettings.getIncrementalSupport().setEnabled(settings.getEnabled());
+		this.documents.setIncremental(sharedSettings.experimentalSettings.getIncrementalSupport().getEnabled());
+	}
+
 }
diff --git a/org.eclipse.lsp4xml/src/main/java/org/eclipse/lsp4xml/commons/TextDocument.java b/org.eclipse.lsp4xml/src/main/java/org/eclipse/lsp4xml/commons/TextDocument.java
@@ -26,12 +26,13 @@
  */
 public class TextDocument extends TextDocumentItem {
 
+	private final Object lock = new Object();
+
 	private static String DEFAULT_DELIMTER = System.lineSeparator();
 
-	private ListLineTracker lineTracker;
+	private final ListLineTracker lineTracker;
 
-	// Buffer of the text document used only in incremental mode.
-	private StringBuilder buffer;
+	private boolean incremental;
 
 	public TextDocument(TextDocumentItem document) {
 		this(document.getText(), document.getUri());
@@ -40,22 +41,23 @@ public TextDocument(TextDocumentItem document) {
 	}
 
 	public TextDocument(String text, String uri) {
+		this.lineTracker = new ListLineTracker();
 		super.setUri(uri);
-		super.setText(text);
+		this.setText(text);
 	}
 
 	public void setIncremental(boolean incremental) {
-		if (incremental) {
-			buffer = new StringBuilder(getText());
-		} else {
-			buffer = null;
-		}
+		this.incremental = incremental;
+	}
+
+	public boolean isIncremental() {
+		return incremental;
 	}
 
 	@Override
 	public void setText(String text) {
 		super.setText(text);
-		lineTracker = null;
+		lineTracker.set(text);
 	}
 
 	public Position positionAt(int position) throws BadLocationException {
@@ -117,10 +119,6 @@ public Range getWordRangeAt(int textOffset, Pattern wordDefinition) {
 	}
 
 	private ListLineTracker getLineTracker() {
-		if (lineTracker == null) {
-			lineTracker = new ListLineTracker();
-			lineTracker.set(super.getText());
-		}
 		return lineTracker;
 	}
 
@@ -137,8 +135,17 @@ public void update(List<TextDocumentContentChangeEvent> changes) {
 		}
 		if (isIncremental()) {
 			try {
-				synchronized (buffer) {
-					for (TextDocumentContentChangeEvent changeEvent : changes) {
+				// Initialize buffer and line tracker from the current text document
+				String initialText = getText();
+				StringBuilder buffer = new StringBuilder(getText());
+				ListLineTracker lt = new ListLineTracker();
+				lt.set(initialText);
+				synchronized (lock) {
+					for (int i = 0; i < changes.size(); i++) {
+						if (i > 0) {
+							lt.set(buffer.toString());
+						}
+						TextDocumentContentChangeEvent changeEvent = changes.get(i);
 
 						Range range = changeEvent.getRange();
 						int length = 0;
@@ -147,17 +154,18 @@ public void update(List<TextDocumentContentChangeEvent> changes) {
 							length = changeEvent.getRangeLength().intValue();
 						} else {
 							// range is optional and if not given, the whole file content is replaced
-							length = getText().length();
-							range = new Range(positionAt(0), positionAt(length));
+							length = buffer.length();
+							range = new Range(lt.getPositionAt(0), lt.getPositionAt(length));
 						}
 						String text = changeEvent.getText();
-						int startOffset = offsetAt(range.getStart());
+						int startOffset = lt.getOffsetAt(range.getStart());
 						buffer.replace(startOffset, startOffset + length, text);
 					}
+					// Update the new text content from the updated buffer
 					setText(buffer.toString());
 				}
 			} catch (BadLocationException e) {
-				// Should never occurs.
+				// Should never occur.
 			}
 		} else {
 			// like vscode does, get the last changes
@@ -170,8 +178,4 @@ public void update(List<TextDocumentContentChangeEvent> changes) {
 		}
 	}
 
-	public boolean isIncremental() {
-		return buffer != null;
-	}
-
 }
diff --git a/org.eclipse.lsp4xml/src/main/java/org/eclipse/lsp4xml/commons/TextDocuments.java b/org.eclipse.lsp4xml/src/main/java/org/eclipse/lsp4xml/commons/TextDocuments.java
@@ -20,28 +20,22 @@
 import org.eclipse.lsp4j.DidOpenTextDocumentParams;
 import org.eclipse.lsp4j.TextDocumentContentChangeEvent;
 import org.eclipse.lsp4j.TextDocumentItem;
+import org.eclipse.lsp4xml.settings.SharedSettings;
 
 /**
  * A manager for simple text documents
  */
 public class TextDocuments implements ITextDocumentFactory {
 
-	private boolean incremental;
+	private SharedSettings settings;
 
 	private final Map<String, TextDocument> documents;
 
+	private boolean incremental;
+
 	public TextDocuments() {
 		documents = new HashMap<>();
-	}
-
-	/**
-	 * Set the incremental support.
-	 * 
-	 * @param incremental
-	 */
-	public void setIncremental(boolean incremental) {
-		this.incremental = incremental;
-		documents.values().forEach(document -> document.setIncremental(incremental));
+		documents.values().forEach(document -> document.setIncremental(isIncremental()));
 	}
 
 	/**
@@ -55,6 +49,14 @@ public boolean isIncremental() {
 		return incremental;
 	}
 
+	public void setIncremental(boolean incremental) {
+		if(this.incremental != incremental) {
+			this.incremental =  incremental;
+			updateIncremental(incremental);
+		}
+
+	}
+
 	/**
 	 * Returns the document for the given URI. Returns undefined if the document is
 	 * not mananged by this instance.
@@ -74,7 +76,7 @@ public void onDidOpenTextDocument(DidOpenTextDocumentParams params) {
 	@Override
 	public TextDocument createDocument(TextDocumentItem document) {
 		TextDocument doc = new TextDocument(document);
-		doc.setIncremental(incremental);
+		doc.setIncremental(isIncremental());
 		return doc;
 	}
 
@@ -99,4 +101,11 @@ public void onDidCloseTextDocument(DidCloseTextDocumentParams params) {
 	public Collection<TextDocument> all() {
 		return documents.values();
 	}
+
+	public void updateIncremental(boolean newIncremental) {
+		Collection<TextDocument> documentList = documents.values();
+		for (TextDocument doc : documentList) {
+			doc.setIncremental(incremental);
+		}
+	}
 }
diff --git a/org.eclipse.lsp4xml/src/main/java/org/eclipse/lsp4xml/settings/SharedSettings.java b/org.eclipse.lsp4xml/src/main/java/org/eclipse/lsp4xml/settings/SharedSettings.java
@@ -25,13 +25,15 @@ public class SharedSettings {
 	public XMLFormattingOptions formattingSettings;
 	public final XMLValidationSettings validationSettings;
 	public final XMLSymbolSettings symbolSettings;
+	public final XMLExperimentalSettings experimentalSettings;
 
 	public SharedSettings() {
 		this.completionSettings = new CompletionSettings();
 		this.foldingSettings = new FoldingRangeCapabilities();
 		this.formattingSettings = new XMLFormattingOptions(true);
 		this.validationSettings = new XMLValidationSettings();
 		this.symbolSettings = new XMLSymbolSettings();
+		this.experimentalSettings = new XMLExperimentalSettings();
 	}
 
 	public void setFormattingSettings(XMLFormattingOptions formattingOptions) {

diff --git a/...settings/XMLExperimentalCapabilities.java → ...xml/settings/XMLExperimentalSettings.java b/...settings/XMLExperimentalCapabilities.java → ...xml/settings/XMLExperimentalSettings.java
@@ -14,15 +14,18 @@
  * XML experimental capabilities.
  *
  */
-public class XMLExperimentalCapabilities {
+public class XMLExperimentalSettings {
 
-	private XMLIncrementalSupportCapabilities incrementalSupport;
+	private XMLIncrementalSupportSettings incrementalSupport;
 
-	public void setIncrementalSupport(XMLIncrementalSupportCapabilities incrementalSupport) {
+	public void setIncrementalSupport(XMLIncrementalSupportSettings incrementalSupport) {
 		this.incrementalSupport = incrementalSupport;
 	}
 
-	public XMLIncrementalSupportCapabilities getIncrementalSupport() {
+	public XMLIncrementalSupportSettings getIncrementalSupport() {
+		if(incrementalSupport == null) {
+			incrementalSupport = new XMLIncrementalSupportSettings();
+		}
 		return incrementalSupport;
 	}
 }
diff --git a/org.eclipse.lsp4xml/src/main/java/org/eclipse/lsp4xml/settings/XMLGeneralClientSettings.java b/org.eclipse.lsp4xml/src/main/java/org/eclipse/lsp4xml/settings/XMLGeneralClientSettings.java
@@ -37,19 +37,34 @@ public class XMLGeneralClientSettings {
 	private LogsSettings logs;
 
 	private XMLFormattingOptions format;
-
-	private XMLExperimentalCapabilities experimental;
 
 	private CompletionSettings completion;
 
 	private ServerSettings server;
 
 	private XMLSymbolSettings symbols;
 
+	private XMLExperimentalSettings experimental;
+
+
+
+	public XMLExperimentalSettings getExperimental() {
+		return experimental;
+	}
+
+	public void setExperimental(XMLExperimentalSettings experimental) {
+		this.experimental = experimental;
+	}
+
 	public void setLogs(LogsSettings logs) {
 		this.logs = logs;
 	}
 
+	public LogsSettings getLogs() {
+		return logs;
+	}
+
+
 	public XMLSymbolSettings getSymbols() {
 		return symbols;
 	}
@@ -58,21 +73,14 @@ public void setSymbols(XMLSymbolSettings symbols) {
 		this.symbols = symbols;
 	}
 
-	public LogsSettings getLogs() {
-		return logs;
-	}
-
+
 	public void setFormat(XMLFormattingOptions format) {
 		this.format = format;
 	}
 
 	public XMLFormattingOptions getFormat() {
 		return format;
 	}
-
-	public XMLExperimentalCapabilities getExperimental() {
-		return experimental;
-	}
 
 	/**
 	 * Set completion settings

diff --git a/...gs/XMLIncrementalSupportCapabilities.java → ...ttings/XMLIncrementalSupportSettings.java b/...gs/XMLIncrementalSupportCapabilities.java → ...ttings/XMLIncrementalSupportSettings.java
@@ -14,11 +14,14 @@
  * XML experimental incremental support capabilities.
  *
  */
-public class XMLIncrementalSupportCapabilities {
+public class XMLIncrementalSupportSettings {
 
 	private Boolean enabled;
 
 	public Boolean getEnabled() {
+		if(enabled == null) {
+			enabled = false; // default off
+		}
 		return enabled;
 	}
 

diff --git a/...rc/main/java/org/eclipse/lsp4xml/settings/capabilities/ServerCapabilitiesInitializer.java b/...rc/main/java/org/eclipse/lsp4xml/settings/capabilities/ServerCapabilitiesInitializer.java
@@ -13,7 +13,6 @@
 
 import static org.eclipse.lsp4xml.settings.capabilities.ServerCapabilitiesConstants.DEFAULT_COMPLETION_OPTIONS;
 import static org.eclipse.lsp4xml.settings.capabilities.ServerCapabilitiesConstants.DEFAULT_LINK_OPTIONS;
-import static org.eclipse.lsp4xml.settings.capabilities.ServerCapabilitiesConstants.DEFAULT_SYNC_OPTION;
 
 import org.eclipse.lsp4j.ServerCapabilities;
 import org.eclipse.lsp4j.TextDocumentSyncKind;
@@ -37,9 +36,9 @@ private ServerCapabilitiesInitializer() {
 	public static ServerCapabilities getNonDynamicServerCapabilities(ClientCapabilitiesWrapper clientCapabilities,
 			boolean isIncremental) {
 		ServerCapabilities serverCapabilities = new ServerCapabilities();
-		// @formatter:off
-		serverCapabilities.setTextDocumentSync(DEFAULT_SYNC_OPTION);
+
 		serverCapabilities.setTextDocumentSync(isIncremental ? TextDocumentSyncKind.Incremental : TextDocumentSyncKind.Full);
+
 		serverCapabilities.setDocumentSymbolProvider(!clientCapabilities.isDocumentSymbolDynamicRegistrationSupported());
 		serverCapabilities.setDocumentHighlightProvider(!clientCapabilities.isDocumentHighlightDynamicRegistered());
 		serverCapabilities.setCodeActionProvider(!clientCapabilities.isCodeActionDynamicRegistered());