The org-davep-dict Reference Manual

Table of Contents

The org-davep-dict Reference Manual

This is the org-davep-dict Reference Manual, version 2.3, generated automatically by Declt version 3.0 "Montgomery Scott" on Fri Jun 26 11:52:56 2020 GMT+0.

1 Introduction

org-davep-dict

RFC2229 client for Common Lisp.

Commentary

The following code provides a set of RFC 2229 client classes, functions and macros for Common Lisp. See http://www.dict.org/ for more details about dictd.

See https://github.com/davep/org-davep-dictrepl as a quick example of how this code might be used.

TODO

• Add support for AUTH.

2 Systems

The main system appears first, followed by any subsystem dependency.

2.1 org-davep-dict

Maintainer

Dave Pearson <davep@davep.org>

Author

Dave Pearson <davep@davep.org>

License

LLGPL

Description

RFC2229 client for Common Lisp.

Long Description

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.

Version

2.3

Dependencies

• split-sequence
• acl-compat
• cl-ppcre

Source

org-davep-dict.asd (file)

Components

• packages.lisp (file)
• dict.lisp (file)

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.

3.1 Lisp

3.1.1 org-davep-dict.asd

Location

org-davep-dict.asd

Systems

org-davep-dict (system)

Packages

org-davep-dict-system

3.1.2 org-davep-dict/packages.lisp

Parent

org-davep-dict (system)

Location

packages.lisp

Packages

org.davep.dict

3.1.3 org-davep-dict/dict.lisp

Dependency

packages.lisp (file)

Parent

org-davep-dict (system)

Location

dict.lisp

Exported Definitions

• *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 (method)
• (setf banner) (method)
• capabilities (method)
• (setf capabilities) (method)
• code (method)
• (setf code) (method)
• connect (method)
• connect (method)
• connectedp (method)
• data (method)
• (setf data) (method)
• database (method)
• (setf database) (method)
• databases (method)
• define (method)
• definition (method)
• (setf definition) (method)
• definition-as-string (method)
• description (method)
• (setf description) (method)
• disconnect (method)
• disconnect (method)
• host (method)
• (setf host) (method)
• info (method)
• make-dict-client (function)
• match (method)
• message-id (method)
• (setf message-id) (method)
• name (method)
• (setf name) (method)
• name (method)
• (setf name) (method)
• port (method)
• (setf port) (method)
• response (method)
• (setf response) (method)
• see-also (method)
• server-details (method)
• (setf server-details) (method)
• server-help (method)
• server-info (method)
• strategies (method)
• with-dict-client (macro)
• word (method)
• (setf word) (method)

Internal Definitions

• 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 (method)
• (setf socket) (method)
• temporary-error-p (method)
• with-safe-reading (macro)

4 Packages

Packages are listed by definition order.

4.1 org-davep-dict-system

Source

org-davep-dict.asd

Use List

• asdf/interface
• common-lisp

4.2 org.davep.dict

RFC 2229 client classes, functions and macros

Source

packages.lisp (file)

Nicknames

• rfc2229-client
• dict-client
• dict

Use List

• cl-ppcre
• split-sequence
• common-lisp

Exported Definitions

