ionian 0.6.3 → 0.6.4

Sign up to get free protection for your applications and to get access to all the features.
Files changed (67) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +63 -0
  3. data/doc/Ionian/Extension/IO.html +1062 -599
  4. data/doc/Ionian/Extension/Socket.html +2140 -1314
  5. data/doc/Ionian/Extension.html +98 -70
  6. data/doc/Ionian/Server.html +577 -345
  7. data/doc/Ionian/Socket.html +1100 -612
  8. data/doc/Ionian.html +100 -70
  9. data/doc/_index.html +164 -0
  10. data/doc/class_list.html +54 -0
  11. data/doc/css/common.css +1 -0
  12. data/doc/css/full_list.css +57 -0
  13. data/doc/css/style.css +338 -0
  14. data/doc/file.README.html +133 -0
  15. data/doc/file.license.html +73 -0
  16. data/doc/file_list.html +59 -0
  17. data/doc/frames.html +26 -0
  18. data/doc/index.html +111 -71
  19. data/doc/js/app.js +219 -0
  20. data/doc/js/full_list.js +178 -0
  21. data/doc/js/jquery.js +4 -18
  22. data/doc/method_list.html +419 -0
  23. data/doc/top-level-namespace.html +112 -0
  24. data/lib/ionian/extension/io.rb +4 -2
  25. data/lib/ionian/socket.rb +1 -1
  26. data/license.txt +2 -0
  27. metadata +28 -54
  28. data/doc/created.rid +0 -6
  29. data/doc/fonts/Lato-Light.ttf +0 -0
  30. data/doc/fonts/Lato-LightItalic.ttf +0 -0
  31. data/doc/fonts/Lato-Regular.ttf +0 -0
  32. data/doc/fonts/Lato-RegularItalic.ttf +0 -0
  33. data/doc/fonts/SourceCodePro-Bold.ttf +0 -0
  34. data/doc/fonts/SourceCodePro-Regular.ttf +0 -0
  35. data/doc/fonts.css +0 -167
  36. data/doc/images/add.png +0 -0
  37. data/doc/images/arrow_up.png +0 -0
  38. data/doc/images/brick.png +0 -0
  39. data/doc/images/brick_link.png +0 -0
  40. data/doc/images/bug.png +0 -0
  41. data/doc/images/bullet_black.png +0 -0
  42. data/doc/images/bullet_toggle_minus.png +0 -0
  43. data/doc/images/bullet_toggle_plus.png +0 -0
  44. data/doc/images/date.png +0 -0
  45. data/doc/images/delete.png +0 -0
  46. data/doc/images/find.png +0 -0
  47. data/doc/images/loadingAnimation.gif +0 -0
  48. data/doc/images/macFFBgHack.png +0 -0
  49. data/doc/images/package.png +0 -0
  50. data/doc/images/page_green.png +0 -0
  51. data/doc/images/page_white_text.png +0 -0
  52. data/doc/images/page_white_width.png +0 -0
  53. data/doc/images/plugin.png +0 -0
  54. data/doc/images/ruby.png +0 -0
  55. data/doc/images/tag_blue.png +0 -0
  56. data/doc/images/tag_green.png +0 -0
  57. data/doc/images/transparent.png +0 -0
  58. data/doc/images/wrench.png +0 -0
  59. data/doc/images/wrench_orange.png +0 -0
  60. data/doc/images/zoom.png +0 -0
  61. data/doc/js/darkfish.js +0 -140
  62. data/doc/js/navigation.js +0 -142
  63. data/doc/js/search.js +0 -109
  64. data/doc/js/search_index.js +0 -1
  65. data/doc/js/searcher.js +0 -228
  66. data/doc/rdoc.css +0 -580
  67. data/doc/table_of_contents.html +0 -402
data/doc/index.html CHANGED
@@ -1,93 +1,133 @@
1
- <!DOCTYPE html>
2
-
3
- <html>
4
- <head>
5
- <meta charset="UTF-8">
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
+ &mdash; Documentation by YARD 0.8.7.3
10
+
11
+ </title>
6
12
 
7
- <title>RDoc Documentation</title>
13
+ <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
8
14
 
9
- <link href="./fonts.css" rel="stylesheet">
10
- <link href="./rdoc.css" rel="stylesheet">
15
+ <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
11
16
 
