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 UTF8StringSequenceSequenceOrUTF8StringUTF8StringRecordOrUTF8String
;
44 class URLSearchParamsObserver
: public nsISupports
{
46 virtual ~URLSearchParamsObserver() = default;
48 virtual void URLSearchParamsUpdated(URLSearchParams
* aFromThis
) = 0;
51 class URLSearchParams final
: public nsISupports
, public nsWrapperCache
{
55 NS_DECL_CYCLE_COLLECTING_ISUPPORTS
56 NS_DECL_CYCLE_COLLECTION_WRAPPERCACHE_CLASS(URLSearchParams
)
58 explicit URLSearchParams(nsISupports
* aParent
,
59 URLSearchParamsObserver
* aObserver
= nullptr);
62 nsISupports
* GetParentObject() const { return mParent
; }
64 virtual JSObject
* WrapObject(JSContext
* aCx
,
65 JS::Handle
<JSObject
*> aGivenProto
) override
;
67 static already_AddRefed
<URLSearchParams
> Constructor(
68 const GlobalObject
& aGlobal
,
69 const UTF8StringSequenceSequenceOrUTF8StringUTF8StringRecordOrUTF8String
&
73 void ParseInput(const nsACString
& aInput
);
75 void Serialize(nsACString
& aValue
) const;
77 uint32_t Size() const;
79 void Get(const nsACString
& aName
, nsACString
& aRetval
);
81 void GetAll(const nsACString
& aName
, nsTArray
<nsCString
>& aRetval
);
83 void Set(const nsACString
& aName
, const nsACString
& aValue
);
85 void Append(const nsACString
& aName
, const nsACString
& aValue
);
87 bool Has(const nsACString
& aName
, const Optional
<nsACString
>& aValue
);
89 void Delete(const nsACString
& aName
, const Optional
<nsACString
>& aValue
);
91 uint32_t GetIterableLength() const;
92 const nsACString
& GetKeyAtIndex(uint32_t aIndex
) const;
93 const nsACString
& GetValueAtIndex(uint32_t aIndex
) const;
95 void Sort(ErrorResult
& aRv
);
97 void Stringify(nsAString
&) const;
99 nsresult
GetSendInfo(nsIInputStream
** aBody
, uint64_t* aContentLength
,
100 nsACString
& aContentTypeWithCharset
,
101 nsACString
& aCharset
) const;
104 void AppendInternal(const nsACString
& aName
, const nsACString
& aValue
);
108 void NotifyObserver();
110 UniquePtr
<URLParams
> mParams
;
111 nsCOMPtr
<nsISupports
> mParent
;
112 RefPtr
<URLSearchParamsObserver
> mObserver
;
116 } // namespace mozilla
118 #endif /* mozilla_dom_URLSearchParams_h */