kamp
/
RetroZilla
mirror of https://github.com/rn10950/RetroZilla.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
RetroZilla/content/xul/document/src/nsXULCommandDispatcher.cpp

511 lines
15 KiB
C++
Raw Blame History

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=2 sw=2 et tw=80: */
/* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is mozilla.org code.
*
* The Initial Developer of the Original Code is
* Netscape Communications Corporation.
* Portions created by the Initial Developer are Copyright (C) 1998
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
* Original Author: David W. Hyatt (hyatt@netscape.com)
*
* Alternatively, the contents of this file may be used under the terms of
* either of the GNU General Public License Version 2 or later (the "GPL"),
* or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
/*
This file provides the implementation for the XUL Command Dispatcher.
*/
#include "nsIContent.h"
#include "nsIFocusController.h"
#include "nsIControllers.h"
#include "nsIDOMDocument.h"
#include "nsIDOMXULDocument.h"
#include "nsIDOMHTMLDocument.h"
#include "nsIDOMElement.h"
#include "nsIDOMNSHTMLInputElement.h"
#include "nsIDOMNSHTMLTextAreaElement.h"
#include "nsIDOMWindowInternal.h"
#include "nsIDOMXULElement.h"
#include "nsIDocument.h"
#include "nsPresContext.h"
#include "nsIPresShell.h"
#include "nsIScriptGlobalObject.h"
#include "nsPIDOMWindow.h"
#include "nsRDFCID.h"
#include "nsXULCommandDispatcher.h"
#include "prlog.h"
#include "nsIDOMEventTarget.h"
#include "nsGUIEvent.h"
#include "nsContentUtils.h"
#include "nsReadableUtils.h"
#include "nsCRT.h"
#include "nsDOMError.h"
#include "nsIDOMNSDocument.h"
#ifdef PR_LOGGING
static PRLogModuleInfo* gLog;
#endif
////////////////////////////////////////////////////////////////////////
nsXULCommandDispatcher::nsXULCommandDispatcher(nsIDocument* aDocument)
: mFocusController(nsnull), mDocument(aDocument), mUpdaters(nsnull)
{
#ifdef PR_LOGGING
if (! gLog)
gLog = PR_NewLogModule("nsXULCommandDispatcher");
#endif
}
nsXULCommandDispatcher::~nsXULCommandDispatcher()
{
while (mUpdaters) {
Updater* doomed = mUpdaters;
mUpdaters = mUpdaters->mNext;
delete doomed;
}
}
// QueryInterface implementation for nsXULCommandDispatcher
NS_INTERFACE_MAP_BEGIN(nsXULCommandDispatcher)
NS_INTERFACE_MAP_ENTRY(nsIDOMXULCommandDispatcher)
NS_INTERFACE_MAP_ENTRY(nsISupportsWeakReference)
NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, nsIDOMXULCommandDispatcher)
NS_INTERFACE_MAP_ENTRY_CONTENT_CLASSINFO(XULCommandDispatcher)
NS_INTERFACE_MAP_END
NS_IMPL_ADDREF(nsXULCommandDispatcher)
NS_IMPL_RELEASE(nsXULCommandDispatcher)
NS_IMETHODIMP
nsXULCommandDispatcher::Create(nsIDocument* aDoc, nsXULCommandDispatcher** aResult)
{
nsXULCommandDispatcher* dispatcher = new nsXULCommandDispatcher(aDoc);
if (!dispatcher)
return NS_ERROR_OUT_OF_MEMORY;
*aResult = dispatcher;
NS_ADDREF(*aResult);
return NS_OK;
}
void
nsXULCommandDispatcher::EnsureFocusController()
{
if (!mFocusController && mDocument) {
nsCOMPtr<nsPIDOMWindow> win(do_QueryInterface(mDocument->GetScriptGlobalObject()));
// An inelegant way to retrieve this to be sure, but we are
// guaranteed that the focus controller outlives us, so it
// is safe to hold on to it (since we can't die until it has
// died).
mFocusController = win->GetRootFocusController(); // Store as a weak ptr.
}
}
////////////////////////////////////////////////////////////////
// nsIDOMXULTracker Interface
NS_IMETHODIMP
nsXULCommandDispatcher::GetFocusedElement(nsIDOMElement** aElement)
{
EnsureFocusController();
NS_ENSURE_TRUE(mFocusController, NS_ERROR_FAILURE);
nsresult rv = mFocusController->GetFocusedElement(aElement);
NS_ENSURE_SUCCESS(rv, rv);
// Make sure the caller can access the focused element.
if (*aElement && !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)
{
EnsureFocusController();
NS_ENSURE_TRUE(mFocusController, NS_ERROR_FAILURE);
nsCOMPtr<nsIDOMWindowInternal> window;
nsresult rv = mFocusController->GetFocusedWindow(getter_AddRefs(window));
NS_ENSURE_TRUE(NS_SUCCEEDED(rv) && window, rv);
rv = CallQueryInterface(window, aWindow);
NS_ENSURE_SUCCESS(rv, rv);
// Make sure the caller can access this window. The caller can access this
// window iff it can access the document.
nsCOMPtr<nsIDOMDocument> domdoc;
rv = (*aWindow)->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)) {
NS_RELEASE(*aWindow);
return NS_ERROR_DOM_SECURITY_ERR;
}
return NS_OK;
}
NS_IMETHODIMP
nsXULCommandDispatcher::SetFocusedElement(nsIDOMElement* aElement)
{
EnsureFocusController();
NS_ENSURE_TRUE(mFocusController, NS_ERROR_FAILURE);
return mFocusController->SetFocusedElement(aElement);
}
NS_IMETHODIMP
nsXULCommandDispatcher::SetFocusedWindow(nsIDOMWindow* aWindow)
{
EnsureFocusController();
NS_ENSURE_TRUE(mFocusController, NS_ERROR_FAILURE);
nsCOMPtr<nsIDOMWindowInternal> window(do_QueryInterface(aWindow));
return mFocusController->SetFocusedWindow(window);
}
NS_IMETHODIMP
nsXULCommandDispatcher::AdvanceFocus()
{
EnsureFocusController();
if (mFocusController)
return mFocusController->MoveFocus(PR_TRUE, nsnull);
return NS_OK;
}
NS_IMETHODIMP
nsXULCommandDispatcher::RewindFocus()
{
EnsureFocusController();
if (mFocusController)
return mFocusController->MoveFocus(PR_FALSE, nsnull);
return NS_OK;
}
NS_IMETHODIMP
nsXULCommandDispatcher::AdvanceFocusIntoSubtree(nsIDOMElement* aElt)
{
EnsureFocusController();
if (mFocusController)
return mFocusController->MoveFocus(PR_TRUE, aElt);
return NS_OK;
}
NS_IMETHODIMP
nsXULCommandDispatcher::AddCommandUpdater(nsIDOMElement* aElement,
const nsAString& aEvents,
const nsAString& aTargets)
{
NS_PRECONDITION(aElement != nsnull, "null ptr");
if (! aElement)
return NS_ERROR_NULL_POINTER;
NS_ENSURE_STATE(mDocument);
nsCOMPtr<nsIDOMNode> doc(do_QueryInterface(mDocument));
nsresult rv = nsContentUtils::CheckSameOrigin(doc, aElement);
if (NS_FAILED(rv)) {
return rv;
}
nsCOMPtr<nsIDOMDocument> ownerDomDoc;
aElement->GetOwnerDocument(getter_AddRefs(ownerDomDoc));
nsCOMPtr<nsIDOMNSDocument> ownerDoc = do_QueryInterface(ownerDomDoc);
NS_ENSURE_STATE(ownerDoc);
// Box object is used as a weak reference to aElement.
nsCOMPtr<nsIBoxObject> boxObject;
ownerDoc->GetBoxObjectFor(aElement, getter_AddRefs(boxObject));
NS_ENSURE_STATE(boxObject);
Updater* updater = mUpdaters;
Updater** link = &mUpdaters;
while (updater) {
nsCOMPtr<nsIDOMElement> element;
updater->mWeakElement->GetElement(getter_AddRefs(element));
if (element == aElement) {
#ifdef NS_DEBUG
if (PR_LOG_TEST(gLog, PR_LOG_NOTICE)) {
nsCAutoString eventsC, targetsC, aeventsC, atargetsC;
eventsC.AssignWithConversion(updater->mEvents);
targetsC.AssignWithConversion(updater->mTargets);
CopyUTF16toUTF8(aEvents, aeventsC);
CopyUTF16toUTF8(aTargets, atargetsC);
PR_LOG(gLog, 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 NS_DEBUG
if (PR_LOG_TEST(gLog, PR_LOG_NOTICE)) {
nsCAutoString aeventsC, atargetsC;
CopyUTF16toUTF8(aEvents, aeventsC);
CopyUTF16toUTF8(aTargets, atargetsC);
PR_LOG(gLog, 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(boxObject, aEvents, aTargets);
if (! updater)
return NS_ERROR_OUT_OF_MEMORY;
*link = updater;
return NS_OK;
}
NS_IMETHODIMP
nsXULCommandDispatcher::RemoveCommandUpdater(nsIDOMElement* aElement)
{
NS_PRECONDITION(aElement != nsnull, "null ptr");
if (! aElement)
return NS_ERROR_NULL_POINTER;
Updater* updater = mUpdaters;
Updater** link = &mUpdaters;
while (updater) {
nsCOMPtr<nsIDOMElement> element;
updater->mWeakElement->GetElement(getter_AddRefs(element));
if (element == aElement) {
#ifdef NS_DEBUG
if (PR_LOG_TEST(gLog, PR_LOG_NOTICE)) {
nsCAutoString eventsC, targetsC;
eventsC.AssignWithConversion(updater->mEvents);
targetsC.AssignWithConversion(updater->mTargets);
PR_LOG(gLog, 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)
{
EnsureFocusController();
NS_ENSURE_TRUE(mFocusController, NS_ERROR_FAILURE);
nsAutoString id;
nsCOMPtr<nsIDOMElement> element;
mFocusController->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;
}
#if 0
{
char* actionString = ToNewCString(aEventName);
printf("Doing UpdateCommands(\"%s\")\n", actionString);
free(actionString);
}
#endif
nsCOMArray<nsIContent> updaters;
for (Updater* updater = mUpdaters; updater != nsnull; updater = updater->mNext) {
nsCOMPtr<nsIDOMElement> element;
updater->mWeakElement->GetElement(getter_AddRefs(element));
if (!element)
continue;
// 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(element);
NS_ASSERTION(content != nsnull, "not an nsIContent");
if (! content)
return NS_ERROR_UNEXPECTED;
updaters.AppendObject(content);
}
for (PRUint32 u = 0; u < updaters.Count(); u++) {
nsIContent* content = updaters[u];
nsCOMPtr<nsIDocument> document = content->GetDocument();
NS_ASSERTION(document != nsnull, "element has no document");
if (! document)
continue;
#ifdef NS_DEBUG
if (PR_LOG_TEST(gLog, PR_LOG_NOTICE)) {
nsCAutoString aeventnameC;
CopyUTF16toUTF8(aEventName, aeventnameC);
PR_LOG(gLog, PR_LOG_NOTICE,
("xulcmd[%p] update %p event=%s",
this, content,
aeventnameC.get()));
}
#endif
PRUint32 count = document->GetNumberOfShells();
for (PRUint32 i = 0; i < count; i++) {
nsIPresShell *shell = document->GetShellAt(i);
// Retrieve the context in which our DOM event will fire.
nsCOMPtr<nsPresContext> context = shell->GetPresContext();
// Handle the DOM event
nsEventStatus status = nsEventStatus_eIgnore;
nsEvent event(PR_TRUE, NS_XUL_COMMAND_UPDATE);
content->HandleDOMEvent(context, &event, nsnull, NS_EVENT_FLAG_INIT, &status);
}
}
return NS_OK;
}
PRBool
nsXULCommandDispatcher::Matches(const nsString& aList,
const nsAString& aElement)
{
if (aList.EqualsLiteral("*"))
return PR_TRUE; // match _everything_!
PRInt32 indx = aList.Find(PromiseFlatString(aElement));
if (indx == -1)
return PR_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) {
PRUnichar ch = aList[indx - 1];
if (! nsCRT::IsAsciiSpace(ch) && ch != PRUnichar(','))
return PR_FALSE;
}
if (indx + aElement.Length() < aList.Length()) {
PRUnichar ch = aList[indx + aElement.Length()];
if (! nsCRT::IsAsciiSpace(ch) && ch != PRUnichar(','))
return PR_FALSE;
}
return PR_TRUE;
}
NS_IMETHODIMP
nsXULCommandDispatcher::GetControllers(nsIControllers** aResult)
{
EnsureFocusController();
NS_ENSURE_TRUE(mFocusController, NS_ERROR_FAILURE);
return mFocusController->GetControllers(aResult);
}
NS_IMETHODIMP
nsXULCommandDispatcher::GetControllerForCommand(const char *aCommand, nsIController** _retval)
{
EnsureFocusController();
NS_ENSURE_TRUE(mFocusController, NS_ERROR_FAILURE);
return mFocusController->GetControllerForCommand(aCommand, _retval);
}
NS_IMETHODIMP
nsXULCommandDispatcher::GetSuppressFocusScroll(PRBool* aSuppressFocusScroll)
{
EnsureFocusController();
NS_ENSURE_TRUE(mFocusController, NS_ERROR_FAILURE);
return mFocusController->GetSuppressFocusScroll(aSuppressFocusScroll);
}
NS_IMETHODIMP
nsXULCommandDispatcher::SetSuppressFocusScroll(PRBool aSuppressFocusScroll)
{
EnsureFocusController();
NS_ENSURE_TRUE(mFocusController, NS_ERROR_FAILURE);
return mFocusController->SetSuppressFocusScroll(aSuppressFocusScroll);
}
Reference in New Issue View Git Blame Copy Permalink