Class RDoc::Markup::AttributeManager
In: lib/rdoc/markup/attribute_manager.rb
Parent: Object

Methods

add_html   add_special   add_word_pair   attribute   change_attribute   changed_attribute_by_name   convert_attrs   convert_html   convert_specials   copy_string   display_attributes   flow   mask_protected_sequences   new   split_into_flow   unmask_protected_sequences  

Constants

NULL = "\000".freeze
A_PROTECT = 004   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
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 = %w[<\\]   A \ in front of a character that would normally be processed turns off processing. We do this by turning < into <#{PROTECT}

Public Class methods

Public Instance methods

attribute(turn_on, turn_off)

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

convert_attrs(str, attrs)

Map attributes like textto the sequence \001\002<char>\001\003<char>, where <char> is a per-attribute specific character

[Validate]

ruby-doc.org is hosted and maintained by James Britt and Happy Camper Studios, a Ruby application development company in Phoenix, Arizona. The site was created in 2002 as part of the Ruby Documentation Project to promote the Ruby language and to help other Ruby hackers.

Documentation content on ruby-doc.org is provided by remarkable members of the Ruby community.

For more information on the Ruby programming language, visit ruby-lang.org.

Want to help improve Ruby's API docs? See Ruby Documentation Guidelines.