/*

 * DO NOT EDIT.  THIS FILE IS GENERATED FROM /src/mozilla-central/docshell/shistory/nsISHistory.idl

 */

#ifndef __gen_nsISHistory_h__

#define __gen_nsISHistory_h__

#ifndef __gen_nsISupports_h__

#include "nsISupports.h"

#endif

#include "mozilla/AlreadyAddRefed.h"

#include "mozilla/Assertions.h"

#include "mozilla/DebugOnly.h"

/* For IDL files that don't want to include root IDL files. */

#ifndef NS_NO_VTABLE

#define NS_NO_VTABLE

#endif

class nsIBFCacheEntry; /* forward declaration */

class nsIDocShell; /* forward declaration */

class nsISHEntry; /* forward declaration */

class nsISHistoryListener; /* forward declaration */

class nsIURI; /* forward declaration */

#include "nsTArrayForwardDeclare.h"

/* starting interface:    nsISHistory */

#define NS_ISHISTORY_IID_STR "7b807041-e60a-4384-935f-af3061d8b815"

#define NS_ISHISTORY_IID \

  {0x7b807041, 0xe60a, 0x4384, \

    { 0x93, 0x5f, 0xaf, 0x30, 0x61, 0xd8, 0xb8, 0x15 }}

class NS_NO_VTABLE nsISHistory : public nsISupports {

 public:

  NS_DECLARE_STATIC_IID_ACCESSOR(NS_ISHISTORY_IID)

  /* [infallible] readonly attribute long count; */

  NS_IMETHOD GetCount(int32_t *aCount) = 0;

  inline int32_t GetCount()

  {

    int32_t result;

    mozilla::DebugOnly<nsresult> rv = GetCount(&result);

    MOZ_ASSERT(NS_SUCCEEDED(rv));

    return result;

  }

  /* attribute long index; */

  NS_IMETHOD GetIndex(int32_t *aIndex) = 0;

  NS_IMETHOD SetIndex(int32_t aIndex) = 0;

  /* [infallible] readonly attribute long requestedIndex; */

  NS_IMETHOD GetRequestedIndex(int32_t *aRequestedIndex) = 0;

  inline int32_t GetRequestedIndex()

  {

    int32_t result;

    mozilla::DebugOnly<nsresult> rv = GetRequestedIndex(&result);

    MOZ_ASSERT(NS_SUCCEEDED(rv));

    return result;

  }

  /* nsISHEntry getEntryAtIndex (in long aIndex); */

  NS_IMETHOD GetEntryAtIndex(int32_t aIndex, nsISHEntry **_retval) = 0;

  /* void PurgeHistory (in long aNumEntries); */

  NS_IMETHOD PurgeHistory(int32_t aNumEntries) = 0;

  /* void addSHistoryListener (in nsISHistoryListener aListener); */

  NS_IMETHOD AddSHistoryListener(nsISHistoryListener *aListener) = 0;

  /* void removeSHistoryListener (in nsISHistoryListener aListener); */

  NS_IMETHOD RemoveSHistoryListener(nsISHistoryListener *aListener) = 0;

  /* void reloadCurrentEntry (); */

  NS_IMETHOD ReloadCurrentEntry(void) = 0;

  /* [noscript] void gotoIndex (in long aIndex); */

  NS_IMETHOD GotoIndex(int32_t aIndex) = 0;

  /* [noscript,notxpcom] long getIndexOfEntry (in nsISHEntry aEntry); */

  NS_IMETHOD_(int32_t) GetIndexOfEntry(nsISHEntry *aEntry) = 0;

  /* void addEntry (in nsISHEntry aEntry, in boolean aPersist); */

  NS_IMETHOD AddEntry(nsISHEntry *aEntry, bool aPersist) = 0;

  /* [noscript,notxpcom] void setRootDocShell (in nsIDocShell rootDocShell); */

  NS_IMETHOD_(void) SetRootDocShell(nsIDocShell *rootDocShell) = 0;

