content/browser/accessibility/accessibility_tree_formatter_uia_win.h

// Copyright 2019 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.
#ifndef CONTENT_BROWSER_ACCESSIBILITY_ACCESSIBILITY_TREE_FORMATTER_UIA_WIN_H_
#define CONTENT_BROWSER_ACCESSIBILITY_ACCESSIBILITY_TREE_FORMATTER_UIA_WIN_H_
#include "content/browser/accessibility/accessibility_tree_formatter.h"

#include <ole2.h>
#include <stdint.h>
#include <uiautomation.h>
#include <wrl/client.h>
#include <memory>
#include <string>
#include <vector>

#include "base/win/scoped_variant.h"
namespace content {

class AccessibilityTreeFormatterUia : public AccessibilityTreeFormatter {
 public:
  AccessibilityTreeFormatterUia();

  ~AccessibilityTreeFormatterUia() override;

  static std::unique_ptr<AccessibilityTreeFormatter> CreateUia();

  void AddDefaultFilters(
      std::vector<PropertyFilter>* property_filters) override;

  static void SetUpCommandLineForTestPass(base::CommandLine* command_line);

  const base::FilePath::StringType GetExpectedFileSuffix() override;

  const base::FilePath::StringType GetVersionSpecificExpectedFileSuffix()
      override;

  std::unique_ptr<base::DictionaryValue> BuildAccessibilityTree(
      BrowserAccessibility* start) override;
  std::unique_ptr<base::DictionaryValue> BuildAccessibilityTreeForProcess(
      base::ProcessId pid) override;
  std::unique_ptr<base::DictionaryValue> BuildAccessibilityTreeForWindow(
      gfx::AcceleratedWidget hwnd) override;
  std::unique_ptr<base::DictionaryValue> BuildAccessibilityTreeForPattern(
      const base::StringPiece& pattern) override;

 private:
  static const long properties_[];
  static const long patterns_[];
  static const long pattern_properties_[];
  void RecursiveBuildAccessibilityTree(IUIAutomationElement* node,
                                       base::DictionaryValue* dict);
  void BuildCacheRequests();
  void AddProperties(IUIAutomationElement* node, base::DictionaryValue* dict);
  void AddExpandCollapseProperties(IUIAutomationElement* node,
                                   base::DictionaryValue* dict);
  void AddGridProperties(IUIAutomationElement* node,
                         base::DictionaryValue* dict);
  void AddGridItemProperties(IUIAutomationElement* node,
                             base::DictionaryValue* dict);
  void AddRangeValueProperties(IUIAutomationElement* node,
                               base::DictionaryValue* dict);
  void AddScrollProperties(IUIAutomationElement* node,
                           base::DictionaryValue* dict);
  void AddSelectionProperties(IUIAutomationElement* node,
                              base::DictionaryValue* dict);
  void AddSelectionItemProperties(IUIAutomationElement* node,
                                  base::DictionaryValue* dict);
  void AddTableProperties(IUIAutomationElement* node,
                          base::DictionaryValue* dict);
  void AddToggleProperties(IUIAutomationElement* node,
                           base::DictionaryValue* dict);
  void AddValueProperties(IUIAutomationElement* node,
                          base::DictionaryValue* dict);
  void AddWindowProperties(IUIAutomationElement* node,
                           base::DictionaryValue* dict);
  void WriteProperty(long propertyId,
                     const base::win::ScopedVariant& var,
                     base::DictionaryValue* dict);
  // UIA enums have type I4, print formatted string for these when possible
  void WriteI4Property(long propertyId, long lval, base::DictionaryValue* dict);
  void WriteUnknownProperty(long propertyId,
                            IUnknown* unk,
                            base::DictionaryValue* dict);
  void WriteElementArray(long propertyId,
                         IUIAutomationElementArray* array,
                         base::DictionaryValue* dict);
  base::string16 GetNodeName(IUIAutomationElement* node);
  const std::string GetAllowEmptyString() override;
  const std::string GetAllowString() override;
  const std::string GetDenyString() override;
  const std::string GetDenyNodeString() override;
  base::string16 ProcessTreeForOutput(
      const base::DictionaryValue& node,
      base::DictionaryValue* filtered_result = nullptr) override;
  void ProcessPropertyForOutput(const std::string& property_name,
                                const base::DictionaryValue& dict,
                                base::string16& line,
                                base::DictionaryValue* filtered_result);
  void ProcessValueForOutput(const std::string& name,
                             const base::Value* value,
                             base::string16& line,
                             base::DictionaryValue* filtered_result);
  Microsoft::WRL::ComPtr<IUIAutomation> uia_;
  Microsoft::WRL::ComPtr<IUIAutomationCacheRequest> element_cache_request_;
  Microsoft::WRL::ComPtr<IUIAutomationCacheRequest> children_cache_request_;
};
}  // namespace content
#endif  // CONTENT_BROWSER_ACCESSIBILITY_ACCESSIBILITY_TREE_FORMATTER_UIA_WIN_H_