dom/base/URL.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this
   4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   5 #ifndef URL_h___
   6 #define URL_h___
   7
   8 #include "mozilla/dom/BindingDeclarations.h"
   9 #include "mozilla/dom/URLSearchParams.h"
  10 #include "nsCycleCollectionParticipant.h"
  11 #include "nsAutoPtr.h"
  12 #include "nsString.h"
  13
  14 class nsIDOMBlob;
  15 class nsIPrincipal;
  16 class nsISupports;
  17 class nsIURI;
  18
  19 namespace mozilla {
  20
  21 class ErrorResult;
  22 class DOMMediaStream;
  23
  24 namespace dom {
  25
  26 class File;
  27 class MediaSource;
  28 class GlobalObject;
  29 struct objectURLOptions;
  30
  31 namespace workers {
  32 class URLProxy;
  33 }
  34
  35 class URL MOZ_FINAL : public URLSearchParamsObserver
  36 {
  37   ~URL() {}
  38
  39 public:
  40   NS_DECL_CYCLE_COLLECTING_ISUPPORTS
  41   NS_DECL_CYCLE_COLLECTION_CLASS(URL)
  42
  43   explicit URL(nsIURI* aURI);
  44
  45   // WebIDL methods
  46   JSObject*
  47   WrapObject(JSContext* aCx);
  48
  49   static already_AddRefed<URL>
  50   Constructor(const GlobalObject& aGlobal, const nsAString& aUrl,
  51               URL& aBase, ErrorResult& aRv);
  52   static already_AddRefed<URL>
  53   Constructor(const GlobalObject& aGlobal, const nsAString& aUrl,
  54               const nsAString& aBase, ErrorResult& aRv);
  55
  56   static void CreateObjectURL(const GlobalObject& aGlobal,
  57                               File& aBlob,
  58                               const objectURLOptions& aOptions,
  59                               nsString& aResult,
  60                               ErrorResult& aError);
  61   static void CreateObjectURL(const GlobalObject& aGlobal,
  62                               DOMMediaStream& aStream,
  63                               const objectURLOptions& aOptions,
  64                               nsString& aResult,
  65                               ErrorResult& aError);
  66   static void CreateObjectURL(const GlobalObject& aGlobal,
  67                               MediaSource& aSource,
  68                               const objectURLOptions& aOptions,
  69                               nsString& aResult,
  70                               ErrorResult& aError);
  71   static void RevokeObjectURL(const GlobalObject& aGlobal,
  72                               const nsAString& aURL);
  73
  74   void GetHref(nsString& aHref, ErrorResult& aRv) const;
  75
  76   void SetHref(const nsAString& aHref, ErrorResult& aRv);
  77
  78   void GetOrigin(nsString& aOrigin, ErrorResult& aRv) const;
  79
  80   void GetProtocol(nsString& aProtocol, ErrorResult& aRv) const;
  81
  82   void SetProtocol(const nsAString& aProtocol, ErrorResult& aRv);
  83
  84   void GetUsername(nsString& aUsername, ErrorResult& aRv) const;
  85
  86   void SetUsername(const nsAString& aUsername, ErrorResult& aRv);
  87
  88   void GetPassword(nsString& aPassword, ErrorResult& aRv) const;
  89
  90   void SetPassword(const nsAString& aPassword, ErrorResult& aRv);
  91
  92   void GetHost(nsString& aHost, ErrorResult& aRv) const;
  93
  94   void SetHost(const nsAString& aHost, ErrorResult& aRv);
  95
  96   void GetHostname(nsString& aHostname, ErrorResult& aRv) const;
  97
  98   void SetHostname(const nsAString& aHostname, ErrorResult& aRv);
  99
 100   void GetPort(nsString& aPort, ErrorResult& aRv) const;
 101
 102   void SetPort(const nsAString& aPort, ErrorResult& aRv);
 103
 104   void GetPathname(nsString& aPathname, ErrorResult& aRv) const;
 105
 106   void SetPathname(const nsAString& aPathname, ErrorResult& aRv);
 107
 108   void GetSearch(nsString& aRetval, ErrorResult& aRv) const;
 109
 110   void SetSearch(const nsAString& aArg, ErrorResult& aRv);
 111
 112   URLSearchParams* SearchParams();
 113
 114   void SetSearchParams(URLSearchParams& aSearchParams);
 115
 116   void GetHash(nsString& aRetval, ErrorResult& aRv) const;
 117
 118   void SetHash(const nsAString& aArg, ErrorResult& aRv);
 119
 120   void Stringify(nsString& aRetval, ErrorResult& aRv) const
 121   {
 122     GetHref(aRetval, aRv);
 123   }
 124
 125   // URLSearchParamsObserver
 126   void URLSearchParamsUpdated(URLSearchParams* aSearchParams) MOZ_OVERRIDE;
 127
 128 private:
 129   nsIURI* GetURI() const
 130   {
 131     return mURI;
 132   }
 133
 134   void CreateSearchParamsIfNeeded();
 135
 136   void SetSearchInternal(const nsAString& aSearch);
 137
 138   void UpdateURLSearchParams();
 139
 140   static void CreateObjectURLInternal(const GlobalObject& aGlobal,
 141                                       nsISupports* aObject,
 142                                       const nsACString& aScheme,
 143                                       const objectURLOptions& aOptions,
 144                                       nsString& aResult,
 145                                       ErrorResult& aError);
 146
 147   nsCOMPtr<nsIURI> mURI;
 148   nsRefPtr<URLSearchParams> mSearchParams;
 149
 150   friend class mozilla::dom::workers::URLProxy;
 151 };
 152
 153 bool IsChromeURI(nsIURI* aURI);
 154
 155 }
 156 }
 157
 158 #endif /* URL_h___ */