Merge remote-tracking branch 'upstream/develop' into bipashabg-2025

Author: cvvergara

.clang-tidy

@@ -0,0 +1,15 @@
+Checks: >
+    google-*,
+    -google-readability-braces-around-statements,
+    -google-readability-casting,
+    clang-analyzer-*,
+    clang-diagnostic-*,
+    cppcoreguidelines-avoid-capturing-lambda-coroutines,
+    cppcoreguidelines-avoid-goto,
+    cppcoreguidelines-avoid-non-const-global-variables,
+    cppcoreguidelines-avoid-reference-coroutine-parameters
+
+WarningsAsErrors: ''
+HeaderFilterRegex: './include'
+FormatStyle:     none
+InheritParentConfig: true

.github/scripts/tidy-vs-commit.sh

@@ -89,7 +89,9 @@ jobs:
           export PATH=/usr/lib/postgresql/${PGVER}/bin:$PATH
           mkdir build
           cd build
-          CXX=clang++ CC=clang cmake -DPOSTGRESQL_VERSION=${PGVER} -DCMAKE_BUILD_TYPE=Debug -DWITH_DOC=OFF ..
+          CXX=clang++ CC=clang cmake -DPOSTGRESQL_VERSION=${PGVER} \
+             -DCMAKE_BUILD_TYPE=Debug -DBUILD_HTML=OFF -DBUILD_DOXY=OFF \
+             -DUSE_CLANG_TIDY=ON ..
 
       - name: Build
         run: |

.github/workflows/clang.yml

@@ -98,49 +98,56 @@ if(WIN32 AND MSVC)
     set(CMAKE_CXX_FLAGS "")
 endif()
 
-#-----------------------------------------------------------------------------
-#-----------------------------------------------------------------------------
-# C/C++ Compiler requirements
-#-----------------------------------------------------------------------------
-#-----------------------------------------------------------------------------
+#---------------------------------------------
+# Boost
+#---------------------------------------------
 
 find_package(Boost ${BOOST_MINIMUM_VERSION} REQUIRED)
 if (NOT Boost_VERSION_MACRO)
     set(Boost_VERSION_MACRO ${Boost_VERSION})
 endif()
 set(BOOST_VERSION "${Boost_MAJOR_VERSION}.${Boost_MINOR_VERSION}.${Boost_SUBMINOR_VERSION}")
+add_definitions(-DBOOST_ALLOW_DEPRECATED_HEADERS)
 
-include(CheckCCompilerFlag)
-include(CheckCXXCompilerFlag)
-if (BOOST_VERSION VERSION_LESS "1.75.0")
-    CHECK_CXX_COMPILER_FLAG("-std=c++11" COMPILER_SUPPORTS_CXX11)
-    if(COMPILER_SUPPORTS_CXX11)
-        set(CMAKE_CXX_STANDARD 11)
-        set(CMAKE_CXX_STANDARD_REQUIRED ON)
-        set(CMAKE_CXX_EXTENSIONS OFF)
+include_directories(SYSTEM ${Boost_INCLUDE_DIRS})
+
+#---------------------------------------------
+# Clang tidy
+#---------------------------------------------
+
+option(USE_CLANG_TIDY "Use clang-tidy." OFF)
+
+if(USE_CLANG_TIDY)
+    find_program(CLANG_TIDY_COMMAND NAMES clang-tidy NO_CACHE)
+    if (CLANG_TIDY_COMMAND)
+        set(CMAKE_CXX_CLANG_TIDY "${CLANG_TIDY_COMMAND};--config-file=${CMAKE_SOURCE_DIR}/.clang-tidy")
     else()
-        CHECK_CXX_COMPILER_FLAG("-std=c++0x" COMPILER_SUPPORTS_CXX0X)
-        if(COMPILER_SUPPORTS_CXX0X)
-            add_compile_options("-std=c++0x")
-            message(STATUS "Using  -std=c++0x.")
-        else()
-        message(WARNING "The compiler ${CMAKE_CXX_COMPILER} has no C++0x or C++11 flags support.
-            Using: callback compiler's standard")
-        endif()
+        message(WARNING "Set to use clang_tidy, but not found.")
     endif()
-else()
-    set(CMAKE_CXX_STANDARD 14)
 endif()
 
-add_definitions(-DBOOST_ALLOW_DEPRECATED_HEADERS)
+#-----------------------------------------------------------------------------
+# C/C++ Compiler requirements
+#-----------------------------------------------------------------------------
+
+include(CheckCCompilerFlag)
+include(CheckCXXCompilerFlag)
+
+set(CMAKE_CXX_STANDARD 17 CACHE STRING "C++ standard version to use (minimum requirement is c++17)")
+
 set(COMPILER_VERSION "${CMAKE_CXX_COMPILER_ID}-${CMAKE_CXX_COMPILER_VERSION}")
 
+#-----------------------------------------------------------------------------
+# C++ language version and compilation flags
+#-----------------------------------------------------------------------------
+message(STATUS "pgRouting: Require C++${CMAKE_CXX_STANDARD}")
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
+set(CMAKE_CXX_EXTENSIONS OFF)
 
 #---------------------------------------------
 # Windows compiler flags
 #---------------------------------------------
 
-
 if(WIN32 AND NOT MSVC)
     set(OS_BUILD  $ENV{OS_BUILD})
     if(NOT OS_BUILD)
@@ -169,23 +176,11 @@ if(WIN32 AND MSVC)
         -EHsc)
 endif()
 
-#-----------------------------------------------------------------------------
-#-----------------------------------------------------------------------------
 #-----------------------------------------------------------------------------
 # Finding prerequisites
 #-----------------------------------------------------------------------------
