content/browser/accessibility/browser_accessibility_win.h

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef CONTENT_BROWSER_ACCESSIBILITY_BROWSER_ACCESSIBILITY_WIN_H_
   6 #define CONTENT_BROWSER_ACCESSIBILITY_BROWSER_ACCESSIBILITY_WIN_H_
   7
   8 #include <atlbase.h>
   9 #include <atlcom.h>
  10 #include <oleacc.h>
  11 #include <UIAutomationCore.h>
  12
  13 #include <vector>
  14
  15 #include "base/compiler_specific.h"
  16 #include "content/browser/accessibility/browser_accessibility.h"
  17 #include "content/common/content_export.h"
  18 #include "third_party/iaccessible2/ia2_api_all.h"
  19 #include "third_party/isimpledom/ISimpleDOMDocument.h"
  20 #include "third_party/isimpledom/ISimpleDOMNode.h"
  21 #include "third_party/isimpledom/ISimpleDOMText.h"
  22
  23 namespace ui {
  24 enum TextBoundaryDirection;
  25 enum TextBoundaryType;
  26 }
  27
  28 namespace content {
  29 class BrowserAccessibilityRelation;
  30
  31 ////////////////////////////////////////////////////////////////////////////////
  32 //
  33 // BrowserAccessibilityWin
  34 //
  35 // Class implementing the windows accessible interface for the Browser-Renderer
  36 // communication of accessibility information, providing accessibility
  37 // to be used by screen readers and other assistive technology (AT).
  38 //
  39 ////////////////////////////////////////////////////////////////////////////////
  40 class __declspec(uuid("562072fe-3390-43b1-9e2c-dd4118f5ac79"))
  41 BrowserAccessibilityWin
  42     : public BrowserAccessibility,
  43       public CComObjectRootEx<CComMultiThreadModel>,
  44       public IDispatchImpl<IAccessible2, &IID_IAccessible2,
  45                            &LIBID_IAccessible2Lib>,
  46       public IAccessibleApplication,
  47       public IAccessibleHyperlink,
  48       public IAccessibleHypertext,
  49       public IAccessibleImage,
  50       public IAccessibleTable,
  51       public IAccessibleTable2,
  52       public IAccessibleTableCell,
  53       public IAccessibleValue,
  54       public IServiceProvider,
  55       public ISimpleDOMDocument,
  56       public ISimpleDOMNode,
  57       public ISimpleDOMText,
  58       public IAccessibleEx,
  59       public IRawElementProviderSimple {
  60  public:
  61   BEGIN_COM_MAP(BrowserAccessibilityWin)
  62     COM_INTERFACE_ENTRY2(IDispatch, IAccessible2)
  63     COM_INTERFACE_ENTRY(IAccessible)
  64     COM_INTERFACE_ENTRY(IAccessible2)
  65     COM_INTERFACE_ENTRY(IAccessibleApplication)
  66     COM_INTERFACE_ENTRY(IAccessibleEx)
  67     COM_INTERFACE_ENTRY(IAccessibleHyperlink)
  68     COM_INTERFACE_ENTRY(IAccessibleHypertext)
  69     COM_INTERFACE_ENTRY(IAccessibleImage)
  70     COM_INTERFACE_ENTRY(IAccessibleTable)
  71     COM_INTERFACE_ENTRY(IAccessibleTable2)
  72     COM_INTERFACE_ENTRY(IAccessibleTableCell)
  73     COM_INTERFACE_ENTRY(IAccessibleText)
  74     COM_INTERFACE_ENTRY(IAccessibleValue)
  75     COM_INTERFACE_ENTRY(IRawElementProviderSimple)
  76     COM_INTERFACE_ENTRY(IServiceProvider)
  77     COM_INTERFACE_ENTRY(ISimpleDOMDocument)
  78     COM_INTERFACE_ENTRY(ISimpleDOMNode)
  79     COM_INTERFACE_ENTRY(ISimpleDOMText)
  80   END_COM_MAP()
  81
  82   // Represents a non-static text node in IAccessibleHypertext. This character
  83   // is embedded in the response to IAccessibleText::get_text, indicating the
  84   // position where a non-static text child object appears.
  85   CONTENT_EXPORT static const base::char16 kEmbeddedCharacter;
  86
  87   // Mappings from roles and states to human readable strings. Initialize
  88   // with |InitializeStringMaps|.
  89   static std::map<int32, base::string16> role_string_map;
  90   static std::map<int32, base::string16> state_string_map;
  91
  92   CONTENT_EXPORT BrowserAccessibilityWin();
  93
  94   CONTENT_EXPORT virtual ~BrowserAccessibilityWin();
  95
  96   // The Windows-specific unique ID, used as the child ID for MSAA methods
  97   // like NotifyWinEvent, and as the unique ID for IAccessible2 and ISimpleDOM.
  98   LONG unique_id_win() const { return unique_id_win_; }
  99
 100   // Called after an atomic tree update completes. See
 101   // BrowserAccessibilityManagerWin::OnAtomicUpdateFinished for more
 102   // details on what these do.
 103   CONTENT_EXPORT void UpdateStep1ComputeWinAttributes();
 104   CONTENT_EXPORT void UpdateStep2ComputeHypertext();
 105   CONTENT_EXPORT void UpdateStep3FireEvents(bool is_subtree_creation);
 106   CONTENT_EXPORT void UpdateStep4DeleteOldWinAttributes();
 107
 108   //
 109   // BrowserAccessibility methods.
 110   //
 111   CONTENT_EXPORT virtual void OnSubtreeWillBeDeleted() override;
 112   CONTENT_EXPORT virtual void NativeAddReference() override;
 113   CONTENT_EXPORT virtual void NativeReleaseReference() override;
 114   CONTENT_EXPORT virtual bool IsNative() const override;
 115   CONTENT_EXPORT virtual void OnLocationChanged() override;
 116
 117   //
 118   // IAccessible methods.
 119   //
 120
 121   // Performs the default action on a given object.
 122   CONTENT_EXPORT STDMETHODIMP accDoDefaultAction(VARIANT var_id) override;
 123
 124   // Retrieves the child element or child object at a given point on the screen.
 125   CONTENT_EXPORT STDMETHODIMP
 126   accHitTest(LONG x_left, LONG y_top, VARIANT* child) override;
 127
 128   // Retrieves the specified object's current screen location.
 129   CONTENT_EXPORT STDMETHODIMP accLocation(LONG* x_left,
 130                                           LONG* y_top,
 131                                           LONG* width,
 132                                           LONG* height,
 133                                           VARIANT var_id) override;
 134
 135   // Traverses to another UI element and retrieves the object.
 136   CONTENT_EXPORT STDMETHODIMP
 137   accNavigate(LONG nav_dir, VARIANT start, VARIANT* end) override;
 138
 139   // Retrieves an IDispatch interface pointer for the specified child.
 140   CONTENT_EXPORT STDMETHODIMP
 141   get_accChild(VARIANT var_child, IDispatch** disp_child) override;
 142
 143   // Retrieves the number of accessible children.
 144   CONTENT_EXPORT STDMETHODIMP get_accChildCount(LONG* child_count) override;
 145
 146   // Retrieves a string that describes the object's default action.
 147   CONTENT_EXPORT STDMETHODIMP
 148   get_accDefaultAction(VARIANT var_id, BSTR* default_action) override;
 149
 150   // Retrieves the object's description.
 151   CONTENT_EXPORT STDMETHODIMP
 152   get_accDescription(VARIANT var_id, BSTR* desc) override;
 153
 154   // Retrieves the object that has the keyboard focus.
 155   CONTENT_EXPORT STDMETHODIMP get_accFocus(VARIANT* focus_child) override;
 156
 157   // Retrieves the help information associated with the object.
 158   CONTENT_EXPORT STDMETHODIMP get_accHelp(VARIANT var_id, BSTR* heflp) override;
 159
 160   // Retrieves the specified object's shortcut.
 161   CONTENT_EXPORT STDMETHODIMP
 162   get_accKeyboardShortcut(VARIANT var_id, BSTR* access_key) override;
 163
 164   // Retrieves the name of the specified object.
 165   CONTENT_EXPORT STDMETHODIMP get_accName(VARIANT var_id, BSTR* name) override;
 166
 167   // Retrieves the IDispatch interface of the object's parent.
 168   CONTENT_EXPORT STDMETHODIMP get_accParent(IDispatch** disp_parent) override;
 169
 170   // Retrieves information describing the role of the specified object.
 171   CONTENT_EXPORT STDMETHODIMP
 172   get_accRole(VARIANT var_id, VARIANT* role) override;
 173
 174   // Retrieves the current state of the specified object.
 175   CONTENT_EXPORT STDMETHODIMP
 176   get_accState(VARIANT var_id, VARIANT* state) override;
 177
 178   // Returns the value associated with the object.
 179   CONTENT_EXPORT STDMETHODIMP
 180   get_accValue(VARIANT var_id, BSTR* value) override;
 181
 182   // Make an object take focus or extend the selection.
 183   CONTENT_EXPORT STDMETHODIMP
 184   accSelect(LONG flags_sel, VARIANT var_id) override;
 185
 186   CONTENT_EXPORT STDMETHODIMP
 187   get_accHelpTopic(BSTR* help_file, VARIANT var_id, LONG* topic_id) override;
 188
 189   CONTENT_EXPORT STDMETHODIMP get_accSelection(VARIANT* selected) override;
 190
 191   // Deprecated methods, not implemented.
 192   CONTENT_EXPORT STDMETHODIMP
 193   put_accName(VARIANT var_id, BSTR put_name) override {
 194     return E_NOTIMPL;
 195   }
 196   CONTENT_EXPORT STDMETHODIMP
 197   put_accValue(VARIANT var_id, BSTR put_val) override {
 198     return E_NOTIMPL;
 199   }
 200
 201   //
 202   // IAccessible2 methods.
 203   //
 204
 205   // Returns role from a longer list of possible roles.
 206   CONTENT_EXPORT STDMETHODIMP role(LONG* role) override;
 207
 208   // Returns the state bitmask from a larger set of possible states.
 209   CONTENT_EXPORT STDMETHODIMP get_states(AccessibleStates* states) override;
 210
 211   // Returns the attributes specific to this IAccessible2 object,
 212   // such as a cell's formula.
 213   CONTENT_EXPORT STDMETHODIMP get_attributes(BSTR* attributes) override;
 214
 215   // Get the unique ID of this object so that the client knows if it's
 216   // been encountered previously.
 217   CONTENT_EXPORT STDMETHODIMP get_uniqueID(LONG* unique_id) override;
 218
 219   // Get the window handle of the enclosing window.
 220   CONTENT_EXPORT STDMETHODIMP get_windowHandle(HWND* window_handle) override;
 221
 222   // Get this object's index in its parent object.
 223   CONTENT_EXPORT STDMETHODIMP get_indexInParent(LONG* index_in_parent) override;
 224
 225   CONTENT_EXPORT STDMETHODIMP get_nRelations(LONG* n_relations) override;
 226
 227   CONTENT_EXPORT STDMETHODIMP
 228   get_relation(LONG relation_index, IAccessibleRelation** relation) override;
 229
 230   CONTENT_EXPORT STDMETHODIMP get_relations(LONG max_relations,
 231                                             IAccessibleRelation** relations,
 232                                             LONG* n_relations) override;
 233
 234   CONTENT_EXPORT STDMETHODIMP scrollTo(enum IA2ScrollType scroll_type) override;
 235
 236   CONTENT_EXPORT STDMETHODIMP
 237   scrollToPoint(enum IA2CoordinateType coordinate_type,
 238                 LONG x,
 239                 LONG y) override;
 240
 241   CONTENT_EXPORT STDMETHODIMP
 242   get_groupPosition(LONG* group_level,
 243                     LONG* similar_items_in_group,
 244                     LONG* position_in_group) override;
 245
 246   //
 247   // IAccessibleEx methods not implemented.
 248   //
 249   CONTENT_EXPORT STDMETHODIMP get_extendedRole(BSTR* extended_role) override {
 250     return E_NOTIMPL;
 251   }
 252   CONTENT_EXPORT STDMETHODIMP
 253   get_localizedExtendedRole(BSTR* localized_extended_role) override {
 254     return E_NOTIMPL;
 255   }
 256   CONTENT_EXPORT STDMETHODIMP
 257   get_nExtendedStates(LONG* n_extended_states) override {
 258     return E_NOTIMPL;
 259   }
 260   CONTENT_EXPORT STDMETHODIMP
 261   get_extendedStates(LONG max_extended_states,
 262                      BSTR** extended_states,
 263                      LONG* n_extended_states) override {
 264     return E_NOTIMPL;
 265   }
 266   CONTENT_EXPORT STDMETHODIMP
 267   get_localizedExtendedStates(LONG max_localized_extended_states,
 268                               BSTR** localized_extended_states,
 269                               LONG* n_localized_extended_states) override {
 270     return E_NOTIMPL;
 271   }
 272   CONTENT_EXPORT STDMETHODIMP get_locale(IA2Locale* locale) override {
 273     return E_NOTIMPL;
 274   }
 275
 276   //
 277   // IAccessibleApplication methods.
 278   //
 279   CONTENT_EXPORT STDMETHODIMP get_appName(BSTR* app_name) override;
 280
 281   CONTENT_EXPORT STDMETHODIMP get_appVersion(BSTR* app_version) override;
 282
 283   CONTENT_EXPORT STDMETHODIMP get_toolkitName(BSTR* toolkit_name) override;
 284
 285   CONTENT_EXPORT STDMETHODIMP
 286   get_toolkitVersion(BSTR* toolkit_version) override;
 287
 288   //
 289   // IAccessibleImage methods.
 290   //
 291   CONTENT_EXPORT STDMETHODIMP get_description(BSTR* description) override;
 292
 293   CONTENT_EXPORT STDMETHODIMP
 294   get_imagePosition(enum IA2CoordinateType coordinate_type,
 295                     LONG* x,
 296                     LONG* y) override;
 297
 298   CONTENT_EXPORT STDMETHODIMP get_imageSize(LONG* height, LONG* width) override;
 299
 300   //
 301   // IAccessibleTable methods.
 302   //
 303
 304   // get_description - also used by IAccessibleImage
 305
 306   CONTENT_EXPORT STDMETHODIMP
 307   get_accessibleAt(long row, long column, IUnknown** accessible) override;
 308
 309   CONTENT_EXPORT STDMETHODIMP get_caption(IUnknown** accessible) override;
 310
 311   CONTENT_EXPORT STDMETHODIMP
 312   get_childIndex(long row_index, long column_index, long* cell_index) override;
 313
 314   CONTENT_EXPORT STDMETHODIMP
 315   get_columnDescription(long column, BSTR* description) override;
 316
 317   CONTENT_EXPORT STDMETHODIMP
 318   get_columnExtentAt(long row, long column, long* n_columns_spanned) override;
 319
 320   CONTENT_EXPORT STDMETHODIMP
 321   get_columnHeader(IAccessibleTable** accessible_table,
 322                    long* starting_row_index) override;
 323
 324   CONTENT_EXPORT STDMETHODIMP
 325   get_columnIndex(long cell_index, long* column_index) override;
 326
 327   CONTENT_EXPORT STDMETHODIMP get_nColumns(long* column_count) override;
 328
 329   CONTENT_EXPORT STDMETHODIMP get_nRows(long* row_count) override;
 330
 331   CONTENT_EXPORT STDMETHODIMP get_nSelectedChildren(long* cell_count) override;
 332
 333   CONTENT_EXPORT STDMETHODIMP get_nSelectedColumns(long* column_count) override;
 334
 335   CONTENT_EXPORT STDMETHODIMP get_nSelectedRows(long* row_count) override;
 336
 337   CONTENT_EXPORT STDMETHODIMP
 338   get_rowDescription(long row, BSTR* description) override;
 339
 340   CONTENT_EXPORT STDMETHODIMP
 341   get_rowExtentAt(long row, long column, long* n_rows_spanned) override;
 342
 343   CONTENT_EXPORT STDMETHODIMP
 344   get_rowHeader(IAccessibleTable** accessible_table,
 345                 long* starting_column_index) override;
 346
 347   CONTENT_EXPORT STDMETHODIMP
 348   get_rowIndex(long cell_index, long* row_index) override;
 349
 350   CONTENT_EXPORT STDMETHODIMP get_selectedChildren(long max_children,
 351                                                    long** children,
 352                                                    long* n_children) override;
 353
 354   CONTENT_EXPORT STDMETHODIMP get_selectedColumns(long max_columns,
 355                                                   long** columns,
 356                                                   long* n_columns) override;
 357
 358   CONTENT_EXPORT STDMETHODIMP
 359   get_selectedRows(long max_rows, long** rows, long* n_rows) override;
 360
 361   CONTENT_EXPORT STDMETHODIMP get_summary(IUnknown** accessible) override;
 362
 363   CONTENT_EXPORT STDMETHODIMP
 364   get_isColumnSelected(long column, boolean* is_selected) override;
 365
 366   CONTENT_EXPORT STDMETHODIMP
 367   get_isRowSelected(long row, boolean* is_selected) override;
 368
 369   CONTENT_EXPORT STDMETHODIMP
 370   get_isSelected(long row, long column, boolean* is_selected) override;
 371
 372   CONTENT_EXPORT STDMETHODIMP
 373   get_rowColumnExtentsAtIndex(long index,
 374                               long* row,
 375                               long* column,
 376                               long* row_extents,
 377                               long* column_extents,
 378                               boolean* is_selected) override;
 379
 380   CONTENT_EXPORT STDMETHODIMP selectRow(long row) override { return E_NOTIMPL; }
 381
 382   CONTENT_EXPORT STDMETHODIMP selectColumn(long column) override {
 383     return E_NOTIMPL;
 384   }
 385
 386   CONTENT_EXPORT STDMETHODIMP unselectRow(long row) override {
 387     return E_NOTIMPL;
 388   }
 389
 390   CONTENT_EXPORT STDMETHODIMP unselectColumn(long column) override {
 391     return E_NOTIMPL;
 392   }
 393
 394   CONTENT_EXPORT STDMETHODIMP
 395   get_modelChange(IA2TableModelChange* model_change) override {
 396     return E_NOTIMPL;
 397   }
 398
 399   //
 400   // IAccessibleTable2 methods.
 401   //
 402   // (Most of these are duplicates of IAccessibleTable methods, only the
 403   // unique ones are included here.)
 404   //
 405
 406   CONTENT_EXPORT STDMETHODIMP
 407   get_cellAt(long row, long column, IUnknown** cell) override;
 408
 409   CONTENT_EXPORT STDMETHODIMP get_nSelectedCells(long* cell_count) override;
 410
 411   CONTENT_EXPORT STDMETHODIMP
 412   get_selectedCells(IUnknown*** cells, long* n_selected_cells) override;
 413
 414   CONTENT_EXPORT STDMETHODIMP
 415   get_selectedColumns(long** columns, long* n_columns) override;
 416
 417   CONTENT_EXPORT STDMETHODIMP
 418   get_selectedRows(long** rows, long* n_rows) override;
 419
 420   //
 421   // IAccessibleTableCell methods.
 422   //
 423
 424   CONTENT_EXPORT STDMETHODIMP
 425   get_columnExtent(long* n_columns_spanned) override;
 426
 427   CONTENT_EXPORT STDMETHODIMP
 428   get_columnHeaderCells(IUnknown*** cell_accessibles,
 429                         long* n_column_header_cells) override;
 430
 431   CONTENT_EXPORT STDMETHODIMP get_columnIndex(long* column_index) override;
 432
 433   CONTENT_EXPORT STDMETHODIMP get_rowExtent(long* n_rows_spanned) override;
 434
 435   CONTENT_EXPORT STDMETHODIMP
 436   get_rowHeaderCells(IUnknown*** cell_accessibles,
 437                      long* n_row_header_cells) override;
 438
 439   CONTENT_EXPORT STDMETHODIMP get_rowIndex(long* row_index) override;
 440
 441   CONTENT_EXPORT STDMETHODIMP get_isSelected(boolean* is_selected) override;
 442
 443   CONTENT_EXPORT STDMETHODIMP
 444   get_rowColumnExtents(long* row,
 445                        long* column,
 446                        long* row_extents,
 447                        long* column_extents,
 448                        boolean* is_selected) override;
 449
 450   CONTENT_EXPORT STDMETHODIMP get_table(IUnknown** table) override;
 451
 452   //
 453   // IAccessibleText methods.
 454   //
 455
 456   CONTENT_EXPORT STDMETHODIMP get_nCharacters(LONG* n_characters) override;
 457
 458   CONTENT_EXPORT STDMETHODIMP get_caretOffset(LONG* offset) override;
 459
 460   CONTENT_EXPORT STDMETHODIMP
 461   get_characterExtents(LONG offset,
 462                        enum IA2CoordinateType coord_type,
 463                        LONG* out_x,
 464                        LONG* out_y,
 465                        LONG* out_width,
 466                        LONG* out_height) override;
 467
 468   CONTENT_EXPORT STDMETHODIMP get_nSelections(LONG* n_selections) override;
 469
 470   CONTENT_EXPORT STDMETHODIMP get_selection(LONG selection_index,
 471                                             LONG* start_offset,
 472                                             LONG* end_offset) override;
 473
 474   CONTENT_EXPORT STDMETHODIMP
 475   get_text(LONG start_offset, LONG end_offset, BSTR* text) override;
 476
 477   CONTENT_EXPORT STDMETHODIMP
 478   get_textAtOffset(LONG offset,
 479                    enum IA2TextBoundaryType boundary_type,
 480                    LONG* start_offset,
 481                    LONG* end_offset,
 482                    BSTR* text) override;
 483
 484   CONTENT_EXPORT STDMETHODIMP
 485   get_textBeforeOffset(LONG offset,
 486                        enum IA2TextBoundaryType boundary_type,
 487                        LONG* start_offset,
 488                        LONG* end_offset,
 489                        BSTR* text) override;
 490
 491   CONTENT_EXPORT STDMETHODIMP
 492   get_textAfterOffset(LONG offset,
 493                       enum IA2TextBoundaryType boundary_type,
 494                       LONG* start_offset,
 495                       LONG* end_offset,
 496                       BSTR* text) override;
 497
 498   CONTENT_EXPORT STDMETHODIMP get_newText(IA2TextSegment* new_text) override;
 499
 500   CONTENT_EXPORT STDMETHODIMP get_oldText(IA2TextSegment* old_text) override;
 501
 502   CONTENT_EXPORT STDMETHODIMP
 503   get_offsetAtPoint(LONG x,
 504                     LONG y,
 505                     enum IA2CoordinateType coord_type,
 506                     LONG* offset) override;
 507
 508   CONTENT_EXPORT STDMETHODIMP
 509   scrollSubstringTo(LONG start_index,
 510                     LONG end_index,
 511                     enum IA2ScrollType scroll_type) override;
 512
 513   CONTENT_EXPORT STDMETHODIMP
 514   scrollSubstringToPoint(LONG start_index,
 515                          LONG end_index,
 516                          enum IA2CoordinateType coordinate_type,
 517                          LONG x,
 518                          LONG y) override;
 519
 520   CONTENT_EXPORT STDMETHODIMP
 521   addSelection(LONG start_offset, LONG end_offset) override;
 522
 523   CONTENT_EXPORT STDMETHODIMP removeSelection(LONG selection_index) override;
 524
 525   CONTENT_EXPORT STDMETHODIMP setCaretOffset(LONG offset) override;
 526
 527   CONTENT_EXPORT STDMETHODIMP setSelection(LONG selection_index,
 528                                            LONG start_offset,
 529                                            LONG end_offset) override;
 530
 531   // IAccessibleText methods not implemented.
 532   CONTENT_EXPORT STDMETHODIMP get_attributes(LONG offset,
 533                                              LONG* start_offset,
 534                                              LONG* end_offset,
 535                                              BSTR* text_attributes) override {
 536     return E_NOTIMPL;
 537   }
 538
 539   //
 540   // IAccessibleHypertext methods.
 541   //
 542
 543   CONTENT_EXPORT STDMETHODIMP get_nHyperlinks(long* hyperlink_count) override;
 544
 545   CONTENT_EXPORT STDMETHODIMP
 546   get_hyperlink(long index, IAccessibleHyperlink** hyperlink) override;
 547
 548   CONTENT_EXPORT STDMETHODIMP
 549   get_hyperlinkIndex(long char_index, long* hyperlink_index) override;
 550
 551   // IAccessibleHyperlink not implemented.
 552   CONTENT_EXPORT STDMETHODIMP get_anchor(long index, VARIANT* anchor) override {
 553     return E_NOTIMPL;
 554   }
 555   CONTENT_EXPORT STDMETHODIMP
 556   get_anchorTarget(long index, VARIANT* anchor_target) override {
 557     return E_NOTIMPL;
 558   }
 559   CONTENT_EXPORT STDMETHODIMP get_startIndex(long* index) override {
 560     return E_NOTIMPL;
 561   }
 562   CONTENT_EXPORT STDMETHODIMP get_endIndex(long* index) override {
 563     return E_NOTIMPL;
 564   }
 565   CONTENT_EXPORT STDMETHODIMP get_valid(boolean* valid) override {
 566     return E_NOTIMPL;
 567   }
 568
 569   // IAccessibleAction not implemented.
 570   CONTENT_EXPORT STDMETHODIMP nActions(long* n_actions) override {
 571     return E_NOTIMPL;
 572   }
 573   CONTENT_EXPORT STDMETHODIMP doAction(long action_index) override {
 574     return E_NOTIMPL;
 575   }
 576   CONTENT_EXPORT STDMETHODIMP
 577   get_description(long action_index, BSTR* description) override {
 578     return E_NOTIMPL;
 579   }
 580   CONTENT_EXPORT STDMETHODIMP get_keyBinding(long action_index,
 581                                              long n_max_bindings,
 582                                              BSTR** key_bindings,
 583                                              long* n_bindings) override {
 584     return E_NOTIMPL;
 585   }
 586   CONTENT_EXPORT STDMETHODIMP get_name(long action_index, BSTR* name) override {
 587     return E_NOTIMPL;
 588   }
 589   CONTENT_EXPORT STDMETHODIMP
 590   get_localizedName(long action_index, BSTR* localized_name) override {
 591     return E_NOTIMPL;
 592   }
 593
 594   //
 595   // IAccessibleValue methods.
 596   //
 597
 598   CONTENT_EXPORT STDMETHODIMP get_currentValue(VARIANT* value) override;
 599
 600   CONTENT_EXPORT STDMETHODIMP get_minimumValue(VARIANT* value) override;
 601
 602   CONTENT_EXPORT STDMETHODIMP get_maximumValue(VARIANT* value) override;
 603
 604   CONTENT_EXPORT STDMETHODIMP setCurrentValue(VARIANT new_value) override;
 605
 606   //
 607   // ISimpleDOMDocument methods.
 608   //
 609
 610   CONTENT_EXPORT STDMETHODIMP get_URL(BSTR* url) override;
 611
 612   CONTENT_EXPORT STDMETHODIMP get_title(BSTR* title) override;
 613
 614   CONTENT_EXPORT STDMETHODIMP get_mimeType(BSTR* mime_type) override;
 615
 616   CONTENT_EXPORT STDMETHODIMP get_docType(BSTR* doc_type) override;
 617
 618   CONTENT_EXPORT STDMETHODIMP
 619   get_nameSpaceURIForID(short name_space_id, BSTR* name_space_uri) override {
 620     return E_NOTIMPL;
 621   }
 622   CONTENT_EXPORT STDMETHODIMP
 623   put_alternateViewMediaTypes(BSTR* comma_separated_media_types) override {
 624     return E_NOTIMPL;
 625   }
 626
 627   //
 628   // ISimpleDOMNode methods.
 629   //
 630
 631   CONTENT_EXPORT STDMETHODIMP get_nodeInfo(BSTR* node_name,
 632                                            short* name_space_id,
 633                                            BSTR* node_value,
 634                                            unsigned int* num_children,
 635                                            unsigned int* unique_id,
 636                                            unsigned short* node_type) override;
 637
 638   CONTENT_EXPORT STDMETHODIMP
 639   get_attributes(unsigned short max_attribs,
 640                  BSTR* attrib_names,
 641                  short* name_space_id,
 642                  BSTR* attrib_values,
 643                  unsigned short* num_attribs) override;
 644
 645   CONTENT_EXPORT STDMETHODIMP
 646   get_attributesForNames(unsigned short num_attribs,
 647                          BSTR* attrib_names,
 648                          short* name_space_id,
 649                          BSTR* attrib_values) override;
 650
 651   CONTENT_EXPORT STDMETHODIMP
 652   get_computedStyle(unsigned short max_style_properties,
 653                     boolean use_alternate_view,
 654                     BSTR* style_properties,
 655                     BSTR* style_values,
 656                     unsigned short* num_style_properties) override;
 657
 658   CONTENT_EXPORT STDMETHODIMP
 659   get_computedStyleForProperties(unsigned short num_style_properties,
 660                                  boolean use_alternate_view,
 661                                  BSTR* style_properties,
 662                                  BSTR* style_values) override;
 663
 664   CONTENT_EXPORT STDMETHODIMP scrollTo(boolean placeTopLeft) override;
 665
 666   CONTENT_EXPORT STDMETHODIMP get_parentNode(ISimpleDOMNode** node) override;
 667
 668   CONTENT_EXPORT STDMETHODIMP get_firstChild(ISimpleDOMNode** node) override;
 669
 670   CONTENT_EXPORT STDMETHODIMP get_lastChild(ISimpleDOMNode** node) override;
 671
 672   CONTENT_EXPORT STDMETHODIMP
 673   get_previousSibling(ISimpleDOMNode** node) override;
 674
 675   CONTENT_EXPORT STDMETHODIMP get_nextSibling(ISimpleDOMNode** node) override;
 676
 677   CONTENT_EXPORT STDMETHODIMP
 678   get_childAt(unsigned int child_index, ISimpleDOMNode** node) override;
 679
 680   CONTENT_EXPORT STDMETHODIMP get_innerHTML(BSTR* innerHTML) override {
 681     return E_NOTIMPL;
 682   }
 683
 684   CONTENT_EXPORT STDMETHODIMP
 685   get_localInterface(void** local_interface) override {
 686     return E_NOTIMPL;
 687   }
 688
 689   CONTENT_EXPORT STDMETHODIMP get_language(BSTR* language) override {
 690     return E_NOTIMPL;
 691   }
 692
 693   //
 694   // ISimpleDOMText methods.
 695   //
 696
 697   CONTENT_EXPORT STDMETHODIMP get_domText(BSTR* dom_text) override;
 698
 699   CONTENT_EXPORT STDMETHODIMP
 700   get_clippedSubstringBounds(unsigned int start_index,
 701                              unsigned int end_index,
 702                              int* out_x,
 703                              int* out_y,
 704                              int* out_width,
 705                              int* out_height) override;
 706
 707   CONTENT_EXPORT STDMETHODIMP
 708   get_unclippedSubstringBounds(unsigned int start_index,
 709                                unsigned int end_index,
 710                                int* out_x,
 711                                int* out_y,
 712                                int* out_width,
 713                                int* out_height) override;
 714
 715   CONTENT_EXPORT STDMETHODIMP
 716   scrollToSubstring(unsigned int start_index, unsigned int end_index) override;
 717
 718   CONTENT_EXPORT STDMETHODIMP get_fontFamily(BSTR* font_family) override {
 719     return E_NOTIMPL;
 720   }
 721
 722   //
 723   // IServiceProvider methods.
 724   //
 725
 726   CONTENT_EXPORT STDMETHODIMP
 727   QueryService(REFGUID guidService, REFIID riid, void** object) override;
 728
 729   // IAccessibleEx methods not implemented.
 730   CONTENT_EXPORT STDMETHODIMP
 731   GetObjectForChild(long child_id, IAccessibleEx** ret) override {
 732     return E_NOTIMPL;
 733   }
 734
 735   CONTENT_EXPORT STDMETHODIMP
 736   GetIAccessiblePair(IAccessible** acc, long* child_id) override {
 737     return E_NOTIMPL;
 738   }
 739
 740   CONTENT_EXPORT STDMETHODIMP GetRuntimeId(SAFEARRAY** runtime_id) override {
 741     return E_NOTIMPL;
 742   }
 743
 744   CONTENT_EXPORT STDMETHODIMP
 745   ConvertReturnedElement(IRawElementProviderSimple* element,
 746                          IAccessibleEx** acc) override {
 747     return E_NOTIMPL;
 748   }
 749
 750   //
 751   // IRawElementProviderSimple methods.
 752   //
 753   // The GetPatternProvider/GetPropertyValue methods need to be implemented for
 754   // the on-screen keyboard to show up in Windows 8 metro.
 755   CONTENT_EXPORT STDMETHODIMP
 756   GetPatternProvider(PATTERNID id, IUnknown** provider) override;
 757   CONTENT_EXPORT STDMETHODIMP
 758   GetPropertyValue(PROPERTYID id, VARIANT* ret) override;
 759
 760   //
 761   // IRawElementProviderSimple methods not implemented
 762   //
 763   CONTENT_EXPORT STDMETHODIMP
 764   get_ProviderOptions(enum ProviderOptions* ret) override {
 765     return E_NOTIMPL;
 766   }
 767
 768   CONTENT_EXPORT STDMETHODIMP
 769   get_HostRawElementProvider(IRawElementProviderSimple** provider) override {
 770     return E_NOTIMPL;
 771   }
 772
 773   //
 774   // CComObjectRootEx methods.
 775   //
 776
 777   // Called by BEGIN_COM_MAP() / END_COM_MAP().
 778   static CONTENT_EXPORT HRESULT WINAPI
 779   InternalQueryInterface(void* this_ptr,
 780                          const _ATL_INTMAP_ENTRY* entries,
 781                          REFIID iid,
 782                          void** object);
 783
 784   // Accessors.
 785   int32 ia_role() const { return win_attributes_->ia_role; }
 786   int32 ia_state() const { return win_attributes_->ia_state; }
 787   const base::string16& role_name() const { return win_attributes_->role_name; }
 788   int32 ia2_role() const { return win_attributes_->ia2_role; }
 789   int32 ia2_state() const { return win_attributes_->ia2_state; }
 790   const std::vector<base::string16>& ia2_attributes() const {
 791     return win_attributes_->ia2_attributes;
 792   }
 793   base::string16 name() const { return win_attributes_->name; }
 794   base::string16 description() const { return win_attributes_->description; }
 795   base::string16 help() const { return win_attributes_->help; }
 796   base::string16 value() const { return win_attributes_->value; }
 797   base::string16 hypertext() const { return win_attributes_->hypertext; }
 798   std::map<int32, int32>& hyperlink_offset_to_index() const {
 799     return win_attributes_->hyperlink_offset_to_index;
 800   }
 801   std::vector<int32>& hyperlinks() const { return win_attributes_->hyperlinks; }
 802
 803  private:
 804   // Add one to the reference count and return the same object. Always
 805   // use this method when returning a BrowserAccessibilityWin object as
 806   // an output parameter to a COM interface, never use it otherwise.
 807   BrowserAccessibilityWin* NewReference();
 808
 809   // Many MSAA methods take a var_id parameter indicating that the operation
 810   // should be performed on a particular child ID, rather than this object.
 811   // This method tries to figure out the target object from |var_id| and
 812   // returns a pointer to the target object if it exists, otherwise NULL.
 813   // Does not return a new reference.
 814   BrowserAccessibilityWin* GetTargetFromChildID(const VARIANT& var_id);
 815
 816   // Initialize the role and state metadata from the role enum and state
 817   // bitmasks defined in ui::AXNodeData.
 818   void InitRoleAndState();
 819
 820   // Retrieve the value of an attribute from the string attribute map and
 821   // if found and nonempty, allocate a new BSTR (with SysAllocString)
 822   // and return S_OK. If not found or empty, return S_FALSE.
 823   HRESULT GetStringAttributeAsBstr(
 824       ui::AXStringAttribute attribute,
 825       BSTR* value_bstr);
 826
 827   // If the string attribute |attribute| is present, add its value as an
 828   // IAccessible2 attribute with the name |ia2_attr|.
 829   void StringAttributeToIA2(ui::AXStringAttribute attribute,
 830                             const char* ia2_attr);
 831
 832   // If the bool attribute |attribute| is present, add its value as an
 833   // IAccessible2 attribute with the name |ia2_attr|.
 834   void BoolAttributeToIA2(ui::AXBoolAttribute attribute,
 835                           const char* ia2_attr);
 836
 837   // If the int attribute |attribute| is present, add its value as an
 838   // IAccessible2 attribute with the name |ia2_attr|.
 839   void IntAttributeToIA2(ui::AXIntAttribute attribute,
 840                          const char* ia2_attr);
 841
 842   // Append the accessible name from this node and its children.
 843   base::string16 GetNameRecursive() const;
 844
 845   // Get the value text, which might come from the floating-point
 846   // value for some roles.
 847   base::string16 GetValueText();
 848
 849   // Get the text of this node for the purposes of IAccessibleText - it may
 850   // be the name, it may be the value, etc. depending on the role.
 851   base::string16 TextForIAccessibleText();
 852
 853   bool IsSameHypertextCharacter(size_t old_char_index, size_t new_char_index);
 854   void ComputeHypertextRemovedAndInserted(
 855       int* start, int* old_len, int* new_len);
 856
 857   // If offset is a member of IA2TextSpecialOffsets this function updates the
 858   // value of offset and returns, otherwise offset remains unchanged.
 859   void HandleSpecialTextOffset(const base::string16& text, LONG* offset);
 860
 861   // Convert from a IA2TextBoundaryType to a ui::TextBoundaryType.
 862   ui::TextBoundaryType IA2TextBoundaryToTextBoundary(IA2TextBoundaryType type);
 863
 864   // Search forwards (direction == 1) or backwards (direction == -1)
 865   // from the given offset until the given boundary is found, and
 866   // return the offset of that boundary.
 867   LONG FindBoundary(const base::string16& text,
 868                     IA2TextBoundaryType ia2_boundary,
 869                     LONG start_offset,
 870                     ui::TextBoundaryDirection direction);
 871
 872   // Return a pointer to the object corresponding to the given id,
 873   // does not make a new reference.
 874   BrowserAccessibilityWin* GetFromID(int32 id);
 875
 876   // Windows-specific unique ID (unique within the browser process),
 877   // used for get_accChild, NotifyWinEvent, and as the unique ID for
 878   // IAccessible2 and ISimpleDOM.
 879   LONG unique_id_win_;
 880
 881   struct WinAttributes {
 882     WinAttributes();
 883
 884     // IAccessible role and state.
 885     int32 ia_role;
 886     int32 ia_state;
 887     base::string16 role_name;
 888
 889     // IAccessible name, description, help, value.
 890     base::string16 name;
 891     base::string16 description;
 892     base::string16 help;
 893     base::string16 value;
 894
 895     // IAccessible2 role and state.
 896     int32 ia2_role;
 897     int32 ia2_state;
 898
 899     // IAccessible2 attributes.
 900     std::vector<base::string16> ia2_attributes;
 901
 902     // Hypertext.
 903     base::string16 hypertext;
 904
 905     // Maps the |hypertext_| embedded character offset to an index in
 906     // |hyperlinks_|.
 907     std::map<int32, int32> hyperlink_offset_to_index;
 908
 909     // The id of a BrowserAccessibilityWin for each hyperlink.
 910     std::vector<int32> hyperlinks;
 911   };
 912
 913   scoped_ptr<WinAttributes> win_attributes_;
 914
 915   // Only valid during the scope of a IA2_EVENT_TEXT_REMOVED or
 916   // IA2_EVENT_TEXT_INSERTED event.
 917   scoped_ptr<WinAttributes> old_win_attributes_;
 918
 919   // Relationships between this node and other nodes.
 920   std::vector<BrowserAccessibilityRelation*> relations_;
 921
 922   // The previous scroll position, so we can tell if this object scrolled.
 923   int previous_scroll_x_;
 924   int previous_scroll_y_;
 925
 926   // The next unique id to use.
 927   static LONG next_unique_id_win_;
 928
 929   // Give BrowserAccessibility::Create access to our constructor.
 930   friend class BrowserAccessibility;
 931   friend class BrowserAccessibilityRelation;
 932
 933   DISALLOW_COPY_AND_ASSIGN(BrowserAccessibilityWin);
 934 };
 935
 936 }  // namespace content
 937
 938 #endif  // CONTENT_BROWSER_ACCESSIBILITY_BROWSER_ACCESSIBILITY_WIN_H_