#6021: Introduce ThreadedDeclarationTreePopulator as shared base for …

…all the populators dealing with IDeclaration trees
codereader · Jul 29, 2022 · 8aecb59 · 8aecb59
1 parent 02bf1b0
commit 8aecb59
Show file tree

Hide file tree

Showing 13 changed files with 50 additions and 24 deletions.
diff --git a/libs/wxutil/dataview/ThreadedDeclarationTreePopulator.h b/libs/wxutil/dataview/ThreadedDeclarationTreePopulator.h
@@ -0,0 +1,22 @@
+#pragma once
+
+#include "DeclarationTreeView.h"
+#include "ThreadedResourceTreePopulator.h"
+
+namespace wxutil
+{
+
+/**
+ * Shared ThreadedResourceTreePopulator implementation specialising on populating
+ * trees of IDeclaration elements.
+ */
+class ThreadedDeclarationTreePopulator :
+    public ThreadedResourceTreePopulator
+{
+public:
+    ThreadedDeclarationTreePopulator(const DeclarationTreeView::Columns& columns) :
+        ThreadedResourceTreePopulator(columns)
+    {}
+};
+
+}
diff --git a/plugins/dm.editing/ThreadedEntityDefPopulator.h b/plugins/dm.editing/ThreadedEntityDefPopulator.h
@@ -7,14 +7,14 @@
 
 #include "wxutil/Bitmap.h"
 #include "wxutil/dataview/DeclarationTreeView.h"
