fune/toolkit/components/sessionstore/SessionStoreParent.h
Cathy Lu df9bafbf73 Bug 1734394 - Make Geckoview use the session store collector r=geckoview-reviewers,agi,farre,peterv
When the session storage prefs are enabled, GeckoSession updateSessionState will provide the bundle of information, including zoom, scroll, and form data, to the delegate. Currently works for Fission and on Fenix.

Differential Revision: https://phabricator.services.mozilla.com/D148215
2022-07-15 20:44:55 +00:00

79 lines
2.9 KiB
C++

/* -*- 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_SessionStoreParent_h
#define mozilla_dom_SessionStoreParent_h
#include "mozilla/dom/BrowserSessionStore.h"
#include "mozilla/dom/CanonicalBrowsingContext.h"
#include "mozilla/dom/Element.h"
#include "mozilla/dom/PSessionStoreParent.h"
#include "mozilla/dom/WindowGlobalParent.h"
#include "mozilla/dom/SessionStoreScrollData.h"
namespace mozilla::dom {
class BrowserParent;
class SessionStoreParent final : public PSessionStoreParent {
public:
SessionStoreParent(CanonicalBrowsingContext* aBrowsingContext,
BrowserSessionStore* aSessionStore);
void FlushAllSessionStoreChildren(const std::function<void()>& aDone);
void FinalFlushAllSessionStoreChildren(const std::function<void()>& aDone);
/**
* Sends data to be stored and instructions to the session store to
* potentially collect data in the parent.
*/
mozilla::ipc::IPCResult RecvSessionStoreUpdate(
const Maybe<nsCString>& aDocShellCaps, const Maybe<bool>& aPrivatedMode,
const MaybeSessionStoreZoom& aZoom, const bool aNeedCollectSHistory,
const uint32_t& aEpoch);
mozilla::ipc::IPCResult RecvIncrementalSessionStoreUpdate(
const MaybeDiscarded<BrowsingContext>& aBrowsingContext,
const Maybe<FormData>& aFormData, const Maybe<nsPoint>& aScrollPosition,
uint32_t aEpoch);
mozilla::ipc::IPCResult RecvResetSessionStore(
const MaybeDiscarded<BrowsingContext>& aBrowsingContext, uint32_t aEpoch);
NS_INLINE_DECL_CYCLE_COLLECTING_NATIVE_REFCOUNTING(SessionStoreParent)
NS_DECL_CYCLE_COLLECTION_NATIVE_CLASS(SessionStoreParent)
protected:
friend class SessionStoreChild;
void SessionStoreUpdate(const Maybe<nsCString>& aDocShellCaps,
const Maybe<bool>& aPrivatedMode,
const MaybeSessionStoreZoom& aZoom,
const bool aNeedCollectSHistory,
const uint32_t& aEpoch);
void IncrementalSessionStoreUpdate(
const MaybeDiscarded<BrowsingContext>& aBrowsingContext,
const Maybe<FormData>& aFormData, const Maybe<nsPoint>& aScrollPosition,
uint32_t aEpoch);
void ResetSessionStore(
const MaybeDiscarded<BrowsingContext>& aBrowsingContext, uint32_t aEpoch);
private:
~SessionStoreParent() = default;
already_AddRefed<SessionStoreParent::FlushTabStatePromise>
FlushSessionStore();
bool mHasNewFormData = false;
bool mHasNewScrollPosition = false;
RefPtr<CanonicalBrowsingContext> mBrowsingContext;
RefPtr<BrowserSessionStore> mSessionStore;
};
} // namespace mozilla::dom
#endif // mozilla_dom_SessionStoreParent_h