Star Sapphire Common LISP Home

Download Star Saphire
Index

LISP: HASH-TABLE

[Typespec][CLTL 4]

SYNOPSIS:

hash-table

DESCRIPTION:

This is the type specifier symbol for hash tables, the LISP object which. is created by make-hash-table.

 

LISP: HASH-TABLE-COUNT

C: Lhash_table_count

min args: 1

max args: 1

[F][CLTL 16]

SYNOPSIS:

hash-table-count hash-table

DESCRIPTION:

This function returns the number of entries in hash table. When a hash table has been created or cleared, the number of entries will be zero.

 

LISP: HASH-TABLE-P

C: htp

min args: 1

max args: 1

[F][CLTL 16]

SYNOPSIS:

hash-table-p object

DESCRIPTION:

The hash-table-p predicate returns true if its argument is a hash table and nil otherwise.

(hash-table-p x) == (typep x 'hash-table)

 

LISP: HASH-TABLE-REHASH-SIZE

C: Lhtrehsz

min args: 1

max args: 1

[F][CLTL 16]

SYNOPSIS:

hash-table-rehash-size hash-table

DESCRIPTION:

This ANSI Common LISP function returns the current rehash size of a hash table.

 

LISP: HASH-TABLE-REHASH-THRESHOLD

C: Lhtrehth

min args: 1

max args: 1

[F][CLTL 16]

SYNOPSIS:

hash-table-rehash-threshold hash-table

DESCRIPTION:

This ANSI Common LISP function returns the current rehash threshold of a hash table.

 

LISP: HASH-TABLE-SIZE

C: Lhttabsz

min args: 1

max args: 1

[F][CLTL 16]

SYNOPSIS:

hash-table-size hash-table

DESCRIPTION:

This ANSI Common LISP function returns the current size of a hash table.

 

LISP: HASH-TABLE-TEST

C: Lhttabts

min args: 1

max args: 1

[F][CLTL 16]

SYNOPSIS:

hash-table-test hash-table

DESCRIPTION:

This ANSI Common LISP function returns the current predicate the hash table uses to compare keys.

NOTES:

A slight difference between Star Sapphire and ANSI should be noted. The test is returned just as it was specified when the hash table was made; ANSI specifies that it will be returned as a symbol if it is eq, eql, equal, or equalp. For instance, Star Sapphire will return the functional object #'equal if the test was specified as :test #'equal in the make-hash-table call.

 

LISP: HASHSIGN

C: Lhashsign

min args: 0

max args: -1

[F][SSCL]

SYNOPSIS:

hashsign

DESCRIPTION:

This is an internal function which is used to parse backquotes. It is an error to call this function.

 

LISP: HELP

C: LispHelp

min args: 0

max args: 0

[F][SSCL]

SYNOPSIS:

help &optional topic

DESCRIPTION:

This function just starts the help system without inquiring about a specific topic (see apropos). If the hypertext has not previously been loaded in a given session, help initializes the database which may take a moment; if the hypertext has been initialized already, the help system starts immediately.

If an optional topic is provided, then help tries to load the specified topic.

NOTES:

The F1 key yields help in most Star Sapphire subsystems including the help system itself. The F1 key is set to expand into the form (help) in init.lsp; therefore pressing F1 in the intepreter will get you into the help system.

SEE ALSO:

qhelp

 

LISP: HISTORY

C: Lhistory

min args: 0

max args: 1

[F][SSCL]

SYNOPSIS:

history &optional resize

DESCRIPTION:

When the history mechanism is on, the arrow keys allow recalling and editing of previously typed lines at the interpreter prompt. This mechanism is on by default at startup.

The following keys work when history is activated:

Esc: Discard current line

Up arrow, Down arrow: Recall previous line

Left arrow, Right arrow: Move cursor left or right to allow editing

Ins: Turn on insert mode

Del: Delete character at cursor.

Backspace: Works normally in non-insert mode, like Del in insert mode.

When in insert mode, the cursor shape changes to a half-sized cursor.

The history function is the LISP interface to interpreters' history mechanism:

If no args, prints a listing of the history to stdout.

If one argument, that argument must be a fixnum, nil or t.

If t and history accumulation was previously off, turns it back on intact.

If nil and history accumulation is on, turns it off.

If one arg, and argument is greater than 0, clones a new history with given size.

If the argument is 0, turns history accumulation off (like nil).

Note that turning history off does not otherwise alter the history list or access thereto; when history is turned back on it will have the contents it did before it was turned off.

Return value is t if successful, nil if not.

(the return will be nil if

given a fixnum arg less than 0 or

given nil and history accumulation was off or

given t and history accumulation was on).

 

NOTES:

This Star Sapphire specific function is not yet supported in the Windows version but is intended to be supported at release. This documentation is left here as a placeholder.