/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */ /* vim: set ts=8 sts=2 et sw=2 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/. */ #include "nsGlobalWindowCommands.h" #include "nsIComponentManager.h" #include "nsIInterfaceRequestor.h" #include "nsIInterfaceRequestorUtils.h" #include "nsCRT.h" #include "nsString.h" #include "mozilla/ArrayUtils.h" #include "mozilla/Preferences.h" #include "nsIControllerCommandTable.h" #include "nsICommandParams.h" #include "nsPIDOMWindow.h" #include "nsIPresShell.h" #include "nsIDocShell.h" #include "nsISelectionController.h" #include "nsIWebNavigation.h" #include "nsIContentViewerEdit.h" #include "nsIContentViewer.h" #include "nsFocusManager.h" #include "nsCopySupport.h" #include "nsIClipboard.h" #include "ContentEventHandler.h" #include "nsContentUtils.h" #include "mozilla/Attributes.h" #include "mozilla/BasicEvents.h" #include "mozilla/TextEvents.h" #include "mozilla/dom/Selection.h" #include "mozilla/layers/KeyboardMap.h" using namespace mozilla; using namespace mozilla::layers; constexpr const char * sSelectAllString = "cmd_selectAll"; constexpr const char * sSelectNoneString = "cmd_selectNone"; constexpr const char * sCopyImageLocationString = "cmd_copyImageLocation"; constexpr const char * sCopyImageContentsString = "cmd_copyImageContents"; constexpr const char * sCopyImageString = "cmd_copyImage"; constexpr const char * sScrollTopString = "cmd_scrollTop"; constexpr const char * sScrollBottomString = "cmd_scrollBottom"; constexpr const char * sScrollPageUpString = "cmd_scrollPageUp"; constexpr const char * sScrollPageDownString = "cmd_scrollPageDown"; constexpr const char * sScrollLineUpString = "cmd_scrollLineUp"; constexpr const char * sScrollLineDownString = "cmd_scrollLineDown"; constexpr const char * sScrollLeftString = "cmd_scrollLeft"; constexpr const char * sScrollRightString = "cmd_scrollRight"; constexpr const char * sMoveTopString = "cmd_moveTop"; constexpr const char * sMoveBottomString = "cmd_moveBottom"; constexpr const char * sMovePageUpString = "cmd_movePageUp"; constexpr const char * sMovePageDownString = "cmd_movePageDown"; constexpr const char * sLinePreviousString = "cmd_linePrevious"; constexpr const char * sLineNextString = "cmd_lineNext"; constexpr const char * sCharPreviousString = "cmd_charPrevious"; constexpr const char * sCharNextString = "cmd_charNext"; // These are so the browser can use editor navigation key bindings // helps with accessibility (boolean pref accessibility.browsewithcaret) constexpr const char * sSelectCharPreviousString = "cmd_selectCharPrevious"; constexpr const char * sSelectCharNextString = "cmd_selectCharNext"; constexpr const char * sWordPreviousString = "cmd_wordPrevious"; constexpr const char * sWordNextString = "cmd_wordNext"; constexpr const char * sSelectWordPreviousString = "cmd_selectWordPrevious"; constexpr const char * sSelectWordNextString = "cmd_selectWordNext"; constexpr const char * sBeginLineString = "cmd_beginLine"; constexpr const char * sEndLineString = "cmd_endLine"; constexpr const char * sSelectBeginLineString = "cmd_selectBeginLine"; constexpr const char * sSelectEndLineString = "cmd_selectEndLine"; constexpr const char * sSelectLinePreviousString = "cmd_selectLinePrevious"; constexpr const char * sSelectLineNextString = "cmd_selectLineNext"; constexpr const char * sSelectPageUpString = "cmd_selectPageUp"; constexpr const char * sSelectPageDownString = "cmd_selectPageDown"; constexpr const char * sSelectTopString = "cmd_selectTop"; constexpr const char * sSelectBottomString = "cmd_selectBottom"; // Physical-direction movement and selection commands constexpr const char * sMoveLeftString = "cmd_moveLeft"; constexpr const char * sMoveRightString = "cmd_moveRight"; constexpr const char * sMoveUpString = "cmd_moveUp"; constexpr const char * sMoveDownString = "cmd_moveDown"; constexpr const char * sMoveLeft2String = "cmd_moveLeft2"; constexpr const char * sMoveRight2String = "cmd_moveRight2"; constexpr const char * sMoveUp2String = "cmd_moveUp2"; constexpr const char * sMoveDown2String = "cmd_moveDown2"; constexpr const char * sSelectLeftString = "cmd_selectLeft"; constexpr const char * sSelectRightString = "cmd_selectRight"; constexpr const char * sSelectUpString = "cmd_selectUp"; constexpr const char * sSelectDownString = "cmd_selectDown"; constexpr const char * sSelectLeft2String = "cmd_selectLeft2"; constexpr const char * sSelectRight2String = "cmd_selectRight2"; constexpr const char * sSelectUp2String = "cmd_selectUp2"; constexpr const char * sSelectDown2String = "cmd_selectDown2"; #if 0 #pragma mark - #endif // a base class for selection-related commands, for code sharing class nsSelectionCommandsBase : public nsIControllerCommand { public: NS_DECL_ISUPPORTS NS_IMETHOD IsCommandEnabled(const char* aCommandName, nsISupports* aCommandContext, bool* _retval) override; NS_IMETHOD GetCommandStateParams(const char* aCommandName, nsICommandParams* aParams, nsISupports* aCommandContext) override; NS_IMETHOD DoCommandParams(const char* aCommandName, nsICommandParams* aParams, nsISupports* aCommandContext) override; protected: virtual ~nsSelectionCommandsBase() {} static nsresult GetPresShellFromWindow(nsPIDOMWindowOuter *aWindow, nsIPresShell **aPresShell); static nsresult GetSelectionControllerFromWindow(nsPIDOMWindowOuter *aWindow, nsISelectionController **aSelCon); // no member variables, please, we're stateless! }; // this class implements commands whose behavior depends on the 'browse with caret' setting class nsSelectMoveScrollCommand : public nsSelectionCommandsBase { public: NS_IMETHOD DoCommand(const char * aCommandName, nsISupports *aCommandContext) override; // no member variables, please, we're stateless! }; // this class implements physical-movement versions of the above class nsPhysicalSelectMoveScrollCommand : public nsSelectionCommandsBase { public: NS_IMETHOD DoCommand(const char * aCommandName, nsISupports *aCommandContext) override; // no member variables, please, we're stateless! }; // this class implements other selection commands class nsSelectCommand : public nsSelectionCommandsBase { public: NS_IMETHOD DoCommand(const char * aCommandName, nsISupports *aCommandContext) override; // no member variables, please, we're stateless! }; // this class implements physical-movement versions of selection commands class nsPhysicalSelectCommand : public nsSelectionCommandsBase { public: NS_IMETHOD DoCommand(const char * aCommandName, nsISupports *aCommandContext) override; // no member variables, please, we're stateless! }; #if 0 #pragma mark - #endif NS_IMPL_ISUPPORTS(nsSelectionCommandsBase, nsIControllerCommand) NS_IMETHODIMP nsSelectionCommandsBase::IsCommandEnabled(const char * aCommandName, nsISupports *aCommandContext, bool *outCmdEnabled) { // XXX this needs fixing. e.g. you can't scroll up if you're already at the top of // the document. *outCmdEnabled = true; return NS_OK; } NS_IMETHODIMP nsSelectionCommandsBase::GetCommandStateParams(const char *aCommandName, nsICommandParams *aParams, nsISupports *aCommandContext) { // XXX we should probably return the enabled state return NS_ERROR_NOT_IMPLEMENTED; } NS_IMETHODIMP nsSelectionCommandsBase::DoCommandParams(const char *aCommandName, nsICommandParams *aParams, nsISupports *aCommandContext) { return DoCommand(aCommandName, aCommandContext); } // protected methods nsresult nsSelectionCommandsBase::GetPresShellFromWindow(nsPIDOMWindowOuter *aWindow, nsIPresShell **aPresShell) { *aPresShell = nullptr; NS_ENSURE_TRUE(aWindow, NS_ERROR_FAILURE); nsIDocShell *docShell = aWindow->GetDocShell(); NS_ENSURE_TRUE(docShell, NS_ERROR_FAILURE); NS_IF_ADDREF(*aPresShell = docShell->GetPresShell()); return NS_OK; } nsresult nsSelectionCommandsBase::GetSelectionControllerFromWindow(nsPIDOMWindowOuter *aWindow, nsISelectionController **aSelCon) { *aSelCon = nullptr; nsCOMPtr presShell; GetPresShellFromWindow(aWindow, getter_AddRefs(presShell)); if (presShell) return CallQueryInterface(presShell, aSelCon); return NS_ERROR_FAILURE; } #if 0 #pragma mark - #endif // Helpers for nsSelectMoveScrollCommand and nsPhysicalSelectMoveScrollCommand static void AdjustFocusAfterCaretMove(nsPIDOMWindowOuter* aWindow) { // adjust the focus to the new caret position nsIFocusManager* fm = nsFocusManager::GetFocusManager(); if (fm) { RefPtr result; fm->MoveFocus(aWindow, nullptr, nsIFocusManager::MOVEFOCUS_CARET, nsIFocusManager::FLAG_NOSCROLL, getter_AddRefs(result)); } } static bool IsCaretOnInWindow(nsPIDOMWindowOuter* aWindow, nsISelectionController* aSelCont) { // We allow the caret to be moved with arrow keys on any window for which // the caret is enabled. In particular, this includes caret-browsing mode // in non-chrome documents. bool caretOn = false; aSelCont->GetCaretEnabled(&caretOn); if (!caretOn) { caretOn = Preferences::GetBool("accessibility.browsewithcaret"); if (caretOn) { nsCOMPtr docShell = aWindow->GetDocShell(); if (docShell && docShell->ItemType() == nsIDocShellTreeItem::typeChrome) { caretOn = false; } } } return caretOn; } static constexpr struct BrowseCommand { const char *reverse, *forward; KeyboardScrollAction::KeyboardScrollActionType scrollAction; nsresult (NS_STDCALL nsISelectionController::*scroll)(bool); nsresult (NS_STDCALL nsISelectionController::*move)(bool, bool); } browseCommands[] = { { sScrollTopString, sScrollBottomString, KeyboardScrollAction::eScrollComplete, &nsISelectionController::CompleteScroll }, { sScrollPageUpString, sScrollPageDownString, KeyboardScrollAction::eScrollPage, &nsISelectionController::ScrollPage }, { sScrollLineUpString, sScrollLineDownString, KeyboardScrollAction::eScrollLine, &nsISelectionController::ScrollLine }, { sScrollLeftString, sScrollRightString, KeyboardScrollAction::eScrollCharacter, &nsISelectionController::ScrollCharacter }, { sMoveTopString, sMoveBottomString, KeyboardScrollAction::eScrollComplete, &nsISelectionController::CompleteScroll, &nsISelectionController::CompleteMove }, { sMovePageUpString, sMovePageDownString, KeyboardScrollAction::eScrollPage, &nsISelectionController::ScrollPage, &nsISelectionController::PageMove }, { sLinePreviousString, sLineNextString, KeyboardScrollAction::eScrollLine, &nsISelectionController::ScrollLine, &nsISelectionController::LineMove }, { sWordPreviousString, sWordNextString, KeyboardScrollAction::eScrollCharacter, &nsISelectionController::ScrollCharacter, &nsISelectionController::WordMove }, { sCharPreviousString, sCharNextString, KeyboardScrollAction::eScrollCharacter, &nsISelectionController::ScrollCharacter, &nsISelectionController::CharacterMove }, { sBeginLineString, sEndLineString, KeyboardScrollAction::eScrollComplete, &nsISelectionController::CompleteScroll, &nsISelectionController::IntraLineMove } }; nsresult nsSelectMoveScrollCommand::DoCommand(const char *aCommandName, nsISupports *aCommandContext) { nsCOMPtr piWindow(do_QueryInterface(aCommandContext)); nsCOMPtr selCont; GetSelectionControllerFromWindow(piWindow, getter_AddRefs(selCont)); NS_ENSURE_TRUE(selCont, NS_ERROR_NOT_INITIALIZED); bool caretOn = IsCaretOnInWindow(piWindow, selCont); for (size_t i = 0; i < ArrayLength(browseCommands); i++) { bool forward = !strcmp(aCommandName, browseCommands[i].forward); if (forward || !strcmp(aCommandName, browseCommands[i].reverse)) { if (caretOn && browseCommands[i].move && NS_SUCCEEDED((selCont->*(browseCommands[i].move))(forward, false))) { AdjustFocusAfterCaretMove(piWindow); return NS_OK; } return (selCont->*(browseCommands[i].scroll))(forward); } } return NS_ERROR_NOT_IMPLEMENTED; } // XXX It's not clear to me yet how we should handle the "scroll" option // for these commands; for now, I'm mapping them back to ScrollCharacter, // ScrollLine, etc., as if for horizontal-mode content, but this may need // to be reconsidered once we have more experience with vertical content. static const struct PhysicalBrowseCommand { const char *command; int16_t direction, amount; KeyboardScrollAction::KeyboardScrollActionType scrollAction; nsresult (NS_STDCALL nsISelectionController::*scroll)(bool); } physicalBrowseCommands[] = { { sMoveLeftString, nsISelectionController::MOVE_LEFT, 0, KeyboardScrollAction::eScrollCharacter, &nsISelectionController::ScrollCharacter }, { sMoveRightString, nsISelectionController::MOVE_RIGHT, 0, KeyboardScrollAction::eScrollCharacter, &nsISelectionController::ScrollCharacter }, { sMoveUpString, nsISelectionController::MOVE_UP, 0, KeyboardScrollAction::eScrollLine, &nsISelectionController::ScrollLine }, { sMoveDownString, nsISelectionController::MOVE_DOWN, 0, KeyboardScrollAction::eScrollLine, &nsISelectionController::ScrollLine }, { sMoveLeft2String, nsISelectionController::MOVE_LEFT, 1, KeyboardScrollAction::eScrollCharacter, &nsISelectionController::ScrollCharacter }, { sMoveRight2String, nsISelectionController::MOVE_RIGHT, 1, KeyboardScrollAction::eScrollCharacter, &nsISelectionController::ScrollCharacter }, { sMoveUp2String, nsISelectionController::MOVE_UP, 1, KeyboardScrollAction::eScrollComplete, &nsISelectionController::CompleteScroll }, { sMoveDown2String, nsISelectionController::MOVE_DOWN, 1, KeyboardScrollAction::eScrollComplete, &nsISelectionController::CompleteScroll }, }; nsresult nsPhysicalSelectMoveScrollCommand::DoCommand(const char *aCommandName, nsISupports *aCommandContext) { nsCOMPtr piWindow(do_QueryInterface(aCommandContext)); nsCOMPtr selCont; GetSelectionControllerFromWindow(piWindow, getter_AddRefs(selCont)); NS_ENSURE_TRUE(selCont, NS_ERROR_NOT_INITIALIZED); bool caretOn = IsCaretOnInWindow(piWindow, selCont); for (size_t i = 0; i < ArrayLength(physicalBrowseCommands); i++) { const PhysicalBrowseCommand& cmd = physicalBrowseCommands[i]; if (!strcmp(aCommandName, cmd.command)) { int16_t dir = cmd.direction; if (caretOn && NS_SUCCEEDED(selCont->PhysicalMove(dir, cmd.amount, false))) { AdjustFocusAfterCaretMove(piWindow); return NS_OK; } bool forward = (dir == nsISelectionController::MOVE_RIGHT || dir == nsISelectionController::MOVE_DOWN); return (selCont->*(cmd.scroll))(forward); } } return NS_ERROR_NOT_IMPLEMENTED; } #if 0 #pragma mark - #endif static const struct SelectCommand { const char *reverse, *forward; nsresult (NS_STDCALL nsISelectionController::*select)(bool, bool); } selectCommands[] = { { sSelectCharPreviousString, sSelectCharNextString, &nsISelectionController::CharacterMove }, { sSelectWordPreviousString, sSelectWordNextString, &nsISelectionController::WordMove }, { sSelectBeginLineString, sSelectEndLineString, &nsISelectionController::IntraLineMove }, { sSelectLinePreviousString, sSelectLineNextString, &nsISelectionController::LineMove }, { sSelectPageUpString, sSelectPageDownString, &nsISelectionController::PageMove }, { sSelectTopString, sSelectBottomString, &nsISelectionController::CompleteMove } }; nsresult nsSelectCommand::DoCommand(const char *aCommandName, nsISupports *aCommandContext) { nsCOMPtr piWindow(do_QueryInterface(aCommandContext)); nsCOMPtr selCont; GetSelectionControllerFromWindow(piWindow, getter_AddRefs(selCont)); NS_ENSURE_TRUE(selCont, NS_ERROR_NOT_INITIALIZED); // These commands are so the browser can use caret navigation key bindings - // Helps with accessibility - aaronl@netscape.com for (size_t i = 0; i < ArrayLength(selectCommands); i++) { bool forward = !strcmp(aCommandName, selectCommands[i].forward); if (forward || !strcmp(aCommandName, selectCommands[i].reverse)) { return (selCont->*(selectCommands[i].select))(forward, true); } } return NS_ERROR_NOT_IMPLEMENTED; } #if 0 #pragma mark - #endif static const struct PhysicalSelectCommand { const char *command; int16_t direction, amount; } physicalSelectCommands[] = { { sSelectLeftString, nsISelectionController::MOVE_LEFT, 0 }, { sSelectRightString, nsISelectionController::MOVE_RIGHT, 0 }, { sSelectUpString, nsISelectionController::MOVE_UP, 0 }, { sSelectDownString, nsISelectionController::MOVE_DOWN, 0 }, { sSelectLeft2String, nsISelectionController::MOVE_LEFT, 1 }, { sSelectRight2String, nsISelectionController::MOVE_RIGHT, 1 }, { sSelectUp2String, nsISelectionController::MOVE_UP, 1 }, { sSelectDown2String, nsISelectionController::MOVE_DOWN, 1 } }; nsresult nsPhysicalSelectCommand::DoCommand(const char *aCommandName, nsISupports *aCommandContext) { nsCOMPtr piWindow(do_QueryInterface(aCommandContext)); nsCOMPtr selCont; GetSelectionControllerFromWindow(piWindow, getter_AddRefs(selCont)); NS_ENSURE_TRUE(selCont, NS_ERROR_NOT_INITIALIZED); for (size_t i = 0; i < ArrayLength(physicalSelectCommands); i++) { if (!strcmp(aCommandName, physicalSelectCommands[i].command)) { return selCont->PhysicalMove(physicalSelectCommands[i].direction, physicalSelectCommands[i].amount, true); } } return NS_ERROR_NOT_IMPLEMENTED; } #if 0 #pragma mark - #endif class nsClipboardCommand final : public nsIControllerCommand { ~nsClipboardCommand() {} public: NS_DECL_ISUPPORTS NS_DECL_NSICONTROLLERCOMMAND }; NS_IMPL_ISUPPORTS(nsClipboardCommand, nsIControllerCommand) nsresult nsClipboardCommand::IsCommandEnabled(const char* aCommandName, nsISupports *aContext, bool *outCmdEnabled) { NS_ENSURE_ARG_POINTER(outCmdEnabled); *outCmdEnabled = false; if (strcmp(aCommandName, "cmd_copy") && strcmp(aCommandName, "cmd_copyAndCollapseToEnd") && strcmp(aCommandName, "cmd_cut") && strcmp(aCommandName, "cmd_paste")) return NS_OK; nsCOMPtr window = do_QueryInterface(aContext); NS_ENSURE_TRUE(window, NS_ERROR_FAILURE); nsCOMPtr doc = window->GetExtantDoc(); if (doc->IsHTMLOrXHTML()) { // In HTML and XHTML documents, we always want the cut, copy and paste // commands to be enabled. *outCmdEnabled = true; } else { // Cut isn't enabled in xul documents which use nsClipboardCommand if (strcmp(aCommandName, "cmd_copy") == 0 || strcmp(aCommandName, "cmd_copyAndCollapseToEnd") == 0) { *outCmdEnabled = nsCopySupport::CanCopy(doc); } } return NS_OK; } nsresult nsClipboardCommand::DoCommand(const char *aCommandName, nsISupports *aContext) { if (strcmp(aCommandName, "cmd_cut") && strcmp(aCommandName, "cmd_copy") && strcmp(aCommandName, "cmd_copyAndCollapseToEnd") && strcmp(aCommandName, "cmd_paste")) return NS_OK; nsCOMPtr window = do_QueryInterface(aContext); NS_ENSURE_TRUE(window, NS_ERROR_FAILURE); nsIDocShell *docShell = window->GetDocShell(); NS_ENSURE_TRUE(docShell, NS_ERROR_FAILURE); nsCOMPtr presShell = docShell->GetPresShell(); NS_ENSURE_TRUE(presShell, NS_ERROR_FAILURE); EventMessage eventMessage = eCopy; if (strcmp(aCommandName, "cmd_cut") == 0) { eventMessage = eCut; } else if (strcmp(aCommandName, "cmd_paste") == 0) { eventMessage = ePaste; } bool actionTaken = false; bool notCancelled = nsCopySupport::FireClipboardEvent(eventMessage, nsIClipboard::kGlobalClipboard, presShell, nullptr, &actionTaken); if (notCancelled && !strcmp(aCommandName, "cmd_copyAndCollapseToEnd")) { dom::Selection *sel = presShell->GetCurrentSelection(SelectionType::eNormal); NS_ENSURE_TRUE(sel, NS_ERROR_FAILURE); sel->CollapseToEnd(IgnoreErrors()); } return actionTaken ? NS_OK : NS_SUCCESS_DOM_NO_OPERATION; } NS_IMETHODIMP nsClipboardCommand::GetCommandStateParams(const char *aCommandName, nsICommandParams *aParams, nsISupports *aCommandContext) { return NS_ERROR_NOT_IMPLEMENTED; } nsresult nsClipboardCommand::DoCommandParams(const char *aCommandName, nsICommandParams* aParams, nsISupports *aContext) { return DoCommand(aCommandName, aContext); } #if 0 #pragma mark - #endif class nsSelectionCommand : public nsIControllerCommand { public: NS_DECL_ISUPPORTS NS_DECL_NSICONTROLLERCOMMAND protected: virtual ~nsSelectionCommand() {} virtual nsresult IsClipboardCommandEnabled(const char * aCommandName, nsIContentViewerEdit* aEdit, bool *outCmdEnabled) = 0; virtual nsresult DoClipboardCommand(const char *aCommandName, nsIContentViewerEdit* aEdit, nsICommandParams* aParams) = 0; static nsresult GetContentViewerEditFromContext(nsISupports *aContext, nsIContentViewerEdit **aEditInterface); // no member variables, please, we're stateless! }; NS_IMPL_ISUPPORTS(nsSelectionCommand, nsIControllerCommand) /*--------------------------------------------------------------------------- nsSelectionCommand ----------------------------------------------------------------------------*/ NS_IMETHODIMP nsSelectionCommand::IsCommandEnabled(const char * aCommandName, nsISupports *aCommandContext, bool *outCmdEnabled) { NS_ENSURE_ARG_POINTER(outCmdEnabled); *outCmdEnabled = false; nsCOMPtr contentEdit; GetContentViewerEditFromContext(aCommandContext, getter_AddRefs(contentEdit)); NS_ENSURE_TRUE(contentEdit, NS_ERROR_NOT_INITIALIZED); return IsClipboardCommandEnabled(aCommandName, contentEdit, outCmdEnabled); } NS_IMETHODIMP nsSelectionCommand::DoCommand(const char *aCommandName, nsISupports *aCommandContext) { nsCOMPtr contentEdit; GetContentViewerEditFromContext(aCommandContext, getter_AddRefs(contentEdit)); NS_ENSURE_TRUE(contentEdit, NS_ERROR_NOT_INITIALIZED); return DoClipboardCommand(aCommandName, contentEdit, nullptr); } NS_IMETHODIMP nsSelectionCommand::GetCommandStateParams(const char *aCommandName, nsICommandParams *aParams, nsISupports *aCommandContext) { return NS_ERROR_NOT_IMPLEMENTED; } NS_IMETHODIMP nsSelectionCommand::DoCommandParams(const char *aCommandName, nsICommandParams *aParams, nsISupports *aCommandContext) { nsCOMPtr contentEdit; GetContentViewerEditFromContext(aCommandContext, getter_AddRefs(contentEdit)); NS_ENSURE_TRUE(contentEdit, NS_ERROR_NOT_INITIALIZED); return DoClipboardCommand(aCommandName, contentEdit, aParams); } nsresult nsSelectionCommand::GetContentViewerEditFromContext(nsISupports *aContext, nsIContentViewerEdit **aEditInterface) { NS_ENSURE_ARG(aEditInterface); *aEditInterface = nullptr; nsCOMPtr window = do_QueryInterface(aContext); NS_ENSURE_TRUE(window, NS_ERROR_INVALID_ARG); nsIDocShell *docShell = window->GetDocShell(); NS_ENSURE_TRUE(docShell, NS_ERROR_FAILURE); nsCOMPtr viewer; docShell->GetContentViewer(getter_AddRefs(viewer)); nsCOMPtr edit(do_QueryInterface(viewer)); NS_ENSURE_TRUE(edit, NS_ERROR_FAILURE); edit.forget(aEditInterface); return NS_OK; } #if 0 #pragma mark - #endif #define NS_DECL_CLIPBOARD_COMMAND(_cmd) \ class _cmd : public nsSelectionCommand \ { \ protected: \ \ virtual nsresult IsClipboardCommandEnabled(const char* aCommandName, \ nsIContentViewerEdit* aEdit, \ bool *outCmdEnabled) override; \ virtual nsresult DoClipboardCommand(const char* aCommandName, \ nsIContentViewerEdit* aEdit, \ nsICommandParams* aParams) override; \ /* no member variables, please, we're stateless! */ \ }; NS_DECL_CLIPBOARD_COMMAND(nsClipboardCopyLinkCommand) NS_DECL_CLIPBOARD_COMMAND(nsClipboardImageCommands) NS_DECL_CLIPBOARD_COMMAND(nsClipboardSelectAllNoneCommands) NS_DECL_CLIPBOARD_COMMAND(nsClipboardGetContentsCommand) nsresult nsClipboardCopyLinkCommand::IsClipboardCommandEnabled(const char* aCommandName, nsIContentViewerEdit* aEdit, bool *outCmdEnabled) { return aEdit->GetInLink(outCmdEnabled); } nsresult nsClipboardCopyLinkCommand::DoClipboardCommand(const char *aCommandName, nsIContentViewerEdit* aEdit, nsICommandParams* aParams) { return aEdit->CopyLinkLocation(); } #if 0 #pragma mark - #endif nsresult nsClipboardImageCommands::IsClipboardCommandEnabled(const char* aCommandName, nsIContentViewerEdit* aEdit, bool *outCmdEnabled) { return aEdit->GetInImage(outCmdEnabled); } nsresult nsClipboardImageCommands::DoClipboardCommand(const char *aCommandName, nsIContentViewerEdit* aEdit, nsICommandParams* aParams) { if (!nsCRT::strcmp(sCopyImageLocationString, aCommandName)) return aEdit->CopyImage(nsIContentViewerEdit::COPY_IMAGE_TEXT); if (!nsCRT::strcmp(sCopyImageContentsString, aCommandName)) return aEdit->CopyImage(nsIContentViewerEdit::COPY_IMAGE_DATA); int32_t copyFlags = nsIContentViewerEdit::COPY_IMAGE_DATA | nsIContentViewerEdit::COPY_IMAGE_HTML; if (aParams) aParams->GetLongValue("imageCopy", ©Flags); return aEdit->CopyImage(copyFlags); } #if 0 #pragma mark - #endif nsresult nsClipboardSelectAllNoneCommands::IsClipboardCommandEnabled(const char* aCommandName, nsIContentViewerEdit* aEdit, bool *outCmdEnabled) { *outCmdEnabled = true; return NS_OK; } nsresult nsClipboardSelectAllNoneCommands::DoClipboardCommand(const char *aCommandName, nsIContentViewerEdit* aEdit, nsICommandParams* aParams) { if (!nsCRT::strcmp(sSelectAllString, aCommandName)) return aEdit->SelectAll(); return aEdit->ClearSelection(); } #if 0 #pragma mark - #endif nsresult nsClipboardGetContentsCommand::IsClipboardCommandEnabled(const char* aCommandName, nsIContentViewerEdit* aEdit, bool *outCmdEnabled) { return aEdit->GetCanGetContents(outCmdEnabled); } nsresult nsClipboardGetContentsCommand::DoClipboardCommand(const char *aCommandName, nsIContentViewerEdit* aEdit, nsICommandParams* aParams) { NS_ENSURE_ARG(aParams); nsAutoCString mimeType("text/plain"); nsCString format; // nsICommandParams needs to use nsACString if (NS_SUCCEEDED(aParams->GetCStringValue("format", getter_Copies(format)))) mimeType.Assign(format); bool selectionOnly = false; aParams->GetBooleanValue("selection_only", &selectionOnly); nsAutoString contents; nsresult rv = aEdit->GetContents(mimeType.get(), selectionOnly, contents); if (NS_FAILED(rv)) return rv; return aParams->SetStringValue("result", contents); } #if 0 // Remove unless needed again, bug 204777 class nsWebNavigationBaseCommand : public nsIControllerCommand { public: virtual ~nsWebNavigationBaseCommand() {} NS_DECL_ISUPPORTS NS_DECL_NSICONTROLLERCOMMAND protected: virtual nsresult IsWebNavCommandEnabled(const char * aCommandName, nsIWebNavigation* aWebNavigation, bool *outCmdEnabled) = 0; virtual nsresult DoWebNavCommand(const char *aCommandName, nsIWebNavigation* aWebNavigation) = 0; static nsresult GetWebNavigationFromContext(nsISupports *aContext, nsIWebNavigation **aWebNavigation); // no member variables, please, we're stateless! }; class nsGoForwardCommand : public nsWebNavigationBaseCommand { protected: virtual nsresult IsWebNavCommandEnabled(const char * aCommandName, nsIWebNavigation* aWebNavigation, bool *outCmdEnabled); virtual nsresult DoWebNavCommand(const char *aCommandName, nsIWebNavigation* aWebNavigation); // no member variables, please, we're stateless! }; class nsGoBackCommand : public nsWebNavigationBaseCommand { protected: virtual nsresult IsWebNavCommandEnabled(const char * aCommandName, nsIWebNavigation* aWebNavigation, bool *outCmdEnabled); virtual nsresult DoWebNavCommand(const char *aCommandName, nsIWebNavigation* aWebNavigation); // no member variables, please, we're stateless! }; /*--------------------------------------------------------------------------- nsWebNavigationCommands no params ----------------------------------------------------------------------------*/ NS_IMPL_ISUPPORTS(nsWebNavigationBaseCommand, nsIControllerCommand) NS_IMETHODIMP nsWebNavigationBaseCommand::IsCommandEnabled(const char * aCommandName, nsISupports *aCommandContext, bool *outCmdEnabled) { NS_ENSURE_ARG_POINTER(outCmdEnabled); *outCmdEnabled = false; nsCOMPtr webNav; GetWebNavigationFromContext(aCommandContext, getter_AddRefs(webNav)); NS_ENSURE_TRUE(webNav, NS_ERROR_INVALID_ARG); return IsCommandEnabled(aCommandName, webNav, outCmdEnabled); } NS_IMETHODIMP nsWebNavigationBaseCommand::GetCommandStateParams(const char *aCommandName, nsICommandParams *aParams, nsISupports *aCommandContext) { // XXX we should probably return the enabled state return NS_ERROR_NOT_IMPLEMENTED; } NS_IMETHODIMP nsWebNavigationBaseCommand::DoCommand(const char *aCommandName, nsISupports *aCommandContext) { nsCOMPtr webNav; GetWebNavigationFromContext(aCommandContext, getter_AddRefs(webNav)); NS_ENSURE_TRUE(webNav, NS_ERROR_INVALID_ARG); return DoWebNavCommand(aCommandName, webNav); } NS_IMETHODIMP nsWebNavigationBaseCommand::DoCommandParams(const char *aCommandName, nsICommandParams *aParams, nsISupports *aCommandContext) { return DoCommand(aCommandName, aCommandContext); } nsresult nsWebNavigationBaseCommand::GetWebNavigationFromContext(nsISupports *aContext, nsIWebNavigation **aWebNavigation) { nsCOMPtr windowReq = do_QueryInterface(aContext); CallGetInterface(windowReq.get(), aWebNavigation); return (*aWebNavigation) ? NS_OK : NS_ERROR_FAILURE; } nsresult nsGoForwardCommand::IsWebNavCommandEnabled(const char * aCommandName, nsIWebNavigation* aWebNavigation, bool *outCmdEnabled) { return aWebNavigation->GetCanGoForward(outCmdEnabled); } nsresult nsGoForwardCommand::DoWebNavCommand(const char *aCommandName, nsIWebNavigation* aWebNavigation) { return aWebNavigation->GoForward(); } nsresult nsGoBackCommand::IsWebNavCommandEnabled(const char * aCommandName, nsIWebNavigation* aWebNavigation, bool *outCmdEnabled) { return aWebNavigation->GetCanGoBack(outCmdEnabled); } nsresult nsGoBackCommand::DoWebNavCommand(const char *aCommandName, nsIWebNavigation* aWebNavigation) { return aWebNavigation->GoBack(); } #endif class nsLookUpDictionaryCommand final : public nsIControllerCommand { public: NS_DECL_ISUPPORTS NS_DECL_NSICONTROLLERCOMMAND private: virtual ~nsLookUpDictionaryCommand() { } }; NS_IMPL_ISUPPORTS(nsLookUpDictionaryCommand, nsIControllerCommand) NS_IMETHODIMP nsLookUpDictionaryCommand::IsCommandEnabled( const char* aCommandName, nsISupports* aCommandContext, bool* aRetval) { *aRetval = true; return NS_OK; } NS_IMETHODIMP nsLookUpDictionaryCommand::GetCommandStateParams(const char* aCommandName, nsICommandParams* aParams, nsISupports* aCommandContext) { return NS_ERROR_NOT_IMPLEMENTED; } NS_IMETHODIMP nsLookUpDictionaryCommand::DoCommand(const char* aCommandName, nsISupports *aCommandContext) { return NS_ERROR_NOT_IMPLEMENTED; } NS_IMETHODIMP nsLookUpDictionaryCommand::DoCommandParams(const char* aCommandName, nsICommandParams* aParams, nsISupports* aCommandContext) { if (NS_WARN_IF(!nsContentUtils::IsSafeToRunScript())) { return NS_ERROR_NOT_AVAILABLE; } int32_t x; int32_t y; nsresult rv = aParams->GetLongValue("x", &x); if (NS_WARN_IF(NS_FAILED(rv))) { return rv; } rv = aParams->GetLongValue("y", &y); if (NS_WARN_IF(NS_FAILED(rv))) { return rv; } LayoutDeviceIntPoint point(x, y); nsCOMPtr window = do_QueryInterface(aCommandContext); if (NS_WARN_IF(!window)) { return NS_ERROR_FAILURE; } nsIDocShell* docShell = window->GetDocShell(); if (NS_WARN_IF(!docShell)) { return NS_ERROR_FAILURE; } nsCOMPtr presShell = docShell->GetPresShell(); if (NS_WARN_IF(!presShell)) { return NS_ERROR_FAILURE; } nsPresContext* presContext = presShell->GetPresContext(); if (NS_WARN_IF(!presContext)) { return NS_ERROR_FAILURE; } nsCOMPtr widget = presContext->GetRootWidget(); if (NS_WARN_IF(!widget)) { return NS_ERROR_FAILURE; } WidgetQueryContentEvent charAt(true, eQueryCharacterAtPoint, widget); charAt.mRefPoint.x = x; charAt.mRefPoint.y = y; ContentEventHandler handler(presContext); handler.OnQueryCharacterAtPoint(&charAt); if (NS_WARN_IF(!charAt.mSucceeded) || charAt.mReply.mOffset == WidgetQueryContentEvent::NOT_FOUND) { return NS_ERROR_FAILURE; } WidgetQueryContentEvent textContent(true, eQueryTextContent, widget); // OSX 10.7 queries 50 characters before/after current point. So we fetch // same length. uint32_t offset = charAt.mReply.mOffset; if (offset > 50) { offset -= 50; } else { offset = 0; } textContent.InitForQueryTextContent(offset, 100); handler.OnQueryTextContent(&textContent); if (NS_WARN_IF(!textContent.mSucceeded || textContent.mReply.mString.IsEmpty())) { return NS_ERROR_FAILURE; } // XXX nsIWordBreaker doesn't use contextual breaker. // If OS provides it, widget should use it if contextual breaker is needed. RefPtr wordBreaker = nsContentUtils::WordBreaker(); if (NS_WARN_IF(!wordBreaker)) { return NS_ERROR_FAILURE; } mozilla::intl::WordRange range = wordBreaker->FindWord(textContent.mReply.mString.get(), textContent.mReply.mString.Length(), charAt.mReply.mOffset - offset); if (range.mEnd == range.mBegin) { return NS_ERROR_FAILURE; } range.mBegin += offset; range.mEnd += offset; WidgetQueryContentEvent lookUpContent(true, eQueryTextContent, widget); lookUpContent.InitForQueryTextContent(range.mBegin, range.mEnd - range.mBegin); lookUpContent.RequestFontRanges(); handler.OnQueryTextContent(&lookUpContent); if (NS_WARN_IF(!lookUpContent.mSucceeded || lookUpContent.mReply.mString.IsEmpty())) { return NS_ERROR_FAILURE; } WidgetQueryContentEvent charRect(true, eQueryTextRect, widget); charRect.InitForQueryTextRect(range.mBegin, range.mEnd - range.mBegin); handler.OnQueryTextRect(&charRect); if (NS_WARN_IF(!charRect.mSucceeded)) { return NS_ERROR_FAILURE; } widget->LookUpDictionary(lookUpContent.mReply.mString, lookUpContent.mReply.mFontRanges, charRect.mReply.mWritingMode.IsVertical(), charRect.mReply.mRect.TopLeft()); return NS_OK; } /*--------------------------------------------------------------------------- RegisterWindowCommands ----------------------------------------------------------------------------*/ #define NS_REGISTER_ONE_COMMAND(_cmdClass, _cmdName) \ { \ _cmdClass* theCmd = new _cmdClass(); \ rv = inCommandTable->RegisterCommand(_cmdName, \ static_cast(theCmd)); \ } #define NS_REGISTER_FIRST_COMMAND(_cmdClass, _cmdName) \ { \ _cmdClass* theCmd = new _cmdClass(); \ rv = inCommandTable->RegisterCommand(_cmdName, \ static_cast(theCmd)); #define NS_REGISTER_NEXT_COMMAND(_cmdClass, _cmdName) \ rv = inCommandTable->RegisterCommand(_cmdName, \ static_cast(theCmd)); #define NS_REGISTER_LAST_COMMAND(_cmdClass, _cmdName) \ rv = inCommandTable->RegisterCommand(_cmdName, \ static_cast(theCmd)); \ } // static nsresult nsWindowCommandRegistration::RegisterWindowCommands( nsIControllerCommandTable *inCommandTable) { nsresult rv; // XXX rework the macros to use a loop is possible, reducing code size // this set of commands is affected by the 'browse with caret' setting NS_REGISTER_FIRST_COMMAND(nsSelectMoveScrollCommand, sScrollTopString); NS_REGISTER_NEXT_COMMAND(nsSelectMoveScrollCommand, sScrollBottomString); NS_REGISTER_NEXT_COMMAND(nsSelectMoveScrollCommand, sScrollPageUpString); NS_REGISTER_NEXT_COMMAND(nsSelectMoveScrollCommand, sScrollPageDownString); NS_REGISTER_NEXT_COMMAND(nsSelectMoveScrollCommand, sScrollLineUpString); NS_REGISTER_NEXT_COMMAND(nsSelectMoveScrollCommand, sScrollLineDownString); NS_REGISTER_NEXT_COMMAND(nsSelectMoveScrollCommand, sScrollLeftString); NS_REGISTER_NEXT_COMMAND(nsSelectMoveScrollCommand, sScrollRightString); NS_REGISTER_NEXT_COMMAND(nsSelectMoveScrollCommand, sMoveTopString); NS_REGISTER_NEXT_COMMAND(nsSelectMoveScrollCommand, sMoveBottomString); NS_REGISTER_NEXT_COMMAND(nsSelectMoveScrollCommand, sWordPreviousString); NS_REGISTER_NEXT_COMMAND(nsSelectMoveScrollCommand, sWordNextString); NS_REGISTER_NEXT_COMMAND(nsSelectMoveScrollCommand, sBeginLineString); NS_REGISTER_NEXT_COMMAND(nsSelectMoveScrollCommand, sEndLineString); NS_REGISTER_NEXT_COMMAND(nsSelectMoveScrollCommand, sMovePageUpString); NS_REGISTER_NEXT_COMMAND(nsSelectMoveScrollCommand, sMovePageDownString); NS_REGISTER_NEXT_COMMAND(nsSelectMoveScrollCommand, sLinePreviousString); NS_REGISTER_NEXT_COMMAND(nsSelectMoveScrollCommand, sLineNextString); NS_REGISTER_NEXT_COMMAND(nsSelectMoveScrollCommand, sCharPreviousString); NS_REGISTER_LAST_COMMAND(nsSelectMoveScrollCommand, sCharNextString); NS_REGISTER_FIRST_COMMAND(nsPhysicalSelectMoveScrollCommand, sMoveLeftString); NS_REGISTER_NEXT_COMMAND(nsPhysicalSelectMoveScrollCommand, sMoveRightString); NS_REGISTER_NEXT_COMMAND(nsPhysicalSelectMoveScrollCommand, sMoveUpString); NS_REGISTER_NEXT_COMMAND(nsPhysicalSelectMoveScrollCommand, sMoveDownString); NS_REGISTER_NEXT_COMMAND(nsPhysicalSelectMoveScrollCommand, sMoveLeft2String); NS_REGISTER_NEXT_COMMAND(nsPhysicalSelectMoveScrollCommand, sMoveRight2String); NS_REGISTER_NEXT_COMMAND(nsPhysicalSelectMoveScrollCommand, sMoveUp2String); NS_REGISTER_LAST_COMMAND(nsPhysicalSelectMoveScrollCommand, sMoveDown2String); NS_REGISTER_FIRST_COMMAND(nsSelectCommand, sSelectCharPreviousString); NS_REGISTER_NEXT_COMMAND(nsSelectCommand, sSelectCharNextString); NS_REGISTER_NEXT_COMMAND(nsSelectCommand, sSelectWordPreviousString); NS_REGISTER_NEXT_COMMAND(nsSelectCommand, sSelectWordNextString); NS_REGISTER_NEXT_COMMAND(nsSelectCommand, sSelectBeginLineString); NS_REGISTER_NEXT_COMMAND(nsSelectCommand, sSelectEndLineString); NS_REGISTER_NEXT_COMMAND(nsSelectCommand, sSelectLinePreviousString); NS_REGISTER_NEXT_COMMAND(nsSelectCommand, sSelectLineNextString); NS_REGISTER_NEXT_COMMAND(nsSelectCommand, sSelectPageUpString); NS_REGISTER_NEXT_COMMAND(nsSelectCommand, sSelectPageDownString); NS_REGISTER_NEXT_COMMAND(nsSelectCommand, sSelectTopString); NS_REGISTER_LAST_COMMAND(nsSelectCommand, sSelectBottomString); NS_REGISTER_FIRST_COMMAND(nsPhysicalSelectCommand, sSelectLeftString); NS_REGISTER_NEXT_COMMAND(nsPhysicalSelectCommand, sSelectRightString); NS_REGISTER_NEXT_COMMAND(nsPhysicalSelectCommand, sSelectUpString); NS_REGISTER_NEXT_COMMAND(nsPhysicalSelectCommand, sSelectDownString); NS_REGISTER_NEXT_COMMAND(nsPhysicalSelectCommand, sSelectLeft2String); NS_REGISTER_NEXT_COMMAND(nsPhysicalSelectCommand, sSelectRight2String); NS_REGISTER_NEXT_COMMAND(nsPhysicalSelectCommand, sSelectUp2String); NS_REGISTER_LAST_COMMAND(nsPhysicalSelectCommand, sSelectDown2String); NS_REGISTER_ONE_COMMAND(nsClipboardCommand, "cmd_cut"); NS_REGISTER_ONE_COMMAND(nsClipboardCommand, "cmd_copy"); NS_REGISTER_ONE_COMMAND(nsClipboardCommand, "cmd_copyAndCollapseToEnd"); NS_REGISTER_ONE_COMMAND(nsClipboardCommand, "cmd_paste"); NS_REGISTER_ONE_COMMAND(nsClipboardCopyLinkCommand, "cmd_copyLink"); NS_REGISTER_FIRST_COMMAND(nsClipboardImageCommands, sCopyImageLocationString); NS_REGISTER_NEXT_COMMAND(nsClipboardImageCommands, sCopyImageContentsString); NS_REGISTER_LAST_COMMAND(nsClipboardImageCommands, sCopyImageString); NS_REGISTER_FIRST_COMMAND(nsClipboardSelectAllNoneCommands, sSelectAllString); NS_REGISTER_LAST_COMMAND(nsClipboardSelectAllNoneCommands, sSelectNoneString); NS_REGISTER_ONE_COMMAND(nsClipboardGetContentsCommand, "cmd_getContents"); #if 0 // Remove unless needed again, bug 204777 NS_REGISTER_ONE_COMMAND(nsGoBackCommand, "cmd_browserBack"); NS_REGISTER_ONE_COMMAND(nsGoForwardCommand, "cmd_browserForward"); #endif NS_REGISTER_ONE_COMMAND(nsLookUpDictionaryCommand, "cmd_lookUpDictionary"); return rv; } /* static */ bool nsGlobalWindowCommands::FindScrollCommand(const char* aCommandName, KeyboardScrollAction* aOutAction) { // Search for a keyboard scroll action to do for this command in browseCommands // and physicalBrowseCommands. Each command exists in only one of them, so the // order we examine browseCommands and physicalBrowseCommands doesn't matter. for (size_t i = 0; i < ArrayLength(browseCommands); i++) { const BrowseCommand& cmd = browseCommands[i]; bool forward = !strcmp(aCommandName, cmd.forward); bool reverse = !strcmp(aCommandName, cmd.reverse); if (forward || reverse) { *aOutAction = KeyboardScrollAction(cmd.scrollAction, forward); return true; } } for (size_t i = 0; i < ArrayLength(physicalBrowseCommands); i++) { const PhysicalBrowseCommand& cmd = physicalBrowseCommands[i]; if (!strcmp(aCommandName, cmd.command)) { int16_t dir = cmd.direction; bool forward = (dir == nsISelectionController::MOVE_RIGHT || dir == nsISelectionController::MOVE_DOWN); *aOutAction = KeyboardScrollAction(cmd.scrollAction, forward); return true; } } return false; }