summaryrefslogtreecommitdiff
path: root/lib/rdoc/include.rb
diff options
context:
space:
mode:
authordrbrain <drbrain@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2012-11-27 04:28:14 +0000
committerdrbrain <drbrain@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2012-11-27 04:28:14 +0000
commit1c279a7d2753949c725754e1302f791b76358114 (patch)
tree36aa3bdde250e564445eba5f2e25fcb96bcb6cef /lib/rdoc/include.rb
parentc72f0daa877808e4fa5018b3191ca09d4b97c03d (diff)
* lib/rdoc*: Updated to RDoc 4.0 (pre-release)
* bin/rdoc: ditto * test/rdoc: ditto * NEWS: Updated with RDoc 4.0 information git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@37889 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'lib/rdoc/include.rb')
-rw-r--r--lib/rdoc/include.rb43
1 files changed, 31 insertions, 12 deletions
diff --git a/lib/rdoc/include.rb b/lib/rdoc/include.rb
index 9cebd3d8ef..1e9ff5a464 100644
--- a/lib/rdoc/include.rb
+++ b/lib/rdoc/include.rb
@@ -1,5 +1,3 @@
-require 'rdoc/code_object'
-
##
# A Module include in a class with \#include
@@ -17,7 +15,7 @@ class RDoc::Include < RDoc::CodeObject
super()
@name = name
self.comment = comment
- @module = nil # cache for module if found
+ @module = nil # cache for module if found
end
##
@@ -30,10 +28,11 @@ class RDoc::Include < RDoc::CodeObject
end
def == other # :nodoc:
- self.class == other.class and
- self.name == other.name
+ self.class === other and @name == other.name
end
+ alias eql? ==
+
##
# Full name based on #module
@@ -42,6 +41,10 @@ class RDoc::Include < RDoc::CodeObject
RDoc::ClassModule === m ? m.full_name : @name
end
+ def hash # :nodoc:
+ [@name, self.module].hash
+ end
+
def inspect # :nodoc:
"#<%s:0x%x %s.include %s>" % [
self.class,
@@ -59,6 +62,13 @@ class RDoc::Include < RDoc::CodeObject
# - if not found, look into the children of included modules,
# in reverse inclusion order;
# - if still not found, go up the hierarchy of names.
+ #
+ # This method has <code>O(n!)</code> behavior when the module calling
+ # include is referencing nonexistent modules. Avoid calling #module until
+ # after all the files are parsed. This behavior is due to ruby's constant
+ # lookup behavior.
+ #
+ # As of the beginning of October, 2011, no gem includes nonexistent modules.
def module
return @module if @module
@@ -66,7 +76,7 @@ class RDoc::Include < RDoc::CodeObject
# search the current context
return @name unless parent
full_name = parent.child_name(@name)
- @module = RDoc::TopLevel.modules_hash[full_name]
+ @module = @store.modules_hash[full_name]
return @module if @module
return @name if @name =~ /^::/
@@ -76,22 +86,31 @@ class RDoc::Include < RDoc::CodeObject
inc = i.module
next if String === inc
full_name = inc.child_name(@name)
- @module = RDoc::TopLevel.modules_hash[full_name]
+ @module = @store.modules_hash[full_name]
return @module if @module
end
# go up the hierarchy of names
- p = parent.parent
- while p
- full_name = p.child_name(@name)
- @module = RDoc::TopLevel.modules_hash[full_name]
+ up = parent.parent
+ while up
+ full_name = up.child_name(@name)
+ @module = @store.modules_hash[full_name]
return @module if @module
- p = p.parent
+ up = up.parent
end
@name
end
+ ##
+ # Sets the store for this class or module and its contained code objects.
+
+ def store= store
+ super
+
+ @file = @store.add_file @file.full_name if @file
+ end
+
def to_s # :nodoc:
"include #@name in: #{parent}"
end