source: branches/scripting/j/src/org/armedbear/lisp/java.lisp @ 11368

Last change on this file since 11368 was 11368, checked in by astalla, 13 years ago

New jimplement-interface functionality allowing some sort of limited single-dispatch OO. Changed LispObject.javaObject() to return this instead of signaling an error.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 11.6 KB
Line 
1;;; java.lisp
2;;;
3;;; Copyright (C) 2003-2007 Peter Graves, Andras Simon
4;;; $Id: java.lisp 11368 2008-10-28 21:16:05Z astalla $
5;;;
6;;; This program is free software; you can redistribute it and/or
7;;; modify it under the terms of the GNU General Public License
8;;; as published by the Free Software Foundation; either version 2
9;;; of the License, or (at your option) any later version.
10;;;
11;;; This program is distributed in the hope that it will be useful,
12;;; but WITHOUT ANY WARRANTY; without even the implied warranty of
13;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14;;; GNU General Public License for more details.
15;;;
16;;; You should have received a copy of the GNU General Public License
17;;; along with this program; if not, write to the Free Software
18;;; Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
19
20(in-package "JAVA")
21
22(require "CLOS")
23
24(defun jregister-handler (object event handler &key data count)
25  (%jregister-handler object event handler data count))
26
27(defun jinterface-implementation (interface &rest method-names-and-defs)
28  "Creates and returns an implementation of a Java interface with
29   methods calling Lisp closures as given in METHOD-NAMES-AND-DEFS.
30
31   INTERFACE is either a Java interface or a string naming one.
32
33   METHOD-NAMES-AND-DEFS is an alternating list of method names
34   (strings) and method definitions (closures).
35
36   For missing methods, a dummy implementation is provided that
37   returns nothing or null depending on whether the return type is
38   void or not. This is for convenience only, and a warning is issued
39   for each undefined method."
40  (let ((interface (jclass interface))
41        (implemented-methods
42         (loop for m in method-names-and-defs
43           for i from 0
44           if (evenp i)
45           do (assert (stringp m) (m) "Method names must be strings: ~s" m) and collect m
46           else
47           do (assert (or (symbolp m) (functionp m)) (m) "Methods must be function designators: ~s" m)))
48        (null (make-immediate-object nil :ref)))
49    (loop for method across
50      (jclass-methods interface :declared nil :public t)
51      for method-name = (jmethod-name method)
52      when (not (member method-name implemented-methods :test #'string=))
53      do
54      (let* ((void-p (string= (jclass-name (jmethod-return-type method)) "void"))
55             (arglist (when (plusp (length (jmethod-params method))) '(&rest ignore)))
56             (def `(lambda
57                     ,arglist
58                     ,(when arglist '(declare (ignore ignore)))
59                     ,(if void-p '(values) null))))
60        (warn "Implementing dummy method ~a for interface ~a"
61              method-name (jclass-name interface))
62        (push (coerce def 'function) method-names-and-defs)
63        (push method-name method-names-and-defs)))
64    (apply #'%jnew-proxy interface method-names-and-defs)))
65
66(defun jimplement-interface (interface &rest method-names-and-defs)
67  "Creates and returns an implementation of a Java interface with
68   methods calling Lisp closures as given in METHOD-NAMES-AND-DEFS.
69
70   INTERFACE is either a Java interface or a string naming one.
71
72   METHOD-NAMES-AND-DEFS is an alternating list of method names
73   (strings) and method definitions (closures).
74
75   For missing methods, a dummy implementation is provided that
76   returns nothing or null depending on whether the return type is
77   void or not. This is for convenience only, and a warning is issued
78   for each undefined method."
79  (let ((interface (jclass interface))
80        (implemented-methods
81         (loop for m in method-names-and-defs
82           for i from 0
83           if (evenp i)
84           do (assert (stringp m) (m) "Method names must be strings: ~s" m) and collect m
85           else
86           do (assert (or (symbolp m) (functionp m)) (m) "Methods must be function designators: ~s" m)))
87        (null (make-immediate-object nil :ref)))
88    (loop for method across
89      (jclass-methods interface :declared nil :public t)
90      for method-name = (jmethod-name method)
91      when (not (member method-name implemented-methods :test #'string=))
92      do
93      (let* ((void-p (string= (jclass-name (jmethod-return-type method)) "void"))
94             (arglist '(&rest ignore))
95             (def `(lambda
96                     ,arglist
97                     ,(when arglist '(declare (ignore ignore)))
98                     ,(if void-p '(values) null))))
99        (warn "Implementing dummy method ~a for interface ~a"
100              method-name (jclass-name interface))
101        (push (coerce def 'function) method-names-and-defs)
102        (push method-name method-names-and-defs)))
103    (apply #'%jimplement-interface interface method-names-and-defs)))
104
105(defun jobject-class (obj)
106  "Returns the Java class that OBJ belongs to"
107  (jcall (jmethod "java.lang.Object" "getClass") obj))
108
109(defun jclass-superclass (class)
110  "Returns the superclass of CLASS, or NIL if it hasn't got one"
111  (jcall (jmethod "java.lang.Class" "getSuperclass") (jclass class)))
112
113(defun jclass-interfaces (class)
114  "Returns the vector of interfaces of CLASS"
115  (jcall (jmethod "java.lang.Class" "getInterfaces") (jclass class)))
116
117(defun jclass-interface-p (class)
118  "Returns T if CLASS is an interface"
119  (jcall (jmethod "java.lang.Class" "isInterface") (jclass class)))
120
121(defun jclass-superclass-p (class-1 class-2)
122  "Returns T if CLASS-1 is a superclass or interface of CLASS-2"
123  (jcall (jmethod "java.lang.Class" "isAssignableFrom" "java.lang.Class")
124         (jclass class-1)
125         (jclass class-2)))
126
127(defun jclass-array-p (class)
128  "Returns T if CLASS is an array class"
129  (jcall (jmethod "java.lang.Class" "isArray") (jclass class)))
130
131(defun jarray-component-type (atype)
132  "Returns the component type of the array type ATYPE"
133  (assert (jclass-array-p atype))
134  (jcall (jmethod "java.lang.Class" "getComponentType") atype))
135
136(defun jarray-length (java-array)
137  (jstatic "getLength" "java.lang.reflect.Array" java-array)  )
138
139(defun (setf jarray-ref) (new-value java-array &rest indices)
140  (apply #'jarray-set java-array new-value indices))
141
142(defun jnew-array-from-array (element-type array)
143  "Returns a new Java array with base type ELEMENT-TYPE (a string or a class-ref)
144   initialized from ARRAY"
145  (flet
146    ((row-major-to-index (dimensions n)
147                         (loop for dims on dimensions
148                           with indices
149                           do
150                           (multiple-value-bind (m r) (floor n (apply #'* (cdr dims)))
151                             (push m indices)
152                             (setq n r))
153                           finally (return (nreverse indices)))))
154    (let* ((fill-pointer (when (array-has-fill-pointer-p array) (fill-pointer array)))
155           (dimensions (if fill-pointer (list fill-pointer) (array-dimensions array)))
156           (jarray (apply #'jnew-array element-type dimensions)))
157      (dotimes (i (if fill-pointer fill-pointer (array-total-size array)) jarray)
158        #+maybe_one_day
159        (setf (apply #'jarray-ref jarray (row-major-to-index dimensions i)) (row-major-aref array i))
160        (apply #'(setf jarray-ref) (row-major-aref array i) jarray (row-major-to-index dimensions i))))))
161
162(defun jclass-constructors (class)
163  "Returns a vector of constructors for CLASS"
164  (jcall (jmethod "java.lang.Class" "getConstructors") (jclass class)))
165
166(defun jconstructor-params (constructor)
167  "Returns a vector of parameter types (Java classes) for CONSTRUCTOR"
168  (jcall (jmethod "java.lang.reflect.Constructor" "getParameterTypes") constructor))
169
170(defun jclass-fields (class &key declared public)
171  "Returns a vector of all (or just the declared/public, if DECLARED/PUBLIC is true) fields of CLASS"
172  (let* ((getter (if declared "getDeclaredFields" "getFields"))
173         (fields (jcall (jmethod "java.lang.Class" getter) (jclass class))))
174    (if public (delete-if-not #'jmember-public-p fields) fields)))
175
176(defun jclass-field (class field-name)
177  "Returns the field named FIELD-NAME of CLASS"
178  (jcall (jmethod "java.lang.Class" "getField" "java.lang.String")
179         (jclass class) field-name))
180
181(defun jfield-type (field)
182  "Returns the type (Java class) of FIELD"
183  (jcall (jmethod "java.lang.reflect.Field" "getType") field))
184
185(defun jfield-name (field)
186  "Returns the name of FIELD as a Lisp string"
187  (jcall (jmethod "java.lang.reflect.Field" "getName") field))
188
189(defun jclass-methods (class &key declared public)
190  "Return a vector of all (or just the declared/public, if DECLARED/PUBLIC is true) methods of CLASS"
191  (let* ((getter (if declared "getDeclaredMethods" "getMethods"))
192         (methods (jcall (jmethod "java.lang.Class" getter) (jclass class))))
193    (if public (delete-if-not #'jmember-public-p methods) methods)))
194
195(defun jmethod-params (method)
196  "Returns a vector of parameter types (Java classes) for METHOD"
197  (jcall (jmethod "java.lang.reflect.Method" "getParameterTypes") method))
198
199;; (defun jmethod-return-type (method)
200;;   "Returns the result type (Java class) of the METHOD"
201;;   (jcall (jmethod "java.lang.reflect.Method" "getReturnType") method))
202
203(defun jmethod-name (method)
204  "Returns the name of METHOD as a Lisp string"
205  (jcall (jmethod "java.lang.reflect.Method" "getName") method))
206
207(defun jinstance-of-p (obj class)
208  "OBJ is an instance of CLASS (or one of its subclasses)"
209  (and (java-object-p obj)
210       (jcall (jmethod "java.lang.Class" "isInstance" "java.lang.Object") (jclass class) obj)))
211
212(defun jmember-static-p (member)
213  "MEMBER is a static member of its declaring class"
214  (jstatic (jmethod "java.lang.reflect.Modifier" "isStatic" "int")
215           "java.lang.reflect.Modifier"
216           (jcall (jmethod "java.lang.reflect.Member" "getModifiers") member)))
217
218(defun jmember-public-p (member)
219  "MEMBER is a public member of its declaring class"
220  (jstatic (jmethod "java.lang.reflect.Modifier" "isPublic" "int")
221           "java.lang.reflect.Modifier"
222           (jcall (jmethod "java.lang.reflect.Member" "getModifiers") member)))
223
224(defun jmember-protected-p (member)
225  "MEMBER is a protected member of its declaring class"
226  (jstatic (jmethod "java.lang.reflect.Modifier" "isProtected" "int")
227           "java.lang.reflect.Modifier"
228           (jcall (jmethod "java.lang.reflect.Member" "getModifiers") member)))
229
230(defmethod make-load-form ((object java-object) &optional environment)
231  (declare (ignore environment))
232  (let ((class-name (jclass-name (jclass-of object))))
233    (cond
234     ((string= class-name "java.lang.reflect.Constructor")
235      `(java:jconstructor ,(jclass-name
236                            (jcall (jmethod "java.lang.reflect.Constructor"
237                                            "getDeclaringClass") object))
238                          ,@(loop for arg-type across
239                              (jcall
240                               (jmethod "java.lang.reflect.Constructor"
241                                        "getParameterTypes")
242                               object)
243                              collecting
244                              (jclass-name arg-type))))
245     ((string= class-name "java.lang.reflect.Method")
246      `(java:jmethod ,(jclass-name
247                       (jcall (jmethod "java.lang.reflect.Method"
248                                       "getDeclaringClass") object))
249                     ,(jmethod-name object)
250                     ,@(loop for arg-type across
251                         (jcall
252                          (jmethod "java.lang.reflect.Method"
253                                   "getParameterTypes")
254                          object)
255                         collecting
256                         (jclass-name arg-type))))
257     ((jinstance-of-p object "java.lang.Class")
258      `(java:jclass ,(jcall (jmethod "java.lang.Class" "getName") object)))
259     (t
260      (error "Unknown load-from for ~A" class-name)))))
261
262(provide "JAVA-EXTENSIONS")
Note: See TracBrowser for help on using the repository browser.