dom/l10n/DocumentL10n.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim:set ts=2 sw=2 sts=2 et cindent: */
   3 /* This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #ifndef mozilla_dom_l10n_DocumentL10n_h
   8 #define mozilla_dom_l10n_DocumentL10n_h
   9
  10 #include "mozilla/dom/DOMLocalization.h"
  11
  12 class nsIContentSink;
  13
  14 namespace mozilla {
  15 namespace dom {
  16
  17 class Document;
  18
  19 enum class DocumentL10nState {
  20   // State set when the DocumentL10n gets constructed.
  21   Constructed = 0,
  22
  23   // State set when the initial translation got triggered. This happens
  24   // if DocumentL10n was constructed during parsing of the document.
  25   //
  26   // If the DocumentL10n gets constructed later, we'll skip directly to
  27   // Ready state.
  28   InitialTranslationTriggered,
  29
  30   // State set the DocumentL10n has been fully initialized, potentially
  31   // with initial translation being completed.
  32   Ready,
  33 };
  34
  35 /**
  36  * This class maintains localization status of the document.
  37  *
  38  * The document will initialize it lazily when a link with a localization
  39  * resource is added to the document.
  40  *
  41  * Once initialized, DocumentL10n relays all API methods to an
  42  * instance of mozILocalization and maintains a single promise
  43  * which gets resolved the first time the document gets translated.
  44  */
  45 class DocumentL10n final : public DOMLocalization {
  46  public:
  47   NS_DECL_ISUPPORTS_INHERITED
  48   NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(DocumentL10n, DOMLocalization)
  49
  50   static RefPtr<DocumentL10n> Create(Document* aDocument, const bool aSync);
  51
  52  protected:
  53   explicit DocumentL10n(Document* aDocument, const bool aSync);
  54   bool Init() override;
  55
  56   virtual ~DocumentL10n() = default;
  57
  58   RefPtr<Document> mDocument;
  59   RefPtr<Promise> mReady;
  60   DocumentL10nState mState;
  61   nsCOMPtr<nsIContentSink> mContentSink;
  62
  63  public:
  64   virtual JSObject* WrapObject(JSContext* aCx,
  65                                JS::Handle<JSObject*> aGivenProto) override;
  66
  67   Promise* Ready();
  68
  69   void TriggerInitialTranslation();
  70   already_AddRefed<Promise> TranslateDocument(ErrorResult& aRv);
  71
  72   void InitialTranslationCompleted(bool aL10nCached);
  73
  74   Document* GetDocument() { return mDocument; };
  75   void OnCreatePresShell();
  76
  77   void ConnectRoot(nsINode& aNode, bool aTranslate, ErrorResult& aRv);
  78
  79   DocumentL10nState GetState() { return mState; };
  80
  81   void MaybeRecordTelemetry();
  82
  83   bool mBlockingLayout = false;
  84
  85   mozilla::TimeStamp mInitialTranslationStart;
  86   static bool mIsFirstBrowserWindow;
  87 };
  88
  89 }  // namespace dom
  90 }  // namespace mozilla
  91
  92 #endif  // mozilla_dom_l10n_DocumentL10n_h