File: render_view_context_menu_browsertest_util.h

package info (click to toggle)
chromium 139.0.7258.127-1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 6,122,068 kB
  • sloc: cpp: 35,100,771; ansic: 7,163,530; javascript: 4,103,002; python: 1,436,920; asm: 946,517; xml: 746,709; pascal: 187,653; perl: 88,691; sh: 88,436; objc: 79,953; sql: 51,488; cs: 44,583; fortran: 24,137; makefile: 22,147; tcl: 15,277; php: 13,980; yacc: 8,984; ruby: 7,485; awk: 3,720; lisp: 3,096; lex: 1,327; ada: 727; jsp: 228; sed: 36
file content (109 lines) | stat: -rw-r--r-- 3,794 bytes parent folder | download | duplicates (6)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
// Copyright 2014 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef CHROME_BROWSER_RENDERER_CONTEXT_MENU_RENDER_VIEW_CONTEXT_MENU_BROWSERTEST_UTIL_H_
#define CHROME_BROWSER_RENDERER_CONTEXT_MENU_RENDER_VIEW_CONTEXT_MENU_BROWSERTEST_UTIL_H_

#include <memory>
#include <optional>
#include <vector>

#include "base/memory/raw_ptr.h"
#include "base/run_loop.h"
#include "chrome/browser/renderer_context_menu/render_view_context_menu.h"
#include "components/renderer_context_menu/render_view_context_menu_observer.h"
#include "content/public/browser/context_menu_params.h"

class RenderViewContextMenu;

class ContextMenuNotificationObserver {
 public:
  using MenuShownCallback = base::OnceCallback<void(RenderViewContextMenu*)>;

  // Wait for a context menu to be shown, and then execute |command_to_execute|.
  explicit ContextMenuNotificationObserver(int command_to_execute);

  // Wait for a context menu to be shown, and then execute |command_to_execute|
  // with specified |event_flags|. Also executes |callback| after executing the
  // command if provided.
  ContextMenuNotificationObserver(int command_to_execute,
                                  int event_flags,
                                  MenuShownCallback callback);

  ContextMenuNotificationObserver(const ContextMenuNotificationObserver&) =
      delete;
  ContextMenuNotificationObserver& operator=(
      const ContextMenuNotificationObserver&) = delete;

  ~ContextMenuNotificationObserver();

 private:
  void MenuShown(RenderViewContextMenu* context_menu);

  void ExecuteCommand(RenderViewContextMenu* context_menu);

  int command_to_execute_;
  int event_flags_;
  MenuShownCallback callback_;
};

// Observe whether a command is executed or not.
class CommandExecutionObserver : public RenderViewContextMenuObserver {
 public:
  explicit CommandExecutionObserver(RenderViewContextMenu* context_menu,
                                    int command_id);
  ~CommandExecutionObserver() override;

  void CommandWillBeExecuted(int command_id) override;
  void CommandBlocked(int command_id) override;

  std::optional<bool> IsCommandExecuted() const;

 private:
  raw_ptr<RenderViewContextMenu> context_menu_;
  int command_id_;
  std::optional<bool> executed_;
};

class ContextMenuWaiter {
 public:
  ContextMenuWaiter();
  explicit ContextMenuWaiter(int command_to_execute);
  // `before_execute` will be run after the context menu is opened and before
  // executing `command_to_execute`.
  ContextMenuWaiter(int command_to_execute, base::OnceClosure before_execute);

  ContextMenuWaiter(const ContextMenuWaiter&) = delete;
  ContextMenuWaiter& operator=(const ContextMenuWaiter&) = delete;

  ~ContextMenuWaiter();

  content::ContextMenuParams& params();
  const std::vector<int>& GetCapturedCommandIds() const;
  const std::vector<int>& GetCapturedEnabledCommandIds() const;

  // A `nullopt` return value indicates the command has not yet been checked
  // whether it is allowed to execute. Or there is no command to execute by
  // `ContextMenuWaiter`.
  std::optional<bool> IsCommandExecuted() const;

  // Wait until the context menu is opened and closed.
  void WaitForMenuOpenAndClose();

 private:
  void MenuShown(RenderViewContextMenu* context_menu);

  void Cancel(RenderViewContextMenu* context_menu);

  content::ContextMenuParams params_;
  std::vector<int> captured_command_ids_;
  std::vector<int> captured_enabled_command_ids_;

  base::RunLoop run_loop_;
  const std::optional<int> maybe_command_to_execute_;
  base::OnceClosure before_execute_;
  std::unique_ptr<CommandExecutionObserver> execution_observer_;
};

#endif  // CHROME_BROWSER_RENDERER_CONTEXT_MENU_RENDER_VIEW_CONTEXT_MENU_BROWSERTEST_UTIL_H_