rdoc 3.1 → 6.3.3

data/lib/rdoc/options.rb

@@ -1,9 +1,76 @@
+# frozen_string_literal: true
 require 'optparse'
-
-require 'rdoc/ri/paths'
+require 'pathname'
 
 ##
 # RDoc::Options handles the parsing and storage of options
+#
+# == Saved Options
+#
+# You can save some options like the markup format in the
+# <tt>.rdoc_options</tt> file in your gem.  The easiest way to do this is:
+#
+#   rdoc --markup tomdoc --write-options
+#
+# Which will automatically create the file and fill it with the options you
+# specified.
+#
+# The following options will not be saved since they interfere with the user's
+# preferences or with the normal operation of RDoc:
+#
+# * +--coverage-report+
+# * +--dry-run+
+# * +--encoding+
+# * +--force-update+
+# * +--format+
+# * +--pipe+
+# * +--quiet+
+# * +--template+
+# * +--verbose+
+#
+# == Custom Options
+#
+# Generators can hook into RDoc::Options to add generator-specific command
+# line options.
+#
+# When <tt>--format</tt> is encountered in ARGV, RDoc calls ::setup_options on
+# the generator class to add extra options to the option parser.  Options for
+# custom generators must occur after <tt>--format</tt>.  <tt>rdoc --help</tt>
+# will list options for all installed generators.
+#
+# Example:
+#
+#   class RDoc::Generator::Spellcheck
+#     RDoc::RDoc.add_generator self
+#
+#     def self.setup_options rdoc_options
+#       op = rdoc_options.option_parser
+#
+#       op.on('--spell-dictionary DICTIONARY',
+#             RDoc::Options::Path) do |dictionary|
+#         rdoc_options.spell_dictionary = dictionary
+#       end
+#     end
+#   end
+#
+# Of course, RDoc::Options does not respond to +spell_dictionary+ by default
+# so you will need to add it:
+#
+#   class RDoc::Options
+#
+#     ##
+#     # The spell dictionary used by the spell-checking plugin.
+#
+#     attr_accessor :spell_dictionary
+#
+#   end
+#
+# == Option Validators
+#
+# OptionParser validators will validate and cast user input values.  In
+# addition to the validators that ship with OptionParser (String, Integer,
+# Float, TrueClass, FalseClass, Array, Regexp, Date, Time, URI, etc.),
+# RDoc::Options adds Path, PathArray and Template.
 
 class RDoc::Options
 
@@ -25,9 +92,57 @@ class RDoc::Options
   }
 
   ##
-  # Template option validator for OptionParser
+  # RDoc options ignored (or handled specially) by --write-options
+
+  SPECIAL = %w[
+    coverage_report
+    dry_run
+    encoding
+    files
+    force_output
+    force_update
+    generator
+    generator_name
+    generator_options
+    generators
+    op_dir
+    option_parser
+    pipe
+    rdoc_include
+    root
+    static_path
+    stylesheet_url
+    template
+    template_dir
+    update_output_dir
+    verbosity
+    write_options
+  ]
+
+  ##
+  # Option validator for OptionParser that matches a directory that exists on
+  # the filesystem.
 
-  Template = nil
+  Directory = Object.new
+
+  ##
+  # Option validator for OptionParser that matches a file or directory that
+  # exists on the filesystem.
+
+  Path = Object.new
+
+  ##
+  # Option validator for OptionParser that matches a comma-separated list of
+  # files or directories that exist on the filesystem.
+
+  PathArray = Object.new
+
+  ##
+  # Option validator for OptionParser that matches a template directory for an
+  # installed generator that lives in
+  # <tt>"rdoc/generator/template/#{template_name}"</tt>
+
+  Template = Object.new
 
   ##
   # Character-set for HTML output.  #encoding is preferred over #charset
@@ -40,14 +155,16 @@ class RDoc::Options
   attr_accessor :dry_run
 
   ##
-  # Encoding of output where.  This is set via --encoding.
+  # The output encoding.  All input files will be transcoded to this encoding.
+  #
+  # The default encoding is UTF-8.  This is set via --encoding.
 
-  attr_accessor :encoding if Object.const_defined? :Encoding
+  attr_accessor :encoding
 
   ##
   # Files matching this pattern will be excluded
 
