Back to index

lightning-sunbird  0.9+nobinonly
nsEmbedGlobalHistory.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.org code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 1998
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *   Conrad Carlen <ccarlen@netscape.com>
00024  *
00025  * Alternatively, the contents of this file may be used under the terms of
00026  * either the GNU General Public License Version 2 or later (the "GPL"), or
00027  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00028  * in which case the provisions of the GPL or the LGPL are applicable instead
00029  * of those above. If you wish to allow use of your version of this file only
00030  * under the terms of either the GPL or the LGPL, and not to allow others to
00031  * use your version of this file under the terms of the MPL, indicate your
00032  * decision by deleting the provisions above and replace them with the notice
00033  * and other provisions required by the GPL or the LGPL. If you do not delete
00034  * the provisions above, a recipient may use your version of this file under
00035  * the terms of any one of the MPL, the GPL or the LGPL.
00036  *
00037  * ***** END LICENSE BLOCK ***** */
00038 
00039 #ifndef __nsEmbedGlobalHistory_h__
00040 #define __nsEmbedGlobalHistory_h__
00041 
00042 #include "nsIGlobalHistory.h"
00043 #include "nsIObserver.h"
00044 #include "nsWeakReference.h"
00045 #include "nsILocalFile.h"
00046 #include "nsString.h"
00047 
00048 class nsHashtable;
00049 class nsHashKey;
00050 class nsCStringKey;
00051 class HistoryEntry;
00052 
00053 //*****************************************************************************
00054 // nsEmbedGlobalHistory
00055 //*****************************************************************************   
00056 
00057 // {2f977d51-5485-11d4-87e2-0010a4e75ef2}
00058 #define NS_EMBEDGLOBALHISTORY_CID \
00059   { 0x2f977d51, 0x5485, 0x11d4, \
00060   { 0x87, 0xe2, 0x00, 0x10, 0xa4, 0xe7, 0x5e, 0xf2 } }
00061 
00062 class nsEmbedGlobalHistory: public nsIGlobalHistory,
00063                             public nsIObserver,
00064                             public nsSupportsWeakReference
00065 {
00066 public:
00067                     nsEmbedGlobalHistory();
00068   virtual           ~nsEmbedGlobalHistory();
00069   
00070   NS_IMETHOD        Init();
00071 
00072   NS_DECL_ISUPPORTS
00073   NS_DECL_NSIGLOBALHISTORY
00074   NS_DECL_NSIOBSERVER
00075 
00076 protected:
00077   enum { kFlushModeAppend, kFlushModeFullWrite };
00078   
00079   nsresult          LoadData();
00080   nsresult          FlushData(PRIntn mode = kFlushModeFullWrite);
00081   nsresult          ResetData();
00082 
00083   nsresult          GetHistoryFile();
00084 
00085   PRBool            EntryHasExpired(HistoryEntry *entry);
00086   static PRIntn PR_CALLBACK enumRemoveEntryIfExpired(nsHashKey *aKey, void *aData, void* closure);
00087 
00088 protected:
00089   PRBool            mDataIsLoaded;
00090   PRInt32           mEntriesAddedSinceFlush;
00091   nsCOMPtr<nsILocalFile>  mHistoryFile;
00092   nsHashtable       *mURLTable;
00093   PRInt64           mExpirationInterval;
00094 };
00095 
00096 #endif