Class: Kaitai::ConsoleWindows

Inherits:
Object
  • Object
show all
Defined in:
lib/kaitai/console_windows.rb

Constant Summary collapse

GET_STD_HANDLE = 
Fiddle::Function.new(kernel32['GetStdHandle'], [dword], handle)
GET_CONSOLE_SCREEN_BUFFER_INFO = 
Fiddle::Function.new(kernel32['GetConsoleScreenBufferInfo'], [handle, ptr], dword)
FILL_CONSOLE_OUTPUT_ATTRIBUTE = 
Fiddle::Function.new(kernel32['FillConsoleOutputAttribute'], [handle, word, dword, dword, ptr], dword)
FILL_CONSOLE_OUTPUT_CHARACTER = 
Fiddle::Function.new(kernel32['FillConsoleOutputCharacter'], [handle, word, dword, dword, ptr], dword)
SET_CONSOLE_CURSOR_POSITION = 
Fiddle::Function.new(kernel32['SetConsoleCursorPosition'], [handle, dword], dword)
SET_CONSOLE_TEXT_ATTRIBUTE = 
Fiddle::Function.new(kernel32['SetConsoleTextAttribute'], [handle, dword], dword)
GETCH = 
Fiddle::Function.new(Fiddle.dlopen('msvcrt')['_getch'], [], word)
COLORS = 
{
  black: 0,
  blue: 1,
  green: 2,
  cyan: 3,
  red: 4,
  magenta: 5,
  yellow: 6,
  white: 7,
  gray: 8,
  bright_blue: 9,
  bright_green: 10,
  bright_cyan: 11,
  bright_red: 12,
  bright_magenta: 13,
  bright_yellow: 14,
  bright_white: 15
}.freeze
ZERO_ESCAPE = 
0.chr
E0_ESCAPE = 
0xe0.chr
KEY_MAP = 
{
  "\b" => :backspace,
  "\t" => :tab,
  "\r" => :enter,

  # Regular AT keyboard arrows
  "#{E0_ESCAPE}H" => :up_arrow,
  "#{E0_ESCAPE}P" => :down_arrow,
  "#{E0_ESCAPE}K" => :left_arrow,
  "#{E0_ESCAPE}M" => :right_arrow,
  "#{E0_ESCAPE}I" => :pg_up,
  "#{E0_ESCAPE}Q" => :pg_dn,
  "#{E0_ESCAPE}G" => :home,
  "#{E0_ESCAPE}O" => :end,

  # Keypad
  "#{ZERO_ESCAPE}H" => :up_arrow,
  "#{ZERO_ESCAPE}P" => :down_arrow,
  "#{ZERO_ESCAPE}K" => :left_arrow,
  "#{ZERO_ESCAPE}M" => :right_arrow,
  "#{ZERO_ESCAPE}I" => :pg_up,
  "#{ZERO_ESCAPE}Q" => :pg_dn,
  "#{ZERO_ESCAPE}G" => :home,
  "#{ZERO_ESCAPE}O" => :end
}.freeze
SINGLE_CHARSET = 
'┌┐└┘─│'
HEAVY_CHARSET = 
'┏┓┗┛━┃'
DOUBLE_CHARSET = 
'╔╗╚╝═║'
CHAR_TL = 
0
CHAR_TR = 
1
CHAR_BL = 
2
CHAR_BR = 
3
CHAR_H = 
4
CHAR_V = 
5

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ ConsoleWindows

Returns a new instance of ConsoleWindows.



27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
 
# File 'lib/kaitai/console_windows.rb', line 27

def initialize
  @stdin_handle = GET_STD_HANDLE.call(-10)
  @stdout_handle = GET_STD_HANDLE.call(-11)
  @fg_color = 7
  @bg_color = 0

  # typedef struct _CONSOLE_SCREEN_BUFFER_INFO {
  #   COORD      dwSize;
  #   COORD      dwCursorPosition;
  #   WORD       wAttributes;
  #   SMALL_RECT srWindow;
  #   COORD      dwMaximumWindowSize;
  # } CONSOLE_SCREEN_BUFFER_INFO;

  # 4 + 4 + 2 + 4 * 2 + 4 = 22

  load_term_size
