Class: RubyRich::Console

Inherits:
Object
  • Object
show all
Defined in:
lib/ruby_rich/console.rb

Constant Summary collapse

ESCAPE_SEQUENCES = 
{
  # 方向键
  '[A' => :up,    '[B' => :down,
  '[C' => :right, '[D' => :left,
  # 功能键
  'OP' => :f1, 'OQ' => :f2, 'OR' => :f3, 'OS' => :f4,
  '[15~' => :f5, '[17~' => :f6, '[18~' => :f7,
  '[19~' => :f8, '[20~' => :f9, '[21~' => :f10,
  '[23~' => :f11, '[24~' => :f12,
  # 添加媒体键示例
  '[1~' => :home,    '[4~' => :end,
  # 添加 macOS 功能键
  '[25~' => :audio_mute,
  # 其他
  '[5~' => :page_up, '[6~' => :page_down,
  '[H' => :home, '[F' => :end,
  '[2~' => :insert, '[3~' => :delete,
  '[Z' => :shift_tab,
  '[13;2u' => :shift_enter,
  '[13;3u' => :alt_enter,
  '[13;2~' => :shift_enter,
  '[13;3~' => :alt_enter
}.freeze
WINDOWS_SPECIAL_KEYS = 
{
  72 => :up,
  80 => :down,
  75 => :left,
  77 => :right,
  71 => :home,
  79 => :end,
  73 => :page_up,
  81 => :page_down,
  82 => :insert,
  83 => :delete
}.freeze

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Console

Returns a new instance of Console.



44
45
46
47
48
49
 
# File 'lib/ruby_rich/console.rb', line 44

def initialize
  @lines = []
  @buffer = []
  @layout = { spacing: 1, align: :left }
  @styles = {}
end

Class Method Details

.clear ⇒ Object 



105
106
107
 
# File 'lib/ruby_rich/console.rb', line 105

def self.clear
  system('clear')
end

.raw ⇒ Object 



97
98
99
100
101
102
103
 
# File 'lib/ruby_rich/console.rb', line 97

def self.raw
  old_state = `stty -g`
  system('stty raw -echo -icanon isig') rescue nil
  yield
ensure
  system("stty #{old_state}") rescue nil
end

Instance Method Details

#add_line(text) ⇒ Object 



207
208
209
 
# File 'lib/ruby_rich/console.rb', line 207

def add_line(text)
  @lines << text
end

#clear ⇒ Object 



211
212
213
 
# File 'lib/ruby_rich/console.rb', line 211

def clear
  Kernel.print "\e[H\e[2J"
end

#get_event(input: $stdin) ⇒ Object 



109
110
111
112
113
114
115
116
 
# File 'lib/ruby_rich/console.rb', line 109

def get_event(input: $stdin)
  if RubyRich::Terminal.windows_mouse_reporting?
    event = RubyRich::Terminal.read_windows_input_event
    return event if event
  end

  get_key(input: input)
end

#get_key(input: $stdin) ⇒ Object 



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
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
173
174
175
176
177
178
179
180
 
# File 'lib/ruby_rich/console.rb', line 118

def get_key(input: $stdin)
  input.raw(intr: true) do |io|
    RubyRich::Terminal.prepare_input
    char = io.getch
    bytes = char.b.bytes
    byte = bytes.first

    return Event.key(:ctrl_c) if byte == 3

    # Handle Enter key first (ASCII 13 = \r, ASCII 10 = \n)
    if char == "\r" || char == "\n"
      # Check for subsequent input (pasted content has multiple characters)
      has_more = IO.select([io], nil, nil, 0)

      return has_more ? Event.key(:paste, value: collect_pending_input(io, char)) : Event.key(:enter)
    end
    # Handle Tab key separately (ASCII 9)
    if char == "\t"
      return Event.key(:tab)
    elsif byte == 8 || byte == 0x7F
      return Event.key(:backspace)
    # Windows special keys can be delivered as:
    # - "\xE0" + a second getch byte
    # - "\xE0H" in one read
    elsif byte == 0 || byte == 224
      code = bytes[1]
      code ||= io.getch.b.bytes.first
      return Event.key(WINDOWS_SPECIAL_KEYS[code] || :"windows_special_#{code}")
    elsif char == "\e" # Detect escape sequence
      sequence = char.b.bytes.drop(1).pack('C*')

      sleep 0.01
      while IO.select([io], nil, nil, 0)
        next_char = io.getch
        break unless next_char

        sequence << next_char
        return read_bracketed_paste(io) if sequence == "[200~"
        break if complete_escape_sequence?(sequence)
      end

      if sequence.empty?
        return Event.key(:escape)
      elsif sequence == "\r" || sequence == "\n"
        return Event.key(:alt_enter)
      elsif (mouse_event = parse_sgr_mouse(sequence))
        return mouse_event
      else
        return Event.key(ESCAPE_SEQUENCES[sequence] || :"ansi_#{sequence.inspect}")
      end
    # Handle Ctrl combinations (excluding Tab and Enter)
    elsif byte.between?(1, 8) || byte.between?(10, 26)
      ctrl_char = (byte + 64).chr.downcase
      return Event.key("ctrl_#{ctrl_char}".to_sym)
    else
      if IO.select([io], nil, nil, 0)
        Event.key(:paste, value: collect_pending_input(io, char))
      else
        Event.key(:string, value: char)
      end
    end
  end
