summaryrefslogtreecommitdiff
path: root/Source/WebInspectorUI/UserInterface/Controllers/CodeMirrorTextKillController.js
blob: 8cd0b73002ca36c5183fe95d6b0fb0f68cba41b5 (plain)
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
/*
 * Copyright (C) 2015 Apple Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 * THE POSSIBILITY OF SUCH DAMAGE.
 */

WebInspector.CodeMirrorTextKillController = class CodeMirrorTextKillController extends WebInspector.Object
{
    constructor(codeMirror)
    {
        super();

        console.assert(codeMirror);

        this._codeMirror = codeMirror;
        this._expectingChangeEventForKill = false;
        this._nextKillStartsNewSequence = true;
        this._shouldPrependToKillRing = false;

        this._handleTextChangeListener = this._handleTextChange.bind(this);
        this._handleEditorBlurListener = this._handleEditorBlur.bind(this);
        this._handleSelectionOrCaretChangeListener = this._handleSelectionOrCaretChange.bind(this);

        // FIXME: these keybindings match CodeMirror's default keymap for OS X.
        // They should probably be altered for Windows / Linux someday.
        this._codeMirror.addKeyMap({
            // Overrides for the 'emacsy' keymap.
            "Ctrl-K": this._handleTextKillCommand.bind(this, "killLine", false),
            "Alt-D": this._handleTextKillCommand.bind(this, "delWordAfter", false),
            // Overrides for the 'macDefault' keymap.
            "Alt-Delete": this._handleTextKillCommand.bind(this, "delGroupAfter", false),
            "Cmd-Backspace": this._handleTextKillCommand.bind(this, "delWrappedLineLeft", true),
            "Cmd-Delete": this._handleTextKillCommand.bind(this, "delWrappedLineRight", false),
            "Alt-Backspace": this._handleTextKillCommand.bind(this, "delGroupBefore", true),
            "Ctrl-Alt-Backspace": this._handleTextKillCommand.bind(this, "delGroupAfter", false),
        });
    }

    _handleTextKillCommand(command, prependsToKillRing, codeMirror)
    {
        // Read-only mode is dynamic in some editors, so check every time
        // and ignore the shortcut if in read-only mode.
        if (this._codeMirror.getOption("readOnly"))
            return;

        this._shouldPrependToKillRing = prependsToKillRing;

        // Don't add the listener if it's still registered because
        // a previous empty kill didn't generate change events.
        if (!this._expectingChangeEventForKill)
            this._codeMirror.on("changes", this._handleTextChangeListener);

        this._expectingChangeEventForKill = true;
        this._codeMirror.execCommand(command);
    }

    _handleTextChange(codeMirror, changes)
    {
        this._codeMirror.off("changes", this._handleTextChangeListener);

        // Sometimes a second change event fires after removing the listener
        // if you perform an "empty kill" and type after moving the caret.
        if (!this._expectingChangeEventForKill)
            return;

        this._expectingChangeEventForKill = false;

        // It doesn't make sense to get more than one change per kill.
        console.assert(changes.length === 1);
        let change = changes[0];

        // If an "empty kill" is followed by up/down or typing,
        // the empty kill won't fire a change event, then we'll get an
        // unrelated change event that shouldn't be treated as a kill.
        if (change.origin !== "+delete")
            return;

        // When killed text includes a newline, CodeMirror returns
        // strange change objects. Special-case for when this could happen.
        let killedText;
        if (change.to.line === change.from.line + 1 && change.removed.length === 2) {
            // An entire line was deleted, including newline (deleteLine).
            if (change.removed[0].length && !change.removed[1].length)
                killedText = change.removed[0] + "\n";
            // A newline was killed by itself (Ctrl-K).
            else
                killedText = "\n";
        } else {
            console.assert(change.removed.length === 1);
            killedText = change.removed[0];
        }

        InspectorFrontendHost.killText(killedText, this._shouldPrependToKillRing, this._nextKillStartsNewSequence);

        // If the editor loses focus or the caret / selection changes
        // (not as a result of the kill), then the next kill should
        // start a new kill ring sequence.
        this._nextKillStartsNewSequence = false;
        this._codeMirror.on("blur", this._handleEditorBlurListener);
        this._codeMirror.on("cursorActivity", this._handleSelectionOrCaretChangeListener);
    }

    _handleEditorBlur(codeMirror)
    {
        this._nextKillStartsNewSequence = true;
        this._codeMirror.off("blur", this._handleEditorBlurListener);
        this._codeMirror.off("cursorActivity", this._handleSelectionOrCaretChangeListener);
    }

    _handleSelectionOrCaretChange(codeMirror)
    {
        if (this._expectingChangeEventForKill)
            return;

        this._nextKillStartsNewSequence = true;
        this._codeMirror.off("blur", this._handleEditorBlurListener);
        this._codeMirror.off("cursorActivity", this._handleSelectionOrCaretChangeListener);
    }
};