From af637290faa7910c84301228083f117d85ec1738 Mon Sep 17 00:00:00 2001 From: falkTX Date: Sun, 23 Jan 2022 00:10:46 +0000 Subject: [PATCH] Make it clear which files are fully custom vs overridden Signed-off-by: falkTX --- doc/OVERVIEW.md | 14 +++++++++----- src/Cardinal/RemoteNanoVG.cpp | 2 +- src/Cardinal/RemoteWindow.cpp | 2 +- src/CardinalFX/RemoteNanoVG.cpp | 2 +- src/CardinalFX/RemoteWindow.cpp | 2 +- src/CardinalSynth/RemoteNanoVG.cpp | 2 +- src/CardinalSynth/RemoteWindow.cpp | 2 +- src/Makefile | 12 ++++++------ src/{override => custom}/RemoteNanoVG.cpp | 0 src/{override => custom}/RemoteWindow.cpp | 0 src/{override => custom}/asset.cpp | 0 src/{override => custom}/dep.cpp | 0 src/{override => custom}/library.cpp | 0 src/{override => custom}/network.cpp | 0 src/{override => custom}/osdialog.cpp | 0 15 files changed, 21 insertions(+), 17 deletions(-) rename src/{override => custom}/RemoteNanoVG.cpp (100%) rename src/{override => custom}/RemoteWindow.cpp (100%) rename src/{override => custom}/asset.cpp (100%) rename src/{override => custom}/dep.cpp (100%) rename src/{override => custom}/library.cpp (100%) rename src/{override => custom}/network.cpp (100%) rename src/{override => custom}/osdialog.cpp (100%) diff --git a/doc/OVERVIEW.md b/doc/OVERVIEW.md index fce38b1..cb04397 100644 --- a/doc/OVERVIEW.md +++ b/doc/OVERVIEW.md @@ -26,8 +26,8 @@ Being GPLv2+ the code license is compatible with Cardinal's GPLv3+. ## deps 3rd-party libraries build setup. -No actual code is hosted here, only a Makefile with steps for fetching source code and build it. -It basically overrides Rack's `dep.mk` things for a proper static build, and supporting more platforms. +No Cardinal specific code is hosted here, only external submodules and a Makefile with steps for fetching extra source code and build it. +The Makefile overrides Rack's `dep.mk` things for a proper static build, and supporting more platforms. ## doc @@ -81,11 +81,15 @@ The source code is the same for all the variants, with compiler macros used to t A few extra files for having access to a few utilities, code borrowed from Carla, which in turn borrowed it from JUCE. The important one is `SharedResourcePointer`, as a way to easily manage a shared class lifecycle. +### custom + +Here are files that are originally from Rack but fully reimplemented in Cardinal. +Some of them are just stubs to define function symbols but without an actual implementation, for example disabling network features. + ### override -Here are files that need to be customized by Cardinal, where it is not possible or wanted to use the originals from Rack. -This can be for disabling certain features, or simply tweaking engine/UI behaviour. -The filenames should be self-explanatory in what they override from Rack. +Here are files that are very close to the original from Rack but required tweaks for Cardinal. +Extra care is needed to ensure these are kept in sync with the originals. ### Rack diff --git a/src/Cardinal/RemoteNanoVG.cpp b/src/Cardinal/RemoteNanoVG.cpp index e6be4e7..a6394af 120000 --- a/src/Cardinal/RemoteNanoVG.cpp +++ b/src/Cardinal/RemoteNanoVG.cpp @@ -1 +1 @@ -../override/RemoteNanoVG.cpp \ No newline at end of file +../custom/RemoteNanoVG.cpp \ No newline at end of file diff --git a/src/Cardinal/RemoteWindow.cpp b/src/Cardinal/RemoteWindow.cpp index 52195ae..7e00fed 120000 --- a/src/Cardinal/RemoteWindow.cpp +++ b/src/Cardinal/RemoteWindow.cpp @@ -1 +1 @@ -../override/RemoteWindow.cpp \ No newline at end of file +../custom/RemoteWindow.cpp \ No newline at end of file diff --git a/src/CardinalFX/RemoteNanoVG.cpp b/src/CardinalFX/RemoteNanoVG.cpp index e6be4e7..a6394af 120000 --- a/src/CardinalFX/RemoteNanoVG.cpp +++ b/src/CardinalFX/RemoteNanoVG.cpp @@ -1 +1 @@ -../override/RemoteNanoVG.cpp \ No newline at end of file +../custom/RemoteNanoVG.cpp \ No newline at end of file diff --git a/src/CardinalFX/RemoteWindow.cpp b/src/CardinalFX/RemoteWindow.cpp index 52195ae..7e00fed 120000 --- a/src/CardinalFX/RemoteWindow.cpp +++ b/src/CardinalFX/RemoteWindow.cpp @@ -1 +1 @@ -../override/RemoteWindow.cpp \ No newline at end of file +../custom/RemoteWindow.cpp \ No newline at end of file diff --git a/src/CardinalSynth/RemoteNanoVG.cpp b/src/CardinalSynth/RemoteNanoVG.cpp index e6be4e7..a6394af 120000 --- a/src/CardinalSynth/RemoteNanoVG.cpp +++ b/src/CardinalSynth/RemoteNanoVG.cpp @@ -1 +1 @@ -../override/RemoteNanoVG.cpp \ No newline at end of file +../custom/RemoteNanoVG.cpp \ No newline at end of file diff --git a/src/CardinalSynth/RemoteWindow.cpp b/src/CardinalSynth/RemoteWindow.cpp index 52195ae..7e00fed 120000 --- a/src/CardinalSynth/RemoteWindow.cpp +++ b/src/CardinalSynth/RemoteWindow.cpp @@ -1 +1 @@ -../override/RemoteWindow.cpp \ No newline at end of file +../custom/RemoteWindow.cpp \ No newline at end of file diff --git a/src/Makefile b/src/Makefile index 0f1df44..a442f4d 100644 --- a/src/Makefile +++ b/src/Makefile @@ -95,17 +95,17 @@ BUILD_CXX_FLAGS += -DnsvgParseFromFile=nsvgParseFromFileCardinal RACK_FILES += AsyncDialog.cpp RACK_FILES += CardinalModuleWidget.cpp +RACK_FILES += custom/asset.cpp +RACK_FILES += custom/dep.cpp +RACK_FILES += custom/library.cpp +RACK_FILES += custom/network.cpp +RACK_FILES += custom/osdialog.cpp RACK_FILES += override/blendish.c +RACK_FILES += override/context.cpp RACK_FILES += override/Engine.cpp RACK_FILES += override/MenuBar.cpp RACK_FILES += override/MIDI_CV.cpp RACK_FILES += override/Scene.cpp -RACK_FILES += override/asset.cpp -RACK_FILES += override/context.cpp -RACK_FILES += override/dep.cpp -RACK_FILES += override/library.cpp -RACK_FILES += override/network.cpp -RACK_FILES += override/osdialog.cpp RACK_FILES += Rack/dep/pffft/pffft.c RACK_FILES += Rack/dep/pffft/fftpack.c diff --git a/src/override/RemoteNanoVG.cpp b/src/custom/RemoteNanoVG.cpp similarity index 100% rename from src/override/RemoteNanoVG.cpp rename to src/custom/RemoteNanoVG.cpp diff --git a/src/override/RemoteWindow.cpp b/src/custom/RemoteWindow.cpp similarity index 100% rename from src/override/RemoteWindow.cpp rename to src/custom/RemoteWindow.cpp diff --git a/src/override/asset.cpp b/src/custom/asset.cpp similarity index 100% rename from src/override/asset.cpp rename to src/custom/asset.cpp diff --git a/src/override/dep.cpp b/src/custom/dep.cpp similarity index 100% rename from src/override/dep.cpp rename to src/custom/dep.cpp diff --git a/src/override/library.cpp b/src/custom/library.cpp similarity index 100% rename from src/override/library.cpp rename to src/custom/library.cpp diff --git a/src/override/network.cpp b/src/custom/network.cpp similarity index 100% rename from src/override/network.cpp rename to src/custom/network.cpp diff --git a/src/override/osdialog.cpp b/src/custom/osdialog.cpp similarity index 100% rename from src/override/osdialog.cpp rename to src/custom/osdialog.cpp