Add support for non-process-based terminals

README.adoc

@@ -5,7 +5,7 @@ Rahman Usta
 :lang: en
 :toc: left
 :numbered:
-:terminalfx-version: 1.0.9
+:terminalfx-version: 1.1.0
 
 == JavaFX Terminal Emulator
 
@@ -21,14 +21,15 @@ We use https://github.com/traff/pty4j[Pty4J] to get VT codes from running proces
 * CygWin Support
 * Configurable (Color, Size, Font)
 * Multi Tab Support
+* Support for non-process based terminals
 
 == Usage
 
 .Default Config
 [source,java]
 ----
 TerminalBuilder terminalBuilder = new TerminalBuilder();
-TerminalTab terminal = terminalBuilder.newTerminal();
+TerminalTab<ExternalProcessPty> terminal = terminalBuilder.newTerminal();
 
 TabPane tabPane = new TabPane();
 tabPane.getTabs().add(terminal);    
@@ -45,14 +46,25 @@ darkConfig.setForegroundColor(Color.rgb(240, 240, 240));
 darkConfig.setCursorColor(Color.rgb(255, 0, 0, 0.5));
 
 TerminalBuilder terminalBuilder = new TerminalBuilder(darkConfig);
-TerminalTab terminal = terminalBuilder.newTerminal();
+TerminalTab<ExternalProcessPty> terminal = terminalBuilder.newTerminal();
 
 TabPane tabPane = new TabPane();
 tabPane.getTabs().add(terminal);
 ----
 
 image::images\dark.png[]
 
+.Using a non-Process Terminal
+[source,java]
+----
+FileCapturePty  filecap = new FileCapturePty(new File("log.in"), new File("README.adoc"), new File("LICENSE"));
+GenericTerminal<FileCapturePty> view = new GenericTerminal<FileCapturePty>(darkConfig, filecap);
+TerminalTab<FileCapturePty> terminal = new TerminalTab<>(view, new DefaultTabNameGenerator());
+
+TabPane tabPane = new TabPane();
+tabPane.getTabs().add(terminal);
+----
+
 == CygWin Support
 
 [source,java]
@@ -61,7 +73,7 @@ TerminalConfig cygwinConfig = new TerminalConfig();
 cygwinConfig.setWindowsTerminalStarter("C:\\cygwin64\\bin\\bash -i"); <1>
 
 TerminalBuilder terminalBuilder = new TerminalBuilder(cygwinConfig);
-TerminalTab terminal = terminalBuilder.newTerminal();
+TerminalTab<ExternalProcessPty> terminal = terminalBuilder.newTerminal();
 
 TabPane tabPane = new TabPane();
 tabPane.getTabs().add(terminal);  

pom.xml

@@ -5,7 +5,7 @@
 
     <groupId>com.kodedu.terminalfx</groupId>
     <artifactId>terminalfx</artifactId>
-    <version>1.0.9</version>
+    <version>1.1.0</version>
     <packaging>jar</packaging>
 
     <name>TerminalFX</name>

src/main/java/com/kodedu/terminalfx/GenericTerminal.java

