summaryrefslogtreecommitdiff
path: root/protocols.lisp
blob: 685afd1444a4c64e33a14707987ce1d66ffe6604 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
(in-package #:mulk.protocols)


(defvar *protocols* (make-hash-table))


(defun find-protocol (name &optional (errorp t))
  (find-class name errorp))


(defun (setf find-protocol) (protocol name &optional errorp)
  (declare (ignore errorp))
  (setf (find-class name) protocol))


(defun protocol-name (protocol)
  (class-name protocol))


(defvar *alleged-conformance* (make-hash-table :test 'equal))
(defvar *actual-conformance* (make-hash-table :test 'equal))


(defun conforms-to-p (class protocol)
  (let ((class (etypecase class
                 (class class)
                 (symbol (find-class class))))
        (protocol (etypecase protocol
                    (protocol protocol)
                    (symbol (find-protocol protocol)))))
    (or (gethash (cons class protocol) *alleged-conformance* nil)
        (some #'(lambda (x) (conforms-to-p x protocol))
              (class-direct-superclasses class)))))


(defun really-conforms-to-p (class protocol)
  (let ((class (etypecase class
                 (class class)
                 (symbol (find-class class))))
        (protocol (etypecase protocol
                    (protocol protocol)
                    (symbol (find-protocol protocol)))))
    (or (gethash (cons class protocol) *actual-conformance* nil)
        (some #'(lambda (x) (really-conforms-to-p x protocol))
              (class-direct-superclasses class)))))


(defgeneric %conforms-to-p (class protocol))

(defmethod %conforms-to-p ((class t) (protocol t))
  nil)


(defgeneric %really-conforms-to-p (class protocol))

(defmethod %really-conforms-to-p ((class t) (protocol t))
  nil)


(defclass protocol (standard-class)
  ((methods :initarg :methods
            :reader protocol-methods)))


(defmethod validate-superclass (class (superclass protocol))
  t)


(defmethod validate-superclass ((class standard-class) (superclass protocol))
  t)


(defmethod validate-superclass ((class protocol) (superclass standard-class))
  t)


(defmacro define-protocol (name superprotocols methods &rest options)
  "Define a new protocol.

superprotocols ::= (*name*\\*)

methods ::= ((method-name [\\* | class-name]\\*)\\*)"
  `(defclass ,name ,superprotocols
        ()
     (:metaclass protocol)
     (:methods ,@methods)
     ,@options))


(defun ensure-conformance (class-name protocol-designator)
  (let* ((protocol (typecase protocol-designator
                     (symbol (find-protocol protocol-designator))
                     (t protocol-designator)))
         (conforming-p nil))
    (with-accessors ((name protocol-name)
                     (superprotocols class-direct-superclasses)
                     (methods protocol-methods))
        protocol
      (loop for method in methods
            for (name . raw-argument-class-list) = method
            for argument-class-list = (substitute class-name
                                                  '*
                                                  raw-argument-class-list)
            for real-argument-class-list = (mapcar #'find-class
                                                   argument-class-list)
            for (applicable-methods methods-determinable-p) =
                (multiple-value-list
                 (funcall #'compute-applicable-methods-using-classes
                          (fdefinition name)
                          real-argument-class-list))
            when (and methods-determinable-p (null applicable-methods))
              collect method into missing-methods
              and do (warn (make-condition 'simple-style-warning
                                :format-control "Class ~A does not ~
                                                 implement method ~A ~
                                                 with argument types ~
                                                 ~A as required by ~
                                                 protocol ~A."
                                :format-arguments (list class-name
                                                        (first method)
                                                        real-argument-class-list
                                                        (protocol-name protocol))))
            unless methods-determinable-p
              do (warn (make-condition 'simple-style-warning
                            :format-control "Could not check whether ~
                                             class ~A implements ~
                                             method ~A with argument ~
                                             types ~A as required by ~
                                             protocol ~A.  Assuming it ~
                                             does."
                            :format-arguments (list class-name
                                                    (first method)
                                                    real-argument-class-list
                                                    (protocol-name protocol))))
            finally (setq conforming-p (null missing-methods)))
      (let ((really-conforming-p
             (and conforming-p
                  (every #'identity
                         ;; We have to use MAPCAR because we
                         ;; don't want short-circuiting.
                         (mapcar #'(lambda (superprotocol)
                                     (or (not (typep superprotocol 'protocol))
                                         (ensure-conformance class-name
                                                             superprotocol)))
                                 superprotocols)))))
        (setf (gethash (cons (find-class class-name) protocol)
                       *alleged-conformance*)
              t)
        (setf (gethash (cons (find-class class-name) protocol)
                       *actual-conformance*)
              really-conforming-p)
        (let ((original-class (find-class class-name)))
          (unless (subtypep original-class protocol)
            (handler-case
                (let* ((new-class-name (gensym (symbol-name class-name)))
                       (temporary-class-name (gensym (symbol-name class-name)))
                       (new-class
                        (ensure-class
                             temporary-class-name
                             :direct-superclasses (list original-class protocol)
                             :metaclass (class-of original-class))))
                  (setf (class-name original-class) new-class-name)
                  (setf (class-name new-class) class-name)
                  (setf (find-class new-class-name) original-class)
                  (setf (find-class class-name) new-class))
              (serious-condition ()
                  (warn (make-condition
                             'simple-style-warning
                             :format-control "Could not add protocol ~A ~
                                              as a superclass of ~A. ~
                                              Most probably, the metaclasses ~
                                              are incompatible.  (See the MOP ~
                                              specification, specifically the ~
                                              part about VALIDATE-SUPERCLASS.)"
                             :format-arguments (list protocol
                                                     original-class)))))))))))


(defmacro implement-protocols (class protocols &body definitions)
  `(progn
     ,@definitions
     ,@(mapcar #'(lambda (protocol)
                   `(ensure-conformance ',class ',protocol))
               protocols)))