998291 - Allow importRelative() to import into a given scope

Status: RESOLVED FIXED

(Core :: XPConnect, enhancement)

Description

[Jez]

Bug 628669 introduced the useful importRelative() function into XPCOMUtils, but it does require that the specified relative module be imported into the JavaScript Object of the calling JavaScript code module's global scope (ie. the first argument passed).  There should be an optional third argument, scope, allowing the module to be imported into a given scope, just the same as with Components.utils.import().

Comment 1

[Jez]

Sorry, I got that description of Components.utils.import() wrong; it doesn't take a third argument, however it does obviously allow you to load a module into a given scope using its second argument.

Comment 2

[Jez]

Attachment: patch v1

Patch allowing optional third argument for scope to be specified in importRelative function.  Tested and working on my Linux build.

Comment 3

[Jez]

Attachment: patch v2

Version 2 of the patch without my debugging stuff in it.

Comment 4

[Benjamin Smedberg]

Comment on attachment 8408955 [details] [diff] [review]
patch v2

Please add a test for this to http://mxr.mozilla.org/mozilla-central/source/testing/xpcshell/example/unit/import_module.jsm#20

Comment 5

[Jez]

Attachment: patch v3 includes test

Adding patch with test.

Comment 6

[Ryan VanderMeulen [:RyanVM]]

https://hg.mozilla.org/integration/mozilla-inbound/rev/8f5f134ee116

Comment 7

[Carsten Book [:Tomcat]]

https://hg.mozilla.org/mozilla-central/rev/8f5f134ee116

Comment 8

[Jez]

I've updated the documentation here:
https://developer.mozilla.org/en-US/docs/Mozilla/JavaScript_code_modules/XPCOMUtils.jsm