File: crostini_force_close_watcher.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 (145 lines) | stat: -rw-r--r-- 5,119 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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
// Copyright 2019 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_ASH_CROSTINI_CROSTINI_FORCE_CLOSE_WATCHER_H_
#define CHROME_BROWSER_ASH_CROSTINI_CROSTINI_FORCE_CLOSE_WATCHER_H_

#include <memory>
#include <optional>
#include <string>

#include "base/memory/raw_ptr.h"
#include "base/memory/weak_ptr.h"
#include "base/time/time.h"
#include "base/timer/elapsed_timer.h"
#include "ui/views/widget/widget_observer.h"

namespace exo {
class ShellSurfaceBase;
}

namespace crostini {

// Class that observes user attempts to close crostini windows, and notifies its
// delegate if it thinks the window needs to be force-closed.
class ForceCloseWatcher : public views::WidgetObserver {
 public:
  class Delegate {
   public:
    virtual ~Delegate();

    // Callback to get the widget this watcher should be watching.
    virtual views::Widget* GetClosableWidget() = 0;

    // Called by the |watcher| when it has finished initializing.
    virtual void Watched(ForceCloseWatcher* watcher) = 0;

    // Called when the watcher decides to begin the force-close operation.
    virtual void Prompt() = 0;

    // Called when the watcher wants to abort an in-progress force-close
    // operation, e.g. because the window we're trying to close did disappear
    // after Prompt() was called.
    virtual void Hide() = 0;
  };

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

  // Creates a watcher for the given |delegate| which will wait for attempts to
  // close its associated widget and, if needed, bring up a UI allowing the user
  // to forcibly close its associated window.
  //
  // The watcher works as follows:
  //
  //                                          Cancel
  //                                     +------------+
  //                                     |            |
  //             X             5 sec     V    X       |
  // "Watching"---->"Waiting"-------->"Active"---->"Dialog"
  //                    |                |          |   |
  //      window closes +----------------+----------+   | Force Close
  //          itself    v                           |   V
  //                  "Done"<--------------------"Force closing"
  //                             Destroy shell
  //                                surface
  //
  // Importantly, we require *two* attempts to close the window before bringing
  // up the dialog, which is needed as windows may legitimately refuse to close
  // (e.g. if you have unsaved work open).
  static void Watch(std::unique_ptr<Delegate> delegate);

  // WidgetObserver overrides.
  void OnWidgetDestroying(views::Widget* widget) override;

  // Called each time a user tries to close the widget being observed.
  void OnCloseRequested();

  // Sets the timeout to the given value, for use in tests.
  void OverrideDelayForTesting(base::TimeDelta delay);

 private:
  // Create a ForceCloseWatcher to monitor close requests on the given
  // |delegate|'s associated widget.
  explicit ForceCloseWatcher(std::unique_ptr<Delegate> delegate);

  ~ForceCloseWatcher() override;

  std::unique_ptr<Delegate> delegate_;

  // Time delay required before bringing up the UI.
  base::TimeDelta force_close_delay_;

  // Implements the delay between the first and second time the user tries to
  // close the window.
  std::optional<base::ElapsedTimer> show_dialog_timer_;
};

// The delegate implementation to allow exo's shell surfaces to be closed by the
// watcher.
class ShellSurfaceForceCloseDelegate : public ForceCloseWatcher::Delegate,
                                       public views::WidgetObserver {
 public:
  ShellSurfaceForceCloseDelegate(exo::ShellSurfaceBase* shell_surface,
                                 std::string app_name);

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

  ~ShellSurfaceForceCloseDelegate() override;

  // Callback for the "Force close" button in the dialog.
  void ForceClose();

  // Closes shell surface's widget. See implementation for details.
  void ForceCloseNow();

  // ForceCloseWatcher::Delegate overrides.
  views::Widget* GetClosableWidget() override;
  void Watched(ForceCloseWatcher* watcher) override;
  void Prompt() override;
  void Hide() override;

  // WidgetObserver overrides.
  void OnWidgetDestroying(views::Widget* widget) override;

 private:
  // Handle to the shell surface we are trying to close.
  raw_ptr<exo::ShellSurfaceBase> shell_surface_;

  // Name of the app we are trying to close (or "" if unknown).
  std::string app_name_;

  // Handle to the widget representing the currently visible force-close dialog
  // (if there is one), or null.
  raw_ptr<views::Widget> current_dialog_ = nullptr;

  base::WeakPtrFactory<ShellSurfaceForceCloseDelegate> weak_ptr_factory_;
};

}  // namespace crostini

#endif  // CHROME_BROWSER_ASH_CROSTINI_CROSTINI_FORCE_CLOSE_WATCHER_H_