-  attr_accessor :exclude
+  attr_writer :exclude
 
   ##
   # The list of files to be processed
@@ -71,10 +188,15 @@ class RDoc::Options
   attr_accessor :formatter
 
   ##
-  # Description of the output generator (set with the <tt>-fmt</tt> option)
+  # Description of the output generator (set with the <tt>--format</tt> option)
 
   attr_accessor :generator
 
+  ##
+  # For #==
+
+  attr_reader :generator_name # :nodoc:
+
   ##
   # Loaded generator options.  Used to prevent --help from loading the same
   # options multiple times.
@@ -92,12 +214,28 @@ class RDoc::Options
 
   attr_accessor :line_numbers
 
+  ##
+  # The output locale.
+
+  attr_accessor :locale
+
+  ##
+  # The directory where locale data live.
+
+  attr_accessor :locale_dir
+
   ##
   # Name of the file, class or module to display in the initial index page (if
   # not specified the first file we encounter is used)
 
   attr_accessor :main_page
 
+  ##
+  # The default markup format.  The default is 'rdoc'.  'markdown', 'tomdoc'
+  # and 'rd' are also built-in.
+
+  attr_accessor :markup
+
   ##
   # If true, only report on undocumented files
 
@@ -113,6 +251,16 @@ class RDoc::Options
 
   attr_accessor :option_parser
 
+  ##
+  # Output heading decorations?
+  attr_accessor :output_decoration
+
+  ##
+  # Directory where guides, FAQ, and other pages not associated with a class
+  # live.  You may leave this unset if these are at the root of your project.
+
+  attr_accessor :page_dir
+
   ##
   # Is RDoc in pipe mode?
 
@@ -123,11 +271,23 @@ class RDoc::Options
 
   attr_accessor :rdoc_include
 
+  ##
+  # Root of the source documentation will be generated for.  Set this when
+  # building documentation outside the source directory.  Defaults to the
+  # current directory.
+
+  attr_accessor :root
+
   ##
   # Include the '#' at the front of hyperlinked instance method names
 
   attr_accessor :show_hash
 
+  ##
+  # Directory to copy static files from
+
+  attr_accessor :static_path
+
   ##
   # The number of columns in a tab
 
@@ -143,11 +303,21 @@ class RDoc::Options
 
   attr_accessor :template_dir
 
+  ##
+  # Additional template stylesheets
+
+  attr_accessor :template_stylesheets
+
   ##
   # Documentation title
 
   attr_accessor :title
 
+  ##
+  # Should RDoc update the timestamps in the output dir?
+
+  attr_accessor :update_output_dir
+
   ##
   # Verbosity, zero means quiet
 
@@ -159,16 +329,27 @@ class RDoc::Options
   attr_accessor :webcvs
 
   ##
-  # Minimum visibility of a documented method. One of +:public+,
-  # +:protected+, +:private+. May be overridden on a per-method
-  # basis with the :doc: directive.
+  # Minimum visibility of a documented method. One of +:public+, +:protected+,
+  # +:private+ or +:nodoc+.
+  #
+  # The +:nodoc+ visibility ignores all directives related to visibility.  The
+  # other visibilities may be overridden on a per-method basis with the :doc:
+  # directive.
 
-  attr_accessor :visibility
+  attr_reader :visibility
 
-  def initialize # :nodoc:
-    require 'rdoc/rdoc'
+  def initialize loaded_options = nil # :nodoc:
+    init_ivars
+    override loaded_options if loaded_options
+  end
+
+  def init_ivars # :nodoc:
     @dry_run = false
-    @exclude = []
+    @exclude = %w[
+      ~\z \.orig\z \.rej\z \.bak\z
+      \.gemspec\z
+    ]
+    @files = nil
     @force_output = false
     @force_update = true
     @generator = nil
@@ -177,27 +358,116 @@ class RDoc::Options
     @generators = RDoc::RDoc::GENERATORS
     @hyperlink_all = false
     @line_numbers = false
+    @locale = nil
+    @locale_name = nil
+    @locale_dir = 'locale'
     @main_page = nil
+    @markup = 'rdoc'
     @coverage_report = false
     @op_dir = nil
