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
|
//===- unittest/Format/FormatTestTableGen.cpp -----------------------------===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
#include "FormatTestUtils.h"
#include "clang/Format/Format.h"
#include "llvm/Support/Debug.h"
#include "gtest/gtest.h"
#define DEBUG_TYPE "format-test"
namespace clang {
namespace format {
class FormatTestTableGen : public testing::Test {
protected:
static std::string format(StringRef Code, unsigned Offset, unsigned Length,
const FormatStyle &Style) {
LLVM_DEBUG(llvm::errs() << "---\n");
LLVM_DEBUG(llvm::errs() << Code << "\n\n");
std::vector<tooling::Range> Ranges(1, tooling::Range(Offset, Length));
tooling::Replacements Replaces = reformat(Style, Code, Ranges);
auto Result = applyAllReplacements(Code, Replaces);
EXPECT_TRUE(static_cast<bool>(Result));
LLVM_DEBUG(llvm::errs() << "\n" << *Result << "\n\n");
return *Result;
}
static std::string format(StringRef Code) {
FormatStyle Style = getGoogleStyle(FormatStyle::LK_TableGen);
Style.ColumnLimit = 60; // To make writing tests easier.
return format(Code, 0, Code.size(), Style);
}
static void verifyFormat(StringRef Code) {
EXPECT_EQ(Code.str(), format(Code)) << "Expected code is not stable";
EXPECT_EQ(Code.str(), format(test::messUp(Code)));
}
static void verifyFormat(StringRef Result, StringRef MessedUp) {
EXPECT_EQ(Result, format(MessedUp));
}
static void verifyFormat(StringRef Code, const FormatStyle &Style) {
EXPECT_EQ(Code.str(), format(Code, 0, Code.size(), Style))
<< "Expected code is not stable";
auto MessUp = test::messUp(Code);
EXPECT_EQ(Code.str(), format(MessUp, 0, MessUp.size(), Style));
}
};
TEST_F(FormatTestTableGen, FormatStringBreak) {
verifyFormat("include \"OptParser.td\"\n"
"def flag : Flag<\"--foo\">,\n"
" HelpText<\n"
" \"This is a very, very, very, very, \"\n"
" \"very, very, very, very, very, very, \"\n"
" \"very long help string\">;");
}
TEST_F(FormatTestTableGen, NoSpacesInSquareBracketLists) {
verifyFormat("def flag : Flag<[\"-\", \"--\"], \"foo\">;");
}
TEST_F(FormatTestTableGen, LiteralsAndIdentifiers) {
verifyFormat("def LiteralAndIdentifiers {\n"
" let someInteger = -42;\n"
" let 0startID = $TokVarName;\n"
" let 0xstartInteger = 0x42;\n"
" let someIdentifier = $TokVarName;\n"
"}");
}
TEST_F(FormatTestTableGen, BangOperators) {
verifyFormat("def BangOperators {\n"
" let IfOpe = !if(\n"
" !not(!and(!gt(!add(1, 2), !sub(3, 4)), !isa<Ty>($x))),\n"
" !foldl(0, !listconcat(!range(5, 6), !range(7, 8)),\n"
" total, rec, !add(total, rec.Number)),\n"
" !tail(!range(9, 10)));\n"
" let ForeachOpe = !foreach(\n"
" arg, arglist,\n"
" !if(!isa<SomeType>(arg.Type),\n"
" !add(!cast<SomeOtherType>(arg).Number, x), arg));\n"
" let CondOpe1 = !cond(!eq(size, 1): 1,\n"
" !eq(size, 2): 1,\n"
" !eq(size, 4): 1,\n"
" !eq(size, 8): 1,\n"
" !eq(size, 16): 1,\n"
" true: 0);\n"
" let CondOpe2 = !cond(!lt(x, 0): \"negativenegative\",\n"
" !eq(x, 0): \"zerozero\",\n"
" true: \"positivepositive\");\n"
" let CondOpe2WithComment = !cond(!lt(x, 0): // negative\n"
" \"negativenegative\",\n"
" !eq(x, 0): // zero\n"
" \"zerozero\",\n"
" true: // default\n"
" \"positivepositive\");\n"
"}");
}
TEST_F(FormatTestTableGen, Include) {
verifyFormat("include \"test/IncludeFile.h\"");
}
TEST_F(FormatTestTableGen, Types) {
verifyFormat("def Types : list<int>, bits<3>, list<list<string>> {}");
}
TEST_F(FormatTestTableGen, SimpleValue1_SingleLiterals) {
verifyFormat("def SimpleValue {\n"
" let Integer = 42;\n"
" let String = \"some string\";\n"
"}");
}
TEST_F(FormatTestTableGen, SimpleValue1_MultilineString) {
// test::messUp does not understand multiline TableGen code-literals.
// We have to give the result and the strings to format manually.
StringRef DefWithCode =
"def SimpleValueCode {\n"
" let Code =\n"
" [{ A TokCode is nothing more than a multi-line string literal "
"delimited by \\[{ and }\\]. It can break across lines and the line "
"breaks are retained in the string. \n"
"(https://llvm.org/docs/TableGen/ProgRef.html#grammar-token-TokCode)}];\n"
"}";
StringRef DefWithCodeMessedUp =
"def SimpleValueCode { let \n"
"Code= \n"
" [{ A TokCode is nothing more than a multi-line string "
"literal "
"delimited by \\[{ and }\\]. It can break across lines and the line "
"breaks are retained in the string. \n"
"(https://llvm.org/docs/TableGen/ProgRef.html#grammar-token-TokCode)}] \n"
" ; \n"
" } ";
verifyFormat(DefWithCode, DefWithCodeMessedUp);
}
TEST_F(FormatTestTableGen, SimpleValue2) {
verifyFormat("def SimpleValue2 {\n"
" let True = true;\n"
" let False = false;\n"
"}");
}
TEST_F(FormatTestTableGen, SimpleValue3) {
verifyFormat("class SimpleValue3<int x> { int Question = ?; }");
}
TEST_F(FormatTestTableGen, SimpleValue4) {
verifyFormat("def SimpleValue4 { let ValueList = {1, 2, 3}; }");
}
TEST_F(FormatTestTableGen, SimpleValue5) {
verifyFormat("def SimpleValue5 {\n"
" let SquareList = [1, 4, 9];\n"
" let SquareListWithType = [\"a\", \"b\", \"c\"]<string>;\n"
" let SquareListListWithType = [[1, 2], [3, 4, 5], [7]]<\n"
" list<int>>;\n"
" let SquareBitsListWithType = [ {1, 2},\n"
" {3, 4} ]<list<bits<8>>>;\n"
"}");
}
TEST_F(FormatTestTableGen, SimpleValue6) {
verifyFormat("def SimpleValue6 {\n"
" let DAGArgIns = (ins i32:$src1, i32:$src2);\n"
" let DAGArgOuts = (outs i32:$dst1, i32:$dst2, i32:$dst3,\n"
" i32:$dst4, i32:$dst5, i32:$dst6, i32:$dst7);\n"
" let DAGArgOutsWithComment = (outs i32:$dst1, // dst1\n"
" i32:$dst2, // dst2\n"
" i32:$dst3, // dst3\n"
" i32:$dst4, // dst4\n"
" i32:$dst5, // dst5\n"
" i32:$dst6, // dst6\n"
" i32:$dst7 // dst7\n"
" );\n"
" let DAGArgBang = (!cast<SomeType>(\"Some\") i32:$src1,\n"
" i32:$src2);\n"
"}");
}
TEST_F(FormatTestTableGen, SimpleValue7) {
verifyFormat("def SimpleValue7 { let Identifier = SimpleValue; }");
}
TEST_F(FormatTestTableGen, SimpleValue8) {
verifyFormat("def SimpleValue8 { let Class = SimpleValue3<3>; }");
}
TEST_F(FormatTestTableGen, ValueSuffix) {
verifyFormat("def SuffixedValues {\n"
" let Bit = value{17};\n"
" let Bits = value{8...15};\n"
" let List = value[1];\n"
" let Slice1 = value[1, ];\n"
" let Slice2 = value[4...7, 17, 2...3, 4];\n"
" let Field = value.field;\n"
"}");
}
TEST_F(FormatTestTableGen, PasteOperator) {
verifyFormat("def Paste#\"Operator\" { string Paste = \"Paste\"#operator; }");
verifyFormat("def [\"Traring\", \"Paste\"]# {\n"
" string X = Traring#;\n"
" string Y = List<\"Operator\">#;\n"
" string Z = [\"Traring\", \"Paste\", \"Traring\", \"Paste\",\n"
" \"Traring\", \"Paste\"]#;\n"
"}");
}
TEST_F(FormatTestTableGen, ClassDefinition) {
verifyFormat("class Class<int x, int y = 1, string z = \"z\", int w = -1>\n"
" : Parent1, Parent2<x, y> {\n"
" int Item1 = 1;\n"
" int Item2;\n"
" code Item3 = [{ Item3 }];\n"
" let Item4 = 4;\n"
" let Item5{1, 2} = 5;\n"
" defvar Item6 = 6;\n"
" let Item7 = ?;\n"
" assert !ge(x, 0), \"Assert7\";\n"
"}");
verifyFormat("class FPFormat<bits<3> val> { bits<3> Value = val; }");
}
TEST_F(FormatTestTableGen, Def) {
verifyFormat("def Def : Parent1<Def>, Parent2(defs Def) {\n"
" code Item1 = [{ Item1 }];\n"
" let Item2{1, 3...4} = {1, 2};\n"
" defvar Item3 = (ops nodty:$node1, nodty:$node2);\n"
" assert !le(Item2, 0), \"Assert4\";\n"
"}");
verifyFormat("class FPFormat<bits<3> val> { bits<3> Value = val; }");
verifyFormat("def NotFP : FPFormat<0>;");
}
TEST_F(FormatTestTableGen, Let) {
verifyFormat("let x = 1, y = value<type>,\n"
" z = !and(!gt(!add(1, 2), !sub(3, 4)), !isa<Ty>($x)) in {\n"
" class Class1 : Parent<x, y> { let Item1 = z; }\n"
"}");
}
TEST_F(FormatTestTableGen, MultiClass) {
verifyFormat("multiclass Multiclass<int x> {\n"
" def : Def1<(item type:$src1),\n"
" (!if(!ge(x, 0), !mul(!add(x, 1), !sub(x, 2)),\n"
" !sub(x, 2)))>;\n"
" def Def2 : value<type>;\n"
" def Def3 : type { let value = 1; }\n"
" defm : SomeMultiClass<Def1, Def2>;\n"
" defvar DefVar = 6;\n"
" foreach i = [1, 2, 3] in {\n"
" def : Foreach#i<(item type:$src1),\n"
" (!if(!gt(x, i),\n"
" !mul(!add(x, i), !sub(x, i)),\n"
" !sub(x, !add(i, 1))))>;\n"
" }\n"
" if !gt(x, 0) then {\n"
" def : IfThen<x>;\n"
" } else {\n"
" def : IfElse<x>;\n"
" }\n"
" if (dagid x, 0) then {\n"
" def : If2<1>;\n"
" }\n"
" let y = 1, z = 2 in {\n"
" multiclass Multiclass2<int x> {\n"
" foreach i = [1, 2, 3] in {\n"
" def : Foreach#i<(item type:$src1),\n"
" (!if(!gt(z, i),\n"
" !mul(!add(y, i), !sub(x, i)),\n"
" !sub(z, !add(i, 1))))>;\n"
" }\n"
" }\n"
" }\n"
"}");
}
TEST_F(FormatTestTableGen, MultiClassesWithPasteOperator) {
// This is a sensitive example for the handling of the paste operators in
// brace type calculation.
verifyFormat("multiclass MultiClass1<int i> {\n"
" def : Def#x<i>;\n"
" def : Def#y<i>;\n"
"}\n"
"multiclass MultiClass2<int i> { def : Def#x<i>; }");
}
TEST_F(FormatTestTableGen, Defm) {
verifyFormat("defm : Multiclass<0>;");
verifyFormat("defm Defm1 : Multiclass<1>;");
}
TEST_F(FormatTestTableGen, Defset) {
verifyFormat("defset list<Class> DefSet1 = {\n"
" def Def1 : Class<1>;\n"
" def Def2 : Class<2>;\n"
"}");
}
TEST_F(FormatTestTableGen, Defvar) {
verifyFormat("defvar DefVar1 = !cond(!ge(!size(PaseOperator.Paste), 1): 1,\n"
" true: 0);");
}
TEST_F(FormatTestTableGen, ForEach) {
verifyFormat(
"foreach i = [1, 2, 3] in {\n"
" def : Foreach#i<(item type:$src1),\n"
" (!if(!lt(x, i),\n"
" !shl(!mul(x, i), !size(\"string\")),\n"
" !size(!strconcat(\"a\", \"b\", \"c\"))))>;\n"
"}");
}
TEST_F(FormatTestTableGen, Dump) { verifyFormat("dump \"Dump\";"); }
TEST_F(FormatTestTableGen, If) {
verifyFormat("if !gt(x, 0) then {\n"
" def : IfThen<x>;\n"
"} else {\n"
" def : IfElse<x>;\n"
"}");
}
TEST_F(FormatTestTableGen, Assert) {
verifyFormat("assert !le(DefVar1, 0), \"Assert1\";");
}
TEST_F(FormatTestTableGen, DAGArgBreakElements) {
FormatStyle Style = getGoogleStyle(FormatStyle::LK_TableGen);
Style.ColumnLimit = 60;
// By default, the DAGArg does not have a break inside.
ASSERT_EQ(Style.TableGenBreakInsideDAGArg, FormatStyle::DAS_DontBreak);
verifyFormat("def Def : Parent {\n"
" let dagarg = (ins a:$src1, aa:$src2, aaa:$src3)\n"
"}",
Style);
// This option forces to break inside the DAGArg.
Style.TableGenBreakInsideDAGArg = FormatStyle::DAS_BreakElements;
verifyFormat("def Def : Parent {\n"
" let dagarg = (ins a:$src1,\n"
" aa:$src2,\n"
" aaa:$src3);\n"
"}",
Style);
verifyFormat("def Def : Parent {\n"
" let dagarg = (other a:$src1,\n"
" aa:$src2,\n"
" aaa:$src3);\n"
"}",
Style);
// Then, limit the DAGArg operator only to "ins".
Style.TableGenBreakingDAGArgOperators = {"ins"};
verifyFormat("def Def : Parent {\n"
" let dagarg = (ins a:$src1,\n"
" aa:$src2,\n"
" aaa:$src3);\n"
"}",
Style);
verifyFormat("def Def : Parent {\n"
" let dagarg = (other a:$src1, aa:$src2, aaa:$src3)\n"
"}",
Style);
}
TEST_F(FormatTestTableGen, DAGArgBreakAll) {
FormatStyle Style = getGoogleStyle(FormatStyle::LK_TableGen);
Style.ColumnLimit = 60;
// By default, the DAGArg does not have a break inside.
verifyFormat("def Def : Parent {\n"
" let dagarg = (ins a:$src1, aa:$src2, aaa:$src3)\n"
"}",
Style);
// This option forces to break inside the DAGArg.
Style.TableGenBreakInsideDAGArg = FormatStyle::DAS_BreakAll;
verifyFormat("def Def : Parent {\n"
" let dagarg = (ins\n"
" a:$src1,\n"
" aa:$src2,\n"
" aaa:$src3\n"
" );\n"
"}",
Style);
verifyFormat("def Def : Parent {\n"
" let dagarg = (other\n"
" a:$src1,\n"
" aa:$src2,\n"
" aaa:$src3\n"
" );\n"
"}",
Style);
// Then, limit the DAGArg operator only to "ins".
Style.TableGenBreakingDAGArgOperators = {"ins"};
verifyFormat("def Def : Parent {\n"
" let dagarg = (ins\n"
" a:$src1,\n"
" aa:$src2,\n"
" aaa:$src3\n"
" );\n"
"}",
Style);
verifyFormat("def Def : Parent {\n"
" let dagarg = (other a:$src1, aa:$src2, aaa:$src3);\n"
"}",
Style);
}
TEST_F(FormatTestTableGen, DAGArgAlignment) {
FormatStyle Style = getGoogleStyle(FormatStyle::LK_TableGen);
Style.ColumnLimit = 60;
Style.TableGenBreakInsideDAGArg = FormatStyle::DAS_BreakAll;
Style.TableGenBreakingDAGArgOperators = {"ins", "outs"};
verifyFormat("def Def : Parent {\n"
" let dagarg = (ins\n"
" a:$src1,\n"
" aa:$src2,\n"
" aaa:$src3\n"
" )\n"
"}",
Style);
verifyFormat("def Def : Parent {\n"
" let dagarg = (not a:$src1, aa:$src2, aaa:$src2)\n"
"}",
Style);
Style.AlignConsecutiveTableGenBreakingDAGArgColons.Enabled = true;
verifyFormat("def Def : Parent {\n"
" let dagarg = (ins\n"
" a :$src1,\n"
" aa :$src2,\n"
" aaa:$src3\n"
" )\n"
"}",
Style);
verifyFormat("def Def : Parent {\n"
" let dagarg = (not a:$src1, aa:$src2, aaa:$src2)\n"
"}",
Style);
}
TEST_F(FormatTestTableGen, CondOperatorAlignment) {
FormatStyle Style = getGoogleStyle(FormatStyle::LK_TableGen);
Style.ColumnLimit = 60;
verifyFormat("let CondOpe1 = !cond(!eq(size, 1): 1,\n"
" !eq(size, 16): 1,\n"
" true: 0);",
Style);
Style.AlignConsecutiveTableGenCondOperatorColons.Enabled = true;
verifyFormat("let CondOpe1 = !cond(!eq(size, 1) : 1,\n"
" !eq(size, 16): 1,\n"
" true : 0);",
Style);
}
TEST_F(FormatTestTableGen, DefAlignment) {
FormatStyle Style = getGoogleStyle(FormatStyle::LK_TableGen);
Style.ColumnLimit = 60;
verifyFormat("def Def : Parent {}\n"
"def DefDef : Parent {}\n"
"def DefDefDef : Parent {}",
Style);
Style.AlignConsecutiveTableGenDefinitionColons.Enabled = true;
verifyFormat("def Def : Parent {}\n"
"def DefDef : Parent {}\n"
"def DefDefDef : Parent {}",
Style);
}
} // namespace format
} // end namespace clang
|