Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow memory display configuration per memory view instance #64

Merged
merged 3 commits into from
Feb 19, 2024
Merged

Allow memory display configuration per memory view instance #64

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
814a9fd
Allow memory display configuration per memory view instance
planger Feb 8, 2024
b2f6bc0
Address minor comments of review
planger Feb 14, 2024
97d1863
Refactor column visibility status
planger Feb 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions media/options-widget.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,3 +69,12 @@
width: 100%;
font-weight: bold;
}

.reset-advanced-options-icon {
position: absolute;
top: 12px;
right: 12px;
border: none;
background-color: transparent;
cursor: pointer;
}
7 changes: 3 additions & 4 deletions src/common/messaging.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,17 +16,16 @@

import type { DebugProtocol } from '@vscode/debugprotocol';
import type { NotificationType, RequestType } from 'vscode-messenger-common';
import { MemoryDisplayConfiguration } from '../webview/utils/view-types';
import type { VariableRange } from './memory-range';
import { ColumnVisibilityStatus, MemoryDisplayConfiguration, MemoryDisplayConfigurationChangeRequest } from '../webview/utils/view-types';

export type MemoryReadResult = DebugProtocol.ReadMemoryResponse['body'];
export type MemoryWriteResult = DebugProtocol.WriteMemoryResponse['body'];

export const readyType: NotificationType<void> = { method: 'ready' };
export const logMessageType: RequestType<string, void> = { method: 'logMessage' };
export const setMemoryDisplayConfigurationType: NotificationType<MemoryDisplayConfigurationChangeRequest> = { method: 'setMemoryDisplayConfiguration' };
export const memoryDisplayConfigurationChangedType: NotificationType<MemoryDisplayConfiguration> = { method: 'memoryDisplayConfigurationChanged' };
export const columnVisibilityType: NotificationType<ColumnVisibilityStatus> = { method: 'columnVisibility' };
export const setMemoryDisplayConfigurationType: NotificationType<Partial<MemoryDisplayConfiguration>> = { method: 'setMemoryDisplayConfiguration' };
export const resetMemoryDisplayConfigurationType: NotificationType<void> = { method: 'resetMemoryDisplayConfiguration' };
export const setOptionsType: RequestType<Partial<DebugProtocol.ReadMemoryArguments | undefined>, void> = { method: 'setOptions' };
export const readMemoryType: RequestType<DebugProtocol.ReadMemoryArguments, MemoryReadResult> = { method: 'readMemory' };
export const writeMemoryType: RequestType<DebugProtocol.WriteMemoryArguments, MemoryWriteResult> = { method: 'writeMemory' };
Expand Down
96 changes: 30 additions & 66 deletions src/plugin/memory-webview-main.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,28 +14,27 @@
* SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
********************************************************************************/

import * as vscode from 'vscode';
import type { DebugProtocol } from '@vscode/debugprotocol';
import * as manifest from './manifest';
import * as vscode from 'vscode';
import { Messenger } from 'vscode-messenger';
import { MessageParticipant, WebviewIdMessageParticipant } from 'vscode-messenger-common';
import { WebviewIdMessageParticipant } from 'vscode-messenger-common';
import { VariableRange } from '../common/memory-range';
import {
readyType,
logMessageType,
setOptionsType,
readMemoryType,
writeMemoryType,
MemoryReadResult,
MemoryWriteResult,
getVariables,
memoryDisplayConfigurationChangedType,
columnVisibilityType,
logMessageType,
readMemoryType,
readyType,
resetMemoryDisplayConfigurationType,
setMemoryDisplayConfigurationType,
setOptionsType,
writeMemoryType
} from '../common/messaging';
import { MemoryProvider } from './memory-provider';
import { MemoryDisplayConfiguration, ScrollingBehavior } from '../webview/utils/view-types';
import { outputChannelLogger } from './logger';
import { VariableRange } from '../common/memory-range';
import { ColumnVisibilityStatus, MemoryDisplayConfiguration as MemoryDisplayConfiguration, ScrollingBehavior } from '../webview/utils/view-types';
import * as manifest from './manifest';
import { MemoryProvider } from './memory-provider';
colin-grant-work marked this conversation as resolved.
Show resolved Hide resolved

