forked from cellularmitosis/ADC-reference-library-2009-july
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathlisting1.html
More file actions
executable file
·1242 lines (991 loc) · 36.5 KB
/
Copy pathlisting1.html
File metadata and controls
executable file
·1242 lines (991 loc) · 36.5 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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/1999/REC-html401-19991224/loose.dtd">
<html>
<head>
<!-- BEGIN META TAG INFO -->
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<link rel="home" href="http://developer.apple.com/">
<link rel="find" href="http://developer.apple.com/search/">
<link rel="stylesheet" type="text/css" href="../../documentation/css/adcstyle.css" title="fonts">
<script language="JavaScript" src="../../documentation/js/adc.js" type="text/javascript"></script>
<!-- END META TAG INFO -->
<!-- BEGIN TITLE -->
<title>MoreSCF - /MoreCFQ/MoreCFQ.c</title>
<!-- END TITLE -->
<script language="JavaScript">
function JumpToNewPage() {
window.location=document.scpopupmenu.gotop.value;
return true;
}
</script>
</head>
<!-- BEGIN BODY OPEN -->
<body>
<!--END BODY OPEN -->
<!-- START CENTER OPEN -->
<center>
<!-- END CENTER OPEN -->
<!-- BEGIN LOGO AND SEARCH -->
<!--#include virtual="/includes/adcnavbar"-->
<!-- END LOGO AND SEARCH -->
<!-- START BREADCRUMB -->
<div id="breadcrumb">
<table width="680" border="0" cellpadding="0" cellspacing="0">
<tr>
<td scope="row"><img width="340" height="10" src="images/1dot.gif" alt=""></td>
<td><img width="340" height="10" src="images/1dot.gif" alt=""></td>
</tr>
<tr valign="middle">
<td align="left" colspan="2">
<a href="http://developer.apple.com/">ADC Home</a> > <a href="../../referencelibrary/index.html">Reference Library</a> > <a href="../../samplecode/index.html">Sample Code</a> > <a href="../../samplecode/Networking/index.html">Networking</a> > <a href="../../samplecode/Networking/idxDarwin-date.html">Darwin</a> > <A HREF="javascript:location.replace('index.html');">MoreSCF</A> >
</td>
</tr>
<tr>
<td colspan="2" scope="row"><img width="680" height="35" src="images/1dot.gif" alt=""></td>
</tr>
</table>
</div>
<!-- END BREADCRUMB -->
<!-- START MAIN CONTENT -->
<!-- START TITLE GRAPHIC AND INTRO-->
<table width="680" border="0" cellpadding="0" cellspacing="0">
<tr align="left" valign="top">
<td><h1><div id="pagehead">MoreSCF</div></h1></td>
</tr>
</table>
<!-- END TITLE GRAPHIC AND INTRO -->
<!-- START WIDE COLUMN -->
<table width="680" border="0" cellpadding="0" cellspacing="0">
<tr align="left" valign="top">
<td id="scdetails">
<h2>/MoreCFQ/MoreCFQ.c</h2>
<form name="scpopupmenu" onSubmit="return false;" method=post>
<p><strong>View Source Code:</strong>
<select name="gotop" onChange="JumpToNewPage();" style="width:340px"><option selected value="ingnore">Select File</option>
<option value="listing1.html">/MoreCFQ/MoreCFQ.c</option>
<option value="listing2.html">/MoreCFQ/MoreCFQ.h</option>
<option value="listing3.html">/MoreSCF/MoreSCF.c</option>
<option value="listing4.html">/MoreSCF/MoreSCF.h</option>
<option value="listing5.html">/MoreSCF/MoreSCFCCLScanner.c</option>
<option value="listing6.html">/MoreSCF/MoreSCFCCLScanner.h</option>
<option value="listing7.html">/MoreSCF/MoreSCFDigest.c</option>
<option value="listing8.html">/MoreSCF/MoreSCFDigest.h</option>
<option value="listing9.html">/MoreSCF/MoreSCFHelpers.c</option>
<option value="listing10.html">/MoreSCF/MoreSCFHelpers.h</option>
<option value="listing11.html">/MoreSCF/MoreSCFPortScanner.c</option>
<option value="listing12.html">/MoreSCF/MoreSCFPortScanner.h</option>
<option value="listing13.html">/MoreSCF/MoreSCFTest/MoreSCFTest.c</option>
<option value="listing14.html">/MoreSCF/Read Me About MoreSCF.txt</option>
<option value="listing15.html">/Read Me.txt</option></select>
</p>
</form>
<p><strong><a href="MoreSCF.zip">Download Sample</a></strong> (“MoreSCF.zip”, 126.7K)<BR>
<strong><a href="MoreSCF.dmg">Download Sample</a></strong> (“MoreSCF.dmg”, 191.8K)</p>
<!--
<p><strong><a href="#">Download Sample</a></strong> (“filename.sit”, 500K)</p>
-->
</td>
</tr>
<tr>
<td scope="row"><img width="680" height="10" src="images/1dot.gif" alt=""><br>
<img height="1" width="680" src="images/1dot_919699.gif" alt=""><br>
<img width="680" height="20" src="images/1dot.gif" alt=""></td>
</tr>
<tr>
<td scope="row">
<!--googleon: index -->
<pre class="sourcecodebox">/*
File: MoreCFQ.c
Contains: Core Foundation utility Routines.
Written by: DTS
Copyright: Copyright (c) 2007 by Apple Inc., All Rights Reserved.
Disclaimer: IMPORTANT: This Apple software is supplied to you by Apple Inc.
("Apple") in consideration of your agreement to the following terms, and your
use, installation, modification or redistribution of this Apple software
constitutes acceptance of these terms. If you do not agree with these terms,
please do not use, install, modify or redistribute this Apple software.
In consideration of your agreement to abide by the following terms, and subject
to these terms, Apple grants you a personal, non-exclusive license, under Apple's
copyrights in this original Apple software (the "Apple Software"), to use,
reproduce, modify and redistribute the Apple Software, with or without
modifications, in source and/or binary forms; provided that if you redistribute
the Apple Software in its entirety and without modifications, you must retain
this notice and the following text and disclaimers in all such redistributions of
the Apple Software. Neither the name, trademarks, service marks or logos of
Apple Inc. may be used to endorse or promote products derived from the
Apple Software without specific prior written permission from Apple. Except as
expressly stated in this notice, no other rights or licenses, express or implied,
are granted by Apple herein, including but not limited to any patent rights that
may be infringed by your derivative works or by other works in which the Apple
Software may be incorporated.
The Apple Software is provided by Apple on an "AS IS" basis. APPLE MAKES NO
WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION THE IMPLIED
WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE, REGARDING THE APPLE SOFTWARE OR ITS USE AND OPERATION ALONE OR IN
COMBINATION WITH YOUR PRODUCTS.
IN NO EVENT SHALL APPLE BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION, MODIFICATION AND/OR DISTRIBUTION
OF THE APPLE SOFTWARE, HOWEVER CAUSED AND WHETHER UNDER THEORY OF CONTRACT, TORT
(INCLUDING NEGLIGENCE), STRICT LIABILITY OR OTHERWISE, EVEN IF APPLE HAS BEEN
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Change History (most recent first):
$Log: MoreCFQ.c,v $
Revision 1.17 2006/03/27 15:10:57
Correct sign vs unsigned char warnings.
Revision 1.16 2006/03/27 14:38:14
Eliminate high-bit set characters.
Revision 1.15 2006/03/24 18:37:16
Eliminate TARGET_RT_MAC_CFM guards where they are inappropriate.
Revision 1.14 2006/03/24 15:41:04
Updated copyright.
Revision 1.13 2006/03/24 12:35:44
Eliminate "pascal" keyword.
Revision 1.12 2006/03/24 11:26:44
Eliminated "MoreSetup.h" to make it easier for folks to copy MIB source into their projects.
Revision 1.11 2005/03/17 13:38:26
CFQStringCopyCString was comparing an OSStatus to NULL rather than noErr. Kudos to GCC 4.0 for pointing that out.
Revision 1.10 2005/03/15 12:19:40
The normalisation routines are not available to CFM, because the underlying CFStringNormalize is not available to CFM. Also, rename a few local variables to avoid GCC's "shadows a global declaration" warning.
Revision 1.9 2005/02/03 09:23:35
Added normalisation and HFSUniStr255 routines.
Revision 1.8 2003/04/14 15:49:05
Add CFQAllocate/Deallocate. Use it to prevent "malloc(0) returns NULL" problems.
Revision 1.7 2003/04/04 15:01:45
Added CFQCreateBundleFromFrameworkName.
Revision 1.6 2003/02/26 20:49:21
The GetValueAtPath APIs are "Get" and not "Copy" APIs, so they don't need *result == NULL as a precondition.
Revision 1.5 2002/12/12 15:22:25
Added CFQDictionaryMerge.
Revision 1.4 2002/11/08 23:08:47
Convert nil to NULL. Added CFQStringCopyCString. Convert MoreAssertQ to assert.
Revision 1.3 2002/10/24 11:46:07
Added CFQError routines.
Revision 1.2 2002/01/22 06:14:19
Change CFQDictionaryAddNumber to CFQDictionarySetNumber.
Revision 1.1 2002/01/16 22:51:31
First checked in.
*/
/////////////////////////////////////////////////////////////////
// Our prototypes
#include "MoreCFQ.h"
// System interfaces
#include <stdlib.h>
/////////////////////////////////////////////////////////////////
#pragma mark ***** Trivial Utilities
extern OSStatus CFQErrorBoolean(Boolean shouldBeTrue)
{
OSStatus err;
err = noErr;
if (!shouldBeTrue) {
err = coreFoundationUnknownErr;
}
return err;
}
extern OSStatus CFQError(const void *shouldBeNotNULL)
{
return CFQErrorBoolean(shouldBeNotNULL != NULL);
}
extern CFTypeRef CFQRetain(CFTypeRef cf)
// See comment in header.
{
if (cf != NULL) {
(void) CFRetain(cf);
}
return cf;
}
extern void CFQRelease(CFTypeRef cf)
// See comment in header.
{
if (cf != NULL) {
CFRelease(cf);
}
}
extern OSStatus CFQAllocate(ByteCount bytesToAllocate, void **blockPtrPtr)
// See comment in header.
{
OSStatus err;
void * blockPtr;
assert( ((CFIndex) bytesToAllocate) >= 0 ); // CFIndex is signed
assert( blockPtrPtr != NULL);
assert(*blockPtrPtr == NULL);
// CFAllocatorAllocate always returns NULL if you ask for 0 bytes.
// For my coding style, that's very unhelpful. So if you ask for
// a block of 0 bytes, you actually get a block of 1 bytes.
if (bytesToAllocate == 0) {
bytesToAllocate += 1;
}
// Allocate the memory.
err = noErr;
// NULL is a synonym for kCFAllocatorDefault.
blockPtr = CFAllocatorAllocate(NULL, (CFIndex) bytesToAllocate, 0);
if (blockPtr == NULL) {
err = memFullErr;
}
*blockPtrPtr = blockPtr;
assert( (err == noErr) == (*blockPtrPtr != NULL) );
return err;
}
extern void CFQDeallocate(void *blockPtr)
// See comment in header.
{
// CFAllocatorDeallocate handles blockPtr being NULL.
// NULL is a synonym for kCFAllocatorDefault.
CFAllocatorDeallocate(NULL, blockPtr);
}
extern OSStatus CFQDictionaryCreateMutable(CFMutableDictionaryRef *result)
// See comment in header.
{
OSStatus err;
assert( result != NULL);
assert(*result == NULL);
err = noErr;
*result = CFDictionaryCreateMutable(NULL, 0, &kCFTypeDictionaryKeyCallBacks, &kCFTypeDictionaryValueCallBacks);
if (*result == NULL) {
err = coreFoundationUnknownErr;
}
assert( (err == noErr) == (*result != NULL) );
return err;
}
extern OSStatus CFQArrayCreateMutable(CFMutableArrayRef *result)
// See comment in header.
{
OSStatus err;
assert( result != NULL);
assert(*result == NULL);
err = noErr;
*result = CFArrayCreateMutable(NULL, 0, &kCFTypeArrayCallBacks);
if (*result == NULL) {
err = coreFoundationUnknownErr;
}
assert( (err == noErr) == (*result != NULL) );
return err;
}
extern OSStatus CFQArrayCreateWithDictionaryKeys(CFDictionaryRef dict, CFArrayRef *result)
// See comment in header.
{
OSStatus err;
CFTypeRef * keys;
assert( dict != NULL);
assert( result != NULL);
assert(*result == NULL);
// Allocate a buffer for the keys, get the keys into the buffer, and
// create the array from that buffer.
keys = NULL;
err = CFQAllocate(CFDictionaryGetCount(dict) * sizeof(CFTypeRef), (void **) &keys);
if (err == noErr) {
CFDictionaryGetKeysAndValues(dict, (const void **) keys, NULL);
*result = CFArrayCreate(NULL, keys, CFDictionaryGetCount(dict), &kCFTypeArrayCallBacks);
if (*result == NULL) {
err = coreFoundationUnknownErr;
}
}
// Clean up.
CFQDeallocate(keys);
assert( (err == noErr) == (*result != NULL) );
assert( (*result == NULL) || (CFDictionaryGetCount(dict) == CFArrayGetCount(*result)) );
return err;
}
extern OSStatus CFQArrayCreateWithDictionaryValues(CFDictionaryRef dict, CFArrayRef *result)
// See comment in header.
{
OSStatus err;
CFTypeRef * values;
assert( dict != NULL);
assert( result != NULL);
assert(*result == NULL);
// Allocate a buffer for the values, get the values into the buffer, and
// create the array from that buffer.
values = NULL;
err = CFQAllocate(CFDictionaryGetCount(dict) * sizeof(CFTypeRef), (void **) &values);
if (err == noErr) {
CFDictionaryGetKeysAndValues(dict, NULL, (const void **) values);
*result = CFArrayCreate(NULL, values, CFDictionaryGetCount(dict), &kCFTypeArrayCallBacks);
if (*result == NULL) {
err = coreFoundationUnknownErr;
}
}
// Clean up.
CFQDeallocate(values);
assert( (err == noErr) == (*result != NULL) );
assert( (*result == NULL) || (CFDictionaryGetCount(dict) == CFArrayGetCount(*result)) );
return err;
}
extern OSStatus CFQDictionaryCreateWithArrayOfKeysAndValues(CFArrayRef keys,
CFArrayRef values,
CFDictionaryRef *result)
// See comment in header.
{
OSStatus err;
CFIndex count;
CFTypeRef * keysBuffer;
CFTypeRef * valuesBuffer;
assert(keys != NULL);
assert(values != NULL);
assert( CFArrayGetCount(keys) == CFArrayGetCount(values) );
assert( result != NULL);
assert(*result == NULL);
keysBuffer = NULL;
valuesBuffer = NULL;
// Check that the arrays are of a like size.
err = noErr;
count = CFArrayGetCount(keys);
if ( count != CFArrayGetCount(values) ) {
err = paramErr;
}
// Allocate a buffer for both keys and values.
if (err == noErr) {
err = CFQAllocate(sizeof(CFTypeRef) * count, (void **) &keysBuffer);
}
if (err == noErr) {
err = CFQAllocate(sizeof(CFTypeRef) * count, (void **) &valuesBuffer);
}
// Get the keys and values into their buffers, and create a
// dictionary based on the buffer.
if (err == noErr) {
CFArrayGetValues(keys, CFRangeMake(0, count), keysBuffer);
CFArrayGetValues(values, CFRangeMake(0, count), valuesBuffer);
*result = CFDictionaryCreate(NULL, keysBuffer, valuesBuffer, count, &kCFTypeDictionaryKeyCallBacks, &kCFTypeDictionaryValueCallBacks);
if (*result == NULL) {
err = coreFoundationUnknownErr;
}
}
// Clean up.
CFQDeallocate(keysBuffer);
CFQDeallocate(valuesBuffer);
return err;
}
extern OSStatus CFQDictionarySetNumber(CFMutableDictionaryRef dict, const void *key, long value)
// See comment in header.
{
OSStatus err;
CFNumberRef valueNum;
// Create a CFNumber and add it to the dictionary.
err = noErr;
valueNum = CFNumberCreate(NULL, kCFNumberLongType, &value);
if (valueNum == NULL) {
err = coreFoundationUnknownErr;
}
if (err == noErr) {
CFDictionarySetValue(dict, key, valueNum);
}
CFQRelease(valueNum);
return err;
}
extern OSStatus CFQStringCopyCString(CFStringRef str, CFStringEncoding encoding, char **cStrPtr)
// See comment in header.
{
OSStatus err;
CFIndex cStrLen;
CFRange range;
assert( str != NULL);
assert( cStrPtr != NULL);
assert(*cStrPtr == NULL);
err = noErr;
range = CFRangeMake(0, CFStringGetLength(str));
(void) CFStringGetBytes(str, range, encoding, 0, false, NULL, 0, &cStrLen);
// Can't convert to CFQAllocate because the caller is required
// to free the string using "free", and there's no guarantee that
// CFQAllocate and "free" are compatible (for example, if you're
// compiling CFM and running on Mac OS X, "free" is from an MSL pool
// while CFQAllocate allocates from System framework).
//
// Anyway, this isn't a problem because the size is always at
// least one byte, so malloc won't misbehave.
*cStrPtr = (char *) malloc( ((size_t) cStrLen) + 1);
if (*cStrPtr == NULL) {
err = memFullErr;
}
if (err == noErr) {
// In the debug build, initialise the last byte of the buffer so that
// we can check that CFStringGetBytes doesn't overrun.
#if !defined(NDEBUG)
((UInt8 *)*cStrPtr)[cStrLen] = 0xA5; // option-8, or MacRoman for BULLET
#endif
if ( CFStringGetBytes(str, range, encoding, 0, false, (UInt8 *) *cStrPtr, cStrLen, &cStrLen) != range.length ) {
err = kCFQDataErr;
}
}
if (err == noErr) {
assert( ((const UInt8 *)*cStrPtr)[cStrLen] == 0xA5);
(*cStrPtr)[cStrLen] = 0;
} else {
free(*cStrPtr);
*cStrPtr = NULL;
}
assert( (err == noErr) == (*cStrPtr != NULL) );
return err;
}
extern OSStatus CFQStringNormalize(CFStringRef *strPtr)
// See comment in header.
{
OSStatus err;
CFMutableStringRef tmpStr;
assert( strPtr != NULL);
assert(*strPtr != NULL);
err = noErr;
tmpStr = CFStringCreateMutableCopy(NULL, 0, *strPtr);
if (tmpStr == NULL) {
err = coreFoundationUnknownErr;
} else {
CFStringNormalize(tmpStr, kCFStringNormalizationFormD);
CFRelease(*strPtr);
*strPtr = tmpStr;
}
assert( strPtr != NULL);
assert(*strPtr != NULL);
return err;
}
extern OSStatus CFQCopyLocalisedNormalisedString(
CFStringRef key,
CFStringRef comment,
CFStringRef * resultPtr
)
// See comment in header.
{
#pragma unused(comment)
OSStatus err;
CFStringRef result;
assert(key != NULL);
assert(comment != NULL);
assert(resultPtr != NULL);
assert(*resultPtr == NULL);
result = CFCopyLocalizedString(key, comment);
err = CFQError(result);
if (err == noErr) {
err = CFQStringNormalize(&result);
}
// Clean up.
if (err != noErr) {
CFQRelease(result);
result = NULL;
}
*resultPtr = result;
assert( (err == noErr) == (*resultPtr != NULL) );
return err;
}
extern OSStatus CFQStringCreateWithHFSUniStr255(
const HFSUniStr255 * hfsStr,
CFStringRef * strPtr
)
// See comment in header.
{
OSStatus err;
assert(hfsStr != NULL);
assert( strPtr != NULL);
assert(*strPtr == NULL);
err = noErr;
*strPtr = CFStringCreateWithCharacters(
NULL,
hfsStr->unicode,
hfsStr->length
);
err = CFQError(*strPtr);
assert( (err == noErr) == (*strPtr != NULL) );
return err;
}
extern OSStatus CFQStringGetHFSUniStr255(
CFStringRef str,
HFSUniStr255 * hfsStr
)
// See comment in header.
{
OSStatus err;
CFIndex len;
assert(str != NULL);
assert(hfsStr != NULL);
len = CFStringGetLength(str);
if ( len > 255 ) {
err = bdNamErr;
} else {
err = noErr;
hfsStr->length = (UInt16) len;
CFStringGetCharacters(str, CFRangeMake(0, len), hfsStr->unicode);
}
return err;
}
/////////////////////////////////////////////////////////////////
#pragma mark ***** Bundle Routines
extern OSStatus CFQBundleCreateFromFrameworkName(CFStringRef frameworkName,
CFBundleRef *bundlePtr)
// See comment in header.
{
OSStatus err;
FSRef frameworksFolderRef;
CFURLRef baseURL;
CFURLRef bundleURL;
assert(frameworkName != NULL);
assert( bundlePtr != NULL);
assert(*bundlePtr == NULL);
*bundlePtr = NULL;
baseURL = NULL;
bundleURL = NULL;
// Find the frameworks folder and create a URL for it.
err = FSFindFolder(kOnAppropriateDisk, kFrameworksFolderType, true, &frameworksFolderRef);
if (err == noErr) {
baseURL = CFURLCreateFromFSRef(kCFAllocatorSystemDefault, &frameworksFolderRef);
err = CFQError(baseURL);
}
// Append the name of the framework to the URL.
if (err == noErr) {
bundleURL = CFURLCreateCopyAppendingPathComponent(kCFAllocatorSystemDefault, baseURL, frameworkName, false);
err = CFQError(bundleURL);
}
// Create a bundle based on that URL and load the bundle into memory.
if (err == noErr) {
*bundlePtr = CFBundleCreate(kCFAllocatorSystemDefault, bundleURL);
err = CFQError(*bundlePtr);
}
if (err == noErr) {
err = CFQErrorBoolean( CFBundleLoadExecutable( *bundlePtr ) );
}
// Clean up.
if (err != noErr) {
CFQRelease(*bundlePtr);
*bundlePtr = NULL;
}
CFQRelease(bundleURL);
CFQRelease(baseURL);
assert( (err == noErr) == (*bundlePtr != NULL) );
return err;
}
/////////////////////////////////////////////////////////////////
#pragma mark ***** Dictionary Path Routines
extern OSStatus CFQDictionaryGetValueAtPath(CFDictionaryRef dict,
const void *path[], CFIndex pathElementCount,
const void **result)
// See comment in header.
{
OSStatus err;
CFDictionaryRef parent;
CFIndex thisElement;
const void * child;
assert( dict != NULL);
assert( path != NULL);
assert( pathElementCount > 0 ); // 0 length paths aren't allowed
assert( result != NULL);
// Some subtleties in the following loop.
//
// o It's possible for dictionaries to contain NULL values, so we use
// CFDictionaryGetValueIfPresent to test for the presence of the
// child rather than CFDictionaryGetValue.
//
// o We use CFDictionaryGetValueIfPresent in place of the combination of
// CFDictionaryContainsKey and CFDictionaryGetValue because it does
// both operations in one hit.
//
// o Loop terminates in one of three ways:
// i) a path element isn't found (kCFQKeyNotFoundErr)
// ii) we find the last path element
// iii) we proceed to the next path element but the child we
// found isn't valid (kCFQDataErr)
//
// o There are no releases or retains in this loop because all values are
// got with "Get" operations.
err = noErr;
thisElement = 0;
parent = dict;
while (true) {
if ( ! CFDictionaryGetValueIfPresent(parent, path[thisElement], &child) ) {
err = kCFQKeyNotFoundErr;
break;
}
if (thisElement == (pathElementCount - 1)) {
break;
}
if ( (child == NULL) || (CFGetTypeID(child) != CFDictionaryGetTypeID()) ) {
err = kCFQDataErr;
break;
}
parent = (CFDictionaryRef) child;
thisElement += 1;
}
if (err == noErr) {
*result = child;
}
return err;
}
static OSStatus PathArrayHelper(CFArrayRef path, CFTypeRef **pathElements)
// pathElements is a pointer to an array of CFTypeRefs.
// On return, *pathElements is set to a newly allocated
// array which you must free using "free".
{
OSStatus err;
CFIndex pathElementCount;
assert(path != NULL);
assert(pathElements != NULL);
// We don't assert that *pathElements is NULL because part of
// our semantics is that we always set it to NULL.
pathElementCount = CFArrayGetCount(path);
assert(pathElementCount > 0);
err = noErr;
*pathElements = (CFTypeRef *) malloc(sizeof(CFTypeRef) * pathElementCount); // pathElementCount > 0, so malloc(0) not possible
if (*pathElements == NULL) {
err = memFullErr;
}
if (err == noErr) {
CFArrayGetValues(path, CFRangeMake(0, pathElementCount), *pathElements);
}
assert( (err == noErr) == (*pathElements != NULL) );
return err;
}
extern OSStatus CFQDictionaryGetValueAtPathArray(CFDictionaryRef dict,
CFArrayRef path,
const void **result)
// See comment in header.
{
OSStatus err;
CFTypeRef * pathElements;
assert( dict != NULL);
assert( path != NULL);
assert( result != NULL);
err = PathArrayHelper(path, &pathElements);
if (err == noErr) {
err = CFQDictionaryGetValueAtPath(dict, pathElements, CFArrayGetCount(path), result);
}
if (pathElements != NULL) {
free(pathElements);
}
return err;
}
static OSStatus CFQMutableDictionaryGetParentForPath(CFMutableDictionaryRef dict,
const void *path[], CFIndex pathElementCount,
CFMutableDictionaryRef *result)
{
OSStatus err;
CFIndex thisElement;
CFMutableDictionaryRef parent;
CFDictionaryRef child;
assert( dict != NULL);
assert( path != NULL);
assert( pathElementCount > 0 ); // 0 length paths aren't allowed
assert( result != NULL);
// Some subtleties in the following loop.
//
// o It's possible for dictionaries to contain NULL values, so we use
// CFDictionaryGetValueIfPresent to test for the presence of the
// child rather than CFDictionaryGetValue.
//
// o We use CFDictionaryGetValueIfPresent in place of the combination of
// CFDictionaryContainsKey and CFDictionaryGetValue because it does
// both operations in one hit.
//
// o Loop terminates in one of three ways:
// i) we reach the last path element
// ii) a path element isn't found (kCFQKeyNotFoundErr)
// iii) we proceed to the next path element but the child we
// found isn't valid (kCFQDataErr)
// iv) we get an error when creating a mutable dictionary
//
// o Memory tracking is very tricky. Specifically, we have to be
// very careful with the mutableChild variable. We create this
// each time we progress through a dictionary in the loop. Each
// time we create it we then immediately add it to the parent
// dictionary, thus ensuring a continued reference count after
// we release our reference count.
err = noErr;
thisElement = 0;
parent = dict;
while (true) {
if (thisElement == (pathElementCount - 1)) {
break;
}
if ( ! CFDictionaryGetValueIfPresent(parent, path[thisElement], (const void **) &child) ) {
err = kCFQKeyNotFoundErr;
break;
}
if ( (child == NULL) || (CFGetTypeID(child) != CFDictionaryGetTypeID()) ) {
err = kCFQDataErr;
break;
}
{
CFMutableDictionaryRef mutableChild;
mutableChild = CFDictionaryCreateMutableCopy(NULL, 0, child);
if (mutableChild == NULL) {
err = coreFoundationUnknownErr;
}
if (err == noErr) {
CFDictionarySetValue(parent, path[thisElement], mutableChild);
assert( CFGetRetainCount(mutableChild) >= 2 );
parent = mutableChild;
thisElement += 1;
}
CFQRelease(mutableChild);
}
if (err != noErr) {
break;
}
}
if (err == noErr) {
*result = parent;
}
assert( (err == noErr) == (*result != NULL) );
return err;
}
extern OSStatus CFQDictionarySetValueAtPath(CFMutableDictionaryRef dict,
const void *path[], CFIndex pathElementCount,
const void *value)
// See comment in header.
{
OSStatus err;
CFMutableDictionaryRef parent;
assert( dict != NULL);
assert( path != NULL);
assert( pathElementCount > 0 ); // 0 length paths aren't allowed
err = CFQMutableDictionaryGetParentForPath(dict, path, pathElementCount, &parent);
if (err == noErr) {
CFDictionarySetValue(parent, path[pathElementCount - 1], value);
}
return err;
}
extern OSStatus CFQDictionarySetValueAtPathArray(CFMutableDictionaryRef dict,
CFArrayRef path,
const void *value)
// See comment in header.
{
OSStatus err;
CFTypeRef * pathElements;
assert( dict != NULL);
assert( path != NULL);
err = PathArrayHelper(path, &pathElements);
if (err == noErr) {
err = CFQDictionarySetValueAtPath(dict, pathElements, CFArrayGetCount(path), value);
}
if (pathElements != NULL) {
free(pathElements);
}
return err;
}
extern OSStatus CFQDictionaryRemoveValueAtPath(CFMutableDictionaryRef dict,
const void *path[], CFIndex pathElementCount)
// See comment in header.
{
OSStatus err;
CFMutableDictionaryRef parent;
assert( dict != NULL);
assert( path != NULL);
assert( pathElementCount > 0 ); // 0 length paths aren't allowed
err = CFQMutableDictionaryGetParentForPath(dict, path, pathElementCount, &parent);
if ( ! CFDictionaryContainsKey(parent, path[pathElementCount - 1]) ) {
err = kCFQKeyNotFoundErr;
}
if (err == noErr) {
CFDictionaryRemoveValue(parent, path[pathElementCount - 1]);
}
return err;
}
extern OSStatus CFQDictionaryRemoveValueAtPathArray(CFMutableDictionaryRef dict,
CFArrayRef path)
// See comment in header.
{
OSStatus err;
CFTypeRef * pathElements;
assert( dict != NULL);
assert( path != NULL);
err = PathArrayHelper(path, &pathElements);
if (err == noErr) {
err = CFQDictionaryRemoveValueAtPath(dict, pathElements, CFArrayGetCount(path));
}
if (pathElements != NULL) {
free(pathElements);
}
return err;
}
/////////////////////////////////////////////////////////////////
#pragma mark ***** Property List Traversal Routines
extern void CFQPropertyListDeepApplyFunction(CFPropertyListRef propList,