This is the enchant Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 15:10:08 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
enchantProgramming interface for Enchant spell-checker library
Teemu Likonen <tlikonen@iki.fi>
Creative Commons CC0 (public domain dedication)
cffi (system).
enchant.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
enchant/enchant.lispenchant (system).
activep (generic function).
broker (class).
broker-describe (function).
broker-dict-exists-p (function).
broker-free (function).
broker-free-dict (function).
broker-get-error (function).
broker-init (function).
broker-list-dicts (function).
broker-request-dict (function).
broker-request-pwl-dict (function).
broker-set-ordering (function).
dict (class).
dict-add (function).
dict-add-to-session (function).
dict-check (function).
dict-describe (function).
dict-get-error (function).
dict-is-added-p (function).
dict-is-removed-p (function).
dict-not-found (condition).
dict-remove (function).
dict-remove-from-session (function).
dict-store-replacement (function).
dict-suggest (function).
enchant-error (condition).
error-string (reader method).
get-version (function).
not-active-broker (condition).
not-active-dict (condition).
print-object (method).
with-broker (macro).
with-dict (macro).
with-pwl-dict (macro).
*callback-data* (special variable).
address (reader method).
(setf address) (writer method).
error-if-not-active-broker (function).
error-if-not-active-dict (function).
error-if-not-proper-string (function).
foreign-object (class).
free-foreign-resource (generic function).
proper-pointer-p (function).
Packages are listed by definition order.
enchantcommon-lisp.
activep (generic function).
broker (class).
broker-describe (function).
broker-dict-exists-p (function).
broker-free (function).
broker-free-dict (function).
broker-get-error (function).
broker-init (function).
broker-list-dicts (function).
broker-request-dict (function).
broker-request-pwl-dict (function).
broker-set-ordering (function).
dict (class).
dict-add (function).
dict-add-to-session (function).
dict-check (function).
dict-describe (function).
dict-get-error (function).
dict-is-added-p (function).
dict-is-removed-p (function).
dict-not-found (condition).
dict-remove (function).
dict-remove-from-session (function).
dict-store-replacement (function).
dict-suggest (function).
enchant-error (condition).
error-string (generic reader).
get-version (function).
not-active-broker (condition).
not-active-dict (condition).
with-broker (macro).
with-dict (macro).
with-pwl-dict (macro).
*callback-data* (special variable).
address (generic reader).
(setf address) (generic writer).
error-if-not-active-broker (function).
error-if-not-active-dict (function).
error-if-not-proper-string (function).
foreign-object (class).
free-foreign-resource (generic function).
proper-pointer-p (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
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‘.
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")
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.
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.
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.
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.
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.
Return an error message string (or ‘nil‘) describing the last error in the UTF-8 encoding. This can be called after ‘broker‘ operations.
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.
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.
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.
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.
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.
Add _word_ to user’s personal dictionary _dict_. If the _word_ exists in user’s exclude dictionary also remove it from there.
Add _word_ to the current spell-checking session _dict_. _Word_ is then recognized as a correct word in the current session.
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.
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.
Return an error message string (or ‘nil‘) describing the last error in the UTF-8 encoding. This can be called after ‘dict‘ operations.
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‘.
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‘.
Add _word_ to user’s exclude dictionary for _dict_. If the _word_ exists in user’s personal dictionary also remove it from there.
Remove _word_ from the current spell-checking session _dict_. The _word_ is not recognized anymore in the current session.
Add a correction statement from misspelled _word_ to _correction_ using dictionary _dict_. _Correction_ might show up in the suggestion list.
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.
Return the Enchant library version.
Test if _object_ is active. Return a generalized boolean. This can be used with ‘broker‘ and ‘dict‘ objects.
foreign-object)) ¶enchant-error)) ¶error.
:string
This slot is read-only.
Class for holding pointers to foreign (non-Lisp) broker resources. Instances are created with ‘broker-init‘ function.
Class for holding pointers to foreign (non-Lisp) dictionary resources. Instances are created with ‘broker-request-dict‘ function.
foreign-object)) ¶automatically generated reader method
foreign-object)) ¶automatically generated writer method
foreign-object) &key) ¶| Jump to: | (
A B D E F G M P W |
|---|
| Jump to: | (
A B D E F G M P W |
|---|
| Jump to: | *
A E S |
|---|
| Jump to: | *
A E S |
|---|
| Jump to: | B C D E F N P S |
|---|
| Jump to: | B C D E F N P S |
|---|