var EventEmitter = require('events'); var Sequencer = require('./sequencer'); var Thread = require('./thread'); var util = require('util'); var defaultBlockPackages = { 'scratch3': require('../blocks/scratch3'), 'wedo2': require('../blocks/wedo2') }; /** * Manages blocks, stacks, and the sequencer. */ function Runtime () { // Bind event emitter EventEmitter.call(this); // State for the runtime /** * All blocks in the workspace. * Keys are block IDs, values are metadata about the block. * @type {Object.} */ this.blocks = {}; /** * All stacks in the workspace. * A list of block IDs that represent stacks (first block in stack). * @type {Array.} */ this.stacks = []; /** * A list of threads that are currently running in the VM. * Threads are added when execution starts and pruned when execution ends. * @type {Array.} */ this.threads = []; /** @type {!Sequencer} */ this.sequencer = new Sequencer(this); /** * Map to look up a block primitive's implementation function by its opcode. * This is a two-step lookup: package name first, then primitive name. * @type {Object.} */ this._primitives = {}; this._registerBlockPackages(); } /** * Event name for glowing a stack * @const {string} */ Runtime.STACK_GLOW_ON = 'STACK_GLOW_ON'; /** * Event name for unglowing a stack * @const {string} */ Runtime.STACK_GLOW_OFF = 'STACK_GLOW_OFF'; /** * Event name for glowing a block * @const {string} */ Runtime.BLOCK_GLOW_ON = 'BLOCK_GLOW_ON'; /** * Event name for unglowing a block * @const {string} */ Runtime.BLOCK_GLOW_OFF = 'BLOCK_GLOW_OFF'; /** * Inherit from EventEmitter */ util.inherits(Runtime, EventEmitter); /** * How rapidly we try to step threads, in ms. */ Runtime.THREAD_STEP_INTERVAL = 1000 / 60; /** * Block management: create blocks and stacks from a `create` event * @param {!Object} block Blockly create event to be processed */ Runtime.prototype.createBlock = function (block, opt_isFlyoutBlock) { // Create new block this.blocks[block.id] = block; // Walk each field and add any shadow blocks // @todo Expand this to cover vertical / nested blocks for (var i in block.fields) { var shadows = block.fields[i].blocks; for (var y in shadows) { var shadow = shadows[y]; this.blocks[shadow.id] = shadow; } } // Push block id to stacks array. New blocks are always a stack even if only // momentary. If the new block is added to an existing stack this stack will // be removed by the `moveBlock` method below. if (!opt_isFlyoutBlock) { this.stacks.push(block.id); } }; /** * Block management: change block field values * @param {!Object} args Blockly change event to be processed */ Runtime.prototype.changeBlock = function (args) { // Validate if (args.element !== 'field') return; if (typeof this.blocks[args.id] === 'undefined') return; if (typeof this.blocks[args.id].fields[args.name] === 'undefined') return; // Update block value this.blocks[args.id].fields[args.name].value = args.value; }; /** * Block management: move blocks from parent to parent * @param {!Object} e Blockly move event to be processed */ Runtime.prototype.moveBlock = function (e) { var _this = this; // Block has a new parent if (e.oldParent === undefined && e.newParent !== undefined) { // Remove stack _this._deleteStack(e.id); // Update new parent if (e.newField === undefined) { _this.blocks[e.newParent].next = e.id; } else { _this.blocks[e.newParent].fields[e.newField] = { name: e.newField, value: e.id, blocks: {} }; } } // Block was removed from parent if (e.newParent === undefined && e.oldParent !== undefined) { // Add stack _this.stacks.push(e.id); // Update old parent if (e.oldField === undefined) { _this.blocks[e.oldParent].next = null; } else { delete _this.blocks[e.oldParent].fields[e.oldField]; } } }; /** * Block management: delete blocks and their associated stacks * @param {!Object} e Blockly delete event to be processed */ Runtime.prototype.deleteBlock = function (e) { // @todo Stop threads running on this stack // Get block var block = this.blocks[e.id]; // Delete children if (block.next !== null) { this.deleteBlock({id: block.next}); } // Delete substacks and fields for (var field in block.fields) { if (field === 'SUBSTACK') { this.deleteBlock({id: block.fields[field].value}); } else { for (var shadow in block.fields[field].blocks) { this.deleteBlock({id: shadow}); } } } // Delete stack this._deleteStack(e.id); // Delete block delete this.blocks[e.id]; }; // ----------------------------------------------------------------------------- // ----------------------------------------------------------------------------- /** * Register default block packages with this runtime. * @todo Prefix opcodes with package name. * @private */ Runtime.prototype._registerBlockPackages = function () { for (var packageName in defaultBlockPackages) { if (defaultBlockPackages.hasOwnProperty(packageName)) { // @todo maybe we pass a different runtime depending on package privilege level? var packageObject = new (defaultBlockPackages[packageName])(this); var packageContents = packageObject.getPrimitives(); for (var op in packageContents) { if (packageContents.hasOwnProperty(op)) { this._primitives[op] = packageContents[op].bind(packageObject); } } } } }; /** * Retrieve the function associated with the given opcode. * @param {!string} opcode The opcode to look up. * @return {Function} The function which implements the opcode. */ Runtime.prototype.getOpcodeFunction = function (opcode) { return this._primitives[opcode]; }; // ----------------------------------------------------------------------------- // ----------------------------------------------------------------------------- /** * Create a thread and push it to the list of threads. * @param {!string} id ID of block that starts the stack */ Runtime.prototype._pushThread = function (id) { if (this.stacks.indexOf(id) < -1) { return; } this.emit(Runtime.STACK_GLOW_ON, id); var thread = new Thread(id); this.threads.push(thread); }; /** * Remove a thread from the list of threads. * @param {?Thread} thread Thread object to remove from actives */ Runtime.prototype._removeThread = function (thread) { var i = this.threads.indexOf(thread); if (i > -1) { this.emit(Runtime.STACK_GLOW_OFF, thread.topBlock); this.threads.splice(i, 1); } }; /** * Toggle a stack * @param {!string} stackId ID of block that starts the stack */ Runtime.prototype.toggleStack = function (stackId) { // Remove any existing thread for (var i = 0; i < this.threads.length; i++) { if (this.threads[i].topBlock == stackId) { this._removeThread(this.threads[i]); return; } } // Otherwise add it this._pushThread(stackId); }; /** * Green flag, which stops currently running threads * and adds all top-level stacks that start with the green flag */ Runtime.prototype.greenFlag = function () { // Remove all existing threads for (var i = 0; i < this.threads.length; i++) { this._removeThread(this.threads[i]); } // Add all top stacks with green flag for (var j = 0; j < this.stacks.length; j++) { var topBlock = this.stacks[j]; if (this.blocks[topBlock].opcode === 'event_whenflagclicked') { this._pushThread(this.stacks[j]); } } }; /** * Stop "everything" */ Runtime.prototype.stopAll = function () { for (var i = 0; i < this.threads.length; i++) { this._removeThread(this.threads[i]); } // @todo call stop function in all extensions/packages/WeDo stub }; /** * Repeatedly run `sequencer.stepThreads` and filter out * inactive threads after each iteration. */ Runtime.prototype._step = function () { var inactiveThreads = this.sequencer.stepThreads(this.threads); for (var i = 0; i < inactiveThreads.length; i++) { this._removeThread(inactiveThreads[i]); } }; /** * Set up timers to repeatedly step in a browser */ Runtime.prototype.start = function () { if (!window.setInterval) return; window.setInterval(function() { this._step(); }.bind(this), Runtime.THREAD_STEP_INTERVAL); }; // ----------------------------------------------------------------------------- // ----------------------------------------------------------------------------- /** * Helper to remove a stack from `this.stacks` * @param {?string} id ID of block that starts the stack */ Runtime.prototype._deleteStack = function (id) { var i = this.stacks.indexOf(id); if (i > -1) this.stacks.splice(i, 1); }; /** * Helper to get the next block for a particular block * @param {?string} id ID of block to get the next block for * @return {?string} ID of next block in the sequence */ Runtime.prototype._getNextBlock = function (id) { if (typeof this.blocks[id] === 'undefined') return null; return this.blocks[id].next; }; /** * Helper to get the substack for a particular C-shaped block * @param {?string} id ID for block to get the substack for * @return {?string} ID of block in the substack */ Runtime.prototype._getSubstack = function (id) { if (typeof this.blocks[id] === 'undefined') return null; return this.blocks[id].fields['SUBSTACK']; }; /** * Helper to get the opcode for a particular block * @param {?string} id ID of block to query * @return {?string} the opcode corresponding to that block */ Runtime.prototype._getOpcode = function (id) { if (typeof this.blocks[id] === 'undefined') return null; return this.blocks[id].opcode; }; module.exports = Runtime;