netlinx-compile 1.0.0 → 3.1.2

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 (84) hide show
  1. checksums.yaml +5 -5
  2. data/README.md +122 -0
  3. data/doc/NetLinx.html +130 -151
  4. data/doc/NetLinx/Compile.html +130 -148
  5. data/doc/NetLinx/Compile/Extension.html +128 -145
  6. data/doc/NetLinx/Compile/Extension/AXS.html +218 -154
  7. data/doc/NetLinx/Compile/ExtensionDiscovery.html +524 -321
  8. data/doc/NetLinx/Compile/ExtensionHandler.html +755 -396
  9. data/doc/NetLinx/Compile/Script.html +431 -282
  10. data/doc/NetLinx/Compiler.html +496 -285
  11. data/doc/NetLinx/CompilerResult.html +1250 -498
  12. data/doc/NetLinx/NoCompilerError.html +142 -155
  13. data/doc/NetLinx/Rake.html +115 -0
  14. data/doc/NetLinx/Rake/Compile.html +358 -0
  15. data/doc/NetLinx/SourceFile.html +702 -423
  16. data/doc/_index.html +234 -0
  17. data/doc/class_list.html +51 -0
  18. data/doc/css/common.css +1 -0
  19. data/doc/css/full_list.css +58 -0
  20. data/doc/css/style.css +496 -0
  21. data/doc/file.README.html +156 -0
  22. data/doc/file.license.html +70 -0
  23. data/doc/file_list.html +61 -0
  24. data/doc/frames.html +17 -0
  25. data/doc/index.html +156 -103
  26. data/doc/js/app.js +314 -0
  27. data/doc/js/full_list.js +216 -0
  28. data/doc/js/jquery.js +4 -18
  29. data/doc/method_list.html +339 -0
  30. data/doc/top-level-namespace.html +110 -0
  31. data/lib/netlinx-compile.rb +11 -1
  32. data/lib/netlinx/compile/extension_discovery.rb +4 -2
  33. data/lib/netlinx/compile/extension_handler.rb +23 -25
  34. data/lib/netlinx/compile/script.rb +4 -3
  35. data/lib/netlinx/compiler.rb +45 -21
  36. data/lib/netlinx/compiler_result.rb +16 -17
  37. data/lib/netlinx/rake/compile.rb +4 -0
  38. data/lib/netlinx/rake/compile/compile.rb +34 -0
  39. data/lib/netlinx/source_file.rb +20 -14
  40. data/lib/test/netlinx/compilable.rb +13 -48
  41. data/lib/test/netlinx/compile/discoverable.rb +3 -14
  42. data/lib/test/netlinx/compile/invokable.rb +3 -15
  43. data/license.txt +1 -1
  44. metadata +114 -74
  45. data/README.txt +0 -2
  46. data/doc/Test.html +0 -147
  47. data/doc/Test/NetLinx.html +0 -147
  48. data/doc/Test/NetLinx/Compilable.html +0 -148
  49. data/doc/Test/NetLinx/Compile.html +0 -146
  50. data/doc/Test/NetLinx/Compile/Discoverable.html +0 -148
  51. data/doc/Test/NetLinx/Compile/Invokable.html +0 -149
  52. data/doc/created.rid +0 -12
  53. data/doc/images/add.png +0 -0
  54. data/doc/images/arrow_up.png +0 -0
  55. data/doc/images/brick.png +0 -0
  56. data/doc/images/brick_link.png +0 -0
  57. data/doc/images/bug.png +0 -0
  58. data/doc/images/bullet_black.png +0 -0
  59. data/doc/images/bullet_toggle_minus.png +0 -0
  60. data/doc/images/bullet_toggle_plus.png +0 -0
  61. data/doc/images/date.png +0 -0
  62. data/doc/images/delete.png +0 -0
  63. data/doc/images/find.png +0 -0
  64. data/doc/images/loadingAnimation.gif +0 -0
  65. data/doc/images/macFFBgHack.png +0 -0
  66. data/doc/images/package.png +0 -0
  67. data/doc/images/page_green.png +0 -0
  68. data/doc/images/page_white_text.png +0 -0
  69. data/doc/images/page_white_width.png +0 -0
  70. data/doc/images/plugin.png +0 -0
  71. data/doc/images/ruby.png +0 -0
  72. data/doc/images/tag_blue.png +0 -0
  73. data/doc/images/tag_green.png +0 -0
  74. data/doc/images/transparent.png +0 -0
  75. data/doc/images/wrench.png +0 -0
  76. data/doc/images/wrench_orange.png +0 -0
  77. data/doc/images/zoom.png +0 -0
  78. data/doc/js/darkfish.js +0 -155
  79. data/doc/js/navigation.js +0 -142
  80. data/doc/js/search.js +0 -94
  81. data/doc/js/search_index.js +0 -1
  82. data/doc/js/searcher.js +0 -228
  83. data/doc/rdoc.css +0 -595
  84. data/doc/table_of_contents.html +0 -138
