Change up to prim

Author: kiwi515

Doxyfile

@@ -113,7 +113,7 @@ EXTRACT_PRIVATE        = YES
 # methods of a class will be included in the documentation.
 # The default value is: NO.
 
-# KOKESHI: Many interfaces like StreamBase have private virtual functions that are
+# KOKESHI: Many interfaces like IStream have private virtual functions that are
 #          intended to be overriden by the user, so their documentation should be visible.
 EXTRACT_PRIV_VIRTUAL   = YES
 

docs/CONTRIBUTING.md

@@ -470,12 +470,12 @@ The brief description for constructors should be "Constructor", and the brief de
 /**
  * @brief Constructor
  */
-StreamBase();
+IStream();
 
 /**
  * @brief Destructor
  */
-virtual ~StreamBase();
+virtual ~IStream();
 ```
 
 If there are many constructor overloads for purposes such as moving/copying, feel free to specify the constructor "type" in the Doxygen detailed description:

lib/libkiwi/core/kiwiFileStream.h

@@ -1,6 +1,6 @@
 #ifndef LIBKIWI_CORE_FILE_STREAM_H
 #define LIBKIWI_CORE_FILE_STREAM_H
-#include <libkiwi/core/kiwiStreamBase.h>
+#include <libkiwi/core/kiwiIStream.h>
 #include <libkiwi/k_types.h>
 
 namespace kiwi {
@@ -19,7 +19,7 @@ enum EOpenMode {
 /**
  * @brief Stream to a physical file
  */
-class FileStream : public StreamBase {
+class FileStream : public IStream {
 public:
     /**
      * @brief Constructor

lib/libkiwi/core/kiwiStreamBase.cpp lib/libkiwi/core/kiwiIStream.cpplib/libkiwi/core/kiwiStreamBase.cpp renamed to lib/libkiwi/core/kiwiIStream.cpp

@@ -8,7 +8,7 @@ namespace kiwi {
  * @param dir Seek direction
  * @param offset Seek offset
  */
-void StreamBase::Seek(ESeekDir dir, s32 offset) {
+void IStream::Seek(ESeekDir dir, s32 offset) {
     K_ASSERT_EX(IsOpen(), "Stream is not available");
     K_ASSERT_EX(CanSeek(), "Stream does not support seeking");
 
@@ -25,7 +25,7 @@ void StreamBase::Seek(ESeekDir dir, s32 offset) {
  * @param size Number of bytes to read
  * @return Number of bytes read, or DVD error code
  */
-s32 StreamBase::Read(void* pDst, u32 size) {
+s32 IStream::Read(void* pDst, u32 size) {
     K_ASSERT_PTR(pDst);
 
     K_ASSERT_EX(IsOpen(), "Stream is not available");
@@ -52,7 +52,7 @@ s32 StreamBase::Read(void* pDst, u32 size) {
  * @param size Number of bytes to write
  * @return Number of bytes written, or DVD error code
  */
-s32 StreamBase::Write(const void* pSrc, u32 size) {
+s32 IStream::Write(const void* pSrc, u32 size) {
     K_ASSERT_PTR(pSrc);
 
     K_ASSERT_EX(IsOpen(), "Stream is not available");
@@ -80,7 +80,7 @@ s32 StreamBase::Write(const void* pSrc, u32 size) {
  * @param size Number of bytes to read
  * @return Number of bytes read, or DVD error code
  */
-s32 StreamBase::Peek(void* pDst, u32 size) {
+s32 IStream::Peek(void* pDst, u32 size) {
     K_ASSERT_PTR(pDst);
 
     K_ASSERT_EX(IsOpen(), "Stream is not available");

lib/libkiwi/core/kiwiStreamBase.h lib/libkiwi/core/kiwiIStream.hlib/libkiwi/core/kiwiStreamBase.h renamed to lib/libkiwi/core/kiwiIStream.h

@@ -1,5 +1,5 @@
-#ifndef LIBKIWI_CORE_STREAM_BASE_H
-#define LIBKIWI_CORE_STREAM_BASE_H
+#ifndef LIBKIWI_CORE_I_STREAM_H
+#define LIBKIWI_CORE_I_STREAM_H
 #include <libkiwi/k_types.h>
 #include <libkiwi/prim/kiwiString.h>
 #include <libkiwi/util/kiwiPtrUtil.h>
@@ -18,19 +18,19 @@ enum ESeekDir {
 };
 
 /**
- * @brief Base class for stream types
+ * @brief Stream type interface
  */
-class StreamBase {
+class IStream {
 public:
     /**
      * @brief Constructor
      */
-    StreamBase() : mIsOpen(false), mPosition(0) {}
+    IStream() : mIsOpen(false), mPosition(0) {}
 
     /**
      * @brief Destructor
      */
-    virtual ~StreamBase() {
+    virtual ~IStream() {
         K_ASSERT_EX(!IsOpen(), "Your class forgot to close the stream!");
     }
 

lib/libkiwi/core/kiwiSceneHookMgr.cpp

@@ -36,7 +36,7 @@ bool IsCurrentPackScene() {
 /**
  * @brief Gets the list of active hooks for the current scene
  */
-TList<SceneHookBase>& SceneHookMgr::GetSceneHooks() {
+TList<ISceneHook>& SceneHookMgr::GetSceneHooks() {
     K_ASSERT_EX(IsCurrentPackScene(), "Only game scenes have hooks");
     s32 id = RP_GET_INSTANCE(RPSysSceneMgr)->getCurrentSceneID();
     return mSceneHookLists[id];
@@ -47,7 +47,7 @@ TList<SceneHookBase>& SceneHookMgr::GetSceneHooks() {
  *
  * @param rHook Scene hook
  */
-void SceneHookMgr::AddHook(SceneHookBase& rHook) {
+void SceneHookMgr::AddHook(ISceneHook& rHook) {
     if (rHook.mSceneID == -1) {
         mGlobalHooks.PushBack(&rHook);
     } else {
@@ -60,7 +60,7 @@ void SceneHookMgr::AddHook(SceneHookBase& rHook) {
  *
  * @param rHook Scene hook
  */
-void SceneHookMgr::RemoveHook(const SceneHookBase& rHook) {
+void SceneHookMgr::RemoveHook(const ISceneHook& rHook) {
     if (rHook.mSceneID == -1) {
         mGlobalHooks.Remove(&rHook);
     } else {

lib/libkiwi/core/kiwiSceneHookMgr.h

@@ -12,7 +12,7 @@ namespace kiwi {
 //! @{
 
 // Forward declarations
-class SceneHookBase;
+class ISceneHook;
 
 /**
  * @brief Scene hook manager
@@ -26,13 +26,13 @@ class SceneHookMgr : public StaticSingleton<SceneHookMgr> {
      *
      * @param rHook Scene hook
      */
-    void AddHook(SceneHookBase& rHook);
+    void AddHook(ISceneHook& rHook);
     /**
      * @brief Unregisters an existing hook
      *
      * @param rHook Scene hook
      */
-    void RemoveHook(const SceneHookBase& rHook);
+    void RemoveHook(const ISceneHook& rHook);
 
 private:
     LIBKIWI_KAMEK_PUBLIC
@@ -71,19 +71,19 @@ class SceneHookMgr : public StaticSingleton<SceneHookMgr> {
     /**
      * @brief Gets the list of active hooks for the current scene
      */
-    TList<SceneHookBase>& GetSceneHooks();
+    TList<ISceneHook>& GetSceneHooks();
 
 private:
     //! Lists of scene hooks
-    TArray<TList<SceneHookBase>, ESceneID_Max> mSceneHookLists;
+    TArray<TList<ISceneHook>, ESceneID_Max> mSceneHookLists;
     //! Global hooks (always active)
-    TList<SceneHookBase> mGlobalHooks;
+    TList<ISceneHook> mGlobalHooks;
 };
 
 /**
- * @brief Base class for scene hooks
+ * @brief Scene hook interface
  */
-class SceneHookBase {
+class ISceneHook {
     friend class SceneHookMgr;
 
 public:
@@ -93,7 +93,7 @@ class SceneHookBase {
      *
      * @param id Scene ID (-1 for all scenes)
      */
-    explicit SceneHookBase(s32 id = -1) : mSceneID(id) {
+    explicit ISceneHook(s32 id = -1) : mSceneID(id) {
         K_ASSERT_EX(id == -1 || id < ESceneID_Max,
                     "Only RP scene IDs and -1 (all scenes) are supported");
 
@@ -102,7 +102,7 @@ class SceneHookBase {
     /**
      * @brief Destructor
      */
-    virtual ~SceneHookBase() {
+    virtual ~ISceneHook() {
         SceneHookMgr::GetInstance().RemoveHook(*this);
     }
 

lib/libkiwi/fun/kiwiGameCorruptor.h

@@ -19,10 +19,10 @@ enum ECorruptDomain {
     ECorruptDomain_DolCode = (1 << 0), //!< Corrupt DOL code sections
     ECorruptDomain_DolData = (1 << 1), //!< Corrupt DOL data sections
 
-    ECorruptDomain_Mem1 = (1 << 2), // Corrupt MEM1 region of RAM
-    ECorruptDomain_Mem2 = (1 << 3), // Corrupt MEM2 region of RAM
+    ECorruptDomain_Mem1 = (1 << 2), //!< Corrupt MEM1 region of RAM
+    ECorruptDomain_Mem2 = (1 << 3), //!< Corrupt MEM2 region of RAM
 
-    ECorruptDomain_Scene = (1 << 4), // Corrupt the current scene's memory
+    ECorruptDomain_Scene = (1 << 4), //!< Corrupt the current scene's memory
 };
 
 /**

lib/libkiwi/libkiwi.h

@@ -1,5 +1,5 @@
-#ifndef LIBKIWI_H
-#define LIBKIWI_H
+#ifndef LIBKIWI_LIBRARY_H
+#define LIBKIWI_LIBRARY_H
 
 #include <libkiwi/core/kiwiColor.h>
 #include <libkiwi/core/kiwiConsoleOut.h>
@@ -8,6 +8,7 @@
 #include <libkiwi/core/kiwiFileRipper.h>
 #include <libkiwi/core/kiwiIBinary.h>
 #include <libkiwi/core/kiwiIScene.h>
+#include <libkiwi/core/kiwiIStream.h>
 #include <libkiwi/core/kiwiJSON.h>
 #include <libkiwi/core/kiwiMemStream.h>
 #include <libkiwi/core/kiwiMemoryMgr.h>
@@ -16,7 +17,6 @@
 #include <libkiwi/core/kiwiSPR.h>
 #include <libkiwi/core/kiwiSceneCreator.h>
 #include <libkiwi/core/kiwiSceneHookMgr.h>
-#include <libkiwi/core/kiwiStreamBase.h>
 #include <libkiwi/core/kiwiThread.h>
 #include <libkiwi/crypt/kiwiBase64.h>
 #include <libkiwi/crypt/kiwiChecksum.h>

lib/libkiwi/net/kiwiAsyncSocket.cpp

@@ -43,8 +43,9 @@ class AsyncSocket::RecvJob {
           mpPeer(pPeer),
           mpCallback(pCallback),
           mpArg(pArg) {
-        K_ASSERT(mpPacket != nullptr);
-        K_ASSERT(mpDst != nullptr);
+
+        K_ASSERT_PTR(mpPacket);
+        K_ASSERT_PTR(mpDst);
         K_ASSERT(OSIsMEM2Region(mpDst));
     }
 
@@ -59,7 +60,7 @@ class AsyncSocket::RecvJob {
      * @brief Tests whether the receive operation is complete
      */
     bool IsComplete() const {
-        K_ASSERT(mpPacket != nullptr);
+        K_ASSERT_PTR(mpPacket);
         return mpPacket->IsWriteComplete();
     }
 
@@ -70,7 +71,7 @@ class AsyncSocket::RecvJob {
      * @return Whether the job is complete
      */
     bool Calc(SOSocket socket) {
-        K_ASSERT(mpPacket != nullptr);
+        K_ASSERT_PTR(mpPacket);
         K_ASSERT(socket >= 0);
 
         // Nothing left to do
@@ -84,7 +85,7 @@ class AsyncSocket::RecvJob {
 
         // Write out data
         if (done) {
-            K_ASSERT(mpDst != nullptr);
+            K_ASSERT_PTR(mpDst);
             K_ASSERT(OSIsMEM2Region(mpDst));
 
             std::memcpy(mpDst, mpPacket->GetContent(),
@@ -127,7 +128,8 @@ class AsyncSocket::SendJob {
      */
     SendJob(Packet* pPacket, Callback pCallback = nullptr, void* pArg = nullptr)
         : mpPacket(pPacket), mpCallback(pCallback), mpArg(pArg) {
-        K_ASSERT(mpPacket != nullptr);
+
+        K_ASSERT_PTR(mpPacket);
     }
 
     /**
@@ -141,7 +143,7 @@ class AsyncSocket::SendJob {
      * @brief Tests whether the send operation is complete
      */
     bool IsComplete() const {
-        K_ASSERT(mpPacket != nullptr);
+        K_ASSERT_PTR(mpPacket);
         return mpPacket->IsReadComplete();
     }
 
@@ -152,7 +154,7 @@ class AsyncSocket::SendJob {
      * @return Whether the job is complete
      */
     bool Calc(SOSocket socket) {
-        K_ASSERT(mpPacket != nullptr);
+        K_ASSERT_PTR(mpPacket);
         K_ASSERT(socket >= 0);
 
         // Nothing left to do
@@ -336,7 +338,7 @@ void AsyncSocket::Calc() {
             // Result code is the peer descriptor
             if (result >= 0) {
                 pSocket = new AsyncSocket(result, mFamily, mType);
-                K_ASSERT(pSocket != nullptr);
+                K_ASSERT_PTR(pSocket);
             }
 
             mState = EState_Thinking;
@@ -408,16 +410,16 @@ SOResult AsyncSocket::RecvImpl(void* pDst, u32 len, u32& rRecv,
                                SockAddrAny* pAddr, Callback pCallback,
                                void* pArg) {
     K_ASSERT(IsOpen());
-    K_ASSERT(pDst != nullptr);
+    K_ASSERT_PTR(pDst);
     K_ASSERT(OSIsMEM2Region(pDst));
 
     // Packet to hold incoming data
     Packet* pPacket = new Packet(len);
-    K_ASSERT(pPacket != nullptr);
+    K_ASSERT_PTR(pPacket);
 
     // Asynchronous job
     RecvJob* pJob = new RecvJob(pPacket, pDst, pAddr, pCallback, pArg);
-    K_ASSERT(pJob != nullptr);
+    K_ASSERT_PTR(pJob);
     mRecvJobs.PushBack(pJob);
 
     // Receive doesn't actually happen on this thread
@@ -440,19 +442,19 @@ SOResult AsyncSocket::SendImpl(const void* pSrc, u32 len, u32& rSend,
                                const SockAddrAny* pAddr, Callback pCallback,
                                void* pArg) {
     K_ASSERT(IsOpen());
-    K_ASSERT(pSrc != nullptr);
+    K_ASSERT_PTR(pSrc);
     K_ASSERT(OSIsMEM2Region(pSrc));
 
     // Packet to hold incoming data
     Packet* pPacket = new Packet(len, pAddr);
-    K_ASSERT(pPacket != nullptr);
+    K_ASSERT_PTR(pPacket);
 
     // Store data inside packet
     pPacket->Write(pSrc, len);
 
     // Asynchronous job
     SendJob* pJob = new SendJob(pPacket, pCallback, pArg);
-    K_ASSERT(pJob != nullptr);
+    K_ASSERT_PTR(pJob);
     mSendJobs.PushBack(pJob);
 
     // Send doesn't actually happen on this thread