2.4.0 Update - Phase I

Author: Requiem

CMakeLists.txt

@@ -6,35 +6,42 @@ project(
     LANGUAGES CXX
 )
 
-
-# set c++ standard
+# set C++ standard
 if(NOT DEFINED CMAKE_CXX_STANDARD)
     set(CMAKE_CXX_STANDARD 20)
 endif()
-
-
-# compiler flags
 set(CMAKE_CXX_STANDARD_REQUIRED ON)
 set(CMAKE_CXX_EXTENSIONS OFF)
 
+if(MSVC)
+    # Globally disable specific MSVC warnings from external headers
+    add_compile_options(
+        /wd5039  # 'TpSetCallbackCleanupGroup' potentially throwing
+        /wd4820  # padding added after data member
+        /wd4626  # deleted assignment operator
+        /wd5045  # Spectre mitigation notice
+        /wd4668  # undefined macro replaced with '0'
+    )
+endif()
+
+# compiler flags
 if (MSVC)
     set(CMAKE_CXX_FLAGS "/Wall /W4 /EHsc")
 else()
-    # linux and apple
+    # Linux and Apple
     set(CMAKE_CXX_FLAGS "-Wextra -Wall -Wextra -Wconversion -Wdouble-promotion -Wno-unused-parameter -Wno-unused-function -Wno-sign-conversion")
 endif()
 
 if(CMAKE_C_COMPILER_ID STREQUAL "Clang" OR CMAKE_C_COMPILER_ID STREQUAL "GNU")
     set(CMAKE_CXX_FLAGS "${CMAKE_C_FLAGS} -lstdc++ -lm")
 endif()
 
-
 # find available compilers
 if (LINUX)
     find_program(CLANGPP_EXECUTABLE NAMES clang++)
     find_program(GPP_EXECUTABLE NAMES g++)
 
-    # select compiler with preference for clang++ (just a personal choice of mine, i'm kinda obsessed with llvm honestly)
+    # select compiler with preference for clang++
     if(CLANGPP_EXECUTABLE)
         set(CMAKE_CXX_COMPILER "${CLANGPP_EXECUTABLE}")
         get_filename_component(COMPILER_NAME ${CLANGPP_EXECUTABLE} NAME)
@@ -45,67 +52,59 @@ if (LINUX)
 endif()
 
 message(STATUS "Compiler: ${COMPILER_NAME}")
-#message(STATUS "Compiler version: ${CMAKE_CXX_COMPILER_VERSION}")
-
-
 
 # fetch and set build type
 set(available_build_types Debug Release)
 if(NOT CMAKE_BUILD_TYPE)
-set(CMAKE_BUILD_TYPE Release CACHE STRING "Choose the type of build (Debug or Release)" FORCE)
+    set(CMAKE_BUILD_TYPE Release CACHE STRING "Choose the type of build (Debug or Release)" FORCE)
 endif()
 
-
 # Define preprocessor macros based on the build type
 if(CMAKE_BUILD_TYPE STREQUAL "Debug")
-add_compile_definitions(__VMAWARE_DEBUG__)
+    add_compile_definitions(__VMAWARE_DEBUG__)
 elseif(CMAKE_BUILD_TYPE STREQUAL "Release")
-add_compile_definitions(__VMAWARE_RELEASE__)
+    add_compile_definitions(__VMAWARE_RELEASE__)
 endif()
 
-
 # general variables
 set(PROJECT_DIR "${CMAKE_CURRENT_SOURCE_DIR}")
 set(BUILD_DIR "${PROJECT_DIR}/build")
 set(TARGET "vmaware")
 
-
 # debug/release CXX flag options
 if (MSVC)
     if(CMAKE_BUILD_TYPE MATCHES "Debug")
-        MESSAGE(STATUS "Build set to debug mode")
+        message(STATUS "Build set to debug mode")
     elseif(CMAKE_BUILD_TYPE MATCHES "Release")
-        MESSAGE(STATUS "Build set to release mode")
+        message(STATUS "Build set to release mode")
         set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} /O2")
     endif()
 elseif(APPLE)
     if(CMAKE_BUILD_TYPE MATCHES "Debug")
