blob: 713b461ae43a0b2a3cf2471f35c0a185b4a17f42 [file] [log] [blame] [raw]
// Copyright (c) 2021, Compiler Explorer Authors
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
// * Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above copyright
// notice, this list of conditions and the following disclaimer in the
// documentation and/or other materials provided with the distribution.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
import _ from 'underscore';
import * as monaco from 'monaco-editor';
import { Container } from 'golden-layout';
import { Pane } from './pane';
import { BasePaneState } from './pane.interfaces';
import { RustMacroExpState } from './rustmacroexp-view.interfaces';
import { ga } from '../analytics';
import { extendConfig } from '../monaco-config';
export class RustMacroExp extends Pane<monaco.editor.IStandaloneCodeEditor, RustMacroExpState> {
constructor(hub: any, container: Container, state: RustMacroExpState & BasePaneState) {
super(hub, container, state);
if (state && state.rustMacroExpOutput) {
this.showRustMacroExpResults(state.rustMacroExpOutput);
}
}
override getInitialHTML(): string {
return $('#rustmacroexp').html();
}
override createEditor(editorRoot: HTMLElement): monaco.editor.IStandaloneCodeEditor {
return monaco.editor.create(editorRoot, extendConfig({
language: 'rust',
readOnly: true,
glyphMargin: true,
lineNumbersMinChars: 3,
}));
}
override registerOpeningAnalyticsEvent(): void {
ga.proxy('send', {
hitType: 'event',
eventCategory: 'OpenViewPane',
eventAction: 'RustMacroExp',
});
}
override getPaneName(): string {
return `Rust Macro Expansion Viewer ${this.compilerInfo.compilerName}` +
`(Editor #${this.compilerInfo.editorId}, ` +
`Compiler #${this.compilerInfo.compilerId})`;
}
override registerCallbacks(): void {
const throttleFunction = _.throttle((event) => this.onDidChangeCursorSelection(event), 500);
this.editor.onDidChangeCursorSelection((event) => throttleFunction(event));
this.eventHub.emit('rustMacroExpViewOpened', this.compilerInfo.compilerId);
this.eventHub.emit('requestSettings');
}
override onCompileResult(compilerId: number, compiler: any, result: any): void {
if (this.compilerInfo.compilerId !== compilerId) return;
if (result.hasRustMacroExpOutput) {
this.showRustMacroExpResults(result.rustMacroExpOutput);
} else if (compiler.supportsRustMacroExpView) {
this.showRustMacroExpResults([{text: '<No output>'}]);
}
}
override onCompiler(compilerId: number, compiler: any, options: any, editorId: number): void {
if (this.compilerInfo.compilerId === compilerId) {
this.compilerInfo.compilerName = compiler ? compiler.name : '';
this.compilerInfo.editorId = editorId;
this.setTitle();
if (compiler && !compiler.supportsRustMacroExpView) {
this.showRustMacroExpResults([{
text: '<Rust Macro Expansion output is not supported for this compiler>'
}]);
}
}
}
showRustMacroExpResults(result: any[]): void {
if (!this.editor) return;
this.editor.getModel().setValue(result.length
? _.pluck(result, 'text').join('\n')
: '<No Rust Macro Expansion generated>');
if (!this.isAwaitingInitialResults) {
if (this.selection) {
this.editor.setSelection(this.selection);
this.editor.revealLinesInCenter(this.selection.selectionStartLineNumber,
this.selection.endLineNumber);
}
this.isAwaitingInitialResults = true;
}
}
override close(): void {
this.eventHub.unsubscribe();
this.eventHub.emit('rustMacroExpViewClosed', this.compilerInfo.compilerId);
this.editor.dispose();
}
}