Landing Chris Guillory CL....

chrome/browser/browser_accessibility.cc

 // Copyright (c) 2006-2008 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "chrome/browser/browser_accessibility.h"
 
 #include "base/logging.h"
 #include "chrome/browser/browser_accessibility_manager.h"
 
 using webkit_glue::WebAccessibility;
@@ skipping 11 matching lines @@
   parent_hwnd_ = parent_hwnd;
 
   // Mark instance as active.
   instance_active_ = true;
   return S_OK;
 }
 
 HRESULT BrowserAccessibility::accDoDefaultAction(VARIANT var_id) {
   if (!instance_active()) {
     // Instance no longer active, fail gracefully.
-    // TODO(klink): Once we have MSAA events, change these fails to having
+    // TODO(ctguil): Once we have MSAA events, change these fails to having
     // BrowserAccessibilityManager firing the right event.
     return E_FAIL;
   }
 
   if (var_id.vt != VT_I4)
     return E_INVALIDARG;
 
   if (!RequestAccessibilityInfo(WebAccessibility::FUNCTION_DODEFAULTACTION,
                                 var_id, NULL, NULL)) {
     return E_FAIL;
   }
 
-  if (!response().return_code)
+  if (response().return_code == WebAccessibility::RETURNCODE_FALSE)
     return S_FALSE;
 
   return S_OK;
 }
 
 STDMETHODIMP BrowserAccessibility::accHitTest(LONG x_left, LONG y_top,
                                               VARIANT* child) {
   if (!instance_active()) {
     // Instance no longer active, fail gracefully.
     return E_FAIL;
   }
 
   if (!child)
     return E_INVALIDARG;
 
   if (!parent_hwnd_) {
     // Parent HWND needed for coordinate conversion.
     return E_FAIL;
   }
 
   // Convert coordinates to test from screen into client window coordinates, to
   // maintain sandbox functionality on renderer side.
   POINT p = {x_left, y_top};
   ::ScreenToClient(parent_hwnd_, &p);
 
   if (!RequestAccessibilityInfo(WebAccessibility::FUNCTION_HITTEST,
-                                EmptyVariant(), p.x, p.y)) {
+                                ChildSelfVariant(), p.x, p.y)) {
     return E_FAIL;
   }
 
