Uniform common headers in project

[Czaki]

As coderabbit suggest

🧹 Outside diff range and nitpick comments (1)

CMakeLists.txt (1)

36-68: Consider consolidating common headers.

I notice that my_queue.h exists in both sprawl_utils and multiscale_opening directories. Consider consolidating common headers into a shared include directory to avoid duplication and potential maintenance issues.

Suggested approaches:

1. Move common headers to a shared include directory (e.g., src/PartSegCore_compiled_backend/include/)
2. Update include paths in CMake accordingly
3. Consider using symbolic links if the headers need to remain in their current locations

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 427f608 and e984759.

📒 Files selected for processing (1)

• CMakeLists.txt (1 hunks)

🔇 Additional comments (3)

CMakeLists.txt (3)

36-68: LGTM! Headers are consistently added across all sprawl_utils modules.

The changes look good overall. The headers are consistently added to all relevant modules, and the installation setup remains correct with all affected modules being installed to the same destination.

---

36-40: Verify header file existence and check other sprawl_utils modules.

The header additions look correct, but let's verify the existence of these files and check if other modules in the sprawl_utils directory might need these headers for consistency.

✅ Verification successful

Headers are correctly added to all relevant modules

The verification shows that:

1. Both header files (my_queue.h and global_consts.h) are included in distance_utils.pxd, which is a common interface file for the sprawl utils modules.
2. The headers are consistently added to all four Cython modules in the sprawl_utils directory that need them:
   • euclidean_cython
   • path_sprawl_cython
   • sprawl_utils
   • fuzzy_distance

The changes are complete and consistent, properly adding the required headers to all relevant modules in the CMakeLists.txt file.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check if the header files exist
if ! [ -f "src/PartSegCore_compiled_backend/sprawl_utils/my_queue.h" ] || \
   ! [ -f "src/PartSegCore_compiled_backend/sprawl_utils/global_consts.h" ]; then
    echo "Warning: One or both header files are missing!"
fi

# Find all .pyx files in sprawl_utils to check if we missed any modules
fd -e pyx . src/PartSegCore_compiled_backend/sprawl_utils/

Length of output: 540

---

Script:

#!/bin/bash
# Let's check if these headers are included in any of the .pyx files
echo "=== Checking my_queue.h inclusions ==="
rg -l "my_queue\.h" src/PartSegCore_compiled_backend/sprawl_utils/

echo -e "\n=== Checking global_consts.h inclusions ==="
rg -l "global_consts\.h" src/PartSegCore_compiled_backend/sprawl_utils/

# Also check the CMakeLists.txt to see all python_add_library commands
echo -e "\n=== Checking CMakeLists.txt for python_add_library ==="
rg "python_add_library" CMakeLists.txt -A 4

Length of output: 2791

---

45-49: Verify header dependencies in Cython modules.

The headers are consistently added across all sprawl_utils modules. Let's verify that these headers are actually used in the Cython files and check for any potential circular dependencies.

Also applies to: 54-58, 64-68

✅ Verification successful

Headers are correctly included and used across modules

The verification confirms that both headers are essential and properly used across the sprawl_utils modules:

1. my_queue.h provides a custom queue implementation that is actively used across multiple Cython modules:

   • Used via my_queue[Point] in path_sprawl_cython.pyx, fuzzy_distance.pyx, euclidean_cython.pyx, and put_borders_in_queue.pyx
   • The queue implementation is critical for the border processing algorithms

2. global_consts.h provides shared constants used across the modules:

   • Contains neighborhood definitions and distance constants used by the path sprawl algorithms
   • The neighborhood arrays are used in conjunction with the queue operations for traversal

The consistent inclusion of these headers across all modules is justified by their shared functionality, and there are no circular dependencies or unused includes.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check for header inclusions in the Cython source files
echo "Checking my_queue.h usage:"
rg -l "my_queue\.h" "src/PartSegCore_compiled_backend/sprawl_utils/*.pyx"

echo "Checking global_consts.h usage:"
rg -l "global_consts\.h" "src/PartSegCore_compiled_backend/sprawl_utils/*.pyx"

Length of output: 476

---

Script:

#!/bin/bash
# First, let's find the actual Cython source files
echo "Finding Cython source files:"
fd -e pyx . src/PartSegCore_compiled_backend/sprawl_utils/

echo "\nChecking my_queue.h usage:"
fd -e pyx . src/PartSegCore_compiled_backend/sprawl_utils/ -x rg -l "my_queue\.h" {}

echo "\nChecking global_consts.h usage:"
fd -e pyx . src/PartSegCore_compiled_backend/sprawl_utils/ -x rg -l "global_consts\.h" {}

# Let's also check the actual header files to understand their content
echo "\nChecking if header files exist:"
ls -l src/PartSegCore_compiled_backend/sprawl_utils/my_queue.h src/PartSegCore_compiled_backend/sprawl_utils/global_consts.h

echo "\nPeeking into header files (if they exist):"
echo "my_queue.h:"
cat src/PartSegCore_compiled_backend/sprawl_utils/my_queue.h
echo "\nglobal_consts.h:"
cat src/PartSegCore_compiled_backend/sprawl_utils/global_consts.h

Length of output: 4144

---

Script:

#!/bin/bash
# Let's check the actual usage of these headers in the Cython files
echo "Checking header includes in Cython files:"
for f in $(fd -e pyx . src/PartSegCore_compiled_backend/sprawl_utils/); do
    echo "\nFile: $f"
    rg "cdef extern from" -A 2 "$f"
done

# Also check if there are any .cpp files generated from Cython that might use these headers
echo "\nChecking for generated cpp files:"
fd -e cpp . src/PartSegCore_compiled_backend/sprawl_utils/

# If any cpp files found, check their includes
for f in $(fd -e cpp . src/PartSegCore_compiled_backend/sprawl_utils/); do
    echo "\nChecking includes in $f:"
    rg "#include" "$f"
done

Length of output: 1998

---

Script:

#!/bin/bash
# Let's check the content of the Cython files directly for any usage patterns
echo "Checking path_sprawl_cython.pyx content:"
cat src/PartSegCore_compiled_backend/sprawl_utils/path_sprawl_cython.pyx

echo "\nChecking for queue-related patterns in all Cython files:"
rg -i "queue" src/PartSegCore_compiled_backend/sprawl_utils/*.pyx

echo "\nChecking for neighborhood/distance patterns in all Cython files:"
rg -i "neigh|distance" src/PartSegCore_compiled_backend/sprawl_utils/*.pyx

Length of output: 18625

Originally posted by @coderabbitai[bot] in #54 (review)