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
|
// Copyright 2023 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef CONTENT_BROWSER_RENDERER_HOST_NAVIGATION_TRANSITIONS_NAVIGATION_TRANSITION_UTILS_H_
#define CONTENT_BROWSER_RENDERER_HOST_NAVIGATION_TRANSITIONS_NAVIGATION_TRANSITION_UTILS_H_
#include "base/functional/callback.h"
#include "content/browser/renderer_host/navigation_transitions/navigation_transition_data.h"
#include "content/common/content_export.h"
#include "third_party/blink/public/common/tokens/tokens.h"
#include "third_party/skia/include/core/SkBitmap.h"
namespace gfx {
class Size;
}
namespace content {
class NavigationControllerImpl;
class NavigationRequest;
class NavigationTransitionUtils {
public:
NavigationTransitionUtils() = delete;
// See ScreenshotCallback in NavigationTransitionTestUtils.
using ScreenshotCallback =
base::RepeatingCallback<void(int nav_entry_index,
const SkBitmap& bitmap,
bool requested,
SkBitmap& out_override)>;
// Capture the `NavigationEntryScreenshot` for the old page, and store the
// screenshot in the old page's NavigationEntry.
//
// This is invoked at 2 points in the navigation's lifecycle, the screenshot is done at one
// of these 2 points:
//
// 1. When dispatching a commit message from the browser to the renderer
// process.
// 2. When the browser receives the DidCommitNavigation ack and the navigation
// is committed in the browser process.
//
// Returns true if a screenshot for the currently committed Document is
// requested for this navigation.
static bool CaptureNavigationEntryScreenshotForCrossDocumentNavigations(
NavigationRequest& navigation_request,
bool did_receive_commit_ack);
// Called when `DidCommitSameDocumentNavigation` arrives at the browser, and
// *before* the navigation commits. Ensures that a `NavigationEntryScreenshot`
// for the pre-navigation DOM state is cached when provided by the Viz
// process.
static void SetSameDocumentNavigationEntryScreenshotToken(
NavigationRequest& navigation_request,
std::optional<blink::SameDocNavigationScreenshotDestinationToken>
destination_token);
static int FindEntryIndexForNavigationTransitionID(
NavigationControllerImpl* controller,
NavigationTransitionData::UniqueId id);
static bool ShouldSkipScreenshot(const NavigationRequest& navigation_request);
// Used by tests to deterministically validate the memory budgeting / eviction
// logic.
CONTENT_EXPORT static void SetCapturedScreenshotSizeForTesting(
const gfx::Size& size);
// Returns the global counter of issued `viz::CopyOutputRequest`s.
CONTENT_EXPORT static int GetNumCopyOutputRequestIssuedForTesting();
// Resets the above counter to zero.
CONTENT_EXPORT static void ResetNumCopyOutputRequestIssuedForTesting();
// Calls `screenshot_callback` with the index of the previous NavigationEntry
// when leaving a page, along with the generated bitmap captured captured for
// all navigations.
CONTENT_EXPORT static void SetNavScreenshotCallbackForTesting(
ScreenshotCallback screenshot_callback);
};
} // namespace content
#endif // CONTENT_BROWSER_RENDERER_HOST_NAVIGATION_TRANSITIONS_NAVIGATION_TRANSITION_UTILS_H_
|
