Beta Shell v2.0

File Manager

~ /usr/share/gems/gems/rdoc-6.0.1.1/lib/rdoc/markup

Name	Size	Perms	Modified	Actions
[ .. / .. ]
attr_changer.rb	424 B	-rw-r--r--	2021-04-05 11:46:35	Edit Del
attr_span.rb	500 B	-rw-r--r--	2021-04-05 11:46:35	Edit Del
attribute_manager.rb	7.95 KB	-rw-r--r--	2021-04-05 11:46:35	Edit Del
attributes.rb	1.19 KB	-rw-r--r--	2021-04-05 11:46:35	Edit Del
blank_line.rb	391 B	-rw-r--r--	2021-04-05 11:46:35	Edit Del
block_quote.rb	252 B	-rw-r--r--	2021-04-05 11:46:35	Edit Del
document.rb	3.15 KB	-rw-r--r--	2021-04-05 11:46:35	Edit Del
formatter.rb	5.31 KB	-rw-r--r--	2021-04-05 11:46:35	Edit Del
formatter_test_case.rb	16.76 KB	-rw-r--r--	2021-04-05 11:46:35	Edit Del
hard_break.rb	446 B	-rw-r--r--	2021-04-05 11:46:35	Edit Del
heading.rb	1.48 KB	-rw-r--r--	2021-04-05 11:46:35	Edit Del
include.rb	829 B	-rw-r--r--	2021-04-05 11:46:35	Edit Del
indented_paragraph.rb	906 B	-rw-r--r--	2021-04-05 11:46:35	Edit Del
inline.rb	118 B	-rw-r--r--	2021-04-05 11:46:35	Edit Del
list.rb	1.82 KB	-rw-r--r--	2021-04-05 11:46:35	Edit Del
list_item.rb	1.71 KB	-rw-r--r--	2021-04-05 11:46:35	Edit Del
paragraph.rb	493 B	-rw-r--r--	2021-04-05 11:46:35	Edit Del
parser.rb	13.72 KB	-rw-r--r--	2021-04-05 11:46:35	Edit Del
pre_process.rb	8.26 KB	-rw-r--r--	2021-04-05 11:46:35	Edit Del
raw.rb	1000 B	-rw-r--r--	2021-04-05 11:46:35	Edit Del
rule.rb	315 B	-rw-r--r--	2021-04-05 11:46:35	Edit Del
special.rb	657 B	-rw-r--r--	2021-04-05 11:46:35	Edit Del
text_formatter_test_case.rb	2.51 KB	-rw-r--r--	2021-04-05 11:46:35	Edit Del
to_ansi.rb	2.05 KB	-rw-r--r--	2021-04-05 11:46:35	Edit Del
to_bs.rb	1.63 KB	-rw-r--r--	2021-04-05 11:46:35	Edit Del
to_html.rb	8.62 KB	-rw-r--r--	2021-04-05 11:46:35	Edit Del
to_html_crossref.rb	4.33 KB	-rw-r--r--	2021-04-05 11:46:35	Edit Del
to_html_snippet.rb	5.45 KB	-rw-r--r--	2021-04-05 11:46:35	Edit Del
to_joined_paragraph.rb	1.1 KB	-rw-r--r--	2021-04-05 11:46:35	Edit Del
to_label.rb	1.83 KB	-rw-r--r--	2021-04-05 11:46:35	Edit Del
to_markdown.rb	3.62 KB	-rw-r--r--	2021-04-05 11:46:35	Edit Del
to_rdoc.rb	6.15 KB	-rw-r--r--	2021-04-05 11:46:35	Edit Del
to_table_of_contents.rb	1.68 KB	-rw-r--r--	2021-04-05 11:46:35	Edit Del
to_test.rb	1.14 KB	-rw-r--r--	2021-04-05 11:46:35	Edit Del
to_tt_only.rb	2.26 KB	-rw-r--r--	2021-04-05 11:46:35	Edit Del
verbatim.rb	1.28 KB	-rw-r--r--	2021-04-05 11:46:35	Edit Del

Editing: document.rb (3.15 KB)

# frozen_string_literal: true
##
# A Document containing lists, headings, paragraphs, etc.

class RDoc::Markup::Document

  include Enumerable

  ##
  # The file this document was created from.  See also
  # RDoc::ClassModule#add_comment

  attr_reader :file

  ##
  # If a heading is below the given level it will be omitted from the
  # table_of_contents

  attr_accessor :omit_headings_below

  ##
  # The parts of the Document

  attr_reader :parts

  ##
  # Creates a new Document with +parts+

  def initialize *parts
    @parts = []
    @parts.concat parts

    @file = nil
    @omit_headings_from_table_of_contents_below = nil
  end

  ##
  # Appends +part+ to the document

  def << part
    case part
    when RDoc::Markup::Document then
      unless part.empty? then
        parts.concat part.parts
        parts << RDoc::Markup::BlankLine.new
      end
    when String then
      raise ArgumentError,
            "expected RDoc::Markup::Document and friends, got String" unless
        part.empty?
    else
      parts << part
    end
  end

  def == other # :nodoc:
    self.class == other.class and
      @file == other.file and
      @parts == other.parts
  end

  ##
  # Runs this document and all its #items through +visitor+

  def accept visitor
    visitor.start_accepting

    visitor.accept_document self

    visitor.end_accepting
  end

  ##
  # Concatenates the given +parts+ onto the document

  def concat parts
    self.parts.concat parts
  end

  ##
  # Enumerator for the parts of this document

  def each &block
    @parts.each(&block)
  end

  ##
  # Does this document have no parts?

  def empty?
    @parts.empty? or (@parts.length == 1 and merged? and @parts.first.empty?)
  end

  ##
  # The file this Document was created from.

  def file= location
    @file = case location
            when RDoc::TopLevel then
              location.relative_name
            else
              location
            end
  end

  ##
  # When this is a collection of documents (#file is not set and this document
  # contains only other documents as its direct children) #merge replaces
  # documents in this class with documents from +other+ when the file matches
  # and adds documents from +other+ when the files do not.
  #
  # The information in +other+ is preferred over the receiver

  def merge other
    if empty? then
      @parts = other.parts
      return self
    end

    other.parts.each do |other_part|
      self.parts.delete_if do |self_part|
        self_part.file and self_part.file == other_part.file
      end

      self.parts << other_part
    end

    self
  end

  ##
  # Does this Document contain other Documents?

  def merged?
    RDoc::Markup::Document === @parts.first
  end

  def pretty_print q # :nodoc:
    start = @file ? "[doc (#{@file}): " : '[doc: '

    q.group 2, start, ']' do
      q.seplist @parts do |part|
        q.pp part
      end
    end
  end

  ##
  # Appends +parts+ to the document

  def push *parts
    self.parts.concat parts
  end

  ##
  # Returns an Array of headings in the document.
  #
  # Require 'rdoc/markup/formatter' before calling this method.

  def table_of_contents
    accept RDoc::Markup::ToTableOfContents.to_toc
  end

end