@opensumi/ide-utils 2.21.13 → 2.22.0

package/src/disposable.ts

@@ -0,0 +1,377 @@
+/** ******************************************************************************
+ * Copyright (C) 2017 TypeFox and others.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License v. 2.0 which is available at
+ * http://www.eclipse.org/legal/epl-2.0.
+ *
+ * This Source Code may also be made available under the following Secondary
+ * Licenses when the conditions for such availability set forth in the Eclipse
+ * Public License v. 2.0 are satisfied: GNU General Public License, version 2
+ * with the GNU Classpath Exception which is available at
+ * https://www.gnu.org/software/classpath/license.html.
+ *
+ * SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
+ ********************************************************************************/
+import { MaybePromise } from './async';
+import { Event, Emitter } from './event';
+
+// DisposableStore 是从 vscode lifecycle 中复制而来
+export class DisposableStore implements IDisposable {
+  private toDispose = new Set<IDisposable>();
+  private _isDisposed = false;
+
+  /**
+   * Dispose of all registered disposables and mark this object as disposed.
+   *
+   * Any future disposables added to this object will be disposed of on `add`.
+   */
+  public dispose(): void {
+    if (this._isDisposed) {
+      return;
+    }
+
+    markTracked(this);
+    this._isDisposed = true;
+    this.clear();
+  }
+
+  /**
+   * Dispose of all registered disposables but do not mark this object as disposed.
+   */
+  public clear(): void {
+    this.toDispose.forEach((item) => item.dispose());
+    this.toDispose.clear();
+  }
+
+  public add<T extends IDisposable>(t: T): T {
+    if (!t) {
+      return t;
+    }
+    if ((t as any as DisposableStore) === this) {
+      throw new Error('Cannot register a disposable on itself!');
+    }
+
+    markTracked(t);
+    if (this._isDisposed) {
+      // eslint-disable-next-line no-console
+      console.warn(new Error('Registering disposable on object that has already been disposed of').stack);
+      t.dispose();
+    } else {
+      this.toDispose.add(t);
+    }
+
+    return t;
+  }
+}
+
+export interface IDisposable {
+  /**
+   * Dispose this object.
+   */
+  dispose(): void;
+}
+
+export function isDisposable<E extends object>(thing: E): thing is E & IDisposable {
+  return typeof (thing as IDisposable).dispose === 'function' && (thing as IDisposable).dispose.length === 0;
+}
+
+export function dispose<T extends IDisposable>(disposable: T): T;
+export function dispose<T extends IDisposable>(...disposables: Array<T | undefined>): T[];
+export function dispose<T extends IDisposable>(disposables: T[]): T[];
+export function dispose<T extends IDisposable>(first: T | T[], ...rest: T[]): T | T[] | undefined {
+  if (Array.isArray(first)) {
+    first.forEach((d) => {
+      if (d) {
+        markTracked(d);
+        d.dispose();
+      }
+    });
+    return [];
+  } else if (rest.length === 0) {
+    if (first) {
+      markTracked(first);
+      first.dispose();
+      return first;
+    }
+    return undefined;
+  } else {
+    dispose(first);
+    dispose(rest);
+    return [];
+  }
+}
+
+export function combinedDisposable(disposables: IDisposable[]): IDisposable {
+  disposables.forEach(markTracked);
+  return trackDisposable({ dispose: () => dispose(disposables) });
+}
+
+export function toDisposable(fn: () => void): IDisposable {
+  return {
+    dispose() {
+      fn();
+    },
+  };
+}
+
+export class Disposable implements IDisposable {
+  protected readonly disposables: IDisposable[] = [];
+  protected readonly onDisposeEmitter = new Emitter<void>();
+
+  constructor(...toDispose: IDisposable[]) {
+    toDispose.forEach((d) => this.addDispose(d));
+  }
+
+  static create(func: () => void): IDisposable {
+    return {
+      dispose: func,
+    };
+  }
+
+  static NULL = Disposable.create(() => {});
+
+  static None = Object.freeze<IDisposable>({ dispose() {} });
+
+  get onDispose(): Event<void> {
+    return this.onDisposeEmitter.event;
+  }
+
+  protected checkDisposed(): void {
+    if (this.disposed && !this.disposingElements) {
+      this.onDisposeEmitter.fire(undefined);
+    }
+  }
+
+  get disposed(): boolean {
+    return this.disposables.length === 0;
+  }
+
+  private disposingElements = false;
+  dispose(): void {
+    if (this.disposed || this.disposingElements) {
+      return;
+    }
+    this.disposingElements = true;
+    while (!this.disposed) {
+      try {
+        this.disposables.pop()!.dispose();
+      } catch (e) {
+        // eslint-disable-next-line no-console
+        console.error(e);
+      }
+    }
+    this.disposingElements = false;
+    this.checkDisposed();
+  }
+
+  addDispose(disposable: IDisposable): IDisposable;
+  addDispose(disposable: IDisposable[]): IDisposable[];
+  addDispose(disposable: IDisposable | IDisposable[]): IDisposable | IDisposable[] {
+    if (Array.isArray(disposable)) {
+      const disposables = disposable;
+      return disposables.map((disposable) => this.addDispose(disposable));
+    } else {
+      return this.add(disposable);
+    }
+  }
+
+  protected registerDispose<T extends IDisposable>(disposable: T): T {
+    if ((disposable as any as Disposable) === this) {
+      throw new Error('Cannot register a disposable on itself!');
+    }
+
+    this.add(disposable);
+    return disposable;
+  }
+
+  private add(disposable: IDisposable): IDisposable {
+    const disposables = this.disposables;
+    disposables.push(disposable);
+    const originalDispose = disposable.dispose.bind(disposable);
+    const toRemove = Disposable.create(() => {
+      const index = disposables.indexOf(disposable);
+      if (index !== -1) {
+        disposables.splice(index, 1);
+      }
+      this.checkDisposed();
+    });
+    disposable.dispose = () => {
+      toRemove.dispose();
+      originalDispose();
+    };
+    return toRemove;
+  }
+}
+
+export class DisposableCollection implements IDisposable {
+  protected readonly disposables: IDisposable[] = [];
+  protected readonly onDisposeEmitter = new Emitter<void>();
+
+  constructor(...toDispose: IDisposable[]) {
+    toDispose.forEach((d) => this.push(d));
+  }
+
+  get onDispose(): Event<void> {
+    return this.onDisposeEmitter.event;
+  }
+
+  protected checkDisposed(): void {
+    if (this.disposed && !this.disposingElements) {
+      this.onDisposeEmitter.fire(undefined);
+    }
+  }
+
+  get disposed(): boolean {
+    return this.disposables.length === 0;
+  }
+
+  private disposingElements = false;
+  dispose(): void {
+    if (this.disposed || this.disposingElements) {
+      return;
+    }
+    const toPromise = [] as any[];
+    this.disposingElements = true;
+    while (!this.disposed) {
+      try {
+        const maybePromise = this.disposables.pop()!.dispose() as MaybePromise<void>;
+        if (maybePromise) {
+          toPromise.push(maybePromise);
+        }
+      } catch (e) {
+        // eslint-disable-next-line no-console
+        console.error('DisposableCollection.dispose error', e);
+      }
+    }
+    this.disposingElements = false;
+    this.checkDisposed();
+    return Promise.all(toPromise) as unknown as MaybePromise<void> as void;
+  }
+
+  push(disposable: IDisposable): IDisposable {
+    const disposables = this.disposables;
+    disposables.push(disposable);
+    const originalDispose = disposable.dispose.bind(disposable);
+    const toRemove = Disposable.create(() => {
+      const index = disposables.indexOf(disposable);
+      if (index !== -1) {
+        disposables.splice(index, 1);
+      }
+      this.checkDisposed();
+    });
+    disposable.dispose = () => {
+      toRemove.dispose();
+      originalDispose();
+    };
+    return toRemove;
+  }
+
+  pushAll(disposables: IDisposable[]): IDisposable[] {
+    return disposables.map((disposable) => this.push(disposable));
+  }
+}
+
+/**
+ * Enables logging of potentially leaked disposables.
+ *
+ * A disposable is considered leaked if it is not disposed or not registered as the child of
+ * another disposable. This tracking is very simple an only works for classes that either
+ * extend Disposable or use a DisposableStore. This means there are a lot of false positives.
+ */
+const TRACK_DISPOSABLES = false;
+
+const __is_disposable_tracked__ = '__is_disposable_tracked__';
+
+function markTracked<T extends IDisposable>(x: T): void {
+  if (!TRACK_DISPOSABLES) {
+    return;
+  }
+
+  if (x && x !== Disposable.None) {
+    try {
+      (x as any)[__is_disposable_tracked__] = true;
+    } catch (_e) {
+      // noop
+    }
+  }
+}
+
+function trackDisposable<T extends IDisposable>(x: T): T {
+  if (!TRACK_DISPOSABLES) {
+    return x;
+  }
+
+  const stack = new Error('Potentially leaked disposable').stack!;
+  setTimeout(() => {
+    if (!(x as any)[__is_disposable_tracked__]) {
+      // eslint-disable-next-line no-console
+      console.log(stack);
+    }
+  }, 3000);
+  return x;
+}
+
+/**
+ * Manages the lifecycle of a disposable value that may be changed.
+ *
+ * This ensures that when the the disposable value is changed, the previously held disposable is disposed of. You can
+ * also register a `MutableDisposable` on a `Disposable` to ensure it is automatically cleaned up.
+ */
+export class MutableDisposable<T extends IDisposable> implements IDisposable {
+  private _value?: T;
+  private _isDisposed = false;
+
+  constructor() {
+    trackDisposable(this);
+  }
+
+  get value(): T | undefined {
+    return this._isDisposed ? undefined : this._value;
+  }
+
+  set value(value: T | undefined) {
+    if (this._isDisposed || value === this._value) {
+      return;
+    }
+
+    if (this._value) {
+      this._value.dispose();
+    }
+    if (value) {
+      markTracked(value);
+    }
+    this._value = value;
+  }
+
+  clear() {
+    this.value = undefined;
+  }
+
+  dispose(): void {
+    this._isDisposed = true;
+    markTracked(this);
+    if (this._value) {
+      this._value.dispose();
+    }
+    this._value = undefined;
+  }
+}
+
+export class RefCountedDisposable {
+  private _counter = 1;
+
+  constructor(private readonly _disposable: IDisposable) {}
+
+  acquire() {
+    this._counter++;
+    return this;
+  }
+
+  release() {
+    if (--this._counter === 0) {
+      this._disposable.dispose();
+    }
+    return this;
+  }
+}

