memory-webview-view.tsx

/********************************************************************************
 * Copyright (C) 2022 Ericsson, Arm 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 'primeflex/primeflex.css';

import { debounce } from 'lodash';
import { PrimeReactProvider } from 'primereact/api';
import React from 'react';
import { createRoot } from 'react-dom/client';
import { HOST_EXTENSION, WebviewIdMessageParticipant } from 'vscode-messenger-common';
import * as manifest from '../common/manifest';
import { createMemoryFromRead, Memory } from '../common/memory';
import { BigIntMemoryRange, doOverlap, getAddressLength, getAddressString, WrittenMemory } from '../common/memory-range';
import {
    applyMemoryType,
    getWebviewSelectionType,
    logMessageType,
    MemoryOptions,
    memoryWrittenType,
    ReadMemoryArguments,
    readMemoryType,
    readyType,
    resetMemoryViewSettingsType,
    SessionContext,
    sessionContextChangedType,
    setMemoryViewSettingsType,
    setOptionsType,
    setTitleType,
    showAdvancedOptionsType,
    storeMemoryType,
    ViewState,
    viewStateChangedType,
    WebviewSelection,
} from '../common/messaging';
import { Change, hasChanged, hasChangedTo } from '../common/typescript';
import { MemoryDisplayConfiguration } from '../common/webview-configuration';
import { AddressColumn } from './columns/address-column';
import { AsciiColumn } from './columns/ascii-column';
import { columnContributionService, ColumnStatus } from './columns/column-contribution-service';
import { DataColumn } from './columns/data-column';
import { MemoryWidget } from './components/memory-widget';
import { decorationService } from './decorations/decoration-service';
import { AddressHover } from './hovers/address-hover';
import { DataHover } from './hovers/data-hover';
import { HoverService, hoverService } from './hovers/hover-service';
import { VariableHover } from './hovers/variable-hover';
import { Decoration, MemoryState } from './utils/view-types';
import { variableDecorator } from './variables/variable-decorations';
import { messenger } from './view-messenger';

export interface MemoryAppState extends MemoryState, MemoryDisplayConfiguration {
    messageParticipant: WebviewIdMessageParticipant;
    title: string;
    viewState: ViewState;
    sessionContext: SessionContext;
    effectiveAddressLength: number;
    decorations: Decoration[];
    hoverService: HoverService;
    columns: ColumnStatus[];
    isFrozen: boolean;
}

export const DEFAULT_SESSION_CONTEXT: SessionContext = {
    canRead: false,
    canWrite: false
};

export const DEFAULT_VIEW_STATE: ViewState = {
    active: false,
    visible: false
};

export const DEFAULT_MEMORY_DISPLAY_CONFIGURATION: MemoryDisplayConfiguration = {
    bytesPerMau: manifest.DEFAULT_BYTES_PER_MAU,
    mausPerGroup: manifest.DEFAULT_MAUS_PER_GROUP,
    groupsPerRow: manifest.DEFAULT_GROUPS_PER_ROW,
    endianness: manifest.DEFAULT_ENDIANNESS,
    scrollingBehavior: manifest.DEFAULT_SCROLLING_BEHAVIOR,
    addressPadding: manifest.DEFAULT_ADDRESS_PADDING,
    addressRadix: manifest.DEFAULT_ADDRESS_RADIX,
    showRadixPrefix: manifest.DEFAULT_SHOW_RADIX_PREFIX,
    autoRefresh: manifest.DEFAULT_AUTO_REFRESH,
    autoRefreshDelay: manifest.DEFAULT_AUTO_REFRESH_DELAY
};

export const DEFAULT_READ_ARGUMENTS: Required<ReadMemoryArguments> = {
    memoryReference: '',
    offset: 0,
    count: 256,
};

class App extends React.Component<{}, MemoryAppState> {
    protected memoryWidget = React.createRef<MemoryWidget>();
    protected refreshTimer?: NodeJS.Timeout | number;

    public constructor(props: {}) {
        super(props);
        columnContributionService.register(new AddressColumn(), false);
        columnContributionService.register(new DataColumn(), false);
        columnContributionService.register(variableDecorator);
        columnContributionService.register(new AsciiColumn());
        decorationService.register(variableDecorator);
        hoverService.register(new AddressHover());
        hoverService.register(new DataHover());
        hoverService.register(new VariableHover());
        this.state = {
            messageParticipant: { type: 'webview', webviewId: '' },
            title: 'Memory',
            viewState: DEFAULT_VIEW_STATE,
            sessionContext: DEFAULT_SESSION_CONTEXT,
            memory: undefined,
            effectiveAddressLength: 0,
            configuredReadArguments: DEFAULT_READ_ARGUMENTS,
            activeReadArguments: DEFAULT_READ_ARGUMENTS,
            decorations: [],
            hoverService: hoverService,
            columns: columnContributionService.getColumns(),
            isMemoryFetching: false,
            isFrozen: false,
            ...DEFAULT_MEMORY_DISPLAY_CONFIGURATION
        };
    }

    public componentDidMount(): void {
        messenger.onRequest(setOptionsType, options => this.setOptions(options));
        messenger.onNotification(memoryWrittenType, writtenMemory => this.memoryWritten(writtenMemory));
        messenger.onNotification(sessionContextChangedType, sessionContext => this.sessionContextChanged(sessionContext));
        messenger.onNotification(viewStateChangedType, viewState => this.viewStateChanged(viewState));
        messenger.onNotification(setMemoryViewSettingsType, config => {
            if (config.visibleColumns) {
                for (const column of columnContributionService.getColumns()) {
                    const id = column.contribution.id;
                    const configurable = column.configurable;
                    this.toggleColumn(id, !configurable || config.visibleColumns.includes(id));
                }
            }
            this.setState(prevState => ({ ...prevState, ...config, title: config.title ?? prevState.title, }));
        });
        messenger.onRequest(getWebviewSelectionType, () => this.getWebviewSelection());
        messenger.onNotification(showAdvancedOptionsType, () => this.showAdvancedOptions());
        messenger.sendNotification(readyType, HOST_EXTENSION, undefined);
        this.updateAutoRefresh();
    }

    public componentDidUpdate(_: {}, from: MemoryAppState): void {
        const current = this.state;
        const stateChange: Change<MemoryAppState> = { from, to: current };
        const sessionContextChange: Change<SessionContext> = { from: from.sessionContext, to: current.sessionContext };
        const viewStateChange: Change<ViewState> = { from: from.viewState, to: current.viewState };

        if (hasChanged(stateChange, 'addressPadding') || (this.state.addressPadding === 'Minimal' && hasChanged(stateChange, 'memory'))) {
            const effectiveAddressLength = this.getEffectiveAddressLength(this.state.memory);
            if (this.state.effectiveAddressLength !== effectiveAddressLength) {
                this.setState({ effectiveAddressLength });
            }
        }
        if (hasChanged(stateChange, 'autoRefresh') || hasChanged(stateChange, 'autoRefreshDelay')) {
            this.updateAutoRefresh();
        }

        if (current.autoRefresh === 'On Stop' && hasChangedTo(sessionContextChange, 'stopped', true) ||
            current.autoRefresh === 'On Focus' && hasChangedTo(viewStateChange, 'active', true)) {
            this.fetchMemory();
        }

        hoverService.setMemoryState(this.state);
    }

    componentWillUnmount(): void {
        clearTimeout(this.refreshTimer);
    }

    protected updateAutoRefresh = (): void => {
        clearTimeout(this.refreshTimer);

        if (this.state.autoRefresh === 'After Delay' && this.state.autoRefreshDelay && this.state.autoRefreshDelay > 0) {
            // we do not use an interval here as we only want to schedule another refresh AFTER the previous execution AND the delay has passed
            // and not strictly every n milliseconds. Even if 'fetchMemory' fails here, we schedule another auto-refresh.
            const scheduleRefresh = () => this.fetchMemory().finally(() => this.updateAutoRefresh());
            this.refreshTimer = setTimeout(scheduleRefresh, this.state.autoRefreshDelay);
        }
    };

    // use a slight debounce as the same event may come in short succession
    protected memoryWritten = debounce((writtenMemory: WrittenMemory): void => {
        if (!this.state.memory) {
            return;
        }
        if (this.state.activeReadArguments.memoryReference === writtenMemory.memoryReference) {
            // catch simple case
            this.fetchMemory();
            return;
        }
        try {
            // If we are dealing with numeric addresses (and not expressions) then we can determine the overlap.
            // Note that we use big int arithmetic here to determine the overlap for (start address + length) vs (memory state address + length), i.e.,
            // we do not actually determine the end address may need to consider the size of a MAU in bytes
            const written: BigIntMemoryRange = {
                startAddress: BigInt(writtenMemory.memoryReference),
                endAddress: BigInt(writtenMemory.memoryReference) + BigInt(writtenMemory.count ?? 0)
            };
            const shown: BigIntMemoryRange = {
                startAddress: this.state.memory.address,
                endAddress: this.state.memory.address + BigInt(this.state.memory.bytes.length)
            };
            if (doOverlap(written, shown)) {
                this.fetchMemory();
                return;
            }
        } catch (error) {
            // ignore and fall through
        }

        // we could try to convert any expression we may have to an address by sending an evaluation request to the DA
        // but for now we just go with a pessimistic approach: if we are unsure, we refresh the memory
        this.fetchMemory();
    }, 100);

    protected sessionContextChanged(sessionContext: SessionContext): void {
        this.setState({ sessionContext });
    }

    protected viewStateChanged(viewState: ViewState): void {
        this.setState({ viewState });
    }

    public render(): React.ReactNode {
        return <PrimeReactProvider>
            <MemoryWidget
                ref={this.memoryWidget}
                messageParticipant={this.state.messageParticipant}
                sessionContext={this.state.sessionContext}
                configuredReadArguments={this.state.configuredReadArguments}
                activeReadArguments={this.state.activeReadArguments}
                memory={this.state.memory}
                decorations={this.state.decorations}
                hoverService={this.state.hoverService}
                columns={this.state.columns}
                title={this.state.title}
                effectiveAddressLength={this.state.effectiveAddressLength}
                updateMemoryState={this.updateMemoryState}
                updateMemoryDisplayConfiguration={this.updateMemoryDisplayConfiguration}
                resetMemoryDisplayConfiguration={this.resetMemoryDisplayConfiguration}
                updateTitle={this.updateTitle}
                toggleColumn={this.toggleColumn}
                toggleFrozen={this.toggleFrozen}
                isFrozen={this.state.isFrozen}
                fetchMemory={this.fetchMemory}
                isMemoryFetching={this.state.isMemoryFetching}
                bytesPerMau={this.state.bytesPerMau}
                groupsPerRow={this.state.groupsPerRow}
                endianness={this.state.endianness}
                mausPerGroup={this.state.mausPerGroup}
                scrollingBehavior={this.state.scrollingBehavior}
                addressPadding={this.state.addressPadding}
                addressRadix={this.state.addressRadix}
                showRadixPrefix={this.state.showRadixPrefix}
                storeMemory={this.storeMemory}
                applyMemory={this.applyMemory}
                autoRefresh={this.state.autoRefresh}
                autoRefreshDelay={this.state.autoRefreshDelay}
            />
        </PrimeReactProvider>;
    }

    protected updateMemoryState = (newState?: Partial<MemoryState>) => this.setState(prevState => ({ ...prevState, ...newState }));
    protected updateMemoryDisplayConfiguration = (newState: Partial<MemoryDisplayConfiguration>) => this.setState(prevState => ({ ...prevState, ...newState }));
    protected resetMemoryDisplayConfiguration = () => messenger.sendNotification(resetMemoryViewSettingsType, HOST_EXTENSION, undefined);

    protected updateTitle = (title: string) => {
        this.setState({ title });
        messenger.sendNotification(setTitleType, HOST_EXTENSION, title);
    };

    protected async setOptions(options?: MemoryOptions): Promise<void> {
        messenger.sendRequest(logMessageType, HOST_EXTENSION, `Setting options: ${JSON.stringify(options)}`);
        this.setState({ configuredReadArguments: { ...this.state.configuredReadArguments, ...options } });
        return this.fetchMemory(options);
    }

    protected fetchMemory = async (partialOptions?: MemoryOptions): Promise<void> => {
        if (this.state.isFrozen || !this.state.sessionContext.canRead) {
            return;
        }
        const completeOptions = {
            memoryReference: partialOptions?.memoryReference || this.state.activeReadArguments.memoryReference,
            offset: partialOptions?.offset ?? this.state.activeReadArguments.offset,
            count: partialOptions?.count ?? this.state.activeReadArguments.count
        };
        if (completeOptions.memoryReference === '') {
            // may happen when we initialize empty
            return;
        }
        return this.doFetchMemory(completeOptions);
    };

    protected async doFetchMemory(memoryOptions: Required<MemoryOptions>): Promise<void> {
        this.setState({ isMemoryFetching: true, activeReadArguments: memoryOptions });
        try {
            const response = await messenger.sendRequest(readMemoryType, HOST_EXTENSION, memoryOptions);
            await Promise.all(Array.from(
                new Set(columnContributionService.getUpdateExecutors().concat(decorationService.getUpdateExecutors())),
                executor => executor.fetchData(memoryOptions)
            ));

            const memory = createMemoryFromRead(response);
            this.setState({ memory, decorations: decorationService.decorations });
            messenger.sendRequest(setOptionsType, HOST_EXTENSION, memoryOptions);
        } catch (ex) {
            // Do not show old results if the current search provided no memory
            this.setState({ memory: undefined });

            if (ex instanceof Error) {
                console.error(ex);
            }
        } finally {
            this.setState({ isMemoryFetching: false });
        }

    }

    protected getEffectiveAddressLength(memory?: Memory): number {
        const { addressRadix, addressPadding } = this.state;
        return addressPadding === 'Minimal' ? this.getLastAddressLength(memory) : getAddressLength(addressPadding, addressRadix);
    }

    protected getLastAddressLength(memory?: Memory): number {
        if (memory === undefined || this.state.groupsPerRow === 'Autofit') {
            return 0;
        }
        const rowLength = this.state.bytesPerMau * this.state.mausPerGroup * 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);
        this.setState({ columns });
    }

    protected toggleFrozen = (): void => { this.doToggleFrozen(); };
    protected doToggleFrozen(): void {
        this.setState(prevState => ({ isFrozen: !prevState.isFrozen }));
    }

    protected showAdvancedOptions(): void {
        this.memoryWidget.current?.showAdvancedOptions();
    }

    protected getWebviewSelection(): WebviewSelection {
        return this.memoryWidget.current?.getWebviewSelection() ?? {};
    }

    protected storeMemory = async (): Promise<void> => {
        await messenger.sendRequest(storeMemoryType, HOST_EXTENSION, { ...this.state.activeReadArguments });
    };

    protected applyMemory = async (): Promise<void> => {
        await messenger.sendRequest(applyMemoryType, HOST_EXTENSION, undefined);
    };
}

const container = document.getElementById('root') as Element;
createRoot(container).render(<App />);