Class: Textbringer::Buffer

Inherits:
Object
  • Object
show all
Extended by:
Enumerable
Defined in:
lib/textbringer/buffer.rb

Constant Summary collapse

GAP_SIZE =
256
UNDO_LIMIT =
1000
UTF8_CHAR_LEN =
Hash.new(1)
DEFAULT_DETECT_ENCODING =
->(s) {
  @@auto_detect_encodings.find { |e|
    s.force_encoding(e)
    s.valid_encoding?
  }
}
NKF_DETECT_ENCODING =
->(s) {
  e = NKF.guess(s)
  case e
  when Encoding::US_ASCII
    Encoding::UTF_8
  when Encoding::ASCII_8BIT
    s.force_encoding(Encoding::UTF_8)
    if s.valid_encoding?
      Encoding::UTF_8
    else
      s.force_encoding(Encoding::ASCII_8BIT)
      Encoding::ASCII_8BIT
    end
  else
    e
  end
}
@@auto_detect_encodings =
[
  Encoding::UTF_8,
  Encoding::EUC_JP,
  Encoding::Windows_31J
]
@@detect_encoding_proc =
DEFAULT_DETECT_ENCODING
@@table =
{}
@@list =
[]
@@current =
nil
@@minibuffer =
nil
@@global_mark_ring =
nil

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(s = +"",, name: nil, file_name: nil, file_encoding: , file_mtime: nil, new_file: true, undo_limit: UNDO_LIMIT, read_only: false) ⇒ Buffer

s might not be copied.



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
# File 'lib/textbringer/buffer.rb', line 206

def initialize(s = +"", name: nil,
               file_name: nil,
               file_encoding: CONFIG[:default_file_encoding],
               file_mtime: nil, new_file: true, undo_limit: UNDO_LIMIT,
               read_only: false)
  set_contents(s, file_encoding)
  @name = name
  @file_name = file_name
  self.file_encoding = file_encoding
  @file_mtime = file_mtime
  @new_file = new_file
  @undo_limit = undo_limit
  @point = 0
  @gap_start = 0
  @gap_end = 0
  @marks = []
  @mark = nil
  @mark_ring = Ring.new(CONFIG[:mark_ring_max],
                        on_delete: ->(mark) { mark.delete })
  @current_line = 1
  @current_column = 1  # One-based character count
  @goal_column = nil   # Zero-based display width count
  @undo_stack = []
  @redo_stack = []
  @undoing = false
  @composite_edit_level = 0
  @composite_edit_actions = []
  @version = 0
  @modified = false
  @mode = FundamentalMode.new(self)
  @keymap = nil
  @attributes = {}
  @save_point_level = 0
  @match_offsets = []
  @visible_mark = nil
  @read_only = read_only
  @callbacks = {}
end

Instance Attribute Details

#current_columnObject (readonly)

Returns the value of attribute current_column.



13
14
15
# File 'lib/textbringer/buffer.rb', line 13

def current_column
  @current_column
end

#current_lineObject (readonly)

Returns the value of attribute current_line.



13
14
15
# File 'lib/textbringer/buffer.rb', line 13

def current_line
  @current_line
end

#file_encodingObject

Returns the value of attribute file_encoding.



12
13
14
# File 'lib/textbringer/buffer.rb', line 12

def file_encoding
  @file_encoding
end

#file_formatObject

Returns the value of attribute file_format.



12
13
14
# File 'lib/textbringer/buffer.rb', line 12

def file_format
  @file_format
end

#file_nameObject

Returns the value of attribute file_name.



12
13
14
# File 'lib/textbringer/buffer.rb', line 12

def file_name
  @file_name
end

#keymapObject

Returns the value of attribute keymap.



11
12
13
# File 'lib/textbringer/buffer.rb', line 11

def keymap
  @keymap
end

#marksObject (readonly)

Returns the value of attribute marks.



12
13
14
# File 'lib/textbringer/buffer.rb', line 12

def marks
  @marks
end

#modeObject

Returns the value of attribute mode.



11
12
13
# File 'lib/textbringer/buffer.rb', line 11

def mode
  @mode
end

#nameObject

Returns the value of attribute name.



12
13
14
# File 'lib/textbringer/buffer.rb', line 12

def name
  @name
end

#pointObject (readonly)

Returns the value of attribute point.



12
13
14
# File 'lib/textbringer/buffer.rb', line 12

def point
  @point
end

#visible_markObject (readonly)

Returns the value of attribute visible_mark.



13
14
15
# File 'lib/textbringer/buffer.rb', line 13

def visible_mark
  @visible_mark
end

Class Method Details

.[](name) ⇒ Object



133
134
135
# File 'lib/textbringer/buffer.rb', line 133

def self.[](name)
  @@table[name]
end

.add(buffer) ⇒ Object



90
91
92
93
# File 'lib/textbringer/buffer.rb', line 90

def self.add(buffer)
  @@table[buffer.name] = buffer
  @@list.push(buffer)
end

.auto_detect_encodingsObject



70
71
72
# File 'lib/textbringer/buffer.rb', line 70

def self.auto_detect_encodings
  @@auto_detect_encodings
end

.auto_detect_encodings=(encodings) ⇒ Object



74
75
76
# File 'lib/textbringer/buffer.rb', line 74

def self.auto_detect_encodings=(encodings)
  @@auto_detect_encodings = encodings
end

.bury(buffer = @@current) ⇒ Object



123
124
125
126
127
# File 'lib/textbringer/buffer.rb', line 123

def self.bury(buffer = @@current)
  @@list.delete(buffer)
  @@list.push(buffer)
  @@current = @@list.first
end

.countObject



129
130
131
# File 'lib/textbringer/buffer.rb', line 129

def self.count
  @@table.size
end

.currentObject



95
96
97
# File 'lib/textbringer/buffer.rb', line 95

def self.current
  @@current
end

.current=(buffer) ⇒ Object



99
100
101
102
103
104
105
# File 'lib/textbringer/buffer.rb', line 99

