The Tor Browser: content/xul/document/src/nsXULCommandDispatcher.cpp@6474c204b198 (annotated)

content/xul/document/src/nsXULCommandDispatcher.cpp@6474c204b198 (annotated)

content/xul/document/src/nsXULCommandDispatcher.cpp

Wed, 31 Dec 2014 06:09:35 +0100

author: Michael Schloh von Bennewitz <michael@schloh.com>
date: Wed, 31 Dec 2014 06:09:35 +0100
changeset 0: 6474c204b198
permissions: -rw-r--r--

Cloned upstream origin tor-browser at tor-browser-31.3.0esr-4.5-1-build1
revision ID fc1c9ff7c1b2defdbc039f12214767608f46423f for hacking purpose.

 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
 /* vim: set ts=2 sw=2 et tw=80: */
 /* This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 /*
   This file provides the implementation for the XUL Command Dispatcher.
  */
 #include "nsIContent.h"
 #include "nsFocusManager.h"
 #include "nsIControllers.h"
 #include "nsIDOMDocument.h"
 #include "nsIDOMElement.h"
 #include "nsIDOMWindow.h"
 #include "nsIDOMXULElement.h"
 #include "nsIDocument.h"
 #include "nsPresContext.h"
 #include "nsIPresShell.h"
 #include "nsIScriptGlobalObject.h"
 #include "nsPIDOMWindow.h"
 #include "nsPIWindowRoot.h"
 #include "nsRDFCID.h"
 #include "nsXULCommandDispatcher.h"
 #include "prlog.h"
 #include "nsContentUtils.h"
 #include "nsReadableUtils.h"
 #include "nsCRT.h"
 #include "nsError.h"
 #include "nsDOMClassInfoID.h"
 #include "mozilla/BasicEvents.h"
 #include "mozilla/EventDispatcher.h"
 #include "mozilla/dom/Element.h"
 using namespace mozilla;
 #ifdef PR_LOGGING
 static PRLogModuleInfo* gCommandLog;
 #endif
 ////////////////////////////////////////////////////////////////////////
 nsXULCommandDispatcher::nsXULCommandDispatcher(nsIDocument* aDocument)
     : mDocument(aDocument), mUpdaters(nullptr)
 {
 #ifdef PR_LOGGING
   if (! gCommandLog)
     gCommandLog = PR_NewLogModule("nsXULCommandDispatcher");
 #endif
 }
 nsXULCommandDispatcher::~nsXULCommandDispatcher()
 {
   Disconnect();
 }
 // QueryInterface implementation for nsXULCommandDispatcher
 DOMCI_DATA(XULCommandDispatcher, nsXULCommandDispatcher)
 NS_INTERFACE_MAP_BEGIN_CYCLE_COLLECTION(nsXULCommandDispatcher)
     NS_INTERFACE_MAP_ENTRY(nsIDOMXULCommandDispatcher)
     NS_INTERFACE_MAP_ENTRY(nsISupportsWeakReference)
     NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, nsIDOMXULCommandDispatcher)
     NS_DOM_INTERFACE_MAP_ENTRY_CLASSINFO(XULCommandDispatcher)
 NS_INTERFACE_MAP_END
 NS_IMPL_CYCLE_COLLECTING_ADDREF(nsXULCommandDispatcher)
 NS_IMPL_CYCLE_COLLECTING_RELEASE(nsXULCommandDispatcher)
 NS_IMPL_CYCLE_COLLECTION_CLASS(nsXULCommandDispatcher)
 NS_IMPL_CYCLE_COLLECTION_UNLINK_BEGIN(nsXULCommandDispatcher)
   tmp->Disconnect();
 NS_IMPL_CYCLE_COLLECTION_UNLINK_END
 NS_IMPL_CYCLE_COLLECTION_TRAVERSE_BEGIN(nsXULCommandDispatcher)
   NS_IMPL_CYCLE_COLLECTION_TRAVERSE(mDocument)
   Updater* updater = tmp->mUpdaters;
   while (updater) {
     cb.NoteXPCOMChild(updater->mElement);
     updater = updater->mNext;
   }
 NS_IMPL_CYCLE_COLLECTION_TRAVERSE_END
 void
 nsXULCommandDispatcher::Disconnect()
 {
   while (mUpdaters) {
     Updater* doomed = mUpdaters;
     mUpdaters = mUpdaters->mNext;
     delete doomed;
   }
   mDocument = nullptr;
 }
 already_AddRefed<nsPIWindowRoot>
 nsXULCommandDispatcher::GetWindowRoot()
 {
   if (mDocument) {
     nsCOMPtr<nsPIDOMWindow> window(mDocument->GetWindow());
     if (window) {
       return window->GetTopWindowRoot();
     }
   }
   return nullptr;
 }
 nsIContent*
 nsXULCommandDispatcher::GetRootFocusedContentAndWindow(nsPIDOMWindow** aWindow)
 {
   *aWindow = nullptr;
   if (mDocument) {
     nsCOMPtr<nsPIDOMWindow> win = mDocument->GetWindow();
     if (win) {
       nsCOMPtr<nsPIDOMWindow> rootWindow = win->GetPrivateRoot();
       if (rootWindow) {
         return nsFocusManager::GetFocusedDescendant(rootWindow, true, aWindow);
       }
     }
   }
   return nullptr;
 }
 NS_IMETHODIMP
 nsXULCommandDispatcher::GetFocusedElement(nsIDOMElement** aElement)
 {
   *aElement = nullptr;
   nsCOMPtr<nsPIDOMWindow> focusedWindow;
   nsIContent* focusedContent =
     GetRootFocusedContentAndWindow(getter_AddRefs(focusedWindow));
   if (focusedContent) {
     CallQueryInterface(focusedContent, aElement);
     // Make sure the caller can access the focused element.
     if (!nsContentUtils::CanCallerAccess(*aElement)) {
       // XXX This might want to return null, but we use that return value
       // to mean "there is no focused element," so to be clear, throw an
       // exception.
       NS_RELEASE(*aElement);
       return NS_ERROR_DOM_SECURITY_ERR;
     }
   }
   return NS_OK;
 }
 NS_IMETHODIMP
 nsXULCommandDispatcher::GetFocusedWindow(nsIDOMWindow** aWindow)
 {
   *aWindow = nullptr;
   nsCOMPtr<nsPIDOMWindow> window;
   GetRootFocusedContentAndWindow(getter_AddRefs(window));
   if (!window)
     return NS_OK;
   // Make sure the caller can access this window. The caller can access this
   // window iff it can access the document.
   nsCOMPtr<nsIDOMDocument> domdoc;
   nsresult rv = window->GetDocument(getter_AddRefs(domdoc));
   NS_ENSURE_SUCCESS(rv, rv);
   // Note: If there is no document, then this window has been cleared and
   // there's nothing left to protect, so let the window pass through.
   if (domdoc && !nsContentUtils::CanCallerAccess(domdoc))
     return NS_ERROR_DOM_SECURITY_ERR;
   CallQueryInterface(window, aWindow);
   return NS_OK;
 }
 NS_IMETHODIMP
 nsXULCommandDispatcher::SetFocusedElement(nsIDOMElement* aElement)
 {
   nsIFocusManager* fm = nsFocusManager::GetFocusManager();
   NS_ENSURE_TRUE(fm, NS_ERROR_FAILURE);
   if (aElement)
     return fm->SetFocus(aElement, 0);
   // if aElement is null, clear the focus in the currently focused child window
   nsCOMPtr<nsPIDOMWindow> focusedWindow;
   GetRootFocusedContentAndWindow(getter_AddRefs(focusedWindow));
   return fm->ClearFocus(focusedWindow);
 }
 NS_IMETHODIMP
 nsXULCommandDispatcher::SetFocusedWindow(nsIDOMWindow* aWindow)
 {
   NS_ENSURE_TRUE(aWindow, NS_OK); // do nothing if set to null
   nsCOMPtr<nsPIDOMWindow> window(do_QueryInterface(aWindow));
   NS_ENSURE_TRUE(window, NS_ERROR_FAILURE);
   nsIFocusManager* fm = nsFocusManager::GetFocusManager();
   NS_ENSURE_TRUE(fm, NS_ERROR_FAILURE);
   // get the containing frame for the window, and set it as focused. This will
   // end up focusing whatever is currently focused inside the frame. Since
   // setting the command dispatcher's focused window doesn't raise the window,
   // setting it to a top-level window doesn't need to do anything.
   nsCOMPtr<nsIDOMElement> frameElement =
     do_QueryInterface(window->GetFrameElementInternal());
   if (frameElement)
     return fm->SetFocus(frameElement, 0);
   return NS_OK;
 }
 NS_IMETHODIMP
 nsXULCommandDispatcher::AdvanceFocus()
 {
   return AdvanceFocusIntoSubtree(nullptr);
 }
 NS_IMETHODIMP
 nsXULCommandDispatcher::RewindFocus()
 {
   nsCOMPtr<nsPIDOMWindow> win;
   GetRootFocusedContentAndWindow(getter_AddRefs(win));
   nsCOMPtr<nsIDOMElement> result;
   nsIFocusManager* fm = nsFocusManager::GetFocusManager();
   if (fm)
     return fm->MoveFocus(win, nullptr, nsIFocusManager::MOVEFOCUS_BACKWARD,
 , getter_AddRefs(result));
   return NS_OK;
 }
 NS_IMETHODIMP
 nsXULCommandDispatcher::AdvanceFocusIntoSubtree(nsIDOMElement* aElt)
 {
   nsCOMPtr<nsPIDOMWindow> win;
   GetRootFocusedContentAndWindow(getter_AddRefs(win));
   nsCOMPtr<nsIDOMElement> result;
   nsIFocusManager* fm = nsFocusManager::GetFocusManager();
   if (fm)
     return fm->MoveFocus(win, aElt, nsIFocusManager::MOVEFOCUS_FORWARD,
 , getter_AddRefs(result));
   return NS_OK;
 }
 NS_IMETHODIMP
 nsXULCommandDispatcher::AddCommandUpdater(nsIDOMElement* aElement,
                                           const nsAString& aEvents,
                                           const nsAString& aTargets)
 {
   NS_PRECONDITION(aElement != nullptr, "null ptr");
   if (! aElement)
     return NS_ERROR_NULL_POINTER;
   NS_ENSURE_TRUE(mDocument, NS_ERROR_UNEXPECTED);
   nsresult rv = nsContentUtils::CheckSameOrigin(mDocument, aElement);
   if (NS_FAILED(rv)) {
     return rv;
   }
   Updater* updater = mUpdaters;
   Updater** link = &mUpdaters;
   while (updater) {
     if (updater->mElement == aElement) {
 #ifdef DEBUG
       if (PR_LOG_TEST(gCommandLog, PR_LOG_NOTICE)) {
         nsAutoCString eventsC, targetsC, aeventsC, atargetsC;
         eventsC.AssignWithConversion(updater->mEvents);
         targetsC.AssignWithConversion(updater->mTargets);
         CopyUTF16toUTF8(aEvents, aeventsC);
         CopyUTF16toUTF8(aTargets, atargetsC);
         PR_LOG(gCommandLog, PR_LOG_NOTICE,
                ("xulcmd[%p] replace %p(events=%s targets=%s) with (events=%s targets=%s)",
                 this, aElement,
                 eventsC.get(),
                 targetsC.get(),
                 aeventsC.get(),
                 atargetsC.get()));
       }
 #endif
       // If the updater was already in the list, then replace
       // (?) the 'events' and 'targets' filters with the new
       // specification.
       updater->mEvents  = aEvents;
       updater->mTargets = aTargets;
       return NS_OK;
     }
     link = &(updater->mNext);
     updater = updater->mNext;
   }
 #ifdef DEBUG
   if (PR_LOG_TEST(gCommandLog, PR_LOG_NOTICE)) {
     nsAutoCString aeventsC, atargetsC;
     CopyUTF16toUTF8(aEvents, aeventsC);
     CopyUTF16toUTF8(aTargets, atargetsC);
     PR_LOG(gCommandLog, PR_LOG_NOTICE,
            ("xulcmd[%p] add     %p(events=%s targets=%s)",
             this, aElement,
             aeventsC.get(),
             atargetsC.get()));
   }
 #endif
   // If we get here, this is a new updater. Append it to the list.
   updater = new Updater(aElement, aEvents, aTargets);
   if (! updater)
       return NS_ERROR_OUT_OF_MEMORY;
   *link = updater;
   return NS_OK;
 }
 NS_IMETHODIMP
 nsXULCommandDispatcher::RemoveCommandUpdater(nsIDOMElement* aElement)
 {
   NS_PRECONDITION(aElement != nullptr, "null ptr");
   if (! aElement)
     return NS_ERROR_NULL_POINTER;
   Updater* updater = mUpdaters;
   Updater** link = &mUpdaters;
   while (updater) {
     if (updater->mElement == aElement) {
 #ifdef DEBUG
       if (PR_LOG_TEST(gCommandLog, PR_LOG_NOTICE)) {
         nsAutoCString eventsC, targetsC;
         eventsC.AssignWithConversion(updater->mEvents);
         targetsC.AssignWithConversion(updater->mTargets);
         PR_LOG(gCommandLog, PR_LOG_NOTICE,
                ("xulcmd[%p] remove  %p(events=%s targets=%s)",
                 this, aElement,
                 eventsC.get(),
                 targetsC.get()));
       }
 #endif
       *link = updater->mNext;
       delete updater;
       return NS_OK;
     }
     link = &(updater->mNext);
     updater = updater->mNext;
   }
   // Hmm. Not found. Oh well.
   return NS_OK;
 }
 NS_IMETHODIMP
 nsXULCommandDispatcher::UpdateCommands(const nsAString& aEventName)
 {
   nsAutoString id;
   nsCOMPtr<nsIDOMElement> element;
   GetFocusedElement(getter_AddRefs(element));
   if (element) {
     nsresult rv = element->GetAttribute(NS_LITERAL_STRING("id"), id);
     NS_ASSERTION(NS_SUCCEEDED(rv), "unable to get element's id");
     if (NS_FAILED(rv)) return rv;
   }
   nsCOMArray<nsIContent> updaters;
   for (Updater* updater = mUpdaters; updater != nullptr; updater = updater->mNext) {
     // Skip any nodes that don't match our 'events' or 'targets'
     // filters.
     if (! Matches(updater->mEvents, aEventName))
       continue;
     if (! Matches(updater->mTargets, id))
       continue;
     nsCOMPtr<nsIContent> content = do_QueryInterface(updater->mElement);
     NS_ASSERTION(content != nullptr, "not an nsIContent");
     if (! content)
       return NS_ERROR_UNEXPECTED;
     updaters.AppendObject(content);
   }
   for (int32_t u = 0; u < updaters.Count(); u++) {
     nsIContent* content = updaters[u];
     nsCOMPtr<nsIDocument> document = content->GetDocument();
     NS_ASSERTION(document != nullptr, "element has no document");
     if (! document)
       continue;
 #ifdef DEBUG
     if (PR_LOG_TEST(gCommandLog, PR_LOG_NOTICE)) {
       nsAutoCString aeventnameC;
       CopyUTF16toUTF8(aEventName, aeventnameC);
       PR_LOG(gCommandLog, PR_LOG_NOTICE,
              ("xulcmd[%p] update %p event=%s",
               this, content,
               aeventnameC.get()));
     }
 #endif
     nsCOMPtr<nsIPresShell> shell = document->GetShell();
     if (shell) {
       // Retrieve the context in which our DOM event will fire.
       nsRefPtr<nsPresContext> context = shell->GetPresContext();
       // Handle the DOM event
       nsEventStatus status = nsEventStatus_eIgnore;
       WidgetEvent event(true, NS_XUL_COMMAND_UPDATE);
       EventDispatcher::Dispatch(content, context, &event, nullptr, &status);
     }
   }
   return NS_OK;
 }
 bool
 nsXULCommandDispatcher::Matches(const nsString& aList,
                                 const nsAString& aElement)
 {
   if (aList.EqualsLiteral("*"))
     return true; // match _everything_!
   int32_t indx = aList.Find(PromiseFlatString(aElement));
   if (indx == -1)
     return false; // not in the list at all
   // okay, now make sure it's not a substring snafu; e.g., 'ur'
   // found inside of 'blur'.
   if (indx > 0) {
     char16_t ch = aList[indx - 1];
     if (! nsCRT::IsAsciiSpace(ch) && ch != char16_t(','))
       return false;
   }
   if (indx + aElement.Length() < aList.Length()) {
     char16_t ch = aList[indx + aElement.Length()];
     if (! nsCRT::IsAsciiSpace(ch) && ch != char16_t(','))
       return false;
   }
   return true;
 }
 NS_IMETHODIMP
 nsXULCommandDispatcher::GetControllers(nsIControllers** aResult)
 {
   nsCOMPtr<nsPIWindowRoot> root = GetWindowRoot();
   NS_ENSURE_TRUE(root, NS_ERROR_FAILURE);
   return root->GetControllers(aResult);
 }
 NS_IMETHODIMP
 nsXULCommandDispatcher::GetControllerForCommand(const char *aCommand, nsIController** _retval)
 {
   nsCOMPtr<nsPIWindowRoot> root = GetWindowRoot();
   NS_ENSURE_TRUE(root, NS_ERROR_FAILURE);
   return root->GetControllerForCommand(aCommand, _retval);
 }
 NS_IMETHODIMP
 nsXULCommandDispatcher::GetSuppressFocusScroll(bool* aSuppressFocusScroll)
 {
   *aSuppressFocusScroll = false;
   return NS_OK;
 }
 NS_IMETHODIMP
 nsXULCommandDispatcher::SetSuppressFocusScroll(bool aSuppressFocusScroll)
 {
   return NS_OK;
 }

The Tor Browser / annotate

content/xul/document/src/nsXULCommandDispatcher.cpp@6474c204b198 (annotated)

content/xul/document/src/nsXULCommandDispatcher.cpp