gecko-dev/editor/composer/ComposerCommandsUpdater.cpp

348 строки
11 KiB
C++

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
*
* 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 "mozilla/ComposerCommandsUpdater.h"
#include "mozilla/mozalloc.h" // for operator new
#include "mozilla/TransactionManager.h" // for TransactionManager
#include "mozilla/dom/Selection.h"
#include "nsAString.h"
#include "nsCommandManager.h" // for nsCommandManager
#include "nsComponentManagerUtils.h" // for do_CreateInstance
#include "nsDebug.h" // for NS_ENSURE_TRUE, etc
#include "nsError.h" // for NS_OK, NS_ERROR_FAILURE, etc
#include "nsID.h" // for NS_GET_IID, etc
#include "nsIDOMWindow.h" // for nsIDOMWindow
#include "nsIDocShell.h" // for nsIDocShell
#include "nsIInterfaceRequestorUtils.h" // for do_GetInterface
#include "nsITransactionManager.h" // for nsITransactionManager
#include "nsLiteralString.h" // for NS_LITERAL_STRING
#include "nsPIDOMWindow.h" // for nsPIDOMWindow
class nsITransaction;
namespace mozilla {
ComposerCommandsUpdater::ComposerCommandsUpdater()
: mDirtyState(eStateUninitialized),
mSelectionCollapsed(eStateUninitialized),
mFirstDoOfFirstUndo(true) {}
ComposerCommandsUpdater::~ComposerCommandsUpdater() {
// cancel any outstanding update timer
if (mUpdateTimer) {
mUpdateTimer->Cancel();
}
}
NS_IMPL_CYCLE_COLLECTING_ADDREF(ComposerCommandsUpdater)
NS_IMPL_CYCLE_COLLECTING_RELEASE(ComposerCommandsUpdater)
NS_INTERFACE_MAP_BEGIN(ComposerCommandsUpdater)
NS_INTERFACE_MAP_ENTRY(nsIDocumentStateListener)
NS_INTERFACE_MAP_ENTRY(nsITransactionListener)
NS_INTERFACE_MAP_ENTRY(nsITimerCallback)
NS_INTERFACE_MAP_ENTRY(nsINamed)
NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, nsIDocumentStateListener)
NS_INTERFACE_MAP_ENTRIES_CYCLE_COLLECTION(ComposerCommandsUpdater)
NS_INTERFACE_MAP_END
NS_IMPL_CYCLE_COLLECTION(ComposerCommandsUpdater, mUpdateTimer, mDOMWindow,
mDocShell)
#if 0
# pragma mark -
#endif
NS_IMETHODIMP
ComposerCommandsUpdater::NotifyDocumentCreated() {
// Trigger an nsIObserve notification that the document has been created
UpdateOneCommand("obs_documentCreated");
return NS_OK;
}
NS_IMETHODIMP
ComposerCommandsUpdater::NotifyDocumentWillBeDestroyed() {
// cancel any outstanding update timer
if (mUpdateTimer) {
mUpdateTimer->Cancel();
mUpdateTimer = nullptr;
}
// We can't call this right now; it is too late in some cases and the window
// is already partially destructed (e.g. JS objects may be gone).
#if 0
// Trigger an nsIObserve notification that the document will be destroyed
UpdateOneCommand("obs_documentWillBeDestroyed");
#endif
return NS_OK;
}
NS_IMETHODIMP
ComposerCommandsUpdater::NotifyDocumentStateChanged(bool aNowDirty) {
// update document modified. We should have some other notifications for this
// too.
return UpdateDirtyState(aNowDirty);
}
#if 0
# pragma mark -
#endif
NS_IMETHODIMP
ComposerCommandsUpdater::WillDo(nsITransactionManager* aManager,
nsITransaction* aTransaction,
bool* aInterrupt) {
*aInterrupt = false;
return NS_OK;
}
NS_IMETHODIMP
ComposerCommandsUpdater::DidDo(nsITransactionManager* aManager,
nsITransaction* aTransaction,
nsresult aDoResult) {
// only need to update if the status of the Undo menu item changes.
size_t undoCount = aManager->AsTransactionManager()->NumberOfUndoItems();
if (undoCount == 1) {
if (mFirstDoOfFirstUndo) {
UpdateCommandGroup(NS_LITERAL_STRING("undo"));
}
mFirstDoOfFirstUndo = false;
}
return NS_OK;
}
NS_IMETHODIMP
ComposerCommandsUpdater::WillUndo(nsITransactionManager* aManager,
nsITransaction* aTransaction,
bool* aInterrupt) {
*aInterrupt = false;
return NS_OK;
}
NS_IMETHODIMP
ComposerCommandsUpdater::DidUndo(nsITransactionManager* aManager,
nsITransaction* aTransaction,
nsresult aUndoResult) {
size_t undoCount = aManager->AsTransactionManager()->NumberOfUndoItems();
if (!undoCount) {
mFirstDoOfFirstUndo = true; // reset the state for the next do
}
UpdateCommandGroup(NS_LITERAL_STRING("undo"));
return NS_OK;
}
NS_IMETHODIMP
ComposerCommandsUpdater::WillRedo(nsITransactionManager* aManager,
nsITransaction* aTransaction,
bool* aInterrupt) {
*aInterrupt = false;
return NS_OK;
}
NS_IMETHODIMP
ComposerCommandsUpdater::DidRedo(nsITransactionManager* aManager,
nsITransaction* aTransaction,
nsresult aRedoResult) {
UpdateCommandGroup(NS_LITERAL_STRING("undo"));
return NS_OK;
}
NS_IMETHODIMP
ComposerCommandsUpdater::WillBeginBatch(nsITransactionManager* aManager,
bool* aInterrupt) {
*aInterrupt = false;
return NS_OK;
}
NS_IMETHODIMP
ComposerCommandsUpdater::DidBeginBatch(nsITransactionManager* aManager,
nsresult aResult) {
return NS_OK;
}
NS_IMETHODIMP
ComposerCommandsUpdater::WillEndBatch(nsITransactionManager* aManager,
bool* aInterrupt) {
*aInterrupt = false;
return NS_OK;
}
NS_IMETHODIMP
ComposerCommandsUpdater::DidEndBatch(nsITransactionManager* aManager,
nsresult aResult) {
return NS_OK;
}
NS_IMETHODIMP
ComposerCommandsUpdater::WillMerge(nsITransactionManager* aManager,
nsITransaction* aTopTransaction,
nsITransaction* aTransactionToMerge,
bool* aInterrupt) {
*aInterrupt = false;
return NS_OK;
}
NS_IMETHODIMP
ComposerCommandsUpdater::DidMerge(nsITransactionManager* aManager,
nsITransaction* aTopTransaction,
nsITransaction* aTransactionToMerge,
bool aDidMerge, nsresult aMergeResult) {
return NS_OK;
}
#if 0
# pragma mark -
#endif
nsresult ComposerCommandsUpdater::Init(nsPIDOMWindowOuter* aDOMWindow) {
if (NS_WARN_IF(!aDOMWindow)) {
return NS_ERROR_INVALID_ARG;
}
mDOMWindow = aDOMWindow;
mDocShell = aDOMWindow->GetDocShell();
return NS_OK;
}
nsresult ComposerCommandsUpdater::PrimeUpdateTimer() {
if (!mUpdateTimer) {
mUpdateTimer = NS_NewTimer();
;
NS_ENSURE_TRUE(mUpdateTimer, NS_ERROR_OUT_OF_MEMORY);
}
const uint32_t kUpdateTimerDelay = 150;
return mUpdateTimer->InitWithCallback(static_cast<nsITimerCallback*>(this),
kUpdateTimerDelay,
nsITimer::TYPE_ONE_SHOT);
}
void ComposerCommandsUpdater::TimerCallback() {
// if the selection state has changed, update stuff
bool isCollapsed = SelectionIsCollapsed();
if (static_cast<int8_t>(isCollapsed) != mSelectionCollapsed) {
UpdateCommandGroup(NS_LITERAL_STRING("select"));
mSelectionCollapsed = isCollapsed;
}
// isn't this redundant with the UpdateCommandGroup above?
// can we just nuke the above call? or create a meta command group?
UpdateCommandGroup(NS_LITERAL_STRING("style"));
}
nsresult ComposerCommandsUpdater::UpdateDirtyState(bool aNowDirty) {
if (mDirtyState != static_cast<int8_t>(aNowDirty)) {
UpdateCommandGroup(NS_LITERAL_STRING("save"));
UpdateCommandGroup(NS_LITERAL_STRING("undo"));
mDirtyState = aNowDirty;
}
return NS_OK;
}
nsresult ComposerCommandsUpdater::UpdateCommandGroup(
const nsAString& aCommandGroup) {
RefPtr<nsCommandManager> commandManager = GetCommandManager();
NS_ENSURE_TRUE(commandManager, NS_ERROR_FAILURE);
if (aCommandGroup.EqualsLiteral("undo")) {
commandManager->CommandStatusChanged("cmd_undo");
commandManager->CommandStatusChanged("cmd_redo");
return NS_OK;
}
if (aCommandGroup.EqualsLiteral("select") ||
aCommandGroup.EqualsLiteral("style")) {
commandManager->CommandStatusChanged("cmd_bold");
commandManager->CommandStatusChanged("cmd_italic");
commandManager->CommandStatusChanged("cmd_underline");
commandManager->CommandStatusChanged("cmd_tt");
commandManager->CommandStatusChanged("cmd_strikethrough");
commandManager->CommandStatusChanged("cmd_superscript");
commandManager->CommandStatusChanged("cmd_subscript");
commandManager->CommandStatusChanged("cmd_nobreak");
commandManager->CommandStatusChanged("cmd_em");
commandManager->CommandStatusChanged("cmd_strong");
commandManager->CommandStatusChanged("cmd_cite");
commandManager->CommandStatusChanged("cmd_abbr");
commandManager->CommandStatusChanged("cmd_acronym");
commandManager->CommandStatusChanged("cmd_code");
commandManager->CommandStatusChanged("cmd_samp");
commandManager->CommandStatusChanged("cmd_var");
commandManager->CommandStatusChanged("cmd_increaseFont");
commandManager->CommandStatusChanged("cmd_decreaseFont");
commandManager->CommandStatusChanged("cmd_paragraphState");
commandManager->CommandStatusChanged("cmd_fontFace");
commandManager->CommandStatusChanged("cmd_fontColor");
commandManager->CommandStatusChanged("cmd_backgroundColor");
commandManager->CommandStatusChanged("cmd_highlight");
return NS_OK;
}
if (aCommandGroup.EqualsLiteral("save")) {
// save commands (most are not in C++)
commandManager->CommandStatusChanged("cmd_setDocumentModified");
commandManager->CommandStatusChanged("cmd_save");
return NS_OK;
}
return NS_OK;
}
nsresult ComposerCommandsUpdater::UpdateOneCommand(const char* aCommand) {
RefPtr<nsCommandManager> commandManager = GetCommandManager();
NS_ENSURE_TRUE(commandManager, NS_ERROR_FAILURE);
commandManager->CommandStatusChanged(aCommand);
return NS_OK;
}
bool ComposerCommandsUpdater::SelectionIsCollapsed() {
if (NS_WARN_IF(!mDOMWindow)) {
return true;
}
RefPtr<dom::Selection> domSelection = mDOMWindow->GetSelection();
if (NS_WARN_IF(!domSelection)) {
return false;
}
return domSelection->IsCollapsed();
}
nsCommandManager* ComposerCommandsUpdater::GetCommandManager() {
if (NS_WARN_IF(!mDocShell)) {
return nullptr;
}
return mDocShell->GetCommandManager();
}
NS_IMETHODIMP
ComposerCommandsUpdater::GetName(nsACString& aName) {
aName.AssignLiteral("ComposerCommandsUpdater");
return NS_OK;
}
#if 0
# pragma mark -
#endif
nsresult ComposerCommandsUpdater::Notify(nsITimer* aTimer) {
NS_ASSERTION(aTimer == mUpdateTimer.get(), "Hey, this ain't my timer!");
TimerCallback();
return NS_OK;
}
#if 0
# pragma mark -
#endif
} // namespace mozilla