interface Variable {
name: string;
Expand All @@ -50,7 +49,7 @@ enum RefreshEnum {
}

const isMemoryVariable = (variable: Variable): variable is Variable => variable && !!(variable as Variable).memoryReference;
const columnConfigurations = [
const CONFIGURABLE_COLUMNS = [
manifest.CONFIG_SHOW_ASCII_COLUMN,
manifest.CONFIG_SHOW_VARIABLES_COLUMN,
];
Expand Down Expand Up @@ -135,8 +134,11 @@ export class MemoryWebview implements vscode.CustomReadonlyEditorProvider {
await this.getWebviewContent(panel);

// Sets up an event listener to listen for messages passed from the webview view context
// and executes code based on the message that is recieved
this.setWebviewMessageListener(panel, initialMemory);
// and executes code based on the message that is received
const webviewParticipant = this.setWebviewMessageListener(panel, initialMemory);

// initialize with configuration
this.setInitialConfiguration(webviewParticipant);
}

protected getRefresh(): RefreshEnum {
Expand Down Expand Up @@ -174,7 +176,7 @@ export class MemoryWebview implements vscode.CustomReadonlyEditorProvider {
`;
}

protected setWebviewMessageListener(panel: vscode.WebviewPanel, options?: Partial<DebugProtocol.ReadMemoryArguments>): void {
protected setWebviewMessageListener(panel: vscode.WebviewPanel, options?: Partial<DebugProtocol.ReadMemoryArguments>): WebviewIdMessageParticipant {
const participant = this.messenger.registerWebviewPanel(panel);

const disposables = [
Expand All @@ -188,78 +190,40 @@ export class MemoryWebview implements vscode.CustomReadonlyEditorProvider {
this.messenger.onRequest(readMemoryType, request => this.readMemory(request), { sender: participant }),
this.messenger.onRequest(writeMemoryType, request => this.writeMemory(request), { sender: participant }),
this.messenger.onRequest(getVariables, request => this.getVariables(request), { sender: participant }),
this.messenger.onNotification(setMemoryDisplayConfigurationType, request => this.setConfiguration(request), { sender: participant }),
this.messenger.onNotification(columnVisibilityType, request => this.handleColumnToggled(request), { sender: participant }),
this.messenger.onNotification(resetMemoryDisplayConfigurationType, () => this.setInitialConfiguration(participant), { sender: participant }),

this.memoryProvider.onDidStopDebug(() => {
if (this.refreshOnStop === RefreshEnum.on) {
this.refresh(participant);
}
}),
this.onMemoryDisplayConfigurationChanged(participant),
this.onColumnVisibilityConfigurationChanged(participant),
];
panel.onDidChangeViewState(newState => {
if (newState.webviewPanel.visible) {
this.refresh(participant, options);
}
});
panel.onDidDispose(() => disposables.forEach(disposible => disposible.dispose()));
}
panel.onDidDispose(() => disposables.forEach(disposable => disposable.dispose()));

protected handleColumnToggled(request: ColumnVisibilityStatus): void {
const { id, active: visible } = request;
vscode.workspace.getConfiguration(manifest.PACKAGE_NAME).update(`columns.${id}`, visible, vscode.ConfigurationTarget.Global);
return participant;
}

protected setConfiguration(request: { id: string, value: unknown }): void {
const { id, value } = request;
vscode.workspace.getConfiguration(manifest.PACKAGE_NAME).update(id, value, vscode.ConfigurationTarget.Global);
protected setInitialConfiguration(webviewParticipant: WebviewIdMessageParticipant): void {
this.messenger.sendNotification(setMemoryDisplayConfigurationType, webviewParticipant, this.getMemoryDisplayConfiguration());
}

protected async refresh(participant: WebviewIdMessageParticipant, options?: Partial<DebugProtocol.ReadMemoryArguments>): Promise<void> {
this.messenger.sendRequest(setOptionsType, participant, options);
const memoryDisplayConfiguration = this.getMemoryDisplayConfiguration();
this.messenger.sendNotification(memoryDisplayConfigurationChangedType, participant, memoryDisplayConfiguration);
columnConfigurations.forEach(columnConfiguration => {
const [, id] = columnConfiguration.split('.');
const active = vscode.workspace.getConfiguration(manifest.PACKAGE_NAME).get<boolean>(columnConfiguration) ?? true;
this.messenger.sendNotification(columnVisibilityType, participant, { id, active });
});
}

protected getMemoryDisplayConfiguration(): MemoryDisplayConfiguration {
const memoryInspectorConfiguration = vscode.workspace.getConfiguration(manifest.PACKAGE_NAME);
const wordsPerGroup = memoryInspectorConfiguration.get<number>(manifest.CONFIG_WORDS_PER_GROUP) || manifest.DEFAULT_WORDS_PER_GROUP;
const groupsPerRow = memoryInspectorConfiguration.get<number>(manifest.CONFIG_GROUPS_PER_ROW) || manifest.DEFAULT_GROUPS_PER_ROW;
const scrollingBehavior = memoryInspectorConfiguration.get<ScrollingBehavior>(manifest.CONFIG_SCROLLING_BEHAVIOR) || manifest.DEFAULT_SCROLLING_BEHAVIOR;
return { wordsPerGroup, groupsPerRow, scrollingBehavior };
}

protected onMemoryDisplayConfigurationChanged(participant: MessageParticipant): vscode.Disposable {
const memoryDisplayConfigurations = [
manifest.CONFIG_WORDS_PER_GROUP,
manifest.CONFIG_GROUPS_PER_ROW,
manifest.CONFIG_SCROLLING_BEHAVIOR,
];
return vscode.workspace.onDidChangeConfiguration(e => {
if (memoryDisplayConfigurations.some(configurationOption => e.affectsConfiguration(`${manifest.PACKAGE_NAME}.${configurationOption}`))) {
const configuration = this.getMemoryDisplayConfiguration();
this.messenger.sendNotification(memoryDisplayConfigurationChangedType, participant, configuration);
}
});
}

protected onColumnVisibilityConfigurationChanged(participant: MessageParticipant): vscode.Disposable {
return vscode.workspace.onDidChangeConfiguration(e => {
columnConfigurations.forEach(configuration => {
if (e.affectsConfiguration(`${manifest.PACKAGE_NAME}.${configuration}`)) {
const [, id] = configuration.split('.');
const active = vscode.workspace.getConfiguration(manifest.PACKAGE_NAME).get<boolean>(configuration) ?? true;
this.messenger.sendNotification(columnVisibilityType, participant, { id, active });
}
});
});
const wordsPerGroup = memoryInspectorConfiguration.get<number>(manifest.CONFIG_WORDS_PER_GROUP, manifest.DEFAULT_WORDS_PER_GROUP);
const groupsPerRow = memoryInspectorConfiguration.get<number>(manifest.CONFIG_GROUPS_PER_ROW, manifest.DEFAULT_GROUPS_PER_ROW);
const scrollingBehavior = memoryInspectorConfiguration.get<ScrollingBehavior>(manifest.CONFIG_SCROLLING_BEHAVIOR, manifest.DEFAULT_SCROLLING_BEHAVIOR);
const visibleColumns = CONFIGURABLE_COLUMNS.filter(column => vscode.workspace.getConfiguration(manifest.PACKAGE_NAME).get<boolean>(column, true))
.map(columnId => columnId.replace('columns.', ''));
return { wordsPerGroup, groupsPerRow, scrollingBehavior, visibleColumns };
}

protected async readMemory(request: DebugProtocol.ReadMemoryArguments): Promise<MemoryReadResult> {
Expand Down
41 changes: 17 additions & 24 deletions src/webview/components/memory-widget.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,12 @@

import { DebugProtocol } from '@vscode/debugprotocol';
import React from 'react';
import { ColumnStatus } from '../columns/column-contribution-service';
import { Decoration, Endianness, Memory, MemoryDisplayConfiguration } from '../utils/view-types';
import { MemoryTable } from './memory-table';
import { OptionsWidget } from './options-widget';
import { Decoration, Endianness, Memory, MemoryDisplayConfiguration } from '../utils/view-types';
import { messenger } from '../view-messenger';
import { memoryDisplayConfigurationChangedType } from '../../common/messaging';
import { ColumnStatus } from '../columns/column-contribution-service';

interface MemoryWidgetProps {
interface MemoryWidgetProps extends MemoryDisplayConfiguration {
memory?: Memory;
decorations: Decoration[];
columns: ColumnStatus[];
Expand All @@ -33,21 +31,19 @@ interface MemoryWidgetProps {
isMemoryFetching: boolean;
refreshMemory: () => void;
updateMemoryArguments: (memoryArguments: Partial<DebugProtocol.ReadMemoryArguments>) => void;
toggleColumn(id: string, active: boolean): void;
updateMemoryDisplayConfiguration: (memoryArguments: Partial<MemoryDisplayConfiguration>) => void;
resetMemoryDisplayConfiguration: () => void;
fetchMemory(partialOptions?: Partial<DebugProtocol.ReadMemoryArguments>): Promise<void>
}

interface MemoryWidgetState extends MemoryDisplayConfiguration {
interface MemoryWidgetState {
endianness: Endianness;
wordSize: number;
}

const defaultOptions: MemoryWidgetState = {
endianness: Endianness.Little,
wordSize: 8,
wordsPerGroup: 1,
groupsPerRow: 4,
scrollingBehavior: 'Paginate',
wordSize: 8
};

export class MemoryWidget extends React.Component<MemoryWidgetProps, MemoryWidgetState> {
Expand All @@ -56,10 +52,6 @@ export class MemoryWidget extends React.Component<MemoryWidgetProps, MemoryWidge
this.state = { ...defaultOptions };
}

public componentDidMount(): void {
messenger.onNotification(memoryDisplayConfigurationChangedType, configuration => this.setState(configuration));
}

override render(): React.ReactNode {
return (<div className='flex flex-column h-full'>
<OptionsWidget
Expand All @@ -69,29 +61,30 @@ export class MemoryWidget extends React.Component<MemoryWidgetProps, MemoryWidge
count={this.props.count}
endianness={this.state.endianness}
wordSize={this.state.wordSize}
wordsPerGroup={this.state.wordsPerGroup}
groupsPerRow={this.state.groupsPerRow}
wordsPerGroup={this.props.wordsPerGroup}
groupsPerRow={this.props.groupsPerRow}
updateMemoryArguments={this.props.updateMemoryArguments}
updateRenderOptions={this.updateRenderOptions}
updateRenderOptions={this.props.updateMemoryDisplayConfiguration}
resetRenderOptions={this.props.resetMemoryDisplayConfiguration}
refreshMemory={this.props.refreshMemory}
toggleColumn={this.props.toggleColumn}
visibleColumns={this.props.visibleColumns}
/>
<MemoryTable
decorations={this.props.decorations}
columnOptions={this.props.columns.filter(candidate => candidate.active)}
columnOptions={this.props.columns.filter(candidate => candidate.active || this.props.visibleColumns.includes(candidate.contribution.id))}
colin-grant-work marked this conversation as resolved.
Show resolved Hide resolved
memory={this.props.memory}
endianness={this.state.endianness}
wordSize={this.state.wordSize}
wordsPerGroup={this.state.wordsPerGroup}
groupsPerRow={this.state.groupsPerRow}
wordsPerGroup={this.props.wordsPerGroup}
groupsPerRow={this.props.groupsPerRow}
offset={this.props.offset}
count={this.props.count}
fetchMemory={this.props.fetchMemory}
isMemoryFetching={this.props.isMemoryFetching}
scrollingBehavior={this.state.scrollingBehavior}
scrollingBehavior={this.props.scrollingBehavior}
visibleColumns={this.props.visibleColumns}
/>
</div>);
}

protected updateRenderOptions = (newState: Partial<MemoryWidgetState>) => this.setState(prevState => ({ ...prevState, ...newState }));
}
Loading
Loading