src/SpellChecker.h

   1 // -*- C++ -*-
   2 /**
   3  * \file SpellChecker.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author unknown
   8  * \author John Levon
   9  *
  10  * Full author contact details are available in file CREDITS.
  11  */
  12
  13 #ifndef SPELL_BASE_H
  14 #define SPELL_BASE_H
  15
  16 #include "support/strfwd.h"
  17
  18
  19 namespace lyx {
  20
  21 class BufferParams;
  22 class Language;
  23 class WordLangTuple;
  24 class docstring_list;
  25
  26 /**
  27  * Pure virtual base class of all spellchecker implementations.
  28  */
  29 class SpellChecker {
  30 public:
  31
  32         /// the result from checking a single word
  33         enum Result  {
  34                 /// word is correct
  35                 WORD_OK = 1,
  36                 /// root of given word was found
  37                 ROOT_FOUND,
  38                 /// word found through compound formation
  39                 COMPOUND_WORD,
  40                 /// word not found
  41                 UNKNOWN_WORD,
  42                 /// number of other ignored "word"
  43                 IGNORED_WORD,
  44                 /// number of personal dictionary "word"
  45                 LEARNED_WORD,
  46                 /// missing dictionary for language
  47                 NO_DICTIONARY
  48         };
  49
  50         virtual ~SpellChecker() {}
  51
  52         /// does the spell check failed
  53         static bool misspelled(Result res) {
  54                 return res != WORD_OK
  55                         && res != IGNORED_WORD
  56                         && res != NO_DICTIONARY
  57                         && res != LEARNED_WORD; }
  58
  59         /// check the given word of the given lang code and return the result
  60         virtual enum Result check(WordLangTuple const &) = 0;
  61
  62         /// Gives suggestions.
  63         virtual void suggest(WordLangTuple const &, docstring_list & suggestions) = 0;
  64
  65         /// Lemmatizing: return stem of word (used by Thesaurus).
  66         virtual void stem(WordLangTuple const &, docstring_list & suggestions) = 0;
  67
  68         /// insert the given word into the personal dictionary
  69         virtual void insert(WordLangTuple const &) = 0;
  70
  71         /// remove the given word from the personal dictionary
  72         virtual void remove(WordLangTuple const &) = 0;
  73
  74         /// accept the given word temporarily
  75         virtual void accept(WordLangTuple const &) = 0;
  76
  77         /// check if dictionary exists
  78         virtual bool hasDictionary(Language const *) const = 0;
  79
  80         /// how many valid dictionaries were found
  81         virtual int numDictionaries() const = 0;
  82
  83         /// if speller can spell check whole paragraph return true
  84         virtual bool canCheckParagraph() const { return false; }
  85
  86         /// count of misspelled words
  87         virtual int numMisspelledWords() const { return 0; }
  88
  89         /// start position and length of misspelled word at index
  90         virtual void misspelledWord(
  91                 int /* index */,
  92                 int & start, int & length) const
  93         {
  94                 /// index is used here to make the compiler happy
  95                 start = 0;
  96                 length = 0;
  97         }
  98
  99         /// give an error message on messy exit
 100         virtual docstring const error() = 0;
 101
 102         /// spell checker state versioning support
 103         typedef unsigned long int ChangeNumber ;
 104         ChangeNumber changeNumber() const { return change_number_; }
 105         void changeNumber(ChangeNumber value) { change_number_ = value; }
 106         void nextChangeNumber() { ++change_number_; }
 107         virtual void advanceChangeNumber() = 0;
 108
 109 private:
 110         ChangeNumber change_number_;
 111 };
 112
 113 /// Access to the singleton SpellChecker.
 114 /// Implemented in LyX.cpp
 115 SpellChecker * theSpellChecker();
 116
 117 /// Set the singleton SpellChecker engine.
 118 /// Implemented in LyX.cpp
 119 void setSpellChecker();
 120
 121 } // namespace lyx
 122
 123 #endif // SPELL_BASE_H