Back to index

lightning-sunbird  0.9+nobinonly
nsArray.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is XPCOM Array implementation.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corp.
00019  * Portions created by the Initial Developer are Copyright (C) 2002
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *   Alec Flett <alecf@netscape.com>
00024  *
00025  * Alternatively, the contents of this file may be used under the terms of
00026  * either the GNU General Public License Version 2 or later (the "GPL"), or
00027  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00028  * in which case the provisions of the GPL or the LGPL are applicable instead
00029  * of those above. If you wish to allow use of your version of this file only
00030  * under the terms of either the GPL or the LGPL, and not to allow others to
00031  * use your version of this file under the terms of the MPL, indicate your
00032  * decision by deleting the provisions above and replace them with the notice
00033  * and other provisions required by the GPL or the LGPL. If you do not delete
00034  * the provisions above, a recipient may use your version of this file under
00035  * the terms of any one of the MPL, the GPL or the LGPL.
00036  *
00037  * ***** END LICENSE BLOCK ***** */
00038 
00039 #ifndef nsArray_h__
00040 #define nsArray_h__
00041 
00042 #include "nsIArray.h"
00043 #include "nsCOMArray.h"
00044 #include "nsCOMPtr.h"
00045 
00046 #define NS_ARRAY_CLASSNAME \
00047   "nsIArray implementation"
00048 
00049 // {35C66FD1-95E9-4e0a-80C5-C3BD2B375481}
00050 #define NS_ARRAY_CID \
00051 { 0x35c66fd1, 0x95e9, 0x4e0a, \
00052   { 0x80, 0xc5, 0xc3, 0xbd, 0x2b, 0x37, 0x54, 0x81 } }
00053 
00054 
00055 // create a new, empty array
00056 nsresult NS_COM
00057 NS_NewArray(nsIMutableArray** aResult);
00058 
00059 // The resulting array will hold an owning reference to every element
00060 // in the original nsCOMArray<T>. This also means that any further
00061 // changes to the original nsCOMArray<T> will not affect the new
00062 // array, and that the original array can go away and the new array
00063 // will still hold valid elements.
00064 nsresult NS_COM
00065 NS_NewArray(nsIMutableArray** aResult, const nsCOMArray_base& base);
00066 
00067 // adapter class to map nsIArray->nsCOMArray
00068 // do NOT declare this as a stack or member variable, use
00069 // nsCOMArray instead!
00070 // if you need to convert a nsCOMArray->nsIArray, see NS_NewArray above
00071 class nsArray : public nsIMutableArray
00072 {
00073 public:
00074     nsArray() { }
00075     nsArray(const nsCOMArray_base& aBaseArray) : mArray(aBaseArray)
00076     { }
00077     
00078     NS_DECL_ISUPPORTS
00079     NS_DECL_NSIARRAY
00080     NS_DECL_NSIMUTABLEARRAY
00081 
00082 private:
00083     ~nsArray();
00084 
00085     nsCOMArray_base mArray;
00086 };
00087 
00088 
00089 // helper class for do_QueryElementAt
00090 class NS_COM nsQueryArrayElementAt : public nsCOMPtr_helper
00091   {
00092     public:
00093       nsQueryArrayElementAt(nsIArray* aArray, PRUint32 aIndex,
00094                             nsresult* aErrorPtr)
00095           : mArray(aArray),
00096             mIndex(aIndex),
00097             mErrorPtr(aErrorPtr)
00098         {
00099           // nothing else to do here
00100         }
00101 
00102       virtual nsresult NS_FASTCALL operator()(const nsIID& aIID, void**) const;
00103 
00104     private:
00105       nsIArray*  mArray;
00106       PRUint32   mIndex;
00107       nsresult*  mErrorPtr;
00108   };
00109 
00110 inline
00111 const nsQueryArrayElementAt
00112 do_QueryElementAt(nsIArray* aArray, PRUint32 aIndex, nsresult* aErrorPtr = 0)
00113   {
00114     return nsQueryArrayElementAt(aArray, aIndex, aErrorPtr);
00115   }
00116 
00117 
00118 #endif