exile/v1/src/chuck_table.h

   1 /*----------------------------------------------------------------------------
   2     ChucK Concurrent, On-the-fly Audio Programming Language
   3       Compiler and Virtual Machine
   4
   5     Copyright (c) 2004 Ge Wang and Perry R. Cook.  All rights reserved.
   6       http://chuck.cs.princeton.edu/
   7       http://soundlab.cs.princeton.edu/
   8
   9     This program is free software; you can redistribute it and/or modify
  10     it under the terms of the GNU General Public License as published by
  11     the Free Software Foundation; either version 2 of the License, or
  12     (at your option) any later version.
  13
  14     This program is distributed in the hope that it will be useful,
  15     but WITHOUT ANY WARRANTY; without even the implied warranty of
  16     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17     GNU General Public License for more details.
  18
  19     You should have received a copy of the GNU General Public License
  20     along with this program; if not, write to the Free Software
  21     Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  22     U.S.A.
  23 -----------------------------------------------------------------------------*/
  24
  25 //-----------------------------------------------------------------------------
  26 // file: chuck_table.h
  27 // desc: ...
  28 //
  29 // No algorithm should use these functions directly, because
  30 // programming with void* is too error-prone.  Instead,
  31 // each module should make "wrapper" functions that take
  32 // well-typed arguments and call the TAB_ functions.
  33 //
  34 // author: Andrew Appel (appel@cs.princeton.edu)
  35 // modified: Ge Wang (gewang@cs.princeton.edu)
  36 //           Perry R. Cook (prc@cs.princeton.edu)
  37 // date: Autumn 2002
  38 //-----------------------------------------------------------------------------
  39 #ifndef __CHUCK_TABLE_H__
  40 #define __CHUCK_TABLE_H__
  41
  42
  43 typedef struct TAB_table_ * TAB_table;
  44 typedef long (* TAB_eq_func)( void * lhs, void * rhs );
  45 typedef long (* TAB_hash_func)( void * key );
  46
  47 /* Make a new table mapping "keys" to "values". */
  48 TAB_table TAB_empty(void);
  49 TAB_table TAB_empty2(unsigned long size);
  50 TAB_table TAB_empty3( TAB_eq_func eq, TAB_hash_func hash, unsigned int size );
  51 void TAB_delete( TAB_table t );
  52
  53 /* Enter the mapping "key"->"value" into table "t",
  54  *    shadowing but not destroying any previous binding for "key". */
  55 void TAB_enter(TAB_table t, void *key, void *value);
  56
  57 /* Look up the most recent binding for "key" in table "t" */
  58 void *TAB_look(TAB_table t, void *key);
  59
  60 /* Pop the most recent binding and return its key.
  61  * This may expose another binding for the same key, if there was one. */
  62 void *TAB_pop(TAB_table t);
  63 void *TAB_topv(TAB_table t);
  64
  65
  66 /* Call "show" on every "key"->"value" pair in the table,
  67  *  including shadowed bindings, in order from the most
  68  *  recent binding of any key to the oldest binding in the table */
  69 void TAB_dump(TAB_table t, void (*show)(void *key, void *value));
  70
  71 /* str eq function */
  72 long str_eq( void * lhs, void * rhs );
  73 long str_hash( void * key );
  74
  75 #endif