Merge pull request #44601 from azat/move-line-readers

Slightly cleanup interactive line reader code

base/base/CMakeLists.txt

@@ -8,16 +8,13 @@ set (SRCS
     getPageSize.cpp
     getThreadId.cpp
     JSON.cpp
-    LineReader.cpp
     mremap.cpp
     phdr_cache.cpp
     preciseExp10.cpp
-    setTerminalEcho.cpp
     shift10.cpp
     sleep.cpp
     terminalColors.cpp
     errnoToString.cpp
-    ReplxxLineReader.cpp
     StringRef.cpp
     safeExit.cpp
     throwError.cpp
@@ -40,11 +37,6 @@ else ()
     target_compile_definitions(common PUBLIC WITH_COVERAGE=0)
 endif ()
 
-# FIXME: move libraries for line reading out from base
-if (TARGET ch_rust::skim)
-    target_link_libraries(common PUBLIC ch_rust::skim)
-endif()
-
 target_include_directories(common PUBLIC .. "${CMAKE_CURRENT_BINARY_DIR}/..")
 
 if (OS_DARWIN AND NOT USE_STATIC_LIBRARIES)

base/base/setTerminalEcho.cpp

@@ -1,28 +0,0 @@
-#include <base/setTerminalEcho.h>
-#include <base/errnoToString.h>
-#include <stdexcept>
-#include <cstring>
-#include <string>
-#include <termios.h>
-#include <unistd.h>
-
-
-void setTerminalEcho(bool enable)
-{
-    /// Obtain terminal attributes,
-    /// toggle the ECHO flag
-    /// and set them back.
-
-    struct termios tty{};
-
-    if (0 != tcgetattr(STDIN_FILENO, &tty))
-        throw std::runtime_error(std::string("setTerminalEcho failed get: ") + errnoToString());
-
-    if (enable)
-        tty.c_lflag |= ECHO;
-    else
-        tty.c_lflag &= ~ECHO;
-
-    if (0 != tcsetattr(STDIN_FILENO, TCSANOW, &tty))
-        throw std::runtime_error(std::string("setTerminalEcho failed set: ") + errnoToString());
-}

base/base/setTerminalEcho.h

@@ -1,4 +0,0 @@
-#pragma once
-
-/// Enable or disable echoing of typed characters. Throws std::runtime_error on error.
-void setTerminalEcho(bool enable);

programs/client/CMakeLists.txt

@@ -13,6 +13,10 @@ set (CLICKHOUSE_CLIENT_LINK
         string_utils
 )
 
+if (TARGET ch_rust::skim)
+    list(APPEND CLICKHOUSE_CLIENT_LINK PRIVATE ch_rust::skim)
+endif()
+
 # Always use internal readpassphrase
 list(APPEND CLICKHOUSE_CLIENT_LINK PRIVATE readpassphrase)
 

programs/local/CMakeLists.txt

@@ -18,6 +18,10 @@ if(NOT CLICKHOUSE_ONE_SHARED)
     target_link_libraries(clickhouse-local-lib PRIVATE clickhouse-server-lib)
 endif()
 
+if (TARGET ch_rust::skim)
+    target_link_libraries(clickhouse-local-lib PRIVATE ch_rust::skim)
+endif()
+
 # Always use internal readpassphrase
 target_link_libraries(clickhouse-local-lib PRIVATE readpassphrase)
 

src/CMakeLists.txt

@@ -332,6 +332,12 @@ macro (dbms_target_link_libraries)
     endforeach ()
 endmacro ()
 
+macro (dbms_target_include_directories)
+    foreach (module ${all_modules})
+        target_include_directories (${module} ${ARGN})
+    endforeach ()
+endmacro ()
+
 dbms_target_include_directories (PUBLIC "${ClickHouse_SOURCE_DIR}/src" "${ClickHouse_BINARY_DIR}/src")
 target_include_directories (clickhouse_common_io PUBLIC "${ClickHouse_SOURCE_DIR}/src" "${ClickHouse_BINARY_DIR}/src")
 
@@ -589,6 +595,11 @@ if (TARGET ch_contrib::annoy)
     dbms_target_link_libraries(PUBLIC ch_contrib::annoy)
 endif()
 
+if (TARGET ch_rust::skim)
+    # Add only -I, library is needed only for clickhouse-client/clickhouse-local
+    dbms_target_include_directories(PRIVATE $<TARGET_PROPERTY:ch_rust::skim,INTERFACE_INCLUDE_DIRECTORIES>)
+endif()
+
 include ("${ClickHouse_SOURCE_DIR}/cmake/add_check.cmake")
 
 if (ENABLE_TESTS)

src/Client/CMakeLists.txt

@@ -1,3 +1,3 @@
 if (ENABLE_EXAMPLES)
     add_subdirectory(examples)
-endif()
+endif()

src/Client/ClientBase.cpp

@@ -1,42 +1,30 @@
 #include <Client/ClientBase.h>
+#include <Client/LineReader.h>
+#include <Client/ClientBaseHelpers.h>
+#include <Client/TestHint.h>
+#include <Client/InternalTextLogs.h>
+#include <Client/TestTags.h>
 
-#include <iostream>
-#include <filesystem>
-#include <map>
-#include <unordered_map>
-
-#include "config.h"
-
+#include <base/argsToConfig.h>
+#include <base/safeExit.h>
+#include <Core/Block.h>
+#include <Core/Protocol.h>
 #include <Common/DateLUT.h>
 #include <Common/MemoryTracker.h>
-#include <base/argsToConfig.h>
-#include <base/LineReader.h>
 #include <Common/scope_guard_safe.h>
-#include <base/safeExit.h>
 #include <Common/Exception.h>
 #include <Common/getNumberOfPhysicalCPUCores.h>
 #include <Common/tests/gtest_global_context.h>
 #include <Common/typeid_cast.h>
-#include <Columns/ColumnString.h>
-#include <Columns/ColumnsNumber.h>
-#include <Core/Block.h>
-#include <Core/Protocol.h>
-#include <Formats/FormatFactory.h>
-#include <Access/AccessControl.h>
-
-#include "config_version.h"
-
 #include <Common/UTF8Helpers.h>
 #include <Common/TerminalSize.h>
 #include <Common/clearPasswordFromCommandLine.h>
 #include <Common/StringUtils/StringUtils.h>
 #include <Common/filesystemHelpers.h>
 #include <Common/NetException.h>
-#include <Storages/ColumnsDescription.h>
-
-#include <Client/ClientBaseHelpers.h>
-#include <Client/TestHint.h>
-#include "TestTags.h"
+#include <Columns/ColumnString.h>
+#include <Columns/ColumnsNumber.h>
+#include <Formats/FormatFactory.h>
 
 #include <Parsers/parseQuery.h>
 #include <Parsers/ParserQuery.h>
@@ -53,26 +41,36 @@
 #include <Parsers/ASTLiteral.h>
 #include <Parsers/ASTIdentifier.h>
 #include <Parsers/ASTColumnDeclaration.h>
+#include <Parsers/Kusto/ParserKQLStatement.h>
 
 #include <Processors/Formats/Impl/NullFormat.h>
 #include <Processors/Formats/IInputFormat.h>
 #include <Processors/Formats/IOutputFormat.h>
-#include <QueryPipeline/QueryPipeline.h>
-#include <QueryPipeline/QueryPipelineBuilder.h>
 #include <Processors/QueryPlan/QueryPlan.h>
 #include <Processors/QueryPlan/BuildQueryPipelineSettings.h>
 #include <Processors/QueryPlan/Optimizations/QueryPlanOptimizationSettings.h>
 #include <Processors/Executors/PullingAsyncPipelineExecutor.h>
 #include <Processors/Transforms/AddingDefaultsTransform.h>
+#include <QueryPipeline/QueryPipeline.h>
+#include <QueryPipeline/QueryPipelineBuilder.h>
 #include <Interpreters/ReplaceQueryParameterVisitor.h>
 #include <Interpreters/ProfileEventsExt.h>
 #include <IO/WriteBufferFromOStream.h>
 #include <IO/WriteBufferFromFileDescriptor.h>
 #include <IO/CompressionMethod.h>
-#include <Client/InternalTextLogs.h>
 #include <IO/ForkWriteBuffer.h>
-#include <Parsers/Kusto/ParserKQLStatement.h>
+
+#include <Access/AccessControl.h>
+#include <Storages/ColumnsDescription.h>
+
 #include <boost/algorithm/string/case_conv.hpp>
+#include <iostream>
+#include <filesystem>
+#include <map>
+#include <unordered_map>
+
+#include "config_version.h"
+#include "config.h"
 
 
 namespace fs = std::filesystem;

src/Client/ClientBaseHelpers.h

@@ -4,7 +4,7 @@
 #include "config.h"
 
 #if USE_REPLXX
-#   include <base/ReplxxLineReader.h>
+#   include <Client/ReplxxLineReader.h>
 #endif
 
 

src/Client/ConnectionParameters.cpp

@@ -9,7 +9,6 @@
 #include <Common/Exception.h>
 #include <Common/isLocalAddress.h>
 #include <Common/DNSResolver.h>
-#include <base/setTerminalEcho.h>
 #include <base/scope_guard.h>
 
 #include <readpassphrase/readpassphrase.h>

src/Client/LineReader.cpp

@@ -1,4 +1,4 @@
-#include <base/LineReader.h>
+#include <Client/LineReader.h>
 
 #include <iostream>
 #include <string_view>
@@ -65,6 +65,9 @@ void addNewWords(Words & to, const Words & from, Compare comp)
 
 }
 
