maxcube-client 0.5.0 → 0.5.1

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.
Files changed (95) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +4 -0
  3. data/data/save/20180214-2023/recv.data +12 -0
  4. data/data/save/20180214-2023/recv.yaml +152 -0
  5. data/data/save/20180214-2023/sent.data +10 -0
  6. data/data/save/20180214-2023/sent.yaml +26 -0
  7. data/data/save/20180214-2230/recv.data +2 -0
  8. data/data/save/20180214-2230/recv.yaml +68 -0
  9. data/data/save/20180214-2230/sent.data +1 -0
  10. data/data/save/20180214-2230/sent.yaml +19 -0
  11. data/data/save/20180215-0057/recv.data +3 -0
  12. data/data/save/20180215-0057/recv.yaml +69 -0
  13. data/data/save/20180215-0057/sent.data +2 -0
  14. data/data/save/20180215-0057/sent.yaml +22 -0
  15. data/data/save/20180216-1641/recv.data +4 -0
  16. data/data/save/20180216-1641/recv.yaml +133 -0
  17. data/data/save/20180216-1641/sent.data +2 -0
  18. data/data/save/20180216-1641/sent.yaml +3 -0
  19. data/lib/maxcube/version.rb +1 -1
  20. data/maxcube-client.gemspec +5 -6
  21. data/spec/msg_spec.rb +2117 -0
  22. data/spec/spec_helper.rb +7 -0
  23. metadata +21 -75
  24. data/.gitignore +0 -6
  25. data/.rubocop.yml +0 -29
  26. data/.yardopts +0 -1
  27. data/Gemfile +0 -5
  28. data/bin/console +0 -8
  29. data/bin/maxcube-client +0 -6
  30. data/bin/sample_server +0 -13
  31. data/bin/sample_socket +0 -13
  32. data/bin/setup +0 -6
  33. data/doc/MaxCube.html +0 -502
  34. data/doc/MaxCube/Messages.html +0 -1927
  35. data/doc/MaxCube/Messages/Handler.html +0 -2912
  36. data/doc/MaxCube/Messages/InvalidMessage.html +0 -140
  37. data/doc/MaxCube/Messages/InvalidMessageBody.html +0 -264
  38. data/doc/MaxCube/Messages/InvalidMessageFormat.html +0 -247
  39. data/doc/MaxCube/Messages/InvalidMessageLength.html +0 -247
  40. data/doc/MaxCube/Messages/InvalidMessageType.html +0 -263
  41. data/doc/MaxCube/Messages/Parser.html +0 -520
  42. data/doc/MaxCube/Messages/Serializer.html +0 -701
  43. data/doc/MaxCube/Messages/TCP.html +0 -172
  44. data/doc/MaxCube/Messages/TCP/Handler.html +0 -1396
  45. data/doc/MaxCube/Messages/TCP/Parser.html +0 -462
  46. data/doc/MaxCube/Messages/TCP/Parser/MessageA.html +0 -186
  47. data/doc/MaxCube/Messages/TCP/Parser/MessageC.html +0 -1077
  48. data/doc/MaxCube/Messages/TCP/Parser/MessageF.html +0 -206
  49. data/doc/MaxCube/Messages/TCP/Parser/MessageH.html +0 -338
  50. data/doc/MaxCube/Messages/TCP/Parser/MessageL.html +0 -535
  51. data/doc/MaxCube/Messages/TCP/Parser/MessageM.html +0 -510
  52. data/doc/MaxCube/Messages/TCP/Parser/MessageN.html +0 -226
  53. data/doc/MaxCube/Messages/TCP/Parser/MessageS.html +0 -225
  54. data/doc/MaxCube/Messages/TCP/Serializer.html +0 -460
  55. data/doc/MaxCube/Messages/TCP/Serializer/MessageA.html +0 -186
  56. data/doc/MaxCube/Messages/TCP/Serializer/MessageC.html +0 -185
  57. data/doc/MaxCube/Messages/TCP/Serializer/MessageF.html +0 -206
  58. data/doc/MaxCube/Messages/TCP/Serializer/MessageL.html +0 -185
  59. data/doc/MaxCube/Messages/TCP/Serializer/MessageM.html +0 -428
  60. data/doc/MaxCube/Messages/TCP/Serializer/MessageN.html +0 -209
  61. data/doc/MaxCube/Messages/TCP/Serializer/MessageQ.html +0 -185
  62. data/doc/MaxCube/Messages/TCP/Serializer/MessageS.html +0 -1168
  63. data/doc/MaxCube/Messages/TCP/Serializer/MessageT.html +0 -240
  64. data/doc/MaxCube/Messages/TCP/Serializer/MessageU.html +0 -206
  65. data/doc/MaxCube/Messages/TCP/Serializer/MessageZ.html +0 -252
  66. data/doc/MaxCube/Messages/UDP.html +0 -164
  67. data/doc/MaxCube/Messages/UDP/Handler.html +0 -832
  68. data/doc/MaxCube/Messages/UDP/Parser.html +0 -609
  69. data/doc/MaxCube/Messages/UDP/Parser/MessageH.html +0 -218
  70. data/doc/MaxCube/Messages/UDP/Parser/MessageI.html +0 -215
  71. data/doc/MaxCube/Messages/UDP/Parser/MessageN.html +0 -226
  72. data/doc/MaxCube/Messages/UDP/Serializer.html +0 -484
  73. data/doc/MaxCube/Network.html +0 -167
  74. data/doc/MaxCube/Network/TCP.html +0 -150
  75. data/doc/MaxCube/Network/TCP/Client.html +0 -1930
  76. data/doc/MaxCube/Network/TCP/Client/Commands.html +0 -2457
  77. data/doc/MaxCube/Network/TCP/SampleServer.html +0 -910
  78. data/doc/MaxCube/Network/UDP.html +0 -150
  79. data/doc/MaxCube/Network/UDP/Client.html +0 -518
  80. data/doc/MaxCube/Network/UDP/SampleSocket.html +0 -628
  81. data/doc/MaxCube/Runner.html +0 -355
  82. data/doc/_index.html +0 -518
  83. data/doc/class_list.html +0 -51
  84. data/doc/css/common.css +0 -1
  85. data/doc/css/full_list.css +0 -58
  86. data/doc/css/style.css +0 -499
  87. data/doc/file.README.html +0 -140
  88. data/doc/file_list.html +0 -56
  89. data/doc/frames.html +0 -17
  90. data/doc/index.html +0 -140
  91. data/doc/js/app.js +0 -248
  92. data/doc/js/full_list.js +0 -216
  93. data/doc/js/jquery.js +0 -4
  94. data/doc/method_list.html +0 -1699
  95. data/doc/top-level-namespace.html +0 -110
