com.atlascopco.hunspell

Class HunspellLibrary

java.lang.Object

com.atlascopco.hunspell.HunspellLibrary

public class HunspellLibrary
extends Object

Wrapper for library hunspell
This file was autogenerated by JNAerator,
a tool written by Olivier Chafik that uses a few opensource projects..
For help, please visit NativeLibs4Java or BridJ .

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	HunspellLibrary.Hunhandle This interface is simply here to allow BridJ to maintain type-safety.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MAXWORDUTF8LEN

Constructor Summary

Constructors

Constructor and Description
HunspellLibrary()

Method Summary

Methods

Modifier and Type	Method and Description
static int	Hunspell_add_dic(org.bridj.Pointer<HunspellLibrary.Hunhandle> pHunspell, org.bridj.Pointer<Byte> dpath) Add dictionary (.dic file only)
static int	Hunspell_add_with_affix(org.bridj.Pointer<HunspellLibrary.Hunhandle> pHunspell, org.bridj.Pointer<Byte> word, org.bridj.Pointer<Byte> example) add word to the run-time dictionary with affix flags of the example (a dictionary word): Hunspell will recognize affixed forms of the new word, too.
static int	Hunspell_add(org.bridj.Pointer<HunspellLibrary.Hunhandle> pHunspell, org.bridj.Pointer<Byte> word) add word to the run-time dictionary
static int	Hunspell_analyze(org.bridj.Pointer<HunspellLibrary.Hunhandle> pHunspell, org.bridj.Pointer<org.bridj.Pointer<org.bridj.Pointer<Byte>>> slst, org.bridj.Pointer<Byte> word) morphological analysis of the word
static org.bridj.Pointer<HunspellLibrary.Hunhandle>	Hunspell_create_key(org.bridj.Pointer<Byte> affpath, org.bridj.Pointer<Byte> dpath, org.bridj.Pointer<Byte> key) This constructor must be used if the dictionary/affix files were compressed/encrypted using the Hunspell hzip program.
static org.bridj.Pointer<HunspellLibrary.Hunhandle>	Hunspell_create(org.bridj.Pointer<Byte> affpath, org.bridj.Pointer<Byte> dpath) This will instantiate the Hunspell object and return a handle to it.
static void	Hunspell_destroy(org.bridj.Pointer<HunspellLibrary.Hunhandle> pHunspell) This calls the destructor on the Hunspell object.
static void	Hunspell_free_list(org.bridj.Pointer<HunspellLibrary.Hunhandle> pHunspell, org.bridj.Pointer<org.bridj.Pointer<org.bridj.Pointer<Byte>>> slst, int n) free suggestion lists
static int	Hunspell_generate(org.bridj.Pointer<HunspellLibrary.Hunhandle> pHunspell, org.bridj.Pointer<org.bridj.Pointer<org.bridj.Pointer<Byte>>> slst, org.bridj.Pointer<Byte> word, org.bridj.Pointer<Byte> word2) morphological generation by example(s)
static int	Hunspell_generate2(org.bridj.Pointer<HunspellLibrary.Hunhandle> pHunspell, org.bridj.Pointer<org.bridj.Pointer<org.bridj.Pointer<Byte>>> slst, org.bridj.Pointer<Byte> word, org.bridj.Pointer<org.bridj.Pointer<Byte>> desc, int n) generation by morph.
static org.bridj.Pointer<Byte>	Hunspell_get_dic_encoding(org.bridj.Pointer<HunspellLibrary.Hunhandle> pHunspell) This retrieves the encoding of the dictionary that the Hunspell instance was instantiated with.
static int	Hunspell_remove(org.bridj.Pointer<HunspellLibrary.Hunhandle> pHunspell, org.bridj.Pointer<Byte> word) remove word from the run-time dictionary
static int	Hunspell_spell(org.bridj.Pointer<HunspellLibrary.Hunhandle> pHunspell, org.bridj.Pointer<Byte> word) spellcheck word
static int	Hunspell_stem(org.bridj.Pointer<HunspellLibrary.Hunhandle> pHunspell, org.bridj.Pointer<org.bridj.Pointer<org.bridj.Pointer<Byte>>> slst, org.bridj.Pointer<Byte> word) stemmer function
static int	Hunspell_stem2(org.bridj.Pointer<HunspellLibrary.Hunhandle> pHunspell, org.bridj.Pointer<org.bridj.Pointer<org.bridj.Pointer<Byte>>> slst, org.bridj.Pointer<org.bridj.Pointer<Byte>> desc, int n) get stems from a morph.
static int	Hunspell_suggest(org.bridj.Pointer<HunspellLibrary.Hunhandle> pHunspell, org.bridj.Pointer<org.bridj.Pointer<org.bridj.Pointer<Byte>>> slst, org.bridj.Pointer<Byte> word) search suggestions

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MAXWORDUTF8LEN

