Don't make versioning default. Separate out Benchmarks target.

Author: sudara

.github/workflows/cmake_ctest.yml

@@ -10,7 +10,7 @@ concurrency:
   cancel-in-progress: true
 
 env:
-  PROJECT_NAME: Pamplejuce_v1
+  PROJECT_NAME: Pamplejuce
   BUILD_TYPE: Release
   BUILD_DIR: Builds
   GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

CMakeLists.txt

@@ -4,19 +4,16 @@ cmake_minimum_required(VERSION 3.24.1)
 
 # This tells cmake we have goodies in the /cmake folder
 list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_SOURCE_DIR}/cmake")
+include (PamplejuceVersion)
 
 # This is the name of your plugin
-# Change me! Note: It cannot have spaces (but PRODUCT_NAME can)
+# Change me! Note: It cannot have spaces (but JUCE's PRODUCT_NAME can)
+# You may want to append the major version on the end of this (and PRODUCT_NAME)
+# set(PROJECT_NAME "MyPlugin_v${MAJOR_VERSION}")
+# Doing so enables major versions to show up in IDEs and DAWs as separate plugins
+# allowing you to change parameters and behavior without breaking user projects
 set(PROJECT_NAME "Pamplejuce")
 
-include (PamplejuceVersion)
-
-# By default, we add the major version on the end of the plugin name like  _v1
-# Different major versions then show up in DAWs as separate plugins
-# This lets you change parameters and behavior without breaking user projects
-# Comment the following line to disable this behavior
-set(PROJECT_NAME "Pamplejuce_v${MAJOR_VERSION}")
-
 # Set the plugin formats you'll be building here.
 # Valid choices here: AAX Unity VST VST3 AU AUv3 Standalone
 set(FORMATS Standalone AU VST3 AUv3)
@@ -62,11 +59,13 @@ juce_add_plugin("${PROJECT_NAME}"
     PLUGIN_CODE P001
     FORMATS "${FORMATS}"
 
-    # Change me!
     # The name of your final executable
     # This is how it's listed in the DAW
     # This can be different from PROJECT_NAME and can have spaces!
-    PRODUCT_NAME "Pamplejuce v1")
+    # You might want to use v${MAJOR_VERSION} here once you go to v2...
+    set(PRODUCT_NAME "${PROJECT_NAME}")
+
+    PRODUCT_NAME "${PRODUCT_NAME}")
 
 # This lets us use our code in both the JUCE targets and our Test target
 # Without running into ODR violations
@@ -81,7 +80,7 @@ target_compile_features(SharedCode INTERFACE cxx_std_20)
 # Just ensure you employ CONFIGURE_DEPENDS so the build system picks up changes
 # If you want to appease the CMake gods and avoid globs, manually add files like so:
 # set(SourceFiles Source/PluginEditor.h Source/PluginProcessor.h Source/PluginEditor.cpp Source/PluginProcessor.cpp)
-file(GLOB_RECURSE SourceFiles CONFIGURE_DEPENDS "${CMAKE_CURRENT_SOURCE_DIR}/Source/*.cpp" "${CMAKE_CURRENT_SOURCE_DIR}/Source/*.h")
+file(GLOB_RECURSE SourceFiles CONFIGURE_DEPENDS "${CMAKE_CURRENT_SOURCE_DIR}/source/*.cpp" "${CMAKE_CURRENT_SOURCE_DIR}/source/*.h")
 target_sources(SharedCode INTERFACE ${SourceFiles})
 
 # Adds a BinaryData target for embedding assets into the binary
@@ -117,7 +116,11 @@ target_link_libraries(SharedCode
     INTERFACE
     Assets
     melatonin_inspector
-    juce::juce_audio_utils
+    juce_audio_utils
+    juce_audio_processors
+    juce_dsp
+    juce_gui_basics
+    juce_gui_extra
     juce::juce_recommended_config_flags
     juce::juce_recommended_lto_flags
     juce::juce_recommended_warning_flags)
@@ -128,5 +131,8 @@ target_link_libraries("${PROJECT_NAME}" PRIVATE SharedCode)
 # IPP support, comment out to disable
 include(PamplejuceIPP)
 
-# Tests target, comment out to disable
+# Everything related to the tests target
 include(Tests)
+
+# A separate target keeps the Tests target fast!
+include(Benchmarks)

Tests/Benchmarks.cpp benchmarks/Benchmarks.cpp

