Class: Reline::Windows

Inherits:
Object show all
Defined in:
lib/reline/windows.rb

Defined Under Namespace

Classes: KeyEventRecord, Win32API

Constant Summary collapse

VK_RETURN = 
0x0D
VK_MENU =

ALT key

0x12
VK_LMENU = 
0xA4
VK_CONTROL = 
0x11
VK_SHIFT = 
0x10
VK_DIVIDE = 
0x6F
KEY_EVENT = 
0x01
WINDOW_BUFFER_SIZE_EVENT = 
0x04
CAPSLOCK_ON = 
0x0080
ENHANCED_KEY = 
0x0100
LEFT_ALT_PRESSED = 
0x0002
LEFT_CTRL_PRESSED = 
0x0008
NUMLOCK_ON = 
0x0020
RIGHT_ALT_PRESSED = 
0x0001
RIGHT_CTRL_PRESSED = 
0x0004
SCROLLLOCK_ON = 
0x0040
SHIFT_PRESSED = 
0x0010
VK_TAB = 
0x09
VK_END = 
0x23
VK_HOME = 
0x24
VK_LEFT = 
0x25
VK_UP = 
0x26
VK_RIGHT = 
0x27
VK_DOWN = 
0x28
VK_DELETE = 
0x2E
STD_INPUT_HANDLE = 
-10
STD_OUTPUT_HANDLE = 
-11
FILE_TYPE_PIPE = 
0x0003
FILE_NAME_INFO = 
2
ENABLE_VIRTUAL_TERMINAL_PROCESSING = 
4
KEY_MAP = 
[
  # It's treated as Meta+Enter on Windows.
  [ { control_keys: :CTRL,  virtual_key_code: 0x0D }, "\e\r".bytes ],
  [ { control_keys: :SHIFT, virtual_key_code: 0x0D }, "\e\r".bytes ],

  # It's treated as Meta+Space on Windows.
  [ { control_keys: :CTRL,  char_code: 0x20 }, "\e ".bytes ],

  # Emulate getwch() key sequences.
  [ { control_keys: [], virtual_key_code: VK_UP },     [0, 72] ],
  [ { control_keys: [], virtual_key_code: VK_DOWN },   [0, 80] ],
  [ { control_keys: [], virtual_key_code: VK_RIGHT },  [0, 77] ],
  [ { control_keys: [], virtual_key_code: VK_LEFT },   [0, 75] ],
  [ { control_keys: [], virtual_key_code: VK_DELETE }, [0, 83] ],
  [ { control_keys: [], virtual_key_code: VK_HOME },   [0, 71] ],
  [ { control_keys: [], virtual_key_code: VK_END },    [0, 79] ],

  # Emulate ANSI key sequence.
  [ { control_keys: :SHIFT, virtual_key_code: VK_TAB }, [27, 91, 90] ],
]
@@getwch = 
Win32API.new('msvcrt', '_getwch', [], 'I')
@@kbhit = 
Win32API.new('msvcrt', '_kbhit', [], 'I')
@@GetKeyState = 
Win32API.new('user32', 'GetKeyState', ['L'], 'L')
@@GetConsoleScreenBufferInfo = 
Win32API.new('kernel32', 'GetConsoleScreenBufferInfo', ['L', 'P'], 'L')
@@SetConsoleCursorPosition = 
Win32API.new('kernel32', 'SetConsoleCursorPosition', ['L', 'L'], 'L')
@@GetStdHandle = 
Win32API.new('kernel32', 'GetStdHandle', ['L'], 'L')
@@FillConsoleOutputCharacter = 
Win32API.new('kernel32', 'FillConsoleOutputCharacter', ['L', 'L', 'L', 'L', 'P'], 'L')
@@ScrollConsoleScreenBuffer = 
Win32API.new('kernel32', 'ScrollConsoleScreenBuffer', ['L', 'P', 'P', 'L', 'P'], 'L')
@@hConsoleHandle = 
@@GetStdHandle.call(STD_OUTPUT_HANDLE)
@@hConsoleInputHandle = 
@@GetStdHandle.call(STD_INPUT_HANDLE)
@@GetNumberOfConsoleInputEvents = 
Win32API.new('kernel32', 'GetNumberOfConsoleInputEvents', ['L', 'P'], 'L')
@@ReadConsoleInputW = 
Win32API.new('kernel32', 'ReadConsoleInputW', ['L', 'P', 'L', 'P'], 'L')
@@GetFileType = 
Win32API.new('kernel32', 'GetFileType', ['L'], 'L')
@@GetFileInformationByHandleEx = 
Win32API.new('kernel32', 'GetFileInformationByHandleEx', ['L', 'I', 'P', 'L'], 'I')
@@FillConsoleOutputAttribute = 
Win32API.new('kernel32', 'FillConsoleOutputAttribute', ['L', 'L', 'L', 'L', 'P'], 'L')
@@SetConsoleCursorInfo = 
Win32API.new('kernel32', 'SetConsoleCursorInfo', ['L', 'P'], 'L')
@@GetConsoleMode = 
Win32API.new('kernel32', 'GetConsoleMode', ['L', 'P'], 'L')
@@SetConsoleMode = 
Win32API.new('kernel32', 'SetConsoleMode', ['L', 'L'], 'L')
@@WaitForSingleObject = 
Win32API.new('kernel32', 'WaitForSingleObject', ['L', 'L'], 'L')
@@legacy_console = 
(getconsolemode() & ENABLE_VIRTUAL_TERMINAL_PROCESSING == 0)
@@input_buf =