package/src/encoding.ts

@@ -0,0 +1,278 @@
+/* ---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+import iconv from 'iconv-lite';
+
+import type { BinaryBuffer } from './buffer';
+import { SUPPORTED_ENCODINGS } from './const';
+
+export const UTF8 = 'utf8';
+export const UTF8_with_bom = 'utf8bom';
+export const UTF16be = 'utf16be';
+export const UTF16le = 'utf16le';
+
+export const UTF16be_BOM = [0xfe, 0xff];
+export const UTF16le_BOM = [0xff, 0xfe];
+export const UTF8_BOM = [0xef, 0xbb, 0xbf];
+
+const ZERO_BYTE_DETECTION_BUFFER_MAX_LEN = 512; // number of bytes to look at to decide about a file being binary or not
+const AUTO_ENCODING_GUESS_MAX_BYTES = 512 * 128; // set an upper limit for the number of bytes we pass on to jschardet
+
+export function isUTF8(encoding: string | null) {
+  if (encoding) {
+    return toIconvLiteEncoding(encoding) === UTF8;
+  }
+  return false;
+}
+
+const SUPPORT_ENCODINGS_TO_ICONV_ENCODINGS: { [name: string]: string } = {
+  ibm866: 'cp866',
+  big5: 'cp950',
+  utf8bom: 'utf8',
+};
+
+export function toIconvLiteEncoding(encodingName: string): string {
+  const normalizedEncodingName = encodingName.replace(/[^a-zA-Z0-9]/g, '').toLowerCase();
+  const mapped = SUPPORT_ENCODINGS_TO_ICONV_ENCODINGS[normalizedEncodingName];
+
+  return mapped || normalizedEncodingName;
+}
+
+/**
+ * The encodings that are allowed in a settings file don't match the canonical encoding labels specified by WHATWG.
+ * See https://encoding.spec.whatwg.org/#names-and-labels
+ * Iconv-lite strips all non-alphanumeric characters, but ripgrep doesn't. For backcompat, allow these labels.
+ */
+export function toCanonicalName(enc: string): string {
+  switch (enc) {
+    case 'shiftjis':
+      return 'shift-jis';
+    case 'utf16le':
+      return 'utf-16le';
+    case 'utf16be':
+      return 'utf-16be';
+    case 'big5hkscs':
+      return 'big5-hkscs';
+    case 'eucjp':
+      return 'euc-jp';
+    case 'euckr':
+      return 'euc-kr';
+    case 'koi8r':
+      return 'koi8-r';
+    case 'koi8u':
+      return 'koi8-u';
+    case 'macroman':
+      return 'x-mac-roman';
+    case 'utf8bom':
+      return 'utf8';
+    default: {
+      const m = enc.match(/windows(\d+)/);
+      if (m) {
+        return 'windows-' + m[1];
+      }
+
+      return enc;
+    }
+  }
+}
+
+export async function encodingExists(encoding: string): Promise<boolean> {
+  return iconv.encodingExists(toNodeEncoding(encoding));
+}
+
+export function toNodeEncoding(enc: string | null): string {
+  if (enc === UTF8_with_bom || enc === null) {
+    return UTF8; // iconv does not distinguish UTF 8 with or without BOM, so we need to help it
+  }
+  return enc;
+}
+
+/**
+ * nodejs 内置的 Buffer 转换编码不支持 GBK，使用第三方的 iconv-lite
+ * @param buffer Uint8Array | Buffer
+ * @param encoding 传入的是 SUPPORTED_ENCODINGS 已有的键值（已通过 tests case 的）
+ */
+export function iconvDecode(buffer: Uint8Array | Buffer, encoding: string) {
+  encoding = toIconvLiteEncoding(encoding);
+  return iconv.decode(buffer as Buffer, encoding);
+}
+
+export function iconvEncode(content: string, encoding: string): Uint8Array | Buffer {
+  encoding = toIconvLiteEncoding(encoding);
+  return iconv.encode(content, encoding);
+}
+
+function encodeLatin1(buffer: Uint8Array): string {
+  let result = '';
+  // eslint-disable-next-line @typescript-eslint/prefer-for-of
+  for (let i = 0; i < buffer.length; i++) {
+    result += String.fromCharCode(buffer[i]);
+  }
+  return result;
+}
+
+export function detectEncodingByBOMFromBuffer(
+  buffer: BinaryBuffer | null,
+  bytesRead: number,
+): typeof UTF8_with_bom | typeof UTF16le | typeof UTF16be | null {
+  if (!buffer || bytesRead < UTF16be_BOM.length) {
+    return null;
+  }
+
+  const b0 = buffer.readUInt8(0);
+  const b1 = buffer.readUInt8(1);
+
+  // UTF-16 BE
+  if (b0 === UTF16be_BOM[0] && b1 === UTF16be_BOM[1]) {
+    return UTF16be;
+  }
+
+  // UTF-16 LE
+  if (b0 === UTF16le_BOM[0] && b1 === UTF16le_BOM[1]) {
+    return UTF16le;
+  }
+
+  if (bytesRead < UTF8_BOM.length) {
+    return null;
+  }
+
+  const b2 = buffer.readUInt8(2);
+
+  // UTF-8
+  if (b0 === UTF8_BOM[0] && b1 === UTF8_BOM[1] && b2 === UTF8_BOM[2]) {
+    return UTF8_with_bom;
+  }
+
+  return null;
+}
+
+// we explicitly ignore a specific set of encodings from auto guessing
+// - ASCII: we never want this encoding (most UTF-8 files would happily detect as
+//          ASCII files and then you could not type non-ASCII characters anymore)
+// - UTF-16: we have our own detection logic for UTF-16
+// - UTF-32: we do not support this encoding in VSCode
+const IGNORE_ENCODINGS = ['ascii', 'utf-16', 'utf-32'];
+
+async function guessEncodingByBuffer(buffer: BinaryBuffer): Promise<string | null> {
+  // lazy load
+  const jschardet = await import('jschardet');
+
+  // ensure to limit buffer for guessing due to https://github.com/aadsm/jschardet/issues/53
+  const limitedBuffer = buffer.slice(0, AUTO_ENCODING_GUESS_MAX_BYTES);
+
+  // before guessing jschardet calls toString('binary') on input if it is a Buffer,
+  // since we are using it inside browser environment as well we do conversion ourselves
+  // https://github.com/aadsm/jschardet/blob/v2.1.1/src/index.js#L36-L40
+  const binaryString = encodeLatin1(limitedBuffer.buffer);
+
+  const guessed = jschardet.detect(binaryString);
+  if (!guessed || !guessed.encoding) {
+    return null;
+  }
+
+  const enc = guessed.encoding.toLowerCase();
+  if (0 <= IGNORE_ENCODINGS.indexOf(enc)) {
+    return null; // see comment above why we ignore some encodings
+  }
+
+  return toIconvLiteEncoding(guessed.encoding);
+}
+
+export interface IDetectedEncodingResult {
+  encoding: string | null;
+  seemsBinary: boolean;
+}
+
+export function detectEncodingFromBuffer(buffer: BinaryBuffer, autoGuessEncoding?: false): IDetectedEncodingResult;
+export function detectEncodingFromBuffer(
+  buffer: BinaryBuffer,
+  autoGuessEncoding?: boolean,
+): Promise<IDetectedEncodingResult>;
+export function detectEncodingFromBuffer(
+  buffer: BinaryBuffer,
+  autoGuessEncoding?: boolean,
+): Promise<IDetectedEncodingResult> | IDetectedEncodingResult {
+  const bytesRead = buffer.byteLength;
+  // Always first check for BOM to find out about encoding
+  let encoding = detectEncodingByBOMFromBuffer(buffer, bytesRead);
+
+  // Detect 0 bytes to see if file is binary or UTF-16 LE/BE
+  // unless we already know that this file has a UTF-16 encoding
+  let seemsBinary = false;
+  if (encoding !== UTF16be && encoding !== UTF16le && buffer) {
+    let couldBeUTF16LE = true; // e.g. 0xAA 0x00
+    let couldBeUTF16BE = true; // e.g. 0x00 0xAA
+    let containsZeroByte = false;
+
+    // This is a simplified guess to detect UTF-16 BE or LE by just checking if
+    // the first 512 bytes have the 0-byte at a specific location. For UTF-16 LE
+    // this would be the odd byte index and for UTF-16 BE the even one.
+    // Note: this can produce false positives (a binary file that uses a 2-byte
+    // encoding of the same format as UTF-16) and false negatives (a UTF-16 file
+    // that is using 4 bytes to encode a character).
+    for (let i = 0; i < bytesRead && i < ZERO_BYTE_DETECTION_BUFFER_MAX_LEN; i++) {
+      const isEndian = i % 2 === 1; // assume 2-byte sequences typical for UTF-16
+      const isZeroByte = buffer.readUInt8(i) === 0;
+
+      if (isZeroByte) {
+        containsZeroByte = true;
+      }
+
+      // UTF-16 LE: expect e.g. 0xAA 0x00
+      if (couldBeUTF16LE && ((isEndian && !isZeroByte) || (!isEndian && isZeroByte))) {
+        couldBeUTF16LE = false;
+      }
+
+      // UTF-16 BE: expect e.g. 0x00 0xAA
+      if (couldBeUTF16BE && ((isEndian && isZeroByte) || (!isEndian && !isZeroByte))) {
+        couldBeUTF16BE = false;
+      }
+
+      // Return if this is neither UTF16-LE nor UTF16-BE and thus treat as binary
+      if (isZeroByte && !couldBeUTF16LE && !couldBeUTF16BE) {
+        break;
+      }
+    }
+
+    // Handle case of 0-byte included
+    if (containsZeroByte) {
+      if (couldBeUTF16LE) {
+        encoding = UTF16le;
+      } else if (couldBeUTF16BE) {
+        encoding = UTF16be;
+      } else {
+        seemsBinary = true;
+      }
+    }
+  }
+
+  // Auto guess encoding if configured
+  if (autoGuessEncoding && !seemsBinary && !encoding && buffer) {
+    return guessEncodingByBuffer(buffer.slice(0, bytesRead)).then((guessedEncoding) => ({
+      seemsBinary: false,
+      encoding: guessedEncoding,
+    }));
+  }
+
+  return { seemsBinary, encoding };
+}
+
+export interface IEncodingInfo {
+  id: string; // encoding identifier
+  labelLong: string; // long label name
+  labelShort: string; // short label name
+}
+
+export function getEncodingInfo(encoding: string | null): null | IEncodingInfo {
+  if (!encoding) {
+    return null;
+  }
+  const result = SUPPORTED_ENCODINGS[encoding] || {};
+
+  return {
+    id: encoding,
+    labelLong: result.labelLong || encoding,
+    labelShort: result.labelShort || encoding,
+  };
+}