• *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 function)
• banner (method)
• (setf banner) (method)
• (setf banner) (generic function)
• capabilities (generic function)
• capabilities (method)
• (setf capabilities) (method)
• (setf capabilities) (generic function)
• code (generic function)
• code (method)
• (setf code) (method)
• (setf code) (generic function)
• connect (generic function)
• connect (method)
• connect (method)
• connectedp (generic function)
• connectedp (method)
• data (generic function)
• data (method)
• (setf data) (method)
• (setf data) (generic function)
• database (generic function)
• database (method)
• (setf database) (method)
• (setf database) (generic function)
• databases (generic function)
• databases (method)
• define (generic function)
• define (method)
• definition (generic function)
• definition (method)
• (setf definition) (method)
• (setf definition) (generic function)
• definition-as-string (generic function)
• definition-as-string (method)
• description (generic function)
• description (method)
• (setf description) (method)
• (setf description) (generic function)
• disconnect (generic function)
• disconnect (method)
• disconnect (method)
• host (generic function)
• host (method)
• (setf host) (method)
• (setf host) (generic function)
• info (generic function)
• info (method)
• make-dict-client (function)
• match (generic function)
• match (method)
• message-id (generic function)
• message-id (method)
• (setf message-id) (method)
• (setf message-id) (generic function)
• name (generic function)
• name (method)
• (setf name) (method)
• name (method)
• (setf name) (method)
• (setf name) (generic function)
• port (generic function)
• port (method)
• (setf port) (method)
• (setf port) (generic function)
• response (generic function)
• response (method)
• (setf response) (method)
• (setf response) (generic function)
• see-also (generic function)
• see-also (method)
• server-details (generic function)
• server-details (method)
• (setf server-details) (method)
• (setf server-details) (generic function)
• server-help (generic function)
• server-help (method)
• server-info (generic function)
• server-info (method)
• strategies (generic function)
• strategies (method)
• with-dict-client (macro)
• word (generic function)
• word (method)
• (setf word) (method)
• (setf word) (generic function)

Internal Definitions

• cap-string->keyword-list (function)
• completion-reply-p (generic function)
• completion-reply-p (method)
• connected-check (generic function)
• connected-check (method)
• dict-client (class)
• dict-client-response (class)
• dict-general-info (class)
• dict-word-definition (class)
• end-of-data-p (function)
• errorp (generic function)
• errorp (method)
• get-line (generic function)
• get-line (method)
• get-line (method)
• get-long-response (generic function)
• get-long-response (method)
• get-short-response (generic function)
• get-short-response (method)
• info-command (generic function)
• info-command (method)
• intermediate-reply-p (generic function)
• intermediate-reply-p (method)
• keyword->dict-string (function)
• long-command (generic function)
• long-command (method)
• permanent-error-p (generic function)
• permanent-error-p (method)
• populate-slots-from-banner (generic function)
• populate-slots-from-banner (method)
• preliminary-reply-p (generic function)
• preliminary-reply-p (method)
• put-line (generic function)
• put-line (method)
• put-line (method)
• read-definition (generic function)
• read-definition (method)
• read-info (generic function)
• read-info (method)
• read-response (generic function)
• read-response (method)
• read-string-as-list (function)
• read-string-as-list-preserving-case (function)
• read-word (generic function)
• read-word (method)
• short-command (generic function)
• short-command (method)
• socket (generic function)
• socket (method)
• (setf socket) (method)
• (setf socket) (generic function)
• temporary-error-p (generic function)
• temporary-error-p (method)
• with-safe-reading (macro)

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

5.1 Exported definitions

5.1.1 Constants

Constant: +all-db+

Database name to use when all definitions/matches are required.

Package

org.davep.dict

Source

dict.lisp (file)

Constant: +default-match-strategy+

Match strategy name meaning "the server’s default".

Package

org.davep.dict

Source

dict.lisp (file)

Constant: +exact-match-strategy+

Match strategy name for an exact match.

Package

org.davep.dict

Source

dict.lisp (file)

Constant: +first-db+

Database name to use when the first definition/match is required.

Package

org.davep.dict

Source

dict.lisp (file)

Constant: +prefix-match-strategy+

Match strategy name for a prefix match.

Package

org.davep.dict

Source

dict.lisp (file)

5.1.2 Special variables

Special Variable: *default-client-id*

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.

Package

org.davep.dict

Source

dict.lisp (file)

Special Variable: *default-dict-host*

Host name to use when a default host is required.

Package

org.davep.dict

Source

dict.lisp (file)

Special Variable: *default-dict-port*

Port to use when a default port is required.

Package

org.davep.dict

Source

dict.lisp (file)