def self.current=(buffer)
  if buffer && buffer.name && @@table.key?(buffer.name)
    @@list.delete(buffer)
    @@list.unshift(buffer)
  end
  @@current = buffer
end

.detect_encoding_procObject



78
79
80
# File 'lib/textbringer/buffer.rb', line 78

def self.detect_encoding_proc
  @@detect_encoding_proc
end

.detect_encoding_proc=(f) ⇒ Object



82
83
84
# File 'lib/textbringer/buffer.rb', line 82

def self.detect_encoding_proc=(f)
  @@detect_encoding_proc = f
end

.display_width(s) ⇒ Object



188
189
190
# File 'lib/textbringer/buffer.rb', line 188

def self.display_width(s)
  Unicode::DisplayWidth.of(s, CONFIG[:east_asian_ambiguous_width])
end

.dump_unsaved_buffers(dir) ⇒ Object



1308
1309
1310
1311
1312
1313
1314
1315
# File 'lib/textbringer/buffer.rb', line 1308

def self.dump_unsaved_buffers(dir)
  FileUtils.mkdir_p(dir)
  @@list.each do |buffer|
    if /\A\*/ !~ buffer.name && buffer.modified?
      buffer.dump(File.expand_path(buffer.object_id.to_s, dir))
    end
  end
end

.dumped_buffers_exist?(dir) ⇒ Boolean

Returns:

  • (Boolean)


1317
1318
1319
# File 'lib/textbringer/buffer.rb', line 1317

def self.dumped_buffers_exist?(dir)
  !Dir.glob(File.expand_path("*.metadata", dir)).empty?
end

.each(&block) ⇒ Object



184
185
186
# File 'lib/textbringer/buffer.rb', line 184

def self.each(&block)
  @@list.each(&block)
end

.find_file(file_name) ⇒ Object



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
# File 'lib/textbringer/buffer.rb', line 151

def self.find_file(file_name)
  file_name = File.expand_path(file_name)
  buffer = @@table.each_value.find { |b|
    b.file_name == file_name
  }
  if buffer.nil?
    name = File.basename(file_name)
    begin
      buffer = Buffer.open(file_name, name: new_buffer_name(name))
      add(buffer)
    rescue Errno::ENOENT
      buffer = new_buffer(name, file_name: file_name)
    end
  end
  buffer
end

.find_or_new(name, **opts) ⇒ Object



137
138
139
# File 'lib/textbringer/buffer.rb', line 137

def self.find_or_new(name, **opts)
  @@table[name] ||= new_buffer(name, **opts)
end

.global_mark_ringObject



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

def self.global_mark_ring
  @@global_mark_ring ||= Ring.new(CONFIG[:global_mark_ring_max])
end

.kill_em_allObject



145
146
147
148
149
# File 'lib/textbringer/buffer.rb', line 145

def self.kill_em_all
  @@table.clear
  @@list.clear
  @@current = nil
end

.lastObject



119
120
121
# File 'lib/textbringer/buffer.rb', line 119

def self.last
  @@list.last
end

.listObject



86
87
88
# File 'lib/textbringer/buffer.rb', line 86

def self.list
  @@list.dup
end

.load(path) ⇒ Object



1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
# File 'lib/textbringer/buffer.rb', line 1297

def self.load(path)
  buffer = Buffer.new(File.binread(path))
   = JSON.parse(File.binread(path + ".metadata"))
  buffer.name = ["name"]
  buffer.file_name = ["file_name"] if ["file_name"]
  buffer.file_encoding = Encoding.find(["file_encoding"])
  buffer.file_format = ["file_format"].intern
  buffer.modified = true
  buffer
end

.load_dumped_buffers(dir) ⇒ Object



1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
# File 'lib/textbringer/buffer.rb', line 1321

def self.load_dumped_buffers(dir)
  Dir.glob(File.expand_path("*.metadata", dir)).map do ||
    path = .sub(/\.metadata\z/, "")
    buffer = Buffer.load(path)
    add(buffer)
    File.unlink()
    File.unlink(path)
    buffer
  end
end

.minibufferObject



107
108
109
# File 'lib/textbringer/buffer.rb', line 107

def self.minibuffer
  @@minibuffer ||= Buffer.new(name: "*Minibuffer*")
end

.namesObject



141
142
143
# File 'lib/textbringer/buffer.rb', line 141

def self.names
  @@table.keys
end

.new_buffer(name, **opts) ⇒ Object



168
169
170
171
172
# File 'lib/textbringer/buffer.rb', line 168

def self.new_buffer(name, **opts)
  buffer = Buffer.new(**opts.merge(name: new_buffer_name(name)))
  add(buffer)
  buffer
end

.new_buffer_name(name) ⇒ Object



174
175
176
177
178
179
180
181
182
# File 'lib/textbringer/buffer.rb', line 174

def self.new_buffer_name(name)
  if @@table.key?(name)
    (2..Float::INFINITY).lazy.map { |i|
      "#{name}<#{i}>"
    }.find { |i| !@@table.key?(i) }
  else
    name
  end
end

.open(file_name, name: File.basename(file_name)) ⇒ Object



365
366
367
368
369
370
371
# File 'lib/textbringer/buffer.rb', line 365

def self.open(file_name, name: File.basename(file_name))
  buffer = Buffer.new(name: name,
                      file_name: file_name, new_file: false)
  buffer.revert
  buffer.read_only = !File.writable?(file_name)
  buffer
end

.other(buffer = @@current) ⇒ Object



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

def self.other(buffer = @@current)
  @@list.find { |buf|  buf != buffer } || Buffer.find_or_new("*scratch*")
end

.region_boundaries(s, e) ⇒ Object



907
908
909
910
911
912
913
# File 'lib/textbringer/buffer.rb', line 907

def self.region_boundaries(s, e)
  if s > e
    [e, s]
  else
    [s, e]
  end
end

Instance Method Details

#[](name) ⇒ Object



