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
|
/*
SPDX-FileCopyrightText: 2016 Milian Wolff <mail@milianw.de>
SPDX-License-Identifier: LGPL-2.0-or-later
*/
#include "test_stringhelpers.h"
#include <QTest>
#include <QStandardPaths>
#include <language/duchain/stringhelpers.h>
#include <cstring>
QTEST_MAIN(TestStringHelpers)
using namespace KDevelop;
void TestStringHelpers::initTestCase()
{
QStandardPaths::setTestModeEnabled(true);
}
void TestStringHelpers::testFormatComment_data()
{
QTest::addColumn<QByteArray>("input");
QTest::addColumn<QByteArray>("output");
QTest::newRow("cpp-style") << QByteArrayLiteral(
"// foo\n"
"// bar"
) << QByteArrayLiteral("foo\n bar");
QTest::newRow("doxy-cpp-style") << QByteArrayLiteral(
"/// foo\n"
"/// bar"
) << QByteArrayLiteral("foo\n bar");
QTest::newRow("doxy-cpp-excl-style") << QByteArrayLiteral(
"//! foo\n"
"//! bar"
) << QByteArrayLiteral("foo\n bar");
QTest::newRow("doxy-cpp-singleline-style") << QByteArrayLiteral("///< foo") << QByteArrayLiteral("foo");
QTest::newRow("doxy-cpp-excl-singleline-style") << QByteArrayLiteral("//!< foo") << QByteArrayLiteral("foo");
QTest::newRow("c-style") << QByteArrayLiteral(
"/*\n"
" foo\n"
" bar\n*/"
) << QByteArrayLiteral("foo\nbar");
QTest::newRow("doxy-c-style") << QByteArrayLiteral(
"/**\n"
" * foo\n"
" * bar\n */"
) << QByteArrayLiteral("foo\n bar");
QTest::newRow("doxy-c-style2") << QByteArrayLiteral(
"/**\n"
" * foo\n"
" * bar\n **/"
) << QByteArrayLiteral("foo\n bar");
QTest::newRow("real multiline") << QByteArrayLiteral(
"/**\n"
" * This is a real comment of some imaginary code.\n"
" *\n"
" * @param foo bar\n"
" * @return meh\n"
" */\n"
)
<< QByteArrayLiteral("This is a real comment of some imaginary code.\n\n @param foo bar\n @return meh");
QTest::newRow("doxy-qt-style-after-member") << QByteArrayLiteral(
"/*!< line1\n"
"line2 */"
) << QByteArrayLiteral("line1\nline2");
QTest::newRow("doxy-c-style-after-member") << QByteArrayLiteral(
"/**< line1\n"
"line2 */"
) << QByteArrayLiteral("line1\nline2");
QTest::newRow("doxy-cpp-style-after-member") << QByteArrayLiteral(
"//!< line1\n"
"//!< line2"
) << QByteArrayLiteral("line1\n line2");
QTest::newRow("doxy-cpp-style-after-member2") << QByteArrayLiteral(
"/// line1\n"
"/// < line2"
) << QByteArrayLiteral("line1\n < line2");
QTest::newRow("doxy-qt-style-before-member") << QByteArrayLiteral(
"/*! line1\n"
"line2 */"
) << QByteArrayLiteral("line1\nline2");
QTest::newRow("doxy-qt-style-before-member2") << QByteArrayLiteral(
"/*! line1\n"
" * *line2* */"
) << QByteArrayLiteral("line1\n *line2*");
QTest::newRow("doxy-cpp-style-before-member") << QByteArrayLiteral(
"//! line1\n"
"//! line2"
) << QByteArrayLiteral("line1\n line2");
}
void TestStringHelpers::testFormatComment()
{
QFETCH(QByteArray, input);
QFETCH(QByteArray, output);
QCOMPARE(formatComment(input), output);
}
void TestStringHelpers::benchFormatComment()
{
QBENCHMARK {
formatComment(QByteArrayLiteral(
"/**\n"
" * This is a real comment of some imaginary code.\n"
" *\n"
" * @param foo bar\n"
" * @return meh\n"
" */\n"
));
}
}
void TestStringHelpers::testParamIterator_data()
{
QTest::addColumn<QString>("parens");
QTest::addColumn<QString>("source");
QTest::addColumn<QStringList>("params");
QTest::addColumn<int>("endPosition");
auto addGeneralTest = [](const QString& parens, const QString& source, const QStringList& params,
int endPosition = -1) {
QTest::addRow("%s", qPrintable(source))
<< parens << source << params << (endPosition == -1 ? source.size() : endPosition);
};
auto addTest = [addGeneralTest](const QString& source, const QStringList& params, int endPosition = -1) {
addGeneralTest("<>:", source, params, endPosition);
};
auto addMacroTest = [addGeneralTest](const QString& source, const QStringList& params, int endPosition = -1) {
addGeneralTest("()", source, params, endPosition);
};
addTest("Empty", {});
addTest("Foo<T1, T2>", {"T1", "T2"});
addTest("operator<", {});
// Such strings are passed to ParamIterator() when an Identifier is constructed from a template argument inside the
// call to Visitor::makeType() in Visitor::createClassTemplateSpecializationType(). For example, the following valid
// C++ code `K< &operator<< <S> > k;` passes the string "&operator<<<S>" to ParamIterator().
addTest("operator< <QString>", {"QString"});
addTest("operator<<<KDevVarLengthArray, Path >", {"KDevVarLengthArray", "Path"});
addTest("operator<=>< QRegularExpression,IndexedString*,char\t>", {"QRegularExpression", "IndexedString*", "char"});
// The valid C++ code `C<decltype(A::f<int>)> c;` passes the string "decltype(A::f<int>)" to ParamIterator().
addTest("decltype(f<int>)", {});
addTest("decltype(A::f)", {});
addTest("decltype(A::f<int>)", {});
addTest("decltype(N::operator< <N::String>)", {});
addTest("__not_overloaded2<_Tp, foo<bar>, __void_t<decltype(std::declval<_Tp>().operator<(std::declval<_Up>()))>>",
{"_Tp", "foo<bar>", "__void_t<decltype(std::declval<_Tp>().operator<(std::declval<_Up>()))>"});
addTest("__not_overloaded2<_Tp, foo<bar>, __void_t<decltype(std::declval<_Tp>().operator>(std::declval<_Up>()))>>",
{"_Tp", "foo<bar>", "__void_t<decltype(std::declval<_Tp>().operator>(std::declval<_Up>()))>"});
addTest("__not_overloaded2<_Tp, foo<bar>, __void_t<decltype(std::declval<_Tp>().operator>=(std::declval<_Up>()))>>",
{"_Tp", "foo<bar>", "__void_t<decltype(std::declval<_Tp>().operator>=(std::declval<_Up>()))>"});
addTest("__not_overloaded2<_Tp, foo<bar>, __void_t<decltype(std::declval<_Tp>().operator<=(std::declval<_Up>()))>>",
{"_Tp", "foo<bar>", "__void_t<decltype(std::declval<_Tp>().operator<=(std::declval<_Up>()))>"});
addTest("__not_overloaded2<_Tp, foo<bar>, __void_t<decltype(std::declval<_Tp>().operator>>(std::declval<_Up>()))>>",
{"_Tp", "foo<bar>", "__void_t<decltype(std::declval<_Tp>().operator>>(std::declval<_Up>()))>"});
addTest("__not_overloaded2<_Tp, foo<bar>, __void_t<decltype(std::declval<_Tp>().operator<<(std::declval<_Up>()))>>",
{"_Tp", "foo<bar>", "__void_t<decltype(std::declval<_Tp>().operator<<(std::declval<_Up>()))>"});
addTest("__not_overloaded2<_Tp, foo<bar>, __void_t<decltype(std::declval<_Tp>().operator<=>(std::declval<_Up>()))>>",
{"_Tp", "foo<bar>", "__void_t<decltype(std::declval<_Tp>().operator<=>(std::declval<_Up>()))>"});
addTest("__not_overloaded2<_Tp, foo<bar>, __void_t<decltype(std::declval<_Tp>().operator->(std::declval<_Up>()))>>",
{"_Tp", "foo<bar>", "__void_t<decltype(std::declval<_Tp>().operator->(std::declval<_Up>()))>"});
addTest("A<\">\\\">\">", {"\">\\\">\""});
addTest("A<'>'>", {"'>'"});
addTest("myoperator<anoperator<anotheroperator>, my_operator>", {"anoperator<anotheroperator>", "my_operator"});
// c++17 operator<=
addTest("Y<decltype(&X::operator<=), &X::operator<=>", {"decltype(&X::operator<=)", "&X::operator<="});
// c++20 operator<=>
addTest("Y<decltype(&X::operator<=>), &X::operator<=>>", {"decltype(&X::operator<=>)", "&X::operator<=>"});
addTest("Y<decltype(&X::operator->), &X::operator->>", {"decltype(&X::operator->)", "&X::operator->"});
addTest("Y<decltype(&X::operator->), Z<&X::operator->>>", {"decltype(&X::operator->)", "Z<&X::operator->>"});
addTest("Y<decltype(&X::operator--), &X::operator-->", {"decltype(&X::operator--)", "&X::operator--"});
addTest("Y<decltype(&X::operator--), Z<&X::operator-->>", {"decltype(&X::operator--)", "Z<&X::operator-->"});
// c++17 operator<=
addTest("Y<decltype(&X::operator<=), Z<&X::operator<=>>", {"decltype(&X::operator<=)", "Z<&X::operator<=>"});
// c++20 operator<=>
addTest("Y<decltype(&X::operator<=>), Z<&X::operator<=>>>", {"decltype(&X::operator<=>)", "Z<&X::operator<=>>"});
// NOTE: the "bogus" identifiers below are invalid but shouldn't trigger UB, so the tests verify that we get
// _something_ (even if it's wrong).
addTest("bogus<_Tp, _Up, invalid<decltype(<=(std::declval<_Tp>(), std::declval<_Up>()))>>",
{"_Tp", "_Up", "invalid<decltype(<=(std::declval<_Tp>(), std::declval<_Up>()))>"});
addTest("bogus<_Tp, _Up, invalid<<=(std::declval<_Tp>(), std::declval<_Up>())>>",
{"_Tp", "_Up", "invalid<<=(std::declval<_Tp>(), std::declval<_Up>())>>"});
addTest("hardToParse<A<B>", {"A<B"});
addTest("hardToParse<(A<B)>", {"(A<B)"});
addTest("hardToParse<(A>B)>", {"(A>B)"});
addTest("hardToParse<Foo<(A<B)>>", {"Foo<(A<B)>"});
addTest("hardToParse<Foo<(A>B)>>", {"Foo<(A>B)>"});
// Such zero/empty tparam strings are actually passed to ParamIterator() while libstdc++ headers are parsed.
addTest("_Index_tuple<>", {});
addTest("const __shared_count< \t>", {});
addTest("_Rb_tree_impl<_Key_compare, >", {"_Key_compare", ""});
addTest("__hash_enum<_Tp,\t \t>", {"_Tp", ""});
addTest("__uniq_ptr_data<_Tp, _Dp, , >", {"_Tp", "_Dp", "", ""});
const auto addSpacedOperatorTest = [addTest](const QString& op) {
const auto tArg1 = QStringLiteral("x %1 y").arg(op);
const auto tArg2 = QStringLiteral("Foo<%1>").arg(tArg1);
for (const auto& templateArgument : {tArg1, tArg2}) {
addTest(QStringLiteral("spaced<%1>").arg(templateArgument), {templateArgument});
}
};
addSpacedOperatorTest("<");
addSpacedOperatorTest(">");
addSpacedOperatorTest("<=");
addSpacedOperatorTest(">=");
addSpacedOperatorTest("<<");
addSpacedOperatorTest(">>");
addSpacedOperatorTest("<<=");
addSpacedOperatorTest(">>=");
addSpacedOperatorTest("<=>");
addSpacedOperatorTest("->");
// -> must be recognized even when not surrounded with spaces
addTest("arrow<u->v>", {"u->v"});
addTest("arrow<Foo<u->v>>", {"Foo<u->v>"});
addTest("X::Y<Z>", {}, 1);
addTest("X<Z::C>", {"Z::C"});
addMacroTest("Q_UNIMPLEMENTED() qWarning(\"Unimplemented code.\")", {}, std::strlen("Q_UNIMPLEMENTED()"));
addMacroTest("Q_FALLTHROUGH( ) [[clang::fallthrough]]", {}, std::strlen("Q_FALLTHROUGH( )"));
addMacroTest("( /*a)b*/ x , /*,*/y,z )", {"/*a)b*/ x", "/*,*/y", "z"});
}
void TestStringHelpers::testParamIterator()
{
QFETCH(QString, parens);
QFETCH(QString, source);
QFETCH(QStringList, params);
QFETCH(int, endPosition);
auto it = KDevelop::ParamIterator(parens, source);
QEXPECT_FAIL("hardToParse<A<B>", "quasi impossible to parse without semantic knowledge of the types", Abort);
int i = 0;
while (!params.isEmpty()) {
QVERIFY(it);
if (i == 1) {
QEXPECT_FAIL("Y<decltype(&X::operator<=), &X::operator<=>", "clang triggers warning for this C++17 code, due to C++20 spaceship op", Continue);
QEXPECT_FAIL("Y<decltype(&X::operator<=), Z<&X::operator<=>>",
"clang triggers warning for this C++17 code, due to C++20 spaceship op", Continue);
}
QCOMPARE(*it, params.takeFirst());
++it;
++i;
}
QVERIFY(!it);
QCOMPARE(it.position(), endPosition);
}
#include "moc_test_stringhelpers.cpp"
|