LLM: Support Using Environment Vairables in Config.

The main changes include:

* **Environment handling**: Introduced a new `EnvSetter` default constructor that automatically applies environment variables from the active workspace (either FileSystemWorkspace or CxxWorkspace), eliminating the need for manual environment setup in various locations.
* **API improvements**: Made `EnvSetter` class exportable (`WXDLLIMPEXP_SDK`) and added `ToEnvList()` method to `EnvMap` for converting to the standard environment list format.
* **Tool execution**: Updated AI tool shell execution and LLM manager to use the new automatic environment setup, ensuring consistent environment application.
* **Error handling protocol**: Refined the system message for AI error handling to be more concise and clearer about the three-attempt maximum rule.

** Generated by CodeLite. **

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

Author: eranif

CodeLite/clEnvironment.hpp

@@ -11,16 +11,16 @@ using clEnvList_t = std::vector<std::pair<wxString, wxString>>;
 
 class WXDLLIMPEXP_CL clEnvironment
 {
-    const clEnvList_t* m_env = nullptr;
-    std::vector<std::pair<wxString, wxAny>> m_old_env;
-
-private:
-    void ApplyFromList(const clEnvList_t* envlist);
-
 public:
     clEnvironment(const clEnvList_t* envlist);
     clEnvironment();
     virtual ~clEnvironment();
+
+    void ApplyFromList(const clEnvList_t* envlist);
+
+private:
+    const clEnvList_t* m_env = nullptr;
+    std::vector<std::pair<wxString, wxAny>> m_old_env;
 };
 
 #endif // CLENVIRONMENT_HPP

Plugin/ai/LLMManager.cpp

@@ -9,6 +9,7 @@
 #include "cl_command_event.h"
 #include "cl_standard_paths.h"
 #include "codelite_events.h"
+#include "environmentconfig.h"
 #include "event_notifier.h"
 #include "file_logger.h"
 #include "fileextmanager.h"
@@ -32,10 +33,8 @@ When encountering errors:
 
 1. **First error:** Analyze, attempt one fix, retry once
 2. **Second error (same type):** Try one alternative approach if available
-3. **Third error or no clear alternative:** **STOP. Report the issue and all attempts made. Ask user for guidance.**
-
+3. **Third error:** **STOP**. Report the issue. Ask user for guidance.**
 Apply to: permission denied, tool failures, file errors, invalid parameters, command failures.