public static final int MAXWORDUTF8LEN

See Also:

Constant Field Values

Constructor Detail

HunspellLibrary

public HunspellLibrary()

Method Detail

Hunspell_create

public static org.bridj.Pointer<HunspellLibrary.Hunhandle> Hunspell_create(org.bridj.Pointer<Byte> affpath,
                                                           org.bridj.Pointer<Byte> dpath)

This will instantiate the Hunspell object and return a handle to it.

Original signature : Hunhandle* Hunspell_create(const char*, const char*)
native declaration : line 12

Parameters:

affpath - the path to the affix file

dpath - the path to the dictionary file

Hunspell_create_key

public static org.bridj.Pointer<HunspellLibrary.Hunhandle> Hunspell_create_key(org.bridj.Pointer<Byte> affpath,
                                                               org.bridj.Pointer<Byte> dpath,
                                                               org.bridj.Pointer<Byte> key)

This constructor must be used if the dictionary/affix files were compressed/encrypted using the Hunspell hzip program.

Original signature : Hunhandle* Hunspell_create_key(const char*, const char*, const char*)
native declaration : line 14

Parameters:

affpath - the path to the affix file

dpath - the path to the dictionary file

key - the key to decrypt encrypted dictionary files

Hunspell_destroy

public static void Hunspell_destroy(org.bridj.Pointer<HunspellLibrary.Hunhandle> pHunspell)

This calls the destructor on the Hunspell object.

Original signature : void Hunspell_destroy(Hunhandle*)
native declaration : line 17

Parameters:

pHunspell - the handle on the hunspell object

Hunspell_add_dic

public static int Hunspell_add_dic(org.bridj.Pointer<HunspellLibrary.Hunhandle> pHunspell,
                   org.bridj.Pointer<Byte> dpath)

Add dictionary (.dic file only)

Original signature : int Hunspell_add_dic(HunHandle*, const char*)

Parameters:

pHunspell - the handle on the hunspell object

dpath - The path of the dictionary file

Returns:

0 if the dictionary was loaded, 1 if there are no available slots

Hunspell_spell

public static int Hunspell_spell(org.bridj.Pointer<HunspellLibrary.Hunhandle> pHunspell,
                 org.bridj.Pointer<Byte> word)

spellcheck word

Original signature : int Hunspell_spell(Hunhandle*, const char*)
native declaration : line 22

Parameters:

pHunspell - the handle on the hunspell object

word - the word to check

Returns:

0 if incorrect, anything else is correct

Hunspell_get_dic_encoding

public static org.bridj.Pointer<Byte> Hunspell_get_dic_encoding(org.bridj.Pointer<HunspellLibrary.Hunhandle> pHunspell)

This retrieves the encoding of the dictionary that the Hunspell instance was instantiated with.

Original signature : char* Hunspell_get_dic_encoding(Hunhandle*)
native declaration : line 24

Parameters:

pHunspell - the handle on the hunspell object

Hunspell_suggest

public static int Hunspell_suggest(org.bridj.Pointer<HunspellLibrary.Hunhandle> pHunspell,
                   org.bridj.Pointer<org.bridj.Pointer<org.bridj.Pointer<Byte>>> slst,
                   org.bridj.Pointer<Byte> word)

search suggestions

Original signature : int Hunspell_suggest(Hunhandle*, char***, const char*)
native declaration : line 33

Parameters:

pHunspell - the handle on the hunspell object

slst - an out param used to return the suggestions

word - the bad word that you need suggestions for

Returns:

the number of suggestions returned in the out param slst

Hunspell_analyze

public static int Hunspell_analyze(org.bridj.Pointer<HunspellLibrary.Hunhandle> pHunspell,
                   org.bridj.Pointer<org.bridj.Pointer<org.bridj.Pointer<Byte>>> slst,
                   org.bridj.Pointer<Byte> word)

morphological analysis of the word

Original signature : int Hunspell_analyze(Hunhandle*, char***, const char*)
native declaration : line 39

Parameters:

pHunspell - the handle on the hunspell object

slst - an out param used to return the analysis of the word

word - the word to analyze

Returns:

the number of suggestions returned in the out param slst

Hunspell_stem

public static int Hunspell_stem(org.bridj.Pointer<HunspellLibrary.Hunhandle> pHunspell,
                org.bridj.Pointer<org.bridj.Pointer<org.bridj.Pointer<Byte>>> slst,
                org.bridj.Pointer<Byte> word)

stemmer function

