153 lines · cpp
1//===- FormatTest.cpp - TableGen Format Utility Tests ---------------------===//2//3// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.4// See https://llvm.org/LICENSE.txt for license information.5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception6//7//===----------------------------------------------------------------------===//8 9#include "mlir/TableGen/Format.h"10#include "gmock/gmock.h"11 12using mlir::tblgen::FmtContext;13using mlir::tblgen::tgfmt;14using ::testing::StrEq;15 16TEST(FormatTest, EmptyFmtStr) {17 FmtContext ctx;18 std::string result = std::string(tgfmt("", &ctx));19 EXPECT_TRUE(result.empty());20}21 22/// Allow extra unused positional parameters.23TEST(FormatTest, EmptyFmtStrExtraParams) {24 FmtContext ctx;25 std::string result = std::string(tgfmt("", &ctx, "a", "b", "c"));26 EXPECT_TRUE(result.empty());27}28 29/// Allow unused placeholder substitution in context.30TEST(FormatTest, EmptyFmtStrPopulatedCtx) {31 FmtContext ctx;32 ctx.withBuilder("builder");33 std::string result = std::string(tgfmt("", &ctx));34 EXPECT_TRUE(result.empty());35}36 37TEST(FormatTest, LiteralFmtStr) {38 FmtContext ctx;39 std::string result = std::string(tgfmt("void foo {}", &ctx));40 EXPECT_THAT(result, StrEq("void foo {}"));41}42 43/// Print single dollar literally.44TEST(FormatTest, AdjacentDollar) {45 FmtContext ctx;46 std::string result = std::string(tgfmt("$", &ctx));47 EXPECT_THAT(result, StrEq("$"));48}49 50/// Print dangling dollar literally.51TEST(FormatTest, DanglingDollar) {52 FmtContext ctx;53 std::string result = std::string(tgfmt("foo bar baz$", &ctx));54 EXPECT_THAT(result, StrEq("foo bar baz$"));55}56 57/// Allow escape dollars with '$$'.58TEST(FormatTest, EscapeDollars) {59 FmtContext ctx;60 std::string result =61 std::string(tgfmt("$$ $$$$ $$$0 $$$_self", &ctx.withSelf("self"), "-0"));62 EXPECT_THAT(result, StrEq("$ $$ $-0 $self"));63}64 65TEST(FormatTest, PositionalFmtStr) {66 FmtContext ctx;67 std::string b = "b";68 int c = 42;69 char d = 'd';70 std::string result =71 std::string(tgfmt("$0 $1 $2 $3", &ctx, "a", b, c + 1, d));72 EXPECT_THAT(result, StrEq("a b 43 d"));73}74 75/// Output the placeholder if missing substitution.76TEST(FormatTest, PositionalFmtStrMissingParams) {77 FmtContext ctx;78 std::string result = std::string(tgfmt("$0 %1 $2", &ctx));79 EXPECT_THAT(result, StrEq("$0<no-subst-found> %1 $2<no-subst-found>"));80}81 82/// Allow flexible reference of positional parameters.83TEST(FormatTest, PositionalFmtStrFlexibleRef) {84 FmtContext ctx;85 std::string result = std::string(tgfmt("$2 $0 $2", &ctx, "a", "b", "c"));86 EXPECT_THAT(result, StrEq("c a c"));87}88 89TEST(FormatTest, PositionalFmtStrNoWhitespace) {90 FmtContext ctx;91 std::string result = std::string(tgfmt("foo$0bar", &ctx, "-"));92 EXPECT_THAT(result, StrEq("foo-bar"));93}94 95TEST(FormatTest, PlaceHolderFmtStrWithSelf) {96 FmtContext ctx;97 std::string result = std::string(tgfmt("$_self", &ctx.withSelf("sss")));98 EXPECT_THAT(result, StrEq("sss"));99}100 101TEST(FormatTest, PlaceHolderFmtStrWithBuilder) {102 FmtContext ctx;103 104 std::string result = std::string(tgfmt("$_builder", &ctx.withBuilder("bbb")));105 EXPECT_THAT(result, StrEq("bbb"));106}107 108TEST(FormatTest, PlaceHolderMissingCtx) {109 std::string result = std::string(tgfmt("$_op", nullptr));110 EXPECT_THAT(result, StrEq("$_op<no-subst-found>"));111}112 113TEST(FormatTest, PlaceHolderMissingSubst) {114 FmtContext ctx;115 std::string result = std::string(tgfmt("$_op", &ctx.withBuilder("builder")));116 EXPECT_THAT(result, StrEq("$_op<no-subst-found>"));117}118 119/// Test commonly used delimiters in C++.120TEST(FormatTest, PlaceHolderFmtStrDelimiter) {121 FmtContext ctx;122 ctx.addSubst("m", "");123 std::string result = std::string(tgfmt("$m{$m($m[$m]$m)$m}$m|", &ctx));124 EXPECT_THAT(result, StrEq("{([])}|"));125}126 127/// Test allowed characters in placeholder symbol.128TEST(FormatTest, CustomPlaceHolderFmtStrPlaceHolderChars) {129 FmtContext ctx;130 ctx.addSubst("m", "0 ");131 ctx.addSubst("m1", "1 ");132 ctx.addSubst("m2C", "2 ");133 ctx.addSubst("M_3", "3 ");134 std::string result = std::string(tgfmt("$m$m1$m2C$M_3", &ctx));135 EXPECT_THAT(result, StrEq("0 1 2 3 "));136}137 138TEST(FormatTest, CustomPlaceHolderFmtStrUnregisteredPlaceHolders) {139 FmtContext ctx;140 std::string result = std::string(tgfmt("foo($awesome, $param)", &ctx));141 EXPECT_THAT(result,142 StrEq("foo($awesome<no-subst-found>, $param<no-subst-found>)"));143}144 145TEST(FormatTest, MixedFmtStr) {146 FmtContext ctx;147 ctx.withBuilder("bbb");148 149 std::string result = std::string(tgfmt("$_builder.build($_self, {$0, $1})",150 &ctx.withSelf("sss"), "a", "b"));151 EXPECT_THAT(result, StrEq("bbb.build(sss, {a, b})"));152}153