-#include "wxutil/dataview/ThreadedResourceTreePopulator.h"
+#include "wxutil/dataview/ThreadedDeclarationTreePopulator.h"
 #include "wxutil/dataview/TreeViewItemStyle.h"
 
 namespace ui
 {
 
 class ThreadedEntityDefPopulator :
-    public wxutil::ThreadedResourceTreePopulator
+    public wxutil::ThreadedDeclarationTreePopulator
 {
 private:
     const wxutil::DeclarationTreeView::Columns& _columns;
@@ -24,7 +24,7 @@ class ThreadedEntityDefPopulator :
 
 public:
     ThreadedEntityDefPopulator(const wxutil::DeclarationTreeView::Columns& columns, const std::string& iconName) :
-        ThreadedResourceTreePopulator(columns),
+        ThreadedDeclarationTreePopulator(columns),
         _columns(columns)
     {
         // Get the list of favourites

diff --git a/radiant/ui/animationpreview/MD5AnimationViewer.cpp b/radiant/ui/animationpreview/MD5AnimationViewer.cpp
@@ -11,7 +11,7 @@
 #include "ifavourites.h"
 #include "wxutil/Bitmap.h"
 #include "wxutil/dataview/ResourceTreeViewToolbar.h"
-#include "wxutil/dataview/ThreadedResourceTreePopulator.h"
+#include "wxutil/dataview/ThreadedDeclarationTreePopulator.h"
 #include "wxutil/dataview/TreeViewItemStyle.h"
 
 namespace ui
@@ -21,7 +21,7 @@ namespace ui
  * Visitor class to retrieve modelDefs and add them to folders.
  */
 class ThreadedModelDefLoader final :
-    public wxutil::ThreadedResourceTreePopulator
+    public wxutil::ThreadedDeclarationTreePopulator
 {
 private:
     const wxutil::DeclarationTreeView::Columns& _columns;
@@ -33,7 +33,7 @@ class ThreadedModelDefLoader final :
 
 public:
     ThreadedModelDefLoader(const wxutil::DeclarationTreeView::Columns& columns) :
-        ThreadedResourceTreePopulator(columns),
+        ThreadedDeclarationTreePopulator(columns),
         _columns(columns)
     {
         // Get the list of favourites

diff --git a/radiant/ui/common/ShaderSelector.cpp b/radiant/ui/common/ShaderSelector.cpp
@@ -23,7 +23,7 @@
 #include <functional>
 
 #include "ifavourites.h"
-#include "wxutil/dataview/ThreadedResourceTreePopulator.h"
+#include "wxutil/dataview/ThreadedDeclarationTreePopulator.h"
 #include "wxutil/dataview/TreeViewItemStyle.h"
 
 namespace ui
@@ -41,7 +41,7 @@ namespace
  * Visitor class to retrieve material names and add them to folders.
  */
 class ThreadedMaterialLoader final :
-    public wxutil::ThreadedResourceTreePopulator
+    public wxutil::ThreadedDeclarationTreePopulator
 {
 private:
     const wxutil::DeclarationTreeView::Columns& _columns;
@@ -54,7 +54,7 @@ class ThreadedMaterialLoader final :
 
 public:
     ThreadedMaterialLoader(const wxutil::DeclarationTreeView::Columns& columns, const ShaderSelector::PrefixList& prefixes) :
-        ThreadedResourceTreePopulator(columns),
+        ThreadedDeclarationTreePopulator(columns),
         _columns(columns),
         _prefixes(prefixes)
     {

diff --git a/radiant/ui/common/SkinChooser.cpp b/radiant/ui/common/SkinChooser.cpp
@@ -9,7 +9,7 @@
 
 #include "ifavourites.h"
 #include "debugging/ScopedDebugTimer.h"
-#include "wxutil/dataview/ThreadedResourceTreePopulator.h"
+#include "wxutil/dataview/ThreadedDeclarationTreePopulator.h"
 #include "wxutil/dataview/TreeView.h"
 #include "wxutil/dataview/TreeViewItemStyle.h"
 #include "wxutil/dataview/VFSTreePopulator.h"
@@ -30,7 +30,7 @@ namespace
      * Visitor class to retrieve skin names and add them to folders.
      */
     class ThreadedSkinLoader final :
-        public wxutil::ThreadedResourceTreePopulator
+        public wxutil::ThreadedDeclarationTreePopulator
     {
     private:
         const wxutil::DeclarationTreeView::Columns& _columns;
@@ -48,7 +48,7 @@ namespace
     public:
         ThreadedSkinLoader(const wxutil::DeclarationTreeView::Columns& columns, const std::string& model, 
             wxDataViewItem& allSkinsItem, wxDataViewItem& matchingSkinsItem) :
-            ThreadedResourceTreePopulator(columns),
+            ThreadedDeclarationTreePopulator(columns),
             _columns(columns),
             _allSkinsItem(allSkinsItem),
             _matchingSkinsItem(matchingSkinsItem),

diff --git a/radiant/ui/common/SoundChooser.cpp b/radiant/ui/common/SoundChooser.cpp
@@ -6,7 +6,7 @@
 #include "ifavourites.h"
 #include "registry/registry.h"
 
-#include "wxutil/dataview/ThreadedResourceTreePopulator.h"
+#include "wxutil/dataview/ThreadedDeclarationTreePopulator.h"
 #include "wxutil/dataview/VFSTreePopulator.h"
 #include "wxutil/dataview/TreeViewItemStyle.h"
 #include "wxutil/dataview/ResourceTreeViewToolbar.h"
@@ -97,7 +97,7 @@ class SoundShaderPopulator :
 
 // Local class for loading sound shader definitions in a separate thread
 class ThreadedSoundShaderLoader :
-    public wxutil::ThreadedResourceTreePopulator
+    public wxutil::ThreadedDeclarationTreePopulator
 {
     // Column specification struct
     const wxutil::DeclarationTreeView::Columns& _columns;
@@ -106,7 +106,7 @@ class ThreadedSoundShaderLoader :
 
     // Construct and initialise variables
     ThreadedSoundShaderLoader(const wxutil::DeclarationTreeView::Columns& columns) :
-        ThreadedResourceTreePopulator(columns),
+        ThreadedDeclarationTreePopulator(columns),
         _columns(columns)
     {}
 

diff --git a/radiant/ui/eclasstree/EClassTreeBuilder.cpp b/radiant/ui/eclasstree/EClassTreeBuilder.cpp
@@ -18,7 +18,7 @@ namespace
 }
 
 EClassTreeBuilder::EClassTreeBuilder(const wxutil::DeclarationTreeView::Columns& columns) :
-    ThreadedResourceTreePopulator(columns),
+    ThreadedDeclarationTreePopulator(columns),
     _columns(columns)
 {
     // Get the list of favourites

diff --git a/radiant/ui/eclasstree/EClassTreeBuilder.h b/radiant/ui/eclasstree/EClassTreeBuilder.h
@@ -3,7 +3,7 @@
 #include "ieclass.h"
 
 #include "wxutil/dataview/DeclarationTreeView.h"
-#include "wxutil/dataview/ThreadedResourceTreePopulator.h"
+#include "wxutil/dataview/ThreadedDeclarationTreePopulator.h"
 
 #include <wx/icon.h>
 
@@ -16,7 +16,7 @@ namespace ui
  * Visitor class to retrieve entityDef names and sort them into the hierarchy tree.
  */
 class EClassTreeBuilder final :
-    public wxutil::ThreadedResourceTreePopulator,
+    public wxutil::ThreadedDeclarationTreePopulator,
 	public EntityClassVisitor
 {
 private:

diff --git a/radiant/ui/materials/MaterialPopulator.cpp b/radiant/ui/materials/MaterialPopulator.cpp
@@ -148,7 +148,7 @@ struct ShaderNameFunctor
 
 // Construct and initialise variables
 MaterialPopulator::MaterialPopulator(const MaterialTreeView::TreeColumns& columns) :
-    ThreadedResourceTreePopulator(columns),
+    ThreadedDeclarationTreePopulator(columns),
     _columns(columns)
 {
     _favourites = GlobalFavouritesManager().getFavourites(decl::getTypeName(decl::Type::Material));

diff --git a/radiant/ui/materials/MaterialPopulator.h b/radiant/ui/materials/MaterialPopulator.h
@@ -2,14 +2,14 @@
 
 #include <set>
 
-#include "wxutil/dataview/ThreadedResourceTreePopulator.h"
+#include "wxutil/dataview/ThreadedDeclarationTreePopulator.h"
 #include "MaterialTreeView.h"
 
 namespace ui
 {
 
 class MaterialPopulator :
-    public wxutil::ThreadedResourceTreePopulator
+    public wxutil::ThreadedDeclarationTreePopulator
 {
 private:
     const MaterialTreeView::TreeColumns& _columns;

diff --git a/radiant/ui/particles/ThreadedParticlesLoader.h b/radiant/ui/particles/ThreadedParticlesLoader.h
@@ -5,7 +5,7 @@
 #include "debugging/ScopedDebugTimer.h"
 
 #include "wxutil/dataview/DeclarationTreeView.h"
-#include "wxutil/dataview/ThreadedResourceTreePopulator.h"
+#include "wxutil/dataview/ThreadedDeclarationTreePopulator.h"
 #include "wxutil/dataview/TreeViewItemStyle.h"
 
 namespace ui
@@ -16,7 +16,7 @@ namespace ui
  * treemodel.
  */
 class ThreadedParticlesLoader final :
-    public wxutil::ThreadedResourceTreePopulator
+    public wxutil::ThreadedDeclarationTreePopulator
 {
 private:
     const wxutil::DeclarationTreeView::Columns& _columns;
@@ -25,7 +25,7 @@ class ThreadedParticlesLoader final :
 
 public:
     ThreadedParticlesLoader(const wxutil::DeclarationTreeView::Columns& columns) :
-        ThreadedResourceTreePopulator(columns),
+        ThreadedDeclarationTreePopulator(columns),
         _columns(columns)
     {
         // Get the list of favourites

diff --git a/tools/msvc/wxutillib.vcxproj b/tools/msvc/wxutillib.vcxproj
@@ -141,6 +141,7 @@
     <ClInclude Include="..\..\libs\wxutil\dataview\KeyValueTable.h" />
     <ClInclude Include="..\..\libs\wxutil\dataview\ResourceTreeView.h" />
     <ClInclude Include="..\..\libs\wxutil\dataview\ResourceTreeViewToolbar.h" />
+    <ClInclude Include="..\..\libs\wxutil\dataview\ThreadedDeclarationTreePopulator.h" />
     <ClInclude Include="..\..\libs\wxutil\dataview\ThreadedResourceTreePopulator.h" />
     <ClInclude Include="..\..\libs\wxutil\dataview\TreeModel.h" />
     <ClInclude Include="..\..\libs\wxutil\dataview\TreeModelFilter.h" />

diff --git a/tools/msvc/wxutillib.vcxproj.filters b/tools/msvc/wxutillib.vcxproj.filters
@@ -157,6 +157,9 @@
     </ClInclude>
     <ClInclude Include="..\..\libs\wxutil\DeclarationSourceView.h" />
     <ClInclude Include="..\..\libs\wxutil\DefinitionView.h" />
+    <ClInclude Include="..\..\libs\wxutil\dataview\ThreadedDeclarationTreePopulator.h">
+      <Filter>dataview</Filter>
+    </ClInclude>
   </ItemGroup>
   <ItemGroup>
     <ClCompile Include="..\..\libs\wxutil\dialog\MessageBox.cpp">