GitHub - pbsurf/luahunspell

Branches Tags

Name		Name	Last commit message	Last commit date
Latest commit History 10 Commits
hunspell/src/lua		hunspell/src/lua
scite_lua		scite_lua
README.TXT		README.TXT

Repository files navigation

LuaHunspell
19 March 2010
updated 20 Aug 2020

Installing for use with SciTE on Linux:

1. Install hunspell library and desired dictionaries (e.g., apt install libhunspell-1.3.0 hunspell-en-us)
2. Copy hunspell.so to SciteDefaultHome (usually /usr/share/scite).  See instructions in luahunspell.cpp for building from source.
3. Extract scite_lua\spellcheck.lua to scite_lua folder (assumes SciTE ExtMan is in use)

Installing for use with SciTE on Windows:

1. Copy hunspell.dll to SciTE folder (e.g., C:\Program Files\wscite).  See below for building from source.
2. Get desired dictionary files from http://hunspell.sourceforge.net/
3. Extract scite_lua\spellcheck.lua to scite_lua folder (assumes SciTE ExtMan is in use)

Using with SciTE:

1. spellcheck.lua assumes en_US dictionary files (.aff, .dic) are located in SciteDefaultHome (Windows) or /usr/share/hunspell (Linux).  Otherwise, set the 'spell.dictpath' and/or 'spell.dictname' properties in SciTEGlobal.properties or SciTEUser.properties (see example below).  .
2. Tools->Toggle Spelling (F9) checks the document and underlines misspelled words; a second time turns off underlining.  Double-click on a word to see suggestions.  Double-click suggestion to make replacement.  The keyboard shortcut can be changed in spellcheck.lua.  Spell checking must be turned off and back on to refresh. 


# Usage example for spell.dictname, dictpath
spell.dictpath=$(SciteDefaultHome)\dict
# do not include file extension
spell.dictname=en_US

Installing SciTE ExtMan under Windows:
- Ignore this if you already have ExtMan working.

1. Obtain extman.lua and spawner-ex.dll from scite-debug (http://scitedebug.luaforge.net/) and copy to SciTE folder.  The version of extman.lua from the the lua-users wiki may not work, at least on Vista.
2. In SciTE properties file (i.e., SciTEGlobal.properties or SciTEUser.properties), add the following:
    ext.lua.startup.script=$(SciteDefaultHome)\extman.lua
Must use a backslash ('\') here or scite_lua folder won't be found (strangely, '/' does work for some other versions of ExtMan).
3. Create scite_lua subfolder in SciTE folder.  Place lua scripts (e.g. spellcheck.lua) here.


Building (Visual C++):

1. Extract contents of hunspell into hunspell source distribution (from, e.g., hunspell-1.2.9.tar.gz)
2. Open src\lua\luahunspell.vcproj (VC++ 2005 project) and adjust "Additional Dependencies" under Configuration Properties->Linker->Input as necessary.  The enclosed SciTE.lib can be used if building SciTE version.
3. Build hunspell.dll.  For SciTE, select SciTE-Release configuration.

Usage example:
  require("hunspell")
  hunspell.init("C:\\hunspell\\en_US.aff", "C:\\hunspell\\en_US.dic")
  iswordrecogized = hunspell.spell("teh")
  suggestions = hunspell.suggest("teh")  -- returns table of strings


spellcheck.lua changes:

0.2 - 2012/06/19:
- add linux support
0.1c - 2010/03/19:
- made dictionary loading check optional (default is to skip check - see spell_testword variable)
- dictionary path and name can be set in SciTE properties file
- changed to modern indicators instead of style byte indicators; fixes failure with HTML files
- moved word extraction code into a generic for iterator, minor improvements; added simple word extraction function
- word used for generating suggestions now agrees with underlined word
- added a tools menu command to show suggestions without double-clicking
0.1b - 2010/03/11: 
- initial version


Related projects:
* Orthospell: https://groups.google.com/g/scite-interest/c/Eu8D7E5yqrE