dom/base/nsLocation.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim: set ts=2 sw=2 et tw=80: */
   3 /* This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #ifndef nsLocation_h__
   8 #define nsLocation_h__
   9
  10 #include "nsIDOMLocation.h"
  11 #include "nsString.h"
  12 #include "nsIWeakReferenceUtils.h"
  13 #include "nsWrapperCache.h"
  14 #include "nsCycleCollectionParticipant.h"
  15 #include "js/TypeDecls.h"
  16 #include "mozilla/ErrorResult.h"
  17 #include "mozilla/dom/URLSearchParams.h"
  18 #include "nsPIDOMWindow.h"
  19
  20 class nsIURI;
  21 class nsIDocShell;
  22 class nsIDocShellLoadInfo;
  23
  24 //*****************************************************************************
  25 // nsLocation: Script "location" object
  26 //*****************************************************************************
  27
  28 class nsLocation MOZ_FINAL : public nsIDOMLocation
  29                            , public nsWrapperCache
  30                            , public mozilla::dom::URLSearchParamsObserver
  31 {
  32   typedef mozilla::ErrorResult ErrorResult;
  33
  34 public:
  35   nsLocation(nsPIDOMWindow* aWindow, nsIDocShell *aDocShell);
  36
  37   NS_DECL_CYCLE_COLLECTING_ISUPPORTS
  38   NS_DECL_CYCLE_COLLECTION_SCRIPT_HOLDER_CLASS_AMBIGUOUS(nsLocation,
  39                                                          nsIDOMLocation)
  40
  41   void SetDocShell(nsIDocShell *aDocShell);
  42   nsIDocShell *GetDocShell();
  43
  44   // nsIDOMLocation
  45   NS_DECL_NSIDOMLOCATION
  46
  47   // WebIDL API:
  48   void Assign(const nsAString& aUrl, ErrorResult& aError)
  49   {
  50     aError = Assign(aUrl);
  51   }
  52   void Replace(const nsAString& aUrl, ErrorResult& aError)
  53   {
  54     aError = Replace(aUrl);
  55   }
  56   void Reload(bool aForceget, ErrorResult& aError)
  57   {
  58     aError = Reload(aForceget);
  59   }
  60   void GetHref(nsAString& aHref, ErrorResult& aError)
  61   {
  62     aError = GetHref(aHref);
  63   }
  64   void SetHref(const nsAString& aHref, ErrorResult& aError)
  65   {
  66     aError = SetHref(aHref);
  67   }
  68   void GetOrigin(nsAString& aOrigin, ErrorResult& aError)
  69   {
  70     aError = GetOrigin(aOrigin);
  71   }
  72   void GetProtocol(nsAString& aProtocol, ErrorResult& aError)
  73   {
  74     aError = GetProtocol(aProtocol);
  75   }
  76   void SetProtocol(const nsAString& aProtocol, ErrorResult& aError)
  77   {
  78     aError = SetProtocol(aProtocol);
  79   }
  80   void GetUsername(nsAString& aUsername, ErrorResult& aError);
  81   void SetUsername(const nsAString& aUsername, ErrorResult& aError);
  82   void GetPassword(nsAString& aPassword, ErrorResult& aError);
  83   void SetPassword(const nsAString& aPassword, ErrorResult& aError);
  84   void GetHost(nsAString& aHost, ErrorResult& aError)
  85   {
  86     aError = GetHost(aHost);
  87   }
  88   void SetHost(const nsAString& aHost, ErrorResult& aError)
  89   {
  90     aError = SetHost(aHost);
  91   }
  92   void GetHostname(nsAString& aHostname, ErrorResult& aError)
  93   {
  94     aError = GetHostname(aHostname);
  95   }
  96   void SetHostname(const nsAString& aHostname, ErrorResult& aError)
  97   {
  98     aError = SetHostname(aHostname);
  99   }
 100   void GetPort(nsAString& aPort, ErrorResult& aError)
 101   {
 102     aError = GetPort(aPort);
 103   }
 104   void SetPort(const nsAString& aPort, ErrorResult& aError)
 105   {
 106     aError = SetPort(aPort);
 107   }
 108   void GetPathname(nsAString& aPathname, ErrorResult& aError)
 109   {
 110     aError = GetPathname(aPathname);
 111   }
 112   void SetPathname(const nsAString& aPathname, ErrorResult& aError)
 113   {
 114     aError = SetPathname(aPathname);
 115   }
 116   void GetSearch(nsAString& aSeach, ErrorResult& aError)
 117   {
 118     aError = GetSearch(aSeach);
 119   }
 120   void SetSearch(const nsAString& aSeach, ErrorResult& aError)
 121   {
 122     aError = SetSearch(aSeach);
 123   }
 124
 125   mozilla::dom::URLSearchParams* SearchParams();
 126
 127   void SetSearchParams(mozilla::dom::URLSearchParams& aSearchParams);
 128
 129   void GetHash(nsAString& aHash, ErrorResult& aError)
 130   {
 131     aError = GetHash(aHash);
 132   }
 133   void SetHash(const nsAString& aHash, ErrorResult& aError)
 134   {
 135     aError = SetHash(aHash);
 136   }
 137   void Stringify(nsAString& aRetval, ErrorResult& aError)
 138   {
 139     GetHref(aRetval, aError);
 140   }
 141   nsPIDOMWindow* GetParentObject() const
 142   {
 143     return mInnerWindow;
 144   }
 145   virtual JSObject* WrapObject(JSContext* aCx) MOZ_OVERRIDE;
 146
 147   // URLSearchParamsObserver
 148   void URLSearchParamsUpdated(mozilla::dom::URLSearchParams* aSearchParams) MOZ_OVERRIDE;
 149
 150 protected:
 151   virtual ~nsLocation();
 152
 153   nsresult SetSearchInternal(const nsAString& aSearch);
 154   void UpdateURLSearchParams();
 155   void RemoveURLSearchParams();
 156
 157   mozilla::dom::URLSearchParams* GetDocShellSearchParams();
 158
 159   // In the case of jar: uris, we sometimes want the place the jar was
 160   // fetched from as the URI instead of the jar: uri itself.  Pass in
 161   // true for aGetInnermostURI when that's the case.
 162   nsresult GetURI(nsIURI** aURL, bool aGetInnermostURI = false);
 163   nsresult GetWritableURI(nsIURI** aURL);
 164   nsresult SetURI(nsIURI* aURL, bool aReplace = false);
 165   nsresult SetHrefWithBase(const nsAString& aHref, nsIURI* aBase,
 166                            bool aReplace);
 167   nsresult SetHrefWithContext(JSContext* cx, const nsAString& aHref,
 168                               bool aReplace);
 169
 170   nsresult GetSourceBaseURL(JSContext* cx, nsIURI** sourceURL);
 171   nsresult CheckURL(nsIURI *url, nsIDocShellLoadInfo** aLoadInfo);
 172   bool CallerSubsumes();
 173
 174   nsString mCachedHash;
 175   nsCOMPtr<nsPIDOMWindow> mInnerWindow;
 176   nsRefPtr<mozilla::dom::URLSearchParams> mSearchParams;
 177   nsWeakPtr mDocShell;
 178 };
 179
 180 #endif // nsLocation_h__
 181