xpcom/ds/nsArray.h

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   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 nsArray_h__
   7 #define nsArray_h__
   8
   9 #include "nsIMutableArray.h"
  10 #include "nsCOMArray.h"
  11 #include "nsCOMPtr.h"
  12 #include "nsCycleCollectionParticipant.h"
  13 #include "mozilla/Attributes.h"
  14
  15 // {35C66FD1-95E9-4e0a-80C5-C3BD2B375481}
  16 #define NS_ARRAY_CID \
  17 { 0x35c66fd1, 0x95e9, 0x4e0a, \
  18   { 0x80, 0xc5, 0xc3, 0xbd, 0x2b, 0x37, 0x54, 0x81 } }
  19
  20 // nsArray without any refcounting declarations
  21 class nsArrayBase : public nsIMutableArray
  22 {
  23 public:
  24   NS_DECL_NSIARRAY
  25   NS_DECL_NSIMUTABLEARRAY
  26
  27   /* Both of these factory functions create a cycle-collectable array
  28      on the main thread and a non-cycle-collectable array on other
  29      threads.  */
  30   static already_AddRefed<nsIMutableArray> Create();
  31   /* Only for the benefit of the XPCOM module system, use Create()
  32      instead.  */
  33   static nsresult XPCOMConstructor(nsISupports* aOuter, const nsIID& aIID,
  34                                    void** aResult);
  35 protected:
  36   nsArrayBase() {}
  37   nsArrayBase(const nsArrayBase& aOther);
  38   explicit nsArrayBase(const nsCOMArray_base& aBaseArray) : mArray(aBaseArray) {}
  39   virtual ~nsArrayBase();
  40
  41   nsCOMArray_base mArray;
  42 };
  43
  44 class nsArray MOZ_FINAL : public nsArrayBase
  45 {
  46   friend class nsArrayBase;
  47
  48 public:
  49   NS_DECL_ISUPPORTS
  50
  51 private:
  52   nsArray() : nsArrayBase() {}
  53   nsArray(const nsArray& aOther);
  54   explicit nsArray(const nsCOMArray_base& aBaseArray) : nsArrayBase(aBaseArray) {}
  55   ~nsArray() {}
  56 };
  57
  58 class nsArrayCC MOZ_FINAL : public nsArrayBase
  59 {
  60   friend class nsArrayBase;
  61
  62 public:
  63   NS_DECL_CYCLE_COLLECTING_ISUPPORTS
  64   NS_DECL_CYCLE_COLLECTION_CLASS(nsArrayCC)
  65
  66 private:
  67   nsArrayCC() : nsArrayBase() {}
  68   nsArrayCC(const nsArrayCC& aOther);
  69   explicit nsArrayCC(const nsCOMArray_base& aBaseArray) : nsArrayBase(aBaseArray) {}
  70   ~nsArrayCC() {}
  71 };
  72
  73 #endif