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 collapse

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
NON_PRINTING_START =

:nodoc:

"\1"
NON_PRINTING_END =

:nodoc:

"\2"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ AttributeManager

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



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/rdoc/markup/attribute_manager.rb', line 69

def initialize
  @html_tags = {}
  @matching_word_pairs = {}
  @protectable = %w[<]
  @regexp_handlings = []
  @word_pair_map = {}
  @exclusive_bitmap = 0
  @attributes = RDoc::Markup::Attributes.new

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

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

Instance Attribute Details

#attributes ⇒ Object (readonly)

The attributes enabled for this markup object.



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

def attributes
  @attributes
end

#exclusive_bitmap ⇒ Object (readonly)

A bits of exclusive maps



63
64
65
 
# File 'lib/rdoc/markup/attribute_manager.rb', line 63

def exclusive_bitmap
  @exclusive_bitmap
end

#html_tags ⇒ Object (readonly)

This maps HTML tags to the corresponding attribute char



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

def html_tags
  @html_tags
end

#matching_word_pairs ⇒ Object (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



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

def matching_word_pairs
  @matching_word_pairs
end

#protectable ⇒ Object (readonly)

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



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

def protectable
  @protectable
end

#regexp_handlings ⇒ Object (readonly)

And this maps _regexp handling_ sequences to a name. A regexp handling sequence is something like a WikiWord



59
60
61
 
# File 'lib/rdoc/markup/attribute_manager.rb', line 59

def regexp_handlings
  @regexp_handlings
end

#word_pair_map ⇒ Object (readonly)

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



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

def word_pair_map
  @word_pair_map
end

Instance Method Details

#add_html(tag, name, exclusive = false) ⇒ Object

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

am.add_html 'em', :EM



289
290
291
292
293
 
# File 'lib/rdoc/markup/attribute_manager.rb', line 289

def add_html(tag, name, exclusive = false)
  bitmap = @attributes.bitmap_for name
  @html_tags[tag.downcase] = bitmap
  @exclusive_bitmap |= bitmap if exclusive
end

#add_regexp_handling(pattern, name, exclusive = false) ⇒ Object

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

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



301
302
303
304
305
 
# File 'lib/rdoc/markup/attribute_manager.rb', line 301

def add_regexp_handling pattern, name, exclusive = false
  bitmap = @attributes.bitmap_for(name)
  @regexp_handlings << [pattern, bitmap]
  @exclusive_bitmap |= bitmap if exclusive
end

#add_word_pair(start, stop, name, exclusive = false) ⇒ Object

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) 


264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/rdoc/markup/attribute_manager.rb', line 264

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

  bitmap = @attributes.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!

  @exclusive_bitmap |= bitmap if exclusive
end

#attribute(turn_on, turn_off) ⇒ Object

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



92
93
94
 
# File 'lib/rdoc/markup/attribute_manager.rb', line 92

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

#change_attribute(current, new) ⇒ Object

Changes the current attribute from current to new



99
100
101
102
 
# File 'lib/rdoc/markup/attribute_manager.rb', line 99

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

#changed_attribute_by_name(current_set, new_set) ⇒ Object

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



108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/rdoc/markup/attribute_manager.rb', line 108

def changed_attribute_by_name current_set, new_set
  current = new = 0
  current_set.each do |name|
    current |= @attributes.bitmap_for(name)
  end

  new_set.each do |name|
    new |= @attributes.bitmap_for(name)
  end

  change_attribute(current, new)
end

#convert_attrs(str, attrs, exclusive = false) ⇒ Object

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



142
143
144
145
 
# File 'lib/rdoc/markup/attribute_manager.rb', line 142

def convert_attrs(str, attrs, exclusive = false)
  convert_attrs_matching_word_pairs(str, attrs, exclusive)
  convert_attrs_word_pair_map(str, attrs, exclusive)
end

#convert_attrs_matching_word_pairs(str, attrs, exclusive) ⇒ Object 



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
 
# File 'lib/rdoc/markup/attribute_manager.rb', line 147

