662162 - Create helper function for getting nsIPrefLocalizedString complexvalue prefs

Status: RESOLVED FIXED

(SeaMonkey :: General, defect)

Description

[Ian Neal]

Attachment: utilityOverlay localized string patch

At the moment utilityOverlay.js has a helper function for getting nsISupportsString complexvalue prefs but not one for nsIPrefLocalizedString.
This patch:
* providers such a helper called GetLocalizedStringPref.
* switches utilityOverlay to use it.

Comment 1

[Philip Chee]

Comment on attachment 537458 [details] [diff] [review]
utilityOverlay localized string patch

Review of attachment 537458 [details] [diff] [review]:
-----------------------------------------------------------------

(must try this Splinter stuff)

::: suite/common/utilityOverlay.js
@@ +183,5 @@
>    } catch (e) {}
>    return "";
>  }
>  
> +function GetLocalizedStringPref(aName)

How about calling it getLocalizedUnicharPref(aPrefName, aDefVal)
see:
<http://mxr.mozilla.org/comm-central/source/mozilla/toolkit/obsolete/content/nsUserSettings.js#90>

@@ +189,5 @@
> +  try {
> +    return Services.prefs.getComplexValue(aName,
> +               Components.interfaces.nsIPrefLocalizedString).data;
> +  } catch (e) {
> +    Components.utils.reportError("Couldn't get " + aName + " pref: " + e);

We should eventually migrate to log4moz so that we can set the logging level e.g. we can set debug off to turn off uninteresting messages such as these.

@@ +1094,5 @@
>      else if (ot.getAttribute('anonid') == 'getMeOutOfHereButton') {
>        // Redirect them to a known-functioning page, default start page
> +      var url = GetLocalizedStringPref("browser.startup.homepage");
> +      if (!url)
> +        url = "about:blank";

var url = getLocalizedUnicharPref("browser.startup.homepage", "about:blank");

Comment 2

[Ian Neal]

Attachment: Revised utilityOverlay localized string patch [Checked in: Comment 4]

Changes since last version:
* As suggested added a default value argument to helper which let some more code be simplified.

Comment 3

[[e-mail]]

Comment on attachment 537473 [details] [diff] [review]
Revised utilityOverlay localized string patch [Checked in: Comment 4]

>+  return aDefaultValue || null;
Not sure we need to do this, I don't think we have any code that specifically distinguishes undefined from null, certainly the two callers don't.

Comment 4

[Ian Neal]

Comment on attachment 537473 [details] [diff] [review]
Revised utilityOverlay localized string patch [Checked in: Comment 4]

http://hg.mozilla.org/comm-central/rev/cc8f23d60452
with just return aDefaultValue;