iqeo-conf 0.0.10 → 0.0.11
Sign up to get free protection for your applications and to get access to all the features.
- data/.gitignore +2 -2
- data/.yardoc/checksums +2 -0
- data/.yardoc/object_types +0 -0
- data/.yardoc/objects/root.dat +0 -0
- data/.yardoc/proxy_types +2 -0
- data/Gemfile.lock +8 -2
- data/README.md +88 -60
- data/Rakefile +15 -7
- data/doc/Iqeo/Configuration.html +974 -0
- data/doc/Iqeo.html +128 -0
- data/doc/_index.html +125 -0
- data/doc/class_list.html +53 -0
- data/doc/css/common.css +1 -0
- data/doc/css/full_list.css +57 -0
- data/doc/css/style.css +328 -0
- data/doc/file.README.html +206 -0
- data/doc/file_list.html +55 -0
- data/doc/frames.html +28 -0
- data/doc/index.html +206 -0
- data/doc/js/app.js +208 -0
- data/doc/js/full_list.js +173 -0
- data/doc/js/jquery.js +4 -0
- data/doc/method_list.html +140 -0
- data/doc/top-level-namespace.html +112 -0
- data/iqeo-conf.gemspec +6 -3
- data/lib/iqeo/configuration/version.rb +2 -1
- data/lib/iqeo/configuration.rb +28 -8
- data/spec/configuration_spec.rb +9 -9
- metadata +62 -20
- data/.rspec +0 -2
- data/.rvmrc +0 -1
- data/pkg/iqeo-conf-0.0.1.gem +0 -0
- data/pkg/iqeo-conf-0.0.2.gem +0 -0
- data/pkg/iqeo-conf-0.0.3.gem +0 -0
- data/pkg/iqeo-conf-0.0.4.gem +0 -0
- data/pkg/iqeo-conf-0.0.5.gem +0 -0
- data/pkg/iqeo-conf-0.0.6.gem +0 -0
- data/pkg/iqeo-conf-0.0.7.gem +0 -0
- data/pkg/iqeo-conf-0.0.8.gem +0 -0
- data/pkg/iqeo-conf-0.0.9.gem +0 -0
data/doc/index.html
ADDED
|
@@ -0,0 +1,206 @@
|
|
|
1
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
2
|
+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
3
|
+
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
|
|
4
|
+
<head>
|
|
5
|
+
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
|
|
6
|
+
<title>
|
|
7
|
+
File: README
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.8.1
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
|
|
16
|
+
|
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
|
18
|
+
hasFrames = window.top.frames.main ? true : false;
|
|
19
|
+
relpath = '';
|
|
20
|
+
framesUrl = "frames.html#!" + escape(window.location.href);
|
|
21
|
+
</script>
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
|
25
|
+
|
|
26
|
+
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
</head>
|
|
30
|
+
<body>
|
|
31
|
+
<div id="header">
|
|
32
|
+
<div id="menu">
|
|
33
|
+
|
|
34
|
+
<a href="_index.html">Index</a> »
|
|
35
|
+
<span class="title">File: README</span>
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
|
|
39
|
+
</div>
|
|
40
|
+
|
|
41
|
+
<div id="search">
|
|
42
|
+
|
|
43
|
+
<a class="full_list_link" id="class_list_link"
|
|
44
|
+
href="class_list.html">
|
|
45
|
+
Class List
|
|
46
|
+
</a>
|
|
47
|
+
|
|
48
|
+
<a class="full_list_link" id="method_list_link"
|
|
49
|
+
href="method_list.html">
|
|
50
|
+
Method List
|
|
51
|
+
</a>
|
|
52
|
+
|
|
53
|
+
<a class="full_list_link" id="file_list_link"
|
|
54
|
+
href="file_list.html">
|
|
55
|
+
File List
|
|
56
|
+
</a>
|
|
57
|
+
|
|
58
|
+
</div>
|
|
59
|
+
<div class="clear"></div>
|
|
60
|
+
</div>
|
|
61
|
+
|
|
62
|
+
<iframe id="search_frame"></iframe>
|
|
63
|
+
|
|
64
|
+
<div id="content"><div id='filecontents'><h1>Iqeo::Configuration</h1>
|
|
65
|
+
|
|
66
|
+
<p>A DSL representing configuration files.</p>
|
|
67
|
+
|
|
68
|
+
<h2>Installation</h2>
|
|
69
|
+
|
|
70
|
+
<p>It`s a gem...</p>
|
|
71
|
+
|
|
72
|
+
<pre class="code ruby"><code>$ gem install iqeo-conf
|
|
73
|
+
</code></pre>
|
|
74
|
+
|
|
75
|
+
<h2>Usage</h2>
|
|
76
|
+
|
|
77
|
+
<p>Require 'iqeo/configuration' and optionally include Iqeo namespace:</p>
|
|
78
|
+
|
|
79
|
+
<pre class="code ruby"><code><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>iqeo/configuration</span><span class='tstring_end'>'</span></span>
|
|
80
|
+
<span class='id identifier rubyid_include'>include</span> <span class='const'>Iqeo</span>
|
|
81
|
+
</code></pre>
|
|
82
|
+
|
|
83
|
+
<h3>Create configuration</h3>
|
|
84
|
+
|
|
85
|
+
<p>There are three ways to create configurations; explicit, block DSL, eval DSL.</p>
|
|
86
|
+
|
|
87
|
+
<h4>Explicit</h4>
|
|
88
|
+
|
|
89
|
+
<p>Call Configuration#new without a block.
|
|
90
|
+
Explicitly call methods on instance to configure instance.</p>
|
|
91
|
+
|
|
92
|
+
<pre class="code ruby"><code><span class='id identifier rubyid_conf'>conf</span> <span class='op'>=</span> <span class='const'>Configuration</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
|
|
93
|
+
<span class='id identifier rubyid_conf'>conf</span><span class='period'>.</span><span class='id identifier rubyid_alpha'>alpha</span> <span class='int'>1</span>
|
|
94
|
+
<span class='id identifier rubyid_conf'>conf</span><span class='period'>.</span><span class='id identifier rubyid_bravo'>bravo</span> <span class='float'>2.0</span>
|
|
95
|
+
<span class='id identifier rubyid_conf'>conf</span><span class='period'>.</span><span class='id identifier rubyid_charlie'>charlie</span> <span class='symbol'>:three</span>
|
|
96
|
+
<span class='id identifier rubyid_conf'>conf</span><span class='period'>.</span><span class='id identifier rubyid_delta'>delta</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>four</span><span class='tstring_end'>"</span></span>
|
|
97
|
+
</code></pre>
|
|
98
|
+
|
|
99
|
+
<h4>Block DSL</h4>
|
|
100
|
+
|
|
101
|
+
<p>Call Configuration#new with a block that expects a variable, a new instance will be yielded.
|
|
102
|
+
Within block, call methods on yielded instance to configure.</p>
|
|
103
|
+
|
|
104
|
+
<pre class="code ruby"><code><span class='id identifier rubyid_conf'>conf</span> <span class='op'>=</span> <span class='const'>Configuration</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_c'>c</span><span class='op'>|</span>
|
|
105
|
+
<span class='id identifier rubyid_c'>c</span><span class='period'>.</span><span class='id identifier rubyid_alpha'>alpha</span> <span class='int'>1</span>
|
|
106
|
+
<span class='id identifier rubyid_c'>c</span><span class='period'>.</span><span class='id identifier rubyid_bravo'>bravo</span> <span class='float'>2.0</span>
|
|
107
|
+
<span class='id identifier rubyid_c'>c</span><span class='period'>.</span><span class='id identifier rubyid_charlie'>charlie</span> <span class='symbol'>:three</span>
|
|
108
|
+
<span class='id identifier rubyid_c'>c</span><span class='period'>.</span><span class='id identifier rubyid_delta'>delta</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>four</span><span class='tstring_end'>"</span></span>
|
|
109
|
+
<span class='kw'>end</span>
|
|
110
|
+
</code></pre>
|
|
111
|
+
|
|
112
|
+
<h4>Eval DSL</h4>
|
|
113
|
+
|
|
114
|
+
<p>Call Configuration#new with a block that does not expect a variable, contents of the block are eval`d in the context of the new instance.
|
|
115
|
+
Call methods with implied self to configure instance.</p>
|
|
116
|
+
|
|
117
|
+
<pre class="code ruby"><code><span class='id identifier rubyid_conf'>conf</span> <span class='op'>=</span> <span class='const'>Configuration</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='kw'>do</span>
|
|
118
|
+
<span class='id identifier rubyid_alpha'>alpha</span> <span class='int'>1</span>
|
|
119
|
+
<span class='id identifier rubyid_bravo'>bravo</span> <span class='float'>2.0</span>
|
|
120
|
+
<span class='id identifier rubyid_charlie'>charlie</span> <span class='symbol'>:three</span>
|
|
121
|
+
<span class='id identifier rubyid_delta'>delta</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>four</span><span class='tstring_end'>"</span></span>
|
|
122
|
+
<span class='kw'>end</span>
|
|
123
|
+
</code></pre>
|
|
124
|
+
|
|
125
|
+
<h3>Read configuration</h3>
|
|
126
|
+
|
|
127
|
+
<p>All examples above result in the same configuration.
|
|
128
|
+
Configuration settings can be retrieved directly or indirectly.</p>
|
|
129
|
+
|
|
130
|
+
<h4>Directly</h4>
|
|
131
|
+
|
|
132
|
+
<h5>Named method</h5>
|
|
133
|
+
|
|
134
|
+
<pre class="code ruby"><code><span class='id identifier rubyid_conf'>conf</span><span class='period'>.</span><span class='id identifier rubyid_alpha'>alpha</span> <span class='comment'># => 1
|
|
135
|
+
</span><span class='id identifier rubyid_conf'>conf</span><span class='period'>.</span><span class='id identifier rubyid_bravo'>bravo</span> <span class='comment'># => 2.0
|
|
136
|
+
</span><span class='id identifier rubyid_conf'>conf</span><span class='period'>.</span><span class='id identifier rubyid_charlie'>charlie</span> <span class='comment'># => :three
|
|
137
|
+
</span><span class='id identifier rubyid_conf'>conf</span><span class='period'>.</span><span class='id identifier rubyid_delta'>delta</span> <span class='comment'># => "four"
|
|
138
|
+
</span></code></pre>
|
|
139
|
+
|
|
140
|
+
<h5>[ 'string' ]</h5>
|
|
141
|
+
|
|
142
|
+
<pre class="code ruby"><code><span class='id identifier rubyid_conf'>conf</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>alpha</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> <span class='comment'># => 1
|
|
143
|
+
</span><span class='id identifier rubyid_conf'>conf</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>bravo</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> <span class='comment'># => 2.0
|
|
144
|
+
</span><span class='id identifier rubyid_conf'>conf</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>charlie</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> <span class='comment'># => :three
|
|
145
|
+
</span><span class='id identifier rubyid_conf'>conf</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>delta</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> <span class='comment'># => "four"
|
|
146
|
+
</span></code></pre>
|
|
147
|
+
|
|
148
|
+
<h5>[ :symbol ]</h5>
|
|
149
|
+
|
|
150
|
+
<pre class="code ruby"><code><span class='id identifier rubyid_conf'>conf</span><span class='lbracket'>[</span><span class='symbol'>:alpha</span><span class='rbracket'>]</span> <span class='comment'># => 1
|
|
151
|
+
</span><span class='id identifier rubyid_conf'>conf</span><span class='lbracket'>[</span><span class='symbol'>:bravo</span><span class='rbracket'>]</span> <span class='comment'># => 2.0
|
|
152
|
+
</span><span class='id identifier rubyid_conf'>conf</span><span class='lbracket'>[</span><span class='symbol'>:charlie</span><span class='rbracket'>]</span> <span class='comment'># => :three
|
|
153
|
+
</span><span class='id identifier rubyid_conf'>conf</span><span class='lbracket'>[</span><span class='symbol'>:delta</span><span class='rbracket'>]</span> <span class='comment'># => "four"
|
|
154
|
+
</span></code></pre>
|
|
155
|
+
|
|
156
|
+
<h4>Indirectly</h4>
|
|
157
|
+
|
|
158
|
+
<p>The underlying storage is an indifferent hash, so the usual Hash and Enumerable methods work.</p>
|
|
159
|
+
|
|
160
|
+
<h5>Hash & Enumerable methods</h5>
|
|
161
|
+
|
|
162
|
+
<pre class="code ruby"><code><span class='id identifier rubyid_conf'>conf</span><span class='period'>.</span><span class='id identifier rubyid_size'>size</span> <span class='comment'># => 4
|
|
163
|
+
</span><span class='id identifier rubyid_conf'>conf</span><span class='period'>.</span><span class='id identifier rubyid_keys'>keys</span> <span class='comment'># => [ 'alpha', 'bravo', 'charlie', 'delta' ]
|
|
164
|
+
</span><span class='id identifier rubyid_conf'>conf</span><span class='period'>.</span><span class='id identifier rubyid_collect'>collect</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span><span class='id identifier rubyid_value'>value</span><span class='op'>|</span> <span class='id identifier rubyid_value'>value</span> <span class='rbrace'>}</span> <span class='comment'># => [ 1, 2.0, :three, 'four' ]
|
|
165
|
+
</span></code></pre>
|
|
166
|
+
|
|
167
|
+
<h2>Features</h2>
|
|
168
|
+
|
|
169
|
+
<ul>
|
|
170
|
+
<li>settings by named methods</li>
|
|
171
|
+
<li>settings by '[]' & '[]='</li>
|
|
172
|
+
<li>settings & locals with '='</li>
|
|
173
|
+
<li>referencing existing settings</li>
|
|
174
|
+
<li>nested configurations</li>
|
|
175
|
+
<li>inheritance & override</li>
|
|
176
|
+
<li>read from string, at creation, or after - merged & nested</li>
|
|
177
|
+
<li>load from filename, at creation, or after - merged & nested</li>
|
|
178
|
+
<li>todo: merge configurations</li>
|
|
179
|
+
<li>todo: defaults</li>
|
|
180
|
+
<li>todo: blank slate</li>
|
|
181
|
+
</ul>
|
|
182
|
+
|
|
183
|
+
<h2>Fancy usage</h2>
|
|
184
|
+
|
|
185
|
+
<ul>
|
|
186
|
+
<li>Dynamic settings by '[]' & '[]=' & 'self'</li>
|
|
187
|
+
<li>Multiple configuration files</li>
|
|
188
|
+
<li>Hierarchial configuration files</li>
|
|
189
|
+
</ul>
|
|
190
|
+
|
|
191
|
+
<h2>License</h2>
|
|
192
|
+
|
|
193
|
+
<p>Copyright Gerard Fowley (<a href="mailto:gerard.fowley@iqeo.net">gerard.fowley@iqeo.net</a>).</p>
|
|
194
|
+
|
|
195
|
+
<p>Licensed under GPL Version 3 license.
|
|
196
|
+
See LICENSE file.</p>
|
|
197
|
+
</div></div>
|
|
198
|
+
|
|
199
|
+
<div id="footer">
|
|
200
|
+
Generated on Fri May 11 14:53:17 2012 by
|
|
201
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
202
|
+
0.8.1 (ruby-1.9.3).
|
|
203
|
+
</div>
|
|
204
|
+
|
|
205
|
+
</body>
|
|
206
|
+
</html>
|
data/doc/js/app.js
ADDED
|
@@ -0,0 +1,208 @@
|
|
|
1
|
+
function createSourceLinks() {
|
|
2
|
+
$('.method_details_list .source_code').
|
|
3
|
+
before("<span class='showSource'>[<a href='#' class='toggleSource'>View source</a>]</span>");
|
|
4
|
+
$('.toggleSource').toggle(function() {
|
|
5
|
+
$(this).parent().nextAll('.source_code').slideDown(100);
|
|
6
|
+
$(this).text("Hide source");
|
|
7
|
+
},
|
|
8
|
+
function() {
|
|
9
|
+
$(this).parent().nextAll('.source_code').slideUp(100);
|
|
10
|
+
$(this).text("View source");
|
|
11
|
+
});
|
|
12
|
+
}
|
|
13
|
+
|
|
14
|
+
function createDefineLinks() {
|
|
15
|
+
var tHeight = 0;
|
|
16
|
+
$('.defines').after(" <a href='#' class='toggleDefines'>more...</a>");
|
|
17
|
+
$('.toggleDefines').toggle(function() {
|
|
18
|
+
tHeight = $(this).parent().prev().height();
|
|
19
|
+
$(this).prev().show();
|
|
20
|
+
$(this).parent().prev().height($(this).parent().height());
|
|
21
|
+
$(this).text("(less)");
|
|
22
|
+
},
|
|
23
|
+
function() {
|
|
24
|
+
$(this).prev().hide();
|
|
25
|
+
$(this).parent().prev().height(tHeight);
|
|
26
|
+
$(this).text("more...");
|
|
27
|
+
});
|
|
28
|
+
}
|
|
29
|
+
|
|
30
|
+
function createFullTreeLinks() {
|
|
31
|
+
var tHeight = 0;
|
|
32
|
+
$('.inheritanceTree').toggle(function() {
|
|
33
|
+
tHeight = $(this).parent().prev().height();
|
|
34
|
+
$(this).parent().toggleClass('showAll');
|
|
35
|
+
$(this).text("(hide)");
|
|
36
|
+
$(this).parent().prev().height($(this).parent().height());
|
|
37
|
+
},
|
|
38
|
+
function() {
|
|
39
|
+
$(this).parent().toggleClass('showAll');
|
|
40
|
+
$(this).parent().prev().height(tHeight);
|
|
41
|
+
$(this).text("show all");
|
|
42
|
+
});
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
function fixBoxInfoHeights() {
|
|
46
|
+
$('dl.box dd.r1, dl.box dd.r2').each(function() {
|
|
47
|
+
$(this).prev().height($(this).height());
|
|
48
|
+
});
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
function searchFrameLinks() {
|
|
52
|
+
$('.full_list_link').click(function() {
|
|
53
|
+
toggleSearchFrame(this, $(this).attr('href'));
|
|
54
|
+
return false;
|
|
55
|
+
});
|
|
56
|
+
}
|
|
57
|
+
|
|
58
|
+
function toggleSearchFrame(id, link) {
|
|
59
|
+
var frame = $('#search_frame');
|
|
60
|
+
$('#search a').removeClass('active').addClass('inactive');
|
|
61
|
+
if (frame.attr('src') == link && frame.css('display') != "none") {
|
|
62
|
+
frame.slideUp(100);
|
|
63
|
+
$('#search a').removeClass('active inactive');
|
|
64
|
+
}
|
|
65
|
+
else {
|
|
66
|
+
$(id).addClass('active').removeClass('inactive');
|
|
67
|
+
frame.attr('src', link).slideDown(100);
|
|
68
|
+
}
|
|
69
|
+
}
|
|
70
|
+
|
|
71
|
+
function linkSummaries() {
|
|
72
|
+
$('.summary_signature').click(function() {
|
|
73
|
+
document.location = $(this).find('a').attr('href');
|
|
74
|
+
});
|
|
75
|
+
}
|
|
76
|
+
|
|
77
|
+
function framesInit() {
|
|
78
|
+
if (hasFrames) {
|
|
79
|
+
document.body.className = 'frames';
|
|
80
|
+
$('#menu .noframes a').attr('href', document.location);
|
|
81
|
+
window.top.document.title = $('html head title').text();
|
|
82
|
+
}
|
|
83
|
+
else {
|
|
84
|
+
$('#menu .noframes a').text('frames').attr('href', framesUrl);
|
|
85
|
+
}
|
|
86
|
+
}
|
|
87
|
+
|
|
88
|
+
function keyboardShortcuts() {
|
|
89
|
+
if (window.top.frames.main) return;
|
|
90
|
+
$(document).keypress(function(evt) {
|
|
91
|
+
if (evt.altKey || evt.ctrlKey || evt.metaKey || evt.shiftKey) return;
|
|
92
|
+
if (typeof evt.target !== "undefined" &&
|
|
93
|
+
(evt.target.nodeName == "INPUT" ||
|
|
94
|
+
evt.target.nodeName == "TEXTAREA")) return;
|
|
95
|
+
switch (evt.charCode) {
|
|
96
|
+
case 67: case 99: $('#class_list_link').click(); break; // 'c'
|
|
97
|
+
case 77: case 109: $('#method_list_link').click(); break; // 'm'
|
|
98
|
+
case 70: case 102: $('#file_list_link').click(); break; // 'f'
|
|
99
|
+
default: break;
|
|
100
|
+
}
|
|
101
|
+
});
|
|
102
|
+
}
|
|
103
|
+
|
|
104
|
+
function summaryToggle() {
|
|
105
|
+
$('.summary_toggle').click(function() {
|
|
106
|
+
localStorage.summaryCollapsed = $(this).text();
|
|
107
|
+
$(this).text($(this).text() == "collapse" ? "expand" : "collapse");
|
|
108
|
+
var next = $(this).parent().parent().nextAll('ul.summary').first();
|
|
109
|
+
if (next.hasClass('compact')) {
|
|
110
|
+
next.toggle();
|
|
111
|
+
next.nextAll('ul.summary').first().toggle();
|
|
112
|
+
}
|
|
113
|
+
else if (next.hasClass('summary')) {
|
|
114
|
+
var list = $('<ul class="summary compact" />');
|
|
115
|
+
list.html(next.html());
|
|
116
|
+
list.find('.summary_desc, .note').remove();
|
|
117
|
+
list.find('a').each(function() {
|
|
118
|
+
$(this).html($(this).find('strong').html());
|
|
119
|
+
$(this).parent().html($(this)[0].outerHTML);
|
|
120
|
+
});
|
|
121
|
+
next.before(list);
|
|
122
|
+
next.toggle();
|
|
123
|
+
}
|
|
124
|
+
return false;
|
|
125
|
+
});
|
|
126
|
+
if (localStorage) {
|
|
127
|
+
if (localStorage.summaryCollapsed == "collapse") $('.summary_toggle').click();
|
|
128
|
+
else localStorage.summaryCollapsed = "expand";
|
|
129
|
+
}
|
|
130
|
+
}
|
|
131
|
+
|
|
132
|
+
function fixOutsideWorldLinks() {
|
|
133
|
+
$('a').each(function() {
|
|
134
|
+
if (window.location.host != this.host) this.target = '_parent';
|
|
135
|
+
});
|
|
136
|
+
}
|
|
137
|
+
|
|
138
|
+
function generateTOC() {
|
|
139
|
+
if ($('#filecontents').length === 0) return;
|
|
140
|
+
var _toc = $('<ol class="top"></ol>');
|
|
141
|
+
var show = false;
|
|
142
|
+
var toc = _toc;
|
|
143
|
+
var counter = 0;
|
|
144
|
+
var tags = ['h2', 'h3', 'h4', 'h5', 'h6'];
|
|
145
|
+
var i;
|
|
146
|
+
if ($('#filecontents h1').length > 1) tags.unshift('h1');
|
|
147
|
+
for (i = 0; i < tags.length; i++) { tags[i] = '#filecontents ' + tags[i]; }
|
|
148
|
+
var lastTag = parseInt(tags[0][1], 10);
|
|
149
|
+
$(tags.join(', ')).each(function() {
|
|
150
|
+
if ($(this).parents('.method_details .docstring').length != 0) return;
|
|
151
|
+
if (this.id == "filecontents") return;
|
|
152
|
+
show = true;
|
|
153
|
+
var thisTag = parseInt(this.tagName[1], 10);
|
|
154
|
+
if (this.id.length === 0) {
|
|
155
|
+
var proposedId = $(this).attr('toc-id');
|
|
156
|
+
if (typeof(proposedId) != "undefined") this.id = proposedId;
|
|
157
|
+
else {
|
|
158
|
+
var proposedId = $(this).text().replace(/[^a-z0-9-]/ig, '_');
|
|
159
|
+
if ($('#' + proposedId).length > 0) { proposedId += counter; counter++; }
|
|
160
|
+
this.id = proposedId;
|
|
161
|
+
}
|
|
162
|
+
}
|
|
163
|
+
if (thisTag > lastTag) {
|
|
164
|
+
for (i = 0; i < thisTag - lastTag; i++) {
|
|
165
|
+
var tmp = $('<ol/>'); toc.append(tmp); toc = tmp;
|
|
166
|
+
}
|
|
167
|
+
}
|
|
168
|
+
if (thisTag < lastTag) {
|
|
169
|
+
for (i = 0; i < lastTag - thisTag; i++) toc = toc.parent();
|
|
170
|
+
}
|
|
171
|
+
var title = $(this).attr('toc-title');
|
|
172
|
+
if (typeof(title) == "undefined") title = $(this).text();
|
|
173
|
+
toc.append('<li><a href="#' + this.id + '">' + title + '</a></li>');
|
|
174
|
+
lastTag = thisTag;
|
|
175
|
+
});
|
|
176
|
+
if (!show) return;
|
|
177
|
+
html = '<div id="toc"><p class="title"><a class="hide_toc" href="#"><strong>Table of Contents</strong></a> <small>(<a href="#" class="float_toc">left</a>)</small></p></div>';
|
|
178
|
+
$('#content').prepend(html);
|
|
179
|
+
$('#toc').append(_toc);
|
|
180
|
+
$('#toc .hide_toc').toggle(function() {
|
|
181
|
+
$('#toc .top').slideUp('fast');
|
|
182
|
+
$('#toc').toggleClass('hidden');
|
|
183
|
+
$('#toc .title small').toggle();
|
|
184
|
+
}, function() {
|
|
185
|
+
$('#toc .top').slideDown('fast');
|
|
186
|
+
$('#toc').toggleClass('hidden');
|
|
187
|
+
$('#toc .title small').toggle();
|
|
188
|
+
});
|
|
189
|
+
$('#toc .float_toc').toggle(function() {
|
|
190
|
+
$(this).text('float');
|
|
191
|
+
$('#toc').toggleClass('nofloat');
|
|
192
|
+
}, function() {
|
|
193
|
+
$(this).text('left');
|
|
194
|
+
$('#toc').toggleClass('nofloat');
|
|
195
|
+
});
|
|
196
|
+
}
|
|
197
|
+
|
|
198
|
+
$(framesInit);
|
|
199
|
+
$(createSourceLinks);
|
|
200
|
+
$(createDefineLinks);
|
|
201
|
+
$(createFullTreeLinks);
|
|
202
|
+
$(fixBoxInfoHeights);
|
|
203
|
+
$(searchFrameLinks);
|
|
204
|
+
$(linkSummaries);
|
|
205
|
+
$(keyboardShortcuts);
|
|
206
|
+
$(summaryToggle);
|
|
207
|
+
$(fixOutsideWorldLinks);
|
|
208
|
+
$(generateTOC);
|
data/doc/js/full_list.js
ADDED
|
@@ -0,0 +1,173 @@
|
|
|
1
|
+
var inSearch = null;
|
|
2
|
+
var searchIndex = 0;
|
|
3
|
+
var searchCache = [];
|
|
4
|
+
var searchString = '';
|
|
5
|
+
var regexSearchString = '';
|
|
6
|
+
var caseSensitiveMatch = false;
|
|
7
|
+
var ignoreKeyCodeMin = 8;
|
|
8
|
+
var ignoreKeyCodeMax = 46;
|
|
9
|
+
var commandKey = 91;
|
|
10
|
+
|
|
11
|
+
RegExp.escape = function(text) {
|
|
12
|
+
return text.replace(/[-[\]{}()*+?.,\\^$|#\s]/g, "\\$&");
|
|
13
|
+
}
|
|
14
|
+
|
|
15
|
+
function fullListSearch() {
|
|
16
|
+
// generate cache
|
|
17
|
+
searchCache = [];
|
|
18
|
+
$('#full_list li').each(function() {
|
|
19
|
+
var link = $(this).find('.object_link a');
|
|
20
|
+
var fullName = link.attr('title').split(' ')[0];
|
|
21
|
+
searchCache.push({name:link.text(), fullName:fullName, node:$(this), link:link});
|
|
22
|
+
});
|
|
23
|
+
|
|
24
|
+
$('#search input').keyup(function(event) {
|
|
25
|
+
if ((event.keyCode > ignoreKeyCodeMin && event.keyCode < ignoreKeyCodeMax)
|
|
26
|
+
|| event.keyCode == commandKey)
|
|
27
|
+
return;
|
|
28
|
+
searchString = this.value;
|
|
29
|
+
caseSensitiveMatch = searchString.match(/[A-Z]/) != null;
|
|
30
|
+
regexSearchString = RegExp.escape(searchString);
|
|
31
|
+
if (caseSensitiveMatch) {
|
|
32
|
+
regexSearchString += "|" +
|
|
33
|
+
$.map(searchString.split(''), function(e) { return RegExp.escape(e); }).
|
|
34
|
+
join('.+?');
|
|
35
|
+
}
|
|
36
|
+
if (searchString === "") {
|
|
37
|
+
clearTimeout(inSearch);
|
|
38
|
+
inSearch = null;
|
|
39
|
+
$('ul .search_uncollapsed').removeClass('search_uncollapsed');
|
|
40
|
+
$('#full_list, #content').removeClass('insearch');
|
|
41
|
+
$('#full_list li').removeClass('found').each(function() {
|
|
42
|
+
|
|
43
|
+
var link = $(this).find('.object_link a');
|
|
44
|
+
link.text(link.text());
|
|
45
|
+
});
|
|
46
|
+
if (clicked) {
|
|
47
|
+
clicked.parents('ul').each(function() {
|
|
48
|
+
$(this).removeClass('collapsed').prev().removeClass('collapsed');
|
|
49
|
+
});
|
|
50
|
+
}
|
|
51
|
+
highlight();
|
|
52
|
+
}
|
|
53
|
+
else {
|
|
54
|
+
if (inSearch) clearTimeout(inSearch);
|
|
55
|
+
searchIndex = 0;
|
|
56
|
+
lastRowClass = '';
|
|
57
|
+
$('#full_list, #content').addClass('insearch');
|
|
58
|
+
$('#noresults').text('');
|
|
59
|
+
searchItem();
|
|
60
|
+
}
|
|
61
|
+
});
|
|
62
|
+
|
|
63
|
+
$('#search input').focus();
|
|
64
|
+
$('#full_list').after("<div id='noresults'></div>");
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
var lastRowClass = '';
|
|
68
|
+
function searchItem() {
|
|
69
|
+
for (var i = 0; i < searchCache.length / 50; i++) {
|
|
70
|
+
var item = searchCache[searchIndex];
|
|
71
|
+
var searchName = (searchString.indexOf('::') != -1 ? item.fullName : item.name);
|
|
72
|
+
var matchString = regexSearchString;
|
|
73
|
+
var matchRegexp = new RegExp(matchString, caseSensitiveMatch ? "" : "i");
|
|
74
|
+
if (searchName.match(matchRegexp) == null) {
|
|
75
|
+
item.node.removeClass('found');
|
|
76
|
+
}
|
|
77
|
+
else {
|
|
78
|
+
item.node.css('padding-left', '10px').addClass('found');
|
|
79
|
+
item.node.parents().addClass('search_uncollapsed');
|
|
80
|
+
item.node.removeClass(lastRowClass).addClass(lastRowClass == 'r1' ? 'r2' : 'r1');
|
|
81
|
+
lastRowClass = item.node.hasClass('r1') ? 'r1' : 'r2';
|
|
82
|
+
item.link.html(item.name.replace(matchRegexp, "<strong>$&</strong>"));
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
if (searchCache.length === searchIndex + 1) {
|
|
86
|
+
searchDone();
|
|
87
|
+
return;
|
|
88
|
+
}
|
|
89
|
+
else {
|
|
90
|
+
searchIndex++;
|
|
91
|
+
}
|
|
92
|
+
}
|
|
93
|
+
inSearch = setTimeout('searchItem()', 0);
|
|
94
|
+
}
|
|
95
|
+
|
|
96
|
+
function searchDone() {
|
|
97
|
+
highlight(true);
|
|
98
|
+
if ($('#full_list li:visible').size() === 0) {
|
|
99
|
+
$('#noresults').text('No results were found.').hide().fadeIn();
|
|
100
|
+
}
|
|
101
|
+
else {
|
|
102
|
+
$('#noresults').text('');
|
|
103
|
+
}
|
|
104
|
+
$('#content').removeClass('insearch');
|
|
105
|
+
clearTimeout(inSearch);
|
|
106
|
+
inSearch = null;
|
|
107
|
+
}
|
|
108
|
+
|
|
109
|
+
clicked = null;
|
|
110
|
+
function linkList() {
|
|
111
|
+
$('#full_list li, #full_list li a:last').click(function(evt) {
|
|
112
|
+
if ($(this).hasClass('toggle')) return true;
|
|
113
|
+
if (this.tagName.toLowerCase() == "li") {
|
|
114
|
+
var toggle = $(this).children('a.toggle');
|
|
115
|
+
if (toggle.size() > 0 && evt.pageX < toggle.offset().left) {
|
|
116
|
+
toggle.click();
|
|
117
|
+
return false;
|
|
118
|
+
}
|
|
119
|
+
}
|
|
120
|
+
if (clicked) clicked.removeClass('clicked');
|
|
121
|
+
var win = window.top.frames.main ? window.top.frames.main : window.parent;
|
|
122
|
+
if (this.tagName.toLowerCase() == "a") {
|
|
123
|
+
clicked = $(this).parent('li').addClass('clicked');
|
|
124
|
+
win.location = this.href;
|
|
125
|
+
}
|
|
126
|
+
else {
|
|
127
|
+
clicked = $(this).addClass('clicked');
|
|
128
|
+
win.location = $(this).find('a:last').attr('href');
|
|
129
|
+
}
|
|
130
|
+
return false;
|
|
131
|
+
});
|
|
132
|
+
}
|
|
133
|
+
|
|
134
|
+
function collapse() {
|
|
135
|
+
if (!$('#full_list').hasClass('class')) return;
|
|
136
|
+
$('#full_list.class a.toggle').click(function() {
|
|
137
|
+
$(this).parent().toggleClass('collapsed').next().toggleClass('collapsed');
|
|
138
|
+
highlight();
|
|
139
|
+
return false;
|
|
140
|
+
});
|
|
141
|
+
$('#full_list.class ul').each(function() {
|
|
142
|
+
$(this).addClass('collapsed').prev().addClass('collapsed');
|
|
143
|
+
});
|
|
144
|
+
$('#full_list.class').children().removeClass('collapsed');
|
|
145
|
+
highlight();
|
|
146
|
+
}
|
|
147
|
+
|
|
148
|
+
function highlight(no_padding) {
|
|
149
|
+
var n = 1;
|
|
150
|
+
$('#full_list li:visible').each(function() {
|
|
151
|
+
var next = n == 1 ? 2 : 1;
|
|
152
|
+
$(this).removeClass("r" + next).addClass("r" + n);
|
|
153
|
+
if (!no_padding && $('#full_list').hasClass('class')) {
|
|
154
|
+
$(this).css('padding-left', (10 + $(this).parents('ul').size() * 15) + 'px');
|
|
155
|
+
}
|
|
156
|
+
n = next;
|
|
157
|
+
});
|
|
158
|
+
}
|
|
159
|
+
|
|
160
|
+
function escapeShortcut() {
|
|
161
|
+
$(document).keydown(function(evt) {
|
|
162
|
+
if (evt.which == 27) {
|
|
163
|
+
$('#search_frame', window.top.document).slideUp(100);
|
|
164
|
+
$('#search a', window.top.document).removeClass('active inactive');
|
|
165
|
+
$(window.top).focus();
|
|
166
|
+
}
|
|
167
|
+
});
|
|
168
|
+
}
|
|
169
|
+
|
|
170
|
+
$(escapeShortcut);
|
|
171
|
+
$(fullListSearch);
|
|
172
|
+
$(linkList);
|
|
173
|
+
$(collapse);
|