Refactor the ArrayQueue, rename [Push] to [Enqueue] and [Pop] to [Dequeue].

scottcgi · scottcgi · commit f9e5e502d9ac · 2021-08-18T10:48:50.000+08:00
diff --git a/ChangeLog.md b/ChangeLog.md
@@ -1,9 +1,12 @@
-## Developing
+## v0.7.0
+
+_`2021.8.18 UTC+8 10:42`_
 
 * Fix case spelling error in `ArrayList.c`.
 * Update the `Vibrator` API of Android.
 * Add the `Smooth` function and Set the `Smooth` as the default ease.
 * Optimize the `Tween` implementation by remove the `queueAction`.
+* Refactor the `ArrayQueue`, rename `Push` to `Enqueue` and `Pop` to `Dequeue`. **(Break Compatibility)**
 
 
 ## v0.6.4
diff --git a/Engine/Graphics/OpenGL/Mesh.c b/Engine/Graphics/OpenGL/Mesh.c
@@ -268,14 +268,14 @@ static void Render(Drawable* drawable)
         fromChild = AArrayList_Get
                     (
                         mesh->childList,
-                        AArrayQueue_PopWithDefault(mesh->drawRangeQueue, int, mesh->fromIndex),
+                        AArrayQueue_DequeueWithDefault(mesh->drawRangeQueue, int, mesh->fromIndex),
                         SubMesh*
                     );
 
         toChild   = AArrayList_Get
                     (
                         mesh->childList,
-                        AArrayQueue_PopWithDefault(mesh->drawRangeQueue, int, mesh->toIndex),
+                        AArrayQueue_DequeueWithDefault(mesh->drawRangeQueue, int, mesh->toIndex),
                         SubMesh*
                     );
     }
diff --git a/Engine/Graphics/OpenGL/Mesh.h b/Engine/Graphics/OpenGL/Mesh.h
@@ -272,8 +272,8 @@ static inline void AMesh_Draw(Mesh* mesh)
  */
 static inline void AMesh_DrawByIndex(Mesh* mesh, int fromIndex, int toIndex)
 {
-    AArrayQueue_Push(mesh->drawRangeQueue, fromIndex);
-    AArrayQueue_Push(mesh->drawRangeQueue, toIndex);
+    AArrayQueue_Enqueue(mesh->drawRangeQueue, fromIndex);
+    AArrayQueue_Enqueue(mesh->drawRangeQueue, toIndex);
     ADrawable->Draw (mesh->drawable);
 }
 
diff --git a/Engine/Toolkit/Utils/ArrayQueue.c b/Engine/Toolkit/Utils/ArrayQueue.c
@@ -19,38 +19,38 @@
 #include "Engine/Toolkit/Platform/Log.h"
 
 
-static void* Push(ArrayQueue* arrayQueue, void* elementPtr)
+static void* Enqueue(ArrayQueue* arrayQueue, void* elementPtr)
 {
-    if (arrayQueue->topIndex > 0 && arrayQueue->topIndex == arrayQueue->elementList->elementArr->length)
+    if (arrayQueue->headIndex > 0 && arrayQueue->headIndex == arrayQueue->elementList->elementArr->length)
     {
-        AArrayList->RemoveRange(arrayQueue->elementList, 0, arrayQueue->topIndex - 1);
-        arrayQueue->topIndex = 0;
+        AArrayList->RemoveRange(arrayQueue->elementList, 0, arrayQueue->headIndex - 1);
+        arrayQueue->headIndex = 0;
     }
 
     return AArrayList->Add(arrayQueue->elementList, elementPtr);
 }
 
 
