[WIP] try to support both replxx and linenoise

Author: Willaaaaaaa

CMakeLists.txt

@@ -158,7 +158,7 @@ IF (EXISTS /usr/local/lib64)
     LINK_DIRECTORIES (/usr/local/lib64)
 ENDIF ()
 
-INCLUDE_DIRECTORIES(. ${PROJECT_SOURCE_DIR}/deps ${PROJECT_SOURCE_DIR}/src /usr/local/include)
+INCLUDE_DIRECTORIES(. ${PROJECT_SOURCE_DIR}/deps ${PROJECT_SOURCE_DIR}/deps/3rd/usr/local/include ${PROJECT_SOURCE_DIR}/src /usr/local/include)
 
 IF(WITH_UNIT_TESTS)
     IF (ENABLE_COVERAGE)

src/common/CMakeLists.txt

@@ -19,6 +19,11 @@ IF(USE_MUSL_LIBC)
     TARGET_LINK_LIBRARIES(common execinfo)
 ENDIF(USE_MUSL_LIBC)
 
+IF(USE_REPLXX)
+    TARGET_LINK_LIBRARIES(common replxx::replxx)
+    MESSAGE(STATUS "common uses replxx")
+ENDIF()
+
 # 编译静态库时，自动会把同名的动态库给删除， 因此需要临时设置一下
 SET_TARGET_PROPERTIES(common PROPERTIES CLEAN_DIRECT_OUTPUT 1)
 

src/common/linereader/line_reader.cpp

@@ -13,18 +13,20 @@ See the Mulan PSL v2 for more details. */
 //
 
 #include "common/linereader/line_reader.h"
