dom/base/URLSearchParams.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
   6 #ifndef mozilla_dom_URLSearchParams_h
   7 #define mozilla_dom_URLSearchParams_h
   8
   9 #include "mozilla/dom/BindingDeclarations.h"
  10 #include "mozilla/ErrorResult.h"
  11 #include "nsCycleCollectionParticipant.h"
  12 #include "nsWrapperCache.h"
  13 #include "nsISupports.h"
  14 #include "nsIUnicodeDecoder.h"
  15
  16 namespace mozilla {
  17 namespace dom {
  18
  19 class URLSearchParams;
  20
  21 class URLSearchParamsObserver : public nsISupports
  22 {
  23 public:
  24   virtual ~URLSearchParamsObserver() {}
  25
  26   virtual void URLSearchParamsUpdated(URLSearchParams* aFromThis) = 0;
  27 };
  28
  29 class URLSearchParams MOZ_FINAL : public nsISupports,
  30                                   public nsWrapperCache
  31 {
  32   ~URLSearchParams();
  33
  34 public:
  35   NS_DECL_CYCLE_COLLECTING_ISUPPORTS
  36   NS_DECL_CYCLE_COLLECTION_SCRIPT_HOLDER_CLASS(URLSearchParams)
  37
  38   URLSearchParams();
  39
  40   // WebIDL methods
  41   nsISupports* GetParentObject() const
  42   {
  43     return nullptr;
  44   }
  45
  46   virtual JSObject*
  47   WrapObject(JSContext* aCx) MOZ_OVERRIDE;
  48
  49   static already_AddRefed<URLSearchParams>
  50   Constructor(const GlobalObject& aGlobal, const nsAString& aInit,
  51               ErrorResult& aRv);
  52
  53   static already_AddRefed<URLSearchParams>
  54   Constructor(const GlobalObject& aGlobal, URLSearchParams& aInit,
  55               ErrorResult& aRv);
  56
  57   void ParseInput(const nsACString& aInput,
  58                   URLSearchParamsObserver* aObserver);
  59
  60   void AddObserver(URLSearchParamsObserver* aObserver);
  61   void RemoveObserver(URLSearchParamsObserver* aObserver);
  62   void RemoveObservers();
  63
  64   void Serialize(nsAString& aValue) const;
  65
  66   void Get(const nsAString& aName, nsString& aRetval);
  67
  68   void GetAll(const nsAString& aName, nsTArray<nsString >& aRetval);
  69
  70   void Set(const nsAString& aName, const nsAString& aValue);
  71
  72   void Append(const nsAString& aName, const nsAString& aValue);
  73
  74   bool Has(const nsAString& aName);
  75
  76   void Delete(const nsAString& aName);
  77
  78   void Stringify(nsString& aRetval) const
  79   {
  80     Serialize(aRetval);
  81   }
  82
  83 private:
  84   void AppendInternal(const nsAString& aName, const nsAString& aValue);
  85
  86   void DeleteAll();
  87
  88   void DecodeString(const nsACString& aInput, nsAString& aOutput);
  89   void ConvertString(const nsACString& aInput, nsAString& aOutput);
  90
  91   void NotifyObservers(URLSearchParamsObserver* aExceptObserver);
  92
  93   struct Param
  94   {
  95     nsString mKey;
  96     nsString mValue;
  97   };
  98
  99   nsTArray<Param> mSearchParams;
 100
 101   nsTArray<nsRefPtr<URLSearchParamsObserver>> mObservers;
 102   nsCOMPtr<nsIUnicodeDecoder> mDecoder;
 103 };
 104
 105 } // namespace dom
 106 } // namespace mozilla
 107
 108 #endif /* mozilla_dom_URLSearchParams_h */