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 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283
|
/*
* Copyright (C) 1999 Lars Knoll (knoll@kde.org)
* (C) 1999 Antti Koivisto (koivisto@kde.org)
* (C) 2001 Dirk Mueller (mueller@kde.org)
* (C) 2006 Alexey Proskuryakov (ap@webkit.org)
* Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2012 Apple Inc. All
* rights reserved.
* Copyright (C) 2008, 2009 Torch Mobile Inc. All rights reserved.
* (http://www.torchmobile.com/)
* Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies)
* Copyright (C) 2011 Google Inc. All rights reserved.
*
* 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_DOM_DOCUMENT_H_
#define THIRD_PARTY_BLINK_RENDERER_CORE_DOM_DOCUMENT_H_
#include <bitset>
#include <string>
#include <utility>
#include "base/memory/scoped_refptr.h"
#include "base/timer/elapsed_timer.h"
#include "services/metrics/public/cpp/ukm_source_id.h"
#include "services/network/public/mojom/referrer_policy.mojom-blink-forward.h"
#include "services/network/public/mojom/web_sandbox_flags.mojom-blink-forward.h"
#include "third_party/blink/public/common/metrics/document_update_reason.h"
#include "third_party/blink/public/mojom/feature_policy/document_policy_feature.mojom-blink-forward.h"
#include "third_party/blink/public/mojom/federated_learning/floc.mojom-blink-forward.h"
#include "third_party/blink/public/mojom/frame/color_scheme.mojom-blink-forward.h"
#include "third_party/blink/public/mojom/input/focus_type.mojom-blink-forward.h"
#include "third_party/blink/public/mojom/permissions/permission.mojom-blink-forward.h"
#include "third_party/blink/public/mojom/scroll/scrollbar_mode.mojom-blink-forward.h"
#include "third_party/blink/renderer/core/accessibility/axid.h"
#include "third_party/blink/renderer/core/core_export.h"
#include "third_party/blink/renderer/core/css/media_value_change.h"
#include "third_party/blink/renderer/core/dom/container_node.h"
#include "third_party/blink/renderer/core/dom/create_element_flags.h"
#include "third_party/blink/renderer/core/dom/document_encoding_data.h"
#include "third_party/blink/renderer/core/dom/document_lifecycle.h"
#include "third_party/blink/renderer/core/dom/document_timing.h"
#include "third_party/blink/renderer/core/dom/live_node_list_registry.h"
#include "third_party/blink/renderer/core/dom/qualified_name.h"
#include "third_party/blink/renderer/core/dom/synchronous_mutation_observer.h"
#include "third_party/blink/renderer/core/dom/text_link_colors.h"
#include "third_party/blink/renderer/core/dom/tree_scope.h"
#include "third_party/blink/renderer/core/dom/user_action_element_set.h"
#include "third_party/blink/renderer/core/editing/forward.h"
#include "third_party/blink/renderer/core/frame/fragment_directive.h"
#include "third_party/blink/renderer/core/html/parser/parser_synchronization_policy.h"
#include "third_party/blink/renderer/core/loader/font_preload_manager.h"
#include "third_party/blink/renderer/platform/bindings/dom_wrapper_world.h"
#include "third_party/blink/renderer/platform/bindings/exception_state.h"
#include "third_party/blink/renderer/platform/heap_observer_set.h"
#include "third_party/blink/renderer/platform/instrumentation/use_counter.h"
#include "third_party/blink/renderer/platform/scheduler/public/post_cancellable_task.h"
#include "third_party/blink/renderer/platform/supplementable.h"
#include "third_party/blink/renderer/platform/timer.h"
#include "third_party/blink/renderer/platform/weborigin/kurl.h"
#include "third_party/blink/renderer/platform/wtf/casting.h"
#include "third_party/blink/renderer/platform/wtf/hash_set.h"
namespace base {
class SingleThreadTaskRunner;
}
namespace ukm {
class UkmRecorder;
} // namespace ukm
namespace net {
class SiteForCookies;
} // namespace net
namespace network {
namespace mojom {
enum class CSPDisposition : int32_t;
} // namespace mojom
} // namespace network
namespace blink {
class AnimationClock;
class AXContext;
class AXObjectCache;
class Attr;
class BeforeUnloadEventListener;
class CDATASection;
class CSSStyleSheet;
class CanvasFontCache;
class ChromeClient;
class Comment;
class CompositorAnimationTimeline;
class ComputedAccessibleNode;
class DisplayLockDocumentState;
class DocumentData;
class ElementIntersectionObserverData;
class ComputedStyle;
class ConsoleMessage;
class ContextFeatures;
class CookieJar;
class DOMImplementation;
class DOMWindow;
class DocumentAnimations;
class DocumentFragment;
class DocumentInit;
class DocumentLoader;
class DocumentMarkerController;
class DocumentNameCollection;
class DocumentParser;
class DocumentResourceCoordinator;
class DocumentState;
class DocumentTimeline;
class DocumentType;
class DOMFeaturePolicy;
class Element;
class ElementDataCache;
class ElementRegistrationOptions;
class Event;
class EventFactoryBase;
class EventListener;
template <typename EventType>
class EventWithHitTestResults;
class FloatQuad;
class FloatRect;
class FontMatchingMetrics;
class FormController;
class FrameCallback;
class HTMLAllCollection;
class HTMLBodyElement;
class FrameScheduler;
class HTMLCollection;
class HTMLDialogElement;
class HTMLElement;
class HTMLFrameOwnerElement;
class HTMLHeadElement;
class HTMLImportLoader;
class HTMLImportsController;
class HTMLLinkElement;
class HTMLPopupElement;
class HTMLScriptElementOrSVGScriptElement;
class HitTestRequest;
class HttpRefreshScheduler;
class IdleRequestOptions;
class IdleTask;
class IntersectionObserverController;
class LayoutView;
class LazyLoadImageObserver;
class LiveNodeListBase;
class LocalDOMWindow;
class Locale;
class LocalFrame;
class LocalFrameView;
class Location;
class MediaQueryListListener;
class MediaQueryMatcher;
class NodeIterator;
class NthIndexCache;
class OriginAccessEntry;
class Page;
class PendingAnimations;
class ProcessingInstruction;
class PropertyRegistry;
class QualifiedName;
class Range;
class ResourceFetcher;
class RootScrollerController;
class ScriptValue;
class ScriptedIdleTaskController;
class SVGDocumentExtensions;
class SVGUseElement;
class Text;
class TrustedHTML;
class ScriptElementBase;
class ScriptPromise;
class ScriptRegexp;
class ScriptRunner;
class ScriptableDocumentParser;
class ScriptedAnimationController;
class SecurityOrigin;
class SelectorQueryCache;
class SerializedScriptValue;
class Settings;
class SlotAssignmentEngine;
class SnapCoordinator;
class StringOrElementCreationOptions;
class StyleEngine;
class StyleResolver;
class StylePropertyMapReadOnly;
class StyleSheetList;
class TextAutosizer;
class TransformSource;
class TreeWalker;
class V8NodeFilter;
class ViewportData;
class VisitedLinkState;
class WebComputedAXTree;
class WebMouseEvent;
class WorkletAnimationController;
enum class CSSPropertyID;
struct AnnotatedRegionValue;
struct FocusParams;
struct IconURL;
struct PhysicalOffset;
struct WebPrintPageDescription;
using MouseEventWithHitTestResults = EventWithHitTestResults<WebMouseEvent>;
enum NodeListInvalidationType : int {
kDoNotInvalidateOnAttributeChanges = 0,
kInvalidateOnClassAttrChange,
kInvalidateOnIdNameAttrChange,
kInvalidateOnNameAttrChange,
kInvalidateOnForAttrChange,
kInvalidateForFormControls,
kInvalidateOnHRefAttrChange,
kInvalidateOnAnyAttrChange,
};
const int kNumNodeListInvalidationTypes = kInvalidateOnAnyAttrChange + 1;
enum DocumentClass {
kDefaultDocumentClass = 0,
kHTMLDocumentClass = 1,
kXHTMLDocumentClass = 1 << 1,
kImageDocumentClass = 1 << 2,
kPluginDocumentClass = 1 << 3,
kMediaDocumentClass = 1 << 4,
kSVGDocumentClass = 1 << 5,
kXMLDocumentClass = 1 << 6,
};
enum ShadowCascadeOrder { kShadowCascadeNone, kShadowCascade };
using DocumentClassFlags = unsigned char;
// A map of IDL attribute name to Element value, for one particular element.
// For example,
// el1.ariaActiveDescendant = el2
// would add the following pair to the ExplicitlySetAttrElementMap for el1:
// ("ariaActiveDescendant", el2)
// This represents 'explicitly set attr-element' in the HTML specification.
// https://whatpr.org/html/3917/common-dom-interfaces.html#reflecting-content-attributes-in-idl-attributes:element-2
// Note that in the interest of simplicitly, attributes that reflect a single
// element reference are implemented using the same ExplicitlySetAttrElementsMap
// storage, but only store a single element vector which is DCHECKED at the
// calling site.
using ExplicitlySetAttrElementsMap =
HeapHashMap<QualifiedName, Member<HeapVector<Member<Element>>>>;
// A document (https://dom.spec.whatwg.org/#concept-document) is the root node
// of a tree of DOM nodes, generally resulting from the parsing of an markup
// (typically, HTML) resource.
//
// A document may or may not have a browsing context
// (https://html.spec.whatwg.org/#browsing-context). A document with a browsing
// context is created by navigation, and has a non-null domWindow(), GetFrame(),
// Loader(), etc., and is visible to the user. It will have a valid
// GetExecutionContext(), which will be equal to domWindow(). If the Document
// constructor receives a DocumentInit created WithDocumentLoader(), it will
// have a browsing context.
// Documents created by all other APIs do not have a browsing context. These
// Documents still have a valid GetExecutionContext() (i.e., the domWindow() of
// the Document in which they were created), so they can still access
// script, but return null for domWindow(), GetFrame() and Loader(). Generally,
// they should not downcast the ExecutionContext to a LocalDOMWindow and access
// the properties of the window directly.
// Finally, unit tests are allowed to create a Document that does not even
// have a valid GetExecutionContext(). This is a lightweight way to test
// properties of the Document and the DOM that do not require script.
class CORE_EXPORT Document : public ContainerNode,
public TreeScope,
public UseCounter,
public Supplementable<Document> {
DEFINE_WRAPPERTYPEINFO();
public:
// Factory for web-exposed Document constructor. The argument document must be
// a document instance representing window.document, and it works as the
// source of ExecutionContext and security origin of the new document.
// https://dom.spec.whatwg.org/#dom-document-document
static Document* Create(Document&);
explicit Document(const DocumentInit& init,
DocumentClassFlags flags = kDefaultDocumentClass);
~Document() override;
// Constructs a Document instance without a subclass for testing.
static Document* CreateForTest();
static Range* CreateRangeAdjustedToTreeScope(const TreeScope&,
const Position&);
// Support JS introspection of frame policy (e.g. feature policy).
DOMFeaturePolicy* featurePolicy();
MediaQueryMatcher& GetMediaQueryMatcher();
void MediaQueryAffectingValueChanged(MediaValueChange change);
using TreeScope::getElementById;
bool IsInitialEmptyDocument() const { return is_initial_empty_document_; }
// Sometimes we permit an initial empty document to cease to be the initial
// empty document. This is needed for cross-process navigations, where a new
// LocalFrame needs to be created but the conceptual frame might have had
// other Documents in a different process. document.open() also causes the
// document to cease to be the initial empty document.
void OverrideIsInitialEmptyDocument() { is_initial_empty_document_ = false; }
bool IsPrerendering() const { return is_prerendering_; }
// Gets the associated LocalDOMWindow even if this Document is associated with
// an HTMLImportsController.
LocalDOMWindow* ExecutingWindow() const;
network::mojom::ReferrerPolicy GetReferrerPolicy() const;
bool DocumentPolicyFeatureObserved(
mojom::blink::DocumentPolicyFeature feature);
String addressSpaceForBindings(ScriptState*) const;
bool CanContainRangeEndPoint() const override { return true; }
SelectorQueryCache& GetSelectorQueryCache();
// Focus Management.
Element* ActiveElement() const;
bool hasFocus() const;
// DOM methods & attributes for Document
DEFINE_ATTRIBUTE_EVENT_LISTENER(beforecopy, kBeforecopy)
DEFINE_ATTRIBUTE_EVENT_LISTENER(beforecut, kBeforecut)
DEFINE_ATTRIBUTE_EVENT_LISTENER(beforepaste, kBeforepaste)
DEFINE_ATTRIBUTE_EVENT_LISTENER(freeze, kFreeze)
DEFINE_ATTRIBUTE_EVENT_LISTENER(pointerlockchange, kPointerlockchange)
DEFINE_ATTRIBUTE_EVENT_LISTENER(pointerlockerror, kPointerlockerror)
DEFINE_ATTRIBUTE_EVENT_LISTENER(readystatechange, kReadystatechange)
DEFINE_ATTRIBUTE_EVENT_LISTENER(resume, kResume)
DEFINE_ATTRIBUTE_EVENT_LISTENER(search, kSearch)
DEFINE_ATTRIBUTE_EVENT_LISTENER(securitypolicyviolation,
kSecuritypolicyviolation)
DEFINE_ATTRIBUTE_EVENT_LISTENER(visibilitychange, kVisibilitychange)
ViewportData& GetViewportData() const { return *viewport_data_; }
void SetDoctype(DocumentType*);
DocumentType* doctype() const { return doc_type_.Get(); }
DOMImplementation& implementation();
Element* documentElement() const { return document_element_.Get(); }
Location* location() const;
Element* CreateElementForBinding(const AtomicString& local_name,
ExceptionState& = ASSERT_NO_EXCEPTION);
Element* CreateElementForBinding(const AtomicString& local_name,
const StringOrElementCreationOptions&,
ExceptionState&);
Element* createElementNS(const AtomicString& namespace_uri,
const AtomicString& qualified_name,
ExceptionState&);
Element* createElementNS(const AtomicString& namespace_uri,
const AtomicString& qualified_name,
const StringOrElementCreationOptions&,
ExceptionState&);
DocumentFragment* createDocumentFragment();
Text* createTextNode(const String& data);
Comment* createComment(const String& data);
CDATASection* createCDATASection(const String& data, ExceptionState&);
ProcessingInstruction* createProcessingInstruction(const String& target,
const String& data,
ExceptionState&);
Attr* createAttribute(const AtomicString& name, ExceptionState&);
Attr* createAttributeNS(const AtomicString& namespace_uri,
const AtomicString& qualified_name,
ExceptionState&);
Node* importNode(Node* imported_node, bool deep, ExceptionState&);
// "create an element" defined in DOM standard. This supports both of
// autonomous custom elements and customized built-in elements.
Element* CreateElement(const QualifiedName&,
const CreateElementFlags,
const AtomicString& is);
// Creates an element without custom element processing.
Element* CreateRawElement(const QualifiedName&,
const CreateElementFlags = CreateElementFlags());
Element* ElementFromPoint(double x, double y) const;
HeapVector<Member<Element>> ElementsFromPoint(double x, double y) const;
Range* caretRangeFromPoint(int x, int y);
Element* scrollingElement();
// When calling from C++ code, use this method. scrollingElement() is
// just for the web IDL implementation.
Element* ScrollingElementNoLayout();
String readyState() const;
AtomicString characterSet() const { return Document::EncodingName(); }
AtomicString EncodingName() const;
void SetContent(const String&);
String SuggestedMIMEType() const;
void SetMimeType(const AtomicString&);
AtomicString contentType() const; // DOM 4 document.contentType
const AtomicString& ContentLanguage() const { return content_language_; }
void SetContentLanguage(const AtomicString&);
String xmlEncoding() const { return xml_encoding_; }
String xmlVersion() const { return xml_version_; }
enum StandaloneStatus { kStandaloneUnspecified, kStandalone, kNotStandalone };
bool xmlStandalone() const { return xml_standalone_ == kStandalone; }
StandaloneStatus XmlStandaloneStatus() const {
return static_cast<StandaloneStatus>(xml_standalone_);
}
bool HasXMLDeclaration() const { return has_xml_declaration_; }
void SetXMLEncoding(const String& encoding) {
xml_encoding_ = encoding;
} // read-only property, only to be set from XMLDocumentParser
void setXMLVersion(const String&, ExceptionState&);
void setXMLStandalone(bool, ExceptionState&);
void SetHasXMLDeclaration(bool has_xml_declaration) {
has_xml_declaration_ = has_xml_declaration ? 1 : 0;
}
AtomicString visibilityState() const;
bool IsPageVisible() const;
bool hidden() const;
void DidChangeVisibilityState();
bool wasDiscarded() const;
void SetWasDiscarded(bool);
// If the document is "prefetch only", it will not be fully contstructed,
// and should never be displayed. Only a few resources will be loaded and
// scanned, in order to warm up caches.
bool IsPrefetchOnly() const;
Node* adoptNode(Node* source, ExceptionState&);
HTMLCollection* images();
HTMLCollection* embeds();
HTMLCollection* applets();
HTMLCollection* links();
HTMLCollection* forms();
HTMLCollection* anchors();
HTMLCollection* scripts();
HTMLAllCollection* all();
HTMLCollection* WindowNamedItems(const AtomicString& name);
DocumentNameCollection* DocumentNamedItems(const AtomicString& name);
HTMLCollection* DocumentAllNamedItems(const AtomicString& name);
// "defaultView" attribute defined in HTML spec.
DOMWindow* defaultView() const;
bool IsHTMLDocument() const { return document_classes_ & kHTMLDocumentClass; }
bool IsXHTMLDocument() const {
return document_classes_ & kXHTMLDocumentClass;
}
bool IsXMLDocument() const { return document_classes_ & kXMLDocumentClass; }
bool IsImageDocument() const {
return document_classes_ & kImageDocumentClass;
}
bool IsSVGDocument() const { return document_classes_ & kSVGDocumentClass; }
bool IsPluginDocument() const {
return document_classes_ & kPluginDocumentClass;
}
bool IsMediaDocument() const {
return document_classes_ & kMediaDocumentClass;
}
bool HasSVGRootNode() const;
bool IsFrameSet() const;
bool IsSrcdocDocument() const { return is_srcdoc_document_; }
bool IsMobileDocument() const { return is_mobile_document_; }
StyleResolver& GetStyleResolver() const;
bool IsViewSource() const { return is_view_source_; }
void SetIsViewSource(bool is_view_source) {
is_view_source_ = is_view_source;
}
// WebXR DOM Overlay support, cf https://immersive-web.github.io/dom-overlays/
// True if there's an ongoing "immersive-ar" WebXR session with a DOM Overlay
// element active. This is needed for applying the :xr-overlay pseudoclass
// and compositing/paint integration for this mode.
bool IsXrOverlay() const { return is_xr_overlay_; }
// Called from modules/xr's XRSystem when DOM Overlay mode starts and ends.
// This lazy-loads the UA stylesheet and updates the overlay element's
// pseudoclass.
void SetIsXrOverlay(bool enabled, Element* overlay_element);
bool SawElementsInKnownNamespaces() const {
return saw_elements_in_known_namespaces_;
}
bool IsScriptExecutionReady() const {
return HaveImportsLoaded() && HaveScriptBlockingStylesheetsLoaded();
}
bool IsForExternalHandler() const { return is_for_external_handler_; }
// This is a DOM function.
StyleSheetList& StyleSheets();
StyleEngine& GetStyleEngine() {
DCHECK(style_engine_.Get());
return *style_engine_.Get();
}
void ScheduleUseShadowTreeUpdate(SVGUseElement&);
void UnscheduleUseShadowTreeUpdate(SVGUseElement&);
void EvaluateMediaQueryList();
FormController& GetFormController();
DocumentState* GetDocumentState() const;
void SetStateForNewControls(const Vector<String>&);
LocalFrameView* View() const; // can be null
LocalFrame* GetFrame() const; // can be null
// Returns frame_ for current document, or if this is an HTML import,
// tree_root document's frame_, if any. Can be null.
// TODO(kochi): Audit usage of this interface (crbug.com/746150).
LocalFrame* GetFrameOfTreeRootDocument() const;
Page* GetPage() const; // can be null
Settings* GetSettings() const; // can be null
float DevicePixelRatio() const;
Range* createRange();
NodeIterator* createNodeIterator(Node* root,
unsigned what_to_show,
V8NodeFilter*);
TreeWalker* createTreeWalker(Node* root,
unsigned what_to_show,
V8NodeFilter*);
// Special support for editing
Text* CreateEditingTextNode(const String&);
void SetupFontBuilder(ComputedStyle& document_style);
bool NeedsLayoutTreeUpdate() const;
// Whether we need layout tree update for this node or not, without
// considering nodes in display locked subtrees.
bool NeedsLayoutTreeUpdateForNode(const Node&,
bool ignore_adjacent_style = false) const;
// Whether we need layout tree update for this node or not, including nodes in
// display locked subtrees.
bool NeedsLayoutTreeUpdateForNodeIncludingDisplayLocked(
const Node&,
bool ignore_adjacent_style = false) const;
// Update ComputedStyles and attach LayoutObjects if necessary, but don't
// lay out. This recursively invokes itself for all ancestor LocalFrames,
// because style in an ancestor frame can affect style in a child frame.
// This method is appropriate for cases where we need to ensure that the
// style for a single Document is up-to-date.
void UpdateStyleAndLayoutTree();
// Same as UpdateStyleAndLayoutTree, but does not recursively update style in
// ancestor frames. This method is intended to be used in cases where we can
// guarantee that ancestor frames already have clean style (e.g., from
// LocalFrameView::UpdateLifecyclePhases, which is a top-down iteration over
// the entire LocalFrame tree; or from Document::UpdateStyleAndLayout, which
// does its own ancestor tree walk).
void UpdateStyleAndLayoutTreeForThisDocument();
void UpdateStyleAndLayoutTreeForNode(const Node*);
void UpdateStyleAndLayoutTreeForSubtree(const Node*);
void UpdateStyleAndLayout(DocumentUpdateReason);
void LayoutUpdated();
enum RunPostLayoutTasks {
kRunPostLayoutTasksAsynchronously,
kRunPostLayoutTasksSynchronously,
};
void UpdateStyleAndLayoutForNode(const Node*, DocumentUpdateReason);
void IncLayoutCallsCounter() { ++layout_calls_counter_; }
void IncLayoutCallsCounterNG() { ++layout_calls_counter_ng_; }
void IncLayoutBlockCounter() { ++layout_blocks_counter_; }
void IncLayoutBlockCounterNG() { ++layout_blocks_counter_ng_; }
scoped_refptr<const ComputedStyle> StyleForPage(uint32_t page_index);
// Ensures that location-based data will be valid for a given node.
//
// This will run style and layout if they are currently dirty, and it may also
// run compositing inputs if the node is in a sticky subtree (as the sticky
// offset may change the node's position).
//
// Due to this you should only call this if you definitely need valid location
// data, otherwise use one of the |UpdateStyleAndLayout...| methods above.
void EnsurePaintLocationDataValidForNode(const Node*,
DocumentUpdateReason reason);
// Returns true if page box (margin boxes and page borders) is visible.
bool IsPageBoxVisible(uint32_t page_index);
// Gets the description for the specified page. This includes preferred page
// size and margins in pixels, assuming 96 pixels per inch. The size and
// margins must be initialized to the default values that are used if auto is
// specified.
void GetPageDescription(uint32_t page_index, WebPrintPageDescription*);
ResourceFetcher* Fetcher() const { return fetcher_.Get(); }
void Initialize();
virtual void Shutdown();
// If you have a Document, use GetLayoutView() instead which is faster.
void GetLayoutObject() const = delete;
LayoutView* GetLayoutView() const { return layout_view_; }
// This will return an AXObjectCache only if there's one or more
// AXContext associated with this document. When all associated
// AXContexts are deleted, the AXObjectCache will be removed.
AXObjectCache* ExistingAXObjectCache() const;
Document& AXObjectCacheOwner() const;
void ClearAXObjectCache();
// to get visually ordered hebrew and arabic pages right
bool VisuallyOrdered() const { return visually_ordered_; }
DocumentLoader* Loader() const;
// This is the DOM API document.open().
void open(LocalDOMWindow* entered_window, ExceptionState&);
// This is used internally and does not handle exceptions.
void open();
DocumentParser* OpenForNavigation(ParserSynchronizationPolicy,
const AtomicString& mime_type,
const AtomicString& encoding);
DocumentParser* ImplicitOpen(ParserSynchronizationPolicy);
// This is the DOM API document.open() implementation.
// document.open() opens a new window when called with three arguments.
Document* open(v8::Isolate*,
const AtomicString& type,
const AtomicString& replace,
ExceptionState&);
DOMWindow* open(v8::Isolate*,
const String& url_string,
const AtomicString& name,
const AtomicString& features,
ExceptionState&);
// This is the DOM API document.close().
void close(ExceptionState&);
// This is used internally and does not handle exceptions.
void close();
// Corresponds to "9. Abort the active document of browsingContext."
// https://html.spec.whatwg.org/C/#navigate
void Abort();
void CheckCompleted();
// Dispatches beforeunload into this document. Returns true if the
// beforeunload handler indicates that it is safe to proceed with an unload,
// false otherwise.
//
// |chrome_client| is used to synchronously get user consent (via a modal
// javascript dialog) to allow the unload to proceed if the beforeunload
// handler returns a non-null value, indicating unsaved state. If a
// null |chrome_client| is provided and the beforeunload returns a non-null
// value this function will automatically return false, indicating that the
// unload should not proceed. A null chrome client is set to by the freezing
// logic, which uses this to determine if a non-empty beforeunload handler
// is present before allowing discarding to proceed.
//
// |is_reload| indicates if the beforeunload is being triggered because of a
// reload operation, otherwise it is assumed to be a page close or navigation.
//
// |did_allow_navigation| is set to reflect the choice made by the user via
// the modal dialog. The value is meaningless if |auto_cancel|
// is true, in which case it will always be set to false.
bool DispatchBeforeUnloadEvent(ChromeClient* chrome_client,
bool is_reload,
bool& did_allow_navigation);
struct UnloadEventTiming {
bool can_request;
base::TimeTicks unload_event_start;
base::TimeTicks unload_event_end;
};
// Dispatches "pagehide", "visibilitychange" and "unload" events, if not
// dispatched already. Fills unload timing if present and |committing_origin|
// has access to the unload timing of the document.
void DispatchUnloadEvents(SecurityOrigin* committing_origin,
base::Optional<Document::UnloadEventTiming>*);
void DispatchFreezeEvent();
enum PageDismissalType {
kNoDismissal,
kBeforeUnloadDismissal,
kPageHideDismissal,
kUnloadVisibilityChangeDismissal,
kUnloadDismissal
};
PageDismissalType PageDismissalEventBeingDispatched() const;
void CancelParsing();
void write(const String& text,
LocalDOMWindow* entered_window = nullptr,
ExceptionState& = ASSERT_NO_EXCEPTION);
void writeln(const String& text,
LocalDOMWindow* entered_window = nullptr,
ExceptionState& = ASSERT_NO_EXCEPTION);
void write(v8::Isolate*, const Vector<String>& text, ExceptionState&);
void writeln(v8::Isolate*, const Vector<String>& text, ExceptionState&);
// TrustedHTML variants of the above.
// TODO(mkwst): Write a spec for this.
void write(v8::Isolate*, TrustedHTML*, ExceptionState&);
void writeln(v8::Isolate*, TrustedHTML*, ExceptionState&);
bool WellFormed() const { return well_formed_; }
// Return the document URL, or an empty URL if it's unavailable.
// This is not an implementation of web-exposed Document.prototype.URL.
const KURL& Url() const { return url_; }
void SetURL(const KURL&);
// Bind the url to document.url, if unavailable bind to about:blank.
KURL urlForBinding() const;
// To understand how these concepts relate to one another, please see the
// comments surrounding their declaration.
// Document base URL.
// https://html.spec.whatwg.org/C/#document-base-url
const KURL& BaseURL() const;
void SetBaseURLOverride(const KURL&);
const KURL& BaseURLOverride() const { return base_url_override_; }
KURL ValidBaseElementURL() const;
const AtomicString& BaseTarget() const { return base_target_; }
void ProcessBaseElement();
// Fallback base URL.
// https://html.spec.whatwg.org/C/#fallback-base-url
KURL FallbackBaseURL() const;
// Creates URL based on passed relative url and this documents base URL.
// Depending on base URL value it is possible that parent document
// base URL will be used instead. Uses CompleteURLWithOverride internally.
KURL CompleteURL(const String&) const;
// Creates URL based on passed relative url and passed base URL override.
KURL CompleteURLWithOverride(const String&,
const KURL& base_url_override) const;
const KURL& WebBundleClaimedUrl() const { return web_bundle_claimed_url_; }
// Determines whether a new document should take on the same origin as that of
// the document which created it.
static bool ShouldInheritSecurityOriginFromOwner(const KURL&);
CSSStyleSheet& ElementSheet();
virtual DocumentParser* CreateParser();
DocumentParser* Parser() const { return parser_.Get(); }
ScriptableDocumentParser* GetScriptableDocumentParser() const;
// FinishingPrinting denotes that the non-printing layout state is being
// restored.
enum PrintingState {
kNotPrinting,
kBeforePrinting,
kPrinting,
kFinishingPrinting
};
bool Printing() const { return printing_ == kPrinting; }
bool BeforePrintingOrPrinting() const {
return printing_ == kPrinting || printing_ == kBeforePrinting;
}
bool FinishingOrIsPrinting() {
return printing_ == kPrinting || printing_ == kFinishingPrinting;
}
void SetPrinting(PrintingState);
bool IsPaintingPreview() const { return is_painting_preview_; }
bool IsPrintingOrPaintingPreview() const {
return Printing() || IsPaintingPreview();
}
enum CompatibilityMode { kQuirksMode, kLimitedQuirksMode, kNoQuirksMode };
void SetCompatibilityMode(CompatibilityMode);
CompatibilityMode GetCompatibilityMode() const { return compatibility_mode_; }
String compatMode() const;
bool InQuirksMode() const { return compatibility_mode_ == kQuirksMode; }
bool InLimitedQuirksMode() const {
return compatibility_mode_ == kLimitedQuirksMode;
}
bool InNoQuirksMode() const { return compatibility_mode_ == kNoQuirksMode; }
bool InLineHeightQuirksMode() const { return !InNoQuirksMode(); }
// https://html.spec.whatwg.org/C/#documentreadystate
enum DocumentReadyState { kLoading, kInteractive, kComplete };
DocumentReadyState GetReadyState() const { return ready_state_; }
void SetReadyState(DocumentReadyState);
bool IsLoadCompleted() const;
bool IsFreezingInProgress() const { return is_freezing_in_progress_; }
enum ParsingState { kParsing, kInDOMContentLoaded, kFinishedParsing };
void SetParsingState(ParsingState);
bool Parsing() const { return parsing_state_ == kParsing; }
bool HasFinishedParsing() const { return parsing_state_ == kFinishedParsing; }
bool ShouldScheduleLayout() const;
TextLinkColors& GetTextLinkColors() { return text_link_colors_; }
const TextLinkColors& GetTextLinkColors() const { return text_link_colors_; }
VisitedLinkState& GetVisitedLinkState() const { return *visited_link_state_; }
MouseEventWithHitTestResults PerformMouseEventHitTest(const HitTestRequest&,
const PhysicalOffset&,
const WebMouseEvent&);
void SetHadKeyboardEvent(bool had_keyboard_event) {
had_keyboard_event_ = had_keyboard_event;
}
bool HadKeyboardEvent() const { return had_keyboard_event_; }
void SetLastFocusType(mojom::blink::FocusType last_focus_type);
mojom::blink::FocusType LastFocusType() const { return last_focus_type_; }
bool SetFocusedElement(Element*, const FocusParams&);
void ClearFocusedElement();
Element* FocusedElement() const { return focused_element_.Get(); }
UserActionElementSet& UserActionElements() { return user_action_elements_; }
const UserActionElementSet& UserActionElements() const {
return user_action_elements_;
}
ExplicitlySetAttrElementsMap* GetExplicitlySetAttrElementsMap(Element*);
// Returns false if the function fails. e.g. |pseudo| is not supported.
bool SetPseudoStateForTesting(Element& element,
const String& pseudo,
bool matches);
void EnqueueAutofocusCandidate(Element&);
bool HasAutofocusCandidates() const;
void FlushAutofocusCandidates();
void FinalizeAutofocus();
void SetSequentialFocusNavigationStartingPoint(Node*);
Element* SequentialFocusNavigationStartingPoint(
mojom::blink::FocusType) const;
void SetActiveElement(Element*);
Element* GetActiveElement() const { return active_element_.Get(); }
Element* HoverElement() const { return hover_element_.Get(); }
void RemoveFocusedElementOfSubtree(Node&, bool among_children_only = false);
void HoveredElementDetached(Element&);
void ActiveChainNodeDetached(Element&);
// Updates hover and active state of elements in the Document. The
// |is_active| param specifies whether the active state should be set or
// unset. |update_active_chain| is used to prevent updates to elements
// outside the frozen active chain; passing false will only refresh the
// active state of elements in the existing chain, but not outside of it. The
// given element is the inner-most element whose state is being modified.
// Hover is always applied.
void UpdateHoverActiveState(bool is_active,
bool update_active_chain,
Element*);
// Updates for :target (CSS3 selector).
void SetCSSTarget(Element*);
Element* CssTarget() const { return css_target_; }
void ScheduleLayoutTreeUpdateIfNeeded();
bool HasPendingForcedStyleRecalc() const;
void RegisterNodeList(const LiveNodeListBase*);
void UnregisterNodeList(const LiveNodeListBase*);
void RegisterNodeListWithIdNameCache(const LiveNodeListBase*);
void UnregisterNodeListWithIdNameCache(const LiveNodeListBase*);
bool ShouldInvalidateNodeListCaches(
const QualifiedName* attr_name = nullptr) const;
void InvalidateNodeListCaches(const QualifiedName* attr_name);
void AttachNodeIterator(NodeIterator*);
void DetachNodeIterator(NodeIterator*);
void MoveNodeIteratorsToNewDocument(Node&, Document&);
void AttachRange(Range*);
void DetachRange(Range*);
void DidMoveTreeToNewDocument(const Node& root);
// nodeChildrenWillBeRemoved is used when removing all node children at once.
void NodeChildrenWillBeRemoved(ContainerNode&);
// nodeWillBeRemoved is only safe when removing one node at a time.
void NodeWillBeRemoved(Node&);
bool CanAcceptChild(const Node& new_child,
const Node* next,
const Node* old_child,
ExceptionState&) const;
void DidInsertText(const CharacterData&, unsigned offset, unsigned length);
void DidRemoveText(const CharacterData&, unsigned offset, unsigned length);
void DidMergeTextNodes(const Text& merged_node,
const Text& node_to_be_removed,
unsigned old_length);
void DidSplitTextNode(const Text& old_node);
LocalDOMWindow* domWindow() const { return dom_window_; }
// Helper functions for forwarding LocalDOMWindow event related tasks to the
// LocalDOMWindow if it exists.
void SetWindowAttributeEventListener(const AtomicString& event_type,
EventListener*);
EventListener* GetWindowAttributeEventListener(
const AtomicString& event_type);
static void RegisterEventFactory(std::unique_ptr<EventFactoryBase>);
static Event* createEvent(ScriptState*,
const String& event_type,
ExceptionState&);
// keep track of what types of event listeners are registered, so we don't
// dispatch events unnecessarily
enum ListenerType {
kDOMSubtreeModifiedListener = 1,
kDOMNodeInsertedListener = 1 << 1,
kDOMNodeRemovedListener = 1 << 2,
kDOMNodeRemovedFromDocumentListener = 1 << 3,
kDOMNodeInsertedIntoDocumentListener = 1 << 4,
kDOMCharacterDataModifiedListener = 1 << 5,
kAnimationEndListener = 1 << 6,
kAnimationStartListener = 1 << 7,
kAnimationIterationListener = 1 << 8,
kAnimationCancelListener = 1 << 9,
kTransitionRunListener = 1 << 10,
kTransitionStartListener = 1 << 11,
kTransitionEndListener = 1 << 12,
kTransitionCancelListener = 1 << 13,
kScrollListener = 1 << 14,
kLoadListenerAtCapturePhaseOrAtStyleElement = 1 << 15,
// 0 bits remaining
};
bool HasListenerType(ListenerType listener_type) const {
return (listener_types_ & listener_type);
}
void AddListenerTypeIfNeeded(const AtomicString& event_type, EventTarget&);
bool HasMutationObserversOfType(MutationType type) const {
return mutation_observer_types_ & type;
}
bool HasMutationObservers() const { return mutation_observer_types_; }
void AddMutationObserverTypes(MutationType types) {
mutation_observer_types_ |= types;
}
IntersectionObserverController* GetIntersectionObserverController();
IntersectionObserverController& EnsureIntersectionObserverController();
// This is used to track IntersectionObservers for which this document is the
// explicit root. The IntersectionObserverController tracks *all* observers
// associated with this document; usually that's what you want.
ElementIntersectionObserverData*
DocumentExplicitRootIntersectionObserverData() const;
ElementIntersectionObserverData&
EnsureDocumentExplicitRootIntersectionObserverData();
const ScriptRegexp& EnsureEmailRegexp() const;
// Returns the owning element in the parent document. Returns nullptr if
// this is the top level document or the owner is remote.
HTMLFrameOwnerElement* LocalOwner() const;
void WillChangeFrameOwnerProperties(int margin_width,
int margin_height,
mojom::blink::ScrollbarMode,
bool is_display_none,
mojom::blink::ColorScheme color_scheme);
String title() const { return title_; }
void setTitle(const String&);
Element* TitleElement() const { return title_element_.Get(); }
void SetTitleElement(Element*);
void RemoveTitle(Element* title_element);
const AtomicString& dir();
void setDir(const AtomicString&);
String cookie(ExceptionState&) const;
void setCookie(const String&, ExceptionState&);
bool CookiesEnabled() const;
const AtomicString& referrer() const;
String domain() const;
void setDomain(const String& new_domain, ExceptionState&);
void OverrideLastModified(const AtomicString& modified) {
override_last_modified_ = modified;
}
String lastModified() const;
// The cookieURL is used to query the cookie database for this document's
// cookies. For example, if the cookie URL is http://example.com, we'll
// use the non-Secure cookies for example.com when computing
// document.cookie.
//
// Q: How is the cookieURL different from the document's URL?
// A: The two URLs are the same almost all the time. However, if one
// document inherits the security context of another document, it
// inherits its cookieURL but not its URL.
//
const KURL& CookieURL() const { return cookie_url_; }
// Returns null if the document is not attached to a frame.
scoped_refptr<const SecurityOrigin> TopFrameOrigin() const;
net::SiteForCookies SiteForCookies() const;
// Permissions service helper methods to facilitate requesting and checking
// storage access permissions.
mojom::blink::PermissionService* GetPermissionService(
ExecutionContext* execution_context);
void PermissionServiceConnectionError();
// Storage Access API methods to check for or request access to storage that
// may otherwise be blocked.
ScriptPromise hasStorageAccess(ScriptState* script_state);
ScriptPromise requestStorageAccess(ScriptState* script_state);
// Fragment directive API, currently used to feature detect text-fragments.
// https://wicg.github.io/scroll-to-text-fragment/#feature-detectability
FragmentDirective& fragmentDirective() const;
// Sends a query via Mojo to ask whether the user has any trust tokens. This
// can reject on permissions errors (e.g. associating |issuer| with the
// top-level origin would exceed the top-level origin's limit on the number of
// associated issuers) or on other internal errors (e.g. the network service
// is unavailable).
ScriptPromise hasTrustToken(ScriptState* script_state,
const String& issuer,
ExceptionState&);
// Floc service helper methods to facilitate querying the floc (i.e.
// interestCohort).
mojom::blink::FlocService* GetFlocService(
ExecutionContext* execution_context);
// Sends a query via Mojo to ask for the interest cohort. This can reject on
// permissions errors (e.g. preferences, content settings, feature policy,
// etc.) or when the interest cohort is unavailable.
// https://github.com/jkarlin/floc
ScriptPromise interestCohort(ScriptState* script_state, ExceptionState&);
// The following implements the rule from HTML 4 for what valid names are.
// To get this right for all the XML cases, we probably have to improve this
// or move it and make it sensitive to the type of document.
static bool IsValidName(const StringView&);
// The following breaks a qualified name into a prefix and a local name.
// It also does a validity check, and returns false if the qualified name
// is invalid. It also sets ExceptionCode when name is invalid.
static bool ParseQualifiedName(const AtomicString& qualified_name,
AtomicString& prefix,
AtomicString& local_name,
ExceptionState&);
// Checks to make sure prefix and namespace do not conflict (per DOM Core 3)
static bool HasValidNamespaceForElements(const QualifiedName&);
static bool HasValidNamespaceForAttributes(const QualifiedName&);
// "body element" as defined by HTML5
// (https://html.spec.whatwg.org/C/#the-body-element-2).
// That is, the first body or frameset child of the document element.
HTMLElement* body() const;
// "HTML body element" as defined by CSSOM View spec
// (https://drafts.csswg.org/cssom-view/#the-html-body-element).
// That is, the first body child of the document element.
HTMLBodyElement* FirstBodyElement() const;
void setBody(HTMLElement*, ExceptionState&);
void WillInsertBody();
HTMLHeadElement* head() const;
// Decide which element is to define the viewport's overflow policy.
Element* ViewportDefiningElement() const;
DocumentMarkerController& Markers() const { return *markers_; }
// Support for Javascript execCommand, and related methods
// See "core/editing/commands/document_exec_command.cc" for implementations.
bool execCommand(const String& command,
bool show_ui,
const String& value,
ExceptionState&);
bool IsRunningExecCommand() const { return is_running_exec_command_; }
bool queryCommandEnabled(const String& command, ExceptionState&);
bool queryCommandIndeterm(const String& command, ExceptionState&);
bool queryCommandState(const String& command, ExceptionState&);
bool queryCommandSupported(const String& command, ExceptionState&);
String queryCommandValue(const String& command, ExceptionState&);
KURL OpenSearchDescriptionURL();
// designMode support
bool InDesignMode() const { return design_mode_; }
String designMode() const;
void setDesignMode(const String&);
// The document of the parent frame.
Document* ParentDocument() const;
Document& TopDocument() const;
// Will only return nullptr in unit tests.
ExecutionContext* GetExecutionContext() const final;
ScriptRunner* GetScriptRunner() { return script_runner_.Get(); }
void currentScriptForBinding(HTMLScriptElementOrSVGScriptElement&) const;
void PushCurrentScript(ScriptElementBase*);
void PopCurrentScript(ScriptElementBase*);
void SetTransformSource(std::unique_ptr<TransformSource>);
TransformSource* GetTransformSource() const {
return transform_source_.get();
}
void IncDOMTreeVersion() {
DCHECK(lifecycle_.StateAllowsTreeMutations());
dom_tree_version_ = ++global_tree_version_;
}
uint64_t DomTreeVersion() const { return dom_tree_version_; }
uint64_t StyleVersion() const { return style_version_; }
enum PendingSheetLayout {
kNoLayoutWithPendingSheets,
kDidLayoutWithPendingSheets,
kIgnoreLayoutWithPendingSheets
};
Vector<IconURL> IconURLs(int icon_types_mask);
base::Optional<Color> ThemeColor() const;
// Returns the HTMLLinkElement currently in use for the Web Manifest.
// Returns null if there is no such element.
HTMLLinkElement* LinkManifest() const;
// Returns the HTMLLinkElement holding the canonical URL. Returns null if
// there is no such element.
HTMLLinkElement* LinkCanonical() const;
void UpdateFocusAppearanceAfterLayout();
void CancelFocusAppearanceUpdate();
// Return true after UpdateFocusAppearanceAfterLayout() call and before
// updating focus appearance.
bool WillUpdateFocusAppearance() const;
void SendFocusNotification(Element*, mojom::blink::FocusType);
bool IsDNSPrefetchEnabled() const { return is_dns_prefetch_enabled_; }
void ParseDNSPrefetchControlHeader(const String&);
void FinishedParsing();
void SetEncodingData(const DocumentEncodingData& new_data);
const WTF::TextEncoding& Encoding() const {
return encoding_data_.Encoding();
}
bool EncodingWasDetectedHeuristically() const {
return encoding_data_.WasDetectedHeuristically();
}
bool SawDecodingError() const { return encoding_data_.SawDecodingError(); }
void SetAnnotatedRegionsDirty(bool f) { annotated_regions_dirty_ = f; }
bool AnnotatedRegionsDirty() const { return annotated_regions_dirty_; }
bool HasAnnotatedRegions() const { return has_annotated_regions_; }
void SetHasAnnotatedRegions(bool f) { has_annotated_regions_ = f; }
const Vector<AnnotatedRegionValue>& AnnotatedRegions() const;
void SetAnnotatedRegions(const Vector<AnnotatedRegionValue>&);
void RemoveAllEventListeners() final;
const SVGDocumentExtensions* SvgExtensions();
SVGDocumentExtensions& AccessSVGExtensions();
bool AllowInlineEventHandler(Node*,
EventListener*,
const String& context_url,
const WTF::OrdinalNumber& context_line);
void StatePopped(scoped_refptr<SerializedScriptValue>);
enum LoadEventProgress {
kLoadEventNotRun,
kLoadEventInProgress,
kLoadEventCompleted,
kBeforeUnloadEventInProgress,
// Advanced to only if the beforeunload event in this document and
// subdocuments isn't canceled and will cause an unload. If beforeunload is
// canceled |load_event_progress_| will revert to its value prior to the
// beforeunload being dispatched.
kBeforeUnloadEventHandled,
kPageHideInProgress,
kUnloadVisibilityChangeInProgress,
kUnloadEventInProgress,
kUnloadEventHandled
};
bool LoadEventStillNeeded() const {
return load_event_progress_ == kLoadEventNotRun;
}
bool LoadEventFinished() const {
return load_event_progress_ >= kLoadEventCompleted;
}
bool BeforeUnloadStarted() const {
return load_event_progress_ >= kBeforeUnloadEventInProgress;
}
bool ProcessingBeforeUnload() const {
return load_event_progress_ == kBeforeUnloadEventInProgress;
}
bool UnloadStarted() const {
return load_event_progress_ >= kPageHideInProgress;
}
bool UnloadEventInProgress() const {
return load_event_progress_ == kUnloadEventInProgress;
}
void BeforeUnloadDoneWillUnload() {
load_event_progress_ = kBeforeUnloadEventHandled;
}
void SetContainsPlugins() { contains_plugins_ = true; }
bool ContainsPlugins() const { return contains_plugins_; }
void EnqueueResizeEvent();
void EnqueueScrollEventForNode(Node*);
void EnqueueScrollEndEventForNode(Node*);
void EnqueueOverscrollEventForNode(Node* target,
double delta_x,
double delta_y);
void EnqueueDisplayLockActivationTask(base::OnceClosure);
void EnqueueAnimationFrameTask(base::OnceClosure);
void EnqueueAnimationFrameEvent(Event*);
// Only one event for a target/event type combination will be dispatched per
// frame.
void EnqueueUniqueAnimationFrameEvent(Event*);
void EnqueueMediaQueryChangeListeners(
HeapVector<Member<MediaQueryListListener>>&);
void EnqueueVisualViewportScrollEvent();
void EnqueueVisualViewportResizeEvent();
void DispatchEventsForPrinting();
void exitPointerLock();
Element* PointerLockElement() const;
// Used to allow element that loads data without going through a FrameLoader
// to delay the 'load' event.
void IncrementLoadEventDelayCount() { ++load_event_delay_count_; }
void DecrementLoadEventDelayCount();
void CheckLoadEventSoon();
bool IsDelayingLoadEvent();
void LoadPluginsSoon();
// This calls checkCompleted() sync and thus can cause JavaScript execution.
void DecrementLoadEventDelayCountAndCheckLoadEvent();
const DocumentTiming& GetTiming() const { return document_timing_; }
int RequestAnimationFrame(FrameCallback*);
void CancelAnimationFrame(int id);
void ServiceScriptedAnimations(
base::TimeTicks monotonic_animation_start_time);
int RequestIdleCallback(IdleTask*, const IdleRequestOptions*);
void CancelIdleCallback(int id);
ScriptedAnimationController& GetScriptedAnimationController();
void InitDNSPrefetch();
bool IsInDocumentWrite() const { return write_recursion_depth_ > 0; }
TextAutosizer* GetTextAutosizer();
ScriptValue registerElement(ScriptState*,
const AtomicString& name,
const ElementRegistrationOptions*,
ExceptionState&);
void ClearImportsController();
HTMLImportsController* EnsureImportsController();
HTMLImportsController* ImportsController() const {
return imports_controller_;
}
HTMLImportLoader* ImportLoader() const;
bool IsHTMLImport() const;
Document& TreeRootDocument() const;
void DidLoadAllImports();
void AdjustFloatQuadsForScrollAndAbsoluteZoom(Vector<FloatQuad>&,
const LayoutObject&) const;
void AdjustFloatRectForScrollAndAbsoluteZoom(FloatRect&,
const LayoutObject&) const;
void SetContextFeatures(ContextFeatures&);
ContextFeatures& GetContextFeatures() const { return *context_features_; }
ElementDataCache* GetElementDataCache() { return element_data_cache_.Get(); }
void DidLoadAllScriptBlockingResources();
void DidAddPendingParserBlockingStylesheet();
void DidLoadAllPendingParserBlockingStylesheets();
void DidRemoveAllPendingStylesheets();
bool InStyleRecalc() const;
// Return a Locale for the default locale if the argument is null or empty.
Locale& GetCachedLocale(const AtomicString& locale = g_null_atom);
AnimationClock& GetAnimationClock();
const AnimationClock& GetAnimationClock() const;
DocumentAnimations& GetDocumentAnimations() const {
return *document_animations_;
}
DocumentTimeline& Timeline() const { return *timeline_; }
PendingAnimations& GetPendingAnimations() { return *pending_animations_; }
WorkletAnimationController& GetWorkletAnimationController() {
return *worklet_animation_controller_;
}
void AttachCompositorTimeline(CompositorAnimationTimeline*) const;
void DetachCompositorTimeline(CompositorAnimationTimeline*) const;
void AddToTopLayer(Element*, const Element* before = nullptr);
void RemoveFromTopLayer(Element*);
const HeapVector<Member<Element>>& TopLayerElements() const {
return top_layer_elements_;
}
HTMLDialogElement* ActiveModalDialog() const;
HeapVector<Member<HTMLPopupElement>>& PopupElementStack() {
return popup_element_stack_;
}
bool PopupShowing() const;
void HideTopmostPopupElement() const;
// This hides all visible popups up to, but not including,
// |endpoint|. If |endpoint| is nullptr, all popups are hidden.
void HideAllPopupsUntil(const HTMLPopupElement* endpoint);
// A non-null template_document_host_ implies that |this| was created by
// EnsureTemplateDocument().
bool IsTemplateDocument() const { return template_document_host_; }
Document& EnsureTemplateDocument();
Document* TemplateDocumentHost() { return template_document_host_; }
// TODO(thestig): Rename these and related functions, since we can call them
// for controls outside of forms as well.
void DidAssociateFormControl(Element*);
void AddConsoleMessage(ConsoleMessage* message,
bool discard_duplicates = false) const;
DocumentLifecycle& Lifecycle() { return lifecycle_; }
const DocumentLifecycle& Lifecycle() const { return lifecycle_; }
bool IsActive() const { return lifecycle_.IsActive(); }
bool IsDetached() const {
return lifecycle_.GetState() >= DocumentLifecycle::kStopping;
}
bool IsStopped() const {
return lifecycle_.GetState() == DocumentLifecycle::kStopped;
}
enum HttpRefreshType { kHttpRefreshFromHeader, kHttpRefreshFromMetaTag };
void MaybeHandleHttpRefresh(const String&, HttpRefreshType);
bool IsHttpRefreshScheduledWithin(base::TimeDelta interval);
void SetHasViewportUnits() { has_viewport_units_ = true; }
bool HasViewportUnits() const { return has_viewport_units_; }
void SetResizedForViewportUnits();
void ClearResizedForViewportUnits();
void InvalidateStyleAndLayoutForFontUpdates();
void Trace(Visitor*) const override;
AtomicString ConvertLocalName(const AtomicString&);
void PlatformColorsChanged();
NthIndexCache* GetNthIndexCache() const { return nth_index_cache_; }
CanvasFontCache* GetCanvasFontCache();
// Used by unit tests so that all parsing will be main thread for
// controlling parsing and chunking precisely.
static void SetThreadedParsingEnabledForTesting(bool);
static bool ThreadedParsingEnabledForTesting();
void IncrementNodeCount() { node_count_++; }
void DecrementNodeCount() {
DCHECK_GT(node_count_, 0);
node_count_--;
}
int NodeCount() const { return node_count_; }
SnapCoordinator& GetSnapCoordinator();
void PerformScrollSnappingTasks();
ShadowCascadeOrder GetShadowCascadeOrder() const {
return shadow_cascade_order_;
}
void SetShadowCascadeOrder(ShadowCascadeOrder);
bool ContainsShadowTree() const {
return shadow_cascade_order_ == ShadowCascadeOrder::kShadowCascade;
}
RootScrollerController& GetRootScrollerController() const {
DCHECK(root_scroller_controller_);
return *root_scroller_controller_;
}
bool IsInMainFrame() const;
const PropertyRegistry* GetPropertyRegistry() const {
return property_registry_;
}
PropertyRegistry& EnsurePropertyRegistry();
// Used to notify the embedder when the user edits the value of a
// text field in a non-secure context.
void MaybeQueueSendDidEditFieldInInsecureContext();
// May return nullptr when PerformanceManager instrumentation is disabled.
DocumentResourceCoordinator* GetResourceCoordinator();
const AtomicString& bgColor() const;
void setBgColor(const AtomicString&);
const AtomicString& fgColor() const;
void setFgColor(const AtomicString&);
const AtomicString& alinkColor() const;
void setAlinkColor(const AtomicString&);
const AtomicString& linkColor() const;
void setLinkColor(const AtomicString&);
const AtomicString& vlinkColor() const;
void setVlinkColor(const AtomicString&);
void clear() {}
void captureEvents() {}
void releaseEvents() {}
ukm::UkmRecorder* UkmRecorder();
ukm::SourceId UkmSourceID() const;
// Tracks and reports UKM metrics of the number of attempted font family match
// attempts (both successful and not successful) by the page.
FontMatchingMetrics* GetFontMatchingMetrics();
scoped_refptr<base::SingleThreadTaskRunner> GetTaskRunner(TaskType);
bool CurrentFrameHadRAF() const;
bool NextFrameHasPendingRAF() const;
StylePropertyMapReadOnly* ComputedStyleMap(Element*);
void AddComputedStyleMapItem(Element*, StylePropertyMapReadOnly*);
StylePropertyMapReadOnly* RemoveComputedStyleMapItem(Element*);
SlotAssignmentEngine& GetSlotAssignmentEngine();
bool IsSlotAssignmentOrLegacyDistributionDirty() const;
#if DCHECK_IS_ON()
unsigned& SlotAssignmentRecalcForbiddenRecursionDepth() {
return slot_assignment_recalc_forbidden_recursion_depth_;
}
bool IsSlotAssignmentRecalcForbidden() {
return slot_assignment_recalc_forbidden_recursion_depth_ > 0;
}
#else
bool IsSlotAssignmentRecalcForbidden() { return false; }
#endif
unsigned& FlatTreeTraversalForbiddenRecursionDepth() {
return flat_tree_traversal_forbidden_recursion_depth_;
}
bool IsFlatTreeTraversalForbidden() {
return flat_tree_traversal_forbidden_recursion_depth_ > 0;
}
unsigned& SlotAssignmentRecalcDepth() {
return slot_assignment_recalc_depth_;
}
bool IsInSlotAssignmentRecalc() const {
// Since we forbid recursive slot assignement recalc, the depth should be
// <= 1.
DCHECK_LE(slot_assignment_recalc_depth_, 1u);
return slot_assignment_recalc_depth_ == 1;
}
bool IsVerticalScrollEnforced() const { return is_vertical_scroll_enforced_; }
bool IsFocusAllowed() const;
LazyLoadImageObserver& EnsureLazyLoadImageObserver();
void IncrementNumberOfCanvases();
void ProcessJavaScriptUrl(const KURL&,
scoped_refptr<const DOMWrapperWorld> world);
DisplayLockDocumentState& GetDisplayLockDocumentState() const;
// Deferred compositor commits are disallowed by default, and are only allowed
// for same-origin navigations to an html document fetched with http.
bool DeferredCompositorCommitIsAllowed() {
return deferred_compositor_commit_is_allowed_;
}
void SetDeferredCompositorCommitIsAllowed(bool new_value) {
deferred_compositor_commit_is_allowed_ = new_value;
}
// Returns whether the document is inside the scope specified in the Web App
// Manifest. If the document doesn't run in a context of a Web App or has no
// associated Web App Manifest, it will return false.
bool IsInWebAppScope() const;
ComputedAccessibleNode* GetOrCreateComputedAccessibleNode(
AXID ax_id,
WebComputedAXTree* tree);
bool HaveRenderBlockingResourcesLoaded() const;
// Sets a beforeunload handler for documents which are embedding plugins. This
// includes PluginDocument as well as an HTMLDocument which embeds a plugin
// inside a cross-process frame (MimeHandlerView).
void SetShowBeforeUnloadDialog(bool show_dialog);
void ColorSchemeChanged();
// A new vision deficiency is being emulated through DevTools.
void VisionDeficiencyChanged();
// A META element with name=color-scheme was added, removed, or modified.
// Update the presentation level color-scheme property for the root element.
void ColorSchemeMetaChanged();
// A META element with name=battery-savings was added, removed, or modified.
// Re-collect the META values that apply and pass to LayerTreeHost.
void BatterySavingsMetaChanged();
// Use counter related functions.
void CountUse(mojom::WebFeature feature) final;
void CountUse(mojom::WebFeature feature) const;
void CountProperty(CSSPropertyID property_id) const;
void CountAnimatedProperty(CSSPropertyID property_id) const;
// Return whether the Feature was previously counted for this document.
// NOTE: only for use in testing.
bool IsUseCounted(mojom::WebFeature) const;
// Return whether the property was previously counted for this document.
// NOTE: only for use in testing.
bool IsPropertyCounted(CSSPropertyID property) const;
// Return whether the animated property was previously counted for this
// document.
// NOTE: only for use in testing.
bool IsAnimatedPropertyCounted(CSSPropertyID property) const;
void ClearUseCounterForTesting(mojom::WebFeature);
void UpdateForcedColors();
bool InForcedColorsMode() const;
bool InDarkMode();
// Capture the toggle event during parsing either by HTML parser or XML
// parser.
void SetToggleDuringParsing(bool toggle_during_parsing) {
toggle_during_parsing_ = toggle_during_parsing;
}
bool ToggleDuringParsing() { return toggle_during_parsing_; }
// We setup a dummy document to sanitize clipboard markup before pasting.
// Sets and indicates whether this is the dummy document.
void SetIsForMarkupSanitization(bool is_for_sanitization) {
is_for_markup_sanitization_ = is_for_sanitization;
}
bool IsForMarkupSanitization() const { return is_for_markup_sanitization_; }
bool HasPendingJavaScriptUrlsForTest() {
return !pending_javascript_urls_.IsEmpty();
}
String GetFragmentDirective() const { return fragment_directive_string_; }
bool UseCountFragmentDirective() const {
return use_count_fragment_directive_;
}
void ApplyScrollRestorationLogic();
void MarkHasFindInPageRequest();
void MarkHasFindInPageContentVisibilityActiveMatch();
void MarkHasFindInPageBeforematchExpandedHiddenMatchable();
void CancelPendingJavaScriptUrls();
HeapObserverSet<SynchronousMutationObserver>&
SynchronousMutationObserverSet() {
return synchronous_mutation_observer_set_;
}
void NotifyUpdateCharacterData(CharacterData* character_data,
unsigned offset,
unsigned old_length,
unsigned new_length);
void NotifyChangeChildren(const ContainerNode& container);
FontPreloadManager& GetFontPreloadManager() { return *font_preload_manager_; }
void FontPreloadingFinishedOrTimedOut();
void IncrementAsyncScriptCount() { async_script_count_++; }
void RecordAsyncScriptCount();
void MarkFirstPaint();
void MaybeExecuteDelayedAsyncScripts();
enum class DeclarativeShadowRootAllowState : uint8_t {
kNotSet,
kAllow,
kDeny
};
DeclarativeShadowRootAllowState GetDeclarativeShadowRootAllowState() const;
void setAllowDeclarativeShadowRoots(bool val);
void SetFindInPageActiveMatchNode(Node*);
const Node* GetFindInPageActiveMatchNode() const;
class CORE_EXPORT PaintPreviewScope {
STACK_ALLOCATED();
public:
explicit PaintPreviewScope(Document& document);
~PaintPreviewScope();
PaintPreviewScope(PaintPreviewScope&) = delete;
PaintPreviewScope& operator=(PaintPreviewScope&) = delete;
private:
Document& document_;
};
bool IsDirAttributeDirty() { return dir_attribute_dirty_; }
void SetDirAttributeDirty() { dir_attribute_dirty_ = true; }
protected:
void ClearXMLVersion() { xml_version_ = String(); }
virtual Document* CloneDocumentWithoutChildren() const;
void LockCompatibilityMode() { compatibility_mode_locked_ = true; }
ParserSynchronizationPolicy GetParserSynchronizationPolicy() const {
return parser_sync_policy_;
}
private:
friend class DocumentTest;
friend class IgnoreDestructiveWriteCountIncrementer;
friend class ThrowOnDynamicMarkupInsertionCountIncrementer;
friend class IgnoreOpensDuringUnloadCountIncrementer;
friend class NthIndexCache;
friend class CanvasRenderingAPIUkmMetricsTest;
friend class OffscreenCanvasRenderingAPIUkmMetricsTest;
FRIEND_TEST_ALL_PREFIXES(FrameFetchContextSubresourceFilterTest,
DuringOnFreeze);
FRIEND_TEST_ALL_PREFIXES(DocumentTest, FindInPageUkm);
FRIEND_TEST_ALL_PREFIXES(DocumentTest, FindInPageUkmInFrame);
FRIEND_TEST_ALL_PREFIXES(TextFinderSimTest,
BeforeMatchExpandedHiddenMatchableUkm);
FRIEND_TEST_ALL_PREFIXES(TextFinderSimTest,
BeforeMatchExpandedHiddenMatchableUkmNoHandler);
class NetworkStateObserver;
friend class AXContext;
void AddAXContext(AXContext*);
void RemoveAXContext(AXContext*);
bool IsDocumentFragment() const =
delete; // This will catch anyone doing an unnecessary check.
bool IsDocumentNode() const =
delete; // This will catch anyone doing an unnecessary check.
bool IsElementNode() const =
delete; // This will catch anyone doing an unnecessary check.
ScriptedIdleTaskController& EnsureScriptedIdleTaskController();
bool HasPendingVisualUpdate() const {
return lifecycle_.GetState() == DocumentLifecycle::kVisualUpdatePending;
}
bool ShouldScheduleLayoutTreeUpdate() const;
void ScheduleLayoutTreeUpdate();
bool NeedsFullLayoutTreeUpdate() const;
void PropagateStyleToViewport();
void UpdateUseShadowTreesIfNeeded();
void EvaluateMediaQueryListIfNeeded();
void UpdateStyleInvalidationIfNeeded();
void UpdateStyle();
void NotifyLayoutTreeOfSubtreeChanges();
bool ChildrenCanHaveStyle() const final;
// ImplicitClose() actually does the work of closing the input stream.
void ImplicitClose();
bool ShouldComplete();
// Returns |true| if both document and its owning frame are still attached.
// Any of them could be detached during the check, e.g. by calling
// iframe.remove() from an event handler.
bool CheckCompletedInternal();
void DetachParser();
void BeginLifecycleUpdatesIfRenderingReady();
void ChildrenChanged(const ChildrenChange&) override;
String nodeName() const final;
NodeType getNodeType() const final;
bool ChildTypeAllowed(NodeType) const final;
Node* Clone(Document&, CloneChildrenFlag) const override;
void CloneDataFromDocument(const Document&);
ShadowCascadeOrder shadow_cascade_order_ = kShadowCascadeNone;
void UpdateTitle(const String&);
void DispatchDidReceiveTitle();
void UpdateFocusAppearance();
void UpdateBaseURL();
void ExecuteScriptsWaitingForResources();
void ExecuteJavaScriptUrls();
void LoadEventDelayTimerFired(TimerBase*);
void PluginLoadingTimerFired(TimerBase*);
void AddListenerType(ListenerType listener_type) {
listener_types_ |= listener_type;
}
void AddMutationEventListenerTypeIfEnabled(ListenerType);
void DidAssociateFormControlsTimerFired(TimerBase*);
void ClearFocusedElementSoon();
void ClearFocusedElementTimerFired(TimerBase*);
bool HasNonEmptyFragment() const;
bool HaveScriptBlockingStylesheetsLoaded() const;
void SetHoverElement(Element*);
using EventFactorySet = HashSet<std::unique_ptr<EventFactoryBase>>;
static EventFactorySet& EventFactories();
void SetNthIndexCache(NthIndexCache* nth_index_cache) {
DCHECK(!nth_index_cache_ || !nth_index_cache);
nth_index_cache_ = nth_index_cache;
}
const OriginAccessEntry& AccessEntryFromURL();
void SendDidEditFieldInInsecureContext();
bool HaveImportsLoaded() const;
void UpdateActiveState(bool is_active, bool update_active_chain, Element*);
void UpdateHoverState(Element*);
const AtomicString& BodyAttributeValue(const QualifiedName&) const;
void SetBodyAttribute(const QualifiedName&, const AtomicString&);
// Returns true if use of |method_name| for markup insertion is allowed by
// feature policy; otherwise returns false and throws a DOM exception.
bool AllowedToUseDynamicMarkUpInsertion(const char* method_name,
ExceptionState&);
void SetFreezingInProgress(bool is_freezing_in_progress) {
is_freezing_in_progress_ = is_freezing_in_progress;
}
void NotifyFocusedElementChanged(Element* old_focused_element,
Element* new_focused_element,
mojom::blink::FocusType focus_type);
void DisplayNoneChangedForFrame();
// Handles a connection error to |has_trust_tokens_answerer_| by rejecting all
// pending promises created by |hasTrustToken|.
void HasTrustTokensAnswererConnectionError();
DocumentLifecycle lifecycle_;
bool is_initial_empty_document_;
// Track the prerendering state.
// TODO(crbug.com/1169032): Update the flag on the prerendering activation.
// Also, we will merge the state into the lifecycle state eventually.
const bool is_prerendering_;
bool evaluate_media_queries_on_style_recalc_;
// If we do ignore the pending stylesheet count, then we need to add a boolean
// to track that this happened so that we can do a full repaint when the
// stylesheets do eventually load.
PendingSheetLayout pending_sheet_layout_;
Member<LocalDOMWindow> dom_window_;
Member<HTMLImportsController> imports_controller_;
// For Documents given a dom_window_ at creation that are not Shutdown(),
// execution_context_ and dom_window_ will be equal.
// For Documents given a dom_window_ at creation that are Shutdown(),
// execution_context_ will be nullptr.
// For Documents not given a dom_window_ at creation, execution_context_
// will be the LocalDOMWindow where script will execute (which may be nullptr
// in unit tests).
Member<ExecutionContext> execution_context_;
Member<ResourceFetcher> fetcher_;
Member<DocumentParser> parser_;
Member<ContextFeatures> context_features_;
Member<HttpRefreshScheduler> http_refresh_scheduler_;
bool well_formed_;
// Document URLs.
KURL url_; // Document.URL: The URL from which this document was retrieved.
KURL base_url_; // Node.baseURI: The URL to use when resolving relative URLs.
KURL base_url_override_; // An alternative base URL that takes precedence
// over base_url_ (but not base_element_url_).
KURL base_element_url_; // The URL set by the <base> element.
KURL cookie_url_; // The URL to use for cookie access.
std::unique_ptr<OriginAccessEntry> access_entry_from_url_;
KURL web_bundle_claimed_url_;
AtomicString base_target_;
// Mime-type of the document in case it was cloned or created by XHR.
AtomicString mime_type_;
Member<DocumentType> doc_type_;
Member<DOMImplementation> implementation_;
Member<CSSStyleSheet> elem_sheet_;
PrintingState printing_;
bool is_painting_preview_;
CompatibilityMode compatibility_mode_;
// This is cheaper than making setCompatibilityMode virtual.
bool compatibility_mode_locked_;
TaskHandle execute_scripts_waiting_for_resources_task_handle_;
TaskHandle javascript_url_task_handle_;
struct PendingJavascriptUrl {
public:
PendingJavascriptUrl(const KURL& input_url,
scoped_refptr<const DOMWrapperWorld> world)
: url(input_url), world(std::move(world)) {}
KURL url;
// The world in which the navigation to |url| initiated. Non-null.
scoped_refptr<const DOMWrapperWorld> world;
};
Vector<PendingJavascriptUrl> pending_javascript_urls_;
// https://html.spec.whatwg.org/C/#autofocus-processed-flag
bool autofocus_processed_flag_ = false;
mojom::blink::FocusType last_focus_type_;
bool had_keyboard_event_;
HeapTaskRunnerTimer<Document> clear_focused_element_timer_;
// https://html.spec.whatwg.org/C/#autofocus-candidates
// We implement this as a Vector because its maximum size is typically 1.
HeapVector<Member<Element>> autofocus_candidates_;
Member<Element> focused_element_;
Member<Range> sequential_focus_navigation_starting_point_;
Member<Element> hover_element_;
Member<Element> active_element_;
Member<Element> document_element_;
UserActionElementSet user_action_elements_;
Member<RootScrollerController> root_scroller_controller_;
double overscroll_accumulated_delta_x_ = 0;
double overscroll_accumulated_delta_y_ = 0;
uint64_t dom_tree_version_;
static uint64_t global_tree_version_;
uint64_t style_version_;
HeapHashSet<WeakMember<NodeIterator>> node_iterators_;
using AttachedRangeSet = HeapHashSet<WeakMember<Range>>;
AttachedRangeSet ranges_;
uint16_t listener_types_;
MutationObserverOptions mutation_observer_types_;
Member<ElementIntersectionObserverData>
document_explicit_root_intersection_observer_data_;
Member<StyleEngine> style_engine_;
Member<StyleSheetList> style_sheet_list_;
Member<FormController> form_controller_;
TextLinkColors text_link_colors_;
const Member<VisitedLinkState> visited_link_state_;
bool visually_ordered_;
using ElementComputedStyleMap =
HeapHashMap<WeakMember<Element>, Member<StylePropertyMapReadOnly>>;
ElementComputedStyleMap element_computed_style_map_;
DocumentReadyState ready_state_;
ParsingState parsing_state_;
bool is_dns_prefetch_enabled_;
bool have_explicitly_disabled_dns_prefetch_;
bool contains_plugins_;
// https://html.spec.whatwg.org/C/dynamic-markup-insertion.html#ignore-destructive-writes-counter
unsigned ignore_destructive_write_count_;
// https://html.spec.whatwg.org/C/dynamic-markup-insertion.html#throw-on-dynamic-markup-insertion-counter
unsigned throw_on_dynamic_markup_insertion_count_;
// https://html.spec.whatwg.org/C/dynamic-markup-insertion.html#ignore-opens-during-unload-counter
unsigned ignore_opens_during_unload_count_;
bool ignore_opens_and_writes_for_abort_ = false;
String title_;
String raw_title_;
Member<Element> title_element_;
Vector<AXContext*> ax_contexts_;
Member<AXObjectCache> ax_object_cache_;
Member<DocumentMarkerController> markers_;
bool update_focus_appearance_after_layout_ = false;
Member<Element> css_target_;
bool was_discarded_;
LoadEventProgress load_event_progress_;
bool is_freezing_in_progress_;
base::ElapsedTimer start_time_;
Member<ScriptRunner> script_runner_;
HeapVector<Member<ScriptElementBase>> current_script_stack_;
std::unique_ptr<TransformSource> transform_source_;
String xml_encoding_;
String xml_version_;
unsigned xml_standalone_ : 2;
unsigned has_xml_declaration_ : 1;
AtomicString content_language_;
DocumentEncodingData encoding_data_;
bool design_mode_;
bool is_running_exec_command_;
HeapHashSet<WeakMember<const LiveNodeListBase>>
lists_invalidated_at_document_;
LiveNodeListRegistry node_lists_;
Member<SVGDocumentExtensions> svg_extensions_;
Vector<AnnotatedRegionValue> annotated_regions_;
bool has_annotated_regions_;
bool annotated_regions_dirty_;
std::unique_ptr<SelectorQueryCache> selector_query_cache_;
// It is safe to keep a raw, untraced pointer to this stack-allocated
// cache object: it is set upon the cache object being allocated on
// the stack and cleared upon leaving its allocated scope. Hence it
// is acceptable not to trace it -- should a conservative GC occur,
// the cache object's references will be traced by a stack walk.
GC_PLUGIN_IGNORE("461878")
NthIndexCache* nth_index_cache_ = nullptr;
DocumentClassFlags document_classes_;
bool is_view_source_;
bool is_xr_overlay_;
bool saw_elements_in_known_namespaces_;
bool is_srcdoc_document_;
bool is_mobile_document_;
LayoutView* layout_view_;
// The last element in |top_layer_elements_| is topmost in the top layer
// stack and is thus the one that will be visually on top.
HeapVector<Member<Element>> top_layer_elements_;
// The stack of currently-displayed popup elements. Elements in the stack
// go from earliest (bottom-most) to latest (top-most).
HeapVector<Member<HTMLPopupElement>> popup_element_stack_;
int load_event_delay_count_;
HeapTaskRunnerTimer<Document> load_event_delay_timer_;
HeapTaskRunnerTimer<Document> plugin_loading_timer_;
DocumentTiming document_timing_;
Member<MediaQueryMatcher> media_query_matcher_;
bool write_recursion_is_too_deep_;
unsigned write_recursion_depth_;
Member<ScriptedAnimationController> scripted_animation_controller_;
Member<ScriptedIdleTaskController> scripted_idle_task_controller_;
Member<TextAutosizer> text_autosizer_;
void ElementDataCacheClearTimerFired(TimerBase*);
HeapTaskRunnerTimer<Document> element_data_cache_clear_timer_;
Member<ElementDataCache> element_data_cache_;
using LocaleIdentifierToLocaleMap =
HashMap<AtomicString, std::unique_ptr<Locale>>;
LocaleIdentifierToLocaleMap locale_cache_;
Member<DocumentAnimations> document_animations_;
Member<DocumentTimeline> timeline_;
Member<PendingAnimations> pending_animations_;
Member<WorkletAnimationController> worklet_animation_controller_;
Member<Document> template_document_;
Member<Document> template_document_host_;
HeapTaskRunnerTimer<Document> did_associate_form_controls_timer_;
HeapHashSet<Member<SVGUseElement>> use_elements_needing_update_;
bool has_viewport_units_;
ParserSynchronizationPolicy parser_sync_policy_;
Member<CanvasFontCache> canvas_font_cache_;
Member<IntersectionObserverController> intersection_observer_controller_;
int node_count_;
Member<SnapCoordinator> snap_coordinator_;
Member<PropertyRegistry> property_registry_;
bool logged_field_edit_;
TaskHandle sensitive_input_edited_task_;
Member<NetworkStateObserver> network_state_observer_;
// |ukm_recorder_| and |source_id_| will allow objects that are part of
// the document to record UKM.
std::unique_ptr<ukm::UkmRecorder> ukm_recorder_;
const int64_t ukm_source_id_;
// Tracks and reports metrics of attempted font match attempts (both
// successful and not successful) by the page.
std::unique_ptr<FontMatchingMetrics> font_matching_metrics_;
#if DCHECK_IS_ON()
unsigned slot_assignment_recalc_forbidden_recursion_depth_ = 0;
#endif
unsigned slot_assignment_recalc_depth_ = 0;
unsigned flat_tree_traversal_forbidden_recursion_depth_ = 0;
Member<DOMFeaturePolicy> policy_;
Member<SlotAssignmentEngine> slot_assignment_engine_;
// TODO(tkent): Should it be moved to LocalFrame or LocalFrameView?
Member<ViewportData> viewport_data_;
// This is set through feature policy 'vertical-scroll'.
bool is_vertical_scroll_enforced_ = false;
// The number of canvas elements on the document
int num_canvases_ = 0;
// The number of LayoutObject::UpdateLayout() calls for both of the legacy
// layout and LayoutNG.
uint32_t layout_calls_counter_ = 0;
// The number of LayoutObject::UpdateLayout() calls for LayoutNG.
uint32_t layout_calls_counter_ng_ = 0;
// The number of LayoutBlock instances for both of the legacy layout
// and LayoutNG.
uint32_t layout_blocks_counter_ = 0;
// The number of LayoutNGMixin<LayoutBlock> instances
uint32_t layout_blocks_counter_ng_ = 0;
bool deferred_compositor_commit_is_allowed_ = false;
// True when the document was created (in DomImplementation) for specific MIME
// types that are handled externally. The document in this case is the
// counterpart to a PluginDocument except that it contains a FrameView as
// opposed to a PluginView.
bool is_for_external_handler_;
Member<LazyLoadImageObserver> lazy_load_image_observer_;
// Tracks which feature policies have already been parsed, so as not to count
// them multiple times.
// The size of this vector is 0 until FeaturePolicyFeatureObserved is called.
Vector<bool> parsed_feature_policies_;
Vector<bool> parsed_document_policies_;
AtomicString override_last_modified_;
// Used to keep track of which ComputedAccessibleNodes have already been
// instantiated in this document to avoid constructing duplicates.
HeapHashMap<AXID, Member<ComputedAccessibleNode>> computed_node_mapping_;
// When the document contains MimeHandlerView, this variable might hold a
// beforeunload handler. This will be set by the blink embedder when
// necessary.
Member<BeforeUnloadEventListener>
mime_handler_view_before_unload_event_listener_;
// Used to communicate state associated with resource management to the
// embedder.
std::unique_ptr<DocumentResourceCoordinator> resource_coordinator_;
// Used for document.cookie. May be null.
Member<CookieJar> cookie_jar_;
bool toggle_during_parsing_ = false;
bool is_for_markup_sanitization_ = false;
String fragment_directive_string_;
Member<FragmentDirective> fragment_directive_;
bool use_count_fragment_directive_ = false;
HeapHashMap<WeakMember<Element>, Member<ExplicitlySetAttrElementsMap>>
element_explicitly_set_attr_elements_map_;
HeapObserverSet<SynchronousMutationObserver>
synchronous_mutation_observer_set_;
Member<DisplayLockDocumentState> display_lock_document_state_;
bool in_forced_colors_mode_;
bool applying_scroll_restoration_logic_ = false;
// Records find-in-page metrics, which are sent to UKM on shutdown.
bool had_find_in_page_request_ = false;
bool had_find_in_page_render_subtree_active_match_ = false;
bool had_find_in_page_beforematch_expanded_hidden_matchable_ = false;
bool dir_attribute_dirty_ = false;
// To reduce the API noisiness an explicit deny decision will set a
// flag that auto rejects the promise without the need for an IPC
// call or potential user prompt.
bool expressly_denied_storage_access_ = false;
Member<FontPreloadManager> font_preload_manager_;
int async_script_count_ = 0;
bool first_paint_recorded_ = false;
DeclarativeShadowRootAllowState declarative_shadow_root_allow_state_ =
DeclarativeShadowRootAllowState::kNotSet;
WeakMember<Node> find_in_page_active_match_node_;
Member<DocumentData> data_;
// If you want to add new data members to blink::Document, please reconsider
// if the members really should be in blink::Document. document.h is a very
// popular header, and the size of document.h affects build time
// significantly.
//
// If a new data member doesn't make sense in inactive documents, such as
// documents created by DOMImplementation/DOMParser, the member should not be
// in blink::Document. It should be in a per-Frame class like
// blink::LocalDOMWindow and blink::LocalFrame.
//
// If you need to add new data members to blink::Document and it requires new
// #includes, add them to blink::DocumentData instead.
};
extern template class CORE_EXTERN_TEMPLATE_EXPORT Supplement<Document>;
inline void Document::ScheduleLayoutTreeUpdateIfNeeded() {
// Inline early out to avoid the function calls below.
if (HasPendingVisualUpdate())
return;
if (ShouldScheduleLayoutTreeUpdate() && NeedsLayoutTreeUpdate())
ScheduleLayoutTreeUpdate();
}
// This is needed to avoid ambiguous overloads with the Node and TreeScope
// versions.
DEFINE_COMPARISON_OPERATORS_WITH_REFERENCES(Document)
// Put these methods here, because they require the Document definition, but we
// really want to inline them.
inline bool Node::IsDocumentNode() const {
return this == GetDocument();
}
Node* EventTargetNodeForDocument(Document*);
template <>
struct DowncastTraits<Document> {
static bool AllowFrom(const Node& node) { return node.IsDocumentNode(); }
};
} // namespace blink
#ifndef NDEBUG
// Outside the blink namespace for ease of invocation from gdb.
CORE_EXPORT void showLiveDocumentInstances();
#endif
#endif // THIRD_PARTY_BLINK_RENDERER_CORE_DOM_DOCUMENT_H_
|