Class: RDoc::Options

Inherits:
Object
  • Object
show all
Defined in:
lib/rdoc/options.rb

Overview

RDoc::Options handles the parsing and storage of options

Saved Options

You can save some options like the markup format in the .rdoc_options 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 --format 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 --format. rdoc --help 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

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.

Constant Summary collapse

DEPRECATED =

The deprecated options.

{
  '--accessor'      => 'support discontinued',
  '--diagram'       => 'support discontinued',
  '--help-output'   => 'support discontinued',
  '--image-format'  => 'was an option for --diagram',
  '--inline-source' => 'source code is now always inlined',
  '--merge'         => 'ri now always merges class information',
  '--one-file'      => 'support discontinued',
  '--op-name'       => 'support discontinued',
  '--opname'        => 'support discontinued',
  '--promiscuous'   => 'files always only document their content',
  '--ri-system'     => 'Ruby installers use other techniques',
}
SPECIAL =

RDoc options ignored (or handled specially) by –write-options

%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
Directory =

Option validator for OptionParser that matches a directory that exists on the filesystem.

Object.new
Path =

Option validator for OptionParser that matches a file or directory that exists on the filesystem.

Object.new
PathArray =

Option validator for OptionParser that matches a comma-separated list of files or directories that exist on the filesystem.

Object.new
Template =

Option validator for OptionParser that matches a template directory for an installed generator that lives in "rdoc/generator/template/#{template_name}"

Object.new

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initializeOptions

:nodoc:


306
307
308
# File 'lib/rdoc/options.rb', line 306

def initialize # :nodoc:
  init_ivars
end

Instance Attribute Details

#charsetObject

Character-set for HTML output. #encoding is preferred over #charset


137
138
139
# File 'lib/rdoc/options.rb', line 137

def charset
  @charset
end

#coverage_reportObject

If true, only report on undocumented files


219
220
221
# File 'lib/rdoc/options.rb', line 219

def coverage_report
  @coverage_report
end

#dry_runObject

If true, RDoc will not write any files.


142
143
144
# File 'lib/rdoc/options.rb', line 142

def dry_run
  @dry_run
end

#encodingObject

The output encoding. All input files will be transcoded to this encoding.

The default encoding is UTF-8. This is set via –encoding.


149
150
151
# File 'lib/rdoc/options.rb', line 149

def encoding
  @encoding
end

#excludeObject

Files matching this pattern will be excluded


154
155
156
# File 'lib/rdoc/options.rb', line 154

def exclude
  @exclude
end

#filesObject

The list of files to be processed


159
160
161
# File 'lib/rdoc/options.rb', line 159

def files
  @files
end

#force_outputObject

Create the output even if the output directory does not look like an rdoc output directory


165
166
167
# File 'lib/rdoc/options.rb', line 165

def force_output
  @force_output
end

#force_updateObject

Scan newer sources than the flag file if true.


170
171
172
# File 'lib/rdoc/options.rb', line 170

def force_update
  @force_update
end

#formatterObject

Formatter to mark up text with


175
176
177
# File 'lib/rdoc/options.rb', line 175

def formatter
  @formatter
end

#generatorObject

Description of the output generator (set with the --format option)


180
181
182
# File 'lib/rdoc/options.rb', line 180

def generator
  @generator
end

#generator_nameObject (readonly)

For #==


185
186
187
# File 'lib/rdoc/options.rb', line 185

def generator_name
  @generator_name
end

#generator_optionsObject

Loaded generator options. Used to prevent –help from loading the same options multiple times.


191
192
193
# File 'lib/rdoc/options.rb', line 191

def generator_options
  @generator_options
end

Old rdoc behavior: hyperlink all words that match a method name, even if not preceded by '#' or '::'


197
198
199
# File 'lib/rdoc/options.rb', line 197

def hyperlink_all
  @hyperlink_all
end

#line_numbersObject

Include line numbers in the source code


202
203
204
# File 'lib/rdoc/options.rb', line 202

def line_numbers
  @line_numbers
end

#main_pageObject

Name of the file, class or module to display in the initial index page (if not specified the first file we encounter is used)


208
209
210
# File 'lib/rdoc/options.rb', line 208

def main_page
  @main_page
end

#markupObject

The default markup format. The default is 'rdoc'. 'markdown', 'tomdoc' and 'rd' are also built-in.


214
215
216
# File 'lib/rdoc/options.rb', line 214

def markup
  @markup
end

#op_dirObject

The name of the output directory


224
225
226
# File 'lib/rdoc/options.rb', line 224

def op_dir
  @op_dir
end

#option_parserObject

The OptionParser for this instance