+    @page_dir = nil
     @pipe = false
+    @output_decoration = true
     @rdoc_include = []
+    @root = Pathname(Dir.pwd)
     @show_hash = false
-    @stylesheet_url = nil
+    @static_path = []
+    @stylesheet_url = nil # TODO remove in RDoc 4
     @tab_width = 8
     @template = nil
     @template_dir = nil
+    @template_stylesheets = []
     @title = nil
+    @update_output_dir = true
     @verbosity = 1
     @visibility = :protected
     @webcvs = nil
+    @write_options = false
+    @encoding = Encoding::UTF_8
+    @charset = @encoding.name
+  end
 
-    if Object.const_defined? :Encoding then
-      @encoding = Encoding.default_external
-      @charset = @encoding.to_s
-    else
-      @charset = 'UTF-8'
+  def init_with map # :nodoc:
+    init_ivars
+
+    encoding = map['encoding']
+    @encoding = encoding ? Encoding.find(encoding) : encoding
+
+    @charset        = map['charset']
+    @exclude        = map['exclude']
+    @generator_name = map['generator_name']
+    @hyperlink_all  = map['hyperlink_all']
+    @line_numbers   = map['line_numbers']
+    @locale_name    = map['locale_name']
+    @locale_dir     = map['locale_dir']
+    @main_page      = map['main_page']
+    @markup         = map['markup']
+    @op_dir         = map['op_dir']
+    @show_hash      = map['show_hash']
+    @tab_width      = map['tab_width']
+    @template_dir   = map['template_dir']
+    @title          = map['title']
+    @visibility     = map['visibility']
+    @webcvs         = map['webcvs']
+
+    @rdoc_include = sanitize_path map['rdoc_include']
+    @static_path  = sanitize_path map['static_path']
+  end
+
+  def yaml_initialize tag, map # :nodoc:
+    init_with map
+  end
+
+  def override map # :nodoc:
+    if map.has_key?('encoding')
+      encoding = map['encoding']
+      @encoding = encoding ? Encoding.find(encoding) : encoding
     end
+
+    @charset        = map['charset']        if map.has_key?('charset')
+    @exclude        = map['exclude']        if map.has_key?('exclude')
+    @generator_name = map['generator_name'] if map.has_key?('generator_name')
+    @hyperlink_all  = map['hyperlink_all']  if map.has_key?('hyperlink_all')
+    @line_numbers   = map['line_numbers']   if map.has_key?('line_numbers')
+    @locale_name    = map['locale_name']    if map.has_key?('locale_name')
+    @locale_dir     = map['locale_dir']     if map.has_key?('locale_dir')
+    @main_page      = map['main_page']      if map.has_key?('main_page')
+    @markup         = map['markup']         if map.has_key?('markup')
+    @op_dir         = map['op_dir']         if map.has_key?('op_dir')
+    @show_hash      = map['show_hash']      if map.has_key?('show_hash')
+    @tab_width      = map['tab_width']      if map.has_key?('tab_width')
+    @template_dir   = map['template_dir']   if map.has_key?('template_dir')
+    @title          = map['title']          if map.has_key?('title')
+    @visibility     = map['visibility']     if map.has_key?('visibility')
+    @webcvs         = map['webcvs']         if map.has_key?('webcvs')
+
+    if map.has_key?('rdoc_include')
+      @rdoc_include = sanitize_path map['rdoc_include']
+    end
+    if map.has_key?('static_path')
+      @static_path  = sanitize_path map['static_path']
+    end
+  end
+
+  def == other # :nodoc:
+    self.class === other and
+      @encoding       == other.encoding       and
+      @generator_name == other.generator_name and
+      @hyperlink_all  == other.hyperlink_all  and
+      @line_numbers   == other.line_numbers   and
+      @locale         == other.locale         and
+      @locale_dir     == other.locale_dir and
+      @main_page      == other.main_page      and
+      @markup         == other.markup         and
+      @op_dir         == other.op_dir         and
+      @rdoc_include   == other.rdoc_include   and
+      @show_hash      == other.show_hash      and
+      @static_path    == other.static_path    and
+      @tab_width      == other.tab_width      and
+      @template       == other.template       and
+      @title          == other.title          and
+      @visibility     == other.visibility     and
+      @webcvs         == other.webcvs
   end
 
   ##
