updated CMmakeLists for building with Supernova

dyfer · dyfer · commit 24b8b065d468 · 2018-01-04T17:41:58.000-08:00
Also updated instructions and regactored  CMakeLists so the .cpp file needs to be specified at the beginning of the file, while the project name is inferred from that filename
diff --git a/01a-BoringMixer/CMakeLists.txt b/01a-BoringMixer/CMakeLists.txt
@@ -1,17 +1,34 @@
+set(FILENAME "BoringMixer.cpp") #specify the .cpp file here
 cmake_minimum_required (VERSION 2.8)
-set(PROJECT "BoringMixer")
+get_filename_component(PROJECT ${FILENAME} NAME_WE) #automatically sets project name from the filename
+# set(PROJECT "my_name") #alternatively set project name manually
+message(STATUS "Project name is ${PROJECT}")
 project (${PROJECT})
 
 include_directories(${SC_PATH}/include/plugin_interface)
 include_directories(${SC_PATH}/include/common)
 include_directories(${SC_PATH}/common)
 
-
 set(CMAKE_SHARED_MODULE_PREFIX "")
 if(APPLE OR WIN32)
 set(CMAKE_SHARED_MODULE_SUFFIX ".scx")
 endif()
 
+option(SUPERNOVA "Build plugins for supernova" OFF)
+if (SUPERNOVA)
+    include_directories(${SC_PATH}/external_libraries/nova-tt)
+    # actually just boost.atomic
+    include_directories(${SC_PATH}/external_libraries/boost)
+    include_directories(${SC_PATH}/external_libraries/boost_lockfree)
+    include_directories(${SC_PATH}/external_libraries/boost-lockfree)
+endif()
+
+option(CPP11 "Build with c++11." ON)
+
+if(CMAKE_CXX_COMPILER_ID STREQUAL "Clang")
+	set(CMAKE_COMPILER_IS_CLANG 1)
+endif()
+
 # The below monstrosity sets compiler flags for SSE (Streaming SIMD Extensions). Among many other things, SSE protects
 # against denormal numbers, which are known to cause glitchy audio in some cases.
 
@@ -71,4 +88,9 @@ if(MINGW)
     set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -mstackrealign")
 endif()
 
-add_library(${PROJECT} MODULE BoringMixer.cpp)
+add_library(${PROJECT} MODULE ${FILENAME})
+if(SUPERNOVA)
+    add_library(${PROJECT}_supernova MODULE ${FILENAME})
+    set_property(TARGET ${PROJECT}_supernova
+                 PROPERTY COMPILE_DEFINITIONS SUPERNOVA)
+endif()
diff --git a/01b-BoringMixer/CMakeLists.txt b/01b-BoringMixer/CMakeLists.txt
@@ -1,19 +1,34 @@
+set(FILENAME "BoringMixer.cpp") #specify the .cpp file here
 cmake_minimum_required (VERSION 2.8)
-set(PROJECT "BoringMixer")
+get_filename_component(PROJECT ${FILENAME} NAME_WE) #automatically sets project name from the filename
+# set(PROJECT "my_name") #alternatively set project name manually
+message(STATUS "Project name is ${PROJECT}")
 project (${PROJECT})
 
 include_directories(${SC_PATH}/include/plugin_interface)
 include_directories(${SC_PATH}/include/common)
 include_directories(${SC_PATH}/common)
 
-
 set(CMAKE_SHARED_MODULE_PREFIX "")
 if(APPLE OR WIN32)
 set(CMAKE_SHARED_MODULE_SUFFIX ".scx")
 endif()
 
+option(SUPERNOVA "Build plugins for supernova" OFF)
+if (SUPERNOVA)
+    include_directories(${SC_PATH}/external_libraries/nova-tt)
+    # actually just boost.atomic
+    include_directories(${SC_PATH}/external_libraries/boost)
+    include_directories(${SC_PATH}/external_libraries/boost_lockfree)
+    include_directories(${SC_PATH}/external_libraries/boost-lockfree)
+endif()
+
 option(CPP11 "Build with c++11." ON)
 
