MeVis/ThirdParty/Sources/Inventor/inventor/lib/database/include/Inventor/SbDict.h

Go to the documentation of this file.

/*
 *
 *  Copyright (C) 2000 Silicon Graphics, Inc.  All Rights Reserved. 
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License as published by the Free Software Foundation; either
 *  version 2.1 of the License, or (at your option) any later version.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  Further, this software is distributed without any warranty that it is
 *  free of the rightful claim of any third person regarding infringement
 *  or the like.  Any license provided herein, whether implied or
 *  otherwise, applies only to this software file.  Patent licenses, if
 *  any, provided herein do not apply to combinations of this program with
 *  other software, or any other product whatsoever.
 * 
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 *  Contact information: Silicon Graphics, Inc., 1600 Amphitheatre Pkwy,
 *  Mountain View, CA  94043, or:
 * 
 *  http://www.sgi.com 
 * 
 *  For further information regarding this notice, see: 
 * 
 *  http://oss.sgi.com/projects/GenInfo/NoticeExplan/
 *
 */


/*
 * Copyright (C) 1990,91   Silicon Graphics, Inc.
 *
 _______________________________________________________________________
 ______________  S I L I C O N   G R A P H I C S   I N C .  ____________
 |
 |   $Revision: 1.1.1.1 $
 |
 |   Description:
 |      This file defines dictionaries. A dictionary maps some sort of
 |      unique key to a data pointer. Keys are unsigned long integers.
 |
 |   Classes:
 |      SbDictEntry, SbDict
 |
 |   Author(s)          : Paul S. Strauss, Nick Thompson
 |
 ______________  S I L I C O N   G R A P H I C S   I N C .  ____________
 _______________________________________________________________________
 */


#ifndef _SB_DICT_
#define _SB_DICT_

#include <Inventor/system/SbSystem.h>

#include <Inventor/SbBasic.h>
#include <Inventor/SbString.h>
#include <Inventor/SbPList.h>


SoINTERNAL class SbDictEntry {
  private:
    unsigned long               key;
    void *              value;

    SbDictEntry *       next;

    SbDictEntry(unsigned long k, void *v)       { key = k; value = v; };

friend class SbDict;
};


SoEXTENDER class INVENTOR_API SbDict {
  public:

    SbDict( int entries = 251 );

    ~SbDict();

    void        applyToAll(void (*rtn)(unsigned long key, void *value) );

    void        applyToAll(void (*rtn)(unsigned long key, void *value, void *data), 
                           void *data );

    void        clear();

    SbBool      enter(unsigned long key, void *value);

    SbBool      find(unsigned long key, void *&value) const;

    void        makePList(SbPList &keys, SbPList &values);

    SbBool      remove(unsigned long key);

  private:
    int                 tableSize;                      
    SbDictEntry *       *buckets;                       

    SbDictEntry *&      findEntry(unsigned long key) const;
    static void         addEntryToPLists(unsigned long key, void *value, void *data);
};

#endif /* _SB_DICT_ */