VirtualBox

source: vbox/trunk/src/VBox/Runtime/common/string/strspace.cpp

Last change on this file was 99758, checked in by vboxsync, 12 months ago

IPRT: Make doxygen 1.9.6 happy. Mostly removing duplicate docs (iprt is documented in the header files). bugref:10442

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id Revision
File size: 6.4 KB
Line 
1/* $Id: strspace.cpp 99758 2023-05-11 21:37:59Z vboxsync $ */
2/** @file
3 * IPRT - Unique String Spaces.
4 */
5
6/*
7 * Copyright (C) 2006-2023 Oracle and/or its affiliates.
8 *
9 * This file is part of VirtualBox base platform packages, as
10 * available from https://www.virtualbox.org.
11 *
12 * This program is free software; you can redistribute it and/or
13 * modify it under the terms of the GNU General Public License
14 * as published by the Free Software Foundation, in version 3 of the
15 * License.
16 *
17 * This program is distributed in the hope that it will be useful, but
18 * WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 * General Public License for more details.
21 *
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, see <https://www.gnu.org/licenses>.
24 *
25 * The contents of this file may alternatively be used under the terms
26 * of the Common Development and Distribution License Version 1.0
27 * (CDDL), a copy of it is provided in the "COPYING.CDDL" file included
28 * in the VirtualBox distribution, in which case the provisions of the
29 * CDDL are applicable instead of those of the GPL.
30 *
31 * You may elect to license modified versions of this file under the
32 * terms and conditions of either the GPL or the CDDL or both.
33 *
34 * SPDX-License-Identifier: GPL-3.0-only OR CDDL-1.0
35 */
36
37
38/*********************************************************************************************************************************
39* Header Files *
40*********************************************************************************************************************************/
41#include <iprt/string.h>
42#include "internal/iprt.h"
43
44#include <iprt/assert.h>
45#include "internal/strhash.h"
46
47
48/*********************************************************************************************************************************
49* Defined Constants And Macros *
50*********************************************************************************************************************************/
51/*
52 * AVL configuration.
53 */
54#define KAVL_DECL(a_Type) static a_Type
55#define KAVL_FN(a) rtstrspace##a
56#define KAVL_MAX_STACK 27 /* Up to 2^24 nodes. */
57#define KAVL_EQUAL_ALLOWED 1
58#define KAVLNODECORE RTSTRSPACECORE
59#define PKAVLNODECORE PRTSTRSPACECORE
60#define PPKAVLNODECORE PPRTSTRSPACECORE
61#define KAVLKEY uint32_t
62#define PKAVLKEY uint32_t *
63
64#define PKAVLCALLBACK PFNRTSTRSPACECALLBACK
65
66/*
67 * AVL Compare macros
68 */
69#define KAVL_G(key1, key2) (key1 > key2)
70#define KAVL_E(key1, key2) (key1 == key2)
71#define KAVL_NE(key1, key2) (key1 != key2)
72
73
74/*
75 * Include the code.
76 */
77#define SSToDS(ptr) ptr
78#define KMAX RT_MAX
79#define kASSERT Assert
80#include "../table/avl_Base.cpp.h"
81#include "../table/avl_Get.cpp.h"
82#include "../table/avl_DoWithAll.cpp.h"
83#include "../table/avl_Destroy.cpp.h"
84
85
86
87RTDECL(bool) RTStrSpaceInsert(PRTSTRSPACE pStrSpace, PRTSTRSPACECORE pStr)
88{
89 pStr->Key = sdbm(pStr->pszString, &pStr->cchString);
90 PRTSTRSPACECORE pMatch = KAVL_FN(Get)(pStrSpace, pStr->Key);
91 if (!pMatch)
92 return KAVL_FN(Insert)(pStrSpace, pStr);
93
94 /* Check for clashes. */
95 for (PRTSTRSPACECORE pCur = pMatch; pCur; pCur = pCur->pList)
96 if ( pCur->cchString == pStr->cchString
97 && !memcmp(pCur->pszString, pStr->pszString, pStr->cchString))
98 return false;
99 pStr->pList = pMatch->pList;
100 pMatch->pList = pStr;
101 return true;
102}
103RT_EXPORT_SYMBOL(RTStrSpaceInsert);
104
105
106RTDECL(PRTSTRSPACECORE) RTStrSpaceRemove(PRTSTRSPACE pStrSpace, const char *pszString)
107{
108 size_t cchString;
109 KAVLKEY Key = sdbm(pszString, &cchString);
110 PRTSTRSPACECORE pCur = KAVL_FN(Get)(pStrSpace, Key);
111 if (!pCur)
112 return NULL;
113
114 /* find the right one. */
115 PRTSTRSPACECORE pPrev = NULL;
116 for (; pCur; pPrev = pCur, pCur = pCur->pList)
117 if ( pCur->cchString == cchString
118 && !memcmp(pCur->pszString, pszString, cchString))
119 break;
120 if (pCur)
121 {
122 if (pPrev)
123 /* simple, it's in the linked list. */
124 pPrev->pList = pCur->pList;
125 else
126 {
127 /* in the tree. remove and reinsert list head. */
128 PRTSTRSPACECORE pInsert = pCur->pList;
129 pCur->pList = NULL;
130 pCur = KAVL_FN(Remove)(pStrSpace, Key);
131 Assert(pCur);
132 if (pInsert)
133 {
134 PRTSTRSPACECORE pList = pInsert->pList;
135 bool fRc = KAVL_FN(Insert)(pStrSpace, pInsert);
136 Assert(fRc); NOREF(fRc);
137 pInsert->pList = pList;
138 }
139 }
140 }
141
142 return pCur;
143}
144RT_EXPORT_SYMBOL(RTStrSpaceRemove);
145
146
147RTDECL(PRTSTRSPACECORE) RTStrSpaceGet(PRTSTRSPACE pStrSpace, const char *pszString)
148{
149 size_t cchString;
150 KAVLKEY Key = sdbm(pszString, &cchString);
151 PRTSTRSPACECORE pCur = KAVL_FN(Get)(pStrSpace, Key);
152 if (!pCur)
153 return NULL;
154
155 /* Linear search. */
156 for (; pCur; pCur = pCur->pList)
157 if ( pCur->cchString == cchString
158 && !memcmp(pCur->pszString, pszString, cchString))
159 return pCur;
160 return NULL;
161}
162RT_EXPORT_SYMBOL(RTStrSpaceGet);
163
164
165RTDECL(PRTSTRSPACECORE) RTStrSpaceGetN(PRTSTRSPACE pStrSpace, const char *pszString, size_t cchMax)
166{
167 size_t cchString;
168 KAVLKEY Key = sdbmN(pszString, cchMax, &cchString);
169 PRTSTRSPACECORE pCur = KAVL_FN(Get)(pStrSpace, Key);
170 if (!pCur)
171 return NULL;
172
173 /* Linear search. */
174 for (; pCur; pCur = pCur->pList)
175 if ( pCur->cchString == cchString
176 && !memcmp(pCur->pszString, pszString, cchString))
177 return pCur;
178 return NULL;
179}
180RT_EXPORT_SYMBOL(RTStrSpaceGetN);
181
182
183RTDECL(int) RTStrSpaceEnumerate(PRTSTRSPACE pStrSpace, PFNRTSTRSPACECALLBACK pfnCallback, void *pvUser)
184{
185 return KAVL_FN(DoWithAll)(pStrSpace, true, pfnCallback, pvUser);
186}
187RT_EXPORT_SYMBOL(RTStrSpaceEnumerate);
188
189
190RTDECL(int) RTStrSpaceDestroy(PRTSTRSPACE pStrSpace, PFNRTSTRSPACECALLBACK pfnCallback, void *pvUser)
191{
192 return KAVL_FN(Destroy)(pStrSpace, pfnCallback, pvUser);
193}
194RT_EXPORT_SYMBOL(RTStrSpaceDestroy);
195
Note: See TracBrowser for help on using the repository browser.

© 2023 Oracle
ContactPrivacy policyTerms of Use