Index: /trunk/source/doc/ccl-documentation.html =================================================================== --- /trunk/source/doc/ccl-documentation.html (revision 13119) +++ /trunk/source/doc/ccl-documentation.html (revision 13120) @@ -429,5 +429,5 @@
- 12.12. The Foreign-Function-Interface Dictionary + 12.12. The Foreign-Function-Interface Dictionary
@@ -10041,5 +10041,6 @@ program args &key (wait t) pty sharing input if-input-does-not-exist output (if-output-exists :error) (error - :output) (if-error-exists :error) status-hook + :output) (if-error-exists :error) status-hook + external-format
Invokes an external program as an OS subprocess @@ -10093,7 +10094,12 @@ whenever Clozure CL detects a change in the status of the EXTERNAL-PROCESS.

-
-
- +

external-format--- + The external format (see Section 4.3.2, “External Formats”) for all of the + streams (input, output, and error) used to + communicate with the external process. +

+
+
+
Description:

Runs the specified program in an external (Unix) process, @@ -10115,5 +10121,5 @@

- +
Arguments and Values:

proc---An EXTERNAL-PROCESS, as returned by RUN-PROGRAM.

@@ -10121,5 +10127,5 @@
- +
Description:

Sends the specified "signal" to the specified @@ -10144,10 +10150,10 @@

- +
Arguments and Values:

proc---An EXTERNAL-PROCESS, as returned by RUN-PROGRAM.

- +
Description:

Returns the process id assigned to @@ -10171,10 +10177,10 @@

- +
Arguments and Values:

proc---An EXTERNAL-PROCESS, as returned by RUN-PROGRAM.

- +
Description:

Returns the stream created when the input argument to @@ -10197,10 +10203,10 @@

- +
Arguments and Values:

proc---An EXTERNAL-PROCESS, as returned by RUN-PROGRAM.

- +
Description:

Returns the stream created when the output argument to @@ -10224,10 +10230,10 @@

- +
Arguments and Values:

proc---An EXTERNAL-PROCESS, as returned by RUN-PROGRAM.

- +
Description:

Returns the stream created when the error argument to @@ -10251,10 +10257,10 @@

- +
Arguments and Values:

proc---An EXTERNAL-PROCESS, as returned by RUN-PROGRAM.

- +
Description:

Returns, as multiple values, a keyword denoting the status @@ -10286,5 +10292,5 @@

- 9.1.1. Stream External Encoding + 9.1.1. Stream External Encoding
@@ -10354,5 +10360,5 @@
-

9.1.1. Stream External Encoding

+

9.1.1. Stream External Encoding

@@ -10515,10 +10521,10 @@
- - - + + + - - + +

A stream that is associated with a file descriptor has attributes and accessors: @@ -10573,5 +10579,5 @@

- +
Values:

stream-list---A list of open file streams. This is a copy of @@ -10580,10 +10586,10 @@

- +
Description:

Returns a list of open file streams.

- +
See Also:
note-open-file-stream, remove-open-file-stream @@ -10608,10 +10614,10 @@
- +
Arguments:

file-stream---A file stream.

- +
Description:

Adds a file stream to the internal list of open @@ -10622,5 +10628,5 @@

- +
See Also:
open-file-streams, remove-open-file-stream @@ -10645,10 +10651,10 @@
- +
Arguments:

file-stream---A file stream.

- +
Description:

Remove file stream from the internal list of open file @@ -10659,5 +10665,5 @@

- +
See Also:
open-file-streams, note-open-file-stream @@ -11092,5 +11098,5 @@
- +
Arguments and Values:

stream---a stream, presumably a fundamental-input-stream.

@@ -11103,5 +11109,5 @@
- +
Description:

Should try to read up to count elements from stream into the @@ -11124,5 +11130,5 @@

- +
Arguments and Values:

stream---a stream, presumably a fundamental-output-stream.

@@ -11135,5 +11141,5 @@
- +
Description:

should try to write the first count elements of list to @@ -11155,5 +11161,5 @@

- +
Arguments and Values:

stream---a stream, presumably a fundamental-input-stream

@@ -11171,5 +11177,5 @@
- +
Description:

should try to read successive elements from stream into @@ -11194,5 +11200,5 @@

- +
Arguments and Values:

stream---a stream, presumably a fundamental-output-stream

@@ -11210,5 +11216,5 @@
- +
Description:

should try to write successive elements of vector to stream, @@ -11232,5 +11238,5 @@

