docshell/base/nsDocShellEnumerator.cpp

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
   2  *
   3  * ***** BEGIN LICENSE BLOCK *****
   4  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   5  *
   6  * The contents of this file are subject to the Mozilla Public License Version
   7  * 1.1 (the "License"); you may not use this file except in compliance with
   8  * the License. You may obtain a copy of the License at
   9  * http://www.mozilla.org/MPL/
  10  *
  11  * Software distributed under the License is distributed on an "AS IS" basis,
  12  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  13  * for the specific language governing rights and limitations under the
  14  * License.
  15  *
  16  * The Original Code is the Mozilla browser.
  17  *
  18  * The Initial Developer of the Original Code is
  19  * Netscape Communications, Inc.
  20  * Portions created by the Initial Developer are Copyright (C) 1999
  21  * the Initial Developer. All Rights Reserved.
  22  *
  23  * Contributor(s):
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either of the GNU General Public License Version 2 or later (the "GPL"),
  27  * or 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
  40 #include "nsDocShellEnumerator.h"
  41
  42 #include "nsIDocShellTreeItem.h"
  43 #include "nsIDocShellTreeNode.h"
  44
  45 nsDocShellEnumerator::nsDocShellEnumerator(PRInt32 inEnumerationDirection)
  46 : mRootItem(nsnull)
  47 , mItemArray(nsnull)
  48 , mCurIndex(0)
  49 , mDocShellType(nsIDocShellTreeItem::typeAll)
  50 , mEnumerationDirection(inEnumerationDirection)
  51 {
  52 }
  53
  54 nsDocShellEnumerator::~nsDocShellEnumerator()
  55 {
  56   delete mItemArray;
  57 }
  58
  59 NS_IMPL_ISUPPORTS1(nsDocShellEnumerator, nsISimpleEnumerator)
  60
  61
  62 /* nsISupports getNext (); */
  63 NS_IMETHODIMP nsDocShellEnumerator::GetNext(nsISupports **outCurItem)
  64 {
  65   NS_ENSURE_ARG_POINTER(outCurItem);
  66   *outCurItem = nsnull;
  67
  68   nsresult rv = EnsureDocShellArray();
  69   if (NS_FAILED(rv)) return rv;
  70
  71   if (mCurIndex >= 0 && mCurIndex < mItemArray->Count())
  72   {
  73     nsIDocShellTreeItem* thisItem = reinterpret_cast<nsIDocShellTreeItem*>(mItemArray->ElementAt(mCurIndex));
  74     rv = thisItem->QueryInterface(NS_GET_IID(nsISupports), (void **)outCurItem);
  75     if (NS_FAILED(rv)) return rv;
  76   }
  77   else
  78     return NS_ERROR_FAILURE;
  79
  80   mCurIndex ++;
  81
  82   return NS_OK;
  83 }
  84
  85 /* boolean hasMoreElements (); */
  86 NS_IMETHODIMP nsDocShellEnumerator::HasMoreElements(PRBool *outHasMore)
  87 {
  88   NS_ENSURE_ARG_POINTER(outHasMore);
  89   *outHasMore = PR_FALSE;
  90
  91   nsresult rv = EnsureDocShellArray();
  92   if (NS_FAILED(rv)) return rv;
  93
  94   *outHasMore = (mCurIndex < mItemArray->Count());
  95   return NS_OK;
  96 }
  97
  98 nsresult nsDocShellEnumerator::GetEnumerationRootItem(nsIDocShellTreeItem * *aEnumerationRootItem)
  99 {
 100   NS_ENSURE_ARG_POINTER(aEnumerationRootItem);
 101   *aEnumerationRootItem = mRootItem;
 102   NS_IF_ADDREF(*aEnumerationRootItem);
 103   return NS_OK;
 104 }
 105
 106 nsresult nsDocShellEnumerator::SetEnumerationRootItem(nsIDocShellTreeItem * aEnumerationRootItem)
 107 {
 108   mRootItem = aEnumerationRootItem;
 109   ClearState();
 110   return NS_OK;
 111 }
 112
 113 nsresult nsDocShellEnumerator::GetEnumDocShellType(PRInt32 *aEnumerationItemType)
 114 {
 115   NS_ENSURE_ARG_POINTER(aEnumerationItemType);
 116   *aEnumerationItemType = mDocShellType;
 117   return NS_OK;
 118 }
 119
 120 nsresult nsDocShellEnumerator::SetEnumDocShellType(PRInt32 aEnumerationItemType)
 121 {
 122   mDocShellType = aEnumerationItemType;
 123   ClearState();
 124   return NS_OK;
 125 }
 126
 127 nsresult nsDocShellEnumerator::First()
 128 {
 129   mCurIndex = 0;
 130   return EnsureDocShellArray();
 131 }
 132
 133 nsresult nsDocShellEnumerator::EnsureDocShellArray()
 134 {
 135   if (!mItemArray)
 136   {
 137     mItemArray = new nsVoidArray;
 138     if (!mItemArray) return NS_ERROR_OUT_OF_MEMORY;
 139
 140     return BuildDocShellArray(*mItemArray);
 141   }
 142
 143   return NS_OK;
 144 }
 145
 146 nsresult nsDocShellEnumerator::ClearState()
 147 {
 148   delete mItemArray;
 149   mItemArray = nsnull;
 150
 151   mCurIndex = 0;
 152   return NS_OK;
 153 }
 154
 155 nsresult nsDocShellEnumerator::BuildDocShellArray(nsVoidArray& inItemArray)
 156 {
 157   NS_ENSURE_TRUE(mRootItem, NS_ERROR_NOT_INITIALIZED);
 158   inItemArray.Clear();
 159   return BuildArrayRecursive(mRootItem, inItemArray);
 160 }
 161
 162 nsresult nsDocShellForwardsEnumerator::BuildArrayRecursive(nsIDocShellTreeItem* inItem, nsVoidArray& inItemArray)
 163 {
 164   nsresult rv;
 165   nsCOMPtr<nsIDocShellTreeNode> itemAsNode = do_QueryInterface(inItem, &rv);
 166   if (NS_FAILED(rv)) return rv;
 167
 168   PRInt32   itemType;
 169   // add this item to the array
 170   if ((mDocShellType == nsIDocShellTreeItem::typeAll) ||
 171       (NS_SUCCEEDED(inItem->GetItemType(&itemType)) && (itemType == mDocShellType)))
 172   {
 173     rv = inItemArray.AppendElement((void *)inItem);
 174     if (NS_FAILED(rv)) return rv;
 175   }
 176
 177   PRInt32   numChildren;
 178   rv = itemAsNode->GetChildCount(&numChildren);
 179   if (NS_FAILED(rv)) return rv;
 180
 181   for (PRInt32 i = 0; i < numChildren; ++i)
 182   {
 183     nsCOMPtr<nsIDocShellTreeItem> curChild;
 184     rv = itemAsNode->GetChildAt(i, getter_AddRefs(curChild));
 185     if (NS_FAILED(rv)) return rv;
 186
 187     rv = BuildArrayRecursive(curChild, inItemArray);
 188     if (NS_FAILED(rv)) return rv;
 189   }
 190
 191   return NS_OK;
 192 }
 193
 194
 195 nsresult nsDocShellBackwardsEnumerator::BuildArrayRecursive(nsIDocShellTreeItem* inItem, nsVoidArray& inItemArray)
 196 {
 197   nsresult rv;
 198   nsCOMPtr<nsIDocShellTreeNode> itemAsNode = do_QueryInterface(inItem, &rv);
 199   if (NS_FAILED(rv)) return rv;
 200
 201   PRInt32   numChildren;
 202   rv = itemAsNode->GetChildCount(&numChildren);
 203   if (NS_FAILED(rv)) return rv;
 204
 205   for (PRInt32 i = numChildren - 1; i >= 0; --i)
 206   {
 207     nsCOMPtr<nsIDocShellTreeItem> curChild;
 208     rv = itemAsNode->GetChildAt(i, getter_AddRefs(curChild));
 209     if (NS_FAILED(rv)) return rv;
 210
 211     rv = BuildArrayRecursive(curChild, inItemArray);
 212     if (NS_FAILED(rv)) return rv;
 213   }
 214
 215   PRInt32   itemType;
 216   // add this item to the array
 217   if ((mDocShellType == nsIDocShellTreeItem::typeAll) ||
 218       (NS_SUCCEEDED(inItem->GetItemType(&itemType)) && (itemType == mDocShellType)))
 219   {
 220     rv = inItemArray.AppendElement((void *)inItem);
 221     if (NS_FAILED(rv)) return rv;
 222   }
 223
 224
 225   return NS_OK;
 226 }
 227
 228