Class: RDoc::Options

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(generators) ⇒ Options

:nodoc:



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/rdoc/options.rb', line 157

def initialize(generators) # :nodoc:
  @op_dir = "doc"
  @op_name = nil
  @show_all = false
  @main_page = nil
  @merge = false
  @exclude = []
  @quiet = false
  @generators = generators
  @generator_name = 'html'
  @generator = @generators[@generator_name]
  @rdoc_include = []
  @title = nil
  @template = nil
  @template_class = nil
  @diagram = false
  @fileboxes = false
  @show_hash = false
  @image_format = 'png'
  @inline_source = false
  @all_one_file = false
  @tab_width = 8
  @include_line_numbers = false
  @extra_accessor_flags = {}
  @promiscuous = false
  @force_update = false
  @title = "RDoc Documentation"

  @css = nil
  @webcvs = nil

  @charset = 'iso-8859-1'
end

Instance Attribute Details

#all_one_file ⇒ Object (readonly)

Should the output be placed into a single file



12
13
14
 
# File 'lib/rdoc/options.rb', line 12

def all_one_file
  @all_one_file
end

#charset ⇒ Object (readonly)

Character-set



17
18
19
 
# File 'lib/rdoc/options.rb', line 17

def charset
  @charset
end

#css ⇒ Object (readonly)

URL of stylesheet



22
23
24
 
# File 'lib/rdoc/options.rb', line 22

def css
  @css
end

#diagram ⇒ Object (readonly)

Should diagrams be drawn



27
28
29
 
# File 'lib/rdoc/options.rb', line 27

def diagram
  @diagram
end

#exclude ⇒ Object

Files matching this pattern will be excluded



32
33
34
 
# File 'lib/rdoc/options.rb', line 32

def exclude
  @exclude
end

#extra_accessor_flags ⇒ Object (readonly)

Additional attr_… style method flags



37
38
39
 
# File 'lib/rdoc/options.rb', line 37

def extra_accessor_flags
  @extra_accessor_flags
end

#extra_accessors ⇒ Object (readonly)

Pattern for additional attr_… style methods



42
43
44
 
# File 'lib/rdoc/options.rb', line 42

def extra_accessors
  @extra_accessors
end

#fileboxes ⇒ Object (readonly)

Should we draw fileboxes in diagrams



47
48
49
 
# File 'lib/rdoc/options.rb', line 47

def fileboxes
  @fileboxes
end

#files ⇒ Object

The list of files to be processed



52
53
54
 
# File 'lib/rdoc/options.rb', line 52

def files
  @files
end

#force_update ⇒ Object (readonly)

Scan newer sources than the flag file if true.



57
58
59
 
# File 'lib/rdoc/options.rb', line 57

def force_update
  @force_update
end

#formatter ⇒ Object

Formatter to mark up text with



67
68
69
 
# File 'lib/rdoc/options.rb', line 67

def formatter
  @formatter
end

#generator ⇒ Object

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



62
63
64
 
# File 'lib/rdoc/options.rb', line 62

def generator
  @generator
end

#image_format ⇒ Object (readonly)

image format for diagrams



72
73
74
 
# File 'lib/rdoc/options.rb', line 72

def image_format
  @image_format
end

#include_line_numbers ⇒ Object (readonly)

Include line numbers in the source listings



77
78
79
 
# File 'lib/rdoc/options.rb', line 77

def include_line_numbers
  @include_line_numbers
end

#inline_source ⇒ Object

Should source code be included inline, or displayed in a popup



82
83
84
 
# File 'lib/rdoc/options.rb', line 82

def inline_source
  @inline_source
end

#main_page ⇒ Object

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



88
89
90
 
# File 'lib/rdoc/options.rb', line 88

def main_page
  @main_page
end

#merge ⇒ Object (readonly)

Merge into classes of the same name when generating ri



93
94
95
 
# File 'lib/rdoc/options.rb', line 93

def merge
  @merge
end

#op_dir ⇒ Object

The name of the output directory