if @@legacy_console

setconsolemode(getconsolemode() | ENABLE_VIRTUAL_TERMINAL_PROCESSING)
@@legacy_console = (getconsolemode() & ENABLE_VIRTUAL_TERMINAL_PROCESSING == 0)

end

[]
@@output_buf = 
[]
@@output = 
STDOUT
@@hsg = 
nil

Class Method Summary collapse

Class Method Details

.check_input_event ⇒ Object 



257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/reline/windows.rb', line 257

def self.check_input_event
  num_of_events = 0.chr * 8
  while @@output_buf.empty?
    Reline.core.line_editor.resize
    if @@WaitForSingleObject.(@@hConsoleInputHandle, 100) != 0 # max 0.1 sec
      # prevent for background consolemode change
      @@legacy_console = (getconsolemode() & ENABLE_VIRTUAL_TERMINAL_PROCESSING == 0)
      next
    end
    next if @@GetNumberOfConsoleInputEvents.(@@hConsoleInputHandle, num_of_events) == 0 or num_of_events.unpack1('L') == 0
    input_records = 0.chr * 20 * 80
    read_event = 0.chr * 4
    if @@ReadConsoleInputW.(@@hConsoleInputHandle, input_records, 80, read_event) != 0
      read_events = read_event.unpack1('L')
      0.upto(read_events) do |idx|
        input_record = input_records[idx * 20, 20]
        event = input_record[0, 2].unpack1('s*')
        case event
        when WINDOW_BUFFER_SIZE_EVENT
          @@winch_handler.()
        when KEY_EVENT
          key_down = input_record[4, 4].unpack1('l*')
          repeat_count = input_record[8, 2].unpack1('s*')
          virtual_key_code = input_record[10, 2].unpack1('s*')
          virtual_scan_code = input_record[12, 2].unpack1('s*')
          char_code = input_record[14, 2].unpack1('S*')
          control_key_state = input_record[16, 2].unpack1('S*')
          is_key_down = key_down.zero? ? false : true
          if is_key_down
            process_key_event(repeat_count, virtual_key_code, virtual_scan_code, char_code, control_key_state)
          end
        end
      end
    end
  end
end

.clear_screen ⇒ Object 



417
418
419
420
421
422
423
424
425
426
427
428
429
430
 
# File 'lib/reline/windows.rb', line 417

def self.clear_screen
  if @@legacy_console
    return unless csbi = get_console_screen_buffer_info
    buffer_width, _buffer_lines, attributes, window_top, window_bottom = csbi.unpack('ss@8S@12sx2s')
    fill_length = buffer_width * (window_bottom - window_top + 1)
    screen_topleft = window_top * 65536
    written = 0.chr * 4
    @@FillConsoleOutputCharacter.call(@@hConsoleHandle, 0x20, fill_length, screen_topleft, written)
    @@FillConsoleOutputAttribute.call(@@hConsoleHandle, attributes, fill_length, screen_topleft, written)
    @@SetConsoleCursorPosition.call(@@hConsoleHandle, screen_topleft)
  else
    @@output.write "\e[2J" "\e[H"
  end
