]> git.lyx.org Git - lyx.git/blobdiff - src/spellchecker.C
Fixes to insettabular/text.
[lyx.git] / src / spellchecker.C
index f7536cb74953051a861d64fb70f4eaacde9e8b5a..81153c61e0a01bbc0b1fef0ff59f4055e07f8c2a 100644 (file)
 
 #include <config.h>
 
+#ifdef __GNUG__
+#pragma implementation
+#endif
+
 #include <unistd.h>
 #include <fcntl.h>
 #include <cstdlib>
 #endif
 
 #ifdef HAVE_SYS_SELECT_H
+# ifdef HAVE_STRINGS_H
+   // <strings.h> is needed at least on AIX because FD_ZERO uses bzero().
+# include <strings.h> 
+# endif
 #include <sys/select.h>
 #endif
 
 #include "lyx_gui_misc.h"
 #include "debug.h"
 #include "support/lstrings.h"
+#include "language.h"
+#include "encoding.h"
+#include "support/lstrings.h"
+
+//#define USE_PSPELL 1
+
+#ifdef USE_PSPELL
+
+#include <pspell/pspell.h>
+
+#endif
 
 using std::reverse;
 using std::endl;
@@ -66,6 +85,8 @@ enum {
 
 static bool RunSpellChecker(BufferView * bv);
 
+#ifndef USE_PSPELL
+
 static FILE * in, * out;  /* streams to communicate with ispell */
 pid_t isp_pid = -1; // pid for the `ispell' process. Also used (RO) in
                     // lyx_cb.C
@@ -76,6 +97,12 @@ static ActualSpellChecker actual_spell_checker;
 
 static int isp_fd;
 
+#else
+
+PspellManager * sc;
+
+#endif
+
 static FD_form_spell_options *fd_form_spell_options = 0;
 FD_form_spell_check *fd_form_spell_check = 0;
 
@@ -85,21 +112,56 @@ void sigchldhandler(pid_t pid, int *status);
 //extern void sigchldchecker(int sig);
 extern void sigchldchecker(pid_t pid, int *status);
 
+#ifndef USE_PSPELL
+
 struct isp_result {
        int flag;
-       int count;
-       string str;
-       char ** misses;
+       char * str;
+       char * b;
+       char * e;
+       const char * next_miss();
        isp_result() {
                flag = ISP_UNKNOWN;
-               count = 0;
-               misses = static_cast<char**>(0);
+               str = 0;
        }
        ~isp_result() {
-               delete[] misses;
+               delete[] str;
        }
 };
 
+const char * isp_result::next_miss() {
+       if (str == 0 || *(e+1) == '\0') return 0;
+       b = e + 2;
+       e = strpbrk(b, ",\n");
+       *e = '\0';
+       return b;
+}
+
+#else
+
+struct isp_result {
+       int flag;
+       PspellStringEmulation * els;
+       
+       const char * next_miss();
+       isp_result() {
+               flag = ISP_UNKNOWN;
+               els = 0;
+       }
+       ~isp_result() {
+               delete_pspell_string_emulation(els);
+       }
+};
+
+const char * isp_result::next_miss() 
+{
+       return pspell_string_emulation_next(els);
+}
+
+#endif
+
+const char * spell_error;
+
 
 /***** Spellchecker options *****/
 
@@ -220,13 +282,14 @@ void SpellCheckerOptions()
        }
 }
 
+#ifndef USE_PSPELL
 
 /***** Spellchecker *****/
 
 // Could also use a clean up. (Asger Alstrup)
 
 static
