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/OSDebug.h>
31
32#include <libkern/c++/OSCollection.h>
33#include <libkern/c++/OSDictionary.h>
34
35#include <IOKit/IOKitDebug.h>
36
37#define super OSObject
38
39OSDefineMetaClassAndAbstractStructors(OSCollection, OSObject)
40
41
42OSMetaClassDefineReservedUsed(OSCollection, 0);
43OSMetaClassDefineReservedUsed(OSCollection, 1);
44OSMetaClassDefineReservedUnused(OSCollection, 2);
45OSMetaClassDefineReservedUnused(OSCollection, 3);
46OSMetaClassDefineReservedUnused(OSCollection, 4);
47OSMetaClassDefineReservedUnused(OSCollection, 5);
48OSMetaClassDefineReservedUnused(OSCollection, 6);
49OSMetaClassDefineReservedUnused(OSCollection, 7);
50
51bool OSCollection::init()
52{
53    if (!super::init())
54        return false;
55
56    updateStamp = 0;
57
58    return true;
59}
60
61void OSCollection::haveUpdated()
62{
63    if (fOptions & kImmutable)
64    {
65#if __LP64__
66	if (!(gIOKitDebug & kOSRegistryModsMode))
67#else
68	if (gIOKitDebug & kOSRegistryModsMode)
69#endif
70	{
71	    panic("Trying to change a collection in the registry");
72	}
73	else
74	{
75	    OSReportWithBacktrace("Trying to change a collection in the registry");
76	}
77    }
78    updateStamp++;
79}
80
81unsigned OSCollection::setOptions(unsigned options, unsigned mask, void *)
82{
83    unsigned old = fOptions;
84
85    if (mask)
86	fOptions = (old & ~mask) | (options & mask);
87
88    return old;
89}
90
91OSCollection *  OSCollection::copyCollection(OSDictionary *cycleDict)
92{
93    if (cycleDict) {
94	OSObject *obj = cycleDict->getObject((const OSSymbol *) this);
95	if (obj)
96	    obj->retain();
97
98	return reinterpret_cast<OSCollection *>(obj);
99    }
100    else {
101	// If we are here it means that there is a collection subclass that
102	// hasn't overridden the copyCollection method.  In which case just
103	// return a reference to ourselves.
104	// Hopefully this collection will not be inserted into the registry
105	retain();
106	return this;
107    }
108}
109