The cl-enchant Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The cl-enchant Reference Manual

This is the cl-enchant Reference Manual, generated automatically by Declt version 2.3 "Robert April" on Wed Mar 14 03:15:14 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

CL Enchant

Common Lisp interface for Enchant spell-checker library

Introduction

CL Enchant is a Common Lisp interface for the Enchant spell-checker library. Enchant is a generic spell-checker library which uses other spell-checkers transparently as back-end. Enchant supports the following checkers:

CL Enchant uses The Common Foreign Function Interface (CFFI) for accessing the Enchant C library. CL Enchant should work on any Common Lisp implementation which supports CFFI.

Installation

Quicklisp is the easiest way to install and load CL Enchant. Two ASDF systems are provided: The system enchant loads the main CL Enchant library. There is also enchant-autoload system which depends on the main library and also tries to load the Enchant C library (using CFFI's facilities).

Examples

Function: (dict-check dict word)

Check the spelling for word using dictionary dict.

ENCHANT> (with-dict (lang "en_GB")
           (dict-check lang "working")) ; correct
"working"

ENCHANT> (with-dict (lang "en_GB")
           (dict-check lang "wrking"))  ; incorrect
NIL

Function: (dict-suggest dict word)

Get spelling suggestions for word using dictionary dict.

ENCHANT> (with-dict (lang "en_US")
           (dict-suggest lang "wrking"))
("wring" "working" "irking" "waking" "wrying" "parking"
 "marking" "winking" "wicking" "Zworykin" "dragging")

Interface (API)

CL Enchant uses similar names to the original Enchant C library. Common Lisp's naming conventions are respected, though. For example, the original C language function enchant_dict_check() has been named enchant:dict-check. The C function enchant_broker_dict_exists() has been named enchant:broker-dict-exists-p and thus respecting the Common Lisp suffix convention for predicate functions.

There are also macros for convenience: with-broker, with-dict and with-pwl-dict. They hide some low-level resource initialization and freeing operations.

Function: activep

The lambda list:

 (object)

Test if object is active. Return a generalized boolean. This can be used with broker and dict objects.

Class: broker

Class for holding pointers to foreign (non-Lisp) broker resources. Instances are created with broker-init function.

Function: broker-describe

The lambda list:

 (broker)

Get information about Enchant dictionary providers. Return a list of lists of three strings: provider name, provider description, provider library filename.

If broker is not an active broker object, signal not-active-broker error condition.

Function: broker-dict-exists-p

The lambda list:

 (broker language)

Check if dictionary for language exists. Broker must be a valid broker object returned by broker-init. Language is a language code and optional country code as a string (e.g., "en", "en_GB"). If the language exists return the language string. Otherwise return nil.

If broker is not an active broker object, signal not-active-broker error condition.

Function: broker-free

The lambda list:

 (broker)

Free the foreign (non-Lisp) broker resources. The argument is a broker object returned by broker-init. The broker object becomes inactive and can't be used anymore.

Function: broker-free-dict

The lambda list:

 (broker dict)

Free the foreign (non-Lisp) dict resources. The first argument is a broker object returned by broker-init and the second a dict object returned by broker-request-dict. The dict object becomes inactive and can't be used anymore.

Function: broker-get-error

The lambda list:

 (broker)

Return an error message string (or nil) describing the last error in the UTF-8 encoding. This can be called after broker operations.

Function: broker-init

Initialize a new broker. Return a broker object which can be used to request dictionaries etc. See function broker-request-dict.

A broker object is active when it has been successfully created. It allocates foreign (non-Lisp) resources and must be freed after use with function broker-free. After being freed it becomes inactive and thus unusable. Generic function activep can be used to test if a broker object is active or not.

See macros with-broker, with-dict and with-pwl-dict which automatically initialize and free broker and dictionary resources.

Function: broker-list-dicts

The lambda list:

 (broker)

List all dictionaries that are available. Return a list of lists with four strings: language and optional country code (e.g., "en" or "en_GB"), provider name, provider description and provider library filename.

If broker is not an active broker object, signal not-active-broker error condition.

Function: broker-request-dict

The lambda list:

 (broker language)

Request a new dictionary for language. Return a dict object which can be used with spell-checker operations etc.

The broker argument must be an active broker object created with broker-init. Language is a language code and optional country code as a string (e.g., "en" or "en_GB").

A dict object is active when it has been successfully created. It allocates foreign (non-Lisp) resources and must be freed after use with function broker-free-dict. After being freed it becomes inactive and thus unusable. Generic function activep can be used to test if dict object is active or not.

If no suitable dictionary could be found dict-not-found error condition is signaled.

See also with-dict macro which automatically creates a dict environment and frees it in the end.

Function: broker-request-pwl-dict

The lambda list:

 (broker pwl)

Request a new dictionary for personal word list file pwl (a filename string). Return a dict object which can be used with spell-checker operations.

The broker argument must be an active broker object created with broker-init. Personal word list file pwl is a text file with one entry (a word) per line. If the file does not exist it is created. New words can be added to the personal word list file with function dict-add.

A dict object is active when it has been successfully created. It allocates foreign (non-Lisp) resources and must be freed after use with function broker-free-dict. After being freed it becomes inactive and thus unusable. Generic function activep can be used to test if dict object is active or not.

See also with-pwl-dict macro which automatically creates a dict environment and frees it in the end.

Function: broker-set-ordering

The lambda list:

 (broker language ordering)

Declares a preference of providers to use for language. The language argument is a language code and optional country code (e.g., "en" or "en_GB"). Pseudo language "*" can be used to declare a default ordering. It is used by any language that does not explicitly declare an ordering. The ordering argument is a list of provider name strings (e.g., ("myspell" "aspell" "ispell")).

If broker is not an active broker object, signal not-active-broker error condition.

Class: dict

Class for holding pointers to foreign (non-Lisp) dictionary resources. Instances are created with broker-request-dict function.

Function: dict-add

The lambda list:

 (dict word)

Add word to user's personal dictionary dict. If the word exists in user's exclude dictionary also remove it from there.

Function: dict-add-to-session

The lambda list:

 (dict word)

Add word to the current spell-checking session dict. Word is then recognized as a correct word in the current session.

Function: dict-check

The lambda list:

 (dict word)

Check the spelling of word (string) using dictionary dict. Return the word if the spelling is correct, nil otherwise.

Dict must be an active dict object returned by broker-request-dict, if not, signal a not-active-dict condition.

Function: dict-describe

The lambda list:

 (dict)

Describe dictionary dict. Return a list of four strings: language code and optional country code (e.g., "en" or "en_GB"), provider name, provider description and provider library filename.

Dict must be an active dict object returned by broker-request-dict, if not, signal a not-active-dict condition.

Function: dict-get-error

The lambda list:

 (dict)

Return an error message string (or nil) describing the last error in the UTF-8 encoding. This can be called after dict operations.

Function: dict-is-added-p

The lambda list:

 (dict word)

Check if word has been added to user's personal dictionary or to the current spell-checking session dict. If true, return word. Otherwise return nil.

Functions for adding words are dict-add and dict-add-to-session.

Function: dict-is-removed-p

The lambda list:

 (dict word)

Check if word has been removed from user's personal dictionary or from the current spell-checking session dict. If true, return word. Otherwise return nil.

Function: dict-remove

The lambda list:

 (dict word)

Add word to user's exclude dictionary for dict. If the word exists in user's personal dictionary also remove it from there.

Function: dict-remove-from-session

The lambda list:

 (dict word)

Remove word from the current spell-checking session dict. The word is not recognized anymore in the current session.

Function: dict-store-replacement

The lambda list:

 (dict word correction)

Add a correction statement from misspelled word to correction using dictionary dict. Correction might show up in the suggestion list.

Function: dict-suggest

The lambda list:

 (dict word)

Request spelling suggestions for word (string) using dictionary dict. Return a list of suggestions (strings) or nil if there aren't any.

Dict must be an active dict object returned by broker-request-dict, if not, signal not-active-dict condition.

Function: get-version

Return the Enchant library version.

Macro: with-broker

The lambda list:

 (variable &body body)

Initialize a new broker (using broker-init) and lexically bind variable to the broker object. Execute all body forms and return the values of the last body form. Finally, free the broker resources with function broker-free.

Macro: with-dict

The lambda list:

 ((variable language &optional broker) &body body)

Request a new dict object for language. Lexically bind variable to the new dict object and execute all body forms. Return the values of the last body form. Finally, free the dict resources with function broker-free-dict.

If the optional broker argument is given reuse that broker object when requesting dict. If the broker argument is not given create implicitly a new broker object with broker-init and free it in the end with broker-free. Note that the decision about the broker argument is done at the macro-expansion time. If there is anything (except the symbol nil) in the place of the broker argument that will be used as the broker.

Examples:

ENCHANT> (with-dict (lang "en_GB")
           (dict-check lang "working"))
"working"

ENCHANT> (with-dict (lang "en_GB")
           (dict-suggest lang "wrking"))
("wring" "working" "irking" "waking" "wrecking" "winking"
 "wrinkling" "marking" "Wrekin" "raking")

Macro: with-pwl-dict

The lambda list:

 ((variable pwl &optional broker) &body body)

Request a new dict object for personal word list file pwl. Lexically bind variable to the new dict object and execute all body forms. Return the values of the last body form. Finally, free the dict resources with function broker-free-dict.

For more information on personal word list files see the documentation of function broker-request-pwl-dict.

If the optional broker argument is given reuse that broker object when requesting dict. If the broker argument is not given create implicitly a new broker object with broker-init and free it in the end with broker-free. Note that the decision about the broker argument is done at the macro-expansion time. If there is anything (except the symbol nil) in the place of the broker argument that will be used as the broker.

Author and license

Author: Teemu Likonen <tlikonen@iki.fi>

PGP: 4E10 55DC 84E9 DFF6 13D7 8557 719D 69D3 2453 9450

License: Public domain

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

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


Previous: , Up: Systems   [Contents][Index]

2.1 enchant

Author

Teemu Likonen <tlikonen@iki.fi>

License

Public Domain

Description

Bindings for Enchant spell-checker library

Dependency

cffi

Source

enchant.asd (file)

Component

enchant.lisp (file)


Next: , Previous: , Up: Top   [Contents][Index]

3 Files

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


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 enchant.asd

Location

enchant.asd

Systems

enchant (system)


Previous: , Up: Lisp files   [Contents][Index]

3.1.2 enchant/enchant.lisp

Parent

enchant (system)

Location

enchant.lisp

Packages

enchant

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

4 Packages

Packages are listed by definition order.


Previous: , Up: Packages   [Contents][Index]

4.1 enchant

Source

enchant.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.1 Macros

Macro: with-broker VARIABLE &body BODY

Initialize a new ‘broker‘ (using ‘broker-init‘) and lexically bind _variable_ to the ‘broker‘ object. Execute all _body_ forms and return the values of the last _body_ form. Finally, free the ‘broker‘ resources with function ‘broker-free‘.

Package

enchant

Source

enchant.lisp (file)

Macro: with-dict (VARIABLE LANGUAGE &optional BROKER) &body BODY

Request a new ‘dict‘ object for _language_. Lexically bind _variable_ to the new ‘dict‘ object and execute all _body_ forms. Return the values of the last _body_ form. Finally, free the ‘dict‘ resources with function ‘broker-free-dict‘.

If the optional _broker_ argument is given reuse that broker object when requesting ‘dict‘. If the _broker_ argument is not given create implicitly a new ‘broker‘ object with ‘broker-init‘ and free it in the end with ‘broker-free‘. Note that the decision about the _broker_ argument is done at the macro-expansion time. If there is
anything (except the symbol ‘nil‘) in the place of the _broker_ argument that will be used as the broker.

Examples:

ENCHANT> (with-dict (lang "en_GB")
(dict-check lang "working"))
"working"

ENCHANT> (with-dict (lang "en_GB")
(dict-suggest lang "wrking"))
("wring" "working" "irking" "waking" "wrecking" "winking" "wrinkling" "marking" "Wrekin" "raking")

Package

enchant

Source

enchant.lisp (file)

Macro: with-pwl-dict (VARIABLE PWL &optional BROKER) &body BODY

Request a new ‘dict‘ object for personal word list file _pwl_. Lexically bind _variable_ to the new ‘dict‘ object and execute all _body_ forms. Return the values of the last _body_ form. Finally, free the ‘dict‘ resources with function ‘broker-free-dict‘.

For more information on personal word list files see the documentation of function ‘broker-request-pwl-dict‘.

If the optional _broker_ argument is given reuse that broker object when requesting ‘dict‘. If the _broker_ argument is not given create implicitly a new ‘broker‘ object with ‘broker-init‘ and free it in the end with ‘broker-free‘. Note that the decision about the _broker_ argument is done at the macro-expansion time. If there is
anything (except the symbol ‘nil‘) in the place of the _broker_ argument that will be used as the broker.

Package

enchant

Source

enchant.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.2 Functions

Function: broker-describe BROKER

Get information about Enchant dictionary providers. Return a list of lists of three strings: provider name, provider description, provider library filename.

If _broker_ is not an active ‘broker‘ object, signal ‘not-active-broker‘ error condition.

Package

enchant

Source

enchant.lisp (file)

Function: broker-dict-exists-p BROKER LANGUAGE

Check if dictionary for _language_ exists. _Broker_ must be a valid ‘broker‘ object returned by ‘broker-init‘. _Language_ is a language code and optional country code as a string (e.g., ‘"en"‘, ‘"en_GB"‘). If the _language_ exists return the _language_ string. Otherwise return ‘nil‘.

If _broker_ is not an active ‘broker‘ object, signal ‘not-active-broker‘ error condition.

Package

enchant

Source

enchant.lisp (file)

Function: broker-free BROKER

Free the foreign (non-Lisp) ‘broker‘ resources. The argument is a ‘broker‘ object returned by ‘broker-init‘. The ‘broker‘ object becomes inactive and can’t be used anymore.

Package

enchant

Source

enchant.lisp (file)

Function: broker-free-dict BROKER DICT

Free the foreign (non-Lisp) ‘dict‘ resources. The first argument is a ‘broker‘ object returned by ‘broker-init‘ and the second a ‘dict‘ object returned by ‘broker-request-dict‘. The ‘dict‘ object becomes inactive and can’t be used anymore.

Package

enchant

Source

enchant.lisp (file)

Function: broker-get-error BROKER

Return an error message string (or ‘nil‘) describing the last error in the UTF-8 encoding. This can be called after ‘broker‘ operations.

Package

enchant

Source

enchant.lisp (file)

Function: broker-init ()

Initialize a new broker. Return a ‘broker‘ object which can be used to request dictionaries etc. See function ‘broker-request-dict‘.

A ‘broker‘ object is active when it has been successfully created. It allocates foreign (non-Lisp) resources and must be freed after use with function ‘broker-free‘. After being freed it becomes inactive and thus unusable. Generic function ‘activep‘ can be used to test if a ‘broker‘ object is active or not.

See macros ‘with-broker‘, ‘with-dict‘ and ‘with-pwl-dict‘ which automatically initialize and free broker and dictionary resources.

Package

enchant

Source

enchant.lisp (file)

Function: broker-list-dicts BROKER

List all dictionaries that are available. Return a list of lists with four strings: language and optional country code (e.g., ‘"en"‘ or ‘"en_GB"‘), provider name, provider description and provider library filename.

If _broker_ is not an active ‘broker‘ object, signal ‘not-active-broker‘ error condition.

Package

enchant

Source

enchant.lisp (file)

Function: broker-request-dict BROKER LANGUAGE

Request a new dictionary for _language_. Return a ‘dict‘ object which can be used with spell-checker operations etc.

The _broker_ argument must be an active ‘broker‘ object created with ‘broker-init‘. _Language_ is a language code and optional country code as a string (e.g., ‘"en"‘ or ‘"en_GB"‘).

A ‘dict‘ object is active when it has been successfully created. It allocates foreign (non-Lisp) resources and must be freed after use with function ‘broker-free-dict‘. After being freed it becomes inactive and thus unusable. Generic function ‘activep‘ can be used to test if ‘dict‘ object is active or not.

If no suitable dictionary could be found ‘dict-not-found‘ error condition is signaled.

See also ‘with-dict‘ macro which automatically creates a ‘dict‘ environment and frees it in the end.

Package

enchant

Source

enchant.lisp (file)

Function: broker-request-pwl-dict BROKER PWL

Request a new dictionary for personal word list file _pwl_ (a filename string). Return a ‘dict‘ object which can be used with spell-checker operations.

The _broker_ argument must be an active ‘broker‘ object created with ‘broker-init‘. Personal word list file _pwl_ is a text file with one
entry (a word) per line. If the file does not exist it is created. New words can be added to the personal word list file with function
‘dict-add‘.

A ‘dict‘ object is active when it has been successfully created. It allocates foreign (non-Lisp) resources and must be freed after use with function ‘broker-free-dict‘. After being freed it becomes inactive and
thus unusable. Generic function ‘activep‘ can be used to test if ‘dict‘ object is active or not.

See also ‘with-pwl-dict‘ macro which automatically creates a ‘dict‘ environment and frees it in the end.

Package

enchant

Source

enchant.lisp (file)

Function: broker-set-ordering BROKER LANGUAGE ORDERING

Declares a preference of providers to use for _language_.
The _language_ argument is a language code and optional country
code (e.g., ‘"en"‘ or ‘"en_GB"‘). Pseudo language ‘"*"‘ can be
used to declare a default ordering. It is used by any language that does not explicitly declare an ordering. The _ordering_ argument is a list of provider name strings (e.g., ‘("myspell" "aspell" "ispell")‘).

If _broker_ is not an active ‘broker‘ object, signal ‘not-active-broker‘ error condition.

Package

enchant

Source

enchant.lisp (file)

Function: dict-add DICT WORD

Add _word_ to user’s personal dictionary _dict_. If the _word_ exists in user’s exclude dictionary also remove it from there.

Package

enchant

Source

enchant.lisp (file)

Function: dict-add-to-session DICT WORD

Add _word_ to the current spell-checking session _dict_. _Word_ is then recognized as a correct word in the current session.

Package

enchant

Source

enchant.lisp (file)

Function: dict-check DICT WORD

Check the spelling of _word_ (string) using dictionary _dict_. Return the _word_ if the spelling is correct, ‘nil‘ otherwise.

_Dict_ must be an active ‘dict‘ object returned by ‘broker-request-dict‘, if not, signal a ‘not-active-dict‘ condition.

Package

enchant

Source

enchant.lisp (file)

Function: dict-describe DICT

Describe dictionary _dict_. Return a list of four strings: language code and optional country code (e.g., ‘"en"‘ or ‘"en_GB"‘), provider name, provider description and provider library filename.

_Dict_ must be an active ‘dict‘ object returned by ‘broker-request-dict‘, if not, signal a ‘not-active-dict‘ condition.

Package

enchant

Source

enchant.lisp (file)

Function: dict-get-error DICT

Return an error message string (or ‘nil‘) describing the last error in the UTF-8 encoding. This can be called after ‘dict‘ operations.

Package

enchant

Source

enchant.lisp (file)

Function: dict-is-added-p DICT WORD

Check if _word_ has been added to user’s personal dictionary or to the current spell-checking session _dict_. If true, return _word_. Otherwise return ‘nil‘.

Functions for adding words are ‘dict-add‘ and ‘dict-add-to-session‘.

Package

enchant

Source

enchant.lisp (file)

Function: dict-is-removed-p DICT WORD

Check if _word_ has been removed from user’s personal dictionary or from the current spell-checking session _dict_. If true, return _word_. Otherwise return ‘nil‘.

Package

enchant

Source

enchant.lisp (file)

Function: dict-remove DICT WORD

Add _word_ to user’s exclude dictionary for _dict_. If the _word_ exists in user’s personal dictionary also remove it from there.

Package

enchant

Source

enchant.lisp (file)

Function: dict-remove-from-session DICT WORD

Remove _word_ from the current spell-checking session _dict_. The _word_ is not recognized anymore in the current session.

Package

enchant

Source

enchant.lisp (file)

Function: dict-store-replacement DICT WORD CORRECTION

Add a correction statement from misspelled _word_ to _correction_ using dictionary _dict_. _Correction_ might show up in the suggestion list.

Package

enchant

Source

enchant.lisp (file)

Function: dict-suggest DICT WORD

Request spelling suggestions for _word_ (string) using dictionary _dict_. Return a list of suggestions (strings) or ‘nil‘ if there aren’t any.

_Dict_ must be an active ‘dict‘ object returned by ‘broker-request-dict‘, if not, signal ‘not-active-dict‘ condition.

Package

enchant

Source

enchant.lisp (file)

Function: get-version ()

Return the Enchant library version.

Package

enchant

Source

enchant.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.3 Generic functions

Generic Function: activep OBJECT

Test if _object_ is active. Return a generalized boolean. This can be used with ‘broker‘ and ‘dict‘ objects.

Package

enchant

Source

enchant.lisp (file)

Methods
Method: activep (OBJECT foreign-object)
Generic Function: error-string CONDITION
Package

enchant

Methods
Method: error-string (CONDITION enchant-error)
Source

enchant.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.4 Conditions

Condition: dict-not-found ()
Package

enchant

Source

enchant.lisp (file)

Direct superclasses

enchant-error (condition)

Condition: enchant-error ()
Package

enchant

Source

enchant.lisp (file)

Direct superclasses

error (condition)

Direct subclasses
Direct methods

error-string (method)

Direct slots
Slot: error-string
Initargs

:string

Readers

error-string (generic function)

Condition: not-active-broker ()
Package

enchant

Source

enchant.lisp (file)

Direct superclasses

enchant-error (condition)

Condition: not-active-dict ()
Package

enchant

Source

enchant.lisp (file)

Direct superclasses

enchant-error (condition)


Previous: , Up: Exported definitions   [Contents][Index]

5.1.5 Classes

Class: broker ()

Class for holding pointers to foreign (non-Lisp) broker resources. Instances are created with ‘broker-init‘ function.

Package

enchant

Source

enchant.lisp (file)

Direct superclasses

foreign-object (class)

Direct methods

free-foreign-resource (method)

Class: dict ()

Class for holding pointers to foreign (non-Lisp) dictionary resources. Instances are created with ‘broker-request-dict‘ function.

Package

enchant

Source

enchant.lisp (file)

Direct superclasses

foreign-object (class)

Direct methods

free-foreign-resource (method)


Previous: , Up: Definitions   [Contents][Index]

5.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Special variables

Special Variable: *callback-data*
Package

enchant

Source

enchant.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.2 Functions

Function: error-if-not-active-broker OBJECT
Package

enchant

Source

enchant.lisp (file)

Function: error-if-not-active-dict OBJECT
Package

enchant

Source

enchant.lisp (file)

Function: error-if-not-proper-string OBJECT
Package

enchant

Source

enchant.lisp (file)

Function: proper-pointer-p OBJECT
Package

enchant

Source

enchant.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.3 Generic functions

Generic Function: address OBJECT
Generic Function: (setf address) NEW-VALUE OBJECT
Package

enchant

Methods
Method: address (FOREIGN-OBJECT foreign-object)

automatically generated reader method

Source

enchant.lisp (file)

Method: (setf address) NEW-VALUE (FOREIGN-OBJECT foreign-object)

automatically generated writer method

Source

enchant.lisp (file)

Generic Function: free-foreign-resource OBJECT &key BROKER &allow-other-keys
Package

enchant

Source

enchant.lisp (file)

Methods
Method: free-foreign-resource (DICT dict) &key BROKER
Method: free-foreign-resource (BROKER broker) &key
Method: free-foreign-resource (OBJECT foreign-object) &key around

Previous: , Up: Internal definitions   [Contents][Index]

5.2.4 Classes

Class: foreign-object ()
Package

enchant

Source

enchant.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses
Direct methods
Direct slots
Slot: address
Initargs

:address

Readers

address (generic function)

Writers

(setf address) (generic function)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   E   F   L  
Index Entry  Section

E
enchant.asd: The enchant<dot>asd file
enchant/enchant.lisp: The enchant/enchant<dot>lisp file

F
File, Lisp, enchant.asd: The enchant<dot>asd file
File, Lisp, enchant/enchant.lisp: The enchant/enchant<dot>lisp file

L
Lisp File, enchant.asd: The enchant<dot>asd file
Lisp File, enchant/enchant.lisp: The enchant/enchant<dot>lisp file

Jump to:   E   F   L  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   (  
A   B   D   E   F   G   M   P   W  
Index Entry  Section

(
(setf address): Internal generic functions
(setf address): Internal generic functions

A
activep: Exported generic functions
activep: Exported generic functions
address: Internal generic functions
address: Internal generic functions

B
broker-describe: Exported functions
broker-dict-exists-p: Exported functions
broker-free: Exported functions
broker-free-dict: Exported functions
broker-get-error: Exported functions
broker-init: Exported functions
broker-list-dicts: Exported functions
broker-request-dict: Exported functions
broker-request-pwl-dict: Exported functions
broker-set-ordering: Exported functions

D
dict-add: Exported functions
dict-add-to-session: Exported functions
dict-check: Exported functions
dict-describe: Exported functions
dict-get-error: Exported functions
dict-is-added-p: Exported functions
dict-is-removed-p: Exported functions
dict-remove: Exported functions
dict-remove-from-session: Exported functions
dict-store-replacement: Exported functions
dict-suggest: Exported functions

E
error-if-not-active-broker: Internal functions
error-if-not-active-dict: Internal functions
error-if-not-proper-string: Internal functions
error-string: Exported generic functions
error-string: Exported generic functions

F
free-foreign-resource: Internal generic functions
free-foreign-resource: Internal generic functions
free-foreign-resource: Internal generic functions
free-foreign-resource: Internal generic functions
Function, broker-describe: Exported functions
Function, broker-dict-exists-p: Exported functions
Function, broker-free: Exported functions
Function, broker-free-dict: Exported functions
Function, broker-get-error: Exported functions
Function, broker-init: Exported functions
Function, broker-list-dicts: Exported functions
Function, broker-request-dict: Exported functions
Function, broker-request-pwl-dict: Exported functions
Function, broker-set-ordering: Exported functions
Function, dict-add: Exported functions
Function, dict-add-to-session: Exported functions
Function, dict-check: Exported functions
Function, dict-describe: Exported functions
Function, dict-get-error: Exported functions
Function, dict-is-added-p: Exported functions
Function, dict-is-removed-p: Exported functions
Function, dict-remove: Exported functions
Function, dict-remove-from-session: Exported functions
Function, dict-store-replacement: Exported functions
Function, dict-suggest: Exported functions
Function, error-if-not-active-broker: Internal functions
Function, error-if-not-active-dict: Internal functions
Function, error-if-not-proper-string: Internal functions
Function, get-version: Exported functions
Function, proper-pointer-p: Internal functions

G
Generic Function, (setf address): Internal generic functions
Generic Function, activep: Exported generic functions
Generic Function, address: Internal generic functions
Generic Function, error-string: Exported generic functions
Generic Function, free-foreign-resource: Internal generic functions
get-version: Exported functions

M
Macro, with-broker: Exported macros
Macro, with-dict: Exported macros
Macro, with-pwl-dict: Exported macros
Method, (setf address): Internal generic functions
Method, activep: Exported generic functions
Method, address: Internal generic functions
Method, error-string: Exported generic functions
Method, free-foreign-resource: Internal generic functions
Method, free-foreign-resource: Internal generic functions
Method, free-foreign-resource: Internal generic functions

P
proper-pointer-p: Internal functions

W
with-broker: Exported macros
with-dict: Exported macros
with-pwl-dict: Exported macros

Jump to:   (  
A   B   D   E   F   G   M   P   W  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   *  
A   E   S  
Index Entry  Section

*
*callback-data*: Internal special variables

A
address: Internal classes

E
error-string: Exported conditions

S
Slot, address: Internal classes
Slot, error-string: Exported conditions
Special Variable, *callback-data*: Internal special variables

Jump to:   *  
A   E   S  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   B   C   D   E   F   N   P   S  
Index Entry  Section

B
broker: Exported classes

C
Class, broker: Exported classes
Class, dict: Exported classes
Class, foreign-object: Internal classes
Condition, dict-not-found: Exported conditions
Condition, enchant-error: Exported conditions
Condition, not-active-broker: Exported conditions
Condition, not-active-dict: Exported conditions

D
dict: Exported classes
dict-not-found: Exported conditions

E
enchant: The enchant system
enchant: The enchant package
enchant-error: Exported conditions

F
foreign-object: Internal classes

N
not-active-broker: Exported conditions
not-active-dict: Exported conditions

P
Package, enchant: The enchant package

S
System, enchant: The enchant system

Jump to:   B   C   D   E   F   N   P   S