Class: RDoc::Markup::AttributeManager

Inherits:
Object
  • Object
show all
Defined in:
lib/rdoc/markup/attribute_manager.rb

Overview

Manages changes of attributes in a block of text

Constant Summary

NULL =

The NUL character

"\000".freeze
A_PROTECT =

-- We work by substituting non-printing characters in to the text. For now I'm assuming that I can substitute a character in the range 0..8 for a 7 bit character without damaging the encoded string, but this might be optimistic ++

004
PROTECT_ATTR =

Special mask character to prevent inline markup handling

A_PROTECT.chr

Instance Attribute Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

- (AttributeManager) initialize

Creates a new attribute manager that understands bold, emphasized and teletype text.



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/rdoc/markup/attribute_manager.rb', line 59

def initialize
  @html_tags = {}
  @matching_word_pairs = {}
  @protectable = %w[<]
  @special = {}
  @word_pair_map = {}

  add_word_pair "*", "*", :BOLD
  add_word_pair "_", "_", :EM
  add_word_pair "+", "+", :TT

  add_html "em", :EM
  add_html "i",  :EM
  add_html "b",  :BOLD
  add_html "tt",   :TT
  add_html "code", :TT
end

Instance Attribute Details

- (Object) html_tags (readonly)

This maps HTML tags to the corresponding attribute char



41
42
43
 
# File 'lib/rdoc/markup/attribute_manager.rb', line 41

def html_tags
  @html_tags
end

- (Object) matching_word_pairs (readonly)

This maps delimiters that occur around words (such as bold or tt) where the start and end delimiters and the same. This lets us optimize the regexp



30
31
32
 
# File 'lib/rdoc/markup/attribute_manager.rb', line 30

def matching_word_pairs
  @matching_word_pairs
end

- (Object) protectable (readonly)

A \ in front of a character that would normally be processed turns off processing. We do this by turning < into <#PROTECT



47
48
49
 
# File 'lib/rdoc/markup/attribute_manager.rb', line 47

def protectable
  @protectable
end

- (Object) special (readonly)

And this maps special sequences to a name. A special sequence is something like a WikiWord



53
54
55
 
# File 'lib/rdoc/markup/attribute_manager.rb', line 53

def special
  @special
end

- (Object) word_pair_map (readonly)

And this is used when the delimiters aren't the same. In this case the hash maps a pattern to the attribute character



36
37
38
 
# File 'lib/rdoc/markup/attribute_manager.rb', line 36

def word_pair_map
  @word_pair_map
end

Instance Method Details

- (Object) add_html(tag, name)

Adds a markup class with name for words surrounded by HTML tag tag. To process emphasis tags:

am.add_html 'em', :EM


222
223
224
 
# File 'lib/rdoc/markup/attribute_manager.rb', line 222

def add_html(tag, name)
  @html_tags[tag.downcase] = RDoc::Markup::Attribute.bitmap_for name
end

- (Object) add_special(pattern, name)

Adds a special handler for pattern with name. A simple URL handler would be:

@am.add_special(/((https?:)\S+\w)/, :HYPERLINK)


232
233
234
 
# File 'lib/rdoc/markup/attribute_manager.rb', line 232

def add_special(pattern, name)
  @special[pattern] = RDoc::Markup::Attribute.bitmap_for name
end

- (Object) add_word_pair(start, stop, name)

Adds a markup class with name for words wrapped in the start and stop character. To make words wrapped with "*" bold:

am.add_word_pair '*', '*', :BOLD

Raises:

  • (ArgumentError) 


199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/rdoc/markup/attribute_manager.rb', line 199

