term_utils 0.1.1 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/AUTHORS +1 -0
- data/CHANGELOG.md +19 -0
- data/COPYING +674 -0
- data/README.md +58 -0
- data/Rakefile +46 -0
- data/doc/TermUtils/FF/Config.html +606 -0
- data/doc/TermUtils/FF/Cursor/Context.html +409 -0
- data/doc/TermUtils/FF/Cursor.html +929 -0
- data/doc/TermUtils/FF/Query.html +749 -0
- data/doc/TermUtils/FF.html +128 -0
- data/doc/TermUtils/Tab/Column.html +1290 -0
- data/doc/TermUtils/Tab/Holder.html +674 -0
- data/doc/TermUtils/Tab/Printer.html +967 -0
- data/doc/TermUtils/Tab/Table.html +1414 -0
- data/doc/TermUtils/Tab.html +508 -0
- data/doc/TermUtils.html +136 -0
- data/doc/_index.html +217 -0
- data/doc/class_list.html +51 -0
- data/doc/css/common.css +1 -0
- data/doc/css/full_list.css +58 -0
- data/doc/css/style.css +496 -0
- data/doc/file.README.html +131 -0
- data/doc/file_list.html +56 -0
- data/doc/frames.html +17 -0
- data/doc/index.html +131 -0
- data/doc/js/app.js +303 -0
- data/doc/js/full_list.js +216 -0
- data/doc/js/jquery.js +4 -0
- data/doc/method_list.html +555 -0
- data/doc/top-level-namespace.html +110 -0
- data/lib/term_utils/ff/config.rb +43 -0
- data/lib/term_utils/ff/cursor.rb +153 -0
- data/lib/term_utils/ff/query.rb +66 -0
- data/lib/term_utils/ff.rb +18 -0
- data/lib/term_utils/tab.rb +22 -3
- data/lib/term_utils.rb +3 -0
- data/term_utils.gemspec +16 -0
- metadata +40 -4
data/doc/file_list.html
ADDED
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
5
|
+
<meta charset="utf-8" />
|
|
6
|
+
|
|
7
|
+
<link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" charset="utf-8" />
|
|
8
|
+
|
|
9
|
+
<link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
|
14
|
+
|
|
15
|
+
<script type="text/javascript" charset="utf-8" src="js/full_list.js"></script>
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
<title>File List</title>
|
|
19
|
+
<base id="base_target" target="_parent" />
|
|
20
|
+
</head>
|
|
21
|
+
<body>
|
|
22
|
+
<div id="content">
|
|
23
|
+
<div class="fixed_header">
|
|
24
|
+
<h1 id="full_list_header">File List</h1>
|
|
25
|
+
<div id="full_list_nav">
|
|
26
|
+
|
|
27
|
+
<span><a target="_self" href="class_list.html">
|
|
28
|
+
Classes
|
|
29
|
+
</a></span>
|
|
30
|
+
|
|
31
|
+
<span><a target="_self" href="method_list.html">
|
|
32
|
+
Methods
|
|
33
|
+
</a></span>
|
|
34
|
+
|
|
35
|
+
<span><a target="_self" href="file_list.html">
|
|
36
|
+
Files
|
|
37
|
+
</a></span>
|
|
38
|
+
|
|
39
|
+
</div>
|
|
40
|
+
|
|
41
|
+
<div id="search">Search: <input type="text" /></div>
|
|
42
|
+
</div>
|
|
43
|
+
|
|
44
|
+
<ul id="full_list" class="file">
|
|
45
|
+
|
|
46
|
+
|
|
47
|
+
<li id="object_README" class="odd">
|
|
48
|
+
<div class="item"><span class="object_link"><a href="index.html" title="README">README</a></span></div>
|
|
49
|
+
</li>
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
|
|
53
|
+
</ul>
|
|
54
|
+
</div>
|
|
55
|
+
</body>
|
|
56
|
+
</html>
|
data/doc/frames.html
ADDED
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<title>Documentation by YARD 0.9.20</title>
|
|
6
|
+
</head>
|
|
7
|
+
<script type="text/javascript" charset="utf-8">
|
|
8
|
+
var match = unescape(window.location.hash).match(/^#!(.+)/);
|
|
9
|
+
var name = match ? match[1] : 'index.html';
|
|
10
|
+
name = name.replace(/^(\w+):\/\//, '').replace(/^\/\//, '');
|
|
11
|
+
window.top.location = name;
|
|
12
|
+
</script>
|
|
13
|
+
<noscript>
|
|
14
|
+
<h1>Oops!</h1>
|
|
15
|
+
<h2>YARD requires JavaScript!</h2>
|
|
16
|
+
</noscript>
|
|
17
|
+
</html>
|
data/doc/index.html
ADDED
|
@@ -0,0 +1,131 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="UTF-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<title>
|
|
7
|
+
File: README
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.9.20
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
|
|
16
|
+
|
|
17
|
+
<script type="text/javascript" charset="utf-8">
|
|
18
|
+
pathId = "README";
|
|
19
|
+
relpath = '';
|
|
20
|
+
</script>
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
|
24
|
+
|
|
25
|
+
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
</head>
|
|
29
|
+
<body>
|
|
30
|
+
<div class="nav_wrap">
|
|
31
|
+
<iframe id="nav" src="class_list.html?1"></iframe>
|
|
32
|
+
<div id="resizer"></div>
|
|
33
|
+
</div>
|
|
34
|
+
|
|
35
|
+
<div id="main" tabindex="-1">
|
|
36
|
+
<div id="header">
|
|
37
|
+
<div id="menu">
|
|
38
|
+
|
|
39
|
+
<a href="_index.html">Index</a> »
|
|
40
|
+
<span class="title">File: README</span>
|
|
41
|
+
|
|
42
|
+
</div>
|
|
43
|
+
|
|
44
|
+
<div id="search">
|
|
45
|
+
|
|
46
|
+
<a class="full_list_link" id="class_list_link"
|
|
47
|
+
href="class_list.html">
|
|
48
|
+
|
|
49
|
+
<svg width="24" height="24">
|
|
50
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
|
51
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
|
52
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
|
53
|
+
</svg>
|
|
54
|
+
</a>
|
|
55
|
+
|
|
56
|
+
</div>
|
|
57
|
+
<div class="clear"></div>
|
|
58
|
+
</div>
|
|
59
|
+
|
|
60
|
+
<div id="content"><div id='filecontents'>
|
|
61
|
+
<h1 id="label-term_utils">term_utils</h1>
|
|
62
|
+
|
|
63
|
+
<p>Terminal utilities for Ruby.</p>
|
|
64
|
+
|
|
65
|
+
<h2 id="label-Purpose">Purpose</h2>
|
|
66
|
+
|
|
67
|
+
<p>Provides terminal utilities like table formatting.</p>
|
|
68
|
+
|
|
69
|
+
<h2 id="label-Content">Content</h2>
|
|
70
|
+
|
|
71
|
+
<h3 id="label-Table+formatting">Table formatting</h3>
|
|
72
|
+
|
|
73
|
+
<p>Take the following table:</p>
|
|
74
|
+
|
|
75
|
+
<pre class="code ruby"><code class="ruby"> id string8 string16
|
|
76
|
+
---- -------- ----------------
|
|
77
|
+
1 Fiat Lux Fiat Lux
|
|
78
|
+
2 Alea ... Alea jacta est
|
|
79
|
+
3 Audac... Audaces fortuna juvat
|
|
80
|
+
---- -------- ----------------
|
|
81
|
+
id string8 string16
|
|
82
|
+
</code></pre>
|
|
83
|
+
|
|
84
|
+
<p>You can produice it with the following code:</p>
|
|
85
|
+
|
|
86
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>term_utils/tab</span><span class='tstring_end'>'</span></span>
|
|
87
|
+
|
|
88
|
+
<span class='const'><span class='object_link'><a href="TermUtils.html" title="TermUtils (module)">TermUtils</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="TermUtils/Tab.html" title="TermUtils::Tab (module)">Tab</a></span></span><span class='period'>.</span><span class='id identifier rubyid_define_table'><span class='object_link'><a href="TermUtils/Tab.html#define_table-class_method" title="TermUtils::Tab.define_table (method)">define_table</a></span></span><span class='lparen'>(</span><span class='symbol'>:foo</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_t'>t</span><span class='op'>|</span>
|
|
89
|
+
<span class='id identifier rubyid_t'>t</span><span class='period'>.</span><span class='id identifier rubyid_define_column'>define_column</span> <span class='symbol'>:id</span><span class='comma'>,</span> <span class='symbol'>:width</span> <span class='op'>=></span> <span class='int'>4</span><span class='comma'>,</span> <span class='symbol'>:align</span> <span class='op'>=></span> <span class='symbol'>:right</span>
|
|
90
|
+
<span class='id identifier rubyid_t'>t</span><span class='period'>.</span><span class='id identifier rubyid_define_column'>define_column</span> <span class='symbol'>:string8</span><span class='comma'>,</span> <span class='symbol'>:fixed</span> <span class='op'>=></span> <span class='kw'>true</span><span class='comma'>,</span> <span class='symbol'>:ellipsis</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>...</span><span class='tstring_end'>"</span></span>
|
|
91
|
+
<span class='id identifier rubyid_t'>t</span><span class='period'>.</span><span class='id identifier rubyid_define_column'>define_column</span> <span class='symbol'>:string16</span><span class='comma'>,</span> <span class='symbol'>:width</span> <span class='op'>=></span> <span class='int'>16</span>
|
|
92
|
+
<span class='kw'>end</span>
|
|
93
|
+
|
|
94
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
|
|
95
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'><<</span> <span class='lbracket'>[</span><span class='int'>1</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Fiat Lux</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Fiat Lux</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span>
|
|
96
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'><<</span> <span class='lbracket'>[</span><span class='int'>2</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Alea jacta est</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Alea jacta est</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span>
|
|
97
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'><<</span> <span class='lbracket'>[</span><span class='int'>3</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Audaces fortuna juvat</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Audaces fortuna juvat</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span>
|
|
98
|
+
|
|
99
|
+
<span class='const'><span class='object_link'><a href="TermUtils.html" title="TermUtils (module)">TermUtils</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="TermUtils/Tab.html" title="TermUtils::Tab (module)">Tab</a></span></span><span class='period'>.</span><span class='id identifier rubyid_printer'><span class='object_link'><a href="TermUtils/Tab.html#printer-class_method" title="TermUtils::Tab.printer (method)">printer</a></span></span> <span class='symbol'>:foo</span><span class='comma'>,</span> <span class='gvar'>$stdout</span><span class='comma'>,</span> <span class='symbol'>:offset</span> <span class='op'>=></span> <span class='int'>2</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_tpr'>tpr</span><span class='op'>|</span>
|
|
100
|
+
<span class='id identifier rubyid_tpr'>tpr</span><span class='period'>.</span><span class='id identifier rubyid_line'>line</span>
|
|
101
|
+
<span class='id identifier rubyid_tpr'>tpr</span><span class='period'>.</span><span class='id identifier rubyid_header'>header</span>
|
|
102
|
+
<span class='id identifier rubyid_tpr'>tpr</span><span class='period'>.</span><span class='id identifier rubyid_separator'>separator</span>
|
|
103
|
+
<span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_d'>d</span><span class='op'>|</span>
|
|
104
|
+
<span class='id identifier rubyid_tpr'>tpr</span><span class='period'>.</span><span class='id identifier rubyid_data'>data</span> <span class='id identifier rubyid_d'>d</span>
|
|
105
|
+
<span class='kw'>end</span>
|
|
106
|
+
<span class='id identifier rubyid_tpr'>tpr</span><span class='period'>.</span><span class='id identifier rubyid_separator'>separator</span>
|
|
107
|
+
<span class='id identifier rubyid_tpr'>tpr</span><span class='period'>.</span><span class='id identifier rubyid_header'>header</span>
|
|
108
|
+
<span class='id identifier rubyid_tpr'>tpr</span><span class='period'>.</span><span class='id identifier rubyid_line'>line</span>
|
|
109
|
+
<span class='kw'>end</span>
|
|
110
|
+
</code></pre>
|
|
111
|
+
|
|
112
|
+
<h3 id="label-File+Finder">File Finder</h3>
|
|
113
|
+
|
|
114
|
+
<p>The File Finder module provides a way to query the filesystem.</p>
|
|
115
|
+
|
|
116
|
+
<p>See the samples.</p>
|
|
117
|
+
|
|
118
|
+
<h2 id="label-License">License</h2>
|
|
119
|
+
|
|
120
|
+
<p>GPL-3.0-only.</p>
|
|
121
|
+
</div></div>
|
|
122
|
+
|
|
123
|
+
<div id="footer">
|
|
124
|
+
Generated on Thu Oct 17 22:50:57 2019 by
|
|
125
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
126
|
+
0.9.20 (ruby-2.6.5).
|
|
127
|
+
</div>
|
|
128
|
+
|
|
129
|
+
</div>
|
|
130
|
+
</body>
|
|
131
|
+
</html>
|
data/doc/js/app.js
ADDED
|
@@ -0,0 +1,303 @@
|
|
|
1
|
+
(function() {
|
|
2
|
+
|
|
3
|
+
var localStorage = {}, sessionStorage = {};
|
|
4
|
+
try { localStorage = window.localStorage; } catch (e) { }
|
|
5
|
+
try { sessionStorage = window.sessionStorage; } catch (e) { }
|
|
6
|
+
|
|
7
|
+
function createSourceLinks() {
|
|
8
|
+
$('.method_details_list .source_code').
|
|
9
|
+
before("<span class='showSource'>[<a href='#' class='toggleSource'>View source</a>]</span>");
|
|
10
|
+
$('.toggleSource').toggle(function() {
|
|
11
|
+
$(this).parent().nextAll('.source_code').slideDown(100);
|
|
12
|
+
$(this).text("Hide source");
|
|
13
|
+
},
|
|
14
|
+
function() {
|
|
15
|
+
$(this).parent().nextAll('.source_code').slideUp(100);
|
|
16
|
+
$(this).text("View source");
|
|
17
|
+
});
|
|
18
|
+
}
|
|
19
|
+
|
|
20
|
+
function createDefineLinks() {
|
|
21
|
+
var tHeight = 0;
|
|
22
|
+
$('.defines').after(" <a href='#' class='toggleDefines'>more...</a>");
|
|
23
|
+
$('.toggleDefines').toggle(function() {
|
|
24
|
+
tHeight = $(this).parent().prev().height();
|
|
25
|
+
$(this).prev().css('display', 'inline');
|
|
26
|
+
$(this).parent().prev().height($(this).parent().height());
|
|
27
|
+
$(this).text("(less)");
|
|
28
|
+
},
|
|
29
|
+
function() {
|
|
30
|
+
$(this).prev().hide();
|
|
31
|
+
$(this).parent().prev().height(tHeight);
|
|
32
|
+
$(this).text("more...");
|
|
33
|
+
});
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
function createFullTreeLinks() {
|
|
37
|
+
var tHeight = 0;
|
|
38
|
+
$('.inheritanceTree').toggle(function() {
|
|
39
|
+
tHeight = $(this).parent().prev().height();
|
|
40
|
+
$(this).parent().toggleClass('showAll');
|
|
41
|
+
$(this).text("(hide)");
|
|
42
|
+
$(this).parent().prev().height($(this).parent().height());
|
|
43
|
+
},
|
|
44
|
+
function() {
|
|
45
|
+
$(this).parent().toggleClass('showAll');
|
|
46
|
+
$(this).parent().prev().height(tHeight);
|
|
47
|
+
$(this).text("show all");
|
|
48
|
+
});
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
function searchFrameButtons() {
|
|
52
|
+
$('.full_list_link').click(function() {
|
|
53
|
+
toggleSearchFrame(this, $(this).attr('href'));
|
|
54
|
+
return false;
|
|
55
|
+
});
|
|
56
|
+
window.addEventListener('message', function(e) {
|
|
57
|
+
if (e.data === 'navEscape') {
|
|
58
|
+
$('#nav').slideUp(100);
|
|
59
|
+
$('#search a').removeClass('active inactive');
|
|
60
|
+
$(window).focus();
|
|
61
|
+
}
|
|
62
|
+
});
|
|
63
|
+
|
|
64
|
+
$(window).resize(function() {
|
|
65
|
+
if ($('#search:visible').length === 0) {
|
|
66
|
+
$('#nav').removeAttr('style');
|
|
67
|
+
$('#search a').removeClass('active inactive');
|
|
68
|
+
$(window).focus();
|
|
69
|
+
}
|
|
70
|
+
});
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
function toggleSearchFrame(id, link) {
|
|
74
|
+
var frame = $('#nav');
|
|
75
|
+
$('#search a').removeClass('active').addClass('inactive');
|
|
76
|
+
if (frame.attr('src') === link && frame.css('display') !== "none") {
|
|
77
|
+
frame.slideUp(100);
|
|
78
|
+
$('#search a').removeClass('active inactive');
|
|
79
|
+
}
|
|
80
|
+
else {
|
|
81
|
+
$(id).addClass('active').removeClass('inactive');
|
|
82
|
+
if (frame.attr('src') !== link) frame.attr('src', link);
|
|
83
|
+
frame.slideDown(100);
|
|
84
|
+
}
|
|
85
|
+
}
|
|
86
|
+
|
|
87
|
+
function linkSummaries() {
|
|
88
|
+
$('.summary_signature').click(function() {
|
|
89
|
+
document.location = $(this).find('a').attr('href');
|
|
90
|
+
});
|
|
91
|
+
}
|
|
92
|
+
|
|
93
|
+
function summaryToggle() {
|
|
94
|
+
$('.summary_toggle').click(function(e) {
|
|
95
|
+
e.preventDefault();
|
|
96
|
+
localStorage.summaryCollapsed = $(this).text();
|
|
97
|
+
$('.summary_toggle').each(function() {
|
|
98
|
+
$(this).text($(this).text() == "collapse" ? "expand" : "collapse");
|
|
99
|
+
var next = $(this).parent().parent().nextAll('ul.summary').first();
|
|
100
|
+
if (next.hasClass('compact')) {
|
|
101
|
+
next.toggle();
|
|
102
|
+
next.nextAll('ul.summary').first().toggle();
|
|
103
|
+
}
|
|
104
|
+
else if (next.hasClass('summary')) {
|
|
105
|
+
var list = $('<ul class="summary compact" />');
|
|
106
|
+
list.html(next.html());
|
|
107
|
+
list.find('.summary_desc, .note').remove();
|
|
108
|
+
list.find('a').each(function() {
|
|
109
|
+
$(this).html($(this).find('strong').html());
|
|
110
|
+
$(this).parent().html($(this)[0].outerHTML);
|
|
111
|
+
});
|
|
112
|
+
next.before(list);
|
|
113
|
+
next.toggle();
|
|
114
|
+
}
|
|
115
|
+
});
|
|
116
|
+
return false;
|
|
117
|
+
});
|
|
118
|
+
if (localStorage.summaryCollapsed == "collapse") {
|
|
119
|
+
$('.summary_toggle').first().click();
|
|
120
|
+
} else { localStorage.summaryCollapsed = "expand"; }
|
|
121
|
+
}
|
|
122
|
+
|
|
123
|
+
function constantSummaryToggle() {
|
|
124
|
+
$('.constants_summary_toggle').click(function(e) {
|
|
125
|
+
e.preventDefault();
|
|
126
|
+
localStorage.summaryCollapsed = $(this).text();
|
|
127
|
+
$('.constants_summary_toggle').each(function() {
|
|
128
|
+
$(this).text($(this).text() == "collapse" ? "expand" : "collapse");
|
|
129
|
+
var next = $(this).parent().parent().nextAll('dl.constants').first();
|
|
130
|
+
if (next.hasClass('compact')) {
|
|
131
|
+
next.toggle();
|
|
132
|
+
next.nextAll('dl.constants').first().toggle();
|
|
133
|
+
}
|
|
134
|
+
else if (next.hasClass('constants')) {
|
|
135
|
+
var list = $('<dl class="constants compact" />');
|
|
136
|
+
list.html(next.html());
|
|
137
|
+
list.find('dt').each(function() {
|
|
138
|
+
$(this).addClass('summary_signature');
|
|
139
|
+
$(this).text( $(this).text().split('=')[0]);
|
|
140
|
+
if ($(this).has(".deprecated").length) {
|
|
141
|
+
$(this).addClass('deprecated');
|
|
142
|
+
};
|
|
143
|
+
});
|
|
144
|
+
// Add the value of the constant as "Tooltip" to the summary object
|
|
145
|
+
list.find('pre.code').each(function() {
|
|
146
|
+
console.log($(this).parent());
|
|
147
|
+
var dt_element = $(this).parent().prev();
|
|
148
|
+
var tooltip = $(this).text();
|
|
149
|
+
if (dt_element.hasClass("deprecated")) {
|
|
150
|
+
tooltip = 'Deprecated. ' + tooltip;
|
|
151
|
+
};
|
|
152
|
+
dt_element.attr('title', tooltip);
|
|
153
|
+
});
|
|
154
|
+
list.find('.docstring, .tags, dd').remove();
|
|
155
|
+
next.before(list);
|
|
156
|
+
next.toggle();
|
|
157
|
+
}
|
|
158
|
+
});
|
|
159
|
+
return false;
|
|
160
|
+
});
|
|
161
|
+
if (localStorage.summaryCollapsed == "collapse") {
|
|
162
|
+
$('.constants_summary_toggle').first().click();
|
|
163
|
+
} else { localStorage.summaryCollapsed = "expand"; }
|
|
164
|
+
}
|
|
165
|
+
|
|
166
|
+
function generateTOC() {
|
|
167
|
+
if ($('#filecontents').length === 0) return;
|
|
168
|
+
var _toc = $('<ol class="top"></ol>');
|
|
169
|
+
var show = false;
|
|
170
|
+
var toc = _toc;
|
|
171
|
+
var counter = 0;
|
|
172
|
+
var tags = ['h2', 'h3', 'h4', 'h5', 'h6'];
|
|
173
|
+
var i;
|
|
174
|
+
if ($('#filecontents h1').length > 1) tags.unshift('h1');
|
|
175
|
+
for (i = 0; i < tags.length; i++) { tags[i] = '#filecontents ' + tags[i]; }
|
|
176
|
+
var lastTag = parseInt(tags[0][1], 10);
|
|
177
|
+
$(tags.join(', ')).each(function() {
|
|
178
|
+
if ($(this).parents('.method_details .docstring').length != 0) return;
|
|
179
|
+
if (this.id == "filecontents") return;
|
|
180
|
+
show = true;
|
|
181
|
+
var thisTag = parseInt(this.tagName[1], 10);
|
|
182
|
+
if (this.id.length === 0) {
|
|
183
|
+
var proposedId = $(this).attr('toc-id');
|
|
184
|
+
if (typeof(proposedId) != "undefined") this.id = proposedId;
|
|
185
|
+
else {
|
|
186
|
+
var proposedId = $(this).text().replace(/[^a-z0-9-]/ig, '_');
|
|
187
|
+
if ($('#' + proposedId).length > 0) { proposedId += counter; counter++; }
|
|
188
|
+
this.id = proposedId;
|
|
189
|
+
}
|
|
190
|
+
}
|
|
191
|
+
if (thisTag > lastTag) {
|
|
192
|
+
for (i = 0; i < thisTag - lastTag; i++) {
|
|
193
|
+
var tmp = $('<ol/>'); toc.append(tmp); toc = tmp;
|
|
194
|
+
}
|
|
195
|
+
}
|
|
196
|
+
if (thisTag < lastTag) {
|
|
197
|
+
for (i = 0; i < lastTag - thisTag; i++) toc = toc.parent();
|
|
198
|
+
}
|
|
199
|
+
var title = $(this).attr('toc-title');
|
|
200
|
+
if (typeof(title) == "undefined") title = $(this).text();
|
|
201
|
+
toc.append('<li><a href="#' + this.id + '">' + title + '</a></li>');
|
|
202
|
+
lastTag = thisTag;
|
|
203
|
+
});
|
|
204
|
+
if (!show) return;
|
|
205
|
+
html = '<div id="toc"><p class="title hide_toc"><a href="#"><strong>Table of Contents</strong></a></p></div>';
|
|
206
|
+
$('#content').prepend(html);
|
|
207
|
+
$('#toc').append(_toc);
|
|
208
|
+
$('#toc .hide_toc').toggle(function() {
|
|
209
|
+
$('#toc .top').slideUp('fast');
|
|
210
|
+
$('#toc').toggleClass('hidden');
|
|
211
|
+
$('#toc .title small').toggle();
|
|
212
|
+
}, function() {
|
|
213
|
+
$('#toc .top').slideDown('fast');
|
|
214
|
+
$('#toc').toggleClass('hidden');
|
|
215
|
+
$('#toc .title small').toggle();
|
|
216
|
+
});
|
|
217
|
+
}
|
|
218
|
+
|
|
219
|
+
function navResizeFn(e) {
|
|
220
|
+
if (e.which !== 1) {
|
|
221
|
+
navResizeFnStop();
|
|
222
|
+
return;
|
|
223
|
+
}
|
|
224
|
+
|
|
225
|
+
sessionStorage.navWidth = e.pageX.toString();
|
|
226
|
+
$('.nav_wrap').css('width', e.pageX);
|
|
227
|
+
$('.nav_wrap').css('-ms-flex', 'inherit');
|
|
228
|
+
}
|
|
229
|
+
|
|
230
|
+
function navResizeFnStop() {
|
|
231
|
+
$(window).unbind('mousemove', navResizeFn);
|
|
232
|
+
window.removeEventListener('message', navMessageFn, false);
|
|
233
|
+
}
|
|
234
|
+
|
|
235
|
+
function navMessageFn(e) {
|
|
236
|
+
if (e.data.action === 'mousemove') navResizeFn(e.data.event);
|
|
237
|
+
if (e.data.action === 'mouseup') navResizeFnStop();
|
|
238
|
+
}
|
|
239
|
+
|
|
240
|
+
function navResizer() {
|
|
241
|
+
$('#resizer').mousedown(function(e) {
|
|
242
|
+
e.preventDefault();
|
|
243
|
+
$(window).mousemove(navResizeFn);
|
|
244
|
+
window.addEventListener('message', navMessageFn, false);
|
|
245
|
+
});
|
|
246
|
+
$(window).mouseup(navResizeFnStop);
|
|
247
|
+
|
|
248
|
+
if (sessionStorage.navWidth) {
|
|
249
|
+
navResizeFn({which: 1, pageX: parseInt(sessionStorage.navWidth, 10)});
|
|
250
|
+
}
|
|
251
|
+
}
|
|
252
|
+
|
|
253
|
+
function navExpander() {
|
|
254
|
+
var done = false, timer = setTimeout(postMessage, 500);
|
|
255
|
+
function postMessage() {
|
|
256
|
+
if (done) return;
|
|
257
|
+
clearTimeout(timer);
|
|
258
|
+
var opts = { action: 'expand', path: pathId };
|
|
259
|
+
document.getElementById('nav').contentWindow.postMessage(opts, '*');
|
|
260
|
+
done = true;
|
|
261
|
+
}
|
|
262
|
+
|
|
263
|
+
window.addEventListener('message', function(event) {
|
|
264
|
+
if (event.data === 'navReady') postMessage();
|
|
265
|
+
return false;
|
|
266
|
+
}, false);
|
|
267
|
+
}
|
|
268
|
+
|
|
269
|
+
function mainFocus() {
|
|
270
|
+
var hash = window.location.hash;
|
|
271
|
+
if (hash !== '' && $(hash)[0]) {
|
|
272
|
+
$(hash)[0].scrollIntoView();
|
|
273
|
+
}
|
|
274
|
+
|
|
275
|
+
setTimeout(function() { $('#main').focus(); }, 10);
|
|
276
|
+
}
|
|
277
|
+
|
|
278
|
+
function navigationChange() {
|
|
279
|
+
// This works around the broken anchor navigation with the YARD template.
|
|
280
|
+
window.onpopstate = function() {
|
|
281
|
+
var hash = window.location.hash;
|
|
282
|
+
if (hash !== '' && $(hash)[0]) {
|
|
283
|
+
$(hash)[0].scrollIntoView();
|
|
284
|
+
}
|
|
285
|
+
};
|
|
286
|
+
}
|
|
287
|
+
|
|
288
|
+
$(document).ready(function() {
|
|
289
|
+
navResizer();
|
|
290
|
+
navExpander();
|
|
291
|
+
createSourceLinks();
|
|
292
|
+
createDefineLinks();
|
|
293
|
+
createFullTreeLinks();
|
|
294
|
+
searchFrameButtons();
|
|
295
|
+
linkSummaries();
|
|
296
|
+
summaryToggle();
|
|
297
|
+
constantSummaryToggle();
|
|
298
|
+
generateTOC();
|
|
299
|
+
mainFocus();
|
|
300
|
+
navigationChange();
|
|
301
|
+
});
|
|
302
|
+
|
|
303
|
+
})();
|