Index: /trunk/source/doc/ccl-documentation.html =================================================================== --- /trunk/source/doc/ccl-documentation.html (revision 14529) +++ /trunk/source/doc/ccl-documentation.html (revision 14530) @@ -6,5 +6,5 @@ Clozure CL Documentation - + @@ -14,5 +14,5 @@
-

Clozure CL Documentation

+

Clozure CL Documentation

@@ -1745,5 +1745,5 @@

The following terms are used in subsequent sections; it may be helpful to refer to these definitions.

-

fasl +

fasl files are the object files produced by compile-file. fasl files store the @@ -1756,5 +1756,5 @@ see Table 3.1, “Platform-specific filename conventions”

-

The Lisp +

The Lisp kernel is a C program with a fair amount of platform-specific assembly language code. Its basic job is to @@ -1766,5 +1766,5 @@ files on different platforms; see Table 3.1, “Platform-specific filename conventions”.

-

A heap +

A heap image is a file that can be quickly mapped into a process's address space. Conceptually, it's not too different @@ -1777,5 +1777,5 @@ standard full heap image files on different platforms; see Table 3.1, “Platform-specific filename conventions”.

-

A bootstrapping image is a minimal +

A bootstrapping image is a minimal heap image used in the process of building Clozure CL itself. The bootstrapping image contains just enough code to load the rest @@ -1789,5 +1789,5 @@ as-yet-unsupported ones) has a uniquely named subdirectory of ccl/lisp-kernel/; each such - + contains a Makefile and may contain some auxiliary files (linker scripts, etc.) that are used to build the lisp kernel on a @@ -2608,5 +2608,5 @@

