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)
  e == Encoding::US_ASCII ? Encoding::UTF_8 : e
}
@@auto_detect_encodings = 
[
  Encoding::UTF_8,
  Encoding::EUC_JP,
  Encoding::Windows_31J
]
@@detect_encoding_proc = 
DEFAULT_DETECT_ENCODING
@@table = 
{}
@@list = 
[]
@@current = 
nil
@@minibuffer = 
nil

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(s = String.new, 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.



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/textbringer/buffer.rb', line 178

def initialize(s = String.new, name: nil,
               file_name: nil,
               file_encoding: CONFIG[:default_file_encoding],
               file_mtime: nil, new_file: true, undo_limit: UNDO_LIMIT,
               read_only: false)
  case s.encoding
  when Encoding::UTF_8, Encoding::ASCII_8BIT
    @contents = s.frozen? ? s.dup : s
  else
    @contents = s.encode(Encoding::UTF_8)
  end
  @contents.force_encoding(Encoding::ASCII_8BIT)
  @name = name
  @file_name = file_name
  self.file_encoding = file_encoding
  @file_mtime = file_mtime
  case @contents
  when /(?<!\r)\n/ 
    @file_format = :unix
  when /\r(?!\n)/
    @file_format = :mac
    @contents.gsub!(/\r/, "\n")
  when /\r\n/
    @file_format = :dos
    @contents.gsub!(/\r/, "")
  else
    @file_format = CONFIG[:default_file_format]
  end
  @new_file = new_file
  @undo_limit = undo_limit
  @point = 0
  @gap_start = 0
  @gap_end = 0
  @marks = []
  @mark = nil
  @current_line = 1
  @current_column = 1  # One-based character count
  @goal_column = nil   # Zero-based display width count
  @yank_start = new_mark
  @undo_stack = []
  @redo_stack = []
  @undoing = false
  @version = 0
  @modified = false
  @mode = FundamentalMode.new(self)
  @keymap = nil
  @attributes = {}
  @save_point_level = 0
  @match_offsets = []
  @visible_mark = nil
  @read_only = read_only
end

Instance Attribute Details

#current_column ⇒ Object (readonly)

Returns the value of attribute current_column.



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

def current_column
  @current_column
end

#current_line ⇒ Object (readonly)

Returns the value of attribute current_line.



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

def current_line
  @current_line
end

#file_encoding ⇒ Object

Returns the value of attribute file_encoding.



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

def file_encoding
  @file_encoding
end

#file_format ⇒ Object

Returns the value of attribute file_format.



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

def file_format
  @file_format
end

#file_name ⇒ Object

Returns the value of attribute file_name.



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

def file_name
  @file_name
end

#keymap ⇒ Object

Returns the value of attribute keymap.



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

def keymap
  @keymap
end

#marks ⇒ Object (readonly)

Returns the value of attribute marks.



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

def marks
  @marks
end

#mode ⇒ Object

Returns the value of attribute mode.



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

def mode
  @mode
end

#modified=(value) ⇒ Object (writeonly)

Sets the attribute modified

Parameters:

  • value —

    the value to set the attribute modified to.



15
16
17
 
# File 'lib/textbringer/buffer.rb', line 15

def modified=(value)
  @modified = value
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#point ⇒ Object (readonly)

Returns the value of attribute point.



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

def point
  @point
end

#visible_mark ⇒ Object (readonly)

Returns the value of attribute visible_mark.



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

def visible_mark
  @visible_mark
end

Class Method Details

.[](name) ⇒ Object 



105
106
107
 
# File 'lib/textbringer/buffer.rb', line 105

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

.add(buffer) ⇒ Object 



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

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

.auto_detect_encodings ⇒ Object 



56
57
58
 
# File 'lib/textbringer/buffer.rb', line 56

def self.auto_detect_encodings
  @@auto_detect_encodings
end

.auto_detect_encodings=(encodings) ⇒ Object 



60
61
62
 
# File 'lib/textbringer/buffer.rb', line 60

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

.count ⇒ Object 



101
102
103
 
# File 'lib/textbringer/buffer.rb', line 101

def self.count
  @@table.size
end

.current ⇒ Object 



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

def self.current
  @@current
end

.current=(buffer) ⇒ Object 



81
82
83
84
85
86
87
 
# File 'lib/textbringer/buffer.rb', line 81

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

.detect_encoding_proc ⇒ Object 



64
65
66
 
# File 'lib/textbringer/buffer.rb', line 64

def self.detect_encoding_proc
  @@detect_encoding_proc
end

.detect_encoding_proc=(f) ⇒ Object 



68
69
70
 
# File 'lib/textbringer/buffer.rb', line 68

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

.display_width(s) ⇒ Object 



160
161
162
 
# File 'lib/textbringer/buffer.rb', line 160

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

.dump_unsaved_buffers(dir) ⇒ Object 



1148
1149
1150
1151
1152
1153
1154
1155
 
# File 'lib/textbringer/buffer.rb', line 1148

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) 


