Replace all occurrences of TextInput with LineEditor

- Update tests as errors/warnings will add a new line in TextInput
- Add `CLING_HISTSIZE` functionality with the newly added LLVM patch.
- Update `cling_history` test to match encoded libedit history

Author: devajithvs

lib/CMakeLists.txt

@@ -8,8 +8,7 @@
 
 add_subdirectory(Interpreter)
 add_subdirectory(MetaProcessor)
-if(EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/UserInterface/textinput OR
-   CLING_INCLUDE_TESTS)
+if(CLING_INCLUDE_TESTS)
    add_subdirectory(UserInterface)
 endif()
 add_subdirectory(Utils)

lib/UserInterface/CMakeLists.txt

@@ -7,40 +7,12 @@
 #------------------------------------------------------------------------------
 
 set( LLVM_LINK_COMPONENTS
+  LineEditor
   support
 )
 
-if(NOT EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/textinput)
-  set(TEXTINPUTSRC ${CMAKE_SOURCE_DIR}/core/textinput/src/)
-  include_directories(${TEXTINPUTSRC})
-else()
-  # For cling, install textinput *.h in include/cling/UserInterface/textinput.
-  install(DIRECTORY ${TEXTINPUTSRC}textinput
-    DESTINATION include/cling/UserInterface
-    FILES_MATCHING
-    PATTERN "CMakeFiles" EXCLUDE
-    PATTERN "*.cpp" EXCLUDE
-    PATTERN "doc" EXCLUDE
-    PATTERN "*.h"
-    )
-endif()
-
 add_cling_library(clingUserInterface
   UserInterface.cpp
-  ${TEXTINPUTSRC}textinput/Editor.cpp
-  ${TEXTINPUTSRC}textinput/History.cpp
-  ${TEXTINPUTSRC}textinput/KeyBinding.cpp
-  ${TEXTINPUTSRC}textinput/Range.cpp
-  ${TEXTINPUTSRC}textinput/SignalHandler.cpp
-  ${TEXTINPUTSRC}textinput/StreamReader.cpp
-  ${TEXTINPUTSRC}textinput/StreamReaderUnix.cpp
-  ${TEXTINPUTSRC}textinput/StreamReaderWin.cpp
-  ${TEXTINPUTSRC}textinput/TerminalConfigUnix.cpp
-  ${TEXTINPUTSRC}textinput/TerminalDisplay.cpp
-  ${TEXTINPUTSRC}textinput/TerminalDisplayUnix.cpp
-  ${TEXTINPUTSRC}textinput/TerminalDisplayWin.cpp
-  ${TEXTINPUTSRC}textinput/TextInput.cpp
-  ${TEXTINPUTSRC}textinput/TextInputContext.cpp
 
   LINK_LIBS
   clingMetaProcessor

lib/UserInterface/UserInterface.cpp

@@ -12,13 +12,9 @@
 #include "cling/Interpreter/Exception.h"
 #include "cling/MetaProcessor/MetaProcessor.h"
 #include "cling/Utils/Output.h"
-#include "textinput/Callbacks.h"
-#include "textinput/History.h"
-#include "textinput/StreamReader.h"
-#include "textinput/TerminalDisplay.h"
-#include "textinput/TextInput.h"
 
 #include "llvm/ADT/SmallString.h"
+#include "llvm/LineEditor/LineEditor.h"
 #include "llvm/Support/ErrorHandling.h"
 #include "llvm/Support/Path.h"
 
@@ -30,44 +26,40 @@ namespace {
   /// to code complete through its own textinput mechanism which is part of the
   /// UserInterface.
   ///
-  class UITabCompletion : public textinput::TabCompletion {
-    const cling::Interpreter& m_ParentInterpreter;
-
-  public:
-    UITabCompletion(const cling::Interpreter& Parent) :
-                    m_ParentInterpreter(Parent) {}
-    ~UITabCompletion() {}
-
-    bool Complete(textinput::Text& Line /*in+out*/,
-                  size_t& Cursor /*in+out*/,
-                  textinput::EditorRange& R /*out*/,
-                  std::vector<std::string>& Completions /*out*/) override {
-      m_ParentInterpreter.codeComplete(Line.GetText(), Cursor, Completions);
-      return true;
-    }
-  };
 
-  ///\brief Delays ~TextInput until after ~StreamReader and ~TerminalDisplay
-  ///
-  class TextInputHolder {
-    textinput::StreamReader* m_Reader;
-    textinput::TerminalDisplay* m_Display;
-    textinput::TextInput m_Input;
-
-  public:
-    TextInputHolder(llvm::SmallString<512>& Hist)
-        : m_Reader(textinput::StreamReader::Create()),
-          m_Display(textinput::TerminalDisplay::Create()),
-          m_Input(*m_Reader, *m_Display, Hist.empty() ? 0 : Hist.c_str()) {}
-
-    ~TextInputHolder() {
-      delete m_Reader;
-      delete m_Display;
-    }
+  struct ClingListCompleter {
+    const cling::Interpreter& MainInterp;
+
+    ClingListCompleter(const cling::Interpreter& Interp) : MainInterp(Interp) {}
 
-    textinput::TextInput* operator -> () { return &m_Input; }
+    std::vector<llvm::LineEditor::Completion> operator()(llvm::StringRef Buffer,
+                                                         size_t Pos) const;
+    std::vector<llvm::LineEditor::Completion>
+    operator()(llvm::StringRef Buffer, size_t Pos, llvm::Error& ErrRes) const;
   };
 
+  std::vector<llvm::LineEditor::Completion>
+  ClingListCompleter::operator()(llvm::StringRef Buffer, size_t Pos) const {
+    auto Err = llvm::Error::success();
+    auto res = (*this)(Buffer, Pos, Err);
+    if (Err)
+      llvm::logAllUnhandledErrors(std::move(Err), llvm::errs(), "error: ");
+    return res;
+  }
+
+  std::vector<llvm::LineEditor::Completion>
+  ClingListCompleter::operator()(llvm::StringRef Buffer, size_t Pos,
+                                 llvm::Error& ErrRes) const {
+    std::vector<llvm::LineEditor::Completion> Comps;
+    std::vector<std::string> Results;
+
+    MainInterp.codeComplete(Buffer.str(), Pos, Results);
+    for (auto c : Results) {
+      Comps.push_back(llvm::LineEditor::Completion(c, c));
+    }
+    return Comps;
+  }
+
   llvm::SmallString<512> GetHistoryFilePath() {
     if (std::getenv("CLING_NOHISTORY")) {
       return {};
@@ -123,42 +115,27 @@ namespace cling {
     }
 
     auto histfilePath{GetHistoryFilePath()};
-
-    const auto Completion =
-        std::make_unique<UITabCompletion>(m_MetaProcessor->getInterpreter());
-    TextInputHolder TI(histfilePath);
-
-    TI->SetCompletion(Completion.get());
+    llvm::LineEditor LE("cling", histfilePath);
+    std::string Input;
+    std::string Prompt("[cling]$ ");
 
     if (const char* HistSizeEnvvar = std::getenv("CLING_HISTSIZE")) {
       const size_t HistSize = std::strtoull(HistSizeEnvvar, nullptr, 0);
 
       // std::strtoull() returns 0 if the parsing fails.
       // zero HistSize will disable history logging to file.
-      // refer to textinput::History::AppendToFile()
-      TI->SetHistoryMaxDepth(HistSize);
-      TI->SetHistoryPruneLength(
-          static_cast<size_t>(textinput::History::kPruneLengthDefault));
+      LE.setHistorySize(HistSize);
     }
 
-    bool Done = false;
-    std::string Line;
-    std::string Prompt("[cling]$ ");
+    LE.setPrompt(Prompt);
 
-    while (!Done) {
+    LE.setListCompleter(ClingListCompleter(m_MetaProcessor->getInterpreter()));
+    while (std::optional<std::string> Line = LE.readLine()) {
       try {
-        m_MetaProcessor->getOuts().flush();
-        {
-          MetaProcessor::MaybeRedirectOutputRAII RAII(*m_MetaProcessor);
-          TI->SetPrompt(Prompt.c_str());
-          Done = TI->ReadInput() == textinput::TextInput::kRREOF;
-          TI->TakeInput(Line);
-          if (Done && Line.empty())
-            break;
-        }
+        m_MetaProcessor->getOuts().flush(); // Do we need this now?
 
         cling::Interpreter::CompilationResult compRes;
-        const int indent = m_MetaProcessor->process(Line, compRes);
+        const int indent = m_MetaProcessor->process(*Line, compRes);
 
         // Quit requested?
         if (indent < 0)
@@ -186,8 +163,10 @@ namespace cling {
       catch(...) {
         cling::errs() << "Exception occurred. Recovering...\n";
       }
+
+      LE.setPrompt(Prompt);
     }
-    m_MetaProcessor->getOuts().flush();
+    m_MetaProcessor->getOuts().flush(); // Do we need this now?
   }
 
   void UserInterface::PrintLogo() {

test/CodeGeneration/Statics.C

@@ -37,5 +37,5 @@ inst02();
 // expected-no-diagnostics
 .q
 
-// CHECK-NEXT: TERD::~TERD::inst02
+// CHECK: TERD::~TERD::inst02
 // CHECK-NEXT: TERD::~TERD::inst01

test/CodeGeneration/const.C

@@ -33,5 +33,5 @@ a.val
 a.getVal()
 // CHECK-NEXT: (int) 1
 
-// CHECK-NEXT: ~A(1), this = [[PTR]]
+// CHECK: ~A(1), this = [[PTR]]
 // CHECK-NOT: ~A

test/CodeUnloading/AtExit.C

@@ -115,7 +115,7 @@ struct ShutdownRecursion {
 
 // Reversed registration order
 
-// CHECK-NEXT: ~ShutdownRecursion
+// CHECK: ~ShutdownRecursion
 // CHECK-NEXT: ShutdownRecursion2
 // CHECK-NEXT: ShutdownRecursion1
 // CHECK-NEXT: ShutdownRecursion0

test/Driver/Inputs/cling_history

@@ -1,8 +1,9 @@
-/*
-comment
- * */
-static const int i = 37;
-};
-// another comment
-using std::cout;
-std::cout << "test\n";
+_HiStOrY_V2_
+/*\012
+\011\011comment\012
+\040*\040*/\012
+\011static\040const\040int\040i\040=\04037;\012
+};\012
+//\040another\040comment\012
+using\040std::cout;\012
+std::cout\040<<\040"test\134n";\012

test/Interfaces/evaluate.C

@@ -224,7 +224,8 @@ gCling->evaluate("arrV", V);
 
 // Destruct the variables with static storage:
 // Destruct arrV:
-//CHECK-NEXT: MADE{7}:dtor
+// The error `err_verify_no_directives` will add a new line here.
+//CHECK: MADE{7}:dtor
 //CHECK-NEXT: MADE{6}:dtor
 //CHECK-NEXT: MADE{5}:dtor
 

test/Prompt/Continuation.C

@@ -72,7 +72,7 @@ CLING_MULTILINE_MACRO("DOWHILE");
 #define CLING_MULTILINE_TRAILING_SPACE   \    
   "Trailing Space "   \    
   "And A Tab" \		
-  " End" // expected-warning@1 {{backslash and newline separated by space}} // expected-warning@2 {{backslash and newline separated by space}}
+  " End" // expected-warning@1 {{backslash and newline separated by space}} // expected-warning@2 {{backslash and newline separated by space}} // expected-warning@3 {{backslash and newline separated by space}}
 
 CLING_MULTILINE_TRAILING_SPACE
 // CHECK-NEXT: (const char[29]) "Trailing Space And A Tab End"

test/Prompt/DontWrap.C

@@ -350,6 +350,6 @@ N::X<int> funcReturnsXint() {
 funcReturnsXint()
 // CHECK-NEXT: (N::X<int>) @0x{{.*}}
 
-// CHECK-NEXT: Nested::~Nested(80)
+// CHECK: Nested::~Nested(80)
 
 // expected-no-diagnostics