ui/accessibility/platform/inspect/ax_script_instruction.h

// Copyright 2021 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef UI_ACCESSIBILITY_PLATFORM_INSPECT_AX_SCRIPT_INSTRUCTION_H_
#define UI_ACCESSIBILITY_PLATFORM_INSPECT_AX_SCRIPT_INSTRUCTION_H_

#include <string>

#include "base/component_export.h"

namespace ui {

class AXPropertyNode;

// A single script instruction. See AXInspectScenario.
// Note: this is only for executing tests or for running a script via
// ax_dump_tree/ax_dump_events for inspecting from out of process.
class COMPONENT_EXPORT(AX_PLATFORM) AXScriptInstruction final {
 public:
  explicit AXScriptInstruction(const std::string& instruction);

  bool IsEvent() const;
  bool IsKeyEvent() const;
  bool IsScript() const;
  bool IsComment() const;
  bool IsPrintTree() const;

  AXPropertyNode AsScript() const;
  // Returns a character string containing either
  // - a key name from http://www.w3.org/TR/DOM-Level-3-Events-key/, or
  // - a single Unicode character (represented in UTF-8).
  std::string AsDomKeyString() const;
  std::string AsEvent() const;
  std::string AsComment() const;

 private:
  size_t EventNameStartIndex() const;
  std::string instruction_;
};

}  // namespace ui

#endif  // UI_ACCESSIBILITY_PLATFORM_INSPECT_AX_SCRIPT_INSTRUCTION_H_