@@ -1,501 +1,1253 @@
1
- <!DOCTYPE html>
2
-
3
- <html>
4
- <head>
5
- <meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
6
-
7
- <title>class NetLinx::CompilerResult - RDoc Documentation</title>
8
-
9
- <link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet">
10
-
11
- <script type="text/javascript">
12
- var rdoc_rel_prefix = "../";
13
- </script>
14
-
15
- <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
16
- <script type="text/javascript" charset="utf-8" src="../js/navigation.js"></script>
17
- <script type="text/javascript" charset="utf-8" src="../js/search_index.js"></script>
18
- <script type="text/javascript" charset="utf-8" src="../js/search.js"></script>
19
- <script type="text/javascript" charset="utf-8" src="../js/searcher.js"></script>
20
- <script type="text/javascript" charset="utf-8" src="../js/darkfish.js"></script>
21
-
22
-
23
- <body id="top" class="class">
24
- <nav id="metadata">
25
- <nav id="home-section" class="section">
26
- <h3 class="section-header">
27
- <a href="../index.html">Home</a>
28
- <a href="../table_of_contents.html#classes">Classes</a>
29
- <a href="../table_of_contents.html#methods">Methods</a>
30
- </h3>
31
- </nav>
32
-
33
-
34
- <nav id="search-section" class="section project-section" class="initially-hidden">
35
- <form action="#" method="get" accept-charset="utf-8">
36
- <h3 class="section-header">
37
- <input type="text" name="search" placeholder="Search" id="search-field"
38
- title="Type to search, Up and Down to navigate, Enter to load">
39
- </h3>
40
- </form>
41
-
42
- <ul id="search-results" class="initially-hidden"></ul>
43
- </nav>
44
-
45
-
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
+ Class: NetLinx::CompilerResult
8
+
9
+ &mdash; Documentation by YARD 0.9.25
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../css/style.css" type="text/css" />
14
+
15
+ <link rel="stylesheet" href="../css/common.css" type="text/css" />
16
+
17
+ <script type="text/javascript">
18
+ pathId = "NetLinx::CompilerResult";
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 (C)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../NetLinx.html" title="NetLinx (module)">NetLinx</a></span></span>
41
+ &raquo;
42
+ <span class="title">CompilerResult</span>
43
+
44
+ </div>
45
+
46
+ <div id="search">
47
+
48
+ <a class="full_list_link" id="class_list_link"
49
+ href="../class_list.html">
50
+
51
+ <svg width="24" height="24">
52
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55
+ </svg>
56
+ </a>
57
+
58
+ </div>
59
+ <div class="clear"></div>
60
+ </div>
61
+
62
+ <div id="content"><h1>Class: NetLinx::CompilerResult
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+ <dl>
70
+ <dt>Inherits:</dt>
71
+ <dd>
72
+ <span class="inheritName">Object</span>
73
+
74
+ <ul class="fullTree">
75
+ <li>Object</li>
76
+
77
+ <li class="next">NetLinx::CompilerResult</li>
78
+
79
+ </ul>
80
+ <a href="#" class="inheritanceTree">show all</a>
81
+
82
+ </dd>
83
+ </dl>
84
+
85
+
86
+
87
+
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+ <dl>
96
+ <dt>Defined in:</dt>
97
+ <dd>lib/netlinx/compiler_result.rb</dd>
98
+ </dl>
99
+
100
+ </div>
101
+
102
+ <h2>Overview</h2><div class="docstring">
103
+ <div class="discussion">
104
+
105
+ <p>Contains info pertaining to a job run through the compiler.</p>
106
+
107
+
108
+ </div>
109
+ </div>
110
+ <div class="tags">
111
+
112
+
113
+ </div>
114
+
115
+
116
+
117
+ <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
118
+ <ul class="summary">
119
+
120
+ <li class="public ">
121
+ <span class="summary_signature">
122
+
123
+ <a href="#compiler_include_paths-instance_method" title="#compiler_include_paths (instance method)">#<strong>compiler_include_paths</strong> &#x21d2; Object </a>
124
+
125
+
126
+
127
+ </span>
128
+
129
+
130
+
131
+
132
+ <span class="note title readonly">readonly</span>
133
+
134
+
135
+
136
+
137
+
138
+
139
+
140
+
141
+
142
+ <span class="summary_desc"><div class='inline'>
143
+ <p>See Compilable interface.</p>
144
+ </div></span>
145
+
146
+ </li>
147
+
148
+
149
+ <li class="public ">
150
+ <span class="summary_signature">
151
+
152
+ <a href="#compiler_library_paths-instance_method" title="#compiler_library_paths (instance method)">#<strong>compiler_library_paths</strong> &#x21d2; Object </a>
153
+
154
+
155
+
156
+ </span>
157
+
158
+
159
+
160
+
161
+ <span class="note title readonly">readonly</span>
162
+
163
+
164
+
165
+
166
+
167
+
168
+
169
+
170
+
171
+ <span class="summary_desc"><div class='inline'>
172
+ <p>See Compilable interface.</p>
173
+ </div></span>
174
+
175
+ </li>
176
+
177
+
178
+ <li class="public ">
179
+ <span class="summary_signature">
180
+
181
+ <a href="#compiler_module_paths-instance_method" title="#compiler_module_paths (instance method)">#<strong>compiler_module_paths</strong> &#x21d2; Object </a>
182
+
183
+
184
+
185
+ </span>
186
+
187
+
188
+
189
+
190
+ <span class="note title readonly">readonly</span>
191
+
192
+
193
+
194
+
195
+
196
+
197
+
198
+
199
+
200
+ <span class="summary_desc"><div class='inline'>
201
+ <p>See Compilable interface.</p>
202
+ </div></span>
203
+
204
+ </li>
205
+
206
+
207
+ <li class="public ">
208
+ <span class="summary_signature">
209
+
210
+ <a href="#compiler_target_files-instance_method" title="#compiler_target_files (instance method)">#<strong>compiler_target_files</strong> &#x21d2; Object </a>
211
+
212
+
213
+
214
+ </span>
215
+
216
+
217
+
218
+
219
+ <span class="note title readonly">readonly</span>
220
+
221
+
222
+
223
+
224
+
225
+
226
+
227
+
228
+
229
+ <span class="summary_desc"><div class='inline'>
230
+ <p>See Compilable interface.</p>
231
+ </div></span>
232
+
233
+ </li>
234
+
235
+
236
+ <li class="public ">
237
+ <span class="summary_signature">
238
+
239
+ <a href="#errors-instance_method" title="#errors (instance method)">#<strong>errors</strong> &#x21d2; Object </a>
240
+
241
+
242
+
243
+ </span>
244
+
245
+
246
+
247
+
248
+ <span class="note title readonly">readonly</span>
249
+
250
+
251
+
252
+
253
+
254
+
255
+
256
+
257
+
258
+ <span class="summary_desc"><div class='inline'>
259
+ <p>Number of compiler errors.</p>
260
+ </div></span>
261
+
262
+ </li>
263
+
264
+
265
+ <li class="public ">
266
+ <span class="summary_signature">
267
+
268
+ <a href="#stream-instance_method" title="#stream (instance method)">#<strong>stream</strong> &#x21d2; Object </a>
269
+
270
+
271
+
272
+ </span>
273
+
274
+
275
+
276
+
277
+ <span class="note title readonly">readonly</span>
278
+
279
+
280
+
281
+
282
+
283
+
284
+
285
+
286
+
287
+ <span class="summary_desc"><div class='inline'>
288
+ <p>The raw stream of text returned by the compiler.</p>
289
+ </div></span>
290
+
291
+ </li>
292
+
293
+
294
+ <li class="public ">
295
+ <span class="summary_signature">
296
+
297
+ <a href="#warnings-instance_method" title="#warnings (instance method)">#<strong>warnings</strong> &#x21d2; Object </a>
298
+
299
+
300
+
301
+ </span>
302
+
303
+
304
+
305
+
306
+ <span class="note title readonly">readonly</span>
307
+
308
+
309
+
310
+
311
+
312
+
313
+
314
+
315
+
316
+ <span class="summary_desc"><div class='inline'>
317
+ <p>Number of compiler warnings.</p>
318
+ </div></span>
319
+
320
+ </li>
321
+
322
+
323
+ </ul>
324
+
325
+
326
+
327
+
328
+
329
+ <h2>
330
+ Instance Method Summary
331
+ <small><a href="#" class="summary_toggle">collapse</a></small>
332
+ </h2>
333
+
334
+ <ul class="summary">
335
+
336
+ <li class="public ">
337
+ <span class="summary_signature">
338
+
339
+ <a href="#error_items-instance_method" title="#error_items (instance method)">#<strong>error_items</strong> &#x21d2; Array&lt;String&gt; </a>
340
+
341
+
342
+
343
+ </span>
344
+
345
+
346
+
347
+
348
+
349
+
350
+
351
+
352
+
353
+ <span class="summary_desc"><div class='inline'>
354
+ <p>A list of errors.</p>
355
+ </div></span>
356
+
357
+ </li>
358
+
359
+
360
+ <li class="public ">
361
+ <span class="summary_signature">
362
+
363
+ <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(**kwargs) &#x21d2; CompilerResult </a>
364
+
365
+
366
+
367
+ </span>
368
+
369
+
370
+ <span class="note title constructor">constructor</span>
371
+
372
+
373
+
374
+
375
+
376
+
377
+
378
+
379
+ <span class="summary_desc"><div class='inline'>
380
+ <p>A new instance of CompilerResult.</p>
381
+ </div></span>
382
+
383
+ </li>
384
+
385
+
386
+ <li class="public ">
387
+ <span class="summary_signature">
388
+
389
+ <a href="#success%3F-instance_method" title="#success? (instance method)">#<strong>success?</strong> &#x21d2; Boolean </a>
390
+
391
+
392
+
393
+ </span>
394
+
395
+
396
+
397
+
398
+
399
+
400
+
401
+
402
+
403
+ <span class="summary_desc"><div class='inline'>
404
+ <p>True if compile was successful.</p>
405
+ </div></span>
406
+
407
+ </li>
408
+
409
+
410
+ <li class="public ">
411
+ <span class="summary_signature">
412
+
413
+ <a href="#target_file-instance_method" title="#target_file (instance method)">#<strong>target_file</strong> &#x21d2; String </a>
414
+
415
+
416
+
417
+ </span>
418
+
419
+
420
+
421
+
422
+
423
+
424
+
425
+
426
+
427
+ <span class="summary_desc"><div class='inline'>
428
+ <p>The absolute path of the source code file that was compiled.</p>
429
+ </div></span>
430
+
431
+ </li>
432
+
433
+
434
+ <li class="public ">
435
+ <span class="summary_signature">
436
+
437
+ <a href="#to_s-instance_method" title="#to_s (instance method)">#<strong>to_s</strong> &#x21d2; Object </a>
438
+
439
+
440
+
441
+ </span>
442
+
443
+
444
+
445
+
446
+
447
+
448
+
449
+
450
+
451
+ <span class="summary_desc"><div class='inline'>
452
+ <p>Alias of <span class='object_link'><a href="#stream-instance_method" title="NetLinx::CompilerResult#stream (method)">#stream</a></span>.</p>
453
+ </div></span>
454
+
455
+ </li>
456
+
457
+
458
+ <li class="public ">
459
+ <span class="summary_signature">
460
+
461
+ <a href="#warning_items-instance_method" title="#warning_items (instance method)">#<strong>warning_items</strong> &#x21d2; Array&lt;String&gt; </a>
462
+
463
+
464
+
465
+ </span>
466
+
467
+
468
+
469
+
470
+
471
+
472
+
473
+
474
+
475
+ <span class="summary_desc"><div class='inline'>
476
+ <p>A list of warnings.</p>
477
+ </div></span>
478
+
479
+ </li>
480
+
481
+
482
+ </ul>
483
+
484
+
485
+ <div id="constructor_details" class="method_details_list">
486
+ <h2>Constructor Details</h2>
487
+
488
+ <div class="method_details first">
489
+ <h3 class="signature first" id="initialize-instance_method">
490
+
491
+ #<strong>initialize</strong>(**kwargs) &#x21d2; <tt><span class='object_link'><a href="" title="NetLinx::CompilerResult (class)">CompilerResult</a></span></tt>
492
+
493
+
494
+
495
+
496
+
497
+ </h3><div class="docstring">
498
+ <div class="discussion">
499
+
500
+ <p>Returns a new instance of CompilerResult.</p>
501
+
502
+
503
+ </div>
504
+ </div>
505
+ <div class="tags">
506
+ <p class="tag_title">Parameters:</p>
507
+ <ul class="param">
508
+
509
+ <li>
510
+
511
+ <span class='name'>kwargs</span>
512
+
513
+
514
+ <span class='type'>(<tt>Hash</tt>)</span>
515
+
516
+
517
+
518
+ &mdash;
519
+ <div class='inline'>
520
+ <p>a customizable set of options</p>
521
+ </div>
522
+
523
+ </li>
524
+
525
+ </ul>
526
+
527
+
528
+
529
+
530
+ <p class="tag_title">Options Hash (<tt>**kwargs</tt>):</p>
531
+ <ul class="option">
532
+
533
+ <li>
534
+ <span class="name">:stream</span>
535
+ <span class="type">(<tt>String</tt>)</span>
536
+ <span class="default">
537
+
538
+ </span>
539
+
540
+ &mdash; <div class='inline'>
541
+ <p>The raw stream of text returned by the compiler.</p>
542
+ </div>
543
+
544
+ </li>
545
+
546
+ <li>
547
+ <span class="name">:compiler_target_files</span>
548
+ <span class="type">(<tt>Array&lt;String&gt;</tt>)</span>
549
+ <span class="default">
550
+
551
+ </span>
552
+
553
+ &mdash; <div class='inline'>
554
+ <p>See Compilable interface.</p>
555
+ </div>
556
+
557
+ </li>
558
+
559
+ <li>
560
+ <span class="name">:compiler_include_paths</span>
561
+ <span class="type">(<tt>Array&lt;String&gt;</tt>)</span>
562
+ <span class="default">
563
+
564
+ </span>
565
+
566
+ &mdash; <div class='inline'>
567
+ <p>See Compilable interface.</p>
568
+ </div>
569
+
570
+ </li>
571
+
572
+ <li>
573
+ <span class="name">:compiler_module_paths</span>
574
+ <span class="type">(<tt>Array&lt;String&gt;</tt>)</span>
575
+ <span class="default">
576
+
577
+ </span>
578
+
579
+ &mdash; <div class='inline'>
580
+ <p>See Compilable interface.</p>
581
+ </div>
582
+
583
+ </li>
584
+
585
+ <li>
586
+ <span class="name">:compiler_library_paths</span>
587
+ <span class="type">(<tt>Array&lt;String&gt;</tt>)</span>
588
+ <span class="default">
589
+
590
+ </span>
591
+
592
+ &mdash; <div class='inline'>
593
+ <p>See Compilable interface.</p>
594
+ </div>
595
+
596
+ </li>
597
+
598
+ </ul>
599
+
600
+
601
+
602
+ </div><table class="source_code">
603
+ <tr>
604
+ <td>
605
+ <pre class="lines">
606
+
607
+
608
+ 27
609
+ 28
610
+ 29
611
+ 30
612
+ 31
613
+ 32
614
+ 33
615
+ 34
616
+ 35
617
+ 36
618
+ 37
619
+ 38
620
+ 39
621
+ 40
622
+ 41
623
+ 42
624
+ 43</pre>
625
+ </td>
626
+ <td>
627
+ <pre class="code"><span class="info file"># File 'lib/netlinx/compiler_result.rb', line 27</span>
628
+
629
+ <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_kwargs'>kwargs</span><span class='rparen'>)</span>
630
+ <span class='ivar'>@stream</span> <span class='op'>=</span> <span class='id identifier rubyid_kwargs'>kwargs</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span> <span class='symbol'>:stream</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span>
46
631
 