def add_word_pair(start, stop, name)
  raise ArgumentError, "Word flags may not start with '<'" if
    start[0,1] == '<'

  bitmap = RDoc::Markup::Attribute.bitmap_for name

  if start == stop then
    @matching_word_pairs[start] = bitmap
  else
    pattern = /(#{Regexp.escape start})(\S+)(#{Regexp.escape stop})/
    @word_pair_map[pattern] = bitmap
  end

  @protectable << start[0,1]
  @protectable.uniq!
end

- (Object) attribute(turn_on, turn_off)

Return an attribute object with the given turn_on and turn_off bits set



80
81
82
 
# File 'lib/rdoc/markup/attribute_manager.rb', line 80

def attribute(turn_on, turn_off)
  RDoc::Markup::AttrChanger.new turn_on, turn_off
end

- (Object) change_attribute(current, new)

Changes the current attribute from current to new



87
88
89
90
 
# File 'lib/rdoc/markup/attribute_manager.rb', line 87

def change_attribute current, new
  diff = current ^ new
  attribute(new & diff, current & diff)
end

- (Object) changed_attribute_by_name(current_set, new_set)

Used by the tests to change attributes by name from current_set to new_set



96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/rdoc/markup/attribute_manager.rb', line 96

def changed_attribute_by_name current_set, new_set
  current = new = 0
  current_set.each do |name|
    current |= RDoc::Markup::Attribute.bitmap_for(name)
  end

  new_set.each do |name|
    new |= RDoc::Markup::Attribute.bitmap_for(name)
  end

  change_attribute(current, new)
end

- (Object) convert_attrs(str, attrs)

Map attributes like textto the sequence 001002<char>001003<char>, where <char> is a per-attribute specific character



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/rdoc/markup/attribute_manager.rb', line 123

def convert_attrs(str, attrs)
  # first do matching ones
  tags = @matching_word_pairs.keys.join("")

  re = /(^|\W)([#{tags}])([#:\\]?[\w.\/-]+?\S?)\2(\W|$)/

  1 while str.gsub!(re) do
    attr = @matching_word_pairs[$2]
    attrs.set_attrs($`.length + $1.length + $2.length, $3.length, attr)
    $1 + NULL * $2.length + $3 + NULL * $2.length + $4
  end

  # then non-matching
  unless @word_pair_map.empty? then
    @word_pair_map.each do |regexp, attr|
      str.gsub!(regexp) {
        attrs.set_attrs($`.length + $1.length, $2.length, attr)
        NULL * $1.length + $2 + NULL * $3.length
      }
    end
  end
end

- (Object) convert_html(str, attrs)

Converts HTML tags to RDoc attributes



149
150
151
152
153
154
155
156
157
158
159
 
# File 'lib/rdoc/markup/attribute_manager.rb', line 149

def convert_html(str, attrs)
  tags = @html_tags.keys.join '|'

  1 while str.gsub!(/<(#{tags})>(.*?)<\/\1>/i) {
    attr = @html_tags[$1.downcase]
    html_length = $1.length + 2
    seq = NULL * html_length
    attrs.set_attrs($`.length + html_length, $2.length, attr)
    seq + $2 + seq + NULL
  }
end

- (Object) convert_specials(str, attrs)

Converts special sequences to RDoc attributes



164
165
166
167
168
169
170
171
172
173
 
# File 'lib/rdoc/markup/attribute_manager.rb', line 164

def convert_specials(str, attrs)
  unless @special.empty?
    @special.each do |regexp, attr|
      str.scan(regexp) do
        attrs.set_attrs($`.length, $&.length,
                        attr | RDoc::Markup::Attribute::SPECIAL)
      end
    end
  end
end

- (Object) copy_string(start_pos, end_pos)

Copies start_pos to end_pos from the current string



112
113
114
115
116
 
# File 'lib/rdoc/markup/attribute_manager.rb', line 112

def copy_string(start_pos, end_pos)
  res = @str[start_pos...end_pos]
  res.gsub!(/\000/, '')
  res
end

- (Object) display_attributes

Debug method that prints a string along with its attributes



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/rdoc/markup/attribute_manager.rb', line 258

def display_attributes
  puts
  puts @str.tr(NULL, "!")
  bit = 1
  16.times do |bno|
    line = ""
    @str.length.times do |i|
      if (@attrs[i] & bit) == 0
        line << " "
      else
        if bno.zero?
          line << "S"
        else
          line << ("%d" % (bno+1))
        end
      end
    end
    puts(line) unless line =~ /^ *$/
    bit <<= 1
  end
end

- (Object) flow(str)

Processes str converting attributes, HTML and specials



239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/rdoc/markup/attribute_manager.rb', line 239

def flow(str)
  @str = str

  mask_protected_sequences

  @attrs = RDoc::Markup::AttrSpan.new @str.length

  convert_attrs    @str, @attrs
  convert_html     @str, @attrs
  convert_specials @str, @attrs

  unmask_protected_sequences

  split_into_flow
end

- (Object) mask_protected_sequences

Escapes special sequences of text to prevent conversion to RDoc



178
179
180
181
182
183
184
 
# File 'lib/rdoc/markup/attribute_manager.rb', line 178

def mask_protected_sequences
  # protect __send__, __FILE__, etc.
  @str.gsub!(/__([a-z]+)__/i,
    "_#{PROTECT_ATTR}_#{PROTECT_ATTR}\\1_#{PROTECT_ATTR}_#{PROTECT_ATTR}")
  @str.gsub!(/\\([#{Regexp.escape @protectable.join('')}])/,
             "\\1#{PROTECT_ATTR}")
end

- (Object) split_into_flow

Splits the string into chunks by attribute change



283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'lib/rdoc/markup/attribute_manager.rb', line 283

def split_into_flow
  res = []
  current_attr = 0

  str_len = @str.length

  # skip leading invisible text
  i = 0
  i += 1 while i < str_len and @str[i].chr == "\0"
  start_pos = i

  # then scan the string, chunking it on attribute changes
  while i < str_len
    new_attr = @attrs[i]
    if new_attr != current_attr
      if i > start_pos
        res << copy_string(start_pos, i)
        start_pos = i
      end

      res << change_attribute(current_attr, new_attr)
      current_attr = new_attr

      if (current_attr & RDoc::Markup::Attribute::SPECIAL) != 0 then
        i += 1 while
          i < str_len and (@attrs[i] & RDoc::Markup::Attribute::SPECIAL) != 0

        res << RDoc::Markup::Special.new(current_attr,
                                         copy_string(start_pos, i))
        start_pos = i
        next
      end
    end

    # move on, skipping any invisible characters
    begin
      i += 1
    end while i < str_len and @str[i].chr == "\0"
  end

  # tidy up trailing text
  if start_pos < str_len
    res << copy_string(start_pos, str_len)
  end

  # and reset to all attributes off
  res << change_attribute(current_attr, 0) if current_attr != 0

  res
end

- (Object) unmask_protected_sequences

Unescapes special sequences of text



189
190
191
 
# File 'lib/rdoc/markup/attribute_manager.rb', line 189

def unmask_protected_sequences
  @str.gsub!(/(.)#{PROTECT_ATTR}/, "\\1\000")
end