LocalStorage.h - mozsearch

Enable keyboard shortcuts

/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */

/* vim: set ts=8 sts=2 et sw=2 tw=80: */

/* 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 mozilla_dom_LocalStorage_h

#define mozilla_dom_LocalStorage_h

#include "Storage.h"

#include "nsWeakReference.h"

namespace mozilla::dom {

class LocalStorageCache;

class LocalStorageManager;

class StorageEvent;

class LocalStorage final : public Storage, public nsSupportsWeakReference {

 public:

  NS_DECL_ISUPPORTS_INHERITED

  NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(LocalStorage, Storage)

  StorageType Type() const override { return eLocalStorage; }

  LocalStorageManager* GetManager() const { return mManager; }

  LocalStorageCache const* GetCache() const { return mCache; }

  const nsString& DocumentURI() const { return mDocumentURI; }

  LocalStorage(nsPIDOMWindowInner* aWindow, LocalStorageManager* aManager,

               LocalStorageCache* aCache, const nsAString& aDocumentURI,

               nsIPrincipal* aPrincipal, nsIPrincipal* aStoragePrincipal,

               bool aIsPrivate);

  bool IsForkOf(const Storage* aOther) const override;

  // WebIDL

  int64_t GetOriginQuotaUsage() const override;

  uint32_t GetLength(nsIPrincipal& aSubjectPrincipal,

                     ErrorResult& aRv) override;

  void Key(uint32_t aIndex, nsAString& aResult, nsIPrincipal& aSubjectPrincipal,

           ErrorResult& aRv) override;

  void GetItem(const nsAString& aKey, nsAString& aResult,

               nsIPrincipal& aSubjectPrincipal, ErrorResult& aRv) override;

  void GetSupportedNames(nsTArray<nsString>& aKeys) override;

  void SetItem(const nsAString& aKey, const nsAString& aValue,

               nsIPrincipal& aSubjectPrincipal, ErrorResult& aRv) override;

  void RemoveItem(const nsAString& aKey, nsIPrincipal& aSubjectPrincipal,

                  ErrorResult& aRv) override;

  void Clear(nsIPrincipal& aSubjectPrincipal, ErrorResult& aRv) override;

  void ApplyEvent(StorageEvent* aStorageEvent);

 private:

  ~LocalStorage();

  friend class LocalStorageManager;

  friend class LocalStorageCache;

  RefPtr<LocalStorageManager> mManager;

  RefPtr<LocalStorageCache> mCache;

  nsString mDocumentURI;

  // Whether this storage is running in private-browsing window.

  bool mIsPrivate : 1;

  void OnChange(const nsAString& aKey, const nsAString& aOldValue,

                const nsAString& aNewValue);

};

}  // namespace mozilla::dom

#endif  // mozilla_dom_LocalStorage_h