Added Rescan option to the PluginRegistrationDialog.

audacity · Aug 9, 2022 · 0c8c66d · 0c8c66d
1 parent 11ecb32
commit 0c8c66d
Show file tree

Hide file tree

Showing 4 changed files with 88 additions and 33 deletions.
diff --git a/libraries/lib-module-manager/PluginManager.cpp b/libraries/lib-module-manager/PluginManager.cpp
@@ -402,7 +402,7 @@ void PluginManager::Initialize(FileConfigFactory factory)
       // Allow the module to auto-register children
       module->AutoRegisterPlugins(*this);
    }
-   
+
    InitializePlugins();
 }
 
@@ -1143,6 +1143,19 @@ ComponentInterface *PluginManager::Load(const PluginID & ID)
    return nullptr;
 }
 
+void PluginManager::ClearEffectPlugins()
+{
+   for (auto it = mRegisteredPlugins.cbegin(); it != mRegisteredPlugins.cend(); ++it)
+   {
+      auto& desc = it->second;
+      if (desc.GetPluginType() == PluginTypeEffect)
+      {
+         mLoadedInterfaces.erase(desc.GetID());
+         it = mRegisteredPlugins.erase(it);
+      }
+   }
+}
+
 std::map<wxString, std::vector<wxString>> PluginManager::CheckPluginUpdates()
 {
    wxArrayString pathIndex;

diff --git a/libraries/lib-module-manager/PluginManager.h b/libraries/lib-module-manager/PluginManager.h
@@ -153,6 +153,8 @@ class MODULE_MANAGER_API PluginManager final : public PluginManagerInterface
    const ComponentInterfaceSymbol & GetSymbol(const PluginID & ID);
    ComponentInterface *Load(const PluginID & ID);
 
+   void ClearEffectPlugins();
+
    /**
     * \brief Ensures that all currently registered plugins still exist
     * and scans for new ones.

diff --git a/src/PluginRegistrationDialog.cpp b/src/PluginRegistrationDialog.cpp
@@ -12,6 +12,7 @@
 #include "EffectInterface.h"
 #include "ModuleManager.h"
 #include "PluginManager.h"
+#include "PluginStartupRegistration.h"
 #include "ShuttleGui.h"
 #include "widgets/AudacityMessageBox.h"
 #include "widgets/ProgressDialog.h"
@@ -359,6 +360,7 @@ enum
    ID_List,
    ID_ClearAll,
    ID_SelectAll,
+   ID_Rescan,
    ID_Enable,
    ID_Disable,
 };
@@ -376,6 +378,7 @@ BEGIN_EVENT_TABLE(PluginRegistrationDialog, wxDialogWrapper)
    EVT_LIST_COL_CLICK(ID_List, PluginRegistrationDialog::OnSort)
    EVT_BUTTON(wxID_OK, PluginRegistrationDialog::OnOK)
    EVT_BUTTON(wxID_CANCEL, PluginRegistrationDialog::OnCancel)
+   EVT_BUTTON(ID_Rescan, PluginRegistrationDialog::OnRescan)
    EVT_BUTTON(ID_ClearAll, PluginRegistrationDialog::OnClearAll)
    EVT_BUTTON(ID_SelectAll, PluginRegistrationDialog::OnSelectAll)
    EVT_BUTTON(ID_Enable, PluginRegistrationDialog::OnEnable)
@@ -510,6 +513,7 @@ void PluginRegistrationDialog::PopulateOrExchange(ShuttleGui &S)
          {
             S.Id(ID_SelectAll).AddButton(XXO("&Select All"));
             S.Id(ID_ClearAll).AddButton(XXO("C&lear All"));
+            S.Id(ID_Rescan).AddButton(XXO("Rescan"));
 
             S.StartHorizontalLay(wxALIGN_CENTER);
             {
@@ -543,45 +547,20 @@ void PluginRegistrationDialog::PopulateOrExchange(ShuttleGui &S)
    }
 
    PluginManager & pm = PluginManager::Get();
-   for (auto &plug : pm.AllPlugins()) {
-      PluginType plugType = plug.GetPluginType();
-      if (plugType != PluginTypeEffect && plugType != PluginTypeStub)
-         continue;
+   PopulateItemsList(pm);
 
-      const auto &path = plug.GetPath();
-      ItemData & item = mItems[path];  // will create NEW entry
-      item.plugs.push_back(&plug);
-      item.path = path;
-      item.state = plug.IsEnabled() ? STATE_Enabled : STATE_Disabled;
-      item.valid = plug.IsValid();
-
-      if (plugType == PluginTypeEffect)
-      {
-         item.name = plug.GetSymbol().Translation();
-      }
-      // This is not right and will not work when other plugin types are added.
-      // But it's presumed that the plugin manager dialog will be fully developed
-      // by then.
-      else if (plugType == PluginTypeStub)
-      {
-         wxFileName fname { path };
-         item.name = fname.GetName().Trim(false).Trim(true);
-#ifndef DISABLE_STATE_NEW
-         if (!item.valid)
-         {
-            item.state = STATE_New;
-         }
-#endif
-      }
+   for (const auto& item : mItems)
+   {
+      const auto& itemData = item.second;
 
       int x;
-      mEffects->GetTextExtent(item.name, &x, NULL);
+      mEffects->GetTextExtent(itemData.name, &x, NULL);
       colWidths[COL_Name] = wxMax(colWidths[COL_Name], x);
 
-      mEffects->GetTextExtent(item.path, &x, NULL);
+      mEffects->GetTextExtent(itemData.path, &x, NULL);
       if (x > colWidths[COL_Path])
       {
-         mLongestPath = item.path;
+         mLongestPath = itemData.path;
       }
       colWidths[COL_Path] = wxMax(colWidths[COL_Path], x);
    }
@@ -626,6 +605,42 @@ void PluginRegistrationDialog::PopulateOrExchange(ShuttleGui &S)
 
 }
 
+void PluginRegistrationDialog::PopulateItemsList(PluginManager& pm)
+{
+   for (auto& plug : pm.AllPlugins())
+   {
+      PluginType plugType = plug.GetPluginType();
+      if (plugType != PluginTypeEffect && plugType != PluginTypeStub)
+         continue;
+
+      const auto& path = plug.GetPath();
+      ItemData& item = mItems[path];  // will create NEW entry
+      item.plugs.push_back(&plug);
+      item.path = path;
+      item.state = plug.IsEnabled() ? STATE_Enabled : STATE_Disabled;
+      item.valid = plug.IsValid();
+
+      if (plugType == PluginTypeEffect)
+      {
+         item.name = plug.GetSymbol().Translation();
+      }
+      // This is not right and will not work when other plugin types are added.
+      // But it's presumed that the plugin manager dialog will be fully developed
+      // by then.
+      else if (plugType == PluginTypeStub)
+      {
+         wxFileName fname{ path };
+         item.name = fname.GetName().Trim(false).Trim(true);
+#ifndef DISABLE_STATE_NEW
+         if (!item.valid)
+         {
+            item.state = STATE_New;
+         }
+#endif
+      }
+   }
+}
+
 void PluginRegistrationDialog::RegenerateEffectsList(int filter)
 {
    mFilter = filter;
@@ -851,6 +866,28 @@ void PluginRegistrationDialog::OnClearAll(wxCommandEvent & WXUNUSED(evt))
    }
 }
 
+void PluginRegistrationDialog::OnRescan(wxCommandEvent& WXUNUSED(evt))
+{
+   mItems.clear();
+   mEffects->DeleteAllItems();
+   mEffects->Update();
+
+   wxTheApp->CallAfter([this] {
+      auto& pm = PluginManager::Get();
+      pm.ClearEffectPlugins();
+
+      auto newPlugins = PluginManager::Get().CheckPluginUpdates();
+      if (!newPlugins.empty())
+      {
+         PluginStartupRegistration reg(newPlugins);
+         reg.Run();
+      }
+
+      PopulateItemsList(pm);
+      RegenerateEffectsList(mFilter);
+   });
+}
+
 void PluginRegistrationDialog::OnEnable(wxCommandEvent & WXUNUSED(evt))
 {
    std::vector<long> items;

diff --git a/src/PluginRegistrationDialog.h b/src/PluginRegistrationDialog.h
@@ -17,6 +17,7 @@
 class CheckListAx;
 enum EffectType : int;
 class PluginDescriptor;
+class PluginManager;
 class ShuttleGui;
 class wxListEvent;
 class wxListCtrl;
@@ -44,6 +45,7 @@ class PluginRegistrationDialog final : public wxDialogWrapper
 
    void Populate();
    void PopulateOrExchange(ShuttleGui & S);
+   void PopulateItemsList(PluginManager& pm);
    void RegenerateEffectsList(int iShowWhat);
    void SetState(int i, bool toggle, bool state = true);
 
@@ -58,6 +60,7 @@ class PluginRegistrationDialog final : public wxDialogWrapper
    void OnCancel(wxCommandEvent & evt);
    void OnSelectAll(wxCommandEvent & evt);
    void OnClearAll(wxCommandEvent & evt);
+   void OnRescan(wxCommandEvent & evt);
    void OnEnable(wxCommandEvent & evt);
    void OnDisable(wxCommandEvent & evt);