gecko-dev/dom/base/PartialSHistory.h
Michael Layzell 3244cf77dd Bug 1315105 - Part 1: Add support for prerendering PartialSHistories to GroupedSHistory, r=smaug
MozReview-Commit-ID: A5bwSy8NkH3

--HG--
extra : rebase_source : e87ff9754b8174f546b262f9ac7dae9157ecb130
2016-12-19 15:03:17 +08:00

73 lines
2.3 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 PartialSHistory_h
#define PartialSHistory_h
#include "nsCycleCollectionParticipant.h"
#include "nsFrameLoader.h"
#include "nsIGroupedSHistory.h"
#include "nsIPartialSHistoryListener.h"
#include "nsIPartialSHistory.h"
#include "nsISHistory.h"
#include "nsISHistoryListener.h"
#include "TabParent.h"
namespace mozilla {
namespace dom {
class PartialSHistory final : public nsIPartialSHistory,
public nsISHistoryListener,
public nsIPartialSHistoryListener,
public nsSupportsWeakReference
{
public:
NS_DECL_CYCLE_COLLECTING_ISUPPORTS
NS_DECL_CYCLE_COLLECTION_CLASS_AMBIGUOUS(PartialSHistory, nsIPartialSHistory)
NS_DECL_NSIPARTIALSHISTORY
NS_DECL_NSIPARTIALSHISTORYLISTENER
NS_DECL_NSISHISTORYLISTENER
/**
* Note that PartialSHistory must be constructed after frameloader has
* created a valid docshell or tabparent.
*/
explicit PartialSHistory(nsIFrameLoader* aOwnerFrameLoader);
private:
~PartialSHistory() {}
already_AddRefed<nsISHistory> GetSessionHistory();
already_AddRefed<TabParent> GetTabParent();
nsresult SHistoryDidUpdate(bool aTruncate = false);
// The cache of number of entries in corresponding nsISHistory. It's only
// used for remote process case. If nsISHistory is in-process, mCount will not
// be used at all.
uint32_t mCount;
// The current local index of the active document in this partial SHistory.
uint32_t mIndex;
// The cache of globalIndexOffset in corresponding nsISHistory. It's only
// used for remote process case.
uint32_t mGlobalIndexOffset;
// One of the possible active states from nsIPartialSHistory
int32_t mActive;
// The frameloader which owns this PartialSHistory.
nsCOMPtr<nsIFrameLoader> mOwnerFrameLoader;
// The GroupedSHistory which this PartialSHistory is part of, or null.
nsCOMPtr<nsIGroupedSHistory> mGroupedSHistory;
};
} // namespace dom
} // namespace mozilla
#endif /* PartialSHistory_h */