cmake: Add option to build with address sanitizer

Author: zjeffer

CMakeLists.txt

@@ -17,6 +17,7 @@ option(GIT_REVISION
 option(UPDATE_CHECKER
        "Enable or disable both the update checker and auto-updater" ON)
 option(PRO_VERSION "Enable or disable Notes Pro features" ON)
+option(ENABLE_ASAN "Enable address sanitizer" OFF)
 
 project(
   Notes
@@ -32,6 +33,13 @@ set(CMAKE_AUTOMOC ON)
 set(CMAKE_AUTOUIC ON)
 set(CMAKE_AUTORCC ON)
 
+# address sanitizer can be enabled by running cmake with -DENABLE_ASAN=ON
+if(ENABLE_ASAN AND (CMAKE_CXX_COMPILER_ID STREQUAL "GNU"
+                    OR CMAKE_CXX_COMPILER_ID MATCHES "Clang"))
+  set(ADDRESS_SANITIZER_FLAGS "-fsanitize=address -fno-omit-frame-pointer")
+  set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${ADDRESS_SANITIZER_FLAGS}")
+endif()
+
 if(POLICY CMP0083)
   cmake_policy(SET CMP0083 NEW)
   include(CheckPIESupported)
@@ -74,6 +82,10 @@ else()
   message(STATUS "Build type: ${CMAKE_BUILD_TYPE}")
 endif()
 
+if(ENABLE_ASAN)
+  message(STATUS "Enabling AddressSanitizer")
+endif()
+
 set(GIT_REV "")
 if(GIT_REVISION)
   if(EXISTS "${CMAKE_SOURCE_DIR}/.git")

docs/build_options.md

@@ -10,6 +10,7 @@ You should set those while invoking CMake to build the project. See the [example
 | `GIT_REVISION`                             | `OFF`         | `ON` / `OFF`        | Append the current git revision to the app's version string |
 | `UPDATE_CHECKER`                           | `ON`          | `ON` / `OFF`        | Enable or disable both the update checker and auto-updater  |
 | `PRO_VERSION`                              | `ON`          | `ON` / `OFF`        | Enable or disable Notes Pro features                        |
+| `ENABLE_ASAN`                              | `OFF`         | `ON` / `OFF`        | Enable AddressSanitizer (ASan) for debugging                |
 
 ### Examples