Class: Muxr::Terminal

Inherits:
Object
  • Object
show all
Defined in:
lib/muxr/terminal.rb

Overview

A minimal VT100/ANSI terminal emulator. It maintains a fixed grid of cells plus a cursor and parser state. Bytes fed from a PTY are interpreted into mutations of the grid which the Renderer then composites into the final frame. The emulator implements enough of the protocol to host typical interactive shells (bash, zsh) and line-oriented programs.

Defined Under Namespace

Classes: Cell

Constant Summary collapse

BOLD = 
1
UNDERLINE = 
2
REVERSE = 
4
DIM = 
8
SCROLLBACK_MAX = 
5000

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(rows: 24, cols: 80) ⇒ Terminal

Returns a new instance of Terminal.



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/muxr/terminal.rb', line 33

def initialize(rows: 24, cols: 80)
  @rows = rows
  @cols = cols
  @buffer = Array.new(rows) { Array.new(cols) { blank_cell } }
  @cursor_row = 0
  @cursor_col = 0
  @saved_cursor = [0, 0]
  @fg = nil
  @bg = nil
  @attrs = 0
  @autowrap_pending = false
  @scroll_top = 0
  @scroll_bottom = rows - 1
  @parser_state = :ground
  @parser_params = +""
  @feed_remainder = +"".b
  @dirty = true
  @scrollback = []
  @view_offset = 0
  @selection_anchor = nil
  @selection_cursor = nil
  @selection_mode = :linear
end

Instance Attribute Details

#cols ⇒ Object (readonly)

Returns the value of attribute cols.



31
32
33
 
# File 'lib/muxr/terminal.rb', line 31

def cols
  @cols
end

#cursor_col ⇒ Object (readonly)

Returns the value of attribute cursor_col.



31
32
33
 
# File 'lib/muxr/terminal.rb', line 31

def cursor_col
  @cursor_col
end

#cursor_row ⇒ Object (readonly)

Returns the value of attribute cursor_row.



31
32
33
 
# File 'lib/muxr/terminal.rb', line 31

def cursor_row
  @cursor_row
end

#rows ⇒ Object (readonly)

Returns the value of attribute rows.



31
32
33
 
# File 'lib/muxr/terminal.rb', line 31

def rows
  @rows
end

#selection_mode ⇒ Object (readonly)

Returns the value of attribute selection_mode.



57
58
59
 
# File 'lib/muxr/terminal.rb', line 57

def selection_mode
  @selection_mode
end

#view_offset ⇒ Object (readonly)

Returns the value of attribute view_offset.



31
32
33
 
# File 'lib/muxr/terminal.rb', line 31

def view_offset
  @view_offset
end

Instance Method Details

#anchor_selection!(mode: :linear) ⇒ Object

