1 /* This file is part of
2 * ======================================================
4 * LyX, The Document Processor
6 * Copyright 2001 The LyX Team.
8 * ======================================================
11 * \author Kevin Atkinson
17 #pragma implementation
24 #if TIME_WITH_SYS_TIME
25 # include <sys/time.h>
29 # include <sys/time.h>
35 #ifdef HAVE_SYS_SELECT_H
36 # ifdef HAVE_STRINGS_H
37 // <strings.h> is needed at least on AIX because FD_ZERO uses bzero().
38 // BUT we cannot include both string.h and strings.h on Irix 6.5 :(
43 #include <sys/select.h>
47 #include "support/lstrings.h"
51 #include "sp_ispell.h"
56 /// pid for the `ispell' process.
60 /// can be found in src/insets/figinset.C
61 extern void sigchldchecker(pid_t pid, int * status);
64 // ------------------- start special pspell code/class --------------------
68 #include "support/LAssert.h"
70 #define USE_ORIGINAL_MANAGER_FUNCS 1
71 # include <pspell/pspell.h>
73 #include "sp_pspell.h"
77 : sc(0), els(0), spell_error_object(0), flag(ISP_UNKNOWN)
81 PSpell::PSpell(BufferParams const & params, string const & lang)
82 : sc(0), els(0), spell_error_object(0), flag(ISP_UNKNOWN)
84 initialize(params, lang);
92 delete_pspell_string_emulation(els);
96 void PSpell::initialize(BufferParams const &, string const & lang)
98 PspellConfig * config = new_pspell_config();
99 config->replace("language-tag", lang.c_str());
100 spell_error_object = new_pspell_manager(config);
101 if (pspell_error_number(spell_error_object) != 0) {
102 error_ = pspell_error_message(spell_error_object);
105 sc = to_pspell_manager(spell_error_object);
106 spell_error_object = 0;
111 void PSpell::cleanUp()
113 if (spell_error_object) {
114 delete_pspell_can_have_error(spell_error_object);
115 spell_error_object = 0;
120 enum PSpell::spellStatus PSpell::check(string const & word)
125 int word_ok = pspell_manager_check(sc, word.c_str());
126 lyx::Assert(word_ok != -1);
131 PspellWordList const * sugs =
132 pspell_manager_suggest(sc, word.c_str());
133 lyx::Assert(sugs != 0);
134 els = pspell_word_list_elements(sugs);
135 if (pspell_word_list_empty(sugs))
147 pspell_manager_save_all_word_lists(sc);
151 void PSpell::insert(string const & word)
154 pspell_manager_add_to_personal(sc, word.c_str());
158 void PSpell::accept(string const & word)
161 pspell_manager_add_to_session(sc, word.c_str());
165 void PSpell::store(string const & mis, string const & cor)
168 pspell_manager_store_replacement(sc, mis.c_str(), cor.c_str());
172 char const * PSpell::nextMiss()
175 return pspell_string_emulation_next(els);
179 char const * PSpell::error()
184 void PSpell::sigchldhandler(pid_t pid, int * status)
186 sigchldchecker(pid, status);
192 // ------------------- start special ispell code/class --------------------
202 ISpell::ISpell(BufferParams const & params, string const & lang)
206 initialize(params, lang);
216 char const * ISpell::nextMiss()
218 if (str == 0 || *(e+1) == '\0') return 0;
220 e = strpbrk(b, ",\n");
226 void ISpell::initialize(BufferParams const & params, string const & lang)
228 static char o_buf[BUFSIZ]; // jc: it could be smaller
229 int pipein[2], pipeout[2];
235 if (pipe(pipein) == -1 || pipe(pipeout) == -1) {
236 lyxerr << "LyX: Can't create pipe for spellchecker!" << endl;
240 if ((out = fdopen(pipein[1], "w")) == 0) {
241 lyxerr << "LyX: Can't create stream for pipe for spellchecker!"
246 if ((in = fdopen(pipeout[0], "r")) == 0) {
247 lyxerr <<"LyX: Can't create stream for pipe for spellchecker!"
252 setvbuf(out, o_buf, _IOLBF, BUFSIZ);
259 lyxerr << "LyX: Can't create child process for spellchecker!"
266 dup2(pipein[0], STDIN_FILENO);
267 dup2(pipeout[1], STDOUT_FILENO);
274 char * tmp = new char[lyxrc.isp_command.length() + 1];
275 lyxrc.isp_command.copy(tmp, lyxrc.isp_command.length());
276 tmp[lyxrc.isp_command.length()] = '\0';
279 string("-a").copy(tmp, 2); tmp[2] = '\0'; // pipe mode
282 if (lang != "default") {
284 string("-d").copy(tmp, 2); tmp[2] = '\0'; // Dictionary file
286 tmp = new char[lang.length() + 1];
287 lang.copy(tmp, lang.length()); tmp[lang.length()] = '\0';
291 if (lyxrc.isp_accept_compound) {
292 // Consider run-together words as legal compounds
294 string("-C").copy(tmp, 2); tmp[2] = '\0';
297 // Report run-together words with
298 // missing blanks as errors
300 string("-B").copy(tmp, 2); tmp[2] = '\0';
303 if (lyxrc.isp_use_esc_chars) {
304 // Specify additional characters that
305 // can be part of a word
307 string("-w").copy(tmp, 2); tmp[2] = '\0';
309 // Put the escape chars in ""s
310 string tms = "\"" + lyxrc.isp_esc_chars + "\"";
311 tmp = new char[tms.length() + 1];
312 tms.copy(tmp, tms.length()); tmp[tms.length()] = '\0';
315 if (lyxrc.isp_use_pers_dict) {
316 // Specify an alternate personal dictionary
318 string("-p").copy(tmp, 2);
321 tmp = new char[lyxrc.isp_pers_dict.length() + 1];
322 lyxrc.isp_pers_dict.copy(tmp, lyxrc.isp_pers_dict.length());
323 tmp[lyxrc.isp_pers_dict.length()] = '\0';
326 if (lyxrc.isp_use_input_encoding &&
327 params.inputenc != "default") {
328 string enc = (params.inputenc == "auto")
329 ? params.language->encoding()->LatexName()
331 string::size_type n = enc.length();
333 string("-T").copy(tmp, 2); tmp[2] = '\0';
334 argv[argc++] = tmp; // Input encoding
335 tmp = new char[n + 1];
343 execvp(argv[0], const_cast<char * const *>(argv));
345 // free the memory used by string::copy in the
347 for (int i= 0; i < argc -1; ++i)
350 lyxerr << "LyX: Failed to start ispell!" << endl;
354 /* Parent process: Read ispells identification message */
355 // Hmm...what are we using this id msg for? Nothing? (Lgb)
356 // Actually I used it to tell if it's truly Ispell or if it's
357 // aspell -- (kevinatk@home.com)
363 FD_SET(pipeout[0], &infds);
364 tv.tv_sec = 15; // fifteen second timeout. Probably too much,
365 // but it can't really hurt.
368 // Configure provides us with macros which are supposed to do
369 // the right typecast.
370 retval = select(SELECT_TYPE_ARG1 (pipeout[0]+1),
371 SELECT_TYPE_ARG234 (&infds),
374 SELECT_TYPE_ARG5 (&tv));
377 // Ok, do the reading. We don't have to FD_ISSET since
378 // there is only one fd in infds.
379 fgets(buf, 2048, in);
381 // determine if the spell checker is really Aspell
382 if (strstr(buf, "Aspell"))
383 actual_spell_checker = ASC_ASPELL;
385 actual_spell_checker = ASC_ISPELL;
387 fputs("!\n", out); // Set terse mode (silently accept correct words)
390 } else if (retval == 0) {
391 // timeout. Give nice message to user.
392 lyxerr << "Ispell read timed out, what now?" << endl;
393 // This probably works but could need some thought
401 // Select returned error
402 lyxerr << "Select on ispell returned error, what now?" << endl;
409 "The ispell-process has died for some reason. *One* possible reason\n"
410 "could be that you do not have a dictionary file\n"
411 "for the language of this document installed.\n"
412 "Check /usr/lib/ispell or set another\n"
413 "dictionary in the Spellchecker Options menu.";
422 return isp_pid != -1;
426 void ISpell::cleanUp()
432 enum ISpell::spellStatus ISpell::check(string const & word)
434 //Please rewrite to use string.
436 ::fputs(word.c_str(), out);
440 ::fgets(buf, 1024, in);
442 /* I think we have to check if ispell is still alive here because
443 the signal-handler could have disabled blocking on the fd */
444 if (!alive()) return ISP_UNKNOWN;
447 case '*': // Word found
450 case '+': // Word found through affix removal
453 case '-': // Word found through compound formation
454 flag = ISP_COMPOUNDWORD;
456 case '\n': // Number or when in terse mode: no problems
459 case '#': // Not found, no near misses and guesses
462 case '?': // Not found, and no near misses, but guesses (guesses are ignored)
463 case '&': // Not found, but we have near misses
466 char * p = strpbrk(buf, ":");
467 str = new char[strlen(p) + 1];
472 default: // This shouldn't happend, but you know Murphy
477 if (flag!= ISP_IGNORE) {
478 while (*buf!= '\n') fgets(buf, 255, in); /* wait for ispell to finish */
486 // Note: If you decide to optimize this out when it is not
487 // needed please note that when Aspell is used this command
488 // is also needed to save the replacement dictionary.
489 // -- Kevin Atkinson (kevinatk@home.com)
491 fputs("#\n", out); // Save personal dictionary
498 void ISpell::insert(string const & word)
500 ::fputc('*', out); // Insert word in personal dictionary
501 ::fputs(word.c_str(), out);
506 void ISpell::accept(string const & word)
508 ::fputc('@', out); // Accept in this session
509 ::fputs(word.c_str(), out);
514 void ISpell::store(string const & mis, string const & cor)
516 if (actual_spell_checker == ASC_ASPELL) {
517 ::fputs("$$ra ", out);
518 ::fputs(mis.c_str(), out);
520 ::fputs(cor.c_str(), out);
526 void ISpell::sigchldhandler(pid_t pid, int * status)
529 if (pid == isp_pid) {
531 fcntl(isp_fd, F_SETFL, O_NONBLOCK); /* set the file descriptor
532 to nonblocking so we can
536 sigchldchecker(pid, status);
539 char const * ISpell::error()