mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-12-13 18:27:35 +00:00
cc2af30635
This patch makes `EditorBase::NotifyDocumentListeners()` notify `ComposerCommandsUpdater` via `HTMLEditor::mComposerCommandsUpdater` directly. Therefore, `ComposerCommandsUpdater` can stop inheriting `nsIDocumentStateListener`. Note that this patch also makes `ComposerCommandsUpdater::UpdateCommandGroup()` not take `nsAString` as its parameter because inlinning the `nsIDocumentStateListener` requires `ComposerCommandsUpdater.h` to include `nsAString.h`, but it's redundant and `UpdateCommandGroup()` just compares it with literal strings. Therefore, using `enum class` for specifying command group is faster. Differential Revision: https://phabricator.services.mozilla.com/D61357 --HG-- extra : moz-landing-system : lando
125 lines
3.4 KiB
C++
125 lines
3.4 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/. */
|
|
|
|
#ifndef mozilla_ComposerCommandsUpdater_h
|
|
#define mozilla_ComposerCommandsUpdater_h
|
|
|
|
#include "nsCOMPtr.h" // for already_AddRefed, nsCOMPtr
|
|
#include "nsCycleCollectionParticipant.h"
|
|
#include "nsINamed.h"
|
|
#include "nsISupportsImpl.h" // for NS_DECL_ISUPPORTS
|
|
#include "nsITimer.h" // for NS_DECL_NSITIMERCALLBACK, etc
|
|
#include "nsITransactionListener.h" // for nsITransactionListener
|
|
#include "nscore.h" // for NS_IMETHOD, nsresult, etc
|
|
|
|
class nsCommandManager;
|
|
class nsIDocShell;
|
|
class nsITransaction;
|
|
class nsITransactionManager;
|
|
class nsPIDOMWindowOuter;
|
|
|
|
namespace mozilla {
|
|
|
|
class ComposerCommandsUpdater final : public nsITransactionListener,
|
|
public nsITimerCallback,
|
|
public nsINamed {
|
|
public:
|
|
ComposerCommandsUpdater();
|
|
|
|
// nsISupports
|
|
NS_DECL_CYCLE_COLLECTING_ISUPPORTS
|
|
NS_DECL_CYCLE_COLLECTION_CLASS_AMBIGUOUS(ComposerCommandsUpdater,
|
|
nsITransactionListener)
|
|
|
|
// nsITimerCallback
|
|
NS_DECL_NSITIMERCALLBACK
|
|
|
|
// nsINamed
|
|
NS_DECL_NSINAMED
|
|
|
|
// nsITransactionListener
|
|
NS_DECL_NSITRANSACTIONLISTENER
|
|
|
|
void Init(nsPIDOMWindowOuter& aDOMWindow);
|
|
|
|
/**
|
|
* OnSelectionChange() is called when selection is changed in the editor.
|
|
*/
|
|
void OnSelectionChange() { PrimeUpdateTimer(); }
|
|
|
|
/**
|
|
* OnHTMLEditorCreated() is called when `HTMLEditor` is created and
|
|
* initialized.
|
|
*/
|
|
MOZ_CAN_RUN_SCRIPT void OnHTMLEditorCreated() {
|
|
UpdateOneCommand("obs_documentCreated");
|
|
}
|
|
|
|
/**
|
|
* OnBeforeHTMLEditorDestroyed() is called when `HTMLEditor` is being
|
|
* destroyed.
|
|
*/
|
|
MOZ_CAN_RUN_SCRIPT void OnBeforeHTMLEditorDestroyed() {
|
|
// cancel any outstanding update timer
|
|
if (mUpdateTimer) {
|
|
mUpdateTimer->Cancel();
|
|
mUpdateTimer = nullptr;
|
|
}
|
|
|
|
// We can't notify the command manager of this right now; it is too late in
|
|
// some cases and the window is already partially destructed (e.g. JS
|
|
// objects may be gone).
|
|
}
|
|
|
|
/**
|
|
* OnHTMLEditorDirtyStateChanged() is called when dirty state of `HTMLEditor`
|
|
* is changed form or to "dirty".
|
|
*/
|
|
MOZ_CAN_RUN_SCRIPT void OnHTMLEditorDirtyStateChanged(bool aNowDirty) {
|
|
if (mDirtyState == static_cast<int8_t>(aNowDirty)) {
|
|
return;
|
|
}
|
|
UpdateCommandGroup(CommandGroup::Save);
|
|
UpdateCommandGroup(CommandGroup::Undo);
|
|
mDirtyState = aNowDirty;
|
|
}
|
|
|
|
protected:
|
|
virtual ~ComposerCommandsUpdater();
|
|
|
|
enum {
|
|
eStateUninitialized = -1,
|
|
eStateOff = 0,
|
|
eStateOn = 1,
|
|
};
|
|
|
|
bool SelectionIsCollapsed();
|
|
MOZ_CAN_RUN_SCRIPT nsresult UpdateOneCommand(const char* aCommand);
|
|
enum class CommandGroup {
|
|
Save,
|
|
Style,
|
|
Undo,
|
|
};
|
|
MOZ_CAN_RUN_SCRIPT void UpdateCommandGroup(CommandGroup aCommandGroup);
|
|
|
|
nsCommandManager* GetCommandManager();
|
|
|
|
nsresult PrimeUpdateTimer();
|
|
void TimerCallback();
|
|
|
|
nsCOMPtr<nsITimer> mUpdateTimer;
|
|
nsCOMPtr<nsPIDOMWindowOuter> mDOMWindow;
|
|
nsCOMPtr<nsIDocShell> mDocShell;
|
|
|
|
int8_t mDirtyState;
|
|
int8_t mSelectionCollapsed;
|
|
bool mFirstDoOfFirstUndo;
|
|
};
|
|
|
|
} // namespace mozilla
|
|
|
|
#endif // #ifndef mozilla_ComposerCommandsUpdater_h
|