etherpad-lite/static/js/ace2_common.js

164 lines
4.1 KiB
JavaScript
Raw Normal View History

/**
* This code is mostly from the old Etherpad. Please help us to comment this code.
* This helps other people to understand this code better and helps them to improve it.
* TL;DR COMMENTS ON THIS FILE ARE HIGHLY APPRECIATED
*/
2011-03-26 14:10:41 +01:00
/**
* Copyright 2009 Google Inc.
2011-07-07 19:59:34 +02:00
*
2011-03-26 14:10:41 +01:00
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
2011-07-07 19:59:34 +02:00
*
2011-03-26 14:10:41 +01:00
* http://www.apache.org/licenses/LICENSE-2.0
2011-07-07 19:59:34 +02:00
*
2011-03-26 14:10:41 +01:00
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS-IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
2011-07-07 19:59:34 +02:00
function isNodeText(node)
{
2011-03-26 14:10:41 +01:00
return (node.nodeType == 3);
}
2011-07-07 19:59:34 +02:00
function object(o)
{
var f = function()
{};
2011-03-26 14:10:41 +01:00
f.prototype = o;
return new f();
}
2011-07-07 19:59:34 +02:00
function extend(obj, props)
{
for (var p in props)
{
2011-03-26 14:10:41 +01:00
obj[p] = props[p];
}
return obj;
}
2011-07-07 19:59:34 +02:00
function forEach(array, func)
{
for (var i = 0; i < array.length; i++)
{
2011-03-26 14:10:41 +01:00
var result = func(array[i], i);
if (result) break;
}
}
2011-07-07 19:59:34 +02:00
function map(array, func)
{
2011-03-26 14:10:41 +01:00
var result = [];
// must remain compatible with "arguments" pseudo-array
2011-07-07 19:59:34 +02:00
for (var i = 0; i < array.length; i++)
{
2011-03-26 14:10:41 +01:00
if (func) result.push(func(array[i], i));
else result.push(array[i]);
}
return result;
}
2011-07-07 19:59:34 +02:00
function filter(array, func)
{
2011-03-26 14:10:41 +01:00
var result = [];
// must remain compatible with "arguments" pseudo-array
2011-07-07 19:59:34 +02:00
for (var i = 0; i < array.length; i++)
{
2011-03-26 14:10:41 +01:00
if (func(array[i], i)) result.push(array[i]);
}
2011-07-07 19:59:34 +02:00
return result;
2011-03-26 14:10:41 +01:00
}
2011-07-07 19:59:34 +02:00
function isArray(testObject)
{
return testObject && typeof testObject === 'object' && !(testObject.propertyIsEnumerable('length')) && typeof testObject.length === 'number';
2011-03-26 14:10:41 +01:00
}
var userAgent = (((function () {return this;})().navigator || {}).userAgent || 'node-js').toLowerCase();
2011-03-26 14:10:41 +01:00
// Figure out what browser is being used (stolen from jquery 1.2.1)
var browser = {
version: (userAgent.match(/.+(?:rv|it|ra|ie)[\/: ]([\d.]+)/) || [])[1],
safari: /webkit/.test(userAgent),
opera: /opera/.test(userAgent),
msie: /msie/.test(userAgent) && !/opera/.test(userAgent),
mozilla: /mozilla/.test(userAgent) && !/(compatible|webkit)/.test(userAgent),
2012-01-22 02:15:02 +01:00
windows: /windows/.test(userAgent),
mobile: /mobile/.test(userAgent) || /android/.test(userAgent)
2011-03-26 14:10:41 +01:00
};
2011-07-07 19:59:34 +02:00
function getAssoc(obj, name)
{
return obj["_magicdom_" + name];
2011-03-26 14:10:41 +01:00
}
2011-07-07 19:59:34 +02:00
function setAssoc(obj, name, value)
{
2011-03-26 14:10:41 +01:00
// note that in IE designMode, properties of a node can get
// copied to new nodes that are spawned during editing; also,
// properties representable in HTML text can survive copy-and-paste
2011-07-07 19:59:34 +02:00
obj["_magicdom_" + name] = value;
2011-03-26 14:10:41 +01:00
}
// "func" is a function over 0..(numItems-1) that is monotonically
// "increasing" with index (false, then true). Finds the boundary
// between false and true, a number between 0 and numItems inclusive.
2011-07-07 19:59:34 +02:00
function binarySearch(numItems, func)
{
2011-03-26 14:10:41 +01:00
if (numItems < 1) return 0;
if (func(0)) return 0;
2011-07-07 19:59:34 +02:00
if (!func(numItems - 1)) return numItems;
2011-03-26 14:10:41 +01:00
var low = 0; // func(low) is always false
2011-07-07 19:59:34 +02:00
var high = numItems - 1; // func(high) is always true
while ((high - low) > 1)
{
var x = Math.floor((low + high) / 2); // x != low, x != high
2011-03-26 14:10:41 +01:00
if (func(x)) high = x;
else low = x;
}
return high;
}
2011-07-07 19:59:34 +02:00
function binarySearchInfinite(expectedLength, func)
{
2011-03-26 14:10:41 +01:00
var i = 0;
while (!func(i)) i += expectedLength;
return binarySearch(i, func);
}
2011-07-07 19:59:34 +02:00
function htmlPrettyEscape(str)
{
return str.replace(/[&"<>]/g, function (c) {
return {
'&': '&amp;',
'"': '&quot;',
'<': '&lt;',
'>': '&gt;'
}[c] || c;
}).replace(/\r?\n/g, '\\n');
2011-03-26 14:10:41 +01:00
}
exports.isNodeText = isNodeText;
exports.object = object;
exports.extend = extend;
exports.forEach = forEach;
exports.map = map;
exports.filter = filter;
exports.isArray = isArray;
exports.browser = browser;
exports.getAssoc = getAssoc;
exports.setAssoc = setAssoc;
exports.binarySearch = binarySearch;
exports.binarySearchInfinite = binarySearchInfinite;
exports.htmlPrettyEscape = htmlPrettyEscape;
exports.map = map;