Make memory address padding configurable (#89)

Introduces VS Code setting for memory address padding with the values * Unpadded * Minimal padding * 32 bit padding * 64 bit padding Fixes #76 --------- Co-authored-by: Martin Fleck <[email protected]>
eclipse-cdt-cloud · Mar 6, 2024 · 7416dc9 · 7416dc9
1 parent 7b4c3bf
commit 7416dc9
Show file tree

Hide file tree

Showing 10 changed files with 106 additions and 15 deletions.
diff --git a/package.json b/package.json
@@ -184,7 +184,10 @@
           "description": "Default words per group"
         },
         "memory-inspector.groupings.groupsPerRow": {
-          "type": ["string", "number"],
+          "type": [
+            "string",
+            "number"
+          ],
           "enum": [
             "Autofit",
             1,
@@ -220,6 +223,23 @@
           ],
           "description": "Behavior when adding more memory beyond the current view."
         },
+        "memory-inspector.addressPadding": {
+          "type": "string",
+          "enum": [
+            "Minimal",
+            "Unpadded",
+            "32bit",
+            "64bit"
+          ],
+          "default": "Minimal",
+          "enumDescriptions": [
+            "Pads to largest address width in loaded range.",
+            "Disables padding.",
+            "Pads to 32 bits.",
+            "Pads to 64 bits."
+          ],
+          "description": "Controls the padding with 0s for memory addresses, enhancing readability by aligning them within a specified bit-width context."
+        },
         "memory-inspector.addressRadix": {
           "type": "number",
           "enum": [

diff --git a/src/common/memory-range.ts b/src/common/memory-range.ts
@@ -85,11 +85,14 @@ export function getRadixMarker(radix: Radix): string {
     return radixPrefixMap[radix];
 }
 
-export function getAddressString(address: bigint, radix: Radix, architecture: Architecture = 32, addPadding = false): string {
-    const paddedLength = addPadding ? Math.ceil(architecture / Math.log2(radix)) : 0;
+export function getAddressString(address: bigint, radix: Radix, paddedLength: number = 0): string {
     return address.toString(radix).padStart(paddedLength, '0');
 }
 
+export function getAddressLength(padding: number, radix: Radix): number {
+    return Math.ceil(padding / Math.log2(radix));
+}
+
 export function toHexStringWithRadixMarker(target: bigint): string {
     return `${getRadixMarker(Radix.Hexadecimal)}${getAddressString(target, Radix.Hexadecimal)}`;
 }

diff --git a/src/plugin/manifest.ts b/src/plugin/manifest.ts
@@ -48,6 +48,8 @@ export const DEFAULT_GROUPS_PER_ROW: GroupsPerRowOption = 4;
 // Scroll
 export const CONFIG_SCROLLING_BEHAVIOR = 'scrollingBehavior';
 export const DEFAULT_SCROLLING_BEHAVIOR = 'Paginate';
+export const CONFIG_ADDRESS_PADDING = 'addressPadding';
+export const DEFAULT_ADDRESS_PADDING = 'Minimal';
 export const CONFIG_ADDRESS_RADIX = 'addressRadix';
 export const DEFAULT_ADDRESS_RADIX = 16;
 export const CONFIG_SHOW_RADIX_PREFIX = 'showRadixPrefix';

diff --git a/src/plugin/memory-webview-main.ts b/src/plugin/memory-webview-main.ts
@@ -35,7 +35,7 @@ import {
 import { MemoryProvider } from './memory-provider';
 import { outputChannelLogger } from './logger';
 import { VariableRange } from '../common/memory-range';
-import { MemoryViewSettings, ScrollingBehavior } from '../webview/utils/view-types';
+import { AddressPaddingOptions, MemoryViewSettings, ScrollingBehavior } from '../webview/utils/view-types';
 
 interface Variable {
     name: string;
@@ -225,9 +225,10 @@ export class MemoryWebview implements vscode.CustomReadonlyEditorProvider {
         const visibleColumns = CONFIGURABLE_COLUMNS
             .filter(column => vscode.workspace.getConfiguration(manifest.PACKAGE_NAME).get<boolean>(column, false))
             .map(columnId => columnId.replace('columns.', ''));
+        const addressPadding = AddressPaddingOptions[memoryInspectorConfiguration.get(manifest.CONFIG_ADDRESS_PADDING, manifest.DEFAULT_ADDRESS_PADDING)];
         const addressRadix = memoryInspectorConfiguration.get<number>(manifest.CONFIG_ADDRESS_RADIX, manifest.DEFAULT_ADDRESS_RADIX);
         const showRadixPrefix = memoryInspectorConfiguration.get<boolean>(manifest.CONFIG_SHOW_RADIX_PREFIX, manifest.DEFAULT_SHOW_RADIX_PREFIX);
-        return { title, bytesPerWord, wordsPerGroup, groupsPerRow, scrollingBehavior, visibleColumns, addressRadix, showRadixPrefix };
+        return { title, bytesPerWord, wordsPerGroup, groupsPerRow, scrollingBehavior, visibleColumns, addressPadding, addressRadix, showRadixPrefix };
     }
 
     protected async readMemory(request: DebugProtocol.ReadMemoryArguments): Promise<MemoryReadResult> {

diff --git a/src/webview/columns/address-column.tsx b/src/webview/columns/address-column.tsx
@@ -16,8 +16,8 @@
 
 import React, { ReactNode } from 'react';
 import { BigIntMemoryRange, getAddressString, getRadixMarker } from '../../common/memory-range';
-import { ColumnContribution, ColumnFittingType } from './column-contribution-service';
-import { Memory, MemoryDisplayConfiguration } from '../utils/view-types';
+import { ColumnContribution, ColumnFittingType, TableRenderOptions } from './column-contribution-service';
+import { Memory } from '../utils/view-types';
 
 export class AddressColumn implements ColumnContribution {
     static ID = 'address';
@@ -28,10 +28,10 @@ export class AddressColumn implements ColumnContribution {
 
     fittingType: ColumnFittingType = 'content-width';
 
-    render(range: BigIntMemoryRange, _: Memory, options: MemoryDisplayConfiguration): ReactNode {
+    render(range: BigIntMemoryRange, _: Memory, options: TableRenderOptions): ReactNode {
         return <span className='memory-start-address'>
             {options.showRadixPrefix && <span className='radix-prefix'>{getRadixMarker(options.addressRadix)}</span>}
-            <span className='address'>{getAddressString(range.startAddress, options.addressRadix)}</span>
+            <span className='address'>{getAddressString(range.startAddress, options.addressRadix, options.effectiveAddressLength)}</span>
         </span>;
     }
 }
diff --git a/src/webview/components/memory-table.tsx b/src/webview/components/memory-table.tsx
@@ -101,6 +101,7 @@ interface MemoryTableProps extends TableRenderOptions, MemoryDisplayConfiguratio
     decorations: Decoration[];
     offset: number;
     count: number;
+    effectiveAddressLength: number;
     fetchMemory(partialOptions?: Partial<DebugProtocol.ReadMemoryArguments>): Promise<void>;
     isMemoryFetching: boolean;
     isFrozen: boolean;

diff --git a/src/webview/components/memory-widget.tsx b/src/webview/components/memory-widget.tsx
@@ -29,6 +29,7 @@ interface MemoryWidgetProps extends MemoryDisplayConfiguration {
     memoryReference: string;
     offset: number;
     count: number;
+    effectiveAddressLength: number;
     isMemoryFetching: boolean;
     refreshMemory: () => void;
     updateMemoryArguments: (memoryArguments: Partial<DebugProtocol.ReadMemoryArguments>) => void;
@@ -72,6 +73,7 @@ export class MemoryWidget extends React.Component<MemoryWidgetProps, MemoryWidge
                 updateRenderOptions={this.props.updateMemoryDisplayConfiguration}
                 resetRenderOptions={this.props.resetMemoryDisplayConfiguration}
                 refreshMemory={this.props.refreshMemory}
+                addressPadding={this.props.addressPadding}
                 addressRadix={this.props.addressRadix}
                 showRadixPrefix={this.props.showRadixPrefix}
                 toggleColumn={this.props.toggleColumn}
@@ -88,9 +90,11 @@ export class MemoryWidget extends React.Component<MemoryWidgetProps, MemoryWidge
                 groupsPerRow={this.props.groupsPerRow}
                 offset={this.props.offset}
                 count={this.props.count}
+                effectiveAddressLength={this.props.effectiveAddressLength}
                 fetchMemory={this.props.fetchMemory}
                 isMemoryFetching={this.props.isMemoryFetching}
                 scrollingBehavior={this.props.scrollingBehavior}
+                addressPadding={this.props.addressPadding}
                 addressRadix={this.props.addressRadix}
                 showRadixPrefix={this.props.showRadixPrefix}
                 isFrozen={this.props.isFrozen}

diff --git a/src/webview/components/options-widget.tsx b/src/webview/components/options-widget.tsx
@@ -23,16 +23,14 @@ import { OverlayPanel } from 'primereact/overlaypanel';
 import { classNames } from 'primereact/utils';
 import React, { FocusEventHandler, KeyboardEvent, KeyboardEventHandler, MouseEventHandler } from 'react';
 import { TableRenderOptions } from '../columns/column-contribution-service';
-import {
-    SerializedTableRenderOptions,
-} from '../utils/view-types';
+import { AddressPaddingOptions, SerializedTableRenderOptions } from '../utils/view-types';
 import { MultiSelectWithLabel } from './multi-select';
 import { CONFIG_BYTES_PER_WORD_CHOICES, CONFIG_GROUPS_PER_ROW_CHOICES, CONFIG_WORDS_PER_GROUP_CHOICES } from '../../plugin/manifest';
 import { tryToNumber } from '../../common/typescript';
 import { Checkbox } from 'primereact/checkbox';
 
 export interface OptionsWidgetProps
-    extends Omit<TableRenderOptions, 'scrollingBehavior'>,
+    extends Omit<TableRenderOptions, 'scrollingBehavior' | 'effectiveAddressLength'>,
     Required<DebugProtocol.ReadMemoryArguments> {
     title: string;
     updateRenderOptions: (options: Partial<SerializedTableRenderOptions>) => void;
@@ -58,6 +56,7 @@ const enum InputId {
     BytesPerWord = 'word-size',
     WordsPerGroup = 'words-per-group',
     GroupsPerRow = 'groups-per-row',
+    AddressPadding = 'address-padding',
     AddressRadix = 'address-radix',
     ShowRadixPrefix = 'show-radix-prefix',
 }
@@ -321,6 +320,20 @@ export class OptionsWidget extends React.Component<OptionsWidgetProps, OptionsWi
                                 className='advanced-options-dropdown' />
 
                             <h2>Address Format</h2>
+
+                            <label
+                                htmlFor={InputId.AddressPadding}
+                                className='advanced-options-label'
+                            >
+                                Address Padding
+                            </label>
+                            <Dropdown
+                                id={InputId.AddressPadding}
+                                value={this.props.addressPadding}
+                                onChange={this.handleAdvancedOptionsDropdownChange}
+                                options={Object.entries(AddressPaddingOptions).map(([label, value]) => ({ label, value }))}
+                                className="advanced-options-dropdown" />
+
                             <label
                                 htmlFor={InputId.AddressRadix}
                                 className='advanced-options-label'
@@ -416,6 +429,9 @@ export class OptionsWidget extends React.Component<OptionsWidgetProps, OptionsWi
             case InputId.GroupsPerRow:
                 this.props.updateRenderOptions({ groupsPerRow: tryToNumber(value) ?? value });
                 break;
+            case InputId.AddressPadding:
+                this.props.updateRenderOptions({ addressPadding: value });
+                break;
             case InputId.AddressRadix:
                 this.props.updateRenderOptions({ addressRadix: Number(value) });
                 break;

diff --git a/src/webview/memory-webview-view.tsx b/src/webview/memory-webview-view.tsx
@@ -38,9 +38,11 @@ import { AddressColumn } from './columns/address-column';
 import { DataColumn } from './columns/data-column';
 import { PrimeReactProvider } from 'primereact/api';
 import 'primeflex/primeflex.css';
+import { getAddressLength, getAddressString } from '../common/memory-range';
 
 export interface MemoryAppState extends MemoryState, MemoryDisplayConfiguration {
     title: string;
+    effectiveAddressLength: number;
     decorations: Decoration[];
     columns: ColumnStatus[];
     isFrozen: boolean;
@@ -51,6 +53,7 @@ const MEMORY_DISPLAY_CONFIGURATION_DEFAULTS: MemoryDisplayConfiguration = {
     wordsPerGroup: 1,
     groupsPerRow: 4,
     scrollingBehavior: 'Paginate',
+    addressPadding: 'Min',
     addressRadix: 16,
     showRadixPrefix: true,
 };
@@ -70,6 +73,7 @@ class App extends React.Component<{}, MemoryAppState> {
             memoryReference: '',
             offset: 0,
             count: 256,
+            effectiveAddressLength: 0,
             decorations: [],
             columns: columnContributionService.getColumns(),
             isMemoryFetching: false,
@@ -91,6 +95,18 @@ class App extends React.Component<{}, MemoryAppState> {
         messenger.sendNotification(readyType, HOST_EXTENSION, undefined);
     }
 
+    public componentDidUpdate(_: {}, prevState: MemoryAppState): void {
+        const addressPaddingNeedsUpdate =
+            (this.state.addressPadding === 'Min' && this.state.memory !== prevState.memory)
+            || this.state.addressPadding !== prevState.addressPadding;
+        if (addressPaddingNeedsUpdate) {
+            const effectiveAddressLength = this.getEffectiveAddressLength(this.state.memory);
+            if (this.state.effectiveAddressLength !== effectiveAddressLength) {
+                this.setState({ effectiveAddressLength });
+            }
+        }
+    }
+
     public render(): React.ReactNode {
         return <PrimeReactProvider>
             <MemoryWidget
@@ -101,6 +117,7 @@ class App extends React.Component<{}, MemoryAppState> {
                 offset={this.state.offset ?? 0}
                 count={this.state.count}
                 title={this.state.title}
+                effectiveAddressLength={this.state.effectiveAddressLength}
                 updateMemoryArguments={this.updateMemoryState}
                 updateMemoryDisplayConfiguration={this.updateMemoryDisplayConfiguration}
                 resetMemoryDisplayConfiguration={this.resetMemoryDisplayConfiguration}
@@ -115,6 +132,7 @@ class App extends React.Component<{}, MemoryAppState> {
                 groupsPerRow={this.state.groupsPerRow}
                 wordsPerGroup={this.state.wordsPerGroup}
                 scrollingBehavior={this.state.scrollingBehavior}
+                addressPadding={this.state.addressPadding}
                 addressRadix={this.state.addressRadix}
                 showRadixPrefix={this.state.showRadixPrefix}
             />
@@ -156,9 +174,11 @@ class App extends React.Component<{}, MemoryAppState> {
                 executor => executor.fetchData(completeOptions)
             ));
 
+            const memory = this.convertMemory(response);
+
             this.setState({
                 decorations: decorationService.decorations,
-                memory: this.convertMemory(response),
+                memory,
                 memoryReference: completeOptions.memoryReference,
                 offset: completeOptions.offset,
                 count: completeOptions.count,
@@ -179,6 +199,21 @@ class App extends React.Component<{}, MemoryAppState> {
         return { bytes, address };
     }
 
+    protected getEffectiveAddressLength(memory?: Memory): number {
+        const { addressRadix, addressPadding } = this.state;
+        return addressPadding === 'Min' ? this.getLastAddressLength(memory) : getAddressLength(addressPadding, addressRadix);
+    }
+
+    protected getLastAddressLength(memory?: Memory): number {
+        if (memory === undefined || this.state.groupsPerRow === 'Autofit') {
+            return 0;
+        }
+        const rowLength = this.state.bytesPerWord * this.state.wordsPerGroup * this.state.groupsPerRow;
+        const rows = Math.ceil(memory.bytes.length / rowLength);
+        const finalAddress = memory.address + BigInt(((rows - 1) * rowLength));
+        return getAddressString(finalAddress, this.state.addressRadix).length;
+    }
+
     protected toggleColumn = (id: string, active: boolean): void => { this.doToggleColumn(id, active); };
     protected async doToggleColumn(id: string, isVisible: boolean): Promise<void> {
         const columns = isVisible ? await columnContributionService.show(id, this.state) : columnContributionService.hide(id);

diff --git a/src/webview/utils/view-types.ts b/src/webview/utils/view-types.ts
@@ -33,7 +33,7 @@ export interface Memory {
 export interface SerializedTableRenderOptions extends MemoryDisplayConfiguration {
     columnOptions: Array<{ label: string, doRender: boolean }>;
     endianness: Endianness;
-    bytesPerWord: number;
+    effectiveAddressLength: number;
 }
 
 export interface Event<T> {
@@ -84,11 +84,20 @@ export interface MemoryDisplayConfiguration {
     wordsPerGroup: number;
     groupsPerRow: GroupsPerRowOption;
     scrollingBehavior: ScrollingBehavior;
+    addressPadding: AddressPadding;
     addressRadix: Radix;
     showRadixPrefix: boolean;
 }
 export type ScrollingBehavior = 'Paginate' | 'Infinite';
 
+export type AddressPadding = 'Min' | number;
+export const AddressPaddingOptions = {
+    'Minimal': 'Min',
+    'Unpadded': 0,
+    '32bit': 32,
+    '64bit': 64,
+} as const;
+
 export interface ColumnVisibilityStatus {
     visibleColumns: string[];
 }