Library refactor up to prim

Author: kiwi515

.clang-format

@@ -21,6 +21,12 @@ WhitespaceSensitiveMacros: [
   NW4R_EF_LIST_FOREACH_SAFE,
   EGG_ASSERT,
   EGG_ASSERT_MSG,
+  K_ASM,
+  KOKESHI_BY_PACK,
+  KM_BRANCH_MF,
+  KM_BRANCH,
+  KM_CALL_MF,
+  KM_CALL,
   ASM,
   TRAMPOLINE,
   TRAMPOLINE_EX,

base/symbols_resort.txt

@@ -3636,6 +3636,8 @@ AppendDrawObject__13RPGrpRendererFP16IRPGrpDrawObject=0x80253d44
 CreateView2D__13RPGrpRendererFUcP11RPGrpScreen=0x80253e1c
 CorrectView__13RPGrpRendererFv=0x80253d68
 __vt__11RPGrpScreen=0x806b5358
+spInstance__16RPSysSaveDataMgr=0x806f4cc0
+setSaveDisable__16RPSysSaveDataMgrFb=0x802338d4
 
 startSeWithRemote__Q23Sp23SndFUlUl=0x802b735c
 startSe__Q23Sp23SndFUl=0x802b73bc

docs/CONTRIBUTING.md

@@ -444,10 +444,10 @@ Macros can be documented like functions, but also a single-line comment will suf
  * @param major Major version number
  * @param minor Minor version number
  */
-#define K_VERSION(major, minor) ((major << 8) | minor)
+#define K_BIN_VERSION(major, minor) ((major << 8) | minor)
 
 //! Helper for creating version numbers
-#define K_VERSION(major, minor) ((major << 8) | minor)
+#define K_BIN_VERSION(major, minor) ((major << 8) | minor)
 ```
 
 ##### Data

examples/CustomScene.cpp

@@ -78,13 +78,13 @@ class CustomScene : public kiwi::IScene {
 // To make the scene creator aware of your custom scene, you need to construct a
 // scene declaration, or SceneDecl object.
 //
-// To simplify construction, libkiwi provides the K_SCENE_DECL macro.
+// To simplify construction, libkiwi provides the K_DECL_SCENE macro.
 // Its argument must be the scene's class name.
 //
 // This macro creates a static object, so it must be placed within the .cpp
 // file, not the header file.
 //
-K_SCENE_DECL(CustomScene);
+K_DECL_SCENE(CustomScene);
 
 //=============================================================================
 // Scene change

include/Pack/RPSystem/RPSysScene.h

@@ -28,7 +28,7 @@ class RPSysScene : public EGG::Scene, public IRPGrpDrawObject {
      * @brief Scene type
      * @ws2
      */
-    enum EKind{
+    enum EKind {
         EKind_System = 'SYS_',   //!< RPSysScene
         EKind_Base = 'BASE',     //!< RPSportsBaseScene
         EKind_Game = 'GAME',     //!< RPSportsGameScene
@@ -39,7 +39,7 @@ class RPSysScene : public EGG::Scene, public IRPGrpDrawObject {
      * @brief Island time
      * @ws2
      */
-    enum ETime{
+    enum ETime {
         ETime_Day,     //!< Force daytime
         ETime_Evening, //!< Force evening
         ETime_Night,   //!< Force night
@@ -177,7 +177,7 @@ class RPSysScene : public EGG::Scene, public IRPGrpDrawObject {
      * @brief Updates the scene's MotionPlus state
      * @ws2
      */
-    virtual void CalculateMotionPlus() {}
+    virtual void CalculateMPlus() {}
 #endif
 
     /**

include/egg/core/eggExpHeap.h

@@ -16,8 +16,8 @@ struct ExpHeap : Heap {
     virtual u32 getAllocatableSize(s32);         // at 0x24
     virtual u32 adjust();                        // at 0x28
 
-    static ExpHeap* create(void*, u32, u16);
-    static ExpHeap* create(u32, Heap*, u16);
+    static ExpHeap* create(void*, u32, u16 = 0);
+    static ExpHeap* create(u32, Heap*, u16 = 0);
 };
 } // namespace EGG
 

lib/libkiwi/core/kiwiColor.h

@@ -11,7 +11,7 @@ namespace kiwi {
 /**
  * @brief RGBA/YUV color
  */
-class Color {
+class Color : public nw4r::ut::Color {
 public:
     /**
      * @brief Constructor
@@ -29,48 +29,51 @@ class Color {
      * @param b Blue component
      * @param a Alpha component
      */
-    Color(u8 r, u8 g, u8 b, u8 a) : r(r), g(g), b(b), a(a) {}
+    Color(u8 _r, u8 _g, u8 _b, u8 _a) {
+        r = _r;
+        g = _g;
+        b = _b;
+        a = _a;
+    }
 
     /**
      * @brief Constructor
      *
      * @param color RGBA32 color
      */
-    Color(u32 color)
-        : r(color >> 24 & 0xFF),
-          g(color >> 16 & 0xFF),
-          b(color >> 8 & 0xFF),
-          a(color >> 0 & 0xFF) {}
+    Color(u32 color) {
+        r = color >> 24 & 0xFF;
+        g = color >> 16 & 0xFF;
+        b = color >> 8 & 0xFF;
+        a = color >> 0 & 0xFF;
+    }
 
     /**
-     * @brief Converts RGB color to YUV format
+     * @brief Implicit conversion operator (RGBA order)
      */
-    Color Yuv() const;
+    operator u32() const {
+        return Rgba32();
+    }
 
     /**
-     * @brief Converts color to u32 (RGBA order)
+     * @brief Converts color to u32 representation (RGBA order)
      */
     u32 Rgba32() const {
         return r << 24 | g << 16 | b << 8 | a;
     }
     /**
-     * @brief Converts color to u32 (ARGB order)
+     * @brief Converts color to u32 representation (ARGB order)
      */
     u32 Argb32() const {
         return a << 24 | r << 16 | g << 8 | b;
     }
 
-    // clang-format off
-    operator             u32() const { return Rgba32(); }                  //!< Implicitly convert to u32 (RGBA order)
-    operator nw4r::ut::Color() const { return nw4r::ut::Color(Rgba32()); } //!< Implicitly convert to NW4R color
-    // clang-format on
+    /**
+     * @brief Converts RGB color to YUV format
+     */
+    Color Yuv() const;
 
 public:
-    u8 r; //!< Red component
-    u8 g; //!< Green component
-    u8 b; //!< Blue component
-    u8 a; //!< Alpha component
-
     /**
      * @name Preset Colors
      */

lib/libkiwi/core/kiwiConsoleOut.h

@@ -12,31 +12,66 @@ namespace detail {
 //! @addtogroup libkiwi_core
 //! @{
 
+struct Hex {};
+struct Dec {};
+
 /**
  * @brief Console text output stream
  * @see kiwi::cout
  */
 class ConsoleOut : private NonCopyable {
 public:
+    /**
+     * @brief Constructor
+     */
+    ConsoleOut() : mHexFormat(false) {}
+
     /**
      * @brief Logs output to the console
      *
      * @param rValue Value (converted to string)
+     * @return Self for method chaining
      */
     template <typename T> const ConsoleOut& operator<<(const T& rValue) const {
-        K_LOG(ToString(rValue));
+        K_LOG(mHexFormat ? ToHexString(rValue) : ToString(rValue));
+        return *this;
+    }
+
+    /**
+     * @brief Applies decimal formatting to the stream (default)
+     * @return Self for method chaining
+     */
+    ConsoleOut& operator<<(Dec) {
+        mHexFormat = false;
+        return *this;
+    }
+    /**
+     * @brief Applies hexadecimal formatting to the stream
+     * @return Self for method chaining
+     */
+    ConsoleOut& operator<<(Hex) {
+        mHexFormat = true;
         return *this;
     }
+
+private:
+    bool mHexFormat; //!< Whether to display values as hex
 };
 
 //! @}
 } // namespace detail
 
 //! Global console handle
 extern const detail::ConsoleOut cout;
+
 //! Newline character
 static const char endl = '\n';
 
+//! Decimal display modifier (default)
+static const detail::Dec dec = detail::Dec();
+//! Hexadecimal display modifier
+static const detail::Hex hex = detail::Hex();
+
 //! @}
 } // namespace kiwi
 

lib/libkiwi/core/kiwiController.cpp

@@ -1,9 +1,45 @@
-#include <revolution/KPAD.h>
-
 #include <libkiwi.h>
 
+#include <revolution/KPAD.h>
+
 namespace kiwi {
 
+/******************************************************************************
+ *
+ * WiiCtrl
+ *
+ ******************************************************************************/
+
+/**
+ * @brief Tests whether specific buttons were held down last frame
+ *
+ * @param buttons Button mask
+ */
+bool WiiCtrl::IsHold(u32 buttons) const {
+    u32 mask = ConvertMask(buttons);
+    return (GetStatus().hold & mask) == mask;
+}
+
+/**
+ * @brief Tests whether specific buttons were released last frame
+ *
+ * @param buttons Button mask
+ */
+bool WiiCtrl::IsRelease(u32 buttons) const {
+    u32 mask = ConvertMask(buttons);
+    return (GetStatus().release & mask) == mask;
+}
+
+/**
+ * @brief Tests whether specific buttons were triggered (pressed) last frame
+ *
+ * @param buttons Button mask
+ */
+bool WiiCtrl::IsTrig(u32 buttons) const {
+    u32 mask = ConvertMask(buttons);
+    return (GetStatus().trig & mask) == mask;
+}
+
 /**
  * @brief Converts generic (EButton) mask to button mask for KPAD
  *
@@ -29,7 +65,7 @@ u32 WiiCtrl::ConvertMask(u32 mask) {
 
     u32 conv = 0;
 
-    for (int i = 0; i < LENGTHOF(table); i++) {
+    for (int i = 0; i < K_LENGTHOF(table); i++) {
         if (mask & table[i][0]) {
             conv |= table[i][1];
         }
@@ -38,48 +74,24 @@ u32 WiiCtrl::ConvertMask(u32 mask) {
     return conv;
 }
 
-/**
- * @brief Tests whether specific buttons were held down last frame
- *
- * @param buttons Button mask
- */
-bool WiiCtrl::IsHold(u32 buttons) const {
-    u32 mask = ConvertMask(buttons);
-    return (GetStatus().hold & mask) == mask;
-}
-
-/**
- * @brief Tests whether specific buttons were released last frame
+/******************************************************************************
  *
- * @param buttons Button mask
- */
-bool WiiCtrl::IsRelease(u32 buttons) const {
-    u32 mask = ConvertMask(buttons);
-    return (GetStatus().release & mask) == mask;
-}
-
-/**
- * @brief Tests whether specific buttons were triggered (pressed) last frame
+ * CtrlMgr
  *
- * @param buttons Button mask
- */
-bool WiiCtrl::IsTrig(u32 buttons) const {
-    u32 mask = ConvertMask(buttons);
-    return (GetStatus().trig & mask) == mask;
-}
+ ******************************************************************************/
 
 /**
  * @brief Gets Wii Remote controller by player index
  *
  * @param i Player index
  */
-const WiiCtrl& CtrlMgr::GetWiiCtrl(EPlayer i) {
+const WiiCtrl& CtrlMgr::GetWiiCtrl(int i) {
     K_ASSERT(i < EPlayer_Max);
 
-    EGG::CoreController* pBase = getNthController(i);
-    K_ASSERT(pBase != nullptr);
+    const EGG::CoreController* pBase = getNthController(i);
+    K_ASSERT_PTR(pBase);
 
-    return *reinterpret_cast<WiiCtrl*>(pBase);
+    return *reinterpret_cast<const WiiCtrl*>(pBase);
 }
 
 } // namespace kiwi

lib/libkiwi/core/kiwiController.h

@@ -1,9 +1,10 @@
 #ifndef LIBKIWI_CORE_CONTROLLER_H
 #define LIBKIWI_CORE_CONTROLLER_H
-#include <egg/core.h>
 #include <libkiwi/k_types.h>
 #include <libkiwi/util/kiwiExtension.h>
 
+#include <egg/core.h>
+
 namespace kiwi {
 //! @addtogroup libkiwi_core
 //! @{
@@ -82,7 +83,7 @@ class WiiCtrl : public Extension<EGG::CoreController> {
      * @brief Gets KPAD data (read-only)
      */
     const KPADStatus& GetStatus() const {
-        return *reinterpret_cast<KPADStatus*>(getCoreStatus(0));
+        return *reinterpret_cast<KPADStatus*>(getCoreStatus());
     }
 };
 
@@ -97,7 +98,7 @@ class CtrlMgr : public ExtSingletonPtr<EGG::CoreControllerMgr, CtrlMgr> {
      *
      * @param i Player index
      */
-    const WiiCtrl& GetWiiCtrl(EPlayer i);
+    const WiiCtrl& GetWiiCtrl(int i);
 };
 
 //! @}