Move helper functions out of Magic.gi

Author: fingolfin

gap/Magic.gi

@@ -5,74 +5,6 @@
 #
 # SPDX-License-Identifier: GPL-2.0-or-later
 
-# Given a string containing a ".", , return its suffix,
-# i.e. the bit after the last ".". For example, given "test.txt",
-# it returns "txt".
-BindGlobal( "AUTODOC_GetSuffix",
-function(str)
-    local i;
-    i := Length(str);
-    while i > 0 and str[i] <> '.' do i := i - 1; od;
-    if i = 0 then return ""; fi;
-    return str{[i+1..Length(str)]};
-end );
-
-# Scan the given (by name) subdirs of a package dir for
-# files with one of the given extensions, and return the corresponding
-# filenames, as relative paths (relative to the package dir).
-#
-# For example, the invocation
-#   AUTODOC_FindMatchingFiles(pkgdir, [ "gap/" ], [ "gi", "gd" ]);
-# might return a list looking like
-#  [ "gap/AutoDocMainFunction.gd", "gap/AutoDocMainFunction.gi", ... ]
-BindGlobal( "AUTODOC_FindMatchingFiles",
-function (pkgdir, subdirs, extensions)
-    local result, JoinRelativePath, AddMatchingFiles, d_rel;
-
-    result := [];
-
-    JoinRelativePath := function( dir, entry )
-        if dir = "" then
-            return entry;
-        fi;
-        return Concatenation( dir, "/", entry );
-    end;
-
-    AddMatchingFiles := function( abs_dir, rel_dir, recursive )
-        local abs_dir_obj, entries, entry, abs_entry, rel_entry;
-
-        abs_dir_obj := Directory( abs_dir );
-        entries := DirectoryContents( abs_dir_obj );
-        Sort( entries );
-        for entry in entries do
-            if entry = "." or entry = ".." then
-                continue;
-            fi;
-            abs_entry := Filename( abs_dir_obj, entry );
-            rel_entry := JoinRelativePath( rel_dir, entry );
-            if IsDirectoryPath( abs_entry ) then
-                if recursive then
-                    AddMatchingFiles( abs_entry, rel_entry, true );
-                fi;
-            elif AUTODOC_GetSuffix( entry ) in extensions and
-                 IsReadableFile( abs_entry ) then
-                Add( result, rel_entry );
-            fi;
-        od;
-    end;
-
-    for d_rel in subdirs do
-        if d_rel = "" or d_rel = "." then
-            AddMatchingFiles( Filename( pkgdir, "" ), "", false );
-        elif not IsDirectoryPath( Filename( pkgdir, d_rel ) ) then
-            continue;
-        else
-            AddMatchingFiles( Filename( pkgdir, d_rel ), d_rel, true );
-        fi;
-    od;
-    return result;
-end );
-
 #
 InstallGlobalFunction( AutoDoc,
 function( arg )

gap/ToolFunctions.gi

@@ -5,6 +5,74 @@
 #
 # SPDX-License-Identifier: GPL-2.0-or-later
 
+# Given a string containing a ".", , return its suffix,
+# i.e. the bit after the last ".". For example, given "test.txt",
+# it returns "txt".
+BindGlobal( "AUTODOC_GetSuffix",
+function(str)
+    local i;
+    i := Length(str);
+    while i > 0 and str[i] <> '.' do i := i - 1; od;
+    if i = 0 then return ""; fi;
+    return str{[i+1..Length(str)]};
+end );
+
+# Scan the given (by name) subdirs of a package dir for
+# files with one of the given extensions, and return the corresponding
+# filenames, as relative paths (relative to the package dir).
+#
+# For example, the invocation
+#   AUTODOC_FindMatchingFiles(pkgdir, [ "gap/" ], [ "gi", "gd" ]);
+# might return a list looking like
+#  [ "gap/AutoDocMainFunction.gd", "gap/AutoDocMainFunction.gi", ... ]
+BindGlobal( "AUTODOC_FindMatchingFiles",
+function (pkgdir, subdirs, extensions)
+    local result, JoinRelativePath, AddMatchingFiles, d_rel;
+
+    result := [];
+
+    JoinRelativePath := function( dir, entry )
+        if dir = "" then
+            return entry;
+        fi;
+        return Concatenation( dir, "/", entry );
+    end;
+
+    AddMatchingFiles := function( abs_dir, rel_dir, recursive )
+        local abs_dir_obj, entries, entry, abs_entry, rel_entry;
+
+        abs_dir_obj := Directory( abs_dir );
+        entries := DirectoryContents( abs_dir_obj );
+        Sort( entries );
+        for entry in entries do
+            if entry = "." or entry = ".." then
+                continue;
+            fi;
+            abs_entry := Filename( abs_dir_obj, entry );
+            rel_entry := JoinRelativePath( rel_dir, entry );
+            if IsDirectoryPath( abs_entry ) then
+                if recursive then
+                    AddMatchingFiles( abs_entry, rel_entry, true );
+                fi;
+            elif AUTODOC_GetSuffix( entry ) in extensions and
+                 IsReadableFile( abs_entry ) then
+                Add( result, rel_entry );
+            fi;
+        od;
+    end;
+
+    for d_rel in subdirs do
+        if d_rel = "" or d_rel = "." then
+            AddMatchingFiles( Filename( pkgdir, "" ), "", false );
+        elif not IsDirectoryPath( Filename( pkgdir, d_rel ) ) then
+            continue;
+        else
+            AddMatchingFiles( Filename( pkgdir, d_rel ), d_rel, true );
+        fi;
+    od;
+    return result;
+end );
+
 # Ensure that the directory named by the given path string exists, creating any
 # missing parent directories on the way. Relative paths are accepted and `.` /
 # `..` components are normalized before creating directories.