Browse Source

Make it clear which files are fully custom vs overridden

Signed-off-by: falkTX <falktx@falktx.com>
tags/22.02
falkTX 3 years ago
parent
commit
af637290fa
Signed by: falkTX <falktx@falktx.com> GPG Key ID: CDBAA37ABC74FBA0
15 changed files with 21 additions and 17 deletions
  1. +9
    -5
      doc/OVERVIEW.md
  2. +1
    -1
      src/Cardinal/RemoteNanoVG.cpp
  3. +1
    -1
      src/Cardinal/RemoteWindow.cpp
  4. +1
    -1
      src/CardinalFX/RemoteNanoVG.cpp
  5. +1
    -1
      src/CardinalFX/RemoteWindow.cpp
  6. +1
    -1
      src/CardinalSynth/RemoteNanoVG.cpp
  7. +1
    -1
      src/CardinalSynth/RemoteWindow.cpp
  8. +6
    -6
      src/Makefile
  9. +0
    -0
      src/custom/RemoteNanoVG.cpp
  10. +0
    -0
      src/custom/RemoteWindow.cpp
  11. +0
    -0
      src/custom/asset.cpp
  12. +0
    -0
      src/custom/dep.cpp
  13. +0
    -0
      src/custom/library.cpp
  14. +0
    -0
      src/custom/network.cpp
  15. +0
    -0
      src/custom/osdialog.cpp

+ 9
- 5
doc/OVERVIEW.md View File

@@ -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



+ 1
- 1
src/Cardinal/RemoteNanoVG.cpp View File

@@ -1 +1 @@
../override/RemoteNanoVG.cpp
../custom/RemoteNanoVG.cpp

+ 1
- 1
src/Cardinal/RemoteWindow.cpp View File

@@ -1 +1 @@
../override/RemoteWindow.cpp
../custom/RemoteWindow.cpp

+ 1
- 1
src/CardinalFX/RemoteNanoVG.cpp View File

@@ -1 +1 @@
../override/RemoteNanoVG.cpp
../custom/RemoteNanoVG.cpp

+ 1
- 1
src/CardinalFX/RemoteWindow.cpp View File

@@ -1 +1 @@
../override/RemoteWindow.cpp
../custom/RemoteWindow.cpp

+ 1
- 1
src/CardinalSynth/RemoteNanoVG.cpp View File

@@ -1 +1 @@
../override/RemoteNanoVG.cpp
../custom/RemoteNanoVG.cpp

+ 1
- 1
src/CardinalSynth/RemoteWindow.cpp View File

@@ -1 +1 @@
../override/RemoteWindow.cpp
../custom/RemoteWindow.cpp

+ 6
- 6
src/Makefile View File

@@ -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


src/override/RemoteNanoVG.cpp → src/custom/RemoteNanoVG.cpp View File


src/override/RemoteWindow.cpp → src/custom/RemoteWindow.cpp View File


src/override/asset.cpp → src/custom/asset.cpp View File


src/override/dep.cpp → src/custom/dep.cpp View File


src/override/library.cpp → src/custom/library.cpp View File


src/override/network.cpp → src/custom/network.cpp View File


src/override/osdialog.cpp → src/custom/osdialog.cpp View File


Loading…
Cancel
Save