This repository has been archived by the owner on Sep 6, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 7.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Capability to Support Document & Project Symbols provided by a Langua…
…ge Server (#14697) * Symbols Provider First Cut * Linting the Symbols Provider * Symbols Provider Second Cut * Document Symbol and Project Symbol support in Brackets * Minor Fixes * Removing Typo, and adding null checks * Addressing review comments * Handle menu toggling in case of language change * Remove active document check * Add unittests for QuickOpen Symbols Provider
- Loading branch information
Showing
10 changed files
with
566 additions
and
38 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
238 changes: 238 additions & 0 deletions
238
src/extensions/default/PhpTooling/PHPSymbolProviders.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,238 @@ | ||
| /* | ||
| * Copyright (c) 2019 - present Adobe. 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. | ||
| * | ||
| */ | ||
|
|
||
| /*jslint regexp: true */ | ||
|
|
||
| define(function (require, exports, module) { | ||
| "use strict"; | ||
|
|
||
| var EditorManager = brackets.getModule("editor/EditorManager"), | ||
| QuickOpen = brackets.getModule("search/QuickOpen"), | ||
| Commands = brackets.getModule("command/Commands"), | ||
| CommandManager = brackets.getModule("command/CommandManager"), | ||
| PathConverters = brackets.getModule("languageTools/PathConverters"); | ||
|
|
||
| var SymbolKind = QuickOpen.SymbolKind; | ||
|
|
||
| function convertRangePosToEditorPos(rangePos) { | ||
| return { | ||
| line: rangePos.line, | ||
| ch: rangePos.character | ||
| }; | ||
| } | ||
|
|
||
| function SymbolInformation(label, fullPath, selectionRange, type, scope, isDocumentSymbolRequest) { | ||
| this.label = label; | ||
| this.fullPath = fullPath; | ||
| this.selectionRange = selectionRange; | ||
| this.type = type; | ||
| this.scope = scope; | ||
| this.isDocumentSymbolRequest = isDocumentSymbolRequest; | ||
| } | ||
|
|
||
| function createList(list, isDocumentSymbolRequest) { | ||
| var newlist = []; | ||
| for (var i = 0; i < list.length; i++) { | ||
| var symbolInfo = list[i], | ||
| label = symbolInfo.name, | ||
| type = SymbolKind[symbolInfo.kind.toString()], | ||
| fullPath = null, | ||
| selectionRange = null, | ||
| scope = symbolInfo.containerName, | ||
| range = null; | ||
|
|
||
| if (!isDocumentSymbolRequest) { | ||
| fullPath = PathConverters.uriToPath(symbolInfo.location.uri); | ||
| } else { | ||
| if (symbolInfo.selectionRange) { | ||
| range = symbolInfo.selectionRange; | ||
| selectionRange = { | ||
| from: convertRangePosToEditorPos(range.start), | ||
| to: convertRangePosToEditorPos(range.end) | ||
| }; | ||
| } | ||
| } | ||
|
|
||
| if (!selectionRange) { | ||
| range = symbolInfo.location.range; | ||
| selectionRange = { | ||
| from: convertRangePosToEditorPos(range.start), | ||
| to: convertRangePosToEditorPos(range.end) | ||
| }; | ||
| } | ||
|
|
||
| newlist.push(new SymbolInformation(label, fullPath, selectionRange, type, scope, isDocumentSymbolRequest)); | ||
| } | ||
|
|
||
| return newlist; | ||
| } | ||
|
|
||
| function transFormToSymbolList(query, matcher, results, isDocumentSymbolRequest) { | ||
| var list = createList(results, isDocumentSymbolRequest); | ||
|
|
||
| // Filter and rank how good each match is | ||
| var filteredList = $.map(list, function (symbolInfo) { | ||
| var searchResult = matcher.match(symbolInfo.label, query); | ||
| if (searchResult) { | ||
| searchResult.symbolInfo = symbolInfo; | ||
| } | ||
| return searchResult; | ||
| }); | ||
|
|
||
| // Sort based on ranking & basic alphabetical order | ||
| QuickOpen.basicMatchSort(filteredList); | ||
|
|
||
| return filteredList; | ||
| } | ||
|
|
||
| /** | ||
| * Provider for Document Symbols | ||
| */ | ||
| function DocumentSymbolsProvider(client) { | ||
| this.client = client; | ||
| } | ||
|
|
||
| DocumentSymbolsProvider.prototype.match = function (query) { | ||
| return query.startsWith("@"); | ||
| }; | ||
|
|
||
| DocumentSymbolsProvider.prototype.search = function (query, matcher) { | ||
| if (!this.client) { | ||
| return $.Deferred().reject(); | ||
| } | ||
|
|
||
| var serverCapabilities = this.client.getServerCapabilities(); | ||
| if (!serverCapabilities || !serverCapabilities.documentSymbolProvider) { | ||
| return $.Deferred().reject(); | ||
| } | ||
|
|
||
| var editor = EditorManager.getActiveEditor(), | ||
| docPath = editor.document.file._path, | ||
| retval = $.Deferred(); | ||
| query = query.slice(1); | ||
|
|
||
| this.client.requestSymbolsForDocument({ | ||
| filePath: docPath | ||
| }).done(function (results) { | ||
| var resultList = transFormToSymbolList(query, matcher, results, true); | ||
| retval.resolve(resultList); | ||
| }); | ||
|
|
||
| return retval; | ||
| }; | ||
|
|
||
| DocumentSymbolsProvider.prototype.itemFocus = function (selectedItem, query, explicit) { | ||
| if (!selectedItem || (query.length < 2 && !explicit)) { | ||
| return; | ||
| } | ||
|
|
||
| var range = selectedItem.symbolInfo.selectionRange; | ||
| EditorManager.getCurrentFullEditor().setSelection(range.from, range.to, true); | ||
| }; | ||
|
|
||
| DocumentSymbolsProvider.prototype.itemSelect = function (selectedItem, query) { | ||
| this.itemFocus(selectedItem, query, true); | ||
| }; | ||
|
|
||
| DocumentSymbolsProvider.prototype.resultsFormatter = function (item, query) { | ||
| var displayName = QuickOpen.highlightMatch(item); | ||
| query = query.slice(1); | ||
|
|
||
| if (item.symbolInfo.scope) { | ||
| return "<li>" + displayName + " (" + item.symbolInfo.type + ")" + "<br /><span class='quick-open-path'>" + item.symbolInfo.scope + "</span></li>"; | ||
| } | ||
| return "<li>" + displayName + " (" + item.symbolInfo.type + ")" + "</li>"; | ||
| }; | ||
|
|
||
| /** | ||
| * Provider for Project Symbols | ||
| */ | ||
| function ProjectSymbolsProvider(client) { | ||
| this.client = client; | ||
| } | ||
|
|
||
| ProjectSymbolsProvider.prototype.match = function (query) { | ||
| return query.startsWith("#"); | ||
| }; | ||
|
|
||
| ProjectSymbolsProvider.prototype.search = function (query, matcher) { | ||
| if (!this.client) { | ||
| return $.Deferred().reject(); | ||
| } | ||
|
|
||
| var serverCapabilities = this.client.getServerCapabilities(); | ||
| if (!serverCapabilities || !serverCapabilities.workspaceSymbolProvider) { | ||
| return $.Deferred().reject(); | ||
| } | ||
|
|
||
| var retval = $.Deferred(); | ||
| query = query.slice(1); | ||
|
|
||
| this.client.requestSymbolsForWorkspace({ | ||
| query: query | ||
| }).done(function (results) { | ||
| var resultList = transFormToSymbolList(query, matcher, results); | ||
| retval.resolve(resultList); | ||
| }); | ||
|
|
||
| return retval; | ||
| }; | ||
|
|
||
| ProjectSymbolsProvider.prototype.itemFocus = function (selectedItem, query, explicit) { | ||
| if (!selectedItem || (query.length < 2 && !explicit)) { | ||
| return; | ||
| } | ||
| }; | ||
|
|
||
| ProjectSymbolsProvider.prototype.itemSelect = function (selectedItem, query) { | ||
| var fullPath = selectedItem.symbolInfo.fullPath, | ||
| range = selectedItem.symbolInfo.selectionRange; | ||
|
|
||
| if (fullPath) { | ||
| CommandManager.execute(Commands.CMD_ADD_TO_WORKINGSET_AND_OPEN, { | ||
| fullPath: fullPath | ||
| }) | ||
| .done(function () { | ||
| if (range.from) { | ||
| var editor = EditorManager.getCurrentFullEditor(); | ||
| editor.setCursorPos(range.from.line, range.from.ch, true); | ||
| } | ||
| }); | ||
| } | ||
| }; | ||
|
|
||
| ProjectSymbolsProvider.prototype.resultsFormatter = function (item, query) { | ||
| var displayName = QuickOpen.highlightMatch(item); | ||
| query = query.slice(1); | ||
|
|
||
| if (item.symbolInfo.scope) { | ||
| return "<li>" + displayName + " (" + item.symbolInfo.type + ")" + "<br /><span class='quick-open-path'>" + item.symbolInfo.scope + "</span><br /><br /><span class='quick-open-path'>" + item.symbolInfo.fullPath + "</span></li>"; | ||
| } | ||
| return "<li>" + displayName + " (" + item.symbolInfo.type + ")" + "<br /><br /><span class='quick-open-path'>" + item.symbolInfo.fullPath + "</span></li>"; | ||
| }; | ||
|
|
||
| exports.SymbolProviders = { | ||
| DocumentSymbolsProvider: DocumentSymbolsProvider, | ||
| ProjectSymbolsProvider: ProjectSymbolsProvider | ||
| }; | ||
| }); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
13 changes: 13 additions & 0 deletions
13
src/extensions/default/PhpTooling/unittest-files/test/test4.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| <?php | ||
|
|
||
| class MyClass{ | ||
| public static $staticValue = 'static'; | ||
| const constantValue = 'const'; | ||
| public $publicValue = 'public'; | ||
| public static function staticMethod(){} | ||
| public function publicFunction(){} | ||
| } | ||
|
|
||
| $myclass = new MyClass(); | ||
|
|
||
| ?> |
Oops, something went wrong.