end

Instance Attribute Details

#cols ⇒ Object (readonly)

Returns the value of attribute cols.



8
9
10
 
# File 'lib/kaitai/console_windows.rb', line 8

def cols
  @cols
end

#on_resize=(value) ⇒ Object (writeonly)

Sets the attribute on_resize

Parameters:

  • value —

    the value to set the attribute on_resize to.



61
62
63
 
# File 'lib/kaitai/console_windows.rb', line 61

def on_resize=(value)
  @on_resize = value
end

#rows ⇒ Object (readonly)

Returns the value of attribute rows.



8
9
10
 
# File 'lib/kaitai/console_windows.rb', line 8

def rows
  @rows
end

Instance Method Details

#bg_color=(col) ⇒ Object 



116
117
118
119
120
121
122
 
# File 'lib/kaitai/console_windows.rb', line 116

def bg_color=(col)
  code = COLORS[col]
  raise "Invalid color: #{col}" unless code

  @bg_color = code
  update_colors
end

#clear ⇒ Object 



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/kaitai/console_windows.rb', line 63

def clear
  con_size = @buf_cols * @buf_rows
  num_written = +'XXXX'
  FILL_CONSOLE_OUTPUT_CHARACTER.call(
    @stdout_handle,
    0x20, # ' '
    con_size,
    0, # [0, 0] coords
    num_written
  )
  FILL_CONSOLE_OUTPUT_ATTRIBUTE.call(
    @stdout_handle,
    current_color_code,
    con_size,
    0, # [0, 0] coords
    num_written
  )
  goto(0, 0)
end

#fg_color=(col) ⇒ Object 



108
109
110
111
112
113
114
 
# File 'lib/kaitai/console_windows.rb', line 108

def fg_color=(col)
  code = COLORS[col]
  raise "Invalid color: #{col}" unless code

  @fg_color = code
  update_colors
end

#goto(x, y) ⇒ Object

Put the cursor up to screen position (x, y). First line is 0, first column is 0.



84
85
86
87
 
# File 'lib/kaitai/console_windows.rb', line 84

def goto(x, y)
  coord = [x, y].pack('vv').unpack1('V')
  SET_CONSOLE_CURSOR_POSITION.call(@stdout_handle, coord)
end

#load_term_size ⇒ Object 



46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/kaitai/console_windows.rb', line 46

def load_term_size
  csbi = 'X' * 22

  GET_CONSOLE_SCREEN_BUFFER_INFO.call(@stdout_handle, csbi)
  @buf_cols, @buf_rows,
    _cur_x, _cur_y, _cur_attr,
    win_left, win_top, win_right, win_bottom,
    _max_win_x, _max_win_y = csbi.unpack('vvvvvvvvvvv')

  # Getting size of actual visible portion of Windows console
  # http://stackoverflow.com/a/12642749/487064
  @cols = win_right - win_left + 1
  @rows = win_bottom - win_top + 1
end

#read_char ⇒ Object

Reads keypresses from the user including 2 and 3 escape character sequences.



134
135
136
137
138
139
140
141
142
143
 
# File 'lib/kaitai/console_windows.rb', line 134

def read_char
  input = GETCH.call.chr
  input << GETCH.call.chr if input == E0_ESCAPE || input == ZERO_ESCAPE

  # https://github.com/kaitai-io/kaitai_struct_visualizer/issues/14
  load_term_size
  @on_resize&.call(false)

  input
end

#read_char_mapped ⇒ Object 



145
146
147
148
149
 
# File 'lib/kaitai/console_windows.rb', line 145

def read_char_mapped
  c = read_char
  c2 = KEY_MAP[c]
  c2 || c
end

#reset_colors ⇒ Object 



124
125
126
127
128
 
# File 'lib/kaitai/console_windows.rb', line 124

def reset_colors
  @fg_color = 7
  @bg_color = 0
  update_colors
end