-static void* Pop(ArrayQueue* arrayQueue, void* defaultElementPtr)
+static void* Dequeue(ArrayQueue* arrayQueue, void* defaultElementPtr)
 {
-    if (arrayQueue->topIndex == arrayQueue->elementList->size)
+    if (arrayQueue->headIndex == arrayQueue->elementList->size)
     {
         return defaultElementPtr;
     }
 
     return (char*) arrayQueue->elementList->elementArr->data +
                    arrayQueue->elementList->elementTypeSize  *
-                   (arrayQueue->topIndex++);
+                   (arrayQueue->headIndex++);
 }
 
 
 static void RemoveAt(ArrayQueue* arrayQueue, int index)
 {
     ALog_A
     (
-        index >= arrayQueue->topIndex && index < arrayQueue->elementList->size,
+        index >= arrayQueue->headIndex && index < arrayQueue->elementList->size,
         "AArrayQueue RemoveAt index = %d, out of range [%d, %d]",
-        index, arrayQueue->topIndex, arrayQueue->elementList->size - 1
+        index, arrayQueue->headIndex, arrayQueue->elementList->size - 1
     );
 
     AArrayList->Remove(arrayQueue->elementList, index);
@@ -59,7 +59,7 @@ static void RemoveAt(ArrayQueue* arrayQueue, int index)
 
 static void Release(ArrayQueue* arrayQueue)
 {
-    arrayQueue->topIndex = 0;
+    arrayQueue->headIndex = 0;
     AArrayList->Release(arrayQueue->elementList);
 }
 
@@ -75,7 +75,7 @@ static void InitWithCapacity(int elementTypeSize, int capacity, ArrayQueue* outA
         AArrayList->InitWithCapacity(elementTypeSize, capacity, outArrayQueue->elementList);
     }
 
-    outArrayQueue->topIndex = 0;
+    outArrayQueue->headIndex = 0;
 }
 
 
@@ -102,7 +102,7 @@ static ArrayQueue* Create(int elementTypeSize)
 
 static void Clear(ArrayQueue* arrayQueue)
 {
-    arrayQueue->topIndex = 0;
+    arrayQueue->headIndex = 0;
     AArrayList->Clear(arrayQueue->elementList);
 }
 
@@ -115,8 +115,8 @@ struct AArrayQueue AArrayQueue[1] =
     InitWithCapacity,
     Release,
 
-    Push,
-    Pop,
+    Enqueue,
+    Dequeue,
     RemoveAt,
     Clear,
 }};
diff --git a/Engine/Toolkit/Utils/ArrayQueue.h b/Engine/Toolkit/Utils/ArrayQueue.h
@@ -27,9 +27,9 @@
 typedef struct
 {
     /**
-     * ArrayQueue top element index.
+     * ArrayQueue head element index.
      */
-    int       topIndex;
+    int       headIndex;
 
     /**
      * Store all elements.
@@ -53,26 +53,26 @@ struct AArrayQueue
     void        (*Release)           (ArrayQueue* arrayQueue);
 
     /**
-     * Push the element from elementPtr to the tail of ArrayQueue.
+     * Add the element from elementPtr to the tail of ArrayQueue.
      * elementPtr: point to element
      *
      * return the elementPtr in ArrayQueue.
      */
-    void*       (*Push)              (ArrayQueue* arrayQueue, void* elementPtr);
+    void*       (*Enqueue)           (ArrayQueue* arrayQueue, void* elementPtr);
 
     /**
-     * Pop the element from the head of ArrayQueue.
-     * return the top elementPtr of the ArrayQueue, if no element return defaultElementPtr.
+     * Remove the element from the head of ArrayQueue.
+     * return the head elementPtr of the ArrayQueue, if no element return defaultElementPtr.
      */
-    void*       (*Pop)               (ArrayQueue* arrayQueue, void* defaultElementPtr);
+    void*       (*Dequeue)           (ArrayQueue* arrayQueue, void* defaultElementPtr);
 
     /**
-     * Remove the element at index that range in [topIndex, ArrayQueue size - 1].
+     * Remove the element at index that range in [headIndex, ArrayQueue size - 1].
      */
     void        (*RemoveAt)          (ArrayQueue* arrayQueue, int   index);
 
     /**
-     * Clear all elements, and reset topIndex to 0.
+     * Clear all elements, and reset headIndex to 0.
      */
     void        (*Clear)             (ArrayQueue* arrayQueue);
 };
@@ -93,49 +93,49 @@ extern struct AArrayQueue AArrayQueue[1];
  * example: ArrayQueue queue[1] = AArrayQueue_Init(ElementType, increase)
  */
 #define AArrayQueue_Init(ElementType, increase)  \