  /* void updateIndex (); */

  NS_IMETHOD UpdateIndex(void) = 0;

  /* void replaceEntry (in long aIndex, in nsISHEntry aReplaceEntry); */

  NS_IMETHOD ReplaceEntry(int32_t aIndex, nsISHEntry *aReplaceEntry) = 0;

  /* boolean notifyOnHistoryReload (in nsIURI aReloadURI, in unsigned long aReloadFlags); */

  NS_IMETHOD NotifyOnHistoryReload(nsIURI *aReloadURI, uint32_t aReloadFlags, bool *_retval) = 0;

  /* void evictOutOfRangeContentViewers (in long aIndex); */

  NS_IMETHOD EvictOutOfRangeContentViewers(int32_t aIndex) = 0;

  /* void evictExpiredContentViewerForEntry (in nsIBFCacheEntry aEntry); */

  NS_IMETHOD EvictExpiredContentViewerForEntry(nsIBFCacheEntry *aEntry) = 0;

  /* void evictAllContentViewers (); */

  NS_IMETHOD EvictAllContentViewers(void) = 0;

  /* [noscript,notxpcom] void addToExpirationTracker (in nsIBFCacheEntry aEntry); */

  NS_IMETHOD_(void) AddToExpirationTracker(nsIBFCacheEntry *aEntry) = 0;

  /* [noscript,notxpcom] void removeFromExpirationTracker (in nsIBFCacheEntry aEntry); */

  NS_IMETHOD_(void) RemoveFromExpirationTracker(nsIBFCacheEntry *aEntry) = 0;

  /* [noscript,notxpcom] void RemoveDynEntries (in long aIndex, in nsISHEntry aEntry); */

  NS_IMETHOD_(void) RemoveDynEntries(int32_t aIndex, nsISHEntry *aEntry) = 0;

  /* [noscript,notxpcom] void RemoveDynEntriesForBFCacheEntry (in nsIBFCacheEntry aEntry); */

  NS_IMETHOD_(void) RemoveDynEntriesForBFCacheEntry(nsIBFCacheEntry *aEntry) = 0;

  /* [noscript,notxpcom] void RemoveEntries (in nsDocshellIDArray aIDs, in long aStartIndex); */

  NS_IMETHOD_(void) RemoveEntries(nsTArray<nsID> & aIDs, int32_t aStartIndex) = 0;

};

  NS_DEFINE_STATIC_IID_ACCESSOR(nsISHistory, NS_ISHISTORY_IID)

/* Use this macro when declaring classes that implement this interface. */

#define NS_DECL_NSISHISTORY \

  using nsISHistory::GetCount; \

  NS_IMETHOD GetCount(int32_t *aCount) override; \

  NS_IMETHOD GetIndex(int32_t *aIndex) override; \

  NS_IMETHOD SetIndex(int32_t aIndex) override; \

  using nsISHistory::GetRequestedIndex; \

  NS_IMETHOD GetRequestedIndex(int32_t *aRequestedIndex) override; \

  NS_IMETHOD GetEntryAtIndex(int32_t aIndex, nsISHEntry **_retval) override; \

  NS_IMETHOD PurgeHistory(int32_t aNumEntries) override; \

  NS_IMETHOD AddSHistoryListener(nsISHistoryListener *aListener) override; \

  NS_IMETHOD RemoveSHistoryListener(nsISHistoryListener *aListener) override; \

  NS_IMETHOD ReloadCurrentEntry(void) override; \

  NS_IMETHOD GotoIndex(int32_t aIndex) override; \

  NS_IMETHOD_(int32_t) GetIndexOfEntry(nsISHEntry *aEntry) override; \

  NS_IMETHOD AddEntry(nsISHEntry *aEntry, bool aPersist) override; \

  NS_IMETHOD_(void) SetRootDocShell(nsIDocShell *rootDocShell) override; \

  NS_IMETHOD UpdateIndex(void) override; \

  NS_IMETHOD ReplaceEntry(int32_t aIndex, nsISHEntry *aReplaceEntry) override; \

  NS_IMETHOD NotifyOnHistoryReload(nsIURI *aReloadURI, uint32_t aReloadFlags, bool *_retval) override; \

  NS_IMETHOD EvictOutOfRangeContentViewers(int32_t aIndex) override; \

  NS_IMETHOD EvictExpiredContentViewerForEntry(nsIBFCacheEntry *aEntry) override; \

  NS_IMETHOD EvictAllContentViewers(void) override; \

  NS_IMETHOD_(void) AddToExpirationTracker(nsIBFCacheEntry *aEntry) override; \

  NS_IMETHOD_(void) RemoveFromExpirationTracker(nsIBFCacheEntry *aEntry) override; \

  NS_IMETHOD_(void) RemoveDynEntries(int32_t aIndex, nsISHEntry *aEntry) override; \

  NS_IMETHOD_(void) RemoveDynEntriesForBFCacheEntry(nsIBFCacheEntry *aEntry) override; \

  NS_IMETHOD_(void) RemoveEntries(nsTArray<nsID> & aIDs, int32_t aStartIndex) override; 

