#$@%#$%!

Ngiler SH3LL 360
: / opt / alt / ruby20 / lib64 / ruby / 2.0.0 / rdoc /

Information Server
MySQL : OFF Perl : OFF CURL : ON WGET : OFF PKEXEC : OFF

Directive	Local Value
IP Address	162.0.209.101
System	Linux premium169.web-hosting.com 4.18.0-553.50.1.lve.el8.x86_64 #1 SMP Thu Apr 17 19:10:24 UTC 2025 x86_64
User	luxeelil
PHP Version	8.0.30
Software	LiteSpeed
Doc root	Writable

Edit File : code_object.rb \| Size : 7.71 KB
## # 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 (never used so far) # * RDoc::NormalClass # * RDoc::NormalModule # * RDoc::SingleClass # * RDoc::MethodAttr # * RDoc::Attr # * RDoc::AnyMethod # * RDoc::GhostMethod # * RDoc::MetaMethod # * RDoc::Alias # * 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_reader :done_documenting ## # Which file this code object was defined in attr_reader :file ## # Force documentation of this CodeObject attr_reader :force_documentation ## # Line in #file where this CodeObject was defined attr_accessor :line ## # Hash of arbitrary metadata for this CodeObject attr_reader :metadata ## # Offset in #file where this CodeObject was defined #-- # TODO character or byte? attr_accessor :offset ## # Sets the parent CodeObject attr_writer :parent ## # Did we ever receive a +:nodoc:+ directive? attr_reader :received_nodoc ## # Set the section this CodeObject is in attr_writer :section ## # The RDoc::Store for this object. attr_accessor :store ## # 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 = '' @parent = nil @parent_name = nil # for loading @parent_class = nil # for loading @section = nil @section_title = nil # for loading @file = nil @full_name = nil @store = nil initialize_visibility end ## # Initializes state for visibility of this CodeObject and its children. def initialize_visibility # :nodoc: @document_children = true @document_self = true @done_documenting = false @force_documentation = false @received_nodoc = false @ignored = false 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 when RDoc::Comment then comment.normalize else if comment and not comment.empty? then normalize_comment comment else # HACK correct fix is to have #initialize create @comment # with the correct encoding if String === @comment and Object.const_defined? :Encoding and @comment.empty? then @comment.force_encoding comment.encoding end @comment end end end ## # Should this CodeObject be shown in documentation? def display? @document_self and not @ignored end ## # Enables or disables documentation of this CodeObject's children unless it # has been turned off by :enddoc: def document_children=(document_children) @document_children = document_children unless @done_documenting end ## # Enables or disables documentation of this CodeObject unless it has been # turned off by :enddoc:. If the argument is +nil+ it means the # documentation is turned off by +:nodoc:+. def document_self=(document_self) return if @done_documenting @document_self = document_self @received_nodoc = true if document_self.nil? end ## # Does this object have a comment with content or is #received_nodoc true? def documented? @received_nodoc or !@comment.empty? end ## # Turns documentation on/off, and turns on/off #document_self # and #document_children. # # Once documentation has been turned off (by +:enddoc:+), # the object will refuse to turn #document_self or # #document_children on, so +:doc:+ and +:start_doc:+ directives # will have no effect in the current file. def done_documenting=(value) @done_documenting = value @document_self = !value @document_children = @document_self end ## # Yields each parent of this CodeObject. See also # RDoc::ClassModule#each_ancestor def each_parent code_object = self while code_object = code_object.parent do yield code_object end self end ## # File name where this CodeObject was found. # # See also RDoc::Context#in_files def file_name return unless @file @file.absolute_name end ## # Force the documentation of this object unless documentation # has been turned off by :enddoc: #-- # HACK untested, was assigning to an ivar def force_documentation=(value) @force_documentation = value unless @done_documenting end ## # Sets the full_name overriding any computed full name. # # Set to +nil+ to clear RDoc's cached value def full_name= full_name @full_name = full_name end ## # Use this to ignore a CodeObject and all its children until found again # (#record_location is called). An ignored item will not be shown in # documentation. # # See github issue #55 # # The ignored status is temporary in order to allow implementation details # to be hidden. At the end of processing a file RDoc allows all classes # and modules to add new documentation to previously created classes. # # If a class was ignored (via stopdoc) then reopened later with additional # documentation it should be shown. If a class was ignored and never # reopened it should not be shown. The ignore flag allows this to occur. def ignore @ignored = true stop_doc end ## # Has this class been ignored? def ignored? @ignored end ## # Our parent CodeObject. The parent may be missing for classes loaded from # legacy RI data stores. def parent return @parent if @parent return nil unless @parent_name if @parent_class == RDoc::TopLevel then @parent = @store.add_file @parent_name else @parent = @store.find_class_or_module @parent_name return @parent if @parent begin @parent = @store.load_class @parent_name rescue RDoc::Store::MissingFileError nil end end 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 ## # Records the RDoc::TopLevel (file) where this code object was defined def record_location top_level @ignored = false @file = top_level end ## # The section this CodeObject is in. Sections allow grouping of constants, # attributes and methods inside a class or module. def section return @section if @section @section = parent.add_section @section_title if parent end ## # Enable capture of documentation unless documentation has been # turned off by :enddoc: def start_doc return if @done_documenting @document_self = true @document_children = true @ignored = false end ## # Disable capture of documentation def stop_doc @document_self = false @document_children = false end end Back

Edit File : code_object.rb | Size : 7.71 KB

