Input stream supplied to TerminalBuilder.streams() is consumed when a…

… terminal instance gets created, fixes #266
jline · May 13, 2018 · a67d60f · a67d60f
1 parent f8894f3
commit a67d60f
Show file tree

Hide file tree

Showing 10 changed files with 77 additions and 10 deletions.
diff --git a/reader/src/test/java/org/jline/terminal/impl/ExternalTerminalTest.java b/reader/src/test/java/org/jline/terminal/impl/ExternalTerminalTest.java
@@ -34,6 +34,7 @@
 
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertNotNull;
+import static org.junit.Assert.assertTrue;
 import static org.junit.Assert.fail;
 
 public class ExternalTerminalTest {
@@ -137,6 +138,14 @@ public void testCursorPosition() throws IOException  {
         assertEquals('f', console.reader().read());
     }
 
+    @Test
+    public void testPaused() throws IOException {
+        ByteArrayOutputStream baos = new ByteArrayOutputStream();
+        ByteArrayInputStream bais = new ByteArrayInputStream("abcdefghijklmnopqrstuvwxyz".getBytes());
+        Terminal term = TerminalBuilder.builder().system(false).streams(bais, baos).paused(true).build();
+        assertTrue(term.paused());
+    }
+
     @Test
     public void testExceptionOnInputStream() throws IOException, InterruptedException {
         ByteArrayOutputStream baos = new ByteArrayOutputStream();

diff --git a/terminal-jansi/src/main/java/org/jline/terminal/impl/jansi/JansiSupportImpl.java b/terminal-jansi/src/main/java/org/jline/terminal/impl/jansi/JansiSupportImpl.java
@@ -94,8 +94,13 @@ else if (osName.startsWith("FreeBSD")) {
 
     @Override
     public Terminal winSysTerminal(String name, String type, boolean ansiPassThrough, Charset encoding, int codepage, boolean nativeSignals, Terminal.SignalHandler signalHandler) throws IOException {
+        return winSysTerminal(name, type, ansiPassThrough, encoding, codepage, nativeSignals, signalHandler, false);
+    }
+
+    @Override
+    public Terminal winSysTerminal(String name, String type, boolean ansiPassThrough, Charset encoding, int codepage, boolean nativeSignals, Terminal.SignalHandler signalHandler, boolean paused) throws IOException {
         if (JANSI_MAJOR_VERSION > 1 || JANSI_MAJOR_VERSION == 1 && JANSI_MINOR_VERSION >= 12) {
-            JansiWinSysTerminal terminal = new JansiWinSysTerminal(name, type, ansiPassThrough, encoding, codepage, nativeSignals, signalHandler);
+            JansiWinSysTerminal terminal = new JansiWinSysTerminal(name, type, ansiPassThrough, encoding, codepage, nativeSignals, signalHandler, paused);
             if (JANSI_MAJOR_VERSION == 1 && JANSI_MINOR_VERSION < 16) {
                 terminal.disableScrolling();
             }

diff --git a/terminal-jansi/src/main/java/org/jline/terminal/impl/jansi/win/JansiWinSysTerminal.java b/terminal-jansi/src/main/java/org/jline/terminal/impl/jansi/win/JansiWinSysTerminal.java
@@ -35,6 +35,10 @@ public JansiWinSysTerminal(String name, boolean nativeSignals) throws IOExceptio
     }
 
     public JansiWinSysTerminal(String name, String type, boolean ansiPassThrough, Charset encoding, int codepage, boolean nativeSignals, SignalHandler signalHandler) throws IOException {
+        this(name, TYPE_WINDOWS, false, null, 0, nativeSignals, signalHandler, false);
+    }
+
+    public JansiWinSysTerminal(String name, String type, boolean ansiPassThrough, Charset encoding, int codepage, boolean nativeSignals, SignalHandler signalHandler, boolean paused) throws IOException {
         super(ansiPassThrough
                         ? new JansiWinConsoleWriter()
                         : new WindowsAnsiWriter(new BufferedWriter(new JansiWinConsoleWriter())),
@@ -46,7 +50,9 @@ public JansiWinSysTerminal(String name, String type, boolean ansiPassThrough, Ch
               signalHandler);
 
         // Start input pump thread
-        resume();
+        if (!paused) {
+            resume();
+        }
     }
 
     @Override

diff --git a/terminal-jna/src/main/java/org/jline/terminal/impl/jna/JnaSupportImpl.java b/terminal-jna/src/main/java/org/jline/terminal/impl/jna/JnaSupportImpl.java
@@ -25,4 +25,9 @@ public Pty open(Attributes attributes, Size size) throws IOException {
     public Terminal winSysTerminal(String name, String type, boolean ansiPassThrough, Charset encoding, int codepage, boolean nativeSignals, Terminal.SignalHandler signalHandler) throws IOException {
         return new JnaWinSysTerminal(name, type, ansiPassThrough, encoding, codepage, nativeSignals, signalHandler);
     }
+
+    @Override
+    public Terminal winSysTerminal(String name, String type, boolean ansiPassThrough, Charset encoding, int codepage, boolean nativeSignals, Terminal.SignalHandler signalHandler, boolean paused) throws IOException {
+        return new JnaWinSysTerminal(name, type, ansiPassThrough, encoding, codepage, nativeSignals, signalHandler, paused);
+    }
 }
diff --git a/terminal-jna/src/main/java/org/jline/terminal/impl/jna/win/JnaWinSysTerminal.java b/terminal-jna/src/main/java/org/jline/terminal/impl/jna/win/JnaWinSysTerminal.java
@@ -30,14 +30,20 @@ public JnaWinSysTerminal(String name, boolean nativeSignals) throws IOException
     }
 
     public JnaWinSysTerminal(String name, String type, boolean ansiPassThrough, Charset encoding, int codepage, boolean nativeSignals, SignalHandler signalHandler) throws IOException {
+        this(name, TYPE_WINDOWS, false, null, 0, nativeSignals, signalHandler, false);
+    }
+
+    public JnaWinSysTerminal(String name, String type, boolean ansiPassThrough, Charset encoding, int codepage, boolean nativeSignals, SignalHandler signalHandler, boolean paused) throws IOException {
         super(ansiPassThrough
                         ? new JnaWinConsoleWriter(consoleOut)
                         : new WindowsAnsiWriter(new BufferedWriter(new JnaWinConsoleWriter(consoleOut)), consoleOut),
               name, type, encoding, codepage, nativeSignals, signalHandler);
         strings.put(InfoCmp.Capability.key_mouse, "\\E[M");
 
         // Start input pump thread
-        resume();
+        if (!paused) {
+            resume();
+        }
     }
 
     @Override

diff --git a/terminal/src/main/java/org/jline/terminal/TerminalBuilder.java b/terminal/src/main/java/org/jline/terminal/TerminalBuilder.java
@@ -95,6 +95,7 @@ public static TerminalBuilder builder() {
     private Size size;
     private boolean nativeSignals = false;
     private Terminal.SignalHandler signalHandler = Terminal.SignalHandler.SIG_DFL;
+    private boolean paused = false;
 
     private TerminalBuilder() {
     }
@@ -229,6 +230,20 @@ public TerminalBuilder signalHandler(Terminal.SignalHandler signalHandler) {
         return this;
     }
 
+    /**
+     * Initial paused state of the terminal (defaults to false).
+     * By default, the terminal is started, but in some cases,
+     * one might want to make sure the input stream is not consumed
+     * before needed, in which case the terminal needs to be created
+     * in a paused state.
+     * @param paused
+     * @see Terminal#pause()
+     */
+    public TerminalBuilder paused(boolean paused) {
+        this.paused = paused;
+        return this;
+    }
+
     public Terminal build() throws IOException {
         Terminal terminal = doBuild();
         Log.debug(() -> "Using terminal " + terminal.getClass().getSimpleName());
@@ -311,15 +326,15 @@ private Terminal doBuild() throws IOException {
                 }
                 if (jna) {
                     try {
-                        return load(JnaSupport.class).winSysTerminal(name, type, ansiPassThrough, encoding, codepage, nativeSignals, signalHandler);
+                        return load(JnaSupport.class).winSysTerminal(name, type, ansiPassThrough, encoding, codepage, nativeSignals, signalHandler, paused);
                     } catch (Throwable t) {
                         Log.debug("Error creating JNA based terminal: ", t.getMessage(), t);
                         exception.addSuppressed(t);
                     }
                 }
                 if (jansi) {
                     try {
-                        return load(JansiSupport.class).winSysTerminal(name, type, ansiPassThrough, encoding, codepage, nativeSignals, signalHandler);
+                        return load(JansiSupport.class).winSysTerminal(name, type, ansiPassThrough, encoding, codepage, nativeSignals, signalHandler, paused);
                     } catch (Throwable t) {
                         Log.debug("Error creating JANSI based terminal: ", t.getMessage(), t);
                         exception.addSuppressed(t);
@@ -386,20 +401,20 @@ private Terminal doBuild() throws IOException {
             if (jna) {
                 try {
                     Pty pty = load(JnaSupport.class).open(attributes, size);
-                    return new PosixPtyTerminal(name, type, pty, in, out, encoding, signalHandler);
+                    return new PosixPtyTerminal(name, type, pty, in, out, encoding, signalHandler, paused);
                 } catch (Throwable t) {
                     Log.debug("Error creating JNA based terminal: ", t.getMessage(), t);
                 }
             }
             if (jansi) {
                 try {
                     Pty pty = load(JansiSupport.class).open(attributes, size);
-                    return new PosixPtyTerminal(name, type, pty, in, out, encoding, signalHandler);
+                    return new PosixPtyTerminal(name, type, pty, in, out, encoding, signalHandler, paused);
                 } catch (Throwable t) {
                     Log.debug("Error creating JANSI based terminal: ", t.getMessage(), t);
                 }
             }
-            Terminal terminal = new ExternalTerminal(name, type, in, out, encoding, signalHandler);
+            Terminal terminal = new ExternalTerminal(name, type, in, out, encoding, signalHandler, paused);
             if (attributes != null) {
                 terminal.setAttributes(attributes);
             }

diff --git a/terminal/src/main/java/org/jline/terminal/impl/ExternalTerminal.java b/terminal/src/main/java/org/jline/terminal/impl/ExternalTerminal.java
@@ -48,9 +48,20 @@ public ExternalTerminal(String name, String type,
                             OutputStream masterOutput,
                             Charset encoding,
                             SignalHandler signalHandler) throws IOException {
+        this(name, type, masterInput, masterOutput, encoding, signalHandler, false);
+    }
+
+    public ExternalTerminal(String name, String type,
+                            InputStream masterInput,
+                            OutputStream masterOutput,
+                            Charset encoding,
+                            SignalHandler signalHandler,
+                            boolean paused) throws IOException {
         super(name, type, masterOutput, encoding, signalHandler);
         this.masterInput = masterInput;
-        resume();
+        if (!paused) {
+            resume();
+        }
     }
 
     public void close() throws IOException {

diff --git a/terminal/src/main/java/org/jline/terminal/impl/PosixPtyTerminal.java b/terminal/src/main/java/org/jline/terminal/impl/PosixPtyTerminal.java
@@ -44,6 +44,10 @@ public PosixPtyTerminal(String name, String type, Pty pty, InputStream in, Outpu
     }
 
     public PosixPtyTerminal(String name, String type, Pty pty, InputStream in, OutputStream out, Charset encoding, SignalHandler signalHandler) throws IOException {
+        this(name, type, pty, in, out, encoding, signalHandler, false);
+    }
+
+    public PosixPtyTerminal(String name, String type, Pty pty, InputStream in, OutputStream out, Charset encoding, SignalHandler signalHandler, boolean paused) throws IOException {
         super(name, type, pty, encoding, signalHandler);
         this.in = Objects.requireNonNull(in);
         this.out = Objects.requireNonNull(out);
@@ -54,7 +58,9 @@ public PosixPtyTerminal(String name, String type, Pty pty, InputStream in, Outpu
         this.reader = NonBlocking.nonBlocking(name, input, encoding());
         this.writer = new PrintWriter(new OutputStreamWriter(output, encoding()));
         parseInfoCmp();
-        resume();
+        if (!paused) {
+            resume();
+        }
     }
 
     public InputStream input() {

diff --git a/terminal/src/main/java/org/jline/terminal/spi/JansiSupport.java b/terminal/src/main/java/org/jline/terminal/spi/JansiSupport.java
@@ -15,4 +15,6 @@ public interface JansiSupport {
 
     Terminal winSysTerminal(String name, String type, boolean ansiPassThrough, Charset encoding, int codepage, boolean nativeSignals, Terminal.SignalHandler signalHandler) throws IOException;
 
+    Terminal winSysTerminal(String name, String type, boolean ansiPassThrough, Charset encoding, int codepage, boolean nativeSignals, Terminal.SignalHandler signalHandler, boolean paused) throws IOException;
+
 }
diff --git a/terminal/src/main/java/org/jline/terminal/spi/JnaSupport.java b/terminal/src/main/java/org/jline/terminal/spi/JnaSupport.java
@@ -15,4 +15,6 @@ public interface JnaSupport {
 
     Terminal winSysTerminal(String name, String type, boolean ansiPassThrough, Charset encoding, int codepage, boolean nativeSignals, Terminal.SignalHandler signalHandler) throws IOException;
 
+    Terminal winSysTerminal(String name, String type, boolean ansiPassThrough, Charset encoding, int codepage, boolean nativeSignals, Terminal.SignalHandler signalHandler, boolean paused) throws IOException;
+
 }