@@ -240,6 +510,94 @@ class RDoc::Options
     @title ||= string
   end
 
+  ##
+  # For dumping YAML
+
+  def encode_with coder # :nodoc:
+    encoding = @encoding ? @encoding.name : nil
+
+    coder.add 'encoding', encoding
+    coder.add 'static_path',  sanitize_path(@static_path)
+    coder.add 'rdoc_include', sanitize_path(@rdoc_include)
+
+    ivars = instance_variables.map { |ivar| ivar.to_s[1..-1] }
+    ivars -= SPECIAL
+
+    ivars.sort.each do |ivar|
+      coder.add ivar, instance_variable_get("@#{ivar}")
+    end
+  end
+
+  ##
+  # Create a regexp for #exclude
+
+  def exclude
+    if @exclude.nil? or Regexp === @exclude then
+      # done, #finish is being re-run
+      @exclude
+    elsif @exclude.empty? then
+      nil
+    else
+      Regexp.new(@exclude.join("|"))
+    end
+  end
+
+  ##
+  # Completes any unfinished option setup business such as filtering for
+  # existent files, creating a regexp for #exclude and setting a default
+  # #template.
+
+  def finish
+    @op_dir ||= 'doc'
+
+    @rdoc_include << "." if @rdoc_include.empty?
+    root = @root.to_s
+    @rdoc_include << root unless @rdoc_include.include?(root)
+
+    @exclude = self.exclude
+
+    finish_page_dir
+
+    check_files
+
+    # If no template was specified, use the default template for the output
+    # formatter
+
+    unless @template then
+      @template     = @generator_name
+      @template_dir = template_dir_for @template
+    end
+
+    if @locale_name
+      @locale = RDoc::I18n::Locale[@locale_name]
+      @locale.load(@locale_dir)
+    else
+      @locale = nil
+    end
+
+    self
+  end
+
+  ##
+  # Fixes the page_dir to be relative to the root_dir and adds the page_dir to
+  # the files list.
+
+  def finish_page_dir
+    return unless @page_dir
+
+    @files << @page_dir.to_s
+
+    page_dir = nil
+    begin
+      page_dir = @page_dir.expand_path.relative_path_from @root
+    rescue ArgumentError
+      # On Windows, sometimes crosses different drive letters.
+      page_dir = @page_dir.expand_path
+    end
+
+    @page_dir = page_dir
+  end
+
   ##
   # Returns a properly-space list of generators and their descriptions.
 
@@ -267,9 +625,9 @@ class RDoc::Options
   end
 
   ##
-  # Parse command line options.
+  # Parses command line options.
 
-  def parse(argv)
+  def parse argv
     ignore_invalid = true
 
     argv.insert(0, *ENV['RDOCOPT'].split) if ENV['RDOCOPT']
@@ -315,44 +673,86 @@ Usage: #{opt.program_name} [options] [names...]
       end
 
       parsers.sort.each do |parser, regexp|
-        opt.banner << "  - #{parser}: #{regexp.join ', '}\n"
+        opt.banner += "  - #{parser}: #{regexp.join ', '}\n"
       end
+      opt.banner += "  - TomDoc:  Only in ruby files\n"
 
-      opt.banner << "\n  The following options are deprecated:\n\n"
+      opt.banner += "\n  The following options are deprecated:\n\n"
 
       name_length = DEPRECATED.keys.sort_by { |k| k.length }.last.length
 
       DEPRECATED.sort_by { |k,| k }.each do |name, reason|
-        opt.banner << "    %*1$2$s  %3$s\n" % [-name_length, name, reason]
+        opt.banner += "    %*1$2$s  %3$s\n" % [-name_length, name, reason]
       end
 
       opt.accept Template do |template|
         template_dir = template_dir_for template
 
         unless template_dir then
-          warn "could not find template #{template}"
+          $stderr.puts "could not find template #{template}"
           nil
         else
           [template, template_dir]
         end
       end
 
