blob: 26b8422d72cc35148708117140c1d09dc753d2ec [file] [log] [blame] [raw]
// Copyright (c) 2012, Matt Godbolt
// 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.
'use strict';
var $ = require('jquery');
var _ = require('underscore');
var ga = require('analytics').ga;
var colour = require('colour');
var Toggles = require('toggles');
var FontScale = require('fontscale');
var Promise = require('es6-promise').Promise;
var Components = require('components');
var LruCache = require('lru-cache');
var options = require('options');
var monaco = require('monaco');
var Alert = require('alert');
var bigInt = require('big-integer');
var local = require('./local');
var Raven = require('raven-js');
require('asm-mode');
require('selectize');
var OpcodeCache = new LruCache({
max: 64 * 1024,
length: function (n) {
return JSON.stringify(n).length;
}
});
function patchOldFilters(filters) {
if (filters === undefined) return undefined;
// Filters are of the form {filter: true|false¸ ...}. In older versions, we used
// to suppress the {filter:false} form. This means we can't distinguish between
// "filter not on" and "filter not present". In the latter case we want to default
// the filter. In the former case we want the filter off. Filters now don't suppress
// but there are plenty of permalinks out there with no filters set at all. Here
// we manually set any missing filters to 'false' to recover the old behaviour of
// "if it's not here, it's off".
_.each(['binary', 'labels', 'directives', 'commentOnly', 'trim', 'intel'], function (oldFilter) {
if (filters[oldFilter] === undefined) filters[oldFilter] = false;
});
return filters;
}
var languages = options.languages;
function Compiler(hub, container, state) {
this.container = container;
this.hub = hub;
this.eventHub = hub.createEventHub();
this.compilerService = hub.compilerService;
this.domRoot = container.getElement();
this.domRoot.html($('#compiler').html());
this.id = state.id || hub.nextCompilerId();
this.sourceEditorId = state.source || 1;
this.settings = JSON.parse(local.get('settings', '{}'));
this.initLang(state);
this.initCompiler(state);
this.infoByLang = {};
this.deferCompiles = hub.deferred;
this.needsCompile = false;
this.options = state.options || options.compileOptions[this.currentLangId];
this.source = '';
this.assembly = [];
this.colours = [];
this.lastResult = {};
this.pendingRequestSentAt = 0;
this.nextRequest = null;
this.optViewOpen = false;
this.cfgViewOpen = false;
this.wantOptInfo = state.wantOptInfo;
this.decorations = {};
this.prevDecorations = [];
this.alertSystem = new Alert();
this.linkedFadeTimeoutId = -1;
this.outputEditor = monaco.editor.create(this.domRoot.find('.monaco-placeholder')[0], {
scrollBeyondLastLine: false,
readOnly: true,
language: 'asm',
fontFamily: 'Consolas, "Liberation Mono", Courier, monospace',
glyphMargin: !options.embedded,
fixedOverflowWidgets: true,
minimap: {
maxColumn: 80
},
lineNumbersMinChars: options.embedded ? 1 : 5
});
this.initButtons(state);
this.compilerPicker.selectize({
sortField: 'name',
valueField: 'id',
labelField: 'name',
searchField: ['name'],
optgroupField: 'group',
optgroups: this.getGroupsInUse(),
options: _.map(this.getCurrentLangCompilers(), _.identity),
items: this.compiler ? [this.compiler.id] : []
}).on('change', _.bind(function (e) {
var val = $(e.target).val();
if (val) {
ga('send', {
hitType: 'event',
eventCategory: 'SelectCompiler',
eventAction: val
});
this.onCompilerChange(val);
}
}, this));
this.compilerSelecrizer = this.compilerPicker[0].selectize;
this.initLibraries(state);
this.initEditorActions();
this.initCallbacks();
// Handle initial settings
this.onSettingsChange(this.settings);
this.sendCompiler();
this.updateCompilerInfo();
this.updateButtons();
this.updateLibsDropdown();
this.saveState();
}
Compiler.prototype.clearEditorsLinkedLines = function () {
this.eventHub.emit('editorSetDecoration', this.sourceEditorId, -1, false);
};
Compiler.prototype.getGroupsInUse = function () {
var currentLangCompilers = _.map(this.getCurrentLangCompilers(), _.identity);
return _.map(_.uniq(currentLangCompilers, false, function (compiler) {
return compiler.group;
}), function (compiler) {
return {value: compiler.group, label: compiler.groupName || compiler.group};
});
};
Compiler.prototype.close = function () {
this.eventHub.unsubscribe();
this.eventHub.emit('compilerClose', this.id);
this.outputEditor.dispose();
};
Compiler.prototype.initPanerButtons = function () {
var outputConfig = _.bind(function () {
return Components.getOutput(this.id, this.sourceEditorId);
}, this);
this.container.layoutManager.createDragSource(this.outputBtn, outputConfig);
this.outputBtn.click(_.bind(function () {
var insertPoint = this.hub.findParentRowOrColumn(this.container) ||
this.container.layoutManager.root.contentItems[0];
insertPoint.addChild(outputConfig);
}, this));
var cloneComponent = _.bind(function () {
return {
type: 'component',
componentName: 'compiler',
componentState: this.currentState()
};
}, this);
var createOptView = _.bind(function () {
return Components.getOptViewWith(this.id, this.source, this.lastResult.optOutput, this.getCompilerName(),
this.sourceEditorId);
}, this);
var createAstView = _.bind(function () {
return Components.getAstViewWith(this.id, this.source, this.lastResult.astOutput, this.getCompilerName(),
this.sourceEditorId);
}, this);
var createGccDumpView = _.bind(function () {
return Components.getGccDumpViewWith(this.id, this.getCompilerName(), this.sourceEditorId,
this.lastResult.gccDumpOutput);
}, this);
var createCfgView = _.bind(function () {
return Components.getCfgViewWith(this.id, this.sourceEditorId);
}, this);
var panerDropdown = this.domRoot.find('.pane-dropdown');
var togglePannerAdder = function () {
panerDropdown.dropdown('toggle');
};
this.container.layoutManager
.createDragSource(this.domRoot.find('.btn.add-compiler'), cloneComponent)
._dragListener.on('dragStart', togglePannerAdder);
this.domRoot.find('.btn.add-compiler').click(_.bind(function () {
var insertPoint = this.hub.findParentRowOrColumn(this.container) ||
this.container.layoutManager.root.contentItems[0];
insertPoint.addChild(cloneComponent);
}, this));
this.container.layoutManager
.createDragSource(this.optButton, createOptView)
._dragListener.on('dragStart', togglePannerAdder);
this.optButton.click(_.bind(function () {
var insertPoint = this.hub.findParentRowOrColumn(this.container) ||
this.container.layoutManager.root.contentItems[0];
insertPoint.addChild(createOptView);
}, this));
this.container.layoutManager
.createDragSource(this.astButton, createAstView)
._dragListener.on('dragStart', togglePannerAdder);
this.astButton.click(_.bind(function () {
var insertPoint = this.hub.findParentRowOrColumn(this.container) ||
this.container.layoutManager.root.contentItems[0];
insertPoint.addChild(createAstView);
}, this));
this.container.layoutManager
.createDragSource(this.gccDumpButton, createGccDumpView)
._dragListener.on('dragStart', togglePannerAdder);
this.gccDumpButton.click(_.bind(function () {
var insertPoint = this.hub.findParentRowOrColumn(this.container) ||
this.container.layoutManager.root.contentItems[0];
insertPoint.addChild(createGccDumpView);
}, this));
this.container.layoutManager
.createDragSource(this.cfgButton, createCfgView)
._dragListener.on('dragStart', togglePannerAdder);
this.cfgButton.click(_.bind(function () {
var insertPoint = this.hub.findParentRowOrColumn(this.container) ||
this.container.layoutManager.root.contentItems[0];
insertPoint.addChild(createCfgView);
}, this));
};
Compiler.prototype.undefer = function () {
this.deferCompiles = false;
if (this.needsCompile) this.compile();
};
// TODO: need to call resize if either .top-bar or .bottom-bar resizes, which needs some work.
// Issue manifests if you make a window where one compiler is small enough that the buttons spill onto two lines:
// reload the page and the bottom-bar is off the bottom until you scroll a tiny bit.
Compiler.prototype.resize = function () {
var topBarHeight = this.topBar.outerHeight(true);
var bottomBarHeight = this.bottomBar.outerHeight(true);
this.outputEditor.layout({
width: this.domRoot.width(),
height: this.domRoot.height() - topBarHeight - bottomBarHeight
});
};
Compiler.prototype.initLang = function (state) {
// If we don't have a language, but a compiler, find the corresponding language.
this.currentLangId = state.lang;
if (!this.currentLangId && state.compiler) {
this.currentLangId = this.langOfCompiler(state.compiler);
}
if (!this.currentLangId && languages[this.settings.defaultLanguage]) {
this.currentLangId = languages[this.settings.defaultLanguage].id;
}
if (!this.currentLangId) {
this.currentLangId = _.keys(languages)[0];
}
};
Compiler.prototype.initCompiler = function (state) {
this.originalCompilerId = state.compiler;
if (state.compiler)
this.compiler = this.findCompiler(this.currentLangId, state.compiler);
else
this.compiler = this.findCompiler(this.currentLangId, options.defaultCompiler[this.currentLangId]);
if (!this.compiler) {
var compilers = this.compilerService.compilersByLang[this.currentLangId];
if (compilers) this.compiler = _.values(compilers)[0];
}
};
Compiler.prototype.initEditorActions = function () {
this.outputEditor.addAction({
id: 'viewsource',
label: 'Scroll to source',
keybindings: [monaco.KeyMod.CtrlCmd | monaco.KeyCode.F10],
keybindingContext: null,
contextMenuGroupId: 'navigation',
contextMenuOrder: 1.5,
run: _.bind(function (ed) {
var desiredLine = ed.getPosition().lineNumber - 1;
var source = this.assembly[desiredLine].source;
if (source.file === null) {
// a null file means it was the user's source
this.eventHub.emit('editorSetDecoration', this.sourceEditorId, source.line, true);
} else {
// TODO: some indication this asm statement came from elsewhere
this.eventHub.emit('editorSetDecoration', this.sourceEditorId, -1, false);
}
}, this)
});
this.outputEditor.addAction({
id: 'viewasmdoc',
label: 'View asm doc',
keybindings: [monaco.KeyMod.CtrlCmd | monaco.KeyCode.F8],
keybindingContext: null,
contextMenuGroupId: 'help',
contextMenuOrder: 1.5,
run: _.bind(this.onAsmToolTip, this)
});
this.outputEditor.addAction({
id: 'toggleColourisation',
label: 'Toggle colourisation',
keybindings: [monaco.KeyMod.CtrlCmd | monaco.KeyMod.Shift | monaco.KeyCode.F1],
keybindingContext: null,
run: _.bind(function () {
this.eventHub.emit('modifySettings', {
colouriseAsm: !this.settings.colouriseAsm
});
}, this)
});
};
// Gets the filters that will actually be used (accounting for issues with binary
// mode etc).
Compiler.prototype.getEffectiveFilters = function () {
if (!this.compiler) return {};
var filters = this.filters.get();
if (filters.binary && !this.compiler.supportsBinary) {
delete filters.binary;
}
if (filters.execute && !this.compiler.supportsExecute) {
delete filters.execute;
}
return filters;
};
Compiler.prototype.compile = function () {
if (this.deferCompiles) {
this.needsCompile = true;
return;
}
this.needsCompile = false;
this.compileTimeLabel.text(' - Compiling...');
var options = {
userArguments: this.options,
compilerOptions: {
produceAst: this.astViewOpen,
produceGccDump: {
opened: this.gccDumpViewOpen,
pass: this.gccDumpPassSelected,
treeDump: this.treeDumpEnabled,
rtlDump: this.rtlDumpEnabled
},
produceOptInfo: this.wantOptInfo,
produceCfg: this.cfgViewOpen
},
filters: this.getEffectiveFilters()
};
var includeFlag = this.compiler ? this.compiler.includeFlag : '-I';
_.each(this.availableLibs[this.currentLangId], function (lib) {
_.each(lib.versions, function (version) {
if (version.used) {
_.each(version.path, function (path) {
options.userArguments += ' ' + includeFlag + path;
});
}
});
});
this.compilerService.expand(this.source).then(_.bind(function (expanded) {
var request = {
source: expanded || '',
compiler: this.compiler ? this.compiler.id : '',
options: options,
lang: this.currentLangId
};
if (!this.compiler) {
this.onCompileResponse(request, errorResult('<Please select a compiler>'), false);
} else {
this.sendCompile(request);
}
}, this));
};
Compiler.prototype.sendCompile = function (request) {
var onCompilerResponse = _.bind(this.onCompileResponse, this);
if (this.pendingRequestSentAt) {
// If we have a request pending, then just store this request to do once the
// previous request completes.
this.nextRequest = request;
return;
}
this.eventHub.emit('compiling', this.id, this.compiler);
this.pendingRequestSentAt = Date.now();
// After a short delay, give the user some indication that we're working on their
// compilation.
var progress = setTimeout(_.bind(function () {
this.setAssembly(fakeAsm('<Compiling...>'));
}, this), 500);
this.compilerService.submit(request)
.then(function (x) {
clearTimeout(progress);
onCompilerResponse(request, x.result, x.localCacheHit);
})
.catch(function (x) {
clearTimeout(progress);
onCompilerResponse(request, errorResult('<Remote compilation failed: ' + x.error + '>'), false);
});
};
Compiler.prototype.getBinaryForLine = function (line) {
var obj = this.assembly[line - 1];
if (!obj) return '<div class="address">????</div><div class="opcodes"><span class="opcode">????</span></div>';
var address = obj.address ? obj.address.toString(16) : '';
var opcodes = '<div class="opcodes" title="' + (obj.opcodes || []).join(' ') + '">';
_.each(obj.opcodes, function (op) {
opcodes += ('<span class="opcode">' + op + '</span>');
});
return '<div class="binary-side"><div class="address">' + address + '</div>' + opcodes + '</div></div>';
};
// TODO: use ContentWidgets? OverlayWidgets?
// Use highlight providers? hover providers? highlight providers?
Compiler.prototype.setAssembly = function (asm) {
this.assembly = asm;
if (!this.outputEditor || !this.outputEditor.getModel()) return;
var currentTopLine = this.outputEditor.getCompletelyVisibleLinesRangeInViewport().startLineNumber;
this.outputEditor.getModel().setValue(asm.length ? _.pluck(asm, 'text').join('\n') : "<No assembly generated>");
this.outputEditor.revealLine(currentTopLine);
var addrToAddrDiv = {};
var decorations = [];
_.each(this.assembly, _.bind(function (obj, line) {
var address = obj.address ? obj.address.toString(16) : '';
// var div = $("<div class='address cm-number'>" + address + "</div>");
addrToAddrDiv[address] = {div: 'moo', line: line};
}, this));
_.each(this.assembly, _.bind(function (obj, line) {
if (!obj.links) return;
_.each(obj.links, _.bind(function (link) {
var address = link.to.toString(16);
// var thing = $("<a href='#' class='cm-number'>" + address + "</a>");
// this.outputEditor.markText(
// from, to, {replacedWith: thing[0], handleMouseEvents: false});
var dest = addrToAddrDiv[address];
if (dest) {
decorations.push({
range: new monaco.Range(line, link.offset, line, link.offset + link.length),
options: {}
});
// var editor = this.outputEditor;
// thing.hover(function (e) {
// var entered = e.type == "mouseenter";
// dest.div.toggleClass("highlighted", entered);
// thing.toggleClass("highlighted", entered);
// });
// thing.on('click', function (e) {
// editor.scrollIntoView({line: dest.line, ch: 0}, 30);
// dest.div.toggleClass("highlighted", false);
// thing.toggleClass("highlighted", false);
// e.preventDefault();
// });
}
}, this));
}, this));
};
function errorResult(text) {
return {asm: fakeAsm(text), code: -1, stdout: '', stderr: ''};
}
function fakeAsm(text) {
return [{text: text, source: null, fake: true}];
}
Compiler.prototype.onCompileResponse = function (request, result, cached) {
// Delete trailing empty lines
if ($.isArray(result.asm)) {
var cutCount = 0;
for (var i = result.asm.length - 1; i >= 0; i--) {
if (result.asm[i].text) {
break;
}
cutCount++;
}
result.asm.splice(result.asm.length - cutCount, cutCount);
}
this.lastResult = result;
var timeTaken = Math.max(0, Date.now() - this.pendingRequestSentAt);
var wasRealReply = this.pendingRequestSentAt > 0;
this.pendingRequestSentAt = 0;
ga('send', {
hitType: 'event',
eventCategory: 'Compile',
eventAction: request.compiler,
eventLabel: request.options.userArguments,
eventValue: cached ? 1 : 0
});
ga('send', {
hitType: 'timing',
timingCategory: 'Compile',
timingVar: request.compiler,
timingValue: timeTaken
});
this.setAssembly(result.asm || fakeAsm('<No output>'));
if (request.options.filters.binary) {
this.setBinaryMargin();
} else {
this.outputEditor.updateOptions({
lineNumbers: true,
lineNumbersMinChars: options.embedded ? 1 : 5,
glyphMargin: true
});
}
var stdout = result.stdout || [];
var stderr = result.stderr || [];
var allText = _.pluck(stdout.concat(stderr), 'text').join('\n');
var failed = result.code !== 0;
var warns = !failed && !!allText;
this.statusLabel
.toggleClass('error', failed)
.toggleClass('warning', warns);
this.outputTextCount.text(stdout.length);
this.outputErrorCount.text(stderr.length);
if (this.isOutputOpened) {
this.outputBtn.prop('title', '');
} else {
this.outputBtn.prop('title', allText.replace(/\x1b\[[0-9;]*m(.\[K)?/g, ''));
}
var timeLabelText = '';
if (cached) {
timeLabelText = ' - cached';
} else if (wasRealReply) {
timeLabelText = ' - ' + timeTaken + 'ms';
}
if (result.asmSize !== undefined) {
timeLabelText += ' (' + result.asmSize + 'B)';
}
this.compileTimeLabel.text(timeLabelText);
this.eventHub.emit('compileResult', this.id, this.compiler, result, languages[this.currentLangId]);
this.updateButtons();
if (this.nextRequest) {
var next = this.nextRequest;
this.nextRequest = null;
this.sendCompile(next);
}
};
Compiler.prototype.setBinaryMargin = function () {
this.outputEditor.updateOptions({
lineNumbers: _.bind(this.getBinaryForLine, this),
lineNumbersMinChars: 20,
glyphMargin: false
});
this.outputEditor._configuration._validatedOptions.lineNumbersMinChars = 20;
this.outputEditor._configuration._recomputeOptions();
};
Compiler.prototype.onEditorChange = function (editor, source, langId, compilerId) {
if (editor === this.sourceEditorId && langId === this.currentLangId &&
(compilerId === undefined || compilerId === this.id)) {
this.source = source;
this.compile();
}
};
Compiler.prototype.onOutputOpened = function (compilerId) {
if (this.id === compilerId) {
this.isOutputOpened = true;
this.outputBtn.prop('disabled', true);
this.resendResult();
}
};
Compiler.prototype.onOutputClosed = function (compilerId) {
if (this.id === compilerId) {
this.isOutputOpened = false;
this.outputBtn.prop('disabled', false);
}
};
Compiler.prototype.onOptViewClosed = function (id) {
if (this.id === id) {
this.wantOptInfo = false;
this.optViewOpen = false;
this.optButton.prop('disabled', this.optViewOpen);
}
};
Compiler.prototype.onAstViewOpened = function (id) {
if (this.id === id) {
this.astButton.prop('disabled', true);
this.astViewOpen = true;
this.compile();
}
};
Compiler.prototype.onAstViewClosed = function (id) {
if (this.id === id) {
this.astButton.prop('disabled', false);
this.astViewOpen = false;
}
};
Compiler.prototype.onGccDumpUIInit = function (id) {
if (this.id === id) {
this.compile();
}
};
Compiler.prototype.onGccDumpFiltersChanged = function (id, filters, reqCompile) {
if (this.id === id) {
this.treeDumpEnabled = (filters.treeDump !== false);
this.rtlDumpEnabled = (filters.rtlDump !== false);
if (reqCompile) {
this.compile();
}
}
};
Compiler.prototype.onGccDumpPassSelected = function (id, passId, reqCompile) {
if (this.id === id) {
this.gccDumpPassSelected = passId;
if (reqCompile && passId !== '') {
this.compile();
}
}
};
Compiler.prototype.onGccDumpViewOpened = function (id) {
if (this.id === id) {
this.gccDumpButton.prop('disabled', true);
this.gccDumpViewOpen = true;
}
};
Compiler.prototype.onGccDumpViewClosed = function (id) {
if (this.id === id) {
this.gccDumpButton.prop('disabled', !this.compiler.supportsGccDump);
this.gccDumpViewOpen = false;
delete this.gccDumpPassSelected;
delete this.treeDumpEnabled;
delete this.rtlDumpEnabled;
}
};
Compiler.prototype.onOptViewOpened = function (id) {
if (this.id === id) {
this.optViewOpen = true;
this.wantOptInfo = true;
this.optButton.prop('disabled', this.optViewOpen);
this.compile();
}
};
Compiler.prototype.onCfgViewOpened = function (id) {
if (this.id === id) {
this.cfgButton.prop('disabled', true);
this.cfgViewOpen = true;
this.compile();
}
};
Compiler.prototype.onCfgViewClosed = function (id) {
if (this.id === id) {
this.cfgViewOpen = false;
this.cfgButton.prop('disabled', this.getEffectiveFilters().binary);
}
};
Compiler.prototype.initButtons = function (state) {
this.filters = new Toggles(this.domRoot.find('.filters'), patchOldFilters(state.filters));
this.fontScale = new FontScale(this.domRoot, state, this.outputEditor);
this.optButton = this.domRoot.find('.btn.view-optimization');
this.astButton = this.domRoot.find('.btn.view-ast');
this.gccDumpButton = this.domRoot.find('.btn.view-gccdump');
this.cfgButton = this.domRoot.find('.btn.view-cfg');
this.libsButton = this.domRoot.find('.btn.show-libs');
this.compileTimeLabel = this.domRoot.find('.compile-time');
this.compileClearCache = this.domRoot.find('.clear-cache');
this.outputBtn = this.domRoot.find('.output-btn');
this.outputTextCount = this.domRoot.find('span.text-count');
this.outputErrorCount = this.domRoot.find('span.err-count');
this.libsTemplates = $('.template #libs-dropdown');
this.noLibsPanel = this.libsTemplates.children('.no-libs');
this.optionsField = this.domRoot.find('.options');
this.prependOptions = this.domRoot.find('.prepend-options');
this.filterBinaryButton = this.domRoot.find("[data-bind='binary']");
this.filterBinaryTitle = this.filterBinaryButton.prop('title');
this.filterExecuteButton = this.domRoot.find("[data-bind='execute']");
this.filterExecuteTitle = this.filterExecuteButton.prop('title');
this.filterLabelsButton = this.domRoot.find("[data-bind='labels']");
this.filterLabelsTitle = this.filterLabelsButton.prop('title');
this.filterDirectivesButton = this.domRoot.find("[data-bind='directives']");
this.filterDirectivesTitle = this.filterDirectivesButton.prop('title');
this.filterCommentsButton = this.domRoot.find("[data-bind='commentOnly']");
this.filterCommentsTitle = this.filterCommentsButton.prop('title');
this.filterTrimButton = this.domRoot.find("[data-bind='trim']");
this.filterTrimTitle = this.filterTrimButton.prop('title');
this.filterIntelButton = this.domRoot.find("[data-bind='intel']");
this.filterIntelTitle = this.filterIntelButton.prop('title');
this.filterDemangleButton = this.domRoot.find("[data-bind='demangle']");
this.filterDemangleTitle = this.filterDemangleButton.prop('title');
this.noBinaryFiltersButtons = this.domRoot.find('.nonbinary');
this.filterExecuteButton.toggle(options.supportsExecute);
this.optionsField.val(this.options);
this.fullCompilerName = this.domRoot.find('.full-compiler-name');
this.compilerPicker = this.domRoot.find('.compiler-picker');
this.topBar = this.domRoot.find('.top-bar');
this.bottomBar = this.domRoot.find('.bottom-bar');
this.statusLabel = this.domRoot.find('.status');
this.initPanerButtons();
};
Compiler.prototype.initLibraries = function (state) {
this.availableLibs = {};
this.updateAvailableLibs();
_.each(state.libs, _.bind(function (lib) {
if (this.availableLibs[this.currentLangId][lib.name] &&
this.availableLibs[this.currentLangId][lib.name].versions &&
this.availableLibs[this.currentLangId][lib.name].versions[lib.ver]) {
this.availableLibs[this.currentLangId][lib.name].versions[lib.ver].used = true;
}
}, this));
};
Compiler.prototype.updateAvailableLibs = function () {
if (!this.availableLibs[this.currentLangId]) {
this.availableLibs[this.currentLangId] = $.extend(true, {}, options.libs[this.currentLangId]);
}
};
Compiler.prototype.updateButtons = function () {
if (!this.compiler) return;
var filters = this.getEffectiveFilters();
// We can support intel output if the compiler supports it, or if we're compiling
// to binary (as we can disassemble it however we like).
var formatFilterTitle = function (button, title) {
button.prop('title', '[' + (button.hasClass('active') ? 'ON' : 'OFF') + '] ' + title +
(button.prop('disabled') ? ' [LOCKED]' : ''));
};
var isIntelFilterDisabled = !this.compiler.supportsIntel && !filters.binary;
this.filterIntelButton.prop('disabled', isIntelFilterDisabled);
formatFilterTitle(this.filterIntelButton, this.filterIntelTitle);
// Disable binary support on compilers that don't work with it.
this.filterBinaryButton.prop('disabled', !this.compiler.supportsBinary);
formatFilterTitle(this.filterBinaryButton, this.filterBinaryTitle);
this.filterExecuteButton.prop('disabled', !this.compiler.supportsExecute);
formatFilterTitle(this.filterExecuteButton, this.filterExecuteTitle);
// Disable demangle for compilers where we can't access it
this.filterDemangleButton.prop('disabled', !this.compiler.supportsDemangle);
formatFilterTitle(this.filterDemangleButton, this.filterDemangleTitle);
// Disable any of the options which don't make sense in binary mode.
var noBinaryFiltersDisabled = !!filters.binary && !this.compiler.supportsFiltersInBinary;
this.noBinaryFiltersButtons.prop('disabled', noBinaryFiltersDisabled);
formatFilterTitle(this.filterLabelsButton, this.filterLabelsTitle);
formatFilterTitle(this.filterDirectivesButton, this.filterDirectivesTitle);
formatFilterTitle(this.filterCommentsButton, this.filterCommentsTitle);
formatFilterTitle(this.filterTrimButton, this.filterTrimTitle);
// If its already open, we should turn it off.
// The pane will update with error text
// Otherwise we just disable the button.
if (!this.optViewOpen) {
this.optButton.prop('disabled', !this.compiler.supportsOptOutput);
} else {
this.optButton.prop('disabled', true);
}
if (!this.astViewOpen) {
this.astButton.prop('disabled', !this.compiler.supportsAstView);
} else {
this.astButton.prop('disabled', true);
}
if (!this.cfgViewOpen) {
this.cfgButton.prop('disabled', !this.compiler.supportsCfg);
} else {
this.cfgButton.prop('disabled', true);
}
if (!this.gccDumpViewOpen) {
this.gccDumpButton.prop('disabled', !this.compiler.supportsGccDump);
} else {
this.gccDumpButton.prop('disabled', true);
}
};
Compiler.prototype.onFontScale = function () {
if (this.getEffectiveFilters().binary) {
this.setBinaryMargin();
}
this.saveState();
};
Compiler.prototype.initCallbacks = function () {
this.filters.on('change', _.bind(this.onFilterChange, this));
this.fontScale.on('change', _.bind(this.onFontScale, this));
this.container.on('destroy', this.close, this);
this.container.on('resize', this.resize, this);
this.container.on('shown', this.resize, this);
this.container.on('open', function () {
this.eventHub.emit('compilerOpen', this.id, this.sourceEditorId);
}, this);
this.eventHub.on('editorChange', this.onEditorChange, this);
this.eventHub.on('editorClose', this.onEditorClose, this);
this.eventHub.on('colours', this.onColours, this);
this.eventHub.on('resendCompilation', this.onResendCompilation, this);
this.eventHub.on('findCompilers', this.sendCompiler, this);
this.eventHub.on('compilerSetDecorations', this.onCompilerSetDecorations, this);
this.eventHub.on('settingsChange', this.onSettingsChange, this);
this.eventHub.on('optViewOpened', this.onOptViewOpened, this);
this.eventHub.on('optViewClosed', this.onOptViewClosed, this);
this.eventHub.on('astViewOpened', this.onAstViewOpened, this);
this.eventHub.on('astViewClosed', this.onAstViewClosed, this);
this.eventHub.on('outputOpened', this.onOutputOpened, this);
this.eventHub.on('outputClosed', this.onOutputClosed, this);
this.eventHub.on('gccDumpPassSelected', this.onGccDumpPassSelected, this);
this.eventHub.on('gccDumpFiltersChanged', this.onGccDumpFiltersChanged, this);
this.eventHub.on('gccDumpViewOpened', this.onGccDumpViewOpened, this);
this.eventHub.on('gccDumpViewClosed', this.onGccDumpViewClosed, this);
this.eventHub.on('gccDumpUIInit', this.onGccDumpUIInit, this);
this.eventHub.on('cfgViewOpened', this.onCfgViewOpened, this);
this.eventHub.on('cfgViewClosed', this.onCfgViewClosed, this);
this.eventHub.on('resize', this.resize, this);
this.eventHub.on('requestFilters', function (id) {
if (id === this.id) {
this.eventHub.emit('filtersChange', this.id, this.getEffectiveFilters());
}
}, this);
this.eventHub.on('requestCompiler', function (id) {
if (id === this.id) {
this.sendCompiler();
}
}, this);
this.eventHub.on('languageChange', this.onLanguageChange, this);
var optionsChange = _.debounce(_.bind(function (e) {
this.onOptionsChange($(e.target).val());
}, this), 800);
this.optionsField
.on('change', optionsChange)
.on('keyup', optionsChange);
this.mouseMoveThrottledFunction = _.throttle(_.bind(this.onMouseMove, this), 250);
this.outputEditor.onMouseMove(_.bind(function (e) {
this.mouseMoveThrottledFunction(e);
if (this.linkedFadeTimeoutId !== -1) {
clearTimeout(this.linkedFadeTimeoutId);
this.linkedFadeTimeoutId = -1;
}
}, this));
this.outputEditor.onMouseLeave(_.bind(function () {
this.linkedFadeTimeoutId = setTimeout(_.bind(function () {
this.clearEditorsLinkedLines();
this.linkedFadeTimeoutId = -1;
}, this), 5000);
}, this));
this.outputEditor.onMouseUp(_.bind(function () {
if (this.getEffectiveFilters().binary) {
this.setBinaryMargin();
}
}, this));
this.outputEditor.onContextMenu(_.bind(function () {
if (this.getEffectiveFilters().binary) {
this.setBinaryMargin();
}
}, this));
this.compileClearCache.on('click', _.bind(function () {
this.compilerService.cache.reset();
this.compile();
}, this));
// Dismiss the popover on escape.
$(document).on('keyup.editable', _.bind(function (e) {
if (e.which === 27) {
this.libsButton.popover('hide');
}
}, this));
// Dismiss on any click that isn't either in the opening element, inside
// the popover or on any alert
$(document).on('click', _.bind(function (e) {
var elem = this.libsButton;
var target = $(e.target);
if (!target.is(elem) && elem.has(target).length === 0 && target.closest('.popover').length === 0) {
elem.popover('hide');
}
}, this));
this.eventHub.on('initialised', this.undefer, this);
};
Compiler.prototype.onOptionsChange = function (options) {
this.options = options;
this.saveState();
this.compile();
this.updateButtons();
this.sendCompiler();
};
Compiler.prototype.updateCompilerInfo = function () {
this.updateCompilerName();
if (this.compiler) {
if (this.compiler.notification) {
this.alertSystem.notify(this.compiler.notification, {
group: 'compilerwarning',
alertClass: 'notification-info',
dismissTime: 5000
});
}
this.prependOptions.prop('title', this.compiler.options);
this.prependOptions.toggle(!!this.compiler.options);
}
};
Compiler.prototype.updateCompilerUI = function () {
this.updateButtons();
this.updateCompilerInfo();
// Resize in case the new compiler name is too big
this.resize();
};
Compiler.prototype.onCompilerChange = function (value) {
this.compiler = this.compilerService.findCompiler(this.currentLangId, value);
this.saveState();
this.compile();
this.updateCompilerUI();
this.sendCompiler();
};
Compiler.prototype.sendCompiler = function () {
this.eventHub.emit('compiler', this.id, this.compiler, this.options, this.sourceEditorId);
};
Compiler.prototype.onEditorClose = function (editor) {
if (editor === this.sourceEditorId) {
// We can't immediately close as an outer loop somewhere in GoldenLayout is iterating over
// the hierarchy. We can't modify while it's being iterated over.
this.close();
_.defer(function (self) {
self.container.close();
}, this);
}
};
Compiler.prototype.onFilterChange = function () {
this.eventHub.emit('filtersChange', this.id, this.getEffectiveFilters());
this.saveState();
this.compile();
this.updateButtons();
};
Compiler.prototype.currentState = function () {
var libs = [];
_.each(this.availableLibs[this.currentLangId], function (library, name) {
_.each(library.versions, function (version, ver) {
if (library.versions[ver].used) {
libs.push({name: name, ver: ver});
}
});
});
var state = {
compiler: this.compiler ? this.compiler.id : '',
source: this.sourceEditorId,
options: this.options,
// NB must *not* be effective filters
filters: this.filters.get(),
wantOptInfo: this.wantOptInfo,
libs: libs,
lang: this.currentLangId
};
this.fontScale.addState(state);
return state;
};
Compiler.prototype.saveState = function () {
this.container.setState(this.currentState());
};
Compiler.prototype.onColours = function (editor, colours, scheme) {
if (editor === this.sourceEditorId) {
var asmColours = {};
_.each(this.assembly, function (x, index) {
if (x.source && x.source.file === null) {
asmColours[index] = colours[x.source.line - 1];
}
});
this.colours = colour.applyColours(this.outputEditor, asmColours, scheme, this.colours);
}
};
Compiler.prototype.getCompilerName = function () {
return this.compiler ? this.compiler.name : 'No compiler set';
};
Compiler.prototype.updateCompilerName = function () {
var name = options.languages[this.currentLangId].name;
var compilerName = this.getCompilerName();
var compilerVersion = this.compiler ? this.compiler.version : '';
this.container.setTitle(compilerName + ' (Editor #' + this.sourceEditorId + ', Compiler #' + this.id + ') ' + name);
this.fullCompilerName.text(compilerVersion);
};
Compiler.prototype.resendResult = function () {
if (!$.isEmptyObject(this.lastResult)) {
this.eventHub.emit('compileResult', this.id, this.compiler, this.lastResult);
return true;
}
return false;
};
Compiler.prototype.onResendCompilation = function (id) {
if (id === this.id) {
this.resendResult();
}
};
Compiler.prototype.updateDecorations = function () {
this.prevDecorations = this.outputEditor.deltaDecorations(
this.prevDecorations, _.flatten(_.values(this.decorations)));
};
Compiler.prototype.onCompilerSetDecorations = function (id, lineNums, revealLine) {
if (Number(id) === this.id) {
if (revealLine && lineNums[0]) this.outputEditor.revealLineInCenter(lineNums[0]);
this.decorations.linkedCode = _.map(lineNums, function (line) {
return {
range: new monaco.Range(line, 1, line, 1),
options: {
isWholeLine: true,
linesDecorationsClassName: 'linked-code-decoration-margin',
inlineClassName: 'linked-code-decoration-inline'
}
};
});
this.updateDecorations();
}
};
Compiler.prototype.onSettingsChange = function (newSettings) {
var before = this.settings;
this.settings = _.clone(newSettings);
if (!before.lastHoverShowSource && this.settings.hoverShowSource) {
this.onCompilerSetDecorations(this.id, []);
}
this.outputEditor.updateOptions({
contextmenu: this.settings.useCustomContextMenu,
minimap: {
enabled: this.settings.showMinimap && !options.embedded
}
});
};
var hexLike = /^(#?[$]|0x)([0-9a-fA-F]+)$/;
var hexLike2 = /^(#?)([0-9a-fA-F]+)H$/;
var decimalLike = /^(#?)(-?[0-9]+)$/;
function getNumericToolTip(value) {
var match = hexLike.exec(value) || hexLike2.exec(value);
if (match) {
return value + ' = ' + bigInt(match[2], 16).toString(10);
}
match = decimalLike.exec(value);
if (match) {
var asBig = bigInt(match[2]);
if (asBig.isNegative()) {
asBig = bigInt('ffffffffffffffff', 16).and(asBig);
}
return value + ' = 0x' + asBig.toString(16).toUpperCase();
}
return null;
}
function getAsmInfo(opcode) {
var cacheName = 'asm/' + opcode;
var cached = OpcodeCache.get(cacheName);
if (cached) {
return Promise.resolve(cached.found ? cached.result : null);
}
return new Promise(function (resolve, reject) {
$.ajax({
type: 'GET',
url: 'api/asm/' + opcode,
dataType: 'json', // Expected,
contentType: 'text/plain', // Sent
success: function (result) {
OpcodeCache.set(cacheName, result);
resolve(result.found ? result.result : null);
},
error: function (result) {
reject(result);
},
cache: true
});
});
}
Compiler.prototype.onMouseMove = function (e) {
if (e === null || e.target === null || e.target.position === null) return;
if (this.settings.hoverShowSource === true && this.assembly) {
var hoverAsm = this.assembly[e.target.position.lineNumber - 1];
if (hoverAsm) {
// We check that we actually have something to show at this point!
this.eventHub.emit('editorSetDecoration', this.sourceEditorId, hoverAsm.source && !hoverAsm.source.file ?
hoverAsm.source.line : -1, false);
}
}
var currentWord = this.outputEditor.getModel().getWordAtPosition(e.target.position);
if (currentWord && currentWord.word) {
var word = currentWord.word;
var startColumn = currentWord.startColumn;
// Avoid throwing an exception if somehow (How?) we have a non existent lineNumber.
// c.f. https://sentry.io/matt-godbolt/compiler-explorer/issues/285270358/
if (e.target.position.lineNumber < this.outputEditor.getModel().getLineCount()) {
// Hacky workaround to check for negative numbers.
// c.f. https://github.com/mattgodbolt/compiler-explorer/issues/434
var lineContent = this.outputEditor.getModel().getLineContent(e.target.position.lineNumber);
if (lineContent[currentWord.startColumn - 2] === '-') {
word = '-' + word;
startColumn -= 1;
}
}
currentWord.range = new monaco.Range(e.target.position.lineNumber, Math.max(startColumn, 1),
e.target.position.lineNumber, currentWord.endColumn);
var numericToolTip = getNumericToolTip(word);
if (numericToolTip) {
this.decorations.numericToolTip = {
range: currentWord.range,
options: {isWholeLine: false, hoverMessage: ['`' + numericToolTip + '`']}
};
this.updateDecorations();
}
var getTokensForLine = function (model, line) {
//Force line's state to be accurate
if (line > model.getLineCount()) return [];
model.getLineTokens(line, /*inaccurateTokensAcceptable*/false);
// Get the tokenization state at the beginning of this line
var state = model._lines[line - 1].getState();
if (!state) return [];
var freshState = model._lines[line - 1].getState().clone();
// Get the human readable tokens on this line
return model._tokenizationSupport.tokenize(model.getLineContent(line), freshState, 0).tokens;
};
if (this.settings.hoverShowAsmDoc === true &&
_.some(getTokensForLine(this.outputEditor.getModel(), currentWord.range.startLineNumber), function (t) {
return t.offset + 1 === currentWord.startColumn && t.type === 'keyword.asm';
})) {
getAsmInfo(currentWord.word).then(_.bind(function (response) {
if (!response) return;
this.decorations.asmToolTip = {
range: currentWord.range,
options: {
isWholeLine: false,
hoverMessage: [response.tooltip + '\n\nMore information available in the context menu.']
}
};
this.updateDecorations();
}, this));
}
}
};
Compiler.prototype.onAsmToolTip = function (ed) {
var pos = ed.getPosition();
var word = ed.getModel().getWordAtPosition(pos);
if (!word || !word.word) return;
var opcode = word.word.toUpperCase();
function appendInfo(url) {
return '<br><br>For more information, visit <a href="' + url +
'" target="_blank" rel="noopener noreferrer">the ' + opcode +
' documentation <sup><small class="glyphicon glyphicon-new-window opens-new-window"' +
' title="Opens in a new window"></small></sup></a>.';
}
getAsmInfo(word.word).then(_.bind(function (asmHelp) {
if (asmHelp) {
this.alertSystem.alert(opcode + ' help', asmHelp.html + appendInfo(asmHelp.url), function () {
ed.focus();
ed.setPosition(pos);
});
} else {
this.alertSystem.notify('This token was not found in the documentation. Sorry!', {
group: 'notokenindocs',
alertClass: 'notification-error',
dismissTime: 3000
});
}
}, this), _.bind(function (rejection) {
this.alertSystem
.notify('There was an error fetching the documentation for this opcode (' + rejection + ').', {
group: 'notokenindocs',
alertClass: 'notification-error',
dismissTime: 3000
});
}, this));
};
Compiler.prototype.updateLibsDropdown = function () {
this.updateAvailableLibs();
this.libsButton.popover({
container: 'body',
content: _.bind(function () {
var libsCount = _.keys(this.availableLibs[this.currentLangId]).length;
if (libsCount === 0) return this.noLibsPanel;
var columnCount = Math.ceil(libsCount / 5);
var currentLibIndex = -1;
var libLists = [];
for (var i = 0; i < columnCount; i++) {
libLists.push($('<ul></ul>').addClass('lib-list'));
}
// Utility function so we can iterate indefinetly over our lists
var getNextList = function () {
currentLibIndex = (currentLibIndex + 1) % columnCount;
return libLists[currentLibIndex];
};
var onChecked = _.bind(function (e) {
var elem = $(e.target);
// Uncheck every lib checkbox with the same name if we're checking the target
if (elem.prop('checked')) {
var others = $.find('input[name=\'' + elem.prop('name') + '\']');
_.each(others, function (other) {
$(other).prop('checked', false);
});
// Recheck the targeted one
elem.prop('checked', true);
}
// And now do the same with the availableLibs object
_.each(this.availableLibs[this.currentLangId][elem.prop('data-lib')].versions, function (version) {
version.used = false;
});
this.availableLibs[this.currentLangId][elem.prop('data-lib')]
.versions[elem.prop('data-version')].used = elem.prop('checked');
this.saveState();
this.compile();
}, this);
_.each(this.availableLibs[this.currentLangId], function (lib, libKey) {
var libsList = getNextList();
var libHeader = $('<span></span>')
.text(lib.name)
.addClass('lib-header');
if (lib.url && lib.url.length > 0) {
libHeader.append($('<a></a>')
.css("float", "right")
.addClass('opens-new-window')
.prop('href', lib.url)
.prop('target', '_blank')
.prop('rel', 'noopener noreferrer')
.append($('<sup></sup>')
.addClass('glyphicon glyphicon-new-window')
)
);
}
if (lib.description && lib.description.length > 0) {
libHeader
.addClass('lib-described')
.prop('title', lib.description);
}
var libCat = $('<li></li>')
.append(libHeader)
.addClass('lib-item');
var libGroup = $('<div></div>');
if (libsList.children().length > 0)
libsList.append($('<hr>').addClass('lib-separator'));
_.each(lib.versions, function (version, vKey) {
libGroup.append($('<div></div>')
.append($('<input type="checkbox">')
.addClass('lib-checkbox')
.prop('data-lib', libKey)
.prop('data-version', vKey)
.prop('checked', version.used)
.prop('name', libKey)
.on('change', onChecked)
).append($('<label></label>')
.addClass('lib-label')
.text(version.version)
.on('click', function () {
$(this).parent().find('.lib-checkbox').trigger('click');
})
)
);
});
libGroup.appendTo(libCat);
libCat.appendTo(libsList);
});
return $('<div></div>').addClass('libs-container').append(libLists);
}, this),
html: true,
placement: 'bottom',
trigger: 'manual'
}).click(_.bind(function () {
this.libsButton.popover('show');
}, this)).on('show.bs.popover', function () {
$(this).data('bs.popover').tip().css('max-width', '100%').css('width', 'auto');
});
};
Compiler.prototype.onLanguageChange = function (editorId, newLangId) {
if (this.sourceEditorId === editorId) {
var oldLangId = this.currentLangId;
this.currentLangId = newLangId;
// Store the current selected stuff to come back to it later in the same session (Not state stored!)
this.infoByLang[oldLangId] = {
compiler: this.compiler && this.compiler.id ? this.compiler.id : options.defaultCompiler[oldLangId],
options: this.options
};
this.updateLibsDropdown();
this.updateCompilersSelector();
this.updateCompilerUI();
this.sendCompiler();
this.saveState();
}
};
Compiler.prototype.getCurrentLangCompilers = function () {
return this.compilerService.getCompilersForLang(this.currentLangId);
};
Compiler.prototype.updateCompilersSelector = function () {
this.compilerSelecrizer.clearOptions(true);
this.compilerSelecrizer.clearOptionGroups();
_.each(this.getGroupsInUse(), function (group) {
this.compilerSelecrizer.addOptionGroup(group.value, {label: group.label});
}, this);
this.compilerSelecrizer.load(_.bind(function (callback) {
callback(_.map(this.getCurrentLangCompilers(), _.identity));
}, this));
var defaultOrFirst = _.bind(function () {
// If the default is a valid compiler, return it
var defaultCompiler = options.defaultCompiler[this.currentLangId];
if (defaultCompiler) return defaultCompiler;
// Else try to find the first one for this language
var value = _.find(options.compilers, _.bind(function (compiler) {
return compiler.lang === this.currentLangId;
}, this));
// Return the first, or an empty string if none found (Should prob report this one...)
return value && value.id ? value.id : "";
}, this);
var info = this.infoByLang[this.currentLangId] || {};
this.compiler = this.findCompiler(this.currentLangId, info.compiler || defaultOrFirst());
this.compilerSelecrizer.setValue([this.compiler ? this.compiler.id : null], true);
this.options = info.options || "";
this.optionsField.val(this.options);
};
Compiler.prototype.findCompiler = function (langId, compilerId) {
return this.compilerService.findCompiler(langId, compilerId);
};
Compiler.prototype.langOfCompiler = function (compilerId) {
var compiler = _.find(options.compilers, function (compiler) {
return compiler.id === compilerId || compiler.alias === compilerId;
});
if (!compiler) {
Raven.captureMessage('Unable to find compiler id "' + compilerId + '"');
compiler = options.compilers[0];
}
return compiler.lang;
};
module.exports = {
Compiler: Compiler
};