summaryrefslogtreecommitdiffstats
path: root/dom/url/URL.h
blob: 16b4678baff9dc9c824568db09333413d94fde6d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
/* -*- 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_URL_h
#define mozilla_dom_URL_h

#include "mozilla/dom/BindingDeclarations.h"
#include "mozilla/dom/URLSearchParams.h"
#include "nsCycleCollectionParticipant.h"
#include "nsString.h"
#include "nsWrapperCache.h"

class nsISupports;
class nsIURI;

namespace mozilla {

class ErrorResult;
class DOMMediaStream;

namespace dom {

class Blob;
class MediaSource;
class GlobalObject;
struct objectURLOptions;

class URL : public URLSearchParamsObserver
          , public nsWrapperCache
{
public:
  NS_DECL_CYCLE_COLLECTING_ISUPPORTS
  NS_DECL_CYCLE_COLLECTION_SCRIPT_HOLDER_CLASS(URL)

  URL(nsISupports* aParent)
    : mParent(aParent)
  {}

  // WebIDL methods
  nsISupports* GetParentObject() const
  {
    return mParent;
  }

  virtual JSObject*
  WrapObject(JSContext* aCx, JS::Handle<JSObject*> aGivenProto) override;

  static already_AddRefed<URL>
  Constructor(const GlobalObject& aGlobal, const nsAString& aURL,
              URL& aBase, ErrorResult& aRv);

  static already_AddRefed<URL>
  Constructor(const GlobalObject& aGlobal, const nsAString& aURL,
              const Optional<nsAString>& aBase, ErrorResult& aRv);

  // Helper for Fetch API
  static already_AddRefed<URL>
  WorkerConstructor(const GlobalObject& aGlobal, const nsAString& aURL,
                    const nsAString& aBase, ErrorResult& aRv);


  static void
  CreateObjectURL(const GlobalObject& aGlobal, Blob& aBlob,
                  const objectURLOptions& aOptions,
                  nsAString& aResult, ErrorResult& aRv);

  static void
  CreateObjectURL(const GlobalObject& aGlobal, DOMMediaStream& aStream,
                  const objectURLOptions& aOptions, nsAString& aResult,
                  ErrorResult& aRv);

  static void
  CreateObjectURL(const GlobalObject& aGlobal, MediaSource& aSource,
                  const objectURLOptions& aOptions, nsAString& aResult,
                  ErrorResult& aRv);

  static void
  RevokeObjectURL(const GlobalObject& aGlobal, const nsAString& aURL,
                  ErrorResult& aRv);

  static bool
  IsValidURL(const GlobalObject& aGlobal, const nsAString& aURL,
             ErrorResult& aRv);

  virtual void
  GetHref(nsAString& aHref, ErrorResult& aRv) const = 0;

  virtual void
  SetHref(const nsAString& aHref, ErrorResult& aRv) = 0;

  virtual void
  GetOrigin(nsAString& aOrigin, ErrorResult& aRv) const = 0;

  virtual void
  GetProtocol(nsAString& aProtocol, ErrorResult& aRv) const = 0;

  virtual void
  SetProtocol(const nsAString& aProtocol, ErrorResult& aRv) = 0;

  virtual void
  GetUsername(nsAString& aUsername, ErrorResult& aRv) const = 0;

  virtual void
  SetUsername(const nsAString& aUsername, ErrorResult& aRv) = 0;

  virtual void
  GetPassword(nsAString& aPassword, ErrorResult& aRv) const = 0;

  virtual void
  SetPassword(const nsAString& aPassword, ErrorResult& aRv) = 0;

  virtual void
  GetHost(nsAString& aHost, ErrorResult& aRv) const = 0;

  virtual void
  SetHost(const nsAString& aHost, ErrorResult& aRv) = 0;

  virtual void
  GetHostname(nsAString& aHostname, ErrorResult& aRv) const = 0;

  virtual void
  SetHostname(const nsAString& aHostname, ErrorResult& aRv) = 0;

  virtual void
  GetPort(nsAString& aPort, ErrorResult& aRv) const = 0;

  virtual void
  SetPort(const nsAString& aPort, ErrorResult& aRv) = 0;

  virtual void
  GetPathname(nsAString& aPathname, ErrorResult& aRv) const = 0;

  virtual void
  SetPathname(const nsAString& aPathname, ErrorResult& aRv) = 0;

  virtual void
  GetSearch(nsAString& aSearch, ErrorResult& aRv) const = 0;

  virtual void
  SetSearch(const nsAString& aSearch, ErrorResult& aRv);

  URLSearchParams* SearchParams();

  virtual void
  GetHash(nsAString& aHost, ErrorResult& aRv) const = 0;

  virtual void
  SetHash(const nsAString& aHash, ErrorResult& aRv) = 0;

  void Stringify(nsAString& aRetval, ErrorResult& aRv) const
  {
    GetHref(aRetval, aRv);
  }

  // URLSearchParamsObserver
  void
  URLSearchParamsUpdated(URLSearchParams* aSearchParams) override;

protected:
  virtual ~URL()
  {}

  virtual void
  UpdateURLSearchParams() = 0;

  virtual void
  SetSearchInternal(const nsAString& aSearch, ErrorResult& aRv) = 0;

  void CreateSearchParamsIfNeeded();

  nsCOMPtr<nsISupports> mParent;
  RefPtr<URLSearchParams> mSearchParams;
};

bool IsChromeURI(nsIURI* aURI);

} // namespace dom
} // namespace mozilla

#endif /* mozilla_dom_URL_h */