input_windows.go 8.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368
  1. package liner
  2. import (
  3. "bufio"
  4. "os"
  5. "syscall"
  6. "unicode/utf16"
  7. "unsafe"
  8. )
  9. var (
  10. kernel32 = syscall.NewLazyDLL("kernel32.dll")
  11. procGetStdHandle = kernel32.NewProc("GetStdHandle")
  12. procReadConsoleInput = kernel32.NewProc("ReadConsoleInputW")
  13. procGetNumberOfConsoleInputEvents = kernel32.NewProc("GetNumberOfConsoleInputEvents")
  14. procGetConsoleMode = kernel32.NewProc("GetConsoleMode")
  15. procSetConsoleMode = kernel32.NewProc("SetConsoleMode")
  16. procSetConsoleCursorPosition = kernel32.NewProc("SetConsoleCursorPosition")
  17. procGetConsoleScreenBufferInfo = kernel32.NewProc("GetConsoleScreenBufferInfo")
  18. procFillConsoleOutputCharacter = kernel32.NewProc("FillConsoleOutputCharacterW")
  19. )
  20. // These names are from the Win32 api, so they use underscores (contrary to
  21. // what golint suggests)
  22. const (
  23. std_input_handle = uint32(-10 & 0xFFFFFFFF)
  24. std_output_handle = uint32(-11 & 0xFFFFFFFF)
  25. std_error_handle = uint32(-12 & 0xFFFFFFFF)
  26. invalid_handle_value = ^uintptr(0)
  27. )
  28. type inputMode uint32
  29. // State represents an open terminal
  30. type State struct {
  31. commonState
  32. handle syscall.Handle
  33. hOut syscall.Handle
  34. origMode inputMode
  35. defaultMode inputMode
  36. key interface{}
  37. repeat uint16
  38. }
  39. const (
  40. enableEchoInput = 0x4
  41. enableInsertMode = 0x20
  42. enableLineInput = 0x2
  43. enableMouseInput = 0x10
  44. enableProcessedInput = 0x1
  45. enableQuickEditMode = 0x40
  46. enableWindowInput = 0x8
  47. )
  48. // NewLiner initializes a new *State, and sets the terminal into raw mode. To
  49. // restore the terminal to its previous state, call State.Close().
  50. func NewLiner() *State {
  51. var s State
  52. hIn, _, _ := procGetStdHandle.Call(uintptr(std_input_handle))
  53. s.handle = syscall.Handle(hIn)
  54. hOut, _, _ := procGetStdHandle.Call(uintptr(std_output_handle))
  55. s.hOut = syscall.Handle(hOut)
  56. s.terminalSupported = true
  57. if m, err := TerminalMode(); err == nil {
  58. s.origMode = m.(inputMode)
  59. mode := s.origMode
  60. mode &^= enableEchoInput
  61. mode &^= enableInsertMode
  62. mode &^= enableLineInput
  63. mode &^= enableMouseInput
  64. mode |= enableWindowInput
  65. mode.ApplyMode()
  66. } else {
  67. s.inputRedirected = true
  68. s.r = bufio.NewReader(os.Stdin)
  69. }
  70. s.getColumns()
  71. s.outputRedirected = s.columns <= 0
  72. return &s
  73. }
  74. // These names are from the Win32 api, so they use underscores (contrary to
  75. // what golint suggests)
  76. const (
  77. focus_event = 0x0010
  78. key_event = 0x0001
  79. menu_event = 0x0008
  80. mouse_event = 0x0002
  81. window_buffer_size_event = 0x0004
  82. )
  83. type input_record struct {
  84. eventType uint16
  85. pad uint16
  86. blob [16]byte
  87. }
  88. type key_event_record struct {
  89. KeyDown int32
  90. RepeatCount uint16
  91. VirtualKeyCode uint16
  92. VirtualScanCode uint16
  93. Char uint16
  94. ControlKeyState uint32
  95. }
  96. // These names are from the Win32 api, so they use underscores (contrary to
  97. // what golint suggests)
  98. const (
  99. vk_back = 0x08
  100. vk_tab = 0x09
  101. vk_menu = 0x12 // ALT key
  102. vk_prior = 0x21
  103. vk_next = 0x22
  104. vk_end = 0x23
  105. vk_home = 0x24
  106. vk_left = 0x25
  107. vk_up = 0x26
  108. vk_right = 0x27
  109. vk_down = 0x28
  110. vk_insert = 0x2d
  111. vk_delete = 0x2e
  112. vk_f1 = 0x70
  113. vk_f2 = 0x71
  114. vk_f3 = 0x72
  115. vk_f4 = 0x73
  116. vk_f5 = 0x74
  117. vk_f6 = 0x75
  118. vk_f7 = 0x76
  119. vk_f8 = 0x77
  120. vk_f9 = 0x78
  121. vk_f10 = 0x79
  122. vk_f11 = 0x7a
  123. vk_f12 = 0x7b
  124. bKey = 0x42
  125. dKey = 0x44
  126. fKey = 0x46
  127. yKey = 0x59
  128. )
  129. const (
  130. shiftPressed = 0x0010
  131. leftAltPressed = 0x0002
  132. leftCtrlPressed = 0x0008
  133. rightAltPressed = 0x0001
  134. rightCtrlPressed = 0x0004
  135. modKeys = shiftPressed | leftAltPressed | rightAltPressed | leftCtrlPressed | rightCtrlPressed
  136. )
  137. // inputWaiting only returns true if the next call to readNext will return immediately.
  138. func (s *State) inputWaiting() bool {
  139. var num uint32
  140. ok, _, _ := procGetNumberOfConsoleInputEvents.Call(uintptr(s.handle), uintptr(unsafe.Pointer(&num)))
  141. if ok == 0 {
  142. // call failed, so we cannot guarantee a non-blocking readNext
  143. return false
  144. }
  145. // during a "paste" input events are always an odd number, and
  146. // the last one results in a blocking readNext, so return false
  147. // when num is 1 or 0.
  148. return num > 1
  149. }
  150. func (s *State) readNext() (interface{}, error) {
  151. if s.repeat > 0 {
  152. s.repeat--
  153. return s.key, nil
  154. }
  155. var input input_record
  156. pbuf := uintptr(unsafe.Pointer(&input))
  157. var rv uint32
  158. prv := uintptr(unsafe.Pointer(&rv))
  159. var surrogate uint16
  160. for {
  161. ok, _, err := procReadConsoleInput.Call(uintptr(s.handle), pbuf, 1, prv)
  162. if ok == 0 {
  163. return nil, err
  164. }
  165. if input.eventType == window_buffer_size_event {
  166. xy := (*coord)(unsafe.Pointer(&input.blob[0]))
  167. s.columns = int(xy.x)
  168. return winch, nil
  169. }
  170. if input.eventType != key_event {
  171. continue
  172. }
  173. ke := (*key_event_record)(unsafe.Pointer(&input.blob[0]))
  174. if ke.KeyDown == 0 {
  175. if ke.VirtualKeyCode == vk_menu && ke.Char > 0 {
  176. // paste of unicode (eg. via ALT-numpad)
  177. if surrogate > 0 {
  178. return utf16.DecodeRune(rune(surrogate), rune(ke.Char)), nil
  179. } else if utf16.IsSurrogate(rune(ke.Char)) {
  180. surrogate = ke.Char
  181. continue
  182. } else {
  183. return rune(ke.Char), nil
  184. }
  185. }
  186. continue
  187. }
  188. if ke.VirtualKeyCode == vk_tab && ke.ControlKeyState&modKeys == shiftPressed {
  189. s.key = shiftTab
  190. } else if ke.VirtualKeyCode == vk_back && (ke.ControlKeyState&modKeys == leftAltPressed ||
  191. ke.ControlKeyState&modKeys == rightAltPressed) {
  192. s.key = altBs
  193. } else if ke.VirtualKeyCode == bKey && (ke.ControlKeyState&modKeys == leftAltPressed ||
  194. ke.ControlKeyState&modKeys == rightAltPressed) {
  195. s.key = altB
  196. } else if ke.VirtualKeyCode == dKey && (ke.ControlKeyState&modKeys == leftAltPressed ||
  197. ke.ControlKeyState&modKeys == rightAltPressed) {
  198. s.key = altD
  199. } else if ke.VirtualKeyCode == fKey && (ke.ControlKeyState&modKeys == leftAltPressed ||
  200. ke.ControlKeyState&modKeys == rightAltPressed) {
  201. s.key = altF
  202. } else if ke.VirtualKeyCode == yKey && (ke.ControlKeyState&modKeys == leftAltPressed ||
  203. ke.ControlKeyState&modKeys == rightAltPressed) {
  204. s.key = altY
  205. } else if ke.Char > 0 {
  206. if surrogate > 0 {
  207. s.key = utf16.DecodeRune(rune(surrogate), rune(ke.Char))
  208. } else if utf16.IsSurrogate(rune(ke.Char)) {
  209. surrogate = ke.Char
  210. continue
  211. } else {
  212. s.key = rune(ke.Char)
  213. }
  214. } else {
  215. switch ke.VirtualKeyCode {
  216. case vk_prior:
  217. s.key = pageUp
  218. case vk_next:
  219. s.key = pageDown
  220. case vk_end:
  221. s.key = end
  222. case vk_home:
  223. s.key = home
  224. case vk_left:
  225. s.key = left
  226. if ke.ControlKeyState&(leftCtrlPressed|rightCtrlPressed) != 0 {
  227. if ke.ControlKeyState&modKeys == ke.ControlKeyState&(leftCtrlPressed|rightCtrlPressed) {
  228. s.key = wordLeft
  229. }
  230. }
  231. case vk_right:
  232. s.key = right
  233. if ke.ControlKeyState&(leftCtrlPressed|rightCtrlPressed) != 0 {
  234. if ke.ControlKeyState&modKeys == ke.ControlKeyState&(leftCtrlPressed|rightCtrlPressed) {
  235. s.key = wordRight
  236. }
  237. }
  238. case vk_up:
  239. s.key = up
  240. case vk_down:
  241. s.key = down
  242. case vk_insert:
  243. s.key = insert
  244. case vk_delete:
  245. s.key = del
  246. case vk_f1:
  247. s.key = f1
  248. case vk_f2:
  249. s.key = f2
  250. case vk_f3:
  251. s.key = f3
  252. case vk_f4:
  253. s.key = f4
  254. case vk_f5:
  255. s.key = f5
  256. case vk_f6:
  257. s.key = f6
  258. case vk_f7:
  259. s.key = f7
  260. case vk_f8:
  261. s.key = f8
  262. case vk_f9:
  263. s.key = f9
  264. case vk_f10:
  265. s.key = f10
  266. case vk_f11:
  267. s.key = f11
  268. case vk_f12:
  269. s.key = f12
  270. default:
  271. // Eat modifier keys
  272. // TODO: return Action(Unknown) if the key isn't a
  273. // modifier.
  274. continue
  275. }
  276. }
  277. if ke.RepeatCount > 1 {
  278. s.repeat = ke.RepeatCount - 1
  279. }
  280. return s.key, nil
  281. }
  282. }
  283. // Close returns the terminal to its previous mode
  284. func (s *State) Close() error {
  285. s.origMode.ApplyMode()
  286. return nil
  287. }
  288. func (s *State) startPrompt() {
  289. if m, err := TerminalMode(); err == nil {
  290. s.defaultMode = m.(inputMode)
  291. mode := s.defaultMode
  292. mode &^= enableProcessedInput
  293. mode.ApplyMode()
  294. }
  295. }
  296. func (s *State) restartPrompt() {
  297. }
  298. func (s *State) stopPrompt() {
  299. s.defaultMode.ApplyMode()
  300. }
  301. // TerminalSupported returns true because line editing is always
  302. // supported on Windows.
  303. func TerminalSupported() bool {
  304. return true
  305. }
  306. func (mode inputMode) ApplyMode() error {
  307. hIn, _, err := procGetStdHandle.Call(uintptr(std_input_handle))
  308. if hIn == invalid_handle_value || hIn == 0 {
  309. return err
  310. }
  311. ok, _, err := procSetConsoleMode.Call(hIn, uintptr(mode))
  312. if ok != 0 {
  313. err = nil
  314. }
  315. return err
  316. }
  317. // TerminalMode returns the current terminal input mode as an InputModeSetter.
  318. //
  319. // This function is provided for convenience, and should
  320. // not be necessary for most users of liner.
  321. func TerminalMode() (ModeApplier, error) {
  322. var mode inputMode
  323. hIn, _, err := procGetStdHandle.Call(uintptr(std_input_handle))
  324. if hIn == invalid_handle_value || hIn == 0 {
  325. return nil, err
  326. }
  327. ok, _, err := procGetConsoleMode.Call(hIn, uintptr(unsafe.Pointer(&mode)))
  328. if ok != 0 {
  329. err = nil
  330. }
  331. return mode, err
  332. }
  333. const cursorColumn = true