349
350
351
352
353
354
355
# File 'lib/textbringer/buffer.rb', line 349

def [](name)
  if @attributes.key?(name)
    @attributes[name]
  else
    CONFIG[name]
  end
end

#[]=(name, value) ⇒ Object



357
358
359
# File 'lib/textbringer/buffer.rb', line 357

def []=(name, value)
  @attributes[name] = value
end

#apply_mode(mode_class) ⇒ Object



1271
1272
1273
1274
1275
# File 'lib/textbringer/buffer.rb', line 1271

def apply_mode(mode_class)
  @keymap = nil
  @mode = mode_class.new(self)
  Utils.run_hooks(mode_class.hook_name)
end

#backward_char(n = 1) ⇒ Object



645
646
647
# File 'lib/textbringer/buffer.rb', line 645

def backward_char(n = 1)
  forward_char(-n)
end

#backward_delete_char(n = 1) ⇒ Object



634
635
636
# File 'lib/textbringer/buffer.rb', line 634

def backward_delete_char(n = 1)
  delete_char(-n)
end

#backward_line(n = 1) ⇒ Object



693
694
695
# File 'lib/textbringer/buffer.rb', line 693

def backward_line(n = 1)
  forward_line(-n)
end

#backward_word(n = 1, regexp: /\p{Letter}|\p{Number}/) ⇒ Object



660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
# File 'lib/textbringer/buffer.rb', line 660

def backward_word(n = 1, regexp: /\p{Letter}|\p{Number}/)
  n.times do
    break if beginning_of_buffer?
    backward_char
    while !beginning_of_buffer? && regexp !~ char_after
      backward_char
    end
    while !beginning_of_buffer? && regexp =~ char_after
      backward_char
    end
    if regexp !~ char_after
      forward_char
    end
  end
end

#beginning_of_bufferObject



718
719
720
721
722
723
724
# File 'lib/textbringer/buffer.rb', line 718

def beginning_of_buffer
  if @save_point_level == 0
    @current_line = 1
    @current_column = 1
  end
  @point = 0
end

#beginning_of_buffer?Boolean

Returns:

  • (Boolean)


726
727
728
# File 'lib/textbringer/buffer.rb', line 726

def beginning_of_buffer?
  @point == 0
end

#beginning_of_lineObject



738
739
740
741
742
743
# File 'lib/textbringer/buffer.rb', line 738

def beginning_of_line
  while !beginning_of_line?
    backward_char
  end
  @point
end

#beginning_of_line?Boolean

Returns:

  • (Boolean)


745
746
747
# File 'lib/textbringer/buffer.rb', line 745

def beginning_of_line?
  beginning_of_buffer? || byte_before == "\n"
end

#binary?Boolean

Returns:

  • (Boolean)


272
273
274
# File 'lib/textbringer/buffer.rb', line 272

def binary?
  @binary
end

#byte_after(location = @point) ⇒ Object



454
455
456
457
458
459
460
# File 'lib/textbringer/buffer.rb', line 454

def byte_after(location = @point)
  if location < @gap_start
    @contents.byteslice(location)
  else
    @contents.byteslice(location + gap_size)
  end
end

#byte_before(location = @point) ⇒ Object



462
463
464
465
466
467
468
# File 'lib/textbringer/buffer.rb', line 462

def byte_before(location = @point)
  if location <= point_min || location > point_max
    nil
  else
    byte_after(location - 1)
  end
end

#byteindex(forward, re, pos) ⇒ Object



1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
# File 'lib/textbringer/buffer.rb', line 1125

def byteindex(forward, re, pos)
  @match_offsets = []
  method = forward ? :index : :rindex
  adjust_gap(0, point_max)
  s = @contents[0...@gap_start]
  if @binary
    offset = pos
  else
    offset = s.byteslice(0, pos).force_encoding(Encoding::UTF_8).size
    s.force_encoding(Encoding::UTF_8)
  end
  begin
    i = s.send(method, re, offset)
    if i
      m = Regexp.last_match
      if m.nil?
        # A bug of rindex
        @match_offsets.push([pos, pos])
        pos
      else
        b = m.pre_match.bytesize
        e = b + m.to_s.bytesize
        if e <= bytesize
          @match_offsets.push([b, e])
          match_beg = m.begin(0)
          match_str = m.to_s
          (1 .. m.size - 1).each do |j|
            cb, ce = m.offset(j)
            if cb.nil?
              @match_offsets.push([nil, nil])
            else
              bb = b + match_str[0, cb - match_beg].bytesize
              be = b + match_str[0, ce - match_beg].bytesize
              @match_offsets.push([bb, be])
            end
          end
          b
        else
          nil
        end
      end
    else
      nil
    end
  end
end

#bytesizeObject Also known as: size



492
493
494
# File 'lib/textbringer/buffer.rb', line 492

def bytesize
  @contents.bytesize - gap_size
end

#char_after(location = @point) ⇒ Object



470
471
472
473
474
475
476
477
# File 'lib/textbringer/buffer.rb', line 470

def char_after(location = @point)
  if @binary
    byte_after(location)
  else
    s = substring(location, location + UTF8_CHAR_LEN[byte_after(location)])
    s.empty? ? nil : s
  end
end

#char_before(location = @point) ⇒ Object



479
480
481
482
483
484
485
486
487
488
489
490
# File 'lib/textbringer/buffer.rb', line 479

def char_before(location = @point)
  if @binary
    byte_before(location)
  else
    if beginning_of_buffer?
      nil
    else
      pos = get_pos(location, -1)
      substring(pos, location)
    end
  end
end

#clearObject



963
964
965
966
967
968
969
970
971
972
973
974
975
976
# File 'lib/textbringer/buffer.rb', line 963

def clear
  check_read_only_flag
  @contents = +""
  @point = @gap_start = @gap_end = 0
  @marks.each do |m|
    m.location = 0
  end
  @current_line = 1
  @current_column = 1
  @goal_column = nil
  self.modified = true
  @undo_stack.clear
  @redo_stack.clear