-void create_ispell_pipe(BufferParams const & params, string const & lang)
+void init_spell_checker(BufferParams const & params, string const & lang)
 {
        static char o_buf[BUFSIZ];  // jc: it could be smaller
        int pipein[2], pipeout[2];
@@ -237,19 +300,19 @@ void create_ispell_pipe(BufferParams const & params, string const & lang)
 
        if(pipe(pipein) == -1 || pipe(pipeout) == -1) {
                lyxerr << "LyX: Can't create pipe for spellchecker!" << endl;
-               return;
+               goto END;
        }
 
        if ((out = fdopen(pipein[1], "w")) == 0) {
                lyxerr << "LyX: Can't create stream for pipe for spellchecker!"
                       << endl;
-               return;
+               goto END;
        }
 
        if ((in = fdopen(pipeout[0], "r")) == 0) {
                lyxerr <<"LyX: Can't create stream for pipe for spellchecker!"
                       << endl;
-               return;
+               goto END;
        }
 
        setvbuf(out, o_buf, _IOLBF, BUFSIZ);
@@ -261,9 +324,9 @@ void create_ispell_pipe(BufferParams const & params, string const & lang)
        if(isp_pid == -1) {
                lyxerr << "LyX: Can't create child process for spellchecker!"
                       << endl;
-               return;
+               goto END;
        }
-
+       
        if(isp_pid == 0) {        
                /* child process */
                dup2(pipein[0], STDIN_FILENO);
@@ -327,13 +390,17 @@ void create_ispell_pipe(BufferParams const & params, string const & lang)
                        argv[argc++] = tmp;
                }
                if (lyxrc.isp_use_input_encoding &&
-                   params.inputenc != "default") {
+                   params.inputenc != "default") {
+                       string enc = (params.inputenc == "auto")
+                               ? params.language_info->encoding()->LatexName()
+                               : params.inputenc;
+                       string::size_type n = enc.length();
                        tmp = new char[3];
                        string("-T").copy(tmp, 2); tmp[2] = '\0';
                        argv[argc++] = tmp; // Input encoding
-                       tmp = new char[params.inputenc.length() + 1];
-                       params.inputenc.copy(tmp, params.inputenc.length());
-                       tmp[params.inputenc.length()] = '\0';
+                       tmp = new char[n + 1];
+                       enc.copy(tmp, n);
+                       tmp[n] = '\0';
                        argv[argc++] = tmp;
                }
 
@@ -349,7 +416,7 @@ void create_ispell_pipe(BufferParams const & params, string const & lang)
                lyxerr << "LyX: Failed to start ispell!" << endl;
                _exit(0);
        }
-
+       {
        /* Parent process: Read ispells identification message */
        // Hmm...what are we using this id msg for? Nothing? (Lgb)
        // Actually I used it to tell if it's truly Ispell or if it's
@@ -382,6 +449,9 @@ void create_ispell_pipe(BufferParams const & params, string const & lang)
                  actual_spell_checker = ASC_ASPELL;
                else
                  actual_spell_checker = ASC_ISPELL;
+
+               fputs("!\n", out); // Set terse mode (silently accept correct words)
+
                
        } else if (retval == 0) {
                // timeout. Give nice message to user.
@@ -395,28 +465,49 @@ void create_ispell_pipe(BufferParams const & params, string const & lang)
                // Select returned error
                lyxerr << "Select on ispell returned error, what now?" << endl;
        }
+       }
+ END:
+       if (isp_pid == -1) {
+               spell_error = 
+                       "\n\n"
+                       "The ispell-process has died for some reason. *One* possible reason\n"
+                       "could be that you do not have a dictionary file\n"
+                       "for the language of this document installed.\n"
+                       "Check /usr/lib/ispell or set another\n"
+                       "dictionary in the Spellchecker Options menu.";
+       } else {
+               spell_error = 0;
+       }
+}
+
+static
+bool sc_still_alive() {
+       return isp_pid != -1;
 }
 
+static
+void sc_clean_up_after_error() 
+{
+       ::fclose(out);
+}
 
 // Send word to ispell and get reply
 static