def convert_attrs_matching_word_pairs(str, attrs, exclusive)
  # first do matching ones
  tags = @matching_word_pairs.select { |start, bitmap|
    if exclusive && exclusive?(bitmap)
      true
    elsif !exclusive && !exclusive?(bitmap)
      true
    else
      false
    end
  }.keys
  return if tags.empty?
  all_tags = @matching_word_pairs.keys

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

  1 while str.gsub!(re) { |orig|
    attr = @matching_word_pairs[$2]
    attr_updated = attrs.set_attrs($`.length + $1.length + $2.length, $3.length, attr)
    if attr_updated
      $1 + NULL * $2.length + $3 + NULL * $2.length + $4
    else
      $1 + NON_PRINTING_START + $2 + NON_PRINTING_END + $3 + NON_PRINTING_START + $2 + NON_PRINTING_END + $4
    end
  }
  str.delete!(NON_PRINTING_START + NON_PRINTING_END)
end

#convert_attrs_word_pair_map(str, attrs, exclusive) ⇒ Object 



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/rdoc/markup/attribute_manager.rb', line 175

def convert_attrs_word_pair_map(str, attrs, exclusive)
  # then non-matching
  unless @word_pair_map.empty? then
    @word_pair_map.each do |regexp, attr|
      if !exclusive
        next if exclusive?(attr)
      else
        next if !exclusive?(attr)
      end
      1 while str.gsub!(regexp) { |orig|
        updated = attrs.set_attrs($`.length + $1.length, $2.length, attr)
        if updated
          NULL * $1.length + $2 + NULL * $3.length
        else
          orig
        end
      }
    end
  end
end

#convert_html(str, attrs, exclusive = false) ⇒ Object

Converts HTML tags to RDoc attributes



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

def convert_html(str, attrs, exclusive = false)
  tags = @html_tags.select { |start, bitmap|
    if exclusive && exclusive?(bitmap)
      true
    elsif !exclusive && !exclusive?(bitmap)
      true
    else
      false
    end
  }.keys.join '|'

  1 while str.gsub!(/<(#{tags})>(.*?)<\/\1>/i) { |orig|
    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

#convert_regexp_handlings(str, attrs, exclusive = false) ⇒ Object

Converts regexp handling sequences to RDoc attributes



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/rdoc/markup/attribute_manager.rb', line 222

def convert_regexp_handlings str, attrs, exclusive = false
  @regexp_handlings.each do |regexp, attribute|
    if exclusive
      next if !exclusive?(attribute)
    else
      next if exclusive?(attribute)
    end
    str.scan(regexp) do
      capture = $~.size == 1 ? 0 : 1

      s, e = $~.offset capture

      attrs.set_attrs s, e - s, attribute | @attributes.regexp_handling
    end
  end
end

#copy_string(start_pos, end_pos) ⇒ Object

Copies start_pos to end_pos from the current string



124
125
126
127
128
 
# File 'lib/rdoc/markup/attribute_manager.rb', line 124

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

#display_attributes ⇒ Object

Debug method that prints a string along with its attributes



332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/rdoc/markup/attribute_manager.rb', line 332

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

#exclusive?(attr) ⇒ Boolean

Returns:

  • (Boolean) 


130
131
132
 
# File 'lib/rdoc/markup/attribute_manager.rb', line 130

def exclusive?(attr)
  (attr & @exclusive_bitmap) != 0
end

#flow(str) ⇒ Object

Processes str converting attributes, HTML and regexp handlings



310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/rdoc/markup/attribute_manager.rb', line 310

def flow str
  @str = str.dup

  mask_protected_sequences

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

  convert_attrs            @str, @attrs, true
  convert_html             @str, @attrs, true
  convert_regexp_handlings @str, @attrs, true
  convert_attrs            @str, @attrs
  convert_html             @str, @attrs
  convert_regexp_handlings @str, @attrs

  unmask_protected_sequences

  split_into_flow
end

#mask_protected_sequences ⇒ Object

Escapes regexp handling sequences of text to prevent conversion to RDoc



242
243
244
245
246
247
248
249
 
# File 'lib/rdoc/markup/attribute_manager.rb', line 242

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

#split_into_flow ⇒ Object

Splits the string into chunks by attribute change



357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
 
# File 'lib/rdoc/markup/attribute_manager.rb', line 357

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 & @attributes.regexp_handling) != 0 then
        i += 1 while
          i < str_len and (@attrs[i] & @attributes.regexp_handling) != 0

        res << RDoc::Markup::RegexpHandling.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

#unmask_protected_sequences ⇒ Object

Unescapes regexp handling sequences of text



254
255
256
 
# File 'lib/rdoc/markup/attribute_manager.rb', line 254

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