[clang-format] Obj-C dictionary literals: Fixed typecast getting put on a separate line from the key

[ksuther]

Summary

Fixes this bug: https://llvm.org/bugs/show_bug.cgi?id=22647

The following dictionary was getting formatted oddly:

NSDictionary *query = @{
    (__bridge id)kSecClass: (__bridge id)kSecClassGenericPassword,
    (__bridge id)kSecReturnData: (__bridge id)kCFBooleanTrue,
};

It was turning into this:

NSDictionary *passwordQuery = @{
  (__bridge id) kSecClass : (__bridge id)kSecClassGenericPassword, (__bridge id)
  kSecReturnData : (__bridge id)kCFBooleanTrue, (__bridge id)
  kSecReturnAttributes : (__bridge id)kCFBooleanTrue,
};

As far as I can tell, changes to format Proto lines correctly was turning the key (e.g. kSecClass) into a TT_SelectorName, which was then force the cast to get separated from the key. I added an extra check to see if the current context is in a dictionary literal, and if so kept the type as TT_Unknown.

[ksuther]

Adding another comment in hopes of getting some visibility on this. Do I need to add other people as reviewers?

[djasper]

lib/Format/TokenAnnotator.cpp

377

Why the language check? If it is needed, can you add a test?

[ksuther]

lib/Format/TokenAnnotator.cpp

377

The language check is so that this only applies to Objective-C literals. Protocol Buffers already have a test suite that tests the conditional here (FormatTestProto.cpp). The reason for the check is that the tree for Objective-C literals and Protocol Buffers looks the same in this situation, but the format behavior needs to differ.

[djasper]

Looks good. Do you have commit access?

lib/Format/TokenAnnotator.cpp

377

Ah, I see, thank you.

[ksuther]

I do not.

[ksuther]

Do I need to do anything else about this and D12489, or do they eventually get committed by someone else? Thanks!

[ksuther]

This patch is still awaiting a commit. Sorry to repeatedly post about this, just don't want it to get lost.

Thanks!

[djasper]

Submitted as r250010.

lib/Format/TokenAnnotator.cpp

         if (CurrentToken->isOneOf(tok::r_paren, tok::r_square))
           return false;
         updateParameterCount(Left, CurrentToken);
         if (CurrentToken->isOneOf(tok::colon, tok::l_brace)) {
           FormatToken *Previous = CurrentToken->getPreviousNonComment();
-          if ((CurrentToken->is(tok::colon) ||
+          if (((CurrentToken->is(tok::colon) &&
+                (!Contexts.back().ColonIsDictLiteral ||
+                 Style.Language != FormatStyle::LK_Cpp)) ||
                Style.Language == FormatStyle::LK_Proto) &&
               Previous->is(tok::identifier))
             Previous->Type = TT_SelectorName;
           if (CurrentToken->is(tok::colon) ||
               Style.Language == FormatStyle::LK_JavaScript)

unittests/Format/FormatTest.cpp

                "    [NSMutableDictionary dictionaryWithDictionary:@{\n"
                "      aaaaaaaaaaaaaaaaaaaaa : aaaaaaaaaaaaa,\n"
                "      bbbbbbbbbbbbbbbbbb : bbbbb,\n"
                "      cccccccccccccccc : ccccccccccccccc\n"
                "    }];");
+
+  // Ensure that casts before the key are kept on the same line as the key
+  verifyFormat("NSDictionary *query = @{\n"
+               "  (__bridge id)kSecClass : (__bridge id)kSecClassGenericPassword,\n"
+               "  (__bridge id)kSecReturnData : (__bridge id)kCFBooleanTrue,\n"
+               "};");
 }
 
 TEST_F(FormatTest, ObjCArrayLiterals) {
   verifyIncompleteFormat("@[");
   verifyFormat("@[]");