Back to index

lightning-sunbird  0.9+nobinonly
nsArrayEnumerator.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 nsArrayEnumerator_h__
00040 #define nsArrayEnumerator_h__
00041 
00042 // enumerator implementation for nsIArray
00043 
00044 #include "nsIArray.h"
00045 #include "nsCOMArray.h"
00046 #include "nsISimpleEnumerator.h"
00047 #include "nsCOMPtr.h"
00048 
00049 class nsSimpleArrayEnumerator : public nsISimpleEnumerator
00050 {
00051 public:
00052     // nsISupports interface
00053     NS_DECL_ISUPPORTS
00054 
00055     // nsISimpleEnumerator interface
00056     NS_DECL_NSISIMPLEENUMERATOR
00057 
00058     // nsSimpleArrayEnumerator methods
00059     nsSimpleArrayEnumerator(nsIArray* aValueArray) :
00060         mValueArray(aValueArray), mIndex(0) {
00061     }
00062 
00063 private:
00064     ~nsSimpleArrayEnumerator() {}
00065 
00066 protected:
00067     nsCOMPtr<nsIArray> mValueArray;
00068     PRUint32 mIndex;
00069 };
00070 
00071 
00072 // Create an enumerator for an existing nsIArray implementation
00073 // The enumerator holds an owning reference to the array.
00074 extern NS_COM nsresult
00075 NS_NewArrayEnumerator(nsISimpleEnumerator* *result,
00076                       nsIArray* array);
00077 
00078 
00079 // create an enumerator for an existing nsCOMArray<T> implementation
00080 // The enumerator will hold an owning reference to each ELEMENT in
00081 // the array. This means that the nsCOMArray<T> can safely go away
00082 // without its objects going away.
00083 extern NS_COM nsresult
00084 NS_NewArrayEnumerator(nsISimpleEnumerator* *aResult,
00085                       const nsCOMArray_base& aArray);
00086 
00087 #endif