The Tor Browser: accessible/src/base/ARIAMap.h@b8a032363ba2 (annotated)

accessible/src/base/ARIAMap.h@b8a032363ba2 (annotated)

accessible/src/base/ARIAMap.h

Thu, 22 Jan 2015 13:21:57 +0100

author: Michael Schloh von Bennewitz <michael@schloh.com>
date: Thu, 22 Jan 2015 13:21:57 +0100
branch: TOR_BUG_9701
changeset 15: b8a032363ba2
permissions: -rw-r--r--

Incorporate requested changes from Mozilla in review:
https://bugzilla.mozilla.org/show_bug.cgi?id=1123480#c6

 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
 /* vim:expandtab:shiftwidth=2:tabstop=2:
  */
 /* 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_a11y_aria_ARIAMap_h_
 #define mozilla_a11y_aria_ARIAMap_h_
 #include "ARIAStateMap.h"
 #include "mozilla/a11y/AccTypes.h"
 #include "mozilla/a11y/Role.h"
 #include "nsIAtom.h"
 #include "nsIContent.h"
 class nsINode;
 ////////////////////////////////////////////////////////////////////////////////
 // Value constants
 /**
  * Used to define if role requires to expose nsIAccessibleValue.
  */
 enum EValueRule
 {
   /**
    * nsIAccessibleValue isn't exposed.
    */
   eNoValue,
   /**
    * nsIAccessibleValue is implemented, supports value, min and max from
    * aria-valuenow, aria-valuemin and aria-valuemax.
    */
   eHasValueMinMax
 };
 ////////////////////////////////////////////////////////////////////////////////
 // Action constants
 /**
  * Used to define if the role requires to expose action.
  */
 enum EActionRule
 {
   eNoAction,
   eActivateAction,
   eClickAction,
   ePressAction,
   eCheckUncheckAction,
   eExpandAction,
   eJumpAction,
   eOpenCloseAction,
   eSelectAction,
   eSortAction,
   eSwitchAction
 };
 ////////////////////////////////////////////////////////////////////////////////
 // Live region constants
 /**
  * Used to define if role exposes default value of aria-live attribute.
  */
 enum ELiveAttrRule
 {
   eNoLiveAttr,
   eOffLiveAttr,
   ePoliteLiveAttr
 };
 ////////////////////////////////////////////////////////////////////////////////
 // Role constants
 /**
  * ARIA role overrides role from native markup.
  */
 const bool kUseMapRole = true;
 /**
  * ARIA role doesn't override the role from native markup.
  */
 const bool kUseNativeRole = false;
 ////////////////////////////////////////////////////////////////////////////////
 // ARIA attribute characteristic masks
 /**
  * This mask indicates the attribute should not be exposed as an object
  * attribute via the catch-all logic in Accessible::Attributes().
  * This means it either isn't mean't to be exposed as an object attribute, or
  * that it should, but is already handled in other code.
  */
 const uint8_t ATTR_BYPASSOBJ = 0x1 << 0;
 const uint8_t ATTR_BYPASSOBJ_IF_FALSE = 0x1 << 1;
 /**
  * This mask indicates the attribute is expected to have an NMTOKEN or bool value.
  * (See for example usage in Accessible::Attributes())
  */
 const uint8_t ATTR_VALTOKEN = 0x1 << 2;
 /**
  * Indicate the attribute is global state or property (refer to
  * http://www.w3.org/TR/wai-aria/states_and_properties#global_states).
  */
 const uint8_t ATTR_GLOBAL = 0x1 << 3;
 ////////////////////////////////////////////////////////////////////////////////
 // State map entry
 /**
  * Used in nsRoleMapEntry.state if no nsIAccessibleStates are automatic for
  * a given role.
  */
 #define kNoReqStates 0
 ////////////////////////////////////////////////////////////////////////////////
 // Role map entry
 /**
  * For each ARIA role, this maps the nsIAccessible information.
  */
 struct nsRoleMapEntry
 {
   /**
    * Return true if matches to the given ARIA role.
    */
   bool Is(nsIAtom* aARIARole) const
     { return *roleAtom == aARIARole; }
   /**
    * Return true if ARIA role has the given accessible type.
    */
   bool IsOfType(mozilla::a11y::AccGenericType aType) const
     { return accTypes & aType; }
   /**
    * Return ARIA role.
    */
   const nsDependentAtomString ARIARoleString() const
     { return nsDependentAtomString(*roleAtom); }
   // ARIA role: string representation such as "button"
   nsIAtom** roleAtom;
   // Role mapping rule: maps to this nsIAccessibleRole
   mozilla::a11y::role role;
   // Role rule: whether to use mapped role or native semantics
   bool roleRule;
   // Value mapping rule: how to compute nsIAccessible value
   EValueRule valueRule;
   // Action mapping rule, how to expose nsIAccessible action
   EActionRule actionRule;
   // 'live' and 'container-live' object attributes mapping rule: how to expose
   // these object attributes if ARIA 'live' attribute is missed.
   ELiveAttrRule liveAttRule;
   // Accessible types this role belongs to.
   uint32_t accTypes;
   // Automatic state mapping rule: always include in nsIAccessibleStates
   uint64_t state;   // or kNoReqStates if no nsIAccessibleStates are automatic for this role.
   // ARIA properties supported for this role
   // (in other words, the aria-foo attribute to nsIAccessibleStates mapping rules)
   // Currently you cannot have unlimited mappings, because
   // a variable sized array would not allow the use of
   // C++'s struct initialization feature.
   mozilla::a11y::aria::EStateRule attributeMap1;
   mozilla::a11y::aria::EStateRule attributeMap2;
   mozilla::a11y::aria::EStateRule attributeMap3;
 };
 ////////////////////////////////////////////////////////////////////////////////
 // ARIA map
 /**
  *  These provide the mappings for WAI-ARIA roles, states and properties using
  *  the structs defined in this file and ARIAStateMap files.
  */
 namespace mozilla {
 namespace a11y {
 namespace aria {
 /**
  * Empty role map entry. Used by accessibility service to create an accessible
  * if the accessible can't use role of used accessible class. For example,
  * it is used for table cells that aren't contained by table.
  */
 extern nsRoleMapEntry gEmptyRoleMap;
 /**
  * Get the role map entry for a given DOM node. This will use the first
  * ARIA role if the role attribute provides a space delimited list of roles.
  *
  * @param aNode  [in] the DOM node to get the role map entry for
  * @return        a pointer to the role map entry for the ARIA role, or nullptr
  *                if none
  */
 nsRoleMapEntry* GetRoleMap(nsINode* aNode);
 /**
  * Return accessible state from ARIA universal states applied to the given
  * element.
  */
 uint64_t UniversalStatesFor(mozilla::dom::Element* aElement);
 /**
  * Get the ARIA attribute characteristics for a given ARIA attribute.
  *
  * @param aAtom  ARIA attribute
  * @return       A bitflag representing the attribute characteristics
  *               (see above for possible bit masks, prefixed "ATTR_")
  */
 uint8_t AttrCharacteristicsFor(nsIAtom* aAtom);
  /**
   * Represents a simple enumerator for iterating through ARIA attributes
   * exposed as object attributes on a given accessible.
   */
 class AttrIterator
 {
 public:
   AttrIterator(nsIContent* aContent) :
     mContent(aContent), mAttrIdx(0)
   {
     mAttrCount = mContent->GetAttrCount();
   }
   bool Next(nsAString& aAttrName, nsAString& aAttrValue);
 private:
   AttrIterator() MOZ_DELETE;
   AttrIterator(const AttrIterator&) MOZ_DELETE;
   AttrIterator& operator= (const AttrIterator&) MOZ_DELETE;
   nsIContent* mContent;
   uint32_t mAttrIdx;
   uint32_t mAttrCount;
 };
 } // namespace aria
 } // namespace a11y
 } // namespace mozilla
 #endif

The Tor Browser / annotate

accessible/src/base/ARIAMap.h@b8a032363ba2 (annotated)

accessible/src/base/ARIAMap.h