end

#log(message, *objects, sep: ' ', end_char: "\n") ⇒ Object 



79
80
81
82
83
84
 
# File 'lib/ruby_rich/console.rb', line 79

def log(message, *objects, sep: ' ', end_char: "\n")
  timestamp = Time.now.strftime("%Y-%m-%d %H:%M:%S")
  log_message = "[#{timestamp}] LOG: #{message} #{objects.map(&:to_s).join(sep)}"
  add_line(log_message)
  render
end

#parse_sgr_mouse(sequence) ⇒ Object 



182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/ruby_rich/console.rb', line 182

def parse_sgr_mouse(sequence)
  match = sequence.match(/\A\[<(\d+);(\d+);(\d+)([Mm])\z/)
  return nil unless match

  code = match[1].to_i
  raw_x = match[2].to_i
  raw_y = match[3].to_i
  terminator = match[4]
  button = mouse_button(code)
  name = mouse_event_name(code, terminator)
  direction = mouse_wheel_direction(code)

  Event.mouse(
    name,
    button: button,
    x: raw_x - 1,
    y: raw_y - 1,
    raw_x: raw_x,
    raw_y: raw_y,
    code: code,
    modifiers: mouse_modifiers(code),
    direction: direction
  )
end

#print(*objects, sep: ' ', end_char: "\n", immediate: false) ⇒ Object 



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/ruby_rich/console.rb', line 60

def print(*objects, sep: ' ', end_char: "\n", immediate: false)
  line_text = objects.map do |obj|
    if obj.is_a?(String) && obj.include?('[')
      # 处理 Rich markup 标记
      RichText.markup(obj)
    else
      obj.to_s
    end
  end.join(sep)
  
  if immediate
    add_line(line_text)
    render
  else
    # 简单输出，不使用 Console 的缓冲和渲染系统
    Kernel.puts line_text
  end
end

#render ⇒ Object 



215
216
217
218
219
220
221
222
223
 
# File 'lib/ruby_rich/console.rb', line 215

def render
  clear
  @lines.each_with_index do |line, index|
    formatted_line = format_line(line)
    @buffer << formatted_line
    Kernel.puts formatted_line
    Kernel.puts "\n" * @layout[:spacing] if index < @lines.size - 1
  end
end

#rule(title: nil, characters: '#', style: 'bold') ⇒ Object 



86
87
88
89
90
91
92
93
94
95
 
# File 'lib/ruby_rich/console.rb', line 86

def rule(title: nil, characters: '#', style: 'bold')
  rule_line = characters * 80
  if title
    formatted_title = " #{title} ".center(80, characters)
    add_line(formatted_title)
  else
    add_line(rule_line)
  end
  render
end

#set_layout(spacing: 1, align: :left) ⇒ Object 



51
52
53
54
 
# File 'lib/ruby_rich/console.rb', line 51

def set_layout(spacing: 1, align: :left)
  @layout[:spacing] = spacing
  @layout[:align] = align
end

#style(name, **attributes) ⇒ Object 



56
57
58
 
# File 'lib/ruby_rich/console.rb', line 56

def style(name, **attributes)
  @styles[name] = attributes
end

#update_line(index, text) ⇒ Object 



225
226
227
228
229
 
# File 'lib/ruby_rich/console.rb', line 225

def update_line(index, text)
  return unless index.between?(0, @lines.size - 1)
  @lines[index] = text
  render
end