12
- <script type="text/javascript">
13
- var rdoc_rel_prefix = "./";
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);
14
21
  </script>
15
22
 
16
- <script src="./js/jquery.js"></script>
17
- <script src="./js/navigation.js"></script>
18
- <script src="./js/search_index.js"></script>
19
- <script src="./js/search.js"></script>
20
- <script src="./js/searcher.js"></script>
21
- <script src="./js/darkfish.js"></script>
22
-
23
-
24
- <body id="top" role="document" class="file">
25
- <nav role="navigation">
26
- <div id="project-navigation">
27
- <div id="home-section" role="region" title="Quick navigation" class="nav-section">
28
- <h2>
29
- <a href="./index.html" rel="home">Home</a>
30
- </h2>
31
-
32
- <div id="table-of-contents-navigation">
33
- <a href="./table_of_contents.html#pages">Pages</a>
34
- <a href="./table_of_contents.html#classes">Classes</a>
35
- <a href="./table_of_contents.html#methods">Methods</a>
36
- </div>
37
- </div>
38
-
39
-
40
- <div id="search-section" role="search" class="project-section initially-hidden">
41
- <form action="#" method="get" accept-charset="utf-8">
42
- <div id="search-field-wrapper">
43
- <input id="search-field" role="combobox" aria-label="Search"
44
- aria-autocomplete="list" aria-controls="search-results"
45
- type="text" name="search" placeholder="Search" spellcheck="false"
46
- title="Type to search, Up and Down to navigate, Enter to load">
47
- </div>
48
23
 
49
- <ul id="search-results" aria-label="Search Results"
50
- aria-busy="false" aria-expanded="false"
51
- aria-atomic="false" class="initially-hidden"></ul>
52
- </form>
53
- </div>
24
+ <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
54
25
 
55
- </div>
26
+ <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
56
27
 
57
- <div id="project-metadata">
58
-
59
- <div id="classindex-section" class="nav-section">
60
- <h3>Class and Module Index</h3>
61
28
 
62
- <ul class="link-list">
29
+ </head>
30
+ <body>
31
+ <div id="header">
32
+ <div id="menu">
63
33
 
64
- <li><a href="./Ionian.html">Ionian</a>
34
+ <a href="_index.html">Index</a> &raquo;
35
+ <span class="title">File: README</span>
65
36
 
66
- <li><a href="./Ionian/Extension.html">Ionian::Extension</a>
67
-
68
- <li><a href="./Ionian/Extension/IO.html">Ionian::Extension::IO</a>
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">
69
42
 
70
- <li><a href="./Ionian/Extension/Socket.html">Ionian::Extension::Socket</a>
43
+ <a class="full_list_link" id="class_list_link"
44
+ href="class_list.html">
45
+ Class List
46
+ </a>
71
47
 
72
- <li><a href="./Ionian/Server.html">Ionian::Server</a>
48
+ <a class="full_list_link" id="method_list_link"
49
+ href="method_list.html">
50
+ Method List
51
+ </a>
73
52
 
74
- <li><a href="./Ionian/Socket.html">Ionian::Socket</a>
53
+ <a class="full_list_link" id="file_list_link"
54
+ href="file_list.html">
55
+ File List
56
+ </a>
75
57
 
76
- </ul>
77
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>Ionian</h1>
78
65
 
79
- </div>
80
- </nav>
66
+ <p><a href="http://badge.fury.io/rb/ionian"><img src="https://badge.fury.io/rb/ionian.png" alt="Gem Version" /></a></p>
81
67
 
82
- <main role="main">
83
- <p>This is the API documentation for RDoc Documentation.
84
- </main>
68
+ <p>A Ruby library to simplify interaction with IO streams. This includes network sockets, file sockets, and serial streams like the console and RS232. Features regular expression matching and notification of received data.</p>
85
69
 
70
+ <h2>Supported Ruby Versions</h2>
86
71
 
72
+ <ul>
73
+ <li>MRI >= 2.0.0</li>
74
+ </ul>
87
75
 
88
- <footer id="validator-badges" role="contentinfo">
89
- <p><a href="http://validator.w3.org/check/referer">Validate</a>
90
- <p>Generated by <a href="http://rdoc.rubyforge.org">RDoc</a> 4.1.1.
91
- <p>Based on <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
92
- </footer>
93
76
 
