Start adding binding for new IFileTree glob and walk.

Author: Holt59

src/mobase/pybind11_all.h

@@ -13,6 +13,7 @@
 #include "pybind11_qt/pybind11_qt.h"
 
 #include "pybind11_utils/functional.h"
+#include "pybind11_utils/generator.h"
 #include "pybind11_utils/shared_cpp_owner.h"
 #include "pybind11_utils/smart_variant_wrapper.h"
 

src/mobase/wrappers/pyfiletree.cpp

@@ -84,6 +84,9 @@ namespace mo2::python {
     void add_ifiletree_bindings(pybind11::module_& m)
     {
 
+        // register generator for walk and glob
+        register_generator_type<std::shared_ptr<const FileTreeEntry>>(m);
+
         // FileTreeEntry class:
         auto fileTreeEntryClass =
             py::class_<FileTreeEntry, std::shared_ptr<FileTreeEntry>>(m,
@@ -164,6 +167,11 @@ namespace mo2::python {
             .value("SKIP", IFileTree::WalkReturn::SKIP)
             .export_values();
 
+        py::enum_<IFileTree::GlobPatternType>(iFileTreeClass, "GlobPatternType")
+            .value("GLOB", IFileTree::GlobPatternType::GLOB)
+            .value("REGEX", IFileTree::GlobPatternType::REGEX)
+            .export_values();
+
         // Non-mutable operations:
         iFileTreeClass.def("exists",
                            py::overload_cast<QString, IFileTree::FileTypes>(
@@ -175,10 +183,18 @@ namespace mo2::python {
         iFileTreeClass.def("pathTo", &IFileTree::pathTo, py::arg("entry"),
                            py::arg("sep") = "\\");
 
-        // Note: walk() would probably be better as a generator in python, but
-        // it is likely impossible to construct from the C++ walk() method.
-        iFileTreeClass.def("walk", &IFileTree::walk, py::arg("callback"),
-                           py::arg("sep") = "\\");
+        iFileTreeClass.def(
+            "walk",
+            py::overload_cast<
+                std::function<IFileTree::WalkReturn(
+                    QString const&, std::shared_ptr<const FileTreeEntry>)>,
+                QString>(&IFileTree::walk, py::const_),
+            py::arg("callback"), py::arg("sep") = "\\");
+
+        iFileTreeClass.def("walk", py::overload_cast<>(&IFileTree::walk, py::const_));
+
+        iFileTreeClass.def("glob", &IFileTree::glob, py::arg("pattern"),
+                           py::arg("type") = IFileTree::GlobPatternType::GLOB);
 
         // Kind-of-static operations:
         iFileTreeClass.def("createOrphanTree", &IFileTree::createOrphanTree,

src/pybind11-utils/CMakeLists.txt

@@ -2,6 +2,7 @@ cmake_minimum_required(VERSION 3.16)
 
 add_library(pybind11-utils STATIC
 	./include/pybind11_utils/functional.h
+	./include/pybind11_utils/generator.h
 	./include/pybind11_utils/shared_cpp_owner.h
 	./include/pybind11_utils/smart_variant_wrapper.h
 	./include/pybind11_utils/smart_variant.h

src/pybind11-utils/include/pybind11_utils/generator.h

@@ -0,0 +1,36 @@
+#ifndef PYTHON_PYBIND11_GENERATOR_H
+#define PYTHON_PYBIND11_GENERATOR_H
+
+#include <generator>
+
+#include <pybind11/pybind11.h>
+
+namespace mo2::python {
+
+    // create a Python generator from a C++ generator
+    //
+    template <typename T>
+    auto register_generator_type(pybind11::handle scope,
+                                 const char* name = "_mo2_generator")
+    {
+        namespace py = pybind11;
+
+        return py::class_<std::generator<T>>(scope, name, py::module_local())
+            .def("__iter__",
+                 [](std::generator<T>& gen) -> std::generator<T>& {
+                     return gen;
+                 })
+            .def("__next__", [](std::generator<T>& gen) {
+                auto it = gen.begin();
+                if (it != gen.end()) {
+                    return *it;
+                }
+                else {
+                    throw py::stop_iteration();
+                }
+            });
+    }
+
+}  // namespace mo2::python
+
+#endif