Class: Textbringer::Window

Inherits:
Object
  • Object
show all
Defined in:
lib/textbringer/window.rb

Direct Known Subclasses

EchoArea

Constant Summary collapse

KEY_NAMES = 
{}
HAVE_GET_KEY_MODIFIERS = 
defined?(Curses.get_key_modifiers)
ALT_NUMBER_BASE = 
Curses::ALT_0 - ?0.ord
ALT_ALPHA_BASE = 
Curses::ALT_A - ?a.ord
@@started = 
false
@@list = 
[]
@@current = 
nil
@@echo_area = 
nil
@@has_colors = 
false

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(lines, columns, y, x) ⇒ Window

Returns a new instance of Window.



220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/textbringer/window.rb', line 220

def initialize(lines, columns, y, x)
  @lines = lines
  @columns = columns
  @y = y
  @x = x
  initialize_window(lines, columns, y, x)
  @window.keypad = true
  @window.scrollok(false)
  @window.idlok(true)
  @buffer = nil
  @top_of_window = nil
  @bottom_of_window = nil
  @point_mark = nil
  @deleted = false
  @raw_key_buffer = []
  @key_buffer = []
end

Instance Attribute Details

#bottom_of_window ⇒ Object (readonly)

Returns the value of attribute bottom_of_window.



218
219
220
 
# File 'lib/textbringer/window.rb', line 218

def bottom_of_window
  @bottom_of_window
end

#buffer ⇒ Object

Returns the value of attribute buffer.



217
218
219
 
# File 'lib/textbringer/window.rb', line 217

def buffer
  @buffer
end

#columns ⇒ Object (readonly)

Returns the value of attribute columns.



217
218
219
 
# File 'lib/textbringer/window.rb', line 217

def columns
  @columns
end

#lines ⇒ Object (readonly)

Returns the value of attribute lines.



217
218
219
 
# File 'lib/textbringer/window.rb', line 217

def lines
  @lines
end

#mode_line ⇒ Object (readonly)

Returns the value of attribute mode_line.



217
218
219
 
# File 'lib/textbringer/window.rb', line 217

def mode_line
  @mode_line
end

#top_of_window ⇒ Object (readonly)

Returns the value of attribute top_of_window.



218
219
220
 
# File 'lib/textbringer/window.rb', line 218

def top_of_window
  @top_of_window
end

#window ⇒ Object (readonly)

Returns the value of attribute window.



217
218
219
 
# File 'lib/textbringer/window.rb', line 217

def window
  @window
end

#x ⇒ Object (readonly)

Returns the value of attribute x.



217
218
219
 
# File 'lib/textbringer/window.rb', line 217

def x
  @x
end

#y ⇒ Object (readonly)

Returns the value of attribute y.



217
218
219
 
# File 'lib/textbringer/window.rb', line 217

def y
  @y
end

Class Method Details

.beep ⇒ Object 



213
214
215
 
# File 'lib/textbringer/window.rb', line 213

def self.beep
  Curses.beep
end

.colors ⇒ Object 



106
107
108
 
# File 'lib/textbringer/window.rb', line 106

def self.colors
  Curses.colors
end

.columns ⇒ Object 



186
187
188
 
# File 'lib/textbringer/window.rb', line 186

def self.columns
  Curses.cols
end

.current ⇒ Object 



32
33
34
 
# File 'lib/textbringer/window.rb', line 32

def self.current
  @@current
end

.current=(window) ⇒ Object 



36
37
38
39
40
41
42
43
44
 
# File 'lib/textbringer/window.rb', line 36

def self.current=(window)
  if window.deleted?
    window = @@list.first
  end
  @@current.save_point if @@current && !@@current.deleted?
  @@current = window
  @@current.restore_point
  Buffer.current = window.buffer
end

.delete_other_windows ⇒ Object 



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/textbringer/window.rb', line 69

def self.delete_other_windows
  if @@current.echo_area?
    raise EditorError, "Can't expand the echo area to full screen"
  end
  @@list.delete_if do |window|
    if window.current? || window.echo_area?
      false
    else
      window.delete
      true
    end
  end
  @@current.move(0, 0)
  @@current.resize(Window.lines - 1, @@current.columns)
end

.delete_window(target = @@current) ⇒ Object 



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/textbringer/window.rb', line 46