77
+ <h2>Installation</h2>
78
+
79
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='id identifier rubyid_install'>install</span> <span class='id identifier rubyid_ionian'>ionian</span>
80
+ </code></pre>
81
+
82
+ <h2>Code Examples</h2>
83
+
84
+ <h3>Creating A Socket</h3>
85
+
86
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_socket'>socket</span> <span class='op'>=</span> <span class='const'>Ionian</span><span class='op'>::</span><span class='const'>Socket</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='label'>host:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>127.0.0.1</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='label'>port:</span> <span class='int'>23</span>
87
+ </code></pre>
88
+
89
+ <h3>Sending And Receiving Data</h3>
90
+
91
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_socket'>socket</span> <span class='op'>=</span> <span class='const'>Ionian</span><span class='op'>::</span><span class='const'>Socket</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='label'>host:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>google.com</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='label'>port:</span> <span class='int'>80</span>
92
+ <span class='id identifier rubyid_socket'>socket</span><span class='period'>.</span><span class='id identifier rubyid_write'>write</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>GET / HTTP/1.1\r\n\r\n</span><span class='tstring_end'>&quot;</span></span>
93
+ <span class='id identifier rubyid_socket'>socket</span><span class='period'>.</span><span class='id identifier rubyid_read_match'>read_match</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id identifier rubyid_match'>match</span><span class='op'>|</span> <span class='id identifier rubyid_p'>p</span> <span class='id identifier rubyid_match'>match</span><span class='semicolon'>;</span> <span class='id identifier rubyid_puts'>puts</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span> <span class='rbrace'>}</span>
94
+ </code></pre>
95
+
96
+ <h3>Match Expressions And Named Captures</h3>
97
+
98
+ <pre class="code ruby"><code class="ruby"><span class='comment'># A simple IRC client.
99
+ </span>
100
+ <span class='id identifier rubyid_socket'>socket</span> <span class='op'>=</span> <span class='const'>Ionian</span><span class='op'>::</span><span class='const'>Socket</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> \
101
+ <span class='label'>host:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>chat.freenode.net</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
102
+ <span class='label'>port:</span> <span class='int'>6667</span><span class='comma'>,</span>
103
+ <span class='comment'># Break up the matches into named captures so it&#39;s easier
104
+ </span> <span class='comment'># to sort through the server&#39;s responses.
105
+ </span> <span class='label'>expression:</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>:(?&lt;server&gt;.*?)\s*:(?&lt;msg&gt;.*?)[\r\n]+</span><span class='regexp_end'>/</span></span>
106
+
107
+ <span class='comment'># Log on to IRC and send a message.
108
+ </span><span class='id identifier rubyid_socket'>socket</span><span class='period'>.</span><span class='id identifier rubyid_write'>write</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>NICK ionian-demo\r\nUSER ionian-demo ionian-demo chat.freenode.net :ionian-demo</span><span class='tstring_end'>&quot;</span></span>
109
+ <span class='id identifier rubyid_socket'>socket</span><span class='period'>.</span><span class='id identifier rubyid_write'>write</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>PROTOCL NAMESX\r\n</span><span class='tstring_end'>&quot;</span></span>
110
+ <span class='id identifier rubyid_socket'>socket</span><span class='period'>.</span><span class='id identifier rubyid_write'>write</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>JOIN #ionian-demo\r\n</span><span class='tstring_end'>&quot;</span></span>
111
+ <span class='id identifier rubyid_socket'>socket</span><span class='period'>.</span><span class='id identifier rubyid_write'>write</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>PRIVMSG #ionian-demo :this is a test\r\n</span><span class='tstring_end'>&quot;</span></span>
112
+
113
+
114
+ <span class='id identifier rubyid_loop'>loop</span> <span class='kw'>do</span>
115
+ <span class='id identifier rubyid_socket'>socket</span><span class='period'>.</span><span class='id identifier rubyid_read_match'>read_match</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_match'>match</span><span class='op'>|</span>
116
+ <span class='comment'># Print the body of the server&#39;s responses.
117
+ </span> <span class='id identifier rubyid_puts'>puts</span> <span class='id identifier rubyid_match'>match</span><span class='period'>.</span><span class='id identifier rubyid_msg'>msg</span>
118
+
119
+ <span class='comment'># Exit when the server has caught up.
120
+ </span> <span class='id identifier rubyid_exit'>exit</span> <span class='kw'>if</span> <span class='id identifier rubyid_match'>match</span><span class='period'>.</span><span class='id identifier rubyid_msg'>msg</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>End of /NAMES list.</span><span class='tstring_end'>&#39;</span></span>
121
+ <span class='kw'>end</span>
122
+ <span class='kw'>end</span>
123
+ </code></pre>
124
+ </div></div>
125
+
126
+ <div id="footer">
127
+ Generated on Sat Mar 15 21:04:53 2014 by
128
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
129
+ 0.8.7.3 (ruby-2.1.1).
130
+ </div>
131
+
132
+ </body>
133
+ </html>
data/doc/js/app.js ADDED
@@ -0,0 +1,219 @@
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
+ try {
82
+ window.top.document.title = $('html head title').text();
83
+ } catch(error) {
84
+ // some browsers will not allow this when serving from file://
85
+ // but we don't want to stop the world.
86
+ }
87
+ }
88
+ else {
89
+ $('#menu .noframes a').text('frames').attr('href', framesUrl);
90
+ }
91
+ }
92
+
93
+ function keyboardShortcuts() {
94
+ if (window.top.frames.main) return;
95
+ $(document).keypress(function(evt) {
96
+ if (evt.altKey || evt.ctrlKey || evt.metaKey || evt.shiftKey) return;
97
+ if (typeof evt.target !== "undefined" &&
98
+ (evt.target.nodeName == "INPUT" ||
99
+ evt.target.nodeName == "TEXTAREA")) return;
100
+ switch (evt.charCode) {
101
+ case 67: case 99: $('#class_list_link').click(); break; // 'c'
102
+ case 77: case 109: $('#method_list_link').click(); break; // 'm'
103
+ case 70: case 102: $('#file_list_link').click(); break; // 'f'
104
+ default: break;
105
+ }
106
+ });
107
+ }
108
+
109
+ function summaryToggle() {
110
+ $('.summary_toggle').click(function() {
111
+ if (localStorage) {
112
+ localStorage.summaryCollapsed = $(this).text();
113
+ }
114
+ $('.summary_toggle').each(function() {
115
+ $(this).text($(this).text() == "collapse" ? "expand" : "collapse");
116
+ var next = $(this).parent().parent().nextAll('ul.summary').first();
117
+ if (next.hasClass('compact')) {
118
+ next.toggle();
119
+ next.nextAll('ul.summary').first().toggle();
120
+ }
121
+ else if (next.hasClass('summary')) {
122
+ var list = $('<ul class="summary compact" />');
123
+ list.html(next.html());
124
+ list.find('.summary_desc, .note').remove();
125
+ list.find('a').each(function() {
126
+ $(this).html($(this).find('strong').html());
127
+ $(this).parent().html($(this)[0].outerHTML);
128
+ });
129
+ next.before(list);
130
+ next.toggle();
131
+ }
132
+ });
133
+ return false;
134
+ });
135
+ if (localStorage) {
136
+ if (localStorage.summaryCollapsed == "collapse") {
137
+ $('.summary_toggle').first().click();
138
+ }
139
+ else localStorage.summaryCollapsed = "expand";
140
+ }
141
+ }
142
+
143
+ function fixOutsideWorldLinks() {
144
+ $('a').each(function() {
145
+ if (window.location.host != this.host) this.target = '_parent';
146
+ });
147
+ }
148
+
149
+ function generateTOC() {
150
+ if ($('#filecontents').length === 0) return;
151
+ var _toc = $('<ol class="top"></ol>');
152
+ var show = false;
153
+ var toc = _toc;
154
+ var counter = 0;
155
+ var tags = ['h2', 'h3', 'h4', 'h5', 'h6'];
156
+ var i;
157
+ if ($('#filecontents h1').length > 1) tags.unshift('h1');
158
+ for (i = 0; i < tags.length; i++) { tags[i] = '#filecontents ' + tags[i]; }
159
+ var lastTag = parseInt(tags[0][1], 10);
160
+ $(tags.join(', ')).each(function() {
161
+ if ($(this).parents('.method_details .docstring').length != 0) return;
162
+ if (this.id == "filecontents") return;
163
+ show = true;
164
+ var thisTag = parseInt(this.tagName[1], 10);
165
+ if (this.id.length === 0) {
166
+ var proposedId = $(this).attr('toc-id');
167
+ if (typeof(proposedId) != "undefined") this.id = proposedId;
168
+ else {
169
+ var proposedId = $(this).text().replace(/[^a-z0-9-]/ig, '_');
170
+ if ($('#' + proposedId).length > 0) { proposedId += counter; counter++; }
171
+ this.id = proposedId;
172
+ }
173
+ }
174
+ if (thisTag > lastTag) {
175
+ for (i = 0; i < thisTag - lastTag; i++) {
176
+ var tmp = $('<ol/>'); toc.append(tmp); toc = tmp;
177
+ }
178
+ }
179
+ if (thisTag < lastTag) {
180
+ for (i = 0; i < lastTag - thisTag; i++) toc = toc.parent();
181
+ }
182
+ var title = $(this).attr('toc-title');
183
+ if (typeof(title) == "undefined") title = $(this).text();
184
+ toc.append('<li><a href="#' + this.id + '">' + title + '</a></li>');
185
+ lastTag = thisTag;
186
+ });
187
+ if (!show) return;
188
+ 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>';
189
+ $('#content').prepend(html);
190
+ $('#toc').append(_toc);
191
+ $('#toc .hide_toc').toggle(function() {
192
+ $('#toc .top').slideUp('fast');
193
+ $('#toc').toggleClass('hidden');
194
+ $('#toc .title small').toggle();
195
+ }, function() {
196
+ $('#toc .top').slideDown('fast');
197
+ $('#toc').toggleClass('hidden');
198
+ $('#toc .title small').toggle();
199
+ });
200
+ $('#toc .float_toc').toggle(function() {
201
+ $(this).text('float');
202
+ $('#toc').toggleClass('nofloat');
203
+ }, function() {
204
+ $(this).text('left');
205
+ $('#toc').toggleClass('nofloat');
206
+ });
207
+ }
208
+
209
+ $(framesInit);
210
+ $(createSourceLinks);
211
+ $(createDefineLinks);
212
+ $(createFullTreeLinks);
213
+ $(fixBoxInfoHeights);
214
+ $(searchFrameLinks);
215
+ $(linkSummaries);
216
+ $(keyboardShortcuts);
217
+ $(summaryToggle);
218
+ $(fixOutsideWorldLinks);
219
+ $(generateTOC);
@@ -0,0 +1,178 @@
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
+ if (link.length === 0) return;
21
+ var fullName = link.attr('title').split(' ')[0];
22
+ searchCache.push({name:link.text(), fullName:fullName, node:$(this), link:link});
23
+ });
24
+
25
+ $('#search input').keyup(function(event) {
26
+ if ((event.keyCode > ignoreKeyCodeMin && event.keyCode < ignoreKeyCodeMax)
27
+ || event.keyCode == commandKey)
28
+ return;
29
+ searchString = this.value;
30
+ caseSensitiveMatch = searchString.match(/[A-Z]/) != null;
31
+ regexSearchString = RegExp.escape(searchString);
32
+ if (caseSensitiveMatch) {
33
+ regexSearchString += "|" +
34
+ $.map(searchString.split(''), function(e) { return RegExp.escape(e); }).
35
+ join('.+?');
36
+ }
37
+ if (searchString === "") {
38
+ clearTimeout(inSearch);
39
+ inSearch = null;
40
+ $('ul .search_uncollapsed').removeClass('search_uncollapsed');
41
+ $('#full_list, #content').removeClass('insearch');
42
+ $('#full_list li').removeClass('found').each(function() {
43
+
44
+ var link = $(this).find('.object_link a');
45
+ if (link.length > 0) link.text(link.text());
46
+ });
47
+ if (clicked) {
48
+ clicked.parents('ul').each(function() {
49
+ $(this).removeClass('collapsed').prev().removeClass('collapsed');
50
+ });
51
+ }
52
+ highlight();
53
+ }
54
+ else {
55
+ if (inSearch) clearTimeout(inSearch);
56
+ searchIndex = 0;
57
+ lastRowClass = '';
58
+ $('#full_list, #content').addClass('insearch');
59
+ $('#noresults').text('');
60
+ searchItem();
61
+ }
62
+ });
63
+
64
+ $('#search input').focus();
65
+ $('#full_list').after("<div id='noresults'></div>");
66
+ }
67
+
68
+ var lastRowClass = '';
69
+ function searchItem() {
70
+ for (var i = 0; i < searchCache.length / 50; i++) {
71
+ var item = searchCache[searchIndex];
72
+ var searchName = (searchString.indexOf('::') != -1 ? item.fullName : item.name);
73
+ var matchString = regexSearchString;
74
+ var matchRegexp = new RegExp(matchString, caseSensitiveMatch ? "" : "i");
75
+ if (searchName.match(matchRegexp) == null) {
76
+ item.node.removeClass('found');
77
+ }
78
+ else {
79
+ item.node.css('padding-left', '10px').addClass('found');
80
+ item.node.parents().addClass('search_uncollapsed');
81
+ item.node.removeClass(lastRowClass).addClass(lastRowClass == 'r1' ? 'r2' : 'r1');
82
+ lastRowClass = item.node.hasClass('r1') ? 'r1' : 'r2';
83
+ item.link.html(item.name.replace(matchRegexp, "<strong>$&</strong>"));
84
+ }
85
+
86
+ if (searchCache.length === searchIndex + 1) {
87
+ searchDone();
88
+ return;
89
+ }
90
+ else {
91
+ searchIndex++;
92
+ }
93
+ }
94
+ inSearch = setTimeout('searchItem()', 0);
95
+ }
96
+
97
+ function searchDone() {
98
+ highlight(true);
99
+ if ($('#full_list li:visible').size() === 0) {
100
+ $('#noresults').text('No results were found.').hide().fadeIn();
101
+ }
102
+ else {
103
+ $('#noresults').text('');
104
+ }
105
+ $('#content').removeClass('insearch');
106
+ clearTimeout(inSearch);
107
+ inSearch = null;
108
+ }
109
+
110
+ clicked = null;
111
+ function linkList() {
112
+ $('#full_list li, #full_list li a:last').click(function(evt) {
113
+ if ($(this).hasClass('toggle')) return true;
114
+ if (this.tagName.toLowerCase() == "li") {
115
+ if ($(this).find('.object_link a').length === 0) {
116
+ $(this).children('a.toggle').click();
117
+ return false;
118
+ }
119
+ var toggle = $(this).children('a.toggle');
120
+ if (toggle.size() > 0 && evt.pageX < toggle.offset().left) {
121
+ toggle.click();
122
+ return false;
123
+ }
124
+ }
125
+ if (clicked) clicked.removeClass('clicked');
126
+ var win = window.top.frames.main ? window.top.frames.main : window.parent;
127
+ if (this.tagName.toLowerCase() == "a") {
128
+ clicked = $(this).parents('li').addClass('clicked');
129
+ win.location = this.href;
130
+ }
131
+ else {
132
+ clicked = $(this).addClass('clicked');
133
+ win.location = $(this).find('a:last').attr('href');
134
+ }
135
+ return false;
136
+ });
137
+ }
138
+
139
+ function collapse() {
140
+ if (!$('#full_list').hasClass('class')) return;
141
+ $('#full_list.class a.toggle').click(function() {
142
+ $(this).parent().toggleClass('collapsed').next().toggleClass('collapsed');
143
+ highlight();
144
+ return false;
145
+ });
146
+ $('#full_list.class ul').each(function() {
147
+ $(this).addClass('collapsed').prev().addClass('collapsed');
148
+ });
149
+ $('#full_list.class').children().removeClass('collapsed');
150
+ highlight();
151
+ }
152
+
153
+ function highlight(no_padding) {
154
+ var n = 1;
155
+ $('#full_list li:visible').each(function() {
156
+ var next = n == 1 ? 2 : 1;
157
+ $(this).removeClass("r" + next).addClass("r" + n);
158
+ if (!no_padding && $('#full_list').hasClass('class')) {
159
+ $(this).css('padding-left', (10 + $(this).parents('ul').size() * 15) + 'px');
160
+ }
161
+ n = next;
162
+ });
163
+ }
164
+
165
+ function escapeShortcut() {
166
+ $(document).keydown(function(evt) {
167
+ if (evt.which == 27) {
168
+ $('#search_frame', window.top.document).slideUp(100);
169
+ $('#search a', window.top.document).removeClass('active inactive');
170
+ $(window.top).focus();
171
+ }
172
+ });
173
+ }
174
+
175
+ $(escapeShortcut);
176
+ $(fullListSearch);
177
+ $(linkList);
178
+ $(collapse);