This is the org-davep-dict Reference Manual, version 2.3, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 17:29:27 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
org-davep-dictRFC2229 client for Common Lisp.
Dave Pearson <davep@davep.org>
Dave Pearson <davep@davep.org>
LLGPL
org-davep-dict provides a set of RFC 2229 client classes, functions and macros
for Common Lisp. See See <URL:http://www.dict.org/> for more
details about dict servers and clients.
See <URL:http://www.davep.org/lisp/#org-davep-dict> for the latest version of this package.
2.3
split-sequence (system).
acl-compat (system).
cl-ppcre (system).
packages.lisp (file).
dict.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
org-davep-dict/org-davep-dict.asdorg-davep-dict (system).
org-davep-dict/dict.lisppackages.lisp (file).
org-davep-dict (system).
*default-client-id* (special variable).
*default-dict-host* (special variable).
*default-dict-port* (special variable).
+all-db+ (constant).
+default-match-strategy+ (constant).
+exact-match-strategy+ (constant).
+first-db+ (constant).
+prefix-match-strategy+ (constant).
banner (reader method).
(setf banner) (writer method).
capabilities (reader method).
(setf capabilities) (writer method).
code (reader method).
(setf code) (writer method).
connect (method).
connect (method).
connectedp (method).
data (reader method).
(setf data) (writer method).
database (reader method).
(setf database) (writer method).
databases (method).
define (method).
definition (reader method).
(setf definition) (writer method).
definition-as-string (method).
description (reader method).
(setf description) (writer method).
disconnect (method).
disconnect (method).
host (reader method).
(setf host) (writer method).
info (method).
make-dict-client (function).
match (method).
message-id (reader method).
(setf message-id) (writer method).
name (reader method).
name (reader method).
(setf name) (writer method).
(setf name) (writer method).
port (reader method).
(setf port) (writer method).
print-object (method).
print-object (method).
print-object (method).
print-object (method).
response (reader method).
(setf response) (writer method).
see-also (method).
server-details (reader method).
(setf server-details) (writer method).
server-help (method).
server-info (method).
strategies (method).
with-dict-client (macro).
word (reader method).
(setf word) (writer method).
cap-string->keyword-list (function).
completion-reply-p (method).
connected-check (method).
dict-client (class).
dict-client-response (class).
dict-general-info (class).
dict-word-definition (class).
end-of-data-p (function).
errorp (method).
get-line (method).
get-line (method).
get-long-response (method).
get-short-response (method).
info-command (method).
intermediate-reply-p (method).
keyword->dict-string (function).
long-command (method).
permanent-error-p (method).
populate-slots-from-banner (method).
preliminary-reply-p (method).
put-line (method).
put-line (method).
read-definition (method).
read-info (method).
read-response (method).
read-string-as-list (function).
read-string-as-list-preserving-case (function).
read-word (method).
short-command (method).
socket (reader method).
(setf socket) (writer method).
temporary-error-p (method).
with-safe-reading (macro).
Packages are listed by definition order.
org.davep.dictRFC 2229 client classes, functions and macros
dict
dict-client
rfc2229-client
cl-ppcre.
common-lisp.
split-sequence.
*default-client-id* (special variable).
*default-dict-host* (special variable).
*default-dict-port* (special variable).
+all-db+ (constant).
+default-match-strategy+ (constant).
+exact-match-strategy+ (constant).
+first-db+ (constant).
+prefix-match-strategy+ (constant).
banner (generic reader).
(setf banner) (generic writer).
capabilities (generic reader).
(setf capabilities) (generic writer).
code (generic reader).
(setf code) (generic writer).
connect (generic function).
connectedp (generic function).
data (generic reader).
(setf data) (generic writer).
database (generic reader).
(setf database) (generic writer).
databases (generic function).
define (generic function).
definition (generic reader).
(setf definition) (generic writer).
definition-as-string (generic function).
description (generic reader).
(setf description) (generic writer).
disconnect (generic function).
host (generic reader).
(setf host) (generic writer).
info (generic function).
make-dict-client (function).
match (generic function).
message-id (generic reader).
(setf message-id) (generic writer).
name (generic reader).
(setf name) (generic writer).
port (generic reader).
(setf port) (generic writer).
response (generic reader).
(setf response) (generic writer).
see-also (generic function).
server-details (generic reader).
(setf server-details) (generic writer).
server-help (generic function).
server-info (generic function).
strategies (generic function).
with-dict-client (macro).
word (generic reader).
(setf word) (generic writer).
cap-string->keyword-list (function).
completion-reply-p (generic function).
connected-check (generic function).
dict-client (class).
dict-client-response (class).
dict-general-info (class).
dict-word-definition (class).
end-of-data-p (function).
errorp (generic function).
get-line (generic function).
get-long-response (generic function).
get-short-response (generic function).
info-command (generic function).
intermediate-reply-p (generic function).
keyword->dict-string (function).
long-command (generic function).
permanent-error-p (generic function).
populate-slots-from-banner (generic function).
preliminary-reply-p (generic function).
put-line (generic function).
read-definition (generic function).
read-info (generic function).
read-response (generic function).
read-string-as-list (function).
read-string-as-list-preserving-case (function).
read-word (generic function).
short-command (generic function).
socket (generic reader).
(setf socket) (generic writer).
temporary-error-p (generic function).
with-safe-reading (macro).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Database name to use when all definitions/matches are required.
Match strategy name meaning "the server’s default".
Match strategy name for an exact match.
Database name to use when the first definition/match is required.
Match strategy name for a prefix match.
The default client ID that will be announced to the dictionary server.
If you would prefer that your application announces itself in a different way then you should modify the value of this variable.
Host name to use when a default host is required.
Port to use when a default port is required.
Create a dictionary client called CLIENT and evaluate BODY.
Create a dictionary client.
dict-client)) ¶dict-client)) ¶The banner message we got when connected to the host.
This slot, when populated, is a ‘DICT-CLIENT-RESPONSE’ object.
dict-client)) ¶dict-client)) ¶Server’s capability list. A list of keywords.
dict-client-response)) ¶dict-client-response)) ¶The numeric code associated with the response.
dict-client)) ¶Connect the dictionary client to the dictionary server.
dict-client)) ¶Ensure that we’re not already connected.
dict-client)) ¶Is DICT-CLIENT connected to a dictionary server?
dict-client-response)) ¶dict-client-response)) ¶Any data associated with the response.
dict-word-definition)) ¶dict-word-definition)) ¶The name of the database that the definition came from.
dict-client)) ¶Get a list of databases available on the server.
An object of the class ‘DICT-CLIENT-RESPONSE’ is returned.
dict-client) (word string) &key database) ¶Define a word.
A list of definitions is returned, the list being empty if no definitions are found. Where definitions are found the list comprised of objects of the class ‘DICT-WORD-DEFINITION’.
dict-word-definition)) ¶dict-word-definition)) ¶The definition of the word.
This is a list of strings, each item in the list is a line from the
definition.
dict-word-definition) &key strip-leading-whitespace) ¶Return the text of DEFINITION as a string.
dict-general-info)) ¶dict-general-info)) ¶The description attribute of the information item.
dict-client)) ¶Disconnect the dictionary client from the dictionary server.
dict-client)) ¶Ensure that we’re connected before we disconnect.
dict-client)) ¶dict-client)) ¶The name of the dictionary host that the client will connect to. The default value for this slot is the value of ‘*DEFAULT-DICT-HOST*’.
dict-client) (database string)) ¶Get information about DATABASE.
An object of the class ‘DICT-CLIENT-RESPONSE’ is returned.
dict-client) (word string) &key database strategy) ¶Match a word.
An object of the class ‘DICT-CLIENT-RESPONSE’ is returned.
dict-client)) ¶dict-client)) ¶The message ID given to us after a successful connection.
dict-word-definition)) ¶dict-word-definition)) ¶The long name of the database that the definition came from.
dict-general-info)) ¶dict-general-info)) ¶The name attribute of the information item.
dict-client)) ¶dict-client)) ¶The number of the port that the client will connect to.
The default value for this slot is the value of ‘*DEFAULT-DICT-PORT*’.
dict-client-response)) ¶dict-client-response)) ¶The text of the response received from the server.
dict-word-definition)) ¶Get a list of "see also" items for the definition.
dict-client)) ¶dict-client)) ¶The server details as pulled from the banner after a successful connection.
dict-client)) ¶Request help from the dictionary server.
An object of the class ‘DICT-CLIENT-RESPONSE’ is returned.
dict-client)) ¶Get information about the server.
An object of the class ‘DICT-CLIENT-RESPONSE’ is returned.
dict-client)) ¶Get a list of strategies available on the server.
An object of the class ‘DICT-CLIENT-RESPONSE’ is returned.
dict-word-definition)) ¶dict-word-definition)) ¶The word that is being defined.
dict-general-info) (stream stream)) ¶Format the INFO for easy reading when output to STREAM.
dict-client) (stream stream)) ¶Format the DICT-CLIENT for easy reading when output to STREAM.
dict-word-definition) (stream stream)) ¶Format the DICT-WORD-DEFINITION for easy reading when output to STREAM.
dict-client-response) (stream stream)) ¶Format the DICT-CLIENT-RESPONSE for easy reading when output to STREAM.
Convert CAP-STRING to a list of keywords.
Is LINE an end of data marker?
Convert KEYWORD into a dict string constant.
Take STRING and read it as a list.
Take STRING and read it as a list while preserving case.
dict-client-response)) ¶Is RESPONSE a completion reply?
dict-client)) ¶Check that DICT-CLIENT is connected to a server, error if not.
dict-client-response)) ¶Is RESPONSE any kind of error?
dict-client)) ¶Read a line from the dictionary server.
dict-client)) ¶Ensure that we’re connected before getting a line.
dict-client)) ¶Get a long (multi line) response from the dict server.
dict-client)) ¶Get a short (one line) response from the dict server.
dict-client) (command string)) ¶Send COMMAND to the server and grahter up the resulting information.
dict-client-response)) ¶Is RESPONSE an intermediate reply?
dict-client) (command string)) ¶Send COMMAND to server and get its multi-line response.
dict-client-response)) ¶Is RESPONSE a permanent error?
dict-client)) ¶Populate various slots from the banner.
DICT-CLIENT is returned.
dict-client-response)) ¶Is RESPONSE a preliminary reply?
dict-client) (line string)) ¶Send a line to the dict server.
dict-client) (line string)) ¶Ensure that we’re connected before putting a line.
dict-word-definition) (dict-client dict-client)) ¶Read the definition of a word from DICT-CLIENT.
dict-general-info) (text string)) ¶Break up TEXT and populate the slots in INFO.
INFO is returned.
dict-client-response) (text string)) ¶Break up the response TEXT and populate the slots in RESPONSE.
RESPONSE is returned.
dict-word-definition) (header dict-client-response)) ¶Break up the HEADER and populate the slots in DEFINITION.
DEFINITION is returned.
dict-client) (command string)) ¶Send COMMAND to server and get its single line response.
dict-client)) ¶dict-client)) ¶The socket used to talk to the host.
dict-client-response)) ¶Is RESPONSE a temporary error?
RFC2229 client class.
This class has the following slots:
HOST - The name of the dictionary host.
PORT - The dictionary port on the host.
SOCKET - When connected this is the socket stream that is being used.
BANNER - An instance of ‘DICT-CLIENT-RESPONSE’ that contains the
banner we got from the dictionary server when we connected.
SERVER-DETAILS - The server details as pulled from the BANNER.
CAPABILITIES - List of server capabilities as pulled from the BANNER.
MESSAGE-ID - The message-ID for this connection as pulled from the BANNER.
Methods associated with this class are:
CONNECTEDP - Check if the client is connected.
CONNECT - Connect to the server.
DISCONNECT - Disconnect from the server.
DEFINE - Get the defintions for a word.
MATCH - Get a list of matches for a word.
DATABASES - Get a list of databases on the server.
STRATAGIES - Get a list of matching stratagies supported by the server.
INFO - Get information about a database.
SERVER-HELP - Get the help text of the server.
SERVER-INFO - Get information about the server.
Functions associted with this class are:
MAKE-DICT-CLIENT - Create a dictionary client object.
(setf banner).
banner.
(setf capabilities).
capabilities.
connect.
connect.
connected-check.
connectedp.
databases.
define.
disconnect.
disconnect.
get-line.
get-line.
get-long-response.
get-short-response.
(setf host).
host.
info.
info-command.
long-command.
match.
(setf message-id).
message-id.
populate-slots-from-banner.
(setf port).
port.
print-object.
put-line.
put-line.
read-definition.
(setf server-details).
server-details.
server-help.
server-info.
short-command.
(setf socket).
socket.
strategies.
The name of the dictionary host that the client will connect to. The default value for this slot is the value of ‘*DEFAULT-DICT-HOST*’.
string
org.davep.dict:*default-dict-host*
:host
host.
The number of the port that the client will connect to.
The default value for this slot is the value of ‘*DEFAULT-DICT-PORT*’.
integer
org.davep.dict:*default-dict-port*
:port
port.
The socket used to talk to the host.
(or null stream)
The banner message we got when connected to the host.
This slot, when populated, is a ‘DICT-CLIENT-RESPONSE’ object.
(or null org.davep.dict::dict-client-response)
The server details as pulled from the banner after a successful connection.
string
""
Server’s capability list. A list of keywords.
list
The message ID given to us after a successful connection.
string
""
Class to hold a response from a dictionary server.
This class has three slots:
CODE - The numeric code associated with the response. RESPONSE - The text of the response received from the server. DATA - Any data associated with the response.
The text of the response received from the server.
string
Class to hold general information returned from the server.
This class is used for holding general information that is returned from the
dictionary server, this includes things like items in the list of databases
or the list of match stratagies.
This class has two slots:
NAME - The name attribute of the information item.
DESCRIPTION - The description attribute of the information item.
Class to hold a word definition.
This class is used to hold a word definition, it has the following slots:
WORD - The word that is being defined.
DATABASE - The name of the database that the definition came from.
NAME - The long name of the database that the definition came from.
DEFINITION - The definition of the word. This is a list of strings, each
item in the list is a line from the definition.
Methods associated with this class are:
SEE-ALSO - Get a list of links found in the defintion.
The name of the database that the definition came from.
string
The long name of the database that the definition came from.
string
name.
The definition of the word.
This is a list of strings, each item in the list is a line from the
definition.
list
| Jump to: | (
B C D E F G H I K L M N P R S T W |
|---|
| Jump to: | (
B C D E F G H I K L M N P R S T W |
|---|
| Jump to: | *
+
B C D H M N P R S W |
|---|
| Jump to: | *
+
B C D H M N P R S W |
|---|
| Jump to: | C D F O P S |
|---|
| Jump to: | C D F O P S |
|---|