- +
Method Signatures:
ccl::stream-device @@ -11238,5 +11244,5 @@
- +
Arguments and Values:

s---a stream.

@@ -11249,5 +11255,5 @@
- +
Description:

Returns the file descriptor associated with @@ -11273,5 +11279,5 @@

- +
Description:

Reads up to max-octets octets from stream into ivector, @@ -11280,5 +11286,5 @@

- +
Arguments:

stream---An input stream. The method defined on @@ -11305,5 +11311,5 @@

- +
Description:

Writes max-octets octets to stream from ivector, starting at @@ -11311,5 +11317,5 @@

- +
Arguments:

stream---An input stream. The method defined on @@ -11321,5 +11327,5 @@

- +
Examples:
@@ -12487,5 +12493,5 @@

- + CHUD:*SHARK-CONFIG-FILE* [Variable]

@@ -12493,5 +12499,5 @@ configuration file created by the "Config Editor" in Shark.app.

- + CHUD:METER form &key (reset nil) (debug-output nil) [Macro]

@@ -12755,5 +12761,5 @@
- 12.12. The Foreign-Function-Interface Dictionary + 12.12. The Foreign-Function-Interface Dictionary
@@ -13583,5 +13589,5 @@
-

12.3.2.4. %int-to-ptr [Function]

+

12.3.2.4. %int-to-ptr [Function]

@@ -13624,5 +13630,5 @@
-

12.3.2.5. %inc-ptr [Function]

+

12.3.2.5. %inc-ptr [Function]

@@ -13674,5 +13680,5 @@
-

12.3.2.6. %ptr-to-int [Function]

+

12.3.2.6. %ptr-to-int [Function]

@@ -13716,5 +13722,5 @@
-

12.3.2.7. %null-ptr [Macro]

+

12.3.2.7. %null-ptr [Macro]

@@ -13741,5 +13747,5 @@
-

12.3.2.8. %null-ptr-p [Function]

+

12.3.2.8. %null-ptr-p [Function]

@@ -13783,5 +13789,5 @@
-

12.3.2.9. %setf-macptr [Function]

+

12.3.2.9. %setf-macptr [Function]

@@ -13831,5 +13837,5 @@
-

12.3.2.10. %incf-ptr [Macro]

+

12.3.2.10. %incf-ptr [Macro]

@@ -13879,5 +13885,5 @@
-

12.3.2.11. with-macptrs [Macro]

+

12.3.2.11. with-macptrs [Macro]

@@ -13929,5 +13935,5 @@
-

12.3.2.12. %stack-block [Macro]

+

12.3.2.12. %stack-block [Macro]

@@ -13980,5 +13986,5 @@
-

12.3.2.13. make-cstring [Function]

+

12.3.2.13. make-cstring [Function]

@@ -14023,5 +14029,5 @@
-

12.3.2.14. with-cstrs [Macro]

+

12.3.2.14. with-cstrs [Macro]

@@ -14073,5 +14079,5 @@
-

12.3.2.15. with-encoded-cstrs [Macro]

+

12.3.2.15. with-encoded-cstrs [Macro]

@@ -14136,5 +14142,5 @@
-

12.3.2.16. %get-cstring [Function]

+

12.3.2.16. %get-cstring [Function]

@@ -14178,5 +14184,5 @@
-

12.3.2.17. %str-from-ptr [Function]

+

12.3.2.17. %str-from-ptr [Function]

@@ -15608,5 +15614,5 @@
-

12.12. The Foreign-Function-Interface Dictionary

+

12.12. The Foreign-Function-Interface Dictionary

@@ -15625,5 +15631,5 @@
- +
Description:

Reads a symbol from the current input stream, with *PACKAGE* @@ -15677,5 +15683,5 @@

- +
Description:

In CCL 1.2 and later, the #& reader macro can be used to @@ -15736,5 +15742,5 @@

- +
Description:

In CCL 0.14.2 and later, the #? reader macro can be used @@ -15783,5 +15789,5 @@

- +
Description:

In CCL 1.2 and later, the #/ reader macro can be used to @@ -15886,5 +15892,5 @@

- +
Description:

In CCL 1.2 and later, the #> reader macro reads @@ -15915,5 +15921,5 @@

- +
Values:

library---either an object of type SHLIB, or a string which @@ -15922,5 +15928,5 @@

- +
Description:

If completely is T, sets the @@ -15951,5 +15957,5 @@

- +
Values:

name---A symbol which can be made into a special variable

@@ -15968,5 +15974,5 @@
- +
Description:

