refactor: Cpp WASM Lightweight Framework

.github/CHANGELOG.md

@@ -35,6 +35,8 @@
 1. [EFCS] Implement calculated yaw damper gain  - @lukecologne (luke)
 1. [EFCS] Decrease yaw damper at low speeds on ground, down to 0 below 40kts - @lukecologne (luke)
 1. [FLIGHTMODEL] Fix pitch trim on approach - @donstim (donbikes)
+1. [GENERAL] Added C++ WASM framework and migrated all flypad-backend code to it - @frankkopp (Frank Kopp)
+1. [EFB] C++ WASM framework, extra-backend to replace flypad-backend, smooth dial turning for Lighting Presets  - @frankkopp (Frank Kopp)
 
 ## 0.11.0
 

.gitignore

@@ -102,8 +102,9 @@
 # explicit exclusions
 /.env
 node_modules/
-obj/
 target/
+obj/
+cmake-build*/
 *.tgz
 *.wasm
 cmake-build*

.vscode/c_cpp_properties.json

@@ -8,8 +8,13 @@
                 "${MSFS_SDK}/SimConnect SDK/include",
                 "${workspaceFolder}/fbw-common/src/wasm/fbw_common/src/**",
                 "${workspaceFolder}/fbw-a32nx/src/wasm/fbw_a320/src/**",
-                "${workspaceFolder}/fbw-a380x/src/wasm/fbw_a380/src/**"
-              ],
+                "${workspaceFolder}/fbw-a380x/src/wasm/fbw_a380/src/**",
+                "${workspaceFolder}/fbw-common/src/wasm/cpp-msfs-framework/**",
+                "${workspaceFolder}/fbw-common/src/wasm/extra-backend/**",
+                "${workspaceFolder}/fbw-a32nx/src/wasm/extra-backend-a32nx/src/**",
+                "${workspaceFolder}/fbw-a380x/src/wasm/extra-backend-a380x/src/**",
+                "${workspaceFolder}/fbw-a32nx/src/wasm/fadec_a320/src/**",
+                "${workspaceFolder}/fbw-a380x/src/wasm/fadec_a380/src/**"           ],
             "defines": [
                 "_MSFS_WASM=1",
                 "__wasi__",
@@ -18,13 +23,12 @@
                 "_MBCS"
             ],
             "windowsSdkVersion": "10.0.18362.0",
-            //"compilerPath": "${MSFS_SDK}/WASM/llvm/bin/clang-cl.exe",
             "compilerArgs": [
               "--sysroot ${MSFS_SDK}/WASM/wasi-sysroot",
               "-target wasm32-unknown-wasi"
             ],
             "cStandard": "c17",
-            "cppStandard": "c++17",
+            "cppStandard": "c++20",
             "intelliSenseMode": "msvc-x64"
         }
     ],

.vscode/launch.json

@@ -8,6 +8,7 @@
             "name": "Attach",
             "type": "cppvsdbg",
             "request": "attach",
+            "processId": "${command:pickProcess}",
             "args": [],
             "stopAtEntry": false,
             "cwd": "${fileDirname}",
@@ -45,4 +46,4 @@
             }
         }
     ]
-}
+    }

CMakeLists.txt

@@ -1,27 +1,59 @@
-# This CMakeLists.txt file is used only for syntax highlighting and navigating
-# through the code in an IDE. It is not used for building the project.
-
-cmake_minimum_required(VERSION 3.19)
-project(flybywire-a32nx)
+cmake_minimum_required(VERSION 3.18)
+project(flybywire-aircraft C CXX)
 
 set(CMAKE_CXX_STANDARD 20)
-set(MSFS_SDK "C:\\MSFS SDK")
-set(FBW_ROOT ${CMAKE_SOURCE_DIR})
+set(CMAKE_VERBOSE_MAKEFILE OFF)
+set(FBW_ROOT ${CMAKE_CURRENT_SOURCE_DIR})
+set(FBW_COMMON ${FBW_ROOT}/fbw-common/src/wasm)
+
+# cmake helper scripts
+include("${FBW_COMMON}/cpp-msfs-framework/cmake/TargetDefinition.cmake")
+
+# compiler refinement
+set(COMPILER_FLAGS "-Wall -Wextra -Wno-unused-function -Wno-unused-command-line-argument -Wno-ignored-attributes -Wno-macro-redefined -target wasm32-unknown-wasi --sysroot \"${MSFS_SDK}/WASM/wasi-sysroot\" -mthread-model single -fno-exceptions -fms-extensions -fvisibility=hidden -ffunction-sections -fdata-sections -fno-stack-protector")
+
+set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} ${COMPILER_FLAGS}")
+set(CMAKE_C_FLAGS_RELEASE "${CMAKE_C_FLAGS_RELEASE} -flto -O2 -DNDEBUG")
+set(CMAKE_C_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} -O0 -DDEBUG")
+
+set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${COMPILER_FLAGS}")
+set(CMAKE_CXX_FLAGS_RELEASE "${CMAKE_C_FLAGS_RELEASE} -flto -O2 -DNDEBUG")
+set(CMAKE_CXX_FLAGS_DEBUG "${CMAKE_CXX_FLAGS_DEBUG} -O0 -DDEBUG")
 
