yard 0.9.28 → 0.9.29

Sign up to get free protection for your applications and to get access to all the features.

Potentially problematic release.


This version of yard might be problematic. Click here for more details.

Files changed (215) hide show
  1. checksums.yaml +4 -4
  2. data/LEGAL +29 -1
  3. data/lib/yard/autoload.rb +2 -1
  4. data/lib/yard/cli/command.rb +1 -1
  5. data/lib/yard/cli/yardoc.rb +1 -1
  6. data/lib/yard/code_objects/base.rb +4 -1
  7. data/lib/yard/docstring_parser.rb +1 -1
  8. data/lib/yard/handlers/ruby/attribute_handler.rb +1 -1
  9. data/lib/yard/handlers/ruby/legacy/attribute_handler.rb +1 -1
  10. data/lib/yard/handlers/ruby/mixin_handler.rb +13 -6
  11. data/lib/yard/i18n/locale.rb +1 -1
  12. data/lib/yard/i18n/message.rb +2 -2
  13. data/lib/yard/i18n/messages.rb +1 -1
  14. data/lib/yard/i18n/pot_generator.rb +1 -1
  15. data/lib/yard/options.rb +1 -1
  16. data/lib/yard/parser/ruby/ruby_parser.rb +8 -2
  17. data/lib/yard/registry_resolver.rb +2 -1
  18. data/lib/yard/server/commands/base.rb +1 -1
  19. data/lib/yard/server/http_utils.rb +512 -0
  20. data/lib/yard/server/rack_adapter.rb +24 -12
  21. data/lib/yard/tags/tag.rb +2 -2
  22. data/lib/yard/tags/types_explainer.rb +1 -1
  23. data/lib/yard/templates/helpers/html_helper.rb +1 -1
  24. data/lib/yard/version.rb +1 -1
  25. metadata +5 -208
  26. data/.dockerignore +0 -2
  27. data/.gitattributes +0 -4
  28. data/.github/FUNDING.yml +0 -3
  29. data/.github/ISSUE_TEMPLATE.md +0 -33
  30. data/.github/PULL_REQUEST_TEMPLATE.md +0 -12
  31. data/.github/workflows/ci.yml +0 -30
  32. data/.github/workflows/gem.yml +0 -19
  33. data/.gitignore +0 -14
  34. data/.rspec +0 -2
  35. data/.rubocop.yml +0 -112
  36. data/.yardopts +0 -26
  37. data/.yardopts_guide +0 -19
  38. data/.yardopts_i18n +0 -23
  39. data/CHANGELOG.md +0 -836
  40. data/CODE_OF_CONDUCT.md +0 -15
  41. data/CONTRIBUTING.md +0 -140
  42. data/Dockerfile.samus +0 -28
  43. data/Gemfile +0 -34
  44. data/Rakefile +0 -36
  45. data/SECURITY.md +0 -26
  46. data/benchmarks/builtins_vs_eval.rb +0 -24
  47. data/benchmarks/concat_vs_join.rb +0 -13
  48. data/benchmarks/erb_vs_erubis.rb +0 -54
  49. data/benchmarks/format_args.rb +0 -47
  50. data/benchmarks/generation.rb +0 -38
  51. data/benchmarks/marshal_vs_dbm.rb +0 -64
  52. data/benchmarks/parsing.rb +0 -46
  53. data/benchmarks/pathname_vs_string.rb +0 -51
  54. data/benchmarks/rdoc_vs_yardoc.rb +0 -11
  55. data/benchmarks/registry_store_types.rb +0 -49
  56. data/benchmarks/ri_vs_yri.rb +0 -19
  57. data/benchmarks/ripper_parser.rb +0 -13
  58. data/benchmarks/splat_vs_flatten.rb +0 -13
  59. data/benchmarks/template_erb.rb +0 -23
  60. data/benchmarks/template_format.rb +0 -7
  61. data/benchmarks/template_profile.rb +0 -18
  62. data/benchmarks/yri_cache.rb +0 -20
  63. data/docs/CodeObjects.md +0 -115
  64. data/docs/GettingStarted.md +0 -679
  65. data/docs/Handlers.md +0 -152
  66. data/docs/Overview.md +0 -61
  67. data/docs/Parser.md +0 -191
  68. data/docs/Tags.md +0 -283
  69. data/docs/TagsArch.md +0 -123
  70. data/docs/Templates.md +0 -496
  71. data/docs/WhatsNew.md +0 -1245
  72. data/docs/images/code-objects-class-diagram.png +0 -0
  73. data/docs/images/handlers-class-diagram.png +0 -0
  74. data/docs/images/overview-class-diagram.png +0 -0
  75. data/docs/images/parser-class-diagram.png +0 -0
  76. data/docs/images/tags-class-diagram.png +0 -0
  77. data/docs/templates/default/fulldoc/html/full_list_tag.erb +0 -9
  78. data/docs/templates/default/fulldoc/html/setup.rb +0 -6
  79. data/docs/templates/default/layout/html/setup.rb +0 -9
  80. data/docs/templates/default/layout/html/tag_list.erb +0 -11
  81. data/docs/templates/default/yard_tags/html/list.erb +0 -18
  82. data/docs/templates/default/yard_tags/html/setup.rb +0 -26
  83. data/docs/templates/plugin.rb +0 -70
  84. data/po/ja.po +0 -31108
  85. data/samus.json +0 -49
  86. data/tasks/prepare_tag.rake +0 -45
  87. data/tasks/update_error_map.rake +0 -53
  88. data/templates/default/class/dot/setup.rb +0 -7
  89. data/templates/default/class/dot/superklass.erb +0 -3
  90. data/templates/default/class/html/constructor_details.erb +0 -8
  91. data/templates/default/class/html/setup.rb +0 -2
  92. data/templates/default/class/html/subclasses.erb +0 -4
  93. data/templates/default/class/setup.rb +0 -36
  94. data/templates/default/class/text/setup.rb +0 -12
  95. data/templates/default/class/text/subclasses.erb +0 -5
  96. data/templates/default/constant/text/header.erb +0 -11
  97. data/templates/default/constant/text/setup.rb +0 -4
  98. data/templates/default/docstring/html/abstract.erb +0 -4
  99. data/templates/default/docstring/html/deprecated.erb +0 -1
  100. data/templates/default/docstring/html/index.erb +0 -5
  101. data/templates/default/docstring/html/note.erb +0 -6
  102. data/templates/default/docstring/html/private.erb +0 -4
  103. data/templates/default/docstring/html/returns_void.erb +0 -1
  104. data/templates/default/docstring/html/text.erb +0 -1
  105. data/templates/default/docstring/html/todo.erb +0 -6
  106. data/templates/default/docstring/setup.rb +0 -52
  107. data/templates/default/docstring/text/abstract.erb +0 -2
  108. data/templates/default/docstring/text/deprecated.erb +0 -2
  109. data/templates/default/docstring/text/index.erb +0 -2
  110. data/templates/default/docstring/text/note.erb +0 -4
  111. data/templates/default/docstring/text/private.erb +0 -2
  112. data/templates/default/docstring/text/returns_void.erb +0 -1
  113. data/templates/default/docstring/text/text.erb +0 -1
  114. data/templates/default/docstring/text/todo.erb +0 -4
  115. data/templates/default/fulldoc/html/css/common.css +0 -1
  116. data/templates/default/fulldoc/html/css/full_list.css +0 -58
  117. data/templates/default/fulldoc/html/css/style.css +0 -497
  118. data/templates/default/fulldoc/html/frames.erb +0 -17
  119. data/templates/default/fulldoc/html/full_list.erb +0 -37
  120. data/templates/default/fulldoc/html/full_list_class.erb +0 -2
  121. data/templates/default/fulldoc/html/full_list_file.erb +0 -7
  122. data/templates/default/fulldoc/html/full_list_method.erb +0 -10
  123. data/templates/default/fulldoc/html/js/app.js +0 -314
  124. data/templates/default/fulldoc/html/js/full_list.js +0 -216
  125. data/templates/default/fulldoc/html/js/jquery.js +0 -4
  126. data/templates/default/fulldoc/html/setup.rb +0 -241
  127. data/templates/default/layout/dot/header.erb +0 -6
  128. data/templates/default/layout/dot/setup.rb +0 -15
  129. data/templates/default/layout/html/breadcrumb.erb +0 -11
  130. data/templates/default/layout/html/files.erb +0 -11
  131. data/templates/default/layout/html/footer.erb +0 -5
  132. data/templates/default/layout/html/headers.erb +0 -15
  133. data/templates/default/layout/html/index.erb +0 -2
  134. data/templates/default/layout/html/layout.erb +0 -24
  135. data/templates/default/layout/html/listing.erb +0 -4
  136. data/templates/default/layout/html/objects.erb +0 -32
  137. data/templates/default/layout/html/script_setup.erb +0 -4
  138. data/templates/default/layout/html/search.erb +0 -13
  139. data/templates/default/layout/html/setup.rb +0 -89
  140. data/templates/default/method/html/header.erb +0 -17
  141. data/templates/default/method/setup.rb +0 -4
  142. data/templates/default/method/text/header.erb +0 -1
  143. data/templates/default/method_details/html/header.erb +0 -3
  144. data/templates/default/method_details/html/method_signature.erb +0 -25
  145. data/templates/default/method_details/html/source.erb +0 -10
  146. data/templates/default/method_details/setup.rb +0 -11
  147. data/templates/default/method_details/text/header.erb +0 -10
  148. data/templates/default/method_details/text/method_signature.erb +0 -12
  149. data/templates/default/method_details/text/setup.rb +0 -11
  150. data/templates/default/module/dot/child.erb +0 -1
  151. data/templates/default/module/dot/dependencies.erb +0 -3
  152. data/templates/default/module/dot/header.erb +0 -6
  153. data/templates/default/module/dot/info.erb +0 -14
  154. data/templates/default/module/dot/setup.rb +0 -15
  155. data/templates/default/module/html/attribute_details.erb +0 -10
  156. data/templates/default/module/html/attribute_summary.erb +0 -8
  157. data/templates/default/module/html/box_info.erb +0 -43
  158. data/templates/default/module/html/children.erb +0 -8
  159. data/templates/default/module/html/constant_summary.erb +0 -17
  160. data/templates/default/module/html/defines.erb +0 -3
  161. data/templates/default/module/html/header.erb +0 -5
  162. data/templates/default/module/html/inherited_attributes.erb +0 -14
  163. data/templates/default/module/html/inherited_constants.erb +0 -8
  164. data/templates/default/module/html/inherited_methods.erb +0 -19
  165. data/templates/default/module/html/item_summary.erb +0 -40
  166. data/templates/default/module/html/method_details_list.erb +0 -9
  167. data/templates/default/module/html/method_summary.erb +0 -14
  168. data/templates/default/module/html/methodmissing.erb +0 -12
  169. data/templates/default/module/html/pre_docstring.erb +0 -1
  170. data/templates/default/module/setup.rb +0 -167
  171. data/templates/default/module/text/children.erb +0 -10
  172. data/templates/default/module/text/class_meths_list.erb +0 -8
  173. data/templates/default/module/text/extends.erb +0 -8
  174. data/templates/default/module/text/header.erb +0 -7
  175. data/templates/default/module/text/includes.erb +0 -8
  176. data/templates/default/module/text/instance_meths_list.erb +0 -8
  177. data/templates/default/module/text/setup.rb +0 -13
  178. data/templates/default/onefile/html/files.erb +0 -5
  179. data/templates/default/onefile/html/headers.erb +0 -6
  180. data/templates/default/onefile/html/layout.erb +0 -17
  181. data/templates/default/onefile/html/readme.erb +0 -3
  182. data/templates/default/onefile/html/setup.rb +0 -62
  183. data/templates/default/root/dot/child.erb +0 -3
  184. data/templates/default/root/dot/setup.rb +0 -6
  185. data/templates/default/root/html/setup.rb +0 -2
  186. data/templates/default/tags/html/example.erb +0 -11
  187. data/templates/default/tags/html/index.erb +0 -3
  188. data/templates/default/tags/html/option.erb +0 -24
  189. data/templates/default/tags/html/overload.erb +0 -14
  190. data/templates/default/tags/html/see.erb +0 -8
  191. data/templates/default/tags/html/tag.erb +0 -20
  192. data/templates/default/tags/setup.rb +0 -57
  193. data/templates/default/tags/text/example.erb +0 -12
  194. data/templates/default/tags/text/index.erb +0 -1
  195. data/templates/default/tags/text/option.erb +0 -20
  196. data/templates/default/tags/text/overload.erb +0 -19
  197. data/templates/default/tags/text/see.erb +0 -11
  198. data/templates/default/tags/text/tag.erb +0 -13
  199. data/templates/guide/class/html/setup.rb +0 -2
  200. data/templates/guide/docstring/html/setup.rb +0 -2
  201. data/templates/guide/fulldoc/html/css/style.css +0 -108
  202. data/templates/guide/fulldoc/html/js/app.js +0 -33
  203. data/templates/guide/fulldoc/html/setup.rb +0 -74
  204. data/templates/guide/layout/html/layout.erb +0 -81
  205. data/templates/guide/layout/html/setup.rb +0 -25
  206. data/templates/guide/method/html/header.erb +0 -18
  207. data/templates/guide/method/html/setup.rb +0 -22
  208. data/templates/guide/module/html/header.erb +0 -7
  209. data/templates/guide/module/html/method_list.erb +0 -5
  210. data/templates/guide/module/html/setup.rb +0 -27
  211. data/templates/guide/onefile/html/files.erb +0 -4
  212. data/templates/guide/onefile/html/setup.rb +0 -6
  213. data/templates/guide/onefile/html/toc.erb +0 -3
  214. data/templates/guide/tags/html/setup.rb +0 -9
  215. data/yard.gemspec +0 -25
