extensions/spellcheck/src/mozSpellChecker.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is Mozilla Spellchecker Component.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * David Einstein.
  19  * Portions created by the Initial Developer are Copyright (C) 2001
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s): David Einstein Deinst@world.std.com
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either the GNU General Public License Version 2 or later (the "GPL"), or
  26  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 #ifndef mozSpellChecker_h__
  39 #define mozSpellChecker_h__
  40
  41 #include "nsCOMPtr.h"
  42 #include "nsISpellChecker.h"
  43 #include "nsString.h"
  44 #include "nsITextServicesDocument.h"
  45 #include "mozIPersonalDictionary.h"
  46 #include "mozISpellCheckingEngine.h"
  47 #include "nsClassHashtable.h"
  48 #include "nsVoidArray.h"
  49 #include "mozISpellI18NUtil.h"
  50
  51 class mozSpellChecker : public nsISpellChecker
  52 {
  53 public:
  54   NS_DECL_ISUPPORTS
  55
  56   mozSpellChecker();
  57   virtual ~mozSpellChecker();
  58
  59   nsresult Init();
  60
  61   // nsISpellChecker
  62   NS_IMETHOD SetDocument(nsITextServicesDocument *aDoc, PRBool aFromStartofDoc);
  63   NS_IMETHOD NextMisspelledWord(nsAString &aWord, nsStringArray *aSuggestions);
  64   NS_IMETHOD CheckWord(const nsAString &aWord, PRBool *aIsMisspelled, nsStringArray *aSuggestions);
  65   NS_IMETHOD Replace(const nsAString &aOldWord, const nsAString &aNewWord, PRBool aAllOccurrences);
  66   NS_IMETHOD IgnoreAll(const nsAString &aWord);
  67
  68   NS_IMETHOD AddWordToPersonalDictionary(const nsAString &aWord);
  69   NS_IMETHOD RemoveWordFromPersonalDictionary(const nsAString &aWord);
  70   NS_IMETHOD GetPersonalDictionary(nsStringArray *aWordList);
  71
  72   NS_IMETHOD GetDictionaryList(nsStringArray *aDictionaryList);
  73   NS_IMETHOD GetCurrentDictionary(nsAString &aDictionary);
  74   NS_IMETHOD SetCurrentDictionary(const nsAString &aDictionary);
  75
  76 protected:
  77   nsCOMPtr<mozISpellI18NUtil> mConverter;
  78   nsCOMPtr<nsITextServicesDocument> mTsDoc;
  79   nsCOMPtr<mozIPersonalDictionary> mPersonalDictionary;
  80
  81   // Hastable maps directory name to the spellchecker contract ID
  82   nsClassHashtable<nsStringHashKey, nsCString> mDictionariesMap;
  83
  84   nsString mDictionaryName;
  85   nsCString *mCurrentEngineContractId;
  86   nsCOMPtr<mozISpellCheckingEngine>  mSpellCheckingEngine;
  87   PRBool mFromStart;
  88   nsStringArray mIgnoreList;
  89
  90   nsresult SetupDoc(PRUint32 *outBlockOffset);
  91
  92   nsresult GetCurrentBlockIndex(nsITextServicesDocument *aDoc, PRInt32 *outBlockIndex);
  93
  94   nsresult InitSpellCheckDictionaryMap();
  95 };
  96 #endif // mozSpellChecker_h__