def self.delete_window(target = @@current)
  if target.echo_area?
    raise EditorError, "Can't delete the echo area"
  end
  if @@list.size == 2
    raise EditorError, "Can't delete the sole window"
  end
  i = @@list.index(target)
  return if i.nil?
  if i == 0
    window = @@list[1]
    window.move(0, 0)
  else
    window = @@list[i - 1]
  end
  window.resize(target.lines + window.lines, window.columns)
  target.delete
  @@list.delete_at(i)
  if target == @@current
    self.current = window
  end
end

.echo_area ⇒ Object 



94
95
96
 
# File 'lib/textbringer/window.rb', line 94

def self.echo_area
  @@echo_area
end

.has_colors=(value) ⇒ Object 



98
99
100
 
# File 'lib/textbringer/window.rb', line 98

def self.has_colors=(value)
  @@has_colors = value
end

.has_colors? ⇒ Boolean

Returns:

  • (Boolean) 


102
103
104
 
# File 'lib/textbringer/window.rb', line 102

def self.has_colors?
  @@has_colors
end

.lines ⇒ Object 



182
183
184
 
# File 'lib/textbringer/window.rb', line 182

def self.lines
  Curses.lines
end

.list(include_echo_area: false) ⇒ Object 



24
25
26
27
28
29
30
 
# File 'lib/textbringer/window.rb', line 24

def self.list(include_echo_area: false)
  if include_echo_area
    @@list.dup
  else
    @@list.reject(&:echo_area?)
  end
end

.load_faces ⇒ Object 



115
116
117
118
 
# File 'lib/textbringer/window.rb', line 115

def self.load_faces
  require_relative "faces/basic"
  require_relative "faces/programming"
end

.other_window ⇒ Object 



85
86
87
88
89
90
91
92
 
# File 'lib/textbringer/window.rb', line 85

def self.other_window
  i = @@list.index(@@current)
  begin
    i += 1
    window = @@list[i % @@list.size]
  end while !window.active?
  self.current = window
end

.redisplay ⇒ Object 



160
161
162
163
164
165
166
167
168
 
# File 'lib/textbringer/window.rb', line 160

def self.redisplay
  return if Controller.current.executing_keyboard_macro?
  return if Window.current.has_input?
  @@list.each do |window|
    window.redisplay unless window.current?
  end
  current.redisplay
  update
end

.redraw ⇒ Object 



170
171
172
173
174
175
176
 
# File 'lib/textbringer/window.rb', line 170

def self.redraw
  @@list.each do |window|
    window.redraw unless window.current?
  end
  current.redraw
  update
end

.resize ⇒ Object 



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/textbringer/window.rb', line 190

def self.resize
  @@list.delete_if do |window|
    if !window.echo_area? &&
        window.y > Window.lines - CONFIG[:window_min_height]
      window.delete
      true
    else
      false
    end
  end
  @@list.each_with_index do |window, i|
    unless window.echo_area?
      if i < @@list.size - 2
        window.resize(window.lines, Window.columns)
      else
        window.resize(Window.lines - 1 - window.y, Window.columns)
      end
    end
  end
  @@echo_area.move(Window.lines - 1, 0)
  @@echo_area.resize(1, Window.columns)
end

.set_default_colors(fg, bg) ⇒ Object 



110
111
112
113
 
# File 'lib/textbringer/window.rb', line 110

def self.set_default_colors(fg, bg)
  Curses.assume_default_colors(Color[fg], Color[bg])
  Window.redraw
end

.start ⇒ Object 



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
 
# File 'lib/textbringer/window.rb', line 120

def self.start
  if @@started
    raise EditorError, "Already started"
  end
  Curses.init_screen
  Curses.noecho
  Curses.raw
  Curses.nonl
  self.has_colors = Curses.has_colors?
  if has_colors?
    Curses.start_color
    Curses.use_default_colors
    load_faces
  end
  begin
    window =
      Textbringer::Window.new(Window.lines - 1, Window.columns, 0, 0)
    window.buffer = Buffer.new_buffer("*scratch*")
    @@list.push(window)
    Window.current = window
    @@echo_area = Textbringer::EchoArea.new(1, Window.columns,
                                            Window.lines - 1, 0)
    Buffer.minibuffer.keymap = MINIBUFFER_LOCAL_MAP
    @@echo_area.buffer = Buffer.minibuffer
    @@list.push(@@echo_area)
    @@started = true
    yield
  ensure
    @@list.each do |win|
      win.close
    end
    @@list.clear
    Curses.echo
    Curses.noraw
    Curses.nl
    Curses.close_screen
    @@started = false
  end