@@ -1,314 +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 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
- var curli;
175
- if ($('#filecontents h1').length > 1) tags.unshift('h1');
176
- for (i = 0; i < tags.length; i++) { tags[i] = '#filecontents ' + tags[i]; }
177
- var lastTag = parseInt(tags[0][1], 10);
178
- $(tags.join(', ')).each(function() {
179
- if ($(this).parents('.method_details .docstring').length != 0) return;
180
- if (this.id == "filecontents") return;
181
- show = true;
182
- var thisTag = parseInt(this.tagName[1], 10);
183
- if (this.id.length === 0) {
184
- var proposedId = $(this).attr('toc-id');
185
- if (typeof(proposedId) != "undefined") this.id = proposedId;
186
- else {
187
- var proposedId = $(this).text().replace(/[^a-z0-9-]/ig, '_');
188
- if ($('#' + proposedId).length > 0) { proposedId += counter; counter++; }
189
- this.id = proposedId;
190
- }
191
- }
192
- if (thisTag > lastTag) {
193
- for (i = 0; i < thisTag - lastTag; i++) {
194
- if ( typeof(curli) == "undefined" ) {
195
- curli = $('<li/>');
196
- toc.append(curli);
197
- }
198
- toc = $('<ol/>');
199
- curli.append(toc);
200
- curli = undefined;
201
- }
202
- }
203
- if (thisTag < lastTag) {
204
- for (i = 0; i < lastTag - thisTag; i++) {
205
- toc = toc.parent();
206
- toc = toc.parent();
207
- }
208
- }
209
- var title = $(this).attr('toc-title');
210
- if (typeof(title) == "undefined") title = $(this).text();
211
- curli =$('<li><a href="#' + this.id + '">' + title + '</a></li>');
212
- toc.append(curli);
213
- lastTag = thisTag;
214
- });
215
- if (!show) return;
216
- html = '<div id="toc"><p class="title hide_toc"><a href="#"><strong>Table of Contents</strong></a></p></div>';
217
- $('#content').prepend(html);
218
- $('#toc').append(_toc);
219
- $('#toc .hide_toc').toggle(function() {
220
- $('#toc .top').slideUp('fast');
221
- $('#toc').toggleClass('hidden');
222
- $('#toc .title small').toggle();
223
- }, function() {
224
- $('#toc .top').slideDown('fast');
225
- $('#toc').toggleClass('hidden');
226
- $('#toc .title small').toggle();
227
- });
228
- }
229
-
230
- function navResizeFn(e) {
231
- if (e.which !== 1) {
232
- navResizeFnStop();
233
- return;
234
- }
235
-
236
- sessionStorage.navWidth = e.pageX.toString();
237
- $('.nav_wrap').css('width', e.pageX);
238
- $('.nav_wrap').css('-ms-flex', 'inherit');
239
- }
240
-
241
- function navResizeFnStop() {
242
- $(window).unbind('mousemove', navResizeFn);
243
- window.removeEventListener('message', navMessageFn, false);
244
- }
245
-
246
- function navMessageFn(e) {
247
- if (e.data.action === 'mousemove') navResizeFn(e.data.event);
248
- if (e.data.action === 'mouseup') navResizeFnStop();
249
- }
250
-
251
- function navResizer() {
252
- $('#resizer').mousedown(function(e) {
253
- e.preventDefault();
254
- $(window).mousemove(navResizeFn);
255
- window.addEventListener('message', navMessageFn, false);
256
- });
257
- $(window).mouseup(navResizeFnStop);
258
-
259
- if (sessionStorage.navWidth) {
260
- navResizeFn({which: 1, pageX: parseInt(sessionStorage.navWidth, 10)});
261
- }
262
- }
263
-
264
- function navExpander() {
265
- var done = false, timer = setTimeout(postMessage, 500);
266
- function postMessage() {
267
- if (done) return;
268
- clearTimeout(timer);
269
- var opts = { action: 'expand', path: pathId };
270
- document.getElementById('nav').contentWindow.postMessage(opts, '*');
271
- done = true;
272
- }
273
-
274
- window.addEventListener('message', function(event) {
275
- if (event.data === 'navReady') postMessage();
276
- return false;
277
- }, false);
278
- }
279
-
280
- function mainFocus() {
281
- var hash = window.location.hash;
282
- if (hash !== '' && $(hash)[0]) {
283
- $(hash)[0].scrollIntoView();
284
- }
285
-
286
- setTimeout(function() { $('#main').focus(); }, 10);
287
- }
288
-
289
- function navigationChange() {
290
- // This works around the broken anchor navigation with the YARD template.
291
- window.onpopstate = function() {
292
- var hash = window.location.hash;
293
- if (hash !== '' && $(hash)[0]) {
294
- $(hash)[0].scrollIntoView();
295
- }
296
- };
297
- }
298
-
299
- $(document).ready(function() {
300
- navResizer();
301
- navExpander();
302
- createSourceLinks();
303
- createDefineLinks();
304
- createFullTreeLinks();
305
- searchFrameButtons();
306
- linkSummaries();
307
- summaryToggle();
308
- constantSummaryToggle();
309
- generateTOC();
310
- mainFocus();
311
- navigationChange();
312
- });
313
-
314
- })();
@@ -1,216 +0,0 @@
1
- (function() {
2
-
3
- var $clicked = $(null);
4
- var searchTimeout = null;
5
- var searchCache = [];
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 escapeShortcut() {
16
- $(document).keydown(function(evt) {
17
- if (evt.which == 27) {
18
- window.parent.postMessage('navEscape', '*');
19
- }
20
- });
21
- }
22
-
23
- function navResizer() {
24
- $(window).mousemove(function(e) {
25
- window.parent.postMessage({
26
- action: 'mousemove', event: {pageX: e.pageX, which: e.which}
27
- }, '*');
28
- }).mouseup(function(e) {
29
- window.parent.postMessage({action: 'mouseup'}, '*');
30
- });
31
- window.parent.postMessage("navReady", "*");
32
- }
33
-
34
- function clearSearchTimeout() {
35
- clearTimeout(searchTimeout);
36
- searchTimeout = null;
37
- }
38
-
39
- function enableLinks() {
40
- // load the target page in the parent window
41
- $('#full_list li').on('click', function(evt) {
42
- $('#full_list li').removeClass('clicked');
43
- $clicked = $(this);
44
- $clicked.addClass('clicked');
45
- evt.stopPropagation();
46
-
47
- if (evt.target.tagName === 'A') return true;
48
-
49
- var elem = $clicked.find('> .item .object_link a')[0];
50
- var e = evt.originalEvent;
51
- var newEvent = new MouseEvent(evt.originalEvent.type);
52
- newEvent.initMouseEvent(e.type, e.canBubble, e.cancelable, e.view, e.detail, e.screenX, e.screenY, e.clientX, e.clientY, e.ctrlKey, e.altKey, e.shiftKey, e.metaKey, e.button, e.relatedTarget);
53
- elem.dispatchEvent(newEvent);
54
- evt.preventDefault();
55
- return false;
56
- });
57
- }
58
-
59
- function enableToggles() {
60
- // show/hide nested classes on toggle click
61
- $('#full_list a.toggle').on('click', function(evt) {
62
- evt.stopPropagation();
63
- evt.preventDefault();
64
- $(this).parent().parent().toggleClass('collapsed');
65
- highlight();
66
- });
67
- }
68
-
69
- function populateSearchCache() {
70
- $('#full_list li .item').each(function() {
71
- var $node = $(this);
72
- var $link = $node.find('.object_link a');
73
- if ($link.length > 0) {
74
- searchCache.push({
75
- node: $node,
76
- link: $link,
77
- name: $link.text(),
78
- fullName: $link.attr('title').split(' ')[0]
79
- });
80
- }
81
- });
82
- }
83
-
84
- function enableSearch() {
85
- $('#search input').keyup(function(event) {
86
- if (ignoredKeyPress(event)) return;
87
- if (this.value === "") {
88
- clearSearch();
89
- } else {
90
- performSearch(this.value);
91
- }
92
- });
93
-
94
- $('#full_list').after("<div id='noresults' style='display:none'></div>");
95
- }
96
-
97
- function ignoredKeyPress(event) {
98
- if (
99
- (event.keyCode > ignoreKeyCodeMin && event.keyCode < ignoreKeyCodeMax) ||
100
- (event.keyCode == commandKey)
101
- ) {
102
- return true;
103
- } else {
104
- return false;
105
- }
106
- }
107
-
108
- function clearSearch() {
109
- clearSearchTimeout();
110
- $('#full_list .found').removeClass('found').each(function() {
111
- var $link = $(this).find('.object_link a');
112
- $link.text($link.text());
113
- });
114
- $('#full_list, #content').removeClass('insearch');
115
- $clicked.parents().removeClass('collapsed');
116
- highlight();
117
- }
118
-
119
- function performSearch(searchString) {
120
- clearSearchTimeout();
121
- $('#full_list, #content').addClass('insearch');
122
- $('#noresults').text('').hide();
123
- partialSearch(searchString, 0);
124
- }
125
-
126
- function partialSearch(searchString, offset) {
127
- var lastRowClass = '';
128
- var i = null;
129
- for (i = offset; i < Math.min(offset + 50, searchCache.length); i++) {
130
- var item = searchCache[i];
131
- var searchName = (searchString.indexOf('::') != -1 ? item.fullName : item.name);
132
- var matchString = buildMatchString(searchString);
133
- var matchRegexp = new RegExp(matchString, caseSensitiveMatch ? "" : "i");
134
- if (searchName.match(matchRegexp) == null) {
135
- item.node.removeClass('found');
136
- item.link.text(item.link.text());
137
- }
138
- else {
139
- item.node.addClass('found');
140
- item.node.removeClass(lastRowClass).addClass(lastRowClass == 'r1' ? 'r2' : 'r1');
141
- lastRowClass = item.node.hasClass('r1') ? 'r1' : 'r2';
142
- item.link.html(item.name.replace(matchRegexp, "<strong>$&</strong>"));
143
- }
144
- }
145
- if(i == searchCache.length) {
146
- searchDone();
147
- } else {
148
- searchTimeout = setTimeout(function() {
149
- partialSearch(searchString, i);
150
- }, 0);
151
- }
152
- }
153
-
154
- function searchDone() {
155
- searchTimeout = null;
156
- highlight();
157
- if ($('#full_list li:visible').size() === 0) {
158
- $('#noresults').text('No results were found.').hide().fadeIn();
159
- } else {
160
- $('#noresults').text('').hide();
161
- }
162
- $('#content').removeClass('insearch');
163
- }
164
-
165
- function buildMatchString(searchString, event) {
166
- caseSensitiveMatch = searchString.match(/[A-Z]/) != null;
167
- var regexSearchString = RegExp.escape(searchString);
168
- if (caseSensitiveMatch) {
169
- regexSearchString += "|" +
170
- $.map(searchString.split(''), function(e) { return RegExp.escape(e); }).
171
- join('.+?');
172
- }
173
- return regexSearchString;
174
- }
175
-
176
- function highlight() {
177
- $('#full_list li:visible').each(function(n) {
178
- $(this).removeClass('even odd').addClass(n % 2 == 0 ? 'odd' : 'even');
179
- });
180
- }
181
-
182
- /**
183
- * Expands the tree to the target element and its immediate
184
- * children.
185
- */
186
- function expandTo(path) {
187
- var $target = $(document.getElementById('object_' + path));
188
- $target.addClass('clicked');
189
- $target.removeClass('collapsed');
190
- $target.parentsUntil('#full_list', 'li').removeClass('collapsed');
191
- if($target[0]) {
192
- window.scrollTo(window.scrollX, $target.offset().top - 250);
193
- highlight();
194
- }
195
- }
196
-
197
- function windowEvents(event) {
198
- var msg = event.data;
199
- if (msg.action === "expand") {
200
- expandTo(msg.path);
201
- }
202
- return false;
203
- }
204
-
205
- window.addEventListener("message", windowEvents, false);
206
-
207
- $(document).ready(function() {
208
- escapeShortcut();
209
- navResizer();
210
- enableLinks();
211
- enableToggles();
212
- populateSearchCache();
213
- enableSearch();
214
- });
215
-
216
- })();