Open Inventor Release 2024.1.1
 
Loading...
Searching...
No Matches
SbDict.h
1/*=======================================================================
2 * Copyright 1991-1996, Silicon Graphics, Inc.
3 * ALL RIGHTS RESERVED
4 *
5 * UNPUBLISHED -- Rights reserved under the copyright laws of the United
6 * States. Use of a copyright notice is precautionary only and does not
7 * imply publication or disclosure.
8 *
9 * U.S. GOVERNMENT RESTRICTED RIGHTS LEGEND:
10 * Use, duplication or disclosure by the Government is subject to restrictions
11 * as set forth in FAR 52.227.19(c)(2) or subparagraph (c)(1)(ii) of the Rights
12 * in Technical Data and Computer Software clause at DFARS 252.227-7013 and/or
13 * in similar or successor clauses in the FAR, or the DOD or NASA FAR
14 * Supplement. Contractor/manufacturer is Silicon Graphics, Inc.,
15 * 2011 N. Shoreline Blvd. Mountain View, CA 94039-7311.
16 *
17 * THE CONTENT OF THIS WORK CONTAINS CONFIDENTIAL AND PROPRIETARY
18 * INFORMATION OF SILICON GRAPHICS, INC. ANY DUPLICATION, MODIFICATION,
19 * DISTRIBUTION, OR DISCLOSURE IN ANY FORM, IN WHOLE, OR IN PART, IS STRICTLY
20 * PROHIBITED WITHOUT THE PRIOR EXPRESS WRITTEN PERMISSION OF SILICON
21 * GRAPHICS, INC.
22**=======================================================================*/
23/*=======================================================================
24** Author : Paul S. Strauss (MMM yyyy)
25** Modified by : Nick Thompson (MMM yyyy)
26**=======================================================================*/
27/*=======================================================================
28 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.), ***
29 *** AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT. ***
30 *** ***
31 *** REPRODUCTION, DISCLOSURE, OR USE, IN WHOLE OR IN PART, OTHER THAN AS ***
32 *** SPECIFIED IN THE LICENSE ARE NOT TO BE UNDERTAKEN EXCEPT WITH PRIOR ***
33 *** WRITTEN AUTHORIZATION OF FEI S.A.S. ***
34 *** ***
35 *** RESTRICTED RIGHTS LEGEND ***
36 *** USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS ***
37 *** WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN ***
38 *** SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT ***
39 *** CLAUSE AT FAR 52.227-19 OR SUBPARAGRAPH (C)(1)(II) OF THE RIGHTS IN ***
40 *** TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013. ***
41 *** ***
42 *** COPYRIGHT (C) 1996-2014 BY FEI S.A.S, ***
43 *** BORDEAUX, FRANCE ***
44 *** ALL RIGHTS RESERVED ***
45**=======================================================================*/
46/*=======================================================================
47** Modified by : VSG (MMM YYYY)
48**=======================================================================*/
49
50
51#ifndef _SB_DICT_
52#define _SB_DICT_
53
54#include <Inventor/SbBase.h>
55#include <Inventor/SbString.h>
56#include <Inventor/SbPList.h>
57
58class SbDictEntry;
59class SbThreadMutex;
60
62//
63// Class: SbDict
64//
65// This is a dictionary mapping (unsigned long) integer keys to (void *) data
66// pointers.
67//
69
70
71{
72 public:
73 // Constructor
74 SbDict(int entries = 251);
75
76 // Destructor
77 ~SbDict();
78
79 // Calls given routine (passing value) for each entry in dictionary.
80 // The order of entries is not guaranteed to mean anything.
81 void applyToAll(void (*rtn)(uintptr_t key, void *value));
82
83 // Calls given routine (passing value,data) for each entry in dictionary.
84 // The order of entries is not guaranteed to mean anything.
85 void applyToAll(void (*rtn)(uintptr_t key, void *value, void *data), void *data);
86
87 // Removes all entries from dictionary.
88 void clear();
89
90 // Enters a key,value pair into the dictionary. Overwrites entry and
91 // returns FALSE if key already exists.
92 SbBool enter(uintptr_t key, void *value);
93
94 // Finds entry with given key, setting value to point to value.
95 // Returns FALSE if no such entry.
96 SbBool find(uintptr_t key, void *&value) const;
97
98 // Makes two SbPLists, one for keys and the other for values.
99 // The order of entries is not guaranteed to mean anything.
100 void makePList(SbPList &keys, SbPList &values);
101
102 // Removes the entry with the given key. Returns FALSE if no such entry.
103 SbBool remove(uintptr_t key);
104
105 private:
106 SbDictEntry *m_entryList; // Hash map
107
108 static void addEntryToPLists(uintptr_t key, void *value, void *data);
109
110 SbThreadMutex* m_mutex;
111};
112
113#endif /* _SB_DICT_ */
114
115
List of generic (void *) pointers.
Definition SbPList.h:77
<a href="IconLegend.html"><img src="extTGS.gif" alt="VSG extension" border="0"></a> Portable mutex c...
int SbBool
Boolean type.
Definition SbBase.h:87