end

.cursor_pos ⇒ Object 



346
347
348
349
350
351
352
353
 
# File 'lib/reline/windows.rb', line 346

def self.cursor_pos
  unless csbi = get_console_screen_buffer_info
    return Reline::CursorPos.new(0, 0)
  end
  x = csbi[4, 2].unpack1('s')
  y = csbi[6, 2].unpack1('s')
  Reline::CursorPos.new(x, y)
end

.deprep(otio) ⇒ Object 



459
460
461
 
# File 'lib/reline/windows.rb', line 459

def self.deprep(otio)
  # do nothing
end

.empty_buffer? ⇒ Boolean

Returns:

  • (Boolean) 


311
312
313
314
315
316
317
318
319
 
# File 'lib/reline/windows.rb', line 311

def self.empty_buffer?
  if not @@output_buf.empty?
    false
  elsif @@kbhit.call == 0
    true
  else
    false
  end
end

.encoding ⇒ Object 



4
5
6
 
# File 'lib/reline/windows.rb', line 4

def self.encoding
  Encoding::UTF_8
end

.erase_after_cursor ⇒ Object 



381
382
383
384
385
386
387
388
 
# File 'lib/reline/windows.rb', line 381

def self.erase_after_cursor
  return unless csbi = get_console_screen_buffer_info
  attributes = csbi[8, 2].unpack1('S')
  cursor = csbi[4, 4].unpack1('L')
  written = 0.chr * 4
  @@FillConsoleOutputCharacter.call(@@hConsoleHandle, 0x20, get_screen_size.last - cursor_pos.x, cursor, written)
  @@FillConsoleOutputAttribute.call(@@hConsoleHandle, attributes, get_screen_size.last - cursor_pos.x, cursor, written)
end

.get_console_screen_buffer_info ⇒ Object 



321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/reline/windows.rb', line 321

def self.get_console_screen_buffer_info
  # CONSOLE_SCREEN_BUFFER_INFO
  # [ 0,2] dwSize.X
  # [ 2,2] dwSize.Y
  # [ 4,2] dwCursorPositions.X
  # [ 6,2] dwCursorPositions.Y
  # [ 8,2] wAttributes
  # [10,2] srWindow.Left
  # [12,2] srWindow.Top
  # [14,2] srWindow.Right
  # [16,2] srWindow.Bottom
  # [18,2] dwMaximumWindowSize.X
  # [20,2] dwMaximumWindowSize.Y
  csbi = 0.chr * 22
  return if @@GetConsoleScreenBufferInfo.call(@@hConsoleHandle, csbi) == 0
  csbi
end

.get_screen_size ⇒ Object 



339
340
341
342
343
344
 
# File 'lib/reline/windows.rb', line 339

def self.get_screen_size
  unless csbi = get_console_screen_buffer_info
    return [1, 1]
  end
  csbi[0, 4].unpack('SS').reverse
end

.getc(_timeout_second) ⇒ Object 



298
299
300
301
 
# File 'lib/reline/windows.rb', line 298

def self.getc(_timeout_second)
  check_input_event
  @@output_buf.shift
end

.hide_cursor ⇒ Object 



436
437
438
439
440
441
 
# File 'lib/reline/windows.rb', line 436

def self.hide_cursor
  size = 100
  visible = 0 # 0 means false
  cursor_info = [size, visible].pack('Li')
  @@SetConsoleCursorInfo.call(@@hConsoleHandle, cursor_info)
end

.in_pasting? ⇒ Boolean

Returns:

  • (Boolean) 


307
308
309
 
# File 'lib/reline/windows.rb', line 307

def self.in_pasting?
  not self.empty_buffer?
end

.move_cursor_column(val) ⇒ Object 



355
356
357
 
# File 'lib/reline/windows.rb', line 355

def self.move_cursor_column(val)
  @@SetConsoleCursorPosition.call(@@hConsoleHandle, cursor_pos.y * 65536 + val)
end

.move_cursor_down(val) ⇒ Object 



