Changeset 14266
- Timestamp:
- 12/01/12 20:57:24 (8 years ago)
- Location:
- branches/1.1.x/doc/manual
- Files:
-
- 4 edited
Legend:
- Unmodified
- Added
- Removed
-
branches/1.1.x/doc/manual/Makefile
r13858 r14266 9 9 pdflatex abcl.tex 10 10 11 ABCL = /Users/evenson/work/abcl-1.1.x/abcl 12 11 13 grovel: 12 abcl--batch --noinform --load "grovel.lisp" --eval '(progn (grovel-docstrings-as-tex (find-package :java)) (grovel-docstrings-as-tex (find-package :extensions)) (grovel-docstrings-as-tex (find-package :threads)))'14 $(ABCL) --batch --noinform --load "grovel.lisp" --eval '(progn (grovel-docstrings-as-tex (find-package :java)) (grovel-docstrings-as-tex (find-package :extensions)) (grovel-docstrings-as-tex (find-package :threads)))' 13 15 14 16 clean: -
branches/1.1.x/doc/manual/extensions.tex
r13866 r14266 1 \paragraph{}2 \label{EXTENSIONS:COMPILE-FILE-IF-NEEDED}3 \index{COMPILE-FILE-IF-NEEDED}4 --- Function: \textbf{compile-file-if-needed} [\textbf{extensions}] \textit{input-file \&rest allargs \&key force-compile \&allow-other-keys}5 6 \begin{adjustwidth}{5em}{5em}7 not-documented8 \end{adjustwidth}9 10 1 \paragraph{} 11 2 \label{EXTENSIONS:MOST-POSITIVE-JAVA-LONG} … … 45 36 46 37 \paragraph{} 47 \label{EXTENSIONS:GROVEL-JAVA-DEFINITIONS}48 \index{GROVEL-JAVA-DEFINITIONS}49 --- Function: \textbf{grovel-java-definitions} [\textbf{extensions}] \textit{}50 51 \begin{adjustwidth}{5em}{5em}52 not-documented53 \end{adjustwidth}54 55 \paragraph{}56 38 \label{EXTENSIONS:*AUTOLOAD-VERBOSE*} 57 39 \index{*AUTOLOAD-VERBOSE*} … … 81 63 82 64 \paragraph{} 83 \label{EXTENSIONS:PROCESS-KILL}84 \index{PROCESS-KILL}85 --- Function: \textbf{process-kill} [\textbf{extensions}] \textit{process}86 87 \begin{adjustwidth}{5em}{5em}88 Kills the process.89 \end{adjustwidth}90 91 \paragraph{}92 65 \label{EXTENSIONS:NIL-VECTOR} 93 66 \index{NIL-VECTOR} … … 153 126 154 127 \paragraph{} 128 \label{EXTENSIONS:WRITE-TIMEOUT} 129 \index{WRITE-TIMEOUT} 130 --- Function: \textbf{write-timeout} [\textbf{extensions}] \textit{socket seconds} 131 132 \begin{adjustwidth}{5em}{5em} 133 not-documented 134 \end{adjustwidth} 135 136 \paragraph{} 155 137 \label{EXTENSIONS:CDR} 156 138 \index{CDR} … … 176 158 177 159 \begin{adjustwidth}{5em}{5em} 178 not-documented 160 Create a TCP socket for client communication to HOST on PORT. 179 161 \end{adjustwidth} 180 162 … … 189 171 190 172 \paragraph{} 191 \label{EXTENSIONS:PROCESS-INPUT}192 \index{PROCESS-INPUT}193 --- Function: \textbf{process-input} [\textbf{extensions}] \textit{}194 195 \begin{adjustwidth}{5em}{5em}196 not-documented197 \end{adjustwidth}198 199 \paragraph{}200 173 \label{EXTENSIONS:MAILBOX} 201 174 \index{MAILBOX} … … 234 207 235 208 \paragraph{} 236 \label{EXTENSIONS:PROCESS}237 \index{PROCESS}238 --- Class: \textbf{process} [\textbf{extensions}] \textit{}239 240 \begin{adjustwidth}{5em}{5em}241 not-documented242 \end{adjustwidth}243 244 \paragraph{}245 209 \label{EXTENSIONS:CADDR} 246 210 \index{CADDR} … … 252 216 253 217 \paragraph{} 254 \label{EXTENSIONS:SIMPLE-SEARCH}255 \index{SIMPLE-SEARCH}256 --- Function: \textbf{simple-search} [\textbf{extensions}] \textit{sequence1 sequence2}257 258 \begin{adjustwidth}{5em}{5em}259 not-documented260 \end{adjustwidth}261 262 \paragraph{}263 218 \label{EXTENSIONS:*LISP-HOME*} 264 219 \index{*LISP-HOME*} … … 297 252 298 253 \paragraph{} 254 \label{EXTENSIONS:*DISASSEMBLER*} 255 \index{*DISASSEMBLER*} 256 --- Variable: \textbf{*disassembler*} [\textbf{extensions}] \textit{} 257 258 \begin{adjustwidth}{5em}{5em} 259 not-documented 260 \end{adjustwidth} 261 262 \paragraph{} 299 263 \label{EXTENSIONS:CLASSP} 300 264 \index{CLASSP} … … 306 270 307 271 \paragraph{} 308 \label{EXTENSIONS: *DISASSEMBLER*}309 \index{ *DISASSEMBLER*}310 --- Variable: \textbf{*disassembler*} [\textbf{extensions}] \textit{}311 312 \begin{adjustwidth}{5em}{5em} 313 not-documented 272 \label{EXTENSIONS:MAKE-TEMP-DIRECTORY} 273 \index{MAKE-TEMP-DIRECTORY} 274 --- Function: \textbf{make-temp-directory} [\textbf{extensions}] \textit{} 275 276 \begin{adjustwidth}{5em}{5em} 277 Create and return the pathname of a previously non-existent directory. 314 278 \end{adjustwidth} 315 279 … … 342 306 343 307 \paragraph{} 344 \label{EXTENSIONS:PROCESS-ERROR}345 \index{PROCESS-ERROR}346 --- Function: \textbf{process-error} [\textbf{extensions}] \textit{}347 348 \begin{adjustwidth}{5em}{5em}349 not-documented350 \end{adjustwidth}351 352 \paragraph{}353 308 \label{EXTENSIONS:SOCKET-LOCAL-PORT} 354 309 \index{SOCKET-LOCAL-PORT} … … 356 311 357 312 \begin{adjustwidth}{5em}{5em} 358 Returns the local port number of the given socket. 359 \end{adjustwidth} 360 361 \paragraph{} 362 \label{EXTENSIONS:PROCESS-ALIVE-P} 363 \index{PROCESS-ALIVE-P} 364 --- Function: \textbf{process-alive-p} [\textbf{extensions}] \textit{process} 365 366 \begin{adjustwidth}{5em}{5em} 367 Return t if process is still alive, nil otherwise. 313 Returns the local port number of the SOCKET. 368 314 \end{adjustwidth} 369 315 … … 446 392 447 393 \begin{adjustwidth}{5em}{5em} 394 Close the client SOCKET. 395 \end{adjustwidth} 396 397 \paragraph{} 398 \label{EXTENSIONS:*ED-FUNCTIONS*} 399 \index{*ED-FUNCTIONS*} 400 --- Variable: \textbf{*ed-functions*} [\textbf{extensions}] \textit{} 401 402 \begin{adjustwidth}{5em}{5em} 403 not-documented 404 \end{adjustwidth} 405 406 \paragraph{} 407 \label{EXTENSIONS:SPECIAL-VARIABLE-P} 408 \index{SPECIAL-VARIABLE-P} 409 --- Function: \textbf{special-variable-p} [\textbf{extensions}] \textit{} 410 411 \begin{adjustwidth}{5em}{5em} 412 not-documented 413 \end{adjustwidth} 414 415 \paragraph{} 416 \label{EXTENSIONS:RESOLVE} 417 \index{RESOLVE} 418 --- Function: \textbf{resolve} [\textbf{extensions}] \textit{symbol} 419 420 \begin{adjustwidth}{5em}{5em} 421 not-documented 422 \end{adjustwidth} 423 424 \paragraph{} 425 \label{EXTENSIONS:CANCEL-FINALIZATION} 426 \index{CANCEL-FINALIZATION} 427 --- Function: \textbf{cancel-finalization} [\textbf{extensions}] \textit{object} 428 429 \begin{adjustwidth}{5em}{5em} 448 430 not-documented 449 431 \end{adjustwidth} … … 459 441 460 442 \paragraph{} 461 \label{EXTENSIONS:*ED-FUNCTIONS*}462 \index{*ED-FUNCTIONS*}463 --- Variable: \textbf{*ed-functions*} [\textbf{extensions}] \textit{}464 465 \begin{adjustwidth}{5em}{5em}466 not-documented467 \end{adjustwidth}468 469 \paragraph{}470 443 \label{EXTENSIONS:COMPILE-SYSTEM} 471 444 \index{COMPILE-SYSTEM} 472 --- Function: \textbf{compile-system} [\textbf{extensions}] \textit{\&key quit (zip t) output-path}445 --- Function: \textbf{compile-system} [\textbf{extensions}] \textit{\&key quit (zip t) (cls-ext *compile-file-class-extension*) (abcl-ext *compile-file-type*) output-path} 473 446 474 447 \begin{adjustwidth}{5em}{5em} … … 486 459 487 460 \paragraph{} 488 \label{EXTENSIONS:SPECIAL-VARIABLE-P}489 \index{SPECIAL-VARIABLE-P}490 --- Function: \textbf{special-variable-p} [\textbf{extensions}] \textit{}491 492 \begin{adjustwidth}{5em}{5em}493 not-documented494 \end{adjustwidth}495 496 \paragraph{}497 461 \label{EXTENSIONS:SOCKET-ACCEPT} 498 462 \index{SOCKET-ACCEPT} … … 500 464 501 465 \begin{adjustwidth}{5em}{5em} 502 not-documented 466 Block until able to return a new socket for handling a incoming request to the specified server SOCKET. 503 467 \end{adjustwidth} 504 468 … … 540 504 541 505 \paragraph{} 542 \label{EXTENSIONS:RESOLVE}543 \index{RESOLVE}544 --- Function: \textbf{resolve} [\textbf{extensions}] \textit{symbol}545 546 \begin{adjustwidth}{5em}{5em}547 not-documented548 \end{adjustwidth}549 550 \paragraph{}551 \label{EXTENSIONS:CANCEL-FINALIZATION}552 \index{CANCEL-FINALIZATION}553 --- Function: \textbf{cancel-finalization} [\textbf{extensions}] \textit{object}554 555 \begin{adjustwidth}{5em}{5em}556 not-documented557 \end{adjustwidth}558 559 \paragraph{}560 506 \label{EXTENSIONS:MAKE-SLIME-OUTPUT-STREAM} 561 507 \index{MAKE-SLIME-OUTPUT-STREAM} … … 567 513 568 514 \paragraph{} 569 \label{EXTENSIONS:RUN-PROGRAM}570 \index{RUN-PROGRAM}571 --- Function: \textbf{run-program} [\textbf{extensions}] \textit{program args \&key environment (wait t)}572 573 \begin{adjustwidth}{5em}{5em}574 Creates a new process running the the PROGRAM.575 ARGS are a list of strings to be passed to the program as arguments.576 577 For no arguments, use nil which means that just the name of the578 program is passed as arg 0.579 580 Returns a process structure containing the JAVA-OBJECT wrapped Process581 object, and the PROCESS-INPUT, PROCESS-OUTPUT, and PROCESS-ERROR streams.582 583 c.f. http://download.oracle.com/javase/6/docs/api/java/lang/Process.html584 585 Notes about Unix environments (as in the :environment):586 587 * The ABCL implementation of run-program, like SBCL, Perl and many588 other programs, copies the Unix environment by default.589 590 * Running Unix programs from a setuid process, or in any other591 situation where the Unix environment is under the control of592 someone else, is a mother lode of security problems. If you are593 contemplating doing this, read about it first. (The Perl594 community has a lot of good documentation about this and other595 security issues in script-like programs.)596 597 The \&key arguments have the following meanings:598 599 :environment600 An alist of STRINGs (name . value) describing the new601 environment. The default is to copy the environment of the current602 process.603 604 :wait605 If non-NIL, which is the default, wait until the created process606 finishes. If NIL, continue running Lisp until the program607 finishes.608 \end{adjustwidth}609 610 \paragraph{}611 515 \label{EXTENSIONS:FIXNUMP} 612 516 \index{FIXNUMP} … … 636 540 637 541 \paragraph{} 638 \label{EXTENSIONS:INTERNAL-COMPILER-ERROR}639 \index{INTERNAL-COMPILER-ERROR}640 --- Function: \textbf{internal-compiler-error} [\textbf{extensions}] \textit{format-control \&rest format-arguments}641 642 \begin{adjustwidth}{5em}{5em}643 not-documented644 \end{adjustwidth}645 646 \paragraph{}647 542 \label{EXTENSIONS:JAR-PATHNAME} 648 543 \index{JAR-PATHNAME} … … 653 548 \end{adjustwidth} 654 549 550 \paragraph{} 551 \label{EXTENSIONS:ASSQL} 552 \index{ASSQL} 553 --- Function: \textbf{assql} [\textbf{extensions}] \textit{} 554 555 \begin{adjustwidth}{5em}{5em} 556 not-documented 557 \end{adjustwidth} 558 559 \paragraph{} 560 \label{EXTENSIONS:FINALIZE} 561 \index{FINALIZE} 562 --- Function: \textbf{finalize} [\textbf{extensions}] \textit{object function} 563 564 \begin{adjustwidth}{5em}{5em} 565 not-documented 566 \end{adjustwidth} 567 568 \paragraph{} 569 \label{EXTENSIONS:CAR} 570 \index{CAR} 571 --- Macro: \textbf{\%car} [\textbf{extensions}] \textit{} 572 573 \begin{adjustwidth}{5em}{5em} 574 not-documented 575 \end{adjustwidth} 576 655 577 NIL 656 578 … … 665 587 666 588 \paragraph{} 667 \label{EXTENSIONS:ASSQL}668 \index{ASSQL}669 --- Function: \textbf{assql} [\textbf{extensions}] \textit{}670 671 \begin{adjustwidth}{5em}{5em}672 not-documented673 \end{adjustwidth}674 675 \paragraph{}676 \label{EXTENSIONS:FINALIZE}677 \index{FINALIZE}678 --- Function: \textbf{finalize} [\textbf{extensions}] \textit{object function}679 680 \begin{adjustwidth}{5em}{5em}681 not-documented682 \end{adjustwidth}683 684 \paragraph{}685 589 \label{EXTENSIONS:RUN-SHELL-COMMAND} 686 590 \index{RUN-SHELL-COMMAND} … … 701 605 702 606 \paragraph{} 703 \label{EXTENSIONS:CAR}704 \index{CAR}705 --- Macro: \textbf{\%car} [\textbf{extensions}] \textit{}706 707 \begin{adjustwidth}{5em}{5em}708 not-documented709 \end{adjustwidth}710 711 \paragraph{}712 607 \label{EXTENSIONS:COLLECT} 713 608 \index{COLLECT} … … 751 646 752 647 \begin{adjustwidth}{5em}{5em} 753 not-documented 754 \end{adjustwidth} 755 756 \paragraph{} 757 \label{EXTENSIONS:DESCRIBE-COMPILER-POLICY} 758 \index{DESCRIBE-COMPILER-POLICY} 759 --- Function: \textbf{describe-compiler-policy} [\textbf{extensions}] \textit{} 760 761 \begin{adjustwidth}{5em}{5em} 762 not-documented 648 Create and return the pathname of a previously non-existent file. 763 649 \end{adjustwidth} 764 650 … … 778 664 779 665 \begin{adjustwidth}{5em}{5em} 780 Returns the peer address of the given socketas a dotted quad string.666 Returns the peer address of the SOCKET as a dotted quad string. 781 667 \end{adjustwidth} 782 668 … … 805 691 806 692 \begin{adjustwidth}{5em}{5em} 807 not-documented 693 Close the server SOCKET. 808 694 \end{adjustwidth} 809 695 … … 886 772 887 773 \begin{adjustwidth}{5em}{5em} 888 not-documented 774 Create a TCP server socket listening for clients on PORT. 889 775 \end{adjustwidth} 890 776 … … 899 785 900 786 \paragraph{} 901 \label{EXTENSIONS:AVER}902 \index{AVER}903 --- Macro: \textbf{aver} [\textbf{extensions}] \textit{}904 905 \begin{adjustwidth}{5em}{5em}906 not-documented907 \end{adjustwidth}908 909 \paragraph{}910 787 \label{EXTENSIONS:INIT-GUI} 911 788 \index{INIT-GUI} … … 926 803 927 804 \paragraph{} 928 \label{EXTENSIONS:PROCESS-EXIT-CODE}929 \index{PROCESS-EXIT-CODE}930 --- Function: \textbf{process-exit-code} [\textbf{extensions}] \textit{instance}931 932 \begin{adjustwidth}{5em}{5em}933 The exit code of a process.934 \end{adjustwidth}935 936 \paragraph{}937 805 \label{EXTENSIONS:SOURCE-FILE-POSITION} 938 806 \index{SOURCE-FILE-POSITION} … … 949 817 950 818 \begin{adjustwidth}{5em}{5em} 951 Returns the peer port number of the given socket.819 Returns the peer port number of the given SOCKET. 952 820 \end{adjustwidth} 953 821 … … 971 839 972 840 \paragraph{} 841 \label{EXTENSIONS:NEQ} 842 \index{NEQ} 843 --- Function: \textbf{neq} [\textbf{extensions}] \textit{obj1 obj2} 844 845 \begin{adjustwidth}{5em}{5em} 846 not-documented 847 \end{adjustwidth} 848 849 \paragraph{} 850 \label{EXTENSIONS:STRING-FIND} 851 \index{STRING-FIND} 852 --- Function: \textbf{string-find} [\textbf{extensions}] \textit{char string} 853 854 \begin{adjustwidth}{5em}{5em} 855 not-documented 856 \end{adjustwidth} 857 858 \paragraph{} 973 859 \label{EXTENSIONS:SOCKET-LOCAL-ADDRESS} 974 860 \index{SOCKET-LOCAL-ADDRESS} … … 976 862 977 863 \begin{adjustwidth}{5em}{5em} 978 Returns the local address of the given socket as a dotted quad string. 979 \end{adjustwidth} 980 981 \paragraph{} 982 \label{EXTENSIONS:NEQ} 983 \index{NEQ} 984 --- Function: \textbf{neq} [\textbf{extensions}] \textit{obj1 obj2} 985 986 \begin{adjustwidth}{5em}{5em} 987 not-documented 988 \end{adjustwidth} 989 990 \paragraph{} 991 \label{EXTENSIONS:STRING-FIND} 992 \index{STRING-FIND} 993 --- Function: \textbf{string-find} [\textbf{extensions}] \textit{char string} 994 995 \begin{adjustwidth}{5em}{5em} 996 not-documented 864 Returns the local address of the SOCKET as a dotted quad string. 865 \end{adjustwidth} 866 867 \paragraph{} 868 \label{EXTENSIONS:READ-TIMEOUT} 869 \index{READ-TIMEOUT} 870 --- Function: \textbf{read-timeout} [\textbf{extensions}] \textit{socket seconds} 871 872 \begin{adjustwidth}{5em}{5em} 873 Time in SECONDS to set local implementation of SO\_CREVTIMEO on SOCKET. 997 874 \end{adjustwidth} 998 875 … … 1007 884 1008 885 \paragraph{} 1009 \label{EXTENSIONS:PROCESS-WAIT}1010 \index{PROCESS-WAIT}1011 --- Function: \textbf{process-wait} [\textbf{extensions}] \textit{process}1012 1013 \begin{adjustwidth}{5em}{5em}1014 Wait for process to quit running for some reason.1015 \end{adjustwidth}1016 1017 \paragraph{}1018 886 \label{EXTENSIONS:SHOW-RESTARTS} 1019 887 \index{SHOW-RESTARTS} … … 1034 902 1035 903 \paragraph{} 1036 \label{EXTENSIONS:PROCESS-P}1037 \index{PROCESS-P}1038 --- Function: \textbf{process-p} [\textbf{extensions}] \textit{object}1039 1040 \begin{adjustwidth}{5em}{5em}1041 not-documented1042 \end{adjustwidth}1043 1044 \paragraph{}1045 904 \label{EXTENSIONS:*GUI-BACKEND*} 1046 905 \index{*GUI-BACKEND*} … … 1098 957 1099 958 \paragraph{} 1100 \label{EXTENSIONS:PROCESS-OUTPUT}1101 \index{PROCESS-OUTPUT}1102 --- Function: \textbf{process-output} [\textbf{extensions}] \textit{}1103 1104 \begin{adjustwidth}{5em}{5em}1105 not-documented1106 \end{adjustwidth}1107 1108 \paragraph{}1109 959 \label{EXTENSIONS:URL-PATHNAME} 1110 960 \index{URL-PATHNAME} … … 1116 966 1117 967 \paragraph{} 1118 \label{EXTENSIONS: COMPILER-UNSUPPORTED-FEATURE-ERROR}1119 \index{ COMPILER-UNSUPPORTED-FEATURE-ERROR}1120 --- Class: \textbf{compiler-unsupported-feature-error} [\textbf{extensions}] \textit{}1121 1122 \begin{adjustwidth}{5em}{5em} 1123 not-documented 968 \label{EXTENSIONS:GETENV-ALL} 969 \index{GETENV-ALL} 970 --- Function: \textbf{getenv-all} [\textbf{extensions}] \textit{variable} 971 972 \begin{adjustwidth}{5em}{5em} 973 Returns all environment variables as an alist containing (name . value) 1124 974 \end{adjustwidth} 1125 975 … … 1134 984 1135 985 \paragraph{} 1136 \label{EXTENSIONS:COMPILER-ERROR}1137 \index{COMPILER-ERROR}1138 --- Function: \textbf{compiler-error} [\textbf{extensions}] \textit{format-control \&rest format-arguments}1139 1140 \begin{adjustwidth}{5em}{5em}1141 not-documented1142 \end{adjustwidth}1143 1144 \paragraph{}1145 986 \label{EXTENSIONS:MACROEXPAND-ALL} 1146 987 \index{MACROEXPAND-ALL} -
branches/1.1.x/doc/manual/java.tex
r13866 r14266 115 115 116 116 \begin{adjustwidth}{5em}{5em} 117 Returns the name of the Java class of OBJECT. If the NAME argument is 118 supplied, verifies that OBJECT is an instance of the named class. The name 119 of the class or nil is always returned as a second value. 117 not-documented 120 118 \end{adjustwidth} 121 119 … … 139 137 140 138 \paragraph{} 139 \label{JAVA:GET-CURRENT-CLASSLOADER} 140 \index{GET-CURRENT-CLASSLOADER} 141 --- Function: \textbf{get-current-classloader} [\textbf{java}] \textit{} 142 143 \begin{adjustwidth}{5em}{5em} 144 not-documented 145 \end{adjustwidth} 146 147 \paragraph{} 148 \label{JAVA:JNEW-ARRAY-FROM-LIST} 149 \index{JNEW-ARRAY-FROM-LIST} 150 --- Function: \textbf{jnew-array-from-list} [\textbf{java}] \textit{element-type list} 151 152 \begin{adjustwidth}{5em}{5em} 153 Returns a new Java array with base type ELEMENT-TYPE (a string or a class-ref) 154 initialized from a Lisp list. 155 \end{adjustwidth} 156 157 \paragraph{} 158 \label{JAVA:JMETHOD} 159 \index{JMETHOD} 160 --- Function: \textbf{jmethod} [\textbf{java}] \textit{class-ref method-name \&rest parameter-class-refs} 161 162 \begin{adjustwidth}{5em}{5em} 163 Returns a reference to the Java method METHOD-NAME of CLASS-REF with the given PARAMETER-CLASS-REFS. 164 \end{adjustwidth} 165 166 \paragraph{} 141 167 \label{JAVA:GET-DEFAULT-CLASSLOADER} 142 168 \index{GET-DEFAULT-CLASSLOADER} … … 157 183 158 184 \paragraph{} 159 \label{JAVA:GET-CURRENT-CLASSLOADER}160 \index{GET-CURRENT-CLASSLOADER}161 --- Function: \textbf{get-current-classloader} [\textbf{java}] \textit{}162 163 \begin{adjustwidth}{5em}{5em}164 not-documented165 \end{adjustwidth}166 167 \paragraph{}168 185 \label{JAVA:REGISTER-JAVA-EXCEPTION} 169 186 \index{REGISTER-JAVA-EXCEPTION} … … 184 201 185 202 \paragraph{} 186 \label{JAVA:JNEW-ARRAY-FROM-LIST}187 \index{JNEW-ARRAY-FROM-LIST}188 --- Function: \textbf{jnew-array-from-list} [\textbf{java}] \textit{element-type list}189 190 \begin{adjustwidth}{5em}{5em}191 not-documented192 \end{adjustwidth}193 194 \paragraph{}195 \label{JAVA:JMETHOD}196 \index{JMETHOD}197 --- Function: \textbf{jmethod} [\textbf{java}] \textit{class-ref method-name \&rest parameter-class-refs}198 199 \begin{adjustwidth}{5em}{5em}200 Returns a reference to the Java method METHOD-NAME of CLASS-REF with the given PARAMETER-CLASS-REFS.201 \end{adjustwidth}202 203 \paragraph{}204 203 \label{JAVA:JPROPERTY-VALUE} 205 204 \index{JPROPERTY-VALUE} 206 --- Function: \textbf{jproperty-value} [\textbf{java}] \textit{obj prop}207 208 \begin{adjustwidth}{5em}{5em} 209 not-documented 205 --- Function: \textbf{jproperty-value} [\textbf{java}] \textit{object property} 206 207 \begin{adjustwidth}{5em}{5em} 208 setf-able access on the Java Beans notion of property named PROPETRY on OBJECT. 210 209 \end{adjustwidth} 211 210 … … 217 216 \begin{adjustwidth}{5em}{5em} 218 217 Returns the type (Java class) of FIELD 218 \end{adjustwidth} 219 220 \paragraph{} 221 \label{JAVA:JCLASS-CONSTRUCTORS} 222 \index{JCLASS-CONSTRUCTORS} 223 --- Function: \textbf{jclass-constructors} [\textbf{java}] \textit{class} 224 225 \begin{adjustwidth}{5em}{5em} 226 Returns a vector of constructors for CLASS 219 227 \end{adjustwidth} 220 228 … … 252 260 253 261 \paragraph{} 254 \label{JAVA:JCLASS-CONSTRUCTORS}255 \index{JCLASS-CONSTRUCTORS}256 --- Function: \textbf{jclass-constructors} [\textbf{java}] \textit{class}257 258 \begin{adjustwidth}{5em}{5em}259 Returns a vector of constructors for CLASS260 \end{adjustwidth}261 262 \paragraph{}263 262 \label{JAVA:JSTATIC} 264 263 \index{JSTATIC} … … 279 278 280 279 \paragraph{} 280 \label{JAVA:JREGISTER-HANDLER} 281 \index{JREGISTER-HANDLER} 282 --- Function: \textbf{jregister-handler} [\textbf{java}] \textit{object event handler \&key data count} 283 284 \begin{adjustwidth}{5em}{5em} 285 not-documented 286 \end{adjustwidth} 287 288 \paragraph{} 289 \label{JAVA:JCLASS-SUPERCLASS} 290 \index{JCLASS-SUPERCLASS} 291 --- Function: \textbf{jclass-superclass} [\textbf{java}] \textit{class} 292 293 \begin{adjustwidth}{5em}{5em} 294 Returns the superclass of CLASS, or NIL if it hasn't got one 295 \end{adjustwidth} 296 297 \paragraph{} 298 \label{JAVA:JAVA-OBJECT-P} 299 \index{JAVA-OBJECT-P} 300 --- Function: \textbf{java-object-p} [\textbf{java}] \textit{object} 301 302 \begin{adjustwidth}{5em}{5em} 303 Returns T if OBJECT is a JAVA-OBJECT. 304 \end{adjustwidth} 305 306 \paragraph{} 307 \label{JAVA:JINPUT-STREAM} 308 \index{JINPUT-STREAM} 309 --- Function: \textbf{jinput-stream} [\textbf{java}] \textit{pathname} 310 311 \begin{adjustwidth}{5em}{5em} 312 Returns a java.io.InputStream for resource denoted by PATHNAME. 313 \end{adjustwidth} 314 315 \paragraph{} 316 \label{JAVA:UNREGISTER-JAVA-EXCEPTION} 317 \index{UNREGISTER-JAVA-EXCEPTION} 318 --- Function: \textbf{unregister-java-exception} [\textbf{java}] \textit{exception-name} 319 320 \begin{adjustwidth}{5em}{5em} 321 Unregisters the Java Throwable EXCEPTION-NAME previously registered by REGISTER-JAVA-EXCEPTION. 322 \end{adjustwidth} 323 324 \paragraph{} 281 325 \label{JAVA:JNEW} 282 326 \index{JNEW} … … 288 332 289 333 \paragraph{} 290 \label{JAVA:JREGISTER-HANDLER}291 \index{JREGISTER-HANDLER}292 --- Function: \textbf{jregister-handler} [\textbf{java}] \textit{object event handler \&key data count}293 294 \begin{adjustwidth}{5em}{5em}295 not-documented296 \end{adjustwidth}297 298 \paragraph{}299 \label{JAVA:JCLASS-SUPERCLASS}300 \index{JCLASS-SUPERCLASS}301 --- Function: \textbf{jclass-superclass} [\textbf{java}] \textit{class}302 303 \begin{adjustwidth}{5em}{5em}304 Returns the superclass of CLASS, or NIL if it hasn't got one305 \end{adjustwidth}306 307 \paragraph{}308 \label{JAVA:JAVA-OBJECT-P}309 \index{JAVA-OBJECT-P}310 --- Function: \textbf{java-object-p} [\textbf{java}] \textit{object}311 312 \begin{adjustwidth}{5em}{5em}313 Returns T if OBJECT is a JAVA-OBJECT.314 \end{adjustwidth}315 316 \paragraph{}317 334 \label{JAVA:JARRAY-COMPONENT-TYPE} 318 335 \index{JARRAY-COMPONENT-TYPE} … … 329 346 330 347 \begin{adjustwidth}{5em}{5em} 331 not-documented 332 \end{adjustwidth} 333 334 \paragraph{} 335 \label{JAVA:UNREGISTER-JAVA-EXCEPTION} 336 \index{UNREGISTER-JAVA-EXCEPTION} 337 --- Function: \textbf{unregister-java-exception} [\textbf{java}] \textit{exception-name} 338 339 \begin{adjustwidth}{5em}{5em} 340 Unregisters the Java Throwable EXCEPTION-NAME previously registered by REGISTER-JAVA-EXCEPTION. 348 Add JAR-OR-JARS to the JVM classpath optionally specifying the CLASSLOADER to add. 349 350 JAR-OR-JARS is either a pathname designating a jar archive or the root 351 directory to search for classes or a list of such values. 341 352 \end{adjustwidth} 342 353 … … 373 384 374 385 \paragraph{} 386 \label{JAVA:+NULL+} 387 \index{+NULL+} 388 --- Variable: \textbf{+null+} [\textbf{java}] \textit{} 389 390 \begin{adjustwidth}{5em}{5em} 391 The JVM null object reference. 392 \end{adjustwidth} 393 394 \paragraph{} 395 \label{JAVA:ENSURE-JAVA-CLASS} 396 \index{ENSURE-JAVA-CLASS} 397 --- Function: \textbf{ensure-java-class} [\textbf{java}] \textit{jclass} 398 399 \begin{adjustwidth}{5em}{5em} 400 Attempt to ensure that the Java class referenced by JCLASS exists in the current process of the implementation. 401 \end{adjustwidth} 402 403 \paragraph{} 375 404 \label{JAVA:JMEMBER-PUBLIC-P} 376 405 \index{JMEMBER-PUBLIC-P} … … 382 411 383 412 \paragraph{} 384 \label{JAVA:+NULL+}385 \index{+NULL+}386 --- Variable: \textbf{+null+} [\textbf{java}] \textit{}387 388 \begin{adjustwidth}{5em}{5em}389 The JVM null object reference.390 \end{adjustwidth}391 392 \paragraph{}393 \label{JAVA:ENSURE-JAVA-CLASS}394 \index{ENSURE-JAVA-CLASS}395 --- Function: \textbf{ensure-java-class} [\textbf{java}] \textit{jclass}396 397 \begin{adjustwidth}{5em}{5em}398 not-documented399 \end{adjustwidth}400 401 \paragraph{}402 413 \label{JAVA:JAVA-CLASS} 403 414 \index{JAVA-CLASS} … … 409 420 410 421 \paragraph{} 422 \label{JAVA:JCLASS-ARRAY-P} 423 \index{JCLASS-ARRAY-P} 424 --- Function: \textbf{jclass-array-p} [\textbf{java}] \textit{class} 425 426 \begin{adjustwidth}{5em}{5em} 427 Returns T if CLASS is an array class 428 \end{adjustwidth} 429 430 \paragraph{} 411 431 \label{JAVA:JMETHOD-LET} 412 432 \index{JMETHOD-LET} … … 418 438 419 439 \paragraph{} 420 \label{JAVA:JCLASS-ARRAY-P}421 \index{JCLASS-ARRAY-P}422 --- Function: \textbf{jclass-array-p} [\textbf{java}] \textit{class}423 424 \begin{adjustwidth}{5em}{5em}425 Returns T if CLASS is an array class426 \end{adjustwidth}427 428 \paragraph{}429 440 \label{JAVA:JCALL} 430 441 \index{JCALL} … … 538 549 539 550 \paragraph{} 551 \label{JAVA:JMAKE-INVOCATION-HANDLER} 552 \index{JMAKE-INVOCATION-HANDLER} 553 --- Function: \textbf{jmake-invocation-handler} [\textbf{java}] \textit{function} 554 555 \begin{adjustwidth}{5em}{5em} 556 not-documented 557 \end{adjustwidth} 558 559 \paragraph{} 540 560 \label{JAVA:+TRUE+} 541 561 \index{+TRUE+} … … 547 567 548 568 \paragraph{} 549 \label{JAVA:JM AKE-INVOCATION-HANDLER}550 \index{JM AKE-INVOCATION-HANDLER}551 --- Function: \textbf{jm ake-invocation-handler} [\textbf{java}] \textit{function}552 553 \begin{adjustwidth}{5em}{5em} 554 not-documented 569 \label{JAVA:JMEMBER-PROTECTED-P} 570 \index{JMEMBER-PROTECTED-P} 571 --- Function: \textbf{jmember-protected-p} [\textbf{java}] \textit{member} 572 573 \begin{adjustwidth}{5em}{5em} 574 MEMBER is a protected member of its declaring class 555 575 \end{adjustwidth} 556 576 … … 571 591 \begin{adjustwidth}{5em}{5em} 572 592 not-documented 573 \end{adjustwidth}574 575 \paragraph{}576 \label{JAVA:JMEMBER-PROTECTED-P}577 \index{JMEMBER-PROTECTED-P}578 --- Function: \textbf{jmember-protected-p} [\textbf{java}] \textit{member}579 580 \begin{adjustwidth}{5em}{5em}581 MEMBER is a protected member of its declaring class582 593 \end{adjustwidth} 583 594 … … 600 611 601 612 \paragraph{} 613 \label{JAVA:JCLASS-FIELDS} 614 \index{JCLASS-FIELDS} 615 --- Function: \textbf{jclass-fields} [\textbf{java}] \textit{class \&key declared public} 616 617 \begin{adjustwidth}{5em}{5em} 618 Returns a vector of all (or just the declared/public, if DECLARED/PUBLIC is true) fields of CLASS 619 \end{adjustwidth} 620 621 \paragraph{} 602 622 \label{JAVA:JNEW-ARRAY-FROM-ARRAY} 603 623 \index{JNEW-ARRAY-FROM-ARRAY} … … 606 626 \begin{adjustwidth}{5em}{5em} 607 627 Returns a new Java array with base type ELEMENT-TYPE (a string or a class-ref) 608 initialized from ARRAY 628 initialized from ARRAY. 609 629 \end{adjustwidth} 610 630 … … 619 639 620 640 \paragraph{} 621 \label{JAVA:JCLASS-FIELDS}622 \index{JCLASS-FIELDS}623 --- Function: \textbf{jclass-fields} [\textbf{java}] \textit{class \&key declared public}624 625 \begin{adjustwidth}{5em}{5em}626 Returns a vector of all (or just the declared/public, if DECLARED/PUBLIC is true) fields of CLASS627 \end{adjustwidth}628 629 \paragraph{}630 641 \label{JAVA:JAVA-EXCEPTION} 631 642 \index{JAVA-EXCEPTION} … … 684 695 685 696 \paragraph{} 697 \label{JAVA:JMEMBER-STATIC-P} 698 \index{JMEMBER-STATIC-P} 699 --- Function: \textbf{jmember-static-p} [\textbf{java}] \textit{member} 700 701 \begin{adjustwidth}{5em}{5em} 702 MEMBER is a static member of its declaring class 703 \end{adjustwidth} 704 705 \paragraph{} 686 706 \label{JAVA:JCONSTRUCTOR-PARAMS} 687 707 \index{JCONSTRUCTOR-PARAMS} … … 693 713 694 714 \paragraph{} 695 \label{JAVA:JMEMBER-STATIC-P}696 \index{JMEMBER-STATIC-P}697 --- Function: \textbf{jmember-static-p} [\textbf{java}] \textit{member}698 699 \begin{adjustwidth}{5em}{5em}700 MEMBER is a static member of its declaring class701 \end{adjustwidth}702 703 \paragraph{}704 715 \label{JAVA:JCOERCE} 705 716 \index{JCOERCE} … … 734 745 735 746 \begin{adjustwidth}{5em}{5em} 736 not-documented 747 Returns the length of a Java primitive array. 737 748 \end{adjustwidth} 738 749 … … 747 758 748 759 \paragraph{} 760 \label{JAVA:JMAKE-PROXY} 761 \index{JMAKE-PROXY} 762 --- Generic Function: \textbf{jmake-proxy} [\textbf{java}] \textit{} 763 764 \begin{adjustwidth}{5em}{5em} 765 Returns a proxy Java object implementing the provided interface(s) using methods implemented in Lisp - typically closures, but implementations are free to provide other mechanisms. You can pass an optional 'lisp-this' object that will be passed to the implementing methods as their first argument. If you don't provide this object, NIL will be used. The second argument of the Lisp methods is the name of the Java method being implemented. This has the implication that overloaded methods are merged, so you have to manually discriminate them if you want to. The remaining arguments are java-objects wrapping the method's parameters. 766 \end{adjustwidth} 767 768 \paragraph{} 749 769 \label{JAVA:JCLASS-FIELD} 750 770 \index{JCLASS-FIELD} … … 756 776 757 777 \paragraph{} 758 \label{JAVA:JMAKE-PROXY}759 \index{JMAKE-PROXY}760 --- Generic Function: \textbf{jmake-proxy} [\textbf{java}] \textit{}761 762 \begin{adjustwidth}{5em}{5em}763 not-documented764 \end{adjustwidth}765 766 \paragraph{}767 778 \label{JAVA:JCALL-RAW} 768 779 \index{JCALL-RAW} -
branches/1.1.x/doc/manual/threads.tex
r13866 r14266 5 5 6 6 \begin{adjustwidth}{5em}{5em} 7 Returns non-NIL if the mailbox can be read from, NIL otherwise. 7 not-documented 8 8 \end{adjustwidth} 9 9 … … 54 54 55 55 \paragraph{} 56 \label{THREADS:MAKE-THREAD} 57 \index{MAKE-THREAD} 58 --- Function: \textbf{make-thread} [\textbf{threads}] \textit{function \&key name} 59 60 \begin{adjustwidth}{5em}{5em} 61 not-documented 62 \end{adjustwidth} 63 64 \paragraph{} 56 65 \label{THREADS:OBJECT-WAIT} 57 66 \index{OBJECT-WAIT} … … 63 72 64 73 \paragraph{} 65 \label{THREADS:MAKE-THREAD}66 \index{MAKE-THREAD}67 --- Function: \textbf{make-thread} [\textbf{threads}] \textit{function \&key name}68 69 \begin{adjustwidth}{5em}{5em}70 not-documented71 \end{adjustwidth}72 73 \paragraph{}74 74 \label{THREADS:MAKE-THREAD-LOCK} 75 75 \index{MAKE-THREAD-LOCK} … … 92 92 \label{THREADS:MAKE-MAILBOX} 93 93 \index{MAKE-MAILBOX} 94 --- Function: \textbf{make-mailbox} [\textbf{threads}] \textit{\&key ((queue g 2304220) NIL)}94 --- Function: \textbf{make-mailbox} [\textbf{threads}] \textit{\&key ((queue g348097) NIL)} 95 95 96 96 \begin{adjustwidth}{5em}{5em} … … 123 123 \begin{adjustwidth}{5em}{5em} 124 124 Returns two values. The second returns non-NIL when the mailbox 125 is empty. The first is the next item to be read from the mailbox 126 if the first is NIL. 125 is empty. The first is the next item to be read from the mailbox. 127 126 128 127 Note that due to multi-threading, the first value returned upon … … 170 169 171 170 \paragraph{} 172 \label{THREADS:MAKE-MUTEX}173 \index{MAKE-MUTEX}174 --- Function: \textbf{make-mutex} [\textbf{threads}] \textit{\&key ((in-use g2304421) NIL)}175 176 \begin{adjustwidth}{5em}{5em}177 not-documented178 \end{adjustwidth}179 180 \paragraph{}181 171 \label{THREADS:THREAD} 182 172 \index{THREAD} … … 188 178 189 179 \paragraph{} 180 \label{THREADS:MAKE-MUTEX} 181 \index{MAKE-MUTEX} 182 --- Function: \textbf{make-mutex} [\textbf{threads}] \textit{\&key ((in-use g348357) NIL)} 183 184 \begin{adjustwidth}{5em}{5em} 185 not-documented 186 \end{adjustwidth} 187 188 \paragraph{} 190 189 \label{THREADS:WITH-THREAD-LOCK} 191 190 \index{WITH-THREAD-LOCK}
Note: See TracChangeset
for help on using the changeset viewer.