The Tor Browser: accessible/src/mac/mozActionElements.mm@141e0f1194b1 (annotated)

accessible/src/mac/mozActionElements.mm@141e0f1194b1 (annotated)

accessible/src/mac/mozActionElements.mm

Wed, 31 Dec 2014 07:16:47 +0100

author: Michael Schloh von Bennewitz <michael@schloh.com>
date: Wed, 31 Dec 2014 07:16:47 +0100
branch: TOR_BUG_9701
changeset 3: 141e0f1194b1
permissions: -rw-r--r--

Revert simplistic fix pending revisit of Mozilla integration attempt.

 /* -*- Mode: Objective-C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 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/. */
 #import "mozActionElements.h"
 #import "MacUtils.h"
 #include "Accessible-inl.h"
 #include "DocAccessible.h"
 #include "XULTabAccessible.h"
 #include "nsDeckFrame.h"
 #include "nsObjCExceptions.h"
 using namespace mozilla::a11y;
 enum CheckboxValue {
   // these constants correspond to the values in the OS
   kUnchecked = 0,
   kChecked = 1,
   kMixed = 2
 };
 @implementation mozButtonAccessible
 - (NSArray*)accessibilityAttributeNames
 {
   NS_OBJC_BEGIN_TRY_ABORT_BLOCK_NIL;
   static NSArray *attributes = nil;
   if (!attributes) {
     attributes = [[NSArray alloc] initWithObjects:NSAccessibilityParentAttribute, // required
                                                   NSAccessibilityRoleAttribute, // required
                                                   NSAccessibilityRoleDescriptionAttribute,
                                                   NSAccessibilityPositionAttribute, // required
                                                   NSAccessibilitySizeAttribute, // required
                                                   NSAccessibilityWindowAttribute, // required
                                                   NSAccessibilityPositionAttribute, // required
                                                   NSAccessibilityTopLevelUIElementAttribute, // required
                                                   NSAccessibilityHelpAttribute,
                                                   NSAccessibilityEnabledAttribute, // required
                                                   NSAccessibilityFocusedAttribute, // required
                                                   NSAccessibilityTitleAttribute, // required
                                                   NSAccessibilityDescriptionAttribute,
 #if DEBUG
                                                   @"AXMozDescription",
 #endif
                                                   nil];
   }
   return attributes;
   NS_OBJC_END_TRY_ABORT_BLOCK_NIL;
 }
 - (id)accessibilityAttributeValue:(NSString *)attribute
 {
   NS_OBJC_BEGIN_TRY_ABORT_BLOCK_NIL;
   if ([attribute isEqualToString:NSAccessibilityChildrenAttribute])
     return nil;
   if ([attribute isEqualToString:NSAccessibilityRoleDescriptionAttribute]) {
     if ([self isTab])
       return utils::LocalizedString(NS_LITERAL_STRING("tab"));
     return NSAccessibilityRoleDescription([self role], nil);
   }
   return [super accessibilityAttributeValue:attribute];
   NS_OBJC_END_TRY_ABORT_BLOCK_NIL;
 }
 - (BOOL)accessibilityIsIgnored
 {
   return !mGeckoAccessible;
 }
 - (NSArray*)accessibilityActionNames
 {
   NS_OBJC_BEGIN_TRY_ABORT_BLOCK_NIL;
   if ([self isEnabled])
     return [NSArray arrayWithObject:NSAccessibilityPressAction];
   return nil;
   NS_OBJC_END_TRY_ABORT_BLOCK_NIL;
 }
 - (NSString*)accessibilityActionDescription:(NSString*)action
 {
   NS_OBJC_BEGIN_TRY_ABORT_BLOCK_NIL;
   if ([action isEqualToString:NSAccessibilityPressAction]) {
     if ([self isTab])
       return utils::LocalizedString(NS_LITERAL_STRING("switch"));
     return @"press button"; // XXX: localize this later?
   }
   return nil;
   NS_OBJC_END_TRY_ABORT_BLOCK_NIL;
 }
 - (void)accessibilityPerformAction:(NSString*)action
 {
   NS_OBJC_BEGIN_TRY_ABORT_BLOCK;
   if ([action isEqualToString:NSAccessibilityPressAction])
     [self click];
   NS_OBJC_END_TRY_ABORT_BLOCK;
 }
 - (void)click
 {
   // both buttons and checkboxes have only one action. we should really stop using arbitrary
   // arrays with actions, and define constants for these actions.
   mGeckoAccessible->DoAction(0);
 }
 - (BOOL)isTab
 {
   return (mGeckoAccessible && (mGeckoAccessible->Role() == roles::PAGETAB));
 }
 @end
 @implementation mozCheckboxAccessible
 - (NSString*)accessibilityActionDescription:(NSString*)action
 {
   NS_OBJC_BEGIN_TRY_ABORT_BLOCK_NIL;
   if ([action isEqualToString:NSAccessibilityPressAction]) {
     if ([self isChecked] != kUnchecked)
       return @"uncheck checkbox"; // XXX: localize this later?
     return @"check checkbox"; // XXX: localize this later?
   }
   return nil;
   NS_OBJC_END_TRY_ABORT_BLOCK_NIL;
 }
 - (int)isChecked
 {
   uint64_t state = mGeckoAccessible->NativeState();
   // check if we're checked or in a mixed state
   if (state & states::CHECKED) {
     return (state & states::MIXED) ? kMixed : kChecked;
   }
   return kUnchecked;
 }
 - (id)value
 {
   NS_OBJC_BEGIN_TRY_ABORT_BLOCK_NIL;
   return [NSNumber numberWithInt:[self isChecked]];
   NS_OBJC_END_TRY_ABORT_BLOCK_NIL;
 }
 @end
 @implementation mozPopupButtonAccessible
 - (NSArray *)accessibilityAttributeNames
 {
   NS_OBJC_BEGIN_TRY_ABORT_BLOCK_NIL;
   static NSArray *attributes = nil;
   if (!attributes) {
     attributes = [[NSArray alloc] initWithObjects:NSAccessibilityParentAttribute, // required
                                                   NSAccessibilityPositionAttribute, // required
                                                   NSAccessibilityRoleAttribute, // required
                                                   NSAccessibilitySizeAttribute, // required
                                                   NSAccessibilityWindowAttribute, // required
                                                   NSAccessibilityTopLevelUIElementAttribute, // required
                                                   NSAccessibilityHelpAttribute,
                                                   NSAccessibilityEnabledAttribute, // required
                                                   NSAccessibilityFocusedAttribute, // required
                                                   NSAccessibilityTitleAttribute, // required for popupmenus, and for menubuttons with a title
                                                   NSAccessibilityChildrenAttribute, // required
                                                   NSAccessibilityDescriptionAttribute, // required if it has no title attr
 #if DEBUG
                                                   @"AXMozDescription",
 #endif
                                                   nil];
   }
   return attributes;
   NS_OBJC_END_TRY_ABORT_BLOCK_NIL;
 }
 - (id)accessibilityAttributeValue:(NSString *)attribute
 {
   NS_OBJC_BEGIN_TRY_ABORT_BLOCK_NIL;
   if ([attribute isEqualToString:NSAccessibilityChildrenAttribute]) {
     return [super children];
   }
   return [super accessibilityAttributeValue:attribute];
   NS_OBJC_END_TRY_ABORT_BLOCK_NIL;
 }
 - (NSArray *)accessibilityActionNames
 {
   NS_OBJC_BEGIN_TRY_ABORT_BLOCK_NIL;
   if ([self isEnabled]) {
     return [NSArray arrayWithObjects:NSAccessibilityPressAction,
                                      NSAccessibilityShowMenuAction,
                                      nil];
   }
   return nil;
   NS_OBJC_END_TRY_ABORT_BLOCK_NIL;
 }
 - (NSString *)accessibilityActionDescription:(NSString *)action
 {
   NS_OBJC_BEGIN_TRY_ABORT_BLOCK_NIL;
   if ([action isEqualToString:NSAccessibilityShowMenuAction])
     return @"show menu";
   return [super accessibilityActionDescription:action];
   NS_OBJC_END_TRY_ABORT_BLOCK_NIL;
 }
 - (void)accessibilityPerformAction:(NSString *)action
 {
   NS_OBJC_BEGIN_TRY_ABORT_BLOCK;
   // both the ShowMenu and Click action do the same thing.
   if ([self isEnabled]) {
     // TODO: this should bring up the menu, but currently doesn't.
     //       once msaa and atk have merged better, they will implement
     //       the action needed to show the menu.
     [super click];
   }
   NS_OBJC_END_TRY_ABORT_BLOCK;
 }
 @end
 @implementation mozTabsAccessible
 - (void)dealloc
 {
   [mTabs release];
   [super dealloc];
 }
 - (NSArray*)accessibilityAttributeNames
 {
   // standard attributes that are shared and supported by root accessible (AXMain) elements.
   static NSMutableArray* attributes = nil;
   if (!attributes) {
     attributes = [[super accessibilityAttributeNames] mutableCopy];
     [attributes addObject:NSAccessibilityContentsAttribute];
     [attributes addObject:NSAccessibilityTabsAttribute];
   }
   return attributes;
 }
 - (id)accessibilityAttributeValue:(NSString *)attribute
 {
   if ([attribute isEqualToString:NSAccessibilityContentsAttribute])
     return [super children];
   if ([attribute isEqualToString:NSAccessibilityTabsAttribute])
     return [self tabs];
   return [super accessibilityAttributeValue:attribute];
 }
 /**
  * Returns the selected tab (the mozAccessible)
  */
 - (id)value
 {
   if (!mGeckoAccessible)
     return nil;
   Accessible* accessible = mGeckoAccessible->GetSelectedItem(0);
   if (!accessible)
     return nil;
   mozAccessible* nativeAcc = nil;
   nsresult rv = accessible->GetNativeInterface((void**)&nativeAcc);
   NS_ENSURE_SUCCESS(rv, nil);
   return nativeAcc;
 }
 /**
  * Return the mozAccessibles that are the tabs.
  */
 - (id)tabs
 {
   if (mTabs)
     return mTabs;
   NSArray* children = [self children];
   NSEnumerator* enumerator = [children objectEnumerator];
   mTabs = [[NSMutableArray alloc] init];
   id obj;
   while ((obj = [enumerator nextObject]))
     if ([obj isTab])
       [mTabs addObject:obj];
   return mTabs;
 }
 - (void)invalidateChildren
 {
   [super invalidateChildren];
   [mTabs release];
   mTabs = nil;
 }
 @end
 @implementation mozPaneAccessible
 - (NSUInteger)accessibilityArrayAttributeCount:(NSString*)attribute
 {
   if (!mGeckoAccessible)
     return 0;
   // By default this calls -[[mozAccessible children] count].
   // Since we don't cache mChildren. This is faster.
   if ([attribute isEqualToString:NSAccessibilityChildrenAttribute])
     return mGeckoAccessible->ChildCount() ? 1 : 0;
   return [super accessibilityArrayAttributeCount:attribute];
 }
 - (NSArray*)children
 {
   if (!mGeckoAccessible)
     return nil;
   nsDeckFrame* deckFrame = do_QueryFrame(mGeckoAccessible->GetFrame());
   nsIFrame* selectedFrame = deckFrame ? deckFrame->GetSelectedBox() : nullptr;
   Accessible* selectedAcc = nullptr;
   if (selectedFrame) {
     nsINode* node = selectedFrame->GetContent();
     selectedAcc = mGeckoAccessible->Document()->GetAccessible(node);
   }
   if (selectedAcc) {
     mozAccessible *curNative = GetNativeFromGeckoAccessible(selectedAcc);
     if (curNative)
       return [NSArray arrayWithObjects:GetObjectOrRepresentedView(curNative), nil];
   }
   return nil;
 }
 @end

The Tor Browser / annotate

accessible/src/mac/mozActionElements.mm@141e0f1194b1 (annotated)

accessible/src/mac/mozActionElements.mm