end

.update ⇒ Object 



178
179
180
 
# File 'lib/textbringer/window.rb', line 178

def self.update
  Curses.doupdate
end

Instance Method Details

#active? ⇒ Boolean

Returns:

  • (Boolean) 


242
243
244
 
# File 'lib/textbringer/window.rb', line 242

def active?
  true
end

#close ⇒ Object 



261
262
263
 
# File 'lib/textbringer/window.rb', line 261

def close
  @window.close
end

#current? ⇒ Boolean

Returns:

  • (Boolean) 


291
292
293
 
# File 'lib/textbringer/window.rb', line 291

def current?
  self == @@current
end

#delete ⇒ Object 



250
251
252
253
254
255
256
257
258
259
 
# File 'lib/textbringer/window.rb', line 250

def delete
  unless @deleted
    if current?
      Window.current = @@list.first
    end
    delete_marks
    @window.close
    @deleted = true
  end
end

#deleted? ⇒ Boolean

Returns:

  • (Boolean) 


246
247
248
 
# File 'lib/textbringer/window.rb', line 246

def deleted?
  @deleted
end

#echo_area? ⇒ Boolean

Returns:

  • (Boolean) 


238
239
240
 
# File 'lib/textbringer/window.rb', line 238

def echo_area?
  false
end

#enlarge(n) ⇒ Object 



569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
 
# File 'lib/textbringer/window.rb', line 569

def enlarge(n)
  if n > 0
    max_height = Window.lines -
      CONFIG[:window_min_height] * (@@list.size - 2) - 1
    new_lines = [lines + n, max_height].min
    needed_lines = new_lines - lines
    resize(new_lines, columns)
    i = @@list.index(self)
    indices = (i + 1).upto(@@list.size - 2).to_a +
      (i - 1).downto(0).to_a
    indices.each do |j|
      break if needed_lines == 0
      window = @@list[j]
      extended_lines = [
        window.lines - CONFIG[:window_min_height],
        needed_lines
      ].min
      window.resize(window.lines - extended_lines, window.columns)
      needed_lines -= extended_lines
    end
    y = 0
    @@list.each do |win|
      win.move(y, win.x)
      y += win.lines
    end
  elsif n < 0 && @@list.size > 2
    new_lines = [lines + n, CONFIG[:window_min_height]].max
    diff = lines - new_lines
    resize(new_lines, columns)
    i = @@list.index(self)
    if i < @@list.size - 2
      window = @@list[i + 1]
      window.move(window.y - diff, window.x)
    else
      window = @@list[i - 1]
      move(self.y + diff, self.x)
    end
    window.resize(window.lines + diff, window.columns)
  end
end

#has_input? ⇒ Boolean

Returns:

  • (Boolean) 


338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/textbringer/window.rb', line 338

def has_input?
  if !@raw_key_buffer.empty? || !@key_buffer.empty?
    return true
  end
  @window.nodelay = true
  begin
    c = @window.get_char
    if c
      @raw_key_buffer.push(c)
    end
    !c.nil?
  ensure
    @window.nodelay = false
  end
end

#highlight ⇒ Object 



354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
 
# File 'lib/textbringer/window.rb', line 354