-    {                                            \
-        0,                                       \
-        AArrayList_Init(ElementType, increase),  \
+    {                                           \
+        0,                                      \
+        AArrayList_Init(ElementType, increase), \
     }
 
 
 /**
- * Shortcut of AArrayQueue->Push.
+ * Shortcut of AArrayQueue->Enqueue.
  */
-#define AArrayQueue_Push(arrayQueue, element) \
-    AArrayQueue->Push(arrayQueue, &(element))
+#define AArrayQueue_Enqueue(arrayQueue, element) \
+    AArrayQueue->Enqueue(arrayQueue, &(element))
 
 
 /**
- * Shortcut of AArrayQueue->Pop.
+ * Shortcut of AArrayQueue->Dequeue.
  * return element.
  */
-#define AArrayQueue_Pop(arrayQueue, ElementType) \
-    (*(ElementType*) AArrayQueue->Pop(arrayQueue, NULL_PTR))
+#define AArrayQueue_Dequeue(arrayQueue, ElementType) \
+    (*(ElementType*) AArrayQueue->Dequeue(arrayQueue, NULL_PTR))
 
 
 /**
- * Shortcut of AArrayQueue->Pop.
+ * Shortcut of AArrayQueue->Dequeue.
  * return element.
  */
-#define AArrayQueue_PopWithDefault(arrayQueue, ElementType, defaultValue) \
-    (*(ElementType*) AArrayQueue->Pop(arrayQueue, &(defaultValue)))
+#define AArrayQueue_DequeueWithDefault(arrayQueue, ElementType, defaultValue) \
+    (*(ElementType*) AArrayQueue->Dequeue(arrayQueue, &(defaultValue)))
 
 
 /**
- * Shortcut of AArrayQueue->Pop.
+ * Shortcut of AArrayQueue->Dequeue.
  * return elementPtr.
  */
-#define AArrayQueue_PopPtr(arrayQueue, ElementType) \
-    ((ElementType*) AArrayQueue->Pop(arrayQueue, NULL))
+#define AArrayQueue_DequeuePtr(arrayQueue, ElementType) \
+    ((ElementType*) AArrayQueue->Dequeue(arrayQueue, NULL))
 
 
 /**
- * Shortcut of AArrayQueue->Pop.
+ * Shortcut of AArrayQueue->Dequeue.
  * return elementPtr.
  */
-#define AArrayQueue_PopPtrWithDefault(arrayQueue, ElementType, defaultValue) \
-    ((ElementType*) AArrayQueue->Pop(arrayQueue, &(defaultValue)))
+#define AArrayQueue_DequeuePtrWithDefault(arrayQueue, ElementType, defaultValue) \
+    ((ElementType*) AArrayQueue->Dequeue(arrayQueue, &(defaultValue)))
 
 
 #endif
diff --git a/Engine/Toolkit/Utils/Tween.c b/Engine/Toolkit/Utils/Tween.c
@@ -132,10 +132,10 @@ static inline void SetActionValue(TweenAction* action)
 }
 
 
-static void PopQueueActionToRun(Tween* tween)
+static void DequeueAction(Tween* tween)
 {
     // get a queue action to run
-    TweenAction* action = AArrayQueue_Pop(tween->queue, TweenAction*);
+    TweenAction* action = AArrayQueue_Dequeue(tween->queue, TweenAction*);
 
     if (action != NULL)
     {
@@ -181,7 +181,7 @@ static void* RunActions(Array(TweenAction*)* actions, void* tweenID)
 
         if (action->isQueue)
         {
-            AArrayQueue_Push(tween->queue, action);
+            AArrayQueue_Enqueue(tween->queue, action);
         }
         else
         {
@@ -190,7 +190,7 @@ static void* RunActions(Array(TweenAction*)* actions, void* tweenID)
         }
     }
 
-    PopQueueActionToRun(tween);
+    DequeueAction(tween);
 
     return tweenID;
 }
@@ -220,7 +220,7 @@ static bool TryRemoveAction(void* tweenID, TweenAction* action)
             }
         }
 