47
-
48
- <div id="file-metadata">
49
- <nav id="file-list-section" class="section">
50
- <h3 class="section-header">Defined In</h3>
51
- <ul>
52
- <li>lib/netlinx/compiler_result.rb
53
- </ul>
54
- </nav>
55
-
56
-
57
- </div>
58
-
59
- <div id="class-metadata">
60
-
61
- <nav id="parent-class-section" class="section">
62
- <h3 class="section-header">Parent</h3>
632
+ <span class='ivar'>@compiler_target_files</span> <span class='op'>=</span> <span class='id identifier rubyid_kwargs'>kwargs</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span> <span class='symbol'>:compiler_target_files</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
633
+ <span class='ivar'>@compiler_include_paths</span> <span class='op'>=</span> <span class='id identifier rubyid_kwargs'>kwargs</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span> <span class='symbol'>:compiler_include_paths</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
634
+ <span class='ivar'>@compiler_module_paths</span> <span class='op'>=</span> <span class='id identifier rubyid_kwargs'>kwargs</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span> <span class='symbol'>:compiler_module_paths</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
635
+ <span class='ivar'>@compiler_library_paths</span> <span class='op'>=</span> <span class='id identifier rubyid_kwargs'>kwargs</span><span class='period'>.</span><span class='id identifier rubyid_fetch'>fetch</span> <span class='symbol'>:compiler_library_paths</span><span class='comma'>,</span> <span class='lbracket'>[</span><span class='rbracket'>]</span>
63
636
 
