Changeset 13690


Ignore:
Timestamp:
11/02/11 13:12:24 (9 years ago)
Author:
Mark Evenson
Message:

Changes corresponding to abcl-20111102a.pdf.

Now generating LaTeX from docstring via grovel.lisp.

Added index.

Location:
trunk/abcl/doc/manual
Files:
5 edited

Legend:

Unmodified
Added
Removed
  • trunk/abcl/doc/manual/abcl.sty

    r13455 r13690  
    3535\usepackage{verbatim}
    3636
     37%% For setting margins in docstrings
     38\usepackage{changepage}
     39
     40\usepackage{makeidx}
     41
     42\makeindex
     43
    3744\ProvidesPackage{abcl}
     45
  • trunk/abcl/doc/manual/abcl.tex

    r13685 r13690  
    761761\end{listing-lisp}
    762762
    763 N.b \code{add-to-classpath} only affects the classloader used by ABCL
     763N.b \code{ADD-TO-CLASSPATH} only affects the classloader used by ABCL
    764764(the value of the special variable \code{JAVA:*CLASSLOADER*}. It has
    765765no effect on Java code outside ABCL.
    766 
    767 \subsection{API}
    768766
    769767% include autogen docs for the JAVA package.
     
    776774excellent \code{java.util.concurrent} packages may be manipulated
    777775directly via the JSS contrib to great effect.
    778 
    779 \subsection{API}
    780776
    781777% include autogen docs for the THREADS package.
     
    790786reference weakly held by the garbage collector and others.
    791787
    792 See \ref{Extensible Sequences} for a generic function interface to
    793 the native JVM contract for \code{java.util.List}.
    794 
    795 \subsection{API}
     788See \ref{Rhodes2007} for a generic function interface to the native
     789JVM contract for \code{java.util.List}.
    796790
    797791% include autogen docs for the EXTENSIONS package.
     
    11061100
    11071101\bibitem{Xach2011}
    1108   Zach Beenep
     1102  Zach Beene
    11091103  ``Quicklisp:  A system for quickly constructing Common Lisp''
    11101104  \url{http://www.quicklisp.org/}
     
    11191113\end{thebibliography}
    11201114
     1115\printindex
     1116
    11211117\end{document}
    11221118
  • trunk/abcl/doc/manual/extensions.tex

    r13613 r13690  
    1 \begin{verbatim}
    2 %CADDR
    3   Macro: (not documented)
    4 %CADR
    5   Macro: (not documented)
    6 %CAR
    7   Macro: (not documented)
    8 %CDR
    9   Macro: (not documented)
    10 *AUTOLOAD-VERBOSE*
    11   Variable: (not documented)
    12 *BATCH-MODE*
    13   Variable: (not documented)
    14 *COMMAND-LINE-ARGUMENT-LIST*
    15   Variable: (not documented)
    16 *DEBUG-CONDITION*
    17   Variable: (not documented)
    18 *DEBUG-LEVEL*
    19   Variable: (not documented)
    20 *DISASSEMBLER*
    21   Variable: (not documented)
    22 *ED-FUNCTIONS*
    23   Variable: (not documented)
    24 *ENABLE-INLINE-EXPANSION*
    25   Variable: (not documented)
    26 *INSPECTOR-HOOK*
    27   Variable: (not documented)
    28 *LISP-HOME*
    29   Variable: (not documented)
    30 *LOAD-TRUENAME-FASL*
    31   Variable: (not documented)
    32 *PRINT-STRUCTURE*
    33   Variable: (not documented)
    34 *REQUIRE-STACK-FRAME*
    35   Variable: (not documented)
    36 *SAVED-BACKTRACE*
    37   Variable: (not documented)
    38 *SUPPRESS-COMPILER-WARNINGS*
    39   Variable: (not documented)
    40 *WARN-ON-REDEFINITION*
    41   Variable: (not documented)
    42 ADJOIN-EQL
    43   Function: (not documented)
    44 ARGLIST
    45   Function: (not documented)
    46 ASSQ
    47   Function: (not documented)
    48 ASSQL
    49   Function: (not documented)
    50 AUTOLOAD
    51   Function: (not documented)
    52 AUTOLOAD-MACRO
    53   Function: (not documented)
    54 AUTOLOADP
    55   Function: (not documented)
    56 AVER
    57   Macro: (not documented)
    58 CANCEL-FINALIZATION
    59   Function: (not documented)
    60 CHAR-TO-UTF8
    61   Function: (not documented)
    62 CHARPOS
    63   Function: (not documented)
    64 CLASSP
    65   Function: (not documented)
    66 COLLECT
    67   Macro: (not documented)
    68 COMPILE-FILE-IF-NEEDED
    69   Function: (not documented)
    70 COMPILE-SYSTEM
    71   Function: (not documented)
    72 COMPILER-ERROR
    73   Function: (not documented)
    74   Class: (not documented)
    75 COMPILER-UNSUPPORTED-FEATURE-ERROR
    76   Class: (not documented)
    77 DESCRIBE-COMPILER-POLICY
    78   Function: (not documented)
    79 DOUBLE-FLOAT-NEGATIVE-INFINITY
    80   Variable: (not documented)
    81 DOUBLE-FLOAT-POSITIVE-INFINITY
    82   Variable: (not documented)
    83 DUMP-JAVA-STACK
    84   Function: (not documented)
    85 EXIT
    86   Function: (not documented)
    87 FEATUREP
    88   Function: (not documented)
    89 FILE-DIRECTORY-P
    90   Function: (not documented)
    91 FINALIZE
    92   Function: (not documented)
    93 FIXNUMP
    94   Function: (not documented)
    95 GC
    96   Function: (not documented)
    97 GET-FLOATING-POINT-MODES
    98   Function: (not documented)
    99 GET-SOCKET-STREAM
    100   Function: :ELEMENT-TYPE must be CHARACTER or (UNSIGNED-BYTE 8); the default is CHARACTER.
    101 GETENV
    102   Function: Return the value of the environment VARIABLE if it exists, otherwise return NIL.
    103 GROVEL-JAVA-DEFINITIONS
    104   Function: (not documented)
    105 INIT-GUI
    106   Function: (not documented)
    107 INTERNAL-COMPILER-ERROR
    108   Function: (not documented)
    109   Class: (not documented)
    110 INTERRUPT-LISP
    111   Function: (not documented)
    112 JAR-PATHNAME
    113   Class: (not documented)
    114 MACROEXPAND-ALL
    115   Function: (not documented)
    116 MAILBOX
    117   Class: (not documented)
    118 MAKE-DIALOG-PROMPT-STREAM
    119   Function: (not documented)
    120 MAKE-SERVER-SOCKET
    121   Function: (not documented)
    122 MAKE-SLIME-INPUT-STREAM
    123   Function: (not documented)
    124 MAKE-SLIME-OUTPUT-STREAM
    125   Function: (not documented)
    126 MAKE-SOCKET
    127   Function: (not documented)
    128 MAKE-TEMP-FILE
    129   Function: (not documented)
    130 MAKE-WEAK-REFERENCE
    131   Function: (not documented)
    132 MEMQ
    133   Function: (not documented)
    134 MEMQL
    135   Function: (not documented)
    136 MOST-NEGATIVE-JAVA-LONG
    137   Variable: (not documented)
    138 MOST-POSITIVE-JAVA-LONG
    139   Variable: (not documented)
    140 MUTEX
    141   Class: (not documented)
    142 NEQ
    143   Function: (not documented)
    144 NIL-VECTOR
    145   Class: (not documented)
    146 PATHNAME-JAR-P
    147   Function: (not documented)
    148 PATHNAME-URL-P
    149   Function: Predicate for whether PATHNAME references a URL.
    150 PRECOMPILE
    151   Function: (not documented)
    152 PROBE-DIRECTORY
    153   Function: (not documented)
    154 PROCESS
    155   Function: (not documented)
    156 PROCESS-ALIVE-P
    157   Function: (not documented)
    158 PROCESS-ERROR
    159   Function: (not documented)
    160 PROCESS-EXIT-CODE
    161   Function: (not documented)
    162 PROCESS-INPUT
    163   Function: (not documented)
    164 PROCESS-KILL
    165   Function: (not documented)
    166 PROCESS-OUTPUT
    167   Function: (not documented)
    168 PROCESS-P
    169   Function: (not documented)
    170 PROCESS-WAIT
    171   Function: (not documented)
    172 QUIT
    173   Function: (not documented)
    174 RESOLVE
    175   Function: (not documented)
    176 RUN-PROGRAM
    177   Function: (not documented)
    178 RUN-SHELL-COMMAND
    179   Function: (not documented)
    180 SERVER-SOCKET-CLOSE
    181   Function: (not documented)
    182 SET-FLOATING-POINT-MODES
    183   Function: (not documented)
    184 SHOW-RESTARTS
    185   Function: (not documented)
    186 SIMPLE-SEARCH
    187   Function: (not documented)
    188 SIMPLE-STRING-FILL
    189   Function: (not documented)
    190 SIMPLE-STRING-SEARCH
    191   Function: (not documented)
    192 SINGLE-FLOAT-NEGATIVE-INFINITY
    193   Variable: (not documented)
    194 SINGLE-FLOAT-POSITIVE-INFINITY
    195   Variable: (not documented)
    196 SLIME-INPUT-STREAM
    197   Class: (not documented)
    198 SLIME-OUTPUT-STREAM
    199   Class: (not documented)
    200 SOCKET-ACCEPT
    201   Function: (not documented)
    202 SOCKET-CLOSE
    203   Function: (not documented)
    204 SOCKET-LOCAL-ADDRESS
    205   Function: Returns the local address of the given socket as a dotted quad string.
    206 SOCKET-LOCAL-PORT
    207   Function: Returns the local port number of the given socket.
    208 SOCKET-PEER-ADDRESS
    209   Function: Returns the peer address of the given socket as a dotted quad string.
    210 SOCKET-PEER-PORT
    211   Function: Returns the peer port number of the given socket.
    212 SOURCE
    213   Function: (not documented)
    214 SOURCE-FILE-POSITION
    215   Function: (not documented)
    216 SOURCE-PATHNAME
    217   Function: (not documented)
    218 SPECIAL-VARIABLE-P
    219   Function: (not documented)
    220 STRING-FIND
    221   Function: (not documented)
    222 STRING-INPUT-STREAM-CURRENT
    223   Function: (not documented)
    224 STRING-POSITION
    225   Function: (not documented)
    226 STYLE-WARN
    227   Function: (not documented)
    228 TRULY-THE
    229   Special Operator: (not documented)
    230 UPTIME
    231   Function: (not documented)
    232 URI-DECODE
    233   Function: (not documented)
    234 URI-ENCODE
    235   Function: (not documented)
    236 URL-PATHNAME
    237   Class: (not documented)
    238 URL-PATHNAME-AUTHORITY
    239   Function: (not documented)
    240 URL-PATHNAME-FRAGMENT
    241   Function: (not documented)
    242 URL-PATHNAME-QUERY
    243   Function: (not documented)
    244 URL-PATHNAME-SCHEME
    245   Function: (not documented)
    246 WEAK-REFERENCE
    247   Class: (not documented)
    248 WEAK-REFERENCE-VALUE
    249   Function: (not documented)
    250 \end{verbatim}
     1\subsection{Exported Symbols from the EXTENSIONS package}
     2
     3\paragraph{}
     4\label{EXTENSIONS:COMPILE-FILE-IF-NEEDED}
     5\index{COMPILE-FILE-IF-NEEDED}
     6--- Function: \textbf{compile-file-if-needed} [\textbf{extensions}] \textit{input-file \&rest allargs \&key force-compile \&allow-other-keys}
     7
     8\begin{adjustwidth}{5em}{5em}
     9NOT-DOCUMENTED
     10\end{adjustwidth}
     11
     12\paragraph{}
     13\label{EXTENSIONS:MOST-POSITIVE-JAVA-LONG}
     14\index{MOST-POSITIVE-JAVA-LONG}
     15--- Variable: \textbf{most-positive-java-long} [\textbf{extensions}] \textit{}
     16
     17\begin{adjustwidth}{5em}{5em}
     18NOT-DOCUMENTED
     19\end{adjustwidth}
     20
     21\paragraph{}
     22\label{EXTENSIONS:DUMP-JAVA-STACK}
     23\index{DUMP-JAVA-STACK}
     24--- Function: \textbf{dump-java-stack} [\textbf{extensions}] \textit{}
     25
     26\begin{adjustwidth}{5em}{5em}
     27NOT-DOCUMENTED
     28\end{adjustwidth}
     29
     30\paragraph{}
     31\label{EXTENSIONS:MEMQL}
     32\index{MEMQL}
     33--- Function: \textbf{memql} [\textbf{extensions}] \textit{item list}
     34
     35\begin{adjustwidth}{5em}{5em}
     36NOT-DOCUMENTED
     37\end{adjustwidth}
     38
     39\paragraph{}
     40\label{EXTENSIONS:DOUBLE-FLOAT-NEGATIVE-INFINITY}
     41\index{DOUBLE-FLOAT-NEGATIVE-INFINITY}
     42--- Variable: \textbf{double-float-negative-infinity} [\textbf{extensions}] \textit{}
     43
     44\begin{adjustwidth}{5em}{5em}
     45NOT-DOCUMENTED
     46\end{adjustwidth}
     47
     48\paragraph{}
     49\label{EXTENSIONS:GROVEL-JAVA-DEFINITIONS}
     50\index{GROVEL-JAVA-DEFINITIONS}
     51--- Function: \textbf{grovel-java-definitions} [\textbf{extensions}] \textit{}
     52
     53\begin{adjustwidth}{5em}{5em}
     54NOT-DOCUMENTED
     55\end{adjustwidth}
     56
     57\paragraph{}
     58\label{EXTENSIONS:*AUTOLOAD-VERBOSE*}
     59\index{*AUTOLOAD-VERBOSE*}
     60--- Variable: \textbf{*autoload-verbose*} [\textbf{extensions}] \textit{}
     61
     62\begin{adjustwidth}{5em}{5em}
     63NOT-DOCUMENTED
     64\end{adjustwidth}
     65
     66\paragraph{}
     67\label{EXTENSIONS:MAKE-SLIME-INPUT-STREAM}
     68\index{MAKE-SLIME-INPUT-STREAM}
     69--- Function: \textbf{make-slime-input-stream} [\textbf{extensions}] \textit{function output-stream}
     70
     71\begin{adjustwidth}{5em}{5em}
     72NOT-DOCUMENTED
     73\end{adjustwidth}
     74
     75\paragraph{}
     76\label{EXTENSIONS:URL-PATHNAME-FRAGMENT}
     77\index{URL-PATHNAME-FRAGMENT}
     78--- Function: \textbf{url-pathname-fragment} [\textbf{extensions}] \textit{p}
     79
     80\begin{adjustwidth}{5em}{5em}
     81NOT-DOCUMENTED
     82\end{adjustwidth}
     83
     84\paragraph{}
     85\label{EXTENSIONS:PROCESS-KILL}
     86\index{PROCESS-KILL}
     87--- Function: \textbf{process-kill} [\textbf{extensions}] \textit{process}
     88
     89\begin{adjustwidth}{5em}{5em}
     90Kills the process.
     91\end{adjustwidth}
     92
     93\paragraph{}
     94\label{EXTENSIONS:NIL-VECTOR}
     95\index{NIL-VECTOR}
     96--- Class: \textbf{nil-vector} [\textbf{extensions}] \textit{}
     97
     98\begin{adjustwidth}{5em}{5em}
     99NOT-DOCUMENTED
     100\end{adjustwidth}
     101
     102\paragraph{}
     103\label{EXTENSIONS:SOURCE-PATHNAME}
     104\index{SOURCE-PATHNAME}
     105--- Function: \textbf{source-pathname} [\textbf{extensions}] \textit{}
     106
     107\begin{adjustwidth}{5em}{5em}
     108NOT-DOCUMENTED
     109\end{adjustwidth}
     110
     111\paragraph{}
     112\label{EXTENSIONS:URI-DECODE}
     113\index{URI-DECODE}
     114--- Function: \textbf{uri-decode} [\textbf{extensions}] \textit{}
     115
     116\begin{adjustwidth}{5em}{5em}
     117NOT-DOCUMENTED
     118\end{adjustwidth}
     119
     120\paragraph{}
     121\label{EXTENSIONS:SIMPLE-STRING-FILL}
     122\index{SIMPLE-STRING-FILL}
     123--- Function: \textbf{simple-string-fill} [\textbf{extensions}] \textit{}
     124
     125\begin{adjustwidth}{5em}{5em}
     126NOT-DOCUMENTED
     127\end{adjustwidth}
     128
     129\paragraph{}
     130\label{EXTENSIONS:MEMQ}
     131\index{MEMQ}
     132--- Function: \textbf{memq} [\textbf{extensions}] \textit{item list}
     133
     134\begin{adjustwidth}{5em}{5em}
     135NOT-DOCUMENTED
     136\end{adjustwidth}
     137
     138\paragraph{}
     139\label{EXTENSIONS:URL-PATHNAME-SCHEME}
     140\index{URL-PATHNAME-SCHEME}
     141--- Function: \textbf{url-pathname-scheme} [\textbf{extensions}] \textit{p}
     142
     143\begin{adjustwidth}{5em}{5em}
     144NOT-DOCUMENTED
     145\end{adjustwidth}
     146
     147\paragraph{}
     148\label{EXTENSIONS:TRULY-THE}
     149\index{TRULY-THE}
     150--- Special Operator: \textbf{truly-the} [\textbf{extensions}] \textit{}
     151
     152\begin{adjustwidth}{5em}{5em}
     153NOT-DOCUMENTED
     154\end{adjustwidth}
     155
     156\paragraph{}
     157\label{EXTENSIONS:SLIME-INPUT-STREAM}
     158\index{SLIME-INPUT-STREAM}
     159--- Class: \textbf{slime-input-stream} [\textbf{extensions}] \textit{}
     160
     161\begin{adjustwidth}{5em}{5em}
     162NOT-DOCUMENTED
     163\end{adjustwidth}
     164
     165\paragraph{}
     166\label{EXTENSIONS:MAKE-SOCKET}
     167\index{MAKE-SOCKET}
     168--- Function: \textbf{make-socket} [\textbf{extensions}] \textit{host port}
     169
     170\begin{adjustwidth}{5em}{5em}
     171NOT-DOCUMENTED
     172\end{adjustwidth}
     173
     174\paragraph{}
     175\label{EXTENSIONS:*ENABLE-INLINE-EXPANSION*}
     176\index{*ENABLE-INLINE-EXPANSION*}
     177--- Variable: \textbf{*enable-inline-expansion*} [\textbf{extensions}] \textit{}
     178
     179\begin{adjustwidth}{5em}{5em}
     180NOT-DOCUMENTED
     181\end{adjustwidth}
     182
     183\paragraph{}
     184\label{EXTENSIONS:PROCESS-INPUT}
     185\index{PROCESS-INPUT}
     186--- Function: \textbf{process-input} [\textbf{extensions}] \textit{}
     187
     188\begin{adjustwidth}{5em}{5em}
     189NOT-DOCUMENTED
     190\end{adjustwidth}
     191
     192\paragraph{}
     193\label{EXTENSIONS:MAILBOX}
     194\index{MAILBOX}
     195--- Class: \textbf{mailbox} [\textbf{extensions}] \textit{}
     196
     197\begin{adjustwidth}{5em}{5em}
     198NOT-DOCUMENTED
     199\end{adjustwidth}
     200
     201\paragraph{}
     202\label{EXTENSIONS:STRING-POSITION}
     203\index{STRING-POSITION}
     204--- Function: \textbf{string-position} [\textbf{extensions}] \textit{}
     205
     206\begin{adjustwidth}{5em}{5em}
     207NOT-DOCUMENTED
     208\end{adjustwidth}
     209
     210\paragraph{}
     211\label{EXTENSIONS:PRECOMPILE}
     212\index{PRECOMPILE}
     213--- Function: \textbf{precompile} [\textbf{extensions}] \textit{name \&optional definition}
     214
     215\begin{adjustwidth}{5em}{5em}
     216NOT-DOCUMENTED
     217\end{adjustwidth}
     218
     219\paragraph{}
     220\label{EXTENSIONS:*SUPPRESS-COMPILER-WARNINGS*}
     221\index{*SUPPRESS-COMPILER-WARNINGS*}
     222--- Variable: \textbf{*suppress-compiler-warnings*} [\textbf{extensions}] \textit{}
     223
     224\begin{adjustwidth}{5em}{5em}
     225NOT-DOCUMENTED
     226\end{adjustwidth}
     227
     228\paragraph{}
     229\label{EXTENSIONS:PROCESS}
     230\index{PROCESS}
     231--- Class: \textbf{process} [\textbf{extensions}] \textit{}
     232
     233\begin{adjustwidth}{5em}{5em}
     234NOT-DOCUMENTED
     235\end{adjustwidth}
     236
     237\paragraph{}
     238\label{EXTENSIONS:SIMPLE-SEARCH}
     239\index{SIMPLE-SEARCH}
     240--- Function: \textbf{simple-search} [\textbf{extensions}] \textit{sequence1 sequence2}
     241
     242\begin{adjustwidth}{5em}{5em}
     243NOT-DOCUMENTED
     244\end{adjustwidth}
     245
     246\paragraph{}
     247\label{EXTENSIONS:*LISP-HOME*}
     248\index{*LISP-HOME*}
     249--- Variable: \textbf{*lisp-home*} [\textbf{extensions}] \textit{}
     250
     251\begin{adjustwidth}{5em}{5em}
     252NOT-DOCUMENTED
     253\end{adjustwidth}
     254
     255\paragraph{}
     256\label{EXTENSIONS:*COMMAND-LINE-ARGUMENT-LIST*}
     257\index{*COMMAND-LINE-ARGUMENT-LIST*}
     258--- Variable: \textbf{*command-line-argument-list*} [\textbf{extensions}] \textit{}
     259
     260\begin{adjustwidth}{5em}{5em}
     261NOT-DOCUMENTED
     262\end{adjustwidth}
     263
     264\paragraph{}
     265\label{EXTENSIONS:FILE-DIRECTORY-P}
     266\index{FILE-DIRECTORY-P}
     267--- Function: \textbf{file-directory-p} [\textbf{extensions}] \textit{}
     268
     269\begin{adjustwidth}{5em}{5em}
     270NOT-DOCUMENTED
     271\end{adjustwidth}
     272
     273\paragraph{}
     274\label{EXTENSIONS:MAKE-DIALOG-PROMPT-STREAM}
     275\index{MAKE-DIALOG-PROMPT-STREAM}
     276--- Function: \textbf{make-dialog-prompt-stream} [\textbf{extensions}] \textit{}
     277
     278\begin{adjustwidth}{5em}{5em}
     279NOT-DOCUMENTED
     280\end{adjustwidth}
     281
     282\paragraph{}
     283\label{EXTENSIONS:CLASSP}
     284\index{CLASSP}
     285--- Function: \textbf{classp} [\textbf{extensions}] \textit{}
     286
     287\begin{adjustwidth}{5em}{5em}
     288NOT-DOCUMENTED
     289\end{adjustwidth}
     290
     291\paragraph{}
     292\label{EXTENSIONS:*DISASSEMBLER*}
     293\index{*DISASSEMBLER*}
     294--- Variable: \textbf{*disassembler*} [\textbf{extensions}] \textit{}
     295
     296\begin{adjustwidth}{5em}{5em}
     297NOT-DOCUMENTED
     298\end{adjustwidth}
     299
     300\paragraph{}
     301\label{EXTENSIONS:SET-FLOATING-POINT-MODES}
     302\index{SET-FLOATING-POINT-MODES}
     303--- Function: \textbf{set-floating-point-modes} [\textbf{extensions}] \textit{\&key traps}
     304
     305\begin{adjustwidth}{5em}{5em}
     306NOT-DOCUMENTED
     307\end{adjustwidth}
     308
     309\paragraph{}
     310\label{EXTENSIONS:*DEBUG-CONDITION*}
     311\index{*DEBUG-CONDITION*}
     312--- Variable: \textbf{*debug-condition*} [\textbf{extensions}] \textit{}
     313
     314\begin{adjustwidth}{5em}{5em}
     315NOT-DOCUMENTED
     316\end{adjustwidth}
     317
     318\paragraph{}
     319\label{EXTENSIONS:EXIT}
     320\index{EXIT}
     321--- Function: \textbf{exit} [\textbf{extensions}] \textit{\&key status}
     322
     323\begin{adjustwidth}{5em}{5em}
     324NOT-DOCUMENTED
     325\end{adjustwidth}
     326
     327\paragraph{}
     328\label{EXTENSIONS:PROCESS-ERROR}
     329\index{PROCESS-ERROR}
     330--- Function: \textbf{process-error} [\textbf{extensions}] \textit{}
     331
     332\begin{adjustwidth}{5em}{5em}
     333NOT-DOCUMENTED
     334\end{adjustwidth}
     335
     336\paragraph{}
     337\label{EXTENSIONS:SOCKET-LOCAL-PORT}
     338\index{SOCKET-LOCAL-PORT}
     339--- Function: \textbf{socket-local-port} [\textbf{extensions}] \textit{socket}
     340
     341\begin{adjustwidth}{5em}{5em}
     342Returns the local port number of the given socket.
     343\end{adjustwidth}
     344
     345\paragraph{}
     346\label{EXTENSIONS:PROCESS-ALIVE-P}
     347\index{PROCESS-ALIVE-P}
     348--- Function: \textbf{process-alive-p} [\textbf{extensions}] \textit{process}
     349
     350\begin{adjustwidth}{5em}{5em}
     351Return t if process is still alive, nil otherwise.
     352\end{adjustwidth}
     353
     354\paragraph{}
     355\label{EXTENSIONS:*INSPECTOR-HOOK*}
     356\index{*INSPECTOR-HOOK*}
     357--- Variable: \textbf{*inspector-hook*} [\textbf{extensions}] \textit{}
     358
     359\begin{adjustwidth}{5em}{5em}
     360NOT-DOCUMENTED
     361\end{adjustwidth}
     362
     363\paragraph{}
     364\label{EXTENSIONS:*REQUIRE-STACK-FRAME*}
     365\index{*REQUIRE-STACK-FRAME*}
     366--- Variable: \textbf{*require-stack-frame*} [\textbf{extensions}] \textit{}
     367
     368\begin{adjustwidth}{5em}{5em}
     369NOT-DOCUMENTED
     370\end{adjustwidth}
     371
     372\paragraph{}
     373\label{EXTENSIONS:PROBE-DIRECTORY}
     374\index{PROBE-DIRECTORY}
     375--- Function: \textbf{probe-directory} [\textbf{extensions}] \textit{}
     376
     377\begin{adjustwidth}{5em}{5em}
     378NOT-DOCUMENTED
     379\end{adjustwidth}
     380
     381\paragraph{}
     382\label{EXTENSIONS:CHAR-TO-UTF8}
     383\index{CHAR-TO-UTF8}
     384--- Function: \textbf{char-to-utf8} [\textbf{extensions}] \textit{}
     385
     386\begin{adjustwidth}{5em}{5em}
     387NOT-DOCUMENTED
     388\end{adjustwidth}
     389
     390\paragraph{}
     391\label{EXTENSIONS:AUTOLOAD}
     392\index{AUTOLOAD}
     393--- Function: \textbf{autoload} [\textbf{extensions}] \textit{}
     394
     395\begin{adjustwidth}{5em}{5em}
     396NOT-DOCUMENTED
     397\end{adjustwidth}
     398
     399\paragraph{}
     400\label{EXTENSIONS:MUTEX}
     401\index{MUTEX}
     402--- Class: \textbf{mutex} [\textbf{extensions}] \textit{}
     403
     404\begin{adjustwidth}{5em}{5em}
     405NOT-DOCUMENTED
     406\end{adjustwidth}
     407
     408\paragraph{}
     409\label{EXTENSIONS:URI-ENCODE}
     410\index{URI-ENCODE}
     411--- Function: \textbf{uri-encode} [\textbf{extensions}] \textit{}
     412
     413\begin{adjustwidth}{5em}{5em}
     414NOT-DOCUMENTED
     415\end{adjustwidth}
     416
     417\paragraph{}
     418\label{EXTENSIONS:AUTOLOAD-MACRO}
     419\index{AUTOLOAD-MACRO}
     420--- Function: \textbf{autoload-macro} [\textbf{extensions}] \textit{}
     421
     422\begin{adjustwidth}{5em}{5em}
     423NOT-DOCUMENTED
     424\end{adjustwidth}
     425
     426\paragraph{}
     427\label{EXTENSIONS:SOCKET-CLOSE}
     428\index{SOCKET-CLOSE}
     429--- Function: \textbf{socket-close} [\textbf{extensions}] \textit{socket}
     430
     431\begin{adjustwidth}{5em}{5em}
     432NOT-DOCUMENTED
     433\end{adjustwidth}
     434
     435\paragraph{}
     436\label{EXTENSIONS:UPTIME}
     437\index{UPTIME}
     438--- Function: \textbf{uptime} [\textbf{extensions}] \textit{}
     439
     440\begin{adjustwidth}{5em}{5em}
     441NOT-DOCUMENTED
     442\end{adjustwidth}
     443
     444\paragraph{}
     445\label{EXTENSIONS:*ED-FUNCTIONS*}
     446\index{*ED-FUNCTIONS*}
     447--- Variable: \textbf{*ed-functions*} [\textbf{extensions}] \textit{}
     448
     449\begin{adjustwidth}{5em}{5em}
     450NOT-DOCUMENTED
     451\end{adjustwidth}
     452
     453\paragraph{}
     454\label{EXTENSIONS:COMPILE-SYSTEM}
     455\index{COMPILE-SYSTEM}
     456--- Function: \textbf{compile-system} [\textbf{extensions}] \textit{\&key quit (zip t) output-path}
     457
     458\begin{adjustwidth}{5em}{5em}
     459NOT-DOCUMENTED
     460\end{adjustwidth}
     461
     462\paragraph{}
     463\label{EXTENSIONS:*LOAD-TRUENAME-FASL*}
     464\index{*LOAD-TRUENAME-FASL*}
     465--- Variable: \textbf{*load-truename-fasl*} [\textbf{extensions}] \textit{}
     466
     467\begin{adjustwidth}{5em}{5em}
     468NOT-DOCUMENTED
     469\end{adjustwidth}
     470
     471\paragraph{}
     472\label{EXTENSIONS:SPECIAL-VARIABLE-P}
     473\index{SPECIAL-VARIABLE-P}
     474--- Function: \textbf{special-variable-p} [\textbf{extensions}] \textit{}
     475
     476\begin{adjustwidth}{5em}{5em}
     477NOT-DOCUMENTED
     478\end{adjustwidth}
     479
     480\paragraph{}
     481\label{EXTENSIONS:SOCKET-ACCEPT}
     482\index{SOCKET-ACCEPT}
     483--- Function: \textbf{socket-accept} [\textbf{extensions}] \textit{socket}
     484
     485\begin{adjustwidth}{5em}{5em}
     486NOT-DOCUMENTED
     487\end{adjustwidth}
     488
     489\paragraph{}
     490\label{EXTENSIONS:*WARN-ON-REDEFINITION*}
     491\index{*WARN-ON-REDEFINITION*}
     492--- Variable: \textbf{*warn-on-redefinition*} [\textbf{extensions}] \textit{}
     493
     494\begin{adjustwidth}{5em}{5em}
     495NOT-DOCUMENTED
     496\end{adjustwidth}
     497
     498\paragraph{}
     499\label{EXTENSIONS:URL-PATHNAME-AUTHORITY}
     500\index{URL-PATHNAME-AUTHORITY}
     501--- Function: \textbf{url-pathname-authority} [\textbf{extensions}] \textit{p}
     502
     503\begin{adjustwidth}{5em}{5em}
     504NOT-DOCUMENTED
     505\end{adjustwidth}
     506
     507\paragraph{}
     508\label{EXTENSIONS:AUTOLOADP}
     509\index{AUTOLOADP}
     510--- Function: \textbf{autoloadp} [\textbf{extensions}] \textit{symbol}
     511
     512\begin{adjustwidth}{5em}{5em}
     513NOT-DOCUMENTED
     514\end{adjustwidth}
     515
     516\paragraph{}
     517\label{EXTENSIONS:MAKE-WEAK-REFERENCE}
     518\index{MAKE-WEAK-REFERENCE}
     519--- Function: \textbf{make-weak-reference} [\textbf{extensions}] \textit{obj}
     520
     521\begin{adjustwidth}{5em}{5em}
     522Creates a weak reference to 'obj'.
     523\end{adjustwidth}
     524
     525\paragraph{}
     526\label{EXTENSIONS:RESOLVE}
     527\index{RESOLVE}
     528--- Function: \textbf{resolve} [\textbf{extensions}] \textit{symbol}
     529
     530\begin{adjustwidth}{5em}{5em}
     531NOT-DOCUMENTED
     532\end{adjustwidth}
     533
     534\paragraph{}
     535\label{EXTENSIONS:CANCEL-FINALIZATION}
     536\index{CANCEL-FINALIZATION}
     537--- Function: \textbf{cancel-finalization} [\textbf{extensions}] \textit{object}
     538
     539\begin{adjustwidth}{5em}{5em}
     540NOT-DOCUMENTED
     541\end{adjustwidth}
     542
     543\paragraph{}
     544\label{EXTENSIONS:MAKE-SLIME-OUTPUT-STREAM}
     545\index{MAKE-SLIME-OUTPUT-STREAM}
     546--- Function: \textbf{make-slime-output-stream} [\textbf{extensions}] \textit{function}
     547
     548\begin{adjustwidth}{5em}{5em}
     549NOT-DOCUMENTED
     550\end{adjustwidth}
     551
     552\paragraph{}
     553\label{EXTENSIONS:RUN-PROGRAM}
     554\index{RUN-PROGRAM}
     555--- Function: \textbf{run-program} [\textbf{extensions}] \textit{program args \&key environment (wait t)}
     556
     557\begin{adjustwidth}{5em}{5em}
     558Creates a new process running the the PROGRAM.
     559ARGS are a list of strings to be passed to the program as arguments.
     560
     561For no arguments, use nil which means that just the name of the
     562program is passed as arg 0.
     563
     564Returns a process structure containing the JAVA-OBJECT wrapped Process
     565object, and the PROCESS-INPUT, PROCESS-OUTPUT, and PROCESS-ERROR streams.
     566
     567c.f. http://download.oracle.com/javase/6/docs/api/java/lang/Process.html
     568
     569Notes about Unix environments (as in the :environment):
     570
     571    * The ABCL implementation of run-program, like SBCL, Perl and many
     572      other programs, copies the Unix environment by default.
     573
     574    * Running Unix programs from a setuid process, or in any other
     575      situation where the Unix environment is under the control of
     576      someone else, is a mother lode of security problems. If you are
     577      contemplating doing this, read about it first. (The Perl
     578      community has a lot of good documentation about this and other
     579      security issues in script-like programs.)
     580
     581The \&key arguments have the following meanings:
     582
     583:environment
     584    An alist of STRINGs (name . value) describing the new
     585    environment. The default is to copy the environment of the current
     586    process.
     587
     588:wait
     589    If non-NIL, which is the default, wait until the created process
     590    finishes. If NIL, continue running Lisp until the program
     591    finishes.
     592\end{adjustwidth}
     593
     594\paragraph{}
     595\label{EXTENSIONS:FIXNUMP}
     596\index{FIXNUMP}
     597--- Function: \textbf{fixnump} [\textbf{extensions}] \textit{}
     598
     599\begin{adjustwidth}{5em}{5em}
     600NOT-DOCUMENTED
     601\end{adjustwidth}
     602
     603\paragraph{}
     604\label{EXTENSIONS:SINGLE-FLOAT-NEGATIVE-INFINITY}
     605\index{SINGLE-FLOAT-NEGATIVE-INFINITY}
     606--- Variable: \textbf{single-float-negative-infinity} [\textbf{extensions}] \textit{}
     607
     608\begin{adjustwidth}{5em}{5em}
     609NOT-DOCUMENTED
     610\end{adjustwidth}
     611
     612\paragraph{}
     613\label{EXTENSIONS:QUIT}
     614\index{QUIT}
     615--- Function: \textbf{quit} [\textbf{extensions}] \textit{\&key status}
     616
     617\begin{adjustwidth}{5em}{5em}
     618NOT-DOCUMENTED
     619\end{adjustwidth}
     620
     621\paragraph{}
     622\label{EXTENSIONS:INTERNAL-COMPILER-ERROR}
     623\index{INTERNAL-COMPILER-ERROR}
     624--- Function: \textbf{internal-compiler-error} [\textbf{extensions}] \textit{format-control \&rest format-arguments}
     625
     626\begin{adjustwidth}{5em}{5em}
     627NOT-DOCUMENTED
     628\end{adjustwidth}
     629
     630\paragraph{}
     631\label{EXTENSIONS:JAR-PATHNAME}
     632\index{JAR-PATHNAME}
     633--- Class: \textbf{jar-pathname} [\textbf{extensions}] \textit{}
     634
     635\begin{adjustwidth}{5em}{5em}
     636NOT-DOCUMENTED
     637\end{adjustwidth}
     638
     639NIL
     640
     641\paragraph{}
     642\label{EXTENSIONS:SIMPLE-STRING-SEARCH}
     643\index{SIMPLE-STRING-SEARCH}
     644--- Function: \textbf{simple-string-search} [\textbf{extensions}] \textit{}
     645
     646\begin{adjustwidth}{5em}{5em}
     647NOT-DOCUMENTED
     648\end{adjustwidth}
     649
     650\paragraph{}
     651\label{EXTENSIONS:ASSQL}
     652\index{ASSQL}
     653--- Function: \textbf{assql} [\textbf{extensions}] \textit{}
     654
     655\begin{adjustwidth}{5em}{5em}
     656NOT-DOCUMENTED
     657\end{adjustwidth}
     658
     659\paragraph{}
     660\label{EXTENSIONS:FINALIZE}
     661\index{FINALIZE}
     662--- Function: \textbf{finalize} [\textbf{extensions}] \textit{object function}
     663
     664\begin{adjustwidth}{5em}{5em}
     665NOT-DOCUMENTED
     666\end{adjustwidth}
     667
     668\paragraph{}
     669\label{EXTENSIONS:RUN-SHELL-COMMAND}
     670\index{RUN-SHELL-COMMAND}
     671--- Function: \textbf{run-shell-command} [\textbf{extensions}] \textit{command \&key directory (output *standard-output*)}
     672
     673\begin{adjustwidth}{5em}{5em}
     674NOT-DOCUMENTED
     675\end{adjustwidth}
     676
     677\paragraph{}
     678\label{EXTENSIONS:*SAVED-BACKTRACE*}
     679\index{*SAVED-BACKTRACE*}
     680--- Variable: \textbf{*saved-backtrace*} [\textbf{extensions}] \textit{}
     681
     682\begin{adjustwidth}{5em}{5em}
     683NOT-DOCUMENTED
     684\end{adjustwidth}
     685
     686\paragraph{}
     687\label{EXTENSIONS:COLLECT}
     688\index{COLLECT}
     689--- Macro: \textbf{collect} [\textbf{extensions}] \textit{}
     690
     691\begin{adjustwidth}{5em}{5em}
     692NOT-DOCUMENTED
     693\end{adjustwidth}
     694
     695\paragraph{}
     696\label{EXTENSIONS:ARGLIST}
     697\index{ARGLIST}
     698--- Function: \textbf{arglist} [\textbf{extensions}] \textit{extended-function-designator}
     699
     700\begin{adjustwidth}{5em}{5em}
     701NOT-DOCUMENTED
     702\end{adjustwidth}
     703
     704\paragraph{}
     705\label{EXTENSIONS:ADJOIN-EQL}
     706\index{ADJOIN-EQL}
     707--- Function: \textbf{adjoin-eql} [\textbf{extensions}] \textit{item list}
     708
     709\begin{adjustwidth}{5em}{5em}
     710NOT-DOCUMENTED
     711\end{adjustwidth}
     712
     713\paragraph{}
     714\label{EXTENSIONS:CHARPOS}
     715\index{CHARPOS}
     716--- Function: \textbf{charpos} [\textbf{extensions}] \textit{stream}
     717
     718\begin{adjustwidth}{5em}{5em}
     719NOT-DOCUMENTED
     720\end{adjustwidth}
     721
     722\paragraph{}
     723\label{EXTENSIONS:MAKE-TEMP-FILE}
     724\index{MAKE-TEMP-FILE}
     725--- Function: \textbf{make-temp-file} [\textbf{extensions}] \textit{}
     726
     727\begin{adjustwidth}{5em}{5em}
     728NOT-DOCUMENTED
     729\end{adjustwidth}
     730
     731\paragraph{}
     732\label{EXTENSIONS:DESCRIBE-COMPILER-POLICY}
     733\index{DESCRIBE-COMPILER-POLICY}
     734--- Function: \textbf{describe-compiler-policy} [\textbf{extensions}] \textit{}
     735
     736\begin{adjustwidth}{5em}{5em}
     737NOT-DOCUMENTED
     738\end{adjustwidth}
     739
     740\paragraph{}
     741\label{EXTENSIONS:*PRINT-STRUCTURE*}
     742\index{*PRINT-STRUCTURE*}
     743--- Variable: \textbf{*print-structure*} [\textbf{extensions}] \textit{}
     744
     745\begin{adjustwidth}{5em}{5em}
     746NOT-DOCUMENTED
     747\end{adjustwidth}
     748
     749\paragraph{}
     750\label{EXTENSIONS:SOCKET-PEER-ADDRESS}
     751\index{SOCKET-PEER-ADDRESS}
     752--- Function: \textbf{socket-peer-address} [\textbf{extensions}] \textit{socket}
     753
     754\begin{adjustwidth}{5em}{5em}
     755Returns the peer address of the given socket as a dotted quad string.
     756\end{adjustwidth}
     757
     758\paragraph{}
     759\label{EXTENSIONS:GC}
     760\index{GC}
     761--- Function: \textbf{gc} [\textbf{extensions}] \textit{}
     762
     763\begin{adjustwidth}{5em}{5em}
     764NOT-DOCUMENTED
     765\end{adjustwidth}
     766
     767\paragraph{}
     768\label{EXTENSIONS:GETENV}
     769\index{GETENV}
     770--- Function: \textbf{getenv} [\textbf{extensions}] \textit{variable}
     771
     772\begin{adjustwidth}{5em}{5em}
     773Return the value of the environment VARIABLE if it exists, otherwise return NIL.
     774\end{adjustwidth}
     775
     776\paragraph{}
     777\label{EXTENSIONS:SERVER-SOCKET-CLOSE}
     778\index{SERVER-SOCKET-CLOSE}
     779--- Function: \textbf{server-socket-close} [\textbf{extensions}] \textit{socket}
     780
     781\begin{adjustwidth}{5em}{5em}
     782NOT-DOCUMENTED
     783\end{adjustwidth}
     784
     785\paragraph{}
     786\label{EXTENSIONS:WEAK-REFERENCE}
     787\index{WEAK-REFERENCE}
     788--- Class: \textbf{weak-reference} [\textbf{extensions}] \textit{}
     789
     790\begin{adjustwidth}{5em}{5em}
     791NOT-DOCUMENTED
     792\end{adjustwidth}
     793
     794\paragraph{}
     795\label{EXTENSIONS:GET-FLOATING-POINT-MODES}
     796\index{GET-FLOATING-POINT-MODES}
     797--- Function: \textbf{get-floating-point-modes} [\textbf{extensions}] \textit{}
     798
     799\begin{adjustwidth}{5em}{5em}
     800NOT-DOCUMENTED
     801\end{adjustwidth}
     802
     803\paragraph{}
     804\label{EXTENSIONS:WEAK-REFERENCE-VALUE}
     805\index{WEAK-REFERENCE-VALUE}
     806--- Function: \textbf{weak-reference-value} [\textbf{extensions}] \textit{obj}
     807
     808\begin{adjustwidth}{5em}{5em}
     809Returns two values, the first being the value of the weak ref,the second T if the reference is valid, or NIL if it hasbeen cleared.
     810\end{adjustwidth}
     811
     812\paragraph{}
     813\label{EXTENSIONS:SINGLE-FLOAT-POSITIVE-INFINITY}
     814\index{SINGLE-FLOAT-POSITIVE-INFINITY}
     815--- Variable: \textbf{single-float-positive-infinity} [\textbf{extensions}] \textit{}
     816
     817\begin{adjustwidth}{5em}{5em}
     818NOT-DOCUMENTED
     819\end{adjustwidth}
     820
     821\paragraph{}
     822\label{EXTENSIONS:FEATUREP}
     823\index{FEATUREP}
     824--- Function: \textbf{featurep} [\textbf{extensions}] \textit{form}
     825
     826\begin{adjustwidth}{5em}{5em}
     827NOT-DOCUMENTED
     828\end{adjustwidth}
     829
     830\paragraph{}
     831\label{EXTENSIONS:PATHNAME-URL-P}
     832\index{PATHNAME-URL-P}
     833--- Function: \textbf{pathname-url-p} [\textbf{extensions}] \textit{pathname}
     834
     835\begin{adjustwidth}{5em}{5em}
     836Predicate for whether PATHNAME references a URL.
     837\end{adjustwidth}
     838
     839\paragraph{}
     840\label{EXTENSIONS:STRING-INPUT-STREAM-CURRENT}
     841\index{STRING-INPUT-STREAM-CURRENT}
     842--- Function: \textbf{string-input-stream-current} [\textbf{extensions}] \textit{stream}
     843
     844\begin{adjustwidth}{5em}{5em}
     845NOT-DOCUMENTED
     846\end{adjustwidth}
     847
     848\paragraph{}
     849\label{EXTENSIONS:MAKE-SERVER-SOCKET}
     850\index{MAKE-SERVER-SOCKET}
     851--- Function: \textbf{make-server-socket} [\textbf{extensions}] \textit{port}
     852
     853\begin{adjustwidth}{5em}{5em}
     854NOT-DOCUMENTED
     855\end{adjustwidth}
     856
     857\paragraph{}
     858\label{EXTENSIONS:INTERRUPT-LISP}
     859\index{INTERRUPT-LISP}
     860--- Function: \textbf{interrupt-lisp} [\textbf{extensions}] \textit{}
     861
     862\begin{adjustwidth}{5em}{5em}
     863NOT-DOCUMENTED
     864\end{adjustwidth}
     865
     866\paragraph{}
     867\label{EXTENSIONS:AVER}
     868\index{AVER}
     869--- Macro: \textbf{aver} [\textbf{extensions}] \textit{}
     870
     871\begin{adjustwidth}{5em}{5em}
     872NOT-DOCUMENTED
     873\end{adjustwidth}
     874
     875\paragraph{}
     876\label{EXTENSIONS:INIT-GUI}
     877\index{INIT-GUI}
     878--- Function: \textbf{init-gui} [\textbf{extensions}] \textit{}
     879
     880\begin{adjustwidth}{5em}{5em}
     881Dummy function used to autoload this file
     882\end{adjustwidth}
     883
     884\paragraph{}
     885\label{EXTENSIONS:URL-PATHNAME-QUERY}
     886\index{URL-PATHNAME-QUERY}
     887--- Function: \textbf{url-pathname-query} [\textbf{extensions}] \textit{p}
     888
     889\begin{adjustwidth}{5em}{5em}
     890NOT-DOCUMENTED
     891\end{adjustwidth}
     892
     893\paragraph{}
     894\label{EXTENSIONS:PROCESS-EXIT-CODE}
     895\index{PROCESS-EXIT-CODE}
     896--- Function: \textbf{process-exit-code} [\textbf{extensions}] \textit{instance}
     897
     898\begin{adjustwidth}{5em}{5em}
     899The exit code of a process.
     900\end{adjustwidth}
     901
     902\paragraph{}
     903\label{EXTENSIONS:SOURCE-FILE-POSITION}
     904\index{SOURCE-FILE-POSITION}
     905--- Function: \textbf{source-file-position} [\textbf{extensions}] \textit{}
     906
     907\begin{adjustwidth}{5em}{5em}
     908NOT-DOCUMENTED
     909\end{adjustwidth}
     910
     911\paragraph{}
     912\label{EXTENSIONS:SOCKET-PEER-PORT}
     913\index{SOCKET-PEER-PORT}
     914--- Function: \textbf{socket-peer-port} [\textbf{extensions}] \textit{socket}
     915
     916\begin{adjustwidth}{5em}{5em}
     917Returns the peer port number of the given socket.
     918\end{adjustwidth}
     919
     920\paragraph{}
     921\label{EXTENSIONS:ASSQ}
     922\index{ASSQ}
     923--- Function: \textbf{assq} [\textbf{extensions}] \textit{}
     924
     925\begin{adjustwidth}{5em}{5em}
     926NOT-DOCUMENTED
     927\end{adjustwidth}
     928
     929\paragraph{}
     930\label{EXTENSIONS:SOURCE}
     931\index{SOURCE}
     932--- Function: \textbf{source} [\textbf{extensions}] \textit{}
     933
     934\begin{adjustwidth}{5em}{5em}
     935NOT-DOCUMENTED
     936\end{adjustwidth}
     937
     938\paragraph{}
     939\label{EXTENSIONS:SOCKET-LOCAL-ADDRESS}
     940\index{SOCKET-LOCAL-ADDRESS}
     941--- Function: \textbf{socket-local-address} [\textbf{extensions}] \textit{socket}
     942
     943\begin{adjustwidth}{5em}{5em}
     944Returns the local address of the given socket as a dotted quad string.
     945\end{adjustwidth}
     946
     947\paragraph{}
     948\label{EXTENSIONS:NEQ}
     949\index{NEQ}
     950--- Function: \textbf{neq} [\textbf{extensions}] \textit{obj1 obj2}
     951
     952\begin{adjustwidth}{5em}{5em}
     953NOT-DOCUMENTED
     954\end{adjustwidth}
     955
     956\paragraph{}
     957\label{EXTENSIONS:STRING-FIND}
     958\index{STRING-FIND}
     959--- Function: \textbf{string-find} [\textbf{extensions}] \textit{char string}
     960
     961\begin{adjustwidth}{5em}{5em}
     962NOT-DOCUMENTED
     963\end{adjustwidth}
     964
     965\paragraph{}
     966\label{EXTENSIONS:PATHNAME-JAR-P}
     967\index{PATHNAME-JAR-P}
     968--- Function: \textbf{pathname-jar-p} [\textbf{extensions}] \textit{}
     969
     970\begin{adjustwidth}{5em}{5em}
     971NOT-DOCUMENTED
     972\end{adjustwidth}
     973
     974\paragraph{}
     975\label{EXTENSIONS:PROCESS-WAIT}
     976\index{PROCESS-WAIT}
     977--- Function: \textbf{process-wait} [\textbf{extensions}] \textit{process}
     978
     979\begin{adjustwidth}{5em}{5em}
     980Wait for process to quit running for some reason.
     981\end{adjustwidth}
     982
     983\paragraph{}
     984\label{EXTENSIONS:SHOW-RESTARTS}
     985\index{SHOW-RESTARTS}
     986--- Function: \textbf{show-restarts} [\textbf{extensions}] \textit{restarts stream}
     987
     988\begin{adjustwidth}{5em}{5em}
     989NOT-DOCUMENTED
     990\end{adjustwidth}
     991
     992\paragraph{}
     993\label{EXTENSIONS:*BATCH-MODE*}
     994\index{*BATCH-MODE*}
     995--- Variable: \textbf{*batch-mode*} [\textbf{extensions}] \textit{}
     996
     997\begin{adjustwidth}{5em}{5em}
     998NOT-DOCUMENTED
     999\end{adjustwidth}
     1000
     1001\paragraph{}
     1002\label{EXTENSIONS:PROCESS-P}
     1003\index{PROCESS-P}
     1004--- Function: \textbf{process-p} [\textbf{extensions}] \textit{object}
     1005
     1006\begin{adjustwidth}{5em}{5em}
     1007NOT-DOCUMENTED
     1008\end{adjustwidth}
     1009
     1010\paragraph{}
     1011\label{EXTENSIONS:*GUI-BACKEND*}
     1012\index{*GUI-BACKEND*}
     1013--- Variable: \textbf{*gui-backend*} [\textbf{extensions}] \textit{}
     1014
     1015\begin{adjustwidth}{5em}{5em}
     1016NOT-DOCUMENTED
     1017\end{adjustwidth}
     1018
     1019\paragraph{}
     1020\label{EXTENSIONS:DOUBLE-FLOAT-POSITIVE-INFINITY}
     1021\index{DOUBLE-FLOAT-POSITIVE-INFINITY}
     1022--- Variable: \textbf{double-float-positive-infinity} [\textbf{extensions}] \textit{}
     1023
     1024\begin{adjustwidth}{5em}{5em}
     1025NOT-DOCUMENTED
     1026\end{adjustwidth}
     1027
     1028\paragraph{}
     1029\label{EXTENSIONS:STYLE-WARN}
     1030\index{STYLE-WARN}
     1031--- Function: \textbf{style-warn} [\textbf{extensions}] \textit{format-control \&rest format-arguments}
     1032
     1033\begin{adjustwidth}{5em}{5em}
     1034NOT-DOCUMENTED
     1035\end{adjustwidth}
     1036
     1037\paragraph{}
     1038\label{EXTENSIONS:MOST-NEGATIVE-JAVA-LONG}
     1039\index{MOST-NEGATIVE-JAVA-LONG}
     1040--- Variable: \textbf{most-negative-java-long} [\textbf{extensions}] \textit{}
     1041
     1042\begin{adjustwidth}{5em}{5em}
     1043NOT-DOCUMENTED
     1044\end{adjustwidth}
     1045
     1046\paragraph{}
     1047\label{EXTENSIONS:SLIME-OUTPUT-STREAM}
     1048\index{SLIME-OUTPUT-STREAM}
     1049--- Class: \textbf{slime-output-stream} [\textbf{extensions}] \textit{}
     1050
     1051\begin{adjustwidth}{5em}{5em}
     1052NOT-DOCUMENTED
     1053\end{adjustwidth}
     1054
     1055\paragraph{}
     1056\label{EXTENSIONS:GET-SOCKET-STREAM}
     1057\index{GET-SOCKET-STREAM}
     1058--- Function: \textbf{get-socket-stream} [\textbf{extensions}] \textit{socket \&key (element-type (quote character)) (external-format default)}
     1059
     1060\begin{adjustwidth}{5em}{5em}
     1061:ELEMENT-TYPE must be CHARACTER or (UNSIGNED-BYTE 8); the default is CHARACTER.
     1062EXTERNAL-FORMAT must be of the same format as specified for OPEN.
     1063\end{adjustwidth}
     1064
     1065\paragraph{}
     1066\label{EXTENSIONS:PROCESS-OUTPUT}
     1067\index{PROCESS-OUTPUT}
     1068--- Function: \textbf{process-output} [\textbf{extensions}] \textit{}
     1069
     1070\begin{adjustwidth}{5em}{5em}
     1071NOT-DOCUMENTED
     1072\end{adjustwidth}
     1073
     1074\paragraph{}
     1075\label{EXTENSIONS:URL-PATHNAME}
     1076\index{URL-PATHNAME}
     1077--- Class: \textbf{url-pathname} [\textbf{extensions}] \textit{}
     1078
     1079\begin{adjustwidth}{5em}{5em}
     1080NOT-DOCUMENTED
     1081\end{adjustwidth}
     1082
     1083\paragraph{}
     1084\label{EXTENSIONS:COMPILER-UNSUPPORTED-FEATURE-ERROR}
     1085\index{COMPILER-UNSUPPORTED-FEATURE-ERROR}
     1086--- Class: \textbf{compiler-unsupported-feature-error} [\textbf{extensions}] \textit{}
     1087
     1088\begin{adjustwidth}{5em}{5em}
     1089NOT-DOCUMENTED
     1090\end{adjustwidth}
     1091
     1092\paragraph{}
     1093\label{EXTENSIONS:*DEBUG-LEVEL*}
     1094\index{*DEBUG-LEVEL*}
     1095--- Variable: \textbf{*debug-level*} [\textbf{extensions}] \textit{}
     1096
     1097\begin{adjustwidth}{5em}{5em}
     1098NOT-DOCUMENTED
     1099\end{adjustwidth}
     1100
     1101\paragraph{}
     1102\label{EXTENSIONS:COMPILER-ERROR}
     1103\index{COMPILER-ERROR}
     1104--- Function: \textbf{compiler-error} [\textbf{extensions}] \textit{format-control \&rest format-arguments}
     1105
     1106\begin{adjustwidth}{5em}{5em}
     1107NOT-DOCUMENTED
     1108\end{adjustwidth}
     1109
     1110\paragraph{}
     1111\label{EXTENSIONS:MACROEXPAND-ALL}
     1112\index{MACROEXPAND-ALL}
     1113--- Function: \textbf{macroexpand-all} [\textbf{extensions}] \textit{form \&optional env}
     1114
     1115\begin{adjustwidth}{5em}{5em}
     1116NOT-DOCUMENTED
     1117\end{adjustwidth}
     1118
  • trunk/abcl/doc/manual/java.tex

    r13627 r13690  
    1 \begin{verbatim}
    2 %JGET-PROPERTY-VALUE
    3   Function: Gets a JavaBeans property on JAVA-OBJECT.
    4 %JSET-PROPERTY-VALUE
    5   Function: Sets a JavaBean property on JAVA-OBJECT.
    6 *JAVA-OBJECT-TO-STRING-LENGTH*
    7   Variable: Length to truncate toString() PRINT-OBJECT output for an
    8  otherwise unspecialized JAVA-OBJECT.  Can be set to NIL to indicate
    9  no limit.
    10 +FALSE+
    11   Variable: The JVM primitive value for boolean false.
    12 +NULL+
    13   Variable: The JVM null object reference.
    14 +TRUE+
    15   Variable: The JVM primitive value for boolean true.
    16 ADD-TO-CLASSPATH
    17   Generic Function: (not documented)
    18 CHAIN
    19   Macro: (not documented)
    20 DESCRIBE-JAVA-OBJECT
    21   Function: (not documented)
    22 DUMP-CLASSPATH
    23   Function: (not documented)
    24 ENSURE-JAVA-CLASS
    25   Function: (not documented)
    26 ENSURE-JAVA-OBJECT
    27   Function: Ensures OBJ is wrapped in a JAVA-OBJECT, wrapping it if necessary.
    28 GET-CURRENT-CLASSLOADER
    29   Function: (not documented)
    30 GET-DEFAULT-CLASSLOADER
    31   Function: (not documented)
    32 JARRAY-COMPONENT-TYPE
    33   Function: Returns the component type of the array type ATYPE
    34 JARRAY-LENGTH
    35   Function: (not documented)
    36 JARRAY-REF
    37   Function: Dereferences the Java array JAVA-ARRAY using the given
    38  INDICIES, coercing the result into a Lisp object, if possible.
    39 JARRAY-REF-RAW
    40   Function: Dereference the Java array JAVA-ARRAY using the given
    41  INDICIES. Does not attempt to coerce the result into a Lisp object.
    42 JARRAY-SET
    43   Function: Stores NEW-VALUE at the given index in JAVA-ARRAY.
    44 JAVA-CLASS
    45   Class: (not documented)
    46 JAVA-EXCEPTION
    47   Class: (not documented)
    48 JAVA-EXCEPTION-CAUSE
    49   Function: (not documented)
    50 JAVA-OBJECT
    51   Class: (not documented)
    52 JAVA-OBJECT-P
    53   Function: Returns T if OBJECT is a JAVA-OBJECT.
    54 JCALL
    55   Function: Invokes the Java method METHOD-REF on INSTANCE with
    56  arguments ARGS, coercing the result into a Lisp object, if possible.
    57 JCALL-RAW
    58   Function: Invokes the Java method METHOD-REF on INSTANCE with
    59  arguments ARGS. Does not attempt to coerce the result into a Lisp
    60  object.
    61 JCLASS
    62   Function: Returns a reference to the Java class designated by
    63  NAME-OR-CLASS-REF. If the CLASS-LOADER parameter is passed, the class
    64  is resolved with respect to the given ClassLoader.
    65 JCLASS-ARRAY-P
    66   Function: Returns T if CLASS is an array class
    67 JCLASS-CONSTRUCTORS
    68   Function: Returns a vector of constructors for CLASS
    69 JCLASS-FIELD
    70   Function: Returns the field named FIELD-NAME of CLASS
    71 JCLASS-FIELDS
    72   Function: Returns a vector of all (or just the declared/public, if
    73  DECLARED/PUBLIC is true) fields of CLASS
    74 JCLASS-INTERFACE-P
    75   Function: Returns T if CLASS is an interface
    76 JCLASS-INTERFACES
    77   Function: Returns the vector of interfaces of CLASS
    78 JCLASS-METHODS
    79   Function: Return a vector of all (or just the declared/public, if
    80  DECLARED/PUBLIC is true) methods of CLASS
    81 JCLASS-NAME
    82   Function: (not documented)
    83 JCLASS-OF
    84   Function: (not documented)
    85 JCLASS-SUPERCLASS
    86   Function: Returns the superclass of CLASS, or NIL if it hasn't got one
    87 JCLASS-SUPERCLASS-P
    88   Function: Returns T if CLASS-1 is a superclass or interface of CLASS-2
    89 JCOERCE
    90   Function: Attempts to coerce OBJECT into a JavaObject of class
    91  INTENDED-CLASS.  Raises a TYPE-ERROR if no conversion is possible.
    92 JCONSTRUCTOR
    93   Function: Returns a reference to the Java constructor of CLASS-REF
    94  with the given PARAMETER-CLASS-REFS.
    95 JCONSTRUCTOR-PARAMS
    96   Function: Returns a vector of parameter types (Java classes) for CONSTRUCTOR
    97 JEQUAL
    98   Function: Compares obj1 with obj2 using java.lang.Object.equals()
    99 JFIELD
    100   Function: Retrieves or modifies a field in a Java class or instance.
    101 JFIELD-NAME
    102   Function: Returns the name of FIELD as a Lisp string
    103 JFIELD-RAW
    104   Function: Retrieves or modifies a field in a Java class or instance. Does not
    105 JFIELD-TYPE
    106   Function: Returns the type (Java class) of FIELD
    107 JINSTANCE-OF-P
    108   Function: OBJ is an instance of CLASS (or one of its subclasses)
    109 JINTERFACE-IMPLEMENTATION
    110   Function: Creates and returns an implementation of a Java interface with
    111 JMAKE-INVOCATION-HANDLER
    112   Function: (not documented)
    113 JMAKE-PROXY
    114   Generic Function: (not documented)
    115 JMEMBER-PROTECTED-P
    116   Function: MEMBER is a protected member of its declaring class
    117 JMEMBER-PUBLIC-P
    118   Function: MEMBER is a public member of its declaring class
    119 JMEMBER-STATIC-P
    120   Function: MEMBER is a static member of its declaring class
    121 JMETHOD
    122   Function: Returns a reference to the Java method METHOD-NAME of
    123  CLASS-REF with the given PARAMETER-CLASS-REFS.
    124 JMETHOD-LET
    125   Macro: (not documented)
    126 JMETHOD-NAME
    127   Function: Returns the name of METHOD as a Lisp string
    128 JMETHOD-PARAMS
    129   Function: Returns a vector of parameter types (Java classes) for METHOD
    130 JMETHOD-RETURN-TYPE
    131   Function: Returns the result type (Java class) of the METHOD
    132 JNEW
    133   Function: Invokes the Java constructor CONSTRUCTOR with the arguments ARGS.
    134 JNEW-ARRAY
    135   Function: Creates a new Java array of type ELEMENT-TYPE, with the given DIMENSIONS.
    136 JNEW-ARRAY-FROM-ARRAY
    137   Function: Returns a new Java array with base type ELEMENT-TYPE (a string or a class-ref)
    138 JNEW-ARRAY-FROM-LIST
    139   Function: (not documented)
    140 JNEW-RUNTIME-CLASS
    141   Function: (not documented)
    142 JNULL-REF-P
    143   Function: Returns a non-NIL value when the JAVA-OBJECT `object` is `null`,
    144 JOBJECT-CLASS
    145   Function: Returns the Java class that OBJ belongs to
    146 JOBJECT-LISP-VALUE
    147   Function: Attempts to coerce JAVA-OBJECT into a Lisp object.
    148 JPROPERTY-VALUE
    149   Function: (not documented)
    150 JREDEFINE-METHOD
    151   Function: (not documented)
    152 JREGISTER-HANDLER
    153   Function: (not documented)
    154 JRESOLVE-METHOD
    155   Function: Finds the most specific Java method METHOD-NAME on
    156  INSTANCE applicable to arguments ARGS. Returns NIL if no suitable
    157  method is found. The algorithm used for resolution is the same used
    158  by JCALL when it is called with a string as the first parameter
    159  (METHOD-REF).
    160 JRUN-EXCEPTION-PROTECTED
    161   Function: Invokes the function CLOSURE and returns the result.
    162   Signals an error if stack or heap exhaustion occurs.
    163 JRUNTIME-CLASS-EXISTS-P
    164   Function: (not documented)
    165 JSTATIC
    166   Function: Invokes the static method METHOD on class CLASS with ARGS.
    167 JSTATIC-RAW
    168   Function: Invokes the static method METHOD on class CLASS with
    169  ARGS. Does not attempt to coerce the arguments or result into a Lisp
    170  object.
    171 MAKE-CLASSLOADER
    172   Function: (not documented)
    173 MAKE-IMMEDIATE-OBJECT
    174   Function: Attempts to coerce a given Lisp object into a java-object of the
    175 REGISTER-JAVA-EXCEPTION
    176   Function: Registers the Java Throwable named by the symbol
    177  EXCEPTION-NAME as the condition designated by CONDITION-SYMBOL.
    178   Returns T if successful, NIL if not.
    179 UNREGISTER-JAVA-EXCEPTION
    180   Function: Unregisters the Java Throwable EXCEPTION-NAME previously
    181  registered by REGISTER-JAVA-EXCEPTION.
    182 \end{verbatim}
     1\subsection{Exported Symbols from the JAVA package}
     2\paragraph{}
     3\label{JAVA:JAVA-EXCEPTION-CAUSE}
     4\index{JAVA-EXCEPTION-CAUSE}
     5--- Function: \textbf{java-exception-cause} [\textbf{java}] \textit{java-exception}
     6
     7\begin{adjustwidth}{5em}{5em}
     8Returns the cause of JAVA-EXCEPTION. (The cause is the Java Throwable
     9  object that caused JAVA-EXCEPTION to be signalled.)
     10\end{adjustwidth}
     11
     12\paragraph{}
     13\label{JAVA:JCLASS-SUPERCLASS-P}
     14\index{JCLASS-SUPERCLASS-P}
     15--- Function: \textbf{jclass-superclass-p} [\textbf{java}] \textit{class-1 class-2}
     16
     17\begin{adjustwidth}{5em}{5em}
     18Returns T if CLASS-1 is a superclass or interface of CLASS-2
     19\end{adjustwidth}
     20
     21\paragraph{}
     22\label{JAVA:JINTERFACE-IMPLEMENTATION}
     23\index{JINTERFACE-IMPLEMENTATION}
     24--- Function: \textbf{jinterface-implementation} [\textbf{java}] \textit{interface \&rest method-names-and-defs}
     25
     26\begin{adjustwidth}{5em}{5em}
     27Creates and returns an implementation of a Java interface with
     28   methods calling Lisp closures as given in METHOD-NAMES-AND-DEFS.
     29
     30   INTERFACE is either a Java interface or a string naming one.
     31
     32   METHOD-NAMES-AND-DEFS is an alternating list of method names
     33   (strings) and method definitions (closures).
     34
     35   For missing methods, a dummy implementation is provided that
     36   returns nothing or null depending on whether the return type is
     37   void or not. This is for convenience only, and a warning is issued
     38   for each undefined method.
     39\end{adjustwidth}
     40
     41\paragraph{}
     42\label{JAVA:DUMP-CLASSPATH}
     43\index{DUMP-CLASSPATH}
     44--- Function: \textbf{dump-classpath} [\textbf{java}] \textit{\&optional classloader}
     45
     46\begin{adjustwidth}{5em}{5em}
     47NOT-DOCUMENTED
     48\end{adjustwidth}
     49
     50\paragraph{}
     51\label{JAVA:ENSURE-JAVA-OBJECT}
     52\index{ENSURE-JAVA-OBJECT}
     53--- Function: \textbf{ensure-java-object} [\textbf{java}] \textit{obj}
     54
     55\begin{adjustwidth}{5em}{5em}
     56Ensures OBJ is wrapped in a JAVA-OBJECT, wrapping it if necessary.
     57\end{adjustwidth}
     58
     59\paragraph{}
     60\label{JAVA:JMETHOD-RETURN-TYPE}
     61\index{JMETHOD-RETURN-TYPE}
     62--- Function: \textbf{jmethod-return-type} [\textbf{java}] \textit{method}
     63
     64\begin{adjustwidth}{5em}{5em}
     65Returns the result type (Java class) of the METHOD
     66\end{adjustwidth}
     67
     68\paragraph{}
     69\label{JAVA:JFIELD-NAME}
     70\index{JFIELD-NAME}
     71--- Function: \textbf{jfield-name} [\textbf{java}] \textit{field}
     72
     73\begin{adjustwidth}{5em}{5em}
     74Returns the name of FIELD as a Lisp string
     75\end{adjustwidth}
     76
     77\paragraph{}
     78\label{JAVA:*JAVA-OBJECT-TO-STRING-LENGTH*}
     79\index{*JAVA-OBJECT-TO-STRING-LENGTH*}
     80--- Variable: \textbf{*java-object-to-string-length*} [\textbf{java}] \textit{}
     81
     82\begin{adjustwidth}{5em}{5em}
     83Length to truncate toString() PRINT-OBJECT output for an otherwise unspecialized JAVA-OBJECT.  Can be set to NIL to indicate no limit.
     84\end{adjustwidth}
     85
     86\paragraph{}
     87\label{JAVA:JRUN-EXCEPTION-PROTECTED}
     88\index{JRUN-EXCEPTION-PROTECTED}
     89--- Function: \textbf{jrun-exception-protected} [\textbf{java}] \textit{closure}
     90
     91\begin{adjustwidth}{5em}{5em}
     92Invokes the function CLOSURE and returns the result.  Signals an error if stack or heap exhaustion occurs.
     93\end{adjustwidth}
     94
     95\paragraph{}
     96\label{JAVA:JINSTANCE-OF-P}
     97\index{JINSTANCE-OF-P}
     98--- Function: \textbf{jinstance-of-p} [\textbf{java}] \textit{obj class}
     99
     100\begin{adjustwidth}{5em}{5em}
     101OBJ is an instance of CLASS (or one of its subclasses)
     102\end{adjustwidth}
     103
     104\paragraph{}
     105\label{JAVA:JMETHOD-NAME}
     106\index{JMETHOD-NAME}
     107--- Function: \textbf{jmethod-name} [\textbf{java}] \textit{method}
     108
     109\begin{adjustwidth}{5em}{5em}
     110Returns the name of METHOD as a Lisp string
     111\end{adjustwidth}
     112
     113\paragraph{}
     114\label{JAVA:JSTATIC-RAW}
     115\index{JSTATIC-RAW}
     116--- Function: \textbf{jstatic-raw} [\textbf{java}] \textit{method class \&rest args}
     117
     118\begin{adjustwidth}{5em}{5em}
     119Invokes the static method METHOD on class CLASS with ARGS. Does not attempt to coerce the arguments or result into a Lisp object.
     120\end{adjustwidth}
     121
     122\paragraph{}
     123\label{JAVA:JCLASS-OF}
     124\index{JCLASS-OF}
     125--- Function: \textbf{jclass-of} [\textbf{java}] \textit{object \&optional name}
     126
     127\begin{adjustwidth}{5em}{5em}
     128Returns the name of the Java class of OBJECT. If the NAME argument is
     129  supplied, verifies that OBJECT is an instance of the named class. The name
     130  of the class or nil is always returned as a second value.
     131\end{adjustwidth}
     132
     133\paragraph{}
     134\label{JAVA:GET-CURRENT-CLASSLOADER}
     135\index{GET-CURRENT-CLASSLOADER}
     136--- Function: \textbf{get-current-classloader} [\textbf{java}] \textit{}
     137
     138\begin{adjustwidth}{5em}{5em}
     139NOT-DOCUMENTED
     140\end{adjustwidth}
     141
     142
     143\paragraph{}
     144\label{JAVA:JNEW-ARRAY-FROM-LIST}
     145\index{JNEW-ARRAY-FROM-LIST}
     146--- Function: \textbf{jnew-array-from-list} [\textbf{java}] \textit{element-type list}
     147
     148\begin{adjustwidth}{5em}{5em}
     149NOT-DOCUMENTED
     150\end{adjustwidth}
     151
     152\paragraph{}
     153\label{JAVA:JMETHOD}
     154\index{JMETHOD}
     155--- Function: \textbf{jmethod} [\textbf{java}] \textit{class-ref method-name \&rest parameter-class-refs}
     156
     157\begin{adjustwidth}{5em}{5em}
     158Returns a reference to the Java method METHOD-NAME of CLASS-REF with the given PARAMETER-CLASS-REFS.
     159\end{adjustwidth}
     160
     161\paragraph{}
     162\label{JAVA:GET-DEFAULT-CLASSLOADER}
     163\index{GET-DEFAULT-CLASSLOADER}
     164--- Function: \textbf{get-default-classloader} [\textbf{java}] \textit{}
     165
     166\begin{adjustwidth}{5em}{5em}
     167NOT-DOCUMENTED
     168\end{adjustwidth}
     169
     170\paragraph{}
     171\label{JAVA:JCLASS-METHODS}
     172\index{JCLASS-METHODS}
     173--- Function: \textbf{jclass-methods} [\textbf{java}] \textit{class \&key declared public}
     174
     175\begin{adjustwidth}{5em}{5em}
     176Return a vector of all (or just the declared/public, if DECLARED/PUBLIC is true) methods of CLASS
     177\end{adjustwidth}
     178
     179\paragraph{}
     180\label{JAVA:REGISTER-JAVA-EXCEPTION}
     181\index{REGISTER-JAVA-EXCEPTION}
     182--- Function: \textbf{register-java-exception} [\textbf{java}] \textit{exception-name condition-symbol}
     183
     184\begin{adjustwidth}{5em}{5em}
     185Registers the Java Throwable named by the symbol EXCEPTION-NAME as the condition designated by CONDITION-SYMBOL.  Returns T if successful, NIL if not.
     186\end{adjustwidth}
     187
     188\paragraph{}
     189\label{JAVA:JCLASS}
     190\index{JCLASS}
     191--- Function: \textbf{jclass} [\textbf{java}] \textit{name-or-class-ref \&optional class-loader}
     192
     193\begin{adjustwidth}{5em}{5em}
     194Returns 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.
     195\end{adjustwidth}
     196
     197\paragraph{}
     198\label{JAVA:JPROPERTY-VALUE}
     199\index{JPROPERTY-VALUE}
     200--- Function: \textbf{jproperty-value} [\textbf{java}] \textit{obj prop}
     201
     202\begin{adjustwidth}{5em}{5em}
     203NOT-DOCUMENTED
     204\end{adjustwidth}
     205
     206\paragraph{}
     207\label{JAVA:JFIELD-TYPE}
     208\index{JFIELD-TYPE}
     209--- Function: \textbf{jfield-type} [\textbf{java}] \textit{field}
     210
     211\begin{adjustwidth}{5em}{5em}
     212Returns the type (Java class) of FIELD
     213\end{adjustwidth}
     214
     215\paragraph{}
     216\label{JAVA:JNEW-RUNTIME-CLASS}
     217\index{JNEW-RUNTIME-CLASS}
     218--- Function: \textbf{jnew-runtime-class} [\textbf{java}] \textit{}
     219
     220\begin{adjustwidth}{5em}{5em}
     221NOT-DOCUMENTED
     222\end{adjustwidth}
     223
     224\paragraph{}
     225\label{JAVA:JCLASS-CONSTRUCTORS}
     226\index{JCLASS-CONSTRUCTORS}
     227--- Function: \textbf{jclass-constructors} [\textbf{java}] \textit{class}
     228
     229\begin{adjustwidth}{5em}{5em}
     230Returns a vector of constructors for CLASS
     231\end{adjustwidth}
     232
     233\paragraph{}
     234\label{JAVA:JSTATIC}
     235\index{JSTATIC}
     236--- Function: \textbf{jstatic} [\textbf{java}] \textit{method class \&rest args}
     237
     238\begin{adjustwidth}{5em}{5em}
     239Invokes the static method METHOD on class CLASS with ARGS.
     240\end{adjustwidth}
     241
     242\paragraph{}
     243\label{JAVA:JMETHOD-PARAMS}
     244\index{JMETHOD-PARAMS}
     245--- Function: \textbf{jmethod-params} [\textbf{java}] \textit{method}
     246
     247\begin{adjustwidth}{5em}{5em}
     248Returns a vector of parameter types (Java classes) for METHOD
     249\end{adjustwidth}
     250
     251\paragraph{}
     252\label{JAVA:JREGISTER-HANDLER}
     253\index{JREGISTER-HANDLER}
     254--- Function: \textbf{jregister-handler} [\textbf{java}] \textit{object event handler \&key data count}
     255
     256\begin{adjustwidth}{5em}{5em}
     257NOT-DOCUMENTED
     258\end{adjustwidth}
     259
     260\paragraph{}
     261\label{JAVA:JCLASS-SUPERCLASS}
     262\index{JCLASS-SUPERCLASS}
     263--- Function: \textbf{jclass-superclass} [\textbf{java}] \textit{class}
     264
     265\begin{adjustwidth}{5em}{5em}
     266Returns the superclass of CLASS, or NIL if it hasn't got one
     267\end{adjustwidth}
     268
     269\paragraph{}
     270\label{JAVA:JAVA-OBJECT-P}
     271\index{JAVA-OBJECT-P}
     272--- Function: \textbf{java-object-p} [\textbf{java}] \textit{object}
     273
     274\begin{adjustwidth}{5em}{5em}
     275Returns T if OBJECT is a JAVA-OBJECT.
     276\end{adjustwidth}
     277
     278\paragraph{}
     279\label{JAVA:UNREGISTER-JAVA-EXCEPTION}
     280\index{UNREGISTER-JAVA-EXCEPTION}
     281--- Function: \textbf{unregister-java-exception} [\textbf{java}] \textit{exception-name}
     282
     283\begin{adjustwidth}{5em}{5em}
     284Unregisters the Java Throwable EXCEPTION-NAME previously registered by REGISTER-JAVA-EXCEPTION.
     285\end{adjustwidth}
     286
     287\paragraph{}
     288\label{JAVA:JNEW}
     289\index{JNEW}
     290--- Function: \textbf{jnew} [\textbf{java}] \textit{constructor \&rest args}
     291
     292\begin{adjustwidth}{5em}{5em}
     293Invokes the Java constructor CONSTRUCTOR with the arguments ARGS.
     294\end{adjustwidth}
     295
     296\paragraph{}
     297\label{JAVA:JRUNTIME-CLASS-EXISTS-P}
     298\index{JRUNTIME-CLASS-EXISTS-P}
     299--- Function: \textbf{jruntime-class-exists-p} [\textbf{java}] \textit{}
     300
     301\begin{adjustwidth}{5em}{5em}
     302NOT-DOCUMENTED
     303\end{adjustwidth}
     304
     305\paragraph{}
     306\label{JAVA:JARRAY-COMPONENT-TYPE}
     307\index{JARRAY-COMPONENT-TYPE}
     308--- Function: \textbf{jarray-component-type} [\textbf{java}] \textit{atype}
     309
     310\begin{adjustwidth}{5em}{5em}
     311Returns the component type of the array type ATYPE
     312\end{adjustwidth}
     313
     314\paragraph{}
     315\label{JAVA:ADD-TO-CLASSPATH}
     316\index{ADD-TO-CLASSPATH}
     317--- Generic Function: \textbf{add-to-classpath} [\textbf{java}] \textit{}
     318
     319\begin{adjustwidth}{5em}{5em}
     320NOT-DOCUMENTED
     321\end{adjustwidth}
     322
     323\paragraph{}
     324\label{JAVA:JOBJECT-LISP-VALUE}
     325\index{JOBJECT-LISP-VALUE}
     326--- Function: \textbf{jobject-lisp-value} [\textbf{java}] \textit{java-object}
     327
     328\begin{adjustwidth}{5em}{5em}
     329Attempts to coerce JAVA-OBJECT into a Lisp object.
     330\end{adjustwidth}
     331
     332\paragraph{}
     333\label{JAVA:JCLASS-NAME}
     334\index{JCLASS-NAME}
     335--- Function: \textbf{jclass-name} [\textbf{java}] \textit{class-ref \&optional name}
     336
     337\begin{adjustwidth}{5em}{5em}
     338When called with one argument, returns the name of the Java class
     339  designated by CLASS-REF. When called with two arguments, tests
     340  whether CLASS-REF matches NAME.
     341\end{adjustwidth}
     342
     343\paragraph{}
     344\label{JAVA:JMEMBER-PUBLIC-P}
     345\index{JMEMBER-PUBLIC-P}
     346--- Function: \textbf{jmember-public-p} [\textbf{java}] \textit{member}
     347
     348\begin{adjustwidth}{5em}{5em}
     349MEMBER is a public member of its declaring class
     350\end{adjustwidth}
     351
     352\paragraph{}
     353\label{JAVA:+NULL+}
     354\index{+NULL+}
     355--- Variable: \textbf{+null+} [\textbf{java}] \textit{}
     356
     357\begin{adjustwidth}{5em}{5em}
     358The JVM null object reference.
     359\end{adjustwidth}
     360
     361\paragraph{}
     362\label{JAVA:ENSURE-JAVA-CLASS}
     363\index{ENSURE-JAVA-CLASS}
     364--- Function: \textbf{ensure-java-class} [\textbf{java}] \textit{jclass}
     365
     366\begin{adjustwidth}{5em}{5em}
     367NOT-DOCUMENTED
     368\end{adjustwidth}
     369
     370\paragraph{}
     371\label{JAVA:JAVA-CLASS}
     372\index{JAVA-CLASS}
     373--- Class: \textbf{java-class} [\textbf{java}] \textit{}
     374
     375\begin{adjustwidth}{5em}{5em}
     376NOT-DOCUMENTED
     377\end{adjustwidth}
     378
     379\paragraph{}
     380\label{JAVA:JMETHOD-LET}
     381\index{JMETHOD-LET}
     382--- Macro: \textbf{jmethod-let} [\textbf{java}] \textit{}
     383
     384\begin{adjustwidth}{5em}{5em}
     385NOT-DOCUMENTED
     386\end{adjustwidth}
     387
     388\paragraph{}
     389\label{JAVA:JCLASS-ARRAY-P}
     390\index{JCLASS-ARRAY-P}
     391--- Function: \textbf{jclass-array-p} [\textbf{java}] \textit{class}
     392
     393\begin{adjustwidth}{5em}{5em}
     394Returns T if CLASS is an array class
     395\end{adjustwidth}
     396
     397\paragraph{}
     398\label{JAVA:JCALL}
     399\index{JCALL}
     400--- Function: \textbf{jcall} [\textbf{java}] \textit{method-ref instance \&rest args}
     401
     402\begin{adjustwidth}{5em}{5em}
     403Invokes the Java method METHOD-REF on INSTANCE with arguments ARGS, coercing the result into a Lisp object, if possible.
     404\end{adjustwidth}
     405
     406\paragraph{}
     407\label{JAVA:JARRAY-REF-RAW}
     408\index{JARRAY-REF-RAW}
     409--- Function: \textbf{jarray-ref-raw} [\textbf{java}] \textit{java-array \&rest indices}
     410
     411\begin{adjustwidth}{5em}{5em}
     412Dereference the Java array JAVA-ARRAY using the given INDICIES. Does not attempt to coerce the result into a Lisp object.
     413\end{adjustwidth}
     414
     415\paragraph{}
     416\label{JAVA:JEQUAL}
     417\index{JEQUAL}
     418--- Function: \textbf{jequal} [\textbf{java}] \textit{obj1 obj2}
     419
     420\begin{adjustwidth}{5em}{5em}
     421Compares obj1 with obj2 using java.lang.Object.equals()
     422\end{adjustwidth}
     423
     424\paragraph{}
     425\label{JAVA:JNULL-REF-P}
     426\index{JNULL-REF-P}
     427--- Function: \textbf{jnull-ref-p} [\textbf{java}] \textit{object}
     428
     429\begin{adjustwidth}{5em}{5em}
     430Returns a non-NIL value when the JAVA-OBJECT `object` is `null`,
     431or signals a TYPE-ERROR condition if the object isn't of
     432the right type.
     433\end{adjustwidth}
     434
     435\paragraph{}
     436\label{JAVA:JNEW-ARRAY}
     437\index{JNEW-ARRAY}
     438--- Function: \textbf{jnew-array} [\textbf{java}] \textit{element-type \&rest dimensions}
     439
     440\begin{adjustwidth}{5em}{5em}
     441Creates a new Java array of type ELEMENT-TYPE, with the given DIMENSIONS.
     442\end{adjustwidth}
     443
     444\paragraph{}
     445\label{JAVA:CHAIN}
     446\index{CHAIN}
     447--- Macro: \textbf{chain} [\textbf{java}] \textit{}
     448
     449\begin{adjustwidth}{5em}{5em}
     450NOT-DOCUMENTED
     451\end{adjustwidth}
     452
     453\paragraph{}
     454\label{JAVA:JFIELD}
     455\index{JFIELD}
     456--- Function: \textbf{jfield} [\textbf{java}] \textit{class-ref-or-field field-or-instance \&optional instance value}
     457
     458\begin{adjustwidth}{5em}{5em}
     459Retrieves or modifies a field in a Java class or instance.
     460
     461Supported argument patterns:
     462
     463   Case 1: class-ref  field-name:
     464      Retrieves the value of a static field.
     465
     466   Case 2: class-ref  field-name  instance-ref:
     467      Retrieves the value of a class field of the instance.
     468
     469   Case 3: class-ref  field-name  primitive-value:
     470      Stores a primitive-value in a static field.
     471
     472   Case 4: class-ref  field-name  instance-ref  value:
     473      Stores value in a class field of the instance.
     474
     475   Case 5: class-ref  field-name  nil  value:
     476      Stores value in a static field (when value may be
     477      confused with an instance-ref).
     478
     479   Case 6: field-name  instance:
     480      Retrieves the value of a field of the instance. The
     481      class is derived from the instance.
     482
     483   Case 7: field-name  instance  value:
     484      Stores value in a field of the instance. The class is
     485      derived from the instance.
     486
     487\end{adjustwidth}
     488
     489\paragraph{}
     490\label{JAVA:JAVA-OBJECT}
     491\index{JAVA-OBJECT}
     492--- Class: \textbf{java-object} [\textbf{java}] \textit{}
     493
     494\begin{adjustwidth}{5em}{5em}
     495NOT-DOCUMENTED
     496\end{adjustwidth}
     497
     498\paragraph{}
     499\label{JAVA:JCLASS-INTERFACES}
     500\index{JCLASS-INTERFACES}
     501--- Function: \textbf{jclass-interfaces} [\textbf{java}] \textit{class}
     502
     503\begin{adjustwidth}{5em}{5em}
     504Returns the vector of interfaces of CLASS
     505\end{adjustwidth}
     506
     507\paragraph{}
     508\label{JAVA:+TRUE+}
     509\index{+TRUE+}
     510--- Variable: \textbf{+true+} [\textbf{java}] \textit{}
     511
     512\begin{adjustwidth}{5em}{5em}
     513The JVM primitive value for boolean true.
     514\end{adjustwidth}
     515
     516\paragraph{}
     517\label{JAVA:JMAKE-INVOCATION-HANDLER}
     518\index{JMAKE-INVOCATION-HANDLER}
     519--- Function: \textbf{jmake-invocation-handler} [\textbf{java}] \textit{function}
     520
     521\begin{adjustwidth}{5em}{5em}
     522NOT-DOCUMENTED
     523\end{adjustwidth}
     524
     525\paragraph{}
     526\label{JAVA:JRESOLVE-METHOD}
     527\index{JRESOLVE-METHOD}
     528--- Function: \textbf{jresolve-method} [\textbf{java}] \textit{method-name instance \&rest args}
     529
     530\begin{adjustwidth}{5em}{5em}
     531Finds 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).
     532\end{adjustwidth}
     533
     534\paragraph{}
     535\label{JAVA:MAKE-CLASSLOADER}
     536\index{MAKE-CLASSLOADER}
     537--- Function: \textbf{make-classloader} [\textbf{java}] \textit{\&optional parent}
     538
     539\begin{adjustwidth}{5em}{5em}
     540NOT-DOCUMENTED
     541\end{adjustwidth}
     542
     543\paragraph{}
     544\label{JAVA:JMEMBER-PROTECTED-P}
     545\index{JMEMBER-PROTECTED-P}
     546--- Function: \textbf{jmember-protected-p} [\textbf{java}] \textit{member}
     547
     548\begin{adjustwidth}{5em}{5em}
     549MEMBER is a protected member of its declaring class
     550\end{adjustwidth}
     551
     552\paragraph{}
     553\label{JAVA:MAKE-IMMEDIATE-OBJECT}
     554\index{MAKE-IMMEDIATE-OBJECT}
     555--- Function: \textbf{make-immediate-object} [\textbf{java}] \textit{object \&optional type}
     556
     557\begin{adjustwidth}{5em}{5em}
     558Attempts to coerce a given Lisp object into a java-object of the
     559given type.  If type is not provided, works as jobject-lisp-value.
     560Currently, type may be :BOOLEAN, treating the object as a truth value,
     561or :REF, which returns Java null if NIL is provided.
     562
     563Deprecated.  Please use JAVA:+NULL+, JAVA:+TRUE+, and JAVA:+FALSE+ for
     564constructing wrapped primitive types, JAVA:JOBJECT-LISP-VALUE for converting a
     565JAVA:JAVA-OBJECT to a Lisp value, or JAVA:JNULL-REF-P to distinguish a wrapped
     566null JAVA-OBJECT from NIL.
     567\end{adjustwidth}
     568
     569\paragraph{}
     570\label{JAVA:JNEW-ARRAY-FROM-ARRAY}
     571\index{JNEW-ARRAY-FROM-ARRAY}
     572--- Function: \textbf{jnew-array-from-array} [\textbf{java}] \textit{element-type array}
     573
     574\begin{adjustwidth}{5em}{5em}
     575Returns a new Java array with base type ELEMENT-TYPE (a string or a class-ref)
     576   initialized from ARRAY
     577\end{adjustwidth}
     578
     579\paragraph{}
     580\label{JAVA:JOBJECT-CLASS}
     581\index{JOBJECT-CLASS}
     582--- Function: \textbf{jobject-class} [\textbf{java}] \textit{obj}
     583
     584\begin{adjustwidth}{5em}{5em}
     585Returns the Java class that OBJ belongs to
     586\end{adjustwidth}
     587
     588\paragraph{}
     589\label{JAVA:JREDEFINE-METHOD}
     590\index{JREDEFINE-METHOD}
     591--- Function: \textbf{jredefine-method} [\textbf{java}] \textit{}
     592
     593\begin{adjustwidth}{5em}{5em}
     594NOT-DOCUMENTED
     595\end{adjustwidth}
     596
     597\paragraph{}
     598\label{JAVA:JCLASS-FIELDS}
     599\index{JCLASS-FIELDS}
     600--- Function: \textbf{jclass-fields} [\textbf{java}] \textit{class \&key declared public}
     601
     602\begin{adjustwidth}{5em}{5em}
     603Returns a vector of all (or just the declared/public, if DECLARED/PUBLIC is true) fields of CLASS
     604\end{adjustwidth}
     605
     606\paragraph{}
     607\label{JAVA:JAVA-EXCEPTION}
     608\index{JAVA-EXCEPTION}
     609--- Class: \textbf{java-exception} [\textbf{java}] \textit{}
     610
     611\begin{adjustwidth}{5em}{5em}
     612NOT-DOCUMENTED
     613\end{adjustwidth}
     614
     615\paragraph{}
     616\label{JAVA:DESCRIBE-JAVA-OBJECT}
     617\index{DESCRIBE-JAVA-OBJECT}
     618--- Function: \textbf{describe-java-object} [\textbf{java}] \textit{}
     619
     620\begin{adjustwidth}{5em}{5em}
     621NOT-DOCUMENTED
     622\end{adjustwidth}
     623
     624\paragraph{}
     625\label{JAVA:JFIELD-RAW}
     626\index{JFIELD-RAW}
     627--- Function: \textbf{jfield-raw} [\textbf{java}] \textit{class-ref-or-field field-or-instance \&optional instance value}
     628
     629\begin{adjustwidth}{5em}{5em}
     630Retrieves or modifies a field in a Java class or instance. Does not
     631attempt to coerce its value or the result into a Lisp object.
     632
     633Supported argument patterns:
     634
     635   Case 1: class-ref  field-name:
     636      Retrieves the value of a static field.
     637
     638   Case 2: class-ref  field-name  instance-ref:
     639      Retrieves the value of a class field of the instance.
     640
     641   Case 3: class-ref  field-name  primitive-value:
     642      Stores a primitive-value in a static field.
     643
     644   Case 4: class-ref  field-name  instance-ref  value:
     645      Stores value in a class field of the instance.
     646
     647   Case 5: class-ref  field-name  nil  value:
     648      Stores value in a static field (when value may be
     649      confused with an instance-ref).
     650
     651   Case 6: field-name  instance:
     652      Retrieves the value of a field of the instance. The
     653      class is derived from the instance.
     654
     655   Case 7: field-name  instance  value:
     656      Stores value in a field of the instance. The class is
     657      derived from the instance.
     658
     659\end{adjustwidth}
     660
     661\paragraph{}
     662\label{JAVA:JCONSTRUCTOR-PARAMS}
     663\index{JCONSTRUCTOR-PARAMS}
     664--- Function: \textbf{jconstructor-params} [\textbf{java}] \textit{constructor}
     665
     666\begin{adjustwidth}{5em}{5em}
     667Returns a vector of parameter types (Java classes) for CONSTRUCTOR
     668\end{adjustwidth}
     669
     670\paragraph{}
     671\label{JAVA:JMEMBER-STATIC-P}
     672\index{JMEMBER-STATIC-P}
     673--- Function: \textbf{jmember-static-p} [\textbf{java}] \textit{member}
     674
     675\begin{adjustwidth}{5em}{5em}
     676MEMBER is a static member of its declaring class
     677\end{adjustwidth}
     678
     679\paragraph{}
     680\label{JAVA:JCOERCE}
     681\index{JCOERCE}
     682--- Function: \textbf{jcoerce} [\textbf{java}] \textit{object intended-class}
     683
     684\begin{adjustwidth}{5em}{5em}
     685Attempts to coerce OBJECT into a JavaObject of class INTENDED-CLASS.  Raises a TYPE-ERROR if no conversion is possible.
     686\end{adjustwidth}
     687
     688\paragraph{}
     689\label{JAVA:JCONSTRUCTOR}
     690\index{JCONSTRUCTOR}
     691--- Function: \textbf{jconstructor} [\textbf{java}] \textit{class-ref \&rest parameter-class-refs}
     692
     693\begin{adjustwidth}{5em}{5em}
     694Returns a reference to the Java constructor of CLASS-REF with the given PARAMETER-CLASS-REFS.
     695\end{adjustwidth}
     696
     697\paragraph{}
     698\label{JAVA:JARRAY-SET}
     699\index{JARRAY-SET}
     700--- Function: \textbf{jarray-set} [\textbf{java}] \textit{java-array new-value \&rest indices}
     701
     702\begin{adjustwidth}{5em}{5em}
     703Stores NEW-VALUE at the given index in JAVA-ARRAY.
     704\end{adjustwidth}
     705
     706\paragraph{}
     707\label{JAVA:JARRAY-LENGTH}
     708\index{JARRAY-LENGTH}
     709--- Function: \textbf{jarray-length} [\textbf{java}] \textit{java-array}
     710
     711\begin{adjustwidth}{5em}{5em}
     712NOT-DOCUMENTED
     713\end{adjustwidth}
     714
     715\paragraph{}
     716\label{JAVA:JARRAY-REF}
     717\index{JARRAY-REF}
     718--- Function: \textbf{jarray-ref} [\textbf{java}] \textit{java-array \&rest indices}
     719
     720\begin{adjustwidth}{5em}{5em}
     721Dereferences the Java array JAVA-ARRAY using the given INDICIES, coercing the result into a Lisp object, if possible.
     722\end{adjustwidth}
     723
     724\paragraph{}
     725\label{JAVA:JCLASS-FIELD}
     726\index{JCLASS-FIELD}
     727--- Function: \textbf{jclass-field} [\textbf{java}] \textit{class field-name}
     728
     729\begin{adjustwidth}{5em}{5em}
     730Returns the field named FIELD-NAME of CLASS
     731\end{adjustwidth}
     732
     733\paragraph{}
     734\label{JAVA:JMAKE-PROXY}
     735\index{JMAKE-PROXY}
     736--- Generic Function: \textbf{jmake-proxy} [\textbf{java}] \textit{}
     737
     738\begin{adjustwidth}{5em}{5em}
     739NOT-DOCUMENTED
     740\end{adjustwidth}
     741
     742\paragraph{}
     743\label{JAVA:JCALL-RAW}
     744\index{JCALL-RAW}
     745--- Function: \textbf{jcall-raw} [\textbf{java}] \textit{method-ref instance \&rest args}
     746
     747\begin{adjustwidth}{5em}{5em}
     748Invokes the Java method METHOD-REF on INSTANCE with arguments ARGS. Does not attempt to coerce the result into a Lisp object.
     749\end{adjustwidth}
     750
     751\paragraph{}
     752\label{JAVA:+FALSE+}
     753\index{+FALSE+}
     754--- Variable: \textbf{+false+} [\textbf{java}] \textit{}
     755
     756\begin{adjustwidth}{5em}{5em}
     757The JVM primitive value for boolean false.
     758\end{adjustwidth}
     759
     760\paragraph{}
     761\label{JAVA:JCLASS-INTERFACE-P}
     762\index{JCLASS-INTERFACE-P}
     763--- Function: \textbf{jclass-interface-p} [\textbf{java}] \textit{class}
     764
     765\begin{adjustwidth}{5em}{5em}
     766Returns T if CLASS is an interface
     767\end{adjustwidth}
     768
  • trunk/abcl/doc/manual/threads.tex

    r13437 r13690  
    1 \begin{verbatim}
    2 THREADS:CURRENT-THREAD
    3   Function: (not documented)
    4 THREADS:DESTROY-THREAD
    5   Function: (not documented)
    6 THREADS:GET-MUTEX
    7   Function: Acquires a lock on the `mutex'.
    8 THREADS:INTERRUPT-THREAD
    9   Function: Interrupts THREAD and forces it to apply FUNCTION to ARGS.
    10 THREADS:MAILBOX-EMPTY-P
    11   Function: Returns non-NIL if the mailbox can be read from, NIL otherwise.
    12 THREADS:MAILBOX-PEEK
    13   Function: Returns two values. The second returns non-NIL when the mailbox
    14 THREADS:MAILBOX-READ
    15   Function: Blocks on the mailbox until an item is available for reading.
    16 THREADS:MAILBOX-SEND
    17   Function: Sends an item into the mailbox, notifying 1 waiter
    18 THREADS:MAKE-MAILBOX
    19   Function: (not documented)
    20 THREADS:MAKE-MUTEX
    21   Function: (not documented)
    22 THREADS:MAKE-THREAD
    23   Function: (not documented)
    24 THREADS:MAKE-THREAD-LOCK
    25   Function: Returns an object to be used with the `with-thread-lock' macro.
    26 THREADS:MAPCAR-THREADS
    27   Function: (not documented)
    28 THREADS:OBJECT-NOTIFY
    29   Function: (not documented)
    30 THREADS:OBJECT-NOTIFY-ALL
    31   Function: (not documented)
    32 THREADS:OBJECT-WAIT
    33   Function: (not documented)
    34 THREADS:RELEASE-MUTEX
    35   Function: Releases a lock on the `mutex'.
    36 THREADS:SYNCHRONIZED-ON
    37   Function: (not documented)
    38 THREADS:THREAD
    39   Class: (not documented)
    40 THREADS:THREAD-ALIVE-P
    41   Function: Boolean predicate whether THREAD is alive.
    42 THREADS:THREAD-JOIN
    43   Function: Waits for thread to finish.
    44 THREADS:THREAD-NAME
    45   Function: (not documented)
    46 THREADS:THREADP
    47   Function: (not documented)
    48 THREADS:WITH-MUTEX
    49   Function: (not documented)
    50 THREADS:WITH-THREAD-LOCK
    51   Function: (not documented)
    52 \end{verbatim}
     1\subsection{Exported Symbols from the THREADS package}
     2
     3\paragraph{}
     4\label{THREADS:MAILBOX-EMPTY-P}
     5\index{MAILBOX-EMPTY-P}
     6--- Function: \textbf{mailbox-empty-p} [\textbf{threads}] \textit{mailbox}
     7
     8\begin{adjustwidth}{5em}{5em}
     9Returns non-NIL if the mailbox can be read from, NIL otherwise.
     10\end{adjustwidth}
     11
     12\paragraph{}
     13\label{THREADS:THREADP}
     14\index{THREADP}
     15--- Function: \textbf{threadp} [\textbf{threads}] \textit{}
     16
     17\begin{adjustwidth}{5em}{5em}
     18NOT-DOCUMENTED
     19\end{adjustwidth}
     20
     21\paragraph{}
     22\label{THREADS:DESTROY-THREAD}
     23\index{DESTROY-THREAD}
     24--- Function: \textbf{destroy-thread} [\textbf{threads}] \textit{}
     25
     26\begin{adjustwidth}{5em}{5em}
     27NOT-DOCUMENTED
     28\end{adjustwidth}
     29
     30\paragraph{}
     31\label{THREADS:WITH-MUTEX}
     32\index{WITH-MUTEX}
     33--- Macro: \textbf{with-mutex} [\textbf{threads}] \textit{}
     34
     35\begin{adjustwidth}{5em}{5em}
     36NOT-DOCUMENTED
     37\end{adjustwidth}
     38
     39\paragraph{}
     40\label{THREADS:THREAD-JOIN}
     41\index{THREAD-JOIN}
     42--- Function: \textbf{thread-join} [\textbf{threads}] \textit{thread}
     43
     44\begin{adjustwidth}{5em}{5em}
     45Waits for thread to finish.
     46\end{adjustwidth}
     47
     48\paragraph{}
     49\label{THREADS:RELEASE-MUTEX}
     50\index{RELEASE-MUTEX}
     51--- Function: \textbf{release-mutex} [\textbf{threads}] \textit{mutex}
     52
     53\begin{adjustwidth}{5em}{5em}
     54Releases a lock on the `mutex'.
     55\end{adjustwidth}
     56
     57\paragraph{}
     58\label{THREADS:OBJECT-WAIT}
     59\index{OBJECT-WAIT}
     60--- Function: \textbf{object-wait} [\textbf{threads}] \textit{}
     61
     62\begin{adjustwidth}{5em}{5em}
     63NOT-DOCUMENTED
     64\end{adjustwidth}
     65
     66\paragraph{}
     67\label{THREADS:MAKE-THREAD}
     68\index{MAKE-THREAD}
     69--- Function: \textbf{make-thread} [\textbf{threads}] \textit{function \&key name}
     70
     71\begin{adjustwidth}{5em}{5em}
     72NOT-DOCUMENTED
     73\end{adjustwidth}
     74
     75\paragraph{}
     76\label{THREADS:MAKE-THREAD-LOCK}
     77\index{MAKE-THREAD-LOCK}
     78--- Function: \textbf{make-thread-lock} [\textbf{threads}] \textit{}
     79
     80\begin{adjustwidth}{5em}{5em}
     81Returns an object to be used with the `with-thread-lock' macro.
     82\end{adjustwidth}
     83
     84\paragraph{}
     85\label{THREADS:OBJECT-NOTIFY-ALL}
     86\index{OBJECT-NOTIFY-ALL}
     87--- Function: \textbf{object-notify-all} [\textbf{threads}] \textit{}
     88
     89\begin{adjustwidth}{5em}{5em}
     90NOT-DOCUMENTED
     91\end{adjustwidth}
     92
     93\paragraph{}
     94\label{THREADS:MAKE-MAILBOX}
     95\index{MAKE-MAILBOX}
     96--- Function: \textbf{make-mailbox} [\textbf{threads}] \textit{}
     97
     98\begin{adjustwidth}{5em}{5em}
     99NOT-DOCUMENTED
     100\end{adjustwidth}
     101
     102\paragraph{}
     103\label{THREADS:OBJECT-NOTIFY}
     104\index{OBJECT-NOTIFY}
     105--- Function: \textbf{object-notify} [\textbf{threads}] \textit{object}
     106
     107\begin{adjustwidth}{5em}{5em}
     108NOT-DOCUMENTED
     109\end{adjustwidth}
     110
     111\paragraph{}
     112\label{THREADS:GET-MUTEX}
     113\index{GET-MUTEX}
     114--- Function: \textbf{get-mutex} [\textbf{threads}] \textit{mutex}
     115
     116\begin{adjustwidth}{5em}{5em}
     117Acquires a lock on the `mutex'.
     118\end{adjustwidth}
     119
     120\paragraph{}
     121\label{THREADS:MAILBOX-PEEK}
     122\index{MAILBOX-PEEK}
     123--- Function: \textbf{mailbox-peek} [\textbf{threads}] \textit{mailbox}
     124
     125\begin{adjustwidth}{5em}{5em}
     126Returns two values. The second returns non-NIL when the mailbox
     127is empty. The first is the next item to be read from the mailbox
     128if the first is NIL.
     129
     130Note that due to multi-threading, the first value returned upon
     131peek, may be different from the one returned upon next read in the
     132calling thread.
     133\end{adjustwidth}
     134
     135\paragraph{}
     136\label{THREADS:THREAD-ALIVE-P}
     137\index{THREAD-ALIVE-P}
     138--- Function: \textbf{thread-alive-p} [\textbf{threads}] \textit{thread}
     139
     140\begin{adjustwidth}{5em}{5em}
     141Boolean predicate whether THREAD is alive.
     142\end{adjustwidth}
     143
     144\paragraph{}
     145\label{THREADS:MAILBOX-READ}
     146\index{MAILBOX-READ}
     147--- Function: \textbf{mailbox-read} [\textbf{threads}] \textit{mailbox}
     148
     149\begin{adjustwidth}{5em}{5em}
     150Blocks on the mailbox until an item is available for reading.
     151When an item is available, it is returned.
     152\end{adjustwidth}
     153
     154\paragraph{}
     155\label{THREADS:SYNCHRONIZED-ON}
     156\index{SYNCHRONIZED-ON}
     157--- NIL: \textbf{synchronized-on} [\textbf{threads}] \textit{}
     158
     159\begin{adjustwidth}{5em}{5em}
     160\end{adjustwidth}
     161
     162\paragraph{}
     163\label{THREADS:INTERRUPT-THREAD}
     164\index{INTERRUPT-THREAD}
     165--- Function: \textbf{interrupt-thread} [\textbf{threads}] \textit{thread function \&rest args}
     166
     167\begin{adjustwidth}{5em}{5em}
     168Interrupts THREAD and forces it to apply FUNCTION to ARGS.
     169When the function returns, the thread's original computation continues. If  multiple interrupts are queued for a thread, they are all run, but the order is not guaranteed.
     170\end{adjustwidth}
     171
     172\paragraph{}
     173\label{THREADS:MAKE-MUTEX}
     174\index{MAKE-MUTEX}
     175--- Function: \textbf{make-mutex} [\textbf{threads}] \textit{}
     176
     177\begin{adjustwidth}{5em}{5em}
     178NOT-DOCUMENTED
     179\end{adjustwidth}
     180
     181\paragraph{}
     182\label{THREADS:THREAD}
     183\index{THREAD}
     184--- Class: \textbf{thread} [\textbf{threads}] \textit{}
     185
     186\begin{adjustwidth}{5em}{5em}
     187NOT-DOCUMENTED
     188\end{adjustwidth}
     189
     190\paragraph{}
     191\label{THREADS:WITH-THREAD-LOCK}
     192\index{WITH-THREAD-LOCK}
     193--- Macro: \textbf{with-thread-lock} [\textbf{threads}] \textit{}
     194
     195\begin{adjustwidth}{5em}{5em}
     196NOT-DOCUMENTED
     197\end{adjustwidth}
     198
     199\paragraph{}
     200\label{THREADS:MAILBOX-SEND}
     201\index{MAILBOX-SEND}
     202--- Function: \textbf{mailbox-send} [\textbf{threads}] \textit{mailbox item}
     203
     204\begin{adjustwidth}{5em}{5em}
     205Sends an item into the mailbox, notifying 1 waiter
     206to wake up for retrieval of that object.
     207\end{adjustwidth}
     208
     209\paragraph{}
     210\label{THREADS:THREAD-NAME}
     211\index{THREAD-NAME}
     212--- Function: \textbf{thread-name} [\textbf{threads}] \textit{}
     213
     214\begin{adjustwidth}{5em}{5em}
     215NOT-DOCUMENTED
     216\end{adjustwidth}
     217
     218\paragraph{}
     219\label{THREADS:CURRENT-THREAD}
     220\index{CURRENT-THREAD}
     221--- Function: \textbf{current-thread} [\textbf{threads}] \textit{}
     222
     223\begin{adjustwidth}{5em}{5em}
     224NOT-DOCUMENTED
     225\end{adjustwidth}
     226
     227\paragraph{}
     228\label{THREADS:MAPCAR-THREADS}
     229\index{MAPCAR-THREADS}
     230--- Function: \textbf{mapcar-threads} [\textbf{threads}] \textit{}
     231
     232\begin{adjustwidth}{5em}{5em}
     233NOT-DOCUMENTED
     234\end{adjustwidth}
     235
Note: See TracChangeset for help on using the changeset viewer.