-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathNSDictionary.m
More file actions
1543 lines (1394 loc) · 41 KB
/
NSDictionary.m
File metadata and controls
1543 lines (1394 loc) · 41 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/** NSDictionary - Dictionary object to store key/value pairs
Copyright (C) 1995, 1996, 1997 Free Software Foundation, Inc.
Written by: Andrew Kachites McCallum <mccallum@gnu.ai.mit.edu>
From skeleton by: Adam Fedor <fedor@boulder.colorado.edu>
Date: Mar 1995
This file is part of the GNUstep Base Library.
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free
Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110 USA.
<title>NSDictionary class reference</title>
$Date$ $Revision$
*/
#import "common.h"
#import "Foundation/NSDictionary.h"
#import "Foundation/NSArray.h"
#import "Foundation/NSOrderedSet.h"
#import "Foundation/NSData.h"
#import "Foundation/NSException.h"
#import "Foundation/NSAutoreleasePool.h"
#import "Foundation/NSFileManager.h"
#import "Foundation/NSCoder.h"
#import "Foundation/NSLock.h"
#import "Foundation/NSSet.h"
#import "Foundation/NSValue.h"
#import "Foundation/NSKeyValueCoding.h"
#import "Foundation/NSUserDefaults.h"
// For private method _decodeArrayOfObjectsForKey:
#import "Foundation/NSKeyedArchiver.h"
#import "GSPrivate.h"
#import "GSFastEnumeration.h"
#import "GSDispatch.h"
static BOOL GSMacOSXCompatiblePropertyLists(void)
{
if (GSPrivateDefaultsFlag(NSWriteOldStylePropertyLists) == YES)
return NO;
return GSPrivateDefaultsFlag(GSMacOSXCompatible);
}
@class GSDictionary;
@interface GSDictionary : NSObject // Help the compiler
@end
@class GSMutableDictionary;
@interface GSMutableDictionary : NSObject // Help the compiler
@end
extern void GSPropertyListMake(id,NSDictionary*,BOOL,BOOL,unsigned,id*);
static Class NSArray_class;
static Class NSDictionaryClass;
static Class NSMutableDictionaryClass;
static Class GSDictionaryClass;
static Class GSMutableDictionaryClass;
static SEL eqSel;
static SEL nxtSel;
static SEL objSel;
static SEL remSel;
static SEL setSel;
static SEL appSel;
/**
* <p>This class and its subclasses store key-value pairs, where the key and
* the value are objects. A great many utility methods for working with
* dictionaries are provided as part of this class, including the ability to
* retrieve multiple entries simultaneously, obtain sorted contents, and
* read/write from/to a serialized representation.</p>
*
* <p>The keys are copied and values are retained by the implementation,
* and both are released when either their entry is dropped or the entire
* dictionary is deallocated.<br />
* As in the OS X implementation, keys must therefore implement the
* [(NSCopying)] protocol.
* </p>
*
* <p>Objects of this class are immutable. For a mutable version, use the
* [NSMutableDictionary] subclass.</p>
*
* <p>The basic functionality in <code>NSDictionary</code> is similar to that
* in Java's <code>HashMap</code>, and like that class it includes no locking
* code and is not thread-safe. If the contents will be modified and
* accessed from multiple threads you should enclose critical operations
* within locks (see [NSLock]).</p>
*/
@implementation NSDictionary
+ (void) initialize
{
if (self == [NSDictionary class])
{
eqSel = @selector(isEqual:);
nxtSel = @selector(nextObject);
objSel = @selector(objectForKey:);
remSel = @selector(removeObjectForKey:);
setSel = @selector(setObject:forKey:);
appSel = @selector(appendString:);
NSArray_class = [NSArray class];
NSDictionaryClass = self;
GSDictionaryClass = [GSDictionary class];
[NSMutableDictionary class];
}
}
+ (id) allocWithZone: (NSZone*)z
{
if (self == NSDictionaryClass)
{
return NSAllocateObject(GSDictionaryClass, 0, z);
}
else
{
return NSAllocateObject(self, 0, z);
}
}
/**
* Returns a new copy of the receiver.<br />
* The default abstract implementation of a copy is to use the
* -initWithDictionary:copyItems: method with the flag set to YES.<br />
* Immutable subclasses generally simply retain and return the receiver.
*/
- (id) copyWithZone: (NSZone*)z
{
NSDictionary *copy = [NSDictionaryClass allocWithZone: z];
return [copy initWithDictionary: self copyItems: NO];
}
/**
* Returns an unsigned integer which is the number of elements
* stored in the dictionary.
*/
- (NSUInteger) count
{
[self subclassResponsibility: _cmd];
return 0;
}
- (void) enumerateKeysAndObjectsUsingBlock:
(GSKeysAndObjectsEnumeratorBlock)aBlock
{
[self enumerateKeysAndObjectsWithOptions: 0
usingBlock: aBlock];
}
- (void) enumerateKeysAndObjectsWithOptions: (NSEnumerationOptions)opts
usingBlock: (GSKeysAndObjectsEnumeratorBlock)aBlock
{
/*
* NOTE: According to the Cocoa documentation, NSEnumerationReverse is
* undefined for NSDictionary. NSEnumerationConcurrent will be handled through
* the GS_DISPATCH_* macros if libdispatch is available.
*/
id<NSFastEnumeration> enumerator = [self keyEnumerator];
SEL objectForKeySelector = @selector(objectForKey:);
IMP objectForKey = [self methodForSelector: objectForKeySelector];
BLOCK_SCOPE BOOL shouldStop = NO;
id obj;
GS_DISPATCH_CREATE_QUEUE_AND_GROUP_FOR_ENUMERATION(enumQueue, opts)
FOR_IN(id, key, enumerator)
obj = (*objectForKey)(self, objectForKeySelector, key);
GS_DISPATCH_SUBMIT_BLOCK(enumQueueGroup, enumQueue,
if (shouldStop == NO) {, }, aBlock, key, obj, &shouldStop);
if (YES == shouldStop)
{
break;
}
END_FOR_IN(enumerator)
GS_DISPATCH_TEARDOWN_QUEUE_AND_GROUP_FOR_ENUMERATION(enumQueue, opts)
}
/**
* <p>In MacOS-X class clusters do not have designated initialisers,
* and there is a general rule that -init is treated as the designated
* initialiser of the class cluster, but that other intitialisers
* may not work s expected an would need to be individually overridden
* in any subclass.
* </p>
* <p>GNUstep tries to make it easier to subclass a class cluster,
* by making class clusters follow the same convention as normal
* classes, so the designated initialiser is the <em>richest</em>
* initialiser. This means that all other initialisers call the
* documented designated initialiser (which calls -init only for
* MacOS-X compatibility), and anyone writing a subclass only needs
* to override that one initialiser in order to have all the other
* ones work.
* </p>
* <p>For MacOS-X compatibility, you may also need to override various
* other initialisers. Exactly which ones, you will need to determine
* by trial on a MacOS-X system ... and may vary between releases of
* MacOS-X. So to be safe, on MacOS-X you probably need to re-implement
* <em>all</em> the class cluster initialisers you might use in conjunction
* with your subclass.
* </p>
*/
- (id) init
{
self = [super init];
return self;
}
/** <init /> <override-subclass />
* Initializes contents to the given objects and keys.
* The two arrays must have the same size.
* The n th element of the objects array is associated with the n th
* element of the keys array.<br />
* Calls -init (which does nothing but maintain MacOS-X compatibility),
* and needs to be re-implemented in subclasses in order to have all
* other initialisers work.
*/
- (id) initWithObjects: (const id[])objects
forKeys: (const id <NSCopying>[])keys
count: (NSUInteger)count
{
self = [self init];
return self;
}
/**
* Return an enumerator object containing all the keys of the dictionary.
*/
- (NSEnumerator*) keyEnumerator
{
return [self subclassResponsibility: _cmd];
}
/**
* Returns the object in the dictionary corresponding to aKey, or nil if
* the key is not present.
*/
- (id) objectForKey: (id)aKey
{
return [self subclassResponsibility: _cmd];
}
- (id) objectForKeyedSubscript: (id)aKey
{
return [self objectForKey: aKey];
}
/**
* Return an enumerator object containing all the objects of the dictionary.
*/
- (NSEnumerator*) objectEnumerator
{
return [self subclassResponsibility: _cmd];
}
/**
* Returns a new instance containing the same objects as
* the receiver.<br />
* The default implementation does this by calling the
* -initWithDictionary:copyItems: method on a newly created object,
* and passing it NO to tell it just to retain the items.
*/
- (id) mutableCopyWithZone: (NSZone*)z
{
NSMutableDictionary *copy = [NSMutableDictionaryClass allocWithZone: z];
return [copy initWithDictionary: self copyItems: NO];
}
- (Class) classForCoder
{
return NSDictionaryClass;
}
- (void) encodeWithCoder: (NSCoder*)aCoder
{
unsigned count = [self count];
if ([aCoder allowsKeyedCoding])
{
id key;
unsigned i;
if ([aCoder class] == [NSKeyedArchiver class])
{
NSArray *keys = [self allKeys];
id objects = [NSMutableArray arrayWithCapacity: count];
for (i = 0; i < count; i++)
{
key = [keys objectAtIndex: i];
[objects addObject: [self objectForKey: key]];
}
[(NSKeyedArchiver*)aCoder _encodeArrayOfObjects: keys
forKey: @"NS.keys"];
[(NSKeyedArchiver*)aCoder _encodeArrayOfObjects: objects
forKey: @"NS.objects"];
}
else if (count > 0)
{
NSEnumerator *enumerator = [self keyEnumerator];
i = 0;
while ((key = [enumerator nextObject]) != nil)
{
NSString *s;
s = [NSString stringWithFormat: @"NS.key.%u", i];
[aCoder encodeObject: key forKey: s];
s = [NSString stringWithFormat: @"NS.object.%u", i];
[aCoder encodeObject: [self objectForKey: key] forKey: s];
i++;
}
}
}
else
{
[aCoder encodeValueOfObjCType: @encode(unsigned) at: &count];
if (count > 0)
{
NSEnumerator *enumerator = [self keyEnumerator];
id key;
IMP enc;
IMP nxt;
IMP ofk;
nxt = [enumerator methodForSelector: @selector(nextObject)];
enc = [aCoder methodForSelector: @selector(encodeObject:)];
ofk = [self methodForSelector: @selector(objectForKey:)];
while ((key = (*nxt)(enumerator, @selector(nextObject))) != nil)
{
id val = (*ofk)(self, @selector(objectForKey:), key);
(*enc)(aCoder, @selector(encodeObject:), key);
(*enc)(aCoder, @selector(encodeObject:), val);
}
}
}
}
- (id) initWithCoder: (NSCoder*)aCoder
{
if ([aCoder allowsKeyedCoding])
{
id keys = nil;
id objects = nil;
if ([aCoder containsValueForKey: @"NS.keys"])
{
keys = [(NSKeyedUnarchiver*)aCoder _decodeArrayOfObjectsForKey:
@"NS.keys"];
objects = [(NSKeyedUnarchiver*)aCoder _decodeArrayOfObjectsForKey:
@"NS.objects"];
}
else if ([aCoder containsValueForKey: @"dict.sortedKeys"])
{
keys = [aCoder decodeObjectForKey: @"dict.sortedKeys"];
objects = [aCoder decodeObjectForKey: @"dict.values"];
}
if (keys == nil)
{
unsigned i = 0;
NSString *key;
id val;
keys = [NSMutableArray arrayWithCapacity: 2];
objects = [NSMutableArray arrayWithCapacity: 2];
key = [NSString stringWithFormat: @"NS.object.%u", i];
val = [(NSKeyedUnarchiver*)aCoder decodeObjectForKey: key];
while (val != nil)
{
[objects addObject: val];
key = [NSString stringWithFormat: @"NS.key.%u", i];
val = [(NSKeyedUnarchiver*)aCoder decodeObjectForKey: key];
[keys addObject: val];
i++;
key = [NSString stringWithFormat: @"NS.object.%u", i];
val = [(NSKeyedUnarchiver*)aCoder decodeObjectForKey: key];
}
}
self = [self initWithObjects: objects forKeys: keys];
}
else
{
unsigned count;
[aCoder decodeValueOfObjCType: @encode(unsigned) at: &count];
if (count > 0)
{
id *keys = NSZoneMalloc(NSDefaultMallocZone(), sizeof(id)*count);
id *vals = NSZoneMalloc(NSDefaultMallocZone(), sizeof(id)*count);
unsigned i;
IMP dec;
dec = [aCoder methodForSelector: @selector(decodeObject)];
for (i = 0; i < count; i++)
{
keys[i] = (*dec)(aCoder, @selector(decodeObject));
vals[i] = (*dec)(aCoder, @selector(decodeObject));
}
self = [self initWithObjects: vals forKeys: keys count: count];
NSZoneFree(NSDefaultMallocZone(), keys);
NSZoneFree(NSDefaultMallocZone(), vals);
}
}
return self;
}
/**
* Returns a new autoreleased empty dictionary.
*/
+ (id) dictionary
{
return AUTORELEASE([[self allocWithZone: NSDefaultMallocZone()] init]);
}
/**
* Returns a newly created dictionary with the keys and objects
* of otherDictionary.
* (The keys and objects are not copied.)
*/
+ (id) dictionaryWithDictionary: (NSDictionary*)otherDictionary
{
return AUTORELEASE([[self allocWithZone: NSDefaultMallocZone()]
initWithDictionary: otherDictionary]);
}
/**
* Returns a dictionary created using the given objects and keys.
* The two arrays must have the same size.
* The n th element of the objects array is associated with the n th
* element of the keys array.
*/
+ (id) dictionaryWithObjects: (const id[])objects
forKeys: (const id <NSCopying>[])keys
count: (NSUInteger)count
{
return AUTORELEASE([[self allocWithZone: NSDefaultMallocZone()]
initWithObjects: objects forKeys: keys count: count]);
}
- (NSUInteger) hash
{
return [self count];
}
/**
* Initialises a dictionary created using the given objects and keys.
* The two arrays must have the same size.
* The n th element of the objects array is associated with the n th
* element of the keys array.
*/
- (id) initWithObjects: (NSArray*)objects forKeys: (NSArray*)keys
{
unsigned objectCount = [objects count];
if (objectCount != [keys count])
{
[NSException raise: NSInvalidArgumentException
format: @"init with obj and key arrays of different sizes"];
}
else
{
GS_BEGINIDBUF(o, objectCount*2);
if ([objects isProxy])
{
unsigned i;
for (i = 0; i < objectCount; i++)
{
o[i] = [objects objectAtIndex: i];
}
}
else
{
[objects getObjects: o];
}
if ([keys isProxy])
{
unsigned i;
for (i = 0; i < objectCount; i++)
{
o[objectCount + i] = [keys objectAtIndex: i];
}
}
else
{
[keys getObjects: o + objectCount];
}
self = [self initWithObjects: o
forKeys: o + objectCount
count: objectCount];
GS_ENDIDBUF();
}
return self;
}
/**
* Initialises a dictionary created using the list given as argument.
* The list is alternately composed of objects and keys and
* terminated by nil. Thus, the list's length must be even,
* followed by nil.
*/
- (id) initWithObjectsAndKeys: (id)firstObject, ...
{
GS_USEIDPAIRLIST(firstObject,
self = [self initWithObjects: __objects forKeys: __pairs count: __count/2]);
return self;
}
/**
* Returns a dictionary created using the list given as argument.
* The list is alternately composed of objects and keys and
* terminated by nil. Thus, the list's length must be even,
* followed by nil.
*/
+ (id) dictionaryWithObjectsAndKeys: (id)firstObject, ...
{
id o = [self allocWithZone: NSDefaultMallocZone()];
GS_USEIDPAIRLIST(firstObject,
o = [o initWithObjects: __objects forKeys: __pairs count: __count/2]);
return AUTORELEASE(o);
}
/**
* Returns a dictionary created using the given objects and keys.
* The two arrays must have the same length.
* The n th element of the objects array is associated with the n th
* element of the keys array.
*/
+ (id) dictionaryWithObjects: (NSArray*)objects forKeys: (NSArray*)keys
{
return AUTORELEASE([[self allocWithZone: NSDefaultMallocZone()]
initWithObjects: objects forKeys: keys]);
}
/**
* Returns a dictionary containing only one object which is associated
* with a key.
*/
+ (id) dictionaryWithObject: (id)object forKey: (id)key
{
return AUTORELEASE([[self allocWithZone: NSDefaultMallocZone()]
initWithObjects: &object forKeys: &key count: 1]);
}
/**
* Initializes with the keys and objects of otherDictionary.
* (The keys and objects are not copied.)
*/
- (id) initWithDictionary: (NSDictionary*)otherDictionary
{
return [self initWithDictionary: otherDictionary copyItems: NO];
}
/**
* Initialise dictionary with the keys and values of otherDictionary.
* If the shouldCopy flag is YES then the values are copied into the
* newly initialised dictionary, otherwise they are simply retained,
* on the assumption that it is safe to retain the keys from another
* dictionary since that other dictionary mwill have copied the keys
* originally to ensure that they are immutable.
*/
- (id) initWithDictionary: (NSDictionary*)other
copyItems: (BOOL)shouldCopy
{
unsigned c = [other count];
if (c > 0)
{
id k;
NSEnumerator *e = [other keyEnumerator];
unsigned i = 0;
IMP nxtObj = [e methodForSelector: nxtSel];
IMP otherObj = [other methodForSelector: objSel];
GS_BEGINIDBUF(o, c*2);
if (shouldCopy)
{
NSZone *z = [self zone];
while ((k = (*nxtObj)(e, nxtSel)) != nil)
{
o[i] = k;
o[c + i] = [(*otherObj)(other, objSel, k) copyWithZone: z];
i++;
}
self = [self initWithObjects: o + c forKeys: o count: i];
while (i-- > 0)
{
[o[c + i] release];
}
}
else
{
while ((k = (*nxtObj)(e, nxtSel)) != nil)
{
o[i] = k;
o[c + i] = (*otherObj)(other, objSel, k);
i++;
}
self = [self initWithObjects: o + c forKeys: o count: c];
}
GS_ENDIDBUF();
}
return self;
}
/**
* <p>Initialises the dictionary with the contents of the specified file,
* which must contain a dictionary in property-list format.
* </p>
* <p>In GNUstep, the property-list format may be either the OpenStep
* format (ASCII data), or the MacOS-X format (UTF-8 XML data) ... this
* method will recognise which it is.
* </p>
* <p>If there is a failure to load the file for any reason, the receiver
* will be released and the method will return nil.
* </p>
* <p>Works by invoking [NSString-initWithContentsOfFile:] and
* [NSString-propertyList] then checking that the result is a dictionary.
* </p>
*/
- (id) initWithContentsOfFile: (NSString*)path
{
NSString *myString;
myString = [[NSString allocWithZone: NSDefaultMallocZone()]
initWithContentsOfFile: path];
if (myString == nil)
{
DESTROY(self);
}
else
{
id result;
NS_DURING
{
result = [myString propertyList];
}
NS_HANDLER
{
result = nil;
}
NS_ENDHANDLER
RELEASE(myString);
if ([result isKindOfClass: NSDictionaryClass])
{
self = [self initWithDictionary: result];
}
else
{
NSWarnMLog(@"Contents of file '%@' does not contain a dictionary",
path);
DESTROY(self);
}
}
return self;
}
/**
* <p>Initialises the dictionary with the contents of the specified URL,
* which must contain a dictionary in property-list format.
* </p>
* <p>In GNUstep, the property-list format may be either the OpenStep
* format (ASCII data), or the MacOS-X format (UTF-8 XML data) ... this
* method will recognise which it is.
* </p>
* <p>If there is a failure to load the URL for any reason, the receiver
* will be released and the method will return nil.
* </p>
* <p>Works by invoking [NSString-initWithContentsOfURL:] and
* [NSString-propertyList] then checking that the result is a dictionary.
* </p>
*/
- (id) initWithContentsOfURL: (NSURL*)aURL
{
NSString *myString;
myString = [[NSString allocWithZone: NSDefaultMallocZone()]
initWithContentsOfURL: aURL];
if (myString == nil)
{
DESTROY(self);
}
else
{
id result;
NS_DURING
{
result = [myString propertyList];
}
NS_HANDLER
{
result = nil;
}
NS_ENDHANDLER
RELEASE(myString);
if ([result isKindOfClass: NSDictionaryClass])
{
self = [self initWithDictionary: result];
}
else
{
NSWarnMLog(@"Contents of URL '%@' does not contain a dictionary",
aURL);
DESTROY(self);
}
}
return self;
}
/**
* Returns a dictionary using the file located at path.
* The file must be a property list containing a dictionary as its root object.
*/
+ (id) dictionaryWithContentsOfFile: (NSString*)path
{
return AUTORELEASE([[self allocWithZone: NSDefaultMallocZone()]
initWithContentsOfFile: path]);
}
/**
* Returns a dictionary using the contents of aURL.
* The URL must be a property list containing a dictionary as its root object.
*/
+ (id) dictionaryWithContentsOfURL: (NSURL*)aURL
{
return AUTORELEASE([[self allocWithZone: NSDefaultMallocZone()]
initWithContentsOfURL: aURL]);
}
- (BOOL) isEqual: other
{
if (other == self)
return YES;
if ([other isKindOfClass: NSDictionaryClass])
return [self isEqualToDictionary: other];
return NO;
}
/**
* Two dictionaries are equal if they each hold the same number of
* entries, each key in one <code>isEqual</code> to a key in the other,
* and, for a given key, the corresponding value objects also satisfy
* <code>isEqual</code>.
*/
- (BOOL) isEqualToDictionary: (NSDictionary*)other
{
unsigned count;
if (other == self)
{
return YES;
}
count = [self count];
if (count == [other count])
{
if (count > 0)
{
NSEnumerator *e = [self keyEnumerator];
IMP nxtObj = [e methodForSelector: nxtSel];
IMP myObj = [self methodForSelector: objSel];
IMP otherObj = [other methodForSelector: objSel];
id k;
while ((k = (*nxtObj)(e, @selector(nextObject))) != nil)
{
id o1 = (*myObj)(self, objSel, k);
id o2 = (*otherObj)(other, objSel, k);
if (o1 == o2)
continue;
if ([o1 isEqual: o2] == NO)
return NO;
}
}
return YES;
}
return NO;
}
/**
* Returns an array containing all the dictionary's keys.
*/
- (NSArray*) allKeys
{
unsigned c = [self count];
if (c == 0)
{
return [NSArray_class array];
}
else
{
NSEnumerator *e = [self keyEnumerator];
IMP nxtObj = [e methodForSelector: nxtSel];
unsigned i;
id result;
GS_BEGINIDBUF(k, c);
for (i = 0; i < c; i++)
{
k[i] = (*nxtObj)(e, nxtSel);
NSAssert (k[i], NSInternalInconsistencyException);
}
result = [[NSArray_class allocWithZone: NSDefaultMallocZone()]
initWithObjects: k count: c];
GS_ENDIDBUF();
return AUTORELEASE(result);
}
}
/**
* Returns an array containing all the dictionary's objects.
*/
- (NSArray*) allValues
{
unsigned c = [self count];
if (c == 0)
{
return [NSArray_class array];
}
else
{
NSEnumerator *e = [self objectEnumerator];
IMP nxtObj = [e methodForSelector: nxtSel];
id result;
unsigned i;
GS_BEGINIDBUF(k, c);
for (i = 0; i < c; i++)
{
k[i] = (*nxtObj)(e, nxtSel);
}
result = [[NSArray_class allocWithZone: NSDefaultMallocZone()]
initWithObjects: k count: c];
GS_ENDIDBUF();
return AUTORELEASE(result);
}
}
- (void) getObjects: (__unsafe_unretained id[])objects
andKeys: (__unsafe_unretained id<NSCopying>[])keys
{
NSUInteger i = 0;
FOR_IN(id, key, self)
if (keys != NULL) keys[i] = key;
if (objects != NULL) objects[i] = [self objectForKey: key];
i++;
END_FOR_IN(self)
}
/**
* Returns an array containing all the dictionary's keys that are
* associated with anObject.
*/
- (NSArray*) allKeysForObject: (id)anObject
{
unsigned c;
if (anObject == nil || (c = [self count]) == 0)
{
return nil;
}
else
{
NSEnumerator *e = [self keyEnumerator];
IMP nxtObj = [e methodForSelector: nxtSel];
IMP myObj = [self methodForSelector: objSel];
BOOL (*eqObj)(id, SEL, id);
id k;
id result;
GS_BEGINIDBUF(a, [self count]);
eqObj = (BOOL (*)(id, SEL, id))[anObject methodForSelector: eqSel];
c = 0;
while ((k = (*nxtObj)(e, nxtSel)) != nil)
{
id o = (*myObj)(self, objSel, k);
if (o == anObject || (*eqObj)(anObject, eqSel, o))
{
a[c++] = k;
}
}
if (c == 0)
{
result = nil;
}
else
{
result = [[NSArray_class allocWithZone: NSDefaultMallocZone()]
initWithObjects: a count: c];
}
GS_ENDIDBUF();
return AUTORELEASE(result);
}
}
struct foo { NSDictionary *d; SEL s; IMP i; };
static NSInteger
compareIt(id o1, id o2, void* context)
{
struct foo *f = (struct foo*)context;
o1 = (*f->i)(f->d, @selector(objectForKey:), o1);
o2 = (*f->i)(f->d, @selector(objectForKey:), o2);
return (NSInteger)(intptr_t)[o1 performSelector: f->s withObject: o2];
}
/**
* Returns ordered array of the keys sorted according to the values they
* correspond to. To sort the values, a message with selector comp is
* send to each value with another value as argument, as in
* <code>[a comp: b]</code>. The comp method should return
* <code>NSOrderedSame</code>, <code>NSOrderedAscending</code>, or
* <code>NSOrderedDescending</code> as appropriate.
*/
- (NSArray*) keysSortedByValueUsingSelector: (SEL)comp
{
struct foo info;
id k;
info.d = self;
info.s = comp;
info.i = [self methodForSelector: objSel];
k = [[self allKeys] sortedArrayUsingFunction: compareIt context: &info];
return k;
}
- (NSArray *) keysSortedByValueUsingComparator: (NSComparator)cmptr
{
return [self keysSortedByValueWithOptions: 0
usingComparator: cmptr];
}
- (NSArray *) keysSortedByValueWithOptions: (NSSortOptions)opts
usingComparator: (NSComparator)cmptr
{
NSArray *sortedValues;
NSArray *noDuplicates;
NSMutableArray *result;
ENTER_POOL
sortedValues = [[self allValues] sortedArrayWithOptions: opts
usingComparator: cmptr];
noDuplicates = [[NSOrderedSet orderedSetWithArray: sortedValues] array];
result = [[NSMutableArray alloc] initWithCapacity: [sortedValues count]];
FOR_IN(NSObject*, value, noDuplicates)
[result addObjectsFromArray: [self allKeysForObject: value]];
END_FOR_IN(noDuplicates)
LEAVE_POOL
return AUTORELEASE(result);
}
/**
* Multiple version of [-objectForKey:]. Objects for each key in keys are
* looked up and placed into return array in same order. For each key that
* has no corresponding value in this dictionary, marker is put into the
* array in its place.
*/
- (NSArray*) objectsForKeys: (NSArray*)keys notFoundMarker: (id)marker
{
unsigned c = [keys count];
if (c == 0)
{
return [NSArray_class array];
}
else
{
unsigned i;
IMP myObj = [self methodForSelector: objSel];
id result;
GS_BEGINIDBUF(obuf, c);
if ([keys isProxy])