- + TRACE {keyword global-value}* {spec | @@ -3052,15 +3052,15 @@

- + CCL:*TRACE-LEVEL* [Variable]

Variable bound to the current nesting level during execution of before and after trace actions. The default printing actions use it to determine the amount of indentation.

- + CCL:*TRACE-MAX-INDENT* [Variable]

The default before and after print actions will not indent by more than the value of ccl:*trace-max-indent* regardless of the current trace level.

- + CCL:TRACE-FUNCTION spec &key {keyword value}* [Function]

@@ -3070,5 +3070,5 @@

- + CCL:*TRACE-PRINT-LEVEL* [Variable]

@@ -3078,5 +3078,5 @@ explicit printing done by user code.

- + CCL:*TRACE-PRINT-LENGTH* [Variable]

@@ -3086,5 +3086,5 @@ explicit printing done by user code.

- + CCL:*TRACE-BAR-FREQUENCY* [Variable]

@@ -3135,5 +3135,5 @@
- +
Arguments and Values:

spec--- @@ -3170,5 +3170,5 @@

- +
Examples:

@@ -3215,5 +3215,5 @@

- +
Description:

@@ -3230,5 +3230,5 @@

- +
Arguments and Values:

@@ -3254,5 +3254,5 @@

- +
Description:

@@ -3266,5 +3266,5 @@

- +
Arguments and Values:

@@ -3433,5 +3433,5 @@

- +
Arguments and Values:

domain---This is used to indicate where the external @@ -3467,5 +3467,5 @@

- +
Description:

Despite the function's name, it doesn't necessarily create a @@ -3635,5 +3635,5 @@

-

4.5.4.1. Encoding Problems

+

4.5.4.1. Encoding Problems

@@ -3651,5 +3651,5 @@
-

4.5.4.2. Byte Order Marks

+

4.5.4.2. Byte Order Marks

@@ -3679,5 +3679,5 @@
-

4.5.4.3. DESCRIBE-CHARACTER-ENCODINGS

+

4.5.4.3. DESCRIBE-CHARACTER-ENCODINGS

@@ -3701,5 +3701,5 @@
- +
Description:

Writes descriptions of all defined character encodings @@ -3710,5 +3710,5 @@

- +
See Also:
Section 4.5.4, “Character Encodings”, Section 4.5.2, “External Formats”, Section 4.5.4.4, “Supported Character Encodings” @@ -4141,5 +4141,5 @@
-

4.5.4.5. Encoding and Decoding Strings

+

4.5.4.5. Encoding and Decoding Strings

@@ -4166,5 +4166,5 @@
- +
Description:

@@ -4197,5 +4197,5 @@

- +
Description:

@@ -4240,5 +4240,5 @@

- +
Description:

@@ -4286,5 +4286,5 @@

- +
Description:

@@ -4336,5 +4336,5 @@

Clozure CL sets up logical pathname translations for logical hosts: ccl and home

- +

The CCL logical host should point to the ccl directory. It is used for a variety of @@ -4440,5 +4440,5 @@ platforms.

- + CCL:MAP-FILE-TO-IVECTOR pathname @@ -4500,5 +4500,5 @@ a memory error.

- + CCL:UNMAP-IVECTOR displaced-array @@ -4512,5 +4512,5 @@ target is an empty vector (of length zero).

- + CCL:MAP-FILE-TO-OCTET-VECTOR pathname @@ -4522,5 +4522,5 @@ bytes.

- + CCL:UNMAP-OCTET-VECTOR displaced-array @@ -4561,5 +4561,5 @@ static.

- + DEFSTATIC var @@ -4615,5 +4615,5 @@

- +

Clozure CL provides the function CCL:SAVE-APPLICATION, which creates a file @@ -4695,5 +4695,5 @@ converted, because address 0 can always be relied upon to refer to the same thing.

- +

As of Clozure CL 1.2, the constant CCL:+NULL-PTR+ refers to a MACPTR object that points to address 0.

@@ -4706,5 +4706,5 @@ or opencml64 script.

- + SAVE-APPLICATION filename @@ -4830,5 +4830,5 @@

- +
Arguments and Values:

out-file--- @@ -4844,5 +4844,5 @@

- +
Description:

@@ -4904,5 +4904,5 @@

- +
Arguments and Values:

mode--- @@ -4912,5 +4912,5 @@

- +
Description:

@@ -4951,5 +4951,5 @@

- +
Arguments and Values:

rounding-mode--- @@ -4960,5 +4960,5 @@

- +
Description:

@@ -5009,5 +5009,5 @@

- +
Arguments and Values:

object--- @@ -5016,5 +5016,5 @@

- +
Description:

@@ -5183,5 +5183,5 @@

- +
Description:

@@ -5217,5 +5217,5 @@

- +
Discussion:

@@ -5235,5 +5235,5 @@

- +
Restarts:

@@ -5303,5 +5303,5 @@

-

4.12.5.1. Fancy arrays

+

4.12.5.1. Fancy arrays

@@ -5330,5 +5330,5 @@
-

4.12.5.2. Hash tables

+

4.12.5.2. Hash tables

@@ -5378,5 +5378,5 @@
-

4.12.5.3. Lists

+

4.12.5.3. Lists

@@ -5547,5 +5547,5 @@
- +
Arguments and Values:

html--- @@ -5569,5 +5569,5 @@

- +
Example:

@@ -5603,5 +5603,5 @@

- +
Summary:

@@ -5625,5 +5625,5 @@

- +
Summary:

@@ -5651,5 +5651,5 @@

- +
Summary:

@@ -5677,5 +5677,5 @@

- +
Summary:

@@ -5708,5 +5708,5 @@

- +
Summary:

@@ -5735,5 +5735,5 @@

- +
Summary:

@@ -5758,5 +5758,5 @@

- +
Summary:

@@ -5785,5 +5785,5 @@

- +
Summary:

@@ -5812,5 +5812,5 @@

- +
Summary:

@@ -5979,5 +5979,5 @@

- +
Summary:

@@ -6004,5 +6004,5 @@

- +
Summary:

@@ -6040,5 +6040,5 @@

- +
Summary:

@@ -6075,5 +6075,5 @@

- +
Summary:

@@ -6086,4 +6086,31 @@ reserved by the lisp for its own use, an error is signaled. (An error is always signaled on Windows systems.) +

+
+
+

+

+

+ + [Special operator] +

+ + unwind-protect protected-form {cleanup-form}* + +
+
+ Ensure cleanup-forms are executed. +
+

+

+

+
+ +
Summary:
+

+ In Clozure CL, the cleanup forms are always executed as if they were + wrapped with without-interrupts. + To allow interrupts, use + with-interrupts-enabled.

@@ -6309,5 +6336,5 @@
-

5.4.2.1. Checking for Updates

+

5.4.2.1. Checking for Updates

@@ -6441,5 +6468,5 @@ the required subsystems, if necessary.

- + BUILD-APPLICATION &key (name "MyApplication") @@ -6741,5 +6768,5 @@

- 6.3.2. As of August 2003: + 6.3.2. As of August 2003:
@@ -6992,5 +7019,5 @@
-

6.3.2.  As of August 2003:

+

6.3.2.  As of August 2003:

@@ -7444,5 +7471,5 @@
- +
Values:

result---a list of all lisp processes (threads) @@ -7450,5 +7477,5 @@

- +
Description:

Returns a list of all lisp processes (threads) known @@ -7462,5 +7489,5 @@

- +
See Also:
@@ -7490,5 +7517,5 @@
- +
Arguments and Values:

name---a string, used to identify the process.

@@ -7529,5 +7556,5 @@
- +
Description:

Creates and returns a new lisp process (thread) with the @@ -7550,5 +7577,5 @@

- +
See Also:
process-preset, process-enable, process-run-function @@ -7569,5 +7596,5 @@
- +
Arguments and Values:

process---a lisp process (thread).

@@ -7579,5 +7606,5 @@
- +
Description:

Suspends process, preventing it from @@ -7601,10 +7628,10 @@

- +
See Also:
process-resume, process-suspend-count
- +
Notes:

process-suspend was previously called @@ -7632,5 +7659,5 @@

- +
Arguments and Values:

process---a lisp process (thread).

@@ -7643,5 +7670,5 @@
- +
Description:

Undoes the effect of a previous call to @@ -7654,10 +7681,10 @@

- +
See Also:
process-suspend, process-suspend-count
- +
Notes:

@@ -7685,5 +7712,5 @@

- +
Arguments and Values:

process---a lisp process (thread).

@@ -7695,5 +7722,5 @@
- +
Description:

An "outstanding" process-suspend call @@ -7710,5 +7737,5 @@

- +
See Also:
process-suspend, process-resume @@ -7731,5 +7758,5 @@
- +
Arguments and Values:

process---a lisp process (thread).

@@ -7742,5 +7769,5 @@
- +
Description:

Typically used to initialize a newly-created or newly-reset @@ -7756,5 +7783,5 @@

- +
See Also:
make-process, process-enable, process-run-function @@ -7777,5 +7804,5 @@
- +
Arguments and Values:

process---a lisp process (thread).

@@ -7786,5 +7813,5 @@
- +
Description:

Tries to begin the execution of process. @@ -7803,10 +7830,10 @@

- +
See Also:
make-process, process-preset, process-run-function
- +
Notes:

It would be nice to have more discussion of what it means @@ -7829,5 +7856,5 @@

- +
Arguments and Values:

name---a string, used to identify the process. @@ -7851,5 +7878,5 @@

- +
Description:

Creates a lisp process (thread) via @@ -7864,5 +7891,5 @@

- +
See Also:
make-process, process-preset, process-enable @@ -7885,5 +7912,5 @@
- +
Arguments and Values:

process---a lisp process (thread).

@@ -7898,5 +7925,5 @@
- +
Description:

Arranges for process @@ -7929,5 +7956,5 @@

- +
See Also:
@@ -7938,5 +7965,5 @@
- +
Notes:

It would probably be better for result @@ -7968,10 +7995,10 @@

- +
Value Type:

A lisp process (thread).

- +
Initial Value:

Bound separately in each process, to that process itself. @@ -7979,5 +8006,5 @@

- +
Description:

Used when lisp code needs to find out what process it is @@ -7985,5 +8012,5 @@

- +
See Also:
@@ -8009,5 +8036,5 @@
- +
Arguments and Values:

process---a lisp process (thread).

@@ -8016,5 +8043,5 @@
- +
Description:

Causes process to cleanly exit @@ -8043,5 +8070,5 @@

- +
See Also:
process-kill, process-abort @@ -8063,5 +8090,5 @@
- +
Arguments and Values:

process---a lisp process (thread), which @@ -8070,5 +8097,5 @@

- +
Description:

@@ -8078,5 +8105,5 @@

- +
See Also:
process-reset, process-enable @@ -8098,5 +8125,5 @@
- +
Arguments and Values:

process---a lisp process (thread).

@@ -8104,5 +8131,5 @@
- +
Description:

@@ -8112,5 +8139,5 @@

- +
See Also:
process-reset, process-abort @@ -8134,5 +8161,5 @@
- +
Arguments and Values:

process---a lisp process (thread).

@@ -8140,5 +8167,5 @@
- +
Description:

Entirely equivalent to calling @@ -8154,5 +8181,5 @@

- +
See Also:
process-reset, process-kill @@ -8173,10 +8200,10 @@
- +
Value Type:

A positive integer.

- +
Initial Value:

The clock resolution of the OS scheduler. Currently, @@ -8185,5 +8212,5 @@

- +
Description:

This value is ordinarily of marginal interest at best, @@ -8193,5 +8220,5 @@

- +
See Also:
@@ -8217,5 +8244,5 @@
- +
Description:

This information is primarily for the benefit of @@ -8231,10 +8258,10 @@

- +
See Also:
process-wait, process-wait-with-timeout, with-terminal-input
- +
Notes:

This should arguably be SETFable, but doesn't seem to @@ -8260,5 +8287,5 @@

- +
Description:

Advises the OS scheduler that the current thread has nothing @@ -8269,10 +8296,10 @@

- +
See Also:
make-lock, make-read-write-lock, make-semaphore, process-input-wait, process-output-wait, with-terminal-input
- +
Notes:

This is a holdover from the days of cooperative @@ -8297,5 +8324,5 @@

- +
Arguments and Values:

whostate---a string, which will be the value of @@ -8310,5 +8337,5 @@

- +
Description:

Causes the current lisp process (thread) to repeatedly @@ -8327,5 +8354,5 @@

- +
See Also:
process-whostate, process-wait-with-timeout, make-lock, make-read-write-lock, make-semaphore, process-input-wait, process-output-wait, with-terminal-input @@ -8347,5 +8374,5 @@
- +
Arguments and Values:

whostate---a string, which will be the value of @@ -8365,5 +8392,5 @@

- +
Description:

If ticks is NIL, behaves exactly like @@ -8382,5 +8409,5 @@

- +
See Also:
*ticks-per-second*, process-whostate, process-wait, make-lock, make-read-write-lock, make-semaphore, process-input-wait, process-output-wait, with-terminal-input @@ -8402,5 +8429,5 @@
- +
Arguments and Values:

body---an implicit progn.

@@ -8409,5 +8436,5 @@
- +
Description:

Executes body @@ -8424,5 +8451,5 @@

- +
See Also:
@@ -8436,4 +8463,34 @@

+ + [Macro] +

+ with-interrupts-enabled + &body body => result +
+
Evaluates its body in an environment in which + process-interrupt requests have immediate effect.
+

+

+

+
+ +
Arguments and Values:
+

body---an implicit progn.

+

result---the primary value returned by + body.

+
+
+ +
Description:
+

Executes body + in an environment in which process-interrupt + requests have immediate effect. +

+
+
+

+

+

[Function] @@ -8448,5 +8505,5 @@
- +
Arguments and Values:

name---any lisp object; saved as part of @@ -8458,5 +8515,5 @@

- +
Description:

Creates and returns a lock object, which can @@ -8468,5 +8525,5 @@

- +
See Also:
with-lock-grabbed, grab-lock, release-lock, try-lock, make-read-write-lock, make-semaphore, process-input-wait, process-output-wait, with-terminal-input @@ -8488,5 +8545,5 @@
- +
Arguments and Values:

lock---an object of type CCL:LOCK.

@@ -8496,5 +8553,5 @@
- +
Description:

Waits until lock is either free or @@ -8507,5 +8564,5 @@

- +
See Also:
make-lock, grab-lock, release-lock, try-lock, make-read-write-lock, make-semaphore, process-input-wait, process-output-wait, with-terminal-input @@ -8526,10 +8583,10 @@
- +
Arguments and Values:

lock---an object of type CCL:LOCK.

- +
Description:

Blocks until lock is owned by the @@ -8542,5 +8599,5 @@

- +
See Also:
make-lock, with-lock-grabbed, release-lock, try-lock, make-read-write-lock, make-semaphore, process-input-wait, process-output-wait, with-terminal-input @@ -8560,10 +8617,10 @@
- +
Arguments and Values:

lock---an object of type CCL:LOCK.

- +
Description:

Signals an error of type CCL:LOCK-NOT-OWNER if @@ -8578,5 +8635,5 @@

- +
See Also:
make-lock, with-lock-grabbed, grab-lock, try-lock, make-read-write-lock, make-semaphore, process-input-wait, process-output-wait, with-terminal-input @@ -8597,5 +8654,5 @@
- +
Arguments and Values:

lock---an object of type CCL:LOCK.

@@ -8604,5 +8661,5 @@
- +
Description:

Tests whether lock @@ -8617,5 +8674,5 @@

- +
See Also:
make-lock, with-lock-grabbed, grab-lock, release-lock, make-read-write-lock, make-semaphore, process-input-wait, process-output-wait, with-terminal-input @@ -8637,5 +8694,5 @@
- +
Arguments and Values:

read-write-lock---a newly-allocated object of type @@ -8643,5 +8700,5 @@

- +
Description:

Creates and returns an object of type CCL::READ-WRITE-LOCK. @@ -8654,10 +8711,10 @@

- +
See Also:
with-read-lock, with-write-lock, make-lock, make-semaphore, process-input-wait, process-output-wait, with-terminal-input
- +
Notes:

There probably should be some way to @@ -8682,5 +8739,5 @@

- +
Arguments and Values:

read-write-lock---an object of type @@ -8691,5 +8748,5 @@

- +
Description:

Waits until read-write-lock has no @@ -8705,5 +8762,5 @@

- +
See Also:
make-read-write-lock, with-write-lock, make-lock, make-semaphore, process-input-wait, process-output-wait, with-terminal-input @@ -8725,5 +8782,5 @@
- +
Arguments and Values:

read-write-lock---an object of type @@ -8734,5 +8791,5 @@

- +
Description:

Waits until read-write-lock has no @@ -8749,5 +8806,5 @@

- +
See Also:
make-read-write-lock, with-read-lock, make-lock, make-semaphore, process-input-wait, process-output-wait, with-terminal-input @@ -8769,10 +8826,10 @@
- +
Arguments and Values:

semaphore---a newly-allocated object of type CCL:SEMAPHORE.

- +
Description:

Creates and returns an object of type CCL:SEMAPHORE. @@ -8783,5 +8840,5 @@

- +
See Also:
signal-semaphore, wait-on-semaphore, timed-wait-on-semaphore, make-lock, make-read-write-lock, process-input-wait, process-output-wait, with-terminal-input @@ -8803,5 +8860,5 @@
- +
Arguments and Values:

semaphore---an object of type CCL:SEMAPHORE.

@@ -8810,5 +8867,5 @@
- +
Description:

Atomically increments semaphore's @@ -8817,10 +8874,10 @@

- +
See Also:
make-semaphore, wait-on-semaphore, timed-wait-on-semaphore, make-lock, make-read-write-lock, process-input-wait, process-output-wait, with-terminal-input
- +
Notes:

result should probably be interpreted @@ -8845,5 +8902,5 @@

- +
Arguments and Values:

semaphore---an object of type CCL:SEMAPHORE.

@@ -8852,5 +8909,5 @@
- +
Description:

Waits until semaphore @@ -8860,10 +8917,10 @@

- +
See Also:
make-semaphore, signal-semaphore, timed-wait-on-semaphore, make-lock, make-read-write-lock, process-input-wait, process-output-wait, with-terminal-input
- +
Notes:

result should probably be interpreted @@ -8889,5 +8946,5 @@

- +
Arguments and Values:

semaphore---An object of type CCL:SEMAPHORE.

@@ -8902,5 +8959,5 @@
- +
Description:

Waits until semaphore @@ -8911,5 +8968,5 @@

- +
See Also:
make-semaphore, wait-on-semaphore, make-lock, make-read-write-lock, process-input-wait, process-output-wait, with-terminal-input @@ -8931,5 +8988,5 @@
- +
Arguments and Values:

fd---a file descriptor, which is a non-negative integer @@ -8939,5 +8996,5 @@

- +
Description:

Wait until input is available on fd. @@ -8955,10 +9012,10 @@

- +
See Also:
make-lock, make-read-write-lock, make-semaphore, process-output-wait, with-terminal-input
- +
Notes:

@@ -8985,5 +9042,5 @@

- +
Arguments and Values:

fd---a file descriptor, which is a non-negative integer @@ -8993,5 +9050,5 @@

- +
Description:

Wait until output is possible on fd or until timeout, if @@ -9006,10 +9063,10 @@

- +
See Also:
make-lock, make-read-write-lock, make-semaphore, process-input-wait, with-terminal-input
- +
Notes:

@@ -9036,5 +9093,5 @@

- +
Arguments and Values:

body---an implicit progn.

@@ -9043,5 +9100,5 @@
- +
Description:

Requests exclusive read access to the standard terminal @@ -9051,5 +9108,5 @@

- +
See Also:
*request-terminal-input-via-break*, :y, make-lock, make-read-write-lock, make-semaphore, process-input-wait, process-output-wait @@ -9070,15 +9127,15 @@
- +
Value Type:

A boolean.

- +
Initial Value:

NIL.

- +
Description:

Controls how attempts to obtain ownership of terminal input @@ -9092,5 +9149,5 @@

- +
See Also:
with-terminal-input, :y, make-lock, make-read-write-lock, make-semaphore, process-input-wait, process-output-wait @@ -9111,5 +9168,5 @@
- +
Arguments and Values:

p---a lisp process (thread), designated either by @@ -9120,5 +9177,5 @@

- +
Description:

:Y is a toplevel command, not a function. As such, it @@ -9131,5 +9188,5 @@

- +
See Also:
with-terminal-input, *request-terminal-input-via-break*, make-lock, make-read-write-lock, make-semaphore, process-input-wait, process-output-wait @@ -9152,5 +9209,5 @@
- +
Arguments and Values:

process---a process, typically created by process-run-function or by make-process

@@ -9162,5 +9219,5 @@
- +
Description:

Waits for the specified process to terminate. If the @@ -9303,5 +9360,5 @@

- +
Arguments and Values:

address-family---The address/protocol family of this socket. Currently @@ -9403,5 +9460,5 @@

- +
Description:

Creates and returns a new socket

@@ -9422,5 +9479,5 @@
- +
Arguments and Values:

socket---The listener-socket to listen on.

@@ -9430,5 +9487,5 @@
- +
Description:

Extracts the first connection on the queue of pending @@ -9456,5 +9513,5 @@

- +
Arguments and Values:

dotted---A string representing an IP address in the @@ -9464,5 +9521,5 @@

- +
Description:

Converts a dotted-string representation of a host address to @@ -9484,5 +9541,5 @@

- +
Arguments and Values:

ipaddr---A 32-bit integer representing an internet host address

@@ -9493,5 +9550,5 @@
- +
Description:

Converts a 32-bit unsigned IP address into octets.

@@ -9512,5 +9569,5 @@
- +
Arguments and Values:

ipaddr---a 32-bit integer representing an internet host address

@@ -9519,5 +9576,5 @@
- +
Description:

Converts a 32-bit unsigned IP address into a host name @@ -9539,5 +9596,5 @@

- +
Arguments and Values:

host---Specifies the host. It can be either a host name @@ -9547,5 +9604,5 @@

- +
Description:

Converts a host spec in any of the acceptable formats into a @@ -9567,5 +9624,5 @@

- +
Arguments and Values:

port---Specifies the port. It can be either a string, such as @@ -9576,5 +9633,5 @@

- +
Description:

Finds the port number for the specified port and protocol

@@ -9596,5 +9653,5 @@
- +
Arguments and Values:

socket---The socket to read from

@@ -9613,5 +9670,5 @@
- +
Description:

Reads a UDP packet from a socket. If no packets are @@ -9650,5 +9707,5 @@

- +
Arguments and Values:

socket---The socket to write to

@@ -9665,5 +9722,5 @@
- +
Description:

Send a UDP packet over a socket.

@@ -9684,5 +9741,5 @@
- +
Arguments and Values:

socket---The socket to shut down (typically a tcp-stream)

@@ -9691,5 +9748,5 @@
- +
Description:

Shuts down part of a bidirectional connection. This is @@ -9712,10 +9769,10 @@

- +
Arguments and Values:

socket---The socket

- +
Description:

Returns the native OS's representation of the socket, or @@ -9742,10 +9799,10 @@

- +
Arguments and Values:

socket---The socket

- +
Description:

Returns the 32-bit unsigned IP address of the remote host, @@ -9767,10 +9824,10 @@

- +
Arguments and Values:

socket---The socket

- +
Description:

Returns the remote port number, or NIL if the socket is not @@ -9792,10 +9849,10 @@

- +
Arguments and Values:

socket---The socket

- +
Description:

Returns 32-bit unsigned IP address of the local host.

@@ -9816,10 +9873,10 @@
- +
Arguments and Values:

socket---The socket

- +
Description:

Returns the local port number

@@ -9840,10 +9897,10 @@
- +
Arguments and Values:

socket---The socket

- +
Description:

Returns :internet or :file, as appropriate.

@@ -9864,10 +9921,10 @@
- +
Arguments and Values:

socket---The socket

- +
Description:

Returns :active for tcp-stream, :passive for @@ -9889,10 +9946,10 @@

- +
Arguments and Values:

socket---The socket

- +
Description:

Returns the socket format as specified by the :format @@ -9914,10 +9971,10 @@

- +
Arguments and Values:

socket---The socket

- +
Description:

returns :stream for tcp-stream and listener-socket, and @@ -9938,10 +9995,10 @@

- +
Description:

The class of OS errors signaled by socket functions

- +
Superclasses:

simple-error

@@ -9962,10 +10019,10 @@
- +
Arguments and Values:

socket-error---the condition

- +
Description:

The OS error code of the error

@@ -9986,10 +10043,10 @@
- +
Arguments and Values:

socket-error---the condition

- +
Description:

A symbol representing the error code in a more @@ -10015,10 +10072,10 @@

- +
Arguments and Values:

socket-error---the condition

- +
Description:

A string describing the context where the error happened. On @@ -10041,5 +10098,5 @@

- +
Arguments and Values:

socket---The socket to close

@@ -10052,5 +10109,5 @@
- +
Description:

The close generic function can be applied to sockets. It @@ -10073,5 +10130,5 @@

- +
Arguments and Values:

var---variable to bind

@@ -10080,5 +10137,5 @@
- +
Description:

executes body with var bound to the result of applying @@ -10212,5 +10269,5 @@

- +
Arguments and Values:

program---A string or pathname which denotes an executable file. @@ -10263,5 +10320,5 @@

- +
Description:

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

- +
Arguments and Values:

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

@@ -10289,5 +10346,5 @@
- +
Description:

Sends the specified "signal" to the specified @@ -10312,10 +10369,10 @@

- +
Arguments and Values:

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

- +
Description:

Returns the process id assigned to @@ -10339,10 +10396,10 @@

- +
Arguments and Values:

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

- +
Description:

Returns the stream created when the input argument to @@ -10365,10 +10422,10 @@

- +
Arguments and Values:

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

- +
Description:

Returns the stream created when the output argument to @@ -10392,10 +10449,10 @@

- +
Arguments and Values:

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

- +
Description:

Returns the stream created when the error argument to @@ -10419,10 +10476,10 @@

- +
Arguments and Values:

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

- +
Description:

Returns, as multiple values, a keyword denoting the status @@ -10454,5 +10511,5 @@

- 9.1.1. Stream External Format + 9.1.1. Stream External Format
@@ -10522,5 +10579,5 @@
-

9.1.1. Stream External Format

+

9.1.1. Stream External Format

@@ -10685,10 +10742,10 @@
- - - - - - + + + + + +

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

- +
Values:

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

- +
Description:

Returns a list of open file streams.

- +
See Also:
note-open-file-stream, remove-open-file-stream @@ -10778,10 +10835,10 @@
- +
Arguments:

file-stream---A file stream.

- +
Description:

Adds a file stream to the internal list of open @@ -10792,5 +10849,5 @@

- +
See Also:
open-file-streams, remove-open-file-stream @@ -10815,10 +10872,10 @@
- +
Arguments:

file-stream---A file stream.

- +
Description:

Remove file stream from the internal list of open file @@ -10829,5 +10886,5 @@

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

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

@@ -11273,5 +11330,5 @@
- +
Description:

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

- +
Arguments and Values:

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

@@ -11305,5 +11362,5 @@
- +
Description:

should try to write the first count elements of list to @@ -11325,5 +11382,5 @@

- +
Arguments and Values:

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

@@ -11341,5 +11398,5 @@
- +
Description:

should try to read successive elements from stream into @@ -11364,5 +11421,5 @@

- +
Arguments and Values:

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

@@ -11380,5 +11437,5 @@
- +
Description:

should try to write successive elements of vector to stream, @@ -11402,5 +11459,5 @@

- +
Method Signatures:
ccl::stream-device @@ -11408,5 +11465,5 @@
- +
Arguments and Values:

s---a stream.

@@ -11419,5 +11476,5 @@
- +
Description:

Returns the file descriptor associated with @@ -11443,5 +11500,5 @@

- +
Description:

Reads up to max-octets octets from stream into ivector, @@ -11450,5 +11507,5 @@

- +
Arguments:

stream---An input stream. The method defined on @@ -11475,5 +11532,5 @@

- +
Description:

Writes max-octets octets to stream from ivector, starting at @@ -11481,5 +11538,5 @@

- +
Arguments:

stream---An input stream. The method defined on @@ -11491,5 +11548,5 @@

- +
Examples:
@@ -12657,5 +12714,5 @@

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

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

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

@@ -13753,5 +13810,5 @@
-

12.3.2.4. %int-to-ptr [Function]

+

12.3.2.4. %int-to-ptr [Function]

@@ -13794,5 +13851,5 @@
-

12.3.2.5. %inc-ptr [Function]

+

12.3.2.5. %inc-ptr [Function]

@@ -13844,5 +13901,5 @@
-

12.3.2.6. %ptr-to-int [Function]

+

12.3.2.6. %ptr-to-int [Function]

@@ -13886,5 +13943,5 @@
-

12.3.2.7. %null-ptr [Macro]

+

12.3.2.7. %null-ptr [Macro]

@@ -13911,5 +13968,5 @@
-

12.3.2.8. %null-ptr-p [Function]

+

12.3.2.8. %null-ptr-p [Function]

@@ -13953,5 +14010,5 @@
-

12.3.2.9. %setf-macptr [Function]

+

12.3.2.9. %setf-macptr [Function]

@@ -14001,5 +14058,5 @@
-

12.3.2.10. %incf-ptr [Macro]

+

12.3.2.10. %incf-ptr [Macro]

@@ -14049,5 +14106,5 @@
-

12.3.2.11. with-macptrs [Macro]

+

12.3.2.11. with-macptrs [Macro]

@@ -14099,5 +14156,5 @@
-

12.3.2.12. %stack-block [Macro]

+

12.3.2.12. %stack-block [Macro]

@@ -14150,5 +14207,5 @@
-

12.3.2.13. make-cstring [Function]

+

12.3.2.13. make-cstring [Function]

@@ -14193,5 +14250,5 @@
-

12.3.2.14. with-cstrs [Macro]

+

12.3.2.14. with-cstrs [Macro]

@@ -14243,5 +14300,5 @@
-

12.3.2.15. with-encoded-cstrs [Macro]

+

12.3.2.15. with-encoded-cstrs [Macro]

@@ -14306,5 +14363,5 @@
-

12.3.2.16. %get-cstring [Function]

+

12.3.2.16. %get-cstring [Function]

@@ -14348,5 +14405,5 @@
-

12.3.2.17. %str-from-ptr [Function]

+

12.3.2.17. %str-from-ptr [Function]

@@ -15794,5 +15851,5 @@
- +
Description:

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

- +
Description:

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

- +
Description:

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

- +
Description:

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

- +
Description:

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

- +
Values:

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

- +
Description:

If completely is T, sets the @@ -16120,5 +16177,5 @@

- +
Values:

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

@@ -16137,5 +16194,5 @@
- +
Description:

Proclaims name @@ -16173,5 +16230,5 @@

- +
Values:

name---NIL or a keyword; the keyword may contain @@ -16181,5 +16238,5 @@

- +
Description:

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

- +
Values:

name--- @@ -16228,5 +16285,5 @@

- +
Description:

If there is already an EXTERNAL-ENTRY-POINT for @@ -16256,5 +16313,5 @@

- +
Values:

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

@@ -16269,5 +16326,5 @@
- +
Description:

Calls the foreign function at the address obtained by @@ -16296,5 +16353,5 @@

- +
Values:

entrypoint---A fixnum or MACPTR

@@ -16307,5 +16364,5 @@
- +
Description:

Calls the foreign function at address entrypoint passing the @@ -16333,5 +16390,5 @@

- +
Values:

entrypoint---A fixnum or MACPTR

@@ -16346,5 +16403,5 @@
- +
Description:

Calls the foreign function at address entrypoint passing the @@ -16371,10 +16428,10 @@

- +
Values:

name---A lisp string.

- +
Description:

Tries to resolve the address of the foreign symbol @@ -16399,10 +16456,10 @@

- +
Values:

name---A lisp string.

- +
Description:

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

- +
Values:

ptr---A MACPTR that points to a block of @@ -16432,5 +16489,5 @@

- +
Description:

In CCL 1.2 and later, the CCL:FREE @@ -16464,5 +16521,5 @@

- +
Values:

element-count---A positive integer.

@@ -16479,5 +16536,5 @@
- +
Description:

@@ -16514,5 +16571,5 @@

- +
Values:

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

- +
Description:

@@ -16580,5 +16637,5 @@

- +
Values:

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

- +
Description:

@@ -16635,5 +16692,5 @@

- +
Notes:

@@ -16668,5 +16725,5 @@

- +
Values:

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

- +
Description:

If the library denoted by name can @@ -16687,5 +16744,5 @@

- +
Examples:
;;; Try to do something simple.
@@ -16722,5 +16779,5 @@
- +
Notes:

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

- +
Values:

ptr---a MACPTR.

@@ -16753,5 +16810,5 @@
- +
Description:

References an instance of a foreign type (or a component of @@ -16779,5 +16836,5 @@

- +
Values:

eep---An EXTERNAL-ENTRY-POINT, as obtained by the EXTERNAL @@ -16785,5 +16842,5 @@

- +
Description:

Tries to resolve the address of the EXTERNAL-ENTRY-POINT @@ -16808,5 +16865,5 @@

- +
Values:

var---A symbol (a lisp variable)

@@ -16816,5 +16873,5 @@
- +
Description:

Executes body @@ -16846,5 +16903,5 @@

- +
Values:

var---A symbol (a lisp variable)

@@ -16853,5 +16910,5 @@
- +
Description:

Executes body in an environment in which each var is @@ -16880,5 +16937,5 @@

- +
Values:

object---A CLOS object of a class for which there exists @@ -16888,5 +16945,5 @@

- +
Description:

@@ -16925,5 +16982,5 @@

- +
Example:
@@ -16939,5 +16996,5 @@
- +
See Also:
@@ -16961,5 +17018,5 @@
- +
Values:

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

- +
Description:

Tells CCL to remove the interface directory denoted by @@ -16992,5 +17049,5 @@

- +
Values:

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

- +
Description:

Tells CCL to add the interface directory denoted by @@ -17021,5 +17078,5 @@

- +
Examples:

One typically wants interface information to be @@ -18674,5 +18731,5 @@

- +
Arguments and Values:

name---a string which is the name of an existing @@ -18684,5 +18741,5 @@

- +
Description:

@@ -18705,5 +18762,5 @@

- +
Arguments and Values:

name---a string which is the name of a new or existing @@ -18718,5 +18775,5 @@

- +
Description:

@@ -18742,5 +18799,5 @@

- +
Values:

path---a string, an absolute pathname in Posix format - with @@ -18748,5 +18805,5 @@

- +
Description:

@@ -18770,5 +18827,5 @@

- +
Values:

uid---a non-negative integer, identifying a specific user @@ -18776,5 +18833,5 @@

- +
Description:

@@ -18796,5 +18853,5 @@

- +
Arguments and Values:

uid---a non-negative integer, identifying a specific user @@ -18805,5 +18862,5 @@

- +
Description:

@@ -18828,5 +18885,5 @@

- +
Arguments and Values:

gid---a non-negative integer, identifying a specific @@ -18837,5 +18894,5 @@

- +
Description:

@@ -18860,10 +18917,10 @@

- +
Values:

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

- +
Description:

@@ -18886,5 +18943,5 @@

- +
Values:

uid---a non-negative integer, identifying a specific user @@ -18894,5 +18951,5 @@

- +
Description:

@@ -18919,5 +18976,5 @@

- +
Values:

command-line---a string, obeying all the whitespace and @@ -18928,5 +18985,5 @@

- +
Description:

@@ -18944,5 +19001,5 @@

- +
Notes:

@@ -18969,5 +19026,5 @@

- +
Arguments and Values:

class-name---a string which denotes an existing class name, or a @@ -18976,5 +19033,5 @@

- +
Description:

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

- +
Arguments and Values:

string---a string constant, used to canonically refer to an @@ -19007,5 +19064,5 @@

- +
Description:

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

- +
Arguments and Values:

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

- +
Description:

Defines an Objective-C-callable method which implements @@ -19076,5 +19133,5 @@

- +
Arguments and Values:

selector---either a string which represents the name of the @@ -19091,5 +19148,5 @@

- +
Description:

Defines an ObjC-callable method which implements the @@ -19112,10 +19169,10 @@

- +
Arguments and Values:

As per DEFINE-OBJC-METHOD

- +
Description:

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

- +
Description:

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

- +
Description:

Per ANSI CL, Clozure CL supports the :EXTERNAL-FORMAT keyword @@ -19238,5 +19295,5 @@

- +
Description:

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

- +
Superclasses:

NS:NS-STRING

- +
Initargs:

:string--- @@ -19275,5 +19332,5 @@

- +
Description:

@@ -19293,5 +19350,5 @@

- +
Examples:

@@ -19324,5 +19381,5 @@

- +
Notes:

@@ -19664,5 +19721,5 @@

- +
Arguments and Values:

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

@@ -19672,5 +19729,5 @@
- +
Description:

Creates a new population of the specified type.

@@ -19690,5 +19747,5 @@
- +
Description:

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

@@ -19708,5 +19765,5 @@
- +
Description:

returns the list encapsulated in population. @@ -19731,5 +19788,5 @@

- +
Description:

Sets the list encapsulated in population to @@ -19764,5 +19821,5 @@

- +
Description:

Returns the value of the kernel variable that specifies the @@ -19785,10 +19842,10 @@

- +
Arguments and Values:

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

- +
Description:

Sets the value of the kernel variable that specifies the @@ -19814,5 +19871,5 @@

- +
Description:

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

- +
Arguments and Values:

arg---a generalized boolean

- +
Description:

Enables the EGC if arg is non-nil, disables the EGC @@ -19865,5 +19922,5 @@

- +
Description:

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

- +
Description:

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

- +
Description:

Returns, as multiple values, the sizes in kilobytes of the @@ -19935,5 +19992,5 @@

- +
Arguments and Values:

generation-0-size---the requested threshold size of the youngest @@ -19945,5 +20002,5 @@

- +
Description:

Puts the indicated threshold sizes in effect. @@ -19969,10 +20026,10 @@

- +
Arguments and Values:

arg---a generalized boolean

- +
Description:

Tries to influence the GC to retain/recycle the pages @@ -19999,5 +20056,5 @@

- +
Description:

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

- 16.7.2. Recommended Reading + 16.7.2. Recommended Reading
@@ -21430,5 +21487,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 @@ -21563,5 +21620,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".

    @@ -21623,5 +21680,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.

    @@ -21670,5 +21727,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. @@ -21691,5 +21748,5 @@
    -

    [2] This is +

    [2] This is sometimes called "The Write Barrier": all assignments which might result in intergenerational references must be noted, as @@ -21697,5 +21754,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 @@ -21813,5 +21870,5 @@

    -

    16.7.2. Recommended Reading

    +

    16.7.2. Recommended Reading

    @@ -22226,5 +22283,5 @@
    - +
    Description:

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

    - +
    Description:

    Arranges that the outermost special bindings of *PACKAGE* @@ -22275,5 +22332,5 @@

    - +
    Description:

    Arranges that the outermost special bindings of *PACKAGE* @@ -22298,5 +22355,5 @@

    - +
    Description:

    This variable is initialized each time an Clozure CL session @@ -22323,5 +22380,5 @@

    - +
    Description:

    Returns non-NIL if AltiVec is available.

    @@ -22341,5 +22398,5 @@
    - +
    Description:

    Intended to control the expansion of certain lap macros. @@ -22363,5 +22420,5 @@

    - +
    Arguments and Values:

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

    @@ -22369,5 +22426,5 @@
    - +
    Description:

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

    - +
    Arguments and Values:

    base---Any available general-purpose register.

    @@ -22404,5 +22461,5 @@
    - +
    Description:

    Generates code which allocates a 16-byte aligned buffer @@ -23051,4 +23108,5 @@

    unuse-interface-dir, Function UNUSE-INTERFACE-DIR
    unwatch, Function UNWATCH
    +
    unwind-protect, Special operator UNWIND-PROTECT
    use-interface-dir, Function USE-INTERFACE-DIR
    use-lisp-heap-gc-threshold, Function USE-LISP-HEAP-GC-THRESHOLD
    @@ -23062,4 +23120,5 @@
    watch, Function WATCH
    with-altivec-registers, LAP Macro WITH-ALTIVEC-REGISTERS
    +
    with-interrupts-enabled, Macro WITH-INTERRUPTS-ENABLED
    with-lock-grabbed, Macro WITH-LOCK-GRABBED
    with-open-socket, Macro WITH-OPEN-SOCKET
    @@ -23080,5 +23139,5 @@ Symbol Index
    -

    This document was last modified at 4:0 on December 23, 2010, in UTC.

    It uses version 1.75.2 of the Norman Walsh Docbook stylesheets.

    Built from subversion rev 14508

    Using libxml 20706, libxslt 10126 and libexslt 815.

    +

    This document was last modified at 18:0 on December 30, 2010, in UTC.

    It uses version 1.75.2 of the Norman Walsh Docbook stylesheets.

    Built from subversion rev 14529

    Using libxml 20706, libxslt 10126 and libexslt 815.