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 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770
|
/*
* Copyright (C) 2006, 2007, 2008, 2009, 2010, 2013 Apple Inc. All rights
* reserved.
* Copyright (C) 2008 Torch Mobile Inc. All rights reserved.
* (http://www.torchmobile.com/)
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public License
* along with this library; see the file COPYING.LIB. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
#ifndef THIRD_PARTY_BLINK_RENDERER_CORE_PAGE_PAGE_H_
#define THIRD_PARTY_BLINK_RENDERER_CORE_PAGE_PAGE_H_
#include <memory>
#include <optional>
#include "base/check_op.h"
#include "base/dcheck_is_on.h"
#include "base/types/pass_key.h"
#include "net/cookies/site_for_cookies.h"
#include "services/network/public/mojom/attribution.mojom-shared.h"
#include "third_party/blink/public/common/fenced_frame/redacted_fenced_frame_config.h"
#include "third_party/blink/public/common/metrics/document_update_reason.h"
#include "third_party/blink/public/common/page/color_provider_color_maps.h"
#include "third_party/blink/public/mojom/devtools/inspector_issue.mojom-blink-forward.h"
#include "third_party/blink/public/mojom/fenced_frame/fenced_frame.mojom-blink.h"
#include "third_party/blink/public/mojom/frame/color_scheme.mojom-blink-forward.h"
#include "third_party/blink/public/mojom/frame/text_autosizer_page_info.mojom-blink.h"
#include "third_party/blink/public/mojom/page/page.mojom-blink-forward.h"
#include "third_party/blink/public/mojom/page/page_visibility_state.mojom-blink.h"
#include "third_party/blink/public/mojom/partitioned_popins/partitioned_popin_params.mojom-forward.h"
#include "third_party/blink/public/platform/scheduler/web_agent_group_scheduler.h"
#include "third_party/blink/public/platform/scheduler/web_scoped_virtual_time_pauser.h"
#include "third_party/blink/public/web/web_lifecycle_update.h"
#include "third_party/blink/public/web/web_window_features.h"
#include "third_party/blink/renderer/bindings/core/v8/v8_compile_hints_consumer.h"
#include "third_party/blink/renderer/bindings/core/v8/v8_compile_hints_producer.h"
#include "third_party/blink/renderer/core/core_export.h"
#include "third_party/blink/renderer/core/css/vision_deficiency.h"
#include "third_party/blink/renderer/core/frame/deprecation/deprecation.h"
#include "third_party/blink/renderer/core/frame/settings_delegate.h"
#include "third_party/blink/renderer/core/inspector/inspector_issue_storage.h"
#include "third_party/blink/renderer/core/page/page_visibility_observer.h"
#include "third_party/blink/renderer/core/page/viewport_description.h"
#include "third_party/blink/renderer/platform/heap/collection_support/heap_hash_set.h"
#include "third_party/blink/renderer/platform/heap/collection_support/heap_linked_hash_set.h"
#include "third_party/blink/renderer/platform/heap/collection_support/heap_vector.h"
#include "third_party/blink/renderer/platform/heap/garbage_collected.h"
#include "third_party/blink/renderer/platform/heap/persistent.h"
#include "third_party/blink/renderer/platform/scheduler/public/agent_group_scheduler.h"
#include "third_party/blink/renderer/platform/scheduler/public/page_scheduler.h"
#include "third_party/blink/renderer/platform/supplementable.h"
#include "third_party/blink/renderer/platform/wtf/forward.h"
#include "third_party/blink/renderer/platform/wtf/text/wtf_string.h"
#include "ui/gfx/geometry/insets.h"
namespace cc {
class AnimationHost;
} // namespace cc
namespace ui {
class ColorProvider;
} // namespace ui
namespace blink {
class AutoscrollController;
class BrowserControls;
class ChromeClient;
class ConsoleMessageStorage;
class ContextMenuController;
class Document;
class DragCaret;
class DragController;
class FocusController;
class Frame;
class LinkHighlight;
class LocalFrame;
class LocalFrameView;
class MediaFeatureOverrides;
class PageAnimator;
struct PageScaleConstraints;
class PageScaleConstraintsSet;
class PluginData;
class PluginsChangedObserver;
class PointerLockController;
class PreferenceOverrides;
class ScopedPagePauser;
class ScrollingCoordinator;
class ScrollbarTheme;
class Settings;
class SpatialNavigationController;
class SVGResourceDocumentCache;
class TopDocumentRootScrollerController;
class ValidationMessageClient;
class VisualViewport;
typedef uint64_t LinkHash;
// When calculating storage access for a partitioned popin the
// `top_frame_origin` is needed to calculate the storage key and the
// `site_for_cookies` is needed to properly filter cookie access.
// https://explainers-by-googlers.github.io/partitioned-popins/
struct PartitionedPopinOpenerProperties {
scoped_refptr<SecurityOrigin> top_frame_origin;
net::SiteForCookies site_for_cookies;
};
// A Page roughly corresponds to a tab or popup window in a browser. It owns a
// tree of frames (a blink::FrameTree). The root frame is called the main frame.
//
// Note that frames can be local or remote to this process.
class CORE_EXPORT Page final : public GarbageCollected<Page>,
public Supplementable<Page>,
public SettingsDelegate,
public PageScheduler::Delegate {
friend class Settings;
public:
// Any pages not owned by a web view should be created using this method.
static Page* CreateNonOrdinary(
ChromeClient& chrome_client,
AgentGroupScheduler& agent_group_scheduler,
const ColorProviderColorMaps* color_provider_colors);
// An "ordinary" page is a fully-featured page owned by a web view.
static Page* CreateOrdinary(
ChromeClient& chrome_client,
Page* opener,
AgentGroupScheduler& agent_group_scheduler,
const base::UnguessableToken& browsing_context_group_token,
const ColorProviderColorMaps* color_provider_colors,
blink::mojom::PartitionedPopinParamsPtr partitioned_popin_params);
Page(base::PassKey<Page>,
ChromeClient& chrome_client,
AgentGroupScheduler& agent_group_scheduler,
const base::UnguessableToken& browsing_context_group_token,
const ColorProviderColorMaps* color_provider_colors,
blink::mojom::PartitionedPopinParamsPtr partitioned_popin_params,
bool is_ordinary);
Page(const Page&) = delete;
Page& operator=(const Page&) = delete;
~Page() override;
void CloseSoon();
bool IsClosing() const { return is_closing_; }
using PageSet = HeapHashSet<WeakMember<Page>>;
// Return the current set of full-fledged, ordinary pages.
// Each created and owned by a WebView.
//
// This set does not include Pages created for other, internal purposes
// (SVGImages, inspector overlays, page popups etc.)
static PageSet& OrdinaryPages();
static void InsertOrdinaryPageForTesting(Page*);
// Returns pages related to the current browsing context (excluding the
// current page). See also
// https://html.spec.whatwg.org/C/#nested-browsing-contexts
HeapVector<Member<Page>> RelatedPages();
// Should be called when |GetScrollbarTheme().UsesOverlayScrollbars()|
// changes.
static void UsesOverlayScrollbarsChanged();
static void ForcedColorsChanged();
static void PlatformColorsChanged();
static void ColorSchemeChanged();
void EmulateForcedColors(bool is_dark_theme);
void DisableEmulatedForcedColors();
bool UpdateColorProviders(
const ColorProviderColorMaps& color_provider_colors);
void UpdateColorProvidersForTest();
const ui::ColorProvider* GetColorProviderForPainting(
mojom::blink::ColorScheme color_scheme,
bool in_forced_colors) const;
// Returns the color provider colors for this page. Used to support the
// creation of Non-ordiany pages from a main page.
const ColorProviderColorMaps& GetColorProviderColorMaps() {
return color_provider_colors_;
}
void SetColorProviderColorMaps(
const ColorProviderColorMaps& color_provider_colors) {
color_provider_colors_ = color_provider_colors;
}
void InitialStyleChanged();
void UpdateAcceleratedCompositingSettings();
ViewportDescription GetViewportDescription() const;
// Returns the plugin data.
PluginData* GetPluginData();
// Resets the plugin data for all pages in the renderer process and notifies
// PluginsChangedObservers.
static void ResetPluginData();
// When this method is called, page_scheduler_->SetIsMainFrameLocal should
// also be called to update accordingly.
// TODO(npm): update the |page_scheduler_| directly in this method.
void SetMainFrame(Frame*);
Frame* MainFrame() const { return main_frame_.Get(); }
void SetPreviousMainFrameForLocalSwap(
LocalFrame* previous_main_frame_for_local_swap) {
previous_main_frame_for_local_swap_ = previous_main_frame_for_local_swap;
}
LocalFrame* GetPreviousMainFrameForLocalSwap() {
return previous_main_frame_for_local_swap_.Get();
}
// Escape hatch for existing code that assumes that the root frame is
// always a LocalFrame. With OOPI, this is not always the case. Code that
// depends on this will generally have to be rewritten to propagate any
// necessary state through all renderer processes for that page and/or
// coordinate/rely on the browser process to help dispatch/coordinate work.
LocalFrame* DeprecatedLocalMainFrame() const;
void DocumentDetached(Document*);
void Animate(base::TimeTicks monotonic_frame_begin_time);
// The |root| argument indicates a root LocalFrame from which to start
// performing the operation. See comment on WebWidget::UpdateLifecycle.
void UpdateLifecycle(LocalFrame& root,
WebLifecycleUpdate requested_update,
DocumentUpdateReason reason);
bool OpenedByDOM() const;
void SetOpenedByDOM();
PageAnimator& Animator() { return *animator_; }
ChromeClient& GetChromeClient() const {
DCHECK(chrome_client_) << "No chrome client";
return *chrome_client_;
}
void SetChromeClientForTesting(ChromeClient* chrome_client) {
chrome_client_ = chrome_client;
}
AutoscrollController& GetAutoscrollController() const {
return *autoscroll_controller_;
}
DragCaret& GetDragCaret() const { return *drag_caret_; }
DragController& GetDragController() const { return *drag_controller_; }
FocusController& GetFocusController() const { return *focus_controller_; }
SpatialNavigationController& GetSpatialNavigationController();
SVGResourceDocumentCache& GetSVGResourceDocumentCache();
ContextMenuController& GetContextMenuController() const {
return *context_menu_controller_;
}
PointerLockController& GetPointerLockController() const {
return *pointer_lock_controller_;
}
ValidationMessageClient& GetValidationMessageClient() const {
return *validation_message_client_;
}
void SetValidationMessageClientForTesting(ValidationMessageClient*);
ScrollingCoordinator* GetScrollingCoordinator();
Settings& GetSettings() const { return *settings_; }
Deprecation& GetDeprecation() { return deprecation_; }
void SetWindowFeatures(const WebWindowFeatures& features) {
window_features_ = features;
}
const WebWindowFeatures& GetWindowFeatures() const {
return window_features_;
}
PageScaleConstraintsSet& GetPageScaleConstraintsSet();
const PageScaleConstraintsSet& GetPageScaleConstraintsSet() const;
BrowserControls& GetBrowserControls();
const BrowserControls& GetBrowserControls() const;
ConsoleMessageStorage& GetConsoleMessageStorage();
const ConsoleMessageStorage& GetConsoleMessageStorage() const;
InspectorIssueStorage& GetInspectorIssueStorage();
const InspectorIssueStorage& GetInspectorIssueStorage() const;
TopDocumentRootScrollerController& GlobalRootScrollerController() const;
VisualViewport& GetVisualViewport();
const VisualViewport& GetVisualViewport() const;
LinkHighlight& GetLinkHighlight();
void SetTabKeyCyclesThroughElements(bool b) {
tab_key_cycles_through_elements_ = b;
}
bool TabKeyCyclesThroughElements() const {
return tab_key_cycles_through_elements_;
}
// Pausing is used to implement the "Optionally, pause while waiting for
// the user to acknowledge the message" step of simple dialog processing:
// https://html.spec.whatwg.org/C/#simple-dialogs
//
// Per https://html.spec.whatwg.org/C/#pause, no loads
// are allowed to start/continue in this state, and all background processing
// is also paused.
bool Paused() const { return paused_; }
void SetPaused(bool);
// Frozen state corresponds to "lifecycle state for CPU suspension"
// https://wicg.github.io/page-lifecycle/#sec-lifecycle-states
bool Frozen() const { return frozen_; }
bool ShowPausedHudOverlay() const { return show_paused_hud_overlay_; }
void SetShowPausedHudOverlay(bool show_overlay);
void SetPageScaleFactor(float);
float PageScaleFactor() const;
float InspectorDeviceScaleFactorOverride() const {
return inspector_device_scale_factor_override_;
}
void SetInspectorDeviceScaleFactorOverride(float override) {
inspector_device_scale_factor_override_ = override;
}
static void AllVisitedStateChanged(bool invalidate_visited_link_hashes);
static void VisitedStateChanged(LinkHash visited_hash);
void SetVisibilityState(mojom::blink::PageVisibilityState visibility_state,
bool is_initial_state);
mojom::blink::PageVisibilityState GetVisibilityState() const;
bool IsPageVisible() const;
bool IsCursorVisible() const;
void SetIsCursorVisible(bool is_visible) { is_cursor_visible_ = is_visible; }
// Don't allow more than a certain number of frames in a page.
static int MaxNumberOfFrames();
static void SetMaxNumberOfFramesToTenForTesting(bool enabled);
void IncrementSubframeCount() { ++subframe_count_; }
void DecrementSubframeCount() {
DCHECK_GT(subframe_count_, 0);
--subframe_count_;
}
int SubframeCount() const;
// Update the CSS safe-area-inset* environment variables in the main frame's
// document based on the stored |max_safe_area_insets| in the Page and the
// given |browser_controls|'s visible height.
//
// The new safe-area-inset* will not be applied to the CSS
// environment if a fullscreen element exists, unless |force_update|
// is true.
void UpdateSafeAreaInsetWithBrowserControls(
const BrowserControls& browser_controls,
bool force_update = false);
// Set the max safe-area-inset* from the browser and update the CSS
// environment variables for the main frame. If the setter is not a main
// frame, applies the same safe-area-inset* to the given |setter|'s document
// as well. The input |insets| is unscaled and in the size of dips.
void SetMaxSafeAreaInsets(LocalFrame* setter, gfx::Insets insets);
void SetDefaultPageScaleLimits(float min_scale, float max_scale);
void SetUserAgentPageScaleConstraints(
const PageScaleConstraints& new_constraints);
#if DCHECK_IS_ON()
void SetIsPainting(bool painting) { is_painting_ = painting; }
bool IsPainting() const { return is_painting_; }
#endif
void DidCommitLoad(LocalFrame*);
void AcceptLanguagesChanged();
void Trace(Visitor*) const override;
void DidInitializeCompositing(cc::AnimationHost&);
void WillStopCompositing();
void WillBeDestroyed();
void RegisterPluginsChangedObserver(PluginsChangedObserver*);
ScrollbarTheme& GetScrollbarTheme() const;
AgentGroupScheduler& GetAgentGroupScheduler() const;
PageScheduler* GetPageScheduler() const;
// PageScheduler::Delegate implementation.
bool IsOrdinary() const override;
bool RequestBeginMainFrameNotExpected(bool new_state) override;
void OnSetPageFrozen(bool is_frozen) override;
void AddAutoplayFlags(int32_t flags);
void ClearAutoplayFlags();
int32_t AutoplayFlags() const;
void SetIsPrerendering(bool is_prerendering) {
is_prerendering_ = is_prerendering;
}
void SetPrerenderMetricSuffix(const String& suffix) {
prerender_metric_suffix_ = suffix;
}
void SetShouldWarmUpCompositorOnPrerender(
bool should_warm_up_compositor_on_prerender) {
should_warm_up_compositor_on_prerender_ =
should_warm_up_compositor_on_prerender;
}
void SetShouldPreparePaintTreeOnPrerender(
bool should_prepare_paint_tree_on_prerender) {
should_prepare_paint_tree_on_prerender_ =
should_prepare_paint_tree_on_prerender;
}
bool IsPrerendering() const { return is_prerendering_; }
const String& PrerenderMetricSuffix() const {
return prerender_metric_suffix_;
}
bool ShouldWarmUpCompositorOnPrerender() const {
return should_warm_up_compositor_on_prerender_;
}
bool ShouldPreparePaintTreeOnPrerender() const {
return should_prepare_paint_tree_on_prerender_;
}
void SetTextAutosizerPageInfo(
const mojom::blink::TextAutosizerPageInfo& page_info) {
web_text_autosizer_page_info_ = page_info;
}
const mojom::blink::TextAutosizerPageInfo& TextAutosizerPageInfo() const {
return web_text_autosizer_page_info_;
}
void SetMediaFeatureOverride(const AtomicString& media_feature,
const String& value);
const MediaFeatureOverrides* GetMediaFeatureOverrides() const {
return media_feature_overrides_.get();
}
void ClearMediaFeatureOverrides();
void SetPreferenceOverride(const AtomicString& media_feature,
const String& value);
const PreferenceOverrides* GetPreferenceOverrides() const {
return preference_overrides_.get();
}
void ClearPreferenceOverrides();
void SetVisionDeficiency(VisionDeficiency new_vision_deficiency);
VisionDeficiency GetVisionDeficiency() const { return vision_deficiency_; }
WebScopedVirtualTimePauser& HistoryNavigationVirtualTimePauser() {
return history_navigation_virtual_time_pauser_;
}
HeapLinkedHashSet<WeakMember<PageVisibilityObserver>>&
PageVisibilityObserverSet() {
return page_visibility_observer_set_;
}
void SetPageLifecycleState(mojom::blink::PageLifecycleStatePtr);
const mojom::blink::PageLifecycleStatePtr& GetPageLifecycleState() {
return lifecycle_state_;
}
// Whether we've dispatched "pagehide" on this page previously, and haven't
// dispatched the "pageshow" event after the last time we've dispatched
// "pagehide". This means that we've navigated away from the page and it's
// still hidden (possibly preserved in the back-forward cache, or unloaded).
bool DispatchedPagehideAndStillHidden();
// Similar to above, but will only return true if we've dispatched 'pagehide'
// with the 'persisted' property set to 'true'.
bool DispatchedPagehidePersistedAndStillHidden();
static void PrepareForLeakDetection();
// Fully invalidate paint of all local frames in this page.
void InvalidatePaint();
// Should be invoked when the main frame of this frame tree is a fenced frame.
void SetIsMainFrameFencedFrameRoot();
// Returns if the main frame of this frame tree is a fenced frame.
bool IsMainFrameFencedFrameRoot() const;
void SetDeprecatedFencedFrameMode(
blink::FencedFrame::DeprecatedFencedFrameMode mode) {
fenced_frame_mode_ = mode;
}
blink::FencedFrame::DeprecatedFencedFrameMode DeprecatedFencedFrameMode() {
return fenced_frame_mode_;
}
v8_compile_hints::V8CrowdsourcedCompileHintsProducer&
GetV8CrowdsourcedCompileHintsProducer() {
return *v8_compile_hints_producer_;
}
v8_compile_hints::V8CrowdsourcedCompileHintsConsumer&
GetV8CrowdsourcedCompileHintsConsumer() {
return *v8_compile_hints_consumer_;
}
// Returns the token uniquely identifying the browsing context group this page
// lives in.
const base::UnguessableToken& BrowsingContextGroupToken();
// Update this Page's browsing context group after a navigation has taken
// place.
void UpdateBrowsingContextGroup(const base::UnguessableToken&);
// Attribution Reporting API ------------------------------------
// Sets whether web or OS-level Attribution Reporting is supported
void SetAttributionSupport(
network::mojom::AttributionSupport attribution_support);
// Returns whether web or OS-level Attribution Reporting is supported. See
// https://github.com/WICG/attribution-reporting-api/blob/main/app_to_web.md.
network::mojom::AttributionSupport GetAttributionSupport() {
return attribution_support_;
}
// Called on a new Page, passing an old Page as the parameter, when doing a
// LocalFrame <-> LocalFrame swap when committing a navigation, to ensure that
// e.g. the close task will still be processed after the swap, the list of
// related pages will include the new page instead of the old page, etc.
void TakePropertiesForLocalMainFrameSwap(Page* old_page);
// This is true if this page is a partitioned popin.
// See https://explainers-by-googlers.github.io/partitioned-popins/
bool IsPartitionedPopin() const;
// If this Page is a partitioned popin then this returns the properties
// struct, otherwise this function CHECKs. See
// https://explainers-by-googlers.github.io/partitioned-popins/
const PartitionedPopinOpenerProperties& GetPartitionedPopinOpenerProperties()
const;
private:
friend class ScopedPagePauser;
class CloseTaskHandler;
// SettingsDelegate overrides.
void SettingsChanged(SettingsDelegate::ChangeType) override;
// Notify |plugins_changed_observers_| that plugins have changed.
void NotifyPluginsChanged() const;
void InvalidateColorScheme();
// Connect the Page to the `opener_`'s related pages, if those exist.
void LinkRelatedPagesIfNeeded();
// Typically, the main frame and Page should both be owned by the embedder,
// which must call Page::willBeDestroyed() prior to destroying Page. This
// call detaches the main frame and clears this pointer, thus ensuring that
// this field only references a live main frame.
//
// However, there are several locations (InspectorOverlay, SVGImage, and
// WebPagePopupImpl) which don't hold a reference to the main frame at all
// after creating it. These are still safe because they always create a
// Frame with a LocalFrameView. LocalFrameView and Frame hold references to
// each other, thus keeping each other alive. The call to willBeDestroyed()
// breaks this cycle, so the frame is still properly destroyed once no
// longer needed.
// Note that the main frame can either be a LocalFrame or a RemoteFrame. When
// the main frame is a RemoteFrame, it's possible for the RemoteFrame to not
// be connected to any RenderFrameProxyHost on the browser side, if the Page
// is a new page created for a provisional main frame. In that case, the main
// frame is solely used as a placeholder to be swapped out by the provisional
// main frame later on.
// See comments in `AgentSchedulingGroup::CreateWebView()` for more details.
Member<Frame> main_frame_;
// When a Page is created for a provisional main frame, which is intended to
// do a local main frame swap when its navigation commits, this will point to
// the previous Page's main frame. This is so that the provisional main frame
// can trigger the detach and "swap out" the previous Page's main frame. This
// is a WeakMember because the lifetime of this page and the previous Page
// should be independent. If the previous Page gets destroyed, the provisional
// Page can still exist (but the browser might trigger its deletion later on).
WeakMember<LocalFrame> previous_main_frame_for_local_swap_;
Member<AgentGroupScheduler> agent_group_scheduler_;
Member<PageAnimator> animator_;
const Member<AutoscrollController> autoscroll_controller_;
Member<ChromeClient> chrome_client_;
const Member<DragCaret> drag_caret_;
const Member<DragController> drag_controller_;
const Member<FocusController> focus_controller_;
const Member<ContextMenuController> context_menu_controller_;
const Member<PageScaleConstraintsSet> page_scale_constraints_set_;
HeapLinkedHashSet<WeakMember<PageVisibilityObserver>>
page_visibility_observer_set_;
const Member<PointerLockController> pointer_lock_controller_;
Member<ScrollingCoordinator> scrolling_coordinator_;
const Member<BrowserControls> browser_controls_;
const Member<ConsoleMessageStorage> console_message_storage_;
const Member<TopDocumentRootScrollerController>
global_root_scroller_controller_;
const Member<VisualViewport> visual_viewport_;
const Member<LinkHighlight> link_highlight_;
Member<SpatialNavigationController> spatial_navigation_controller_;
Member<SVGResourceDocumentCache> svg_resource_document_cache_;
Member<PluginData> plugin_data_;
Member<ValidationMessageClient> validation_message_client_;
InspectorIssueStorage inspector_issue_storage_;
Deprecation deprecation_;
WebWindowFeatures window_features_;
bool opened_by_dom_;
// Set to true when window.close() has been called and the Page will be
// destroyed. The browsing contexts in this page should no longer be
// discoverable via JS.
// TODO(dcheng): Try to remove |DOMWindow::m_windowIsClosing| in favor of
// this. However, this depends on resolving https://crbug.com/674641
bool is_closing_;
bool tab_key_cycles_through_elements_;
float inspector_device_scale_factor_override_;
mojom::blink::PageLifecycleStatePtr lifecycle_state_;
bool is_ordinary_;
bool is_cursor_visible_;
// See Page::Paused and Page::Frozen for the detailed description of paused
// and frozen state. The main distinction is that "frozen" state is
// web-exposed (onfreeze / onresume) and controlled from the browser process,
// while "paused" state is an implementation detail of handling sync IPCs and
// controlled from the renderer.
bool paused_ = false;
bool frozen_ = false;
bool show_paused_hud_overlay_ = false;
#if DCHECK_IS_ON()
bool is_painting_ = false;
#endif
int subframe_count_;
// |max_safe_area_insets_| is coming from the display cutout client.
// |scaled_max_safe_area_insets_| has been scaled to the size of physical
// pixles.
gfx::InsetsF scaled_max_safe_area_insets_;
gfx::InsetsF applied_safe_area_insets_;
// The light, dark and forced_colors mode ColorProviders corresponding to the
// top-level web container this Page is associated with.
std::unique_ptr<ui::ColorProvider> light_color_provider_;
std::unique_ptr<ui::ColorProvider> dark_color_provider_;
std::unique_ptr<ui::ColorProvider> forced_colors_color_provider_;
// Caching the color provider colors for easy creation of non ordinary pages
// who may depend on the main Page for colors.
ColorProviderColorMaps color_provider_colors_;
// This provider is used when forced color emulation is enabled via DevTools,
// overriding the light, dark or forced colors color providers.
std::unique_ptr<ui::ColorProvider> emulated_forced_colors_provider_;
HeapHashSet<WeakMember<PluginsChangedObserver>> plugins_changed_observers_;
// A circular, double-linked list of pages that are related to the current
// browsing context. See also RelatedPages method.
Member<Page> next_related_page_;
Member<Page> prev_related_page_;
// The Page that opened this Page.
WeakMember<Page> opener_;
std::unique_ptr<PageScheduler> page_scheduler_;
// Overrides for various media features, set from DevTools.
std::unique_ptr<MediaFeatureOverrides> media_feature_overrides_;
// Overrides for user preference media features, set from Web Preferences API.
std::unique_ptr<PreferenceOverrides> preference_overrides_;
// Emulated vision deficiency, set from DevTools.
VisionDeficiency vision_deficiency_ = VisionDeficiency::kNoVisionDeficiency;
int32_t autoplay_flags_;
// Whether the page is being prerendered by the Prerender2
// feature. See content/browser/preloading/prerender/README.md.
//
// This is ordinarily initialized by WebViewImpl immediately after creating
// this Page. Once initialized, it can only transition from true to false on
// prerender activation; it does not go from false to true.
bool is_prerendering_ = false;
String prerender_metric_suffix_;
// If true, warms up compositor on `WebLocalFrameImpl::DidCommitLoad` if the
// page is under prerendering.
bool should_warm_up_compositor_on_prerender_ = false;
// If true, prepares the paint tree if the page is under prerendering.
bool should_prepare_paint_tree_on_prerender_ = false;
// Whether the the Page's main document is a Fenced Frame document. This is
// only set for the MPArch implementation and is true when the corresponding
// browser side FrameTree has the FrameTree::Type of kFencedFrame.
bool is_fenced_frame_tree_ = false;
// This tracks the mode that the fenced frame is set to.
blink::FencedFrame::DeprecatedFencedFrameMode fenced_frame_mode_ =
blink::FencedFrame::DeprecatedFencedFrameMode::kDefault;
mojom::blink::TextAutosizerPageInfo web_text_autosizer_page_info_;
WebScopedVirtualTimePauser history_navigation_virtual_time_pauser_;
Member<v8_compile_hints::V8CrowdsourcedCompileHintsProducer>
v8_compile_hints_producer_;
Member<v8_compile_hints::V8CrowdsourcedCompileHintsConsumer>
v8_compile_hints_consumer_;
// The information determining the browsing context group this page lives in.
base::UnguessableToken browsing_context_group_token_;
network::mojom::AttributionSupport attribution_support_ =
network::mojom::AttributionSupport::kUnset;
Member<CloseTaskHandler> close_task_handler_;
// When the renderer opens a view representing a Partitioned Popin, the
// entire frame tree is partitioned as though it was an iframe in the opener.
// These properties are used in document.cc to calculate parameters critical
// for access to storage.
// See https://explainers-by-googlers.github.io/partitioned-popins/
std::optional<PartitionedPopinOpenerProperties>
partitioned_popin_opener_properties_;
};
extern template class CORE_EXTERN_TEMPLATE_EXPORT Supplement<Page>;
class CORE_EXPORT InternalSettingsPageSupplementBase : public Supplement<Page> {
public:
using Supplement<Page>::Supplement;
static const char kSupplementName[];
};
} // namespace blink
#endif // THIRD_PARTY_BLINK_RENDERER_CORE_PAGE_PAGE_H_
|