The hspell Reference Manual

Table of Contents

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

The hspell Reference Manual

This is the hspell Reference Manual, generated automatically by Declt version 2.3 "Robert April" on Wed Mar 14 04:00:46 2018 GMT+0.


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

1 Introduction

hspell

Common Lisp bindings for hspell.

Example

lisp HSPELL> (correct-spelling-p "עפשרות") NIL 1 HSPELL> (correct-spelling "עפשרות") ("הפשרות" "אפשרות") HSPELL> (word-splits "כלב") (("כלב" 0 (:VERB :NONDEF :IMPER :MISC)) ("לב" 1 (:L :NONDEF :MISC))) HSPELL> (canonic-gimatria-p "תרס\"ו") 666

License

MIT


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 hspell

Author

death <github.com/death>

License

MIT

Description

Hspell bindings for Common Lisp.

Dependencies
Source

hspell.asd (file)

Components

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 hspell.asd

Location

hspell.asd

Systems

hspell (system)


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

3.1.2 hspell/packages.lisp

Parent

hspell (system)

Location

packages.lisp

Packages

hspell


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

3.1.3 hspell/low-level.lisp

Dependency

packages.lisp (file)

Parent

hspell (system)

Location

low-level.lisp

Internal Definitions

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

3.1.4 hspell/hspell.lisp

Dependency

low-level.lisp (file)

Parent

hspell (system)

Location

hspell.lisp

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 hspell

Source

packages.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 Special variables

Special Variable: *hspell*
Package

hspell

Source

hspell.lisp (file)


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

5.1.2 Functions

Function: correct-spelling WORD &optional HSPELL
Package

hspell

Source

hspell.lisp (file)

Function: correct-spelling-p WORD &optional HSPELL
Package

hspell

Source

hspell.lisp (file)

Function: dictionary-path ()
Function: (setf dictionary-path) NEW-VALUE
Package

hspell

Source

hspell.lisp (file)

Function: make-hspell &key HE-SHEELA LINGUISTICS
Package

hspell

Source

hspell.lisp (file)

Function: word-splits WORD &optional HSPELL
Package

hspell

Source

hspell.lisp (file)


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

5.2 Internal definitions


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

5.2.1 Constants

Constant: hspell-opt-default
Package

hspell

Source

low-level.lisp (file)

Constant: hspell-opt-he-sheela
Package

hspell

Source

low-level.lisp (file)

Constant: hspell-opt-linguistics
Package

hspell

Source

low-level.lisp (file)

Constant: n-corlist-len
Package

hspell

Source

low-level.lisp (file)

Constant: n-corlist-words
Package

hspell

Source

low-level.lisp (file)


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

5.2.2 Special variables

Special Variable: *splits*
Package

hspell

Source

hspell.lisp (file)


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

5.2.3 Symbol macros

Symbol Macro: hspell-debug
Package

hspell

Source

low-level.lisp (file)

Expansion

(hspell::%var-accessor-hspell-debug)


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

5.2.4 Macros

Macro: with-corlist (VAR) &body FORMS
Package

hspell

Source

hspell.lisp (file)

Macro: with-hspell-string (FOREIGN-VAR LISP-STRING) &body FORMS
Package

hspell

Source

hspell.lisp (file)

Macro: with-splits &body FORMS
Package

hspell

Source

hspell.lisp (file)


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

5.2.5 Functions

Function: %var-accessor-hspell-debug ()
Function: (setf %var-accessor-hspell-debug) VALUE
Package

hspell

Source

low-level.lisp (file)

Function: canonic-gimatria-p WORD &optional HSPELL
Package

hspell

Source

hspell.lisp (file)

Function: corlist-add CORLIST WORD
Package

hspell

Source

low-level.lisp (file)

Function: corlist-correction CORLIST
Package

hspell

Source

hspell.lisp (file)

Function: corlist-free CORLIST
Package

hspell

Source

low-level.lisp (file)

Function: corlist-init CORLIST
Package

hspell

Source

low-level.lisp (file)

Function: corlist-n CORLIST
Package

hspell

Source

hspell.lisp (file)

Function: hspell-check-word DICT WORD PREFLEN
Package

hspell

Source

low-level.lisp (file)

Function: hspell-enum-splits DICT WORD ENUMF
Package

hspell

Source

low-level.lisp (file)

Function: hspell-get-dictionary-path ()
Package

hspell

Source

low-level.lisp (file)

Function: hspell-init DICTP FLAGS
Package

hspell

Source

low-level.lisp (file)

Function: hspell-is-canonic-gimatria WORD
Package

hspell

Source

low-level.lisp (file)

Function: hspell-set-dictionary-path PATH
Package

hspell

Source

low-level.lisp (file)

Function: hspell-string-to-lisp PTR &optional OFFSET
Package

hspell

Source

hspell.lisp (file)

Function: hspell-trycorrect DICT WORD CORLIST
Package

hspell

Source

low-level.lisp (file)

Function: hspell-uninit DICT
Package

hspell

Source

low-level.lisp (file)


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

5.2.6 Generic functions

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

hspell

Methods
Method: handle (HSPELL hspell)

automatically generated reader method

Source

hspell.lisp (file)

Method: (setf handle) NEW-VALUE (HSPELL hspell)

automatically generated writer method

Source

hspell.lisp (file)


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

5.2.7 Classes

Class: corlist-tclass ()
Package

