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
|
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
const lazy = {};
ChromeUtils.defineESModuleGetters(lazy, {
Color: "resource://gre/modules/Color.sys.mjs",
Rect: "resource://gre/modules/Geometry.sys.mjs",
});
ChromeUtils.defineLazyGetter(lazy, "kDebug", () => {
const kDebugPref = "findbar.modalHighlight.debug";
return (
Services.prefs.getPrefType(kDebugPref) &&
Services.prefs.getBoolPref(kDebugPref)
);
});
const kContentChangeThresholdPx = 5;
const kBrightTextSampleSize = 5;
// This limit is arbitrary and doesn't scale for low-powered machines or
// high-powered machines. Netbooks will probably need a much lower limit, for
// example. Though getting something out there is better than nothing.
const kPageIsTooBigPx = 500000;
const kModalHighlightRepaintLoFreqMs = 100;
const kModalHighlightRepaintHiFreqMs = 16;
const kHighlightAllPref = "findbar.highlightAll";
const kModalHighlightPref = "findbar.modalHighlight";
const kFontPropsCSS = [
"color",
"font-family",
"font-kerning",
"font-size",
"font-size-adjust",
"font-stretch",
"font-variant",
"font-weight",
"line-height",
"letter-spacing",
"text-emphasis",
"text-orientation",
"text-transform",
"word-spacing",
];
const kFontPropsCamelCase = kFontPropsCSS.map(prop => {
let parts = prop.split("-");
return (
parts.shift() +
parts.map(part => part.charAt(0).toUpperCase() + part.slice(1)).join("")
);
});
const kRGBRE = /^rgba?\s*\(\s*(\d+)\s*,\s*(\d+)\s*,\s*(\d+)\s*/i;
// This uuid is used to prefix HTML element IDs in order to make them unique and
// hard to clash with IDs content authors come up with.
const kModalIdPrefix = "cedee4d0-74c5-4f2d-ab43-4d37c0f9d463";
const kModalOutlineId = kModalIdPrefix + "-findbar-modalHighlight-outline";
const kOutlineBoxColor = "255,197,53";
const kOutlineBoxBorderSize = 1;
const kOutlineBoxBorderRadius = 2;
const kModalStyles = {
outlineNode: [
["background-color", `rgb(${kOutlineBoxColor})`],
["background-clip", "padding-box"],
["border", `${kOutlineBoxBorderSize}px solid rgba(${kOutlineBoxColor},.7)`],
["border-radius", `${kOutlineBoxBorderRadius}px`],
["box-shadow", `0 2px 0 0 rgba(0,0,0,.1)`],
["color", "#000"],
["display", "flex"],
[
"margin",
`-${kOutlineBoxBorderSize}px 0 0 -${kOutlineBoxBorderSize}px !important`,
],
["overflow", "hidden"],
["pointer-events", "none"],
["position", "absolute"],
["white-space", "nowrap"],
["will-change", "transform"],
["z-index", 2],
],
outlineNodeDebug: [["z-index", 2147483647]],
outlineText: [
["margin", "0 !important"],
["padding", "0 !important"],
["vertical-align", "top !important"],
],
maskNode: [
["background", "rgba(0,0,0,.25)"],
["pointer-events", "none"],
["position", "absolute"],
["z-index", 1],
],
maskNodeTransition: [["transition", "background .2s ease-in"]],
maskNodeDebug: [
["z-index", 2147483646],
["top", 0],
["left", 0],
],
maskNodeBrightText: [["background", "rgba(255,255,255,.25)"]],
};
const kModalOutlineAnim = {
keyframes: [
{ transform: "scaleX(1) scaleY(1)" },
{ transform: "scaleX(1.5) scaleY(1.5)", offset: 0.5, easing: "ease-in" },
{ transform: "scaleX(1) scaleY(1)" },
],
duration: 50,
};
const kNSHTML = "http://www.w3.org/1999/xhtml";
const kRepaintSchedulerStopped = 1;
const kRepaintSchedulerPaused = 2;
const kRepaintSchedulerRunning = 3;
function mockAnonymousContentNode(domNode) {
return {
setTextContentForElement(id, text) {
(domNode.querySelector("#" + id) || domNode).textContent = text;
},
getAttributeForElement(id, attrName) {
let node = domNode.querySelector("#" + id) || domNode;
if (!node.hasAttribute(attrName)) {
return undefined;
}
return node.getAttribute(attrName);
},
setAttributeForElement(id, attrName, attrValue) {
(domNode.querySelector("#" + id) || domNode).setAttribute(
attrName,
attrValue
);
},
removeAttributeForElement(id, attrName) {
let node = domNode.querySelector("#" + id) || domNode;
if (!node.hasAttribute(attrName)) {
return;
}
node.removeAttribute(attrName);
},
remove() {
try {
domNode.remove();
} catch (ex) {}
},
setAnimationForElement(id, keyframes, duration) {
return (domNode.querySelector("#" + id) || domNode).animate(
keyframes,
duration
);
},
setCutoutRectsForElement(id, rects) {
// no-op for now.
},
};
}
let gWindows = new WeakMap();
/**
* FinderHighlighter class that is used by Finder.sys.mjs to take care of the
* 'Highlight All' feature, which can highlight all find occurrences in a page.
*
* @param {Finder} finder Finder.sys.mjs instance
* @param {boolean} useTop check and use top-level windows for rectangle
* computation, if possible.
*/
export function FinderHighlighter(finder, useTop = false) {
this._highlightAll = Services.prefs.getBoolPref(kHighlightAllPref);
this._modal = Services.prefs.getBoolPref(kModalHighlightPref);
this._useSubFrames = false;
this._useTop = useTop;
this._marksListener = null;
this._testing = false;
this.finder = finder;
}
FinderHighlighter.prototype = {
get iterator() {
return this.finder.iterator;
},
enableTesting(enable) {
this._testing = enable;
},
// Get the top-most window when allowed. When out-of-process frames are used,
// this will usually be the same as the passed-in window. The checkUseTop
// argument can be used to instead check the _useTop flag which can be used
// to enable rectangle coordinate checks.
getTopWindow(window, checkUseTop) {
if (this._useSubFrames || (checkUseTop && this._useTop)) {
try {
return window.top;
} catch (ex) {}
}
return window;
},
useModal() {
// Modal highlighting is currently only enabled when there are no
// out-of-process subframes.
return this._modal && this._useSubFrames;
},
/**
* Each window is unique, globally, and the relation between an active
* highlighting session and a window is 1:1.
* For each window we track a number of properties which _at least_ consist of
* - {Boolean} detectedGeometryChange Whether the geometry of the found ranges'
* rectangles has changed substantially
* - {Set} dynamicRangesSet Set of ranges that may move around, depending
* on page layout changes and user input
* - {Map} frames Collection of frames that were encountered
* when inspecting the found ranges
* - {Map} modalHighlightRectsMap Collection of ranges and their corresponding
* Rects and texts
*
* @param {nsIDOMWindow} window
* @return {Object}
*/
getForWindow(window, propName = null) {
if (!gWindows.has(window)) {
gWindows.set(window, {
detectedGeometryChange: false,
dynamicRangesSet: new Set(),
frames: new Map(),
lastWindowDimensions: { width: 0, height: 0 },
modalHighlightRectsMap: new Map(),
previousRangeRectsAndTexts: { rectList: [], textList: [] },
repaintSchedulerState: kRepaintSchedulerStopped,
});
}
return gWindows.get(window);
},
/**
* Notify all registered listeners that the 'Highlight All' operation finished.
*
* @param {Boolean} highlight Whether highlighting was turned on
*/
notifyFinished(highlight) {
for (let l of this.finder._listeners) {
try {
l.onHighlightFinished(highlight);
} catch (ex) {}
}
},
/**
* Toggle highlighting all occurrences of a word in a page. This method will
* be called recursively for each (i)frame inside a page.
*
* @param {Booolean} highlight Whether highlighting should be turned on
* @param {String} word Needle to search for and highlight when found
* @param {Boolean} linksOnly Only consider nodes that are links for the search
* @param {Boolean} drawOutline Whether found links should be outlined.
* @param {Boolean} useSubFrames Whether to iterate over subframes.
* @yield {Promise} that resolves once the operation has finished
*/
async highlight(highlight, word, linksOnly, drawOutline, useSubFrames) {
let window = this.finder._getWindow();
let dict = this.getForWindow(window);
let controller = this.finder._getSelectionController(window);
let doc = window.document;
this._found = false;
this._useSubFrames = useSubFrames;
let result = { searchString: word, highlight, found: false };
if (!controller || !doc || !doc.documentElement) {
// Without the selection controller,
// we are unable to (un)highlight any matches
return result;
}
if (highlight) {
let params = {
allowDistance: 1,
caseSensitive: this.finder._fastFind.caseSensitive,
entireWord: this.finder._fastFind.entireWord,
linksOnly,
word,
finder: this.finder,
listener: this,
matchDiacritics: this.finder._fastFind.matchDiacritics,
useCache: true,
useSubFrames,
window,
};
if (
this.iterator.isAlreadyRunning(params) ||
(this.useModal() &&
this.iterator._areParamsEqual(params, dict.lastIteratorParams))
) {
return result;
}
if (!this.useModal()) {
dict.visible = true;
}
await this.iterator.start(params);
if (this._found) {
this.finder._outlineLink(drawOutline);
}
} else {
this.hide(window);
// Removing the highlighting always succeeds, so return true.
this._found = true;
}
result.found = this._found;
this.notifyFinished(result);
return result;
},
// FinderIterator listener implementation
onIteratorRangeFound(range) {
this.highlightRange(range);
this._found = true;
},
onIteratorReset() {},
onIteratorRestart() {
this.clear(this.finder._getWindow());
},
onIteratorStart(params) {
let window = this.finder._getWindow();
let dict = this.getForWindow(window);
// Save a clean params set for use later in the `update()` method.
dict.lastIteratorParams = params;
if (!this.useModal()) {
this.hide(window, this.finder._fastFind.getFoundRange());
}
this.clear(window);
},
/**
* Add a range to the find selection, i.e. highlight it, and if it's inside an
* editable node, track it.
*
* @param {Range} range Range object to be highlighted
*/
highlightRange(range) {
let node = range.startContainer;
let editableNode = this._getEditableNode(node);
let window = node.ownerGlobal;
let controller = this.finder._getSelectionController(window);
if (editableNode) {
controller = editableNode.editor.selectionController;
}
if (this.useModal()) {
this._modalHighlight(range, controller, window);
} else {
let findSelection = controller.getSelection(
Ci.nsISelectionController.SELECTION_FIND
);
findSelection.addRange(range);
// Check if the range is inside an (i)frame.
if (window != this.getTopWindow(window)) {
let dict = this.getForWindow(this.getTopWindow(window));
// Add this frame to the list, so that we'll be able to find it later
// when we need to clear its selection(s).
dict.frames.set(window, {});
}
}
if (editableNode) {
// Highlighting added, so cache this editor, and hook up listeners
// to ensure we deal properly with edits within the highlighting
this._addEditorListeners(editableNode.editor);
}
},
/**
* If modal highlighting is enabled, show the dimmed background that will overlay
* the page.
*
* @param {nsIDOMWindow} window The dimmed background will overlay this window.
* Optional, defaults to the finder window.
*/
show(window = null) {
window = this.getTopWindow(window || this.finder._getWindow());
let dict = this.getForWindow(window);
if (!this.useModal() || dict.visible) {
return;
}
dict.visible = true;
this._maybeCreateModalHighlightNodes(window);
this._addModalHighlightListeners(window);
},
/**
* Clear all highlighted matches. If modal highlighting is enabled and
* the outline + dimmed background is currently visible, both will be hidden.
*
* @param {nsIDOMWindow} window The dimmed background will overlay this window.
* Optional, defaults to the finder window.
* @param {Range} skipRange A range that should not be removed from the
* find selection.
* @param {Event} event When called from an event handler, this will
* be the triggering event.
*/
hide(window, skipRange = null, event = null) {
try {
window = this.getTopWindow(window);
} catch (ex) {
console.error(ex);
return;
}
let dict = this.getForWindow(window);
let isBusySelecting = dict.busySelecting;
dict.busySelecting = false;
// Do not hide on anything but a left-click.
if (
event &&
event.type == "click" &&
(event.button !== 0 ||
event.altKey ||
event.ctrlKey ||
event.metaKey ||
event.shiftKey ||
event.relatedTarget ||
isBusySelecting ||
(event.target.localName == "a" && event.target.href))
) {
return;
}
this._clearSelection(
this.finder._getSelectionController(window),
skipRange
);
for (let frame of dict.frames.keys()) {
this._clearSelection(
this.finder._getSelectionController(frame),
skipRange
);
}
// Next, check our editor cache, for editors belonging to this
// document
if (this._editors) {
let doc = window.document;
for (let x = this._editors.length - 1; x >= 0; --x) {
if (this._editors[x].document == doc) {
this._clearSelection(this._editors[x].selectionController, skipRange);
// We don't need to listen to this editor any more
this._unhookListenersAtIndex(x);
}
}
}
if (dict.modalRepaintScheduler) {
window.clearTimeout(dict.modalRepaintScheduler);
dict.modalRepaintScheduler = null;
dict.repaintSchedulerState = kRepaintSchedulerStopped;
}
dict.lastWindowDimensions = { width: 0, height: 0 };
this._removeRangeOutline(window);
this._removeHighlightAllMask(window);
this._removeModalHighlightListeners(window);
dict.visible = false;
},
/**
* Called by the Finder after a find result comes in; update the position and
* content of the outline to the newly found occurrence.
* To make sure that the outline covers the found range completely, all the
* CSS styles that influence the text are copied and applied to the outline.
*
* @param {Object} data Dictionary coming from Finder that contains the
* following properties:
* {Number} result One of the nsITypeAheadFind.FIND_* constants
* indicating the result of a search operation.
* {Boolean} findBackwards If TRUE, the search was performed backwards,
* FALSE if forwards.
* {Boolean} findAgain If TRUE, the search was performed using the same
* search string as before.
* {String} linkURL If a link was hit, this will contain a URL string.
* {Rect} rect An object with top, left, width and height
* coordinates of the current selection.
* {String} searchString The string the search was performed with.
* {Boolean} storeResult Indicator if the search string should be stored
* by the consumer of the Finder.
*/
async update(data, foundInThisFrame) {
let window = this.finder._getWindow();
let dict = this.getForWindow(window);
let foundRange = this.finder._fastFind.getFoundRange();
if (
data.result == Ci.nsITypeAheadFind.FIND_NOTFOUND ||
!data.searchString ||
(foundInThisFrame && !foundRange)
) {
this.hide(window);
return;
}
this._useSubFrames = data.useSubFrames;
if (!this.useModal()) {
if (this._highlightAll) {
dict.previousFoundRange = dict.currentFoundRange;
dict.currentFoundRange = foundRange;
let params = this.iterator.params;
if (
dict.visible &&
this.iterator._areParamsEqual(params, dict.lastIteratorParams)
) {
return;
}
if (!dict.visible && !params) {
params = { word: data.searchString, linksOnly: data.linksOnly };
}
if (params) {
await this.highlight(
true,
params.word,
params.linksOnly,
params.drawOutline,
data.useSubFrames
);
}
}
return;
}
dict.animateOutline = true;
// Immediately finish running animations, if any.
this._finishOutlineAnimations(dict);
if (foundRange !== dict.currentFoundRange || data.findAgain) {
dict.previousFoundRange = dict.currentFoundRange;
dict.currentFoundRange = foundRange;
if (!dict.visible) {
this.show(window);
} else {
this._maybeCreateModalHighlightNodes(window);
}
}
if (this._highlightAll) {
await this.highlight(
true,
data.searchString,
data.linksOnly,
data.drawOutline,
data.useSubFrames
);
}
},
/**
* Invalidates the list by clearing the map of highlighted ranges that we
* keep to build the mask for.
*/
clear(window = null) {
if (!window || !this.getTopWindow(window)) {
return;
}
let dict = this.getForWindow(this.getTopWindow(window));
this._finishOutlineAnimations(dict);
dict.dynamicRangesSet.clear();
dict.frames.clear();
dict.modalHighlightRectsMap.clear();
dict.brightText = null;
},
/**
* Removes the outline from a single window. This is done when
* switching the current search to a new frame.
*/
clearCurrentOutline(window = null) {
let dict = this.getForWindow(this.getTopWindow(window));
this._finishOutlineAnimations(dict);
this._removeRangeOutline(window);
},
// Update the tick marks that should appear on the page's scrollbar(s).
updateScrollMarks() {
// Only show scrollbar marks when normal highlighting is enabled.
if (this.useModal() || !this._highlightAll) {
this.removeScrollMarks();
return;
}
let marks = new Set(); // Use a set so duplicate values are removed.
let window = this.finder._getWindow();
// Show the marks on the horizontal scrollbar for vertical writing modes.
let onHorizontalScrollbar = !window
.getComputedStyle(window.document.body || window.document.documentElement)
.writingMode.startsWith("horizontal");
let yStart = window.scrollY - window.scrollMinY;
let xStart = window.scrollX - window.scrollMinX;
let hasRanges = false;
if (window) {
let controllers = [this.finder._getSelectionController(window)];
let editors = this.editors;
if (editors) {
// Add the selection controllers from any input fields.
controllers.push(...editors.map(editor => editor.selectionController));
}
for (let controller of controllers) {
let findSelection = controller.getSelection(
Ci.nsISelectionController.SELECTION_FIND
);
let rangeCount = findSelection.rangeCount;
if (rangeCount > 0) {
hasRanges = true;
}
// No need to calculate the mark positions if there is no visible scrollbar.
if (window.scrollMaxY > window.scrollMinY && !onHorizontalScrollbar) {
// Use the body's scrollHeight if available.
let scrollHeight =
window.document.body?.scrollHeight ||
window.document.documentElement.scrollHeight;
let yAdj = (window.scrollMaxY - window.scrollMinY) / scrollHeight;
for (let r = 0; r < rangeCount; r++) {
let rect = findSelection.getRangeAt(r).getBoundingClientRect();
let yPos = Math.round((yStart + rect.y + rect.height / 2) * yAdj); // use the midpoint
marks.add(yPos);
}
} else if (
window.scrollMaxX > window.scrollMinX &&
onHorizontalScrollbar
) {
// Use the body's scrollWidth if available.
let scrollWidth =
window.document.body?.scrollWidth ||
window.document.documentElement.scrollWidth;
let xAdj = (window.scrollMaxX - window.scrollMinX) / scrollWidth;
for (let r = 0; r < rangeCount; r++) {
let rect = findSelection.getRangeAt(r).getBoundingClientRect();
let xPos = Math.round((xStart + rect.x + rect.width / 2) * xAdj);
marks.add(xPos);
}
}
}
}
if (hasRanges) {
// Assign the marks to the window and add a listener for the MozScrolledAreaChanged
// event which fires whenever the scrollable area's size is updated.
this.setScrollMarks(window, Array.from(marks), onHorizontalScrollbar);
if (!this._marksListener) {
this._marksListener = event => {
this.updateScrollMarks();
};
window.addEventListener(
"MozScrolledAreaChanged",
this._marksListener,
true
);
window.addEventListener("resize", this._marksListener);
}
} else if (this._marksListener) {
// No results were found so remove any existing ones and the MozScrolledAreaChanged listener.
this.removeScrollMarks();
}
},
removeScrollMarks() {
let window;
try {
window = this.finder._getWindow();
} catch (ex) {
// An exception can happen after changing remoteness but this
// would have deleted the marks anyway.
return;
}
if (this._marksListener) {
window.removeEventListener(
"MozScrolledAreaChanged",
this._marksListener,
true
);
window.removeEventListener("resize", this._marksListener);
this._marksListener = null;
}
this.setScrollMarks(window, []);
},
/**
* Set the scrollbar marks for a current search. If testing mode is enabled, fire a
* find-scrollmarks-changed event at the window.
*
* @param window window to set the scrollbar marks on
* @param marks array of integer scrollbar mark positions
* @param onHorizontalScrollbar whether to display the marks on the horizontal scrollbar
*/
setScrollMarks(window, marks, onHorizontalScrollbar = false) {
window.setScrollMarks(marks, onHorizontalScrollbar);
// Fire an event containing the found mark values if testing mode is enabled.
if (this._testing) {
window.dispatchEvent(
new CustomEvent("find-scrollmarks-changed", {
detail: {
marks: Array.from(marks),
onHorizontalScrollbar,
},
})
);
}
},
/**
* When the current page is refreshed or navigated away from, the CanvasFrame
* contents is not valid anymore, i.e. all anonymous content is destroyed.
* We need to clear the references we keep, which'll make sure we redraw
* everything when the user starts to find in page again.
*/
onLocationChange() {
let window = this.finder._getWindow();
if (!window || !this.getTopWindow(window)) {
return;
}
this.hide(window);
this.clear(window);
this._removeRangeOutline(window);
gWindows.delete(this.getTopWindow(window));
},
/**
* When `kModalHighlightPref` pref changed during a session, this callback is
* invoked. When modal highlighting is turned off, we hide the CanvasFrame
* contents.
*
* @param {Boolean} useModalHighlight
*/
onModalHighlightChange(useModalHighlight) {
let window = this.finder._getWindow();
if (window && this.useModal() && !useModalHighlight) {
this.hide(window);
this.clear(window);
}
this._modal = useModalHighlight;
this.updateScrollMarks();
},
/**
* When 'Highlight All' is toggled during a session, this callback is invoked
* and when it's turned off, the found occurrences will be removed from the mask.
*
* @param {Boolean} highlightAll
*/
onHighlightAllChange(highlightAll) {
this._highlightAll = highlightAll;
if (!highlightAll) {
let window = this.finder._getWindow();
if (!this.useModal()) {
this.hide(window);
}
this.clear(window);
this._scheduleRepaintOfMask(window);
}
this.updateScrollMarks();
},
/**
* Utility; removes all ranges from the find selection that belongs to a
* controller. Optionally skips a specific range.
*
* @param {nsISelectionController} controller
* @param {Range} restoreRange
*/
_clearSelection(controller, restoreRange = null) {
if (!controller) {
return;
}
let sel = controller.getSelection(Ci.nsISelectionController.SELECTION_FIND);
sel.removeAllRanges();
if (restoreRange) {
sel = controller.getSelection(Ci.nsISelectionController.SELECTION_NORMAL);
sel.addRange(restoreRange);
controller.setDisplaySelection(
Ci.nsISelectionController.SELECTION_ATTENTION
);
controller.repaintSelection(Ci.nsISelectionController.SELECTION_NORMAL);
}
},
/**
* Utility; get the nsIDOMWindowUtils for a window.
*
* @param {nsIDOMWindow} window Optional, defaults to the finder window.
* @return {nsIDOMWindowUtils}
*/
_getDWU(window = null) {
return (window || this.finder._getWindow()).windowUtils;
},
/**
* Utility; returns the bounds of the page relative to the viewport.
* If the pages is part of a frameset or inside an iframe of any kind, its
* offset is accounted for.
* Geometry.sys.mjs takes care of the DOMRect calculations.
*
* @param {nsIDOMWindow} window Window to read the boundary rect from
* @param {Boolean} [includeScroll] Whether to ignore the scroll offset,
* which is useful for comparing DOMRects.
* Optional, defaults to `true`
* @return {Rect}
*/
_getRootBounds(window, includeScroll = true) {
let dwu = this._getDWU(this.getTopWindow(window, true));
let cssPageRect = lazy.Rect.fromRect(dwu.getRootBounds());
let scrollX = {};
let scrollY = {};
if (includeScroll && window == this.getTopWindow(window, true)) {
dwu.getScrollXY(false, scrollX, scrollY);
cssPageRect.translate(scrollX.value, scrollY.value);
}
// If we're in a frame, update the position of the rect (top/ left).
let currWin = window;
while (currWin != this.getTopWindow(window, true)) {
let frameOffsets = this._getFrameElementOffsets(currWin);
cssPageRect.translate(frameOffsets.x, frameOffsets.y);
// Since the frame is an element inside a parent window, we'd like to
// learn its position relative to it.
let el = currWin.browsingContext.embedderElement;
currWin = currWin.parent;
dwu = this._getDWU(currWin);
let parentRect = lazy.Rect.fromRect(dwu.getBoundsWithoutFlushing(el));
if (includeScroll) {
dwu.getScrollXY(false, scrollX, scrollY);
parentRect.translate(scrollX.value, scrollY.value);
// If the current window is an iframe with scrolling="no" and its parent
// is also an iframe the scroll offsets from the parents' documentElement
// (inverse scroll position) needs to be subtracted from the parent
// window rect.
if (
el.getAttribute("scrolling") == "no" &&
currWin != this.getTopWindow(window, true)
) {
let docEl = currWin.document.documentElement;
parentRect.translate(-docEl.scrollLeft, -docEl.scrollTop);
}
}
cssPageRect.translate(parentRect.left, parentRect.top);
}
let frameOffsets = this._getFrameElementOffsets(currWin);
cssPageRect.translate(frameOffsets.x, frameOffsets.y);
return cssPageRect;
},
/**
* (I)Frame elements may have a border and/ or padding set, which is not
* included in the bounds returned by nsDOMWindowUtils#getRootBounds() for the
* window it hosts.
* This method fetches this offset of the frame element to the respective window.
*
* @param {nsIDOMWindow} window Window to read the boundary rect from
* @return {Object} Simple object that contains the following two properties:
* - {Number} x Offset along the horizontal axis.
* - {Number} y Offset along the vertical axis.
*/
_getFrameElementOffsets(window) {
let frame = window.frameElement;
if (!frame) {
return { x: 0, y: 0 };
}
// Getting style info is super expensive, causing reflows, so let's cache
// frame border widths and padding values aggressively.
let dict = this.getForWindow(this.getTopWindow(window, true));
let frameData = dict.frames.get(window);
if (!frameData) {
dict.frames.set(window, (frameData = {}));
}
if (frameData.offset) {
return frameData.offset;
}
let style = frame.ownerGlobal.getComputedStyle(frame);
// We only need to left sides, because ranges are offset from point 0,0 in
// the top-left corner.
let borderOffset = [
parseInt(style.borderLeftWidth, 10) || 0,
parseInt(style.borderTopWidth, 10) || 0,
];
let paddingOffset = [
parseInt(style.paddingLeft, 10) || 0,
parseInt(style.paddingTop, 10) || 0,
];
return (frameData.offset = {
x: borderOffset[0] + paddingOffset[0],
y: borderOffset[1] + paddingOffset[1],
});
},
/**
* Utility; fetch the full width and height of the current window, excluding
* scrollbars.
*
* @param {nsiDOMWindow} window The current finder window.
* @return {Object} The current full page dimensions with `width` and `height`
* properties
*/
_getWindowDimensions(window) {
// First we'll try without flushing layout, because it's way faster.
let dwu = this._getDWU(window);
let { width, height } = dwu.getRootBounds();
if (!width || !height) {
// We need a flush after all :'(
width = window.innerWidth + window.scrollMaxX - window.scrollMinX;
height = window.innerHeight + window.scrollMaxY - window.scrollMinY;
let scrollbarHeight = {};
let scrollbarWidth = {};
dwu.getScrollbarSize(false, scrollbarWidth, scrollbarHeight);
width -= scrollbarWidth.value;
height -= scrollbarHeight.value;
}
return { width, height };
},
/**
* Utility; get all available font styles as applied to the content of a given
* range. The CSS properties we look for can be found in `kFontPropsCSS`.
*
* @param {Range} range Range to fetch style info from.
* @return {Object} Dictionary consisting of the styles that were found.
*/
_getRangeFontStyle(range) {
let node = range.startContainer;
while (node.nodeType != 1) {
node = node.parentNode;
}
let style = node.ownerGlobal.getComputedStyle(node);
let props = {};
for (let prop of kFontPropsCamelCase) {
if (prop in style && style[prop]) {
props[prop] = style[prop];
}
}
return props;
},
/**
* Utility; transform a dictionary object as returned by `_getRangeFontStyle`
* above into a HTML style attribute value.
*
* @param {Object} fontStyle
* @return {String}
*/
_getHTMLFontStyle(fontStyle) {
let style = [];
for (let prop of Object.getOwnPropertyNames(fontStyle)) {
let idx = kFontPropsCamelCase.indexOf(prop);
if (idx == -1) {
continue;
}
style.push(`${kFontPropsCSS[idx]}: ${fontStyle[prop]}`);
}
return style.join("; ");
},
/**
* Transform a style definition array as defined in `kModalStyles` into a CSS
* string that can be used to set the 'style' property of a DOM node.
*
* @param {Array} stylePairs Two-dimensional array of style pairs
* @param {...Array} [additionalStyles] Optional set of style pairs that will
* augment or override the styles defined
* by `stylePairs`
* @return {String}
*/
_getStyleString(stylePairs, ...additionalStyles) {
let baseStyle = new Map(stylePairs);
for (let additionalStyle of additionalStyles) {
for (let [prop, value] of additionalStyle) {
baseStyle.set(prop, value);
}
}
return [...baseStyle]
.map(([cssProp, cssVal]) => `${cssProp}: ${cssVal}`)
.join("; ");
},
/**
* Checks whether a CSS RGB color value can be classified as being 'bright'.
*
* @param {String} cssColor RGB color value in the default format rgb[a](r,g,b)
* @return {Boolean}
*/
_isColorBright(cssColor) {
cssColor = cssColor.match(kRGBRE);
if (!cssColor || !cssColor.length) {
return false;
}
cssColor.shift();
return !new lazy.Color(...cssColor).useBrightText;
},
/**
* Detects if the overall text color in the page can be described as bright.
* This is done according to the following algorithm:
* 1. With the entire set of ranges that we have found thusfar;
* 2. Get an odd-numbered `sampleSize`, with a maximum of `kBrightTextSampleSize`
* ranges,
* 3. Slice the set of ranges into `sampleSize` number of equal parts,
* 4. Grab the first range for each slice and inspect the brightness of the
* color of its text content.
* 5. When the majority of ranges are counted as contain bright colored text,
* the page is considered to contain bright text overall.
*
* @param {Object} dict Dictionary of properties belonging to the
* currently active window. The page text color property
* will be recorded in `dict.brightText` as `true` or `false`.
*/
_detectBrightText(dict) {
let sampleSize = Math.min(
dict.modalHighlightRectsMap.size,
kBrightTextSampleSize
);
let ranges = [...dict.modalHighlightRectsMap.keys()];
let rangesCount = ranges.length;
// Make sure the sample size is an odd number.
if (sampleSize % 2 == 0) {
// Make the previously or currently found range weigh heavier.
if (dict.previousFoundRange || dict.currentFoundRange) {
ranges.push(dict.previousFoundRange || dict.currentFoundRange);
++sampleSize;
++rangesCount;
} else {
--sampleSize;
}
}
let brightCount = 0;
for (let i = 0; i < sampleSize; ++i) {
let range = ranges[Math.floor((rangesCount / sampleSize) * i)];
let fontStyle = this._getRangeFontStyle(range);
if (this._isColorBright(fontStyle.color)) {
++brightCount;
}
}
dict.brightText = brightCount >= Math.ceil(sampleSize / 2);
},
/**
* Checks if a range is inside a DOM node that's positioned in a way that it
* doesn't scroll along when the document is scrolled and/ or zoomed. This
* is the case for 'fixed' and 'sticky' positioned elements, elements inside
* (i)frames and elements that have their overflow styles set to 'auto' or
* 'scroll'.
*
* @param {Range} range Range that be enclosed in a dynamic container
* @return {Boolean}
*/
_isInDynamicContainer(range) {
const kFixed = new Set(["fixed", "sticky", "scroll", "auto"]);
let node = range.startContainer;
while (node.nodeType != 1) {
node = node.parentNode;
}
let document = node.ownerDocument;
let window = document.defaultView;
let dict = this.getForWindow(this.getTopWindow(window));
// Check if we're in a frameset (including iframes).
if (window != this.getTopWindow(window)) {
if (!dict.frames.has(window)) {
dict.frames.set(window, {});
}
return true;
}
do {
let style = window.getComputedStyle(node);
if (
kFixed.has(style.position) ||
kFixed.has(style.overflow) ||
kFixed.has(style.overflowX) ||
kFixed.has(style.overflowY)
) {
return true;
}
node = node.parentNode;
} while (node && node != document.documentElement);
return false;
},
/**
* Read and store the rectangles that encompass the entire region of a range
* for use by the drawing function of the highlighter.
*
* @param {Range} range Range to fetch the rectangles from
* @param {Object} [dict] Dictionary of properties belonging to
* the currently active window
* @return {Set} Set of rects that were found for the range
*/
_getRangeRectsAndTexts(range, dict = null) {
let window = range.startContainer.ownerGlobal;
let bounds;
// If the window is part of a frameset, try to cache the bounds query.
if (dict && dict.frames.has(window)) {
let frameData = dict.frames.get(window);
bounds = frameData.bounds;
if (!bounds) {
bounds = frameData.bounds = this._getRootBounds(window);
}
} else {
bounds = this._getRootBounds(window);
}
let topBounds = this._getRootBounds(this.getTopWindow(window, true), false);
let rects = [];
// A range may consist of multiple rectangles, we can also do these kind of
// precise cut-outs. range.getBoundingClientRect() returns the fully
// encompassing rectangle, which is too much for our purpose here.
let { rectList, textList } = range.getClientRectsAndTexts();
for (let rect of rectList) {
rect = lazy.Rect.fromRect(rect);
rect.x += bounds.x;
rect.y += bounds.y;
// If the rect is not even visible from the top document, we can ignore it.
if (rect.intersects(topBounds)) {
rects.push(rect);
}
}
return { rectList: rects, textList };
},
/**
* Read and store the rectangles that encompass the entire region of a range
* for use by the drawing function of the highlighter and store them in the
* cache.
*
* @param {Range} range Range to fetch the rectangles from
* @param {Boolean} [checkIfDynamic] Whether we should check if the range
* is dynamic as per the rules in
* `_isInDynamicContainer()`. Optional,
* defaults to `true`
* @param {Object} [dict] Dictionary of properties belonging to
* the currently active window
* @return {Set} Set of rects that were found for the range
*/
_updateRangeRects(range, checkIfDynamic = true, dict = null) {
let window = range.startContainer.ownerGlobal;
let rectsAndTexts = this._getRangeRectsAndTexts(range, dict);
// Only fetch the rect at this point, if not passed in as argument.
dict = dict || this.getForWindow(this.getTopWindow(window));
let oldRectsAndTexts = dict.modalHighlightRectsMap.get(range);
dict.modalHighlightRectsMap.set(range, rectsAndTexts);
// Check here if we suddenly went down to zero rects from more than zero before,
// which indicates that we should re-iterate the document.
if (
oldRectsAndTexts &&
oldRectsAndTexts.rectList.length &&
!rectsAndTexts.rectList.length
) {
dict.detectedGeometryChange = true;
}
if (checkIfDynamic && this._isInDynamicContainer(range)) {
dict.dynamicRangesSet.add(range);
}
return rectsAndTexts;
},
/**
* Re-read the rectangles of the ranges that we keep track of separately,
* because they're enclosed by a position: fixed container DOM node or (i)frame.
*
* @param {Object} dict Dictionary of properties belonging to the currently
* active window
*/
_updateDynamicRangesRects(dict) {
// Reset the frame bounds cache.
for (let frameData of dict.frames.values()) {
frameData.bounds = null;
}
for (let range of dict.dynamicRangesSet) {
this._updateRangeRects(range, false, dict);
}
},
/**
* Update the content, position and style of the yellow current found range
* outline that floats atop the mask with the dimmed background.
* Rebuild it, if necessary, This will deactivate the animation between
* occurrences.
*
* @param {Object} dict Dictionary of properties belonging to the currently
* active window
*/
_updateRangeOutline(dict) {
let range = dict.currentFoundRange;
if (!range) {
return;
}
let fontStyle = this._getRangeFontStyle(range);
// Text color in the outline is determined by kModalStyles.
delete fontStyle.color;
let rectsAndTexts = this._updateRangeRects(range, true, dict);
let outlineAnonNode = dict.modalHighlightOutline;
let rectCount = rectsAndTexts.rectList.length;
let previousRectCount = dict.previousRangeRectsAndTexts.rectList.length;
// (re-)Building the outline is conditional and happens when one of the
// following conditions is met:
// 1. No outline nodes were built before, or
// 2. When the amount of rectangles to draw is different from before, or
// 3. When there's more than one rectangle to draw, because it's impossible
// to animate that consistently with AnonymousContent nodes.
let rebuildOutline =
!outlineAnonNode || rectCount !== previousRectCount || rectCount != 1;
dict.previousRangeRectsAndTexts = rectsAndTexts;
let window = this.getTopWindow(range.startContainer.ownerGlobal);
let document = window.document;
// First see if we need to and can remove the previous outline nodes.
if (rebuildOutline) {
this._removeRangeOutline(window);
}
// Abort when there's no text to highlight OR when it's the exact same range
// as the previous call and isn't inside a dynamic container.
if (
!rectsAndTexts.textList.length ||
(!rebuildOutline &&
dict.previousUpdatedRange == range &&
!dict.dynamicRangesSet.has(range))
) {
return;
}
let outlineBox;
if (rebuildOutline) {
// Create the main (yellow) highlight outline box.
outlineBox = document.createElementNS(kNSHTML, "div");
outlineBox.setAttribute("id", kModalOutlineId);
}
const kModalOutlineTextId = kModalOutlineId + "-text";
let i = 0;
for (let rect of rectsAndTexts.rectList) {
let text = rectsAndTexts.textList[i];
// Next up is to check of the outline box' borders will not overlap with
// rects that we drew before or will draw after this one.
// We're taking the width of the border into account, which is
// `kOutlineBoxBorderSize` pixels.
// When left and/ or right sides will overlap with the current, previous
// or next rect, make sure to make the necessary adjustments to the style.
// These adjustments will override the styles as defined in `kModalStyles.outlineNode`.
let intersectingSides = new Set();
let previous = rectsAndTexts.rectList[i - 1];
if (previous && rect.left - previous.right <= 2 * kOutlineBoxBorderSize) {
intersectingSides.add("left");
}
let next = rectsAndTexts.rectList[i + 1];
if (next && next.left - rect.right <= 2 * kOutlineBoxBorderSize) {
intersectingSides.add("right");
}
let borderStyles = [...intersectingSides].map(side => [
"border-" + side,
0,
]);
if (intersectingSides.size) {
borderStyles.push([
"margin",
`-${kOutlineBoxBorderSize}px 0 0 ${
intersectingSides.has("left") ? 0 : -kOutlineBoxBorderSize
}px !important`,
]);
borderStyles.push([
"border-radius",
(intersectingSides.has("left") ? 0 : kOutlineBoxBorderRadius) +
"px " +
(intersectingSides.has("right") ? 0 : kOutlineBoxBorderRadius) +
"px " +
(intersectingSides.has("right") ? 0 : kOutlineBoxBorderRadius) +
"px " +
(intersectingSides.has("left") ? 0 : kOutlineBoxBorderRadius) +
"px",
]);
}
let outlineStyle = this._getStyleString(
kModalStyles.outlineNode,
[
["top", rect.top + "px"],
["left", rect.left + "px"],
["height", rect.height + "px"],
["width", rect.width + "px"],
],
borderStyles,
lazy.kDebug ? kModalStyles.outlineNodeDebug : []
);
fontStyle.lineHeight = rect.height + "px";
let textStyle =
this._getStyleString(kModalStyles.outlineText) +
"; " +
this._getHTMLFontStyle(fontStyle);
if (rebuildOutline) {
let textBoxParent = outlineBox.appendChild(
document.createElementNS(kNSHTML, "div")
);
textBoxParent.setAttribute("id", kModalOutlineId + i);
textBoxParent.setAttribute("style", outlineStyle);
let textBox = document.createElementNS(kNSHTML, "span");
textBox.setAttribute("id", kModalOutlineTextId + i);
textBox.setAttribute("style", textStyle);
textBox.textContent = text;
textBoxParent.appendChild(textBox);
} else {
// Set the appropriate properties on the existing nodes, which will also
// activate the transitions.
outlineAnonNode.setAttributeForElement(
kModalOutlineId + i,
"style",
outlineStyle
);
outlineAnonNode.setAttributeForElement(
kModalOutlineTextId + i,
"style",
textStyle
);
outlineAnonNode.setTextContentForElement(kModalOutlineTextId + i, text);
}
++i;
}
if (rebuildOutline) {
dict.modalHighlightOutline = lazy.kDebug
? mockAnonymousContentNode(
(document.body || document.documentElement).appendChild(outlineBox)
)
: document.insertAnonymousContent(outlineBox);
}
if (dict.animateOutline && !this._isPageTooBig(dict)) {
let animation;
dict.animations = new Set();
for (let i = rectsAndTexts.rectList.length - 1; i >= 0; --i) {
animation = dict.modalHighlightOutline.setAnimationForElement(
kModalOutlineId + i,
Cu.cloneInto(kModalOutlineAnim.keyframes, window),
kModalOutlineAnim.duration
);
animation.onfinish = function () {
dict.animations.delete(this);
};
dict.animations.add(animation);
}
}
dict.animateOutline = false;
dict.ignoreNextContentChange = true;
dict.previousUpdatedRange = range;
},
/**
* Finish any currently playing animations on the found range outline node.
*
* @param {Object} dict Dictionary of properties belonging to the currently
* active window
*/
_finishOutlineAnimations(dict) {
if (!dict.animations) {
return;
}
for (let animation of dict.animations) {
animation.finish();
}
},
/**
* Safely remove the outline AnoymousContent node from the CanvasFrame.
*
* @param {nsIDOMWindow} window
*/
_removeRangeOutline(window) {
let dict = this.getForWindow(window);
if (!dict.modalHighlightOutline) {
return;
}
if (lazy.kDebug) {
dict.modalHighlightOutline.remove();
} else {
try {
window.document.removeAnonymousContent(dict.modalHighlightOutline);
} catch (ex) {}
}
dict.modalHighlightOutline = null;
},
/**
* Add a range to the list of ranges to highlight on, or cut out of, the dimmed
* background.
*
* @param {Range} range Range object that should be inspected
* @param {nsIDOMWindow} window Window object, whose DOM tree is being traversed
*/
_modalHighlight(range, controller, window) {
this._updateRangeRects(range);
this.show(window);
// We don't repaint the mask right away, but pass it off to a render loop of
// sorts.
this._scheduleRepaintOfMask(window);
},
/**
* Lazily insert the nodes we need as anonymous content into the CanvasFrame
* of a window.
*
* @param {nsIDOMWindow} window Window to draw in.
*/
_maybeCreateModalHighlightNodes(window) {
window = this.getTopWindow(window);
let dict = this.getForWindow(window);
if (dict.modalHighlightOutline) {
if (!dict.modalHighlightAllMask) {
// Make sure to at least show the dimmed background.
this._repaintHighlightAllMask(window, false);
this._scheduleRepaintOfMask(window);
} else {
this._scheduleRepaintOfMask(window, { contentChanged: true });
}
return;
}
let document = window.document;
// A hidden document doesn't accept insertAnonymousContent calls yet.
if (document.hidden) {
let onVisibilityChange = () => {
document.removeEventListener("visibilitychange", onVisibilityChange);
this._maybeCreateModalHighlightNodes(window);
};
document.addEventListener("visibilitychange", onVisibilityChange);
return;
}
// Make sure to at least show the dimmed background.
this._repaintHighlightAllMask(window, false);
},
/**
* Build and draw the mask that takes care of the dimmed background that
* overlays the current page and the mask that cuts out all the rectangles of
* the ranges that were found.
*
* @param {nsIDOMWindow} window Window to draw in.
* @param {Boolean} [paintContent]
*/
_repaintHighlightAllMask(window, paintContent = true) {
window = this.getTopWindow(window);
let dict = this.getForWindow(window);
const kMaskId = kModalIdPrefix + "-findbar-modalHighlight-outlineMask";
if (!dict.modalHighlightAllMask) {
let document = window.document;
let maskNode = document.createElementNS(kNSHTML, "div");
maskNode.setAttribute("id", kMaskId);
dict.modalHighlightAllMask = lazy.kDebug
? mockAnonymousContentNode(
(document.body || document.documentElement).appendChild(maskNode)
)
: document.insertAnonymousContent(maskNode);
}
// Make sure the dimmed mask node takes the full width and height that's available.
let { width, height } = (dict.lastWindowDimensions =
this._getWindowDimensions(window));
if (typeof dict.brightText != "boolean" || dict.updateAllRanges) {
this._detectBrightText(dict);
}
let maskStyle = this._getStyleString(
kModalStyles.maskNode,
[
["width", width + "px"],
["height", height + "px"],
],
dict.brightText ? kModalStyles.maskNodeBrightText : [],
paintContent ? kModalStyles.maskNodeTransition : [],
lazy.kDebug ? kModalStyles.maskNodeDebug : []
);
dict.modalHighlightAllMask.setAttributeForElement(
kMaskId,
"style",
maskStyle
);
this._updateRangeOutline(dict);
let allRects = [];
// When the user's busy scrolling the document, don't bother cutting out rectangles,
// because they're not going to keep up with scrolling speed anyway.
if (!dict.busyScrolling && (paintContent || dict.modalHighlightAllMask)) {
// No need to update dynamic ranges separately when we already about to
// update all of them anyway.
if (!dict.updateAllRanges) {
this._updateDynamicRangesRects(dict);
}
let DOMRect = window.DOMRect;
for (let [range, rectsAndTexts] of dict.modalHighlightRectsMap) {
if (!this.finder._fastFind.isRangeVisible(range, false)) {
continue;
}
if (dict.updateAllRanges) {
rectsAndTexts = this._updateRangeRects(range);
}
// If a geometry change was detected, we bail out right away here, because
// the current set of ranges has been invalidated.
if (dict.detectedGeometryChange) {
return;
}
for (let rect of rectsAndTexts.rectList) {
allRects.push(new DOMRect(rect.x, rect.y, rect.width, rect.height));
}
}
dict.updateAllRanges = false;
}
// We may also want to cut out zero rects, which effectively clears out the mask.
dict.modalHighlightAllMask.setCutoutRectsForElement(kMaskId, allRects);
// The reflow observer may ignore the reflow we cause ourselves here.
dict.ignoreNextContentChange = true;
},
/**
* Safely remove the mask AnoymousContent node from the CanvasFrame.
*
* @param {nsIDOMWindow} window
*/
_removeHighlightAllMask(window) {
window = this.getTopWindow(window);
let dict = this.getForWindow(window);
if (!dict.modalHighlightAllMask) {
return;
}
// If the current window isn't the one the content was inserted into, this
// will fail, but that's fine.
if (lazy.kDebug) {
dict.modalHighlightAllMask.remove();
} else {
try {
window.document.removeAnonymousContent(dict.modalHighlightAllMask);
} catch (ex) {}
}
dict.modalHighlightAllMask = null;
},
/**
* Check if the width or height of the current document is too big to handle
* for certain operations. This allows us to degrade gracefully when we expect
* the performance to be negatively impacted due to drawing-intensive operations.
*
* @param {Object} dict Dictionary of properties belonging to the currently
* active window
* @return {Boolean}
*/
_isPageTooBig(dict) {
let { height, width } = dict.lastWindowDimensions;
return height >= kPageIsTooBigPx || width >= kPageIsTooBigPx;
},
/**
* Doing a full repaint each time a range is delivered by the highlight iterator
* is way too costly, thus we pipe the frequency down to every
* `kModalHighlightRepaintLoFreqMs` milliseconds. If there are dynamic ranges
* found (see `_isInDynamicContainer()` for the definition), the frequency
* will be upscaled to `kModalHighlightRepaintHiFreqMs`.
*
* @param {nsIDOMWindow} window
* @param {Object} options Dictionary of painter hints that contains the
* following properties:
* {Boolean} contentChanged Whether the documents' content changed in the
* meantime. This happens when the DOM is updated
* whilst the page is loaded.
* {Boolean} scrollOnly TRUE when the page has scrolled in the meantime,
* which means that the dynamically positioned
* elements need to be repainted.
* {Boolean} updateAllRanges Whether to recalculate the rects of all ranges
* that were found up until now.
*/
_scheduleRepaintOfMask(
window,
{ contentChanged = false, scrollOnly = false, updateAllRanges = false } = {}
) {
if (!this.useModal()) {
return;
}
window = this.getTopWindow(window);
let dict = this.getForWindow(window);
// Bail out early if the repaint scheduler is paused or when we're supposed
// to ignore the next paint (i.e. content change).
if (
dict.repaintSchedulerState == kRepaintSchedulerPaused ||
(contentChanged && dict.ignoreNextContentChange)
) {
dict.ignoreNextContentChange = false;
return;
}
let hasDynamicRanges = !!dict.dynamicRangesSet.size;
let pageIsTooBig = this._isPageTooBig(dict);
let repaintDynamicRanges =
(scrollOnly || contentChanged) && hasDynamicRanges && !pageIsTooBig;
// Determine scroll behavior and keep that state around.
let startedScrolling = !dict.busyScrolling && scrollOnly;
// When the user started scrolling the document, hide the other highlights.
if (startedScrolling) {
dict.busyScrolling = startedScrolling;
this._repaintHighlightAllMask(window);
}
// Whilst scrolling, suspend the repaint scheduler, but only when the page is
// too big or the find results contains ranges that are inside dynamic
// containers.
if (dict.busyScrolling && (pageIsTooBig || hasDynamicRanges)) {
dict.ignoreNextContentChange = true;
this._updateRangeOutline(dict);
// NB: we're not using `kRepaintSchedulerPaused` on purpose here, otherwise
// we'd break the `busyScrolling` detection (re-)using the timer.
if (dict.modalRepaintScheduler) {
window.clearTimeout(dict.modalRepaintScheduler);
dict.modalRepaintScheduler = null;
}
}
// When we request to repaint unconditionally, we mean to call
// `_repaintHighlightAllMask()` right after the timeout.
if (!dict.unconditionalRepaintRequested) {
dict.unconditionalRepaintRequested =
!contentChanged || repaintDynamicRanges;
}
// Some events, like a resize, call for recalculation of all the rects of all ranges.
if (!dict.updateAllRanges) {
dict.updateAllRanges = updateAllRanges;
}
if (dict.modalRepaintScheduler) {
return;
}
let timeoutMs =
hasDynamicRanges && !dict.busyScrolling
? kModalHighlightRepaintHiFreqMs
: kModalHighlightRepaintLoFreqMs;
dict.modalRepaintScheduler = window.setTimeout(() => {
dict.modalRepaintScheduler = null;
dict.repaintSchedulerState = kRepaintSchedulerStopped;
dict.busyScrolling = false;
let pageContentChanged = dict.detectedGeometryChange;
if (!pageContentChanged && !pageIsTooBig) {
let { width: previousWidth, height: previousHeight } =
dict.lastWindowDimensions;
let { width, height } = (dict.lastWindowDimensions =
this._getWindowDimensions(window));
pageContentChanged =
dict.detectedGeometryChange ||
Math.abs(previousWidth - width) > kContentChangeThresholdPx ||
Math.abs(previousHeight - height) > kContentChangeThresholdPx;
}
dict.detectedGeometryChange = false;
// When the page has changed significantly enough in size, we'll restart
// the iterator with the same parameters as before to find us new ranges.
if (pageContentChanged && !pageIsTooBig) {
this.iterator.restart(this.finder);
}
if (
dict.unconditionalRepaintRequested ||
(dict.modalHighlightRectsMap.size && pageContentChanged)
) {
dict.unconditionalRepaintRequested = false;
this._repaintHighlightAllMask(window);
}
}, timeoutMs);
dict.repaintSchedulerState = kRepaintSchedulerRunning;
},
/**
* Add event listeners to the content which will cause the modal highlight
* AnonymousContent to be re-painted or hidden.
*
* @param {nsIDOMWindow} window
*/
_addModalHighlightListeners(window) {
window = this.getTopWindow(window);
let dict = this.getForWindow(window);
if (dict.highlightListeners) {
return;
}
dict.highlightListeners = [
this._scheduleRepaintOfMask.bind(this, window, { contentChanged: true }),
this._scheduleRepaintOfMask.bind(this, window, { updateAllRanges: true }),
this._scheduleRepaintOfMask.bind(this, window, { scrollOnly: true }),
this.hide.bind(this, window, null),
() => (dict.busySelecting = true),
() => {
if (window.document.hidden) {
dict.repaintSchedulerState = kRepaintSchedulerPaused;
} else if (dict.repaintSchedulerState == kRepaintSchedulerPaused) {
dict.repaintSchedulerState = kRepaintSchedulerRunning;
this._scheduleRepaintOfMask(window);
}
},
];
let target = this.iterator._getDocShell(window).chromeEventHandler;
target.addEventListener("MozAfterPaint", dict.highlightListeners[0]);
target.addEventListener("resize", dict.highlightListeners[1]);
target.addEventListener("scroll", dict.highlightListeners[2], {
capture: true,
passive: true,
});
target.addEventListener("click", dict.highlightListeners[3]);
target.addEventListener("selectstart", dict.highlightListeners[4]);
window.document.addEventListener(
"visibilitychange",
dict.highlightListeners[5]
);
},
/**
* Remove event listeners from content.
*
* @param {nsIDOMWindow} window
*/
_removeModalHighlightListeners(window) {
window = this.getTopWindow(window);
let dict = this.getForWindow(window);
if (!dict.highlightListeners) {
return;
}
let target = this.iterator._getDocShell(window).chromeEventHandler;
target.removeEventListener("MozAfterPaint", dict.highlightListeners[0]);
target.removeEventListener("resize", dict.highlightListeners[1]);
target.removeEventListener("scroll", dict.highlightListeners[2], {
capture: true,
passive: true,
});
target.removeEventListener("click", dict.highlightListeners[3]);
target.removeEventListener("selectstart", dict.highlightListeners[4]);
window.document.removeEventListener(
"visibilitychange",
dict.highlightListeners[5]
);
dict.highlightListeners = null;
},
/**
* For a given node returns its editable parent or null if there is none.
* It's enough to check if node is a text node and its parent's parent is
* an input or textarea.
*
* @param node the node we want to check
* @returns the first node in the parent chain that is editable,
* null if there is no such node
*/
_getEditableNode(node) {
if (
node.nodeType === node.TEXT_NODE &&
node.parentNode &&
node.parentNode.parentNode &&
(ChromeUtils.getClassName(node.parentNode.parentNode) ===
"HTMLInputElement" ||
ChromeUtils.getClassName(node.parentNode.parentNode) ===
"HTMLTextAreaElement")
) {
return node.parentNode.parentNode;
}
return null;
},
/**
* Add ourselves as an nsIEditActionListener and nsIDocumentStateListener for
* a given editor
*
* @param editor the editor we'd like to listen to
*/
_addEditorListeners(editor) {
if (!this._editors) {
this._editors = [];
this._stateListeners = [];
}
let existingIndex = this._editors.indexOf(editor);
if (existingIndex == -1) {
let x = this._editors.length;
this._editors[x] = editor;
this._stateListeners[x] = this._createStateListener();
this._editors[x].addEditActionListener(this);
this._editors[x].addDocumentStateListener(this._stateListeners[x]);
}
},
/**
* Helper method to unhook listeners, remove cached editors
* and keep the relevant arrays in sync
*
* @param idx the index into the array of editors/state listeners
* we wish to remove
*/
_unhookListenersAtIndex(idx) {
this._editors[idx].removeEditActionListener(this);
this._editors[idx].removeDocumentStateListener(this._stateListeners[idx]);
this._editors.splice(idx, 1);
this._stateListeners.splice(idx, 1);
if (!this._editors.length) {
delete this._editors;
delete this._stateListeners;
}
},
/**
* Remove ourselves as an nsIEditActionListener and
* nsIDocumentStateListener from a given cached editor
*
* @param editor the editor we no longer wish to listen to
*/
_removeEditorListeners(editor) {
// editor is an editor that we listen to, so therefore must be
// cached. Find the index of this editor
let idx = this._editors.indexOf(editor);
if (idx == -1) {
return;
}
// Now unhook ourselves, and remove our cached copy
this._unhookListenersAtIndex(idx);
},
/*
* nsIEditActionListener logic follows
*
* We implement this interface to allow us to catch the case where
* the findbar found a match in a HTML <input> or <textarea>. If the
* user adjusts the text in some way, it will no longer match, so we
* want to remove the highlight, rather than have it expand/contract
* when letters are added or removed.
*/
/**
* Helper method used to check whether a selection intersects with
* some highlighting
*
* @param selectionRange the range from the selection to check
* @param findRange the highlighted range to check against
* @returns true if they intersect, false otherwise
*/
_checkOverlap(selectionRange, findRange) {
if (!selectionRange || !findRange) {
return false;
}
// The ranges overlap if one of the following is true:
// 1) At least one of the endpoints of the deleted selection
// is in the find selection
// 2) At least one of the endpoints of the find selection
// is in the deleted selection
if (
findRange.isPointInRange(
selectionRange.startContainer,
selectionRange.startOffset
)
) {
return true;
}
if (
findRange.isPointInRange(
selectionRange.endContainer,
selectionRange.endOffset
)
) {
return true;
}
if (
selectionRange.isPointInRange(
findRange.startContainer,
findRange.startOffset
)
) {
return true;
}
if (
selectionRange.isPointInRange(findRange.endContainer, findRange.endOffset)
) {
return true;
}
return false;
},
/**
* Helper method to determine if an edit occurred within a highlight
*
* @param selection the selection we wish to check
* @param node the node we want to check is contained in selection
* @param offset the offset into node that we want to check
* @returns the range containing (node, offset) or null if no ranges
* in the selection contain it
*/
_findRange(selection, node, offset) {
let rangeCount = selection.rangeCount;
let rangeidx = 0;
let foundContainingRange = false;
let range = null;
// Check to see if this node is inside one of the selection's ranges
while (!foundContainingRange && rangeidx < rangeCount) {
range = selection.getRangeAt(rangeidx);
if (range.isPointInRange(node, offset)) {
foundContainingRange = true;
break;
}
rangeidx++;
}
if (foundContainingRange) {
return range;
}
return null;
},
// Start of nsIEditActionListener implementations
WillDeleteText(textNode, offset, length) {
let editor = this._getEditableNode(textNode).editor;
let controller = editor.selectionController;
let fSelection = controller.getSelection(
Ci.nsISelectionController.SELECTION_FIND
);
let range = this._findRange(fSelection, textNode, offset);
if (range) {
// Don't remove the highlighting if the deleted text is at the
// end of the range
if (textNode != range.endContainer || offset != range.endOffset) {
// Text within the highlight is being removed - the text can
// no longer be a match, so remove the highlighting
fSelection.removeRange(range);
if (fSelection.rangeCount == 0) {
this._removeEditorListeners(editor);
}
}
}
},
DidInsertText(textNode, offset, aString) {
let editor = this._getEditableNode(textNode).editor;
let controller = editor.selectionController;
let fSelection = controller.getSelection(
Ci.nsISelectionController.SELECTION_FIND
);
let range = this._findRange(fSelection, textNode, offset);
if (range) {
// If the text was inserted before the highlight
// adjust the highlight's bounds accordingly
if (textNode == range.startContainer && offset == range.startOffset) {
range.setStart(
range.startContainer,
range.startOffset + aString.length
);
} else if (textNode != range.endContainer || offset != range.endOffset) {
// The edit occurred within the highlight - any addition of text
// will result in the text no longer being a match,
// so remove the highlighting
fSelection.removeRange(range);
if (fSelection.rangeCount == 0) {
this._removeEditorListeners(editor);
}
}
}
},
WillDeleteRanges(rangesToDelete) {
let { editor } = this._getEditableNode(rangesToDelete[0].startContainer);
let controller = editor.selectionController;
let fSelection = controller.getSelection(
Ci.nsISelectionController.SELECTION_FIND
);
let shouldDelete = {};
let numberOfDeletedSelections = 0;
let numberOfMatches = fSelection.rangeCount;
// We need to test if any ranges to be deleted
// are in any of the ranges of the find selection
// Usually both selections will only contain one range, however
// either may contain more than one.
for (let fIndex = 0; fIndex < numberOfMatches; fIndex++) {
shouldDelete[fIndex] = false;
let fRange = fSelection.getRangeAt(fIndex);
for (let selRange of rangesToDelete) {
if (shouldDelete[fIndex]) {
continue;
}
let doesOverlap = this._checkOverlap(selRange, fRange);
if (doesOverlap) {
shouldDelete[fIndex] = true;
numberOfDeletedSelections++;
}
}
}
// OK, so now we know what matches (if any) are in the selection
// that is being deleted. Time to remove them.
if (!numberOfDeletedSelections) {
return;
}
for (let i = numberOfMatches - 1; i >= 0; i--) {
if (shouldDelete[i]) {
fSelection.removeRange(fSelection.getRangeAt(i));
}
}
// Remove listeners if no more highlights left
if (!fSelection.rangeCount) {
this._removeEditorListeners(editor);
}
},
/*
* nsIDocumentStateListener logic follows
*
* When attaching nsIEditActionListeners, there are no guarantees
* as to whether the findbar or the documents in the browser will get
* destructed first. This leads to the potential to either leak, or to
* hold on to a reference an editable element's editor for too long,
* preventing it from being destructed.
*
* However, when an editor's owning node is being destroyed, the editor
* sends out a DocumentWillBeDestroyed notification. We can use this to
* clean up our references to the object, to allow it to be destroyed in a
* timely fashion.
*/
/**
* Unhook ourselves when one of our state listeners has been called.
* This can happen in 4 cases:
* 1) The document the editor belongs to is navigated away from, and
* the document is not being cached
*
* 2) The document the editor belongs to is expired from the cache
*
* 3) The tab containing the owning document is closed
*
* 4) The <input> or <textarea> that owns the editor is explicitly
* removed from the DOM
*
* @param the listener that was invoked
*/
_onEditorDestruction(aListener) {
// First find the index of the editor the given listener listens to.
// The listeners and editors arrays must always be in sync.
// The listener will be in our array of cached listeners, as this
// method could not have been called otherwise.
let idx = 0;
while (this._stateListeners[idx] != aListener) {
idx++;
}
// Unhook both listeners
this._unhookListenersAtIndex(idx);
},
/**
* Creates a unique document state listener for an editor.
*
* It is not possible to simply have the findbar implement the
* listener interface itself, as it wouldn't have sufficient information
* to work out which editor was being destroyed. Therefore, we create new
* listeners on the fly, and cache them in sync with the editors they
* listen to.
*/
_createStateListener() {
return {
findbar: this,
QueryInterface: ChromeUtils.generateQI(["nsIDocumentStateListener"]),
NotifyDocumentWillBeDestroyed() {
this.findbar._onEditorDestruction(this);
},
// Unimplemented
notifyDocumentStateChanged(aDirty) {},
};
},
};
|