Merge branch 'main' of https://github.com/PackProject/APClient

Author: plyd823

include/__doxygen.hpp

@@ -338,6 +338,10 @@
 //! @defgroup libkiwi_core core
 //! @brief Core system
 
+//! @ingroup libkiwi
+//! @defgroup libkiwi_crypt crypt
+//! @brief Cryptography
+
 //! @ingroup libkiwi
 //! @defgroup libkiwi_debug debug
 //! @brief Debugging

lib/libkiwi/debug/kiwiDebugMenu.cpp

@@ -0,0 +1,7 @@
+#include <libkiwi.h>
+
+namespace kiwi {
+
+;
+
+} // namespace kiwi

lib/libkiwi/debug/kiwiDebugMenu.h

@@ -0,0 +1,70 @@
+#ifndef LIBKIWI_DEBUG_DEBUG_MENU_H
+#define LIBKIWI_DEBUG_DEBUG_MENU_H
+#include <Pack/RPGraphics.h>
+#include <libkiwi/k_types.h>
+#include <libkiwi/prim/kiwiVector.h>
+
+namespace kiwi {
+//! @addtogroup libkiwi_debug
+//! @{
+
+// Forward declarations
+class DebugOptionBase;
+
+/**
+ * @brief Debug menu
+ */
+class DebugMenu : public IRPGrpDrawObject {
+public:
+    /**
+     * @brief Option action result
+     */
+    enum EResult {
+        EResult_None,    //!< Nothing happened
+        EResult_Invalid, //!< State failed to change
+        EResult_Change,  //!< State changed
+        EResult_Close,   //!< Request to close menu
+    };
+
+public:
+    /**
+     * @brief Constructor
+     */
+    DebugMenu() : mCursor(0) {}
+    /**
+     * @brief Destructor
+     */
+    virtual ~DebugMenu() {
+        mOptions.Clear();
+    }
+
+    /**
+     * @brief Updates the menu state
+     */
+    virtual void Calculate();
+    /**
+     * @brief User-level render pass
+     */
+    virtual void UserDraw();
+
+    /**
+     * @brief Updates the menu state (for sub-classes)
+     */
+    virtual void OnCalculate() {}
+    /**
+     * @brief Render pass (for sub-classes)
+     */
+    virtual void OnUserDraw() {}
+
+protected:
+    //! Cursor position
+    u32 mCursor;
+
+    //! Option list
+    TVector<DebugOptionBase*> mOptions;
+};
+
+//! @}
+} // namespace kiwi
+
+#endif

lib/libkiwi/debug/kiwiDebugOption.cpp

