Skip to content

[CodeCompletion] Suggest 'Self' inside struct, enum and classe #32053

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 3, 2020
Merged

[CodeCompletion] Suggest 'Self' inside struct, enum and classe #32053

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 50 additions & 2 deletions lib/IDE/CodeCompletion.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4491,6 +4491,51 @@ class CompletionLookup final : public swift::VisibleDeclConsumer {
getAttributeDeclParamCompletions(DAK_Available, 0);
}

void getSelfTypeCompletionInDeclContext(SourceLoc Loc, bool isForDeclResult) {
const DeclContext *typeDC = CurrDeclContext->getInnermostTypeContext();
if (!typeDC)
return;

// For protocols, there's a 'Self' generic parameter.
if (typeDC->getSelfProtocolDecl())
return;

Type selfType =
CurrDeclContext->mapTypeIntoContext(typeDC->getSelfInterfaceType());

if (typeDC->getSelfClassDecl()) {
// In classes, 'Self' can be used in result type of func, subscript and
// computed property, or inside function bodies.
bool canUseDynamicSelf = false;
if (isForDeclResult) {
canUseDynamicSelf = true;
} else {
const auto *checkDC = CurrDeclContext;
if (isa<TypeAliasDecl>(checkDC))
checkDC = checkDC->getParent();

if (const auto *AFD = checkDC->getInnermostMethodContext()) {
canUseDynamicSelf = Ctx.SourceMgr.rangeContainsTokenLoc(
AFD->getBodySourceRange(), Loc);
}
}
if (!canUseDynamicSelf)
return;
// 'Self' in class is a dynamic type.
selfType = DynamicSelfType::get(selfType, Ctx);
} else {
// In enums and structs, 'Self' is just an alias for the nominal type,
// and can be used anywhere.
}

CodeCompletionResultBuilder Builder(
Sink, CodeCompletionResult::ResultKind::Keyword,
SemanticContextKind::CurrentNominal, expectedTypeContext);
Builder.addKeyword("Self");
Builder.setKeywordKind(CodeCompletionKeywordKind::kw_Self);
addTypeAnnotation(Builder, selfType);
}