data/doc/file.README.html DELETED
@@ -1,140 +0,0 @@
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
- &mdash; Documentation by YARD 0.9.12
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="file_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> &raquo;
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-eQ3-2FELV+Max-21+Cube+TCP+client">eQ3/ELV Max! Cube TCP client</h1>
62
-
63
- <h2 id="label-Download">Download</h2>
64
-
65
- <p>Ruby <a href="https://rubygems.org/gems/maxcube-client">gem</a></p>
66
-
67
- <p><a href="https://github.com/Tomaqa/maxcube-client">GitHub</a> repository</p>
68
-
69
- <h2 id="label-Installation">Installation</h2>
70
-
71
- <p>Add this line to your application&#39;s Gemfile:</p>
72
-
73
- <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>maxcube-client</span><span class='tstring_end'>&#39;</span></span>
74
- </code></pre>
75
-
76
- <p>And then execute:</p>
77
-
78
- <pre class="code ruby"><code class="ruby">$ bundle
79
- </code></pre>
80
-
81
- <p>Or install it yourself as:</p>
82
-
83
- <pre class="code ruby"><code class="ruby">$ gem install maxcube-client
84
- </code></pre>
85
-
86
- <h2 id="label-Usage">Usage</h2>
87
-
88
- <p>Run <code>bin/maxcube-client help</code> and follow instructions. This
89
- script starts either TCP or UDP client. UDP client is used only for device
90
- discovery purposes yet.</p>
91
-
92
- <p>You can also run <code>bin/console</code>, if you want to to handle objects
93
- yourself.</p>
94
-
95
- <p>Yet there are sample servers: <code>bin/sample_server</code> (TCP) and
96
- <code>bin/sample_socket</code> (UDP), but only with very basic features.
97
- However, they can be used to try simple connection with client.</p>
98
-
99
- <h2 id="label-Documentation">Documentation</h2>
100
-
101
- <p>Project is documented using YARD.</p>
102
-
103
- <p>MAX! Cube protocol itself is not documented here though. You should have a
104
- look <a href="https://github.com/Bouni/max-cube-protocol">here</a>, where I
105
- derived vast of specifications from.</p>
106
-
107
- <h2 id="label-Development">Development</h2>
108
-
109
- <p>After checking out the repo, run <code>bin/setup</code> to install
110
- dependencies. Then, run <code>rake spec</code> to run the tests. You can
111
- also run <code>bin/console</code> for an interactive prompt that will allow
112
- you to experiment.</p>
113
-
114
- <p>To install this gem onto your local machine, run <code>bundle exec rake
115
- install</code>. To release a new version, update the version number in
116
- <code>version.rb</code>, and then run <code>bundle exec rake
117
- release</code>, which will create a git tag for the version, push git
118
- commits and tags, and push the <code>.gem</code> file to <a
119
- href="https://rubygems.org">rubygems.org</a>.</p>
120
-
121
- <h2 id="label-Contributing">Contributing</h2>
122
-
123
- <p>Bug reports and pull requests are welcome on GitHub at <a
124
- href="https://github.com/Tomaqa/maxcube-client">github.com/Tomaqa/maxcube-client</a>.</p>
125
-
126
- <h2 id="label-License">License</h2>
127
-
128
- <p>The gem is available as open source under the terms of the <a
129
- href="https://opensource.org/licenses/MIT">MIT License</a>.</p>
130
- </div></div>
131
-
132
- <div id="footer">
133
- Generated on Fri Feb 16 13:44:01 2018 by
134
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
135
- 0.9.12 (ruby-2.5.0).
136
- </div>
137
-
138
- </div>
139
- </body>
140
- </html>
data/doc/file_list.html DELETED
@@ -1,56 +0,0 @@
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 DELETED
@@ -1,17 +0,0 @@
1
- <!DOCTYPE html>
2
- <html>
3
- <head>
4
- <meta charset="utf-8">
5
- <title>Documentation by YARD 0.9.12</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 DELETED
@@ -1,140 +0,0 @@
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
- &mdash; Documentation by YARD 0.9.12
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> &raquo;
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-eQ3-2FELV+Max-21+Cube+TCP+client">eQ3/ELV Max! Cube TCP client</h1>
62
-
63
- <h2 id="label-Download">Download</h2>
64
-
65
- <p>Ruby <a href="https://rubygems.org/gems/maxcube-client">gem</a></p>
66
-
67
- <p><a href="https://github.com/Tomaqa/maxcube-client">GitHub</a> repository</p>
68
-
69
- <h2 id="label-Installation">Installation</h2>
70
-
71
- <p>Add this line to your application&#39;s Gemfile:</p>
72
-
73
- <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>maxcube-client</span><span class='tstring_end'>&#39;</span></span>
74
- </code></pre>
75
-
76
- <p>And then execute:</p>
77
-
78
- <pre class="code ruby"><code class="ruby">$ bundle
79
- </code></pre>
80
-
81
- <p>Or install it yourself as:</p>
82
-
83
- <pre class="code ruby"><code class="ruby">$ gem install maxcube-client
84
- </code></pre>
85
-
86
- <h2 id="label-Usage">Usage</h2>
87
-
88
- <p>Run <code>bin/maxcube-client help</code> and follow instructions. This
89
- script starts either TCP or UDP client. UDP client is used only for device
90
- discovery purposes yet.</p>
91
-
92
- <p>You can also run <code>bin/console</code>, if you want to to handle objects
93
- yourself.</p>
94
-
95
- <p>Yet there are sample servers: <code>bin/sample_server</code> (TCP) and
96
- <code>bin/sample_socket</code> (UDP), but only with very basic features.
97
- However, they can be used to try simple connection with client.</p>
98
-
99
- <h2 id="label-Documentation">Documentation</h2>
100
-
101
- <p>Project is documented using YARD.</p>
102
-
103
- <p>MAX! Cube protocol itself is not documented here though. You should have a
104
- look <a href="https://github.com/Bouni/max-cube-protocol">here</a>, where I
105
- derived vast of specifications from.</p>
106
-
107
- <h2 id="label-Development">Development</h2>
108
-
109
- <p>After checking out the repo, run <code>bin/setup</code> to install
110
- dependencies. Then, run <code>rake spec</code> to run the tests. You can
111
- also run <code>bin/console</code> for an interactive prompt that will allow
112
- you to experiment.</p>
113
-
114
- <p>To install this gem onto your local machine, run <code>bundle exec rake
115
- install</code>. To release a new version, update the version number in
116
- <code>version.rb</code>, and then run <code>bundle exec rake
117
- release</code>, which will create a git tag for the version, push git
118
- commits and tags, and push the <code>.gem</code> file to <a
119
- href="https://rubygems.org">rubygems.org</a>.</p>
120
-
121
- <h2 id="label-Contributing">Contributing</h2>
122
-
123
- <p>Bug reports and pull requests are welcome on GitHub at <a
124
- href="https://github.com/Tomaqa/maxcube-client">github.com/Tomaqa/maxcube-client</a>.</p>
125
-
126
- <h2 id="label-License">License</h2>
127
-
128
- <p>The gem is available as open source under the terms of the <a
129
- href="https://opensource.org/licenses/MIT">MIT License</a>.</p>
130
- </div></div>
131
-
132
- <div id="footer">
133
- Generated on Fri Feb 16 13:44:00 2018 by
134
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
135
- 0.9.12 (ruby-2.5.0).
136
- </div>
137
-
138
- </div>
139
- </body>
140
- </html>
data/doc/js/app.js DELETED
@@ -1,248 +0,0 @@
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 generateTOC() {
124
- if ($('#filecontents').length === 0) return;
125
- var _toc = $('<ol class="top"></ol>');
126
- var show = false;
127
- var toc = _toc;
128
- var counter = 0;
129
- var tags = ['h2', 'h3', 'h4', 'h5', 'h6'];
130
- var i;
131
- if ($('#filecontents h1').length > 1) tags.unshift('h1');
132
- for (i = 0; i < tags.length; i++) { tags[i] = '#filecontents ' + tags[i]; }
133
- var lastTag = parseInt(tags[0][1], 10);
134
- $(tags.join(', ')).each(function() {
135
- if ($(this).parents('.method_details .docstring').length != 0) return;
136
- if (this.id == "filecontents") return;
137
- show = true;
138
- var thisTag = parseInt(this.tagName[1], 10);
139
- if (this.id.length === 0) {
140
- var proposedId = $(this).attr('toc-id');
141
- if (typeof(proposedId) != "undefined") this.id = proposedId;
142
- else {
143
- var proposedId = $(this).text().replace(/[^a-z0-9-]/ig, '_');
144
- if ($('#' + proposedId).length > 0) { proposedId += counter; counter++; }
145
- this.id = proposedId;
146
- }
147
- }
148
- if (thisTag > lastTag) {
149
- for (i = 0; i < thisTag - lastTag; i++) {
150
- var tmp = $('<ol/>'); toc.append(tmp); toc = tmp;
151
- }
152
- }
153
- if (thisTag < lastTag) {
154
- for (i = 0; i < lastTag - thisTag; i++) toc = toc.parent();
155
- }
156
- var title = $(this).attr('toc-title');
157
- if (typeof(title) == "undefined") title = $(this).text();
158
- toc.append('<li><a href="#' + this.id + '">' + title + '</a></li>');
159
- lastTag = thisTag;
160
- });
161
- if (!show) return;
162
- html = '<div id="toc"><p class="title hide_toc"><a href="#"><strong>Table of Contents</strong></a></p></div>';
163
- $('#content').prepend(html);
164
- $('#toc').append(_toc);
165
- $('#toc .hide_toc').toggle(function() {
166
- $('#toc .top').slideUp('fast');
167
- $('#toc').toggleClass('hidden');
168
- $('#toc .title small').toggle();
169
- }, function() {
170
- $('#toc .top').slideDown('fast');
171
- $('#toc').toggleClass('hidden');
172
- $('#toc .title small').toggle();
173
- });
174
- }
175
-
176
- function navResizeFn(e) {
177
- if (e.which !== 1) {
178
- navResizeFnStop();
179
- return;
180
- }
181
-
182
- sessionStorage.navWidth = e.pageX.toString();
183
- $('.nav_wrap').css('width', e.pageX);
184
- $('.nav_wrap').css('-ms-flex', 'inherit');
185
- }
186
-
187
- function navResizeFnStop() {
188
- $(window).unbind('mousemove', navResizeFn);
189
- window.removeEventListener('message', navMessageFn, false);
190
- }
191
-
192
- function navMessageFn(e) {
193
- if (e.data.action === 'mousemove') navResizeFn(e.data.event);
194
- if (e.data.action === 'mouseup') navResizeFnStop();
195
- }
196
-
197
- function navResizer() {
198
- $('#resizer').mousedown(function(e) {
199
- e.preventDefault();
200
- $(window).mousemove(navResizeFn);
201
- window.addEventListener('message', navMessageFn, false);
202
- });
203
- $(window).mouseup(navResizeFnStop);
204
-
205
- if (sessionStorage.navWidth) {
206
- navResizeFn({which: 1, pageX: parseInt(sessionStorage.navWidth, 10)});
207
- }
208
- }
209
-
210
- function navExpander() {
211
- var done = false, timer = setTimeout(postMessage, 500);
212
- function postMessage() {
213
- if (done) return;
214
- clearTimeout(timer);
215
- var opts = { action: 'expand', path: pathId };
216
- document.getElementById('nav').contentWindow.postMessage(opts, '*');
217
- done = true;
218
- }
219
-
220
- window.addEventListener('message', function(event) {
221
- if (event.data === 'navReady') postMessage();
222
- return false;
223
- }, false);
224
- }
225
-
226
- function mainFocus() {
227
- var hash = window.location.hash;
228
- if (hash !== '' && $(hash)[0]) {
229
- $(hash)[0].scrollIntoView();
230
- }
231
-
232
- setTimeout(function() { $('#main').focus(); }, 10);
233
- }
234
-
235
- $(document).ready(function() {
236
- navResizer();
237
- navExpander();
238
- createSourceLinks();
239
- createDefineLinks();
240
- createFullTreeLinks();
241
- searchFrameButtons();
242
- linkSummaries();
243
- summaryToggle();
244
- generateTOC();
245
- mainFocus();
246
- });
247
-
248
- })();