Coin: SbDict.h Source File

| Coin3D is Free Software, published under the BSD 3-clause license. | https://coin3d.github.io https://www.kongsberg.com/en/kogt/

SbDict.h
1#ifndef COIN_SBDICT_H
2#define COIN_SBDICT_H
3
4/**************************************************************************\
5 * Copyright (c) Kongsberg Oil & Gas Technologies AS
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are
10 * met:
11 *
12 * Redistributions of source code must retain the above copyright notice,
13 * this list of conditions and the following disclaimer.
14 *
15 * Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 *
19 * Neither the name of the copyright holder nor the names of its
20 * contributors may be used to endorse or promote products derived from
21 * this software without specific prior written permission.
22 *
23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
26 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
27 * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
28 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
29 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
30 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
31 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
32 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34\**************************************************************************/
35
36// *************************************************************************
37
38// Internally, we should use the SbHash template class, since it
39// provides a better interface than SbDict, and since the interface of
40// SbDict has issues on 64-bit platforms when keeping strict
41// compatibility with the original SbDict of SGI Inventor.
42
43#if defined(COIN_INTERNAL) && !defined(COIN_ALLOW_SBDICT)
44#error prefer SbHash over SbDict for internal code
45#endif // COIN_INTERNAL
46
47// *************************************************************************
48
49#include <cstddef>
50#include <Inventor/SbBasic.h>
51
52class SbPList;
53
54// *************************************************************************
55
56extern "C" {
57typedef uintptr_t SbDictKeyType;
58typedef void SbDictApplyFunc(SbDictKeyType key, void * value);
59typedef void SbDictApplyDataFunc(SbDictKeyType key, void * value, void * data);
60typedef SbDictKeyType SbDictHashingFunc(const SbDictKeyType key);
61}
62
63 class COIN_DLL_API SbDict {
64public:
65 SbDict(const int entries = 251);
66 SbDict(const SbDict & from);
67 ~SbDict();
68
69 SbDict & operator=(const SbDict & from);
70
71 typedef uintptr_t Key;
72
73 void applyToAll(SbDictApplyFunc * rtn) const;
74 void applyToAll(SbDictApplyDataFunc * rtn, void * data) const;
75 void clear(void);
76
77 SbBool enter(const Key key, void * const value);
78 SbBool find(const Key key, void *& value) const;
79 void makePList(SbPList & keys, SbPList & values);
80 SbBool remove(const Key key);
81
82 void setHashingFunction(SbDictHashingFunc * func);
83
84private:
85 struct cc_hash * hashtable;
86
87};
88
89// *************************************************************************
90
91#endif // !COIN_SBDICT_H
SbDict
The SbDict class organizes a dictionary of keys and values.
Definition SbDict.h:63
SbPList
The SbPList class is a container class for void pointers.
Definition lists/SbPList.h:40