gecko-dev/modules/libpref/nsIPrefLocalizedString.idl
Nicholas Nethercote ddf867ccad Bug 1409635 (part 2) - Fix up nsIPrefLocalizedString. r=froydnj.
nsIPrefLocalizedString is meant to be a wrapper for nsISupportsString,
basically identical but with a different identifier. But it's not a
sub-interface of nsISupportsString. Instead it (almost) duplicates
nsISupportsString's internals.

Specifically, nsISupportsString has `attribute AString data`, resulting in
these C++ methods:

> NS_IMETHOD GetData(nsAString& aData)
> NS_IMETHOD SetData(const nsAString& aData)

nsIPrefLocalizedString has `attribute wstring data`, resulting in these C++
methods:

> NS_IMETHOD GetData(char16_t** aData)
> NS_IMETHOD SetData(const char16_t* aData)

Then we have nsPrefLocalizedString, the concrete subclass of
nsIPrefLocalizedString. It implements the AString methods via
NS_FORWARD_NSISUPPORTSSTRING, which forwards to mUnicodeString. It also
implements the wstring methods explicitly, and they just call the AString
methods. It's all a bit of a mess.

(Both interfaces also have `wstring toString()`. The forwarding works more
smoothly for that method.)

This patch changes nsIPrefLocalizedString so it is a trivial sub-interface of
nsISupportsString. This change eliminates the need for the wstring methods, so
the patch removes them as well. The net result is we have less code, and fewer
conversions between C strings and Gecko strings. The patch also merges the
nsISupportsString and nsIPrefLocalizedString cases in
nsPrefBranch::SetComplexValue(), because they are now identical. (The
nsISupportsString and nsIPrefLocalizedString cases in
nsPrefBranch::GetComplexValue() remain distinct; indeed, that's the whole
reason for having them as separate interfaces.)
2017-10-18 16:51:56 +11:00

35 lines
1.3 KiB
Plaintext

/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#include "nsISupports.idl"
#include "nsISupportsPrimitives.idl"
/**
* The nsIPrefLocalizedString interface is simply a wrapper interface for
* nsISupportsString so the preferences service can have a unique identifier
* to distinguish between requests for normal wide strings (nsISupportsString)
* and "localized" wide strings, which get their default values from properites
* files.
*
* @see nsIPrefBranch
* @see nsISupportsString
*/
[scriptable, uuid(ae419e24-1dd1-11b2-b39a-d3e5e7073802)]
interface nsIPrefLocalizedString : nsISupportsString {};
%{C++
#define NS_PREFLOCALIZEDSTRING_CID \
{ /* {064d9cee-1dd2-11b2-83e3-d25ab0193c26} */ \
0x064d9cee, \
0x1dd2, \
0x11b2, \
{ 0x83, 0xe3, 0xd2, 0x5a, 0xb0, 0x19, 0x3c, 0x26 } \
}
#define NS_PREFLOCALIZEDSTRING_CONTRACTID "@mozilla.org/pref-localizedstring;1"
%}