369
370
371
372
373
374
375
376
377
378
379
 
# File 'lib/reline/windows.rb', line 369

def self.move_cursor_down(val)
  if val > 0
    return unless csbi = get_console_screen_buffer_info
    screen_height = get_screen_size.first
    y = cursor_pos.y + val
    y = screen_height - 1 if y > (screen_height - 1)
    @@SetConsoleCursorPosition.call(@@hConsoleHandle, (cursor_pos.y + val) * 65536 + cursor_pos.x)
  elsif val < 0
    move_cursor_up(-val)
  end
end

.move_cursor_up(val) ⇒ Object 



359
360
361
362
363
364
365
366
367
 
# File 'lib/reline/windows.rb', line 359

def self.move_cursor_up(val)
  if val > 0
    y = cursor_pos.y - val
    y = 0 if y < 0
    @@SetConsoleCursorPosition.call(@@hConsoleHandle, y * 65536 + cursor_pos.x)
  elsif val < 0
    move_cursor_down(-val)
  end
end

.msys_tty?(io = @@hConsoleInputHandle) ⇒ Boolean

Returns:

  • (Boolean) 


173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/reline/windows.rb', line 173

def self.msys_tty?(io = @@hConsoleInputHandle)
  # check if fd is a pipe
  if @@GetFileType.call(io) != FILE_TYPE_PIPE
    return false
  end

  bufsize = 1024
  p_buffer = "\0" * bufsize
  res = @@GetFileInformationByHandleEx.call(io, FILE_NAME_INFO, p_buffer, bufsize - 2)
  return false if res == 0

  # get pipe name: p_buffer layout is:
  #   struct _FILE_NAME_INFO {
  #     DWORD FileNameLength;
  #     WCHAR FileName[1];
  #   } FILE_NAME_INFO
  len = p_buffer[0, 4].unpack1("L")
  name = p_buffer[4, len].encode(Encoding::UTF_8, Encoding::UTF_16LE, invalid: :replace)

  # Check if this could be a MSYS2 pty pipe ('\msys-XXXX-ptyN-XX')
  # or a cygwin pty pipe ('\cygwin-XXXX-ptyN-XX')
  name =~ /(msys-|cygwin-).*-pty/ ? true : false
end

.prep ⇒ Object 



454
455
456
457
 
# File 'lib/reline/windows.rb', line 454

def self.prep
  # do nothing
  nil
end

.process_key_event(repeat_count, virtual_key_code, virtual_scan_code, char_code, control_key_state) ⇒ Object 



220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/reline/windows.rb', line 220

def self.process_key_event(repeat_count, virtual_key_code, virtual_scan_code, char_code, control_key_state)

  # high-surrogate
  if 0xD800 <= char_code and char_code <= 0xDBFF
    @@hsg = char_code
    return
  end
  # low-surrogate
  if 0xDC00 <= char_code and char_code <= 0xDFFF
    if @@hsg
      char_code = 0x10000 + (@@hsg - 0xD800) * 0x400 + char_code - 0xDC00
      @@hsg = nil
    else
      # no high-surrogate. ignored.
      return
    end
  else
    # ignore high-surrogate without low-surrogate if there
    @@hsg = nil
  end

  key = KeyEventRecord.new(virtual_key_code, char_code, control_key_state)

  match = KEY_MAP.find { |args,| key.matches?(**args) }
  unless match.nil?
    @@output_buf.concat(match.last)
    return
  end

  # no char, only control keys
  return if key.char_code == 0 and key.control_keys.any?

  @@output_buf.push("\e".ord) if key.control_keys.include?(:ALT) and !key.control_keys.include?(:CTRL)

  @@output_buf.concat(key.char.bytes)
end

.scroll_down(val) ⇒ Object 



390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
 
# File 'lib/reline/windows.rb', line 390

