File: shared_web_contents_with_app_lock.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 (75 lines) | stat: -rw-r--r-- 3,030 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
// Copyright 2022 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_WEB_APPLICATIONS_LOCKS_SHARED_WEB_CONTENTS_WITH_APP_LOCK_H_
#define CHROME_BROWSER_WEB_APPLICATIONS_LOCKS_SHARED_WEB_CONTENTS_WITH_APP_LOCK_H_

#include "base/containers/flat_set.h"
#include "base/memory/weak_ptr.h"
#include "chrome/browser/web_applications/locks/app_lock.h"
#include "chrome/browser/web_applications/locks/lock.h"
#include "chrome/browser/web_applications/locks/shared_web_contents_lock.h"
#include "chrome/browser/web_applications/locks/with_app_resources.h"
#include "chrome/browser/web_applications/locks/with_shared_web_contents_resources.h"
#include "components/webapps/common/web_app_id.h"

namespace content {
class WebContents;
}  // namespace content

namespace web_app {

class WebAppLockManager;

// This locks both the background shared web contents AND the given app ids. The
// background web contents is used by the WebAppProvider system to do operations
// in the background that require a web contents, like install web apps and
// fetch data.
//
// Locks can be acquired by using the `WebAppLockManager`.
class SharedWebContentsWithAppLockDescription : public LockDescription {
 public:
  explicit SharedWebContentsWithAppLockDescription(
      base::flat_set<webapps::AppId> app_ids);
  SharedWebContentsWithAppLockDescription(
      SharedWebContentsWithAppLockDescription&&);
  ~SharedWebContentsWithAppLockDescription();
};

// Holding this lock means that the user has exclusive access to the app id/s
// and the background web contents in use by the WebAppProvider system. This
// does not ensure that the app/s are installed when the lock is granted. Checks
// for that will need to be handled by the user of the lock.
// The web contents will be prepared for use via
// WebAppUrlLoader::PrepareForLoad() prior to being granted access.
//
// See `WebAppLockManager` for how to use locks. Destruction of this class will
// release the lock or cancel the lock request if it is not acquired yet.
//
// Note: Accessing a lock before it is granted or after the WebAppProvider
// system has shutdown (or the profile has shut down) will CHECK-fail.
class SharedWebContentsWithAppLock : public Lock,
                                     public WithSharedWebContentsResources,
                                     public WithAppResources {
 public:
  using LockDescription = SharedWebContentsWithAppLockDescription;

  SharedWebContentsWithAppLock();
  ~SharedWebContentsWithAppLock();

  base::WeakPtr<SharedWebContentsWithAppLock> AsWeakPtr() {
    return weak_factory_.GetWeakPtr();
  }

 private:
  friend class WebAppLockManager;
  void GrantLock(WebAppLockManager& lock_manager,
                 content::WebContents& web_contents);

  base::WeakPtrFactory<SharedWebContentsWithAppLock> weak_factory_{this};
};

}  // namespace web_app

#endif  // CHROME_BROWSER_WEB_APPLICATIONS_LOCKS_SHARED_WEB_CONTENTS_WITH_APP_LOCK_H_