98
99
100
 
# File 'lib/rdoc/options.rb', line 98

def op_dir
  @op_dir
end

#op_name ⇒ Object

The name to use for the output



103
104
105
 
# File 'lib/rdoc/options.rb', line 103

def op_name
  @op_name
end

#promiscuous ⇒ Object (readonly)

Are we promiscuous about showing module contents across multiple files



108
109
110
 
# File 'lib/rdoc/options.rb', line 108

def promiscuous
  @promiscuous
end

#quiet ⇒ Object (readonly)

Don’t display progress as we process the files



113
114
115
 
# File 'lib/rdoc/options.rb', line 113

def quiet
  @quiet
end

#rdoc_include ⇒ Object (readonly)

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



118
119
120
 
# File 'lib/rdoc/options.rb', line 118

def rdoc_include
  @rdoc_include
end

#show_all ⇒ Object

Include private and protected methods in the output



123
124
125
 
# File 'lib/rdoc/options.rb', line 123

def show_all
  @show_all
end

#show_hash ⇒ Object (readonly)

Include the ‘#’ at the front of hyperlinked instance method names



128
129
130
 
# File 'lib/rdoc/options.rb', line 128

def show_hash
  @show_hash
end

#tab_width ⇒ Object (readonly)

The number of columns in a tab



133
134
135
 
# File 'lib/rdoc/options.rb', line 133

def tab_width
  @tab_width
end

#template ⇒ Object (readonly)

template to be used when generating output



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

def template
  @template
end

#template_class ⇒ Object

Template class for file generation – HACK around dependencies in lib/rdoc/generator/html.rb



145
146
147
 
# File 'lib/rdoc/options.rb', line 145

def template_class
  @template_class
end

#title ⇒ Object

Documentation title



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

def title
  @title
end

#webcvs ⇒ Object (readonly)

URL of web cvs frontend



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

def webcvs
  @webcvs
end

Instance Method Details

#parse(argv) ⇒ Object

Parse command line options.



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
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
351
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
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
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
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
 
# File 'lib/rdoc/options.rb', line 194

def parse(argv)
  accessors = []

  opts = OptionParser.new do |opt|
    opt.program_name = File.basename $0
    opt.version = RDoc::VERSION
    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.

- HTML output is normally produced into a number of separate files
  (one per class, module, and file, along with various indices).
  These files will appear in the directory given by the --op
  option (doc/ by default).

- XML output by default is written to standard output. If a
  --opname option is given, the output will instead be written
  to a file with that name in the output directory.

