completionchunkstotextconvertertest.cpp 16.3 KB
Newer Older
Nikolai Kosjar's avatar
Nikolai Kosjar committed
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
**
** Copyright (C) 2015 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt.io/licensing
**
** This file is part of Qt Creator.
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia.  For licensing terms and
** conditions see http://www.qt.io/licensing.  For further information
** use the contact form at http://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file.  Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Digia gives you certain additional
** rights.  These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
****************************************************************************/

#include <codecompletionchunk.h>
32
#include <clangcompletionchunkstotextconverter.h>
33

Marco Bubke's avatar
Marco Bubke committed
34 35 36
#include <gmock/gmock.h>
#include <gmock/gmock-matchers.h>
#include <gtest/gtest.h>
37
#include "gtest-qt-printing.h"
Marco Bubke's avatar
Marco Bubke committed
38

39 40
namespace {

41
using ClangBackEnd::CodeCompletionChunk;
42
using ClangBackEnd::CodeCompletionChunks;
43
using Converter = ClangCodeModel::Internal::CompletionChunksToTextConverter;
44 45 46 47

class CompletionChunksToTextConverter : public ::testing::Test
{
protected:
48 49 50 51
    void setupConverterForKeywords();

protected:
    Converter converter;
52
    CodeCompletionChunk integerResultType{CodeCompletionChunk::ResultType, Utf8StringLiteral("int")};
53
    CodeCompletionChunk templateResultType{CodeCompletionChunk::ResultType, Utf8StringLiteral("Foo<int>")};
54 55 56 57 58 59 60
    CodeCompletionChunk enumerationResultType{CodeCompletionChunk::ResultType, Utf8StringLiteral("Enumeration")};
    CodeCompletionChunk functionName{CodeCompletionChunk::TypedText, Utf8StringLiteral("Function")};
    CodeCompletionChunk variableName{CodeCompletionChunk::TypedText, Utf8StringLiteral("Variable")};
    CodeCompletionChunk enumeratorName{CodeCompletionChunk::TypedText, Utf8StringLiteral("Enumerator")};
    CodeCompletionChunk enumerationName{CodeCompletionChunk::TypedText, Utf8StringLiteral("Enumeration")};
    CodeCompletionChunk className{CodeCompletionChunk::TypedText, Utf8StringLiteral("Class")};
    CodeCompletionChunk leftParen{CodeCompletionChunk::LeftParen, Utf8StringLiteral("(")};
61
    CodeCompletionChunk rightParen{CodeCompletionChunk::RightParen, Utf8StringLiteral(")")};
62
    CodeCompletionChunk comma{CodeCompletionChunk::Comma, Utf8StringLiteral(", ")};
63
    CodeCompletionChunk semicolon{CodeCompletionChunk::SemiColon, Utf8StringLiteral(";")};
64 65 66
    CodeCompletionChunk functionArgumentX{CodeCompletionChunk::Placeholder, Utf8StringLiteral("char x")};
    CodeCompletionChunk functionArgumentY{CodeCompletionChunk::Placeholder, Utf8StringLiteral("int y")};
    CodeCompletionChunk functionArgumentZ{CodeCompletionChunk::Placeholder, Utf8StringLiteral("int z")};
67
    CodeCompletionChunk functionArgumentTemplate{CodeCompletionChunk::Placeholder, Utf8StringLiteral("const Foo<int> &foo")};
68 69 70 71 72 73 74 75 76 77 78 79 80 81
    CodeCompletionChunk switchName{CodeCompletionChunk::TypedText, Utf8StringLiteral("switch")};
    CodeCompletionChunk condition{CodeCompletionChunk::Placeholder, Utf8StringLiteral("condition")};
    CodeCompletionChunk leftBrace{CodeCompletionChunk::LeftBrace, Utf8StringLiteral("{")};
    CodeCompletionChunk rightBrace{CodeCompletionChunk::RightBrace, Utf8StringLiteral("}")};
    CodeCompletionChunk verticalSpace{CodeCompletionChunk::VerticalSpace, Utf8StringLiteral("\n")};
    CodeCompletionChunk throwName{CodeCompletionChunk::TypedText, Utf8StringLiteral("throw")};
    CodeCompletionChunk voidResultType{CodeCompletionChunk::ResultType, Utf8StringLiteral("void")};
    CodeCompletionChunk forName{CodeCompletionChunk::TypedText, Utf8StringLiteral("for")};
    CodeCompletionChunk initStatement{CodeCompletionChunk::Placeholder, Utf8StringLiteral("init-statement")};
    CodeCompletionChunk initExpression{CodeCompletionChunk::Placeholder, Utf8StringLiteral("init-expression")};
    CodeCompletionChunk statements{CodeCompletionChunk::Placeholder, Utf8StringLiteral("statements")};
    CodeCompletionChunk constCastName{CodeCompletionChunk::TypedText, Utf8StringLiteral("const_cast")};
    CodeCompletionChunk leftAngle{CodeCompletionChunk::LeftAngle, Utf8StringLiteral("<")};
    CodeCompletionChunk rightAngle{CodeCompletionChunk::RightAngle, Utf8StringLiteral(">")};
82 83 84
    CodeCompletionChunk elseName{CodeCompletionChunk::TypedText, Utf8StringLiteral("else")};
    CodeCompletionChunk ifName{CodeCompletionChunk::TypedText, Utf8StringLiteral("if")};
    CodeCompletionChunk horizontalSpace{CodeCompletionChunk::HorizontalSpace, Utf8StringLiteral(" ")};
85 86
    CodeCompletionChunk enableIfT{CodeCompletionChunk::TypedText, Utf8StringLiteral("enable_if_t")};
    CodeCompletionChunk enableIfTCondition{CodeCompletionChunk::Placeholder, Utf8StringLiteral("_Cond")};
87 88 89 90
    CodeCompletionChunk  optionalEnableIfTType{CodeCompletionChunk::Placeholder, Utf8StringLiteral("_Tp"), true};
    CodeCompletionChunk optionalComma{CodeCompletionChunk::Comma, Utf8StringLiteral(", "), true};
    CodeCompletionChunk optionalFunctionArgumentY{CodeCompletionChunk::Placeholder, Utf8StringLiteral("int y"), true};
    CodeCompletionChunk optionalFunctionArgumentZ{CodeCompletionChunk::Placeholder, Utf8StringLiteral("int z"), true};
91 92 93 94
};

TEST_F(CompletionChunksToTextConverter, ParseIsClearingText)
{
95
    CodeCompletionChunks completionChunks({integerResultType, functionName, leftParen, rightParen});
96
    converter.setAddResultType(true);
97 98 99 100 101 102 103 104

    converter.parseChunks(completionChunks);

    ASSERT_THAT(converter.text(), QStringLiteral("int Function()"));
}

TEST_F(CompletionChunksToTextConverter, ConvertFunction)
{
105
    CodeCompletionChunks completionChunks({integerResultType, functionName, leftParen, rightParen});
106
    converter.setAddResultType(true);
107 108 109 110 111 112 113 114

    converter.parseChunks(completionChunks);

    ASSERT_THAT(converter.text(), QStringLiteral("int Function()"));
}

TEST_F(CompletionChunksToTextConverter, ConvertFunctionWithParameters)
{
115
    CodeCompletionChunks completionChunks({integerResultType, functionName, leftParen, functionArgumentX,rightParen});
116 117
    converter.setAddResultType(true);
    converter.setAddPlaceHolderText(true);
118 119 120 121 122 123

    converter.parseChunks(completionChunks);

    ASSERT_THAT(converter.text(), QStringLiteral("int Function(char x)"));
}

124 125 126 127 128 129 130 131 132 133
TEST_F(CompletionChunksToTextConverter, ConvertToFunctionSignatureWithOneArgument)
{
    CodeCompletionChunks completionChunks({integerResultType,
                                           functionName,
                                           leftParen,
                                           functionArgumentX,
                                           rightParen});

    using ClangCodeModel::Internal::CompletionChunksToTextConverter;

134
    ASSERT_THAT(converter.convertToFunctionSignatureWithHtml(completionChunks),
135 136 137 138 139 140 141 142 143 144 145
                QStringLiteral("int Function(char x)"));
}

TEST_F(CompletionChunksToTextConverter, ConvertToFunctionSignatureWithOneParameterThatIsActive)
{
    CodeCompletionChunks completionChunks({integerResultType,
                                           functionName,
                                           leftParen,
                                            functionArgumentX,
                                           rightParen});

146
    ASSERT_THAT(converter.convertToFunctionSignatureWithHtml(completionChunks, 1),
147 148 149 150 151 152 153 154 155 156 157
                QStringLiteral("int Function(<b>char x</b>)"));
}

TEST_F(CompletionChunksToTextConverter, ConvertToFunctionSignatureWithOneParameterAndInInvalidActiveParameter)
{
    CodeCompletionChunks completionChunks({integerResultType,
                                           functionName,
                                           leftParen,
                                            functionArgumentX,
                                           rightParen});

158
    ASSERT_THAT(converter.convertToFunctionSignatureWithHtml(completionChunks, -1),
159 160 161 162 163 164 165 166 167 168 169 170 171
                QStringLiteral("int Function(char x)"));
}

TEST_F(CompletionChunksToTextConverter, ConvertToFunctionSignatureWithTwoParametersWhereOneIsActive)
{
    CodeCompletionChunks completionChunks({integerResultType,
                                           functionName,
                                           leftParen,
                                            functionArgumentX,
                                            comma,
                                            functionArgumentY,
                                           rightParen});

172
    ASSERT_THAT(converter.convertToFunctionSignatureWithHtml(completionChunks, 2),
173 174 175 176 177 178 179 180 181 182 183 184 185
                QStringLiteral("int Function(char x, <b>int y</b>)"));
}

TEST_F(CompletionChunksToTextConverter, ConvertToFunctionSignatureWithTwoParametersWhereOneIsOptionalAndActive)
{
    CodeCompletionChunks completionChunks({integerResultType,
                                           functionName,
                                           leftParen,
                                            functionArgumentX,
                                            optionalComma,
                                            optionalFunctionArgumentY,
                                           rightParen});

186
    ASSERT_THAT(converter.convertToFunctionSignatureWithHtml(completionChunks, 2),
187 188 189
                QStringLiteral("int Function(char x<i>, <b>int y</b></i>)"));
}

190 191 192 193 194 195 196 197 198 199
TEST_F(CompletionChunksToTextConverter, ConvertToFunctionSignatureWithTemplateReturnType)
{
    CodeCompletionChunks completionChunks({templateResultType,
                                           functionName,
                                           leftParen,
                                            functionArgumentX,
                                           rightParen});

    using ClangCodeModel::Internal::CompletionChunksToTextConverter;

200
    ASSERT_THAT(CompletionChunksToTextConverter::convertToFunctionSignatureWithHtml(completionChunks),
201 202 203 204 205 206 207 208 209 210 211 212 213
                QStringLiteral("Foo&lt;int&gt; Function(char x)"));
}

TEST_F(CompletionChunksToTextConverter, ConvertToFunctionSignatureWithTemplateArgument)
{
    CodeCompletionChunks completionChunks({integerResultType,
                                           functionName,
                                           leftParen,
                                            functionArgumentTemplate,
                                           rightParen});

    using ClangCodeModel::Internal::CompletionChunksToTextConverter;

214
    ASSERT_THAT(CompletionChunksToTextConverter::convertToFunctionSignatureWithHtml(completionChunks),
215 216 217
                QStringLiteral("int Function(const Foo&lt;int&gt; &amp;foo)"));
}

218 219
TEST_F(CompletionChunksToTextConverter, ConvertFunctionWithOptionalParameter)
{
220 221 222 223 224 225 226 227 228
    CodeCompletionChunks completionChunks({integerResultType,
                                           functionName,
                                           leftParen,
                                           functionArgumentX,
                                           optionalComma,
                                           optionalFunctionArgumentY,
                                           optionalComma,
                                           optionalFunctionArgumentZ,
                                           rightParen});
229

230
    ASSERT_THAT(Converter::convertToToolTipWithHtml(completionChunks),
231
                QStringLiteral("int Function (char x<i>, int y, int z</i>)"));
232 233 234 235
}

TEST_F(CompletionChunksToTextConverter, ConvertVariable)
{
236
    CodeCompletionChunks completionChunks({integerResultType, variableName});
237
    converter.setAddResultType(true);
238 239 240 241 242 243 244 245

    converter.parseChunks(completionChunks);

    ASSERT_THAT(converter.text(), QStringLiteral("int Variable"));
}

TEST_F(CompletionChunksToTextConverter, Enumerator)
{
246
    CodeCompletionChunks completionChunks({enumerationResultType, enumeratorName});
247
    converter.setAddResultType(true);
248 249 250 251 252 253 254 255

    converter.parseChunks(completionChunks);

    ASSERT_THAT(converter.text(), QStringLiteral("Enumeration Enumerator"));
}

TEST_F(CompletionChunksToTextConverter, Enumeration)
{
256
    CodeCompletionChunks completionChunks({className});
257 258 259 260 261 262

    converter.parseChunks(completionChunks);

    ASSERT_THAT(converter.text(), QStringLiteral("Class"));
}

263 264
TEST_F(CompletionChunksToTextConverter, Switch)
{
265
    CodeCompletionChunks completionChunks({switchName,
266 267 268 269 270 271
                                           leftParen,
                                           condition,
                                           rightParen,
                                           leftBrace,
                                           verticalSpace,
                                           rightBrace});
Nikolai Kosjar's avatar
Nikolai Kosjar committed
272
    converter.setupForKeywords();
273 274 275 276 277 278 279 280 281

    converter.parseChunks(completionChunks);

    ASSERT_THAT(converter.text(), QStringLiteral("switch () {\n\n}"));
    ASSERT_THAT(converter.placeholderPositions().at(0), 8);
}

TEST_F(CompletionChunksToTextConverter, For)
{
282
    CodeCompletionChunks completionChunks({forName,
283 284 285 286 287 288 289 290 291 292 293 294
                                                   leftParen,
                                                   initStatement,
                                                   semicolon,
                                                   initExpression,
                                                   semicolon,
                                                   condition,
                                                   rightParen,
                                                   leftBrace,
                                                   verticalSpace,
                                                   statements,
                                                   verticalSpace,
                                                   rightBrace});
Nikolai Kosjar's avatar
Nikolai Kosjar committed
295
    converter.setupForKeywords();
296 297 298 299 300 301 302 303

    converter.parseChunks(completionChunks);

    ASSERT_THAT(converter.text(), QStringLiteral("for (;;) {\n\n}"));
}

TEST_F(CompletionChunksToTextConverter, const_cast)
{
304
    CodeCompletionChunks completionChunks({constCastName,
305 306 307 308
                                                   leftAngle,
                                                   rightAngle,
                                                   leftParen,
                                                   rightParen});
Nikolai Kosjar's avatar
Nikolai Kosjar committed
309
    converter.setupForKeywords();
310 311 312

    converter.parseChunks(completionChunks);

313
    ASSERT_THAT(converter.text(), QStringLiteral("const_cast<>()"));
314 315 316 317
}

TEST_F(CompletionChunksToTextConverter, Throw)
{
318
    CodeCompletionChunks completionChunks({voidResultType, throwName});
319 320 321 322 323 324

    auto completionName = Converter::convertToName(completionChunks);

    ASSERT_THAT(completionName, QStringLiteral("throw"));
}

325 326
TEST_F(CompletionChunksToTextConverter, ElseIf)
{
327
    CodeCompletionChunks completionChunks({elseName,
328 329 330 331 332 333 334 335
                                                   horizontalSpace,
                                                   ifName,
                                                   horizontalSpace,
                                                   leftBrace,
                                                   verticalSpace,
                                                   statements,
                                                   verticalSpace,
                                                   rightBrace});
Nikolai Kosjar's avatar
Nikolai Kosjar committed
336
    converter.setupForKeywords();
337 338 339 340 341 342

    converter.parseChunks(completionChunks);

    ASSERT_THAT(converter.text(), QStringLiteral("else if {\n\n}"));
}

343 344 345 346 347
TEST_F(CompletionChunksToTextConverter, EnableIfT)
{
    CodeCompletionChunks completionChunks({enableIfT,
                                           leftAngle,
                                           enableIfTCondition,
348 349
                                           optionalComma,
                                           optionalEnableIfTType,
350
                                           rightAngle});
Nikolai Kosjar's avatar
Nikolai Kosjar committed
351
    converter.setupForKeywords();
352 353 354

    converter.parseChunks(completionChunks);

355
    ASSERT_THAT(converter.text(), QStringLiteral("enable_if_t<>"));
356 357
}

358
}