1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
|
require 'rdoc/ri'
##
# Encapsulate all the strangeness to do with finding out where to find RDoc
# files
#
# We basically deal with three directories:
#
# 1. The 'system' documentation directory, which holds the documentation
# distributed with Ruby, and which is managed by the Ruby install process
# 2. The 'site' directory, which contains site-wide documentation added
# locally.
# 3. The 'user' documentation directory, stored under the user's own home
# directory.
#
# There's contention about all this, but for now:
#
# system:: $datadir/ri/<ver>/system/...
# site:: $datadir/ri/<ver>/site/...
# user:: ~/.rdoc
module RDoc::RI::Paths
#:stopdoc:
require 'rbconfig'
DOC_DIR = "doc/rdoc"
VERSION = RbConfig::CONFIG['ruby_version']
if VERSION > '1.9.1'
if m = /ruby/.match(RbConfig::CONFIG['RUBY_INSTALL_NAME'])
m = [m.pre_match, m.post_match]
else
m = [""] * 2
end
ri = "#{m[0]}ri#{m[1]}"
rdoc = "#{m[0]}rdoc#{m[1]}"
base = File.join(RbConfig::CONFIG['datadir'], ri, VERSION)
else
if m = /ruby/.match(RbConfig::CONFIG['RUBY_BASE_NAME'])
m = [m.pre_match, m.post_match]
else
m = [""] * 2
end
ri = "#{m[0]}ri#{m[1]}"
rdoc = "#{m[0]}rdoc#{m[1]}"
base = File.join(RbConfig::CONFIG['ridir'], VERSION)
end
SYSDIR = File.join(base, "system")
SITEDIR = File.join(base, "site")
HOMEDIR = (File.expand_path("~/.#{rdoc}") rescue nil)
autoload(:GEMDIRS, File.expand_path('../gemdirs.rb', __FILE__))
# Returns the selected documentation directories as an Array, or PATH if no
# overriding directories were given.
def self.path(use_system, use_site, use_home, use_gems, *extra_dirs)
path = raw_path(use_system, use_site, use_home, use_gems, *extra_dirs)
return path.select { |directory| File.directory? directory }
end
# Returns the selected documentation directories including nonexistent
# directories. Used to print out what paths were searched if no ri was
# found.
def self.raw_path(use_system, use_site, use_home, use_gems, *extra_dirs)
path = []
path << extra_dirs unless extra_dirs.empty?
path << SYSDIR if use_system
path << SITEDIR if use_site
path << HOMEDIR if use_home
path << GEMDIRS if use_gems
return path.flatten.compact
end
end
|
