bz: Note that this is a work in progress. Some rewriting may need to happen pending the outcome of . Please let me know if you plan to make any major changes to this document before doing so. --Bzbarsky 15:19, 31 May 2005 (PDT)
XPCNativeWrapper is a way to wrap up an object so that it's safe to access from privileged code. It can be used in all Firefox versions, though the
behavior changed somewhat starting with Firefox 1.1.
XPCNativeWrapper in Firefox versions prior to 1.1
In Firefox versions prior to 1.1, use of
XPCNativeWrapper requires manually constructing an
XPCNativeWrapper and passing it the object to be wrapped and the names of the methods/properties to be exposed as arguments. The resulting object exposes ONLY the methods/properties whose methods were passed as arguments. This is described in more detail in the the entry for
XPCNativeWrapper at the MozillaZine KnowledgeBase.
XPCNativeWrapper in Firefox versions starting with 1.1
There are three different types of
XPCNativeWrapper in Firefox 1.1. All three types wrap a possibly-unsafe object and provide safe access to all of its properties and methods (unlike
XPCNativeWrapper in versions before 1.1, which only provided safe access to the properties and methods listed in its constructor). If unsafe access to a property is required for some reason, this can be accomplished via the
wrappedJSObject property of the wrapper. For example, if
docWrapper is a wrapper for
is the same as
The differences in behavior between the three types of
XPCNativeWrapper are determined by two characteristics an
XPCNativeWrapper wrapper can have. An
XPCNativeWrapper can be explicit (or the opposite, implicit) and can be deep (or the opposite, shallow). The type of wrapper created is generally determined by the way it was created as follows:
|Constructor called with string arguments||Explicit||Shallow|
|Constructor called with no string arguments||Explicit||Deep|
Explicit vs. Implicit
The difference in behavior between explicit and implicit
XPCNativeWrapper is that a property access on an implicit
XPCNativeWrapper from code that does not have
xpcnativewrappers=yes is NOT safe. The property access will be forwarded through to the
wrappedJSObject of the
This means the code that doesn't use
xpcnativewrappers=yes doesn't need to worry about bugs arising because other code that does hands it an implicit
XPCNativeWrapper. On the other hand, it does need to watch out for unsafe object access.
Property access on an explicit
XPCNativeWrapper is safe no matter whether
xpcnativewrappers=yes is being used.
Deep vs. Shallow
The difference in behavior between deep and shallow
XPCNativeWrapper is that when a property is accessed or a function is called on a deep wrapper the return value will be wrapped in a
XPCNativeWrapper of its own. The new
XPCNativeWrapper will also be deep and it will be explicit if and only if the
XPCNativeWrapper whose property is accessed was explicit. By contrast, when a property is accessed or a function is called on a shallow wrapper, the return value may be an unsafe object.
For example, say we are given three instances of
XPCNativeWrapper for the same window object. Let us call them
shallowWindow. Then we have:
var doc1 = deepExplicitWindow.document; // doc1 is now a deep explicit
XPCNativeWrapperfor // the document object. Accessing doc1.open(), say, is safe.
var doc2 = deepImplicitWindow.document; // If the caller has xpcnativewrappers=yes set, doc2 is now a deep // implicit
XPCNativeWrapperfor the document object. // Otherwise doc2 is not the unsafe document object, since the // property access was simply passed along to the unsafe window object.
var doc3 = shallowWindow.document; // doc3 is now the unsafe document object.
There are three different ways of creating an
XPCNativeWrapper object; one way for each of the three types.
XPCNativeWrapper constructor call with string arguments
var contentWinWrapper = new XPCNativeWrapper(content, "document");
This creates an explicit shallow
XPCNativeWrapper. This syntax has been kept for compatibility with versions prior to Firefox 1.1. While all properties of the
contentWinWrapper object can now be safely accessed, the return values of these properties are NOT safe to access (just like in versions prior to Firefox 1.1), since the
XPCNativeWrapper is shallow. So to compare the content document title to the current content selection, one must do:
var winWrapper = new XPCNativeWrapper(content, "document", "getSelection()"); var docWrapper = new XPCNativeWrapper(winWrapper.document, "title"); return docWrapper.title == winWrapper.getSelection();
just like in versions before Firefox 1.1. Note that the
"getSelection()" argument is not strictly needed here; if the code is not intended for use with Firefox versions before 1.1 it can be removed. A single string argument after the object being wrapped is all that is required for Firefox 1.1 to create this type of
XPCNativeWrapper constructor call with no string arguments
var contentWinWrapper = new XPCNativeWrapper(content);
Code that has
xpcnativewrappers=yes and accesses a content object will get back an implicit deep
XPCNativeWrapper. Accessing properties of this
XPCNativeWrapper is safe from code that uses
xpcnativewrappers=yes, and the return values will also be wrapped in implicit deep
A wrapper created in this way will stick around as long as the object being wrapped does and accessing an object twice in a row will give the same
bz: except for https://bugzilla.mozilla.org/show_bug.cgi?id=295937 -- sort that out before trying to explain the exact behavior here.
There are some commonly used properties that cannot be used with
- Assigning to the
locationproperty of a wrapped document or window will not work. Code that wishes to set the location should assign to the
hrefproperty of the location object (after wrapping the location object itself, as needed).
document.open()(with no arguments) will not work. Code that wishes to do this should call