xpcom/ds/nsArray.h

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is XPCOM Array implementation.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corp.
  19  * Portions created by the Initial Developer are Copyright (C) 2002
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *   Alec Flett <alecf@netscape.com>
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either the GNU General Public License Version 2 or later (the "GPL"), or
  27  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK ***** */
  38
  39 #ifndef nsArray_h__
  40 #define nsArray_h__
  41
  42 #include "nsIMutableArray.h"
  43 #include "nsCOMArray.h"
  44 #include "nsCOMPtr.h"
  45 #include "nsCycleCollectionParticipant.h"
  46
  47 #define NS_ARRAY_CLASSNAME \
  48   "nsIArray implementation"
  49
  50 // {35C66FD1-95E9-4e0a-80C5-C3BD2B375481}
  51 #define NS_ARRAY_CID \
  52 { 0x35c66fd1, 0x95e9, 0x4e0a, \
  53   { 0x80, 0xc5, 0xc3, 0xbd, 0x2b, 0x37, 0x54, 0x81 } }
  54
  55
  56 // adapter class to map nsIArray->nsCOMArray
  57 // do NOT declare this as a stack or member variable, use
  58 // nsCOMArray instead!
  59 // if you need to convert a nsCOMArray->nsIArray, see NS_NewArray above
  60 class nsArray : public nsIMutableArray
  61 {
  62 public:
  63     nsArray() { }
  64     nsArray(const nsCOMArray_base& aBaseArray) : mArray(aBaseArray)
  65     { }
  66
  67     NS_DECL_ISUPPORTS
  68     NS_DECL_NSIARRAY
  69     NS_DECL_NSIMUTABLEARRAY
  70
  71 protected:
  72     ~nsArray();
  73
  74     nsCOMArray_base mArray;
  75 };
  76
  77 class nsArrayCC : public nsArray
  78 {
  79 public:
  80     nsArrayCC() : nsArray() { }
  81     nsArrayCC(const nsCOMArray_base& aBaseArray) : nsArray(aBaseArray)
  82     { }
  83
  84     NS_DECL_CYCLE_COLLECTING_ISUPPORTS
  85     NS_DECL_CYCLE_COLLECTION_CLASS(nsArrayCC)
  86 };
  87
  88 nsresult nsArrayConstructor(nsISupports *aOuter, const nsIID& aIID, void **aResult);
  89
  90 #endif