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/. */
7 #ifndef mozilla_dom_URLSearchParams_h
8 #define mozilla_dom_URLSearchParams_h
11 #include "ErrorList.h"
12 #include "js/RootingAPI.h"
13 #include "mozilla/AlreadyAddRefed.h"
14 #include "mozilla/Assertions.h"
15 #include "mozilla/RefPtr.h"
16 #include "mozilla/UniquePtr.h"
18 #include "nsCycleCollectionParticipant.h"
19 #include "nsISupports.h"
22 #include "nsWrapperCache.h"
25 class nsIGlobalObject
;
28 struct JSStructuredCloneReader
;
29 struct JSStructuredCloneWriter
;
39 class URLSearchParams
;
40 class USVStringSequenceSequenceOrUSVStringUSVStringRecordOrUSVString
;
42 class URLSearchParamsObserver
: public nsISupports
{
44 virtual ~URLSearchParamsObserver() = default;
46 virtual void URLSearchParamsUpdated(URLSearchParams
* aFromThis
) = 0;
49 class URLSearchParams final
: public nsISupports
, public nsWrapperCache
{
53 NS_DECL_CYCLE_COLLECTING_ISUPPORTS
54 NS_DECL_CYCLE_COLLECTION_SCRIPT_HOLDER_CLASS(URLSearchParams
)
56 explicit URLSearchParams(nsISupports
* aParent
,
57 URLSearchParamsObserver
* aObserver
= nullptr);
60 nsISupports
* GetParentObject() const { return mParent
; }
62 virtual JSObject
* WrapObject(JSContext
* aCx
,
63 JS::Handle
<JSObject
*> aGivenProto
) override
;
65 static already_AddRefed
<URLSearchParams
> Constructor(
66 const GlobalObject
& aGlobal
,
67 const USVStringSequenceSequenceOrUSVStringUSVStringRecordOrUSVString
&
71 void ParseInput(const nsACString
& aInput
);
73 void Serialize(nsAString
& aValue
) const;
75 void Get(const nsAString
& aName
, nsString
& aRetval
);
77 void GetAll(const nsAString
& aName
, nsTArray
<nsString
>& aRetval
);
79 void Set(const nsAString
& aName
, const nsAString
& aValue
);
81 void Append(const nsAString
& aName
, const nsAString
& aValue
);
83 bool Has(const nsAString
& aName
);
85 void Delete(const nsAString
& aName
);
87 uint32_t GetIterableLength() const;
88 const nsAString
& GetKeyAtIndex(uint32_t aIndex
) const;
89 const nsAString
& GetValueAtIndex(uint32_t aIndex
) const;
91 void Sort(ErrorResult
& aRv
);
93 void Stringify(nsString
& aRetval
) const { Serialize(aRetval
); }
95 static already_AddRefed
<URLSearchParams
> ReadStructuredClone(
96 JSContext
* aCx
, nsIGlobalObject
* aGlobal
,
97 JSStructuredCloneReader
* aReader
);
99 bool WriteStructuredClone(JSContext
* aCx
,
100 JSStructuredCloneWriter
* aWriter
) const;
102 nsresult
GetSendInfo(nsIInputStream
** aBody
, uint64_t* aContentLength
,
103 nsACString
& aContentTypeWithCharset
,
104 nsACString
& aCharset
) const;
107 bool ReadStructuredClone(JSStructuredCloneReader
* aReader
);
109 bool WriteStructuredClone(JSStructuredCloneWriter
* aWriter
) const;
111 void AppendInternal(const nsAString
& aName
, const nsAString
& aValue
);
115 void NotifyObserver();
117 UniquePtr
<URLParams
> mParams
;
118 nsCOMPtr
<nsISupports
> mParent
;
119 RefPtr
<URLSearchParamsObserver
> mObserver
;
123 } // namespace mozilla
125 #endif /* mozilla_dom_URLSearchParams_h */