File: exclusive_access_controller_base.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 (90 lines) | stat: -rw-r--r-- 3,410 bytes parent folder | download | duplicates (5)
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
// Copyright 2015 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_UI_EXCLUSIVE_ACCESS_EXCLUSIVE_ACCESS_CONTROLLER_BASE_H_
#define CHROME_BROWSER_UI_EXCLUSIVE_ACCESS_EXCLUSIVE_ACCESS_CONTROLLER_BASE_H_

#include "base/memory/raw_ptr.h"
#include "chrome/browser/ui/exclusive_access/exclusive_access_bubble_type.h"
#include "content/public/browser/web_contents_observer.h"
#include "url/origin.h"

class ExclusiveAccessManager;

namespace content {
class WebContents;
}

// The base class for the different exclusive access controllers like the
// FullscreenController, KeyboardLockController, and PointerLockController which
// controls lifetime for which the resource (screen/mouse-pointer/keyboard) is
// held exclusively.
class ExclusiveAccessControllerBase {
 public:
  explicit ExclusiveAccessControllerBase(ExclusiveAccessManager* manager);

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

  virtual ~ExclusiveAccessControllerBase();

  virtual url::Origin GetOriginForExclusiveAccessBubble() const;

  content::WebContents* exclusive_access_tab() const {
    return web_contents_observer_.web_contents();
  }

  // Functions implemented by derived classes:

  // Called when Esc is pressed. Returns true if the event is handled.
  virtual bool HandleUserPressedEscape() = 0;

  // Called when Esc is held for longer than the press-and-hold duration.
  virtual void HandleUserHeldEscape() = 0;

  // Called when Esc is released before reaching the press-and-hold duration.
  virtual void HandleUserReleasedEscapeEarly() = 0;

  // Returns true if the controller requires press-and-hold to exit.
  virtual bool RequiresPressAndHoldEscToExit() const = 0;

  // Called by Browser in response to call from ExclusiveAccessBubble.
  virtual void ExitExclusiveAccessToPreviousState() = 0;

  // Called by ExclusiveAccessManager in response to calls from Browser.
  virtual void OnTabDeactivated(content::WebContents* web_contents);
  virtual void OnTabDetachedFromView(content::WebContents* web_contents);
  virtual void OnTabClosing(content::WebContents* web_contents);

 protected:
  void SetTabWithExclusiveAccess(content::WebContents* tab);

  ExclusiveAccessManager* exclusive_access_manager() const { return manager_; }

  // Exits exclusive access mode for the tab if currently exclusive.
  virtual void ExitExclusiveAccessIfNecessary() = 0;

  // Notifies the tab that it has been forced out of exclusive access mode
  // if necessary.
  virtual void NotifyTabExclusiveAccessLost() = 0;

 private:
  const raw_ptr<ExclusiveAccessManager> manager_;

  class WebContentsObserver : public content::WebContentsObserver {
   public:
    explicit WebContentsObserver(ExclusiveAccessControllerBase& controller);
    // Detect page navigation and exit exclusive access.
    void NavigationEntryCommitted(
        const content::LoadCommittedDetails& load_details) override;
    // Let the controller set the WebContents to be observed.
    using content::WebContentsObserver::Observe;

   private:
    const raw_ref<ExclusiveAccessControllerBase> controller_;
  } web_contents_observer_{*this};
};

#endif  // CHROME_BROWSER_UI_EXCLUSIVE_ACCESS_EXCLUSIVE_ACCESS_CONTROLLER_BASE_H_