intl/strres/nsStringBundleService.h
author Cameron McCormack <cam@mcc.id.au>
Mon, 01 Jul 2019 07:20:04 +0000
changeset 540509 02312da6f1ca3310b6ce63c1f825aa40574c7a13
parent 537901 33686f46a5ba418320b24efcbef537f889895419
child 567978 73820a049c644c3f3af58cece3bdb7cd0e4b2185
permissions -rw-r--r--
Bug 1553705 - Make GenerateStateKey() infallible. r=smaug Differential Revision: https://phabricator.services.mozilla.com/D32258

/* -*- Mode: C++; 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/. */

#ifndef nsStringBundleService_h__
#define nsStringBundleService_h__

#include "nsCOMPtr.h"
#include "nsDataHashtable.h"
#include "nsHashKeys.h"
#include "nsIPersistentProperties2.h"
#include "nsIStringBundle.h"
#include "nsIObserver.h"
#include "nsWeakReference.h"
#include "nsIErrorService.h"
#include "nsIMemoryReporter.h"

#include "mozilla/LinkedList.h"
#include "mozilla/UniquePtr.h"

struct bundleCacheEntry_t;

class nsStringBundleService : public nsIStringBundleService,
                              public nsIObserver,
                              public nsSupportsWeakReference,
                              public nsIMemoryReporter {
  MOZ_DEFINE_MALLOC_SIZE_OF(MallocSizeOf);

 public:
  nsStringBundleService();

  nsresult Init();

  NS_DECL_ISUPPORTS
  NS_DECL_NSISTRINGBUNDLESERVICE
  NS_DECL_NSIOBSERVER

  NS_IMETHOD CollectReports(nsIHandleReportCallback* aHandleReport,
                            nsISupports* aData, bool anonymize) override {
    size_t amt = SizeOfIncludingThis(MallocSizeOf);

    MOZ_COLLECT_REPORT("explicit/string-bundles/service", KIND_HEAP,
                       UNITS_BYTES, amt,
                       "Memory used for StringBundleService overhead");
    return NS_OK;
  };

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

  void SendContentBundles(
      mozilla::dom::ContentParent* aContentParent) const override;

  void RegisterContentBundle(const nsCString& aBundleURL,
                             const mozilla::ipc::FileDescriptor& aMapFile,
                             size_t aMapSize) override;

 private:
  virtual ~nsStringBundleService();

  void getStringBundle(const char* aUrl, nsIStringBundle** aResult);
  nsresult FormatWithBundle(nsIStringBundle* bundle, nsresult aStatus,
                            const nsTArray<nsString>& argArray,
                            nsAString& result);

  void flushBundleCache(bool ignoreShared = true);

  mozilla::UniquePtr<bundleCacheEntry_t> evictOneEntry();

  bundleCacheEntry_t* insertIntoCache(already_AddRefed<nsIStringBundle> aBundle,
                                      const nsACString& aHashKey);

  nsDataHashtable<nsCStringHashKey, bundleCacheEntry_t*> mBundleMap;
  // LRU list of cached entries, with the least-recently-used entry first.
  mozilla::LinkedList<bundleCacheEntry_t> mBundleCache;
  // List of cached shared-memory string bundles, in arbitrary order.
  mozilla::AutoCleanLinkedList<bundleCacheEntry_t> mSharedBundles;

  nsCOMPtr<nsIErrorService> mErrorService;
};

#endif