[1426] "Render" the completion proposal providers for text field comp…

…onent Bug: #1426 Signed-off-by: Pierre-Charles David <pierre-charles.david@obeo.fr>
eclipse-sirius · Oct 27, 2022 · cc09e61 · cc09e61
1 parent 524027b
commit cc09e61
Show file tree

Hide file tree

Showing 8 changed files with 155 additions and 12 deletions.
diff --git a/...components-forms/src/main/java/org/eclipse/sirius/components/forms/CompletionRequest.java b/...components-forms/src/main/java/org/eclipse/sirius/components/forms/CompletionRequest.java
@@ -0,0 +1,57 @@
+/*******************************************************************************
+ * Copyright (c) 2022 Obeo.
+ * This program and the accompanying materials
+ * are made available under the terms of the Eclipse Public License v2.0
+ * which accompanies this distribution, and is available at
+ * https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Contributors:
+ *     Obeo - initial API and implementation
+ *******************************************************************************/
+package org.eclipse.sirius.components.forms;
+
+import java.text.MessageFormat;
+import java.util.Objects;
+
+/**
+ * Represents a completion request for a text field.
+ *
+ * @author pcdavid
+ */
+public final class CompletionRequest {
+    /**
+     * The name of the variable used to pass the current text value to the completion provider implementation.
+     */
+    public static final String CURRENT_TEXT = "currentText"; //$NON-NLS-1$
+
+    /**
+     * The name of the variable used to pass the cursor position to the completion provider implementation.
+     */
+    public static final String CURSOR_POSITION = "cursorPosition"; //$NON-NLS-1$
+
+    private final String currentText;
+
+    private final int cursorPosition;
+
+    public CompletionRequest(String currentText, int cursorPosition) {
+        this.currentText = Objects.requireNonNull(currentText);
+        this.cursorPosition = Objects.checkIndex(cursorPosition, currentText.length());
+    }
+
+    public String getCurrentText() {
+        return this.currentText;
+    }
+
+    public int getCursorPosition() {
+        return this.cursorPosition;
+    }
+
+    @Override
+    public String toString() {
+        String pattern = "{0} '{'currentText: {1}, cursorPosition: {2}'}'"; //$NON-NLS-1$
+        return MessageFormat.format(pattern, this.getClass().getSimpleName(), this.currentText, this.cursorPosition);
+    }
+
+}
diff --git a/...d/sirius-components-forms/src/main/java/org/eclipse/sirius/components/forms/Textarea.java b/...d/sirius-components-forms/src/main/java/org/eclipse/sirius/components/forms/Textarea.java
@@ -35,6 +35,8 @@ public final class Textarea extends AbstractWidget {
 
     private TextareaStyle style;
 
+    private Function<CompletionRequest, List<CompletionProposal>> completionProposalsProvider;
+
     private Textarea() {
         // Prevent instantiation
     }
@@ -51,14 +53,18 @@ public TextareaStyle getStyle() {
         return this.style;
     }
 
+    public Function<CompletionRequest, List<CompletionProposal>> getCompletionProposalsProvider() {
+        return this.completionProposalsProvider;
+    }
+
     public static Builder newTextarea(String id) {
         return new Builder(id);
     }
 
     @Override
     public String toString() {
-        String pattern = "{0} '{'id: {1}, label: {2}, value: {3}'}'"; //$NON-NLS-1$
-        return MessageFormat.format(pattern, this.getClass().getSimpleName(), this.getId(), this.label, this.value);
+        String pattern = "{0} '{'id: {1}, label: {2}, value: {3}', supportsCompletion: {4}}'"; //$NON-NLS-1$
+        return MessageFormat.format(pattern, this.getClass().getSimpleName(), this.getId(), this.label, this.value, this.completionProposalsProvider != null);
     }
 
     /**
@@ -80,6 +86,8 @@ public static final class Builder {
 
         private TextareaStyle style;
 
+        private Function<CompletionRequest, List<CompletionProposal>> completionProposalsProvider;
+
         private List<Diagnostic> diagnostics;
 
         private Builder(String id) {
@@ -111,6 +119,11 @@ public Builder style(TextareaStyle style) {
             return this;
         }
 
+        public Builder completionProposalsProvider(Function<CompletionRequest, List<CompletionProposal>> completionProposalsProvider) {
+            this.completionProposalsProvider = Objects.requireNonNull(completionProposalsProvider);
+            return this;
+        }
+
         public Builder diagnostics(List<Diagnostic> diagnostics) {
             this.diagnostics = Objects.requireNonNull(diagnostics);
             return this;
@@ -124,6 +137,7 @@ public Textarea build() {
             textarea.value = Objects.requireNonNull(this.value);
             textarea.newValueHandler = Objects.requireNonNull(this.newValueHandler);
             textarea.style = this.style; // Optional on purpose
+            textarea.completionProposalsProvider = this.completionProposalsProvider; // Optional on purpose
             textarea.diagnostics = Objects.requireNonNull(this.diagnostics);
             return textarea;
         }

diff --git a/.../sirius-components-forms/src/main/java/org/eclipse/sirius/components/forms/Textfield.java b/.../sirius-components-forms/src/main/java/org/eclipse/sirius/components/forms/Textfield.java
@@ -35,6 +35,8 @@ public final class Textfield extends AbstractWidget {
 
     private TextfieldStyle style;
 
+    private Function<CompletionRequest, List<CompletionProposal>> completionProposalsProvider;
+
     private Textfield() {
         // Prevent instantiation
     }
@@ -51,14 +53,18 @@ public TextfieldStyle getStyle() {
         return this.style;
     }
 
+    public Function<CompletionRequest, List<CompletionProposal>> getCompletionProposalsProvider() {
+        return this.completionProposalsProvider;
+    }
+
     public static Builder newTextfield(String id) {
         return new Builder(id);
     }
 
     @Override
     public String toString() {
-        String pattern = "{0} '{'id: {1}, label: {2}, value: {3}'}'"; //$NON-NLS-1$
-        return MessageFormat.format(pattern, this.getClass().getSimpleName(), this.getId(), this.label, this.value);
+        String pattern = "{0} '{'id: {1}, label: {2}, value: {3}', supportsCompletion: {4}}'"; //$NON-NLS-1$
+        return MessageFormat.format(pattern, this.getClass().getSimpleName(), this.getId(), this.label, this.value, this.completionProposalsProvider != null);
     }
 
     /**
@@ -80,6 +86,8 @@ public static final class Builder {
 
         private TextfieldStyle style;
 
+        private Function<CompletionRequest, List<CompletionProposal>> completionProposalsProvider;
+
         private List<Diagnostic> diagnostics;
 
         private Builder(String id) {
@@ -111,6 +119,11 @@ public Builder style(TextfieldStyle style) {
             return this;
         }
 
+        public Builder completionProposalsProvider(Function<CompletionRequest, List<CompletionProposal>> completionProposalsProvider) {
+            this.completionProposalsProvider = Objects.requireNonNull(completionProposalsProvider);
+            return this;
+        }
+
         public Builder diagnostics(List<Diagnostic> diagnostics) {
             this.diagnostics = Objects.requireNonNull(diagnostics);
             return this;
@@ -124,6 +137,7 @@ public Textfield build() {
             textfield.value = Objects.requireNonNull(this.value);
             textfield.newValueHandler = Objects.requireNonNull(this.newValueHandler);
             textfield.style = this.style; // Optional on purpose
+            textfield.completionProposalsProvider = this.completionProposalsProvider; // Optional on purpose
             textfield.diagnostics = Objects.requireNonNull(this.diagnostics);
             return textfield;
         }

diff --git a/...forms/src/main/java/org/eclipse/sirius/components/forms/components/TextareaComponent.java b/...forms/src/main/java/org/eclipse/sirius/components/forms/components/TextareaComponent.java
@@ -16,6 +16,8 @@
 import java.util.Objects;
 import java.util.function.Function;
 
+import org.eclipse.sirius.components.forms.CompletionProposal;
+import org.eclipse.sirius.components.forms.CompletionRequest;
 import org.eclipse.sirius.components.forms.description.TextareaDescription;
 import org.eclipse.sirius.components.forms.elements.TextareaElementProps;
 import org.eclipse.sirius.components.forms.elements.TextareaElementProps.Builder;
@@ -27,7 +29,7 @@
 import org.eclipse.sirius.components.representations.VariableManager;
 
 /**
- * The component used to create the textarea widget.
+ * The component used to render the textarea widget.
  *
  * @author sbegaudeau
  */
@@ -62,6 +64,15 @@ public Element render() {
                 .newValueHandler(specializedHandler)
                 .children(children);
 
+        if (textareaDescription.getCompletionProposalsProvider() != null) {
+            Function<CompletionRequest, List<CompletionProposal>> proposalsProvider = request -> {
+                VariableManager completionVariables = variableManager.createChild();
+                completionVariables.put(CompletionRequest.CURRENT_TEXT, request.getCurrentText());
+                completionVariables.put(CompletionRequest.CURSOR_POSITION, request.getCursorPosition());
+                return textareaDescription.getCompletionProposalsProvider().apply(completionVariables);
+            };
+            textareaElementPropsBuilder.completionProposalsProvider(proposalsProvider);
+        }
         if (iconURL != null) {
             textareaElementPropsBuilder.iconURL(iconURL);
         }

diff --git a/...orms/src/main/java/org/eclipse/sirius/components/forms/components/TextfieldComponent.java b/...orms/src/main/java/org/eclipse/sirius/components/forms/components/TextfieldComponent.java
@@ -14,9 +14,10 @@
 
 import java.util.List;
 import java.util.Objects;
-import java.util.function.BiFunction;
 import java.util.function.Function;
 
+import org.eclipse.sirius.components.forms.CompletionProposal;
+import org.eclipse.sirius.components.forms.CompletionRequest;
 import org.eclipse.sirius.components.forms.description.TextfieldDescription;
 import org.eclipse.sirius.components.forms.elements.TextfieldElementProps;
 import org.eclipse.sirius.components.forms.elements.TextfieldElementProps.Builder;
@@ -49,9 +50,8 @@ public Element render() {
         String label = textfieldDescription.getLabelProvider().apply(variableManager);
         String iconURL = textfieldDescription.getIconURLProvider().apply(variableManager);
         String value = textfieldDescription.getValueProvider().apply(variableManager);
-        BiFunction<VariableManager, String, IStatus> genericHandler = textfieldDescription.getNewValueHandler();
         Function<String, IStatus> specializedHandler = newValue -> {
-            return genericHandler.apply(variableManager, newValue);
+            return textfieldDescription.getNewValueHandler().apply(variableManager, newValue);
         };
         var textfieldStyle = textfieldDescription.getStyleProvider().apply(variableManager);
 
@@ -64,6 +64,15 @@ public Element render() {
                 .newValueHandler(specializedHandler)
                 .children(children);
 
+        if (textfieldDescription.getCompletionProposalsProvider() != null) {
+            Function<CompletionRequest, List<CompletionProposal>> proposalsProvider = request -> {
+                VariableManager completionVariables = variableManager.createChild();
+                completionVariables.put(CompletionRequest.CURRENT_TEXT, request.getCurrentText());
+                completionVariables.put(CompletionRequest.CURSOR_POSITION, request.getCursorPosition());
+                return textfieldDescription.getCompletionProposalsProvider().apply(completionVariables);
+            };
+            textfieldElementPropsBuilder.completionProposalsProvider(proposalsProvider);
+        }
         if (iconURL != null) {
             textfieldElementPropsBuilder.iconURL(iconURL);
         }

diff --git a/...orms/src/main/java/org/eclipse/sirius/components/forms/elements/TextareaElementProps.java b/...orms/src/main/java/org/eclipse/sirius/components/forms/elements/TextareaElementProps.java
@@ -18,6 +18,8 @@
 import java.util.function.Function;
 
 import org.eclipse.sirius.components.annotations.Immutable;
+import org.eclipse.sirius.components.forms.CompletionProposal;
+import org.eclipse.sirius.components.forms.CompletionRequest;
 import org.eclipse.sirius.components.forms.TextareaStyle;
 import org.eclipse.sirius.components.representations.Element;
 import org.eclipse.sirius.components.representations.IProps;
@@ -42,6 +44,8 @@ public final class TextareaElementProps implements IProps {
 
     private Function<String, IStatus> newValueHandler;
 
+    private Function<CompletionRequest, List<CompletionProposal>> completionProposalsProvider;
+
     private TextareaStyle style;
 
     private List<Element> children;
@@ -74,6 +78,10 @@ public TextareaStyle getStyle() {
         return this.style;
     }
 
+    public Function<CompletionRequest, List<CompletionProposal>> getCompletionProposalsProvider() {
+        return this.completionProposalsProvider;
+    }
+
     @Override
     public List<Element> getChildren() {
         return this.children;
@@ -85,8 +93,8 @@ public static Builder newTextareaElementProps(String id) {
 
     @Override
     public String toString() {
-        String pattern = "{0} '{'id: {1}, label: {2}, value: {3}'}'"; //$NON-NLS-1$
-        return MessageFormat.format(pattern, this.getClass().getSimpleName(), this.id, this.label, this.value);
+        String pattern = "{0} '{'id: {1}, label: {2}, value: {3}, supportsCompletion: {4}'}'"; //$NON-NLS-1$
+        return MessageFormat.format(pattern, this.getClass().getSimpleName(), this.id, this.label, this.value, this.completionProposalsProvider != null);
     }
 
     /**
@@ -108,6 +116,8 @@ public static final class Builder {
 
         private TextareaStyle style;
 
+        private Function<CompletionRequest, List<CompletionProposal>> completionProposalsProvider;
+
         private List<Element> children;
 
         private Builder(String id) {
@@ -139,6 +149,11 @@ public Builder style(TextareaStyle style) {
             return this;
         }
 
+        public Builder completionProposalsProvider(Function<CompletionRequest, List<CompletionProposal>> completionProposalsProvider) {
+            this.completionProposalsProvider = Objects.requireNonNull(completionProposalsProvider);
+            return this;
+        }
+
         public Builder children(List<Element> children) {
             this.children = Objects.requireNonNull(children);
             return this;
@@ -152,6 +167,7 @@ public TextareaElementProps build() {
             textareaElementProps.value = Objects.requireNonNull(this.value);
             textareaElementProps.newValueHandler = Objects.requireNonNull(this.newValueHandler);
             textareaElementProps.style = this.style; // Optional on purpose
+            textareaElementProps.completionProposalsProvider = this.completionProposalsProvider; // Optional on purpose
             textareaElementProps.children = Objects.requireNonNull(this.children);
             return textareaElementProps;
         }

diff --git a/...rms/src/main/java/org/eclipse/sirius/components/forms/elements/TextfieldElementProps.java b/...rms/src/main/java/org/eclipse/sirius/components/forms/elements/TextfieldElementProps.java
@@ -18,6 +18,8 @@
 import java.util.function.Function;
 
 import org.eclipse.sirius.components.annotations.Immutable;
+import org.eclipse.sirius.components.forms.CompletionProposal;
+import org.eclipse.sirius.components.forms.CompletionRequest;
 import org.eclipse.sirius.components.forms.TextfieldStyle;
 import org.eclipse.sirius.components.representations.Element;
 import org.eclipse.sirius.components.representations.IProps;
@@ -44,6 +46,8 @@ public final class TextfieldElementProps implements IProps {
 
     private TextfieldStyle style;
 
+    private Function<CompletionRequest, List<CompletionProposal>> completionProposalsProvider;
+
     private List<Element> children;
 
     private TextfieldElementProps() {
@@ -66,6 +70,10 @@ public String getValue() {
         return this.value;
     }
 
+    public Function<CompletionRequest, List<CompletionProposal>> getCompletionProposalsProvider() {
+        return this.completionProposalsProvider;
+    }
+
     @Override
     public List<Element> getChildren() {
         return this.children;
@@ -85,8 +93,8 @@ public static Builder newTextfieldElementProps(String id) {
 
     @Override
     public String toString() {
-        String pattern = "{0} '{'id: {1}, label: {2}, value: {3}'}'"; //$NON-NLS-1$
-        return MessageFormat.format(pattern, this.getClass().getSimpleName(), this.id, this.label, this.value);
+        String pattern = "{0} '{'id: {1}, label: {2}, value: {3}, supportsCompletion: {4}'}'"; //$NON-NLS-1$
+        return MessageFormat.format(pattern, this.getClass().getSimpleName(), this.id, this.label, this.value, this.completionProposalsProvider != null);
     }
 
     /**
@@ -108,6 +116,8 @@ public static final class Builder {
 
         private TextfieldStyle style;
 
+        private Function<CompletionRequest, List<CompletionProposal>> completionProposalsProvider;
+
         private List<Element> children;
 
         private Builder(String id) {
@@ -139,6 +149,11 @@ public Builder style(TextfieldStyle style) {
             return this;
         }
 
+        public Builder completionProposalsProvider(Function<CompletionRequest, List<CompletionProposal>> completionProposalsProvider) {
+            this.completionProposalsProvider = Objects.requireNonNull(completionProposalsProvider);
+            return this;
+        }
+
         public Builder children(List<Element> children) {
             this.children = Objects.requireNonNull(children);
             return this;
@@ -152,6 +167,7 @@ public TextfieldElementProps build() {
             textfieldElementProps.value = Objects.requireNonNull(this.value);
             textfieldElementProps.newValueHandler = Objects.requireNonNull(this.newValueHandler);
             textfieldElementProps.style = this.style; // Optional on purpose
+            textfieldElementProps.completionProposalsProvider = this.completionProposalsProvider; // Optional on purpose
             textfieldElementProps.children = Objects.requireNonNull(this.children);
             return textfieldElementProps;
         }