Merge branch 'FreeCAD:main' into addedDependencyChecker

chennes · chennes · commit 1c1e343d8a9b · 2025-12-19T15:27:27.000-06:00
diff --git a/.github/ISSUE_TEMPLATE/1-FUNCTIONAL_PROBLEM_REPORT.yml b/.github/ISSUE_TEMPLATE/1-FUNCTIONAL_PROBLEM_REPORT.yml
@@ -7,6 +7,15 @@ body:
       value: |
         Thanks for taking the time to fill out this problem report! Please [search](https://github.com/FreeCAD/FreeCAD/issues) if a similar issue already exists and check out [how to report issues](https://github.com/FreeCAD/FreeCAD?tab=readme-ov-file#reporting-issues). By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/FreeCAD/FreeCAD/blob/main/CODE_OF_CONDUCT.md).
 
+  - type: textarea
+    id: description
+    attributes:
+      label: Problem description
+      description: Describe the problem and how it impacts user experience, workflow, maintainability or performance. You can attach images or log files by clicking this area to highlight it and then dragging files in. To attach a FCStd file, ZIP it first.
+      placeholder: Describe your problem briefly.
+    validations:
+      required: true
+
   - type: dropdown
     id: wb
     attributes:
@@ -28,15 +37,6 @@ body:
         - TechDraw
         - Other (specify in description)
 
-  - type: textarea
-    id: description
-    attributes:
-      label: Problem description
-      description: Describe the problem and how it impacts user experience, workflow, maintainability or performance. You can attach images or log files by clicking this area to highlight it and then dragging files in. To attach a FCStd file, ZIP it first.
-      placeholder: Describe your problem briefly.
-    validations:
-      required: true
-
   - type: textarea
     id: steps_to_reproduce
     attributes:
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -77,3 +77,11 @@ repos:
     rev: 317810f3c6a0ad3572367dc86cb6e41863e16e08  # frozen: v21.1.5
     hooks:
         -   id: clang-format
+-   repo: local
+    hooks:
+      - id: added_dependency
+        name: check for new FreeCAD inter-module dependencies
+        entry: python tools/lint/added_dependency.py
+        language: python
+        files: \.(cpp|h|py|pyi)$
+        pass_filenames: true
diff --git a/cMake/FreeCAD_Helpers/CheckInterModuleDependencies.cmake b/cMake/FreeCAD_Helpers/CheckInterModuleDependencies.cmake
@@ -21,7 +21,7 @@ macro(CheckInterModuleDependencies)
     REQUIRES_MODS(BUILD_BIM                BUILD_PART BUILD_MESH BUILD_MESH_PART BUILD_DRAFT)
     REQUIRES_MODS(BUILD_DRAFT              BUILD_SKETCHER BUILD_TECHDRAW)
     REQUIRES_MODS(BUILD_DRAWING            BUILD_PART BUILD_SPREADSHEET)
-    REQUIRES_MODS(BUILD_FEM                BUILD_PART)
+    REQUIRES_MODS(BUILD_FEM                BUILD_PART BUILD_MESH BUILD_PLOT)
     REQUIRES_MODS(BUILD_IMPORT             BUILD_PART BUILD_PART_DESIGN)
     REQUIRES_MODS(BUILD_INSPECTION         BUILD_MESH BUILD_POINTS BUILD_PART)
     REQUIRES_MODS(BUILD_JTREADER           BUILD_MESH)
@@ -30,7 +30,7 @@ macro(CheckInterModuleDependencies)
     REQUIRES_MODS(BUILD_OPENSCAD           BUILD_MESH_PART BUILD_DRAFT)
     REQUIRES_MODS(BUILD_MATERIAL_EXTERNAL  BUILD_MATERIAL)
     REQUIRES_MODS(BUILD_MEASURE            BUILD_PART)
-    REQUIRES_MODS(BUILD_PART               BUILD_MATERIAL)
+    REQUIRES_MODS(BUILD_PART               BUILD_MATERIAL BUILD_SHOW)
     REQUIRES_MODS(BUILD_PART_DESIGN        BUILD_SKETCHER)
     # REQUIRES_MODS(BUILD_CAM              BUILD_PART BUILD_MESH BUILD_ROBOT)
     REQUIRES_MODS(BUILD_CAM                BUILD_PART BUILD_MESH)
diff --git a/tools/lint/added_dependency.py b/tools/lint/added_dependency.py
@@ -1,11 +1,22 @@
+#!/usr/bin/env python3
 # SPDX-License-Identifier: LGPL-2.1-or-later
 
-"""Script to parse git diff output and determine if any new C++ dependencies were added between FreeCAD modules."""
+"""Script to parse changed files and determine if any new C++ dependencies were added between
+FreeCAD modules."""
 
+import argparse
 import os
 import re
 import sys
 
+from utils import (
+    init_environment,
+    write_file,
+    append_file,
+    emit_problem_matchers,
+    add_common_arguments,
+)
+
 KNOWN_MODULES = [
     "app",
     "base",
@@ -98,7 +109,11 @@ def load_intermodule_dependencies(cmake_file_path: str) -> dict[str, list[str]]:
     """FreeCAD already has a file that defines the known dependencies between modules. The basic rule is that no NEW
     dependencies can be added (without extensive discussion with the core developers). This function loads that file
     and parses it such that we can use it to check if a new dependency was added."""
-    dependencies = {}
+    dependencies = {
+        "base": [],
+        "app": ["base"],
+        "gui": ["app", "base"]
+    }
 
     if not os.path.exists(cmake_file_path):
         print(f"ERROR: {cmake_file_path} not found", file=sys.stderr)
@@ -114,30 +129,54 @@ def load_intermodule_dependencies(cmake_file_path: str) -> dict[str, list[str]]:
         prerequisites = match.group(2).split()
         module_name = dependent.replace("BUILD", "").replace("_", "").lower()
         prereq_names = [p.replace("BUILD", "").replace("_", "").lower() for p in prerequisites]
+        prereq_names.append("app")  # Everything in this list depends on (or is allowed to depend on) App
         dependencies[module_name] = prereq_names
 
-    print()
-    print("Recognized intermodule dependencies")
-    print("-----------------------------------")
-    for module, deps in dependencies.items():
-        print(f"{module} depends on: {', '.join(deps)}")
-    print()
+    for KNOWN_MODULE in KNOWN_MODULES:
+        if KNOWN_MODULE not in dependencies:
+            dependencies[KNOWN_MODULE] = ["app", "base"]  # NOT Gui, which must be handled separately
+
+    resolve_transitive_dependencies(dependencies)
+
+    #print()
+    #print("Recognized intermodule dependencies")
+    #print("-----------------------------------")
+    #for module, deps in dependencies.items():
+    #    print(f"{module} depends on: {', '.join(deps)}")
+    #print()
 
     return dependencies
 
+def resolve_transitive_dependencies(dependencies: dict[str, list[str]]) -> None:
+    changed = True
+    while changed:
+        changed = False
+        for module, deps in dependencies.items():
+            for dep in list(deps):  # copy to avoid mutation during iteration
+                for transitive in dependencies.get(dep, []):
+                    if transitive not in deps:
+                        deps.append(transitive)
+                        changed = True
+
+
 
 def check_file_dependencies(
-    file: str, diff: str, intermodule_dependencies: dict[str, list[str]]
+    file: str, intermodule_dependencies: dict[str, list[str]]
 ) -> bool:
     """Returns true if the dependencies are OK, or false if they are not."""
     file_module = file.split("/")[1]  # src/Gui, etc.
     if file_module == "Mod":
         file_module = file.split("/")[2]  # src/Mod/Part, etc.
-    diff_lines = diff.split("\n")
+    is_gui = "gui" in [x.lower() for x in file.split("/")]
+    with open(file, "r", encoding="utf-8") as f:
+        content = f.read()
+    lines = content.splitlines()
     failed = False
-    for line in diff_lines:
+    line_number = 0
+    for line in lines:
+        line_number += 1
         if file.endswith(".h") or file.endswith(".cpp"):
-            include_file = (m := re.search(r'^\+\s*#include\s*[<"]([^>"]+)[>"]', line)) and m.group(
+            include_file = (m := re.search(r'^\s*#include\s*[<"]([^>"]+)[>"]', line)) and m.group(
                 1
             )
             if include_file:
@@ -149,41 +188,43 @@ def check_file_dependencies(
         elif file.endswith(".py") or file.endswith(".pyi"):
             include_file_module = (
                 m := re.search(
-                    r"^\+\s*(?:from\s+([\w.]+)\s+)?import\s+([\w.]+(?:\s+as\s+\w+)?(?:\s*,\s*[\w.]+(?:\s+as\s+\w+)?)*)",
+                    r"^\s*(?:from\s+([\w.]+)\s+)?import\s+([\w.]+(?:\s+as\s+\w+)?(?:\s*,\s*[\w.]+(?:\s+as\s+\w+)?)*)",
                     line,
                 )
             ) and (m.group(1) or m.group(2))
         else:
             return True
         if not include_file_module:
             continue
+        if is_gui and include_file_module.lower() == "gui":
+            # Special case: anything with "gui" in its path is allowed to include Gui
+            continue
         compatibility = check_module_compatibility(
             file_module.lower(), include_file_module.lower(), intermodule_dependencies
         )
 
         if not compatibility:
             print(
-                f"      👉 {file_module} added a new dependency on {include_file_module}",
+                f"  --> {file_module} added a new dependency on {include_file_module} in {file} line {line_number}",
                 file=sys.stderr,
             )
             failed = True
     return not failed
 
 
-if __name__ == "__main__":
+def main():
+
     dependencies = load_intermodule_dependencies(
         "cMake/FreeCAD_Helpers/CheckIntermoduleDependencies.cmake"
     )
-    piped_diff = sys.stdin.read()
-    file_diffs = parse_diff_by_file(piped_diff)
     failed_files = []
-    for file, diff in file_diffs.items():
-        print(f"Checking changed file {file} for dependency violations...")
-        if not check_file_dependencies(file, diff, dependencies):
-            print(f"  ❌ ERROR: Dependency violation found in {file}")
+    for file in sys.argv[1:]:
+        if not check_file_dependencies(file, dependencies):
             failed_files.append(file)
-        else:
-            print(f"  ✅ No problems found in {file}")
     if failed_files:
         sys.exit(1)
     sys.exit(0)
+
+
+if __name__ == "__main__":
+   main()