-  if (!response().return_code) {
+  if (response().return_code == WebAccessibility::RETURNCODE_FALSE) {
     // The point is outside of the object's boundaries.
     child->vt = VT_EMPTY;
     return S_FALSE;
   }
 
   if (response().output_long1 == -1) {
     if (CreateInstance(IID_IAccessible, response().object_id,
                        reinterpret_cast<void**>(&child->pdispVal)) == S_OK) {
       child->vt = VT_DISPATCH;
       // Increment the reference count for the retrieved interface.
@@ skipping 62 matching lines @@
       nav_dir == NAVDIR_LEFT || nav_dir == NAVDIR_RIGHT) {
     // Directions not implemented, matching Mozilla and IE.
     return E_INVALIDARG;
   }
 
   if (!RequestAccessibilityInfo(WebAccessibility::FUNCTION_NAVIGATE, start,
                                 nav_dir, NULL)) {
     return E_FAIL;
   }
 
-  if (!response().return_code) {
+  if (response().return_code == WebAccessibility::RETURNCODE_FALSE) {
     // No screen element was found in the specified direction.
     end->vt = VT_EMPTY;
     return S_FALSE;
   }
 
   if (response().output_long1 == -1) {
     if (CreateInstance(IID_IAccessible, response().object_id,
                        reinterpret_cast<void**>(&end->pdispVal)) == S_OK) {
       end->vt = VT_DISPATCH;
       // Increment the reference count for the retrieved interface.
@@ skipping 21 matching lines @@
 
   // If var_child is the parent, remain with the same IDispatch.
   if (var_child.lVal == CHILDID_SELF && iaccessible_id_ != 1000)
     return S_OK;
 
   if (!RequestAccessibilityInfo(WebAccessibility::FUNCTION_GETCHILD, var_child,
                                 NULL, NULL)) {
     return E_FAIL;
   }
 
-  if (!response().return_code) {
+  // TODO(ctguil): Figure out when the return code would be false
+  if (response().return_code == WebAccessibility::RETURNCODE_FALSE) {
     // When at a leaf, children are handled by the parent object.
     *disp_child = NULL;
     return S_FALSE;
   }
 
   // Retrieve the IUnknown interface for the parent view, and assign the
   // IDispatch returned.
   if (CreateInstance(IID_IAccessible, response().object_id,
                      reinterpret_cast<void**>(disp_child)) == S_OK) {
     // Increment the reference count for the retrieved interface.
     (*disp_child)->AddRef();
     return S_OK;
   } else {
     return E_NOINTERFACE;
   }
 }
 
 STDMETHODIMP BrowserAccessibility::get_accChildCount(LONG* child_count) {
   if (!instance_active()) {
     // Instance no longer active, fail gracefully.
     return E_FAIL;
   }
 
   if (!child_count)
     return E_INVALIDARG;
 
   if (!RequestAccessibilityInfo(WebAccessibility::FUNCTION_CHILDCOUNT,
-                                EmptyVariant(), NULL, NULL)) {
+                                ChildSelfVariant(), NULL, NULL)) {
     return E_FAIL;
   }
 
   *child_count = response().output_long1;
   return S_OK;
 }
 
 STDMETHODIMP BrowserAccessibility::get_accDefaultAction(VARIANT var_id,
                                                         BSTR* def_action) {
   if (!instance_active()) {
     // Instance no longer active, fail gracefully.
     return E_FAIL;
   }
 
   if (var_id.vt != VT_I4 || !def_action)
     return E_INVALIDARG;
 
   if (!RequestAccessibilityInfo(WebAccessibility::FUNCTION_DEFAULTACTION,
                                 var_id, NULL, NULL)) {
     return E_FAIL;
   }
 
-  if (!response().return_code) {
+  if (response().return_code == WebAccessibility::RETURNCODE_FALSE) {
     // No string found.
     return S_FALSE;
   }
 
   *def_action = SysAllocString(response().output_string.c_str());
 
   DCHECK(*def_action);
   return S_OK;
 }
 
 STDMETHODIMP BrowserAccessibility::get_accDescription(VARIANT var_id,
                                                       BSTR* desc) {
   if (!instance_active()) {
     // Instance no longer active, fail gracefully.
     return E_FAIL;
   }
 
   if (var_id.vt != VT_I4 || !desc)
     return E_INVALIDARG;
 
   if (!RequestAccessibilityInfo(WebAccessibility::FUNCTION_DESCRIPTION, var_id,
                                 NULL, NULL)) {
     return E_FAIL;
   }
 
-  if (!response().return_code) {
+  if (response().return_code == WebAccessibility::RETURNCODE_FALSE) {
     // No string found.
     return S_FALSE;
   }
 
   *desc = SysAllocString(response().output_string.c_str());
 
   DCHECK(*desc);
   return S_OK;
 }
 
 STDMETHODIMP BrowserAccessibility::get_accFocus(VARIANT* focus_child) {
   if (!instance_active()) {
     // Instance no longer active, fail gracefully.
     return E_FAIL;
   }
 
   if (!focus_child)
     return E_INVALIDARG;
 
   if (!RequestAccessibilityInfo(WebAccessibility::FUNCTION_GETFOCUSEDCHILD,
-                                EmptyVariant(), NULL, NULL)) {
+                                ChildSelfVariant(), NULL, NULL)) {
     return E_FAIL;
   }
 
-  if (!response().return_code) {
+  if (response().return_code == WebAccessibility::RETURNCODE_FALSE) {
     // The window that contains this object is not the active window.
     focus_child->vt = VT_EMPTY;
     return S_FALSE;
   }
 
   if (response().output_long1 == -1) {
     if (CreateInstance(IID_IAccessible, response().object_id,
            reinterpret_cast<void**>(&focus_child->pdispVal)) == S_OK) {
       focus_child->vt = VT_DISPATCH;
       // Increment the reference count for the retrieved interface.
@@ skipping 16 matching lines @@
   }
 
   if (var_id.vt != VT_I4 || !help)
     return E_INVALIDARG;
 
   if (!RequestAccessibilityInfo(WebAccessibility::FUNCTION_HELPTEXT, var_id,
                                 NULL, NULL)) {
     return E_FAIL;
   }
 
-  if (!response().return_code || response().output_string.empty()) {
+  if (response().return_code == WebAccessibility::RETURNCODE_FALSE ||
+      response().output_string.empty()) {
     // No string found.
     return S_FALSE;
   }
 
   *help = SysAllocString(response().output_string.c_str());
 
   DCHECK(*help);
   return S_OK;
 }
 
 STDMETHODIMP BrowserAccessibility::get_accKeyboardShortcut(VARIANT var_id,
                                                            BSTR* acc_key) {
   if (!instance_active()) {
     // Instance no longer active, fail gracefully.
     return E_FAIL;
   }
 
   if (var_id.vt != VT_I4 || !acc_key)
     return E_INVALIDARG;
 
   if (!RequestAccessibilityInfo(WebAccessibility::FUNCTION_KEYBOARDSHORTCUT,
                                 var_id, NULL, NULL)) {
     return E_FAIL;
   }
 
-  if (!response().return_code) {
+  if (response().return_code == WebAccessibility::RETURNCODE_FALSE) {
     // No string found.
     return S_FALSE;
   }
 
   *acc_key = SysAllocString(response().output_string.c_str());
 
   DCHECK(*acc_key);
   return S_OK;
 }
 
 STDMETHODIMP BrowserAccessibility::get_accName(VARIANT var_id, BSTR* name) {
   if (!instance_active()) {
     // Instance no longer active, fail gracefully.
     return E_FAIL;
   }
 
   if (var_id.vt != VT_I4 || !name)
     return E_INVALIDARG;
 
   if (!RequestAccessibilityInfo(WebAccessibility::FUNCTION_NAME, var_id, NULL,
                                 NULL)) {
     return E_FAIL;
   }
 
-  if (!response().return_code) {
+  if (response().return_code == WebAccessibility::RETURNCODE_FALSE) {
     // No string found.
     return S_FALSE;
   }
 
   *name = SysAllocString(response().output_string.c_str());
 
   DCHECK(*name);
   return S_OK;
 }
 
@@ skipping 16 matching lines @@
                                     reinterpret_cast<void**>(disp_parent));
 
     if (!SUCCEEDED(hr)) {
       *disp_parent = NULL;
       return S_FALSE;
     }
     return S_OK;
   }
 
   if (!RequestAccessibilityInfo(WebAccessibility::FUNCTION_GETPARENT,
-                                EmptyVariant(), NULL, NULL)) {
+                                ChildSelfVariant(), NULL, NULL)) {
     return E_FAIL;
   }
 
-  if (!response().return_code) {
+  if (response().return_code == WebAccessibility::RETURNCODE_FALSE) {
     // No parent exists for this object.
     return S_FALSE;
   }
 
   // Retrieve the IUnknown interface for the parent view, and assign the
   // IDispatch returned.
   if (CreateInstance(IID_IAccessible, response().object_id,
                      reinterpret_cast<void**>(disp_parent)) == S_OK) {
     // Increment the reference count for the retrieved interface.
     (*disp_parent)->AddRef();
@@ skipping 49 matching lines @@
   }
 
   if (var_id.vt != VT_I4 || !value)
     return E_INVALIDARG;
 
   if (!RequestAccessibilityInfo(WebAccessibility::FUNCTION_VALUE, var_id, NULL,
                                 NULL)) {
     return E_FAIL;
   }
 
-  if (!response().return_code || response().output_string.empty()) {
+  if (response().return_code == WebAccessibility::RETURNCODE_FALSE ||
+      response().output_string.empty()) {
     // No string found.
     return S_FALSE;
   }
 
   *value = SysAllocString(response().output_string.c_str());
 
   DCHECK(*value);
   return S_OK;
 }
 
@@ skipping 20 matching lines @@
                                                   int iaccessible_id,
                                                   void** interface_ptr) {
   return BrowserAccessibilityManager::GetInstance()->
       CreateAccessibilityInstance(iid, iaccessible_id, routing_id_,
                                   process_id_, parent_hwnd_, interface_ptr);
 }
 
 bool BrowserAccessibility::RequestAccessibilityInfo(int iaccessible_func_id,
                                                     VARIANT var_id, LONG input1,
                                                     LONG input2) {
+  DCHECK(V_VT(&var_id) == VT_I4);
+
   // Create and populate IPC message structure, for retrieval of accessibility
   // information from the renderer.
   WebAccessibility::InParams in_params;
   in_params.object_id = iaccessible_id_;
   in_params.function_id = iaccessible_func_id;
-  in_params.child_id = var_id.lVal;
+  in_params.child_id = V_I4(&var_id);
   in_params.input_long1 = input1;
   in_params.input_long2 = input2;
 
   return BrowserAccessibilityManager::GetInstance()->
-      RequestAccessibilityInfo(&in_params, routing_id_, process_id_);
+           RequestAccessibilityInfo(&in_params, routing_id_, process_id_) &&
+         response().return_code != WebAccessibility::RETURNCODE_FAIL;
 }
 
 const WebAccessibility::OutParams& BrowserAccessibility::response() {
   return BrowserAccessibilityManager::GetInstance()->response();
 }
 
 long BrowserAccessibility::MSAARole(long browser_accessibility_role) {
   switch (browser_accessibility_role) {
     case WebAccessibility::ROLE_APPLICATION:
       return ROLE_SYSTEM_APPLICATION;
@@ skipping 102 matching lines @@
     state |= STATE_SYSTEM_READONLY;
 
   if ((browser_accessibility_state >> WebAccessibility::STATE_TRAVERSED) & 1)
     state |= STATE_SYSTEM_TRAVERSED;
 
   if ((browser_accessibility_state >> WebAccessibility::STATE_UNAVAILABLE) & 1)
     state |= STATE_SYSTEM_UNAVAILABLE;
 
   return state;
 }