Document music functions too.

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

diff --git a/lily/include/scm-hash.hh b/lily/include/scm-hash.hh
index 3bc455f88a9c4ba8360467a993eec75438eecb1b..cbaef193be908bd50e34c7059258e3e8430037f8 100644 (file)
--- a/lily/include/scm-hash.hh
+++ b/lily/include/scm-hash.hh
@@ -1,40 +1,60 @@
-/*   
+/*
   scm-hash.hh -- declare Scheme hasher.
-  
+
   source file of the GNU LilyPond music typesetter
-  
-  (c) 1999 Han-Wen Nienhuys <hanwen@cs.uu.nl>
-  
- */
+
+  (c) 1999--2006 Han-Wen Nienhuys <hanwen@xs4all.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.
- */
-class Scheme_hash_table : private Hash_table<SCM,SCM>
+   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:
-  //  bool elem_b (SCM k) const;
-  Hash_table<SCM,SCM>::try_retrieve;
-  Hash_table<SCM,SCM>::elem_b;  
+  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);
-  
+  SCM get (SCM k) const;
+  void remove (SCM k);
   Scheme_hash_table ();
-  void operator = (Scheme_hash_table const &); 
+  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);
 };
 
 #endif /* SCM_HASH_HH */