libkern/c++/OSCollectionIterator.cpp

   1 /*
   2  * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. The rights granted to you under the License
  10  * may not be used to create, or enable the creation or redistribution of,
  11  * unlawful or unlicensed copies of an Apple operating system, or to
  12  * circumvent, violate, or enable the circumvention or violation of, any
  13  * terms of an Apple operating system software license agreement.
  14  *
  15  * Please obtain a copy of the License at
  16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
  17  *
  18  * The Original Code and all software distributed under the License are
  19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  23  * Please see the License for the specific language governing rights and
  24  * limitations under the License.
  25  *
  26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
  27  */
  28 /* IOArray.h created by rsulack on Thu 11-Sep-1997 */
  29
  30 #include <libkern/c++/OSCollectionIterator.h>
  31 #include <libkern/c++/OSCollection.h>
  32 #include <libkern/c++/OSArray.h>
  33 #include <libkern/c++/OSLib.h>
  34
  35 #define super OSIterator
  36
  37 OSDefineMetaClassAndStructors(OSCollectionIterator, OSIterator)
  38
  39 bool
  40 OSCollectionIterator::initWithCollection(const OSCollection *inColl)
  41 {
  42         if (!super::init() || !inColl) {
  43                 return false;
  44         }
  45
  46         inColl->retain();
  47         collection = inColl;
  48         collIterator = 0;
  49         initialUpdateStamp = 0;
  50         valid = false;
  51
  52         return true;
  53 }
  54
  55 OSCollectionIterator *
  56 OSCollectionIterator::withCollection(const OSCollection *inColl)
  57 {
  58         OSCollectionIterator *me = new OSCollectionIterator;
  59
  60         if (me && !me->initWithCollection(inColl)) {
  61                 me->release();
  62                 return 0;
  63         }
  64
  65         return me;
  66 }
  67
  68 void
  69 OSCollectionIterator::free()
  70 {
  71         if (collIterator) {
  72                 kfree(collIterator, collection->iteratorSize());
  73                 OSCONTAINER_ACCUMSIZE(-((size_t) collection->iteratorSize()));
  74                 collIterator = 0;
  75         }
  76
  77         if (collection) {
  78                 collection->release();
  79                 collection = 0;
  80         }
  81
  82         super::free();
  83 }
  84
  85 void
  86 OSCollectionIterator::reset()
  87 {
  88         valid = false;
  89
  90         if (!collIterator) {
  91                 collIterator = (void *)kalloc_container(collection->iteratorSize());
  92                 OSCONTAINER_ACCUMSIZE(collection->iteratorSize());
  93                 if (!collIterator) {
  94                         return;
  95                 }
  96         }
  97
  98         if (!collection->initIterator(collIterator)) {
  99                 return;
 100         }
 101
 102         initialUpdateStamp = collection->updateStamp;
 103         valid = true;
 104 }
 105
 106 bool
 107 OSCollectionIterator::isValid()
 108 {
 109         if (!collIterator) {
 110                 collIterator = (void *)kalloc_container(collection->iteratorSize());
 111                 OSCONTAINER_ACCUMSIZE(collection->iteratorSize());
 112                 if (!collection->initIterator(collIterator)) {
 113                         return false;
 114                 }
 115                 initialUpdateStamp = collection->updateStamp;
 116                 valid = true;
 117         } else if (!valid || collection->updateStamp != initialUpdateStamp) {
 118                 return false;
 119         }
 120
 121         return true;
 122 }
 123
 124 OSObject *
 125 OSCollectionIterator::getNextObject()
 126 {
 127         OSObject *retObj;
 128         bool retVal;
 129
 130         if (!isValid()) {
 131                 return 0;
 132         }
 133
 134         retVal = collection->getNextObjectForIterator(collIterator, &retObj);
 135         return (retVal)? retObj : 0;
 136 }