rdoc 3.9.5 → 3.10.pre.1

data/lib/rdoc/rdoc.rb

@@ -1,16 +1,5 @@
 require 'rdoc'
 
-require 'rdoc/encoding'
-require 'rdoc/parser'
-
-# Simple must come first
-require 'rdoc/parser/simple'
-require 'rdoc/parser/ruby'
-require 'rdoc/parser/c'
-
-require 'rdoc/stats'
-require 'rdoc/options'
-
 require 'find'
 require 'fileutils'
 require 'time'
@@ -96,7 +85,7 @@ class RDoc::RDoc
   ##
   # Sets the active RDoc::RDoc instance
 
-  def self.current=(rdoc)
+  def self.current= rdoc
     @current = rdoc
   end
 
@@ -106,6 +95,7 @@ class RDoc::RDoc
   def self.reset
     RDoc::TopLevel.reset
     RDoc::Parser::C.reset
+    RDoc::RDoc.current = nil
   end
 
   ##
@@ -409,6 +399,7 @@ The internal error was:
 
   def document options
     RDoc::RDoc.reset
+    RDoc::RDoc.current = self
 
     if RDoc::Options === options then
       @options = options
@@ -468,18 +459,12 @@ The internal error was:
 
   def generate file_info
     Dir.chdir @options.op_dir do
-      begin
-        self.class.current = self
-
-        unless @options.quiet then
-          $stderr.puts "\nGenerating #{@generator.class.name.sub(/^.*::/, '')} format into #{Dir.pwd}..."
-        end
-
-        @generator.generate file_info
-        update_output_dir '.', @start_time, @last_modified
-      ensure
-        self.class.current = nil
+      unless @options.quiet then
+        $stderr.puts "\nGenerating #{@generator.class.name.sub(/^.*::/, '')} format into #{Dir.pwd}..."
       end
+
+      @generator.generate file_info
+      update_output_dir '.', @start_time, @last_modified
     end
   end
 

data/lib/rdoc/require.rb

@@ -1,5 +1,3 @@
-require 'rdoc/code_object'
-
 ##
 # A file loaded by \#require
 

data/lib/rdoc/ri.rb

@@ -12,7 +12,9 @@ module RDoc::RI
 
   class Error < RDoc::Error; end
 
-end
+  autoload :Driver, 'rdoc/ri/driver'
+  autoload :Paths,  'rdoc/ri/paths'
+  autoload :Store,  'rdoc/ri/store'
 
-require 'rdoc/ri/store'
+end
 

data/lib/rdoc/ri/driver.rb

@@ -11,11 +11,7 @@ begin
 rescue LoadError
 end
 
-require 'rdoc/ri'
-require 'rdoc/ri/paths'
-require 'rdoc/markup'
-require 'rdoc/markup/formatter'
-require 'rdoc/text'
+require 'rdoc'
 
 ##
 # For RubyGems backwards compatibility
@@ -1101,7 +1097,7 @@ Options may also be set in the 'RI' environment variable.
   # Foo::Bar#baz.
   #
   # NOTE: Given Foo::Bar, Bar is considered a class even though it may be a
