summaryrefslogtreecommitdiffstats
path: root/dom/base/Location.h
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--dom/base/Location.h138
1 files changed, 138 insertions, 0 deletions
diff --git a/dom/base/Location.h b/dom/base/Location.h
new file mode 100644
index 0000000000..338366e81b
--- /dev/null
+++ b/dom/base/Location.h
@@ -0,0 +1,138 @@
+/* -*- 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_Location_h
+#define mozilla_dom_Location_h
+
+#include "js/TypeDecls.h"
+#include "mozilla/ErrorResult.h"
+#include "mozilla/LinkedList.h"
+#include "mozilla/dom/BrowsingContext.h"
+#include "mozilla/dom/LocationBase.h"
+#include "nsCycleCollectionParticipant.h"
+#include "nsString.h"
+#include "nsWrapperCache.h"
+
+class nsIDocShell;
+class nsIPrincipal;
+class nsIURI;
+class nsPIDOMWindowInner;
+
+namespace mozilla::dom {
+
+//*****************************************************************************
+// Location: Script "location" object
+//*****************************************************************************
+
+class Location final : public nsISupports,
+ public LocationBase,
+ public nsWrapperCache,
+ public LinkedListElement<Location> {
+ public:
+ typedef BrowsingContext::LocationProxy RemoteProxy;
+
+ explicit Location(nsPIDOMWindowInner* aWindow);
+
+ NS_DECL_CYCLE_COLLECTING_ISUPPORTS
+ NS_DECL_CYCLE_COLLECTION_WRAPPERCACHE_CLASS(Location)
+
+ // WebIDL API:
+ void Assign(const nsAString& aUrl, nsIPrincipal& aSubjectPrincipal,
+ ErrorResult& aError);
+
+ void Reload(bool aForceget, nsIPrincipal& aSubjectPrincipal,
+ ErrorResult& aError);
+
+ void GetHref(nsAString& aHref, nsIPrincipal& aSubjectPrincipal,
+ ErrorResult& aError) {
+ if (!CallerSubsumes(&aSubjectPrincipal)) {
+ aError.Throw(NS_ERROR_DOM_SECURITY_ERR);
+ return;
+ }
+
+ aError = GetHref(aHref);
+ }
+
+ void GetOrigin(nsAString& aOrigin, nsIPrincipal& aSubjectPrincipal,
+ ErrorResult& aError);
+
+ void GetProtocol(nsAString& aProtocol, nsIPrincipal& aSubjectPrincipal,
+ ErrorResult& aError);
+
+ void SetProtocol(const nsAString& aProtocol, nsIPrincipal& aSubjectPrincipal,
+ ErrorResult& aError);
+
+ void GetHost(nsAString& aHost, nsIPrincipal& aSubjectPrincipal,
+ ErrorResult& aError);
+
+ void SetHost(const nsAString& aHost, nsIPrincipal& aSubjectPrincipal,
+ ErrorResult& aError);
+
+ void GetHostname(nsAString& aHostname, nsIPrincipal& aSubjectPrincipal,
+ ErrorResult& aError);
+
+ void SetHostname(const nsAString& aHostname, nsIPrincipal& aSubjectPrincipal,
+ ErrorResult& aError);
+
+ void GetPort(nsAString& aPort, nsIPrincipal& aSubjectPrincipal,
+ ErrorResult& aError);
+
+ void SetPort(const nsAString& aPort, nsIPrincipal& aSubjectPrincipal,
+ ErrorResult& aError);
+
+ void GetPathname(nsAString& aPathname, nsIPrincipal& aSubjectPrincipal,
+ ErrorResult& aError);
+
+ void SetPathname(const nsAString& aPathname, nsIPrincipal& aSubjectPrincipal,
+ ErrorResult& aError);
+
+ void GetSearch(nsAString& aSeach, nsIPrincipal& aSubjectPrincipal,
+ ErrorResult& aError);
+
+ void SetSearch(const nsAString& aSeach, nsIPrincipal& aSubjectPrincipal,
+ ErrorResult& aError);
+
+ void GetHash(nsAString& aHash, nsIPrincipal& aSubjectPrincipal,
+ ErrorResult& aError);
+
+ void SetHash(const nsAString& aHash, nsIPrincipal& aSubjectPrincipal,
+ ErrorResult& aError);
+
+ nsPIDOMWindowInner* GetParentObject() const { return mInnerWindow; }
+
+ virtual JSObject* WrapObject(JSContext* aCx,
+ JS::Handle<JSObject*> aGivenProto) override;
+
+ // Non WebIDL methods:
+
+ nsresult GetHref(nsAString& aHref);
+
+ nsresult ToString(nsAString& aString) { return GetHref(aString); }
+
+ void ClearCachedValues();
+
+ protected:
+ virtual ~Location();
+
+ BrowsingContext* GetBrowsingContext() override;
+ nsIDocShell* GetDocShell() override;
+
+ // In the case of jar: uris, we sometimes want the place the jar was
+ // fetched from as the URI instead of the jar: uri itself. Pass in
+ // true for aGetInnermostURI when that's the case.
+ // Note, this method can return NS_OK with a null value for aURL. This happens
+ // if the docShell is null.
+ nsresult GetURI(nsIURI** aURL, bool aGetInnermostURI = false);
+
+ bool CallerSubsumes(nsIPrincipal* aSubjectPrincipal);
+
+ nsString mCachedHash;
+ nsCOMPtr<nsPIDOMWindowInner> mInnerWindow;
+};
+
+} // namespace mozilla::dom
+
+#endif // mozilla_dom_Location_h