1157
1158
1159
 
# File 'lib/textbringer/buffer.rb', line 1157

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

.each(&block) ⇒ Object 



156
157
158
 
# File 'lib/textbringer/buffer.rb', line 156

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

.find_file(file_name) ⇒ Object 



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/textbringer/buffer.rb', line 123

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 



109
110
111
 
# File 'lib/textbringer/buffer.rb', line 109

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

.kill_em_all ⇒ Object 



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

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

.last ⇒ Object 



93
94
95
96
97
98
99
 
# File 'lib/textbringer/buffer.rb', line 93

def self.last
  if @@list.last == @@current
    @@list[-2]
  else
    @@list.last
  end
end

.load(path) ⇒ Object 



1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
 
# File 'lib/textbringer/buffer.rb', line 1137

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

.load_dumped_buffers(dir) ⇒ Object 



1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
 
# File 'lib/textbringer/buffer.rb', line 1161

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

.minibuffer ⇒ Object 



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

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

.names ⇒ Object 



113
114
115
 
# File 'lib/textbringer/buffer.rb', line 113

def self.names
  @@table.keys
end

.new_buffer(name, **opts) ⇒ Object 



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

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 



146
147
148
149
150
151
152
153
154
 
# File 'lib/textbringer/buffer.rb', line 146

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 



318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'lib/textbringer/buffer.rb', line 318

def self.open(file_name, name: File.basename(file_name))
  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
  Buffer.new(s, name: name,
             file_name: file_name, file_encoding: enc, file_mtime: mtime,
             new_file: false, read_only: !File.writable?(file_name))
end

Instance Method Details

#[](name) ⇒ Object 



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

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

#[]=(name, value) ⇒ Object 



310
311
312
 
# File 'lib/textbringer/buffer.rb', line 310

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

#apply_mode(mode_class) ⇒ Object 



1111
1112
1113
1114
1115
 
# File 'lib/textbringer/buffer.rb', line 1111

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 



579
580
581
 
# File 'lib/textbringer/buffer.rb', line 579

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

#backward_delete_char(n = 1) ⇒ Object 



568
569
570
 
# File 'lib/textbringer/buffer.rb', line 568

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

#backward_line(n = 1) ⇒ Object 



627
628
629
 
# File 'lib/textbringer/buffer.rb', line 627

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

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



594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
 
# File 'lib/textbringer/buffer.rb', line 594

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_buffer ⇒ Object 



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

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) 


660
661
662
 
# File 'lib/textbringer/buffer.rb', line 660

def beginning_of_buffer?
  @point == 0
end

#beginning_of_line ⇒ Object 



672
673
674
675
676
677
 
# File 'lib/textbringer/buffer.rb', line 672

def beginning_of_line
  while !beginning_of_line?
    backward_char
  end
  @point
end

#beginning_of_line? ⇒ Boolean

Returns:

  • (Boolean) 


679
680
681
 
# File 'lib/textbringer/buffer.rb', line 679

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

#binary? ⇒ Boolean

Returns:

  • (Boolean) 


258
259
260
 
# File 'lib/textbringer/buffer.rb', line 258

def binary?
  @binary
end

