netlinx-compile 1.0.0 → 2.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +14 -0
- data/bin/netlinx-compile +0 -0
- data/doc/NetLinx.html +119 -151
- data/doc/NetLinx/Compile.html +119 -148
- data/doc/NetLinx/Compile/Extension.html +115 -145
- data/doc/NetLinx/Compile/Extension/AXS.html +217 -154
- data/doc/NetLinx/Compile/ExtensionDiscovery.html +479 -321
- data/doc/NetLinx/Compile/ExtensionHandler.html +703 -396
- data/doc/NetLinx/Compile/Script.html +390 -282
- data/doc/NetLinx/Compiler.html +375 -288
- data/doc/NetLinx/CompilerResult.html +1102 -498
- data/doc/NetLinx/NoCompilerError.html +135 -155
- data/doc/NetLinx/SourceFile.html +608 -423
- data/doc/_index.html +215 -0
- data/doc/class_list.html +58 -0
- data/doc/css/common.css +1 -0
- data/doc/css/full_list.css +57 -0
- data/doc/css/style.css +339 -0
- data/doc/file.README.html +94 -0
- data/doc/file.license.html +73 -0
- data/doc/file_list.html +63 -0
- data/doc/frames.html +26 -0
- data/doc/index.html +94 -103
- data/doc/js/app.js +219 -0
- data/doc/js/full_list.js +181 -0
- data/doc/js/jquery.js +4 -18
- data/doc/method_list.html +261 -0
- data/doc/top-level-namespace.html +112 -0
- data/lib/test/netlinx/compilable.rb +13 -48
- data/lib/test/netlinx/compile/discoverable.rb +3 -14
- data/lib/test/netlinx/compile/invokable.rb +3 -15
- metadata +98 -67
- data/README.txt +0 -2
- data/doc/Test.html +0 -147
- data/doc/Test/NetLinx.html +0 -147
- data/doc/Test/NetLinx/Compilable.html +0 -148
- data/doc/Test/NetLinx/Compile.html +0 -146
- data/doc/Test/NetLinx/Compile/Discoverable.html +0 -148
- data/doc/Test/NetLinx/Compile/Invokable.html +0 -149
- data/doc/created.rid +0 -12
- data/doc/images/add.png +0 -0
- data/doc/images/arrow_up.png +0 -0
- data/doc/images/brick.png +0 -0
- data/doc/images/brick_link.png +0 -0
- data/doc/images/bug.png +0 -0
- data/doc/images/bullet_black.png +0 -0
- data/doc/images/bullet_toggle_minus.png +0 -0
- data/doc/images/bullet_toggle_plus.png +0 -0
- data/doc/images/date.png +0 -0
- data/doc/images/delete.png +0 -0
- data/doc/images/find.png +0 -0
- data/doc/images/loadingAnimation.gif +0 -0
- data/doc/images/macFFBgHack.png +0 -0
- data/doc/images/package.png +0 -0
- data/doc/images/page_green.png +0 -0
- data/doc/images/page_white_text.png +0 -0
- data/doc/images/page_white_width.png +0 -0
- data/doc/images/plugin.png +0 -0
- data/doc/images/ruby.png +0 -0
- data/doc/images/tag_blue.png +0 -0
- data/doc/images/tag_green.png +0 -0
- data/doc/images/transparent.png +0 -0
- data/doc/images/wrench.png +0 -0
- data/doc/images/wrench_orange.png +0 -0
- data/doc/images/zoom.png +0 -0
- data/doc/js/darkfish.js +0 -155
- data/doc/js/navigation.js +0 -142
- data/doc/js/search.js +0 -94
- data/doc/js/search_index.js +0 -1
- data/doc/js/searcher.js +0 -228
- data/doc/rdoc.css +0 -595
- data/doc/table_of_contents.html +0 -138
|
@@ -1,396 +1,703 @@
|
|
|
1
|
-
<!DOCTYPE html
|
|
2
|
-
|
|
3
|
-
<html>
|
|
4
|
-
<head>
|
|
5
|
-
<meta content="text/html; charset=
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
<
|
|
16
|
-
|
|
17
|
-
<script type="text/javascript" charset="utf-8"
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
<
|
|
25
|
-
|
|
26
|
-
<
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
</
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
<
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
<
|
|
142
|
-
extensions.</p>
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
<
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
<
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
<
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
</
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
<
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
|
|
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
|
+
Class: NetLinx::Compile::ExtensionHandler
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.8.7.6
|
|
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
|
+
hasFrames = window.top.frames.main ? true : false;
|
|
19
|
+
relpath = '../../';
|
|
20
|
+
framesUrl = "../../frames.html#!NetLinx/Compile/ExtensionHandler.html";
|
|
21
|
+
</script>
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
|
|
25
|
+
|
|
26
|
+
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
</head>
|
|
30
|
+
<body>
|
|
31
|
+
<div id="header">
|
|
32
|
+
<div id="menu">
|
|
33
|
+
|
|
34
|
+
<a href="../../_index.html">Index (E)</a> »
|
|
35
|
+
<span class='title'><span class='object_link'><a href="../../NetLinx.html" title="NetLinx (module)">NetLinx</a></span></span> » <span class='title'><span class='object_link'><a href="../Compile.html" title="NetLinx::Compile (module)">Compile</a></span></span>
|
|
36
|
+
»
|
|
37
|
+
<span class="title">ExtensionHandler</span>
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
<div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
|
|
41
|
+
</div>
|
|
42
|
+
|
|
43
|
+
<div id="search">
|
|
44
|
+
|
|
45
|
+
<a class="full_list_link" id="class_list_link"
|
|
46
|
+
href="../../class_list.html">
|
|
47
|
+
Class List
|
|
48
|
+
</a>
|
|
49
|
+
|
|
50
|
+
<a class="full_list_link" id="method_list_link"
|
|
51
|
+
href="../../method_list.html">
|
|
52
|
+
Method List
|
|
53
|
+
</a>
|
|
54
|
+
|
|
55
|
+
<a class="full_list_link" id="file_list_link"
|
|
56
|
+
href="../../file_list.html">
|
|
57
|
+
File List
|
|
58
|
+
</a>
|
|
59
|
+
|
|
60
|
+
</div>
|
|
61
|
+
<div class="clear"></div>
|
|
62
|
+
</div>
|
|
63
|
+
|
|
64
|
+
<iframe id="search_frame"></iframe>
|
|
65
|
+
|
|
66
|
+
<div id="content"><h1>Class: NetLinx::Compile::ExtensionHandler
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
</h1>
|
|
71
|
+
|
|
72
|
+
<dl class="box">
|
|
73
|
+
|
|
74
|
+
<dt class="r1">Inherits:</dt>
|
|
75
|
+
<dd class="r1">
|
|
76
|
+
<span class="inheritName">Object</span>
|
|
77
|
+
|
|
78
|
+
<ul class="fullTree">
|
|
79
|
+
<li>Object</li>
|
|
80
|
+
|
|
81
|
+
<li class="next">NetLinx::Compile::ExtensionHandler</li>
|
|
82
|
+
|
|
83
|
+
</ul>
|
|
84
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
85
|
+
|
|
86
|
+
</dd>
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
<dt class="r2 last">Defined in:</dt>
|
|
97
|
+
<dd class="r2 last">lib/netlinx/compile/extension_handler.rb</dd>
|
|
98
|
+
|
|
99
|
+
</dl>
|
|
100
|
+
<div class="clear"></div>
|
|
101
|
+
|
|
102
|
+
<h2>Overview</h2><div class="docstring">
|
|
103
|
+
<div class="discussion">
|
|
104
|
+
|
|
105
|
+
<p>Tells netlinx-compile which class handles the compiling of a set of file
|
|
106
|
+
extensions.</p>
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
</div>
|
|
110
|
+
</div>
|
|
111
|
+
<div class="tags">
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
</div>
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
<h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
|
|
119
|
+
<ul class="summary">
|
|
120
|
+
|
|
121
|
+
<li class="public ">
|
|
122
|
+
<span class="summary_signature">
|
|
123
|
+
|
|
124
|
+
<a href="#extensions-instance_method" title="#extensions (instance method)">- (Object) <strong>extensions</strong> </a>
|
|
125
|
+
|
|
126
|
+
|
|
127
|
+
|
|
128
|
+
</span>
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
<span class="summary_desc"><div class='inline'>
|
|
142
|
+
<p>A list of file extensions that this ExtensionHandler handles.</p>
|
|
143
|
+
</div></span>
|
|
144
|
+
|
|
145
|
+
</li>
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
<li class="public ">
|
|
149
|
+
<span class="summary_signature">
|
|
150
|
+
|
|
151
|
+
<a href="#handler_class-instance_method" title="#handler_class (instance method)">- (Object) <strong>handler_class</strong> </a>
|
|
152
|
+
|
|
153
|
+
|
|
154
|
+
|
|
155
|
+
</span>
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
<span class="note title readonly">readonly</span>
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
<span class="summary_desc"><div class='inline'>
|
|
171
|
+
<p>The class to invoke to handle compiling a file extension specified in this
|
|
172
|
+
ExtensionHandler.</p>
|
|
173
|
+
</div></span>
|
|
174
|
+
|
|
175
|
+
</li>
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
<li class="public ">
|
|
179
|
+
<span class="summary_signature">
|
|
180
|
+
|
|
181
|
+
<a href="#usurps-instance_method" title="#usurps (instance method)">- (Object) <strong>usurps</strong> </a>
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
</span>
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
<span class="summary_desc"><div class='inline'>
|
|
199
|
+
<p>A list of file extensions that this ExtensionHandler usurps.</p>
|
|
200
|
+
</div></span>
|
|
201
|
+
|
|
202
|
+
</li>
|
|
203
|
+
|
|
204
|
+
|
|
205
|
+
</ul>
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
|
|
209
|
+
|
|
210
|
+
|
|
211
|
+
<h2>
|
|
212
|
+
Instance Method Summary
|
|
213
|
+
<small>(<a href="#" class="summary_toggle">collapse</a>)</small>
|
|
214
|
+
</h2>
|
|
215
|
+
|
|
216
|
+
<ul class="summary">
|
|
217
|
+
|
|
218
|
+
<li class="public ">
|
|
219
|
+
<span class="summary_signature">
|
|
220
|
+
|
|
221
|
+
<a href="#%3C%3C-instance_method" title="#<< (instance method)">- (Object) <strong><<</strong>(file_extension) </a>
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
</span>
|
|
226
|
+
|
|
227
|
+
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
|
|
235
|
+
<span class="summary_desc"><div class='inline'>
|
|
236
|
+
<p>Alias to add a file extension.</p>
|
|
237
|
+
</div></span>
|
|
238
|
+
|
|
239
|
+
</li>
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
<li class="public ">
|
|
243
|
+
<span class="summary_signature">
|
|
244
|
+
|
|
245
|
+
<a href="#include%3F-instance_method" title="#include? (instance method)">- (Boolean) <strong>include?</strong>(file_extension) </a>
|
|
246
|
+
|
|
247
|
+
|
|
248
|
+
|
|
249
|
+
</span>
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
|
|
256
|
+
|
|
257
|
+
|
|
258
|
+
|
|
259
|
+
<span class="summary_desc"><div class='inline'>
|
|
260
|
+
<p>Returns true if this ExtensionHandler can handle the specified file
|
|
261
|
+
extension.</p>
|
|
262
|
+
</div></span>
|
|
263
|
+
|
|
264
|
+
</li>
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
<li class="public ">
|
|
268
|
+
<span class="summary_signature">
|
|
269
|
+
|
|
270
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">- (ExtensionHandler) <strong>initialize</strong>(**kvargs) </a>
|
|
271
|
+
|
|
272
|
+
|
|
273
|
+
|
|
274
|
+
</span>
|
|
275
|
+
|
|
276
|
+
|
|
277
|
+
<span class="note title constructor">constructor</span>
|
|
278
|
+
|
|
279
|
+
|
|
280
|
+
|
|
281
|
+
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
|
|
285
|
+
|
|
286
|
+
<span class="summary_desc"><div class='inline'>
|
|
287
|
+
<p>Parameters: extensions: An array of file extensions (without the leading
|
|
288
|
+
dot) that this ExtensionHandler supports.</p>
|
|
289
|
+
</div></span>
|
|
290
|
+
|
|
291
|
+
</li>
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
<li class="public ">
|
|
295
|
+
<span class="summary_signature">
|
|
296
|
+
|
|
297
|
+
<a href="#is_a_workspace%3F-instance_method" title="#is_a_workspace? (instance method)">- (Boolean) <strong>is_a_workspace?</strong> </a>
|
|
298
|
+
|
|
299
|
+
|
|
300
|
+
|
|
301
|
+
</span>
|
|
302
|
+
|
|
303
|
+
|
|
304
|
+
|
|
305
|
+
|
|
306
|
+
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
|
|
311
|
+
<span class="summary_desc"><div class='inline'>
|
|
312
|
+
<p>Returns true if the ExtensionHandler handles a workspace file (as opposed
|
|
313
|
+
to a source code file).</p>
|
|
314
|
+
</div></span>
|
|
315
|
+
|
|
316
|
+
</li>
|
|
317
|
+
|
|
318
|
+
|
|
319
|
+
</ul>
|
|
320
|
+
|
|
321
|
+
|
|
322
|
+
<div id="constructor_details" class="method_details_list">
|
|
323
|
+
<h2>Constructor Details</h2>
|
|
324
|
+
|
|
325
|
+
<div class="method_details first">
|
|
326
|
+
<h3 class="signature first" id="initialize-instance_method">
|
|
327
|
+
|
|
328
|
+
- (<tt><span class='object_link'><a href="" title="NetLinx::Compile::ExtensionHandler (class)">ExtensionHandler</a></span></tt>) <strong>initialize</strong>(**kvargs)
|
|
329
|
+
|
|
330
|
+
|
|
331
|
+
|
|
332
|
+
|
|
333
|
+
|
|
334
|
+
</h3><div class="docstring">
|
|
335
|
+
<div class="discussion">
|
|
336
|
+
|
|
337
|
+
<p>Parameters:</p>
|
|
338
|
+
|
|
339
|
+
<pre class="code ruby"><code class="ruby">extensions: An array of file extensions (without the leading dot)
|
|
340
|
+
that this ExtensionHandler supports.
|
|
341
|
+
|
|
342
|
+
usurps: Future.
|
|
343
|
+
Lets this ExtensionHandler take priority over other
|
|
344
|
+
ones. For example, most third-party handlers would
|
|
345
|
+
probably usurp the .apw NetLinx Studio workspace
|
|
346
|
+
extension.
|
|
347
|
+
|
|
348
|
+
is_a_workspace: Set to true if this ExtensionHandler is for
|
|
349
|
+
compiling a workspace. False by default. This
|
|
350
|
+
parameter assists with smart compiling, as
|
|
351
|
+
ExtensionDiscovery can return all workspace_handlers.
|
|
352
|
+
|
|
353
|
+
handler_class: A reference to the class that should be instantiated
|
|
354
|
+
if this handler is selected. For example,
|
|
355
|
+
NetLinx::SourceFile is the class that handles files
|
|
356
|
+
with the .axs extension.</code></pre>
|
|
357
|
+
|
|
358
|
+
|
|
359
|
+
</div>
|
|
360
|
+
</div>
|
|
361
|
+
<div class="tags">
|
|
362
|
+
|
|
363
|
+
|
|
364
|
+
</div><table class="source_code">
|
|
365
|
+
<tr>
|
|
366
|
+
<td>
|
|
367
|
+
<pre class="lines">
|
|
368
|
+
|
|
369
|
+
|
|
370
|
+
37
|
|
371
|
+
38
|
|
372
|
+
39
|
|
373
|
+
40
|
|
374
|
+
41
|
|
375
|
+
42</pre>
|
|
376
|
+
</td>
|
|
377
|
+
<td>
|
|
378
|
+
<pre class="code"><span class="info file"># File 'lib/netlinx/compile/extension_handler.rb', line 37</span>
|
|
379
|
+
|
|
380
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='op'>**</span><span class='id identifier rubyid_kvargs'>kvargs</span><span class='rparen'>)</span>
|
|
381
|
+
<span class='ivar'>@extensions</span> <span class='op'>=</span> <span class='id identifier rubyid_kvargs'>kvargs</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span> <span class='symbol'>:extensions</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
|
|
382
|
+
<span class='ivar'>@usurps</span> <span class='op'>=</span> <span class='id identifier rubyid_kvargs'>kvargs</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span> <span class='symbol'>:usurps</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
|
|
383
|
+
<span class='ivar'>@is_a_workspace</span> <span class='op'>=</span> <span class='id identifier rubyid_kvargs'>kvargs</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span> <span class='symbol'>:is_a_workspace</span><span class='comma'>,</span> <span class='kw'>false</span>
|
|
384
|
+
<span class='ivar'>@handler_class</span> <span class='op'>=</span> <span class='id identifier rubyid_kvargs'>kvargs</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span> <span class='symbol'>:handler_class</span><span class='comma'>,</span> <span class='kw'>nil</span>
|
|
385
|
+
<span class='kw'>end</span></pre>
|
|
386
|
+
</td>
|
|
387
|
+
</tr>
|
|
388
|
+
</table>
|
|
389
|
+
</div>
|
|
390
|
+
|
|
391
|
+
</div>
|
|
392
|
+
|
|
393
|
+
<div id="instance_attr_details" class="attr_details">
|
|
394
|
+
<h2>Instance Attribute Details</h2>
|
|
395
|
+
|
|
396
|
+
|
|
397
|
+
<span id="extensions=-instance_method"></span>
|
|
398
|
+
<div class="method_details first">
|
|
399
|
+
<h3 class="signature first" id="extensions-instance_method">
|
|
400
|
+
|
|
401
|
+
- (<tt>Object</tt>) <strong>extensions</strong>
|
|
402
|
+
|
|
403
|
+
|
|
404
|
+
|
|
405
|
+
|
|
406
|
+
|
|
407
|
+
</h3><div class="docstring">
|
|
408
|
+
<div class="discussion">
|
|
409
|
+
|
|
410
|
+
<p>A list of file extensions that this ExtensionHandler handles.</p>
|
|
411
|
+
|
|
412
|
+
|
|
413
|
+
</div>
|
|
414
|
+
</div>
|
|
415
|
+
<div class="tags">
|
|
416
|
+
|
|
417
|
+
|
|
418
|
+
</div><table class="source_code">
|
|
419
|
+
<tr>
|
|
420
|
+
<td>
|
|
421
|
+
<pre class="lines">
|
|
422
|
+
|
|
423
|
+
|
|
424
|
+
7
|
|
425
|
+
8
|
|
426
|
+
9</pre>
|
|
427
|
+
</td>
|
|
428
|
+
<td>
|
|
429
|
+
<pre class="code"><span class="info file"># File 'lib/netlinx/compile/extension_handler.rb', line 7</span>
|
|
430
|
+
|
|
431
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_extensions'>extensions</span>
|
|
432
|
+
<span class='ivar'>@extensions</span>
|
|
433
|
+
<span class='kw'>end</span></pre>
|
|
434
|
+
</td>
|
|
435
|
+
</tr>
|
|
436
|
+
</table>
|
|
437
|
+
</div>
|
|
438
|
+
|
|
439
|
+
|
|
440
|
+
<span id=""></span>
|
|
441
|
+
<div class="method_details ">
|
|
442
|
+
<h3 class="signature " id="handler_class-instance_method">
|
|
443
|
+
|
|
444
|
+
- (<tt>Object</tt>) <strong>handler_class</strong> <span class="extras">(readonly)</span>
|
|
445
|
+
|
|
446
|
+
|
|
447
|
+
|
|
448
|
+
|
|
449
|
+
|
|
450
|
+
</h3><div class="docstring">
|
|
451
|
+
<div class="discussion">
|
|
452
|
+
|
|
453
|
+
<p>The class to invoke to handle compiling a file extension specified in this
|
|
454
|
+
ExtensionHandler.</p>
|
|
455
|
+
|
|
456
|
+
|
|
457
|
+
</div>
|
|
458
|
+
</div>
|
|
459
|
+
<div class="tags">
|
|
460
|
+
|
|
461
|
+
|
|
462
|
+
</div><table class="source_code">
|
|
463
|
+
<tr>
|
|
464
|
+
<td>
|
|
465
|
+
<pre class="lines">
|
|
466
|
+
|
|
467
|
+
|
|
468
|
+
16
|
|
469
|
+
17
|
|
470
|
+
18</pre>
|
|
471
|
+
</td>
|
|
472
|
+
<td>
|
|
473
|
+
<pre class="code"><span class="info file"># File 'lib/netlinx/compile/extension_handler.rb', line 16</span>
|
|
474
|
+
|
|
475
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_handler_class'>handler_class</span>
|
|
476
|
+
<span class='ivar'>@handler_class</span>
|
|
477
|
+
<span class='kw'>end</span></pre>
|
|
478
|
+
</td>
|
|
479
|
+
</tr>
|
|
480
|
+
</table>
|
|
481
|
+
</div>
|
|
482
|
+
|
|
483
|
+
|
|
484
|
+
<span id="usurps=-instance_method"></span>
|
|
485
|
+
<div class="method_details ">
|
|
486
|
+
<h3 class="signature " id="usurps-instance_method">
|
|
487
|
+
|
|
488
|
+
- (<tt>Object</tt>) <strong>usurps</strong>
|
|
489
|
+
|
|
490
|
+
|
|
491
|
+
|
|
492
|
+
|
|
493
|
+
|
|
494
|
+
</h3><div class="docstring">
|
|
495
|
+
<div class="discussion">
|
|
496
|
+
|
|
497
|
+
<p>A list of file extensions that this ExtensionHandler usurps. For example,
|
|
498
|
+
third-party workspace extensions would probably usurp the .apw workspace
|
|
499
|
+
extension.</p>
|
|
500
|
+
|
|
501
|
+
|
|
502
|
+
</div>
|
|
503
|
+
</div>
|
|
504
|
+
<div class="tags">
|
|
505
|
+
|
|
506
|
+
|
|
507
|
+
</div><table class="source_code">
|
|
508
|
+
<tr>
|
|
509
|
+
<td>
|
|
510
|
+
<pre class="lines">
|
|
511
|
+
|
|
512
|
+
|
|
513
|
+
12
|
|
514
|
+
13
|
|
515
|
+
14</pre>
|
|
516
|
+
</td>
|
|
517
|
+
<td>
|
|
518
|
+
<pre class="code"><span class="info file"># File 'lib/netlinx/compile/extension_handler.rb', line 12</span>
|
|
519
|
+
|
|
520
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_usurps'>usurps</span>
|
|
521
|
+
<span class='ivar'>@usurps</span>
|
|
522
|
+
<span class='kw'>end</span></pre>
|
|
523
|
+
</td>
|
|
524
|
+
</tr>
|
|
525
|
+
</table>
|
|
526
|
+
</div>
|
|
527
|
+
|
|
528
|
+
</div>
|
|
529
|
+
|
|
530
|
+
|
|
531
|
+
<div id="instance_method_details" class="method_details_list">
|
|
532
|
+
<h2>Instance Method Details</h2>
|
|
533
|
+
|
|
534
|
+
|
|
535
|
+
<div class="method_details first">
|
|
536
|
+
<h3 class="signature first" id="<<-instance_method">
|
|
537
|
+
|
|
538
|
+
- (<tt>Object</tt>) <strong><<</strong>(file_extension)
|
|
539
|
+
|
|
540
|
+
|
|
541
|
+
|
|
542
|
+
|
|
543
|
+
|
|
544
|
+
</h3><div class="docstring">
|
|
545
|
+
<div class="discussion">
|
|
546
|
+
|
|
547
|
+
<p>Alias to add a file extension.</p>
|
|
548
|
+
|
|
549
|
+
|
|
550
|
+
</div>
|
|
551
|
+
</div>
|
|
552
|
+
<div class="tags">
|
|
553
|
+
|
|
554
|
+
|
|
555
|
+
</div><table class="source_code">
|
|
556
|
+
<tr>
|
|
557
|
+
<td>
|
|
558
|
+
<pre class="lines">
|
|
559
|
+
|
|
560
|
+
|
|
561
|
+
45
|
|
562
|
+
46
|
|
563
|
+
47</pre>
|
|
564
|
+
</td>
|
|
565
|
+
<td>
|
|
566
|
+
<pre class="code"><span class="info file"># File 'lib/netlinx/compile/extension_handler.rb', line 45</span>
|
|
567
|
+
|
|
568
|
+
<span class='kw'>def</span> <span class='op'><<</span><span class='lparen'>(</span><span class='id identifier rubyid_file_extension'>file_extension</span><span class='rparen'>)</span>
|
|
569
|
+
<span class='ivar'>@extensions</span> <span class='op'><<</span> <span class='id identifier rubyid_parse_extension'>parse_extension</span><span class='lparen'>(</span><span class='id identifier rubyid_file_extension'>file_extension</span><span class='rparen'>)</span>
|
|
570
|
+
<span class='kw'>end</span></pre>
|
|
571
|
+
</td>
|
|
572
|
+
</tr>
|
|
573
|
+
</table>
|
|
574
|
+
</div>
|
|
575
|
+
|
|
576
|
+
<div class="method_details ">
|
|
577
|
+
<h3 class="signature " id="include?-instance_method">
|
|
578
|
+
|
|
579
|
+
- (<tt>Boolean</tt>) <strong>include?</strong>(file_extension)
|
|
580
|
+
|
|
581
|
+
|
|
582
|
+
|
|
583
|
+
|
|
584
|
+
|
|
585
|
+
</h3><div class="docstring">
|
|
586
|
+
<div class="discussion">
|
|
587
|
+
|
|
588
|
+
<p>Returns true if this ExtensionHandler can handle the specified file
|
|
589
|
+
extension.</p>
|
|
590
|
+
|
|
591
|
+
|
|
592
|
+
</div>
|
|
593
|
+
</div>
|
|
594
|
+
<div class="tags">
|
|
595
|
+
|
|
596
|
+
<p class="tag_title">Returns:</p>
|
|
597
|
+
<ul class="return">
|
|
598
|
+
|
|
599
|
+
<li>
|
|
600
|
+
|
|
601
|
+
|
|
602
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
603
|
+
|
|
604
|
+
|
|
605
|
+
|
|
606
|
+
</li>
|
|
607
|
+
|
|
608
|
+
</ul>
|
|
609
|
+
|
|
610
|
+
</div><table class="source_code">
|
|
611
|
+
<tr>
|
|
612
|
+
<td>
|
|
613
|
+
<pre class="lines">
|
|
614
|
+
|
|
615
|
+
|
|
616
|
+
64
|
|
617
|
+
65
|
|
618
|
+
66</pre>
|
|
619
|
+
</td>
|
|
620
|
+
<td>
|
|
621
|
+
<pre class="code"><span class="info file"># File 'lib/netlinx/compile/extension_handler.rb', line 64</span>
|
|
622
|
+
|
|
623
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='id identifier rubyid_file_extension'>file_extension</span><span class='rparen'>)</span>
|
|
624
|
+
<span class='ivar'>@extensions</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span> <span class='id identifier rubyid_parse_extension'>parse_extension</span><span class='lparen'>(</span><span class='id identifier rubyid_file_extension'>file_extension</span><span class='rparen'>)</span>
|
|
625
|
+
<span class='kw'>end</span></pre>
|
|
626
|
+
</td>
|
|
627
|
+
</tr>
|
|
628
|
+
</table>
|
|
629
|
+
</div>
|
|
630
|
+
|
|
631
|
+
<div class="method_details ">
|
|
632
|
+
<h3 class="signature " id="is_a_workspace?-instance_method">
|
|
633
|
+
|
|
634
|
+
- (<tt>Boolean</tt>) <strong>is_a_workspace?</strong>
|
|
635
|
+
|
|
636
|
+
|
|
637
|
+
|
|
638
|
+
|
|
639
|
+
|
|
640
|
+
</h3><div class="docstring">
|
|
641
|
+
<div class="discussion">
|
|
642
|
+
|
|
643
|
+
<p>Returns true if the ExtensionHandler handles a workspace file (as opposed
|
|
644
|
+
to a source code file).</p>
|
|
645
|
+
|
|
646
|
+
<p>Workspace files are significant because they contain information about a
|
|
647
|
+
project, connection settings for a master, and possibly multiple systems
|
|
648
|
+
that need to be compiled. Therefore, when smart-compiling, workspaces need
|
|
649
|
+
to be distinguished from source code files because discovering a workspace
|
|
650
|
+
should be considered a better match than discovering a source code file.</p>
|
|
651
|
+
|
|
652
|
+
|
|
653
|
+
</div>
|
|
654
|
+
</div>
|
|
655
|
+
<div class="tags">
|
|
656
|
+
|
|
657
|
+
<p class="tag_title">Returns:</p>
|
|
658
|
+
<ul class="return">
|
|
659
|
+
|
|
660
|
+
<li>
|
|
661
|
+
|
|
662
|
+
|
|
663
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
664
|
+
|
|
665
|
+
|
|
666
|
+
|
|
667
|
+
</li>
|
|
668
|
+
|
|
669
|
+
</ul>
|
|
670
|
+
|
|
671
|
+
</div><table class="source_code">
|
|
672
|
+
<tr>
|
|
673
|
+
<td>
|
|
674
|
+
<pre class="lines">
|
|
675
|
+
|
|
676
|
+
|
|
677
|
+
58
|
|
678
|
+
59
|
|
679
|
+
60</pre>
|
|
680
|
+
</td>
|
|
681
|
+
<td>
|
|
682
|
+
<pre class="code"><span class="info file"># File 'lib/netlinx/compile/extension_handler.rb', line 58</span>
|
|
683
|
+
|
|
684
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_is_a_workspace?'>is_a_workspace?</span>
|
|
685
|
+
<span class='ivar'>@is_a_workspace</span>
|
|
686
|
+
<span class='kw'>end</span></pre>
|
|
687
|
+
</td>
|
|
688
|
+
</tr>
|
|
689
|
+
</table>
|
|
690
|
+
</div>
|
|
691
|
+
|
|
692
|
+
</div>
|
|
693
|
+
|
|
694
|
+
</div>
|
|
695
|
+
|
|
696
|
+
<div id="footer">
|
|
697
|
+
Generated on Mon Jan 26 15:35:29 2015 by
|
|
698
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
699
|
+
0.8.7.6 (ruby-2.1.5).
|
|
700
|
+
</div>
|
|
701
|
+
|
|
702
|
+
</body>
|
|
703
|
+
</html>
|