Original signature : int Hunspell_stem(Hunhandle*, char***, const char*)
native declaration : line 43

Parameters:

pHunspell - the handle on the hunspell object

slst - an out param used to return the possible stems of the word

word - the word to stem

Returns:

the number of suggestions returned in the out param slst

Hunspell_stem2

public static int Hunspell_stem2(org.bridj.Pointer<HunspellLibrary.Hunhandle> pHunspell,
                 org.bridj.Pointer<org.bridj.Pointer<org.bridj.Pointer<Byte>>> slst,
                 org.bridj.Pointer<org.bridj.Pointer<Byte>> desc,
                 int n)

get stems from a morph. analysis

Original signature : int Hunspell_stem2(Hunhandle*, char***, char**, int)
native declaration : line 52

Parameters:

pHunspell - the handle on the hunspell object

slst - an out param used to return the suggestions

desc - the output from Hunspell_analyze(Pointer, Pointer, Pointer) for the word you want to stem

n - the number of results in desc

Returns:

the number of suggestions returned in the out param slst

Hunspell_generate

public static int Hunspell_generate(org.bridj.Pointer<HunspellLibrary.Hunhandle> pHunspell,
                    org.bridj.Pointer<org.bridj.Pointer<org.bridj.Pointer<Byte>>> slst,
                    org.bridj.Pointer<Byte> word,
                    org.bridj.Pointer<Byte> word2)

morphological generation by example(s)

Original signature : int Hunspell_generate(Hunhandle*, char***, const char*, const char*)
native declaration : line 56

Parameters:

pHunspell - the handle on the hunspell object

slst - an out param used to return the possible stems of the word

word - the word to generate for

word2 - the word to use as an example to generate with

Returns:

the number of suggestions returned in the out param slst

Hunspell_generate2

public static int Hunspell_generate2(org.bridj.Pointer<HunspellLibrary.Hunhandle> pHunspell,
                     org.bridj.Pointer<org.bridj.Pointer<org.bridj.Pointer<Byte>>> slst,
                     org.bridj.Pointer<Byte> word,
                     org.bridj.Pointer<org.bridj.Pointer<Byte>> desc,
                     int n)

generation by morph. description(s)

Original signature : int Hunspell_generate2(Hunhandle*, char***, const char*, char**, int)
native declaration : line 67

Parameters:

pHunspell - the handle on the hunspell object

slst - an out param used to return the suggestions

word - the word to generate from

desc - the output from Hunspell_analyze(Pointer, Pointer, Pointer) for the word you want to use as an example for generation

n - the number of results in desc

Returns:

the number of suggestions returned in the out param slst

Hunspell_add

public static int Hunspell_add(org.bridj.Pointer<HunspellLibrary.Hunhandle> pHunspell,
               org.bridj.Pointer<Byte> word)

add word to the run-time dictionary

Original signature : int Hunspell_add(Hunhandle*, const char*)
native declaration : line 74

Parameters:

pHunspell - the handle on the hunspell object

word - the word to add to the runtime dictionary

Hunspell_add_with_affix

public static int Hunspell_add_with_affix(org.bridj.Pointer<HunspellLibrary.Hunhandle> pHunspell,
                          org.bridj.Pointer<Byte> word,
                          org.bridj.Pointer<Byte> example)

add word to the run-time dictionary with affix flags of the example (a dictionary word): Hunspell will recognize affixed forms of the new word, too.

Original signature: int Hunspell_add_with_affix(Hunhandle*, const char*, const char*)
native declaration : line 81

Parameters:

pHunspell - the handle on the hunspell object

word - the word to add to the runtime dictionary

example - the word to use as an example to figure out which affix flags apply to the added word

Returns:

non-zero if error occurs

Hunspell_remove

public static int Hunspell_remove(org.bridj.Pointer<HunspellLibrary.Hunhandle> pHunspell,
                  org.bridj.Pointer<Byte> word)

remove word from the run-time dictionary

Original signature : int Hunspell_remove(Hunhandle*, const char*)
native declaration : line 85

Parameters:

pHunspell - the handle on the hunspell object

word - the word to remove from the runtime dictionary

Returns:

non-zero if error occurs

Hunspell_free_list

public static void Hunspell_free_list(org.bridj.Pointer<HunspellLibrary.Hunhandle> pHunspell,
                      org.bridj.Pointer<org.bridj.Pointer<org.bridj.Pointer<Byte>>> slst,
                      int n)

free suggestion lists

Original signature : void Hunspell_free_list(Hunhandle*, char***, int)
native declaration : line 89

Parameters:

pHunspell - the handle on the hunspell object

slst - the returned list that you want to clear

n - the number of items in the list