229
230
231
# File 'lib/rdoc/options.rb', line 229

def option_parser
  @option_parser
end

#page_dirObject

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.


235
236
237
# File 'lib/rdoc/options.rb', line 235

def page_dir
  @page_dir
end

#pipeObject

Is RDoc in pipe mode?


240
241
242
# File 'lib/rdoc/options.rb', line 240

def pipe
  @pipe
end

#rdoc_includeObject

Array of directories to search for files to satisfy an :include:


245
246
247
# File 'lib/rdoc/options.rb', line 245

def rdoc_include
  @rdoc_include
end

#rootObject

Root of the source documentation will be generated for. Set this when building documentation outside the source directory. Defaults to the current directory.


252
253
254
# File 'lib/rdoc/options.rb', line 252

def root
  @root
end

#show_hashObject

Include the '#' at the front of hyperlinked instance method names


257
258
259
# File 'lib/rdoc/options.rb', line 257

def show_hash
  @show_hash
end

#static_pathObject

Directory to copy static files from


262
263
264
# File 'lib/rdoc/options.rb', line 262

def static_path
  @static_path
end

#tab_widthObject

The number of columns in a tab


267
268
269
# File 'lib/rdoc/options.rb', line 267

def tab_width
  @tab_width
end

#templateObject

Template to be used when generating output


272
273
274
# File 'lib/rdoc/options.rb', line 272

def template
  @template
end

#template_dirObject

Directory the template lives in


277
278
279
# File 'lib/rdoc/options.rb', line 277

def template_dir
  @template_dir
end

#titleObject

Documentation title


282
283
284
# File 'lib/rdoc/options.rb', line 282

def title
  @title
end

#update_output_dirObject

Should RDoc update the timestamps in the output dir?


287
288
289
# File 'lib/rdoc/options.rb', line 287

def update_output_dir
  @update_output_dir
end

#verbosityObject

Verbosity, zero means quiet


292
293
294
# File 'lib/rdoc/options.rb', line 292

def verbosity
  @verbosity
end

#visibilityObject

Minimum visibility of a documented method. One of :public, :protected, :private. May be overridden on a per-method basis with the :doc: directive.


304
305
306
# File 'lib/rdoc/options.rb', line 304

def visibility
  @visibility
end

#webcvsObject

URL of web cvs frontend


297
298
299
# File 'lib/rdoc/options.rb', line 297

def webcvs
  @webcvs
end

Instance Method Details

#==(other) ⇒ Object

:nodoc:


383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
# File 'lib/rdoc/options.rb', line 383

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
    @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

#check_filesObject

Check that the files on the command line exist


405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
# File 'lib/rdoc/options.rb', line 405

def check_files
  @files.delete_if do |file|
    if File.exist? file then
      if File.readable? file then
        false
      else
        warn "file '#{file}' not readable"

        true
      end
    else
      warn "file '#{file}' not found"

      true
    end
  end
end

#check_generatorObject

Ensure only one generator is loaded


426
427
428
429
430
431
# File 'lib/rdoc/options.rb', line 426

def check_generator
  if @generator then
    raise OptionParser::InvalidOption,
      "generator already set to #{@generator_name}"
  end
end

#default_title=(string) ⇒ Object

Set the title, but only if not already set. Used to set the title from a source file, so that a title set from the command line will have the priority.


438
439
440
# File 'lib/rdoc/options.rb', line 438

def default_title=(string)
  @title ||= string
end

#encode_with(coder) ⇒ Object

For dumping YAML


445
446
447
448
449
450
451
452
453
454
455
456
457
458
# File 'lib/rdoc/options.rb', line 445

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

#finishObject

Completes any unfinished option setup business such as filtering for existent files, creating a regexp for #exclude and setting a default #template.


465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
# File 'lib/rdoc/options.rb', line 465

def finish
  @op_dir ||= 'doc'

  @rdoc_include << "." if @rdoc_include.empty?

  if @exclude.nil? or Regexp === @exclude then
    # done, #finish is being re-run
  elsif @exclude.empty? then
    @exclude = nil
  else
    @exclude = Regexp.new(@exclude.join("|"))
  end

  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

  self
end

#finish_page_dirObject

Fixes the page_dir to be relative to the root_dir and adds the page_dir to the files list.


497
498
499
500
501
502
503
504
505
# File 'lib/rdoc/options.rb', line 497

def finish_page_dir
  return unless @page_dir

  @files << @page_dir.to_s

  page_dir = @page_dir.expand_path.relative_path_from @root

  @page_dir = page_dir
end

#generator_descriptionsObject

Returns a properly-space list of generators and their descriptions.


