Back to index

lightning-sunbird  0.9+nobinonly
mozPersonalDictionary.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is Mozilla Spellchecker Component.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * David Einstein.
00019  * Portions created by the Initial Developer are Copyright (C) 2001
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s): David Einstein Deinst@world.std.com
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either the GNU General Public License Version 2 or later (the "GPL"), or
00026  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 
00038 #ifndef mozPersonalDictionary_h__
00039 #define mozPersonalDictionary_h__
00040 
00041 #include "nsCOMPtr.h"
00042 #include "nsString.h"
00043 #include "nsVoidArray.h"
00044 #include "mozIPersonalDictionary.h"
00045 #include "nsIUnicodeEncoder.h"
00046 #include "nsIObserver.h"
00047 #include "nsWeakReference.h"
00048 #include "nsTHashtable.h"
00049 #include "nsCRT.h"
00050 
00051 #define MOZ_PERSONALDICTIONARY_CONTRACTID "@mozilla.org/spellchecker/personaldictionary;1"
00052 #define MOZ_PERSONALDICTIONARY_CID         \
00053 { /* 7EF52EAF-B7E1-462B-87E2-5D1DBACA9048 */  \
00054 0X7EF52EAF, 0XB7E1, 0X462B, \
00055   { 0X87, 0XE2, 0X5D, 0X1D, 0XBA, 0XCA, 0X90, 0X48 } }
00056 
00057 class nsUniCharEntry : public PLDHashEntryHdr
00058 {
00059 public:
00060   // Hash methods
00061   typedef const PRUnichar* KeyType;
00062   typedef const PRUnichar* KeyTypePointer;
00063 
00064   nsUniCharEntry(const PRUnichar* aKey) : mKey(nsCRT::strdup(aKey)) {}
00065   nsUniCharEntry(const nsUniCharEntry& toCopy)
00066   { 
00067     NS_NOTREACHED("ALLOW_MEMMOVE is set, so copy ctor shouldn't be called");
00068   }
00069 
00070   ~nsUniCharEntry()
00071   { 
00072     if (mKey)
00073       nsCRT::free(mKey);
00074   }
00075  
00076   KeyType GetKey() const { return mKey; }
00077   KeyTypePointer GetKeyPointer() const { return mKey; }
00078   PRBool KeyEquals(KeyTypePointer aKey) const { return !nsCRT::strcmp(mKey, aKey); }
00079   static KeyTypePointer KeyToPointer(KeyType aKey) { return aKey; }
00080 
00081   static PLDHashNumber HashKey(KeyTypePointer aKey) { return nsCRT::HashCode(aKey); }
00082 
00083   enum { ALLOW_MEMMOVE = PR_TRUE };
00084 
00085 private:
00086   PRUnichar *mKey;
00087 };
00088 
00089 
00090 class mozPersonalDictionary : public mozIPersonalDictionary, 
00091                               public nsIObserver,
00092                               public nsSupportsWeakReference
00093 {
00094 public:
00095   NS_DECL_ISUPPORTS
00096   NS_DECL_MOZIPERSONALDICTIONARY
00097   NS_DECL_NSIOBSERVER
00098 
00099   mozPersonalDictionary();
00100   virtual ~mozPersonalDictionary();
00101 
00102   nsresult Init();
00103 
00104 protected:
00105   nsStringArray  mDictionary;  /* use something a little smarter eventually*/
00106   PRBool         mDirty;       /* has the dictionary been modified */
00107   nsTHashtable<nsUniCharEntry> mDictionaryTable;
00108   nsTHashtable<nsUniCharEntry> mIgnoreTable;
00109   nsCOMPtr<nsIUnicodeEncoder>  mEncoder; /*Encoder to use to compare with spellchecker word */
00110 };
00111 
00112 #endif