[thirdparty/git.git] / gitweb / static / js / lib / common-lib.js

// Copyright (C) 2007, Fredrik Kuivinen <frekui@gmail.com>
//               2007, Petr Baudis <pasky@suse.cz>
//          2008-2011, Jakub Narebski <jnareb@gmail.com>

/**
 * @fileOverview Generic JavaScript code (helper functions)
 * @license GPLv2 or later
 */


/* ============================================================ */
/* ............................................................ */
/* Padding */

/**
 * pad INPUT on the left with STR that is assumed to have visible
 * width of single character (for example nonbreakable spaces),
 * to WIDTH characters
 *
 * example: padLeftStr(12, 3, '\u00A0') == '\u00A012'
 *          ('\u00A0' is nonbreakable space)
 *
 * @param {Number|String} input: number to pad
 * @param {Number} width: visible width of output
 * @param {String} str: string to prefix to string, defaults to '\u00A0'
 * @returns {String} INPUT prefixed with STR x (WIDTH - INPUT.length)
 */
function padLeftStr(input, width, str) {
	var prefix = '';
	if (typeof str === 'undefined') {
		ch = '\u00A0'; // using '&nbsp;' doesn't work in all browsers
	}

	width -= input.toString().length;
	while (width > 0) {
		prefix += str;
		width--;
	}
	return prefix + input;
}

/**
 * Pad INPUT on the left to WIDTH, using given padding character CH,
 * for example padLeft('a', 3, '_') is '__a'
 *             padLeft(4, 2) is '04' (same as padLeft(4, 2, '0'))
 *
 * @param {String} input: input value converted to string.
 * @param {Number} width: desired length of output.
 * @param {String} ch: single character to prefix to string, defaults to '0'.
 *
 * @returns {String} Modified string, at least SIZE length.
 */
function padLeft(input, width, ch) {
	var s = input + "";
	if (typeof ch === 'undefined') {
		ch = '0';
	}

	while (s.length < width) {
		s = ch + s;
	}
	return s;
}


/* ............................................................ */
/* Ajax */

/**
 * Create XMLHttpRequest object in cross-browser way
 * @returns XMLHttpRequest object, or null
 */
function createRequestObject() {
	try {
		return new XMLHttpRequest();
	} catch (e) {}
	try {
		return window.createRequest();
	} catch (e) {}
	try {
		return new ActiveXObject("Msxml2.XMLHTTP");
	} catch (e) {}
	try {
		return new ActiveXObject("Microsoft.XMLHTTP");
	} catch (e) {}

	return null;
}


/* ............................................................ */
/* unquoting/unescaping filenames */

/**#@+
 * @constant
 */
var escCodeRe = /\\([^0-7]|[0-7]{1,3})/g;
var octEscRe = /^[0-7]{1,3}$/;
var maybeQuotedRe = /^\"(.*)\"$/;
/**#@-*/

/**
 * unquote maybe C-quoted filename (as used by git, i.e. it is
 * in double quotes '"' if there is any escape character used)
 * e.g. 'aa' -> 'aa', '"a\ta"' -> 'a	a'
 *
 * @param {String} str: git-quoted string
 * @returns {String} Unquoted and unescaped string
 *
 * @globals escCodeRe, octEscRe, maybeQuotedRe
 */
function unquote(str) {
	function unq(seq) {
		var es = {
			// character escape codes, aka escape sequences (from C)
			// replacements are to some extent JavaScript specific
			t: "\t",   // tab            (HT, TAB)
			n: "\n",   // newline        (NL)
			r: "\r",   // return         (CR)
			f: "\f",   // form feed      (FF)
			b: "\b",   // backspace      (BS)
			a: "\x07", // alarm (bell)   (BEL)
			e: "\x1B", // escape         (ESC)
			v: "\v"    // vertical tab   (VT)
		};

		if (seq.search(octEscRe) !== -1) {
			// octal char sequence
			return String.fromCharCode(parseInt(seq, 8));
		} else if (seq in es) {
			// C escape sequence, aka character escape code
			return es[seq];
		}
		// quoted ordinary character
		return seq;
	}

	var match = str.match(maybeQuotedRe);
	if (match) {
		str = match[1];
		// perhaps str = eval('"'+str+'"'); would be enough?
		str = str.replace(escCodeRe,
			function (substr, p1, offset, s) { return unq(p1); });
	}
	return str;
}

