1 //===- unittest/Format/FormatTestProto.cpp --------------------------------===// 2 // 3 // The LLVM Compiler Infrastructure 4 // 5 // This file is distributed under the University of Illinois Open Source 6 // License. See LICENSE.TXT for details. 7 // 8 //===----------------------------------------------------------------------===// 9 10 #include "FormatTestUtils.h" 11 #include "clang/Format/Format.h" 12 #include "llvm/Support/Debug.h" 13 #include "gtest/gtest.h" 14 15 #define DEBUG_TYPE "format-test" 16 17 namespace clang { 18 namespace format { 19 20 class FormatTestTextProto : public ::testing::Test { 21 protected: 22 static std::string format(llvm::StringRef Code, unsigned Offset, 23 unsigned Length, const FormatStyle &Style) { 24 DEBUG(llvm::errs() << "---\n"); 25 DEBUG(llvm::errs() << Code << "\n\n"); 26 std::vector<tooling::Range> Ranges(1, tooling::Range(Offset, Length)); 27 tooling::Replacements Replaces = reformat(Style, Code, Ranges); 28 auto Result = applyAllReplacements(Code, Replaces); 29 EXPECT_TRUE(static_cast<bool>(Result)); 30 DEBUG(llvm::errs() << "\n" << *Result << "\n\n"); 31 return *Result; 32 } 33 34 static std::string format(llvm::StringRef Code, const FormatStyle &Style) { 35 return format(Code, 0, Code.size(), Style); 36 } 37 38 static void verifyFormat(llvm::StringRef Code, const FormatStyle &Style) { 39 EXPECT_EQ(Code.str(), format(test::messUp(Code), Style)); 40 } 41 42 static void verifyFormat(llvm::StringRef Code) { 43 FormatStyle Style = getGoogleStyle(FormatStyle::LK_TextProto); 44 Style.ColumnLimit = 60; // To make writing tests easier. 45 verifyFormat(Code, Style); 46 } 47 }; 48 49 TEST_F(FormatTestTextProto, KeepsTopLevelEntriesFittingALine) { 50 verifyFormat("field_a: OK field_b: OK field_c: OK field_d: OK field_e: OK"); 51 } 52 53 TEST_F(FormatTestTextProto, SupportsMessageFields) { 54 verifyFormat("msg_field: {}"); 55 56 verifyFormat("msg_field: { field_a: A }"); 57 58 verifyFormat("msg_field: { field_a: \"OK\" field_b: 123 }"); 59 60 verifyFormat("msg_field: {\n" 61 " field_a: 1\n" 62 " field_b: OK\n" 63 " field_c: \"OK\"\n" 64 " field_d: 123\n" 65 " field_e: 23\n" 66 "}"); 67 68 verifyFormat("msg_field {}"); 69 70 verifyFormat("msg_field { field_a: A }"); 71 72 verifyFormat("msg_field { field_a: \"OK\" field_b: 123 }"); 73 74 verifyFormat("msg_field {\n" 75 " field_a: 1\n" 76 " field_b: OK\n" 77 " field_c: \"OK\"\n" 78 " field_d: 123\n" 79 " field_e: 23.0\n" 80 " field_f: false\n" 81 " field_g: 'lala'\n" 82 " field_h: 1234.567e-89\n" 83 "}"); 84 85 verifyFormat("msg_field: { msg_field { field_a: 1 } }"); 86 87 verifyFormat("id: \"ala.bala\"\n" 88 "item { type: ITEM_A rank: 1 score: 90.0 }\n" 89 "item { type: ITEM_B rank: 2 score: 70.5 }\n" 90 "item {\n" 91 " type: ITEM_A\n" 92 " rank: 3\n" 93 " score: 20.0\n" 94 " description: \"the third item has a description\"\n" 95 "}"); 96 } 97 98 TEST_F(FormatTestTextProto, AvoidsTopLevelBinPacking) { 99 verifyFormat("field_a: OK\n" 100 "field_b: OK\n" 101 "field_c: OK\n" 102 "field_d: OK\n" 103 "field_e: OK\n" 104 "field_f: OK"); 105 106 verifyFormat("field_a: OK\n" 107 "field_b: \"OK\"\n" 108 "field_c: \"OK\"\n" 109 "msg_field: { field_d: 123 }\n" 110 "field_e: OK\n" 111 "field_f: OK"); 112 113 verifyFormat("field_a: OK\n" 114 "field_b: \"OK\"\n" 115 "field_c: \"OK\"\n" 116 "msg_field: { field_d: 123 field_e: OK }"); 117 118 verifyFormat("a: {\n" 119 " field_a: OK\n" 120 " field_b { field_c: OK }\n" 121 " field_d: OKOKOK\n" 122 " field_e: OK\n" 123 "}"); 124 125 verifyFormat("field_a: OK,\n" 126 "field_b { field_c: OK },\n" 127 "field_d: OKOKOK,\n" 128 "field_e: OK"); 129 } 130 131 TEST_F(FormatTestTextProto, AddsNewlinesAfterTrailingComments) { 132 verifyFormat("field_a: OK // Comment\n" 133 "field_b: 1"); 134 135 verifyFormat("field_a: OK\n" 136 "msg_field: {\n" 137 " field_b: OK // Comment\n" 138 "}"); 139 140 verifyFormat("field_a: OK\n" 141 "msg_field {\n" 142 " field_b: OK // Comment\n" 143 "}"); 144 } 145 146 TEST_F(FormatTestTextProto, ImplicitStringLiteralConcatenation) { 147 verifyFormat("field_a: 'aaaaa'\n" 148 " 'bbbbb'"); 149 verifyFormat("field_a: \"aaaaa\"\n" 150 " \"bbbbb\""); 151 FormatStyle Style = getGoogleStyle(FormatStyle::LK_TextProto); 152 Style.AlwaysBreakBeforeMultilineStrings = true; 153 verifyFormat("field_a:\n" 154 " 'aaaaa'\n" 155 " 'bbbbb'", 156 Style); 157 verifyFormat("field_a:\n" 158 " \"aaaaa\"\n" 159 " \"bbbbb\"", 160 Style); 161 } 162 163 TEST_F(FormatTestTextProto, SupportsAngleBracketMessageFields) { 164 // Single-line tests 165 verifyFormat("msg_field <>"); 166 verifyFormat("msg_field: <>"); 167 verifyFormat("msg_field < field_a: OK >"); 168 verifyFormat("msg_field: < field_a: 123 >"); 169 verifyFormat("msg_field < field_a <> >"); 170 verifyFormat("msg_field < field_a < field_b <> > >"); 171 verifyFormat("msg_field: < field_a < field_b: <> > >"); 172 verifyFormat("msg_field < field_a: OK, field_b: \"OK\" >"); 173 verifyFormat("msg_field < field_a: OK field_b: <>, field_c: OK >"); 174 verifyFormat("msg_field < field_a { field_b: 1 }, field_c: < f_d: 2 > >"); 175 verifyFormat("msg_field: < field_a: OK, field_b: \"OK\" >"); 176 verifyFormat("msg_field: < field_a: OK field_b: <>, field_c: OK >"); 177 verifyFormat("msg_field: < field_a { field_b: 1 }, field_c: < fd_d: 2 > >"); 178 verifyFormat("field_a: \"OK\", msg_field: < field_b: 123 >, field_c: {}"); 179 verifyFormat("field_a < field_b: 1 >, msg_fid: < fiel_b: 123 >, field_c <>"); 180 verifyFormat("field_a < field_b: 1 > msg_fied: < field_b: 123 > field_c <>"); 181 verifyFormat("field < field < field: <> >, field <> > field: < field: 1 >"); 182 183 // Multiple lines tests 184 verifyFormat("msg_field <\n" 185 " field_a: OK\n" 186 " field_b: \"OK\"\n" 187 " field_c: 1\n" 188 " field_d: 12.5\n" 189 " field_e: OK\n" 190 ">"); 191 192 verifyFormat("msg_field: <>\n" 193 "field_c: \"OK\",\n" 194 "msg_field: < field_d: 123 >\n" 195 "field_e: OK\n" 196 "msg_field: < field_d: 12 >"); 197 198 verifyFormat("field_a: OK,\n" 199 "field_b < field_c: OK >,\n" 200 "field_d: < 12.5 >,\n" 201 "field_e: OK"); 202 203 verifyFormat("field_a: OK\n" 204 "field_b < field_c: OK >\n" 205 "field_d: < 12.5 >\n" 206 "field_e: OKOKOK"); 207 208 verifyFormat("msg_field <\n" 209 " field_a: OK,\n" 210 " field_b < field_c: OK >,\n" 211 " field_d: < 12.5 >,\n" 212 " field_e: OK\n" 213 ">"); 214 215 verifyFormat("msg_field <\n" 216 " field_a: < field: OK >,\n" 217 " field_b < field_c: OK >,\n" 218 " field_d: < 12.5 >,\n" 219 " field_e: OK,\n" 220 ">"); 221 222 verifyFormat("msg_field: <\n" 223 " field_a: \"OK\"\n" 224 " msg_field: { field_b: OK }\n" 225 " field_g: OK\n" 226 " field_g: OK\n" 227 " field_g: OK\n" 228 ">"); 229 230 verifyFormat("field_a {\n" 231 " field_d: ok\n" 232 " field_b: < field_c: 1 >\n" 233 " field_d: ok\n" 234 " field_d: ok\n" 235 "}"); 236 237 verifyFormat("field_a: {\n" 238 " field_d: ok\n" 239 " field_b: < field_c: 1 >\n" 240 " field_d: ok\n" 241 " field_d: ok\n" 242 "}"); 243 244 verifyFormat("field_a: < f1: 1, f2: <> >\n" 245 "field_b <\n" 246 " field_b1: <>\n" 247 " field_b2: ok,\n" 248 " field_b3: <\n" 249 " field_x {} // Comment\n" 250 " field_y: { field_z: 1 }\n" 251 " field_w: ok\n" 252 " >\n" 253 " field {\n" 254 " field_x <> // Comment\n" 255 " field_y: < field_z: 1 >\n" 256 " field_w: ok\n" 257 " msg_field: <\n" 258 " field: <>\n" 259 " field: < field: 1 >\n" 260 " field: < field: 2 >\n" 261 " field: < field: 3 >\n" 262 " field: < field: 4 >\n" 263 " field: ok\n" 264 " >\n" 265 " }\n" 266 ">\n" 267 "field: OK,\n" 268 "field_c < field < field <> > >"); 269 270 verifyFormat("app_id: 'com.javax.swing.salsa.latino'\n" 271 "head_id: 1\n" 272 "data < key: value >"); 273 274 verifyFormat("app_id: 'com.javax.swing.salsa.latino'\n" 275 "head_id: 1\n" 276 "data < key: value >\n" 277 "tail_id: 2"); 278 279 verifyFormat("app_id: 'com.javax.swing.salsa.latino'\n" 280 "head_id: 1\n" 281 "data < key: value >\n" 282 "data { key: value }"); 283 284 verifyFormat("app {\n" 285 " app_id: 'com.javax.swing.salsa.latino'\n" 286 " head_id: 1\n" 287 " data < key: value >\n" 288 "}"); 289 290 verifyFormat("app: {\n" 291 " app_id: 'com.javax.swing.salsa.latino'\n" 292 " head_id: 1\n" 293 " data < key: value >\n" 294 "}"); 295 296 verifyFormat("app_id: 'com.javax.swing.salsa.latino'\n" 297 "headheadheadheadheadhead_id: 1\n" 298 "product_data { product { 1 } }"); 299 300 verifyFormat("app_id: 'com.javax.swing.salsa.latino'\n" 301 "headheadheadheadheadhead_id: 1\n" 302 "product_data < product { 1 } >"); 303 304 verifyFormat("app_id: 'com.javax.swing.salsa.latino'\n" 305 "headheadheadheadheadhead_id: 1\n" 306 "product_data < product < 1 > >"); 307 308 verifyFormat("app <\n" 309 " app_id: 'com.javax.swing.salsa.latino'\n" 310 " headheadheadheadheadhead_id: 1\n" 311 " product_data < product { 1 } >\n" 312 ">"); 313 314 verifyFormat("dcccwrnfioeruvginerurneitinfo {\n" 315 " exte3nsionrnfvui { key: value }\n" 316 "}"); 317 } 318 319 TEST_F(FormatTestTextProto, DiscardsUnbreakableTailIfCanBreakAfter) { 320 // The two closing braces count towards the string UnbreakableTailLength, but 321 // since we have broken after the corresponding opening braces, we don't 322 // consider that length for string breaking. 323 verifyFormat( 324 "foo: {\n" 325 " bar: {\n" 326 " text: \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\"\n" 327 " }\n" 328 "}"); 329 } 330 331 TEST_F(FormatTestTextProto, KeepsLongStringLiteralsOnSameLine) { 332 verifyFormat( 333 "foo: {\n" 334 " text: \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaasaaaaaaaaaa\"\n" 335 "}"); 336 } 337 338 TEST_F(FormatTestTextProto, KeepsCommentsIndentedInList) { 339 verifyFormat("aaaaaaaaaa: 100\n" 340 "bbbbbbbbbbbbbbbbbbbbbbbbbbb: 200\n" 341 "# Single line comment for stuff here.\n" 342 "cccccccccccccccccccccccc: 3849\n" 343 "# Multiline comment for stuff here.\n" 344 "# Multiline comment for stuff here.\n" 345 "# Multiline comment for stuff here.\n" 346 "cccccccccccccccccccccccc: 3849"); 347 } 348 349 TEST_F(FormatTestTextProto, FormatsExtensions) { 350 verifyFormat("[type] { key: value }"); 351 verifyFormat("[type] {\n" 352 " keyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyyy: value\n" 353 "}"); 354 verifyFormat("[type.type] { key: value }"); 355 verifyFormat("[type.type] < key: value >"); 356 verifyFormat("[type.type/type.type] { key: value }"); 357 verifyFormat("msg {\n" 358 " [type.type] { key: value }\n" 359 "}"); 360 verifyFormat("msg {\n" 361 " [type.type] {\n" 362 " keyyyyyyyyyyyyyy: valuuuuuuuuuuuuuuuuuuuuuuuuue\n" 363 " }\n" 364 "}"); 365 verifyFormat("key: value\n" 366 "[a.b] { key: value }"); 367 verifyFormat("msg: <\n" 368 " key: value\n" 369 " [a.b.c/d.e]: < key: value >\n" 370 " [f.g]: <\n" 371 " key: valueeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee\n" 372 " key: {}\n" 373 " >\n" 374 " key {}\n" 375 " [h.i.j] < key: value >\n" 376 " [a]: {\n" 377 " [b.c]: {}\n" 378 " [d] <>\n" 379 " [e/f]: 1\n" 380 " }\n" 381 ">"); 382 verifyFormat("[longg.long.long.long.long.long.long.long.long.long.long\n" 383 " .longg.longlong] { key: value }"); 384 verifyFormat("[longg.long.long.long.long.long.long.long.long.long.long\n" 385 " .longg.longlong] {\n" 386 " key: value\n" 387 " key: value\n" 388 " key: value\n" 389 " key: value\n" 390 "}"); 391 verifyFormat("[longg.long.long.long.long.long.long.long.long.long\n" 392 " .long/longg.longlong] { key: value }"); 393 verifyFormat("[aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/\n" 394 " bbbbbbbbbbbbbb] { key: value }"); 395 // These go over the column limit intentionally, since the alternative 396 // [aa..a\n] is worse. 397 verifyFormat("[aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa] {\n" 398 " key: value\n" 399 "}"); 400 verifyFormat("[aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa] {\n" 401 " [type.type] {\n" 402 " keyyyyyyyyyyyyyy: valuuuuuuuuuuuuuuuuuuuuuuuuue\n" 403 " }\n" 404 "}"); 405 verifyFormat("[aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/\n" 406 " bbbbbbb] {\n" 407 " [type.type] {\n" 408 " keyyyyyyyyyyyyyy: valuuuuuuuuuuuuuuuuuuuuuuuuue\n" 409 " }\n" 410 "}"); 411 verifyFormat( 412 "aaaaaaaaaaaaaaa {\n" 413 " bbbbbb {\n" 414 " [a.b/cy] {\n" 415 " eeeeeeeeeeeee: \"The lazy coo cat jumps over the lazy hot dog\"\n" 416 " }\n" 417 " }\n" 418 "}"); 419 } 420 421 TEST_F(FormatTestTextProto, NoSpaceAfterPercent) { 422 verifyFormat("key: %d"); 423 } 424 425 TEST_F(FormatTestTextProto, FormatsRepeatedListInitializers) { 426 verifyFormat("keys: []"); 427 verifyFormat("keys: [ 1 ]"); 428 verifyFormat("keys: [ 'ala', 'bala' ]"); 429 verifyFormat("keys:\n" 430 " [ 'ala', 'bala', 'porto', 'kala', 'too', 'long', 'ng' ]"); 431 verifyFormat("key: item\n" 432 "keys: [\n" 433 " 'ala',\n" 434 " 'bala',\n" 435 " 'porto',\n" 436 " 'kala',\n" 437 " 'too',\n" 438 " 'long',\n" 439 " 'long',\n" 440 " 'long'\n" 441 "]\n" 442 "key: item\n" 443 "msg {\n" 444 " key: item\n" 445 " keys: [\n" 446 " 'ala',\n" 447 " 'bala',\n" 448 " 'porto',\n" 449 " 'kala',\n" 450 " 'too',\n" 451 " 'long',\n" 452 " 'long'\n" 453 " ]\n" 454 "}\n" 455 "key: value" 456 ); 457 FormatStyle Style = getGoogleStyle(FormatStyle::LK_TextProto); 458 Style.ColumnLimit = 60; // To make writing tests easier. 459 Style.Cpp11BracedListStyle = true; 460 verifyFormat("keys: [1]", Style); 461 } 462 463 TEST_F(FormatTestTextProto, AcceptsOperatorAsKey) { 464 verifyFormat("aaaaaaaaaaa: <\n" 465 " bbbbbbbbb: <\n" 466 " ccccccccccccccccccccccc: <\n" 467 " operator: 1\n" 468 " operator: 2\n" 469 " operator { key: value }\n" 470 " >\n" 471 " >\n" 472 ">"); 473 } 474 475 TEST_F(FormatTestTextProto, BreaksConsecutiveStringLiterals) { 476 verifyFormat("ala: \"str1\"\n" 477 " \"str2\"\n"); 478 } 479 480 TEST_F(FormatTestTextProto, PutsMultipleEntriesInExtensionsOnNewlines) { 481 FormatStyle Style = getGoogleStyle(FormatStyle::LK_TextProto); 482 verifyFormat("pppppppppp: {\n" 483 " ssssss: \"http://example.com/blahblahblah\"\n" 484 " ppppppp: \"sssss/MMMMMMMMMMMM\"\n" 485 " [ns.sssss.eeeeeeeee.eeeeeeeeeeeeeee] { begin: 24 end: 252 }\n" 486 " [ns.sssss.eeeeeeeee.eeeeeeeeeeeeeee] {\n" 487 " begin: 24\n" 488 " end: 252\n" 489 " key: value\n" 490 " key: value\n" 491 " }\n" 492 "}", Style); 493 } 494 495 } // end namespace tooling 496 } // end namespace clang 497