Home

User Manual - Armed Bear Common Lisp (ABCL)

1. 14 334 Evaluation kam dee RR GK Q Q RAHA 15 3 3 5 Compilation s p ses o obo en bak Sa a 15 3 3 6 Invocation of functions and 15 3 3 7 Implementation of Java interfaces in Lisp 15 3 3 8 Implementation of Java classes in 16 4 Implementation Dependent Extensions 17 Al JAVA z SS ae ee eo Oe Ee as 17 4 1 1 Modifying the JVM CLASSPATH 17 4 1 2 Creating a synthetic Java Class at 17 42 THREADS a BA Oe eS ee ele ae 25 43 EXTENSIONS e bran ee a eee ha OT 442 a 28 5 Beyond ANSI 37 5 1 Compiler to Java 5 Bvtecode 37 52 P abhnamen u a ow honor OMAR Ee GA EUR m s bd 37 5 3 Package Local Nicknames 39 5 4 Extensible Sequences 40 5 5 Extensi ns to CLOS s so 20 2 kan L 40 I b gt CONTENTS 5 5 1 Metaobject Proto ol ss xl noo s e 2 a a w u 40 5 5 2 Specializing on Java classes 40 5 6 Extensions to the Reader Cr w a m a wU e w s w w a la 41 5 7 Overloading of the CL REQUIRE Mechanism 41 5 8 JSS extension of the Reader by SHARPSIGN DOUBLE QUOTE
2. Variable true java The JVM primitive value for boolean true Generic Function add to classpath java Add JAR OR JARS to the JVM classpath optionally specifying the CLASS LOADER to add JAR OR JARS is either a pathname designating a jar archive or the root directory to search for classes or a list of such values Macro chain java not documented Macro define java class java not documented Function describe java object java not documented Function dump classpath java optional classloader not documented Function ensure java class java jclass Attempt to ensure that the Java class referenced by JCLASS exists in the current process of the implementation Function ensure java object java obj Ensures OBJ is wrapped in a JAVA OBJECT wrapping it if necessary Function get current classloader java not documented Function get default classloader java not documented Function jarray component type java atype Returns the component type of the array type ATYPE 4 1 JAVA 19 Function jarray from list java list Return a Java array from LIST whose type is inferred from the first element For more control over the type of the array use JNEW ARRAY FROM LIST Function jarray length java java array Returns the length of a Java primitive array Function jarray ref java java array amp rest indices Dereferences
3. Function set hot count system not documented Function set schar system string index character not documented Function set std slot value system instance slot name new value not documented Function setf function name p system thing not documented Function sha256 system rest paths or strings Returned ASCIIfied representation of SHA 256 digest of byte based resource at PATHS OR STRINGs Function shrink vector system vector new size not documented Function simple format system destination control string amp rest format arguments not documented Function simple search system sequence sequence not documented Function simple typep system not documented Function single float bits system float not documented Class slot definition system not documented Function source transform system name not documented Function standard instance access system instance location not documented 75 Function standard object p system object not documented Function std instance class system not documented Function std instance layout system not documented Function std slot boundp system instance slot name not documented Function std slot value system instance slot name not documented Function structure length system instance not documented Function structure object p system obj
4. Function make emf cache system not documented Function make instances obsolete system class not documented Function make integer type system low high not documented Function make list system not documented Function make logical pathname system namestring not documented Function make slot definition system slot class Argument must be a subclass of standard slot definition Function make structure system name slot values not documented Function member system not documented Function nstring capitalize system not documented Function Mnstring downcase system not documented Function nstring upcase system not documented Function Vooutput object system object stream not documented Function Voputf system plist indicator new value not documented Function Voreinit emf cache system generic function egl specilizer objects list not documented Function set class default initargs system not documented 59 60 APPENDIX B THE SVSTEM DICTIONARV Function set class direct default initargs system not documented Function set class direct methods system not documented Function set class direct slots system not documented Function set class direct subclasses system class direct subclasses not documented Function set class direct s
5. COMPUTE DISCRIMINATING FUNCTION 51EQL SPECIALIZER 52 COMPUTE EFFECTIVE METHOD 51 COMPUTE EFFECTIVE SLOT DEFINITION 51 COMPUTE SLOTS 51 CONCATENATE FASLS 65 CURRENT THREAD 26 DEFCONST 65 DEFGENERIC 50 DEFINE JAVA CLASS 18 DEFINE SOURCE TRANSFORM 65 DEFKNOWN 65 DEFPACKAGE 39 DEFUN 58 DELETE EQ 66 EQL SPECIALIZER OBJECT 52 EXIT 31 EXPAND INLINE 67 EXPAND SOURCE TRANSFORM 67 EXTRACT LAMBDA LIST 52 EXTRACT SPECIALIZER NAMES 52 FDEFINITION BLOCK NAME 67 FEATUREP 31 FILE DIRECTORY P 31 FINALIZE 31 FINALIZE INHERITANCE 52 FIND CONTRIB 67 FIND JAVA CLASS 78 FIND METHOD COMBINATION 52 84 FIND SVSTEM 67 FIXNUM CONSTANT VALUE 67 FIXNUM TVPE P 67 FIXNUMP 31 FLOAT BITS 58 FLOAT INFINITY P 67 FLOAT NAN P 67 FLOAT OVERFLOW MODE 67 FLOAT STRING 67 FLOAT UNDERFLOW MODE 67 FORWARD REFERENCED CLASS 52 67 FRAME TO LIST 67 FRAME TO STRING 68 FSET 68 FTYPE RESULT TYPE 68 FUNCALLABLE STANDARD CLASS 52 INDEX INLINE EXPANSION 68 INLINE P 68 INSPECTED PARTS 68 INTEGER CONSTANT VALUE 69 INTEGER TYPE HIGH 69 INTEGER TYPE LOW 69 INTEGER TYPE P 69 INTERACTIVE EVAL 69 INTERN EQL SPECIALIZER 53 INTERNAL COMPILER ERROR 69 INTERRUPT LISP 32 INTERRUPT THREAD 26 INVOKE ADD IMPORTS 78 INVOKE RESTARGS 78 ITERABLE TO LIST 78 FUNCALLABLE STANDARD INSTANCE ACC SS ROPOS 78 52 FUNCALLABLE STANDARD OBJECT 52 FUNCTION PLIST 68 FUNCTION RESULT
6. ED FUNCTIONS 29 ASET 64 ENABLE AUTOCOMPILE 62 ASSQ 30 ENABLE INLINE EXPANSION 29 ASSQL 30 EXPLAIN 63 AUTOCOMPILE 64 FASL LOADER 63 AUTOLOAD 30 FASL VERSION 63 AUTOLOAD MACRO 30 GUI BACKEND 29 AUTOLOAD REF P 30 INLINE DECLARATIONS 63 AUTOLOAD SETF EXPANDER 30 INSPECTOR HOOK 29 AUTOLOAD SETF FUNCTION 30 JAVA OBJECT TO STRING LENGTH 18 AUTOLOADP 31 LISP HOME 29 AVAILABLE ENCODINGS 64 LOAD TRUENAME FASL 29 AVER 64 LOGICAL PATHNAME TRANSLATIONS 63 NOINFORM 63 BACKTRACE 64 PRINT STRUCTURE 30 BUILT IN FUNCTION P 64 REQUIRE STACK FRAME 30 SAFETY 63 CACHE EMF 64 SAVED BACKTRACE 30 CADDR 29 SOURCE 63 CADR 29 SOURCE POSITION 63 CALL COUNT 64 SPACE 63 CALL REGISTERS LIMIT 64 SPEED 63 CANCEL FINALIZATION 31 SUPPRESS COMPILER WARNINGS 30 CANONICALIZE DIRECT SUPERCLASSES 50 TRACED NAMES 63 CANONICALIZE LOGICAL HOST 64 WARN ON REDEFINITION 30 CAR 29 CL PACKAGEH 63 CDR 29 FALSE 18 CHAIN 18 82 INDEX CHAR TO UTFS 31 CHARPOS 31 CHECK DECLARATION TVPE 64 CHECK SEQUENCE BOUNDS 64 CLASS DEFAULT INITARGS 50 58 CLASS DIRECT DEFAULT INITARGS 50 58 CLASS DIRECT METHODS 50 58 CLASS DIRECT SLOTS 50 58 CLASS DIRECT SUBCLASSES 50 58 CLASS DIRECT SUPERCLASSES 50 58 CLASS DOCUMENTATION 50 CLASS FINALIZED P 50 58 CLASS LAVOUT 58 CLASS NAME 58 CLASS PRECEDENCE LIST 50 58 CLASS PROTOTVPE 50 CLASS SLOTS 51 58
7. Function dump uninterned symbol index system symbol not documented Function empty environment p system environment not documented Function ensure input stream system pathname Returns a java io InputStream for resource denoted by PATHNAME Class environment system not documented Function environment add function definition system environment name lambda expression not documented Function environment add macro definition system environment name expander not documented Function environment add symbol binding system environment symbol value not documented Function environment all functions system environment not documented Function environment all variables system environment not documented Function environment variables system environment not documented Function expand inline system form expansion not documented Function expand source transform system form not documented Function fdefinition block name system function name not documented Function find contrib system Introspect runtime classpaths to find a loadable ABCL CONTRIB Function find system system Find the location of the system Used to determine relative pathname to find abcl contrib jar Function fixnum constant value system compiler type not documented Function fixnum type p system compiler type not documented Func
8. 42 5 9 ASIDES ce tse k eut m Hew 42 Contrib 43 6 1 abecehasdi co z s kun Y ae ernennen 43 6 1 1 Referencing Maven Artifacts via ASDF 48 OTT 43 6 1 3 Directly Instructing Maven to Download JVM Artifacts 44 62 CIPIT 44 6 9 JSS sea wo A kee eomm Rx Rec CR wee Se a On RUD 2 b de da 44 6 2 1 JOSSE ao 44 BA A Fah ss 45 6 5 sdiinstalli 22204222555 Yabba een eek 45 History 47 The MOP Dictionary 49 The SYSTEM Dictionary 57 The JSS Dictionary 77 0 0 1 Preface to the Fourth Edition ABCL 1 3 now implements an optimized implementation of the LispStack abstraction thanks to Dmitry Nadezhin which runs on ORCL JVMs from 1 5 8 conformantly 0 0 2 Preface to the Third Edition The implementation now contains a performant and conformant implementation of A MOP to the point of inclusion in CLOSER MOP s test suite 0 0 3 Preface to the Second Edition ABCL 1 1 now contains A MOP We hope you enjoy The Mgmt Chapter 1 Introduction Armed Bear Common Lisp ABCL is an implementation of Common Lisp that runs on the Java Virtual Machine It compiles Common Lisp to Java 5 bvtecode l providing the following integration methods for interfacing with Java code and libraries e Lisp code can create Java objects and call their methods see Section 3 1 page 9 e Java code can call Lisp functions
9. Packages findPackage CL Symbol valuesSymbol cl findAccessibleSymbol VALUES LispObject valuesArgs 5 LispInteger getInstance 1 LispInteger getInstance 2 equivalent to values 1 2 LispObject result valuesSymbol execute valuesArgs LispObject values LispThread currentThread getValues for LispObject value values System out printlin value gt value printObject Introspecting a LispObject We present various patterns for introspecting an arbitrary LispObject which can hold the result of every Lisp evaluation into semantics that Java can meaningfully deal with LispObject as boolean If the LispObject is to be interpreted as a generalized boolean value one can use getBooleanValue to convert to Java LispObject object Symbol NIL boolean javaValue object getBooleanValue Since in Lisp any value other than NIL means true Java equality can also be used which is a bit easier to type and better in terms of information it conveys to the compiler boolean javaValue object Symbol NIL LispObject as a list If LispObject is a list it will have the type Cons One can then use the copyToArray method to make things a bit more suitable for Java iteration LispObject result interpreter eval 1 24445 if result instanceof Cons 4 LispObject array Cons result copvToArrav A more Lispy way to iterate down a list is to use the cdr access function
10. SINGLE FLOAT NEGATIVE INFINITV 34 SINGLE FLOAT POSITIVE INFINITV 34 SLIME INPUT STREAM 34 SLIME OUTPUT STREAM 34 SLOT BOUNDP USING CLASS 53 SLOT DEFINITION 54 74 SLOT DEFINITION ALLOCATION 54 SLOT DEFINITION DOCUMENTATION 54 SLOT DEFINITION INITARGS 54 SLOT DEFINITION INITFORM 54 SLOT DEFINITION INITFUNCTION 54 SLOT DEFINITION LOCATION 54 SLOT DEFINITION NAME 54 SLOT DEFINITION READERS 54 SLOT DEFINITION TVPE 54 SLOT DEFINITION WRITERS 54 SLOT MAKUNBOUND USING CLASS 54 SLOT VALUE USING CLASS 54 SOCKET ACCEPT 34 SOCKET CLOSE 34 SOCKET LOCAL ADDRESS 35 SOCKET LOCAL PORT 35 SOCKET PEER ADDRESS 35 SOCKET PEER PORT 35 SOURCE 35 SOURCE FILE POSITION 35 SOURCE PATHNAME 35 SOURCE TRANSFORM 74 SPECIAL VARIABLE P 35 SPECIALIZER 54 87 STRING FIND 35 STRING GREATERP 61 STRING INPUT STREAM CURRENT 35 STRING LESSP 61 STRING NOT EQUAL 61 STRING NOT GREATERP 61 STRING NOT LESSP 61 STRING POSITION 35 STRING UPCASE 61 STRING 61 STRINGI 61 STRING 61 STRING 62 STRING 62 STRUCTURE LENGTH 75 STRUCTURE OBJECT P 75 STRUCTURE REF 75 STRUCTURE SET 75 STYLE WARN 35 SUBCLASSP 75 SVSET 75 SWAP SLOTS 75 SYMBOL MACRO P 75 SYNCHRONIZED ON 27 THREAD 27 THREAD ALIVE P 27 THREAD JOIN 27 THREAD NAME 27 THREADP 27 SPECIALIZER DIRECT GENERIC FUNCTIONBRULY THE 35 54 SPECIALIZER DIRECT METHODS 54 STANDARD ACCESSOR METHOD 55 STANDARD DIRECT SL
11. amp allow other keys not documented Generic Function ensure class using class mop not documented Generic Function ensure generic function using class mop not documented 51 52 APPENDIX A THE DICTIONARV Class eql specializer mop not documented Function egl specializer object mop eql specializer not documented Function extract lambda list mop specialized lambda list not documented Function extract specializer names mop specialized lambda list not documented Generic Function finalize inheritance mop not documented Generic Function find method combination mop not documented Class forward referenced class system not documented Class funcallable standard class mop not documented Function funcallable standard instance access mop instance location not documented Class funcallable standard object mop not documented Generic Function generic function argument precedence order mop not documented Generic Function generic function declarations mop not documented Generic Function generic function lambda list mop not documented Generic Function generic function method class mop not documented Generic Function generic function method combination mop not documented Generic Function generic function methods mop not documented Generic Functi
12. extensions not documented Variable batch mode extensions not documented Variable command line argument list extensions not documented Variable debug condition extensions not documented Variable debug level extensions not documented Variable disassembler extensions not documented Variable ed functions extensions not documented Variable enable inline expansion extensions not documented Variable gui backend extensions not documented Variable inspector hook extensions not documented Variable lisp home extensions not documented Variable load truename fasl extensions not documented 29 30 CHAPTER 4 IMPLEMENTATION DEPENDENT EXTENSIONS Variable print structure extensions not documented Variable require stack frame extensions not documented Variable saved backtrace extensions not documented Variable suppress compiler warnings extensions not documented Variable warn on redefinition extensions not documented Function add package local nickname extensions local nickname actual package amp op tional package designator package not documented Function adjoin eql extensions item list not documented Function arglist extensions ertended function designator not documented Function assq extensions not documente
13. TVPE 68 GC 31 JAR IMPORT 78 JAR PATHNAME 32 37 JAR STREAM 69 JARRAY COMPONENT TYPE 18 JARRAV FROM LIST 19 JARRAV LENGTH 19 GENERIC FUNCTION ARGUMENT PRECEDENXRRAY REF 19 ORDER 52 JARRAV REF RAW 19 GENERIC FUNCTION DECLARATIONS 52 JARRAV SET 19 GENERIC FUNCTION LAMBDA LIST 52 JARRAV TO LIST 79 GENERIC FUNCTION METHOD CLASS 52 JAVA CLASS 19 GENERIC FUNCTION METHOD COMBINATIOWA CLASS METHOD NAMES 79 52 GENERIC FUNCTION METHODS 52 GENERIC FUNCTION NAME 53 GET CACHED EMF 68 GET CURRENT CLASSLOADER 18 GET DEFAULT CLASSLOADER 18 GET FLOATING POINT MODES 32 GET FUNCTION INFO VALUE 68 GET JAVA FIELD 78 GET MUTEX 26 GET SOCKET STREAM 32 GETENV 32 GETENV ALL 32 GETHASHI 68 GROVEL JAVA DEFINITIONS IN FILE 68 HASH TABLE WEAKNESS 68 HASHMAP TO HASHTABLE 78 History 47 HOT COUNT 68 IDENTITY HASH CODE 68 IN PACKAGE 58 INIT FASL 68 INIT GUI 32 JAVA EXCEPTION 19 JAVA EXCEPTION CAUSE 19 JAVA LONG TYPE P 69 JAVA OBJECT 19 JAVA OBJECT P 19 JCALL 19 JCALL RAW 19 JCLASS 19 JCLASS ALL INTERFACES 79 JCLASS ARRAY P 19 JCLASS CONSTRUCTORS 20 JCLASS FIELD 20 JCLASS FIELDS 20 JCLASS INTERFACE P 20 JCLASS INTERFACES 20 JCLASS METHODS 20 JCLASS NAME 20 JCLASS OF 20 JCLASS SUPERCLASS 20 JCLASS SUPERCLASS P 20 JCMN 79 JCOERCE 20 JCONSTRUCTOR 20 JCONSTRUCTOR PARAMS 20 JEQUAL 20 INDEX JFIELD 21 JFIELD NAME 21 JFIEL
14. Youytoldyme A ymsg Package pkg Packages findPackage Symbol foo pkg findAccessibleSymbol FOO Function fooFunction Function foo getSymbolFunction JavaObject parameter new JavaObject Lispuisufun LispObject result fooFunction execute parameter How to get the naked string value Svstem out printin The resultiwasu result writeToString If one is calling a function in the CL package the syntax can become considerably simpler If we can locate the instance of definition in the ABCL Java source we can invoke the symbol directly For instance to tell if a LispObject is Lisp NIL we can invoke the CL function NULL in the following way boolean nullp LispObject object 1 LispObject result Primitives NULL execute object if result NIL the symbol NIL 15 explicitly named in the Java namespace at Symbol NIL but is always present in the local namespace in its unadorned form for the convenience of the User return false return true Multiple Values After a call to a function that returns Lisp multiple values the values are associated with the executing LispThread until the next call into Lisp One may access the values object as a list 3 3 JAVA SCRIPTING API JSR 223 13 of LispObject instances via a call to getValues on that thread reference as evidenced by the following code org armedbear lisp Package cl
15. a lock on the mutex Special Operator synchronized on threads not documented Class thread threads not documented Function thread alive p threads thread Boolean predicate whether THREAD is alive Function thread join threads thread Waits for thread to finish Function thread name threads not documented Function threadp threads not documented Macro with mutex threads not documented Macro with thread lock threads not documented Function yield threads hint to the scheduler that the current thread is willing to yield its current use of a processor The scheduler is free to ignore this hint See java lang Thread yield 28 CHAPTER 4 IMPLEMENTATION DEPENDENT EXTENSIONS 4 3 EXTENSIONS The symbols in the EXTENSIONS package nicknamed EXT constitutes extensions to the ANSI standard that are potentially useful to the user They include functions for manipulating network sockets running external programs registering object finalizers constructing reference weakly held by the garbage collector and others See Rho09 for a generic function interface to the native JVM contract for java util List 4 3 EXTENSIONS Macro caddr extensions not documented Macro cadr extensions not documented Macro extensions not documented Macro extensions not documented Variable autoload verbose
16. and generic functions either directly Section 3 2 1 page 11 or via JSR 223 Section 3 3 page 13 e jinterface implementation creates Lisp side implementations of Java interfaces that can be used as listeners for Swing classes and similar e java jnew runtime class can inject fully synthetic Java classes and their objects into the current JVM process whose behavior is specified via closures expressed in Common Lisp ABCL is supported by the Lisp library manager QUICKLISP and can run many of the programs and libraries provided therein out of the box 1 1 Conformance 1 1 1 ANSI Common Lisp ABCL is currently a non conforming ANSI Common Lisp implementation due to the following known issues e The generic function signatures of the CL DOCUMENTATION symbol do not match the specifi cation e The CL TIME form does not return a proper CL VALUES environment to its caller e When merging pathnames and the defaults point to a EXT JAR PATHNAME we set the DEVICE of the result to UNSPECIFIC if the pathname to be be merged does not contain a specified DEVICE does not contain a specified HOST does contain a relative DIRECTORY and we are not running on a MSFT Windows platform 1The class file version is 49 0 Parts of the current implementation are not fully finished so the status of some interfaces here should be treated with skepticism if you run into problems Shttp quicklisp org 4The intent of this rathe
17. character whose code is specified by the hexadecimal digits zzzz The hexadecimal sequence may be one to four digits long Note that this sequence is never output by the implementation Instead the corresponding Unicode character is output for characters whose code is greater than 0x00ff 5 7 Overloading of the CL REQUIRE Mechanism The CL REQUIRE mechanism is overloaded by attaching these semantics to the execution of REQUIRE on the following symbols ASDF Loads the ASDF implementation shipped with the implementation After ASDF has been loaded in this manner symbols passed to CL REQUIRE which are otherwise unresolved are passed to ASDF for a chance for resolution This means for instance if CL PPCRE can be lo cated as a loadable ASDF system require cl ppcre is equivalent to asdf 1oad system cl ppcre ABCL CONTRIB Locates and pushes the toplevel contents of abcl contrib jar into the ASDF central registry 1 abcl asdf Functions for loading JVM artifacts dynamically hooking into ASDF 3 objects where possible 2 asdf jar Package addressable JVM artifacts via abcl asdf descriptions as a single binary artifact including recursive dependencies 3 mvn These systems name common JVM artifacts from the distributed pom xml graph of Maven Aether a jna Dynamically load jna jar version 4 0 0 from the network 6 4 quicklisp abcl Boot a local Quicklisp installation via the ASDF IRI type introduced bia ABCL ASDF C
18. explicitly stating the conformance of Armed Bear Common Lisp to ANSI we released abcl 1 0 0 We released abcl 1 0 1 as a main tainence release on January 10 2012 In December 2012 we revised the implementation by adding A MOP with the release of abcl 1 1 0 We released abcl 1 1 1 as a maintainence release on Feburary 14 2013 At the beginning of June 2013 we enhanced the stability of the implementation with the release of abcl 1 2 1 In March 2014 we introduced the Fourth Edition of the implementation with abcl 1 3 0 At the end of April 2014 we released abcl 1 3 1 as a maintainence release We followed this in April 2015 with the release of abcl 1 3 2 47 48 CHAPTER 7 HISTORV Appendix The Dictionarv 50 APPENDIX A THE DICTIONARV Function defgeneric mop function name amp rest all keys not documented Generic Function accessor method slot definition mop not documented Generic Function add dependent mop not documented Generic Function add direct method mop not documented Generic Function add direct subclass mop not documented Function canonicalize direct superclasses mop direct superclasses not documented Generic Function class default initargs mop not documented Generic Function class direct default initargs mop not documented Generic Function class direct methods mop not documented Generic Functi
19. interfaces constructors methods fields access flags quote public annotations Creates and loads a Java class with methods calling Lisp closures as given in METHODS CLASS NAME and SUPER NAME are strings INTER FACES is a list of strings CONSTRUCTORS METHODS and FIELDS are lists of constructor method and field definitions Constructor definitions currently NOT supported are lists of the form argument types function amp optional super invocation arguments where argument types is a list of strings and function is a lisp function of 1 length argument types arguments the instance this is passed in as the last argument The optional super invocation arguments is a list of numbers between 1 and length argument types where the number k stands for the kth argument to the just defined constructor If present the constructor of the superclass will be called with the appropriate arguments E g if the constructor definition is java lang String int lambda string i this 2 1 then the constructor of the superclass with argument types int java lang String will be called with the second and first arguments Method definitions are lists of the form METHOD NAME RETURN TYPE ARGUMENT TYPES FUNCTION amp key MODIFIERS ANNOTATIONS where METHOD NAME is a string RETURN TYPE denotes the type of the object returned by the method ARGUMENT TYPES is a list of parameters to the method The types are either stri
20. 0 MAKE MACRO EXPANDER 71 MAKE MAILBOX 26 MAKE METHOD LAMBDA 53 MAKE MUTEX 26 MAKE SERVER SOCKET 32 MAKE SINGLE FLOAT 71 MAKE SLIME INPUT STREAM 32 MAKE SLIME OUTPUT STREAM 32 MAKE SLOT DEFINITION 59 MAKE SOCKET 32 MAKE STRUCTURE 59 71 MAKE SYMBOL MACRO 71 MAKE TEMP DIRECTORY 32 MAKE TEMP FILE 33 MAKE THREAD 26 MAKE THREAD LOCK 26 MAKE WEAK REFERENCE 33 MAP DEPENDENTS 53 MAPCAR THREADS 26 MEMBER 59 MEMQ 33 MEMQL 33 METAOBJECT 53 METHOD FUNCTION 53 METHOD GENERIC FUNCTION 53 METHOD LAMBDA LIST 53 METHOD QUALIFIERS 53 METHOD SPECIALIZERS 53 MOST NEGATIVE JAVA LONG 33 MOST POSITIVE JAVA LONG 33 MUTEX 33 NAMED LAMBDA 71 NEQ 33 NEW 79 86 NIL VECTOR 33 NORMALIZE TVPE 71 NOTE NAME DEFINED 71 NOTINLINE P 71 NSTRING CAPITALIZE 59 NSTRING DOWNCASE 59 NSTRING UPCASE 59 OBJECT NOTIFV 27 OBJECT NOTIFV ALL 27 OBJECT WAIT 27 OUT SYNONYM OF 71 OUTPUT OBJECT 59 71 PACKAGE EXTERNAL SVMBOLS 71 PACKAGE INHERITED SVMBOLS 71 PACKAGE INTERNAL SVMBOLS 71 PACKAGE LOCAL NICKNAMES 33 39 PACKAGE LOCALLY NICKNAMED BY LIST 33 39 PACKAGE SYMBOLS 71 PARSE BODY 71 PATHNAME JAR P 33 PATHNAME URL P 33 38 PRECOMPILE 33 71 PROBE DIRECTORY 33 PROCESS 72 PROCESS ALIVE P 72 PROCESS ERROR 72 PROCESS EXIT CODE 72 PROCESS INPUT 72 PROCESS KILL 72 PROCESS OPTIMIZATION DECLARATIONS 72 PROCESS OUTPUT 72 PROCESS P 72 PROCESS WAIT 72 PROCLAIMED FTYPE 72
21. 12 Kent Pitman et al Common Lisp HyperSpec http www lispworks com documentation HyperSpec Front index htm 1996 Last accessed Feb 4 2012 Frangois Ren Rideau Daniel Barlow Christopher Rhodes and Garry King Asdf http common lisp net project asdf Last accessed Feb 5 2012 Christophe Rhodes User extensible sequences in Common Lisp In Proceedings of the 2007 International Lisp Conference pages 13 1 13 14 ACM 2009 Also available at http doc gold ac uk masO1cr papers i1c2007 sequences 20070301 pdf SLIME The Superior Lisp Interaction Mode for Emacs http common lisp net project slime Last accessed Feb 4 2012 81 Index ABCL CONTRIB 62 FALSE TYPE 63 AUTOLOAD VERBOSE 29 FIXNUM TYPE 63 BATCH MODE 29 HNTEGER TYPE 63 CL USER COMPATIBILITY 78 KEYWORD PACKAGEH 64 COMMAND LINE ARGUMENT LIST 29 NULL 18 COMPILE FILE CLASS EXTENSION 62 SLOT UNBOUND4 64 COMPILE FILE ENVIRONMENT 62 TRUEH 18 COMPILE FILE TYPE 62 TRUE TYPE 64 COMPILE FILE ZIP 62 COMPILER DIAGNOSTIC 62 ACCESSOR METHOD SLOT DEFINITION 50 COMPILER ERROR CONTEXT 62 ADD DEPENDENT 50 CURRENT PRINT LENGTH 62 ADD DIRECT METHOD 50 CURRENT PRINT LEVEL 62 ADD DIRECT SUBCLASS 50 DEBUG 62 ADD PACKAGE LOCAL NICKNAME 30 39 DEBUG CONDITION 29 ADD TO CLASSPATH 18 DEBUG LEVEL 29 ADJOIN EQL 30 DISASSEMBLER 29 ALLOCATE FUNCALLABLE INSTANCE 58 DO AUTO IMPORTS 78 ARGLIST 30
22. ABCL implements all the three interfaces ScriptEngine and the two optional ones almost completely While the JSR 223 API is not specific to a single scripting language it was designed with languages with a more or less Java like object model in mind languages such as Javascript Python Ruby which have a concept of class or object with fields and methods Lisp is a bit different so certain adaptations were made and in one case a method has been left unimplemented since it does not map at all to Lisp The ScriptEngine The main interface defined by JSR 223 javax script ScriptEngine is implemented by the class org armedbear lisp scripting AbclScriptEngine AbclScriptEngine is a singleton reflect ing the fact that ABCL is a singleton as well You can obtain an instance of AbclScriptEngine us ing the AbclScriptEngineFactory or by using the service provider mechanism through ScriptEngineManager refer to the javax script documentation 3 3 3 Start up and configuration file At start up i e when its constructor is invoked as part of the static initialization phase of AbclScriptEngineFactory the ABCL script engine attempts to load an init file from the classpath abcl script config lisp If present this file can be used to customize the behavior of the engine by setting a number of variables in the ABCL SCRIPT package Here is a list of the available variables use throwing debugger controls whether ABCL uses a non stand
23. Armed Bear Common Lisp User Manual Mark Evenson Erik Hulsmann Rudolf Schlatte Alessio Stalla Ville Voutilainen Version 1 3 2 April 2015 Contents 0 0 1 Preface to the Fourth Edition s ee u s e cs peanais a k y aa 4 0 0 2 Preface to the Third Edition 4 0 0 3 Preface to the Second Edition Lee 4 1 Introduction 5 Conformance Pha a aa GOR R3 5 11241 ANSI Common 25554224422445 94224 0 5 1 12 Contemporary Common Lisp want ar aaa URS wg 6 1 2 License amu ee cs chk a deu RAE 6 1 4 Contributors 222222251242 6 2 Running ABCL 7 Options 2 280035 OSIS Hees aes able NS 7 2 2 Initlalizationi late Te a Ee AOE s E 8 3 Interaction with the Hosting JVM 9 31 Lispto Java u enc a5 PA RE RO ER AA ee ADU iee deat g M 9 3 1 1 Low level Java 2 42 4 9 9 2 Java tO 11 3 2 1 Galling Lisp from Java se to Siew ee 11 3 9 Java Scripting API JSR2299 gt ca 2er eo an va 13 331 Conversions s s Bad a ragai i GR ia Teheran 14 3 3 2 Implemented JSR 223 interfaces 14 3 3 3 Start up and configuration file
24. CLASSFILES IMPORT 78 CLASSP 31 COERCE TO CONDITION 64 COERCE TO FUNCTION 65 COLLECT 31 Command Line Options 7 COMPILE FILE IF NEEDED 65 COMPILE SYSTEM 31 65 COMPILED LISP FUNCTION P 65 COMPILER DEFSTRUCT 65 COMPILER ERROR 65 COMPILER MACROEXPAND 65 COMPILER STYLE WARN 65 COMPILER SUBTYPEP 65 COMPILER UNSUPPORTED 65 COMPILER WARN 65 COMPUTE APPLICABLE METHODS 51 COMPUTE APPLICABLE METHODS USING CLASSES 51 COMPUTE CLASS PRECEDENCE LIST 51 COMPUTE DEFAULT INITARGS 51 83 DELETE EQL 66 DESCRIBE COMPILER POLICV 66 DESCRIBE JAVA OBJECT 18 DESTROY THREAD 26 DIRECT SLOT DEFINITION 51 DIRECT SLOT DEFINITION CLASS 51 DISABLE ZIP CACHE 66 DISASSEMBLE CLASS BYTES 66 DOCUMENTATION 58 DOUBLE FLOAT HIGH BITS 66 DOUBLE FLOAT LOW BITS 66 DOUBLE FLOAT NEGATIVE INFINITY 31 DOUBLE FLOAT POSITIVE INFINITY 31 DUMP CLASSPATH 18 DUMP FORM 66 DUMP JAVA STACK 31 DUMP UNINTERNED SYMBOL INDEX 66 EFFECTIVE SLOT DEFINITION 51 EFFECTIVE SLOT DEFINITION CLASS 51 EMPTY ENVIRONMENT P 66 ENSURE CLASS 51 ENSURE CLASS USING CLASS 51 ENSURE COMPATIBILITY 78 ENSURE GENERIC FUNCTION USING CLASS 51 ENSURE INPUT STREAM 66 ENSURE JAVA CLASS 18 ENSURE JAVA OBJECT 18 ENVIRONMENT 66 ENVIRONMENT ADD FUNCTION DEFINITION 66 ENVIRONMENT ADD MACRO DEFINITION 66 ENVIRONMENT ADD SYMBOL BINDING 66 ENVIRONMENT ALL FUNCTIONS 66 ENVIRONMENT ALL VARIABLES 67 ENVIRONMENT VARIABLES 67
25. D RAW 21 JFIELD TVPE 21 JINPUT STREAM 21 JINSTANCE OF P 21 JINTERFACE IMPLEMENTATION 22 JLIST TO LIST 79 JMAKE INVOCATION HANDLER 22 MAKE PROXV 22 MEMBER PROTECTED P 22 MEMBER PUBLIC P 22 MEMBER STATIC P 22 METHOD 22 METHOD LET 22 METHOD NAME 22 METHOD PARAMS 22 JMETHOD RETURN TVPE 22 JNEW 23 JNEW ARRAV 23 JNEW ARRAY FROM ARRAY 23 JNEW ARRAV FROM LIST 23 JNEW RUNTIME CLASS 23 JNULL REF P 23 JOBJECT CLASS 23 JOBJECT LISP VALUE 24 JPROPERTY VALUE 24 JREGISTER HANDLER 24 JRESOLVE METHOD 24 JRUN EXCEPTION PROTECTED 24 JSTATIC 24 JSTATIC RAW 24 J J J J J J J J LAMBDA NAME 69 LAYOUT CLASS 69 LAYOUT LENGTH 69 LAYOUT SLOT INDEX 69 LAYOUT SLOT LOCATION 69 LIST DELETE EQ 69 LIST DELETE EQL 69 LIST DIRECTORY 69 LIST TO LIST 79 LOAD COMPILED FUNCTION 70 LOAD SYSTEM FILE 70 LOGICAL HOST P 70 LOGICAL PATHNAME P 70 LOOKUP KNOWN SYMBOL 70 MACRO FUNCTION P 70 MACROEXPAND ALL 32 MAILBOX 32 MAILBOX EMPT Y P 26 MAILBOX PEEK 26 MAILBOX READ 26 85 MAILBOX SEND 26 MAKE CLASSLOADER 24 MAKE CLOSURE 70 MAKE COMPILER TYPE 70 MAKE CONDITION 59 MAKE DIALOG PROMPT STREAM 32 MAKE DOUBLE FLOAT 70 MAKE EMF CACHE 59 MAKE ENVIRONMENT 70 MAKE FILE STREAM 70 MAKE FILL POINTER OUTPUT STREAM 70 MAKE IMMEDIATE OBJECT 24 MAKE INSTANCES OBSOLETE 59 MAKE INTEGER TYPE 59 70 MAKE KEVWORD 70 MAKE LAYOUT 70 MAKE LIST 59 MAKE LOGICAL PATHNAME 59 MAKE MACRO 7
26. EPENDENT EXTENSIONS Function jinterface implementation java interface amp rest method names and defs Creates and returns an implementation of a Java interface with methods calling Lisp closures as given in METHOD NAMES AND DEFS INTERFACE is either a Java interface or a string naming one METHOD NAMES AND DEFS is an alternating list of method names strings and method definitions closures For missing methods a dummy implementation is provided that returns nothing or null depending on whether the return type is void or not This is for convenience only and a warning is issued for each undefined method Function jmake invocation handler java function not documented Generic Function jmake proxy java Returns a proxy Java object implementing the provided interface s us ing methods implemented in Lisp typically closures but implementations are free to provide other mechanisms You can pass an optional lisp this object that will be passed to the implementing methods as their first ar gument If you don t provide this object NIL will be used The second argument of the Lisp methods is the name of the Java method being im plemented This has the implication that overloaded methods are merged so you have to manually discriminate them if you want to The remaining arguments are java objects wrapping the method s parameters Function jmember protected p java member MEMBER is a protected member of its dec
27. HNAMES If the optional TOPDIR argument is specified the archive will preserve the hierarchy of PATHNAMES relative to TOPDIR Without TOPDIR there will be no sub directories in the archive i e it will be flat Appendix The JSS Dictionarv These public interfaces are provided bv the JSS contrib 77 78 APPENDIX C THE JSS DICTIONARV Variable cl user compatibility jss Whether backwards compatibility with JSS s use of CL USER has been enabled Variable do auto imports jss Whether to automatically introspect all Java classes on the classpath when JSS is loaded Function classfiles import jss directory Load all Java classes recursively contained under DIRECTORY in the cur rent process Function ensure compatibility jss Ensure backwards compatibility with JSS s use of CL USER Function find java class jss name not documented Function get java field jss object field optional try harder running in osgi Get the value of the FIELD contained in OBJECT If OBJECT is a symbol it names a dot qualified static FIELD Function hashmap to hashtable jss hashmap amp rest rest amp key keyfun function iden tity valfun function identity invert NIL table amp allow other keys Converts the a HASHMAP reference to a java util HashMap object to a Lisp hashtable The REST paramter specifies arguments to the underlying MAKE HASH TABLE call KEYFUN and VALFUN spec
28. L USER gt asdf load svstem quicklisp abcl The user may extend the CL REQUIRE mechanism by pushing function hooks into SYSTEM xMODULE PROVIDER FUNCTIO Each such hook function takes a single argument containing the symbol passed to CL REQUIRE and returns a non NIL value if it can successful resolve the symbol gt This represents a compromise with contemporary in 2011 32bit hosting architecures for which we wish to make text processing efficient Should the User require more control over UNICODE processing we recommend Edi Weisz excellent work with FLEXI STREAMS which we fully support 6This loading can be inhibited if at runtime the Java class corresponding classname clause of the system defition is present 42 CHAPTER 5 BEVOND ANSI 5 8 JSS extension of the Reader by SHARPSIGN DOUBLE QUOTE The JSS contrib consitutes an additional optional extension to the reader in the definition of the SHARPSIGN DOUBLE QUOTE reader macro See section 6 3 on page 44 for more information 5 9 ASDF asdf 3 1 4 see RBRK is packaged as core component of ABCL but not initialized by default as it relies on the CLOS subsystem which can take a bit of time to start 7 The packaged ASDF may be loaded by the ANSI REQUIRE mechanism as follows CL USER gt require asdf While this time is merely on the order of seconds for contemporary 2011 machines for applications that need to initialize quickly for example
29. OT DEFINITION 55 STANDARD EFFECTIVE SLOT DEFINITION 55 STANDARD INSTANCE ACCESS 55 74 STANDARD METHOD 55 STANDARD OBJECT P 75 STANDARD READER METHOD 55 STANDARD SLOT DEFINITION 55 STANDARD WRITER METHOD 55 STD ALLOCATE INSTANCE 61 STD INSTANCE CLASS 75 STD INSTANCE LAYOUT 75 STD SLOT BOUNDP 75 STD SLOT VALUE 75 STREAM OUTPUT OBJECT 61 STREAM TERPRI 61 STREAM WRITE CHAR 61 STRING CAPITALIZE 61 STRING DOWNCASE 61 STRING EQUAL 61 Cadddddddddddadaad TYPE ERROR 62 NDEFINED FUNCTION CALLED 75 NREGISTER JAVA EXCEPTION 24 NTRACED FUNCTION 75 NZIP 75 PDATE DEPENDENT 55 PTIME 35 RI 37 RI DECODE 35 RI ENCODE 35 RL PATHNAME 36 37 RL PATHNAME AUTHORITY 36 38 RL PATHNAME FRAGMENT 36 38 RL PATHNAME QUERY 36 38 RL PATHNAME SCHEME 36 38 RL STREAM 76 VALIDATE SUPERCLASS 55 VECTOR DELETE EQ 76 VECTOR DELETE EQL 76 VECTOR TO LIST 79 WEAK REFERENCE 36 88 WEAK REFERENCE VALUE 36 WHITESPACEP 76 WILD PATHNAME P 62 WITH CONSTANT SIGNATURE 79 WITH MUTEX 27 WITH THREAD LOCK 27 WRITE 8 BITS 76 WRITE TIMEOUT 36 WRITE VECTOR UNSIGNED BYTE 8 76 WRITER METHOD CLASS 55 VIELD 27 ZIP 76 INDEX
30. PROCLAIMED TYPE 72 PSXHASH 72 PUT 72 PUTF 59 PUTHASH 72 QUIT 33 READ 8 BITS 72 READ TIMEOUT 34 READ VECTOR UNSIGNED BVTE 8 73 READER METHOD CLASS 53 RECORD SOURCE INFORMATION 73 REGISTER JAVA EXCEPTION 24 REINIT EMF CACHE 59 RELEASE MUTEX 27 INDEX REMEMBER 73 REMOVE DEPENDENT 53 REMOVE DIRECT METHOD 53 REMOVE DIRECT SUBCLASS 53 REMOVE PACKAGE LOCAL NICKNAME 34 40 REMOVE ZIP CACHE ENTRY 73 REPL 7 REQUIRE TYPE 73 RESOLVE 34 RUN PROGRAM 73 RUN SHELL COMMAND 34 SERVER SOCKET CLOSE 34 SET CALL COUNT 73 SET CAR 73 SET CDR 74 SET CHAR 74 SET CLASS DEFAULT INITARGS 59 SET CLASS DIRECT DEFAULT INITARGS 60 SET CLASS DIRECT METHODS 60 SET CLASS DIRECT SLOTS 60 SET CLASS DIRECT SUBCLASSES 60 SET CLASS DIRECT SUPERCLASSES 60 SET CLASS DOCUMENTATION 60 SET CLASS FINALIZED P 60 SET CLASS LAYOUT 60 SET CLASS NAME 60 SET CLASS PRECEDENCE LIST 60 SET CLASS SLOTS 60 SET DOCUMENTATION 60 SET FILL POINTER 60 SET FIND CLASS 60 SET FLOATING POINT MODES 34 SET FUNCALLABLE INSTANCE FUNCTION 53 SET FUNCTION INFO VALUE 74 SET HOT COUNT 74 SET JAVA FIELD 79 SET SCHAR 74 SET STANDARD INSTANCE ACCESS 60 SET STD INSTANCE LAYOUT 60 SET STD SLOT VALUE 74 SET TO LIST 79 SETF FUNCTION NAME P 74 SHA256 74 SHOW RESTARTS 34 SHRINK VECTOR 74 SIMPLE FORMAT 74 SIMPLE SEARCH 74 SIMPLE STRING FILL 34 SIMPLE STRING SEARCH 34 SIMPLE TVPEP 74 SINGLE FLOAT BITS 74 INDEX
31. STING JVM jmake proxy interface implementation optional lisp this gt proxy interface is a Java interface metaobject e g obtained by invoking jclass or a string naming a Java interface implementation is the object used to implement the interface several built in methods of jmake proxy exist for various types of implementations lisp this is an object passed to the closures implementing the Lisp methods of the interface and defaults to NIL The returned proxy is an instance of the interface with methods implemented with Lisp functions Built in interface implementation types include e a single Lisp function which upon invocation of any method in the interface will be passed the method name the Lisp this object and all the parameters Useful for interfaces with a single method or to implement custom interface implementation strategies e a hash map of method name Lisp function mappings Function signature is lisp this amp rest args e Lisp package The name of the Java method to invoke is first transformed in an idiomatic Lisp name javaMethodName becomes JAVA METHOD NAME and a symbol with that name is searched in the package If it exists and is fbound the corresponding function will be called Function signature is as the hash table case This functionality is exposed by the class AbciScriptEngine via the two methods getInterface Class and getInterface Object Class The former returns an interface implemented wi
32. a web server this time might be unnecessarily long Chapter 6 Contrib The ABCL contrib is packaged as a separate jar archive usuallv named abcl contrib jar or possiblv something like abcl contrib 1 3 2 jar The contrib jar is not loaded the imple mentation bv default and must be first intialized bv the REQUIRE mechanism before using anv specific contrib CL USER gt require abcl contrib 6 1 abcl asdf This contrib enables an additional syntax for ASDF system definition which dynamically loads JVM artifacts such as jar archives via encapsulation of the Maven build tool The Maven Aether component can also be directly manipulated by the function associated with the ABCL ASDF RESOLVE DEPENDENCIES symbol When loaded abcl asdf adds the following objects to ASDF JAR FILE JAR DIRECTORY CLASS FILE DIRECTORY and MVN exporting them and others as public symbols 6 1 1 Referencing Maven Artifacts via ASDF Maven artifacts may be referenced within ASDF system definitions as the following example ref erences the log4j 1 4 9 jar JVM artifact which provides a widely used abstraction for handling logging systems jii Mode LISP in package asdf defsystem log4j components mvn log4j log4j version 1 4 9 6 1 2 API We define an API for ABCL ASDF as consisting of the following ASDF classes JAR DIRECTORY JAR FILE and CLASS FILE DIRECTORY for JVM artifacts that have a cur rently valid pathname repre
33. aluate code in what JSR 223 calls a ScriptContext basically a flat environ ment of name value pairs This context is used to establish special bindings for all the variables defined in it since variable names are strings from Java s point of view they are first interned using READ FROM STRING with as usual ABCL SCRIPT USER as the default package Variables are declared special because CL s LOAD EVAL and COMPILE functions work in a null lexical environment and would ignore non special bindings Contrary to what the function LOAD does evaluation of a series of forms returns the value of the last form instead of T so the evaluation of short scripts does the Right Thing 3 3 5 Compilation AbclScriptEngine implements the javax script Compilable interface Currently it only sup ports compilation using temporary files Compiled code returned as an instance of javax script CompiledScript is read compiled and executed by default in the ABCL SCRIPT USER package just like evaluated code In contrast to evaluated code though due to the way the ABCL compiler works compiled code contains no reference to top level self evaluating objects like numbers or strings Thus when evaluated a piece of compiled code will return the value of the last non self evaluating form for example the code do something 42 will return 42 when interpreted but will return the result of do something when compiled and later evaluated To ensure consi
34. ard debugging hook function to throw a Java exception instead of dropping into the debugger in case of unhandled error conditions e Default value T e Rationale it is more convenient for Java programmers using Lisp as a scripting language to have it return exceptions to Java instead of handling them in the Lisp world e Known Issues the non standard debugger hook has been reported to misbehave in certain circumstances so consider disabling it if it doesn t work for you launch swank at startup If true Swank will be launched at startup See swank dir and swank port e Default value NIL swank dir The directory where Swank is installed Must be set if 1aunch swank at startup is true 3 3 JAVA SCRIPTING API JSR 223 15 swank port The port where Swank will listen for connections Must be set if klaunch swank at startupx is true e Default value 4005 Additionally at startup the AbclScriptEngine will require asdf in fact it uses asdf to load Swank 3 3 4 Evaluation Code is read and evaluated in the package ABCL SCRIPT USER This packages USEs the COMMON LISP JAVA and ABCL SCRIPT packages Future versions of the script engine might make this default package configurable The CL LOAD function is used under the hood for evaluating code and thus the behavior of LOAD is guaranteed This allows among other things IN PACKAGE forms to change the package in which the loaded code is read It is possible to ev
35. argument Accessing Java object and class fields Fields in Java objects can be accessed using the getter and setter functions JAVA JFIELD and SETF JAVA JFIELD Static class fields are accessed the same way but with a class object or string naming a class as first argument Like JAVA JCALL and friends values returned from these accessors carry an intended class around and values which can be converted to Lisp values will be converted 3 2 Java to Lisp This section describes the various ways that one interacts with Lisp from Java code In order to access the Lisp world from Java one needs to be aware of a few things the most important ones being listed below e All Lisp values are descendants of LispObject e Lisp symbols are accessible either via static members of the Symbol class or by dynamically introspecting a Package object e The Lisp dynamic environment may be saved via LispThread bindSpecial Binding and restored via LispThread resetSpecialBindings Mark e Functions can be executed by invoking LispObject execute args 3 2 1 Calling Lisp from Java Note the entire ABCL Lisp system resides in the org armedbear lisp package but the following code snippets do not show the relevant import statements in the interest of brevity An example of the import statement would be import org armedbear lisp 12 CHAPTER 3 INTERACTION WITH THE HOSTING JVM to potentially import all the JVM symbol from the or
36. ava jar abcl jar N b for the proceeding command to work the java executable needs to be in your path To facilitate the use of ABCL in tool chains such as SLIME sli the Superior Lisp Interaction Mode for Emacs we provide both a Bourne shell script and a DOS batch file If you or your administrator adjusted the path properly ABCL may be executed simply as cmd abcl Probably the easiest way of setting up an editing environment using the EMACS editor is to use QUICKLISP and follow the instructions at http www quicklisp org beta slime 2 1 Options ABCL supports the following command line options help displays a help message noinform Suppresses the printing of startup information and banner noinit suppresses the loading of the abclrc startup file nosystem suppresses loading the system lisp customization file eval FORM evaluates FORM before initializing the REPL load FILE loads the file FILE before initializing the REPL load system file FILE loads the system file FILE before initializing the REPL batch evaluates forms specified by arguments and in the initialization file 7 abclrc and then exits without starting a REPL of the command line arguments following the occurrence of are passed unprocessed into a list of strings accessible via the variable EXT COMMAND LINE ARGUMENT LIST from within ABCL I Read Eval Print Loop a Lisp command line 8 CHAPTER 2 RUNNING ABCL 2 2 Initia
37. class 1 class 2 Returns T if CLASS 1 is a superclass or interface of CLASS 2 Function jcoerce java object intended class Attempts to coerce OBJECT into a JavaObject of class INTENDED CLASS Raises a TYPE ERROR if no conversion is possible Function jconstructor java class ref amp rest parameter class refs Returns a reference to the Java constructor of CLASS REF with the given PARAMETER CLASS REFS Function jconstructor params java constructor Returns a vector of parameter types Java classes for CONSTRUCTOR Function jequal java obj1 obj2 Compares objl with obj2 using java lang Object equals 4 1 JAVA 21 Function jfield java class ref or field field or instance Boptional instance value Retrieves or modifies a field in a Java class or instance Supported argument patterns Case 1 class ref field name Retrieves the value of a static field Case 2 class ref field name instance ref Retrieves the value of a class field of the instance Case 3 class ref field name primitive value Stores a primitive value in a static field Case 4 class ref field name instance ref value Stores value in a class field of the instance Case 5 class ref field name nil value Stores value in a static field when value may be confused with an instance ref Case 6 field name instance Retrieves the value of a field of the in stance The class is derived from the instance Case 7 field name instance valu
38. cumented Function available encodings system Returns all charset encodings suitable for passing to a stream constructor available at runtime Macro aver system not documented Function backtrace system Returns a Java backtrace of the invoking thread Function built in function p system not documented Function cache emf system generic function args emf not documented Function call count system not documented Variable call registers limit system not documented Function canonicalize logical host system host not documented Function check declaration type system name not documented Function check sequence bounds system sequence start end not documented Function coerce to condition system datum arguments default type fun name not documented 65 Function coerce to function system not documented Function compile file if needed system input file Brest allargs amp key force compile amp allow other keys not documented Function compile system extensions amp key quit zip t cls ext compile file class extension abcl ext compile file type output path not documented Function compiled lisp function p system object not documented Function compiler defstruct system name amp key conc name default constructor con structors copier include type named initial offset predicate print function print object
39. d Function assql extensions not documented Function autoload extensions symbol or symbols optional filename Setup the autoload for S YMBOL OR SYMBOLS optionally corresponding to FILENAME Function autoload macro extensions not documented Function autoload ref p extensions symbol Boolean predicate for whether SYMBOL has generalized reference functions which need to be resolved Function autoload setf expander extensions symbol or symbols filename Setup the autoload for S YMBOL OR SYMBOLS on the setf expander from FILENAME Function autoload setf function extensions symbol or symbols filename Setup the autoload for SYMBOL OR SYMBOLS on the setf function from FILENAME 4 3 EXTENSIONS 31 Function autoloadp extensions symbol Boolean predicate for whether SYMBOL stands for a function that cur rently needs to be autoloaded Function cancel finalization extensions object not documented Function char to utf8 extensions not documented Function charpos extensions stream not documented Function classp extensions not documented Macro collect extensions not documented Function compile system extensions amp key quit zip t cls ext compile file class extension abcl ext compile file type output path not documented Variable double float negative infinity extensions not documented Variable double float pos
40. d are recognizable by their name ending with RAW 3 1 1 Low level Java This subsection covers the low level API available after evaluating require JAVA A higher level Java API developed by Alan Ruttenberg is available in the contrib directory and described later in this document see Section 6 3 on page 44 Calling Java Object Methods There are two ways to call a Java object method in the low level basic e Call a specific method reference which was previously acquired e Dynamic dispatch using the method name and the call specific arguments provided by finding the best match see Section 3 1 1 JAVA JMETHOD is used to acquire a specific method reference The function takes two or more arguments The first is a Java class designator a JAVA JAVA CLASS object returned by JAVA JCLASS or a string naming a Java class The second is a string naming the method Any arguments beyond the first two should be strings naming Java classes with one exception as listed in the next paragraph These classes specify the types of the arguments for the method lForeign Function Interface is the term of art for the part of a Lisp implementation which implements calling code written in other languages typically normalized to the local C compiler calling conventions 9 10 CHAPTER 3 INTERACTION WITH THE HOSTING JVM When JAVA JMETHOD is called with three parameters and the last parameter is an integer the first meth
41. dicates PATHNAME URL P and PATHNAME JAR P See for the draft of the publication of the technical details The case of inner and outer EXT JAR PATHNAME 77 arises when zip archives themselves contain zip archives which is the case when the ABCL fasl is included in the abcl jar zip archive 5 3 PACKAGE LOCAL NICKNAMES 39 5 3 Package Local Nicknames ABCL allows giving packages local nicknames they allow short and easy to use names to be used without fear of name conflict associated with normal nicknames A local nickname is valid only when inside the package for which it has been specified Different packages can use same local nickname for different global names or different local nickname for same global name Symbol package local nicknames in features denotes the support for this feature The options to def package are extended with a new option local nicknames local nickname actual package name The new package has the specified local nicknames for the corresponding actual packages Example defpackage bar intern X defpackage foo intern X defpackage quux use 1 1ocal nicknames bar foo foo bar find symbol X foo gt FOD X find symbol X bar gt BAR X let package find package quux find symbol X foo gt BAR X let package find package quux find symbol X bar gt FOO X Function package local nicknames ext packa
42. direct slots slots inherited accessors documentation not documented Function compiler error system format control amp rest format arguments not documented Function compiler macroexpand system form optional env not documented Function compiler style warn system format control amp rest format arguments not documented Function compiler subtypep system compiler type typespec not documented Function compiler unsupported system format control amp rest format arguments not documented Function compiler warn system format control amp rest format arguments not documented Function concatenate fasls system inputs output not documented Macro defconst system not documented Macro define source transform system not documented Macro defknown system not documented 66 APPENDIX B THE SVSTEM DICTIONARV Function delete eq system item sequence not documented Function delete eql system item sequence not documented Function describe compiler policy system not documented Function disable zip cache system Disable all caching of ABCL FASLs and ZIPs Function disassemble class bytes system java object not documented Function double float high bits system float not documented Function double float low bits system float not documented Function dump form system form stream not documented
43. e Stores value in a field of the instance The class is derived from the instance Function jfield name java field Returns the name of FIELD as a Lisp string Function jfield raw java class ref or field field or instance Boptional instance value Retrieves or modifies a field in a Java class or instance Does not attempt to coerce its value or the result into a Lisp object Supported argument patterns Case 1 class ref field name Retrieves the value of a static field Case 2 class ref field name instance ref Retrieves the value of a class field of the instance Case 3 class ref field name primitive value Stores a primitive value in a static field Case 4 class ref field name instance ref value Stores value in a class field of the instance Case 5 class ref field name nil value Stores value in a static field when value may be confused with an instance ref Case 6 field name instance Retrieves the value of a field of the in stance The class is derived from the instance Case 7 field name instance value Stores value in a field of the instance The class is derived from the instance Function jfield type java field Returns the type Java class of FIELD Function jinput stream java pathname Returns a java io InputStream for resource denoted by PATHNAME Function jinstance of p java obj class OBJ is an instance of CLASS or one of its subclasses 22 CHAPTER 4 IMPLEMENTATION D
44. e loading CL LOAD understands 5 2 Pathname We implement an extension to the CL PATHNAME that allows for the description and retrieval of resources named a URI l scheme that the JVM understands By definition support is built in into the JVM to access the http and https schemes but additional protocol handlers may be installed at runtime by having JVM symbols present in the sun net protocol dynamic package See Mas00 for more details ABCL has created specializations of the ANSI CL PATHNAME object to enable to use of URIs to address dynamically loaded resources for the JVM The EXT URL PATHNAME specialization has a corresponding URI whose canonical representation is defined to be the NAMESTRING of the CL The EXT JAR PATHNAME extension further specializes the the EXT URL PATHNAME to provide access to components of zip archives prefix ext http abcl not org cl packages extensions Oprefix cl lt http abcl not org cl packages common lisp gt lt ext jar pathname gt a lt ext url pathnane gt lt ext url pathname gt a lt cl pathname gt lt cl logical pathname gt a lt cl pathname gt Both the EXT URL PATHNAME and EXT JAR PATHNAME objects may be used anywhere a CL PATHNAME is accepted with the following caveats A stream obtained via CL OPEN on a CL URL PATHNAME cannot be the target of write oper ations URI is essentially a superset of what is commonly und
45. ect not documented Function structure ref system instance index not documented Function structure set system instance index new value not documented Function subclassp system class not documented Function svset system simple vector index new value not documented Function swap slots system instance 1 instance 2 not documented Function symbol macro p system value not documented Function undefined function called system name arguments not documented Function untraced function system name not documented Function unzip system pathname amp optional directory unzipped pathnames Unpack zip archive at PATHNAME returning a list of extracted pathnames If the optional DIRECTORY is specified root the abstraction in that directory otherwise use the current value of DEFAULT PATHNAME DEFAULTS 76 APPENDIX B THE SVSTEM DICTIONARV Class url stream system not documented Function vector delete eq system item vector not documented Function vector delete eql system item vector not documented Function whitespacep system not documented Function write 8 bits system byte stream not documented Function write vector unsigned byte 8 system vector stream start end not documented Function zip system pathname pathnames C optional topdir Creates a zip archive at PATHNAME whose entries enumerated via the list of PAT
46. ed function system source not documented Function load system file system not documented Function logical host p system canonical host not documented Function logical pathname p system object Returns true if OBJECT is of type logical pathname otherwise returns false Function lookup known symbol system not documented Function macro function p system value not documented Function make closure system not documented Function make compiler type system typespec not documented Function make double float system bits not documented Function make environment system amp optional parent environment not documented Function make file stream system pathname namestring element type direction if exists external format not documented Function make fill pointer output stream system not documented Function make integer type system type not documented Function make key word system symbol not documented Function make layout system class instance slots class slots not documented Function make macro system name erpansion function not documented Function make macro expander system definition not documented Function make single float system bits not documented Function make structure system not documented Function make symbol macro system expansion not documented Mac
47. erstood as a URL We sometime suse the term URL as shorthand in describing the URL Pathnames even though the corresponding encoding is more akin to a URI as described in RFC3986 BLFMO5 37 38 CHAPTER 5 BEYOND ANSI e Any results of canonicalization procedures performed on the underlying URI are discarded between resolutions i e the implementation does not attempt to cache the results of current name resolution of the representing resource unless it is requested to be resolved Upon resolution any canonicalization procedures followed in resolving the resource e g following redirects are discarded Users may programatically initiate a new local computation of the resolution of the resource by applying the CL TRUENAME function to a EXT URL PATHNAME object Depending on the reliability and properties of your local REST infrastructure these results may not necessarily be idempotent over time The implementation of EXT URL PATHNAME allows the ABCL user to dynamically load code from the network For example QUICKLISP Bea may be completely installed from the REPL as the single form CL USER gt load http beta quicklisp org quicklisp lisp will load and execute the Quicklisp setup code The implementation currently breaks ANSI conformance by allowing the types able to be CL READ for the DEVICE to return a possible CONS of CL PATHNAME objects In order to smooth over the bit about types being CL READ from CL PATHNAME compone
48. g armedbear lisp namespace There can only ever be a single Lisp interpreter per JVM instance A reference to this inter preter is obtained by calling the static method Interpreter createInstance Interpreter interpreter Interpreter createInstance If this method has already been invoked in the lifetime of the current Java process it will return null so if you are writing Java whose life cycle is a bit out of your control like in a Java servlet a safer invocation pattern might be Interpreter interpreter Interpreter getInstance if interpreter null interpreter Interpreter createInstance The Lisp eval primitive may simply be passed strings for evaluation String line load file lisp LispObject result interpreter eval line Notice that all possible return values from an arbitrary Lisp computation are collapsed into a single return value Doing useful further computation on the LispObject depends on knowing what the result of the computation might be This usually involves some amount of instanceof introspection and forms a whole topic to itself see Section 3 2 1 page 13 Using eval involves the Lisp interpreter Lisp functions may also be directly invoked by Java method calls as follows One simply locates the package containing the symbol obtains a reference to the symbol and then invokes the execute method with the desired parameters interpreter eval defun foo msg formatynily
49. ge designator Returns an ALIST of 1ocal nickname actual package describing the nicknames local to the designated package When in the designated package calls to find package with any of the local nicknames will return the corresponding actual package instead This also affects all implied calls to find package including those performed by the reader When printing a package prefix for a symbol with a package local nick name the local nickname is used instead of the real name in order to preserve print read consistency Function package locally nicknamed by list ext package designator Returns a list of packages which have a local nickname for the designated package Function add package local nickname ext local nickname actual package amp optional package designator Adds local nickname for actual package in the designated package de faulting to current package local nickname must be a string designator and actual package must be a package designator Returns the designated package Signals an error if local nickname is already a package local nickname for a different package or if local nickname is one of CL COMMON LISP or KEYWORD or if 1ocal nickname is a global name or nick name for the package to which the nickname would be added When in the designated package calls to find package with the local nickname will return the package the designated actual package instead This also affects all i
50. ifies functions to be run on the keys and values of the HASHMAP right before they are placed in the hashtable If INVERT is non nil than reverse the keys and values in the resulting hashtable Macro invoke add imports jss not documented Function invoke restargs jss method object args amp optional raw NIL not documented Function iterable to list jss iterable Return the items contained the java lang Iterable ITERABLE as a list Function japropos jss string Output the names of all Java class names loaded in the current process which match STRING Function jar import jss file Import all the Java classes contained in the pathname FILE into the JSS dynamic lookup cache 79 Function jarrav to list jss jarray Convert the Java array named by JARRARY into a Lisp list Function java class method names jss class amp optional stream Return a list of the public methods encapsulated by the JVM CLASS If STREAM non nil output a verbose description to the named output stream CLASS may either be a string naming a fully qualified JVM class in dot notation or a symbol resolved against all class entries in the current classpath Function jclass all interfaces jss class Return a list of interfaces the class implements Function jemn jss not documented Function jlist to list jss list Convert a LIST implementing java util List to a Lisp list Function l
51. ist to list jss list not documented Function new jss class name amp rest args Invoke the Java constructor for CLASS NAME with ARGS CLASS NAME may either be a symbol or a string according to the usual JSS conventions Function set java field jss object field value amp optional try harder running in osgi Set the FIELD of OBJECT to VALUE If OBJECT is a symbol it names a dot qualified Java class to look for a static FIELD If OBJECT is an instance of java java object the associated is used to look up the static FIELD Function set to list jss set not documented Function vector to list jss vector Return the elements of java lang Vector VECTOR a list Macro with constant signature jss not documented 80 APPENDIX THE JSS DICTIONARV Bibliographv Bea BLFMO5 Gro06 Mas00 96 RBRK Rho09 sli Zach Beane Quicklisp http www quicklisp org Last accessed Jan 25 2012 Tim Berners Lee Roy Fielding and Larry Masinter Rfc 3986 Uri generic syntax http www ietf org rfc rfc3986 txt 2005 Last accessed Feb 5 2012 Mike Grogan Scripting for the Java platform Final Draft Specification JSR 223 Sun Microsystems Inc 2006 http jcp org aboutJava communityprocess final jsr223 index html Brian Maso new era for Java protocol handlers http java sun com developer onlineTraining protocolhandlers August 2000 Last accessed Jan 25 20
52. it fasl system amp key version not documented Function inline expansion system name not documented Function inline p system name not documented Function inspected parts system not documented Function integer constant value system compiler type not documented Function integer type high system not documented Function integer type low system not documented Function integer type p system object not documented Function interactive eval system not documented Function internal compiler error system format control amp rest format arguments not documented Class jar stream system not documented Function java long type p system compiler type not documented Function lambda name system not documented Function layout class system layout not documented Function layout length system layout not documented Function layout slot index system not documented Function layout slot location system layout slot name not documented Function list delete eq system item list not documented Function list delete eql system item list not documented Function list directory system directory optional resolve symlinks nil Lists the contents of DIRECTORY optionally resolving symbolic links 69 70 APPENDIX B THE SVSTEM DICTIONARV Function load compil
53. itive infinity extensions not documented Function dump java stack extensions not documented Function exit extensions amp key status not documented Function featurep extensions form not documented Function file directorv p extensions pathspec not documented Function finalize extensions object function not documented Function fixnump extensions not documented Function gc extensions not documented 32 CHAPTER 4 IMPLEMENTATION DEPENDENT EXTENSIONS Function get floating point modes extensions not documented Function get socket stream extensions socket amp key element type quote character erternal format default ELEMENT TYPE must be CHARACTER or UNSIGNED BYTE 8 the default is CHARACTER EXTERNAL FORMAT must be of the same format as specified for OPEN Function getenv extensions variable Return the value of the environment VARIABLE if it exists otherwise return NIL Function getenv all extensions variable Returns all environment variables as an alist containing name value Function init gui extensions Dummy function used to autoload this file Function interrupt lisp extensions not documented Class jar pathname extensions not documented Function macroexpand all extensions form C optional env not documented Class mailbox extensions not documented Function make dialog pr
54. just as like one would traverse a list in Lisp LispObject result interpreter eval 1 2 4 45 while result Symbol NIL doSomething result car result result cdr 3 3 Java Scripting API JSR 223 ABCL can be built with support for JSR 223 Gro06 which offers a language agnostic API to invoke other languages from Java The binary distribution download able from ABCL s homepage is built with JSR 223 support If you re building ABCL from source on a pre 1 6 JVM you need to 14 CHAPTER 3 INTERACTION WITH THE HOSTING JVM have a JSR 223 implementation in your classpath such as Apache Commons BSF 3 x or greater in order to build ABCL with JSR 223 support otherwise this feature will not be built This section describes the design decisions behind the ABCL JSR 223 support It is not a description of what JSR 223 is or a tutorial on how to use it See http abcl org trac browser trunk abcl examples jsr 223 for example usage 3 3 1 Conversions In general ABCL s implementation of the JSR 223 API performs implicit conversion from Java objects to Lisp objects when invoking Lisp from Java and the opposite when returning values from Java to Lisp This potentially reduces coupling between user code and ABCL To avoid such conversions wrap the relevant objects in JavaObject instances 3 3 2 Implemented JSR 223 interfaces JSR 223 defines three main interfaces of which two Invocable and Compilable are optional
55. kaging ASDF systems into jar archives for ABCL Given a running ABCL image with loadable ASDF systems the code in this package will recur sively package all the required source and fasls in a jar archive The documentation for this contrib can be found at http abcl org svn tags 1 3 2 contrib asdf jar README markdown 6 3 jss To one used to the more universal syntax of Lisp pairs upon which the definition of read and compile time macros is quite natural the Java syntax available to the Java programmer may be said to suck To alleviate this situation the JSS contrib introduces the SHARPSIGN DOUBLE QUOTE reader macro which allows the the specification of the name of invoking function as the first element of the relevant s expr which tends to be more congruent to how Lisp programmers seem to be wired to think While quite useful we don t expect that the JSS contrib will be the last experiment in wrangling Java from Common Lisp 6 3 1 JSS usage Example CL USER gt require abcl contrib gt ABCL CONTRIB CL USER gt require jss gt JSS CL USER getProperties java lang System gt lt java util Properties java runtime name Java 2FA21ACF gt CL USER propertyNames getProperties java lang System gt lt java util Hashtable Enumerator java util Has 36B4361A gt 1See Graham s On Lisp http lib store yahoo net lib paulgraham onlisp pdf 6 4 JFLI 45 S
56. laring class Function jmember public p java member MEMBER is a public member of its declaring class Function jmember static p java member MEMBER is a static member of its declaring class Function jmethod java class ref method name amp rest parameter class refs Returns a reference to the Java method METHOD NAME of CLASS REF with the given PARAMETER CLASS REFS Macro jmethod let java not documented Function jmethod name java method Returns the name of METHOD as a Lisp string Function jmethod params java method Returns a vector of parameter types Java classes for METHOD Function jmethod return type java method Returns the result type Java class of the METHOD 4 1 JAVA 23 Function jnew java constructor amp rest args Invokes the Java constructor CONSTRUCTOR with the arguments ARGS Function jnew array java element type amp rest dimensions Creates a new Java array of type ELEMENT TYPE with the given DI MENSIONS Function jnew array from array java element type array Returns a new Java array with base type ELEMENT TVPE a string or a class ref initialized from ARRAY Function jnew array from list java element type list Returns a new Java array with base type ELEMENT TVPE a string or a class ref initialized from a Lisp list Function jnew runtime class java class name amp rest args amp key superclass java lang Object
57. lected in the THREADS package Most of the abstractions in Doug Lea s excellent java util concurrent packages may be manipulated directly via the JSS contrib to great effect 26 CHAPTER 4 IMPLEMENTATION DEPENDENT EXTENSIONS Function current thread threads Returns a reference to invoking thread Function destroy thread threads not documented Function get mutex threads muter Acquires a lock on the mutex Function interrupt thread threads thread function Crest args Interrupts THREAD and forces it to apply FUNCTION to ARGS When the function returns the thread s original computation continues If mul tiple interrupts are queued for a thread they are all run but the order is not guaranteed Function mailbox empty p threads mailbox Returns non NIL if the mailbox can be read from NIL otherwise Function mailbox peek threads mailbox Returns two values The second returns non NIL when the mailbox is empty The first is the next item to be read from the mailbox Note that due to multi threading the first value returned upon peek may be different from the one returned upon next read in the calling thread Function mailbox read threads mailbox Blocks on the mailbox until an item is available for reading When an item is available it is returned Function mailbox send threads mailbox item Sends an item into the mailbox notifying 1 waiter to wake up for ret
58. lization If the ABCL process is started without the noinit flag it attempts to load a file named abclrc in the user s home directory and then interpret its contents The user s home directory is determined by the value of the JVM system property user home This value may or may not correspond to the value of the HOME system environment variable at the discretion of the JVM implementation that ABCL finds itself hosted upon Chapter 3 Interaction with the Hosting JVM The Armed Bear Common Lisp implementation is hosted on a Java Virtual Machine This chapter describes the mechanisms which the implementation interacts with that hosting mechanism 3 1 Lisp to Java ABCL offers a number of mechanisms to interact with Java from its Lisp environment It allows calling both instance and static methods of Java objects manipulation of instance and static fields on Java objects and construction of new Java objects When calling Java routines some values will automatically be converted by the FFI from Lisp values to Java values These conversions typically apply to strings integers and floats Other values need to be converted to their Java equivalents by the programmer before calling the Java object method Java values returned to Lisp are also generally converted back to their Lisp counterparts Some operators make an exception to this rule and do not perform any conversion those are the raw counterparts of certain FFI functions an
59. llection API erase all types to Object The user can always force a more specific intended class by using the JAVA JCOERCE operator The Java reflection API is found in the java lang reflect package 65 3 2 JAVA TO LISP 11 Calling Java class static methods Like non static methods references to static methods can be acquired bv using the JAVA JMETHOD primitive Static methods are called with JAVA JSTATIC instead of JAVA JCALL Like JAVA JCALL JAVA JSTATIC supports dvnamic dispatch bv passing the name of the method as a string instead of passing a method reference The parameter values should be values to pass in the function call instead of a specification of classes for each parameter Parameter matching for FFI dvnamic dispatch algorithm used to resolve the best matching method given the name and the arguments tvpes is the same as described in the Java Language Specification Anv deviation should be reported as a bug Instantiating Java objects Java objects can be instantiated created from Lisp by calling a constructor from the class of the object to be created The JAVA JCONSTRUCTOR primitive is used to acquire a constructor reference It s arguments specify the types of arguments of the constructor method the same way as with JAVA JMETHOD The obtained constructor is passed as an argument to JAVA JNEW together with any arguments JAVA JNEW can also be invoked with a string naming the class as its first
60. me url p extensions pathname Predicate for whether PATHNAME references a URL Function precompile extensions name optional definition not documented Function probe directory extensions pathspec not documented Function quit extensions amp key status not documented 33 34 CHAPTER 4 IMPLEMENTATION DEPENDENT EXTENSIONS Function read timeout extensions socket seconds Time in SECONDS to set local implementation of SO RCVTIMEO on SOCKET Function remove package local nickname extensions old nickname amp optional package designator not documented Function resolve extensions symbol Resolve the function named by SYMBOL via the autoloader mechanism Returns either the function or NIL if no resolution was possible Function run shell command extensions command amp key directory output standard output Deprecated Use SYS RUN PROGRAM Function server socket close extensions socket Close the server SOCKET Function set floating point modes extensions amp key traps not documented Function show restarts extensions restarts stream not documented Function simple string fill extensions not documented Function simple string search extensions not documented Variable single float negative infinity extensions not documented Variable single float positive infinity extensions not documented Class slime i
61. mplied calls to find package including those performed by the reader 4Package local nicknames were originally developed in SBCL 40 CHAPTER 5 BEYOND ANSI When printing a package prefix for a symbol with a package local nick name local nickname is used instead of the real name in order to preserve print read consistency Function remove package local nickname ext old nickname optional package designator If the designated package had old nickname as a local nickname for an other package it is removed Returns true if the nickname existed and was removed and nil otherwise 5 4 Extensible Sequences See Rhodes2007 Rho09 for the design The SEQUENCE package fully implements Christopher Rhodes proposal for extensible se quences These user extensible sequences are used directly in java collections lisp provide these CLOS abstractions on the standard Java collection classes as defined by the java util List contract This extension is not automatically loaded by the implementation It may be loaded via CL USER gt require java collections if both extensible sequences and their application to Java collections is required or CL USER gt require extensible sequences if only the extensible sequences API as specified in Rho09 is required Note that require java collections must be issued before java util List or any sub class is used as a specializer in a CLOS method definition see the section below 5 5 Exte
62. nction jclass array p java class Returns T if CLASS is an array class 20 CHAPTER 4 IMPLEMENTATION DEPENDENT EXTENSIONS Function jclass constructors java class Returns vector of constructors for CLASS Function jclass field java class field name Returns the field named FIELD NAME of CLASS Function jclass fields java class amp key declared public Returns a vector of all or just the declared public if DECLARED PUB LIC is true fields of CLASS Function jclass interface p java class Returns T if CLASS is an interface Function jclass interfaces java class Returns the vector of interfaces of CLASS Function jclass methods java class amp key declared public Return a vector of all or just the declared public if DECLARED PUBLIC is true methods of CLASS Function jclass name java class ref amp optional name When called with one argument returns the name of the Java class des ignated by CLASS REF When called with two arguments tests whether CLASS REF matches NAME Function jclass of java object amp optional name Returns the name of the Java class of OBJECT If the NAME argument is supplied verifies that OBJECT is an instance of the named class The name of the class or nil is always returned as a second value Function jclass superclass java class Returns the superclass of CLASS or NIL if it hasn t got one Function jclass superclass p java
63. ngs naming fully qualified java classes or Lisp keywords referring to primitive types void int etc FUNCTION is a Lisp function of minimum arity 1 length argument types The instance this is passed as the first argument Field definitions are lists of the form field name type amp key modifiers annotations Function jnull ref p java object Returns a non NIL value when the JAVA OBJECT object is null or signals a TYPE ERROR condition if the object isn t of the right type Function jobject class java obj Returns the Java class that OBJ belongs to 24 CHAPTER 4 IMPLEMENTATION DEPENDENT EXTENSIONS Function jobject lisp value java java object Attempts to coerce JAVA OBJECT into a Lisp object Function jproperty value java object property setf able access on the Java Beans notion of property named PROPETRY on OBJECT Function jregister handler java object event handler amp key data count not documented Function jresolve method java method name instance amp rest args Finds the most specific Java method METHOD NAME on INSTANCE applicable to arguments ARGS Returns NIL if no suitable method is found The algorithm used for resolution is the same used by JCALL when it is called with a string as the first parameter METHOD REF Function jrun exception protected java closure Invokes the function CLOSURE and returns the result Signals an error if stack or hea
64. nput stream extensions not documented Class slime output stream extensions not documented Function socket accept extensions socket Block until able to return a new socket for handling a incoming request to the specified server SOCKET Function socket close extensions socket Close the client SOCKET 4 3 EXTENSIONS Function socket local address extensions socket Returns the local address of the SOCKET as a dotted quad string Function socket local port extensions socket Returns the local port number of the SOCKET Function socket peer address extensions socket Returns the peer address of the SOCKET as a dotted quad string Function socket peer port extensions socket Returns the peer port number of the given SOCKET Function source extensions not documented Function source file position extensions not documented Function source pathname extensions symbol Returns either the pathname corresponding to the file from which this symbol was compiled or the keyword TOP LEVEL Function special variable p extensions not documented Function string find extensions char string not documented Function string input stream current extensions stream not documented Function string position extensions not documented Function style warn extensions format control Crest format arguments not documented Macr
65. nsions to CLOS 5 5 1 Metaobject Protocol ABCL implements the metaobject protocol for CLOS as specified in A MOP The symbols are exported from the package MOP Contrary to the AMOP specification and following SBCL s lead the metaclass funcallable standard object has funcallable standard class as metaclass instead of standard class 5 5 2 Specializing on Java classes There is an additional syntax for specializing the parameter of a generic function on a java class viz java jclass CLASS STRING where CLASS STRING is a string naming a Java class in dotted package form For instance the following specialization would perhaps allow one to print more information about the contents of a java util Collection object defmethod print object coll java jclass java util Collection stream If the class had been loaded via a classloader other than the original the class you wish to specialize on one needs to specify the classloader as an optional third argument defparameter other classloader jcall getBaseLoader cl user classpath manager 5 6 EXTENSIONS TO THE READER 41 defmethod print object device id java jclass dto nbi service hdm alcatel com NBIDevicelD xother classloaderx stream 22325 5 6 Extensions to the Reader We implement a special hexadecimal escape sequence for specifying 32 bit characters to the Lisp reader namely we allow a sequences of the form NUzzzz to be processed by the reader as
66. nt length system not documented Variable current print level system not documented Variable debug system not documented Variable enable autocompile system not documented Variable explain system not documented Variable fasl loader system not documented Variable fasl version system not documented Variable inline declarations system not documented Variable logical pathname translations system not documented Variable noinform system not documented Variable safety system not documented Variable source system not documented Variable source position system not documented Variable space system not documented Variable speed system not documented Variable traced names system not documented Variable cl package system not documented Variable false type system not documented Variable fixnum type system not documented Variable integer type system not documented 63 64 APPENDIX B THE SVSTEM DICTIONARV Variable keyword package system not documented Variable slot unbound system not documented Variable true type system not documented Function aset system array subscripts new element not documented Function autocompile system function not do
67. nts we extend the semantics for the usual PATHNAME merge semantics when DEFAULT PATHNAME DEFAULTS contains a EXT JAR PATHNAME with the do what I mean algorithm described in 1 1 on page 5 Implementation The implementation of these extensions stores all the additional information in the CL PATHNAME object itself in ways that while strictly speaking are conformant nonetheless may trip up libraries that don t expect the following e DEVICE can be either a string denoting a drive letter under DOS or a list of exactly one or two elements If DEVICE is a list it denotes a EXT JAR PATHNAME with the entries containing CL PATHNAME objects which describe the outer and possibly inner locations of the jar archive e EXT URL PATHNAME always has a HOST component that is a property list The values of the HOST property list are always character strings The allowed keys have the following meanings SCHEME Scheme of URI http ftp bundle etc AUTHORITY Valid authority according to the URI scheme For http this could be example org 8080 QUERY The query of the URI FRAGMENT The fragment portion of the URI e In order to encapsulate the implementation decisions for these meanings the following func tions provide a SETF able API for reading and writing such values URL PATHNAME QUERY URL PATHNAME FRAGMENT URL PATHNAME AUTHORITY and URL PATHNAME SCHEME The spe cific subtype of a Pathname may be determined with the pre
68. o truly the extensions not documented Function uptime extensions not documented Function uri decode extensions not documented Function uri encode extensions not documented 35 36 CHAPTER 4 IMPLEMENTATION DEPENDENT EXTENSIONS Class url pathname extensions not documented Function url pathname authority extensions p not documented Function url pathname fragment extensions p not documented Function url pathname query extensions p not documented Function url pathname scheme extensions p not documented Class weak reference extensions not documented Function weak reference value extensions obj Returns two values the first being the value of the weak ref the second if the reference is valid or NIL if it hasbeen cleared Function write timeout extensions socket seconds No op setting of write timeout to SECONDS on SOCKET Chapter 5 Bevond ANSI Naturallv in striving to be a useful contemporarv Common Lisp implementation ABCL endeav ors to include extensions bevond the ANSI specification which are either widelv adopted or are especiallv useful in working with the hosting JVM 5 1 Compiler to Java 5 Bytecode CL COMPILE FILE interface emits a packed fasl format whose Pathname has the type abcl These fasls are operating system neutral byte archives packaged by the zip compression format which contain artifacts whos
69. od bv that name and matching number of parameters is returned Once a method reference has been acquired it can be invoked using JAVA JCALL which takes the method as the first argument The second argument is the object instance to call the method on or NIL in case of a static method Anv remaining parameters are used as the remaining arguments for the call Calling Java object methods dvnamic dispatch The second way of calling Java object methods is by using dynamic dispatch In this case JAVA JCALL is used directly without acquiring a method reference first In this case the first argument provided to JAVA JCALL is a string naming the method to be called The second argu ment is the instance on which the method should be called and any further arguments are used to select the best matching method and dispatch the call Dynamic dispatch Caveats Dynamic dispatch is performed by using the Java reflection API 2 Generally the dispatch works fine but there are corner cases where the API does not correctly reflect all the details involved in calling a Java method An example is the following Java code ZipFile jar new ZipFile path to some jar Object els jar entries Method method els getClass getMethod hasMoreElements method invoke els Even though the method hasMoreElements is public in Enumeration the above code fails with java lang IllegalAccessException Class can not access a member of class java u
70. ome more information on jss can be found in its documentation at http abcl org svn tags 1 3 2 contrib jss README markdown 6 4 jfli The contrib contains a pure Java version of JFLI http abcl org svn tags 1 3 2 contrib jfli README 6 5 asdf install The asdf install contrib provides an implementation of ASDF INSTALL Superseded by Quicklisp see Xach2011 Bea The require ofthe asdf install symbol has the side effect of pushing the directory asdf install dir systems into the value of the ASDF central registry in asdf central registry providing a convenient mechanism for stashing ABCL specific system definitions for convenient access http abcl org tags 1 3 2 contrib asdf install README 46 CHAPTER 6 CONTRIB Chapter 7 Historv ABCL was originally the extension language for the J editor which was started in 1998 Peter Graves Sometime in 2003 a whole lot of code that had previously not been released publically was suddenly committed that enabled ABCL to be plausibly termed an emergent ANSI Common Lisp implementation candidate From 2006 to 2008 Peter manned the development lists incorporating patches as made sense After a suitable search Peter nominated Erik Hiilsmann to take over the project In 2008 the implementation was transferred to the current maintainers who have strived to improve its usability as a contemporary Common Lisp implementation On October 22 2011 with the publication of this Manual
71. ompt stream extensions not documented Function make server socket extensions port Create TCP server socket listening for clients on PORT Function make slime input stream extensions function output stream not documented Function make slime output stream extensions function not documented Function make socket extensions host port Create a TCP socket for client communication to HOST on PORT Function make temp directory extensions Create and return the pathname of a previously non existent directory 4 3 EXTENSIONS Function make temp file extensions Create and return the pathname of a previously non existent file Function make weak reference extensions obj Creates a weak reference to obj Function memq extensions item list not documented Function extensions item list not documented Variable most negative java long extensions not documented Variable most positive java long extensions not documented Class mutex extensions not documented Function neq extensions obj obj2 not documented Class nil vector extensions not documented Function package local nicknames extensions package not documented Function package locally nicknamed by list extensions package not documented Function pathname jar p extensions not documented Function pathna
72. on class direct slots mop not documented Generic Function class direct subclasses mop not documented Generic Function class direct superclasses mop not documented Function class documentation mop not documented Generic Function class finalized p mop not documented Generic Function class precedence list mop not documented Generic Function class prototype mop not documented Generic Function class slots mop not documented Generic Function compute applicable methods jcommon lisp not documented Generic Function compute applicable methods using classes mop not documented Generic Function compute class precedence list mop not documented Generic Function compute default initargs mop not documented Generic Function compute discriminating function mop not documented Generic Function compute effective method mop not documented Generic Function compute effective slot definition mop not documented Generic Function compute slots mop not documented Class direct slot definition mop not documented Generic Function direct slot definition class mop not documented Class effective slot definition mop not documented Generic Function effective slot definition class mop not documented Function ensure class mop name amp rest all keys amp key
73. on generic function name mop not documented Function intern egl specializer mop object not documented Generic Function make method lambda mop not documented Generic Function map dependents mop not documented Class metaobject mop not documented Generic Function method function mop not documented Generic Function method generic function mop not documented Generic Function method lambda list mop not documented Generic Function method qualifiers common lisp not documented Generic Function method specializers mop not documented Generic Function reader method class mop not documented Generic Function remove dependent mop not documented Generic Function remove direct method mop not documented Generic Function remove direct subclass mop not documented Function set funcallable instance function mop funcallable instance function not documented Generic Function slot boundp using class mop not documented 53 54 APPENDIX A THE DICTIONARV Class slot definition system not documented Generic Function slot definition allocation mop not documented Generic Function slot definition documentation mop not documented Generic Function slot definition initargs mop not documented Generic Function slot definition initform mop no
74. ot documented Function string not greaterp system not documented Function string not lessp system not documented Function string upcase system not documented Function string system not documented Function stringj system not documented Function stringj system not documented 61 62 APPENDIX B THE SVSTEM DICTIONARV Function string system not documented Function string system not documented Function type error system datum expected type not documented Function wild pathname p system pathname keyword Predicate for determing whether PATHNAME contains wild components KEYWORD if non nil should be one of directory host device name type or version indicating that only the specified component should be checked for wildness Variable abcl contrib system Pathname of the ABCL contrib Initialized via SYSTEM FIND CONTRIB Variable compile file class extension system not documented Variable compile file environment system not documented Variable compile file type system not documented Variable compile file zip system not documented Variable compiler diagnostic system The stream to emit compiler diagnostic messages to or nil to muffle output Variable compiler error context system not documented Variable current pri
75. p exhaustion occurs Function jstatic java method class Crest args Invokes the static method METHOD on class CLASS with ARGS Function jstatic raw java method class amp rest args Invokes the static method METHOD on class CLASS with ARGS Does not attempt to coerce the arguments or result into a Lisp object Function make classloader java optional parent not documented Function make immediate object java object amp optional type Attempts to coerce a given Lisp object into a java object of the given type If type is not provided works as jobject lisp value Currently type may be BOOLEAN treating the object as a truth value or REF which returns Java null if NIL is provided Deprecated Please use JAVA NULL JAVA TRUE and JAVA FALSE for constructing wrapped primitive types JAVA JOBJECT LISP VALUE for converting a JAVA JAVA OBJECT to a Lisp value or JAVA JNULL REF P to distinguish a wrapped null JAVA OBJECT from NIL Function register java exception java exception name condition symbol Registers the Java Throwable named by the symbol EXCEPTION NAME as the condition designated by CONDITION SYMBOL Returns T if suc cessful NIL if not Function unregister java exception java exception name Unregisters the Java Throwable EXCEPTION NAME previously registered by REGISTER JAVA EXCEPTION 4 2 THREADS 25 4 2 THREADS The extensions for handling multithreaded execution are col
76. pped Process object and the PROCESS INPUT PROCESS OUTPUT and PROCESS ERROR streams c f http download oracle com javase 6 docs api java lang Process html Notes about Unix environments as in the environment The ABCL implementation of run program like SBCL Perl and many other programs copies the Unix environment by default Running Unix programs from a setuid process or in any other situ ation where the Unix environment is under the control of someone else is a mother lode of security problems If you are contemplating doing this read about it first The Perl community has a lot of good documentation about this and other security issues in script like programs The amp key arguments have the following meanings environment An alist of STRINGs name value describing new en vironment values that replace existing ones clear env If non NIL the current environment is cleared before the values supplied by environment are inserted wait If non NIL which is the default wait until the created process finishes If NIL continue running Lisp until the program finishes Function set call count system not documented Function set car system not documented 74 APPENDIX B THE SVSTEM DICTIONARV Function set cdr system not documented Function set char system string index character not documented Function set function info value system name indicator value not documented
77. r arcane sounding deviation from conformance is so that the result of a merge won t fill in a DEVICE with the wrong default device for the host in the sense of the fourth paragraph in the CLHS description of MERGE PATHNAMES see in P 96 the paragraph beginning If the PATHNAME explicitly specifies a host and not a device A future version of the implementation may return to conformance by using the HOST value to reflect the type explicitly 6 CHAPTER 1 INTRODUCTION Somewhat confusinglv this statement of non conformance in the accompanving user documen tation fulfills the requirements that ABCL is a conforming ANSI Common Lisp implementation according to the Common Lisp HyperSpec P 96 Clarifications to this point are solicited ABCL aims to be be a fully conforming ANSI Common Lisp implementation Any other behavior should be reported as a bug 1 1 2 Contemporary Common Lisp In addition to ANSI conformance ABCL strives to implement features expected of a contempo rary Common Lisp i e a Lisp of the post 2005 Renaissance The following known problems detract from ABCL being a proper contemporary Common Lisp e An incomplete implementation of interactive debugging mechanisms namely a no op version of STEP the inability to inspect local variables in a given call frame and the inability to resume a halted computation at an arbitrarily selected call frame e Incomplete streams abstraction in that ABCL needs suitable abstrac
78. rieval of that object Function make mailbox threads amp key queue 91973515 NIL not documented Function make mutex threads amp key in use 91973775 NIL not documented Function make thread threads function amp key name not documented Function make thread lock threads Returns an object to be used with the with thread lock macro Function mapcar threads threads not documented 4 2 THREADS 27 Function object notifv threads object Wakes up a single thread that is waiting on OBJECT s monitor If any threads are waiting on this object one of them is chosen to be awakened The choice is arbitrary and occurs at the discretion of the implementation A thread waits on an object s monitor by calling one of the wait methods Function object notify all threads object Wakes up all threads that are waiting on this OBJECT s monitor A thread waits on an object s monitor by calling one of the wait methods Function object wait threads object optional timeout Causes the current thread to block until object notify or object notify all is called on OBJECT Optionally unblock execution after TIMEOUT seconds A TIMEOUT of zero means to wait indefinitely A non zero TIMEOUT of less than a nanosecond is interpolated as a nanosecond wait See the documentation of java lang Object wait for further information Function release mutex threads mutez Releases
79. ro named lambda system not documented Function normalize type system type not documented Function note name defined system name not documented Function notinline p system name not documented Function out synonym of system stream designator not documented Function output object system object stream not documented Function package external symbols system not documented Function package inherited symbols system not documented Function package internal symbols system not documented Function package symbols system not documented Function parse body system body amp optional doc string allowed t not documented Function precompile extensions name C optional definition not documented 71 72 APPENDIX B THE SVSTEM DICTIONARV Class process system not documented Function process alive p system process Return t if process is still alive nil otherwise Function process error system not documented Function process exit code system instance The exit code of a process Function process input system not documented Function process kill system process Kills the process Function process optimization declarations system forms not documented Function process output system not documented Function process p system object not documen
80. sentation Both the and IRI classes descend from ASDF COMPONENT but do not directly have a filesystem location For use outside of ASDF system definitions we currently define one method ABCL ASDF RESOLVE DEPENDENCIES which locates downloads caches and then loads into the currently executing JVM process all re cursive dependencies annotated in the Maven pom xml graph 43 44 CHAPTER 6 CONTRIB 6 1 3 Directly Instructing Maven to Download JVM Artifacts Bypassing ASDF one can directly issue requests for the Maven artifacts to be downloaded CL USER gt abcl asdf resolve dependencies com google gwt gwt user WARNING Using LATEST for unspecified version Users evenson m2 repository com google gwt gwt user 2 4 0 rc gwt user 2 4 0 rci jar Users evenson m2 repository javax vali dation validation api 1 0 0 GA validation api 1 0 0 GA jar User s evenson m2 repository javax validation validation api 1 0 0 G A validation api 1 0 0 GA sources jar To actually load the dependency use the JAVA ADD TO CLASSPATH generic function CL USER gt java add to classpath abcl asdf resolve dependencies com google gwt gwt user Notice that all recursive dependencies have been located and installed locally from the network as well More extensive documentations and examples can be found at http abcl org svn tags 1 3 2 contrib abcl asdf README markdown 6 2 asdf jar The asdf jar contrib provides a system for pac
81. stency of behavior between interpreted and compiled code make sure the last form is always a compound form at least identity some literal object Note that this issue should not matter in real code where it is unlikely a top level self evaluating form will appear as the last form in a file in fact the Common Lisp load function always returns upon success with JSR 223 this policy has been changed to make evaluation of small code snippets work as intended 3 3 6 Invocation of functions and methods AbclScriptEngine implements the javax script Invocable interface which allows to directly call Lisp functions and methods and to obtain Lisp implementations of Java interfaces This is only partially possible with Lisp since it has functions but not methods not in the traditional OO sense at least since Lisp methods are not attached to objects but belong to generic functions Thus the method invokeMethod is not implemented and throws an UnsupportedOperationException when called The invokeFunction method should be used to call both regular and generic func tions 3 3 7 Implementation of Java interfaces in Lisp ABCL can use the Java reflection based proxy feature to implement Java interfaces in Lisp It has several built in ways to implement an interface and supports definition of new ones The JAVA JMAKE PROXY generic function is used to make such proxies It has the following signature 16 CHAPTER 3 INTERACTION WITH THE HO
82. t documented Generic Function slot definition initfunction mop not documented Generic Function slot definition location mop not documented Generic Function slot definition name mop not documented Generic Function slot definition readers mop not documented Generic Function slot definition type mop not documented Generic Function slot definition writers mop not documented Generic Function slot makunbound using class mop not documented Generic Function slot value using class mop not documented Class specializer mop not documented Generic Function specializer direct generic functions mop not documented Generic Function specializer direct methods mop not documented Class standard accessor method not documented Class standard direct slot definition not documented Class standard effective slot definition mop not documented Function standard instance access system instance location not documented Class standard method common lisp not documented Class standard reader method mop not documented Class standard slot definition not documented Class standard writer method mop not documented Generic Function update dependent mop not documented Generic Function validate superclass mop This generic function is called to de
83. ted Function process wait system process Wait for process to quit running for some reason Function proclaimed ftype system name not documented Function proclaimed type system name not documented Function psxhash system object not documented Function put system not documented Function puthash system key hash table new value Boptional default not documented Function read 8 bits system stream optional eof error p eof value not documented 73 Function read vector unsigned byte 8 system vector stream start end not documented Function record source information system name optional source pathname source position not documented Function remember system not documented Function remove zip cache entry system pathname not documented Function require type system arg type not documented Function run program system program args amp key environment wait t clear environment Run PROGRAM with ARGS in with ENVIRONMENT variables Possibly WAIT for subprocess to exit Optionally CLEAR ENVIRONMENT of the subprocess of any non specified values Creates new process running the the PROGRAM ARGS are a list of strings to be passed to the program as arguments For no arguments use nil which means that just the name of the pro gram is passed as arg 0 Returns a process structure containing the JAVA OBJECT wra
84. termine whether the class superclass is suitable for use as a superclass of class Generic Function writer method class mop not documented 55 56 APPENDIX A THE DICTIONARV Appendix The SYSTEM Dictionary The public interfaces in this package are subject to change with ABCL 1 5 57 58 APPENDIX B THE SVSTEM DICTIONARV Function allocate funcallable instance system class not documented Function class default initargs system not documented Function class direct default initargs system not documented Function class direct methods system not documented Function 96class direct slots system not documented Function class direct subclasses system not documented Function class direct superclasses system not documented Function class finalized p system not documented Function class layout system class not documented Function class name system class not documented Function class precedence list system not documented Function class slots system class not documented Function defun system name definition not documented Function documentation system object doc type not documented Function float bits system integer not documented Function in package system not documented Function make condition system not documented
85. th the cur rent Lisp package the latter allows the programmer to pass an interface implementation object which will in turn be passed to the jmake proxy generic function 3 3 8 Implementation of Java classes in Lisp See JAVA JNEW RUNTIME CLASS on 4 1 2 Chapter 4 Implementation Dependent Extensions As outlined by the CLHS ANSI conformance guidelines we document the extensions to the Armed Bear Lisp implementation made accessible to the user by virtue of being an exported symbol in the JAVA THREADS or EXTENSIONS packages 41 JAVA 4 1 1 Modifying the JVM CLASSPATH The JAVA ADD TO CLASSPATH generic functions allows one to add the specified pathname or list of pathnames to the current classpath used by ABCL allowing the dynamic loading of JVM objects CL USER gt add to classpath path to some jar N b ADD TO CLASSPATH only affects the classloader used by ABCL the value of the special variable JAVA CLASSLOADER It has no effect on Java code outside ABCL 4 1 2 Creating a synthetic Java Class at Runtime See JAVA JNEW RUNTIME CLASS on 4 1 2 17 18 CHAPTER 4 IMPLEMENTATION DEPENDENT EXTENSIONS Variable java object to string length java Length to truncate toString PRINT OBJECT output for an otherwise unspecialized JAVA OBJECT Can be set to NIL to indicate no limit Variable false java The JVM primitive value for boolean false Variable null java The JVM null object reference
86. the Java array JAVA ARRAY using the given INDICIES co ercing the result into a Lisp object if possible Function jarray ref raw java java array amp rest indices Dereference the Java array JAVA ARRAY using the given INDICIES Does not attempt to coerce the result into a Lisp object Function jarray set java java array new value amp rest indices Stores NEW VALUE at the given index in JAVA ARRAY Class java class java not documented Class java exception java not documented Function java exception cause java exception Returns the cause of JAVA EXCEPTION The cause is the Java Throw able object that caused JAVA EXCEPTION to be signalled Class java object java not documented Function java object p java object Returns T if OBJECT is a JAVA OBJECT Function jcall java method ref instance amp rest args Invokes the Java method METHOD REF on INSTANCE with arguments ARGS coercing the result into a Lisp object if possible Function jcall raw java method ref instance amp rest args Invokes the Java method METHOD REF on INSTANCE with arguments ARGS Does not attempt to coerce the result into a Lisp object Function jclass java name or class ref amp optional class loader Returns a reference to the Java class designated by NAME OR CLASS REF If the CLASS LOADER parameter is passed the class is resolved with respect to the given ClassLoader Fu
87. til zip ZipFile 2 with modifiers public at sun reflect Reflection ensureMemberAccess Reflection java at java lang reflect Method invoke Method java 583 at This is because the method has been overridden by a non public class and the reflection API unlike javac is not able to handle such a case While code like that is uncommon in Java it is typical of ABCL s FFI calls The code above corresponds to the following Lisp code let jar jnew java util zip ZipFile path to some jar let els jcall entries jar jcall hasMoreElements els except that the dynamic dispatch part is not shown To avoid such pitfalls all Java objects in ABCL carry an extra field representing the intended class of the object That class is used first by JAVA JCALL and similar to resolve methods the actual class of the object is only tried if the method is not found in the intended class Of course the intended class is always a super class of the actual class in the worst case they coincide The intended class is deduced by the return type of the method that originally returned the Java object in the case above the intended class of ELS is java util Enumeration because that is the return type of the entries method While this strategy is generally effective there are cases where the intended class becomes too broad to be useful The typical example is the extraction of an element from a collection since methods in the co
88. tion float infinity p system not documented Function float nan p system not documented Function float overflow mode system amp optional boolean not documented Function float string system not documented Function float underflow mode system amp optional boolean not documented Class forward referenced class system not documented Function frame to list system frame not documented 67 68 APPENDIX B THE SVSTEM DICTIONARV Function frame to string system frame Convert stack FRAME to a potentially readable string Function fset system name function amp optional source position arglist documentation not documented Function ftype result type system ftype not documented Function function plist system function not documented Function function result type system name not documented Function get cached emf system generic function args not documented Function get function info value system name indicator not documented Function gethash1 system key hash table not documented Function grovel java definitions in file system file out not documented Function hash table weakness system hash table Return weakness property of HASH TABLE or NIL if it has none Function hot count system not documented Function identity hash code system not documented Function in
89. tion between ANSI and Gray streams e Incomplete documentation missing docstrings from exported symbols and the draft status of this user manual 1 2 License ABCL is licensed under the terms of the GPL v2 of June 1991 with the classpath exception see the file COPYING in the source distribution for the license term 13 in the same file for the classpath exception This license broadly means that you must distribute the sources to ABCL including any changes you make together with a program that includes ABCL but that you are not required to distribute the sources of the whole program Submitting your changes upstream to the ABCL development team is actively encouraged and very much appreciated of course 1 3 Contributors Philipp Marek Thanks for the markup Douglas Miles Thanks for the whacky IKVM stuff and keeping the flame alive in the dark years Alan Ruttenberg Thanks for JSS and of course Peter Graves 5Somewhat surprisingly allowed by ANSI The streams could be optimized to the JVM NIO abstractions at great profit for binary byte level manipu lations See http abcl org svn trunk tags 1 3 2 COPYING Chapter 2 Running ABCL ABCL is packaged as a single jar file usually named either abcl jar or possibly something like abcl 1 3 2 jar if using a versioned package on the local filesystem from your system vendor This jar file can be executed from the command line to obtain a REPL viz cmd j
90. uperclasses system not documented Function set class documentation system not documented Function set class finalized p system not documented Function 96set class layout system class layout not documented Function set class name system not documented Function set class precedence list system not documented Function set class slots system class slot definitions not documented Function set documentation system object doc type documentation not documented Function set fill pointer system not documented Function set find class system not documented Function set standard instance access system instance location new value not documented Function set std instance layout system not documented Function std allocate instance system class not documented Function stream output object system not documented Function stream terpri system output stream not documented Function stream write char system character output stream not documented Function string capitalize system not documented Function string downcase system not documented Function string equal system not documented Function string greaterp system not documented Function string lessp system not documented Function string not equal system n

User Manual - Armed Bear Common Lisp (ABCL)

Contents

Download Pdf Manuals

Related Search

Related Contents