@theia/memory-inspector 1.45.0 → 1.46.0-next.72

package/src/browser/utils/memory-widget-manager.ts

@@ -1,179 +1,179 @@
-/********************************************************************************
- * Copyright (C) 2021 Ericsson 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-only WITH Classpath-exception-2.0
- ********************************************************************************/
-import { Disposable, DisposableCollection, Emitter, MessageService } from '@theia/core';
-import { ApplicationShell, OpenViewArguments, WidgetManager } from '@theia/core/lib/browser';
-import { injectable, inject, postConstruct } from '@theia/core/shared/inversify';
-import { MemoryDiffTableWidget, MemoryDiffWidget } from '../diff-widget/memory-diff-table-widget';
-import { MemoryWidget } from '../memory-widget/memory-widget';
-import { RegisterWidget } from '../register-widget/register-widget-types';
-import { MemoryDiffWidgetData, MemoryWidgetOptions } from './memory-widget-utils';
-import { nls } from '@theia/core/lib/common/nls';
-import { EditableMemoryWidget } from '../editable-widget/memory-editable-table-widget';
-
-@injectable()
-export class MemoryWidgetManager implements Disposable {
-    protected createdWidgetCount = 0;
-    protected widgetDisplayId = 0;
-    protected readonly toDispose = new DisposableCollection();
-
-    @inject(WidgetManager) protected readonly widgetManager: WidgetManager;
-    @inject(ApplicationShell) protected readonly shell: ApplicationShell;
-    @inject(MessageService) protected readonly messageService: MessageService;
-
-    protected readonly onNewWidgetCreated = new Emitter<MemoryWidget>();
-    readonly onDidCreateNewWidget = this.onNewWidgetCreated.event;
-
-    protected readonly onSelectedWidgetChanged = new Emitter<MemoryWidget | undefined>();
-    readonly onDidChangeSelectedWidget = this.onSelectedWidgetChanged.event;
-
-    protected readonly onChangedEmitter = new Emitter<void>();
-    readonly onChanged = this.onChangedEmitter.event;
-
-    protected readonly _availableWidgets = new Map<string, MemoryWidget>();
-    protected _focusedWidget: MemoryWidget | undefined;
-    protected _canCompare = false;
-
-    get availableWidgets(): MemoryWidget[] {
-        return Array.from(this._availableWidgets.values());
-    }
-
-    get canCompare(): boolean {
-        return this._canCompare;
-    }
-
-    @postConstruct()
-    protected init(): void {
-        this.toDispose.pushAll([
-            this.shell.onDidChangeActiveWidget(({ newValue }) => {
-                if (newValue instanceof MemoryWidget) {
-                    this._focusedWidget = newValue;
-                }
-            }),
-            this.widgetManager.onDidCreateWidget(e => {
-                const { widget } = e;
-                if (widget instanceof MemoryWidget) {
-                    this._availableWidgets.set(widget.id, widget);
-                    this.toDispose.push(widget.onDidDispose(() => {
-                        this._availableWidgets.delete(widget.id);
-                        if (widget === this._focusedWidget) {
-                            this.focusedWidget = undefined;
-                        }
-                        this.onChangedEmitter.fire();
-                    }));
-                }
-            }),
-            this.onChanged(() => this.setCanCompare()),
-            this.onNewWidgetCreated,
-            this.onChangedEmitter,
-            this.onSelectedWidgetChanged,
-        ]);
-    }
-
-    get focusedWidget(): MemoryWidget | undefined {
-        return this._focusedWidget ?? this._availableWidgets.values().next().value;
-    }
-
-    set focusedWidget(title: MemoryWidget | undefined) {
-        this._focusedWidget = title;
-        this.onSelectedWidgetChanged.fire(title);
-    }
-
-    protected setCanCompare(): void {
-        this._canCompare = this.availableWidgets.filter(widget => !RegisterWidget.is(widget) && !MemoryDiffWidget.is(widget)).length > 1;
-    }
-
-    async createNewMemoryWidget<T extends MemoryWidget>(kind: 'register' | 'memory' | 'writable' | string = 'memory'): Promise<T> {
-        this.widgetDisplayId = this._availableWidgets.size !== 0 ? this.widgetDisplayId + 1 : 1;
-        const widget = await this.getWidgetOfKind<T>(kind);
-        this._availableWidgets.set(widget.id, widget);
-        widget.title.changed.connect(() => this.onChangedEmitter.fire());
-        widget.activate();
-        this.fireNewWidget(widget);
-        return widget;
-    }
-
-    protected getWidgetOfKind<T extends MemoryWidget>(kind: string): Promise<T> {
-        const widgetId = this.getWidgetIdForKind(kind);
-        const options = this.getWidgetOptionsForId(widgetId);
-        return this.widgetManager.getOrCreateWidget<T>(widgetId, options);
-    }
-
-    protected getWidgetIdForKind(kind: string): string {
-        switch (kind) {
-            case 'register':
-            case RegisterWidget.ID:
-                return RegisterWidget.ID;
-            case 'writable':
-            case EditableMemoryWidget.ID:
-                return EditableMemoryWidget.ID;
-            default:
-                return MemoryWidget.ID;
-        }
-    }
-
-    protected getWidgetOptionsForId(widgetId: string): MemoryWidgetOptions {
-        return { identifier: this.createdWidgetCount += 1, displayId: this.widgetDisplayId };
-    }
-
-    dispose(): void {
-        this.toDispose.dispose();
-    }
-
-    protected fireNewWidget(widget: MemoryWidget): void {
-        this.onNewWidgetCreated.fire(widget);
-        this.onChangedEmitter.fire();
-    }
-
-    async doDiff(options: Omit<MemoryDiffWidgetData, 'dynamic' | 'identifier'>): Promise<MemoryDiffWidget | undefined> {
-        if (options.beforeBytes.length === 0) {
-            // eslint-disable-next-line max-len
-            const beforeBytesMessage = nls.localize('theia/memory-inspector/utils/bytesMessage', 'You must load memory in both widgets you would like to compare. {0} has no memory loaded.', options.titles[0]);
-            this.messageService.warn(beforeBytesMessage);
-            return undefined;
-        } else if (options.afterBytes.length === 0) {
-            // eslint-disable-next-line max-len
-            const afterBytesMessage = nls.localize('theia/memory-inspector/utils/afterBytes', 'You must load memory in both widgets you would like to compare. {0} has no memory loaded.', options.titles[1]);
-            this.messageService.warn(afterBytesMessage);
-            return undefined;
-        }
-
-        const fullOptions: MemoryDiffWidgetData = { ...options, dynamic: false, identifier: options.titles.join('-') };
-
-        const existingWidget = this._availableWidgets.get(MemoryWidget.getIdentifier(fullOptions.identifier.toString())) as MemoryDiffWidget;
-
-        if (existingWidget && existingWidget.tableWidget instanceof MemoryDiffTableWidget) {
-            existingWidget.tableWidget.updateDiffData(options);
-        }
-
-        const widget = existingWidget ?? await this.widgetManager
-            .getOrCreateWidget<MemoryDiffWidget>(
-                MemoryDiffWidget.ID,
-                { ...options, dynamic: false, identifier: options.titles.join('-') },
-            );
-
-        const tabBar = this.shell.getTabBarFor(widget);
-        if (!tabBar) {
-            // The widget is not attached yet, so add it to the shell
-            const widgetArgs: OpenViewArguments = {
-                area: 'main',
-            };
-            await this.shell.addWidget(widget, widgetArgs);
-        }
-        await this.shell.activateWidget(widget.id);
-
-        return widget;
-    }
-}
+/********************************************************************************
+ * Copyright (C) 2021 Ericsson 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-only WITH Classpath-exception-2.0
+ ********************************************************************************/
+import { Disposable, DisposableCollection, Emitter, MessageService } from '@theia/core';
+import { ApplicationShell, OpenViewArguments, WidgetManager } from '@theia/core/lib/browser';
+import { injectable, inject, postConstruct } from '@theia/core/shared/inversify';
+import { MemoryDiffTableWidget, MemoryDiffWidget } from '../diff-widget/memory-diff-table-widget';
+import { MemoryWidget } from '../memory-widget/memory-widget';
+import { RegisterWidget } from '../register-widget/register-widget-types';
+import { MemoryDiffWidgetData, MemoryWidgetOptions } from './memory-widget-utils';
+import { nls } from '@theia/core/lib/common/nls';
+import { EditableMemoryWidget } from '../editable-widget/memory-editable-table-widget';
+
+@injectable()
+export class MemoryWidgetManager implements Disposable {
+    protected createdWidgetCount = 0;
+    protected widgetDisplayId = 0;
+    protected readonly toDispose = new DisposableCollection();
+
+    @inject(WidgetManager) protected readonly widgetManager: WidgetManager;
+    @inject(ApplicationShell) protected readonly shell: ApplicationShell;
+    @inject(MessageService) protected readonly messageService: MessageService;
+
+    protected readonly onNewWidgetCreated = new Emitter<MemoryWidget>();
+    readonly onDidCreateNewWidget = this.onNewWidgetCreated.event;
+
+    protected readonly onSelectedWidgetChanged = new Emitter<MemoryWidget | undefined>();
+    readonly onDidChangeSelectedWidget = this.onSelectedWidgetChanged.event;
+
+    protected readonly onChangedEmitter = new Emitter<void>();
+    readonly onChanged = this.onChangedEmitter.event;
+
+    protected readonly _availableWidgets = new Map<string, MemoryWidget>();
+    protected _focusedWidget: MemoryWidget | undefined;
+    protected _canCompare = false;
+
+    get availableWidgets(): MemoryWidget[] {
+        return Array.from(this._availableWidgets.values());
+    }
+
+    get canCompare(): boolean {
+        return this._canCompare;
+    }
+
+    @postConstruct()
+    protected init(): void {
+        this.toDispose.pushAll([
+            this.shell.onDidChangeActiveWidget(({ newValue }) => {
+                if (newValue instanceof MemoryWidget) {
+                    this._focusedWidget = newValue;
+                }
+            }),
+            this.widgetManager.onDidCreateWidget(e => {
+                const { widget } = e;
+                if (widget instanceof MemoryWidget) {
+                    this._availableWidgets.set(widget.id, widget);
+                    this.toDispose.push(widget.onDidDispose(() => {
+                        this._availableWidgets.delete(widget.id);
+                        if (widget === this._focusedWidget) {
+                            this.focusedWidget = undefined;
+                        }
+                        this.onChangedEmitter.fire();
+                    }));
+                }
+            }),
+            this.onChanged(() => this.setCanCompare()),
+            this.onNewWidgetCreated,
+            this.onChangedEmitter,
+            this.onSelectedWidgetChanged,
+        ]);
+    }
+
+    get focusedWidget(): MemoryWidget | undefined {
+        return this._focusedWidget ?? this._availableWidgets.values().next().value;
+    }
+
+    set focusedWidget(title: MemoryWidget | undefined) {
+        this._focusedWidget = title;
+        this.onSelectedWidgetChanged.fire(title);
+    }
+
+    protected setCanCompare(): void {
+        this._canCompare = this.availableWidgets.filter(widget => !RegisterWidget.is(widget) && !MemoryDiffWidget.is(widget)).length > 1;
+    }
+
+    async createNewMemoryWidget<T extends MemoryWidget>(kind: 'register' | 'memory' | 'writable' | string = 'memory'): Promise<T> {
+        this.widgetDisplayId = this._availableWidgets.size !== 0 ? this.widgetDisplayId + 1 : 1;
+        const widget = await this.getWidgetOfKind<T>(kind);
+        this._availableWidgets.set(widget.id, widget);
+        widget.title.changed.connect(() => this.onChangedEmitter.fire());
+        widget.activate();
+        this.fireNewWidget(widget);
+        return widget;
+    }
+
+    protected getWidgetOfKind<T extends MemoryWidget>(kind: string): Promise<T> {
+        const widgetId = this.getWidgetIdForKind(kind);
+        const options = this.getWidgetOptionsForId(widgetId);
+        return this.widgetManager.getOrCreateWidget<T>(widgetId, options);
+    }
+
+    protected getWidgetIdForKind(kind: string): string {
+        switch (kind) {
+            case 'register':
+            case RegisterWidget.ID:
+                return RegisterWidget.ID;
+            case 'writable':
+            case EditableMemoryWidget.ID:
+                return EditableMemoryWidget.ID;
+            default:
+                return MemoryWidget.ID;
+        }
+    }
+
+    protected getWidgetOptionsForId(widgetId: string): MemoryWidgetOptions {
+        return { identifier: this.createdWidgetCount += 1, displayId: this.widgetDisplayId };
+    }
+
+    dispose(): void {
+        this.toDispose.dispose();
+    }
+
+    protected fireNewWidget(widget: MemoryWidget): void {
+        this.onNewWidgetCreated.fire(widget);
+        this.onChangedEmitter.fire();
+    }
+
+    async doDiff(options: Omit<MemoryDiffWidgetData, 'dynamic' | 'identifier'>): Promise<MemoryDiffWidget | undefined> {
+        if (options.beforeBytes.length === 0) {
+            // eslint-disable-next-line max-len
+            const beforeBytesMessage = nls.localize('theia/memory-inspector/utils/bytesMessage', 'You must load memory in both widgets you would like to compare. {0} has no memory loaded.', options.titles[0]);
+            this.messageService.warn(beforeBytesMessage);
+            return undefined;
+        } else if (options.afterBytes.length === 0) {
+            // eslint-disable-next-line max-len
+            const afterBytesMessage = nls.localize('theia/memory-inspector/utils/afterBytes', 'You must load memory in both widgets you would like to compare. {0} has no memory loaded.', options.titles[1]);
+            this.messageService.warn(afterBytesMessage);
+            return undefined;
+        }
+
+        const fullOptions: MemoryDiffWidgetData = { ...options, dynamic: false, identifier: options.titles.join('-') };
+
+        const existingWidget = this._availableWidgets.get(MemoryWidget.getIdentifier(fullOptions.identifier.toString())) as MemoryDiffWidget;
+
+        if (existingWidget && existingWidget.tableWidget instanceof MemoryDiffTableWidget) {
+            existingWidget.tableWidget.updateDiffData(options);
+        }
+
+        const widget = existingWidget ?? await this.widgetManager
+            .getOrCreateWidget<MemoryDiffWidget>(
+                MemoryDiffWidget.ID,
+                { ...options, dynamic: false, identifier: options.titles.join('-') },
+            );
+
+        const tabBar = this.shell.getTabBarFor(widget);
+        if (!tabBar) {
+            // The widget is not attached yet, so add it to the shell
+            const widgetArgs: OpenViewArguments = {
+                area: 'main',
+            };
+            await this.shell.addWidget(widget, widgetArgs);
+        }
+        await this.shell.activateWidget(widget.id);
+
+        return widget;
+    }
+}

