Files
swift-mirror/include/swift/IDE/ArgumentCompletion.h
Alex Hoppen 2392117a2d [CodeCompletion] Record solution-specific variable types in argument completion
We are doing global completion for function arguments, so we should also record the variable types determined by the solution.
2022-03-25 10:42:08 +01:00

91 lines
3.6 KiB
C++

//===--- ArgumentCompletion.h -----------------------------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2022 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See https://swift.org/LICENSE.txt for license information
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//
#ifndef SWIFT_IDE_ARGUMENTCOMPLETION_H
#define SWIFT_IDE_ARGUMENTCOMPLETION_H
#include "swift/IDE/CodeCompletionConsumer.h"
#include "swift/IDE/CodeCompletionContext.h"
#include "swift/IDE/PossibleParamInfo.h"
#include "swift/IDE/TypeCheckCompletionCallback.h"
namespace swift {
namespace ide {
class ArgumentTypeCheckCompletionCallback : public TypeCheckCompletionCallback {
struct Result {
/// The type associated with the code completion expression itself.
Type ExpectedType;
/// True if this is a subscript rather than a function call.
bool IsSubscript;
/// The FuncDecl or SubscriptDecl associated with the call.
ValueDecl *FuncD;
/// The type of the function being called.
Type FuncTy;
/// The index of the argument containing the completion location
unsigned ArgIdx;
/// The index of the parameter corresponding to the completion argument.
Optional<unsigned> ParamIdx;
/// The indices of all params that were bound to non-synthesized
/// arguments. Used so we don't suggest them even when the args are out of
/// order.
std::set<unsigned> ClaimedParamIndices;
/// True if the completion is a noninitial term in a variadic argument.
bool IsNoninitialVariadic;
/// The base type of the call/subscript (null for free functions).
Type BaseType;
/// True if an argument label precedes the completion location.
bool HasLabel;
/// Whether the surrounding context is async and thus calling async
/// functions is supported.
bool IsInAsyncContext;
/// Types of variables that were determined in the solution that produced
/// this result. This in particular includes parameters of closures that
/// were type-checked with the code completion expression.
llvm::SmallDenseMap<const VarDecl *, Type> SolutionSpecificVarTypes;
};
CodeCompletionExpr *CompletionExpr;
DeclContext *DC;
SmallVector<Result, 4> Results;
/// Populates a vector of parameters to suggest along with a vector of types
/// to match the lookup results against.
///
/// \Returns true if global lookup should be performed.
bool addPossibleParams(const ArgumentTypeCheckCompletionCallback::Result &Res,
SmallVectorImpl<PossibleParamInfo> &Params,
SmallVectorImpl<Type> &Types);
void sawSolutionImpl(const constraints::Solution &solution) override;
public:
ArgumentTypeCheckCompletionCallback(CodeCompletionExpr *CompletionExpr,
DeclContext *DC)
: CompletionExpr(CompletionExpr), DC(DC) {}
/// \param IncludeSignature Whether to include a suggestion for the entire
/// function signature instead of suggesting individual labels. Used when
/// completing after the opening '(' of a function call \param Loc The
/// location of the code completion token
void deliverResults(bool IncludeSignature, SourceLoc Loc, DeclContext *DC,
CodeCompletionContext &CompletionCtx,
CodeCompletionConsumer &Consumer);
};
} // end namespace ide
} // end namespace swift
#endif // SWIFT_IDE_ARGUMENTCOMPLETION_H