Web Inspector: Command-/ (slash) now auto-comments code via CodeMirror 4. Should...
[WebKit-https.git] / Source / WebInspectorUI / UserInterface / Models / KeyboardShortcut.js
1 /*
2  * Copyright (C) 2013 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 WebInspector.KeyboardShortcut = function(modifiers, key, callback, targetElement)
27 {
28     WebInspector.Object.call(this);
29
30     console.assert(key);
31     console.assert(!callback || typeof callback === "function");
32     console.assert(!targetElement || targetElement instanceof Element);
33
34     if (typeof key === "string") {
35         key = key[0].toUpperCase();
36         key = new WebInspector.Key(key.charCodeAt(0), key);
37     }
38
39     if (callback && !targetElement)
40         targetElement = document;
41
42     this._modifiers = modifiers || WebInspector.KeyboardShortcut.Modifier.None;
43     this._key = key;
44     this._targetElement = targetElement;
45     this._callback = callback;
46     this._disabled = false;
47     this._implicitlyPreventsDefault = true;
48
49     if (targetElement) {
50         var targetKeyboardShortcuts = targetElement._keyboardShortcuts;
51         if (!targetKeyboardShortcuts)
52             targetKeyboardShortcuts = targetElement._keyboardShortcuts = [];
53
54         targetKeyboardShortcuts.push(this);
55
56         if (!WebInspector.KeyboardShortcut._registeredKeyDownListener) {
57             WebInspector.KeyboardShortcut._registeredKeyDownListener = true;
58             window.addEventListener("keydown", WebInspector.KeyboardShortcut._handleKeyDown);
59         }
60     }
61 };
62
63 WebInspector.KeyboardShortcut._handleKeyDown = function(event)
64 {
65     if (event.defaultPrevented)
66         return;
67
68     for (var targetElement = event.target; targetElement; targetElement = targetElement.parentNode) {
69         if (!targetElement._keyboardShortcuts)
70             continue;
71
72         for (var i = 0; i < targetElement._keyboardShortcuts.length; ++i) {
73             var keyboardShortcut = targetElement._keyboardShortcuts[i];
74             if (!keyboardShortcut.matchesEvent(event))
75                 continue;
76
77             keyboardShortcut.callback(event, keyboardShortcut);
78
79             if (keyboardShortcut.implicitlyPreventsDefault)
80                 event.preventDefault();
81
82             return;
83         }
84     }
85 };
86
87 WebInspector.KeyboardShortcut.Modifier = {
88     None: 0,
89     Shift: 1,
90     Control: 2,
91     Option: 4,
92     Command: 8,
93
94     get CommandOrControl()
95     {
96         return InspectorFrontendHost.platform() === "mac" ? this.Command : this.Control;
97     }
98 };
99
100 WebInspector.Key = function(keyCode, displayName)
101 {
102     this._keyCode = keyCode;
103     this._displayName = displayName;
104 };
105
106 WebInspector.Key.prototype = {
107     get keyCode()
108     {
109         return this._keyCode;
110     },
111
112     get displayName()
113     {
114         return this._displayName;
115     },
116
117     toString: function()
118     {
119         return this._displayName;
120     }
121 };
122
123 WebInspector.KeyboardShortcut.Key = {
124     Backspace: new WebInspector.Key(8, "\u232b"),
125     Tab: new WebInspector.Key(9, "\u21e5"),
126     Enter: new WebInspector.Key(13, "\u21a9"),
127     Escape: new WebInspector.Key(27, "\u238b"),
128     Space: new WebInspector.Key(32, "Space"),
129     PageUp: new WebInspector.Key(33, "\u21de"),
130     PageDown: new WebInspector.Key(34, "\u21df"),
131     End: new WebInspector.Key(35, "\u2198"),
132     Home: new WebInspector.Key(36, "\u2196"),
133     Left: new WebInspector.Key(37, "\u2190"),
134     Up: new WebInspector.Key(38, "\u2191"),
135     Right: new WebInspector.Key(39, "\u2192"),
136     Down: new WebInspector.Key(40, "\u2193"),
137     Delete: new WebInspector.Key(46, "\u2326"),
138     Zero: new WebInspector.Key(48, "0"),
139     F1: new WebInspector.Key(112, "F1"),
140     F2: new WebInspector.Key(113, "F2"),
141     F3: new WebInspector.Key(114, "F3"),
142     F4: new WebInspector.Key(115, "F4"),
143     F5: new WebInspector.Key(116, "F5"),
144     F6: new WebInspector.Key(117, "F6"),
145     F7: new WebInspector.Key(118, "F7"),
146     F8: new WebInspector.Key(119, "F8"),
147     F9: new WebInspector.Key(120, "F9"),
148     F10: new WebInspector.Key(121, "F10"),
149     F11: new WebInspector.Key(122, "F11"),
150     F12: new WebInspector.Key(123, "F12"),
151     Semicolon: new WebInspector.Key(186, ";"),
152     Plus: new WebInspector.Key(187, "+"),
153     Comma: new WebInspector.Key(188, ","),
154     Minus: new WebInspector.Key(189, "-"),
155     Period: new WebInspector.Key(190, "."),
156     Slash: new WebInspector.Key(191, "/"),
157     Backslash: new WebInspector.Key(220, "\\"),
158     Apostrophe: new WebInspector.Key(192, "`"),
159     SingleQuote: new WebInspector.Key(222, "\'")
160 };
161
162 WebInspector.KeyboardShortcut.prototype = {
163     constructor: WebInspector.KeyboardShortcut,
164
165     // Public
166
167     get modifiers()
168     {
169         return this._modifiers;
170     },
171
172     get key()
173     {
174         return this._key;
175     },
176
177     get displayName()
178     {
179         var result = "";
180
181         if (this._modifiers & WebInspector.KeyboardShortcut.Modifier.Control)
182             result += "\u2303";
183         if (this._modifiers & WebInspector.KeyboardShortcut.Modifier.Option)
184             result += InspectorFrontendHost.platform() === "mac" ? "\u2325" : "\u2387";
185         if (this._modifiers & WebInspector.KeyboardShortcut.Modifier.Shift)
186             result += "\u21e7";
187         if (this._modifiers & WebInspector.KeyboardShortcut.Modifier.Command)
188             result += "\u2318";
189
190         result += this._key.toString();
191
192         return result;
193     },
194
195     get callback()
196     {
197         return this._callback;
198     },
199
200     get disabled()
201     {
202         return this._disabled;
203     },
204
205     set disabled(disabled)
206     {
207         this._disabled = disabled || false;
208     },
209
210     get implicitlyPreventsDefault()
211     {
212         return this._implicitlyPreventsDefault;
213     },
214
215     set implicitlyPreventsDefault(implicitly)
216     {
217         this._implicitlyPreventsDefault = implicitly;
218     },
219
220     unbind: function()
221     {
222         this._disabled = true;
223
224         if (!this._targetElement)
225             return;
226
227         var targetKeyboardShortcuts = this._targetElement._keyboardShortcuts;
228         if (!targetKeyboardShortcuts)
229             return;
230
231         targetKeyboardShortcuts.remove(this);
232     },
233
234     matchesEvent: function(event)
235     {
236         if (this._disabled)
237             return false;
238
239         if (this._key.keyCode !== event.keyCode)
240             return false;
241
242         var eventModifiers = WebInspector.KeyboardShortcut.Modifier.None;
243         if (event.shiftKey)
244             eventModifiers |= WebInspector.KeyboardShortcut.Modifier.Shift;
245         if (event.ctrlKey)
246             eventModifiers |= WebInspector.KeyboardShortcut.Modifier.Control;
247         if (event.altKey)
248             eventModifiers |= WebInspector.KeyboardShortcut.Modifier.Option;
249         if (event.metaKey)
250             eventModifiers |= WebInspector.KeyboardShortcut.Modifier.Command;
251         return this._modifiers === eventModifiers;
252     }
253 };
254
255 WebInspector.KeyboardShortcut.prototype.__proto__ = WebInspector.Object.prototype;