package/src/browser/utils/memory-widget-utils.tsx

@@ -1,132 +1,132 @@
-/********************************************************************************
- * Copyright (C) 2021 Ericsson 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-only WITH Classpath-exception-2.0
- ********************************************************************************/
-
-import * as Long from 'long';
-import { VariableRange, VariableDecoration } from './memory-widget-variable-utils';
-
-export namespace Constants {
-    export const DEBOUNCE_TIME = 200;
-    export const ERROR_TIMEOUT = 5000;
-}
-export namespace Utils {
-    export const validateNumericalInputs = (e: React.ChangeEvent<HTMLInputElement>, allowNegative = true): void => {
-        const toReplace = allowNegative ? /[^\d-]/g : /[^\d]/g;
-        e.target.value = e.target.value.replace(toReplace, '');
-    };
-
-    export const isPrintableAsAscii = (byte: number): boolean => byte >= 32 && byte < (128 - 1);
-}
-
-export namespace Interfaces {
-    export interface MemoryReadResult {
-        bytes: LabeledUint8Array;
-        address: Long;
-    }
-    export interface WidgetMemoryState extends MemoryReadResult {
-        variables: VariableRange[];
-    }
-
-    export interface MemoryOptions {
-        address: string | number;
-        offset: number;
-        length: number;
-        byteSize: number;
-        bytesPerGroup: number;
-        groupsPerRow: number;
-        endianness: Endianness;
-        doDisplaySettings: boolean;
-        doUpdateAutomatically: boolean;
-        columnsDisplayed: ColumnsDisplayed;
-        recentLocationsArray: string[];
-        isFrozen: boolean;
-    }
-    export interface MoreMemoryOptions {
-        numBytes: number;
-        direction: 'above' | 'below';
-    }
-
-    export enum Endianness {
-        Little = 'Little Endian',
-        Big = 'Big Endian'
-    }
-    export interface LabeledUint8Array extends Uint8Array {
-        label?: string;
-    }
-
-    export interface StylableNodeAttributes {
-        className?: string;
-        style?: React.CSSProperties;
-        variable?: VariableDecoration;
-        title?: string;
-        isHighlighted?: boolean;
-    }
-
-    export interface FullNodeAttributes extends StylableNodeAttributes {
-        content: string;
-    }
-
-    export interface BitDecorator {
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        (...args: any[]): Partial<FullNodeAttributes>;
-    }
-    export interface RowDecorator {
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        (...args: any[]): Partial<StylableNodeAttributes>;
-    }
-    export interface ByteFromChunkData {
-        address: Long;
-        /**
-         * A single eight-bit byte
-         */
-        value: string;
-    }
-
-    export interface Column {
-        label: string;
-        doRender: boolean;
-    }
-
-    export interface ColumnIDs {
-        label: string;
-        id: string;
-    }
-
-    export interface ColumnsDisplayed {
-        [id: string]: Column;
-    }
-}
-
-export const MemoryWidgetOptions = Symbol('MemoryWidgetOptions');
-export interface MemoryWidgetOptions {
-    identifier: string | number;
-    displayId?: string | number;
-    dynamic?: boolean;
-}
-
-export const MemoryDiffWidgetData = Symbol('MemoryDiffWidgetData');
-export interface MemoryDiffWidgetData extends MemoryWidgetOptions {
-    beforeAddress: Long;
-    beforeBytes: Interfaces.LabeledUint8Array;
-    beforeVariables: VariableRange[];
-    afterAddress: Long;
-    afterBytes: Interfaces.LabeledUint8Array;
-    afterVariables: VariableRange[];
-    dynamic: false;
-    titles: [string, string];
-}
-
-export const RegisterWidgetOptions = Symbol('RegisterWidgetData');
-export type RegisterWidgetOptions = MemoryWidgetOptions;
+/********************************************************************************
+ * Copyright (C) 2021 Ericsson 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-only WITH Classpath-exception-2.0
+ ********************************************************************************/
+
+import * as Long from 'long';
+import { VariableRange, VariableDecoration } from './memory-widget-variable-utils';
+
+export namespace Constants {
+    export const DEBOUNCE_TIME = 200;
+    export const ERROR_TIMEOUT = 5000;
+}
+export namespace Utils {
+    export const validateNumericalInputs = (e: React.ChangeEvent<HTMLInputElement>, allowNegative = true): void => {
+        const toReplace = allowNegative ? /[^\d-]/g : /[^\d]/g;
+        e.target.value = e.target.value.replace(toReplace, '');
+    };
+
+    export const isPrintableAsAscii = (byte: number): boolean => byte >= 32 && byte < (128 - 1);
+}
+
+export namespace Interfaces {
+    export interface MemoryReadResult {
+        bytes: LabeledUint8Array;
+        address: Long;
+    }
+    export interface WidgetMemoryState extends MemoryReadResult {
+        variables: VariableRange[];
+    }
+
+    export interface MemoryOptions {
+        address: string | number;
+        offset: number;
+        length: number;
+        byteSize: number;
+        bytesPerGroup: number;
+        groupsPerRow: number;
+        endianness: Endianness;
+        doDisplaySettings: boolean;
+        doUpdateAutomatically: boolean;
+        columnsDisplayed: ColumnsDisplayed;
+        recentLocationsArray: string[];
+        isFrozen: boolean;
+    }
+    export interface MoreMemoryOptions {
+        numBytes: number;
+        direction: 'above' | 'below';
+    }
+
+    export enum Endianness {
+        Little = 'Little Endian',
+        Big = 'Big Endian'
+    }
+    export interface LabeledUint8Array extends Uint8Array {
+        label?: string;
+    }
+
+    export interface StylableNodeAttributes {
+        className?: string;
+        style?: React.CSSProperties;
+        variable?: VariableDecoration;
+        title?: string;
+        isHighlighted?: boolean;
+    }
+
+    export interface FullNodeAttributes extends StylableNodeAttributes {
+        content: string;
+    }
+
+    export interface BitDecorator {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        (...args: any[]): Partial<FullNodeAttributes>;
+    }
+    export interface RowDecorator {
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        (...args: any[]): Partial<StylableNodeAttributes>;
+    }
+    export interface ByteFromChunkData {
+        address: Long;
+        /**
+         * A single eight-bit byte
+         */
+        value: string;
+    }
+
+    export interface Column {
+        label: string;
+        doRender: boolean;
+    }
+
+    export interface ColumnIDs {
+        label: string;
+        id: string;
+    }
+
+    export interface ColumnsDisplayed {
+        [id: string]: Column;
+    }
+}
+
+export const MemoryWidgetOptions = Symbol('MemoryWidgetOptions');
+export interface MemoryWidgetOptions {
+    identifier: string | number;
+    displayId?: string | number;
+    dynamic?: boolean;
+}
+
+export const MemoryDiffWidgetData = Symbol('MemoryDiffWidgetData');
+export interface MemoryDiffWidgetData extends MemoryWidgetOptions {
+    beforeAddress: Long;
+    beforeBytes: Interfaces.LabeledUint8Array;
+    beforeVariables: VariableRange[];
+    afterAddress: Long;
+    afterBytes: Interfaces.LabeledUint8Array;
+    afterVariables: VariableRange[];
+    dynamic: false;
+    titles: [string, string];
+}
+
+export const RegisterWidgetOptions = Symbol('RegisterWidgetData');
+export type RegisterWidgetOptions = MemoryWidgetOptions;