main.js

/*jslint asi: true, vars: true, plusplus: true, devel: true, nomen: true,  maxerr: 50 */
/*global define, $, brackets */

define(function (require, exports, module) {
    var CommandManager  = brackets.getModule("command/CommandManager"),
        Menus           = brackets.getModule("command/Menus"),
        EditorManager   = brackets.getModule("editor/EditorManager"),
        LiveDevelopmentUtils = brackets.getModule("LiveDevelopment/LiveDevelopmentUtils");
    
    var JavaScriptBuffer = require('./light-refactor.js/type-inference');
    
    var ModalBar = brackets.getModule('widgets/ModalBar').ModalBar;
    
    var lastFailedAttemptKey = ''; // A hash to determine if this is a repeated CTRL-R, and should jump to syntax error.
    
    function convertPos(pos) {
        return {line: pos.line, ch: pos.column}
    }
    
    CommandManager.register("Rename JavaScript Identifier", "javascript.renameIdentifier", function () {
        var editor = EditorManager.getFocusedEditor()
        if (editor === null)
            return
        var cm = editor._codeMirror
        
        var text = editor.document.getText()
        var pos = editor.indexFromPos(editor.getCursorPos())
        
        var filename = editor.document.file ? editor.document.file.name : "";
        var isHtml = LiveDevelopmentUtils.isStaticHtmlFileExt(filename)
        
        var jsb = new JavaScriptBuffer;
        try {
            jsb.add("main", text, {type: isHtml ? "html" : "js"})
        } catch (e) {
            var msg;
            if (e.lineNumber) {
                var failedAttemptKey = e.toString() + '~' + filename + '~' + pos
                if (failedAttemptKey === lastFailedAttemptKey) {
                    editor.setCursorPos(e.lineNumber-1, e.column, true);
                    msg = e.description;
                } else {
                    lastFailedAttemptKey = failedAttemptKey;
                    msg = 'syntax error (CTRL-R again to jump)';
                }
            } else {
                msg = e.toString()
            }
            editor.displayErrorMessageAtCursor('JS Rename: ' + msg)
            return;
        }
        lastFailedAttemptKey = '';
        
        var questions = jsb.renameTokenAt("main", pos) // TODO: run in background?
        if (!questions) {
            editor.displayErrorMessageAtCursor('JS Rename: place cursor in a name')
            return
        }
        
        var initialRange = questions[0][0];
        var oldName = text.substring(initialRange.start.offset, initialRange.end.offset)
        
        // We need to highlight groups of tokens. We use an array to keep track of the text markers we've inserted.
        var markers = []
        function setHighlighting(ranges) {
            cm.operation(function() {
                markers.forEach(function(x) { x.clear() }) // remove any existing markers
                markers.length = 0
                $(cm.getWrapperElement()).addClass("find-highlighting");
                for (var j=0; j<ranges.length; j++) {
                    var range = ranges[j]
                    var marker = editor._codeMirror.markText(convertPos(range.start), convertPos(range.end), {className:"CodeMirror-searching"})
                    markers.push(marker)
                }
            })
        }
        function clearHighlighting() {
            $(cm.getWrapperElement()).removeClass("find-highlighting");
            cm.operation(function() {
                markers.forEach(function(x) { x.clear() })
                markers.length = 0
            })
        }
        
        // Highlight token related to the selected token while asking for the new name
        setHighlighting(questions[0])
        // ModalBar args: html, autoclose, animate
        var nameBar = new ModalBar('New name: <input type="text" style="width: 14em" value="'+oldName+'"/>', true, false); 
        $("input[type='text']", nameBar.getRoot()).select();
        
        var selected = {0:true} // indices of selected renamings (auto-answer first question)
        
        var newName;
        var confirmBar = null;
        
        function handleCommit() {
            newName = $("input[type='text']", nameBar.getRoot()).val()
            nameBar = null
            askQuestion(1)
        }
        
        nameBar.getRoot().keydown(function (ev) {
            if (ev.keyCode === 13) { // enter
                ev.preventDefault()
                nameBar.close()
                handleCommit()
            }
        })
        nameBar.on("close", clearHighlighting)
        
        function askQuestion(i) {
            if (i === questions.length) {
                finishRenaming()
            } else {
                if (confirmBar === null) {
                    confirmBar = new ModalBar(
                          'Rename this token? ' +
                          '<button id="rename-yes" class="btn">Yes</button> ' +
                          '<button id="rename-no" class="btn">No</button> ' +
                          '<button class="btn">Abort</button>' +
                          '<div style="float: right; color:gray">' +
                            'Question <span id="rename-question-num">' + (i+1-1) + '</span> / ' + (questions.length-1) + ' ' +
                            '<button id="rename-yes-all" class="btn">Yes to Rest</button> ' +
                            '<button id="rename-no-all" class="btn">No to Rest</button> ' +
                          '</div>', 
                          false, false) // false=dont auto-close, false=dont animate
                    confirmBar.on("close", clearHighlighting);
                    confirmBar.getRoot().keydown(function (ev) {
                        if (ev.keyCode === 27) { // escape
                            ev.preventDefault()
                            confirmBar.close(false, false);
                        }
                    });
                    $("button", confirmBar.getRoot()).first().focus();
                }
                $("#rename-question-num").text(""+i);
                var token = questions[i][0]
                editor.setSelection(convertPos(token.start), convertPos(token.start), true) // true=center viewport on selection
                setHighlighting(questions[i])
                confirmBar.getRoot().off("click")
                confirmBar.getRoot().on("click", "button", function(e) {
                    switch (e.target.id) {
                        case 'rename-yes':
                            selected[i] = true
                            askQuestion(i+1)
                            break;
                        case 'rename-no':
                            selected[i] = false
                            askQuestion(i+1)
                            break;
                        case 'rename-yes-all':
                            for (var j=i; j<questions.length; j++) {
                                selected[j] = true;
                            }
                            finishRenaming();
                            break;
                        case 'rename-no-all':
                            finishRenaming();
                            break;
                        default:
                            clearUI();
                            break;
                    }
                })
            }
        }
        
        function clearUI() {
            clearHighlighting();
            if (nameBar) {
                nameBar.close(false, false)
                nameBar = null
            }
            if (confirmBar) {
                confirmBar.close(false, false)
                confirmBar = null
            }
        }
        
        function finishRenaming() {
            clearUI();
            // After renaming, zoom back to original position. We need to keep track of the exact
            // column offset in case it changes due to renaming
            var zoomCol = initialRange.start.column;
            var zoomLine = initialRange.start.line;
            var oldNameLength = initialRange.end.column - initialRange.start.column;
            var zoomScreen = questions.length > 1; // don't zoom if renaming was completely automatic
            
            // collect all ranges to update
            var ranges = []
            for (var i=0; i<questions.length; i++) {
                if (!selected[i])
                    continue
                for (var j=0; j<questions[i].length; j++) {
                    var range = questions[i][j]
                    ranges.push(range)
                    
                    // check if this renaming pushes the zoom offset
                    if (range.start.line === initialRange.start.line && range.start.column < initialRange.start.column) {
                        zoomCol += newName.length - oldNameLength;
                    }
                }
            }
            
            // sort ranges from back to front to avoid changing offset during replaceRange
            ranges.sort(function(x,y) { return y.start.offset - x.start.offset })
            
            // apply changes
            editor.document.batchOperation(function() {
                ranges.forEach(function (range) {
                    editor.document.replaceRange(newName, convertPos(range.start), convertPos(range.end))
                })
                // zoom back to original token and select it
                editor.setSelection({line:zoomLine, ch:zoomCol}, {line:zoomLine, ch:zoomCol+newName.length}, zoomScreen)
            })
        }
        
    });
    
    // Use Find menu if present (Sprint 39+), otherwise use Edit menu.
    var menuLocation = Menus.AppMenuBar.FIND_MENU || Menus.AppMenuBar.EDIT_MENU;
    var menuItemLocation = Menus.MenuSection.FIND_REPLACE_COMMANDS || Menus.MenuSection.EDIT_REPLACE_COMMANDS;
    
    var keys = [
        {key: "Ctrl-R", platform:"mac"}, // don't translate to Cmd-R on mac
        {key: "Ctrl-R", platform:"win"},
        {key: "Ctrl-R", platform:"linux"}
    ];
    
    Menus.getMenu(menuLocation).addMenuItem("javascript.renameIdentifier", keys, Menus.LAST_IN_SECTION, menuItemLocation);
});