File: exclusive_access_controller_base.h

package info (click to toggle)
chromium-browser 57.0.2987.98-1~deb8u1
  • links: PTS, VCS
  • area: main
  • in suites: jessie
  • size: 2,637,852 kB
  • ctags: 2,544,394
  • sloc: cpp: 12,815,961; ansic: 3,676,222; python: 1,147,112; asm: 526,608; java: 523,212; xml: 286,794; perl: 92,654; sh: 86,408; objc: 73,271; makefile: 27,698; cs: 18,487; yacc: 13,031; tcl: 12,957; pascal: 4,875; ml: 4,716; lex: 3,904; sql: 3,862; ruby: 1,982; lisp: 1,508; php: 1,368; exp: 404; awk: 325; csh: 117; jsp: 39; sed: 37
file content (93 lines) | stat: -rw-r--r-- 3,400 bytes parent folder | download
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
// Copyright (c) 2015 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 CHROME_BROWSER_UI_EXCLUSIVE_ACCESS_EXCLUSIVE_ACCESS_CONTROLLER_BASE_H_
#define CHROME_BROWSER_UI_EXCLUSIVE_ACCESS_EXCLUSIVE_ACCESS_CONTROLLER_BASE_H_

#include "base/macros.h"
#include "base/memory/ref_counted.h"
#include "chrome/browser/ui/exclusive_access/exclusive_access_bubble_type.h"
#include "content/public/browser/notification_observer.h"
#include "content/public/browser/notification_registrar.h"

class ExclusiveAccessManager;
class GURL;

namespace content {
class WebContents;
}

// The base class for the different exclusive access controllers like the
// FullscreenController, and MouseLockController which controls lifetime for
// which the resource (screen/mouse) is held exclusively.
class ExclusiveAccessControllerBase : public content::NotificationObserver {
 public:
  explicit ExclusiveAccessControllerBase(ExclusiveAccessManager* manager);
  ~ExclusiveAccessControllerBase() override;

  GURL GetExclusiveAccessBubbleURL() const;
  virtual GURL GetURLForExclusiveAccessBubble() const;

  content::WebContents* exclusive_access_tab() const {
    return tab_with_exclusive_access_;
  }

  // Functions implemented by derived classes:

  // Control behavior when escape is pressed returning true if it was handled.
  virtual bool HandleUserPressedEscape() = 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);

  // Callbacks ////////////////////////////////////////////////////////////////

  // content::NotificationObserver to detect page navigation and exit exclusive
  // access.
  void Observe(int type,
               const content::NotificationSource& source,
               const content::NotificationDetails& details) override;

  // For recording UMA.
  void RecordBubbleReshownUMA();
  // Called when the exclusive access session ends.
  void RecordExitingUMA();

 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;

  // Records the BubbleReshowsPerSession data to the appropriate histogram for
  // this controller.
  virtual void RecordBubbleReshowsHistogram(int bubble_reshow_count) = 0;

 private:
  void UpdateNotificationRegistrations();

  ExclusiveAccessManager* const manager_;

  content::NotificationRegistrar registrar_;

  content::WebContents* tab_with_exclusive_access_ = nullptr;

  // The number of bubble re-shows for the current session (reset upon exiting).
  int bubble_reshow_count_ = 0;

  DISALLOW_COPY_AND_ASSIGN(ExclusiveAccessControllerBase);
};

#endif  // CHROME_BROWSER_UI_EXCLUSIVE_ACCESS_EXCLUSIVE_ACCESS_CONTROLLER_BASE_H_