forked from adobe/brackets
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathAppInit.js
More file actions
169 lines (149 loc) · 5.57 KB
/
AppInit.js
File metadata and controls
169 lines (149 loc) · 5.57 KB
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
/*
* Copyright (c) 2012 - present Adobe Systems Incorporated. All rights reserved.
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
*
*/
/**
* Defines hooks to assist with module initialization.
*
* This module defines 3 methods for client modules to attach callbacks:
* - htmlReady - When the main application template is rendered
* - extensionsLoaded - When the extension manager has loaded all extensions
* - appReady - When Brackets completes loading all modules and extensions
*
* These are *not* jQuery events. Each method is similar to $(document).ready
* in that it will call the handler immediately if brackets is already done
* loading.
*/
define(function (require, exports, module) {
"use strict";
/*
* Fires when the base htmlContent/main-view.html is loaded
* @type {string}
* @const
*/
var HTML_READY = "htmlReady";
/*
* Fires when all extensions are loaded
* @type {string}
* @const
*/
var APP_READY = "appReady";
/*
* Fires after extensions have been loaded
* @type {string}
* @const
*/
var EXTENSIONS_LOADED = "extensionsLoaded";
/*
* Map of each state's trigger
* @type {Object.<string, boolean>}
* @private
*/
var _status = { HTML_READY : false, APP_READY : false, EXTENSIONS_LOADED: false };
/*
* Map of callbacks to states
* @type {Object.<string, Array.<function()>>}
* @private
*/
var _callbacks = {};
_callbacks[HTML_READY] = [];
_callbacks[APP_READY] = [];
_callbacks[EXTENSIONS_LOADED] = [];
/*
* calls the specified handler inside a try/catch handler
* @param {function()} handler - the callback to call
* @private
*/
function _callHandler(handler) {
try {
// TODO (issue 1034): We *could* use a $.Deferred for this, except deferred objects enter a broken
// state if any resolution callback throws an exception. Since third parties (e.g. extensions) may
// add callbacks to this, we need to be robust to exceptions
handler();
} catch (e) {
console.error("Exception when calling a 'brackets done loading' handler: " + e);
console.log(e.stack);
}
}
/*
* dispatches the event by calling all handlers registered for that type
* @param {string} type - the event type to dispatch (APP_READY, EXTENSIONS_READY, HTML_READY)
* @private
*/
function _dispatchReady(type) {
var i,
myHandlers = _callbacks[type];
// mark this status complete
_status[type] = true;
for (i = 0; i < myHandlers.length; i++) {
_callHandler(myHandlers[i]);
}
// clear all callbacks after being called
_callbacks[type] = [];
}
/*
* adds a callback to the list of functions to call for the specified event type
* @param {string} type - the event type to dispatch (APP_READY, EXTENSIONS_READY, HTML_READY)
* @param {function} handler - callback funciton to call when the event is triggered
* @private
*/
function _addListener(type, handler) {
if (_status[type]) {
_callHandler(handler);
} else {
_callbacks[type].push(handler);
}
}
/**
* Adds a callback for the ready hook. Handlers are called after
* htmlReady is done, the initial project is loaded, and all extensions are
* loaded.
* @param {function} handler - callback function to call when the event is fired
*/
function appReady(handler) {
_addListener(APP_READY, handler);
}
/**
* Adds a callback for the htmlReady hook. Handlers are called after the
* main application html template is rendered.
* @param {function} handler - callback function to call when the event is fired
*/
function htmlReady(handler) {
_addListener(HTML_READY, handler);
}
/**
* Adds a callback for the extensionsLoaded hook. Handlers are called after the
* extensions have been loaded
* @param {function} handler - callback function to call when the event is fired
*/
function extensionsLoaded(handler) {
_addListener(EXTENSIONS_LOADED, handler);
}
// Public API
exports.appReady = appReady;
exports.htmlReady = htmlReady;
exports.extensionsLoaded = extensionsLoaded;
exports.HTML_READY = HTML_READY;
exports.APP_READY = APP_READY;
exports.EXTENSIONS_LOADED = EXTENSIONS_LOADED;
// Unit Test API
exports._dispatchReady = _dispatchReady;
});