/* Use this macro when declaring the members of this interface when the

   class doesn't implement the interface. This is useful for forwarding. */

#define NS_DECL_NON_VIRTUAL_NSISHISTORY \

  using nsISHistory::GetCount; \

  nsresult GetCount(int32_t *aCount); \

  nsresult GetIndex(int32_t *aIndex); \

  nsresult SetIndex(int32_t aIndex); \

  using nsISHistory::GetRequestedIndex; \

  nsresult GetRequestedIndex(int32_t *aRequestedIndex); \

  nsresult GetEntryAtIndex(int32_t aIndex, nsISHEntry **_retval); \

  nsresult PurgeHistory(int32_t aNumEntries); \

  nsresult AddSHistoryListener(nsISHistoryListener *aListener); \

  nsresult RemoveSHistoryListener(nsISHistoryListener *aListener); \

  nsresult ReloadCurrentEntry(void); \

  nsresult GotoIndex(int32_t aIndex); \

  nsresult_(int32_t) GetIndexOfEntry(nsISHEntry *aEntry); \

  nsresult AddEntry(nsISHEntry *aEntry, bool aPersist); \

  nsresult_(void) SetRootDocShell(nsIDocShell *rootDocShell); \

  nsresult UpdateIndex(void); \

  nsresult ReplaceEntry(int32_t aIndex, nsISHEntry *aReplaceEntry); \

  nsresult NotifyOnHistoryReload(nsIURI *aReloadURI, uint32_t aReloadFlags, bool *_retval); \

  nsresult EvictOutOfRangeContentViewers(int32_t aIndex); \

  nsresult EvictExpiredContentViewerForEntry(nsIBFCacheEntry *aEntry); \

  nsresult EvictAllContentViewers(void); \

  nsresult_(void) AddToExpirationTracker(nsIBFCacheEntry *aEntry); \

  nsresult_(void) RemoveFromExpirationTracker(nsIBFCacheEntry *aEntry); \

  nsresult_(void) RemoveDynEntries(int32_t aIndex, nsISHEntry *aEntry); \

  nsresult_(void) RemoveDynEntriesForBFCacheEntry(nsIBFCacheEntry *aEntry); \

  nsresult_(void) RemoveEntries(nsTArray<nsID> & aIDs, int32_t aStartIndex); 

/* Use this macro to declare functions that forward the behavior of this interface to another object. */