-        for (int i = tween->queue->topIndex; i < tween->queue->elementList->size; ++i)
+        for (int i = tween->queue->headIndex; i < tween->queue->elementList->size; ++i)
         {
             TweenAction* tweenAction = AArrayList_Get(tween->queue->elementList, i, TweenAction*);
 
@@ -253,7 +253,7 @@ static bool TryRemoveAllActions(void* tweenID)
         AArrayList->Clear(tween->current);
 
         TweenAction* action;
-        while ((action = AArrayQueue_Pop(tween->queue, TweenAction*)))
+        while ((action = AArrayQueue_Dequeue(tween->queue, TweenAction*)))
         {
             AArrayList_Add(actionCacheList, action);
         }
@@ -302,7 +302,7 @@ static bool TryCompleteAllActions(void* tweenID, bool isFireOnComplete)
         AArrayList->Clear(tween->current);
 
         TweenAction* action;
-        while ((action = AArrayQueue_Pop(tween->queue, TweenAction*)))
+        while ((action = AArrayQueue_Dequeue(tween->queue, TweenAction*)))
         {
             SetActionComplete(action, isFireOnComplete);
             AArrayList_Add(actionCacheList, action);
@@ -387,7 +387,7 @@ static void Update(float deltaSeconds)
 
                 if (action->isQueue)
                 {
-                    PopQueueActionToRun(tween);
+                    DequeueAction(tween);
                 }
             }
         }
diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 <img src="./Docs/Images/Logo.png" width="176" height="228" alt="Mojoc Logo" title="Mojoc Logo" />
 
 
-## Mojoc v0.6.4
+## Mojoc v0.7.0
 
 Mojoc is an open-source, cross-platform, pure C game engine. It is based on OpenGLES3 and written in C99. It currently works on IOS and Android, but can easily be extended to other platforms, and will support more platforms in the future.
 

Original file line number	Diff line number	Diff line change
`@@ -268,14 +268,14 @@ static void Render(Drawable* drawable)`
`268`	`268`	`fromChild = AArrayList_Get`
`269`	`269`	`(`
`270`	`270`	`mesh->childList,`
`271`		`- AArrayQueue_PopWithDefault(mesh->drawRangeQueue, int, mesh->fromIndex),`
	`271`	`+ AArrayQueue_DequeueWithDefault(mesh->drawRangeQueue, int, mesh->fromIndex),`
`272`	`272`	`SubMesh*`
`273`	`273`	`);`
`274`	`274`
`275`	`275`	`toChild = AArrayList_Get`
`276`	`276`	`(`
`277`	`277`	`mesh->childList,`
`278`		`- AArrayQueue_PopWithDefault(mesh->drawRangeQueue, int, mesh->toIndex),`
	`278`	`+ AArrayQueue_DequeueWithDefault(mesh->drawRangeQueue, int, mesh->toIndex),`
`279`	`279`	`SubMesh*`
`280`	`280`	`);`
`281`	`281`	`}`
Original file line number	Diff line number	Diff line change
`@@ -272,8 +272,8 @@ static inline void AMesh_Draw(Mesh* mesh)`
`272`	`272`	`*/`
`273`	`273`	`static inline void AMesh_DrawByIndex(Mesh* mesh, int fromIndex, int toIndex)`
`274`	`274`	`{`
`275`		`- AArrayQueue_Push(mesh->drawRangeQueue, fromIndex);`
`276`		`- AArrayQueue_Push(mesh->drawRangeQueue, toIndex);`
	`275`	`+ AArrayQueue_Enqueue(mesh->drawRangeQueue, fromIndex);`
	`276`	`+ AArrayQueue_Enqueue(mesh->drawRangeQueue, toIndex);`
`277`	`277`	`ADrawable->Draw (mesh->drawable);`
`278`	`278`	`}`
`279`	`279`
Original file line number	Diff line number	Diff line change
`@@ -19,38 +19,38 @@`
`19`	`19`	`#include "Engine/Toolkit/Platform/Log.h"`
`20`	`20`
`21`	`21`
`22`		`-static void* Push(ArrayQueue* arrayQueue, void* elementPtr)`
	`22`	`+static void* Enqueue(ArrayQueue* arrayQueue, void* elementPtr)`