-# include sub directories
+message("MSFS_SDK: " ${MSFS_SDK})
+
+# add the include paths
 include_directories(
-        ${PROJECT_SOURCE_DIR}/fbw-a32nx/src/wasm/fadec_a320
-        ${PROJECT_SOURCE_DIR}/fbw-a32nx/src/wasm/fbw_a320
-        ${PROJECT_SOURCE_DIR}/fbw-a32nx/src/wasm/flypad-backend
-        ${PROJECT_SOURCE_DIR}/fbw-a380x/src/wasm/fadec_a380
-        ${PROJECT_SOURCE_DIR}/fbw-a380x/src/wasm/fbw_a380
-        ${PROJECT_SOURCE_DIR}/fbw-common/src/wasm/fadec_common
-        ${PROJECT_SOURCE_DIR}/fbw-common/src/wasm/fbw_common
+    "${MSFS_SDK}/WASM/include"
+    "${MSFS_SDK}/WASM/wasi-sysroot/include"
+    "${MSFS_SDK}/WASM/wasi-sysroot/include/c++/v1"
+    "${MSFS_SDK}/SimConnect SDK/include"
+    "${FBW_COMMON}/cpp-msfs-framework/lib"
+    "${FBW_COMMON}/cpp-msfs-framework/MsfsHandler"
+    "${FBW_COMMON}/cpp-msfs-framework/MsfsHandler/DataTypes"
+)
+
+# add compiler definitions
+add_definitions(
+    -D_MSFS_WASM=1
+    -D__wasi__
+    -D_LIBC_NO_EXCEPTIONS
+    -D_LIBCPP_HAS_NO_THREADS
+    -D_WINDLL
+    -D_MBCS
+    # ZERO_LVL=0 CRITICAL_LVL=1 ERROR_LVL=2 WARN_LVL=3 INFO_LVL=4 DEBUG_LVL=5 VERBOSE=6 TRACE_LVL=7
+    -DLOG_LEVEL=4
+    # EXAMPLES | NO_EXAMPLES
+    -DNO_EXAMPLES
+    #PROFILING | NO_PROFILING - for logging of profiling information of pre-, post-, update() calls
+    -DNO_PROFILING
 )
 
-add_subdirectory(./fbw-a32nx/src/wasm/fadec_a320)
-add_subdirectory(./fbw-a32nx/src/wasm/fbw_a320)
-add_subdirectory(./fbw-a32nx/src/wasm/flypad-backend)
-add_subdirectory(./fbw-a380x/src/wasm/fadec_a380)
-add_subdirectory(./fbw-a380x/src/wasm/fbw_a380)
-add_subdirectory(./fbw-a380x/src/wasm/flypad-backend)
+# add the common components
+add_subdirectory(fbw-common/src/wasm)
+
+# add the A32NX components
+add_subdirectory(fbw-a32nx/src/wasm)
+
+# add the A380X components
+add_subdirectory(fbw-a380x/src/wasm)

fbw-a32nx/src/base/flybywire-aircraft-a320-neo/SimObjects/AirPlanes/FlyByWire_A320_NEO/panel/panel.cfg

@@ -133,7 +133,7 @@ background_color = 0,0,0
 htmlgauge00 = WasmInstrument/WasmInstrument.html?wasm_module=systems.wasm&wasm_gauge=systems,0,0,1,1
 htmlgauge01 = WasmInstrument/WasmInstrument.html?wasm_module=fbw.wasm&wasm_gauge=fbw,0,0,1,1
 htmlgauge02 = WasmInstrument/WasmInstrument.html?wasm_module=fadec.wasm&wasm_gauge=FadecGauge,0,0,1,1
-htmlgauge03 = WasmInstrument/WasmInstrument.html?wasm_module=flypad-backend.wasm&wasm_gauge=FlyPadBackend,0,0,1,1
+htmlgauge03 = WasmInstrument/WasmInstrument.html?wasm_module=extra-backend-a32nx.wasm&wasm_gauge=Gauge_Extra_Backend,0,0,1,1
 
 [VCockpit18]
 size_mm = 0,0

fbw-a32nx/src/systems/instruments/src/EFB/Efb.tsx