5.1.3 Macros

Macro: with-dict-client (CLIENT &key HOST PORT) &body BODY

Create a dictionary client called CLIENT and evaluate BODY.

Package

org.davep.dict

Source

dict.lisp (file)

5.1.4 Functions

Function: make-dict-client &key HOST PORT

Create a dictionary client.

Package

org.davep.dict

Source

dict.lisp (file)

5.1.5 Generic functions

Generic Function: banner OBJECT

Generic Function: (setf banner) NEW-VALUE OBJECT

Package

org.davep.dict

Methods

Method: banner (DICT-CLIENT dict-client)

Method: (setf banner) NEW-VALUE (DICT-CLIENT dict-client)

The banner message we got when connected to the host.
This slot, when populated, is a ‘DICT-CLIENT-RESPONSE’ object.

Source

dict.lisp (file)

Generic Function: capabilities OBJECT

Generic Function: (setf capabilities) NEW-VALUE OBJECT

Package

org.davep.dict

Methods

Method: capabilities (DICT-CLIENT dict-client)

Method: (setf capabilities) NEW-VALUE (DICT-CLIENT dict-client)

Server’s capability list. A list of keywords.

Source

dict.lisp (file)

Generic Function: code OBJECT

Generic Function: (setf code) NEW-VALUE OBJECT

Package

org.davep.dict

Methods

Method: code (DICT-CLIENT-RESPONSE dict-client-response)

Method: (setf code) NEW-VALUE (DICT-CLIENT-RESPONSE dict-client-response)

The numeric code associated with the response.

Source

dict.lisp (file)

Generic Function: connect DICT-CLIENT

Package

org.davep.dict

Methods

Method: connect (DICT-CLIENT dict-client)

Connect the dictionary client to the dictionary server.

Source

dict.lisp (file)

Method: connect (DICT-CLIENT dict-client) before

Ensure that we’re not already connected.

Source

dict.lisp (file)

Generic Function: connectedp DICT-CLIENT

Package

org.davep.dict

Methods

Method: connectedp (DICT-CLIENT dict-client)

Is DICT-CLIENT connected to a dictionary server?

Source

dict.lisp (file)

Generic Function: data OBJECT

Generic Function: (setf data) NEW-VALUE OBJECT

Package

org.davep.dict

Methods

Method: data (DICT-CLIENT-RESPONSE dict-client-response)

Method: (setf data) NEW-VALUE (DICT-CLIENT-RESPONSE dict-client-response)

Any data associated with the response.

Source

dict.lisp (file)

Generic Function: database OBJECT

Generic Function: (setf database) NEW-VALUE OBJECT

Package

org.davep.dict

Methods

Method: database (DICT-WORD-DEFINITION dict-word-definition)

Method: (setf database) NEW-VALUE (DICT-WORD-DEFINITION dict-word-definition)

The name of the database that the definition came from.

Source

dict.lisp (file)

Generic Function: databases DICT-CLIENT

Package

org.davep.dict

Methods

Method: databases (DICT-CLIENT dict-client)

Get a list of databases available on the server.

An object of the class ‘DICT-CLIENT-RESPONSE’ is returned.

Source

dict.lisp (file)

Generic Function: define DICT-CLIENT WORD &key DATABASE

Package

org.davep.dict

Methods

