- adding console helper, to factor out some common things from 3ds + switch

- adding debug logger to the consoles

Author: Totto16

platforms/build-3ds.sh

@@ -43,12 +43,12 @@ export ARCH="arm"
 export ARM_VERSION="arm11mpcore"
 export ENDIANESS="little"
 
-export COMMON_FLAGS="'-march=armv6k','-mtune=mpcore','-mfloat-abi=hard', '-mtp=soft','-mword-relocations', '-ffunction-sections', '-fdata-sections'"
+export COMMON_FLAGS="'-march=armv6k','-mtune=mpcore','-mfloat-abi=hard','-mtp=soft','-mword-relocations','-ffunction-sections','-fdata-sections'"
 
 # compat flags for some POSIX functions
 export EXTRA_COMPILE_FLAGS="'-DNOSTYLUS','-D_XOPEN_SOURCE'"
 
-export COMPILE_FLAGS="'-D_3DS','-D__3DS__', '-isystem', '$LIBCTRU/include', '-I$PORTLIBS_PATH_3DS/include'"
+export COMPILE_FLAGS="'-D_3DS','-D__3DS__','-D__CONSOLE__','-D__NINTENDO_CONSOLE__','-isystem','$LIBCTRU/include','-I$PORTLIBS_PATH_3DS/include'"
 
 export LINK_FLAGS="'-L$PORTLIBS_LIB','-L$LIBCTRU_LIB','-fPIE','-specs=$ARCH_DEVKIT_FOLDER/$TOOL_PREFIX/lib/3dsx.specs'"
 
@@ -98,7 +98,7 @@ cpp_link_args = [$COMMON_FLAGS, $LINK_FLAGS]
 [properties]
 pkg_config_libdir = '$PKG_CONFIG_PATH'
 needs_exe_wrapper = true
-library_dirs= ['$LIBCTRU_LIB', '$PORTLIBS_LIB']
+library_dirs= ['$LIBCTRU_LIB','$PORTLIBS_LIB']
 libctru='$LIBCTRU'
 
 APP_NAME	= 'oopetris'

platforms/build-android.sh

@@ -290,8 +290,8 @@ c_std = 'c11'
 cpp_std = 'c++23'
 c_args = ['--sysroot=${SYS_ROOT:?}','-fPIE','-fPIC','--target=$ARM_COMPILER_TRIPLE','-DHAVE_USR_INCLUDE_MALLOC_H','-D_MALLOC_H','-D__BITNESS=$BITNESS']
 cpp_args = ['--sysroot=${SYS_ROOT:?}','-fPIE','-fPIC','--target=$ARM_COMPILER_TRIPLE','-D__BITNESS=$BITNESS']
-c_link_args = ['-fPIE', '-L$SYS_ROOT/usr/lib']
-cpp_link_args = ['-fPIE', '-L$SYS_ROOT/usr/lib']
+c_link_args = ['-fPIE','-L$SYS_ROOT/usr/lib']
+cpp_link_args = ['-fPIE','-L$SYS_ROOT/usr/lib']
 prefix = '$SYS_ROOT'
 libdir = '$LIB_PATH'
 
@@ -307,7 +307,7 @@ EOF
         ln -s "$BASE_PATH/sources/android/cpufeatures/cpu-features.c" "$PWD/subprojects/cpu-features/src/cpu-features.c"
         ln -s "$BASE_PATH/sources/android/cpufeatures/cpu-features.h" "$PWD/subprojects/cpu-features/include/cpu-features.h"
         cat <<EOF >"$PWD/subprojects/cpu-features/meson.build"
