drop extra 2006-02-06 heading
[bpt/guile.git] / libguile / symbols.c
index 57ead5c..c8b9017 100644 (file)
@@ -1,46 +1,25 @@
-/* Copyright (C) 1995,1996,1997,1998,2000,2001 Free Software Foundation, Inc.
+/* Copyright (C) 1995,1996,1997,1998,2000,2001, 2003, 2004, 2006 Free Software Foundation, Inc.
  * 
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2, or (at your option)
- * any later version.
- * 
- * This program 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 General Public License for more details.
- * 
- * You should have received a copy of the GNU General Public License
- * along with this software; see the file COPYING.  If not, write to
- * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
- * Boston, MA 02111-1307 USA
- *
- * As a special exception, the Free Software Foundation gives permission
- * for additional uses of the text contained in its release of GUILE.
- *
- * The exception is that, if you link the GUILE library with other files
- * to produce an executable, this does not by itself cause the
- * resulting executable to be covered by the GNU General Public License.
- * Your use of that executable is in no way restricted on account of
- * linking the GUILE library code into it.
+ * 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 exception does not however invalidate any other reasons why
- * the executable file might be covered by the GNU General Public License.
- *
- * This exception applies only to the code released by the
- * Free Software Foundation under the name GUILE.  If you copy
- * code from other Free Software Foundation releases into a copy of
- * GUILE, as the General Public License permits, the exception does
- * not apply to the code that you add in this way.  To avoid misleading
- * anyone as to the status of such modified files, you must delete
- * this exception notice from them.
+ * 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.
  *
- * If you write modifications of your own for GUILE, it is your choice
- * whether to permit this exception to apply to your modifications.
- * If you do not wish that, delete this exception notice.  */
+ * 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ */
 
 
 \f
+#if HAVE_CONFIG_H
+#  include <config.h>
+#endif
 
 #include "libguile/_scm.h"
 #include "libguile/chars.h"
@@ -55,6 +34,8 @@
 #include "libguile/hashtab.h"
 #include "libguile/weaks.h"
 #include "libguile/modules.h"
+#include "libguile/read.h"
+#include "libguile/srfi-13.h"
 
 #include "libguile/validate.h"
 #include "libguile/symbols.h"
