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