Fix up naming, the input/output pipes are always confusing...

bryphe-coder · bryphe-coder · commit e23745e189a8 · 2022-02-12T03:26:45.000Z
diff --git a/expect/conpty/conpty.go b/expect/conpty/conpty.go
@@ -1,3 +1,4 @@
+//go:build windows
 // +build windows
 
 // Original copyright 2020 ActiveState Software. All rights reserved.
@@ -16,17 +17,17 @@ import (
 
 // ConPty represents a windows pseudo console.
 type ConPty struct {
-	hpCon       windows.Handle
-	pipeFdIn    windows.Handle
-	pipeFdOut   windows.Handle
-	pipe3 windows.Handle
-	pipe4 windows.Handle
-	consoleSize uintptr
-	outputR      *os.File
-	outputW     *os.File
-	inputR      *os.File
-	inputW     *os.File
-	closed     bool
+	hpCon                    windows.Handle
+	outPipePseudoConsoleSide windows.Handle
+	outPipeOurSide           windows.Handle
+	inPipeOurSide            windows.Handle
+	inPipePseudoConsoleSide  windows.Handle
+	consoleSize              uintptr
+	outFilePseudoConsoleSide *os.File
+	outFileOurSide           *os.File
+	inFilePseudoConsoleSide  *os.File
+	inFileOurSide            *os.File
+	closed                   bool
 }
 
 // New returns a new ConPty pseudo terminal device
@@ -40,67 +41,62 @@ func New(columns int16, rows int16) (*ConPty, error) {
 
 // Close closes the pseudo-terminal and cleans up all attached resources
 func (c *ConPty) Close() error {
-	if (c.closed) {
+	// Trying to close these pipes multiple times will result in an
+	// access violation
+	if c.closed {
 		return nil
 	}
 
 	err := closePseudoConsole(c.hpCon)
-	c.outputR.Close()
-	c.outputW.Close()
-	c.inputR.Close()
-	c.inputW.Close()
+	c.outFilePseudoConsoleSide.Close()
+	c.outFileOurSide.Close()
+	c.inFilePseudoConsoleSide.Close()
+	c.inFileOurSide.Close()
 	c.closed = true
 	return err
 }
 
 // OutPipe returns the output pipe of the pseudo terminal
 func (c *ConPty) OutPipe() *os.File {
-	return c.outputR
+	return c.outFilePseudoConsoleSide
 }
 
 func (c *ConPty) Reader() io.Reader {
-	return c.outputW
+	return c.outFileOurSide
 }
 
 // InPipe returns input pipe of the pseudo terminal
 // Note: It is safer to use the Write method to prevent partially-written VT sequences
 // from corrupting the terminal
 func (c *ConPty) InPipe() *os.File {
-	return c.inputR
+	return c.inFilePseudoConsoleSide
 }
 
 func (c *ConPty) WriteString(str string) (int, error) {
-	return c.inputW.WriteString(str)
+	return c.inFileOurSide.WriteString(str)
 }
 
 func (c *ConPty) createPseudoConsoleAndPipes() error {
-	// These are the readers/writers for "stdin", but we only need this to
-	// successfully call CreatePseudoConsole. After, we can throw it away.
-	var hPipeInW, hPipeInR windows.Handle
-
 	// Create the stdin pipe
-	if err := windows.CreatePipe(&hPipeInR, &hPipeInW, nil, 0); err != nil {
+	if err := windows.CreatePipe(&c.inPipePseudoConsoleSide, &c.inPipeOurSide, nil, 0); err != nil {
 		return err
 	}
 
 	// Create the stdout pipe
-	if err := windows.CreatePipe(&c.pipeFdOut, &c.pipeFdIn, nil, 0); err != nil {
+	if err := windows.CreatePipe(&c.outPipeOurSide, &c.outPipePseudoConsoleSide, nil, 0); err != nil {
 		return err
 	}
 
 	// Create the pty with our stdin/stdout
-	if err := createPseudoConsole(c.consoleSize, hPipeInR, c.pipeFdIn, &c.hpCon); err != nil {
+	if err := createPseudoConsole(c.consoleSize, c.inPipePseudoConsoleSide, c.outPipePseudoConsoleSide, &c.hpCon); err != nil {
 		return fmt.Errorf("failed to create pseudo console: %d, %v", uintptr(c.hpCon), err)
 	}
 
-	c.pipe3 = hPipeInR
-	c.pipe4 = hPipeInW
-
-	c.outputR = os.NewFile(uintptr(c.pipeFdIn), "|0")
-	c.outputW = os.NewFile(uintptr(c.pipeFdOut), "|1")
+	c.outFilePseudoConsoleSide = os.NewFile(uintptr(c.outPipePseudoConsoleSide), "|0")
+	c.outFileOurSide = os.NewFile(uintptr(c.outPipeOurSide), "|1")
 
-	c.inputR = os.NewFile(uintptr(c.pipe3), "|2")
-	c.inputW = os.NewFile(uintptr(c.pipe4), "|3")
+	c.inFilePseudoConsoleSide = os.NewFile(uintptr(c.inPipePseudoConsoleSide), "|2")
+	c.inFileOurSide = os.NewFile(uintptr(c.inPipeOurSide), "|3")
 	c.closed = false
 
 	return nil
diff --git a/expect/conpty/syscall.go b/expect/conpty/syscall.go
@@ -1,3 +1,4 @@
+//go:build windows
 // +build windows
 
 // Copyright 2020 ActiveState Software. All rights reserved.

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+//go:build windows`
`1`	`2`	`// +build windows`
`2`	`3`
`3`	`4`	`// Copyright 2020 ActiveState Software. All rights reserved.`