smoothie.js

smoothie.js

//
// This file is part of Smoothie.
//
// Copyright (C) 2013,14 Torben Haase, Flowy Apps ([email protected])
//
// Smoothie is free software: you can redistribute it and/or modify it under the
// terms of the GNU Lesser General Public License as published by the Free
// Software Foundation, either version 3 of the License, or (at your option) any
// later version.
//
// Smoothie is distributed in the hope that it will be useful, but WITHOUT ANY
// WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
// A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more
// details.You should have received a copy of the GNU Lesser General Public
// License along with Smoothie.  If not, see <http://www.gnu.org/licenses/>.
//
////////////////////////////////////////////////////////////////////////////////

// NOTE The load parameter points to the function, which prepares the
//      environment for each module and runs its code. Scroll down to the end of
//      the file to see the function definition.
(function(load) { 'use strict';

var SmoothieError = function(message, fileName, lineNumber) {
	this.name = "SmoothieError";
	this.message = message;
}
SmoothieError.prototype = Object.create(Error.prototype);

// INFO Smoothie options
//      The values can be set by defining a object called Smoothie, which
//      contains properties of the same name as the options to be changed.
// NOTE The Smoothe object has to be defined before this script here is loaded
//      and changing the values in the Smoothie object will have no effect
//      afterwards!

// NOTE Main module identifier
var main = window.Smoothie&&window.Smoothie.main!==undefined?window.Smoothie.main:'main';
// NOTE Global module paths
var paths = window.Smoothie&&window.Smoothie.paths!==undefined?window.Smoothie.paths.slice(0):['./'];

// INFO Current module paths
//      path[0] contains the path of the currently loaded module, path[1]
//      contains the path its parent module and so on.

var pwd = Array('');

// INFO Path parser
//      A HTMLAnchorElement parses its href property automatically, so we use
//      this functionality to parse our module paths instead of implemnting our
//      own.

var parser = document.createElement('A');

// INFO Module cache
//      Contains getter functions for the exports objects of all the loaded
//      modules. The getter for the module 'mymod' is name '$name' to prevent
//      collisions with predefined object properties (see note below).
//      As long as a module has not been loaded the getter is either undefined
//      or contains the module code as a function (in case the module has been
//      pre-laoded in a bundle).
// NOTE For IE8 the cache will be replaced by a HTMLDivElement-object later on,
//      since defineProperty is only supported for DOM objects there.

var cache = new Object();
var locks = new Object();

// INFO Module getter
//      Takes a module identifier, resolves it and gets the module code via an
//      AJAX request from the module URI. If this was successful the code and
//      some environment variables are passed to the load function. The return
//      value is the module's `exports` object. If the cache already
//      contains an object for the module id, this object is returned directly.
// NOTE If a callback function has been passed, the AJAX request is asynchronous
//      and the mpdule exports are passed to the callback function after the
//      module has been loaded.

function require(identifier, callback) {
	var descriptor = resolve(identifier);
	var cacheid = '$'+descriptor.id;

	if (cache[cacheid]) {
		if (typeof cache[cacheid] === 'string')
			load(descriptor, cache, pwd, cache[cacheid]);
		// NOTE The callback should always be called asynchronously to ensure
		//      that a cached call won't differ from an uncached one.
		callback && setTimeout(function(){callback(cache[cacheid])}, 0);
		return cache[cacheid];
	}

	var request = new XMLHttpRequest();

	// NOTE IE8 doesn't support the onload event, therefore we use
	//      onreadystatechange as a fallback here. However, onreadystatechange
	//      shouldn't be used for all browsers, since at least mobile Safari
	//      seems to have an issue where onreadystatechange is called twice for
	//      readyState 4.
	callback && (request[request.onload===null?'onload':'onreadystatechange'] = onLoad);
	request.open('GET', descriptor.uri, !!callback);
	// NOTE Sending the request causes the event loop to continue. Therefore
	//      pending AJAX load events for the same url might be executed before
	//      the synchronous onLoad is called. This should be no problem, but in
	//      Chrome the responseText of the sneaked in load events will be empty.
	//      Therefore we have to lock the loading while executong send().   
	locks[cacheid] = locks[cacheid]++||1;
	request.send();
	locks[cacheid]--;
	!callback && onLoad();
	return cache[cacheid];

	function onLoad() {
		if (request.readyState != 4)
			return;
		if (request.status != 200)
			throw new SmoothieError('unable to load '+descriptor.id+" ("+request.status+" "+request.statusText+")");
		if (locks[cacheid]) {
			console.warn("module locked: "+descriptor.id);
			callback && setTimeout(onLoad, 0);
			return;
		}
		if (!cache[cacheid])
			load(descriptor, cache, pwd, 'function(){\n'+request.responseText+'\n}');
		callback && callback(cache[cacheid]);
	}
}

// INFO Module resolver
//      Takes a module identifier and resolves it to a module id and URI. Both
//      values are returned as a module descriptor, which can be passed to
//      `fetch` to load a module.

function resolve(identifier) {
	// NOTE Matches [1]:[..]/[path/to/][file][.js]
	var m = identifier.match(/^(?:([^:\/]+):)?(\.\.?)?\/?((?:.*\/)?)([^\.]+)?(\..*)?$/);
	// NOTE Matches [1]:[/path/to]
	var p = pwd[0].match(/^(?:([^:\/]+):)?(.*)/);
	var root = m[2] ? paths[p[1]?parseInt(p[1]):0] : paths[m[1]?parseInt(m[1]):0];
	parser.href = (m[2]?root+p[2]+m[2]+'/':root)+m[3]+(m[4]?m[4]:'index');
	var id = parser.href.replace(/^[^:]*:\/\/[^\/]*\/|\/(?=\/)/g, '');
	var uri = "/"+id+(m[5]?m[5]:'.js');
	root.replace(/[^\/]+\//g, function(r) {
		id = (id.substr(0, r.length) == r) ?id.substr(r.length) : id = '../'+id;
	});
	return {'id':id,'uri':uri};
}

// INFO Boot loader
//      After the the main module has been loaded it is passed to this function,
//      which calls the appropriate hooks according to the document loading
//      state.

function boot(module) {
	var ieInteractiveWithBody;
	module.loading && module.loading();
	switch (document.readyState) {
		case 'complete':
			module.ready && module.ready(document.body);
			module.interactive && module.interactive(document.body);
			module.complete && module.complete(document.body);
			break;
		case 'interactive':
			// NOTE In IE8/9 the 'interactive' state has still no document body,
			//      if the page has been loaded from cache. Therefore we have to
			//      wait until the 'complete' state has been reached to call the
			//      hooks for 'interactive' then.
			if (ieInteractiveWithBody = !!document.body) { 
				module.ready && module.ready(document.body);
				module.interactive && module.interactive(document.body);
			}
		case 'loading':
			document.onreadystatechange = function() {
				switch (document.readyState) {
					case 'interactive':
						module.ready && module.ready(document.body);
						module.interactive && module.interactive(document.body);
						break;
					case 'complete':
						if (!ieInteractiveWithBody) {
							module.ready && module.ready(document.body);
							module.interactive && module.interactive(document.body);
						}
						module.complete && module.complete(document.body);
						break;
					default:
						throw new SmoothieError('unknown readyState '+document.readyState);
				}
			};
			break;
		default:
			throw new SmoothieError('unknown readyState '+document.readyState);
	}
}

// INFO Bootstrapping 1: Exporting require to global scope

if (window.require !== undefined)
	throw new SmoothieError('\'require\' already defined in global scope');

try {
	Object.defineProperty(window, 'require', {'value':require});
	Object.defineProperty(window.require, 'resolve', {'value':resolve});
	Object.defineProperty(window.require, 'paths', {'get':function(){return paths.slice(0);}});
}
catch (e) {
	// NOTE IE8 can't use defineProperty on non-DOM objects, so we have to fall
	//      back to unsave property assignments in this case.
	window.require = require;
	window.require.resolve = resolve;
	window.require.paths = paths.slice(0);
	// NOTE We definetly need a getter for the cache, so we make the the cache a
	//      DOM-object in IE8.
	cache = document.createElement('DIV');
}

// INFO Adding preloaded modules to cache

for (var id in (window.Smoothie && window.Smoothie.preloaded))
	cache['$'+id] = window.Smoothie.preloaded[id].toString();

// INFO Parsing module root paths

for (var i=0; i<paths.length; i++) {
	parser.href = paths[i];
	paths[i] = '/'+parser.href.replace(/^[^:]*:\/\/[^\/]*\/|\/(?=\/)/g, '');
}

// INFO Bootstrapping 2: Loading the main module

main && require(main, boot);

})(

// INFO Module loader
//      Takes the module descriptor, the global variables and the module code,
//      sets up the module envirinment, defines the module getter in the cache
//      and evaluates the module code. If module is a bundle the code of the
//      pre-loaded modules will be stored in the cache afterwards.
// NOTE This functions is defined as an anonymous function, which is passed as
//      a parameter to the closure above to provide a clean environment (only
//      global variables, module and exports) for the loaded module. This is
//      also the reason why `source`, `pwd` & `cache` are not named parameters.

function /*load*/(module/*, cache, pwd, source*/) {
	var global = window;
	var exports = new Object();
	Object.defineProperty(module, 'exports', {'get':function(){return exports;},'set':function(e){exports=e;}});
	arguments[2].unshift(module.id.match(/(?:.*\/)?/)[0]);
	Object.defineProperty(arguments[1], '$'+module.id, {'get':function(){return exports;}});
	// NOTE Firebug ignores the sourceUrl when the source is composed inside
	//      the eval call.
	arguments[3] = '('+arguments[3]+')();\n//# sourceURL='+module.uri;
	eval(arguments[3]);
	// NOTE Store module code in the cache if the loaded file is a bundle
	if (typeof module.id !== 'string')
		for (id in module)
			arguments[1]['$'+require.resolve(id).id] = module[id].toString();
	arguments[2].shift();
}

);