1 files changed, 180 insertions, 0 deletions
diff --git a/lib/rdoc/code_object.rb b/lib/rdoc/code_object.rb
new file mode 100644
index 0000000000..f8c4e33f7e
--- /dev/null
+++ b/lib/rdoc/code_object.rb
@@ -0,0 +1,180 @@
+require 'rdoc'
+require 'rdoc/text'
+
+##
+# Base class for the RDoc code tree.
+#
+# We contain the common stuff for contexts (which are containers) and other
+# elements (methods, attributes and so on)
+#
+# Here's the tree of the CodeObject subclasses:
+#
+# * RDoc::Context
+#   * RDoc::TopLevel
+#   * RDoc::ClassModule
+#     * RDoc::AnonClass
+#     * RDoc::NormalClass
+#     * RDoc::NormalModule
+#     * RDoc::SingleClass
+# * RDoc::AnyMethod
+#   * RDoc::GhostMethod
+#   * RDoc::MetaMethod
+# * RDoc::Alias
+# * RDoc::Attr
+# * RDoc::Constant
+# * RDoc::Require
+# * RDoc::Include
+
+class RDoc::CodeObject
+
+  include RDoc::Text
+
+  ##
+  # Our comment
+
+  attr_reader :comment
+
+  ##
+  # Do we document our children?
+
+  attr_reader :document_children
+
+  ##
+  # Do we document ourselves?
+
+  attr_reader :document_self
+
+  ##
+  # Are we done documenting (ie, did we come across a :enddoc:)?
+
+  attr_accessor :done_documenting
+
+  ##
+  # Force documentation of this CodeObject
+
+  attr_accessor :force_documentation
+
+  ##
+  # Hash of arbitrary metadata for this CodeObject
+
+  attr_reader :metadata
+
+  ##
+  # Our parent CodeObject
+
+  attr_accessor :parent
+
+  ##
+  # Which section are we in
+
+  attr_accessor :section
+
+  ##
+  # We are the model of the code, but we know that at some point we will be
+  # worked on by viewers. By implementing the Viewable protocol, viewers can
+  # associated themselves with these objects.
+
+  attr_accessor :viewer
+
+  ##
+  # Creates a new CodeObject that will document itself and its children
+
+  def initialize
+    @metadata = {}
+    @comment = ''
+
+    @document_children   = true
+    @document_self       = true
+    @done_documenting    = false
+    @force_documentation = false
+
+    @parent = nil
+  end
+
+  ##
+  # Replaces our comment with +comment+, unless it is empty.
+
+  def comment=(comment)
+    @comment = case comment
+               when NilClass               then ''
+               when RDoc::Markup::Document then comment
+               else
+                 if comment and not comment.empty? then
+                   normalize_comment comment
+                 else
+                   @comment
+                 end
+               end
+  end
+
+  ##
+  # Enables or disables documentation of this CodeObject's children.  Calls
+  # remove_classes_and_modules when disabling.
+
+  def document_children=(document_children)
+    @document_children = document_children
+    remove_classes_and_modules unless document_children
+  end
+
+  ##
+  # Enables or disables documentation of this CodeObject.  Calls
+  # remove_methods_etc when disabling.
+
+  def document_self=(document_self)
+    @document_self = document_self
+    remove_methods_etc unless document_self
+  end
+
+  ##
+  # Does this class have a comment with content or is document_self false.
+
+  def documented?
+    !(@document_self and @comment.empty?)
+  end
+
+  ##
+  # File name of our parent
+
+  def parent_file_name
+    @parent ? @parent.base_name : '(unknown)'
+  end
+
+  ##
+  # Name of our parent
+
+  def parent_name
+    @parent ? @parent.full_name : '(unknown)'
+  end
+
+  ##
+  # Callback called upon disabling documentation of children.  See
+  # #document_children=
+
+  def remove_classes_and_modules
+  end
+
+  ##
+  # Callback called upon disabling documentation of ourself.  See
+  # #document_self=
+
+  def remove_methods_etc
+  end
+
+  ##
+  # Enable capture of documentation
+
+  def start_doc
+    @document_self = true
+    @document_children = true
+  end
+
+  ##
+  # Disable capture of documentation
+
+  def stop_doc
+    @document_self = false
+    @document_children = false
+  end
+
+end
+