summaryrefslogtreecommitdiffstats
path: root/src/VBox/Runtime/common/string/strspace.cpp
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--src/VBox/Runtime/common/string/strspace.cpp242
1 files changed, 242 insertions, 0 deletions
diff --git a/src/VBox/Runtime/common/string/strspace.cpp b/src/VBox/Runtime/common/string/strspace.cpp
new file mode 100644
index 00000000..1ede87cb
--- /dev/null
+++ b/src/VBox/Runtime/common/string/strspace.cpp
@@ -0,0 +1,242 @@
+/* $Id: strspace.cpp $ */
+/** @file
+ * IPRT - Unique String Spaces.
+ */
+
+/*
+ * Copyright (C) 2006-2019 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.
+ *
+ * The contents of this file may alternatively be used under the terms
+ * of the Common Development and Distribution License Version 1.0
+ * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
+ * VirtualBox OSE distribution, in which case the provisions of the
+ * CDDL are applicable instead of those of the GPL.
+ *
+ * You may elect to license modified versions of this file under the
+ * terms and conditions of either the GPL or the CDDL or both.
+ */
+
+
+/*********************************************************************************************************************************
+* Header Files *
+*********************************************************************************************************************************/
+#include <iprt/string.h>
+#include "internal/iprt.h"
+
+#include <iprt/assert.h>
+#include "internal/strhash.h"
+
+
+/*********************************************************************************************************************************
+* Defined Constants And Macros *
+*********************************************************************************************************************************/
+/*
+ * AVL configuration.
+ */
+#define KAVL_DECL(a_Type) static a_Type
+#define KAVL_FN(a) rtstrspace##a
+#define KAVL_MAX_STACK 27 /* Up to 2^24 nodes. */
+#define KAVL_EQUAL_ALLOWED 1
+#define KAVLNODECORE RTSTRSPACECORE
+#define PKAVLNODECORE PRTSTRSPACECORE
+#define PPKAVLNODECORE PPRTSTRSPACECORE
+#define KAVLKEY uint32_t
+#define PKAVLKEY uint32_t *
+
+#define PKAVLCALLBACK PFNRTSTRSPACECALLBACK
+
+/*
+ * AVL Compare macros
+ */
+#define KAVL_G(key1, key2) (key1 > key2)
+#define KAVL_E(key1, key2) (key1 == key2)
+#define KAVL_NE(key1, key2) (key1 != key2)
+
+
+/*
+ * Include the code.
+ */
+#define SSToDS(ptr) ptr
+#define KMAX RT_MAX
+#define kASSERT Assert
+#include "../table/avl_Base.cpp.h"
+#include "../table/avl_Get.cpp.h"
+#include "../table/avl_DoWithAll.cpp.h"
+#include "../table/avl_Destroy.cpp.h"
+
+
+
+/**
+ * Inserts a string into a unique string space.
+ *
+ * @returns true on success.
+ * @returns false if the string collided with an existing string.
+ * @param pStrSpace The space to insert it into.
+ * @param pStr The string node.
+ */
+RTDECL(bool) RTStrSpaceInsert(PRTSTRSPACE pStrSpace, PRTSTRSPACECORE pStr)
+{
+ pStr->Key = sdbm(pStr->pszString, &pStr->cchString);
+ PRTSTRSPACECORE pMatch = KAVL_FN(Get)(pStrSpace, pStr->Key);
+ if (!pMatch)
+ return KAVL_FN(Insert)(pStrSpace, pStr);
+
+ /* Check for clashes. */
+ for (PRTSTRSPACECORE pCur = pMatch; pCur; pCur = pCur->pList)
+ if ( pCur->cchString == pStr->cchString
+ && !memcmp(pCur->pszString, pStr->pszString, pStr->cchString))
+ return false;
+ pStr->pList = pMatch->pList;
+ pMatch->pList = pStr;
+ return true;
+}
+RT_EXPORT_SYMBOL(RTStrSpaceInsert);
+
+
+/**
+ * Removes a string from a unique string space.
+ *
+ * @returns Pointer to the removed string node.
+ * @returns NULL if the string was not found in the string space.
+ * @param pStrSpace The space to insert it into.
+ * @param pszString The string to remove.
+ */
+RTDECL(PRTSTRSPACECORE) RTStrSpaceRemove(PRTSTRSPACE pStrSpace, const char *pszString)
+{
+ size_t cchString;
+ KAVLKEY Key = sdbm(pszString, &cchString);
+ PRTSTRSPACECORE pCur = KAVL_FN(Get)(pStrSpace, Key);
+ if (!pCur)
+ return NULL;
+
+ /* find the right one. */
+ PRTSTRSPACECORE pPrev = NULL;
+ for (; pCur; pPrev = pCur, pCur = pCur->pList)
+ if ( pCur->cchString == cchString
+ && !memcmp(pCur->pszString, pszString, cchString))
+ break;
+ if (pCur)
+ {
+ if (pPrev)
+ /* simple, it's in the linked list. */
+ pPrev->pList = pCur->pList;
+ else
+ {
+ /* in the tree. remove and reinsert list head. */
+ PRTSTRSPACECORE pInsert = pCur->pList;
+ pCur->pList = NULL;
+ pCur = KAVL_FN(Remove)(pStrSpace, Key);
+ Assert(pCur);
+ if (pInsert)
+ {
+ PRTSTRSPACECORE pList = pInsert->pList;
+ bool fRc = KAVL_FN(Insert)(pStrSpace, pInsert);
+ Assert(fRc); NOREF(fRc);
+ pInsert->pList = pList;
+ }
+ }
+ }
+
+ return pCur;
+}
+RT_EXPORT_SYMBOL(RTStrSpaceRemove);
+
+
+/**
+ * Gets a string from a unique string space.
+ *
+ * @returns Pointer to the string node.
+ * @returns NULL if the string was not found in the string space.
+ * @param pStrSpace The space to insert it into.
+ * @param pszString The string to get.
+ */
+RTDECL(PRTSTRSPACECORE) RTStrSpaceGet(PRTSTRSPACE pStrSpace, const char *pszString)
+{
+ size_t cchString;
+ KAVLKEY Key = sdbm(pszString, &cchString);
+ PRTSTRSPACECORE pCur = KAVL_FN(Get)(pStrSpace, Key);
+ if (!pCur)
+ return NULL;
+
+ /* Linear search. */
+ for (; pCur; pCur = pCur->pList)
+ if ( pCur->cchString == cchString
+ && !memcmp(pCur->pszString, pszString, cchString))
+ return pCur;
+ return NULL;
+}
+RT_EXPORT_SYMBOL(RTStrSpaceGet);
+
+
+/**
+ * Gets a string from a unique string space.
+ *
+ * @returns Pointer to the string node.
+ * @returns NULL if the string was not found in the string space.
+ * @param pStrSpace The space to insert it into.
+ * @param pszString The string to get.
+ * @param cchMax The max string length to evaluate. Passing
+ * RTSTR_MAX is ok and makes it behave just like
+ * RTStrSpaceGet.
+ */
+RTDECL(PRTSTRSPACECORE) RTStrSpaceGetN(PRTSTRSPACE pStrSpace, const char *pszString, size_t cchMax)
+{
+ size_t cchString;
+ KAVLKEY Key = sdbmN(pszString, cchMax, &cchString);
+ PRTSTRSPACECORE pCur = KAVL_FN(Get)(pStrSpace, Key);
+ if (!pCur)
+ return NULL;
+
+ /* Linear search. */
+ for (; pCur; pCur = pCur->pList)
+ if ( pCur->cchString == cchString
+ && !memcmp(pCur->pszString, pszString, cchString))
+ return pCur;
+ return NULL;
+}
+RT_EXPORT_SYMBOL(RTStrSpaceGetN);
+
+
+/**
+ * Enumerates the string space.
+ * The caller supplies a callback which will be called for each of
+ * the string nodes.
+ *
+ * @returns 0 or what ever non-zero return value pfnCallback returned
+ * when aborting the destruction.
+ * @param pStrSpace The space to insert it into.
+ * @param pfnCallback The callback.
+ * @param pvUser The user argument.
+ */
+RTDECL(int) RTStrSpaceEnumerate(PRTSTRSPACE pStrSpace, PFNRTSTRSPACECALLBACK pfnCallback, void *pvUser)
+{
+ return KAVL_FN(DoWithAll)(pStrSpace, true, pfnCallback, pvUser);
+}
+RT_EXPORT_SYMBOL(RTStrSpaceEnumerate);
+
+
+/**
+ * Destroys the string space.
+ * The caller supplies a callback which will be called for each of
+ * the string nodes in for freeing their memory and other resources.
+ *
+ * @returns 0 or what ever non-zero return value pfnCallback returned
+ * when aborting the destruction.
+ * @param pStrSpace The space to insert it into.
+ * @param pfnCallback The callback.
+ * @param pvUser The user argument.
+ */
+RTDECL(int) RTStrSpaceDestroy(PRTSTRSPACE pStrSpace, PFNRTSTRSPACECALLBACK pfnCallback, void *pvUser)
+{
+ return KAVL_FN(Destroy)(pStrSpace, pfnCallback, pvUser);
+}
+RT_EXPORT_SYMBOL(RTStrSpaceDestroy);
+