forked from qt-creator/qt-creator
8d6549fa74
1 struct Foo { int member; };
2 void f(Foo *foo)
3 {
4 foo.<REQUEST COMPLETION> // correct '.' to '->' and provide results
5 }
The preferred approach would be to check if "foo" in line 4 is of
pointer type, but there is no suitable cursor (only CompoundStmt) at
that position since the code is usually not yet parsed and thus invalid.
Thus, just run the completion as is. If there are not any results for a
dot completion, re-run the completion with "." exchanged by "->". This
approach is inherently slower than the preferred approach implemented in
the built-in code model.
The following rare cases are not handled:
1) Requesting completion after white space:
Works: foo.<COMPLETE HERE>
Fails: foo. <COMPLETE HERE>
2) Opening a file and requesting completion (ctrl+space) without prior
editing. No editing before triggering completion means that no
unsaved file is generated on the backend side, which is a
requirement for the correction.
Task-number: QTCREATORBUG-11581
Change-Id: I6bc8e8594778774ab342755fdb01a8a3e5c52ba0
Reviewed-by: Marco Bubke <marco.bubke@theqtcompany.com>
392 lines
16 KiB
C++
392 lines
16 KiB
C++
/****************************************************************************
|
|
**
|
|
** 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 <codecompleter.h>
|
|
#include <filecontainer.h>
|
|
#include <projectpart.h>
|
|
#include <projects.h>
|
|
#include <clangtranslationunit.h>
|
|
#include <translationunits.h>
|
|
#include <unsavedfiles.h>
|
|
#include <utf8stringvector.h>
|
|
|
|
#include <QCoreApplication>
|
|
#include <QFile>
|
|
#include <QTemporaryDir>
|
|
|
|
#include <gmock/gmock.h>
|
|
#include <gmock/gmock-matchers.h>
|
|
#include <gtest/gtest.h>
|
|
#include "gtest-qt-printing.h"
|
|
|
|
using ::testing::ElementsAreArray;
|
|
using ::testing::Contains;
|
|
using ::testing::AllOf;
|
|
using ::testing::Not;
|
|
using ::testing::PrintToString;
|
|
|
|
using ClangBackEnd::CodeCompletion;
|
|
using ClangBackEnd::CodeCompleter;
|
|
|
|
namespace {
|
|
|
|
MATCHER_P2(IsCodeCompletion, text, completionKind,
|
|
std::string(negation ? "isn't" : "is") + " code completion with text "
|
|
+ PrintToString(text) + " and kind " + PrintToString(completionKind)
|
|
)
|
|
{
|
|
if (arg.text() != text) {
|
|
*result_listener << "text is " + PrintToString(arg.text()) + " and not " + PrintToString(text);
|
|
return false;
|
|
}
|
|
|
|
if (arg.completionKind() != completionKind) {
|
|
*result_listener << "kind is " + PrintToString(arg.completionKind()) + " and not " + PrintToString(completionKind);
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
class CodeCompleter : public ::testing::Test
|
|
{
|
|
protected:
|
|
void SetUp();
|
|
void copyTargetHeaderToTemporaryIncludeDirecory();
|
|
void copyChangedTargetHeaderToTemporaryIncludeDirecory();
|
|
ClangBackEnd::CodeCompleter setupCompleter(const ClangBackEnd::FileContainer &fileContainer);
|
|
static Utf8String readFileContent(const QString &fileName);
|
|
|
|
protected:
|
|
QTemporaryDir includeDirectory;
|
|
Utf8String includePath{QStringLiteral("-I") + includeDirectory.path()};
|
|
QString targetHeaderPath{includeDirectory.path() + QStringLiteral("/complete_target_header.h")};
|
|
ClangBackEnd::ProjectPartContainer projectPart{Utf8StringLiteral("projectPartId"), {includePath}};
|
|
ClangBackEnd::FileContainer mainFileContainer{Utf8StringLiteral(TESTDATA_DIR"/complete_completer_main.cpp"),
|
|
projectPart.projectPartId()};
|
|
ClangBackEnd::ProjectParts projects;
|
|
ClangBackEnd::UnsavedFiles unsavedFiles;
|
|
ClangBackEnd::TranslationUnits translationUnits{projects, unsavedFiles};
|
|
ClangBackEnd::TranslationUnit translationUnit;
|
|
ClangBackEnd::CodeCompleter completer;
|
|
ClangBackEnd::FileContainer unsavedMainFileContainer{mainFileContainer.filePath(),
|
|
projectPart.projectPartId(),
|
|
readFileContent(QStringLiteral("/complete_completer_main_unsaved.cpp")),
|
|
true};
|
|
ClangBackEnd::FileContainer unsavedTargetHeaderFileContainer{targetHeaderPath,
|
|
projectPart.projectPartId(),
|
|
readFileContent(QStringLiteral("/complete_target_header_unsaved.h")),
|
|
true};
|
|
|
|
ClangBackEnd::FileContainer arrowFileContainer{
|
|
Utf8StringLiteral(TESTDATA_DIR"/complete_arrow.cpp"),
|
|
projectPart.projectPartId(),
|
|
readFileContent(QStringLiteral("/complete_arrow.cpp")),
|
|
true
|
|
};
|
|
ClangBackEnd::FileContainer dotArrowCorrectionForPointerFileContainer{
|
|
Utf8StringLiteral(TESTDATA_DIR"/complete_withDotArrowCorrectionForPointer.cpp"),
|
|
projectPart.projectPartId(),
|
|
readFileContent(QStringLiteral("/complete_withDotArrowCorrectionForPointer.cpp")),
|
|
true
|
|
};
|
|
ClangBackEnd::FileContainer noDotArrowCorrectionForObjectFileContainer{
|
|
Utf8StringLiteral(TESTDATA_DIR"/complete_withNoDotArrowCorrectionForObject.cpp"),
|
|
projectPart.projectPartId(),
|
|
readFileContent(QStringLiteral("/complete_withNoDotArrowCorrectionForObject.cpp")),
|
|
true
|
|
};
|
|
ClangBackEnd::FileContainer noDotArrowCorrectionForFloatFileContainer{
|
|
Utf8StringLiteral(TESTDATA_DIR"/complete_withNoDotArrowCorrectionForFloat.cpp"),
|
|
projectPart.projectPartId(),
|
|
readFileContent(QStringLiteral("/complete_withNoDotArrowCorrectionForFloat.cpp")),
|
|
true
|
|
};
|
|
ClangBackEnd::FileContainer noDotArrowCorrectionForObjectWithArrowOperatortFileContainer{
|
|
Utf8StringLiteral(TESTDATA_DIR"/complete_withNoDotArrowCorrectionForObjectWithArrowOperator.cpp"),
|
|
projectPart.projectPartId(),
|
|
readFileContent(QStringLiteral("/complete_withNoDotArrowCorrectionForObjectWithArrowOperator.cpp")),
|
|
true
|
|
};
|
|
ClangBackEnd::FileContainer noDotArrowCorrectionForDotDotFileContainer{
|
|
Utf8StringLiteral(TESTDATA_DIR"/complete_withNoDotArrowCorrectionForDotDot.cpp"),
|
|
projectPart.projectPartId(),
|
|
readFileContent(QStringLiteral("/complete_withNoDotArrowCorrectionForDotDot.cpp")),
|
|
true
|
|
};
|
|
ClangBackEnd::FileContainer noDotArrowCorrectionForArrowDotFileContainer{
|
|
Utf8StringLiteral(TESTDATA_DIR"/complete_withNoDotArrowCorrectionForArrowDot.cpp"),
|
|
projectPart.projectPartId(),
|
|
readFileContent(QStringLiteral("/complete_withNoDotArrowCorrectionForArrowDot.cpp")),
|
|
true
|
|
};
|
|
ClangBackEnd::FileContainer noDotArrowCorrectionForOnlyDotContainer{
|
|
Utf8StringLiteral(TESTDATA_DIR"/complete_withNoDotArrowCorrectionForOnlyDot.cpp"),
|
|
projectPart.projectPartId(),
|
|
readFileContent(QStringLiteral("/complete_withNoDotArrowCorrectionForOnlyDot.cpp")),
|
|
true
|
|
};
|
|
};
|
|
|
|
Utf8String CodeCompleter::readFileContent(const QString &fileName)
|
|
{
|
|
QFile readFileContentFile(QStringLiteral(TESTDATA_DIR) + fileName);
|
|
bool hasOpened = readFileContentFile.open(QIODevice::ReadOnly | QIODevice::Text);
|
|
|
|
EXPECT_TRUE(hasOpened);
|
|
|
|
return Utf8String::fromByteArray(readFileContentFile.readAll());
|
|
}
|
|
|
|
void CodeCompleter::copyTargetHeaderToTemporaryIncludeDirecory()
|
|
{
|
|
QFile::remove(targetHeaderPath);
|
|
bool hasCopied = QFile::copy(QString::fromUtf8(TESTDATA_DIR "/complete_target_header.h"),
|
|
targetHeaderPath);
|
|
EXPECT_TRUE(hasCopied);
|
|
}
|
|
|
|
void CodeCompleter::copyChangedTargetHeaderToTemporaryIncludeDirecory()
|
|
{
|
|
QFile::remove(targetHeaderPath);
|
|
bool hasCopied = QFile::copy(QString::fromUtf8(TESTDATA_DIR "/complete_target_header_changed.h"),
|
|
targetHeaderPath);
|
|
EXPECT_TRUE(hasCopied);
|
|
}
|
|
|
|
void CodeCompleter::SetUp()
|
|
{
|
|
EXPECT_TRUE(includeDirectory.isValid());
|
|
projects.createOrUpdate({projectPart});
|
|
translationUnits.create({mainFileContainer});
|
|
translationUnit = translationUnits.translationUnit(mainFileContainer);
|
|
completer = ClangBackEnd::CodeCompleter(translationUnit);
|
|
|
|
copyTargetHeaderToTemporaryIncludeDirecory();
|
|
|
|
translationUnit.cxTranslationUnit(); // initialize translation unit so we check changes
|
|
}
|
|
|
|
TEST_F(CodeCompleter, FunctionInUnsavedFile)
|
|
{
|
|
unsavedFiles.createOrUpdate({unsavedMainFileContainer});
|
|
translationUnits.update({unsavedMainFileContainer});
|
|
|
|
ASSERT_THAT(completer.complete(27, 1),
|
|
AllOf(Contains(IsCodeCompletion(Utf8StringLiteral("FunctionWithArguments"),
|
|
CodeCompletion::FunctionCompletionKind)),
|
|
Contains(IsCodeCompletion(Utf8StringLiteral("Function"),
|
|
CodeCompletion::FunctionCompletionKind)),
|
|
Contains(IsCodeCompletion(Utf8StringLiteral("UnsavedFunction"),
|
|
CodeCompletion::FunctionCompletionKind)),
|
|
Contains(IsCodeCompletion(Utf8StringLiteral("f"),
|
|
CodeCompletion::FunctionCompletionKind)),
|
|
Not(Contains(IsCodeCompletion(Utf8StringLiteral("SavedFunction"),
|
|
CodeCompletion::FunctionCompletionKind)))));
|
|
}
|
|
|
|
TEST_F(CodeCompleter, VariableInUnsavedFile)
|
|
{
|
|
unsavedFiles.createOrUpdate({unsavedMainFileContainer});
|
|
translationUnits.update({unsavedMainFileContainer});
|
|
|
|
ASSERT_THAT(completer.complete(27, 1),
|
|
Contains(IsCodeCompletion(Utf8StringLiteral("VariableInUnsavedFile"),
|
|
CodeCompletion::VariableCompletionKind)));
|
|
}
|
|
|
|
TEST_F(CodeCompleter, GlobalVariableInUnsavedFile)
|
|
{
|
|
unsavedFiles.createOrUpdate({unsavedMainFileContainer});
|
|
translationUnits.update({unsavedMainFileContainer});
|
|
|
|
ASSERT_THAT(completer.complete(27, 1),
|
|
Contains(IsCodeCompletion(Utf8StringLiteral("GlobalVariableInUnsavedFile"),
|
|
CodeCompletion::VariableCompletionKind)));
|
|
}
|
|
|
|
TEST_F(CodeCompleter, Macro)
|
|
{
|
|
unsavedFiles.createOrUpdate({unsavedMainFileContainer});
|
|
translationUnits.update({unsavedMainFileContainer});
|
|
|
|
ASSERT_THAT(completer.complete(27, 1),
|
|
Contains(IsCodeCompletion(Utf8StringLiteral("Macro"),
|
|
CodeCompletion::PreProcessorCompletionKind)));
|
|
}
|
|
|
|
TEST_F(CodeCompleter, Keyword)
|
|
{
|
|
ASSERT_THAT(completer.complete(27, 1),
|
|
Contains(IsCodeCompletion(Utf8StringLiteral("switch"),
|
|
CodeCompletion::KeywordCompletionKind)));
|
|
}
|
|
|
|
TEST_F(CodeCompleter, FunctionInIncludedHeader)
|
|
{
|
|
ASSERT_THAT(completer.complete(27, 1),
|
|
Contains(IsCodeCompletion(Utf8StringLiteral("FunctionInIncludedHeader"),
|
|
CodeCompletion::FunctionCompletionKind)));
|
|
}
|
|
|
|
TEST_F(CodeCompleter, FunctionInUnsavedIncludedHeader)
|
|
{
|
|
unsavedFiles.createOrUpdate({unsavedTargetHeaderFileContainer});
|
|
translationUnits.create({unsavedTargetHeaderFileContainer});
|
|
|
|
ASSERT_THAT(completer.complete(27, 1),
|
|
Contains(IsCodeCompletion(Utf8StringLiteral("FunctionInIncludedHeaderUnsaved"),
|
|
CodeCompletion::FunctionCompletionKind)));
|
|
}
|
|
|
|
TEST_F(CodeCompleter, DISABLED_FunctionInChangedIncludedHeader)
|
|
{
|
|
copyChangedTargetHeaderToTemporaryIncludeDirecory();
|
|
|
|
ASSERT_THAT(completer.complete(27, 1),
|
|
Contains(IsCodeCompletion(Utf8StringLiteral("FunctionInIncludedHeaderChanged"),
|
|
CodeCompletion::FunctionCompletionKind)));
|
|
}
|
|
|
|
TEST_F(CodeCompleter, DISABLED_FunctionInChangedIncludedHeaderWithUnsavedContentInMainFile) // it's not that bad because we reparse anyway
|
|
{
|
|
unsavedFiles.createOrUpdate({unsavedMainFileContainer});
|
|
translationUnits.update({unsavedMainFileContainer});
|
|
|
|
copyChangedTargetHeaderToTemporaryIncludeDirecory();
|
|
|
|
ASSERT_THAT(completer.complete(27, 1),
|
|
Contains(IsCodeCompletion(Utf8StringLiteral("FunctionInIncludedHeaderChanged"),
|
|
CodeCompletion::FunctionCompletionKind)));
|
|
}
|
|
|
|
TEST_F(CodeCompleter, ArrowCompletion)
|
|
{
|
|
auto myCompleter = setupCompleter(arrowFileContainer);
|
|
|
|
const ClangBackEnd::CodeCompletions completions = myCompleter.complete(5, 10);
|
|
|
|
ASSERT_THAT(completions,
|
|
Contains(IsCodeCompletion(Utf8StringLiteral("member"),
|
|
CodeCompletion::VariableCompletionKind)));
|
|
ASSERT_THAT(myCompleter.neededCorrection(),
|
|
ClangBackEnd::CompletionCorrection::NoCorrection);
|
|
}
|
|
|
|
TEST_F(CodeCompleter, DotToArrowCompletionForPointer)
|
|
{
|
|
auto myCompleter = setupCompleter(dotArrowCorrectionForPointerFileContainer);
|
|
|
|
const ClangBackEnd::CodeCompletions completions = myCompleter.complete(5, 9);
|
|
|
|
ASSERT_THAT(completions,
|
|
Contains(IsCodeCompletion(Utf8StringLiteral("member"),
|
|
CodeCompletion::VariableCompletionKind)));
|
|
ASSERT_THAT(myCompleter.neededCorrection(),
|
|
ClangBackEnd::CompletionCorrection::DotToArrowCorrection);
|
|
}
|
|
|
|
TEST_F(CodeCompleter, NoDotToArrowCompletionForObject)
|
|
{
|
|
auto myCompleter = setupCompleter(noDotArrowCorrectionForObjectFileContainer);
|
|
|
|
const ClangBackEnd::CodeCompletions completions = myCompleter.complete(5, 9);
|
|
|
|
ASSERT_THAT(completions,
|
|
Contains(IsCodeCompletion(Utf8StringLiteral("member"),
|
|
CodeCompletion::VariableCompletionKind)));
|
|
ASSERT_THAT(myCompleter.neededCorrection(), ClangBackEnd::CompletionCorrection::NoCorrection);
|
|
}
|
|
|
|
TEST_F(CodeCompleter, NoDotToArrowCompletionForFloat)
|
|
{
|
|
auto myCompleter = setupCompleter(noDotArrowCorrectionForFloatFileContainer);
|
|
|
|
const ClangBackEnd::CodeCompletions completions = myCompleter.complete(3, 18);
|
|
|
|
ASSERT_TRUE(completions.isEmpty());
|
|
ASSERT_THAT(myCompleter.neededCorrection(), ClangBackEnd::CompletionCorrection::NoCorrection);
|
|
}
|
|
|
|
TEST_F(CodeCompleter, NoDotArrowCorrectionForObjectWithArrowOperator)
|
|
{
|
|
auto myCompleter = setupCompleter(noDotArrowCorrectionForObjectWithArrowOperatortFileContainer);
|
|
|
|
const ClangBackEnd::CodeCompletions completions = myCompleter.complete(8, 9);
|
|
|
|
ASSERT_THAT(completions,
|
|
Contains(IsCodeCompletion(Utf8StringLiteral("member"),
|
|
CodeCompletion::VariableCompletionKind)));
|
|
ASSERT_THAT(myCompleter.neededCorrection(), ClangBackEnd::CompletionCorrection::NoCorrection);
|
|
}
|
|
|
|
TEST_F(CodeCompleter, NoDotArrowCorrectionForDotDot)
|
|
{
|
|
auto myCompleter = setupCompleter(noDotArrowCorrectionForDotDotFileContainer);
|
|
|
|
const ClangBackEnd::CodeCompletions completions = myCompleter.complete(5, 10);
|
|
|
|
ASSERT_TRUE(completions.isEmpty());
|
|
ASSERT_THAT(myCompleter.neededCorrection(), ClangBackEnd::CompletionCorrection::NoCorrection);
|
|
}
|
|
|
|
TEST_F(CodeCompleter, NoDotArrowCorrectionForArrowDot)
|
|
{
|
|
auto myCompleter = setupCompleter(noDotArrowCorrectionForArrowDotFileContainer);
|
|
|
|
const ClangBackEnd::CodeCompletions completions = myCompleter.complete(5, 11);
|
|
|
|
ASSERT_TRUE(completions.isEmpty());
|
|
ASSERT_THAT(myCompleter.neededCorrection(), ClangBackEnd::CompletionCorrection::NoCorrection);
|
|
}
|
|
|
|
TEST_F(CodeCompleter, NoDotArrowCorrectionForOnlyDot)
|
|
{
|
|
auto myCompleter = setupCompleter(noDotArrowCorrectionForOnlyDotContainer);
|
|
|
|
const ClangBackEnd::CodeCompletions completions = myCompleter.complete(5, 6);
|
|
|
|
ASSERT_THAT(completions,
|
|
Contains(IsCodeCompletion(Utf8StringLiteral("Foo"),
|
|
CodeCompletion::ClassCompletionKind)));
|
|
ASSERT_THAT(myCompleter.neededCorrection(), ClangBackEnd::CompletionCorrection::NoCorrection);
|
|
}
|
|
|
|
ClangBackEnd::CodeCompleter CodeCompleter::setupCompleter(
|
|
const ClangBackEnd::FileContainer &fileContainer)
|
|
{
|
|
translationUnits.create({fileContainer});
|
|
unsavedFiles.createOrUpdate({fileContainer});
|
|
|
|
return ClangBackEnd::CodeCompleter(translationUnits.translationUnit(fileContainer));
|
|
}
|
|
|
|
}
|