Changed license terms to the plain LGPL thru-out.
[bpt/guile.git] / oop / goops.scm
index 7cf7c7b..9153bce 100644 (file)
@@ -1,21 +1,20 @@
 ;;; installed-scm-file
 
-;;;;   Copyright (C) 1998, 1999, 2000, 2001 Free Software Foundation, Inc.
+;;;; Copyright (C) 1998,1999,2000,2001,2002, 2003 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 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 program is distributed in the hope that it will be useful,
+;;;; 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 General Public License for more details.
+;;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+;;;; Lesser 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
+;;;; 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 ;;;; 
 \f
 
 ;;;;
 
 (define-module (oop goops)
-  :use-module (oop goops goopscore)
-  :use-module (oop goops util)
-  :use-module (oop goops dispatch)
-  :use-module (oop goops compile)
-  :no-backtrace
-  )
-
-(export                          ; Define the exported symbols of this file
-    goops-version is-a?
-    ensure-metaclass ensure-metaclass-with-supers
-    define-class   class make-class
-    define-generic make-generic ensure-generic
-    define-accessor make-accessor ensure-accessor
-    define-method make-method method add-method!
-    object-eqv? object-equal?
-    class-slot-ref class-slot-set! slot-unbound slot-missing 
-    slot-definition-name  slot-definition-options slot-definition-allocation
-    slot-definition-getter slot-definition-setter slot-definition-accessor
-    slot-definition-init-value slot-definition-init-form
-    slot-definition-init-thunk slot-definition-init-keyword 
-    slot-init-function class-slot-definition
-    method-source
-    compute-cpl compute-std-cpl compute-get-n-set compute-slots
-    compute-getter-method compute-setter-method
-    allocate-instance initialize make-instance make
-    no-next-method  no-applicable-method no-method
-    change-class update-instance-for-different-class
-    shallow-clone deep-clone
-    class-redefinition
-    apply-generic apply-method apply-methods
-    compute-applicable-methods %compute-applicable-methods
-    method-more-specific? sort-applicable-methods
-    class-subclasses class-methods
-    goops-error
-    min-fixnum max-fixnum
-)
-
-;;; *fixme* Should go into goops.c
-
-(export
-    instance?  slot-ref-using-class
-    slot-set-using-class! slot-bound-using-class?
-    slot-exists-using-class? slot-ref slot-set! slot-bound? class-of
-    class-name class-direct-supers class-direct-subclasses
-    class-direct-methods class-direct-slots class-precedence-list
-    class-slots class-environment
-    generic-function-name
-    generic-function-methods method-generic-function method-specializers
-    primitive-generic-generic enable-primitive-generic!
-    method-procedure accessor-method-slot-definition
-    slot-exists? make find-method get-keyword)
+  :export-syntax (define-class class
+                 define-generic define-accessor define-method
+                 define-extended-generic define-extended-generics
+                 method)
+  :export (goops-version is-a?
+           ensure-metaclass ensure-metaclass-with-supers
+          make-class
+          make-generic ensure-generic
+          make-extended-generic
+          make-accessor ensure-accessor
+          process-class-pre-define-generic
+          process-class-pre-define-accessor
+          process-define-generic
+          process-define-accessor
+          make-method add-method!
+          object-eqv? object-equal?
+          class-slot-ref class-slot-set! slot-unbound slot-missing 
+          slot-definition-name  slot-definition-options
+          slot-definition-allocation
+          slot-definition-getter slot-definition-setter
+          slot-definition-accessor
+          slot-definition-init-value slot-definition-init-form
+          slot-definition-init-thunk slot-definition-init-keyword 
+          slot-init-function class-slot-definition
+          method-source
+          compute-cpl compute-std-cpl compute-get-n-set compute-slots
+          compute-getter-method compute-setter-method
+          allocate-instance initialize make-instance make
+          no-next-method  no-applicable-method no-method
+          change-class update-instance-for-different-class
+          shallow-clone deep-clone
+          class-redefinition
+          apply-generic apply-method apply-methods
+          compute-applicable-methods %compute-applicable-methods
+          method-more-specific? sort-applicable-methods
+          class-subclasses class-methods
+          goops-error
+          min-fixnum max-fixnum
+          ;;; *fixme* Should go into goops.c
+          instance?  slot-ref-using-class
+          slot-set-using-class! slot-bound-using-class?
+          slot-exists-using-class? slot-ref slot-set! slot-bound?
+          class-name class-direct-supers class-direct-subclasses
+          class-direct-methods class-direct-slots class-precedence-list
+          class-slots class-environment
+          generic-function-name
+          generic-function-methods method-generic-function method-specializers
+          primitive-generic-generic enable-primitive-generic!
+          method-procedure accessor-method-slot-definition
+          slot-exists? make find-method get-keyword)
+  :replace (<class> <operator-class> <entity-class> <entity>)
+  :re-export (class-of)  ;; from (guile)
+  :no-backtrace)
+
+;; First initialize the builtin part of GOOPS
+(%init-goops-builtins)
+
+;; Then load the rest of GOOPS
+(use-modules (oop goops util)
+            (oop goops dispatch)
+            (oop goops compile))
 
 \f
 (define min-fixnum (- (expt 2 29)))
 (define (define-class-pre-definition keyword exp env)
   (case keyword
     ((#:getter #:setter)
-     (if (defined? exp env)
-        `(define ,exp (ensure-generic ,exp ',exp))
-        `(define ,exp (make-generic ',exp))))
+     `(process-class-pre-define-generic ',exp))
     ((#:accessor)
-     (if (defined? exp env)
-        `(define ,exp (ensure-accessor ,exp ',exp))
-        `(define ,exp (make-accessor ',exp))))
+     `(process-class-pre-define-accessor ',exp))
     (else #f)))
 
+(define (process-class-pre-define-generic name)
+  (let ((var (module-variable (current-module) name)))
+    (if (not (and var
+                 (variable-bound? var)
+                 (is-a? (variable-ref var) <generic>)))
+       (process-define-generic name))))
+
+(define (process-class-pre-define-accessor name)
+  (let ((var (module-variable (current-module) name)))
+    (cond ((or (not var)
+              (not (variable-bound? var)))
+          (process-define-accessor name))
+         ((or (is-a? (variable-ref var) <accessor>)
+              (is-a? (variable-ref var) <extended-generic-with-setter>)))
+         ((is-a? (variable-ref var) <generic>)
+          ;;*fixme* don't mutate an imported object!
+          (variable-set! var (ensure-accessor (variable-ref var) name)))
+         (else
+          (process-define-accessor name)))))
+
 ;;; This code should be implemented in C.
 ;;;
 (define define-class
           (name cadr)
           (slots cdddr))
     
-    (procedure->macro
+    (procedure->memoizing-macro
       (lambda (exp env)
        (cond ((not (top-level-env? env))
               (goops-error "define-class: Only allowed at top level"))
                 `(begin
                    ;; define accessors
                    ,@(pre-definitions (slots exp) env)
-                
-                   ,(if (defined? name env)
-                     
-                        ;; redefine an old class
-                        `(define ,name
-                           (let ((old ,name)
-                                 (new (class ,@(cddr exp) #:name ',name)))
-                             (if (and (is-a? old <class>)
-                                      ;; Prevent redefinition of non-objects
-                                      (memq <object>
-                                            (class-precedence-list old)))
-                                 (class-redefinition old new)
-                                 new)))
-                     
-                        ;; define a new class
-                        `(define ,name
-                           (class ,@(cddr exp) #:name ',name)))))))))))
-
-(define standard-define-class define-class)
+                   ;; update the current-module
+                   (let* ((class (class ,@(cddr exp) #:name ',name))
+                          (var (module-ensure-local-variable!
+                                (current-module) ',name))
+                          (old (and (variable-bound? var)
+                                    (variable-ref var))))
+                     (if (and old
+                              (is-a? old <class>)
+                              (memq <object> (class-precedence-list old)))
+                         (variable-set! var (class-redefinition old class))
+                         (variable-set! var class)))))))))))
+
+(defmacro standard-define-class args
+  `(define-class ,@args))
 
 ;;; (class (SUPER ...) SLOT-DEFINITION ... OPTION ...)
 ;;;
 ;;;
 
 (define define-generic
-  (procedure->macro
+  (procedure->memoizing-macro
     (lambda (exp env)
       (let ((name (cadr exp)))
        (cond ((not (symbol? name))
               (goops-error "bad generic function name: ~S" name))
-             ((defined? name env)
-              `(define ,name
-                 (if (is-a? ,name <generic>)
-                     (make <generic> #:name ',name)
-                     (ensure-generic ,name ',name))))
+             ((top-level-env? env)
+              `(process-define-generic ',name))
              (else
               `(define ,name (make <generic> #:name ',name))))))))
 
+(define (process-define-generic name)
+  (let ((var (module-ensure-local-variable! (current-module) name)))
+    (if (or (not var)
+           (not (variable-bound? var))
+           (is-a? (variable-ref var) <generic>))
+       ;; redefine if NAME isn't defined previously, or is another generic
+       (variable-set! var (make <generic> #:name name))
+       ;; otherwise try to upgrade the object to a generic
+       (variable-set! var (ensure-generic (variable-ref var) name)))))
+
+(define define-extended-generic
+  (procedure->memoizing-macro
+    (lambda (exp env)
+      (let ((name (cadr exp)))
+       (cond ((not (symbol? name))
+              (goops-error "bad generic function name: ~S" name))
+             ((null? (cddr exp))
+              (goops-error "missing expression"))
+             (else
+              `(define ,name (make-extended-generic ,(caddr exp) ',name))))))))
+(define define-extended-generics
+  (procedure->memoizing-macro
+    (lambda (exp env)
+      (let ((names (cadr exp))
+           (prefixes (get-keyword #:prefix (cddr exp) #f)))
+       (if prefixes
+           `(begin
+              ,@(map (lambda (name)
+                       `(define-extended-generic ,name
+                          (list ,@(map (lambda (prefix)
+                                         (symbol-append prefix name))
+                                       prefixes))))
+                     names))
+           (goops-error "no prefixes supplied"))))))
+
 (define (make-generic . name)
   (let ((name (and (pair? name) (car name))))
     (make <generic> #:name name)))
 
+(define (make-extended-generic gfs . name)
+  (let* ((name (and (pair? name) (car name)))
+        (gfs (if (pair? gfs) gfs (list gfs)))
+        (gws? (any (lambda (gf) (is-a? gf <generic-with-setter>)) gfs)))
+    (let ((ans (if gws?
+                  (let* ((sname (and name (make-setter-name name)))
+                         (setters
+                          (apply append
+                                 (map (lambda (gf)
+                                        (if (is-a? gf <generic-with-setter>)
+                                            (list (ensure-generic (setter gf)
+                                                                  sname))
+                                            '()))
+                                      gfs)))
+                         (es (make <extended-generic-with-setter>
+                               #:name name
+                               #:extends gfs
+                               #:setter (make <extended-generic>
+                                          #:name sname
+                                          #:extends setters))))
+                    (extended-by! setters (setter es))
+                    es)
+                  (make <extended-generic>
+                    #:name name
+                    #:extends gfs))))
+      (extended-by! gfs ans)
+      ans)))
+
+(define (extended-by! gfs eg)
+  (for-each (lambda (gf)
+             (slot-set! gf 'extended-by
+                        (cons eg (slot-ref gf 'extended-by))))
+           gfs))
+
+(define (not-extended-by! gfs eg)
+  (for-each (lambda (gf)
+             (slot-set! gf 'extended-by
+                        (delq! eg (slot-ref gf 'extended-by))))
+           gfs))
+
 (define (ensure-generic old-definition . name)
   (let ((name (and (pair? name) (car name))))
     (cond ((is-a? old-definition <generic>) old-definition)
          (else (make <generic> #:name name)))))
 
 (define define-accessor
-  (procedure->macro
+  (procedure->memoizing-macro
     (lambda (exp env)
       (let ((name (cadr exp)))
        (cond ((not (symbol? name))
               (goops-error "bad accessor name: ~S" name))
-             ((defined? name env)
-              `(define ,name
-                 (if (and (is-a? ,name <generic-with-setter>)
-                          (is-a? (setter ,name) <generic>))
-                     (make-accessor ',name)
-                     (ensure-accessor ,name ',name))))
+             ((top-level-env? env)
+              `(process-define-accessor ',name))
              (else
               `(define ,name (make-accessor ',name))))))))
 
+(define (process-define-accessor name)
+  (let ((var (module-ensure-local-variable! (current-module) name)))
+    (if (or (not var)
+           (not (variable-bound? var))
+           (is-a? (variable-ref var) <accessor>)
+           (is-a? (variable-ref var) <extended-generic-with-setter>))
+       ;; redefine if NAME isn't defined previously, or is another accessor
+       (variable-set! var (make-accessor name))
+       ;; otherwise try to upgrade the object to an accessor
+       (variable-set! var (ensure-accessor (variable-ref var) name)))))
+
 (define (make-setter-name name)
   (string->symbol (string-append "setter:" (symbol->string name))))
 
 (define (make-accessor . name)
   (let ((name (and (pair? name) (car name))))
-    (make <generic-with-setter>
+    (make <accessor>
          #:name name
          #:setter (make <generic>
                         #:name (and name (make-setter-name name))))))
 
 (define (ensure-accessor proc . name)
   (let ((name (and (pair? name) (car name))))
-    (cond ((is-a? proc <generic-with-setter>)
-          (if (is-a? (setter proc) <generic>)
-              proc
-              (upgrade-generic-with-setter proc (setter proc))))
+    (cond ((and (is-a? proc <accessor>)
+               (is-a? (setter proc) <generic>))
+          proc)
+         ((is-a? proc <generic-with-setter>)
+          (upgrade-accessor proc (setter proc)))
          ((is-a? proc <generic>)
-          (upgrade-generic-with-setter proc (make-generic name)))
+          (upgrade-accessor proc (make-generic name)))
          ((procedure-with-setter? proc)
-          (make <generic-with-setter>
+          (make <accessor>
                 #:name name
                 #:default (procedure proc)
                 #:setter (ensure-generic (setter proc) name)))
          (else
           (make-accessor name)))))
 
-(define (upgrade-generic-with-setter generic setter)
-  (let ((methods (generic-function-methods generic))
-       (gws (make <generic-with-setter>
+(define (upgrade-accessor generic setter)
+  (let ((methods (slot-ref generic 'methods))
+       (gws (make (if (is-a? generic <extended-generic>)
+                      <extended-generic-with-setter>
+                      <accessor>)
                   #:name (generic-function-name generic)
+                  #:extended-by (slot-ref generic 'extended-by)
                   #:setter setter)))
+    (if (is-a? generic <extended-generic>)
+       (let ((gfs (slot-ref generic 'extends)))
+         (not-extended-by! gfs generic)
+         (slot-set! gws 'extends gfs)
+         (extended-by! gfs gws)))
     ;; Steal old methods
     (for-each (lambda (method)
                (slot-set! method 'generic-function gws))
 (define method
   (letrec ((specializers
            (lambda (ls)
-             (cond ((null? ls) '('()))
+             (cond ((null? ls) (list (list 'quote '())))
                    ((pair? ls) (cons (if (pair? (car ls))
                                          (cadar ls)
                                          '<top>)
 
 (define (compute-new-list-of-methods gf new)
   (let ((new-spec (method-specializers new))
-       (methods  (generic-function-methods gf)))
+       (methods  (slot-ref gf 'methods)))
     (let loop ((l methods))
       (if (null? l)
          (cons new methods)
 ;;; Methods to compare objects
 ;;;
 
+(define-method (equal? x y) #f)
+
 (define-method (object-eqv? x y)    #f)
 (define-method (object-equal? x y)  (eqv? x y))
 
 (define-method (display o file) 
   (write-object o file))
 
+;;;
+;;; Handling of duplicate bindings in the module system
+;;;
+
+(define-method (merge-generics (module <module>)
+                              (name <symbol>)
+                              (int1 <module>)
+                              (val1 <top>)
+                              (int2 <module>)
+                              (val2 <top>)
+                              (var <top>)
+                              (val <top>))
+  #f)
+
+(define-method (merge-generics (module <module>)
+                              (name <symbol>)
+                              (int1 <module>)
+                              (val1 <generic>)
+                              (int2 <module>)
+                              (val2 <generic>)
+                              (var <top>)
+                              (val <boolean>))
+  (and (not (eq? val1 val2))
+       (make-variable (make-extended-generic (list val2 val1) name))))
+
+(define-method (merge-generics (module <module>)
+                              (name <symbol>)
+                              (int1 <module>)
+                              (val1 <generic>)
+                              (int2 <module>)
+                              (val2 <generic>)
+                              (var <top>)
+                              (gf <extended-generic>))
+  (and (not (memq val2 (slot-ref gf 'extends)))
+       (begin
+        (slot-set! gf
+                   'extends
+                   (cons val2 (delq! val2 (slot-ref gf 'extends))))
+        (slot-set! val2
+                   'extended-by
+                   (cons gf (delq! gf (slot-ref val2 'extended-by))))
+        var)))
+
+(module-define! duplicate-handlers 'merge-generics merge-generics)
+
+(define-method (merge-accessors (module <module>)
+                               (name <symbol>)
+                               (int1 <module>)
+                               (val1 <top>)
+                               (int2 <module>)
+                               (val2 <top>)
+                               (var <top>)
+                               (val <top>))
+  #f)
+
+(define-method (merge-accessors (module <module>)
+                               (name <symbol>)
+                               (int1 <module>)
+                               (val1 <accessor>)
+                               (int2 <module>)
+                               (val2 <accessor>)
+                               (var <top>)
+                               (val <top>))
+  (merge-generics module name int1 val1 int2 val2 var val))
+
+(module-define! duplicate-handlers 'merge-accessors merge-accessors)
+
 ;;;
 ;;; slot access
 ;;;
                                             can-go-in-now))))
                (loop
                 (filter (lambda (x) (not (eq? x choice)))
-                            elements)
+                        elements)
                 constraints
                 (append result (list choice)))))))))
 
        (set-procedure-property! generic 'name name))
     ))
 
+(define-method (initialize (eg <extended-generic>) initargs)
+  (next-method)
+  (slot-set! eg 'extends (get-keyword #:extends initargs '())))
+
 (define dummy-procedure (lambda args *unspecified*))
 
 (define-method (initialize (method <method>) initargs)