@@ -0,0 +1,26 @@
+file(GLOB_RECURSE BenchmarkFiles CONFIGURE_DEPENDS "${CMAKE_CURRENT_SOURCE_DIR}/benchmarks/*.cpp" "${CMAKE_CURRENT_SOURCE_DIR}/Benchmarks/*.h")
+
+# Organize the test source in the Tests/ folder in the IDE
+source_group(TREE ${CMAKE_CURRENT_SOURCE_DIR}/benchmarks PREFIX "" FILES ${BenchmarkFiles})
+
+add_executable(Benchmarks ${BenchmarkFiles})
+target_compile_features(Benchmarks PRIVATE cxx_std_20)
+catch_discover_tests(Benchmarks)
+
+# Our benchmark executable also wants to know about our plugin code...
+target_include_directories(Benchmarks PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}/Source)
+
+# Copy over compile definitions from our plugin target so it has all the JUCEy goodness
+target_compile_definitions(Benchmarks PRIVATE $<TARGET_PROPERTY:${PROJECT_NAME},COMPILE_DEFINITIONS>)
+
+# And give tests access to our shared code
+target_link_libraries(Benchmarks PRIVATE SharedCode Catch2::Catch2WithMain)
+
+# Make an Xcode Scheme for the test executable so we can run tests in the IDE
+set_target_properties(Benchmarks PROPERTIES XCODE_GENERATE_SCHEME ON)
+
+# When running Tests we have specific needs
+target_compile_definitions(Benchmarks PUBLIC
+    JUCE_MODAL_LOOPS_PERMITTED=1 # let us run Message Manager in tests
+    RUN_PAMPLEJUCE_TESTS=1 # also run tests in module .cpp files guarded by RUN_PAMPLEJUCE_TESTS
+)

cmake/Benchmarks.cmake

@@ -5,8 +5,10 @@
 enable_testing()
 
 # "GLOBS ARE BAD" is brittle and silly dev UX, sorry CMake!
-file(GLOB_RECURSE TestFiles CONFIGURE_DEPENDS "${CMAKE_CURRENT_SOURCE_DIR}/Tests/*.cpp" "${CMAKE_CURRENT_SOURCE_DIR}/Tests/*.h")
-source_group(TREE ${CMAKE_CURRENT_SOURCE_DIR}/Tests PREFIX "" FILES ${TestFiles})
+file(GLOB_RECURSE TestFiles CONFIGURE_DEPENDS "${CMAKE_CURRENT_SOURCE_DIR}/tests/*.cpp" "${CMAKE_CURRENT_SOURCE_DIR}/tests/*.h")
+
+# Organize the test source in the Tests/ folder in Xcode
+source_group(TREE ${CMAKE_CURRENT_SOURCE_DIR}/tests PREFIX "" FILES ${TestFiles})
 
 # Use Catch2 v3 on the devel branch
 Include(FetchContent)
@@ -37,12 +39,9 @@ set_target_properties(Tests PROPERTIES XCODE_GENERATE_SCHEME ON)
 # When running Tests we have specific needs
 target_compile_definitions(Tests PUBLIC
     JUCE_MODAL_LOOPS_PERMITTED=1 # let us run Message Manager in tests
-    RUN_PAMPLEJUCE_TESTS=1 # lets us run tests in module .cpp files
+    RUN_PAMPLEJUCE_TESTS=1 # also run tests in other module .cpp files guarded by RUN_PAMPLEJUCE_TESTS
 )
 
-# Organize the test source in the Tests/ folder in the IDE
-source_group(TREE ${CMAKE_CURRENT_SOURCE_DIR}/Tests PREFIX "" FILES ${TestFiles})
-
 # Load and use the .cmake file provided by Catch2
 # https://github.com/catchorg/Catch2/blob/devel/docs/cmake-integration.md
 # We have to manually provide the source directory here for now

cmake/Tests.cmake

@@ -2,7 +2,7 @@
 set_target_properties(SharedCode PROPERTIES FOLDER "")
 
 # The Xcode source tree should uhhh, still look like the source tree, yo
-source_group(TREE ${CMAKE_CURRENT_SOURCE_DIR}/Source PREFIX "" FILES ${SourceFiles})
+source_group(TREE ${CMAKE_CURRENT_SOURCE_DIR}/source PREFIX "" FILES ${SourceFiles})
 
 # It tucks the Plugin varieties into a "Targets" folder and generate an Xcode Scheme manually
 # Xcode scheme generation is turned off globally to limit noise from other targets

cmake/Xcode.cmake

@@ -13,7 +13,7 @@ PluginProcessor testPlugin;
 TEST_CASE("Plugin instance name", "[name]")
 {
   CHECK_THAT(testPlugin.getName().toStdString(),
-             Catch::Matchers::Equals("Pamplejuce v1"));
+             Catch::Matchers::Equals("Pamplejuce"));
 }
 
 #ifdef PAMPLEJUCE_IPP