-isp_result *ispell_check_word(char *word)
+isp_result * sc_check_word(string const & word)
 {
        //Please rewrite to use string.
-       isp_result *result;
-       char buf[1024], *p;
-       int count, i;
 
-       fputs(word, out); 
-       fputc('\n', out);
+       ::fputs(word.c_str(), out);
+       ::fputc('\n', out);
   
-       fgets(buf, 1024, in); 
+       char buf[1024];
+       ::fgets(buf, 1024, in); 
   
        /* I think we have to check if ispell is still alive here because
           the signal-handler could have disabled blocking on the fd */
-       if (isp_pid == -1) return 0;
+       if (!sc_still_alive()) return 0;
 
-       result = new isp_result;
+       isp_result * result = new isp_result;
   
        switch (*buf) {
        case '*': // Word found
@@ -438,25 +529,10 @@ isp_result *ispell_check_word(char *word)
        case '&': // Not found, but we have near misses
        {
                result->flag = ISP_MISSED;
-               result->str = buf;
-               // nb is leaked! where should it be freed? I have to
-               // admit I do not understand the intent of the code :(
-               // (JMarc) 
-               char * nb = new char[result->str.length() + 1];
-               result->str.copy(nb, result->str.length());
-               nb[result->str.length()]= '\0';
-               p = strpbrk(nb+2, " ");
-               sscanf(p, "%d", &count); // Get near misses count
-               result->count = count;
-               if (count) result->misses = new char*[count];
-               p = strpbrk(nb, ":");
-               p += 2;
-               for (i = 0; i < count; ++i) {
-                       result->misses[i] = p;
-                       p = strpbrk(p, ",\n");
-                       *p = 0;
-                       p += 2;
-               }
+               char * p = strpbrk(buf, ":");
+               result->str = new char[strlen(p) + 1];
+               result->e   = result->str;
+               strcpy(result->str, p);
                break;
        }
        default: // This shouldn't happend, but you know Murphy
@@ -471,8 +547,8 @@ isp_result *ispell_check_word(char *word)
 }
 
 
-static inline
-void ispell_terminate()
+static inline 
+void close_spell_checker()
 {
         // Note: If you decide to optimize this out when it is not 
         // needed please note that when Aspell is used this command 
@@ -486,42 +562,122 @@ void ispell_terminate()
 }
 
 
-static inline
-void ispell_terse_mode()
+static inline 
+void sc_insert_word(string const & word)
 {
-       fputs("!\n", out); // Set terse mode (silently accept correct words)
+       ::fputc('*', out); // Insert word in personal dictionary
+       ::fputs(word.c_str(), out);
+       ::fputc('\n', out);
 }
 
 
+static inline 
+void sc_accept_word(string const & word) 
+{
+       ::fputc('@', out); // Accept in this session
+       ::fputs(word.c_str(), out);
+       ::fputc('\n', out);
+}
+
 static inline
-void ispell_insert_word(char const *word)
+void sc_store_replacement(string const & mis, string const & cor) {
+        if(actual_spell_checker == ASC_ASPELL) {
+                ::fputs("$$ra ", out);
+                ::fputs(mis.c_str(), out);
+                ::fputc(',', out);
+                ::fputs(cor.c_str(), out);
+                ::fputc('\n', out);
+        }
+}
+
+#else
+
+PspellCanHaveError * spell_error_object;
+
+static
+void init_spell_checker(BufferParams const &, string const & lang)
 {
-       fputc('*', out); // Insert word in personal dictionary
-       fputs(word, out);
-       fputc('\n', out);
+       PspellConfig * config = new_pspell_config();
+       string code;
+       split(lang, code, '_');
+       config->replace("language-tag", code.c_str());
+       spell_error_object = new_pspell_manager(config);
+       if (pspell_error_number(spell_error_object) != 0) {
+               spell_error = pspell_error_message(spell_error_object);
+       } else {
+               spell_error = 0;
+               sc = to_pspell_manager(spell_error_object);
+               spell_error_object = 0;
+       }
 }
 
+static 
+bool sc_still_alive() {
+       return true;
+}
 
-static inline
-void ispell_accept_word(char const *word
+static
+void sc_clean_up_after_error(
 {
-       fputc('@', out); // Accept in this session
-       fputs(word, out);
-       fputc('\n', out);
+       delete_pspell_can_have_error(spell_error_object);
 }
 
-static inline
-void ispell_store_replacement(char const *mis, string const & cor) {
-        if(actual_spell_checker == ASC_ASPELL) {
-                fputs("$$ra ", out);
-                fputs(mis, out);
-                fputc(',', out);
-                fputs(cor.c_str(), out);
-                fputc('\n', out);
-        }
+
+
+// Send word to ispell and get reply
+static
+isp_result * sc_check_word(string const & word)
+{
+       isp_result * result = new isp_result;
+#warning Why isnt word_ok a bool? (Lgb)
+       int word_ok = pspell_manager_check(sc, word.c_str());
+       Assert(word_ok != -1);
+
+       if (word_ok) {
+               result->flag = ISP_OK;
+       } else {
+               PspellWordList const * sugs =
+                       pspell_manager_suggest(sc, word.c_str());
+               Assert(sugs != 0);
+               result->els = pspell_word_list_elements(sugs);
+               if (pspell_word_list_empty(sugs)) 
+                       result->flag = ISP_UNKNOWN;
+               else 
+                       result->flag = ISP_MISSED;
+       }
+       return result;
+}
+
+
+static inline 
+void close_spell_checker()
+{
+       pspell_manager_save_all_word_lists(sc);
+}
+
+
+static inline 
+void sc_insert_word(string const & word)
+{
+       pspell_manager_add_to_personal(sc, word.c_str());
+}
+
+
+static inline 
+void sc_accept_word(string const & word) 
+{
+       pspell_manager_add_to_session(sc, word.c_str());
 }
 
 
+static inline 
+void sc_store_replacement(string const & mis, string const & cor)
+{
+       pspell_manager_store_replacement(sc, mis.c_str(), cor.c_str());
+}
+
+#endif
+
 void ShowSpellChecker(BufferView * bv)
 {
        FL_OBJECT * obj;
@@ -534,7 +690,8 @@ void ShowSpellChecker(BufferView * bv)
        if (fd_form_spell_check == 0) {
                fd_form_spell_check = create_form_form_spell_check();
                // Make sure pressing the close box does not kill LyX. (RvdK)
-               fl_set_form_atclose(fd_form_spell_check->form_spell_check, IgnoreCloseBoxCB, 0);
+               fl_set_form_atclose(fd_form_spell_check->form_spell_check, 
+                                   CancelCloseBoxCB, 0);
        }
 
        // Clear form
@@ -570,12 +727,12 @@ void ShowSpellChecker(BufferView * bv)
        fl_set_object_lcol(fd_form_spell_check->input, FL_INACTIVE);
        fl_set_object_lcol(fd_form_spell_check->browser, FL_INACTIVE);
 
-       while (true){
+       while (true) {
                obj = fl_do_forms();
-               if (obj == fd_form_spell_check->options){
+               if (obj == fd_form_spell_check->options) {
                        SpellCheckerOptions();
                }
-               if (obj == fd_form_spell_check->start){
+               if (obj == fd_form_spell_check->start) {
                        // activate insert, accept, and stop
                        fl_activate_object(fd_form_spell_check->insert);
                        fl_activate_object(fd_form_spell_check->accept);
@@ -636,42 +793,48 @@ void ShowSpellChecker(BufferView * bv)
 }
 
 
-// Perform an ispell session
+// Perform a spell session
 static
 bool RunSpellChecker(BufferView * bv)
 {
        isp_result * result;
-       int i, newvalue;
+       int newvalue;
        FL_OBJECT * obj;
 
-       string tmp = (lyxrc.isp_use_alt_lang) ? lyxrc.isp_alt_lang : bv->buffer()->GetLanguage();
-       bool rtl = tmp == "hebrew" || tmp == "arabic";
+#ifdef USE_PSPELL
+       string tmp = (lyxrc.isp_use_alt_lang) ?
+           lyxrc.isp_alt_lang : bv->buffer()->params.language_info->code();
+#else
+       string tmp = (lyxrc.isp_use_alt_lang) ?
+           lyxrc.isp_alt_lang : bv->buffer()->GetLanguage();
+#endif
+#warning This is not good we should find a way to identify a rtl-language in a more general way. Please have a look Dekel! (Jug)
+// For now I'll change this to a bit more general solution but
+// Please comment on this if you don't like it. We probaly need
+// anoter flag something like lyxrc.isp_use_alt_lang_rtl (true/false)!
+       bool rtl;
+       if (lyxrc.isp_use_alt_lang)
+           rtl = (tmp == "hebrew" || tmp == "arabic");
+       else
+           rtl = bv->buffer()->params.language_info->RightToLeft();
 
        int oldval = 0;  /* used for updating slider only when needed */
        float newval = 0.0;
    
        /* create ispell process */
-       create_ispell_pipe(bv->buffer()->params, tmp);
+       init_spell_checker(bv->buffer()->params, tmp);
 
-       if (isp_pid == -1) {
-               fl_show_message(
-                       _("\n\n"
-                         "The ispell-process has died for some reason. *One* possible reason\n"
-                         "could be that you do not have a dictionary file\n"
-                         "for the language of this document installed.\n"
-                         "Check /usr/lib/ispell or set another\n"
-                         "dictionary in the Spellchecker Options menu."), "", "");
-               fclose(out);
-               return true;
+       if (spell_error != 0) {
+               fl_show_message(_(spell_error), "", "");
+               sc_clean_up_after_error();
+               return false;
        }
 
-       // Put ispell in terse mode to improve speed
-       ispell_terse_mode();
-
        unsigned int word_count = 0;
+
        while (true) {
-               char * word = bv->nextWord(newval);
-               if (word == 0) break;
+               string const word = bv->nextWord(newval);
+               if (word.empty()) break;
                ++word_count;
                
                // Update slider if and only if value has changed
@@ -679,26 +842,23 @@ bool RunSpellChecker(BufferView * bv)
                if(newvalue!= oldval) {
                        oldval = newvalue;
                        fl_set_slider_value(fd_form_spell_check->slider, oldval);
-               }
+               }
 
                if (word_count%1000 == 0) {
                        obj =  fl_check_forms();
                        if (obj == fd_form_spell_check->stop) {
-                               delete[] word;
-                               ispell_terminate();
+                               close_spell_checker();
                                return true;
                        }
                        if (obj == fd_form_spell_check->done) {
-                               delete[] word;
-                               ispell_terminate(); 
+                               close_spell_checker();
                                return false;
                        }
                }
 
-               result = ispell_check_word(word);
-               if (isp_pid == -1) {
+               result = sc_check_word(word);
+               if (!sc_still_alive()) {
                        delete result;
-                       delete[] word;
                        break;
                }
 
@@ -712,27 +872,28 @@ bool RunSpellChecker(BufferView * bv)
                                reverse(tmp.begin(),tmp.end());
                                fl_set_object_label(fd_form_spell_check->text, tmp.c_str());
                        } else
-                               fl_set_object_label(fd_form_spell_check->text, word);
-                       fl_set_input(fd_form_spell_check->input, word);
+                               fl_set_object_label(fd_form_spell_check->text, word.c_str());
+                       fl_set_input(fd_form_spell_check->input, word.c_str());
                        fl_clear_browser(fd_form_spell_check->browser);
-                       for (i = 0; i < result->count; ++i) {
+                       const char * w;
+                       while ((w = result->next_miss()) != 0) {
                                if (rtl) {
-                                       string tmp = result->misses[i];
+                                       string tmp = w;
                                        reverse(tmp.begin(),tmp.end());
                                        fl_add_browser_line(fd_form_spell_check->browser, tmp.c_str());
                                } else
-                                       fl_add_browser_line(fd_form_spell_check->browser, result->misses[i]);
+                                       fl_add_browser_line(fd_form_spell_check->browser, w);
                        }
 
                        int clickline = -1;
                        while (true) {
                                obj = fl_do_forms();
                                if (obj == fd_form_spell_check->insert) {
-                                       ispell_insert_word(word);
+                                       sc_insert_word(word);
                                        break;
                                }
                                if (obj == fd_form_spell_check->accept) {
-                                       ispell_accept_word(word);
+                                       sc_accept_word(word);
                                        break;
                                }
                                if (obj == fd_form_spell_check->ignore) {
@@ -740,7 +901,7 @@ bool RunSpellChecker(BufferView * bv)
                                }
                                if (obj == fd_form_spell_check->replace || 
                                    obj == fd_form_spell_check->input) {
-                                       ispell_store_replacement(word, fl_get_input(fd_form_spell_check->input));
+                                       sc_store_replacement(word, fl_get_input(fd_form_spell_check->input));
                                        bv->replaceWord(fl_get_input(fd_form_spell_check->input));
                                        break;
                                }
@@ -749,7 +910,7 @@ bool RunSpellChecker(BufferView * bv)
                                        // sent to lyx@via by Mark Burton <mark@cbl.leeds.ac.uk>
                                        if (clickline == 
                                            fl_get_browser(fd_form_spell_check->browser)) {
-                                               ispell_store_replacement(word, fl_get_input(fd_form_spell_check->input));
+                                               sc_store_replacement(word, fl_get_input(fd_form_spell_check->input));
                                                bv->replaceWord(fl_get_input(fd_form_spell_check->input));
                                                break;
                                        }
@@ -768,27 +929,24 @@ bool RunSpellChecker(BufferView * bv)
                                }
                                if (obj == fd_form_spell_check->stop) {
                                        delete result;
-                                       delete[] word;
-                                       ispell_terminate();
+                                       close_spell_checker();
                                        return true;
                                }
            
                                if (obj == fd_form_spell_check->done) {
                                        delete result;
-                                       delete[] word;
-                                       ispell_terminate();
+                                       close_spell_checker();
                                        return false;
                                }
                        }
                }
                default:
                        delete result;
-                       delete[] word;
                }
        }
    
-       if(isp_pid!= -1) {
-               ispell_terminate();
+       if(sc_still_alive()) {
+               close_spell_checker();
                string word_msg(tostr(word_count));
                if (word_count != 1) {
                        word_msg += _(" words checked.");
@@ -799,14 +957,16 @@ bool RunSpellChecker(BufferView * bv)
                                word_msg.c_str());
                return false;
        } else {
-               fl_show_message(_("The ispell-process has died for some reason.\n"
+               fl_show_message(_("The spell checker has died for some reason.\n"
                                "Maybe it has been killed."), "", "");
-               fclose(out);
+               sc_clean_up_after_error();
                return true;
        }
 }
 
 
+#ifndef USE_PSPELL
+
 void sigchldhandler(pid_t pid, int * status)
 { 
        if (isp_pid > 0)
@@ -818,3 +978,12 @@ void sigchldhandler(pid_t pid, int * status)
                }
        sigchldchecker(pid, status);
 }
+
+#else
+
+void sigchldhandler(pid_t, int *)
+{ 
+       // do nothing
+}
+
+#endif