dom/url/URL.h

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim: set ts=8 sts=2 et sw=2 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 mozilla_dom_URL_h
   8 #define mozilla_dom_URL_h
   9
  10 #include "mozilla/dom/URLSearchParams.h"
  11 #include "nsCycleCollectionParticipant.h"
  12 #include "nsIURI.h"
  13 #include "nsString.h"
  14 #include "nsWrapperCache.h"
  15
  16 class nsISupports;
  17
  18 namespace mozilla {
  19
  20 class ErrorResult;
  21
  22 namespace dom {
  23
  24 class Blob;
  25 class MediaSource;
  26 class GlobalObject;
  27 template <typename T>
  28 class Optional;
  29
  30 class URL final : public URLSearchParamsObserver, public nsWrapperCache {
  31  public:
  32   NS_DECL_CYCLE_COLLECTING_ISUPPORTS
  33   NS_DECL_CYCLE_COLLECTION_WRAPPERCACHE_CLASS(URL)
  34
  35   explicit URL(nsISupports* aParent, nsCOMPtr<nsIURI> aURI)
  36       : mParent(aParent), mURI(std::move(aURI)) {
  37     MOZ_ASSERT(mURI);
  38   }
  39
  40   // WebIDL methods
  41   nsISupports* GetParentObject() const { return mParent; }
  42
  43   JSObject* WrapObject(JSContext* aCx,
  44                        JS::Handle<JSObject*> aGivenProto) override;
  45
  46   static already_AddRefed<URL> Constructor(const GlobalObject& aGlobal,
  47                                            const nsAString& aURL,
  48                                            const Optional<nsAString>& aBase,
  49                                            ErrorResult& aRv);
  50
  51   static already_AddRefed<URL> Constructor(nsISupports* aParent,
  52                                            const nsAString& aURL,
  53                                            const nsAString& aBase,
  54                                            ErrorResult& aRv);
  55
  56   static already_AddRefed<URL> Constructor(nsISupports* aParent,
  57                                            const nsAString& aURL, nsIURI* aBase,
  58                                            ErrorResult& aRv);
  59
  60   static void CreateObjectURL(const GlobalObject& aGlobal, Blob& aBlob,
  61                               nsAString& aResult, ErrorResult& aRv);
  62
  63   static void CreateObjectURL(const GlobalObject& aGlobal, MediaSource& aSource,
  64                               nsAString& aResult, ErrorResult& aRv);
  65
  66   static void RevokeObjectURL(const GlobalObject& aGlobal,
  67                               const nsAString& aURL, ErrorResult& aRv);
  68
  69   static bool IsValidObjectURL(const GlobalObject& aGlobal,
  70                                const nsAString& aURL, ErrorResult& aRv);
  71
  72   static bool CanParse(const GlobalObject& aGlobal, const nsAString& aURL,
  73                        const Optional<nsAString>& aBase);
  74
  75   void GetHref(nsAString& aHref) const;
  76
  77   void SetHref(const nsAString& aHref, ErrorResult& aRv);
  78
  79   void GetOrigin(nsAString& aOrigin) const;
  80
  81   void GetProtocol(nsAString& aProtocol) const;
  82
  83   void SetProtocol(const nsAString& aProtocol);
  84
  85   void GetUsername(nsAString& aUsername) const;
  86
  87   void SetUsername(const nsAString& aUsername);
  88
  89   void GetPassword(nsAString& aPassword) const;
  90
  91   void SetPassword(const nsAString& aPassword);
  92
  93   void GetHost(nsAString& aHost) const;
  94
  95   void SetHost(const nsAString& aHost);
  96
  97   void GetHostname(nsAString& aHostname) const;
  98
  99   void SetHostname(const nsAString& aHostname);
 100
 101   void GetPort(nsAString& aPort) const;
 102
 103   void SetPort(const nsAString& aPort);
 104
 105   void GetPathname(nsAString& aPathname) const;
 106
 107   void SetPathname(const nsAString& aPathname);
 108
 109   void GetSearch(nsAString& aSearch) const;
 110
 111   void SetSearch(const nsAString& aSearch);
 112
 113   URLSearchParams* SearchParams();
 114
 115   void GetHash(nsAString& aHost) const;
 116
 117   void SetHash(const nsAString& aHash);
 118
 119   void ToJSON(nsAString& aResult) const { GetHref(aResult); }
 120
 121   // URLSearchParamsObserver
 122   void URLSearchParamsUpdated(URLSearchParams* aSearchParams) override;
 123
 124   nsIURI* URI() const;
 125   static already_AddRefed<URL> FromURI(GlobalObject&, nsIURI*);
 126
 127  private:
 128   ~URL() = default;
 129
 130   void UpdateURLSearchParams();
 131
 132  private:
 133   void SetSearchInternal(const nsAString& aSearch);
 134
 135   void CreateSearchParamsIfNeeded();
 136
 137   nsCOMPtr<nsISupports> mParent;
 138   RefPtr<URLSearchParams> mSearchParams;
 139   nsCOMPtr<nsIURI> mURI;
 140 };
 141
 142 bool IsChromeURI(nsIURI* aURI);
 143
 144 }  // namespace dom
 145 }  // namespace mozilla
 146
 147 #endif /* mozilla_dom_URL_h */