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 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311
|
/*
* Copyright (C) 1998, 1999 Torben Weis <weis@kde.org>
* 1999-2001 Lars Knoll <knoll@kde.org>
* 1999-2001 Antti Koivisto <koivisto@kde.org>
* 2000-2001 Simon Hausmann <hausmann@kde.org>
* 2000-2001 Dirk Mueller <mueller@kde.org>
* 2000 Stefan Schimanski <1Stein@gmx.de>
* Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010 Apple Inc. All rights
* reserved.
* Copyright (C) 2008 Nokia Corporation and/or its subsidiary(-ies)
* Copyright (C) 2008 Eric Seidel <eric@webkit.org>
*
* 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_FRAME_LOCAL_FRAME_H_
#define THIRD_PARTY_BLINK_RENDERER_CORE_FRAME_LOCAL_FRAME_H_
#include <memory>
#include <vector>
#include "base/gtest_prod_util.h"
#include "base/time/default_tick_clock.h"
#include "base/time/time.h"
#include "base/unguessable_token.h"
#include "build/build_config.h"
#include "mojo/public/cpp/bindings/pending_associated_receiver.h"
#include "mojo/public/cpp/bindings/pending_receiver.h"
#include "net/storage_access_api/status.h"
#include "services/metrics/public/cpp/ukm_source_id.h"
#include "services/network/public/mojom/fetch_api.mojom-blink-forward.h"
#include "third_party/blink/public/common/frame/frame_ad_evidence.h"
#include "third_party/blink/public/common/frame/frame_owner_element_type.h"
#include "third_party/blink/public/common/frame/history_user_activation_state.h"
#include "third_party/blink/public/common/tokens/tokens.h"
#include "third_party/blink/public/mojom/back_forward_cache_not_restored_reasons.mojom-blink.h"
#include "third_party/blink/public/mojom/blob/blob_url_store.mojom-blink-forward.h"
#include "third_party/blink/public/mojom/confidence_level.mojom-blink.h"
#include "third_party/blink/public/mojom/device_posture/device_posture_provider.mojom-blink-forward.h"
#include "third_party/blink/public/mojom/devtools/devtools_agent.mojom-blink-forward.h"
#include "third_party/blink/public/mojom/frame/back_forward_cache_controller.mojom-blink-forward.h"
#include "third_party/blink/public/mojom/frame/frame.mojom-blink-forward.h"
#include "third_party/blink/public/mojom/frame/frame_owner_properties.mojom-blink-forward.h"
#include "third_party/blink/public/mojom/frame/media_player_action.mojom-blink-forward.h"
#include "third_party/blink/public/mojom/frame/reporting_observer.mojom-blink-forward.h"
#include "third_party/blink/public/mojom/frame/sudden_termination_disabler_type.mojom-blink-forward.h"
#include "third_party/blink/public/mojom/frame/viewport_intersection_state.mojom-blink.h"
#include "third_party/blink/public/mojom/input/focus_type.mojom-blink-forward.h"
#include "third_party/blink/public/mojom/lcp_critical_path_predictor/lcp_critical_path_predictor.mojom-blink.h"
#include "third_party/blink/public/mojom/link_to_text/link_to_text.mojom-blink-forward.h"
#include "third_party/blink/public/mojom/loader/pause_subresource_loading_handle.mojom-blink-forward.h"
#include "third_party/blink/public/mojom/navigation/renderer_content_settings.mojom.h"
#include "third_party/blink/public/mojom/navigation/renderer_eviction_reason.mojom-blink-forward.h"
#include "third_party/blink/public/mojom/reporting/reporting.mojom-blink-forward.h"
#include "third_party/blink/public/mojom/script/script_evaluation_params.mojom-blink-forward.h"
#include "third_party/blink/public/mojom/use_counter/metrics/web_feature.mojom-blink-forward.h"
#include "third_party/blink/public/platform/task_type.h"
#include "third_party/blink/public/platform/web_background_resource_fetch_assets.h"
#include "third_party/blink/public/platform/web_content_settings_client.h"
#include "third_party/blink/public/web/web_print_params.h"
#include "third_party/blink/public/web/web_script_execution_callback.h"
#include "third_party/blink/renderer/core/core_export.h"
#include "third_party/blink/renderer/core/dom/weak_identifier_map.h"
#include "third_party/blink/renderer/core/editing/forward.h"
#include "third_party/blink/renderer/core/editing/iterators/text_iterator_behavior.h"
#include "third_party/blink/renderer/core/frame/ad_script_identifier.h"
#include "third_party/blink/renderer/core/frame/frame.h"
#include "third_party/blink/renderer/core/frame/frame_types.h"
#include "third_party/blink/renderer/core/frame/frame_visibility_observer.h"
#include "third_party/blink/renderer/core/frame/local_frame_view.h"
#include "third_party/blink/renderer/core/frame/widget_creation_observer.h"
#include "third_party/blink/renderer/core/loader/back_forward_cache_loader_helper_impl.h"
#include "third_party/blink/renderer/core/loader/frame_loader.h"
#include "third_party/blink/renderer/platform/graphics/touch_action.h"
#include "third_party/blink/renderer/platform/heap/collection_support/heap_hash_map.h"
#include "third_party/blink/renderer/platform/heap/collection_support/heap_hash_set.h"
#include "third_party/blink/renderer/platform/heap/garbage_collected.h"
#include "third_party/blink/renderer/platform/loader/fetch/client_hints_preferences.h"
#include "third_party/blink/renderer/platform/loader/fetch/loader_freeze_mode.h"
#include "third_party/blink/renderer/platform/mojo/browser_interface_broker_proxy_impl.h"
#include "third_party/blink/renderer/platform/mojo/heap_mojo_associated_remote.h"
#include "third_party/blink/renderer/platform/mojo/heap_mojo_remote.h"
#include "third_party/blink/renderer/platform/mojo/heap_mojo_unique_receiver_set.h"
#include "third_party/blink/renderer/platform/mojo/heap_mojo_wrapper_mode.h"
#include "third_party/blink/renderer/platform/scheduler/public/frame_scheduler.h"
#include "third_party/blink/renderer/platform/supplementable.h"
#include "third_party/perfetto/include/perfetto/tracing/traced_value_forward.h"
#include "ui/gfx/geometry/transform.h"
#include "ui/gfx/image/image_skia.h"
namespace base {
class SingleThreadTaskRunner;
}
namespace gfx {
class Point;
class Range;
class Size;
} // namespace gfx
namespace network {
class SharedURLLoaderFactory;
} // namespace network
namespace blink {
class AdTracker;
class AssociatedInterfaceProvider;
class AttributionSrcLoader;
class AuditsIssue;
class BackgroundColorPaintImageGenerator;
class BoxShadowPaintImageGenerator;
class ClipPathPaintImageGenerator;
class Color;
class ContentCaptureManager;
class ContextMenuInsetsChangedObserver;
class CoreProbeSink;
class Document;
class Editor;
class Element;
class EventHandler;
class EventHandlerRegistry;
class FrameConsole;
class FrameOverlay;
class FrameSelection;
class FrameWidget;
class IdlenessDetector;
class InputMethodController;
class InspectorIssueReporter;
class InspectorTaskRunner;
class InspectorTraceEvents;
class InterfaceRegistry;
class LCPCriticalPathPredictor;
class LCPScriptObserver;
class LayoutView;
class LocalDOMWindow;
class LocalFrameClient;
class LocalFrameMojoHandler;
class LocalWindowProxy;
class Node;
class NodeTraversal;
class PerformanceMonitor;
class WebLinkPreviewTriggerer;
class PluginData;
class PolicyContainer;
class ScrollSnapshotClient;
class SpellChecker;
class StorageKey;
class StyleEnvironmentVariables;
class SystemClipboard;
class TextFragmentHandler;
class TextSuggestionController;
class VirtualKeyboardOverlayChangedObserver;
class WebContentSettingsClient;
class WebInputEventAttribution;
class WebPluginContainerImpl;
class WebPrescientNetworking;
class URLLoader;
struct BlinkTransferableMessage;
struct WebScriptSource;
namespace v8_compile_hints {
class V8LocalCompileHintsProducer;
} // namespace v8_compile_hints
enum class BackForwardCacheAware;
#if !BUILDFLAG(IS_ANDROID)
class WindowControlsOverlayChangedDelegate;
#endif
extern template class CORE_EXTERN_TEMPLATE_EXPORT Supplement<LocalFrame>;
// A LocalFrame is a frame hosted inside this process.
//
// LocalFrame should not inherit from Mojo interfaces, and should not have
// data members for Mojo remotes in order to avoid including full mojom headers
// from local_frame.h. LocalFrameMojoHandler should do them instead.
//
// Blink code should not directly use LocalFrameMojoHandler. If Blink code
// needs to call a function that is exposed as a Mojo method, the function
// implementation should be in LocalFrame, and LocalFrameMojoHandler should
// delegate to LocalFrame's implementation.
class CORE_EXPORT LocalFrame final
: public Frame,
public FrameScheduler::Delegate,
public BackForwardCacheLoaderHelperImpl::Delegate,
public Supplementable<LocalFrame> {
public:
// Returns the LocalFrame instance for the given |frame_token|.
static LocalFrame* FromFrameToken(const LocalFrameToken& frame_token);
// For a description of |inheriting_agent_factory| go see the comment on the
// Frame constructor.
LocalFrame(
LocalFrameClient*,
Page&,
FrameOwner*,
Frame* parent,
Frame* previous_sibling,
FrameInsertType insert_type,
const LocalFrameToken& frame_token,
WindowAgentFactory* inheriting_agent_factory,
InterfaceRegistry*,
mojo::PendingRemote<mojom::blink::BrowserInterfaceBroker>,
const base::TickClock* clock = base::DefaultTickClock::GetInstance());
// Initialize the LocalFrame, creating and initializing its LocalDOMWindow. It
// starts from the initial empty document.
// - |policy_container| is used to set the PolicyContainer of the new
// LocalDOMWindow. If you pass a null |policy_container|, it will be
// initialized to an empty, default one, which has no PolicyContainerHost
// counterpart. This is usually safe to do if this LocalFrame has no
// corresponding RenderFrameHost.
// - |storage_key| is the key used to partition access to storage API like DOM
// storage, IndexedDB, BroadcastChannel, etc...
// - |document_ukm_source_id| is the ukm source id for the new document. If
// you pass ukm::kInvalidSourceId, a new ukm source id will be generated.
// - `creator_base_url` is the base url of the initiator that created this
// frame.
//
// Note: Usually, the initial empty document inherits its |policy_container|
// and |storage_key| from the parent or the opener. The inheritance operation
// is taken care of by the browser (if this LocalFrame was just created in
// response to the creation of a RenderFrameHost) or by blink if this is a
// synchronously created LocalFrame child.
void Init(Frame* opener,
const DocumentToken& document_token,
std::unique_ptr<PolicyContainer> policy_container,
const StorageKey& storage_key,
ukm::SourceId document_ukm_source_id,
const KURL& creator_base_url);
void SetView(LocalFrameView*);
void CreateView(const gfx::Size&, const Color&);
// Frame overrides:
~LocalFrame() override;
void Trace(Visitor*) const override;
void Navigate(FrameLoadRequest&, WebFrameLoadType) override;
bool ShouldClose() override;
const SecurityContext* GetSecurityContext() const override;
void PrintNavigationErrorMessage(const Frame&, const String& reason);
void PrintNavigationWarning(const String&);
bool DetachDocument() override;
void CheckCompleted() override;
void DidChangeVisibilityState() override;
void HookBackForwardCacheEviction() override;
void RemoveBackForwardCacheEviction() override;
void SetTextDirection(base::i18n::TextDirection direction) override;
// This sets the is_inert_ flag and also recurses through this frame's
// subtree, updating the inert bit on all descendant frames.
void SetIsInert(bool) override;
void SetInheritedEffectiveTouchAction(TouchAction) override;
void DidFocus() override;
bool IsAdFrame() const override;
// BackForwardCacheLoaderHelperImpl::Delegate:
void EvictFromBackForwardCache(
mojom::blink::RendererEvictionReason reason,
std::unique_ptr<SourceLocation> source_location) override;
void DidBufferLoadWhileInBackForwardCache(bool update_process_wide_count,
size_t num_bytes) override;
void DidChangeThemeColor(bool update_theme_color_cache);
void DidChangeBackgroundColor(SkColor4f background_color, bool color_adjust);
// Returns false if detaching child frames reentrantly detached `this`.
bool DetachChildren();
// After Document is attached, resets state related to document, and sets
// context to the current document.
void DidAttachDocument();
void Reload(WebFrameLoadType);
// Note: these three functions are not virtual but intentionally shadow the
// corresponding method in the Frame base class to return the
// LocalFrame-specific subclass.
LocalWindowProxy* WindowProxy(DOMWrapperWorld&);
LocalWindowProxy* WindowProxyMaybeUninitialized(DOMWrapperWorld&);
LocalDOMWindow* DomWindow();
const LocalDOMWindow* DomWindow() const;
void SetDOMWindow(LocalDOMWindow*);
LocalFrameView* View() const override;
Document* GetDocument() const;
void DocumentDetached();
void SetPagePopupOwner(Element&);
Element* PagePopupOwner() const { return page_popup_owner_.Get(); }
bool HasPagePopupOwner() const { return page_popup_owner_ != nullptr; }
// Root of the layout tree for the document contained in this frame.
LayoutView* ContentLayoutObject() const;
Editor& GetEditor() const;
EventHandler& GetEventHandler() const;
EventHandlerRegistry& GetEventHandlerRegistry() const;
FrameLoader& Loader() const;
FrameSelection& Selection() const;
InputMethodController& GetInputMethodController() const;
TextSuggestionController& GetTextSuggestionController() const;
SpellChecker& GetSpellChecker() const;
FrameConsole& Console() const;
BackgroundColorPaintImageGenerator* GetBackgroundColorPaintImageGenerator();
BoxShadowPaintImageGenerator* GetBoxShadowPaintImageGenerator();
ClipPathPaintImageGenerator* GetClipPathPaintImageGenerator();
void SetClipPathPaintImageGeneratorForTesting(ClipPathPaintImageGenerator*);
LCPCriticalPathPredictor* GetLCPP();
// A local root is the root of a connected subtree that contains only
// LocalFrames. The local root is responsible for coordinating input, layout,
// et cetera for that subtree of frames.
bool IsLocalRoot() const;
LocalFrame& LocalFrameRoot() const;
CoreProbeSink* GetProbeSink() { return probe_sink_.Get(); }
scoped_refptr<InspectorTaskRunner> GetInspectorTaskRunner();
// Returns ContentCaptureManager in LocalFrameRoot, create or destroy it as
// needed.
ContentCaptureManager* GetOrResetContentCaptureManager();
void AddWidgetCreationObserver(WidgetCreationObserver* observer);
void NotifyFrameWidgetCreated();
// Returns the current state of caret browsing mode.
bool IsCaretBrowsingEnabled() const;
// Activates the user activation states of the |LocalFrame| (provided it's
// non-null) and all its ancestors.
//
// The |notification_type| parameter is used for histograms only.
static void NotifyUserActivation(
LocalFrame*,
mojom::blink::UserActivationNotificationType notification_type);
// Returns the transient user activation state of the |LocalFrame|, provided
// it is non-null. Otherwise returns |false|.
static bool HasTransientUserActivation(LocalFrame*);
// Consumes the transient user activation state of the |LocalFrame|, provided
// the frame pointer is non-null and the state hasn't been consumed since
// activation. Returns |true| if successfully consumed the state.
static bool ConsumeTransientUserActivation(
LocalFrame*,
UserActivationUpdateSource update_source =
UserActivationUpdateSource::kRenderer);
bool IsHistoryUserActivationActive() const {
return history_user_activation_state_.IsActive();
}
void ConsumeHistoryUserActivation();
// Activates or clears history user activation state and also notifies frame
// scheduler of the state change.
void SetHadUserInteraction(bool had_user_interaction);
// Sets the Storage Access API status in the browser process..
void SetStorageAccessApiStatus(net::StorageAccessApiStatus status);
// Registers an observer that will be notified if a VK occludes
// the content when it raises/dismisses. The observer is a HeapHashSet
// data structure that doesn't allow duplicates.
void RegisterVirtualKeyboardOverlayChangedObserver(
VirtualKeyboardOverlayChangedObserver*);
// Notify |virtual_keyboard_overlay_changed_observers_| that keyboard overlay
// rect has changed.
void NotifyVirtualKeyboardOverlayRectObservers(const gfx::Rect&) const;
void RegisterContextMenuInsetsChangedObserver(
ContextMenuInsetsChangedObserver*);
// Notify observers that the context menu insets have changes. If the passed
// rect is empty, the insets should be removed.
void NotifyContextMenuInsetsObservers(const gfx::Rect&) const;
// This call will "show interest" in the Element with the provided DOMNodeID,
// which is presumed to have an `interesttarget` attribute.
void ShowInterestInElement(int) const;
// Bubbles a logical scroll to the parent frame, if one exists. For a local
// frame, this will continue the scroll synchronously. For remote frames and
// frame tree boundaries, this will IPC the scroll via the browser process.
// Returns true if the scroll is locally consumed, false otherwise.
bool BubbleLogicalScrollInParentFrame(mojom::blink::ScrollDirection direction,
ui::ScrollGranularity granularity);
// Receives and continues a bubbled logical scroll from the child frame (sent
// via the method above). This can either be called synchronously by the
// method above or from the RemoteFrame child after being sent via IPC.
// Returns true if the scroll is locally consumed, false otherwise.
bool BubbleLogicalScrollFromChildFrame(
mojom::blink::ScrollDirection direction,
ui::ScrollGranularity granularity,
Frame* child);
// =========================================================================
// All public functions below this point are candidates to move out of
// LocalFrame into another class.
// See layers_as_json.h for accepted flags.
String GetLayerTreeAsTextForTesting(unsigned flags = 0) const;
// Begin printing.
// If too large (in the inline direction), the frame content will fit to the
// page size with the specified maximum shrink ratio, if this value is larger
// than 1. If this value is 1 or less, there will be no shrinking.
void StartPrinting(const WebPrintParams&, float maximum_shrink_ratio = 0);
void StartPrintingSubLocalFrame();
void EndPrinting();
bool ShouldUsePaginatedLayout() const;
// Setup for a Paint Preview of the page which will paint the full page
// contents.
void StartPaintPreview();
void EndPaintPreview();
// Save the current scroll offset of the scrollable area associated with the
// given node (if not already saved). All saved scroll offsets can be restored
// via RestoreScrollOffsets() (this will also clear all entries for saved
// scroll offsets).
void EnsureSaveScrollOffset(Node&);
void RestoreScrollOffsets();
bool InViewSourceMode() const;
void SetInViewSourceMode(bool = true);
void SetLayoutZoomFactor(float);
float LayoutZoomFactor() const { return layout_zoom_factor_; }
void SetTextZoomFactor(float);
float TextZoomFactor() const { return text_zoom_factor_; }
void SetCssZoomFactor(float);
float CssZoomFactor() const { return css_zoom_factor_; }
void SetZoomFactors(float layout_zoom_factor,
float text_zoom_factor,
float css_zoom_factor);
double DevicePixelRatio() const;
// Informs the local root's document and its local descendant subtree that a
// media query value changed.
void MediaQueryAffectingValueChangedForLocalSubtree(MediaValueChange);
void ViewportSegmentsChanged(const std::vector<gfx::Rect>& viewport_segments);
void UpdateViewportSegmentCSSEnvironmentVariables(
const std::vector<gfx::Rect>& viewport_segments);
void UpdateViewportSegmentCSSEnvironmentVariables(
StyleEnvironmentVariables& vars,
const std::vector<gfx::Rect>& viewport_segments);
void OverrideDevicePostureForEmulation(
mojom::blink::DevicePostureType device_posture_param);
void DisableDevicePostureOverrideForEmulation();
mojom::blink::DevicePostureType GetDevicePosture();
String SelectedText() const;
String SelectedText(const TextIteratorBehavior& behavior) const;
String SelectedTextForClipboard() const;
void TextSelectionChanged(const WTF::String& selection_text,
uint32_t offset,
const gfx::Range& range) const;
PositionWithAffinityTemplate<EditingAlgorithm<NodeTraversal>>
PositionForPoint(const PhysicalOffset& frame_point);
Document* DocumentAtPoint(const PhysicalOffset&);
void RemoveSpellingMarkersUnderWords(const Vector<String>& words);
bool ShouldThrottleRendering() const;
// Returns frame scheduler for this frame.
// FrameScheduler is destroyed during frame detach and nullptr will be
// returned after it.
FrameScheduler* GetFrameScheduler();
scoped_refptr<base::SingleThreadTaskRunner> GetTaskRunner(TaskType);
void ScheduleVisualUpdateUnlessThrottled();
bool IsNavigationAllowed() const { return navigation_disable_count_ == 0; }
// destination_url is only used when a navigation is blocked due to
// framebusting defenses, in order to give the option of restarting the
// navigation at a later time.
bool CanNavigate(const Frame&, const KURL& destination_url = KURL());
void MaybeStartOutermostMainFrameNavigation(const Vector<KURL>& urls) const;
// Whether a navigation should replace the current history entry or not.
// Note this isn't exhaustive; there are other cases where a navigation does a
// replacement which this function doesn't cover.
bool NavigationShouldReplaceCurrentHistoryEntry(
const FrameLoadRequest& request,
WebFrameLoadType frame_load_type);
// Return this frame's BrowserInterfaceBroker. Must not be called on detached
// frames (that is, frames where `Client()` returns nullptr).
BrowserInterfaceBrokerProxy& GetBrowserInterfaceBroker();
InterfaceRegistry* GetInterfaceRegistry() { return interface_registry_; }
// Returns an AssociatedInterfaceProvider the frame can use to request
// navigation-associated interfaces from the browser. Messages transmitted
// over such interfaces will be dispatched in FIFO order with respect to each
// other and messages implementing navigation.
//
// Carefully consider whether an interface needs to be navigation-associated
// before introducing new navigation-associated interfaces.
//
// Navigation-associated interfaces are currently implemented as
// channel-associated interfaces. See
// https://chromium.googlesource.com/chromium/src/+/main/docs/mojo_ipc_conversion.md#Channel_Associated-Interfaces
AssociatedInterfaceProvider* GetRemoteNavigationAssociatedInterfaces();
LocalFrameClient* Client() const;
// Returns the widget for this frame, or from the nearest ancestor which is a
// local root. It is never null for frames in ordinary Pages (which means the
// Page is inside a WebView), except very early in initialization. For frames
// in a non-ordinary Page (without a WebView, such as in unit tests, popups,
// devtools), it will always be null.
FrameWidget* GetWidgetForLocalRoot();
WebContentSettingsClient* GetContentSettingsClient();
const mojom::RendererContentSettingsPtr& GetContentSettings() const;
PluginData* GetPluginData() const;
PerformanceMonitor* GetPerformanceMonitor() {
return performance_monitor_.Get();
}
IdlenessDetector* GetIdlenessDetector() { return idleness_detector_.Get(); }
AdTracker* GetAdTracker() { return ad_tracker_.Get(); }
void SetAdTrackerForTesting(AdTracker* ad_tracker);
LCPScriptObserver* GetScriptObserver() { return script_observer_.Get(); }
AttributionSrcLoader* GetAttributionSrcLoader() {
return attribution_src_loader_.Get();
}
enum class LazyLoadImageSetting { kDisabled, kEnabledExplicit };
// Returns the enabled state of lazyloading of images.
LazyLoadImageSetting GetLazyLoadImageSetting() const;
scoped_refptr<network::SharedURLLoaderFactory> GetURLLoaderFactory();
// For some tests, we use this method to create a URLLoader instead of using
// GetURLLoaderFactory().
std::unique_ptr<URLLoader> CreateURLLoaderForTesting();
scoped_refptr<WebBackgroundResourceFetchAssets>
MaybeGetBackgroundResourceFetchAssets();
bool IsInert() const { return is_inert_; }
// If the frame hosts a PluginDocument, this method returns the
// WebPluginContainerImpl that hosts the plugin. If the provided node is a
// plugin, then it returns its WebPluginContainerImpl. Otherwise, uses the
// currently focused element (if any).
// TODO(slangley): Refactor this method to extract the logic of looking up
// focused element or passed node into explicit methods.
WebPluginContainerImpl* GetWebPluginContainer(Node* = nullptr) const;
// Called on a view for a LocalFrame with a RemoteFrame parent. This makes
// viewport intersection and occlusion/obscuration available that accounts for
// remote ancestor frames and their respective scroll positions, clips, etc.
void SetViewportIntersectionFromParent(
const mojom::blink::ViewportIntersectionState& intersection_state);
gfx::Size GetOutermostMainFrameSize() const override;
gfx::Point GetOutermostMainFrameScrollPosition() const override;
void SetOpener(Frame* opener) override;
// See viewport_intersection_state.mojom for more info on these
// methods.
gfx::Rect RemoteViewportIntersection() const {
return intersection_state_.viewport_intersection;
}
gfx::Rect RemoteMainFrameIntersection() const {
return intersection_state_.main_frame_intersection;
}
gfx::Transform RemoteMainFrameTransform() const {
return intersection_state_.main_frame_transform;
}
mojom::blink::FrameOcclusionState GetOcclusionState() const;
bool NeedsOcclusionTracking() const;
// Replaces the initial empty document with a Document suitable for
// |mime_type| and populated with the contents of |data|. Only intended for
// use in internal-implementation LocalFrames that aren't in the frame tree.
void ForceSynchronousDocumentInstall(const AtomicString& mime_type,
const SegmentedBuffer& data);
// Called when certain event listeners are added for the first time/last time,
// making it possible/not possible to terminate the frame suddenly.
void UpdateSuddenTerminationStatus(
bool added_listener,
mojom::blink::SuddenTerminationDisablerType disabler_type);
// Called when we added an event listener that might affect sudden termination
// disabling of the page.
void AddedSuddenTerminationDisablerListener(const EventTarget& event_target,
const AtomicString& event_type);
// Called when we removed event listeners that might affect sudden termination
// disabling of the page.
void RemovedSuddenTerminationDisablerListener(const EventTarget& event_target,
const AtomicString& event_type);
// TODO(https://crbug.com/578349): provisional frames are a hack that should
// be removed.
bool IsProvisional() const;
// Returns the Page's `previous_main_frame_for_local_swap_` if set, or the
// LocalFrame for which `provisional_frame_ == this`. The LocalFrame returned
// will be swapped out in place of `this` as part of a
// LocalFrame <-> LocalFrame swap during navigation commit. This function may
// only be called on a provisional frame.
LocalFrame* GetPreviousLocalFrameForLocalSwap();
// Whether the frame is considered to be a root ad frame by Ad Tagging.
bool IsAdRoot() const;
// Called by the embedder on creation of the initial empty document and, for
// all other documents, just before commit (ReadyToCommitNavigation time).
void SetAdEvidence(const blink::FrameAdEvidence& ad_evidence);
// This is used to check if a script tagged as an ad is currently on the v8
// stack.
bool IsAdScriptInStack() const;
// The evidence for or against a frame being an ad. `std::nullopt` if not yet
// set or if the frame is a subfiltering root frame (outermost main frame) as
// only child frames can be tagged as ads.
const std::optional<blink::FrameAdEvidence>& AdEvidence() const {
return ad_evidence_;
}
bool IsFrameCreatedByAdScript() const {
return is_frame_created_by_ad_script_;
}
// Updates the frame color overlay to match the highlight ad setting.
void UpdateAdHighlight();
// Binds |receiver| and prevents resource loading until either the frame is
// navigated or the receiver pipe is closed.
void PauseSubresourceLoading(
mojo::PendingReceiver<blink::mojom::blink::PauseSubresourceLoadingHandle>
receiver);
void ResumeSubresourceLoading();
ClientHintsPreferences& GetClientHintsPreferences() {
return client_hints_preferences_;
}
mojom::blink::ReportingServiceProxy* GetReportingService();
mojom::blink::DevicePostureProvider* GetDevicePostureProvider();
// Returns the frame host ptr. The interface returned is backed by an
// associated interface with the legacy Chrome IPC channel.
mojom::blink::LocalFrameHost& GetLocalFrameHostRemote() const;
// Returns the bfcache controller host ptr. The interface returned is backed
// by an associated interface with the legacy Chrome IPC channel.
mojom::blink::BackForwardCacheControllerHost&
GetBackForwardCacheControllerHostRemote();
// Sets back/forward cache NotRestoredReasons for this frame. Only set for
// outermost main frame.
void SetNotRestoredReasons(
mojom::blink::BackForwardCacheNotRestoredReasonsPtr);
const mojom::blink::BackForwardCacheNotRestoredReasonsPtr&
GetNotRestoredReasons();
// Sets navigation confidence for this frame. Only set for outermost
// main frame.
void SetNavigationConfidence(double randomized_trigger_rate,
mojom::blink::ConfidenceLevel confidence);
const AtomicString& GetReducedAcceptLanguage() const {
return reduced_accept_language_;
}
void SetReducedAcceptLanguage(const AtomicString& reduced_accept_language);
// Overlays a color on top of this LocalFrameView if it is associated with
// the main frame. Should not have multiple consumers.
void SetMainFrameColorOverlay(SkColor color);
// Overlays a color on top of this LocalFrameView if it is associated with
// a subframe. Should not have multiple consumers.
void SetSubframeColorOverlay(SkColor color);
void UpdateFrameColorOverlayPrePaint();
void PaintFrameColorOverlay(GraphicsContext&);
// To be called from OomInterventionImpl.
void ForciblyPurgeV8Memory();
void OnPageLifecycleStateUpdated();
void WasHidden();
void WasShown();
bool IsHidden() const { return hidden_; }
// Whether the frame clips its content to the frame's size.
bool ClipsContent() const;
// Triggers a use counter if a feature, which is currently available in all
// frames, would be blocked by the introduction of permissions policy. This
// takes two counters (which may be the same). It triggers
// |blockedCrossOrigin| if the frame is cross-origin relative to the top-level
// document, and triggers |blockedSameOrigin| if it is same-origin with the
// top level, but is embedded in any way through a cross-origin frame.
// (A->B->A embedding)
void CountUseIfFeatureWouldBeBlockedByPermissionsPolicy(
mojom::WebFeature blocked_cross_origin,
mojom::WebFeature blocked_same_origin);
void FinishedLoading(FrameLoader::NavigationFinishState);
void UpdateFaviconURL();
using IsCapturingMediaCallback = base::RepeatingCallback<bool()>;
void SetIsCapturingMediaCallback(IsCapturingMediaCallback callback);
bool IsCapturingMedia() const;
void DidChangeVisibleToHitTesting() override;
WebPrescientNetworking* PrescientNetworking();
void SetPrescientNetworkingForTesting(
std::unique_ptr<WebPrescientNetworking> prescient_networking);
void CopyImageAtViewportPoint(const gfx::Point& viewport_point);
void MediaPlayerActionAtViewportPoint(
const gfx::Point& viewport_position,
const blink::mojom::blink::MediaPlayerActionType type,
bool enable);
void RequestVideoFrameAtWithBoundsHint(
const gfx::Point& viewport_position,
const gfx::Size& max_size,
int max_area,
base::OnceCallback<void(const SkBitmap&, const gfx::Rect&)> callback);
// Handle the request as a download. If the request is for a blob: URL,
// a BlobURLToken should be provided as |blob_url_token| to ensure the
// correct blob gets downloaded.
void DownloadURL(
const ResourceRequest& request,
network::mojom::blink::RedirectMode cross_origin_redirect_behavior);
void DownloadURL(
const ResourceRequest& request,
network::mojom::blink::RedirectMode cross_origin_redirect_behavior,
mojo::PendingRemote<mojom::blink::BlobURLToken> blob_url_token);
void NotifyUserActivation(
mojom::blink::UserActivationNotificationType notification_type);
void AddInspectorIssue(AuditsIssue issue);
void SaveImageAt(const gfx::Point& window_point);
void AdvanceFocusForIME(mojom::blink::FocusType focus_type);
void PostMessageEvent(
const std::optional<RemoteFrameToken>& source_frame_token,
const String& source_origin,
const String& target_origin,
BlinkTransferableMessage message);
void SetScaleFactor(float scale);
void ClosePageForTesting();
void SetInitialFocus(bool reverse);
#if BUILDFLAG(IS_MAC)
void GetCharacterIndexAtPoint(const gfx::Point& point);
#endif
#if !BUILDFLAG(IS_ANDROID)
void UpdateWindowControlsOverlay(const gfx::Rect& bounding_rect_in_dips);
void RegisterWindowControlsOverlayChangedDelegate(
WindowControlsOverlayChangedDelegate*);
// For PWAs with display_overrides, these getters are information about the
// titlebar bounds sent over from the browser via UpdateWindowControlsOverlay
// in LocalMainFrame that are needed to persist the lifetime of the frame.
const gfx::Rect& GetWindowControlsOverlayRect() const {
return window_controls_overlay_rect_;
}
bool IsWindowControlsOverlayVisible() const {
return is_window_controls_overlay_visible_;
}
#endif // !BUILDFLAG(IS_ANDROID)
SystemClipboard* GetSystemClipboard();
// Indicate that this frame was attached as a MainFrame.
void WasAttachedAsLocalMainFrame();
// Return true if the frame is able to access an event with the given
// attribution (i.e. the event is targeted for an origin that the frame may
// access).
bool CanAccessEvent(const WebInputEventAttribution&) const;
LocalFrameToken GetLocalFrameToken() const;
LoaderFreezeMode GetLoaderFreezeMode();
// Swaps `this` LocalFrame in to replace the current frame (e.g. in the case
// of subframes, `Owner()->frame()`, or in the case of the main frame,
// `GetPage()->Frame()`). Must only be called on provisional frames.
bool SwapIn();
// Replaces the active document with an empty document to free resources,
// e.g. for supporting tab discard.
void Discard();
void LoadJavaScriptURL(const KURL& url);
void RequestExecuteScript(int32_t world_id,
base::span<const WebScriptSource> sources,
mojom::blink::UserActivationOption,
mojom::blink::EvaluationTiming,
mojom::blink::LoadEventBlockingOption,
WebScriptExecutionCallback,
BackForwardCacheAware back_forward_cache_aware,
mojom::blink::WantResultOption,
mojom::blink::PromiseResultOption);
void SetEvictCachedSessionStorageOnFreezeOrUnload();
// Whether to maintain a trivial session history.
//
// One example is prerender.
// Explainer:
// https://github.com/jeremyroman/alternate-loading-modes/blob/main/browsing-context.md#session-history
bool ShouldMaintainTrivialSessionHistory() const;
TextFragmentHandler* GetTextFragmentHandler() const {
return text_fragment_handler_.Get();
}
void BindTextFragmentReceiver(
mojo::PendingReceiver<mojom::blink::TextFragmentReceiver> receiver);
void CreateTextFragmentHandler();
// Invokes on first paint, this method could be invoked multiple times, refer
// to FrameFirstPaint.
void OnFirstPaint(bool text_painted, bool image_painted);
// Invoked on first contentful paint on this frame.
void OnFirstContentfulPaint();
#if BUILDFLAG(IS_MAC)
void ResetTextInputHostForTesting();
void RebindTextInputHostForTesting();
#endif
void WriteIntoTrace(perfetto::TracedValue ctx) const;
bool AncestorOrSelfHasCSPEE() const { return ancestor_or_self_has_cspee_; }
void SetAncestorOrSelfHasCSPEE(bool has_policy) {
ancestor_or_self_has_cspee_ = has_policy;
}
void SetBackgroundColorPaintImageGeneratorForTesting(
BackgroundColorPaintImageGenerator* generator);
std::optional<SkColor> GetFrameOverlayColorForTesting() const;
// Returns a PendingRemote resolved via this frame's BrowserInterfaceBroker
// for use when creating the PublicUrlManager instance in threaded worklets.
// See `WorkletGlobalScope::TakeBlobUrlStorePendingRemote()` for more info.
mojo::PendingRemote<mojom::blink::BlobURLStore>
GetBlobUrlStorePendingRemote();
void AddScrollSnapshotClient(ScrollSnapshotClient&);
// Take a snapshot for relevant scrollers at the beginning of a frame update.
// https://drafts.csswg.org/scroll-animations-1/#avoiding-cycles
void UpdateScrollSnapshots();
// Each ScrollSnapshotClients has their internal state updated at
// a specific point in the lifecycle (see call to UpdateSnapshot).
// Since this call takes place *before* layout, ScrollSnapshotClients also
// get an additional opportunity to update their state (see ValidateSnapshot).
//
// The lifecycle update will call this function after style and layout has
// completed. The function will then go though all clients, and compare the
// current state snapshot to a fresh state snapshot. If they are equal, then
// no further action is needed. Otherwise, all effect targets associated
// with the client are marked for recalc, which causes the style/layout phase
// to run again.
//
// Returns true if all client states are valid, otherwise returns false.
//
// https://github.com/w3c/csswg-drafts/issues/5261
bool ValidateScrollSnapshotClients();
void ClearScrollSnapshotClients();
const HeapHashSet<WeakMember<ScrollSnapshotClient>>&
GetScrollSnapshotClientsForTesting() {
return scroll_snapshot_clients_;
}
void ScheduleNextServiceForScrollSnapshotClients();
void CheckPositionAnchorsForCssVisibilityChanges();
// This is called after all other position-visibility conditions have been
// checked.
void CheckPositionAnchorsForChainedVisibilityChanges();
using BlockingDetailsList = Vector<mojom::blink::BlockingDetailsPtr>;
static BlockingDetailsList ConvertFeatureAndLocationToMojomStruct(
const BFCacheBlockingFeatureAndLocations&,
const BFCacheBlockingFeatureAndLocations&);
bool IsSameOrigin();
v8_compile_hints::V8LocalCompileHintsProducer&
GetV8LocalCompileHintsProducer() {
return *v8_local_compile_hints_producer_;
}
// Returns whether images are allowed to load for the current frame. This is a
// convenience method that checks both renderer content settings and frame
// settings.
// Can only be called while the frame is not detached.
bool ImagesEnabled();
// Returns whether script is allowed to run for the current frame. This is a
// convenience method that checks both renderer content settings and frame
// settings.
// Can only be called while the frame is not detached.
bool ScriptEnabled();
const WebPrintParams& GetPrintParams() const;
// Returns the `Frame` for which `provisional_frame_ == this`. May only be
// called on a provisional frame.
Frame* GetProvisionalOwnerFrame();
// Return a keep alive handle for the browser side NavigationStateKeepAlive.
// The NavigationStateKeepAlive is created by a RenderFrameHost. Holding the
// pending receiver of this remote means the keep alive handle can still exist
// beyond the lifetime of the RenderFrameHost that created it.
mojo::PendingRemote<mojom::blink::NavigationStateKeepAliveHandle>
IssueKeepAliveHandle();
WebLinkPreviewTriggerer* GetOrCreateLinkPreviewTriggerer();
void SetLinkPreviewTriggererForTesting(
std::unique_ptr<WebLinkPreviewTriggerer> trigger);
void AllowStorageAccessAndNotify(
blink::WebContentSettingsClient::StorageType storage_type,
base::OnceCallback<void(bool)> callback);
bool AllowStorageAccessSyncAndNotify(
blink::WebContentSettingsClient::StorageType storage_type);
void NotifyFrameVisibilityChanged(mojom::blink::FrameVisibility visibility);
HeapHashSet<WeakMember<FrameVisibilityObserver>>&
GetFrameVisibilityObserverSet() {
return frame_visibility_observers_;
}
private:
friend class FrameNavigationDisabler;
// LocalFrameMojoHandler is a part of LocalFrame.
friend class LocalFrameMojoHandler;
FRIEND_TEST_ALL_PREFIXES(LocalFrameTest, CharacterIndexAtPointWithPinchZoom);
FRIEND_TEST_ALL_PREFIXES(WebFrameTest, SmartClipData);
FRIEND_TEST_ALL_PREFIXES(WebFrameTest, SmartClipDataWithPinchZoom);
FRIEND_TEST_ALL_PREFIXES(WebFrameTest,
SmartClipReturnsEmptyStringsWhenUserSelectIsNone);
FRIEND_TEST_ALL_PREFIXES(WebFrameTest, SmartClipDoesNotCrashPositionReversed);
// Frame protected overrides:
bool DetachImpl(FrameDetachType) override;
// Intentionally private to prevent redundant checks when the type is
// already LocalFrame.
bool IsLocalFrame() const override { return true; }
bool IsRemoteFrame() const override { return false; }
void EnableNavigation() { --navigation_disable_count_; }
void DisableNavigation() { ++navigation_disable_count_; }
// Internal implementation for starting and ending paint preview capture.
// `capturing` is true when capture starts and false when it ends.
void SetInvalidationForCapture(bool capturing);
// Internal implementation for starting or ending printing.
// |printing| is true when printing starts, false when printing ends.
// |maximum_shrink_ratio| is only meaningful when we should use printing
// layout for this frame.
void SetPrinting(bool printing, float maximum_shrink_ratio);
// FrameScheduler::Delegate overrides:
void UpdateTaskTime(base::TimeDelta time) override;
void UpdateBackForwardCacheDisablingFeatures(
BlockingDetails details) override;
const base::UnguessableToken& GetAgentClusterId() const override;
void OnTaskCompleted(base::TimeTicks start_time,
base::TimeTicks end_time) override;
void MainFrameInteractive() override;
void MainFrameFirstMeaningfulPaint() override;
DocumentResourceCoordinator* GetDocumentResourceCoordinator() override;
// Consumes and returns the transient user activation state this frame, after
// updating all other frames in the frame tree.
bool ConsumeTransientUserActivation(UserActivationUpdateSource update_source);
void SetFrameColorOverlay(SkColor color);
void DidFreeze();
void DidResume();
void SetContextPaused(bool);
// Helper for NavigationShouldReplaceCurrentHistoryEntry
bool ShouldReplaceForSameUrlNavigation(const FrameLoadRequest&);
HitTestResult HitTestResultForVisualViewportPos(
const gfx::Point& pos_in_viewport);
bool ShouldThrottleDownload();
void ExtractSmartClipDataInternal(const gfx::Rect& rect_in_viewport,
String& clip_text,
String& clip_html,
gfx::Rect& clip_rect);
#if !BUILDFLAG(IS_ANDROID)
void SetTitlebarAreaDocumentStyleEnvironmentVariables() const;
void MaybeUpdateWindowControlsOverlayWithNewZoomLevel();
#endif
void EnsureLinkPreviewTriggererInitialized();
std::unique_ptr<FrameScheduler> frame_scheduler_;
// Holds all PauseSubresourceLoadingHandles allowing either |this| to delete
// them explicitly or the pipe closing to delete them.
//
// LocalFrame can be reused by multiple ExecutionContext.
HeapMojoUniqueReceiverSet<blink::mojom::blink::PauseSubresourceLoadingHandle>
pause_handle_receivers_{nullptr};
// Keeps track of all the registered VK observers.
HeapHashSet<WeakMember<VirtualKeyboardOverlayChangedObserver>>
virtual_keyboard_overlay_changed_observers_;
// Keeps track of all the registered context menu insets observers.
HeapHashSet<WeakMember<ContextMenuInsetsChangedObserver>>
context_menu_insets_changed_observers_;
HeapHashSet<WeakMember<WidgetCreationObserver>> widget_creation_observers_;
mutable FrameLoader loader_;
// Cleared by LocalFrame::detach(), so as to keep the observable lifespan
// of LocalFrame::view().
Member<LocalFrameView> view_;
// Usually 0. Non-null if this is the top frame of PagePopup.
Member<Element> page_popup_owner_;
const Member<Editor> editor_;
const Member<FrameSelection> selection_;
const Member<EventHandler> event_handler_;
const Member<FrameConsole> console_;
int navigation_disable_count_;
// TODO(dcheng): In theory, this could be replaced by checking the
// FrameLoaderStateMachine if a real load has committed. Unfortunately, the
// internal state tracked there is incorrect today. See
// https://crbug.com/778318.
unsigned in_view_source_mode_ : 1;
// Whether this frame is frozen or not. This is a copy of Page::IsFrozen()
// and is stored here to ensure that we do not dispatch onfreeze() twice
// in a row and every onfreeze() has a single corresponding onresume().
unsigned frozen_ : 1;
// Whether this frame is paused or not. This is a copy of Page::IsPaused()
// and is stored here to ensure that we do not call SetContextPaused() twice
// in a row with the same argument.
unsigned paused_ : 1;
// Whether this frame is known to be completely occluded by other opaque
// OS-level windows.
unsigned hidden_ : 1;
// Whether DetachImpl() has run to completion on this LocalFrame.
unsigned did_run_detach_impl_ : 1 = false;
float layout_zoom_factor_;
float text_zoom_factor_;
float css_zoom_factor_;
Member<CoreProbeSink> probe_sink_;
scoped_refptr<InspectorTaskRunner> inspector_task_runner_;
Member<PerformanceMonitor> performance_monitor_;
Member<AdTracker> ad_tracker_;
Member<IdlenessDetector> idleness_detector_;
Member<AttributionSrcLoader> attribution_src_loader_;
Member<InspectorIssueReporter> inspector_issue_reporter_;
Member<InspectorTraceEvents> inspector_trace_events_;
// Access content_capture_manager_ through GetOrResetContentCaptureManager()
// because WebContentCaptureClient might already stop the capture.
Member<ContentCaptureManager> content_capture_manager_;
Member<LCPScriptObserver> script_observer_;
HistoryUserActivationState history_user_activation_state_;
InterfaceRegistry* const interface_registry_;
mojom::blink::ViewportIntersectionState intersection_state_;
// Only set for outermost main frame.
mojom::blink::BackForwardCacheNotRestoredReasonsPtr not_restored_reasons_;
ClientHintsPreferences client_hints_preferences_;
IsCapturingMediaCallback is_capturing_media_callback_;
Member<FrameOverlay> frame_color_overlay_;
std::optional<base::UnguessableToken> embedding_token_;
std::unique_ptr<WebPrescientNetworking> prescient_networking_;
Member<LocalFrameMojoHandler> mojo_handler_;
// Variable to control burst of download requests.
int num_burst_download_requests_ = 0;
base::TimeTicks burst_download_start_time_;
// Access to the global sanitized system clipboard.
Member<SystemClipboard> system_clipboard_;
// Access to background-color paint image generator. Initialized per local
// root and reused among sub frames.
Member<BackgroundColorPaintImageGenerator>
background_color_paint_image_generator_;
// TODO(crbug.com/1264553) : use a map from property id to
// NativePaintImageGenerator, then we could avoid needing to switch on the
// property in compositor_animations.cc
// Access to box shadow paint image
// generator. Initialized per local root and reused among sub frames.
Member<BoxShadowPaintImageGenerator> box_shadow_paint_image_generator_;
// Access to clip-path paint image generator. Initialized per local root and
// reused among sub frames.
Member<ClipPathPaintImageGenerator> clip_path_paint_image_generator_;
using SavedScrollOffsets = GCedHeapHashMap<Member<Node>, ScrollOffset>;
Member<SavedScrollOffsets> saved_scroll_offsets_;
// Created lazily when needed, either via the browser's SharedHighlighting
// binding to it or via a context menu with a selection being opened in a
// frame.
Member<TextFragmentHandler> text_fragment_handler_;
// ScrollSnapshotClients owned by elements in this frame. The clients must
// be registered at the actual elements as the references here are weak.
HeapHashSet<WeakMember<ScrollSnapshotClient>> scroll_snapshot_clients_;
#if !BUILDFLAG(IS_ANDROID)
bool is_window_controls_overlay_visible_ = false;
// |layout_zoom_factor_| is asynchronously set sometimes (most prominently
// seen on mac) in |LocalFrame| via |WebFrameWidgetImpl::SetZoomLevel| on
// navigation. We need to store the window_controls_overlay_rect sent from the
// browser in dips so we can convert the rect to blink space coordinates when
// |layout_zoom_factor_| gets updated this way.
gfx::Rect window_controls_overlay_rect_in_dips_;
gfx::Rect window_controls_overlay_rect_;
WeakMember<WindowControlsOverlayChangedDelegate>
window_controls_overlay_changed_delegate_;
#endif
// The evidence for or against a frame being an ad frame. `std::nullopt` if
// not yet set or if the frame is a subfiltering root frame. (Only non-root
// frames can be tagged as ad frames.) This is per-frame (as opposed to
// per-document) as we want to decide whether a frame is an ad or not before
// commit, while the document has not yet been created.
//
// This is constructed directly in the renderer in the case of an initial
// synchronous commit and otherwise is signaled from the browser process at
// ready-to-commit time.
std::optional<blink::FrameAdEvidence> ad_evidence_;
Member<LCPCriticalPathPredictor> lcpp_;
// True if this frame is a frame that had a script tagged as an ad on the v8
// stack at the time of creation. This is updated in `SetAdEvidence()`,
// allowing the bit to be propagated when a frame navigates cross-origin.
// Fenced frames do not set this bit for the initial empty document, see
// SubresourceFilterAgent::Initialize.
bool is_frame_created_by_ad_script_ = false;
// The ancestry chain of ad script identifiers leading to this frame's
// creation, ordered from the most immediate script (in the frame creation
// stack) to more distant ancestors (that created the immediately preceding
// script). Kept to defer instrumentation probe call until the frame is
// committed.
Vector<AdScriptIdentifier> provisional_ad_script_ancestry_;
bool evict_cached_session_storage_on_freeze_or_unload_ = false;
// Indicate if the current document's color scheme was notified.
bool notified_color_scheme_ = false;
// Stores whether this frame is affected by a CSPEE policy (from any ancestor
// frame). Calculated browser-side and used to help determine if this frame
// is allowed to load a new child opaque-ads fenced frame.
bool ancestor_or_self_has_cspee_ = false;
// Reduced accept language for top-level frame.
AtomicString reduced_accept_language_;
Member<v8_compile_hints::V8LocalCompileHintsProducer>
v8_local_compile_hints_producer_;
// This handle notifies the scheduler of whether the unload handler is used or
// not so it can block BFCache.
FrameScheduler::SchedulingAffectingFeatureHandle
feature_handle_for_scheduler_;
WebPrintParams print_params_;
BrowserInterfaceBrokerProxyImpl browser_interface_broker_proxy_;
// Holds WebLinkPreviewTriggerer instance if content renderer client wants to
// inject it. Note that `link_preview_triggerer_` may be nullptr after
// initialization.
bool is_link_preivew_triggerer_initialized_ = false;
std::unique_ptr<WebLinkPreviewTriggerer> link_preview_triggerer_;
HeapHashSet<WeakMember<FrameVisibilityObserver>> frame_visibility_observers_;
void OnStorageAccessCallback(base::OnceCallback<void(bool)> callback,
mojom::blink::StorageTypeAccessed storage_type,
bool isAllowed);
};
inline FrameLoader& LocalFrame::Loader() const {
return loader_;
}
inline LocalFrameView* LocalFrame::View() const {
return view_.Get();
}
inline FrameSelection& LocalFrame::Selection() const {
return *selection_;
}
inline Editor& LocalFrame::GetEditor() const {
return *editor_;
}
inline FrameConsole& LocalFrame::Console() const {
return *console_;
}
inline bool LocalFrame::InViewSourceMode() const {
return in_view_source_mode_;
}
inline void LocalFrame::SetInViewSourceMode(bool mode) {
in_view_source_mode_ = mode;
}
inline EventHandler& LocalFrame::GetEventHandler() const {
DCHECK(event_handler_);
return *event_handler_;
}
template <>
struct DowncastTraits<LocalFrame> {
static bool AllowFrom(const Frame& frame) { return frame.IsLocalFrame(); }
};
DECLARE_WEAK_IDENTIFIER_MAP(LocalFrame);
class FrameNavigationDisabler {
STACK_ALLOCATED();
public:
explicit FrameNavigationDisabler(LocalFrame&);
FrameNavigationDisabler(const FrameNavigationDisabler&) = delete;
FrameNavigationDisabler& operator=(const FrameNavigationDisabler&) = delete;
~FrameNavigationDisabler();
private:
LocalFrame* frame_;
};
} // namespace blink
#endif // THIRD_PARTY_BLINK_RENDERER_CORE_FRAME_LOCAL_FRAME_H_
|