def self.scroll_down(val)
  return if val < 0
  return unless csbi = get_console_screen_buffer_info
  buffer_width, buffer_lines, x, y, attributes, window_left, window_top, window_bottom = csbi.unpack('ssssSssx2s')
  screen_height = window_bottom - window_top + 1
  val = screen_height if val > screen_height

  if @@legacy_console || window_left != 0
    # unless ENABLE_VIRTUAL_TERMINAL,
    # if srWindow.Left != 0 then it's conhost.exe hosted console
    # and puts "\n" causes horizontal scroll. its glitch.
    # FYI irb write from culumn 1, so this gives no gain.
    scroll_rectangle = [0, val, buffer_width, buffer_lines - val].pack('s4')
    destination_origin = 0 # y * 65536 + x
    fill = [' '.ord, attributes].pack('SS')
    @@ScrollConsoleScreenBuffer.call(@@hConsoleHandle, scroll_rectangle, nil, destination_origin, fill)
  else
    origin_x = x + 1
    origin_y = y - window_top + 1
    @@output.write [
      (origin_y != screen_height) ? "\e[#{screen_height};H" : nil,
      "\n" * val,
      (origin_y != screen_height or !x.zero?) ? "\e[#{origin_y};#{origin_x}H" : nil
    ].join
  end
end

.set_default_key_bindings(config) ⇒ Object 



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/reline/windows.rb', line 16

def self.set_default_key_bindings(config)
  {
    [224, 72] => :ed_prev_history, # ↑
    [224, 80] => :ed_next_history, # ↓
    [224, 77] => :ed_next_char,    # →
    [224, 75] => :ed_prev_char,    # ←
    [224, 83] => :key_delete,      # Del
    [224, 71] => :ed_move_to_beg,  # Home
    [224, 79] => :ed_move_to_end,  # End
    [  0, 41] => :ed_unassigned,   # input method on/off
    [  0, 72] => :ed_prev_history, # ↑
    [  0, 80] => :ed_next_history, # ↓
    [  0, 77] => :ed_next_char,    # →
    [  0, 75] => :ed_prev_char,    # ←
    [  0, 83] => :key_delete,      # Del
    [  0, 71] => :ed_move_to_beg,  # Home
    [  0, 79] => :ed_move_to_end   # End
  }.each_pair do |key, func|
    config.add_default_key_binding_by_keymap(:emacs, key, func)
    config.add_default_key_binding_by_keymap(:vi_insert, key, func)
    config.add_default_key_binding_by_keymap(:vi_command, key, func)
  end

  {
    [27, 32] => :em_set_mark,             # M-<space>
    [24, 24] => :em_exchange_mark,        # C-x C-x
  }.each_pair do |key, func|
    config.add_default_key_binding_by_keymap(:emacs, key, func)
  end

  # Emulate ANSI key sequence.
  {
    [27, 91, 90] => :completion_journey_up, # S-Tab
  }.each_pair do |key, func|
    config.add_default_key_binding_by_keymap(:emacs, key, func)
    config.add_default_key_binding_by_keymap(:vi_insert, key, func)
  end
end

.set_screen_size(rows, columns) ⇒ Object

Raises:

  • (NotImplementedError) 


432
433
434
 
# File 'lib/reline/windows.rb', line 432

def self.set_screen_size(rows, columns)
  raise NotImplementedError
end

.set_winch_handler(&handler) ⇒ Object 



450
451
452
 
# File 'lib/reline/windows.rb', line 450

def self.set_winch_handler(&handler)
  @@winch_handler = handler
end

.show_cursor ⇒ Object 



443
444
445
446
447
448
 
# File 'lib/reline/windows.rb', line 443

def self.show_cursor
  size = 100
  visible = 1 # 1 means true
  cursor_info = [size, visible].pack('Li')
  @@SetConsoleCursorInfo.call(@@hConsoleHandle, cursor_info)
end

.ungetc(c) ⇒ Object 



303
304
305
 
# File 'lib/reline/windows.rb', line 303

def self.ungetc(c)
  @@output_buf.unshift(c)
end

.win? ⇒ Boolean

Returns:

  • (Boolean) 


8
9
10
 
# File 'lib/reline/windows.rb', line 8

def self.win?
  true
end

.win_legacy_console? ⇒ Boolean

Returns:

  • (Boolean) 


12
13
14
 
# File 'lib/reline/windows.rb', line 12

def self.win_legacy_console?
  @@legacy_console
end

.with_raw_input ⇒ Object 



294
295
296
 
# File 'lib/reline/windows.rb', line 294

def self.with_raw_input
  yield
end