@@ -0,0 +1,108 @@
+package com.kodedu.terminalfx;
+
+import java.io.BufferedReader;
+import java.io.BufferedWriter;
+import java.io.IOException;
+import java.io.InputStreamReader;
+import java.io.OutputStreamWriter;
+import java.io.Writer;
+import java.util.concurrent.LinkedBlockingQueue;
+
+import com.kodedu.terminalfx.annotation.WebkitCall;
+import com.kodedu.terminalfx.config.TerminalConfig;
+import com.kodedu.terminalfx.helper.ThreadHelper;
+import com.kodedu.terminalfx.processes.Pty;
+
+import javafx.beans.property.ObjectProperty;
+import javafx.beans.property.SimpleObjectProperty;
+
+public class GenericTerminal<T extends Pty> extends TerminalView {
+
+	private T process;
+	private final ObjectProperty<Writer> outputWriterProperty;
+	private final LinkedBlockingQueue<String> commandQueue;
+
+	public GenericTerminal() {
+		this(null, null);
+	}
+
+	public GenericTerminal(TerminalConfig terminalConfig, T virtualProcess) {
+		setTerminalConfig(terminalConfig);
+		this.process = virtualProcess;
+		outputWriterProperty = new SimpleObjectProperty<>();
+		commandQueue = new LinkedBlockingQueue<>();
+	}
+
+	@WebkitCall
+	public void command(String command) {
+		try {
+			commandQueue.put(command);
+		} catch (final InterruptedException e) {
+			throw new RuntimeException(e);
+		}
+		ThreadHelper.start(() -> {
+			try {
+				final String commandToExecute = commandQueue.poll();
+				getOutputWriter().write(commandToExecute);
+				getOutputWriter().flush();
+			} catch (final IOException e) {
+				e.printStackTrace();
+			}
+		});
+	}
+
+	@Override
+	public void onTerminalReady() {
+		ThreadHelper.start(() -> {
+			try {
+				initializeProcess();
+			} catch (final Exception e) {
+			}
+		});
+	}
+
+	private void initializeProcess() throws Exception {
+		process.fork();
+
+		columnsProperty().addListener(evt -> updateWinSize());
+		rowsProperty().addListener(evt -> updateWinSize());
+		updateWinSize();
+		setInputReader(new BufferedReader(new InputStreamReader(process.getInputStream())));
+		setErrorReader(new BufferedReader(new InputStreamReader(process.getErrorStream())));
+		setOutputWriter(new BufferedWriter(new OutputStreamWriter(process.getOutputStream())));
+		focusCursor();
+
+		countDownLatch.countDown();
+
+		process.waitFor();
+	}
+
+	private void updateWinSize() {
+		try {
+			process.setWinSize(getColumns(), getRows());
+		} catch (Exception e) {
+			//
+		}
+	}
+
+	public ObjectProperty<Writer> outputWriterProperty() {
+		return outputWriterProperty;
+	}
+
+	public Writer getOutputWriter() {
+		return outputWriterProperty.get();
+	}
+
+	public void setOutputWriter(Writer writer) {
+		outputWriterProperty.set(writer);
+	}
+
+	public T getPty() {
+		return process;
+	}
+
+	public void destroy() {
+		getPty().close();
+	}
+
+}

src/main/java/com/kodedu/terminalfx/Terminal.java

@@ -1,143 +1,27 @@
 package com.kodedu.terminalfx;
 
-import java.io.BufferedReader;
-import java.io.BufferedWriter;
-import java.io.IOException;
-import java.io.InputStreamReader;
-import java.io.OutputStreamWriter;
-import java.io.Writer;
-import java.nio.file.Files;
 import java.nio.file.Path;
-import java.nio.file.Paths;
-import java.util.HashMap;
-import java.util.Map;
-import java.util.Objects;
-import java.util.concurrent.LinkedBlockingQueue;
 
-import com.kodedu.terminalfx.annotation.WebkitCall;
 import com.kodedu.terminalfx.config.TerminalConfig;
-import com.kodedu.terminalfx.helper.IOHelper;
-import com.kodedu.terminalfx.helper.ThreadHelper;
+import com.kodedu.terminalfx.processes.ExternalProcessPty;
 import com.pty4j.PtyProcess;
-import com.pty4j.WinSize;
-import com.sun.jna.Platform;
 
