forked from 1j01/os-gui
-
Notifications
You must be signed in to change notification settings - Fork 0
/
$Window.js
1634 lines (1529 loc) · 58.5 KB
/
$Window.js
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
((exports) => {
// TODO: E\("([a-z]+)"\) -> "<$1>" or get rid of jQuery as a dependency
function E(tagName) {
return document.createElement(tagName);
}
function element_to_string(element) {
// returns a CSS-selector-like string for the given element
// if (element instanceof Element) { // doesn't work with different window.Element from iframes
if (typeof element === "object" && "tagName" in element) {
return element.tagName.toLowerCase() +
(element.id ? "#" + element.id : "") +
(element.className ? "." + element.className.split(" ").join(".") : "") +
(element.src ? `[src="${element.src}"]` : "") + // Note: not escaped; may not actually work as a selector (but this is for debugging)
(element.srcdoc ? "[srcdoc]" : "") + // (srcdoc can be long)
(element.href ? `[href="${element.href}"]` : "");
} else if (element) {
return element.constructor.name;
} else {
return `${element}`;
}
}
function find_tabstops(container_el) {
const $el = $(container_el);
// This function finds focusable controls, but not necessarily all of them;
// for radio elements, it only gives one: either the checked one, or the first one if none are checked.
// Note: for audio[controls], Chrome at least has two tabstops (the audio element and three dots menu button).
// It might be possible to detect this in the shadow DOM, I don't know, I haven't worked with the shadow DOM.
// But it might be more reliable to make a dummy tabstop element to detect when you tab out of the first/last element.
// Also for iframes!
// Assuming that doesn't mess with screen readers.
// Right now you can't tab to the three dots menu if it's the last element.
// @TODO: see what ally.js does. Does it handle audio[controls]? https://allyjs.io/api/query/tabsequence.html
let $controls = $el.find(`
input:enabled,
textarea:enabled,
select:enabled,
button:enabled,
a[href],
[tabIndex='0'],
details summary,
iframe,
object,
embed,
video[controls],
audio[controls],
[contenteditable]:not([contenteditable='false'])
`).filter(":visible");
// const $controls = $el.find(":tabbable"); // https://api.jqueryui.com/tabbable-selector/
// Radio buttons should be treated as a group with one tabstop.
// If there's no selected ("checked") radio, it should still visit the group,
// but if there is a selected radio in the group, it should skip all unselected radios in the group.
const radios = {}; // best radio found so far, per group
const to_skip = [];
for (const el of $controls.toArray()) {
if (el.nodeName.toLowerCase() === "input" && el.type === "radio") {
if (radios[el.name]) {
if (el.checked) {
to_skip.push(radios[el.name]);
radios[el.name] = el;
} else {
to_skip.push(el);
}
} else {
radios[el.name] = el;
}
}
}
const $tabstops = $controls.not(to_skip);
// debug viz:
// $tabstops.css({boxShadow: "0 0 2px 2px green"});
// $(to_skip).css({boxShadow: "0 0 2px 2px gray"})
return $tabstops;
}
var $G = $(window);
$Window.Z_INDEX = 5;
var minimize_slots = []; // for if there's no taskbar
// @TODO: make this a class,
// instead of a weird pseudo-class
function $Window(options) {
options = options || {};
// @TODO: handle all option defaults here
// and validate options.
var $w = $(E("div")).addClass("window os-window").appendTo("body");
$w[0].$window = $w;
$w.element = $w[0];
$w[0].id = `os-window-${Math.random().toString(36).substr(2, 9)}`;
$w.$titlebar = $(E("div")).addClass("window-titlebar").appendTo($w);
$w.$title_area = $(E("div")).addClass("window-title-area").appendTo($w.$titlebar);
$w.$title = $(E("span")).addClass("window-title").appendTo($w.$title_area);
if (options.toolWindow) {
options.minimizeButton = false;
options.maximizeButton = false;
}
if (options.minimizeButton !== false) {
$w.$minimize = $(E("button")).addClass("window-minimize-button window-action-minimize window-button").appendTo($w.$titlebar);
$w.$minimize.attr("aria-label", "Minimize window"); // @TODO: for taskbarless minimized windows, "restore"
$w.$minimize.append("<span class='window-button-icon'></span>");
}
if (options.maximizeButton !== false) {
$w.$maximize = $(E("button")).addClass("window-maximize-button window-action-maximize window-button").appendTo($w.$titlebar);
$w.$maximize.attr("aria-label", "Maximize or restore window"); // @TODO: specific text for the state
if (!options.resizable) {
$w.$maximize.attr("disabled", true);
}
$w.$maximize.append("<span class='window-button-icon'></span>");
}
if (options.closeButton !== false) {
$w.$x = $(E("button")).addClass("window-close-button window-action-close window-button").appendTo($w.$titlebar);
$w.$x.attr("aria-label", "Close window");
$w.$x.append("<span class='window-button-icon'></span>");
}
$w.$content = $(E("div")).addClass("window-content").appendTo($w);
$w.$content.attr("tabIndex", "-1");
$w.$content.css("outline", "none");
if (options.toolWindow) {
$w.addClass("tool-window");
}
if (options.parentWindow) {
options.parentWindow.addChildWindow($w);
// semantic parent logic is currently only suited for tool windows
// for dialog windows, it would make the dialog window not show as focused
// (alternatively, I could simply, when following the semantic parent chain, look for windows that are not tool windows)
if (options.toolWindow) {
$w[0].dataset.semanticParent = options.parentWindow[0].id;
}
}
var $component = options.$component;
if (typeof options.icon === "object" && "tagName" in options.icon) {
options.icons = { any: options.icon };
} else if (options.icon) {
// old terrible API using globals that you have to define
console.warn("DEPRECATED: use options.icons instead of options.icon, e.g. new $Window({icons: {16: 'app-16x16.png', any: 'app-icon.svg'}})");
if (typeof $Icon !== "undefined" && typeof TITLEBAR_ICON_SIZE !== "undefined") {
$w.icon_name = options.icon;
$w.$icon = $Icon(options.icon, TITLEBAR_ICON_SIZE).prependTo($w.$titlebar);
} else {
throw new Error("Use {icon: img_element} or {icons: {16: url_or_img_element}} options");
}
}
$w.icons = options.icons || {};
let iconSize = 16;
$w.setTitlebarIconSize = function (target_icon_size) {
if ($w.icons) {
$w.$icon?.remove();
$w.$icon = $($w.getIconAtSize(target_icon_size));
$w.$icon.prependTo($w.$titlebar);
}
iconSize = target_icon_size;
$w.trigger("icon-change");
};
$w.getTitlebarIconSize = function () {
return iconSize;
};
// @TODO: this could be a static method, like OSGUI.getIconAtSize(icons, targetSize)
$w.getIconAtSize = function (target_icon_size) {
let icon_size;
if ($w.icons[target_icon_size]) {
icon_size = target_icon_size;
} else if ($w.icons["any"]) {
icon_size = "any";
} else {
const sizes = Object.keys($w.icons).filter(size => isFinite(size) && isFinite(parseFloat(size)));
sizes.sort((a, b) => Math.abs(a - target_icon_size) - Math.abs(b - target_icon_size));
icon_size = sizes[0];
}
if (icon_size) {
const icon = $w.icons[icon_size];
let icon_element;
if (icon.nodeType !== undefined) {
icon_element = icon.cloneNode(true);
} else {
icon_element = E("img");
const $icon = $(icon_element);
if (icon.srcset) {
$icon.attr("srcset", icon.srcset);
} else {
$icon.attr("src", icon.src || icon);
}
$icon.attr({
width: icon_size,
height: icon_size,
draggable: false,
});
$icon.css({
width: target_icon_size,
height: target_icon_size,
});
}
return icon_element;
}
return null;
};
// @TODO: automatically update icon size based on theme (with a CSS variable)
$w.setTitlebarIconSize(iconSize);
$w.getIconName = () => {
console.warn("DEPRECATED: use $w.icons object instead of $w.icon_name");
return $w.icon_name;
};
$w.setIconByID = (icon_name) => {
console.warn("DEPRECATED: use $w.setIcons(icons) instead of $w.setIconByID(icon_name)");
var old_$icon = $w.$icon;
$w.$icon = $Icon(icon_name, TITLEBAR_ICON_SIZE);
old_$icon.replaceWith($w.$icon);
$w.icon_name = icon_name;
$w.task?.updateIcon();
$w.trigger("icon-change");
return $w;
};
$w.setIcons = (icons) => {
$w.icons = icons;
$w.setTitlebarIconSize(iconSize);
$w.task?.updateIcon();
// icon-change already sent by setTitlebarIconSize
};
if ($component) {
$w.addClass("component-window");
}
setTimeout(() => {
if (get_direction() == "rtl") {
$w.addClass("rtl"); // for reversing the titlebar gradient
}
}, 0);
// returns writing/layout direction, "ltr" or "rtl"
function get_direction() {
return window.get_direction ? window.get_direction() : getComputedStyle($w[0]).direction;
}
// This is very silly, using jQuery's event handling to implement simpler event handling.
// But I'll implement it in a non-silly way at least when I remove jQuery. Maybe sooner.
const $event_target = $({});
const make_simple_listenable = (name) => {
return (callback) => {
const fn = () => {
callback();
};
$event_target.on(name, fn);
const dispose = () => {
$event_target.off(name, fn);
};
return dispose;
};
};
$w.onFocus = make_simple_listenable("focus");
$w.onBlur = make_simple_listenable("blur");
$w.onClosed = make_simple_listenable("closed");
$w.setDimensions = ({ innerWidth, innerHeight, outerWidth, outerHeight }) => {
let width_from_frame, height_from_frame;
// It's good practice to make all measurements first, then update the DOM.
// Once you update the DOM, the browser has to recalculate layout, which can be slow.
if (innerWidth) {
width_from_frame = $w.outerWidth() - $w.$content.outerWidth();
}
if (innerHeight) {
height_from_frame = $w.outerHeight() - $w.$content.outerHeight();
const $menu_bar = $w.$content.find(".menus"); // only if inside .content; might move to a slot outside .content later
if ($menu_bar.length) {
// maybe this isn't technically part of the frame, per se? but it's part of the non-client area, which is what I technically mean.
height_from_frame += $menu_bar.outerHeight();
}
}
if (outerWidth) {
$w.outerWidth(outerWidth);
}
if (outerHeight) {
$w.outerHeight(outerHeight);
}
if (innerWidth) {
$w.outerWidth(innerWidth + width_from_frame);
}
if (innerHeight) {
$w.outerHeight(innerHeight + height_from_frame);
}
};
$w.setDimensions(options);
let child_$windows = [];
$w.addChildWindow = ($child_window) => {
child_$windows.push($child_window);
};
const showAsFocused = () => {
if ($w.hasClass("focused")) {
return;
}
$w.addClass("focused");
$event_target.triggerHandler("focus");
};
const stopShowingAsFocused = () => {
if (!$w.hasClass("focused")) {
return;
}
$w.removeClass("focused");
$event_target.triggerHandler("blur");
};
$w.focus = () => {
// showAsFocused();
$w.bringToFront();
refocus();
};
$w.blur = () => {
stopShowingAsFocused();
if (document.activeElement && document.activeElement.closest(".window") == $w[0]) {
document.activeElement.blur();
}
};
if (options.toolWindow) {
if (options.parentWindow) {
options.parentWindow.onFocus(showAsFocused);
options.parentWindow.onBlur(stopShowingAsFocused);
// TODO: also show as focused if focus is within the window
// initial state
// might need a setTimeout, idk...
if (document.activeElement && document.activeElement.closest(".window") == options.parentWindow[0]) {
showAsFocused();
}
} else {
// the browser window is the parent window
// show focus whenever the browser window is focused
$(window).on("focus", showAsFocused);
$(window).on("blur", stopShowingAsFocused);
// initial state
if (document.hasFocus()) {
showAsFocused();
}
}
} else {
// global focusout is needed, to continue showing as focused while child windows or menu popups are focused (@TODO: Is this redundant with focusin?)
// global focusin is needed, to show as focused when a child window becomes focused (when perhaps nothing was focused before, so no focusout event)
// global blur is needed, to show as focused when an iframe gets focus, because focusin/out doesn't fire at all in that case
// global focus is needed, to stop showing as focused when an iframe loses focus
// pretty ridiculous!!
// but it still doesn't handle the case where the browser window is not focused, and the user clicks an iframe directly.
// for that, we need to listen inside the iframe, because no events are fired at all outside in that case,
// and :focus/:focus-within doesn't work with iframes so we can't even do a hack with transitionstart.
// @TODO: simplify the strategy; I ended up piling a few strategies on top of each other, and the earlier ones may be redundant.
// In particular, 1. I ended up making it proactively inject into iframes, rather than when focused since there's a case where focus can't be detected otherwise.
// 2. I ended up simulating focusin events for iframes.
// I may want to rely on that, or, I may want to remove that and set up a refocus chain directly instead,
// avoiding refocus() which may interfere with drag operations in an iframe when focusing the iframe (e.g. clicking into Paint to draw or drag a sub-window).
// console.log("adding global focusin/focusout/blur/focus for window", $w[0].id);
const global_focus_update_handler = make_focus_in_out_handler($w[0], true); // must be $w and not $content so semantic parent chain works, with [data-semantic-parent] pointing to the window not the content
window.addEventListener("focusin", global_focus_update_handler);
window.addEventListener("focusout", global_focus_update_handler);
window.addEventListener("blur", global_focus_update_handler);
window.addEventListener("focus", global_focus_update_handler);
function setupIframe(iframe) {
if (!focus_update_handlers_by_container.has(iframe)) {
const iframe_update_focus = make_focus_in_out_handler(iframe, false);
// this also operates as a flag to prevent multiple handlers from being added, or waiting for the iframe to load duplicately
focus_update_handlers_by_container.set(iframe, iframe_update_focus);
// @TODO: try removing setTimeout(s)
setTimeout(() => { // for iframe src to be set? I forget.
// Note: try must be INSIDE setTimeout, not outside, to work.
try {
const wait_for_iframe_load = (callback) => {
// Note: error may occur accessing iframe.contentDocument; this must be handled by the caller.
// To that end, this function must access it synchronously, to allow the caller to handle the error.
if (iframe.contentDocument.readyState == "complete") {
callback();
} else {
// iframe.contentDocument.addEventListener("readystatechange", () => {
// if (iframe.contentDocument.readyState == "complete") {
// callback();
// }
// });
setTimeout(() => {
wait_for_iframe_load(callback);
}, 100);
}
};
wait_for_iframe_load(() => {
// console.log("adding focusin/focusout/blur/focus for iframe", iframe);
iframe.contentWindow.addEventListener("focusin", iframe_update_focus);
iframe.contentWindow.addEventListener("focusout", iframe_update_focus);
iframe.contentWindow.addEventListener("blur", iframe_update_focus);
iframe.contentWindow.addEventListener("focus", iframe_update_focus);
observeIframes(iframe.contentDocument);
});
} catch (error) {
warn_iframe_access(iframe, error);
}
}, 100);
}
}
function observeIframes(container_node) {
const observer = new MutationObserver((mutations) => {
for (const mutation of mutations) {
for (const node of mutation.addedNodes) {
if (node.tagName == "IFRAME") {
setupIframe(node);
}
}
}
});
observer.observe(container_node, { childList: true, subtree: true });
// needed in recursive calls (for iframes inside iframes)
// (for the window, it shouldn't be able to have iframes yet)
for (const iframe of container_node.querySelectorAll("iframe")) {
setupIframe(iframe);
}
}
observeIframes($w.$content[0]);
function make_focus_in_out_handler(logical_container_el, is_root) {
// In case of iframes, logical_container_el is the iframe, and container_node is the iframe's contentDocument.
// container_node is not a parameter here because it can change over time, may be an empty document before the iframe is loaded.
return function handle_focus_in_out(event) {
const container_node = logical_container_el.tagName == "IFRAME" ? logical_container_el.contentDocument : logical_container_el;
const document = container_node.ownerDocument ?? container_node;
// is this equivalent?
// const document = logical_container_el.tagName == "IFRAME" ? logical_container_el.contentDocument : logical_container_el.ownerDocument;
// console.log(`handling ${event.type} for container`, container_el);
let newly_focused = event ? (event.type === "focusout" || event.type === "blur") ? event.relatedTarget : event.target : document.activeElement;
if (event?.type === "blur") {
newly_focused = null; // only handle iframe
}
// console.log(`[${$w.title()}] (is_root=${is_root})`, `newly_focused is (preliminarily)`, element_to_string(newly_focused), `\nlogical_container_el`, logical_container_el, `\ncontainer_node`, container_node, `\ndocument.activeElement`, document.activeElement, `\ndocument.hasFocus()`, document.hasFocus(), `\ndocument`, document);
// Iframes are stingy about focus events, so we need to check if focus is actually within an iframe.
if (
document.activeElement &&
document.activeElement.tagName === "IFRAME" &&
(event?.type === "focusout" || event?.type === "blur") &&
!newly_focused // doesn't exist for security reasons in this case
) {
newly_focused = document.activeElement;
// console.log(`[${$w.title()}] (is_root=${is_root})`, `newly_focused is (actually)`, element_to_string(newly_focused));
}
const outside_or_at_exactly =
!newly_focused ||
// contains() only works with DOM nodes (elements and documents), not window objects.
// Since container_node is a DOM node, it will never have a Window inside of it (ignoring iframes).
newly_focused.window === newly_focused || // is a Window object (cross-frame test)
!container_node.contains(newly_focused); // Note: node.contains(node) === true
const firmly_outside = outside_or_at_exactly && container_node !== newly_focused;
// console.log(`[${$w.title()}] (is_root=${is_root})`, `outside_or_at_exactly=${outside_or_at_exactly}`, `firmly_outside=${firmly_outside}`);
if (firmly_outside && is_root) {
stopShowingAsFocused();
}
if (
!outside_or_at_exactly &&
newly_focused.tagName !== "HTML" &&
newly_focused.tagName !== "BODY" &&
newly_focused !== container_node &&
!newly_focused.matches(".window-content") &&
!newly_focused.closest(".menus") &&
!newly_focused.closest(".window-titlebar")
) {
last_focus_by_container.set(logical_container_el, newly_focused); // overwritten for iframes below
debug_focus_tracking(document, container_node, newly_focused, is_root);
}
if (
!outside_or_at_exactly &&
newly_focused.tagName === "IFRAME"
) {
const iframe = newly_focused;
// console.log("iframe", iframe, onfocusin_by_container.has(iframe));
try {
const focus_in_iframe = iframe.contentDocument.activeElement;
if (
focus_in_iframe &&
focus_in_iframe.tagName !== "HTML" &&
focus_in_iframe.tagName !== "BODY" &&
!focus_in_iframe.closest(".menus")
) {
// last_focus_by_container.set(logical_container_el, iframe); // done above
last_focus_by_container.set(iframe, focus_in_iframe);
debug_focus_tracking(iframe.contentDocument, iframe.contentDocument, focus_in_iframe, is_root);
}
} catch (e) {
warn_iframe_access(iframe, e);
}
}
// For child windows and menu popups, follow "semantic parent" chain.
// Menu popups and child windows aren't descendants of the window they belong to,
// but should keep the window shown as focused.
// (In principle this sort of feature could be useful for focus tracking*,
// but right now it's only for child windows and menu popups, which should not be tracked for refocus,
// so I'm doing this after last_focus_by_container.set, for now anyway.)
// ((*: and it may even be surprising if it doesn't work, if one sees the attribute on menus and attempts to use it.
// But who's going to see that? The menus close so it's a pain to see the DOM structure! :P **))
// (((**: without window.debugKeepMenusOpen)))
if (is_root) {
do {
// if (!newly_focused?.closest) {
// console.warn("what is this?", newly_focused);
// break;
// }
const waypoint = newly_focused?.closest?.("[data-semantic-parent]");
if (waypoint) {
const id = waypoint.dataset.semanticParent;
const parent = waypoint.ownerDocument.getElementById(id);
// console.log("following semantic parent, from", newly_focused, "\nto", parent, "\nvia", waypoint);
newly_focused = parent;
if (!parent) {
console.warn("semantic parent not found with id", id);
break;
}
} else {
break;
}
} while (true);
}
// Note: allowing showing window as focused from listeners inside iframe (non-root) too,
// in order to handle clicking an iframe when the browser window was not previously focused (e.g. after reload)
if (
newly_focused &&
newly_focused.window !== newly_focused && // cross-frame test for Window object
container_node.contains(newly_focused)
) {
showAsFocused();
$w.bringToFront();
if (!is_root) {
// trigger focusin events for iframes
// @TODO: probably don't need showAsFocused() here since it'll be handled externally (on this simulated focusin),
// and might not need a lot of other logic frankly if I'm simulating focusin events
let el = logical_container_el;
while (el) {
// console.log("dispatching focusin event for", el);
el.dispatchEvent(new Event("focusin", {
bubbles: true,
target: el,
view: el.ownerDocument.defaultView,
}));
el = el.currentView?.frameElement;
}
}
} else if (is_root) {
stopShowingAsFocused();
}
}
}
// initial state is unfocused
}
$w.css("touch-action", "none");
let minimize_target_el = null; // taskbar button (optional)
$w.setMinimizeTarget = function (new_taskbar_button_el) {
minimize_target_el = new_taskbar_button_el;
};
let task;
Object.defineProperty($w, "task", {
get() {
return task;
},
set(new_task) {
console.warn("DEPRECATED: use $w.setMinimizeTarget(taskbar_button_el) instead of setting $window.task object");
task = new_task;
},
});
let before_minimize;
$w.minimize = () => {
minimize_target_el = minimize_target_el || task?.$task[0];
if (animating_titlebar) {
when_done_animating_titlebar.push($w.minimize);
return;
}
if ($w.is(":visible")) {
if (minimize_target_el && !$w.hasClass("minimized-without-taskbar")) {
const before_rect = $w.$titlebar[0].getBoundingClientRect();
const after_rect = minimize_target_el.getBoundingClientRect();
$w.animateTitlebar(before_rect, after_rect, () => {
$w.hide();
$w.blur();
});
} else {
// no taskbar
// @TODO: make this metrically similar to what Windows 98 does
// @TODO: DRY! This is copied heavily from maximize()
// @TODO: after minimize (without taskbar) and maximize, restore should restore original position before minimize
// OR should it not maximize but restore the unmaximized state? I think I tested it but I forget.
const to_width = 150;
const spacing = 10;
if ($w.hasClass("minimized-without-taskbar")) {
// unminimizing
minimize_slots[$w._minimize_slot_index] = null;
} else {
// minimizing
let i = 0;
while (minimize_slots[i]) {
i++;
}
$w._minimize_slot_index = i;
minimize_slots[i] = $w;
}
const to_x = $w._minimize_slot_index * (to_width + spacing) + 10;
const titlebar_height = $w.$titlebar.outerHeight();
let before_unminimize;
const instantly_minimize = () => {
before_minimize = {
position: $w.css("position"),
left: $w.css("left"),
top: $w.css("top"),
width: $w.css("width"),
height: $w.css("height"),
};
$w.addClass("minimized-without-taskbar");
if ($w.hasClass("maximized")) {
$w.removeClass("maximized");
$w.addClass("was-maximized");
$w.$maximize.removeClass("window-action-restore");
$w.$maximize.addClass("window-action-maximize");
}
$w.$minimize.removeClass("window-action-minimize");
$w.$minimize.addClass("window-action-restore");
if (before_unminimize) {
$w.css({
position: before_unminimize.position,
left: before_unminimize.left,
top: before_unminimize.top,
width: before_unminimize.width,
height: before_unminimize.height,
});
} else {
$w.css({
position: "fixed",
top: `calc(100% - ${titlebar_height + 5}px)`,
left: to_x,
width: to_width,
height: titlebar_height,
});
}
};
const instantly_unminimize = () => {
before_unminimize = {
position: $w.css("position"),
left: $w.css("left"),
top: $w.css("top"),
width: $w.css("width"),
height: $w.css("height"),
};
$w.removeClass("minimized-without-taskbar");
if ($w.hasClass("was-maximized")) {
$w.removeClass("was-maximized");
$w.addClass("maximized");
$w.$maximize.removeClass("window-action-maximize");
$w.$maximize.addClass("window-action-restore");
}
$w.$minimize.removeClass("window-action-restore");
$w.$minimize.addClass("window-action-minimize");
$w.css({ width: "", height: "" });
if (before_minimize) {
$w.css({
position: before_minimize.position,
left: before_minimize.left,
top: before_minimize.top,
width: before_minimize.width,
height: before_minimize.height,
});
}
};
const before_rect = $w.$titlebar[0].getBoundingClientRect();
let after_rect;
$w.css("transform", "");
if ($w.hasClass("minimized-without-taskbar")) {
instantly_unminimize();
after_rect = $w.$titlebar[0].getBoundingClientRect();
instantly_minimize();
} else {
instantly_minimize();
after_rect = $w.$titlebar[0].getBoundingClientRect();
instantly_unminimize();
}
$w.animateTitlebar(before_rect, after_rect, () => {
if ($w.hasClass("minimized-without-taskbar")) {
instantly_unminimize();
} else {
instantly_minimize();
$w.blur();
}
});
}
}
};
$w.unminimize = () => {
if (animating_titlebar) {
when_done_animating_titlebar.push($w.unminimize);
return;
}
if ($w.hasClass("minimized-without-taskbar")) {
$w.minimize();
return;
}
if ($w.is(":hidden")) {
const before_rect = minimize_target_el.getBoundingClientRect();
$w.show();
const after_rect = $w.$titlebar[0].getBoundingClientRect();
$w.hide();
$w.animateTitlebar(before_rect, after_rect, () => {
$w.show();
$w.bringToFront();
$w.focus();
});
}
};
let before_maximize;
$w.maximize = () => {
if (!options.resizable) {
return;
}
if (animating_titlebar) {
when_done_animating_titlebar.push($w.maximize);
return;
}
if ($w.hasClass("minimized-without-taskbar")) {
$w.minimize();
return;
}
const instantly_maximize = () => {
before_maximize = {
position: $w.css("position"),
left: $w.css("left"),
top: $w.css("top"),
width: $w.css("width"),
height: $w.css("height"),
};
$w.addClass("maximized");
const $taskbar = $(".taskbar");
const scrollbar_width = window.innerWidth - $(window).width();
const scrollbar_height = window.innerHeight - $(window).height();
const taskbar_height = $taskbar.length ? $taskbar.outerHeight() + 1 : 0;
$w.css({
position: "fixed",
top: 0,
left: 0,
width: `calc(100vw - ${scrollbar_width}px)`,
height: `calc(100vh - ${scrollbar_height}px - ${taskbar_height}px)`,
});
};
const instantly_unmaximize = () => {
$w.removeClass("maximized");
$w.css({ width: "", height: "" });
if (before_maximize) {
$w.css({
position: before_maximize.position,
left: before_maximize.left,
top: before_maximize.top,
width: before_maximize.width,
height: before_maximize.height,
});
}
};
const before_rect = $w.$titlebar[0].getBoundingClientRect();
let after_rect;
$w.css("transform", "");
const restoring = $w.hasClass("maximized");
if (restoring) {
instantly_unmaximize();
after_rect = $w.$titlebar[0].getBoundingClientRect();
instantly_maximize();
} else {
instantly_maximize();
after_rect = $w.$titlebar[0].getBoundingClientRect();
instantly_unmaximize();
}
$w.animateTitlebar(before_rect, after_rect, () => {
if (restoring) {
instantly_unmaximize(); // finalize in some way
$w.$maximize.removeClass("window-action-restore");
$w.$maximize.addClass("window-action-maximize");
} else {
instantly_maximize(); // finalize in some way
$w.$maximize.removeClass("window-action-maximize");
$w.$maximize.addClass("window-action-restore");
}
});
};
$w.restore = () => {
if ($w.is(".minimized-without-taskbar, .minimized")) {
$w.unminimize();
} else if ($w.is(".maximized")) {
$w.maximize();
}
};
// must not pass event to functions by accident; also methods may not be defined yet
$w.$minimize?.on("click", (e)=> { $w.minimize(); });
$w.$maximize?.on("click", (e)=> { $w.maximize(); });
$w.$x?.on("click", (e)=> { $w.close(); });
$w.$title_area.on("dblclick", (e)=> { $w.maximize(); });
$w.css({
position: "absolute",
zIndex: $Window.Z_INDEX++
});
$w.bringToFront = () => {
$w.css({
zIndex: $Window.Z_INDEX++
});
for (const $childWindow of child_$windows) {
$childWindow.bringToFront();
}
};
// Keep track of last focused elements per container,
// where containers include:
// - window (global focus tracking)
// - $w[0] (window-local, for restoring focus when refocusing window)
// - any iframes that are same-origin (for restoring focus when refocusing window)
// @TODO: should these be WeakMaps? probably.
// @TODO: share this Map between all windows? but clean it up when destroying windows? or would a WeakMap take care of that?
var last_focus_by_container = new Map(); // element to restore focus to, by container
var focus_update_handlers_by_container = new Map(); // event handlers by container; note use as a flag to avoid adding multiple handlers
var debug_svg_by_container = new Map(); // visualization
var debug_svgs_in_window = []; // visualization
var warned_iframes = new WeakSet(); // prevent spamming console
const warn_iframe_access = (iframe, error) => {
const log_template = (message) => [`OS-GUI.js failed to access an iframe (${element_to_string(iframe)}) for focus integration.
${message}
Original error:
`, error];
let cross_origin;
if (iframe.srcdoc) {
cross_origin = false;
} else {
try {
const url = new URL(iframe.src);
cross_origin = url.origin !== window.location.origin; // shouldn't need to use iframe.ownerDocument.location.origin because intermediate iframes must be same-origin
} catch (parse_error) {
console.error(...log_template(`This may be a bug in OS-GUI. Is this a cross-origin iframe? Failed to parse URL (${parse_error}).`));
return;
}
}
if (cross_origin) {
if (options.iframes?.ignoreCrossOrigin && !warned_iframes.has(iframe)) {
console.warn(...log_template(`Only same-origin iframes can work with focus integration (showing window as focused, refocusing last focused controls).
If you can re-host the content on the same origin, you can resolve this and enable focus integration.
You can also disable this warning by passing {iframes: {ignoreCrossOrigin: true}} to $Window.`));
warned_iframes.add(iframe);
}
} else {
console.error(...log_template(`This may be a bug in OS-GUI, since it doesn't appear to be a cross-origin iframe.`));
}
};
const debug_focus_tracking = (document, container_el, descendant_el, is_root) => {
if (!$Window.DEBUG_FOCUS) {
return;
}
let svg = debug_svg_by_container.get(container_el);
if (!svg) {
svg = document.createElementNS("http://www.w3.org/2000/svg", "svg");
svg.style.position = "fixed";
svg.style.top = "0";
svg.style.left = "0";
svg.style.width = "100%";
svg.style.height = "100%";
svg.style.pointerEvents = "none";
svg.style.zIndex = "100000000";
svg.style.direction = "ltr"; // position labels correctly
debug_svg_by_container.set(container_el, svg);
debug_svgs_in_window.push(svg);
document.body.appendChild(svg);
}
svg._container_el = container_el;
svg._descendant_el = descendant_el;
svg._is_root = is_root;
animate_debug_focus_tracking();
};
const update_debug_focus_tracking = (svg) => {
const container_el = svg._container_el;
const descendant_el = svg._descendant_el;
const is_root = svg._is_root;
while (svg.lastChild) {
svg.removeChild(svg.lastChild);
}
const descendant_rect = descendant_el.getBoundingClientRect?.() ?? { left: 0, top: 0, width: innerWidth, height: innerHeight, right: innerWidth, bottom: innerHeight };
const container_rect = container_el.getBoundingClientRect?.() ?? { left: 0, top: 0, width: innerWidth, height: innerHeight, right: innerWidth, bottom: innerHeight };
// draw rectangles with labels
for (const rect of [descendant_rect, container_rect]) {
const rect_el = document.createElementNS("http://www.w3.org/2000/svg", "rect");
rect_el.setAttribute("x", rect.left);
rect_el.setAttribute("y", rect.top);
rect_el.setAttribute("width", rect.width);
rect_el.setAttribute("height", rect.height);
rect_el.setAttribute("stroke", rect === descendant_rect ? "#f44" : "#f44");
rect_el.setAttribute("stroke-width", "2");
rect_el.setAttribute("fill", "none");
if (!is_root) {
rect_el.setAttribute("stroke-dasharray", "5,5");
}
svg.appendChild(rect_el);
const text_el = document.createElementNS("http://www.w3.org/2000/svg", "text");
text_el.setAttribute("x", rect.left);
text_el.setAttribute("y", rect.top + (rect === descendant_rect ? 20 : 0)); // align container text on outside, descendant text on inside
text_el.setAttribute("fill", rect === descendant_rect ? "#f44" : "aqua");
text_el.setAttribute("font-size", "20");
text_el.style.textShadow = "1px 1px 1px black, 0 0 10px black";
text_el.textContent = element_to_string(rect === descendant_rect ? descendant_el : container_el);
svg.appendChild(text_el);
}
// draw lines connecting the two rects
const lines = [
[descendant_rect.left, descendant_rect.top, container_rect.left, container_rect.top],
[descendant_rect.right, descendant_rect.top, container_rect.right, container_rect.top],
[descendant_rect.left, descendant_rect.bottom, container_rect.left, container_rect.bottom],
[descendant_rect.right, descendant_rect.bottom, container_rect.right, container_rect.bottom],
];
for (const line of lines) {
const line_el = document.createElementNS("http://www.w3.org/2000/svg", "line");
line_el.setAttribute("x1", line[0]);
line_el.setAttribute("y1", line[1]);
line_el.setAttribute("x2", line[2]);
line_el.setAttribute("y2", line[3]);
line_el.setAttribute("stroke", "green");
line_el.setAttribute("stroke-width", "2");
svg.appendChild(line_el);
}
};
let debug_animation_frame_id;
const animate_debug_focus_tracking = () => {
cancelAnimationFrame(debug_animation_frame_id);
if (!$Window.DEBUG_FOCUS) {
clean_up_debug_focus_tracking();
return;
}
debug_animation_frame_id = requestAnimationFrame(animate_debug_focus_tracking);
for (const svg of debug_svgs_in_window) {
update_debug_focus_tracking(svg);
}
};
const clean_up_debug_focus_tracking = () => {
cancelAnimationFrame(debug_animation_frame_id);
for (const svg of debug_svgs_in_window) {
svg.remove();
}
debug_svgs_in_window.length = 0;
debug_svg_by_container.clear();
};
const refocus = (container_el = $w.$content[0]) => {
const logical_container_el = container_el.matches(".window-content") ? $w[0] : container_el;
const last_focus = last_focus_by_container.get(logical_container_el);
if (last_focus) {
last_focus.focus({ preventScroll: true });
if (last_focus.tagName === "IFRAME") {
try {
refocus(last_focus);
} catch (e) {
warn_iframe_access(last_focus, e);
}
}
return;
}
const $tabstops = find_tabstops(container_el);
const $default = $tabstops.filter(".default");
if ($default.length) {
$default[0].focus({ preventScroll: true });
return;
}
if ($tabstops.length) {
if ($tabstops[0].tagName === "IFRAME") {
try {
refocus($tabstops[0]); // not .contentDocument.body because we want the container tracked by last_focus_by_container