embedding/lite/nsEmbedGlobalHistory.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.org code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 1998
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *   Conrad Carlen <ccarlen@netscape.com>
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either the GNU General Public License Version 2 or later (the "GPL"), or
  27  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK ***** */
  38
  39 #ifndef __nsEmbedGlobalHistory_h__
  40 #define __nsEmbedGlobalHistory_h__
  41
  42 #include "nsIGlobalHistory.h"
  43 #include "nsIObserver.h"
  44 #include "nsWeakReference.h"
  45 #include "nsILocalFile.h"
  46 #include "nsString.h"
  47
  48 class nsHashtable;
  49 class nsHashKey;
  50 class nsCStringKey;
  51 class HistoryEntry;
  52
  53 //*****************************************************************************
  54 // nsEmbedGlobalHistory
  55 //*****************************************************************************
  56
  57 // {2f977d51-5485-11d4-87e2-0010a4e75ef2}
  58 #define NS_EMBEDGLOBALHISTORY_CID \
  59   { 0x2f977d51, 0x5485, 0x11d4, \
  60   { 0x87, 0xe2, 0x00, 0x10, 0xa4, 0xe7, 0x5e, 0xf2 } }
  61
  62 class nsEmbedGlobalHistory: public nsIGlobalHistory,
  63                             public nsIObserver,
  64                             public nsSupportsWeakReference
  65 {
  66 public:
  67                     nsEmbedGlobalHistory();
  68   virtual           ~nsEmbedGlobalHistory();
  69
  70   NS_IMETHOD        Init();
  71
  72   NS_DECL_ISUPPORTS
  73   NS_DECL_NSIGLOBALHISTORY
  74   NS_DECL_NSIOBSERVER
  75
  76 protected:
  77   enum { kFlushModeAppend, kFlushModeFullWrite };
  78
  79   nsresult          LoadData();
  80   nsresult          FlushData(PRIntn mode = kFlushModeFullWrite);
  81   nsresult          ResetData();
  82
  83   nsresult          GetHistoryFile();
  84
  85   PRBool            EntryHasExpired(HistoryEntry *entry);
  86   static PRIntn PR_CALLBACK enumRemoveEntryIfExpired(nsHashKey *aKey, void *aData, void* closure);
  87
  88 protected:
  89   PRBool            mDataIsLoaded;
  90   PRInt32           mEntriesAddedSinceFlush;
  91   nsCOMPtr<nsILocalFile>  mHistoryFile;
  92   nsHashtable       *mURLTable;
  93   PRInt64           mExpirationInterval;
  94 };
  95
  96 #endif