510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
# File 'lib/rdoc/options.rb', line 510

def generator_descriptions
  lengths = []

  generators = RDoc::RDoc::GENERATORS.map do |name, generator|
    lengths << name.length

    description = generator::DESCRIPTION if
      generator.const_defined? :DESCRIPTION

    [name, description]
  end

  longest = lengths.max

  generators.sort.map do |name, description|
    if description then
      "  %-*s - %s" % [longest, name, description]
    else
      "  #{name}"
    end
  end.join "\n"
end

#init_ivarsObject

:nodoc:


310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
# File 'lib/rdoc/options.rb', line 310

def init_ivars # :nodoc:
  @dry_run = false
  @exclude = []
  @files = nil
  @force_output = false
  @force_update = true
  @generator = nil
  @generator_name = nil
  @generator_options = []
  @generators = RDoc::RDoc::GENERATORS
  @hyperlink_all = false
  @line_numbers = false
  @main_page = nil
  @markup = 'rdoc'
  @coverage_report = false
  @op_dir = nil
  @page_dir = nil
  @pipe = false
  @rdoc_include = []
  @root = Pathname(Dir.pwd)
  @show_hash = false
  @static_path = []
  @stylesheet_url = nil # TODO remove in RDoc 4
  @tab_width = 8
  @template = nil
  @template_dir = nil
  @title = nil
  @update_output_dir = true
  @verbosity = 1
  @visibility = :protected
  @webcvs = nil
  @write_options = false

  if Object.const_defined? :Encoding then
    @encoding = Encoding::UTF_8
    @charset = @encoding.name
  else
    @encoding = nil
    @charset = 'UTF-8'
  end
end

#init_with(map) ⇒ Object

:nodoc:


352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
# File 'lib/rdoc/options.rb', line 352

def init_with map # :nodoc:
  init_ivars

  encoding = map['encoding']
  @encoding = if Object.const_defined? :Encoding then
                encoding ? Encoding.find(encoding) : encoding
              end

  @charset        = map['charset']
  @exclude        = map['exclude']
  @generator_name = map['generator_name']
  @hyperlink_all  = map['hyperlink_all']
  @line_numbers   = map['line_numbers']
  @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

#parse(argv) ⇒ Object

Parses command line options.


536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
# File 'lib/rdoc/options.rb', line 536

def parse argv
  ignore_invalid = true

  argv.insert(0, *ENV['RDOCOPT'].split) if ENV['RDOCOPT']

  opts = OptionParser.new do |opt|
    @option_parser = opt
    opt.program_name = File.basename $0
    opt.version = RDoc::VERSION
    opt.release = nil
    opt.summary_indent = ' ' * 4
    opt.banner = <<-EOF
Usage: #{opt.program_name} [options] [names...]

Files are parsed, and the information they contain collected, before any
output is produced. This allows cross references between all files to be
resolved. If a name is a directory, it is traversed. If no names are
specified, all Ruby files in the current directory (and subdirectories) are
processed.

How RDoc generates output depends on the output formatter being used, and on
the options you give.

Options can be specified via the RDOCOPT environment variable, which
functions similar to the RUBYOPT environment variable for ruby.

  $ export RDOCOPT="--show-hash"

will make rdoc show hashes in method links by default.  Command-line options
always will override those in RDOCOPT.

Available formatters:

#{generator_descriptions}