##
# 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 (never used so far)
#     * RDoc::NormalClass
#     * RDoc::NormalModule
#     * RDoc::SingleClass
# * RDoc::MethodAttr
#   * RDoc::Attr
#   * RDoc::AnyMethod
#     * RDoc::GhostMethod
#     * RDoc::MetaMethod
# * RDoc::Alias
# * 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_reader :done_documenting

##
  # Which file this code object was defined in

attr_reader :file

##
  # Force documentation of this CodeObject

attr_reader :force_documentation

##
  # Line in #file where this CodeObject was defined

attr_accessor :line

##
  # Hash of arbitrary metadata for this CodeObject

attr_reader :metadata

##
  # Offset in #file where this CodeObject was defined
  #--
  # TODO character or byte?

attr_accessor :offset

##
  # Sets the parent CodeObject

attr_writer :parent

##
  # Did we ever receive a +:nodoc:+ directive?

attr_reader :received_nodoc

##
  # Set the section this CodeObject is in

attr_writer :section

##
  # The RDoc::Store for this object.

attr_accessor :store

##
  # 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       = ''
    @parent        = nil
    @parent_name   = nil # for loading
    @parent_class  = nil # for loading
    @section       = nil
    @section_title = nil # for loading
    @file          = nil
    @full_name     = nil
    @store         = nil

initialize_visibility
  end

##
  # Initializes state for visibility of this CodeObject and its children.

def initialize_visibility # :nodoc:
    @document_children   = true
    @document_self       = true
    @done_documenting    = false
    @force_documentation = false
    @received_nodoc      = false
    @ignored             = false
  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
               when RDoc::Comment          then comment.normalize
               else
                 if comment and not comment.empty? then
                   normalize_comment comment
                 else
                   # HACK correct fix is to have #initialize create @comment
                   #      with the correct encoding
                   if String === @comment and
                      Object.const_defined? :Encoding and @comment.empty? then
                     @comment.force_encoding comment.encoding
                   end
                   @comment
                 end
               end
  end

##
  # Should this CodeObject be shown in documentation?

def display?
    @document_self and not @ignored
  end

##
  # Enables or disables documentation of this CodeObject's children unless it
  # has been turned off by :enddoc:

def document_children=(document_children)
    @document_children = document_children unless @done_documenting
  end

##
  # Enables or disables documentation of this CodeObject unless it has been
  # turned off by :enddoc:.  If the argument is +nil+ it means the
  # documentation is turned off by +:nodoc:+.

def document_self=(document_self)
    return if @done_documenting

@document_self = document_self
    @received_nodoc = true if document_self.nil?
  end

##
  # Does this object have a comment with content or is #received_nodoc true?

def documented?
    @received_nodoc or !@comment.empty?
  end

##
  # Turns documentation on/off, and turns on/off #document_self
  # and #document_children.
  #
  # Once documentation has been turned off (by +:enddoc:+),
  # the object will refuse to turn #document_self or
  # #document_children on, so +:doc:+ and +:start_doc:+ directives
  # will have no effect in the current file.

def done_documenting=(value)
    @done_documenting = value
    @document_self = !value
    @document_children = @document_self
  end

##
  # Yields each parent of this CodeObject.  See also
  # RDoc::ClassModule#each_ancestor

def each_parent
    code_object = self

while code_object = code_object.parent do
      yield code_object
    end

self
  end

##
  # File name where this CodeObject was found.
  #
  # See also RDoc::Context#in_files

def file_name
    return unless @file

@file.absolute_name
  end

##
  # Force the documentation of this object unless documentation
  # has been turned off by :enddoc:
  #--
  # HACK untested, was assigning to an ivar

def force_documentation=(value)
    @force_documentation = value unless @done_documenting
  end

##
  # Sets the full_name overriding any computed full name.
  #
  # Set to +nil+ to clear RDoc's cached value

def full_name= full_name
    @full_name = full_name
  end

##
  # Use this to ignore a CodeObject and all its children until found again
  # (#record_location is called).  An ignored item will not be shown in
  # documentation.
  #
  # See github issue #55
  #
  # The ignored status is temporary in order to allow implementation details
  # to be hidden.  At the end of processing a file RDoc allows all classes
  # and modules to add new documentation to previously created classes.
  #
  # If a class was ignored (via stopdoc) then reopened later with additional
  # documentation it should be shown.  If a class was ignored and never
  # reopened it should not be shown.  The ignore flag allows this to occur.

def ignore
    @ignored = true

stop_doc
  end

##
  # Has this class been ignored?

def ignored?
    @ignored
  end

##
  # Our parent CodeObject.  The parent may be missing for classes loaded from
  # legacy RI data stores.

def parent
    return @parent if @parent
    return nil unless @parent_name

if @parent_class == RDoc::TopLevel then
      @parent = @store.add_file @parent_name
    else
      @parent = @store.find_class_or_module @parent_name

return @parent if @parent

begin
        @parent = @store.load_class @parent_name
      rescue RDoc::Store::MissingFileError
        nil
      end
    end
  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

##
  # Records the RDoc::TopLevel (file) where this code object was defined

def record_location top_level
    @ignored = false
    @file = top_level
  end

##
  # The section this CodeObject is in.  Sections allow grouping of constants,
  # attributes and methods inside a class or module.

def section
    return @section if @section

@section = parent.add_section @section_title if parent
  end

##
  # Enable capture of documentation unless documentation has been
  # turned off by :enddoc:

def start_doc
    return if @done_documenting

@document_self = true
    @document_children = true
    @ignored = false
  end

##
  # Disable capture of documentation

def stop_doc
    @document_self = false
    @document_children = false
  end

end

Back