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),
83 PSpell::PSpell(BufferParams const & params, string const & lang)
84 : sc(0), els(0), spell_error_object(0), flag(ISP_UNKNOWN),
87 initialize(params, lang);
96 delete_pspell_string_emulation(els);
100 void PSpell::initialize(BufferParams const &, string const & lang)
102 PspellConfig * config = new_pspell_config();
103 config->replace("language-tag", lang.c_str());
104 spell_error_object = new_pspell_manager(config);
105 if (pspell_error_number(spell_error_object) != 0) {
106 error_ = pspell_error_message(spell_error_object);
109 sc = to_pspell_manager(spell_error_object);
110 spell_error_object = 0;
116 void PSpell::cleanUp()
118 if (spell_error_object) {
119 delete_pspell_can_have_error(spell_error_object);
120 spell_error_object = 0;
125 enum PSpell::spellStatus PSpell::check(string const & word)
130 int word_ok = pspell_manager_check(sc, word.c_str());
131 lyx::Assert(word_ok != -1);
136 PspellWordList const * sugs =
137 pspell_manager_suggest(sc, word.c_str());
138 lyx::Assert(sugs != 0);
139 els = pspell_word_list_elements(sugs);
140 if (pspell_word_list_empty(sugs))
152 pspell_manager_save_all_word_lists(sc);
156 void PSpell::insert(string const & word)
159 pspell_manager_add_to_personal(sc, word.c_str());
163 void PSpell::accept(string const & word)
166 pspell_manager_add_to_session(sc, word.c_str());
170 void PSpell::store(string const & mis, string const & cor)
173 pspell_manager_store_replacement(sc, mis.c_str(), cor.c_str());
177 char const * PSpell::nextMiss()
180 return pspell_string_emulation_next(els);
185 char const * PSpell::error()
191 void PSpell::sigchldhandler(pid_t pid, int * status)
193 sigchldchecker(pid, status);
199 // ------------------- start special ispell code/class --------------------
203 : str(0), flag(ISP_UNKNOWN)
207 ISpell::ISpell(BufferParams const & params, string const & lang)
208 : str(0), flag(ISP_UNKNOWN)
210 initialize(params, lang);
220 char const * ISpell::nextMiss()
222 if (str == 0 || *(e+1) == '\0') return 0;
224 e = strpbrk(b, ",\n");
230 void ISpell::initialize(BufferParams const & params, string const & lang)
232 static char o_buf[BUFSIZ]; // jc: it could be smaller
240 if (pipe(pipein) == -1 || pipe(pipeout) == -1) {
241 lyxerr << "LyX: Can't create pipe for spellchecker!" << endl;
245 if ((out = fdopen(pipein[1], "w")) == 0) {
246 lyxerr << "LyX: Can't create stream for pipe for spellchecker!"
251 if ((in = fdopen(pipeout[0], "r")) == 0) {
252 lyxerr <<"LyX: Can't create stream for pipe for spellchecker!"
257 setvbuf(out, o_buf, _IOLBF, BUFSIZ);
264 lyxerr << "LyX: Can't create child process for spellchecker!"
271 dup2(pipein[0], STDIN_FILENO);
272 dup2(pipeout[1], STDOUT_FILENO);
279 char * tmp = new char[lyxrc.isp_command.length() + 1];
280 lyxrc.isp_command.copy(tmp, lyxrc.isp_command.length());
281 tmp[lyxrc.isp_command.length()] = '\0';
284 string("-a").copy(tmp, 2); tmp[2] = '\0'; // pipe mode
287 if (lang != "default") {
289 string("-d").copy(tmp, 2); tmp[2] = '\0'; // Dictionary file
291 tmp = new char[lang.length() + 1];
292 lang.copy(tmp, lang.length()); tmp[lang.length()] = '\0';
296 if (lyxrc.isp_accept_compound) {
297 // Consider run-together words as legal compounds
299 string("-C").copy(tmp, 2); tmp[2] = '\0';
302 // Report run-together words with
303 // missing blanks as errors
305 string("-B").copy(tmp, 2); tmp[2] = '\0';
308 if (lyxrc.isp_use_esc_chars) {
309 // Specify additional characters that
310 // can be part of a word
312 string("-w").copy(tmp, 2); tmp[2] = '\0';
314 // Put the escape chars in ""s
315 string tms = "\"" + lyxrc.isp_esc_chars + "\"";
316 tmp = new char[tms.length() + 1];
317 tms.copy(tmp, tms.length()); tmp[tms.length()] = '\0';
320 if (lyxrc.isp_use_pers_dict) {
321 // Specify an alternate personal dictionary
323 string("-p").copy(tmp, 2);
326 tmp = new char[lyxrc.isp_pers_dict.length() + 1];
327 lyxrc.isp_pers_dict.copy(tmp, lyxrc.isp_pers_dict.length());
328 tmp[lyxrc.isp_pers_dict.length()] = '\0';
331 if (lyxrc.isp_use_input_encoding &&
332 params.inputenc != "default") {
333 string enc = (params.inputenc == "auto")
334 ? params.language->encoding()->LatexName()
336 string::size_type n = enc.length();
338 string("-T").copy(tmp, 2);
340 argv[argc++] = tmp; // Input encoding
341 tmp = new char[n + 1];
349 execvp(argv[0], const_cast<char * const *>(argv));
351 // free the memory used by string::copy in the
353 for (int i = 0; i < argc - 1; ++i)
356 lyxerr << "LyX: Failed to start ispell!" << endl;
360 /* Parent process: Read ispells identification message */
361 // Hmm...what are we using this id msg for? Nothing? (Lgb)
362 // Actually I used it to tell if it's truly Ispell or if it's
363 // aspell -- (kevinatk@home.com)
369 FD_SET(pipeout[0], &infds);
370 tv.tv_sec = 15; // fifteen second timeout. Probably too much,
371 // but it can't really hurt.
374 // Configure provides us with macros which are supposed to do
375 // the right typecast.
376 retval = select(SELECT_TYPE_ARG1 (pipeout[0]+1),
377 SELECT_TYPE_ARG234 (&infds),
380 SELECT_TYPE_ARG5 (&tv));
383 // Ok, do the reading. We don't have to FD_ISSET since
384 // there is only one fd in infds.
385 fgets(buf, 2048, in);
387 // determine if the spell checker is really Aspell
388 if (strstr(buf, "Aspell"))
389 actual_spell_checker = ASC_ASPELL;
391 actual_spell_checker = ASC_ISPELL;
393 fputs("!\n", out); // Set terse mode (silently accept correct words)
396 } else if (retval == 0) {
397 // timeout. Give nice message to user.
398 lyxerr << "Ispell read timed out, what now?" << endl;
399 // This probably works but could need some thought
407 // Select returned error
408 lyxerr << "Select on ispell returned error, what now?" << endl;
415 "The ispell-process has died for some reason. *One* possible reason\n"
416 "could be that you do not have a dictionary file\n"
417 "for the language of this document installed.\n"
418 "Check /usr/lib/ispell or set another\n"
419 "dictionary in the Spellchecker Options menu.";
428 return isp_pid != -1;
432 void ISpell::cleanUp()
438 enum ISpell::spellStatus ISpell::check(string const & word)
440 //Please rewrite to use string.
442 ::fputs(word.c_str(), out);
446 ::fgets(buf, 1024, in);
448 // I think we have to check if ispell is still alive here because
449 // the signal-handler could have disabled blocking on the fd
450 if (!alive()) return ISP_UNKNOWN;
453 case '*': // Word found
456 case '+': // Word found through affix removal
459 case '-': // Word found through compound formation
460 flag = ISP_COMPOUNDWORD;
462 case '\n': // Number or when in terse mode: no problems
465 case '#': // Not found, no near misses and guesses
468 case '?': // Not found, and no near misses, but guesses (guesses are ignored)
469 case '&': // Not found, but we have near misses
472 char * p = strpbrk(buf, ":");
473 str = new char[strlen(p) + 1];
478 default: // This shouldn't happend, but you know Murphy
483 if (flag!= ISP_IGNORE) {
484 while (*buf!= '\n') fgets(buf, 255, in); /* wait for ispell to finish */
492 // Note: If you decide to optimize this out when it is not
493 // needed please note that when Aspell is used this command
494 // is also needed to save the replacement dictionary.
495 // -- Kevin Atkinson (kevinatk@home.com)
497 fputs("#\n", out); // Save personal dictionary
504 void ISpell::insert(string const & word)
506 ::fputc('*', out); // Insert word in personal dictionary
507 ::fputs(word.c_str(), out);
512 void ISpell::accept(string const & word)
514 ::fputc('@', out); // Accept in this session
515 ::fputs(word.c_str(), out);
520 void ISpell::store(string const & mis, string const & cor)
522 if (actual_spell_checker == ASC_ASPELL) {
523 ::fputs("$$ra ", out);
524 ::fputs(mis.c_str(), out);
526 ::fputs(cor.c_str(), out);
532 void ISpell::sigchldhandler(pid_t pid, int * status)
535 if (pid == isp_pid) {
537 // set the file descriptor to nonblocking so we can
539 fcntl(isp_fd, F_SETFL, O_NONBLOCK);
542 sigchldchecker(pid, status);
546 char const * ISpell::error()