end

#composite_editObject



1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
# File 'lib/textbringer/buffer.rb', line 1251

def composite_edit
  @composite_edit_level += 1
  begin
    yield
  ensure
    @composite_edit_level -= 1
    if @composite_edit_level == 0 && !@composite_edit_actions.empty?
      action = CompositeAction.new(self,
                                   @composite_edit_actions.first.location)
      @composite_edit_actions.each do |i|
        action.add_action(i)
      end
      action.version = @composite_edit_actions.first.version
      push_undo(action)
      @composite_edit_actions.clear
    end
  end
  fire_callbacks(:modified)
end

#copy_region(s = @point, e = mark, append = false) ⇒ Object



915
916
917
918
919
920
921
922
923
# File 'lib/textbringer/buffer.rb', line 915

def copy_region(s = @point, e = mark, append = false)
  s, e = Buffer.region_boundaries(s, e)
  str = substring(s, e)
  if append && !KILL_RING.empty?
    KILL_RING.current.concat(str)
  else
    KILL_RING.push(str)
  end
end

#current?Boolean

Returns:

  • (Boolean)


325
326
327
# File 'lib/textbringer/buffer.rb', line 325

def current?
  @@current == self
end

#current_symbolObject



1332
1333
1334
1335
1336
# File 'lib/textbringer/buffer.rb', line 1332

def current_symbol
  from = save_point { skip_re_backward(@mode.symbol_pattern); @point }
  to = save_point { skip_re_forward(@mode.symbol_pattern); @point }
  from < to ? substring(from, to) : nil
end

#delete_char(n = 1) ⇒ Object



596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
# File 'lib/textbringer/buffer.rb', line 596

def delete_char(n = 1)
  check_read_only_flag
  adjust_gap
  s = @point
  pos = get_pos(@point, n)
  if n > 0
    str = substring(s, pos)
    # fill the gap with NUL to avoid invalid byte sequence in UTF-8
    @contents[@gap_end...user_to_gap(pos)] = "\0" * (pos - @point)
    @gap_end += pos - @point
    @marks.each do |m|
      if m.location > pos
        m.location -= pos - @point
      elsif m.location > @point
        m.location = @point
      end
    end
    push_undo(DeleteAction.new(self, s, s, str))
    self.modified = true
  elsif n < 0
    str = substring(pos, s)
    update_line_and_column(@point, pos)
    # fill the gap with NUL to avoid invalid byte sequence in UTF-8
    @contents[user_to_gap(pos)...@gap_start] = "\0" * (@point - pos)
    @marks.each do |m|
      if m.location >= @point
        m.location -= @point - pos
      elsif m.location > pos
        m.location = pos
      end
    end
    @point = @gap_start = pos
    push_undo(DeleteAction.new(self, s, pos, str))
    self.modified = true
  end
  @goal_column = nil
end

#delete_region(s = @point, e = mark) ⇒ Object



930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
# File 'lib/textbringer/buffer.rb', line 930

def delete_region(s = @point, e = mark)
  check_read_only_flag
  old_pos = @point
  s, e = Buffer.region_boundaries(s, e)
  update_line_and_column(old_pos, s)
  save_point do
    str = substring(s, e)
    @point = s
    adjust_gap
    len = e - s
    # fill the gap with NUL to avoid invalid byte sequence in UTF-8
    @contents[@gap_end, len] = "\0" * len
    @gap_end += len
    @marks.each do |m|
      if m.location > e
        m.location -= len
      elsif m.location > s
        m.location = s
      end
    end
    push_undo(DeleteAction.new(self, old_pos, s, str))
    self.modified = true
  end
end

#delete_visible_markObject



900
901
902
903
904
905
# File 'lib/textbringer/buffer.rb', line 900

def delete_visible_mark
  if @visible_mark
    @visible_mark.delete
    @visible_mark = nil
  end
end

#display_width(s) ⇒ Object



201
202
203
# File 'lib/textbringer/buffer.rb', line 201

def display_width(s)
  Buffer.display_width(expand_tab(s))
end

#dump(path) ⇒ Object



1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
# File 'lib/textbringer/buffer.rb', line 1286

def dump(path)
  File.binwrite(path, to_s)
   = {
    "name" => name,
    "file_name" => file_name,
    "file_encoding" => file_encoding.name,
    "file_format" => file_format.to_s
  }
  File.binwrite(path + ".metadata", .to_json)
end

#end_of_bufferObject



730
731
732
# File 'lib/textbringer/buffer.rb', line 730

def end_of_buffer
  goto_char(bytesize)
end

#end_of_buffer?Boolean

Returns:

  • (Boolean)


734
735
736
# File 'lib/textbringer/buffer.rb', line 734

def end_of_buffer?
  @point == bytesize
end

#end_of_lineObject



749
750
751
752
753
754
# File 'lib/textbringer/buffer.rb', line 749

def end_of_line
  while !end_of_line?
    forward_char
  end
  @point
end

#end_of_line?Boolean

Returns:

  • (Boolean)


756
757
758
# File 'lib/textbringer/buffer.rb', line 756

def end_of_line?
  end_of_buffer? || byte_after == "\n"
end

#exchange_point_and_mark(mark = @mark) ⇒ Object



786
787
788
789
790
791
792
# File 'lib/textbringer/buffer.rb', line 786

def exchange_point_and_mark(mark = @mark)
  if mark.nil?
    raise EditorError, "The mark is not set"
  end
  update_line_and_column(@point, mark.location)
  @point, mark.location = mark.location, @point
end

#expand_tab(s) ⇒ Object



192
193
194
195
196
197
198
199
# File 'lib/textbringer/buffer.rb', line 192

