xpcomcore-rubygem 0.3.1 → 0.3.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (146) hide show
  1. data/Rakefile +1 -1
  2. data/VERSION +1 -1
  3. data/xpcomcore-rubygem.gemspec +144 -2
  4. data/xpcomcore/LICENSE +21 -0
  5. data/xpcomcore/README +27 -0
  6. data/xpcomcore/Rakefile +83 -0
  7. data/xpcomcore/VERSION.yml +5 -0
  8. data/xpcomcore/bin/popen_helper.sh +47 -0
  9. data/xpcomcore/bootstrapper.js +32 -0
  10. data/xpcomcore/components/XPCOMCore.js +122 -0
  11. data/xpcomcore/doc/files.html +275 -0
  12. data/xpcomcore/doc/index.html +275 -0
  13. data/xpcomcore/doc/symbols/Error.html +264 -0
  14. data/xpcomcore/doc/symbols/File.NoSuchFileError.html +334 -0
  15. data/xpcomcore/doc/symbols/File.html +451 -0
  16. data/xpcomcore/doc/symbols/Kernel.html +1098 -0
  17. data/xpcomcore/doc/symbols/LoadError.html +334 -0
  18. data/xpcomcore/doc/symbols/SelfConceptError.html +334 -0
  19. data/xpcomcore/doc/symbols/Sys.html +394 -0
  20. data/xpcomcore/doc/symbols/XPCBuiltins.html +314 -0
  21. data/xpcomcore/doc/symbols/_global_.html +264 -0
  22. data/xpcomcore/doc/symbols/src/lib_file.js.html +82 -0
  23. data/xpcomcore/doc/symbols/src/lib_kernel.js.html +250 -0
  24. data/xpcomcore/doc/symbols/src/lib_sys.js.html +60 -0
  25. data/xpcomcore/doc/symbols/src/lib_xpc_builtins.js.html +20 -0
  26. data/xpcomcore/etc/jsdoc-toolkit/README.txt +186 -0
  27. data/xpcomcore/etc/jsdoc-toolkit/app/frame.js +33 -0
  28. data/xpcomcore/etc/jsdoc-toolkit/app/frame/Chain.js +102 -0
  29. data/xpcomcore/etc/jsdoc-toolkit/app/frame/Dumper.js +144 -0
  30. data/xpcomcore/etc/jsdoc-toolkit/app/frame/Hash.js +84 -0
  31. data/xpcomcore/etc/jsdoc-toolkit/app/frame/Link.js +153 -0
  32. data/xpcomcore/etc/jsdoc-toolkit/app/frame/Namespace.js +10 -0
  33. data/xpcomcore/etc/jsdoc-toolkit/app/frame/Opt.js +134 -0
  34. data/xpcomcore/etc/jsdoc-toolkit/app/frame/Reflection.js +26 -0
  35. data/xpcomcore/etc/jsdoc-toolkit/app/frame/String.js +93 -0
  36. data/xpcomcore/etc/jsdoc-toolkit/app/frame/Testrun.js +129 -0
  37. data/xpcomcore/etc/jsdoc-toolkit/app/handlers/FOODOC.js +26 -0
  38. data/xpcomcore/etc/jsdoc-toolkit/app/handlers/XMLDOC.js +26 -0
  39. data/xpcomcore/etc/jsdoc-toolkit/app/handlers/XMLDOC/DomReader.js +159 -0
  40. data/xpcomcore/etc/jsdoc-toolkit/app/handlers/XMLDOC/XMLDoc.js +16 -0
  41. data/xpcomcore/etc/jsdoc-toolkit/app/handlers/XMLDOC/XMLParse.js +292 -0
  42. data/xpcomcore/etc/jsdoc-toolkit/app/lib/JSDOC.js +104 -0
  43. data/xpcomcore/etc/jsdoc-toolkit/app/lib/JSDOC/DocComment.js +200 -0
  44. data/xpcomcore/etc/jsdoc-toolkit/app/lib/JSDOC/DocTag.js +294 -0
  45. data/xpcomcore/etc/jsdoc-toolkit/app/lib/JSDOC/JsDoc.js +126 -0
  46. data/xpcomcore/etc/jsdoc-toolkit/app/lib/JSDOC/JsPlate.js +109 -0
  47. data/xpcomcore/etc/jsdoc-toolkit/app/lib/JSDOC/Lang.js +144 -0
  48. data/xpcomcore/etc/jsdoc-toolkit/app/lib/JSDOC/Parser.js +145 -0
  49. data/xpcomcore/etc/jsdoc-toolkit/app/lib/JSDOC/PluginManager.js +33 -0
  50. data/xpcomcore/etc/jsdoc-toolkit/app/lib/JSDOC/Symbol.js +645 -0
  51. data/xpcomcore/etc/jsdoc-toolkit/app/lib/JSDOC/SymbolSet.js +241 -0
  52. data/xpcomcore/etc/jsdoc-toolkit/app/lib/JSDOC/TextStream.js +41 -0
  53. data/xpcomcore/etc/jsdoc-toolkit/app/lib/JSDOC/Token.js +18 -0
  54. data/xpcomcore/etc/jsdoc-toolkit/app/lib/JSDOC/TokenReader.js +332 -0
  55. data/xpcomcore/etc/jsdoc-toolkit/app/lib/JSDOC/TokenStream.js +133 -0
  56. data/xpcomcore/etc/jsdoc-toolkit/app/lib/JSDOC/Util.js +32 -0
  57. data/xpcomcore/etc/jsdoc-toolkit/app/lib/JSDOC/Walker.js +474 -0
  58. data/xpcomcore/etc/jsdoc-toolkit/app/main.js +111 -0
  59. data/xpcomcore/etc/jsdoc-toolkit/app/plugins/commentSrcJson.js +20 -0
  60. data/xpcomcore/etc/jsdoc-toolkit/app/plugins/frameworkPrototype.js +16 -0
  61. data/xpcomcore/etc/jsdoc-toolkit/app/plugins/functionCall.js +10 -0
  62. data/xpcomcore/etc/jsdoc-toolkit/app/plugins/publishSrcHilite.js +62 -0
  63. data/xpcomcore/etc/jsdoc-toolkit/app/plugins/symbolLink.js +10 -0
  64. data/xpcomcore/etc/jsdoc-toolkit/app/plugins/tagParamConfig.js +31 -0
  65. data/xpcomcore/etc/jsdoc-toolkit/app/plugins/tagSynonyms.js +43 -0
  66. data/xpcomcore/etc/jsdoc-toolkit/app/run.js +348 -0
  67. data/xpcomcore/etc/jsdoc-toolkit/app/t/TestDoc.js +144 -0
  68. data/xpcomcore/etc/jsdoc-toolkit/app/t/runner.js +13 -0
  69. data/xpcomcore/etc/jsdoc-toolkit/app/test.js +325 -0
  70. data/xpcomcore/etc/jsdoc-toolkit/app/test/addon.js +24 -0
  71. data/xpcomcore/etc/jsdoc-toolkit/app/test/anon_inner.js +14 -0
  72. data/xpcomcore/etc/jsdoc-toolkit/app/test/augments.js +31 -0
  73. data/xpcomcore/etc/jsdoc-toolkit/app/test/augments2.js +26 -0
  74. data/xpcomcore/etc/jsdoc-toolkit/app/test/borrows.js +46 -0
  75. data/xpcomcore/etc/jsdoc-toolkit/app/test/borrows2.js +23 -0
  76. data/xpcomcore/etc/jsdoc-toolkit/app/test/config.js +22 -0
  77. data/xpcomcore/etc/jsdoc-toolkit/app/test/constructs.js +18 -0
  78. data/xpcomcore/etc/jsdoc-toolkit/app/test/encoding.js +10 -0
  79. data/xpcomcore/etc/jsdoc-toolkit/app/test/encoding_other.js +12 -0
  80. data/xpcomcore/etc/jsdoc-toolkit/app/test/event.js +54 -0
  81. data/xpcomcore/etc/jsdoc-toolkit/app/test/exports.js +14 -0
  82. data/xpcomcore/etc/jsdoc-toolkit/app/test/functions_anon.js +39 -0
  83. data/xpcomcore/etc/jsdoc-toolkit/app/test/functions_nested.js +33 -0
  84. data/xpcomcore/etc/jsdoc-toolkit/app/test/global.js +13 -0
  85. data/xpcomcore/etc/jsdoc-toolkit/app/test/globals.js +25 -0
  86. data/xpcomcore/etc/jsdoc-toolkit/app/test/ignore.js +10 -0
  87. data/xpcomcore/etc/jsdoc-toolkit/app/test/inner.js +16 -0
  88. data/xpcomcore/etc/jsdoc-toolkit/app/test/jsdoc_test.js +477 -0
  89. data/xpcomcore/etc/jsdoc-toolkit/app/test/lend.js +33 -0
  90. data/xpcomcore/etc/jsdoc-toolkit/app/test/memberof.js +19 -0
  91. data/xpcomcore/etc/jsdoc-toolkit/app/test/memberof_constructor.js +17 -0
  92. data/xpcomcore/etc/jsdoc-toolkit/app/test/module.js +17 -0
  93. data/xpcomcore/etc/jsdoc-toolkit/app/test/name.js +19 -0
  94. data/xpcomcore/etc/jsdoc-toolkit/app/test/namespace_nested.js +23 -0
  95. data/xpcomcore/etc/jsdoc-toolkit/app/test/nocode.js +13 -0
  96. data/xpcomcore/etc/jsdoc-toolkit/app/test/oblit_anon.js +20 -0
  97. data/xpcomcore/etc/jsdoc-toolkit/app/test/overview.js +20 -0
  98. data/xpcomcore/etc/jsdoc-toolkit/app/test/param_inline.js +37 -0
  99. data/xpcomcore/etc/jsdoc-toolkit/app/test/params_optional.js +8 -0
  100. data/xpcomcore/etc/jsdoc-toolkit/app/test/prototype.js +17 -0
  101. data/xpcomcore/etc/jsdoc-toolkit/app/test/prototype_nested.js +9 -0
  102. data/xpcomcore/etc/jsdoc-toolkit/app/test/prototype_oblit.js +13 -0
  103. data/xpcomcore/etc/jsdoc-toolkit/app/test/prototype_oblit_constructor.js +24 -0
  104. data/xpcomcore/etc/jsdoc-toolkit/app/test/public.js +10 -0
  105. data/xpcomcore/etc/jsdoc-toolkit/app/test/scripts/code.js +5 -0
  106. data/xpcomcore/etc/jsdoc-toolkit/app/test/scripts/notcode.txt +5 -0
  107. data/xpcomcore/etc/jsdoc-toolkit/app/test/shared.js +42 -0
  108. data/xpcomcore/etc/jsdoc-toolkit/app/test/shared2.js +2 -0
  109. data/xpcomcore/etc/jsdoc-toolkit/app/test/shortcuts.js +22 -0
  110. data/xpcomcore/etc/jsdoc-toolkit/app/test/static_this.js +13 -0
  111. data/xpcomcore/etc/jsdoc-toolkit/app/test/synonyms.js +31 -0
  112. data/xpcomcore/etc/jsdoc-toolkit/app/test/tosource.js +23 -0
  113. data/xpcomcore/etc/jsdoc-toolkit/app/test/variable_redefine.js +14 -0
  114. data/xpcomcore/etc/jsdoc-toolkit/changes.txt +96 -0
  115. data/xpcomcore/etc/jsdoc-toolkit/conf/sample.conf +31 -0
  116. data/xpcomcore/etc/jsdoc-toolkit/java/build.xml +36 -0
  117. data/xpcomcore/etc/jsdoc-toolkit/java/build_1.4.xml +36 -0
  118. data/xpcomcore/etc/jsdoc-toolkit/java/classes/js.jar +0 -0
  119. data/xpcomcore/etc/jsdoc-toolkit/java/src/JsDebugRun.java +21 -0
  120. data/xpcomcore/etc/jsdoc-toolkit/java/src/JsRun.java +21 -0
  121. data/xpcomcore/etc/jsdoc-toolkit/jsdebug.jar +0 -0
  122. data/xpcomcore/etc/jsdoc-toolkit/jsrun.jar +0 -0
  123. data/xpcomcore/etc/jsdoc-toolkit/jsrun.sh +52 -0
  124. data/xpcomcore/etc/jsdoc-toolkit/templates/jsdoc/allclasses.tmpl +17 -0
  125. data/xpcomcore/etc/jsdoc-toolkit/templates/jsdoc/allfiles.tmpl +56 -0
  126. data/xpcomcore/etc/jsdoc-toolkit/templates/jsdoc/class.tmpl +646 -0
  127. data/xpcomcore/etc/jsdoc-toolkit/templates/jsdoc/index.tmpl +39 -0
  128. data/xpcomcore/etc/jsdoc-toolkit/templates/jsdoc/publish.js +200 -0
  129. data/xpcomcore/etc/jsdoc-toolkit/templates/jsdoc/static/default.css +162 -0
  130. data/xpcomcore/etc/jsdoc-toolkit/templates/jsdoc/static/header.html +2 -0
  131. data/xpcomcore/etc/jsdoc-toolkit/templates/jsdoc/static/index.html +19 -0
  132. data/xpcomcore/etc/jsdoc-toolkit/templates/jsdoc/symbol.tmpl +35 -0
  133. data/xpcomcore/lib/file.js +75 -0
  134. data/xpcomcore/lib/kernel.js +243 -0
  135. data/xpcomcore/lib/sys.js +52 -0
  136. data/xpcomcore/lib/xpc_builtins.js +13 -0
  137. data/xpcomcore/test/file_test.js +27 -0
  138. data/xpcomcore/test/fixtures/empty +0 -0
  139. data/xpcomcore/test/fixtures/love.js +1 -0
  140. data/xpcomcore/test/fixtures/mad_love.js +1 -0
  141. data/xpcomcore/test/fixtures/mad_world.js +1 -0
  142. data/xpcomcore/test/fixtures/syntax_error.js +1 -0
  143. data/xpcomcore/test/kernel_test.js +95 -0
  144. data/xpcomcore/test/sys_test.js +19 -0
  145. data/xpcomcore/test/xpc_builtins_test.js +8 -0
  146. metadata +143 -1
