Ticket #1696: progress_1696_I.patch

binaries/data/mods/public/simulation/data/atlasFilters.json

@@ +1 @@
+{
+    "_comments" : "excludeFolders support regular expression to filter folders",
+    "excludeFolders": "(rubble|formations|special)"
+}
+ No newline at end of file

source/lib/file/vfs/vfs_util.cpp

@@ -33 +33 @@
 
 #include "lib/sysdep/filesystem.h"
 #include "lib/regex.h"
+#include <boost/regex.hpp>
 
 
 namespace vfs {
@@ -54 +55 @@
     return INFO::OK;
 }
 
-
-Status ForEachFile(const PIVFS& fs, const VfsPath& startPath, FileCallback cb, uintptr_t cbData, const wchar_t* pattern, size_t flags)
+Status ForEachFile(const PIVFS& fs, const VfsPath& startPath, FileCallback cb, uintptr_t cbData, const wchar_t* pattern, size_t flags, const wchar_t* excludeFolderPattern)
 {
     // (declare here to avoid reallocations)
     CFileInfos files; DirectoryNames subdirectoryNames;
+    boost::wregex* excludeFolderRegex = NULL;
 
     // (a FIFO queue is more efficient than recursion because it uses less
     // stack space and avoids seeks due to breadth-first traversal.)
@@ -83 +84 @@
         if(!(flags & DIR_RECURSIVE))
             break;
 
-        for(size_t i = 0; i < subdirectoryNames.size(); i++)
-            pendingDirectories.push(path / subdirectoryNames[i]/"");
+        for (size_t i = 0; i < subdirectoryNames.size(); i++)
+        {
+            if (excludeFolderPattern != NULL)
+            {
+                if (excludeFolderRegex == NULL)
+                {
+                    excludeFolderRegex = new boost::wregex(excludeFolderPattern);
+                }
+                
+                if (boost::regex_match(subdirectoryNames[i].string().c_str(), *excludeFolderRegex))
+                {
+                    //Exclude folder
+                    continue;
+                }
+            }
+
+            pendingDirectories.push(path / subdirectoryNames[i] / "");
+        }
+            
         pendingDirectories.pop();
     }
 

source/lib/file/vfs/vfs_util.h

@@ -63 +63 @@
  * @param pattern that file names must match. '*' and '&' wildcards
  *        are allowed. 0 matches everything.
  * @param flags @ref DirFlags
+ * @param excludeFolderPattern regular expression to exclude folders
  * @return Status
  **/
-extern Status ForEachFile(const PIVFS& fs, const VfsPath& path, FileCallback cb, uintptr_t cbData, const wchar_t* pattern = 0, size_t flags = 0);
+extern Status ForEachFile(const PIVFS& fs, const VfsPath& path, FileCallback cb, uintptr_t cbData, const wchar_t* pattern = 0, size_t flags = 0, const wchar_t* excludeFolderPattern = 0);
 
 
 /**

source/ps/TemplateLoader.cpp

@@ -191 +191 @@
     return INFO::OK;
 }
 
-std::vector<std::string> CTemplateLoader::FindTemplates(const std::string& path, bool includeSubdirectories, ETemplatesType templatesType)
+std::vector<std::string> CTemplateLoader::FindTemplates(const std::string& path, bool includeSubdirectories, ETemplatesType templatesType, const wchar_t* excludeFolders)
 {
     std::vector<std::string> templates;
 
@@ -202 +202 @@
     {
         templatePath = VfsPath(TEMPLATE_ROOT) / path;
         if (includeSubdirectories)
-            ok = vfs::ForEachFile(g_VFS, templatePath, AddToTemplates, (uintptr_t)&templates, L"*.xml", vfs::DIR_RECURSIVE);
+            ok = vfs::ForEachFile(g_VFS, templatePath, AddToTemplates, (uintptr_t)&templates, L"*.xml", vfs::DIR_RECURSIVE, excludeFolders);
         else
             ok = vfs::ForEachFile(g_VFS, templatePath, AddToTemplates, (uintptr_t)&templates, L"*.xml");
         WARN_IF_ERR(ok);

source/ps/TemplateLoader.h

@@ -53 +53 @@
      * Returns a list of strings that could be validly passed as @c templateName to LoadTemplateFile.
      * (This includes "actor|foo" etc names).
      */
-    std::vector<std::string> FindTemplates(const std::string& path, bool includeSubdirectories, ETemplatesType templatesType);
+    std::vector<std::string> FindTemplates(const std::string& path, bool includeSubdirectories, ETemplatesType templatesType, const wchar_t* excludeFolders = 0);
 
 private:
     /**

source/simulation2/components/CCmpTemplateManager.cpp

@@ -128 +128 @@
 
     virtual std::string GetCurrentTemplateName(entity_id_t ent);
 
+    virtual std::vector<std::string> FindAllTemplates(bool includeActors, const wchar_t* excludeFolders);
+
     virtual std::vector<std::string> FindAllTemplates(bool includeActors);
 
     virtual std::vector<entity_id_t> GetEntitiesUsingTemplate(std::string templateName);
@@ -228 +230 @@
 
 std::vector<std::string> CCmpTemplateManager::FindAllTemplates(bool includeActors)
 {
+    return FindAllTemplates(includeActors, NULL);
+}
+
+std::vector<std::string> CCmpTemplateManager::FindAllTemplates(bool includeActors, const wchar_t* excludeFolders)
+{
     ETemplatesType templatesType = includeActors ? ALL_TEMPLATES : SIMULATION_TEMPLATES;
-    return m_templateLoader.FindTemplates("", true, templatesType);
+    return m_templateLoader.FindTemplates("", true, templatesType, excludeFolders);
 }
 
 /**

source/simulation2/components/ICmpTemplateManager.h

@@ -97 +97 @@
      * (This includes "actor|foo" etc names).
      * Intended for use by the map editor. This is likely to be quite slow.
      */
+    virtual std::vector<std::string> FindAllTemplates(bool includeActors, const wchar_t* excludeFolders) = 0;
     virtual std::vector<std::string> FindAllTemplates(bool includeActors) = 0;
 
     /**

source/tools/atlas/GameInterface/Handlers/ObjectHandlers.cpp

@@ -65 +65 @@
 {
     std::vector<sObjectsListItem> objects;
 
+    ScriptInterface& scriptInterface = g_Game->GetSimulation2()->GetScriptInterface();
+
+    CScriptValRooted s = scriptInterface.ReadJSONFile("simulation/data/atlasFilters.json");
+    std::wstring excludeFolders;
+    scriptInterface.GetProperty(s.get(), "excludeFolders", excludeFolders);
+    
     CmpPtr<ICmpTemplateManager> cmpTemplateManager(*g_Game->GetSimulation2(), SYSTEM_ENTITY);
     if (cmpTemplateManager)
     {
-        std::vector<std::string> names = cmpTemplateManager->FindAllTemplates(true);
+        std::vector<std::string> names = cmpTemplateManager->FindAllTemplates(true, excludeFolders.c_str());
 
         for (std::vector<std::string>::iterator it = names.begin(); it != names.end(); ++it)
         {