Electrolysis/places that need session history

Places that need session history

This planning document is preparatory work for task "Session history for remote tabs" in [1]. It lists all the places that need (read / write) session history.

all the following objects make use of session history (or session history listener) in a certain way. For each of them, nsISHistory usage is detailled and links to code are provided.

Places using nsISHistory

WebNavigation interface || attribute sessionHistory ||

• nsIWebNavigation.idl

CCUncollectableMarker component || nsComPtr history ||

• '::MarkDocShell()' || nsCCUncollectableMarker.cpp

DocShell component || nsComPtr shistory & rootSH ||

• '::GetInterface()' || nsDocShell.cpp
• '::DoAddChildSHEntry()' || nsDocShell.cpp
• '::getCanGoBack()' || nsDocShell.cpp
• '::getCanGoForward()' || nsDocShell.cpp
• '::goBack()' || nsDocShell.cpp
• '::goForward()' || nsDocShell.cpp
• '::gotoIndex()' || nsDocShell.cpp
• '::Reload()' || nsDocShell.cpp
• '::EndPageLoad()' || nsDocShell.cpp
• '::RestoreFromHistory()' || nsDocShell.cpp
• '::OnNewURI()' || nsDocShell.cpp

SHEntry || QI for nsISHistoryInternal ||

• '::Expire()' || nsSHEntry.cpp

EmbedPrivate || public member mSessionHistory ||

• '::Realize()' || EmbedPrivate.cpp

WebBrowser || adds/removes SHistory listeners ||

• '::BindListener()' || nsWebBrowser.cpp
• '::UnBindListener()' || nsWebBrowser.cpp

DocumentViewer || QI for nsISHistoryInternal ||

• '::Show()' || nsDocumentViewer.cpp

broswer-places.js || call .history member ||

• '::PCH_bookmarkPage()' || browser-places.js

browser.js || .sessionHistory & .history ||

• '::prepareForStartup()' || browser.js
• '::gotoHistoryIndex()' || browser.js
• '::BrowserForward()' || browser.js
• '::BrowserBack()' || browser.js
• '::BrowserReloadWithFlags()' || browser.js
• '::gotoHistorFillHistoryMenuyIndex()' || browser.js
• '::getShortcutOrURI()' || browser.js
• '::BrowserSetForcedCharacterSet()' || browser.js
• '::undoCloseTab()' || browser.js

bookmarkProperties.js || .history ||

• '::_getURITitleFromHistory()' || bookmarkProperties.js
• '::_getCreateNewBookmarkTransaction()' || bookmarkProperties.js

controller.js || .history ||

• '::__removeRange()' || controller.js
• '::_removeRowsFromHistory()' || controller.js
• '::_removeHistoryContainer()' || controller.js

editBookmarkOverlay.js || .history ||

• '::_getItemStaticTitle()' || editBookmarkOverlay.js

history-panel.js || .history ||

• '::searchHistory()' || history-panel.js

places.js || .history ||

• '::onPlaceSelected()' || places.js
• '::saveSearch()' || places.js
• '::search()' || places.js
• '::doSearch()' || places.js

utils.js || .history ||

• '::markPageAsTyped()' || utils.js
• '::markPageAsFollowedBookmark()' || utils.js

nsPlacesTransactionsService.js || .history ||

• '::doTransaction()' || nsPlacesTransactionsService.js

Places using nsISHistoryListener

SHistoryInternal interface || attribute listener ||

• nsISHistoryInternal.idl

DocShell || nsComPtr listener||

• '::Reload()' || nsDocShell.cpp

WebBrowser || QI for nsISHistoryListener ||

• '::bindListener()' || nsWebBrowser.cpp

WebBrowserChrome || derives from nsISHistoryListener ||

• WebBrowserChrome.h

Other cases

FrameLoader || nsComPtr ourHistory || nsFrameLoader.cpp

• but it does NOT yet do anything useful with it. Take a look.