blob: 49c484ffa69f7c854f34d72db6b01a8597f34919 [file] [log] [blame]
//===--- REPLCodeCompletion.h - Code completion for REPL --------*- C++ -*-===//
// This source file is part of the open source project
// Copyright (c) 2014 - 2017 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
// See for license information
// See for the list of Swift project authors
// This module provides completions to the immediate mode environment.
#include "swift/Basic/LLVM.h"
#include "swift/IDE/CodeCompletion.h"
#include "swift/IDE/CodeCompletionCache.h"
#include "swift/Parse/CodeCompletionCallbacks.h"
#include "llvm/ADT/ArrayRef.h"
#include "llvm/ADT/StringRef.h"
#include <memory>
#include <vector>
#include <string>
#include <utility>
namespace swift {
/// State of a completion operation.
enum class CompletionState {
/// An invalid completion set.
/// No matching completions were found. Subsequent <TAB>s just beep.
/// A unique completion was found. Subsequent <TAB>s just beep.
/// Completions have been looked up and the root has been completed. This is
/// the state after the first <TAB> event. The next <TAB> will display
/// available completions.
/// Displayed the list of available completions. Subsequent <TAB> events will
/// cycle through completing different stems.
/// Represents a completion set and maintains state for navigating through
/// a set of completions.
class REPLCompletions {
struct CookedResult {
StringRef InsertableString;
unsigned NumBytesToErase;
friend class REPLCodeCompletionConsumer;
CompletionState State;
ide::CodeCompletionCache CompletionCache;
ide::CodeCompletionContext CompletionContext;
std::unique_ptr<ide::CodeCompletionConsumer> Consumer;
std::unique_ptr<CodeCompletionCallbacksFactory> CompletionCallbacksFactory;
std::vector<StringRef> CompletionStrings;
std::vector<CookedResult> CookedResults;
std::string Prefix;
mutable Optional<std::string> Root;
size_t CurrentCompletionIdx;
/// Create an invalid completion set.
/// Create completion results for the given string.
void populate(SourceFile &SF, StringRef EnteredCode);
/// Returns true if this is a valid completion set.
explicit operator bool() const { return State != CompletionState::Invalid; }
bool isValid() const { return State != CompletionState::Invalid; }
// True if no completions were found.
bool isEmpty() const { return State == CompletionState::Empty; }
/// True if the completion is unique.
bool isUnique() const { return State == CompletionState::Unique; }
/// Returns the current state of the completion.
CompletionState getState() const { return State; }
/// Sets the state of the completion.
void setState(CompletionState S) { State = S; }
/// Returns the common root of all the found completions (or the entire
/// completion for a unique completion).
StringRef getRoot() const;
/// Returns the stem (if any) returned by the previous \c getNextStem() call.
CookedResult getPreviousStem() const;
/// Returns the next completion stem. Cycles to the beginning of the list if
/// the end was reached.
CookedResult getNextStem();
/// Returns a list of all complete names for which completions were found.
ArrayRef<StringRef> getCompletionList() const {
return CompletionStrings;
/// Reset the completion set to an invalid state.
void reset();
} // namespace swift