dom/svg/SVGTests.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 DOM_SVG_SVGTESTS_H_
   8 #define DOM_SVG_SVGTESTS_H_
   9
  10 #include "nsStringFwd.h"
  11 #include "mozilla/AlreadyAddRefed.h"
  12 #include "mozilla/SVGStringList.h"
  13
  14 class nsAttrValue;
  15 class nsAtom;
  16 class nsStaticAtom;
  17
  18 namespace mozilla {
  19
  20 namespace dom {
  21 class DOMSVGStringList;
  22 }
  23
  24 #define MOZILLA_DOMSVGTESTS_IID                      \
  25   {                                                  \
  26     0x92370da8, 0xda28, 0x4895, {                    \
  27       0x9b, 0x1b, 0xe0, 0x06, 0x0d, 0xb7, 0x3f, 0xc3 \
  28     }                                                \
  29   }
  30
  31 namespace dom {
  32
  33 class SVGElement;
  34
  35 class SVGTests : public nsISupports {
  36  public:
  37   NS_DECLARE_STATIC_IID_ACCESSOR(MOZILLA_DOMSVGTESTS_IID)
  38
  39   SVGTests();
  40
  41   friend class dom::DOMSVGStringList;
  42   using SVGStringList = mozilla::SVGStringList;
  43
  44   /**
  45    * Compare the language name(s) in a systemLanguage attribute to the
  46    * user's language preferences, as defined in
  47    * http://www.w3.org/TR/SVG11/struct.html#SystemLanguageAttribute
  48    * We have a match if a language name in the users language preferences
  49    * exactly equals one of the language names or exactly equals a prefix of
  50    * one of the language names in the systemLanguage attribute.
  51    * @returns 2 * the lowest index in the aAcceptLangs that matches + 1
  52    * if only the prefix matches, -2 if there's no systemLanguage attribute,
  53    * or -1 if no indices match.
  54    * XXX This algorithm is O(M*N).
  55    */
  56   int32_t GetBestLanguagePreferenceRank(const nsAString& aAcceptLangs) const;
  57
  58   /**
  59    * Check whether the conditional processing attributes other than
  60    * systemLanguage "return true" if they apply to and are specified
  61    * on the given element. Returns true if this element should be
  62    * rendered, false if it should not.
  63    */
  64   bool PassesConditionalProcessingTestsIgnoringSystemLanguage() const;
  65
  66   /**
  67    * Check whether the conditional processing attributes requiredExtensions
  68    * and systemLanguage both "return true" if they apply to
  69    * and are specified on the given element. Returns true if this element
  70    * should be rendered, false if it should not.
  71    */
  72   bool PassesConditionalProcessingTests() const;
  73
  74   /**
  75    * Check whether the conditional processing attributes requiredExtensions
  76    * and systemLanguage both "return true" if they apply to
  77    * and are specified on the given element. Returns true if this element
  78    * should be rendered, false if it should not.
  79    *
  80    * @param aAcceptLangs The value of the intl.accept_languages preference
  81    */
  82   bool PassesConditionalProcessingTests(const nsAString& aAcceptLangs) const;
  83
  84   /**
  85    * Returns true if the attribute is one of the conditional processing
  86    * attributes.
  87    */
  88   bool IsConditionalProcessingAttribute(const nsAtom* aAttribute) const;
  89
  90   bool ParseConditionalProcessingAttribute(nsAtom* aAttribute,
  91                                            const nsAString& aValue,
  92                                            nsAttrValue& aResult);
  93
  94   /**
  95    * Unsets a conditional processing attribute.
  96    */
  97   void UnsetAttr(const nsAtom* aAttribute);
  98
  99   nsStaticAtom* GetAttrName(uint8_t aAttrEnum) const;
 100   void GetAttrValue(uint8_t aAttrEnum, nsAttrValue& aValue) const;
 101
 102   void MaybeInvalidate();
 103
 104   // WebIDL
 105   already_AddRefed<DOMSVGStringList> RequiredExtensions();
 106   already_AddRefed<DOMSVGStringList> SystemLanguage();
 107
 108   bool HasExtension(const nsAString& aExtension) const;
 109
 110   virtual SVGElement* AsSVGElement() = 0;
 111
 112   const SVGElement* AsSVGElement() const {
 113     return const_cast<SVGTests*>(this)->AsSVGElement();
 114   }
 115
 116  protected:
 117   virtual ~SVGTests() = default;
 118
 119  private:
 120   enum { EXTENSIONS, LANGUAGE };
 121   SVGStringList mStringListAttributes[2];
 122   static nsStaticAtom* const sStringListNames[2];
 123 };
 124
 125 NS_DEFINE_STATIC_IID_ACCESSOR(SVGTests, MOZILLA_DOMSVGTESTS_IID)
 126
 127 }  // namespace dom
 128 }  // namespace mozilla
 129
 130 #endif  // DOM_SVG_SVGTESTS_H_