rename.js 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353
  1. /*---------------------------------------------------------------------------------------------
  2. * Copyright (c) Microsoft Corporation. All rights reserved.
  3. * Licensed under the MIT License. See License.txt in the project root for license information.
  4. *--------------------------------------------------------------------------------------------*/
  5. var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
  6. var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
  7. if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
  8. else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
  9. return c > 3 && r && Object.defineProperty(target, key, r), r;
  10. };
  11. var __param = (this && this.__param) || function (paramIndex, decorator) {
  12. return function (target, key) { decorator(target, key, paramIndex); }
  13. };
  14. var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
  15. function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
  16. return new (P || (P = Promise))(function (resolve, reject) {
  17. function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
  18. function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
  19. function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
  20. step((generator = generator.apply(thisArg, _arguments || [])).next());
  21. });
  22. };
  23. import { alert } from '../../../base/browser/ui/aria/aria.js';
  24. import { IdleValue, raceCancellation } from '../../../base/common/async.js';
  25. import { CancellationToken, CancellationTokenSource } from '../../../base/common/cancellation.js';
  26. import { onUnexpectedError } from '../../../base/common/errors.js';
  27. import { DisposableStore } from '../../../base/common/lifecycle.js';
  28. import { assertType } from '../../../base/common/types.js';
  29. import { URI } from '../../../base/common/uri.js';
  30. import { EditorStateCancellationTokenSource } from '../../browser/core/editorState.js';
  31. import { EditorAction, EditorCommand, registerEditorAction, registerEditorCommand, registerEditorContribution, registerModelAndPositionCommand } from '../../browser/editorExtensions.js';
  32. import { IBulkEditService, ResourceEdit } from '../../browser/services/bulkEditService.js';
  33. import { ICodeEditorService } from '../../browser/services/codeEditorService.js';
  34. import { Position } from '../../common/core/position.js';
  35. import { Range } from '../../common/core/range.js';
  36. import { EditorContextKeys } from '../../common/editorContextKeys.js';
  37. import { RenameProviderRegistry } from '../../common/modes.js';
  38. import { ITextResourceConfigurationService } from '../../common/services/textResourceConfigurationService.js';
  39. import { MessageController } from '../message/messageController.js';
  40. import * as nls from '../../../nls.js';
  41. import { Extensions } from '../../../platform/configuration/common/configurationRegistry.js';
  42. import { ContextKeyExpr } from '../../../platform/contextkey/common/contextkey.js';
  43. import { IInstantiationService } from '../../../platform/instantiation/common/instantiation.js';
  44. import { ILogService } from '../../../platform/log/common/log.js';
  45. import { INotificationService } from '../../../platform/notification/common/notification.js';
  46. import { IEditorProgressService } from '../../../platform/progress/common/progress.js';
  47. import { Registry } from '../../../platform/registry/common/platform.js';
  48. import { CONTEXT_RENAME_INPUT_VISIBLE, RenameInputField } from './renameInputField.js';
  49. class RenameSkeleton {
  50. constructor(model, position) {
  51. this.model = model;
  52. this.position = position;
  53. this._providerRenameIdx = 0;
  54. this._providers = RenameProviderRegistry.ordered(model);
  55. }
  56. hasProvider() {
  57. return this._providers.length > 0;
  58. }
  59. resolveRenameLocation(token) {
  60. return __awaiter(this, void 0, void 0, function* () {
  61. const rejects = [];
  62. for (this._providerRenameIdx = 0; this._providerRenameIdx < this._providers.length; this._providerRenameIdx++) {
  63. const provider = this._providers[this._providerRenameIdx];
  64. if (!provider.resolveRenameLocation) {
  65. break;
  66. }
  67. let res = yield provider.resolveRenameLocation(this.model, this.position, token);
  68. if (!res) {
  69. continue;
  70. }
  71. if (res.rejectReason) {
  72. rejects.push(res.rejectReason);
  73. continue;
  74. }
  75. return res;
  76. }
  77. const word = this.model.getWordAtPosition(this.position);
  78. if (!word) {
  79. return {
  80. range: Range.fromPositions(this.position),
  81. text: '',
  82. rejectReason: rejects.length > 0 ? rejects.join('\n') : undefined
  83. };
  84. }
  85. return {
  86. range: new Range(this.position.lineNumber, word.startColumn, this.position.lineNumber, word.endColumn),
  87. text: word.word,
  88. rejectReason: rejects.length > 0 ? rejects.join('\n') : undefined
  89. };
  90. });
  91. }
  92. provideRenameEdits(newName, token) {
  93. return __awaiter(this, void 0, void 0, function* () {
  94. return this._provideRenameEdits(newName, this._providerRenameIdx, [], token);
  95. });
  96. }
  97. _provideRenameEdits(newName, i, rejects, token) {
  98. return __awaiter(this, void 0, void 0, function* () {
  99. const provider = this._providers[i];
  100. if (!provider) {
  101. return {
  102. edits: [],
  103. rejectReason: rejects.join('\n')
  104. };
  105. }
  106. const result = yield provider.provideRenameEdits(this.model, this.position, newName, token);
  107. if (!result) {
  108. return this._provideRenameEdits(newName, i + 1, rejects.concat(nls.localize('no result', "No result.")), token);
  109. }
  110. else if (result.rejectReason) {
  111. return this._provideRenameEdits(newName, i + 1, rejects.concat(result.rejectReason), token);
  112. }
  113. return result;
  114. });
  115. }
  116. }
  117. export function rename(model, position, newName) {
  118. return __awaiter(this, void 0, void 0, function* () {
  119. const skeleton = new RenameSkeleton(model, position);
  120. const loc = yield skeleton.resolveRenameLocation(CancellationToken.None);
  121. if (loc === null || loc === void 0 ? void 0 : loc.rejectReason) {
  122. return { edits: [], rejectReason: loc.rejectReason };
  123. }
  124. return skeleton.provideRenameEdits(newName, CancellationToken.None);
  125. });
  126. }
  127. // --- register actions and commands
  128. let RenameController = class RenameController {
  129. constructor(editor, _instaService, _notificationService, _bulkEditService, _progressService, _logService, _configService) {
  130. this.editor = editor;
  131. this._instaService = _instaService;
  132. this._notificationService = _notificationService;
  133. this._bulkEditService = _bulkEditService;
  134. this._progressService = _progressService;
  135. this._logService = _logService;
  136. this._configService = _configService;
  137. this._dispoableStore = new DisposableStore();
  138. this._cts = new CancellationTokenSource();
  139. this._renameInputField = this._dispoableStore.add(new IdleValue(() => this._dispoableStore.add(this._instaService.createInstance(RenameInputField, this.editor, ['acceptRenameInput', 'acceptRenameInputWithPreview']))));
  140. }
  141. static get(editor) {
  142. return editor.getContribution(RenameController.ID);
  143. }
  144. dispose() {
  145. this._dispoableStore.dispose();
  146. this._cts.dispose(true);
  147. }
  148. run() {
  149. return __awaiter(this, void 0, void 0, function* () {
  150. this._cts.dispose(true);
  151. if (!this.editor.hasModel()) {
  152. return undefined;
  153. }
  154. const position = this.editor.getPosition();
  155. const skeleton = new RenameSkeleton(this.editor.getModel(), position);
  156. if (!skeleton.hasProvider()) {
  157. return undefined;
  158. }
  159. this._cts = new EditorStateCancellationTokenSource(this.editor, 4 /* Position */ | 1 /* Value */);
  160. // resolve rename location
  161. let loc;
  162. try {
  163. const resolveLocationOperation = skeleton.resolveRenameLocation(this._cts.token);
  164. this._progressService.showWhile(resolveLocationOperation, 250);
  165. loc = yield resolveLocationOperation;
  166. }
  167. catch (e) {
  168. MessageController.get(this.editor).showMessage(e || nls.localize('resolveRenameLocationFailed', "An unknown error occurred while resolving rename location"), position);
  169. return undefined;
  170. }
  171. if (!loc) {
  172. return undefined;
  173. }
  174. if (loc.rejectReason) {
  175. MessageController.get(this.editor).showMessage(loc.rejectReason, position);
  176. return undefined;
  177. }
  178. if (this._cts.token.isCancellationRequested) {
  179. return undefined;
  180. }
  181. this._cts.dispose();
  182. this._cts = new EditorStateCancellationTokenSource(this.editor, 4 /* Position */ | 1 /* Value */, loc.range);
  183. // do rename at location
  184. let selection = this.editor.getSelection();
  185. let selectionStart = 0;
  186. let selectionEnd = loc.text.length;
  187. if (!Range.isEmpty(selection) && !Range.spansMultipleLines(selection) && Range.containsRange(loc.range, selection)) {
  188. selectionStart = Math.max(0, selection.startColumn - loc.range.startColumn);
  189. selectionEnd = Math.min(loc.range.endColumn, selection.endColumn) - loc.range.startColumn;
  190. }
  191. const supportPreview = this._bulkEditService.hasPreviewHandler() && this._configService.getValue(this.editor.getModel().uri, 'editor.rename.enablePreview');
  192. const inputFieldResult = yield this._renameInputField.value.getInput(loc.range, loc.text, selectionStart, selectionEnd, supportPreview, this._cts.token);
  193. // no result, only hint to focus the editor or not
  194. if (typeof inputFieldResult === 'boolean') {
  195. if (inputFieldResult) {
  196. this.editor.focus();
  197. }
  198. return undefined;
  199. }
  200. this.editor.focus();
  201. const renameOperation = raceCancellation(skeleton.provideRenameEdits(inputFieldResult.newName, this._cts.token), this._cts.token).then((renameResult) => __awaiter(this, void 0, void 0, function* () {
  202. if (!renameResult || !this.editor.hasModel()) {
  203. return;
  204. }
  205. if (renameResult.rejectReason) {
  206. this._notificationService.info(renameResult.rejectReason);
  207. return;
  208. }
  209. // collapse selection to active end
  210. this.editor.setSelection(Range.fromPositions(this.editor.getSelection().getPosition()));
  211. this._bulkEditService.apply(ResourceEdit.convert(renameResult), {
  212. editor: this.editor,
  213. showPreview: inputFieldResult.wantsPreview,
  214. label: nls.localize('label', "Renaming '{0}'", loc === null || loc === void 0 ? void 0 : loc.text),
  215. quotableLabel: nls.localize('quotableLabel', "Renaming {0}", loc === null || loc === void 0 ? void 0 : loc.text),
  216. }).then(result => {
  217. if (result.ariaSummary) {
  218. alert(nls.localize('aria', "Successfully renamed '{0}' to '{1}'. Summary: {2}", loc.text, inputFieldResult.newName, result.ariaSummary));
  219. }
  220. }).catch(err => {
  221. this._notificationService.error(nls.localize('rename.failedApply', "Rename failed to apply edits"));
  222. this._logService.error(err);
  223. });
  224. }), err => {
  225. this._notificationService.error(nls.localize('rename.failed', "Rename failed to compute edits"));
  226. this._logService.error(err);
  227. });
  228. this._progressService.showWhile(renameOperation, 250);
  229. return renameOperation;
  230. });
  231. }
  232. acceptRenameInput(wantsPreview) {
  233. this._renameInputField.value.acceptInput(wantsPreview);
  234. }
  235. cancelRenameInput() {
  236. this._renameInputField.value.cancelInput(true);
  237. }
  238. };
  239. RenameController.ID = 'editor.contrib.renameController';
  240. RenameController = __decorate([
  241. __param(1, IInstantiationService),
  242. __param(2, INotificationService),
  243. __param(3, IBulkEditService),
  244. __param(4, IEditorProgressService),
  245. __param(5, ILogService),
  246. __param(6, ITextResourceConfigurationService)
  247. ], RenameController);
  248. // ---- action implementation
  249. export class RenameAction extends EditorAction {
  250. constructor() {
  251. super({
  252. id: 'editor.action.rename',
  253. label: nls.localize('rename.label', "Rename Symbol"),
  254. alias: 'Rename Symbol',
  255. precondition: ContextKeyExpr.and(EditorContextKeys.writable, EditorContextKeys.hasRenameProvider),
  256. kbOpts: {
  257. kbExpr: EditorContextKeys.editorTextFocus,
  258. primary: 60 /* F2 */,
  259. weight: 100 /* EditorContrib */
  260. },
  261. contextMenuOpts: {
  262. group: '1_modification',
  263. order: 1.1
  264. }
  265. });
  266. }
  267. runCommand(accessor, args) {
  268. const editorService = accessor.get(ICodeEditorService);
  269. const [uri, pos] = Array.isArray(args) && args || [undefined, undefined];
  270. if (URI.isUri(uri) && Position.isIPosition(pos)) {
  271. return editorService.openCodeEditor({ resource: uri }, editorService.getActiveCodeEditor()).then(editor => {
  272. if (!editor) {
  273. return;
  274. }
  275. editor.setPosition(pos);
  276. editor.invokeWithinContext(accessor => {
  277. this.reportTelemetry(accessor, editor);
  278. return this.run(accessor, editor);
  279. });
  280. }, onUnexpectedError);
  281. }
  282. return super.runCommand(accessor, args);
  283. }
  284. run(accessor, editor) {
  285. const controller = RenameController.get(editor);
  286. if (controller) {
  287. return controller.run();
  288. }
  289. return Promise.resolve();
  290. }
  291. }
  292. registerEditorContribution(RenameController.ID, RenameController);
  293. registerEditorAction(RenameAction);
  294. const RenameCommand = EditorCommand.bindToContribution(RenameController.get);
  295. registerEditorCommand(new RenameCommand({
  296. id: 'acceptRenameInput',
  297. precondition: CONTEXT_RENAME_INPUT_VISIBLE,
  298. handler: x => x.acceptRenameInput(false),
  299. kbOpts: {
  300. weight: 100 /* EditorContrib */ + 99,
  301. kbExpr: EditorContextKeys.focus,
  302. primary: 3 /* Enter */
  303. }
  304. }));
  305. registerEditorCommand(new RenameCommand({
  306. id: 'acceptRenameInputWithPreview',
  307. precondition: ContextKeyExpr.and(CONTEXT_RENAME_INPUT_VISIBLE, ContextKeyExpr.has('config.editor.rename.enablePreview')),
  308. handler: x => x.acceptRenameInput(true),
  309. kbOpts: {
  310. weight: 100 /* EditorContrib */ + 99,
  311. kbExpr: EditorContextKeys.focus,
  312. primary: 1024 /* Shift */ + 3 /* Enter */
  313. }
  314. }));
  315. registerEditorCommand(new RenameCommand({
  316. id: 'cancelRenameInput',
  317. precondition: CONTEXT_RENAME_INPUT_VISIBLE,
  318. handler: x => x.cancelRenameInput(),
  319. kbOpts: {
  320. weight: 100 /* EditorContrib */ + 99,
  321. kbExpr: EditorContextKeys.focus,
  322. primary: 9 /* Escape */,
  323. secondary: [1024 /* Shift */ | 9 /* Escape */]
  324. }
  325. }));
  326. // ---- api bridge command
  327. registerModelAndPositionCommand('_executeDocumentRenameProvider', function (model, position, ...args) {
  328. const [newName] = args;
  329. assertType(typeof newName === 'string');
  330. return rename(model, position, newName);
  331. });
  332. registerModelAndPositionCommand('_executePrepareRename', function (model, position) {
  333. return __awaiter(this, void 0, void 0, function* () {
  334. const skeleton = new RenameSkeleton(model, position);
  335. const loc = yield skeleton.resolveRenameLocation(CancellationToken.None);
  336. if (loc === null || loc === void 0 ? void 0 : loc.rejectReason) {
  337. throw new Error(loc.rejectReason);
  338. }
  339. return loc;
  340. });
  341. });
  342. //todo@jrieken use editor options world
  343. Registry.as(Extensions.Configuration).registerConfiguration({
  344. id: 'editor',
  345. properties: {
  346. 'editor.rename.enablePreview': {
  347. scope: 5 /* LANGUAGE_OVERRIDABLE */,
  348. description: nls.localize('enablePreview', "Enable/disable the ability to preview changes before renaming"),
  349. default: true,
  350. type: 'boolean'
  351. }
  352. }
  353. });