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
|
/* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is Jetpack.
*
* The Initial Developer of the Original Code is
* the Mozilla Foundation.
* Portions created by the Initial Developer are Copyright (C) 2010
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
* Irakli Gozalishvili <gozala@mozilla.com> (Original Author)
*
* Alternatively, the contents of this file may be used under the terms of
* either the GNU General Public License Version 2 or later (the "GPL"), or
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
"use strict";
const { Trait } = require("../traits");
const { List } = require("../list");
const { Tab, Options } = require("../tabs/tab");
const { EventEmitter } = require("../events");
const { EVENTS } = require("../tabs/events");
const { getOwnerWindow, getActiveTab, getTabs,
openTab, activateTab } = require("../tabs/utils");
const { observer: tabsObserver } = require("../tabs/observer");
const TAB_BROWSER = "tabbrowser";
/**
* This is a trait that is used in composition of window wrapper. Trait tracks
* tab related events of the wrapped window in order to keep track of open
* tabs and maintain their wrappers. Every new tab gets wrapped and jetpack
* type event is emitted.
*/
const WindowTabTracker = Trait.compose({
/**
* Chrome window whose tabs are tracked.
*/
_window: Trait.required,
/**
* Function used to emit events.
*/
_emit: EventEmitter.required,
_tabOptions: Trait.required,
/**
* Function to add event listeners.
*/
on: EventEmitter.required,
removeListener: EventEmitter.required,
/**
* Initializes tab tracker for a browser window.
*/
_initWindowTabTracker: function _initWindowTabTracker() {
// Ugly hack that we have to remove at some point (see Bug 658059). At this
// point it is necessary to invoke lazy `tabs` getter on the windows object
// which creates a `TabList` instance.
this.tabs;
// Binding all methods used as event listeners to the instance.
this._onTabReady = this._emitEvent.bind(this, "ready");
this._onTabOpen = this._onTabEvent.bind(this, "open");
this._onTabClose = this._onTabEvent.bind(this, "close");
this._onTabActivate = this._onTabEvent.bind(this, "activate");
this._onTabDeactivate = this._onTabEvent.bind(this, "deactivate");
for each (let tab in getTabs(this._window)) {
// We emulate "open" events for all open tabs since gecko does not emits
// them on the tabs that new windows are open with. Also this is
// necessary to synchronize tabs lists with an actual state.
this._onTabOpen(tab);
}
// We also emulate "activate" event so that it's picked up by a tab list.
this._onTabActivate(getActiveTab(this._window));
// Setting up event listeners
tabsObserver.on("open", this._onTabOpen);
tabsObserver.on("close", this._onTabClose);
tabsObserver.on("activate", this._onTabActivate);
tabsObserver.on("deactivate", this._onTabDeactivate);
},
_destroyWindowTabTracker: function _destroyWindowTabTracker() {
// We emulate close events on all tabs, since gecko does not emits such
// events by itself.
for each (let tab in this.tabs)
this._emitEvent("close", tab);
this._tabs._clear();
tabsObserver.removeListener("open", this._onTabOpen);
tabsObserver.removeListener("close", this._onTabClose);
tabsObserver.removeListener("activate", this._onTabActivate);
tabsObserver.removeListener("deactivate", this._onTabDeactivate);
},
_onTabEvent: function _onTabEvent(type, tab) {
if (this._window === getOwnerWindow(tab)) {
let options = this._tabOptions.shift() || {};
options.tab = tab;
options.window = this._public;
// creating tab wrapper and adding listener to "ready" events.
let wrappedTab = Tab(options);
// Setting up an event listener for ready events.
if (type === "open")
wrappedTab.on("ready", this._onTabReady);
this._emitEvent(type, wrappedTab);
}
},
_emitEvent: function _emitEvent(type, tab) {
// Notifies combined tab list that tab was added / removed.
tabs._emit(type, tab);
// Notifies contained tab list that window was added / removed.
this._tabs._emit(type, tab);
}
});
exports.WindowTabTracker = WindowTabTracker;
/**
* This trait is used to create live representation of open tab lists. Each
* window wrapper's tab list is represented by an object created from this
* trait. It is also used to represent list of all the open windows. Trait is
* composed out of `EventEmitter` in order to emit 'TabOpen', 'TabClose' events.
* **Please note** that objects created by this trait can't be exposed outside
* instead you should expose it's `_public` property, see comments in
* constructor for details.
*/
const TabList = List.resolve({ constructor: "_init" }).compose(
// This is ugly, but necessary. Will be removed by #596248
EventEmitter.resolve({ toString: null }),
Trait.compose({
on: Trait.required,
_emit: Trait.required,
constructor: function TabList(options) {
this._window = options.window;
// Add new items to the list
this.on(EVENTS.open.name, this._add.bind(this));
// Remove closed items from the list
this.on(EVENTS.close.name, this._remove.bind(this));
// Set value whenever new tab becomes active.
this.on("activate", function onTabActivate(tab) {
this._activeTab = tab;
}.bind(this));
// Initialize list.
this._init();
// This list is not going to emit any events, object holding this list
// will do it instead, to make that possible we return a private API.
return this;
},
get activeTab() this._activeTab,
_activeTab: null,
open: function open(options) {
options = Options(options);
this._window._tabOptions.push(options);
let tab = openTab(this._window._window, options.url);
if (!options.inBackground)
activateTab(tab);
}
// This is ugly, but necessary. Will be removed by #596248
}).resolve({ toString: null })
);
/**
* Combined list of all open tabs on all the windows.
* type {TabList}
*/
var tabs = TabList({ window: null });
exports.tabs = tabs._public;
/**
* Trait is a part of composition that represents window wrapper. This trait is
* composed out of `WindowTabTracker` that allows it to keep track of open tabs
* on the window being wrapped.
*/
const WindowTabs = Trait.compose(
WindowTabTracker,
Trait.compose({
_window: Trait.required,
/**
* List of tabs
*/
get tabs() (this._tabs || (this._tabs = TabList({ window: this })))._public,
_tabs: null,
})
);
exports.WindowTabs = WindowTabs;
|