-project('cpu-features', 'c')
+project('cpu-features','c')
 
 meson.override_dependency(
     'cpu-features',

platforms/build-switch.sh

@@ -46,7 +46,7 @@ export COMMON_FLAGS="'-ftls-model=local-exec','-march=armv8-a+crc+crypto','-mtun
 # compat flags for some POSIX functions
 export EXTRA_COMPILE_FLAGS="'-DNOSTYLUS','-D_XOPEN_SOURCE'"
 
-export COMPILE_FLAGS="'-D__SWITCH__','-isystem','$LIBNX/include','-I$PORTLIBS_PATH_SWITCH/include'"
+export COMPILE_FLAGS="'-D__SWITCH__','-D__CONSOLE__','-D__NINTENDO_CONSOLE__','-isystem','$LIBNX/include','-I$PORTLIBS_PATH_SWITCH/include'"
 
 export LINK_FLAGS="'-L$PORTLIBS_LIB','-L$LIBNX_LIB','-fPIE','-specs=$DEVKITPRO/libnx/switch.specs'"
 
@@ -96,7 +96,7 @@ cpp_link_args = [$COMMON_FLAGS, $LINK_FLAGS]
 [properties]
 pkg_config_libdir = '$PKG_CONFIG_PATH'
 needs_exe_wrapper = true
-library_dirs= ['$LIBNX_LIB', '$PORTLIBS_LIB']
+library_dirs= ['$LIBNX_LIB','$PORTLIBS_LIB']
 libnx='$LIBNX'
 
 APP_NAME	= 'oopetris'

src/application.cpp

@@ -9,10 +9,8 @@
 #include <ranges>
 #include <stdexcept>
 
-#if defined(__SWITCH__)
-#include <switch.h>
-#elif defined(__3DS__)
-#include <3ds.h>
+#if defined(__CONSOLE__)
+#include "helper/console_helpers.hpp"
 #endif
 
 namespace {
@@ -65,20 +63,13 @@ void Application::run() {
     auto start_execution_time = std::chrono::steady_clock::now();
 
     while (m_is_running
-    //TODO factor out
-#if defined(__SWITCH__)
-           // see https://switchbrew.github.io/libnx/applet_8h.html#a7ed640e5f4a81ed3960c763fdc1521c5
-           // this checks for some other reasons why this app should quit, its switch specific
-           and appletMainLoop()
-#elif defined(__3DS__)
-           // see https://libctru.devkitpro.org/apt_8h.html#a84808c36d9a8c389896ecf241c7f89cb
-           // this checks for some other reasons why this app should quit, its 3ds specific
-           and aptMainLoop()
+
+#if defined(__CONSOLE__)
+           and console::inMainLoop()
 #endif
 
     ) {
 
-
         m_event_dispatcher.dispatch_pending_events();
         update();
         render();

src/helper/console_helpers.cpp

@@ -0,0 +1,56 @@
+
+#include "helper/errors.hpp"
+#if defined(__NINTENDO_CONSOLE__)
+
+#include "console_helpers.hpp"
+
+#if defined(__SWITCH__)
+#include <switch.h>
+#elif defined(__3DS__)
+#include <3ds.h>
+#endif
+
+void console::debug_write(const char* text, size_t size) {
+#ifdef __3DS__
+    svcOutputDebugString(text, size);
+#elif defined(__SWITCH__)
+    svcOutputDebugString(text, size);
+#else
+#error "not implemented"
+#endif
+}
+
+void console::platform_init() {
+#if defined(__3DS__) || defined(__SWITCH__)
+    Result ret = romfsInit();
+    if (R_FAILED(ret)) {
+        throw helper::IniInitializationError(fmt::format("romfsInit() failed: {:#2x}", (unsigned int) ret));
+    }
+#else
+#error "not implemented"
+#endif
+}
+
+void console::platform_exit() {
+#if defined(__3DS__) || defined(__SWITCH__)
+    Result ret = romfsExit();
+    if (R_FAILED(ret)) {
+        throw helper::IniInitializationError(fmt::format("romfsExit() failed: {:#2x}", (unsigned int) ret));
+    }
+#else
+#error "not implemented"
+#endif
+}
+
+bool console::inMainLoop() {
+#ifdef __3DS__
+    return aptMainLoop();
+#elif defined(__SWITCH__)
+    return appletMainLoop();
+#else
+#error "not implemented"
+#endif
+}
+
+
+#endif

src/helper/console_helpers.hpp

@@ -0,0 +1,55 @@
+
+
+#pragma once
+
+#if defined(__CONSOLE__)
+
+namespace console {
+
+    void debug_write(const char* text, size_t size);
+
+    inline void debug_print(const char* text) {
+        debug_write(text, strlen(text));
+    }
+
+    inline void debug_print(const std::string& value) {
+        debug_write(value.c_str(), value.size());
+    }
+
+    void platform_init();
+
+    void platform_exit();
+
+    [[nodiscard]] bool inMainLoop();
+
+
+    template<typename Mutex>
+    class debug_sink final : public base_sink<Mutex> {
+    public:
+        explicit debug_sink() { }
+        debug_sink(const debug_sink&) = delete;
+        debug_sink& operator=(const debug_sink&) = delete;
+
+    protected:
+        void sink_it_(const details::log_msg& msg) override {
+            memory_buf_t formatted;
+            base_sink<Mutex>::formatter_->format(msg, formatted);
+            debug_write(formatted.data(), static_cast<std::streamsize>(formatted.size()));
+        }
+
+        void flush_() override {
+            // noop
+        }
+
+        std::ostream& ostream_;
+        bool force_flush_;
+    };
+
+    using debug_sink_mt = debug_sink<std::mutex>;
+    using debug_sink_st = debug_sink<details::null_mutex>;
+
+
+} // namespace console
+
+
+#endif

src/helper/meson.build

@@ -29,6 +29,8 @@ core_src_files += files(
 graphics_src_files += files(
     'clock_source.cpp',
     'clock_source.hpp',
+    'console_helpers.cpp',
+    'console_helpers.hpp',
     'graphic_utils.cpp',
     'graphic_utils.hpp',
     'message_box.cpp',

src/main.cpp

@@ -25,8 +25,10 @@ int main(int argc, char** argv) {
     std::vector<spdlog::sink_ptr> sinks;
 #if defined(__ANDROID__)
     sinks.push_back(std::make_shared<spdlog::sinks::android_sink_mt>());
+#elif defined(__CONSOLE__)
+    sinks.push_back(std::make_shared<console::debug_sink_mt>());
 #else
-    sinks.push_back(std::make_shared<spdlog::sinks::stdout_sink_st>());
+    sinks.push_back(std::make_shared<spdlog::sinks::stdout_sink_mt>());
 #endif
     sinks.push_back(std::make_shared<spdlog::sinks::rotating_file_sink_mt>(
             fmt::format("{}/oopetris.log", logs_path.string()), 1024 * 1024 * 10, 5, true