45 | * This constructor ensures the add-on is registered with the terminal and verifies that the 46 | * add-on's name, as returned by {@link #getName()}, is not {@code null}. A non-null name is 47 | * required for client-side add-ons to be uniquely identified and targeted for JavaScript 48 | * execution. 49 | *
50 | * 51 | * @param xterm the {@link XTermBase} instance this add-on will be attached to. Must not be 52 | * {@code null}. 53 | * @throws NullPointerException if {@code xterm} is {@code null} 54 | * @throws IllegalStateException if {@link #getName()} returns {@code null} immediately after 55 | * superclass construction. This check relies on {@code getName()} being a static value. 56 | */ 57 | protected ClientTerminalAddon(XTermBase xterm) { 58 | super(xterm); 59 | this.xterm = xterm; 60 | if (getName() == null) { 61 | throw new IllegalStateException("getName() must return a non-null value"); 62 | } 63 | } 64 | 65 | /** 66 | * The xterm instance that this add-on is associated with. 67 | */ 68 | protected XTermBase getXterm() { 69 | return xterm; 70 | } 71 | 72 | /** 73 | * Retrieves the unique name of this client-side add-on. 74 | *75 | * This name is used by {@link #executeJs(String, Serializable...)} to target the corresponding 76 | * JavaScript object on the client (i.e., {@code this.addons[name]} within the client-side 77 | * terminal's scope). The name effectively acts as a key in a client-side add-ons collection 78 | * managed by the terminal. 79 | *
80 | * 81 | * @return the unique, non-null string identifier for the client-side counterpart of this add-on. 82 | * Subclasses must implement this to provide a name for add-on-specific JavaScript 83 | * execution. 84 | */ 85 | protected abstract String getName(); 86 | 87 | /** 88 | * Executes a JavaScript {@code expression} in the context of this add-on, with the specified 89 | * {@code parameters}. 90 | * 91 | * @see #getName() 92 | * @see Element#executeJs(String, Serializable...) 93 | */ 94 | protected final void executeJs(String expression, Serializable... parameters) { 95 | String name = getName(); 96 | 97 | JsonArray args = Json.createArray(); 98 | for (int i = 0; i < parameters.length; i++) { 99 | args.set(i, JsonCodec.encodeWithTypeInfo(parameters[i])); 100 | } 101 | 102 | expression = expression.replaceAll("\\$(\\d+)", "\\$1[$1]"); 103 | xterm.executeJs("(function(){" + expression + "}).apply(this.addons[$0],$1);", name, args); 104 | } 105 | 106 | } 107 | -------------------------------------------------------------------------------- /src/main/java/com/flowingcode/vaadin/addons/xterm/ITerminal.java: -------------------------------------------------------------------------------- 1 | /*- 2 | * #%L 3 | * XTerm Console Addon 4 | * %% 5 | * Copyright (C) 2020 - 2023 Flowing Code 6 | * %% 7 | * Licensed under the Apache License, Version 2.0 (the "License"); 8 | * you may not use this file except in compliance with the License. 9 | * You may obtain a copy of the License at 10 | * 11 | * http://www.apache.org/licenses/LICENSE-2.0 12 | * 13 | * Unless required by applicable law or agreed to in writing, software 14 | * distributed under the License is distributed on an "AS IS" BASIS, 15 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 16 | * See the License for the specific language governing permissions and 17 | * limitations under the License. 18 | * #L% 19 | */ 20 | package com.flowingcode.vaadin.addons.xterm; 21 | 22 | import java.io.Serializable; 23 | import java.util.concurrent.CompletableFuture; 24 | 25 | /** The API that represents an xterm.js terminal. */ 26 | public interface ITerminal extends Serializable { 27 | 28 | /** Unfocus the terminal. */ 29 | void blur(); 30 | 31 | /** Focus the terminal. */ 32 | void focus(); 33 | 34 | /** Gets whether the terminal has an active selection. */ 35 | CompletableFuture- Letter spacing - Cursor blink 119 | */ 120 | void setRendererType(RendererType value); 121 | 122 | enum RendererType { 123 | DOM, 124 | CANVAS 125 | } 126 | 127 | /** 128 | * Whether to select the word under the cursor on right click, this is standard behavior in a lot 129 | * of macOS applications. 130 | */ 131 | void setRightClickSelectsWord(boolean value); 132 | 133 | /** 134 | * Whether screen reader support is enabled. When on this will expose supporting elements in the 135 | * DOM to support NVDA on Windows and VoiceOver on macOS. 136 | */ 137 | void setScreenReaderMode(boolean value); 138 | 139 | /** 140 | * The amount of scrollback in the terminal. Scrollback is the amount of rows that are retained 141 | * when lines are scrolled beyond the initial viewport. 142 | */ 143 | void setScrollback(int value); 144 | 145 | /** The scrolling speed multiplier used for adjusting normal scrolling speed. */ 146 | void setScrollSensitivity(int value); 147 | 148 | /** The size of tab stops in the terminal. */ 149 | void setTabStopWidth(int value); 150 | 151 | /** 152 | * A string containing all characters that are considered word separated by the double click to 153 | * select work logic. 154 | */ 155 | void setWordSeparator(String value); 156 | } 157 | -------------------------------------------------------------------------------- /src/main/java/com/flowingcode/vaadin/addons/xterm/ITerminalSelection.java: -------------------------------------------------------------------------------- 1 | /*- 2 | * #%L 3 | * XTerm Console Addon 4 | * %% 5 | * Copyright (C) 2020 - 2023 Flowing Code 6 | * %% 7 | * Licensed under the Apache License, Version 2.0 (the "License"); 8 | * you may not use this file except in compliance with the License. 9 | * You may obtain a copy of the License at 10 | * 11 | * http://www.apache.org/licenses/LICENSE-2.0 12 | * 13 | * Unless required by applicable law or agreed to in writing, software 14 | * distributed under the License is distributed on an "AS IS" BASIS, 15 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 16 | * See the License for the specific language governing permissions and 17 | * limitations under the License. 18 | * #L% 19 | */ 20 | package com.flowingcode.vaadin.addons.xterm; 21 | 22 | import com.vaadin.flow.component.HasElement; 23 | 24 | /** 25 | * Add selection support to XTerm using arrow keys. 26 | */ 27 | public interface ITerminalSelection extends HasElement { 28 | 29 | /** Sets the command line prompt. */ 30 | default void setKeyboardSelectionEnabled(boolean enabled) { 31 | getElement().setProperty("keyboardSelectionEnabled", enabled); 32 | } 33 | 34 | /** Returns the command line prompt. */ 35 | default boolean getKeyboardSelectionEnabled() { 36 | // the feature is enabled by default 37 | // getProperty defaults to false in case the mixin isn't applied 38 | return getElement().getProperty("keyboardSelectionEnabled", false); 39 | } 40 | 41 | } 42 | -------------------------------------------------------------------------------- /src/main/java/com/flowingcode/vaadin/addons/xterm/PreserveStateAddon.java: -------------------------------------------------------------------------------- 1 | /*- 2 | * #%L 3 | * XTerm Console Addon 4 | * %% 5 | * Copyright (C) 2020 - 2025 Flowing Code 6 | * %% 7 | * Licensed under the Apache License, Version 2.0 (the "License"); 8 | * you may not use this file except in compliance with the License. 9 | * You may obtain a copy of the License at 10 | * 11 | * http://www.apache.org/licenses/LICENSE-2.0 12 | * 13 | * Unless required by applicable law or agreed to in writing, software 14 | * distributed under the License is distributed on an "AS IS" BASIS, 15 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 16 | * See the License for the specific language governing permissions and 17 | * limitations under the License. 18 | * #L% 19 | */ 20 | package com.flowingcode.vaadin.addons.xterm; 21 | 22 | import com.flowingcode.vaadin.addons.xterm.utils.StateMemoizer; 23 | import lombok.experimental.Delegate; 24 | 25 | import java.util.Objects; 26 | import java.util.concurrent.CompletableFuture; 27 | 28 | /** 29 | * Add-on which preserves the client-side state when the component is removed 30 | * from the UI then reattached later on. The problem here is that when the 31 | * {@link XTerm} server-side component is detached from the UI, the xterm.js client-side 32 | * component is destroyed along with its state. When the {@link XTerm} component 33 | * is later re-attached to the UI, a new unconfigured xterm.js is created on the 34 | * client-side. 35 | *
36 | * To use this addon, simply create the addon then make sure to call all {@link ITerminal} 37 | * and {@link ITerminalOptions} methods via this addon: 38 | *
39 | * final XTerm xterm = new XTerm();
40 | * final PreserveStateAddon addon = new PreserveStateAddon(xterm);
41 | * addon.writeln("Hello!");
42 | * addon.setPrompt("$ ");
43 | * addon.writePrompt();
44 | *
45 | */
46 | public class PreserveStateAddon extends TerminalAddon
47 | implements ITerminal, ITerminalOptions {
48 |
49 | /**
50 | * The xterm to delegate all calls to.
51 | */
52 | private final XTerm xterm;
53 | /**
54 | * Remembers everything that was printed into the xterm and what the user typed in.
55 | */
56 | private final StringBuilder scrollbackBuffer = new StringBuilder();
57 | /**
58 | * All commands are properly applied before the first attach; they're just
59 | * not preserved after subsequent detach/attach.
60 | */
61 | private boolean wasDetachedOnce = false;
62 | /**
63 | * Used to re-apply all options to the xterm after it has been reattached back to the UI.
64 | * Otherwise, the options would not be applied to the client-side xterm.js component.
65 | */
66 | private final StateMemoizer optionsMemoizer;
67 |
68 | /**
69 | * Delegate all option setters through this delegate, which is the {@link #optionsMemoizer} proxy.
70 | * That will allow us to re-apply the settings when the xterm is re-attached.
71 | *
72 | * For example, calling {@link ITerminalOptions#setBellSound(String)}
73 | * on this addon will pass through the call to this delegate, which in turn passes
74 | * the call to {@link #optionsMemoizer} which remembers the call and passes
75 | * it to {@link #xterm}.
76 | *
77 | * After the xterm.js is re-attached, we simply call {@link StateMemoizer#apply()}
78 | * to apply all changed setters again to xterm.js, to make sure xterm.js is
79 | * configured.
80 | */
81 | @Delegate
82 | private final ITerminalOptions optionsDelegate;
83 |
84 | public PreserveStateAddon(XTerm xterm) {
85 | super(xterm);
86 | this.xterm = Objects.requireNonNull(xterm);
87 | optionsMemoizer = new StateMemoizer(xterm, ITerminalOptions.class);
88 | optionsDelegate = (ITerminalOptions) optionsMemoizer.getProxy();
89 | xterm.addAttachListener(e -> {
90 | if (wasDetachedOnce) {
91 | optionsMemoizer.apply();
92 | xterm.write(scrollbackBuffer.toString());
93 | xterm.writePrompt();
94 | }
95 | });
96 | xterm.addDetachListener(e -> wasDetachedOnce = true);
97 | xterm.addLineListener(e -> {
98 | // add the prompt to the scrollback buffer
99 | scrollbackBuffer.append(xterm.getPrompt());
100 | // also make sure that any user input ends up in the scrollback buffer.
101 | scrollbackBuffer.append(e.getLine());
102 | scrollbackBuffer.append('\n');
103 | });
104 | }
105 |
106 | @Override
107 | public void blur() {
108 | xterm.blur();
109 | }
110 |
111 | @Override
112 | public void focus() {
113 | xterm.focus();
114 | }
115 |
116 | @Override
117 | public CompletableFuture29 | * Concrete add-on implementations should subclass this class to provide specific features. Each 30 | * add-on is tightly coupled with a specific {@code XTermBase} instance, allowing it to interact 31 | * with and enhance that terminal. 32 | *
33 | * 34 | * @author Javier Godoy / Flowing Code S.A. 35 | */ 36 | @SuppressWarnings("serial") 37 | public abstract class TerminalAddon implements Serializable { 38 | 39 | /** 40 | * Constructs a new {@code TerminalAddon} and associates it with the provided {@link XTermBase} 41 | * instance. 42 | * 43 | * @param xterm the {@code XTermBase} instance to which this add-on will be attached 44 | * @throws NullPointerException if the provided {@code xterm} is {@code null} 45 | */ 46 | protected TerminalAddon(XTermBase xterm) { 47 | Objects.requireNonNull(xterm); 48 | xterm.registerServerSideAddon(this); 49 | } 50 | 51 | } 52 | -------------------------------------------------------------------------------- /src/main/java/com/flowingcode/vaadin/addons/xterm/TerminalHistory.java: -------------------------------------------------------------------------------- 1 | /*- 2 | * #%L 3 | * XTerm Console Addon 4 | * %% 5 | * Copyright (C) 2020 - 2023 Flowing Code 6 | * %% 7 | * Licensed under the Apache License, Version 2.0 (the "License"); 8 | * you may not use this file except in compliance with the License. 9 | * You may obtain a copy of the License at 10 | * 11 | * http://www.apache.org/licenses/LICENSE-2.0 12 | * 13 | * Unless required by applicable law or agreed to in writing, software 14 | * distributed under the License is distributed on an "AS IS" BASIS, 15 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 16 | * See the License for the specific language governing permissions and 17 | * limitations under the License. 18 | * #L% 19 | */ 20 | package com.flowingcode.vaadin.addons.xterm; 21 | 22 | import com.vaadin.flow.component.ComponentUtil; 23 | import com.vaadin.flow.component.Key; 24 | import com.vaadin.flow.shared.Registration; 25 | import java.io.IOException; 26 | import java.io.ObjectInputStream; 27 | import java.io.Serializable; 28 | import java.util.ArrayList; 29 | import java.util.Collections; 30 | import java.util.Iterator; 31 | import java.util.LinkedList; 32 | import java.util.List; 33 | import java.util.ListIterator; 34 | import java.util.Objects; 35 | import java.util.Optional; 36 | import java.util.function.Predicate; 37 | 38 | /** Manages a command history buffer for {@link XTerm}. */ 39 | @SuppressWarnings("serial") 40 | public class TerminalHistory implements Serializable { 41 | 42 | private LinkedList291 | * Example usage: 292 | *
293 | * 294 | *{@code
295 | * MySpecificAddon addon = terminal.getAddon(MySpecificAddon.class);
296 | * if (addon != null) {
297 | * addon.doSomethingSpecific();
298 | * }
299 | * }
300 | *
301 | * @param The tests use Chrome driver (see pom.xml for integration-tests profile) to run integration 35 | * tests on a headless Chrome. If a property {@code test.use .hub} is set to true, {@code 36 | * AbstractViewTest} will assume that the TestBench test is running in a CI environment. In order to 37 | * keep the this class light, it makes certain assumptions about the CI environment (such as 38 | * available environment variables). It is not advisable to use this class as a base class for you 39 | * own TestBench tests. 40 | * 41 | *
To learn more about TestBench, visit Vaadin TestBench.
43 | */
44 | public abstract class AbstractViewTest extends ParallelTest {
45 | private static final int SERVER_PORT = 8080;
46 |
47 | private final String route;
48 |
49 | @Rule public ScreenshotOnFailureRule rule = new ScreenshotOnFailureRule(this, true);
50 |
51 | public AbstractViewTest() {
52 | this("");
53 | }
54 |
55 | protected AbstractViewTest(String route) {
56 | this.route = route;
57 | }
58 |
59 | @BeforeClass
60 | public static void setupClass() {
61 | WebDriverManager.chromedriver().setup();
62 | }
63 |
64 | @Override
65 | @Before
66 | public void setup() throws Exception {
67 | if (isUsingHub()) {
68 | super.setup();
69 | } else {
70 | setDriver(TestBench.createDriver(new ChromeDriver()));
71 | }
72 | getDriver().get(getURL(route));
73 | }
74 |
75 | /**
76 | * Returns deployment host name concatenated with route.
77 | *
78 | * @return URL to route
79 | */
80 | private static String getURL(String route) {
81 | return String.format("http://%s:%d/%s", getDeploymentHostname(), SERVER_PORT, route);
82 | }
83 |
84 | /** Property set to true when running on a test hub. */
85 | private static final String USE_HUB_PROPERTY = "test.use.hub";
86 |
87 | /**
88 | * Returns whether we are using a test hub. This means that the starter is running tests in
89 | * Vaadin's CI environment, and uses TestBench to connect to the testing hub.
90 | *
91 | * @return whether we are using a test hub
92 | */
93 | private static boolean isUsingHub() {
94 | return Boolean.TRUE.toString().equals(System.getProperty(USE_HUB_PROPERTY));
95 | }
96 |
97 | /**
98 | * If running on CI, get the host name from environment variable HOSTNAME
99 | *
100 | * @return the host name
101 | */
102 | private static String getDeploymentHostname() {
103 | return isUsingHub() ? System.getenv("HOSTNAME") : "localhost";
104 | }
105 | }
106 |
--------------------------------------------------------------------------------
/src/test/java/com/flowingcode/vaadin/addons/xterm/integration/ClipboardFeatureIT.java:
--------------------------------------------------------------------------------
1 | /*-
2 | * #%L
3 | * XTerm Console Addon
4 | * %%
5 | * Copyright (C) 2020 - 2023 Flowing Code
6 | * %%
7 | * Licensed under the Apache License, Version 2.0 (the "License");
8 | * you may not use this file except in compliance with the License.
9 | * You may obtain a copy of the License at
10 | *
11 | * http://www.apache.org/licenses/LICENSE-2.0
12 | *
13 | * Unless required by applicable law or agreed to in writing, software
14 | * distributed under the License is distributed on an "AS IS" BASIS,
15 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 | * See the License for the specific language governing permissions and
17 | * limitations under the License.
18 | * #L%
19 | */
20 | package com.flowingcode.vaadin.addons.xterm.integration;
21 |
22 | import static org.hamcrest.Matchers.is;
23 | import static org.junit.Assert.assertThat;
24 | import java.util.List;
25 | import org.junit.Test;
26 | import org.openqa.selenium.interactions.Actions;
27 |
28 | public class ClipboardFeatureIT extends AbstractViewTest {
29 |
30 | private static int[] intArray(Object obj) {
31 | return ((List) obj).stream().mapToInt(i -> ((Long) i).intValue()).toArray();
32 | }
33 |
34 | @Test
35 | public void testFeature() {
36 | XTermElement term = $(XTermElement.class).first();
37 |
38 | term.setPrompt(null);
39 | term.write("\\x1bcTEXT");
40 |
41 | int[] size =
42 | intArray(
43 | term
44 | .executeScript(
45 | "return [this.clientWidth, this.clientHeight]"));
46 |
47 | term.setUseSystemClipboard(false);
48 |
49 | new Actions(driver)
50 | .moveToElement(term, -size[0] / 2, -size[1] / 2 + 10)
51 | .clickAndHold()
52 | .moveByOffset(100, 0)
53 | .release()
54 | .perform();
55 |
56 | new Actions(driver).contextClick().perform();
57 | assertThat(term.currentLine(), is("TEXTTEXT"));
58 | }
59 | }
60 |
--------------------------------------------------------------------------------
/src/test/java/com/flowingcode/vaadin/addons/xterm/integration/ConsoleFeatureIT.java:
--------------------------------------------------------------------------------
1 | /*-
2 | * #%L
3 | * XTerm Console Addon
4 | * %%
5 | * Copyright (C) 2020 - 2023 Flowing Code
6 | * %%
7 | * Licensed under the Apache License, Version 2.0 (the "License");
8 | * you may not use this file except in compliance with the License.
9 | * You may obtain a copy of the License at
10 | *
11 | * http://www.apache.org/licenses/LICENSE-2.0
12 | *
13 | * Unless required by applicable law or agreed to in writing, software
14 | * distributed under the License is distributed on an "AS IS" BASIS,
15 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 | * See the License for the specific language governing permissions and
17 | * limitations under the License.
18 | * #L%
19 | */
20 | package com.flowingcode.vaadin.addons.xterm.integration;
21 |
22 | import static com.flowingcode.vaadin.addons.xterm.integration.XTermTestUtils.makeFullLine;
23 | import static org.hamcrest.Matchers.is;
24 | import static org.hamcrest.Matchers.isEmptyString;
25 | import static org.junit.Assert.assertThat;
26 | import org.junit.Test;
27 | import org.openqa.selenium.Keys;
28 |
29 | public class ConsoleFeatureIT extends AbstractViewTest {
30 |
31 | @Test
32 | public void testWriteWrappedLine() throws InterruptedException {
33 | XTermElement term = $(XTermElement.class).first();
34 | Position home = term.cursorPosition();
35 | String text = makeFullLine(term, true) + "Z";
36 | term.sendKeys(text);
37 | assertThat(term.currentLine(), is(text));
38 | assertThat(term.cursorPosition(), is(new Position(1, home.y + 1)));
39 | assertThat(term.lineAtOffset(0), is("Z"));
40 | }
41 |
42 | @Test
43 | public void testFeature() throws InterruptedException {
44 | // navigation with keyboard
45 | XTermElement term = $(XTermElement.class).first();
46 |
47 | Position pos = term.cursorPosition();
48 |
49 | term.sendKeys("HELLO");
50 | assertThat(term.currentLine(), is("HELLO"));
51 | assertThat(term.cursorPosition(), is(pos.plus(5, 0)));
52 |
53 | term.sendKeys(Keys.ARROW_LEFT);
54 | assertThat(term.cursorPosition(), is(pos.plus(4, 0)));
55 |
56 | term.sendKeys(Keys.ARROW_RIGHT);
57 | assertThat(term.cursorPosition(), is(pos.plus(5, 0)));
58 |
59 | term.sendKeys(Keys.HOME);
60 | assertThat(term.cursorPosition(), is(pos.plus(0, 0)));
61 |
62 | term.sendKeys(Keys.END);
63 | assertThat(term.cursorPosition(), is(pos.plus(5, 0)));
64 |
65 | term.sendKeys(Keys.BACK_SPACE);
66 | assertThat(term.currentLine(), is("HELL"));
67 | assertThat(term.cursorPosition(), is(pos.plus(4, 0)));
68 |
69 | term.sendKeys(Keys.HOME, Keys.DELETE);
70 | assertThat(term.currentLine(), is("ELL"));
71 | assertThat(term.cursorPosition(), is(pos.plus(0, 0)));
72 |
73 | term.sendKeys("A");
74 | assertThat(term.currentLine(), is("AELL"));
75 |
76 | term.sendKeys(Keys.INSERT, "B");
77 | assertThat(term.currentLine(), is("ABLL"));
78 |
79 | term.sendKeys(Keys.INSERT, "C");
80 | assertThat(term.currentLine(), is("ABCLL"));
81 |
82 |
83 | // long line
84 | term.sendKeys(Keys.ENTER);
85 | assertThat(term.currentLine(), is(""));
86 | assertThat(term.cursorPosition(), is(pos.advance(0, 1)));
87 |
88 | String prompt = term.lineAtOffset(0);
89 | String text = makeFullLine(term, true);
90 | int cols = text.length();
91 |
92 | term.sendKeys(text);
93 | term.sendKeys(Keys.HOME);
94 | assertThat(term.cursorPosition(), is(pos));
95 | assertThat(term.currentLine(), is(text));
96 |
97 | term.sendKeys("A");
98 | assertThat(term.lineAtOffset(0), is(prompt + "A" + text.substring(0, cols - 1)));
99 | assertThat(term.lineAtOffset(1), is(text.substring(cols - 1)));
100 |
101 | term.sendKeys("B");
102 | assertThat(term.lineAtOffset(0), is(prompt + "AB" + text.substring(0, cols - 2)));
103 | assertThat(term.lineAtOffset(1), is(text.substring(cols - 2)));
104 |
105 | term.sendKeys(Keys.END);
106 | assertThat(term.cursorPosition(), is(new Position(2, pos.y + 1)));
107 |
108 | term.sendKeys(Keys.HOME);
109 | assertThat(term.cursorPosition(), is(pos));
110 |
111 | term.sendKeys(Keys.DELETE);
112 | assertThat(term.lineAtOffset(0), is(prompt + "B" + text.substring(0, cols - 1)));
113 | assertThat(term.lineAtOffset(1), is(text.substring(cols - 1)));
114 |
115 | term.sendKeys(Keys.DELETE);
116 | assertThat(term.lineAtOffset(0), is(prompt + text));
117 | assertThat(term.lineAtOffset(1), isEmptyString());
118 | }
119 |
120 | @Test
121 | public void testCsiSequences() throws InterruptedException {
122 | // CSI sequences that implement navigation with keyboard
123 | XTermElement term = $(XTermElement.class).first();
124 | Position pos = term.cursorPosition();
125 |
126 | term.sendKeys("HELLO");
127 | assertThat(term.currentLine(), is("HELLO"));
128 |
129 | // Cursor Home Logical Line
130 | term.write("\u001b[dx,dy.*/
33 | public Position advance(int dx, int dy) {
34 | this.x+=dx;
35 | this.y+=dy;
36 | return this;
37 | }
38 |
39 | /**Return a new position that is equal to this position plus dx,dy.*/
40 | public Position plus(int dx, int dy) {
41 | return new Position(this.x+dx, this.y+dy);
42 | }
43 |
44 | /**Return a new position that is equal to this position adjusted by columnWidth.*/
45 | public Position adjust(int columnWidth) {
46 | int pos = x + y*columnWidth;
47 | return new Position(pos%columnWidth, pos/columnWidth);
48 | }
49 |
50 | }
51 |
--------------------------------------------------------------------------------
/src/test/java/com/flowingcode/vaadin/addons/xterm/integration/SelectionFeatureIT.java:
--------------------------------------------------------------------------------
1 | /*-
2 | * #%L
3 | * XTerm Console Addon
4 | * %%
5 | * Copyright (C) 2020 - 2023 Flowing Code
6 | * %%
7 | * Licensed under the Apache License, Version 2.0 (the "License");
8 | * you may not use this file except in compliance with the License.
9 | * You may obtain a copy of the License at
10 | *
11 | * http://www.apache.org/licenses/LICENSE-2.0
12 | *
13 | * Unless required by applicable law or agreed to in writing, software
14 | * distributed under the License is distributed on an "AS IS" BASIS,
15 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 | * See the License for the specific language governing permissions and
17 | * limitations under the License.
18 | * #L%
19 | */
20 | package com.flowingcode.vaadin.addons.xterm.integration;
21 |
22 | import static com.flowingcode.vaadin.addons.xterm.integration.XTermTestUtils.makeFullLine;
23 | import static org.hamcrest.Matchers.is;
24 | import static org.hamcrest.Matchers.isEmptyString;
25 | import static org.junit.Assert.assertThat;
26 | import org.junit.Test;
27 | import org.openqa.selenium.Keys;
28 |
29 | public class SelectionFeatureIT extends AbstractViewTest {
30 |
31 | @Test
32 | public void testSelectionFeature() throws InterruptedException {
33 | XTermElement term = $(XTermElement.class).first();
34 | Position pos;
35 |
36 | term.write("abcd");
37 | pos = term.cursorPosition();
38 |
39 | // select left, backspace
40 | term.sendKeys(Keys.SHIFT, Keys.ARROW_LEFT);
41 | assertThat(term.getSelection(), is("d"));
42 | assertThat(term.cursorPosition(), is(pos));
43 | term.sendKeys(Keys.BACK_SPACE);
44 | assertThat(term.currentLine(), is("abc"));
45 | assertThat(term.cursorPosition(), is(pos.advance(-1, 0)));
46 |
47 | // select left, delete
48 | term.sendKeys(Keys.SHIFT, Keys.ARROW_LEFT);
49 | assertThat(term.getSelection(), is("c"));
50 | assertThat(term.cursorPosition(), is(pos));
51 | term.sendKeys(Keys.DELETE);
52 | assertThat(term.currentLine(), is("ab"));
53 | assertThat(term.cursorPosition(), is(pos.advance(-1, 0)));
54 |
55 | // select right, delete
56 | term.sendKeys(Keys.HOME);
57 | pos = term.cursorPosition();
58 | term.sendKeys(Keys.SHIFT, Keys.ARROW_RIGHT);
59 | assertThat(term.getSelection(), is("a"));
60 | assertThat(term.cursorPosition(), is(pos));
61 | term.sendKeys(Keys.DELETE);
62 | assertThat(term.currentLine(), is("b"));
63 | assertThat(term.cursorPosition(), is(pos));
64 |
65 | // select right, backspace
66 | term.sendKeys(Keys.SHIFT, Keys.ARROW_RIGHT);
67 | assertThat(term.getSelection(), is("b"));
68 | assertThat(term.cursorPosition(), is(pos));
69 | term.sendKeys(Keys.BACK_SPACE);
70 | assertThat(term.currentLine(), isEmptyString());
71 | assertThat(term.cursorPosition(), is(pos));
72 |
73 | term.write("abcd");
74 | pos = term.cursorPosition();
75 |
76 | // select to home, delete
77 | term.sendKeys(Keys.SHIFT, Keys.HOME);
78 | assertThat(term.getSelection(), is("abcd"));
79 | assertThat(term.cursorPosition(), is(pos));
80 | term.sendKeys(Keys.DELETE);
81 | assertThat(term.currentLine(), isEmptyString());
82 | assertThat(term.cursorPosition(), is(pos.advance(-4, 0)));
83 |
84 | // select to end, delete
85 | term.write("abcd");
86 | term.sendKeys(Keys.HOME);
87 | pos = term.cursorPosition();
88 | term.sendKeys(Keys.SHIFT, Keys.END);
89 | assertThat(term.getSelection(), is("abcd"));
90 | assertThat(term.cursorPosition(), is(pos));
91 | term.sendKeys(Keys.DELETE);
92 | assertThat(term.currentLine(), isEmptyString());
93 | assertThat(term.cursorPosition(), is(pos));
94 |
95 | String text = makeFullLine(term, true) + makeFullLine(term, false) + makeFullLine(term, false);
96 |
97 | // select to home, delete (wrapping)
98 | term.write(text);
99 | assertThat(term.currentLine(), is(text));
100 | term.sendKeys(Keys.SHIFT, Keys.HOME);
101 | assertThat(term.getSelection(), is(text));
102 | term.sendKeys(Keys.DELETE);
103 | assertThat(term.currentLine(), isEmptyString());
104 |
105 | // select to end, delete (wrapping)
106 | term.write(text);
107 | assertThat(term.currentLine(), is(text));
108 | term.sendKeys(Keys.HOME);
109 | term.sendKeys(Keys.SHIFT, Keys.END);
110 | assertThat(term.getSelection(), is(text));
111 | term.sendKeys(Keys.DELETE);
112 | assertThat(term.currentLine(), isEmptyString());
113 |
114 | }
115 |
116 | }
--------------------------------------------------------------------------------
/src/test/java/com/flowingcode/vaadin/addons/xterm/integration/TerminalHistoryIT.java:
--------------------------------------------------------------------------------
1 | /*-
2 | * #%L
3 | * XTerm Console Addon
4 | * %%
5 | * Copyright (C) 2020 - 2023 Flowing Code
6 | * %%
7 | * Licensed under the Apache License, Version 2.0 (the "License");
8 | * you may not use this file except in compliance with the License.
9 | * You may obtain a copy of the License at
10 | *
11 | * http://www.apache.org/licenses/LICENSE-2.0
12 | *
13 | * Unless required by applicable law or agreed to in writing, software
14 | * distributed under the License is distributed on an "AS IS" BASIS,
15 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 | * See the License for the specific language governing permissions and
17 | * limitations under the License.
18 | * #L%
19 | */
20 | package com.flowingcode.vaadin.addons.xterm.integration;
21 |
22 | import static org.hamcrest.Matchers.is;
23 | import static org.hamcrest.Matchers.isEmptyString;
24 | import static org.junit.Assert.assertThat;
25 | import org.junit.Test;
26 | import org.openqa.selenium.Keys;
27 |
28 | public class TerminalHistoryIT extends AbstractViewTest {
29 |
30 | @Test
31 | public void testArrowKeys() {
32 | XTermElement term = $(XTermElement.class).first();
33 |
34 | Position pos = term.cursorPosition();
35 | term.sendKeys("foo1\nfoo2\n");
36 |
37 | assertThat(term.cursorPosition(), is(pos.advance(0, 2)));
38 | assertThat(term.currentLine(), isEmptyString());
39 |
40 | term.sendKeys(Keys.ARROW_UP);
41 | assertThat(term.currentLine(), is("foo2"));
42 |
43 | term.sendKeys(Keys.ARROW_UP);
44 | assertThat(term.currentLine(), is("foo1"));
45 |
46 | term.sendKeys(Keys.ARROW_UP);
47 | assertThat(term.currentLine(), is("foo1"));
48 |
49 | term.sendKeys(Keys.ARROW_DOWN);
50 | assertThat(term.currentLine(), is("foo2"));
51 |
52 | term.sendKeys(Keys.ARROW_DOWN);
53 | assertThat(term.currentLine(), isEmptyString());
54 | }
55 |
56 | @Test
57 | public void testArrowKeysAndRestore() {
58 | XTermElement term = $(XTermElement.class).first();
59 |
60 | Position pos = term.cursorPosition();
61 | term.sendKeys("foo1\nfoo2\n");
62 |
63 | assertThat(term.cursorPosition(), is(pos.advance(0, 2)));
64 | assertThat(term.currentLine(), isEmptyString());
65 |
66 | term.sendKeys("bar");
67 | term.sendKeys(Keys.ARROW_UP);
68 | assertThat(term.currentLine(), is("foo2"));
69 |
70 | term.sendKeys(Keys.ARROW_DOWN);
71 | assertThat(term.currentLine(), is("bar"));
72 | }
73 |
74 | @Test
75 | public void testArrowUpAfterRunningLastCommandFromHistory() {
76 | XTermElement term = $(XTermElement.class).first();
77 |
78 | term.sendKeys("foo1\n");
79 | term.sendKeys("foo2\n");
80 |
81 | assertThat(term.currentLine(), isEmptyString());
82 |
83 | term.sendKeys(Keys.ARROW_UP);
84 | assertThat(term.currentLine(), is("foo2"));
85 | term.sendKeys("\n");
86 |
87 | term.sendKeys(Keys.ARROW_UP);
88 | assertThat(term.currentLine(), is("foo2"));
89 |
90 | term.sendKeys(Keys.ARROW_UP);
91 | assertThat(term.currentLine(), is("foo1"));
92 | }
93 |
94 | @Test
95 | public void testArrowUpAfterRunningEmptyCommand() {
96 | XTermElement term = $(XTermElement.class).first();
97 |
98 | term.sendKeys("foo1\n");
99 | term.sendKeys("foo2\n");
100 |
101 | assertThat(term.currentLine(), isEmptyString());
102 |
103 | term.sendKeys(Keys.ARROW_UP);
104 | assertThat(term.currentLine(), is("foo2"));
105 | term.sendKeys("\u0008\u0008\u0008\u0008"); // 4 backspaces
106 | assertThat(term.currentLine(), isEmptyString());
107 | term.sendKeys("\n");
108 |
109 | term.sendKeys(Keys.ARROW_UP);
110 | // The position in the history should be back at the end
111 | assertThat(term.currentLine(), is("foo2"));
112 | }
113 |
114 | }
115 |
--------------------------------------------------------------------------------
/src/test/java/com/flowingcode/vaadin/addons/xterm/integration/XTermElement.java:
--------------------------------------------------------------------------------
1 | /*-
2 | * #%L
3 | * XTerm Console Addon
4 | * %%
5 | * Copyright (C) 2020 - 2023 Flowing Code
6 | * %%
7 | * Licensed under the Apache License, Version 2.0 (the "License");
8 | * you may not use this file except in compliance with the License.
9 | * You may obtain a copy of the License at
10 | *
11 | * http://www.apache.org/licenses/LICENSE-2.0
12 | *
13 | * Unless required by applicable law or agreed to in writing, software
14 | * distributed under the License is distributed on an "AS IS" BASIS,
15 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 | * See the License for the specific language governing permissions and
17 | * limitations under the License.
18 | * #L%
19 | */
20 | package com.flowingcode.vaadin.addons.xterm.integration;
21 |
22 | import com.vaadin.testbench.TestBenchElement;
23 | import com.vaadin.testbench.commands.TestBenchCommandExecutor;
24 | import com.vaadin.testbench.elementsbase.Element;
25 | import java.util.Arrays;
26 | import java.util.List;
27 | import org.openqa.selenium.WebElement;
28 |
29 | /**
30 | * A TestBench element representing a <fc-xterm> element.
31 | */
32 | @Element("fc-xterm")
33 | public class XTermElement extends TestBenchElement {
34 |
35 | private WebElement input;
36 |
37 | @Override
38 | protected void init(WebElement element, TestBenchCommandExecutor commandExecutor) {
39 | super.init(element, commandExecutor);
40 | input = (WebElement) waitUntil(
41 | driver -> executeScript("return this.terminal.textarea"));
42 | }
43 | public void write(String text) {
44 | executeScript(String.format("this.terminal.write('%s')", text));
45 | }
46 |
47 | public int getColumnWidth() {
48 | return ((Long) executeScript("return this.terminal.cols")).intValue();
49 | }
50 |
51 | final String currentLine() {
52 | return getPropertyString("currentLine");
53 | }
54 |
55 | public String getSelection() {
56 | return (String) executeScript("return this.terminal.getSelection()");
57 | }
58 |
59 | public String lineAtOffset(int offset) {
60 | return ((String) executeScript(
61 | "buffer=this.terminal._core._inputHandler._bufferService.buffer;"
62 | + "line=buffer.lines.get(buffer.ybase+buffer.y+(arguments[0]));"
63 | + "return line.translateToString().substr(0,line.getTrimmedLength());",
64 | offset));
65 | }
66 |
67 | public Position cursorPosition() {
68 | int[] pos = intArray(executeScript(
69 | "buffer=this.terminal.buffer.active; return [buffer.cursorX, buffer.cursorY]",
70 | this));
71 | return new Position(pos[0], pos[1]);
72 | }
73 |
74 | private static int[] intArray(Object obj) {
75 | return ((List) obj).stream().mapToInt(i -> ((Long) i).intValue()).toArray();
76 | }
77 |
78 | public void setUseSystemClipboard(boolean value) {
79 | setProperty("useSystemClipboard", value);
80 | }
81 |
82 | public void setPrompt(String value) {
83 | setProperty("prompt", value);
84 | }
85 |
86 | @Override
87 | public void sendKeys(CharSequence... keysToSend) {
88 | input.sendKeys(keysToSend);
89 | }
90 |
91 | @Override
92 | public Object executeScript(String script, Object... arguments) {
93 | script = String.format(
94 | "return function(arguments){arguments.pop(); %s}.bind(arguments[arguments.length-1])([].slice.call(arguments))",
95 | script);
96 | arguments = Arrays.copyOf(arguments, arguments.length + 1);
97 | arguments[arguments.length - 1] = this;
98 | return getCommandExecutor().executeScript(script, arguments);
99 | }
100 |
101 | }
102 |
--------------------------------------------------------------------------------
/src/test/java/com/flowingcode/vaadin/addons/xterm/integration/XTermIT.java:
--------------------------------------------------------------------------------
1 | /*-
2 | * #%L
3 | * XTerm Console Addon
4 | * %%
5 | * Copyright (C) 2020 - 2023 Flowing Code
6 | * %%
7 | * Licensed under the Apache License, Version 2.0 (the "License");
8 | * you may not use this file except in compliance with the License.
9 | * You may obtain a copy of the License at
10 | *
11 | * http://www.apache.org/licenses/LICENSE-2.0
12 | *
13 | * Unless required by applicable law or agreed to in writing, software
14 | * distributed under the License is distributed on an "AS IS" BASIS,
15 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 | * See the License for the specific language governing permissions and
17 | * limitations under the License.
18 | * #L%
19 | */
20 | package com.flowingcode.vaadin.addons.xterm.integration;
21 |
22 | import static org.hamcrest.Matchers.is;
23 | import static org.hamcrest.Matchers.not;
24 | import static org.hamcrest.Matchers.notNullValue;
25 | import static org.junit.Assert.assertThat;
26 | import com.vaadin.testbench.TestBenchElement;
27 | import org.hamcrest.Description;
28 | import org.hamcrest.Matcher;
29 | import org.hamcrest.TypeSafeDiagnosingMatcher;
30 | import org.junit.Test;
31 | import org.openqa.selenium.By;
32 |
33 | public class XTermIT extends AbstractViewTest {
34 |
35 | private Matcher