Merge pull request #73 from schnoddelbotz/master

RFE: Expose exit code from Terminal's shell #72

Author: andydotxyz

README.md

@@ -45,29 +45,29 @@ Already planned is:
 * Scroll-back
 * Background and font/size customisation
 * Split panels
-* Windows support
 
 # Library
 
 You can also use this project as a library to create your own
 terminal based applications, using the import path "github.com/fyne-io/terminal".
 
-There are two modes, using the default shell (macOS and Linux) or connecting
-to a remote shell.
+There are two modes, using the default shell or connecting to a remote shell.
 
 ## Local Shell
 
-To load a terminal widget and launch the current shell (works on macOS and Linux)
-use the `RunLocalShell` method after creating a `Terminal`, as follows:
+To load a terminal widget and launch the current shell (works on macOS and Linux;
+on Windows, it always uses PowerShell) use the `RunLocalShell` method after creating
+a `Terminal`, as follows:
 
 ```go
 	// run new terminal and close app on terminal exit.
 	t := terminal.New()
 	go func() {
 		_ = t.RunLocalShell()
+		log.Printf("Terminal's shell exited with exit code: %d", t.ExitCode())
 		a.Quit()
 	}()
-	
+
 	// w is a fyne.Window created to hold the content
 	w.SetContent(t)
 	w.ShowAndRun()
@@ -82,7 +82,7 @@ For example to open a terminal to an SSH connection that you have created:
 	in, _ := session.StdinPipe()
 	out, _ := session.StdoutPipe()
 	go session.Run("$SHELL || bash")
-	
+
 	// run new terminal and close app on terminal exit.
 	t := terminal.New()
 	go func() {

term.go

@@ -5,6 +5,7 @@ import (
 	"io"
 	"math"
 	"os"
+	"os/exec"
 	"runtime"
 	"sync"
 	"time"
@@ -82,6 +83,7 @@ type Terminal struct {
 
 	printData []byte
 	printer   Printer
+	cmd       *exec.Cmd
 }
 
 // Printer is used for spooling print data when its received.
@@ -216,6 +218,16 @@ func (t *Terminal) Text() string {
 	return t.content.Text()
 }
 
+// ExitCode returns the exit code from the terminal's shell.
+// Returns -1 if called before shell was started or before shell exited.
+// Also returns -1 if shell was terminated by a signal.
+func (t *Terminal) ExitCode() int {
+	if t.cmd == nil {
+		return -1
+	}
+	return t.cmd.ProcessState.ExitCode()
+}
+
 // TouchCancel handles the tap action for mobile apps that lose focus during tap.
 func (t *Terminal) TouchCancel(ev *mobile.TouchEvent) {
 	if t.onMouseUp != nil {
@@ -294,6 +306,8 @@ func (t *Terminal) run() {
 	for {
 		num, err := t.out.Read(buf)
 		if err != nil {
+			// wait for cmd (shell) to exit, populates ProcessState.ExitCode
+			t.cmd.Wait()
 			// this is the pre-go 1.13 way to check for the read failing (terminal closed)
 			if err.Error() == "EOF" {
 				break // term exit on macOS

term_test.go

@@ -16,6 +16,11 @@ func TestNewTerminal(t *testing.T) {
 	assert.NotNil(t, term.content)
 }
 
+func TestExitCode(t *testing.T) {
+	term := New()
+	assert.Equal(t, term.ExitCode(), int(-1))
+}
+
 func TestTerminal_Resize(t *testing.T) {
 	term := New()
 	term.Resize(fyne.NewSize(45, 45))

term_unix.go

@@ -37,6 +37,7 @@ func (t *Terminal) startPTY() (io.WriteCloser, io.Reader, io.Closer, error) {
 	env = append(env, "TERM=xterm-256color")
 	c := exec.Command(shell)
 	c.Env = env
+	t.cmd = c
 
 	// Start the command with a pty.
 	f, err := pty.Start(c)

term_windows.go

@@ -4,6 +4,7 @@ import (
 	"io"
 	"log"
 	"os"
+	"os/exec"
 	"syscall"
 
 	"github.com/ActiveState/termtest/conpty"
@@ -33,15 +34,17 @@ func (t *Terminal) startPTY() (io.WriteCloser, io.Reader, io.Closer, error) {
 		return nil, nil, nil, err
 	}
 
+	t.cmd = &exec.Cmd{}
 	process, err := os.FindProcess(pid)
 	if err != nil {
 		return nil, nil, nil, err
 	}
 	go func() {
-		_, err := process.Wait()
+		ps, err := process.Wait()
 		if err != nil {
 			log.Fatalf("Error waiting for process: %v", err)
 		}
+		t.cmd.ProcessState = ps
 		if t.pty != nil {
 			t.pty = nil
 			_ = cpty.Close()