summaryrefslogtreecommitdiffstats
path: root/dom/l10n/DocumentL10n.h
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-28 14:29:10 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-28 14:29:10 +0000
commit2aa4a82499d4becd2284cdb482213d541b8804dd (patch)
treeb80bf8bf13c3766139fbacc530efd0dd9d54394c /dom/l10n/DocumentL10n.h
parentInitial commit. (diff)
downloadfirefox-upstream.tar.xz
firefox-upstream.zip
Adding upstream version 86.0.1.upstream/86.0.1upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'dom/l10n/DocumentL10n.h')
-rw-r--r--dom/l10n/DocumentL10n.h87
1 files changed, 87 insertions, 0 deletions
diff --git a/dom/l10n/DocumentL10n.h b/dom/l10n/DocumentL10n.h
new file mode 100644
index 0000000000..fc40f590f3
--- /dev/null
+++ b/dom/l10n/DocumentL10n.h
@@ -0,0 +1,87 @@
+/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/* vim:set ts=2 sw=2 sts=2 et cindent: */
+/* 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_DocumentL10n_h
+#define mozilla_dom_l10n_DocumentL10n_h
+
+#include "mozilla/dom/DOMLocalization.h"
+
+class nsIContentSink;
+
+namespace mozilla {
+namespace dom {
+
+class Document;
+
+enum class DocumentL10nState {
+ // State set when the DocumentL10n gets constructed.
+ Constructed = 0,
+
+ // State set when the initial translation got triggered. This happens
+ // if DocumentL10n was constructed during parsing of the document.
+ //
+ // If the DocumentL10n gets constructed later, we'll skip directly to
+ // Ready state.
+ InitialTranslationTriggered,
+
+ // State set the DocumentL10n has been fully initialized, potentially
+ // with initial translation being completed.
+ Ready,
+};
+
+/**
+ * This class maintains localization status of the document.
+ *
+ * The document will initialize it lazily when a link with a localization
+ * resource is added to the document.
+ *
+ * Once initialized, DocumentL10n relays all API methods to an
+ * instance of mozILocalization and maintains a single promise
+ * which gets resolved the first time the document gets translated.
+ */
+class DocumentL10n final : public DOMLocalization {
+ public:
+ NS_DECL_ISUPPORTS_INHERITED
+ NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(DocumentL10n, DOMLocalization)
+
+ static RefPtr<DocumentL10n> Create(Document* aDocument, const bool aSync);
+
+ protected:
+ explicit DocumentL10n(Document* aDocument, const bool aSync);
+ bool Init() override;
+
+ virtual ~DocumentL10n() = default;
+
+ RefPtr<Document> mDocument;
+ RefPtr<Promise> mReady;
+ DocumentL10nState mState;
+ nsCOMPtr<nsIContentSink> mContentSink;
+
+ public:
+ virtual JSObject* WrapObject(JSContext* aCx,
+ JS::Handle<JSObject*> aGivenProto) override;
+
+ Promise* Ready();
+
+ void TriggerInitialTranslation();
+ already_AddRefed<Promise> TranslateDocument(ErrorResult& aRv);
+
+ void InitialTranslationCompleted(bool aL10nCached);
+
+ Document* GetDocument() { return mDocument; };
+ void OnCreatePresShell();
+
+ void ConnectRoot(nsINode& aNode, bool aTranslate, ErrorResult& aRv);
+
+ DocumentL10nState GetState() { return mState; };
+
+ bool mBlockingLayout = false;
+};
+
+} // namespace dom
+} // namespace mozilla
+
+#endif // mozilla_dom_l10n_DocumentL10n_h