This is an archive of the discontinued LLVM Phabricator instance.

Differential D35015

[clang-format] Add space between a message field key and the opening bracket in proto messages
ClosedPublic

Authored by krasimir on Jul 5 2017, 8:52 AM.

Details

Reviewers
djasper
Commits
rG47f21ef2af0a: [clang-format] Add space between a message field key and the opening bracket in…
rC307261: [clang-format] Add space between a message field key and the opening bracket in…
rL307261: [clang-format] Add space between a message field key and the opening bracket in…
Summary

This patch updates the formatting of message fields of type a{...} to a {...}
for proto messages.

Diff Detail

Event Timeline

krasimir created this revision.Jul 5 2017, 8:52 AM
Harbormaster completed remote builds in B7963: Diff 105277.Jul 5 2017, 8:52 AM
Herald added a subscriber: klimek. · View Herald TranscriptJul 5 2017, 8:52 AM
djasper accepted this revision.Jul 6 2017, 6:23 AM

Looks good.

This revision is now accepted and ready to land.Jul 6 2017, 6:23 AM
Closed by commit rL307261: [clang-format] Add space between a message field key and the opening bracket in… (authored by krasimir). · Explain WhyJul 6 2017, 6:59 AM
This revision was automatically updated to reflect the committed changes.

Revision Contents

PathSize
lib/
Format/
2 lines
unittests/
Format/
20 lines
73 lines

Diff 105277

lib/Format/TokenAnnotator.cpp