+if(CMAKE_CXX_COMPILER_ID STREQUAL "Clang")
+	set(CMAKE_COMPILER_IS_CLANG 1)
+endif()
+
 if(CMAKE_COMPILER_IS_GNUCXX OR CMAKE_COMPILER_IS_CLANG)
     add_definitions(-fvisibility=hidden)
 
@@ -66,4 +81,9 @@ if(MINGW)
     set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -mstackrealign")
 endif()
 
-add_library(${PROJECT} MODULE BoringMixer.cpp)
+add_library(${PROJECT} MODULE ${FILENAME})
+if(SUPERNOVA)
+    add_library(${PROJECT}_supernova MODULE ${FILENAME})
+    set_property(TARGET ${PROJECT}_supernova
+                 PROPERTY COMPILE_DEFINITIONS SUPERNOVA)
+endif()
diff --git a/02-MySaw/CMakeLists.txt b/02-MySaw/CMakeLists.txt
@@ -1,19 +1,34 @@
+set(FILENAME "MySaw.cpp") #specify the .cpp file here
 cmake_minimum_required (VERSION 2.8)
-set(PROJECT "MySaw")
+get_filename_component(PROJECT ${FILENAME} NAME_WE) #automatically sets project name from the filename
+# set(PROJECT "my_name") #alternatively set project name manually
+message(STATUS "Project name is ${PROJECT}")
 project (${PROJECT})
 
 include_directories(${SC_PATH}/include/plugin_interface)
 include_directories(${SC_PATH}/include/common)
 include_directories(${SC_PATH}/common)
 
-
 set(CMAKE_SHARED_MODULE_PREFIX "")
 if(APPLE OR WIN32)
 set(CMAKE_SHARED_MODULE_SUFFIX ".scx")
 endif()
 
+option(SUPERNOVA "Build plugins for supernova" OFF)
+if (SUPERNOVA)
+    include_directories(${SC_PATH}/external_libraries/nova-tt)
+    # actually just boost.atomic
+    include_directories(${SC_PATH}/external_libraries/boost)
+    include_directories(${SC_PATH}/external_libraries/boost_lockfree)
+    include_directories(${SC_PATH}/external_libraries/boost-lockfree)
+endif()
+
 option(CPP11 "Build with c++11." ON)
 
+if(CMAKE_CXX_COMPILER_ID STREQUAL "Clang")
+	set(CMAKE_COMPILER_IS_CLANG 1)
+endif()
+
 if(CMAKE_COMPILER_IS_GNUCXX OR CMAKE_COMPILER_IS_CLANG)
     add_definitions(-fvisibility=hidden)
 
@@ -66,4 +81,9 @@ if(MINGW)
     set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -mstackrealign")
 endif()
 
-add_library(${PROJECT} MODULE MySaw.cpp)
+add_library(${PROJECT} MODULE ${FILENAME})
+if(SUPERNOVA)
+    add_library(${PROJECT}_supernova MODULE ${FILENAME})
+    set_property(TARGET ${PROJECT}_supernova
+                 PROPERTY COMPILE_DEFINITIONS SUPERNOVA)
+endif()
diff --git a/03-AnalogEcho/CMakeLists.txt b/03-AnalogEcho/CMakeLists.txt
@@ -1,19 +1,34 @@
+set(FILENAME "AnalogEcho.cpp") #specify the .cpp file here
 cmake_minimum_required (VERSION 2.8)
-set(PROJECT "AnalogEcho")
+get_filename_component(PROJECT ${FILENAME} NAME_WE) #automatically sets project name from the filename
+# set(PROJECT "my_name") #alternatively set project name manually
+message(STATUS "Project name is ${PROJECT}")
 project (${PROJECT})
 
 include_directories(${SC_PATH}/include/plugin_interface)
 include_directories(${SC_PATH}/include/common)
 include_directories(${SC_PATH}/common)
 
-
 set(CMAKE_SHARED_MODULE_PREFIX "")
 if(APPLE OR WIN32)
 set(CMAKE_SHARED_MODULE_SUFFIX ".scx")
 endif()
 