def expand_tab(s)
  # TODO: Support multibyte characters
  tw = self[:tab_width]
  fmt = "A#{tw}"
  s.b.gsub(/([^\t]{#{tw}})|([^\t]*)\t/n) {
    [$+].pack(fmt)
  }.force_encoding(Encoding::UTF_8)
end

#file_modified?Boolean

Returns:

  • (Boolean)


432
433
434
# File 'lib/textbringer/buffer.rb', line 432

def file_modified?
  !@file_mtime.nil? && File.mtime(@file_name) != @file_mtime
end

#forward_char(n = 1) ⇒ Object



638
639
640
641
642
643
# File 'lib/textbringer/buffer.rb', line 638

def forward_char(n = 1)
  pos = get_pos(@point, n)
  update_line_and_column(@point, pos)
  @point = pos
  @goal_column = nil
end

#forward_line(n = 1) ⇒ Object



676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
# File 'lib/textbringer/buffer.rb', line 676

def forward_line(n = 1)
  if n > 0
    n.times do
      end_of_line
      break if end_of_buffer?
      forward_char
    end
  elsif n < 0
    (-n).times do
      beginning_of_line
      break if beginning_of_buffer?
      backward_char
      beginning_of_line
    end
  end
end

#forward_word(n = 1, regexp: /\p{Letter}|\p{Number}/) ⇒ Object



649
650
651
652
653
654
655
656
657
658
# File 'lib/textbringer/buffer.rb', line 649

def forward_word(n = 1, regexp: /\p{Letter}|\p{Number}/)
  n.times do
    while !end_of_buffer? && regexp !~ char_after
      forward_char
    end
    while !end_of_buffer? && regexp =~ char_after
      forward_char
    end
  end
end

#gap_filled_with_nul?Boolean

Returns:

  • (Boolean)


1247
1248
1249
# File 'lib/textbringer/buffer.rb', line 1247

def gap_filled_with_nul?
  @contents[@gap_start...@gap_end]&.match?(/\A\0*\z/)
end

#get_line_and_column(pos) ⇒ Object



505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
# File 'lib/textbringer/buffer.rb', line 505

def get_line_and_column(pos)
  line = 1 + @contents[0...user_to_gap(pos)].count("\n")
  if pos == point_min
    column = 1
  else
    i = @contents.rindex("\n", user_to_gap(pos - 1))
    if i
      i += 1
    else
      i = 0
    end
    column = 1 + substring(gap_to_user(i), pos).size
  end
  [line, column]
end

#goto_char(pos) ⇒ Object



521
522
523
524
525
526
527
528
529
530
531
532
533
# File 'lib/textbringer/buffer.rb', line 521

def goto_char(pos)
  if pos < 0 || pos > size
    raise RangeError, "Out of buffer"
  end
  if !@binary && byte_after(pos)&.match?(/[\x80-\xbf]/n)
    raise ArgumentError, "Position is in the middle of a character"
  end
  @goal_column = nil
  if @save_point_level == 0
    @current_line, @current_column = get_line_and_column(pos)
  end
  @point = pos
end

#goto_line(n) ⇒ Object



535
536
537
538
539
540
541
542
543
544
545
546
547
548
# File 'lib/textbringer/buffer.rb', line 535

def goto_line(n)
  pos = point_min
  i = 1
  while i < n && pos < @contents.bytesize
    pos = @contents.index("\n", pos)
    break if pos.nil?
    i += 1
    pos += 1
  end
  @point = gap_to_user(pos)
  @current_line = i
  @current_column = 1
  @goal_column = nil
end

#gsub(*args, &block) ⇒ Object



1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
# File 'lib/textbringer/buffer.rb', line 1350

def gsub(*args, &block)
  if block
    s = to_s.gsub(*args) { |*params|
      block.binding.eval('->(backref) { $~ = backref }').call($~)
      block.call(*params)
    }
  else
    s = to_s.gsub(*args)
  end

  composite_edit do
    delete_region(point_min, point_max)
    insert(s)
  end
  self
end

#indent_to(column) ⇒ Object



1277
1278
1279
1280
1281
1282
1283
1284
# File 'lib/textbringer/buffer.rb', line 1277

def indent_to(column)
  s = if self[:indent_tabs_mode]
    "\t" * (column / self[:tab_width]) + " " * (column % self[:tab_width])
  else
    " " * column
  end
  insert(s)
end

#insert(x, merge_undo = false) ⇒ Object



550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
# File 'lib/textbringer/buffer.rb', line 550

def insert(x, merge_undo = false)
  s = x.to_s
  check_read_only_flag
  pos = @point
  size = s.bytesize
  adjust_gap(size)
  @contents[@point, size] = s.b
  @marks.each do |m|
    if m.location > @point
      m.location += size
    end
  end
  @point = @gap_start += size
  update_line_and_column(pos, @point)
  unless @undoing
    if merge_undo && @undo_stack.last.is_a?(InsertAction)
      @undo_stack.last.merge(s)
      @redo_stack.clear
    else
      push_undo(InsertAction.new(self, pos, s))
    end
  end
  self.modified = true
  @goal_column = nil
  self
end

#insert_final_newlineObject



1378
1379
1380
1381
1382
1383
1384
1385
# File 'lib/textbringer/buffer.rb', line 1378

def insert_final_newline
  save_excursion do
    end_of_buffer
    if char_before != "\n"
      insert("\n")
    end
  end
end

#insert_for_yank(s) ⇒ Object



1006
1007
1008
1009
1010
1011
# File 'lib/textbringer/buffer.rb', line 1006

def insert_for_yank(s)
  if @mark.nil? || !point_at_mark?(@mark)
    push_mark
  end
  insert(s)
end

#inspectObject



245
246
247
# File 'lib/textbringer/buffer.rb', line 245

def inspect
  "#<Buffer:#{@name || '0x%x' % object_id}>"
end

#killObject



309
310
311
312
313
314
315
316
317
318
319
# File 'lib/textbringer/buffer.rb', line 309

def kill
  @@table.delete(@name)
  @@list.delete(self)
  if @@current == self
    @@current = nil
  end
  @marks.each do |mark|
    mark.detach
  end
  fire_callbacks(:killed)
end

#kill_line(append = false) ⇒ Object



978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
# File 'lib/textbringer/buffer.rb', line 978

def kill_line(append = false)
  save_point do |saved|
    if end_of_buffer?
      raise RangeError, "End of buffer"
    end
    if char_after == ?\n
      forward_char
    else
      end_of_line
    end
    pos = @point
    point_to_mark(saved)
    kill_region(@point, pos, append)
  end
end

#kill_region(s = @point, e = mark, append = false) ⇒ Object



925
926
927
928
# File 'lib/textbringer/buffer.rb', line 925

def kill_region(s = @point, e = mark, append = false)
  copy_region(s, e, append)
  delete_region(s, e)
end

#kill_word(append = false) ⇒ Object



994
995
996
997
998
999
1000
1001
1002
1003
1004
# File 'lib/textbringer/buffer.rb', line 994

def kill_word(append = false)
  save_point do |saved|
    if end_of_buffer?
      raise RangeError, "End of buffer"
    end
    forward_word
    pos = @point
    point_to_mark(saved)
    kill_region(@point, pos, append)
  end
end

#looking_at?(re) ⇒ Boolean

Returns:

  • (Boolean)


1116
1117
1118
1119
1120
1121
1122
1123
# File 'lib/textbringer/buffer.rb', line 1116

def looking_at?(re)
  if re.is_a?(Regexp)
    r = /\G#{re}/
  else
    r = "\\G(?:#{re})"
  end
  byteindex(true, r, @point) == @point
end

#markObject



828
829
830
831
832
833
# File 'lib/textbringer/buffer.rb', line 828

def mark
  if @mark.nil?
    raise EditorError, "The mark is not set"
  end
  @mark.location
end

#mark_to_point(mark) ⇒ Object



770
771
772
# File 'lib/textbringer/buffer.rb', line 770

def mark_to_point(mark)
  mark.location = @point
end

#match_beginning(n) ⇒ Object



1172
1173
1174
# File 'lib/textbringer/buffer.rb', line 1172

def match_beginning(n)
  @match_offsets[n]&.first
end

#match_end(n) ⇒ Object



1176
1177
1178
# File 'lib/textbringer/buffer.rb', line 1176

def match_end(n)
  @match_offsets[n]&.last
end

#match_string(n) ⇒ Object



1180
1181
1182
1183
1184
1185
1186
1187
# File 'lib/textbringer/buffer.rb', line 1180

def match_string(n)
  b, e = @match_offsets[n]
  if b.nil?
    nil
  else
    substring(b, e)
  end
end

#modified=(modified) ⇒ Object



334
335
336
337
338
339
# File 'lib/textbringer/buffer.rb', line 334

def modified=(modified)
  @modified = modified
  if @composite_edit_level == 0 && modified
    fire_callbacks(:modified)
  end
end

#modified?Boolean

Returns:

  • (Boolean)


341
342
343
# File 'lib/textbringer/buffer.rb', line 341

def modified?
  @modified
end

#new_file?Boolean

Returns:

  • (Boolean)


361
362
363
# File 'lib/textbringer/buffer.rb', line 361

def new_file?
  @new_file
end

#new_mark(location = @point) ⇒ Object



760
761
762
763
764
# File 'lib/textbringer/buffer.rb', line 760

def new_mark(location = @point)
  Mark.new(self, location).tap { |m|
    @marks << m
  }
end

#newlineObject



577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
# File 'lib/textbringer/buffer.rb', line 577

def newline
  indentation = save_point { |saved|
    if char_after&.match?(/[ \t]/)
      next ""
    end
    beginning_of_line
    s = @point
    while char_after&.match?(/[ \t]/)
      forward_char
    end
    str = substring(s, @point)
    if end_of_buffer? || char_after == "\n"
      delete_region(s, @point)
    end
    str
  }
  insert("\n" + indentation)
end

#next_line(n = 1) ⇒ Object



697
698
699
700
701
702
703
704
705
# File 'lib/textbringer/buffer.rb', line 697

def next_line(n = 1)
  column = get_goal_column
  n.times do
    end_of_line
    forward_char
    adjust_column(column)
  end
  @goal_column = column
end

#on(name, &callback) ⇒ Object



329
330
331
332
# File 'lib/textbringer/buffer.rb', line 329

def on(name, &callback)
  @callbacks[name] ||= []
  @callbacks[name].push(callback)
end

#on_global_mark_ring?Boolean

Returns:

  • (Boolean)


858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
# File 'lib/textbringer/buffer.rb', line 858

def on_global_mark_ring?
  mark_ring = Buffer.global_mark_ring
  if mark_ring.empty?
    return false
  end
  current = mark_ring.current
  if current&.buffer == self
    return true
  end
  next_mark = mark_ring[-1]
  if next_mark&.buffer ==  self
    return true
  end
  false
end

#on_killed(&callback) ⇒ Object



321
322
323
# File 'lib/textbringer/buffer.rb', line 321

def on_killed(&callback)
  add_callback(:killed, callback)
end

#on_modified(&callback) ⇒ Object



345
346
347
# File 'lib/textbringer/buffer.rb', line 345

def on_modified(&callback)
  add_callback(:modified, callback)
end

#point_after_mark?(mark) ⇒ Boolean

Returns:

  • (Boolean)


782
783
784
# File 'lib/textbringer/buffer.rb', line 782

def point_after_mark?(mark)
  @point > mark.location
end

#point_at_mark?(mark) ⇒ Boolean

Returns:

  • (Boolean)


774
775
776
# File 'lib/textbringer/buffer.rb', line 774

def point_at_mark?(mark)
  @point == mark.location
end

#point_before_mark?(mark) ⇒ Boolean

Returns:

  • (Boolean)


778
779
780
# File 'lib/textbringer/buffer.rb', line 778

def point_before_mark?(mark)
  @point < mark.location
end

#point_maxObject



501
502
503
# File 'lib/textbringer/buffer.rb', line 501

def point_max
  bytesize
end

#point_minObject



497
498
499
# File 'lib/textbringer/buffer.rb', line 497

def point_min
  0
end

#point_to_mark(mark) ⇒ Object



766
767
768
# File 'lib/textbringer/buffer.rb', line 766

def point_to_mark(mark)
  goto_char(mark.location)
end

#pop_markObject



885
886
887
888
# File 'lib/textbringer/buffer.rb', line 885

def pop_mark
  return if @mark_ring.empty?
  @mark = @mark_ring.rotate(1)
end

#pop_to_markObject



890
891
892
893
# File 'lib/textbringer/buffer.rb', line 890

def pop_to_mark
  goto_char(mark)
  pop_mark
end

#previous_line(n = 1) ⇒ Object



707
708
709
710
711
712
713
714
715
716
# File 'lib/textbringer/buffer.rb', line 707

def previous_line(n = 1)
  column = get_goal_column
  n.times do
    beginning_of_line
    backward_char
    beginning_of_line
    adjust_column(column)
  end
  @goal_column = column
end

#push_global_mark(pos = @point, force: false) ⇒ Object



874
875
876
877
878
879
880
881
882
883
# File 'lib/textbringer/buffer.rb', line 874

def push_global_mark(pos = @point, force: false)
  if force || !on_global_mark_ring?
    mark = new_mark
    mark.location = pos
    Buffer.global_mark_ring.push(mark)
    true
  else
    false
  end
end

#push_mark(pos = @point) ⇒ Object

Set mark at pos, and push the mark on the mark ring. Unlike Emacs, the new mark is pushed on the mark ring instead of the old one.



846
847
848
849
850
851
852
853
854
855
856
# File 'lib/textbringer/buffer.rb', line 846

def push_mark(pos = @point)
  @mark = new_mark
  @mark.location = pos
  @mark_ring.push(@mark)
  if self != Buffer.minibuffer
    global_mark_ring = Buffer.global_mark_ring
    if global_mark_ring.empty? || global_mark_ring.current.buffer != self
      push_global_mark(pos)
    end
  end
end

#re_search_backward(s, raise_error: true, count: 1) ⇒ Object



1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
# File 'lib/textbringer/buffer.rb', line 1086

def re_search_backward(s, raise_error: true, count: 1)
  if count < 0
    return re_search_forward(s, raise_error: raise_error, count: -count)
  end
  re = new_regexp(s)
  pos = @point
  count.times do
    p = pos
    begin
      i = byteindex(false, re, p)
      if i.nil?
        if raise_error
          raise SearchError, "Search failed"
        else
          return nil
        end
      end
      p = get_pos(p, -1)
    rescue RangeError
      if raise_error
        raise SearchError, "Search failed"
      else
        return nil
      end
    end while match_end(0) > pos
    pos = match_beginning(0)
  end
  goto_char(pos)
end

#re_search_forward(s, raise_error: true, count: 1) ⇒ Object



1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
# File 'lib/textbringer/buffer.rb', line 1066

def re_search_forward(s, raise_error: true, count: 1)
  if count < 0
    return re_search_backward(s, raise_error: raise_error, count: -count)
  end
  re = new_regexp(s)
  pos = @point
  count.times do
    i = byteindex(true, re, pos)
    if i.nil?
      if raise_error
        raise SearchError, "Search failed"
      else
        return nil
      end
    end
    pos = match_end(0)
  end
  goto_char(pos)
end

#read_only=(value) ⇒ Object



293
294
295
296
297
298
# File 'lib/textbringer/buffer.rb', line 293

def read_only=(value)
  @read_only = value
  if @read_only
    @modified = false
  end
end

#read_only?Boolean

Returns:

  • (Boolean)


289
290
291
# File 'lib/textbringer/buffer.rb', line 289

def read_only?
  @read_only
end

#read_only_editObject



300
301
302
303
304
305
306
307
# File 'lib/textbringer/buffer.rb', line 300

def read_only_edit
  self.read_only = false
  begin
    yield
  ensure
    self.read_only = true
  end
end

#redoObject



1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
# File 'lib/textbringer/buffer.rb', line 1044

def redo
  check_read_only_flag
  if @redo_stack.empty?
    raise EditorError, "No further redo information"
  end
  action = @redo_stack.pop
  @undoing = true
  begin
    was_modified = @modified
    action.redo
    if action.version == @version
      @modified = false
      action.version = nil
    elsif !was_modified
      action.version = @version
    end
    @undo_stack.push(action)
  ensure
    @undoing = false
  end
end

#replace(str, start: point_min, end: point_max) ⇒ Object



955
956
957
958
959
960
961
# File 'lib/textbringer/buffer.rb', line 955

def replace(str, start: point_min, end: point_max)
  composite_edit do
    delete_region(start, binding.local_variable_get(:end))
    goto_char(start)
    insert(str)
  end
end

#replace_match(str) ⇒ Object



1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
# File 'lib/textbringer/buffer.rb', line 1189

def replace_match(str)
  new_str = str.gsub(/\\(?:([0-9]+)|(&)|(\\))/) { |s|
    case
    when $1
      match_string($1.to_i)
    when $2
      match_string(0)
    when $3
      "\\"
    end
  }
  b = match_beginning(0)
  e =  match_end(0)
  goto_char(b)
  composite_edit do
    delete_region(b, e)
    insert(new_str)
  end
end

#replace_regexp_forward(regexp, to_str) ⇒ Object



1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
# File 'lib/textbringer/buffer.rb', line 1209

def replace_regexp_forward(regexp, to_str)
  result = 0
  rest = substring(point, point_max)
  composite_edit do
    delete_region(point, point_max)
    new_str = rest.gsub(new_regexp(regexp)) {
      result += 1
      m = Regexp.last_match
      to_str.gsub(/\\(?:([0-9]+)|(&)|(\\))/) { |s|
      case
      when $1
        m[$1.to_i]
      when $2
        m.to_s
      when $3
        "\\"
      end
      }
    }
    insert(new_str)
  end
  result
end

#revert(enc = nil) ⇒ Object



373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
# File 'lib/textbringer/buffer.rb', line 373

def revert(enc = nil)
  if @file_name.nil?
    raise EditorError, "Buffer has no file name"
  end
  clear
  s, mtime = File.open(@file_name,
                       external_encoding: Encoding::ASCII_8BIT,
                       binmode: true) { |f|
    f.flock(File::LOCK_SH)
    [f.read, f.mtime]
  }
  enc ||= @@detect_encoding_proc.call(s) || Encoding::ASCII_8BIT
  s.force_encoding(enc)
  unless s.valid_encoding?
    enc = Encoding::ASCII_8BIT
    s.force_encoding(enc)
  end
  set_contents(s, enc)
  @file_mtime = mtime
  @modified = false
end

#save(file_name = @file_name) ⇒ Object



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

def save(file_name = @file_name)
  if file_name.nil?
    raise EditorError, "File name is not set"
  end
  file_name = File.expand_path(file_name)
  config = EditorConfig.load_file(file_name)
  if config["trim_trailing_whitespace"]
    trim_trailing_whitespace
  end
  if config["insert_final_newline"]
    insert_final_newline
  end
  begin
    File.open(file_name, "w",
              external_encoding: @file_encoding, binmode: true) do |f|
      f.flock(File::LOCK_EX)
      write_to_file(f)
      f.flush
    end
    @file_mtime = File.mtime(file_name)
  rescue Errno::EISDIR
    if @name
      file_name = File.expand_path(@name, file_name)
      retry
    else
      raise
    end
  end
  if file_name != @file_name
    self.file_name = file_name
  end
  @version += 1
  @modified = false
  @new_file = false
  @read_only = false
end

#save_excursionObject

Don’t save Buffer.current.



811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
# File 'lib/textbringer/buffer.rb', line 811

def save_excursion
  old_point = new_mark
  old_mark = @mark&.dup
  old_column = @goal_column
  begin
    yield
  ensure
    point_to_mark(old_point)
    old_point.delete
    if old_mark
      @mark.location = old_mark.location
      old_mark.delete
    end
    @goal_column = old_column
  end
end

#save_pointObject

The buffer should not be modified in the given block because current_line/current_column is not updated in save_point.



796
797
798
799
800
801
802
803
804
805
806
807
808
# File 'lib/textbringer/buffer.rb', line 796

def save_point
  saved = new_mark
  column = @goal_column
  @save_point_level += 1
  begin
    yield(saved)
  ensure
    point_to_mark(saved)
    saved.delete
    @goal_column = column
    @save_point_level -= 1
  end
end

#set_mark(pos = @point) ⇒ Object



835
836
837
838
839
840
841
# File 'lib/textbringer/buffer.rb', line 835

def set_mark(pos = @point)
  if @mark
    @mark.location = pos
  else
    push_mark(pos)
  end
end

#set_visible_mark(pos = @point) ⇒ Object



895
896
897
898
# File 'lib/textbringer/buffer.rb', line 895

def set_visible_mark(pos = @point)
  @visible_mark ||= new_mark
  @visible_mark.location = pos
end

#skip_re_backward(re) ⇒ Object



1344
1345
1346
1347
1348
# File 'lib/textbringer/buffer.rb', line 1344

def skip_re_backward(re)
  while re =~ char_before
    backward_char
  end
end

#skip_re_forward(re) ⇒ Object



1338
1339
1340
1341
1342
# File 'lib/textbringer/buffer.rb', line 1338

def skip_re_forward(re)
  while re =~ char_after
    forward_char
  end
end

#substring(s, e) ⇒ Object



442
443
444
445
446
447
448
449
450
451
452
# File 'lib/textbringer/buffer.rb', line 442

def substring(s, e)
  result =
    if s > @gap_start || e <= @gap_start
      @contents[user_to_gap(s)...user_to_gap(e)]
    else
      len = @gap_start - s
      @contents[user_to_gap(s), len] + @contents[@gap_end, e - s - len]
    end
  result.force_encoding(Encoding::UTF_8) unless @binary
  result
end

#to_sObject



436
437
438
439
440
# File 'lib/textbringer/buffer.rb', line 436

def to_s
  result = (@contents[0...@gap_start] + @contents[@gap_end..-1])
  result.force_encoding(Encoding::UTF_8) unless @binary
  result
end

#transpose_charsObject



1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
# File 'lib/textbringer/buffer.rb', line 1233

def transpose_chars
  if end_of_line?
    backward_char
  end
  if beginning_of_buffer?
    raise RangeError, "Beginning of buffer"
  end
  backward_char
  c = char_after
  delete_char
  forward_char
  insert(c)
end

#trim_trailing_whitespaceObject



1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
# File 'lib/textbringer/buffer.rb', line 1367

def trim_trailing_whitespace
  save_excursion do
    beginning_of_buffer
    composite_edit do
      while re_search_forward(/[ \t]+$/, raise_error: false)
        replace_match("")
      end
    end
  end
end

#undoObject



1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
# File 'lib/textbringer/buffer.rb', line 1022

def undo
  check_read_only_flag
  if @undo_stack.empty?
    raise EditorError, "No further undo information"
  end
  action = @undo_stack.pop
  @undoing = true
  begin
    was_modified = @modified
    action.undo
    if action.version == @version
      @modified = false
      action.version = nil
    elsif !was_modified
      action.version = @version
    end
    @redo_stack.push(action)
  ensure
    @undoing = false
  end
end

#yankObject



1013
1014
1015
# File 'lib/textbringer/buffer.rb', line 1013

def yank
  insert_for_yank(KILL_RING.current)
end

#yank_popObject



1017
1018
1019
1020
# File 'lib/textbringer/buffer.rb', line 1017

def yank_pop
  delete_region
  insert_for_yank(KILL_RING.rotate(1))
end