-#-----------------------------------------------------------------------------
-#-----------------------------------------------------------------------------
 
-#---------------------------------------------
-#---------------------------------------------
-# Perl
-#---------------------------------------------
-#---------------------------------------------
-include(FindPerl)
-if(NOT PERL_EXECUTABLE)
-    message(FATAL_ERROR "perl NOT FOUND - Please check your Perl installation.")
-endif()
+find_package(Perl REQUIRED)
 
 #---------------------------------------------
 #---------------------------------------------
@@ -224,16 +219,6 @@ endif()
 add_definitions(-DPGSQL_VERSION=${PGSQL_VERSION})
 message(STATUS "PGSQL_VERSION=${PGSQL_VERSION}")
 
-
-#---------------------------------------------
-#---------------------------------------------
-# Boost
-#---------------------------------------------
-#---------------------------------------------
-
-include_directories(SYSTEM ${Boost_INCLUDE_DIRS})
-
-
 #---------------------------------------------
 if (PROJECT_DEBUG)
     message(STATUS "PERL_VERSION_STRING = ${PERL_VERSION_STRING}")

.github/workflows/tidy-check.yml

@@ -13,6 +13,43 @@ To see all issues & pull requests closed by this release see the
 [#4.0.0](https://github.com/pgRouting/pgrouting/issues?utf8=%E2%9C%93&q=milestone%3A%22Release%204.0.0%22)
 
 
+Build
+
+* C++ standard is std17
+
+  * Using this standard all versions of  will work
+  * The code is not yet modified to use std17:
+
+    * If needed: ``-DCMAKE_CXX_STANDARD=14`` to lower the standard.
+
+* The user's documentation is build by default
+* The doxygen documentation is build by default
+
+For developers:
+
+* Set `-DUSE_CLANG_TIDY=ON` for clang tidy checks.
+* Tidy checks are done on CI.
+
+Documentation build
+
+* The doxygen documentation is build by default
+* The HTML documentation is build by default
+* The translated languages (en, es, zh_Hans) HTML documentation is build by default
+* `WITH-DOC` is not used anymore
+
+User's Documentation is not build when
+
+* Sphinx is not found
+* When all Sphinx formats are OFF
+* When all languages are OFF
+* Documentation output changed location to [build/doc/_build/](format) directory
+
+  * For example: for HTML output is on `build/doc/_build/html` directory
+
+Developers's Documentation is not build when
+
+* Doxygen is not found
+
 Summary of changes by function
 
 * pgr_aStar
@@ -454,25 +491,6 @@ Summary of functions and signatures no longer on pgrouting
 * [#2919](https://github.com/pgRouting/pgrouting/issues/2919) pgr_withpoints(text,text,text,boolean,character,boolean)
 * [#2919](https://github.com/pgRouting/pgrouting/issues/2919) pgr_withpointsvia(text,text,anyarray,boolean,boolean,boolean,character,boolean)
 
-Documentation build
-
-WITH-DOC is not used anymore
-
-* The doxygen documentation is build by default
-* The HTML documentation is build by default
-* The translated languages (en, es, zh_Hans) HTML documentation is build by default
-
-User's Documentation is not build when
-
-* Sphinx is not found
-* When all Sphinx formats are OFF
-* When all languages are OFF
-* Output is on build/doc/_build/<format> directory
-
-Developers's Documentation is not build when
-
-* Doxygen is not found
-
 Code enhancements
 
 * Removal of unused C/C++ code

CMakeLists.txt

@@ -46,6 +46,45 @@ To see all issues & pull requests closed by this release see the
    :local:
    :depth: 1
 
+Build
+...............................................................................
+
+* C++ standard is std17
+
+  * Using this standard all versions of boost will work
+  * The code is not yet modified to use std17:
+
+    * If needed: ``-DCMAKE_CXX_STANDARD=14`` to lower the standard.
+
+* The user's documentation is build by default
+* The doxygen documentation is build by default
+
+For developers:
+
+* Set `-DUSE_CLANG_TIDY=ON` for clang tidy checks.
+* Tidy checks are done on CI.
+
+Documentation build
+...............................................................................
+
+* The doxygen documentation is build by default
+* The HTML documentation is build by default
+* The translated languages (en, es, zh_Hans) HTML documentation is build by default
+* `WITH-DOC` is not used anymore
+
+User's Documentation is not build when
+
+* Sphinx is not found
+* When all Sphinx formats are OFF
+* When all languages are OFF
+* Documentation output changed location to `build/doc/_build/<format>` directory
+
+  * For example: for HTML output is on `build/doc/_build/html` directory
+
+Developers's Documentation is not build when
+
+* Doxygen is not found
+
 Summary of changes by function
 ...............................................................................
 
@@ -524,26 +563,6 @@ Summary of functions and signatures no longer on pgrouting
 * :issue:`2919` pgr_withpoints(text,text,text,boolean,character,boolean)
 * :issue:`2919` pgr_withpointsvia(text,text,anyarray,boolean,boolean,boolean,character,boolean)
 
-Documentation build
-...............................................................................
-
-WITH-DOC is not used anymore
-
-* The doxygen documentation is build by default
-* The HTML documentation is build by default
-* The translated languages (en, es, zh_Hans) HTML documentation is build by default
-
-User's Documentation is not build when
-
-* Sphinx is not found
-* When all Sphinx formats are OFF
-* When all languages are OFF
-* Output is on build/doc/_build/<format> directory
-
-Developers's Documentation is not build when
-
-* Doxygen is not found
-
 Code enhancements
 ...............................................................................