/* -*- 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 nsHistory_h___
#define nsHistory_h___
#include "mozilla/Attributes.h"
#include "mozilla/dom/HistoryBinding.h"
#include "mozilla/dom/ChildSHistory.h"
#include "nsCOMPtr.h"
#include "nsCycleCollectionParticipant.h"
#include "nsIWeakReferenceUtils.h" // for nsWeakPtr
#include "nsPIDOMWindow.h" // for GetParentObject
#include "nsStringFwd.h"
#include "nsWrapperCache.h"
class nsIDocShell;
class nsISHistory;
class nsIWeakReference;
class nsPIDOMWindowInner;
namespace mozilla {
class ErrorResult;
}
// Script "History" object
class nsHistory final :
public nsISupports,
public nsWrapperCache {
public:
NS_DECL_CYCLE_COLLECTING_ISUPPORTS
NS_DECL_CYCLE_COLLECTION_WRAPPERCACHE_CLASS(nsHistory)
public:
explicit nsHistory(nsPIDOMWindowInner* aInnerWindow);
nsPIDOMWindowInner* GetParentObject()
const;
virtual JSObject* WrapObject(JSContext* aCx,
JS::Handle<JSObject*> aGivenProto) override;
uint32_t GetLength(mozilla::ErrorResult& aRv)
const;
mozilla::dom::ScrollRestoration GetScrollRestoration(
mozilla::dom::CallerType aCallerType, mozilla::ErrorResult& aRv);
void SetScrollRestoration(mozilla::dom::ScrollRestoration aMode,
mozilla::dom::CallerType aCallerType,
mozilla::ErrorResult& aRv);
void GetState(JSContext* aCx, JS::MutableHandle<JS::Value> aResult,
mozilla::ErrorResult& aRv)
const;
void Go(int32_t aDelta, nsIPrincipal& aSubjectPrincipal,
mozilla::ErrorResult& aRv);
void Back(mozilla::dom::CallerType aCallerType, mozilla::ErrorResult& aRv);
void Forward(mozilla::dom::CallerType aCallerType, mozilla::ErrorResult& aRv);
void PushState(JSContext* aCx, JS::Handle<JS::Value> aData,
const nsAString& aTitle,
const nsAString& aUrl,
mozilla::dom::CallerType aCallerType,
mozilla::ErrorResult& aRv);
void ReplaceState(JSContext* aCx, JS::Handle<JS::Value> aData,
const nsAString& aTitle,
const nsAString& aUrl,
mozilla::dom::CallerType aCallerType,
mozilla::ErrorResult& aRv);
protected:
virtual ~nsHistory();
void PushOrReplaceState(JSContext* aCx, JS::Handle<JS::Value> aData,
const nsAString& aTitle,
const nsAString& aUrl,
mozilla::dom::CallerType aCallerType,
mozilla::ErrorResult& aRv,
bool aReplace);
already_AddRefed<mozilla::dom::ChildSHistory> GetSessionHistory()
const;
nsWeakPtr mInnerWindow;
};
#endif /* nsHistory_h___ */
