author Cameron McCormack <>
Mon, 01 Jul 2019 07:20:04 +0000
changeset 540509 02312da6f1ca3310b6ce63c1f825aa40574c7a13
parent 537901 33686f46a5ba418320b24efcbef537f889895419
permissions -rw-r--r--
Bug 1553705 - Make GenerateStateKey() infallible. r=smaug Differential Revision:

/* -*- Mode: C++; tab-width: 4; 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 */

#ifndef nsStringBundle_h__
#define nsStringBundle_h__

#include "mozilla/Mutex.h"
#include "nsIStringBundle.h"
#include "nsIMemoryReporter.h"
#include "nsCOMPtr.h"
#include "nsString.h"
#include "nsCOMArray.h"

class nsIPersistentProperties;

class nsStringBundleBase : public nsIStringBundle, public nsIMemoryReporter {

  nsresult ParseProperties(nsIPersistentProperties**);


  virtual nsresult LoadProperties() = 0;

  const nsCString& BundleURL() const { return mPropertiesURL; }

  // Returns true if this bundle has more than one reference. If it has only
  // a single reference, it is assumed to be held alive by the bundle cache.
  bool IsShared() const { return mRefCnt > 1; }

  static nsStringBundleBase* Cast(nsIStringBundle* aBundle) {
    return static_cast<nsStringBundleBase*>(aBundle);

  template <typename T, typename... Args>
  static already_AddRefed<T> Create(Args... args);

  nsStringBundleBase(const char* aURLSpec);

  virtual ~nsStringBundleBase();

  virtual nsresult GetStringImpl(const nsACString& aName,
                                 nsAString& aResult) = 0;

  virtual nsresult GetSimpleEnumerationImpl(nsISimpleEnumerator** elements) = 0;

  void RegisterMemoryReporter();

  nsCString mPropertiesURL;
  mozilla::Mutex mMutex;
  bool mAttemptedLoad;
  bool mLoaded;

  size_t SizeOfIncludingThisIfUnshared(
      mozilla::MallocSizeOf aMallocSizeOf) const override;

  static nsresult FormatString(const char16_t* formatStr,
                               const nsTArray<nsString>& aParams,
                               nsAString& aResult);

class nsStringBundle : public nsStringBundleBase {

  nsCOMPtr<nsIPersistentProperties> mProps;

  nsresult LoadProperties() override;

  size_t SizeOfIncludingThis(
      mozilla::MallocSizeOf aMallocSizeOf) const override;

  friend class nsStringBundleBase;

  explicit nsStringBundle(const char* aURLSpec);

  virtual ~nsStringBundle();

  nsresult GetStringImpl(const nsACString& aName, nsAString& aResult) override;

  nsresult GetSimpleEnumerationImpl(nsISimpleEnumerator** elements) override;