def highlight
  @highlight_on = {}
  @highlight_off = {}
  return if !@@has_colors || !CONFIG[:syntax_highlight] || @buffer.binary?
  syntax_table = @buffer.mode.syntax_table || DEFAULT_SYNTAX_TABLE
  if @buffer.bytesize < CONFIG[:highlight_buffer_size_limit]
    base_pos = @buffer.point_min
    s = @buffer.to_s
  else
    base_pos = @buffer.point
    len = columns * (lines - 1) / 2 * 3
    s = @buffer.substring(@buffer.point, @buffer.point + len).scrub("")
  end
  return if !s.valid_encoding?
  re_str = syntax_table.map { |name, re|
    "(?<#{name}>#{re})"
  }.join("|")
  re = Regexp.new(re_str)
  names = syntax_table.keys
  s.scan(re) do
    b = base_pos + $`.bytesize
    e = b + $&.bytesize
    if b < @buffer.point && @buffer.point < e
      b = @buffer.point
    end
    name = names.find { |n| $~[n] }
    attributes = Face[name]&.attributes
    if attributes
      @highlight_on[b] = attributes
      @highlight_off[e] = attributes
    end
  end
end

#move(y, x) ⇒ Object 



494
495
496
497
498
499
 
# File 'lib/textbringer/window.rb', line 494

def move(y, x)
  @y = y
  @x = x
  @window.move(y, x)
  @mode_line.move(y + @window.maxy, x)
end

#read_event ⇒ Object 



295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/textbringer/window.rb', line 295

def read_event
  key = get_char
  if key.is_a?(Integer)
    if HAVE_GET_KEY_MODIFIERS
      if Curses::ALT_0 <= key && key <= Curses::ALT_9
        @key_buffer.push((key - ALT_NUMBER_BASE).chr)
        return "\e"
      elsif Curses::ALT_A <= key && key <= Curses::ALT_Z
        @key_buffer.push((key - ALT_ALPHA_BASE).chr)
        return "\e"
      end
    end
    KEY_NAMES[key] || key
  else
    key&.encode(Encoding::UTF_8)
  end
end

#read_event_nonblock ⇒ Object 



313
314
315
316
317
318
319
320
 
# File 'lib/textbringer/window.rb', line 313

def read_event_nonblock
  @window.nodelay = true
  begin
    read_event
  ensure
    @window.nodelay = false
  end
end

#recenter ⇒ Object 



509
510
511
512
513
514
515
516
517
518
519
520
 
# File 'lib/textbringer/window.rb', line 509

def recenter
  @buffer.save_point do |saved|
    max = (lines - 1) / 2
    count = beginning_of_line_and_count(max)
    while count < max
      break if @buffer.point == 0
      @buffer.backward_char
      count += beginning_of_line_and_count(max - count - 1) + 1
    end
    @buffer.mark_to_point(@top_of_window)
  end
end

#recenter_if_needed ⇒ Object 



522
523
524
525
526
527
 
# File 'lib/textbringer/window.rb', line 522

def recenter_if_needed
  if @buffer.point_before_mark?(@top_of_window) ||
     @buffer.point_after_mark?(@bottom_of_window)
    recenter
  end
end

#redisplay ⇒ Object 



388
389
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
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
 
# File 'lib/textbringer/window.rb', line 388

def redisplay
  return if @buffer.nil?
  redisplay_mode_line
  @buffer.save_point do |saved|
    if current?
      point = saved
    else
      point = @point_mark
      @buffer.point_to_mark(@point_mark)
    end
    framer
    y = x = 0
    @buffer.point_to_mark(@top_of_window)
    highlight
    @window.erase
    @window.setpos(0, 0)
    @window.attrset(0)
    if current? && @buffer.visible_mark &&
       @buffer.point_after_mark?(@buffer.visible_mark)
      @window.attron(Curses::A_REVERSE)
    end
    while !@buffer.end_of_buffer?
      cury, curx = @window.cury, @window.curx
      if @buffer.point_at_mark?(point)
        y, x = cury, curx
        if current? && @buffer.visible_mark
          if @buffer.point_after_mark?(@buffer.visible_mark)
            @window.attroff(Curses::A_REVERSE)
          elsif @buffer.point_before_mark?(@buffer.visible_mark)
            @window.attron(Curses::A_REVERSE)
          end
        end
      end
      if current? && @buffer.visible_mark &&
         @buffer.point_at_mark?(@buffer.visible_mark)
        if @buffer.point_after_mark?(point)
          @window.attroff(Curses::A_REVERSE)
        elsif @buffer.point_before_mark?(point)
          @window.attron(Curses::A_REVERSE)
        end
      end
      if attrs = @highlight_off[@buffer.point]
        @window.attroff(attrs)
      end
      if attrs = @highlight_on[@buffer.point]
        @window.attron(attrs)
      end
      c = @buffer.char_after
      if c == "\n"
        @window.clrtoeol
        break if cury == lines - 2   # lines include mode line
        @window.setpos(cury + 1, 0)
        @buffer.forward_char
        next
      elsif c == "\t"
        n = calc_tab_width(curx)
        c = " " * n
      else
        c = escape(c)
      end
      if curx < columns - 4
        newx = nil
      else
        newx = curx + Buffer.display_width(c)
        if newx > columns
          if cury == lines - 2
            break
          else
            @window.clrtoeol
            @window.setpos(cury + 1, 0)
          end
        end
      end
      if Buffer.display_width(c) == 0
        # ncurses on macOS prints U+FEFF, U+FE0F etc. as space,
        # so ignore it
      else
        @window.addstr(c)
      end
      break if newx == columns && cury == lines - 2
      @buffer.forward_char
    end
    if current? && @buffer.visible_mark
      @window.attroff(Curses::A_REVERSE)
    end
    @buffer.mark_to_point(@bottom_of_window)
    if @buffer.point_at_mark?(point)
      y, x = @window.cury, @window.curx
    end
    if x == columns - 1
      c = @buffer.char_after(point.location)
      if c && Buffer.display_width(c) > 1
        y += 1
        x = 0
      end
    end
    @window.setpos(y, x)
    @window.noutrefresh
  end
end

#redraw ⇒ Object 



489
490
491
492
 
# File 'lib/textbringer/window.rb', line 489

def redraw
  @window.redraw
  @mode_line.redraw
end

#resize(lines, columns) ⇒ Object 



501
502
503
504
505
506
507
 
# File 'lib/textbringer/window.rb', line 501

def resize(lines, columns)
  @lines = lines
  @columns = columns
  @window.resize(lines - 1, columns)
  @mode_line.move(@y + lines - 1, @x)
  @mode_line.resize(1, columns)
end

#restore_point ⇒ Object 



287
288
289
 
# File 'lib/textbringer/window.rb', line 287

def restore_point
  @buffer.point_to_mark(@point_mark)
end

#save_point ⇒ Object 



279
280
281
282
283
284
285
 
# File 'lib/textbringer/window.rb', line 279

def save_point
  @buffer[:top_of_window] ||= @buffer.new_mark
  @buffer[:top_of_window].location = @top_of_window.location
  @buffer[:bottom_of_window] ||= @buffer.new_mark
  @buffer[:bottom_of_window].location = @bottom_of_window.location
  @buffer.mark_to_point(@point_mark)
end

#scroll_down ⇒ Object 



539
540
541
542
543
544
545
546
547
 
# File 'lib/textbringer/window.rb', line 539

def scroll_down
  if @top_of_window.location == @buffer.point_min
    raise RangeError, "Beginning of buffer"
  end
  @buffer.point_to_mark(@top_of_window)
  @buffer.next_line
  @buffer.beginning_of_line
  @top_of_window.location = 0
end

#scroll_up ⇒ Object 



529
530
531
532
533
534
535
536
537
 
# File 'lib/textbringer/window.rb', line 529

def scroll_up
  if @bottom_of_window.location == @buffer.point_max
    raise RangeError, "End of buffer"
  end
  @buffer.point_to_mark(@bottom_of_window)
  @buffer.previous_line
  @buffer.beginning_of_line
  @buffer.mark_to_point(@top_of_window)
end

#shrink(n) ⇒ Object 



610
611
612
 
# File 'lib/textbringer/window.rb', line 610

def shrink(n)
  enlarge(-n)
end

#shrink_if_larger_than_buffer ⇒ Object 



614
615
616
617
618
619
620
621
622
623
624
625
626
627
 
# File 'lib/textbringer/window.rb', line 614

def shrink_if_larger_than_buffer
  @buffer.save_point do
    @buffer.end_of_buffer
    @buffer.skip_re_backward(/\s/)
    count = beginning_of_line_and_count(Window.lines) + 1
    while !@buffer.beginning_of_buffer?
      @buffer.backward_char
      count += beginning_of_line_and_count(Window.lines) + 1
    end
    if lines - 1 > count
      shrink(lines - 1 - count)
    end
  end
end

#split(other_lines = nil) ⇒ Object 



549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
 
# File 'lib/textbringer/window.rb', line 549

def split(other_lines = nil)
  old_lines = lines
  if other_lines
    if other_lines < CONFIG[:window_min_height]
      raise EditorError, "Window too small"
    end
    new_lines = lines - other_lines
  else
    new_lines = (old_lines / 2.0).ceil
  end
  if new_lines < CONFIG[:window_min_height]
    raise EditorError, "Window too small"
  end
  resize(new_lines, columns)
  new_window = Window.new(old_lines - new_lines, columns, y + new_lines, x)
  new_window.buffer = buffer
  i = @@list.index(self)
  @@list.insert(i + 1, new_window)
end

#wait_input(msecs) ⇒ Object 



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

def wait_input(msecs)
  if !@raw_key_buffer.empty? || !@key_buffer.empty?
    return @raw_key_buffer.first || @key_buffer.first
  end
  @window.timeout = msecs
  begin
    c = @window.get_char
    if c
      @raw_key_buffer.push(c)
    end
    c
  ensure
    @window.timeout = -1
  end
end