Runtime: add C++-like vector implementation in C

git-svn-id: https://www.virtualbox.org/svn/vbox/trunk@37720 cfe28804-0f27-0410-a406-dd0f0b0b656f

1 files changed, 225 insertions, 0 deletions

diff --git a/src/VBox/Runtime/testcase/tstVector.cpp b/src/VBox/Runtime/testcase/tstVector.cpp
new file mode 100644
index 00000000000..5cf1115fde5
--- /dev/null
+++ b/src/VBox/Runtime/testcase/tstVector.cpp
@@ -0,0 +1,225 @@
+/* $Id$ */
+/** @file
+ * IPRT Testcase - Vector container structure.
+ */
+
+/*
+ * Copyright (C) 2011 Oracle Corporation
+ *
+ * This file is part of VirtualBox Open Source Edition (OSE), as
+ * available from http://www.virtualbox.org. This file is free software;
+ * you can redistribute it and/or modify it under the terms of the GNU
+ * General Public License (GPL) as published by the Free Software
+ * Foundation, in version 2 as it comes in the "COPYING" file of the
+ * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
+ * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
+ */
+
+/*******************************************************************************
+*   Header Files                                                               *
+*******************************************************************************/
+#include <iprt/test.h>
+#include <iprt/vector.h>
+
+#include <stdlib.h>  /* For realloc */
+
+/** Counter of the number of delete calls made so far */
+static unsigned s_cDeleteCalls = 0;
+
+/** Record the argument of the delete function here. */
+static void *s_apvDeleteArg[10];
+
+/** Dummy delete function for vector-of-void pointer elements */
+static void deletePVoid(void **ppv)
+{
+    if (s_cDeleteCalls < RT_ELEMENTS(s_apvDeleteArg))
+        s_apvDeleteArg[s_cDeleteCalls] = *ppv;
+    ++s_cDeleteCalls;
+}
+
+/** Dummy delete by value function for vector-of-void pointer elements */
+static void deletePVoidValue(void *pv)
+{
+    if (s_cDeleteCalls < RT_ELEMENTS(s_apvDeleteArg))
+        s_apvDeleteArg[s_cDeleteCalls] = pv;
+    ++s_cDeleteCalls;
+}
+
+/* Start by instantiating each function once for syntax checking */
+RTVEC_DECL_STRUCT(tstInstance, void *)
+RTVEC_DECL_STRUCT(tstInstance2, void *)
+
+RTVEC_DECLFN_DELETE_ADAPTER_ID(tstInstance, void *)
+RTVEC_DECLFN_DELETE_ADAPTER_TO_VALUE(tstInstance, void *)
+
+RTVEC_DECLFN_SIZE(tstInstance, void *)
+RTVEC_DECLFN_RESERVE(tstInstance, void *, rtvecReallocDefTag)
+RTVEC_DECLFN_BEGIN(tstInstance, void *)
+RTVEC_DECLFN_END(tstInstance, void *)
+RTVEC_DECLFN_PUSHBACK(tstInstance, void *)
+RTVEC_DECLFN_POPBACK(tstInstance)
+RTVEC_DECLFN_POPBACK_DELETE(tstInstance2, void *, deletePVoid,
+                            tstInstanceDeleteAdapterId)
+RTVEC_DECLFN_CLEAR(tstInstance)
+RTVEC_DECLFN_CLEAR_DELETE(tstInstance2, deletePVoid,
+                          tstInstanceDeleteAdapterId)
+RTVEC_DECLFN_DETACH(tstInstance, void *)
+
+RTVEC_DECL(tstSimple, void *)
+
+static void testVectorSimple(RTTEST hTest)
+{
+    RTTestISub("Vector structure, no cleanup callback");
+
+    struct tstSimple myVec = RTVEC_INITIALIZER;
+    void **ppvVal;
+
+    RTTESTI_CHECK(tstSimpleSize(&myVec) == 0);
+
+    ppvVal = tstSimplePushBack(&myVec);
+    /* AssertPtrReturnVoid(ppvVal); */
+    RTTESTI_CHECK(ppvVal == tstSimpleBegin(&myVec));
+    RTTESTI_CHECK(ppvVal + 1 == tstSimpleEnd(&myVec));
+    RTTESTI_CHECK(tstSimpleSize(&myVec) == 1);
+    *ppvVal = (void *)1;
+
+    ppvVal = tstSimplePushBack(&myVec);
+    /* AssertPtrReturnVoid(ppvVal); */
+    RTTESTI_CHECK(ppvVal - 1 == tstSimpleBegin(&myVec));
+    RTTESTI_CHECK(ppvVal + 1 == tstSimpleEnd(&myVec));
+    RTTESTI_CHECK(tstSimpleSize(&myVec) == 2);
+    RTTESTI_CHECK(ppvVal[-1] == (void *)1);
+
+    *ppvVal = (void *)3;
+    ppvVal = tstSimplePushBack(&myVec);
+    /* AssertPtrReturnVoid(ppvVal); */
+    RTTESTI_CHECK(ppvVal - 2 == tstSimpleBegin(&myVec));
+    RTTESTI_CHECK(ppvVal + 1 == tstSimpleEnd(&myVec));
+    RTTESTI_CHECK(tstSimpleSize(&myVec) == 3);
+    RTTESTI_CHECK(ppvVal[-2] == (void *)1);
+    RTTESTI_CHECK(ppvVal[-1] == (void *)3);
+
+    tstSimplePopBack(&myVec);
+    RTTESTI_CHECK(tstSimpleBegin(&myVec) + 2 == tstSimpleEnd(&myVec));
+    RTTESTI_CHECK(*tstSimpleBegin(&myVec) == (void *)1);
+    RTTESTI_CHECK(*(tstSimpleEnd(&myVec) - 1) == (void *)3);
+
+    tstSimpleClear(&myVec);
+    RTTESTI_CHECK(tstSimpleBegin(&myVec) == tstSimpleEnd(&myVec));
+    ppvVal = tstSimplePushBack(&myVec);
+    /* AssertPtrReturnVoid(ppvVal); */
+    RTTESTI_CHECK(ppvVal == tstSimpleBegin(&myVec));
+    RTTESTI_CHECK(ppvVal + 1 == tstSimpleEnd(&myVec));
+
+    tstSimpleClear(&myVec);
+    ppvVal = tstSimplePushBack(&myVec);
+    /* AssertPtrReturnVoid(ppvVal); */
+    *ppvVal = (void *)1;
+    ppvVal = tstSimplePushBack(&myVec);
+    /* AssertPtrReturnVoid(ppvVal); */
+    *ppvVal = (void *)3;
+    ppvVal = tstSimplePushBack(&myVec);
+    /* AssertPtrReturnVoid(ppvVal); */
+    *ppvVal = (void *)2;
+    ppvVal = tstSimpleDetach(&myVec);
+    RTTESTI_CHECK(tstSimpleBegin(&myVec) == NULL);
+    RTTESTI_CHECK(tstSimpleSize(&myVec) == 0);
+    RTTESTI_CHECK(ppvVal[0] == (void *)1);
+    RTTESTI_CHECK(ppvVal[1] == (void *)3);
+    RTTESTI_CHECK(ppvVal[2] == (void *)2);
+}
+
+RTVEC_DECL_DELETE(tstDelete, void *, deletePVoid)
+
+static void testVectorDelete(RTTEST hTest)
+{
+    RTTestISub("Vector structure with cleanup by pointer callback");
+
+    struct tstDelete myVec = RTVEC_INITIALIZER;
+    void **ppvVal;
+
+    ppvVal = tstDeletePushBack(&myVec);
+    /* AssertPtrReturnVoid(ppvVal); */
+    *ppvVal = (void *)1;
+    ppvVal = tstDeletePushBack(&myVec);
+    /* AssertPtrReturnVoid(ppvVal); */
+    *ppvVal = (void *)3;
+    ppvVal = tstDeletePushBack(&myVec);
+    /* AssertPtrReturnVoid(ppvVal); */
+    *ppvVal = (void *)2;
+
+    s_cDeleteCalls = 0;
+    tstDeletePopBack(&myVec);
+    RTTESTI_CHECK(s_cDeleteCalls == 1);
+    RTTESTI_CHECK(s_apvDeleteArg[0] == (void *)2);
+    RTTESTI_CHECK(tstDeleteBegin(&myVec) + 2 == tstDeleteEnd(&myVec));
+    RTTESTI_CHECK(*tstDeleteBegin(&myVec) == (void *)1);
+    RTTESTI_CHECK(*(tstDeleteEnd(&myVec) - 1) == (void *)3);
+
+    s_cDeleteCalls = 0;
+    tstDeleteClear(&myVec);
+    RTTESTI_CHECK(s_cDeleteCalls == 2);
+    RTTESTI_CHECK(s_apvDeleteArg[0] == (void *)1);
+    RTTESTI_CHECK(s_apvDeleteArg[1] == (void *)3);
+    RTTESTI_CHECK(tstDeleteBegin(&myVec) == tstDeleteEnd(&myVec));
+    ppvVal = tstDeletePushBack(&myVec);
+    /* AssertPtrReturnVoid(ppvVal); */
+    RTTESTI_CHECK(ppvVal == tstDeleteBegin(&myVec));
+    RTTESTI_CHECK(ppvVal + 1 == tstDeleteEnd(&myVec));
+}
+
+RTVEC_DECL_DELETE_BY_VALUE(tstDeleteValue, void *, deletePVoidValue)
+
+static void testVectorDeleteValue(RTTEST hTest)
+{
+    RTTestISub("Vector structure with cleanup by value callback");
+
+    struct tstDeleteValue myVec = RTVEC_INITIALIZER;
+    void **ppvVal;
+
+    ppvVal = tstDeleteValuePushBack(&myVec);
+    /* AssertPtrReturnVoid(ppvVal); */
+    *ppvVal = (void *)1;
+    ppvVal = tstDeleteValuePushBack(&myVec);
+    /* AssertPtrReturnVoid(ppvVal); */
+    *ppvVal = (void *)3;
+    ppvVal = tstDeleteValuePushBack(&myVec);
+    /* AssertPtrReturnVoid(ppvVal); */
+    *ppvVal = (void *)2;
+
+    s_cDeleteCalls = 0;
+    tstDeleteValuePopBack(&myVec);
+    RTTESTI_CHECK(s_cDeleteCalls == 1);
+    RTTESTI_CHECK(s_apvDeleteArg[0] == (void *)2);
+    RTTESTI_CHECK(   tstDeleteValueBegin(&myVec) + 2
+                  == tstDeleteValueEnd(&myVec));
+    RTTESTI_CHECK(*tstDeleteValueBegin(&myVec) == (void *)1);
+    RTTESTI_CHECK(*(tstDeleteValueEnd(&myVec) - 1) == (void *)3);
+
+    s_cDeleteCalls = 0;
+    tstDeleteValueClear(&myVec);
+    RTTESTI_CHECK(s_cDeleteCalls == 2);
+    RTTESTI_CHECK(s_apvDeleteArg[0] == (void *)1);
+    RTTESTI_CHECK(s_apvDeleteArg[1] == (void *)3);
+    RTTESTI_CHECK(tstDeleteValueBegin(&myVec) == tstDeleteValueEnd(&myVec));
+    ppvVal = tstDeleteValuePushBack(&myVec);
+    /* AssertPtrReturnVoid(ppvVal); */
+    RTTESTI_CHECK(ppvVal == tstDeleteValueBegin(&myVec));
+    RTTESTI_CHECK(ppvVal + 1 == tstDeleteValueEnd(&myVec));
+}
+
+
+
+int main()
+{
+    RTTEST hTest;
+    RTEXITCODE rcExit = RTTestInitAndCreate("tstVector", &hTest);
+    if (rcExit != RTEXITCODE_SUCCESS)
+        return rcExit;
+
+    testVectorSimple(hTest);
+    testVectorDelete(hTest);
+    testVectorDeleteValue(hTest);
+
+    return RTTestSummaryAndDestroy(hTest);
+}