#define NS_FORWARD_NSISHISTORY(_to) \

  using nsISHistory::GetCount; \

  NS_IMETHOD GetCount(int32_t *aCount) override { return _to GetCount(aCount); } \

  NS_IMETHOD GetIndex(int32_t *aIndex) override { return _to GetIndex(aIndex); } \

  NS_IMETHOD SetIndex(int32_t aIndex) override { return _to SetIndex(aIndex); } \

  using nsISHistory::GetRequestedIndex; \

  NS_IMETHOD GetRequestedIndex(int32_t *aRequestedIndex) override { return _to GetRequestedIndex(aRequestedIndex); } \

  NS_IMETHOD GetEntryAtIndex(int32_t aIndex, nsISHEntry **_retval) override { return _to GetEntryAtIndex(aIndex, _retval); } \

  NS_IMETHOD PurgeHistory(int32_t aNumEntries) override { return _to PurgeHistory(aNumEntries); } \

  NS_IMETHOD AddSHistoryListener(nsISHistoryListener *aListener) override { return _to AddSHistoryListener(aListener); } \

  NS_IMETHOD RemoveSHistoryListener(nsISHistoryListener *aListener) override { return _to RemoveSHistoryListener(aListener); } \

  NS_IMETHOD ReloadCurrentEntry(void) override { return _to ReloadCurrentEntry(); } \

  NS_IMETHOD GotoIndex(int32_t aIndex) override { return _to GotoIndex(aIndex); } \

  NS_IMETHOD_(int32_t) GetIndexOfEntry(nsISHEntry *aEntry) override { return _to GetIndexOfEntry(aEntry); } \

  NS_IMETHOD AddEntry(nsISHEntry *aEntry, bool aPersist) override { return _to AddEntry(aEntry, aPersist); } \

  NS_IMETHOD_(void) SetRootDocShell(nsIDocShell *rootDocShell) override { return _to SetRootDocShell(rootDocShell); } \

  NS_IMETHOD UpdateIndex(void) override { return _to UpdateIndex(); } \

  NS_IMETHOD ReplaceEntry(int32_t aIndex, nsISHEntry *aReplaceEntry) override { return _to ReplaceEntry(aIndex, aReplaceEntry); } \

  NS_IMETHOD NotifyOnHistoryReload(nsIURI *aReloadURI, uint32_t aReloadFlags, bool *_retval) override { return _to NotifyOnHistoryReload(aReloadURI, aReloadFlags, _retval); } \

  NS_IMETHOD EvictOutOfRangeContentViewers(int32_t aIndex) override { return _to EvictOutOfRangeContentViewers(aIndex); } \

  NS_IMETHOD EvictExpiredContentViewerForEntry(nsIBFCacheEntry *aEntry) override { return _to EvictExpiredContentViewerForEntry(aEntry); } \

  NS_IMETHOD EvictAllContentViewers(void) override { return _to EvictAllContentViewers(); } \

  NS_IMETHOD_(void) AddToExpirationTracker(nsIBFCacheEntry *aEntry) override { return _to AddToExpirationTracker(aEntry); } \

  NS_IMETHOD_(void) RemoveFromExpirationTracker(nsIBFCacheEntry *aEntry) override { return _to RemoveFromExpirationTracker(aEntry); } \

  NS_IMETHOD_(void) RemoveDynEntries(int32_t aIndex, nsISHEntry *aEntry) override { return _to RemoveDynEntries(aIndex, aEntry); } \

  NS_IMETHOD_(void) RemoveDynEntriesForBFCacheEntry(nsIBFCacheEntry *aEntry) override { return _to RemoveDynEntriesForBFCacheEntry(aEntry); } \

  NS_IMETHOD_(void) RemoveEntries(nsTArray<nsID> & aIDs, int32_t aStartIndex) override { return _to RemoveEntries(aIDs, aStartIndex); } 

/* Use this macro to declare functions that forward the behavior of this interface to another object in a safe way. */

