extensions/spellcheck/src/mozPersonalDictionary.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 mozPersonalDictionary_h__
  39 #define mozPersonalDictionary_h__
  40
  41 #include "nsCOMPtr.h"
  42 #include "nsString.h"
  43 #include "nsVoidArray.h"
  44 #include "mozIPersonalDictionary.h"
  45 #include "nsIUnicodeEncoder.h"
  46 #include "nsIObserver.h"
  47 #include "nsWeakReference.h"
  48 #include "nsTHashtable.h"
  49 #include "nsCRT.h"
  50
  51 #define MOZ_PERSONALDICTIONARY_CONTRACTID "@mozilla.org/spellchecker/personaldictionary;1"
  52 #define MOZ_PERSONALDICTIONARY_CID         \
  53 { /* 7EF52EAF-B7E1-462B-87E2-5D1DBACA9048 */  \
  54 0X7EF52EAF, 0XB7E1, 0X462B, \
  55   { 0X87, 0XE2, 0X5D, 0X1D, 0XBA, 0XCA, 0X90, 0X48 } }
  56
  57 class nsUniCharEntry : public PLDHashEntryHdr
  58 {
  59 public:
  60   // Hash methods
  61   typedef const PRUnichar* KeyType;
  62   typedef const PRUnichar* KeyTypePointer;
  63
  64   nsUniCharEntry(const PRUnichar* aKey) : mKey(nsCRT::strdup(aKey)) {}
  65   nsUniCharEntry(const nsUniCharEntry& toCopy)
  66   {
  67     NS_NOTREACHED("ALLOW_MEMMOVE is set, so copy ctor shouldn't be called");
  68   }
  69
  70   ~nsUniCharEntry()
  71   {
  72     if (mKey)
  73       nsCRT::free(mKey);
  74   }
  75
  76   KeyType GetKey() const { return mKey; }
  77   PRBool KeyEquals(KeyTypePointer aKey) const { return !nsCRT::strcmp(mKey, aKey); }
  78   static KeyTypePointer KeyToPointer(KeyType aKey) { return aKey; }
  79
  80   static PLDHashNumber HashKey(KeyTypePointer aKey) { return nsCRT::HashCode(aKey); }
  81
  82   enum { ALLOW_MEMMOVE = PR_TRUE };
  83
  84 private:
  85   PRUnichar *mKey;
  86 };
  87
  88
  89 class mozPersonalDictionary : public mozIPersonalDictionary,
  90                               public nsIObserver,
  91                               public nsSupportsWeakReference
  92 {
  93 public:
  94   NS_DECL_ISUPPORTS
  95   NS_DECL_MOZIPERSONALDICTIONARY
  96   NS_DECL_NSIOBSERVER
  97
  98   mozPersonalDictionary();
  99   virtual ~mozPersonalDictionary();
 100
 101   nsresult Init();
 102
 103 protected:
 104   nsStringArray  mDictionary;  /* use something a little smarter eventually*/
 105   PRBool         mDirty;       /* has the dictionary been modified */
 106   nsTHashtable<nsUniCharEntry> mDictionaryTable;
 107   nsTHashtable<nsUniCharEntry> mIgnoreTable;
 108   nsCOMPtr<nsIUnicodeEncoder>  mEncoder; /*Encoder to use to compare with spellchecker word */
 109 };
 110
 111 #endif