+option(SUPERNOVA "Build plugins for supernova" OFF)
+if (SUPERNOVA)
+    include_directories(${SC_PATH}/external_libraries/nova-tt)
+    # actually just boost.atomic
+    include_directories(${SC_PATH}/external_libraries/boost)
+    include_directories(${SC_PATH}/external_libraries/boost_lockfree)
+    include_directories(${SC_PATH}/external_libraries/boost-lockfree)
+endif()
+
 option(CPP11 "Build with c++11." ON)
 
+if(CMAKE_CXX_COMPILER_ID STREQUAL "Clang")
+	set(CMAKE_COMPILER_IS_CLANG 1)
+endif()
+
 if(CMAKE_COMPILER_IS_GNUCXX OR CMAKE_COMPILER_IS_CLANG)
     add_definitions(-fvisibility=hidden)
 
@@ -66,4 +81,9 @@ if(MINGW)
     set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -mstackrealign")
 endif()
 
-add_library(${PROJECT} MODULE AnalogEcho.cpp)
+add_library(${PROJECT} MODULE ${FILENAME})
+if(SUPERNOVA)
+    add_library(${PROJECT}_supernova MODULE ${FILENAME})
+    set_property(TARGET ${PROJECT}_supernova
+                 PROPERTY COMPILE_DEFINITIONS SUPERNOVA)
+endif()
diff --git a/README.md b/README.md
@@ -17,7 +17,7 @@ Beyond this repository, the reader is encouraged to look at [sc3-plugins](https:
 
 ## Compiling
 
-This is how you build one of the examples in this directory. The examples are kept separate with duplicated code so that you can simply copy out a directory to start your own ugen. **Currently, this build system is missing two things: Windows and supernova. Sorry, we're working on it...**
+This is how you build one of the examples in this directory. The examples are kept separate with duplicated code so that you can simply copy out a directory to start your own ugen (see [Development workflow](#development-workflow)). **Currently, this build system is missing Windows. Sorry, we're working on it...**
 
 Before you can compile any plugin, you will need a copy of the SuperCollider *source code* (NOT the app itself). The source code version should match your SuperCollider app version. Slight differences will probably be tolerated, but if they're too far apart you will get an "API version mismatch" error when you boot the server.
 
@@ -39,7 +39,14 @@ Here, `/path/to/sc3source/` is the path to the source code. Once again, this is
 
 The path should contain a file at `include/plugin_interface/SC_PlugIn.h`. If you get a warning that `SC_PlugIn.h` could not be found, then `SC_PATH` is not set correctly. If no `SC_PATH` is provided, the build system assumes the SuperCollider include files in `/usr/include/SuperCollider/`.
 
-CMake will remember your `SC_PATH`, so you only need to run that once. After that, simply build using `make`:
+CMake will remember your `SC_PATH`, so you only need to run that once.
+
+If you also want to build a UGen for Supernova, then you need to set the 'SUPERNOVA' flag. The CMake command would then look like this:
+
+```shell
+example-plugins/01a-BoringMixer/build/$ cmake -DSC_PATH=/path/to/sc3source/ -DSUPERNOVA=ON ..
+```
+After that, simply build using `make`:
 
 ```shell
 example-plugins/01a-BoringMixer/build/$ make
@@ -51,9 +58,12 @@ This will produce a "shared library" file ending in `.scx`. On Linux, the extens
 
 Copy, move, or symbolic link the folder into your Extensions folder. You can find out which one that is by evaluating `Platform.userExtensionDir` in sclang. You can install the plugin(s) system-wide by copying to `Platform.systemExtensionDir`.
 
+Please note that currently (as of January 2018) Supernova is more picky about location of UGens on macOS. They need to be placed in a subdirectory called `plugins` inside the above mentioned extension directory. This pertains only to the UGen file (`.scx`), not the `.sc` class file.
+
 If you're not using sclang, the installation method varies. Ask the developer(s) of the client if you're not sure how.
 
 ## Development workflow
+In order to start developing a new UGen, make a copy of one of the example's directory. Change the `.cpp` filename, as well as the name and contents of the corresponding `.sc` file, and update the beginning of `CMakeLists.txt` with your new `.cpp` filename. Then you're ready to work on the code.
 
 If you change your source file(s) or `CMakeLists.txt`, simply use `make` to recompile the shared library. You will need to restart scsynth/supernova for your changes to take effect.
 
