0.8.12.4:
[sbcl.git] / src / pcl / defcombin.lisp
index f91b20f..8b71ed4 100644 (file)
 ;;;; and runs the same rule.
 
 (defclass short-method-combination (standard-method-combination)
-     ((operator
-       :reader short-combination-operator
-       :initarg :operator)
-      (identity-with-one-argument
-       :reader short-combination-identity-with-one-argument
-       :initarg :identity-with-one-argument))
+  ((operator
+    :reader short-combination-operator
+    :initarg :operator)
+   (identity-with-one-argument
+    :reader short-combination-identity-with-one-argument
+    :initarg :identity-with-one-argument))
   (:predicate-name short-method-combination-p))
 
 (defun expand-short-defcombin (whole)
@@ -74,7 +74,7 @@
      ',type ',operator ',identity-with-one-arg ',documentation)))
 
 (defun load-short-defcombin (type operator ioa doc)
-  (let* ((truename *load-truename*)
+  (let* ((pathname *load-pathname*)
         (specializers
           (list (find-class 'generic-function)
                 (intern-eql-specializer type)
                           (short-combine-methods
                            type options operator ioa new-method doc))
                         args))
-           :definition-source `((define-method-combination ,type) ,truename)))
+           :definition-source `((define-method-combination ,type) ,pathname)))
     (when old-method
       (remove-method #'find-method-combination old-method))
-    (add-method #'find-method-combination new-method)))
+    (add-method #'find-method-combination new-method)
+    (setf (random-documentation type 'method-combination) doc)
+    type))
 
 (defun short-combine-methods (type options operator ioa method doc)
   (cond ((null options) (setq options '(:most-specific-first)))
        (order (car (method-combination-options combin)))
        (around ())
        (primary ()))
-    (dolist (m applicable-methods)
-      (let ((qualifiers (method-qualifiers m)))
-       (flet ((lose (method why)
-                (invalid-method-error
-                  method
-                  "The method ~S ~A.~%~
-                   The method combination type ~S was defined with the~%~
-                   short form of DEFINE-METHOD-COMBINATION and so requires~%~
-                   all methods have either the single qualifier ~S or the~%~
-                   single qualifier :AROUND."
-                  method why type type)))
-         (cond ((null qualifiers)
-                (lose m "has no qualifiers"))
-               ((cdr qualifiers)
-                (lose m "has more than one qualifier"))
+    (flet ((invalid (gf combin m)
+            (if *in-precompute-effective-methods-p*
+                (return-from compute-effective-method
+                  `(%invalid-qualifiers ',gf ',combin ',m))
+                (invalid-qualifiers gf combin m))))
+      (dolist (m applicable-methods)
+       (let ((qualifiers (method-qualifiers m)))
+         (cond ((null qualifiers) (invalid generic-function combin m))
+               ((cdr qualifiers) (invalid generic-function combin m))
                ((eq (car qualifiers) :around)
                 (push m around))
                ((eq (car qualifiers) type)
                 (push m primary))
-               (t
-                (lose m "has an illegal qualifier"))))))
+               (t (invalid generic-function combin m))))))
     (setq around (nreverse around))
     (ecase order
       (:most-specific-last) ; nothing to be done, already in correct order
                `(,operator ,@(mapcar (lambda (m) `(call-method ,m ()))
                                      primary)))))
       (cond ((null primary)
-            `(error "No ~S methods for the generic function ~S."
-                    ',type ',generic-function))
+            ;; As of sbcl-0.8.0.80 we don't seem to need to need
+            ;; to do anything messy like
+            ;;        `(APPLY (FUNCTION (IF AROUND
+            ;;                              'NO-PRIMARY-METHOD
+            ;;                              'NO-APPLICABLE-METHOD)
+            ;;                           ',GENERIC-FUNCTION
+            ;;                           .ARGS.)
+            ;; here because (for reasons I don't understand at the
+            ;; moment -- WHN) control will never reach here if there
+            ;; are no applicable methods, but instead end up
+            ;; in NO-APPLICABLE-METHODS first.
+            ;;
+            ;; FIXME: The way that we arrange for .ARGS. to be bound 
+            ;; here seems weird. We rely on EXPAND-EFFECTIVE-METHOD-FUNCTION
+            ;; recognizing any form whose operator is %NO-PRIMARY-METHOD
+            ;; as magical, and carefully surrounding it with a
+            ;; LAMBDA form which binds .ARGS. But...
+            ;;   1. That seems fragile, because the magicalness of
+            ;;      %NO-PRIMARY-METHOD forms is scattered around
+            ;;      the system. So it could easily be broken by
+            ;;      locally-plausible maintenance changes like,
+            ;;      e.g., using the APPLY expression above.
+            ;;   2. That seems buggy w.r.t. to MOPpish tricks in
+            ;;      user code, e.g.
+            ;;         (DEFMETHOD COMPUTE-EFFECTIVE-METHOD :AROUND (...)
+            ;;           `(PROGN ,(CALL-NEXT-METHOD) (INCF *MY-CTR*)))
+             `(%no-primary-method ',generic-function .args.))
            ((null around) main-method)
            (t
             `(call-method ,(car around)
                           (,@(cdr around) (make-method ,main-method))))))))
+
+(defmethod invalid-qualifiers ((gf generic-function)
+                              (combin short-method-combination)
+                              method)
+  (let ((qualifiers (method-qualifiers method))
+       (type (method-combination-type combin)))
+    (let ((why (cond
+                ((null qualifiers) "has no qualifiers")
+                ((cdr qualifiers) "has too many qualifiers")
+                (t (aver (and (neq (car qualifiers) type)
+                              (neq (car qualifiers) :around)))
+                   "has an invalid qualifier"))))
+      (invalid-method-error
+       method
+       "The method ~S on ~S ~A.~%~
+       The method combination type ~S was defined with the~%~
+       short form of DEFINE-METHOD-COMBINATION and so requires~%~
+       all methods have either the single qualifier ~S or the~%~
+       single qualifier :AROUND."
+       method gf why type type))))
 \f
 ;;;; long method combinations
 
-(defclass long-method-combination (standard-method-combination)
-     ((function :initarg :function
-               :reader long-method-combination-function)))
-
 (defun expand-long-defcombin (form)
   (let ((type (cadr form))
        (lambda-list (caddr form))
        (make-long-method-combination-function
          type lambda-list method-group-specifiers args-option gf-var
          body)
-      `(load-long-defcombin ',type ',documentation #',function))))
+      `(load-long-defcombin ',type ',documentation #',function
+                           ',args-option))))
 
 (defvar *long-method-combination-functions* (make-hash-table :test 'eq))
 
-(defun load-long-defcombin (type doc function)
+(defun load-long-defcombin (type doc function args-lambda-list)
   (let* ((specializers
           (list (find-class 'generic-function)
                 (intern-eql-specializer type)
                            (make-instance 'long-method-combination
                                           :type type
                                           :options options
+                                          :args-lambda-list args-lambda-list
                                           :documentation doc))
                          args))
             :definition-source `((define-method-combination ,type)
-                             ,*load-truename*))))
+                                 ,*load-pathname*))))
     (setf (gethash type *long-method-combination-functions*) function)
     (when old-method (remove-method #'find-method-combination old-method))
-    (add-method #'find-method-combination new-method)))
+    (add-method #'find-method-combination new-method)
+    (setf (random-documentation type 'method-combination) doc)
+    type))
 
 (defmethod compute-effective-method ((generic-function generic-function)
                                     (combin long-method-combination)
 
 (defun make-long-method-combination-function
        (type ll method-group-specifiers args-option gf-var body)
-  ;;(declare (values documentation function))
   (declare (ignore type))
-  (multiple-value-bind (documentation declarations real-body)
-      (extract-declarations body)
-
+  (multiple-value-bind (real-body declarations documentation)
+      (parse-body body)
     (let ((wrapped-body
            (wrap-method-group-specifier-bindings method-group-specifiers
                                                  declarations
       (values
        documentation
        `(lambda (.generic-function. .method-combination. .applicable-methods.)
-          (progn .generic-function. .method-combination. .applicable-methods.)
+          (declare (ignorable .generic-function.
+                    .method-combination. .applicable-methods.))
           (block .long-method-combination-function. ,wrapped-body))))))
 
 ;; parse-method-group-specifiers parse the method-group-specifiers
 
+(define-condition long-method-combination-error 
+    (reference-condition simple-error)
+  ()
+  (:default-initargs 
+      :references (list '(:ansi-cl :macro define-method-combination))))
+
 (defun wrap-method-group-specifier-bindings
        (method-group-specifiers declarations real-body)
   (let (names
            (push name names)
            (push specializer-cache specializer-caches)
            (push `((or ,@tests)
-                     (if  (equal ,specializer-cache .specializers.)
-                          (return-from .long-method-combination-function.
-                            '(error "More than one method of type ~S ~
-                                     with the same specializers."
-                                    ',name))
-                          (setq ,specializer-cache .specializers.))
-                     (push .method. ,name))
-                   cond-clauses)
+                   (if (and (equal ,specializer-cache .specializers.)
+                            (not (null .specializers.)))
+                       (return-from .long-method-combination-function.
+                         '(error 'long-method-combination-error
+                           :format-control "More than one method of type ~S ~
+                                            with the same specializers."
+                           :format-arguments (list ',name)))
+                       (setq ,specializer-cache .specializers.))
+                   (push .method. ,name))
+                 cond-clauses)
            (when required
              (push `(when (null ,name)
                         (return-from .long-method-combination-function.
-                          '(error "No ~S methods." ',name)))
+                          '(error 'long-method-combination-error
+                            :format-control "No ~S methods." 
+                            :format-arguments (list ',name))))
                      required-checks))
            (loop (unless (and (constantp order)
                               (neq order (setq order (eval order))))
       (dolist (.method. .applicable-methods.)
        (let ((.qualifiers. (method-qualifiers .method.))
              (.specializers. (method-specializers .method.)))
-         (progn .qualifiers. .specializers.)
+         (declare (ignorable .qualifiers. .specializers.))
          (cond ,@(nreverse cond-clauses))))
       ,@(nreverse required-checks)
       ,@(nreverse order-cleanups)
 ;;;
 ;;; At compute-effective-method time, the symbols in the :arguments
 ;;; option are bound to the symbols in the intercept lambda list.
-(defun deal-with-args-option (wrapped-body args-option)
-  (let* ((intercept-lambda-list
-          (let (collect)
-            (dolist (arg args-option)
-              (if (memq arg lambda-list-keywords)
-                  (push arg collect)
-                  (push (gensym) collect)))
-             (nreverse collect)))
-        (intercept-rebindings
-           (loop for arg in args-option
-                 for int in intercept-lambda-list
-                 unless (memq arg lambda-list-keywords)
-                 collect `(,arg ',int))))
-    (setf (cadr wrapped-body)
-         (append intercept-rebindings (cadr wrapped-body)))
+;;;
+;;; FIXME: in here we have not one but two mini-copies of a weird
+;;; hybrid of PARSE-LAMBDA-LIST and PARSE-DEFMACRO-LAMBDA-LIST.
+(defun deal-with-args-option (wrapped-body args-lambda-list)
+  (let ((intercept-rebindings
+        (let (rebindings)
+          (dolist (arg args-lambda-list (nreverse rebindings))
+            (unless (member arg lambda-list-keywords)
+              (typecase arg
+                (symbol (push `(,arg ',arg) rebindings))
+                (cons
+                 (unless (symbolp (car arg))
+                   (error "invalid lambda-list specifier: ~S." arg))
+                 (push `(,(car arg) ',(car arg)) rebindings))
+                (t (error "invalid lambda-list-specifier: ~S." arg)))))))
+       (nreq 0)
+       (nopt 0)
+       (whole nil))
+    ;; Count the number of required and optional parameters in
+    ;; ARGS-LAMBDA-LIST into NREQ and NOPT, and set WHOLE to the
+    ;; name of a &WHOLE parameter, if any.
+    (when (member '&whole (rest args-lambda-list))
+      (error 'simple-program-error
+            :format-control "~@<The value of the :ARGUMENTS option of ~
+                DEFINE-METHOD-COMBINATION is~2I~_~S,~I~_but &WHOLE may ~
+                only appear first in the lambda list.~:>"
+            :format-arguments (list args-lambda-list)))
+    (loop with state = 'required
+         for arg in args-lambda-list do
+           (if (memq arg lambda-list-keywords)
+               (setq state arg)
+               (case state
+                 (required (incf nreq))
+                 (&optional (incf nopt))
+                 (&whole (setq whole arg state 'required)))))
+    ;; This assumes that the head of WRAPPED-BODY is a let, and it
+    ;; injects let-bindings of the form (ARG 'SYM) for all variables
+    ;; of the argument-lambda-list; SYM is a gensym.
+    (aver (memq (first wrapped-body) '(let let*)))
+    (setf (second wrapped-body)
+         (append intercept-rebindings (second wrapped-body)))
+    ;; Be sure to fill out the args lambda list so that it can be too
+    ;; short if it wants to.
+    (unless (or (memq '&rest args-lambda-list)
+               (memq '&allow-other-keys args-lambda-list))
+      (let ((aux (memq '&aux args-lambda-list)))
+       (setq args-lambda-list
+             (append (ldiff args-lambda-list aux)
+                     (if (memq '&key args-lambda-list)
+                         '(&allow-other-keys)
+                         '(&rest .ignore.))
+                     aux))))
+    ;; .GENERIC-FUNCTION. is bound to the generic function in the
+    ;; method combination function, and .GF-ARGS* is bound to the
+    ;; generic function arguments in effective method functions
+    ;; created for generic functions having a method combination that
+    ;; uses :ARGUMENTS.
+    ;;
+    ;; The DESTRUCTURING-BIND binds the parameters of the
+    ;; ARGS-LAMBDA-LIST to actual generic function arguments.  Because
+    ;; ARGS-LAMBDA-LIST may be shorter or longer than the generic
+    ;; function's lambda list, which is only known at run time, this
+    ;; destructuring has to be done on a slighly modified list of
+    ;; actual arguments, from which values might be stripped or added.
+    ;;
+    ;; Using one of the variable names in the body inserts a symbol
+    ;; into the effective method, and running the effective method
+    ;; produces the value of actual argument that is bound to the
+    ;; symbol.
+    `(let ((inner-result. ,wrapped-body)
+          (gf-lambda-list (generic-function-lambda-list .generic-function.)))
+       `(destructuring-bind ,',args-lambda-list
+           (frob-combined-method-args
+            .gf-args. ',gf-lambda-list
+            ,',nreq ,',nopt)
+         ,,(when (memq '.ignore. args-lambda-list)
+             ''(declare (ignore .ignore.)))
+         ;; If there is a &WHOLE in the args-lambda-list, let
+         ;; it result in the actual arguments of the generic-function
+         ;; not the frobbed list.
+         ,,(when whole
+             ``(setq ,',whole .gf-args.))
+         ,inner-result.))))
 
-    ;; Be sure to fill out the intercept lambda list so that it can
-    ;; be too short if it wants to.
-    (cond ((memq '&rest intercept-lambda-list))
-         ((memq '&allow-other-keys intercept-lambda-list))
-         ((memq '&key intercept-lambda-list)
-          (setq intercept-lambda-list
-                (append intercept-lambda-list '(&allow-other-keys))))
-         (t
-          (setq intercept-lambda-list
-                (append intercept-lambda-list '(&rest .ignore.)))))
+;;; Partition VALUES into three sections: required, optional, and the
+;;; rest, according to required, optional, and other parameters in
+;;; LAMBDA-LIST.  Make the required and optional sections NREQ and
+;;; NOPT elements long by discarding values or adding NILs.  Value is
+;;; the concatenated list of required and optional sections, and what
+;;; is left as rest from VALUES.
+(defun frob-combined-method-args (values lambda-list nreq nopt)
+  (loop with section = 'required
+       for arg in lambda-list
+       if (memq arg lambda-list-keywords) do
+         (setq section arg)
+         (unless (eq section '&optional)
+           (loop-finish))
+       else if (eq section 'required)
+         count t into nr
+         and collect (pop values) into required
+       else if (eq section '&optional)
+         count t into no
+         and collect (pop values) into optional
+       finally
+         (flet ((frob (list n m)
+                  (cond ((> n m) (butlast list (- n m)))
+                        ((< n m) (nconc list (make-list (- m n))))
+                        (t list))))
+           (return (nconc (frob required nr nreq)
+                          (frob optional no nopt)
+                          values)))))
 
-    `(let ((inner-result. ,wrapped-body))
-       `(apply #'(lambda ,',intercept-lambda-list
-                  ,,(when (memq '.ignore. intercept-lambda-list)
-                      ''(declare (ignore .ignore.)))
-                  ,inner-result.)
-              .combined-method-args.))))