fix: fix linting, formatting, and typo issues

Author: aminya

.cmake-format.yaml

@@ -1,5 +1,5 @@
 format:
-  line_width: 100
+  line_width: 110
   tab_size: 2
   max_pargs_hwrap: 5
   max_subgroups_hwrap: 3

cspell.config.yaml

@@ -23,7 +23,6 @@ words:
   - ccache
   - ccmake
   - choco
-  - servor
   - cmake
   - CMAKE
   - cmakelint
@@ -63,6 +62,7 @@ words:
   - fstack
   - ftime
   - gcovr
+  - genex
   - gnueabi
   - gnueabihf
   - Graphviz
@@ -116,6 +116,7 @@ words:
   - rpath
   - rtti
   - sccache
+  - servor
   - setx
   - shlib
   - suppr
@@ -128,6 +129,7 @@ words:
   - undoc
   - vcpkg
   - vcvarsall
+  - venv
   - visualc
   - visualcpp
   - VSCMD

docs/CMakeLists.txt

@@ -65,8 +65,8 @@ configure_file(conf.py.in conf.py @ONLY)
 set(doc_formats "")
 if(SPHINX_HTML)
   list(APPEND doc_formats html)
-  set(html_extra_commands COMMAND ${CMAKE_COMMAND} -E copy_directory
-                          ${CMAKE_CURRENT_LIST_DIR}/root/ ${CMAKE_CURRENT_BINARY_DIR}
+  set(html_extra_commands COMMAND ${CMAKE_COMMAND} -E copy_directory ${CMAKE_CURRENT_LIST_DIR}/root/
+                          ${CMAKE_CURRENT_BINARY_DIR}
   )
   file(WRITE ${CMAKE_CURRENT_BINARY_DIR}/js/versions.js
        "var ar_versions = [{\"version\": \"build\", \"folder\": \"html\", \"has_pdf\": false}]"
@@ -104,8 +104,8 @@ foreach(format ${doc_formats})
   add_custom_command(
     OUTPUT ${doc_format_output}
     COMMAND
-      ${SPHINX_EXECUTABLE} -c ${CMAKE_CURRENT_BINARY_DIR} -d ${CMAKE_CURRENT_BINARY_DIR}/doctrees -b
-      ${format} ${sphinx_flags} ${CMAKE_CURRENT_LIST_DIR} ${CMAKE_CURRENT_BINARY_DIR}/${format} >
+      ${SPHINX_EXECUTABLE} -c ${CMAKE_CURRENT_BINARY_DIR} -d ${CMAKE_CURRENT_BINARY_DIR}/doctrees -b ${format}
+      ${sphinx_flags} ${CMAKE_CURRENT_LIST_DIR} ${CMAKE_CURRENT_BINARY_DIR}/${format} >
       ${CMAKE_CURRENT_BINARY_DIR}/${doc_format_log} # log stdout, pass stderr
       ${${format}_extra_commands}
     DEPENDS ${doc_format_last}
@@ -120,15 +120,11 @@ endforeach()
 add_custom_target(documentation ALL DEPENDS ${doc_format_outputs})
 
 if(SPHINX_INFO)
-  install(FILES ${CMAKE_CURRENT_BINARY_DIR}/texinfo/cmake.info DESTINATION ${CMAKE_INFO_DIR}
-          ${COMPONENT}
-  )
+  install(FILES ${CMAKE_CURRENT_BINARY_DIR}/texinfo/cmake.info DESTINATION ${CMAKE_INFO_DIR} ${COMPONENT})
 endif()
 
 if(SPHINX_MAN)
-  file(GLOB man_rst RELATIVE ${CMAKE_SOURCE_DIR}/Help/manual
-       ${CMAKE_SOURCE_DIR}/Help/manual/*.[1-9].rst
-  )
+  file(GLOB man_rst RELATIVE ${CMAKE_SOURCE_DIR}/Help/manual ${CMAKE_SOURCE_DIR}/Help/manual/*.[1-9].rst)
   foreach(m ${man_rst})
     if("x${m}" MATCHES "^x(.+)\\.([1-9])\\.rst$")
       set(name "${CMAKE_MATCH_1}")
@@ -142,8 +138,8 @@ if(SPHINX_MAN)
         endif()
       endif()
       if(NOT skip)
-        install(FILES ${CMAKE_CURRENT_BINARY_DIR}/man/${name}.${sec}
-                DESTINATION ${CMAKE_MAN_DIR}/man${sec} ${COMPONENT}
+        install(FILES ${CMAKE_CURRENT_BINARY_DIR}/man/${name}.${sec} DESTINATION ${CMAKE_MAN_DIR}/man${sec}
+                ${COMPONENT}
         )
       endif()
       unset(skip)

docs/cmake/FindSphinx.cmake

@@ -51,8 +51,8 @@ function(
 )
 
   add_custom_target(
-    ${target_name} ALL COMMAND ${SPHINX_EXECUTABLE} -b ${builder} -c ${conf} ${source}
-                               ${destination} COMMENT "Generating sphinx documentation: ${builder}"
+    ${target_name} ALL COMMAND ${SPHINX_EXECUTABLE} -b ${builder} -c ${conf} ${source} ${destination}
+    COMMENT "Generating sphinx documentation: ${builder}"
   )
 
   set_property(DIRECTORY APPEND PROPERTY ADDITIONAL_MAKE_CLEAN_FILES ${destination})

src/Clang.cmake

@@ -4,10 +4,9 @@ set(ProjectOptions_SRC_DIR "${CMAKE_CURRENT_LIST_DIR}")
 
 # detect clang
 function(is_clang value)
-  if(clang
-     OR ("${CMAKE_CXX_COMPILER_ID}" STREQUAL "Clang" AND "${CMAKE_C_COMPILER_ID}" STREQUAL "Clang")
-     OR ("${DETECTED_CMAKE_CXX_COMPILER_ID}" STREQUAL "Clang" AND "${DETECTED_CMAKE_C_COMPILER_ID}"
-                                                                  STREQUAL "Clang")
+  if(clang OR ("${CMAKE_CXX_COMPILER_ID}" STREQUAL "Clang" AND "${CMAKE_C_COMPILER_ID}" STREQUAL "Clang")
+     OR ("${DETECTED_CMAKE_CXX_COMPILER_ID}" STREQUAL "Clang" AND "${DETECTED_CMAKE_C_COMPILER_ID}" STREQUAL
+                                                                  "Clang")
   )
     set(${value} ON PARENT_SCOPE)
     return()
@@ -24,9 +23,7 @@ function(is_clang value)
     include("${ProjectOptions_SRC_DIR}/DetectCompiler.cmake")
     detect_compiler()
 
-    if((DETECTED_CMAKE_CXX_COMPILER_ID STREQUAL "Clang" AND DETECTED_CMAKE_C_COMPILER_ID STREQUAL
-                                                            "Clang")
-    )
+    if((DETECTED_CMAKE_CXX_COMPILER_ID STREQUAL "Clang" AND DETECTED_CMAKE_C_COMPILER_ID STREQUAL "Clang"))
       set(${value} ON PARENT_SCOPE)
       return()
     endif()

src/Common.cmake

@@ -22,9 +22,7 @@ macro(common_project_options ENABLE_COMPILE_COMMANDS_SYMLINK)
     message(STATUS "Setting build type to 'RelWithDebInfo' as none was specified.")
     set(CMAKE_BUILD_TYPE RelWithDebInfo CACHE STRING "Choose the type of build." FORCE)
     # Set the possible values of build type for cmake-gui, ccmake
-    set_property(
-      CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS "Debug" "Release" "MinSizeRel" "RelWithDebInfo"
-    )
+    set_property(CACHE CMAKE_BUILD_TYPE PROPERTY STRINGS "Debug" "Release" "MinSizeRel" "RelWithDebInfo")
   endif()
 
   get_property(BUILDING_MULTI_CONFIG GLOBAL PROPERTY GENERATOR_IS_MULTI_CONFIG)
@@ -35,8 +33,8 @@ macro(common_project_options ENABLE_COMPILE_COMMANDS_SYMLINK)
       # list to only the configuration types you use, but only if one
       # is not forced-set on the command line for VS
       message(TRACE "Setting up multi-config build types")
-      set(CMAKE_CONFIGURATION_TYPES Debug Release RelWithDebInfo MinSizeRel
-          CACHE STRING "Enabled build types" FORCE
+      set(CMAKE_CONFIGURATION_TYPES Debug Release RelWithDebInfo MinSizeRel CACHE STRING
+                                                                                  "Enabled build types" FORCE
       )
     else()
       message(TRACE "User chose a specific build type, so we are using that")
@@ -61,9 +59,7 @@ macro(common_project_options ENABLE_COMPILE_COMMANDS_SYMLINK)
       # Make a symbol link of compile_commands.json on the source dir to help clang based tools find it
       if(WIN32)
         # Detect whether cmake is run as administrator (only administrator can read the LOCAL SERVICE account reg key)
-        execute_process(
-          COMMAND reg query "HKU\\S-1-5-19" ERROR_VARIABLE IS_NONADMINISTRATOR OUTPUT_QUIET
-        )
+        execute_process(COMMAND reg query "HKU\\S-1-5-19" ERROR_VARIABLE IS_NONADMINISTRATOR OUTPUT_QUIET)
       else()
         set(IS_NONADMINISTRATOR "")
       endif()
@@ -77,17 +73,14 @@ macro(common_project_options ENABLE_COMPILE_COMMANDS_SYMLINK)
           DEPENDS ${CMAKE_BINARY_DIR}/compile_commands.json
           VERBATIM
         )
-        add_custom_target(
-          _copy_compile_commands DEPENDS ${CMAKE_SOURCE_DIR}/compile_commands.json VERBATIM
-        )
+        add_custom_target(_copy_compile_commands DEPENDS ${CMAKE_SOURCE_DIR}/compile_commands.json VERBATIM)
         message(
           STATUS
             "compile_commands.json was not symlinked to the root. Run `cmake --build <build_dir> -t _copy_compile_commands` if needed."
         )
       else()
-        file(CREATE_LINK ${CMAKE_BINARY_DIR}/compile_commands.json
-             ${CMAKE_SOURCE_DIR}/compile_commands.json SYMBOLIC
-             RESULT _compile_commands_symlink_result
+        file(CREATE_LINK ${CMAKE_BINARY_DIR}/compile_commands.json ${CMAKE_SOURCE_DIR}/compile_commands.json
+             SYMBOLIC RESULT _compile_commands_symlink_result
         )
         if(_compile_commands_symlink_result EQUAL 0)
           message(TRACE "compile_commands.json was symlinked to the root.")

src/Conan.cmake

@@ -19,25 +19,21 @@ endfunction()
 
 # Run Conan 1 for dependency management
 macro(_run_conan1)
-  set(options
-    DEPRECATED_CALL # For backward compability
+  set(options DEPRECATED_CALL # For backward compability
   )
-  set(one_value_args
-    DEPRECATED_PROFILE # For backward compability
+  set(one_value_args DEPRECATED_PROFILE # For backward compability
   )
-  set(multi_value_args
-    HOST_PROFILE
-    BUILD_PROFILE
-    INSTALL_ARGS
-    DEPRECATED_OPTIONS # For backward compability
+  set(multi_value_args HOST_PROFILE BUILD_PROFILE INSTALL_ARGS DEPRECATED_OPTIONS # For backward compability
   )
   cmake_parse_arguments(_args "${options}" "${one_value_args}" "${multi_value_args}" ${ARGN})
 
   conan_get_version(_conan_current_version)
   if(_conan_current_version VERSION_GREATER_EQUAL "2.0.0")
-    message(FATAL_ERROR
-      "ENABLE_CONAN in `project_options(...)` only supports conan 1.\n"
-      "  If you're using conan 2, disable ENABLE_CONAN and use `run_conan(...)` before `project(...)`.")
+    message(
+      FATAL_ERROR
+        "ENABLE_CONAN in `project_options(...)` only supports conan 1.\n"
+        "  If you're using conan 2, disable ENABLE_CONAN and use `run_conan(...)` before `project(...)`."
+    )
   endif()
 
   # Download automatically, you can also just copy the conan.cmake file
@@ -67,9 +63,7 @@ macro(_run_conan1)
     INDEX
     0
   )
-  conan_add_remote(
-    NAME bincrafters URL https://bincrafters.jfrog.io/artifactory/api/conan/public-conan
-  )
+  conan_add_remote(NAME bincrafters URL https://bincrafters.jfrog.io/artifactory/api/conan/public-conan)
 
   if(CONAN_EXPORTED)
     # standard conan installation, in which deps will be defined in conanfile. It is not necessary to call conan again, as it is already running.
@@ -100,8 +94,9 @@ macro(_run_conan1)
     endif()
 
     set(_should_detect FALSE)
-    if(((NOT _args_DEPRECATED_CALL) AND ((NOT _args_HOST_PROFILE) OR ("auto-cmake" IN_LIST _args_HOST_PROFILE)))
-        OR ((_args_DEPRECATED_CALL) AND (NOT _args_DEPRECATED_PROFILE)))
+    if(((NOT _args_DEPRECATED_CALL) AND ((NOT _args_HOST_PROFILE) OR ("auto-cmake" IN_LIST _args_HOST_PROFILE)
+                                        )) OR ((_args_DEPRECATED_CALL) AND (NOT _args_DEPRECATED_PROFILE))
+    )
       set(_should_detect TRUE)
       list(REMOVE_ITEM _args_HOST_PROFILE "auto-cmake")
     endif()
@@ -184,34 +179,31 @@ endmacro()
 macro(_run_conan2)
   set(options)
   set(one_value_args)
-  set(multi_value_args
-    HOST_PROFILE
-    BUILD_PROFILE
-    INSTALL_ARGS
-  )
+  set(multi_value_args HOST_PROFILE BUILD_PROFILE INSTALL_ARGS)
   cmake_parse_arguments(_args "${options}" "${one_value_args}" "${multi_value_args}" ${ARGN})
 
   if(CMAKE_VERSION VERSION_LESS "3.24.0")
-    message(FATAL_ERROR
-      "`run_conan(...)` with conan 2 only supports cmake 3.24+, please update your cmake.\n"
-      "  Or you can downgrade your conan to use conan 1.")
+    message(FATAL_ERROR "`run_conan(...)` with conan 2 only supports cmake 3.24+, please update your cmake.\n"
+                        "  Or you can downgrade your conan to use conan 1."
+    )
   endif()
 
   conan_get_version(_conan_current_version)
   if(_conan_current_version VERSION_LESS "2.0.5")
-    message(FATAL_ERROR
-      "`run_conan(...)` with conan 2 only supports conan 2.0.5+, please update your conan.\n"
-      "  Or You can downgrade your conan to use conan 1.")
+    message(
+      FATAL_ERROR "`run_conan(...)` with conan 2 only supports conan 2.0.5+, please update your conan.\n"
+                  "  Or You can downgrade your conan to use conan 1."
+    )
   endif()
 
   # Download automatically, you can also just copy the conan.cmake file
   if(NOT EXISTS "${CMAKE_BINARY_DIR}/conan_provider.cmake")
     message(STATUS "Downloading conan_provider.cmake from https://github.com/conan-io/cmake-conan")
     file(
-      DOWNLOAD "https://raw.githubusercontent.com/conan-io/cmake-conan/f6464d1e13ef7a47c569f5061f9607ea63339d39/conan_provider.cmake"
+      DOWNLOAD
+      "https://raw.githubusercontent.com/conan-io/cmake-conan/f6464d1e13ef7a47c569f5061f9607ea63339d39/conan_provider.cmake"
       "${CMAKE_BINARY_DIR}/conan_provider.cmake"
       EXPECTED_HASH SHA256=0a5eb4afbdd94faf06dcbf82d3244331605ef2176de32c09ea9376e768cbb0fc
-
       # TLS_VERIFY ON # fails on some systems
     )
   endif()
@@ -230,14 +222,24 @@ macro(_run_conan2)
 
   set(CONAN_HOST_PROFILE "${_args_HOST_PROFILE}" CACHE STRING "Conan host profile" FORCE)
   set(CONAN_BUILD_PROFILE "${_args_BUILD_PROFILE}" CACHE STRING "Conan build profile" FORCE)
-  set(CONAN_INSTALL_ARGS "${_args_INSTALL_ARGS}" CACHE STRING "Command line arguments for conan install" FORCE)
+  set(CONAN_INSTALL_ARGS "${_args_INSTALL_ARGS}" CACHE STRING "Command line arguments for conan install"
+                                                       FORCE
+  )
 
   # A workaround from https://github.com/conan-io/cmake-conan/issues/595
   list(APPEND CMAKE_PROJECT_TOP_LEVEL_INCLUDES "${CMAKE_BINARY_DIR}/conan_provider.cmake")
 
   # Add this to invoke conan even when there's no find_package in CMakeLists.txt.
   # This helps users get the third-party package names, which is used in later find_package.
-  cmake_language(DEFER DIRECTORY "${CMAKE_CURRENT_SOURCE_DIR}" CALL find_package Git QUIET)
+  cmake_language(
+    DEFER
+    DIRECTORY
+    "${CMAKE_CURRENT_SOURCE_DIR}"
+    CALL
+    find_package
+    Git
+    QUIET
+  )
 endmacro()
 
 #[[.rst:
@@ -298,4 +300,4 @@ macro(run_conan)
   else()
     _run_conan2(${ARGN})
   endif()
-endmacro()
+endmacro()