+namespace DB
+{
+
 replxx::Replxx::completions_t LineReader::Suggest::getCompletions(const String & prefix, size_t prefix_length)
 {
     std::string_view last_word;
@@ -202,3 +205,5 @@ LineReader::InputStatus LineReader::readOneLine(const String & prompt)
     trim(input);
     return INPUT_LINE;
 }
+
+}

src/Client/LineReader.h

@@ -9,6 +9,9 @@
 #include <base/types.h>
 #include <base/defines.h>
 
+namespace DB
+{
+
 class LineReader
 {
 public:
@@ -68,3 +71,5 @@ protected:
     virtual InputStatus readOneLine(const String & prompt);
     virtual void addToHistory(const String &) {}
 };
+
+}

src/Client/ReplxxLineReader.cpp

@@ -1,6 +1,10 @@
-#include <base/ReplxxLineReader.h>
+#include <Client/ReplxxLineReader.h>
 #include <base/errnoToString.h>
 
+#include <IO/ReadBufferFromFile.h>
+#include <IO/WriteBufferFromString.h>
+#include <IO/copyData.h>
+
 #include <stdexcept>
 #include <chrono>
 #include <cerrno>
@@ -108,13 +112,11 @@ void writeRetry(int fd, const std::string & data)
 }
 std::string readFile(const std::string & path)
 {
-    std::ifstream t(path);
-    std::string str;
-    t.seekg(0, std::ios::end);
-    str.reserve(t.tellg());
-    t.seekg(0, std::ios::beg);
-    str.assign((std::istreambuf_iterator<char>(t)), std::istreambuf_iterator<char>());
-    return str;
+    std::string out;
+    DB::WriteBufferFromString out_buffer(out);
+    DB::ReadBufferFromFile in_buffer(path);
+    DB::copyData(in_buffer, out_buffer);
+    return out;
 }
 
 /// Simple wrapper for temporary files.
