238928 - domstubs.idl should not include nsAString.h

Status: VERIFIED FIXED

(Core :: DOM: Core & HTML, defect)

Description

[Marco Pesenti Gritti]

As per #238088 nsStringAPI.h and nsAString.h conflicts. nsAString.h should only
be used by files in the mozilla codebase.
Including it in domstubs.idl we make impossible to use nsIDOMXXX and
nsEmbedString contemporarily by embedding applications.

Comment 1

[Benjamin Smedberg]

This makes the frozen DOM interfaces unusable with the SDK.

Comment 2

[Marco Pesenti Gritti]

Is the Truncate () necessary ?

nsTSubstring SetIsVoid (PR_TRUE) method seem to be doing it already
http://lxr.mozilla.org/mozilla/source/xpcom/string/src/nsTSubstring.cpp#485

Also there is similar SetToNull code without the Truncate () call
http://lxr.mozilla.org/mozilla/source/extensions/webservices/soap/src/nsSOAPUtils.h#175

If so would s/DOMStringIsNull/IsVoid s/SetDOMStringToNull/SetIsVoid(TRUE) be
considered an acceptable solution ? I dont see disadvantages in using the string
api directly but I'm not familiar with either DOM or string code.

Comment 3

[David Baron :dbaron: (⌚️UTC-4, no longer working on Mozilla)]

The disadvantage to using the string API directly is that it's not frozen so we
don't guarantee binary compatibility.

Comment 4

[David Baron :dbaron: (⌚️UTC-4, no longer working on Mozilla)]

The easiest solution is probably to move these helpers elsewhere, into something
not included by frozen headers.

Comment 5

[Marco Pesenti Gritti]

Ok, I looked in the dom headers and I couldnt find any good candidate.
Suggestions are welcome.
Maybe nsDOMUtils.cpp/.h is in order ? (IHMO at that point getting rid of the
helpers and use the aString.IsVoid/SetIsVoid in the mozilla DOM implementation
would be cleaner, at least if Truncate() is redundant).

Comment 6

[Marco Pesenti Gritti]

Attachment: Move the helpers out to nsDOMString.h

I did not use nsDOMUtils.h because there is a file with the same name in
extensions/

Comment 7

[Johnny Stenback (:jst)]

Comment on attachment 145028 [details] [diff] [review]
Move the helpers out to nsDOMString.h

+inline void SetDOMStringToNull(nsAString& aString)
+{
+  aString.Truncate();
+  aString.SetIsVoid(PR_TRUE);
+}

Seems like you can remove the call to Truncate(), as you mentioned earlier.

sr=jst for making this change, I'm sure we'll find more helpers to add to this
header file as we move forward...

Comment 8

[Marco Pesenti Gritti]

Attachment: Updated patch without Truncate() as request by jst

Comment 9

[Darin Fisher]

fixed-on-trunk for 1.7 final

Comment 10

[:Ms2ger (he/him; ⌚ UTC+1/+2)]

V. based on code inspection.