RDoc understands the following file formats:

    EOF

    parsers = Hash.new { |h,parser| h[parser] = [] }

    RDoc::Parser.parsers.each do |regexp, parser|
      parsers[parser.name.sub('RDoc::Parser::', '')] << regexp.source
    end

    parsers.sort.each do |parser, regexp|
      opt.banner << "  - #{parser}: #{regexp.join ', '}\n"
    end

    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]
    end

    opt.accept Template do |template|
      template_dir = template_dir_for template

      unless template_dir then
        $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.",
             "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
    end

    opt.on("--all", "-a",
           "Synonym for --visibility=private.") do |value|
      @visibility = :private
    end

    opt.separator nil

    opt.on("--exclude=PATTERN", "-x", Regexp,
           "Do not process files or directories",
           "matching PATTERN.") do |value|
      @exclude << value
    end

    opt.separator nil

    opt.on("--extension=NEW=OLD", "-E",
           "Treat files ending with .new as if they",
           "ended with .old. Using '-E cgi=rb' will",
           "cause xxx.cgi to be parsed as a Ruby file.") do |value|
      new, old = value.split(/=/, 2)

      unless new and old then
        raise OptionParser::InvalidArgument, "Invalid parameter to '-E'"
      end

      unless RDoc::Parser.alias_extension old, new then
        raise OptionParser::InvalidArgument, "Unknown extension .#{old} to -E"
      end
    end

    opt.separator nil

    opt.on("--[no-]force-update", "-U",
           "Forces rdoc to scan all sources even if",
           "newer than the flag file.") do |value|
      @force_update = value
    end

    opt.separator nil

    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,
           "Set the width of tab characters.") do |value|
      @tab_width = value
    end

    opt.separator nil

    opt.on("--visibility=VISIBILITY", "-V", RDoc::VISIBILITIES,
           "Minimum visibility to document a method.",
           "One of 'public', 'protected' (the default)",
           "or 'private'. Can be abbreviated.") 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

    opt.on("--force-output", "-O",
           "Forces rdoc to write the output files,",
           "even if the output directory exists",
           "and does not seem to have been created",
           "by rdoc.") do |value|
      @force_output = value
    end

    opt.separator nil

    generator_text = @generators.keys.map { |name| "  #{name}" }.sort

    opt.on("-f", "--fmt=FORMAT", "--format=FORMAT", @generators.keys,
           "Set the output formatter.  One of:", *generator_text) do |value|
      check_generator

      @generator_name = value.downcase
      setup_generator
    end

    opt.separator nil

    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|
      @rdoc_include.concat value.map { |dir| dir.strip }
    end

    opt.separator nil

    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

    opt.separator nil

    opt.on("--output=DIR", "--op", "-o",
           "Set the output directory.") do |value|
      @op_dir = value
    end

    opt.separator nil

    opt.on("-d",
           "Deprecated --diagram option.",
           "Prevents firing debug mode",
           "with legacy invocation.") do |value|
    end

    opt.separator nil
    opt.separator 'HTML generator options:'
    opt.separator nil

    opt.on("--charset=CHARSET", "-c",
           "Specifies the output HTML character-set.",
           "Use --encoding instead of --charset if",
           "available.") do |value|
      @charset = value
    end

    opt.separator nil

    opt.on("--hyperlink-all", "-A",
           "Generate hyperlinks for all words that",
           "correspond to known methods, even if they",
           "do not start with '#' or '::' (legacy",
           "behavior).") do |value|
      @hyperlink_all = value
    end

    opt.separator nil

    opt.on("--main=NAME", "-m",
           "NAME will be the initial page displayed.") do |value|
      @main_page = value
    end

    opt.separator nil

    opt.on("--[no-]line-numbers", "-N",
           "Include line numbers in the source code.",
           "By default, only the number of the first",
           "line is displayed, in a leading comment.") do |value|
      @line_numbers = value
    end

    opt.separator nil

    opt.on("--show-hash", "-H",
           "A name of the form #name in a comment is a",
           "possible hyperlink to an instance method",
           "name. When displayed, the '#' is removed",
           "unless this option is specified.") do |value|
      @show_hash = value
    end

    opt.separator nil

    opt.on("--template=NAME", "-T", Template,
           "Set the template used when generating",
           "output. The default depends on the",
           "formatter used.") do |(template, template_dir)|
      @template     = template
      @template_dir = template_dir
    end

    opt.separator nil

    opt.on("--title=TITLE", "-t",
           "Set TITLE as the title for HTML output.") do |value|
      @title = value
    end

    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",
           "name of the current file will be",
           "substituted; if the URL doesn't contain a",
           "'\%s', the filename will be appended to it.") do |value|
      @webcvs = value
    end

    opt.separator nil
    opt.separator "ri generator options:"
    opt.separator nil

    opt.on("--ri", "-r",
           "Generate output for use by `ri`. The files",
           "are stored in the '.rdoc' directory under",
           "your home directory unless overridden by a",
           "subsequent --op parameter, so no special",
           "privileges are needed.") do |value|
      check_generator

      @generator_name = "ri"
      @op_dir ||= RDoc::RI::Paths::HOMEDIR
      setup_generator
    end

    opt.separator nil

    opt.on("--ri-site", "-R",
           "Generate output for use by `ri`. The files",
           "are stored in a site-wide directory,",
           "making them accessible to others, so",
           "special privileges are needed.") do |value|
      check_generator

      @generator_name = "ri"
      @op_dir = RDoc::RI::Paths::SITEDIR
      setup_generator
    end

    opt.separator nil
    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.separator nil

    opt.on("--verbose", "-v",
           "Display extra progress as RDoc parses") do |value|
      @verbosity = 2
    end

    opt.separator nil

    opt.on("--help",
           "Display this help") do
      RDoc::RDoc::GENERATORS.each_key do |generator|
        setup_generator generator
      end

      puts opt.help
      exit
    end

    opt.separator nil
  end

  setup_generator 'darkfish' if
    argv.grep(/\A(-f|--fmt|--format|-r|-R|--ri|--ri-site)\b/).empty?

  deprecated = []
  invalid = []

  begin
    opts.parse! argv
  rescue OptionParser::InvalidArgument, OptionParser::InvalidOption => e
    if DEPRECATED[e.args.first] then
      deprecated << e.args.first
    elsif %w[--format --ri -r --ri-site -R].include? e.args.first then
      raise
    else
      invalid << e.args.join(' ')
    end

    retry
  end

  unless @generator then
    @generator = RDoc::Generator::Darkfish
    @generator_name = 'darkfish'
  end

  if @pipe and not argv.empty? then
    @pipe = false
    invalid << '-p (with files)'
  end

  unless quiet then
    deprecated.each do |opt|
      $stderr.puts 'option ' << opt << ' is deprecated: ' << DEPRECATED[opt]
    end

    unless invalid.empty? then
      invalid = "invalid options: #{invalid.join ', '}"

      if ignore_invalid then
        $stderr.puts invalid
        $stderr.puts '(invalid options are ignored)'
      else
        $stderr.puts opts
        $stderr.puts invalid
        exit 1
      end
    end
  end

  @files = argv.dup

  finish

  if @write_options then
    write_options
    exit
  end

  self
