sugarcube.js

/***********************************************************************************************************************

	sugarcube.js

	Copyright © 2013–2021 Thomas Michael Edwards <thomasmedwards@gmail.com>. All rights reserved.
	Use of this source code is governed by a BSD 2-clause "Simplified" License, which may be found in the LICENSE file.

***********************************************************************************************************************/
/*
	global Alert, Browser, Config, Dialog, Engine, Fullscreen, Has, LoadScreen, SimpleStore, L10n, Macro, Passage,
	       Save, Scripting, Setting, SimpleAudio, State, Story, UI, UIBar, DebugBar, Util, Visibility, Wikifier
	, Links, idb
*/
/* eslint-disable no-var */

/*
	Version object.
*/
var version = Object.freeze({
	title      : 'SugarCube',
	major      : '{{BUILD_VERSION_MAJOR}}',
	minor      : '{{BUILD_VERSION_MINOR}}',
	patch      : '{{BUILD_VERSION_PATCH}}',
	prerelease : '{{BUILD_VERSION_PRERELEASE}}',
	build      : '{{BUILD_VERSION_BUILD}}',
	date       : new Date('{{BUILD_VERSION_DATE}}'),
	/* legacy */
	extensions : {},
	/* /legacy */

	toString() {
		'use strict';

		const prerelease = this.prerelease ? `-${this.prerelease}` : '';
		return `${this.major}.${this.minor}.${this.patch}${prerelease}+${this.build}`;
	},

	short() {
		'use strict';

		const prerelease = this.prerelease ? `-${this.prerelease}` : '';
		return `${this.title} (v${this.major}.${this.minor}.${this.patch}${prerelease})`;
	},

	long() {
		'use strict';

		return `${this.title} v${this.toString()} (${this.date.toUTCString()})`;
	}
});

/* eslint-disable no-unused-vars */
/*
	Internal variables.
*/
// Temporary state object.
var TempState = {};

// Legacy macros object.
var macros = {};

// Post-display task callbacks object.
var postdisplay = {};

// Post-render task callbacks object.
var postrender = {};

// Pre-display task callbacks object.
var predisplay = {};

// Pre-history task callbacks object.
var prehistory = {};

// Pre-render task callbacks object.
var prerender = {};

// Session storage manager object.
var session = null;

// Settings object.
var settings = {};

// Setup object.
var setup = {};

// Persistant storage manager object.
var storage = null;

/*
	Legacy aliases.
*/
var browser       = Browser;
var config        = Config;
var has           = Has;
var History       = State;
var state         = State;
var tale          = Story;
var TempVariables = State.temporary;
/* eslint-enable no-unused-vars */

/*
	Global `SugarCube` object.  Allows scripts to detect if they're running in SugarCube by
	testing for the object (e.g. `"SugarCube" in window`) and contains exported identifiers
	for debugging purposes.
*/
window.SugarCube = {};

/*
	Main function, entry point for the story.
*/
jQuery(() => {
	'use strict';

	const mainStart = () => {
		if (DEBUG) { console.log('[SugarCube/main()] Document loaded; beginning startup.'); }

		/*
			WARNING!

			The ordering of the code within this function is critically important,
			so be careful when mucking around with it.
		*/
		try {
			// Acquire an initial lock for and initialize the loading screen.
			const lockId = LoadScreen.lock();
			LoadScreen.init();

			// Normalize the document.
			if (document.normalize) {
				document.normalize();
			}

			const initProcess = () => {
				console.log('initProcess()');

				// Load the story data (must be done before most anything else).
				Story.load();

				// Instantiate the storage and session objects.
				// NOTE: `SimpleStore.create(storageId, persistent)`
				storage = SimpleStore.create(Story.domId, true);
				session = SimpleStore.create(Story.domId, false);

				// Initialize the user interface (must be done before story initialization, specifically before scripts).
				Dialog.init();
				UIBar.init();
				Engine.init();

				// Initialize the story (largely load the user styles, scripts, and widgets).
				Story.init();

				// Initialize the localization (must be done after story initialization).
				L10n.init();

				// Alert when the browser is degrading required capabilities (must be done after localization initialization).
				if (!session.has('rcWarn') && storage.name === 'cookie') {
					/* eslint-disable no-alert */
					session.set('rcWarn', 1);
					window.alert(L10n.get('warningNoWebStorage'));
					/* eslint-enable no-alert */
				}

				// Initialize the saves (must be done after story initialization, but before engine start).
				Save.init();

				// Initialize the settings.
				Setting.init();

				// Initialize indexedDB
				idb.init(Story.domId);

				// Initialize hotkeys
				Links.init();

				// Initialize the macros.
				Macro.init();

				// Start the engine (should be done as late as possible, but before interface startup).
				Engine.start();

				// Initialize the debug bar interface (should be done as late as possible, but before interface startup).
				if (Config.debug) {
					DebugBar.init();
				}

				// Set a recurring timer to start the interfaces (necessary due to DOM readiness issues in some browsers).
				const $window    = $(window);
				const vprCheckId = setInterval(() => {
					// If `$window.width()` returns a zero value, bail out and wait.
					if (!$window.width()) {
						return;
					}

					// Clear the recurring timer.
					clearInterval(vprCheckId);

					// Start the UI bar interface.
					UIBar.start();

					// Start the debug bar interface.
					if (Config.debug) {
						DebugBar.start();
					}

					// Trigger the `:storyready` global synthetic event.
					jQuery.event.trigger({ type : ':storyready' });

					// Release the loading screen lock after a short delay.
					setTimeout(() => LoadScreen.unlock(lockId), Engine.minDomActionDelay * 2);
				}, Engine.minDomActionDelay);

				// Finally, export identifiers for debugging purposes.
				Object.defineProperty(window, 'SugarCube', {
					// WARNING: We need to assign new values at points, so seal it, do not freeze it.
					value : Object.seal(Object.assign(Object.create(null), {
						Browser,
						Config,
						Dialog,
						Engine,
						Fullscreen,
						Has,
						L10n,
						Macro,
						Passage,
						Save,
						Scripting,
						Setting,
						SimpleAudio,
						State,
						Story,
						UI,
						UIBar,
						DebugBar,
						Util,
						Visibility,
						Wikifier,
						session,
						settings,
						setup,
						storage,
						version
					}))
				});

				if (DEBUG) { console.log('[SugarCube/main()] Startup complete; story ready.'); }
			};

			// inject i18n on there
			if (typeof i18nManager !== 'undefined') {
				// eslint-disable-next-line no-undef
				i18nManager.loadTranslateData(['ValueZip', 'Remote']);
				// eslint-disable-next-line no-undef
				i18nManager.isInited.then(() => {
					initProcess();
				});
			}
			else {
				initProcess();
			}
		}
		catch (ex) {
			console.error(ex);
			LoadScreen.clear();
			return Alert.fatal(null, ex.message, ex);
		}
	};

	// inject ModLoader on there
	if (typeof window.modSC2DataManager !== 'undefined') {
		// eslint-disable-next-line no-alert
		// alert('start modSC2DataManager');
		window.modSC2DataManager.startInit()
			.then(() => window.jsPreloader.startLoad())
			// eslint-disable-next-line no-alert
			// .then(() => alert('modSC2DataManager ok'))
			.then(() => mainStart())
			.catch(err => {
				console.error(err);
				// eslint-disable-next-line no-alert
				// alert(`Error loading mod data: ${err?.message ? err.message : err}`);
			});
	}
	else {
		// eslint-disable-next-line no-alert
		// alert('cannot find modSC2DataManager');
		mainStart();
	}
});