1 //===-- llvm/LineEditor/LineEditor.h - line editor --------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 #ifndef LLVM_LINEEDITOR_LINEEDITOR_H
11 #define LLVM_LINEEDITOR_LINEEDITOR_H
13 #include "llvm/ADT/Optional.h"
14 #include "llvm/ADT/OwningPtr.h"
15 #include "llvm/ADT/StringRef.h"
24 /// Create a LineEditor object.
26 /// \param ProgName The name of the current program. Used to form a default
28 /// \param HistoryPath Path to the file in which to store history data, if
30 /// \param In The input stream used by the editor.
31 /// \param Out The output stream used by the editor.
32 /// \param Err The error stream used by the editor.
33 LineEditor(StringRef ProgName, StringRef HistoryPath = "", FILE *In = stdin,
34 FILE *Out = stdout, FILE *Err = stderr);
39 /// \return The line, or llvm::Optional<std::string>() on EOF.
40 llvm::Optional<std::string> readLine() const;
45 static std::string getDefaultHistoryPath(StringRef ProgName);
47 /// The action to perform upon a completion request.
48 struct CompletionAction {
50 /// Insert Text at the cursor position.
52 /// Show Completions, or beep if the list is empty.
58 /// The text to insert.
61 /// The list of completions to show.
62 std::vector<std::string> Completions;
65 /// A possible completion at a given cursor position.
68 Completion(const std::string &TypedText, const std::string &DisplayText)
69 : TypedText(TypedText), DisplayText(DisplayText) {}
71 /// The text to insert. If the user has already input some of the
72 /// completion, this should only include the rest of the text.
73 std::string TypedText;
75 /// A description of this completion. This may be the completion itself, or
76 /// maybe a summary of its type or arguments.
77 std::string DisplayText;
80 /// Set the completer for this LineEditor. A completer is a function object
81 /// which takes arguments of type StringRef (the string to complete) and
82 /// size_t (the zero-based cursor position in the StringRef) and returns a
84 template <typename T> void setCompleter(T Comp) {
85 Completer.reset(new CompleterModel<T>(Comp));
88 /// Set the completer for this LineEditor to the given list completer.
89 /// A list completer is a function object which takes arguments of type
90 /// StringRef (the string to complete) and size_t (the zero-based cursor
91 /// position in the StringRef) and returns a std::vector<Completion>.
92 template <typename T> void setListCompleter(T Comp) {
93 Completer.reset(new ListCompleterModel<T>(Comp));
96 /// Use the current completer to produce a CompletionAction for the given
97 /// completion request. If the current completer is a list completer, this
98 /// will return an AK_Insert CompletionAction if each completion has a common
99 /// prefix, or an AK_ShowCompletions CompletionAction otherwise.
101 /// \param Buffer The string to complete
102 /// \param Pos The zero-based cursor position in the StringRef
103 CompletionAction getCompletionAction(StringRef Buffer, size_t Pos) const;
105 const std::string &getPrompt() const { return Prompt; }
106 void setPrompt(const std::string &P) { Prompt = P; }
108 // Public so callbacks in LineEditor.cpp can use it.
113 std::string HistoryPath;
114 OwningPtr<InternalData> Data;
116 struct CompleterConcept {
117 virtual ~CompleterConcept();
118 virtual CompletionAction complete(StringRef Buffer, size_t Pos) const = 0;
121 struct ListCompleterConcept : CompleterConcept {
122 ~ListCompleterConcept();
123 CompletionAction complete(StringRef Buffer, size_t Pos) const;
124 static std::string getCommonPrefix(const std::vector<Completion> &Comps);
125 virtual std::vector<Completion> getCompletions(StringRef Buffer,
126 size_t Pos) const = 0;
129 template <typename T>
130 struct CompleterModel : CompleterConcept {
131 CompleterModel(T Value) : Value(Value) {}
132 CompletionAction complete(StringRef Buffer, size_t Pos) const {
133 return Value(Buffer, Pos);
138 template <typename T>
139 struct ListCompleterModel : ListCompleterConcept {
140 ListCompleterModel(T Value) : Value(Value) {}
141 std::vector<Completion> getCompletions(StringRef Buffer, size_t Pos) const {
142 return Value(Buffer, Pos);
147 llvm::OwningPtr<const CompleterConcept> Completer;