source: trunk/abcl/contrib/jss/invoke.lisp @ 14947

Last change on this file since 14947 was 14947, checked in by mevenson, 14 months ago

JSS syntax for fields (Alan Ruttenberg)

<thing> is either {<lisp expression>} or a class name or abbreviation that find-java-class can use

If <thing> is a lisp expression, then it is evaluated (in the lexical environment) and used as an instance
If <thing> is a class name the result of find-java-class is used and a static field access is done.

<field> is either {<lisp expression} or string

If <field> is a lisp expression it should evaluate to a string that names a field
If <field> is a string (no quotes) it is used as the field name

eg. #"" -> (get-java-field (find-java-class ' "baz" t)

#"{foo}.baz" -> (get-java-field (find-java-class foo) "baz" t)

From <>.

File size: 30.5 KB
1;; Copyright (C) 2005 Alan Ruttenberg
2;; Copyright (C) 2011-2 Mark Evenson
4;; Since JSS 1.0 was largely derivative of the Jscheme System, the
5;; current system is licensed under the same terms, namely:
7;; This software is provided 'as-is', without any express or
8;; implied warranty.
10;; In no event will the author be held liable for any damages
11;; arising from the use of this software.
13;; Permission is granted to anyone to use this software for any
14;; purpose, including commercial applications, and to alter it
15;; and redistribute it freely, subject to the following
16;; restrictions:
18;; 1. The origin of this software must not be misrepresented; you
19;;    must not claim that you wrote the original software. If you
20;;    use this software in a product, an acknowledgment in the
21;;    product documentation would be appreciated but is not
22;;    required.
24;; 2. Altered source versions must be plainly marked as such, and
25;;    must not be misrepresented as being the original software.
27;; 3. This notice may not be removed or altered from any source
28;;    distribution.
31;; The dynamic dispatch of the java.lang.reflect package is used to
32;; make it real easy, if perhaps less efficient, to write Java code
33;; since you don't need to be bothered with imports, or with figuring
34;; out which method to call.  The only time that you need to know a
35;; class name is when you want to call a static method, or a
36;; constructor, and in those cases, you only need to know enough of
37;; the class name that is unique wrt to the classes on your classpath.
39;; Java methods look like this: #"toString". Java classes are
40;; represented as symbols, which are resolved to the appropriate java
41;; class name. When ambiguous, you need to be more specific. A simple example:
43;; (let ((sw (new 'StringWriter)))
44;;   (#"write" sw "Hello ")
45;;   (#"write" sw "World")
46;;   (print (#"toString" sw)))
48;; What's happened here? First, all the classes in all the jars in the
49;; classpath have been collected.  For each class a.b.C.d, we have
50;; recorded that b.c.d, b.C.d, C.d, c.d, and d potentially refer to
51;; this class. In your call to new, as long as the symbol can refer to
52;; only one class, we use that class. In this case, it is
53;; You could also have written (new
54;; 'io.stringwriter), (new '|io.StringWriter|), (new
55;; '
57;; the call (#"write" sw "Hello "), uses the code in to
58;; call the method named "write" with the arguments sw and "Hello ".
59;; JSS figures out the right java method to call, and calls it.
61;; If you want to do a raw java call, use #0"toString". Raw calls
62;; return their results as Java objects, avoiding doing the usual Java
63;; object to Lisp object conversions that ABCL does.
65;; (with-constant-signature ((name jname raw?)*) &body body)
66;; binds a macro which expands to a jcall, promising that the same method
67;; will be called every time. Use this if you are making a lot of calls and
68;; want to avoid the overhead of a the dynamic dispatch.
69;; e.g. (with-constant-signature ((tostring "toString"))
70;;        (time (dotimes (i 10000) (tostring "foo"))))
71;; runs about 3x faster than (time (dotimes (i 10000) (#"toString" "foo")))
73;; (with-constant-signature ((tostring "toString" t)) ...) will cause the
74;; toString to be a raw java call. see get-all-jar-classnames below for an example.
76;; Implementation is that the first time the function is called, the
77;; method is looked up based on the arguments passed, and thereafter
78;; that method is called directly.  Doesn't work for static methods at
79;; the moment (lazy)
81;; (japropos string) finds all class names matching string
82;; (jcmn class-name) lists the names of all methods for the class
84;; TODO
85;;   - Make with-constant-signature work for static methods too.
86;;   - #2"toString" to work like function scoped (with-constant-signature ((tostring "toString")) ...)
87;;   - #3"toString" to work like runtime scoped (with-constant-signature ((tostring "toString")) ...)
88;;      (both probably need compiler support to work)
89;;   - Maybe get rid of second " in reader macro. #"toString looks nicer, but might
90;;     confuse lisp mode.
91;;   - write jmap, analogous to map, but can take java collections, java arrays etc.
92;;   - write loop clauses for java collections.
93;;   - Register classes in .class files below classpath directories (when :wild-inferiors works)
94;;   - Make documentation like Edi Weitz
96;; Thanks: Peter Graves, Jscheme developers, Mike Travers for skij, 
97;; Andras Simon for jfli-abcl which bootstrapped me and taught me how to do
98;; get-all-jar-classnames
101;; changelog
103;; Sat January 28, 2006, alanr:
105;; Change imports strategy. Only index by last part of class name,
106;; case insensitive. Make the lookup-class-name logic be a bit more
107;; complicated. This substantially reduces the time it takes to do the
108;; auto imports and since class name lookup is relatively infrequent,
109;; and in any case cached, this doesn't effect run time speed.  (did
110;; try caching, but didn't pay - more time was spent reading and
111;; populating large hash table)
113;; Split class path by ";" in addition to ":" for windows.
115;; Tested on windows, linux.
117;; 2011-05-21 Mark Evenson
118;;   "ported" to native ABCL without needing the jscheme.jar or bsh-2.0b4.jar
120(in-package :jss)
122(eval-when (:compile-toplevel :load-toplevel :execute)
123  (defvar *do-auto-imports* t 
124    "Whether to automatically introspect all Java classes on the classpath when JSS is loaded."))
126(defvar *muffle-warnings* t)
128(defvar *imports-resolved-classes* (make-hash-table :test 'equalp))
130(defun find-java-class (name)
131  "Returns the java.lang.Class representation of NAME.
133NAME can either string or a symbol according to the usual JSS conventions."
134  (jclass (maybe-resolve-class-against-imports name)))
136(defmacro invoke-add-imports (&rest imports)
137  "Push these imports onto the search path. If multiple, earlier in list take precedence"
138  `(eval-when (:compile-toplevel :load-toplevel :execute)
139     (clrhash *imports-resolved-classes*)
140     (dolist (i (reverse ',imports))
141       (setq *imports-resolved-classes* (delete i *imports-resolved-classes* :test 'equal))
142       )))
144(defun clear-invoke-imports ()
145  (clrhash *imports-resolved-classes*))
147(defun maybe-resolve-class-against-imports (classname)
148  (or (gethash (string classname) *imports-resolved-classes*)
149      (let ((found (lookup-class-name classname)))
150        (if found
151            (progn 
152              (setf (gethash classname *imports-resolved-classes*) found)
153              found)
154            (string classname)))))
156(defvar *class-name-to-full-case-insensitive* (make-hash-table :test 'equalp))
158;; This is the function that calls invoke to call your java
159;; method. The first argument is the method name or 'new. The second
160;; is the object you are calling it on, followed by the rest of the
161;; arguments. If the "object" is a symbol, then that symbol is assumed
162;; to be a java class, and a static method on the class is called,
163;; otherwise a regular method is called.
165(defun invoke (method object &rest args)
166  (invoke-restargs method object args))
168(defun invoke-restargs (method object args &optional (raw? nil))
169  (let* ((object-as-class-name 
170          (if (symbolp object) (maybe-resolve-class-against-imports object)))
171         (object-as-class 
172          (if object-as-class-name (find-java-class object-as-class-name))))
173    (if (eq method 'new)
174        (apply #'jnew (or object-as-class-name object) args)
175        (if raw?
176            (if (symbolp object)
177                (apply #'jstatic-raw method object-as-class  args)
178                (apply #'jcall-raw method object  args))
179            (if (symbolp object)
180                (apply #'jstatic method object-as-class args)
181                (apply #'jcall method object args))))))
183(defconstant +set-accessible+ 
184  (jmethod "java.lang.reflect.AccessibleObject" "setAccessible" "boolean"))
186(defun invoke-find-method (method object args)
187  (let ((result 
188         (if (symbolp object)
189                ;;; static method
190             (apply #'jmethod (lookup-class-name object) 
191                    method (mapcar #'jobject-class args))
192                  ;;; instance method
193             (apply #'jresolve-method 
194                    method object args))))
195    (jcall +set-accessible+ result +true+)
196    result))
198;; This is the reader macro for java methods. it translates the method
199;; into a lambda form that calls invoke. Which is nice because you
200;; can, e.g. do this: (mapcar #"toString" list-of-java-objects). The reader
201;; macro takes one arg. If 0, then jstatic-raw is called, so that abcl doesn't
202;; automagically convert the returned java object into a lisp object. So
203;; #0"toString" returns a java.lang.String object, where as #"toString" returns
204;; a regular Lisp string as ABCL converts the Java string to a Lisp string.
206(eval-when (:compile-toplevel :load-toplevel :execute)
207  (defun read-invoke (stream char arg) 
208    (unread-char char stream)
209    (let ((name (read stream)))
210      (if (or (find #\. name) (find #\{ name))
211    (jss-transform-to-field name)
212    (let ((object-var (gensym))
213    (args-var (gensym)))
214      `(lambda (,object-var &rest ,args-var) 
215         (invoke-restargs ,name  ,object-var ,args-var ,(eql arg 0)))))))
216  (set-dispatch-macro-character #\# #\" 'read-invoke))
218(defmacro with-constant-signature (fname-jname-pairs &body body)
219  "Expand all references to FNAME-JNAME-PAIRS in BODY into static function calls promising that the same function bound in the FNAME-JNAME-PAIRS will be invoked with the same argument signature.
221FNAME-JNAME-PAIRS is a list of (symbol function &optional raw)
222elements where symbol will be the symbol bound to the method named by
223the string function.  If the optional parameter raw is non-nil, the
224result will be the raw JVM object, uncoerced by the usual conventions.
226Use this macro if you are making a lot of calls and
227want to avoid the overhead of the dynamic dispatch."
229  (if (null fname-jname-pairs)
230      `(progn ,@body)
231      (destructuring-bind ((fname jname &optional raw) &rest ignore) fname-jname-pairs
232        (declare (ignore ignore))
233        (let ((varname (gensym)))
234          `(let ((,varname nil))
235             (macrolet ((,fname (&rest args)
236                          `(if ,',varname
237                               (if ,',raw
238                                   (jcall-raw ,',varname ,@args)
239                                   (jcall ,',varname ,@args))
240                               (progn
241                                 (setq ,',varname (invoke-find-method ,',jname ,(car args) (list ,@(rest args))))
242                                 (if ,',raw
243                                     (jcall-raw ,',varname ,@args)
244                                     (jcall ,',varname ,@args))))))
245               (with-constant-signature ,(cdr fname-jname-pairs)
246                 ,@body)))))))
248(defun lookup-class-name (name &key
249                                 (table *class-name-to-full-case-insensitive*)
250                                 (muffle-warning nil)
251                                 (return-ambiguous nil))
252  (setq name (string name))
253  (let* (;; cant (last-name-pattern (#"compile" '|java.util.regex.Pattern| ".*?([^.]*)$"))
254         ;; reason: bootstrap - the class name would have to be looked up...
255         (last-name-pattern (load-time-value (jstatic (jmethod "java.util.regex.Pattern" "compile"
256                                                               (jclass "java.lang.String"))
257                                                      (jclass "java.util.regex.Pattern") 
258                                                      ".*?([^.]*)$")))
259         (last-name 
260          (let ((matcher (#0"matcher" last-name-pattern name)))
261            (#"matches" matcher)
262            (#"group" matcher 1))))
263    (let* ((bucket (gethash last-name *class-name-to-full-case-insensitive*))
264           (bucket-length (length bucket)))
265      (or (find name bucket :test 'equalp)
266          (flet ((matches-end (end full test)
267                   (= (+ (or (search end full :from-end t :test test) -10)
268                         (length end))
269                      (length full)))
270                 (ambiguous (choices)
271       (if return-ambiguous 
272           (return-from lookup-class-name choices)
273           (error "Ambiguous class name: ~a can be ~{~a~^, ~}" name choices))))
274            (if (zerop bucket-length)
275    (progn (unless muffle-warning (warn "can't find class named ~a" name)) nil)
276                (let ((matches (loop for el in bucket when (matches-end name el 'char=) collect el)))
277                  (if (= (length matches) 1)
278                      (car matches)
279                      (if (= (length matches) 0)
280                          (let ((matches (loop for el in bucket when (matches-end name el 'char-equal) collect el)))
281                            (if (= (length matches) 1)
282                                (car matches)
283                                (if (= (length matches) 0)
284            (progn (unless muffle-warning (warn "can't find class named ~a" name)) nil)
285                                    (ambiguous matches))))
286                          (ambiguous matches))))))))))
288(defun get-all-jar-classnames (jar-file-name)
289  (let* ((jar (jnew (jconstructor "java.util.jar.JarFile" (jclass "java.lang.String")) (namestring (truename jar-file-name))))
290         (entries (#"entries" jar)))
291    (with-constant-signature ((matcher "matcher" t) (substring "substring")
292                              (jreplace "replace" t) (jlength "length")
293                              (matches "matches") (getname "getName" t)
294                              (next "nextElement" t) (hasmore "hasMoreElements")
295                              (group "group"))
296      (loop while (hasmore entries)
297         for name =  (getname (next entries))
298         with class-pattern = (jstatic "compile" "java.util.regex.Pattern" ".*\\.class$")
299         with name-pattern = (jstatic "compile" "java.util.regex.Pattern" ".*?([^.]*)$")
300         when (matches (matcher class-pattern name))
301         collect
302           (let* ((fullname (substring (jreplace name #\/ #\.) 0 (- (jlength name) 6)))
303                  (matcher (matcher name-pattern fullname))
304                  (name (progn (matches matcher) (group matcher 1))))
305             (cons name fullname))
306           ))))
308(defun jar-import (file)
309  "Import all the Java classes contained in the pathname FILE into the JSS dynamic lookup cache."
310  (when (probe-file file)
311    (loop for (name . full-class-name) in (get-all-jar-classnames file)
312       do 
313         (pushnew full-class-name (gethash name *class-name-to-full-case-insensitive*) 
314                  :test 'equal))))
316(defun new (class-name &rest args)
317  "Invoke the Java constructor for CLASS-NAME with ARGS.
319CLASS-NAME may either be a symbol or a string according to the usual JSS conventions."
320  (invoke-restargs 'new class-name args))
322(defvar *running-in-osgi* (ignore-errors (jclass "org.osgi.framework.BundleActivator")))
324(define-condition no-such-java-field (error)
325  ((field-name
326    :initarg :field-name
327    :reader field-name
328    )
329   (object
330    :initarg :object
331    :reader object
332    ))
333  (:report (lambda (c stream)
334             (format stream "Unable to find a FIELD named ~a for ~a"
335                     (field-name c) (object c))))
336  )
338(defun get-java-field (object field &optional (try-harder *running-in-osgi*))
339  "Get the value of the FIELD contained in OBJECT.
340If OBJECT is a symbol it names a dot qualified static FIELD."
341  (if try-harder
342      (let* ((class (if (symbolp object)
343                        (setq object (find-java-class object))
344                        (if (equal "java.lang.Class" (jclass-name (jobject-class object)))
345                            object
346                            (jobject-class object))))
347             (jfield (if (java-object-p field)
348                         field
349                         (or (find-declared-field field class)
350                             (error 'no-such-java-field :field-name field :object object)))))
351        (#"setAccessible" jfield +true+)
352        (values (#"get" jfield object) jfield))
353      (if (symbolp object)
354          (let ((class (find-java-class object)))
355            (jfield class field))
356          (jfield field object))))
358(defun find-declared-field (field class)
359  "Return a FIELD object corresponding to the definition of FIELD
360\(a string\) visible at CLASS. *Not* restricted to public classes, and checks
361all superclasses of CLASS.
362   Returns NIL if no field object is found."
363  (loop while class
364     for field-obj = (get-declared-field class field)
365     if field-obj
366     do (return-from find-declared-field field-obj)
367     else
368     do (setf class (jclass-superclass class)))
369  nil)
371(defun get-declared-field (class fieldname)
372  (find fieldname (#"getDeclaredFields" class)
373        :key 'jfield-name :test 'equal))
375;; TODO use #"getSuperclass" and #"getInterfaces" to see whether there
376;; are fields in superclasses that we might set
377(defun set-java-field (object field value &optional (try-harder *running-in-osgi*))
378  "Set the FIELD of OBJECT to VALUE.
379If OBJECT is a symbol, it names a dot qualified Java class to look for
380a static FIELD.  If OBJECT is an instance of java:java-object, the
381associated is used to look up the static FIELD."
382  (if try-harder
383      (let* ((class (if (symbolp object)
384                        (setq object (find-java-class object))
385                        (if (equal "java.lang.Class" (jclass-name (jobject-class object)) )
386                            object
387                            (jobject-class object))))
388             (jfield (if (java-object-p field)
389                         field
390                         (or (find-declared-field field class)
391                             (error 'no-such-java-field :field-name field :object object)))))
392        (#"setAccessible" jfield +true+)
393        (values (#"set" jfield object value) jfield))
394      (if (symbolp object)
395          (let ((class (find-java-class object)))
396            (setf (jfield (#"getName" class) field) value))
397          (if (typep object 'java-object)
398              (setf (jfield (jclass-of object) field) value)
399              (setf (jfield object field) value)))))
401(defun (setf get-java-field) (value object field &optional (try-harder *running-in-osgi*))
402  (set-java-field object field value try-harder))
405(defconstant +for-name+ 
406  (jmethod "java.lang.Class" "forName" "java.lang.String" "boolean" "java.lang.ClassLoader"))
408(defun find-java-class (name)
409  (or (jstatic +for-name+ "java.lang.Class" 
410               (maybe-resolve-class-against-imports name) +true+ java::*classloader*)
411      (ignore-errors (jclass (maybe-resolve-class-against-imports name)))))
413(defmethod print-object ((obj (jclass "java.lang.Class")) stream) 
414  (print-unreadable-object (obj stream :identity nil)
415    (format stream "java class ~a" (jclass-name obj))))
417(defmethod print-object ((obj (jclass "java.lang.reflect.Method")) stream) 
418  (print-unreadable-object (obj stream :identity nil)
419    (format stream "method ~a" (#"toString" obj))))
421(defun do-auto-imports ()
422  (labels ((expand-paths (cp)
423             (loop :for s :in cp
424                :appending (loop :for entry 
425                              :in (let ((p (pathname s)))
426                                    (if (wild-pathname-p p)
427                                        (directory p)
428                                        (list p)))
429                              :collecting entry)))
430           (import-classpath (cp)
431             (mapcar 
432              (lambda (p) 
433                (when *load-verbose*
434                  (format t ";; Importing ~A~%" p))
435                (cond 
436                  ((file-directory-p p) )
437                  ((equal (pathname-type p) "jar")
438                   (jar-import (merge-pathnames p
439                                                (format nil "~a/" (jstatic "getProperty" "java.lang.System" "user.dir")))))))
440              cp))
441           (split-classpath (cp)
442             (coerce 
443              (jcall "split" cp 
444                     (string (jfield (jclass "") "pathSeparatorChar")))
445              'cons))
446           (do-imports (cp)
447             (import-classpath (expand-paths (split-classpath cp)))))
448    (do-imports (jcall "getClassPath" (jstatic "getRuntimeMXBean" '||)))
449    (do-imports (jcall "getBootClassPath" (jstatic "getRuntimeMXBean" '||)))))
451(eval-when (:load-toplevel :execute)
452  (when *do-auto-imports* 
453    (do-auto-imports)))
455(defun japropos (string)
456  "Output the names of all Java class names loaded in the current process which match STRING.."
457  (setq string (string string))
458  (let ((matches nil))
459    (maphash (lambda(key value) 
460               (declare (ignore key))
461               (loop for class in value
462                  when (search string class :test 'string-equal)
463                  do (pushnew (list class "Java Class") matches :test 'equal)))
464             *class-name-to-full-case-insensitive*)
465    (loop for (match type) in (sort matches 'string-lessp :key 'car)
466       do (format t "~a: ~a~%" match type))
467    ))
469(defun jclass-method-names (class &optional full)
470  (if (java-object-p class)
471      (if (equal (jclass-name (jobject-class class)) "java.lang.Class")
472          (setq class (jclass-name class))
473          (setq class (jclass-name (jobject-class class)))))
474  (union
475   (remove-duplicates (map 'list (if full #"toString" 'jmethod-name) (#"getMethods" (find-java-class class))) :test 'equal)
476   (ignore-errors (remove-duplicates (map 'list (if full #"toString" 'jmethod-name) (#"getConstructors" (find-java-class class))) :test 'equal))))
478(defun java-class-method-names (class &optional stream)
479  "Return a list of the public methods encapsulated by the JVM CLASS.
481If STREAM non-nil, output a verbose description to the named output stream.
483CLASS may either be a string naming a fully qualified JVM class in dot
484notation, or a symbol resolved against all class entries in the
485current classpath."
486  (if stream
487      (dolist (method (jclass-method-names class t))
488        (format stream "~a~%" method))
489      (jclass-method-names class)))
491(setf (symbol-function 'jcmn) #'java-class-method-names)
493(defun path-to-class (classname)
494  (let ((full (lookup-class-name classname)))
495    (#"toString" 
496     (#"getResource" 
497      (find-java-class full)
498      (concatenate 'string "/" (substitute #\/ #\. full) ".class")))))
502(defun all-loaded-classes ()
503  (let ((classes-field 
504         (find "classes" (#"getDeclaredFields" (jclass "java.lang.ClassLoader"))
505               :key #"getName" :test 'equal)))
506    (#"setAccessible" classes-field +true+)
507    (loop for classloader in (mapcar #'first (dump-classpath))
508       append
509         (loop with classesv = (#"get" classes-field classloader)
510            for i below (#"size" classesv)
511            collect (#"getName" (#"elementAt" classesv i)))
512       append
513         (loop with classesv = (#"get" classes-field (#"getParent" classloader))
514            for i below (#"size" classesv)
515            collect (#"getName" (#"elementAt" classesv i))))))
517(defun get-dynamic-class-path ()
518  (rest 
519   (find-if (lambda (loader) 
520              (string= "org.armedbear.lisp.JavaClassLoader"
521                       (jclass-name (jobject-class loader))))
522            (dump-classpath)
523            :key #'car)))
525(defun java-gc ()
526  (#"gc" (#"getRuntime" 'java.lang.runtime))
527  (#"runFinalization" (#"getRuntime" 'java.lang.runtime))
528  (#"gc" (#"getRuntime" 'java.lang.runtime))
529  (java-room))
531(defun java-room ()
532  (let ((rt (#"getRuntime" 'java.lang.runtime)))
533    (values (- (#"totalMemory" rt) (#"freeMemory" rt))
534            (#"totalMemory" rt)
535            (#"freeMemory" rt)
536            (list :used :total :free))))
538(defun verbose-gc (&optional (new-value nil new-value-supplied))
539  (if new-value-supplied
540      (progn (#"setVerbose" (#"getMemoryMXBean"  ' new-value) new-value)
541      (#"isVerbose" (#"getMemoryMXBean"  '
543(defun all-jars-below (directory) 
544  (loop with q = (system:list-directory directory) 
545     while q for top = (pop q)
546     if (null (pathname-name top)) do (setq q (append q (all-jars-below top))) 
547     if (equal (pathname-type top) "jar") collect top))
549(defun all-classfiles-below (directory) 
550  (loop with q = (system:list-directory directory) 
551     while q for top = (pop q)
552     if (null (pathname-name top)) do (setq q (append q (all-classfiles-below top ))) 
553     if (equal (pathname-type top) "class")
554     collect top
555       ))
557(defun all-classes-below-directory (directory)
558  (loop for file in (all-classfiles-below directory) collect
559       (format nil "~{~a.~}~a"
560               (subseq (pathname-directory file) (length (pathname-directory directory)))
561               (pathname-name file))
562       ))
564(defun classfiles-import (directory)
565  "Load all Java classes recursively contained under DIRECTORY in the current process."
566  (setq directory (truename directory))
567  (loop for full-class-name in (all-classes-below-directory directory)
568     for name = (#"replaceAll" full-class-name "^.*\\." "")
569     do
570       (pushnew full-class-name (gethash name *class-name-to-full-case-insensitive*) 
571                :test 'equal)))
573(defun set-to-list (set)
574  (declare (optimize (speed 3) (safety 0)))
575  (with-constant-signature ((iterator "iterator" t) (hasnext "hasNext") (next "next"))
576    (loop with iterator = (iterator set)
577       while (hasNext iterator)
578       for item = (next iterator)
579       collect item)))
581(defun jlist-to-list (list)
582  "Convert a LIST implementing java.util.List to a Lisp list."
583  (declare (optimize (speed 3) (safety 0)))
584  (loop :for i :from 0 :below (jcall "size" list)
585     :collecting (jcall "get" list i)))
587(defun jarray-to-list (jarray)
588  "Convert the Java array named by JARRARY into a Lisp list."
589  (declare (optimize (speed 3) (safety 0)))
590  (loop :for i :from 0 :below (jarray-length jarray)
591     :collecting (jarray-ref jarray i)))
593;;; Deprecated
595;;; XXX unclear what sort of list this would actually work on, as it
596;;; certainly doesn't seem to be any of the Java collection types
597;;; (what implements getNext())?
598(defun list-to-list (list)
599  (declare (optimize (speed 3) (safety 0)))
600  (with-constant-signature ((isEmpty "isEmpty") (getfirst "getFirst")
601                            (getNext "getNext"))
602    (loop until (isEmpty list)
603       collect (getFirst list)
604       do (setq list (getNext list)))))
606;; Contribution of Luke Hope. (Thanks!)
608(defun iterable-to-list (iterable)
609  "Return the items contained the java.lang.Iterable ITERABLE as a list."
610  (declare (optimize (speed 3) (safety 0)))
611  (let ((it (#"iterator" iterable)))
612    (with-constant-signature ((has-next "hasNext")
613                              (next "next"))
614      (loop :while (has-next it)
615         :collect (next it)))))
617(defun vector-to-list (vector)
618  "Return the elements of java.lang.Vector VECTOR as a list."
619  (declare (optimize (speed 3) (safety 0)))
620  (with-constant-signature ((has-more "hasMoreElements")
621                            (next "nextElement"))
622    (let ((elements (#"elements" vector)))
623      (loop :while (has-more elements)
624         :collect (next elements)))))
626(defun hashmap-to-hashtable (hashmap &rest rest &key (keyfun #'identity) (valfun #'identity) (invert? nil)
627                                                  table 
628                             &allow-other-keys )
629  "Converts the a HASHMAP reference to a java.util.HashMap object to a Lisp hashtable.
631The REST paramter specifies arguments to the underlying MAKE-HASH-TABLE call.
633KEYFUN and VALFUN specifies functions to be run on the keys and values
634of the HASHMAP right before they are placed in the hashtable.
636If INVERT? is non-nil than reverse the keys and values in the resulting hashtable."
637  (let ((keyset (#"keySet" hashmap))
638        (table (or table (apply 'make-hash-table
639                                (loop for (key value) on rest by #'cddr
640                                   unless (member key '(:invert? :valfun :keyfun :table)) 
641                                   collect key and collect value)))))
642    (with-constant-signature ((iterator "iterator" t) (hasnext "hasNext") (next "next"))
643      (loop with iterator = (iterator keyset)
644         while (hasNext iterator)
645         for item = (next iterator)
646         do (if invert?
647                (setf (gethash (funcall valfun (#"get" hashmap item)) table) (funcall keyfun item))
648                (setf (gethash (funcall keyfun item) table) (funcall valfun (#"get" hashmap item)))))
649      table)))
651(defun jclass-all-interfaces (class)
652  "Return a list of interfaces the class implements"
653  (unless (java-object-p class)
654    (setq class (find-java-class class)))
655  (loop for aclass = class then (#"getSuperclass" aclass)
656     while aclass
657     append (coerce (#"getInterfaces" aclass) 'list)))
659(defun safely (f name)
660  (let ((fname (gensym)))
661    (compile fname
662             `(lambda(&rest args)
663                (with-simple-restart (top-level
664                                      "Return from lisp method implementation for ~a." ,name)
665                  (apply ,f args))))
666    (symbol-function fname)))
668(defun jdelegating-interface-implementation (interface dispatch-to &rest method-names-and-defs)
669  "Creates and returns an implementation of a Java interface with
670   methods calling Lisp closures as given in METHOD-NAMES-AND-DEFS.
672   INTERFACE is an interface
674   DISPATCH-TO is an existing Java object
676   METHOD-NAMES-AND-DEFS is an alternating list of method names
677   (strings) and method definitions (closures).
679   For missing methods, a dummy implementation is provided that
680   calls the method on DISPATCH-TO."
681  (let ((implemented-methods
682         (loop for m in method-names-and-defs
683            for i from 0
684            if (evenp i) 
685            do (assert (stringp m) (m) "Method names must be strings: ~s" m) and collect m
686            else
687            do (assert (or (symbolp m) (functionp m)) (m) "Methods must be function designators: ~s" m))))
688    (let ((safe-method-names-and-defs 
689           (loop for (name function) on method-names-and-defs by #'cddr
690              collect name collect (safely function name))))
691      (loop for method across
692           (jclass-methods interface :declared nil :public t)
693         for method-name = (jmethod-name method)
694         when (not (member method-name implemented-methods :test #'string=))
695         do
696           (let* ((def  `(lambda
697                             (&rest args)
698                           (invoke-restargs ,(jmethod-name method) ,dispatch-to args t)
699                           )))
700             (push (coerce def 'function) safe-method-names-and-defs)
701             (push method-name safe-method-names-and-defs)))
702      (apply #'java::%jnew-proxy  interface safe-method-names-and-defs))))
Note: See TracBrowser for help on using the repository browser.