`23`	`23`	`{`
`24`		`- if (arrayQueue->topIndex > 0 && arrayQueue->topIndex == arrayQueue->elementList->elementArr->length)`
	`24`	`+ if (arrayQueue->headIndex > 0 && arrayQueue->headIndex == arrayQueue->elementList->elementArr->length)`
`25`	`25`	`{`
`26`		`- AArrayList->RemoveRange(arrayQueue->elementList, 0, arrayQueue->topIndex - 1);`
`27`		`- arrayQueue->topIndex = 0;`
	`26`	`+ AArrayList->RemoveRange(arrayQueue->elementList, 0, arrayQueue->headIndex - 1);`
	`27`	`+ arrayQueue->headIndex = 0;`
`28`	`28`	`}`
`29`	`29`
`30`	`30`	`return AArrayList->Add(arrayQueue->elementList, elementPtr);`
`31`	`31`	`}`
`32`	`32`
`33`	`33`
`34`		`-static void* Pop(ArrayQueue* arrayQueue, void* defaultElementPtr)`
	`34`	`+static void* Dequeue(ArrayQueue* arrayQueue, void* defaultElementPtr)`
`35`	`35`	`{`
`36`		`- if (arrayQueue->topIndex == arrayQueue->elementList->size)`
	`36`	`+ if (arrayQueue->headIndex == arrayQueue->elementList->size)`
`37`	`37`	`{`
`38`	`38`	`return defaultElementPtr;`
`39`	`39`	`}`
`40`	`40`
`41`	`41`	`return (char*) arrayQueue->elementList->elementArr->data +`
`42`	`42`	`arrayQueue->elementList->elementTypeSize *`
`43`		`- (arrayQueue->topIndex++);`
	`43`	`+ (arrayQueue->headIndex++);`
`44`	`44`	`}`
`45`	`45`
`46`	`46`
`47`	`47`	`static void RemoveAt(ArrayQueue* arrayQueue, int index)`
`48`	`48`	`{`
`49`	`49`	`ALog_A`
`50`	`50`	`(`
`51`		`- index >= arrayQueue->topIndex && index < arrayQueue->elementList->size,`
	`51`	`+ index >= arrayQueue->headIndex && index < arrayQueue->elementList->size,`
`52`	`52`	`"AArrayQueue RemoveAt index = %d, out of range [%d, %d]",`
`53`		`- index, arrayQueue->topIndex, arrayQueue->elementList->size - 1`
	`53`	`+ index, arrayQueue->headIndex, arrayQueue->elementList->size - 1`
`54`	`54`	`);`
`55`	`55`
`56`	`56`	`AArrayList->Remove(arrayQueue->elementList, index);`
`@@ -59,7 +59,7 @@ static void RemoveAt(ArrayQueue* arrayQueue, int index)`
`59`	`59`
`60`	`60`	`static void Release(ArrayQueue* arrayQueue)`
`61`	`61`	`{`
`62`		`- arrayQueue->topIndex = 0;`
	`62`	`+ arrayQueue->headIndex = 0;`
`63`	`63`	`AArrayList->Release(arrayQueue->elementList);`
`64`	`64`	`}`
`65`	`65`
`@@ -75,7 +75,7 @@ static void InitWithCapacity(int elementTypeSize, int capacity, ArrayQueue* outA`
`75`	`75`	`AArrayList->InitWithCapacity(elementTypeSize, capacity, outArrayQueue->elementList);`
`76`	`76`	`}`
`77`	`77`
`78`		`- outArrayQueue->topIndex = 0;`
	`78`	`+ outArrayQueue->headIndex = 0;`
`79`	`79`	`}`
`80`	`80`
`81`	`81`
`@@ -102,7 +102,7 @@ static ArrayQueue* Create(int elementTypeSize)`
`102`	`102`
`103`	`103`	`static void Clear(ArrayQueue* arrayQueue)`
`104`	`104`	`{`
`105`		`- arrayQueue->topIndex = 0;`
	`105`	`+ arrayQueue->headIndex = 0;`