Method: define (DICT-CLIENT 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’.

Source

dict.lisp (file)

Generic Function: definition OBJECT

Generic Function: (setf definition) NEW-VALUE OBJECT

Package

org.davep.dict

Methods

Method: definition (DICT-WORD-DEFINITION dict-word-definition)

Method: (setf definition) NEW-VALUE (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.

Source

dict.lisp (file)

Generic Function: definition-as-string DEFINITION &key STRIP-LEADING-WHITESPACE

Package

org.davep.dict

Methods

Method: definition-as-string (DEFINITION dict-word-definition) &key STRIP-LEADING-WHITESPACE

Return the text of DEFINITION as a string.

Source

dict.lisp (file)

Generic Function: description OBJECT

Generic Function: (setf description) NEW-VALUE OBJECT

Package

org.davep.dict

Methods

Method: description (DICT-GENERAL-INFO dict-general-info)

Method: (setf description) NEW-VALUE (DICT-GENERAL-INFO dict-general-info)

The description attribute of the information item.

Source

dict.lisp (file)

Generic Function: disconnect DICT-CLIENT

Package

org.davep.dict

Methods

Method: disconnect (DICT-CLIENT dict-client)

Disconnect the dictionary client from the dictionary server.

Source

dict.lisp (file)

Method: disconnect (DICT-CLIENT dict-client) before

Ensure that we’re connected before we disconnect.

Source

dict.lisp (file)

Generic Function: host OBJECT

Generic Function: (setf host) NEW-VALUE OBJECT

Package

org.davep.dict

Methods

Method: host (DICT-CLIENT dict-client)

Method: (setf host) NEW-VALUE (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*’.

Source

dict.lisp (file)

Generic Function: info DICT-CLIENT DATABASE

Package

org.davep.dict

Methods

Method: info (DICT-CLIENT dict-client) (DATABASE string)

Get information about DATABASE.

An object of the class ‘DICT-CLIENT-RESPONSE’ is returned.

Source

dict.lisp (file)

Generic Function: match DICT-CLIENT WORD &key DATABASE STRATEGY

Package

org.davep.dict

Methods

Method: match (DICT-CLIENT dict-client) (WORD string) &key DATABASE STRATEGY

Match a word.

An object of the class ‘DICT-CLIENT-RESPONSE’ is returned.

Source

dict.lisp (file)

Generic Function: message-id OBJECT

Generic Function: (setf message-id) NEW-VALUE OBJECT

Package

org.davep.dict

Methods

Method: message-id (DICT-CLIENT dict-client)

Method: (setf message-id) NEW-VALUE (DICT-CLIENT dict-client)

The message ID given to us after a successful connection.

Source

dict.lisp (file)

Generic Function: name OBJECT

Generic Function: (setf name) NEW-VALUE OBJECT

Package

org.davep.dict

Methods

Method: name (DICT-WORD-DEFINITION dict-word-definition)

Method: (setf name) NEW-VALUE (DICT-WORD-DEFINITION dict-word-definition)

The long name of the database that the definition came from.

Source

dict.lisp (file)

Method: name (DICT-GENERAL-INFO dict-general-info)

Method: (setf name) NEW-VALUE (DICT-GENERAL-INFO dict-general-info)

The name attribute of the information item.

Source

dict.lisp (file)

Generic Function: port OBJECT

Generic Function: (setf port) NEW-VALUE OBJECT

Package

org.davep.dict

Methods

Method: port (DICT-CLIENT dict-client)

Method: (setf port) NEW-VALUE (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*’.

Source

dict.lisp (file)

Generic Function: response OBJECT

Generic Function: (setf response) NEW-VALUE OBJECT

Package

org.davep.dict

Methods

Method: response (DICT-CLIENT-RESPONSE dict-client-response)

Method: (setf response) NEW-VALUE (DICT-CLIENT-RESPONSE dict-client-response)

The text of the response received from the server.

Source

dict.lisp (file)

Generic Function: see-also DEFINITION

Package

org.davep.dict

Methods

Method: see-also (DEFINITION dict-word-definition)

Get a list of "see also" items for the definition.

Source

dict.lisp (file)

Generic Function: server-details OBJECT

Generic Function: (setf server-details) NEW-VALUE OBJECT

Package

org.davep.dict

Methods

Method: server-details (DICT-CLIENT dict-client)

Method: (setf server-details) NEW-VALUE (DICT-CLIENT dict-client)

The server details as pulled from the banner after a successful connection.

Source

dict.lisp (file)

Generic Function: server-help DICT-CLIENT

Package

org.davep.dict

Methods

Method: server-help (DICT-CLIENT dict-client)

Request help from the dictionary server.

An object of the class ‘DICT-CLIENT-RESPONSE’ is returned.

Source

dict.lisp (file)

Generic Function: server-info DICT-CLIENT

Package

org.davep.dict

Methods

Method: server-info (DICT-CLIENT dict-client)

Get information about the server.

An object of the class ‘DICT-CLIENT-RESPONSE’ is returned.

Source

dict.lisp (file)

Generic Function: strategies DICT-CLIENT

Package

org.davep.dict

Methods

Method: strategies (DICT-CLIENT dict-client)

Get a list of strategies available on the server.

An object of the class ‘DICT-CLIENT-RESPONSE’ is returned.

Source

dict.lisp (file)

Generic Function: word OBJECT

Generic Function: (setf word) NEW-VALUE OBJECT

Package

org.davep.dict

Methods

Method: word (DICT-WORD-DEFINITION dict-word-definition)

Method: (setf word) NEW-VALUE (DICT-WORD-DEFINITION dict-word-definition)

The word that is being defined.

Source

dict.lisp (file)

5.2 Internal definitions

5.2.1 Macros

Macro: with-safe-reading &body BODY

Package

org.davep.dict

Source

dict.lisp (file)

5.2.2 Functions

Function: cap-string->keyword-list CAP-STRING

Convert CAP-STRING to a list of keywords.

Package

org.davep.dict

Source

dict.lisp (file)

Function: end-of-data-p LINE

Is LINE an end of data marker?

Package

org.davep.dict

Source

dict.lisp (file)

Function: keyword->dict-string KEYWORD

Convert KEYWORD into a dict string constant.

Package

org.davep.dict

Source

dict.lisp (file)

Function: read-string-as-list STRING

Take STRING and read it as a list.

Package

org.davep.dict

Source

dict.lisp (file)

Function: read-string-as-list-preserving-case STRING

Take STRING and read it as a list while preserving case.

Package

org.davep.dict

Source

dict.lisp (file)

5.2.3 Generic functions

Generic Function: completion-reply-p RESPONSE

Package

org.davep.dict

Methods

Method: completion-reply-p (RESPONSE dict-client-response)

Is RESPONSE a completion reply?

Source

dict.lisp (file)

Generic Function: connected-check DICT-CLIENT

Package

org.davep.dict

Methods

Method: connected-check (DICT-CLIENT dict-client)

Check that DICT-CLIENT is connected to a server, error if not.

Source

dict.lisp (file)

Generic Function: errorp RESPONSE

Package

org.davep.dict

Methods

Method: errorp (RESPONSE dict-client-response)

Is RESPONSE any kind of error?

Source

dict.lisp (file)

Generic Function: get-line DICT-CLIENT

Package

org.davep.dict

Methods

Method: get-line (DICT-CLIENT dict-client)

Read a line from the dictionary server.

Source

dict.lisp (file)

Method: get-line (DICT-CLIENT dict-client) before

Ensure that we’re connected before getting a line.

Source

dict.lisp (file)

Generic Function: get-long-response DICT-CLIENT

Package

org.davep.dict

Methods

Method: get-long-response (DICT-CLIENT dict-client)

Get a long (multi line) response from the dict server.

Source

dict.lisp (file)

Generic Function: get-short-response DICT-CLIENT

Package

org.davep.dict

Methods

Method: get-short-response (DICT-CLIENT dict-client)

Get a short (one line) response from the dict server.

Source

dict.lisp (file)

Generic Function: info-command DICT-CLIENT COMMAND

Package

org.davep.dict

Methods

Method: info-command (DICT-CLIENT dict-client) (COMMAND string)

Send COMMAND to the server and grahter up the resulting information.

Source

dict.lisp (file)

Generic Function: intermediate-reply-p RESPONSE

Package

org.davep.dict

Methods

Method: intermediate-reply-p (RESPONSE dict-client-response)

Is RESPONSE an intermediate reply?

Source

dict.lisp (file)

Generic Function: long-command DICT-CLIENT COMMAND

Package

org.davep.dict

Methods

Method: long-command (DICT-CLIENT dict-client) (COMMAND string)

Send COMMAND to server and get its multi-line response.

Source

dict.lisp (file)

Generic Function: permanent-error-p RESPONSE

Package

org.davep.dict

Methods

Method: permanent-error-p (RESPONSE dict-client-response)

Is RESPONSE a permanent error?

Source

dict.lisp (file)

Generic Function: populate-slots-from-banner DICT-CLIENT

Package

org.davep.dict

Methods

Method: populate-slots-from-banner (DICT-CLIENT dict-client)

Populate various slots from the banner.

DICT-CLIENT is returned.

Source

dict.lisp (file)

Generic Function: preliminary-reply-p RESPONSE

Package

org.davep.dict

Methods

Method: preliminary-reply-p (RESPONSE dict-client-response)

Is RESPONSE a preliminary reply?

Source

dict.lisp (file)

Generic Function: put-line DICT-CLIENT LINE

Package

org.davep.dict

Methods

Method: put-line (DICT-CLIENT dict-client) (LINE string)

Send a line to the dict server.

Source

dict.lisp (file)

Method: put-line (DICT-CLIENT dict-client) (LINE string) before

Ensure that we’re connected before putting a line.

Source

dict.lisp (file)

Generic Function: read-definition DEFINITION DICT-CLIENT

Package

org.davep.dict

Methods

Method: read-definition (DEFINITION dict-word-definition) (DICT-CLIENT dict-client)

Read the definition of a word from DICT-CLIENT.

Source

dict.lisp (file)

Generic Function: read-info INFO TEXT

Package

org.davep.dict

Methods

Method: read-info (INFO dict-general-info) (TEXT string)

Break up TEXT and populate the slots in INFO.

INFO is returned.

Source

dict.lisp (file)

Generic Function: read-response RESPONSE TEXT

Package

org.davep.dict

Methods

Method: read-response (RESPONSE dict-client-response) (TEXT string)

Break up the response TEXT and populate the slots in RESPONSE.

RESPONSE is returned.

Source

dict.lisp (file)

Generic Function: read-word DEFINITION HEADER

Package

org.davep.dict

Methods

Method: read-word (DEFINITION dict-word-definition) (HEADER dict-client-response)

Break up the HEADER and populate the slots in DEFINITION.

DEFINITION is returned.

Source

dict.lisp (file)

Generic Function: short-command DICT-CLIENT COMMAND

Package

org.davep.dict

Methods

Method: short-command (DICT-CLIENT dict-client) (COMMAND string)

Send COMMAND to server and get its single line response.

Source

dict.lisp (file)

Generic Function: socket OBJECT

Generic Function: (setf socket) NEW-VALUE OBJECT

Package

org.davep.dict

Methods

Method: socket (DICT-CLIENT dict-client)

Method: (setf socket) NEW-VALUE (DICT-CLIENT dict-client)

The socket used to talk to the host.

Source

dict.lisp (file)

Generic Function: temporary-error-p RESPONSE

Package

org.davep.dict

Methods

Method: temporary-error-p (RESPONSE dict-client-response)

Is RESPONSE a temporary error?

Source

dict.lisp (file)

5.2.4 Classes

Class: dict-client ()

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.

Package

org.davep.dict

Source

dict.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• server-help (method)
• server-info (method)
• info (method)
• strategies (method)
• databases (method)
• match (method)
• define (method)
• read-definition (method)
• disconnect (method)
• disconnect (method)
• connect (method)
• connect (method)
• populate-slots-from-banner (method)
• info-command (method)
• long-command (method)
• short-command (method)
• get-long-response (method)
• get-short-response (method)
• put-line (method)
• put-line (method)
• get-line (method)
• get-line (method)
• print-object (method)
• connected-check (method)
• connectedp (method)
• message-id (method)
• message-id (method)
• capabilities (method)
• capabilities (method)
• server-details (method)
• server-details (method)
• banner (method)
• banner (method)
• socket (method)
• socket (method)
• port (method)
• port (method)
• host (method)
• host (method)

Direct slots

Slot: host

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*’.

Type

string

Initargs

:host

Initform

org.davep.dict:*default-dict-host*

Readers

host (generic function)

Writers

(setf host) (generic function)

Slot: port

The number of the port that the client will connect to.
The default value for this slot is the value of ‘*DEFAULT-DICT-PORT*’.

Type

integer

Initargs

:port

Initform

org.davep.dict:*default-dict-port*

Readers

port (generic function)

Writers

(setf port) (generic function)

Slot: socket

The socket used to talk to the host.

Type

(or null stream)

Readers

socket (generic function)

Writers

(setf socket) (generic function)

Slot: banner

The banner message we got when connected to the host.
This slot, when populated, is a ‘DICT-CLIENT-RESPONSE’ object.

Type

(or null org.davep.dict::dict-client-response)

Readers

banner (generic function)

Writers

(setf banner) (generic function)

Slot: server-details

The server details as pulled from the banner after a successful connection.

Type

string

Initform

""

Readers

server-details (generic function)

Writers

(setf server-details) (generic function)

Slot: capabilities

Server’s capability list. A list of keywords.

Type

list

Readers

capabilities (generic function)

Writers

(setf capabilities) (generic function)

Slot: message-id

The message ID given to us after a successful connection.

Type

string

Initform

""

Readers

message-id (generic function)

Writers

(setf message-id) (generic function)

Class: dict-client-response ()

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.

Package

org.davep.dict

Source

dict.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• read-word (method)
• print-object (method)
• errorp (method)
• permanent-error-p (method)
• temporary-error-p (method)
• intermediate-reply-p (method)
• completion-reply-p (method)
• preliminary-reply-p (method)
• read-response (method)
• data (method)
• data (method)
• response (method)
• response (method)
• code (method)
• code (method)

Direct slots

Slot: code

The numeric code associated with the response.

Type

integer

Readers

code (generic function)

Writers

(setf code) (generic function)

Slot: response

The text of the response received from the server.

Type

string

Readers

response (generic function)

Writers

(setf response) (generic function)

Slot: data

Any data associated with the response.

Type

list

Readers

data (generic function)

Writers

(setf data) (generic function)

Class: dict-general-info ()

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.

Package

org.davep.dict

Source

dict.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• print-object (method)
• read-info (method)
• description (method)
• description (method)
• name (method)
• name (method)

Direct slots

Slot: name

The name attribute of the information item.

Type

string

Readers

name (generic function)

Writers

(setf name) (generic function)

Slot: description

The description attribute of the information item.

Type

string

Readers

description (generic function)

Writers

(setf description) (generic function)

Class: dict-word-definition ()

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.

Package

org.davep.dict

Source

dict.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• read-definition (method)
• print-object (method)
• see-also (method)
• definition-as-string (method)
• read-word (method)
• definition (method)
• definition (method)
• name (method)
• name (method)
• database (method)
• database (method)
• word (method)
• word (method)

Direct slots

Slot: word

The word that is being defined.

Type

string

Readers

word (generic function)

Writers

(setf word) (generic function)

Slot: database

The name of the database that the definition came from.

Type

string

Readers

database (generic function)

Writers

(setf database) (generic function)

Slot: name

The long name of the database that the definition came from.

Type

string

Readers

name (generic function)

Writers

(setf name) (generic function)

Slot: definition

The definition of the word.
This is a list of strings, each item in the list is a line from the definition.

Type

list

Readers

definition (generic function)

Writers

(setf definition) (generic function)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types