- .chm files (Windows help files) are written in the --op directory.
  If an --opname parameter is present, that name is used, otherwise
  the file will be called rdoc.chm.
    EOF

    opt.separator nil
    opt.separator "Options:"
    opt.separator nil

    opt.on("--accessor=ACCESSORS", "-A", Array,
           "A comma separated list of additional class",
           "methods that should be treated like",
           "'attr_reader' and friends.",
           " ",
           "Option may be repeated.",
           " ",
           "Each accessorname may have '=text'",
           "appended, in which case that text appears",
           "where the r/w/rw appears for normal.",
           "accessors") do |value|
      value.each do |accessor|
        if accessor =~ /^(\w+)(=(.*))?$/
          accessors << $1
          @extra_accessor_flags[$1] = $3
        end
      end
    end

    opt.separator nil

    opt.on("--all", "-a",
           "Include all methods (not just public) in",
           "the output.") do |value|
      @show_all = value
    end

    opt.separator nil

    opt.on("--charset=CHARSET", "-c",
           "Specifies the HTML character-set.") do |value|
      @charset = value
    end

    opt.separator nil

    opt.on("--debug", "-D",
           "Displays lots on internal stuff.") do |value|
      $DEBUG_RDOC = value
    end

    opt.separator nil

    opt.on("--diagram", "-d",
           "Generate diagrams showing modules and",
           "classes. You need dot V1.8.6 or later to",
           "use the --diagram option correctly. Dot is",
           "available from http://graphviz.org") do |value|
      check_diagram
      @diagram = true
    end

    opt.separator nil

    opt.on("--exclude=PATTERN", "-x", Regexp,
           "Do not process files or directories",
           "matching PATTERN. Files given explicitly",
           "on the command line will never be",
           "excluded.") 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::ParserFactory.alias_extension old, new then
        raise OptionParser::InvalidArgument, "Unknown extension .#{old} to -E"
      end
    end

    opt.separator nil

    opt.on("--fileboxes", "-F",
           "Classes are put in boxes which represents",
           "files, where these classes reside. Classes",
           "shared between more than one file are",
           "shown with list of files that are sharing",
           "them. Silently discarded if --diagram is",
           "not given.") do |value|
      @fileboxes = value
    end

    opt.separator nil

    opt.on("--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("--fmt=FORMAT", "--format=FORMAT", "-f", @generators.keys,
           "Set the output formatter.") do |value|
      @generator_name = value.downcase
      setup_generator
    end

    opt.separator nil

    image_formats = %w[gif png jpg jpeg]
    opt.on("--image-format=FORMAT", "-I", image_formats,
           "Sets output image format for diagrams. Can",
           "be #{image_formats.join ', '}. If this option",
           "is omitted, png is used. Requires",
           "diagrams.") do |value|
      @image_format = value
    end

    opt.separator nil

    opt.on("--include=DIRECTORIES", "-i", Array,
           "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("--inline-source", "-S",
           "Show method source code inline, rather than",
           "via a popup link.") do |value|
      @inline_source = value
    end

    opt.separator nil

    opt.on("--line-numbers", "-N",
           "Include line numbers in the source code.") do |value|
      @include_line_numbers = 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("--merge", "-M",
           "When creating ri output, merge previously",
           "processed classes into previously",
           "documented classes of the same name.") do |value|
      @merge = value
    end

    opt.separator nil

    opt.on("--one-file", "-1",
           "Put all the output into a single file.") do |value|
      @all_one_file = value
      @inline_source = value if value
      @template = 'one_page_html'
    end

    opt.separator nil

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

    opt.separator nil

    opt.on("--opname=NAME", "-n",
           "Set the NAME of the output. Has no effect",
           "for HTML.") do |value|
      @op_name = value
    end

    opt.separator nil

    opt.on("--promiscuous", "-p",
           "When documenting a file that contains a",
           "module or class also defined in other",
           "files, show all stuff for that module or",
           "class in each files page. By default, only",
           "show stuff defined in that particular file.") do |value|
      @promiscuous = value
    end

    opt.separator nil

    opt.on("--quiet", "-q",
           "Don't show progress as we parse.") do |value|
      @quiet = value
    end

    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|
      @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|
      @generator_name = "ri"
      @op_dir = RDoc::RI::Paths::SITEDIR
      setup_generator
    end

    opt.separator nil

    opt.on("--ri-system", "-Y",
           "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.  This",
           "option is intended to be used during Ruby",
           "installation.") do |value|
      @generator_name = "ri"
      @op_dir = RDoc::RI::Paths::SYSDIR
      setup_generator
    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("--style=URL", "-s",
           "Specifies the URL of a separate stylesheet.") do |value|
      @css = value
    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("--template=NAME", "-T",
           "Set the template used when generating",
           "output.") do |value|
      @template = value
    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("--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
  end

  opts.parse! argv

  @files = argv.dup

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

  if @exclude.empty? then
    @exclude = nil
  else
    @exclude = Regexp.new(@exclude.join("|"))
  end

  check_files

  # If no template was specified, use the default template for the output
  # formatter

  @template ||= @generator_name

  # Generate a regexp from the accessors
  unless accessors.empty? then
    re = '^(' + accessors.map { |a| Regexp.quote a }.join('|') + ')$'
    @extra_accessors = Regexp.new re
  end

rescue OptionParser::InvalidArgument, OptionParser::InvalidOption => e
  puts opts
  puts
  puts e
  exit 1
end