Skip to content

Commit 9290d21

Browse files
crosbymichaelcrosbymichael
authored
Merge pull request #25 from mat007/support-read-write-windows
Support read write windows
2 parents cb7008a + a7ba593 commit 9290d21

File tree

2 files changed

+44
-80
lines changed

2 files changed

+44
-80
lines changed

‎console_linux.go

+8-8
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ func NewEpoller() (*Epoller, error) {
7272
}, nil
7373
}
7474

75-
// Add creates a epoll console based on the provided console. The console will
75+
// Add creates an epoll console based on the provided console. The console will
7676
// be registered with EPOLLET (i.e. using edge-triggered notification) and its
7777
// file descriptor will be set to non-blocking mode. After this, user should use
7878
// the return console to perform I/O.
@@ -134,7 +134,7 @@ func (e *Epoller) Wait() error {
134134
}
135135
}
136136

137-
// Close unregister the console's file descriptor from epoll interface
137+
// CloseConsole unregisters the console's file descriptor from epoll interface
138138
func (e *Epoller) CloseConsole(fd int) error {
139139
e.mu.Lock()
140140
defer e.mu.Unlock()
@@ -149,12 +149,12 @@ func (e *Epoller) getConsole(sysfd int) *EpollConsole {
149149
return f
150150
}
151151

152-
// Close the epoll fd
152+
// Close closes the epoll fd
153153
func (e *Epoller) Close() error {
154154
return unix.Close(e.efd)
155155
}
156156

157-
// EpollConsole acts like a console but register its file descriptor with a
157+
// EpollConsole acts like a console but registers its file descriptor with an
158158
// epoll fd and uses epoll API to perform I/O.
159159
type EpollConsole struct {
160160
Console
@@ -167,7 +167,7 @@ type EpollConsole struct {
167167
// Read reads up to len(p) bytes into p. It returns the number of bytes read
168168
// (0 <= n <= len(p)) and any error encountered.
169169
//
170-
// If the console's read returns EAGAIN or EIO, we assumes that its a
170+
// If the console's read returns EAGAIN or EIO, we assume that it's a
171171
// temporary error because the other side went away and wait for the signal
172172
// generated by epoll event to continue.
173173
func (ec *EpollConsole) Read(p []byte) (n int, err error) {
@@ -207,7 +207,7 @@ func (ec *EpollConsole) Read(p []byte) (n int, err error) {
207207
// written from p (0 <= n <= len(p)) and any error encountered that caused
208208
// the write to stop early.
209209
//
210-
// If writes to the console returns EAGAIN or EIO, we assumes that its a
210+
// If writes to the console returns EAGAIN or EIO, we assume that it's a
211211
// temporary error because the other side went away and wait for the signal
212212
// generated by epoll event to continue.
213213
func (ec *EpollConsole) Write(p []byte) (n int, err error) {
@@ -224,7 +224,7 @@ func (ec *EpollConsole) Write(p []byte) (n int, err error) {
224224
} else {
225225
hangup = (err == unix.EAGAIN || err == unix.EIO)
226226
}
227-
// if the other end disappear, assume this is temporary and wait for the
227+
// if the other end disappears, assume this is temporary and wait for the
228228
// signal to continue again.
229229
if hangup {
230230
ec.writec.Wait()
@@ -242,7 +242,7 @@ func (ec *EpollConsole) Write(p []byte) (n int, err error) {
242242
return n, err
243243
}
244244

245-
// Close closed the file descriptor and signal call waiters for this fd.
245+
// Shutdown closes the file descriptor and signals call waiters for this fd.
246246
// It accepts a callback which will be called with the console's fd. The
247247
// callback typically will be used to do further cleanup such as unregister the
248248
// console's fd from the epoll interface.

‎console_windows.go

+36-72
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@
1717
package console
1818

1919
import (
20-
"fmt"
2120
"os"
2221

2322
"github.com/pkg/errors"
@@ -29,90 +28,55 @@ var (
2928
ErrNotImplemented = errors.New("not implemented")
3029
)
3130

32-
func (m *master) initStdios() {
33-
m.in = windows.Handle(os.Stdin.Fd())
34-
if err := windows.GetConsoleMode(m.in, &m.inMode); err == nil {
35-
// Validate that windows.ENABLE_VIRTUAL_TERMINAL_INPUT is supported, but do not set it.
36-
if err = windows.SetConsoleMode(m.in, m.inMode|windows.ENABLE_VIRTUAL_TERMINAL_INPUT); err == nil {
37-
vtInputSupported = true
38-
}
39-
// Unconditionally set the console mode back even on failure because SetConsoleMode
40-
// remembers invalid bits on input handles.
41-
windows.SetConsoleMode(m.in, m.inMode)
42-
} else {
43-
fmt.Printf("failed to get console mode for stdin: %v\n", err)
44-
}
45-
46-
m.out = windows.Handle(os.Stdout.Fd())
47-
if err := windows.GetConsoleMode(m.out, &m.outMode); err == nil {
48-
if err := windows.SetConsoleMode(m.out, m.outMode|windows.ENABLE_VIRTUAL_TERMINAL_PROCESSING); err == nil {
49-
m.outMode |= windows.ENABLE_VIRTUAL_TERMINAL_PROCESSING
31+
func (m *master) init() {
32+
m.h = windows.Handle(m.f.Fd())
33+
if err := windows.GetConsoleMode(m.h, &m.mode); err == nil {
34+
if m.f == os.Stdin {
35+
// Validate that windows.ENABLE_VIRTUAL_TERMINAL_INPUT is supported, but do not set it.
36+
if err = windows.SetConsoleMode(m.h, m.mode|windows.ENABLE_VIRTUAL_TERMINAL_INPUT); err == nil {
37+
vtInputSupported = true
38+
}
39+
// Unconditionally set the console mode back even on failure because SetConsoleMode
40+
// remembers invalid bits on input handles.
41+
windows.SetConsoleMode(m.h, m.mode)
42+
} else if err := windows.SetConsoleMode(m.h, m.mode|windows.ENABLE_VIRTUAL_TERMINAL_PROCESSING); err == nil {
43+
m.mode |= windows.ENABLE_VIRTUAL_TERMINAL_PROCESSING
5044
} else {
51-
windows.SetConsoleMode(m.out, m.outMode)
45+
windows.SetConsoleMode(m.h, m.mode)
5246
}
53-
} else {
54-
fmt.Printf("failed to get console mode for stdout: %v\n", err)
55-
}
56-
57-
m.err = windows.Handle(os.Stderr.Fd())
58-
if err := windows.GetConsoleMode(m.err, &m.errMode); err == nil {
59-
if err := windows.SetConsoleMode(m.err, m.errMode|windows.ENABLE_VIRTUAL_TERMINAL_PROCESSING); err == nil {
60-
m.errMode |= windows.ENABLE_VIRTUAL_TERMINAL_PROCESSING
61-
} else {
62-
windows.SetConsoleMode(m.err, m.errMode)
63-
}
64-
} else {
65-
fmt.Printf("failed to get console mode for stderr: %v\n", err)
6647
}
6748
}
6849

6950
type master struct {
70-
in windows.Handle
71-
inMode uint32
72-
73-
out windows.Handle
74-
outMode uint32
75-
76-
err windows.Handle
77-
errMode uint32
51+
h windows.Handle
52+
mode uint32
53+
f *os.File
7854
}
7955

8056
func (m *master) SetRaw() error {
81-
if err := makeInputRaw(m.in, m.inMode); err != nil {
82-
return err
57+
if m.f == os.Stdin {
58+
if err := makeInputRaw(m.h, m.mode); err != nil {
59+
return err
60+
}
61+
} else {
62+
// Set StdOut and StdErr to raw mode, we ignore failures since
63+
// windows.DISABLE_NEWLINE_AUTO_RETURN might not be supported on this version of
64+
// Windows.
65+
windows.SetConsoleMode(m.h, m.mode|windows.DISABLE_NEWLINE_AUTO_RETURN)
8366
}
84-
85-
// Set StdOut and StdErr to raw mode, we ignore failures since
86-
// windows.DISABLE_NEWLINE_AUTO_RETURN might not be supported on this version of
87-
// Windows.
88-
89-
windows.SetConsoleMode(m.out, m.outMode|windows.DISABLE_NEWLINE_AUTO_RETURN)
90-
91-
windows.SetConsoleMode(m.err, m.errMode|windows.DISABLE_NEWLINE_AUTO_RETURN)
92-
9367
return nil
9468
}
9569

9670
func (m *master) Reset() error {
97-
for _, s := range []struct {
98-
fd windows.Handle
99-
mode uint32
100-
}{
101-
{m.in, m.inMode},
102-
{m.out, m.outMode},
103-
{m.err, m.errMode},
104-
} {
105-
if err := windows.SetConsoleMode(s.fd, s.mode); err != nil {
106-
return errors.Wrap(err, "unable to restore console mode")
107-
}
71+
if err := windows.SetConsoleMode(m.h, m.mode); err != nil {
72+
return errors.Wrap(err, "unable to restore console mode")
10873
}
109-
11074
return nil
11175
}
11276

11377
func (m *master) Size() (WinSize, error) {
11478
var info windows.ConsoleScreenBufferInfo
115-
err := windows.GetConsoleScreenBufferInfo(m.out, &info)
79+
err := windows.GetConsoleScreenBufferInfo(m.h, &info)
11680
if err != nil {
11781
return WinSize{}, errors.Wrap(err, "unable to get console info")
11882
}
@@ -134,11 +98,11 @@ func (m *master) ResizeFrom(c Console) error {
13498
}
13599

136100
func (m *master) DisableEcho() error {
137-
mode := m.inMode &^ windows.ENABLE_ECHO_INPUT
101+
mode := m.mode &^ windows.ENABLE_ECHO_INPUT
138102
mode |= windows.ENABLE_PROCESSED_INPUT
139103
mode |= windows.ENABLE_LINE_INPUT
140104

141-
if err := windows.SetConsoleMode(m.in, mode); err != nil {
105+
if err := windows.SetConsoleMode(m.h, mode); err != nil {
142106
return errors.Wrap(err, "unable to set console to disable echo")
143107
}
144108

@@ -150,15 +114,15 @@ func (m *master) Close() error {
150114
}
151115

152116
func (m *master) Read(b []byte) (int, error) {
153-
panic("not implemented on windows")
117+
return m.f.Read(b)
154118
}
155119

156120
func (m *master) Write(b []byte) (int, error) {
157-
panic("not implemented on windows")
121+
return m.f.Write(b)
158122
}
159123

160124
func (m *master) Fd() uintptr {
161-
return uintptr(m.in)
125+
return uintptr(m.h)
162126
}
163127

164128
// on windows, console can only be made from os.Std{in,out,err}, hence there
@@ -210,7 +174,7 @@ func newMaster(f *os.File) (Console, error) {
210174
if f != os.Stdin && f != os.Stdout && f != os.Stderr {
211175
return nil, errors.New("creating a console from a file is not supported on windows")
212176
}
213-
m := &master{}
214-
m.initStdios()
177+
m := &master{f: f}
178+
m.init()
215179
return m, nil
216180
}

0 commit comments

Comments
 (0)