+      opt.accept Directory do |directory|
+        directory = File.expand_path directory
+
+        raise OptionParser::InvalidArgument unless File.directory? directory
+
+        directory
+      end
+
+      opt.accept Path do |path|
+        path = File.expand_path path
+
+        raise OptionParser::InvalidArgument unless File.exist? path
+
+        path
+      end
+
+      opt.accept PathArray do |paths,|
+        paths = if paths then
+                  paths.split(',').map { |d| d unless d.empty? }
+                end
+
+        paths.map do |path|
+          path = File.expand_path path
+
+          raise OptionParser::InvalidArgument unless File.exist? path
+
+          path
+        end
+      end
+
       opt.separator nil
       opt.separator "Parsing options:"
       opt.separator nil
 
-      if Object.const_defined? :Encoding then
-        opt.on("--encoding=ENCODING", "-e", Encoding.list.map { |e| e.name },
-               "Specifies the output encoding.  All files",
-               "read will be converted to this encoding.",
-               "Preferred over --charset") do |value|
-                 @encoding = Encoding.find value
-                 @charset = @encoding.to_s # may not be valid value
-               end
+      opt.on("--encoding=ENCODING", "-e", Encoding.list.map { |e| e.name },
+             "Specifies the output encoding.  All files",
+             "read will be converted to this encoding.",
+             "The default encoding is UTF-8.",
+             "--encoding is preferred over --charset") do |value|
+               @encoding = Encoding.find value
+               @charset = @encoding.name # may not be valid value
+             end
+
+      opt.separator nil
+
+      opt.on("--locale=NAME",
+             "Specifies the output locale.") do |value|
+        @locale_name = value
+      end
 
-        opt.separator nil
+      opt.on("--locale-data-dir=DIR",
+             "Specifies the directory where locale data live.") do |value|
+        @locale_dir = value
       end
 
+      opt.separator nil
+
       opt.on("--all", "-a",
              "Synonym for --visibility=private.") do |value|
         @visibility = :private
@@ -387,33 +787,69 @@ Usage: #{opt.program_name} [options] [names...]
 
       opt.on("--[no-]force-update", "-U",
              "Forces rdoc to scan all sources even if",
-             "newer than the flag file.") do |value|
+             "no files are newer than the flag file.") do |value|
         @force_update = value
       end
 
       opt.separator nil
 
