Merge pull request #217 from Project579/compile_commands

Author: aminya

README.md

@@ -134,6 +134,7 @@ project_options(
       ${ENABLE_SANITIZER_UNDEFINED_BEHAVIOR}
       # ENABLE_SANITIZER_THREAD
       # ENABLE_SANITIZER_MEMORY
+      # ENABLE_COMPILE_COMMANDS_SYMLINK
       # ENABLE_PCH
       # PCH_HEADERS
       # WARNINGS_AS_ERRORS

docs/src/project_options_api.md

@@ -17,6 +17,7 @@
 - `ENABLE_SANITIZER_UNDEFINED_BEHAVIOR`: Enable undefined behavior sanitizer
 - `ENABLE_SANITIZER_THREAD`: Enable thread sanitizer
 - `ENABLE_SANITIZER_MEMORY`: Enable memory sanitizer
+- `ENABLE_COMPILE_COMMANDS_SYMLINK`: Enable compile_commands.json symlink creation
 - `ENABLE_PCH`: Enable Precompiled Headers
 - `ENABLE_INCLUDE_WHAT_YOU_USE`: Enable static analysis with include-what-you-use
 - `ENABLE_GCC_ANALYZER`: Enable static analysis with GCC (10+) analyzer

docs/src/project_options_example.md

@@ -92,6 +92,7 @@ project_options(
       ${ENABLE_SANITIZER_UNDEFINED_BEHAVIOR}
       # ENABLE_SANITIZER_THREAD
       # ENABLE_SANITIZER_MEMORY
+      # ENABLE_COMPILE_COMMANDS_SYMLINK
       # ENABLE_PCH
       # PCH_HEADERS
       # WARNINGS_AS_ERRORS

src/Common.cmake

@@ -12,7 +12,7 @@ macro(set_project_options_src_dir)
 endmacro()
 
 # Common project settings run by default for all the projects that call `project_options()`
-macro(common_project_options)
+macro(common_project_options ENABLE_COMPILE_COMMANDS_SYMLINK)
   set_project_options_src_dir()
   message(DEBUG "${ProjectOptions_SRC_DIR}")
 
@@ -74,51 +74,57 @@ macro(common_project_options)
     # Enable generate compile_commands.json
     set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
 
-    # 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)
-    else()
-      set(IS_NONADMINISTRATOR "")
-    endif()
+    if(${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)
+      else()
+        set(IS_NONADMINISTRATOR "")
+      endif()
 
-    if(IS_NONADMINISTRATOR)
-      # For non-administrator, create an auxiliary target and ask user to run it
-      add_custom_command(
-        OUTPUT ${CMAKE_SOURCE_DIR}/compile_commands.json
-        COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_BINARY_DIR}/compile_commands.json
-                ${CMAKE_SOURCE_DIR}/compile_commands.json
-        DEPENDS ${CMAKE_BINARY_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)
-      message(TRACE "compile_commands.json was symlinked to the root.")
-    endif()
+      if(IS_NONADMINISTRATOR)
+        # For non-administrator, create an auxiliary target and ask user to run it
+        add_custom_command(
+          OUTPUT ${CMAKE_SOURCE_DIR}/compile_commands.json
+          COMMAND ${CMAKE_COMMAND} -E copy ${CMAKE_BINARY_DIR}/compile_commands.json
+                  ${CMAKE_SOURCE_DIR}/compile_commands.json
+          DEPENDS ${CMAKE_BINARY_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)
+        if(_compile_commands_symlink_result EQUAL 0)
+          message(TRACE "compile_commands.json was symlinked to the root.")
+        else()
+          message(WARNING "failed to create compile_commands.json symlink to the root.")
+        endif()
+      endif()
 
-    # Add compile_commans.json to .gitignore if .gitignore exists
-    set(GITIGNORE_FILE "${CMAKE_SOURCE_DIR}/.gitignore")
+      # Add compile_commans.json to .gitignore if .gitignore exists
+      set(GITIGNORE_FILE "${CMAKE_SOURCE_DIR}/.gitignore")
 
-    if(EXISTS ${GITIGNORE_FILE})
-      file(STRINGS ${GITIGNORE_FILE} HAS_IGNORED REGEX "^compile_commands.json")
+      if(EXISTS ${GITIGNORE_FILE})
+        file(STRINGS ${GITIGNORE_FILE} HAS_IGNORED REGEX "^compile_commands.json")
 
-      if(NOT HAS_IGNORED)
-        message(TRACE "Adding compile_commands.json to .gitignore")
-        file(APPEND ${GITIGNORE_FILE} "\ncompile_commands.json")
+        if(NOT HAS_IGNORED)
+          message(TRACE "Adding compile_commands.json to .gitignore")
+          file(APPEND ${GITIGNORE_FILE} "\ncompile_commands.json")
+        endif()
       endif()
     endif()
   endif()

src/DynamicProjectOptions.cmake

@@ -75,6 +75,7 @@ macro(dynamic_project_options)
       "0\;ENABLE_SANITIZER_UNDEFINED_BEHAVIOR\;OFF\;${SUPPORTS_UBSAN}\;Make certain types (numeric mostly) of undefined behavior into runtime errors"
       "0\;ENABLE_SANITIZER_THREAD\;OFF\;OFF\;Make thread race conditions into hard runtime errors"
       "0\;ENABLE_SANITIZER_MEMORY\;OFF\;OFF\;Make other memory errors into runtime errors"
+      "0\;ENABLE_COMPILE_COMMANDS_SYMLINK\;OFF\;OFF\;Don't create a symlink for compile_commands.json"
       "1\;LINKER\;\;\;Choose a specific linker"
       "1\;VS_ANALYSIS_RULESET\;\;\;Override the defaults for the code analysis rule set in Visual Studio"
       "1\;CONAN_PROFILE\;\;\;Use specific Conan profile"
@@ -204,6 +205,7 @@ macro(dynamic_project_options)
     ${ENABLE_SANITIZER_UNDEFINED_BEHAVIOR_VALUE}
     ${ENABLE_SANITIZER_THREAD_VALUE}
     ${ENABLE_SANITIZER_MEMORY_VALUE}
+    ${ENABLE_COMPILE_COMMANDS_SYMLINK_VALUE}
     ${LINKER_VALUE}
     ${VS_ANALYSIS_RULESET_VALUE}
     ${CONAN_PROFILE_VALUE}

src/Index.cmake

@@ -66,7 +66,8 @@ macro(project_options)
       ENABLE_SANITIZER_LEAK
       ENABLE_SANITIZER_UNDEFINED_BEHAVIOR
       ENABLE_SANITIZER_THREAD
-      ENABLE_SANITIZER_MEMORY)
+      ENABLE_SANITIZER_MEMORY
+      ENABLE_COMPILE_COMMANDS_SYMLINK)
   set(oneValueArgs
       PREFIX
       LINKER
@@ -100,7 +101,7 @@ macro(project_options)
     set(WARNING_MESSAGE WARNING)
   endif()
 
-  common_project_options()
+  common_project_options(${ProjectOptions_ENABLE_COMPILE_COMMANDS_SYMLINK})
 
   # Add an interface library for the options
   set(_options_target project_options)