Class: Reline::Unicode

Inherits:
Object
  • Object
show all
Defined in:
lib/reline/unicode.rb

Defined Under Namespace

Classes: EastAsianWidth

Constant Summary collapse

EscapedPairs = 
{
  0x00 => '^@',
  0x01 => '^A', # C-a
  0x02 => '^B',
  0x03 => '^C',
  0x04 => '^D',
  0x05 => '^E',
  0x06 => '^F',
  0x07 => '^G',
  0x08 => '^H', # Backspace
  0x09 => '^I',
  0x0A => '^J',
  0x0B => '^K',
  0x0C => '^L',
  0x0D => '^M', # Enter
  0x0E => '^N',
  0x0F => '^O',
  0x10 => '^P',
  0x11 => '^Q',
  0x12 => '^R',
  0x13 => '^S',
  0x14 => '^T',
  0x15 => '^U',
  0x16 => '^V',
  0x17 => '^W',
  0x18 => '^X',
  0x19 => '^Y',
  0x1A => '^Z', # C-z
  0x1B => '^[', # C-[ C-3
  0x1C => '^\\', # C-\
  0x1D => '^]', # C-]
  0x1E => '^^', # C-~ C-6
  0x1F => '^_', # C-_ C-7
  0x7F => '^?', # C-? C-8
}
NON_PRINTING_START = 
"\1"
NON_PRINTING_END = 
"\2"
CSI_REGEXP = 
/\e\[[\d;]*[ABCDEFGHJKSTfminsuhl]/
OSC_REGEXP = 
/\e\]\d+(?:;[^;\a\e]+)*(?:\a|\e\\)/
WIDTH_SCANNER = 
/\G(?:(#{NON_PRINTING_START})|(#{NON_PRINTING_END})|(#{CSI_REGEXP})|(#{OSC_REGEXP})|(\X))/o

Class Method Summary collapse

Class Method Details

.calculate_width(str, allow_escape_code = false) ⇒ Object 



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/reline/unicode.rb', line 104

def self.calculate_width(str, allow_escape_code = false)
  if allow_escape_code
    width = 0
    rest = str.encode(Encoding::UTF_8)
    in_zero_width = false
    rest.scan(WIDTH_SCANNER) do |non_printing_start, non_printing_end, csi, osc, gc|
      case
      when non_printing_start
        in_zero_width = true
      when non_printing_end
        in_zero_width = false
      when csi, osc
      when gc
        unless in_zero_width
          width += get_mbchar_width(gc)
        end
      end
    end
    width
  else
    str.encode(Encoding::UTF_8).grapheme_clusters.inject(0) { |w, gc|
      w + get_mbchar_width(gc)
    }
  end
end

.common_prefix(list, ignore_case: false) ⇒ Object 



393
394
395
396
397
398
399
400
401
402
403
404
 
# File 'lib/reline/unicode.rb', line 393

def self.common_prefix(list, ignore_case: false)
  return '' if list.empty?

  common_prefix_gcs = list.first.grapheme_clusters
  list.each do |item|
    gcs = item.grapheme_clusters
    common_prefix_gcs = common_prefix_gcs.take_while.with_index do |gc, i|
      ignore_case ? gc.casecmp?(gcs[i]) : gc == gcs[i]
    end
  end
  common_prefix_gcs.join
end

.east_asian_width(ord) ⇒ Object 



75
76
77
78
79
 
# File 'lib/reline/unicode.rb', line 75

def self.east_asian_width(ord)
  chunk_index = EastAsianWidth::CHUNK_LAST.bsearch_index { |o| ord <= o }
  size = EastAsianWidth::CHUNK_WIDTH[chunk_index]
  size == -1 ? Reline.ambiguous_width : size
end

.ed_transpose_words(line, byte_pointer) ⇒ Object 



298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/reline/unicode.rb', line 298

def self.ed_transpose_words(line, byte_pointer)
  gcs = line.byteslice(0, byte_pointer).grapheme_clusters
  pos = gcs.size
  gcs += line.byteslice(byte_pointer..).grapheme_clusters
  pos += 1 while pos < gcs.size && !word_character?(gcs[pos])
  if pos == gcs.size # 'aaa  bbb [cursor] '
    pos -= 1 while pos > 0 && !word_character?(gcs[pos - 1])
    second_word_end = gcs.size
  else # 'aaa  [cursor]bbb'
    pos += 1 while pos < gcs.size && word_character?(gcs[pos])
    second_word_end = pos
  end
  pos -= 1 while pos > 0 && word_character?(gcs[pos - 1])
  second_word_start = pos
  pos -= 1 while pos > 0 && !word_character?(gcs[pos - 1])
  first_word_end = pos
  pos -= 1 while pos > 0 && word_character?(gcs[pos - 1])
  first_word_start = pos

  [first_word_start, first_word_end, second_word_start, second_word_end].map do |idx|
    gcs.take(idx).sum(&:bytesize)
  end
end

.em_backward_word(line, byte_pointer) ⇒ Object 



284
285
286
287
288
289
 
# File 'lib/reline/unicode.rb', line 284

def self.em_backward_word(line, byte_pointer)
  gcs = line.byteslice(0, byte_pointer).grapheme_clusters.reverse
  nonwords = gcs.take_while { |c| !word_character?(c) }
  words = gcs.drop(nonwords.size).take_while { |c| word_character?(c) }
  nonwords.sum(&:bytesize) + words.sum(&:bytesize)
end

.em_big_backward_word(line, byte_pointer) ⇒ Object 



291
292
293
294
295
296
 
# File 'lib/reline/unicode.rb', line 291

def self.em_big_backward_word(line, byte_pointer)
  gcs = line.byteslice(0, byte_pointer).grapheme_clusters.reverse
  spaces = gcs.take_while { |c| space_character?(c) }
  nonspaces = gcs.drop(spaces.size).take_while { |c| !space_character?(c) }
  spaces.sum(&:bytesize) + nonspaces.sum(&:bytesize)
end

.em_forward_word(line, byte_pointer) ⇒ Object 



270
271
272
273
274
275
 
# File 'lib/reline/unicode.rb', line 270

def self.em_forward_word(line, byte_pointer)
  gcs = line.byteslice(byte_pointer..).grapheme_clusters
  nonwords = gcs.take_while { |c| !word_character?(c) }
  words = gcs.drop(nonwords.size).take_while { |c| word_character?(c) }
  nonwords.sum(&:bytesize) + words.sum(&:bytesize)
end

.em_forward_word_with_capitalization(line, byte_pointer) ⇒ Object 



277
278
279
280
281
282
 
# File 'lib/reline/unicode.rb', line 277

def self.em_forward_word_with_capitalization(line, byte_pointer)
  gcs = line.byteslice(byte_pointer..).grapheme_clusters
  nonwords = gcs.take_while { |c| !word_character?(c) }
  words = gcs.drop(nonwords.size).take_while { |c| word_character?(c) }
  [nonwords.sum(&:bytesize) + words.sum(&:bytesize), nonwords.join + words.join.capitalize]
end

.escape_for_print(str) ⇒ Object 



44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/reline/unicode.rb', line 44

def self.escape_for_print(str)
  str.chars.map! { |gr|
    case gr
    when -"\n"
      gr
    when -"\t"
      -'  '
    else
      EscapedPairs[gr.ord] || gr
    end
  }.join
end

.get_mbchar_width(mbchar) ⇒ Object 



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/reline/unicode.rb', line 81

def self.get_mbchar_width(mbchar)
  ord = mbchar.ord
  if ord <= 0x1F # in EscapedPairs
    return 2
  elsif mbchar.length == 1 && ord <= 0x7E # printable ASCII chars
    return 1
  end

  utf8_mbchar = mbchar.encode(Encoding::UTF_8)
  zwj = false
  utf8_mbchar.chars.sum do |c|
    if zwj
      zwj = false
      0
    elsif c.ord == 0x200D # Zero Width Joiner
      zwj = true
      0
    else
      east_asian_width(c.ord)
    end
  end
end

.get_next_mbchar_size(line, byte_pointer) ⇒ Object 



256
257
258
259
 
# File 'lib/reline/unicode.rb', line 256

def self.get_next_mbchar_size(line, byte_pointer)
  grapheme = line.byteslice(byte_pointer..-1).grapheme_clusters.first
  grapheme ? grapheme.bytesize : 0
end

.get_prev_mbchar_size(line, byte_pointer) ⇒ Object 



261
262
263
264
265
266
267
268
 
# File 'lib/reline/unicode.rb', line 261

def self.get_prev_mbchar_size(line, byte_pointer)
  if byte_pointer.zero?
    0
  else
    grapheme = line.byteslice(0..(byte_pointer - 1)).grapheme_clusters.last
    grapheme ? grapheme.bytesize : 0
  end
end

.safe_encode(str, encoding) ⇒ Object 



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/reline/unicode.rb', line 57

def self.safe_encode(str, encoding)
  # Reline only supports utf-8 convertible string.
  converted = str.encode(encoding, invalid: :replace, undef: :replace)
  return converted if str.encoding == Encoding::UTF_8 || converted.encoding == Encoding::UTF_8 || converted.ascii_only?

  # This code is essentially doing the same thing as
  # `str.encode(utf8, **replace_options).encode(encoding, **replace_options)`
  # but also avoids unnecessary irreversible encoding conversion.
  converted.gsub(/\X/) do |c|
    c.encode(Encoding::UTF_8)
    c
  rescue Encoding::UndefinedConversionError
    '?'
  end
end

.space_character?(s) ⇒ Boolean

Returns:

  • (Boolean) 


418
419
420
 
# File 'lib/reline/unicode.rb', line 418

def self.space_character?(s)
  s.match?(/\s/) if s
end

.split_by_width(str, max_width) ⇒ Object

This method is used by IRB



131
132
133
134
 
# File 'lib/reline/unicode.rb', line 131

def self.split_by_width(str, max_width)
  lines = split_line_by_width(str, max_width)
  [lines, lines.size]
end

.split_line_by_width(str, max_width, encoding = str.encoding, offset: 0) ⇒ Object 



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/reline/unicode.rb', line 136

def self.split_line_by_width(str, max_width, encoding = str.encoding, offset: 0)
  lines = [String.new(encoding: encoding)]
  width = offset
  rest = str.encode(Encoding::UTF_8)
  in_zero_width = false
  seq = String.new(encoding: encoding)
  rest.scan(WIDTH_SCANNER) do |non_printing_start, non_printing_end, csi, osc, gc|
    case
    when non_printing_start
      in_zero_width = true
    when non_printing_end
      in_zero_width = false
    when csi
      lines.last << csi
      unless in_zero_width
        if csi == -"\e[m" || csi == -"\e[0m"
          seq.clear
        else
          seq << csi
        end
      end
    when osc
      lines.last << osc
      seq << osc unless in_zero_width
    when gc
      unless in_zero_width
        mbchar_width = get_mbchar_width(gc)
        if (width += mbchar_width) > max_width
          width = mbchar_width
          lines << seq.dup
        end
      end
      lines.last << gc
    end
  end
  # The cursor moves to next line in first
  if width == max_width
    lines << String.new(encoding: encoding)
  end
  lines
end

.strip_non_printing_start_end(prompt) ⇒ Object 



178
179
180
 
# File 'lib/reline/unicode.rb', line 178

def self.strip_non_printing_start_end(prompt)
  prompt.gsub(/\x01([^\x02]*)(?:\x02|\z)/) { $1 }
end

.take_mbchar_range(str, start_col, width, cover_begin: false, cover_end: false, padding: false) ⇒ Object 



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
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/reline/unicode.rb', line 187

def self.take_mbchar_range(str, start_col, width, cover_begin: false, cover_end: false, padding: false)
  chunk = String.new(encoding: str.encoding)

  end_col = start_col + width
  total_width = 0
  rest = str.encode(Encoding::UTF_8)
  in_zero_width = false
  chunk_start_col = nil
  chunk_end_col = nil
  has_csi = false
  rest.scan(WIDTH_SCANNER) do |non_printing_start, non_printing_end, csi, osc, gc|
    case
    when non_printing_start
      in_zero_width = true
    when non_printing_end
      in_zero_width = false
    when csi
      has_csi = true
      chunk << csi
    when osc
      chunk << osc
    when gc
      if in_zero_width
        chunk << gc
        next
      end

      mbchar_width = get_mbchar_width(gc)
      prev_width = total_width
      total_width += mbchar_width

      if (cover_begin || padding ? total_width <= start_col : prev_width < start_col)
        # Current character haven't reached start_col yet
        next
      elsif padding && !cover_begin && prev_width < start_col && start_col < total_width
        # Add preceding padding. This padding might have background color.
        chunk << ' ' * (total_width - start_col)
        chunk_start_col ||= start_col
        chunk_end_col = total_width
        next
      elsif (cover_end ? prev_width < end_col : total_width <= end_col)
        # Current character is in the range
        chunk << gc
        chunk_start_col ||= prev_width
        chunk_end_col = total_width
        break if total_width >= end_col
      else
        # Current character exceeds end_col
        if padding && end_col < total_width
          # Add succeeding padding. This padding might have background color.
          chunk << ' ' * (end_col - prev_width)
          chunk_start_col ||= prev_width
          chunk_end_col = end_col
        end
        break
      end
    end
  end
  chunk_start_col ||= start_col
  chunk_end_col ||= start_col
  if padding && chunk_end_col < end_col
    # Append padding. This padding should not include background color.
    chunk << "\e[0m" if has_csi
    chunk << ' ' * (end_col - chunk_end_col)
    chunk_end_col = end_col
  end
  [chunk, chunk_start_col, chunk_end_col - chunk_start_col]
end

.take_range(str, start_col, max_width) ⇒ Object

Take a chunk of a String cut by width with escape sequences.



183
184
185
 
# File 'lib/reline/unicode.rb', line 183

def self.take_range(str, start_col, max_width)
  take_mbchar_range(str, start_col, max_width).first
end

.vi_backward_word(line, byte_pointer) ⇒ Object 



384
385
386
387
388
389
390
391
 
# File 'lib/reline/unicode.rb', line 384

def self.vi_backward_word(line, byte_pointer)
  gcs = line.byteslice(0, byte_pointer).grapheme_clusters.reverse
  spaces = gcs.take_while { |c| space_character?(c) }
  gcs.shift(spaces.size)
  start_with_word = word_character?(gcs.first)
  matched = gcs.take_while { |c| start_with_word ? word_character?(c) : !word_character?(c) && !space_character?(c) }
  spaces.sum(&:bytesize) + matched.sum(&:bytesize)
end

.vi_big_backward_word(line, byte_pointer) ⇒ Object 



339
340
341
342
343
344
 
# File 'lib/reline/unicode.rb', line 339

def self.vi_big_backward_word(line, byte_pointer)
  gcs = line.byteslice(0, byte_pointer).grapheme_clusters.reverse
  spaces = gcs.take_while { |c| space_character?(c) }
  nonspaces = gcs.drop(spaces.size).take_while { |c| !space_character?(c) }
  spaces.sum(&:bytesize) + nonspaces.sum(&:bytesize)
end

.vi_big_forward_end_word(line, byte_pointer) ⇒ Object 



329
330
331
332
333
334
335
336
337
 
# File 'lib/reline/unicode.rb', line 329

def self.vi_big_forward_end_word(line, byte_pointer)
  gcs = line.byteslice(byte_pointer..).grapheme_clusters
  first = gcs.shift(1)
  spaces = gcs.take_while { |c| space_character?(c) }
  nonspaces = gcs.drop(spaces.size).take_while { |c| !space_character?(c) }
  matched = spaces + nonspaces
  matched.pop
  first.sum(&:bytesize) + matched.sum(&:bytesize)
end

.vi_big_forward_word(line, byte_pointer) ⇒ Object 



322
323
324
325
326
327
 
# File 'lib/reline/unicode.rb', line 322

def self.vi_big_forward_word(line, byte_pointer)
  gcs = line.byteslice(byte_pointer..).grapheme_clusters
  nonspaces = gcs.take_while { |c| !space_character?(c) }
  spaces = gcs.drop(nonspaces.size).take_while { |c| space_character?(c) }
  nonspaces.sum(&:bytesize) + spaces.sum(&:bytesize)
end

.vi_first_print(line) ⇒ Object 



406
407
408
409
410
 
# File 'lib/reline/unicode.rb', line 406

def self.vi_first_print(line)
  gcs = line.grapheme_clusters
  spaces = gcs.take_while { |c| space_character?(c) }
  spaces.sum(&:bytesize)
end

.vi_forward_end_word(line, byte_pointer) ⇒ Object 



366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'lib/reline/unicode.rb', line 366

def self.vi_forward_end_word(line, byte_pointer)
  gcs = line.byteslice(byte_pointer..).grapheme_clusters
  return 0 if gcs.empty?
  return gcs.first.bytesize if gcs.size == 1

  start = gcs.shift
  skips = [start]
  if space_character?(start) || space_character?(gcs.first)
    spaces = gcs.take_while { |c| space_character?(c) }
    skips += spaces
    gcs.shift(spaces.size)
  end
  start_with_word = word_character?(gcs.first)
  matched = gcs.take_while { |c| start_with_word ? word_character?(c) : !word_character?(c) && !space_character?(c) }
  matched.pop
  skips.sum(&:bytesize) + matched.sum(&:bytesize)
end

.vi_forward_word(line, byte_pointer, drop_terminate_spaces = false) ⇒ Object 



346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
 
# File 'lib/reline/unicode.rb', line 346

def self.vi_forward_word(line, byte_pointer, drop_terminate_spaces = false)
  gcs = line.byteslice(byte_pointer..).grapheme_clusters
  return 0 if gcs.empty?

  c = gcs.first
  matched =
    if word_character?(c)
      gcs.take_while { |c| word_character?(c) }
    elsif space_character?(c)
      gcs.take_while { |c| space_character?(c) }
    else
      gcs.take_while { |c| !word_character?(c) && !space_character?(c) }
    end

  return matched.sum(&:bytesize) if drop_terminate_spaces

  spaces = gcs.drop(matched.size).take_while { |c| space_character?(c) }
  matched.sum(&:bytesize) + spaces.sum(&:bytesize)
end

.word_character?(s) ⇒ Boolean

Returns:

  • (Boolean) 


412
413
414
415
416
 
# File 'lib/reline/unicode.rb', line 412

def self.word_character?(s)
  s.encode(Encoding::UTF_8).match?(/\p{Word}/) if s
rescue Encoding::UndefinedConversionError
  false
end