@@ -211,28 +211,32 @@ const Efb = () => {
 
     // Automatically load a lighting preset
     useEffect(() => {
-        if (ac1BusIsPowered && autoLoadLightingPresetEnabled) {
+        if (ac1BusIsPowered && powerState === PowerStates.LOADED && autoLoadLightingPresetEnabled) {
+            // TIME OF DAY enum : 1 = Day ; 2 = Dusk/Dawn ; 3 = Night
             switch (timeOfDay) {
             case 1:
                 if (autoLoadDayLightingPresetID !== 0) {
+                    console.log('Auto-loading lighting preset: ', autoLoadDayLightingPresetID);
                     setLoadLightingPresetVar(autoLoadDayLightingPresetID);
                 }
                 break;
             case 2:
                 if (autoLoadDawnDuskLightingPresetID !== 0) {
+                    console.log('Auto-loading lighting preset: ', autoLoadDawnDuskLightingPresetID);
                     setLoadLightingPresetVar(autoLoadDawnDuskLightingPresetID);
                 }
                 break;
             case 3:
                 if (autoLoadNightLightingPresetID !== 0) {
+                    console.log('Auto-loading lighting preset: ', autoLoadNightLightingPresetID);
                     setLoadLightingPresetVar(autoLoadNightLightingPresetID);
                 }
                 break;
             default:
                 break;
             }
         }
-    }, [ac1BusIsPowered, autoLoadLightingPresetEnabled]);
+    }, [ac1BusIsPowered, powerState, autoLoadLightingPresetEnabled]);
 
     useInterval(() => {
         if (!autoFillChecklists) return;

fbw-a32nx/src/systems/instruments/src/EFB/Presets/Widgets/Procedures.tsx

@@ -68,7 +68,6 @@ export const StepDescription = new Map([
     [2090, 'ATC ALT RPTG On'],
     [2100, 'TCAS TRAFFIC ABV'],
     [2110, 'COCKPIT DOOR LCK'],
-    [2120, 'Strobe Auto'],
     [2120, 'Strobe On'],
     [2121, 'Strobe Off'],
     [2122, 'Strobe Auto'],

fbw-a32nx/src/wasm/CMakeLists.txt

@@ -0,0 +1,13 @@
+# folder structure
+set(OUTPUT_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/../../out/flybywire-aircraft-a320-neo/SimObjects/AirPlanes/FlyByWire_A320_NEO/panel)
+
+# add compiler definitions
+add_definitions(-DA32NX)
+
+add_subdirectory(extra-backend-a32nx)
+
+# FIXME: remove the if-clause as soon as all components are using CMake
+if (WIN32)
+    add_subdirectory(fadec_a320)
+    add_subdirectory(fbw_a320)
+endif ()

fbw-a32nx/src/wasm/README.md

@@ -7,6 +7,6 @@ This directory contains the source Rust and C++ files for the WASM modules.
 ```
 - fadec_a320            <c++ src for fadec>
 - fbw_a320	            <c++ src for fbw/ap>
-- flypad-backend        <c++ src for flypad backend>
+- extra-backend-a32nx   <c++ src for backend for flyPad and other extra non-aviation systems>
 - systems       	    <rust src for other systems>
 ```

fbw-a32nx/src/wasm/extra-backend-a32nx/CMakeLists.txt

@@ -0,0 +1,42 @@
+# extra-backend-a32nx CMakeLists.txt
+
+# add additional compiler definitions for the a32nx extra-backend build
+add_definitions()
+
+# add the local include directories
+include_directories(
+    ${CMAKE_CURRENT_SOURCE_DIR}/src
+    ${CMAKE_CURRENT_SOURCE_DIR}/src/AircraftPresets
+    ${CMAKE_CURRENT_SOURCE_DIR}/src/LightingPresets
+    ${FBW_COMMON}/cpp-msfs-framework/
+    ${FBW_COMMON}/extra-backend/
+)
+
+# define the source files
+set(SOURCE_FILES
+    ${CMAKE_CURRENT_SOURCE_DIR}/src/Gauge_Extra_Backend.cpp
+    ${CMAKE_CURRENT_SOURCE_DIR}/src/LightingPresets/LightingPresets_A32NX.cpp
+    ${FBW_COMMON}/cpp-msfs-framework/Example/ExampleModule.cpp
+    ${FBW_COMMON}/extra-backend/Pushback/Pushback.cpp
+    ${FBW_COMMON}/extra-backend/AircraftPresets/AircraftPresets.cpp
+    ${FBW_COMMON}/extra-backend/LightingPresets/LightingPresets.cpp
+    )
+set(INCLUDE_FILES
+    ${CMAKE_CURRENT_SOURCE_DIR}/src/AircraftPresets/AircraftPresetProcedures_A32NX.h
+    ${CMAKE_CURRENT_SOURCE_DIR}/src/LightingPresets/LightingPresets_A32NX.h
+    ${FBW_COMMON}/cpp-msfs-framework/Example/ExampleModule.h
+    ${FBW_COMMON}/cpp-msfs-framework/Example/longtext.h
+    ${FBW_COMMON}/extra-backend/Pushback/InertialDampener.hpp
+    ${FBW_COMMON}/extra-backend/Pushback/Pushback.h
+    ${FBW_COMMON}/extra-backend/AircraftPresets/AircraftPresets.h
+    ${FBW_COMMON}/extra-backend/AircraftPresets/PresetProcedures.h
+    ${FBW_COMMON}/extra-backend/AircraftPresets/ProcedureStep.h
+    ${FBW_COMMON}/extra-backend/LightingPresets/LightingPresets.h
+    )
+
+# create the targets
+add_library(extra-backend-a32nx OBJECT ${SOURCE_FILES} ${INCLUDE_FILES})
+add_wasm_library(
+    NAME extra-backend-a32nx
+    DEPENDENCIES extra-backend-a32nx cpp-msfs-framework-a32nx
+)