Class: RDocF95::Markup::AttributeManager

Inherits:
Object
  • Object
show all
Defined in:
lib/rdoc-f95/markup/inline.rb

Constant Summary collapse

NULL = 
"\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 = 
A_PROTECT.chr
MATCHING_WORD_PAIRS =

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

{}
WORD_PAIR_MAP =

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

{}
HTML_TAGS =

This maps HTML tags to the corresponding attribute char

{}
SPECIAL =

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

{}
PROTECTABLE =

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

%w[<\\]

Instance Method Summary collapse

Constructor Details

#initialize ⇒ AttributeManager

Returns a new instance of AttributeManager.



226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/rdoc-f95/markup/inline.rb', line 226

def initialize
  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)

  add_special(/<!--(.*?)-->/, :COMMENT)
end

Instance Method Details

#add_html(tag, name) ⇒ Object 



256
257
258
 
# File 'lib/rdoc-f95/markup/inline.rb', line 256

def add_html(tag, name)
  HTML_TAGS[tag.downcase] = Attribute.bitmap_for(name)
end

#add_special(pattern, name) ⇒ Object 



260
261
262
 
# File 'lib/rdoc-f95/markup/inline.rb', line 260

def add_special(pattern, name)
  SPECIAL[pattern] = Attribute.bitmap_for(name)
end

#add_word_pair(start, stop, name) ⇒ Object 



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

def add_word_pair(start, stop, name)
  raise "Word flags may not start '<'" if start[0] == ?<
  bitmap = Attribute.bitmap_for(name)
  if start == stop
    MATCHING_WORD_PAIRS[start] = bitmap
  else
    pattern = Regexp.new("(" + Regexp.escape(start) + ")" +
#                             "([A-Za-z]+)" +
                         "(\\S+)" +
                         "(" + Regexp.escape(stop) +")")
    WORD_PAIR_MAP[pattern] = bitmap
  end
  PROTECTABLE << start[0,1]
  PROTECTABLE.uniq!
end

#attribute(turn_on, turn_off) ⇒ Object

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



139
140
141
 
# File 'lib/rdoc-f95/markup/inline.rb', line 139

def attribute(turn_on, turn_off)
  AttrChanger.new(turn_on, turn_off)
end

#change_attribute(current, new) ⇒ Object 



143
144
145
146
 
# File 'lib/rdoc-f95/markup/inline.rb', line 143

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

#changed_attribute_by_name(current_set, new_set) ⇒ Object 



148
149
150
151
152
153
 
# File 'lib/rdoc-f95/markup/inline.rb', line 148

def changed_attribute_by_name(current_set, new_set)
  current = new = 0
  current_set.each {|name| current |= Attribute.bitmap_for(name) }
  new_set.each {|name| new |= Attribute.bitmap_for(name) }
  change_attribute(current, new)
end

#convert_attrs(str, attrs) ⇒ Object

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



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/rdoc-f95/markup/inline.rb', line 166

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

#convert_html(str, attrs) ⇒ Object 



189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/rdoc-f95/markup/inline.rb', line 189

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

#convert_specials(str, attrs) ⇒ Object 



201
202
203
204
205
206
207
208
209
 
# File 'lib/rdoc-f95/markup/inline.rb', line 201

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

#copy_string(start_pos, end_pos) ⇒ Object 



155
156
157
158
159
 
# File 'lib/rdoc-f95/markup/inline.rb', line 155

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

#display_attributes ⇒ Object 



285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/rdoc-f95/markup/inline.rb', line 285

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

#flow(str) ⇒ Object 



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

def flow(str)
  @str = str

  puts("Before flow, str='#{@str.dump}'") if $DEBUG_RDOC
  mask_protected_sequences

  @attrs = AttrSpan.new(@str.length)

  puts("After protecting, str='#{@str.dump}'") if $DEBUG_RDOC

  convert_attrs(@str, @attrs)
  convert_html(@str, @attrs)
  convert_specials(str, @attrs)

  unmask_protected_sequences

  puts("After flow, str='#{@str.dump}'") if $DEBUG_RDOC

  return split_into_flow
end

#mask_protected_sequences ⇒ Object 



217
218
219
220
 
# File 'lib/rdoc-f95/markup/inline.rb', line 217

def mask_protected_sequences
  protect_pattern = Regexp.new("\\\\([#{Regexp.escape(PROTECTABLE.join(''))}])")
  @str.gsub!(protect_pattern, "\\1#{PROTECT_ATTR}")
end

#split_into_flow ⇒ Object 



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
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/rdoc-f95/markup/inline.rb', line 307

def split_into_flow
  display_attributes if $DEBUG_RDOC

  res = []
  current_attr = 0
  str = ""

  str_len = @str.length

  # skip leading invisible text
  i = 0
  i += 1 while i < str_len and @str[i] == "\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 & Attribute::SPECIAL) != 0
        i += 1 while i < str_len and (@attrs[i] & Attribute::SPECIAL) != 0
        res << 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] == "\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

  return res
end

#unmask_protected_sequences ⇒ Object 



222
223
224
 
# File 'lib/rdoc-f95/markup/inline.rb', line 222

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