Class: Reline::Windows

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

Defined Under Namespace

Classes: Win32API

Constant Summary collapse

RAW_KEYSTROKE_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
}
VK_MENU = 
0x12
VK_LMENU = 
0xA4
VK_CONTROL = 
0x11
VK_SHIFT = 
0x10
STD_INPUT_HANDLE = 
-10
STD_OUTPUT_HANDLE = 
-11
WINDOW_BUFFER_SIZE_EVENT = 
0x04
FILE_TYPE_PIPE = 
0x0003
FILE_NAME_INFO = 
2
ENABLE_VIRTUAL_TERMINAL_PROCESSING = 
4
@@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')
@@ReadConsoleInput = 
Win32API.new('kernel32', 'ReadConsoleInput', ['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')
@@GetConsoleMode = 
Win32API.new('kernel32', 'GetConsoleMode', ['L', 'P'], 'L')
@@SetConsoleMode = 
Win32API.new('kernel32', 'SetConsoleMode', ['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 = 
[]

Class Method Summary collapse

Class Method Details

.clear_screen ⇒ Object 



298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/reline/windows.rb', line 298

def self.clear_screen
  csbi = 0.chr * 22
  return if @@GetConsoleScreenBufferInfo.call(@@hConsoleHandle, csbi) == 0
  buffer_width = csbi[0, 2].unpack('S').first
  attributes = csbi[8, 2].unpack('S').first
  _window_left, window_top, _window_right, window_bottom = *csbi[10,8].unpack('S*')
  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)
end

.cursor_pos ⇒ Object 



246
247
248
249
250
251
252
 
# File 'lib/reline/windows.rb', line 246

def self.cursor_pos
  csbi = 0.chr * 22
  @@GetConsoleScreenBufferInfo.call(@@hConsoleHandle, csbi)
  x = csbi[4, 2].unpack('s*').first
  y = csbi[6, 2].unpack('s*').first
  Reline::CursorPos.new(x, y)
end

.deprep(otio) ⇒ Object 



325
326
327
 
# File 'lib/reline/windows.rb', line 325

def self.deprep(otio)
  # do nothing
end

.empty_buffer? ⇒ Boolean

Returns:

  • (Boolean) 


230
231
232
233
234
235
236
237
238
 
# File 'lib/reline/windows.rb', line 230

def self.empty_buffer?
  if not @@input_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 



279
280
281
282
283
284
285
286
 
# File 'lib/reline/windows.rb', line 279

def self.erase_after_cursor
  csbi = 0.chr * 24
  @@GetConsoleScreenBufferInfo.call(@@hConsoleHandle, csbi)
  cursor = csbi[4, 4].unpack('L').first
  written = 0.chr * 4
  @@FillConsoleOutputCharacter.call(@@hConsoleHandle, 0x20, get_screen_size.last - cursor_pos.x, cursor, written)
  @@FillConsoleOutputAttribute.call(@@hConsoleHandle, 0, get_screen_size.last - cursor_pos.x, cursor, written)
end

.get_screen_size ⇒ Object 



240
241
242
243
244
 
# File 'lib/reline/windows.rb', line 240

def self.get_screen_size
  csbi = 0.chr * 22
  @@GetConsoleScreenBufferInfo.call(@@hConsoleHandle, csbi)
  csbi[0, 4].unpack('SS').reverse
end

.getc ⇒ Object 



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/reline/windows.rb', line 174

def self.getc
  num_of_events = 0.chr * 8
  while @@GetNumberOfConsoleInputEvents.(@@hConsoleInputHandle, num_of_events) != 0 and num_of_events.unpack('L').first > 0
    input_record = 0.chr * 18
    read_event = 0.chr * 4
    if @@ReadConsoleInput.(@@hConsoleInputHandle, input_record, 1, read_event) != 0
      event = input_record[0, 2].unpack('s*').first
      if event == WINDOW_BUFFER_SIZE_EVENT
        @@winch_handler.()
      end
    end
  end
  unless @@output_buf.empty?
    return @@output_buf.shift
  end
  input = getwch
  meta = (@@GetKeyState.call(VK_LMENU) & 0x80) != 0
  control = (@@GetKeyState.call(VK_CONTROL) & 0x80) != 0
  shift = (@@GetKeyState.call(VK_SHIFT) & 0x80) != 0
  force_enter = !input.instance_of?(Array) && (control or shift) && input == 0x0D
  if force_enter
    # It's treated as Meta+Enter on Windows
    @@output_buf.push("\e".ord)
    @@output_buf.push(input)
  else
    case input
    when 0x00
      meta = false
      @@output_buf.push(input)
      input = getwch
      @@output_buf.push(*input)
    when 0xE0
      @@output_buf.push(input)
      input = getwch
      @@output_buf.push(*input)
    when 0x03
      @@output_buf.push(input)
    else
      @@output_buf.push(input)
    end
  end
  if meta
    "\e".ord
  else
    @@output_buf.shift
  end
end

.getwch ⇒ Object 



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/reline/windows.rb', line 148

def self.getwch
  unless @@input_buf.empty?
    return @@input_buf.shift
  end
  while @@kbhit.call == 0
    sleep(0.001)
  end
  until @@kbhit.call == 0
    ret = @@getwch.call
    if ret == 0 or ret == 0xE0
      @@input_buf << ret
      ret = @@getwch.call
      @@input_buf << ret
      return @@input_buf.shift
    end
    begin
      bytes = ret.chr(Encoding::UTF_8).bytes
      @@input_buf.push(*bytes)
    rescue Encoding::UndefinedConversionError
      @@input_buf << ret
      @@input_buf << @@getwch.call if ret == 224
    end
  end
  @@input_buf.shift
end

.in_pasting? ⇒ Boolean

Returns:

  • (Boolean) 


226
227
228
 
# File 'lib/reline/windows.rb', line 226

def self.in_pasting?
  not self.empty_buffer?
end

.move_cursor_column(val) ⇒ Object 



254
255
256
 
# File 'lib/reline/windows.rb', line 254

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

.move_cursor_down(val) ⇒ Object 



268
269
270
271
272
273
274
275
276
277
 
# File 'lib/reline/windows.rb', line 268

def self.move_cursor_down(val)
  if val > 0
    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 



258
259
260
261
262
263
264
265
266
 
# File 'lib/reline/windows.rb', line 258

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) 


124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/reline/windows.rb', line 124

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].unpack("L")[0]
  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 



320
321
322
323
 
# File 'lib/reline/windows.rb', line 320

def self.prep
  # do nothing
  nil
end

.scroll_down(val) ⇒ Object 



288
289
290
291
292
293
294
295
296
 
# File 'lib/reline/windows.rb', line 288

def self.scroll_down(val)
  return if val.zero?
  screen_height = get_screen_size.first
  val = screen_height - 1 if val > (screen_height - 1)
  scroll_rectangle = [0, val, get_screen_size.last, get_screen_size.first].pack('s4')
  destination_origin = 0 # y * 65536 + x
  fill = [' '.ord, 0].pack('SS')
  @@ScrollConsoleScreenBuffer.call(@@hConsoleHandle, scroll_rectangle, nil, destination_origin, fill)
end

.set_screen_size(rows, columns) ⇒ Object

Raises:

  • (NotImplementedError) 


312
313
314
 
# File 'lib/reline/windows.rb', line 312

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

.set_winch_handler(&handler) ⇒ Object 



316
317
318
 
# File 'lib/reline/windows.rb', line 316

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

.ungetc(c) ⇒ Object 



222
223
224
 
# File 'lib/reline/windows.rb', line 222

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