-  #       method
+  # method
 
   def parse_name name
     parts = name.split(/(::|#|\.)/)

data/lib/rdoc/ri/store.rb

@@ -1,4 +1,3 @@
-require 'rdoc/code_objects'
 require 'fileutils'
 
 ##

data/lib/rdoc/ruby_lex.rb

@@ -11,7 +11,6 @@
 
 require "e2mmap"
 require "irb/slex"
-require "rdoc/ruby_token"
 require "stringio"
 
 ##
@@ -23,6 +22,12 @@ class RDoc::RubyLex
 
   # :stopdoc:
 
+  ##
+  # Raised upon invalid input
+
+  class Error < RDoc::Error
+  end
+
   extend Exception2MessageMapper
 
   def_exception(:AlreadyDefinedToken, "Already defined token(%s)")
@@ -51,6 +56,19 @@ class RDoc::RubyLex
 
   self.debug_level = 0
 
+  def self.tokenize text, options
+    tokens = []
+
+    scanner = RDoc::RubyLex.new text, options
+    scanner.exception_on_syntax_error = true
+
+    while token = scanner.token do
+      tokens << token 
+    end
+
+    tokens
+  end
+
   def initialize(content, options)
     lex_init
 
@@ -91,6 +109,7 @@ class RDoc::RubyLex
 
     @prompt = nil
     @prev_seek = nil
+    @ltype = nil
   end
 
   def inspect # :nodoc:
@@ -122,8 +141,8 @@ class RDoc::RubyLex
   end
 
   def get_readed
-    if idx = @readed.reverse.index("\n")
-      @base_char_no = idx
+    if idx = @readed.rindex("\n")
+      @base_char_no = @readed.size - (idx + 1)
     else
       @base_char_no += @readed.size
     end
@@ -188,8 +207,8 @@ class RDoc::RubyLex
     @seek -= 1
     if c == "\n"
       @line_no -= 1
-      if idx = @readed.reverse.index("\n")
-        @char_no = @readed.size - idx
+      if idx = @readed.rindex("\n")
+        @char_no = idx + 1
       else
         @char_no = @base_char_no + @readed.size
       end
@@ -323,7 +342,7 @@ class RDoc::RubyLex
         tk = @OP.match(self)
         @space_seen = tk.kind_of?(TkSPACE)
       rescue SyntaxError => e
-        raise RDoc::Error, "syntax error: #{e.message}" if
+        raise Error, "syntax error: #{e.message}" if
           @exception_on_syntax_error
 
         tk = TkError.new(@seek, @line_no, @char_no)
@@ -413,7 +432,7 @@ class RDoc::RubyLex
       gets # consume =end
 
       @ltype = nil
-      Token(TkCOMMENT, res)
+      Token(TkRD_COMMENT, res)
     end
 
     @OP.def_rule("\n") do |op, io|
@@ -978,14 +997,15 @@ class RDoc::RubyLex
     end
 
     @here_header = false
-    doc = ''
+    doc = '"'
     while l = gets
-      l = l.sub(/(:?\r)?\n\z/, '')
+      l = l.sub(/(:?\r)?\n\z/, "\n")
       if (indent ? l.strip : l) == quoted
         break
       end
       doc << l
     end
+    doc << '"'
 
     @here_header = true
     @here_readed.concat reserve
@@ -1005,7 +1025,7 @@ class RDoc::RubyLex
     elsif ch =~ /\W/
       lt = "\""
     else
-      raise RDoc::Error, "unknown type of %string #{ch.inspect}"
+      raise Error, "unknown type of %string #{ch.inspect}"
     end
     #     if ch !~ /\W/
     #       ungetc
@@ -1040,7 +1060,7 @@ class RDoc::RubyLex
       when /[0-7]/
         match = /[0-7_]/
       when /[89]/
-        raise RDoc::Error, "Illegal octal digit"
+        raise Error, "Illegal octal digit"
       else
         return Token(TkINTEGER, num)
       end
@@ -1054,7 +1074,7 @@ class RDoc::RubyLex
         if match =~ ch
           if ch == "_"
             if non_digit
-              raise RDoc::Error, "trailing `#{ch}' in number"
+              raise Error, "trailing `#{ch}' in number"
             else
               non_digit = ch
             end
@@ -1066,10 +1086,10 @@ class RDoc::RubyLex
           ungetc
           num[-1, 1] = ''
           if len0
-            raise RDoc::Error, "numeric literal without digits"
+            raise Error, "numeric literal without digits"
           end
           if non_digit
-            raise RDoc::Error, "trailing `#{non_digit}' in number"
+            raise Error, "trailing `#{non_digit}' in number"
           end
           break
         end
@@ -1090,7 +1110,7 @@ class RDoc::RubyLex
         non_digit = ch
       when allow_point && "."
         if non_digit
-          raise RDoc::Error, "trailing `#{non_digit}' in number"
+          raise Error, "trailing `#{non_digit}' in number"
         end
         type = TkFLOAT
         if peek(0) !~ /[0-9]/
@@ -1102,7 +1122,7 @@ class RDoc::RubyLex
         allow_point = false
       when allow_e && "e", allow_e && "E"
         if non_digit
-          raise RDoc::Error, "trailing `#{non_digit}' in number"
+          raise Error, "trailing `#{non_digit}' in number"
         end
         type = TkFLOAT
         if peek(0) =~ /[+-]/
@@ -1113,7 +1133,7 @@ class RDoc::RubyLex
         non_digit = ch
       else
         if non_digit
-          raise RDoc::Error, "trailing `#{non_digit}' in number"
+          raise Error, "trailing `#{non_digit}' in number"
         end
         ungetc
         num[-1, 1] = ''
@@ -1125,13 +1145,16 @@ class RDoc::RubyLex
   end
 
   def identify_string(ltype, quoted = ltype)
+    close = PERCENT_PAREN.values.include?(quoted)
     @ltype = ltype
     @quoted = quoted
 
     str = if ltype == quoted then
             ltype.dup
+          elsif RUBY_VERSION > '1.9' then
+            "%#{PERCENT_LTYPE.key ltype}#{PERCENT_PAREN_REV[quoted]}"
           else
-            "%#{PERCENT_PAREN_REV[quoted]}"
+            "%#{PERCENT_LTYPE.index ltype}#{PERCENT_PAREN_REV[quoted]}"
           end
 
     subtype = nil
@@ -1141,7 +1164,7 @@ class RDoc::RubyLex
       while ch = getc
         str << ch
 
-        if @quoted == ch and nest == 0
+        if @quoted == ch and nest <= 0
           break
         elsif @ltype != "'" && @ltype != "]" && @ltype != ":" and ch == "#"
           ch = getc
@@ -1162,7 +1185,7 @@ class RDoc::RubyLex
           str << read_escape
         end
 
-        if PERCENT_PAREN.values.include?(@quoted)
+        if close then
           if PERCENT_PAREN[ch] == @quoted
             nest += 1
           elsif ch == @quoted

data/lib/rdoc/ruby_token.rb

@@ -60,6 +60,11 @@ module RDoc::RubyToken
       self
     end
 
+    def inspect # :nodoc:
+      klass = self.class.name.split('::').last
+      "{%s %d, %d:%d %p}" % [klass, @seek, @line_no, @char_no, @text]
+    end
+
   end
 
   class TkNode < Token
@@ -83,6 +88,12 @@ module RDoc::RubyToken
     end
 
     alias text node
+
+    def inspect # :nodoc:
+      klass = self.class.name.split('::').last
+      "{%s %d, %d:%d %p}" % [klass, @seek, @line_no, @char_no, @node]
+    end
+
   end
 
   class TkId < Token
@@ -105,6 +116,12 @@ module RDoc::RubyToken
     end
 
     alias text name
+
+    def inspect # :nodoc:
+      klass = self.class.name.split('::').last
+      "{%s %d, %d:%d %p}" % [klass, @seek, @line_no, @char_no, @name]
+    end
+
   end
 
   class TkKW < TkId
@@ -130,6 +147,12 @@ module RDoc::RubyToken
     end
 
     alias text value
+
+    def inspect # :nodoc:
+      klass = self.class.name.split('::').last
+      "{%s %s, %d:%d %p}" % [klass, @seek, @line_no, @char_no, @value]
+    end
+
   end
 
   class TkOp < Token
@@ -153,6 +176,12 @@ module RDoc::RubyToken
     end
 
     alias text name
+
+    def inspect # :nodoc:
+      klass = self.class.name.split('::').last
+      "{%s %d, %d:%d %p}" % [klass, @seek, @line_no, @char_no, @name]
+    end
+
   end
 
   class TkOPASGN < TkOp
@@ -175,6 +204,12 @@ module RDoc::RubyToken
     def text
       @text ||= "#{TkToken2Reading[op]}="
     end
+
+    def inspect # :nodoc:
+      klass = self.class.name.split('::').last
+      "{%s %d, %d:%d %p}" % [klass, @seek, @line_no, @char_no, @op]
+    end
+
   end
 
   class TkUnknownChar < Token
@@ -197,6 +232,12 @@ module RDoc::RubyToken
     end
 
     alias text name
+
+    def inspect # :nodoc:
+      klass = self.class.name.split('::').last
+      "{%s %d, %d:%d %p}" % [klass, @seek, @line_no, @char_no, @name]
+    end
+
   end
 
   class TkError < Token
@@ -360,7 +401,6 @@ module RDoc::RubyToken
     [:TkSEMICOLON,  Token,  ";"],
 
     [:TkCOMMENT,    TkVal],
-    [:TkRD_COMMENT],
     [:TkSPACE,      Token,  " "],
     [:TkNL,         Token,  "\n"],
     [:TkEND_OF_SCRIPT],
@@ -401,7 +441,9 @@ module RDoc::RubyToken
     def_token(*defs)
   end
 
-  NEWLINE_TOKEN = TkNL.new nil, 0, 0, "\n"
+  def_token :TkRD_COMMENT, TkCOMMENT
+
+  NEWLINE_TOKEN = TkNL.new 0, 0, 0, "\n"
 
   class TkSYMBOL
 

data/lib/rdoc/single_class.rb

@@ -1,5 +1,3 @@
-require 'rdoc/class_module'
-
 ##
 # A singleton class
 

data/lib/rdoc/stats.rb

@@ -1,5 +1,3 @@
-require 'rdoc'
-
 ##
 # RDoc statistics collector which prints a summary and report of a project's
 # documentation totals.
@@ -211,9 +209,6 @@ class RDoc::Stats
 
   def report
     if @coverage_level > 0 then
-      require 'rdoc/markup/to_tt_only'
-      require 'rdoc/generator/markup'
-      require 'rdoc/text'
       extend RDoc::Text
     end
 

data/lib/rdoc/task.rb

@@ -25,12 +25,12 @@ require 'rubygems'
 begin
   gem 'rdoc'
 rescue Gem::LoadError
-end
+end unless defined?(RDoc)
 
 begin
   gem 'rake'
 rescue Gem::LoadError
-end
+end unless defined?(Rake)
 
 require 'rdoc'
 require 'rake'
@@ -52,7 +52,6 @@ require 'rake/tasklib'
 #
 # Simple Example:
 #
-#   gem 'rdoc'
 #   require 'rdoc/task'
 #
 #   RDoc::Task.new do |rdoc|
@@ -69,7 +68,6 @@ require 'rake/tasklib'
 # generating two sets of documentation.  For instance, if you want to have a
 # development set of documentation including private methods:
 #
-#   gem 'rdoc'
 #   require 'rdoc/task'
 #
 #   RDoc::Task.new :rdoc_dev do |rdoc|
@@ -87,7 +85,6 @@ require 'rake/tasklib'
 #
 # For example:
 #
-#   gem 'rdoc'
 #   require 'rdoc/task'
 #
 #   RDoc::Task.new(:rdoc => "rdoc", :clobber_rdoc => "rdoc:clean",
@@ -241,7 +238,6 @@ class RDoc::Task < Rake::TaskLib
       args = option_list + @rdoc_files
 
       $stderr.puts "rdoc #{args.join ' '}" if Rake.application.options.trace
-      require 'rdoc/rdoc'
       RDoc::RDoc.new.document args
     end