[DataFormatter] Add CFDictionary data formatter

[JDevlieghere]

Summary

Add data formatter for NSCFDictionary.

[vsk]

LGTM, thanks!

[davide]

LGTM.

[clayborg]

It might be nice to split up the tests a bit. The data formatter tests have a history of testing 1000 things at once and saying "something failed in the this test with 1000 things". It would be nice if we knew that only dictionaries were failing by testing each type individually. Not required for this test, but try this out by reverting the changes in NSDictionary.cpp so you can see the kind of issue I am talking about.

[JDevlieghere]

• Also test CFDictionaryRef

[jingham]

Yes, I really wish unittest2 allowed non-aborting tests. If you split up all these tests, then you make the testsuite have to build and run some little executable over and over. It would be so nice if there were a way to say:

self.startTestBundle()

self.assertTrue(something)
...
self.assertTrue(something_else)

self.endTestBundle()

where the failures would be held in the test bundle till "endTestBundle", and then all the failures reported.

That would allow us to test a bunch of independent things without having to build & run over and over.

Jim

packages/Python/lldbsuite/test/functionalities/data-formatter/data-formatter-objc/TestDataFormatterObjC.py

def nsdecimalnumber_data_formatter_commands(self):
                     substrs=['(NSDecimalNumber *) decimal_number = ', '123456 x 10^-10',
                              '(NSDecimalNumber *) decimal_neg_number = ', '-123456 x 10^10',
                              '(NSDecimalNumber *) decimal_one = ', '1 x 10^0',
                              '(NSDecimalNumber *) decimal_zero = ', '0',
                              '(NSDecimalNumber *) decimal_nan = ', 'NaN'])
 
     def nscontainers_data_formatter_commands(self):
         self.expect(
-            'frame variable newArray newDictionary newMutableDictionary cfarray_ref mutable_array_ref',
+            'frame variable newArray newDictionary nscfDictionary newMutableDictionary cfarray_ref mutable_array_ref',
             substrs=[
                 '(NSArray *) newArray = ',
                 '@"50 elements"',
                 '(NSDictionary *) newDictionary = ',
                 ' 12 key/value pairs',
                 '(NSDictionary *) newMutableDictionary = ',
                 ' 21 key/value pairs',
+                '(NSCFDictionary *) nscfDictionary = ',
+                ' 2 key/value pairs',
+                '(CFDictionaryRef *) nscfDictionary = ',
+                ' 3 key/value pairs',
                 '(CFArrayRef) cfarray_ref = ',
                 '@"3 elements"',
                 '(CFMutableArrayRef) mutable_array_ref = ',
                 '@"11 elements"'])
 
         self.expect('frame variable iset1 iset2 imset',
                     substrs=['4 indexes', '512 indexes', '10 indexes'])
 

packages/Python/lldbsuite/test/functionalities/data-formatter/data-formatter-objc/main.m

NSString *hebrew = [NSString stringWithString:@"לילה טוב"];
       [newMutableDictionary setObject:@"foo" forKey:@"bar14"];
       [newMutableDictionary setObject:@"foo" forKey:@"bar15"];
       [newMutableDictionary setObject:@"foo" forKey:@"bar16"];
       [newMutableDictionary setObject:@"foo" forKey:@"bar17"];
       [newMutableDictionary setObject:@"foo" forKey:@"bar18"];
       [newMutableDictionary setObject:@"foo" forKey:@"bar19"];
       [newMutableDictionary setObject:@"foo" forKey:@"bar20"];
 
+      id cfKeys[2] = { @"foo", @"bar", @"baz" };
+      id cfValues[2] = { @"foo", @"bar", @"baz" };
+      NSCFDictionary *nscfDictionary = CFBridgingRelease(CFDictionaryCreate(nil, (void *)cfKeys, (void *)cfValues, 2, nil, nil));
+      CFDictionaryRef cfDictionaryRef = CFDictionaryCreate(nil, (void *)cfKeys, (void *)cfValues, 3, nil, nil);
+
       NSAttributedString* attrString = [[NSAttributedString alloc] initWithString:@"hello world from foo" attributes:newDictionary];
       [attrString isEqual:nil];
       NSAttributedString* mutableAttrString = [[NSMutableAttributedString alloc] initWithString:@"hello world from foo" attributes:newDictionary];
       [mutableAttrString isEqual:nil];
 
       NSString* mutableString = [[NSMutableString alloc] initWithString:@"foo"];
       [mutableString insertString:@"foo said this string needs to be very long so much longer than whatever other string has been seen ever before by anyone of the mankind that of course this is still not long enough given what foo our friend foo our lovely dearly friend foo desired of us so i am adding more stuff here for the sake of it and for the joy of our friend who is named guess what just foo. hence, dear friend foo, stay safe, your string is now  long enough to accommodate your testing need and I will make sure that if not we extend it with even more fuzzy random meaningless words pasted one after the other from a long tiresome friday evening spent working in my office. my office mate went home but I am still randomly typing just for the fun of seeing what happens of the length of a Mutable String in Cocoa if it goes beyond one byte.. so be it, dear " atIndex:0];
 

source/Plugins/Language/ObjC/NSDictionary.cpp

bool lldb_private::formatters::NSDictionarySummaryProvider(
   ConstString class_name(descriptor->GetClassName());
 
   static const ConstString g_DictionaryI("__NSDictionaryI");
   static const ConstString g_DictionaryM("__NSDictionaryM");
   static const ConstString g_DictionaryMLegacy("__NSDictionaryM_Legacy");
   static const ConstString g_DictionaryMImmutable("__NSDictionaryM_Immutable");
   static const ConstString g_Dictionary1("__NSSingleEntryDictionaryI");
   static const ConstString g_Dictionary0("__NSDictionary0");
+  static const ConstString g_DictionaryCF("__NSCFDictionary");
 
   if (class_name.IsEmpty())
     return false;
 
   if (class_name == g_DictionaryI || class_name == g_DictionaryMImmutable) {
     Status error;
     value = process_sp->ReadUnsignedIntegerFromMemory(valobj_addr + ptr_size,
                                                       ptr_size, 0, error);
     if (error.Fail())
       return false;
     value &= (is_64bit ? ~0xFC00000000000000UL : ~0xFC000000U);
-  } else if (class_name == g_DictionaryM || class_name == g_DictionaryMLegacy) {
+  } else if (class_name == g_DictionaryM || class_name == g_DictionaryMLegacy ||
+             class_name == g_DictionaryCF) {
     AppleObjCRuntime *apple_runtime =
     llvm::dyn_cast_or_null<AppleObjCRuntime>(runtime);
     Status error;
     if (apple_runtime && apple_runtime->GetFoundationVersion() >= 1437) {
       value = Foundation1437::__NSDictionaryMSize(*process_sp, valobj_addr,
                                                   error);
     } else {
       value = process_sp->ReadUnsignedIntegerFromMemory(valobj_addr + ptr_size,