lyx_mirror/src/AspellChecker.cpp

370 lines
10 KiB
C++
Raw Normal View History

/**
* \file AspellChecker.cpp
* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
* \author Kevin Atkinson
* \author John Levon
*
* Full author contact details are available in file CREDITS.
*/
#include <config.h>
#include "AspellChecker.h"
#include "LyXRC.h"
#include "WordLangTuple.h"
#include "support/lassert.h"
#include "support/debug.h"
#include "support/docstring_list.h"
#include "support/filetools.h"
#include "support/Package.h"
#include "support/FileName.h"
#include "support/Path.h"
#include <aspell.h>
#include <map>
#include <string>
using namespace std;
using namespace lyx::support;
namespace lyx {
namespace {
struct Speller {
AspellConfig * config;
AspellCanHaveError * e_speller;
};
typedef std::map<std::string, Speller> Spellers;
} // anon namespace
struct AspellChecker::Private
{
Private() {}
~Private();
/// add a speller of the given language and variety
AspellSpeller * addSpeller(string const & lang,
string const & variety = string());
///
AspellSpeller * speller(string const & lang,
string const & variety);
/// create a unique ID from lang code and variety
string const spellerID(string const & lang,
string const & variety);
bool isValidDictionary(AspellConfig * config,
string const & lang, string const & variety);
bool checkAspellData(AspellConfig * config,
string const & basepath, string const & datapath, string const & dictpath,
string const & lang, string const & variety);
AspellConfig * getConfig(string const & lang, string const & variety);
/// the spellers
Spellers spellers_;
/// the location below system/user directory
/// there the rws files lookup will happen
const string dictDirectory(void) { return "dict"; }
/// there the dat+cmap files lookup will happen
const string dataDirectory(void) { return "data"; }
/// os package directory constants
/// macports on Mac OS X or
/// aspell rpms on Linux
const string osPackageBase(void) {
#ifdef USE_MACOSX_PACKAGING
return "/opt/local";
#else
return "/usr";
#endif
}
const string osPackageDictDirectory(void) {
#ifdef USE_MACOSX_PACKAGING
return "/share/aspell";
#else
return "/lib/aspell-0.60";
#endif
}
const string osPackageDataDirectory(void) { return "/lib/aspell-0.60"; }
};
AspellChecker::Private::~Private()
{
Spellers::iterator it = spellers_.begin();
Spellers::iterator end = spellers_.end();
for (; it != end; ++it) {
if (it->second.e_speller) {
AspellSpeller * speller = to_aspell_speller(it->second.e_speller);
aspell_speller_save_all_word_lists(speller);
delete_aspell_can_have_error(it->second.e_speller);
}
delete_aspell_config(it->second.config);
}
}
bool AspellChecker::Private::isValidDictionary(AspellConfig * config,
string const & lang, string const & variety)
{
bool have = false;
// code taken from aspell's list-dicts example
// the returned pointer should _not_ need to be deleted
AspellDictInfoList * dlist = get_aspell_dict_info_list(config);
AspellDictInfoEnumeration * dels = aspell_dict_info_list_elements(dlist);
const AspellDictInfo * entry;
while (0 != (entry = aspell_dict_info_enumeration_next(dels))) {
LYXERR(Debug::DEBUG, "aspell dict:"
<< " name=" << entry->name
<< ",code=" << entry->code
<< ",variety=" << entry->jargon);
if (entry->code == lang && (variety.empty() || entry->jargon == variety)) {
have = true;
break;
}
}
delete_aspell_dict_info_enumeration(dels);
LYXERR(Debug::FILES, "aspell dictionary: " << lang << (have ? " yes" : " no"));
return have;
}
bool AspellChecker::Private::checkAspellData(AspellConfig * config,
string const & basepath, string const & datapath, string const & dictpath,
string const & lang, string const & variety)
{
FileName base(basepath);
bool have_dict = base.isDirectory() ;
if (have_dict) {
FileName data(addPath(base.absFileName(), datapath));
FileName dict(addPath(base.absFileName(), dictpath));
have_dict = dict.isDirectory() && data.isDirectory();
if (have_dict) {
LYXERR(Debug::FILES, "aspell dict-dir: " << dict);
LYXERR(Debug::FILES, "aspell data-dir: " << data);
aspell_config_replace(config, "dict-dir", dict.absFileName().c_str());
aspell_config_replace(config, "data-dir", data.absFileName().c_str());
have_dict = isValidDictionary(config, lang, variety);
}
}
return have_dict ;
}
AspellConfig * AspellChecker::Private::getConfig(string const & lang, string const & variety)
{
AspellConfig * config = new_aspell_config();
bool have_dict = false;
string const sysdir = lyx::support::package().system_support().absFileName() ;
string const userdir = lyx::support::package().user_support().absFileName() ;
LYXERR(Debug::FILES, "aspell user dir: " << userdir);
have_dict = checkAspellData(config, userdir, dataDirectory(), dictDirectory(), lang, variety);
if (!have_dict) {
LYXERR(Debug::FILES, "aspell sysdir dir: " << sysdir);
have_dict = checkAspellData(config, sysdir, dataDirectory(), dictDirectory(), lang, variety);
}
if (!have_dict) {
// check for package data of OS installation
have_dict = checkAspellData(config, osPackageBase(), osPackageDataDirectory(), osPackageDictDirectory(), lang, variety);
}
return config ;
}
AspellSpeller * AspellChecker::Private::addSpeller(string const & lang,
string const & variety)
{
Speller m;
m.config = getConfig(lang, variety);
// Aspell supports both languages and varieties (such as German
// old vs. new spelling). The respective naming convention is
// lang_REGION-variety (e.g. de_DE-alt).
aspell_config_replace(m.config, "lang", lang.c_str());
if (!variety.empty())
aspell_config_replace(m.config, "variety", variety.c_str());
// Set the encoding to utf-8.
// aspell does also understand "ucs-4", so we would not need a
// conversion in theory, but if this is used it expects all
// char const * arguments to be a cast from uint const *, and it
// seems that this uint is not compatible with our char_type on some
// platforms (cygwin, OS X). Therefore we use utf-8, that does
// always work.
aspell_config_replace(m.config, "encoding", "utf-8");
if (lyxrc.spellchecker_accept_compound)
// Consider run-together words as legal compounds
aspell_config_replace(m.config, "run-together", "true");
else
// Report run-together words as errors
aspell_config_replace(m.config, "run-together", "false");
m.e_speller = new_aspell_speller(m.config);
if (aspell_error_number(m.e_speller) != 0) {
// FIXME: We should indicate somehow that this language is not supported.
LYXERR(Debug::FILES, "aspell error: " << aspell_error_message(m.e_speller));
delete_aspell_can_have_error(m.e_speller);
delete_aspell_config(m.config);
m.config = 0;
m.e_speller = 0;
}
spellers_[spellerID(lang, variety)] = m;
return m.e_speller ? to_aspell_speller(m.e_speller) : 0;
}
AspellSpeller * AspellChecker::Private::speller(string const & lang,
string const & variety)
{
Spellers::iterator it = spellers_.find(spellerID(lang, variety));
if (it != spellers_.end())
return to_aspell_speller(it->second.e_speller);
return addSpeller(lang, variety);
}
string const AspellChecker::Private::spellerID(string const & lang,
string const & variety)
{
if (variety.empty())
return lang;
return lang + "-" + variety;
}
AspellChecker::AspellChecker(): d(new Private)
{
}
AspellChecker::~AspellChecker()
{
delete d;
}
SpellChecker::Result AspellChecker::check(WordLangTuple const & word)
{
AspellSpeller * m =
d->speller(word.lang()->code(), word.lang()->variety());
if (!m)
return WORD_OK;
if (word.word().empty())
// MSVC compiled Aspell doesn't like it.
return WORD_OK;
string const word_str = to_utf8(word.word());
int const word_ok = aspell_speller_check(m, word_str.c_str(), -1);
LASSERT(word_ok != -1, /**/);
return (word_ok) ? WORD_OK : UNKNOWN_WORD;
}
void AspellChecker::insert(WordLangTuple const & word)
{
Spellers::iterator it = d->spellers_.find(
d->spellerID(word.lang()->code(), word.lang()->variety()));
if (it != d->spellers_.end()) {
AspellSpeller * speller = to_aspell_speller(it->second.e_speller);
aspell_speller_add_to_personal(speller, to_utf8(word.word()).c_str(), -1);
}
}
void AspellChecker::accept(WordLangTuple const & word)
{
Spellers::iterator it = d->spellers_.find(
d->spellerID(word.lang()->code(), word.lang()->variety()));
if (it != d->spellers_.end()) {
AspellSpeller * speller = to_aspell_speller(it->second.e_speller);
aspell_speller_add_to_session(speller, to_utf8(word.word()).c_str(), -1);
}
}
void AspellChecker::suggest(WordLangTuple const & wl,
docstring_list & suggestions)
{
suggestions.clear();
AspellSpeller * m =
d->speller(wl.lang()->code(), wl.lang()->variety());
if (!m)
return;
AspellWordList const * sugs =
aspell_speller_suggest(m, to_utf8(wl.word()).c_str(), -1);
LASSERT(sugs != 0, /**/);
AspellStringEnumeration * els = aspell_word_list_elements(sugs);
if (!els || aspell_word_list_empty(sugs))
return;
for (;;) {
char const * str = aspell_string_enumeration_next(els);
if (!str)
break;
suggestions.push_back(from_utf8(str));
}
delete_aspell_string_enumeration(els);
}
bool AspellChecker::hasDictionary(Language const * lang) const
{
bool have = false;
Spellers::iterator it = d->spellers_.begin();
Spellers::iterator end = d->spellers_.end();
if (lang) {
for (; it != end && !have; ++it) {
have = it->second.config && d->isValidDictionary(it->second.config, lang->code(), lang->variety());
}
if (!have) {
AspellConfig * config = d->getConfig(lang->code(), lang->variety());
have = d->isValidDictionary(config, lang->code(), lang->variety());
delete_aspell_config(config);
}
}
return have;
}
docstring const AspellChecker::error()
{
Spellers::iterator it = d->spellers_.begin();
Spellers::iterator end = d->spellers_.end();
char const * err = 0;
for (; it != end && 0 == err; ++it) {
if (it->second.e_speller && aspell_error_number(it->second.e_speller) != 0)
err = aspell_error_message(it->second.e_speller);
}
// FIXME UNICODE: err is not in UTF8, but probably the locale encoding
return (err ? from_utf8(err) : docstring());
}
} // namespace lyx