-import javafx.beans.property.ObjectProperty;
-import javafx.beans.property.SimpleObjectProperty;
-
-public class Terminal extends TerminalView {
-
-    private PtyProcess process;
-    private final ObjectProperty<Writer> outputWriterProperty;
-    private final Path terminalPath;
-    private String[] termCommand;
-    private final LinkedBlockingQueue<String> commandQueue;
+public class Terminal extends GenericTerminal<ExternalProcessPty> {
 
     public Terminal() {
         this(null, null);
     }
 
     public Terminal(TerminalConfig terminalConfig, Path terminalPath) {
-        setTerminalConfig(terminalConfig);
-        this.terminalPath = terminalPath;
-        outputWriterProperty = new SimpleObjectProperty<>();
-        commandQueue = new LinkedBlockingQueue<>();
-    }
-
-    @WebkitCall
-    public void command(String command) {
-        try {
-            commandQueue.put(command);
-        } catch (final InterruptedException e) {
-            throw new RuntimeException(e);
-        }
-        ThreadHelper.start(() -> {
-            try {
-                final String commandToExecute = commandQueue.poll();
-                getOutputWriter().write(commandToExecute);
-                getOutputWriter().flush();
-            } catch (final IOException e) {
-                e.printStackTrace();
-            }
-        });
-    }
-
-    @Override
-    public void onTerminalReady() {
-        ThreadHelper.start(() -> {
-            try {
-                initializeProcess();
-            } catch (final Exception e) {
-            }
-        });
-    }
-
-    private void initializeProcess() throws Exception {
-        final Path dataDir = getDataDir();
-        IOHelper.copyLibPty(dataDir);
-
-        if (Platform.isWindows()) {
-            this.termCommand = getTerminalConfig().getWindowsTerminalStarter().split("\\s+");
-        } else {
-            this.termCommand = getTerminalConfig().getUnixTerminalStarter().split("\\s+");
-        }
-
-        final Map<String, String> envs = new HashMap<>(System.getenv());
-        envs.put("TERM", "xterm");
-
-        System.setProperty("PTY_LIB_FOLDER", dataDir.resolve("libpty").toString());
-
-        if (Objects.nonNull(terminalPath) && Files.exists(terminalPath)) {
-            this.process = PtyProcess.exec(termCommand, envs, terminalPath.toString());
-        } else {
-            this.process = PtyProcess.exec(termCommand, envs);
-        }
-
-        columnsProperty().addListener(evt -> updateWinSize());
-        rowsProperty().addListener(evt -> updateWinSize());
-        updateWinSize();
-        setInputReader(new BufferedReader(new InputStreamReader(process.getInputStream())));
-        setErrorReader(new BufferedReader(new InputStreamReader(process.getErrorStream())));
-        setOutputWriter(new BufferedWriter(new OutputStreamWriter(process.getOutputStream())));
-        focusCursor();
-
-        countDownLatch.countDown();
-
-        process.waitFor();
-    }
-
-    private Path getDataDir() {
-        final String userHome = System.getProperty("user.home");
-        final Path dataDir = Paths.get(userHome).resolve(".terminalfx");
-        return dataDir;
+        super(terminalConfig, new ExternalProcessPty(terminalPath));
+        getPty().setTerminalConfig(getTerminalConfig());
     }
 
     public Path getTerminalPath() {
-        return terminalPath;
-    }
-
-    private void updateWinSize() {
-        try {
-            process.setWinSize(new WinSize(getColumns(), getRows()));
-        } catch (Exception e) {
-            //
-        }
-    }
-
-    public ObjectProperty<Writer> outputWriterProperty() {
-        return outputWriterProperty;
-    }
-
-    public Writer getOutputWriter() {
-        return outputWriterProperty.get();
-    }
-
-    public void setOutputWriter(Writer writer) {
-        outputWriterProperty.set(writer);
+        return getPty().getTerminalPath();
     }
 
     public PtyProcess getProcess() {
-        return process;
+        return getPty().getProcess();
     }
-
 }

src/main/java/com/kodedu/terminalfx/TerminalAppStarter.java

@@ -1,13 +1,14 @@
 package com.kodedu.terminalfx;
 
+import java.io.InputStream;
+
 import javafx.application.Application;
 import javafx.application.Platform;
 import javafx.fxml.FXMLLoader;
 import javafx.scene.Parent;
 import javafx.scene.Scene;
 import javafx.stage.Stage;
 
-import java.io.InputStream;
 
 
 public class TerminalAppStarter extends Application {

src/main/java/com/kodedu/terminalfx/TerminalBuilder.java

@@ -2,6 +2,7 @@
 
 import com.kodedu.terminalfx.config.DefaultTabNameGenerator;
 import com.kodedu.terminalfx.config.TerminalConfig;
+import com.kodedu.terminalfx.processes.ExternalProcessPty;
 import com.kodedu.terminalfx.config.TabNameGenerator;
 
 import java.nio.file.Path;
@@ -53,8 +54,8 @@ public void setTerminalPath(Path terminalPath) {
         this.terminalPath = terminalPath;
     }
 
-    public TerminalTab newTerminal() {
-        TerminalTab terminalTab = new TerminalTab(getTerminalConfig(), getNameGenerator(), getTerminalPath());
+    public TerminalTab<ExternalProcessPty> newTerminal() {
+        TerminalTab<ExternalProcessPty> terminalTab = new TerminalTab<>(() -> new Terminal(getTerminalConfig(), getTerminalPath()), getNameGenerator());
         return terminalTab;
     }
 }

src/main/java/com/kodedu/terminalfx/TerminalGenerator.java

@@ -0,0 +1,9 @@
+package com.kodedu.terminalfx;
+
+import com.kodedu.terminalfx.processes.Pty;
+
+@FunctionalInterface
+public interface TerminalGenerator<T extends Pty> {
+
+	GenericTerminal<T> generate();
+}