mirror of
https://github.com/apple/swift.git
synced 2025-12-14 20:36:38 +01:00
ca92efc8e6
Correct format: ``` //===--- Name of file - Description ----------------------------*- Lang -*-===// ``` Notes: * Comment line should be exactly 80 chars. * Padding: Pad with dashes after "Description" to reach 80 chars. * "Name of file", "Description" and "Lang" are all optional. * In case of missing "Lang": drop the "-*-" markers. * In case of missing space: drop one, two or three dashes before "Name of file".
121 lines
3.8 KiB
C++
121 lines
3.8 KiB
C++
//===--- REPLCodeCompletion.h - Code completion for REPL --------*- C++ -*-===//
|
|
//
|
|
// This source file is part of the Swift.org open source project
|
|
//
|
|
// Copyright (c) 2014 - 2016 Apple Inc. and the Swift project authors
|
|
// Licensed under Apache License v2.0 with Runtime Library Exception
|
|
//
|
|
// See http://swift.org/LICENSE.txt for license information
|
|
// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
//
|
|
// This module provides completions to the immediate mode environment.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef SWIFT_IDE_REPL_CODE_COMPLETION_H
|
|
#define SWIFT_IDE_REPL_CODE_COMPLETION_H
|
|
|
|
#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.
|
|
Invalid,
|
|
/// No matching completions were found. Subsequent <TAB>s just beep.
|
|
Empty,
|
|
/// A unique completion was found. Subsequent <TAB>s just beep.
|
|
Unique,
|
|
/// 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.
|
|
CompletedRoot,
|
|
/// Displayed the list of available completions. Subsequent <TAB> events will
|
|
/// cycle through completing different stems.
|
|
DisplayedCompletionList
|
|
};
|
|
|
|
/// Represents a completion set and maintains state for navigating through
|
|
/// a set of completions.
|
|
class REPLCompletions {
|
|
public:
|
|
struct CookedResult {
|
|
StringRef InsertableString;
|
|
unsigned NumBytesToErase;
|
|
};
|
|
|
|
private:
|
|
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;
|
|
|
|
public:
|
|
/// Create an invalid completion set.
|
|
REPLCompletions();
|
|
|
|
/// 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
|
|
|
|
#endif // LLVM_SWIFT_IDE_REPL_CODE_COMPLETION_H
|
|
|