File: string.rb

package info (click to toggle)
ruby-ansi 1.5.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 404 kB
  • sloc: ruby: 1,880; makefile: 5
file content (254 lines) | stat: -rw-r--r-- 6,134 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
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
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
require 'ansi/code'
#require 'ansi/layout/split'

# Create a new Ansi::String object.
def ANSI.string(str)
  ANSI::String.new(str)
end

# IMPORTANT! ANSI::String is experimental!!!
#
# ANSI::String stores a regular string (`@text`) and an associative
# array that ties a character index to an ANSI code (`marks`).
# For example is we have the string:
#
#   "Big Apple"
#
# And applied the color red to it, the marks list would be:
#
#   [[0, :red], [9, :clear]]
#
# TODO: In the future we may be able to subclass String,
# instead of delegating via @text, but not until it is more
# compatible.
#
class ANSI::String

  CLR = ANSI::Code::CLEAR

  attr :text
  attr :marks

  # New Ansi::String
  def initialize(text=nil, marks=nil)
    @text  = (text  || '').to_s
    @marks = marks  || []
    yield(self) if block_given?
  end

  # Convert Ansi::String object to normal String.
  # This converts the intental markup codes to ANSI codes.
  def to_s
    s = text.dup
    m = marks.sort do |a,b|
      v = b[0] <=> a[0]
      if v == 0
        (b[1] == :clear or b[1] == :reset) ? -1 : 1
      else
        v
      end
    end
    m.each do |(index, code)|
      s.insert(index, ANSI::Code.__send__(code))
    end
    #s << CLR unless s =~ /#{Regexp.escape(CLR)}$/  # always end with a clear
    s
  end

  # ANSI::String is a type of String.
  alias_method :to_str, :to_s

  # The size of the base text.
  def size ; text.size ; end

  # Upcase the string.
  def upcase  ; self.class.new(text.upcase, marks) ; end
  def upcase! ; text.upcase! ; end

  # Downcase the string.
  def downcase  ; self.class.new(text.downcase, marks) ; end
  def downcase! ; text.upcase! ; end

  # Add one String to another, or to a regular String.
  def +(other)
    case other
    when ANSI::String
      ntext  = text + other.text
      nmarks = marks.dup
      omarks = shift_marks(0, text.size, other.marks)
      omarks.each{ |(i, c)| nmarks << [i,c] }
    else
      ntext  = text + other.to_s
      nmarks = marks.dup
    end
    self.class.new(ntext, nmarks)
  end

  #
  #def |(other)
  #  Split.new(self, other)
  #end

  #
  #def lr(other, options={})
  #  Split.new(self, other, options)
  #end

  # slice
  def slice(*args)
    if args.size == 2
      index, len = *args
      endex  = index+len
      new_text  = text[index, len]
      new_marks = []
      marks.each do |(i, v)|
        new_marks << [i, v] if i >= index && i < endex
      end
      self.class.new(new_text, new_marks)
    elsif args.size == 1
      rng = args.first
      case rng
      when Range
        index, endex = rng.begin, rng.end
        new_text  = text[rng]
        new_marks = []
        marks.each do |(i, v)|
          new_marks << [i, v] if i >= index && i < endex
        end
        self.class.new(new_text, new_marks)
      else
        nm = marks.select do |(i, v)|
          #marks[0] == rng or ( marks[0] == rng + 1 && [:clear, :reset].include?(marks[1]) )
          i == rng or ( i == rng + 1 && [:clear, :reset].include?(v) )
        end
        self.class.new(text[rng,1], nm)
      end
    else
      raise ArgumentError
    end
  end

  #
  alias_method :[], :slice

  # This is more limited than the normal String method.
  # It does not yet support a block, and +replacement+
  # won't substitue for \1, \2, etc.
  #
  # TODO: block support.
  def sub!(pattern, replacement=nil, &block)
    mark_changes = []
    text = @text.sub(pattern) do |s|
      index  = $~.begin(0)
      replacement = block.call(s) if block_given?
      delta  = (replacement.size - s.size)
      mark_changes << [index, delta]
      replacement
    end
    marks = @marks
    mark_changes.each do |index, delta|
      marks = shift_marks(index, delta, marks)
    end
    @text  = text
    @marks = marks
    self
  end

  # See #sub!.
  def sub(pattern,replacement=nil, &block)
    dup.sub!(pattern, replacement, &block)
  end

  #
  def gsub!(pattern, replacement=nil, &block)
    mark_changes   = []
    mark_additions = []
    text = @text.gsub(pattern) do |s|
      index = $~.begin(0)
      replacement = block.call(self.class.new(s)) if block_given?
      if self.class===replacement
        adj_marks = replacement.marks.map{ |(i,c)| [i+index,c] }
        mark_additions.concat(adj_marks)
        replacement = replacement.text
      end
      delta = (replacement.size - s.size)
      mark_changes << [index, delta]
      replacement
    end
    marks = @marks
    mark_changes.each do |(index, delta)|
      marks = shift_marks(index, delta, marks)
    end
    marks.concat(mark_additions)
    @text  = text
    @marks = marks
    self
  end

  # See #gsub!.
  def gsub(pattern, replacement=nil, &block)
    dup.gsub!(pattern, replacement, &block)
  end

  #
  def ansi(code)
    m = marks.dup
    m.unshift([0, code])
    m.push([size, :clear])
    self.class.new(text, m)
  end

  alias_method :color, :ansi

  #
  def ansi!(code)
    marks.unshift([0, code])
    marks.push([size, :clear])
  end

  alias_method :color!, :ansi!

  def red        ; color(:red)      ; end
  def green      ; color(:green)    ; end
  def blue       ; color(:blue)     ; end
  def black      ; color(:black)    ; end
  def magenta    ; color(:magenta)  ; end
  def yellow     ; color(:yellow)   ; end
  def cyan       ; color(:cyan)     ; end

  def bold       ; ansi(:bold)       ; end
  def underline  ; ansi(:underline)  ; end

  def red!       ; color!(:red)     ; end
  def green!     ; color!(:green)   ; end
  def blue!      ; color!(:blue)    ; end
  def black!     ; color!(:black)   ; end
  def magenta!   ; color!(:magenta) ; end
  def yellow!    ; color!(:yellow)  ; end
  def cyan!      ; color!(:cyan)    ; end

  def bold!      ; ansi!(:bold)      ; end
  def underline! ; ansi!(:underline) ; end

private

  #
  def shift_marks(index, delta, marks=nil)
    new_marks = []
    (marks || @marks).each do |(i, c)|
      case i <=> index
      when -1
        new_marks << [i, c]
      when 0, 1
        new_marks << [i+delta, c]
      end
    end
    new_marks
  end

  #
  def shift_marks!(index, delta)
    @marks.replace(shift_marks(index, delta))
  end

end