void getTypeCompletionsInDeclContext(SourceLoc Loc,
bool ModuleQualifier = true) {
Kind = LookupKind::TypeInDeclContext;
Expand Down Expand Up @@ -5783,6 +5828,7 @@ void CodeCompletionCallbacksImpl::doneParsing() {
auto DoPostfixExprBeginning = [&] (){
SourceLoc Loc = P.Context.SourceMgr.getCodeCompletionLoc();
Lookup.getValueCompletionsInDeclContext(Loc);
Lookup.getSelfTypeCompletionInDeclContext(Loc, /*isForDeclResult=*/false);
};

switch (Kind) {
Expand Down Expand Up @@ -5933,8 +5979,10 @@ void CodeCompletionCallbacksImpl::doneParsing() {

case CompletionKind::TypeDeclResultBeginning:
case CompletionKind::TypeSimpleBeginning: {
Lookup.getTypeCompletionsInDeclContext(
P.Context.SourceMgr.getCodeCompletionLoc());
auto Loc = Context.SourceMgr.getCodeCompletionLoc();
Lookup.getTypeCompletionsInDeclContext(Loc);
Lookup.getSelfTypeCompletionInDeclContext(
Loc, Kind == CompletionKind::TypeDeclResultBeginning);
break;
}

Expand Down
223 changes: 223 additions & 0 deletions test/IDE/complete_sself.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,223 @@
// RUN: %swift-ide-test -code-completion -source-filename %s -code-completion-token=GLOBAL_BODY_EXPR | %FileCheck %s --check-prefix=NOSELF
// RUN: %swift-ide-test -code-completion -source-filename %s -code-completion-token=GLOBAL_BODY_TYPE | %FileCheck %s --check-prefix=NOSELF
// RUN: %swift-ide-test -code-completion -source-filename %s -code-completion-token=GLOBAL_VARBODY_EXPR | %FileCheck %s --check-prefix=NOSELF
// RUN: %swift-ide-test -code-completion -source-filename %s -code-completion-token=GLOBAL_FUNC_PARAMTYPE | %FileCheck %s --check-prefix=NOSELF
// RUN: %swift-ide-test -code-completion -source-filename %s -code-completion-token=GLOBAL_FUNC_DEFAULTEXPR | %FileCheck %s --check-prefix=NOSELF
// RUN: %swift-ide-test -code-completion -source-filename %s -code-completion-token=GLOBAL_FUNC_RESULTTYPE | %FileCheck %s --check-prefix=NOSELF

// RUN: %swift-ide-test -code-completion -source-filename %s -code-completion-token=PROTOCOL_FUNC_PARAMTYPE | %FileCheck %s --check-prefix=GENERICPARAM
// RUN: %swift-ide-test -code-completion -source-filename %s -code-completion-token=PROTOCOL_FUNC_RESULTTYPE | %FileCheck %s --check-prefix=GENERICPARAM
// RUN: %swift-ide-test -code-completion -source-filename %s -code-completion-token=PROTOCOL_SUBSCRIPT_PARAMTYPE | %FileCheck %s --check-prefix=GENERICPARAM
// RUN: %swift-ide-test -code-completion -source-filename %s -code-completion-token=PROTOCOL_SUBSCRIPT_RESULTTYPE | %FileCheck %s --check-prefix=GENERICPARAM
// RUN: %swift-ide-test -code-completion -source-filename %s -code-completion-token=PROTOCOL_VAR_TYPE | %FileCheck %s --check-prefix=GENERICPARAM

// RUN: %swift-ide-test -code-completion -source-filename %s -code-completion-token=PROTOEXT_FUNC_PARAMTYPE | %FileCheck %s --check-prefix=GENERICPARAM
// RUN: %swift-ide-test -code-completion -source-filename %s -code-completion-token=PROTOEXT_FUNC_DEFAULTEXPR | %FileCheck %s --check-prefix=GENERICPARAM
// RUN: %swift-ide-test -code-completion -source-filename %s -code-completion-token=PROTOEXT_FUNC_RESULTTYPE | %FileCheck %s --check-prefix=GENERICPARAM
// RUN: %swift-ide-test -code-completion -source-filename %s -code-completion-token=PROTOEXT_SUBSCRIPT_PARAMTYPE | %FileCheck %s --check-prefix=GENERICPARAM
// RUN: %swift-ide-test -code-completion -source-filename %s -code-completion-token=PROTOEXT_SUBSCRIPT_RESULTTYPE | %FileCheck %s --check-prefix=GENERICPARAM
// RUN: %swift-ide-test -code-completion -source-filename %s -code-completion-token=PROTOEXT_VAR_TYPE | %FileCheck %s --check-prefix=GENERICPARAM
// RUN: %swift-ide-test -code-completion -source-filename %s -code-completion-token=PROTOEXT_BODY_EXPR | %FileCheck %s --check-prefix=GENERICPARAM
// RUN: %swift-ide-test -code-completion -source-filename %s -code-completion-token=PROTOEXT_BODY_TYPE | %FileCheck %s --check-prefix=GENERICPARAM
// RUN: %swift-ide-test -code-completion -source-filename %s -code-completion-token=PROTOEXT_VARBODY_EXPR | %FileCheck %s --check-prefix=GENERICPARAM

// RUN: %swift-ide-test -code-completion -source-filename %s -code-completion-token=STRUCT_FUNC_PARAMTYPE | %FileCheck %s --check-prefix=STATICSELF
// RUN: %swift-ide-test -code-completion -source-filename %s -code-completion-token=STRUCT_FUNC_DEFAULTEXPR | %FileCheck %s --check-prefix=STATICSELF
// RUN: %swift-ide-test -code-completion -source-filename %s -code-completion-token=STRUCT_FUNC_RESULTTYPE | %FileCheck %s --check-prefix=STATICSELF
// RUN: %swift-ide-test -code-completion -source-filename %s -code-completion-token=STRUCT_SUBSCRIPT_PARAMTYPE | %FileCheck %s --check-prefix=STATICSELF
// RUN: %swift-ide-test -code-completion -source-filename %s -code-completion-token=STRUCT_SUBSCRIPT_RESULTTYPE | %FileCheck %s --check-prefix=STATICSELF
// RUN: %swift-ide-test -code-completion -source-filename %s -code-completion-token=STRUCT_VAR_TYPE | %FileCheck %s --check-prefix=STATICSELF
// RUN: %swift-ide-test -code-completion -source-filename %s -code-completion-token=STRUCT_BODY_EXPR | %FileCheck %s --check-prefix=STATICSELF
// RUN: %swift-ide-test -code-completion -source-filename %s -code-completion-token=STRUCT_BODY_TYPE | %FileCheck %s --check-prefix=STATICSELF
// RUN: %swift-ide-test -code-completion -source-filename %s -code-completion-token=STRUCT_VARBODY_EXPR | %FileCheck %s --check-prefix=STATICSELF

// RUN: %swift-ide-test -code-completion -source-filename %s -code-completion-token=STRUCTEXT_FUNC_PARAMTYPE | %FileCheck %s --check-prefix=STATICSELF
// RUN: %swift-ide-test -code-completion -source-filename %s -code-completion-token=STRUCTEXT_FUNC_DEFAULTEXPR | %FileCheck %s --check-prefix=STATICSELF
// RUN: %swift-ide-test -code-completion -source-filename %s -code-completion-token=STRUCTEXT_FUNC_RESULTTYPE | %FileCheck %s --check-prefix=STATICSELF
// RUN: %swift-ide-test -code-completion -source-filename %s -code-completion-token=STRUCTEXT_SUBSCRIPT_PARAMTYPE | %FileCheck %s --check-prefix=STATICSELF
// RUN: %swift-ide-test -code-completion -source-filename %s -code-completion-token=STRUCTEXT_SUBSCRIPT_RESULTTYPE | %FileCheck %s --check-prefix=STATICSELF
// RUN: %swift-ide-test -code-completion -source-filename %s -code-completion-token=STRUCTEXT_VAR_TYPE | %FileCheck %s --check-prefix=STATICSELF
// RUN: %swift-ide-test -code-completion -source-filename %s -code-completion-token=STRUCTEXT_BODY_EXPR | %FileCheck %s --check-prefix=STATICSELF
// RUN: %swift-ide-test -code-completion -source-filename %s -code-completion-token=STRUCTEXT_BODY_TYPE | %FileCheck %s --check-prefix=STATICSELF
// RUN: %swift-ide-test -code-completion -source-filename %s -code-completion-token=STRUCTEXT_VARBODY_EXPR | %FileCheck %s --check-prefix=STATICSELF

// RUN: %swift-ide-test -code-completion -source-filename %s -code-completion-token=CLASS_FUNC_PARAMTYPE | %FileCheck %s --check-prefix=NOSELF
// RUN: %swift-ide-test -code-completion -source-filename %s -code-completion-token=CLASS_FUNC_DEFAULTEXPR | %FileCheck %s --check-prefix=NOSELF
// RUN: %swift-ide-test -code-completion -source-filename %s -code-completion-token=CLASS_FUNC_RESULTTYPE | %FileCheck %s --check-prefix=DYNAMICSELF
// RUN: %swift-ide-test -code-completion -source-filename %s -code-completion-token=CLASS_SUBSCRIPT_PARAMTYPE | %FileCheck %s --check-prefix=NOSELF
// RUN: %swift-ide-test -code-completion -source-filename %s -code-completion-token=CLASS_SUBSCRIPT_RESULTTYPE | %FileCheck %s --check-prefix=DYNAMICSELF
// RUN: %swift-ide-test -code-completion -source-filename %s -code-completion-token=CLASS_VAR_TYPE | %FileCheck %s --check-prefix=DYNAMICSELF
// RUN: %swift-ide-test -code-completion -source-filename %s -code-completion-token=CLASS_BODY_EXPR | %FileCheck %s --check-prefix=DYNAMICSELF
// RUN: %swift-ide-test -code-completion -source-filename %s -code-completion-token=CLASS_BODY_TYPE | %FileCheck %s --check-prefix=DYNAMICSELF
// RUN: %swift-ide-test -code-completion -source-filename %s -code-completion-token=CLASS_VARBODY_EXPR | %FileCheck %s --check-prefix=DYNAMICSELF

// RUN: %swift-ide-test -code-completion -source-filename %s -code-completion-token=CLASSEXT_FUNC_PARAMTYPE | %FileCheck %s --check-prefix=NOSELF
// RUN: %swift-ide-test -code-completion -source-filename %s -code-completion-token=CLASSEXT_FUNC_DEFAULTEXPR | %FileCheck %s --check-prefix=NOSELF
// RUN: %swift-ide-test -code-completion -source-filename %s -code-completion-token=CLASSEXT_FUNC_RESULTTYPE | %FileCheck %s --check-prefix=DYNAMICSELF
// RUN: %swift-ide-test -code-completion -source-filename %s -code-completion-token=CLASSEXT_SUBSCRIPT_PARAMTYPE | %FileCheck %s --check-prefix=NOSELF
// RUN: %swift-ide-test -code-completion -source-filename %s -code-completion-token=CLASSEXT_SUBSCRIPT_RESULTTYPE | %FileCheck %s --check-prefix=DYNAMICSELF
// RUN: %swift-ide-test -code-completion -source-filename %s -code-completion-token=CLASSEXT_VAR_TYPE | %FileCheck %s --check-prefix=DYNAMICSELF
// RUN: %swift-ide-test -code-completion -source-filename %s -code-completion-token=CLASSEXT_BODY_EXPR | %FileCheck %s --check-prefix=DYNAMICSELF
// RUN: %swift-ide-test -code-completion -source-filename %s -code-completion-token=CLASSEXT_BODY_TYPE | %FileCheck %s --check-prefix=DYNAMICSELF
// RUN: %swift-ide-test -code-completion -source-filename %s -code-completion-token=CLASSEXT_VARBODY_EXPR | %FileCheck %s --check-prefix=DYNAMICSELF

// RUN: %swift-ide-test -code-completion -source-filename %s -code-completion-token=CLASS_NESTEDBODY_TYPE | %FileCheck %s --check-prefix=DYNAMICSELF
// RUN: %swift-ide-test -code-completion -source-filename %s -code-completion-token=CLASS_NESTEDBODY_EXPR | %FileCheck %s --check-prefix=DYNAMICSELF
// RUN: %swift-ide-test -code-completion -source-filename %s -code-completion-token=CLASS_NESTEDFUNC_PARAMTYPE | %FileCheck %s --check-prefix=DYNAMICSELF
// RUN: %swift-ide-test -code-completion -source-filename %s -code-completion-token=CLASS_NESTEDFUNC_DEFAULTEXPR | %FileCheck %s --check-prefix=DYNAMICSELF
// RUN: %swift-ide-test -code-completion -source-filename %s -code-completion-token=CLASS_NESTEDFUNC_RESULTTYPE | %FileCheck %s --check-prefix=DYNAMICSELF
// RUN: %swift-ide-test -code-completion -source-filename %s -code-completion-token=CLASS_TYPEALIAS_TYPE | %FileCheck %s --check-prefix=DYNAMICSELF
// RUN: %swift-ide-test -code-completion -source-filename %s -code-completion-token=CLASS_NESTEDTYPE_EXPR | %FileCheck %s --check-prefix=DYNAMICSELF
// RUN: %swift-ide-test -code-completion -source-filename %s -code-completion-token=CLASS_NESTEDTYPE_TYPE | %FileCheck %s --check-prefix=DYNAMICSELF

// NOSELF: Begin completions
// NOSELF-NOT: name=Self
// NOSELF: End completions

// GENERICPARAM: Begin completions
// GENERICPARAM: Decl[GenericTypeParam]/Local: Self[#Self#];

// STATICSELF: Begin completions
// STATICSELF: Keyword[Self]/CurrNominal: Self[#S#];

// DYNAMICSELF: Begin completions
// DYNAMICSELF: Keyword[Self]/CurrNominal: Self[#Self#];

func freeFunc() {
#^GLOBAL_BODY_EXPR^#
let _: #^GLOBAL_BODY_TYPE^#
}
var freeVar: String {
"\(#^GLOBAL_VARBODY_EXPR^#)"
}
func freeFunc(x: #^GLOBAL_FUNC_PARAMTYPE^#) {}
func freeFunc(x: Int = #^GLOBAL_FUNC_DEFAULTEXPR^#) {}
func freeFunc(x: Int) -> #^GLOBAL_FUNC_RESULTTYPE^# {}

var x: ^#GLOBAL_VAR_TYPE^#

func sync() {}

protocol P {
func protoMeth(x: #^PROTOCOL_FUNC_PARAMTYPE^#)
func protoMeth(x: Int) -> #^PROTOCOL_FUNC_RESULTTYPE^#

subscript(x: #^PROTOCOL_SUBSCRIPT_PARAMTYPE^#) -> Int { get }
subscript(y: Int) -> #^PROTOCOL_SUBSCRIPT_RESULTTYPE^# { get }

var x: #^PROTOCOL_VAR_TYPE^#
}
extension P {
func method(x: #^PROTOEXT_FUNC_PARAMTYPE^#) { }
func method(x: Int = #^PROTOEXT_FUNC_DEFAULTEXPR^#) { }
func method(x: Int) -> #^PROTOEXT_FUNC_RESULTTYPE^# { }

subscript(x: #^PROTOEXT_SUBSCRIPT_PARAMTYPE^#) -> Int { }
subscript(y: Int) -> #^PROTOEXT_SUBSCRIPT_RESULTTYPE^# { }

var x: #^PROTOEXT_VAR_TYPE^# { }

func bodyTest() {
#^PROTOEXT_BODY_EXPR^#
let _: #^PROTOEXT_BODY_TYPE^#
}
var varTest: String {
"\(#^PROTOEXT_VARBODY_EXPR^#)"
}
}

struct S {
func method(x: #^STRUCT_FUNC_PARAMTYPE^#)
func method(x: Int = #^STRUCT_FUNC_DEFAULTEXPR^#) { }
func method(x: Int) -> #^STRUCT_FUNC_RESULTTYPE^#

subscript(x: #^STRUCT_SUBSCRIPT_PARAMTYPE^#) -> Int { get }
subscript(y: Int) -> #^STRUCT_SUBSCRIPT_RESULTTYPE^# { get }

var x: #^STRUCT_VAR_TYPE^#

func bodyTest() {
#^STRUCT_BODY_EXPR^#
let _: #^STRUCT_BODY_TYPE^#
}
var varTest: String {
"\(#^STRUCT_VARBODY_EXPR^#)"
}
}
extension S {
func method(x: #^STRUCTEXT_FUNC_PARAMTYPE^#)
func method(x: Int = #^STRUCTEXT_FUNC_DEFAULTEXPR^#) { }
func method(x: Int) -> #^STRUCTEXT_FUNC_RESULTTYPE^#

subscript(x: #^STRUCTEXT_SUBSCRIPT_PARAMTYPE^#) -> Int { get }
subscript(y: Int) -> #^STRUCTEXT_SUBSCRIPT_RESULTTYPE^# { get }

var x: #^STRUCTEXT_VAR_TYPE^#

func bodyTest() {
#^STRUCTEXT_BODY_EXPR^#
let _: #^STRUCTEXT_BODY_TYPE^#
}
var varTest: String {
"\(#^STRUCTEXT_VARBODY_EXPR^#)"
}
}

class C {
func method(x: #^CLASS_FUNC_PARAMTYPE^#)
func method(x: Int = #^CLASS_FUNC_DEFAULTEXPR^#) { }
func method(x: Int) -> #^CLASS_FUNC_RESULTTYPE^#

subscript(x: #^CLASS_SUBSCRIPT_PARAMTYPE^#) -> Int { get }
subscript(y: Int) -> #^CLASS_SUBSCRIPT_RESULTTYPE^# { get }

var x: #^CLASS_VAR_TYPE^#

func bodyTest() {
#^CLASS_BODY_EXPR^#
let _: #^CLASS_BODY_TYPE^#
}
var varTest: String {
"\(#^CLASS_VARBODY_EXPR^#)"
}
}
class CC {}
extension CC {
func method(x: #^CLASSEXT_FUNC_PARAMTYPE^#)
func method(x: Int = #^CLASSEXT_FUNC_DEFAULTEXPR^#) { }
func method(x: Int) -> #^CLASSEXT_FUNC_RESULTTYPE^#

subscript(x: #^CLASSEXT_SUBSCRIPT_PARAMTYPE^#) -> Int { get }
subscript(y: Int) -> #^CLASSEXT_SUBSCRIPT_RESULTTYPE^# { get }

var x: #^CLASSEXT_VAR_TYPE^#

func bodyTest() {
#^CLASSEXT_BODY_EXPR^#
let _: #^CLASSEXT_BODY_TYPE^#
}
var varTest: String {
"\(#^CLASSEXT_VARBODY_EXPR^#)"
}
}

class CCC {
func bodyTest() {
func inner() {
#^CLASS_NESTEDBODY_EXPR^#
let _: #^CLASS_NESTEDBODY_TYPE^#
}

func inner(x: #^CLASS_NESTEDFUNC_PARAMTYPE^#) {}
func inner(y: Int = #^CLASS_NESTEDFUNC_DEFAULTEXPR^#) {}
func inner() -> #^CLASS_NESTEDFUNC_RESULTTYPE^# {}

typealias A<T> = #^CLASS_TYPEALIAS_TYPE^#
}
class Inner {
func method() {
#^CLASS_NESTEDTYPE_EXPR^#
let _: #^CLASS_NESTEDTYPE_TYPE^#
}
}
}