end

#quietObject

Don't display progress as we process the files


1050
1051
1052
# File 'lib/rdoc/options.rb', line 1050

def quiet
  @verbosity.zero?
end

#quiet=(bool) ⇒ Object

Set quietness to bool


1057
1058
1059
# File 'lib/rdoc/options.rb', line 1057

def quiet= bool
  @verbosity = bool ? 0 : 1
end

#sanitize_path(path) ⇒ Object

Removes directories from path that are outside the current directory


1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
# File 'lib/rdoc/options.rb', line 1064

def sanitize_path path
  require 'pathname'
  dot = Pathname.new('.').expand_path

  path.reject do |item|
    path = Pathname.new(item).expand_path
    relative = path.relative_path_from(dot).to_s
    relative.start_with? '..'
  end
end

#setup_generator(generator_name = @generator_name) ⇒ Object

Set up an output generator for the named generator_name.

If the found generator responds to :setup_options it will be called with the options instance. This allows generators to add custom options or set default options.


1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
# File 'lib/rdoc/options.rb', line 1082

def setup_generator generator_name = @generator_name
  @generator = @generators[generator_name]

  unless @generator then
    raise OptionParser::InvalidArgument,
          "Invalid output formatter #{generator_name}"
  end

  return if @generator_options.include? @generator

  @generator_name = generator_name
  @generator_options << @generator

  if @generator.respond_to? :setup_options then
    @option_parser ||= OptionParser.new
    @generator.setup_options self
  end
end

#template_dir_for(template) ⇒ Object

Finds the template dir for template


1104
1105
1106
1107
1108
1109
1110
1111
1112
# File 'lib/rdoc/options.rb', line 1104

def template_dir_for template
  template_path = File.join 'rdoc', 'generator', 'template', template

  $LOAD_PATH.map do |path|
    File.join File.expand_path(path), template_path
  end.find do |dir|
    File.directory? dir
  end
end

#to_yaml(opts = {}) ⇒ Object

This is compatibility code for syck


1117
1118
1119
1120
1121
1122
1123
1124
1125
# File 'lib/rdoc/options.rb', line 1117

def to_yaml opts = {} # :nodoc:
  return super if YAML.const_defined?(:ENGINE) and not YAML::ENGINE.syck?

  YAML.quick_emit self, opts do |out|
    out.map taguri, to_yaml_style do |map|
      encode_with map
    end
  end
end

#warn(message) ⇒ Object

Displays a warning using Kernel#warn if we're being verbose


1130
1131
1132
# File 'lib/rdoc/options.rb', line 1130

def warn message
  super message if @verbosity > 1
end

#write_optionsObject

Writes the YAML file .rdoc_options to the current directory containing the parsed options.


1138
1139
1140
1141
1142
1143
1144
1145
1146
# File 'lib/rdoc/options.rb', line 1138

def write_options
  RDoc.load_yaml

  open '.rdoc_options', 'w' do |io|
    io.set_encoding Encoding::UTF_8 if Object.const_defined? :Encoding

    YAML.dump self, io
  end
end

#yaml_initialize(tag, map) ⇒ Object

:nodoc:


379
380
381
# File 'lib/rdoc/options.rb', line 379

def yaml_initialize tag, map # :nodoc:
  init_with map
end