hspell

Source

low-level.lisp (file)

Direct superclasses
  • translatable-foreign-type (class)
  • foreign-struct-type (class)
Class: hspell ()
Package

hspell

Source

hspell.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
  • handle (method)
  • handle (method)
Direct slots
Slot: handle
Initargs

:handle

Readers

handle (generic function)

Writers

(setf handle) (generic function)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   H   L  
Index Entry  Section

F
File, Lisp, hspell.asd: The hspell<dot>asd file
File, Lisp, hspell/hspell.lisp: The hspell/hspell<dot>lisp file
File, Lisp, hspell/low-level.lisp: The hspell/low-level<dot>lisp file
File, Lisp, hspell/packages.lisp: The hspell/packages<dot>lisp file

H
hspell.asd: The hspell<dot>asd file
hspell/hspell.lisp: The hspell/hspell<dot>lisp file
hspell/low-level.lisp: The hspell/low-level<dot>lisp file
hspell/packages.lisp: The hspell/packages<dot>lisp file

L
Lisp File, hspell.asd: The hspell<dot>asd file
Lisp File, hspell/hspell.lisp: The hspell/hspell<dot>lisp file
Lisp File, hspell/low-level.lisp: The hspell/low-level<dot>lisp file
Lisp File, hspell/packages.lisp: The hspell/packages<dot>lisp file

Jump to:   F   H   L  

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

A.2 Functions

Jump to:   %   (  
C   D   F   G   H   M   W  
Index Entry  Section

%
%var-accessor-hspell-debug: Internal functions

(
(setf %var-accessor-hspell-debug): Internal functions
(setf dictionary-path): Exported functions
(setf handle): Internal generic functions
(setf handle): Internal generic functions

C
canonic-gimatria-p: Internal functions
corlist-add: Internal functions
corlist-correction: Internal functions
corlist-free: Internal functions
corlist-init: Internal functions
corlist-n: Internal functions
correct-spelling: Exported functions
correct-spelling-p: Exported functions

D
dictionary-path: Exported functions

F
Function, %var-accessor-hspell-debug: Internal functions
Function, (setf %var-accessor-hspell-debug): Internal functions
Function, (setf dictionary-path): Exported functions
Function, canonic-gimatria-p: Internal functions
Function, corlist-add: Internal functions
Function, corlist-correction: Internal functions
Function, corlist-free: Internal functions
Function, corlist-init: Internal functions
Function, corlist-n: Internal functions
Function, correct-spelling: Exported functions
Function, correct-spelling-p: Exported functions
Function, dictionary-path: Exported functions
Function, hspell-check-word: Internal functions
Function, hspell-enum-splits: Internal functions
Function, hspell-get-dictionary-path: Internal functions
Function, hspell-init: Internal functions
Function, hspell-is-canonic-gimatria: Internal functions
Function, hspell-set-dictionary-path: Internal functions
Function, hspell-string-to-lisp: Internal functions
Function, hspell-trycorrect: Internal functions
Function, hspell-uninit: Internal functions
Function, make-hspell: Exported functions
Function, word-splits: Exported functions

G
Generic Function, (setf handle): Internal generic functions
Generic Function, handle: Internal generic functions

H
handle: Internal generic functions
handle: Internal generic functions
hspell-check-word: Internal functions
hspell-enum-splits: Internal functions
hspell-get-dictionary-path: Internal functions
hspell-init: Internal functions
hspell-is-canonic-gimatria: Internal functions
hspell-set-dictionary-path: Internal functions
hspell-string-to-lisp: Internal functions
hspell-trycorrect: Internal functions
hspell-uninit: Internal functions

M
Macro, with-corlist: Internal macros
Macro, with-hspell-string: Internal macros
Macro, with-splits: Internal macros
make-hspell: Exported functions
Method, (setf handle): Internal generic functions
Method, handle: Internal generic functions

W
with-corlist: Internal macros
with-hspell-string: Internal macros
with-splits: Internal macros
word-splits: Exported functions

Jump to:   %   (  
C   D   F   G   H   M   W  

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

A.3 Variables

Jump to:   *  
C   H   N   S  
Index Entry  Section

*
*hspell*: Exported special variables
*splits*: Internal special variables

C
Constant, hspell-opt-default: Internal constants
Constant, hspell-opt-he-sheela: Internal constants
Constant, hspell-opt-linguistics: Internal constants
Constant, n-corlist-len: Internal constants
Constant, n-corlist-words: Internal constants

H
handle: Internal classes
hspell-debug: Internal symbol macros
hspell-opt-default: Internal constants
hspell-opt-he-sheela: Internal constants
hspell-opt-linguistics: Internal constants

N
n-corlist-len: Internal constants
n-corlist-words: Internal constants

S
Slot, handle: Internal classes
Special Variable, *hspell*: Exported special variables
Special Variable, *splits*: Internal special variables
Symbol Macro, hspell-debug: Internal symbol macros

Jump to:   *  
C   H   N   S  

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

A.4 Data types

Jump to:   C   H   P   S  
Index Entry  Section

C
Class, corlist-tclass: Internal classes
Class, hspell: Internal classes
corlist-tclass: Internal classes

H
hspell: The hspell system
hspell: The hspell package
hspell: Internal classes

P
Package, hspell: The hspell package

S
System, hspell: The hspell system

Jump to:   C   H   P   S