Proclaims name @@ -16004,5 +16010,5 @@

- +
Values:

name---NIL or a keyword; the keyword may contain @@ -16012,5 +16018,5 @@

- +
Description:

If name is non-NIL, defines name to be an alias for the @@ -16046,5 +16052,5 @@

- +
Values:

name--- @@ -16059,5 +16065,5 @@

- +
Description:

If there is already an EXTERNAL-ENTRY-POINT for @@ -16087,5 +16093,5 @@

- +
Values:

name---A lisp string. See external, above.

@@ -16100,5 +16106,5 @@
- +
Description:

Calls the foreign function at the address obtained by @@ -16127,5 +16133,5 @@

- +
Values:

entrypoint---A fixnum or MACPTR

@@ -16138,5 +16144,5 @@
- +
Description:

Calls the foreign function at address entrypoint passing the @@ -16164,5 +16170,5 @@

- +
Values:

entrypoint---A fixnum or MACPTR

@@ -16177,5 +16183,5 @@
- +
Description:

Calls the foreign function at address entrypoint passing the @@ -16202,10 +16208,10 @@

- +
Values:

name---A lisp string.

- +
Description:

Tries to resolve the address of the foreign symbol @@ -16230,10 +16236,10 @@

- +
Values:

name---A lisp string.

- +
Description:

Tries to resolve the address of the foreign symbol name. If @@ -16257,5 +16263,5 @@

- +
Values:

ptr---A MACPTR that points to a block of @@ -16263,5 +16269,5 @@

- +
Description:

In CCL 1.2 and later, the CCL:FREE @@ -16295,5 +16301,5 @@

- +
Values:

element-count---A positive integer.

@@ -16310,5 +16316,5 @@
- +
Description:

@@ -16345,5 +16351,5 @@

- +
Values:

typespec---A foreign type specifier, or a keyword which is used @@ -16362,5 +16368,5 @@

- +
Description:

@@ -16411,5 +16417,5 @@

- +
Values:

typespec---A foreign type specifier, or a keyword which is used @@ -16425,5 +16431,5 @@

- +
Description:

@@ -16466,5 +16472,5 @@

- +
Notes:

@@ -16499,5 +16505,5 @@

- +
Values:

name---A SIMPLE-STRING which is presumed to be the so-name of @@ -16507,5 +16513,5 @@

- +
Description:

If the library denoted by name can @@ -16518,5 +16524,5 @@

- +
Examples:
;;; Try to do something simple.
@@ -16553,5 +16559,5 @@
- +
Notes:

It would be helpful to describe what an soname is and give @@ -16576,5 +16582,5 @@

- +
Values:

ptr---a MACPTR.

@@ -16584,5 +16590,5 @@
- +
Description:

