console_windows.go 5.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201
  1. package console
  2. import (
  3. "fmt"
  4. "os"
  5. "github.com/pkg/errors"
  6. "golang.org/x/sys/windows"
  7. )
  8. var (
  9. vtInputSupported bool
  10. ErrNotImplemented = errors.New("not implemented")
  11. )
  12. func (m *master) initStdios() {
  13. m.in = windows.Handle(os.Stdin.Fd())
  14. if err := windows.GetConsoleMode(m.in, &m.inMode); err == nil {
  15. // Validate that windows.ENABLE_VIRTUAL_TERMINAL_INPUT is supported, but do not set it.
  16. if err = windows.SetConsoleMode(m.in, m.inMode|windows.ENABLE_VIRTUAL_TERMINAL_INPUT); err == nil {
  17. vtInputSupported = true
  18. }
  19. // Unconditionally set the console mode back even on failure because SetConsoleMode
  20. // remembers invalid bits on input handles.
  21. windows.SetConsoleMode(m.in, m.inMode)
  22. } else {
  23. fmt.Printf("failed to get console mode for stdin: %v\n", err)
  24. }
  25. m.out = windows.Handle(os.Stdout.Fd())
  26. if err := windows.GetConsoleMode(m.out, &m.outMode); err == nil {
  27. if err := windows.SetConsoleMode(m.out, m.outMode|windows.ENABLE_VIRTUAL_TERMINAL_PROCESSING); err == nil {
  28. m.outMode |= windows.ENABLE_VIRTUAL_TERMINAL_PROCESSING
  29. } else {
  30. windows.SetConsoleMode(m.out, m.outMode)
  31. }
  32. } else {
  33. fmt.Printf("failed to get console mode for stdout: %v\n", err)
  34. }
  35. m.err = windows.Handle(os.Stderr.Fd())
  36. if err := windows.GetConsoleMode(m.err, &m.errMode); err == nil {
  37. if err := windows.SetConsoleMode(m.err, m.errMode|windows.ENABLE_VIRTUAL_TERMINAL_PROCESSING); err == nil {
  38. m.errMode |= windows.ENABLE_VIRTUAL_TERMINAL_PROCESSING
  39. } else {
  40. windows.SetConsoleMode(m.err, m.errMode)
  41. }
  42. } else {
  43. fmt.Printf("failed to get console mode for stderr: %v\n", err)
  44. }
  45. }
  46. type master struct {
  47. in windows.Handle
  48. inMode uint32
  49. out windows.Handle
  50. outMode uint32
  51. err windows.Handle
  52. errMode uint32
  53. }
  54. func (m *master) SetRaw() error {
  55. if err := makeInputRaw(m.in, m.inMode); err != nil {
  56. return err
  57. }
  58. // Set StdOut and StdErr to raw mode, we ignore failures since
  59. // windows.DISABLE_NEWLINE_AUTO_RETURN might not be supported on this version of
  60. // Windows.
  61. windows.SetConsoleMode(m.out, m.outMode|windows.DISABLE_NEWLINE_AUTO_RETURN)
  62. windows.SetConsoleMode(m.err, m.errMode|windows.DISABLE_NEWLINE_AUTO_RETURN)
  63. return nil
  64. }
  65. func (m *master) Reset() error {
  66. for _, s := range []struct {
  67. fd windows.Handle
  68. mode uint32
  69. }{
  70. {m.in, m.inMode},
  71. {m.out, m.outMode},
  72. {m.err, m.errMode},
  73. } {
  74. if err := windows.SetConsoleMode(s.fd, s.mode); err != nil {
  75. return errors.Wrap(err, "unable to restore console mode")
  76. }
  77. }
  78. return nil
  79. }
  80. func (m *master) Size() (WinSize, error) {
  81. var info windows.ConsoleScreenBufferInfo
  82. err := windows.GetConsoleScreenBufferInfo(m.out, &info)
  83. if err != nil {
  84. return WinSize{}, errors.Wrap(err, "unable to get console info")
  85. }
  86. winsize := WinSize{
  87. Width: uint16(info.Window.Right - info.Window.Left + 1),
  88. Height: uint16(info.Window.Bottom - info.Window.Top + 1),
  89. }
  90. return winsize, nil
  91. }
  92. func (m *master) Resize(ws WinSize) error {
  93. return ErrNotImplemented
  94. }
  95. func (m *master) ResizeFrom(c Console) error {
  96. return ErrNotImplemented
  97. }
  98. func (m *master) DisableEcho() error {
  99. mode := m.inMode &^ windows.ENABLE_ECHO_INPUT
  100. mode |= windows.ENABLE_PROCESSED_INPUT
  101. mode |= windows.ENABLE_LINE_INPUT
  102. if err := windows.SetConsoleMode(m.in, mode); err != nil {
  103. return errors.Wrap(err, "unable to set console to disable echo")
  104. }
  105. return nil
  106. }
  107. func (m *master) Close() error {
  108. return nil
  109. }
  110. func (m *master) Read(b []byte) (int, error) {
  111. panic("not implemented on windows")
  112. }
  113. func (m *master) Write(b []byte) (int, error) {
  114. panic("not implemented on windows")
  115. }
  116. func (m *master) Fd() uintptr {
  117. return uintptr(m.in)
  118. }
  119. // on windows, console can only be made from os.Std{in,out,err}, hence there
  120. // isnt a single name here we can use. Return a dummy "console" value in this
  121. // case should be sufficient.
  122. func (m *master) Name() string {
  123. return "console"
  124. }
  125. // makeInputRaw puts the terminal (Windows Console) connected to the given
  126. // file descriptor into raw mode
  127. func makeInputRaw(fd windows.Handle, mode uint32) error {
  128. // See
  129. // -- https://msdn.microsoft.com/en-us/library/windows/desktop/ms686033(v=vs.85).aspx
  130. // -- https://msdn.microsoft.com/en-us/library/windows/desktop/ms683462(v=vs.85).aspx
  131. // Disable these modes
  132. mode &^= windows.ENABLE_ECHO_INPUT
  133. mode &^= windows.ENABLE_LINE_INPUT
  134. mode &^= windows.ENABLE_MOUSE_INPUT
  135. mode &^= windows.ENABLE_WINDOW_INPUT
  136. mode &^= windows.ENABLE_PROCESSED_INPUT
  137. // Enable these modes
  138. mode |= windows.ENABLE_EXTENDED_FLAGS
  139. mode |= windows.ENABLE_INSERT_MODE
  140. mode |= windows.ENABLE_QUICK_EDIT_MODE
  141. if vtInputSupported {
  142. mode |= windows.ENABLE_VIRTUAL_TERMINAL_INPUT
  143. }
  144. if err := windows.SetConsoleMode(fd, mode); err != nil {
  145. return errors.Wrap(err, "unable to set console to raw mode")
  146. }
  147. return nil
  148. }
  149. func checkConsole(f *os.File) error {
  150. var mode uint32
  151. if err := windows.GetConsoleMode(windows.Handle(f.Fd()), &mode); err != nil {
  152. return err
  153. }
  154. return nil
  155. }
  156. func newMaster(f *os.File) (Console, error) {
  157. if f != os.Stdin && f != os.Stdout && f != os.Stderr {
  158. return nil, errors.New("creating a console from a file is not supported on windows")
  159. }
  160. m := &master{}
  161. m.initStdios()
  162. return m, nil
  163. }