node-sword-interface 1.0.26 → 1.0.28

package/API.md

@@ -65,6 +65,7 @@ This is the main class of node-sword-interface and it provides a set of static f
     * [.getBibleText(moduleCode)](#NodeSwordInterface+getBibleText) ⇒ [<code>Array.&lt;VerseObject&gt;</code>](#VerseObject)
     * [.getBookIntroduction(moduleCode, bookCode)](#NodeSwordInterface+getBookIntroduction) ⇒ <code>String</code>
     * [.moduleHasBook(moduleCode, bookCode)](#NodeSwordInterface+moduleHasBook) ⇒ <code>Boolean</code>
+    * [.getDictModuleKeys(moduleCode)](#NodeSwordInterface+getDictModuleKeys) ⇒ <code>Array.&lt;String&gt;</code>
     * [.getModuleSearchResults(moduleCode, searchTerm, progressCB, searchType, searchScope, isCaseSensitive, useExtendedVerseBoundaries)](#NodeSwordInterface+getModuleSearchResults) ⇒ <code>Promise</code>
     * [.terminateModuleSearch()](#NodeSwordInterface+terminateModuleSearch)
     * [.hebrewStrongsAvailable()](#NodeSwordInterface+hebrewStrongsAvailable) ⇒ <code>Boolean</code>
@@ -494,7 +495,7 @@ Returns the introduction of the given book.
 <a name="NodeSwordInterface+moduleHasBook"></a>
 
 ### nodeSwordInterface.moduleHasBook(moduleCode, bookCode) ⇒ <code>Boolean</code>
-Checks whether a module has a certain book
+Checks whether a module has a certain book.
 
 **Kind**: instance method of [<code>NodeSwordInterface</code>](#NodeSwordInterface)  
 
@@ -503,6 +504,17 @@ Checks whether a module has a certain book
 | moduleCode | <code>String</code> | 
 | bookCode | <code>String</code> | 
 
+<a name="NodeSwordInterface+getDictModuleKeys"></a>
+
+### nodeSwordInterface.getDictModuleKeys(moduleCode) ⇒ <code>Array.&lt;String&gt;</code>
+Returns the keys of a dictionary module.
+
+**Kind**: instance method of [<code>NodeSwordInterface</code>](#NodeSwordInterface)  
+
+| Param | Type |
+| --- | --- |
+| moduleCode | <code>String</code> | 
+
 <a name="NodeSwordInterface+getModuleSearchResults"></a>
 
 ### nodeSwordInterface.getModuleSearchResults(moduleCode, searchTerm, progressCB, searchType, searchScope, isCaseSensitive, useExtendedVerseBoundaries) ⇒ <code>Promise</code>

package/CMakeLists.txt

@@ -38,6 +38,7 @@ ${CMAKE_SOURCE_DIR}/src/sword_backend/module_store.cpp
 ${CMAKE_SOURCE_DIR}/src/sword_backend/repository_interface.cpp
 ${CMAKE_SOURCE_DIR}/src/sword_backend/sword_status_reporter.cpp
 ${CMAKE_SOURCE_DIR}/src/sword_backend/module_helper.cpp
+${CMAKE_SOURCE_DIR}/src/sword_backend/dict_helper.cpp
 ${CMAKE_SOURCE_DIR}/src/sword_backend/string_helper.cpp
 ${CMAKE_SOURCE_DIR}/src/sword_backend/file_system_helper.cpp
 ${CMAKE_SOURCE_DIR}/src/sword_backend/module_installer.cpp

package/binding.gyp

@@ -58,6 +58,7 @@
             "src/sword_backend/mutex.cpp",
             "src/sword_backend/file_system_helper.cpp",
             "src/sword_backend/module_helper.cpp",
+            "src/sword_backend/dict_helper.cpp",
             "src/sword_backend/module_store.cpp",
             "src/sword_backend/string_helper.cpp",
             "src/sword_backend/strongs_entry.cpp",

package/index.js

@@ -547,16 +547,26 @@ class NodeSwordInterface {
   }
 
   /**
-   * Checks whether a module has a certain book
+   * Checks whether a module has a certain book.
    * 
    * @param {String} moduleCode 
    * @param {String} bookCode 
-   * @returns {Boolean}
+   * @return {Boolean}
    */
   moduleHasBook(moduleCode, bookCode) {
     return this.nativeInterface.moduleHasBook(moduleCode, bookCode);
   }
 
+  /**
+   * Returns the keys of a dictionary module.
+   * 
+   * @param {String} moduleCode 
+   * @return {String[]}
+   */
+  getDictModuleKeys(moduleCode) {
+    return this.nativeInterface.getDictModuleKeys(moduleCode);
+  }
+
   /**
    * Returns the results of a module search.
    *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-sword-interface",
-  "version": "1.0.26",
+  "version": "1.0.28",
   "description": "Javascript (N-API) interface to SWORD library",
   "keywords": [
     "C++",
@@ -28,7 +28,7 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/ezra-bible-app/node-sword-interface.git"
+    "url": "git+https://github.com/ezra-bible-app/node-sword-interface.git"
   },
   "devDependencies": {
     "jsdoc-to-markdown": "^8.0.3",

package/src/napi_module/node_sword_interface.cpp

@@ -34,6 +34,7 @@
 #include "module_store.hpp"
 #include "module_installer.hpp"
 #include "module_helper.hpp"
+#include "dict_helper.hpp"
 #include "text_processor.hpp"
 #include "module_search.hpp"
 #include "mutex.hpp"
@@ -101,6 +102,7 @@ Napi::Object NodeSwordInterface::Init(Napi::Env env, Napi::Object exports)
         InstanceMethod("getChapterVerseCount", &NodeSwordInterface::getChapterVerseCount),
         InstanceMethod("getBookIntroduction", &NodeSwordInterface::getBookIntroduction),
         InstanceMethod("moduleHasBook", &NodeSwordInterface::moduleHasBook),
+        InstanceMethod("getDictModuleKeys", &NodeSwordInterface::getDictModuleKeys),
         InstanceMethod("getModuleSearchResults", &NodeSwordInterface::getModuleSearchResults),
         InstanceMethod("terminateModuleSearch", &NodeSwordInterface::terminateModuleSearch),
         InstanceMethod("getStrongsEntry", &NodeSwordInterface::getStrongsEntry),
@@ -174,6 +176,7 @@ NodeSwordInterface::NodeSwordInterface(const Napi::CallbackInfo& info) : Napi::O
     if (!homeDirError && !localeDirError) { // We only proceed if there has not been any issue with the homeDir or localeDir
         this->_moduleStore = new ModuleStore(this->customHomeDir);
         this->_moduleHelper = new ModuleHelper(*(this->_moduleStore));
+        this->_dictHelper = new DictHelper(*(this->_moduleStore));
         this->_repoInterface = new RepositoryInterface(this->_swordStatusReporter, *(this->_moduleHelper), *(this->_moduleStore), this->customHomeDir);
         this->_moduleInstaller = new ModuleInstaller(*(this->_repoInterface), *(this->_moduleStore), this->customHomeDir);
         this->_napiSwordHelper = new NapiSwordHelper(*(this->_moduleHelper), *(this->_moduleStore));
@@ -710,6 +713,21 @@ Napi::Value NodeSwordInterface::moduleHasBook(const Napi::CallbackInfo& info)
     return hasBook;
 }
 
+Napi::Value NodeSwordInterface::getDictModuleKeys(const Napi::CallbackInfo& info)
+{
+    lockApi();
+    Napi::Env env = info.Env();
+    INIT_SCOPE_AND_VALIDATE(ParamType::string);
+    Napi::String moduleName = info[0].As<Napi::String>();
+    ASSERT_SW_MODULE_EXISTS(moduleName);
+
+    vector<string> dictModuleKeys = this->_dictHelper->getKeyList(moduleName);
+    Napi::Array dictModuleKeyArray = this->_napiSwordHelper->getNapiArrayFromStringVector(env, dictModuleKeys);
+
+    unlockApi();
+    return dictModuleKeyArray;
+}
+
 Napi::Value NodeSwordInterface::getModuleSearchResults(const Napi::CallbackInfo& info)
 {
     lockApi();

package/src/napi_module/node_sword_interface.hpp

@@ -29,6 +29,7 @@ class ModuleInstaller;
 class TextProcessor;
 class NapiSwordHelper;
 class ModuleHelper;
+class DictHelper;
 class ModuleSearch;
 class ModuleSearchWorker;
 enum class ModuleType;
@@ -82,6 +83,7 @@ private:
     Napi::Value getChapterVerseCount(const Napi::CallbackInfo& info);
     Napi::Value getBookIntroduction(const Napi::CallbackInfo& info);
     Napi::Value moduleHasBook(const Napi::CallbackInfo& info);
+    Napi::Value getDictModuleKeys(const Napi::CallbackInfo& info);
 
     Napi::Value getModuleSearchResults(const Napi::CallbackInfo& info);
     Napi::Value terminateModuleSearch(const Napi::CallbackInfo& info);
@@ -104,6 +106,7 @@ private:
     bool dirExists(const Napi::CallbackInfo& info, std::string dirName);
 
     ModuleHelper* _moduleHelper;
+    DictHelper* _dictHelper;
     NapiSwordHelper* _napiSwordHelper;
     RepositoryInterface* _repoInterface;
     ModuleStore* _moduleStore;

package/src/node_sword_cli.cpp

@@ -3,6 +3,7 @@
 #include "module_store.hpp"
 #include "text_processor.hpp"
 #include "module_helper.hpp"
+#include "dict_helper.hpp"
 #include "module_installer.hpp"
 #include "strongs_entry.hpp"
 #include "module_search.hpp"
@@ -126,6 +127,17 @@ void get_book_list(ModuleHelper& module_helper)
     }
 }
 
+void get_dict_key_list(DictHelper& dict_helper)
+{
+    vector<string> keyList = dict_helper.getKeyList("Vines");
+
+    cout << "Got " << keyList.size() << " entries!" << endl;
+
+    for (int i = 0; i < keyList.size(); i++) {
+        cout << keyList[i] << endl;
+    }
+}
+
 void test_unlock_key(ModuleInstaller& module_installer, ModuleStore& module_store, TextProcessor& text_processor)
 {
     module_installer.uninstallModule("NA28");
@@ -167,6 +179,7 @@ int main(int argc, char** argv)
 {
     ModuleStore moduleStore;
     ModuleHelper moduleHelper(moduleStore);
+    DictHelper dictHelper(moduleStore);
     SwordStatusReporter statusReporter;
     RepositoryInterface repoInterface(statusReporter, moduleHelper, moduleStore);
     ModuleInstaller moduleInstaller(repoInterface, moduleStore);
@@ -209,7 +222,7 @@ int main(int argc, char** argv)
     /*sword_facade.installModule("StrongsHebrew");
     sword_facade.installModule("StrongsGreek");*/
 
-    get_strongs_entry(textProcessor);
+    //get_strongs_entry(textProcessor);
 
     //get_module_text(textProcessor);
 
@@ -217,6 +230,8 @@ int main(int argc, char** argv)
 
     //get_book_list(moduleHelper);
 
+    get_dict_key_list(dictHelper);
+
     //string translation = sword_facade.getSwordTranslation(string("/usr/share/sword/locales.d"), string("de"), string("locales"));
     //cout << translation << endl;
 

package/src/sword_backend/dict_helper.cpp

@@ -0,0 +1,69 @@
+/* This file is part of node-sword-interface.
+
+   Copyright (C) 2019 - 2024 Tobias Klein <contact@tklein.info>
+
+   node-sword-interface 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 2 of the License, or
+   (at your option) any later version.
+
+   node-sword-interface 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 node-sword-interface. See the file COPYING.
+   If not, see <http://www.gnu.org/licenses/>. */
+
+// Sword includes
+#include <swmodule.h>
+#include <swld.h>
+
+#include "dict_helper.hpp"
+
+using namespace std;
+using namespace sword;
+
+std::vector<std::string> DictHelper::getKeyList(std::string moduleName)
+{
+    vector<string> keyList;
+
+    if (moduleName.size() == 0) {
+        cerr << "getKeyList: Cannot work with empty moduleName!" << endl;
+        return keyList;
+    }
+
+    SWModule* module = this->_moduleStore.getLocalModule(moduleName);
+
+    if (module == 0) {
+        cerr << "getLocalModule returned zero pointer for " << moduleName << endl;
+
+    } else {
+        const char* moduleType = module->getType();
+
+        if (strcmp(moduleType, "Lexicons / Dictionaries") != 0) {
+
+            cerr << "Given module is not a lexicon/dictionary!" << endl;
+
+        } else {
+            sword::SWLD* swldModule = static_cast<sword::SWLD*>(module);
+
+            if (swldModule == NULL) {
+
+                cerr << "Could not initialize module " << moduleName << " as SWLD module." << endl;
+
+            } else {
+                long entryCount = swldModule->getEntryCount();
+
+                for (long i = 0; i < entryCount; i++) {
+                    const char* key = swldModule->getKeyForEntry(i);
+                    string stringKey = string(key);
+                    keyList.push_back(stringKey);
+                }
+            }
+        }
+    }
+
+    return keyList;
+}

package/src/sword_backend/dict_helper.hpp

@@ -0,0 +1,39 @@
+/* This file is part of node-sword-interface.
+
+   Copyright (C) 2019 - 2024 Tobias Klein <contact@tklein.info>
+
+   node-sword-interface 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 2 of the License, or
+   (at your option) any later version.
+
+   node-sword-interface 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 node-sword-interface. See the file COPYING.
+   If not, see <http://www.gnu.org/licenses/>. */
+
+#ifndef _DICT_HELPER
+#define _DICT_HELPER
+
+#include <string>
+#include <vector>
+
+#include "module_store.hpp"
+
+class DictHelper {
+public:
+    DictHelper(ModuleStore& moduleStore) : _moduleStore(moduleStore) {}
+
+    std::vector<std::string> getKeyList(std::string moduleName);
+
+    virtual ~DictHelper(){}
+
+private:
+    ModuleStore& _moduleStore;
+};
+
+#endif // _DICT_HELPER

package/src/sword_backend/module_helper.cpp

@@ -83,9 +83,12 @@ bool ModuleHelper::moduleHasBook(sword::SWModule* module, std::string bookCode)
        For apocryphal books we may get "Rev 1:1" as actual module key and this will mismatch with the set key
        and then indicate that the book is not existing. */
 
-    if (moduleKeyText != key.str()) {
+    // We compare the first three letters of the two keys to see whether the key retrieved matches the key we are looking for
+    if (moduleKeyText.size() >= 3 && key.str().size() >= 3 && moduleKeyText.substr(0,3) != key.str().substr(0,3)) {
         hasBook = false;
     } else {
+        // The first three letters of the key seem ok.
+        // Now let's check next whether the module has the corresponding entry.
         hasBook = module->hasEntry(module->getKey());
     }