Move glob() and walk() generator versions to standalone functions.

Author: Holt59

include/uibase/ifiletree.h

@@ -29,6 +29,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 #include <mutex>
 #include <stdexcept>
 #include <vector>
+#include <version>
 
 #include <QDateTime>
 #include <QFlags>
@@ -112,14 +113,6 @@ struct QDLLEXPORT UnsupportedOperationException : public Exception
   using Exception::Exception;
 };
 
-/**
- * @brief Exception thrown when an invalid glob pattern is specified.
- */
-struct QDLLEXPORT InvalidGlobPatternException : public Exception
-{
-  using Exception::Exception;
-};
-
 /**
  * @brief Represent an entry in a file tree, either a file or a directory. This class
  *     inherited by IFileTree so that operations on entry are the same for a file or
@@ -631,20 +624,6 @@ class QDLLEXPORT IFileTree : public virtual FileTreeEntry
 
   };
 
-  enum class GlobPatternType
-  {
-    /**
-     * @brief Glob mode, similar to python pathlib.Path.glob function
-     */
-    GLOB,
-
-    /**
-     * @brief Regex mode, each part of the pattern (between / or \) is considered a
-     * regex, except for ** which is still considered as glob.
-     */
-    REGEX
-  };
-
   /**
    * @brief Walk this tree, calling the given function for each entry in it.
    *
@@ -662,27 +641,6 @@ class QDLLEXPORT IFileTree : public virtual FileTreeEntry
            callback,
        QString sep = "\\") const;
 
-  /**
-   * @brief Walk this tree, returning entries.
-   *
-   * During the walk, parent tree are guaranteed to be visited before their childrens.
-   * The current tree is not included in the return generator.
-   *
-   * @return a generator over the entries.
-   */
-  std::generator<std::shared_ptr<const FileTreeEntry>> walk() const;
-
-  /**
-   * @brief Glob entries matching the given pattern in this tree.
-   *
-   * @param pattern Glob pattern to match, using the same syntax as QRegularExpression.
-   * @param patternType Type of the pattern.
-   *
-   * @return a generator over the entries matching the given pattern.
-   */
-  std::generator<std::shared_ptr<const FileTreeEntry>>
-  glob(QString pattern, GlobPatternType patternType = GlobPatternType::GLOB) const;
-
 public:  // Utility functions:
   /**
    * @brief Create a new orphan empty tree.
@@ -1161,4 +1119,12 @@ class QDLLEXPORT IFileTree : public virtual FileTreeEntry
 
 }  // namespace MOBase
 
+// __has_cpp_attribute(__cpp_lib_generator) does not seem to work, maybe some conflict
+// with Qt?
+#ifdef __cpp_lib_generator
+
+#include "ifiletree_utils.h"
+
+#endif
+
 #endif

include/uibase/ifiletree_utils.h

@@ -0,0 +1,82 @@
+/*
+Mod Organizer shared UI functionality
+
+Copyright (C) 2020 MO2 Team. All rights reserved.
+
+This library is free software; you can redistribute it and/or
+modify it under the terms of the GNU Lesser General Public
+License as published by the Free Software Foundation; either
+version 3 of the License, or (at your option) any later version.
+
+This library is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public
+License along with this library; if not, write to the Free Software
+Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+*/
+
+#ifndef UIBASE_IFILETREE_UTILS_H
+#define UIBASE_IFILETREE_UTILS_H
+
+#include <generator>
+
+#include <QString>
+
+#include "dllimport.h"
+#include "exceptions.h"
+#include "ifiletree.h"
+
+namespace MOBase
+{
+
+/**
+ * @brief Exception thrown when an invalid glob pattern is specified.
+ */
+struct QDLLEXPORT InvalidGlobPatternException : public Exception
+{
+  using Exception::Exception;
+};
+
+enum class GlobPatternType
+{
+  /**
+   * @brief Glob mode, similar to python pathlib.Path.glob function
+   */
+  GLOB,
+
+  /**
+   * @brief Regex mode, each part of the pattern (between / or \) is considered a
+   * regex, except for ** which is still considered as glob.
+   */
+  REGEX
+};
+
+/**
+ * @brief Walk this tree, returning entries.
+ *
+ * During the walk, parent tree are guaranteed to be visited before their childrens.
+ * The current tree is not included in the return generator.
+ *
+ * @return a generator over the entries.
+ */
+QDLLEXPORT std::generator<std::shared_ptr<const FileTreeEntry>>
+walk(std::shared_ptr<const IFileTree> fileTree);
+
+/**
+ * @brief Glob entries matching the given pattern in this tree.
+ *
+ * @param pattern Glob pattern to match, using the same syntax as QRegularExpression.
+ * @param patternType Type of the pattern.
+ *
+ * @return a generator over the entries matching the given pattern.
+ */
+QDLLEXPORT std::generator<std::shared_ptr<const FileTreeEntry>>
+glob(std::shared_ptr<const IFileTree> fileTree, QString pattern,
+     GlobPatternType patternType = GlobPatternType::GLOB);
+
+}  // namespace MOBase
+
+#endif

src/CMakeLists.txt

@@ -35,6 +35,7 @@ set(root_headers
 )
 set(interface_headers
 	../include/uibase/ifiletree.h
+	../include/uibase/ifiletree_utils.h
 	../include/uibase/iinstallationmanager.h
 	../include/uibase/imodinterface.h
 	../include/uibase/imodlist.h