@@ -269,6 +271,9 @@ void convertHistoryFile(const std::string & path, replxx::Replxx & rx)
 
 }
 
+namespace DB
+{
+
 static bool replxx_last_is_delimiter = false;
 void ReplxxLineReader::setLastIsDelimiter(bool flag)
 {
@@ -508,3 +513,5 @@ void ReplxxLineReader::enableBracketedPaste()
     bracketed_paste_enabled = true;
     rx.enable_bracketed_paste();
 }
+
+}

src/Client/ReplxxLineReader.h

@@ -1,9 +1,11 @@
 #pragma once
 
 #include "LineReader.h"
-
 #include <replxx.hxx>
 
+namespace DB
+{
+
 class ReplxxLineReader : public LineReader
 {
 public:
@@ -36,3 +38,5 @@ private:
 
     std::string editor;
 };
+
+}

src/Client/Suggest.h

@@ -5,8 +5,8 @@
 #include <Client/Connection.h>
 #include <Client/IServerConnection.h>
 #include <Client/LocalConnection.h>
+#include <Client/LineReader.h>
 #include <IO/ConnectionTimeouts.h>
-#include <base/LineReader.h>
 #include <thread>
 
 

utils/check-style/check-style

@@ -292,6 +292,7 @@ std_cerr_cout_excludes=(
     # IProcessor::dump()
     src/Processors/IProcessor.cpp
     src/Client/ClientBase.cpp
+    src/Client/LineReader.cpp
     src/Client/QueryFuzzer.cpp
     src/Client/Suggest.cpp
     src/Bridge/IBridge.cpp

utils/zookeeper-cli/CMakeLists.txt

@@ -1,2 +1,4 @@
-clickhouse_add_executable(clickhouse-zookeeper-cli zookeeper-cli.cpp)
+clickhouse_add_executable(clickhouse-zookeeper-cli
+    zookeeper-cli.cpp
+    ${ClickHouse_SOURCE_DIR}/src/Client/LineReader.cpp)
 target_link_libraries(clickhouse-zookeeper-cli PRIVATE clickhouse_common_zookeeper_no_log)

utils/zookeeper-cli/zookeeper-cli.cpp

@@ -3,7 +3,7 @@
 #include <Poco/ConsoleChannel.h>
 #include <Common/ZooKeeper/KeeperException.h>
 #include <Common/ZooKeeper/ZooKeeper.h>
-#include <base/LineReader.h>
+#include <Client/LineReader.h>
 #include <Common/logger_useful.h>
 
 #include <iostream>
@@ -70,7 +70,7 @@ int main(int argc, char ** argv)
         Poco::Logger::root().setLevel("trace");
 
         zkutil::ZooKeeper zk{zkutil::ZooKeeperArgs(argv[1])};
-        LineReader lr({}, false, {"\\"}, {});
+        DB::LineReader lr({}, false, {"\\"}, {});
 
         do
         {