Sort includes using clang-format (#129)

* Sort includes using clang-format

* Update clang-format-check.yml to version 19

* Update clang-format-check.yml

* Update unordered_map_and_set.hpp

Author: zfergus

.clang-format

@@ -8,7 +8,32 @@ BinPackParameters: false
 AllowAllParametersOfDeclarationOnNextLine: true
 AlignAfterOpenBracket: AlwaysBreak
 BreakBeforeBinaryOperators: NonAssignment
-SortIncludes: false
+SortIncludes: true
 CommentPragmas:  '^@.+'
 BreakStringLiterals: false
 PackConstructorInitializers: CurrentLine
+# Regroup includes with a priority system
+IncludeBlocks: Regroup
+IncludeCategories:
+  # by default, the main header of a cpp will get priority 0
+  # regex here are sorted by search pattern, not by sort priority
+  - Regex:           "^<ipc\/[^/]*>" # this libraries
+    Priority:        2    # internal library group
+    SortPriority:    2
+    CaseSensitive:   true
+  - Regex:           "^<ipc\/.*\/.*>" # this libraries
+    Priority:        2    # internal library group
+    SortPriority:    3
+    CaseSensitive:   true
+  - Regex:           "^<(.*\\.h[px]*)|(Eigen\/.*)>"
+    Priority:        4    # libraries (because they end in .h)
+    SortPriority:    4
+    CaseSensitive:   false
+  - Regex:           "^<.*"
+    Priority:        5    # system (without .h, because that is captured by the other group)
+    SortPriority:    5
+    CaseSensitive:   false
+  - Regex:           ".*" # catch-all for internal files
+    Priority:        1    # internal file group
+    SortPriority:    1
+    CaseSensitive:   true

python/.clang-format

@@ -0,0 +1,2 @@
+BasedOnStyle: InheritParentConfig
+SortIncludes: false

python/src/utils/eigen_ext.cpp

@@ -9,9 +9,11 @@ void define_eigen_ext(py::module_& m)
 {
     m.def(
         "project_to_pd",
+        // clang-format off
         &project_to_pd<
             double, Eigen::Dynamic, Eigen::Dynamic,
             Eigen::ColMajor | Eigen::AutoAlign, Eigen::Dynamic, Eigen::Dynamic>,
+        // clang-format on
         R"ipc_Qu8mg5v7(
         Matrix projection onto positive definite cone
 
@@ -35,9 +37,11 @@ void define_eigen_ext(py::module_& m)
 
     m.def(
         "project_to_psd",
+        // clang-format off
         &project_to_psd<
             double, Eigen::Dynamic, Eigen::Dynamic,
             Eigen::ColMajor | Eigen::AutoAlign, Eigen::Dynamic, Eigen::Dynamic>,
+        // clang-format on
         R"ipc_Qu8mg5v7(
         Matrix projection onto positive semi-definite cone
 

src/ipc/broad_phase/aabb.cpp

@@ -1,7 +1,7 @@
 #include "aabb.hpp"
 
-#include <tbb/parallel_for.h>
 #include <tbb/blocked_range.h>
+#include <tbb/parallel_for.h>
 
 #include <cfenv>
 

src/ipc/broad_phase/broad_phase.cpp

@@ -1,15 +1,14 @@
 #include "broad_phase.hpp"
 
+#include <ipc/config.hpp>
 #include <ipc/broad_phase/brute_force.hpp>
 #include <ipc/broad_phase/bvh.hpp>
-#include <ipc/broad_phase/spatial_hash.hpp>
 #include <ipc/broad_phase/hash_grid.hpp>
+#include <ipc/broad_phase/spatial_hash.hpp>
 #include <ipc/broad_phase/sweep_and_prune.hpp>
 #include <ipc/broad_phase/sweep_and_tiniest_queue.hpp>
 #include <ipc/candidates/candidates.hpp>
 
-#include <ipc/config.hpp>
-
 namespace ipc {
 
 void BroadPhase::build(

src/ipc/broad_phase/brute_force.cpp

@@ -2,9 +2,9 @@
 
 #include <ipc/utils/merge_thread_local.hpp>
 
+#include <tbb/blocked_range2d.h>
 #include <tbb/enumerable_thread_specific.h>
 #include <tbb/parallel_for.h>
-#include <tbb/blocked_range2d.h>
 
 #include <algorithm> // std::min/max
 

src/ipc/broad_phase/bvh.cpp

@@ -2,9 +2,9 @@
 
 #include <ipc/utils/merge_thread_local.hpp>
 
-#include <tbb/parallel_for.h>
 #include <tbb/blocked_range.h>
 #include <tbb/enumerable_thread_specific.h>
+#include <tbb/parallel_for.h>
 
 using namespace std::placeholders;
 

src/ipc/broad_phase/hash_grid.cpp

@@ -1,11 +1,11 @@
 #include "hash_grid.hpp"
 
 #include <ipc/broad_phase/voxel_size_heuristic.hpp>
-#include <ipc/utils/merge_thread_local.hpp>
 #include <ipc/utils/logger.hpp>
+#include <ipc/utils/merge_thread_local.hpp>
 
-#include <tbb/enumerable_thread_specific.h>
 #include <tbb/blocked_range2d.h>
+#include <tbb/enumerable_thread_specific.h>
 #include <tbb/parallel_for.h>
 #include <tbb/parallel_sort.h>
 

src/ipc/broad_phase/spatial_hash.cpp

@@ -2,12 +2,11 @@
 // Originally created by Minchen Li.
 #include "spatial_hash.hpp"
 
-#include <ipc/ccd/aabb.hpp>
+#include <ipc/config.hpp>
 #include <ipc/broad_phase/voxel_size_heuristic.hpp>
+#include <ipc/ccd/aabb.hpp>
 #include <ipc/utils/merge_thread_local.hpp>
 
-#include <ipc/config.hpp>
-
 #include <tbb/enumerable_thread_specific.h>
 #include <tbb/parallel_for.h>
 #include <tbb/parallel_sort.h>

src/ipc/broad_phase/spatial_hash.hpp

@@ -3,8 +3,8 @@
 #pragma once
 
 #include <ipc/broad_phase/broad_phase.hpp>
-#include <ipc/utils/unordered_map_and_set.hpp>
 #include <ipc/utils/eigen_ext.hpp>
+#include <ipc/utils/unordered_map_and_set.hpp>
 
 #include <vector>