[armedbear-cvs] r14266 - branches/1.1.x/doc/manual
mevenson at common-lisp.net
mevenson at common-lisp.net
Sat Dec 1 20:57:25 UTC 2012
Author: mevenson
Date: Sat Dec 1 12:57:24 2012
New Revision: 14266
Log:
abcl-1.1.0 Manual grovel.
Modified:
branches/1.1.x/doc/manual/Makefile
branches/1.1.x/doc/manual/extensions.tex
branches/1.1.x/doc/manual/java.tex
branches/1.1.x/doc/manual/threads.tex
Modified: branches/1.1.x/doc/manual/Makefile
==============================================================================
--- branches/1.1.x/doc/manual/Makefile Sat Dec 1 11:50:07 2012 (r14265)
+++ branches/1.1.x/doc/manual/Makefile Sat Dec 1 12:57:24 2012 (r14266)
@@ -8,8 +8,10 @@
pdflatex abcl.tex
pdflatex abcl.tex
+ABCL = /Users/evenson/work/abcl-1.1.x/abcl
+
grovel:
- abcl --batch --noinform --load "grovel.lisp" --eval '(progn (grovel-docstrings-as-tex (find-package :java)) (grovel-docstrings-as-tex (find-package :extensions)) (grovel-docstrings-as-tex (find-package :threads)))'
+ $(ABCL) --batch --noinform --load "grovel.lisp" --eval '(progn (grovel-docstrings-as-tex (find-package :java)) (grovel-docstrings-as-tex (find-package :extensions)) (grovel-docstrings-as-tex (find-package :threads)))'
clean:
rm -f *.aux *.bbl *.blg *.idx *.ilg *.ind *.log *.out *.toc abcl.pdf
Modified: branches/1.1.x/doc/manual/extensions.tex
==============================================================================
--- branches/1.1.x/doc/manual/extensions.tex Sat Dec 1 11:50:07 2012 (r14265)
+++ branches/1.1.x/doc/manual/extensions.tex Sat Dec 1 12:57:24 2012 (r14266)
@@ -1,13 +1,4 @@
\paragraph{}
-\label{EXTENSIONS:COMPILE-FILE-IF-NEEDED}
-\index{COMPILE-FILE-IF-NEEDED}
---- Function: \textbf{compile-file-if-needed} [\textbf{extensions}] \textit{input-file \&rest allargs \&key force-compile \&allow-other-keys}
-
-\begin{adjustwidth}{5em}{5em}
-not-documented
-\end{adjustwidth}
-
-\paragraph{}
\label{EXTENSIONS:MOST-POSITIVE-JAVA-LONG}
\index{MOST-POSITIVE-JAVA-LONG}
--- Variable: \textbf{most-positive-java-long} [\textbf{extensions}] \textit{}
@@ -44,15 +35,6 @@
\end{adjustwidth}
\paragraph{}
-\label{EXTENSIONS:GROVEL-JAVA-DEFINITIONS}
-\index{GROVEL-JAVA-DEFINITIONS}
---- Function: \textbf{grovel-java-definitions} [\textbf{extensions}] \textit{}
-
-\begin{adjustwidth}{5em}{5em}
-not-documented
-\end{adjustwidth}
-
-\paragraph{}
\label{EXTENSIONS:*AUTOLOAD-VERBOSE*}
\index{*AUTOLOAD-VERBOSE*}
--- Variable: \textbf{*autoload-verbose*} [\textbf{extensions}] \textit{}
@@ -80,15 +62,6 @@
\end{adjustwidth}
\paragraph{}
-\label{EXTENSIONS:PROCESS-KILL}
-\index{PROCESS-KILL}
---- Function: \textbf{process-kill} [\textbf{extensions}] \textit{process}
-
-\begin{adjustwidth}{5em}{5em}
-Kills the process.
-\end{adjustwidth}
-
-\paragraph{}
\label{EXTENSIONS:NIL-VECTOR}
\index{NIL-VECTOR}
--- Class: \textbf{nil-vector} [\textbf{extensions}] \textit{}
@@ -152,6 +125,15 @@
\end{adjustwidth}
\paragraph{}
+\label{EXTENSIONS:WRITE-TIMEOUT}
+\index{WRITE-TIMEOUT}
+--- Function: \textbf{write-timeout} [\textbf{extensions}] \textit{socket seconds}
+
+\begin{adjustwidth}{5em}{5em}
+not-documented
+\end{adjustwidth}
+
+\paragraph{}
\label{EXTENSIONS:CDR}
\index{CDR}
--- Macro: \textbf{\%cdr} [\textbf{extensions}] \textit{}
@@ -175,7 +157,7 @@
--- Function: \textbf{make-socket} [\textbf{extensions}] \textit{host port}
\begin{adjustwidth}{5em}{5em}
-not-documented
+Create a TCP socket for client communication to HOST on PORT.
\end{adjustwidth}
\paragraph{}
@@ -188,15 +170,6 @@
\end{adjustwidth}
\paragraph{}
-\label{EXTENSIONS:PROCESS-INPUT}
-\index{PROCESS-INPUT}
---- Function: \textbf{process-input} [\textbf{extensions}] \textit{}
-
-\begin{adjustwidth}{5em}{5em}
-not-documented
-\end{adjustwidth}
-
-\paragraph{}
\label{EXTENSIONS:MAILBOX}
\index{MAILBOX}
--- Class: \textbf{mailbox} [\textbf{extensions}] \textit{}
@@ -233,15 +206,6 @@
\end{adjustwidth}
\paragraph{}
-\label{EXTENSIONS:PROCESS}
-\index{PROCESS}
---- Class: \textbf{process} [\textbf{extensions}] \textit{}
-
-\begin{adjustwidth}{5em}{5em}
-not-documented
-\end{adjustwidth}
-
-\paragraph{}
\label{EXTENSIONS:CADDR}
\index{CADDR}
--- Macro: \textbf{\%caddr} [\textbf{extensions}] \textit{}
@@ -251,15 +215,6 @@
\end{adjustwidth}
\paragraph{}
-\label{EXTENSIONS:SIMPLE-SEARCH}
-\index{SIMPLE-SEARCH}
---- Function: \textbf{simple-search} [\textbf{extensions}] \textit{sequence1 sequence2}
-
-\begin{adjustwidth}{5em}{5em}
-not-documented
-\end{adjustwidth}
-
-\paragraph{}
\label{EXTENSIONS:*LISP-HOME*}
\index{*LISP-HOME*}
--- Variable: \textbf{*lisp-home*} [\textbf{extensions}] \textit{}
@@ -296,6 +251,15 @@
\end{adjustwidth}
\paragraph{}
+\label{EXTENSIONS:*DISASSEMBLER*}
+\index{*DISASSEMBLER*}
+--- Variable: \textbf{*disassembler*} [\textbf{extensions}] \textit{}
+
+\begin{adjustwidth}{5em}{5em}
+not-documented
+\end{adjustwidth}
+
+\paragraph{}
\label{EXTENSIONS:CLASSP}
\index{CLASSP}
--- Function: \textbf{classp} [\textbf{extensions}] \textit{}
@@ -305,12 +269,12 @@
\end{adjustwidth}
\paragraph{}
-\label{EXTENSIONS:*DISASSEMBLER*}
-\index{*DISASSEMBLER*}
---- Variable: \textbf{*disassembler*} [\textbf{extensions}] \textit{}
+\label{EXTENSIONS:MAKE-TEMP-DIRECTORY}
+\index{MAKE-TEMP-DIRECTORY}
+--- Function: \textbf{make-temp-directory} [\textbf{extensions}] \textit{}
\begin{adjustwidth}{5em}{5em}
-not-documented
+Create and return the pathname of a previously non-existent directory.
\end{adjustwidth}
\paragraph{}
@@ -341,30 +305,12 @@
\end{adjustwidth}
\paragraph{}
-\label{EXTENSIONS:PROCESS-ERROR}
-\index{PROCESS-ERROR}
---- Function: \textbf{process-error} [\textbf{extensions}] \textit{}
-
-\begin{adjustwidth}{5em}{5em}
-not-documented
-\end{adjustwidth}
-
-\paragraph{}
\label{EXTENSIONS:SOCKET-LOCAL-PORT}
\index{SOCKET-LOCAL-PORT}
--- Function: \textbf{socket-local-port} [\textbf{extensions}] \textit{socket}
\begin{adjustwidth}{5em}{5em}
-Returns the local port number of the given socket.
-\end{adjustwidth}
-
-\paragraph{}
-\label{EXTENSIONS:PROCESS-ALIVE-P}
-\index{PROCESS-ALIVE-P}
---- Function: \textbf{process-alive-p} [\textbf{extensions}] \textit{process}
-
-\begin{adjustwidth}{5em}{5em}
-Return t if process is still alive, nil otherwise.
+Returns the local port number of the SOCKET.
\end{adjustwidth}
\paragraph{}
@@ -445,49 +391,67 @@
--- Function: \textbf{socket-close} [\textbf{extensions}] \textit{socket}
\begin{adjustwidth}{5em}{5em}
+Close the client SOCKET.
+\end{adjustwidth}
+
+\paragraph{}
+\label{EXTENSIONS:*ED-FUNCTIONS*}
+\index{*ED-FUNCTIONS*}
+--- Variable: \textbf{*ed-functions*} [\textbf{extensions}] \textit{}
+
+\begin{adjustwidth}{5em}{5em}
not-documented
\end{adjustwidth}
\paragraph{}
-\label{EXTENSIONS:UPTIME}
-\index{UPTIME}
---- Function: \textbf{uptime} [\textbf{extensions}] \textit{}
+\label{EXTENSIONS:SPECIAL-VARIABLE-P}
+\index{SPECIAL-VARIABLE-P}
+--- Function: \textbf{special-variable-p} [\textbf{extensions}] \textit{}
\begin{adjustwidth}{5em}{5em}
not-documented
\end{adjustwidth}
\paragraph{}
-\label{EXTENSIONS:*ED-FUNCTIONS*}
-\index{*ED-FUNCTIONS*}
---- Variable: \textbf{*ed-functions*} [\textbf{extensions}] \textit{}
+\label{EXTENSIONS:RESOLVE}
+\index{RESOLVE}
+--- Function: \textbf{resolve} [\textbf{extensions}] \textit{symbol}
\begin{adjustwidth}{5em}{5em}
not-documented
\end{adjustwidth}
\paragraph{}
-\label{EXTENSIONS:COMPILE-SYSTEM}
-\index{COMPILE-SYSTEM}
---- Function: \textbf{compile-system} [\textbf{extensions}] \textit{\&key quit (zip t) output-path}
+\label{EXTENSIONS:CANCEL-FINALIZATION}
+\index{CANCEL-FINALIZATION}
+--- Function: \textbf{cancel-finalization} [\textbf{extensions}] \textit{object}
\begin{adjustwidth}{5em}{5em}
not-documented
\end{adjustwidth}
\paragraph{}
-\label{EXTENSIONS:*LOAD-TRUENAME-FASL*}
-\index{*LOAD-TRUENAME-FASL*}
---- Variable: \textbf{*load-truename-fasl*} [\textbf{extensions}] \textit{}
+\label{EXTENSIONS:UPTIME}
+\index{UPTIME}
+--- Function: \textbf{uptime} [\textbf{extensions}] \textit{}
\begin{adjustwidth}{5em}{5em}
not-documented
\end{adjustwidth}
\paragraph{}
-\label{EXTENSIONS:SPECIAL-VARIABLE-P}
-\index{SPECIAL-VARIABLE-P}
---- Function: \textbf{special-variable-p} [\textbf{extensions}] \textit{}
+\label{EXTENSIONS:COMPILE-SYSTEM}
+\index{COMPILE-SYSTEM}
+--- Function: \textbf{compile-system} [\textbf{extensions}] \textit{\&key quit (zip t) (cls-ext *compile-file-class-extension*) (abcl-ext *compile-file-type*) output-path}
+
+\begin{adjustwidth}{5em}{5em}
+not-documented
+\end{adjustwidth}
+
+\paragraph{}
+\label{EXTENSIONS:*LOAD-TRUENAME-FASL*}
+\index{*LOAD-TRUENAME-FASL*}
+--- Variable: \textbf{*load-truename-fasl*} [\textbf{extensions}] \textit{}
\begin{adjustwidth}{5em}{5em}
not-documented
@@ -499,7 +463,7 @@
--- Function: \textbf{socket-accept} [\textbf{extensions}] \textit{socket}
\begin{adjustwidth}{5em}{5em}
-not-documented
+Block until able to return a new socket for handling a incoming request to the specified server SOCKET.
\end{adjustwidth}
\paragraph{}
@@ -539,24 +503,6 @@
\end{adjustwidth}
\paragraph{}
-\label{EXTENSIONS:RESOLVE}
-\index{RESOLVE}
---- Function: \textbf{resolve} [\textbf{extensions}] \textit{symbol}
-
-\begin{adjustwidth}{5em}{5em}
-not-documented
-\end{adjustwidth}
-
-\paragraph{}
-\label{EXTENSIONS:CANCEL-FINALIZATION}
-\index{CANCEL-FINALIZATION}
---- Function: \textbf{cancel-finalization} [\textbf{extensions}] \textit{object}
-
-\begin{adjustwidth}{5em}{5em}
-not-documented
-\end{adjustwidth}
-
-\paragraph{}
\label{EXTENSIONS:MAKE-SLIME-OUTPUT-STREAM}
\index{MAKE-SLIME-OUTPUT-STREAM}
--- Function: \textbf{make-slime-output-stream} [\textbf{extensions}] \textit{function}
@@ -566,48 +512,6 @@
\end{adjustwidth}
\paragraph{}
-\label{EXTENSIONS:RUN-PROGRAM}
-\index{RUN-PROGRAM}
---- Function: \textbf{run-program} [\textbf{extensions}] \textit{program args \&key environment (wait t)}
-
-\begin{adjustwidth}{5em}{5em}
-Creates a 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
-program is passed as arg 0.
-
-Returns a process structure containing the JAVA-OBJECT wrapped 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
- situation 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 \&key arguments have the following meanings:
-
-:environment
- An alist of STRINGs (name . value) describing the new
- environment. The default is to copy the environment of the current
- process.
-
-:wait
- If non-NIL, which is the default, wait until the created process
- finishes. If NIL, continue running Lisp until the program
- finishes.
-\end{adjustwidth}
-
-\paragraph{}
\label{EXTENSIONS:FIXNUMP}
\index{FIXNUMP}
--- Function: \textbf{fixnump} [\textbf{extensions}] \textit{}
@@ -635,47 +539,47 @@
\end{adjustwidth}
\paragraph{}
-\label{EXTENSIONS:INTERNAL-COMPILER-ERROR}
-\index{INTERNAL-COMPILER-ERROR}
---- Function: \textbf{internal-compiler-error} [\textbf{extensions}] \textit{format-control \&rest format-arguments}
+\label{EXTENSIONS:JAR-PATHNAME}
+\index{JAR-PATHNAME}
+--- Class: \textbf{jar-pathname} [\textbf{extensions}] \textit{}
\begin{adjustwidth}{5em}{5em}
not-documented
\end{adjustwidth}
\paragraph{}
-\label{EXTENSIONS:JAR-PATHNAME}
-\index{JAR-PATHNAME}
---- Class: \textbf{jar-pathname} [\textbf{extensions}] \textit{}
+\label{EXTENSIONS:ASSQL}
+\index{ASSQL}
+--- Function: \textbf{assql} [\textbf{extensions}] \textit{}
\begin{adjustwidth}{5em}{5em}
not-documented
\end{adjustwidth}
-NIL
-
\paragraph{}
-\label{EXTENSIONS:SIMPLE-STRING-SEARCH}
-\index{SIMPLE-STRING-SEARCH}
---- Function: \textbf{simple-string-search} [\textbf{extensions}] \textit{}
+\label{EXTENSIONS:FINALIZE}
+\index{FINALIZE}
+--- Function: \textbf{finalize} [\textbf{extensions}] \textit{object function}
\begin{adjustwidth}{5em}{5em}
not-documented
\end{adjustwidth}
\paragraph{}
-\label{EXTENSIONS:ASSQL}
-\index{ASSQL}
---- Function: \textbf{assql} [\textbf{extensions}] \textit{}
+\label{EXTENSIONS:CAR}
+\index{CAR}
+--- Macro: \textbf{\%car} [\textbf{extensions}] \textit{}
\begin{adjustwidth}{5em}{5em}
not-documented
\end{adjustwidth}
+NIL
+
\paragraph{}
-\label{EXTENSIONS:FINALIZE}
-\index{FINALIZE}
---- Function: \textbf{finalize} [\textbf{extensions}] \textit{object function}
+\label{EXTENSIONS:SIMPLE-STRING-SEARCH}
+\index{SIMPLE-STRING-SEARCH}
+--- Function: \textbf{simple-string-search} [\textbf{extensions}] \textit{}
\begin{adjustwidth}{5em}{5em}
not-documented
@@ -700,15 +604,6 @@
\end{adjustwidth}
\paragraph{}
-\label{EXTENSIONS:CAR}
-\index{CAR}
---- Macro: \textbf{\%car} [\textbf{extensions}] \textit{}
-
-\begin{adjustwidth}{5em}{5em}
-not-documented
-\end{adjustwidth}
-
-\paragraph{}
\label{EXTENSIONS:COLLECT}
\index{COLLECT}
--- Macro: \textbf{collect} [\textbf{extensions}] \textit{}
@@ -750,16 +645,7 @@
--- Function: \textbf{make-temp-file} [\textbf{extensions}] \textit{}
\begin{adjustwidth}{5em}{5em}
-not-documented
-\end{adjustwidth}
-
-\paragraph{}
-\label{EXTENSIONS:DESCRIBE-COMPILER-POLICY}
-\index{DESCRIBE-COMPILER-POLICY}
---- Function: \textbf{describe-compiler-policy} [\textbf{extensions}] \textit{}
-
-\begin{adjustwidth}{5em}{5em}
-not-documented
+Create and return the pathname of a previously non-existent file.
\end{adjustwidth}
\paragraph{}
@@ -777,7 +663,7 @@
--- Function: \textbf{socket-peer-address} [\textbf{extensions}] \textit{socket}
\begin{adjustwidth}{5em}{5em}
-Returns the peer address of the given socket as a dotted quad string.
+Returns the peer address of the SOCKET as a dotted quad string.
\end{adjustwidth}
\paragraph{}
@@ -804,7 +690,7 @@
--- Function: \textbf{server-socket-close} [\textbf{extensions}] \textit{socket}
\begin{adjustwidth}{5em}{5em}
-not-documented
+Close the server SOCKET.
\end{adjustwidth}
\paragraph{}
@@ -885,7 +771,7 @@
--- Function: \textbf{make-server-socket} [\textbf{extensions}] \textit{port}
\begin{adjustwidth}{5em}{5em}
-not-documented
+Create a TCP server socket listening for clients on PORT.
\end{adjustwidth}
\paragraph{}
@@ -898,15 +784,6 @@
\end{adjustwidth}
\paragraph{}
-\label{EXTENSIONS:AVER}
-\index{AVER}
---- Macro: \textbf{aver} [\textbf{extensions}] \textit{}
-
-\begin{adjustwidth}{5em}{5em}
-not-documented
-\end{adjustwidth}
-
-\paragraph{}
\label{EXTENSIONS:INIT-GUI}
\index{INIT-GUI}
--- Function: \textbf{init-gui} [\textbf{extensions}] \textit{}
@@ -925,15 +802,6 @@
\end{adjustwidth}
\paragraph{}
-\label{EXTENSIONS:PROCESS-EXIT-CODE}
-\index{PROCESS-EXIT-CODE}
---- Function: \textbf{process-exit-code} [\textbf{extensions}] \textit{instance}
-
-\begin{adjustwidth}{5em}{5em}
-The exit code of a process.
-\end{adjustwidth}
-
-\paragraph{}
\label{EXTENSIONS:SOURCE-FILE-POSITION}
\index{SOURCE-FILE-POSITION}
--- Function: \textbf{source-file-position} [\textbf{extensions}] \textit{}
@@ -948,7 +816,7 @@
--- Function: \textbf{socket-peer-port} [\textbf{extensions}] \textit{socket}
\begin{adjustwidth}{5em}{5em}
-Returns the peer port number of the given socket.
+Returns the peer port number of the given SOCKET.
\end{adjustwidth}
\paragraph{}
@@ -970,15 +838,6 @@
\end{adjustwidth}
\paragraph{}
-\label{EXTENSIONS:SOCKET-LOCAL-ADDRESS}
-\index{SOCKET-LOCAL-ADDRESS}
---- Function: \textbf{socket-local-address} [\textbf{extensions}] \textit{socket}
-
-\begin{adjustwidth}{5em}{5em}
-Returns the local address of the given socket as a dotted quad string.
-\end{adjustwidth}
-
-\paragraph{}
\label{EXTENSIONS:NEQ}
\index{NEQ}
--- Function: \textbf{neq} [\textbf{extensions}] \textit{obj1 obj2}
@@ -997,45 +856,45 @@
\end{adjustwidth}
\paragraph{}
-\label{EXTENSIONS:PATHNAME-JAR-P}
-\index{PATHNAME-JAR-P}
---- Function: \textbf{pathname-jar-p} [\textbf{extensions}] \textit{}
+\label{EXTENSIONS:SOCKET-LOCAL-ADDRESS}
+\index{SOCKET-LOCAL-ADDRESS}
+--- Function: \textbf{socket-local-address} [\textbf{extensions}] \textit{socket}
\begin{adjustwidth}{5em}{5em}
-not-documented
+Returns the local address of the SOCKET as a dotted quad string.
\end{adjustwidth}
\paragraph{}
-\label{EXTENSIONS:PROCESS-WAIT}
-\index{PROCESS-WAIT}
---- Function: \textbf{process-wait} [\textbf{extensions}] \textit{process}
+\label{EXTENSIONS:READ-TIMEOUT}
+\index{READ-TIMEOUT}
+--- Function: \textbf{read-timeout} [\textbf{extensions}] \textit{socket seconds}
\begin{adjustwidth}{5em}{5em}
-Wait for process to quit running for some reason.
+Time in SECONDS to set local implementation of SO\_CREVTIMEO on SOCKET.
\end{adjustwidth}
\paragraph{}
-\label{EXTENSIONS:SHOW-RESTARTS}
-\index{SHOW-RESTARTS}
---- Function: \textbf{show-restarts} [\textbf{extensions}] \textit{restarts stream}
+\label{EXTENSIONS:PATHNAME-JAR-P}
+\index{PATHNAME-JAR-P}
+--- Function: \textbf{pathname-jar-p} [\textbf{extensions}] \textit{}
\begin{adjustwidth}{5em}{5em}
not-documented
\end{adjustwidth}
\paragraph{}
-\label{EXTENSIONS:*BATCH-MODE*}
-\index{*BATCH-MODE*}
---- Variable: \textbf{*batch-mode*} [\textbf{extensions}] \textit{}
+\label{EXTENSIONS:SHOW-RESTARTS}
+\index{SHOW-RESTARTS}
+--- Function: \textbf{show-restarts} [\textbf{extensions}] \textit{restarts stream}
\begin{adjustwidth}{5em}{5em}
not-documented
\end{adjustwidth}
\paragraph{}
-\label{EXTENSIONS:PROCESS-P}
-\index{PROCESS-P}
---- Function: \textbf{process-p} [\textbf{extensions}] \textit{object}
+\label{EXTENSIONS:*BATCH-MODE*}
+\index{*BATCH-MODE*}
+--- Variable: \textbf{*batch-mode*} [\textbf{extensions}] \textit{}
\begin{adjustwidth}{5em}{5em}
not-documented
@@ -1097,15 +956,6 @@
\end{adjustwidth}
\paragraph{}
-\label{EXTENSIONS:PROCESS-OUTPUT}
-\index{PROCESS-OUTPUT}
---- Function: \textbf{process-output} [\textbf{extensions}] \textit{}
-
-\begin{adjustwidth}{5em}{5em}
-not-documented
-\end{adjustwidth}
-
-\paragraph{}
\label{EXTENSIONS:URL-PATHNAME}
\index{URL-PATHNAME}
--- Class: \textbf{url-pathname} [\textbf{extensions}] \textit{}
@@ -1115,12 +965,12 @@
\end{adjustwidth}
\paragraph{}
-\label{EXTENSIONS:COMPILER-UNSUPPORTED-FEATURE-ERROR}
-\index{COMPILER-UNSUPPORTED-FEATURE-ERROR}
---- Class: \textbf{compiler-unsupported-feature-error} [\textbf{extensions}] \textit{}
+\label{EXTENSIONS:GETENV-ALL}
+\index{GETENV-ALL}
+--- Function: \textbf{getenv-all} [\textbf{extensions}] \textit{variable}
\begin{adjustwidth}{5em}{5em}
-not-documented
+Returns all environment variables as an alist containing (name . value)
\end{adjustwidth}
\paragraph{}
@@ -1130,15 +980,6 @@
\begin{adjustwidth}{5em}{5em}
not-documented
-\end{adjustwidth}
-
-\paragraph{}
-\label{EXTENSIONS:COMPILER-ERROR}
-\index{COMPILER-ERROR}
---- Function: \textbf{compiler-error} [\textbf{extensions}] \textit{format-control \&rest format-arguments}
-
-\begin{adjustwidth}{5em}{5em}
-not-documented
\end{adjustwidth}
\paragraph{}
Modified: branches/1.1.x/doc/manual/java.tex
==============================================================================
--- branches/1.1.x/doc/manual/java.tex Sat Dec 1 11:50:07 2012 (r14265)
+++ branches/1.1.x/doc/manual/java.tex Sat Dec 1 12:57:24 2012 (r14266)
@@ -114,9 +114,7 @@
--- Function: \textbf{jclass-of} [\textbf{java}] \textit{object \&optional name}
\begin{adjustwidth}{5em}{5em}
-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.
+not-documented
\end{adjustwidth}
\paragraph{}
@@ -138,75 +136,76 @@
\end{adjustwidth}
\paragraph{}
-\label{JAVA:GET-DEFAULT-CLASSLOADER}
-\index{GET-DEFAULT-CLASSLOADER}
---- Function: \textbf{get-default-classloader} [\textbf{java}] \textit{}
+\label{JAVA:GET-CURRENT-CLASSLOADER}
+\index{GET-CURRENT-CLASSLOADER}
+--- Function: \textbf{get-current-classloader} [\textbf{java}] \textit{}
\begin{adjustwidth}{5em}{5em}
not-documented
\end{adjustwidth}
\paragraph{}
-\label{JAVA:JCLASS-METHODS}
-\index{JCLASS-METHODS}
---- Function: \textbf{jclass-methods} [\textbf{java}] \textit{class \&key declared public}
+\label{JAVA:JNEW-ARRAY-FROM-LIST}
+\index{JNEW-ARRAY-FROM-LIST}
+--- Function: \textbf{jnew-array-from-list} [\textbf{java}] \textit{element-type list}
\begin{adjustwidth}{5em}{5em}
-Return a vector of all (or just the declared/public, if DECLARED/PUBLIC is true) methods of CLASS
+Returns a new Java array with base type ELEMENT-TYPE (a string or a class-ref)
+ initialized from a Lisp list.
\end{adjustwidth}
\paragraph{}
-\label{JAVA:GET-CURRENT-CLASSLOADER}
-\index{GET-CURRENT-CLASSLOADER}
---- Function: \textbf{get-current-classloader} [\textbf{java}] \textit{}
+\label{JAVA:JMETHOD}
+\index{JMETHOD}
+--- Function: \textbf{jmethod} [\textbf{java}] \textit{class-ref method-name \&rest parameter-class-refs}
\begin{adjustwidth}{5em}{5em}
-not-documented
+Returns a reference to the Java method METHOD-NAME of CLASS-REF with the given PARAMETER-CLASS-REFS.
\end{adjustwidth}
\paragraph{}
-\label{JAVA:REGISTER-JAVA-EXCEPTION}
-\index{REGISTER-JAVA-EXCEPTION}
---- Function: \textbf{register-java-exception} [\textbf{java}] \textit{exception-name condition-symbol}
+\label{JAVA:GET-DEFAULT-CLASSLOADER}
+\index{GET-DEFAULT-CLASSLOADER}
+--- Function: \textbf{get-default-classloader} [\textbf{java}] \textit{}
\begin{adjustwidth}{5em}{5em}
-Registers the Java Throwable named by the symbol EXCEPTION-NAME as the condition designated by CONDITION-SYMBOL. Returns T if successful, NIL if not.
+not-documented
\end{adjustwidth}
\paragraph{}
-\label{JAVA:JCLASS}
-\index{JCLASS}
---- Function: \textbf{jclass} [\textbf{java}] \textit{name-or-class-ref \&optional class-loader}
+\label{JAVA:JCLASS-METHODS}
+\index{JCLASS-METHODS}
+--- Function: \textbf{jclass-methods} [\textbf{java}] \textit{class \&key declared public}
\begin{adjustwidth}{5em}{5em}
-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.
+Return a vector of all (or just the declared/public, if DECLARED/PUBLIC is true) methods of CLASS
\end{adjustwidth}
\paragraph{}
-\label{JAVA:JNEW-ARRAY-FROM-LIST}
-\index{JNEW-ARRAY-FROM-LIST}
---- Function: \textbf{jnew-array-from-list} [\textbf{java}] \textit{element-type list}
+\label{JAVA:REGISTER-JAVA-EXCEPTION}
+\index{REGISTER-JAVA-EXCEPTION}
+--- Function: \textbf{register-java-exception} [\textbf{java}] \textit{exception-name condition-symbol}
\begin{adjustwidth}{5em}{5em}
-not-documented
+Registers the Java Throwable named by the symbol EXCEPTION-NAME as the condition designated by CONDITION-SYMBOL. Returns T if successful, NIL if not.
\end{adjustwidth}
\paragraph{}
-\label{JAVA:JMETHOD}
-\index{JMETHOD}
---- Function: \textbf{jmethod} [\textbf{java}] \textit{class-ref method-name \&rest parameter-class-refs}
+\label{JAVA:JCLASS}
+\index{JCLASS}
+--- Function: \textbf{jclass} [\textbf{java}] \textit{name-or-class-ref \&optional class-loader}
\begin{adjustwidth}{5em}{5em}
-Returns a reference to the Java method METHOD-NAME of CLASS-REF with the given PARAMETER-CLASS-REFS.
+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.
\end{adjustwidth}
\paragraph{}
\label{JAVA:JPROPERTY-VALUE}
\index{JPROPERTY-VALUE}
---- Function: \textbf{jproperty-value} [\textbf{java}] \textit{obj prop}
+--- Function: \textbf{jproperty-value} [\textbf{java}] \textit{object property}
\begin{adjustwidth}{5em}{5em}
-not-documented
+setf-able access on the Java Beans notion of property named PROPETRY on OBJECT.
\end{adjustwidth}
\paragraph{}
@@ -219,6 +218,15 @@
\end{adjustwidth}
\paragraph{}
+\label{JAVA:JCLASS-CONSTRUCTORS}
+\index{JCLASS-CONSTRUCTORS}
+--- Function: \textbf{jclass-constructors} [\textbf{java}] \textit{class}
+
+\begin{adjustwidth}{5em}{5em}
+Returns a vector of constructors for CLASS
+\end{adjustwidth}
+
+\paragraph{}
\label{JAVA:JNEW-RUNTIME-CLASS}
\index{JNEW-RUNTIME-CLASS}
--- Function: \textbf{jnew-runtime-class} [\textbf{java}] \textit{class-name \&rest args \&key (superclass java.lang.Object) interfaces constructors methods fields (access-flags (quote (public))) annotations}
@@ -251,15 +259,6 @@
\end{adjustwidth}
\paragraph{}
-\label{JAVA:JCLASS-CONSTRUCTORS}
-\index{JCLASS-CONSTRUCTORS}
---- Function: \textbf{jclass-constructors} [\textbf{java}] \textit{class}
-
-\begin{adjustwidth}{5em}{5em}
-Returns a vector of constructors for CLASS
-\end{adjustwidth}
-
-\paragraph{}
\label{JAVA:JSTATIC}
\index{JSTATIC}
--- Function: \textbf{jstatic} [\textbf{java}] \textit{method class \&rest args}
@@ -278,15 +277,6 @@
\end{adjustwidth}
\paragraph{}
-\label{JAVA:JNEW}
-\index{JNEW}
---- Function: \textbf{jnew} [\textbf{java}] \textit{constructor \&rest args}
-
-\begin{adjustwidth}{5em}{5em}
-Invokes the Java constructor CONSTRUCTOR with the arguments ARGS.
-\end{adjustwidth}
-
-\paragraph{}
\label{JAVA:JREGISTER-HANDLER}
\index{JREGISTER-HANDLER}
--- Function: \textbf{jregister-handler} [\textbf{java}] \textit{object event handler \&key data count}
@@ -314,6 +304,33 @@
\end{adjustwidth}
\paragraph{}
+\label{JAVA:JINPUT-STREAM}
+\index{JINPUT-STREAM}
+--- Function: \textbf{jinput-stream} [\textbf{java}] \textit{pathname}
+
+\begin{adjustwidth}{5em}{5em}
+Returns a java.io.InputStream for resource denoted by PATHNAME.
+\end{adjustwidth}
+
+\paragraph{}
+\label{JAVA:UNREGISTER-JAVA-EXCEPTION}
+\index{UNREGISTER-JAVA-EXCEPTION}
+--- Function: \textbf{unregister-java-exception} [\textbf{java}] \textit{exception-name}
+
+\begin{adjustwidth}{5em}{5em}
+Unregisters the Java Throwable EXCEPTION-NAME previously registered by REGISTER-JAVA-EXCEPTION.
+\end{adjustwidth}
+
+\paragraph{}
+\label{JAVA:JNEW}
+\index{JNEW}
+--- Function: \textbf{jnew} [\textbf{java}] \textit{constructor \&rest args}
+
+\begin{adjustwidth}{5em}{5em}
+Invokes the Java constructor CONSTRUCTOR with the arguments ARGS.
+\end{adjustwidth}
+
+\paragraph{}
\label{JAVA:JARRAY-COMPONENT-TYPE}
\index{JARRAY-COMPONENT-TYPE}
--- Function: \textbf{jarray-component-type} [\textbf{java}] \textit{atype}
@@ -328,16 +345,10 @@
--- Generic Function: \textbf{add-to-classpath} [\textbf{java}] \textit{}
\begin{adjustwidth}{5em}{5em}
-not-documented
-\end{adjustwidth}
-
-\paragraph{}
-\label{JAVA:UNREGISTER-JAVA-EXCEPTION}
-\index{UNREGISTER-JAVA-EXCEPTION}
---- Function: \textbf{unregister-java-exception} [\textbf{java}] \textit{exception-name}
+Add JAR-OR-JARS to the JVM classpath optionally specifying the CLASSLOADER to add.
-\begin{adjustwidth}{5em}{5em}
-Unregisters the Java Throwable EXCEPTION-NAME previously registered by REGISTER-JAVA-EXCEPTION.
+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.
\end{adjustwidth}
\paragraph{}
@@ -372,15 +383,6 @@
\end{adjustwidth}
\paragraph{}
-\label{JAVA:JMEMBER-PUBLIC-P}
-\index{JMEMBER-PUBLIC-P}
---- Function: \textbf{jmember-public-p} [\textbf{java}] \textit{member}
-
-\begin{adjustwidth}{5em}{5em}
-MEMBER is a public member of its declaring class
-\end{adjustwidth}
-
-\paragraph{}
\label{JAVA:+NULL+}
\index{+NULL+}
--- Variable: \textbf{+null+} [\textbf{java}] \textit{}
@@ -395,22 +397,22 @@
--- Function: \textbf{ensure-java-class} [\textbf{java}] \textit{jclass}
\begin{adjustwidth}{5em}{5em}
-not-documented
+Attempt to ensure that the Java class referenced by JCLASS exists in the current process of the implementation.
\end{adjustwidth}
\paragraph{}
-\label{JAVA:JAVA-CLASS}
-\index{JAVA-CLASS}
---- Class: \textbf{java-class} [\textbf{java}] \textit{}
+\label{JAVA:JMEMBER-PUBLIC-P}
+\index{JMEMBER-PUBLIC-P}
+--- Function: \textbf{jmember-public-p} [\textbf{java}] \textit{member}
\begin{adjustwidth}{5em}{5em}
-not-documented
+MEMBER is a public member of its declaring class
\end{adjustwidth}
\paragraph{}
-\label{JAVA:JMETHOD-LET}
-\index{JMETHOD-LET}
---- Macro: \textbf{jmethod-let} [\textbf{java}] \textit{}
+\label{JAVA:JAVA-CLASS}
+\index{JAVA-CLASS}
+--- Class: \textbf{java-class} [\textbf{java}] \textit{}
\begin{adjustwidth}{5em}{5em}
not-documented
@@ -426,6 +428,15 @@
\end{adjustwidth}
\paragraph{}
+\label{JAVA:JMETHOD-LET}
+\index{JMETHOD-LET}
+--- Macro: \textbf{jmethod-let} [\textbf{java}] \textit{}
+
+\begin{adjustwidth}{5em}{5em}
+not-documented
+\end{adjustwidth}
+
+\paragraph{}
\label{JAVA:JCALL}
\index{JCALL}
--- Function: \textbf{jcall} [\textbf{java}] \textit{method-ref instance \&rest args}
@@ -537,6 +548,15 @@
\end{adjustwidth}
\paragraph{}
+\label{JAVA:JMAKE-INVOCATION-HANDLER}
+\index{JMAKE-INVOCATION-HANDLER}
+--- Function: \textbf{jmake-invocation-handler} [\textbf{java}] \textit{function}
+
+\begin{adjustwidth}{5em}{5em}
+not-documented
+\end{adjustwidth}
+
+\paragraph{}
\label{JAVA:+TRUE+}
\index{+TRUE+}
--- Variable: \textbf{+true+} [\textbf{java}] \textit{}
@@ -546,12 +566,12 @@
\end{adjustwidth}
\paragraph{}
-\label{JAVA:JMAKE-INVOCATION-HANDLER}
-\index{JMAKE-INVOCATION-HANDLER}
---- Function: \textbf{jmake-invocation-handler} [\textbf{java}] \textit{function}
+\label{JAVA:JMEMBER-PROTECTED-P}
+\index{JMEMBER-PROTECTED-P}
+--- Function: \textbf{jmember-protected-p} [\textbf{java}] \textit{member}
\begin{adjustwidth}{5em}{5em}
-not-documented
+MEMBER is a protected member of its declaring class
\end{adjustwidth}
\paragraph{}
@@ -573,15 +593,6 @@
\end{adjustwidth}
\paragraph{}
-\label{JAVA:JMEMBER-PROTECTED-P}
-\index{JMEMBER-PROTECTED-P}
---- Function: \textbf{jmember-protected-p} [\textbf{java}] \textit{member}
-
-\begin{adjustwidth}{5em}{5em}
-MEMBER is a protected member of its declaring class
-\end{adjustwidth}
-
-\paragraph{}
\label{JAVA:MAKE-IMMEDIATE-OBJECT}
\index{MAKE-IMMEDIATE-OBJECT}
--- Function: \textbf{make-immediate-object} [\textbf{java}] \textit{object \&optional type}
@@ -599,13 +610,22 @@
\end{adjustwidth}
\paragraph{}
+\label{JAVA:JCLASS-FIELDS}
+\index{JCLASS-FIELDS}
+--- Function: \textbf{jclass-fields} [\textbf{java}] \textit{class \&key declared public}
+
+\begin{adjustwidth}{5em}{5em}
+Returns a vector of all (or just the declared/public, if DECLARED/PUBLIC is true) fields of CLASS
+\end{adjustwidth}
+
+\paragraph{}
\label{JAVA:JNEW-ARRAY-FROM-ARRAY}
\index{JNEW-ARRAY-FROM-ARRAY}
--- Function: \textbf{jnew-array-from-array} [\textbf{java}] \textit{element-type array}
\begin{adjustwidth}{5em}{5em}
Returns a new Java array with base type ELEMENT-TYPE (a string or a class-ref)
- initialized from ARRAY
+ initialized from ARRAY.
\end{adjustwidth}
\paragraph{}
@@ -618,15 +638,6 @@
\end{adjustwidth}
\paragraph{}
-\label{JAVA:JCLASS-FIELDS}
-\index{JCLASS-FIELDS}
---- Function: \textbf{jclass-fields} [\textbf{java}] \textit{class \&key declared public}
-
-\begin{adjustwidth}{5em}{5em}
-Returns a vector of all (or just the declared/public, if DECLARED/PUBLIC is true) fields of CLASS
-\end{adjustwidth}
-
-\paragraph{}
\label{JAVA:JAVA-EXCEPTION}
\index{JAVA-EXCEPTION}
--- Class: \textbf{java-exception} [\textbf{java}] \textit{}
@@ -683,21 +694,21 @@
\end{adjustwidth}
\paragraph{}
-\label{JAVA:JCONSTRUCTOR-PARAMS}
-\index{JCONSTRUCTOR-PARAMS}
---- Function: \textbf{jconstructor-params} [\textbf{java}] \textit{constructor}
+\label{JAVA:JMEMBER-STATIC-P}
+\index{JMEMBER-STATIC-P}
+--- Function: \textbf{jmember-static-p} [\textbf{java}] \textit{member}
\begin{adjustwidth}{5em}{5em}
-Returns a vector of parameter types (Java classes) for CONSTRUCTOR
+MEMBER is a static member of its declaring class
\end{adjustwidth}
\paragraph{}
-\label{JAVA:JMEMBER-STATIC-P}
-\index{JMEMBER-STATIC-P}
---- Function: \textbf{jmember-static-p} [\textbf{java}] \textit{member}
+\label{JAVA:JCONSTRUCTOR-PARAMS}
+\index{JCONSTRUCTOR-PARAMS}
+--- Function: \textbf{jconstructor-params} [\textbf{java}] \textit{constructor}
\begin{adjustwidth}{5em}{5em}
-MEMBER is a static member of its declaring class
+Returns a vector of parameter types (Java classes) for CONSTRUCTOR
\end{adjustwidth}
\paragraph{}
@@ -733,7 +744,7 @@
--- Function: \textbf{jarray-length} [\textbf{java}] \textit{java-array}
\begin{adjustwidth}{5em}{5em}
-not-documented
+Returns the length of a Java primitive array.
\end{adjustwidth}
\paragraph{}
@@ -746,21 +757,21 @@
\end{adjustwidth}
\paragraph{}
-\label{JAVA:JCLASS-FIELD}
-\index{JCLASS-FIELD}
---- Function: \textbf{jclass-field} [\textbf{java}] \textit{class field-name}
+\label{JAVA:JMAKE-PROXY}
+\index{JMAKE-PROXY}
+--- Generic Function: \textbf{jmake-proxy} [\textbf{java}] \textit{}
\begin{adjustwidth}{5em}{5em}
-Returns the field named FIELD-NAME of CLASS
+Returns a proxy Java object implementing the provided interface(s) using 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 argument. 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 implemented. 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.
\end{adjustwidth}
\paragraph{}
-\label{JAVA:JMAKE-PROXY}
-\index{JMAKE-PROXY}
---- Generic Function: \textbf{jmake-proxy} [\textbf{java}] \textit{}
+\label{JAVA:JCLASS-FIELD}
+\index{JCLASS-FIELD}
+--- Function: \textbf{jclass-field} [\textbf{java}] \textit{class field-name}
\begin{adjustwidth}{5em}{5em}
-not-documented
+Returns the field named FIELD-NAME of CLASS
\end{adjustwidth}
\paragraph{}
Modified: branches/1.1.x/doc/manual/threads.tex
==============================================================================
--- branches/1.1.x/doc/manual/threads.tex Sat Dec 1 11:50:07 2012 (r14265)
+++ branches/1.1.x/doc/manual/threads.tex Sat Dec 1 12:57:24 2012 (r14266)
@@ -4,7 +4,7 @@
--- Function: \textbf{mailbox-empty-p} [\textbf{threads}] \textit{mailbox}
\begin{adjustwidth}{5em}{5em}
-Returns non-NIL if the mailbox can be read from, NIL otherwise.
+not-documented
\end{adjustwidth}
\paragraph{}
@@ -53,18 +53,18 @@
\end{adjustwidth}
\paragraph{}
-\label{THREADS:OBJECT-WAIT}
-\index{OBJECT-WAIT}
---- Function: \textbf{object-wait} [\textbf{threads}] \textit{}
+\label{THREADS:MAKE-THREAD}
+\index{MAKE-THREAD}
+--- Function: \textbf{make-thread} [\textbf{threads}] \textit{function \&key name}
\begin{adjustwidth}{5em}{5em}
not-documented
\end{adjustwidth}
\paragraph{}
-\label{THREADS:MAKE-THREAD}
-\index{MAKE-THREAD}
---- Function: \textbf{make-thread} [\textbf{threads}] \textit{function \&key name}
+\label{THREADS:OBJECT-WAIT}
+\index{OBJECT-WAIT}
+--- Function: \textbf{object-wait} [\textbf{threads}] \textit{}
\begin{adjustwidth}{5em}{5em}
not-documented
@@ -91,7 +91,7 @@
\paragraph{}
\label{THREADS:MAKE-MAILBOX}
\index{MAKE-MAILBOX}
---- Function: \textbf{make-mailbox} [\textbf{threads}] \textit{\&key ((queue g2304220) NIL)}
+--- Function: \textbf{make-mailbox} [\textbf{threads}] \textit{\&key ((queue g348097) NIL)}
\begin{adjustwidth}{5em}{5em}
not-documented
@@ -122,8 +122,7 @@
\begin{adjustwidth}{5em}{5em}
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
-if the first is NIL.
+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
@@ -169,18 +168,18 @@
\end{adjustwidth}
\paragraph{}
-\label{THREADS:MAKE-MUTEX}
-\index{MAKE-MUTEX}
---- Function: \textbf{make-mutex} [\textbf{threads}] \textit{\&key ((in-use g2304421) NIL)}
+\label{THREADS:THREAD}
+\index{THREAD}
+--- Class: \textbf{thread} [\textbf{threads}] \textit{}
\begin{adjustwidth}{5em}{5em}
not-documented
\end{adjustwidth}
\paragraph{}
-\label{THREADS:THREAD}
-\index{THREAD}
---- Class: \textbf{thread} [\textbf{threads}] \textit{}
+\label{THREADS:MAKE-MUTEX}
+\index{MAKE-MUTEX}
+--- Function: \textbf{make-mutex} [\textbf{threads}] \textit{\&key ((in-use g348357) NIL)}
\begin{adjustwidth}{5em}{5em}
not-documented
More information about the armedbear-cvs
mailing list