SbDict.h

/*=======================================================================
 * Copyright 1991-1996, Silicon Graphics, Inc.
 * ALL RIGHTS RESERVED
 *
 * UNPUBLISHED -- Rights reserved under the copyright laws of the United
 * States.   Use of a copyright notice is precautionary only and does not
 * imply publication or disclosure.
 *
 * U.S. GOVERNMENT RESTRICTED RIGHTS LEGEND:
 * Use, duplication or disclosure by the Government is subject to restrictions
 * as set forth in FAR 52.227.19(c)(2) or subparagraph (c)(1)(ii) of the Rights
 * in Technical Data and Computer Software clause at DFARS 252.227-7013 and/or
 * in similar or successor clauses in the FAR, or the DOD or NASA FAR
 * Supplement.  Contractor/manufacturer is Silicon Graphics, Inc.,
 * 2011 N. Shoreline Blvd. Mountain View, CA 94039-7311.
 *
 * THE CONTENT OF THIS WORK CONTAINS CONFIDENTIAL AND PROPRIETARY
 * INFORMATION OF SILICON GRAPHICS, INC. ANY DUPLICATION, MODIFICATION,
 * DISTRIBUTION, OR DISCLOSURE IN ANY FORM, IN WHOLE, OR IN PART, IS STRICTLY
 * PROHIBITED WITHOUT THE PRIOR EXPRESS WRITTEN PERMISSION OF SILICON
 * GRAPHICS, INC.
**=======================================================================*/
/*=======================================================================
** Author      : Paul S. Strauss (MMM yyyy)
** Modified by : Nick Thompson (MMM yyyy)
**=======================================================================*/
/*=======================================================================
 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.),            ***
 ***              AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT.                     ***
 ***                                                                                ***
 ***  REPRODUCTION, DISCLOSURE,  OR USE,  IN WHOLE OR IN PART,  OTHER THAN AS       ***
 ***  SPECIFIED  IN THE LICENSE ARE  NOT TO BE  UNDERTAKEN  EXCEPT WITH PRIOR       ***
 ***  WRITTEN AUTHORIZATION OF FEI S.A.S.                                           ***
 ***                                                                                ***
 ***                        RESTRICTED RIGHTS LEGEND                                ***
 ***  USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS      ***
 ***  WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN      ***
 ***  SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT      ***
 ***  CLAUSE  AT FAR 52.227-19  OR SUBPARAGRAPH  (C)(1)(II)  OF  THE RIGHTS IN      ***
 ***  TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013.             ***
 ***                                                                                ***
 ***                   COPYRIGHT (C) 1996-2014 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Modified by : VSG (MMM YYYY)
**=======================================================================*/
 
 
#ifndef _SB_DICT_
#define _SB_DICT_
 
#include <Inventor/SbBase.h>
#include <Inventor/SbString.h>
#include <Inventor/SbPList.h>
 
class SbDictEntry;
class SbThreadMutex;
 
//
//  Class: SbDict
//
//  This is a dictionary mapping (unsigned long) integer keys to (void *) data
//  pointers.
//
 
 
{
 public:
  // Constructor
  SbDict(int entries = 251);
  
  // Destructor
  ~SbDict();
  
  // Calls given routine (passing value) for each entry in dictionary.
  //  The order of entries is not guaranteed to mean anything.
  void applyToAll(void (*rtn)(uintptr_t key, void *value));
  
  // Calls given routine (passing value,data) for each entry in dictionary.
  //  The order of entries is not guaranteed to mean anything.
  void applyToAll(void (*rtn)(uintptr_t key, void *value, void *data), void *data);
  
  // Removes all entries from dictionary.
  void clear();
  
  // Enters a key,value pair into the dictionary. Overwrites entry and
  //  returns FALSE if key already exists.
  SbBool enter(uintptr_t key, void *value);
  
  // Finds entry with given key, setting value to point to value.
  //  Returns FALSE if no such entry.
  SbBool find(uintptr_t key, void *&value) const;
  
  // Makes two SbPLists, one for keys and the other for values.
  //  The order of entries is not guaranteed to mean anything.
  void makePList(SbPList &keys, SbPList &values);
  
  // Removes the entry with the given key. Returns FALSE if no such entry.
  SbBool remove(uintptr_t key);
  
 private:
  SbDictEntry *m_entryList; // Hash map
  
  static void addEntryToPLists(uintptr_t key, void *value, void *data);
 
  SbThreadMutex* m_mutex;
};
 
#endif /* _SB_DICT_ */