Implement eq and equal hash tables
authorDavid Vázquez <davazp@gmail.com>
Sun, 16 Feb 2014 05:04:31 +0000 (06:04 +0100)
committerDavid Vázquez <davazp@gmail.com>
Sun, 16 Feb 2014 05:04:31 +0000 (06:04 +0100)
jscl.lisp
src/boot.lisp
src/hash-table.lisp [new file with mode: 0644]
tests/hash-tables.lisp [new file with mode: 0644]

index a5e4294..7c26841 100644 (file)
--- a/jscl.lisp
+++ b/jscl.lisp
@@ -49,6 +49,7 @@
     ("string"        :target)
     ("sequence"      :target)
     ("stream"        :target)
+    ("hash-table"    :target)
     ("print"         :target)
     ("documentation" :target)
     ("misc"          :target)
index 736c07d..d2c505f 100644 (file)
            (value (second pairs)))
        (multiple-value-bind (vars vals store-vars writer-form reader-form)
            (!get-setf-expansion place)
+         (declare (ignorable reader-form))
          ;; TODO: Optimize the expansion a little bit to avoid let*
          ;; or multiple-value-bind when unnecesary.
          `(let* ,(mapcar #'list vars vals)
             (multiple-value-bind ,store-vars
                 ,value
-              ,writer-form
-              ,reader-form)))))
+              ,writer-form)))))
     (t
      `(progn
         ,@(do ((pairs pairs (cddr pairs))
diff --git a/src/hash-table.lisp b/src/hash-table.lisp
new file mode 100644 (file)
index 0000000..e598150
--- /dev/null
@@ -0,0 +1,102 @@
+;;; hash-table.lisp ---
+
+;; JSCL 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 3 of the
+;; License, or (at your option) any later version.
+;;
+;; JSCL 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 JSCL.  If not, see <http://www.gnu.org/licenses/>.
+
+;;; Javascript dictionaries are the natural way to implement Common
+;;; Lisp hash tables. However, there is a big differences betweent
+;;; them which we need to work around. Javascript dictionaries require
+;;; the keys to be strings. To solve that, we map Lisp objects to
+;;; strings such that "equivalent" values map to the same string,
+;;; regarding the equality predicate used (one of `eq', `eql', `equal'
+;;; and `equalp').
+;;;
+
+
+;;; If a hash table has `eq' as test, we need to generate unique
+;;; strings for each Lisp object. To do this, we tag the objects with
+;;; a `$$jscl_id' property. As a special case, numbers are not
+;;; objects, but they can be used for indexin a Javascript dictionary,
+;;; we do not need to tag them.
+(defvar *eq-hash-counter* 0)
+(defun eq-hash (x)
+  (cond
+    ((numberp x)
+     x)
+    (t
+     (unless (in "$$jscl_id" x)
+       (oset (format nil "$~d" *eq-hash-counter*) x "$$jscl_id")
+       (incf *eq-hash-counter*))
+     (oget x "$$jscl_id"))))
+
+;;; We do not have bignums, so eql is equivalent to eq.
+(defun eql-hash (x)
+  (eq-hash x))
+
+
+;;; In the case of equal-based hash tables, we do not store the hash
+;;; in the objects, but compute a hash from the elements it contains.
+(defun equal-hash (x)
+  (typecase x
+    (cons
+     (concat "(" (equal-hash (car x)) (equal-hash (cdr x)) ")"))
+    (string
+     (concat "s" (integer-to-string (length x)) ":" (lisp-to-js x)))
+    (t
+     (eql-hash x))))
+
+(defun equalp-hash (x)
+  ;; equalp is not implemented as predicate. So I am skipping this one
+  ;; by now.
+  )
+
+
+(defun make-hash-table (&key (test #'eql))
+  (let* ((test-fn (fdefinition test))
+         (hash-fn
+          (cond
+            ((eq test-fn #'eq)    #'eq-hash)
+            ((eq test-fn #'eql)   #'eql-hash)
+            ((eq test-fn #'equal) #'equal-hash)
+            ((eq test-fn #'equalp) #'equalp-hash))))
+    ;; TODO: Replace list with a storage-vector and tag
+    ;; conveniently to implemnet `hash-table-p'.
+    `(hash-table ,hash-fn ,(new))))
+
+(defun gethash (key hash-table &optional default)
+  (let ((obj (caddr hash-table))
+        (hash (funcall (cadr hash-table) key)))
+    (values (oget obj hash)
+            (in hash obj))))
+
+(defun sethash (new-value key hash-table)
+  (let ((obj (caddr hash-table))
+        (hash (funcall (cadr hash-table) key)))
+    (oset new-value obj hash)
+    new-value))
+
+
+;;; TODO: Please, implement (DEFUN (SETF foo) ...) syntax!
+(define-setf-expander gethash (key hash-table &optional defaults)
+  (let ((g!key (gensym))
+        (g!hash-table (gensym))
+        (g!defaults (gensym))
+        (g!new-value (gensym)))
+    (values (list g!key g!hash-table g!defaults)            ; temporary variables
+            (list key hash-table defaults)                  ; value forms
+            (list g!new-value)                              ; store variables
+            `(progn
+               (sethash ,g!new-value ,g!key ,g!hash-table)  ; storing form
+               ,g!new-value)              
+            `(gethash ,g!new-value ,g!key ,g!hash-table)    ; accessing form
+            )))
diff --git a/tests/hash-tables.lisp b/tests/hash-tables.lisp
new file mode 100644 (file)
index 0000000..abbec79
--- /dev/null
@@ -0,0 +1,16 @@
+
+(let ((ht (make-hash-table))
+      (key "foo"))
+  (setf (gethash key ht) 10)
+  (test (null (gethash "foo" ht)))
+  (test (equal (gethash key ht) 10))
+  (setf (gethash 'foo ht) "lisp")
+  (test (string= (gethash 'foo ht) "lisp")))
+
+
+(let ((ht (make-hash-table :test #'equal)))
+  (setf (gethash "foo" ht) 10)
+  (test (equal (gethash "foo" ht) 10)))
+
+
+