#byte_after(location = @point) ⇒ Object 



388
389
390
391
392
393
394
 
# File 'lib/textbringer/buffer.rb', line 388

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 



396
397
398
399
400
401
402
 
# File 'lib/textbringer/buffer.rb', line 396

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 



973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
 
# File 'lib/textbringer/buffer.rb', line 973

def byteindex(forward, re, pos)
  @match_offsets = []
  method = forward ? :index : :rindex
  adjust_gap(0, point_max)
  if @binary
    offset = pos
  else
    offset = @contents[0...pos].force_encoding(Encoding::UTF_8).size
    @contents.force_encoding(Encoding::UTF_8)
  end
  begin
    i = @contents.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
  ensure
    @contents.force_encoding(Encoding::ASCII_8BIT)
  end
end

#bytesize ⇒ Object Also known as: size 



426
427
428
 
# File 'lib/textbringer/buffer.rb', line 426

def bytesize
  @contents.bytesize - gap_size
end

#char_after(location = @point) ⇒ Object 



404
405
406
407
408
409
410
411
 
# File 'lib/textbringer/buffer.rb', line 404

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 



413
414
415
416
417
418
419
420
421
422
423
424
 
# File 'lib/textbringer/buffer.rb', line 413

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

#clear ⇒ Object 



827
828
829
830
831
832
833
834
835
836
837
838
839
840
 
# File 'lib/textbringer/buffer.rb', line 827

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

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



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

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

#current? ⇒ Boolean

Returns:

  • (Boolean) 


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

def current?
  @@current == self
end

#current_symbol ⇒ Object 



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

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 



530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
 
# File 'lib/textbringer/buffer.rb', line 530

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))
    @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))
    @modified = true
  end
  @goal_column = nil
end

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



800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
 
# File 'lib/textbringer/buffer.rb', line 800

def delete_region(s = @point, e = mark)
  check_read_only_flag
  old_pos = @point
  if s > e
    s, e = e, s
  end
  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)) 
    @modified = true
  end
end

#delete_visible_mark ⇒ Object 



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

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

#display_width(s) ⇒ Object 



173
174
175
 
# File 'lib/textbringer/buffer.rb', line 173

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

#dump(path) ⇒ Object 



1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
 
# File 'lib/textbringer/buffer.rb', line 1126

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

#end_of_buffer ⇒ Object 



664
665
666
 
# File 'lib/textbringer/buffer.rb', line 664

def end_of_buffer
  goto_char(bytesize)
end

#end_of_buffer? ⇒ Boolean

Returns:

  • (Boolean) 


668
669
670
 
# File 'lib/textbringer/buffer.rb', line 668

def end_of_buffer?
  @point == bytesize
end

#end_of_line ⇒ Object 



683
684
685
686
687
688
 
# File 'lib/textbringer/buffer.rb', line 683

def end_of_line
  while !end_of_line?
    forward_char
  end
  @point
end

#end_of_line? ⇒ Boolean

Returns:

  • (Boolean) 


690
691
692
 
# File 'lib/textbringer/buffer.rb', line 690

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

#exchange_point_and_mark(mark = @mark) ⇒ Object 



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

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 



164
165
166
167
168
169
170
171
 
# File 'lib/textbringer/buffer.rb', line 164

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) 


366
367
368
 
# File 'lib/textbringer/buffer.rb', line 366

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

#forward_char(n = 1) ⇒ Object 



572
573
574
575
576
577
 
# File 'lib/textbringer/buffer.rb', line 572

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 



610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
 
# File 'lib/textbringer/buffer.rb', line 610

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 



583
584
585
586
587
588
589
590
591
592
 
# File 'lib/textbringer/buffer.rb', line 583

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) 


1094
1095
1096
 
# File 'lib/textbringer/buffer.rb', line 1094

def gap_filled_with_nul?
  /\A\0*\z/ =~ @contents[@gap_start...@gap_end] ? true : false
end

#get_line_and_column(pos) ⇒ Object 



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

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 



455
456
457
458
459
460
461
462
463
464
465
466
467
 
# File 'lib/textbringer/buffer.rb', line 455

