dom/l10n/DOMLocalization.h

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim: set ts=8 sts=2 et sw=2 tw=80: */
   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_DOMLocalization_h
   8 #define mozilla_dom_l10n_DOMLocalization_h
   9
  10 #include "nsTHashSet.h"
  11 #include "nsXULPrototypeDocument.h"
  12 #include "mozilla/intl/Localization.h"
  13 #include "mozilla/dom/DOMLocalizationBinding.h"
  14 #include "mozilla/dom/L10nMutations.h"
  15 #include "mozilla/dom/L10nOverlaysBinding.h"
  16 #include "mozilla/dom/LocalizationBinding.h"
  17
  18 // XXX Avoid including this here by moving function bodies to the cpp file
  19 #include "nsINode.h"
  20
  21 namespace mozilla {
  22 namespace dom {
  23
  24 class Element;
  25 class L10nMutations;
  26
  27 class DOMLocalization : public intl::Localization {
  28  public:
  29   NS_DECL_ISUPPORTS_INHERITED
  30   NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(DOMLocalization, Localization)
  31
  32   static already_AddRefed<DOMLocalization> Create(
  33       nsIGlobalObject* aGlobal, const bool aSync,
  34       const BundleGenerator& aBundleGenerator);
  35
  36   void Destroy();
  37
  38   static already_AddRefed<DOMLocalization> Constructor(
  39       const GlobalObject& aGlobal, const Sequence<nsString>& aResourceIds,
  40       const bool aSync, const BundleGenerator& aBundleGenerator,
  41       ErrorResult& aRv);
  42
  43   virtual JSObject* WrapObject(JSContext* aCx,
  44                                JS::Handle<JSObject*> aGivenProto) override;
  45
  46   /**
  47    * DOMLocalization API
  48    *
  49    * Methods documentation in DOMLocalization.webidl
  50    */
  51
  52   void ConnectRoot(nsINode& aNode, ErrorResult& aRv);
  53   void DisconnectRoot(nsINode& aNode, ErrorResult& aRv);
  54
  55   void PauseObserving(ErrorResult& aRv);
  56   void ResumeObserving(ErrorResult& aRv);
  57
  58   void SetAttributes(JSContext* aCx, Element& aElement, const nsAString& aId,
  59                      const Optional<JS::Handle<JSObject*>>& aArgs,
  60                      ErrorResult& aRv);
  61   void GetAttributes(Element& aElement, L10nIdArgs& aResult, ErrorResult& aRv);
  62
  63   already_AddRefed<Promise> TranslateFragment(nsINode& aNode, ErrorResult& aRv);
  64
  65   already_AddRefed<Promise> TranslateElements(
  66       const Sequence<OwningNonNull<Element>>& aElements, ErrorResult& aRv);
  67   already_AddRefed<Promise> TranslateElements(
  68       const Sequence<OwningNonNull<Element>>& aElements,
  69       nsXULPrototypeDocument* aProto, ErrorResult& aRv);
  70
  71   already_AddRefed<Promise> TranslateRoots(ErrorResult& aRv);
  72
  73   /**
  74    * Helper methods
  75    */
  76
  77   /**
  78    * Accumulates all translatable elements (ones containing
  79    * a `data-l10n-id` attribute) from under a node into
  80    * a list of elements.
  81    */
  82   static void GetTranslatables(nsINode& aNode,
  83                                Sequence<OwningNonNull<Element>>& aElements,
  84                                ErrorResult& aRv);
  85
  86   /**
  87    * Sets the root information such as locale and direction.
  88    */
  89   static void SetRootInfo(Element* aElement);
  90
  91   /**
  92    * Applies l10n translations on translatable elements.
  93    *
  94    * If `aProto` gets passed, it'll be used to cache
  95    * the localized elements.
  96    *
  97    * Result is `true` if all translations were applied
  98    * successfully, and `false` otherwise.
  99    */
 100   bool ApplyTranslations(nsTArray<nsCOMPtr<Element>>& aElements,
 101                          nsTArray<Nullable<L10nMessage>>& aTranslations,
 102                          nsXULPrototypeDocument* aProto, ErrorResult& aRv);
 103
 104   bool SubtreeRootInRoots(nsINode* aSubtreeRoot) {
 105     for (const auto* key : mRoots) {
 106       nsINode* subtreeRoot = key->SubtreeRoot();
 107       if (subtreeRoot == aSubtreeRoot) {
 108         return true;
 109       }
 110     }
 111     return false;
 112   }
 113
 114  protected:
 115   explicit DOMLocalization(nsIGlobalObject* aGlobal, const bool aSync,
 116                            const BundleGenerator& aBundleGenerator);
 117   virtual ~DOMLocalization();
 118   void OnChange() override;
 119   void DisconnectMutations();
 120   void DisconnectRoots();
 121   void ReportL10nOverlaysErrors(nsTArray<L10nOverlaysError>& aErrors);
 122   void ConvertStringToL10nArgs(const nsString& aInput, intl::L10nArgs& aRetVal,
 123                                ErrorResult& aRv);
 124
 125   RefPtr<L10nMutations> mMutations;
 126   nsTHashSet<RefPtr<nsINode>> mRoots;
 127 };
 128
 129 }  // namespace dom
 130 }  // namespace mozilla
 131
 132 #endif