mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-12-03 10:33:33 +00:00
2bf505b023
Differential Revision: https://phabricator.services.mozilla.com/D37053 --HG-- extra : moz-landing-system : lando
90 lines
2.6 KiB
C++
90 lines
2.6 KiB
C++
/* -*- 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/. */
|
|
|
|
#ifndef mozilla_dom_l10n_L10nMutations_h
|
|
#define mozilla_dom_l10n_L10nMutations_h
|
|
|
|
#include "nsRefreshDriver.h"
|
|
#include "nsStubMutationObserver.h"
|
|
#include "nsTHashtable.h"
|
|
#include "mozilla/dom/DOMLocalization.h"
|
|
|
|
namespace mozilla {
|
|
namespace dom {
|
|
|
|
/**
|
|
* L10nMutations manage observing roots for localization
|
|
* changes and coalescing pending translations into
|
|
* batches - one per animation frame.
|
|
*/
|
|
class L10nMutations final : public nsStubMutationObserver,
|
|
public nsARefreshObserver {
|
|
public:
|
|
NS_DECL_CYCLE_COLLECTING_ISUPPORTS
|
|
NS_DECL_CYCLE_COLLECTION_CLASS_AMBIGUOUS(L10nMutations, nsIMutationObserver)
|
|
NS_DECL_NSIMUTATIONOBSERVER_CONTENTAPPENDED
|
|
NS_DECL_NSIMUTATIONOBSERVER_CONTENTINSERTED
|
|
NS_DECL_NSIMUTATIONOBSERVER_ATTRIBUTECHANGED
|
|
|
|
explicit L10nMutations(DOMLocalization* aDOMLocalization);
|
|
|
|
/**
|
|
* Pause root observation.
|
|
* This is useful for injecting already-translated
|
|
* content into an observed root, without causing
|
|
* superflues translation.
|
|
*/
|
|
void PauseObserving();
|
|
|
|
/**
|
|
* Resume root observation.
|
|
*/
|
|
void ResumeObserving();
|
|
|
|
/**
|
|
* Disconnect roots, stop refresh observer
|
|
* and break the cycle collection deadlock
|
|
* by removing the reference to mDOMLocalization.
|
|
*/
|
|
void Disconnect();
|
|
|
|
/**
|
|
* Called when PresShell gets created for the document.
|
|
* If there are already pending mutations, this
|
|
* will schedule the refresh driver to translate them.
|
|
*/
|
|
void OnCreatePresShell();
|
|
|
|
protected:
|
|
bool mObserving = false;
|
|
bool mRefreshObserver = false;
|
|
RefPtr<nsRefreshDriver> mRefreshDriver;
|
|
DOMLocalization* mDOMLocalization;
|
|
|
|
// The hash is used to speed up lookups into mPendingElements.
|
|
nsTHashtable<nsRefPtrHashKey<Element>> mPendingElementsHash;
|
|
nsTArray<RefPtr<Element>> mPendingElements;
|
|
|
|
virtual void WillRefresh(mozilla::TimeStamp aTime) override;
|
|
|
|
void StartRefreshObserver();
|
|
void StopRefreshObserver();
|
|
void L10nElementChanged(Element* aElement);
|
|
void FlushPendingTranslations();
|
|
|
|
private:
|
|
~L10nMutations() {
|
|
StopRefreshObserver();
|
|
MOZ_ASSERT(!mDOMLocalization,
|
|
"DOMLocalization<-->L10nMutations cycle should be broken.");
|
|
}
|
|
};
|
|
|
|
} // namespace dom
|
|
} // namespace mozilla
|
|
|
|
#endif // mozilla_dom_l10n_L10nMutations_h__
|