Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://ruby.github.io/rdoc/RDoc/Markup/Formatter.html below:

class RDoc::Markup::Formatter - rdoc Documentation

1. RDoc::
2. Markup::
3. Formatter

Base class for RDoc markup formatters

Formatters are a visitor that converts an RDoc::Markup tree (from a comment) into some kind of output. RDoc ships with formatters for converting back to rdoc, ANSI text, HTML, a Table of Contents and other formats.

If you’d like to write your own Formatter use RDoc::Markup::FormatterTestCase. If you’re writing a text-output formatter use RDoc::Markup::TextFormatterTestCase which provides extra test cases.

InlineTag

Tag for inline markup containing a bit for the bitmask and the on and off triggers.

def self.gen_relative_url(path, target)
  from        = File.dirname path
  to, to_file = File.split target

  from = from.split "/"
  to   = to.split "/"

  from.delete '.'
  to.delete '.'

  while from.size > 0 and to.size > 0 and from[0] == to[0] do
    from.shift
    to.shift
  end

  from.fill ".."
  from.concat to
  from << to_file
  File.join(*from)
end

Converts a target url to one that is relative to a given path

def initialize(options, markup = nil)
  @options = options

  @markup = markup || RDoc::Markup.new
  @am     = @markup.attribute_manager
  @am.add_regexp_handling(/<br>/, :HARD_BREAK)

  @attributes = @am.attributes

  @attr_tags = []

  @in_tt = 0
  @tt_bit = @attributes.bitmap_for :TT

  @hard_break = ''
  @from_path = '.'
end

Creates a new Formatter

def accept_document(document)
  document.parts.each do |item|
    case item
    when RDoc::Markup::Document then 
      accept_document item
    else
      item.accept self
    end
  end
end

Adds document to the output

def add_regexp_handling_RDOCLINK
  @markup.add_regexp_handling(/rdoc-[a-z]+:[^\s\]]+/, :RDOCLINK)
end

Adds a regexp handling for links of the form rdoc-…:

def add_regexp_handling_TIDYLINK
  @markup.add_regexp_handling(/(?:
                                \{[^{}]*\} | # multi-word label
                                \b[^\s{}]+? # single-word label
                               )

                               \[\S+?\]     # link target
                              /x, :TIDYLINK)
end

Adds a regexp handling for links of the form <text> and <word>

def add_tag(name, start, stop)
  attr = @attributes.bitmap_for name
  @attr_tags << InlineTag.new(attr, start, stop)
end

Add a new set of tags for an attribute. We allow separate start and end tags for flexibility

def annotate(tag)
  tag
end

Allows tag to be decorated with additional information.

def convert(content)
  @markup.convert content, self
end

Marks up content

def convert_flow(flow)
  res = []

  flow.each do |item|
    case item
    when String then
      res << convert_string(item)
    when RDoc::Markup::AttrChanger then
      off_tags res, item
      on_tags res, item
    when RDoc::Markup::RegexpHandling then
      res << convert_regexp_handling(item)
    else
      raise "Unknown flow element: #{item.inspect}"
    end
  end

  res.join
end

Converts flow items flow

def convert_regexp_handling(target)
  return target.text if in_tt?

  handled = false

  @attributes.each_name_of target.type do |name|
    method_name = "handle_regexp_#{name}"

    if respond_to? method_name then
      target.text = public_send method_name, target
      handled = true
    end
  end

  unless handled then
    target_name = @attributes.as_string target.type

    raise RDoc::Error, "Unhandled regexp handling #{target_name}: #{target}"
  end

  target.text
end

Converts added regexp handlings. See RDoc::Markup#add_regexp_handling

def convert_string(string)
  string
end

Converts a string to be fancier if desired

def each_attr_tag(attr_mask, reverse = false)
  return if attr_mask.zero?

  @attr_tags.public_send(reverse ? :reverse_each : :each) do |tag|
    if attr_mask & tag.bit != 0 then
      yield tag
    end
  end
end

Use ignore in your subclass to ignore the content of a node.

alias accept_raw ignore

def in_tt?
  @in_tt > 0
end

Are we currently inside tt tags?

def parse_url(url)
  case url
  when /^rdoc-label:([^:]*)(?::(.*))?/ then
    scheme = 'link'
    path   = "##{$1}"
    id     = " id=\"#{$2}\"" if $2
  when /([A-Za-z]+):(.*)/ then
    scheme = $1.downcase
    path   = $2
  when /^#/ then
  else
    scheme = 'http'
    path   = url
    url    = url
  end

  if scheme == 'link' then
    url = if path[0, 1] == '#' then 
            path
          else
            self.class.gen_relative_url @from_path, path
          end
  end

  [scheme, url, id]
end

Extracts and a scheme, url and an anchor id from url and returns them.

def tt?(tag)
  tag.bit == @tt_bit
end

Is tag a tt tag?

def tt_tag?(attr_mask, reverse = false)
  each_attr_tag(attr_mask, reverse) do |tag|
    return true if tt? tag
  end
  false
end

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4