diff --git a/src/command/Commands.js b/src/command/Commands.js index 896af77e8a1..a9476113590 100644 --- a/src/command/Commands.js +++ b/src/command/Commands.js @@ -58,6 +58,7 @@ define(function (require, exports, module) { exports.EDIT_SELECT_LINE = "edit.selectLine"; exports.EDIT_FIND = "edit.find"; exports.EDIT_FIND_IN_FILES = "edit.findInFiles"; + exports.EDIT_FIND_IN_SUBTREE = "edit.findInSubtree"; exports.EDIT_FIND_NEXT = "edit.findNext"; exports.EDIT_FIND_PREVIOUS = "edit.findPrevious"; exports.EDIT_REPLACE = "edit.replace"; diff --git a/src/command/Menus.js b/src/command/Menus.js index 1153862eab8..ebedf774ec1 100644 --- a/src/command/Menus.js +++ b/src/command/Menus.js @@ -993,6 +993,8 @@ define(function (require, exports, module) { project_cmenu.addMenuItem(Commands.FILE_NEW); project_cmenu.addMenuItem(Commands.FILE_NEW_FOLDER); project_cmenu.addMenuItem(Commands.FILE_RENAME, "F2"); + project_cmenu.addMenuDivider(); + project_cmenu.addMenuItem(Commands.EDIT_FIND_IN_SUBTREE); var working_set_cmenu = registerContextMenu(ContextMenuIds.WORKING_SET_MENU); working_set_cmenu.addMenuItem(Commands.FILE_CLOSE); @@ -1000,6 +1002,8 @@ define(function (require, exports, module) { working_set_cmenu.addMenuItem(Commands.FILE_RENAME); working_set_cmenu.addMenuItem(Commands.NAVIGATE_SHOW_IN_FILE_TREE); working_set_cmenu.addMenuDivider(); + working_set_cmenu.addMenuItem(Commands.EDIT_FIND_IN_SUBTREE); + working_set_cmenu.addMenuDivider(); working_set_cmenu.addMenuItem(Commands.SORT_WORKINGSET_BY_ADDED); working_set_cmenu.addMenuItem(Commands.SORT_WORKINGSET_BY_NAME); working_set_cmenu.addMenuItem(Commands.SORT_WORKINGSET_BY_TYPE); diff --git a/src/nls/root/strings.js b/src/nls/root/strings.js index 19f6c918984..51b4f34de82 100644 --- a/src/nls/root/strings.js +++ b/src/nls/root/strings.js @@ -107,14 +107,16 @@ define({ "NO_UPDATE_TITLE" : "You're up to date!", "NO_UPDATE_MESSAGE" : "You are running the latest version of {APP_NAME}.", - "FIND_IN_FILES_TITLE" : "for \"{4}\" - {0} {1} in {2} {3}", + "FIND_IN_FILES_TITLE" : "for \"{4}\" {5} - {0} {1} in {2} {3}", + "FIND_IN_FILES_SCOPED" : "in {0}", + "FIND_IN_FILES_NO_SCOPE" : "in project", "FIND_IN_FILES_FILE" : "file", "FIND_IN_FILES_FILES" : "files", "FIND_IN_FILES_MATCH" : "match", "FIND_IN_FILES_MATCHES" : "matches", "FIND_IN_FILES_MORE_THAN" : "More than ", "FIND_IN_FILES_MAX" : " (showing the first {0} matches)", - "FIND_IN_FILES_FILE_PATH" : "File: {0}", + "FIND_IN_FILES_FILE_PATH" : "File: {0}", "FIND_IN_FILES_LINE" : "line: {0}", "ERROR_FETCHING_UPDATE_INFO_TITLE" : "Error getting update info", @@ -178,6 +180,7 @@ define({ "CMD_SELECT_LINE" : "Select Line", "CMD_FIND" : "Find", "CMD_FIND_IN_FILES" : "Find in Files", + "CMD_FIND_IN_SUBTREE" : "Find in...", "CMD_FIND_NEXT" : "Find Next", "CMD_FIND_PREVIOUS" : "Find Previous", "CMD_REPLACE" : "Replace", diff --git a/src/project/ProjectManager.js b/src/project/ProjectManager.js index 9369680e6dd..075b67b338e 100644 --- a/src/project/ProjectManager.js +++ b/src/project/ProjectManager.js @@ -269,6 +269,8 @@ define(function (require, exports, module) { * If absPath lies within the project, returns a project-relative path. Else returns absPath * unmodified. * Does not support paths containing ".." + * @param {!string} absPath + * @return {!string} */ function makeProjectRelativeIfPossible(absPath) { if (isWithinProject(absPath)) { diff --git a/src/search/FindInFiles.js b/src/search/FindInFiles.js index 00ea72bef8f..64edeff1f86 100644 --- a/src/search/FindInFiles.js +++ b/src/search/FindInFiles.js @@ -47,6 +47,7 @@ define(function (require, exports, module) { Commands = require("command/Commands"), Strings = require("strings"), StringUtils = require("utils/StringUtils"), + ProjectManager = require("project/ProjectManager"), DocumentManager = require("document/DocumentManager"), EditorManager = require("editor/EditorManager"), FileIndexManager = require("project/FileIndexManager"), @@ -86,6 +87,21 @@ define(function (require, exports, module) { return new RegExp(query, "gi"); } + /** + * Returns label text to indicate the search scope. Already HTML-escaped. + * @param {?Entry} scope + */ + function _labelForScope(scope) { + var projName = ProjectManager.getProjectRoot().name; + if (scope) { + var displayPath = StringUtils.htmlEscape(ProjectManager.makeProjectRelativeIfPossible(scope.fullPath)); + return StringUtils.format(Strings.FIND_IN_FILES_SCOPED, displayPath); + } else { + return Strings.FIND_IN_FILES_NO_SCOPE; + } + } + + // This dialog class was mostly copied from QuickOpen. We should have a common dialog // class that everyone can use. @@ -126,12 +142,14 @@ define(function (require, exports, module) { /** * Shows the search dialog * @param {?string} initialString Default text to prepopulate the search field with + * @param {?Entry} scope Search scope, or null to search whole proj * @returns {$.Promise} that is resolved with the string to search for */ - FindInFilesDialog.prototype.showDialog = function (initialString) { - var dialogHTML = Strings.CMD_FIND_IN_FILES + - ": (" + - Strings.SEARCH_REGEXP_INFO + ")"; + FindInFilesDialog.prototype.showDialog = function (initialString, scope) { + // Note the prefix label is a simple "Find:" - the "in ..." part comes after the text field + var dialogHTML = Strings.CMD_FIND + + ":  " + + "(" + Strings.SEARCH_REGEXP_INFO + ")"; this.result = new $.Deferred(); this._createDialogDiv(dialogHTML); var $searchField = $("input#findInFilesInput"); @@ -140,6 +158,8 @@ define(function (require, exports, module) { $searchField.attr("value", initialString || ""); $searchField.get(0).select(); + $("#findInFilesScope").html(_labelForScope(scope)); + $searchField.bind("keydown", function (event) { if (event.keyCode === KeyEvent.DOM_VK_RETURN || event.keyCode === KeyEvent.DOM_VK_ESCAPE) { // Enter/Return key or Esc key event.stopPropagation(); @@ -209,7 +229,7 @@ define(function (require, exports, module) { return matches; } - function _showSearchResults(searchResults, query) { + function _showSearchResults(searchResults, query, scope) { var $searchResultsDiv = $("#search-results"); if (searchResults && searchResults.length) { @@ -229,17 +249,19 @@ define(function (require, exports, module) { } numMatchesStr += String(numMatches); + // This text contains some formatting, so all the strings are assumed to be already escaped var summary = StringUtils.format( Strings.FIND_IN_FILES_TITLE, numMatchesStr, (numMatches > 1) ? Strings.FIND_IN_FILES_MATCHES : Strings.FIND_IN_FILES_MATCH, searchResults.length, (searchResults.length > 1 ? Strings.FIND_IN_FILES_FILES : Strings.FIND_IN_FILES_FILE), - query + query, + scope ? _labelForScope(scope) : "" ); $("#search-result-summary") - .text(summary + + .html(summary + (numMatches > FIND_IN_FILES_MAX ? StringUtils.format(Strings.FIND_IN_FILES_MAX, FIND_IN_FILES_MAX) : "")) .prepend(" "); // putting a normal space before the "-" is not enough @@ -251,11 +273,8 @@ define(function (require, exports, module) { return $("").html(content); }; - var esc = function (str) { - str = str.replace(//g, ">"); - return str; - }; + // shorthand function name + var esc = StringUtils.htmlEscape; var highlightMatch = function (line, start, end) { return esc(line.substr(0, start)) + "" + esc(line.substring(start, end)) + "" + esc(line.substr(end)); @@ -263,7 +282,7 @@ define(function (require, exports, module) { // Add row for file name $("") - .append("" + StringUtils.format(Strings.FIND_IN_FILES_FILE_PATH, StringUtils.breakableUrl(item.fullPath)) + "") + .append("" + StringUtils.format(Strings.FIND_IN_FILES_FILE_PATH, StringUtils.breakableUrl(esc(item.fullPath))) + "") .click(function () { // Clicking file section header collapses/expands result rows for that file var $fileHeader = $(this); @@ -313,11 +332,30 @@ define(function (require, exports, module) { EditorManager.resizeEditor(); } + /** + * @param {!FileInfo} fileInfo File in question + * @param {?Entry} scope Search scope, or null if whole project + * @return {boolean} + */ + function inScope(fileInfo, scope) { + if (scope) { + if (scope.isDirectory) { + // Dirs always have trailing slash, so we don't have to worry about being + // a substring of another dir name + return fileInfo.fullPath.indexOf(scope.fullPath) === 0; + } else { + return fileInfo.fullPath === scope.fullPath; + } + } + return true; + } + /** * Displays a non-modal embedded dialog above the code mirror editor that allows the user to do * a find operation across all files in the project. + * @param {?Entry} scope Project file/subfolder to search within; else searches whole project. */ - function doFindInFiles() { + function doFindInFiles(scope) { var dialog = new FindInFilesDialog(); @@ -328,7 +366,7 @@ define(function (require, exports, module) { searchResults = []; maxHitsFoundInFile = false; - dialog.showDialog(initialString) + dialog.showDialog(initialString, scope) .done(function (query) { if (query) { var queryExpr = _getQueryRegExp(query); @@ -341,28 +379,33 @@ define(function (require, exports, module) { Async.doInParallel(fileListResult, function (fileInfo) { var result = new $.Deferred(); - DocumentManager.getDocumentForPath(fileInfo.fullPath) - .done(function (doc) { - var matches = _getSearchMatches(doc.getText(), queryExpr); - - if (matches && matches.length) { - searchResults.push({ - fullPath: fileInfo.fullPath, - matches: matches - }); - } - result.resolve(); - }) - .fail(function (error) { - // Error reading this file. This is most likely because the file isn't a text file. - // Resolve here so we move on to the next file. - result.resolve(); - }); - + if (!inScope(fileInfo, scope)) { + result.resolve(); + } else { + // Search one file + DocumentManager.getDocumentForPath(fileInfo.fullPath) + .done(function (doc) { + var matches = _getSearchMatches(doc.getText(), queryExpr); + + if (matches && matches.length) { + searchResults.push({ + fullPath: fileInfo.fullPath, + matches: matches + }); + } + result.resolve(); + }) + .fail(function (error) { + // Error reading this file. This is most likely because the file isn't a text file. + // Resolve here so we move on to the next file. + result.resolve(); + }); + } return result.promise(); }) .done(function () { - _showSearchResults(searchResults, query); + // Done searching all files: show results + _showSearchResults(searchResults, query, scope); StatusBar.hideBusyIndicator(); }) .fail(function () { @@ -374,11 +417,23 @@ define(function (require, exports, module) { }); } + /** Search within the file/subtree defined by the sidebar selection */ + function doFindInSubtree() { + // Prefer project tree selection, else use working set selection + var selectedEntry = ProjectManager.getSelectedItem(); + if (!selectedEntry) { + var doc = DocumentManager.getCurrentDocument(); + selectedEntry = (doc && doc.file); + } + + doFindInFiles(selectedEntry); + } + + // Initialize items dependent on HTML DOM AppInit.htmlReady(function () { var $searchResults = $("#search-results"), $searchContent = $("#search-results .table-container"); - }); function _fileNameChangeHandler(event, oldName, newName) { @@ -392,5 +447,7 @@ define(function (require, exports, module) { } $(DocumentManager).on("fileNameChange", _fileNameChangeHandler); - CommandManager.register(Strings.CMD_FIND_IN_FILES, Commands.EDIT_FIND_IN_FILES, doFindInFiles); + + CommandManager.register(Strings.CMD_FIND_IN_FILES, Commands.EDIT_FIND_IN_FILES, doFindInFiles); + CommandManager.register(Strings.CMD_FIND_IN_SUBTREE, Commands.EDIT_FIND_IN_SUBTREE, doFindInSubtree); });