Show First 20 Lines • Show All 2,295 Lines • ▼ Show 20 Lines if (Left.is(tok::kw_operator))
Style.Language == FormatStyle::LK_TextProto) { Style.Language == FormatStyle::LK_TextProto) {
if (Right.is(tok::period) && if (Right.is(tok::period) &&
Left.isOneOf(Keywords.kw_optional, Keywords.kw_required, Left.isOneOf(Keywords.kw_optional, Keywords.kw_required,
Keywords.kw_repeated, Keywords.kw_extend)) Keywords.kw_repeated, Keywords.kw_extend))
return true; return true;
if (Right.is(tok::l_paren) && if (Right.is(tok::l_paren) &&
Left.isOneOf(Keywords.kw_returns, Keywords.kw_option)) Left.isOneOf(Keywords.kw_returns, Keywords.kw_option))
return true; return true;
if (Right.isOneOf(tok::l_brace, tok::less) && Left.is(TT_SelectorName))
return true;
} else if (Style.Language == FormatStyle::LK_JavaScript) { } else if (Style.Language == FormatStyle::LK_JavaScript) {
if (Left.is(TT_JsFatArrow)) if (Left.is(TT_JsFatArrow))
return true; return true;
// for await ( ... // for await ( ...
if (Right.is(tok::l_paren) && Left.is(Keywords.kw_await) && if (Right.is(tok::l_paren) && Left.is(Keywords.kw_await) &&
Left.Previous && Left.Previous->is(tok::kw_for)) Left.Previous && Left.Previous->is(tok::kw_for))
return true; return true;
if (Left.is(Keywords.kw_async) && Right.is(tok::l_paren) && if (Left.is(Keywords.kw_async) && Right.is(tok::l_paren) &&
▲ Show 20 Lines • Show All 523 Lines • Show Last 20 Lines

unittests/Format/FormatTestProto.cpp

Show First 20 Lines • Show All 193 Lines • ▼ Show 20 LinesTEST_F(FormatTestProto, FormatsOptions) {
verifyFormat("option (MyProto.options) = {\n" verifyFormat("option (MyProto.options) = {\n"
" field_a: OK // Comment\n" " field_a: OK // Comment\n"
" field_b: \"OK\"\n" " field_b: \"OK\"\n"
" field_c: \"OK\"\n" " field_c: \"OK\"\n"
" msg_field: {field_d: 123}\n" " msg_field: {field_d: 123}\n"
"};"); "};");
verifyFormat("option (MyProto.options) = {\n" verifyFormat("option (MyProto.options) = {\n"
" field_c: \"OK\"\n" " field_c: \"OK\"\n"
" msg_field{field_d: 123}\n" " msg_field {field_d: 123}\n"
"};"); "};");
verifyFormat("option (MyProto.options) = {\n" verifyFormat("option (MyProto.options) = {\n"
" field_a: OK\n" " field_a: OK\n"
" field_b{field_c: OK}\n" " field_b {field_c: OK}\n"
" field_d: OKOKOK\n" " field_d: OKOKOK\n"
" field_e: OK\n" " field_e: OK\n"
"}"); "}");
// Support syntax with <> instead of {}. // Support syntax with <> instead of {}.
verifyFormat("option (MyProto.options) = {\n" verifyFormat("option (MyProto.options) = {\n"
" field_c: \"OK\",\n" " field_c: \"OK\",\n"
" msg_field: <field_d: 123>\n" " msg_field: <field_d: 123>\n"
"};"); "};");
verifyFormat("option (MyProto.options) = {\n" verifyFormat("option (MyProto.options) = {\n"
" field_a: OK\n" " field_a: OK\n"
" field_b<field_c: OK>\n" " field_b <field_c: OK>\n"
" field_d: OKOKOK\n" " field_d: OKOKOK\n"
" field_e: OK\n" " field_e: OK\n"
"}"); "}");
verifyFormat("option (MyProto.options) = {\n" verifyFormat("option (MyProto.options) = {\n"
" msg_field: <>\n" " msg_field: <>\n"
" field_c: \"OK\",\n" " field_c: \"OK\",\n"
" msg_field: <field_d: 123>\n" " msg_field: <field_d: 123>\n"
Show All 22 Lines verifyFormat("option (MyProto.options) = <\n"
" msg_field: {field_b: OK}\n" " msg_field: {field_b: OK}\n"
" field_g: OK\n" " field_g: OK\n"
" field_g: OK\n" " field_g: OK\n"
" field_g: OK\n" " field_g: OK\n"
">;"); ">;");
verifyFormat("option (MyProto.options) = <\n" verifyFormat("option (MyProto.options) = <\n"
" field_a: \"OK\"\n" " field_a: \"OK\"\n"
" msg_field<\n" " msg_field <\n"
" field_b: OK\n" " field_b: OK\n"
" field_c: OK\n" " field_c: OK\n"
" field_d: OK\n" " field_d: OK\n"
" field_e: OK\n" " field_e: OK\n"
" field_f: OK\n" " field_f: OK\n"
" >\n" " >\n"
" field_g: OK\n" " field_g: OK\n"
">;"); ">;");
verifyFormat("option (MyProto.options) = <\n" verifyFormat("option (MyProto.options) = <\n"
" field_a: \"OK\"\n" " field_a: \"OK\"\n"
" msg_field<\n" " msg_field <\n"
" field_b: OK,\n" " field_b: OK,\n"
" field_c: OK,\n" " field_c: OK,\n"
" field_d: OK,\n" " field_d: OK,\n"
" field_e: OK,\n" " field_e: OK,\n"
" field_f: OK\n" " field_f: OK\n"
" >\n" " >\n"
" field_g: OK\n" " field_g: OK\n"
">;"); ">;");
Show All 19 Lines verifyFormat("option (MyProto.options) = <\n"
" field_e: OK\n" " field_e: OK\n"
" field_f: OK\n" " field_f: OK\n"
" }\n" " }\n"
" field_g: OK\n" " field_g: OK\n"
">;"); ">;");
verifyFormat("option (MyProto.options) = <\n" verifyFormat("option (MyProto.options) = <\n"
" field_a: \"OK\"\n" " field_a: \"OK\"\n"
" msg_field{\n" " msg_field {\n"
" field_b: OK\n" " field_b: OK\n"
" field_c: OK\n" " field_c: OK\n"
" field_d: OK\n" " field_d: OK\n"
" field_e: OK\n" " field_e: OK\n"
" field_f: OK\n" " field_f: OK\n"
" }\n" " }\n"
" field_g: OK\n" " field_g: OK\n"
">;"); ">;");
verifyFormat("option (MyProto.options) = {\n" verifyFormat("option (MyProto.options) = {\n"
" field_a: \"OK\"\n" " field_a: \"OK\"\n"
" msg_field<\n" " msg_field <\n"
" field_b: OK\n" " field_b: OK\n"
" field_c: OK\n" " field_c: OK\n"
" field_d: OK\n" " field_d: OK\n"
" field_e: OK\n" " field_e: OK\n"
" field_f: OK\n" " field_f: OK\n"
" >\n" " >\n"
" field_g: OK\n" " field_g: OK\n"
"};"); "};");
verifyFormat("option (MyProto.options) = {\n" verifyFormat("option (MyProto.options) = {\n"
" field_a: \"OK\"\n" " field_a: \"OK\"\n"
" msg_field: <\n" " msg_field: <\n"
" field_b: OK\n" " field_b: OK\n"
" field_c: OK\n" " field_c: OK\n"
" field_d: OK\n" " field_d: OK\n"
" field_e: OK\n" " field_e: OK\n"
" field_f: OK\n" " field_f: OK\n"
" >\n" " >\n"
" field_g: OK\n" " field_g: OK\n"
"};"); "};");
verifyFormat("option (MyProto.options) = <\n" verifyFormat("option (MyProto.options) = <\n"
" field_a: \"OK\"\n" " field_a: \"OK\"\n"
" msg_field{\n" " msg_field {\n"
" field_b: OK\n" " field_b: OK\n"
" field_c: OK\n" " field_c: OK\n"
" field_d: OK\n" " field_d: OK\n"
" msg_field<\n" " msg_field <\n"
" field_A: 1\n" " field_A: 1\n"
" field_B: 2\n" " field_B: 2\n"
" field_C: 3\n" " field_C: 3\n"
" field_D: 4\n" " field_D: 4\n"
" field_E: 5\n" " field_E: 5\n"
" >\n" " >\n"
" msg_field<field_A: 1 field_B: 2 field_C: 3 field_D: 4>\n" " msg_field <field_A: 1 field_B: 2 field_C: 3 field_D: 4>\n"
" field_e: OK\n" " field_e: OK\n"
" field_f: OK\n" " field_f: OK\n"
" }\n" " }\n"
" field_g: OK\n" " field_g: OK\n"
">;"); ">;");
} }
TEST_F(FormatTestProto, FormatsService) { TEST_F(FormatTestProto, FormatsService) {
Show All 35 Lines

unittests/Format/FormatTestTextProto.cpp

Show First 20 Lines • Show All 55 Lines • ▼ Show 20 LinesTEST_F(FormatTestTextProto, SupportsMessageFields) {
verifyFormat("msg_field: {\n" verifyFormat("msg_field: {\n"
" field_a: 1\n" " field_a: 1\n"
" field_b: OK\n" " field_b: OK\n"
" field_c: \"OK\"\n" " field_c: \"OK\"\n"
" field_d: 123\n" " field_d: 123\n"
" field_e: 23\n" " field_e: 23\n"
"}"); "}");
verifyFormat("msg_field{}"); verifyFormat("msg_field {}");
verifyFormat("msg_field{field_a: A}"); verifyFormat("msg_field {field_a: A}");
verifyFormat("msg_field{field_a: \"OK\" field_b: 123}"); verifyFormat("msg_field {field_a: \"OK\" field_b: 123}");
verifyFormat("msg_field{\n" verifyFormat("msg_field {\n"
" field_a: 1\n" " field_a: 1\n"
" field_b: OK\n" " field_b: OK\n"
" field_c: \"OK\"\n" " field_c: \"OK\"\n"
" field_d: 123\n" " field_d: 123\n"
" field_e: 23.0\n" " field_e: 23.0\n"
" field_f: false\n" " field_f: false\n"
" field_g: 'lala'\n" " field_g: 'lala'\n"
" field_h: 1234.567e-89\n" " field_h: 1234.567e-89\n"
"}"); "}");
verifyFormat("msg_field: {msg_field{field_a: 1}}"); verifyFormat("msg_field: {msg_field {field_a: 1}}");
verifyFormat("id: \"ala.bala\"\n" verifyFormat("id: \"ala.bala\"\n"
"item{type: ITEM_A rank: 1 score: 90.0}\n" "item {type: ITEM_A rank: 1 score: 90.0}\n"
"item{type: ITEM_B rank: 2 score: 70.5}\n" "item {type: ITEM_B rank: 2 score: 70.5}\n"
"item{\n" "item {\n"
" type: ITEM_A\n" " type: ITEM_A\n"
" rank: 3\n" " rank: 3\n"
" score: 20.0\n" " score: 20.0\n"
" description: \"the third item has a description\"\n" " description: \"the third item has a description\"\n"
"}"); "}");
} }
TEST_F(FormatTestTextProto, AvoidsTopLevelBinPacking) { TEST_F(FormatTestTextProto, AvoidsTopLevelBinPacking) {
Show All 13 LinesTEST_F(FormatTestTextProto, AvoidsTopLevelBinPacking) {
verifyFormat("field_a: OK\n" verifyFormat("field_a: OK\n"
"field_b: \"OK\"\n" "field_b: \"OK\"\n"
"field_c: \"OK\"\n" "field_c: \"OK\"\n"
"msg_field: {field_d: 123 field_e: OK}"); "msg_field: {field_d: 123 field_e: OK}");
verifyFormat("a: {\n" verifyFormat("a: {\n"
" field_a: OK\n" " field_a: OK\n"
" field_b{field_c: OK}\n" " field_b {field_c: OK}\n"
" field_d: OKOKOK\n" " field_d: OKOKOK\n"
" field_e: OK\n" " field_e: OK\n"
"}"); "}");
verifyFormat("field_a: OK,\n" verifyFormat("field_a: OK,\n"
"field_b{field_c: OK},\n" "field_b {field_c: OK},\n"
"field_d: OKOKOK,\n" "field_d: OKOKOK,\n"
"field_e: OK"); "field_e: OK");
} }
TEST_F(FormatTestTextProto, AddsNewlinesAfterTrailingComments) { TEST_F(FormatTestTextProto, AddsNewlinesAfterTrailingComments) {
verifyFormat("field_a: OK // Comment\n" verifyFormat("field_a: OK // Comment\n"
"field_b: 1"); "field_b: 1");
verifyFormat("field_a: OK\n" verifyFormat("field_a: OK\n"
"msg_field: {\n" "msg_field: {\n"
" field_b: OK // Comment\n" " field_b: OK // Comment\n"
"}"); "}");
verifyFormat("field_a: OK\n" verifyFormat("field_a: OK\n"
"msg_field{\n" "msg_field {\n"
" field_b: OK // Comment\n" " field_b: OK // Comment\n"
"}"); "}");
} }
TEST_F(FormatTestTextProto, SupportsAngleBracketMessageFields) { TEST_F(FormatTestTextProto, SupportsAngleBracketMessageFields) {
// Single-line tests // Single-line tests
verifyFormat("msg_field<>"); verifyFormat("msg_field <>");
verifyFormat("msg_field: <>"); verifyFormat("msg_field: <>");
verifyFormat("msg_field<field_a: OK>"); verifyFormat("msg_field <field_a: OK>");
verifyFormat("msg_field: <field_a: 123>"); verifyFormat("msg_field: <field_a: 123>");
verifyFormat("msg_field<field_a<>>"); verifyFormat("msg_field <field_a <>>");
verifyFormat("msg_field<field_a<field_b<>>>"); verifyFormat("msg_field <field_a <field_b <>>>");
verifyFormat("msg_field: <field_a<field_b: <>>>"); verifyFormat("msg_field: <field_a <field_b: <>>>");
verifyFormat("msg_field<field_a: OK, field_b: \"OK\">"); verifyFormat("msg_field <field_a: OK, field_b: \"OK\">");
verifyFormat("msg_field<field_a: OK field_b: <>, field_c: OK>"); verifyFormat("msg_field <field_a: OK field_b: <>, field_c: OK>");
verifyFormat("msg_field<field_a{field_b: 1}, field_c: <field_d: 2>>"); verifyFormat("msg_field <field_a {field_b: 1}, field_c: <field_d: 2>>");
verifyFormat("msg_field: <field_a: OK, field_b: \"OK\">"); verifyFormat("msg_field: <field_a: OK, field_b: \"OK\">");
verifyFormat("msg_field: <field_a: OK field_b: <>, field_c: OK>"); verifyFormat("msg_field: <field_a: OK field_b: <>, field_c: OK>");
verifyFormat("msg_field: <field_a{field_b: 1}, field_c: <field_d: 2>>"); verifyFormat("msg_field: <field_a {field_b: 1}, field_c: <field_d: 2>>");
verifyFormat("field_a: \"OK\", msg_field: <field_b: 123>, field_c: {}"); verifyFormat("field_a: \"OK\", msg_field: <field_b: 123>, field_c: {}");
verifyFormat("field_a<field_b: 1>, msg_field: <field_b: 123>, field_c<>"); verifyFormat("field_a <field_b: 1>, msg_field: <field_b: 123>, field_c <>");
verifyFormat("field_a<field_b: 1> msg_field: <field_b: 123> field_c<>"); verifyFormat("field_a <field_b: 1> msg_field: <field_b: 123> field_c <>");
verifyFormat("field<field<field: <>>, field<>> field: <field: 1>"); verifyFormat("field <field <field: <>>, field <>> field: <field: 1>");
// Multiple lines tests // Multiple lines tests
verifyFormat("msg_field<\n" verifyFormat("msg_field <\n"
" field_a: OK\n" " field_a: OK\n"
" field_b: \"OK\"\n" " field_b: \"OK\"\n"
" field_c: 1\n" " field_c: 1\n"
" field_d: 12.5\n" " field_d: 12.5\n"
" field_e: OK\n" " field_e: OK\n"
">"); ">");
verifyFormat("msg_field: <>\n" verifyFormat("msg_field: <>\n"
"field_c: \"OK\",\n" "field_c: \"OK\",\n"
"msg_field: <field_d: 123>\n" "msg_field: <field_d: 123>\n"
"field_e: OK\n" "field_e: OK\n"
"msg_field: <field_d: 12>"); "msg_field: <field_d: 12>");
verifyFormat("field_a: OK,\n" verifyFormat("field_a: OK,\n"
"field_b<field_c: OK>,\n" "field_b <field_c: OK>,\n"
"field_d: <12.5>,\n" "field_d: <12.5>,\n"
"field_e: OK"); "field_e: OK");
verifyFormat("field_a: OK\n" verifyFormat("field_a: OK\n"
"field_b<field_c: OK>\n" "field_b <field_c: OK>\n"
"field_d: <12.5>\n" "field_d: <12.5>\n"
"field_e: OKOKOK"); "field_e: OKOKOK");
verifyFormat("msg_field<\n" verifyFormat("msg_field <\n"
" field_a: OK,\n" " field_a: OK,\n"
" field_b<field_c: OK>,\n" " field_b <field_c: OK>,\n"
" field_d: <12.5>,\n" " field_d: <12.5>,\n"
" field_e: OK\n" " field_e: OK\n"
">"); ">");
verifyFormat("msg_field<\n" verifyFormat("msg_field <\n"
" field_a: <field: OK>,\n" " field_a: <field: OK>,\n"
" field_b<field_c: OK>,\n" " field_b <field_c: OK>,\n"
" field_d: <12.5>,\n" " field_d: <12.5>,\n"
" field_e: OK,\n" " field_e: OK,\n"
">"); ">");
verifyFormat("msg_field: <\n" verifyFormat("msg_field: <\n"
" field_a: \"OK\"\n" " field_a: \"OK\"\n"
" msg_field: {field_b: OK}\n" " msg_field: {field_b: OK}\n"
" field_g: OK\n" " field_g: OK\n"
" field_g: OK\n" " field_g: OK\n"
" field_g: OK\n" " field_g: OK\n"
">"); ">");
verifyFormat("field_a{\n" verifyFormat("field_a {\n"
" field_d: ok\n" " field_d: ok\n"
" field_b: <field_c: 1>\n" " field_b: <field_c: 1>\n"
" field_d: ok\n" " field_d: ok\n"
" field_d: ok\n" " field_d: ok\n"
"}"); "}");
verifyFormat("field_a: {\n" verifyFormat("field_a: {\n"
" field_d: ok\n" " field_d: ok\n"
" field_b: <field_c: 1>\n" " field_b: <field_c: 1>\n"
" field_d: ok\n" " field_d: ok\n"
" field_d: ok\n" " field_d: ok\n"
"}"); "}");
verifyFormat("field_a: <f1: 1, f2: <>>\n" verifyFormat("field_a: <f1: 1, f2: <>>\n"
"field_b<\n" "field_b <\n"
" field_b1: <>\n" " field_b1: <>\n"
" field_b2: ok,\n" " field_b2: ok,\n"
" field_b3: <\n" " field_b3: <\n"
" field_x{} // Comment\n" " field_x {} // Comment\n"
" field_y: {field_z: 1}\n" " field_y: {field_z: 1}\n"
" field_w: ok\n" " field_w: ok\n"
" >\n" " >\n"
" field{\n" " field {\n"
" field_x<> // Comment\n" " field_x <> // Comment\n"
" field_y: <field_z: 1>\n" " field_y: <field_z: 1>\n"
" field_w: ok\n" " field_w: ok\n"
" msg_field: <\n" " msg_field: <\n"
" field: <>\n" " field: <>\n"
" field: <field: 1>\n" " field: <field: 1>\n"
" field: <field: 2>\n" " field: <field: 2>\n"
" field: <field: 3>\n" " field: <field: 3>\n"
" field: <field: 4>\n" " field: <field: 4>\n"
" field: ok\n" " field: ok\n"
" >\n" " >\n"
" }\n" " }\n"
">\n" ">\n"
"field: OK,\n" "field: OK,\n"
"field_c<field<field<>>>"); "field_c <field <field <>>>");
} }
} // end namespace tooling } // end namespace tooling
} // end namespace clang } // end namespace clang