-        MESSAGE(STATUS "Build set to debug mode")
+        message(STATUS "Build set to debug mode")
         set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -g -O0 -fsanitize=address")
     elseif(CMAKE_BUILD_TYPE MATCHES "Release")
-        MESSAGE(STATUS "Build set to release mode")
-        set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -g0 -O2")
-        set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -march=native -mtune=native")
+        message(STATUS "Build set to release mode")
+        set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -g0 -O2 -march=native -mtune=native")
     endif()
 elseif(LINUX)
     if(CMAKE_BUILD_TYPE MATCHES "Debug")
-        MESSAGE(STATUS "Build set to debug mode")
-        set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -g -fmax-errors=5 -DDEBUG -O0 -fsanitize=address,leak") # todo, add ubsan
+        message(STATUS "Build set to debug mode")
+        set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -g -fmax-errors=5 -DDEBUG -O0 -fsanitize=address,leak")
     elseif(CMAKE_BUILD_TYPE MATCHES "Release")
-        MESSAGE(STATUS "Build set to release mode")
+        message(STATUS "Build set to release mode")
         set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -g0 -O2")
-        if (${CMAKE_SYSTEM_PROCESSOR} MATCHES "x86_64")
+        if(${CMAKE_SYSTEM_PROCESSOR} MATCHES "x86_64")
             set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -march=native -mtune=native")
         elseif(${CMAKE_SYSTEM_PROCESSOR} MATCHES "arm")
             set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -mcpu=native")
         endif()
     endif()
 else()
-    MESSAGE(STATUS "Build set to release mode")
+    message(STATUS "Build set to release mode")
     set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -O2")
 endif()
 
-
 # add executable
 set(CMAKE_RUNTIME_OUTPUT_DIRECTORY "${BUILD_DIR}")
 add_executable(${TARGET} "src/cli.cpp")
@@ -114,19 +113,17 @@ if(NOT DEFINED CMAKE_CXX_STANDARD)
 endif()
 set_property(TARGET ${TARGET} PROPERTY CXX_STANDARD_REQUIRED ON)
 
-
 # CTest stuff
 include(CTest)
 enable_testing()
 set(ARGUMENTS "--all")
 if(MSVC)
-add_test(executable, "${BUILD_DIR}/Release/${TARGET}")
+    add_test(executable "${BUILD_DIR}/Release/${TARGET}")
 else()
-add_test(NAME TARGET COMMAND "${BUILD_DIR}/${TARGET}" ${ARGUMENTS})
+    add_test(NAME TARGET COMMAND "${BUILD_DIR}/${TARGET}" ${ARGUMENTS})
 endif()
 
-
-# release stuff
+# install rules
 if (NOT MSVC)
     if(CMAKE_BUILD_TYPE MATCHES "Release")
         install(TARGETS ${TARGET} DESTINATION /usr/bin)
@@ -142,4 +139,4 @@ elseif(MSVC)
     set(HEADER_INSTALL_PATH "C:\\Program Files (x86)\\YourLibrary\\include")
     install(FILES "src/vmaware.hpp" DESTINATION "${HEADER_INSTALL_PATH}")
     install(FILES "src/vmaware_MIT.hpp" DESTINATION "${HEADER_INSTALL_PATH}")
-endif()
+endif()

CONTRIBUTING.md

@@ -13,9 +13,8 @@ You can create an issue, and I will reply within 24 hours. We have too much free
 
 
 ## Extra 
-We have a tool that can update the MIT file and other details of the library with a python script for maintenance purposes. The script at `auxiliary/updater.py` will update:
+We have an useful script at `auxiliary/updater.py` will update:
 - the section line numbers in the header banner
 - the date of the update
-- the MIT file by copying the GPL file and removing every GPL code (so that you don't have to make the same changes on 2 different files separately, just focus on vmaware.hpp and let the script manage the vmaware_MIT.hpp file)
 
 It's highly recommended to use this script before sending the PR so that all the above don't have to be manually updated, which can be time consuming and can potentially creep in some human errors.