def goto_char(pos)
  if pos < 0 || pos > size
    raise RangeError, "Out of buffer"
  end
  if !@binary && /[\x80-\xbf]/n =~ byte_after(pos)
    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 



469
470
471
472
473
474
475
476
477
478
479
480
481
482
 
# File 'lib/textbringer/buffer.rb', line 469

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 



1190
1191
1192
1193
1194
1195
1196
 
# File 'lib/textbringer/buffer.rb', line 1190

def gsub(*args, &block)
  s = to_s.gsub(*args, &block)
  delete_region(point_min, point_max)
  insert(s)
  merge_undo(2)
  self
end

#indent_to(column) ⇒ Object 



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

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 



484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
 
# File 'lib/textbringer/buffer.rb', line 484

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
  @modified = true
  @goal_column = nil
  self
end

#insert_for_yank(s) ⇒ Object 



870
871
872
873
 
# File 'lib/textbringer/buffer.rb', line 870

def insert_for_yank(s)
  mark_to_point(@yank_start)
  insert(s)
end

#inspect ⇒ Object 



231
232
233
 
# File 'lib/textbringer/buffer.rb', line 231

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

#kill ⇒ Object 



286
287
288
289
290
291
292
 
# File 'lib/textbringer/buffer.rb', line 286

def kill
  @@table.delete(@name)
  @@list.delete(self)
  if @@current == self
    @@current = nil
  end
end

#kill_line(append = false) ⇒ Object 



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

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 



795
796
797
798
 
# File 'lib/textbringer/buffer.rb', line 795

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

#kill_word(append = false) ⇒ Object 



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

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) 


964
965
966
967
968
969
970
971
 
# File 'lib/textbringer/buffer.rb', line 964

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

#mark ⇒ Object 



762
763
764
765
766
767
 
# File 'lib/textbringer/buffer.rb', line 762

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

#mark_to_point(mark) ⇒ Object 



704
705
706
 
# File 'lib/textbringer/buffer.rb', line 704

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

#match_beginning(n) ⇒ Object 



1021
1022
1023
 
# File 'lib/textbringer/buffer.rb', line 1021

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

#match_end(n) ⇒ Object 



1025
1026
1027
 
# File 'lib/textbringer/buffer.rb', line 1025

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

#match_string(n) ⇒ Object 



1029
1030
1031
1032
1033
1034
1035
1036
 
# File 'lib/textbringer/buffer.rb', line 1029

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

#merge_undo(n) ⇒ Object 



1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
 
# File 'lib/textbringer/buffer.rb', line 1098

def merge_undo(n)
  return if @undoing || @undo_limit == 0
  actions = @undo_stack.pop(n)
  if actions
    action = CompositeAction.new(self, actions.first.location)
    actions.each do |i|
      action.add_action(i)
    end
    action.version = actions.first.version
    @undo_stack.push(action)
  end
end

#modified? ⇒ Boolean

Returns:

  • (Boolean) 


298
299
300
 
# File 'lib/textbringer/buffer.rb', line 298

def modified?
  @modified
end

#new_file? ⇒ Boolean

Returns:

  • (Boolean) 


314
315
316
 
# File 'lib/textbringer/buffer.rb', line 314

def new_file?
  @new_file
end

#new_mark(location = @point) ⇒ Object 



694
695
696
697
698
 
# File 'lib/textbringer/buffer.rb', line 694

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

#newline ⇒ Object 



511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
 
# File 'lib/textbringer/buffer.rb', line 511

