Add editor encoding api

src/vs/platform/extensions/common/extensionsApiProposals.ts

@@ -166,6 +166,9 @@ const _allApiProposals = {
  editSessionIdentityProvider: {
  proposal: 'https://raw.githubusercontent.com/microsoft/vscode/main/src/vscode-dts/vscode.proposed.editSessionIdentityProvider.d.ts',
  },
+ editorEncoding: {
+ proposal: 'https://raw.githubusercontent.com/microsoft/vscode/main/src/vscode-dts/vscode.proposed.editorEncoding.d.ts',
+ },
  editorHoverVerbosityLevel: {
  proposal: 'https://raw.githubusercontent.com/microsoft/vscode/main/src/vscode-dts/vscode.proposed.editorHoverVerbosityLevel.d.ts',
  },

src/vs/workbench/api/browser/mainThreadEditors.ts

@@ -29,6 +29,8 @@ import { IEditorControl } from 'vs/workbench/common/editor';
 import { getCodeEditor, ICodeEditor } from 'vs/editor/browser/editorBrowser';
 import { IConfigurationService } from 'vs/platform/configuration/common/configuration';
 import { DirtyDiffContribution } from 'vs/workbench/contrib/scm/browser/dirtydiffDecorator';
+import { toEditorWithEncodingSupport } from 'vs/workbench/browser/parts/editor/editorStatus';
+import { EncodingMode } from 'vs/workbench/services/textfile/common/textfiles';
 
 export interface IMainThreadEditorLocator {
  getEditor(id: string): MainThreadTextEditor | undefined;
@@ -274,6 +276,52 @@ export class MainThreadTextEditors implements MainThreadTextEditorsShape {
 
  return Promise.resolve([]);
  }
+
+ $tryGetEncoding(id: string): Promise<string | undefined> {
+ const editor = this._editorLocator.getEditor(id);
+
+ if (!editor) {
+ return Promise.reject(new Error('No such TextEditor'));
+ }
+
+ const editorPanes = this._editorService.visibleEditorPanes;
+ for (const editorPane of editorPanes) {
+ if (editor.matches(editorPane)) {
+ const encodingSupport = toEditorWithEncodingSupport(editorPane.input);
+ if (!encodingSupport) {
+ return Promise.reject(new Error('No file active at this time'));
+ }
+
+ const encoding = encodingSupport.getEncoding();
+
+ return Promise.resolve(encoding);
+ }
+ }
+
+ return Promise.reject(new Error('No text editor active at this time'));
+ }
+
+ $trySetEncoding(id: string, encoding: string, mode: EncodingMode): Promise<void> {
+ const editor = this._editorLocator.getEditor(id);
+
+ if (!editor) {
+ return Promise.reject(new Error('No such TextEditor'));
+ }
+
+ const editorPanes = this._editorService.visibleEditorPanes;
+ for (const editorPane of editorPanes) {
+ if (editor.matches(editorPane)) {
+ const encodingSupport = toEditorWithEncodingSupport(editorPane.input);
+ if (!encodingSupport) {
+ return Promise.reject(new Error('No file active at this time'));
+ }
+
+ return encodingSupport.setEncoding(encoding, mode);
+ }
+ }
+
+ return Promise.reject(new Error('No text editor active at this time'));
+ }
 }
 
 // --- commands

src/vs/workbench/api/common/extHost.api.impl.ts

@@ -1753,6 +1753,7 @@ export function createApiFactoryAndRegisterActors(accessor: ServicesAccessor): I
  NewSymbolNameTriggerKind: extHostTypes.NewSymbolNameTriggerKind,
  InlineEdit: extHostTypes.InlineEdit,
  InlineEditTriggerKind: extHostTypes.InlineEditTriggerKind,
+ EncodingMode: extHostTypes.EncodingMode,
  };
  };
 }

src/vs/workbench/api/common/extHost.protocol.ts

@@ -83,6 +83,7 @@ import * as search from 'vs/workbench/services/search/common/search';
 import { ISaveProfileResult } from 'vs/workbench/services/userDataProfile/common/userDataProfile';
 import type { TerminalShellExecutionCommandLineConfidence } from 'vscode';
 import { AuthInfo, Credentials } from 'vs/platform/request/common/request';
