Back to index

lightning-sunbird  0.9+nobinonly
nsEnumeratorUtils.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 mozilla.org code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 1998
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either of the GNU General Public License Version 2 or later (the "GPL"),
00026  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 
00038 #ifndef nsEnumeratorUtils_h__
00039 #define nsEnumeratorUtils_h__
00040 
00041 #include "nsIEnumerator.h"
00042 #include "nsISupportsArray.h"
00043 
00044 class NS_COM nsArrayEnumerator : public nsISimpleEnumerator
00045 {
00046 public:
00047     // nsISupports interface
00048     NS_DECL_ISUPPORTS
00049 
00050     // nsISimpleEnumerator interface
00051     NS_IMETHOD HasMoreElements(PRBool* aResult);
00052     NS_IMETHOD GetNext(nsISupports** aResult);
00053 
00054     // nsArrayEnumerator methods
00055     nsArrayEnumerator(nsISupportsArray* aValueArray);
00056 
00057 private:
00058     ~nsArrayEnumerator(void);
00059 
00060 protected:
00061     nsISupportsArray* mValueArray;
00062     PRInt32 mIndex;
00063 };
00064 
00065 extern NS_COM nsresult
00066 NS_NewArrayEnumerator(nsISimpleEnumerator* *result,
00067                       nsISupportsArray* array);
00068 
00070 
00071 class NS_COM nsSingletonEnumerator : public nsISimpleEnumerator
00072 {
00073 public:
00074     NS_DECL_ISUPPORTS
00075 
00076     // nsISimpleEnumerator methods
00077     NS_IMETHOD HasMoreElements(PRBool* aResult);
00078     NS_IMETHOD GetNext(nsISupports** aResult);
00079 
00080     nsSingletonEnumerator(nsISupports* aValue);
00081 
00082 private:
00083     ~nsSingletonEnumerator();
00084 
00085 protected:
00086     nsISupports* mValue;
00087     PRBool mConsumed;
00088 };
00089 
00090 extern "C" NS_COM nsresult
00091 NS_NewSingletonEnumerator(nsISimpleEnumerator* *result,
00092                           nsISupports* singleton);
00093 
00095 
00096 class NS_COM nsUnionEnumerator : public nsISimpleEnumerator
00097 {
00098 public:
00099     NS_DECL_ISUPPORTS
00100 
00101     // nsISimpleEnumerator methods
00102     NS_IMETHOD HasMoreElements(PRBool* aResult);
00103     NS_IMETHOD GetNext(nsISupports** aResult);
00104 
00105     nsUnionEnumerator(nsISimpleEnumerator* firstEnumerator,
00106                       nsISimpleEnumerator* secondEnumerator);
00107 
00108 private:
00109     ~nsUnionEnumerator();
00110 
00111 protected:
00112     nsCOMPtr<nsISimpleEnumerator> mFirstEnumerator, mSecondEnumerator;
00113     PRBool mConsumed;
00114     PRBool mAtSecond;
00115 };
00116 
00117 extern "C" NS_COM nsresult
00118 NS_NewUnionEnumerator(nsISimpleEnumerator* *result,
00119                       nsISimpleEnumerator* firstEnumerator,
00120                       nsISimpleEnumerator* secondEnumerator);
00121 
00123 
00124 #endif /* nsEnumeratorUtils_h__ */