def newline
  indentation = save_point { |saved|
    if /[ \t]/ =~ char_after
      next ""
    end
    beginning_of_line
    s = @point
    while /[ \t]/ =~ char_after
      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 



631
632
633
634
635
636
637
638
639
 
# File 'lib/textbringer/buffer.rb', line 631

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

#point_after_mark?(mark) ⇒ Boolean

Returns:

  • (Boolean) 


716
717
718
 
# File 'lib/textbringer/buffer.rb', line 716

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

#point_at_mark?(mark) ⇒ Boolean

Returns:

  • (Boolean) 


708
709
710
 
# File 'lib/textbringer/buffer.rb', line 708

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

#point_before_mark?(mark) ⇒ Boolean

Returns:

  • (Boolean) 


712
713
714
 
# File 'lib/textbringer/buffer.rb', line 712

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

#point_max ⇒ Object 



435
436
437
 
# File 'lib/textbringer/buffer.rb', line 435

def point_max
  bytesize
end

#point_min ⇒ Object 



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

def point_min
  0
end

#point_to_mark(mark) ⇒ Object 



700
701
702
 
# File 'lib/textbringer/buffer.rb', line 700

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

#previous_line(n = 1) ⇒ Object 



641
642
643
644
645
646
647
648
649
650
 
# File 'lib/textbringer/buffer.rb', line 641

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

#re_search_backward(s, raise_error: true) ⇒ Object 



941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
 
# File 'lib/textbringer/buffer.rb', line 941

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

#re_search_forward(s, raise_error: true) ⇒ Object 



928
929
930
931
932
933
934
935
936
937
938
939
 
# File 'lib/textbringer/buffer.rb', line 928

def re_search_forward(s, raise_error: true)
  re = new_regexp(s)
  i = byteindex(true, re, @point)
  if i.nil?
    if raise_error
      raise SearchError, "Search failed"
    else
      return nil
    end
  end
  goto_char(match_end(0))
end

#read_only=(value) ⇒ Object 



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

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

#read_only? ⇒ Boolean

Returns:

  • (Boolean) 


275
276
277
 
# File 'lib/textbringer/buffer.rb', line 275

def read_only?
  @read_only
end

#redo ⇒ Object 



906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
 
# File 'lib/textbringer/buffer.rb', line 906

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_match(str) ⇒ Object 



1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
 
# File 'lib/textbringer/buffer.rb', line 1038

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)
  delete_region(b, e)
  insert(new_str)
  merge_undo(2)
end

#replace_regexp_forward(regexp, to_str) ⇒ Object 



1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
 
# File 'lib/textbringer/buffer.rb', line 1057

def replace_regexp_forward(regexp, to_str)
  result = 0
  rest = substring(point, point_max)
  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)
  merge_undo(2)
  result
end

#save(file_name = @file_name) ⇒ Object 



336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
 
# File 'lib/textbringer/buffer.rb', line 336

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)
  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
      @file_mtime = f.mtime
    end
  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_excursion ⇒ Object

Don’t save Buffer.current.



745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
 
# File 'lib/textbringer/buffer.rb', line 745

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_point ⇒ Object

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



730
731
732
733
734
735
736
737
738
739
740
741
742
 
# File 'lib/textbringer/buffer.rb', line 730

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 



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

def set_mark(pos = @point)
  @mark ||= new_mark
  @mark.location = pos
end

#set_visible_mark(pos = @point) ⇒ Object 



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

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

#skip_re_backward(re) ⇒ Object 



1184
1185
1186
1187
1188
 
# File 'lib/textbringer/buffer.rb', line 1184

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

#skip_re_forward(re) ⇒ Object 



1178
1179
1180
1181
1182
 
# File 'lib/textbringer/buffer.rb', line 1178

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

#substring(s, e) ⇒ Object 



376
377
378
379
380
381
382
383
384
385
386
 
# File 'lib/textbringer/buffer.rb', line 376

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_s ⇒ Object 



370
371
372
373
374
 
# File 'lib/textbringer/buffer.rb', line 370

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

#transpose_chars ⇒ Object 



1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
 
# File 'lib/textbringer/buffer.rb', line 1080

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

#undo ⇒ Object 



884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
 
# File 'lib/textbringer/buffer.rb', line 884

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

#yank ⇒ Object 



875
876
877
 
# File 'lib/textbringer/buffer.rb', line 875

def yank
  insert_for_yank(KILL_RING.current)
end

#yank_pop ⇒ Object 



879
880
881
882
 
# File 'lib/textbringer/buffer.rb', line 879

def yank_pop
  delete_region(@yank_start.location, @point)
  insert_for_yank(KILL_RING.current(1))
end