Drop the anchor at the cursor’s current position. ‘mode` controls the selection shape: :linear (character-by-character, reading order) or :block (rectangular).



128
129
130
131
132
133
 
# File 'lib/muxr/terminal.rb', line 128

def anchor_selection!(mode: :linear)
  return unless @selection_cursor
  @selection_anchor = @selection_cursor.dup
  @selection_mode = mode
  @dirty = true
end

#cell(r, c) ⇒ Object 



59
60
61
 
# File 'lib/muxr/terminal.rb', line 59

def cell(r, c)
  @buffer[r][c]
end

#clear_anchor! ⇒ Object

Drop the anchor but keep the cursor so the user can continue navigating (vim’s behavior when pressing v while already in linear visual mode).



137
138
139
140
141
 
# File 'lib/muxr/terminal.rb', line 137

def clear_anchor!
  return unless @selection_anchor
  @selection_anchor = nil
  @dirty = true
end

#clear_dirty! ⇒ Object 



339
340
341
 
# File 'lib/muxr/terminal.rb', line 339

def clear_dirty!
  @dirty = false
end

#clear_selection ⇒ Object 



277
278
279
280
281
282
 
# File 'lib/muxr/terminal.rb', line 277

def clear_selection
  return unless @selection_anchor
  @selection_anchor = nil
  @selection_cursor = nil
  @dirty = true
end

#dirty? ⇒ Boolean

Returns:

  • (Boolean) 


335
336
337
 
# File 'lib/muxr/terminal.rb', line 335

def dirty?
  @dirty
end

#extract_selection_text ⇒ Object 



298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/muxr/terminal.rb', line 298

def extract_selection_text
  return "" unless @selection_anchor
  if @selection_mode == :block
    ar, ac = @selection_anchor
    br, bc = @selection_cursor
    min_r, max_r = ar <= br ? [ar, br] : [br, ar]
    min_c, max_c = ac <= bc ? [ac, bc] : [bc, ac]
    lines = []
    (min_r..max_r).each do |tr|
      row = timeline_row(tr)
      if row.nil? || min_c >= row.length
        lines << ""
        next
      end
      last = [max_c, row.length - 1].min
      chars = (min_c..last).map { |c| row[c]&.char || " " }
      lines << chars.join.rstrip
    end
    return lines.join("\n")
  end
  sr, sc, er, ec = ordered_selection
  lines = []
  (sr..er).each do |tr|
    row = timeline_row(tr)
    if row.nil?
      lines << ""
      next
    end
    first = (tr == sr) ? sc : 0
    last = (tr == er) ? ec : row.length - 1
    last = [last, row.length - 1].min
    chars = (first..last).map { |c| row[c]&.char || " " }
    lines << chars.join.rstrip
  end
  lines.join("\n")
end

#feed(data) ⇒ Object 



369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
 
# File 'lib/muxr/terminal.rb', line 369

def feed(data)
  bytes = @feed_remainder + data.b
  @feed_remainder = +"".b
  str = bytes.dup.force_encoding(Encoding::UTF_8)
  unless str.valid_encoding?
    # Find the longest valid UTF-8 prefix and stash the remainder for the
    # next feed call so multi-byte characters don't get garbled across PTY
    # read boundaries.
    raw = bytes.bytes
    while raw.any?
      candidate = raw.pack("C*").force_encoding(Encoding::UTF_8)
      break if candidate.valid_encoding?
      @feed_remainder = ([raw.last] + @feed_remainder.bytes).pack("C*").b
      raw.pop
    end
    str = raw.pack("C*").force_encoding(Encoding::UTF_8)
    # Bail out completely if we couldn't decode anything yet.
    return if str.empty?
  end
  str.each_char { |c| process_char(c) }
  @dirty = true
end

#move_selection_cursor_by(dr, dc) ⇒ Object 



149
150
151
152
153
154
155
156
157
158
 
# File 'lib/muxr/terminal.rb', line 149

def move_selection_cursor_by(dr, dc)
  return unless @selection_cursor
  tr, tc = @selection_cursor
  ntr = (tr + dr).clamp(0, timeline_size - 1)
  ntc = (tc + dc).clamp(0, @cols - 1)
  return if ntr == tr && ntc == tc
  @selection_cursor = [ntr, ntc]
  ensure_selection_cursor_visible
  @dirty = true
end

#place_selection_cursor(r, c) ⇒ Object

Place the moving cursor at a viewport position without dropping an anchor — the user is still navigating, not yet selecting.



117
118
119
120
121
122
123
 
# File 'lib/muxr/terminal.rb', line 117

def place_selection_cursor(r, c)
  tr = timeline_row_for_visible(r).clamp(0, timeline_size - 1)
  tc = c.clamp(0, @cols - 1)
  @selection_cursor = [tr, tc]
  @selection_anchor = nil
  @dirty = true
end

#resize(rows, cols) ⇒ Object 



343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'lib/muxr/terminal.rb', line 343

def resize(rows, cols)
  return if rows == @rows && cols == @cols
  new_buf = Array.new(rows) { Array.new(cols) { blank_cell } }
  keep_rows = [rows, @rows].min
  keep_cols = [cols, @cols].min
  src_start = @rows - keep_rows
  keep_rows.times do |i|
    keep_cols.times do |j|
      new_buf[i][j].copy_from(@buffer[src_start + i][j])
    end
  end
  @buffer = new_buf
  @rows = rows
  @cols = cols
  @scroll_top = 0
  @scroll_bottom = rows - 1
  @cursor_row = @cursor_row.clamp(0, rows - 1)
  @cursor_col = @cursor_col.clamp(0, cols - 1)
  @autowrap_pending = false
  # Selection points at timeline rows whose shape can't be remapped
  # meaningfully through a resize, so drop it rather than show a smear.
  @selection_anchor = nil
  @selection_cursor = nil
  @dirty = true
end

#scroll_back(n = 1) ⇒ Object 



87
88
89
 
# File 'lib/muxr/terminal.rb', line 87

def scroll_back(n = 1)
  set_view_offset(@view_offset + n)
end

#scroll_forward(n = 1) ⇒ Object 



91
92
93
 
# File 'lib/muxr/terminal.rb', line 91

def scroll_forward(n = 1)
  set_view_offset(@view_offset - n)
end

#scroll_to_bottom ⇒ Object 



99
100
101
 
# File 'lib/muxr/terminal.rb', line 99

def scroll_to_bottom
  set_view_offset(0)
end

#scroll_to_top ⇒ Object 



95
96
97
 
# File 'lib/muxr/terminal.rb', line 95

def scroll_to_top
  set_view_offset(@scrollback.size)
end

#scrollback_size ⇒ Object 



79
80
81
 
# File 'lib/muxr/terminal.rb', line 79

def scrollback_size
  @scrollback.size
end

#scrolled_back? ⇒ Boolean

Returns:

  • (Boolean) 


83
84
85
 
# File 'lib/muxr/terminal.rb', line 83

def scrolled_back?
  @view_offset > 0
end

#selected_at_visible?(r, c) ⇒ Boolean

Returns:

  • (Boolean) 


284
285
286
287
288
 
# File 'lib/muxr/terminal.rb', line 284

def selected_at_visible?(r, c)
  return false unless @selection_anchor
  tr = timeline_row_for_visible(r)
  inside_selection?(tr, c)
end

#selection_active? ⇒ Boolean

———- selection ———-

Selection coordinates are in the combined “timeline”:

0..scrollback.size-1                 → @scrollback rows
scrollback.size..scrollback.size+rows-1 → @buffer rows

so the selection stays anchored to the same text as the user pages through history.

Returns:

  • (Boolean) 


111
112
113
 
# File 'lib/muxr/terminal.rb', line 111

def selection_active?
  !@selection_anchor.nil?
end

#selection_cursor_to(tr, tc) ⇒ Object 



160
161
162
163
164
165
166
167
 
# File 'lib/muxr/terminal.rb', line 160

def selection_cursor_to(tr, tc)
  return unless @selection_cursor
  ntr = tr.clamp(0, timeline_size - 1)
  ntc = tc.clamp(0, @cols - 1)
  @selection_cursor = [ntr, ntc]
  ensure_selection_cursor_visible
  @dirty = true
end

#selection_cursor_to_bottom ⇒ Object 



183
184
185
 
# File 'lib/muxr/terminal.rb', line 183

def selection_cursor_to_bottom
  selection_cursor_to(timeline_size - 1, @cols - 1)
end

#selection_cursor_to_first_non_blank ⇒ Object 



187
188
189
190
191
 
# File 'lib/muxr/terminal.rb', line 187

def selection_cursor_to_first_non_blank
  return unless @selection_cursor
  tr = @selection_cursor[0]
  selection_cursor_to(tr, first_non_blank_col(tr))
end

#selection_cursor_to_line_end ⇒ Object 



174
175
176
177
 
# File 'lib/muxr/terminal.rb', line 174

def selection_cursor_to_line_end
  return unless @selection_cursor
  selection_cursor_to(@selection_cursor[0], @cols - 1)
end

#selection_cursor_to_line_start ⇒ Object 



169
170
171
172
 
# File 'lib/muxr/terminal.rb', line 169

def selection_cursor_to_line_start
  return unless @selection_cursor
  selection_cursor_to(@selection_cursor[0], 0)
end

#selection_cursor_to_top ⇒ Object 



179
180
181
 
# File 'lib/muxr/terminal.rb', line 179

def selection_cursor_to_top
  selection_cursor_to(0, 0)
end

#selection_cursor_to_viewport(where) ⇒ Object

Jump to top/middle/bottom of the visible viewport (vim H/M/L), landing on the first non-blank column of the destination line.



195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/muxr/terminal.rb', line 195

def selection_cursor_to_viewport(where)
  return unless @selection_cursor
  vr = case where
       when :top    then 0
       when :middle then @rows / 2
       when :bottom then @rows - 1
       end
  return if vr.nil?
  tr = timeline_row_for_visible(vr).clamp(0, timeline_size - 1)
  selection_cursor_to(tr, first_non_blank_col(tr))
end

#selection_cursor_visible ⇒ Object 



290
291
292
293
294
295
296
 
# File 'lib/muxr/terminal.rb', line 290

def selection_cursor_visible
  return nil unless @selection_cursor
  tr, tc = @selection_cursor
  vr = tr - (@scrollback.size - @view_offset)
  return nil unless vr.between?(0, @rows - 1)
  [vr, tc]
end

#selection_cursor_word_backward(big: false) ⇒ Object 



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/muxr/terminal.rb', line 252

def selection_cursor_word_backward(big: false)
  return unless @selection_cursor
  tr, tc = @selection_cursor
  pos = step_backward(tr, tc)
  return unless pos
  tr, tc = pos
  while char_class_at(tr, tc, big: big) == :space
    pos = step_backward(tr, tc)
    unless pos
      selection_cursor_to(tr, tc)
      return
    end
    tr, tc = pos
  end
  cls = char_class_at(tr, tc, big: big)
  loop do
    pos = step_backward(tr, tc)
    if pos.nil? || pos[0] != tr || char_class_at(pos[0], pos[1], big: big) != cls
      selection_cursor_to(tr, tc)
      return
    end
    tr, tc = pos
  end
end

#selection_cursor_word_end(big: false) ⇒ Object 



229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/muxr/terminal.rb', line 229

def selection_cursor_word_end(big: false)
  return unless @selection_cursor
  tr, tc = @selection_cursor
  pos = step_forward(tr, tc)
  return unless pos
  tr, tc = pos
  while char_class_at(tr, tc, big: big) == :space
    pos = step_forward(tr, tc)
    break unless pos
    tr, tc = pos
  end
  return if char_class_at(tr, tc, big: big) == :space
  cls = char_class_at(tr, tc, big: big)
  loop do
    pos = step_forward(tr, tc)
    if pos.nil? || pos[0] != tr || char_class_at(pos[0], pos[1], big: big) != cls
      selection_cursor_to(tr, tc)
      return
    end
    tr, tc = pos
  end
end

#selection_cursor_word_forward(big: false) ⇒ Object 



207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/muxr/terminal.rb', line 207

def selection_cursor_word_forward(big: false)
  return unless @selection_cursor
  tr, tc = @selection_cursor
  prev_cls = char_class_at(tr, tc, big: big)
  loop do
    nxt = step_forward(tr, tc)
    break unless nxt
    ntr, ntc = nxt
    cur_cls = char_class_at(ntr, ntc, big: big)
    # Row boundaries act as whitespace breaks even when the row is fully
    # packed (no trailing pad) — visually the user sees a new line.
    effective_prev = (ntr != tr) ? :space : prev_cls
    if effective_prev != cur_cls && cur_cls != :space
      selection_cursor_to(ntr, ntc)
      return
    end
    tr, tc = ntr, ntc
    prev_cls = cur_cls
  end
  selection_cursor_to(timeline_size - 1, @cols - 1)
end

#start_selection_at_visible(r, c, mode: :linear) ⇒ Object

Convenience for tests: place cursor at (r,c) AND anchor immediately.



144
145
146
147
 
# File 'lib/muxr/terminal.rb', line 144

def start_selection_at_visible(r, c, mode: :linear)
  place_selection_cursor(r, c)
  anchor_selection!(mode: mode)
end

#visible_cell(r, c) ⇒ Object

Returns the Cell that should be visible at (r, c) given the current scrollback view_offset. When view_offset == 0 this is the live grid. When view_offset > 0, rows in the top of the visible area are sourced from @scrollback instead.



67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/muxr/terminal.rb', line 67

def visible_cell(r, c)
  return @buffer[r][c] if @view_offset.zero?
  idx = @scrollback.size - @view_offset + r
  if idx < @scrollback.size
    row = @scrollback[idx]
    return blank_cell if row.nil? || c >= row.length
    row[c]
  else
    @buffer[idx - @scrollback.size][c]
  end
end