+#include "common/lang/string.h"
 
 namespace common {
 LineReader LineReaderManager::reader_;
-bool LineReaderManager::is_first_call_ = true;
+bool       LineReaderManager::is_first_call_ = true;
 
-char* LineReaderManager::my_readline(const char* prompt, const std::string& history_file) {
+char *LineReaderManager::my_readline(const char *prompt, const std::string &history_file)
+{
   if (is_first_call_) {
     reader_.history_load(history_file);
     is_first_call_ = false;
   }
 
-  char* line = reader_.input(prompt);
+  char *line = (char *)reader_.input(prompt);
   if (line == nullptr) {
     return nullptr;
   }
@@ -40,20 +42,30 @@ char* LineReaderManager::my_readline(const char* prompt, const std::string& hist
   if (is_valid_input) {
     reader_.history_add(line);
   }
-  
+
   return line;
 }
 
-bool LineReaderManager::is_exit_command(const char* cmd, const std::string& history_file) {
-  bool is_exit = 0 == strncasecmp("exit", cmd, 4) || 
-                0 == strncasecmp("bye", cmd, 3) || 
-                0 == strncasecmp("\\q", cmd, 2) ||
-                0 == strncasecmp("interrupted", cmd, 11);
-                
+bool LineReaderManager::is_exit_command(const char *cmd, const std::string &history_file)
+{
+  bool is_exit = 0 == strncasecmp("exit", cmd, 4) || 0 == strncasecmp("bye", cmd, 3) ||
+                 0 == strncasecmp("\\q", cmd, 2) || 0 == strncasecmp("interrupted", cmd, 11);
+
   if (is_exit) {
     reader_.history_save(history_file);
   }
-  
+
   return is_exit;
 }
-} // namespace common
+
+void LineReaderManager::free_buffer(char *buffer)
+{
+  if (buffer != nullptr) {
+#if USE_REPLXX
+    delete[] buffer;  // replxx uses new[]
+#else
+    free(buffer);  // linenoise uses malloc
+#endif
+  }
+}
+}  // namespace common

src/common/linereader/line_reader.h

@@ -16,36 +16,44 @@ See the Mulan PSL v2 for more details. */
 #define COMMON_LINE_READER
 
 #if USE_REPLXX
-  #include "replxx.hxx"
-  using LineReader = replxx::Replxx;
+#include "replxx.hxx"
+using LineReader = replxx::Replxx;
 #else
-  #include "common/linereader/linenoise_reader.h"
-  using LineReader = LinenoiseReader;
+#include "common/linereader/linenoise_reader.h"
+using LineReader = LinenoiseReader;
 #endif
 
 namespace common {
-class LineReaderManager {
+class LineReaderManager
+{
 public:
   /**
    * @brief Read a line from input
    * @param prompt The prompt to display
    * @param history_file path/to/file
    * @return char* to input string or nullptr
    */
-  static char* my_readline(const char* prompt, const std::string& history_file);
+  static char *my_readline(const char *prompt, const std::string &history_file);
 
   /**
    * @brief Check if the command is an exit command
    * @param cmd The input command
    * @param history_file path/to/file
    * @return True if the command is an exit command
    */
-  static bool is_exit_command(const char* cmd, const std::string& history_file);
+  static bool is_exit_command(const char *cmd, const std::string &history_file);
+
+  /**
+   * @brief Free the buffer allocated by my_readline
+   * @param buffer The buffer allocated by my_readline
+   * @note dealing with alloc-dealloc-mismatch
+   */
+  static void free_buffer(char *buffer);
 
 private:
   static LineReader reader_;
-  static bool is_first_call_;
+  static bool       is_first_call_;
 };
-} // namespace common
+}  // namespace common
 
-#endif // COMMON_LINE_READER
+#endif  // COMMON_LINE_READER

src/common/linereader/linenoise_reader.cpp

@@ -8,43 +8,41 @@ EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT,
 MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
 See the Mulan PSL v2 for more details. */
 
-// 
+//
 // Created by Willaaaaaaa in 2025
 //
 
 #include "common/linereader/linenoise_reader.h"
 #include "common/linereader/linenoise.h"
 #include "common/lang/string.h"
 
-LinenoiseReader::LinenoiseReader() {
+LinenoiseReader::LinenoiseReader()
+{
   linenoiseHistorySetMaxLen(1000);
   linenoiseSetMultiLine(0);
 }
 
-char* LinenoiseReader::input(const char* prompt) {
-  return linenoise(prompt);
-}
+char *LinenoiseReader::input(const char *prompt) { return linenoise(prompt); }
 
-bool LinenoiseReader::history_load(const std::string& history_file) {
+bool LinenoiseReader::history_load(const std::string &history_file)
+{
   history_file_ = history_file;
   return linenoiseHistoryLoad(history_file.c_str()) == 0;
 }
 
-bool LinenoiseReader::history_save(const std::string& history_file) const {
+bool LinenoiseReader::history_save(const std::string &history_file) const
+{
   return linenoiseHistorySave(history_file.c_str()) == 0;
 }
 
-bool LinenoiseReader::history_add(const char* line) {
+bool LinenoiseReader::history_add(const char *line)
+{
   if (line != nullptr && *line != '\0') {
     return linenoiseHistoryAdd(line) == 0;
   }
   return false;
 }
 
-void LinenoiseReader::history_set_max_len(int len) {
-  linenoiseHistorySetMaxLen(len);
-}
+void LinenoiseReader::history_set_max_len(int len) { linenoiseHistorySetMaxLen(len); }
 
-void LinenoiseReader::clear_screen() {
-  linenoiseClearScreen();
-}
+void LinenoiseReader::clear_screen() { linenoiseClearScreen(); }

src/common/linereader/linenoise_reader.h

@@ -8,7 +8,7 @@ EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO NON-INFRINGEMENT,
 MERCHANTABILITY OR FIT FOR A PARTICULAR PURPOSE.
 See the Mulan PSL v2 for more details. */
 
-// 
+//
 // Created by Willaaaaaaa in 2025
 //
 
@@ -21,45 +21,47 @@ See the Mulan PSL v2 for more details. */
  * @brief A wrapper class for linenoise lib
  * @details Support history memory...
  */
-class LinenoiseReader {
+class LinenoiseReader
+{
 public:
   LinenoiseReader();
   ~LinenoiseReader() = default;
-  
+
   /**
-   * @brief Read input with C string
+   * @brief Read input with C++ string
    * @param prompt
    * @return char* to input string or nullptr
+  //  * @note set prompt to string to be consistent with replxx
    */
-  char* input(const char* prompt);
-  
+  char *input(const char *prompt);
+
   /**
    * @brief Load history records from the file
    * @param history_file path/to/history
    * @return Whether load success
    */
-  bool history_load(const std::string& history_file);
-  
+  bool history_load(const std::string &history_file);
+
   /**
    * @brief Save history records to the file
    * @param history_file path/to/history
    * @return Whether save success
    */
-  bool history_save(const std::string& history_file) const;
-  
+  bool history_save(const std::string &history_file) const;
+
   /**
    * @brief Add a single history record to the file
    * @param line the C string command to be recorded
    * @return Whether add success
    */
-  bool history_add(const char* line);
-  
+  bool history_add(const char *line);
+
   /**
    * @brief Set the maximum of history length
    * @param len length
    */
   void history_set_max_len(int len);
-  
+
   /**
    * @brief Clean the screen: Ctrl + L
    */
@@ -69,4 +71,4 @@ class LinenoiseReader {
   std::string history_file_;
 };
 
-#endif // COMMON_LINENOISE_WRAPPER_H
+#endif  // COMMON_LINENOISE_WRAPPER_H

src/obclient/client.cpp

@@ -43,10 +43,7 @@ const std::string LINE_HISTORY_FILE = "./.obclient.history";
    'strncasecmp("exit", cmd, 4)' means that obclient read command string from terminal, truncate it to 4 chars from
    the beginning, then compare the result with 'exit', if they match, exit the obclient.
 */
-bool is_exit_command(const char *cmd)
-{
-  return LineReaderManager::is_exit_command(cmd, LINE_HISTORY_FILE);
-}
+bool is_exit_command(const char *cmd) { return LineReaderManager::is_exit_command(cmd, LINE_HISTORY_FILE); }
 
 int init_unix_sock(const char *unix_sock_path)
 {
@@ -145,13 +142,13 @@ int main(int argc, char *argv[])
 
   while ((input_command = LineReaderManager::my_readline(prompt_str, LINE_HISTORY_FILE)) != nullptr) {
     if (common::is_blank(input_command)) {
-      free(input_command);
+      LineReaderManager::free_buffer(input_command);
       input_command = nullptr;
       continue;
     }
 
     if (is_exit_command(input_command)) {
-      free(input_command);
+      LineReaderManager::free_buffer(input_command);
       input_command = nullptr;
       break;
     }
@@ -165,7 +162,7 @@ int main(int argc, char *argv[])
       fprintf(stderr, "send error: %d:%s \n", errno, strerror(errno));
       exit(1);
     }
-    free(input_command);
+    LineReaderManager::free_buffer(input_command);
     input_command = nullptr;
 
     memset(send_buf, 0, sizeof(send_buf));
@@ -197,7 +194,7 @@ int main(int argc, char *argv[])
   }
 
   if (input_command != nullptr) {
-    free(input_command);
+    LineReaderManager::free_buffer(input_command);
     input_command = nullptr;
   }
   close(sockfd);

src/oblsm/client/cliutil/parser.cpp

@@ -22,11 +22,11 @@ using common::LineReaderManager;
 namespace oceanbase {
 std::string my_readline(const std::string &prompt)
 {
-  char* line = LineReaderManager::my_readline(prompt.c_str(), LINE_HISTORY_FILE);
+  char *line = LineReaderManager::my_readline(prompt.c_str(), LINE_HISTORY_FILE);
   if (line == nullptr) {
     return "";
   }
-  
+
   std::string result = line;
   free(line);
   return result;

src/oblsm/client/cliutil/parser.h

@@ -28,7 +28,7 @@ See the Mulan PSL v2 for more details. */
 #define MAX_MEM_BUFFER_SIZE 8192
 namespace oceanbase {
 
-inline const string   LINE_HISTORY_FILE = "./.oblsm_cli.history";
+inline const string LINE_HISTORY_FILE = "./.oblsm_cli.history";
 
 std::string my_readline(const string &prompt);
 

src/oblsm/client/ob_lsm_client.cpp

@@ -120,14 +120,14 @@ int main(int, char **)
   static time_t previous_history_save_time = 0;
 
   for (; !quit;) {
-    char* command_input = LineReaderManager::my_readline(prompt.c_str(), LINE_HISTORY_FILE);
+    char *command_input = LineReaderManager::my_readline(prompt.c_str(), LINE_HISTORY_FILE);
 
     if (command_input == nullptr) {
       continue;
     }
 
     std::string command = command_input;
-    free(command_input);
+    LineReaderManager::free_buffer(command_input);
     command_input = nullptr;
 
     if (!command.empty()) {