`106`	`106`	`AArrayList->Clear(arrayQueue->elementList);`
`107`	`107`	`}`
`108`	`108`
`@@ -115,8 +115,8 @@ struct AArrayQueue AArrayQueue[1] =`
`115`	`115`	`InitWithCapacity,`
`116`	`116`	`Release,`
`117`	`117`
`118`		`- Push,`
`119`		`- Pop,`
	`118`	`+ Enqueue,`
	`119`	`+ Dequeue,`
`120`	`120`	`RemoveAt,`
`121`	`121`	`Clear,`
`122`	`122`	`}};`
Original file line number	Diff line number	Diff line change
`@@ -132,10 +132,10 @@ static inline void SetActionValue(TweenAction* action)`
`132`	`132`	`}`
`133`	`133`
`134`	`134`
`135`		`-static void PopQueueActionToRun(Tween* tween)`
	`135`	`+static void DequeueAction(Tween* tween)`
`136`	`136`	`{`
`137`	`137`	`// get a queue action to run`
`138`		`- TweenAction* action = AArrayQueue_Pop(tween->queue, TweenAction*);`
	`138`	`+ TweenAction* action = AArrayQueue_Dequeue(tween->queue, TweenAction*);`
`139`	`139`
`140`	`140`	`if (action != NULL)`
`141`	`141`	`{`
`@@ -181,7 +181,7 @@ static void* RunActions(Array(TweenAction) actions, void* tweenID)`
`181`	`181`
`182`	`182`	`if (action->isQueue)`
`183`	`183`	`{`
`184`		`- AArrayQueue_Push(tween->queue, action);`
	`184`	`+ AArrayQueue_Enqueue(tween->queue, action);`
`185`	`185`	`}`
`186`	`186`	`else`
`187`	`187`	`{`
`@@ -190,7 +190,7 @@ static void* RunActions(Array(TweenAction) actions, void* tweenID)`
`190`	`190`	`}`
`191`	`191`	`}`
`192`	`192`
`193`		`- PopQueueActionToRun(tween);`
	`193`	`+ DequeueAction(tween);`
`194`	`194`
`195`	`195`	`return tweenID;`
`196`	`196`	`}`
`@@ -220,7 +220,7 @@ static bool TryRemoveAction(void* tweenID, TweenAction* action)`
`220`	`220`	`}`
`221`	`221`	`}`
`222`	`222`
`223`		`- for (int i = tween->queue->topIndex; i < tween->queue->elementList->size; ++i)`
	`223`	`+ for (int i = tween->queue->headIndex; i < tween->queue->elementList->size; ++i)`
`224`	`224`	`{`
`225`	`225`	`TweenAction* tweenAction = AArrayList_Get(tween->queue->elementList, i, TweenAction*);`
`226`	`226`
`@@ -253,7 +253,7 @@ static bool TryRemoveAllActions(void* tweenID)`
`253`	`253`	`AArrayList->Clear(tween->current);`
`254`	`254`
`255`	`255`	`TweenAction* action;`
`256`		`- while ((action = AArrayQueue_Pop(tween->queue, TweenAction*)))`
	`256`	`+ while ((action = AArrayQueue_Dequeue(tween->queue, TweenAction*)))`
`257`	`257`	`{`
`258`	`258`	`AArrayList_Add(actionCacheList, action);`
`259`	`259`	`}`
`@@ -302,7 +302,7 @@ static bool TryCompleteAllActions(void* tweenID, bool isFireOnComplete)`
`302`	`302`	`AArrayList->Clear(tween->current);`
`303`	`303`
`304`	`304`	`TweenAction* action;`
`305`		`- while ((action = AArrayQueue_Pop(tween->queue, TweenAction*)))`
	`305`	`+ while ((action = AArrayQueue_Dequeue(tween->queue, TweenAction*)))`
`306`	`306`	`{`
`307`	`307`	`SetActionComplete(action, isFireOnComplete);`
`308`	`308`	`AArrayList_Add(actionCacheList, action);`
`@@ -387,7 +387,7 @@ static void Update(float deltaSeconds)`
`387`	`387`
`388`	`388`	`if (action->isQueue)`
`389`	`389`	`{`
`390`		`- PopQueueActionToRun(tween);`
	`390`	`+ DequeueAction(tween);`
`391`	`391`	`}`
`392`	`392`	`}`
`393`	`393`	`}`