data/xpcomcore/doc/symbols/File.html ADDED
@@ -0,0 +1,451 @@
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
+ <meta name="generator" content="JsDoc Toolkit" />
7
+
8
+ <title>JsDoc Reference - File</title>
9
+
10
+ <style type="text/css">
11
+ /* default.css */
12
+ body
13
+ {
14
+ font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif;
15
+ width: 800px;
16
+ }
17
+
18
+ .header
19
+ {
20
+ clear: both;
21
+ background-color: #ccc;
22
+ padding: 8px;
23
+ }
24
+
25
+ h1
26
+ {
27
+ font-size: 150%;
28
+ font-weight: bold;
29
+ padding: 0;
30
+ margin: 1em 0 0 .3em;
31
+ }
32
+
33
+ hr
34
+ {
35
+ border: none 0;
36
+ border-top: 1px solid #7F8FB1;
37
+ height: 1px;
38
+ }
39
+
40
+ pre.code
41
+ {
42
+ display: block;
43
+ padding: 8px;
44
+ border: 1px dashed #ccc;
45
+ }
46
+
47
+ #index
48
+ {
49
+ margin-top: 24px;
50
+ float: left;
51
+ width: 160px;
52
+ position: absolute;
53
+ left: 8px;
54
+ background-color: #F3F3F3;
55
+ padding: 8px;
56
+ }
57
+
58
+ #content
59
+ {
60
+ margin-left: 190px;
61
+ width: 600px;
62
+ }
63
+
64
+ .classList
65
+ {
66
+ list-style-type: none;
67
+ padding: 0;
68
+ margin: 0 0 0 8px;
69
+ font-family: arial, sans-serif;
70
+ font-size: 1em;
71
+ overflow: auto;
72
+ }
73
+
74
+ .classList li
75
+ {
76
+ padding: 0;
77
+ margin: 0 0 8px 0;
78
+ }
79
+
80
+ .summaryTable { width: 100%; }
81
+
82
+ h1.classTitle
83
+ {
84
+ font-size:170%;
85
+ line-height:130%;
86
+ }
87
+
88
+ h2 { font-size: 110%; }
89
+ caption, div.sectionTitle
90
+ {
91
+ background-color: #7F8FB1;
92
+ color: #fff;
93
+ font-size:130%;
94
+ text-align: left;
95
+ padding: 2px 6px 2px 6px;
96
+ border: 1px #7F8FB1 solid;
97
+ }
98
+
99
+ div.sectionTitle { margin-bottom: 8px; }
100
+ .summaryTable thead { display: none; }
101
+
102
+ .summaryTable td
103
+ {
104
+ vertical-align: top;
105
+ padding: 4px;
106
+ border-bottom: 1px #7F8FB1 solid;
107
+ border-right: 1px #7F8FB1 solid;
108
+ }
109
+
110
+ /*col#summaryAttributes {}*/
111
+ .summaryTable td.attributes
112
+ {
113
+ border-left: 1px #7F8FB1 solid;
114
+ width: 140px;
115
+ text-align: right;
116
+ }
117
+
118
+ td.attributes, .fixedFont
119
+ {
120
+ line-height: 15px;
121
+ color: #002EBE;
122
+ font-family: "Courier New",Courier,monospace;
123
+ font-size: 13px;
124
+ }
125
+
126
+ .summaryTable td.nameDescription
127
+ {
128
+ text-align: left;
129
+ font-size: 13px;
130
+ line-height: 15px;
131
+ }
132
+
133
+ .summaryTable td.nameDescription, .description
134
+ {
135
+ line-height: 15px;
136
+ padding: 4px;
137
+ padding-left: 4px;
138
+ }
139
+
140
+ .summaryTable { margin-bottom: 8px; }
141
+
142
+ ul.inheritsList
143
+ {
144
+ list-style: square;
145
+ margin-left: 20px;
146
+ padding-left: 0;
147
+ }
148
+
149
+ .detailList {
150
+ margin-left: 20px;
151
+ line-height: 15px;
152
+ }
153
+ .detailList dt { margin-left: 20px; }
154
+
155
+ .detailList .heading
156
+ {
157
+ font-weight: bold;
158
+ padding-bottom: 6px;
159
+ margin-left: 0;
160
+ }
161
+
162
+ .light, td.attributes, .light a:link, .light a:visited
163
+ {
164
+ color: #777;
165
+ font-style: italic;
166
+ }
167
+
168
+ .fineprint
169
+ {
170
+ text-align: right;
171
+ font-size: 10px;
172
+ }
173
+ </style>
174
+ </head>
175
+
176
+ <body>
177
+ <!-- ============================== header ================================= -->
178
+ <!-- begin static/header.html -->
179
+ <div id="header">
180
+ </div>
181
+ <!-- end static/header.html -->
182
+
183
+ <!-- ============================== classes index ============================ -->
184
+ <div id="index">
185
+ <!-- begin publish.classesIndex -->
186
+ <div align="center"><a href="../index.html">Class Index</a>
187
+ | <a href="../files.html">File Index</a></div>
188
+ <hr />
189
+ <h2>Classes</h2>
190
+ <ul class="classList">
191
+
192
+ <li><i><a href="../symbols/_global_.html">_global_</a></i></li>
193
+
194
+ <li><a href="../symbols/Error.html">Error</a></li>
195
+
196
+ <li><a href="../symbols/File.html">File</a></li>
197
+
198
+ <li><a href="../symbols/File.NoSuchFileError.html">File.NoSuchFileError</a></li>
199
+
200
+ <li><a href="../symbols/Kernel.html">Kernel</a></li>
201
+
202
+ <li><a href="../symbols/LoadError.html">LoadError</a></li>
203
+
204
+ <li><a href="../symbols/SelfConceptError.html">SelfConceptError</a></li>
205
+
206
+ <li><a href="../symbols/Sys.html">Sys</a></li>
207
+
208
+ <li><a href="../symbols/XPCBuiltins.html">XPCBuiltins</a></li>
209
+
210
+ </ul>
211
+ <hr />
212
+ <!-- end publish.classesIndex -->
213
+ </div>
214
+
215
+ <div id="content">
216
+ <!-- ============================== class title ============================ -->
217
+ <h1 class="classTitle">
218
+
219
+ Class File
220
+ </h1>
221
+
222
+ <!-- ============================== class summary ========================== -->
223
+ <p class="description">
224
+
225
+
226
+ File class used for things such as creating filesystem paths, reading files, etc.
227
+
228
+
229
+ <br /><i>Defined in: </i> <a href="../symbols/src/lib_file.js.html">file.js</a>.
230
+
231
+ </p>
232
+
233
+ <!-- ============================== constructor summary ==================== -->
234
+
235
+ <table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class File.">
236
+ <caption>Class Summary</caption>
237
+ <thead>
238
+ <tr>
239
+ <th scope="col">Constructor Attributes</th>
240
+ <th scope="col">Constructor Name and Description</th>
241
+ </tr>
242
+ </thead>
243
+ <tbody>
244
+ <tr>
245
+ <td class="attributes">&nbsp;</td>
246
+ <td class="nameDescription" >
247
+ <div class="fixedFont">
248
+ <b><a href="../symbols/File.html#constructor">File</a></b>()
249
+ </div>
250
+ <div class="description"></div>
251
+ </td>
252
+ </tr>
253
+ </tbody>
254
+ </table>
255
+
256
+
257
+ <!-- ============================== properties summary ===================== -->
258
+
259
+
260
+ <!-- ============================== methods summary ======================== -->
261
+
262
+
263
+
264
+ <table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class File.">
265
+ <caption>Method Summary</caption>
266
+ <thead>
267
+ <tr>
268
+ <th scope="col">Method Attributes</th>
269
+ <th scope="col">Method Name and Description</th>
270
+ </tr>
271
+ </thead>
272
+ <tbody>
273
+
274
+ <tr>
275
+ <td class="attributes">&lt;static&gt; &nbsp;</td>
276
+ <td class="nameDescription">
277
+ <div class="fixedFont">File.<b><a href="../symbols/File.html#.join">join</a></b>(components)
278
+ </div>
279
+ <div class="description">Joins the given string arguments together using the operating system's native path
280
+ separator.</div>
281
+ </td>
282
+ </tr>
283
+
284
+ <tr>
285
+ <td class="attributes">&lt;static&gt; &nbsp;</td>
286
+ <td class="nameDescription">
287
+ <div class="fixedFont">File.<b><a href="../symbols/File.html#.read">read</a></b>(filePath, maxBytes)
288
+ </div>
289
+ <div class="description">Reads the given number of bytes (or the entire contents if the argument is ommitted)
290
+ from the specified file</div>
291
+ </td>
292
+ </tr>
293
+
294
+ </tbody>
295
+ </table>
296
+
297
+
298
+
299
+
300
+ <!-- ============================== events summary ======================== -->
301
+
302
+
303
+ <!-- ============================== constructor details ==================== -->
304
+
305
+ <div class="details"><a name="constructor"> </a>
306
+ <div class="sectionTitle">
307
+ Class Detail
308
+ </div>
309
+
310
+ <div class="fixedFont">
311
+ <b>File</b>()
312
+ </div>
313
+
314
+ <div class="description">
315
+
316
+
317
+ </div>
318
+
319
+
320
+
321
+
322
+
323
+
324
+
325
+
326
+
327
+
328
+
329
+
330
+ </div>
331
+
332
+
333
+ <!-- ============================== field details ========================== -->
334
+
335
+
336
+ <!-- ============================== method details ========================= -->
337
+
338
+ <div class="sectionTitle">
339
+ Method Detail
340
+ </div>
341
+
342
+ <a name=".join"> </a>
343
+ <div class="fixedFont">&lt;static&gt;
344
+
345
+ <span class="light">{String}</span>
346
+ <span class="light">File.</span><b>join</b>(components)
347
+
348
+ </div>
349
+ <div class="description">
350
+ Joins the given string arguments together using the operating system's native path
351
+ separator.
352
+
353
+
354
+ </div>
355
+
356
+
357
+
358
+
359
+ <dl class="detailList">
360
+ <dt class="heading">Parameters:</dt>
361
+
362
+ <dt>
363
+ <span class="light fixedFont">{String[]}</span> <b>components</b>
364
+
365
+ </dt>
366
+ <dd>Set of strings to join together.</dd>
367
+
368
+ </dl>
369
+
370
+
371
+
372
+
373
+
374
+ <dl class="detailList">
375
+ <dt class="heading">Returns:</dt>
376
+
377
+ <dd><span class="light fixedFont">{String}</span> The resulting path.</dd>
378
+
379
+ </dl>
380
+
381
+
382
+
383
+
384
+ <hr />
385
+
386
+ <a name=".read"> </a>
387
+ <div class="fixedFont">&lt;static&gt;
388
+
389
+ <span class="light">{String}</span>
390
+ <span class="light">File.</span><b>read</b>(filePath, maxBytes)
391
+
392
+ </div>
393
+ <div class="description">
394
+ Reads the given number of bytes (or the entire contents if the argument is ommitted)
395
+ from the specified file
396
+
397
+
398
+ </div>
399
+
400
+
401
+
402
+
403
+ <dl class="detailList">
404
+ <dt class="heading">Parameters:</dt>
405
+
406
+ <dt>
407
+ <span class="light fixedFont">{String}</span> <b>filePath</b>
408
+
409
+ </dt>
410
+ <dd>Path to a file.</dd>
411
+
412
+ <dt>
413
+ <span class="light fixedFont">{int}</span> <b>maxBytes</b>
414
+ <i>Optional</i>
415
+ </dt>
416
+ <dd>Number of bytes to read from the file. Defaults to entire file.</dd>
417
+
418
+ </dl>
419
+
420
+
421
+
422
+
423
+
424
+ <dl class="detailList">
425
+ <dt class="heading">Returns:</dt>
426
+
427
+ <dd><span class="light fixedFont">{String}</span> The data read from the given file.</dd>
428
+
429
+ </dl>
430
+
431
+
432
+
433
+
434
+
435
+
436
+
437
+
438
+ <!-- ============================== event details ========================= -->
439
+
440
+
441
+ <hr />
442
+ </div>
443
+
444
+
445
+ <!-- ============================== footer ================================= -->
446
+ <div class="fineprint" style="clear:both">
447
+
448
+ Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.3.0 on Mon Oct 05 2009 22:11:36 GMT-0500 (CDT)
449
+ </div>
450
+ </body>
451
+ </html>
data/xpcomcore/doc/symbols/Kernel.html ADDED
@@ -0,0 +1,1098 @@
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
+ <meta name="generator" content="JsDoc Toolkit" />
7
+
8
+ <title>JsDoc Reference - Kernel</title>
9
+
10
+ <style type="text/css">
11
+ /* default.css */
12
+ body
13
+ {
14
+ font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif;
15
+ width: 800px;
16
+ }
17
+
18
+ .header
19
+ {
20
+ clear: both;
21
+ background-color: #ccc;
22
+ padding: 8px;
23
+ }
24
+
25
+ h1
26
+ {
27
+ font-size: 150%;
28
+ font-weight: bold;
29
+ padding: 0;
30
+ margin: 1em 0 0 .3em;
31
+ }
32
+
33
+ hr
34
+ {
35
+ border: none 0;
36
+ border-top: 1px solid #7F8FB1;
37
+ height: 1px;
38
+ }
39
+
40
+ pre.code
41
+ {
42
+ display: block;
43
+ padding: 8px;
44
+ border: 1px dashed #ccc;
45
+ }
46
+
47
+ #index
48
+ {
49
+ margin-top: 24px;
50
+ float: left;
51
+ width: 160px;
52
+ position: absolute;
53
+ left: 8px;
54
+ background-color: #F3F3F3;
55
+ padding: 8px;
56
+ }
57
+
58
+ #content
59
+ {
60
+ margin-left: 190px;
61
+ width: 600px;
62
+ }
63
+
64
+ .classList
65
+ {
66
+ list-style-type: none;
67
+ padding: 0;
68
+ margin: 0 0 0 8px;
69
+ font-family: arial, sans-serif;
70
+ font-size: 1em;
71
+ overflow: auto;
72
+ }
73
+
74
+ .classList li
75
+ {
76
+ padding: 0;
77
+ margin: 0 0 8px 0;
78
+ }
79
+
80
+ .summaryTable { width: 100%; }
81
+
82
+ h1.classTitle
83
+ {
84
+ font-size:170%;
85
+ line-height:130%;
86
+ }
87
+
88
+ h2 { font-size: 110%; }
89
+ caption, div.sectionTitle
90
+ {
91
+ background-color: #7F8FB1;
92
+ color: #fff;
93
+ font-size:130%;
94
+ text-align: left;
95
+ padding: 2px 6px 2px 6px;
96
+ border: 1px #7F8FB1 solid;
97
+ }
98
+
99
+ div.sectionTitle { margin-bottom: 8px; }
100
+ .summaryTable thead { display: none; }
101
+
102
+ .summaryTable td
103
+ {
104
+ vertical-align: top;
105
+ padding: 4px;
106
+ border-bottom: 1px #7F8FB1 solid;
107
+ border-right: 1px #7F8FB1 solid;
108
+ }
109
+
110
+ /*col#summaryAttributes {}*/
111
+ .summaryTable td.attributes
112
+ {
113
+ border-left: 1px #7F8FB1 solid;
114
+ width: 140px;
115
+ text-align: right;
116
+ }
117
+
118
+ td.attributes, .fixedFont
119
+ {
120
+ line-height: 15px;
121
+ color: #002EBE;
122
+ font-family: "Courier New",Courier,monospace;
123
+ font-size: 13px;
124
+ }
125
+
126
+ .summaryTable td.nameDescription
127
+ {
128
+ text-align: left;
129
+ font-size: 13px;
130
+ line-height: 15px;
131
+ }
132
+
133
+ .summaryTable td.nameDescription, .description
134
+ {
135
+ line-height: 15px;
136
+ padding: 4px;
137
+ padding-left: 4px;
138
+ }
139
+
140
+ .summaryTable { margin-bottom: 8px; }
141
+
142
+ ul.inheritsList
143
+ {
144
+ list-style: square;
145
+ margin-left: 20px;
146
+ padding-left: 0;
147
+ }
148
+
149
+ .detailList {
150
+ margin-left: 20px;
151
+ line-height: 15px;
152
+ }
153
+ .detailList dt { margin-left: 20px; }
154
+
155
+ .detailList .heading
156
+ {
157
+ font-weight: bold;
158
+ padding-bottom: 6px;
159
+ margin-left: 0;
160
+ }
161
+
162
+ .light, td.attributes, .light a:link, .light a:visited
163
+ {
164
+ color: #777;
165
+ font-style: italic;
166
+ }
167
+
168
+ .fineprint
169
+ {
170
+ text-align: right;
171
+ font-size: 10px;
172
+ }
173
+ </style>
174
+ </head>
175
+
176
+ <body>
177
+ <!-- ============================== header ================================= -->
178
+ <!-- begin static/header.html -->
179
+ <div id="header">
180
+ </div>
181
+ <!-- end static/header.html -->
182
+
183
+ <!-- ============================== classes index ============================ -->
184
+ <div id="index">
185
+ <!-- begin publish.classesIndex -->
186
+ <div align="center"><a href="../index.html">Class Index</a>
187
+ | <a href="../files.html">File Index</a></div>
188
+ <hr />
189
+ <h2>Classes</h2>
190
+ <ul class="classList">
191
+
192
+ <li><i><a href="../symbols/_global_.html">_global_</a></i></li>
193
+
194
+ <li><a href="../symbols/Error.html">Error</a></li>
195
+
196
+ <li><a href="../symbols/File.html">File</a></li>
197
+
198
+ <li><a href="../symbols/File.NoSuchFileError.html">File.NoSuchFileError</a></li>
199
+
200
+ <li><a href="../symbols/Kernel.html">Kernel</a></li>
201
+
202
+ <li><a href="../symbols/LoadError.html">LoadError</a></li>
203
+
204
+ <li><a href="../symbols/SelfConceptError.html">SelfConceptError</a></li>
205
+
206
+ <li><a href="../symbols/Sys.html">Sys</a></li>
207
+
208
+ <li><a href="../symbols/XPCBuiltins.html">XPCBuiltins</a></li>
209
+
210
+ </ul>
211
+ <hr />
212
+ <!-- end publish.classesIndex -->
213
+ </div>
214
+
215
+ <div id="content">
216
+ <!-- ============================== class title ============================ -->
217
+ <h1 class="classTitle">
218
+
219
+ Class Kernel
220
+ </h1>
221
+
222
+ <!-- ============================== class summary ========================== -->
223
+ <p class="description">
224
+
225
+
226
+ Our central 'class' containing a lot of properties and methods we need to
227
+ build the rest of XPCOMCore on top of.
228
+
229
+
230
+ <br /><i>Defined in: </i> <a href="../symbols/src/lib_kernel.js.html">kernel.js</a>.
231
+
232
+ </p>
233
+
234
+ <!-- ============================== constructor summary ==================== -->
235
+
236
+ <table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class Kernel.">
237
+ <caption>Class Summary</caption>
238
+ <thead>
239
+ <tr>
240
+ <th scope="col">Constructor Attributes</th>
241
+ <th scope="col">Constructor Name and Description</th>
242
+ </tr>
243
+ </thead>
244
+ <tbody>
245
+ <tr>
246
+ <td class="attributes">&nbsp;</td>
247
+ <td class="nameDescription" >
248
+ <div class="fixedFont">
249
+ <b><a href="../symbols/Kernel.html#constructor">Kernel</a></b>(mixinScope)
250
+ </div>
251
+ <div class="description">A pseudo-constructor to make JSDoc happy and actually document things in <a href="../symbols/Kernel.html">Kernel</a>.</div>
252
+ </td>
253
+ </tr>
254
+ </tbody>
255
+ </table>
256
+
257
+
258
+ <!-- ============================== properties summary ===================== -->
259
+
260
+
261
+
262
+ <table class="summaryTable" cellspacing="0" summary="A summary of the fields documented in the class Kernel.">
263
+ <caption>Field Summary</caption>
264
+ <thead>
265
+ <tr>
266
+ <th scope="col">Field Attributes</th>
267
+ <th scope="col">Field Name and Description</th>
268
+ </tr>
269
+ </thead>
270
+ <tbody>
271
+
272
+ <tr>
273
+ <td class="attributes">&nbsp;</td>
274
+ <td class="nameDescription">
275
+ <div class="fixedFont">
276
+ <b><a href="../symbols/Kernel.html#$Cc">$Cc</a></b>
277
+ </div>
278
+ <div class="description">A shortcut constant to Components.classes.</div>
279
+ </td>
280
+ </tr>
281
+
282
+ <tr>
283
+ <td class="attributes">&nbsp;</td>
284
+ <td class="nameDescription">
285
+ <div class="fixedFont">
286
+ <b><a href="../symbols/Kernel.html#$Ci">$Ci</a></b>
287
+ </div>
288
+ <div class="description">A shortcut constant to Components.interfaces.</div>
289
+ </td>
290
+ </tr>
291
+
292
+ <tr>
293
+ <td class="attributes">&nbsp;</td>
294
+ <td class="nameDescription">
295
+ <div class="fixedFont">
296
+ <b><a href="../symbols/Kernel.html#$Cr">$Cr</a></b>
297
+ </div>
298
+ <div class="description">A shortcut constant to Components.results.</div>
299
+ </td>
300
+ </tr>
301
+
302
+ <tr>
303
+ <td class="attributes">&nbsp;</td>
304
+ <td class="nameDescription">
305
+ <div class="fixedFont">
306
+ <b><a href="../symbols/Kernel.html#$Cu">$Cu</a></b>
307
+ </div>
308
+ <div class="description">A shortcut constant to Components.utils.</div>
309
+ </td>
310
+ </tr>
311
+
312
+ <tr>
313
+ <td class="attributes">&nbsp;</td>
314
+ <td class="nameDescription">
315
+ <div class="fixedFont">
316
+ <b><a href="../symbols/Kernel.html#$ENV">$ENV</a></b>
317
+ </div>
318
+ <div class="description">Returns a reference to an object allowing for get()/set() on environment variables.</div>
319
+ </td>
320
+ </tr>
321
+
322
+ <tr>
323
+ <td class="attributes">&nbsp;</td>
324
+ <td class="nameDescription">
325
+ <div class="fixedFont">
326
+ <b><a href="../symbols/Kernel.html#$LOAD_PATH">$LOAD_PATH</a></b>
327
+ </div>
328
+ <div class="description">Taking inspiration from Ruby, this defines the set of paths to check when
329
+ trying to load a file via either <a href="../symbols/Kernel.html#load">Kernel#load</a> or <a href="../symbols/Kernel.html#require">Kernel#require</a>.</div>
330
+ </td>
331
+ </tr>
332
+
333
+ <tr>
334
+ <td class="attributes">&nbsp;</td>
335
+ <td class="nameDescription">
336
+ <div class="fixedFont">
337
+ <b><a href="../symbols/Kernel.html#$LOADED_FEATURES">$LOADED_FEATURES</a></b>
338
+ </div>
339
+ <div class="description">Taking inspiration from Ruby, this defines the currently loaded files that
340
+ have been loaded through <a href="../symbols/Kernel.html#require">Kernel#require</a>.</div>
341
+ </td>
342
+ </tr>
343
+
344
+ </tbody>
345
+ </table>
346
+
347
+
348
+
349
+
350
+
351
+ <!-- ============================== methods summary ======================== -->
352
+
353
+
354
+
355
+ <table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class Kernel.">
356
+ <caption>Method Summary</caption>
357
+ <thead>
358
+ <tr>
359
+ <th scope="col">Method Attributes</th>
360
+ <th scope="col">Method Name and Description</th>
361
+ </tr>
362
+ </thead>
363
+ <tbody>
364
+
365
+ <tr>
366
+ <td class="attributes">&nbsp;</td>
367
+ <td class="nameDescription">
368
+ <div class="fixedFont"><b><a href="../symbols/Kernel.html#$CURRENT_DIRECTORY">$CURRENT_DIRECTORY</a></b>(stackTraversalDepth)
369
+ </div>
370
+ <div class="description">This method tries to determine the filesystem path to parent directory of the caller
371
+ code of this method NOTE - see the note on $CURRENT_FILE, as the same applies here.</div>
372
+ </td>
373
+ </tr>
374
+
375
+ <tr>
376
+ <td class="attributes">&nbsp;</td>
377
+ <td class="nameDescription">
378
+ <div class="fixedFont"><b><a href="../symbols/Kernel.html#$CURRENT_FILE">$CURRENT_FILE</a></b>(stackTraversalDepth)
379
+ </div>
380
+ <div class="description">Taking inspiration from Ruby, this method tries to determine the filesystem path to
381
+ the caller code of this method.</div>
382
+ </td>
383
+ </tr>
384
+
385
+ <tr>
386
+ <td class="attributes">&nbsp;</td>
387
+ <td class="nameDescription">
388
+ <div class="fixedFont"><b><a href="../symbols/Kernel.html#load">load</a></b>(featurePath)
389
+ </div>
390
+ <div class="description">Searches <a href="../symbols/Kernel.html#$LOAD_PATH">Kernel#$LOAD_PATH</a> for files to load into the current global scope.</div>
391
+ </td>
392
+ </tr>
393
+
394
+ <tr>
395
+ <td class="attributes">&lt;inner&gt; &nbsp;</td>
396
+ <td class="nameDescription">
397
+ <div class="fixedFont"><b><a href="../symbols/Kernel.html#-makeCallingGetter">makeCallingGetter</a></b>(attr, argsArray)
398
+ </div>
399
+ <div class="description"></div>
400
+ </td>
401
+ </tr>
402
+
403
+ <tr>
404
+ <td class="attributes">&lt;inner&gt; &nbsp;</td>
405
+ <td class="nameDescription">
406
+ <div class="fixedFont"><b><a href="../symbols/Kernel.html#-makeGetter">makeGetter</a></b>(attr)
407
+ </div>
408
+ <div class="description"></div>
409
+ </td>
410
+ </tr>
411
+
412
+ <tr>
413
+ <td class="attributes">&nbsp;</td>
414
+ <td class="nameDescription">
415
+ <div class="fixedFont"><b><a href="../symbols/Kernel.html#print">print</a></b>(str)
416
+ </div>
417
+ <div class="description">Prints a string to standard out, without a trailing newline.</div>
418
+ </td>
419
+ </tr>
420
+
421
+ <tr>
422
+ <td class="attributes">&nbsp;</td>
423
+ <td class="nameDescription">
424
+ <div class="fixedFont"><b><a href="../symbols/Kernel.html#puts">puts</a></b>(str)
425
+ </div>
426
+ <div class="description">Prints a string to standard out, with a trailing newline.</div>
427
+ </td>
428
+ </tr>
429
+
430
+ <tr>
431
+ <td class="attributes">&nbsp;</td>
432
+ <td class="nameDescription">
433
+ <div class="fixedFont"><b><a href="../symbols/Kernel.html#require">require</a></b>(featurePath)
434
+ </div>
435
+ <div class="description">Searches <a href="../symbols/Kernel.html#$LOAD_PATH">Kernel#$LOAD_PATH</a> for features to load into the current global scope.</div>
436
+ </td>
437
+ </tr>
438
+
439
+ <tr>
440
+ <td class="attributes">&lt;inner&gt; &nbsp;</td>
441
+ <td class="nameDescription">
442
+ <div class="fixedFont"><b><a href="../symbols/Kernel.html#-standardLibraryLoader">standardLibraryLoader</a></b>()
443
+ </div>
444
+ <div class="description"></div>
445
+ </td>
446
+ </tr>
447
+
448
+ </tbody>
449
+ </table>
450
+
451
+
452
+
453
+
454
+ <!-- ============================== events summary ======================== -->
455
+
456
+
457
+ <!-- ============================== constructor details ==================== -->
458
+
459
+ <div class="details"><a name="constructor"> </a>
460
+ <div class="sectionTitle">
461
+ Class Detail
462
+ </div>
463
+
464
+ <div class="fixedFont">
465
+ <b>Kernel</b>(mixinScope)
466
+ </div>
467
+
468
+ <div class="description">
469
+ A pseudo-constructor to make JSDoc happy and actually document things in <a href="../symbols/Kernel.html">Kernel</a>.
470
+ If this method is called with an argument, all properties from <a href="../symbols/Kernel.html">Kernel</a> are taken
471
+ and defined as the return value of getter methods set on the given object.
472
+
473
+ </div>
474
+
475
+
476
+
477
+
478
+
479
+ <dl class="detailList">
480
+ <dt class="heading">Parameters:</dt>
481
+
482
+ <dt>
483
+ <span class="light fixedFont">{Object}</span> <b>mixinScope</b>
484
+
485
+ </dt>
486
+ <dd>Optional argument, any object to mix <a href="../symbols/Kernel.html">Kernel</a>'s properties
487
+ into.</dd>
488
+
489
+ </dl>
490
+
491
+
492
+
493
+
494
+
495
+ <dl class="detailList">
496
+ <dt class="heading">Returns:</dt>
497
+
498
+ <dd>The prototype object of the Kernel function.</dd>
499
+
500
+ </dl>
501
+
502
+
503
+
504
+
505
+ </div>
506
+
507
+
508
+ <!-- ============================== field details ========================== -->
509
+
510
+ <div class="sectionTitle">
511
+ Field Detail
512
+ </div>
513
+
514
+ <a name="$Cc"> </a>
515
+ <div class="fixedFont">
516
+
517
+
518
+ <b>$Cc</b>
519
+
520
+ </div>
521
+ <div class="description">
522
+ A shortcut constant to Components.classes.
523
+
524
+
525
+ </div>
526
+
527
+
528
+
529
+
530
+
531
+
532
+
533
+
534
+ <hr />
535
+
536
+ <a name="$Ci"> </a>
537
+ <div class="fixedFont">
538
+
539
+
540
+ <b>$Ci</b>
541
+
542
+ </div>
543
+ <div class="description">
544
+ A shortcut constant to Components.interfaces.
545
+
546
+
547
+ </div>
548
+
549
+
550
+
551
+
552
+
553
+
554
+
555
+
556
+ <hr />
557
+
558
+ <a name="$Cr"> </a>
559
+ <div class="fixedFont">
560
+
561
+
562
+ <b>$Cr</b>
563
+
564
+ </div>
565
+ <div class="description">
566
+ A shortcut constant to Components.results.
567
+
568
+
569
+ </div>
570
+
571
+
572
+
573
+
574
+
575
+
576
+
577
+
578
+ <hr />
579
+
580
+ <a name="$Cu"> </a>
581
+ <div class="fixedFont">
582
+
583
+
584
+ <b>$Cu</b>
585
+
586
+ </div>
587
+ <div class="description">
588
+ A shortcut constant to Components.utils.
589
+
590
+
591
+ </div>
592
+
593
+
594
+
595
+
596
+
597
+
598
+
599
+
600
+ <hr />
601
+
602
+ <a name="$ENV"> </a>
603
+ <div class="fixedFont">
604
+
605
+ <span class="light">{nsIEnvironment}</span>
606
+ <b>$ENV</b>
607
+
608
+ </div>
609
+ <div class="description">
610
+ Returns a reference to an object allowing for get()/set() on environment variables.
611
+
612
+
613
+ </div>
614
+
615
+
616
+
617
+
618
+
619
+
620
+
621
+
622
+ <hr />
623
+
624
+ <a name="$LOAD_PATH"> </a>
625
+ <div class="fixedFont">
626
+
627
+ <span class="light">{Array}</span>
628
+ <b>$LOAD_PATH</b>
629
+
630
+ </div>
631
+ <div class="description">
632
+ Taking inspiration from Ruby, this defines the set of paths to check when
633
+ trying to load a file via either <a href="../symbols/Kernel.html#load">Kernel#load</a> or <a href="../symbols/Kernel.html#require">Kernel#require</a>.
634
+
635
+
636
+ </div>
637
+
638
+
639
+
640
+
641
+
642
+
643
+
644
+
645
+ <hr />
646
+
647
+ <a name="$LOADED_FEATURES"> </a>
648
+ <div class="fixedFont">
649
+
650
+ <span class="light">{Array}</span>
651
+ <b>$LOADED_FEATURES</b>
652
+
653
+ </div>
654
+ <div class="description">
655
+ Taking inspiration from Ruby, this defines the currently loaded files that
656
+ have been loaded through <a href="../symbols/Kernel.html#require">Kernel#require</a>.
657
+
658
+
659
+ </div>
660
+
661
+
662
+
663
+
664
+
665
+
666
+
667
+
668
+
669
+
670
+
671
+
672
+ <!-- ============================== method details ========================= -->
673
+
674
+ <div class="sectionTitle">
675
+ Method Detail
676
+ </div>
677
+
678
+ <a name="$CURRENT_DIRECTORY"> </a>
679
+ <div class="fixedFont">
680
+
681
+ <span class="light">{String}</span>
682
+ <b>$CURRENT_DIRECTORY</b>(stackTraversalDepth)
683
+
684
+ </div>
685
+ <div class="description">
686
+ This method tries to determine the filesystem path to parent directory of the caller
687
+ code of this method NOTE - see the note on $CURRENT_FILE, as the same applies here.
688
+
689
+
690
+ </div>
691
+
692
+
693
+
694
+
695
+ <dl class="detailList">
696
+ <dt class="heading">Parameters:</dt>
697
+
698
+ <dt>
699
+ <span class="light fixedFont">{int}</span> <b>stackTraversalDepth</b>
700
+
701
+ </dt>
702
+ <dd>Optional argument, how far to look up the stack to
703
+ figure out who called us. The default is usually safe.</dd>
704
+
705
+ </dl>
706
+
707
+
708
+
709
+
710
+ <dl class="detailList">
711
+ <dt class="heading">Throws:</dt>
712
+
713
+ <dt>
714
+ <span class="light fixedFont">{<a href="../symbols/SelfConceptError.html">SelfConceptError</a>}</span> <b></b>
715
+ </dt>
716
+ <dd>Thrown when we can't figure out what the filesystem
717
+ path to the parent directory of the current file is.</dd>
718
+
719
+ </dl>
720
+
721
+
722
+ <dl class="detailList">
723
+ <dt class="heading">Returns:</dt>
724
+
725
+ <dd><span class="light fixedFont">{String}</span> The path to the current directory</dd>
726
+
727
+ </dl>
728
+
729
+
730
+
731
+
732
+ <hr />
733
+
734
+ <a name="$CURRENT_FILE"> </a>
735
+ <div class="fixedFont">
736
+
737
+ <span class="light">{String}</span>
738
+ <b>$CURRENT_FILE</b>(stackTraversalDepth)
739
+
740
+ </div>
741
+ <div class="description">
742
+ Taking inspiration from Ruby, this method tries to determine the filesystem path to
743
+ the caller code of this method.
744
+ NOTE - when <a href="../symbols/Kernel.html">Kernel</a> is mixed into an object, this function gets mixed in via
745
+ a special case behaviour that makes it a getter that actually calls the function
746
+ rather than returning the function object itself. This is to facilitate being able
747
+ to call '$CURRENT_FILE' in your code rather than '$CURRENT_FILE()'. The stackTraversalDepth
748
+ parameter is there for this reason, since we need to traverse the stack further than
749
+ normal to find the calling scope than we normally would.
750
+
751
+
752
+ </div>
753
+
754
+
755
+
756
+
757
+ <dl class="detailList">
758
+ <dt class="heading">Parameters:</dt>
759
+
760
+ <dt>
761
+ <span class="light fixedFont">{int}</span> <b>stackTraversalDepth</b>
762
+
763
+ </dt>
764
+ <dd>Optional argument, how far to look up the stack to
765
+ figure out who called us. The default is usually safe.</dd>
766
+
767
+ </dl>
768
+
769
+
770
+
771
+
772
+ <dl class="detailList">
773
+ <dt class="heading">Throws:</dt>
774
+
775
+ <dt>
776
+ <span class="light fixedFont">{<a href="../symbols/SelfConceptError.html">SelfConceptError</a>}</span> <b></b>
777
+ </dt>
778
+ <dd>Thrown when we can't figure out what the filesystem
779
+ path to the current file is.</dd>
780
+
781
+ </dl>
782
+
783
+
784
+ <dl class="detailList">
785
+ <dt class="heading">Returns:</dt>
786
+
787
+ <dd><span class="light fixedFont">{String}</span> The path to the current file</dd>
788
+
789
+ </dl>
790
+
791
+
792
+
793
+
794
+ <hr />
795
+
796
+ <a name="load"> </a>
797
+ <div class="fixedFont">
798
+
799
+ <span class="light">{Boolean}</span>
800
+ <b>load</b>(featurePath)
801
+
802
+ </div>
803
+ <div class="description">
804
+ Searches <a href="../symbols/Kernel.html#$LOAD_PATH">Kernel#$LOAD_PATH</a> for files to load into the current global scope.
805
+ Files loaded via this method will not be added to <a href="../symbols/Kernel.html#$LOADED_FEATURES">Kernel#$LOADED_FEATURES</a> and hence
806
+ can be repeatedly loaded and executed.
807
+
808
+
809
+ </div>
810
+
811
+
812
+
813
+
814
+ <dl class="detailList">
815
+ <dt class="heading">Parameters:</dt>
816
+
817
+ <dt>
818
+ <span class="light fixedFont">{String}</span> <b>featurePath</b>
819
+
820
+ </dt>
821
+ <dd>Full or relative path including file extension to try and load.</dd>
822
+
823
+ </dl>
824
+
825
+
826
+
827
+
828
+ <dl class="detailList">
829
+ <dt class="heading">Throws:</dt>
830
+
831
+ <dt>
832
+ <span class="light fixedFont">{<a href="../symbols/LoadError.html">LoadError</a>}</span> <b></b>
833
+ </dt>
834
+ <dd>Thrown when we can't find the specified file in any directories specified
835
+ in <a href="../symbols/Kernel.html#$LOAD_PATH">Kernel#$LOAD_PATH</a>.</dd>
836
+
837
+ </dl>
838
+
839
+
840
+ <dl class="detailList">
841
+ <dt class="heading">Returns:</dt>
842
+
843
+ <dd><span class="light fixedFont">{Boolean}</span> True if the file was loaded succesfully</dd>
844
+
845
+ </dl>
846
+
847
+
848
+
849
+
850
+ <hr />
851
+
852
+ <a name="-makeCallingGetter"> </a>
853
+ <div class="fixedFont">&lt;inner&gt;
854
+
855
+
856
+ <b>makeCallingGetter</b>(attr, argsArray)
857
+
858
+ </div>
859
+ <div class="description">
860
+
861
+
862
+
863
+ </div>
864
+
865
+
866
+
867
+
868
+ <dl class="detailList">
869
+ <dt class="heading">Parameters:</dt>
870
+
871
+ <dt>
872
+ <b>attr</b>
873
+
874
+ </dt>
875
+ <dd></dd>
876
+
877
+ <dt>
878
+ <b>argsArray</b>
879
+
880
+ </dt>
881
+ <dd></dd>
882
+
883
+ </dl>
884
+
885
+
886
+
887
+
888
+
889
+
890
+
891
+
892
+ <hr />
893
+
894
+ <a name="-makeGetter"> </a>
895
+ <div class="fixedFont">&lt;inner&gt;
896
+
897
+
898
+ <b>makeGetter</b>(attr)
899
+
900
+ </div>
901
+ <div class="description">
902
+
903
+
904
+
905
+ </div>
906
+
907
+
908
+
909
+
910
+ <dl class="detailList">
911
+ <dt class="heading">Parameters:</dt>
912
+
913
+ <dt>
914
+ <b>attr</b>
915
+
916
+ </dt>
917
+ <dd></dd>
918
+
919
+ </dl>
920
+
921
+
922
+
923
+
924
+
925
+
926
+
927
+
928
+ <hr />
929
+
930
+ <a name="print"> </a>
931
+ <div class="fixedFont">
932
+
933
+
934
+ <b>print</b>(str)
935
+
936
+ </div>
937
+ <div class="description">
938
+ Prints a string to standard out, without a trailing newline.
939
+
940
+
941
+ </div>
942
+
943
+
944
+
945
+
946
+ <dl class="detailList">
947
+ <dt class="heading">Parameters:</dt>
948
+
949
+ <dt>
950
+ <span class="light fixedFont">{String}</span> <b>str</b>
951
+
952
+ </dt>
953
+ <dd>String to print to standard out.</dd>
954
+
955
+ </dl>
956
+
957
+
958
+
959
+
960
+
961
+
962
+
963
+
964
+ <hr />
965
+
966
+ <a name="puts"> </a>
967
+ <div class="fixedFont">
968
+
969
+
970
+ <b>puts</b>(str)
971
+
972
+ </div>
973
+ <div class="description">
974
+ Prints a string to standard out, with a trailing newline.
975
+
976
+
977
+ </div>
978
+
979
+
980
+
981
+
982
+ <dl class="detailList">
983
+ <dt class="heading">Parameters:</dt>
984
+
985
+ <dt>
986
+ <span class="light fixedFont">{String}</span> <b>str</b>
987
+
988
+ </dt>
989
+ <dd>String to print to standard out.</dd>
990
+
991
+ </dl>
992
+
993
+
994
+
995
+
996
+
997
+
998
+
999
+
1000
+ <hr />
1001
+
1002
+ <a name="require"> </a>
1003
+ <div class="fixedFont">
1004
+
1005
+ <span class="light">{Boolean}</span>
1006
+ <b>require</b>(featurePath)
1007
+
1008
+ </div>
1009
+ <div class="description">
1010
+ Searches <a href="../symbols/Kernel.html#$LOAD_PATH">Kernel#$LOAD_PATH</a> for features to load into the current global scope.
1011
+ Files loaded via this method will be added to <a href="../symbols/Kernel.html#$LOADED_FEATURES">Kernel#$LOADED_FEATURES</a> and hence two
1012
+ consecutive calls to this method will not load and execute the code twice.
1013
+
1014
+
1015
+ </div>
1016
+
1017
+
1018
+
1019
+
1020
+ <dl class="detailList">
1021
+ <dt class="heading">Parameters:</dt>
1022
+
1023
+ <dt>
1024
+ <span class="light fixedFont">{String}</span> <b>featurePath</b>
1025
+
1026
+ </dt>
1027
+ <dd>Full or relative path without the file extension to try and require.</dd>
1028
+
1029
+ </dl>
1030
+
1031
+
1032
+
1033
+
1034
+ <dl class="detailList">
1035
+ <dt class="heading">Throws:</dt>
1036
+
1037
+ <dt>
1038
+ <span class="light fixedFont">{<a href="../symbols/LoadError.html">LoadError</a>}</span> <b></b>
1039
+ </dt>
1040
+ <dd>Thrown when we can't find the specified feature in any directories specified
1041
+ in <a href="../symbols/Kernel.html#$LOAD_PATH">Kernel#$LOAD_PATH</a>.</dd>
1042
+
1043
+ </dl>
1044
+
1045
+
1046
+ <dl class="detailList">
1047
+ <dt class="heading">Returns:</dt>
1048
+
1049
+ <dd><span class="light fixedFont">{Boolean}</span> True if successful, false if the specified feature has already been required.</dd>
1050
+
1051
+ </dl>
1052
+
1053
+
1054
+
1055
+
1056
+ <hr />
1057
+
1058
+ <a name="-standardLibraryLoader"> </a>
1059
+ <div class="fixedFont">&lt;inner&gt;
1060
+
1061
+
1062
+ <b>standardLibraryLoader</b>()
1063
+
1064
+ </div>
1065
+ <div class="description">
1066
+
1067
+
1068
+
1069
+ </div>
1070
+
1071
+
1072
+
1073
+
1074
+
1075
+
1076
+
1077
+
1078
+
1079
+
1080
+
1081
+
1082
+
1083
+
1084
+
1085
+ <!-- ============================== event details ========================= -->
1086
+
1087
+
1088
+ <hr />
1089
+ </div>
1090
+
1091
+
1092
+ <!-- ============================== footer ================================= -->
1093
+ <div class="fineprint" style="clear:both">
1094
+
1095
+ Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.3.0 on Mon Oct 05 2009 22:11:36 GMT-0500 (CDT)
1096
+ </div>
1097
+ </body>
1098
+ </html>