rdoc 2.3.0 → 2.4.0

data/lib/rdoc/parser/c.rb

@@ -311,18 +311,21 @@ class RDoc::Parser::C < RDoc::Parser
       meth_obj.start_collecting_tokens
       meth_obj.add_token RDoc::RubyToken::Token.new(1,1).set_text(body_text)
       meth_obj.comment = mangle_comment comment
-    when %r{((?>/\*.*?\*/\s*))^\s*\#\s*define\s+#{meth_name}\s+(\w+)}m
+    when %r{((?>/\*.*?\*/\s*))^\s*(\#\s*define\s+#{meth_name}\s+(\w+))}m
       comment = $1
-      find_body(class_name, $2, meth_obj, body, true)
-      find_modifiers(comment, meth_obj)
-      meth_obj.comment = mangle_comment(comment) + meth_obj.comment
+      body_text = $2
+      find_body class_name, $3, meth_obj, body, true
+      find_modifiers comment, meth_obj
+
+      meth_obj.start_collecting_tokens
+      meth_obj.add_token RDoc::RubyToken::Token.new(1,1).set_text(body_text)
+      meth_obj.comment = mangle_comment(comment) + meth_obj.comment.to_s
     when %r{^\s*\#\s*define\s+#{meth_name}\s+(\w+)}m
       unless find_body(class_name, $1, meth_obj, body, true)
         warn "No definition for #{meth_name}" unless @options.quiet
         return false
       end
     else
-
       # No body, but might still have an override comment
       comment = find_override_comment(class_name, meth_obj.name)
 
@@ -342,7 +345,7 @@ class RDoc::Parser::C < RDoc::Parser
       if raw_name =~ /^rb_m/
         container = @top_level.add_module RDoc::NormalModule, name
       else
-        container = @top_level.add_class RDoc::NormalClass, name, nil
+        container = @top_level.add_class RDoc::NormalClass, name
       end
 
       container.record_location @top_level
@@ -488,7 +491,12 @@ class RDoc::Parser::C < RDoc::Parser
     end
 
     if class_mod == "class" then
-      full_name = enclosure.full_name.to_s + "::#{class_name}"
+      full_name = if RDoc::ClassModule === enclosure then
+                    enclosure.full_name + "::#{class_name}"
+                  else
+                    class_name
+                  end
+
       if @content =~ %r{Document-class:\s+#{full_name}\s*<\s+([:,\w]+)} then
         parent_name = $1
       end
@@ -499,7 +507,7 @@ class RDoc::Parser::C < RDoc::Parser
       @stats.add_module cm
     end
 
-    cm.record_location enclosure.toplevel
+    cm.record_location enclosure.top_level
 
     find_class_comment cm.full_name, cm
 

data/lib/rdoc/parser/ruby.rb

@@ -1803,8 +1803,7 @@ class RDoc::Parser::Ruby < RDoc::Parser
     when "attr_writer"   then rw = "W"
     when "attr_accessor" then rw = "RW"
     else
-      rw = @options.extra_accessor_flags[tk.name]
-      rw = '?' if rw.nil?
+      rw = '?'
     end
 
     for name in args
@@ -1995,7 +1994,7 @@ class RDoc::Parser::Ruby < RDoc::Parser
     indent = TkSPACE.new 1, 1
     indent.set_text " " * column
 
-    position_comment = TkCOMMENT.new(line_no, 1, "# File #{@top_level.file_absolute_name}, line #{line_no}")
+    position_comment = TkCOMMENT.new(line_no, 1, "# File #{@top_level.absolute_name}, line #{line_no}")
     meth.add_tokens [position_comment, NEWLINE_TOKEN, indent]
 
     meth.params = ''
@@ -2049,7 +2048,7 @@ class RDoc::Parser::Ruby < RDoc::Parser
         remove_token_listener self
         return
       else
-        warn "#{container.toplevel.file_relative_name}:#{name_t.line_no} unknown name token #{name_t.inspect} for meta-method '#{tk.name}'"
+        warn "unknown name token #{name_t.inspect} for meta-method '#{tk.name}'"
         name = 'unknown'
       end
     end
@@ -2065,7 +2064,7 @@ class RDoc::Parser::Ruby < RDoc::Parser
     indent = TkSPACE.new 1, 1
     indent.set_text " " * column
 
-    position_comment = TkCOMMENT.new(line_no, 1, "# File #{@top_level.file_absolute_name}, line #{line_no}")
+    position_comment = TkCOMMENT.new(line_no, 1, "# File #{@top_level.absolute_name}, line #{line_no}")
     meth.add_tokens [position_comment, NEWLINE_TOKEN, indent]
     meth.add_tokens @token_stream
 
@@ -2150,7 +2149,7 @@ class RDoc::Parser::Ruby < RDoc::Parser
           container.record_location @top_level
         end
       else
-        # warn("Unexpected token '#{name_t2.inspect}'")
+        warn "unexpected method name token #{name_t2.inspect}"
         # break
         skip_method(container)
         return
@@ -2163,6 +2162,13 @@ class RDoc::Parser::Ruby < RDoc::Parser
       back_tk.reverse_each do |token|
         unget_tk token
       end
+
+      unless name_t.respond_to? :name then
+        warn "unexpected method name token #{name_t.inspect}"
+        skip_method container
+        return
+      end
+
       name = name_t.name
 
       meth = RDoc::AnyMethod.new get_tkread, name
@@ -2177,7 +2183,7 @@ class RDoc::Parser::Ruby < RDoc::Parser
     indent = TkSPACE.new 1, 1
     indent.set_text " " * column
 
-    token = TkCOMMENT.new(line_no, 1, "# File #{@top_level.file_absolute_name}, line #{line_no}")
+    token = TkCOMMENT.new(line_no, 1, "# File #{@top_level.absolute_name}, line #{line_no}")
     meth.add_tokens [token, NEWLINE_TOKEN, indent]
     meth.add_tokens @token_stream
 
@@ -2437,7 +2443,7 @@ class RDoc::Parser::Ruby < RDoc::Parser
             keep_comment = true
           when 'attr' then
             parse_attr container, single, tk, comment
-          when /^attr_(reader|writer|accessor)$/, @options.extra_accessors then
+          when /^attr_(reader|writer|accessor)$/ then
             parse_attr_accessor container, single, tk, comment
           when 'alias_method' then
             if container.document_self then
@@ -2536,7 +2542,7 @@ class RDoc::Parser::Ruby < RDoc::Parser
     end
   end
 
-  def parse_toplevel_statements(container)
+  def parse_top_level_statements(container)
     comment = collect_first_comment
     look_for_directives_in(container, comment)
     container.comment = comment unless comment.empty?
@@ -2706,7 +2712,7 @@ class RDoc::Parser::Ruby < RDoc::Parser
     catch(:eof) do
       catch(:enddoc) do
         begin
-          parse_toplevel_statements(@top_level)
+          parse_top_level_statements(@top_level)
         rescue Exception => e
           $stderr.puts <<-EOF
 

data/lib/rdoc/parser/simple.rb

@@ -23,7 +23,7 @@ class RDoc::Parser::Simple < RDoc::Parser
   end
 
   ##
-  # Extract the file contents and attach them to the toplevel as a comment
+  # Extract the file contents and attach them to the TopLevel as a comment
 
   def scan
     @top_level.comment = remove_private_comments(@content)

data/lib/rdoc/rdoc.rb

@@ -6,7 +6,6 @@ require 'rdoc/parser'
 require 'rdoc/parser/simple'
 require 'rdoc/parser/ruby'
 require 'rdoc/parser/c'
-require 'rdoc/parser/f95'
 require 'rdoc/parser/perl'
 
 require 'rdoc/stats'
@@ -33,6 +32,16 @@ module RDoc
 
   class RDoc
 
+    ##
+    # Generator instance used for creating output
+
+    attr_accessor :generator
+
+    ##
+    # RDoc options
+
+    attr_reader :options
+
     ##
     # Accessor for statistics.  Available after each call to parse_files
 
@@ -51,7 +60,23 @@ module RDoc
       GENERATORS[name] = klass
     end
 
+    ##
+    # Active RDoc::RDoc instance
+
+    def self.current
+      @current
+    end
+
+    ##
+    # Sets the active RDoc::RDoc instance
+
+    def self.current=(rdoc)
+      @current = rdoc
+    end
+
     def initialize
+      @generator = nil
+      @options = nil
       @stats = nil
     end
 
@@ -68,9 +93,10 @@ module RDoc
     # we may clobber some manually generated documentation
 
     def setup_output_dir(op_dir, force)
-      flag_file = output_flag_file(op_dir)
-      if File.exist?(op_dir)
-        unless File.directory?(op_dir)
+      flag_file = output_flag_file op_dir
+
+      if File.exist? op_dir then
+        unless File.directory? op_dir then
           error "'#{op_dir}' exists, and is not a directory"
         end
         begin
@@ -94,14 +120,14 @@ module RDoc
     # Update the flag file in an output directory.
 
     def update_output_dir(op_dir, time)
-      File.open(output_flag_file(op_dir), "w") {|f| f.puts time.rfc2822 }
+      File.open(output_flag_file(op_dir), "w") { |f| f.puts time.rfc2822 }
     end
 
     ##
     # Return the path name of the flag file in an output directory.
 
     def output_flag_file(op_dir)
-      File.join(op_dir, "created.rid")
+      File.join op_dir, "created.rid"
     end
 
     ##
@@ -119,6 +145,7 @@ module RDoc
         candidates = Dir.glob(File.join(in_dir, patt))
         result.concat(normalized_file_list(options,  candidates))
       end
+
       result
     end
 
@@ -188,17 +215,17 @@ module RDoc
 
       return [] if file_list.empty?
 
-      jobs = SizedQueue.new(number_of_threads * 3)
+      jobs = SizedQueue.new(@options.threads * 3)
       workers = []
       file_info = []
       file_info_lock = Mutex.new
 
       Thread.abort_on_exception = true
       @stats = Stats.new(file_list.size, options.verbosity)
-      @stats.begin_adding(number_of_threads)
+      @stats.begin_adding @options.threads
 
       # Create worker threads.
-      number_of_threads.times do
+      @options.threads.times do
         thread = Thread.new do
           while (filename = jobs.pop)
             @stats.add_file(filename)
@@ -248,16 +275,12 @@ module RDoc
     # Throws: RDoc::Error on error
 
     def document(argv)
-      TopLevel::reset
+      TopLevel.reset
 
       @options = Options.new
       @options.parse argv
 
-      @last_created = nil
-
-      unless @options.all_one_file then
-        @last_created = setup_output_dir @options.op_dir, @options.force_update
-      end
+      @last_created = setup_output_dir @options.op_dir, @options.force_update
 
       start_time = Time.now
 
@@ -268,23 +291,27 @@ module RDoc
       if file_info.empty?
         $stderr.puts "\nNo newer files." unless @options.quiet
       else
-        generator = @options.generator
+        gen_klass = @options.generator
 
-        $stderr.puts "\nGenerating #{generator.name.sub(/^.*::/, '')}..." unless
-          @options.quiet
+        unless @options.quiet then
+          $stderr.puts "\nGenerating #{gen_klass.name.sub(/^.*::/, '')}..."
+        end
 
-        @gen = generator.for @options
+        @generator = gen_klass.for @options
 
         pwd = Dir.pwd
 
-        Dir.chdir @options.op_dir unless @options.all_one_file
+        Dir.chdir @options.op_dir
 
         begin
+          self.class.current = self
+
           Diagram.new(file_info, @options).draw if @options.diagram
-          @gen.generate(file_info)
-          update_output_dir(".", start_time)
+          @generator.generate file_info
+          update_output_dir ".", start_time
         ensure
-          Dir.chdir(pwd)
+          self.class.current = nil
+          Dir.chdir pwd
         end
       end
 
@@ -296,15 +323,6 @@ module RDoc
 
     private
 
-    def number_of_threads
-      @@number_of_threads ||=
-        if RUBY_PLATFORM == "java"
-          Java::java::lang::Runtime.getRuntime.availableProcessors * 2
-        else
-          2
-        end
-    end
-
     def read_file_contents(filename)
       content = if RUBY_VERSION >= '1.9' then
                   File.open(filename, "r:ascii-8bit") { |f| f.read }
@@ -339,7 +357,5 @@ end
 
 # require built-in generators after discovery in case they've been replaced
 require 'rdoc/generator/darkfish'
-require 'rdoc/generator/html'
 require 'rdoc/generator/ri'
-require 'rdoc/generator/xml'
 

data/lib/rdoc/require.rb

@@ -0,0 +1,32 @@
+require 'rdoc/code_object'
+
+##
+# A file loaded by \#require
+
+class RDoc::Require < RDoc::CodeObject
+
+  ##
+  # Name of the required file
+
+  attr_accessor :name
+
+  ##
+  # Creates a new Require that loads +name+ with +comment+
+
+  def initialize(name, comment)
+    super()
+    @name = name.gsub(/'|"/, "") #'
+    self.comment = comment
+  end
+
+  def inspect # :nodoc:
+    "#<%s:0x%x require '%s' in %s>" % [
+      self.class,
+      object_id,
+      @name,
+      parent_file_name,
+    ]
+  end
+
+end
+

data/lib/rdoc/ri/descriptions.rb

@@ -129,7 +129,7 @@ class RDoc::RI::ClassDescription < RDoc::RI::ModuleDescription
   attr_accessor :superclass
 
   def display_name
-      "Class"
+    "Class"
   end
 
   def superclass_string

data/lib/rdoc/ri/driver.rb

@@ -607,7 +607,7 @@ Options may also be set in the 'RI' environment variable.
   def expand_klass(klass)
     klass.split('::').inject '' do |expanded, klass_part|
       expanded << '::' unless expanded.empty?
-      expanded << klass_part
+      short = expanded << klass_part
 
       subset = class_cache.keys.select do |klass|
         klass =~ /^#{expanded}[^:]*$/
@@ -615,11 +615,11 @@ Options may also be set in the 'RI' environment variable.
 
       abbrevs = Abbrev.abbrev subset
 
-      expanded = abbrevs[expanded].dup
+      expanded = abbrevs[short]
 
-      raise NotFoundError, expanded unless expanded
+      raise NotFoundError, short unless expanded
 
-      expanded
+      expanded.dup
     end
   end
 

data/lib/rdoc/ri/formatter.rb

@@ -443,88 +443,126 @@ end
 
 class RDoc::RI::HtmlFormatter < RDoc::RI::AttributeFormatter
 
-  def write_attribute_text(prefix, line)
-    curr_attr = 0
-    line.each do |achar|
-      attr = achar.attr
-      if achar.attr != curr_attr
-        update_attributes(curr_attr, achar.attr)
-        curr_attr = achar.attr
-      end
-      @output.print(escape(achar.char))
-    end
-    update_attributes(curr_attr, 0) unless curr_attr.zero?
-  end
+  ##
+  # We depend on HTML4-conforming user agents to ignore an empty p element
 
-  def draw_line(label=nil)
-    if label != nil
-      bold_print(label)
-    end
-    @output.puts("<hr>")
+  def blankline
+    @output.puts '<p />'
   end
 
-  def bold_print(txt)
-    tag("b") { txt }
-  end
+  ##
+  # Emboldens +text+
 
-  def blankline()
-    @output.puts("<p>")
+  def bold_print(text)
+    tag("b") { text }
   end
 
+  ##
+  # Outputs a forced line break element
+
   def break_to_newline
-    @output.puts("<br>")
+    @output.puts '<br />'
   end
 
+  ##
+  # Outputs heading elements for +text+ with +level+ up to 4.  Ignores
+  # +indent+.
+
   def display_heading(text, level, indent)
     level = 4 if level > 4
     tag("h#{level}") { text }
     @output.puts
   end
 
+  ##
+  # Outputs +list+ which is displayed as follows:
+  #
+  # BULLET:: unordered list
+  # NUMBER:: ordered list
+  # LABELED:: definition list
+  # NOTE:: table
+
   def display_list(list)
     case list.type
     when :BULLET then
       list_type = "ul"
-      prefixer = proc { |ignored| "<li>" }
+      prefixer = proc { |ignored| '<li>' }
+      suffix = '</li>'
 
     when :NUMBER, :UPPERALPHA, :LOWERALPHA then
       list_type = "ol"
-      prefixer = proc { |ignored| "<li>" }
+      prefixer = proc { |ignored| '<li>' }
+      suffix = '</li>'
 
     when :LABELED then
       list_type = "dl"
       prefixer = proc do |li|
-        "<dt><b>" + escape(li.label) + "</b><dd>"
+        "<dt><b>#{escape li.label}</b></dt><dd>"
       end
+      suffix = '</dd>'
 
     when :NOTE then
       list_type = "table"
       prefixer = proc do |li|
         %{<tr valign="top"><td>#{li.label.gsub(/ /, '&nbsp;')}</td><td>}
       end
+      suffix = '</td></tr>'
     else
       fail "unknown list type"
     end
 
     @output.print "<#{list_type}>"
+
     list.contents.each do |item|
       if item.kind_of? RDoc::Markup::Flow::LI
-        prefix = prefixer.call(item)
+        prefix = prefixer.call item
         @output.print prefix
-        display_flow_item(item, prefix)
+        display_flow_item item, prefix
+        @output.print suffix
       else
-        display_flow_item(item)
+        display_flow_item item
       end
     end
+
     @output.print "</#{list_type}>"
   end
 
+  ##
+  # Outputs a preformatted section for +item+.  +prefix+ is ignored.
+
   def display_verbatim_flow_item(item, prefix=@indent)
-    @output.print("<pre>")
+    @output.print '<pre>'
+
     item.body.split(/\n/).each do |line|
-      @output.puts conv_html(line)
+      @output.puts escape(line)
+    end
+
+    @output.puts '</pre>'
+  end
+
+  ##
+  # Outputs a horizontal rule element, optionally labeled above with +label+ in
+  # bold.
+
+  def draw_line(label = nil)
+    bold_print label if label
+
+    @output.puts "<hr />"
+  end
+
+  def write_attribute_text(prefix, line)
+    curr_attr = 0
+
+    line.each do |achar|
+      attr = achar.attr
+      if achar.attr != curr_attr then
+        update_attributes curr_attr, achar.attr
+        curr_attr = achar.attr
+      end
+      @output.print escape(achar.char)
     end
-    @output.puts("</pre>")
+
+    update_attributes curr_attr, 0 unless curr_attr.zero?
   end
 
   private