References an instance of a foreign type (or a component of @@ -16610,5 +16616,5 @@

- +
Values:

eep---An EXTERNAL-ENTRY-POINT, as obtained by the EXTERNAL @@ -16616,5 +16622,5 @@

- +
Description:

Tries to resolve the address of the EXTERNAL-ENTRY-POINT @@ -16639,5 +16645,5 @@

- +
Values:

var---A symbol (a lisp variable)

@@ -16647,5 +16653,5 @@
- +
Description:

Executes body @@ -16677,5 +16683,5 @@

- +
Values:

var---A symbol (a lisp variable)

@@ -16684,5 +16690,5 @@
- +
Description:

Executes body in an environment in which each var is @@ -16711,5 +16717,5 @@

- +
Values:

object---A CLOS object of a class for which there exists @@ -16719,5 +16725,5 @@

- +
Description:

@@ -16756,5 +16762,5 @@

- +
Example:
@@ -16770,5 +16776,5 @@
- +
See Also:
@@ -16792,5 +16798,5 @@
- +
Values:

dir-id---A keyword whose pname, mapped to lower case, names a @@ -16799,5 +16805,5 @@

- +
Description:

Tells CCL to remove the interface directory denoted by @@ -16823,5 +16829,5 @@

- +
Values:

dir-id---A keyword whose pname, mapped to lower case, names a @@ -16830,5 +16836,5 @@

- +
Description:

Tells CCL to add the interface directory denoted by @@ -16852,5 +16858,5 @@

- +
Examples:

One typically wants interface information to be @@ -16955,10 +16961,10 @@

- 13.6.1. Using define-objc-method + 13.6.1. Using define-objc-method
- 13.6.2. Using objc:defmethod + 13.6.2. Using objc:defmethod
@@ -17566,5 +17572,5 @@
-

13.6.1. Using define-objc-method

+

13.6.1. Using define-objc-method

@@ -17683,5 +17689,5 @@
-

13.6.2. Using objc:defmethod

+

13.6.2. Using objc:defmethod

@@ -18507,5 +18513,5 @@
- +
Arguments and Values:

name---a string which is the name of an existing @@ -18517,5 +18523,5 @@

- +
Description:

@@ -18538,5 +18544,5 @@

- +
Arguments and Values:

name---a string which is the name of a new or existing @@ -18551,5 +18557,5 @@

- +
Description:

@@ -18575,5 +18581,5 @@

- +
Values:

path---a string, an absolute pathname in Posix format - with @@ -18581,5 +18587,5 @@

- +
Description:

@@ -18603,5 +18609,5 @@

- +
Values:

uid---a non-negative integer, identifying a specific user @@ -18609,5 +18615,5 @@

- +
Description:

@@ -18629,5 +18635,5 @@

- +
Arguments and Values:

uid---a non-negative integer, identifying a specific user @@ -18638,5 +18644,5 @@

- +
Description:

@@ -18661,5 +18667,5 @@

- +
Arguments and Values:

gid---a non-negative integer, identifying a specific @@ -18670,5 +18676,5 @@

- +
Description:

@@ -18693,10 +18699,10 @@

- +
Values:

pid---a non-negative integer, identifying an OS process

- +
Description:

@@ -18719,5 +18725,5 @@

- +
Values:

uid---a non-negative integer, identifying a specific user @@ -18727,5 +18733,5 @@

- +
Description:

@@ -18752,5 +18758,5 @@

- +
Values:

command-line---a string, obeying all the whitespace and @@ -18761,5 +18767,5 @@

- +
Description:

@@ -18777,5 +18783,5 @@

- +
Notes:

@@ -18802,5 +18808,5 @@

- +
Arguments and Values:

class-name---a string which denotes an existing class name, or a @@ -18809,5 +18815,5 @@

- +
Description:

Used to refer to a known ObjC class by name. (Via the use @@ -18834,5 +18840,5 @@

- +
Arguments and Values:

string---a string constant, used to canonically refer to an @@ -18840,5 +18846,5 @@

- +
Description:

Used to refer to an ObjC method selector (method name). Uses @@ -18862,5 +18868,5 @@

- +
Arguments and Values:

name-and-result-type---either an Objective-C message name, for methods @@ -18884,5 +18890,5 @@

- +
Description:

Defines an Objective-C-callable method which implements @@ -18909,5 +18915,5 @@

- +
Arguments and Values:

selector---either a string which represents the name of the @@ -18924,5 +18930,5 @@

- +
Description:

Defines an ObjC-callable method which implements the @@ -18945,10 +18951,10 @@

- +
Arguments and Values:

As per DEFINE-OBJC-METHOD

- +
Description:

Like DEFINE-OBJC-METHOD, only used to define methods on the @@ -18992,5 +18998,5 @@

- +
Description:

This variable is currently only used by the standard reader macro @@ -19027,5 +19033,5 @@

- +
Description:

Per ANSI CL, Clozure CL supports the :EXTERNAL-FORMAT keyword @@ -19071,5 +19077,5 @@

- +
Description:

The value of this variable is used when :EXTERNAL-FORMAT is @@ -19095,10 +19101,10 @@

- +
Superclasses:

NS:NS-STRING

- +
Initargs:

:string--- @@ -19108,5 +19114,5 @@

- +
Description:

@@ -19126,5 +19132,5 @@

- +
Examples:

@@ -19157,5 +19163,5 @@

- +
Notes:

@@ -19497,5 +19503,5 @@

- +
Arguments and Values:

type---The type of population, one of :LIST (the default) or :ALIST

@@ -19505,5 +19511,5 @@
- +
Description:

Creates a new population of the specified type.

@@ -19523,5 +19529,5 @@
- +
Description:

returns the type of population, one of :LIST or :ALIST

@@ -19541,5 +19547,5 @@
- +
Description:

returns the list encapsulated in population. @@ -19564,5 +19570,5 @@

- +
Description:

Sets the list encapsulated in population to @@ -19597,5 +19603,5 @@

- +
Description:

Returns the value of the kernel variable that specifies the @@ -19618,10 +19624,10 @@

- +
Arguments and Values:

new-threshold---The requested new lisp-heap-gc-threshold.

- +
Description:

Sets the value of the kernel variable that specifies the @@ -19647,5 +19653,5 @@

- +
Description:

Tries to grow or shrink lisp's heap space, so that the @@ -19667,10 +19673,10 @@

- +
Arguments and Values:

arg---a generalized boolean

- +
Description:

Enables the EGC if arg is non-nil, disables the EGC @@ -19698,5 +19704,5 @@

- +
Description:

Returns T if the EGC was enabled at the time of the call, @@ -19721,5 +19727,5 @@

- +
Description:

Returns T if the EGC was active at the time of the call, NIL @@ -19746,5 +19752,5 @@

- +
Description:

Returns, as multiple values, the sizes in kilobytes of the @@ -19768,5 +19774,5 @@

- +
Arguments and Values:

generation-0-size---the requested threshold size of the youngest @@ -19778,5 +19784,5 @@

- +
Description:

Puts the indicated threshold sizes in effect. @@ -19802,10 +19808,10 @@

- +
Arguments and Values:

arg---a generalized boolean

- +
Description:

Tries to influence the GC to retain/recycle the pages @@ -19832,5 +19838,5 @@

- +
Description:

Returns T if the GC tries to retain pages between full GCs @@ -19987,5 +19993,5 @@

- 16.7.2. Recommended Reading + 16.7.2. Recommended Reading
@@ -21263,5 +21269,5 @@

  • To support a feature called GCTWA - [1] + [1] , the vector that contains the internal symbols of the current package is marked on entry to the @@ -21396,5 +21402,5 @@

    -

    [1] I believe that the acronym comes from MACLISP, +

    [1] I believe that the acronym comes from MACLISP, where it stood for "Garbage Collection of Truly Worthless Atoms".

    @@ -21456,5 +21462,5 @@ generations looking for such intergenerational references, the runtime system must note all such intergenerational references - at the point where they're created (via Setf).[2] The + at the point where they're created (via Setf).[2] The set of pointers that may contain intergenerational references is sometimes called the remembered set.

    @@ -21503,5 +21509,5 @@ that might introduce an intergenerational reference must be memoized. - [3] It's always safe to + [3] It's always safe to push any cons cell or gvector locative onto the memo stack; it's never safe to push anything else. @@ -21524,5 +21530,5 @@
    -

    [2] This is +

    [2] This is sometimes called "The Write Barrier": all assignments which might result in intergenerational references must be noted, as @@ -21530,5 +21536,5 @@

    -

    [3] Note that the implicit setfs that occur when +

    [3] Note that the implicit setfs that occur when initializing an object - as in the case of a call to cons or vector - can't introduce intergenerational references, since @@ -21646,5 +21652,5 @@

    -

    16.7.2. Recommended Reading

    +

    16.7.2. Recommended Reading

    @@ -22059,5 +22065,5 @@
    - +
    Description:

    When true, attempts to redefine (via DEFUN or DEFMETHOD) @@ -22084,5 +22090,5 @@

    - +
    Description:

    Arranges that the outermost special bindings of *PACKAGE* @@ -22108,5 +22114,5 @@

    - +
    Description:

    Arranges that the outermost special bindings of *PACKAGE* @@ -22131,5 +22137,5 @@

    - +
    Description:

    This variable is initialized each time an Clozure CL session @@ -22156,5 +22162,5 @@

    - +
    Description:

    Returns non-NIL if AltiVec is available.

    @@ -22174,5 +22180,5 @@
    - +
    Description:

    Intended to control the expansion of certain lap macros. @@ -22196,5 +22202,5 @@

    - +
    Arguments and Values:

    reglist---A list of vector register names (vr0 .. vr31).

    @@ -22202,5 +22208,5 @@
    - +
    Description:

    Specifies the set of AltiVec registers used in body. If @@ -22228,5 +22234,5 @@

    - +
    Arguments and Values:

    base---Any available general-purpose register.

    @@ -22237,5 +22243,5 @@
    - +
    Description:

    Generates code which allocates a 16-byte aligned buffer @@ -22901,5 +22907,5 @@ Symbol Index

    -

    This document was last modified at 19:0 on October 27, 2009, in UTC.

    It uses version 1.72.0 of the Norman Walsh Docbook stylesheets.

    Built from subversion rev 13106

    Using libxml 20629, libxslt 10121 and libexslt 813.

    +

    This document was last modified at 4:0 on October 29, 2009, in UTC.

    It uses version 1.72.0 of the Norman Walsh Docbook stylesheets.

    Built from subversion rev 13119

    Using libxml 20629, libxslt 10121 and libexslt 813.