-
 **Never** loop indefinitely on repeated failures. Three attempts maximum before escalating to user.)#";
 
 /**
@@ -557,9 +556,9 @@ assistant::Config Manager::MakeConfig()
         return m_default_config;
     }
 
-    assistant::Config config =
-        assistant::Config::FromFile(res.value().ToStdString(wxConvUTF8)).value_or(m_default_config);
-    return config;
+    // Apply environment variables before we proceed
+    EnvSetter env;
+    return assistant::Config::FromFile(res.value().ToStdString(wxConvUTF8)).value_or(m_default_config);
 }
 
 void Manager::Restart()
@@ -651,6 +650,7 @@ void Manager::Start(std::shared_ptr<assistant::ClientBase> client)
 
     m_client->SetCachingPolicy(GetConfig().GetCachePolicy());
     m_client->SetTookInvokeCallback(&Manager::CanRunTool);
+    m_client->ClearSystemMessages();
     m_client->AddSystemMessage(kSystemMessageRetryProtocol);
 
     // Start the worker thread
@@ -681,6 +681,7 @@ bool Manager::ReloadConfig(std::optional<wxString> config_content, bool prompt)
         content = FileManager::ReadSettingsFileContent(kAssistantConfigFile, opts).value_or(kDefaultSettings);
     }
 
+    EnvSetter env;
     auto conf = assistant::Config::FromContent(content.ToStdString(wxConvUTF8));
     if (conf.has_value()) {
         m_client_config = std::move(conf.value());
@@ -973,6 +974,7 @@ clStatusOr<wxString> Manager::CreateOrOpenConfig()
     wxString backup_file_path = global_config_path + ".old";
     bool valid_file{false};
     try {
+        EnvSetter env;
         auto conf = assistant::Config::FromFile(global_config_path.ToStdString(wxConvUTF8));
         valid_file = conf.has_value();
     } catch (const std::exception& e) {

Plugin/ai/Tools.cpp

@@ -11,6 +11,7 @@
 #include "clSFTPManager.hpp"
 #include "clWorkspaceManager.h"
 #include "codelite_events.h"
+#include "environmentconfig.h"
 #include "event_notifier.h"
 #include "globals.h"
 #include "procutils.h"
@@ -506,6 +507,7 @@ FunctionResult ToolShellExecute([[maybe_unused]] const assistant::json& args)
         // Local command.
         ProcUtils::WrapInShell(cmd);
         wxArrayString output_arr;
+        EnvSetter env;
         ProcUtils::SafeExecuteCommand(cmd, output_arr, termination_flag.GetFlag());
         if (termination_flag.IsSet()) {
             return FunctionResult{.isError = true, .text = "Command terminated by user"};
@@ -519,6 +521,7 @@ FunctionResult ToolShellExecute([[maybe_unused]] const assistant::json& args)
     // Local command.
     ProcUtils::WrapInShell(cmd);
     wxArrayString output_arr;
+    EnvSetter env;
     ProcUtils::SafeExecuteCommand(cmd, output_arr, termination_flag.GetFlag());
     llm::Manager::GetInstance().DeleteTerminationFlag(termination_flag.GetFlag());
     if (termination_flag.IsSet()) {
@@ -530,6 +533,7 @@ FunctionResult ToolShellExecute([[maybe_unused]] const assistant::json& args)
     func_result.isError = false;
     func_result.text = command_output;
 #endif
+
     llm::Manager::GetInstance().PrintMessage(
         _("Successfully executed the command. Output:\n```bash\n") + func_result.text + "\n```\n", IconType::kInfo);
     return func_result;
@@ -540,17 +544,14 @@ FunctionResult GetOS([[maybe_unused]] const assistant::json& args)
     VERIFY_WORKER_THREAD();
 
     // Check if a remote workspace is opened - if so, always return "Linux"
-    auto cb = [=]() -> FunctionResult {
+    auto is_remote_workspace_cb = [=]() -> bool {
         auto workspace = clWorkspaceManager::Get().GetWorkspace();
-        if (workspace && workspace->IsRemote()) {
-            return Ok(wxString("Linux"));
-        }
-        return FunctionResult{.isError = false}; // Signal to continue with local OS detection
+        return workspace && workspace->IsRemote();
     };
 
-    auto result = EventNotifier::Get()->RunOnMain<FunctionResult>(std::move(cb));
-    if (!result.text.empty()) {
-        return result; // Remote workspace detected, return "Linux"
+    auto is_remote = EventNotifier::Get()->RunOnMain<bool>(std::move(is_remote_workspace_cb));
+    if (is_remote) {
+        return Ok("Linux"); // Remote workspace detected, return "Linux"
     }
 
     wxString os_name;

Plugin/environmentconfig.cpp

@@ -24,9 +24,11 @@
 //////////////////////////////////////////////////////////////////////////////
 #include "environmentconfig.h"
 
+#include "FileSystemWorkspace/clFileSystemWorkspace.hpp"
 #include "archive.h"
 #include "envvarlist.h"
 #include "macromanager.h"
+#include "workspace.h"
 #include "xmlutils.h"
 
 #include <algorithm>
@@ -272,3 +274,24 @@ DollarEscaper::~DollarEscaper()
     // we restore it to non escaped $ !!
     m_str.Replace("@@ESC_DOLLAR@@", "$");
 }
+
+// EnvSetter
+
+EnvSetter::EnvSetter()
+    : m_env(EnvironmentConfig::Instance())
+{
+    wxStringMap_t env_map;
+    wxString project_name, config_name;
+    if (clFileSystemWorkspace::Get().IsOpen() && !clFileSystemWorkspace::Get().IsRemote()) {
+        auto env_list = clFileSystemWorkspace::Get().GetEnvironment();
+        for (const auto& [k, v] : env_list) {
+            env_map.insert({k, v});
+        }
+
+    } else if (clCxxWorkspaceST::Get()->IsOpen() && clCxxWorkspaceST::Get()->GetActiveProject()) {
+        auto project = clCxxWorkspaceST::Get()->GetActiveProject();
+        config_name = project->GetBuildConfiguration() ? project->GetBuildConfiguration()->GetName() : wxString{};
+        project_name = project->GetName();
+    }
+    m_env->ApplyEnv(&env_map, project_name, config_name);
+}

Plugin/environmentconfig.h

@@ -84,10 +84,11 @@ class WXDLLIMPEXP_SDK EnvironmentConfig : public ConfigurationToolBase
     virtual wxString GetRootName();
 };
 
-class EnvSetter
+class WXDLLIMPEXP_SDK EnvSetter
 {
 public:
-    explicit EnvSetter(wxStringMap_t* om = NULL)
+    EnvSetter();
+    explicit EnvSetter(wxStringMap_t* om)
         : m_env(EnvironmentConfig::Instance())
     {
         m_env->ApplyEnv(om, wxEmptyString, wxEmptyString);
@@ -101,7 +102,7 @@ class EnvSetter
         if (envlist) {
             overrideMap.reserve(envlist->size());
             for (const auto& [name, value] : *envlist) {
-                overrideMap.insert({ name, value });
+                overrideMap.insert({name, value});
             }
         }
         m_env->ApplyEnv(&overrideMap, wxEmptyString, wxEmptyString);

Plugin/envvarlist.cpp

@@ -55,15 +55,15 @@ void EnvVarList::AddVariable(const wxString& setName, const wxString& name, cons
     wxString currentValueStr = DoGetSetVariablesStr(setName, actualSetName);
     wxArrayString currentValues = wxStringTokenize(currentValueStr, wxT("\r\n"), wxTOKEN_STRTOK);
 
-    if(currentValues.Index(newEntry) == wxNOT_FOUND)
+    if (currentValues.Index(newEntry) == wxNOT_FOUND)
         currentValues.Add(newEntry);
 
     currentValueStr.Clear();
-    for(size_t i = 0; i < currentValues.GetCount(); i++) {
+    for (size_t i = 0; i < currentValues.GetCount(); i++) {
         currentValueStr << currentValues.Item(i) << wxT("\n");
     }
 
-    if(currentValueStr.IsEmpty() == false)
+    if (currentValueStr.IsEmpty() == false)
         currentValueStr.RemoveLast();
 
     m_envVarSets[actualSetName] = currentValueStr;
@@ -76,47 +76,49 @@ void EnvVarList::InsertVariable(const wxString& setName, const wxString& name, c
     DoGetSetVariablesStr(setName, actualSetName);
 
     EnvMap set = GetVariables(actualSetName, false, wxEmptyString, wxEmptyString);
-    if(!set.Contains(name)) {
+    if (!set.Contains(name)) {
         set.Put(name, value);
     }
     m_envVarSets[actualSetName] = set.String();
 }
 
-EnvMap EnvVarList::GetVariables(const wxString& setName, bool includeWorkspaceEnvs, const wxString& projectName,
+EnvMap EnvVarList::GetVariables(const wxString& setName,
+                                bool includeWorkspaceEnvs,
+                                const wxString& projectName,
                                 const wxString& configName)
 {
     EnvMap variables;
     wxString actualSetName;
 
     wxString currentValueStr = DoGetSetVariablesStr(setName, actualSetName);
 
-    if(includeWorkspaceEnvs && !clCxxWorkspaceST::Get()->GetName().IsEmpty()) {
+    if (includeWorkspaceEnvs && !clCxxWorkspaceST::Get()->GetName().IsEmpty()) {
         currentValueStr.Trim().Trim(false);
         currentValueStr << wxT("\n");
         currentValueStr << clCxxWorkspaceST::Get()->GetEnvironmentVariables();
 
-        if(projectName.IsEmpty() == false) {
+        if (projectName.IsEmpty() == false) {
             currentValueStr.Trim().Trim(false);
             BuildConfigPtr buildConf = clCxxWorkspaceST::Get()->GetProjBuildConf(projectName, configName);
-            if(buildConf) {
+            if (buildConf) {
                 currentValueStr << wxT("\n");
                 currentValueStr << buildConf->GetEnvvars();
             }
         }
     }
 
     wxArrayString currentValues = wxStringTokenize(currentValueStr, wxT("\r\n"), wxTOKEN_STRTOK);
-    for(size_t i = 0; i < currentValues.GetCount(); i++) {
+    for (size_t i = 0; i < currentValues.GetCount(); i++) {
         wxString entry = currentValues.Item(i);
 
         // remove any comment from the line
         int where = entry.Find(wxT("#"));
-        if(where != wxNOT_FOUND) {
+        if (where != wxNOT_FOUND) {
             entry = entry.Left(where);
         }
 
         entry.Trim().Trim(false);
-        if(entry.IsEmpty()) {
+        if (entry.IsEmpty()) {
             continue;
         }
 
@@ -136,17 +138,17 @@ wxString EnvVarList::DoGetSetVariablesStr(const wxString& setName, wxString& sel
 
     selectedSetName = setName;
     wxStringMap_t::iterator iter = m_envVarSets.find(setName);
-    if(iter != m_envVarSets.end())
+    if (iter != m_envVarSets.end())
         currentValueStr = iter->second;
     else {
         iter = m_envVarSets.find(m_activeSet);
-        if(iter != m_envVarSets.end()) {
+        if (iter != m_envVarSets.end()) {
             currentValueStr = iter->second;
             selectedSetName = m_activeSet;
         } else {
             selectedSetName = wxT("Default");
             iter = m_envVarSets.find(selectedSetName);
-            if(iter != m_envVarSets.end())
+            if (iter != m_envVarSets.end())
                 currentValueStr = iter->second;
         }
     }
@@ -160,7 +162,7 @@ bool EnvVarList::IsSetExist(const wxString& setName) { return m_envVarSets.find(
 bool EnvMap::Get(const wxString& key, wxString& val)
 {
     int where = m_keys.Index(key);
-    if(where == wxNOT_FOUND)
+    if (where == wxNOT_FOUND)
         return false;
 
     val = m_values.Item(where);
@@ -184,7 +186,7 @@ size_t EnvMap::GetCount() { return m_keys.GetCount(); }
 
 bool EnvMap::Get(size_t index, wxString& key, wxString& val)
 {
-    if(index >= m_keys.GetCount())
+    if (index >= m_keys.GetCount())
         return false;
 
     key = m_keys.Item(index);
@@ -197,11 +199,11 @@ bool EnvMap::Contains(const wxString& key) { return m_keys.Index(key) != wxNOT_F
 wxString EnvMap::String()
 {
     wxString s;
-    for(size_t i = 0; i < m_keys.GetCount(); i++) {
+    for (size_t i = 0; i < m_keys.GetCount(); i++) {
         s << m_keys.Item(i) << wxT("=") << m_values.Item(i) << wxT("\n");
     }
 
-    if(s.IsEmpty() == false)
+    if (s.IsEmpty() == false)
         s.RemoveLast();
 
     return s;

Plugin/envvarlist.h

@@ -25,6 +25,7 @@
 #ifndef __evnvarlist__
 #define __evnvarlist__
 
+#include "clEnvironment.hpp"
 #include "codelite_exports.h"
 #include "macros.h"
 #include "serialized_object.h"
@@ -33,8 +34,6 @@
 
 class WXDLLIMPEXP_SDK EnvMap
 {
-    wxArrayString m_keys;
-    wxArrayString m_values;
 
 public:
     EnvMap() = default;
@@ -47,6 +46,23 @@ class WXDLLIMPEXP_SDK EnvMap
     bool Get(size_t index, wxString& key, wxString& val);
     bool Contains(const wxString& key);
     wxString String();
+
+    inline clEnvList_t ToEnvList() const
+    {
+        clEnvList_t result;
+        if (m_keys.size() != m_values.size()) {
+            return result;
+        }
+        result.reserve(m_keys.size());
+        for (size_t i = 0; i < m_keys.size(); ++i) {
+            result.push_back({m_keys[i].ToStdString(wxConvUTF8), m_values[i].ToStdString(wxConvUTF8)});
+        }
+        return result;
+    }
+
+private:
+    wxArrayString m_keys;
+    wxArrayString m_values;
 };
 
 class WXDLLIMPEXP_SDK EnvVarList : public SerializedObject
@@ -63,7 +79,7 @@ class WXDLLIMPEXP_SDK EnvVarList : public SerializedObject
 
     void SetActiveSet(const wxString& activeSet)
     {
-        if(activeSet != _("<Use Active Set>") && activeSet != USE_GLOBAL_SETTINGS)
+        if (activeSet != _("<Use Active Set>") && activeSet != USE_GLOBAL_SETTINGS)
             this->m_activeSet = activeSet;
     }
 
@@ -81,7 +97,9 @@ class WXDLLIMPEXP_SDK EnvVarList : public SerializedObject
      */
     void InsertVariable(const wxString& setName, const wxString& name, const wxString& value);
 
-    EnvMap GetVariables(const wxString& setName, bool includeWorkspaceEnvs, const wxString& projectName,
+    EnvMap GetVariables(const wxString& setName,
+                        bool includeWorkspaceEnvs,
+                        const wxString& projectName,
                         const wxString& configName);
     bool IsSetExist(const wxString& setName);