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"
80 spell_error_object = 0;
84 PSpell::PSpell(BufferParams const & params, string const & lang)
88 spell_error_object = 0;
90 initialize(params, lang);
98 delete_pspell_string_emulation(els);
102 void PSpell::initialize(BufferParams const &, string const & lang)
104 PspellConfig * config = new_pspell_config();
106 split(lang, code, '_');
107 config->replace("language-tag", code.c_str());
108 spell_error_object = new_pspell_manager(config);
109 if (pspell_error_number(spell_error_object) != 0) {
110 error_ = pspell_error_message(spell_error_object);
113 sc = to_pspell_manager(spell_error_object);
114 spell_error_object = 0;
119 void PSpell::cleanUp()
121 if (spell_error_object) {
122 delete_pspell_can_have_error(spell_error_object);
123 spell_error_object = 0;
128 enum PSpell::spellStatus PSpell::check(string const & word)
133 int word_ok = pspell_manager_check(sc, word.c_str());
134 lyx::Assert(word_ok != -1);
139 PspellWordList const * sugs =
140 pspell_manager_suggest(sc, word.c_str());
141 lyx::Assert(sugs != 0);
142 els = pspell_word_list_elements(sugs);
143 if (pspell_word_list_empty(sugs))
155 pspell_manager_save_all_word_lists(sc);
159 void PSpell::insert(string const & word)
162 pspell_manager_add_to_personal(sc, word.c_str());
166 void PSpell::accept(string const & word)
169 pspell_manager_add_to_session(sc, word.c_str());
173 void PSpell::store(string const & mis, string const & cor)
176 pspell_manager_store_replacement(sc, mis.c_str(), cor.c_str());
180 char const * PSpell::nextMiss()
183 return pspell_string_emulation_next(els);
187 char const * PSpell::error()
192 void PSpell::sigchldhandler(pid_t pid, int * status)
194 sigchldchecker(pid, status);
200 // ------------------- start special ispell code/class --------------------
210 ISpell::ISpell(BufferParams const & params, string const & lang)
214 initialize(params, lang);
224 char const * ISpell::nextMiss()
226 if (str == 0 || *(e+1) == '\0') return 0;
228 e = strpbrk(b, ",\n");
234 void ISpell::initialize(BufferParams const & params, string const & lang)
236 static char o_buf[BUFSIZ]; // jc: it could be smaller
237 int pipein[2], pipeout[2];
243 if (pipe(pipein) == -1 || pipe(pipeout) == -1) {
244 lyxerr << "LyX: Can't create pipe for spellchecker!" << endl;
248 if ((out = fdopen(pipein[1], "w")) == 0) {
249 lyxerr << "LyX: Can't create stream for pipe for spellchecker!"
254 if ((in = fdopen(pipeout[0], "r")) == 0) {
255 lyxerr <<"LyX: Can't create stream for pipe for spellchecker!"
260 setvbuf(out, o_buf, _IOLBF, BUFSIZ);
267 lyxerr << "LyX: Can't create child process for spellchecker!"
274 dup2(pipein[0], STDIN_FILENO);
275 dup2(pipeout[1], STDOUT_FILENO);
282 char * tmp = new char[lyxrc.isp_command.length() + 1];
283 lyxrc.isp_command.copy(tmp, lyxrc.isp_command.length());
284 tmp[lyxrc.isp_command.length()] = '\0';
287 string("-a").copy(tmp, 2); tmp[2] = '\0'; // pipe mode
290 if (lang != "default") {
292 string("-d").copy(tmp, 2); tmp[2] = '\0'; // Dictionary file
294 tmp = new char[lang.length() + 1];
295 lang.copy(tmp, lang.length()); tmp[lang.length()] = '\0';
299 if (lyxrc.isp_accept_compound) {
300 // Consider run-together words as legal compounds
302 string("-C").copy(tmp, 2); tmp[2] = '\0';
305 // Report run-together words with
306 // missing blanks as errors
308 string("-B").copy(tmp, 2); tmp[2] = '\0';
311 if (lyxrc.isp_use_esc_chars) {
312 // Specify additional characters that
313 // can be part of a word
315 string("-w").copy(tmp, 2); tmp[2] = '\0';
317 // Put the escape chars in ""s
318 string tms = "\"" + lyxrc.isp_esc_chars + "\"";
319 tmp = new char[tms.length() + 1];
320 tms.copy(tmp, tms.length()); tmp[tms.length()] = '\0';
323 if (lyxrc.isp_use_pers_dict) {
324 // Specify an alternate personal dictionary
326 string("-p").copy(tmp, 2);
329 tmp = new char[lyxrc.isp_pers_dict.length() + 1];
330 lyxrc.isp_pers_dict.copy(tmp, lyxrc.isp_pers_dict.length());
331 tmp[lyxrc.isp_pers_dict.length()] = '\0';
334 if (lyxrc.isp_use_input_encoding &&
335 params.inputenc != "default") {
336 string enc = (params.inputenc == "auto")
337 ? params.language->encoding()->LatexName()
339 string::size_type n = enc.length();
341 string("-T").copy(tmp, 2); tmp[2] = '\0';
342 argv[argc++] = tmp; // Input encoding
343 tmp = new char[n + 1];
351 execvp(argv[0], const_cast<char * const *>(argv));
353 // free the memory used by string::copy in the
355 for (int i= 0; i < argc -1; ++i)
358 lyxerr << "LyX: Failed to start ispell!" << endl;
362 /* Parent process: Read ispells identification message */
363 // Hmm...what are we using this id msg for? Nothing? (Lgb)
364 // Actually I used it to tell if it's truly Ispell or if it's
365 // aspell -- (kevinatk@home.com)
371 FD_SET(pipeout[0], &infds);
372 tv.tv_sec = 15; // fifteen second timeout. Probably too much,
373 // but it can't really hurt.
376 // Configure provides us with macros which are supposed to do
377 // the right typecast.
378 retval = select(SELECT_TYPE_ARG1 (pipeout[0]+1),
379 SELECT_TYPE_ARG234 (&infds),
382 SELECT_TYPE_ARG5 (&tv));
385 // Ok, do the reading. We don't have to FD_ISSET since
386 // there is only one fd in infds.
387 fgets(buf, 2048, in);
389 // determine if the spell checker is really Aspell
390 if (strstr(buf, "Aspell"))
391 actual_spell_checker = ASC_ASPELL;
393 actual_spell_checker = ASC_ISPELL;
395 fputs("!\n", out); // Set terse mode (silently accept correct words)
398 } else if (retval == 0) {
399 // timeout. Give nice message to user.
400 lyxerr << "Ispell read timed out, what now?" << endl;
401 // This probably works but could need some thought
409 // Select returned error
410 lyxerr << "Select on ispell returned error, what now?" << endl;
417 "The ispell-process has died for some reason. *One* possible reason\n"
418 "could be that you do not have a dictionary file\n"
419 "for the language of this document installed.\n"
420 "Check /usr/lib/ispell or set another\n"
421 "dictionary in the Spellchecker Options menu.";
430 return isp_pid != -1;
434 void ISpell::cleanUp()
440 enum ISpell::spellStatus ISpell::check(string const & word)
442 //Please rewrite to use string.
444 ::fputs(word.c_str(), out);
448 ::fgets(buf, 1024, in);
450 /* I think we have to check if ispell is still alive here because
451 the signal-handler could have disabled blocking on the fd */
452 if (!alive()) return ISP_UNKNOWN;
455 case '*': // Word found
458 case '+': // Word found through affix removal
461 case '-': // Word found through compound formation
462 flag = ISP_COMPOUNDWORD;
464 case '\n': // Number or when in terse mode: no problems
467 case '#': // Not found, no near misses and guesses
470 case '?': // Not found, and no near misses, but guesses (guesses are ignored)
471 case '&': // Not found, but we have near misses
474 char * p = strpbrk(buf, ":");
475 str = new char[strlen(p) + 1];
480 default: // This shouldn't happend, but you know Murphy
485 if (flag!= ISP_IGNORE) {
486 while (*buf!= '\n') fgets(buf, 255, in); /* wait for ispell to finish */
494 // Note: If you decide to optimize this out when it is not
495 // needed please note that when Aspell is used this command
496 // is also needed to save the replacement dictionary.
497 // -- Kevin Atkinson (kevinatk@home.com)
499 fputs("#\n", out); // Save personal dictionary
506 void ISpell::insert(string const & word)
508 ::fputc('*', out); // Insert word in personal dictionary
509 ::fputs(word.c_str(), out);
514 void ISpell::accept(string const & word)
516 ::fputc('@', out); // Accept in this session
517 ::fputs(word.c_str(), out);
522 void ISpell::store(string const & mis, string const & cor)
524 if (actual_spell_checker == ASC_ASPELL) {
525 ::fputs("$$ra ", out);
526 ::fputs(mis.c_str(), out);
528 ::fputs(cor.c_str(), out);
534 void ISpell::sigchldhandler(pid_t pid, int * status)
537 if (pid == isp_pid) {
539 fcntl(isp_fd, F_SETFL, O_NONBLOCK); /* set the file descriptor
540 to nonblocking so we can
544 sigchldchecker(pid, status);
547 char const * ISpell::error()