enigma-bbs/core/menu_stack.js

/* jslint node: true */
'use strict';

//	ENiGMA½
var loadMenu	= require('./menu_util.js').loadMenu;

var _			= require('lodash');
var assert		= require('assert');

module.exports	= MenuStack;

function MenuStack(client) {
	this.client	= client;
	this.stack	= [];

	var self	= this;

	this.push = function(moduleInfo) {
		return self.stack.push(moduleInfo);
	};

	this.pop = function() {
		return self.stack.pop();
	};

	this.peekPrev = function() {
		if(this.stackSize() > 1) {
			return self.stack[self.stack.length - 2];
		}
	};

	this.top = function() {
		if(self.stackSize() > 0) {
			return self.stack[self.stack.length - 1];
		}
	};

	this.stackSize = function() {
		return self.stack.length;
	};
}

MenuStack.prototype.next = function(cb) {
	var currentModuleInfo = this.top();
	assert(currentModuleInfo, 'Empty menu stack!');

	var menuConfig = currentModuleInfo.instance.menuConfig;
	var next;

	if(_.isArray(menuConfig.next)) {
		next = this.client.acs.getConditionalValue(menuConfig.next, 'next');
		if(!next) {
			cb(new Error('No matching condition for \'next\'!'));
			return;
		}
	} else if(_.isString(menuConfig.next)) {
		next = menuConfig.next;
	} else {
		cb(new Error('Invalid or missing \'next\' member in menu config!'));
		return;
	}

	if(next === currentModuleInfo.name) {
		cb(new Error('Menu config \'next\' specifies current menu!'));
		return;
	}

	this.goto(next, { }, cb);
};

MenuStack.prototype.prev = function(cb) {
	this.pop().instance.leave();			//	leave & remove current
	
	const previousModuleInfo = this.pop();	//	get previous

	if(previousModuleInfo) {
		this.goto(
			previousModuleInfo.name, 
			{ 
				extraArgs	: previousModuleInfo.extraArgs, 
				savedState	: previousModuleInfo.savedState
			}, 
			cb
		);
	} else {
		cb(new Error('No previous menu available!'));
	}
};

MenuStack.prototype.goto = function(name, options, cb) {
	var currentModuleInfo = this.top();

	if(!cb && _.isFunction(options)) {
		cb = options;
	}

	const self = this;

	if(currentModuleInfo && name === currentModuleInfo.name) {
		if(cb) {
			cb(new Error('Already at supplied menu!'));
		}
		return;
	}

	const loadOpts = {
		name		: name,
		client		: self.client, 
	};

	if(_.isObject(options)) {
		loadOpts.extraArgs = options.extraArgs;
	}

	loadMenu(loadOpts, function menuLoaded(err, modInst) {
		if(err) {
			const errCb = cb || self.client.defaultHandlerMissingMod();
			errCb(err);
		} else {
			//	:TODO: Move this log to caller
			self.client.log.debug( { menuName : name }, 'Goto menu module');

			if(currentModuleInfo) {
				//	save stack state
				currentModuleInfo.savedState = currentModuleInfo.instance.getSaveState();

				currentModuleInfo.instance.leave();
			}

			self.push({
				name		: name,
				instance	: modInst,
				extraArgs	: loadOpts.extraArgs,
			});

			//	restore previous state if requested
			if(options && options.savedState) {
				modInst.restoreSavedState(options.savedState);
			}

			modInst.enter();

			self.client.log.trace(
				{ stack : _.map(self.stack, function(si) { return si.name; } ) },
				'Updated menu stack');

			if(cb) {
				cb(null);
			}
		}
	});
};

MenuStack.prototype.getCurrentModule = function() {
	var top = this.top();
	if(top) {
		return top.instance;
	}
};