/* end of common-lib.js */
Commit	Line	Data
9a86dd57 JN	1	// Copyright (C) 2007, Fredrik Kuivinen <frekui@gmail.com>
	2	// 2007, Petr Baudis <pasky@suse.cz>
	3	// 2008-2011, Jakub Narebski <jnareb@gmail.com>
	4
	5	/**
	6	* @fileOverview Generic JavaScript code (helper functions)
	7	* @license GPLv2 or later
	8	*/
	9
	10
	11	/* ============================================================ */
	12	/* ............................................................ */
	13	/* Padding */
	14
	15	/**
e2895de4 JN	16	* pad INPUT on the left with STR that is assumed to have visible
	17	* width of single character (for example nonbreakable spaces),
	18	* to WIDTH characters
	19	*
9a86dd57 JN	20	* example: padLeftStr(12, 3, '\u00A0') == '\u00A012'
	21	* ('\u00A0' is nonbreakable space)
	22	*
	23	* @param {Number\|String} input: number to pad
	24	* @param {Number} width: visible width of output
4dfa207e	25	* @param {String} str: string to prefix to string, defaults to '\u00A0'
e2895de4	26	* @returns {String} INPUT prefixed with STR x (WIDTH - INPUT.length)
9a86dd57 JN	27	*/
	28	function padLeftStr(input, width, str) {
	29	var prefix = '';
4dfa207e JN	30	if (typeof str === 'undefined') {
	31	ch = '\u00A0'; // using ' ' doesn't work in all browsers
	32	}
9a86dd57 JN	33
	34	width -= input.toString().length;
	35	while (width > 0) {
	36	prefix += str;
	37	width--;
	38	}
	39	return prefix + input;
	40	}
	41
	42	/**
e2895de4	43	* Pad INPUT on the left to WIDTH, using given padding character CH,
4dfa207e JN	44	* for example padLeft('a', 3, '_') is '__a'
4dfa207e JN	45	* padLeft(4, 2) is '04' (same as padLeft(4, 2, '0'))
9a86dd57 JN	46	*
	47	* @param {String} input: input value converted to string.
	48	* @param {Number} width: desired length of output.
4dfa207e	49	* @param {String} ch: single character to prefix to string, defaults to '0'.
9a86dd57 JN	50	*
	51	* @returns {String} Modified string, at least SIZE length.
	52	*/
	53	function padLeft(input, width, ch) {
	54	var s = input + "";
4dfa207e JN	55	if (typeof ch === 'undefined') {
	56	ch = '0';
	57	}
	58
9a86dd57 JN	59	while (s.length < width) {
	60	s = ch + s;
	61	}
	62	return s;
	63	}
	64
	65
	66	/* ............................................................ */
	67	/* Ajax */
	68
	69	/**
	70	* Create XMLHttpRequest object in cross-browser way
	71	* @returns XMLHttpRequest object, or null
	72	*/
	73	function createRequestObject() {
	74	try {
	75	return new XMLHttpRequest();
	76	} catch (e) {}
	77	try {
	78	return window.createRequest();
	79	} catch (e) {}
	80	try {
	81	return new ActiveXObject("Msxml2.XMLHTTP");
	82	} catch (e) {}
	83	try {
	84	return new ActiveXObject("Microsoft.XMLHTTP");
	85	} catch (e) {}
	86
	87	return null;
	88	}
	89
	90
9a86dd57 JN	91	/* ............................................................ */
	92	/* unquoting/unescaping filenames */
	93
	94	/**#@+
	95	* @constant
	96	*/
	97	var escCodeRe = /\\([^0-7]\|[0-7]{1,3})/g;
	98	var octEscRe = /^[0-7]{1,3}$/;
	99	var maybeQuotedRe = /^\"(.*)\"$/;
	100	/*#@-/
	101
	102	/**
e2895de4 JN	103	* unquote maybe C-quoted filename (as used by git, i.e. it is
e2895de4 JN	104	* in double quotes '"' if there is any escape character used)
9a86dd57 JN	105	* e.g. 'aa' -> 'aa', '"a\ta"' -> 'a a'
	106	*
	107	* @param {String} str: git-quoted string
	108	* @returns {String} Unquoted and unescaped string
	109	*
	110	* @globals escCodeRe, octEscRe, maybeQuotedRe
	111	*/
	112	function unquote(str) {
	113	function unq(seq) {
	114	var es = {
	115	// character escape codes, aka escape sequences (from C)
	116	// replacements are to some extent JavaScript specific
	117	t: "\t", // tab (HT, TAB)
	118	n: "\n", // newline (NL)
	119	r: "\r", // return (CR)
	120	f: "\f", // form feed (FF)
	121	b: "\b", // backspace (BS)
	122	a: "\x07", // alarm (bell) (BEL)
	123	e: "\x1B", // escape (ESC)
	124	v: "\v" // vertical tab (VT)
	125	};
	126
	127	if (seq.search(octEscRe) !== -1) {
	128	// octal char sequence
	129	return String.fromCharCode(parseInt(seq, 8));
	130	} else if (seq in es) {
	131	// C escape sequence, aka character escape code
	132	return es[seq];
	133	}
	134	// quoted ordinary character
	135	return seq;
	136	}
	137
	138	var match = str.match(maybeQuotedRe);
	139	if (match) {
	140	str = match[1];
	141	// perhaps str = eval('"'+str+'"'); would be enough?
	142	str = str.replace(escCodeRe,
	143	function (substr, p1, offset, s) { return unq(p1); });
	144	}
	145	return str;
	146	}
	147
	148	/* end of common-lib.js */