* Documentation/user/tutorial.itely: Revised (continued).

[lilypond.git] / lily / include / scm-hash.hh

diff --git a/lily/include/scm-hash.hh b/lily/include/scm-hash.hh
index a0382d0446b918f0fd9ee16c2928e17ac4a9e394..c5c2769e67ac646531bb748053d5ef71790a79c6 100644 (file)
--- a/lily/include/scm-hash.hh
+++ b/lily/include/scm-hash.hh
@@ -3,30 +3,64 @@
   
   source file of the GNU LilyPond music typesetter
   
-  (c) 1999 Han-Wen Nienhuys <hanwen@cs.uu.nl>
+  (c) 1999--2004 Han-Wen Nienhuys <hanwen@cs.uu.nl>
   
  */
 
 #ifndef SCM_HASH_HH
 #define SCM_HASH_HH
 
+
 #include "lily-guile.hh"
-#include "hash-table.hh"
 #include "smobs.hh"
 
+
 /**
-   auto resizing hash table. This should come from GUILE.
+   auto resizing hash table. 
+
+   1. ALWAYS USE THIS AS VIA A POINTER, i.e.
+
+   class Foo {
+    Scheme_hash_table * tab;
+   };
+
+   and NOT
+
+   class Foo {
+    Scheme_hash_table tab;
+   }
+
+
+   2. UPON DESTRUCTION, DO
+
+   scm_gc_unprotect_object (tab->self_scm_);
+
  */
-class Scheme_hash_table : public Hash_table<SCM,SCM>
-{
-public:  
+
+class Scheme_hash_table
+{  
+public:
+  bool try_retrieve (SCM key, SCM *val);
+  bool contains (SCM key) const;
+
+  /**
+     WARNING: putting something in assumes responsibility for cleaning
+     up.  */
+  void set (SCM k, SCM v);
+  SCM get (SCM k) const; 
+  void remove (SCM k);
   Scheme_hash_table ();
   void operator = (Scheme_hash_table const &); 
   Scheme_hash_table (Scheme_hash_table const &);
-  virtual ~Scheme_hash_table ();
-  DECLARE_SMOBS;
+
   SCM to_alist () const;
+private:
+  SCM hash_tab_;
+  unsigned elt_count_;
+  
+  DECLARE_SMOBS (Scheme_hash_table,foo);
 };
 
+
 #endif /* SCM_HASH_HH */