#define NS_FORWARD_SAFE_NSISHISTORY(_to) \

  NS_IMETHOD GetCount(int32_t *aCount) override { return !_to ? NS_ERROR_NULL_POINTER : _to->GetCount(aCount); } \

  NS_IMETHOD GetIndex(int32_t *aIndex) override { return !_to ? NS_ERROR_NULL_POINTER : _to->GetIndex(aIndex); } \

  NS_IMETHOD SetIndex(int32_t aIndex) override { return !_to ? NS_ERROR_NULL_POINTER : _to->SetIndex(aIndex); } \

  NS_IMETHOD GetRequestedIndex(int32_t *aRequestedIndex) override { return !_to ? NS_ERROR_NULL_POINTER : _to->GetRequestedIndex(aRequestedIndex); } \

  NS_IMETHOD GetEntryAtIndex(int32_t aIndex, nsISHEntry **_retval) override { return !_to ? NS_ERROR_NULL_POINTER : _to->GetEntryAtIndex(aIndex, _retval); } \

  NS_IMETHOD PurgeHistory(int32_t aNumEntries) override { return !_to ? NS_ERROR_NULL_POINTER : _to->PurgeHistory(aNumEntries); } \

  NS_IMETHOD AddSHistoryListener(nsISHistoryListener *aListener) override { return !_to ? NS_ERROR_NULL_POINTER : _to->AddSHistoryListener(aListener); } \

  NS_IMETHOD RemoveSHistoryListener(nsISHistoryListener *aListener) override { return !_to ? NS_ERROR_NULL_POINTER : _to->RemoveSHistoryListener(aListener); } \

  NS_IMETHOD ReloadCurrentEntry(void) override { return !_to ? NS_ERROR_NULL_POINTER : _to->ReloadCurrentEntry(); } \

  NS_IMETHOD GotoIndex(int32_t aIndex) override { return !_to ? NS_ERROR_NULL_POINTER : _to->GotoIndex(aIndex); } \

  NS_IMETHOD_(int32_t) GetIndexOfEntry(nsISHEntry *aEntry) override; \

  NS_IMETHOD AddEntry(nsISHEntry *aEntry, bool aPersist) override { return !_to ? NS_ERROR_NULL_POINTER : _to->AddEntry(aEntry, aPersist); } \

  NS_IMETHOD_(void) SetRootDocShell(nsIDocShell *rootDocShell) override; \

  NS_IMETHOD UpdateIndex(void) override { return !_to ? NS_ERROR_NULL_POINTER : _to->UpdateIndex(); } \

  NS_IMETHOD ReplaceEntry(int32_t aIndex, nsISHEntry *aReplaceEntry) override { return !_to ? NS_ERROR_NULL_POINTER : _to->ReplaceEntry(aIndex, aReplaceEntry); } \

  NS_IMETHOD NotifyOnHistoryReload(nsIURI *aReloadURI, uint32_t aReloadFlags, bool *_retval) override { return !_to ? NS_ERROR_NULL_POINTER : _to->NotifyOnHistoryReload(aReloadURI, aReloadFlags, _retval); } \

  NS_IMETHOD EvictOutOfRangeContentViewers(int32_t aIndex) override { return !_to ? NS_ERROR_NULL_POINTER : _to->EvictOutOfRangeContentViewers(aIndex); } \

  NS_IMETHOD EvictExpiredContentViewerForEntry(nsIBFCacheEntry *aEntry) override { return !_to ? NS_ERROR_NULL_POINTER : _to->EvictExpiredContentViewerForEntry(aEntry); } \

  NS_IMETHOD EvictAllContentViewers(void) override { return !_to ? NS_ERROR_NULL_POINTER : _to->EvictAllContentViewers(); } \

  NS_IMETHOD_(void) AddToExpirationTracker(nsIBFCacheEntry *aEntry) override; \

  NS_IMETHOD_(void) RemoveFromExpirationTracker(nsIBFCacheEntry *aEntry) override; \

  NS_IMETHOD_(void) RemoveDynEntries(int32_t aIndex, nsISHEntry *aEntry) override; \

  NS_IMETHOD_(void) RemoveDynEntriesForBFCacheEntry(nsIBFCacheEntry *aEntry) override; \

  NS_IMETHOD_(void) RemoveEntries(nsTArray<nsID> & aIDs, int32_t aStartIndex) override; 

#endif /* __gen_nsISHistory_h__ */