dom/base/DOMStringList.h

   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/. */
   6
   7 #ifndef mozilla_dom_DOMStringList_h
   8 #define mozilla_dom_DOMStringList_h
   9
  10 #include "nsISupports.h"
  11 #include "nsTArray.h"
  12 #include "nsWrapperCache.h"
  13 #include "nsString.h"
  14
  15 namespace mozilla {
  16 namespace dom {
  17
  18 class DOMStringList : public nsISupports, public nsWrapperCache {
  19  protected:
  20   virtual ~DOMStringList();
  21
  22  public:
  23   NS_DECL_CYCLE_COLLECTING_ISUPPORTS
  24   NS_DECL_CYCLE_COLLECTION_SCRIPT_HOLDER_CLASS(DOMStringList)
  25
  26   virtual JSObject* WrapObject(JSContext* aCx,
  27                                JS::Handle<JSObject*> aGivenProto) override;
  28   nsISupports* GetParentObject() { return nullptr; }
  29
  30   void IndexedGetter(uint32_t aIndex, bool& aFound, nsAString& aResult) {
  31     EnsureFresh();
  32     if (aIndex < mNames.Length()) {
  33       aFound = true;
  34       aResult = mNames[aIndex];
  35     } else {
  36       aFound = false;
  37     }
  38   }
  39
  40   void Item(uint32_t aIndex, nsAString& aResult) {
  41     EnsureFresh();
  42     if (aIndex < mNames.Length()) {
  43       aResult = mNames[aIndex];
  44     } else {
  45       aResult.SetIsVoid(true);
  46     }
  47   }
  48
  49   uint32_t Length() {
  50     EnsureFresh();
  51     return mNames.Length();
  52   }
  53
  54   bool Contains(const nsAString& aString) {
  55     EnsureFresh();
  56     return mNames.Contains(aString);
  57   }
  58
  59   bool Add(const nsAString& aName) {
  60     // XXXbz mNames should really be a fallible array; otherwise this
  61     // return value is meaningless.
  62     return mNames.AppendElement(aName) != nullptr;
  63   }
  64
  65   void Clear() { mNames.Clear(); }
  66
  67   nsTArray<nsString>& StringArray() { return mNames; }
  68
  69   void CopyList(nsTArray<nsString>& aNames) { aNames = mNames; }
  70
  71  protected:
  72   // A method that subclasses can override to modify mNames as needed
  73   // before we index into it or return its length or whatnot.
  74   virtual void EnsureFresh() {}
  75
  76   // XXXbz we really want this to be a fallible array, but we end up passing it
  77   // to consumers who declare themselves as taking and nsTArray.  :(
  78   nsTArray<nsString> mNames;
  79 };
  80
  81 }  // namespace dom
  82 }  // namespace mozilla
  83
  84 #endif /* mozilla_dom_DOMStringList_h */