Source code

Revision control

Other Tools

/* -*- 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 */
#ifndef mozilla_dom_l10n_L10nMutations_h
#define mozilla_dom_l10n_L10nMutations_h
#include "nsRefreshObservers.h"
#include "nsStubMutationObserver.h"
#include "nsTHashtable.h"
#include "mozilla/dom/DOMLocalization.h"
class nsRefreshDriver;
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 {
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();
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();
bool IsInRoots(nsINode* aNode);
} // namespace dom
} // namespace mozilla
#endif // mozilla_dom_l10n_L10nMutations_h__