feat: introduces optimized debug option

[lolito93]

With the SEN_USER_SIZE_OPTIMIZED_DEBUG users can now control whether they want a smaller and better optimized debug build that is fast and has reliable debug information.

Resolves SEN-1680

[EnriqueParodi]

The comment says "Override options" but the code appends. gcc and clang take the last optimisation flag, but nothing is overridden and -fno-omit-frame-pointer is passed twice.

Choosing the flags once before the list avoids both:

# -Og with compressed debug info builds smaller and runs faster than -O0, at the
# cost of some variables being optimised away.
if(SEN_OPTIMIZED_DEBUG)
  set(debug_options_ -Og -gz)
else()
  set(debug_options_ -O0 -g)
endif()

set(common_clang_gcc_options_
  ...
  "$<$<CONFIG:Debug>:${debug_options_};-fno-omit-frame-pointer>"
  "$<$<CONFIG:Release>:-O3>"
)

and the if(SEN_USER_SIZE_OPTIMIZED_DEBUG) block below goes away.

The option name would be more aligned with the others by using SEN_OPTIMIZED_DEBUG. The conan option would become with_optimized_debug to match.

Thanks!

[lolito93]

Good morning @EnriqueParodi, thanks for the review. I aligned the naming of the CMake option and factored out how the compiler flags are set.

The merge-base changed after approval.

The base branch was changed.

[lolito93]

Can be re-approved and merged.