xpcomcore-rubygem 0.3.2 → 0.5.0
Sign up to get free protection for your applications and to get access to all the features.
- data/README.markdown +14 -0
- data/Rakefile +13 -11
- data/VERSION +1 -1
- data/bin/xpcomcore +7 -0
- data/lib/xpcomcore-rubygem.rb +9 -0
- data/lib/xpcomcore-rubygem/commands.rb +54 -0
- data/lib/xpcomcore-rubygem/commands/generate.rb +23 -0
- data/lib/xpcomcore-rubygem/commands/generate/application.rb +63 -0
- data/lib/xpcomcore-rubygem/commands/generate/jeweler_builder_command.rb +108 -0
- data/lib/xpcomcore-rubygem/commands/generate/library.rb +25 -0
- data/lib/xpcomcore-rubygem/commands/generate/template_helpers.rb +78 -0
- data/lib/xpcomcore-rubygem/commands/launch.rb +129 -0
- data/templates/application/application.ini.erb +12 -0
- data/templates/application/chrome/chrome.manifest.erb +1 -0
- data/templates/application/chrome/content/xul/main_window.xul.erb +6 -0
- data/{extension → templates/application}/components/bootstrapper.js +1 -1
- data/templates/application/defaults/preferences/prefs.js.erb +7 -0
- data/templates/shared/jsdoc_doc_task.erb +7 -0
- data/templates/shared/xultestrunner_test_task.erb +7 -0
- data/xpcomcore-rubygem.gemspec +48 -136
- data/xpcomcore/Rakefile +42 -19
- data/xpcomcore/bootstrapper.js +1 -3
- data/xpcomcore/{VERSION.yml → build_properties.yml} +3 -0
- data/xpcomcore/components/XPCOMCore.js +0 -2
- data/xpcomcore/doc/files.html +10 -10
- data/xpcomcore/doc/index.html +17 -17
- data/xpcomcore/doc/symbols/_global_.html +10 -9
- data/xpcomcore/doc/symbols/{Error.html → error.html} +10 -9
- data/xpcomcore/doc/symbols/{File.html → file.html} +13 -12
- data/xpcomcore/doc/symbols/{File.NoSuchFileError.html → file.nosuchfileerror.html} +13 -12
- data/xpcomcore/doc/symbols/{Kernel.html → kernel.html} +48 -47
- data/xpcomcore/doc/symbols/{LoadError.html → loaderror.html} +13 -12
- data/xpcomcore/doc/symbols/{SelfConceptError.html → selfconcepterror.html} +13 -12
- data/xpcomcore/doc/symbols/{Sys.html → sys.html} +12 -11
- data/xpcomcore/doc/symbols/{XPCBuiltins.html → xpcbuiltins.html} +11 -10
- metadata +61 -135
- data/README.rdoc +0 -18
- data/bin/xpcomcore-firefox +0 -4
- data/bin/xpcomcore-rubygem-install +0 -205
- data/extension/README.txt +0 -1
- data/extension/install.rdf +0 -16
- data/xpcomcore/etc/jsdoc-toolkit/README.txt +0 -186
- data/xpcomcore/etc/jsdoc-toolkit/app/frame.js +0 -33
- data/xpcomcore/etc/jsdoc-toolkit/app/frame/Chain.js +0 -102
- data/xpcomcore/etc/jsdoc-toolkit/app/frame/Dumper.js +0 -144
- data/xpcomcore/etc/jsdoc-toolkit/app/frame/Hash.js +0 -84
- data/xpcomcore/etc/jsdoc-toolkit/app/frame/Link.js +0 -153
- data/xpcomcore/etc/jsdoc-toolkit/app/frame/Namespace.js +0 -10
- data/xpcomcore/etc/jsdoc-toolkit/app/frame/Opt.js +0 -134
- data/xpcomcore/etc/jsdoc-toolkit/app/frame/Reflection.js +0 -26
- data/xpcomcore/etc/jsdoc-toolkit/app/frame/String.js +0 -93
- data/xpcomcore/etc/jsdoc-toolkit/app/frame/Testrun.js +0 -129
- data/xpcomcore/etc/jsdoc-toolkit/app/handlers/FOODOC.js +0 -26
- data/xpcomcore/etc/jsdoc-toolkit/app/handlers/XMLDOC.js +0 -26
- data/xpcomcore/etc/jsdoc-toolkit/app/handlers/XMLDOC/DomReader.js +0 -159
- data/xpcomcore/etc/jsdoc-toolkit/app/handlers/XMLDOC/XMLDoc.js +0 -16
- data/xpcomcore/etc/jsdoc-toolkit/app/handlers/XMLDOC/XMLParse.js +0 -292
- data/xpcomcore/etc/jsdoc-toolkit/app/lib/JSDOC.js +0 -104
- data/xpcomcore/etc/jsdoc-toolkit/app/lib/JSDOC/DocComment.js +0 -200
- data/xpcomcore/etc/jsdoc-toolkit/app/lib/JSDOC/DocTag.js +0 -294
- data/xpcomcore/etc/jsdoc-toolkit/app/lib/JSDOC/JsDoc.js +0 -126
- data/xpcomcore/etc/jsdoc-toolkit/app/lib/JSDOC/JsPlate.js +0 -109
- data/xpcomcore/etc/jsdoc-toolkit/app/lib/JSDOC/Lang.js +0 -144
- data/xpcomcore/etc/jsdoc-toolkit/app/lib/JSDOC/Parser.js +0 -145
- data/xpcomcore/etc/jsdoc-toolkit/app/lib/JSDOC/PluginManager.js +0 -33
- data/xpcomcore/etc/jsdoc-toolkit/app/lib/JSDOC/Symbol.js +0 -645
- data/xpcomcore/etc/jsdoc-toolkit/app/lib/JSDOC/SymbolSet.js +0 -241
- data/xpcomcore/etc/jsdoc-toolkit/app/lib/JSDOC/TextStream.js +0 -41
- data/xpcomcore/etc/jsdoc-toolkit/app/lib/JSDOC/Token.js +0 -18
- data/xpcomcore/etc/jsdoc-toolkit/app/lib/JSDOC/TokenReader.js +0 -332
- data/xpcomcore/etc/jsdoc-toolkit/app/lib/JSDOC/TokenStream.js +0 -133
- data/xpcomcore/etc/jsdoc-toolkit/app/lib/JSDOC/Util.js +0 -32
- data/xpcomcore/etc/jsdoc-toolkit/app/lib/JSDOC/Walker.js +0 -474
- data/xpcomcore/etc/jsdoc-toolkit/app/main.js +0 -111
- data/xpcomcore/etc/jsdoc-toolkit/app/plugins/commentSrcJson.js +0 -20
- data/xpcomcore/etc/jsdoc-toolkit/app/plugins/frameworkPrototype.js +0 -16
- data/xpcomcore/etc/jsdoc-toolkit/app/plugins/functionCall.js +0 -10
- data/xpcomcore/etc/jsdoc-toolkit/app/plugins/publishSrcHilite.js +0 -62
- data/xpcomcore/etc/jsdoc-toolkit/app/plugins/symbolLink.js +0 -10
- data/xpcomcore/etc/jsdoc-toolkit/app/plugins/tagParamConfig.js +0 -31
- data/xpcomcore/etc/jsdoc-toolkit/app/plugins/tagSynonyms.js +0 -43
- data/xpcomcore/etc/jsdoc-toolkit/app/run.js +0 -348
- data/xpcomcore/etc/jsdoc-toolkit/app/t/TestDoc.js +0 -144
- data/xpcomcore/etc/jsdoc-toolkit/app/t/runner.js +0 -13
- data/xpcomcore/etc/jsdoc-toolkit/app/test.js +0 -325
- data/xpcomcore/etc/jsdoc-toolkit/app/test/addon.js +0 -24
- data/xpcomcore/etc/jsdoc-toolkit/app/test/anon_inner.js +0 -14
- data/xpcomcore/etc/jsdoc-toolkit/app/test/augments.js +0 -31
- data/xpcomcore/etc/jsdoc-toolkit/app/test/augments2.js +0 -26
- data/xpcomcore/etc/jsdoc-toolkit/app/test/borrows.js +0 -46
- data/xpcomcore/etc/jsdoc-toolkit/app/test/borrows2.js +0 -23
- data/xpcomcore/etc/jsdoc-toolkit/app/test/config.js +0 -22
- data/xpcomcore/etc/jsdoc-toolkit/app/test/constructs.js +0 -18
- data/xpcomcore/etc/jsdoc-toolkit/app/test/encoding.js +0 -10
- data/xpcomcore/etc/jsdoc-toolkit/app/test/encoding_other.js +0 -12
- data/xpcomcore/etc/jsdoc-toolkit/app/test/event.js +0 -54
- data/xpcomcore/etc/jsdoc-toolkit/app/test/exports.js +0 -14
- data/xpcomcore/etc/jsdoc-toolkit/app/test/functions_anon.js +0 -39
- data/xpcomcore/etc/jsdoc-toolkit/app/test/functions_nested.js +0 -33
- data/xpcomcore/etc/jsdoc-toolkit/app/test/global.js +0 -13
- data/xpcomcore/etc/jsdoc-toolkit/app/test/globals.js +0 -25
- data/xpcomcore/etc/jsdoc-toolkit/app/test/ignore.js +0 -10
- data/xpcomcore/etc/jsdoc-toolkit/app/test/inner.js +0 -16
- data/xpcomcore/etc/jsdoc-toolkit/app/test/jsdoc_test.js +0 -477
- data/xpcomcore/etc/jsdoc-toolkit/app/test/lend.js +0 -33
- data/xpcomcore/etc/jsdoc-toolkit/app/test/memberof.js +0 -19
- data/xpcomcore/etc/jsdoc-toolkit/app/test/memberof_constructor.js +0 -17
- data/xpcomcore/etc/jsdoc-toolkit/app/test/module.js +0 -17
- data/xpcomcore/etc/jsdoc-toolkit/app/test/name.js +0 -19
- data/xpcomcore/etc/jsdoc-toolkit/app/test/namespace_nested.js +0 -23
- data/xpcomcore/etc/jsdoc-toolkit/app/test/nocode.js +0 -13
- data/xpcomcore/etc/jsdoc-toolkit/app/test/oblit_anon.js +0 -20
- data/xpcomcore/etc/jsdoc-toolkit/app/test/overview.js +0 -20
- data/xpcomcore/etc/jsdoc-toolkit/app/test/param_inline.js +0 -37
- data/xpcomcore/etc/jsdoc-toolkit/app/test/params_optional.js +0 -8
- data/xpcomcore/etc/jsdoc-toolkit/app/test/prototype.js +0 -17
- data/xpcomcore/etc/jsdoc-toolkit/app/test/prototype_nested.js +0 -9
- data/xpcomcore/etc/jsdoc-toolkit/app/test/prototype_oblit.js +0 -13
- data/xpcomcore/etc/jsdoc-toolkit/app/test/prototype_oblit_constructor.js +0 -24
- data/xpcomcore/etc/jsdoc-toolkit/app/test/public.js +0 -10
- data/xpcomcore/etc/jsdoc-toolkit/app/test/scripts/code.js +0 -5
- data/xpcomcore/etc/jsdoc-toolkit/app/test/scripts/notcode.txt +0 -5
- data/xpcomcore/etc/jsdoc-toolkit/app/test/shared.js +0 -42
- data/xpcomcore/etc/jsdoc-toolkit/app/test/shared2.js +0 -2
- data/xpcomcore/etc/jsdoc-toolkit/app/test/shortcuts.js +0 -22
- data/xpcomcore/etc/jsdoc-toolkit/app/test/static_this.js +0 -13
- data/xpcomcore/etc/jsdoc-toolkit/app/test/synonyms.js +0 -31
- data/xpcomcore/etc/jsdoc-toolkit/app/test/tosource.js +0 -23
- data/xpcomcore/etc/jsdoc-toolkit/app/test/variable_redefine.js +0 -14
- data/xpcomcore/etc/jsdoc-toolkit/changes.txt +0 -96
- data/xpcomcore/etc/jsdoc-toolkit/conf/sample.conf +0 -31
- data/xpcomcore/etc/jsdoc-toolkit/java/build.xml +0 -36
- data/xpcomcore/etc/jsdoc-toolkit/java/build_1.4.xml +0 -36
- data/xpcomcore/etc/jsdoc-toolkit/java/classes/js.jar +0 -0
- data/xpcomcore/etc/jsdoc-toolkit/java/src/JsDebugRun.java +0 -21
- data/xpcomcore/etc/jsdoc-toolkit/java/src/JsRun.java +0 -21
- data/xpcomcore/etc/jsdoc-toolkit/jsdebug.jar +0 -0
- data/xpcomcore/etc/jsdoc-toolkit/jsrun.jar +0 -0
- data/xpcomcore/etc/jsdoc-toolkit/jsrun.sh +0 -52
- data/xpcomcore/etc/jsdoc-toolkit/templates/jsdoc/allclasses.tmpl +0 -17
- data/xpcomcore/etc/jsdoc-toolkit/templates/jsdoc/allfiles.tmpl +0 -56
- data/xpcomcore/etc/jsdoc-toolkit/templates/jsdoc/class.tmpl +0 -646
- data/xpcomcore/etc/jsdoc-toolkit/templates/jsdoc/index.tmpl +0 -39
- data/xpcomcore/etc/jsdoc-toolkit/templates/jsdoc/publish.js +0 -200
- data/xpcomcore/etc/jsdoc-toolkit/templates/jsdoc/static/default.css +0 -162
- data/xpcomcore/etc/jsdoc-toolkit/templates/jsdoc/static/header.html +0 -2
- data/xpcomcore/etc/jsdoc-toolkit/templates/jsdoc/static/index.html +0 -19
- data/xpcomcore/etc/jsdoc-toolkit/templates/jsdoc/symbol.tmpl +0 -35
data/xpcomcore/doc/index.html
CHANGED
|
@@ -186,21 +186,21 @@ ul.inheritsList
|
|
|
186
186
|
|
|
187
187
|
<li><i><a href="symbols/_global_.html">_global_</a></i></li>
|
|
188
188
|
|
|
189
|
-
<li><a href="symbols/
|
|
189
|
+
<li><a href="symbols/error.html">Error</a></li>
|
|
190
190
|
|
|
191
|
-
<li><a href="symbols/
|
|
191
|
+
<li><a href="symbols/file.html">File</a></li>
|
|
192
192
|
|
|
193
|
-
<li><a href="symbols/
|
|
193
|
+
<li><a href="symbols/file.nosuchfileerror.html">File.NoSuchFileError</a></li>
|
|
194
194
|
|
|
195
|
-
<li><a href="symbols/
|
|
195
|
+
<li><a href="symbols/kernel.html">Kernel</a></li>
|
|
196
196
|
|
|
197
|
-
<li><a href="symbols/
|
|
197
|
+
<li><a href="symbols/loaderror.html">LoadError</a></li>
|
|
198
198
|
|
|
199
|
-
<li><a href="symbols/
|
|
199
|
+
<li><a href="symbols/selfconcepterror.html">SelfConceptError</a></li>
|
|
200
200
|
|
|
201
|
-
<li><a href="symbols/
|
|
201
|
+
<li><a href="symbols/sys.html">Sys</a></li>
|
|
202
202
|
|
|
203
|
-
<li><a href="symbols/
|
|
203
|
+
<li><a href="symbols/xpcbuiltins.html">XPCBuiltins</a></li>
|
|
204
204
|
|
|
205
205
|
</ul>
|
|
206
206
|
<hr />
|
|
@@ -217,50 +217,50 @@ ul.inheritsList
|
|
|
217
217
|
<hr />
|
|
218
218
|
|
|
219
219
|
<div>
|
|
220
|
-
<h2><a href="symbols/
|
|
220
|
+
<h2><a href="symbols/error.html">Error</a></h2>
|
|
221
221
|
|
|
222
222
|
</div>
|
|
223
223
|
<hr />
|
|
224
224
|
|
|
225
225
|
<div>
|
|
226
|
-
<h2><a href="symbols/
|
|
226
|
+
<h2><a href="symbols/file.html">File</a></h2>
|
|
227
227
|
File class used for things such as creating filesystem paths, reading files, etc.
|
|
228
228
|
</div>
|
|
229
229
|
<hr />
|
|
230
230
|
|
|
231
231
|
<div>
|
|
232
|
-
<h2><a href="symbols/
|
|
232
|
+
<h2><a href="symbols/file.nosuchfileerror.html">File.NoSuchFileError</a></h2>
|
|
233
233
|
Exception representing an error loading a file.
|
|
234
234
|
</div>
|
|
235
235
|
<hr />
|
|
236
236
|
|
|
237
237
|
<div>
|
|
238
|
-
<h2><a href="symbols/
|
|
238
|
+
<h2><a href="symbols/kernel.html">Kernel</a></h2>
|
|
239
239
|
Our central 'class' containing a lot of properties and methods we need to
|
|
240
240
|
build the rest of XPCOMCore on top of.
|
|
241
241
|
</div>
|
|
242
242
|
<hr />
|
|
243
243
|
|
|
244
244
|
<div>
|
|
245
|
-
<h2><a href="symbols/
|
|
245
|
+
<h2><a href="symbols/loaderror.html">LoadError</a></h2>
|
|
246
246
|
Exception representing an error loading a file.
|
|
247
247
|
</div>
|
|
248
248
|
<hr />
|
|
249
249
|
|
|
250
250
|
<div>
|
|
251
|
-
<h2><a href="symbols/
|
|
251
|
+
<h2><a href="symbols/selfconcepterror.html">SelfConceptError</a></h2>
|
|
252
252
|
Exception representing an error determining what the path to the currently executing file is.
|
|
253
253
|
</div>
|
|
254
254
|
<hr />
|
|
255
255
|
|
|
256
256
|
<div>
|
|
257
|
-
<h2><a href="symbols/
|
|
257
|
+
<h2><a href="symbols/sys.html">Sys</a></h2>
|
|
258
258
|
Sys namespace used for things such as executing external commands.
|
|
259
259
|
</div>
|
|
260
260
|
<hr />
|
|
261
261
|
|
|
262
262
|
<div>
|
|
263
|
-
<h2><a href="symbols/
|
|
263
|
+
<h2><a href="symbols/xpcbuiltins.html">XPCBuiltins</a></h2>
|
|
264
264
|
XPCBuiltins namespace used for holding constructors for standard XPCOM objects.
|
|
265
265
|
</div>
|
|
266
266
|
<hr />
|
|
@@ -269,7 +269,7 @@ build the rest of XPCOMCore on top of.
|
|
|
269
269
|
</div>
|
|
270
270
|
<div class="fineprint" style="clear:both">
|
|
271
271
|
|
|
272
|
-
Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blankt">JsDoc Toolkit</a> 2.3.
|
|
272
|
+
Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blankt">JsDoc Toolkit</a> 2.3.2 on Sun Oct 11 2009 18:59:13 GMT-0500 (CDT)
|
|
273
273
|
</div>
|
|
274
274
|
</body>
|
|
275
275
|
</html>
|
|
@@ -191,21 +191,21 @@ ul.inheritsList
|
|
|
191
191
|
|
|
192
192
|
<li><i><a href="../symbols/_global_.html">_global_</a></i></li>
|
|
193
193
|
|
|
194
|
-
<li><a href="../symbols/
|
|
194
|
+
<li><a href="../symbols/error.html">Error</a></li>
|
|
195
195
|
|
|
196
|
-
<li><a href="../symbols/
|
|
196
|
+
<li><a href="../symbols/file.html">File</a></li>
|
|
197
197
|
|
|
198
|
-
<li><a href="../symbols/
|
|
198
|
+
<li><a href="../symbols/file.nosuchfileerror.html">File.NoSuchFileError</a></li>
|
|
199
199
|
|
|
200
|
-
<li><a href="../symbols/
|
|
200
|
+
<li><a href="../symbols/kernel.html">Kernel</a></li>
|
|
201
201
|
|
|
202
|
-
<li><a href="../symbols/
|
|
202
|
+
<li><a href="../symbols/loaderror.html">LoadError</a></li>
|
|
203
203
|
|
|
204
|
-
<li><a href="../symbols/
|
|
204
|
+
<li><a href="../symbols/selfconcepterror.html">SelfConceptError</a></li>
|
|
205
205
|
|
|
206
|
-
<li><a href="../symbols/
|
|
206
|
+
<li><a href="../symbols/sys.html">Sys</a></li>
|
|
207
207
|
|
|
208
|
-
<li><a href="../symbols/
|
|
208
|
+
<li><a href="../symbols/xpcbuiltins.html">XPCBuiltins</a></li>
|
|
209
209
|
|
|
210
210
|
</ul>
|
|
211
211
|
<hr />
|
|
@@ -222,6 +222,7 @@ ul.inheritsList
|
|
|
222
222
|
<!-- ============================== class summary ========================== -->
|
|
223
223
|
<p class="description">
|
|
224
224
|
|
|
225
|
+
|
|
225
226
|
|
|
226
227
|
|
|
227
228
|
|
|
@@ -258,7 +259,7 @@ ul.inheritsList
|
|
|
258
259
|
<!-- ============================== footer ================================= -->
|
|
259
260
|
<div class="fineprint" style="clear:both">
|
|
260
261
|
|
|
261
|
-
Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.3.
|
|
262
|
+
Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.3.2 on Sun Oct 11 2009 18:59:12 GMT-0500 (CDT)
|
|
262
263
|
</div>
|
|
263
264
|
</body>
|
|
264
265
|
</html>
|
|
@@ -191,21 +191,21 @@ ul.inheritsList
|
|
|
191
191
|
|
|
192
192
|
<li><i><a href="../symbols/_global_.html">_global_</a></i></li>
|
|
193
193
|
|
|
194
|
-
<li><a href="../symbols/
|
|
194
|
+
<li><a href="../symbols/error.html">Error</a></li>
|
|
195
195
|
|
|
196
|
-
<li><a href="../symbols/
|
|
196
|
+
<li><a href="../symbols/file.html">File</a></li>
|
|
197
197
|
|
|
198
|
-
<li><a href="../symbols/
|
|
198
|
+
<li><a href="../symbols/file.nosuchfileerror.html">File.NoSuchFileError</a></li>
|
|
199
199
|
|
|
200
|
-
<li><a href="../symbols/
|
|
200
|
+
<li><a href="../symbols/kernel.html">Kernel</a></li>
|
|
201
201
|
|
|
202
|
-
<li><a href="../symbols/
|
|
202
|
+
<li><a href="../symbols/loaderror.html">LoadError</a></li>
|
|
203
203
|
|
|
204
|
-
<li><a href="../symbols/
|
|
204
|
+
<li><a href="../symbols/selfconcepterror.html">SelfConceptError</a></li>
|
|
205
205
|
|
|
206
|
-
<li><a href="../symbols/
|
|
206
|
+
<li><a href="../symbols/sys.html">Sys</a></li>
|
|
207
207
|
|
|
208
|
-
<li><a href="../symbols/
|
|
208
|
+
<li><a href="../symbols/xpcbuiltins.html">XPCBuiltins</a></li>
|
|
209
209
|
|
|
210
210
|
</ul>
|
|
211
211
|
<hr />
|
|
@@ -222,6 +222,7 @@ ul.inheritsList
|
|
|
222
222
|
<!-- ============================== class summary ========================== -->
|
|
223
223
|
<p class="description">
|
|
224
224
|
|
|
225
|
+
|
|
225
226
|
|
|
226
227
|
|
|
227
228
|
|
|
@@ -258,7 +259,7 @@ ul.inheritsList
|
|
|
258
259
|
<!-- ============================== footer ================================= -->
|
|
259
260
|
<div class="fineprint" style="clear:both">
|
|
260
261
|
|
|
261
|
-
Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.3.
|
|
262
|
+
Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.3.2 on Sun Oct 11 2009 18:59:12 GMT-0500 (CDT)
|
|
262
263
|
</div>
|
|
263
264
|
</body>
|
|
264
265
|
</html>
|
|
@@ -191,21 +191,21 @@ ul.inheritsList
|
|
|
191
191
|
|
|
192
192
|
<li><i><a href="../symbols/_global_.html">_global_</a></i></li>
|
|
193
193
|
|
|
194
|
-
<li><a href="../symbols/
|
|
194
|
+
<li><a href="../symbols/error.html">Error</a></li>
|
|
195
195
|
|
|
196
|
-
<li><a href="../symbols/
|
|
196
|
+
<li><a href="../symbols/file.html">File</a></li>
|
|
197
197
|
|
|
198
|
-
<li><a href="../symbols/
|
|
198
|
+
<li><a href="../symbols/file.nosuchfileerror.html">File.NoSuchFileError</a></li>
|
|
199
199
|
|
|
200
|
-
<li><a href="../symbols/
|
|
200
|
+
<li><a href="../symbols/kernel.html">Kernel</a></li>
|
|
201
201
|
|
|
202
|
-
<li><a href="../symbols/
|
|
202
|
+
<li><a href="../symbols/loaderror.html">LoadError</a></li>
|
|
203
203
|
|
|
204
|
-
<li><a href="../symbols/
|
|
204
|
+
<li><a href="../symbols/selfconcepterror.html">SelfConceptError</a></li>
|
|
205
205
|
|
|
206
|
-
<li><a href="../symbols/
|
|
206
|
+
<li><a href="../symbols/sys.html">Sys</a></li>
|
|
207
207
|
|
|
208
|
-
<li><a href="../symbols/
|
|
208
|
+
<li><a href="../symbols/xpcbuiltins.html">XPCBuiltins</a></li>
|
|
209
209
|
|
|
210
210
|
</ul>
|
|
211
211
|
<hr />
|
|
@@ -222,6 +222,7 @@ ul.inheritsList
|
|
|
222
222
|
<!-- ============================== class summary ========================== -->
|
|
223
223
|
<p class="description">
|
|
224
224
|
|
|
225
|
+
|
|
225
226
|
|
|
226
227
|
File class used for things such as creating filesystem paths, reading files, etc.
|
|
227
228
|
|
|
@@ -245,7 +246,7 @@ ul.inheritsList
|
|
|
245
246
|
<td class="attributes"> </td>
|
|
246
247
|
<td class="nameDescription" >
|
|
247
248
|
<div class="fixedFont">
|
|
248
|
-
<b><a href="../symbols/
|
|
249
|
+
<b><a href="../symbols/file.html#constructor">File</a></b>()
|
|
249
250
|
</div>
|
|
250
251
|
<div class="description"></div>
|
|
251
252
|
</td>
|
|
@@ -274,7 +275,7 @@ ul.inheritsList
|
|
|
274
275
|
<tr>
|
|
275
276
|
<td class="attributes"><static> </td>
|
|
276
277
|
<td class="nameDescription">
|
|
277
|
-
<div class="fixedFont">File.<b><a href="../symbols/
|
|
278
|
+
<div class="fixedFont">File.<b><a href="../symbols/file.html#.join">join</a></b>(components)
|
|
278
279
|
</div>
|
|
279
280
|
<div class="description">Joins the given string arguments together using the operating system's native path
|
|
280
281
|
separator.</div>
|
|
@@ -284,7 +285,7 @@ separator.</div>
|
|
|
284
285
|
<tr>
|
|
285
286
|
<td class="attributes"><static> </td>
|
|
286
287
|
<td class="nameDescription">
|
|
287
|
-
<div class="fixedFont">File.<b><a href="../symbols/
|
|
288
|
+
<div class="fixedFont">File.<b><a href="../symbols/file.html#.read">read</a></b>(filePath, maxBytes)
|
|
288
289
|
</div>
|
|
289
290
|
<div class="description">Reads the given number of bytes (or the entire contents if the argument is ommitted)
|
|
290
291
|
from the specified file</div>
|
|
@@ -445,7 +446,7 @@ from the specified file
|
|
|
445
446
|
<!-- ============================== footer ================================= -->
|
|
446
447
|
<div class="fineprint" style="clear:both">
|
|
447
448
|
|
|
448
|
-
Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.3.
|
|
449
|
+
Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.3.2 on Sun Oct 11 2009 18:59:12 GMT-0500 (CDT)
|
|
449
450
|
</div>
|
|
450
451
|
</body>
|
|
451
452
|
</html>
|
|
@@ -191,21 +191,21 @@ ul.inheritsList
|
|
|
191
191
|
|
|
192
192
|
<li><i><a href="../symbols/_global_.html">_global_</a></i></li>
|
|
193
193
|
|
|
194
|
-
<li><a href="../symbols/
|
|
194
|
+
<li><a href="../symbols/error.html">Error</a></li>
|
|
195
195
|
|
|
196
|
-
<li><a href="../symbols/
|
|
196
|
+
<li><a href="../symbols/file.html">File</a></li>
|
|
197
197
|
|
|
198
|
-
<li><a href="../symbols/
|
|
198
|
+
<li><a href="../symbols/file.nosuchfileerror.html">File.NoSuchFileError</a></li>
|
|
199
199
|
|
|
200
|
-
<li><a href="../symbols/
|
|
200
|
+
<li><a href="../symbols/kernel.html">Kernel</a></li>
|
|
201
201
|
|
|
202
|
-
<li><a href="../symbols/
|
|
202
|
+
<li><a href="../symbols/loaderror.html">LoadError</a></li>
|
|
203
203
|
|
|
204
|
-
<li><a href="../symbols/
|
|
204
|
+
<li><a href="../symbols/selfconcepterror.html">SelfConceptError</a></li>
|
|
205
205
|
|
|
206
|
-
<li><a href="../symbols/
|
|
206
|
+
<li><a href="../symbols/sys.html">Sys</a></li>
|
|
207
207
|
|
|
208
|
-
<li><a href="../symbols/
|
|
208
|
+
<li><a href="../symbols/xpcbuiltins.html">XPCBuiltins</a></li>
|
|
209
209
|
|
|
210
210
|
</ul>
|
|
211
211
|
<hr />
|
|
@@ -221,8 +221,9 @@ ul.inheritsList
|
|
|
221
221
|
|
|
222
222
|
<!-- ============================== class summary ========================== -->
|
|
223
223
|
<p class="description">
|
|
224
|
+
|
|
224
225
|
<br />Extends
|
|
225
|
-
<a href="../symbols/
|
|
226
|
+
<a href="../symbols/error.html">Error</a>.<br />
|
|
226
227
|
|
|
227
228
|
|
|
228
229
|
Exception representing an error loading a file.
|
|
@@ -247,7 +248,7 @@ ul.inheritsList
|
|
|
247
248
|
<td class="attributes"> </td>
|
|
248
249
|
<td class="nameDescription" >
|
|
249
250
|
<div class="fixedFont">
|
|
250
|
-
<b><a href="../symbols/
|
|
251
|
+
<b><a href="../symbols/file.nosuchfileerror.html#constructor">File.NoSuchFileError</a></b>(message)
|
|
251
252
|
</div>
|
|
252
253
|
<div class="description"></div>
|
|
253
254
|
</td>
|
|
@@ -302,7 +303,7 @@ ul.inheritsList
|
|
|
302
303
|
<dl class="detailList">
|
|
303
304
|
<dt class="heading">Returns:</dt>
|
|
304
305
|
|
|
305
|
-
<dd><span class="light fixedFont">{<a href="../symbols/
|
|
306
|
+
<dd><span class="light fixedFont">{<a href="../symbols/error.html">Error</a>}</span> </dd>
|
|
306
307
|
|
|
307
308
|
</dl>
|
|
308
309
|
|
|
@@ -328,7 +329,7 @@ ul.inheritsList
|
|
|
328
329
|
<!-- ============================== footer ================================= -->
|
|
329
330
|
<div class="fineprint" style="clear:both">
|
|
330
331
|
|
|
331
|
-
Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.3.
|
|
332
|
+
Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.3.2 on Sun Oct 11 2009 18:59:12 GMT-0500 (CDT)
|
|
332
333
|
</div>
|
|
333
334
|
</body>
|
|
334
335
|
</html>
|
|
@@ -191,21 +191,21 @@ ul.inheritsList
|
|
|
191
191
|
|
|
192
192
|
<li><i><a href="../symbols/_global_.html">_global_</a></i></li>
|
|
193
193
|
|
|
194
|
-
<li><a href="../symbols/
|
|
194
|
+
<li><a href="../symbols/error.html">Error</a></li>
|
|
195
195
|
|
|
196
|
-
<li><a href="../symbols/
|
|
196
|
+
<li><a href="../symbols/file.html">File</a></li>
|
|
197
197
|
|
|
198
|
-
<li><a href="../symbols/
|
|
198
|
+
<li><a href="../symbols/file.nosuchfileerror.html">File.NoSuchFileError</a></li>
|
|
199
199
|
|
|
200
|
-
<li><a href="../symbols/
|
|
200
|
+
<li><a href="../symbols/kernel.html">Kernel</a></li>
|
|
201
201
|
|
|
202
|
-
<li><a href="../symbols/
|
|
202
|
+
<li><a href="../symbols/loaderror.html">LoadError</a></li>
|
|
203
203
|
|
|
204
|
-
<li><a href="../symbols/
|
|
204
|
+
<li><a href="../symbols/selfconcepterror.html">SelfConceptError</a></li>
|
|
205
205
|
|
|
206
|
-
<li><a href="../symbols/
|
|
206
|
+
<li><a href="../symbols/sys.html">Sys</a></li>
|
|
207
207
|
|
|
208
|
-
<li><a href="../symbols/
|
|
208
|
+
<li><a href="../symbols/xpcbuiltins.html">XPCBuiltins</a></li>
|
|
209
209
|
|
|
210
210
|
</ul>
|
|
211
211
|
<hr />
|
|
@@ -222,6 +222,7 @@ ul.inheritsList
|
|
|
222
222
|
<!-- ============================== class summary ========================== -->
|
|
223
223
|
<p class="description">
|
|
224
224
|
|
|
225
|
+
|
|
225
226
|
|
|
226
227
|
Our central 'class' containing a lot of properties and methods we need to
|
|
227
228
|
build the rest of XPCOMCore on top of.
|
|
@@ -246,9 +247,9 @@ build the rest of XPCOMCore on top of.
|
|
|
246
247
|
<td class="attributes"> </td>
|
|
247
248
|
<td class="nameDescription" >
|
|
248
249
|
<div class="fixedFont">
|
|
249
|
-
<b><a href="../symbols/
|
|
250
|
+
<b><a href="../symbols/kernel.html#constructor">Kernel</a></b>(mixinScope)
|
|
250
251
|
</div>
|
|
251
|
-
<div class="description">A pseudo-constructor to make JSDoc happy and actually document things in <a href="../symbols/
|
|
252
|
+
<div class="description">A pseudo-constructor to make JSDoc happy and actually document things in <a href="../symbols/kernel.html">Kernel</a>.</div>
|
|
252
253
|
</td>
|
|
253
254
|
</tr>
|
|
254
255
|
</tbody>
|
|
@@ -273,7 +274,7 @@ build the rest of XPCOMCore on top of.
|
|
|
273
274
|
<td class="attributes"> </td>
|
|
274
275
|
<td class="nameDescription">
|
|
275
276
|
<div class="fixedFont">
|
|
276
|
-
<b><a href="../symbols/
|
|
277
|
+
<b><a href="../symbols/kernel.html#$Cc">$Cc</a></b>
|
|
277
278
|
</div>
|
|
278
279
|
<div class="description">A shortcut constant to Components.classes.</div>
|
|
279
280
|
</td>
|
|
@@ -283,7 +284,7 @@ build the rest of XPCOMCore on top of.
|
|
|
283
284
|
<td class="attributes"> </td>
|
|
284
285
|
<td class="nameDescription">
|
|
285
286
|
<div class="fixedFont">
|
|
286
|
-
<b><a href="../symbols/
|
|
287
|
+
<b><a href="../symbols/kernel.html#$Ci">$Ci</a></b>
|
|
287
288
|
</div>
|
|
288
289
|
<div class="description">A shortcut constant to Components.interfaces.</div>
|
|
289
290
|
</td>
|
|
@@ -293,7 +294,7 @@ build the rest of XPCOMCore on top of.
|
|
|
293
294
|
<td class="attributes"> </td>
|
|
294
295
|
<td class="nameDescription">
|
|
295
296
|
<div class="fixedFont">
|
|
296
|
-
<b><a href="../symbols/
|
|
297
|
+
<b><a href="../symbols/kernel.html#$Cr">$Cr</a></b>
|
|
297
298
|
</div>
|
|
298
299
|
<div class="description">A shortcut constant to Components.results.</div>
|
|
299
300
|
</td>
|
|
@@ -303,7 +304,7 @@ build the rest of XPCOMCore on top of.
|
|
|
303
304
|
<td class="attributes"> </td>
|
|
304
305
|
<td class="nameDescription">
|
|
305
306
|
<div class="fixedFont">
|
|
306
|
-
<b><a href="../symbols/
|
|
307
|
+
<b><a href="../symbols/kernel.html#$Cu">$Cu</a></b>
|
|
307
308
|
</div>
|
|
308
309
|
<div class="description">A shortcut constant to Components.utils.</div>
|
|
309
310
|
</td>
|
|
@@ -313,7 +314,7 @@ build the rest of XPCOMCore on top of.
|
|
|
313
314
|
<td class="attributes"> </td>
|
|
314
315
|
<td class="nameDescription">
|
|
315
316
|
<div class="fixedFont">
|
|
316
|
-
<b><a href="../symbols/
|
|
317
|
+
<b><a href="../symbols/kernel.html#$ENV">$ENV</a></b>
|
|
317
318
|
</div>
|
|
318
319
|
<div class="description">Returns a reference to an object allowing for get()/set() on environment variables.</div>
|
|
319
320
|
</td>
|
|
@@ -323,10 +324,10 @@ build the rest of XPCOMCore on top of.
|
|
|
323
324
|
<td class="attributes"> </td>
|
|
324
325
|
<td class="nameDescription">
|
|
325
326
|
<div class="fixedFont">
|
|
326
|
-
<b><a href="../symbols/
|
|
327
|
+
<b><a href="../symbols/kernel.html#$LOAD_PATH">$LOAD_PATH</a></b>
|
|
327
328
|
</div>
|
|
328
329
|
<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/
|
|
330
|
+
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
331
|
</td>
|
|
331
332
|
</tr>
|
|
332
333
|
|
|
@@ -334,10 +335,10 @@ trying to load a file via either <a href="../symbols/Kernel.html#load">Kernel#lo
|
|
|
334
335
|
<td class="attributes"> </td>
|
|
335
336
|
<td class="nameDescription">
|
|
336
337
|
<div class="fixedFont">
|
|
337
|
-
<b><a href="../symbols/
|
|
338
|
+
<b><a href="../symbols/kernel.html#$LOADED_FEATURES">$LOADED_FEATURES</a></b>
|
|
338
339
|
</div>
|
|
339
340
|
<div class="description">Taking inspiration from Ruby, this defines the currently loaded files that
|
|
340
|
-
have been loaded through <a href="../symbols/
|
|
341
|
+
have been loaded through <a href="../symbols/kernel.html#require">Kernel#require</a>.</div>
|
|
341
342
|
</td>
|
|
342
343
|
</tr>
|
|
343
344
|
|
|
@@ -365,7 +366,7 @@ have been loaded through <a href="../symbols/Kernel.html#require">Kernel#require
|
|
|
365
366
|
<tr>
|
|
366
367
|
<td class="attributes"> </td>
|
|
367
368
|
<td class="nameDescription">
|
|
368
|
-
<div class="fixedFont"><b><a href="../symbols/
|
|
369
|
+
<div class="fixedFont"><b><a href="../symbols/kernel.html#$CURRENT_DIRECTORY">$CURRENT_DIRECTORY</a></b>(stackTraversalDepth)
|
|
369
370
|
</div>
|
|
370
371
|
<div class="description">This method tries to determine the filesystem path to parent directory of the caller
|
|
371
372
|
code of this method NOTE - see the note on $CURRENT_FILE, as the same applies here.</div>
|
|
@@ -375,7 +376,7 @@ code of this method NOTE - see the note on $CURRENT_FILE, as the same applies he
|
|
|
375
376
|
<tr>
|
|
376
377
|
<td class="attributes"> </td>
|
|
377
378
|
<td class="nameDescription">
|
|
378
|
-
<div class="fixedFont"><b><a href="../symbols/
|
|
379
|
+
<div class="fixedFont"><b><a href="../symbols/kernel.html#$CURRENT_FILE">$CURRENT_FILE</a></b>(stackTraversalDepth)
|
|
379
380
|
</div>
|
|
380
381
|
<div class="description">Taking inspiration from Ruby, this method tries to determine the filesystem path to
|
|
381
382
|
the caller code of this method.</div>
|
|
@@ -385,16 +386,16 @@ the caller code of this method.</div>
|
|
|
385
386
|
<tr>
|
|
386
387
|
<td class="attributes"> </td>
|
|
387
388
|
<td class="nameDescription">
|
|
388
|
-
<div class="fixedFont"><b><a href="../symbols/
|
|
389
|
+
<div class="fixedFont"><b><a href="../symbols/kernel.html#load">load</a></b>(featurePath)
|
|
389
390
|
</div>
|
|
390
|
-
<div class="description">Searches <a href="../symbols/
|
|
391
|
+
<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
392
|
</td>
|
|
392
393
|
</tr>
|
|
393
394
|
|
|
394
395
|
<tr>
|
|
395
396
|
<td class="attributes"><inner> </td>
|
|
396
397
|
<td class="nameDescription">
|
|
397
|
-
<div class="fixedFont"><b><a href="../symbols/
|
|
398
|
+
<div class="fixedFont"><b><a href="../symbols/kernel.html#-makeCallingGetter">makeCallingGetter</a></b>(attr, argsArray)
|
|
398
399
|
</div>
|
|
399
400
|
<div class="description"></div>
|
|
400
401
|
</td>
|
|
@@ -403,7 +404,7 @@ the caller code of this method.</div>
|
|
|
403
404
|
<tr>
|
|
404
405
|
<td class="attributes"><inner> </td>
|
|
405
406
|
<td class="nameDescription">
|
|
406
|
-
<div class="fixedFont"><b><a href="../symbols/
|
|
407
|
+
<div class="fixedFont"><b><a href="../symbols/kernel.html#-makeGetter">makeGetter</a></b>(attr)
|
|
407
408
|
</div>
|
|
408
409
|
<div class="description"></div>
|
|
409
410
|
</td>
|
|
@@ -412,7 +413,7 @@ the caller code of this method.</div>
|
|
|
412
413
|
<tr>
|
|
413
414
|
<td class="attributes"> </td>
|
|
414
415
|
<td class="nameDescription">
|
|
415
|
-
<div class="fixedFont"><b><a href="../symbols/
|
|
416
|
+
<div class="fixedFont"><b><a href="../symbols/kernel.html#print">print</a></b>(str)
|
|
416
417
|
</div>
|
|
417
418
|
<div class="description">Prints a string to standard out, without a trailing newline.</div>
|
|
418
419
|
</td>
|
|
@@ -421,7 +422,7 @@ the caller code of this method.</div>
|
|
|
421
422
|
<tr>
|
|
422
423
|
<td class="attributes"> </td>
|
|
423
424
|
<td class="nameDescription">
|
|
424
|
-
<div class="fixedFont"><b><a href="../symbols/
|
|
425
|
+
<div class="fixedFont"><b><a href="../symbols/kernel.html#puts">puts</a></b>(str)
|
|
425
426
|
</div>
|
|
426
427
|
<div class="description">Prints a string to standard out, with a trailing newline.</div>
|
|
427
428
|
</td>
|
|
@@ -430,16 +431,16 @@ the caller code of this method.</div>
|
|
|
430
431
|
<tr>
|
|
431
432
|
<td class="attributes"> </td>
|
|
432
433
|
<td class="nameDescription">
|
|
433
|
-
<div class="fixedFont"><b><a href="../symbols/
|
|
434
|
+
<div class="fixedFont"><b><a href="../symbols/kernel.html#require">require</a></b>(featurePath)
|
|
434
435
|
</div>
|
|
435
|
-
<div class="description">Searches <a href="../symbols/
|
|
436
|
+
<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
437
|
</td>
|
|
437
438
|
</tr>
|
|
438
439
|
|
|
439
440
|
<tr>
|
|
440
441
|
<td class="attributes"><inner> </td>
|
|
441
442
|
<td class="nameDescription">
|
|
442
|
-
<div class="fixedFont"><b><a href="../symbols/
|
|
443
|
+
<div class="fixedFont"><b><a href="../symbols/kernel.html#-standardLibraryLoader">standardLibraryLoader</a></b>()
|
|
443
444
|
</div>
|
|
444
445
|
<div class="description"></div>
|
|
445
446
|
</td>
|
|
@@ -466,8 +467,8 @@ the caller code of this method.</div>
|
|
|
466
467
|
</div>
|
|
467
468
|
|
|
468
469
|
<div class="description">
|
|
469
|
-
A pseudo-constructor to make JSDoc happy and actually document things in <a href="../symbols/
|
|
470
|
-
If this method is called with an argument, all properties from <a href="../symbols/
|
|
470
|
+
A pseudo-constructor to make JSDoc happy and actually document things in <a href="../symbols/kernel.html">Kernel</a>.
|
|
471
|
+
If this method is called with an argument, all properties from <a href="../symbols/kernel.html">Kernel</a> are taken
|
|
471
472
|
and defined as the return value of getter methods set on the given object.
|
|
472
473
|
|
|
473
474
|
</div>
|
|
@@ -483,7 +484,7 @@ and defined as the return value of getter methods set on the given object.
|
|
|
483
484
|
<span class="light fixedFont">{Object}</span> <b>mixinScope</b>
|
|
484
485
|
|
|
485
486
|
</dt>
|
|
486
|
-
<dd>Optional argument, any object to mix <a href="../symbols/
|
|
487
|
+
<dd>Optional argument, any object to mix <a href="../symbols/kernel.html">Kernel</a>'s properties
|
|
487
488
|
into.</dd>
|
|
488
489
|
|
|
489
490
|
</dl>
|
|
@@ -630,7 +631,7 @@ into.</dd>
|
|
|
630
631
|
</div>
|
|
631
632
|
<div class="description">
|
|
632
633
|
Taking inspiration from Ruby, this defines the set of paths to check when
|
|
633
|
-
trying to load a file via either <a href="../symbols/
|
|
634
|
+
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
|
|
|
635
636
|
|
|
636
637
|
</div>
|
|
@@ -653,7 +654,7 @@ trying to load a file via either <a href="../symbols/Kernel.html#load">Kernel#lo
|
|
|
653
654
|
</div>
|
|
654
655
|
<div class="description">
|
|
655
656
|
Taking inspiration from Ruby, this defines the currently loaded files that
|
|
656
|
-
have been loaded through <a href="../symbols/
|
|
657
|
+
have been loaded through <a href="../symbols/kernel.html#require">Kernel#require</a>.
|
|
657
658
|
|
|
658
659
|
|
|
659
660
|
</div>
|
|
@@ -711,7 +712,7 @@ figure out who called us. The default is usually safe.</dd>
|
|
|
711
712
|
<dt class="heading">Throws:</dt>
|
|
712
713
|
|
|
713
714
|
<dt>
|
|
714
|
-
<span class="light fixedFont">{<a href="../symbols/
|
|
715
|
+
<span class="light fixedFont">{<a href="../symbols/selfconcepterror.html">SelfConceptError</a>}</span> <b></b>
|
|
715
716
|
</dt>
|
|
716
717
|
<dd>Thrown when we can't figure out what the filesystem
|
|
717
718
|
path to the parent directory of the current file is.</dd>
|
|
@@ -741,7 +742,7 @@ path to the parent directory of the current file is.</dd>
|
|
|
741
742
|
<div class="description">
|
|
742
743
|
Taking inspiration from Ruby, this method tries to determine the filesystem path to
|
|
743
744
|
the caller code of this method.
|
|
744
|
-
NOTE - when <a href="../symbols/
|
|
745
|
+
NOTE - when <a href="../symbols/kernel.html">Kernel</a> is mixed into an object, this function gets mixed in via
|
|
745
746
|
a special case behaviour that makes it a getter that actually calls the function
|
|
746
747
|
rather than returning the function object itself. This is to facilitate being able
|
|
747
748
|
to call '$CURRENT_FILE' in your code rather than '$CURRENT_FILE()'. The stackTraversalDepth
|
|
@@ -773,7 +774,7 @@ figure out who called us. The default is usually safe.</dd>
|
|
|
773
774
|
<dt class="heading">Throws:</dt>
|
|
774
775
|
|
|
775
776
|
<dt>
|
|
776
|
-
<span class="light fixedFont">{<a href="../symbols/
|
|
777
|
+
<span class="light fixedFont">{<a href="../symbols/selfconcepterror.html">SelfConceptError</a>}</span> <b></b>
|
|
777
778
|
</dt>
|
|
778
779
|
<dd>Thrown when we can't figure out what the filesystem
|
|
779
780
|
path to the current file is.</dd>
|
|
@@ -801,8 +802,8 @@ path to the current file is.</dd>
|
|
|
801
802
|
|
|
802
803
|
</div>
|
|
803
804
|
<div class="description">
|
|
804
|
-
Searches <a href="../symbols/
|
|
805
|
-
Files loaded via this method will not be added to <a href="../symbols/
|
|
805
|
+
Searches <a href="../symbols/kernel.html#$LOAD_PATH">Kernel#$LOAD_PATH</a> for files to load into the current global scope.
|
|
806
|
+
Files loaded via this method will not be added to <a href="../symbols/kernel.html#$LOADED_FEATURES">Kernel#$LOADED_FEATURES</a> and hence
|
|
806
807
|
can be repeatedly loaded and executed.
|
|
807
808
|
|
|
808
809
|
|
|
@@ -829,10 +830,10 @@ can be repeatedly loaded and executed.
|
|
|
829
830
|
<dt class="heading">Throws:</dt>
|
|
830
831
|
|
|
831
832
|
<dt>
|
|
832
|
-
<span class="light fixedFont">{<a href="../symbols/
|
|
833
|
+
<span class="light fixedFont">{<a href="../symbols/loaderror.html">LoadError</a>}</span> <b></b>
|
|
833
834
|
</dt>
|
|
834
835
|
<dd>Thrown when we can't find the specified file in any directories specified
|
|
835
|
-
in <a href="../symbols/
|
|
836
|
+
in <a href="../symbols/kernel.html#$LOAD_PATH">Kernel#$LOAD_PATH</a>.</dd>
|
|
836
837
|
|
|
837
838
|
</dl>
|
|
838
839
|
|
|
@@ -1007,8 +1008,8 @@ in <a href="../symbols/Kernel.html#$LOAD_PATH">Kernel#$LOAD_PATH</a>.</dd>
|
|
|
1007
1008
|
|
|
1008
1009
|
</div>
|
|
1009
1010
|
<div class="description">
|
|
1010
|
-
Searches <a href="../symbols/
|
|
1011
|
-
Files loaded via this method will be added to <a href="../symbols/
|
|
1011
|
+
Searches <a href="../symbols/kernel.html#$LOAD_PATH">Kernel#$LOAD_PATH</a> for features to load into the current global scope.
|
|
1012
|
+
Files loaded via this method will be added to <a href="../symbols/kernel.html#$LOADED_FEATURES">Kernel#$LOADED_FEATURES</a> and hence two
|
|
1012
1013
|
consecutive calls to this method will not load and execute the code twice.
|
|
1013
1014
|
|
|
1014
1015
|
|
|
@@ -1035,10 +1036,10 @@ consecutive calls to this method will not load and execute the code twice.
|
|
|
1035
1036
|
<dt class="heading">Throws:</dt>
|
|
1036
1037
|
|
|
1037
1038
|
<dt>
|
|
1038
|
-
<span class="light fixedFont">{<a href="../symbols/
|
|
1039
|
+
<span class="light fixedFont">{<a href="../symbols/loaderror.html">LoadError</a>}</span> <b></b>
|
|
1039
1040
|
</dt>
|
|
1040
1041
|
<dd>Thrown when we can't find the specified feature in any directories specified
|
|
1041
|
-
in <a href="../symbols/
|
|
1042
|
+
in <a href="../symbols/kernel.html#$LOAD_PATH">Kernel#$LOAD_PATH</a>.</dd>
|
|
1042
1043
|
|
|
1043
1044
|
</dl>
|
|
1044
1045
|
|
|
@@ -1092,7 +1093,7 @@ in <a href="../symbols/Kernel.html#$LOAD_PATH">Kernel#$LOAD_PATH</a>.</dd>
|
|
|
1092
1093
|
<!-- ============================== footer ================================= -->
|
|
1093
1094
|
<div class="fineprint" style="clear:both">
|
|
1094
1095
|
|
|
1095
|
-
Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.3.
|
|
1096
|
+
Documentation generated by <a href="http://code.google.com/p/jsdoc-toolkit/" target="_blank">JsDoc Toolkit</a> 2.3.2 on Sun Oct 11 2009 18:59:13 GMT-0500 (CDT)
|
|
1096
1097
|
</div>
|
|
1097
1098
|
</body>
|
|
1098
1099
|
</html>
|