@@ -0,0 +1,216 @@
+#include <libkiwi.h>
+
+namespace kiwi {
+
+/******************************************************************************
+ *
+ * DebugOptionBase
+ *
+ ******************************************************************************/
+
+/**
+ * @brief Sets whether the option is enabled
+ *
+ * @param enable Enable status
+ */
+void DebugOptionBase::SetEnabled(bool enable) {
+    mIsEnabled = enable;
+    UpdateString();
+}
+
+/******************************************************************************
+ *
+ * DebugIntOption
+ *
+ ******************************************************************************/
+
+/**
+ * @brief Constructor
+ *
+ * @param rName Option name
+ * @param min Minimum value (inclusive)
+ * @param max Maximum value (inclusive)
+ * @param initial Initial value (optional)
+ */
+DebugIntOption::DebugIntOption(const String& rName, int min, int max,
+                               Optional<int> initial)
+    : DebugOptionBase(rName), mMin(min), mMax(max) {
+
+    K_ASSERT(max >= min);
+
+    // Initial value defaults to minimum
+    SetValue(initial ? *initial : min);
+}
+
+/**
+ * @brief Increments the option value
+ * @return Action result
+ */
+DebugMenu::EResult DebugIntOption::Increment() {
+    if (!IsEnabled()) {
+        return DebugMenu::EResult_Invalid;
+    }
+
+    // Value wraps around
+    SetValue(mValue == mMax ? mMin : mValue + 1);
+    return DebugMenu::EResult_Change;
+}
+
+/**
+ * @brief Decrements the option value
+ * @return Action result
+ */
+DebugMenu::EResult DebugIntOption::Decrement() {
+    if (!IsEnabled()) {
+        return DebugMenu::EResult_Invalid;
+    }
+
+    // Value wraps around
+    SetValue(mValue == mMin ? mMax : mValue - 1);
+    return DebugMenu::EResult_Change;
+}
+
+/**
+ * @brief Sets the maximum value (inclusive)
+ * @details The current option value is validated upon range changes.
+ *
+ * @param max New maximum value (inclusive)
+ */
+void DebugIntOption::SetMax(int max) {
+    K_ASSERT(max >= mMin);
+
+    mMax = max;
+    Validate();
+}
+
+/**
+ * @brief Sets the minimum value (inclusive)
+ * @details The current option value is validated upon range changes.
+ *
+ * @param min New minimum value (inclusive)
+ */
+void DebugIntOption::SetMin(int min) {
+    K_ASSERT(min <= mMax);
+
+    mMin = min;
+    Validate();
+}
+
+/**
+ * @brief Sets the range (inclusive) of acceptable values
+ * @details The current option value is validated upon range changes.
+ *
+ * @param min New minimum value (inclusive)
+ * @param max New maximum value (inclusive)
+ */
+void DebugIntOption::SetRange(int min, int max) {
+    K_ASSERT(max >= min);
+
+    mMin = min;
+    mMax = max;
+    Validate();
+}
+
+/**
+ * @brief Validates the option value
+ */
+void DebugIntOption::Validate() {
+    if (mValue > mMax) {
+        SetValue(mMax);
+    } else if (mValue < mMin) {
+        SetValue(mMin);
+    }
+}
+
+/**
+ * @brief Updates the option value string
+ */
+void DebugIntOption::UpdateString() {
+    if (IsEnabled()) {
+        mValueText = kiwi::ToString(mValue);
+    } else {
+        mValueText = "DISABLED";
+    }
+}
+
+/**
+ * @brief Sets the integer option value
+ *
+ * @param value New value
+ */
+void DebugIntOption::SetValue(int value) {
+    mValue = Clamp(mValue, mMin, mMax);
+    UpdateString();
+}
+
+/******************************************************************************
+ *
+ * DebugBoolOption
+ *
+ ******************************************************************************/
+
+/**
+ * @brief Updates the option value string
+ */
+void DebugBoolOption::UpdateString() {
+    if (IsEnabled()) {
+        mValueText = GetValue() ? "True" : "False";
+    } else {
+        mValueText = "DISABLED";
+    }
+}
+
+/******************************************************************************
+ *
+ * DebugEnumOption
+ *
+ ******************************************************************************/
+
+/**
+ * @brief Sets the option enum value strings
+ *
+ * @param ppValues Enum value strings
+ */
+void DebugEnumOption::SetEnumValues(const char** ppValues) {
+    K_ASSERT(ppValues != nullptr);
+
+    mppValues = ppValues;
+    UpdateString();
+}
+
+/**
+ * @brief Updates the option value string
+ */
+void DebugEnumOption::UpdateString() {
+    K_ASSERT(mppValues != nullptr);
+
+    if (IsEnabled()) {
+        mValueText = mppValues[GetValue()];
+    } else {
+        mValueText = "DISABLED";
+    }
+}
+
+/******************************************************************************
+ *
+ * DebugProcOption
+ *
+ ******************************************************************************/
+
+/**
+ * @brief Performs the option selection logic
+ * @return Action result
+ */
+DebugMenu::EResult DebugProcOption::Select() {
+    if (!IsEnabled()) {
+        return DebugMenu::EResult_Invalid;
+    }
+
+    if (mpCallback != nullptr) {
+        return mpCallback(mpCallbackArg);
+    }
+
+    return DebugMenu::EResult_None;
+}
+
+} // namespace kiwi