-      opt.on("--pipe",
+      opt.on("--pipe", "-p",
              "Convert RDoc on stdin to HTML") do
         @pipe = true
       end
 
       opt.separator nil
 
-      opt.on("--tab-width=WIDTH", "-w", OptionParser::DecimalInteger,
+      opt.on("--tab-width=WIDTH", "-w", Integer,
              "Set the width of tab characters.") do |value|
+        raise OptionParser::InvalidArgument,
+              "#{value} is an invalid tab width" if value <= 0
         @tab_width = value
       end
 
       opt.separator nil
 
-      opt.on("--visibility=VISIBILITY", "-V", RDoc::VISIBILITIES,
+      opt.on("--visibility=VISIBILITY", "-V", RDoc::VISIBILITIES + [:nodoc],
              "Minimum visibility to document a method.",
-             "One of 'public', 'protected' (the default)",
-             "or 'private'. Can be abbreviated.") do |value|
+             "One of 'public', 'protected' (the default),",
+             "'private' or 'nodoc' (show everything)") do |value|
         @visibility = value
       end
 
+      opt.separator nil
+
+      markup_formats = RDoc::Text::MARKUP_FORMAT.keys.sort
+
+      opt.on("--markup=MARKUP", markup_formats,
+             "The markup format for the named files.",
+             "The default is rdoc.  Valid values are:",
+             markup_formats.join(', ')) do |value|
+        @markup = value
+      end
+
+      opt.separator nil
+
+      opt.on("--root=ROOT", Directory,
+             "Root of the source tree documentation",
+             "will be generated for.  Set this when",
+             "building documentation outside the",
+             "source directory.  Default is the",
+             "current directory.") do |root|
+        @root = Pathname(root)
+      end
+
+      opt.separator nil
+
+      opt.on("--page-dir=DIR", Directory,
+             "Directory where guides, your FAQ or",
+             "other pages not associated with a class",
+             "live.  Set this when you don't store",
+             "such files at your project root.",
+             "NOTE: Do not use the same file name in",
+             "the page dir and the root of your project") do |page_dir|
+        @page_dir = Pathname(page_dir)
+      end
+
       opt.separator nil
       opt.separator "Common generator options:"
       opt.separator nil
@@ -440,7 +876,7 @@ Usage: #{opt.program_name} [options] [names...]
 
       opt.separator nil
 
-      opt.on("--include=DIRECTORIES", "-i", Array,
+      opt.on("--include=DIRECTORIES", "-i", PathArray,
              "Set (or add to) the list of directories to",
              "be searched when satisfying :include:",
              "requests. Can be used more than once.") do |value|
@@ -449,9 +885,11 @@ Usage: #{opt.program_name} [options] [names...]
 
       opt.separator nil
 
-      opt.on("--[no-]coverage-report", "--[no-]dcov", "-C",
+      opt.on("--[no-]coverage-report=[LEVEL]", "--[no-]dcov", "-C", Integer,
              "Prints a report on undocumented items.",
              "Does not generate files.") do |value|
+        value = 0 if value.nil? # Integer converts -C to nil
+
         @coverage_report = value
         @force_update = true if value
       end
@@ -530,6 +968,14 @@ Usage: #{opt.program_name} [options] [names...]
 
       opt.separator nil
 
+      opt.on("--template-stylesheets=FILES", PathArray,
+             "Set (or add to) the list of files to",
+             "include with the html template.") do |value|
+        @template_stylesheets << value
+      end
+
+      opt.separator nil
+
       opt.on("--title=TITLE", "-t",
              "Set TITLE as the title for HTML output.") do |value|
         @title = value
@@ -537,6 +983,18 @@ Usage: #{opt.program_name} [options] [names...]
 
       opt.separator nil
 
+      opt.on("--copy-files=PATH", Path,
+             "Specify a file or directory to copy static",
+             "files from.",
+             "If a file is given it will be copied into",
+             "the output dir.  If a directory is given the",
+             "entire directory will be copied.",
+             "You can use this multiple times") do |value|
+        @static_path << value
+      end
+
+      opt.separator nil
+
       opt.on("--webcvs=URL", "-W",
              "Specify a URL for linking to a web frontend",
              "to CVS. If the URL contains a '\%s', the",
@@ -573,7 +1031,7 @@ Usage: #{opt.program_name} [options] [names...]
         check_generator
 
         @generator_name = "ri"
-        @op_dir = RDoc::RI::Paths::SITEDIR
+        @op_dir = RDoc::RI::Paths.site_dir
         setup_generator
       end
 
@@ -581,34 +1039,60 @@ Usage: #{opt.program_name} [options] [names...]
       opt.separator "Generic options:"
       opt.separator nil
 
+      opt.on("--write-options",
+             "Write .rdoc_options to the current",
+             "directory with the given options.  Not all",
+             "options will be used.  See RDoc::Options",
+             "for details.") do |value|
+        @write_options = true
+      end
+
+      opt.separator nil
+
       opt.on("--[no-]dry-run",
              "Don't write any files") do |value|
         @dry_run = value
       end
 
+      opt.separator nil
+
       opt.on("-D", "--[no-]debug",
              "Displays lots on internal stuff.") do |value|
         $DEBUG_RDOC = value
       end
 
+      opt.separator nil
+
       opt.on("--[no-]ignore-invalid",
              "Ignore invalid options and continue",
              "(default true).") do |value|
         ignore_invalid = value
       end
 
+      opt.separator nil
+
       opt.on("--quiet", "-q",
              "Don't show progress as we parse.") do |value|
         @verbosity = 0
       end
 
-      opt.on("--verbose", "-v",
+      opt.separator nil
+
+      opt.on("--verbose", "-V",
              "Display extra progress as RDoc parses") do |value|
         @verbosity = 2
       end
 
-      opt.on("--help",
-             "Display this help") do
+      opt.separator nil
+
+      opt.on("--version", "-v", "print the version") do
+        puts opt.version
+        exit
+      end
+
+      opt.separator nil
+
+      opt.on("--help", "-h", "Display this help") do
         RDoc::RDoc::GENERATORS.each_key do |generator|
           setup_generator generator
         end
@@ -628,7 +1112,7 @@ Usage: #{opt.program_name} [options] [names...]
 
     begin
       opts.parse! argv
-    rescue OptionParser::InvalidArgument, OptionParser::InvalidOption => e
+    rescue OptionParser::ParseError => e
       if DEPRECATED[e.args.first] then
         deprecated << e.args.first
       elsif %w[--format --ri -r --ri-site -R].include? e.args.first then
@@ -652,43 +1136,37 @@ Usage: #{opt.program_name} [options] [names...]
 
     unless quiet then
       deprecated.each do |opt|
-        $stderr.puts 'option ' << opt << ' is deprecated: ' << DEPRECATED[opt]
+        $stderr.puts 'option ' + opt + ' is deprecated: ' + DEPRECATED[opt]
       end
+    end
 
-      unless invalid.empty? then
-        invalid = "invalid options: #{invalid.join ', '}"
+    unless invalid.empty? then
+      invalid = "invalid options: #{invalid.join ', '}"
 
-        if ignore_invalid then
+      if ignore_invalid then
+        unless quiet then
           $stderr.puts invalid
           $stderr.puts '(invalid options are ignored)'
-        else
+        end
+      else
+        unless quiet then
           $stderr.puts opts
-          $stderr.puts invalid
-          exit 1
         end
+        $stderr.puts invalid
+        exit 1
       end
     end
 
-    @op_dir ||= 'doc'
     @files = argv.dup
 
-    @rdoc_include << "." if @rdoc_include.empty?
+    finish
 
-    if @exclude.empty? then
-      @exclude = nil
-    else
-      @exclude = Regexp.new(@exclude.join("|"))
+    if @write_options then
+      write_options
+      exit
     end
 
-    check_files
-
-    # If no template was specified, use the default template for the output
-    # formatter
-
-    unless @template then
-      @template     = @generator_name
-      @template_dir = template_dir_for @template
-    end
+    self
   end
 
   ##
@@ -705,6 +1183,29 @@ Usage: #{opt.program_name} [options] [names...]
     @verbosity = bool ? 0 : 1
   end
 
+  ##
+  # Removes directories from +path+ that are outside the current directory
+
+  def sanitize_path path
+    require 'pathname'
+    dot = Pathname.new('.').expand_path
+
+    path.reject do |item|
+      path = Pathname.new(item).expand_path
+      is_reject = nil
+      relative = nil
+      begin
+        relative = path.relative_path_from(dot).to_s
+      rescue ArgumentError
+        # On Windows, sometimes crosses different drive letters.
+        is_reject = true
+      else
+        is_reject = relative.start_with? '..'
+      end
+      is_reject
+    end
+  end
+
   ##
   # Set up an output generator for the named +generator_name+.
   #
@@ -725,7 +1226,10 @@ Usage: #{opt.program_name} [options] [names...]
     @generator_name = generator_name
     @generator_options << @generator
 
-    @generator.setup_options self if @generator.respond_to? :setup_options
+    if @generator.respond_to? :setup_options then
+      @option_parser ||= OptionParser.new
+      @generator.setup_options self
+    end
   end
 
   ##
@@ -741,5 +1245,41 @@ Usage: #{opt.program_name} [options] [names...]
     end
   end
 
-end
+  # Sets the minimum visibility of a documented method.
+  #
+  # Accepts +:public+, +:protected+, +:private+, +:nodoc+, or +:all+.
+  #
+  # When +:all+ is passed, visibility is set to +:private+, similarly to
+  # RDOCOPT="--all", see #visibility for more information.
+
+  def visibility= visibility
+    case visibility
+    when :all
+      @visibility = :private
+    else
+      @visibility = visibility
+    end
+  end
 
+  ##
+  # Displays a warning using Kernel#warn if we're being verbose
+
+  def warn message
+    super message if @verbosity > 1
+  end
+
+  ##
+  # Writes the YAML file .rdoc_options to the current directory containing the
+  # parsed options.
+
+  def write_options
+    RDoc.load_yaml
+
+    File.open '.rdoc_options', 'w' do |io|
+      io.set_encoding Encoding::UTF_8
+
+      YAML.dump self, io
+    end
+  end
+
+end