64
- <p class="link">Object
637
+ <span class='comment'># Capture error and warning counts.
638
+ </span> <span class='ivar'>@errors</span> <span class='op'>=</span> <span class='kw'>nil</span>
639
+ <span class='ivar'>@warnings</span> <span class='op'>=</span> <span class='kw'>nil</span>
65
640
 
66
- </nav>
67
-
68
-
69
-
70
- <!-- Method Quickref -->
71
- <nav id="method-list-section" class="section">
72
- <h3 class="section-header">Methods</h3>
73
-
74
- <ul class="link-list">
75
-
76
- <li ><a href="#method-c-new">::new</a>
77
-
78
- <li ><a href="#method-i-error_items">#error_items</a>
79
-
80
- <li ><a href="#method-i-success-3F">#success?</a>
81
-
82
- <li ><a href="#method-i-target_file">#target_file</a>
83
-
84
- <li ><a href="#method-i-to_s">#to_s</a>
85
-
86
- <li ><a href="#method-i-warning_items">#warning_items</a>
87
-
88
- </ul>
89
- </nav>
90
-
91
- </div>
92
-
93
- <div id="project-metadata">
94
-
95
- <nav id="classindex-section" class="section project-section">
96
- <h3 class="section-header">Class and Module Index</h3>
97
-
98
- <ul class="link-list">
99
-
100
- <li><a href="../NetLinx.html">NetLinx</a>
101
-
102
- <li><a href="../NetLinx/Compile.html">NetLinx::Compile</a>
103
-
104
- <li><a href="../NetLinx/Compile/Extension.html">NetLinx::Compile::Extension</a>
105
-
106
- <li><a href="../NetLinx/Compile/Extension/AXS.html">NetLinx::Compile::Extension::AXS</a>
107
-
108
- <li><a href="../NetLinx/Compile/ExtensionDiscovery.html">NetLinx::Compile::ExtensionDiscovery</a>
109
-
110
- <li><a href="../NetLinx/Compile/ExtensionHandler.html">NetLinx::Compile::ExtensionHandler</a>
111
-
112
- <li><a href="../NetLinx/Compile/Script.html">NetLinx::Compile::Script</a>
113
-
114
- <li><a href="../NetLinx/Compiler.html">NetLinx::Compiler</a>
115
-
116
- <li><a href="../NetLinx/CompilerResult.html">NetLinx::CompilerResult</a>
117
-
118
- <li><a href="../NetLinx/NoCompilerError.html">NetLinx::NoCompilerError</a>
119
-
120
- <li><a href="../NetLinx/SourceFile.html">NetLinx::SourceFile</a>
121
-
122
- <li><a href="../Test.html">Test</a>
123
-
124
- <li><a href="../Test/NetLinx.html">Test::NetLinx</a>
125
-
126
- <li><a href="../Test/NetLinx/Compilable.html">Test::NetLinx::Compilable</a>
127
-
128
- <li><a href="../Test/NetLinx/Compile.html">Test::NetLinx::Compile</a>
129
-
130
- <li><a href="../Test/NetLinx/Compile/Discoverable.html">Test::NetLinx::Compile::Discoverable</a>
131
-
132
- <li><a href="../Test/NetLinx/Compile/Invokable.html">Test::NetLinx::Compile::Invokable</a>
133
-
134
- </ul>
135
- </nav>
136
-
137
- </div>
138
- </nav>
139
-
140
- <div id="documentation">
141
- <h1 class="class">class NetLinx::CompilerResult</h1>
142
-
143
- <div id="description" class="description">
144
-
145
- <p>Contains info pertaining to a job run through the compiler.</p>
146
-
147
- </div><!-- description -->
148
-
149
-
150
-
151
-
152
- <section id="5Buntitled-5D" class="documentation-section">
153
-
154
-
155
-
156
-
157
-
158
-
159
-
160
- <!-- Attributes -->
161
- <section id="attribute-method-details" class="method-section section">
162
- <h3 class="section-header">Attributes</h3>
163
-
164
-
165
- <div id="attribute-i-compiler_include_paths" class="method-detail">
166
- <div class="method-heading attribute-method-heading">
167
- <span class="method-name">compiler_include_paths</span><span
168
- class="attribute-access-type">[R]</span>
169
- </div>
170
-
171
- <div class="method-description">
172
-
173
- <p>See Compilable interface.</p>
174
-
175
- </div>
176
- </div>
177
-
178
- <div id="attribute-i-compiler_library_paths" class="method-detail">
179
- <div class="method-heading attribute-method-heading">
180
- <span class="method-name">compiler_library_paths</span><span
181
- class="attribute-access-type">[R]</span>
182
- </div>
183
-
184
- <div class="method-description">
185
-
186
- <p>See Compilable interface.</p>
187
-
188
- </div>
189
- </div>
190
-
191
- <div id="attribute-i-compiler_module_paths" class="method-detail">
192
- <div class="method-heading attribute-method-heading">
193
- <span class="method-name">compiler_module_paths</span><span
194
- class="attribute-access-type">[R]</span>
195
- </div>
196
-
197
- <div class="method-description">
198
-
199
- <p>See Compilable interface.</p>
200
-
201
- </div>
202
- </div>
203
-
204
- <div id="attribute-i-compiler_target_files" class="method-detail">
205
- <div class="method-heading attribute-method-heading">
206
- <span class="method-name">compiler_target_files</span><span
207
- class="attribute-access-type">[R]</span>
208
- </div>
209
-
210
- <div class="method-description">
211
-
212
- <p>See Compilable interface.</p>
213
-
214
- </div>
215
- </div>
216
-
217
- <div id="attribute-i-errors" class="method-detail">
218
- <div class="method-heading attribute-method-heading">
219
- <span class="method-name">errors</span><span
220
- class="attribute-access-type">[R]</span>
221
- </div>
222
-
223
- <div class="method-description">
224
-
225
- <p>Number of compiler errors.</p>
226
-
227
- </div>
228
- </div>
229
-
230
- <div id="attribute-i-stream" class="method-detail">
231
- <div class="method-heading attribute-method-heading">
232
- <span class="method-name">stream</span><span
233
- class="attribute-access-type">[R]</span>
234
- </div>
235
-
236
- <div class="method-description">
237
-
238
- <p>The raw stream of text returned by the compiler.</p>
239
-
240
- </div>
241
- </div>
242
-
243
- <div id="attribute-i-warnings" class="method-detail">
244
- <div class="method-heading attribute-method-heading">
245
- <span class="method-name">warnings</span><span
246
- class="attribute-access-type">[R]</span>
247
- </div>
248
-
249
- <div class="method-description">
250
-
251
- <p>Number of compiler warnings.</p>
252
-
253
- </div>
254
- </div>
255
-
256
- </section><!-- attribute-method-details -->
257
-
258
-
259
- <!-- Methods -->
260
-
261
- <section id="public-class-5Buntitled-5D-method-details" class="method-section section">
262
- <h3 class="section-header">Public Class Methods</h3>
263
-
264
-
265
- <div id="method-c-new" class="method-detail ">
266
-
267
- <div class="method-heading">
268
- <span class="method-name">new</span><span
269
- class="method-args">(**kvargs)</span>
270
-
271
- <span class="method-click-advice">click to toggle source</span>
272
-
273
- </div>
274
-
275
-
276
- <div class="method-description">
277
-
278
- <p>Args:</p>
279
-
280
- <pre>stream -- The raw stream of text returned by the compiler.
281
- compiler_target_files -- See Compilable interface.
282
- compiler_include_paths -- See Compilable interface.
283
- compiler_module_paths -- See Compilable interface.
284
- compiler_library_paths -- See Compilable interface.</pre>
285
-
286
-
287
-
288
-
289
- <div class="method-source-code" id="new-source">
290
- <pre><span class="ruby-comment"># File lib/netlinx/compiler_result.rb, line 28</span>
291
- <span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-operator">**</span><span class="ruby-identifier">kvargs</span>)
292
- <span class="ruby-ivar">@stream</span> = <span class="ruby-identifier">kvargs</span>.<span class="ruby-identifier">fetch</span> <span class="ruby-value">:stream</span>, <span class="ruby-string">&#39;&#39;</span>
293
-
294
- <span class="ruby-ivar">@compiler_target_files</span> = <span class="ruby-identifier">kvargs</span>.<span class="ruby-identifier">fetch</span> <span class="ruby-value">:compiler_target_files</span>, []
295
- <span class="ruby-ivar">@compiler_include_paths</span> = <span class="ruby-identifier">kvargs</span>.<span class="ruby-identifier">fetch</span> <span class="ruby-value">:compiler_include_paths</span>, []
296
- <span class="ruby-ivar">@compiler_module_paths</span> = <span class="ruby-identifier">kvargs</span>.<span class="ruby-identifier">fetch</span> <span class="ruby-value">:compiler_module_paths</span>, []
297
- <span class="ruby-ivar">@compiler_library_paths</span> = <span class="ruby-identifier">kvargs</span>.<span class="ruby-identifier">fetch</span> <span class="ruby-value">:compiler_library_paths</span>, []
298
-
299
- <span class="ruby-comment"># Capture error and warning counts.</span>
300
- <span class="ruby-ivar">@errors</span> = <span class="ruby-keyword">nil</span>
301
- <span class="ruby-ivar">@warnings</span> = <span class="ruby-keyword">nil</span>
302
-
303
- <span class="ruby-ivar">@stream</span>.<span class="ruby-identifier">scan</span> <span class="ruby-regexp">/(\d+) error\(s\), (\d+) warning\(s\)/</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">e</span>, <span class="ruby-identifier">w</span><span class="ruby-operator">|</span>
304
- <span class="ruby-ivar">@errors</span> = <span class="ruby-identifier">e</span>.<span class="ruby-identifier">to_i</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">e</span>
305
- <span class="ruby-ivar">@warnings</span> = <span class="ruby-identifier">w</span>.<span class="ruby-identifier">to_i</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">w</span>
306
- <span class="ruby-keyword">end</span>
307
- <span class="ruby-keyword">end</span></pre>
308
- </div><!-- new-source -->
309
-
310
- </div>
311
-
312
-
313
-
314
-
315
- </div><!-- new-method -->
316
-
317
-
318
- </section><!-- public-class-method-details -->
319
-
320
- <section id="public-instance-5Buntitled-5D-method-details" class="method-section section">
321
- <h3 class="section-header">Public Instance Methods</h3>
322
-
323
-
324
- <div id="method-i-error_items" class="method-detail ">
325
-
326
- <div class="method-heading">
327
- <span class="method-name">error_items</span><span
328
- class="method-args">()</span>
329
-
330
- <span class="method-click-advice">click to toggle source</span>
331
-
332
- </div>
333
-
334
-
335
- <div class="method-description">
336
-
337
- <p>An enumerable list of errors.</p>
338
-
339
-
340
-
341
-
342
- <div class="method-source-code" id="error_items-source">
343
- <pre><span class="ruby-comment"># File lib/netlinx/compiler_result.rb, line 67</span>
344
- <span class="ruby-keyword">def</span> <span class="ruby-identifier">error_items</span>
345
- <span class="ruby-ivar">@stream</span>.<span class="ruby-identifier">scan</span>(<span class="ruby-regexp">/(^ERROR: .*$)/</span>).<span class="ruby-identifier">map</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">i</span><span class="ruby-operator">|</span> <span class="ruby-identifier">i</span>.<span class="ruby-identifier">first</span>}
346
- <span class="ruby-keyword">end</span></pre>
347
- </div><!-- error_items-source -->
348
-
349
- </div>
350
-
351
-
352
-
353
-
354
- </div><!-- error_items-method -->
355
-
356
-
357
- <div id="method-i-success-3F" class="method-detail ">
358
-
359
- <div class="method-heading">
360
- <span class="method-name">success?</span><span
361
- class="method-args">()</span>
362
-
363
- <span class="method-click-advice">click to toggle source</span>
364
-
365
- </div>
366
-
367
-
368
- <div class="method-description">
369
-
370
- <p><a href="Compile.html">Compile</a> was successful?</p>
371
-
372
-
373
-
374
-
375
- <div class="method-source-code" id="success-3F-source">
376
- <pre><span class="ruby-comment"># File lib/netlinx/compiler_result.rb, line 57</span>
377
- <span class="ruby-keyword">def</span> <span class="ruby-identifier">success?</span>
378
- <span class="ruby-ivar">@errors</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-ivar">@warnings</span> <span class="ruby-operator">==</span> <span class="ruby-value">0</span>
379
- <span class="ruby-keyword">end</span></pre>
380
- </div><!-- success-3F-source -->
381
-
382
- </div>
383
-
384
-
385
-
386
-
387
- </div><!-- success-3F-method -->
388
-
389
-
390
- <div id="method-i-target_file" class="method-detail ">
391
-
392
- <div class="method-heading">
393
- <span class="method-name">target_file</span><span
394
- class="method-args">()</span>
395
-
396
- <span class="method-click-advice">click to toggle source</span>
397
-
398
- </div>
399
-
400
-
401
- <div class="method-description">
402
-
403
- <p>Returns the absolute path of the source code file that was compiled.</p>
404
-
405
-
406
-
407
-
408
- <div class="method-source-code" id="target_file-source">
409
- <pre><span class="ruby-comment"># File lib/netlinx/compiler_result.rb, line 52</span>
410
- <span class="ruby-keyword">def</span> <span class="ruby-identifier">target_file</span>
411
- <span class="ruby-ivar">@compiler_target_files</span>.<span class="ruby-identifier">first</span>
412
- <span class="ruby-keyword">end</span></pre>
413
- </div><!-- target_file-source -->
414
-
415
- </div>
416
-
417
-
418
-
419
-
420
- </div><!-- target_file-method -->
421
-
422
-
423
- <div id="method-i-to_s" class="method-detail ">
424
-
425
- <div class="method-heading">
426
- <span class="method-name">to_s</span><span
427
- class="method-args">()</span>
428
-
429
- <span class="method-click-advice">click to toggle source</span>
430
-
431
- </div>
432
-
433
-
434
- <div class="method-description">
435
-
436
- <p>Alias of <a href="CompilerResult.html#attribute-i-stream">stream</a>.</p>
437
-
438
-
439
-
440
-
441
- <div class="method-source-code" id="to_s-source">
442
- <pre><span class="ruby-comment"># File lib/netlinx/compiler_result.rb, line 47</span>
443
- <span class="ruby-keyword">def</span> <span class="ruby-identifier">to_s</span>
444
- <span class="ruby-ivar">@stream</span>
445
- <span class="ruby-keyword">end</span></pre>
446
- </div><!-- to_s-source -->
447
-
448
- </div>
449
-
450
-
451
-
452
-
453
- </div><!-- to_s-method -->
454
-
455
-
456
- <div id="method-i-warning_items" class="method-detail ">
457
-
458
- <div class="method-heading">
459
- <span class="method-name">warning_items</span><span
460
- class="method-args">()</span>
461
-
462
- <span class="method-click-advice">click to toggle source</span>
463
-
464
- </div>
465
-
466
-
467
- <div class="method-description">
468
-
469
- <p>An enumerable list of warnings.</p>
470
-
471
-
472
-
473
-
474
- <div class="method-source-code" id="warning_items-source">
475
- <pre><span class="ruby-comment"># File lib/netlinx/compiler_result.rb, line 62</span>
476
- <span class="ruby-keyword">def</span> <span class="ruby-identifier">warning_items</span>
477
- <span class="ruby-ivar">@stream</span>.<span class="ruby-identifier">scan</span>(<span class="ruby-regexp">/(^WARNING: .*$)/</span>).<span class="ruby-identifier">map</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">i</span><span class="ruby-operator">|</span> <span class="ruby-identifier">i</span>.<span class="ruby-identifier">first</span>}
478
- <span class="ruby-keyword">end</span></pre>
479
- </div><!-- warning_items-source -->
480
-
481
- </div>
482
-
483
-
484
-
485
-
486
- </div><!-- warning_items-method -->
487
-
488
-
489
- </section><!-- public-instance-method-details -->
490
-
491
- </section><!-- 5Buntitled-5D -->
492
-
493
- </div><!-- documentation -->
494
-
495
-
496
- <footer id="validator-badges">
497
- <p><a href="http://validator.w3.org/check/referer">[Validate]</a>
498
- <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 4.0.1.
499
- <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
500
- </footer>
501
-
641
+ <span class='ivar'>@stream</span><span class='period'>.</span><span class='id identifier rubyid_scan'>scan</span> <span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>(\d+) error\(s\), (\d+) warning\(s\)</span><span class='regexp_end'>/</span></span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_e'>e</span><span class='comma'>,</span> <span class='id identifier rubyid_w'>w</span><span class='op'>|</span>
642
+ <span class='ivar'>@errors</span> <span class='op'>=</span> <span class='id identifier rubyid_e'>e</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span> <span class='kw'>if</span> <span class='id identifier rubyid_e'>e</span>
643
+ <span class='ivar'>@warnings</span> <span class='op'>=</span> <span class='id identifier rubyid_w'>w</span><span class='period'>.</span><span class='id identifier rubyid_to_i'>to_i</span> <span class='kw'>if</span> <span class='id identifier rubyid_w'>w</span>
644
+ <span class='kw'>end</span>
645
+ <span class='kw'>end</span></pre>
646
+ </td>
647
+ </tr>
648
+ </table>
649
+ </div>
650
+
651
+ </div>
652
+
653
+ <div id="instance_attr_details" class="attr_details">
654
+ <h2>Instance Attribute Details</h2>
655
+
656
+
657
+ <span id=""></span>
658
+ <div class="method_details first">
659
+ <h3 class="signature first" id="compiler_include_paths-instance_method">
660
+
661
+ #<strong>compiler_include_paths</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
662
+
663
+
664
+
665
+
666
+
667
+ </h3><div class="docstring">
668
+ <div class="discussion">
669
+
670
+ <p>See Compilable interface.</p>
671
+
672
+
673
+ </div>
674
+ </div>
675
+ <div class="tags">
676
+
677
+
678
+ </div><table class="source_code">
679
+ <tr>
680
+ <td>
681
+ <pre class="lines">
682
+
683
+
684
+ 16
685
+ 17
686
+ 18</pre>
687
+ </td>
688
+ <td>
689
+ <pre class="code"><span class="info file"># File 'lib/netlinx/compiler_result.rb', line 16</span>
690
+
691
+ <span class='kw'>def</span> <span class='id identifier rubyid_compiler_include_paths'>compiler_include_paths</span>
692
+ <span class='ivar'>@compiler_include_paths</span>
693
+ <span class='kw'>end</span></pre>
694
+ </td>
695
+ </tr>
696
+ </table>
697
+ </div>
698
+
699
+
700
+ <span id=""></span>
701
+ <div class="method_details ">
702
+ <h3 class="signature " id="compiler_library_paths-instance_method">
703
+
704
+ #<strong>compiler_library_paths</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
705
+
706
+
707
+
708
+
709
+
710
+ </h3><div class="docstring">
711
+ <div class="discussion">
712
+
713
+ <p>See Compilable interface.</p>
714
+
715
+
716
+ </div>
717
+ </div>
718
+ <div class="tags">
719
+
720
+
721
+ </div><table class="source_code">
722
+ <tr>
723
+ <td>
724
+ <pre class="lines">
725
+
726
+
727
+ 20
728
+ 21
729
+ 22</pre>
730
+ </td>
731
+ <td>
732
+ <pre class="code"><span class="info file"># File 'lib/netlinx/compiler_result.rb', line 20</span>
733
+
734
+ <span class='kw'>def</span> <span class='id identifier rubyid_compiler_library_paths'>compiler_library_paths</span>
735
+ <span class='ivar'>@compiler_library_paths</span>
736
+ <span class='kw'>end</span></pre>
737
+ </td>
738
+ </tr>
739
+ </table>
740
+ </div>
741
+
742
+
743
+ <span id=""></span>
744
+ <div class="method_details ">
745
+ <h3 class="signature " id="compiler_module_paths-instance_method">
746
+
747
+ #<strong>compiler_module_paths</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
748
+
749
+
750
+
751
+
752
+
753
+ </h3><div class="docstring">
754
+ <div class="discussion">
755
+
756
+ <p>See Compilable interface.</p>
757
+
758
+
759
+ </div>
760
+ </div>
761
+ <div class="tags">
762
+
763
+
764
+ </div><table class="source_code">
765
+ <tr>
766
+ <td>
767
+ <pre class="lines">
768
+
769
+
770
+ 18
771
+ 19
772
+ 20</pre>
773
+ </td>
774
+ <td>
775
+ <pre class="code"><span class="info file"># File 'lib/netlinx/compiler_result.rb', line 18</span>
776
+
777
+ <span class='kw'>def</span> <span class='id identifier rubyid_compiler_module_paths'>compiler_module_paths</span>
778
+ <span class='ivar'>@compiler_module_paths</span>
779
+ <span class='kw'>end</span></pre>
780
+ </td>
781
+ </tr>
782
+ </table>
783
+ </div>
784
+
785
+
786
+ <span id=""></span>
787
+ <div class="method_details ">
788
+ <h3 class="signature " id="compiler_target_files-instance_method">
789
+
790
+ #<strong>compiler_target_files</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
791
+
792
+
793
+
794
+
795
+
796
+ </h3><div class="docstring">
797
+ <div class="discussion">
798
+
799
+ <p>See Compilable interface.</p>
800
+
801
+
802
+ </div>
803
+ </div>
804
+ <div class="tags">
805
+
806
+
807
+ </div><table class="source_code">
808
+ <tr>
809
+ <td>
810
+ <pre class="lines">
811
+
812
+
813
+ 14
814
+ 15
815
+ 16</pre>
816
+ </td>
817
+ <td>
818
+ <pre class="code"><span class="info file"># File 'lib/netlinx/compiler_result.rb', line 14</span>
819
+
820
+ <span class='kw'>def</span> <span class='id identifier rubyid_compiler_target_files'>compiler_target_files</span>
821
+ <span class='ivar'>@compiler_target_files</span>
822
+ <span class='kw'>end</span></pre>
823
+ </td>
824
+ </tr>
825
+ </table>
826
+ </div>
827
+
828
+
829
+ <span id=""></span>
830
+ <div class="method_details ">
831
+ <h3 class="signature " id="errors-instance_method">
832
+
833
+ #<strong>errors</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
834
+
835
+
836
+
837
+
838
+
839
+ </h3><div class="docstring">
840
+ <div class="discussion">
841
+
842
+ <p>Number of compiler errors.</p>
843
+
844
+
845
+ </div>
846
+ </div>
847
+ <div class="tags">
848
+
849
+
850
+ </div><table class="source_code">
851
+ <tr>
852
+ <td>
853
+ <pre class="lines">
854
+
855
+
856
+ 7
857
+ 8
858
+ 9</pre>
859
+ </td>
860
+ <td>
861
+ <pre class="code"><span class="info file"># File 'lib/netlinx/compiler_result.rb', line 7</span>
862
+
863
+ <span class='kw'>def</span> <span class='id identifier rubyid_errors'>errors</span>
864
+ <span class='ivar'>@errors</span>
865
+ <span class='kw'>end</span></pre>
866
+ </td>
867
+ </tr>
868
+ </table>
869
+ </div>
870
+
871
+
872
+ <span id=""></span>
873
+ <div class="method_details ">
874
+ <h3 class="signature " id="stream-instance_method">
875
+
876
+ #<strong>stream</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
877
+
878
+
879
+
880
+
881
+
882
+ </h3><div class="docstring">
883
+ <div class="discussion">
884
+
885
+ <p>The raw stream of text returned by the compiler.</p>
886
+
887
+
888
+ </div>
889
+ </div>
890
+ <div class="tags">
891
+
892
+
893
+ </div><table class="source_code">
894
+ <tr>
895
+ <td>
896
+ <pre class="lines">
897
+
898
+
899
+ 5
900
+ 6
901
+ 7</pre>
902
+ </td>
903
+ <td>
904
+ <pre class="code"><span class="info file"># File 'lib/netlinx/compiler_result.rb', line 5</span>
905
+
906
+ <span class='kw'>def</span> <span class='id identifier rubyid_stream'>stream</span>
907
+ <span class='ivar'>@stream</span>
908
+ <span class='kw'>end</span></pre>
909
+ </td>
910
+ </tr>
911
+ </table>
912
+ </div>
913
+
914
+
915
+ <span id=""></span>
916
+ <div class="method_details ">
917
+ <h3 class="signature " id="warnings-instance_method">
918
+
919
+ #<strong>warnings</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
920
+
921
+
922
+
923
+
924
+
925
+ </h3><div class="docstring">
926
+ <div class="discussion">
927
+
928
+ <p>Number of compiler warnings.</p>
929
+
930
+
931
+ </div>
932
+ </div>
933
+ <div class="tags">
934
+
935
+
936
+ </div><table class="source_code">
937
+ <tr>
938
+ <td>
939
+ <pre class="lines">
940
+
941
+
942
+ 9
943
+ 10
944
+ 11</pre>
945
+ </td>
946
+ <td>
947
+ <pre class="code"><span class="info file"># File 'lib/netlinx/compiler_result.rb', line 9</span>
948
+
949
+ <span class='kw'>def</span> <span class='id identifier rubyid_warnings'>warnings</span>
950
+ <span class='ivar'>@warnings</span>
951
+ <span class='kw'>end</span></pre>
952
+ </td>
953
+ </tr>
954
+ </table>
955
+ </div>
956
+
957
+ </div>
958
+
959
+
960
+ <div id="instance_method_details" class="method_details_list">
961
+ <h2>Instance Method Details</h2>
962
+
963
+
964
+ <div class="method_details first">
965
+ <h3 class="signature first" id="error_items-instance_method">
966
+
967
+ #<strong>error_items</strong> &#x21d2; <tt>Array&lt;String&gt;</tt>
968
+
969
+
970
+
971
+
972
+
973
+ </h3><div class="docstring">
974
+ <div class="discussion">
975
+
976
+ <p>Returns a list of errors.</p>
977
+
978
+
979
+ </div>
980
+ </div>
981
+ <div class="tags">
982
+
983
+ <p class="tag_title">Returns:</p>
984
+ <ul class="return">
985
+
986
+ <li>
987
+
988
+
989
+ <span class='type'>(<tt>Array&lt;String&gt;</tt>)</span>
990
+
991
+
992
+
993
+ &mdash;
994
+ <div class='inline'>
995
+ <p>a list of errors.</p>
996
+ </div>
997
+
998
+ </li>
999
+
1000
+ </ul>
1001
+
1002
+ </div><table class="source_code">
1003
+ <tr>
1004
+ <td>
1005
+ <pre class="lines">
1006
+
1007
+
1008
+ 66
1009
+ 67
1010
+ 68</pre>
1011
+ </td>
1012
+ <td>
1013
+ <pre class="code"><span class="info file"># File 'lib/netlinx/compiler_result.rb', line 66</span>
1014
+
1015
+ <span class='kw'>def</span> <span class='id identifier rubyid_error_items'>error_items</span>
1016
+ <span class='ivar'>@stream</span><span class='period'>.</span><span class='id identifier rubyid_scan'>scan</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>(^ERROR: .*$)</span><span class='regexp_end'>/</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_i'>i</span><span class='op'>|</span> <span class='id identifier rubyid_i'>i</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='rbrace'>}</span>
1017
+ <span class='kw'>end</span></pre>
1018
+ </td>
1019
+ </tr>
1020
+ </table>
1021
+ </div>
1022
+
1023
+ <div class="method_details ">
1024
+ <h3 class="signature " id="success?-instance_method">
1025
+
1026
+ #<strong>success?</strong> &#x21d2; <tt>Boolean</tt>
1027
+
1028
+
1029
+
1030
+
1031
+
1032
+ </h3><div class="docstring">
1033
+ <div class="discussion">
1034
+
1035
+ <p>Returns true if compile was successful.</p>
1036
+
1037
+
1038
+ </div>
1039
+ </div>
1040
+ <div class="tags">
1041
+
1042
+ <p class="tag_title">Returns:</p>
1043
+ <ul class="return">
1044
+
1045
+ <li>
1046
+
1047
+
1048
+ <span class='type'>(<tt>Boolean</tt>)</span>
1049
+
1050
+
1051
+
1052
+ &mdash;
1053
+ <div class='inline'>
1054
+ <p>true if compile was successful.</p>
1055
+ </div>
1056
+
1057
+ </li>
1058
+
1059
+ </ul>
1060
+
1061
+ </div><table class="source_code">
1062
+ <tr>
1063
+ <td>
1064
+ <pre class="lines">
1065
+
1066
+
1067
+ 56
1068
+ 57
1069
+ 58</pre>
1070
+ </td>
1071
+ <td>
1072
+ <pre class="code"><span class="info file"># File 'lib/netlinx/compiler_result.rb', line 56</span>
1073
+
1074
+ <span class='kw'>def</span> <span class='id identifier rubyid_success?'>success?</span>
1075
+ <span class='ivar'>@errors</span> <span class='op'>==</span> <span class='int'>0</span> <span class='op'>&amp;&amp;</span> <span class='ivar'>@warnings</span> <span class='op'>==</span> <span class='int'>0</span>
1076
+ <span class='kw'>end</span></pre>
1077
+ </td>
1078
+ </tr>
1079
+ </table>
1080
+ </div>
1081
+
1082
+ <div class="method_details ">
1083
+ <h3 class="signature " id="target_file-instance_method">
1084
+
1085
+ #<strong>target_file</strong> &#x21d2; <tt>String</tt>
1086
+
1087
+
1088
+
1089
+
1090
+
1091
+ </h3><div class="docstring">
1092
+ <div class="discussion">
1093
+
1094
+ <p>Returns the absolute path of the source code file that was compiled.</p>
1095
+
1096
+
1097
+ </div>
1098
+ </div>
1099
+ <div class="tags">
1100
+
1101
+ <p class="tag_title">Returns:</p>
1102
+ <ul class="return">
1103
+
1104
+ <li>
1105
+
1106
+
1107
+ <span class='type'>(<tt>String</tt>)</span>
1108
+
1109
+
1110
+
1111
+ &mdash;
1112
+ <div class='inline'>
1113
+ <p>the absolute path of the source code file that was compiled.</p>
1114
+ </div>
1115
+
1116
+ </li>
1117
+
1118
+ </ul>
1119
+
1120
+ </div><table class="source_code">
1121
+ <tr>
1122
+ <td>
1123
+ <pre class="lines">
1124
+
1125
+
1126
+ 51
1127
+ 52
1128
+ 53</pre>
1129
+ </td>
1130
+ <td>
1131
+ <pre class="code"><span class="info file"># File 'lib/netlinx/compiler_result.rb', line 51</span>
1132
+
1133
+ <span class='kw'>def</span> <span class='id identifier rubyid_target_file'>target_file</span>
1134
+ <span class='ivar'>@compiler_target_files</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span>
1135
+ <span class='kw'>end</span></pre>
1136
+ </td>
1137
+ </tr>
1138
+ </table>
1139
+ </div>
1140
+
1141
+ <div class="method_details ">
1142
+ <h3 class="signature " id="to_s-instance_method">
1143
+
1144
+ #<strong>to_s</strong> &#x21d2; <tt>Object</tt>
1145
+
1146
+
1147
+
1148
+
1149
+
1150
+ </h3><div class="docstring">
1151
+ <div class="discussion">
1152
+
1153
+ <p>Alias of <span class='object_link'><a href="#stream-instance_method" title="NetLinx::CompilerResult#stream (method)">#stream</a></span>.</p>
1154
+
1155
+
1156
+ </div>
1157
+ </div>
1158
+ <div class="tags">
1159
+
1160
+
1161
+ </div><table class="source_code">
1162
+ <tr>
1163
+ <td>
1164
+ <pre class="lines">
1165
+
1166
+
1167
+ 46
1168
+ 47
1169
+ 48</pre>
1170
+ </td>
1171
+ <td>
1172
+ <pre class="code"><span class="info file"># File 'lib/netlinx/compiler_result.rb', line 46</span>
1173
+
1174
+ <span class='kw'>def</span> <span class='id identifier rubyid_to_s'>to_s</span>
1175
+ <span class='ivar'>@stream</span>
1176
+ <span class='kw'>end</span></pre>
1177
+ </td>
1178
+ </tr>
1179
+ </table>
1180
+ </div>
1181
+
1182
+ <div class="method_details ">
1183
+ <h3 class="signature " id="warning_items-instance_method">
1184
+
1185
+ #<strong>warning_items</strong> &#x21d2; <tt>Array&lt;String&gt;</tt>
1186
+
1187
+
1188
+
1189
+
1190
+
1191
+ </h3><div class="docstring">
1192
+ <div class="discussion">
1193
+
1194
+ <p>Returns a list of warnings.</p>
1195
+
1196
+
1197
+ </div>
1198
+ </div>
1199
+ <div class="tags">
1200
+
1201
+ <p class="tag_title">Returns:</p>
1202
+ <ul class="return">
1203
+
1204
+ <li>
1205
+
1206
+
1207
+ <span class='type'>(<tt>Array&lt;String&gt;</tt>)</span>
1208
+
1209
+
1210
+
1211
+ &mdash;
1212
+ <div class='inline'>
1213
+ <p>a list of warnings.</p>
1214
+ </div>
1215
+
1216
+ </li>
1217
+
1218
+ </ul>
1219
+
1220
+ </div><table class="source_code">
1221
+ <tr>
1222
+ <td>
1223
+ <pre class="lines">
1224
+
1225
+
1226
+ 61
1227
+ 62
1228
+ 63</pre>
1229
+ </td>
1230
+ <td>
1231
+ <pre class="code"><span class="info file"># File 'lib/netlinx/compiler_result.rb', line 61</span>
1232
+
1233
+ <span class='kw'>def</span> <span class='id identifier rubyid_warning_items'>warning_items</span>
1234
+ <span class='ivar'>@stream</span><span class='period'>.</span><span class='id identifier rubyid_scan'>scan</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>/</span><span class='tstring_content'>(^WARNING: .*$)</span><span class='regexp_end'>/</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_map'>map</span> <span class='lbrace'>{</span><span class='op'>|</span><span class='id identifier rubyid_i'>i</span><span class='op'>|</span> <span class='id identifier rubyid_i'>i</span><span class='period'>.</span><span class='id identifier rubyid_first'>first</span><span class='rbrace'>}</span>
1235
+ <span class='kw'>end</span></pre>
1236
+ </td>
1237
+ </tr>
1238
+ </table>
1239
+ </div>
1240
+
1241
+ </div>
1242
+
1243
+ </div>
1244
+
1245
+ <div id="footer">
1246
+ Generated on Sat Jul 11 17:29:51 2020 by
1247
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1248
+ 0.9.25 (ruby-2.7.1).
1249
+ </div>
1250
+
1251
+ </div>
1252
+ </body>
1253
+ </html>