Add String Replace Function to Lua Scripting API

This change exposes a new `str_replace_all` function to the Lua scripting
environment, allowing Lua scripts to perform substring replacements on
strings.

The implementation provides an efficient string replacement utility that
finds and replaces all occurrences of a substring within a given string.
The function includes optimizations such as pre-allocation to reduce
memory reallocations during the replacement process, and handles edge
cases like empty search strings by returning the original string unchanged.

The new function is registered with LuaBridge in the `codelite` namespace,
making it accessible to all Lua scripts running within the CodeLite
environment. Comprehensive documentation has been added to the header file,
including usage examples and implementation notes.

* Scripting/CodeLiteLUA.cpp - Register new function and add implementation
* Scripting/CodeLiteLUA.hpp - Add function declaration with documentation

** Generated by CodeLite. **

Signed-off-by: Eran Ifrah <eran@codelite.org>

Author: eranif

Plugin/Scripting/CodeLiteLUA.cpp

@@ -40,7 +40,7 @@ void CodeLiteLUA::Initialise()
     auto& self = Get();
     self.m_state = luaL_newstate();
     luaL_openlibs(self.m_state);
-    
+
     try {
         clDEBUG() << "Registering codelite with LUA" << endl;
         luabridge::getGlobalNamespace(self.m_state)
@@ -57,6 +57,7 @@ void CodeLiteLUA::Initialise()
             .addFunction("log_system", &CodeLiteLUA::log_system)
             .addFunction("log_debug", &CodeLiteLUA::log_debug)
             .addFunction("log_trace", &CodeLiteLUA::log_trace)
+            .addFunction("str_replace_all", &CodeLiteLUA::str_replace_all)
             .endNamespace();
 
     } catch (const std::exception& e) {
@@ -196,6 +197,29 @@ void CodeLiteLUA::log_message(const std::string& msg, FileLogger::LogLevel level
     }
 }
 
+std::string
+CodeLiteLUA::str_replace_all(const std::string& str, const std::string& find_what, const std::string& replace_with)
+{
+    if (find_what.empty()) {
+        return str;
+    }
+
+    std::string result;
+    result.reserve(str.size()); // Pre-allocate to reduce reallocations
+
+    size_t pos = 0;
+    size_t last_pos = 0;
+
+    while ((pos = str.find(find_what, last_pos)) != std::string::npos) {
+        result.append(str, last_pos, pos - last_pos);
+        result.append(replace_with);
+        last_pos = pos + find_what.length();
+    }
+
+    result.append(str, last_pos, std::string::npos);
+    return result;
+}
+
 void CodeLiteLUA::chat(const std::string& prompt)
 {
     // send an event requesting to initiate a chat

Plugin/Scripting/CodeLiteLUA.hpp

@@ -249,6 +249,41 @@ class WXDLLIMPEXP_SDK CodeLiteLUA : public wxEvtHandler
      */
     static inline void log_trace(const std::string& msg) { log_message(msg, FileLogger::LogLevel::Developer); }
 
+    /**
+     * @brief Replaces all occurrences of a substring within a string with another substring.
+     *
+     * This function searches for all instances of `find_what` in `str` and replaces them with
+     * `replace_with`. The function pre-allocates memory to minimize reallocations during the
+     * replacement process. If `find_what` is empty, the original string is returned unchanged.
+     *
+     * @param str The input string to search within.
+     * @param find_what The substring to search for and replace.
+     * @param replace_with The substring to replace each occurrence of `find_what` with.
+     *
+     * @return std::string A new string with all occurrences of `find_what` replaced by `replace_with`.
+     *
+     * @note If `find_what` is an empty string, the function returns a copy of the original string
+     *       to avoid infinite loops.
+     *
+     * @code
+     * CodeLiteLUA lua_handler;
+     * std::string input = "Hello world, world!";
+     * std::string result = lua_handler.str_replace_all(input, "world", "universe");
+     * // result is "Hello universe, universe!"
+     *
+     * std::string no_match = lua_handler.str_replace_all(input, "xyz", "abc");
+     * // no_match is "Hello world, world!" (unchanged)
+     *
+     * std::string empty_find = lua_handler.str_replace_all(input, "", "test");
+     * // empty_find is "Hello world, world!" (unchanged)
+     * @endcode
+     *
+     * @see std::string::find
+     * @see std::string::replace
+     */
+    static std::string
+    str_replace_all(const std::string& str, const std::string& find_what, const std::string& replace_with);
+
 private:
     CodeLiteLUA();
     ~CodeLiteLUA();