@@ -83,79 +64,127 @@ SCM_DEFINE (scm_sys_symbols, "%symbols", 0, 0, 0,
 /* {Symbols}
  */
 
+/* In order to optimize reading speed, this function breaks part of
+ * the hashtable abstraction.  The optimizations are:
+ *
+ * 1. The argument string can be compared directly to symbol objects
+ *    without first creating an SCM string object.  (This would have
+ *    been necessary if we had used the hashtable API in hashtab.h.)
+ *
+ * 2. We can use the raw hash value stored in scm_i_symbol_hash (sym)
+ *    to speed up lookup.
+ *
+ * Both optimizations might be possible without breaking the
+ * abstraction if the API in hashtab.c is improved.
+ */
 
-SCM
-scm_mem2symbol (const char *name, size_t len)
+unsigned long
+scm_i_hash_symbol (SCM obj, unsigned long n, void *closure)
 {
-  size_t raw_hash = scm_string_hash ((const unsigned char *) name, len)/2;
-  size_t hash = raw_hash % SCM_VECTOR_LENGTH (symbols);
+  return scm_i_symbol_hash (obj) % n;
+}
 
-  {
-    /* Try to find the symbol in the symbols table */
-
-    SCM l;
-
-    for (l = SCM_VELTS (symbols) [hash]; !SCM_NULLP (l); l = SCM_CDR (l))
-      {
-       SCM sym = SCM_CAAR (l);
-       if (SCM_SYMBOL_HASH (sym) == raw_hash
-           && SCM_SYMBOL_LENGTH (sym) == len)
-         {
-           char *chrs = SCM_SYMBOL_CHARS (sym);
-           size_t i = len;
-
-           while (i != 0)
-             {
-               --i;
-               if (name[i] != chrs[i])
-                 goto next_symbol;
-             }
-
-           return sym;
-         }
-      next_symbol:
-       ;
-      }
-  }
+static SCM
+lookup_interned_symbol (const char *name, size_t len,
+                       unsigned long raw_hash)
+{
+  /* Try to find the symbol in the symbols table */
+  SCM l;
+  unsigned long hash = raw_hash % SCM_HASHTABLE_N_BUCKETS (symbols);
 
-  {
-    /* The symbol was not found - create it. */
+  for (l = SCM_HASHTABLE_BUCKET (symbols, hash);
+       !scm_is_null (l);
+       l = SCM_CDR (l))
+    {
+      SCM sym = SCM_CAAR (l);
+      if (scm_i_symbol_hash (sym) == raw_hash
+         && scm_i_symbol_length (sym) == len)
+       {
+         const char *chrs = scm_i_symbol_chars (sym);
+         size_t i = len;
+
+         while (i != 0)
+           {
+             --i;
+             if (name[i] != chrs[i])
+               goto next_symbol;
+           }
+
+         return sym;
+       }
+    next_symbol:
+      ;
+    }
+
+  return SCM_BOOL_F;
+}
 
-    SCM symbol;
-    SCM cell;
-    SCM slot;
+static SCM
+scm_i_c_mem2symbol (const char *name, size_t len)
+{
+  SCM symbol;
+  size_t raw_hash = scm_string_hash ((const unsigned char *) name, len);
+  size_t hash = raw_hash % SCM_HASHTABLE_N_BUCKETS (symbols);
+
+  symbol = lookup_interned_symbol (name, len, raw_hash);
+  if (symbol != SCM_BOOL_F)
+    return symbol;
 
-    symbol = scm_double_cell (SCM_MAKE_SYMBOL_TAG (len),
-                             (scm_t_bits) scm_gc_strndup (name, len,
-                                                          "symbol"),
-                             raw_hash,
-                             SCM_UNPACK (scm_cons (SCM_BOOL_F, SCM_EOL)));
+  {
+    /* The symbol was not found - create it. */
+    SCM symbol = scm_i_c_make_symbol (name, len, 0, raw_hash,
+                                     scm_cons (SCM_BOOL_F, SCM_EOL));
 
-    slot = SCM_VELTS (symbols) [hash];
-    cell = scm_cons (symbol, SCM_UNDEFINED);
-    SCM_VELTS (symbols) [hash] = scm_cons (cell, slot);
+    SCM slot = SCM_HASHTABLE_BUCKET (symbols, hash);
+    SCM cell = scm_cons (symbol, SCM_UNDEFINED);
+    SCM_SET_HASHTABLE_BUCKET (symbols, hash, scm_cons (cell, slot));
+    SCM_HASHTABLE_INCREMENT (symbols);
+    if (SCM_HASHTABLE_N_ITEMS (symbols) > SCM_HASHTABLE_UPPER (symbols))
+      scm_i_rehash (symbols, scm_i_hash_symbol, 0, "scm_mem2symbol");
 
     return symbol;
   }
 }
 
-SCM
-scm_mem2uninterned_symbol (const char *name, size_t len)
+static SCM
+scm_i_mem2symbol (SCM str)
 {
-  size_t raw_hash = (scm_string_hash ((const unsigned char *) name, len)/2
-                    + SCM_T_BITS_MAX/2 + 1);
-
-  return scm_double_cell (SCM_MAKE_SYMBOL_TAG (len),
-                         (scm_t_bits) scm_gc_strndup (name, len, 
-                                                      "symbol"),
-                         raw_hash,
-                         SCM_UNPACK (scm_cons (SCM_BOOL_F, SCM_EOL)));
+  SCM symbol;
+  const char *name = scm_i_string_chars (str);
+  size_t len = scm_i_string_length (str);
+  size_t raw_hash = scm_string_hash ((const unsigned char *) name, len);
+  size_t hash = raw_hash % SCM_HASHTABLE_N_BUCKETS (symbols);
+
+  symbol = lookup_interned_symbol (name, len, raw_hash);
+  if (symbol != SCM_BOOL_F)
+    return symbol;
+
+  {
+    /* The symbol was not found - create it. */
+    SCM symbol = scm_i_make_symbol (str, 0, raw_hash,
+                                   scm_cons (SCM_BOOL_F, SCM_EOL));
+
+    SCM slot = SCM_HASHTABLE_BUCKET (symbols, hash);
+    SCM cell = scm_cons (symbol, SCM_UNDEFINED);
+    SCM_SET_HASHTABLE_BUCKET (symbols, hash, scm_cons (cell, slot));
+    SCM_HASHTABLE_INCREMENT (symbols);
+    if (SCM_HASHTABLE_N_ITEMS (symbols) > SCM_HASHTABLE_UPPER (symbols))
+      scm_i_rehash (symbols, scm_i_hash_symbol, 0, "scm_mem2symbol");
+
+    return symbol;
+  }
 }
 
-SCM
-scm_str2symbol (const char *str)
+
+static SCM
+scm_i_mem2uninterned_symbol (SCM str)
 {
-  return scm_mem2symbol (str, strlen (str));
+  const char *name = scm_i_string_chars (str);
+  size_t len = scm_i_string_length (str);
+  size_t raw_hash = scm_string_hash ((const unsigned char *) name, len);
+
+  return scm_i_make_symbol (str, SCM_I_F_SYMBOL_UNINTERNED, 
+                           raw_hash, scm_cons (SCM_BOOL_F, SCM_EOL));
 }
 
 SCM_DEFINE (scm_symbol_p, "symbol?", 1, 0, 0, 
@@ -164,7 +193,7 @@ SCM_DEFINE (scm_symbol_p, "symbol?", 1, 0, 0,
            "@code{#f}.")
 #define FUNC_NAME s_scm_symbol_p
 {
-  return SCM_BOOL (SCM_SYMBOLP (obj));
+  return scm_from_bool (scm_is_symbol (obj));
 }
 #undef FUNC_NAME
 
@@ -175,7 +204,7 @@ SCM_DEFINE (scm_symbol_interned_p, "symbol-interned?", 1, 0, 0,
 #define FUNC_NAME s_scm_symbol_interned_p
 {
   SCM_VALIDATE_SYMBOL (1, symbol);
-  return SCM_BOOL (SCM_SYMBOL_INTERNED_P (symbol));
+  return scm_from_bool (scm_i_symbol_is_interned (symbol));
 }
 #undef FUNC_NAME
 
@@ -186,12 +215,8 @@ SCM_DEFINE (scm_make_symbol, "make-symbol", 1, 0, 0,
            "calls to @code{string->symbol} will not return it.")
 #define FUNC_NAME s_scm_make_symbol
 {
-  SCM sym;
   SCM_VALIDATE_STRING (1, name);
-  sym = scm_mem2uninterned_symbol (SCM_STRING_CHARS (name),
-                                  SCM_STRING_LENGTH (name));
-  scm_remember_upto_here_1 (name);
-  return sym;
+  return scm_i_mem2uninterned_symbol (name);
 }
 #undef FUNC_NAME
 
@@ -222,11 +247,8 @@ SCM_DEFINE (scm_symbol_to_string, "symbol->string", 1, 0, 0,
            "@end lisp")
 #define FUNC_NAME s_scm_symbol_to_string
 {
-  SCM str;
   SCM_VALIDATE_SYMBOL (1, s);
-  str = scm_mem2string (SCM_SYMBOL_CHARS (s), SCM_SYMBOL_LENGTH (s));
-  scm_remember_upto_here_1 (s);
-  return str;
+  return scm_i_symbol_substring (s, 0, scm_i_symbol_length (s));
 }
 #undef FUNC_NAME
 
@@ -255,18 +277,25 @@ SCM_DEFINE (scm_string_to_symbol, "string->symbol", 1, 0, 0,
            "@end lisp")
 #define FUNC_NAME s_scm_string_to_symbol
 {
-  SCM sym;
   SCM_VALIDATE_STRING (1, string);
-  sym = scm_mem2symbol (SCM_STRING_CHARS (string),
-                       SCM_STRING_LENGTH (string));
-  scm_remember_upto_here_1 (string);
-  return sym;
+  return scm_i_mem2symbol (string);
 }
 #undef FUNC_NAME
 
-#define MAX_PREFIX_LENGTH 30
+SCM_DEFINE (scm_string_ci_to_symbol, "string-ci->symbol", 1, 0, 0,
+           (SCM str),
+           "Return the symbol whose name is @var{str}.  @var{str} is\n"
+           "converted to lowercase before the conversion is done, if Guile\n"
+           "is currently reading symbols case-insensitively.")
+#define FUNC_NAME s_scm_string_ci_to_symbol
+{
+  return scm_string_to_symbol (SCM_CASE_INSENSITIVE_P
+                              ? scm_string_downcase(str)
+                              : str);
+}
+#undef FUNC_NAME
 
-static int gensym_counter;
+#define MAX_PREFIX_LENGTH 30
 
 SCM_DEFINE (scm_gensym, "gensym", 0, 1, 0,
             (SCM prefix),
@@ -277,30 +306,24 @@ SCM_DEFINE (scm_gensym, "gensym", 0, 1, 0,
            "resetting the counter.")
 #define FUNC_NAME s_scm_gensym
 {
-  char buf[MAX_PREFIX_LENGTH + SCM_INTBUFLEN];
-  char *name = buf;
-  size_t len;
+  static int gensym_counter = 0;
+  
+  SCM suffix, name;
+  int n, n_digits;
+  char buf[SCM_INTBUFLEN];
+
   if (SCM_UNBNDP (prefix))
-    {
-      name[0] = ' ';
-      name[1] = 'g';
-      len = 2;
-    }
-  else
-    {
-      SCM_VALIDATE_STRING (1, prefix);
-      len = SCM_STRING_LENGTH (prefix);
-      if (len > MAX_PREFIX_LENGTH)
-       name = scm_malloc (len + SCM_INTBUFLEN);
-      memcpy (name, SCM_STRING_CHARS (prefix), len);
-    }
-  {
-    int n_digits = scm_iint2str (gensym_counter++, 10, &name[len]);
-    SCM res = scm_mem2symbol (name, len + n_digits);
-    if (name != buf)
-      free (name);
-    return res;
-  }
+    prefix = scm_from_locale_string (" g");
+  
+  /* mutex in case another thread looks and incs at the exact same moment */
+  scm_i_scm_pthread_mutex_lock (&scm_i_misc_mutex);
+  n = gensym_counter++;
+  scm_i_pthread_mutex_unlock (&scm_i_misc_mutex);
+
+  n_digits = scm_iint2str (n, 10, buf);
+  suffix = scm_from_locale_stringn (buf, n_digits);
+  name = scm_string_append (scm_list_2 (prefix, suffix));
+  return scm_string_to_symbol (name);
 }
 #undef FUNC_NAME
 
@@ -310,7 +333,7 @@ SCM_DEFINE (scm_symbol_hash, "symbol-hash", 1, 0, 0,
 #define FUNC_NAME s_scm_symbol_hash
 {
   SCM_VALIDATE_SYMBOL (1, symbol);
-  return scm_ulong2num (SCM_SYMBOL_HASH (symbol));
+  return scm_from_ulong (scm_i_symbol_hash (symbol));
 }
 #undef FUNC_NAME
 
@@ -319,8 +342,8 @@ SCM_DEFINE (scm_symbol_fref, "symbol-fref", 1, 0, 0,
            "Return the contents of @var{symbol}'s @dfn{function slot}.")
 #define FUNC_NAME s_scm_symbol_fref
 {
-  SCM_VALIDATE_SYMBOL (1,s);
-  return SCM_SYMBOL_FUNC (s);
+  SCM_VALIDATE_SYMBOL (1, s);
+  return SCM_CAR (SCM_CELL_OBJECT_3 (s));
 }
 #undef FUNC_NAME
 
@@ -330,8 +353,8 @@ SCM_DEFINE (scm_symbol_pref, "symbol-pref", 1, 0, 0,
            "Return the @dfn{property list} currently associated with @var{symbol}.")
 #define FUNC_NAME s_scm_symbol_pref
 {
-  SCM_VALIDATE_SYMBOL (1,s);
-  return SCM_SYMBOL_PROPS (s);
+  SCM_VALIDATE_SYMBOL (1, s);
+  return SCM_CDR (SCM_CELL_OBJECT_3 (s));
 }
 #undef FUNC_NAME
 
@@ -341,8 +364,8 @@ SCM_DEFINE (scm_symbol_fset_x, "symbol-fset!", 2, 0, 0,
            "Change the binding of @var{symbol}'s function slot.")
 #define FUNC_NAME s_scm_symbol_fset_x
 {
-  SCM_VALIDATE_SYMBOL (1,s);
-  SCM_SET_SYMBOL_FUNC (s, val);
+  SCM_VALIDATE_SYMBOL (1, s);
+  SCM_SETCAR (SCM_CELL_OBJECT_3 (s), val);
   return SCM_UNSPECIFIED;
 }
 #undef FUNC_NAME
@@ -353,62 +376,65 @@ SCM_DEFINE (scm_symbol_pset_x, "symbol-pset!", 2, 0, 0,
            "Change the binding of @var{symbol}'s property slot.")
 #define FUNC_NAME s_scm_symbol_pset_x
 {
-  SCM_VALIDATE_SYMBOL (1,s);
-  SCM_DEFER_INTS;
-  SCM_SET_SYMBOL_PROPS (s, val);
-  SCM_ALLOW_INTS;
+  SCM_VALIDATE_SYMBOL (1, s);
+  SCM_SETCDR (SCM_CELL_OBJECT_3 (s), val);
   return SCM_UNSPECIFIED;
 }
 #undef FUNC_NAME
 
+SCM
+scm_from_locale_symbol (const char *sym)
+{
+  return scm_i_c_mem2symbol (sym, strlen (sym));
+}
 
-/* Converts the given Scheme symbol OBJ into a C string, containing a copy
-   of OBJ's content with a trailing null byte.  If LENP is non-NULL, set
-   *LENP to the string's length.
-
-   When STR is non-NULL it receives the copy and is returned by the function,
-   otherwise new memory is allocated and the caller is responsible for 
-   freeing it via free().  If out of memory, NULL is returned.
-
-   Note that Scheme symbols may contain arbitrary data, including null
-   characters.  This means that null termination is not a reliable way to 
-   determine the length of the returned value.  However, the function always 
-   copies the complete contents of OBJ, and sets *LENP to the length of the
-   scheme symbol (if LENP is non-null).  */
-#define FUNC_NAME "scm_c_symbol2str"
-char *
-scm_c_symbol2str (SCM obj, char *str, size_t *lenp)
+SCM
+scm_from_locale_symboln (const char *sym, size_t len)
 {
-  size_t len;
+  return scm_i_c_mem2symbol (sym, len);
+}
 
-  SCM_ASSERT (SCM_SYMBOLP (obj), obj, SCM_ARG1, FUNC_NAME);
-  len = SCM_SYMBOL_LENGTH (obj);
+SCM
+scm_take_locale_symboln (char *sym, size_t len)
+{
+  SCM res;
+  unsigned long raw_hash;
 
-  if (str == NULL)
+  if (len == (size_t)-1)
+    len = strlen (sym);
+  else
     {
-      /* FIXME: Should we use exported wrappers for malloc (and free), which
-       * allow windows DLLs to call the correct freeing function? */
-      str = (char *) malloc ((len + 1) * sizeof (char));
-      if (str == NULL)
-       return NULL;
+      /* Ensure STR is null terminated.  A realloc for 1 extra byte should
+         often be satisfied from the alignment padding after the block, with
+         no actual data movement.  */
+      sym = scm_realloc (sym, len+1);
+      sym[len] = '\0';
     }
 
-  memcpy (str, SCM_SYMBOL_CHARS (obj), len);
-  scm_remember_upto_here_1 (obj);
-  str[len] = '\0';
+  raw_hash = scm_string_hash ((unsigned char *)sym, len);
+  res = lookup_interned_symbol (sym, len, raw_hash);
+  if (res != SCM_BOOL_F)
+    {
+      free (sym);
+      return res;
+    }
 
-  if (lenp != NULL)
-    *lenp = len;
+  res = scm_i_c_take_symbol (sym, len, 0, raw_hash,
+                            scm_cons (SCM_BOOL_F, SCM_EOL));
 
-  return str;
+  return res;
 }
-#undef FUNC_NAME
 
+SCM
+scm_take_locale_symbol (char *sym)
+{
+  return scm_take_locale_symboln (sym, (size_t)-1);
+}
 
 void
 scm_symbols_prehistory ()
 {
-  symbols = scm_make_weak_key_hash_table (SCM_MAKINUM (1009));
+  symbols = scm_make_weak_key_hash_table (scm_from_int (2139));
   scm_permanent_object (symbols);
 }
 
@@ -416,10 +442,7 @@ scm_symbols_prehistory ()
 void
 scm_init_symbols ()
 {
-  gensym_counter = 0;
-#ifndef SCM_MAGIC_SNARFER
 #include "libguile/symbols.x"
-#endif
 }
 
 /*