Add option for building with sanitizers like ASan, UBSan, LSan

[leha-bot]

It could improve detecting bugs while debugging.
In my own local copy I just add a

add_compile_options("-fsanitize=address,undefined,leak")
add_link_options("-fsanitize=address,undefined,leak")

, but I suggest the distinct CMake option(BUILD_WITH_SANITIZERS, "Build with enabled Address, Leak and Undefine Behaviour Sanitizers" OFF) and recommend to build the all examples and tests on CI with this option.
(I could also make a PR with this feature).

[alandefreitas]

Yes. That sounds good.

We could associate that with the BUILD_WITH_PEDANTIC_WARNINGS option, which just means we want to look for bugs while compiling:

matplotplusplus/CMakeLists.txt

Line 41 in d0ef918

option(BUILD_WITH_PEDANTIC_WARNINGS "Use pedantic warnings. This is useful for developers because many of these warnings will be in continuous integration anyway." OFF)

We could use these options by default when BUILD_WITH_PEDANTIC_WARNINGS is ON by using it as the default value for BUILD_WITH_SANITIZERS

option(BUILD_WITH_SANITIZERS, "Build with enabled Address, Leak and Undefine Behaviour Sanitizers" ${BUILD_WITH_PEDANTIC_WARNINGS})

or applying these options in both cases. By supplementing this line:

matplotplusplus/source/matplot/CMakeLists.txt

Line 136 in d0ef918

if (BUILD_WITH_PEDANTIC_WARNINGS)

like this:

if (BUILD_WITH_PEDANTIC_WARNINGS)
   # ...
endif ()
if (BUILD_WITH_PEDANTIC_WARNINGS OR BUILD_WITH_SANITIZERS)
   # ...
endif ()

Maybe the second option is better because it's more explicit. Cmake might cache the options and the default values might not apply. Or using both options.

I'm just not sure MSVC has equivalent options and whether the names are the same for GCC and Clang.

[leha-bot]

MSVC historically has the /sdl flag for their static analyzer. But they recently also added the ASan support into MSVC 2019; I think we could dig in this direction and make some CMake logic like:

if (MSVC)
   target_compile_options(matplot "/sdl")
   target_link_libraries(matplot clang_rt.asan-i386.lib) # ??? maybe MSVC::asan imported target which could choose which one asan library is required depending on processor architecture, CRT runtime, etc
else()
   # non-msvc code flags
   target_compile_options(matplot "-fsanitize=address")
   target_link_options(matplot "-fsanitize=address")
endif()

[alandefreitas]

That's great