+import { EncodingMode } from 'vs/workbench/services/textfile/common/textfiles';
 
 export interface IWorkspaceData extends IStaticWorkspaceData {
  folders: { uri: UriComponents; name: string; index: number }[];
@@ -282,6 +283,8 @@ export interface MainThreadTextEditorsShape extends IDisposable {
  $tryApplyEdits(id: string, modelVersionId: number, edits: ISingleEditOperation[], opts: IApplyEditsOptions): Promise<boolean>;
  $tryInsertSnippet(id: string, modelVersionId: number, template: string, selections: readonly IRange[], opts: IUndoStopOptions): Promise<boolean>;
  $getDiffInformation(id: string): Promise<IChange[]>;
+ $tryGetEncoding(id: string): Promise<string | undefined>;
+ $trySetEncoding(id: string, encoding: string, mode: EncodingMode): Promise<void>;
 }
 
 export interface MainThreadTreeViewsShape extends IDisposable {

src/vs/workbench/api/common/extHostTextEditor.ts

@@ -11,11 +11,12 @@ import { IRange } from 'vs/editor/common/core/range';
 import { ISingleEditOperation } from 'vs/editor/common/core/editOperation';
 import { IResolvedTextEditorConfiguration, ITextEditorConfigurationUpdate, MainThreadTextEditorsShape } from 'vs/workbench/api/common/extHost.protocol';
 import * as TypeConverters from 'vs/workbench/api/common/extHostTypeConverters';
-import { EndOfLine, Position, Range, Selection, SnippetString, TextEditorLineNumbersStyle, TextEditorRevealType } from 'vs/workbench/api/common/extHostTypes';
+import { EncodingMode, EndOfLine, Position, Range, Selection, SnippetString, TextEditorLineNumbersStyle, TextEditorRevealType } from 'vs/workbench/api/common/extHostTypes';
 import type * as vscode from 'vscode';
 import { ILogService } from 'vs/platform/log/common/log';
 import { Lazy } from 'vs/base/common/lazy';
 import { IExtensionDescription } from 'vs/platform/extensions/common/extensions';
+import * as TextFiles from 'vs/workbench/services/textfile/common/textfiles';
 
 export class TextEditorDecorationType {
 
@@ -566,6 +567,13 @@ export class ExtHostTextEditor {
  },
  hide() {
  _proxy.$tryHideEditor(id);
+ },
+ getEncoding(): Promise<string | undefined> {
+ return _proxy.$tryGetEncoding(id);
+ },
+ setEncoding(encoding: string, mode: EncodingMode): Promise<void> {
+ const _mode: TextFiles.EncodingMode = mode === EncodingMode.Encode ? TextFiles.EncodingMode.Encode : TextFiles.EncodingMode.Decode;
+ return _proxy.$trySetEncoding(id, encoding, _mode);
  }
  });
  }

src/vs/workbench/api/common/extHostTypes.ts

@@ -4638,3 +4638,11 @@ export enum InlineEditTriggerKind {
 }
 
 //#endregion
+
+//#region
+export enum EncodingMode {
+ Encode = 0,
+ Decode = 1
+}
+
+//#endregion

src/vs/workbench/api/test/browser/extHostTextEditor.test.ts

@@ -89,7 +89,9 @@ suite('ExtHostTextEditorOptions', () => {
  $trySetSelections: undefined!,
  $tryApplyEdits: undefined!,
  $tryInsertSnippet: undefined!,
- $getDiffInformation: undefined!
+ $getDiffInformation: undefined!,
+ $tryGetEncoding: undefined!,
+ $trySetEncoding: undefined!
  };
  opts = new ExtHostTextEditorOptions(mockProxy, '1', {
  tabSize: 4,

src/vs/workbench/browser/parts/editor/editorStatus.ts

@@ -80,7 +80,7 @@ class SideBySideEditorLanguageSupport implements ILanguageSupport {
  }
 }
 
-function toEditorWithEncodingSupport(input: EditorInput): IEncodingSupport | null {
+export function toEditorWithEncodingSupport(input: EditorInput): IEncodingSupport | null {
 
  // Untitled Text Editor
  if (input instanceof UntitledTextEditorInput) {

src/vscode-dts/vscode.proposed.editorEncoding.d.ts

@@ -0,0 +1,35 @@
+/*---------------------------------------------------------------------------------------------
+ * Copyright (c) Microsoft Corporation. All rights reserved.
+ * Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+
+declare module 'vscode' {
+ // https://github.com/microsoft/vscode/issues/824
+
+ export enum EncodingMode {
+
+ /**
+ * Instructs the encoding support to encode the object with the provided encoding
+ */
+ Encode = 0,
+
+ /**
+ * Instructs the encoding support to decode the object with the provided encoding
+ */
+ Decode = 1
+ }
+
+ export interface TextEditor {
+ /**
+ * Get the text editor encoding.
+ */
+ getEncoding(): Thenable<string | undefined>;
+
+ /**
+ * Set the text editor encoding.
+ * @param encoding
+ * @param mode
+ */
+ setEncoding(encoding: string, mode: EncodingMode): Thenable<void>;
+ }
+}