-
-
Notifications
You must be signed in to change notification settings - Fork 5
Added support for spelling correction in our bindings. #130
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| <?xml version="1.0"?> | ||
| <!DOCTYPE module PUBLIC | ||
| "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN" | ||
| "https://checkstyle.org/dtds/configuration_1_3.dtd"> | ||
|
|
||
| <module name="Checker"> | ||
| <module name="TreeWalker"> | ||
| <!-- Disable the NoFinalizerCheck so finalize() is allowed --> | ||
| <module name="NoFinalizer"> | ||
| <property name="severity" value="ignore" /> | ||
| </module> | ||
| </module> | ||
| </module> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| /* | ||
| * Copyright (C) 2025 Matthieu Gautier <mgautier@kymeria.fr> | ||
| * | ||
| * This program is free software; you can redistribute it and/or modify | ||
| * it under the terms of the GNU General Public License as published by | ||
| * the Free Software Foundation; either version 3 of the License, or | ||
| * any later version. | ||
| * | ||
| * 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. See the | ||
| * GNU General Public License for more details. | ||
| * | ||
| * You should have received a copy of the GNU General Public License | ||
| * along with this program; if not, write to the Free Software | ||
| * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, | ||
| * MA 02110-1301, USA. | ||
| */ | ||
|
|
||
| #include <jni.h> | ||
| #include "org_kiwix_libkiwix_SpellingsDB.h" | ||
| #include "spelling_correction.h" | ||
| #include <zim/archive.h> | ||
| #include "utils.h" | ||
|
|
||
| #define NATIVE_TYPE kiwix::SpellingsDB | ||
| #define TYPENAME libkiwix_SpellingsDB | ||
|
|
||
| #include <macros.h> | ||
|
|
||
| METHOD(void, setNativeSpellingsDB, jobject archive, jstring cacheDirPath) { | ||
| auto archive1 = getPtr<zim::Archive>(env, archive); | ||
| std::string cPath = TO_C(cacheDirPath); | ||
|
|
||
| auto spellingsDB = std::make_shared<kiwix::SpellingsDB>(*archive1, cPath); | ||
| SET_PTR(spellingsDB); | ||
| } CATCH_EXCEPTION() | ||
|
|
||
| DISPOSE | ||
|
|
||
| METHOD(jobjectArray, getSpellingCorrections, jstring jWord, jint maxCount) { | ||
| auto results = THIS->getSpellingCorrections(TO_C(jWord), TO_C(maxCount)); | ||
| jclass stringClass = env->FindClass("java/lang/String"); | ||
| jobjectArray jArray = env->NewObjectArray(results.size(), stringClass, nullptr); | ||
|
|
||
| for (size_t i = 0; i < results.size(); ++i) { | ||
| env->SetObjectArrayElement(jArray, i, TO_JNI(results[i])); | ||
| } | ||
|
|
||
| return jArray; | ||
| } CATCH_EXCEPTION(nullptr) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| package org.kiwix.libkiwix; | ||
|
|
||
| import org.kiwix.libzim.Archive; | ||
|
|
||
| public class SpellingsDB { | ||
| public SpellingsDB(Archive archive, String cacheDirPath) { | ||
| setNativeSpellingsDB(archive, cacheDirPath); | ||
| } | ||
|
|
||
| private native void setNativeSpellingsDB(Archive archive, String cacheDirPath); | ||
| public native String[] getSpellingCorrections(String word, int maxCount); | ||
|
|
||
| @Override | ||
| protected void finalize() { dispose(); } | ||
|
|
||
| ///--------- The wrapper thing | ||
| // To delete our native wrapper | ||
| public native void dispose(); | ||
| // A pointer (as a long) to a native Handle | ||
| private long nativeHandle; | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| /* | ||
| * Copyright (C) 2025 Matthieu Gautier <mgautier@kymeria.fr> | ||
| * | ||
| * This program is free software; you can redistribute it and/or modify | ||
| * it under the terms of the GNU General Public License as published by | ||
| * the Free Software Foundation; either version 3 of the License, or | ||
| * any later version. | ||
| * | ||
| * 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. See the | ||
| * GNU General Public License for more details. | ||
| * | ||
| * You should have received a copy of the GNU General Public License | ||
| * along with this program; if not, write to the Free Software | ||
| * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, | ||
| * MA 02110-1301, USA. | ||
| */ | ||
|
|
||
| package org.kiwix.test.libkiwix; | ||
|
|
||
| import org.kiwix.libkiwix.SpellingsDB; | ||
| import org.kiwix.libzim.Archive; | ||
| import org.kiwix.test.libzim.TestArchive; | ||
|
|
||
| public class TestSpellingsDB { | ||
| private SpellingsDB inner; | ||
|
|
||
| public TestSpellingsDB(TestArchive archive, String cacheDirPath) { | ||
| inner = new SpellingsDB(archive.inner(), cacheDirPath); | ||
| } | ||
|
|
||
| public String[] getSpellingCorrections(String word, int maxCount) { | ||
| return inner.getSpellingCorrections(word, maxCount); | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A fraud implementation of
getSpellingCorrections()always returning the string "Test ZIM file" packaged into a single element array will pass this test. In fact, it may return an array containing more than one element and the test will still pass.Tests should be written in a way ruling out such temporary implementations (acceptable in TDD approach). At a minimum, you should cover the case when no spelling correction is returned.